Improve linting

Problem:
Slow linters are used that have complicated configuration and expensive
to maintain.

Solution:
Introduce the new ruff linter which is super fast as it is written in
Rust. Also has options to emit suggested solutions and also to
automatically fix errors. This is just the introduction - eventually
this will be added to a commit hook and the github actions and
other linters will be removed.
Additionally added workaround for fixing the current version of the
github ubuntu-latest runner.

Signed-off-by: Paul Hewlett <[email protected]>

.devcontainer/devcontainer.json

@@ -39,6 +39,7 @@
 
 			// Add the IDs of extensions you want installed when the container is created.
 			"extensions": [
+				"charliermarsh.ruff",
 				"ms-python.python",
 				"ms-python.vscode-pylance"
 			]

.github/workflows/python-package.yml

@@ -23,6 +23,8 @@ jobs:
     - name: Install dependencies
       run: |
         export DEBIAN_FRONTEND=noninteractive
+        # https://github.com/community/community/discussions/47863
+        sudo apt-mark hold grub-efi-amd64-signed
         sudo apt-get update
         sudo apt-get upgrade -y --no-install-recommends
         sudo apt-get install -y --fix-missing \

.github/workflows/python-publish.yml

@@ -21,6 +21,8 @@ jobs:
     - name: Install dependencies
       run: |
         export DEBIAN_FRONTEND=noninteractive
+        # https://github.com/community/community/discussions/47863
+        sudo apt-mark hold grub-efi-amd64-signed
         sudo apt-get update
         sudo apt-get upgrade -y --no-install-recommends
         sudo apt-get install -y --fix-missing \

Taskfile.yml

@@ -44,10 +44,23 @@ tasks:
     deps: [about]
     cmds:
       - ./scripts/builder.sh python3 --version
+      - ./scripts/builder.sh ruff check archivist examples functests unittests
       - ./scripts/builder.sh python3 -m pyright archivist
       - ./scripts/builder.sh pycodestyle --format=pylint archivist examples functests unittests
       - ./scripts/builder.sh python3 -m pylint archivist examples functests unittests
 
+  check-fixes:
+    desc: Show proposed fixes from ruff
+    deps: [about]
+    cmds:
+      - ./scripts/builder.sh ruff check --show-fixes archivist examples functests unittests
+
+  check-fixes-apply:
+    desc: Apply  proposed fixes from ruff
+    deps: [about]
+    cmds:
+      - ./scripts/builder.sh ruff check --fix archivist examples functests unittests
+
   clean:
     desc: Clean git repo
     cmds:

archivist/access_policies.py

@@ -22,22 +22,24 @@
 """
 
 from __future__ import annotations
-from logging import getLogger
+
 from copy import deepcopy
-from typing import Any, Generator, Optional
+from logging import getLogger
+from typing import TYPE_CHECKING, Any, Generator, Optional
 
 # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
-from . import archivist
+
+if TYPE_CHECKING:
+    from . import archivist
 
 from .assets import Asset
 from .constants import (
-    ACCESS_POLICIES_SUBPATH,
     ACCESS_POLICIES_LABEL,
+    ACCESS_POLICIES_SUBPATH,
     ASSETS_LABEL,
 )
 from .dictmerge import _deepmerge
 
-
 LOGGER = getLogger(__name__)
 
 

archivist/appidp.py

@@ -22,15 +22,20 @@
 """
 
 from __future__ import annotations
+
 from logging import getLogger
+from typing import TYPE_CHECKING
 
 # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
 # pylint:disable=too-few-public-methods
-from . import archivist
+
+# pylint:disable=cyclic-import      # but pylint doesn't understand this feature
+if TYPE_CHECKING:
+    from . import archivist
 
 from .constants import (
-    APPIDP_SUBPATH,
     APPIDP_LABEL,
+    APPIDP_SUBPATH,
     APPIDP_TOKEN,
 )
 

archivist/applications.py

