feat: parse __init__.py files in packages. Closes: #52 (#76)

Co-authored-by: Konstantin Zangerle <[email protected]>

docs(version): set version to 0.9.0, parsing root module is a new feature

Signed-off-by: Luc Sorel-Giffo <[email protected]>

Author: JustKiddingCode

README.md

@@ -202,8 +202,7 @@ poetry run pytest -v --cov=py2puml --cov-branch --cov-report term-missing --cov-
 
 # Changelog
 
-* `upcoming`: replaced yapf by the ruff formatter
-* `0.8.2`: add classes defined in `__init__.py` files to plantuml output
+* `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)
 * `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)

poetry.lock

@@ -16,7 +16,7 @@ def run():
 
     argparser = ArgumentParser(description='Generate PlantUML class diagrams to document your Python application.')
 
-    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.8.1')
+    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.9.0')
     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)
 

py2puml/cli.py

@@ -11,6 +11,10 @@
 def inspect_package(
     domain_path: str, domain_module: str, domain_items_by_fqn: Dict[str, UmlItem], domain_relations: List[UmlRelation]
 ):
+    # inspects the package module first, then its children modules and subpackages
+    item_module = import_module(domain_module)
+    inspect_module(item_module, domain_module, domain_items_by_fqn, domain_relations)
+
     for _, name, is_pkg in walk_packages([domain_path], f'{domain_module}.'):
         if not is_pkg:
             domain_item_module: ModuleType = import_module(name)

py2puml/inspection/inspectpackage.py

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

pyproject.toml

@@ -1,10 +1,10 @@
 @startuml tests.modules.withpkginitandmodule
 !pragma useIntermediatePackages false
 
-class tests.modules.withpkginitandmodule.test.InTestModule {
+class tests.modules.withpkginitandmodule.InInitTest {
   test_member: str
 }
-class tests.modules.withpkginitandmodule.InInitTest {
+class tests.modules.withpkginitandmodule.test.InTestModule {
   test_member: str
 }
 footer Generated by //py2puml//

tests/modules/withpkginitandmodule/tests.modules.withpkginitandmodule.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.8.1'
+    assert __version__ == '0.9.0'
 
 
 # Description also output in the CLI