port over inductor

Author: dragoncoder047

schemascii/components_render.py renamed to schemascii/OLD_components_render.py

@@ -15,13 +15,10 @@
     make_text_point,
     bunch_o_lines,
     deep_transform,
-    make_plus,
-    make_variable,
     sort_terminals_counterclockwise,
     light_arrows,
     sort_for_flags,
-    is_clockwise,
-)
+    is_clockwise)
 from .errors import TerminalsError, BOMError, UnsupportedComponentError
 
 # pylint: disable=unbalanced-tuple-unpacking
@@ -97,42 +94,6 @@ def sort_terminals(
     return sort_terminals
 
 
-@component("L", "VL", "LV")
-@n_terminal(2)
-@no_ambiguous
-def inductor(box: Cbox, terminals: list[Terminal],
-             bom_data: BOMData, **options):
-    """Draw an inductor (coil, choke, etc)
-    bom:henries"""
-    t1, t2 = terminals[0].pt, terminals[1].pt
-    vec = t1 - t2
-    mid = (t1 + t2) / 2
-    length = abs(vec)
-    angle = phase(vec)
-    scale = options["scale"]
-    data = f"M{t1.real * scale} {t1.imag * scale}"
-    dxdy = rect(scale, angle)
-    for _ in range(int(length)):
-        data += f"a1 1 0 01 {-dxdy.real} {dxdy.imag}"
-    return (
-        XML.path(
-            d=data,
-            stroke=options["stroke"],
-            fill="transparent",
-            stroke__width=options["stroke_width"],
-        )
-        + make_variable(mid, angle, "V" in box.type, **options)
-        + id_text(
-            box,
-            bom_data,
-            terminals,
-            (("H", False),),
-            make_text_point(t1, t2, **options),
-            **options,
-        )
-    )
-
-
 @component("B", "BT", "BAT")
 @polarized
 @no_ambiguous

schemascii/components/inductor.py

@@ -0,0 +1,46 @@
+from cmath import phase, rect
+
+import schemascii.components as _c
+import schemascii.data_consumer as _dc
+import schemascii.utils as _utils
+
+
+class Inductor(_c.PolarizedTwoTerminalComponent, _c.SimpleComponent,
+               ids=("L",), namespaces=(":inductor",)):
+    options = [
+        "inherit",
+        _dc.Option("value", str, "Inductance in henries"),
+        _dc.Option("current", str, "Maximum current rating in amps", None)
+    ]
+
+    @property
+    def value_format(self):
+        return [("value", "H", False, self.is_variable),
+                ("current", "A", False)]
+
+    def render(self, **options) -> str:
+        t1, t2 = self.terminals[0].pt, self.terminals[1].pt
+        vec = t1 - t2
+        length = abs(vec)
+        angle = phase(vec)
+        scale = options["scale"]
+        data = f"M{t1.real * scale} {t1.imag * scale}"
+        d = rect(scale, angle)
+        for _ in range(int(length)):
+            data += f"a1 1 0 01 {-d.real} {d.imag}"
+        return (
+            _utils.XML.path(d=data, stroke=options["stroke"],
+                            fill="transparent",
+                            stroke__width=options["stroke_width"])
+            + self.format_id_text(
+                _utils.make_text_point(t1, t2, **options), **options))
+
+
+class VariableInductor(Inductor, ids=("VL", "LV")):
+    is_variable = True
+
+    def render(self, **options):
+        t1, t2 = self.terminals[0].pt, self.terminals[1].pt
+        return (super().render(**options)
+                + _utils.make_variable(
+                    (t1 + t2) / 2, phase(t1 - t2), **options))

scripts/docs.py

@@ -2,13 +2,9 @@
 import re
 import os
 from itertools import groupby
-from schemascii.components_render import RENDERERS
 
-# pylint: disable=unspecified-encoding,missing-function-docstring,invalid-name
-# pylint: disable=not-an-iterable
-# cSpell:ignore siht etareneg redner iicsa stpircs nettirwrevo ylpmis segnahc
-# cSpell:ignore mehcs daetsn detareneg yllacitamotua codc stnenopmoc lliw ruo
-# cSpell:ignore sgnirtscod
+raise NotImplementedError("TODO: re-write docs generator script "
+                          "after I re-do the cmdline help text")
 
 TOP = ("# Supported Schemascii Components\n\n<!--\n"
        + "".join(reversed("/stpircs nur dna\nyp.redner_stnenopmoc/iicsa"