@@ -22,20 +22,21 @@
 """
 
 from __future__ import annotations
+
 from logging import getLogger
-from typing import Any, Optional
+from typing import TYPE_CHECKING, Any, Optional
 
 # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
-from . import archivist
+if TYPE_CHECKING:
+    from . import archivist
 
 from .constants import (
-    APPLICATIONS_SUBPATH,
     APPLICATIONS_LABEL,
     APPLICATIONS_REGENERATE,
+    APPLICATIONS_SUBPATH,
 )
 from .dictmerge import _deepmerge
 
-
 LOGGER = getLogger(__name__)
 
 

archivist/archivist.py

@@ -30,43 +30,42 @@
 
 """
 from __future__ import annotations
-from logging import getLogger
+
 from copy import deepcopy
+from logging import getLogger
 from time import time
 from typing import Any, BinaryIO, Optional, Tuple
 
 from requests_toolbelt.multipart.encoder import MultipartEncoder
 
+from .access_policies import _AccessPoliciesClient
+from .appidp import _AppIDPClient
+from .applications import _ApplicationsClient
+from .archivistpublic import ArchivistPublic
+from .assetattachments import _AssetAttachmentsClient
+from .assets import _AssetsRestricted
+from .attachments import _AttachmentsClient
+from .compliance import _ComplianceClient
+from .compliance_policies import _CompliancePoliciesClient
+from .composite import _CompositeClient
 from .confirmer import MAX_TIME
 from .constants import (
     ROOT,
     SEP,
 )
 from .dictmerge import _dotdict
 from .errors import (
-    _parse_response,
     ArchivistError,
+    _parse_response,
 )
-from .archivistpublic import ArchivistPublic
-from .retry429 import retry_429
-
-from .access_policies import _AccessPoliciesClient
-from .appidp import _AppIDPClient
-from .applications import _ApplicationsClient
-from .assets import _AssetsRestricted
-from .assetattachments import _AssetAttachmentsClient
-from .attachments import _AttachmentsClient
-from .compliance import _ComplianceClient
-from .compliance_policies import _CompliancePoliciesClient
-from .composite import _CompositeClient
 from .events import _EventsRestricted
 from .locations import _LocationsClient
+from .retry429 import retry_429
 from .runner import _Runner
 from .sboms import _SBOMSClient
 from .subjects import _SubjectsClient
 from .tenancies import _TenanciesClient
 
-
 LOGGER = getLogger(__name__)
 
 
@@ -222,10 +221,7 @@ def __copy__(self) -> Archivist:
         )
 
     def _add_headers(self, headers: dict[str, str] | None) -> dict[str, Any]:
-        if isinstance(headers, dict):
-            newheaders = {**headers}
-        else:
-            newheaders = {}
+        newheaders = {**headers} if isinstance(headers, dict) else {}
 
         auth = self.auth  # this may trigger a refetch so only do it once here
         # for appidp endpoint there may not be an authtoken

archivist/archivistpublic.py

@@ -23,35 +23,37 @@
 """
 
 from __future__ import annotations
-from logging import getLogger
+
 from collections import deque
 from copy import deepcopy
-from typing import Any, BinaryIO, Optional
+from logging import getLogger
+from typing import TYPE_CHECKING, Any, BinaryIO, Optional
 
 import requests
-from requests.models import Response
+
+if TYPE_CHECKING:
+    from requests.models import Response
 
 
+from .assetattachments import _AssetAttachmentsClient
+from .assets import _AssetsPublic
 from .confirmer import MAX_TIME
 from .constants import (
     HEADERS_REQUEST_TOTAL_COUNT,
     HEADERS_TOTAL_COUNT,
 )
 from .dictmerge import _deepmerge, _dotdict
 from .errors import (
-    _parse_response,
     ArchivistBadFieldError,
     ArchivistDuplicateError,
     ArchivistHeaderError,
     ArchivistNotFoundError,
+    _parse_response,
 )
+from .events import _EventsPublic
 from .headers import _headers_get
 from .retry429 import retry_429
 
-from .assets import _AssetsPublic
-from .events import _EventsPublic
-from .assetattachments import _AssetAttachmentsClient
-
 LOGGER = getLogger(__name__)
 
 
@@ -168,10 +170,7 @@ def __copy__(self):
         )
 
     def _add_headers(self, headers: Optional[dict]) -> dict[str, str]:
-        if headers is not None:
-            newheaders = {**headers}
-        else:
-            newheaders = {}
+        newheaders = {**headers} if headers is not None else {}
 
         return newheaders
 

archivist/asset.py

@@ -3,6 +3,8 @@
 """
 from __future__ import annotations
 
