Merge pull request #263 from nunobrum/262-regex-error-with-comments-in-netlist

262 regex error with comments in netlist

Author: nunobrum

README.md

@@ -1,6 +1,6 @@
 # README <!-- omit in toc -->
 
-_current version: 1.4.7_
+_current version: 1.4.8 (alpha)_
 
 *spicelib* is a toolchain of python utilities design to interact with spice simulators, as for example:
 
@@ -1124,9 +1124,10 @@ in [GitHub spicelib issues](https://github.com/nunobrum/spicelib/issues)
 
 ## History
 * Version 1.4.8
+    * Fixing Issue #262 - Support for comments in netlists
     * SpiceEditor: Allow writing of netlists directly to an io.StringIO buffer (Issue  #258)
 * Version 1.4.7
-    * Implementing a lazy loading approach in RawRead 
+    * Implementing a lazy loading approach in RawRead
     * Fixing Issue #256 - Correct add_component() in SpiceEditor
     * Support for string parameters - Issue #154
 * Version 1.4.6

examples/testfiles/all_elements_lt.net

@@ -84,7 +84,7 @@ Q2 NC_38 NC_39 NC_40 BC517 temp=60 ic=0.6, 5
 * Rxxx n1 n2 <value> [tc=tc1, tc2, ...] [temp=<value>] ...
 * Rxxx n+ n- <value> <mname> <l=length> <w=width> ...
 * Rxxx n+ n- R = 'expression' <tc1=value> <tc2=value> <noisy=0> ...
-R1 in out 10k
+R1 in out 10k ; withcomments
 R2 NC_41 NC_42 R=2k5R
 R3 NC_41 NC_42 'V(cc) < {Vt} ? {R1} : {R2}' temp=13
 R4 in out 10k tol=1% pwr=0.1
@@ -114,7 +114,7 @@ W1 NC_56 NC_57 V1 W on
 
 * Xxxx n1 n2 n3... <subckt name> [<parameter>=<expression>]
 XU1 1 2 a
-X§U2 NC_58 NC_59 NC_60 NC_61 NC_62 AD549
+X§U2 NC_58 NC_59 NC_60 NC_61 NC_62 AD549 ;§ withcomments
 XU3 NC_01 NC_02 NC_03 NC_04 NC_05 level2 Avol=1Meg GBW=10Meg Slew=10Meg Ilimit=25m Rail=0 Vos=0 En=0 Enk=0 In=0 Ink=0 Rin=500Meg
 XU4 in out1 V1 V2 out1 OPAx189 bla_v2 =1% bla_sp1=2 bla_sp2 = 3
 XU5 in out1 V1 V2 out1 GND OPAx189_float

spicelib/editor/spice_editor.py

@@ -74,11 +74,15 @@ def PREFIX_AND_NODES_RGX(prefix: str, nodes_min: int, nodes_max: int = None) ->
     return "^(?P<designator>" + prefix + "§?\\w+)(?P<nodes>(?:\\s+[\\w+-\\.¥]+){" + nodes_str + "})"
 
 
+# Optional comment at end of line. Will consume trailing spaces and is to be used on all lines.
+COMMENT_RGX = r"(?:\s+;.*)?\\?\s*$"
+
 # Potential model name, probably needs expanding. Will require a leading space
 MODEL_OR_VALUE_RGX = r"\s+(?P<value>[\w\.\-\{\}]+)"
 
-# the rest of the line. Cannot be used with PARAM. Will require a leading space, and finish the line
-ANY_VALUE_RGX = r"\s+(?P<value>.*)$"
+# the rest of the line. Cannot be used with PARAM. 
+# Includes the comment regex and will expect to finish the line.
+ANY_VALUE_RGX = r"\s+(?P<value>.*)" + COMMENT_RGX
 
 # maybe a value. Will require a leading space
 MAYBE_VALUE_RGX = r"\s+(?P<value>.*?)"
@@ -108,8 +112,9 @@ def VALUE_RGX(prefix: str, number_regex_suffix: str) -> str:
 
 # Parameters expression of the type: key = value. 
 # key must be a full word without signs or dots
-# Value may be composite, and contain multiple spaces and quotes. Will expect to finish the line.
-PARAM_RGX = r"(?P<params>(\s+\w+\s*(=\s*[\w\{\}\(\)\-\+\*\/%\.\,'\"\s]+)?)*)?\\?\s*$"
+# Value may be composite, and contain multiple spaces and quotes. 
+# Includes the comment regex and will expect to finish the line.
+PARAM_RGX = r"(?P<params>(\s+\w+\s*(=\s*[\w\{\}\(\)\-\+\*\/%\.\,'\"\s]+)?)*)?" + COMMENT_RGX
 
 
 REPLACE_REGEXS = {
@@ -153,11 +158,11 @@ def VALUE_RGX(prefix: str, number_regex_suffix: str) -> str:
     # Ixxx n+ n- R=<value>
     # Ixxx n+ n- PWL(t1 i1 t2 i2 t3 i3...)
     # Ixxx n+ n- wavefile=<filename> [chan=<nnn>]
-    'I': PREFIX_AND_NODES_RGX("I", 2) + MAYBE_VALUE_RGX + r"(?P<params>(\s+\w+\s*=\s*[\w\{\}\(\)\-\+\*\/%\.\,'\"\s]+)*)$",  # Independent Current Source
+    'I': PREFIX_AND_NODES_RGX("I", 2) + MAYBE_VALUE_RGX + r"(?P<params>(\s+\w+\s*=\s*[\w\{\}\(\)\-\+\*\/%\.\,'\"\s]+)*)" + COMMENT_RGX,  # Independent Current Source
     # Jxxx D G S <model> [area] [off] [IC=Vds, Vgs] [temp=T]
     'J': PREFIX_AND_NODES_RGX("J", 3) + MODEL_OR_VALUE_RGX + PARAM_RGX,  # JFET
     # Kxxx Lyyy Lzzz ... value
-    'K': PREFIX_AND_NODES_RGX("K", 2, 99) + r"\s+(?P<value>[\+\-]?[0-9\.E+-]+[kmuµnpgt]?).*$",  # Mutual Inductance
+    'K': PREFIX_AND_NODES_RGX("K", 2, 99) + r"\s+(?P<value>[\+\-]?[0-9\.E+-]+[kmuµnpgt]?)" + COMMENT_RGX,  # Mutual Inductance
     # Lxxx n+ n- <value> <mname> <nt=val> <m=val> ...
     # Lxxx n+ n- L = 'expression' <tc1=value> <tc2=value>
     'L': PREFIX_AND_NODES_RGX("L", 2) + VALUE_RGX("L", r"(Meg|[kmuµnpgt])?H?\d*") + PARAM_RGX,  # Inductance
@@ -192,14 +197,14 @@ def VALUE_RGX(prefix: str, number_regex_suffix: str) -> str:
     # Vxxx n+ n- PWL(t1 v1 t2 v2 t3 v3...)
     # Vxxx n+ n- wavefile=<filename> [chan=<nnn>]
     # ex: V1 NC_08 NC_09 PWL(1u 0 +2n 1 +1m 1 +2n 0 +1m 0 +2n -1 +1m -1 +2n 0) AC 1 2 Rser=3 Cpar=4
-    'V': PREFIX_AND_NODES_RGX("V", 2) + MAYBE_VALUE_RGX + r"(?P<params>(\s+\w+\s*=\s*[\w\{\}\(\)\-\+\*\/%\.\,'\"\s]+)*)$",  # Independent Voltage Source
+    'V': PREFIX_AND_NODES_RGX("V", 2) + MAYBE_VALUE_RGX + r"(?P<params>(\s+\w+\s*=\s*[\w\{\}\(\)\-\+\*\/%\.\,'\"\s]+)*)" + COMMENT_RGX,  # Independent Voltage Source
     # Wxxx n1 n2 Vnam <model> [on,off]
     'W': PREFIX_AND_NODES_RGX("W", 3) + ANY_VALUE_RGX,  # Current Controlled Switch
     # Xxxx n1 n2 n3... <subckt name> [<parameter>=<expression>]
     # ex: XU1 NC_01 NC_02 NC_03 NC_04 NC_05 level2 Avol=1Meg GBW=10Meg Slew=10Meg Ilimit=25m Rail=0 Vos=0 En=0 Enk=0 In=0 Ink=0 Rin=500Meg
     #     XU1 in out1 -V +V out1 OPAx189 bla_v2 =1% bla_sp1=2 bla_sp2 = 3
     #     XU1 in out1 -V +V out1 GND OPAx189_float    
-    'X': PREFIX_AND_NODES_RGX("X", 1, 99) + MODEL_OR_VALUE_RGX + r"(?:\s+(?P<params>(?:\w+\s*=\s*['\"{]?.*?['\"}]?\s*)+))?\\?\s*$",
+    'X': PREFIX_AND_NODES_RGX("X", 1, 99) + MODEL_OR_VALUE_RGX + r"(?:\s+(?P<params>(?:\w+\s*=\s*['\"{]?.*?['\"}]?\s*)+))?" + COMMENT_RGX,  # Subcircuit Instance
     # (ngspice) Yxxx N1 0 N2 0 mname <LEN=LENGTH>
     # (qspice) Ynnn N+ N- <frequency1> dF=<value> Ctot=<value> [Q=<value>]
     'Y': PREFIX_AND_NODES_RGX("Y", 2, 4) + MODEL_OR_VALUE_RGX + PARAM_RGX,  # Single Lossy Transmission Line

unittests/golden/all_elements_lt.net

@@ -82,7 +82,7 @@ Q2 NC_38 NC_39 NC_40 1e-9 temp=60 ic=0.6, 5
 * Rxxx n1 n2 <value> [tc=tc1, tc2, ...] [temp=<value>] ...
 * Rxxx n+ n- <value> <mname> <l=length> <w=width> ...
 * Rxxx n+ n- R = 'expression' <tc1=value> <tc2=value> <noisy=0> ...
-R1 in out 1e-9
+R1 in out 1e-9 ; withcomments
 R2 NC_41 NC_42 R= 1e-9
 R3 NC_41 NC_42 1e-9 temp=13
 R4 in out 1e-9 tol=1% pwr=0.1
@@ -112,7 +112,7 @@ W1 NC_56 NC_57 V1 1e-9
 
 * Xxxx n1 n2 n3... <subckt name> [<parameter>=<expression>]
 XU1 1 2 1e-9
-XU2 NC_58 NC_59 NC_60 NC_61 NC_62 1e-9
+XU2 NC_58 NC_59 NC_60 NC_61 NC_62 1e-9 ;§ withcomments
 XU3 NC_01 NC_02 NC_03 NC_04 NC_05 1e-9 Avol=1Meg GBW=10Meg Slew=10Meg Ilimit=25m Rail=0 Vos=0 En=1e-09 In=0 Ink=0 Rin=500Meg blabla=1 2 3 4 5 6 7
 XU4 in out1 V1 V2 out1 1e-9 bla_v2=1e-09 bla_sp2=3 blabla=1 2 3 4 5 6 7
 XU5 in out1 V1 V2 out1 GND 1e-9

unittests/test_spice_editor.py

@@ -527,7 +527,12 @@ def test_elements(self):
         for el, exp in expected.items():
             # print(f"Reading {el}")
             value = exp[0]
-            self.assertEqual(edt.get_component_value(el).casefold(), value.casefold(), f"Test reading {el} Value")
+            if value is None:
+                value = ""
+            v2 = edt.get_component_value(el)
+            if v2 is None:
+                v2 = ""
+            self.assertEqual(v2.casefold(), value.casefold(), f"Test reading {el} Value")
             params = edt.get_component_parameters(el)
             self.assertDictEqual(params, params | exp[1], f"Test reading {el} Parameters")