run bump-pydantic

Author: giancarloromeo

services/web/server/src/simcore_service_webserver/announcements/_models.py

@@ -1,8 +1,8 @@
 from datetime import datetime
-from typing import Any, ClassVar, Literal
+from typing import Literal
 
 import arrow
-from pydantic import BaseModel, validator
+from pydantic import BaseModel, ConfigDict, ValidationInfo, field_validator
 
 
 # NOTE: this model is used for BOTH
@@ -18,10 +18,10 @@ class Announcement(BaseModel):
     link: str
     widgets: list[Literal["login", "ribbon", "user-menu"]]
 
-    @validator("end")
+    @field_validator("end")
     @classmethod
-    def check_start_before_end(cls, v, values):
-        if start := values.get("start"):
+    def check_start_before_end(cls, v, info: ValidationInfo):
+        if start := info.data.get("start"):
             end = v
             if end <= start:
                 msg = f"end={end!r} is not before start={start!r}"
@@ -31,8 +31,8 @@ def check_start_before_end(cls, v, values):
     def expired(self) -> bool:
         return self.end <= arrow.utcnow().datetime
 
-    class Config:
-        schema_extra: ClassVar[dict[str, Any]] = {
+    model_config = ConfigDict(
+        json_schema_extra={
             "examples": [
                 {
                     "id": "Student_Competition_2023",
@@ -56,3 +56,4 @@ class Config:
                 },
             ]
         }
+    )

services/web/server/src/simcore_service_webserver/application_settings.py

@@ -3,6 +3,7 @@
 from typing import Any, Final
 
 from aiohttp import web
+from common_library.pydantic_fields_extension import is_nullable
 from models_library.basic_types import (
     BootModeEnum,
     BuildTargetEnum,
@@ -11,8 +12,15 @@
     VersionTag,
 )
 from models_library.utils.change_case import snake_to_camel
-from pydantic import AnyHttpUrl, parse_obj_as, root_validator, validator
-from pydantic.fields import Field, ModelField
+from pydantic import (
+    AliasChoices,
+    AnyHttpUrl,
+    TypeAdapter,
+    ValidationInfo,
+    field_validator,
+    model_validator,
+)
+from pydantic.fields import Field
 from pydantic.types import PositiveInt
 from settings_library.base import BaseCustomSettings
 from settings_library.email import SMTPSettings
@@ -53,7 +61,7 @@ class ApplicationSettings(BaseCustomSettings, MixinLoggingSettings):
     # CODE STATICS ---------------------------------------------------------
     API_VERSION: str = API_VERSION
     APP_NAME: str = APP_NAME
-    API_VTAG: VersionTag = parse_obj_as(VersionTag, API_VTAG)
+    API_VTAG: VersionTag = TypeAdapter(VersionTag).validate_python(API_VTAG)
 
     # IMAGE BUILDTIME ------------------------------------------------------
     # @Makefile
@@ -83,13 +91,13 @@ class ApplicationSettings(BaseCustomSettings, MixinLoggingSettings):
     SIMCORE_VCS_RELEASE_TAG: str | None = Field(
         default=None,
         description="Name of the tag that marks this release, or None if undefined",
-        example="ResistanceIsFutile10",
+        examples=["ResistanceIsFutile10"],
     )
 
     SIMCORE_VCS_RELEASE_URL: AnyHttpUrl | None = Field(
         default=None,
         description="URL to release notes",
-        example="https://github.com/ITISFoundation/osparc-simcore/releases/tag/staging_ResistanceIsFutile10",
+        examples=["https://github.com/ITISFoundation/osparc-simcore/releases/tag/staging_ResistanceIsFutile10"],
     )
 
     SWARM_STACK_NAME: str | None = Field(
@@ -105,13 +113,14 @@ class ApplicationSettings(BaseCustomSettings, MixinLoggingSettings):
     )
     WEBSERVER_LOGLEVEL: LogLevel = Field(
         default=LogLevel.WARNING.value,
-        env=["WEBSERVER_LOGLEVEL", "LOG_LEVEL", "LOGLEVEL"],
+        validation_alias=AliasChoices("WEBSERVER_LOGLEVEL", "LOG_LEVEL", "LOGLEVEL"),
         # NOTE: suffix '_LOGLEVEL' is used overall
     )
-
     WEBSERVER_LOG_FORMAT_LOCAL_DEV_ENABLED: bool = Field(
         default=False,
-        env=["WEBSERVER_LOG_FORMAT_LOCAL_DEV_ENABLED", "LOG_FORMAT_LOCAL_DEV_ENABLED"],
+        validation_alias=AliasChoices(
+            "WEBSERVER_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!",
     )
     # TODO: find a better name!?
@@ -120,100 +129,117 @@ class ApplicationSettings(BaseCustomSettings, MixinLoggingSettings):
         description="host name to serve within the container."
         "NOTE that this different from WEBSERVER_HOST env which is the host seen outside the container",
     )
-    WEBSERVER_HOST: str | None = Field(None, env=["WEBSERVER_HOST", "HOST", "HOSTNAME"])
-    WEBSERVER_PORT: PortInt = parse_obj_as(PortInt, DEFAULT_AIOHTTP_PORT)
+    WEBSERVER_HOST: str | None = Field(
+        None, validation_alias=AliasChoices("WEBSERVER_HOST", "HOST", "HOSTNAME")
+    )
+    WEBSERVER_PORT: PortInt = TypeAdapter(PortInt).validate_python(DEFAULT_AIOHTTP_PORT)
 
     WEBSERVER_FRONTEND: FrontEndAppSettings | None = Field(
-        auto_default_from_env=True, description="front-end static settings"
+        json_schema_extra={"auto_default_from_env": True},
+        description="front-end static settings",
     )
 
     # PLUGINS ----------------
 
     WEBSERVER_ACTIVITY: PrometheusSettings | None = Field(
-        auto_default_from_env=True,
+        json_schema_extra={"auto_default_from_env": True},
         description="activity plugin",
     )
     WEBSERVER_CATALOG: CatalogSettings | None = Field(
-        auto_default_from_env=True, description="catalog service client's plugin"
+        json_schema_extra={"auto_default_from_env": True},
+        description="catalog service client's plugin",
     )
     # TODO: Shall be required
     WEBSERVER_DB: PostgresSettings | None = Field(
-        auto_default_from_env=True, description="database plugin"
+        json_schema_extra={"auto_default_from_env": True}, description="database plugin"
     )
     WEBSERVER_DIAGNOSTICS: DiagnosticsSettings | None = Field(
-        auto_default_from_env=True, description="diagnostics plugin"
+        json_schema_extra={"auto_default_from_env": True},
+        description="diagnostics plugin",
     )
     WEBSERVER_DIRECTOR_V2: DirectorV2Settings | None = Field(
-        auto_default_from_env=True, description="director-v2 service client's plugin"
+        json_schema_extra={"auto_default_from_env": True},
+        description="director-v2 service client's plugin",
     )
     WEBSERVER_EMAIL: SMTPSettings | None = Field(
-        auto_default_from_env=True, description="email plugin"
+        json_schema_extra={"auto_default_from_env": True}, description="email plugin"
     )
     WEBSERVER_EXPORTER: ExporterSettings | None = Field(
-        auto_default_from_env=True, description="exporter plugin"
+        json_schema_extra={"auto_default_from_env": True}, description="exporter plugin"
     )
     WEBSERVER_GARBAGE_COLLECTOR: GarbageCollectorSettings | None = Field(
-        auto_default_from_env=True, description="garbage collector plugin"
+        json_schema_extra={"auto_default_from_env": True},
+        description="garbage collector plugin",
     )
 
     WEBSERVER_INVITATIONS: InvitationsSettings | None = Field(
-        auto_default_from_env=True, description="invitations plugin"
+        json_schema_extra={"auto_default_from_env": True},
+        description="invitations plugin",
     )
 
     WEBSERVER_LOGIN: LoginSettings | None = Field(
-        auto_default_from_env=True, description="login plugin"
+        json_schema_extra={"auto_default_from_env": True}, description="login plugin"
     )
 
     WEBSERVER_PAYMENTS: PaymentsSettings | None = Field(
-        auto_default_from_env=True, description="payments plugin settings"
+        json_schema_extra={"auto_default_from_env": True},
+        description="payments plugin settings",
     )
 
     WEBSERVER_DYNAMIC_SCHEDULER: DynamicSchedulerSettings | None = Field(
-        auto_default_from_env=True, description="dynamic-scheduler plugin settings"
+        description="dynamic-scheduler plugin settings",
+        json_schema_extra={"auto_default_from_env": True},
     )
 
-    WEBSERVER_REDIS: RedisSettings | None = Field(auto_default_from_env=True)
+    WEBSERVER_REDIS: RedisSettings | None = Field(
+        json_schema_extra={"auto_default_from_env": True}
+    )
 
     WEBSERVER_REST: RestSettings | None = Field(
-        auto_default_from_env=True, description="rest api plugin"
+        description="rest api plugin", json_schema_extra={"auto_default_from_env": True}
     )
 
     WEBSERVER_RESOURCE_MANAGER: ResourceManagerSettings = Field(
-        auto_default_from_env=True, description="resource_manager plugin"
+        description="resource_manager plugin",
+        json_schema_extra={"auto_default_from_env": True},
     )
     WEBSERVER_RESOURCE_USAGE_TRACKER: ResourceUsageTrackerSettings | None = Field(
-        auto_default_from_env=True,
         description="resource usage tracker service client's plugin",
+        json_schema_extra={"auto_default_from_env": True},
     )
     WEBSERVER_SCICRUNCH: SciCrunchSettings | None = Field(
-        auto_default_from_env=True, description="scicrunch plugin"
+        description="scicrunch plugin",
+        json_schema_extra={"auto_default_from_env": True},
     )
     WEBSERVER_SESSION: SessionSettings = Field(
-        auto_default_from_env=True, description="session plugin"
+        description="session plugin", json_schema_extra={"auto_default_from_env": True}
     )
 
     WEBSERVER_STATICWEB: StaticWebserverModuleSettings | None = Field(
-        auto_default_from_env=True, description="static-webserver service plugin"
+        description="static-webserver service plugin",
+        json_schema_extra={"auto_default_from_env": True},
     )
     WEBSERVER_STORAGE: StorageSettings | None = Field(
-        auto_default_from_env=True, description="storage service client's plugin"
+        description="storage service client's plugin",
+        json_schema_extra={"auto_default_from_env": True},
     )
     WEBSERVER_STUDIES_DISPATCHER: StudiesDispatcherSettings | None = Field(
-        auto_default_from_env=True, description="studies dispatcher plugin"
+        description="studies dispatcher plugin",
+        json_schema_extra={"auto_default_from_env": True},
     )
 
     WEBSERVER_TRACING: TracingSettings | None = Field(
-        auto_default_from_env=True, description="tracing plugin"
+        description="tracing plugin", json_schema_extra={"auto_default_from_env": True}
     )
 
     WEBSERVER_PROJECTS: ProjectsSettings | None = Field(
-        auto_default_from_env=True, description="projects plugin"
+        description="projects plugin", json_schema_extra={"auto_default_from_env": True}
     )
     WEBSERVER_RABBITMQ: RabbitSettings | None = Field(
-        auto_default_from_env=True, description="rabbitmq plugin"
+        description="rabbitmq plugin", json_schema_extra={"auto_default_from_env": True}
     )
     WEBSERVER_USERS: UsersSettings | None = Field(
-        auto_default_from_env=True, description="users plugin"
+        description="users plugin", json_schema_extra={"auto_default_from_env": True}
     )
 
     # These plugins only require (for the moment) an entry to toggle between enabled/disabled
@@ -242,7 +268,7 @@ class ApplicationSettings(BaseCustomSettings, MixinLoggingSettings):
         "Currently this is a system plugin and cannot be disabled",
     )
 
