add pint support to str_spice and cleanup

FabriceSalvaire · FabriceSalvaire · commit 084028a1f2ca · 2024-01-26T02:20:19.000+01:00
diff --git a/PySpice/Spice/AnalysisParameters.py b/PySpice/Spice/AnalysisParameters.py
@@ -44,8 +44,8 @@
 
 ####################################################################################################
 
-from ..Tools.StringTools import join_list
 from ..Unit import as_s, as_Hz
+from .StringTools import join_list
 
 ####################################################################################################
 
diff --git a/PySpice/Spice/BasicElement.py b/PySpice/Spice/BasicElement.py
@@ -99,7 +99,6 @@
 
 import logging
 
-from ..Tools.StringTools import str_spice, join_list, join_dict
 from ..Unit import U_m, U_s, U_A, U_V, U_Degree, U_Ω, U_F, U_H, U_Hz
 from .Element import (
     AnyPinElement,
@@ -124,6 +123,8 @@
     IntKeyParameter,
     ModelPositionalParameter,
 )
+from .StringTools import join_list, join_dict
+from .unit import str_spice
 
 ####################################################################################################
 
diff --git a/PySpice/Spice/DeviceModel.py b/PySpice/Spice/DeviceModel.py
@@ -22,7 +22,7 @@
 
 ####################################################################################################
 
-from PySpice.Tools.StringTools import join_dict
+from .StringTools import join_dict
 
 ####################################################################################################
 
diff --git a/PySpice/Spice/Element.py b/PySpice/Spice/Element.py
@@ -38,13 +38,13 @@
 
 ####################################################################################################
 
-from PySpice.Tools.StringTools import join_list
 from .ElementParameter import (
     ParameterDescriptor,
     PositionalElementParameter,
     FlagParameter, KeyValueParameter,
 )
 from .FakeDipole import FakeDipole
+from .StringTools import join_list
 
 ####################################################################################################
 
diff --git a/PySpice/Spice/ElementParameter.py b/PySpice/Spice/ElementParameter.py
@@ -25,7 +25,7 @@
 ####################################################################################################
 
 from ..Unit import Unit
-from ..Tools.StringTools import str_spice
+from .unit import str_spice
 
 ####################################################################################################
 
diff --git a/PySpice/Spice/HighLevelElement.py b/PySpice/Spice/HighLevelElement.py
@@ -27,9 +27,10 @@
 ####################################################################################################
 
 from ..Math import rms_to_amplitude, amplitude_to_rms
-from ..Tools.StringTools import join_list, join_dict, str_spice, str_spice_list
 from ..Unit import as_s, as_V, as_A, as_Hz
 from .BasicElement import VoltageSource, CurrentSource
+from .StringTools import join_list, join_dict
+from .unit import str_spice, str_spice_list
 
 ####################################################################################################
 
diff --git a/PySpice/Spice/Netlist.py b/PySpice/Spice/Netlist.py
@@ -87,9 +87,10 @@ def __init__(self, **kwargs):
 
 ####################################################################################################
 
-from PySpice.Tools.StringTools import join_lines, join_list, prefix_lines, TextBuffer
+from PySpice.Tools.TextBuffer import TextBuffer
 from .DeviceModel import DeviceModel
 from .Element import Pin
+from .StringTools import join_list, prefix_lines
 
 ####################################################################################################
 
diff --git a/PySpice/Spice/Parser/HighLevelParser.py b/PySpice/Spice/Parser/HighLevelParser.py
@@ -81,8 +81,8 @@
 import logging
 import os
 
-from PySpice.Spice.Netlist import Node
-from PySpice.Tools.StringTools import remove_multi_space
+from ..Netlist import Node
+from ..StringTools import remove_multi_space
 from . import Ast
 from . import ElementData
 from .Ast import AstNode
diff --git a/PySpice/Spice/Simulation.py b/PySpice/Spice/Simulation.py
@@ -33,7 +33,7 @@
 
 ####################################################################################################
 
-from ..Tools.StringTools import join_list, join_dict, str_spice, TextBuffer
+from ..Tools.TextBuffer import TextBuffer
 from ..Unit import as_Degree, u_Degree
 from .AnalysisParameters import (
     ACAnalysisParameters,
@@ -48,6 +48,8 @@
     TransferFunctionAnalysisParameters,
     TransientAnalysisParameters,
 )
+from .StringTools import join_list, join_dict
+from .unit import str_spice
 
 ####################################################################################################
 
diff --git a/PySpice/Spice/StringTools.py b/PySpice/Spice/StringTools.py
@@ -22,45 +22,22 @@
     'join_dict',
     'join_lines',
     'join_list',
-    'str_spice',
-    'str_spice_list',
     'prefix_lines',
     'remove_multi_space',
-    'TextBufer',
 ]
 
 ####################################################################################################
 
 import os
 
