fix(cli): insert the current working directory at the beginning of the PYTHON_PATH to ease module resolution (#82)

Author: lucsorel

README.md

@@ -202,7 +202,8 @@ poetry run pytest -v --cov=py2puml --cov-branch --cov-report term-missing --cov-
 
 # Changelog
 
-* `upcoming`: fix url to PlantUML logo
+* `0.9.1`: improved 0.7.2 by adding the current working directory at the beginning of the sys.path to resolve the module paths of the project being inspected.
+Fix url to PlantUML logo on the README.md page
 * `0.9.0`: add classes defined in `__init__.py` files to plantuml output; replaced yapf by the ruff formatter
 * `0.8.1`: delegated the grouping of nested namespaces (see `0.7.0`) to the PlantUML binary, which handles it natively
 * `0.8.0`: added support for union types, and github actions (pre-commit hooks + automated tests)

py2puml/cli.py

@@ -9,14 +9,14 @@
 
 
 def run():
-    # adds the current working directory to the system path so that py2puml can import them
+    # adds the current working directory to the system path in the first place
+    # to ease module resolution when py2puml imports them
     current_working_directory = str(Path.cwd().resolve())
-    if current_working_directory not in path:
-        path.append(current_working_directory)
+    path.insert(0, current_working_directory)
 
     argparser = ArgumentParser(description='Generate PlantUML class diagrams to document your Python application.')
 
-    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.9.0')
+    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.9.1')
     argparser.add_argument('path', metavar='path', type=str, help='the filepath to the domain')
     argparser.add_argument('module', metavar='module', type=str, help='the module name of the domain', default=None)
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "py2puml"
-version = "0.9.0"
+version = "0.9.1"
 description = "Generate PlantUML class diagrams to document your Python application."
 keywords = ["class diagram", "PlantUML", "documentation", "inspection", "AST"]
 readme = "README.md"

tests/modules/withconfusingrootpackage/test/__init__.py

@@ -0,0 +1,16 @@
+"""
+When attempting to resolve test.range, the python interpreter will search:
+- in the current working directory (and should succeed)
+- in the test package of the Python standard library (and should fail)
+
+This non-regression test ensures that the current working directory is
+in the first position of the paths of PYTHON_PATH (sys.path) so that
+module resolution is attempted first in the inspected codebase.
+"""
+from datetime import datetime
+
+
+class Range:
+    def __init__(self, start: datetime, stop: datetime):
+        self.start = start
+        self.stop = stop

tests/modules/withconfusingrootpackage/test/range.py

@@ -0,0 +1,9 @@
+@startuml test
+!pragma useIntermediatePackages false
+
+class test.range.Range {
+  start: datetime
+  stop: datetime
+}
+footer Generated by //py2puml//
+@enduml

tests/puml_files/test.puml

@@ -3,7 +3,7 @@
 
 # Ensures the library version is modified in the pyproject.toml file when upgrading it (pull request)
 def test_version():
-    assert __version__ == '0.9.0'
+    assert __version__ == '0.9.1'
 
 
 # Description also output in the CLI

tests/py2puml/test__init__.py

@@ -20,11 +20,21 @@ def test_cli_consistency_with_the_default_configuration(entrypoint: List[str]):
     assert ''.join(puml_content).strip() == cli_stdout.strip()
 
 
-def test_cli_on_specific_working_directory():
-    command = ['py2puml', 'withrootnotincwd', 'withrootnotincwd']
-    cli_process = run(command, stdout=PIPE, stderr=PIPE, text=True, check=True, cwd='tests/modules')
-
-    with open(TESTS_PATH / 'puml_files' / 'withrootnotincwd.puml', 'r', encoding='utf8') as expected_puml_file:
+@mark.parametrize(
+    ['command', 'current_working_directory', 'expected_puml_contents_file'],
+    [
+        (['python', '-m', 'py2puml', 'withrootnotincwd', 'withrootnotincwd'], 'tests/modules', 'withrootnotincwd.puml'),
+        (['py2puml', 'withrootnotincwd', 'withrootnotincwd'], 'tests/modules', 'withrootnotincwd.puml'),
+        (['python', '-m', 'py2puml', 'test', 'test'], 'tests/modules/withconfusingrootpackage', 'test.puml'),
+        (['py2puml', 'test', 'test'], 'tests/modules/withconfusingrootpackage', 'test.puml'),
+    ],
+)
+def test_cli_on_specific_working_directory(
+    command: List[str], current_working_directory: str, expected_puml_contents_file: str
+):
+    cli_process = run(command, stdout=PIPE, stderr=PIPE, text=True, check=True, cwd=current_working_directory)
+
+    with open(TESTS_PATH / 'puml_files' / expected_puml_contents_file, 'r', encoding='utf8') as expected_puml_file:
         assert_multilines(
             # removes the last return carriage added by the stdout
             list(StringIO(cli_process.stdout))[:-1],