ul-api-utils 8.1.16__py3-none-any.whl → 8.1.17__py3-none-any.whl

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/api_resource/api_resource_fn_typing.py

@@ -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
@@ -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
             kwargs['body'] = TypeAdapter(expected_typing).validate_python(body)
         except ValidationError as ve:
             if self.has_body_validation_error:

ul_api_utils/api_resource/api_response.py

@@ -168,7 +168,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):

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/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-8.1.16.dist-info → ul_api_utils-8.1.17.dist-info}/METADATA

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

{ul_api_utils-8.1.16.dist-info → ul_api_utils-8.1.17.dist-info}/RECORD

@@ -26,12 +26,12 @@ ul_api_utils/sentry.py,sha256=UH_SwZCAoKH-Nw5B9CVQMoF-b1BJOp-ZTzwqUZ3Oq84,1801
 ul_api_utils/access/__init__.py,sha256=NUyRNvCVwfePrfdn5ATFVfHeSO3iq4-Syeup4IAZGzs,4526
 ul_api_utils/api_resource/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ul_api_utils/api_resource/api_request.py,sha256=6Ag2trKIkenhYYPU2--hnfNJC5lLgBxVQ7jXj5D1eXM,3303
-ul_api_utils/api_resource/api_resource.py,sha256=j-E8KJiXWS1L0oVIerJZlbGpDL2ijlQrck4GrJPWPyE,17840
+ul_api_utils/api_resource/api_resource.py,sha256=ERAGC4rrN_jmZ_dFhYZZ_Eczqdy5tQK7cfN7SY4sIfA,17914
 ul_api_utils/api_resource/api_resource_config.py,sha256=l9OYJy75UZLshOkEQDO5jlhXeb5H4HDPu-nLOjuoexw,769
 ul_api_utils/api_resource/api_resource_error_handling.py,sha256=E0SWpjFSIP-4SumbgzrHtFuFiGe9q38WsvLROt0YcPE,1168
-ul_api_utils/api_resource/api_resource_fn_typing.py,sha256=n5bux_azlV8aRtRQdoIP553tXWHCi7P-brKUAgj502E,18970
+ul_api_utils/api_resource/api_resource_fn_typing.py,sha256=2jTHmcTeTZBpYc-LZ1wcT1YfM8NaifBBo1Bhs_uP6zw,18965
 ul_api_utils/api_resource/api_resource_type.py,sha256=mgjSQI3swGpgpLI6y35LYtFrdN-kXyV5cQorwGW7h6g,462
-ul_api_utils/api_resource/api_response.py,sha256=bfnWo5GZUCzwJm8rDfzcpuYL4l63pBedJ0tTguP--qw,10069
+ul_api_utils/api_resource/api_response.py,sha256=DYKqNI8xbXIMBCn-GmZx24Bsr7SBgKQDtGU2nbw3p6Q,10141
 ul_api_utils/api_resource/api_response_db.py,sha256=ucY6ANPlHZml7JAbvq-PL85z0bvERTjEJKvz-REPyok,888
 ul_api_utils/api_resource/api_response_payload_alias.py,sha256=FoD0LhQGZ2T8A5-VKRX5ADyzSgm7_dd3qxU2BgCVXkA,587
 ul_api_utils/api_resource/db_types.py,sha256=gF0oxisRkYLf7_2e7YEU-HJDxLy3dJCVaJsYQbOfG5k,433
@@ -60,7 +60,7 @@ ul_api_utils/internal_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJW
 ul_api_utils/internal_api/internal_api.py,sha256=gLlz4TYDgrmEF8S2XpNCKgAjLHsd21vs75kppHLoG6A,14067
 ul_api_utils/internal_api/internal_api_check_context.py,sha256=FJyYuyhp7AzvKSoyNrszw6vtUanSUKNNcDmlNH-UDI4,1709
 ul_api_utils/internal_api/internal_api_error.py,sha256=sdm3V2VLSfFVBmxaeo2Wy2wkhmxWTXGsCCR-u08ChMg,471
