Skip to content

fix: Fix normalization of extension paths on the annoying operating system and Python 3.13 #211

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 1 commit into from
Nov 26, 2024
Merged

fix: Fix normalization of extension paths on the annoying operating system and Python 3.13 #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 3 additions & 5 deletions src/mkdocstrings_handlers/python/handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,11 +469,9 @@ def normalize_extension_paths(self, extensions: Sequence) -> Sequence:
pth = str(ext)
options = None

if pth.endswith(".py") or ".py:" in pth or "/" in pth or "\\" in pth: # noqa: SIM102
# This is a sytem path. Normalize it.
if not os.path.isabs(pth):
# Make path absolute relative to config file path.
pth = os.path.normpath(os.path.join(base_path, pth))
if pth.endswith(".py") or ".py:" in pth or "/" in pth or "\\" in pth:
# This is a system path. Normalize it, make it absolute relative to config file path.
pth = os.path.abspath(os.path.join(base_path, pth))

if options is not None:
normalized.append({pth: options})
Expand Down
9 changes: 5 additions & 4 deletions tests/test_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,11 @@ def test_expand_globs_without_changing_directory() -> None:
(True, {"extension.py:SomeExtension": {"option": "value"}}),
(True, {"path/to/extension.py": {"option": "value"}}),
(True, {"path/to/extension.py:SomeExtension": {"option": "value"}}),
(False, "/absolute/path/to/extension.py"),
(False, "/absolute/path/to/extension.py:SomeExtension"),
(False, {"/absolute/path/to/extension.py": {"option": "value"}}),
(False, {"/absolute/path/to/extension.py:SomeExtension": {"option": "value"}}),
# True because OS path normalization.
(True, "/absolute/path/to/extension.py"),
(True, "/absolute/path/to/extension.py:SomeExtension"),
(True, {"/absolute/path/to/extension.py": {"option": "value"}}),
(True, {"/absolute/path/to/extension.py:SomeExtension": {"option": "value"}}),
(False, "dot.notation.path.to.extension"),
(False, "dot.notation.path.to.pyextension"),
(False, {"dot.notation.path.to.extension": {"option": "value"}}),
Expand Down