arpakitlib 1.7.76__py3-none-any.whl → 1.7.78__py3-none-any.whl

arpakitlib/_arpakit_project_template/src/api/auth.py

@@ -1,6 +1,22 @@
-from arpakitlib.ar_fastapi_util import api_key_api_auth
+from arpakitlib.ar_fastapi_util import base_api_auth
 from src.core.settings import get_cached_settings
 
-check_with_settings_api_key_api_auth = api_key_api_auth(
-    correct_api_key=get_cached_settings().api_correct_api_key
+api_key_with_settings_api_auth = base_api_auth(
+    correct_api_keys=get_cached_settings().api_correct_api_key,
+    require_correct_api_key=False
+)
+
+correct_api_key_with_settings_api_auth = base_api_auth(
+    correct_api_keys=get_cached_settings().api_correct_api_key,
+    require_correct_api_key=True
+)
+
+token_with_settings_api_auth = base_api_auth(
+    correct_api_keys=get_cached_settings().api_correct_token,
+    require_correct_token=False
+)
+
+correct_token_with_settings_api_auth = base_api_auth(
+    correct_api_keys=get_cached_settings().api_correct_token,
+    require_correct_token=True
 )

arpakitlib/_arpakit_project_template/src/core/settings.py

@@ -35,6 +35,8 @@ class Settings(SimpleSettings):
 
     api_correct_api_key: str | None = "1"
 
+    api_correct_token: str | None = "1"
+
     var_dirname: str | None = "var"
 
     var_dirpath: str | None = os.path.join(BASE_DIRPATH, var_dirname)

arpakitlib/ar_fastapi_util.py

@@ -29,11 +29,12 @@ from arpakitlib.ar_base_worker_util import BaseWorker, safe_run_worker_in_backgr
 from arpakitlib.ar_dict_util import combine_dicts
 from arpakitlib.ar_enumeration_util import Enumeration
 from arpakitlib.ar_file_storage_in_dir_util import FileStorageInDir
+from arpakitlib.ar_func_util import raise_if_not_async_func, is_async_function
 from arpakitlib.ar_json_util import safely_transfer_obj_to_json_str_to_json_obj
 from arpakitlib.ar_logging_util import setup_normal_logging
 from arpakitlib.ar_sqlalchemy_model_util import StoryLogDBM
 from arpakitlib.ar_sqlalchemy_util import SQLAlchemyDB
-from arpakitlib.ar_type_util import raise_for_type, raise_if_not_async_func, raise_if_none
+from arpakitlib.ar_type_util import raise_for_type, raise_if_none
 
 _ARPAKIT_LIB_MODULE_VERSION = "3.0"
 
@@ -250,7 +251,7 @@ def create_handle_exception(
             _func_data = func(
                 status_code=status_code, error_so=error_so, request=request, exception=exception, **_kwargs
             )
-            if asyncio.iscoroutine(_func_data):
+            if is_async_function(_func_data):
                 _func_data = await _func_data
             if _func_data is not None:
                 status_code, error_so, _kwargs = _func_data[0], _func_data[1], _func_data[2]
@@ -470,19 +471,49 @@ class BaseAPIAuthData(BaseModel):
     token_string: str | None = None
     api_key_string: str | None = None
 
+    is_token_string_correct: bool | None = None
+    is_api_key_string_correct: bool | None = None
+
 
 def base_api_auth(
         *,
         require_api_key_string: bool = False,
-        require_token_string: bool = False
+        require_token_string: bool = False,
+        validate_api_key_func: Callable | None = None,
+        validate_token_func: Callable | None = None,
+        correct_api_keys: str | list[str] | None = None,
+        correct_tokens: str | list[str] | None = None,
+        require_correct_api_key: bool = False,
+        require_correct_token: bool = False,
 ) -> Callable:
+    if isinstance(correct_api_keys, str):
+        correct_api_keys = [correct_api_keys]
+    if correct_api_keys is not None:
+        raise_for_type(correct_api_keys, list)
+        validate_api_key_func = lambda *args, **kwargs: kwargs["api_key_string"] in correct_api_keys
+
+    if isinstance(correct_tokens, str):
+        correct_tokens = [correct_tokens]
+    if correct_tokens is not None:
+        raise_for_type(correct_tokens, list)
+        validate_token_func = lambda *args, **kwargs: kwargs["token_string"] in correct_tokens
+
+    if require_correct_api_key:
+        raise_if_none(validate_api_key_func)
+        require_api_key_string = True
+
+    if require_correct_token:
+        raise_if_none(validate_token_func)
+        require_token_string = True
+
     async def func(
             *,
             ac: fastapi.security.HTTPAuthorizationCredentials | None = fastapi.Security(
                 fastapi.security.HTTPBearer(auto_error=False)
             ),
             api_key_string: str | None = Security(APIKeyHeader(name="apikey", auto_error=False)),
-            request: starlette.requests.Request
+            request: starlette.requests.Request,
+            transmitted_api_data: BaseTransmittedAPIData = Depends(get_transmitted_api_data)
     ) -> BaseAPIAuthData:
 
         api_auth_data = BaseAPIAuthData(
@@ -537,6 +568,8 @@ def base_api_auth(
         if not api_auth_data.token_string:
             api_auth_data.token_string = None
 
+        # api_key
+
         if require_api_key_string and not api_auth_data.api_key_string:
             raise APIException(
                 status_code=starlette.status.HTTP_401_UNAUTHORIZED,
@@ -544,6 +577,8 @@ def base_api_auth(
                 error_data=safely_transfer_obj_to_json_str_to_json_obj(api_auth_data.model_dump())
             )
 
+        # token
+
         if require_token_string and not api_auth_data.token_string:
             raise APIException(
                 status_code=starlette.status.HTTP_401_UNAUTHORIZED,
@@ -551,49 +586,55 @@ def base_api_auth(
                 error_data=safely_transfer_obj_to_json_str_to_json_obj(api_auth_data.model_dump())
             )
 
-        return api_auth_data
+        # api_key
 
-    return func
+        if validate_api_key_func is not None:
+            validate_api_key_func_data = validate_api_key_func(
+                api_key_string=api_auth_data.api_key_string,
+                token_string=api_auth_data.token_string,
+                base_api_auth_data=api_auth_data,
+                transmitted_api_data=transmitted_api_data,
+                request=request
+            )
+            if is_async_function(validate_api_key_func_data):
+                validate_api_key_func_data = await validate_api_key_func_data
+            api_auth_data.is_api_key_string_correct = validate_api_key_func_data
 
+        # token
 
-class CheckAPIKeyAPIAuthData(BaseAPIAuthData):
-    is_api_key_correct: bool | None = None
+        if validate_token_func is not None:
+            validate_token_func_data = validate_token_func(
+                api_key_string=api_auth_data.api_key_string,
+                token_string=api_auth_data.token_string,
+                base_api_auth_data=api_auth_data,
+                transmitted_api_data=transmitted_api_data,
+                request=request
+            )
+            if is_async_function(validate_token_func_data):
+                validate_token_func_data_data = await validate_token_func_data
+            api_auth_data.is_token_string_correct = validate_token_func_data_data
 
+        # api_key
 
-def api_key_api_auth(
-        *,
-        validate_api_key_func: Callable | None = None,
-        correct_api_key: str | None = None
-):
-    if correct_api_key is not None:
-        validate_api_key_func = lambda *args, **kwargs: kwargs["api_key_string"] == correct_api_key
-    raise_if_none(validate_api_key_func)
+        if require_correct_api_key:
+            if not api_auth_data.is_api_key_string_correct:
+                raise APIException(
+                    status_code=starlette.status.HTTP_401_UNAUTHORIZED,
+                    error_code=BaseAPIErrorCodes.cannot_authorize,
+                    error_data=safely_transfer_obj_to_json_str_to_json_obj(api_auth_data.model_dump())
+                )
 
-    async def func(
-            *,
-            base_api_auth_data: BaseAPIAuthData = Depends(base_api_auth(
-                require_api_key_string=True,
-                require_token_string=False
-            )),
-            transmitted_api_data: BaseTransmittedAPIData = Depends(get_transmitted_api_data),
-            request: starlette.requests.Request
-    ) -> CheckAPIKeyAPIAuthData:
-        check_api_key_api_auth_data = CheckAPIKeyAPIAuthData.model_validate(base_api_auth_data)
-        check_api_key_api_auth_data.is_api_key_correct = validate_api_key_func(
-            api_key_string=base_api_auth_data.api_key_string,
-            base_api_auth_data=base_api_auth_data,
-            transmitted_api_data=transmitted_api_data,
-            request=request
-        )
+        # token
 
-        if not check_api_key_api_auth_data.is_api_key_correct:
-            raise APIException(
-                status_code=starlette.status.HTTP_401_UNAUTHORIZED,
-                error_code=BaseAPIErrorCodes.cannot_authorize,
-                error_data=safely_transfer_obj_to_json_str_to_json_obj(check_api_key_api_auth_data.model_dump())
-            )
+        if require_correct_token:
+            if not api_auth_data.is_token_string_correct:
+                raise APIException(
+                    status_code=starlette.status.HTTP_401_UNAUTHORIZED,
+                    error_code=BaseAPIErrorCodes.cannot_authorize,
+                    error_data=safely_transfer_obj_to_json_str_to_json_obj(api_auth_data.model_dump())
+                )
 
-        return check_api_key_api_auth_data
+        return api_auth_data
 
     return func
 

arpakitlib/ar_func_util.py

@@ -0,0 +1,51 @@
+import asyncio
+import inspect
+from typing import Callable
+
+_ARPAKIT_LIB_MODULE_VERSION = "3.0"
+
+
+def is_async_function(func: Callable) -> bool:
+    return asyncio.iscoroutinefunction(func)
+
+
+def is_sync_function(func: Callable) -> bool:
+    return inspect.isfunction(func) and not is_async_function(func)
+
+
+def raise_if_not_async_func(func: Callable):
+    if not is_async_function(func):
+        raise TypeError(f"The provided function '{func.__name__}' is not an async function")
+
+
+def raise_if_not_sync_func(func: Callable):
+    if not is_sync_function(func):
+        raise TypeError(f"The provided function '{func.__name__}' is not a sync function")
+
+
+def raise_if_async_func(func: Callable):
+    if is_async_function(func):
+        raise TypeError(f"The provided function '{func.__name__}' should not be async")
+
+
+def raise_if_sync_func(func: Callable):
+    if is_sync_function(func):
+        raise TypeError(f"The provided function '{func.__name__}' should not be sync")
+
+
+def __example():
+    def one():
+        pass
+
+    async def two():
+        pass
+
+    print(is_sync_function(one))
+    print(is_sync_function(two))
+
+    print(is_async_function(one))
+    print(is_async_function(two))
+
+
+if __name__ == '__main__':
+    __example()

arpakitlib/ar_type_util.py

@@ -67,11 +67,6 @@ def raise_for_types(comparable, need_types, comment_for_error: Optional[str] = N
         raise TypeError(err)
 
 
-def raise_if_not_async_func(func: Any):
-    if not inspect.iscoroutinefunction(func):
-        raise TypeError(f"The provided function '{func.__name__}' is not an async function")
-
-
 def make_none_to_false(v: Any) -> Any:
     if v is None:
         return False

{arpakitlib-1.7.76.dist-info → arpakitlib-1.7.78.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: arpakitlib
-Version: 1.7.76
+Version: 1.7.78
 Summary: arpakitlib
 Home-page: https://github.com/ARPAKIT-Company/arpakitlib
 License: Apache-2.0

{arpakitlib-1.7.76.dist-info → arpakitlib-1.7.78.dist-info}/RECORD

@@ -73,7 +73,7 @@ arpakitlib/_arpakit_project_template/src/additional_model/__init__.py,sha256=47D
 arpakitlib/_arpakit_project_template/src/additional_model/additional_model.py,sha256=4KCOvto9Hj5eMYpvfaJChghhR9bkCvKluGGPWrTezoY,134
 arpakitlib/_arpakit_project_template/src/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arpakitlib/_arpakit_project_template/src/api/asgi.py,sha256=a5UBxOyNC8NG3E0ayhiDo3t5tPoB3WtOf2gbZJFWBAA,74
-arpakitlib/_arpakit_project_template/src/api/auth.py,sha256=onnmSwjtc0aX7y6X2GCqayKcZ85Besz0KoElctv-H-w,228
+arpakitlib/_arpakit_project_template/src/api/auth.py,sha256=bf5DtYA3q7HgyIIrzr1-X-AUfNfYe41mGV6Si977nxg,701
 arpakitlib/_arpakit_project_template/src/api/const.py,sha256=7d4qD5hedqr7QxVzbfsA7E1bNZn2Pm2U8joXGtpANu0,287
 arpakitlib/_arpakit_project_template/src/api/create_api_app.py,sha256=lDE77W6WkeAeRB_vJY3TXRTa3HeiO-t26eTtG7v8j6U,4594
 arpakitlib/_arpakit_project_template/src/api/event.py,sha256=58wCVyVSIe_kydWi44M0Wvp7bTnV8xvO30gMXzjbFYc,750
@@ -93,7 +93,7 @@ arpakitlib/_arpakit_project_template/src/api/util.py,sha256=47DEQpj8HBSa-_TImW-5
 arpakitlib/_arpakit_project_template/src/business_service/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arpakitlib/_arpakit_project_template/src/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arpakitlib/_arpakit_project_template/src/core/const.py,sha256=CZZew674y7LhCAlYhvuF5cV4Zb9nQ17j2Tcuj2GEBf4,1232
-arpakitlib/_arpakit_project_template/src/core/settings.py,sha256=VR2wHHkiTc4GKfddt-UeeQ1zZREL1njBRuHsi7JWLuQ,2197
+arpakitlib/_arpakit_project_template/src/core/settings.py,sha256=S1WPgnFWiRNjCXLllZHq6xp3AiyzzqnRBubg02iRkvo,2238
 arpakitlib/_arpakit_project_template/src/core/util.py,sha256=5R8gvcZdvuDQes45FBnLC2IDv2Jhajp1VhJJYNKYjMQ,1539
 arpakitlib/_arpakit_project_template/src/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arpakitlib/_arpakit_project_template/src/db/sqlalchemy_model.py,sha256=nXtayUkBaVb6tWx5qJgXZLbLOTVAjnSLpSDxBm7yZLc,234
@@ -148,9 +148,10 @@ arpakitlib/ar_fastapi_static/swagger-ui/swagger-ui.css,sha256=jzPZlgJTFwSdSphk9C
 arpakitlib/ar_fastapi_static/swagger-ui/swagger-ui.css.map,sha256=5wq8eXMLU6Zxb45orZPL1zAsBFJReFw6GjYqGpUX3hg,262650
 arpakitlib/ar_fastapi_static/swagger-ui/swagger-ui.js,sha256=ffrLZHHEQ_g84A-ul3yWa10Kk09waOAxHcQXPuZuavg,339292
 arpakitlib/ar_fastapi_static/swagger-ui/swagger-ui.js.map,sha256=9UhIW7MqCOZPAz1Sl1IKfZUuhWU0p-LJqrnjjJD9Xhc,1159454
-arpakitlib/ar_fastapi_util.py,sha256=9gUzWhtqBV8stxPmWQ76Btw8rzWGFoBjRwMofGWdyhQ,25258
+arpakitlib/ar_fastapi_util.py,sha256=7VwkGwH2YXTx5i5HgX6sFg16wH3YyFSu8yNyP_4Sxtc,27078
 arpakitlib/ar_file_storage_in_dir_util.py,sha256=D3e3rGuHoI6xqAA5mVvEpVVpOWY1jyjNsjj2UhyHRbE,3674
 arpakitlib/ar_file_util.py,sha256=GUdJYm1tUZnYpY-SIPRHAZBHGra8NKy1eYEI0D5AfhY,489
+arpakitlib/ar_func_util.py,sha256=aqcweSuaY73FbCly844sSnlud63g4TRkKhSwUUN-QM0,1239
 arpakitlib/ar_hash_util.py,sha256=Iqy6KBAOLBQMFLWv676boI5sV7atT2B-fb7aCdHOmIQ,340
 arpakitlib/ar_http_request_util.py,sha256=Kp2wKU4wGPsJ6m5sLwCEKWMs3Uqa59SUxhBevU6Gk_s,4328
 arpakitlib/ar_ip_util.py,sha256=aEAa1Hvobh9DWX7cmBAPLqnXSTiKe2hRk-WJaiKMaI8,1009
@@ -174,12 +175,12 @@ arpakitlib/ar_sqlalchemy_model_util.py,sha256=AuD0L4b-h0g3VqGoFHWK5JIet_Jxpg49o7
 arpakitlib/ar_sqlalchemy_util.py,sha256=Hcg1THrDsSR_-8dsY1CG3NWPEv0FqCbkPXFXLtjlSJ0,4207
 arpakitlib/ar_ssh_runner_util.py,sha256=e9deuUdBW7Eh0Exx2nTBhk57SaOZYaJaSjNk8q6dbJk,6804
 arpakitlib/ar_str_util.py,sha256=tFoGSDYoGpfdVHWor5Li9pEOFmDFlHkX-Z8iOy1LK7Y,3537
-arpakitlib/ar_type_util.py,sha256=46ZMuWls3uN0Re5T0sfEAmyNUDnxn9yvj6dHivSDZKs,3915
+arpakitlib/ar_type_util.py,sha256=s0NsTM7mV3HuwyRwyYLdNn7Ep2HbyI4FIr-dd8x0lfI,3734
 arpakitlib/ar_yookassa_api_client_util.py,sha256=sh4fcUkAkdOetFn9JYoTvjcSXP-M1wU04KEY-ECLfLg,5137
 arpakitlib/ar_zabbix_api_client_util.py,sha256=Q-VR4MvoZ9aHwZeYZr9G3LwN-ANx1T5KFmF6pvPM-9M,6402
-arpakitlib-1.7.76.dist-info/LICENSE,sha256=GPEDQMam2r7FSTYqM1mm7aKnxLaWcBotH7UvQtea-ec,11355
-arpakitlib-1.7.76.dist-info/METADATA,sha256=sat8Sj_1M9alTRio_zyVPE5uwkUufovTjH-aubogASI,2824
-arpakitlib-1.7.76.dist-info/NOTICE,sha256=95aUzaPJjVpDsGAsNzVnq7tHTxAl0s5UFznCTkVCau4,763
-arpakitlib-1.7.76.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-arpakitlib-1.7.76.dist-info/entry_points.txt,sha256=36xqR3PJFT2kuwjkM_EqoIy0qFUDPKSm_mJaI7emewE,87
-arpakitlib-1.7.76.dist-info/RECORD,,
+arpakitlib-1.7.78.dist-info/LICENSE,sha256=GPEDQMam2r7FSTYqM1mm7aKnxLaWcBotH7UvQtea-ec,11355
+arpakitlib-1.7.78.dist-info/METADATA,sha256=dMQB2b6Psj0ky04X33tUTYPkNADnuFbNEMWVBgLKfvk,2824
+arpakitlib-1.7.78.dist-info/NOTICE,sha256=95aUzaPJjVpDsGAsNzVnq7tHTxAl0s5UFznCTkVCau4,763
+arpakitlib-1.7.78.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+arpakitlib-1.7.78.dist-info/entry_points.txt,sha256=36xqR3PJFT2kuwjkM_EqoIy0qFUDPKSm_mJaI7emewE,87
+arpakitlib-1.7.78.dist-info/RECORD,,