docs(readme): complex compound types are properly handled (#38)

Author: lucsorel

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.7.0')
+    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.7.1')
     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)
 

pyproject.toml

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

tests/__init__.py

@@ -1,23 +1,23 @@
 from os.path import dirname, realpath, join
-from re import compile
+from re import compile as re_compile
 from itertools import takewhile
 
 # exports the version and the project description read from the pyproject.toml file
 __version__ = None
 __description__ = None
 
 PARENT_DIR = dirname(dirname(realpath(__file__)))
-VERSION_PATTERN = compile('^version = "([^"]+)"$')
-DESCRIPTION_PATTERN = compile('^description = "([^"]+)"$')
+VERSION_PATTERN = re_compile('^version = "([^"]+)"$')
+DESCRIPTION_PATTERN = re_compile('^description = "([^"]+)"$')
 
-def get_from_line_and_pattern(line: str, pattern) -> str:
-    pattern_match = pattern.search(line)
+def get_from_line_and_pattern(content_line: str, pattern) -> str:
+    pattern_match = pattern.search(content_line)
     if pattern_match is None:
         return None
     else:
         return pattern_match.group(1)
 
-with open(join(PARENT_DIR, 'pyproject.toml')) as pyproject:
+with open(join(PARENT_DIR, 'pyproject.toml'), encoding='utf8') as pyproject:
     for line in takewhile(lambda _: __version__ is None or __description__ is None, pyproject):
         __version__ = __version__ if __version__ is not None else get_from_line_and_pattern(line, VERSION_PATTERN)
         __description__ = __description__ if __description__ is not None else get_from_line_and_pattern(line, DESCRIPTION_PATTERN)

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

tests/py2puml/test_cli.py

@@ -1,7 +1,7 @@
+from subprocess import run, PIPE
 from typing import List
 
 from pytest import mark
-from subprocess import run, PIPE
 
 from py2puml.py2puml import py2puml
 from tests import __version__, __description__