@GitHK review: field not required

ITISFoundation · Jul 21, 2023 · 2d6a7f3 · 2d6a7f3
1 parent d93f5cd
commit 2d6a7f3
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 24 deletions.
diff --git a/packages/models-library/src/models_library/api_schemas_webserver/_base.py b/packages/models-library/src/models_library/api_schemas_webserver/_base.py
@@ -5,12 +5,10 @@
 
 from typing import Any
 
-from pydantic import BaseModel, Extra, Field
+from pydantic import BaseModel, Extra
 
 from ..utils.change_case import snake_to_camel
 
-NOT_REQUIRED = Field(default=None)
-
 
 class EmptyModel(BaseModel):
     # Used to represent body={}

diff --git a/packages/models-library/src/models_library/api_schemas_webserver/projects.py b/packages/models-library/src/models_library/api_schemas_webserver/projects.py
@@ -17,7 +17,8 @@
 from ..projects_state import ProjectState
 from ..projects_ui import StudyUI
 from ..utils.common_validators import empty_str_to_none, none_to_empty_str
-from ._base import NOT_REQUIRED, EmptyModel, InputSchema, OutputSchema
+from ..utils.pydantic_tools_extension import FieldNotRequired
+from ._base import EmptyModel, InputSchema, OutputSchema
 from .permalinks import ProjectPermalink
 
 
@@ -65,7 +66,7 @@ class ProjectGet(OutputSchema):
     ui: EmptyModel | StudyUI | None
     quality: dict[str, Any] = {}
     dev: dict | None
-    permalink: ProjectPermalink = NOT_REQUIRED
+    permalink: ProjectPermalink = FieldNotRequired()
 
     _empty_description = validator("description", allow_reuse=True, pre=True)(
         none_to_empty_str
@@ -103,15 +104,15 @@ class ProjectReplace(InputSchema):
 
 
 class ProjectUpdate(InputSchema):
-    name: str = NOT_REQUIRED
-    description: str = NOT_REQUIRED
-    thumbnail: HttpUrlWithCustomMinLength = NOT_REQUIRED
-    workbench: NodesDict = NOT_REQUIRED
-    access_rights: dict[GroupIDStr, AccessRights] = NOT_REQUIRED
-    tags: list[int] = NOT_REQUIRED
-    classifiers: list[ClassifierID] = NOT_REQUIRED
+    name: str = FieldNotRequired()
+    description: str = FieldNotRequired()
+    thumbnail: HttpUrlWithCustomMinLength = FieldNotRequired()
+    workbench: NodesDict = FieldNotRequired()
+    access_rights: dict[GroupIDStr, AccessRights] = FieldNotRequired()
+    tags: list[int] = FieldNotRequired()
+    classifiers: list[ClassifierID] = FieldNotRequired()
     ui: StudyUI | None = None
-    quality: dict[str, Any] = NOT_REQUIRED
+    quality: dict[str, Any] = FieldNotRequired()
 
 
 __all__: tuple[str, ...] = (

diff --git a/services/api-server/src/simcore_service_api_server/models/_utils_pydantic.py b/services/api-server/src/simcore_service_api_server/models/_utils_pydantic.py
@@ -1,11 +1,6 @@
-from pydantic import Field
-
 from ..utils.serialization import json_dumps, json_loads
 
 
 class BaseConfig:
     json_loads = json_loads
     json_dumps = json_dumps
-
-
-NOT_REQUIRED = Field(default=None)
diff --git a/services/api-server/src/simcore_service_api_server/models/pagination.py b/services/api-server/src/simcore_service_api_server/models/pagination.py
@@ -17,11 +17,10 @@
     DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     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 ._utils_pydantic import NOT_REQUIRED
-
 T = TypeVar("T")
 
 # NOTE: same pagination limits and defaults as web-server
@@ -46,7 +45,7 @@ class OnePage(GenericModel, Generic[T]):
     """
 
     items: Sequence[T]
-    total: NonNegativeInt = NOT_REQUIRED
+    total: NonNegativeInt = FieldNotRequired()
 
     @validator("total", pre=True)
     @classmethod

diff --git a/services/api-server/src/simcore_service_api_server/models/schemas/studies.py b/services/api-server/src/simcore_service_api_server/models/schemas/studies.py
@@ -2,9 +2,9 @@
 
 from models_library.projects import ProjectID
 from models_library.projects_nodes_io import NodeID
+from models_library.utils.pydantic_tools_extension import FieldNotRequired
 from pydantic import BaseModel, Field
 
-from .._utils_pydantic import NOT_REQUIRED
 from .solvers import SolverPort
 
 StudyID: TypeAlias = ProjectID
@@ -13,8 +13,8 @@
 # OUTPUT
 class Study(BaseModel):  # StudyGet
     uid: StudyID
-    title: str = NOT_REQUIRED
-    description: str = NOT_REQUIRED
+    title: str = FieldNotRequired()
+    description: str = FieldNotRequired()
 
 
 class StudyPort(SolverPort):