From aa71785bd51f945d4f6ae1b3ed70f2d8b078b18c Mon Sep 17 00:00:00 2001
From: Sam Crow <samuelkcrow@gmail.com>
Date: Tue, 18 Jul 2023 11:28:30 -0700
Subject: [PATCH] fix circular import with pin and net

---
 compiler/base/hierarchy_spice.py | 106 ++++++++++++++++++++++++++++++-
 compiler/base/net_spice.py       |  51 ---------------
 compiler/base/pin_spice.py       |  71 ---------------------
 3 files changed, 104 insertions(+), 124 deletions(-)
 delete mode 100644 compiler/base/net_spice.py
 delete mode 100644 compiler/base/pin_spice.py

diff --git a/compiler/base/hierarchy_spice.py b/compiler/base/hierarchy_spice.py
index 96357209..4803fb65 100644
--- a/compiler/base/hierarchy_spice.py
+++ b/compiler/base/hierarchy_spice.py
@@ -18,8 +18,6 @@ from .delay_data import delay_data
 from .wire_spice_model import wire_spice_model
 from .power_data import power_data
 from .logical_effort import convert_relative_c_to_farad, convert_farad_to_relative_c
-from .pin_spice import pin_spice
-from .net_spice import net_spice
 
 
 class spice():
@@ -728,3 +726,107 @@ class spice():
         return self == mod and \
                child_net.lower() == alias_net.lower() and \
                parent_net.lower() == alias_net.lower()
