arpakitlib 1.7.17__tar.gz → 1.7.19__tar.gz

{arpakitlib-1.7.17 → arpakitlib-1.7.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: arpakitlib
-Version: 1.7.17
+Version: 1.7.19
 Summary: arpakitlib
 Home-page: https://github.com/ARPAKIT-Company/arpakitlib
 License: Apache-2.0
@@ -8,7 +8,7 @@ Keywords: arpakitlib,arpakit,arpakit-company,arpakitcompany,arpakit_company
 Author: arpakit
 Author-email: arpakit@gmail.com
 Requires-Python: >=3.12,<4.0
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent

arpakitlib-1.7.19/arpakitlib/_arpakit_project_template/manage/example_init_arpakit_project_template.sh

@@ -0,0 +1 @@
+arpakitlib -c init_arpakit_project_template -project_dirpath ./ -overwrite_if_exists ... -project_name ... -sql_db_port ... -api_port ... -ignore_paths_startswith ... -only_paths_startswith ...

arpakitlib-1.7.19/arpakitlib/_arpakit_project_template/manage/start_api_for_dev_with_reload.py

@@ -0,0 +1,9 @@
+from src.api.start_api_for_dev import start_api_for_dev
+
+
+def command():
+    start_api_for_dev(reload=True)
+
+
+if __name__ == '__main__':
+    command()

arpakitlib-1.7.19/arpakitlib/_arpakit_project_template/manage/start_api_for_dev_without_reload.py

@@ -0,0 +1,9 @@
+from src.api.start_api_for_dev import start_api_for_dev
+
+
+def command():
+    start_api_for_dev(reload=False)
+
+
+if __name__ == '__main__':
+    command()

arpakitlib-1.7.19/arpakitlib/_arpakit_project_template/src/api/create_api_app.py

@@ -0,0 +1,61 @@
+from fastapi import FastAPI
+
+from arpakitlib.ar_fastapi_util import create_fastapi_app, InitSqlalchemyDBStartupAPIEvent, InitFileStoragesInDir, \
+    create_handle_exception, create_handle_exception_creating_story_log
+from src.api.event import FirstStartupAPIEvent, FirstShutdownAPIEvent
+from src.api.router.v1.main_router import api_v1_main_router
+from src.api.transmitted_api_data import TransmittedAPIData
+from src.core.settings import get_cached_settings
+from src.core.util import get_cached_sqlalchemy_db, get_cached_media_file_storage_in_dir, \
+    get_cached_cache_file_storage_in_dir, get_cached_dump_file_storage_in_dir, setup_logging
+
+
+def create_api_app() -> FastAPI:
+    setup_logging()
+
+    settings = get_cached_settings()
+    sqlalchemy_db = get_cached_sqlalchemy_db() if settings.sql_db_url is not None else None
+
+    transmitted_api_data = TransmittedAPIData(
+        settings=get_cached_settings(),
+        sqlalchemy_db=sqlalchemy_db
+    )
+
+    api_app = create_fastapi_app(
+        title="{PROJECT_NAME}",
+        description="{PROJECT_NAME}",
+        log_filepath=get_cached_settings().log_filepath,
+        handle_exception_=create_handle_exception(
+            funcs_before_response=[
+                create_handle_exception_creating_story_log(sqlalchemy_db=sqlalchemy_db)
+                if sqlalchemy_db is not None else None
+            ],
+            async_funcs_after_response=[]
+        ),
+        startup_api_events=[
+            FirstStartupAPIEvent(transmitted_api_data=transmitted_api_data),
+            InitFileStoragesInDir(
+                file_storages_in_dir=[
+                    get_cached_media_file_storage_in_dir(),
+                    get_cached_cache_file_storage_in_dir(),
+                    get_cached_dump_file_storage_in_dir()
+                ]
+            ),
+            (
+                InitSqlalchemyDBStartupAPIEvent(sqlalchemy_db=sqlalchemy_db)
+                if (sqlalchemy_db is not None and settings.init_sql_db_at_start) else None
+            ),
+        ],
+        shutdown_api_events=[
+            FirstShutdownAPIEvent(transmitted_api_data=transmitted_api_data)
+        ],
+        transmitted_api_data=transmitted_api_data,
+        main_api_router=api_v1_main_router,
+        media_dirpath=settings.media_dirpath
+    )
+
+    return api_app
+
+
+if __name__ == '__main__':
+    create_api_app()

{arpakitlib-1.7.17 → arpakitlib-1.7.19}/arpakitlib/_arpakit_project_template/src/api/event.py

@@ -6,19 +6,19 @@ from src.api.transmitted_api_data import TransmittedAPIData
 _logger = logging.getLogger(__name__)
 
 
-class StartupAPIEvent(BaseStartupAPIEvent):
+class FirstStartupAPIEvent(BaseStartupAPIEvent):
     def __init__(self, transmitted_api_data: TransmittedAPIData):
         super().__init__()
         self.transmitted_api_data = transmitted_api_data
 
     async def async_on_startup(self, *args, **kwargs):
-        pass
+        self._logger.info(self.__class__.__name__)
 
 
-class ShutdownAPIEvent(BaseShutdownAPIEvent):
+class FirstShutdownAPIEvent(BaseShutdownAPIEvent):
     def __init__(self, transmitted_api_data: TransmittedAPIData):
         super().__init__()
         self.transmitted_api_data = transmitted_api_data
 
     async def async_on_shutdown(self, *args, **kwargs):
-        pass
+        self._logger.info(self.__class__.__name__)

arpakitlib-1.7.19/arpakitlib/_arpakit_project_template/src/api/router/v1/main_router.py

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

{arpakitlib-1.7.17 → arpakitlib-1.7.19}/arpakitlib/_arpakit_project_template/src/api/start_api_for_dev.py

@@ -1,10 +1,10 @@
 import uvicorn
 
 
-def start_app_for_dev(reload: bool = True):
+def start_api_for_dev(reload: bool = True):
     uvicorn.run(
         "src.api.asgi:app",
-        port=...,
+        port=int("{API_PORT}"),
         host="localhost",
         workers=1,
         reload=reload
@@ -12,4 +12,4 @@ def start_app_for_dev(reload: bool = True):
 
 
 if __name__ == '__main__':
-    start_app_for_dev()
+    start_api_for_dev()

{arpakitlib-1.7.17 → arpakitlib-1.7.19}/arpakitlib/_arpakit_project_template/src/core/settings.py

@@ -34,6 +34,8 @@ class Settings(SimpleSettings):
         "postgresql://{PROJECT_NAME}:{PROJECT_NAME}@127.0.0.1:{SQL_DB_PORT}/{PROJECT_NAME}"
     )
 
+    init_sql_db_at_start: bool = False
+
     sql_db_echo: bool = False
 
 

arpakitlib-1.7.17/arpakitlib/ar_project_template_util.py → arpakitlib-1.7.19/arpakitlib/ar_arpakit_project_template_util.py

@@ -4,6 +4,7 @@ import logging
 import os
 
 from arpakitlib.ar_str_util import make_none_if_blank, raise_if_string_blank
+from arpakitlib.ar_type_util import raise_for_type
 
 _ARPAKIT_LIB_MODULE_VERSION = "3.0"
 
@@ -15,8 +16,10 @@ def init_arpakit_project_template(
         project_dirpath: str,
         overwrite_if_exists: bool = False,
         project_name: str | None = None,
+        sql_db_port: int | None = None,
+        api_port: int | None = None,
         ignore_paths_startswith: list[str] | str | None = None,
-        only_paths_startswith: list[str] | str | None = None
+        only_paths_startswith: list[str] | str | None = None,
 ):
     raise_if_string_blank(project_dirpath)
 
@@ -24,6 +27,12 @@ def init_arpakit_project_template(
         project_name = project_name.strip()
     project_name = make_none_if_blank(project_name)
 
+    if sql_db_port is not None:
+        raise_for_type(sql_db_port, int)
+
+    if api_port is not None:
+        raise_for_type(api_port, int)
+
     if isinstance(ignore_paths_startswith, str):
         ignore_paths_startswith = [ignore_paths_startswith]
     if ignore_paths_startswith is None:
@@ -59,8 +68,12 @@ def init_arpakit_project_template(
                     continue
                 with open(os.path.join(root, file), "r", encoding="utf-8") as _file:
                     _content = _file.read()
-                if project_name:
+                if project_name is not None:
                     _content = _content.replace("{PROJECT_NAME}", project_name)
+                if sql_db_port is not None:
+                    _content = _content.replace("{SQL_DB_PORT}", str(sql_db_port))
+                if api_port is not None:
+                    _content = _content.replace("{API_PORT}", str(api_port))
                 res[rel_path] = _content
         return res
 

{arpakitlib-1.7.17 → arpakitlib-1.7.19}/arpakitlib/ar_arpakitlib_cli_util.py

@@ -2,9 +2,9 @@
 
 import sys
 
+from arpakitlib.ar_arpakit_project_template_util import init_arpakit_project_template
 from arpakitlib.ar_need_type_util import parse_need_type, NeedTypes
 from arpakitlib.ar_parse_command import parse_command
-from arpakitlib.ar_project_template_util import init_arpakit_project_template
 from arpakitlib.ar_str_util import raise_if_string_blank
 
 
@@ -25,7 +25,8 @@ def execute_arpakitlib_cli(*, full_command: str | None = None):
         print(
             "Commands:"
             "\n- init_arpakit_project_template"
-            " (project_dirpath, overwrite_if_exists, project_name, ignore_paths_startswith, only_paths_startswith)"
+            " (project_dirpath, overwrite_if_exists, project_name, sql_db_port, api_port,"
+            " ignore_paths_startswith, only_paths_startswith)"
         )
 
     elif command == "init_arpakit_project_template":
@@ -36,7 +37,17 @@ def execute_arpakitlib_cli(*, full_command: str | None = None):
             allow_none=False
         )
         project_name: str = parsed_command.get_value_by_keys(keys=["pm", "project_name"])
-        project_name = project_name if project_name.strip() else None
+        project_name = project_name.strip() if project_name.strip() else None
+        sql_db_port: int | None = parse_need_type(
+            value=parsed_command.get_value_by_keys(keys=["sdp", "sql_db_port"]),
+            need_type=NeedTypes.int_,
+            allow_none=True
+        )
+        api_port: int | None = parse_need_type(
+            value=parsed_command.get_value_by_keys(keys=["ap", "api_port"]),
+            need_type=NeedTypes.int_,
+            allow_none=True
+        )
         ignore_paths_startswith: list[str] | None = parse_need_type(
             value=parsed_command.get_value_by_keys(keys=["ipsw", "ignore_paths_startswith"]),
             need_type=NeedTypes.list_of_str,
@@ -48,7 +59,8 @@ def execute_arpakitlib_cli(*, full_command: str | None = None):
             allow_none=True
         )
         init_arpakit_project_template(
-            project_dirpath=project_dirpath, overwrite_if_exists=overwrite_if_exists, project_name=project_name,
+            project_dirpath=project_dirpath, overwrite_if_exists=overwrite_if_exists,
+            project_name=project_name, sql_db_port=sql_db_port, api_port=api_port,
             ignore_paths_startswith=ignore_paths_startswith, only_paths_startswith=only_paths_startswith
         )
 

{arpakitlib-1.7.17 → arpakitlib-1.7.19}/arpakitlib/ar_fastapi_util.py

@@ -7,6 +7,7 @@ import logging
 import os.path
 import pathlib
 import traceback
+from contextlib import suppress
 from datetime import datetime
 from typing import Any, Callable
 
@@ -19,7 +20,6 @@ import starlette.status
 from fastapi import FastAPI, APIRouter, Query, Security
 from fastapi.openapi.docs import get_swagger_ui_html, get_redoc_html
 from fastapi.security import APIKeyHeader
-from jaraco.context import suppress
 from pydantic import BaseModel, ConfigDict
 from starlette.middleware.cors import CORSMiddleware
 from starlette.staticfiles import StaticFiles
@@ -147,14 +147,16 @@ class APIException(fastapi.exceptions.HTTPException):
 
 def create_handle_exception(
         *,
-        funcs_before_response: list[Callable] | None = None,
-        async_funcs_after_response: list[Callable] | None = None,
-) -> Any:
+        funcs_before_response: list[Callable | None] | None = None,
+        async_funcs_after_response: list[Callable | None] | None = None,
+) -> Callable:
     if funcs_before_response is None:
         funcs_before_response = []
+    funcs_before_response = [v for v in funcs_before_response if v is not None]
 
     if async_funcs_after_response is None:
         async_funcs_after_response = []
+    async_funcs_after_response = [v for v in async_funcs_after_response if v is not None]
 
     async def handle_exception(
             request: starlette.requests.Request, exception: Exception
@@ -564,7 +566,7 @@ def simple_api_router_for_testing():
 
 
 _DEFAULT_CONTACT = {
-    "name": "arpakit",
+    "name": "ARPAKIT Company",
     "email": "support@arpakit.com"
 }
 
@@ -575,8 +577,8 @@ def create_fastapi_app(
         description: str | None = "arpakitlib FastAPI",
         log_filepath: str | None = "./story.log",
         handle_exception_: Callable | None = create_handle_exception(),
-        startup_api_events: list[BaseStartupAPIEvent] | None = None,
-        shutdown_api_events: list[BaseShutdownAPIEvent] | None = None,
+        startup_api_events: list[BaseStartupAPIEvent | None] | None = None,
+        shutdown_api_events: list[BaseShutdownAPIEvent | None] | None = None,
         transmitted_api_data: BaseTransmittedAPIData = BaseTransmittedAPIData(),
         main_api_router: APIRouter = simple_api_router_for_testing(),
         contact: dict[str, Any] | None = None,
@@ -589,9 +591,11 @@ def create_fastapi_app(
 
     if not startup_api_events:
         startup_api_events = [BaseStartupAPIEvent()]
+    startup_api_events = [v for v in startup_api_events if v is not None]
 
     if not shutdown_api_events:
         shutdown_api_events = [BaseShutdownAPIEvent()]
+    shutdown_api_events = [v for v in shutdown_api_events if v is not None]
 
     app = FastAPI(
         title=title,

{arpakitlib-1.7.17 → arpakitlib-1.7.19}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "arpakitlib"
-version = "1.7.17"
+version = "1.7.19"
 description = "arpakitlib"
 authors = ["arpakit <arpakit@gmail.com>", "arpakit_support <support@arpakit.com>"]
 license = "Apache License 2.0"
@@ -8,7 +8,7 @@ readme = "README.md"
 keywords = ["arpakitlib", "arpakit", "arpakit-company", "arpakitcompany", "arpakit_company"]
 package-mode = true
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: Apache Software License",
     "Programming Language :: Python",

arpakitlib-1.7.17/arpakitlib/_arpakit_project_template/manage/example_init_arpakit_project_template.sh

@@ -1 +0,0 @@
-arpakitlib -c init_arpakit_project_template -project_dirpath ./ -overwrite_if_exists ... -project_name ... -ignore_paths_startswith ... -only_paths_startswith ...

arpakitlib-1.7.17/arpakitlib/_arpakit_project_template/src/api/create_api_app.py

@@ -1,5 +0,0 @@
-from fastapi import FastAPI
-
-
-def create_api_app() -> FastAPI:
-    pass