add inline options

TODO: document the change & release

Author: dragoncoder047

release.py

@@ -41,7 +41,7 @@ def writefile(file, text):
 cmd("python3 -m build --sdist")
 cmd("python3 -m build --wheel")
 
-cmd("schemascii test_data/test_charge_pump.txt --out test_data/test_charge_pump.txt.svg --padding 30")
+cmd("schemascii test_data/test_charge_pump.txt --out test_data/test_charge_pump.txt.svg")
 
 print("for some reason convert isn't working with the css, so aborting the auto-rendering")
 sys.exit(0)

schemascii/__init__.py

@@ -1,3 +1,5 @@
+from .inline_config import get_inline_configs
+from .configs import apply_config_defaults
 from .grid import Grid
 from .components import find_all
 from .edgemarks import find_edge_marks
@@ -8,36 +10,16 @@
 
 __version__ = "0.1.3"
 
-default_options = {
-    'padding': 10,
-    'scale': 15,
-    'stroke_width': 2,
-    'stroke': 'black',
-    'label': 'LV',
-    'nolabels': False,
-}
-
-option_types = {
-    'padding': float,
-    'scale': float,
-    'stroke_width': float,
-    'stroke': str,
-    'label': str,
-    'nolabels': bool,
-}
-
 
 def render(filename: str, text: str = None, **options) -> str:
     "Render the Schemascii diagram to an SVG string."
     if text is None:
         with open(filename, encoding="ascii") as f:
             text = f.read()
-    # default options
-    options = default_options | options
-    for oname, otypefun in option_types.items():
-        options[oname] = otypefun(options[oname])
     # get everything
     grid = Grid(filename, text)
+    # Passed-in options override diagram inline options
+    options = apply_config_defaults(get_inline_configs(grid) | options)
     components, bom_data = find_all(grid)
     terminals = {c: find_edge_marks(grid, c) for c in components}
     fixed_bom_data = {c: [b for b in bom_data if

schemascii/__main__.py

@@ -3,6 +3,7 @@
 import warnings
 from . import render, __version__
 from .errors import Error
+from .configs import add_config_arguments
 
 
 def cli_main():
@@ -18,30 +19,7 @@ def cli_main():
                     default=None,
                     dest="out_file",
                     help="Output SVG file. (default input file plus .svg)")
-    ap.add_argument("--padding",
-                    help="Amount of padding to add on the edges.",
-                    type=int,
-                    default=10)
-    ap.add_argument("--scale",
-                    help="Scale at which to enlarge the entire diagram by.",
-                    type=int,
-                    default=15)
-    ap.add_argument("--stroke_width",
-                    help="Width of the lines",
-                    type=int,
-                    default=2)
-    ap.add_argument("--stroke",
-                    help="Color of the lines.",
-                    default="black")
-    ap.add_argument("--label",
-                    help="Component label style "
-                    "(L=include label, V=include value, VL=both)",
-                    choices=["L", "V", "VL"],
-                    default="VL")
-    ap.add_argument("--nolabels",
-                    help="Turns off labels on all components, "
-                    "except for part numbers on ICs.",
-                    action="store_true")
+    add_config_arguments(ap)
     args = ap.parse_args()
     if args.out_file is None:
         args.out_file = args.in_file + ".svg"

schemascii/configs.py

@@ -0,0 +1,63 @@
+import argparse
+from dataclasses import dataclass
+from .errors import ArgumentError
+
+
+@dataclass
+class ConfigConfig:
+    name: str
+    clazz: type | list
+    default: object
+    description: str
+
+
+OPTIONS = [
+    ConfigConfig("padding", float, 10,
+                 "Amount of padding to add on the edges."),
+    ConfigConfig("scale", float, 15,
+                 "Scale at which to enlarge the entire diagram by."),
+    ConfigConfig("stroke_width", float, 2, "Width of the lines"),
+    ConfigConfig("stroke", str, "black", "Color of the lines."),
+    ConfigConfig("label", ["", "VL", "L", "V"], "VL",
+                 "Component label style (L=include label, V=include value, VL=both)"),
+    ConfigConfig("nolabels", bool, False,
+                 "Turns off labels on all components, except for part numbers on ICs."),
+]
+
+
+def add_config_arguments(a: argparse.ArgumentParser):
+    "Register all the config options on the argument parser."
+    for opt in OPTIONS:
+        if isinstance(opt.clazz, list):
+            a.add_argument(
+                "--" + opt.name,
+                help=opt.description,
+                choices=opt.clazz,
+                default=opt.default)
+        else:
+            a.add_argument(
+                "--" + opt.name,
+                help=opt.description,
+                type=opt.clazz,
+                default=opt.default)
+
+
+def apply_config_defaults(options: dict) -> dict:
+    "Merge the defaults and ensure the options are the right type."
+    for opt in OPTIONS:
+        if opt.name not in options:
+            options[opt.name] = opt.default
+            continue
+        if isinstance(opt.clazz, list):
+            if options[opt.name] not in opt.clazz:
+                raise ArgumentError(
+                    f"config option {opt.name}: invalid choice: {options[opt.name]} "
+                    f"(valid options are {', '.join(map(repr, opt.clazz))})")
+            continue
+        try:
+            options[opt.name] = opt.clazz(options[opt.name])
+        except ValueError as err:
+            raise ArgumentError(f"config option {opt.name}: "
+                                f"invalid {opt.clazz.__name__} value: "
+                                f"{options[opt.name]}") from err
+    return options

schemascii/errors.py

@@ -16,3 +16,7 @@ class BOMError(ValueError, Error):
 
 class UnsupportedComponentError(NameError, Error):
     "Component type is not supported."
+
+
+class ArgumentError(ValueError, Error):
+    "Invalid config argument value."

schemascii/grid.py

@@ -1,5 +1,5 @@
 class Grid:
-    """Helper class for manmaging a 2-D
+    """Helper class for managing a 2-D
     grid of ASCII art."""
 
     def __init__(self, filename: str, data: str = None):

schemascii/inline_config.py

@@ -0,0 +1,32 @@
+import re
+from .grid import Grid
+
+INLINE_CONFIG_RE = re.compile(r"!([a-z]+)=([^!]*)!", re.I)
+
+
+def get_inline_configs(grid: Grid) -> dict:
+    out = {}
+    for y, line in enumerate(grid.lines):
+        for m in INLINE_CONFIG_RE.finditer(line):
+            interval = m.span()
+            key = m.group(1)
+            val = m.group(2)
+            for x in range(*interval):
+                grid.setmask(complex(x, y))
+            try:
+                val = float(val)
+            except ValueError:
+                pass
+            out[key] = val
+    return out
+
+
+if __name__ == '__main__':
+    g = Grid("null",
+             """
+foobar -------C1-------
+!padding=30!!label=!
+!foobar=bar!
+""")
+    print(get_inline_configs(g))
+    print(g)

test_data/test_charge_pump.txt

@@ -1,4 +1,4 @@
-*--BAT1+--*-------*---*
+*--BAT1+--*-------*---*      !padding=30!
 |         |       |   |
 |         R1    .~~~. |
 |         |     :   :-*