Merge pull request #593 from zapta/develop

Assorted changes

Author: cavearr

.github/workflows/test.yml

@@ -20,17 +20,9 @@ jobs:
             shell: bash
 
         strategy:
-            # max-parallel: 3
             matrix:
                 os: [ubuntu-22.04, macos-latest, windows-latest]
-                python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
-                # Windows test are almost x10 slower on github so we drop the
-                # less critical ones.
-                exclude:
-                  - os: windows-latest
-                    python-version: '3.9'
-                  - os: windows-latest
-                    python-version: '3.10'
+                python-version: ['3.11', '3.12', '3.13']
 
         steps:
             - name: Checkout sources

.pylintrc

@@ -0,0 +1,9 @@
+# Configuration file for pylint.
+
+[MESSAGES CONTROL]
+# Do not warn about TODOs.
+disable=fixme
+
+[SIMILARITIES]
+# Reducing the sensitivity of duplicate code (default is 4)
+min-similarity-lines=15

README.md

@@ -1,8 +1,11 @@
 [![][apio-logo]][wiki]
 
-[![PyPI Version][pypi-image]][pypi-url]
-[![Build Status][build-image]][build-url]
-[![License][license-image]][license-url]
+[![PyPI Version][pypi-image]][pypi-url]<br>
+[![License][license-image]][license-url]<br>
+[![Test](https://github.com/FPGAwars/apio/actions/workflows/test.yml/badge.svg)](https://github.com/FPGAwars/apio/actions/workflows/test.yml)<br>
+[![build-linux-x86-64-installer](https://github.com/FPGAwars/apio/actions/workflows/build-linux-x86-64-installer.yml/badge.svg)](https://github.com/FPGAwars/apio/actions/workflows/build-linux-x86-64-installer.yml)<br>
+[![build-darwin-arm64-installer](https://github.com/FPGAwars/apio/actions/workflows/build-darwin-arm64-installer.yml/badge.svg)](https://github.com/FPGAwars/apio/actions/workflows/build-darwin-arm64-installer.yml)<br>
+[![build-windows-amd64-installer](https://github.com/FPGAwars/apio/actions/workflows/build-windows-amd64-installer.yml/badge.svg)](https://github.com/FPGAwars/apio/actions/workflows/build-windows-amd64-installer.yml)
 
 ![][linux-logo]&nbsp;&nbsp;&nbsp;![][macosx-logo]&nbsp;&nbsp;&nbsp;![][windows-logo]&nbsp;&nbsp;&nbsp;![][ubuntu-logo]&nbsp;&nbsp;&nbsp;![][raspbian-logo]
 

apio/__main__.py

@@ -3,12 +3,12 @@
 
 import sys
 
-# pylint: disable=import-outside-toplevel
-
 
 def main():
     """Apio starting point."""
 
+    # pylint: disable=import-outside-toplevel
+
     # -- Handle the case in which we run under pyinstaller and the pyinstaller
     # -- program was invoked to run the scons subprocess. This case doesn't
     # -- happen when running as a standard pip package.

apio/apio_context.py

@@ -82,10 +82,11 @@ class ApioContextScope(Enum):
     PROJECT_REQUIRED = 3
 
 
-# pylint: disable=too-many-instance-attributes
 class ApioContext:
     """Apio context. Class for accessing apio resources and configurations."""
 
+    # pylint: disable=too-many-instance-attributes
+
     def __init__(
         self,
         *,
@@ -554,8 +555,9 @@ def is_windows(self) -> bool:
         return "windows" in self.platform_id
 
 
-# pylint: disable=too-few-public-methods
 class _ProjectResolverImpl(ProjectResolver):
+    # pylint: disable=too-few-public-methods
+
     def __init__(self, apio_context: ApioContext):
         """When ApioContext instances this object, ApioContext is fully
         constructed, except for the project field."""

apio/commands/apio_api.py

@@ -78,7 +78,6 @@
 )
 
 
-# pylint: disable=too-many-locals
 @click.command(
     name="info",
     cls=ApioCommand,
@@ -98,6 +97,8 @@ def _info_cli(
 ):
     """Implements the 'apio apio info' command."""
 
+    # pylint: disable=too-many-locals
+
     # -- Should have at list one section
     if not sections:
         cerror("Please list at least one section (e.g. --section boards).")

apio/commands/apio_boards.py

@@ -24,12 +24,12 @@
 from apio.managers.examples import Examples
 
 
-# pylint: disable=duplicate-code
-# pylint: disable=too-many-instance-attributes
 @dataclass(frozen=True)
 class Entry:
     """Holds the values of a single board report line."""
 
+    # pylint: disable=too-many-instance-attributes
+
     board: str
     examples_count: str
     board_description: str
@@ -47,11 +47,11 @@ def sort_key(self):
         return (util.fpga_arch_sort_key(self.fpga_arch), self.board.lower())
 
 
-# R0914: Too many local variables (17/15)
-# pylint: disable=R0914
 def list_boards(apio_ctx: ApioContext, verbose: bool):
     """Prints all the available board definitions."""
 
+    # pylint: disable=too-many-locals
+
     # -- Get examples counts by board. This is a sparse dictionary.
     examples = Examples(apio_ctx)
     examples_counts: Dict[str, int] = examples.count_examples_by_board()
@@ -154,8 +154,6 @@ def list_boards(apio_ctx: ApioContext, verbose: bool):
 
 # ------------- apio boards
 
-# pylint: disable=duplicate-code
-
 
 # -- Text in the rich-text format of the python rich library.
 APIO_BOARDS_HELP = """

apio/commands/apio_build.py

@@ -73,7 +73,6 @@ def cli(
     # -- Create the scons manager.
     scons = SCons(apio_ctx)
 
-    # pylint: disable=duplicate-code
     # -- Build the project with the given parameters
     exit_code = scons.build(
         Verbosity(all=verbose, synth=verbose_synth, pnr=verbose_pnr)

apio/commands/apio_examples.py

@@ -44,7 +44,6 @@ def examples_sort_key(entry: ExampleInfo) -> Any:
     return (util.fpga_arch_sort_key(entry.fpga_arch), entry.name)
 
 
-# pylint: disable=duplicate-code
 def list_examples(apio_ctx: ApioContext, verbose: bool) -> None:
     """Print all the examples available. Return a process exit
     code, 0 if ok, non zero otherwise."""

apio/commands/apio_fpgas.py

@@ -22,12 +22,12 @@
 from apio.commands import options
 
 
-# pylint: disable=duplicate-code
-# pylint: disable=too-many-instance-attributes
 @dataclass(frozen=True)
 class Entry:
     """A class to hold the field of a single line of the report."""
 
+    # pylint: disable=too-many-instance-attributes
+
     fpga: str
     board_count: int
     fpga_arch: str
@@ -42,10 +42,11 @@ def sort_key(self):
         return (util.fpga_arch_sort_key(self.fpga_arch), self.fpga.lower())
 
 
-# pylint: disable=too-many-locals
 def list_fpgas(apio_ctx: ApioContext, verbose: bool):
     """Prints all the available FPGA definitions."""
 
+    # pylint: disable=too-many-locals
+
     # -- Collect a sparse dict with fpga ids to board count.
     boards_counts: Dict[str, int] = {}
     for board_info in apio_ctx.boards.values():
@@ -142,7 +143,6 @@ def list_fpgas(apio_ctx: ApioContext, verbose: bool):
 
 # -------- apio fpgas
 
-# pylint: disable=duplicate-code
 
 # -- Text in the rich-text format of the python rich library.
 APIO_FPGAS_HELP = """

apio/commands/apio_graph.py

@@ -61,8 +61,6 @@
 """
 
 
-# pylint: disable=too-many-arguments
-# pylint: disable=too-many-positional-arguments
 @click.command(
     name="graph",
     cls=cmd_util.ApioCommand,
@@ -87,6 +85,10 @@ def cli(
     top_module: str,
 ):
     """Implements the apio graph command."""
+
+    # pylint: disable=too-many-arguments
+    # pylint: disable=too-many-positional-arguments
+
     # -- Make pylint happy.
     _ = (svg,)
 

apio/commands/apio_info.py

@@ -219,7 +219,6 @@ def _options_cli(
 """
 
 
-# pylint: disable=duplicate-code
 @click.command(
     name="resources",
     cls=ApioCommand,
@@ -291,7 +290,6 @@ def _resources_cli():
 """
 
 
-# pylint: disable=duplicate-code
 @click.command(
     name="system",
     cls=ApioCommand,
@@ -446,8 +444,6 @@ def _platforms_cli():
 )
 
 
-# pylint: disable=duplicate-code
-# pylint: disable=too-many-locals
 @click.command(
     name="colors",
     cls=ApioCommand,
@@ -467,6 +463,8 @@ def _colors_cli(
 ):
     """Implements the 'apio info colors' command."""
 
+    # pylint: disable=too-many-locals
+
     # -- Make pylint happy.
     _ = (rich_,)
 

apio/commands/apio_lint.py

@@ -69,8 +69,6 @@
 """
 
 
-# pylint: disable=too-many-arguments
-# pylint: disable=too-many-positional-arguments
 @click.command(
     name="lint",
     cls=cmd_util.ApioCommand,
@@ -98,6 +96,9 @@ def cli(
 ):
     """Lint the verilog code."""
 
+    # pylint: disable=too-many-arguments
+    # pylint: disable=too-many-positional-arguments
+
     # -- Create the apio context.
     apio_ctx = ApioContext(
         scope=ApioContextScope.PROJECT_REQUIRED,

apio/commands/apio_packages.py

@@ -20,7 +20,6 @@
 from apio.utils.cmd_util import ApioGroup, ApioSubgroup, ApioCommand
 
 
-# pylint: disable=duplicate-code
 def print_packages_report(apio_ctx: ApioContext) -> None:
     """A common function to print the state of the packages."""
 

apio/commands/apio_preferences.py

@@ -61,7 +61,6 @@ def _list_themes_colors():
     print()
 
 
-# pylint: disable=duplicate-code
 def _list_preferences(apio_ctx: ApioContext):
     """Lists the preferences."""
 

apio/commands/apio_report.py

@@ -31,7 +31,6 @@
 """
 
 
-# pylint: disable=duplicate-code
 @click.command(
     name="report",
     cls=cmd_util.ApioCommand,

apio/commands/apio_sim.py

@@ -21,7 +21,6 @@
 
 # --------- apio sim
 
-# pylint: disable=duplicate-code
 
 # -- Text in the rich-text format of the python rich library.
 APIO_SIM_HELP = """

apio/commands/apio_test.py

@@ -19,7 +19,6 @@
 
 # --------- apio test
 
-# pylint: disable=duplicate-code
 
 # -- Text in the rich-text format of the python rich library.
 APIO_TEST_HELP = """

apio/commands/options.py

@@ -25,10 +25,12 @@
 # ----------------------------------
 
 
-# W0622: Redefining built-in 'help'
-# pylint: disable=W0622
 def force_option_gen(*, help: str):
     """Generate a --force option with given help text."""
+
+    # W0622: Redefining built-in 'help'
+    # pylint: disable=redefined-builtin
+
     return click.option(
         "force",  # Var name
         "-f",
@@ -39,10 +41,12 @@ def force_option_gen(*, help: str):
     )
 
 
-# W0622: Redefining built-in 'help'
-# pylint: disable=W0622
 def list_option_gen(*, help: str):
     """Generate a --list option with given help text."""
+
+    # W0622: Redefining built-in 'help'
+    # pylint: disable=redefined-builtin
+
     return click.option(
         "list_",  # Var name. Deconflicting from python builtin 'list'.
         "-l",
@@ -53,13 +57,15 @@ def list_option_gen(*, help: str):
     )
 
 
-# W0622: Redefining built-in 'help'
-# pylint: disable=W0622
 def top_module_option_gen(
     *,
     help: str = "Set the top level module name.",
 ):
     """Generate a --top-module option with given help text."""
+
+    # W0622: Redefining built-in 'help'
+    # pylint: disable=redefined-builtin
+
     return click.option(
         "top_module",  # Var name.
         "-t",
@@ -74,6 +80,10 @@ def top_module_option_gen(
 
 def dst_option_gen(*, help: str):
     """Generate a --dst option with given help text."""
+
+    # W0622: Redefining built-in 'help'
+    # pylint: disable=redefined-builtin
+
     dst_option = click.option(
         "dst",  # Var name.
         "-d",

apio/common/apio_console.py

@@ -64,13 +64,15 @@ def __post_init__(self):
 
 # NOTE: not declaring terminal_mode and  theme_name is Optional[] because it
 # causes the tests to fail with python 3.9.
-# pylint: disable=global-statement
 def configure(
     *,
     terminal_mode: TerminalMode = None,
     theme_name: str = None,
 ) -> None:
     """Change the apio console settings."""
+
+    # pylint: disable=global-statement
+
     global _state
 
     # -- Force utf-8 output encoding. This is a workaround for rich library