Port to Python 3.10, add Ubuntu 22.04 CI jobs (#7)

gezalore · web-flow · commit 87c60635771e · 2025-08-07T07:10:31.000+01:00
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -30,7 +30,12 @@ concurrency:
 jobs:
   check:
     name: "Check RTLMeter"
-    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        os:
+          - ubuntu-22.04
+          - ubuntu-24.04
+    runs-on: ${{ matrix.os }}
     outputs:
       cases: ${{ steps.gatherCases.outputs.cases }}
     steps:
@@ -57,6 +62,7 @@ jobs:
         run: make spellcheck
       - name: Gather cases for run
         id: gatherCases
+        if: ${{ matrix.os == 'ubuntu-24.04' }}
         run: |
           # Gather all configurations into a JSON list
           echo "cases=[" >> cases.json
@@ -72,17 +78,22 @@ jobs:
   build-verilator:
     name: "Build Verilator"
     needs: check # Not really a dependency, but don't bother if 'check' fails
-    runs-on: ubuntu-24.04
     strategy:
       matrix:
         cxx:
           - g++
           - clang++
+        os:
+          - ubuntu-22.04
+          - ubuntu-24.04
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Install dependencies
         run: |
           sudo apt update
-          sudo apt install ccache mold help2man libfl-dev libgoogle-perftools-dev libsystemc-dev
+          sudo apt install ccache mold help2man libfl-dev libsystemc-dev
+          # Some conflict of libunwind verison on 22.04, can live without it
+          [[ "${{ matrix.os }}" == "ubuntu-22.04" ]] || sudo apt install libgoogle-perftools-dev
       - name: Checkout Verilator
         uses: actions/checkout@v4
         with:
@@ -101,26 +112,31 @@ jobs:
         run: make install
       - name: Tar up installation
         working-directory: verilator
-        run: tar --posix -c -z -f verilator-${{ matrix.cxx }}.tar.gz install
+        run: tar --posix -c -z -f verilator-${{ matrix.cxx }}-${{ matrix.os }}.tar.gz install
       - name: Upload Verilator installation archive
         uses: actions/upload-artifact@v4
         with:
-          path: verilator/verilator-${{ matrix.cxx }}.tar.gz
-          name: verilator-${{ matrix.cxx }}
+          path: verilator/verilator-${{ matrix.cxx }}-${{ matrix.os }}.tar.gz
+          name: verilator-${{ matrix.cxx }}-${{ matrix.os }}
 
   run-with-verilator:
     name: Run
     needs:
       - check
       - build-verilator
-    runs-on: ubuntu-24.04
     strategy:
       max-parallel: 8
       matrix:
         cxx:
           - g++
           - clang++
+        os:
+          - ubuntu-22.04
+          - ubuntu-24.04
         case: ${{ fromJson(needs.check.outputs.cases) }}
+        exclude:
+          - { os: ubuntu-22.04, cxx: clang++ } # Seems to fill up disk space
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -136,10 +152,10 @@ jobs:
       - name: Download Verilator installation archive
         uses: actions/download-artifact@v4
         with:
-          name: verilator-${{ matrix.cxx }}
+          name: verilator-${{ matrix.cxx }}-${{ matrix.os }}
       - name: Unpack Verilator installation archive
         run: |
-          tar -x -z -f verilator-${{ matrix.cxx }}.tar.gz
+          tar -x -z -f verilator-${{ matrix.cxx }}-${{ matrix.os }}.tar.gz
           ls -la
       - name: Run
         working-directory: rtlmeter
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -18,7 +18,9 @@ name: Docs
 
 on:
   push:
-    branches: ["main"]
+    branches:
+      - main
+  pull_request:
   workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -52,6 +54,7 @@ jobs:
 
   # Deployment job
   deploy:
+    if: ${{ github.repository == 'verilator/rtlmeter' && github.event_name == 'push' && github.ref_name == 'main' }}
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
diff --git a/Makefile b/Makefile
@@ -29,7 +29,7 @@ venv:
 
 .PHONY: typecheck
 typecheck:
-	env MYPYPATH=$(PYTHONPATH) $(PYTHON) -m mypy --disable-error-code=import-untyped src/main.py
+	env MYPYPATH=$(PYTHONPATH) $(PYTHON) -m mypy --disable-error-code=import-untyped src/rtlmeter/main.py
 
 .PHONY: lint
 lint:
diff --git a/README.rst b/README.rst
@@ -34,7 +34,7 @@ Dependencies
 We try to keep external dependencies to a minimum. You will need the following
 available through your shell ``$PATH``:
 
-- Python 3.12 or newer as ``python3``
+- Python 3.10 or newer as ``python3``
 - An installation of Verilator as ``verilator``
 
 All other dependencies are managed via a Python virtual environment, please see
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -33,7 +33,7 @@
 
 # -- General configuration ---------------------------------------------------
 
-needs_sphinx = "8.2"
+needs_sphinx = "8.1"
 
 extensions = ["sphinx_copybutton"]
 
diff --git a/docs/source/descriptor.rst b/docs/source/descriptor.rst
@@ -10,8 +10,8 @@ For examples, please refer to the existing descriptors in the repository (
 ``designs/*/descriptor.yaml``).
 
 The formal schema of the descriptor used for run-time validation can
-be found in `src/schema.yaml
-<https://github.com/verilator/rtlmeter/blob/main/src/schema.yaml>`_.
+be found in `src/rtlmeter/schema.yaml
+<https://github.com/verilator/rtlmeter/blob/main/src/rtlmeter/schema.yaml>`_.
 
 Types of entries
 ----------------
diff --git a/docs/source/gettingstarted.rst b/docs/source/gettingstarted.rst
@@ -19,7 +19,7 @@ Start by cloning the repository, then ``cd`` to the root of the project:
 Setting up dependencies
 -----------------------
 
-We assume you have Python 3.12 or newer available through your shell ``$PATH``
+We assume you have Python 3.10 or newer available through your shell ``$PATH``
 as ``python3``. To confirm, you can run ``python3 --version``.
 
 Python dependencies are manged through a virtual environment that you can
diff --git a/docs/source/spelling_wordlist.txt b/docs/source/spelling_wordlist.txt
@@ -1,4 +1,5 @@
 benchmarking
+boolean
 Ccache
 cocotb
 Dhrystone
diff --git a/python-requirements.txt b/python-requirements.txt
@@ -8,7 +8,7 @@ pyyaml==6.0.2
 ruff==0.9.3
 scikit-learn==1.6.1
 scipy==1.15.1
-sphinx==8.2.3
+sphinx==8.1.3
 sphinxcontrib-spelling==8.0.1
 sphinx-copybutton==0.5.2
 sphinx-rtd-theme==3.0.2
diff --git a/rtlmeter b/rtlmeter
@@ -17,4 +17,4 @@
 
 export RTLMETER_ROOT=$(dirname $(readlink -f $0))
 export PYTHONPATH="${RTLMETER_ROOT}/src:$PYTHONPATH"
-exec ${RTLMETER_ROOT}/venv/bin/python3 -m src.main "$@"
+exec ${RTLMETER_ROOT}/venv/bin/python3 -m src.rtlmeter.main "$@"
diff --git a/src/rtlmeter/__init__.py b/src/rtlmeter/__init__.py
diff --git a/src/rtlmeter/cgraph.py b/src/rtlmeter/cgraph.py
@@ -19,9 +19,9 @@
 import os
 import shutil
 from dataclasses import dataclass
-from typing import Any, Callable, Dict, List, Self, final
+from typing import Any, Callable, Dict, List, final
 
-import misc
+from rtlmeter import misc
 
 
 @final
@@ -51,8 +51,8 @@ class CNode:
     workDir: str
     step: str
     computation: Callable[[], bool]
-    oNodes: List[Self] = dataclasses.field(default_factory=list)  # Nodes that depend on this node
-    iNodes: List[Self] = dataclasses.field(default_factory=list)  # Nodes that this node depends on
+    oNodes: List = dataclasses.field(default_factory=list)  # Nodes that depend on this node
+    iNodes: List = dataclasses.field(default_factory=list)  # Nodes that this node depends on
 
     def __eq__(self, other: Any) -> bool:
         return isinstance(other, CNode) and other.graph == self.graph and other.id == self.id
diff --git a/src/rtlmeter/context.py b/src/rtlmeter/context.py
@@ -18,7 +18,7 @@
 from functools import cached_property
 from typing import Any, Dict, Final, List, final
 
-import yaml_descriptor
+from rtlmeter import yaml_descriptor
 
 ###############################################################################
 # All global state in the program are contained in the singleton Context object
diff --git a/src/rtlmeter/descriptors.py b/src/rtlmeter/descriptors.py
@@ -18,8 +18,8 @@
 from dataclasses import dataclass
 from typing import Any, Dict, List, final
 
-import misc
-from context import CTX
+from rtlmeter import misc
+from rtlmeter.context import CTX
 
 
 # Get scalar attribute from the last descriptor that contains it, later overwrites earlier
diff --git a/src/rtlmeter/main.py b/src/rtlmeter/main.py
@@ -16,10 +16,10 @@
 
 import argparse
 
-import subcommands.reporting
-import subcommands.run
-import subcommands.show
-import subcommands.validate
+import rtlmeter.subcommands.reporting
+import rtlmeter.subcommands.run
+import rtlmeter.subcommands.show
+import rtlmeter.subcommands.validate
 
 if __name__ == "__main__":
     # Create the command line parser
@@ -29,10 +29,10 @@
     subparsers = parser.add_subparsers(title="subcommands", required=True)
 
     # Add the subcommands
-    subcommands.show.addSubcommands(subparsers)
-    subcommands.run.addSubcommands(subparsers)
-    subcommands.reporting.addSubcommands(subparsers)
-    subcommands.validate.addSubcommands(subparsers)
+    rtlmeter.subcommands.show.addSubcommands(subparsers)
+    rtlmeter.subcommands.run.addSubcommands(subparsers)
+    rtlmeter.subcommands.reporting.addSubcommands(subparsers)
+    rtlmeter.subcommands.validate.addSubcommands(subparsers)
 
     # Parse arguments and dispatch to entry point
     args = parser.parse_args()
diff --git a/src/rtlmeter/metrics.py b/src/rtlmeter/metrics.py
@@ -18,7 +18,7 @@
 import operator
 import os
 from dataclasses import dataclass
-from typing import Callable, Dict, Final, List, Literal, final
+from typing import Callable, Dict, Final, List, Literal, TypeAlias, final
 
 Step = Literal[
     "verilate",
@@ -104,7 +104,7 @@ class Sample:
 
 
 # Metrics are stored as a map from 'case' to 'step' to 'metric' to list of samples
-type Metrics = Dict[str, Dict[Step, Dict[Metric, List[Sample]]]]
+Metrics : TypeAlias = Dict[str, Dict[Step, Dict[Metric, List[Sample]]]]
 
 
 # Read all metrics from the given working directory and collate into single data structure
diff --git a/src/rtlmeter/misc.py b/src/rtlmeter/misc.py
diff --git a/src/rtlmeter/runcmd.py b/src/rtlmeter/runcmd.py
@@ -22,8 +22,8 @@
 import time
 from typing import Dict, Final, List
 
-import misc
-from context import CTX
+from rtlmeter import misc
+from rtlmeter.context import CTX
 
 _TIMEFORMAT: Final[str] = """{
     "elapsed" : %e,
diff --git a/src/rtlmeter/schema.yaml b/src/rtlmeter/schema.yaml
diff --git a/src/rtlmeter/subcommands/__init__.py b/src/rtlmeter/subcommands/__init__.py
diff --git a/src/rtlmeter/subcommands/common.py b/src/rtlmeter/subcommands/common.py
@@ -21,8 +21,8 @@
 from functools import cached_property
 from typing import Callable, Dict, Final, Iterable, List, Set, final
 
-from context import CTX
-from descriptors import ExecuteDescriptor
+from rtlmeter.context import CTX
+from rtlmeter.descriptors import ExecuteDescriptor
 
 # fmt: off
 TAGS: Final[Dict[str, str]] = {
diff --git a/src/rtlmeter/subcommands/reporting.py b/src/rtlmeter/subcommands/reporting.py
@@ -27,10 +27,9 @@
 import tabulate
 from sklearn.neighbors import LocalOutlierFactor
 
-import metrics
-import misc
-from context import CTX
-from subcommands.common import (
+from rtlmeter import metrics, misc
+from rtlmeter.context import CTX
+from rtlmeter.subcommands.common import (
     ArgExistingDirectory,
     ArgExistingFileOrDirectory,
     ArgPatternMatcher,
@@ -389,7 +388,7 @@ def rawdataMain(args: argparse.Namespace) -> None:
 
 def collateMain(args: argparse.Namespace) -> None:
     # Include the current date and time
-    now = datetime.datetime.now(datetime.UTC).replace(microsecond=0)
+    now = datetime.datetime.now(datetime.timezone.utc).replace(microsecond=0)
 
     # Include git revsion or RTLMeter
     rltmeterVersion = subprocess.run(
diff --git a/src/rtlmeter/subcommands/run.py b/src/rtlmeter/subcommands/run.py
@@ -24,13 +24,13 @@
 
 import tabulate
 
-import misc
-import verilator as sim
-from cgraph import CGraph, CNode, CStatus
-from context import CTX
-from descriptors import CompileDescriptor, ExecuteDescriptor
-from runcmd import runcmd
-from subcommands.common import ArgPatternMatcher, ArgRangedInt, casesByTag
+import rtlmeter.verilator as sim
+from rtlmeter import misc
+from rtlmeter.cgraph import CGraph, CNode, CStatus
+from rtlmeter.context import CTX
+from rtlmeter.descriptors import CompileDescriptor, ExecuteDescriptor
+from rtlmeter.runcmd import runcmd
+from rtlmeter.subcommands.common import ArgPatternMatcher, ArgRangedInt, casesByTag
 
 
 # Add 'prep' and 'post' hooks if present
diff --git a/src/rtlmeter/subcommands/show.py b/src/rtlmeter/subcommands/show.py
@@ -20,10 +20,10 @@
 
 import tabulate
 
-import metrics
-from context import CTX
-from descriptors import ExecuteDescriptor
-from subcommands.common import TAGS, ArgExistingFileOrDirectory
+from rtlmeter import metrics
+from rtlmeter.context import CTX
+from rtlmeter.descriptors import ExecuteDescriptor
+from rtlmeter.subcommands.common import TAGS, ArgExistingFileOrDirectory
 
 
 def showCases(dataPath: str | None) -> None:
diff --git a/src/rtlmeter/subcommands/validate.py b/src/rtlmeter/subcommands/validate.py
@@ -23,10 +23,10 @@
 from collections import Counter, defaultdict
 from typing import Dict, Set
 
-import misc
-from context import CTX
-from descriptors import CompileDescriptor, ExecuteDescriptor
-from subcommands.common import TAGS, ArgPatternMatcher, casesByTag
+from rtlmeter import misc
+from rtlmeter.context import CTX
+from rtlmeter.descriptors import CompileDescriptor, ExecuteDescriptor
+from rtlmeter.subcommands.common import TAGS, ArgPatternMatcher, casesByTag
 
 
 def checkFile(case: str, relFileName: str, absFileName: str, attrName: str) -> bool:
diff --git a/src/rtlmeter/verilator.py b/src/rtlmeter/verilator.py
@@ -19,11 +19,11 @@
 import os
 from typing import Final, List, Tuple
 
-import metrics
-from cgraph import CGraph, CNode
-from context import CTX
-from descriptors import CompileDescriptor, ExecuteDescriptor
-from runcmd import runcmd
+from rtlmeter import metrics
+from rtlmeter.cgraph import CGraph, CNode
+from rtlmeter.context import CTX
+from rtlmeter.descriptors import CompileDescriptor, ExecuteDescriptor
+from rtlmeter.runcmd import runcmd
 
 _PREFIX: Final[str] = "Vsim"
 
diff --git a/src/rtlmeter/yaml_descriptor.py b/src/rtlmeter/yaml_descriptor.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`benchmarking`
	`2`	`+boolean`
`2`	`3`	`Ccache`
`3`	`4`	`cocotb`
`4`	`5`	`Dhrystone`