ul-api-utils 9.0.0a6__tar.gz → 9.0.0a8__tar.gz

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/PKG-INFO

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

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/setup.py

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

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/api_resource/api_resource.py

@@ -16,8 +16,9 @@ from ul_api_utils.api_resource.api_resource_error_handling import WEB_EXCEPTION_
     ProcessingExceptionsParams, WEB_UNKNOWN_ERROR_PARAMS
 from ul_api_utils.api_resource.api_resource_fn_typing import ApiResourceFnTyping
 from ul_api_utils.api_resource.api_resource_type import ApiResourceType
-from ul_api_utils.api_resource.api_response import JsonApiResponse, HtmlApiResponse, FileApiResponse, JsonApiResponsePayload, EmptyJsonApiResponse, \
-    RedirectApiResponse, ProxyJsonApiResponse, RootJsonApiResponse
+from ul_api_utils.api_resource.api_response import JsonApiResponse, HtmlApiResponse, FileApiResponse, \
+    JsonApiResponsePayload, EmptyJsonApiResponse, \
+    RedirectApiResponse, ProxyJsonApiResponse, RootJsonApiResponse, RootJsonApiResponsePayload
 from ul_api_utils.conf import APPLICATION_ENV, APPLICATION_JWT_PUBLIC_KEY, APPLICATION_DEBUG
 from ul_api_utils.const import REQUEST_HEADER__X_FORWARDED_FOR, \
     RESPONSE_HEADER__WWW_AUTH, OOPS, REQUEST_HEADER__USER_AGENT
@@ -38,7 +39,7 @@ TPayload = TypeVar('TPayload')
 
 
 T = TypeVar('T')
-TResp = TypeVar('TResp', bound=JsonApiResponsePayload)
+TResp = TypeVar('TResp', bound=Union[JsonApiResponsePayload, RootJsonApiResponsePayload[Any]])
 
 
 class ApiResource:

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/api_resource/api_resource_fn_typing.py

@@ -2,7 +2,7 @@ import inspect
 from typing import NamedTuple, Any, Callable, Optional, List, Dict, Type, Tuple, TYPE_CHECKING, Union, get_origin, get_args
 
 from flask import request
-from pydantic import BaseModel, ValidationError, validate_call, TypeAdapter
+from pydantic import BaseModel, ValidationError, validate_call, TypeAdapter, RootModel
 from pydantic.v1.utils import deep_update
 from pydantic_core import ErrorDetails
 
@@ -25,7 +25,7 @@ if TYPE_CHECKING:
 FN_SYSTEM_PROPS = {"api_resource", "query", "body", "return", "body_validation_error", "query_validation_error"}
 
 
-def _is_complex_type(annotation):
+def _is_complex_type(annotation: Any) -> bool:
     origin = get_origin(annotation)
 
     # Optional[type_] is typing.Union
@@ -82,18 +82,18 @@ class ApiResourceFnTyping(NamedTuple):
 
         if self.request_body_optional:
             if self.request_body_many:
-                class BodyTypingOptList(BaseModel):
-                    __root__: Optional[List[body_typing]] = None  # type: ignore
+                class BodyTypingOptList(RootModel[List[body_typing] | None]):  # type: ignore
+                    pass
 
                 return BodyTypingOptList
 
-            class BodyTypingOpt(BaseModel):
-                __root__: Optional[body_typing] = None  # type: ignore
+            class BodyTypingOpt(RootModel[Optional[body_typing]]):  # type: ignore
+                pass
             return BodyTypingOpt
 
         if self.request_body_many:
-            class BodyTypingList(BaseModel):
-                __root__: List[body_typing]  # type: ignore
+            class BodyTypingList(RootModel[List[body_typing]]):  # type: ignore
+                pass
 
             return BodyTypingList
         return body_typing
@@ -165,8 +165,7 @@ class ApiResourceFnTyping(NamedTuple):
             return kwargs, errors
         body = self._get_body()
         try:
