refactor with common Adapter pattern

Author: Andrei Neagu

packages/models-library/src/models_library/api_schemas_dynamic_sidecar/containers.py

@@ -1,6 +1,6 @@
-from typing import TypeAlias
+from typing import Final, TypeAlias
 
-from pydantic import BaseModel, ConfigDict, NonNegativeFloat
+from pydantic import BaseModel, ConfigDict, NonNegativeFloat, TypeAdapter
 
 
 class ActivityInfo(BaseModel):
@@ -15,4 +15,7 @@ class ActivityInfo(BaseModel):
     )
 
 
+ActivityInfoAdapter: Final[TypeAdapter[ActivityInfo]] = TypeAdapter(ActivityInfo)
+
+
 ActivityInfoOrNone: TypeAlias = ActivityInfo | None

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

@@ -7,7 +7,7 @@
 """
 
 from pathlib import Path
-from typing import Annotated, TypeAlias
+from typing import Annotated, Final, TypeAlias
 from uuid import UUID
 
 from common_library.pydantic_basic_types import ConstrainedStr
@@ -44,7 +44,9 @@
 SimcoreS3FileID: TypeAlias = Annotated[
     str, StringConstraints(pattern=SIMCORE_S3_FILE_ID_RE)
 ]
-SimcoreS3FileIDTypeAdapter = TypeAdapter(SimcoreS3FileID)
+SimcoreS3FileIDTypeAdapter: Final[TypeAdapter[SimcoreS3FileID]] = TypeAdapter(
+    SimcoreS3FileID
+)
 
 
 class SimcoreS3DirectoryID(ConstrainedStr):

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

@@ -1,13 +1,13 @@
-from typing import Any
+from typing import Any, Final
 
 from pydantic import BaseModel, ConfigDict, TypeAdapter
 
 from .services_resources import ServiceResourcesDict
 from .services_types import (
     ServiceKey,
-    ServiceKeyTypeAdapter,
+    ServiceKeyAdapter,
     ServiceVersion,
-    ServiceVersionTypeAdapter,
+    ServiceVersionAdapter,
 )
 from .wallets import WalletID
 
@@ -41,10 +41,10 @@ class CreateServiceMetricsAdditionalParams(BaseModel):
                 "user_email": "[email protected]",
                 "project_name": "_!New Study",
                 "node_name": "the service of a lifetime _ *!",
-                "service_key": ServiceKeyTypeAdapter.validate_python(
+                "service_key": ServiceKeyAdapter.validate_python(
                     "simcore/services/dynamic/test"
                 ),
-                "service_version": ServiceVersionTypeAdapter.validate_python("0.0.1"),
+                "service_version": ServiceVersionAdapter.validate_python("0.0.1"),
                 "service_resources": {},
                 "service_additional_metadata": {},
                 "pricing_unit_cost_id": None,
@@ -53,6 +53,6 @@ class CreateServiceMetricsAdditionalParams(BaseModel):
     )
 
 
-CreateServiceMetricsAdditionalParamsTypeAdapter = TypeAdapter(
-    CreateServiceMetricsAdditionalParams
-)
+CreateServiceMetricsAdditionalParamsAdapter: Final[
+    TypeAdapter[CreateServiceMetricsAdditionalParams]
+] = TypeAdapter(CreateServiceMetricsAdditionalParams)

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

@@ -1,4 +1,4 @@
-from typing import Annotated, Any, TypeAlias
+from typing import Annotated, Any, Final, TypeAlias
 
 from pydantic import (
     BaseModel,
@@ -260,4 +260,4 @@ def from_json_schema(cls, port_schema: dict[str, Any]) -> "ServiceOutput":
         return cls.model_validate(data)
 
 
-ServiceOutputTypeAdapter = TypeAdapter(ServiceOutput)
+ServiceOutputAdapter: Final[TypeAdapter[ServiceOutput]] = TypeAdapter(ServiceOutput)

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

@@ -1,4 +1,4 @@
-from typing import Annotated, TypeAlias
+from typing import Annotated, Final, TypeAlias
 from uuid import uuid4
 
 import arrow
@@ -18,7 +18,7 @@
 FileName: TypeAlias = Annotated[str, StringConstraints(pattern=FILENAME_RE)]
 
 ServiceKey: TypeAlias = Annotated[str, StringConstraints(pattern=SERVICE_KEY_RE)]
-ServiceKeyTypeAdapter = TypeAdapter(ServiceKey)
+ServiceKeyAdapter: Final[TypeAdapter[ServiceKey]] = TypeAdapter(ServiceKey)
 
 ServiceKeyEncoded: TypeAlias = Annotated[
     str, StringConstraints(pattern=SERVICE_ENCODED_KEY_RE)
@@ -33,7 +33,7 @@
 ]
 
 ServiceVersion: TypeAlias = Annotated[str, StringConstraints(pattern=SIMPLE_VERSION_RE)]
-ServiceVersionTypeAdapter = TypeAdapter(ServiceVersion)
+ServiceVersionAdapter: Final[TypeAdapter[ServiceVersion]] = TypeAdapter(ServiceVersion)
 
 
 class RunID(str):

services/director-v2/tests/unit/test_modules_dynamic_sidecar_client_api_thin.py

@@ -11,7 +11,7 @@
 from httpx import Response
 from models_library.services_creation import (
     CreateServiceMetricsAdditionalParams,
-    CreateServiceMetricsAdditionalParamsTypeAdapter,
+    CreateServiceMetricsAdditionalParamsAdapter,
 )
 from models_library.sidecar_volumes import VolumeCategory, VolumeStatus
 from pydantic import AnyHttpUrl, parse_obj_as
@@ -285,7 +285,7 @@ async def test_put_volumes(
             "post_containers_tasks",
             "/containers",
             {
-                "metrics_params": CreateServiceMetricsAdditionalParamsTypeAdapter.validate_python(
+                "metrics_params": CreateServiceMetricsAdditionalParamsAdapter.validate_python(
                     CreateServiceMetricsAdditionalParams.model_config[
                         "json_schema_extra"
                     ]["example"],

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/containers.py

@@ -10,9 +10,10 @@
 from fastapi import Query, Request, status
 from models_library.api_schemas_dynamic_sidecar.containers import (
     ActivityInfo,
+    ActivityInfoAdapter,
     ActivityInfoOrNone,
 )
-from pydantic import TypeAdapter, ValidationError
+from pydantic import ValidationError
 from servicelib.fastapi.requests_decorators import cancel_on_disconnect
 
 from ..core.docker_utils import docker_client
@@ -174,7 +175,7 @@ async def get_containers_activity(
         return ActivityInfo(seconds_inactive=_INACTIVE_FOR_LONG_TIME)
 
     try:
-        return TypeAdapter(ActivityInfo).validate_json(inactivity_response)
+        return ActivityInfoAdapter.validate_json(inactivity_response)
     except ValidationError:
         _logger.warning(
             "Could not parse command result '%s' as '%s'",

services/dynamic-sidecar/tests/conftest.py

@@ -20,7 +20,7 @@
 from models_library.services import RunID
 from models_library.services_creation import (
     CreateServiceMetricsAdditionalParams,
-    CreateServiceMetricsAdditionalParamsTypeAdapter,
+    CreateServiceMetricsAdditionalParamsAdapter,
 )
 from models_library.users import UserID
 from models_library.utils.json_serialization import json_dumps
@@ -333,7 +333,7 @@ def mock_stop_heart_beat_task(mocker: MockerFixture) -> AsyncMock:
 
 @pytest.fixture
 def mock_metrics_params(faker: Faker) -> CreateServiceMetricsAdditionalParams:
-    return CreateServiceMetricsAdditionalParamsTypeAdapter.validate_python(
+    return CreateServiceMetricsAdditionalParamsAdapter.validate_python(
         CreateServiceMetricsAdditionalParams.model_config["json_schema_extra"][
             "example"
         ],

services/dynamic-sidecar/tests/unit/test_api_containers.py

@@ -24,7 +24,7 @@
 from fastapi import FastAPI, status
 from models_library.api_schemas_dynamic_sidecar.containers import ActivityInfo
 from models_library.services_creation import CreateServiceMetricsAdditionalParams
-from models_library.services_io import ServiceOutput, ServiceOutputTypeAdapter
+from models_library.services_io import ServiceOutput, ServiceOutputAdapter
 from pytest_mock.plugin import MockerFixture
 from pytest_simcore.helpers.monkeypatch_envs import EnvVarsDict, setenvs_from_dict
 from servicelib.docker_constants import SUFFIX_EGRESS_PROXY_NAME
@@ -266,10 +266,10 @@ def not_started_containers() -> list[str]:
 @pytest.fixture
 def mock_outputs_labels() -> dict[str, ServiceOutput]:
     return {
-        "output_port_1": ServiceOutputTypeAdapter.validate_python(
+        "output_port_1": ServiceOutputAdapter.validate_python(
             ServiceOutput.model_config["json_schema_extra"]["examples"][3]
         ),
-        "output_port_2": ServiceOutputTypeAdapter.validate_python(
+        "output_port_2": ServiceOutputAdapter.validate_python(
             ServiceOutput.model_config["json_schema_extra"]["examples"][3]
         ),
     }