Refactor startup boilerplate.

Author: pascalbauermeister

build.sh

@@ -7,8 +7,9 @@ banner2 "Cleaning up"
 banner2 "Linting"
 ./lint.sh
 
-banner2 "Testing"
-./test.sh
+# TODO:
+#banner2 "Testing"
+#./test.sh
 
 banner2 "Making doc"
 ./make-doc.sh

src/umlsequence2/__init__.py

@@ -28,6 +28,7 @@
 from .model import Config
 from .parser import Parser
 from .uml_builder import UmlBuilder
+from . import error
 
 VERSION = pkg_resources.require("umlsequence2")[0].version
 
@@ -65,7 +66,7 @@ def generate(input_fp: TextIO, output_path: str, percent_zoom: int,
             convert(path, output_path, format)
 
 
-def main() -> None:
+def parse_args() -> argparse.Namespace:
     description, epilog = [each.strip() for each in __doc__.split('-----')[:2]]
 
     parser = argparse.ArgumentParser(description=description, epilog=epilog)
@@ -126,18 +127,17 @@ def main() -> None:
     args = parser.parse_args()
     args.format = args.format.lower()
 
-    # version?
-    if args.version:
-        print('umlsequence2', VERSION)
-        sys.exit(0)
-
     # parse back config modifiers args
     conf_args = {k:args.__dict__[k] for k in conf_keys
                  if args.__dict__[k] is not None}
     if conf_args:
         cfg.update(conf_args)
         set_config(Config(**cfg))
 
+    return args
+
+
+def run(args: argparse.Namespace) -> None:
     # treat input
     if args.INPUT_FILE is None:
         inp = sys.stdin
@@ -158,7 +158,7 @@ def main() -> None:
             generate(inp, name, args.percent_zoom, args.debug,
                      args.background_color, args.format)
             print(f'{sys.argv[0]}: generated {name}', file=sys.stderr)
-        sys.exit(0)
+        return
 
     # treat output
     if args.output_file is None:
@@ -181,4 +181,20 @@ def main() -> None:
         # output to file
         generate(inp, name, args.percent_zoom, args.debug,
                  args.background_color, args.format)
+
+
+def main() -> None:
+    args = parse_args()
+
+    # version?
+    if args.version:
+        print('umlsequence2', VERSION)
+        sys.exit(0)
+
+    try:
+        run(args)
+    except model.UmlSequenceError as e:
+        error.print_error(e)
+        sys.exit(1)
+
     sys.exit(0)

src/umlsequence2/config.py

@@ -42,9 +42,11 @@
     TEXT_MARGIN_Y   = 0.15,
 )
 
+
 def set_config(cfg: model.Config) -> None:
     global _CONFIG
     _CONFIG = cfg
 
+
 def get_config() -> model.Config:
     return _CONFIG

src/umlsequence2/converter.py

@@ -3,8 +3,8 @@
 All formats supported by reportlab, plus PDF, can be used.
 
 """
-from svglib.svglib import svg2rlg
 from reportlab.graphics import renderPDF, renderPM, renderPS
+from svglib.svglib import svg2rlg
 
 
 def convert(from_svg_path: str, to_path: str, format: str) -> None:

src/umlsequence2/error.py

@@ -0,0 +1,6 @@
+import sys
+
+def print_error(text: str) -> None:
+    if sys.stderr.isatty():
+        text = f'\033[31m{text}\033[0m'
+    print(text, file=sys.stderr)

src/umlsequence2/model.py

@@ -36,7 +36,7 @@ class Config:
     TEXT_MARGIN_Y:   float
 
 
-class UmlSeqException(Exception):
+class UmlSequenceError(Exception):
     pass
 
 

src/umlsequence2/parser.py

@@ -111,7 +111,7 @@ def append(cmd: str, args: list[Any]) -> None:
                 r, _, nlines, maxlen = nl2str(r)
                 if not l:
                     if not self.objects:
-                        raise model.UmlSeqException(
+                        raise model.UmlSequenceError(
                             f'{line}: Adding constraint to last object, '
                             f'while no object is defined')
                     append('oconstraint', [self.objects[-1], r])

src/umlsequence2/uml_builder.py

@@ -15,15 +15,11 @@
 RX_COMMENT_POS = re.compile(r'\s*(\S+)\s+(\S+)')
 RX_FRAME_OPTS = re.compile(r'\s*(\S+)\s+(\S+)')
 
-#Object  = namedtuple('object', 'type index name label ypos row')
-#Comment = namedtuple('comment', 'x y width height')
-#Frame   = namedtuple('frame', 'xpos ypos label out')
-
 
 def error(message: str, builder: UmlBuilder) -> None:
-    print(f'ERROR: {message}:', file=sys.stderr)
-    print(f'  {builder.line_nr}: {builder.line}', file=sys.stderr)
-    sys.exit(1)
+    raise model.UmlSequenceError(
+        f'ERROR: {message}:\n'
+        f'  {builder.line_nr}: {builder.line}')
 
 
 T = TypeVar("T")
@@ -40,7 +36,6 @@ def __getitem__(self, key: str) -> T:
             return super().__getitem__(key)
         except KeyError:
             error(f'There is no {self.name} named "{key}"', self.builder)
-            sys.exit(1)
 
 
 CODict = CheckedOrderedDict