Uses typing_extensions.TypedDict in all instances used in pydantic models AND fixes with migration of rest_ordering (#6770)

Author: pcrespov

.github/CODEOWNERS

@@ -14,7 +14,7 @@ Makefile                                  @pcrespov @sanderegg
 /ci/                                      @sanderegg @pcrespov
 /docs/                                    @pcrespov
 /packages/common-library/                 @giancarloromeo
-/packages/models-library/                 @sanderegg @pcrespov @matusdrobuliak66
+/packages/models-library/                 @sanderegg @pcrespov @matusdrobuliak66 @giancarloromeo
 /packages/postgres-database/              @matusdrobuliak66
 /packages/pytest-simcore/                 @pcrespov @sanderegg
 /packages/service-integration/            @pcrespov @sanderegg @GitHK

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

@@ -1,5 +1,7 @@
 from pydantic import BaseModel, ConfigDict, ValidationInfo, field_validator
-from typing_extensions import TypedDict
+from typing_extensions import (  # https://docs.pydantic.dev/latest/api/standard_library_types/#typeddict
+    TypedDict,
+)
 
 from .basic_types import EnvVarKey
 

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

@@ -6,7 +6,9 @@
 
 from pydantic import BaseModel, ConfigDict, Field, field_validator
 from pydantic_extra_types.color import Color
-from typing_extensions import TypedDict
+from typing_extensions import (  # https://docs.pydantic.dev/latest/api/standard_library_types/#typeddict
+    TypedDict,
+)
 
 from .projects_nodes_io import NodeID, NodeIDStr
 from .projects_nodes_ui import Marker, Position

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

@@ -8,7 +8,7 @@ class RequestParameters(BaseModel):
     """
 
     def as_params(self, **export_options) -> dict[str, str]:
-        data = self.dict(**export_options)
+        data = self.model_dump(**export_options)
         return {k: f"{v}" for k, v in data.items()}
 
 

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

@@ -1,9 +1,11 @@
 from math import ceil
 from typing import Any, Protocol, runtime_checkable
-from typing_extensions import TypedDict
 
 from common_library.pydantic_networks_extension import AnyHttpUrlLegacy
 from pydantic import TypeAdapter
+from typing_extensions import (  # https://docs.pydantic.dev/latest/api/standard_library_types/#typeddict
+    TypedDict,
+)
 
 from .rest_pagination import PageLinks, PageMetaInfoLimitOffset
 
@@ -70,7 +72,9 @@ def paginate_data(
     """
     last_page = ceil(total / limit) - 1
 
-    data = [item.model_dump() if hasattr(item, "model_dump") else item for item in chunk]
+    data = [
+        item.model_dump() if hasattr(item, "model_dump") else item for item in chunk
+    ]
 
     return PageDict(
         _meta=PageMetaInfoLimitOffset(

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

@@ -1,4 +1,8 @@
-from typing import Any, TypedDict
+from typing import Any
+
+from typing_extensions import (  # https://docs.pydantic.dev/latest/api/standard_library_types/#typeddict
+    TypedDict,
+)
 
 
 class SocketMessageDict(TypedDict):

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

@@ -48,7 +48,7 @@ def parse_json_pre_validator(value: Any):
             return json_loads(value)
         except JSONDecodeError as err:
             msg = f"Invalid JSON {value=}: {err}"
-            raise TypeError(msg) from err
+            raise ValueError(msg) from err
     return value
 
 

packages/models-library/tests/test_rest_ordering.py

@@ -151,3 +151,22 @@ def test_ordering_query_model_with_map():
     model = OrderQueryParamsModel.model_validate({"order_by": {"field": "modified"}})
     assert model.order_by
     assert model.order_by.field == "some_db_column_name"
+
+
+def test_ordering_query_parse_json_pre_validator():
+
+    OrderQueryParamsModel = create_ordering_query_model_classes(
+        ordering_fields={"modified", "name"},
+        default=OrderBy(field=IDStr("modified"), direction=OrderDirection.DESC),
+    )
+
+    bad_json_value = ",invalid json"
+    with pytest.raises(ValidationError) as err_info:
+        OrderQueryParamsModel.model_validate({"order_by": bad_json_value})
+
+    exc = err_info.value
+    assert exc.error_count() == 1
+    error = exc.errors()[0]
+    assert error["loc"] == ("order_by",)
+    assert error["type"] == "value_error"
+    assert error["input"] == bad_json_value

packages/postgres-database/src/simcore_postgres_database/models/products.py

@@ -11,7 +11,9 @@
 import sqlalchemy as sa
 from sqlalchemy.dialects.postgresql import JSONB
 from sqlalchemy.sql import func
-from typing_extensions import TypedDict
+from typing_extensions import (  # https://docs.pydantic.dev/latest/api/standard_library_types/#typeddict
+    TypedDict,
+)
 
 from .base import metadata
 from .groups import groups

packages/service-library/src/servicelib/aiohttp/application_setup.py

@@ -4,11 +4,14 @@
 from collections.abc import Callable
 from copy import deepcopy
 from enum import Enum
-from typing import Any, Protocol, TypedDict
+from typing import Any, Protocol
 
 import arrow
 from aiohttp import web
 from pydantic import TypeAdapter
+from typing_extensions import (  # https://docs.pydantic.dev/latest/api/standard_library_types/#typeddict
+    TypedDict,
+)
 
 from .application_keys import APP_CONFIG_KEY, APP_SETTINGS_KEY