ul-api-utils 7.8.0__py3-none-any.whl → 7.8.3__py3-none-any.whl

example/conf.py

@@ -16,6 +16,7 @@ sdk = ApiSdk(ApiSdkConfig(
     flask_debugging_plugins=ApiSdkFlaskDebuggingPluginsEnabled(
         flask_monitoring_dashboard=True,
     ),
+    web_error_template='error.html.jinja2',
 ))
 
 

example/routes/api_some.py

@@ -12,7 +12,8 @@ from example.permissions import SOME_PERMISSION, SOME_PERMISSION2
 from ul_api_utils.api_resource.api_request import ApiRequestQuery
 from ul_api_utils.api_resource.api_resource import ApiResource
 from ul_api_utils.api_resource.api_resource_config import ApiResourceConfig
-from ul_api_utils.api_resource.api_response import FileApiResponse, JsonApiResponsePayload, JsonApiResponse, AnyJsonApiResponse, ProxyJsonApiResponse, HtmlApiResponse
+from ul_api_utils.api_resource.api_response import FileApiResponse, JsonApiResponsePayload, JsonApiResponse, \
+    AnyJsonApiResponse, ProxyJsonApiResponse, HtmlApiResponse, EmptyJsonApiResponse
 from ul_api_utils.errors import Server5XXInternalApiError, NoResultFoundApiError, Client4XXInternalApiError
 from ul_api_utils.internal_api.internal_api import InternalApi
 from ul_api_utils.utils.api_encoding import ApiEncoding
@@ -224,6 +225,17 @@ def override(api_resource: ApiResource) -> JsonApiResponse[RespObject]:
     return api_resource.response_ok(RespObject(now=datetime.now()))
 
 
+@sdk.rest_api('GET', '/example-resource-empty', access=sdk.ACCESS_PUBLIC)
+def empty_resp_test(api_resource: ApiResource) -> EmptyJsonApiResponse:
+    return api_resource.response_empty_ok()
+
+
+@sdk.rest_api('POST', '/example-resource-empty-check', access=sdk.ACCESS_PUBLIC)
+def empty_resp_req_test(api_resource: ApiResource) -> EmptyJsonApiResponse:
+    internal_api.request_get('/example-resource-empty').check()
+    return api_resource.response_empty_ok()
+
+
 @sdk.rest_api('POST', '/example-resource-empty-gzip', access=sdk.ACCESS_PUBLIC)
 def some12(api_resource: ApiResource, body: List[SomeBody]) -> JsonApiResponse[RespObject]:
     sess = db.session()

ul_api_utils/api_resource/api_resource.py

@@ -12,6 +12,8 @@ from werkzeug.datastructures import FileStorage
 
 from ul_api_utils.access import GLOBAL_PERMISSION__PUBLIC, PermissionDefinition, GLOBAL_PERMISSION__PRIVATE_RT, GLOBAL_PERMISSION__PRIVATE
 from ul_api_utils.api_resource.api_resource_config import ApiResourceConfig
+from ul_api_utils.api_resource.api_resource_error_handling import WEB_EXCEPTION_HANDLING_PARAMS__MAP, \
+    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, \
@@ -20,7 +22,8 @@ from ul_api_utils.conf import APPLICATION_ENV, APPLICATION_JWT_PUBLIC_KEY, APPLI
 from ul_api_utils.const import REQUEST_HEADER__X_FORWARDED_FOR, \
     RESPONSE_HEADER__WWW_AUTH, OOPS, REQUEST_HEADER__USER_AGENT
 from ul_api_utils.errors import ValidationListApiError, AccessApiError, NoResultFoundApiError, PermissionDeniedApiError, \
-    SimpleValidateApiError, ValidateApiError, HasAlreadyExistsApiError, AbstractInternalApiError, InvalidContentTypeError
+    SimpleValidateApiError, ValidateApiError, HasAlreadyExistsApiError, AbstractInternalApiError, \
+    InvalidContentTypeError
 from ul_api_utils.internal_api.internal_api_response import InternalApiResponse
 from ul_api_utils.modules.api_sdk_config import ApiSdkConfig
 from ul_api_utils.modules.api_sdk_jwt import ApiSdkJwt, JWT_VERSION
@@ -88,6 +91,9 @@ class ApiResource:
         self._limiter_enabled = limiter_enabled
         self._db_initialized = db_initialized
 
+    def __repr__(self) -> str:
+        return f"ApiResource object. Type: {self._type}, Function: {self._fn_typing.fn.__name__}"
+
     @property
     def debugger_enabled(self) -> bool:
         return self._debugger_enabled
