ul-api-utils 8.1.19__tar.gz → 8.1.21__tar.gz

{ul-api-utils-8.1.19 → ul-api-utils-8.1.21}/PKG-INFO

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

{ul-api-utils-8.1.19 → ul-api-utils-8.1.21}/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.19',
+    version='8.1.21',
     description='Python api utils',
     author='Unic-lab',
     long_description=long_description,
@@ -66,7 +66,7 @@ setup(
         "cryptography==38.0.1",
         "colored==1.4.3",
         "flask-socketio==5.3.6",
-        "ormsgpack==1.4.1",
+        "ormsgpack==1.8.0",
         "msgpack==1.0.4",
         "msgpack-types==0.2.0",
         "fastavro==1.7.0",

{ul-api-utils-8.1.19 → ul-api-utils-8.1.21}/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,7 +508,7 @@ 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(

{ul-api-utils-8.1.19 → ul-api-utils-8.1.21}/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-8.1.21/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.21/ul_api_utils/validators/custom_fields.py

@@ -0,0 +1,60 @@
+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]):
+    @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-8.1.19 → ul-api-utils-8.1.21}/ul_api_utils.egg-info/PKG-INFO

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

{ul-api-utils-8.1.19 → ul-api-utils-8.1.21}/ul_api_utils.egg-info/requires.txt

@@ -16,7 +16,7 @@ requests==2.28.1
 cryptography==38.0.1
 colored==1.4.3
 flask-socketio==5.3.6
-ormsgpack==1.4.1
+ormsgpack==1.8.0
 msgpack==1.0.4
 msgpack-types==0.2.0
 fastavro==1.7.0

ul-api-utils-8.1.19/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-8.1.19/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