Merge pull request #299 from krcb197/281-remove-legacy_enum_type

Remove the Legacy Enum

Author: krcb197

.github/workflows/action.yaml

@@ -142,8 +142,6 @@ jobs:
           sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --legacy_block_access
           sleep 10
-          python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --legacy_enum_type
-          sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --copy_libraries
           sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --hashing_mode PYTHONHASH
@@ -221,9 +219,6 @@ jobs:
           
           peakrdl python tests/testcases/basic.rdl -o peakrdl_out/no_lib/ --skip_library_copy
           python -m unittest discover -s peakrdl_out/no_lib
-          
-          peakrdl python tests/testcases/enum_example.rdl -o peakrdl_out/raw_legacy_enum/ --legacy_enum_type
-          python -m unittest discover -s peakrdl_out/raw_legacy_enum
 
           # test a TOMl file that passes in overridden templates
           peakrdl python tests/testcases/basic.rdl -o peakrdl_out/simple_user_template/ --peakrdl-cfg tests/alternative_templates_toml/peakrdl.toml

README.md

@@ -130,4 +130,13 @@ the following options were changed:
   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`
 
+## 4.0.0
+
+some legacy features from the early versions were removed 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. Version 4.0.0 removed the option to use `IntEnum`
+- The first versions of PeakRDL Python used the built-in `Array` type for accessing blocks of data efficiently.
+  This had some restrictions, so a new methodology based on the `list` type was introduced in version 0.9.
+  The old array based behaviour was removed in this version
+
 

docs/generated_package.rst

@@ -187,24 +187,6 @@ Legacy Block Callback and Block Access
 
     The ``legacy_block_access`` will now default to ``False``
 
-Legacy Enumeration Types
-------------------------
-
-.. versionchanged:: 1.2.0
-
-   Previous versions of PeakRDL Python used `IntEnum` for the the field encoding. This had a
-   limitation that the metadata from the system RDL code, notably the ``name`` and ``desc``
-   property could not be included. A new data type for the enumerations was introduced in
-   version 1.2.0.
-
-   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
 ===============================
 

generate_and_test.py

@@ -97,11 +97,6 @@
                                type=pathlib.Path, required=False,
                                help='export a text file with a list of the all qualified instance'
                                     'names in the systemRDL')
-CommandLineParser.add_argument('--legacy_enum_type', action='store_true',
-                               dest='legacy_enum_type',
-                               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',
@@ -224,7 +219,6 @@ def build_logging_cong(logfilepath:str):
         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=
         CommandLineArgs.skip_systemrdl_name_and_desc_properties,
         skip_systemrdl_name_and_desc_in_docstring=

generate_testcases.py

@@ -84,7 +84,6 @@ def compile_rdl(infile: str,
 def generate(root: Node, outdir: str,
              asyncoutput: bool = False,
              legacy_block_access: bool = True,
-             legacy_enum_type: bool = True,
              copy_library: bool = False,
              skip_systemrdl_name_and_desc_in_docstring: bool = False,
              hashing_mode: NodeHashingMethod = NodeHashingMethod.PYTHONHASH) -> List[str]:
@@ -96,8 +95,6 @@ def generate(root: Node, outdir: str,
         outdir: directory to store the result in
         legacy_block_access: If set to True the code build a register model the legacy array block
                              access as opposed to the newer list based
-        legacy_enum_type: If set to True the code with build with the old style IntEnum rather than
-                          the new style SystemRDLEnum
 
     Returns:
         List of strings with the module names generated
@@ -108,7 +105,6 @@ def generate(root: Node, outdir: str,
         root, outdir,  # type: ignore[no-untyped-call]
         asyncoutput=asyncoutput,
         legacy_block_access=legacy_block_access,
-        legacy_enum_type=legacy_enum_type,
         skip_library_copy=not copy_library,
         skip_systemrdl_name_and_desc_in_docstring=
         skip_systemrdl_name_and_desc_in_docstring,
@@ -174,7 +170,6 @@ def generate(root: Node, outdir: str,
             _ = generate(root, str(output_path / folder_parts),
                          asyncoutput=asyncoutput,
                          legacy_block_access=legacy,
-                         legacy_enum_type=legacy,
                          copy_library=CommandLineArgs.copy_libraries,
                          skip_systemrdl_name_and_desc_in_docstring=skip_name_and_desc_in_docstring,
                          hashing_mode=hashing_method)

src/peakrdl_python/__about__.py

@@ -17,4 +17,4 @@
 
 Variables that describes the peakrdl-python Package
 """
-__version__ = "3.1.0"
+__version__ = "4.0.0rc1"

src/peakrdl_python/__peakrdl__.py

@@ -97,12 +97,6 @@ def add_exporter_arguments(self, arg_group: 'argparse._ActionsContainer') -> Non
                                     'be hidden')
         arg_group.add_argument('--skip_library_copy', action='store_true',
                                help='skip the copy of the library code into the generated package')
-        arg_group.add_argument('--legacy_enum_type', action='store_true',
-                               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.'
-                                     ' 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 '
@@ -190,7 +184,6 @@ def do_export(self, top_node: 'AddrmapNode', options: 'argparse.Namespace') -> N
             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,
             skip_systemrdl_name_and_desc_properties=
                 options.skip_systemrdl_name_and_desc_properties,
             skip_systemrdl_name_and_desc_in_docstring=