♻️Maintenance: mypy notifications-library, osparc-gateway-server, invitations (#6120)

sanderegg · web-flow · commit eb1a259c27c6 · 2024-07-30T07:35:53.000+02:00
diff --git a/.github/workflows/ci-testing-deploy.yml b/.github/workflows/ci-testing-deploy.yml
@@ -1032,7 +1032,6 @@ jobs:
           source .venv/bin/activate && \
           pushd services/osparc-gateway-server && \
           make mypy
-        continue-on-error: true
       - name: test
         if: always()
         run: |
@@ -1428,7 +1427,6 @@ jobs:
         run: ./ci/github/unit-testing/invitations.bash install
       - name: typecheck
         run: ./ci/github/unit-testing/invitations.bash typecheck
-        continue-on-error: true
       - name: test
         if: always()
         run: ./ci/github/unit-testing/invitations.bash test
@@ -1644,7 +1642,6 @@ jobs:
         run: ./ci/github/unit-testing/notifications-library.bash install
       - name: typecheck
         run: ./ci/github/unit-testing/notifications-library.bash typecheck
-        continue-on-error: true
       - name: test
         if: always()
         run: ./ci/github/unit-testing/notifications-library.bash test
diff --git a/packages/notifications-library/requirements/_test.in b/packages/notifications-library/requirements/_test.in
@@ -22,3 +22,5 @@ pytest-sugar
 python-dotenv
 pyyaml
 tenacity
+sqlalchemy[mypy]
+types-aiofiles
diff --git a/packages/notifications-library/requirements/_test.txt b/packages/notifications-library/requirements/_test.txt
@@ -14,6 +14,10 @@ exceptiongroup==1.2.2
     # via pytest
 faker==26.0.0
     # via -r requirements/_test.in
+greenlet==3.0.3
+    # via
+    #   -c requirements/_base.txt
+    #   sqlalchemy
 icdiff==2.0.7
     # via pytest-icdiff
 idna==3.7
@@ -22,6 +26,10 @@ idna==3.7
     #   requests
 iniconfig==2.0.0
     # via pytest
+mypy==1.11.0
+    # via sqlalchemy
+mypy-extensions==1.0.0
+    # via mypy
 packaging==24.1
     # via
     #   pytest
@@ -71,14 +79,29 @@ six==1.16.0
     # via
     #   -c requirements/_base.txt
     #   python-dateutil
+sqlalchemy==1.4.52
+    # via
+    #   -c requirements/../../../requirements/constraints.txt
+    #   -c requirements/_base.txt
+    #   -r requirements/_test.in
+sqlalchemy2-stubs==0.0.2a38
+    # via sqlalchemy
 tenacity==8.5.0
     # via -r requirements/_test.in
 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
+typing-extensions==4.12.2
+    # via
+    #   -c requirements/_base.txt
+    #   mypy
+    #   sqlalchemy2-stubs
 urllib3==2.2.2
     # via
     #   -c requirements/../../../requirements/constraints.txt
diff --git a/packages/notifications-library/requirements/_tools.txt b/packages/notifications-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
@@ -81,6 +84,7 @@ tomlkit==0.13.0
 typing-extensions==4.12.2
     # via
     #   -c requirements/_base.txt
+    #   -c requirements/_test.txt
     #   astroid
     #   black
     #   mypy
diff --git a/packages/notifications-library/setup.cfg b/packages/notifications-library/setup.cfg
@@ -15,3 +15,8 @@ test = pytest
 
 [tool:pytest]
 asyncio_mode = auto
+
+[mypy]
+plugins =
+	pydantic.mypy
+	sqlalchemy.ext.mypy.plugin
diff --git a/packages/notifications-library/src/notifications_library/_email.py b/packages/notifications-library/src/notifications_library/_email.py
@@ -4,7 +4,6 @@
 from contextlib import asynccontextmanager
 from email.headerregistry import Address
 from email.message import EmailMessage
-from typing import cast
 
 from aiosmtplib import SMTP
 from settings_library.email import EmailProtocol, SMTPSettings
@@ -86,4 +85,4 @@ async def create_email_session(
                 settings.SMTP_PASSWORD.get_secret_value(),
             )
 
-        yield cast(SMTP, smtp)
+        yield smtp
diff --git a/services/invitations/setup.cfg b/services/invitations/setup.cfg
@@ -11,3 +11,7 @@ commit_args = --no-verify
 asyncio_mode = auto
 markers =
 	testit: "marks test to run during development"
+
+[mypy]
+plugins =
+	pydantic.mypy
diff --git a/services/invitations/src/simcore_service_invitations/_meta.py b/services/invitations/src/simcore_service_invitations/_meta.py
@@ -1,10 +1,12 @@
 """ Application's metadata
 
 """
+
 from typing import Final
 
 from packaging.version import Version
 from servicelib.utils_meta import PackageInfo
+from settings_library.basic_types import VersionTag
 
 info: Final = PackageInfo(package_name="simcore-service-invitations")
 __version__: Final[str] = info.__version__
@@ -13,7 +15,7 @@
 PROJECT_NAME: Final[str] = info.project_name
 VERSION: Final[Version] = info.version
 API_VERSION: Final[str] = info.__version__
-API_VTAG: Final[str] = info.api_prefix_path_tag
+API_VTAG: Final[VersionTag] = VersionTag(info.api_prefix_path_tag)
 SUMMARY: Final[str] = info.get_summary()
 
 
diff --git a/services/invitations/src/simcore_service_invitations/api/_dependencies.py b/services/invitations/src/simcore_service_invitations/api/_dependencies.py
@@ -1,3 +1,4 @@
+# mypy: disable-error-code=truthy-function
 import logging
 import secrets
 
diff --git a/services/invitations/src/simcore_service_invitations/cli.py b/services/invitations/src/simcore_service_invitations/cli.py
@@ -5,7 +5,7 @@
 from cryptography.fernet import Fernet
 from models_library.emails import LowerCaseEmailStr
 from models_library.invitations import InvitationContent, InvitationInputs
-from pydantic import HttpUrl, ValidationError, parse_obj_as
+from pydantic import EmailStr, HttpUrl, ValidationError, parse_obj_as
 from rich.console import Console
 from servicelib.utils_secrets import generate_password
 from settings_library.utils_cli import (
@@ -117,7 +117,7 @@ def invite(
 
     invitation_data = InvitationInputs(
         issuer=issuer,
-        guest=email,
+        guest=parse_obj_as(EmailStr, email),
         trial_account_days=trial_account_days,
         extra_credits_in_usd=None,
         product=product,
diff --git a/services/invitations/src/simcore_service_invitations/core/application.py b/services/invitations/src/simcore_service_invitations/core/application.py
@@ -29,7 +29,7 @@ def create_app(settings: ApplicationSettings | None = None) -> FastAPI:
     override_fastapi_openapi_method(app)
 
     # STATE
-    app.state.settings = settings or ApplicationSettings()
+    app.state.settings = settings or ApplicationSettings()  # type: ignore[call-arg]
     assert app.state.settings.API_VERSION == API_VERSION  # nosec
 
     # PLUGINS SETUP
diff --git a/services/invitations/src/simcore_service_invitations/core/settings.py b/services/invitations/src/simcore_service_invitations/core/settings.py
@@ -1,5 +1,4 @@
 from functools import cached_property
-from typing import cast
 
 from models_library.products import ProductName
 from pydantic import Field, HttpUrl, PositiveInt, SecretStr, validator
@@ -57,8 +56,7 @@ def LOG_LEVEL(self):
     @validator("INVITATIONS_LOGLEVEL")
     @classmethod
     def valid_log_level(cls, value: str) -> str:
-        # NOTE: mypy is not happy without the cast
-        return cast(str, cls.validate_log_level(value))
+        return cls.validate_log_level(value)
 
 
 class MinimalApplicationSettings(_BaseApplicationSettings):
diff --git a/services/osparc-gateway-server/setup.cfg b/services/osparc-gateway-server/setup.cfg
@@ -9,3 +9,7 @@ commit_args = --no-verify
 
 [tool:pytest]
 asyncio_mode = auto
+
+[mypy]
+plugins =
+	pydantic.mypy
diff --git a/services/osparc-gateway-server/src/osparc_gateway_server/app.py b/services/osparc-gateway-server/src/osparc_gateway_server/app.py
@@ -1,6 +1,6 @@
 import sys
 
-from dask_gateway_server.app import main
+from dask_gateway_server.app import main  # type: ignore[import-untyped]
 
 
 def start() -> None:
diff --git a/services/osparc-gateway-server/src/osparc_gateway_server/backend/osparc.py b/services/osparc-gateway-server/src/osparc_gateway_server/backend/osparc.py
@@ -7,8 +7,10 @@
 import osparc_gateway_server
 from aiodocker import Docker
 from aiodocker.exceptions import DockerContainerError
-from dask_gateway_server.backends.base import PublicException
-from dask_gateway_server.backends.db_base import (
+from dask_gateway_server.backends.base import (  # type: ignore[import-untyped]
+    PublicException,
+)
+from dask_gateway_server.backends.db_base import (  # type: ignore[import-untyped]
     Cluster,
     DBBackendBase,
     JobStatus,
@@ -17,8 +19,8 @@
     islice,
     timestamp,
 )
-from osparc_gateway_server.remote_debug import setup_remote_debugging
 
+from ..remote_debug import setup_remote_debugging
 from .errors import NoHostFoundError, NoServiceTasksError, TaskNotAssignedError
 from .settings import AppSettings, BootModeEnum
 from .utils import (
@@ -38,17 +40,15 @@
 #
 # https://patorjk.com/software/taag/#p=display&v=0&f=Avatar&t=osparc-gateway-server
 #
-WELCOME_MSG = r"""
+WELCOME_MSG = rf"""
  ____  ____  ____  ____  ____  ____       ____  ____  ____  _  __      _____ ____  _____  _____ _      ____ ___  _      ____  _____ ____  _     _____ ____
 /  _ \/ ___\/  __\/  _ \/  __\/   _\     /  _ \/  _ \/ ___\/ |/ /     /  __//  _ \/__ __\/  __// \  /|/  _ \\  \//     / ___\/  __//  __\/ \ |\/  __//  __\
 | / \||    \|  \/|| / \||  \/||  / _____ | | \|| / \||    \|   /_____ | |  _| / \|  / \  |  \  | |  ||| / \| \  /_____ |    \|  \  |  \/|| | //|  \  |  \/|
 | \_/|\___ ||  __/| |-|||    /|  \_\____\| |_/|| |-||\___ ||   \\____\| |_//| |-||  | |  |  /_ | |/\||| |-|| / / \____\\___ ||  /_ |    /| \// |  /_ |    /
-\____/\____/\_/   \_/ \|\_/\_\\____/     \____/\_/ \|\____/\_|\_\     \____\\_/ \|  \_/  \____\\_/  \|\_/ \|/_/        \____/\____\\_/\_\\__/  \____\\_/\_\ {}
+\____/\____/\_/   \_/ \|\_/\_\\____/     \____/\_/ \|\____/\_|\_\     \____\\_/ \|  \_/  \____\\_/  \|\_/ \|/_/        \____/\____\\_/\_\\__/  \____\\_/\_\ {version(osparc_gateway_server.package_name)}
 
 
-""".format(
-    version(osparc_gateway_server.package_name)
-)
+"""
 
 
 class OsparcBackend(DBBackendBase):
@@ -63,7 +63,7 @@ class OsparcBackend(DBBackendBase):
     cluster_secrets: list[DockerSecret] = []
 
     async def do_setup(self) -> None:
-        self.settings = AppSettings()
+        self.settings = AppSettings()  # type: ignore[call-arg]
         assert isinstance(self.log, logging.Logger)  # nosec
         self.log.info(
             "osparc-gateway-server application settings:\n%s",
@@ -318,12 +318,11 @@ async def on_cluster_heartbeat(self, cluster_name, msg) -> None:
                     JobStatus.STOPPED if worker.close_expected else JobStatus.FAILED
                 )
                 target_updates.append((worker, {"target": target}))
+            elif worker.status == JobStatus.SUBMITTED:
+                submitted_workers.append(worker)
             else:
-                if worker.status == JobStatus.SUBMITTED:
-                    submitted_workers.append(worker)
-                else:
-                    assert worker.status == JobStatus.CREATED
-                    created_workers.append(worker)
+                assert worker.status == JobStatus.CREATED
+                created_workers.append(worker)
 
         n_pending = len(created_workers) + len(submitted_workers)
         n_to_stop = len(active_workers) + n_pending - count
diff --git a/services/osparc-gateway-server/src/osparc_gateway_server/backend/utils.py b/services/osparc-gateway-server/src/osparc_gateway_server/backend/utils.py
@@ -2,13 +2,17 @@
 import json
 import logging
 from collections import deque
+from collections.abc import AsyncGenerator, Mapping
 from copy import deepcopy
 from pathlib import Path
-from typing import Any, AsyncGenerator, Final, Mapping, NamedTuple, cast
+from typing import Any, Final, NamedTuple, cast
 
 import aiodocker
 from aiodocker import Docker
-from dask_gateway_server.backends.db_base import Cluster, DBBackendBase
+from dask_gateway_server.backends.db_base import (  # type: ignore[import-untyped]
+    Cluster,
+    DBBackendBase,
+)
 from yarl import URL
 
 from .errors import NoHostFoundError
@@ -274,7 +278,7 @@ async def start_service(
         )
         raise
     except asyncio.CancelledError:
-        logger.warn("Service creation was cancelled")
+        logger.warning("Service creation was cancelled")
         raise
 
 
@@ -376,7 +380,7 @@ async def get_next_empty_node_hostname(
     docker_client: Docker, cluster: Cluster
 ) -> Hostname:
     current_count = getattr(get_next_empty_node_hostname, "counter", -1) + 1
-    setattr(get_next_empty_node_hostname, "counter", current_count)
+    setattr(get_next_empty_node_hostname, "counter", current_count)  # noqa: B010
 
     cluster_nodes = deque(await docker_client.nodes.list())
     current_worker_services = await docker_client.services.list(
diff --git a/services/osparc-gateway-server/src/osparc_gateway_server/remote_debug.py b/services/osparc-gateway-server/src/osparc_gateway_server/remote_debug.py
@@ -2,14 +2,15 @@
     https://github.com/microsoft/debugpy
 
 """
+
 import logging
 
 
 def setup_remote_debugging(logger: logging.Logger) -> None:
     try:
         logger.debug("Attaching debugpy ...")
 
-        import debugpy
+        import debugpy  # type: ignore[import-untyped]
 
         REMOTE_DEBUGGING_PORT = 3000
         debugpy.listen(("0.0.0.0", REMOTE_DEBUGGING_PORT))  # nosec

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# mypy: disable-error-code=truthy-function`
`1`	`2`	`import logging`
`2`	`3`	`import secrets`
`3`	`4`