Skip to content

Remove shlex.quote to fix issues when filenames have spaces #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 12, 2025
Merged

Remove shlex.quote to fix issues when filenames have spaces #38

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9df80d9
The shlex.quote is breaking file paths that have spaces in them, as it
Nov 12, 2025
5149ce3
Apply suggestions from code review
henryiii Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions pybind11_mkdoc/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ def _append_include_dir(args: list, include_dir: str, verbose: bool = True):
"""

if os.path.isdir(include_dir):
args.append(f"-I{shlex.quote(include_dir)}")
args.append(f"-I{include_dir}")
elif verbose:
print(f"Include directoy '{shlex.quote(include_dir)}' does not exist!")
print(f"Include directory {include_dir!r} does not exist!")


def _append_definition(args: list, definition: str, verbose: bool = True):
Expand All @@ -61,9 +61,9 @@ def _append_definition(args: list, definition: str, verbose: bool = True):
"""

try:
macro, value = definition.strip().split('=')
macro = shlex.quote(macro.strip())
value = shlex.quote(value.strip()) if value else '1'
macro, _, value = definition.partition('=')
macro = macro.strip()
value = value.strip() if value else '1'

args.append(f"-D{macro}={value}")
except ValueError as exc:
Expand All @@ -72,9 +72,9 @@ def _append_definition(args: list, definition: str, verbose: bool = True):
if re.search(r'^[A-Za-z_][A-Za-z0-9_]*', definition):
args.append(f"-D{definition}")
else:
print(f"Failed to parse definition: {shlex.quote(definition)}")
print(f"Failed to parse definition: {definition}")
except:
print(f"Failed to parse definition: {shlex.quote(definition)}")
print(f"Failed to parse definition: {definition}")



Expand Down Expand Up @@ -128,10 +128,10 @@ def main():
_append_definition(mkdoc_args, arg[2:])
else:
# append argument as is and hope for the best
mkdoc_args.append(shlex.quote(arg))
mkdoc_args.append(arg)

for header in parsed_args.header:
mkdoc_args.append(shlex.quote(header))
mkdoc_args.append(header)

mkdoc(mkdoc_args, docstring_width, mkdoc_out)

Expand Down
Loading