arpakitlib 1.8.0__py3-none-any.whl → 1.8.2__py3-none-any.whl

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/api/router/v1/main_router.py

@@ -1,7 +1,7 @@
 from fastapi import APIRouter
 
-from api.router.v1 import healthcheck, get_errors_info, now_utc_datetime
-from api.router.v1 import raise_fake_error, check_auth, arpakitlib_
+from api.router.v1 import healthcheck, get_errors_info, now_utc_datetime, clear_log_file, get_log_file
+from api.router.v1 import raise_fake_error, check_auth
 
 main_v1_api_router = APIRouter()
 
@@ -45,10 +45,23 @@ main_v1_api_router.include_router(
     tags=["Fake error"]
 )
 
-# Healthcheck
+# Now UTC Datetime
 
 main_v1_api_router.include_router(
     router=now_utc_datetime.api_router,
     prefix="/now_utc_datetime",
     tags=["Now UTC datetime"]
 )
+
+# Log file
+
+main_v1_api_router.include_router(
+    router=clear_log_file.api_router,
+    prefix="/clear_log_file",
+    tags=["Log file"]
+)
+main_v1_api_router.include_router(
+    router=get_log_file.api_router,
+    prefix="/get_log_file",
+    tags=["Log file"]
+)

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/api/router/v1/now_utc_datetime.py

@@ -1,5 +1,4 @@
 import fastapi
-import starlette.status
 from fastapi import APIRouter
 
 from api.schema.common.out import ErrorCommonSO, DatetimeCommonSO
