peakrdl-python 0.7.0__tar.gz → 0.7.3__tar.gz

{peakrdl-python-0.7.0 → peakrdl-python-0.7.3}/.github/workflows/action.yaml

@@ -23,9 +23,9 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
@@ -41,9 +41,9 @@ jobs:
   mypy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
@@ -65,10 +65,10 @@ jobs:
         python-version: [3.7, 3.8, 3.9, "3.10", "3.11", "3.12"]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -159,9 +159,9 @@ jobs:
     name: Build source distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         name: Install Python
         with:
           python-version: "3.11"
@@ -173,7 +173,7 @@ jobs:
       - name: Build
         run: python -m build
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           path: |
             dist/*.tar.gz
@@ -190,7 +190,7 @@ jobs:
     # Only publish when a GitHub Release is created.
     if: github.event_name == 'release'
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: artifact
           path: dist

{peakrdl-python-0.7.0 → peakrdl-python-0.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peakrdl-python
-Version: 0.7.0
+Version: 0.7.3
 Summary: Generate python wrapper for a register model compiled SystemRDL input
 Author: Keith Brady
 License:                     GNU GENERAL PUBLIC LICENSE

{peakrdl-python-0.7.0 → peakrdl-python-0.7.3}/example/array_access/demo_array_access.py

@@ -36,9 +36,6 @@ if __name__ == '__main__':
     for index, array_item in regmodel.reg_array_1D.items():
         print(f'item[{index[0]}]={array_item.field_a.read():d}')
 
-    # access a entry in the 3D array
-    print(regmodel.reg_array_3D[1][1][1].field_a.read())
-
     # access a entry in the 3D array with other indexing scheme
     print(regmodel.reg_array_3D[1,1,1].field_a.read())
 

{peakrdl-python-0.7.0 → peakrdl-python-0.7.3}/src/peakrdl_python/__about__.py

@@ -1,4 +1,4 @@
 """
 Variables that describes the PeakRDL Python Package
 """
-__version__ = "0.7.0"
+__version__ = "0.7.3"

{peakrdl-python-0.7.0 → peakrdl-python-0.7.3}/src/peakrdl_python/__peakrdl__.py

@@ -29,7 +29,7 @@ class Exporter(ExporterSubcommandPlugin):
         "user_template_dir": schema.DirectoryPath(),
     }
 
-    def add_exporter_arguments(self, arg_group: 'argparse.ArgumentParser') -> None:
+    def add_exporter_arguments(self, arg_group: 'argparse._ActionsContainer') -> None:
         """
         Added the arguments to the PeakRDL arguments
 
@@ -42,7 +42,16 @@ class Exporter(ExporterSubcommandPlugin):
         arg_group.add_argument('--async', action='store_true', dest='is_async',
                                help='define accesses to register model as asynchronous')
         arg_group.add_argument('--skip_test_case_generation', action='store_true',
-                            help='skip the generation of the test cases')
+                               help='skip the generation of the test cases')
+        arg_group.add_argument('--suppress_cleanup', action='store_true', dest='suppress_cleanup',
+                               help='by default peakrdl_python deletes all existing python .py '
+                                    'files found in the directory where the package will be'
+                                    ' generated. This is normally useful if the user is '
+                                    'generating over the top of an existing package and prevents '
+                                    'problems when the strucutre of the register map changes. '
+                                    'However, if additional python files are added by the user '
+                                    '(not recommended) this cleanup will need to be suppressed '
+                                    'and managed by the user')
 
     def do_export(self, top_node: 'AddrmapNode', options: 'argparse.Namespace') -> None:
         """
@@ -57,11 +66,12 @@ class Exporter(ExporterSubcommandPlugin):
         """
         templates = self.cfg['user_template_dir']
         peakrdl_exporter = \
-            PythonExporter(user_template_dir=templates) # type: ignore[no-untyped-call]
+            PythonExporter(user_template_dir=templates)  # type: ignore[no-untyped-call]
 
         peakrdl_exporter.export(
             top_node,
             options.output,
             options.is_async,
-            skip_test_case_generation=options.skip_test_case_generation
+            skip_test_case_generation=options.skip_test_case_generation,
+            delete_existing_package_content=not options.suppress_cleanup
         )

{peakrdl-python-0.7.0 → peakrdl-python-0.7.3}/src/peakrdl_python/exporter.py

@@ -3,9 +3,8 @@ Main Classes for the PeakRDL Python
 """
 import os
 from pathlib import Path
-from shutil import copyfile
+from shutil import copy
 from typing import List, NoReturn, Iterable, Tuple
-from glob import glob
 
 import jinja2 as jj
 from systemrdl import RDLWalker # type: ignore
@@ -39,6 +38,120 @@ class PythonExportTemplateError(Exception):
     Exception for hading errors in the templating
     """
 
+class _PythonPackage:
+    """
+    Class to represent a python package
+    """
+    def __init__(self, path: Path):
+        self._path = path
+
+    @property
+    def path(self) -> Path:
+        """
+        path of the package
+        """
+        return self._path
+
+    def child_package(self, name: str) -> '_PythonPackage':
+        """
+        provide a child package within the current package
+
+        Args:
+            name: name of child package
+
+        Returns:
+            None
+
+        """
+        return _PythonPackage(path=self.path / name)
+
+    def child_module_path(self, name: str) -> Path:
+        """
+        return a child module within the package
+
+        Args:
+            name: name of module
+
+        Returns:
+            None
+
+        """
+        return Path(self.path) / name
+
+    @property
+    def _init_path(self) -> Path:
+        return self.child_module_path('__init__.py')
+
+    def _make_empty_init_file(self) -> None:
+        with self._init_path.open('w', encoding='utf-8') as fid:
+            fid.write('pass\n')
+
+    def create_empty_package(self, cleanup: bool) -> None:
+        """
+        make the package folder (if it does not already exist), populate the __init__.py and
+        optionally remove any existing python files
+
+        Args:
+            cleanup (bool) : delete any existing python files in the package
+
+        Returns:
+            None
+        """
+        if self.path.exists():
+            if cleanup:
+                for file in self.path.glob('*.py'):
+                    os.remove(file.resolve())
+        else:
+            self.path.mkdir(parents=True, exist_ok=False)
+        self._make_empty_init_file()
+
+
+class _Package(_PythonPackage):
+    """
+    Class to define the package being generated
+
+    Args:
+        include_tests (bool): include the tests package
+    """
+    def __init__(self, path:str, package_name: str, include_tests: bool):
+        super().__init__(Path(path) / package_name)
+        self.reg_model = self.child_package('reg_model')
+        self._include_tests = include_tests
+        if include_tests:
+            self.tests = self.child_package('tests')
+        self.lib = self.child_package('lib')
+
+
+    def create_empty_package(self, cleanup: bool) -> None:
+        """
+        create the directories and __init__.py files associated with the exported package
+
+        Args:
+            package_path: directory for the package output
+            cleanup (bool): delete existing python files
+
+        Returns:
+            None
+
+        """
+
+        # make the folder for this package and populate the empty __init__.py
+        super().create_empty_package(cleanup=cleanup)
+        # make all the child packages folders and their __init__.py
+        self.reg_model.create_empty_package(cleanup=cleanup)
+        if self._include_tests:
+            self.tests.create_empty_package(cleanup=cleanup)
+        self.lib.create_empty_package(cleanup=cleanup)
+
+        # copy all the python source code that is part of the library which comes as part of the
+        # peakrdl-python to the lib direction of the generated package
+        template_package = Path(__file__).parent / 'lib'
+        files_in_package = template_package.glob('*.py')
+
+        for file_in_package in files_in_package:
+            copy(src=file_in_package, dst=self.lib.path)
+
+
 class PythonExporter:
     """
     PeakRDL Python Exporter class
@@ -96,7 +209,8 @@ class PythonExporter:
 
     def export(self, node: Node, path: str,
                asyncoutput: bool=False,
-               skip_test_case_generation: bool=False) -> List[str]:
+               skip_test_case_generation: bool=False,
+               delete_existing_package_content: bool = True) -> List[str]:
         """
         Generated Python Code and Testbench
 
@@ -106,6 +220,9 @@ class PythonExporter:
             path (str) : Output package path.
             asyncoutput (bool) : If set this builds a register model with async callbacks
             skip_test_case_generation (bool): skip generation the generation of the test cases
+            delete_existing_package_content (bool): delete any python files in the package
+                                                    location, normally left over from previous
+                                                    operations
 
         Returns:
             List[str] : modules that have been exported:
@@ -118,9 +235,10 @@ class PythonExporter:
         else:
             top_block = node
 
-        package_path = os.path.join(path, node.inst_name)
-        self._create_empty_package(package_path=package_path,
-                                   skip_test_case_generation=skip_test_case_generation)
+        package = _Package(path=path,
+                           package_name=node.inst_name,
+                           include_tests=not skip_test_case_generation)
+        package.create_empty_package(cleanup=delete_existing_package_content)
 
         self._build_node_type_table(top_block)
 
@@ -167,21 +285,19 @@ class PythonExporter:
         context.update(self.user_template_context)
 
         template = self.jj_env.get_template("addrmap.py.jinja")
-        module_fqfn = os.path.join(package_path,
-                                   'reg_model',
-                                   top_block.inst_name + '.py')
+        module_path = package.reg_model.child_module_path(top_block.inst_name + '.py')
 
-        stream = template.stream(context)
-        stream.dump(module_fqfn, encoding='utf-8')
+        with module_path.open('w', encoding='utf-8') as fp:
+            stream = template.stream(context)
+            stream.dump(fp)
 
         if not skip_test_case_generation:
 
             # make the top level base class for all the other test, this is what instantes
             # the register model
             template = self.jj_env.get_template("baseclass_tb.py.jinja")
-            module_tb_fqfn = os.path.join(package_path,
-                                          'tests',
-                                          '_' + top_block.inst_name + '_test_base.py')
+            module_tb_path = package.tests.child_module_path(
+                '_' + top_block.inst_name + '_test_base.py')
 
             context = {
                 'top_node': top_block,
@@ -189,9 +305,9 @@ class PythonExporter:
                 'version': __version__
             }
 
-
-            stream = template.stream(context)
-            stream.dump(module_tb_fqfn, encoding='utf-8')
+            with module_tb_path.open('w', encoding='utf-8') as fp:
+                stream = template.stream(context)
+                stream.dump(fp)
 
             # make the tests themselves
             template = self.jj_env.get_template("addrmap_tb.py.jinja")
@@ -208,10 +324,7 @@ class PythonExporter:
                 RDLWalker(unroll=True).walk(block, owned_elements, skip_top=True)
 
                 fq_block_name = '_'.join(block.get_path_segments(array_suffix = '_{index:d}_'))
-
-                module_tb_fqfn = os.path.join(package_path,
-                                              'tests',
-                                              'test_' + fq_block_name + '.py')
+                module_tb_path = package.tests.child_module_path('test_' + fq_block_name + '.py')
 
                 context = {
                     'top_node': top_block,
@@ -244,8 +357,9 @@ class PythonExporter:
                     'version': __version__
                 }
 
-                stream = template.stream(context)
-                stream.dump(module_tb_fqfn, encoding='utf-8')
+                with module_tb_path.open('w', encoding='utf-8') as fp:
+                    stream = template.stream(context)
+                    stream.dump(fp)
 
         return top_block.inst_name
 
@@ -291,49 +405,6 @@ class PythonExporter:
             else:
                 self.node_type_name[child_inst] = cand_type_name
 
-    @staticmethod
-    def _create_empty_package(package_path:str,
-                              skip_test_case_generation: bool) -> None:
-        """
-        create the directories and __init__.py files associated with the exported package
-
-        Args:
-            package_path: directory for the package output
-            skip_test_case_generation: skip the generation of the test folders
-
-        Returns:
-            None
-
-        """
-
-        Path(package_path).mkdir(parents=True, exist_ok=True)
-        Path(os.path.join(package_path, 'reg_model')).mkdir(parents=True, exist_ok=True)
-        if not skip_test_case_generation:
-            Path(os.path.join(package_path, 'tests')).mkdir(parents=True, exist_ok=True)
-        Path(os.path.join(package_path, 'lib')).mkdir(parents=True, exist_ok=True)
-
-        module_fqfn = os.path.join(package_path, 'reg_model', '__init__.py')
-        with open(module_fqfn, 'w', encoding='utf-8') as fid:
-            fid.write('pass\n')
-        if not skip_test_case_generation:
-            module_fqfn = os.path.join(package_path, 'tests', '__init__.py')
-            with open(module_fqfn, 'w', encoding='utf-8') as fid:
-                fid.write('pass\n')
-        module_fqfn = os.path.join(package_path, '__init__.py')
-        with open(module_fqfn, 'w', encoding='utf-8') as fid:
-            fid.write('pass\n')
-
-        template_package = os.path.join(os.path.dirname(__file__),
-                                        'lib')
-        files_in_package = glob(os.path.join(template_package,'*.py'))
-
-        for file_in_package in files_in_package:
-            filename = os.path.basename(file_in_package)
-            copyfile(src=os.path.join(template_package,
-                                      filename),
-                     dst=os.path.join(package_path,
-                                      'lib',
-                                      filename))
 
     def _raise_template_error(self, message: str) -> NoReturn:
         """