peakrdl-python 1.2.1rc5__tar.gz → 2.0.0rc1__tar.gz

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/.github/workflows/action.yaml

@@ -10,6 +10,7 @@ on:
   pull_request:
     branches:
     - main
+    - 'release/**'
   schedule:
     - cron: '00 6 1 * *'
   release:
@@ -144,6 +145,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 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"
+          
+          python -m generate_and_test --RDL_source_file tests/testcases/name_desc_all_levels.rdl --root_node name_desc_all_levels --skip_systemrdl_name_and_desc_properties
 
   peakrdl_integration:
     needs:

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: peakrdl-python
-Version: 1.2.1rc5
+Version: 2.0.0rc1
 Summary: Generate Python Register Access Layer (RAL) from SystemRDL
 Author: Keith Brady
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -720,13 +720,79 @@ Dynamic: license-file
 [![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)
 
-# peakrdl-python
-Generate Python Register Access Layer (RAL) from SystemRDL
+# Introduction
+PeakRDL Python is used to generate a python based Register Access Layer (RAL) from SystemRDL.
 
 ## Documentation
 See the [peakrdl-python Documentation](https://peakrdl-python.readthedocs.io/) for more details
 
-## Upgrading from pre 0.9.0
+## Getting Started
+
+### Installation
+
+1. Install a recent version of Python 3
+2. Install `peakrdl-python`
+   ```console
+   python3 -m pip install peakrdl-python
+   ```
+3. (Optional) Install `peakrdl`, this is needed if you want to use peakrdl python from the command
+   line
+   ```console
+   python3 -m pip install peakrdl
+   ```
+   
+### First 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.
+
+1. Build the Register Access Layer (RAL) from the systemRDL code
+   ```console
+   peakrdl python accelera-generic_example.rdl -o .
+   ```
+   This will create a python package called `some_register_map` containing the python RAL
+2. In addition to the RAL, peakrdl-python also generates a simulator that can be used to exercise 
+   the RAL without connecting to real hardware. Enter the following code into a file:
+   ```python
+   """
+   An demonstration of using peakrdl-python using the accelera generic example
+   """
+   # import the top level RAL class
+   from some_register_map.reg_model.some_register_map import some_register_map_cls
+   # import the simulator class
+   from some_register_map.sim.some_register_map import some_register_map_simulator_cls
+   
+   from some_register_map.lib import NormalCallbackSet
+   
+   if __name__ == '__main__':
+       # create an instance of the RAL with the callbacks directed at the hardware simulator
+       hw_sim = some_register_map_simulator_cls(0)
+       ral = some_register_map_cls(callbacks=NormalCallbackSet(read_callback=hw_sim.read,
+                                                               write_callback=hw_sim.write))
+   
+       # read chip ID
+       chip_id_part_number = ral.chip_id_reg.part_num.read()
+       chip_id_revision_number = ral.chip_id_reg.part_num.read()
+       print(f'Chip ID:{chip_id_part_number}.{chip_id_revision_number}')
+   ```
+   save it as `some_register_map_demo.py`
+3. Run the example
+   ```commandline
+   python3 -m some_register_map_demo
+   ```
+   This will generate the following output on the console:
+   ```commandline
+   Chip ID:0.0
+   ```
+   
+# 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 
+
+## Upgrading from previous versions (some important changes)
+
+### 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:
@@ -737,12 +803,19 @@ 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 propogate through to the generated code. This may break advanced 
+metadata from the systemRDL to propagate through to the generated code. This may break advanced 
 usage of the python enumerations. User are encouraged to use the new feature, however, if there 
-are problems with the old enumeation types (based on `IntEnum`) can be used, see 
+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
+
+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 
+python classes for systemRDL components that required unique classes. The previous versions were 
+more conservative and tended to generate a lot of duplicate classes. 
+
 

peakrdl_python-2.0.0rc1/README.md

@@ -0,0 +1,104 @@
+![CI](https://github.com/krcb197/PeakRDL-python/actions/workflows/action.yaml/badge.svg)
+[![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)
+
+# Introduction
+PeakRDL Python is used to generate a python based Register Access Layer (RAL) from SystemRDL.
+
+## Documentation
+See the [peakrdl-python Documentation](https://peakrdl-python.readthedocs.io/) for more details
+
+## Getting Started
+
+### Installation
+
+1. Install a recent version of Python 3
+2. Install `peakrdl-python`
+   ```console
+   python3 -m pip install peakrdl-python
+   ```
+3. (Optional) Install `peakrdl`, this is needed if you want to use peakrdl python from the command
+   line
+   ```console
+   python3 -m pip install peakrdl
+   ```
+   
+### First 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.
+
+1. Build the Register Access Layer (RAL) from the systemRDL code
+   ```console
+   peakrdl python accelera-generic_example.rdl -o .
+   ```
+   This will create a python package called `some_register_map` containing the python RAL
+2. In addition to the RAL, peakrdl-python also generates a simulator that can be used to exercise 
+   the RAL without connecting to real hardware. Enter the following code into a file:
+   ```python
+   """
+   An demonstration of using peakrdl-python using the accelera generic example
+   """
+   # import the top level RAL class
+   from some_register_map.reg_model.some_register_map import some_register_map_cls
+   # import the simulator class
+   from some_register_map.sim.some_register_map import some_register_map_simulator_cls
+   
+   from some_register_map.lib import NormalCallbackSet
+   
+   if __name__ == '__main__':
+       # create an instance of the RAL with the callbacks directed at the hardware simulator
+       hw_sim = some_register_map_simulator_cls(0)
+       ral = some_register_map_cls(callbacks=NormalCallbackSet(read_callback=hw_sim.read,
+                                                               write_callback=hw_sim.write))
+   
+       # read chip ID
+       chip_id_part_number = ral.chip_id_reg.part_num.read()
+       chip_id_revision_number = ral.chip_id_reg.part_num.read()
+       print(f'Chip ID:{chip_id_part_number}.{chip_id_revision_number}')
+   ```
+   save it as `some_register_map_demo.py`
+3. Run the example
+   ```commandline
+   python3 -m some_register_map_demo
+   ```
+   This will generate the following output on the console:
+   ```commandline
+   Chip ID:0.0
+   ```
+   
+# 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 
+
+## Upgrading from previous versions (some important changes)
+
+### 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:
+* registers (in register array)
+* memory entries in a memory
+
+Users are encouraged to upgrade in order to avoid this limitation. However, there is a legacy mode
+to support users with existing designs, see: _Legacy Block Callback and Block Access_ in the 
+documentation
+
+### 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 
+usage of the python enumerations. User are encouraged to use the new feature, however, if there 
+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
+
+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 
+python classes for systemRDL components that required unique classes. The previous versions were 
+more conservative and tended to generate a lot of duplicate classes. 
+
+

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/docs/generated_package.rst

@@ -411,7 +411,7 @@ User Defined Properties are not automatically included they must be specified, a
 
 .. code-block:: bash
 
-   peakrdl python chip_with_registers.rdl -o chip_with_registers
+   peakrdl python user_defined_properties.rdl -o . --udp component_usage
 
 The user defined properties are stored in a ``udp`` property of all component in the generated
 register access and can be accessed as follows:

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/array_access/demo_array_access.py

@@ -1,6 +1,6 @@
-import json
-from typing import Union
-
+"""
+A demonstration of array access for peakrdl-python
+"""
 from array_access.reg_model.array_access import array_access_cls
 from array_access.sim.array_access import array_access_simulator_cls
 from array_access.lib.callbacks import NormalCallbackSet

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/enumerated_fields/demo_enumerated_fields.py

@@ -1,5 +1,5 @@
 """
-A demonstration of using enumeration
+A demonstration of using enumeration for peakrdl-python
 """
 from enumerated_fields.lib import NormalCallbackSet
 

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/optimised_access/demo_optimised_access.py

@@ -1,8 +1,7 @@
 """
 PeakRDL Python example to show the different methods to access the fields of a register
 """
-from optimised_access.reg_model.optimised_access import optimised_access_cls, \
-    optimised_access_gpio_direction_enc_enumcls
+from optimised_access.reg_model.optimised_access import optimised_access_cls
 from optimised_access.sim.optimised_access import optimised_access_simulator_cls
 
 from optimised_access.lib import NormalCallbackSet
@@ -19,15 +18,19 @@ if __name__ == '__main__':
     # configure the GPIO 0 and GPIO 1 without affecting the state of the GPIO 2 and GPIO 3
     # configuration.
 
+    # the direction field enumeration is needed to, it is found field attribute, note that the
+    # same enumeration definition can be used for all channels in this case
+    direction_enum = dut.gpio_register.gpio_0_dir.enum_cls
+
     # This can be done either using the ``write_fields`` method
-    dut.gpio_register.write_fields(gpio_0_dir=optimised_access_gpio_direction_enc_enumcls.GPIO_OUT,
+    dut.gpio_register.write_fields(gpio_0_dir=direction_enum.GPIO_OUT,
                                    gpio_0_pullup=False,
                                    gpio_0_strength=2,
-                                   gpio_1_dir=optimised_access_gpio_direction_enc_enumcls.GPIO_IN)
+                                   gpio_1_dir=direction_enum.GPIO_IN)
 
     # It can also be done with the context manager
     with dut.gpio_register.single_read_modify_write() as reg:
-        reg.gpio_0_dir.write(optimised_access_gpio_direction_enc_enumcls.GPIO_OUT)
+        reg.gpio_0_dir.write(direction_enum.GPIO_OUT)
         reg.gpio_0_pullup.write(False)
         reg.gpio_0_strength.write(2)
-        reg.gpio_0_dir.write(optimised_access_gpio_direction_enc_enumcls.GPIO_IN)
+        reg.gpio_0_dir.write(direction_enum.GPIO_IN)

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/overridden_names/demo_over_ridden_names.py

@@ -1,6 +1,11 @@
-import json
-from typing import Union
+"""
+A demonstration of using overridden names for peakrdl-python
 
+In this example there is a register which has one field. These have systemRDL names: reg_a and
+field_a respectively. However the python_inst_name has been used on change the names in the
+peakrdl-python register model to overridden_reg_a and overridden_field_a respectively
+
+"""
 from over_ridden_names.reg_model.over_ridden_names import over_ridden_names_cls
 from over_ridden_names.lib import NormalCallbackSet
 from over_ridden_names.sim_lib.dummy_callbacks import dummy_read
@@ -13,5 +18,5 @@ if __name__ == '__main__':
     # access the field value directly
     print(over_ridden_names.overridden_reg_a.overridden_field_a.read())
 
-    # access the feild value using the original systemRDL names
+    # access the field value using the original systemRDL names
     print(over_ridden_names.get_child_by_system_rdl_name('reg_a').get_child_by_system_rdl_name('field_a').read())

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/simulating_callbacks/flashing_the_LED.py

@@ -1,3 +1,6 @@
+"""
+A demonstration of extended simulator behaviour in peakrdl-python
+"""
 import tkinter
 import tkinter as tk
 

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/tranversing_address_map/dumping_register_state_to_json_file.py

@@ -1,3 +1,6 @@
+"""
+A demonstration of traversing the register model generated with peakrdl-python
+"""
 import json
 from typing import Union
 

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/tranversing_address_map/reseting_registers.py

@@ -1,4 +1,6 @@
-import json
+"""
+A demonstration of traversing the register model generated with peakrdl-python
+"""
 from typing import Union
 
 from chip_with_registers.reg_model.chip_with_registers import chip_with_registers_cls
@@ -11,7 +13,7 @@ from chip_with_registers.lib import NormalCallbackSet,  RegWriteOnly, RegReadWri
 class chip_with_registers_cls_with_reset(chip_with_registers_cls):
     """
     Extends the chip_with_registers_cls class adding methods to reset all the registers to
-    there defined reset values
+    their defined reset values
     """
 
     @staticmethod

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/tranversing_address_map/writing_register_state_from_json_file.py

@@ -1,3 +1,6 @@
+"""
+A demonstration of traversing the register model generated with peakrdl-python
+"""
 import json
 from typing import Union, Dict, List
 

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/user_defined_properties/demo_user_defined_properties.py

@@ -1,3 +1,6 @@
+"""
+A demonstration of user defined properties generated with peakrdl-python
+"""
 from user_defined_property.reg_model.user_defined_property import user_defined_property_cls
 from user_defined_property.sim_lib.dummy_callbacks import dummy_read, dummy_write
 from user_defined_property.lib.callbacks import NormalCallbackSet
@@ -8,7 +11,7 @@ if __name__ == '__main__':
     regmodel = user_defined_property_cls(callbacks=NormalCallbackSet(read_callback=dummy_read,
                                                                      write_callback=dummy_write))
 
-    # loop through the the fields in the register access model and print out the value of the
+    # loop through the fields in the register access model and print out the value of the
     # component_usage property
     for field in regmodel.control_register.readable_fields:
         field_usage = field.udp['component_usage']

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/why_ral/with_hal.py

@@ -1,9 +1,17 @@
 """
-An example to turn on GPIO 0 with the RAL
+An example to turn on GPIO 0 with a Hardware Abstaction Layer, built on top of the peakrdl-python
+Register Abstraction Layer (RAL)
 """
+from enum import Enum, auto
 from gpio.reg_model.gpio import gpio_cls as GPIO
 from gpio.sim.gpio import gpio_simulator_cls as HardwareSimulator
-from gpio.reg_model.gpio import gpio_gpio_direction_enc_enumcls as GPIO_DIR_ENUM
+
+class GPIODir(Enum):
+    """
+    Enumeration for GPIO direction
+    """
+    IN = auto()
+    OUT = auto()
 
 from gpio.lib import NormalCallbackSet
 
@@ -23,12 +31,25 @@ class HAL:
             return getattr(self._ral.data_out, f'gpio_{self._chn}_out')
 
         @property
-        def direction(self) -> GPIO_DIR_ENUM:
-            return self.__direction_field.read()
+        def __gpio_enum(self):
+            return self.__direction_field.enum_cls
+
+        @property
+        def direction(self) -> GPIODir:
+            ral_enum_value = self.__direction_field.read()
+            if ral_enum_value is self.__gpio_enum.GPIO_IN:
+                return GPIODir.IN
+            if ral_enum_value is self.__gpio_enum.GPIO_OUT:
+                return GPIODir.OUT
+            raise ValueError(f'Unable to map {ral_enum_value}')
 
         @direction.setter
-        def direction(self, dir: GPIO_DIR_ENUM):
-            self.__direction_field.write(dir)
+        def direction(self, dir: GPIODir):
+            mappping_dict = {
+                GPIODir.IN: self.__gpio_enum.GPIO_IN,
+                GPIODir.OUT: self.__gpio_enum.GPIO_OUT,
+            }
+            self.__direction_field.write(mappping_dict[dir])
 
         @property
         def data_out(self) -> bool:
@@ -36,8 +57,8 @@ class HAL:
 
         @data_out.setter
         def data_out(self, dir: bool):
-            if self.direction is not GPIO_DIR_ENUM.GPIO_OUT:
-                self.direction = GPIO_DIR_ENUM.GPIO_OUT
+            if self.direction is not GPIODir.OUT:
+                self.direction = GPIODir.OUT
             self.__data_out_field.write(dir)
 
 

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/why_ral/with_ral.py

@@ -1,9 +1,8 @@
 """
-An example to turn on GPIO 0 with the RAL
+An example to turn on GPIO 0 with the RAL, with using peakrdl-python
 """
 from gpio.reg_model.gpio import gpio_cls as GPIO
 from gpio.sim.gpio import gpio_simulator_cls as HardwareSimulator
-from gpio.reg_model.gpio import gpio_gpio_direction_enc_enumcls as GPIO_DIR_ENUM
 
 from gpio.lib import NormalCallbackSet
 
@@ -13,7 +12,11 @@ if __name__ == '__main__':
     hw = HardwareSimulator(0)
     gpio = GPIO(callbacks=NormalCallbackSet(read_callback=hw.read, write_callback=hw.write))
 
+    # the direction field enumeration is needed to, it is found field attribute, note that the
+    # same enumeration definition can be used for all channels in this case
+    direction_enum = gpio.dir.gpio_0_dir.enum_cls
+
     # Configure GPIO[0] as out
-    gpio.dir.gpio_0_dir.write(GPIO_DIR_ENUM.GPIO_OUT)
+    gpio.dir.gpio_0_dir.write(direction_enum.GPIO_OUT)
     # Configure GPIO[0] state as 1
     gpio.data_out.gpio_0_out.write(1)

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/example/why_ral/without_ral.py

@@ -1,5 +1,5 @@
 """
-An example to turn on GPIO 0 with just read and write
+An example to turn on GPIO 0 with just read and write, without using peakrdl-python
 """
 
 class HardwareSimulator:

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/generate_and_test.py

@@ -96,6 +96,13 @@ CommandLineParser.add_argument('--legacy_enum_type', action='store_true',
                                help='peakrdl python has ways to define field encoding as enums a '
                                     'a new method and an old method based on IntEnum. Setting '
                                     'this to true will restore the old behaviour')
+CommandLineParser.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 '
+                                    'attributes as properties of the class that is built. Setting '
+                                    'this will skip this reducign the size of the python code '
+                                    'generated')
 
 
 def build_logging_cong(logfilepath:str):
@@ -136,12 +143,13 @@ def build_logging_cong(logfilepath:str):
             },
             __name__:  {
                 'handlers': ['console', 'file'],
-                'propagate': True
             },
             'reg_model':  {
                 'handlers': ['console', 'file'],
-                'propagate': True
-            }
+            },
+            'peakrdl_python': {
+                'handlers': ['console', 'file'],
+            },
         }
     }
 
