♻️Maintenance: Mypy on servicelib (#6117)

Author: sanderegg

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

@@ -1512,7 +1512,6 @@ jobs:
         run: ./ci/github/unit-testing/service-library.bash install_all
       - name: typecheck
         run: ./ci/github/unit-testing/service-library.bash typecheck
-        continue-on-error: true
       - name: test
         if: always()
         run: ./ci/github/unit-testing/service-library.bash test_all

packages/postgres-database/src/simcore_postgres_database/utils_aiosqlalchemy.py

@@ -16,7 +16,7 @@ class DBMigrationError(RuntimeError):
     pass
 
 
-async def raise_if_migration_not_ready(engine: AsyncEngine):
+async def raise_if_migration_not_ready(engine: AsyncEngine) -> None:
     """Ensures db migration is complete
 
     :raises DBMigrationError

packages/service-library/requirements/_test.in

@@ -25,10 +25,15 @@ pytest-asyncio
 pytest-benchmark
 pytest-cov
 pytest-docker
+pytest-icdiff
 pytest-instafail
 pytest-mock
 pytest-runner
 pytest-sugar
 pytest-xdist
 python-dotenv
 respx
+sqlalchemy[mypy]
+types_aiofiles
+types-psycopg2
+types_tqdm

packages/service-library/requirements/_test.txt

@@ -65,6 +65,10 @@ frozenlist==1.4.1
     #   -c requirements/_base.txt
     #   aiohttp
     #   aiosignal
+greenlet==3.0.3
+    # via
+    #   -c requirements/_aiohttp.txt
+    #   sqlalchemy
 h11==0.14.0
     # via
     #   -c requirements/_fastapi.txt
@@ -78,6 +82,8 @@ httpx==0.27.0
     #   -c requirements/../../../requirements/constraints.txt
     #   -c requirements/_fastapi.txt
     #   respx
+icdiff==2.0.7
+    # via pytest-icdiff
 idna==3.7
     # via
     #   -c requirements/_aiohttp.txt
@@ -115,6 +121,10 @@ multidict==6.0.5
     #   -c requirements/_base.txt
     #   aiohttp
     #   yarl
+mypy==1.11.0
+    # via sqlalchemy
+mypy-extensions==1.0.0
+    # via mypy
 openapi-schema-validator==0.6.2
     # via
     #   -c requirements/_aiohttp.txt
@@ -133,6 +143,8 @@ pathable==0.4.3
     #   jsonschema-path
 pluggy==1.5.0
     # via pytest
+pprintpp==0.4.0
+    # via pytest-icdiff
 psutil==6.0.0
     # via -r requirements/_test.in
 py-cpuinfo==9.0.0
@@ -145,6 +157,7 @@ pytest==8.2.2
     #   pytest-benchmark
     #   pytest-cov
     #   pytest-docker
+    #   pytest-icdiff
     #   pytest-instafail
     #   pytest-mock
     #   pytest-sugar
@@ -162,6 +175,8 @@ pytest-cov==5.0.0
     # via -r requirements/_test.in
 pytest-docker==3.1.1
     # via -r requirements/_test.in
+pytest-icdiff==0.9
+    # via -r requirements/_test.in
 pytest-instafail==0.5.0
     # via -r requirements/_test.in
 pytest-mock==3.14.0
@@ -221,17 +236,33 @@ sniffio==1.3.1
     #   anyio
     #   asgi-lifespan
     #   httpx
+sqlalchemy==1.4.52
+    # via
+    #   -c requirements/../../../requirements/constraints.txt
+    #   -c requirements/_aiohttp.txt
+    #   -r requirements/_test.in
+sqlalchemy2-stubs==0.0.2a38
+    # via sqlalchemy
 termcolor==2.4.0
     # via pytest-sugar
 tomli==2.0.1
     # via
     #   coverage
+    #   mypy
     #   pytest
+types-aiofiles==24.1.0.20240626
+    # via -r requirements/_test.in
+types-psycopg2==2.9.21.20240417
+    # via -r requirements/_test.in
+types-tqdm==4.66.0.20240417
+    # via -r requirements/_test.in
 typing-extensions==4.12.2
     # via
     #   -c requirements/_base.txt
     #   -c requirements/_fastapi.txt
     #   anyio
+    #   mypy
+    #   sqlalchemy2-stubs
 urllib3==2.2.2
     # via
     #   -c requirements/../../../requirements/constraints.txt

packages/service-library/requirements/_tools.txt

@@ -28,9 +28,12 @@ isort==5.13.2
 mccabe==0.7.0
     # via pylint
 mypy==1.11.0
-    # via -r requirements/../../../requirements/devenv.txt
+    # via
+    #   -c requirements/_test.txt
+    #   -r requirements/../../../requirements/devenv.txt
 mypy-extensions==1.0.0
     # via
+    #   -c requirements/_test.txt
     #   black
     #   mypy
 nodeenv==1.9.1

packages/service-library/setup.cfg

@@ -20,3 +20,8 @@ markers =
 	testit: "marks test to run during development"
 	performance_test: "performance test"
 	no_cleanup_check_rabbitmq_server_has_no_errors: "no check in rabbitmq logs"
+
+[mypy]
+plugins =
+	pydantic.mypy
+	sqlalchemy.ext.mypy.plugin

packages/service-library/src/servicelib/aiohttp/aiopg_utils.py

@@ -10,6 +10,7 @@
     SEE for underlying psycopg: http://initd.org/psycopg/docs/module.html
     SEE for extra keywords: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS
 """
+
 # TODO: Towards implementing https://github.com/ITISFoundation/osparc-simcore/issues/1195
 # TODO: deprecate this module. Move utils into retry_policies, simcore_postgres_database.utils_aiopg
 
@@ -63,9 +64,9 @@ def init_pg_tables(dsn: DataSourceName, schema: sa.schema.MetaData):
 
 
 def raise_http_unavailable_error(retry_state: RetryCallState):
-    # TODO: mark incident on db to determine the quality of service. E.g. next time we do not stop. TIP: obj, query = retry_state.args; obj.app.register_incidents
-
-    exc: DatabaseError = retry_state.outcome.exception()
+    assert retry_state.outcome  # nosec
+    exc = retry_state.outcome.exception()
+    assert exc  # nosec
     # StandardError
     # |__ Warning
     # |__ Error
@@ -101,13 +102,13 @@ class PostgresRetryPolicyUponOperation:
     def __init__(self, logger: logging.Logger | None = None):
         logger = logger or log
 
-        self.kwargs = dict(
-            retry=retry_if_exception_type(DatabaseError),
-            wait=wait_fixed(self.WAIT_SECS),
-            stop=stop_after_attempt(self.ATTEMPTS_COUNT),
-            after=after_log(logger, logging.WARNING),
-            retry_error_callback=raise_http_unavailable_error,
-        )
+        self.kwargs = {
+            "retry": retry_if_exception_type(DatabaseError),
+            "wait": wait_fixed(self.WAIT_SECS),
+            "stop": stop_after_attempt(self.ATTEMPTS_COUNT),
+            "after": after_log(logger, logging.WARNING),
+            "retry_error_callback": raise_http_unavailable_error,
+        }
 
 
 __all__ = (

packages/service-library/src/servicelib/aiohttp/application_setup.py

@@ -74,7 +74,7 @@ def _parse_and_validate_arguments(
         msg = "Can only set config_section or config_enabled but not both"
         raise ValueError(msg)
 
-    section = config_section or module_name.split(".")[-1]
+    section: str | None = config_section or module_name.split(".")[-1]
     if config_enabled is None:
         config_enabled = f"{section}.enabled"
     else:

packages/service-library/src/servicelib/aiohttp/client_session.py

@@ -1,4 +1,5 @@
 from collections.abc import AsyncGenerator
+from typing import cast
 
 from aiohttp import ClientSession, ClientTimeout, web
 from models_library.utils.json_serialization import json_dumps
@@ -40,7 +41,7 @@ async def persistent_client_session(app: web.Application) -> AsyncGenerator[None
 def get_client_session(app: web.Application) -> ClientSession:
     """Refers to the one-and-only client in the app"""
     assert APP_CLIENT_SESSION_KEY in app  # nosec
-    return app[APP_CLIENT_SESSION_KEY]
+    return cast(ClientSession, app[APP_CLIENT_SESSION_KEY])
 
 
 __all__: tuple[str, ...] = (

packages/service-library/src/servicelib/aiohttp/dev_error_logger.py

@@ -2,7 +2,8 @@
 import traceback
 
 from aiohttp.web import Application, HTTPError, Request, middleware
-from servicelib.aiohttp.typing_extension import Handler, Middleware
+
+from .typing_extension import Handler, Middleware
 
 _logger = logging.getLogger(__name__)
 
@@ -23,12 +24,12 @@ async def middleware_handler(request: Request, handler: Handler):
                 "Traceback": "\n".join(traceback.format_tb(err.__traceback__)),
             }
             formatted_error = "".join(
-                [f"\n{_SEP}{k}{_SEP}\n{v}" for k, v in fields.items()]
+                [f"\n{_SEP}{k!r}{_SEP}\n{v!r}" for k, v in fields.items()]
             )
             _logger.debug("Error serialized to client:%s", formatted_error)
             raise
 
-    return middleware_handler  # type: ignore[no-any-return]
+    return middleware_handler
 
 
 def setup_dev_error_logger(app: Application) -> None: