Skip to content
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

fix(#3554): correct module_to_os_path to return directory paths #3565

Merged
merged 2 commits into from
Aug 25, 2024
Merged

fix(#3554): correct module_to_os_path to return directory paths #3565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
efd1908
Update module_loader.py
supercoder-dev Jun 12, 2024
e9d8cfc
feat: adds a test for single file module
cofin Aug 25, 2024
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
4 changes: 2 additions & 2 deletions litestar/utils/module_loader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

from __future__ import annotations

import os.path
import sys
from importlib import import_module
from importlib.util import find_spec
Expand Down Expand Up @@ -39,7 +38,8 @@ def module_to_os_path(dotted_path: str = "app") -> Path:
except ModuleNotFoundError as e:
raise TypeError(f"Couldn't find the path for {dotted_path}") from e

return Path(str(src.origin).rsplit(os.path.sep + "__init__.py", maxsplit=1)[0])
path = Path(str(src.origin))
return path.parent if path.is_file() else path


def import_string(dotted_path: str) -> Any:
Expand Down
7 changes: 5 additions & 2 deletions tests/unit/test_utils/test_module_loader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ def test_import_string() -> None:
_ = import_string("imaginary_module_that_doesnt_exist.Config") # a random nonexistent class


def test_module_path() -> None:
def test_module_path(tmp_path: Path, monkeypatch: MonkeyPatch) -> None:
the_path = module_to_os_path("litestar.config.compression")
assert the_path.exists()

tmp_path.joinpath("simple_module.py").write_text("x = 'foo'")
monkeypatch.syspath_prepend(tmp_path)
os_path = module_to_os_path("simple_module")
assert os_path == Path(tmp_path)
with pytest.raises(TypeError):
_ = module_to_os_path("litestar.config.compression.Config")
_ = module_to_os_path("litestar.config.compression.extra.module")
Expand All @@ -35,5 +39,4 @@ def test_import_string_cached(tmp_path: Path, monkeypatch: MonkeyPatch) -> None:
tmp_path.joinpath("testmodule.py").write_text("x = 'foo'")
monkeypatch.chdir(tmp_path)
monkeypatch.syspath_prepend(tmp_path)

assert import_string("testmodule.x") == "foo"
Loading