Remove dangerous usage of non-public parts of the systemrdl-compiler API

Author: amykyta3

pyproject.toml

@@ -7,7 +7,7 @@ name = "peakrdl-uvm"
 dynamic = ["version"]
 requires-python = ">=3.7"
 dependencies = [
-    "systemrdl-compiler ~= 1.30",
+    "systemrdl-compiler ~= 1.31",
     "jinja2 >= 2.9",
 ]
 

src/peakrdl_uvm/exporter.py

@@ -62,11 +62,8 @@ def __init__(self, **kwargs):
         # value = max accesswidth/memwidth used in node's descendants
         self.bus_width_db = {}
 
-        # Dictionary of root-level type definitions
-        # key = definition type name
-        # value = representative object
-        #   components, this is the original_def (which can be None in some cases)
-        self.namespace_db = {}
+        # Set of root-level type definitions
+        self.namespace_db = set()
 
         self.reuse_class_definitions = True
 
@@ -184,14 +181,18 @@ def _get_class_name(self, node: Node) -> str:
                 # Unable to determine a reusable type name. Fall back to hierarchical path
                 class_name = node.get_rel_path(
                     self.top.parent,
-                    hier_separator="__", array_suffix="", empty_array_suffix=""
+                    hier_separator="__",
+                    array_suffix="",
+                    empty_array_suffix="",
                 )
                 # Add prefix to prevent collision when mixing namespace methods
                 class_name = "xtern__" + class_name
         else:
             class_name = node.get_rel_path(
                 self.top.parent,
-                hier_separator="__", array_suffix="", empty_array_suffix=""
+                hier_separator="__",
+                array_suffix="",
+                empty_array_suffix="",
             )
 
         return class_name
@@ -213,7 +214,7 @@ def _get_class_friendly_name(self, node: Node) -> str:
         else:
             friendly_name = node.get_rel_path(self.top.parent)
 
-        return type(node.inst).__name__ + " - " + friendly_name
+        return node.component_type_name + " - " + friendly_name
 
 
     def _get_inst_name(self, node: Node) -> str:
@@ -235,19 +236,12 @@ def _class_needs_definition(self, node: Node) -> bool:
         type_name = self._get_class_name(node)
 
         if type_name in self.namespace_db:
-            obj = self.namespace_db[type_name]
-
-            # Sanity-check for collisions
-            if (obj is None) or (obj is not node.original_def):
-                raise RuntimeError("Namespace collision! Type-name generation is not robust enough to create unique names!")
-
-            # This object likely represents the existing class definition
             # Ok to omit the re-definition
             return False
 
         # Need to emit a new definition
         # First, register it in the namespace
-        self.namespace_db[type_name] = node.original_def
+        self.namespace_db.add(type_name)
         return True
 
 

test/pylint.rc

@@ -50,10 +50,6 @@ load-plugins=
 # Pickle collected data for later comparisons.
 persistent=yes
 
-# When enabled, pylint would attempt to guess common misconfiguration and emit
-# user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
-
 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.
 unsafe-load-any-extension=no
@@ -98,9 +94,6 @@ disable=
         abstract-method,
         protected-access,
         duplicate-code,
-        cyclic-import,
-
-        # Can't do until py35 support is dropped
         consider-using-f-string
 
 # Enable the message, report, category or checker with the given id(s). You can
@@ -144,7 +137,7 @@ max-nested-blocks=5
 # inconsistent-return-statements if a never returning function is called then
 # it will be considered as an explicit return statement and no message will be
 # printed.
-never-returning-functions=sys.exit
+never-returning-functions=sys.exit,argparse.parse_error
 
 
 [STRING]
@@ -494,7 +487,7 @@ valid-metaclass-classmethod-first-arg=cls
 ignored-parents=
 
 # Maximum number of arguments for function / method.
-max-args=8
+max-args=16
 
 # Maximum number of attributes for a class (see R0902).
 max-attributes=7
@@ -569,5 +562,5 @@ preferred-modules=
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "BaseException, Exception".
-overgeneral-exceptions=BaseException,
-                       Exception
+overgeneral-exceptions=builtin.BaseException,
+                       builtin.Exception

test/requirements.txt

@@ -0,0 +1 @@
+pylint

test/run.sh

@@ -2,42 +2,34 @@
 
 set -e
 
-this_dir="$( cd "$(dirname "$0")" ; pwd -P )"
+cd "$(dirname "$0")"
 
 exists () {
   type "$1" >/dev/null 2>/dev/null
 }
 
 # Initialize venv
-venv_bin=$this_dir/.venv/bin
-python3 -m venv $this_dir/.venv
-
-#tools
-python=$venv_bin/python
-pylint=$venv_bin/pylint
+#rm -rf .venv
+python3.13 -m venv .venv
+source .venv/bin/activate
 
 
 # Install test dependencies
-$python -m pip install -U pylint setuptools pip
+pip install -r requirements.txt
 
 
 # Install dut
-cd $this_dir/..
-$python setup.py install
-cd $this_dir
+pip install -e "../[cli]"
 
+# Run lint
+pylint --rcfile pylint.rc ../src/peakrdl_uvm
 
 # Generate testcase verilog files
-$python generate_testcase_data.py basic testcases/basic.rdl
-
+python generate_testcase_data.py basic testcases/basic.rdl
 
 # Run modelsim testcases
 if exists vsim; then
     ./vsim_test.sh testcases/basic_uvm_nofac_reuse_pkg.sv testcases/basic_test.sv
     ./vsim_test.sh testcases/basic_uvm_fac_reuse_pkg.sv testcases/basic_test.sv
     ./vsim_test.sh testcases/basic_uvm_nofac_noreuse_pkg.sv testcases/basic_test.sv
 fi
-
-
-# Run lint
-$pylint --rcfile $this_dir/pylint.rc ../src/peakrdl_uvm | tee $this_dir/lint.rpt