-####################################################################################################
-
-from PySpice.Unit.Unit import UnitValue
-
-####################################################################################################
-
-def str_spice(obj, unit=True):
-    # Fixme: right place ???
-    '''Convert an object to a Spice compatible string.'''
-    if isinstance(obj, UnitValue):
-        if unit:
-            return obj.str_spice()
-        else:   # Fixme: ok ???
-            return obj.str(spice=False, space=False, unit=False)
-    else:
-        return str(obj)
-
-####################################################################################################
-
-def str_spice_list(*args):
-    return [str_spice(x) for x in args]
+from .unit import str_spice
 
 ####################################################################################################
 
 def prefix_lines(items, prefix=''):
     return [prefix + str(item)
             for item in items
-            if item is not None] # Fixme: and item
+            if item is not None]   # Fixme: and item
 
 ####################################################################################################
 
@@ -110,35 +87,3 @@ def remove_multi_space(txt: str) -> str:
         new_txt += c
         last_c = c
     return new_txt
-
-####################################################################################################
-
-class TextBuffer:
-
-    ##############################################
-
-    def __init__(self):
-        self._lines = []
-
-    ##############################################
-
-    def _append_line(self, line):
-        if line is not None:
-            _ = str(line)
-            if _:
-                self._lines.append(_)
-
-    ##############################################
-
-    def __iadd__(self, obj):
-        if isinstance(obj, (list, tuple)):
-            for _ in obj:
-                self._append_line(_)
-        else:
-            self._append_line(obj)
-        return self
-
-    ##############################################
-
-    def __str__(self):
-        return os.linesep.join(self._lines)
diff --git a/PySpice/Spice/unit.py b/PySpice/Spice/unit.py
@@ -0,0 +1,100 @@
+####################################################################################################
+#
+# PySpice - A Spice Package for Python
+# Copyright (C) 2024 Fabrice Salvaire
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+####################################################################################################
+
+__all__ = [
+    'str_spice',
+    'str_spice_list',
+]
+
+####################################################################################################
+
+import logging
+
+####################################################################################################
+
+from PySpice.Unit.Unit import UnitValue
+
+####################################################################################################
+
+_module_logger = logging.getLogger(__name__)
+
+####################################################################################################
+
+SPICE_SUFFIX = {
+    'Tera': 'T',
+    'Giga': 'G',
+    'Mega': 'Meg',
+    'Kilo': 'K',
+    'Mil': 'mil',
+    'milli': 'm',
+    'micro': 'u',
+    'nano': 'n',
+    'pico': 'p',
+    'femto': 'f',
+    'atto': 'a',
+}
+_ = {}
+for name, suffix in SPICE_SUFFIX.items():
+    if name[0].isupper():
+        _[name.lower()] = suffix
+SPICE_SUFFIX.update(_)
+
+try:
+    import pint
+
+    @pint.register_unit_format('spice')
+    def format_spice_unit(unit, registry, **options) -> str:
+        # See Ngspice Manual — 2.1.4.2 Numbers
+        # See https://pint.readthedocs.io/en/stable/user/formatting.html#string-formatting-specification
+        # registry.parse_unit_name
+        #   return tuple of tuples (str, str, str)
+        #   all non-equivalent combinations of (prefix, unit name, suffix)
+        unit_tuple = registry.parse_unit_name(str(unit), case_sensitive=False)
+        prefix = unit_tuple[0][0]
+        if prefix and prefix not in SPICE_SUFFIX:
+            raise ValueError(f"unsupported Pint unit {unit}")
+        _ = str(unit)
+        # Fixme: useless ?
+        if _.startswith('mega'):
+            _ = 'Mega' + _[4:]
+        return _
+except ImportError:
+    pint = None
+
+####################################################################################################
+
+def str_spice(obj, unit=True):
+    # Fixme: right place ???
+    '''Convert an object to a Spice compatible string.'''
+    if isinstance(obj, UnitValue):
+        if unit:
+            return obj.str_spice()
+        else:   # Fixme: ok ???
+            return obj.str(spice=False, space=False, unit=False)
+    elif pint and isinstance(obj, pint.Quantity):
+        # _module_logger.info(f'Pint {obj} -> {obj:spice}')
+        return f"{obj:spice}".replace(' ', '')
+    else:
+        return str(obj)
+
+####################################################################################################
+
+def str_spice_list(*args):
+    return [str_spice(x) for x in args]
diff --git a/PySpice/Tools/TextBuffer.py b/PySpice/Tools/TextBuffer.py
@@ -0,0 +1,59 @@
+####################################################################################################
+#
+# PySpice - A Spice Package for Python
+# Copyright (C) 2014 Fabrice Salvaire
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+####################################################################################################
+
+__all__ = [
+    'TextBuffer',
+]
+
+####################################################################################################
+
+import os
+
+####################################################################################################
+
+class TextBuffer:
+
+    ##############################################
+
+    def __init__(self):
+        self._lines = []
+
+    ##############################################
+
+    def _append_line(self, line):
+        if line is not None:
+            _ = str(line)
+            if _:
+                self._lines.append(_)
+
+    ##############################################
+
+    def __iadd__(self, obj):
+        if isinstance(obj, (list, tuple)):
+            for _ in obj:
+                self._append_line(_)
+        else:
+            self._append_line(obj)
+        return self
+
+    ##############################################
+
+    def __str__(self):
+        return os.linesep.join(self._lines)