-    @root_validator()
+    @model_validator(mode="after")
     @classmethod
     def build_vcs_release_url_if_unset(cls, values):
         release_url = values.get("SIMCORE_VCS_RELEASE_URL")
@@ -260,39 +286,43 @@ def build_vcs_release_url_if_unset(cls, values):
 
         return values
 
-    @validator(
+    @field_validator(
         # List of plugins under-development (keep up-to-date)
         # TODO: consider mark as dev-feature in field extras of Config attr.
         # Then they can be automtically advertised
         "WEBSERVER_META_MODELING",
         "WEBSERVER_VERSION_CONTROL",
-        pre=True,
-        always=True,
+        mode="before",
     )
     @classmethod
-    def enable_only_if_dev_features_allowed(cls, v, values, field: ModelField):
+    def enable_only_if_dev_features_allowed(cls, v, info: ValidationInfo):
         """Ensures that plugins 'under development' get programatically
         disabled if WEBSERVER_DEV_FEATURES_ENABLED=False
         """
-        if values["WEBSERVER_DEV_FEATURES_ENABLED"]:
+        if info.data["WEBSERVER_DEV_FEATURES_ENABLED"]:
             return v
         if v:
             _logger.warning(
-                "%s still under development and will be disabled.", field.name
+                "%s still under development and will be disabled.", info.field_name
             )
-        return None if field.allow_none else False
+
+        return (
+            None
+            if info.field_name and is_nullable(cls.model_fields[info.field_name])
+            else False
+        )
 
     @cached_property
     def log_level(self) -> int:
         level: int = getattr(logging, self.WEBSERVER_LOGLEVEL.upper())
         return level
 
-    @validator("WEBSERVER_LOGLEVEL", pre=True)
+    @field_validator("WEBSERVER_LOGLEVEL")
     @classmethod
-    def valid_log_level(cls, value: str) -> str:
+    def valid_log_level(cls, value):
         return cls.validate_log_level(value)
 
-    @validator("SC_HEALTHCHECK_TIMEOUT", pre=True)
+    @field_validator("SC_HEALTHCHECK_TIMEOUT", mode="before")
     @classmethod
     def get_healthcheck_timeout_in_seconds(cls, v):
         # Ex. HEALTHCHECK --interval=5m --timeout=3s

services/web/server/src/simcore_service_webserver/catalog/_api.py

@@ -23,7 +23,7 @@
 from models_library.users import UserID
 from models_library.utils.fastapi_encoders import jsonable_encoder
 from pint import UnitRegistry
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 from servicelib.aiohttp.requests_validation import handle_validation_as_http_error
 from servicelib.rabbitmq.rpc_interfaces.catalog import services as catalog_rpc
 from servicelib.rest_constants import RESPONSE_MODEL_POLICY
@@ -42,9 +42,7 @@ class CatalogRequestContext(BaseModel):
     user_id: UserID
     product_name: str
     unit_registry: UnitRegistry
-
-    class Config:
-        arbitrary_types_allowed = True
+    model_config = ConfigDict(arbitrary_types_allowed=True)
 
     @classmethod
     def create(cls, request: Request) -> "CatalogRequestContext":

services/web/server/src/simcore_service_webserver/catalog/_handlers.py

@@ -26,7 +26,7 @@
     ServiceResourcesDict,
     ServiceResourcesDictHelpers,
 )
-from pydantic import BaseModel, Extra, Field, parse_obj_as, validator
+from pydantic import BaseModel, ConfigDict, Field, TypeAdapter, field_validator
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
     parse_request_path_parameters_as,
@@ -54,12 +54,12 @@
 class ServicePathParams(BaseModel):
     service_key: ServiceKey
     service_version: ServiceVersion
+    model_config = ConfigDict(
+        populate_by_name=True,
+        extra="forbid",
+    )
 
-    class Config:
-        allow_population_by_field_name = True
-        extra = Extra.forbid
-
-    @validator("service_key", pre=True)
+    @field_validator("service_key", mode="before")
     @classmethod
     def ensure_unquoted(cls, v):
         # NOTE: this is needed as in pytest mode, the aiohttp server does not seem to unquote automatically
@@ -387,4 +387,6 @@ async def get_service_pricing_plan(request: Request):
             service_version=f"{path_params.service_version}",
         )
 
-    return envelope_json_response(parse_obj_as(PricingPlanGet, pricing_plan))
+    return envelope_json_response(
+        TypeAdapter(PricingPlanGet).validate_python(pricing_plan)
+    )