rename and added new test

Author: pcrespov

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

@@ -30,7 +30,7 @@ class _BaseOrderQueryParams(RequestParameters):
     order_by: OrderBy
 
 
-def create_ordering_query_model_classes(
+def create_ordering_query_model_class(
     *,
     ordering_fields: set[str],
     default: OrderBy,

packages/models-library/tests/test_rest_ordering.py

@@ -1,10 +1,12 @@
+import pickle
+
 import pytest
 from common_library.json_serialization import json_dumps
 from models_library.basic_types import IDStr
 from models_library.rest_ordering import (
     OrderBy,
     OrderDirection,
-    create_ordering_query_model_classes,
+    create_ordering_query_model_class,
 )
 from pydantic import (
     BaseModel,
@@ -48,8 +50,31 @@ def _validate_order_by_field(cls, v):
     )
 
 
+@pytest.mark.xfail(
+    reason="create_ordering_query_model_class.<locals>._OrderBy is still not pickable"
+)
+def test_pickle_ordering_query_model_class():
+    OrderQueryParamsModel = create_ordering_query_model_class(
+        ordering_fields={"name", "description"},
+        default=OrderBy(field=IDStr("name"), direction=OrderDirection.DESC),
+    )
+
+    data = {"order_by": {"field": "name", "direction": "asc"}}
+    query_model = OrderQueryParamsModel.model_validate(data)
+
+    # https://docs.pydantic.dev/latest/concepts/serialization/#pickledumpsmodel
+    expected = query_model.order_by
+
+    # see https://github.com/ITISFoundation/osparc-simcore/pull/6828
+    # FAILURE: raises `AttributeError: Can't pickle local object 'create_ordering_query_model_class.<locals>._OrderBy'`
+    data = pickle.dumps(expected)
+
+    loaded = pickle.loads(data)
+    assert loaded == expected
+
+
 def test_conversion_order_by_from_query_to_domain_model():
-    OrderQueryParamsModel = create_ordering_query_model_classes(
+    OrderQueryParamsModel = create_ordering_query_model_class(
         ordering_fields={"modified_at", "name", "description"},
         default=OrderBy(field=IDStr("modified_at"), direction=OrderDirection.DESC),
     )
@@ -90,7 +115,7 @@ def test_conversion_order_by_from_query_to_domain_model():
 
 
 def test_ordering_query_model_class_factory():
-    BaseOrderingQueryModel = create_ordering_query_model_classes(
+    BaseOrderingQueryModel = create_ordering_query_model_class(
         ordering_fields={"modified_at", "name", "description"},
         default=OrderBy(field=IDStr("modified_at"), direction=OrderDirection.DESC),
         ordering_fields_api_to_column_map={"modified_at": "modified_column"},
@@ -119,7 +144,7 @@ class OrderQueryParamsModel(BaseOrderingQueryModel):
 
 def test_ordering_query_model_class__fails_with_invalid_fields():
 
-    OrderQueryParamsModel = create_ordering_query_model_classes(
+    OrderQueryParamsModel = create_ordering_query_model_class(
         ordering_fields={"modified", "name", "description"},
         default=OrderBy(field=IDStr("modified"), direction=OrderDirection.DESC),
     )
@@ -136,7 +161,7 @@ def test_ordering_query_model_class__fails_with_invalid_fields():
 
 
 def test_ordering_query_model_class__fails_with_invalid_direction():
-    OrderQueryParamsModel = create_ordering_query_model_classes(
+    OrderQueryParamsModel = create_ordering_query_model_class(
         ordering_fields={"modified", "name", "description"},
         default=OrderBy(field=IDStr("modified"), direction=OrderDirection.DESC),
     )
@@ -154,7 +179,7 @@ def test_ordering_query_model_class__fails_with_invalid_direction():
 
 def test_ordering_query_model_class__defaults():
 
-    OrderQueryParamsModel = create_ordering_query_model_classes(
+    OrderQueryParamsModel = create_ordering_query_model_class(
         ordering_fields={"modified", "name", "description"},
         default=OrderBy(field=IDStr("modified"), direction=OrderDirection.DESC),
         ordering_fields_api_to_column_map={"modified": "modified_at"},
@@ -184,7 +209,7 @@ def test_ordering_query_model_class__defaults():
 
 
 def test_ordering_query_model_with_map():
-    OrderQueryParamsModel = create_ordering_query_model_classes(
+    OrderQueryParamsModel = create_ordering_query_model_class(
         ordering_fields={"modified", "name", "description"},
         default=OrderBy(field=IDStr("modified"), direction=OrderDirection.DESC),
         ordering_fields_api_to_column_map={"modified": "some_db_column_name"},
@@ -197,7 +222,7 @@ def test_ordering_query_model_with_map():
 
 def test_ordering_query_parse_json_pre_validator():
 
-    OrderQueryParamsModel = create_ordering_query_model_classes(
+    OrderQueryParamsModel = create_ordering_query_model_class(
         ordering_fields={"modified", "name"},
         default=OrderBy(field=IDStr("modified"), direction=OrderDirection.DESC),
     )

packages/service-library/tests/aiohttp/test_requests_validation.py

@@ -15,7 +15,7 @@
 from models_library.rest_ordering import (
     OrderBy,
     OrderDirection,
-    create_ordering_query_model_classes,
+    create_ordering_query_model_class,
 )
 from pydantic import BaseModel, ConfigDict, Field
 from servicelib.aiohttp import status
@@ -365,7 +365,7 @@ async def test_parse_request_with_invalid_headers_params(
 
 def test_parse_request_query_parameters_as_with_order_by_query_models():
 
-    OrderQueryModel = create_ordering_query_model_classes(
+    OrderQueryModel = create_ordering_query_model_class(
         ordering_fields={"modified", "name"}, default=OrderBy(field="name")
     )
 

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

@@ -8,7 +8,7 @@
 from models_library.rest_ordering import (
     OrderBy,
     OrderDirection,
-    create_ordering_query_model_classes,
+    create_ordering_query_model_class,
 )
 from models_library.rest_pagination import PageQueryParameters
 from models_library.trash import RemoveQueryParams
@@ -42,7 +42,7 @@ class FolderFilters(Filters):
     )
 
 
-_FolderOrderQueryParams: type[RequestParameters] = create_ordering_query_model_classes(
+_FolderOrderQueryParams: type[RequestParameters] = create_ordering_query_model_class(
     ordering_fields={
         "modified_at",
         "name",

services/web/server/src/simcore_service_webserver/projects/_crud_handlers_models.py

@@ -15,7 +15,7 @@
 from models_library.rest_ordering import (
     OrderBy,
     OrderDirection,
-    create_ordering_query_model_classes,
+    create_ordering_query_model_class,
 )
 from models_library.rest_pagination import PageQueryParameters
 from models_library.utils.common_validators import (
@@ -100,7 +100,7 @@ class ProjectFilters(Filters):
     )
 
 
-ProjectsListOrderParams = create_ordering_query_model_classes(
+ProjectsListOrderParams = create_ordering_query_model_class(
     ordering_fields={
         "type",
         "uuid",

services/web/server/src/simcore_service_webserver/resource_usage/_service_runs_handlers.py

@@ -16,7 +16,7 @@
 from models_library.rest_ordering import (
     OrderBy,
     OrderDirection,
-    create_ordering_query_model_classes,
+    create_ordering_query_model_class,
 )
 from models_library.rest_pagination import Page, PageQueryParameters
 from models_library.rest_pagination_utils import paginate_data
@@ -53,7 +53,7 @@ async def wrapper(request: web.Request) -> web.StreamResponse:
 
 _ResorceUsagesListOrderQueryParams: type[
     RequestParameters
-] = create_ordering_query_model_classes(
+] = create_ordering_query_model_class(
     ordering_fields={
         "wallet_id",
         "wallet_name",

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

@@ -6,7 +6,7 @@
 from models_library.rest_ordering import (
     OrderBy,
     OrderDirection,
-    create_ordering_query_model_classes,
+    create_ordering_query_model_class,
 )
 from models_library.rest_pagination import PageQueryParameters
 from models_library.trash import RemoveQueryParams
@@ -31,7 +31,7 @@ class WorkspacesPathParams(StrictRequestParameters):
 
 _WorkspacesListOrderQueryParams: type[
     RequestParameters
-] = create_ordering_query_model_classes(
+] = create_ordering_query_model_class(
     ordering_fields={
         "modified_at",
         "name",