Inspect sub-folders recursively (#8)

* fixed sub-folders recursive inspection, unit tests
* skips imports that are not classes
* upgraded pytest version, properly separated project and poetry configurations
* add __init__.py in tests folder to run pytest in vscode

Co-authored-by: doyou89.jung <[email protected]>
Co-authored-by: Luc Sorel-Giffo <[email protected]>

Author: 3 people

.gitignore

@@ -4,3 +4,4 @@ __pycache__/
 *.egg-info/
 *.puml
 dist/
+.vscode/

README.md

@@ -30,8 +30,6 @@ From a given path corresponding to a folder containing python code, `py2puml` lo
 
 * complex type hints with more than one level of genericity are not properly handled for the moment: `List[MyClass]` or `Dict[str, MyClass]` are handled properly, `Dict[str, List[MyClass]]` is not. If your domain classes (also called business objects or DTOs) have attributes with complex type hints, it may be a code smell indicating that you should write a class which would better represent the business logic. But I may improve this part of the library as well 😀
 
-* `py2puml` does not inspect sub-folders recursively, but it is planned
-
 * `py2puml` outputs diagrams in PlantUML syntax, which can be saved in text files along your python code and versioned with them. To generate image files, use the PlantUML runtime or a docker image (see [think/plantuml](https://hub.docker.com/r/think/plantuml))
 
 * `py2puml` uses features of python 3 (generators for example) and thus won't work with python 2 runtimes. It relies on native python modules and uses no 3rd-party library, except [pytest](https://docs.pytest.org/en/latest/) as a development dependency for running the unit-tests
@@ -123,11 +121,16 @@ Which renders like this:
 # Tests
 
 ```sh
+# directly with poetry
+poetry run python -m pytest -v
+
+# in a virtual environment
 python3 -m pytest -v
 ```
 
 # Changelog
 
+* `0.3.1`: inspect sub-folders recursively
 * `0.3.0`: handle classes derived from namedtuples (attribute types are `any`)
 * `0.2.0`: handle inheritance relationships and enums. Unit tested
 * `0.1.3`: first release, handle all module of a folder and compositions of domain classes
@@ -139,6 +142,7 @@ Unless stated otherwise all works are licensed under the [MIT license](http://sp
 # Contributions
 
 * [Luc Sorel-Giffo](https://github.com/lucsorel)
+* [Doyou Jung](https://github.com/doyou89)
 
 Pull-requests are welcome and will be processed on a best-effort basis.
 

poetry.lock

@@ -0,0 +1,3 @@
+[virtualenvs]
+create = true
+in-project = true

poetry.toml

@@ -1,7 +1,7 @@
 from typing import Iterable, Type, List, Dict
 from types import ModuleType
 from enum import Enum
-from inspect import getmembers
+from inspect import getmembers, isclass
 from re import compile
 
 from py2puml.domain.umlitem import UmlItem
@@ -11,17 +11,18 @@
 from py2puml.utils import inspect_type
 
 CONCRETE_TYPE_PATTERN = compile("^<(?:class|enum) '([\\.|\\w]+)'>$")
-
 def filter_domain_definitions(module: ModuleType, root_module_name: str) -> Iterable[Type]:
     for definition_key in dir(module):
         definition_type = getattr(module, definition_key)
-        definition_members = getmembers(definition_type)
-        definition_module_member = next(
-            (member for member in definition_members if member[0] == '__module__' and member[1].startswith(root_module_name)),
-            None
-        )
-        if definition_module_member is not None:
-            yield definition_type
+        if isclass(definition_type):
+            definition_members = getmembers(definition_type)
+            definition_module_member = next((
+                member for member in definition_members
+                # ensures that the type belongs to the module being parsed
+                if member[0] == '__module__' and member[1].startswith(root_module_name)
+            ), None)
+            if definition_module_member is not None:
+                yield definition_type
 
 def get_type_name(type: Type, root_module_name: str):
     if type.__module__.startswith(root_module_name):

py2puml/parser.py

@@ -12,11 +12,9 @@
 def py2puml(domain_path: str, domain_module: str) -> Iterable[str]:
     domain_items_by_fqdn: Dict[str, UmlItem] = {}
     domain_relations: List[UmlRelation] = []
-    for _, name, is_pkg in walk_packages([domain_path]):
+    for _, name, is_pkg in walk_packages([domain_path], f'{domain_module}.'):
         if not is_pkg:
-            domain_item_module: ModuleType = import_module(
-                f'{domain_module}.{name}'
-            )
+            domain_item_module: ModuleType = import_module(name)
             parse_item_module(
                 domain_item_module,
                 domain_module,