ul-api-utils 8.1.4__tar.gz → 8.1.6__tar.gz

{ul-api-utils-8.1.4 → ul-api-utils-8.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-api-utils
-Version: 8.1.4
+Version: 8.1.6
 Summary: Python api utils
 Author: Unic-lab
 Author-email: 

{ul-api-utils-8.1.4 → ul-api-utils-8.1.6}/setup.py

@@ -9,7 +9,7 @@ with open(path.join(HERE, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='ul-api-utils',
-    version='8.1.4',
+    version='8.1.6',
     description='Python api utils',
     author='Unic-lab',
     long_description=long_description,

{ul-api-utils-8.1.4 → ul-api-utils-8.1.6}/ul_api_utils/api_resource/api_resource_fn_typing.py

@@ -3,13 +3,14 @@ from typing import NamedTuple, Any, Callable, Optional, List, Dict, Type, Tuple,
 
 from flask import request
 from pydantic import BaseModel, ValidationError, validate_call, TypeAdapter
-from pydantic.utils import deep_update
+from pydantic.v1.utils import deep_update
 from pydantic_core import ErrorDetails
 
 from ul_api_utils.api_resource.api_request import ApiRequestQuery
 from ul_api_utils.api_resource.api_resource_type import ApiResourceType
-from ul_api_utils.api_resource.api_response import HtmlApiResponse, JsonApiResponse, FileApiResponse, RedirectApiResponse, ApiResponse, \
-    JsonApiResponsePayload, ProxyJsonApiResponse, AnyJsonApiResponse, \
+from ul_api_utils.api_resource.api_response import HtmlApiResponse, JsonApiResponse, FileApiResponse, \
+    RedirectApiResponse, ApiResponse, \
+    JsonApiResponsePayload, RootJsonApiResponsePayload, ProxyJsonApiResponse, AnyJsonApiResponse, \
     EmptyJsonApiResponse, TPayloadTotalUnion, RootJsonApiResponse
 from ul_api_utils.api_resource.signature_check import get_typing, set_model_dictable, set_model
 from ul_api_utils.errors import ValidationListApiError, ResourceRuntimeApiError, InvalidContentTypeError
@@ -56,7 +57,7 @@ class ApiResourceFnTyping(NamedTuple):
     query_typing: Optional[Type[ApiRequestQuery]]  # none if it is not specified
     has_query_validation_error: bool
     return_typing: Optional[Type[ApiResponse]]  # NOT NONE for api
-    return_payload_typing: Optional[Type[JsonApiResponsePayload]]  # NOT NONE for api
+    return_payload_typing: Optional[Type[JsonApiResponsePayload] | Type[RootJsonApiResponsePayload[Any]]]  # NOT NONE for api
 
     def get_return_schema(self) -> Type[BaseModel]:
         inner_type = self.return_payload_typing
@@ -91,7 +92,7 @@ class ApiResourceFnTyping(NamedTuple):
     def runtime_validate_api_proxy_payload(self, response: Dict[str, Any], *, quick: bool) -> None:
         assert isinstance(response, dict)
 
-    def runtime_validate_api_response_payload(self, payload: Any, total_count: Optional[int], *, quick: bool) -> TPayloadTotalUnion:
+    def runtime_validate_api_response_payload(self, payload: Any, total_count: Optional[int], *, quick: bool) -> TPayloadTotalUnion:  # type: ignore
         quick = quick or self.return_payload_typing is None
 
         if self.return_typing == AnyJsonApiResponse:
@@ -106,7 +107,7 @@ class ApiResourceFnTyping(NamedTuple):
                 if r is None:
                     raise ResourceRuntimeApiError(f'invalid type of object. {type(o).__name__} was given')
                 new_payload.append(r)
-            return new_payload, total_count  # type: ignore
+            return new_payload, total_count
 
         if payload is None:  # only for case when payload must be single object
             return None, None
@@ -114,7 +115,7 @@ class ApiResourceFnTyping(NamedTuple):
         new_payload = to_dict(payload) if quick else set_model_dictable(self.return_payload_typing, payload)  # type: ignore
         if new_payload is None:
             raise ResourceRuntimeApiError(f'invalid type of object. {type(payload).__name__} was given')
-        return new_payload, None  # type: ignore
+        return new_payload, None
 
     def _get_body(self) -> Optional[Any]:
         if self.api_resource_type == ApiResourceType.WEB:
@@ -230,7 +231,7 @@ class ApiResourceFnTyping(NamedTuple):
         cls,
         api_resource_type: 'ApiResourceType',
         fn: Callable[['ApiResource'], ApiResponse],
-    ) -> Tuple[bool, Optional[Type[JsonApiResponsePayload]], Optional[Type[ApiResponse]]]:
+    ) -> Tuple[bool, Optional[Type[JsonApiResponsePayload] | Type[RootJsonApiResponsePayload[Any]]], Optional[Type[ApiResponse]]]:
         response_many = False
         return_typing = fn.__annotations__.get('return', None)
         ret = get_typing(return_typing)
@@ -259,21 +260,21 @@ class ApiResourceFnTyping(NamedTuple):
                     assert return_payload_typing is None, f'{fn.__name__} :: invalid response payload typing. payload must be None. {return_payload_typing.__name__} was given'
 
                 elif return_typing is RootJsonApiResponse:
-                    assert return_payload_typing is not None and issubclass(return_payload_typing, JsonApiResponsePayload), \
-                        f'{fn.__name__} :: invalid response payload typing. payload must be subclass of JsonApiResponsePayload. ' \
+                    assert return_payload_typing is not None and issubclass(return_payload_typing, (JsonApiResponsePayload, RootJsonApiResponsePayload)), \
+                        f'{fn.__name__} :: invalid response payload typing. payload must be subclass of (JsonApiResponsePayload, RootJsonApiResponsePayload). ' \
                         f'{return_payload_typing.__name__ if return_payload_typing is not None else "None"} was given'
 
                 elif return_typing is AnyJsonApiResponse:
                     assert return_payload_typing is None, f'{fn.__name__} :: invalid response payload typing. payload must be None. {return_payload_typing.__name__} was given'
 
                 elif issubclass(return_typing, JsonApiResponse):
-                    assert return_payload_typing is not None and issubclass(return_payload_typing, JsonApiResponsePayload), \
-                        f'{fn.__name__} :: invalid response payload typing. payload must be subclass of JsonApiResponsePayload. ' \
+                    assert return_payload_typing is not None and issubclass(return_payload_typing, (JsonApiResponsePayload, RootJsonApiResponsePayload)), \
+                        f'{fn.__name__} :: invalid response payload typing. payload must be subclass of (JsonApiResponsePayload, RootJsonApiResponsePayload). ' \
                         f'{return_payload_typing.__name__ if return_payload_typing is not None else "None"} was given'
 
                 elif issubclass(return_typing, ProxyJsonApiResponse):
-                    assert return_payload_typing is not None and issubclass(return_payload_typing, JsonApiResponsePayload), \
-                        f'{fn.__name__} :: invalid response payload typing. payload must be subclass of JsonApiResponsePayload. ' \
+                    assert return_payload_typing is not None and issubclass(return_payload_typing, (JsonApiResponsePayload, RootJsonApiResponsePayload)), \
+                        f'{fn.__name__} :: invalid response payload typing. payload must be subclass of (JsonApiResponsePayload, RootJsonApiResponsePayload). ' \
                         f'{return_payload_typing.__name__ if return_payload_typing is not None else "None"} was given'
 
                 else:

{ul-api-utils-8.1.4 → ul-api-utils-8.1.6}/ul_api_utils/api_resource/api_response.py

@@ -2,14 +2,16 @@ import io
 from datetime import datetime
 from types import NoneType
 from typing import TypeVar, Generic, List, Optional, Dict, Any, Callable, Union, BinaryIO, Tuple, Type
+
 import msgpack
 from flask import jsonify, send_file, redirect, Response, request
-from pydantic import ConfigDict, RootModel
 from pydantic import BaseModel
+from pydantic import ConfigDict, RootModel
 from werkzeug import Response as BaseResponse
 
 from ul_api_utils.api_resource.db_types import TPayloadInputUnion
-from ul_api_utils.const import RESPONSE_PROP_OK, RESPONSE_PROP_PAYLOAD, RESPONSE_PROP_COUNT, RESPONSE_PROP_TOTAL, RESPONSE_PROP_ERRORS, MIME__JSON, MIME__MSGPCK, \
+from ul_api_utils.const import RESPONSE_PROP_OK, RESPONSE_PROP_PAYLOAD, RESPONSE_PROP_COUNT, RESPONSE_PROP_TOTAL, \
+    RESPONSE_PROP_ERRORS, MIME__JSON, MIME__MSGPCK, \
     REQUEST_HEADER__ACCEPT
 from ul_api_utils.debug.debugger import Debugger
 from ul_api_utils.utils.json_encoder import CustomJSONEncoder
@@ -139,21 +141,30 @@ class EmptyJsonApiResponse(ApiResponse):
         return resp
 
 
+T = TypeVar("T")
+
 class JsonApiResponsePayload(BaseModel):
     model_config = ConfigDict(extra="ignore")
 
 
-TResultPayloadUnion = Union[None, Dict[str, Any], JsonApiResponsePayload, List[JsonApiResponsePayload], List[Dict[str, Any]]]
+class RootJsonApiResponsePayload(RootModel[T]):
+    pass
+
+TRootJsonApiResponsePayload = TypeVar('TRootJsonApiResponsePayload')
+
+TResultPayloadUnion = Union[None, Dict[str, Any], JsonApiResponsePayload, TRootJsonApiResponsePayload, List[JsonApiResponsePayload], List[TRootJsonApiResponsePayload], List[Dict[str, Any]]]
 TPayloadTotalUnion = Union[
     Tuple[None, None],
     Tuple[Dict[str, Any], None],
     Tuple[JsonApiResponsePayload, None],
+    Tuple[TRootJsonApiResponsePayload, None],
     Tuple[List[JsonApiResponsePayload], int],
+    Tuple[List[TRootJsonApiResponsePayload], int],
     Tuple[List[Dict[str, Any]], int],
 ]
 
 
-class DictJsonApiResponsePayload(RootModel[Dict[str, Any]]):
+class DictJsonApiResponsePayload(RootJsonApiResponsePayload[Dict[str, Any]]):
     pass
 
 

{ul-api-utils-8.1.4 → ul-api-utils-8.1.6}/ul_api_utils/api_resource/api_response_payload_alias.py

@@ -1,9 +1,8 @@
 from datetime import datetime
-from types import NoneType
 
-from pydantic import UUID4, RootModel
+from pydantic import UUID4
 
-from ul_api_utils.api_resource.api_response import JsonApiResponsePayload
+from ul_api_utils.api_resource.api_response import JsonApiResponsePayload, RootJsonApiResponsePayload
 
 
 class ApiBaseModelPayloadResponse(JsonApiResponsePayload):
@@ -22,5 +21,5 @@ class ApiBaseUserModelPayloadResponse(JsonApiResponsePayload):
     is_alive: bool
 
 
-class ApiEmptyResponse(RootModel[NoneType]):  # type: ignore
+class ApiEmptyResponse(RootJsonApiResponsePayload[None]):
     pass

ul-api-utils-8.1.6/ul_api_utils/validators/__tests__/test_custom_fields.py

@@ -0,0 +1,32 @@
+# import pytest
+#
+# from pydantic import BaseModel
+# from typing import Union, List
+# from ul_api_utils.validators.custom_fields import QueryParamsSeparatedList
+#
+#
+# class ModelStr(BaseModel):
+#     param: QueryParamsSeparatedList[str]
+#
+#
+# class ModelInt(BaseModel):
+#     param: QueryParamsSeparatedList[int]
+#
+#
+# @pytest.mark.parametrize(
+#     "model, input_data, expected_output",
+#     [
+#         pytest.param(ModelStr, "first_array_element,second,third,this", ["first_array_element", "second", "third", "this"]),
+#         pytest.param(ModelStr, ["first_array_element,second,third,this"], ["first_array_element", "second", "third", "this"]),
+#         pytest.param(ModelInt, ["1,2,3,4,5"], [1, 2, 3, 4, 5]),
+#         pytest.param(ModelStr, 'first_array_element,"second,third",this', ["first_array_element", "second,third", "this"]),
+#         pytest.param(ModelStr, ['first_array_element,"second,third",this'], ["first_array_element", "second,third", "this"]),
+#         pytest.param(ModelStr, '"first_array_element,second,third",this, "1,2"', ["first_array_element,second,third", "this", "1,2"]),
+#     ],
+# )
+# def test__query_params_separated_list(
+#     model: Union[ModelStr, ModelInt], input_data: Union[List[str], str], expected_output: List[Union[str, int]],
+# ) -> None:
+#     instance = model(param=input_data)  # type: ignore
+#     assert isinstance(instance.param, list)
+#     assert instance.param == expected_output

{ul-api-utils-8.1.4 → ul-api-utils-8.1.6}/ul_api_utils/validators/custom_fields.py

@@ -1,8 +1,9 @@
 import csv
-from typing import TypeVar, Generic, List, Union, Generator, Callable, Annotated, Any, get_args
+from typing import TypeVar, Generic, List, Union, Generator, Callable, Annotated, Any
 from uuid import UUID
 
-from pydantic import ValidationError, Field, StringConstraints, TypeAdapter
+from pydantic import Field, StringConstraints, TypeAdapter
+from pydantic_core import ValidationError, InitErrorDetails
 from pydantic_core.core_schema import ValidationInfo
 
 from ul_api_utils.const import CRON_EXPRESSION_VALIDATION_REGEX, MIN_UTC_OFFSET_SECONDS, MAX_UTC_OFFSET_SECONDS
@@ -38,12 +39,13 @@ class QueryParamsSeparatedList(Generic[QueryParamsSeparatedListValueType]):
     Note:
         Sent as a string, but interpreted as List.
     """
+    _contains_type: Any = None
 
-    def __init__(self, contains_type: QueryParamsSeparatedListValueType) -> None:
-        self.contains_type = contains_type
-
-    def __repr__(self) -> str:
-        return f'QueryParamsSeparatedList({super().__repr__()})'
+    @classmethod
+    def __class_getitem__(cls, item: Any) -> QueryParamsSeparatedListValueType:
+        new_cls = super().__class_getitem__(item)  # type: ignore
+        new_cls._contains_type = item
+        return new_cls
 
     @classmethod
     def __get_validators__(cls) -> Generator[Callable[[Union[List[str], str], ValidationInfo], List[QueryParamsSeparatedListValueType]], None, None]:
@@ -54,23 +56,29 @@ class QueryParamsSeparatedList(Generic[QueryParamsSeparatedListValueType]):
         """
         Validate and convert the query parameter string into a list of the specified type.
         """
+        if cls._contains_type is None:
+            raise TypeError("QueryParamsSeparatedList must be parameterized with a type, e.g., QueryParamsSeparatedList[int]")
+
+        adapter = TypeAdapter(cls._contains_type)
+
         if not isinstance(query_param, list):
             query_param = [query_param]
 
         reader = csv.reader(query_param, skipinitialspace=True)
         splitted = next(reader)
 
-        adapter = TypeAdapter(get_args(cls)[0])
-
         validated_items = []
-        errors = []
+        errors: List[InitErrorDetails] = []
 
-        for value in splitted:
+        for idx, value in enumerate(splitted):
             try:
                 validated_items.append(adapter.validate_python(value))
             except ValidationError as e:
-                errors.append(e)
+                for error in e.errors(include_url=False):
+                    error['loc'] = ('param', idx)
+                    errors.append(error)  # type: ignore
+
         if errors:
-            raise ValidationError(errors)
+            raise ValidationError.from_exception_data("List validation error", errors)
 
         return validated_items

{ul-api-utils-8.1.4 → ul-api-utils-8.1.6}/ul_api_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-api-utils
-Version: 8.1.4
+Version: 8.1.6
 Summary: Python api utils
 Author: Unic-lab
 Author-email: 

ul-api-utils-8.1.4/ul_api_utils/validators/__tests__/test_custom_fields.py

@@ -1,33 +0,0 @@
-import pytest
-
-from pydantic import BaseModel
-from typing import Union, List
-from ul_api_utils.validators.custom_fields import QueryParamsSeparatedList
-
-
-class ModelStr(BaseModel):
-    param: QueryParamsSeparatedList[str]
-
-
-class ModelInt(BaseModel):
-    param: QueryParamsSeparatedList[int]
-
-
-@pytest.mark.parametrize(
-    "model, input_data, expected_output",
-    [
-        pytest.param(ModelStr, "first_array_element,second,third,this", ["first_array_element", "second", "third", "this"]),
-        pytest.param(ModelStr, ["first_array_element,second,third,this"], ["first_array_element", "second", "third", "this"]),
-        pytest.param(ModelInt, "1,2,3,4,5", [1, 2, 3, 4, 5]),
-        pytest.param(ModelInt, ["1,2,3,4,5"], [1, 2, 3, 4, 5]),
-        pytest.param(ModelStr, 'first_array_element,"second,third",this', ["first_array_element", "second,third", "this"]),
-        pytest.param(ModelStr, ['first_array_element,"second,third",this'], ["first_array_element", "second,third", "this"]),
-        pytest.param(ModelStr, '"first_array_element,second,third",this, "1,2"', ["first_array_element,second,third", "this", "1,2"]),
-    ],
-)
-def test__query_params_separated_list(
-    model: Union[ModelStr, ModelInt], input_data: Union[List[str], str], expected_output: List[Union[str, int]],
-) -> None:
-    instance = model(param=input_data)  # type: ignore
-    assert isinstance(instance.param, list)
-    assert instance.param == expected_output