bump-pydantic

Author: giancarloromeo

services/api-server/requirements/_base.txt

@@ -19,10 +19,6 @@ anyio==4.3.0
     #   httpx
 asgi-lifespan==2.1.0
     # via -r requirements/_test.in
-async-timeout==4.0.3
-    # via
-    #   -c requirements/_base.txt
-    #   aiohttp
 attrs==23.2.0
     # via
     #   -c requirements/_base.txt
@@ -91,11 +87,6 @@ ecdsa==0.19.0
     #   moto
     #   python-jose
     #   sshpubkeys
-exceptiongroup==1.2.0
-    # via
-    #   -c requirements/_base.txt
-    #   anyio
-    #   pytest
 faker==27.0.0
     # via -r requirements/_test.in
 flask==2.1.3
@@ -318,11 +309,6 @@ sqlalchemy2-stubs==0.0.2a38
     # via sqlalchemy
 sshpubkeys==3.3.1
     # via moto
-tomli==2.0.1
-    # via
-    #   coverage
-    #   mypy
-    #   pytest
 types-aiofiles==24.1.0.20240626
     # via -r requirements/_test.in
 types-awscrt==0.21.2
@@ -335,7 +321,6 @@ typing-extensions==4.10.0
     # via
     #   -c requirements/_base.txt
     #   alembic
-    #   anyio
     #   boto3-stubs
     #   mypy
     #   sqlalchemy2-stubs

services/api-server/requirements/_test.txt

@@ -91,22 +91,12 @@ setuptools==69.2.0
     #   -c requirements/_base.txt
     #   -c requirements/_test.txt
     #   pip-tools
-tomli==2.0.1
-    # via
-    #   -c requirements/_test.txt
-    #   black
-    #   build
-    #   mypy
-    #   pip-tools
-    #   pylint
 tomlkit==0.13.2
     # via pylint
 typing-extensions==4.10.0
     # via
     #   -c requirements/_base.txt
     #   -c requirements/_test.txt
-    #   astroid
-    #   black
     #   mypy
 virtualenv==20.26.3
     # via pre-commit

services/api-server/requirements/_tools.txt

@@ -1,8 +1,14 @@
 from functools import cached_property
 
 from models_library.basic_types import BootModeEnum, LogLevel
-from pydantic import Field, NonNegativeInt, PositiveInt, SecretStr
-from pydantic.class_validators import validator
+from pydantic import (
+    AliasChoices,
+    Field,
+    NonNegativeInt,
+    PositiveInt,
+    SecretStr,
+    field_validator,
+)
 from settings_library.base import BaseCustomSettings
 from settings_library.catalog import CatalogSettings
 from settings_library.director_v2 import DirectorV2Settings
@@ -24,11 +30,14 @@ class WebServerSettings(WebServerBaseSettings, MixinSessionSettings):
         description="Secret key to encrypt cookies. "
         'TIP: python3 -c "from cryptography.fernet import *; print(Fernet.generate_key())"',
         min_length=44,
-        env=["SESSION_SECRET_KEY", "WEBSERVER_SESSION_SECRET_KEY"],
+        validation_alias=AliasChoices(
+            "SESSION_SECRET_KEY", "WEBSERVER_SESSION_SECRET_KEY"
+        ),
     )
     WEBSERVER_SESSION_NAME: str = DEFAULT_SESSION_COOKIE_NAME
 
-    @validator("WEBSERVER_SESSION_SECRET_KEY")
+    @field_validator("WEBSERVER_SESSION_SECRET_KEY")
+    @classmethod
     @classmethod
     def check_valid_fernet_key(cls, v):
         return cls.do_check_valid_fernet_key(v)