-            expected_typing: Type[BaseModel | List[BaseModel]] = List[self.body_typing] \
-                if self.request_body_many else self.body_typing
+            expected_typing: Type[BaseModel | List[BaseModel]] = List[self.body_typing] if self.request_body_many else self.body_typing  # type: ignore
             kwargs['body'] = TypeAdapter(expected_typing).validate_python(body)
         except ValidationError as ve:
             if self.has_body_validation_error:

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/api_resource/api_response.py

@@ -1,6 +1,5 @@
 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
@@ -64,8 +63,8 @@ class HtmlApiResponse(ApiResponse):
 
     @classmethod
     def _internal_use__mk_schema(cls, inner_type: Optional[Type[BaseModel]]) -> Type[BaseModel]:
-        class _ResponseNoneType(BaseModel):
-            __root__: NoneType  # type: ignore
+        class _ResponseNoneType(RootModel[None]):
+            pass
         return _ResponseNoneType
 
     def to_flask_response(self, debugger: Optional[Debugger] = None) -> BaseResponse:
@@ -100,8 +99,8 @@ class FileApiResponse(ApiResponse):
 
     @classmethod
     def _internal_use__mk_schema(cls, inner_type: Optional[Type[BaseModel]]) -> Type[BaseModel]:
-        class _ResponseNoneType(BaseModel):
-            __root__: NoneType  # type: ignore
+        class _ResponseNoneType(RootModel[None]):
+            pass
         return _ResponseNoneType
 
     def to_flask_response(self, debugger: Optional[Debugger] = None) -> BaseResponse:
@@ -125,8 +124,8 @@ class EmptyJsonApiResponse(ApiResponse):
 
     @classmethod
     def _internal_use__mk_schema(cls, inner_type: Optional[Type[BaseModel]]) -> Type[BaseModel]:
-        class _ResponseNoneType(BaseModel):
-            __root__: NoneType  # type: ignore
+        class _ResponseNoneType(RootModel[None]):
+            pass
         return _ResponseNoneType
 
     def to_flask_response(self, debugger: Optional[Debugger] = None) -> BaseResponse:
@@ -162,7 +161,7 @@ class DictJsonApiResponsePayload(RootJsonApiResponsePayload[Dict[str, Any]]):
     pass
 
 
-TProxyPayload = TypeVar('TProxyPayload', bound=Union[JsonApiResponsePayload, List[JsonApiResponsePayload], None])
+TProxyPayload = TypeVar('TProxyPayload', bound=Union[JsonApiResponsePayload, List[JsonApiResponsePayload], RootJsonApiResponsePayload[Any], List[RootJsonApiResponsePayload[Any]], None])
 
 
 class ProxyJsonApiResponse(Generic[TProxyPayload], EmptyJsonApiResponse):
