Refactoring of fole and classes names.

Author: pascalbauermeister

src/umlsequence2/__init__.py

@@ -1,16 +1 @@
-import os
-import sys
-
-from .renderer import Renderer
-from .parser import Parser
-
-def generate_svg(input_fp, output_path, percent_zoom, debug, bgcolor):
- cmds, raw = Parser(input_fp.read()).parse()
-
- if debug:
- print(raw, file=sys.stderr)
- print("----------", file=sys.stderr)
- for cmd in cmds:
- print(cmd[0], ', '.join([repr(a) for a in cmd[1:]]))
-
- Renderer(cmds, output_path, percent_zoom, bgcolor).run()
+# File needed for this dir to be a package

src/umlsequence2/convert.py

@@ -1,31 +1,34 @@
-#!/usr/bin/env python3
-
-"""Command-line UML sequence diagram generator (version 2).
-Converts a textual UML sequence description into a graphic file.
------
-See https://github.com/pbauermeister/umlsequence2/ for information,
-syntax and examples.
------
-(C) Copyright 2021 by Pascal Bauermeister.
------
-Usage:
- umlsequence2 -h print help for options
- umlsequence2 FILE.umlsequence generates FILE.svg
-
-See README.md for more information.
-"""
+"""Orchestrate the work.
+
+Parse commandline args, read input, generate diagram, and convert to
+desired output format.
 
+"""
 import argparse
 import io
 import os
 import re
 import sys
 import tempfile
 
-from umlsequence2 import generate_svg
-from umlsequence2.convert import convert
+from .converter import convert
+from .uml_builder import UmlBuilder
+from .parser import Parser
+
+
+def generate_svg(input_fp, output_path, percent_zoom, debug, bgcolor):
+ cmds, raw = Parser(input_fp.read()).parse()
 
-def run(input_fp, output_path, percent_zoom, debug, bgcolor, format):
+ if debug:
+ print(raw, file=sys.stderr)
+ print("----------", file=sys.stderr)
+ for cmd in cmds:
+ print(cmd[0], ', '.join([repr(a) for a in cmd[1:]]))
+
+ UmlBuilder(cmds, output_path, percent_zoom, bgcolor).run()
+
+
+def generate(input_fp, output_path, percent_zoom, debug, bgcolor, format):
  if debug:
  print(dict(input=input_fp.name,
  output=output_path,
@@ -44,11 +47,8 @@ def run(input_fp, output_path, percent_zoom, debug, bgcolor, format):
  convert(path, output_path, format)
 
 
-def main():
- parts = [each.strip() for each in __doc__.split('-----')]
- parser = argparse.ArgumentParser(
- description=parts[0],
- epilog=parts[1])
+def main(description, epilog):
+ parser = argparse.ArgumentParser(description=description, epilog=epilog)
 
  parser.add_argument('INPUT_FILE',
  action="store",
@@ -110,8 +110,8 @@ def main():
  inp = io.StringIO(snippet['src'])
  name = snippet['output']
  inp.name = name
- run(inp, name, args.percent_zoom, args.debug, args.background_color,
- args.format)
+ 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)
 
@@ -128,15 +128,12 @@ def main():
  # output to stdout
  with tempfile.TemporaryDirectory() as d:
  path = os.path.join(d, 'file.svg')
- run(inp, path, args.percent_zoom, args.debug, args.background_color,
- args.format)
+ generate(inp, path, args.percent_zoom, args.debug,
+  args.background_color, args.format)
  with open(path) as f:
  print(f.read())
  else:
  # output to file
- run(inp, name, args.percent_zoom, args.debug, args.background_color,
- args.format)
+ generate(inp, name, args.percent_zoom, args.debug,
+  args.background_color, args.format)
  sys.exit(0)
-
-if __name__ == "__main__":
- main()

src/umlsequence2/run.py renamed to src/umlsequence2/main.py

@@ -1,11 +1,14 @@
+"""Parse input code.
+
+Tokenize and parse input code, and translate to intermediate commands.
+
+"""
 import re
 
 
 def escape(s):
  return s.replace('&', '&amp;').replace('<', '&lt;').replace('>', '&gt;')
 
-###############################################################################
-
 
 class Parser:
  RE_MESSAGE = re.compile(

src/umlsequence2/parser.py

@@ -1,18 +1,21 @@
+"""Implement graphic primitives as SVG elements."""
 import svgwrite
 from svgwrite import cm, mm
 
 from .config import CONFIG
 
+
 def cm2px(cm):
  return cm * 35.43307
  return round(cm * 35.43307, 2)
 
+
 def px2cm(px):
  return px / 35.43307
  return round(px / 35.43307, 2)
 
 
-class SvgBuilder:
+class SvgRenderer:
  def __init__(self, out_path, percent_zoom, bg_color='white'):
  self.dwg = svgwrite.Drawing(filename=out_path, debug=True)
  self.zoom = percent_zoom/100

src/umlsequence2/svg_builder.py renamed to src/umlsequence2/svg_renderer.py

@@ -1,44 +1,44 @@
+"""Render intermediate UML code to graphic primitives."""
 import sys
 import re
 from subprocess import Popen, PIPE
 from collections import OrderedDict, namedtuple
 
 from .config import CONFIG as C
-from .svg_builder import SvgBuilder
+from .svg_renderer import SvgRenderer
 
 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, renderer):
+def error(message, builder):
  print(f'ERROR: {message}:', file=sys.stderr)
- print(f' {renderer.line_nr}: {renderer.line}', file=sys.stderr)
+ print(f' {builder.line_nr}: {builder.line}', file=sys.stderr)
  sys.exit(1)
 
 
 class CheckedOrderedDict(OrderedDict):
- def __init__(self, name, renderer):
+ def __init__(self, name, builder):
  self.name = name
- self.renderer = renderer
+ self.builder = builder
  super().__init__()
 
  def __getitem__(self, key):
  try:
  return super().__getitem__(key)
  except KeyError:
- error(f'There is no {self.name} named "{key}"', self.renderer)
+ error(f'There is no {self.name} named "{key}"', self.builder)
  sys.exit(1)
 
 
-class Renderer:
+class UmlBuilder:
  def __init__(self, lines, out_path, percent_zoom, bg_color):
  self.lines = lines
- self.gfx = SvgBuilder(out_path, percent_zoom, bg_color)
+ self.gfx = SvgRenderer(out_path, percent_zoom, bg_color)
  self.warnings = set()
  self.g = {}
 

src/umlsequence2/renderer.py renamed to src/umlsequence2/uml_builder.py

@@ -1,10 +1,24 @@
 #!/usr/bin/env python3
+
+"""Command-line UML sequence diagram generator (version 2).
+Converts a textual UML sequence description into a graphic file.
+-----
+See https://github.com/pbauermeister/umlsequence2/ for information,
+syntax and examples.
+-----
+(C) Copyright 2021 by Pascal Bauermeister.
+-----
+See README.md for more information.
+"""
+
 import os.path
 import sys
 
 home = os.path.split(sys.argv[0])[0]
 sys.path.append(os.path.join(home, 'src'))
 
 if __name__ == "__main__":
- from src.umlsequence2.run import main
- main()
+ from src.umlsequence2.main import main
+
+ desc, epilog, _, _ = [each.strip() for each in __doc__.split('-----')]
+ main(desc, epilog)