Enhance user account query parameters with ordering support and add utility for retrieving literal values

Author: pcrespov

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

@@ -32,6 +32,7 @@
     SearchPatternSafeStr,
     validate_input_xss_safety,
 )
+from ..rest_ordering import OrderingQueryParams
 from ..users import (
     FirstNameStr,
     LastNameStr,
@@ -313,7 +314,14 @@ class UsersForAdminListFilter(Filters):
     model_config = ConfigDict(extra="forbid")
 
 
-class UsersAccountListQueryParams(UsersForAdminListFilter, PageQueryParameters): ...
+UserAccountOrderFields: TypeAlias = Literal["email", "created_at"]
+
+
+class UsersAccountListQueryParams(
+    UsersForAdminListFilter,
+    PageQueryParameters,
+    OrderingQueryParams[UserAccountOrderFields],
+): ...
 
 
 class _InvitationDetails(InputSchema):

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

@@ -6,7 +6,7 @@
 """
 
 from enum import Enum
-from typing import TYPE_CHECKING, Generic, TypeVar
+from typing import TYPE_CHECKING, Any, Generic, Literal, TypeVar, get_args, get_origin
 
 from pydantic.generics import GenericModel
 
@@ -29,6 +29,13 @@ def __str__(self) -> str: ...
     TField = TypeVar("TField", bound=str)
 
 
+def get_literal_values(tfield: Any) -> tuple[str, ...] | None:
+    """Return Literal values if TField is a Literal, else None."""
+    if get_origin(tfield) is Literal:
+        return get_args(tfield)
+    return None
+
+
 class OrderClause(GenericModel, Generic[TField]):
     field: TField
     direction: OrderDirection = OrderDirection.ASC

packages/models-library/tests/test_rest_ordering.py

@@ -4,6 +4,7 @@
 import pytest
 from common_library.json_serialization import json_dumps
 from models_library.basic_types import IDStr
+from models_library.list_operations import get_literal_values
 from models_library.rest_ordering import (
     OrderBy,
     OrderClause,
@@ -259,6 +260,8 @@ class TestOrderingParams(OrderingQueryParams[ValidField]):
         OrderClause[ValidField](field="gender", direction=OrderDirection.ASC),
     ]
 
+    assert get_literal_values(ValidField) == ("created_at", "name", "gender")
+
 
 def test_ordering_query_params_validation_error_with_invalid_fields():
     """Test that OrderingQueryParams raises ValidationError when invalid fields are used"""