@@ -150,8 +158,11 @@ if __name__ == '__main__':
 
     CommandLineArgs = CommandLineParser.parse_args()
 
-    logfile_path = build_logging_cong(CommandLineArgs.output_path / f'{__file__}.log')
-    logging.config.dictConfig(logfile_path)
+    print('Setup main Logger')
+    log_file_config = build_logging_cong(str(CommandLineArgs.output_path / f'{__file__}.log'))
+    logging.config.dictConfig(log_file_config)
+    script_logger = logging.getLogger(__name__)
+    script_logger.info('Generating and testing')
 
     rdlc = compiler_with_udp_registers()
 
@@ -183,14 +194,17 @@ if __name__ == '__main__':
 
     exporter = PythonExporter()
     start_time = time.time()
-    exporter.export(node=spec, path=str(CommandLineArgs.output_path / 'generate_and_test_output'),
-                    asyncoutput=CommandLineArgs.asyncoutput,
-                    delete_existing_package_content=not CommandLineArgs.suppress_cleanup,
-                    skip_library_copy=not CommandLineArgs.copy_libraries,
-                    legacy_block_access=CommandLineArgs.legacy_block_access,
-                    user_defined_properties_to_include=CommandLineArgs.udp,
-                    hidden_inst_name_regex=CommandLineArgs.hide_regex,
-                    legacy_enum_type=CommandLineArgs.legacy_enum_type)
+    exporter.export(
+        node=spec, path=str(CommandLineArgs.output_path / 'generate_and_test_output'),
+        asyncoutput=CommandLineArgs.asyncoutput,
+        delete_existing_package_content=not CommandLineArgs.suppress_cleanup,
+        skip_library_copy=not CommandLineArgs.copy_libraries,
+        legacy_block_access=CommandLineArgs.legacy_block_access,
+        user_defined_properties_to_include=CommandLineArgs.udp,
+        hidden_inst_name_regex=CommandLineArgs.hide_regex,
+        legacy_enum_type=CommandLineArgs.legacy_enum_type,
+        skip_systemrdl_name_and_desc_properties=
+        CommandLineArgs.skip_systemrdl_name_and_desc_properties)
     print(f'generation time {time.time() - start_time}s')
 
     if not CommandLineArgs.export_only:

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/pyproject.toml

