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

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

Author: JustKiddingCode

README.md

@@ -203,6 +203,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.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)
@@ -231,6 +232,7 @@ Unless stated otherwise all works are licensed under the [MIT license](http://sp
 * [Doyou Jung](https://github.com/doyou89)
 * [Julien Jerphanion](https://github.com/jjerphan)
 * [Luis Fernando Villanueva Pérez](https://github.com/jonykalavera)
+* [Konstantin Zangerle](https://github.com/justkiddingcode)
 
 ## Pull requests
 

py2puml/inspection/inspectpackage.py

@@ -15,3 +15,5 @@ def inspect_package(
         if not is_pkg:
             domain_item_module: ModuleType = import_module(name)
             inspect_module(domain_item_module, domain_module, domain_items_by_fqn, domain_relations)
+    item_module = import_module(f'{domain_module}', f'{domain_module}.')
+    inspect_module(item_module, domain_module, domain_items_by_fqn, domain_relations)

pyproject.toml

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

tests/modules/withpkginitandmodule/__init__.py

@@ -0,0 +1,7 @@
+""" This is a package with a __init__.py file only """
+from dataclasses import dataclass
+
+
+@dataclass
+class InInitTest:
+    test_member: str

tests/modules/withpkginitandmodule/test.py

@@ -0,0 +1,7 @@
+""" This is a package with a __init__.py file only """
+from dataclasses import dataclass
+
+
+@dataclass
+class InTestModule:
+    test_member: str

tests/modules/withpkginitandmodule/tests.modules.withpkginitandmodule.puml

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

tests/modules/withpkginitonly/__init__.py

@@ -0,0 +1,7 @@
+""" This is a package with a __init__.py file only """
+from dataclasses import dataclass
+
+
+@dataclass
+class InitOnlyTest:
+    test_member: str

tests/modules/withpkginitonly/tests.modules.withpkginitonly.puml

@@ -0,0 +1,8 @@
+@startuml tests.modules.withpkginitonly
+!pragma useIntermediatePackages false
+
+class tests.modules.withpkginitonly.InitOnlyTest {
+  test_member: str
+}
+footer Generated by //py2puml//
+@enduml

tests/py2puml/test_py2puml.py

@@ -15,6 +15,30 @@ def test_py2puml_model_on_py2uml_domain():
     assert_py2puml_is_file_content('py2puml/domain', 'py2puml.domain', domain_diagram_file_path)
 
 
+def test_py2puml_with_pkg_init_only():
+    """
+    Ensure that __init__.py files are also parsed
+    """
+    domain_diagram_file_path = CURRENT_DIR.parent / 'modules/withpkginitonly' / 'tests.modules.withpkginitonly.puml'
+
+    assert_py2puml_is_file_content(
+        'tests/modules/withpkginitonly', 'tests.modules.withpkginitonly', domain_diagram_file_path
+    )
+
+
+def test_py2puml_with_pkg_init_and_module():
+    """
+    Ensure that __init__.py files are also parsed, in combination with other module
+    """
+    domain_diagram_file_path = (
+        CURRENT_DIR.parent / 'modules/withpkginitandmodule' / 'tests.modules.withpkginitandmodule.puml'
+    )
+
+    assert_py2puml_is_file_content(
+        'tests/modules/withpkginitandmodule', 'tests.modules.withpkginitandmodule', domain_diagram_file_path
+    )
+
+
 def test_py2puml_with_heavily_nested_model():
     domain_diagram_file_path = (
         CURRENT_DIR.parent / 'modules' / 'withnestednamespace' / 'tests.modules.withnestednamespace.puml'