arpakitlib 1.7.250__py3-none-any.whl → 1.7.253__py3-none-any.whl

arpakitlib/_arpakit_project_template/alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

arpakitlib/_arpakit_project_template/alembic/env.py

@@ -0,0 +1,83 @@
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from src.core.settings import get_cached_settings
+from src.sql_db.util import get_base_dbm
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+config.set_section_option("alembic", "sqlalchemy.url", get_cached_settings().sync_sql_db_url)
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = get_base_dbm().metadata
+
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection, target_metadata=target_metadata
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

arpakitlib/_arpakit_project_template/alembic/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

arpakitlib/_arpakit_project_template/alembic.ini

@@ -0,0 +1,119 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+# version_path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+version_path_separator = os
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

arpakitlib/_arpakit_project_template/example.env

@@ -4,29 +4,20 @@
 # sql_db_password=
 # sql_db_port=
 # sql_db_database=
-# sql_db_url=
+# sync_sql_db_url=
 # async_sql_db_url=
 # sql_db_echo=
-# api_init_sql_db_at_start=
-# api_title=
-# api_description=
-# api_logging_func_before_response=
-# api_story_log_func_before_response=
-# api_start_operation_executor_worker=
-# api_start_scheduled_operation_creator_worker=
 # api_port=
+# api_init_sql_db_at_start=
+# api_logging__api_func_before_in_handle_exception=
+# api_story_log__api_func_before_in_handle_exception=
 # api_correct_api_key=
 # api_correct_token=
 # api_enable_admin1=
-# var_dirname=
+# admin1_secret_key=
 # var_dirpath=
-# log_filename=
 # log_filepath=
-# cache_dirname=
 # cache_dirpath=
-# media_dirname=
 # media_dirpath=
-# dump_dirname=
 # dump_dirpath=
 # local_timezone=
-# admin1_secret_key=

arpakitlib/_arpakit_project_template/manage/docker_rm_postgres.sh

@@ -0,0 +1,3 @@
+cd ..
+source .env
+docker rm -f ${project_name}_postgres

arpakitlib/_arpakit_project_template/manage/docker_run_postgres.sh

@@ -1,4 +1,5 @@
 cd ..
-docker rm {{PROJECT_NAME}}_postgres
-docker run --name {{PROJECT_NAME}}_postgres -d -p {{SQL_DB_PORT}}:5432 -e POSTGRES_USER={{PROJECT_NAME}} -e POSTGRES_PASSWORD={{PROJECT_NAME}} -e POSTGRES_DB={{PROJECT_NAME}} postgres:16 -c max_connections=100
-docker start {{PROJECT_NAME}}_postgres
+source .env
+docker rm ${project_name}_postgres
+docker run --name ${project_name}_postgres -d -p ${sql_db_port}:5432 -e POSTGRES_USER=${sql_db_user} -e POSTGRES_PASSWORD=${sql_db_password} -e POSTGRES_DB=${sql_db_database} postgres:16 -c max_connections=100
+docker start ${project_name}_postgres

arpakitlib/_arpakit_project_template/manage/docker_start_postgres.sh

@@ -1,2 +1,3 @@
 cd ..
-docker start {{PROJECT_NAME}}_postgres
+source .env
+docker start ${project_name}_postgres

arpakitlib/_arpakit_project_template/manage/docker_stop_postgres.sh

@@ -1,2 +1,3 @@
 cd ..
-docker stop {{PROJECT_NAME}}_postgres
+source .env
+docker stop ${project_name}_postgres

arpakitlib/_arpakit_project_template/manage/git_set_arpakit_company_origin.sh

@@ -1,7 +1,9 @@
 cd ..
 
+source .env
+
 git remote remove arpakit_company_github_1
-git remote add arpakit_company_github_1 git@github.com:ARPAKIT-Company/{{PROJECT_NAME}}.git
+git remote add arpakit_company_github_1 git@github.com:ARPAKIT-Company/${project_name}.git
 
 git remote remove arpakit_company_gitlab_1
-git remote add arpakit_company_gitlab_1 git@gitlab.com:ARPAKIT-Company/{{PROJECT_NAME}}.git
+git remote add arpakit_company_gitlab_1 git@gitlab.com:ARPAKIT-Company/${project_name}.git

