najaeda 0.1.4__cp312-cp312-macosx_11_0_arm64.whl → 0.1.5__cp312-cp312-macosx_11_0_arm64.whl

najaeda/instance_visitor.py

@@ -0,0 +1,45 @@
+# SPDX-FileCopyrightText: 2024 The Naja authors
+# <https://github.com/najaeda/naja/blob/main/AUTHORS>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Callable
+from najaeda import netlist
+
+
+class VisitorConfig:
+    def __init__(
+        self,
+        enter_condition: Callable[[netlist.Instance], bool] = lambda node: True,
+        callback: Callable[[netlist.Instance], None] = lambda node: None,
+    ):
+        """
+        :param enter_condition: A function that determines whether to visit
+        the children of an instance.
+        :param callback: The callback to be executed when an instance is visited.
+        """
+        self.callback = callback
+        self.enter_condition = enter_condition
+
+
+class Visitor:
+    def __init__(self, instance: netlist.Instance):
+        """
+        :param netlist: The hierarchical netlist to be traversed.
+        """
+        self.instance = instance
+
+    def visit(self, instance: netlist.Instance, config: VisitorConfig):
+        """
+        Recursively visits nodes in the netlist hierarchy.
+
+        :param instance: The current node in the netlist instance hierarchy.
+        :param config: VisitorConfig object defining conditions and callbacks.
+        """
+        # Execute the callback
+        config.callback(instance)
+
+        # Check if we should proceed to children
+        if config.enter_condition(instance):
+            for child in instance.get_child_instances():
+                self.visit(child, config)

najaeda/netlist.py

@@ -35,13 +35,13 @@ class Equipotential:
 
     def get_top_terms(self):
         for term in self.equi.getTerms():
-            yield Term(snl.SNLPath(), term.getBitTerm())
+            yield Term(snl.SNLPath(), term)
 
     def get_all_leaf_readers(self):
         for term in self.equi.getInstTermOccurrences():
             direction = term.getInstTerm().getDirection()
             if direction != snl.SNLTerm.Direction.Output:
-                if term.getInstTerm().getInstance().getModel().isPrimitive():
+                if term.getInstTerm().getInstance().getModel().isLeaf():
                     yield Term(
                         snl.SNLPath(term.getPath(), term.getInstTerm().getInstance()),
                         term.getInstTerm().getBitTerm(),
@@ -161,14 +161,14 @@ class Net:
             path = snl.SNLPath(self.path, term.getInstance())
             yield Term(path, term.getBitTerm())
 
-    def get_terms(self):
+    def get_design_terms(self):
         if hasattr(self, "net_concat"):
             raise ValueError("Cannot get terms from a net_concat")
         for term in self.net.getBitTerms():
             yield Term(self.path, term)
 
-    def get_components(self):
-        for term in itertools.chain(self.get_terms(), self.get_inst_terms()):
+    def get_terms(self):
+        for term in itertools.chain(self.get_design_terms(), self.get_inst_terms()):
             yield term
 
 
@@ -452,6 +452,10 @@ class Instance:
         """Return True if this is a blackbox."""
         return self.__get_snl_model().isBlackBox()
 
+    def is_leaf(self) -> bool:
+        """Return True if this is a leaf."""
+        return self.__get_snl_model().isLeaf()
+
     def is_const0(self) -> bool:
         """Return True if this is a constant 0 generator."""
         return self.__get_snl_model().isConst0()

{najaeda-0.1.4.dist-info → najaeda-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: najaeda
-Version: 0.1.4
+Version: 0.1.5
 Summary: Naja EDA Python package
 Author-Email: Naja Authors <contact@keplertech.io>
 License: Apache License 2.0
@@ -61,11 +61,10 @@ easily extended in the future. Don't hesitate to reach out if you need help.
     netlist.load_primitives('xilinx')
     benchmarks = path.join('..','benchmarks')
     top = netlist.load_verilog([path.join(benchmarks, 'verilog', 'arm_core_netlist.v')])
-    #
 
 Print all the instances in the netlist
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Next example shows how to browse all the netlist and print all its content.
+Next example shows how to browse all the netlist and print all its content recursively.
 
 .. code-block:: python
 
@@ -74,13 +73,30 @@ Next example shows how to browse all the netlist and print all its content.
             print(f"{child_instance}:{child_instance.get_model_name()}")
             print_netlist(child_instance)
 
+Similar to the previous example, but utilizing an instance visitor.
+This approach allows you to perform operations on each instance while
+also defining conditions for stopping or continuing exploration.
+
+.. code-block:: python
+
+    def print_instance(instance):
+        print(f"{instance}:{instance.get_model_name()}")
+    visitor_config = instance_visitor.VisitorConfig(callback=print_instance)
+    instance_visitor.Visitor(top).visit(top, visitor_config)
+
 Documentation
 -------------
 najaeda is a work in progress, and the documentation is still under development.
 
 Naja documentation is available on the `Naja GitHub repository <https://github.com/najaeda/naja>`_.
 
-License
+Support
 -------
+Please put up issues on the Delocate issue tracker.
+If you encounter any issues or have questions, please report them on the
+`Naja issue tracker <https://github.com/najaeda/naja/issues>`_.
 
-This project is licensed under the Apache License 2.0. See the `LICENSE <https://github.com/najaeda/naja/blob/main/LICENSE>`_ file for details.
+License
+-------
+This project is licensed under the Apache License 2.0.
+See the `LICENSE <https://github.com/najaeda/naja/blob/main/LICENSE>`_ file for details.

najaeda-0.1.5.dist-info/RECORD

@@ -0,0 +1,13 @@
+najaeda-0.1.5.dist-info/RECORD,,
+najaeda-0.1.5.dist-info/WHEEL,sha256=bS2kxwU1pioFffhNQmlfvjD0H1flBf5ZtxV4jDj8Nvc,114
+najaeda-0.1.5.dist-info/METADATA,sha256=WuZMeLEC6yRy9aEA4UiQ5Bg9RA_NtPplvGclOEt6h7c,3511
+najaeda-0.1.5.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+najaeda-0.1.5.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377
+najaeda/netlist.py,sha256=jzpnmhGdkXRmSYmMNv3YGe3KC9BB9eoQc0Y3zlMh3ag,25748
+najaeda/libnaja_snl_python.dylib,sha256=ewNYliZsN8mZ1I80HMKnQN8jSiiISFEjGfRTd-zOD2Y,740160
+najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+najaeda/libnaja_snl.dylib,sha256=8Ei7KKU0b14IqlvH_8yQSSCpH0rjbxpeRaXgyfSemMY,574112
+najaeda/snl.so,sha256=2vv_LPtR0B-txFyT1mZYaYoaqPw6vd42BX2UROwOR8A,97888
+najaeda/instance_visitor.py,sha256=HrrOnCSuw5Lh1HSp2R-ckYP4gEbqdxp_rw3Sl0GpGHE,1479
+najaeda/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+najaeda/primitives/xilinx.py,sha256=fuu4KxEIuC0ueCK4C_gds6hzgtJsLE3tjDtOHtY9McM,25947

najaeda-0.1.4.dist-info/RECORD

@@ -1,12 +0,0 @@
-najaeda-0.1.4.dist-info/RECORD,,
-najaeda-0.1.4.dist-info/WHEEL,sha256=bS2kxwU1pioFffhNQmlfvjD0H1flBf5ZtxV4jDj8Nvc,114
-najaeda-0.1.4.dist-info/METADATA,sha256=rpver3Febf2UhLXS-HAceNHU3YnNLGKde1icywDK_-Y,2842
-najaeda-0.1.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-najaeda-0.1.4.dist-info/licenses/AUTHORS,sha256=7NYEGDAX_1QZvCCHfq8YVXC5ZbwH_pbNI8DcSmm70GU,377
-najaeda/netlist.py,sha256=ena4A9S1UxQV-pO1XWxO_qbG-4ELnorKInJgX0zN3M0,25633
-najaeda/libnaja_snl_python.dylib,sha256=GR1KlfHbg2X3aYcQKgjWbWnwEorGvrANrcYh8KEkdbg,740160
-najaeda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-najaeda/libnaja_snl.dylib,sha256=8Ei7KKU0b14IqlvH_8yQSSCpH0rjbxpeRaXgyfSemMY,574112
-najaeda/snl.so,sha256=2vv_LPtR0B-txFyT1mZYaYoaqPw6vd42BX2UROwOR8A,97888
-najaeda/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-najaeda/primitives/xilinx.py,sha256=fuu4KxEIuC0ueCK4C_gds6hzgtJsLE3tjDtOHtY9McM,25947