fix(cli): add current working directory to path so that py2puml can import and inspect modules in specific folders (#40)

* build(poetry): make poetry use the current python binary

* fix(cli): add current working directory to system path so that its modules can be imported and inspected by poetry

Author: lucsorel

README.md

@@ -20,7 +20,7 @@ Some parsing features are available only since Python 3.8 (like [ast.get_source_
 
 ## Features
 
-From a given path corresponding to a folder containing Python code, `py2puml` processes each file as a module and generates a [PlantUML script](https://plantuml.com/en/class-diagram) of its classe-like definitions using:
+From a given path corresponding to a folder containing Python code, `py2puml` processes each Python module and generates a [PlantUML script](https://plantuml.com/en/class-diagram) from the definitions of various data structures using:
 
 * **[inspection](https://docs.python.org/3/library/inspect.html)** and [type annotations](https://docs.python.org/3/library/typing.html) to detect:
   * static class attributes and [dataclass](https://docs.python.org/3/library/dataclasses.html) fields
@@ -29,7 +29,7 @@ From a given path corresponding to a folder containing Python code, `py2puml` pr
   * composition and inheritance relationships (between your domain classes only, for documentation sake).
 The detection of composition relationships relies on type annotations only, assigned values or expressions are never evaluated to prevent unwanted side-effects
 
-* parsing [abstract syntax trees](https://docs.python.org/3/library/ast.html#ast.NodeVisitor) to detect the instance attributes defined in `__init__` constructors
+* parsing **[abstract syntax trees](https://docs.python.org/3/library/ast.html#ast.NodeVisitor)** to detect the instance attributes defined in `__init__` constructors
 
 `py2puml` outputs diagrams in PlantUML syntax, which can be:
 * versioned along your code with a unit-test ensuring its consistency (see the [test_py2puml.py's test_py2puml_model_on_py2uml_domain](tests/py2puml/test_py2puml.py) example)
@@ -192,11 +192,12 @@ python3 -m pytest -v
 Code coverage (with [missed branch statements](https://pytest-cov.readthedocs.io/en/latest/config.html?highlight=--cov-branch)):
 
 ```sh
-poetry run pytest -v --cov=py2puml --cov-branch --cov-report term-missing --cov-fail-under 90
+poetry run pytest -v --cov=py2puml --cov-branch --cov-report term-missing --cov-fail-under 92
 ```
 
 # Changelog
 
+* `0.7.2`: added the current working directory to the import path to make py2puml work in any directory or in native virtual environment (not handled by poetry)
 * `0.7.1`: removed obsolete part of documentation: deeply compound types are now well handled (by version `0.7.0`)
 * `0.7.0`: improved the generated PlantUML documentation (added the namespace structure of the code base, homogenized type  between inspection and parsing), improved relationships management (handle forward references, deduplicate relationships)
 * `0.6.1`: handle class names with digits

poetry.toml

@@ -1,6 +1,7 @@
 [virtualenvs]
 create = true
 in-project = true
+prefer-active-python = true
 
 [repositories]
 [repositories.testpypi]

py2puml/asserts.py

@@ -1,6 +1,6 @@
 from io import StringIO
 from pathlib import Path
-from typing import Union
+from typing import Iterable, List, Union
 
 from py2puml.py2puml import py2puml
 
@@ -13,9 +13,13 @@ def assert_py2puml_is_file_content(domain_path: str, domain_module: str, diagram
 def assert_py2puml_is_stringio(domain_path: str, domain_module: str, expected_content_stream: StringIO):
     # generates the PlantUML documentation
     puml_content = list(py2puml(domain_path, domain_module))
+
+    assert_multilines(puml_content, expected_content_stream)
+
+
+def assert_multilines(actual_multilines: List[str], expected_multilines: Iterable[str]):
     line_index = 0
-    for line_index, (actual_line, expected_line) in enumerate(zip(puml_content, expected_content_stream)):
-        assert actual_line == expected_line, f'actual and expected contents have changed at line {line_index + 1}'
+    for line_index, (actual_line, expected_line) in enumerate(zip(actual_multilines, expected_multilines)):
+        assert actual_line == expected_line, f'actual and expected contents have changed at line {line_index + 1}: {actual_line=}, {expected_line=}'
 
-    assert line_index + 1 == len(puml_content), f'actual and expected diagrams have {line_index + 1} lines'
-
+    assert line_index + 1 == len(actual_multilines), f'actual and expected diagrams have {line_index + 1} lines'

py2puml/cli.py

@@ -2,14 +2,21 @@
 # -*- coding: utf-8 -*-
 
 from argparse import ArgumentParser
+from pathlib import Path
+from sys import path
 
 from py2puml.py2puml import py2puml
 
 
 def run():
+    # adds the current working directory to the system path so that py2puml can import them
+    current_working_directory = str(Path.cwd().resolve())
+    if current_working_directory not in path:
+        path.append(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.7.1')
+    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.7.2')
     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.7.1"
+version = "0.7.2"
 description = "Generate PlantUML class diagrams to document your Python application."
 keywords = ["class diagram", "PlantUML", "documentation", "inspection", "AST"]
 readme = "README.md"
@@ -25,9 +25,7 @@ pytest-cov = "^4.0.0"
 
 [tool.pytest.ini_options]
 minversion = "6.2"
-testpaths = [
-    "tests"
-]
+testpaths = ["tests"]
 console_output_style = "count"
 
 [tool.pylint.messages_control]

tests/__init__.py

@@ -1,12 +1,15 @@
-from os.path import dirname, realpath, join
-from re import compile as re_compile
 from itertools import takewhile
+from pathlib import Path
+from re import compile as re_compile
+
 
 # exports the version and the project description read from the pyproject.toml file
 __version__ = None
 __description__ = None
 
-PARENT_DIR = dirname(dirname(realpath(__file__)))
+TESTS_PATH = Path(__file__).parent
+PROJECT_PATH = TESTS_PATH.parent
+
 VERSION_PATTERN = re_compile('^version = "([^"]+)"$')
 DESCRIPTION_PATTERN = re_compile('^description = "([^"]+)"$')
 
@@ -17,7 +20,7 @@ def get_from_line_and_pattern(content_line: str, pattern) -> str:
     else:
         return pattern_match.group(1)
 
-with open(join(PARENT_DIR, 'pyproject.toml'), encoding='utf8') as pyproject:
-    for line in takewhile(lambda _: __version__ is None or __description__ is None, pyproject):
+with open(PROJECT_PATH / 'pyproject.toml', encoding='utf8') as pyproject_file:
+    for line in takewhile(lambda _: __version__ is None or __description__ is None, pyproject_file):
         __version__ = __version__ if __version__ is not None else get_from_line_and_pattern(line, VERSION_PATTERN)
         __description__ = __description__ if __description__ is not None else get_from_line_and_pattern(line, DESCRIPTION_PATTERN)

tests/modules/withrootnotincwd/point.py

@@ -0,0 +1,7 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class Point:
+    x: float
+    y: float

tests/modules/withrootnotincwd/segment.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass
+
+from withrootnotincwd.point import Point
+
+
+@dataclass
+class Segment:
+    a: Point
+    b: Point

tests/puml_files/withrootnotincwd.puml

@@ -0,0 +1,16 @@
+@startuml withrootnotincwd
+namespace withrootnotincwd {
+  namespace point {}
+  namespace segment {}
+}
+class withrootnotincwd.point.Point {
+  x: float
+  y: float
+}
+class withrootnotincwd.segment.Segment {
+  a: Point
+  b: Point
+}
+withrootnotincwd.segment.Segment *-- withrootnotincwd.point.Point
+footer Generated by //py2puml//
+@enduml

tests/py2puml/test__init__.py

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