@@ -41,21 +50,25 @@ class BasicSettings(BaseCustomSettings, MixinLoggingSettings):
     # DEVELOPMENT
     API_SERVER_DEV_FEATURES_ENABLED: bool = Field(
         default=False,
-        env=["API_SERVER_DEV_FEATURES_ENABLED", "FAKE_API_SERVER_ENABLED"],
+        validation_alias=AliasChoices(
+            "API_SERVER_DEV_FEATURES_ENABLED", "FAKE_API_SERVER_ENABLED"
+        ),
     )
 
     # LOGGING
     LOG_LEVEL: LogLevel = Field(
         default=LogLevel.INFO.value,
-        env=["API_SERVER_LOGLEVEL", "LOG_LEVEL", "LOGLEVEL"],
+        validation_alias=AliasChoices("API_SERVER_LOGLEVEL", "LOG_LEVEL", "LOGLEVEL"),
     )
     API_SERVER_LOG_FORMAT_LOCAL_DEV_ENABLED: bool = Field(
         default=False,
-        env=["API_SERVER_LOG_FORMAT_LOCAL_DEV_ENABLED", "LOG_FORMAT_LOCAL_DEV_ENABLED"],
+        validation_alias=AliasChoices(
+            "API_SERVER_LOG_FORMAT_LOCAL_DEV_ENABLED", "LOG_FORMAT_LOCAL_DEV_ENABLED"
+        ),
         description="Enables local development log format. WARNING: make sure it is disabled if you want to have structured logs!",
     )
 
-    @validator("LOG_LEVEL", pre=True)
+    @field_validator("LOG_LEVEL", mode="before")
     @classmethod
     def _validate_loglevel(cls, value) -> str:
         log_level: str = cls.validate_log_level(value)

services/api-server/src/simcore_service_api_server/core/settings.py

@@ -2,7 +2,7 @@
 import urllib.parse
 from typing import Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 from pydantic.types import ConstrainedStr
 
 # RESOURCE NAMES https://cloud.google.com/apis/design/resource_names
@@ -32,9 +32,7 @@
 
 class RelativeResourceName(ConstrainedStr):
     regex = re.compile(_RELATIVE_RESOURCE_NAME_RE)
-
-    class Config:
-        frozen = True
+    model_config = ConfigDict(frozen=True)
 
 
 # NOTE: we quote parts in a single resource_name and unquote when split
@@ -67,10 +65,12 @@ def split_resource_name(resource_name: RelativeResourceName) -> list[str]:
 # Resource IDs must be clearly documented whether they are assigned by the client, the server, or either
 #
 class BaseResource(BaseModel):
-    name: RelativeResourceName = Field(None, example="solvers/isolve/releases/1.2.3")
-    id: Any = Field(None, description="Resource ID", example="1.2.3")  # noqa: A003
+    name: RelativeResourceName = Field(None, examples=["solvers/isolve/releases/1.2.3"])
+    id: Any = Field(None, description="Resource ID", examples=["1.2.3"])  # noqa: A003
 
 
 class BaseCollection(BaseModel):
-    name: RelativeResourceName = Field(None, example="solvers/isolve/releases")
-    id: Any = Field(None, description="Collection ID", example="releases")  # noqa: A003
+    name: RelativeResourceName = Field(None, examples=["solvers/isolve/releases"])
+    id: Any = Field(
+        None, description="Collection ID", examples=["releases"]
+    )  # noqa: A003

services/api-server/src/simcore_service_api_server/models/api_resources.py

@@ -7,7 +7,7 @@
 """
 
 from collections.abc import Sequence
-from typing import Any, ClassVar, Generic, TypeAlias, TypeVar
+from typing import Generic, TypeAlias, TypeVar
 
 from fastapi_pagination.limit_offset import LimitOffsetParams
 from fastapi_pagination.links.limit_offset import (
@@ -18,8 +18,7 @@
     MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE,
 )
 from models_library.utils.pydantic_tools_extension import FieldNotRequired
-from pydantic import Field, NonNegativeInt, validator
-from pydantic.generics import GenericModel
+from pydantic import BaseModel, ConfigDict, Field, NonNegativeInt
 
 T = TypeVar("T")
 
@@ -35,7 +34,7 @@
 PaginationParams: TypeAlias = LimitOffsetParams
 
 
-class OnePage(GenericModel, Generic[T]):
+class OnePage(BaseModel, Generic[T]):
     """
     A single page is used to envelope a small sequence that does not require
     pagination
