arpakitlib 1.7.40__tar.gz → 1.7.43__tar.gz

{arpakitlib-1.7.40 → arpakitlib-1.7.43}/PKG-INFO

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

arpakitlib-1.7.43/arpakitlib/_arpakit_project_template/src/api/auth.py

@@ -0,0 +1,6 @@
+from arpakitlib.ar_fastapi_util import is_api_key_correct_api_auth
+from src.core.settings import get_cached_settings
+
+check_with_settings_is_api_key_correct_api_auth = is_api_key_correct_api_auth(
+    correct_api_key=get_cached_settings().api_correct_api_key
+)

{arpakitlib-1.7.40 → arpakitlib-1.7.43}/arpakitlib/_arpakit_project_template/src/core/settings.py

@@ -31,6 +31,8 @@ class Settings(SimpleSettings):
 
     api_port: int | None = int("{API_PORT}") if "{API_PORT}".isdigit() else None
 
+    api_correct_api_key: str | None = None
+
     var_dirname: str | None = "var"
 
     var_dirpath: str | None = os.path.join(BASE_DIRPATH, var_dirname)

{arpakitlib-1.7.40 → arpakitlib-1.7.43}/arpakitlib/api_key_util.py

@@ -3,7 +3,7 @@ from uuid import uuid4
 from arpakitlib.ar_datetime_util import now_utc_dt
 
 
-def generate_default_api_key_value() -> str:
+def generate_api_key() -> str:
     return (
         f"apikey{str(uuid4()).replace('-', '')}{str(now_utc_dt().timestamp()).replace('.', '')}"
     )

arpakitlib-1.7.43/arpakitlib/ar_fastapi_static/healthcheck

@@ -0,0 +1 @@
+Healthcheck

{arpakitlib-1.7.40 → arpakitlib-1.7.43}/arpakitlib/ar_fastapi_util.py

@@ -32,7 +32,7 @@ from arpakitlib.ar_json_util import safely_transfer_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
+from arpakitlib.ar_type_util import raise_for_type, raise_if_not_async_func, raise_if_none
 
 _ARPAKIT_LIB_MODULE_VERSION = "3.0"
 
@@ -529,26 +529,20 @@ def base_api_auth(
 
 
 class CheckAPIKeyAPIAuthData(BaseAPIAuthData):
-    require_check_api_key: bool = False
     is_api_key_correct: bool | None = None
 
 
-def check_api_key_api_auth(
+def is_api_key_correct_api_auth(
         *,
-        require_check_api_key: bool = True,
-        check_api_key_func: Callable | None = None,
+        validate_api_key_func: Callable | None = None,
         correct_api_key: str | None = None
 ):
-    if require_check_api_key:
-        require_api_key_string = True
-    else:
-        require_api_key_string = False
+    require_api_key_string = True
 
     if correct_api_key is not None:
-        check_api_key_func = lambda **kwargs: kwargs["api_key_string"] == correct_api_key
+        validate_api_key_func = lambda **kwargs: kwargs["api_key_string"] == correct_api_key
 
-    if require_check_api_key and check_api_key_func is None:
-        raise ValueError("require_check_api_key and check_api_key_func is None")
+    raise_if_none(validate_api_key_func)
 
     async def func(
             *,
@@ -560,18 +554,17 @@ def check_api_key_api_auth(
             request: starlette.requests.Request
     ) -> CheckAPIKeyAPIAuthData:
         check_api_key_api_auth_data = CheckAPIKeyAPIAuthData.model_validate(base_api_auth_data)
-        check_api_key_api_auth_data.require_check_api_key = require_check_api_key
         check_api_key_api_auth_data.is_api_key_correct = (
-            check_api_key_func(
+            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
             )
-            if check_api_key_func is not None else None
+            if validate_api_key_func is not None else None
         )
 
-        if check_api_key_api_auth_data.require_check_api_key and not check_api_key_api_auth_data.is_api_key_correct:
+        if not check_api_key_api_auth_data.is_api_key_correct:
             raise APIException(
                 status_code=starlette.status.HTTP_401_UNAUTHORIZED,
                 error_code=ErrorSO.APIErrorCodes.cannot_authorize,

arpakitlib-1.7.43/arpakitlib/ar_file_util.py

@@ -0,0 +1,20 @@
+import os
+
+
+def raise_if_path_not_exists(path: str):
+    if not os.path.exists(path):
+        raise Exception(f"path {path} not exists")
+
+
+def clear_text_file(filepath: str):
+    if not os.path.exists(filepath):
+        return
+    with open(filepath, mode="w") as f:
+        f.write("")
+
+
+def create_text_file(filepath: str, text: str = ""):
+    if os.path.exists(filepath):
+        return
+    with open(filepath, mode="w") as f:
+        f.write(text)

{arpakitlib-1.7.40 → arpakitlib-1.7.43}/arpakitlib/ar_type_util.py

@@ -80,7 +80,7 @@ def make_none_to_false(v: Any) -> Any:
 
 def raise_if_none(v: Any) -> Any:
     if v is None:
-        raise ValueError(f"v is None, v={v}")
+        raise ValueError(f"v is None, v={v}, type(v)={type(v)}")
     return v
 
 

{arpakitlib-1.7.40 → arpakitlib-1.7.43}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "arpakitlib"
-version = "1.7.40"
+version = "1.7.43"
 description = "arpakitlib"
 authors = ["arpakit <arpakit@gmail.com>", "arpakit_support <support@arpakit.com>"]
 license = "Apache License 2.0"

arpakitlib-1.7.40/arpakitlib/ar_file_util.py

@@ -1,6 +0,0 @@
-import os
-
-
-def raise_if_path_not_exists(path: str):
-    if not os.path.exists(path):
-        raise Exception(f"path {path} not exists")