eda-netlist-parser 0.1.0__tar.gz

eda_netlist_parser-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rohaan Scherpbier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

eda_netlist_parser-0.1.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: eda-netlist-parser
+Version: 0.1.0
+Summary: Pure-Python parser for SPICE-family netlist files (.spi, .cir, .cdl, .scs, .spf)
+License: MIT License
+        
+        Copyright (c) 2025 Rohaan Scherpbier
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/rohaansch/netlist-parser
+Keywords: EDA,SPICE,netlist,CDL,Spectre,VLSI,semiconductor,simulation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: color
+Requires-Dist: termcolor>=1.1; extra == "color"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: termcolor>=1.1; extra == "dev"
+Dynamic: license-file
+
+# eda-netlist-parser
+
+A pure-Python parser for SPICE-family netlist files: `.spi`, `.cir`, `.cdl`, `.scs`, `.spf`, `.sp`, `.hsp`.
+
+[![CI](https://github.com/rohaansch/netlist-parser/actions/workflows/ci.yml/badge.svg)](https://github.com/rohaansch/netlist-parser/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/badge/python-3.7%2B-blue)](https://pypi.org/project/eda-netlist-parser/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+## Installation
+
+```bash
+pip install eda-netlist-parser
+# optional colored terminal output:
+pip install eda-netlist-parser[color]
+```
+
+[![PyPI](https://img.shields.io/pypi/v/eda-sdf-parser)](https://pypi.org/project/eda-netlist-parser/)
+[![Python](https://img.shields.io/pypi/pyversions/eda-sdf-parser)](https://pypi.org/project/eda-netlist-parser/)
+
+## Quick start
+
+```python
+from netlist_parser import NetlistParser, NetlistError
+
+parser = NetlistParser()
+
+try:
+    netlist = parser.parse("design.spi")
+except NetlistError as e:
+    print(f"Error: {e}")
+
+for cell in netlist.cells:
+    print(cell.name, cell.ports)
+    for inst in cell.instances:
+        print("  ", inst.name, inst.code, inst.device_name)
+```
+
+### Importing
+
+```python
+from netlist_parser import NetlistParser
+from netlist_parser import NetlistParser, Netlist, NetlistCell, DeviceInstance
+```
+
+## API
+
+### `NetlistParser(internal=False)`
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `parse(filename)` | `Netlist` | Parse a single file |
+| `read(path, data=None)` | varies | Parse file or directory |
+
+`read()` data modes:
+
+| `data=` | Returns |
+|---------|---------|
+| `None` | `Netlist` |
+| `'cells'` | `Set[str]` |
+| `'ports'` | `Dict[str, List[str]]` |
+| `'devices'` | `Dict[str, Set[str]]` |
+| `'device-params'` | `Dict[str, Dict]` |
+| `'resistors'` | `Dict[str, List]` |
+| `'capacitors'` | `Dict[str, List]` |
+
+### Classes
+
+- `Netlist` — full file data: `.cells`, `.version`, `.resistance`, `.capacitance`, `.layer_map`
+- `NetlistCell` — one subckt: `.name`, `.ports`, `.instances`, `.substitute`
+- `DeviceInstance` — one line: `.name`, `.code`, `.nodes`, `.device_name`, `.number`, `.parameters`
+- `NetlistError` — raised on file errors
+
+## CLI
+
+```
+netlist-parser sample.spi                   # summary
+netlist-parser sample.spi --cells           # list cell names
+netlist-parser sample.spi --ports           # cell → ports
+netlist-parser sample.spi --devices         # cell → device names
+netlist-parser sample.spi --cell inv_x1     # one cell detail
+netlist-parser --version
+```
+
+## License
+
+[MIT](LICENSE)

eda_netlist_parser-0.1.0/README.md

@@ -0,0 +1,86 @@
+# eda-netlist-parser
+
+A pure-Python parser for SPICE-family netlist files: `.spi`, `.cir`, `.cdl`, `.scs`, `.spf`, `.sp`, `.hsp`.
+
+[![CI](https://github.com/rohaansch/netlist-parser/actions/workflows/ci.yml/badge.svg)](https://github.com/rohaansch/netlist-parser/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/badge/python-3.7%2B-blue)](https://pypi.org/project/eda-netlist-parser/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+## Installation
+
+```bash
+pip install eda-netlist-parser
+# optional colored terminal output:
+pip install eda-netlist-parser[color]
+```
+
+[![PyPI](https://img.shields.io/pypi/v/eda-sdf-parser)](https://pypi.org/project/eda-netlist-parser/)
+[![Python](https://img.shields.io/pypi/pyversions/eda-sdf-parser)](https://pypi.org/project/eda-netlist-parser/)
+
+## Quick start
+
+```python
+from netlist_parser import NetlistParser, NetlistError
+
+parser = NetlistParser()
+
+try:
+    netlist = parser.parse("design.spi")
+except NetlistError as e:
+    print(f"Error: {e}")
+
+for cell in netlist.cells:
+    print(cell.name, cell.ports)
+    for inst in cell.instances:
+        print("  ", inst.name, inst.code, inst.device_name)
+```
+
+### Importing
+
+```python
+from netlist_parser import NetlistParser
+from netlist_parser import NetlistParser, Netlist, NetlistCell, DeviceInstance
+```
+
+## API
+
+### `NetlistParser(internal=False)`
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `parse(filename)` | `Netlist` | Parse a single file |
+| `read(path, data=None)` | varies | Parse file or directory |
+
+`read()` data modes:
+
+| `data=` | Returns |
+|---------|---------|
+| `None` | `Netlist` |
+| `'cells'` | `Set[str]` |
+| `'ports'` | `Dict[str, List[str]]` |
+| `'devices'` | `Dict[str, Set[str]]` |
+| `'device-params'` | `Dict[str, Dict]` |
+| `'resistors'` | `Dict[str, List]` |
+| `'capacitors'` | `Dict[str, List]` |
+
+### Classes
+
+- `Netlist` — full file data: `.cells`, `.version`, `.resistance`, `.capacitance`, `.layer_map`
+- `NetlistCell` — one subckt: `.name`, `.ports`, `.instances`, `.substitute`
+- `DeviceInstance` — one line: `.name`, `.code`, `.nodes`, `.device_name`, `.number`, `.parameters`
+- `NetlistError` — raised on file errors
+
+## CLI
+
+```
+netlist-parser sample.spi                   # summary
+netlist-parser sample.spi --cells           # list cell names
+netlist-parser sample.spi --ports           # cell → ports
+netlist-parser sample.spi --devices         # cell → device names
+netlist-parser sample.spi --cell inv_x1     # one cell detail
+netlist-parser --version
+```
+
+## License
+
+[MIT](LICENSE)

eda_netlist_parser-0.1.0/eda_netlist_parser.egg-info/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: eda-netlist-parser
+Version: 0.1.0
+Summary: Pure-Python parser for SPICE-family netlist files (.spi, .cir, .cdl, .scs, .spf)
+License: MIT License
+        
+        Copyright (c) 2025 Rohaan Scherpbier
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/rohaansch/netlist-parser
+Keywords: EDA,SPICE,netlist,CDL,Spectre,VLSI,semiconductor,simulation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: color
+Requires-Dist: termcolor>=1.1; extra == "color"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: termcolor>=1.1; extra == "dev"
+Dynamic: license-file
+
+# eda-netlist-parser
+
+A pure-Python parser for SPICE-family netlist files: `.spi`, `.cir`, `.cdl`, `.scs`, `.spf`, `.sp`, `.hsp`.
+
+[![CI](https://github.com/rohaansch/netlist-parser/actions/workflows/ci.yml/badge.svg)](https://github.com/rohaansch/netlist-parser/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/badge/python-3.7%2B-blue)](https://pypi.org/project/eda-netlist-parser/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+## Installation
+
+```bash
+pip install eda-netlist-parser
+# optional colored terminal output:
+pip install eda-netlist-parser[color]
+```
+
+[![PyPI](https://img.shields.io/pypi/v/eda-sdf-parser)](https://pypi.org/project/eda-netlist-parser/)
+[![Python](https://img.shields.io/pypi/pyversions/eda-sdf-parser)](https://pypi.org/project/eda-netlist-parser/)
+
+## Quick start
+
+```python
+from netlist_parser import NetlistParser, NetlistError
+
+parser = NetlistParser()
+
+try:
+    netlist = parser.parse("design.spi")
+except NetlistError as e:
+    print(f"Error: {e}")
+
+for cell in netlist.cells:
+    print(cell.name, cell.ports)
+    for inst in cell.instances:
+        print("  ", inst.name, inst.code, inst.device_name)
+```
+
+### Importing
+
+```python
+from netlist_parser import NetlistParser
+from netlist_parser import NetlistParser, Netlist, NetlistCell, DeviceInstance
+```
+
+## API
+
+### `NetlistParser(internal=False)`
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `parse(filename)` | `Netlist` | Parse a single file |
+| `read(path, data=None)` | varies | Parse file or directory |
+
+`read()` data modes:
+
+| `data=` | Returns |
+|---------|---------|
+| `None` | `Netlist` |
+| `'cells'` | `Set[str]` |
+| `'ports'` | `Dict[str, List[str]]` |
+| `'devices'` | `Dict[str, Set[str]]` |
+| `'device-params'` | `Dict[str, Dict]` |
+| `'resistors'` | `Dict[str, List]` |
+| `'capacitors'` | `Dict[str, List]` |
+
+### Classes
+
+- `Netlist` — full file data: `.cells`, `.version`, `.resistance`, `.capacitance`, `.layer_map`
+- `NetlistCell` — one subckt: `.name`, `.ports`, `.instances`, `.substitute`
+- `DeviceInstance` — one line: `.name`, `.code`, `.nodes`, `.device_name`, `.number`, `.parameters`
+- `NetlistError` — raised on file errors
+
+## CLI
+
+```
+netlist-parser sample.spi                   # summary
+netlist-parser sample.spi --cells           # list cell names
+netlist-parser sample.spi --ports           # cell → ports
+netlist-parser sample.spi --devices         # cell → device names
+netlist-parser sample.spi --cell inv_x1     # one cell detail
+netlist-parser --version
+```
+
+## License
+
+[MIT](LICENSE)

eda_netlist_parser-0.1.0/eda_netlist_parser.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+README.md
+pyproject.toml
+eda_netlist_parser.egg-info/PKG-INFO
+eda_netlist_parser.egg-info/SOURCES.txt
+eda_netlist_parser.egg-info/dependency_links.txt
+eda_netlist_parser.egg-info/entry_points.txt
+eda_netlist_parser.egg-info/requires.txt
+eda_netlist_parser.egg-info/top_level.txt
+netlist_parser/__init__.py
+netlist_parser/__main__.py
+netlist_parser/parser.py
+netlist_parser/utils.py
+tests/test_cli.py
+tests/test_exceptions.py
+tests/test_integration.py
+tests/test_parser.py

eda_netlist_parser-0.1.0/eda_netlist_parser.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

eda_netlist_parser-0.1.0/eda_netlist_parser.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+netlist-parser = netlist_parser.__main__:main

eda_netlist_parser-0.1.0/eda_netlist_parser.egg-info/requires.txt

@@ -0,0 +1,7 @@
+
+[color]
+termcolor>=1.1
+
+[dev]
+pytest>=7
+termcolor>=1.1

eda_netlist_parser-0.1.0/eda_netlist_parser.egg-info/top_level.txt

@@ -0,0 +1 @@
+netlist_parser

eda_netlist_parser-0.1.0/netlist_parser/__init__.py

@@ -0,0 +1,20 @@
+"""netlist_parser — Pure-Python parser for SPICE-family netlist files."""
+
+from .parser import (
+    NetlistError,
+    Netlist,
+    NetlistCell,
+    DeviceInstance,
+    NetlistParser,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "NetlistParser",
+    "Netlist",
+    "NetlistCell",
+    "DeviceInstance",
+    "NetlistError",
+    "__version__",
+]

eda_netlist_parser-0.1.0/netlist_parser/__main__.py

@@ -0,0 +1,117 @@
+"""CLI entry point: python -m netlist_parser  or  netlist-parser (installed script)."""
+
+import argparse
+import sys
+
+from .parser import NetlistParser, NetlistError
+from . import __version__
+
+
+def main() -> None:
+    ap = argparse.ArgumentParser(
+        prog="netlist-parser",
+        description="Parse a SPICE-family netlist file and print its content.",
+        epilog=(
+            "Examples:\n"
+            "  netlist-parser sample.spi\n"
+            "  netlist-parser sample.spi --cells\n"
+            "  netlist-parser sample.spi --ports\n"
+            "  netlist-parser sample.spi --devices\n"
+            "  netlist-parser sample.spi --cell inv_x1\n"
+            "  netlist-parser --version\n"
+        ),
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    ap.add_argument("path", nargs="?", help="Path to a netlist file")
+    ap.add_argument(
+        "--cells",
+        action="store_true",
+        help="Print cell names defined in the file",
+    )
+    ap.add_argument(
+        "--ports",
+        action="store_true",
+        help="Print each cell and its port list",
+    )
+    ap.add_argument(
+        "--devices",
+        action="store_true",
+        help="Print each cell and the device names it uses",
+    )
+    ap.add_argument(
+        "--cell",
+        metavar="NAME",
+        help="Print detailed info for a specific cell",
+    )
+    ap.add_argument(
+        "--version",
+        action="store_true",
+        help="Print package version and exit",
+    )
+    args = ap.parse_args()
+
+    if args.version:
+        print(__version__)
+        return
+
+    if not args.path:
+        ap.error("the following arguments are required: path")
+
+    parser = NetlistParser()
+    try:
+        netlist = parser.parse(args.path)
+    except NetlistError as exc:
+        print(f"Error: {exc}", file=sys.stderr)
+        sys.exit(1)
+
+    if args.cells:
+        for cell in netlist.cells:
+            print(cell.name)
+        return
+
+    if args.ports:
+        for cell in netlist.cells:
+            ports = " ".join(cell.ports)
+            print(f"{cell.name}: {ports}")
+        return
+
+    if args.devices:
+        for cell in netlist.cells:
+            device_names = sorted(
+                {inst.device_name for inst in cell.instances if inst.device_name}
+            )
+            print(f"{cell.name}: {', '.join(device_names)}")
+        return
+
+    if args.cell:
+        target = args.cell
+        for cell in netlist.cells:
+            if cell.name == target:
+                print(f"Cell: {cell.name}")
+                print(f"  Ports: {' '.join(cell.ports)}")
+                print(f"  Instances ({len(cell.instances)}):")
+                for inst in cell.instances:
+                    line = f"    {inst.name}  code={inst.code}"
+                    if inst.device_name:
+                        line += f"  device={inst.device_name}"
+                    if inst.number:
+                        line += f"  number={inst.number}"
+                    if inst.nodes:
+                        line += f"  nodes={inst.nodes}"
+                    if inst.parameters:
+                        line += f"  params={inst.parameters}"
+                    print(line)
+                return
+        print(f"Error: cell '{target}' not found in {args.path}", file=sys.stderr)
+        sys.exit(1)
+
+    # Default: summary
+    print(f"File:  {args.path}")
+    print(f"Format: {netlist.version}")
+    print(f"Cells ({len(netlist.cells)}):")
+    for cell in netlist.cells:
+        print(f"  {cell.name}  ports={len(cell.ports)}  instances={len(cell.instances)}")
+
+
+if __name__ == "__main__":
+    main()