ul-api-utils 7.8.0__tar.gz → 7.8.3__tar.gz

{ul-api-utils-7.8.0 → ul-api-utils-7.8.3}/PKG-INFO

@@ -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: 

{ul-api-utils-7.8.0 → ul-api-utils-7.8.3}/example/conf.py

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

{ul-api-utils-7.8.0 → ul-api-utils-7.8.3}/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-7.8.0 → ul-api-utils-7.8.3}/setup.py

@@ -9,7 +9,7 @@ with open(path.join(HERE, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='ul-api-utils',
-    version='7.8.0',
+    version='7.8.3',
     description='Python api utils',
     author='Unic-lab',
     long_description=long_description,
@@ -78,6 +78,9 @@ setup(
 
         "werkzeug==2.3.7",
 
+        "wtforms==3.0.1",
+        "wtforms-alchemy==0.18.0",
+
         # "opentelemetry-sdk==1.8.0",
         # "opentelemetry-api==1.8.0",
         # "opentelemetry-instrumentation-flask==0.27b0",

{ul-api-utils-7.8.0 → ul-api-utils-7.8.3}/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-7.8.3/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-7.8.0 → ul-api-utils-7.8.3}/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-7.8.0 → ul-api-utils-7.8.3}/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 → ul-api-utils-7.8.3}/ul_api_utils.egg-info/PKG-INFO

@@ -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: 

{ul-api-utils-7.8.0 → ul-api-utils-7.8.3}/ul_api_utils.egg-info/SOURCES.txt

@@ -30,6 +30,7 @@ ul_api_utils/api_resource/__init__.py
 ul_api_utils/api_resource/api_request.py
 ul_api_utils/api_resource/api_resource.py
 ul_api_utils/api_resource/api_resource_config.py
+ul_api_utils/api_resource/api_resource_error_handling.py
 ul_api_utils/api_resource/api_resource_fn_typing.py
 ul_api_utils/api_resource/api_resource_type.py
 ul_api_utils/api_resource/api_response.py

{ul-api-utils-7.8.0 → ul-api-utils-7.8.3}/ul_api_utils.egg-info/requires.txt

@@ -23,3 +23,5 @@ sentry-sdk[flask]==1.9.2
 types-requests==2.28.8
 types-jinja2==2.11.9
 werkzeug==2.3.7
+wtforms==3.0.1
+wtforms-alchemy==0.18.0