Pyright type checker fails on cmds

Problem:
The pyright type checker erroneously fails on the archivist/cmds
directory.

Solution:
The archivist cmds directory does not contain library code but only the
exposed entrypoints. The solution is to not bother checking the cmds
subdirectory.

Fixes AB#7653

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

Author: eccles

.github/workflows/python-package.yml

@@ -44,7 +44,7 @@ jobs:
         ./scripts/version.sh
         pycodestyle --format=pylint archivist examples functests unittests
         python3 -m pylint archivist examples functests unittests
-        python3 -m pyright archivist
+        python3 -m pyright --stats archivist
         black archivist examples unittests functests
         ./scripts/zipnotebooks.sh
         (cd docs && make clean && make html)

Taskfile.yml

@@ -45,7 +45,7 @@ tasks:
     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 python3 -m pyright --stats archivist
       - ./scripts/builder.sh pycodestyle --format=pylint archivist examples functests unittests
       - ./scripts/builder.sh python3 -m pylint archivist examples functests unittests
 

archivist/archivist.py

@@ -308,7 +308,7 @@ def post_file(
 
         response = self.session.post(
             url,
-            data=multipart,  # type: ignore    https://github.com/requests/toolbelt/issues/312
+            data=multipart,  # pyright: ignore    https://github.com/requests/toolbelt/issues/312
             headers=self._add_headers(headers),
             verify=self.verify,
             params=_dotdict(params),

archivist/confirmer.py

@@ -78,7 +78,7 @@ def _wait_for_confirmation(self: events._EventsPublic, identity: str) -> events.
 
 @backoff.on_predicate(
     backoff.expo,
-    logger=None,  # type: ignore
+    logger=None,  # pyright: ignore
     max_time=__lookup_max_time,
     on_backoff=backoff_handler,
     on_giveup=__on_giveup_confirmation,
@@ -102,7 +102,7 @@ def _wait_for_confirmation(self: Managers, identity: str) -> ReturnTypes:
     if entity[CONFIRMATION_STATUS] == CONFIRMATION_CONFIRMED:
         return entity
 
-    return None  # type: ignore
+    return None  # pyright: ignore
 
 
 def __on_giveup_confirmed(details: dict[str, Any]):
@@ -116,7 +116,7 @@ def __on_giveup_confirmed(details: dict[str, Any]):
 
 @backoff.on_predicate(
     backoff.expo,
-    logger=None,  # type: ignore
+    logger=None,  # pyright: ignore
     max_time=__lookup_max_time,
     on_backoff=backoff_handler,
     on_giveup=__on_giveup_confirmed,

archivist/events.py

@@ -187,10 +187,11 @@ def count(
         # asset_id will cause issues in the _identity function and the count function
         LOGGER.debug("asset_id %s", asset_id)
         LOGGER.debug(
-            "event_id %s", f"{self._identity(asset_id)}/{EVENTS_LABEL}"  # type:ignore
+            "event_id %s",
+            f"{self._identity(asset_id)}/{EVENTS_LABEL}",  # pyright: ignore
         )
         return self._archivist.count(
-            f"{self._identity(asset_id)}/{EVENTS_LABEL}",  # type:ignore
+            f"{self._identity(asset_id)}/{EVENTS_LABEL}",  # pyright: ignore
             params=self._params(props, attrs, asset_attrs),
         )
 
@@ -226,7 +227,7 @@ def list(
         return (
             Event(**a)
             for a in self._archivist.list(
-                f"{self._identity(asset_id)}/{EVENTS_LABEL}",  # type:ignore
+                f"{self._identity(asset_id)}/{EVENTS_LABEL}",  # pyright: ignore
                 EVENTS_LABEL,
                 page_size=page_size,
                 params=self._params(props, attrs, asset_attrs),
@@ -262,7 +263,7 @@ def read_by_signature(
 
         return Event(
             **self._archivist.get_by_signature(
-                f"{self._identity(asset_id)}/{EVENTS_LABEL}",  # type:ignore
+                f"{self._identity(asset_id)}/{EVENTS_LABEL}",  # pyright: ignore
                 EVENTS_LABEL,
                 params=self._params(props, attrs, asset_attrs),
             )

archivist/parser.py

@@ -49,7 +49,7 @@ def __init__(self, **kwargs):
 
     def __call__(self, parser, namespace, values, option_string=None):
         # Convert value back into an Enum
-        value = self._enum[values]  # type: ignore
+        value = self._enum[values]  # pyright: ignore
         setattr(namespace, self.dest, value)
 
 

archivist/publisher.py

@@ -38,7 +38,7 @@ def __on_giveup_publication(details):
 
 @backoff.on_predicate(
     backoff.expo,
-    logger=None,  # type: ignore
+    logger=None,  # pyright: ignore
     max_time=__lookup_max_time,
     on_backoff=backoff_handler,
     on_giveup=__on_giveup_publication,
@@ -50,4 +50,4 @@ def _wait_for_publication(self: sboms._SBOMSClient, identity: str) -> sboms.SBOM
     if entity.published_date:
         return entity
 
-    return None  # type: ignore
+    return None  # pyright: ignore

archivist/runner.py

@@ -206,7 +206,7 @@ def action(self, action_name: str) -> Callable:
         Get valid action in map
         """
         # if an exception occurs here then the dict initialized above is faulty.
-        return self.ops(action_name).get("action")  # type: ignore
+        return self.ops(action_name).get("action")  # pyright: ignore
 
     def keywords(self, action_name: str) -> Tuple | None:
         """
@@ -316,10 +316,10 @@ def label(self, verb: str, noun: str):
 
     def identity_from_label(self, noun, identity_method):
         label = self.get(f"{noun}_label")
-        if not label.startswith(f"{noun}s/"):  # type: ignore
+        if not label.startswith(f"{noun}s/"):  # pyright: ignore
             return identity_method(label)
 
-        uid = label.split("/")[1]  # type: ignore
+        uid = label.split("/")[1]  # pyright: ignore
         try:
             _ = UUID(uid, version=4)
         except ValueError:

archivist/subjects_confirmer.py

@@ -39,7 +39,7 @@ def __on_giveup_confirmation(details):
 
 @backoff.on_predicate(
     backoff.expo,
-    logger=None,  # type: ignore
+    logger=None,  # pyright: ignore
     max_time=__lookup_max_time,
     on_backoff=backoff_handler,
     on_giveup=__on_giveup_confirmation,
@@ -50,9 +50,9 @@ def _wait_for_confirmation(
     """Return None until subjects is confirmed"""
     subject = self.read(identity)
     if CONFIRMATION_STATUS not in subject:
-        return None  # type: ignore
+        return None  # pyright: ignore
 
     if subject[CONFIRMATION_STATUS] == CONFIRMATION_CONFIRMED:
         return subject
 
-    return None  # type: ignore
+    return None  # pyright: ignore

archivist/uploader.py

@@ -35,7 +35,7 @@ def __on_giveup_uploading(details):
 
 @backoff.on_predicate(
     backoff.expo,
-    logger=None,  # type: ignore
+    logger=None,  # pyright: ignore
     max_time=__lookup_max_time,
     on_backoff=backoff_handler,
     on_giveup=__on_giveup_uploading,
@@ -46,6 +46,6 @@ def _wait_for_uploading(self: sboms._SBOMSClient, identity: str) -> sboms.SBOM:
         LOGGER.debug("Uploader Read %s", identity)
         entity = self.read(identity)
     except ArchivistNotFoundError:
-        return None  # type: ignore
+        return None  # pyright: ignore
 
     return entity