-ul_api_utils/internal_api/internal_api_response.py,sha256=rNAqY82ezupcRSnWY1YO2T5QhwfOFrak0dp23shgUxY,11583
+ul_api_utils/internal_api/internal_api_response.py,sha256=TyS7iLbvTFb0oAcElK3fUAB5jNGQDtiJUrESn5BTTHM,11917
 ul_api_utils/internal_api/__tests__/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ul_api_utils/internal_api/__tests__/internal_api.py,sha256=X2iopeso6vryszeeA__lcqXQVtz3Nwt3ngH7M4OuN1U,1116
 ul_api_utils/internal_api/__tests__/internal_api_content_type.py,sha256=mfiYPkzKtfZKFpi4RSnWAoCd6mRijr6sFsa2TF-s5t8,749
@@ -115,7 +115,7 @@ ul_api_utils/utils/json_encoder.py,sha256=ra43WhkAadIvVpUY3uik_Nzg0LVXUXTGYvx4Gx
 ul_api_utils/utils/load_modules.py,sha256=_CPmQuB6o_33FE6zFl_GyO5xS5gmjfNffB6k-cglKAA,685
 ul_api_utils/utils/token_check.py,sha256=-Quuh8gOs9fNE1shYhdiMpQedafsLN7MB2ilSxG_F8E,489
 ul_api_utils/utils/token_check_through_request.py,sha256=OyyObu6Btk9br7auIYvWcMULhNznNSD5T0mWOwZX7Uk,663
-ul_api_utils/utils/unwrap_typing.py,sha256=19jyhkRcb89v1gzR62YDsMO9zxR2PU5bjYZm1is8Aoo,4189
+ul_api_utils/utils/unwrap_typing.py,sha256=uObDLxYcRni6ieN9FuvWTa350HjSUIpgTb7FrIUzsVI,4349
 ul_api_utils/utils/uuid_converter.py,sha256=OZMuySkoALrQQOe312_BHVWN20Sz5frKuH9KYziAGsU,565
 ul_api_utils/utils/__tests__/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ul_api_utils/utils/__tests__/api_path_version.py,sha256=n7VFVdwFqP_FS6PE3OUCS68oU3tG78xM4HxrKShLhNw,898
@@ -148,9 +148,9 @@ ul_api_utils/validators/validate_empty_object.py,sha256=3Ck_iwyJE_M5e7l6s1i88aqb
 ul_api_utils/validators/validate_uuid.py,sha256=EfvlRirv2EW0Z6w3s8E8rUa9GaI8qXZkBWhnPs8NFrA,257
 ul_api_utils/validators/__tests__/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ul_api_utils/validators/__tests__/test_custom_fields.py,sha256=20gLlnm1Ithsbbz3NIUXVAd92lW6YwVRSg_nETZhfaI,1442
-ul_api_utils-8.1.16.dist-info/LICENSE,sha256=6Qo8OdcqI8aGrswJKJYhST-bYqxVQBQ3ujKdTSdq-80,1062
-ul_api_utils-8.1.16.dist-info/METADATA,sha256=g3CCq5zlTMjyZp7D7BVWG7WyY6IY7M1KoSHNSnCkSHU,14748
-ul_api_utils-8.1.16.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-ul_api_utils-8.1.16.dist-info/entry_points.txt,sha256=8tL3ySHWTyJMuV1hx1fHfN8zumDVOCOm63w3StphkXg,53
-ul_api_utils-8.1.16.dist-info/top_level.txt,sha256=1XsW8iOSFaH4LOzDcnNyxHpHrbKU3fSn-aIAxe04jmw,21
-ul_api_utils-8.1.16.dist-info/RECORD,,
+ul_api_utils-8.1.17.dist-info/LICENSE,sha256=6Qo8OdcqI8aGrswJKJYhST-bYqxVQBQ3ujKdTSdq-80,1062
+ul_api_utils-8.1.17.dist-info/METADATA,sha256=sErifyqu-OT3p_wAZzWuKVGN8TM7q3SZnN9hq5LvHtg,14748
+ul_api_utils-8.1.17.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+ul_api_utils-8.1.17.dist-info/entry_points.txt,sha256=8tL3ySHWTyJMuV1hx1fHfN8zumDVOCOm63w3StphkXg,53
+ul_api_utils-8.1.17.dist-info/top_level.txt,sha256=1XsW8iOSFaH4LOzDcnNyxHpHrbKU3fSn-aIAxe04jmw,21
+ul_api_utils-8.1.17.dist-info/RECORD,,