+from contextlib import suppress
+
 
 class Asset(dict):
     """Asset
@@ -50,9 +52,7 @@ def primary_image(self) -> str | None:
     def name(self) -> str | None:
         """str: name of the asset"""
         name = None
-        try:
+        with suppress(KeyError, TypeError):
             name = self["attributes"]["arc_display_name"]
-        except (KeyError, TypeError):
-            pass
 
         return name

archivist/assetattachments.py

@@ -25,21 +25,23 @@
 # pylint:disable=too-few-public-methods
 
 from __future__ import annotations
+
 from copy import deepcopy
 from logging import getLogger
-from typing import Any, BinaryIO, Optional
+from typing import TYPE_CHECKING, Any, BinaryIO, Optional
 from urllib.parse import urlparse
 
-from requests.models import Response
+if TYPE_CHECKING:
+    from requests.models import Response
 
-# pylint:disable=cyclic-import      # but pylint doesn't understand this feature
-from . import archivist
+    # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
+    from . import archivist
 
 from .constants import (
-    SEP,
-    ASSETATTACHMENTS_SUBPATH,
     ASSETATTACHMENTS_LABEL,
+    ASSETATTACHMENTS_SUBPATH,
     ATTACHMENTS_LABEL,
+    SEP,
 )
 from .dictmerge import _deepmerge
 

archivist/assets.py

@@ -22,21 +22,20 @@
 """
 
 from __future__ import annotations
+
+from copy import deepcopy
 from logging import getLogger
 from typing import Any, Optional, Tuple
-from copy import deepcopy
 
 # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
-from . import archivist
-
+from . import archivist, confirmer
 from .asset import Asset
 from .constants import (
     ASSET_BEHAVIOURS,
-    ASSETS_SUBPATH,
     ASSETS_LABEL,
+    ASSETS_SUBPATH,
     CONFIRMATION_STATUS,
 )
-from . import confirmer
 from .dictmerge import _deepmerge
 from .errors import ArchivistBadFieldError, ArchivistNotFoundError
 from .utils import selector_signature

archivist/attachments.py

@@ -25,20 +25,22 @@
 # pylint:disable=too-few-public-methods
 
 from __future__ import annotations
+
 from copy import deepcopy
 from io import BytesIO
 from logging import getLogger
 from os import path
-from typing import BinaryIO, Optional, Any
+from typing import TYPE_CHECKING, Any, BinaryIO, Optional
 
-from requests.models import Response
+if TYPE_CHECKING:
+    from requests.models import Response
 
-# pylint:disable=cyclic-import      # but pylint doesn't understand this feature
-from . import archivist
+    # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
+    from . import archivist
 
 from .constants import (
-    ATTACHMENTS_SUBPATH,
     ATTACHMENTS_LABEL,
+    ATTACHMENTS_SUBPATH,
 )
 from .dictmerge import _deepmerge
 from .utils import get_url

archivist/cmds/runner/__main__.py

@@ -3,7 +3,6 @@
 
 from .main import main
 
-
 if __name__ == "__main__":
     # execute only if run as a script
     main()

archivist/cmds/runner/main.py

@@ -5,7 +5,6 @@
 from sys import stdout as sys_stdout
 
 from ...parser import common_parser, endpoint
-
 from .run import run
 
 LOGGER = getLogger(__name__)

archivist/cmds/runner/run.py

@@ -1,17 +1,15 @@
 # pylint:  disable=missing-docstring
 
 from __future__ import annotations
+
 from logging import getLogger
 from os import environ
 from sys import exit as sys_exit
 
 from pyaml_env import parse_config
 
-from ... import about
-
 # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
-from ... import archivist
-
+from ... import about, archivist
 
 LOGGER = getLogger(__name__)