@@ -10,8 +9,9 @@ api_router = APIRouter()
 
 @api_router.get(
     "",
+    name="Now UTC datetime",
+    status_code=fastapi.status.HTTP_200_OK,
     response_model=DatetimeCommonSO | ErrorCommonSO,
-    status_code=starlette.status.HTTP_200_OK
 )
 async def _(
         *,

arpakitlib/_arpakit_project_template_v_1/api/router/v1/raise_fake_error.py

@@ -0,0 +1,35 @@
+import fastapi
+import starlette.exceptions
+from fastapi import APIRouter
+
+from api.schema.common.out import ErrorCommonSO
+
+api_router = APIRouter()
+
+
+@api_router.get(
+    "",
+    name="Raise fake error",
+    response_model=ErrorCommonSO,
+    status_code=fastapi.status.HTTP_500_INTERNAL_SERVER_ERROR
+)
+async def _(
+        *,
+        request: fastapi.requests.Request,
+        response: fastapi.responses.Response,
+        n: int | None = None
+):
+    if n == 1:
+        raise fastapi.HTTPException(
+            detail={"n": n},
+            status_code=fastapi.status.HTTP_500_INTERNAL_SERVER_ERROR
+        )
+    elif n == 2:
+        raise starlette.exceptions.HTTPException(
+            detail=f"fake_error, n={n}",
+            status_code=fastapi.status.HTTP_500_INTERNAL_SERVER_ERROR
+        )
+    elif n == 3:
+        raise ValueError(f"fake error n={n}")
+    else:
+        raise Exception(f"fake error, n={n}")

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/api/schema/v1/out.py

@@ -15,12 +15,6 @@ class HealthcheckV1SO(BaseV1SO):
     is_ok: bool = True
 
 
-class ARPAKITLIBInfoV1SO(BaseV1SO):
-    arpakitlib: bool = True
-    arpakitlib_project_template_version: str
-    data: dict[str, Any] = {}
-
-
 class _SimpleDBMV1SO(BaseV1SO):
     id: int
     long_id: str

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/command/drop_json_db.py

@@ -1,12 +1,12 @@
 from core.settings import get_cached_settings
 from core.util import setup_logging
-from json_db.util import get_json_db
+from json_db.json_db import get_cached_json_db
 
 
 def __command():
     setup_logging()
     get_cached_settings().raise_if_mode_type_prod()
-    get_json_db().drop()
+    get_cached_json_db().drop()
 
 
 if __name__ == '__main__':

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/command/init_json_db.py

@@ -1,10 +1,10 @@
 from core.util import setup_logging
-from json_db.util import get_json_db
+from json_db.json_db import get_cached_json_db
 
 
 def __command():
     setup_logging()
-    get_json_db().init()
+    get_cached_json_db().init()
 
 
 if __name__ == '__main__':

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/command/reinit_json_db.py

@@ -1,12 +1,12 @@
 from core.settings import get_cached_settings
 from core.util import setup_logging
-from json_db.util import get_json_db
+from json_db.json_db import get_cached_json_db
 
 
 def __command():
     setup_logging()
     get_cached_settings().raise_if_mode_type_prod()
-    get_json_db().reinit()
+    get_cached_json_db().reinit()
 
 
 if __name__ == '__main__':

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/command/rm_all_records_in_json_db.py

@@ -1,12 +1,12 @@
 from core.settings import get_cached_settings
 from core.util import setup_logging
-from json_db.util import get_json_db
+from json_db.json_db import get_cached_json_db
 
 
 def __command():
     setup_logging()
     get_cached_settings().raise_if_mode_type_prod()
-    get_json_db().rm_all_records()
+    get_cached_json_db().rm_all_records()
 
 
 if __name__ == '__main__':

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/core/cache_file_storage_in_dir.py

@@ -4,12 +4,14 @@ from arpakitlib.ar_file_storage_in_dir_util import FileStorageInDir
 from core.settings import get_cached_settings
 
 
-def create_cache_file_storage_in_dir() -> FileStorageInDir:
+def create_cache_file_storage_in_dir() -> FileStorageInDir | None:
+    if get_cached_settings().cache_dirpath is None:
+        return None
     return FileStorageInDir(dirpath=get_cached_settings().cache_dirpath)
 
 
 @lru_cache()
-def get_cached_cache_file_storage_in_dir() -> FileStorageInDir:
+def get_cached_cache_file_storage_in_dir() -> FileStorageInDir | None:
     return create_cache_file_storage_in_dir()
 
 

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/core/const.py

@@ -9,14 +9,13 @@ from arpakitlib.ar_json_util import safely_transfer_obj_to_json_str
 class ProjectPaths(Enumeration):
     base_dirpath: str = str(pathlib.Path(__file__).parent.parent)
 
-    env_filename: str = ".env"
-    env_filepath: str = os.path.join(base_dirpath, env_filename)
+    env_filepath: str = os.path.join(base_dirpath, ".env")
 
-    resource_dirname: str = "resource"
-    resource_dirpath: str = os.path.join(base_dirpath, resource_dirname)
+    resource_dirpath: str = os.path.join(base_dirpath, "resource")
 
-    static_dirname: str = "static"
-    static_dirpath: str = os.path.join(resource_dirpath, static_dirname)
+    static_dirpath: str = os.path.join(resource_dirpath, "static")
+
+    templates_dirpath: str = os.path.join(resource_dirpath, "templates")
 
     arpakit_lib_project_template_filepath: str = os.path.join(base_dirpath, "arpakitlib_project_template.json")
 

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/core/dump_file_storage_in_dir.py

@@ -4,12 +4,14 @@ from arpakitlib.ar_file_storage_in_dir_util import FileStorageInDir
 from core.settings import get_cached_settings
 
 
-def create_dump_file_storage_in_dir() -> FileStorageInDir:
+def create_dump_file_storage_in_dir() -> FileStorageInDir | None:
+    if get_cached_settings().dump_dirpath is None:
+        return None
     return FileStorageInDir(dirpath=get_cached_settings().dump_dirpath)
 
 
 @lru_cache()
-def get_cached_dump_file_storage_in_dir() -> FileStorageInDir:
+def get_cached_dump_file_storage_in_dir() -> FileStorageInDir | None:
     return create_dump_file_storage_in_dir()
 
 

arpakitlib/_arpakit_project_template_v_1/core/jinja2_templates.py

@@ -0,0 +1,14 @@
+from functools import lru_cache
+
+from fastapi.templating import Jinja2Templates
+
+from core.const import ProjectPaths
+
+
+def create_jinja2_templates() -> Jinja2Templates:
+    return Jinja2Templates(directory=ProjectPaths.templates_dirpath)
+
+
+@lru_cache()
+def get_cached_jinja2_templates() -> Jinja2Templates:
+    return create_jinja2_templates()

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/core/media_file_storage_in_dir.py

@@ -4,12 +4,14 @@ from arpakitlib.ar_file_storage_in_dir_util import FileStorageInDir
 from core.settings import get_cached_settings
 
 
-def create_media_file_storage_in_dir() -> FileStorageInDir:
+def create_media_file_storage_in_dir() -> FileStorageInDir | None:
+    if get_cached_settings().media_dirpath is None:
+        return None
     return FileStorageInDir(dirpath=get_cached_settings().media_dirpath)
 
 
 @lru_cache()
-def get_cached_media_file_storage_in_dir() -> FileStorageInDir:
+def get_cached_media_file_storage_in_dir() -> FileStorageInDir | None:
     return create_media_file_storage_in_dir()
 
 

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/core/settings.py

@@ -105,7 +105,7 @@ class Settings(SimpleSettings):
 
     api_init_json_db: bool = False
 
-    api_correct_api_keys: list[str] | None = "1"
+    api_correct_api_keys: list[str] | None = ["1"]
 
     @field_validator("api_correct_api_keys", mode="before")
     def validate_api_correct_api_keys(cls, v: Any, validation_info: ValidationInfo, **kwargs) -> list[str] | None:
@@ -119,7 +119,7 @@ class Settings(SimpleSettings):
                     v[i] = str(v_)
         return v
 
-    api_correct_tokens: list[str] | None = "1"
+    api_correct_tokens: list[str] | None = ["1"]
 
     @field_validator("api_correct_tokens", mode="before")
     def validate_api_correct_tokens(cls, v: Any, validation_info: ValidationInfo, **kwargs) -> list[str] | None:
@@ -133,15 +133,17 @@ class Settings(SimpleSettings):
                     v[i] = str(v_)
         return v
 
-    api_enable_admin1: bool = True
+    api_enable_sqladmin: bool = True
 
     api_start_operation_executor_worker: bool = False
 
     api_start_scheduled_operation_creator_worker: bool = False
 
-    api_story_log__api_func_before_in_exception_handler: bool = True
+    api_story_log__api_func_before_in_exception_handler: bool = False
 
-    admin1_secret_key: str | None = "85a9583cb91c4de7a78d7eb1e5306a04418c9c43014c447ea8ec8dd5deb4cf71"
+    sqladmin_secret_key: str | None = "85a9583cb91c4de7a78d7eb1e5306a04418c9c43014c447ea8ec8dd5deb4cf71"
+
+    sqladmin_correct_passwords: list[str] | None = ["1"]
 
     tg_bot_token: str | None = None
 

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/example.env

@@ -13,11 +13,12 @@
 # api_init_json_db=
 # api_correct_api_keys=
 # api_correct_tokens=
-# api_enable_admin1=
+# api_enable_sqladmin=
 # api_start_operation_executor_worker=
 # api_start_scheduled_operation_creator_worker=
 # api_story_log__api_func_before_in_exception_handler=
-# admin1_secret_key=
+# sqladmin_secret_key=
+# sqladmin_correct_passwords=
 # tg_bot_token=
 # tg_bot_proxy_url=
 # tg_bot_init_sqlalchemy_db=

arpakitlib/_arpakit_project_template_v_1/json_db/json_db.py

@@ -0,0 +1,28 @@
+import os
+from functools import lru_cache
+
+from arpakitlib.ar_json_db_util import BaseJSONDb
+from core.settings import get_cached_settings
+
+
+class JSONDb(BaseJSONDb):
+    def __init__(self, dirpath: str):
+        super().__init__()
+        self.story_log = self.create_json_db_file(
+            filepath=os.path.join(dirpath, "story_log.json"), use_memory=True, beautify_json=False
+        )
+
+
+def create_json_db() -> JSONDb | None:
+    if get_cached_settings().json_db_dirpath is None:
+        return None
+    return JSONDb(
+        dirpath=get_cached_settings().json_db_dirpath
+    )
+
+
+@lru_cache()
+def get_cached_json_db() -> JSONDb:
+    return JSONDb(
+        dirpath=get_cached_settings().json_db_dirpath
+    )

arpakitlib/_arpakit_project_template_v_1/resource/static/healthcheck

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

arpakitlib/_arpakit_project_template_v_1/site/router/main_router.py

@@ -0,0 +1,3 @@
+from fastapi import APIRouter
+
+main_site_router = APIRouter()

arpakitlib/_arpakit_project_template_v_1/sqladmin_/add_admin_in_app.py

@@ -0,0 +1,24 @@
+from fastapi import FastAPI
+from sqladmin import Admin
+
+from core.settings import get_cached_settings
+from sqladmin_.admin_auth import SQLAdminAuth
+from sqladmin_.model_view import get_simple_mv
+from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
+
+
+def add_sqladmin_in_app(*, app: FastAPI, base_url: str = "sqladmin") -> FastAPI:
+    authentication_backend = SQLAdminAuth()
+
+    admin = Admin(
+        app=app,
+        engine=get_cached_sqlalchemy_db().engine,
+        base_url=base_url,
+        authentication_backend=authentication_backend,
+        title=get_cached_settings().project_name
+    )
+
+    for model_view in get_simple_mv().__subclasses__():
+        admin.add_model_view(model_view)
+
+    return app

arpakitlib/_arpakit_project_template_v_1/sqladmin_/admin_auth.py

@@ -0,0 +1,54 @@
+import logging
+
+import fastapi
+from sqladmin.authentication import AuthenticationBackend
+
+from core.settings import get_cached_settings
+
+
+class SQLAdminAuth(AuthenticationBackend):
+    def __init__(self):
+        self._logger = logging.getLogger(self.__class__.__name__)
+        super().__init__(secret_key=get_cached_settings().sqladmin_secret_key)
+
+    async def login(self, request: fastapi.Request) -> bool:
+        form = await request.form()
+        username, password = form.get("username"), form.get("password")
+        if username:
+            username = username.strip()
+        if password:
+            password = password.strip()
+
+        if get_cached_settings().sqladmin_correct_passwords is None:
+            return False
+        if (
+                (username is not None and username in get_cached_settings().sqladmin_correct_passwords)
+                or
+                (password is not None and password in get_cached_settings().sqladmin_correct_passwords)
+        ):
+            return True
+
+        return False
+
+    async def logout(self, request: fastapi.Request) -> bool:
+        request.session.clear()
+        return True
+
+    async def authenticate(self, request: fastapi.Request) -> bool:
+        form = await request.form()
+        username, password = form.get("username"), form.get("password")
+        if username:
+            username = username.strip()
+        if password:
+            password = password.strip()
+
+        if get_cached_settings().sqladmin_correct_passwords is None:
+            return False
+        if (
+                (username is not None and username in get_cached_settings().sqladmin_correct_passwords)
+                or
+                (password is not None and password in get_cached_settings().sqladmin_correct_passwords)
+        ):
+            return True
+
+        return False

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/sqlalchemy_db/sqlalchemy_db.py

@@ -5,7 +5,10 @@ from core.settings import get_cached_settings
 from sqlalchemy_db.sqlalchemy_model import get_simple_dbm
 
 
-def create_sqlalchemy_db() -> SQLAlchemyDb:
+def create_sqlalchemy_db() -> SQLAlchemyDb | None:
+    if not get_cached_settings().sqlalchemy_sync_db_url or not get_cached_settings().sqlalchemy_async_db_url:
+        return None
+
     return SQLAlchemyDb(
         sync_db_url=get_cached_settings().sqlalchemy_sync_db_url,
         async_db_url=get_cached_settings().sqlalchemy_async_db_url,
@@ -15,5 +18,5 @@ def create_sqlalchemy_db() -> SQLAlchemyDb:
 
 
 @lru_cache()
-def get_cached_sqlalchemy_db() -> SQLAlchemyDb:
+def get_cached_sqlalchemy_db() -> SQLAlchemyDb | None:
     return create_sqlalchemy_db()

arpakitlib/{_arpakit_project_template_v1 → _arpakit_project_template_v_1}/tg_bot/transmitted_tg_data.py

@@ -9,7 +9,7 @@ from core.cache_file_storage_in_dir import get_cached_cache_file_storage_in_dir
 from core.dump_file_storage_in_dir import get_cached_dump_file_storage_in_dir
 from core.media_file_storage_in_dir import get_cached_media_file_storage_in_dir
 from core.settings import Settings, get_cached_settings
-from json_db.util import get_json_db
+from json_db.json_db import get_cached_json_db
 from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
 
 
@@ -27,7 +27,7 @@ def create_transmitted_tg_bot_data() -> TransmittedTgBotData:
 
     sqlalchemy_db = get_cached_sqlalchemy_db() if settings.sqlalchemy_sync_db_url is not None else None
 
-    json_db = get_json_db() if settings.json_db_dirpath is not None else None
+    json_db = get_cached_json_db() if settings.json_db_dirpath is not None else None
 
     media_file_storage_in_dir = (
         get_cached_media_file_storage_in_dir() if settings.media_dirpath is not None else None

arpakitlib/ar_arpakit_project_template_util.py

@@ -38,8 +38,10 @@ def init_arpakit_project_template(
 
     def _generate_filepath_to_content() -> dict[str, bytes]:
         arpakit_project_template_dirpath = os.path.join(
-            os.path.dirname(os.path.abspath(__file__)), f"_arpakit_project_template_v{version}"
+            os.path.dirname(os.path.abspath(__file__)), f"_arpakit_project_template_v_{version}"
         )
+        if not os.path.exists(arpakit_project_template_dirpath):
+            raise Exception(f"not os.path.exists({arpakit_project_template_dirpath})")
         res = {}
         for root, dirs, files in os.walk(arpakit_project_template_dirpath):
             dirs[:] = [d for d in dirs if d != '__pycache__']

arpakitlib/ar_arpakitlib_cli_util.py

@@ -31,9 +31,6 @@ def execute_arpakitlib_cli(*, full_command: str | None = None):
         print("-overwrite_if_exists ...")
         print("-ignore_paths_startswith ...")
         print("-only_paths_startswith ...")
-        print("-param1 ...")
-        print("-param2 ...")
-        print("-param3 ...")
         print("\n")
 
     elif command == "init_arpakit_project_template":

{arpakitlib-1.8.0.dist-info → arpakitlib-1.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: arpakitlib
-Version: 1.8.0
+Version: 1.8.2
 Summary: arpakitlib
 License: Apache-2.0
 Keywords: arpakitlib,arpakit,arpakit-company,arpakitcompany,arpakit_company