feat: add support to detect and document methods

Author: jonykalavera

init.sh

@@ -21,4 +21,4 @@ echo "$(date '+%Y-%m-%d_%H:%M:%S') $(poetry --version) will be used to install d
 
 # installs the project dependencies
 echo "$(date '+%Y-%m-%d_%H:%M:%S') poetry ${depsinstall}"
-poetry ${depsinstall}
+poetry ${depsinstall}

py2puml/__main__.py

@@ -1,4 +1,4 @@
 from py2puml.cli import run
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     run()

py2puml/asserts.py

@@ -5,12 +5,17 @@
 from py2puml.py2puml import py2puml
 
 
-def assert_py2puml_is_file_content(domain_path: str, domain_module: str, diagram_filepath: Union[str, Path]):
+def assert_py2puml_is_file_content(
+    domain_path: str, domain_module: str, diagram_filepath: Union[str, Path]
+):
     # reads the existing class diagram
-    with open(diagram_filepath, 'r', encoding='utf8') as expected_puml_file:
+    with open(diagram_filepath, "r", encoding="utf8") as expected_puml_file:
         assert_py2puml_is_stringio(domain_path, domain_module, expected_puml_file)
 
-def assert_py2puml_is_stringio(domain_path: str, domain_module: str, expected_content_stream: StringIO):
+
+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))
 
@@ -19,7 +24,14 @@ def assert_py2puml_is_stringio(domain_path: str, domain_module: str, expected_co
 
 def assert_multilines(actual_multilines: List[str], expected_multilines: Iterable[str]):
     line_index = 0
-    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(actual_multilines), f'actual and expected diagrams have {line_index + 1} lines'
+    for line_index, (actual_line, expected_line) in enumerate(
+        zip(actual_multilines, expected_multilines)
+    ):
+        # print(actual_line[:-1])
+        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(
+        actual_multilines
+    ), f"actual and expected diagrams have {line_index + 1} lines"

py2puml/cli.py

@@ -14,11 +14,21 @@ def run():
     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 = ArgumentParser(
+        description="Generate PlantUML class diagrams to document your Python application."
+    )
 
-    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)
+    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,
+    )
 
     args = argparser.parse_args()
-    print(''.join(py2puml(args.path, args.module)))
+    print("".join(py2puml(args.path, args.module)))

py2puml/domain/package.py

@@ -1,9 +1,11 @@
 from dataclasses import dataclass, field
 from typing import List
 
+
 @dataclass
 class Package:
-    '''A folder or a python module'''
+    """A folder or a python module"""
+
     name: str
-    children: List['Package'] = field(default_factory=list)
+    children: List["Package"] = field(default_factory=list)
     items_number: int = 0

py2puml/domain/umlclass.py

@@ -1,15 +1,47 @@
-from typing import List
-from dataclasses import dataclass
+from dataclasses import dataclass, field
+from typing import Dict, List
 
 from py2puml.domain.umlitem import UmlItem
 
+
 @dataclass
 class UmlAttribute:
     name: str
     type: str
     static: bool
 
+
+@dataclass
+class UmlMethod:
+    name: str
+    arguments: Dict = field(default_factory=dict)
+    is_static: bool = False
+    is_class: bool = False
+    return_type: str = None
+
+    def represent_as_puml(self):
+        items = []
+        if self.is_static:
+            items.append("{static}")
+        if self.return_type:
+            items.append(self.return_type)
+        items.append(f"{self.name}({self.signature})")
+        return " ".join(items)
+
+    @property
+    def signature(self):
+        if self.arguments:
+            return ", ".join(
+                [
+                    f"{arg_type} {arg_name}" if arg_type else f"{arg_name}"
+                    for arg_name, arg_type in self.arguments.items()
+                ]
+            )
+        return ""
+
+
 @dataclass
 class UmlClass(UmlItem):
     attributes: List[UmlAttribute]
+    methods: List[UmlMethod]
     is_abstract: bool = False

py2puml/domain/umlenum.py

@@ -1,13 +1,15 @@
-from typing import List
 from dataclasses import dataclass
+from typing import List
 
 from py2puml.domain.umlitem import UmlItem
 
+
 @dataclass
 class Member:
     name: str
     value: str
 
+
 @dataclass
 class UmlEnum(UmlItem):
     members: List[Member]

py2puml/domain/umlitem.py

@@ -1,6 +1,7 @@
 from dataclasses import dataclass
 
+
 @dataclass
 class UmlItem:
     name: str
-    fqn: str
+    fqn: str

py2puml/domain/umlrelation.py

@@ -1,10 +1,12 @@
 from dataclasses import dataclass
 from enum import Enum, unique
 
+
 @unique
 class RelType(Enum):
-    COMPOSITION = '*'
-    INHERITANCE = '<|'
+    COMPOSITION = "*"
+    INHERITANCE = "<|"
+
 
 @dataclass
 class UmlRelation:

py2puml/example.py

@@ -1,11 +1,9 @@
 from py2puml.py2puml import py2puml
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     # outputs the PlantUML content in the terminal
-    print(''.join(
-        py2puml('py2puml/domain', 'py2puml.domain')
-    ))
+    print("".join(py2puml("py2puml/domain", "py2puml.domain")))
 
     # writes the PlantUML content in a file
-    with open('py2puml/py2puml.domain.puml', 'w', encoding='utf8') as puml_file:
-        puml_file.writelines(py2puml('py2puml/domain', 'py2puml.domain'))
+    with open("py2puml/py2puml.domain.puml", "w", encoding="utf8") as puml_file:
+        puml_file.writelines(py2puml("py2puml/domain", "py2puml.domain"))