Cosmetic refactorings, Update of docs.

Author: pascalbauermeister

CHANGES.md

@@ -0,0 +1,10 @@
+# Changes
+
+## Version 2.0.6
+- use more recent setuptools.
+- use Typing and mypy.
+- require Python 3.10 or upper.
+
+## Version 2.0.5 and below
+- Rewrite of https://github.com/pbauermeister/umlsequence in pure
+  Python (+ reportlab).

README.md

@@ -1,15 +1,26 @@
 umlsequence2
 ============
 
-UML Sequence Diagrams Generator - Commandline tool to generate
+UML Sequence Diagrams Generator, version 2<sup>[1]</sup> -
+Commandline tool to generate
 diagrams as images in various formats (SVG, PNG, JPG, PDF, etc.) from
 source text files.
 
-Source code: https://github.com/pbauermeister/umlsequence2
+- Source code: https://github.com/pbauermeister/umlsequence2
+- Package page: https://pypi.org/project/umlsequence2/
 
-(This is a pure-Python rewrite of the
+<sub>[1] This is a pure-Python rewrite of the
 https://github.com/pbauermeister/umlsequence project, which was itself
-based on umlgraph by Diomidis Spinellis.)
+based on umlgraph (in Java) by Diomidis Spinellis.</sub>
+
+## Scope
+
+"*A sequence diagram or system sequence diagram (SSD) shows process interactions
+arranged in time sequence in the field of software engineering. It depicts the
+processes involved and the sequence of messages exchanged between the processes
+needed to carry out the functionality.*"
+-- [Wikipedia](https://en.wikipedia.org/wiki/Sequence_diagram)
+## Summary
 
 Source text files are in the so-called "umlsequence" syntax.
 
@@ -20,21 +31,21 @@ Umlsequence syntax example:
     T : t:thread
     O : :Toolkit
     P :
-    
+
     # messages and activations
     E  -> T+ a1:run(3)
     T  -> O+ run()
     O        >callbackLoop()
-    
+
     # creation
     O+ :> P  p:Peer
-    
+
     # message with response
     O- => P  result=handleExpose()
-    
+
     # destruction
     O  #> P
-    
+
     # deactivation
     T- O-
 

TODO.md

@@ -0,0 +1,7 @@
+# TODO:
+
+- in uml_builder, move keywords to constants defined in model
+- in parser, move preprocess to own module
+- in parser, refactor regex and handling
+- in parser, refactor horrendous do_line() in smaller functions.
+

src/umlsequence2/__init__.py

@@ -25,10 +25,9 @@
 
 from .config import get_config, set_config
 from .converter import convert
-from .model import Config
 from .parser import Parser
 from .uml_builder import UmlBuilder
-from . import error
+from . import error, model
 
 VERSION = pkg_resources.require("umlsequence2")[0].version
 
@@ -132,7 +131,7 @@ def parse_args() -> argparse.Namespace:
                  if args.__dict__[k] is not None}
     if conf_args:
         cfg.update(conf_args)
-        set_config(Config(**cfg))
+        set_config(model.Config(**cfg))
 
     return args
 
@@ -194,7 +193,7 @@ def main() -> None:
     try:
         run(args)
     except model.UmlSequenceError as e:
-        error.print_error(e)
+        error.print_error(str(e))
         sys.exit(1)
 
     sys.exit(0)

src/umlsequence2/parser.py

@@ -4,9 +4,9 @@
 
 """
 import re
+from typing import Any
 
 from . import model
-from typing import Any
 
 
 def escape(s: str) -> str:
@@ -37,24 +37,15 @@ class Parser:
         "([#A-Za-z_0-9]*)([\+\-\#~!]?)"
         " *"
         "(.*)")
-
-    #RE_MESSAGE_call = re.compile("([A-Za-z_0-9]+) *(=) *(.*)")
     RE_MESSAGE_call = re.compile("(.*?) *(=) *(.*)")
-
     RE_OBJ_STATE = re.compile("([A-Za-z_0-9]+[\+\-\#~!]|:)+")
-
     RE_CONSTRAINT = re.compile("([A-Za-z_0-9]*)([\+\-\#~!]?) *(_?)\{(.*)\}")
 
     extensions = ['.dot']
 
     def __init__(self, raw: str):
-        # save call arguments for later use in format()
-        #self.raw = raw.encode('utf-8')
-        #self.raw = raw.encode('latin1')
         self.raw = raw
 
-        return
-
     def parse1(self, lines: list[str]) -> list[model.Command]:
         cmds: list[model.Command] = []
 

src/umlsequence2/svg_renderer.py

@@ -2,7 +2,6 @@
 from typing import Sequence
 
 import svgwrite
-from svgwrite import cm, mm
 
 from .config import get_config
 

src/umlsequence2/uml_builder.py

@@ -3,9 +3,8 @@
 
 import re
 import sys
-from collections import OrderedDict, namedtuple
-from subprocess import PIPE, Popen
-from typing import Any, TypeVar, Callable
+from collections import OrderedDict
+from typing import Any, Callable, TypeVar
 
 from .config import get_config
 from .svg_renderer import SvgRenderer
@@ -33,10 +32,10 @@ def __init__(self, name: str, builder: UmlBuilder):
 
     def __getitem__(self, key: str) -> T:
         try:
-            return super().__getitem__(key)
+            res = super().__getitem__(key)
         except KeyError:
             error(f'There is no {self.name} named "{key}"', self.builder)
-
+        return res
 
 CODict = CheckedOrderedDict