@@ -208,30 +214,51 @@ class ApiResource:
 
         return JsonApiResponse._internal_use_response_error(self._fn_typing.response_payload_many, 500, [self._mk_error("system-error", str(err))])
 
-    def response_web_error(self, err: Exception) -> HtmlApiResponse:
-        if isinstance(err, PermissionDeniedApiError):
-            resp = HtmlApiResponse(error=err, content=f"403 Access Not Permitted. {str(err)}", ok=False, status_code=403)
-            if self.method != ApiMethod.OPTIONS and self._config.http_auth is not None:
-                resp.headers[RESPONSE_HEADER__WWW_AUTH] = f'{self._config.http_auth.scheme} realm="{self._config.http_auth.realm}"'
-            return resp
-        if isinstance(err, AccessApiError):
-            resp = HtmlApiResponse(error=err, content=f"401 Invalid Token. {str(err)}", ok=False, status_code=401)
+    def _generate_web_error_response(
+        self,
+        happened_exception: Exception,
+        default_status_code: int,
+        error_message: str,
+        apply_auth_headers: bool = False,
+    ) -> HtmlApiResponse:
+        if hasattr(happened_exception, "status_code"):
+            default_status_code = happened_exception.status_code  # type: ignore
+        assert self._config.web_error_template is not None  # only for mypy
+        response = HtmlApiResponse(
+            content=self.render_template(
+                self._config.web_error_template,
+                {
+                    "error_traceback": happened_exception,
+                    "error_message": error_message,
+                    "status_code": default_status_code,
+                },
+            ),
+            ok=False,
+            status_code=default_status_code,
+        )
+        if apply_auth_headers:
             if self.method != ApiMethod.OPTIONS and self._config.http_auth is not None:
-                resp.headers[RESPONSE_HEADER__WWW_AUTH] = f'{self._config.http_auth.scheme} realm="{self._config.http_auth.realm}"'
-            return resp
-        if isinstance(err, ValidateApiError):
-            return HtmlApiResponse(error=err, content="400 Invalid Request\n Request validation error", ok=False, status_code=400)
+                response.headers[RESPONSE_HEADER__WWW_AUTH] = f'{self._config.http_auth.scheme} realm="{self._config.http_auth.realm}"'
+            return response
+        return response
+
+    def response_web_error(self, err: Exception) -> HtmlApiResponse:
+        if self._config.web_error_template is None:
+            return HtmlApiResponse(error=err, content=OOPS, ok=False, status_code=500)
 
         if self._db_initialized:
             from sqlalchemy.exc import NoResultFound as NoResultFoundError
 
