peakrdl-python 3.0.0rc7__tar.gz → 3.1.0__tar.gz

{peakrdl_python-3.0.0rc7 → peakrdl_python-3.1.0}/.github/workflows/action.yaml

@@ -27,9 +27,9 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 
@@ -52,9 +52,9 @@ jobs:
   mypy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 
@@ -77,10 +77,10 @@ jobs:
         python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -107,10 +107,10 @@ jobs:
         python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -161,7 +161,8 @@ jobs:
           sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/user_defined_properties.rdl --root_node user_defined_properties --udp bool_property_to_include enum_property_to_include int_property_to_include str_property_to_include struct_property_to_include double_layer_struct_property_to_include
           sleep 10
-          
+          python -m generate_and_test --RDL_source_file tests/testcases/user_defined_properties.rdl --root_node user_defined_properties --udp bool_property_to_include enum_property_to_include int_property_to_include str_property_to_include struct_property_to_include double_layer_struct_property_to_include int_array_property_to_include str_array_property_to_include enum_array_property_to_include
+          sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/user_defined_properties.rdl --root_node user_defined_properties --udp_regex "bool_property_to_include|enum_property_to_include|int_property_to_include|str_property_to_include|struct_property_to_include|double_layer_struct_property_to_include"
           sleep 10
 
@@ -183,10 +184,10 @@ jobs:
         python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -306,7 +307,7 @@ jobs:
         python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Install dependencies
         run: |
@@ -341,10 +342,10 @@ jobs:
         lib_copy: [true, false]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -390,10 +391,10 @@ jobs:
         python-version: [3.9, "3.10", "3.11", "3.12", "3.13", "3.14"]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -425,17 +426,54 @@ jobs:
         mypy autoformatted_output
         python -m unittest discover -s autoformatted_output
 
+  pathological:
+
+    needs:
+      - integration_tests
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .[peakrdl]
+          python -m pip install mypy
+
+      - name: Prepare System RDL
+        run: |
+          mkdir ./pathological_test
+          python -m tests.pathological_register_maps.pathological_rdl_builder ./pathological_test/deep.rdl deep
+
+      - name: build_package
+        run: |
+          peakrdl python ./pathological_test/deep.rdl -o ./pathological_test/ --skip_library_copy
+
+      - name: type check generated code
+        run: |
+           mypy ./pathological_test/deep/
+
+      - name: Run unit tests
+        run: python -m unittest discover -s ./pathological_test/
+
   #-------------------------------------------------------------------------------
   build:
     needs:
       - autoformating
+      - pathological
 
     name: Build source distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         name: Install Python
         with:
           python-version: "3.13"

