kisa-utils 0.37.2__py3-none-any.whl → 0.37.3__py3-none-any.whl

kisa_utils/servers/flask.py

@@ -5,7 +5,8 @@ Kisa Server Utilities
 import kisa_utils as kutils
 from kisa_utils.storage import Path
 from kisa_utils.response import Response, Ok, Error
-from flask import Flask, request, jsonify, wrappers, render_template_string, current_app, g as app_ctx
+from flask import Flask, request, jsonify, wrappers, render_template_string
+from flask import current_app, g as app_ctx, make_response
 from flask_cors import CORS
 from functools import wraps
 import copy
@@ -351,11 +352,27 @@ def entry(func):
 
 #     return wrapper
 
+@enforceRequirements
+def __verifyResponseHeaders(headers:dict[str, str|int|float], /) -> Response:
+    '''
+    validate response headers to be set
+    '''
+
+    keyTypes, valuetypes = get_args(__verifyResponseHeaders.__annotations__['headers'])
+
+    for header in headers:
+        if not isinstance(header, keyTypes):
+            return Error(f'response header `{header}` expected to be of type `{keyTypes}`')
+        if not isinstance(headers[header], valuetypes):
+            return Error(f'response header `{header}` value expected to be of type `{valuetypes}`')
+
+    return Ok()
 
 # @enforceRequirements
 def endpoint(
     name: str|Callable = '', group: str = '', methods:list[str] = ['POST'],
-    security: Optional[Callable] = None
+    security: Optional[Callable] = None,
+    responseHeaders:dict[str, str|int|float] = {}
 ) -> Callable:
     """
         creates flask endpoints
@@ -370,6 +387,9 @@ def endpoint(
 
         methods = _normalize_and_validate_methods(methods)
         
+        if responseHeaders and not (resp := __verifyResponseHeaders(responseHeaders)):
+            raise ValueError(resp.log)
+
         if 1:
             _group = group + '/' if group else ''
             _name = '/' + _group + (name or func.__name__)
@@ -519,7 +539,29 @@ def endpoint(
             if not isinstance(resp, expectedReturnType):
                 raise TypeError(f'`{handler.__name__}` did NOT return a {expectedReturnType.__name__} object')
 
-            return resp
+            if isinstance(resp, tuple):
+                if 2 != len(resp):
+                    raise Exception(f'expected 2-item tuple from the endpoint handler!')
+                if not isinstance(resp[1], int):
+                    raise Exception(f'expected status_code as the second item in the tuple from the endpoint handler!')
+
+            if not responseHeaders:
+                return resp
+            
+            if isinstance(resp, tuple):
+                resp,statusCode = resp
+            else:
+                statusCode = 200
+
+            if isinstance(resp, Response):
+                resp = resp.asJSON
+
+            response =  make_response(resp,statusCode)
+
+            for header in responseHeaders:
+                response.headers[header] = responseHeaders[header]
+
+            return response
 
         w.__name__ = f'__kisa_wrapper_{_group}_{handler.__name__}'
         __SERVER_APP.route(_name, methods=methods)(w)

{kisa_utils-0.37.2.dist-info → kisa_utils-0.37.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kisa-utils
-Version: 0.37.2
+Version: 0.37.3
 Summary: Utility functions and modules for KISA Developers
 Author: Tom Bukenya
 Author-email: glayn2bukman@gmail.com

{kisa_utils-0.37.2.dist-info → kisa_utils-0.37.3.dist-info}/RECORD

@@ -19,11 +19,11 @@ kisa_utils/token.py,sha256=ReCIBsq95RMYCrDCyHgU1y_Eq-xp_PBpZiHxwsY6Fj4,8015
 kisa_utils/permissions/__config__.py,sha256=i3ELkOydDnjKx2ozQTxLZdZ8DXSeUncnl2kRxANjFmM,613
 kisa_utils/permissions/__init__.py,sha256=k7WbNlE8i9Vyf_SdbXbTh8D3gt4obDe3f8rONVVmNH4,36291
 kisa_utils/servers/__init__.py,sha256=lPqDyGTrFo0qwPZ2WA9Xtcpc5D8AIU4huqgFx1iZf68,19
-kisa_utils/servers/flask.py,sha256=Z8k8gtUulZw5KJnDFgGa1o1TX5zqbWkmeFDERMPWd-g,35002
+kisa_utils/servers/flask.py,sha256=PXH0WQh7LBi6Pj9WugIyXXHwbUTZIBQjMWt9SAysmgA,36586
 kisa_utils/structures/__init__.py,sha256=JBU1j3A42jQ62ALKnsS1Hav9YXcYwjDw1wQJtohXPbU,83
 kisa_utils/structures/utils.py,sha256=M4qBWjkrG9grHgIu_OZ6TEISsHRtZq5hF-S4mScelgs,2484
 kisa_utils/structures/validator.py,sha256=8FTi_GDPTNplxNJLTH8DraNyHZPjYFRvPBlI0sIvjBE,3573
-kisa_utils-0.37.2.dist-info/METADATA,sha256=suXXHe2bnfMykd5io8ADDhXLdiqLUXvqi0gp895Husk,477
-kisa_utils-0.37.2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-kisa_utils-0.37.2.dist-info/top_level.txt,sha256=URxY4sRuqmirOxWtztpVmPoGQdksEMYO6hmYsEDGz2Y,75
-kisa_utils-0.37.2.dist-info/RECORD,,
+kisa_utils-0.37.3.dist-info/METADATA,sha256=28yDyc18EqX8MIQYC4eNRYjtizKrjd7v2v-tNj4F4Ik,477
+kisa_utils-0.37.3.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+kisa_utils-0.37.3.dist-info/top_level.txt,sha256=URxY4sRuqmirOxWtztpVmPoGQdksEMYO6hmYsEDGz2Y,75
+kisa_utils-0.37.3.dist-info/RECORD,,