peakrdl-python 2.0.0rc6__tar.gz → 2.1.0rc1__tar.gz

{peakrdl_python-2.0.0rc6 → peakrdl_python-2.1.0rc1}/.github/workflows/action.yaml

@@ -29,7 +29,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
 
       - name: Install dependencies
         run: |
@@ -54,7 +54,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
 
       - name: Install dependencies
         run: |
@@ -72,7 +72,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13" ]
+        python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
       - uses: actions/checkout@v4
@@ -102,7 +102,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13" ]
+        python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
       - uses: actions/checkout@v4
@@ -144,6 +144,8 @@ jobs:
           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
           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
           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
+          
+          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"
 
           python -m generate_and_test --RDL_source_file tests/testcases/reserved_elements.rdl --root_node reserved_elements --hide_regex "(?:[\w_\[\]]+\.)+RSVD"
           
@@ -158,7 +160,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13" ]
+        python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
       - uses: actions/checkout@v4
@@ -181,7 +183,8 @@ jobs:
           peakrdl python tests/testcases/hidden_property.rdl -o peakrdl_out/raw/show_hidden/ --show_hidden
           peakrdl python tests/testcases/simple.xml tests/testcases/multifile.rdl -o peakrdl_out/raw
           peakrdl python tests/testcases/extended_memories.rdl -o peakrdl_out/raw/
-          peakrdl python tests/testcases/user_defined_properties.rdl -o peakrdl_out/raw/ --udp bool_property_to_include
+          peakrdl python tests/testcases/user_defined_properties.rdl -o peakrdl_out/raw/list/ --udp bool_property_to_include enum_property_to_include struct_property_to_include str_property_to_include
+          peakrdl python tests/testcases/user_defined_properties.rdl -o peakrdl_out/raw/regex/ --udp_regex "bool_property_to_include|enum_property_to_include|struct_property_to_include|str_property_to_include"
           peakrdl python tests/testcases/reserved_elements.rdl -o peakrdl_out/raw/ --hide_regex "(?:[\w_\[\]]+\.)+RSVD"
           peakrdl python tests/testcases/parametrised_top.rdl -o peakrdl_out/raw/ -P MY_PARAM=3
           python -m unittest discover -s peakrdl_out/raw
@@ -259,6 +262,14 @@ jobs:
           python -m with_hal
 
           cd ../..
+          
+          cd example/user_defined_properties/
+          peakrdl python user_defined_properties.rdl -o . --udp_regex "^(?!python_hide$)(?!python_name$).+"
+          python -m demo_user_defined_properties
+          
+          cd ../..
+          
+          
 
   integration_tests:
     needs:
@@ -268,7 +279,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.9, "3.10", "3.11", "3.12", "3.13"]
+        python-version: [3.9, "3.10", "3.11", "3.12", "3.13", "3.14"]
         lib_copy: [true, false]
 
     steps:
@@ -330,7 +341,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.9, "3.10", "3.11", "3.12", "3.13"]
+        python-version: [3.9, "3.10", "3.11", "3.12", "3.13", "3.14"]
 
     steps:
     - uses: actions/checkout@v4
@@ -381,7 +392,7 @@ jobs:
       - uses: actions/setup-python@v5
         name: Install Python
         with:
-          python-version: "3.12"
+          python-version: "3.13"
 
       - name: Install dependencies
         run: |