@@ -434,7 +434,7 @@ known-third-party = ["enchant"]
 [tool.pylint.logging]
 # The type of string formatting that logging methods do. `old` means using %
 # formatting, `new` is for `{}` formatting.
-logging-format-style = "old"
+logging-format-style = "new"
 
 # Logging modules to check that the string format arguments are in logging
 # function parameter format.
@@ -454,21 +454,23 @@ confidence = ["HIGH", "CONTROL_FLOW", "INFERENCE", "INFERENCE_FAILURE", "UNDEFIN
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
-disable = ["raw-checker-failed",
-           "bad-inline-option",
-           "locally-disabled",
-           "file-ignored",
-           "suppressed-message",
-           "deprecated-pragma",
-           "use-symbolic-message-instead",
-           "use-implicit-booleaness-not-comparison-to-string",
-           "use-implicit-booleaness-not-comparison-to-zero"]
+disable = [
+    "raw-checker-failed",
+    "bad-inline-option",
+    "locally-disabled",
+    "file-ignored",
+    "suppressed-message",
+    "deprecated-pragma",
+    "use-symbolic-message-instead",
+    "use-implicit-booleaness-not-comparison-to-string",
+    "use-implicit-booleaness-not-comparison-to-zero",
+    "logging-fstring-interpolation"]
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
 # multiple time (only on the command line, not in the configuration file where it
 # should appear only once). See also the "--disable" option for examples.
-# enable =
+enable = ["logging-not-lazy"]
 
 [tool.pylint.method_args]
 # List of qualified names (i.e., library.method) which require a timeout

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/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__ = "1.2.1rc5"
+__version__ = "2.0.0rc1"

{peakrdl_python-1.2.1rc5 → peakrdl_python-2.0.0rc1}/src/peakrdl_python/__peakrdl__.py

@@ -93,6 +93,12 @@ class Exporter(ExporterSubcommandPlugin):
                                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')
+        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 '
+                                    'attributes as properties of the class that is built. Setting '
+                                    'this will skip this reducign the size of the python code '
+                                    'generated')
 
     def do_export(self, top_node: 'AddrmapNode', options: 'argparse.Namespace') -> None:
         """
@@ -126,5 +132,6 @@ class Exporter(ExporterSubcommandPlugin):
             user_defined_properties_to_include=options.udp,
             hidden_inst_name_regex=options.hide_regex,
             skip_library_copy=options.skip_library_copy,
-            legacy_enum_type=options.legacy_enum_type
+            legacy_enum_type=options.legacy_enum_type,
+            skip_systemrdl_name_and_desc_properties=options.skip_systemrdl_name_and_desc_properties
         )