arpakitlib/_arpakit_project_template/manage/git_set_arpakit_origin.sh

@@ -1,7 +1,9 @@
 cd ..
 
+source .env
+
 git remote remove arpakit_github_1
-git remote add arpakit_github_1 git@github.com:arpakit/{{PROJECT_NAME}}.git
+git remote add arpakit_github_1 git@github.com:arpakit/${project_name}.git
 
 git remote remove arpakit_gitlab_1
-git remote add arpakit_gitlab_1 git@gitlab.com:arpakit/{{PROJECT_NAME}}.git
+git remote add arpakit_gitlab_1 git@gitlab.com:arpakit/${project_name}.git

arpakitlib/_arpakit_project_template/src/additional_model/additional_model.py

@@ -1,8 +1 @@
-from arpakitlib.ar_additional_model_util import BaseAM
-
-
-class ExampleAM(BaseAM):
-    name: str = "Name"
-    surname: str = "Surname"
-
 # ...

arpakitlib/_arpakit_project_template/src/api/auth.py

@@ -1 +1,53 @@
 # ...
+from typing import Callable
+
+import starlette.requests
+
+from arpakitlib.ar_fastapi_util import BaseAPIAuthData
+from src.api.transmitted_api_data import TransmittedAPIData
+
+
+def correct_api_key_from_settings__validate_api_key_func(
+        *args, **kwargs
+) -> Callable:
+    async def func(
+            *,
+            api_key_string: str | None,
+            token_string: str | None,
+            base_api_auth_data: BaseAPIAuthData,
+            transmitted_api_data: TransmittedAPIData,
+            request: starlette.requests.Request,
+            **kwargs_
+    ):
+        if transmitted_api_data.settings.api_correct_api_key is None:
+            return True
+        if not api_key_string:
+            return False
+        if api_key_string.strip() != transmitted_api_data.settings.api_correct_api_key.strip():
+            return False
+        return True
+
+    return func
+
+
+def correct_token_from_settings__validate_api_key_func(
+        *args, **kwargs
+) -> Callable:
+    async def func(
+            *,
+            api_key_string: str | None,
+            token_string: str | None,
+            base_api_auth_data: BaseAPIAuthData,
+            transmitted_api_data: TransmittedAPIData,
+            request: starlette.requests.Request,
+            **kwargs_
+    ):
+        if transmitted_api_data.settings.api_correct_token is None:
+            return True
+        if not token_string:
+            return False
+        if token_string.strip() != transmitted_api_data.settings.api_correct_token.strip():
+            return False
+        return True
+
+    return func

arpakitlib/_arpakit_project_template/src/api/create_api_app.py

@@ -2,14 +2,14 @@ from fastapi import FastAPI
 
 from arpakitlib.ar_fastapi_util import create_fastapi_app
 from src.api.create_handle_exception_ import create_handle_exception_
-from src.api.event import StartupAPIEvent, ShutdownAPIEvent
+from src.api.event import get_startup_api_events, get_shutdown_api_events
 from src.api.router.main_router import main_api_router
 from src.api.transmitted_api_data import TransmittedAPIData
 from src.core.const import ProjectPaths
 from src.core.settings import get_cached_settings
 from src.core.util import setup_logging, get_cached_media_file_storage_in_dir, get_cached_cache_file_storage_in_dir, \
     get_cached_dump_file_storage_in_dir
-from src.db.util import get_cached_sqlalchemy_db
+from src.sql_db.util import get_cached_sqlalchemy_db
 
 
 def create_api_app() -> FastAPI:
@@ -19,28 +19,35 @@ def create_api_app() -> FastAPI:
 
     sqlalchemy_db = get_cached_sqlalchemy_db() if settings.sql_db_url 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,
-        media_file_storage_in_dir=get_cached_media_file_storage_in_dir(),
-        cache_file_storage_in_dir=get_cached_cache_file_storage_in_dir(),
-        dump_file_storage_in_dir=get_cached_dump_file_storage_in_dir()
+        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
     )
 