@@ -193,8 +192,8 @@ class RootJsonApiResponse(Generic[TJsonObjApiResponsePayload], EmptyJsonApiRespo
 
     @classmethod
     def _internal_use__mk_schema(cls, inner_type: Optional[Type[BaseModel]]) -> Type[BaseModel]:
-        class _ResponseStd(BaseModel):
-            __root__: inner_type  # type: ignore
+        class _ResponseStd(RootModel[inner_type]):  # type: ignore
+            pass
         return _ResponseStd
 
     def to_flask_response(self, debugger: Optional[Debugger] = None) -> BaseResponse:

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/debug/debugger.py

@@ -79,7 +79,7 @@ class Debugger:
             return
 
         started_at = stat.get_request_started_at()
-        ended_at = time.time()
+        ended_at = time.perf_counter()
         name = self.name
 
         stats = stat.get_stat(code_spans=True, started_at=started_at, ended_at=ended_at)
@@ -90,7 +90,7 @@ class Debugger:
     def render_dict(self, status_code: int) -> Dict[str, Any]:
         if not collecting_enabled():
             return {}
-        stats = [st.unwrap() for st in stat.get_stat(started_at=stat.get_request_started_at(), ended_at=time.time())]
+        stats = [st.unwrap() for st in stat.get_stat(started_at=stat.get_request_started_at(), ended_at=time.perf_counter())]
 
         return {
             RESPONSE_PROP_DEBUG_STATS: stats,
@@ -107,7 +107,7 @@ class Debugger:
             return script
 
         started_at = stat.get_request_started_at()
-        ended_at = time.time()
+        ended_at = time.perf_counter()
 
         stats = stat.get_stat(code_spans=True, started_at=started_at, ended_at=ended_at)
 

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/debug/stat.py

@@ -18,7 +18,7 @@ INDENT = '    '
 
 
 def time_now() -> float:
-    return time.time()
+    return time.perf_counter()
 
 
 def mark_request_started() -> None:
@@ -439,11 +439,6 @@ def mk_stat_string(
     header = f'{IND}{" " * (i_size * 2 + 2)}{IND}Request{" " * MAX_LEN_OF_TYPE}{INDENT * max_lvl}{col_duration(started_at, ended_at, cm=cm)}{INDENT}{INDENT}{total_str}'
 
     short_identifier = uuid.uuid4().hex[:8]
-    started_dt = datetime.fromtimestamp(started_at)
-    ended_dt = datetime.fromtimestamp(ended_at)
-    date_str = f'{cm[C_FG_GRAY]}{started_dt.date().isoformat()}{cm[C_NC]}' \
-               f'{IND}{started_dt.strftime("%H:%M:%S")}{cm[C_FG_GRAY]}.{started_dt.microsecond // 1000:0<3}{cm[C_NC]}' \
-               f' - {ended_dt.strftime("%H:%M:%S")}{cm[C_FG_GRAY]}.{ended_dt.microsecond // 1000:0<3}{cm[C_NC]}'
-    return f'▀▀▀▀▀ {name} {cm[C_FG_GRAY]}{short_identifier}{cm[C_NC]}{IND}{date_str} {"▀" * 55}' \
+    return f'▀▀▀▀▀ {name} {cm[C_FG_GRAY]}{short_identifier}{cm[C_NC]}{IND}{"▀" * 55}' \
            f'\n{header}\n' \
            f'{result_s}▄▄▄▄▄ {name} {cm[C_FG_GRAY]}{short_identifier}{cm[C_NC]} {"▄" * 96}'

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/internal_api/internal_api.py

@@ -278,7 +278,7 @@ class InternalApi:
         ):
             return self._override[path][method](has_std_schema)
 
-        started_at = time.time()
+        started_at = time.perf_counter()
         q = ApiPathVersion.cleanup_q(q)
         url = f'{self._entry_point.rstrip("/")}{path}'
 

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/internal_api/internal_api_response.py

@@ -7,7 +7,7 @@ from typing import Any, Optional, List, Generic, Type, TypeVar, Union, Dict, Nam
 import requests
 from pydantic import ValidationError
 
-from ul_api_utils.api_resource.api_response import JsonApiResponsePayload
+from ul_api_utils.api_resource.api_response import JsonApiResponsePayload, RootJsonApiResponsePayload
 from ul_api_utils.api_resource.signature_check import set_model
 from ul_api_utils.const import RESPONSE_PROP_DEBUG_STATS, RESPONSE_PROP_PAYLOAD, RESPONSE_PROP_OK, RESPONSE_PROP_ERRORS, RESPONSE_PROP_TOTAL, RESPONSE_PROP_COUNT, MIME__JSON, \
     RESPONSE_HEADER__CONTENT_TYPE
@@ -18,7 +18,7 @@ from ul_api_utils.utils.api_format import ApiFormat
 from ul_api_utils.internal_api.internal_api_error import InternalApiResponseErrorObj
 from ul_api_utils.utils.unwrap_typing import UnwrappedOptionalObjOrListOfObj
 
-TPyloadType = TypeVar('TPyloadType', bound=Union[JsonApiResponsePayload, List[JsonApiResponsePayload], None])
+TPyloadType = TypeVar('TPyloadType', bound=Union[JsonApiResponsePayload, List[JsonApiResponsePayload], RootJsonApiResponsePayload[Any], List[RootJsonApiResponsePayload[Any]], None])
 TResp = TypeVar('TResp', bound='InternalApiResponse[Any]')
 
 
@@ -73,17 +73,17 @@ class InternalApiResponse(Generic[TPyloadType]):
 
         self._parsed_schema: Optional[InternalApiResponseSchema] = None
         self._parsed_json: Any = None
-        self._parsed_payload: Union[None, JsonApiResponsePayload, List[JsonApiResponsePayload]] = None
+        self._parsed_payload: Union[None, JsonApiResponsePayload, List[JsonApiResponsePayload], RootJsonApiResponsePayload[Any], List[RootJsonApiResponsePayload[Any]]] = None
 
         self._status_checked = False
         self._info = info
 
         if payload_type is not None:
-            self._payload_type = UnwrappedOptionalObjOrListOfObj.parse(payload_type, JsonApiResponsePayload)
+            self._payload_type = UnwrappedOptionalObjOrListOfObj.parse(payload_type, JsonApiResponsePayload) or UnwrappedOptionalObjOrListOfObj.parse(payload_type, RootJsonApiResponsePayload)
             if self._payload_type is None:
-                tn = JsonApiResponsePayload.__name__
+                tn1, tn2 = JsonApiResponsePayload.__name__, RootJsonApiResponsePayload.__name__
                 raise ValueError(
-                    f'payload_typing is invalid. must be Union[Type[{tn}], Optional[Type[{tn}]], List[Type[{tn}]], Optional[List[Type[{tn}]]]]. {payload_type} was given',
+                    f'payload_typing is invalid. must be Union[Type[{tn1} | {tn2}], Optional[Type[{tn1} | {tn2}]], List[Type[{tn1} | {tn2}]], Optional[List[Type[{tn1} | {tn2}]]]]. {payload_type} was given',
                 )
 
     def typed(self, payload_type: Type[TPyloadType]) -> 'InternalApiResponse[TPyloadType]':

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/modules/api_sdk.py

@@ -117,7 +117,7 @@ class ApiSdk:
 
         self._config = config
         self._routes_loaded = False
-        self._request_started_at = time.time()
+        self._request_started_at = time.perf_counter()
         self._initialized_flask_name: Optional[str] = None
         self._flask_app_cache: Optional[Flask] = None
         self._limiter_enabled = False

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/utils/flask_swagger_generator/specifiers/swagger_three_specifier.py

@@ -68,8 +68,8 @@ class SwaggerSchema(SwaggerModel):
             if '$ref' in json.dumps(json_schema):
                 while '$ref' in json.dumps(json_schema):
                     json_schema = replace_value_in_dict(json_schema.copy(), json_schema.copy())
-            if 'definitions' in json_schema:
-                del json_schema['definitions']
+            if '$defs' in json_schema:
+                del json_schema['$defs']
             self.type = json_schema['type']
             if json_schema['type'] == 'object':
                 self.properties = json_schema.get('properties', dict())
@@ -508,17 +508,29 @@ class SwaggerPath(SwaggerModel):
                     swagger_request_type.add_swagger_model(parameters)
                 query_schema = query_model.model_json_schema()
                 query_required_fields = set(query_schema.get('required')) if query_schema.get('required') is not None else set()
-                query_definitions = query_schema.get('definitions')
+                query_definitions = query_schema.get('$defs')
                 for parameter_name, parameter_spec in query_schema.get('properties').items():
-                    if parameter_spec.get('type') is not None:
-                        parameter_models.add(SwaggerQueryParameter(
-                            input_type=parameter_spec.get('type'),
-                            input_format=parameter_spec.get('format'),
-                            default_value=parameter_spec.get('default'),
-                            name=parameter_name,
-                            description=parameter_spec.get('description'),
-                            required=parameter_name in query_required_fields,
-                        ))
+                    if 'anyOf' in parameter_spec.keys():
+                        if parameter_spec.get('anyOf')[0].get('$ref') is not None:
+                            definition = query_definitions.get(parameter_spec.get('$ref', '').split('/')[-1], {})
+                            parameter_models.add(SwaggerQueryParameter(
+                                input_type=definition.get('type', 'string'),
+                                input_format=definition.get('format'),
+                                default_value=definition.get('default'),
+                                name=parameter_name,
+                                description=definition.get('description'),
+                                enum=definition.get('enum'),
+                                required=parameter_name in query_required_fields,
+                            ))
+                        if parameter_spec.get('anyOf')[0].get('type') is not None:
+                            parameter_models.add(SwaggerQueryParameter(
+                                input_type=parameter_spec.get('anyOf')[0].get('type'),
+                                input_format=parameter_spec.get('format'),
+                                default_value=parameter_spec.get('default'),
+                                name=parameter_name,
+                                description=parameter_spec.get('description'),
+                                required=parameter_name in query_required_fields,
+                            ))
                     elif parameter_spec.get('$ref') is not None:
                         definition = query_definitions.get(parameter_spec.get('$ref', '').split('/')[-1], {})
                         parameter_models.add(SwaggerQueryParameter(
@@ -530,6 +542,15 @@ class SwaggerPath(SwaggerModel):
                             enum=definition.get('enum'),
                             required=parameter_name in query_required_fields,
                         ))
+                    elif parameter_spec.get('type') is not None:
+                        parameter_models.add(SwaggerQueryParameter(
+                            input_type=parameter_spec.get('type') or parameter_spec.get('anyOf')[0].get('type'),
+                            input_format=parameter_spec.get('format'),
+                            default_value=parameter_spec.get('default'),
+                            name=parameter_name,
+                            description=parameter_spec.get('description'),
+                            required=parameter_name in query_required_fields,
+                        ))
                 if isinstance(parameters, SwaggerModel):
                     parameters.add_swagger_models(parameter_models)
                 elif isinstance(parameters, list):

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/utils/flask_swagger_generator/utils/replace_in_dict.py

@@ -5,7 +5,7 @@ def replace_value_in_dict(item: Union[List, Dict], original_schema):  # type: ig
     if isinstance(item, list):
         return [replace_value_in_dict(i, original_schema) for i in item]
     elif isinstance(item, dict):
-        if list(item.keys()) == ['$ref']:
+        if '$ref' in list(item.keys()):
             definitions = item['$ref'][2:].split('/')
             res = original_schema.copy()
             for definition in definitions:

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/utils/json_encoder.py

@@ -2,7 +2,7 @@ import dataclasses
 import decimal
 import json
 from base64 import b64encode
-from datetime import date, datetime
+from datetime import date, datetime, time
 from enum import Enum
 from json import JSONEncoder
 from typing import Dict, Any, Union, List, Optional, TYPE_CHECKING
@@ -66,6 +66,8 @@ class CustomJSONEncoder(JSONEncoder):
             return str(obj.isoformat())
         if isinstance(obj, date):
             return str(obj.isoformat())
+        if isinstance(obj, time):
+            return str(obj.isoformat())
         if isinstance(obj, UUID):
             return str(obj)
         if isinstance(obj, Enum):

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils/utils/unwrap_typing.py

@@ -2,6 +2,8 @@ from dataclasses import dataclass
 from types import NoneType
 from typing import NamedTuple, Type, Tuple, _GenericAlias, _UnionGenericAlias, Any, Union, Optional, TypeVar, Generic, Callable  # type: ignore
 
+from ul_api_utils.api_resource.api_response import RootJsonApiResponsePayload
+
 
 class TypingType(NamedTuple):
     value: Type[Any]
@@ -47,6 +49,7 @@ def unwrap_typing(t: Type[Any]) -> Union[TypingGeneric, TypingUnion, TypingType,
 
 T = TypeVar('T')
 TVal = TypeVar('TVal')
+TValRoot = TypeVar('TValRoot', bound=RootJsonApiResponsePayload[Any])
 
 
 def default_constructor(value_type: Type[TVal], data: Any) -> TVal:
@@ -72,7 +75,7 @@ class UnwrappedOptionalObjOrListOfObj(Generic[TVal]):
         return constructor(self.value_type, payload)  # type: ignore
 
     @staticmethod
-    def parse(t: Type[Any], type_constraint: Optional[Type[TVal]]) -> 'Optional[UnwrappedOptionalObjOrListOfObj[TVal]]':
+    def parse(t: Type[Any], type_constraint: Optional[Type[TVal | TValRoot]]) -> 'Optional[UnwrappedOptionalObjOrListOfObj[TVal]]':
         unwrapped_t = unwrap_typing(t)
 
         many = False

ul-api-utils-9.0.0a8/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-9.0.0a8/ul_api_utils/validators/custom_fields.py

@@ -0,0 +1,66 @@
+import csv
+from typing import TypeVar, Generic, List, Union, Annotated, Any, get_args
+from uuid import UUID
+
+from pydantic import Field, StringConstraints, BeforeValidator
+
+from ul_api_utils.const import CRON_EXPRESSION_VALIDATION_REGEX, MIN_UTC_OFFSET_SECONDS, MAX_UTC_OFFSET_SECONDS
+
+NotEmptyListAnnotation = Annotated[list[Any], Field(min_length=1)]
+NotEmptyListStrAnnotation = Annotated[list[str], Field(min_length=1)]
+NotEmptyListIntAnnotation = Annotated[list[int], Field(min_length=1)]
+NotEmptyListUUIDAnnotation = Annotated[list[UUID], Field(min_length=1)]
+CronScheduleAnnotation = Annotated[str, StringConstraints(pattern=CRON_EXPRESSION_VALIDATION_REGEX)]
+WhiteSpaceStrippedStrAnnotation = Annotated[str, StringConstraints(strip_whitespace=True)]
+UTCOffsetSecondsAnnotation = Annotated[int, Field(ge=MIN_UTC_OFFSET_SECONDS, le=MAX_UTC_OFFSET_SECONDS)]
+PgTypePasswordStrAnnotation = Annotated[str, StringConstraints(min_length=6, max_length=72)]
+PgTypeShortStrAnnotation = Annotated[str, StringConstraints(min_length=0, max_length=255)]
+PgTypeLongStrAnnotation = Annotated[str, StringConstraints(min_length=0, max_length=1000)]
+PgTypeInt16Annotation = Annotated[int, Field(ge=-32768, le=32768)]
+PgTypePositiveInt16Annotation = Annotated[int, Field(ge=0, le=32768)]
+PgTypeInt32Annotation = Annotated[int, Field(ge=-2147483648, le=2147483648)]
+PgTypePositiveInt32Annotation = Annotated[int, Field(ge=0, le=2147483648)]
+PgTypeInt64Annotation = Annotated[int, Field(ge=-9223372036854775808, le=9223372036854775808)]
+PgTypePositiveInt64Annotation = Annotated[int, Field(ge=0, le=9223372036854775808)]
+
+
+QueryParamsSeparatedListValueType = TypeVar('QueryParamsSeparatedListValueType')
+
+
+def validate_query_params(value: Union[str, List[str]], type_: type) -> List[QueryParamsSeparatedListValueType]:
+    def process_item(item: str) -> QueryParamsSeparatedListValueType:
+        return type_(item.strip())
+
+    if isinstance(value, list):
+        result: list[QueryParamsSeparatedListValueType] = []
+        for item in value:
+            if isinstance(item, str):
+                reader = csv.reader([item], skipinitialspace=True)
+                result.extend(process_item(sub_item) for row in reader for sub_item in row)
+            else:
+                raise ValueError("List items must be strings")
+    elif isinstance(value, str):
+        reader = csv.reader([value], skipinitialspace=True)
+        result = [process_item(item) for row in reader for item in row]
+    else:
+        raise ValueError("Value must be a string or a list of strings")
+
+    return result
+
+
+class QueryParamsSeparatedList(Generic[QueryParamsSeparatedListValueType]):
+    def __init__(self, value: Union[str, List[str]]):
+        self._values: List[QueryParamsSeparatedListValueType] = validate_query_params(value)
+
+    def to_list(self) -> List[QueryParamsSeparatedListValueType]:
+        return list(self._values)
+
+    @classmethod
+    def __get_pydantic_core_schema__(cls, source_type: type, handler: Any) -> Any:
+        inner_type = get_args(source_type)[0]
+        return handler(
+            Annotated[
+                List[inner_type],  # type: ignore
+                BeforeValidator(lambda x: validate_query_params(x, inner_type))
+            ]
+        )

{ul-api-utils-9.0.0a6 → ul-api-utils-9.0.0a8}/ul_api_utils.egg-info/PKG-INFO

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

ul-api-utils-9.0.0a6/ul_api_utils/validators/__tests__/test_custom_fields.py

@@ -1,32 +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(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-9.0.0a6/ul_api_utils/validators/custom_fields.py

@@ -1,84 +0,0 @@
-import csv
-from typing import TypeVar, Generic, List, Union, Generator, Callable, Annotated, Any
-from uuid import UUID
-
-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
-
-NotEmptyListAnnotation = Annotated[list[Any], Field(min_length=1)]
-NotEmptyListStrAnnotation = Annotated[list[str], Field(min_length=1)]
-NotEmptyListIntAnnotation = Annotated[list[int], Field(min_length=1)]
-NotEmptyListUUIDAnnotation = Annotated[list[UUID], Field(min_length=1)]
-CronScheduleAnnotation = Annotated[str, StringConstraints(pattern=CRON_EXPRESSION_VALIDATION_REGEX)]
-WhiteSpaceStrippedStrAnnotation = Annotated[str, StringConstraints(strip_whitespace=True)]
-UTCOffsetSecondsAnnotation = Annotated[int, Field(ge=MIN_UTC_OFFSET_SECONDS, le=MAX_UTC_OFFSET_SECONDS)]
-PgTypePasswordStrAnnotation = Annotated[str, StringConstraints(min_length=6, max_length=72)]
-PgTypeShortStrAnnotation = Annotated[str, StringConstraints(min_length=0, max_length=255)]
-PgTypeLongStrAnnotation = Annotated[str, StringConstraints(min_length=0, max_length=1000)]
-PgTypeInt16Annotation = Annotated[int, Field(ge=-32768, le=32768)]
-PgTypePositiveInt16Annotation = Annotated[int, Field(ge=0, le=32768)]
-PgTypeInt32Annotation = Annotated[int, Field(ge=-2147483648, le=2147483648)]
-PgTypePositiveInt32Annotation = Annotated[int, Field(ge=0, le=2147483648)]
-PgTypeInt64Annotation = Annotated[int, Field(ge=-9223372036854775808, le=9223372036854775808)]
-PgTypePositiveInt64Annotation = Annotated[int, Field(ge=0, le=9223372036854775808)]
-
-
-QueryParamsSeparatedListValueType = TypeVar('QueryParamsSeparatedListValueType')
-
-
-class QueryParamsSeparatedList(Generic[QueryParamsSeparatedListValueType]):
-    """
-    Supports cases when query parameters are being sent as a string, but you have to assume
-    that it is a list.
-
-    F.E. Query string is ?foo=1,2
-
-    Note:
-        Sent as a string, but interpreted as List.
-    """
-    _contains_type: Any = None
-
-    @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]:
-        yield cls.validate
-
-    @classmethod
-    def validate(cls, query_param: Union[List[str], str], info: ValidationInfo) -> List[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)
-
-        validated_items = []
-        errors: List[InitErrorDetails] = []
-
-        for idx, value in enumerate(splitted):
-            try:
-                validated_items.append(adapter.validate_python(value))
-            except ValidationError as e:
-                for error in e.errors(include_url=False):
-                    error['loc'] = ('param', idx)
-                    errors.append(error)  # type: ignore
-
-        if errors:
-            raise ValidationError.from_exception_data("List validation error", errors)
-
-        return validated_items