⬆️Pydantic V2: Diverse fixes after merges from master (#6627)

Author: sanderegg

.env-devel

@@ -104,11 +104,11 @@ DYNAMIC_SIDECAR_IMAGE=${DOCKER_REGISTRY:-itisfoundation}/dynamic-sidecar:${DOCKE
 DYNAMIC_SIDECAR_LOG_LEVEL=DEBUG
 DYNAMIC_SIDECAR_PROMETHEUS_MONITORING_NETWORKS=[]
 DYNAMIC_SIDECAR_PROMETHEUS_SERVICE_LABELS={}
-DYNAMIC_SIDECAR_API_SAVE_RESTORE_STATE_TIMEOUT=3600
+DYNAMIC_SIDECAR_API_SAVE_RESTORE_STATE_TIMEOUT=01:00:00
 # DIRECTOR_V2 ----
 DYNAMIC_SCHEDULER_LOGLEVEL=DEBUG
 DYNAMIC_SCHEDULER_PROFILING=1
-DYNAMIC_SCHEDULER_STOP_SERVICE_TIMEOUT=3600
+DYNAMIC_SCHEDULER_STOP_SERVICE_TIMEOUT=01:00:00
 
 FUNCTION_SERVICES_AUTHORS='{"UN": {"name": "Unknown", "email": "[email protected]", "affiliation": "unknown"}}'
 

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

@@ -4,7 +4,6 @@
 from pydantic import BaseModel, Field
 
 from ..basic_types import IDStr
-from ..utils.pydantic_tools_extension import NOT_REQUIRED
 
 
 class DefaultApiError(BaseModel):
@@ -13,7 +12,7 @@ class DefaultApiError(BaseModel):
         description="Error identifier as a code or a name. "
         "Mainly for machine-machine communication purposes.",
     )
-    detail: Any | None = Field(NOT_REQUIRED, description="Human readable error message")
+    detail: Any | None = Field(default=None, description="Human readable error message")
 
     @classmethod
     def from_status_code(

packages/models-library/src/models_library/api_schemas_webserver/projects.py

@@ -8,13 +8,12 @@
 from datetime import datetime
 from typing import Any, Literal, TypeAlias
 
-from models_library.folders import FolderID
-from models_library.workspaces import WorkspaceID
 from pydantic import ConfigDict, Field, HttpUrl, field_validator
 
 from ..api_schemas_long_running_tasks.tasks import TaskGet
 from ..basic_types import LongTruncatedStr, ShortTruncatedStr
 from ..emails import LowerCaseEmailStr
+from ..folders import FolderID
 from ..projects import ClassifierID, DateTimeStr, NodesDict, ProjectID
 from ..projects_access import AccessRights, GroupIDStr
 from ..projects_state import ProjectState
@@ -24,7 +23,7 @@
     none_to_empty_str_pre_validator,
     null_or_none_str_to_none_validator,
 )
-from ..utils.pydantic_tools_extension import FieldNotRequired
+from ..workspaces import WorkspaceID
 from ._base import EmptyModel, InputSchema, OutputSchema
 from .permalinks import ProjectPermalink
 
@@ -74,12 +73,16 @@ class ProjectGet(OutputSchema):
     prj_owner: LowerCaseEmailStr
     access_rights: dict[GroupIDStr, AccessRights]
     tags: list[int]
-    classifiers: list[ClassifierID] = []
+    classifiers: list[ClassifierID] = Field(
+        default_factory=list, json_schema_extra={"default": []}
+    )
     state: ProjectState | None = None
     ui: EmptyModel | StudyUI | None = None
-    quality: dict[str, Any] = {}
+    quality: dict[str, Any] = Field(
+        default_factory=dict, json_schema_extra={"default": {}}
+    )
     dev: dict | None
-    permalink: ProjectPermalink = FieldNotRequired()
+    permalink: ProjectPermalink | None = None
     workspace_id: WorkspaceID | None
     folder_id: FolderID | None
     trashed_at: datetime | None
@@ -107,13 +110,15 @@ class ProjectReplace(InputSchema):
     last_change_date: DateTimeStr
     workbench: NodesDict
     access_rights: dict[GroupIDStr, AccessRights]
-    tags: list[int] | None = []
+    tags: list[int] | None = Field(
+        default_factory=list, json_schema_extra={"default": []}
+    )
     classifiers: list[ClassifierID] | None = Field(
-        default_factory=list,
+        default_factory=list, json_schema_extra={"default": []}
     )
     ui: StudyUI | None = None
     quality: dict[str, Any] = Field(
-        default_factory=dict,
+        default_factory=dict, json_schema_extra={"default": {}}
     )
 
     _empty_is_none = field_validator("thumbnail", mode="before")(
@@ -122,16 +127,16 @@ class ProjectReplace(InputSchema):
 
 
 class ProjectPatch(InputSchema):
-    name: ShortTruncatedStr = FieldNotRequired()
-    description: LongTruncatedStr = FieldNotRequired()
-    thumbnail: HttpUrl = FieldNotRequired()
-    access_rights: dict[GroupIDStr, AccessRights] = FieldNotRequired()
-    classifiers: list[ClassifierID] = FieldNotRequired()
-    dev: dict | None = FieldNotRequired()
-    ui: StudyUI | None = FieldNotRequired()
-    quality: dict[str, Any] = FieldNotRequired()
-
-    _empty_is_none = field_validator("thumbnail", allow_reuse=True, pre=True)(
+    name: ShortTruncatedStr | None = Field(default=None)
+    description: LongTruncatedStr | None = Field(default=None)
+    thumbnail: HttpUrl | None = Field(default=None)
+    access_rights: dict[GroupIDStr, AccessRights] | None = Field(default=None)
+    classifiers: list[ClassifierID] | None = Field(default=None)
+    dev: dict | None = Field(default=None)
+    ui: StudyUI | None = Field(default=None)
+    quality: dict[str, Any] | None = Field(default=None)
+
+    _empty_is_none = field_validator("thumbnail", mode="before")(
         empty_str_to_none_pre_validator
     )
 

packages/models-library/src/models_library/api_schemas_webserver/projects_nodes.py

@@ -10,7 +10,6 @@
 from ..services import ServiceKey, ServicePortKey, ServiceVersion
 from ..services_enums import ServiceState
 from ..services_resources import ServiceResourcesDict
-from ..utils.pydantic_tools_extension import FieldNotRequired
 from ._base import InputSchemaWithoutCamelCase, OutputSchema
 
 assert ServiceResourcesDict  # nosec
@@ -27,19 +26,19 @@ class NodeCreate(InputSchemaWithoutCamelCase):
 
 
 class NodePatch(InputSchemaWithoutCamelCase):
-    service_key: ServiceKey = FieldNotRequired(alias="key")
-    service_version: ServiceVersion = FieldNotRequired(alias="version")
-    label: str = FieldNotRequired()
-    inputs: InputsDict = FieldNotRequired()
-    inputs_required: list[InputID] = FieldNotRequired(alias="inputsRequired")
-    input_nodes: list[NodeID] = FieldNotRequired(alias="inputNodes")
-    progress: float | None = FieldNotRequired(
-        ge=0, le=100
+    service_key: ServiceKey | None = Field(default=None, alias="key")
+    service_version: ServiceVersion | None = Field(default=None, alias="version")
+    label: str | None = Field(default=None)
+    inputs: InputsDict = Field(default=None)
+    inputs_required: list[InputID] | None = Field(default=None, alias="inputsRequired")
+    input_nodes: list[NodeID] | None = Field(default=None, alias="inputNodes")
+    progress: float | None = Field(
+        default=None, ge=0, le=100
     )  # NOTE: it is used by frontend for File Picker progress
-    boot_options: BootOptions = FieldNotRequired(alias="bootOptions")
-    outputs: dict[
-        str, Any
-    ] = FieldNotRequired()  # NOTE: it is used by frontend for File Picker
+    boot_options: BootOptions | None = Field(default=None, alias="bootOptions")
+    outputs: dict[str, Any] | None = Field(
+        default=None
+    )  # NOTE: it is used by frontend for File Picker
 
 
 class NodeCreated(OutputSchema):

packages/models-library/src/models_library/api_schemas_webserver/wallets.py

@@ -6,7 +6,6 @@
 
 from ..basic_types import AmountDecimal, IDStr, NonNegativeDecimal
 from ..users import GroupID
-from ..utils.pydantic_tools_extension import FieldNotRequired
 from ..wallets import WalletID, WalletStatus
 from ._base import InputSchema, OutputSchema
 
@@ -21,9 +20,7 @@ class WalletGet(OutputSchema):
     created: datetime
     modified: datetime
 
-    model_config = ConfigDict(
-        frozen=False
-    )
+    model_config = ConfigDict(frozen=False)
 
 
 class WalletGetWithAvailableCredits(WalletGet):
@@ -60,7 +57,7 @@ class PutWalletBodyParams(OutputSchema):
 
 class CreateWalletPayment(InputSchema):
     price_dollars: AmountDecimal
-    comment: str = FieldNotRequired(max_length=100)
+    comment: str | None = Field(default=None, max_length=100)
 
 
 class WalletPaymentInitiated(OutputSchema):
@@ -77,15 +74,15 @@ class PaymentTransaction(OutputSchema):
     price_dollars: Decimal
     wallet_id: WalletID
     osparc_credits: Decimal
-    comment: str = FieldNotRequired()
+    comment: str | None = Field(default=None)
     created_at: datetime
     completed_at: datetime | None
     # SEE PaymentTransactionState enum
     state: Literal["PENDING", "SUCCESS", "FAILED", "CANCELED"] = Field(
         ..., alias="completedStatus"
     )
-    state_message: str = FieldNotRequired()
-    invoice_url: HttpUrl = FieldNotRequired()
+    state_message: str | None = Field(default=None)
+    invoice_url: HttpUrl | None = Field(default=None)
 
 
 class PaymentMethodInitiated(OutputSchema):

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

@@ -1,10 +1,11 @@
 from datetime import datetime
 from typing import TypeAlias
 
-from models_library.users import GroupID, UserID
-from models_library.workspaces import WorkspaceID
 from pydantic import BaseModel, ConfigDict, Field, PositiveInt
 
+from .users import GroupID, UserID
+from .workspaces import WorkspaceID
+
 FolderID: TypeAlias = PositiveInt
 
 

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

@@ -99,7 +99,7 @@ class ProjectAtDB(BaseProjectModel):
     prj_owner: int | None = Field(..., description="The project owner id")
 
     published: bool | None = Field(
-        False, description="Defines if a study is available publicly"
+        default=False, description="Defines if a study is available publicly"
     )
 
     @field_validator("project_type", mode="before")
@@ -183,8 +183,4 @@ class Project(BaseProjectModel):
         alias="trashedAt",
     )
 
-    model_config = ConfigDict(
-        description="Document that stores metadata, pipeline and UI setup of a study",
-        title="osparc-simcore project",
-        extra="forbid",
-    )
+    model_config = ConfigDict(title="osparc-simcore project", extra="forbid")

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

@@ -1,7 +1,6 @@
 from typing import Generic, TypeVar
 
 from pydantic import BaseModel, Field, Json
-from pydantic.generics import GenericModel
 
 
 class Filters(BaseModel):
@@ -15,7 +14,7 @@ class Filters(BaseModel):
 FilterT = TypeVar("FilterT", bound=Filters)
 
 
-class FiltersQueryParameters(GenericModel, Generic[FilterT]):
+class FiltersQueryParameters(BaseModel, Generic[FilterT]):
     filters: Json[FilterT] | None = Field(  # pylint: disable=unsubscriptable-object
         default=None,
         description="Custom filter query parameter encoded as JSON",

packages/models-library/src/models_library/utils/common_validators.py

@@ -8,7 +8,7 @@
     class MyModel(BaseModel):
        thumbnail: str | None
 
-       _empty_is_none = validator("thumbnail", allow_reuse=True, pre=True)(
+       _empty_is_none = validator("thumbnail", mode="before")(
            empty_str_to_none_pre_validator
        )
 

packages/models-library/src/models_library/utils/pydantic_tools_extension.py

@@ -1,7 +1,6 @@
-import functools
-from typing import Final, TypeVar
+from typing import TypeVar
 
-from pydantic import Field, TypeAdapter, ValidationError
+from pydantic import TypeAdapter, ValidationError
 
 T = TypeVar("T")
 
@@ -11,17 +10,3 @@ def parse_obj_or_none(type_: type[T], obj) -> T | None:
         return TypeAdapter(type_).validate_python(obj)
     except ValidationError:
         return None
-
-
-#
-# NOTE: Helper to define non-nullable optional fields
-# SEE details in test/test_utils_pydantic_tools_extension.py
-#
-# Two usage styles:
-#
-# class Model(BaseModel):
-#     value: FieldNotRequired(description="some optional field")
-#     other: Field(NOT_REQUIRED, description="alternative")
-#
-NOT_REQUIRED: Final = None
-FieldNotRequired = functools.partial(Field, default=NOT_REQUIRED)