{peakrdl_python-3.0.0rc7 → peakrdl_python-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: peakrdl-python
-Version: 3.0.0rc7
+Version: 3.1.0
 Summary: Generate Python Register Access Layer (RAL) from SystemRDL
 Author: Keith Brady
 License:              GNU LESSER GENERAL PUBLIC LICENSE
@@ -191,7 +191,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9.2
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: systemrdl-compiler>=1.29.3
+Requires-Dist: systemrdl-compiler>=1.31.0
 Requires-Dist: jinja2
 Requires-Dist: typing-extensions; python_version < "3.11"
 Requires-Dist: more_itertools; python_version < "3.13"
@@ -286,9 +286,9 @@ assumes that peakrdl has been installed.
 To make use of the RAL with real hardware or a different simulation, the callbacks will need to be 
 connected to the appropriate access function in order to perform an address space reads and writes 
 
-# Upgrading from previous versions (some important changes)
+# Some important changes
 
-## Upgrading from pre 0.9.0
+## 0.9.0
 
 In order to address a major limitation of peakrdl-python that prevented it from implementing the
 full systemRDL specification, a breaking API change was needed for handling blocks:
@@ -299,7 +299,7 @@ Users are encouraged to upgrade in order to avoid this limitation. However, ther
 to support users with existing designs, see: _Legacy Block Callback and Block Access_ in the 
 documentation
 
-## Upgrading from pre 1.2.0
+## 1.2.0
 
 Version 1.2 introduced a new way to define the enumerations for the field encoding. This allows 
 metadata from the systemRDL to propagate through to the generated code. This may break advanced 
@@ -307,7 +307,7 @@ usage of the python enumerations. User are encouraged to use the new feature, ho
 are problems with the old enumeration types (based on `IntEnum`) can be used, see 
 _Legacy Enumeration Types_ in the documentation
 
-## Upgrading from pre 2.0.0
+## 2.0.0
 
 Version 2.0.0 introduced a significant change to the process for building the register model python
 code. This change was intended to reduce the size of the generated code by only generating 
@@ -325,4 +325,20 @@ changing each time it was regenerated, version 2.1.0 introduces a option to eith
   of large register models but will be consistent, therefore is useful if the resultant code is being
   checked into a version control system (such as GIT) and the differences are being reviewed
 
+## 3.0.0
+
+Version 3.0.0 has included a significant refactoring of the generated test cases, moving functions out
+of the templates (generated code) in favour of an enhanced test library. On some cases, this 
+reduced the size of the test case generated code by 90%, significantly improved the time to generate
+the code and also improved the time to run the tests by a 30% reduction.
+
+In preparation for the removal of some legacy features from the early versions in release 4.0.0, 
+the following options were changed:
+- Version 1.2 introduced a new custom enumeration type (rather than using `IntEnum`) in order to allow
+  the content to `name` and `desc` systemRDL properties in be accessible. Until version 3.0.0 the new
+  type was not the default, it now is. The old enumeration types can still be used by setting `legacy_enum_type`.
+- The first versions of PeakRDL Python used the built-in `Array` type for accessing blocks of data efficiently.
+  This had some restrictions, so the a new methodology based on the `list` type was introduced in version 0.9.
+  The old array based behaviour is no longer the default but can be turned on using the `legacy_block_access`
+
 

{peakrdl_python-3.0.0rc7 → peakrdl_python-3.1.0}/README.md

@@ -75,9 +75,9 @@ assumes that peakrdl has been installed.
 To make use of the RAL with real hardware or a different simulation, the callbacks will need to be 
 connected to the appropriate access function in order to perform an address space reads and writes 
 
-# Upgrading from previous versions (some important changes)
+# Some important changes
 
-## Upgrading from pre 0.9.0
+## 0.9.0
 
 In order to address a major limitation of peakrdl-python that prevented it from implementing the
 full systemRDL specification, a breaking API change was needed for handling blocks:
@@ -88,7 +88,7 @@ Users are encouraged to upgrade in order to avoid this limitation. However, ther
 to support users with existing designs, see: _Legacy Block Callback and Block Access_ in the 
 documentation
 
-## Upgrading from pre 1.2.0
+## 1.2.0
 
 Version 1.2 introduced a new way to define the enumerations for the field encoding. This allows 
 metadata from the systemRDL to propagate through to the generated code. This may break advanced 
@@ -96,7 +96,7 @@ usage of the python enumerations. User are encouraged to use the new feature, ho
 are problems with the old enumeration types (based on `IntEnum`) can be used, see 
 _Legacy Enumeration Types_ in the documentation
 
-## Upgrading from pre 2.0.0
+## 2.0.0
 
 Version 2.0.0 introduced a significant change to the process for building the register model python
 code. This change was intended to reduce the size of the generated code by only generating 
@@ -114,4 +114,20 @@ changing each time it was regenerated, version 2.1.0 introduces a option to eith
   of large register models but will be consistent, therefore is useful if the resultant code is being
   checked into a version control system (such as GIT) and the differences are being reviewed
 
+## 3.0.0
+
+Version 3.0.0 has included a significant refactoring of the generated test cases, moving functions out
+of the templates (generated code) in favour of an enhanced test library. On some cases, this 
+reduced the size of the test case generated code by 90%, significantly improved the time to generate
+the code and also improved the time to run the tests by a 30% reduction.
+
+In preparation for the removal of some legacy features from the early versions in release 4.0.0, 
+the following options were changed:
+- Version 1.2 introduced a new custom enumeration type (rather than using `IntEnum`) in order to allow
+  the content to `name` and `desc` systemRDL properties in be accessible. Until version 3.0.0 the new
+  type was not the default, it now is. The old enumeration types can still be used by setting `legacy_enum_type`.
+- The first versions of PeakRDL Python used the built-in `Array` type for accessing blocks of data efficiently.
+  This had some restrictions, so the a new methodology based on the `list` type was introduced in version 0.9.
+  The old array based behaviour is no longer the default but can be turned on using the `legacy_block_access`
+
 

{peakrdl_python-3.0.0rc7 → peakrdl_python-3.1.0}/docs/generated_package.rst

@@ -9,6 +9,7 @@ will be based on the top level address map name with the package was generated
 
 | ``<root_name>``
 | ├── ``lib``
+| ├── ``lib_test``
 | ├── ``sim_lib``
 | ├── ``reg_model``
 | │ └── ``<root_name>.py``
@@ -20,8 +21,9 @@ will be based on the top level address map name with the package was generated
 In the folder structure above:
 
 - ``<root_name>.py`` - This is the register access layer code for the design
-- ``test_<root_name>.py`` - This is a set of autogenerated unittests to verify the register access layer
+- ``test_<root_name>.py`` - This is a set of autogenerated unittests to verify the register access layer (The unit test generation can be skipped, see ``skip_test_case_generation``)
 - ``lib`` - This is a package of base classes used by the register access layer (The copy of this can be skipped, see :ref:`skipping-lib-copy`)
+- ``lib_test`` - This is a package of base classes autogenerated unit tests (The copy of this can be skipped, see :ref:`skipping-lib-copy`)
 - ``sim_lib`` - This is a package of base classes used by the register access layer simulator (The copy of this can be skipped, see :ref:`skipping-lib-copy`)
 
 .. versionchanged:: 2.0.0
@@ -30,6 +32,11 @@ In the folder structure above:
     than building the whole register model in a single python module. This helps avoid
     excessively large files which helps speed up the generation and loading time.
 
+.. versionchanged:: 3.0.0
+
+    The auto-generated unit tests were changed in version 3.0.0 to split to make use
+    of a test library, which significantly reduced the size of the generated code.
+
 Top Level Classes
 -----------------
 
@@ -74,8 +81,10 @@ Callbacks
 =========
 
 The Register Access Layer will typically interfaced to a driver that
-allows accesses the chip. However, it can also be interfaced to a simulation
-of the device.
+allows accesses the chip.
+
+.. tip:: The simulator generated with the register model can be used as an alternative to
+         a hardware connection
 
 In order to operate the register access layer typically requires the following:
 
@@ -174,6 +183,10 @@ Legacy Block Callback and Block Access
       * ``NormalCallbackSetLegacy`` for standard python function callbacks
       * ``AsyncCallbackSetLegacy`` for async python function callbacks, these are called from the library using ``await``
 
+.. versionchanged:: 3.0.0
+
+    The ``legacy_block_access`` will now default to ``False``
+
 Legacy Enumeration Types
 ------------------------
 
@@ -187,6 +200,10 @@ Legacy Enumeration Types
    There was a small risk this may impact some users code, in the case of advanced usage of the
    enumeration. The old behaviour can be brought back using the ``legacy_enum_type`` build option.
 
+.. versionchanged:: 3.0.0
+
+    The ``legacy_enum_type`` will now default to ``False``
+
 
 Using the Register Access Layer
 ===============================

{peakrdl_python-3.0.0rc7 → peakrdl_python-3.1.0}/generate_and_test.py

@@ -222,6 +222,7 @@ if __name__ == '__main__':
         skip_library_copy=not CommandLineArgs.copy_libraries,
         legacy_block_access=CommandLineArgs.legacy_block_access,
         user_defined_properties_to_include=CommandLineArgs.udp,
+        user_defined_properties_to_include_regex=CommandLineArgs.udp_regex,
         hidden_inst_name_regex=CommandLineArgs.hide_regex,
         legacy_enum_type=CommandLineArgs.legacy_enum_type,
         skip_systemrdl_name_and_desc_properties=

{peakrdl_python-3.0.0rc7 → peakrdl_python-3.1.0}/pyproject.toml

@@ -8,7 +8,7 @@ dynamic = ["version"]
 # Callable is broken in python 3.9.0 and 3.9.1 so these need to be excluded
 requires-python = ">=3.9.2"
 dependencies = [
-    "systemrdl-compiler>=1.29.3", # this is needed to make sure all the latest type checking
+    "systemrdl-compiler>=1.31.0", # this is needed for the latest overlappign register features
     "jinja2",
     "typing-extensions;python_version<'3.11'",
     # the batched fucntion was adopted into the standard python library at 3.13

{peakrdl_python-3.0.0rc7 → peakrdl_python-3.1.0}/src/peakrdl_python/__about__.py

@@ -17,4 +17,4 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Variables that describes the peakrdl-python Package
 """
-__version__ = "3.0.0rc7"
+__version__ = "3.1.0"

{peakrdl_python-3.0.0rc7 → peakrdl_python-3.1.0}/src/peakrdl_python/__peakrdl__.py

@@ -80,7 +80,8 @@ class Exporter(ExporterSubcommandPlugin):
         arg_group.add_argument('--legacy_block_access', action='store_true',
                                dest='legacy_block_access',
                                help='peakrdl python has two methods to hold blocks of data, the '
-                                    'legacy mode based on array.array or the new mode using lists')
+                                    'legacy mode based on array.array or the new mode using '
+                                    'lists. This option will be removed in version 4.0')
         arg_group.add_argument('--show_hidden', action='store_true',
                                dest='show_hidden',
                                help='show addrmap, regfile, memory, register and fields that '
@@ -100,7 +101,8 @@ class Exporter(ExporterSubcommandPlugin):
                                dest='legacy_enum_type',
                                help='peakrdl python has two ways to define field encoding as '
                                      'enums new method and an old method based on IntEnum. '
-                                     'Setting this to true will restore the old behaviour')
+                                     'Setting this to true will restore the old behaviour.'
+                                     ' This option will be removed in version 4.0')
         arg_group.add_argument('--skip_systemrdl_name_and_desc_properties', action='store_true',
                                dest='skip_systemrdl_name_and_desc_properties',
                                help='peakrdl python includes the system RDL name and desc '

{peakrdl_python-3.0.0rc7 → peakrdl_python-3.1.0}/src/peakrdl_python/exporter.py

@@ -47,7 +47,7 @@ from .systemrdl_node_utility_functions import get_reg_writable_fields, \
     get_field_default_value, get_enum_values, get_properties_to_include, \
     HideNodeCallback, hide_based_on_property, \
     full_slice_accessor, ShowUDPCallback, \
-    node_iterator_entry
+    node_iterator_entry, simulator_field_definition
 from .unique_component_iterator import UniqueComponents
 from .unique_component_iterator import PeakRDLPythonUniqueRegisterComponents
 from .unique_component_iterator import PeakRDLPythonUniqueMemoryComponents
@@ -243,6 +243,7 @@ class PythonExporter:
             'asyncoutput': asyncoutput,
             'isinstance': isinstance,
             'str': str,
+            'list': list,
             'uses_enum': uses_enum(top_block),
             'get_fully_qualified_type_name': partial(
                 unique_component_walker.python_class_name,
@@ -414,14 +415,18 @@ class PythonExporter:
 
                 context = {
                     'top_node': top_block,
-                    'systemrdlRegNode': RegNode,
                     'systemrdlFieldNode': FieldNode,
+                    'systemrdlRegNode': RegNode,
+                    'systemrdlRegfileNode': RegfileNode,
+                    'systemrdlAddrmapNode': AddrmapNode,
+                    'systemrdlMemNode': MemNode,
                     'systemrdlSignalNode': SignalNode,
                     'systemrdlUserStruct': UserStruct,
                     'systemrdlUserEnum': UserEnum,
                     'isinstance': isinstance,
                     'type': type,
                     'str': str,
+                    'list': list,
                     'asyncoutput': asyncoutput,
                     'unique_registers': unique_register_subset,
                     'unique_property_enums':
@@ -511,14 +516,18 @@ class PythonExporter:
 
                 context = {
                     'top_node': top_block,
-                    'systemrdlMemNode': MemNode,
                     'systemrdlFieldNode': FieldNode,
+                    'systemrdlRegNode': RegNode,
+                    'systemrdlRegfileNode': RegfileNode,
+                    'systemrdlAddrmapNode': AddrmapNode,
+                    'systemrdlMemNode': MemNode,
                     'systemrdlSignalNode': SignalNode,
                     'systemrdlUserStruct': UserStruct,
                     'systemrdlUserEnum': UserEnum,
                     'isinstance': isinstance,
                     'type': type,
                     'str': str,
+                    'list' : list,
                     'asyncoutput': asyncoutput,
                     'unique_memories': unique_memory_subset,
                     'unique_property_enums':
@@ -584,11 +593,16 @@ class PythonExporter:
                 context = {
                     'top_node': top_block,
                     'systemrdlFieldNode': FieldNode,
+                    'systemrdlRegNode': RegNode,
+                    'systemrdlRegfileNode': RegfileNode,
+                    'systemrdlAddrmapNode': AddrmapNode,
+                    'systemrdlMemNode': MemNode,
                     'systemrdlUserStruct': UserStruct,
                     'systemrdlUserEnum': UserEnum,
                     'isinstance': isinstance,
                     'type': type,
                     'str': str,
+                    'list': list,
                     'asyncoutput': asyncoutput,
                     'unique_fields': unique_fields_subset,
                     'unique_property_enums':
@@ -676,16 +690,17 @@ class PythonExporter:
                 raise TypeError(f'node should be a register, got {type(node)}')
             reg_addr = node.absolute_address
             if reg_addr in reg_dict:
+                if not node.has_overlaps:
+                    raise RuntimeError('A non-overlaping node should not have a duplicate address')
                 existing_entry = reg_dict[reg_addr]
-                # if the entry is already list simply append to it
-                if isinstance(existing_entry, list):
-                    existing_entry.append(node)
-                elif isinstance(existing_entry, RegNode):
-                    reg_dict[reg_addr] = [existing_entry, node]
-                else:
-                    raise TypeError(f'exiting entry of unexpected type: {type(existing_entry)}')
+                if not isinstance(existing_entry, list):
+                    raise RuntimeError('A overlapping entry should have been made as list')
+                existing_entry.append(node)
             else:
-                reg_dict[reg_addr] = node
+                if node.has_overlaps:
+                    reg_dict[reg_addr] = [node,]
+                else:
+                    reg_dict[reg_addr] = node
 
 
         context = {
@@ -697,7 +712,8 @@ class PythonExporter:
             'asyncoutput': asyncoutput,
             'skip_lib_copy': skip_lib_copy,
             'legacy_block_access': legacy_block_access,
-            'list': list
+            'list': list,
+            'simulator_field_definition': simulator_field_definition,
         }
 
         module_name = top_block.inst_name
@@ -843,6 +859,7 @@ class PythonExporter:
                 'isinstance': isinstance,
                 'type': type,
                 'str': str,
+                'list': list,
                 'full_slice_accessor': full_slice_accessor,
                 'get_python_path_segments': get_python_path_segments,
                 'safe_node_name': safe_node_name,
@@ -951,12 +968,12 @@ class PythonExporter:
                skip_test_case_generation: bool = False,
                delete_existing_package_content: bool = True,
                skip_library_copy: bool = False,
-               legacy_block_access: bool = True,
+               legacy_block_access: bool = False,
                show_hidden: bool = False,
                user_defined_properties_to_include: Optional[list[str]] = None,
                user_defined_properties_to_include_regex: Optional[str] = None,
                hidden_inst_name_regex: Optional[str] = None,
-               legacy_enum_type: bool = True,
+               legacy_enum_type: bool = False,
                skip_systemrdl_name_and_desc_properties: bool = False,
                skip_systemrdl_name_and_desc_in_docstring: bool = False,
                register_class_per_generated_file: int =
@@ -1011,6 +1028,7 @@ class PythonExporter:
             legacy_enum_type: version 1.2 introduced a new Enum type that allows system
                               rdl ``name`` and ``desc`` properties on field encoding
                               to be included. The legacy mode uses python IntEnum.
+                              .. version-deprecated:: 3.0
             skip_systemrdl_name_and_desc_properties (bool) : version 1.2 introduced new properties
                                                              that include the systemRDL name and
                                                              desc as properties of the built
@@ -1053,6 +1071,16 @@ class PythonExporter:
         Returns:
             modules that have been exported:
         """
+        if legacy_enum_type:
+            warnings.warn('legacy_enum_type is deprecated and '
+                          'will be removed from a future version please try the new mode',
+                          category=DeprecationWarning)
+
+        if legacy_block_access:
+            warnings.warn('legacy_block_access is deprecated and '
+                          'will be removed from a future version please try the new mode',
+                          category=DeprecationWarning)
+
 
         # If it is the root node, skip to top addrmap
         if isinstance(node, RootNode):
@@ -1154,7 +1182,7 @@ class PythonExporter:
         """
         enum_needed: list[UserEnumMeta] = []
 
-        def walk_property_struct_node(value: Any) -> None:
+        def walk_property_subnode(value: Any) -> None:
             if isinstance(value, UserEnum) and type(value) not in enum_needed:
                 enum_type = type(value)
                 if not isinstance(enum_type, UserEnumMeta):
@@ -1163,19 +1191,15 @@ class PythonExporter:
 
             if isinstance(value, UserStruct):
                 for sub_value in value.members.values():
-                    walk_property_struct_node(sub_value)
+                    walk_property_subnode(sub_value)
+
+            if isinstance(value, list):
+                for sub_value in value:
+                    walk_property_subnode(sub_value)
 
         for node in unique_components.nodes.values():
             for node_property_name in node.properties_to_include:
                 node_property = node.instance.get_property(node_property_name)
-                if isinstance(node_property, UserEnum) and type(node_property) not in enum_needed:
-                    enum_type = type(node_property)
-                    if not isinstance(enum_type, UserEnumMeta):
-                        raise TypeError(f'enum type should be UserEnumMeta, got {type(enum_type)}')
-                    enum_needed.append(enum_type)
-
-                if isinstance(node_property, UserStruct):
-                    for sub_value in node_property.members.values():
-                        walk_property_struct_node(sub_value)
+                walk_property_subnode(node_property)
 
         return enum_needed

{peakrdl_python-3.0.0rc7 → peakrdl_python-3.1.0}/src/peakrdl_python/lib/base.py

@@ -26,12 +26,15 @@ from abc import ABC, abstractmethod
 from itertools import product
 from enum import IntEnum, Enum, auto
 import math
+import re
 
 from .callbacks import CallbackSet, CallbackSetLegacy
 
 UDPStruct = dict[str, 'UDPType']
 UDPType = Union[str, int, bool, IntEnum, UDPStruct]
 
+array_instance_re = re.compile(r'(?P<root_name>[A-Za-z_0-9]*)\[(?P<index>\d+)\]')
+
 class Base(ABC):
     """
     base class of for all types
@@ -97,6 +100,35 @@ class Base(ABC):
         """
         return {}
 
+    def _traverse_from_fully_qualified_name(self, fully_qualified_name: list[str]) -> 'Base':
+        """
+        This method allows another node in the structure to located based on a list of string
+        which represented the systemRDL path.
+
+        This function is intended for use with UDPs which reference other UDPs
+        """
+
+        # 1) location the root node by walking backwards up the tree until the parent is
+        #    found
+        def locate_root(node: 'Base') -> 'Base':
+            if node.parent is None:
+                return node
+            return locate_root(node.parent)
+        root_node = locate_root(self)
+        # 2) check the 1st entry in the list matches the name of the root
+        if root_node.inst_name != fully_qualified_name[0]:
+            raise RuntimeError('root node name mismatch')
+        # 3) start walking down the tree matching the nodes
+        walking_node = root_node
+        for node_name in fully_qualified_name[1:]:
+            if not isinstance(walking_node, Node):
+                # the current node being traversed must be a Node type i.e. not a field
+                raise RuntimeError('node traversal has failed as type:{type(walking_node)} was'
+                                   ' unexpectedly encountered')
+            walking_node = walking_node.get_child_by_system_rdl_name(node_name)
+
+        return walking_node
+
     @property
     def rdl_name(self) -> Optional[str]:
         """
@@ -200,6 +232,18 @@ class Node(Base ,ABC):
         """
         if not isinstance(name, str):
             raise TypeError(f'name must be a string got {type(name)}')
+
+        # check if an array style child pointer
+        array_name_match = array_instance_re.match(name)
+        if array_name_match:
+            root_name = array_name_match.group("root_name")
+            index = int(array_name_match.group("index"))
+            child_array = getattr(self, self.systemrdl_python_child_name_map[root_name])
+            if not isinstance(child_array, NodeArray):
+                raise ValueError('attempting to use array indexing into a non-array '
+                                 f'node: {root_name} of type:{type(child_array)}')
+            return child_array[index]
+
         return getattr(self, self.systemrdl_python_child_name_map[name])
 
     @property