🎨 Refactor models to use Annotated for field definitions across various schemas

Author: pcrespov

packages/aws-library/src/aws_library/s3/_models.py

@@ -1,6 +1,6 @@
 import datetime
 from pathlib import Path
-from typing import TypeAlias, cast
+from typing import Annotated, TypeAlias, cast
 
 from models_library.api_schemas_storage.storage_schemas import ETag
 from models_library.basic_types import SHA256Str
@@ -54,9 +54,10 @@ def as_path(self) -> Path:
 
 class S3DirectoryMetaData(BaseModel, frozen=True):
     prefix: S3ObjectPrefix
-    size: ByteSize | None = Field(
-        ..., description="Size of the directory if computed, None if unknown"
-    )
+    size: Annotated[
+        ByteSize | None,
+        Field(description="Size of the directory if computed, None if unknown"),
+    ]
 
     def as_path(self) -> Path:
         return self.prefix

packages/common-library/tests/test_pydantic_fields_extension.py

@@ -1,13 +1,14 @@
-from typing import Any, Callable, Literal
+from collections.abc import Callable
+from typing import Any, Literal
 
 import pytest
 from common_library.pydantic_fields_extension import get_type, is_literal, is_nullable
-from pydantic import BaseModel, Field
+from pydantic import BaseModel
 
 
 class MyModel(BaseModel):
     a: int
-    b: float | None = Field(...)
+    b: float | None
     c: str = "bla"
     d: bool | None = None
     e: Literal["bla"]

packages/common-library/tests/test_pydantic_validators.py

@@ -7,7 +7,7 @@
     validate_numeric_string_as_timedelta,
 )
 from faker import Faker
-from pydantic import BeforeValidator, Field
+from pydantic import BeforeValidator
 from pydantic_settings import BaseSettings, SettingsConfigDict
 from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
 
@@ -17,7 +17,7 @@ class Settings(BaseSettings):
         APP_NAME: str
         REQUEST_TIMEOUT: Annotated[
             timedelta, BeforeValidator(_validate_legacy_timedelta_str)
-        ] = Field(default=timedelta(hours=1))
+        ] = timedelta(hours=1)
 
         model_config = SettingsConfigDict()
 
@@ -45,7 +45,7 @@ def test_validate_timedelta_in_legacy_mode(
 ):
     class Settings(BaseSettings):
         APP_NAME: str
-        REQUEST_TIMEOUT: timedelta = Field(default=timedelta(seconds=40))
+        REQUEST_TIMEOUT: timedelta = timedelta(seconds=40)
 
         _validate_request_timeout = validate_numeric_string_as_timedelta(
             "REQUEST_TIMEOUT"

packages/models-library/src/models_library/api_schemas__common/errors.py

@@ -1,18 +1,16 @@
 import http
-from typing import Any
+from typing import Annotated, Any
 
 from pydantic import BaseModel, Field
 
 from ..basic_types import IDStr
 
 
 class DefaultApiError(BaseModel):
-    name: IDStr = Field(
-        ...,
-        description="Error identifier as a code or a name. "
-        "Mainly for machine-machine communication purposes.",
+    name: Annotated[IDStr, Field(description="Exception's class name")]
+    detail: Annotated[Any | None, Field(description="Human readable error message")] = (
+        None
     )
-    detail: Any | None = Field(default=None, description="Human readable error message")
 
     @classmethod
     def from_status_code(

packages/models-library/src/models_library/api_schemas__common/meta.py

@@ -1,3 +1,5 @@
+from typing import Annotated
+
 from pydantic import BaseModel, ConfigDict, Field
 
 from ..basic_types import VersionStr
@@ -6,9 +8,10 @@
 class BaseMeta(BaseModel):
     name: str
     version: VersionStr
-    released: dict[str, VersionStr] | None = Field(
-        default=None, description="Maps every route's path tag with a released version"
-    )
+    released: Annotated[
+        dict[str, VersionStr] | None,
+        Field(description="Maps every route's path tag with a released version"),
+    ] = None
 
     model_config = ConfigDict(
         json_schema_extra={

packages/models-library/src/models_library/api_schemas_api_server/api_keys.py

@@ -1,3 +1,5 @@
+from typing import Annotated
+
 from pydantic import BaseModel, ConfigDict, Field, SecretStr
 
 
@@ -10,7 +12,7 @@ class ApiKeyInDB(BaseModel):
     api_key: str
     api_secret: str
 
-    id_: int = Field(0, alias="id")
+    id_: Annotated[int, Field(alias="id")] = 0
     display_name: str
     user_id: int
     product_name: str

packages/models-library/src/models_library/api_schemas_catalog/services_specifications.py

@@ -1,18 +1,23 @@
+from typing import Annotated
+
 from pydantic import BaseModel, Field
 
 from ..generated_models.docker_rest_api import ServiceSpec as DockerServiceSpec
 
 
 class ServiceSpecifications(BaseModel):
-    sidecar: DockerServiceSpec | None = Field(
-        default=None,
-        description="schedule-time specifications for the service sidecar (follows Docker Service creation API, see https://docs.docker.com/engine/api/v1.25/#operation/ServiceCreate)",
-    )
-    service: DockerServiceSpec | None = Field(
-        default=None,
-        description="schedule-time specifications specifications for the service (follows Docker Service creation API (specifically only the Resources part), see https://docs.docker.com/engine/api/v1.41/#tag/Service/operation/ServiceCreate",
-    )
+    sidecar: Annotated[
+        DockerServiceSpec | None,
+        Field(
+            description="schedule-time specifications for the service sidecar (follows Docker Service creation API, see https://docs.docker.com/engine/api/v1.25/#operation/ServiceCreate)",
+        ),
+    ] = None
+    service: Annotated[
+        DockerServiceSpec | None,
+        Field(
+            description="schedule-time specifications specifications for the service (follows Docker Service creation API (specifically only the Resources part), see https://docs.docker.com/engine/api/v1.41/#tag/Service/operation/ServiceCreate",
+        ),
+    ] = None
 
 
-class ServiceSpecificationsGet(ServiceSpecifications):
-    ...
+class ServiceSpecificationsGet(ServiceSpecifications): ...

packages/models-library/src/models_library/api_schemas_clusters_keeper/clusters.py

@@ -1,5 +1,6 @@
 import datetime
 from enum import auto
+from typing import Annotated
 
 from pydantic import AnyUrl, BaseModel, Field
 
@@ -17,7 +18,7 @@ class ClusterState(StrAutoEnum):
 
 class OnDemandCluster(BaseModel):
     endpoint: AnyUrl
-    authentication: ClusterAuthentication = Field(discriminator="type")
+    authentication: Annotated[ClusterAuthentication, Field(discriminator="type")]
     state: ClusterState
     user_id: UserID
     wallet_id: WalletID | None