@@ -47,7 +46,7 @@ class OnePage(GenericModel, Generic[T]):
     items: Sequence[T]
     total: NonNegativeInt = FieldNotRequired()
 
-    @validator("total", pre=True)
+    @field_validator("total", mode="before")
     @classmethod
     def check_total(cls, v, values):
         items = values["items"]
@@ -60,9 +59,9 @@ def check_total(cls, v, values):
 
         return v
 
-    class Config:
-        frozen = True
-        schema_extra: ClassVar[dict[str, Any]] = {
+    model_config = ConfigDict(
+        frozen=True,
+        json_schema_extra={
             "examples": [
                 {
                     "total": 1,
@@ -72,7 +71,8 @@ class Config:
                     "items": ["one"],
                 },
             ],
-        }
+        },
+    )
 
 
 __all__: tuple[str, ...] = (

services/api-server/src/simcore_service_api_server/models/pagination.py

@@ -1,6 +1,6 @@
-from typing import Any, ClassVar
+from typing import Any
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 
 class ErrorGet(BaseModel):
@@ -11,12 +11,13 @@ class ErrorGet(BaseModel):
     #   - https://github.com/ITISFoundation/osparc-simcore/issues/2446
     errors: list[Any]
 
-    class Config:
-        schema_extra: ClassVar[dict[str, Any]] = {
+    model_config = ConfigDict(
+        json_schema_extra={
             "example": {
                 "errors": [
                     "some error message",
                     "another error message",
                 ]
             }
         }
+    )

services/api-server/src/simcore_service_api_server/models/schemas/errors.py

@@ -1,6 +1,6 @@
 from mimetypes import guess_type
 from pathlib import Path
-from typing import Any, ClassVar
+from typing import Annotated
 from urllib.parse import quote as _quote
 from urllib.parse import unquote as _unquote
 from uuid import UUID, uuid3
@@ -14,18 +14,18 @@
     AnyUrl,
     BaseModel,
     ByteSize,
-    ConstrainedStr,
+    ConfigDict,
     Field,
+    StringConstraints,
+    field_validator,
     parse_obj_as,
-    validator,
 )
 from servicelib.file_utils import create_sha256_checksum
 
 _NAMESPACE_FILEID_KEY = UUID("aa154444-d22d-4290-bb15-df37dba87865")
 
 
-class FileName(ConstrainedStr):
-    strip_whitespace = True
+FileName = Annotated[str, StringConstraints(strip_whitespace=True)]
 
 
 class ClientFile(BaseModel):
@@ -46,7 +46,9 @@ class File(BaseModel):
 
     filename: str = Field(..., description="Name of the file with extension")
     content_type: str | None = Field(
-        default=None, description="Guess of type content [EXPERIMENTAL]"
+        default=None,
+        description="Guess of type content [EXPERIMENTAL]",
+        validate_default=True,
     )
     sha256_checksum: SHA256Str | None = Field(
         default=None,
@@ -55,9 +57,9 @@ class File(BaseModel):
     )
     e_tag: ETag | None = Field(default=None, description="S3 entity tag")
 
-    class Config:
-        allow_population_by_field_name = True
-        schema_extra: ClassVar[dict[str, Any]] = {
+    model_config = ConfigDict(
+        populate_by_name=True,
+        json_schema_extra={
             "examples": [
                 # complete
                 {
@@ -72,9 +74,10 @@ class Config:
                     "filename": "whitepaper.pdf",
                 },
             ]
-        }
+        },
+    )
 
-    @validator("content_type", always=True, pre=True)
+    @field_validator("content_type", mode="before")
     @classmethod
     def guess_content_type(cls, v, values):
         if v is None: