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

arpakitlib/_arpakit_project_template_v1/api/schema/v1/out.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+import datetime as dt
+from typing import Any
+
+from api.schema.base_schema import BaseSO
+from sqlalchemy_db.sqlalchemy_model import OperationDBM, StoryLogDBM
+
+
+class BaseV1SO(BaseSO):
+    pass
+
+
+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
+    creation_dt: dt.datetime
+
+
+class StoryLogV1SO(_SimpleDBMV1SO):
+    level: str
+    type: str | None = None
+    title: str | None = None
+    data: dict[str, Any] = {}
+
+    @classmethod
+    def from_story_log_dbm(cls, *, story_log_dbm: StoryLogDBM) -> StoryLogV1SO:
+        return cls.model_validate(story_log_dbm.simple_dict_with_sd_properties())
+
+
+class OperationV1SO(_SimpleDBMV1SO):
+    execution_start_dt: dt.datetime | None = None
+    execution_finish_dt: dt.datetime | None = None
+    status: str
+    type: str
+    input_data: dict[str, Any] = {}
+    output_data: dict[str, Any] = {}
+    error_data: dict[str, Any] = {}
+    duration_total_seconds: float | None = None
+
+    @classmethod
+    def from_operation_dbm(cls, *, operation_dbm: OperationDBM) -> OperationV1SO:
+        return cls.model_validate(operation_dbm.simple_dict_with_sd_properties())

arpakitlib/_arpakit_project_template_v1/api/transmitted_api_data.py

@@ -0,0 +1,66 @@
+from functools import lru_cache
+
+import starlette.requests
+from pydantic import BaseModel, ConfigDict
+
+from arpakitlib.ar_file_storage_in_dir_util import FileStorageInDir
+from arpakitlib.ar_json_db_util import BaseJSONDb
+from arpakitlib.ar_sqlalchemy_util import SQLAlchemyDb
+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
+from core.settings import get_cached_settings
+from json_db.util import get_json_db
+from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
+
+
+class TransmittedAPIData(BaseModel):
+    model_config = ConfigDict(extra="ignore", arbitrary_types_allowed=True, from_attributes=True)
+
+    settings: Settings | None = None
+    sqlalchemy_db: SQLAlchemyDb | None = None
+    json_db: BaseJSONDb | None = None
+    media_file_storage_in_dir: FileStorageInDir | None = None
+    cache_file_storage_in_dir: FileStorageInDir | None = None
+    dump_file_storage_in_dir: FileStorageInDir | None = None
+
+
+def get_transmitted_api_data(request: starlette.requests.Request) -> TransmittedAPIData:
+    return request.app.state.transmitted_api_data
+
+
+def create_transmitted_api_data() -> TransmittedAPIData:
+    settings = get_cached_settings()
+
+    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
+
+    media_file_storage_in_dir = (
+        get_cached_media_file_storage_in_dir() if settings.media_dirpath is not None else None
+    )
+
+    cache_file_storage_in_dir = (
+        get_cached_cache_file_storage_in_dir() if settings.cache_dirpath is not None else None
+    )
+
+    dump_file_storage_in_dir = (
+        get_cached_dump_file_storage_in_dir() if settings.dump_dirpath is not None else None
+    )
+
+    transmitted_api_data = TransmittedAPIData(
+        settings=settings,
+        sqlalchemy_db=sqlalchemy_db,
+        json_db=json_db,
+        media_file_storage_in_dir=media_file_storage_in_dir,
+        cache_file_storage_in_dir=cache_file_storage_in_dir,
+        dump_file_storage_in_dir=dump_file_storage_in_dir
+    )
+
+    return transmitted_api_data
+
+
+@lru_cache()
+def get_cached_transmitted_api_data() -> TransmittedAPIData:
+    return create_transmitted_api_data()

arpakitlib/_arpakit_project_template_v1/arpakitlib_project_template.json

@@ -0,0 +1,3 @@
+{
+  "arpakitlib_project_template_version": "1"
+}

arpakitlib/{_arpakit_project_template/src → _arpakit_project_template_v1}/business_service/hello_world.py

@@ -1,6 +1,6 @@
 import logging
 
-from src.core.util import setup_logging
+from core.util import setup_logging
 
 _logger = logging.getLogger(__name__)
 

arpakitlib/_arpakit_project_template_v1/business_service/remove_operations.py

@@ -0,0 +1,51 @@
+import asyncio
+
+from arpakitlib.ar_type_util import raise_for_type
+from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
+from sqlalchemy_db.sqlalchemy_model import OperationDBM
+
+
+def remove_operations(
+        *,
+        filter_operation_ids: list[int] | int | None = None,
+        filter_operation_statuses: list[str] | str | None = None,
+        filter_operation_types: list[str] | str | None = None,
+):
+    if isinstance(filter_operation_ids, int):
+        filter_operation_ids = [filter_operation_ids]
+    if filter_operation_ids is not None:
+        raise_for_type(filter_operation_ids, list)
+
+    if isinstance(filter_operation_statuses, str):
+        filter_operation_statuses = [filter_operation_statuses]
+    if filter_operation_statuses is not None:
+        raise_for_type(filter_operation_statuses, list)
+
+    if isinstance(filter_operation_types, str):
+        filter_operation_types = [filter_operation_types]
+    if filter_operation_types is not None:
+        raise_for_type(filter_operation_types, list)
+
+    with get_cached_sqlalchemy_db().new_session() as session:
+        query = session.query(OperationDBM)
+        if filter_operation_ids is not None:
+            query = query.filter(OperationDBM.id.in_(filter_operation_ids))
+        if filter_operation_statuses is not None:
+            query = query.filter(OperationDBM.status.in_(filter_operation_statuses))
+        if filter_operation_types is not None:
+            query = query.filter(OperationDBM.type.in_(filter_operation_types))
+        query.delete()
+        session.commit()
+
+
+def __example():
+    remove_operations(filter_operation_statuses="123")
+
+
+async def __async_example():
+    pass
+
+
+if __name__ == '__main__':
+    __example()
+    asyncio.run(__async_example())

arpakitlib/_arpakit_project_template_v1/command/alembic_history.sh

@@ -0,0 +1,2 @@
+cd ..
+alembic history

arpakitlib/_arpakit_project_template_v1/command/alembic_revision_autogenerate.sh

@@ -0,0 +1,2 @@
+cd ..
+alembic revision --autogenerate -m "no_message"

arpakitlib/{_arpakit_project_template/manage/json_beautify.py → _arpakit_project_template_v1/command/beautify_json.py}

@@ -1,10 +1,10 @@
 from arpakitlib.ar_json_util import safely_transfer_str_to_json_obj_to_json_str
 
 
-def __json_beautify():
+def __command():
     s = input("JSON:\n")
     print(safely_transfer_str_to_json_obj_to_json_str(s))
 
 
 if __name__ == '__main__':
-    __json_beautify()
+    __command()

arpakitlib/{_arpakit_project_template/src/core/_check_logging.py → _arpakit_project_template_v1/command/check_logging.py}

@@ -1,14 +1,14 @@
 import logging
 
-from src.core.util import setup_logging
+from core.util import setup_logging
 
 _logger = logging.getLogger(__name__)
 
 
-def _check_logging():
+def __command():
     setup_logging()
     _logger.info("logging is good")
 
 
 if __name__ == '__main__':
-    _check_logging()
+    __command()

arpakitlib/_arpakit_project_template_v1/command/check_sqlalchemy_db.py

@@ -0,0 +1,11 @@
+from core.util import setup_logging
+from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
+
+
+def __command():
+    setup_logging()
+    get_cached_sqlalchemy_db().check_conn()
+
+
+if __name__ == '__main__':
+    __command()

arpakitlib/_arpakit_project_template_v1/command/drop_json_db.py

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

arpakitlib/_arpakit_project_template_v1/command/drop_sqlalchemy_db.py

@@ -0,0 +1,14 @@
+from core.settings import get_cached_settings
+from core.util import setup_logging
+from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
+
+
+def __command():
+    setup_logging()
+    get_cached_settings().raise_if_mode_type_prod()
+    get_cached_sqlalchemy_db().drop()
+    get_cached_sqlalchemy_db().drop_celery_tables()
+
+
+if __name__ == '__main__':
+    __command()

arpakitlib/{_arpakit_project_template/src/core/_generate_settings_env_example.py → _arpakit_project_template_v1/command/generate_settings_env_example.py}

@@ -1,14 +1,14 @@
 import os.path
 
 from arpakitlib.ar_json_util import safely_transfer_obj_to_json_str
-from src.core.const import ProjectPaths
-from src.core.settings import Settings, get_cached_settings
+from core.const import ProjectPaths
+from core.settings import Settings, get_cached_settings
 
 
-def _generate_settings_env_example():
+def __command():
     print(safely_transfer_obj_to_json_str(get_cached_settings().model_dump(mode="json")))
     Settings.save_env_example_to_file(filepath=os.path.join(ProjectPaths.base_dirpath, "example.env"))
 
 
 if __name__ == '__main__':
-    _generate_settings_env_example()
+    __command()

arpakitlib/{_arpakit_project_template/manage → _arpakit_project_template_v1/command}/hello_world.py

@@ -1,6 +1,6 @@
-def __hello_world():
+def __command():
     print("Hello world")
 
 
 if __name__ == '__main__':
-    __hello_world()
+    __command()

arpakitlib/_arpakit_project_template_v1/command/init_json_db.py

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

arpakitlib/_arpakit_project_template_v1/command/init_sqlalchemy_db.py

@@ -0,0 +1,11 @@
+from core.util import setup_logging
+from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
+
+
+def __command():
+    setup_logging()
+    get_cached_sqlalchemy_db().init()
+
+
+if __name__ == '__main__':
+    __command()

arpakitlib/_arpakit_project_template_v1/command/reinit_json_db.py

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

arpakitlib/_arpakit_project_template_v1/command/reinit_sqlalchemy_db.py

@@ -0,0 +1,13 @@
+from core.settings import get_cached_settings
+from core.util import setup_logging
+from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
+
+
+def __command():
+    setup_logging()
+    get_cached_settings().raise_if_mode_type_prod()
+    get_cached_sqlalchemy_db().reinit()
+
+
+if __name__ == '__main__':
+    __command()

arpakitlib/_arpakit_project_template_v1/command/remove_operations.py

@@ -0,0 +1,13 @@
+from business_service.remove_operations import remove_operations
+from core.settings import get_cached_settings
+from core.util import setup_logging
+
+
+def __command():
+    setup_logging()
+    get_cached_settings().raise_if_mode_type_prod()
+    remove_operations()
+
+
+if __name__ == '__main__':
+    __command()

arpakitlib/_arpakit_project_template_v1/command/remove_story_logs.py

@@ -0,0 +1,16 @@
+from core.settings import get_cached_settings
+from core.util import setup_logging
+from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
+from sqlalchemy_db.sqlalchemy_model import StoryLogDBM
+
+
+def __command():
+    setup_logging()
+    get_cached_settings().raise_if_mode_type_prod()
+    with get_cached_sqlalchemy_db().new_session() as session:
+        session.query(StoryLogDBM).delete()
+        session.commit()
+
+
+if __name__ == '__main__':
+    __command()

arpakitlib/_arpakit_project_template_v1/command/rm_all_records_in_json_db.py

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

arpakitlib/{_arpakit_project_template/src/core/_show_settings.py → _arpakit_project_template_v1/command/show_settings.py}

@@ -1,10 +1,10 @@
 from arpakitlib.ar_json_util import safely_transfer_obj_to_json_str
-from src.core.settings import get_cached_settings
+from core.settings import get_cached_settings
 
 
-def _check_settings():
+def __command():
     print(safely_transfer_obj_to_json_str(get_cached_settings().model_dump(mode="json")))
 
 
 if __name__ == '__main__':
-    _check_settings()
+    __command()

arpakitlib/{_arpakit_project_template/src/api/_start_api_with_reload.py → _arpakit_project_template_v1/command/start_api_with_reload.py}

@@ -1,13 +1,13 @@
 import uvicorn
 
-from src.core.settings import get_cached_settings
-from src.core.util import setup_logging
+from core.settings import get_cached_settings
+from core.util import setup_logging
 
 
-def _start_api_for_dev_with_reload():
+def __command():
     setup_logging()
     uvicorn.run(
-        "src.api.asgi:app",
+        "api.asgi:app",
         port=get_cached_settings().api_port,
         host="localhost",
         workers=1,
@@ -16,4 +16,4 @@ def _start_api_for_dev_with_reload():
 
 
 if __name__ == '__main__':
-    _start_api_for_dev_with_reload()
+    __command()

arpakitlib/{_arpakit_project_template/src/api/_start_api_without_reload.py → _arpakit_project_template_v1/command/start_api_without_reload.py}

@@ -1,13 +1,13 @@
 import uvicorn
 
-from src.core.settings import get_cached_settings
-from src.core.util import setup_logging
+from core.settings import get_cached_settings
+from core.util import setup_logging
 
 
-def _start_api_for_dev_without_reload():
+def __command():
     setup_logging()
     uvicorn.run(
-        "src.api.asgi:app",
+        "api.asgi:app",
         port=get_cached_settings().api_port,
         host="localhost",
         workers=1,
@@ -16,4 +16,4 @@ def _start_api_for_dev_without_reload():
 
 
 if __name__ == '__main__':
-    _start_api_for_dev_without_reload()
+    __command()

arpakitlib/_arpakit_project_template_v1/command/start_async_operation_executor_worker.py

@@ -0,0 +1,14 @@
+import asyncio
+
+from core.util import setup_logging
+from operation_execution.operation_executor_worker import create_operation_executor_worker
+
+
+def __command():
+    setup_logging()
+    worker = create_operation_executor_worker()
+    asyncio.run(worker.async_safe_run())
+
+
+if __name__ == '__main__':
+    __command()

arpakitlib/_arpakit_project_template_v1/command/start_async_scheduled_operation_creator_worker.py

@@ -0,0 +1,14 @@
+import asyncio
+
+from core.util import setup_logging
+from operation_execution.scheduled_operation_creator_worker import create_scheduled_operation_creator_worker
+
+
+async def __command():
+    setup_logging()
+    worker = create_scheduled_operation_creator_worker()
+    await worker.async_safe_run()
+
+
+if __name__ == '__main__':
+    asyncio.run(__command())

arpakitlib/_arpakit_project_template_v1/command/start_sync_operation_executor_worker.py

@@ -0,0 +1,15 @@
+from core.util import setup_logging
+from operation_execution.operation_executor_worker import OperationExecutorWorker
+from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
+
+
+def __command():
+    setup_logging()
+    worker = OperationExecutorWorker(
+        sqlalchemy_db=get_cached_sqlalchemy_db(),
+    )
+    worker.sync_safe_run()
+
+
+if __name__ == '__main__':
+    __command()

arpakitlib/_arpakit_project_template_v1/command/start_sync_operation_executor_workers.py

@@ -0,0 +1,22 @@
+from arpakitlib.ar_base_worker_util import safe_run_workers_in_background, SafeRunInBackgroundModes
+from core.util import setup_logging
+from operation_execution.operation_executor_worker import OperationExecutorWorker
+from sqlalchemy_db.sqlalchemy_db import get_cached_sqlalchemy_db
+
+
+def __command():
+    setup_logging()
+    workers = []
+    for i in range(int(input("amount of workers: "))):
+        workers.append(OperationExecutorWorker(
+            sqlalchemy_db=get_cached_sqlalchemy_db(),
+        ))
+    safe_run_workers_in_background(
+        workers=workers,
+        mode=SafeRunInBackgroundModes.thread
+    )
+    input("press to close")
+
+
+if __name__ == '__main__':
+    __command()

arpakitlib/_arpakit_project_template_v1/command/start_sync_scheduled_operation_creator_worker.py

@@ -0,0 +1,12 @@
+from core.util import setup_logging
+from operation_execution.scheduled_operation_creator_worker import create_scheduled_operation_creator_worker
+
+
+def __command():
+    setup_logging()
+    worker = create_scheduled_operation_creator_worker()
+    worker.sync_safe_run()
+
+
+if __name__ == '__main__':
+    __command()

arpakitlib/_arpakit_project_template_v1/core/cache_file_storage_in_dir.py

@@ -0,0 +1,21 @@
+from functools import lru_cache
+
+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:
+    return FileStorageInDir(dirpath=get_cached_settings().cache_dirpath)
+
+
+@lru_cache()
+def get_cached_cache_file_storage_in_dir() -> FileStorageInDir:
+    return create_cache_file_storage_in_dir()
+
+
+def __example():
+    print(get_cached_cache_file_storage_in_dir().dirpath)
+
+
+if __name__ == '__main__':
+    __example()

arpakitlib/{_arpakit_project_template/src → _arpakit_project_template_v1}/core/const.py

@@ -7,25 +7,18 @@ from arpakitlib.ar_json_util import safely_transfer_obj_to_json_str
 
 
 class ProjectPaths(Enumeration):
-    base_dirpath: str = str(pathlib.Path(__file__).parent.parent.parent)
+    base_dirpath: str = str(pathlib.Path(__file__).parent.parent)
 
     env_filename: str = ".env"
     env_filepath: str = os.path.join(base_dirpath, env_filename)
 
-    src_dirname: str = "src"
-    src_dirpath: str = os.path.join(base_dirpath, src_dirname)
-
-    manage_dirname: str = "manage"
-    manage_dirpath: str = os.path.join(base_dirpath, manage_dirname)
-
     resource_dirname: str = "resource"
     resource_dirpath: str = os.path.join(base_dirpath, resource_dirname)
 
     static_dirname: str = "static"
     static_dirpath: str = os.path.join(resource_dirpath, static_dirname)
 
-
-# ...
+    arpakit_lib_project_template_filepath: str = os.path.join(base_dirpath, "arpakitlib_project_template.json")
 
 
 def __example():

arpakitlib/_arpakit_project_template_v1/core/dump_file_storage_in_dir.py

@@ -0,0 +1,21 @@
+from functools import lru_cache
+
+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:
+    return FileStorageInDir(dirpath=get_cached_settings().dump_dirpath)
+
+
+@lru_cache()
+def get_cached_dump_file_storage_in_dir() -> FileStorageInDir:
+    return create_dump_file_storage_in_dir()
+
+
+def __example():
+    print(get_cached_dump_file_storage_in_dir().dirpath)
+
+
+if __name__ == '__main__':
+    __example()

arpakitlib/_arpakit_project_template_v1/core/media_file_storage_in_dir.py

@@ -0,0 +1,21 @@
+from functools import lru_cache
+
+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:
+    return FileStorageInDir(dirpath=get_cached_settings().media_dirpath)
+
+
+@lru_cache()
+def get_cached_media_file_storage_in_dir() -> FileStorageInDir:
+    return create_media_file_storage_in_dir()
+
+
+def __example():
+    print(get_cached_media_file_storage_in_dir().dirpath)
+
+
+if __name__ == '__main__':
+    __example()