fix(compoundtypesplitter): handle class names with digits (#36)

* fix(compoundtypesplitter): handle class names with digits

fixes #35

* docs(readme): fixed version of previous change

Author: lucsorel

README.md

@@ -181,6 +181,7 @@ poetry run python -m pytest -v --cov=py2puml --cov-branch --cov-report term-miss
 
 # Changelog
 
+* `0.6.1`: handle class names with digits
 * `0.6.0`: handle abstract classes
 * `0.5.4`: fixed the packaging so that the contribution guide is included in the published package
 * `0.5.3`: handle constructors decorated by wrapping decorators (decorators making uses of `functools.wrap`)

py2puml/cli.py

@@ -9,7 +9,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.6.0')
+    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.6.1')
     argparser.add_argument('path', metavar='path', type=str, help='the path of the domain')
     argparser.add_argument('module', metavar='module', type=str, help='the module of the domain', default=None)
 

py2puml/parsing/compoundtypesplitter.py

@@ -2,7 +2,7 @@
 from re import compile, Pattern
 from typing import List, Tuple
 
-IS_COMPOUND_TYPE: Pattern = compile('^[a-z|A-Z|\\[|\\]|\\.|,|\\s|_]+$')
+IS_COMPOUND_TYPE: Pattern = compile('^[a-z|A-Z|0-9|\\[|\\]|\\.|,|\\s|_]+$')
 SPLITTING_CHARACTERS = ('[', ']', ',')
 
 class CompoundTypeSplitter(object):

pyproject.toml

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

tests/modules/withcompoundtypewithdigits.py

@@ -0,0 +1,12 @@
+from typing import List
+
+
+class IPv6:
+    '''class name with digits'''
+    def __init__(self, address: str) -> None:
+        self.address: str = address
+
+class Multicast:
+    def __init__(self, address: IPv6, repetition: int):
+        # List[IPv6] must be parsed
+        self.addresses: List[IPv6] = [address] * repetition

tests/py2puml/inspection/test_inspectclass.py

@@ -1,7 +1,9 @@
 
-from typing import Dict, List
+from typing import Dict, List, Tuple
 from importlib import import_module
 
+from pytest import fixture
+
 from py2puml.domain.umlitem import UmlItem
 from py2puml.domain.umlclass import UmlClass, UmlAttribute
 from py2puml.domain.umlrelation import UmlRelation, RelType
@@ -14,9 +16,17 @@
 from tests.asserts.relation import assert_relation
 
 
-def test_inspect_module_should_find_static_and_instance_attributes():
-    domain_items_by_fqn: Dict[str, UmlItem] = {}
-    domain_relations: List[UmlRelation] = []
+@fixture(scope='function')
+def domain_items_by_fqn() -> Dict[str, UmlItem]:
+    return {}
+
+@fixture(scope='function')
+def domain_relations() -> List[UmlRelation]:
+    return []
+
+def test_inspect_module_should_find_static_and_instance_attributes(
+    domain_items_by_fqn: Dict[str, UmlItem], domain_relations: List[UmlRelation]
+):
     inspect_module(
         import_module('tests.modules.withconstructor'),
         'tests.modules.withconstructor',
@@ -70,9 +80,9 @@ def test_inspect_module_should_find_static_and_instance_attributes():
         RelType.COMPOSITION
     )
 
-def test_inspect_module_should_find_abstract_class():
-    domain_items_by_fqn: Dict[str, UmlItem] = {}
-    domain_relations: List[UmlRelation] = []
+def test_inspect_module_should_find_abstract_class(
+    domain_items_by_fqn: Dict[str, UmlItem], domain_relations: List[UmlRelation]
+):
     inspect_module(
         import_module('tests.modules.withabstract'),
         'tests.modules.withabstract',
@@ -91,9 +101,9 @@ def test_inspect_module_should_find_abstract_class():
     assert domain_relations[0].source_fqn == 'tests.modules.withabstract.ClassTemplate'
     assert domain_relations[0].target_fqn == 'tests.modules.withabstract.ConcreteClass'
 
-def test_inspect_module_parse_class_constructor_should_not_process_inherited_constructor():
-    domain_items_by_fqn: Dict[str, UmlItem] = {}
-    domain_relations: List[UmlRelation] = []
+def test_inspect_module_parse_class_constructor_should_not_process_inherited_constructor(
+    domain_items_by_fqn: Dict[str, UmlItem], domain_relations: List[UmlRelation]
+):
     # inspects the two sub-modules
     inspect_module(
         import_module('tests.modules.withinheritedconstructor.point'),
@@ -127,9 +137,9 @@ def test_inspect_module_parse_class_constructor_should_not_process_inherited_con
     unit_attribute = metric_origin_umlitem.attributes[0]
     assert_attribute(unit_attribute, 'unit', 'str', expected_staticity=True)
 
-def test_inspect_module_should_unwrap_decorated_constructor():
-    domain_items_by_fqn: Dict[str, UmlItem] = {}
-    domain_relations: List[UmlRelation] = []
+def test_inspect_module_should_unwrap_decorated_constructor(
+    domain_items_by_fqn: Dict[str, UmlItem], domain_relations: List[UmlRelation]
+):
     inspect_module(
         import_module('tests.modules.withwrappedconstructor'),
         'tests.modules.withwrappedconstructor',
@@ -148,3 +158,26 @@ def test_inspect_module_should_unwrap_decorated_constructor():
     # PointDecoratedWithoutWrapping UmlClass
     point_without_wrapping_umlitem: UmlClass = domain_items_by_fqn['tests.modules.withwrappedconstructor.PointDecoratedWithoutWrapping']
     assert len(point_without_wrapping_umlitem.attributes) == 0, 'the attributes of the original constructor could not be found, the constructor was not wrapped by the decorator'
+
+def test_inspect_module_should_handle_compound_types_with_numbers_in_their_name(
+    domain_items_by_fqn: Dict[str, UmlItem], domain_relations: List[UmlRelation]
+):
+    fqdn = 'tests.modules.withcompoundtypewithdigits'
+    inspect_module(
+        import_module(fqdn), fqdn,
+        domain_items_by_fqn, domain_relations
+    )
+
+    assert len(domain_items_by_fqn) == 2, 'two classes must be inspected'
+
+    # IPv6 UmlClass
+    ipv6_umlitem: UmlClass = domain_items_by_fqn[f'{fqdn}.IPv6']
+    assert len(ipv6_umlitem.attributes) == 1, '1 attributes of IPv6 must be inspected'
+    address_attribute = ipv6_umlitem.attributes[0]
+    assert_attribute(address_attribute, 'address', 'str', expected_staticity=False)
+
+    # Multicast UmlClass
+    multicast_umlitem: UmlClass = domain_items_by_fqn[f'{fqdn}.Multicast']
+    assert len(multicast_umlitem.attributes) == 1, '1 attributes of Multicast must be inspected'
+    address_attribute = multicast_umlitem.attributes[0]
+    assert_attribute(address_attribute, 'addresses', 'List[IPv6]', expected_staticity=False)

tests/py2puml/parsing/test_compoundtypesplitter.py

@@ -34,6 +34,7 @@ def test_CompoundTypeSplitter_from_invalid_types(type_annotation: str):
     ('_ast.Name', ('_ast.Name',)),
     ('Tuple[str, withenum.TimeUnit]', ('Tuple', '[', 'str', ',', 'withenum.TimeUnit', ']')),
     ('List[datetime.date]', ('List', '[', 'datetime.date', ']')),
+    ('List[IPv6]', ('List', '[', 'IPv6', ']')),
     ('modules.withenum.TimeUnit', ('modules.withenum.TimeUnit',)),
     ('Dict[str, Dict[str,builtins.float]]', ('Dict', '[', 'str', ',', 'Dict', '[', 'str', ',', 'builtins.float', ']', ']')),
 ])

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.6.0'
+    assert __version__ == '0.6.1'
 
 # Description also output in the CLI
 def test_description():