-    startup_api_events = []
-
-    startup_api_events.append(StartupAPIEvent(transmitted_api_data=transmitted_api_data))
-
-    shutdown_api_events = []
+    handle_exception_ = create_handle_exception_(transmitted_api_data=transmitted_api_data)
 
-    shutdown_api_events.append(ShutdownAPIEvent(transmitted_api_data=transmitted_api_data))
+    startup_api_events = get_startup_api_events(transmitted_api_data=transmitted_api_data)
 
-    handle_exception_ = create_handle_exception_(transmitted_api_data=transmitted_api_data)
+    shutdown_api_events = get_shutdown_api_events(transmitted_api_data=transmitted_api_data)
 
     api_app = create_fastapi_app(
-        title=settings.api_title.strip(),
-        description=settings.api_description.strip(),
-        log_filepath=settings.log_filepath,
+        title=settings.project_name.strip(),
+        description=settings.project_name.strip(),
         handle_exception_=handle_exception_,
         startup_api_events=startup_api_events,
         shutdown_api_events=shutdown_api_events,

arpakitlib/_arpakit_project_template/src/api/create_handle_exception_.py

@@ -2,18 +2,18 @@ import fastapi.exceptions
 import starlette.exceptions
 import starlette.status
 
-from arpakitlib.ar_fastapi_util import create_handle_exception, story_log_func_before_response, \
-    logging_func_before_response
+from arpakitlib.ar_fastapi_util import create_handle_exception, story_log__api_func_before_in_handle_exception, \
+    logging__api_func_before_in_handle_exception
 from src.api.const import APIErrorCodes
 from src.api.transmitted_api_data import TransmittedAPIData
 
 
-def create_handle_exception_(*, transmitted_api_data: TransmittedAPIData):
-    funcs_before_response = []
+def create_handle_exception_(*, transmitted_api_data: TransmittedAPIData, **kwargs):
+    funcs_before = []
 
-    if transmitted_api_data.settings.api_logging_func_before_response:
-        funcs_before_response.append(
-            logging_func_before_response(
+    if transmitted_api_data.settings.api_logging__api_func_before_in_handle_exception:
+        funcs_before.append(
+            logging__api_func_before_in_handle_exception(
                 ignore_api_error_codes=[
                     APIErrorCodes.cannot_authorize,
                     APIErrorCodes.error_in_request,
@@ -31,9 +31,9 @@ def create_handle_exception_(*, transmitted_api_data: TransmittedAPIData):
             )
         )
 
-    if transmitted_api_data.settings.api_story_log_func_before_response:
-        funcs_before_response.append(
-            story_log_func_before_response(
+    if transmitted_api_data.settings.api_story_log__api_func_before_in_handle_exception:
+        funcs_before.append(
+            story_log__api_func_before_in_handle_exception(
                 sqlalchemy_db=transmitted_api_data.sqlalchemy_db,
                 ignore_api_error_codes=[
                     APIErrorCodes.cannot_authorize,
@@ -51,9 +51,9 @@ def create_handle_exception_(*, transmitted_api_data: TransmittedAPIData):
             )
         )
 
-    async_funcs_after_response = []
+    async_funcs_after = []
 
     return create_handle_exception(
-        funcs_before_response=funcs_before_response,
-        async_funcs_after_response=async_funcs_after_response
+        funcs_before=funcs_before,
+        async_funcs_after=async_funcs_after
     )

arpakitlib/_arpakit_project_template/src/api/event.py

@@ -1,13 +1,16 @@
 from arpakitlib.ar_base_worker_util import safe_run_worker_in_background, SafeRunInBackgroundModes
 from arpakitlib.ar_fastapi_util import BaseStartupAPIEvent, BaseShutdownAPIEvent
 from arpakitlib.ar_operation_execution_util import OperationExecutorWorker, ScheduledOperationCreatorWorker
-from arpakitlib.ar_sqlalchemy_util import SQLAlchemyDB
+from arpakitlib.ar_sqlalchemy_util import SQLAlchemyDb
 from arpakitlib.ar_type_util import raise_for_type
 from src.api.transmitted_api_data import TransmittedAPIData
 from src.operation_execution.operation_executor import OperationExecutor
 from src.operation_execution.scheduled_operations import SCHEDULED_OPERATIONS
 
 
+# STARTUP API EVENTS
+
+
 class StartupAPIEvent(BaseStartupAPIEvent):
     def __init__(self, transmitted_api_data: TransmittedAPIData, **kwargs):
         super().__init__(**kwargs)
@@ -26,11 +29,11 @@ class StartupAPIEvent(BaseStartupAPIEvent):
             self.transmitted_api_data.dump_file_storage_in_dir.init()
 
         if self.transmitted_api_data.settings.api_init_sql_db_at_start:
-            raise_for_type(self.transmitted_api_data.sqlalchemy_db, SQLAlchemyDB)
+            raise_for_type(self.transmitted_api_data.sqlalchemy_db, SQLAlchemyDb)
             self.transmitted_api_data.sqlalchemy_db.init()
 
-        if self.transmitted_api_data.settings.api_start_operation_executor_worker:
-            raise_for_type(self.transmitted_api_data.sqlalchemy_db, SQLAlchemyDB)
+        if self.transmitted_api_data.settings.api_start_operation_executor_worker:  # TODO
+            raise_for_type(self.transmitted_api_data.sqlalchemy_db, SQLAlchemyDb)
             _ = safe_run_worker_in_background(
                 worker=OperationExecutorWorker(
                     sqlalchemy_db=self.transmitted_api_data.sqlalchemy_db,
@@ -40,8 +43,8 @@ class StartupAPIEvent(BaseStartupAPIEvent):
                 mode=SafeRunInBackgroundModes.thread
             )
 
-        if self.transmitted_api_data.settings.api_start_scheduled_operation_creator_worker:
-            raise_for_type(self.transmitted_api_data.sqlalchemy_db, SQLAlchemyDB)
+        if self.transmitted_api_data.settings.api_start_scheduled_operation_creator_worker:  # TODO
+            raise_for_type(self.transmitted_api_data.sqlalchemy_db, SQLAlchemyDb)
             _ = safe_run_worker_in_background(
                 worker=ScheduledOperationCreatorWorker(
                     sqlalchemy_db=self.transmitted_api_data.sqlalchemy_db,
@@ -53,6 +56,17 @@ class StartupAPIEvent(BaseStartupAPIEvent):
         self._logger.info("finish")
 
 
+def get_startup_api_events(
+        *, transmitted_api_data: TransmittedAPIData, **kwargs
+) -> list[BaseStartupAPIEvent]:
+    res = []
+    res.append(StartupAPIEvent(transmitted_api_data=transmitted_api_data))
+    return res
+
+
+# SHUTDOWN API EVENTS
+
+
 class ShutdownAPIEvent(BaseShutdownAPIEvent):
     def __init__(self, transmitted_api_data: TransmittedAPIData, **kwargs):
         super().__init__(**kwargs)
@@ -61,3 +75,11 @@ class ShutdownAPIEvent(BaseShutdownAPIEvent):
     async def async_on_shutdown(self, *args, **kwargs):
         self._logger.info("start")
         self._logger.info("finish")
+
+
+def get_shutdown_api_events(
+        *, transmitted_api_data: TransmittedAPIData, **kwargs
+) -> list[BaseShutdownAPIEvent]:
+    res = []
+    res.append(ShutdownAPIEvent(transmitted_api_data=transmitted_api_data))
+    return res

arpakitlib/_arpakit_project_template/src/api/transmitted_api_data.py

@@ -1,15 +1,7 @@
-from arpakitlib.ar_fastapi_util import BaseTransmittedAPIData
-from arpakitlib.ar_file_storage_in_dir_util import FileStorageInDir
-from arpakitlib.ar_sqlalchemy_util import SQLAlchemyDB
+from arpakitlib.ar_fastapi_util import AdvancedTransmittedAPIData
 
 from src.core.settings import Settings
 
 
-class TransmittedAPIData(BaseTransmittedAPIData):
-    settings: Settings
-    sqlalchemy_db: SQLAlchemyDB | 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
-
-    # ...
+class TransmittedAPIData(AdvancedTransmittedAPIData):
+    settings: Settings | None = None