+
+
+class pin_spice():
+    """
+    A class to represent a spice netlist pin.
+    mod is the parent module that created this pin.
+    mod_net is the net object of this pin's parent module. It must have the same name as the pin.
+    inst is the instance this pin is a part of, if any.
+    inst_net is the net object from mod's nets which connects to this pin.
+    """
+
+    valid_pin_types = ["INOUT", "INPUT", "OUTPUT", "POWER", "GROUND"]
+
+    def __init__(self, name, type, mod):
+        self.name = name
+        self.set_type(type)
+        self.mod = mod
+        self.mod_net = None
+        self.inst = None
+        self.inst_net = None
+
+        # TODO: evaluate if this makes sense... and works
+        self._hash = hash(self.name)
+
+    def set_type(self, type):
+        debug.check(type in pin_spice.valid_pin_types,
+                    "Invalid pin type for {0}: {1}".format(self.name, type))
+        self.type = type
+
+    def set_mod_net(self, net):
+        debug.check(isinstance(net, net_spice), "net must be a net_spice object")
+        debug.check(net.name == self.name, "module spice net must have same name as spice pin")
+        self.mod_net = net
+
+    def set_inst(self, inst):
+        self.inst = inst
+
+    def set_inst_net(self, net):
+        debug.check(self.inst_net is None,
+                "pin {} is already connected to net {} so it cannot also be connected to net {}\
+                ".format(self.name, self.inst_net.name, net.name))
+        debug.check(isinstance(net, net_spice), "net must be a net_spice object")
+        self.inst_net = net
+
+    def __str__(self):
+        """ override print function output """
+        return "(pin_name={} type={})".format(self.name, self.type)
+
+    def __repr__(self):
+        """ override repr function output """
+        return self.name
+
+    def __eq__(self, name):
+        return (name == self.name) if isinstance(name, str) else super().__eq__(name)
+
+    def __hash__(self):
+        """
+        Implement the hash function for sets etc.
+        Only hash name since spice does not allow two pins to share a name.
+        Provides a speedup if pin_spice is used as a key for dicts.
+        """
+        return self._hash
+
+
+class net_spice():
+    """
+    A class to represent a spice net.
+    pins are all the pins connected to this net.
+    inst is the instance this net is a part of, if any.
+    """
+
+    def __init__(self, name):
+        self.name = name
+        self.pins = []
+        self.inst = None
+
+        # TODO: evaluate if this makes sense... and works
+        self._hash = hash(self.name)
+
+    def connect_pin(self, pin):
+        debug.check(isinstance(pin, pin_spice), "pin must be a pin_spice object")
+        if pin in self.pins:
+            debug.warning("pin {} was already connected to net {} ... why was it connected again?".format(pin.name, self.name))
+        else:
+            self.pins.append(pin)
+
+    def __str__(self):
+        """ override print function output """
+        return "(pin_name={} type={})".format(self.name, self.type)
+
+    def __repr__(self):
+        """ override repr function output """
+        return self.name
+
+    def __eq__(self, name):
+        return (name == self.name) if isinstance(name, str) else super().__eq__(name)
+
+    def __hash__(self):
+        """
+        Implement the hash function for sets etc.
+        Only hash name since spice does not allow two pins to share a name.
+        Provides a speedup if pin_spice is used as a key for dicts.
+        """
+        return self._hash
diff --git a/compiler/base/net_spice.py b/compiler/base/net_spice.py
deleted file mode 100644
index d1c24ab6..00000000
--- a/compiler/base/net_spice.py
+++ /dev/null
@@ -1,51 +0,0 @@
-# See LICENSE for licensing information.
-#
-# Copyright (c) 2016-2023 Regents of the University of California and The Board
-# of Regents for the Oklahoma Agricultural and Mechanical College
-# (acting for and on behalf of Oklahoma State University)
-# All rights reserved.
-#
-from openram import debug
-from .pin_spice import pin_spice
-
-
-class net_spice:
-    """
-    A class to represent a spice net.
-    pins are all the pins connected to this net.
-    inst is the instance this net is a part of, if any.
-    """
-
-    def __init__(self, name):
-        self.name = name
-        self.pins = []
-        self.inst = None
-
-        # TODO: evaluate if this makes sense... and works
-        self._hash = hash(self.name)
-
-    def connect_pin(self, pin):
-        debug.check(isinstance(pin, pin_spice), "pin must be a pin_spice object")
-        if pin in self.pins:
-            debug.warning("pin {} was already connected to net {} ... why was it connected again?".format(pin.name, self.name))
-        else:
-            self.pins.append(pin)
-
-    def __str__(self):
-        """ override print function output """
-        return "(pin_name={} type={})".format(self.name, self.type)
-
-    def __repr__(self):
-        """ override repr function output """
-        return self.name
-
-    def __eq__(self, name):
-        return (name == self.name) if isinstance(name, str) else super().__eq__(name)
-
-    def __hash__(self):
-        """
-        Implement the hash function for sets etc.
-        Only hash name since spice does not allow two pins to share a name.
-        Provides a speedup if pin_spice is used as a key for dicts.
-        """
-        return self._hash
diff --git a/compiler/base/pin_spice.py b/compiler/base/pin_spice.py
deleted file mode 100644
index 1b101bfd..00000000
--- a/compiler/base/pin_spice.py
+++ /dev/null
@@ -1,71 +0,0 @@
-# See LICENSE for licensing information.
-#
-# Copyright (c) 2016-2023 Regents of the University of California and The Board
-# of Regents for the Oklahoma Agricultural and Mechanical College
-# (acting for and on behalf of Oklahoma State University)
-# All rights reserved.
-#
-from openram import debug
-from .net_spice import net_spice
-
-
-class pin_spice:
-    """
-    A class to represent a spice netlist pin.
-    mod is the parent module that created this pin.
-    mod_net is the net object of this pin's parent module. It must have the same name as the pin.
-    inst is the instance this pin is a part of, if any.
-    inst_net is the net object from mod's nets which connects to this pin.
-    """
-
-    valid_pin_types = ["INOUT", "INPUT", "OUTPUT", "POWER", "GROUND"]
-
-    def __init__(self, name, type, mod):
-        self.name = name
-        self.set_type(type)
-        self.mod = mod
-        self.mod_net = None
-        self.inst = None
-        self.inst_net = None
-
-        # TODO: evaluate if this makes sense... and works
-        self._hash = hash(self.name)
-
-    def set_type(self, type):
-        debug.check(type in pin_spice.valid_pin_types,
-                    "Invalid pin type for {0}: {1}".format(self.name, type))
-        self.type = type
-
-    def set_mod_net(self, net):
-        debug.check(isinstance(net, net_spice), "net must be a net_spice object")
-        debug.check(net.name == self.name, "module spice net must have same name as spice pin")
-        self.mod_net = net
-
-    def set_inst(self, inst):
-        self.inst = inst
-
-    def set_inst_net(self, net):
-        debug.check(self.inst_net is None,
-                "pin {} is already connected to net {} so it cannot also be connected to net {}\
-                ".format(self.name, self.inst_net.name, net.name))
-        debug.check(isinstance(net, net_spice), "net must be a net_spice object")
-        self.inst_net = net
-
-    def __str__(self):
-        """ override print function output """
-        return "(pin_name={} type={})".format(self.name, self.type)
-
-    def __repr__(self):
-        """ override repr function output """
-        return self.name
-
-    def __eq__(self, name):
-        return (name == self.name) if isinstance(name, str) else super().__eq__(name)
-
-    def __hash__(self):
-        """
-        Implement the hash function for sets etc.
-        Only hash name since spice does not allow two pins to share a name.
-        Provides a speedup if pin_spice is used as a key for dicts.
-        """
-        return self._hash