Change Node.parameters to return dict of elaborated parameter values rather than internal Parameter objects

Author: amykyta3

src/systemrdl/node.py

@@ -1,7 +1,7 @@
 import re
 import itertools
 from copy import deepcopy, copy
-from collections import deque
+from collections import deque, OrderedDict
 from typing import TYPE_CHECKING, Optional, Iterator, Any, List, Tuple, Dict
 from typing import Sequence, Union, overload, TypeVar, Type
 
@@ -14,8 +14,6 @@
 if TYPE_CHECKING:
     from .compiler import RDLEnvironment
     from .source_ref import SourceRefBase
-    from .core.parameter import Parameter
-    from collections import OrderedDict
     from markdown import Markdown
 
 T = TypeVar("T")
@@ -857,14 +855,19 @@ def property_src_ref(self) -> Dict[str, 'SourceRefBase']:
         return self.inst.property_src_ref
 
     @property
-    def parameters(self) -> 'OrderedDict[str, Parameter]':
+    def parameters(self) -> 'OrderedDict[str, Any]':
         """
-        Parameters of this component
+        Returns a dictionary of the parameters of this component, and their final
+        elaborated values.
+
         These are stored in the order that they were defined
 
         .. versionadded:: 1.30
         """
-        return self.inst.parameters_dict
+        param_values_dict = OrderedDict()
+        for param_name, param in self.inst.parameters_dict.items():
+            param_values_dict[param_name] = param.get_value()
+        return param_values_dict
 
     @property
     def external(self) -> bool:

test/lib/type_hint_utils.py

@@ -66,5 +66,8 @@ def value_is_compatible(value, hint) -> bool:
         else:
             raise RuntimeError(f"Unhandled generic {hint}: {hint.__origin__}")
 
+    if hint is typing.Any:
+        return True
+
     # hint is an actual class
     return isinstance(value, hint)

test/test_api_type_hints.py

@@ -1,6 +1,6 @@
 import glob
 import os
-from typing import Union, List, Optional
+from typing import Union, List, Optional, Dict, Any
 import sys
 
 from typing_extensions import Literal, get_overloads, get_type_hints
@@ -10,6 +10,7 @@
 from lib.type_hint_utils import value_is_compatible, hint_is
 from systemrdl.node import AddressableNode, FieldNode, MemNode, Node, AddrmapNode, RegNode, RegfileNode, RootNode, SignalNode, VectorNode
 from systemrdl import component as comp
+from systemrdl.source_ref import SourceRefBase
 from unittest_utils import RDLSourceTestCase
 
 from systemrdl.walker import RDLListener, RDLSimpleWalker
@@ -114,19 +115,25 @@ def enter_Component(self, node: Node) -> None:
         self.test_class.assert_attr_type_hint(node, "inst_name", str)
         self.test_class.assert_attr_type_hint(node, "type_name", Optional[str])
         self.test_class.assert_attr_type_hint(node, "orig_type_name", Optional[str])
+        self.test_class.assert_attr_type_hint(node, "inst_src_ref", Optional[SourceRefBase])
+        self.test_class.assert_attr_type_hint(node, "def_src_ref", Optional[SourceRefBase])
+        self.test_class.assert_attr_type_hint(node, "property_src_ref", Dict[str, SourceRefBase])
+        self.test_class.assert_attr_type_hint(node, "parameters", Dict[str, Any])
         self.test_class.assert_attr_type_hint(node, "external", bool)
+        self.test_class.assert_attr_type_hint(node, "cpuif_reset", Optional[SignalNode])
 
     def enter_AddressableComponent(self, node: AddressableNode) -> None:
         self.test_class.assert_attr_type_hint(node, "raw_address_offset", int)
         self.test_class.assert_attr_type_hint(node, "raw_absolute_address", int)
         self.test_class.assert_attr_type_hint(node, "size", int)
         self.test_class.assert_attr_type_hint(node, "total_size", int)
-        if node.is_array:
+        if node.is_array is True:
             self.test_class.assert_attr_type_hint(node, "array_dimensions", List[int])
             self.test_class.assert_attr_type_hint(node, "array_stride", int)
         else:
             self.test_class.assertIsNone(node.array_dimensions)
             self.test_class.assertIsNone(node.array_stride)
+        self.test_class.assert_attr_type_hint(node, "n_elements", int)
 
 
     def enter_VectorComponent(self, node: VectorNode) -> None:
@@ -159,6 +166,7 @@ def enter_Reg(self, node: RegNode) -> None:
         self.test_class.assert_attr_type_hint(node, "parent", Union[AddrmapNode, RegfileNode, MemNode])
         self.test_class.assert_attr_type_hint(node, "inst", comp.Reg)
         self.test_class.assert_attr_type_hint(node, "size", int)
+        self.test_class.assert_attr_type_hint(node, "is_msb0_order", bool)
         self.test_class.assert_attr_type_hint(node, "is_virtual", bool)
         self.test_class.assert_attr_type_hint(node, "has_sw_writable", bool)
         self.test_class.assert_attr_type_hint(node, "has_sw_readable", bool)

test/test_multiple_elab.py

@@ -48,9 +48,7 @@ def test_multi_elab_params(self):
         rdlc = RDLCompiler(message_printer=TestPrinter())
         rdlc.compile_file(os.path.join(this_dir, "rdl_src/elab_params.rdl"))
 
-        print("1")
         default_root = rdlc.elaborate("elab_params")
-        print("2")
         W10_root = rdlc.elaborate("elab_params", parameters={
             "STR": "ovr1",
             "INT": 10,
@@ -61,7 +59,6 @@ def test_multi_elab_params(self):
         self.assertEqual(default_root.top.find_by_path("r1.f").width, 1)
         self.assertEqual(W10_root.top.find_by_path("r1.f").width, 10)
 
-        # Test old parameter API - Was not explicitly made a private API!
         expected = {
             "STR": "default",
             "INT": 1,
@@ -70,8 +67,13 @@ def test_multi_elab_params(self):
             "BOOL": True,
             "UNUSED_STR": "asdf",
         }
+        # Test old parameter API - Was not explicitly made a private API!
         for param in default_root.top.inst.parameters:
             self.assertEqual(expected[param.name], param.get_value())
+        # Test new parameter API
+        for name, value in default_root.top.parameters.items():
+            self.assertEqual(expected[name], value)
+
 
         expected = {
             "STR": "ovr1",
@@ -81,8 +83,12 @@ def test_multi_elab_params(self):
             "BOOL": True,
             "UNUSED_STR": "ovr2",
         }
+        # Test old parameter API - Was not explicitly made a private API!
         for param in W10_root.top.inst.parameters:
             self.assertEqual(expected[param.name], param.get_value())
+        # Test new parameter API
+        for name, value in W10_root.top.parameters.items():
+            self.assertEqual(expected[name], value)
 
 
     def test_multi_elab_common_dpa(self):

test/test_parameters.py

@@ -284,15 +284,12 @@ def checkme(r, X):
             self.assertEqual(r.get_property("udp4"), int("0x" + "A" * X, 0))
             self.assertEqual(r.get_property("udp5"), 0xFFFFFFFF & ((1 << X) - 1))
 
-        print("r1")
         r1 = root.find_by_path("top.r1")
         checkme(r1, 8)
 
-        print("r2")
         r2 = root.find_by_path("top.r2")
         checkme(r2, 4)
 
-        print("r3")
         r3 = root.find_by_path("top.r3")
         checkme(r3, 8)