♻️Maintenance: mypy catalog (#6121)

Author: sanderegg

.github/workflows/ci-testing-deploy.yml

@@ -665,7 +665,6 @@ jobs:
         run: ./ci/github/unit-testing/catalog.bash install
       - name: typecheck
         run: ./ci/github/unit-testing/catalog.bash typecheck
-        continue-on-error: true
       - name: test
         if: always()
         run: ./ci/github/unit-testing/catalog.bash test

packages/models-library/src/models_library/rpc_pagination.py

@@ -65,7 +65,7 @@ def create(
         total: int,
         limit: int,
         offset: int,
-    ):
+    ) -> "PageRpc":
         return cls(
             _meta=PageMetaInfoLimitOffset(
                 total=total, count=len(chunk), limit=limit, offset=offset

services/catalog/requirements/_test.in

@@ -28,3 +28,5 @@ pytest-mock
 pytest-runner
 respx
 sqlalchemy[mypy] # adds Mypy / Pep-484 Support for ORM Mappings SEE https://docs.sqlalchemy.org/en/20/orm/extensions/mypy.html
+types-psycopg2
+types-PyYAML

services/catalog/requirements/_test.txt

@@ -185,6 +185,10 @@ tomli==2.0.1
     #   coverage
     #   mypy
     #   pytest
+types-psycopg2==2.9.21.20240417
+    # via -r requirements/_test.in
+types-pyyaml==6.0.12.20240724
+    # via -r requirements/_test.in
 typing-extensions==4.10.0
     # via
     #   -c requirements/_base.txt

services/catalog/setup.cfg

@@ -9,5 +9,10 @@ commit_args = --no-verify
 
 [tool:pytest]
 asyncio_mode = auto
-markers = 
+markers =
 	testit: "marks test to run during development"
+
+[mypy]
+plugins =
+	pydantic.mypy
+	sqlalchemy.ext.mypy.plugin

services/catalog/src/simcore_service_catalog/_constants.py

@@ -1,9 +1,9 @@
-from typing import Final
+from typing import Any, Final
 
 # These are equivalent to pydantic export models but for responses
 # SEE https://pydantic-docs.helpmanual.io/usage/exporting_models/#modeldict
 # SEE https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter
-RESPONSE_MODEL_POLICY: Final[dict[str, bool]] = {
+RESPONSE_MODEL_POLICY: Final[dict[str, Any]] = {
     "response_model_by_alias": True,
     "response_model_exclude_unset": True,
     "response_model_exclude_defaults": False,

services/catalog/src/simcore_service_catalog/api/dependencies/services.py

@@ -1,6 +1,6 @@
 import logging
 from dataclasses import dataclass
-from typing import Annotated
+from typing import Annotated, cast
 
 from fastapi import Depends, FastAPI, Header, HTTPException, status
 from models_library.api_schemas_catalog.services_specifications import (
@@ -92,10 +92,13 @@ async def get_service_from_manifest(
     Retrieves service metadata from the docker registry via the director
     """
     try:
-        return await manifest.get_service(
-            key=service_key,
-            version=service_version,
-            director_client=director_client,
+        return cast(
+            ServiceMetaDataPublished,
+            await manifest.get_service(
+                key=service_key,
+                version=service_version,
+                director_client=director_client,
+            ),
         )
 
     except ValidationError as exc:

services/catalog/src/simcore_service_catalog/api/rest/_services.py

@@ -5,7 +5,7 @@
 import urllib.parse
 from typing import Annotated, Any, TypeAlias, cast
 
-from aiocache import cached
+from aiocache import cached  # type: ignore[import-untyped]
 from fastapi import APIRouter, Depends, Header, HTTPException, status
 from models_library.api_schemas_catalog.services import ServiceGet, ServiceUpdate
 from models_library.services import ServiceKey, ServiceType, ServiceVersion
@@ -335,6 +335,7 @@ async def update_service(
 
     if updated_service.access_rights:
         # start by updating/inserting new entries
+        assert x_simcore_products_name  # nosec
         new_access_rights = [
             ServiceAccessRightsAtDB(
                 key=service_key,
@@ -366,6 +367,7 @@ async def update_service(
         await services_repo.delete_service_access_rights(deleted_access_rights)
 
     # now return the service
+    assert x_simcore_products_name  # nosec
     return await get_service(
         user_id=user_id,
         service_in_manifest=await get_service_from_manifest(

services/catalog/src/simcore_service_catalog/api/rest/_services_ports.py

@@ -30,11 +30,11 @@ async def list_service_ports(
     ports: list[ServicePortGet] = []
 
     if service.inputs:
-        for name, port in service.inputs.items():
-            ports.append(ServicePortGet.from_service_io("input", name, port))
+        for name, input_port in service.inputs.items():
+            ports.append(ServicePortGet.from_service_io("input", name, input_port))
 
     if service.outputs:
-        for name, port in service.outputs.items():
-            ports.append(ServicePortGet.from_service_io("output", name, port))
+        for name, output_port in service.outputs.items():
+            ports.append(ServicePortGet.from_service_io("output", name, output_port))
 
     return ports

services/catalog/src/simcore_service_catalog/api/rest/_services_resources.py

@@ -197,7 +197,7 @@ async def get_service_resources(
         )
 
     service_spec: ComposeSpecLabelDict | None = parse_raw_as(
-        ComposeSpecLabelDict | None,
+        ComposeSpecLabelDict | None,  # type: ignore[arg-type]
         service_labels.get(SIMCORE_SERVICE_COMPOSE_SPEC_LABEL, "null"),
     )
     _logger.debug("received %s", f"{service_spec=}")