Merge pull request #63 from krcb197/build_process_improvements

Build process improvements

Author: krcb197

.github/workflows/action.yaml

@@ -9,6 +9,11 @@ on:
     branches: [ main ]
   pull_request:
     branches: [ main ]
+  schedule:
+    - cron: '00 6 1 * *'
+  release:
+    types:
+      - published
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -18,9 +23,9 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: "3.10"
 
@@ -36,9 +41,9 @@ jobs:
   mypy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: "3.10"
 
@@ -51,16 +56,19 @@ jobs:
         run: mypy src/peakrdl_python --config-file=tests/.mypy.ini
 
   tests:
+    needs:
+      - mypy
+      - lint
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [3.7, 3.8, 3.9, "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -75,10 +83,13 @@ jobs:
 
     - name: Generate testcases
       run: |
+        # retrieve the example code from the systemRDL compiler
+        wget -L https://raw.githubusercontent.com/SystemRDL/systemrdl-compiler/main/examples/accelera-generic_example.rdl -O tests/testcases/accelera-generic_example.rdl
         python generate_testcases.py
         mypy testcase_output/raw --config-file=tests/.mypy.ini
         # autopep8 is moving some of the #ignore statements around so it no longer passes mypy
         # mypy testcase_output/autopep8 --config-file=tests/.mypy.ini
+        # pylint --rcfile tests/pylint.rc testcase_output/autopep8 --disable=duplicate-code,line-too-long,too-many-statements,invalid-name,unused-import,too-many-instance-attributes,too-many-arguments,too-many-lines
         pytest testcase_output/raw
         pytest testcase_output/autopep8
 
@@ -113,4 +124,45 @@ jobs:
         # python -m flashing_the_LED
 
         cd ../..
+  #-------------------------------------------------------------------------------
+  build_sdist:
+    needs:
+      - tests
+      - lint
+      - mypy
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        name: Install Python
+        with:
+          python-version: 3.8
+
+      - name: Build sdist
+        run: python setup.py sdist
+
+      - uses: actions/upload-artifact@v3
+        with:
+          path: dist/*.tar.gz
 
+  #-------------------------------------------------------------------------------
+  deploy:
+    needs:
+      - build_sdist
+
+    runs-on: ubuntu-latest
+
+    # Only publish when a GitHub Release is created.
+    if: github.event_name == 'release'
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: artifact
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

src/peakrdl_python/__about__.py

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

src/peakrdl_python/exporter.py

@@ -35,6 +35,8 @@ class PythonExporter:
             into the template namespace.
     """
 
+    # pylint: disable=too-few-public-methods
+
     def __init__(self, **kwargs):
 
         user_template_dir = kwargs.pop("user_template_dir", None)
@@ -98,13 +100,13 @@ def export(self, node: Node, path: str,
             node = node.top
 
         package_path = os.path.join(path, node.inst_name)
-        self.create_empty_package(package_path=package_path)
+        self._create_empty_package(package_path=package_path)
 
         modules = [node]
 
         for block in modules:
 
-            self.build_node_type_table(block)
+            self._build_node_type_table(block)
 
             context = {
                 'print': print,
@@ -122,7 +124,7 @@ def export(self, node: Node, path: str,
                 'isinstance': isinstance,
                 'uses_enum' : uses_enum(block),
                 'uses_memory' : uses_memory(block),
-                'get_fully_qualified_type_name': self.lookup_type_name,
+                'get_fully_qualified_type_name': self._lookup_type_name,
                 'get_array_dim': get_array_dim,
                 'get_dependent_component': get_dependent_component,
                 'get_dependent_enum': get_dependent_enum,
@@ -168,7 +170,7 @@ def export(self, node: Node, path: str,
 
         return [m.inst_name for m in modules]
 
-    def lookup_type_name(self, node: Node) -> str:
+    def _lookup_type_name(self, node: Node) -> str:
         """
         Retreive the unique type name from the current lookup list
 
@@ -182,7 +184,7 @@ def lookup_type_name(self, node: Node) -> str:
 
         return self.node_type_name[node.inst]
 
-    def build_node_type_table(self, node: AddressableNode) -> None:
+    def _build_node_type_table(self, node: AddressableNode) -> None:
         """
         Populate the type name lookup dictionary
 
@@ -211,7 +213,7 @@ def build_node_type_table(self, node: AddressableNode) -> None:
                 self.node_type_name[child_inst] = cand_type_name
 
     @staticmethod
-    def create_empty_package(package_path:str) -> None:
+    def _create_empty_package(package_path:str) -> None:
         """
         create the directories and __init__.py files associated with the exported package