-            if isinstance(err, NoResultFoundError):
-                if self._config.not_found_template is None:
-                    return HtmlApiResponse(error=err, content="404 Not Found", ok=False, status_code=404)
-                return HtmlApiResponse(error=err, content=self.render_template(self._config.not_found_template, {}), ok=False, status_code=404)
-        if self._config.not_found_template is None:
-            return HtmlApiResponse(error=err, content=OOPS, ok=False, status_code=500)
-        return HtmlApiResponse(error=err, content=OOPS, ok=False, status_code=500)
+            WEB_EXCEPTION_HANDLING_PARAMS__MAP[NoResultFoundError] = ProcessingExceptionsParams(default_status_code=404, error_message="Not found")
+
+        error_response_params = WEB_EXCEPTION_HANDLING_PARAMS__MAP.get(type(err), WEB_UNKNOWN_ERROR_PARAMS)
+
+        return self._generate_web_error_response(
+            happened_exception=err,
+            default_status_code=error_response_params.default_status_code,
+            error_message=error_response_params.error_message,
+            apply_auth_headers=error_response_params.apply_auth_headers,
+        )
 
     def render_template(self, template_name: str, data: Dict[str, Any]) -> str:
         return render_template(

ul_api_utils/api_resource/api_resource_error_handling.py

@@ -0,0 +1,21 @@
+from typing import NamedTuple, Dict, Type
+
+from ul_api_utils.errors import PermissionDeniedApiError, AccessApiError, ValidateApiError, \
+    Server5XXInternalApiError, Client4XXInternalApiError
+
+
+class ProcessingExceptionsParams(NamedTuple):
+    default_status_code: int
+    error_message: str
+    apply_auth_headers: bool = False
+
+
+WEB_EXCEPTION_HANDLING_PARAMS__MAP: Dict[Type[Exception], ProcessingExceptionsParams] = {
+    PermissionDeniedApiError: ProcessingExceptionsParams(default_status_code=403, error_message="Access not permitted", apply_auth_headers=True),
+    AccessApiError: ProcessingExceptionsParams(default_status_code=401, error_message="Invalid token", apply_auth_headers=True),
+    ValidateApiError: ProcessingExceptionsParams(default_status_code=400, error_message="Request validation error"),
+    Server5XXInternalApiError: ProcessingExceptionsParams(default_status_code=500, error_message="Server error"),
+    Client4XXInternalApiError: ProcessingExceptionsParams(default_status_code=400, error_message="Request validation error"),
+}
+
+WEB_UNKNOWN_ERROR_PARAMS = ProcessingExceptionsParams(default_status_code=500, error_message="Unknown error")

ul_api_utils/api_resource/api_resource_fn_typing.py

@@ -154,7 +154,8 @@ class ApiResourceFnTyping(NamedTuple):
             return kwargs, errors
         body = self._get_body()
         try:
-            kwargs['body'] = [set_model(self.body_typing, fields) for fields in _body_list(body)] if self.request_body_many else set_model(self.body_typing, body)  # type: ignore
+            expected_typing: Type[BaseModel | List[BaseModel]] = List[self.body_typing] if self.request_body_many else self.body_typing      # type: ignore
+            kwargs['body'] = parse_obj_as(expected_typing, body)
         except ValidationError as ve:
             if self.has_body_validation_error:
                 kwargs['body_validation_error'] = ve

ul_api_utils/modules/api_sdk_config.py

@@ -42,7 +42,7 @@ class ApiSdkConfig(BaseModel):
 
     static_url_path: Optional[str] = None
 
-    not_found_template: Optional[str] = None
+    web_error_template: Optional[str] = None
 
     rate_limit: Union[str, List[str]] = '100/minute'  # [count (int)] [per|/] [second|minute|hour|day|month|year][s]
     rate_limit_storage_uri: str = ''  # supports url of redis, memcached, mongodb

{ul_api_utils-7.8.0.dist-info → ul_api_utils-7.8.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-api-utils
-Version: 7.8.0
+Version: 7.8.3
 Summary: Python api utils
 Author: Unic-lab
 Author-email: 
@@ -41,6 +41,8 @@ Requires-Dist: sentry-sdk[flask] (==1.9.2)
 Requires-Dist: types-requests (==2.28.8)
 Requires-Dist: types-jinja2 (==2.11.9)
 Requires-Dist: werkzeug (==2.3.7)
+Requires-Dist: wtforms (==3.0.1)
+Requires-Dist: wtforms-alchemy (==0.18.0)
 
 # Generic library api-utils
 

{ul_api_utils-7.8.0.dist-info → ul_api_utils-7.8.3.dist-info}/RECORD

@@ -1,12 +1,12 @@
 example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-example/conf.py,sha256=WPMSjEdxkxp7Vnwc-zBJrX3dE2KfbSMegsIiHktbY-M,844
+example/conf.py,sha256=QrffEnJInUeL38I4hzg2ft-Lczzq4yCLVBqWEeZ4MLs,888
 example/main.py,sha256=8jOO1VliFr92UoCLDInzSDPRLluzPuO-MMkzHc5Xd2w,419
 example/permissions.py,sha256=i8_zOOPdra3oMXZfyTspewRYNdn21PCqOD1ATG69Itk,277
 example/pure_flask_example.py,sha256=A7cbcjTr28FS1sVNAsQbj1N9EgEFIXDB4aRwOV6_tbU,1329
 example/rate_limit_load.py,sha256=U2Bgp8UztT4TNKdv9NVioxWfE68aCsC7uKz7xPCy6XM,225
 example/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 example/routes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-example/routes/api_some.py,sha256=d_X3828IZFs7EAKcP_lX9hHRZaaOQw1XoehDU3ZHcnI,12232
+example/routes/api_some.py,sha256=Lo4lXeLuXwZ_XJP6PnZ5QQCU8OzpyyDP_NU5zY1pbPM,12719
 example/workers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 example/workers/worker.py,sha256=flMYq50OhLtNSaA2qyDJSMeXSNXIqhdBIsaxcmO5-xQ,681
 ul_api_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -19,9 +19,10 @@ ul_api_utils/sentry.py,sha256=UH_SwZCAoKH-Nw5B9CVQMoF-b1BJOp-ZTzwqUZ3Oq84,1801
 ul_api_utils/access/__init__.py,sha256=OD2UnvAi8ax40B_5JlaW2IAcOcZzk2Y15h8Xi_wEa0g,4526
 ul_api_utils/api_resource/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ul_api_utils/api_resource/api_request.py,sha256=psVfLJqapV4PBL3YF0Bj22T3PDcCWQME87chtGBH3pw,3279
-ul_api_utils/api_resource/api_resource.py,sha256=YPVkj2PMGdTEoY4GYKsS0CFrImTyY9IQuTGTs6SxwrU,17185
+ul_api_utils/api_resource/api_resource.py,sha256=mUaFWxYBfHemcM2SaBQBOtTb4T4fbvZ4CNmE2GwPtOg,17766
 ul_api_utils/api_resource/api_resource_config.py,sha256=_B7DNe5eLbRw0Spy1y5CatXjlz5M3wqgYIjnJemlY44,760
-ul_api_utils/api_resource/api_resource_fn_typing.py,sha256=_cIr115JuRBi9kmFmiTm4jP9sHJ0bNbUlaRzWODcruI,18182
+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=OrmVFSuvqER5FwlhA6N6iaO3N99iPfTapBv_X_6xcbo,18224
 ul_api_utils/api_resource/api_resource_type.py,sha256=mgjSQI3swGpgpLI6y35LYtFrdN-kXyV5cQorwGW7h6g,462
 ul_api_utils/api_resource/api_response.py,sha256=jb5mKjouupDmctzPb2b7Z9_dpWVuxUHxVSevz-8sODI,9676
 ul_api_utils/api_resource/api_response_db.py,sha256=ucY6ANPlHZml7JAbvq-PL85z0bvERTjEJKvz-REPyok,888
@@ -57,7 +58,7 @@ ul_api_utils/internal_api/__tests__/internal_api.py,sha256=X2iopeso6vryszeeA__lc
 ul_api_utils/internal_api/__tests__/internal_api_content_type.py,sha256=mfiYPkzKtfZKFpi4RSnWAoCd6mRijr6sFsa2TF-s5t8,749
 ul_api_utils/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ul_api_utils/modules/api_sdk.py,sha256=mnb3wOuM0xHyOiG3WGgrNYp0sLDWVft6vLOlp5FGdWo,25074
-ul_api_utils/modules/api_sdk_config.py,sha256=cKQhIuEaLp4o9UVA4fmnR4QuEZPO9pqEjs_Xqgk8Mlw,2042
+ul_api_utils/modules/api_sdk_config.py,sha256=ANxsbzVHYoZPoeBM5oKsYwnvxpl9VVocmPkoL_mwyK4,2042
 ul_api_utils/modules/api_sdk_jwt.py,sha256=2XRfb0LxHUnldSL67S60v1uyoDpVPNaq4zofUtkeg88,15112
 ul_api_utils/modules/intermediate_state.py,sha256=7ZZ3Sypbb8LaSfrVhaXaWRDnj8oyy26NUbmFK7vr-y4,1270
 ul_api_utils/modules/worker_context.py,sha256=jGjopeuYuTtIDmsrqK7TcbTD-E81t8OWvWS1JpTC6b0,802
@@ -133,9 +134,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=QLZ7DFta01Z7DOK9Z5Iq4uf_CmvDkVReis-GAl_QN48,1447
-ul_api_utils-7.8.0.dist-info/LICENSE,sha256=6Qo8OdcqI8aGrswJKJYhST-bYqxVQBQ3ujKdTSdq-80,1062
-ul_api_utils-7.8.0.dist-info/METADATA,sha256=ye4_rHtf-C06Ltam7yrnIsVqoJ5IqMFZxpIQEh4xOfg,14454
-ul_api_utils-7.8.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-ul_api_utils-7.8.0.dist-info/entry_points.txt,sha256=8tL3ySHWTyJMuV1hx1fHfN8zumDVOCOm63w3StphkXg,53
-ul_api_utils-7.8.0.dist-info/top_level.txt,sha256=1XsW8iOSFaH4LOzDcnNyxHpHrbKU3fSn-aIAxe04jmw,21
-ul_api_utils-7.8.0.dist-info/RECORD,,
+ul_api_utils-7.8.3.dist-info/LICENSE,sha256=6Qo8OdcqI8aGrswJKJYhST-bYqxVQBQ3ujKdTSdq-80,1062
+ul_api_utils-7.8.3.dist-info/METADATA,sha256=94zpzsKBdLQsFDwdf77UW9v42c5dRHjS4CfMWfguxzc,14529
+ul_api_utils-7.8.3.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+ul_api_utils-7.8.3.dist-info/entry_points.txt,sha256=8tL3ySHWTyJMuV1hx1fHfN8zumDVOCOm63w3StphkXg,53
+ul_api_utils-7.8.3.dist-info/top_level.txt,sha256=1XsW8iOSFaH4LOzDcnNyxHpHrbKU3fSn-aIAxe04jmw,21
+ul_api_utils-7.8.3.dist-info/RECORD,,