{peakrdl_python-2.0.0rc6 → peakrdl_python-2.1.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: peakrdl-python
-Version: 2.0.0rc6
+Version: 2.1.0rc1
 Summary: Generate Python Register Access Layer (RAL) from SystemRDL
 Author: Keith Brady
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -691,6 +691,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
@@ -708,7 +709,7 @@ Provides-Extra: dev
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
-Requires-Dist: peakrdl-ipxact; extra == "dev"
+Requires-Dist: peakrdl; extra == "dev"
 Provides-Extra: peakrdl
 Requires-Dist: peakrdl; extra == "peakrdl"
 Provides-Extra: unit-test
@@ -717,6 +718,8 @@ Requires-Dist: tomli; python_version < "3.11" and extra == "unit-test"
 Dynamic: license-file
 
 ![CI](https://github.com/krcb197/PeakRDL-python/actions/workflows/action.yaml/badge.svg)
+[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
+[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/peakrdl-python.svg)](https://pypi.org/project/peakrdl-python)
 [![Documentation Status](https://readthedocs.org/projects/peakrdl-python/badge/?version=latest)](https://peakrdl-python.readthedocs.io/en/latest/?badge=latest)
 [![Downloads](https://static.pepy.tech/badge/peakrdl-python)](https://pepy.tech/project/peakrdl-python)
@@ -742,7 +745,7 @@ See the [peakrdl-python Documentation](https://peakrdl-python.readthedocs.io/) f
    python3 -m pip install peakrdl
    ```
    
-### First Demo
+### Demo
 
 This demonstration relies on downloading the systemRDL example from Accelera, available here: [accelera-generic_example.rdl](https://github.com/SystemRDL/systemrdl-compiler/blob/main/examples/accelera-generic_example.rdl). This demonstration also 
 assumes that peakrdl has been installed.
@@ -789,11 +792,11 @@ assumes that peakrdl has been installed.
 # Usage
 
 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 with perform a address space reads and writes 
+connected to the appropriate access function in order to perform an address space reads and writes 
 
-## Upgrading from previous versions (some important changes)
+# Upgrading from previous versions (some important changes)
 
-### Upgrading from pre 0.9.0
+## Upgrading from pre 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:
@@ -804,7 +807,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
+## Upgrading from pre 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 
@@ -812,7 +815,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
+## Upgrading from pre 2.0.0
 
 Version 2.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 

{peakrdl_python-2.0.0rc6 → peakrdl_python-2.1.0rc1}/README.md

@@ -1,4 +1,6 @@
 ![CI](https://github.com/krcb197/PeakRDL-python/actions/workflows/action.yaml/badge.svg)
+[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
+[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/peakrdl-python.svg)](https://pypi.org/project/peakrdl-python)
 [![Documentation Status](https://readthedocs.org/projects/peakrdl-python/badge/?version=latest)](https://peakrdl-python.readthedocs.io/en/latest/?badge=latest)
 [![Downloads](https://static.pepy.tech/badge/peakrdl-python)](https://pepy.tech/project/peakrdl-python)
@@ -24,7 +26,7 @@ See the [peakrdl-python Documentation](https://peakrdl-python.readthedocs.io/) f
    python3 -m pip install peakrdl
    ```
    
-### First Demo
+### Demo
 
 This demonstration relies on downloading the systemRDL example from Accelera, available here: [accelera-generic_example.rdl](https://github.com/SystemRDL/systemrdl-compiler/blob/main/examples/accelera-generic_example.rdl). This demonstration also 
 assumes that peakrdl has been installed.
@@ -71,11 +73,11 @@ assumes that peakrdl has been installed.
 # Usage
 
 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 with perform a address space reads and writes 
+connected to the appropriate access function in order to perform an address space reads and writes 
 
-## Upgrading from previous versions (some important changes)
+# Upgrading from previous versions (some important changes)
 
-### Upgrading from pre 0.9.0
+## Upgrading from pre 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:
@@ -86,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
+## Upgrading from pre 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 
@@ -94,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
+## Upgrading from pre 2.0.0
 
 Version 2.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 

{peakrdl_python-2.0.0rc6 → peakrdl_python-2.1.0rc1}/docs/generated_package.rst

@@ -418,6 +418,11 @@ Exposing User Defined Properties
 SystemRDL allows properties to be added to any component (Field, Memory, Register, Register File,
 Address Map), so called *User Defined Properties (UDP)*.
 
+There are two methods to expose user defined properties:
+
+- A list of strings to include in the package
+- A Regular Expression which will include any UDP which matches the regular expression
+
 Consider the following systemRDL example with a user defined property: ``component_usage``
 
 .. literalinclude :: ../example/user_defined_properties/user_defined_properties.rdl
@@ -429,12 +434,28 @@ User Defined Properties are not automatically included they must be specified, a
 
    peakrdl python user_defined_properties.rdl -o . --udp component_usage
 
+Alternatively the User Defined Properties can be included with a regular expression.
+In the following case all UDPs are included, except the ones used by PeakRDL python
+
+.. code-block:: bash
+
+   peakrdl python user_defined_properties.rdl -o . --udp_regex "^(?!python_hide$)(?!python_name$).+"
+
+.. warning::
+
+   Attempting to use both the list and regular expression approach is not supported and will
+   generate an error
+
 The user defined properties are stored in a ``udp`` property of all component in the generated
 register access and can be accessed as follows:
 
 .. literalinclude :: ../example/user_defined_properties/demo_user_defined_properties.py
    :language: python
 
+.. versionadded:: 2.0.0
+
+    Regular Expression matching for User Defined Properties was added in version 2.0.0
+
 Python Safe Names
 =================
 

{peakrdl_python-2.0.0rc6 → peakrdl_python-2.1.0rc1}/generate_and_test.py

@@ -81,9 +81,12 @@ CommandLineParser.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 or the new mode using lists')
-CommandLineParser.add_argument('--udp', dest='udp', nargs='*',
+udp_group = CommandLineParser.add_mutually_exclusive_group(required=False)
+udp_group.add_argument('--udp', dest='udp', nargs='*',
                                type=str, help='any user defined properties to include in the '
                                               'reg_model')
+udp_group.add_argument('--udp_regex', dest='udp_regex', type=str,
+                       help='a regex to define which UPD ares show in the reg model')
 CommandLineParser.add_argument('--hide_regex', dest='hide_regex', type=str,
                                help='A regex that will cause any matching fully qualified node to '
                                     'be hidden')

{peakrdl_python-2.0.0rc6 → peakrdl_python-2.1.0rc1}/pyproject.toml

@@ -34,6 +34,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Programming Language :: Python :: 3 :: Only",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
@@ -62,7 +63,7 @@ dev = [
     "mypy",
     "pylint",
     "coverage",
-    "peakrdl-ipxact"
+    "peakrdl"
 ]
 peakrdl = [
     "peakrdl"

{peakrdl_python-2.0.0rc6 → peakrdl_python-2.1.0rc1}/src/peakrdl_python/__about__.py

@@ -1,6 +1,6 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2025
+Copyright (C) 2021 - 2023
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -17,4 +17,4 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Variables that describes the peakrdl-python Package
 """
-__version__ = "2.0.0rc6"
+__version__ = "2.1.0rc1"

{peakrdl_python-2.0.0rc6 → peakrdl_python-2.1.0rc1}/src/peakrdl_python/__peakrdl__.py

@@ -85,8 +85,11 @@ class Exporter(ExporterSubcommandPlugin):
                                help='show addrmap, regfile, memory, register and fields that '
                                     'have been given the python_hide user defined property and '
                                     'would be removed from the build python by default')
-        arg_group.add_argument('--udp', dest='udp', nargs='*', type=str,
+        udp_group = arg_group.add_mutually_exclusive_group(required=False)
+        udp_group.add_argument('--udp', dest='udp', nargs='*', type=str,
                                help='any user defined properties to include in the reg_model')
+        udp_group.add_argument('--udp_regex', dest='udp_regex', type=str,
+                               help='a regex to define which UPD ares show in the reg model')
         arg_group.add_argument('--hide_regex', dest='hide_regex', type=str,
                                help='A regex that will cause any matching fully qualified node to '
                                     'be hidden')
@@ -172,6 +175,7 @@ class Exporter(ExporterSubcommandPlugin):
             legacy_block_access=options.legacy_block_access,
             show_hidden=options.show_hidden,
             user_defined_properties_to_include=options.udp,
+            user_defined_properties_to_include_regex=options.udp_regex,
             hidden_inst_name_regex=options.hide_regex,
             skip_library_copy=options.skip_library_copy,
             legacy_enum_type=options.legacy_enum_type,

{peakrdl_python-2.0.0rc6 → peakrdl_python-2.1.0rc1}/src/peakrdl_python/class_names.py

@@ -21,9 +21,7 @@ from systemrdl.node import Node
 from systemrdl.node import FieldNode
 from systemrdl.node import RegNode
 from systemrdl.node import MemNode
-from systemrdl.rdltypes.user_enum import UserEnumMeta
 from .systemrdl_node_utility_functions import is_encoded_field
-from .systemrdl_node_hashes import enum_hash
 
 def get_field_get_base_class_name(node: FieldNode, async_library_classes: bool) -> str:
     """
@@ -105,13 +103,3 @@ def get_base_class_name(node: Node, async_library_classes: bool) -> str:
         return __get_mem_get_base_class_name(node, async_library_classes=async_library_classes)
 
     raise TypeError(f'Unhandled node type: {type(node)}')
-
-def fully_qualified_enum_type(field_enum: UserEnumMeta) -> str:
-    """
-    Returns the fully qualified class type name, for an enum
-    """
-    enum_hash_value = enum_hash(field_enum)
-    full_scope_path = field_enum.get_scope_path('_')
-    if enum_hash_value < 0:
-        return full_scope_path + '_' + field_enum.type_name + '_neg_' + hex(-enum_hash_value)
-    return full_scope_path + '_' + field_enum.type_name + hex(enum_hash_value)