diff --git a/src/fastapi_app/.env.example b/src/fastapi_app/.env.example index 59d34a6..64d1c9a 100644 --- a/src/fastapi_app/.env.example +++ b/src/fastapi_app/.env.example @@ -9,3 +9,5 @@ API_HOST=0.0.0.0 API_PORT=8000 JWT_SECRET_KEY=v9LctjUWwol4XbvczPiLFMDtZ8aal7mm + +APP_RELOAD=True diff --git a/src/fastapi_app/bin/__main__.py b/src/fastapi_app/bin/__main__.py index f7e51e9..82dab4d 100644 --- a/src/fastapi_app/bin/__main__.py +++ b/src/fastapi_app/bin/__main__.py @@ -1,17 +1,37 @@ +import asyncio import logging +import os -import uvicorn - -import lib.app.app as app_module -import lib.app.settings as app_settings +import lib.app as app logger = logging.getLogger(__name__) -app_instance = app_module.Application() -app = app_instance.create_app() -settings = app_settings.settings +async def run() -> None: + settings = app.Settings() + application = app.Application.from_settings(settings) + + try: + await application.start() + finally: + await application.dispose() + + +def main() -> None: + try: + asyncio.run(run()) + exit(os.EX_OK) + except SystemExit: + exit(os.EX_OK) + except app.ApplicationError: + exit(os.EX_SOFTWARE) + except KeyboardInterrupt: + logger.info("Exited with keyboard interruption") + exit(os.EX_OK) + except BaseException: + logger.exception("Unexpected error occurred") + exit(os.EX_SOFTWARE) if __name__ == "__main__": - uvicorn.run(app, host=settings.api.host, port=settings.api.port) + main() diff --git a/src/fastapi_app/lib/api/v1/handlers/__init__.py b/src/fastapi_app/lib/api/v1/handlers/__init__.py index e69de29..4df1385 100644 --- a/src/fastapi_app/lib/api/v1/handlers/__init__.py +++ b/src/fastapi_app/lib/api/v1/handlers/__init__.py @@ -0,0 +1,5 @@ +from .health import * + +__all__ = [ + "health_router", +] diff --git a/src/fastapi_app/lib/api/v1/handlers/health/__init__.py b/src/fastapi_app/lib/api/v1/handlers/health/__init__.py new file mode 100644 index 0000000..48a8b68 --- /dev/null +++ b/src/fastapi_app/lib/api/v1/handlers/health/__init__.py @@ -0,0 +1,5 @@ +from .liveness_probe import router as health_router + +__all__ = [ + "health_router", +] diff --git a/src/fastapi_app/lib/api/v1/handlers/health/liveness_probe.py b/src/fastapi_app/lib/api/v1/handlers/health/liveness_probe.py new file mode 100644 index 0000000..d3fbbce --- /dev/null +++ b/src/fastapi_app/lib/api/v1/handlers/health/liveness_probe.py @@ -0,0 +1,15 @@ +import fastapi + +import lib.api.v1.schemas as api_shemas + +router = fastapi.APIRouter() + + +@router.get( + "/", + response_model=api_shemas.HealthResponseModel, + summary="Статус работоспособности", + description="Проверяет доступность сервиса FastAPI.", +) +async def health(): + return api_shemas.HealthResponseModel(status="healthy") diff --git a/src/fastapi_app/lib/api/v1/schemas/__init__.py b/src/fastapi_app/lib/api/v1/schemas/__init__.py index e69de29..06d8e5f 100644 --- a/src/fastapi_app/lib/api/v1/schemas/__init__.py +++ b/src/fastapi_app/lib/api/v1/schemas/__init__.py @@ -0,0 +1,6 @@ +from .base import * + +__all__ = [ + "HealthResponseModel", + "TokenResponseModel", +] diff --git a/src/fastapi_app/lib/api/v1/schemas/base.py b/src/fastapi_app/lib/api/v1/schemas/base.py new file mode 100644 index 0000000..3de6237 --- /dev/null +++ b/src/fastapi_app/lib/api/v1/schemas/base.py @@ -0,0 +1,12 @@ +import uuid + +import pydantic + + +class TokenResponseModel(pydantic.BaseModel): + sub: uuid.UUID + exp: int | None = None + + +class HealthResponseModel(pydantic.BaseModel): + status: str = pydantic.Field(default=..., examples=["healthy"], description="Схема доступности сервиса") diff --git a/src/fastapi_app/lib/api/v1/schemas/entity.py b/src/fastapi_app/lib/api/v1/schemas/entity.py deleted file mode 100644 index 73c898f..0000000 --- a/src/fastapi_app/lib/api/v1/schemas/entity.py +++ /dev/null @@ -1,8 +0,0 @@ -import uuid - -import pydantic - - -class Token(pydantic.BaseModel): - sub: uuid.UUID - exp: int | None = None diff --git a/src/fastapi_app/lib/app/__init__.py b/src/fastapi_app/lib/app/__init__.py index e69de29..1118bb7 100644 --- a/src/fastapi_app/lib/app/__init__.py +++ b/src/fastapi_app/lib/app/__init__.py @@ -0,0 +1,11 @@ +from .app import Application +from .errors import * +from .settings import Settings + +__all__ = [ + "Application", + "Settings", + "ApplicationError", + "DisposeError", + "StartServerError", +] diff --git a/src/fastapi_app/lib/app/app.py b/src/fastapi_app/lib/app/app.py index 6e24e89..ea25a43 100644 --- a/src/fastapi_app/lib/app/app.py +++ b/src/fastapi_app/lib/app/app.py @@ -1,36 +1,123 @@ +import dataclasses import logging +import logging.config as logging_config +import typing import fastapi +import uvicorn +import lib.api.v1.handlers as api_v1_handlers +import lib.app.errors as app_errors import lib.app.settings as app_settings +import lib.app.split_settings as app_split_settings logger = logging.getLogger(__name__) -class Application: - def __init__(self) -> None: - self.settings = app_settings - self.logger = logging.getLogger(__name__) - self.producer = None +@dataclasses.dataclass +class DisposableResource: + name: str + dispose_callback: typing.Awaitable[typing.Any] - def create_app(self) -> fastapi.FastAPI: - app = fastapi.FastAPI( - title="FastAPI", - version="0.1.0", - docs_url="/api/openapi", - openapi_url="/api/openapi.json", + +class Application: + def __init__( + self, + settings: app_settings.Settings, + fastapi_app: fastapi.FastAPI, + disposable_resources: list[DisposableResource], + ) -> None: + self._settings = settings + self._fastapi_app = fastapi_app + self._disposable_resources = disposable_resources + + @classmethod + def from_settings(cls, settings: app_settings.Settings) -> typing.Self: + # Logging + + logging_config.dictConfig(app_split_settings.get_logging_config(**settings.logger.model_dump())) + + logger.info("Initializing application") + disposable_resources = [] + + # Global clients + + logger.info("Initializing global clients") + + # Clients + + logger.info("Initializing clients") + + # Repositories + + logger.info("Initializing repositories") + + # Caches + + logger.info("Initializing caches") + + # Services + + logger.info("Initializing services") + + # Handlers + + logger.info("Initializing handlers") + # liveness_probe_handler = health_handlers.LivenessProbeHandler() + + logger.info("Creating application") + # aio_app = aiohttp_web.Application() + + fastapi_app = fastapi.FastAPI( + title=settings.app.title, + version=settings.app.version, + docs_url=settings.app.docs_url, + openapi_url=settings.app.openapi_url, default_response_class=fastapi.responses.ORJSONResponse, ) - # app.include_router(api_handlers.user_router, prefix="/api/v1/users", tags=["users"]) - # app.include_router(api_handlers.movie_router, prefix="/api/v1/movies", tags=["movies"]) + # Routes + fastapi_app.include_router(api_v1_handlers.health_router, prefix="/api/v1/health", tags=["health"]) - @app.on_event("startup") - async def startup_event(): - self.logger.info("Starting server") + application = Application( + settings=settings, + fastapi_app=fastapi_app, + disposable_resources=disposable_resources, + ) - @app.on_event("shutdown") - async def shutdown_event(): - self.logger.info("Shutting down server") + logger.info("Initializing application finished") - return app + return application + + async def start(self) -> None: + try: + config = uvicorn.Config( + app=self._fastapi_app, + host=self._settings.api.host, + port=self._settings.api.port, + ) + server = uvicorn.Server(config) + await server.serve() + except BaseException as unexpected_error: + logger.exception("FastAPI failed to start") + raise app_errors.StartServerError("FastAPI failed to start") from unexpected_error + + async def dispose(self) -> None: + logger.info("Application is shutting down...") + dispose_errors = [] + + for resource in self._disposable_resources: + logger.info("Disposing %s...", resource.name) + try: + await resource.dispose_callback + except Exception as unexpected_error: + dispose_errors.append(unexpected_error) + logger.exception("Failed to dispose %s", resource.name) + else: + logger.info("%s has been disposed", resource.name) + + if len(dispose_errors) != 0: + logger.error("Application has shut down with errors") + raise app_errors.DisposeError("Application has shut down with errors, see logs above") + + logger.info("Application has successfully shut down") diff --git a/src/fastapi_app/lib/app/errors.py b/src/fastapi_app/lib/app/errors.py new file mode 100644 index 0000000..855d04e --- /dev/null +++ b/src/fastapi_app/lib/app/errors.py @@ -0,0 +1,22 @@ +import typing + + +class ApplicationError(Exception): + def __init__(self, message: str, *args: typing.Any) -> None: + super().__init__(*args) + self.message = message + + +class DisposeError(ApplicationError): + pass + + +class StartServerError(ApplicationError): + pass + + +__all__ = [ + "ApplicationError", + "DisposeError", + "StartServerError", +] diff --git a/src/fastapi_app/lib/app/settings.py b/src/fastapi_app/lib/app/settings.py index e3853ea..95e727e 100644 --- a/src/fastapi_app/lib/app/settings.py +++ b/src/fastapi_app/lib/app/settings.py @@ -1,5 +1,3 @@ -import logging.config as logging_config - import pydantic import pydantic_settings @@ -8,6 +6,7 @@ import lib.app.split_settings as app_split_settings class Settings(pydantic_settings.BaseSettings): api: app_split_settings.ApiSettings = pydantic.Field(default_factory=lambda: app_split_settings.ApiSettings()) + app: app_split_settings.AppSettings = pydantic.Field(default_factory=lambda: app_split_settings.AppSettings()) postgres: app_split_settings.PostgresSettings = pydantic.Field( default_factory=lambda: app_split_settings.PostgresSettings() ) @@ -17,10 +16,3 @@ class Settings(pydantic_settings.BaseSettings): project: app_split_settings.ProjectSettings = pydantic.Field( default_factory=lambda: app_split_settings.ProjectSettings() ) - - -settings = Settings() # todo Вынести в инициализацию - -logging_config.dictConfig( # todo Вынести в инициализацию - app_split_settings.get_logging_config(**settings.logger.model_dump()) -) diff --git a/src/fastapi_app/lib/app/split_settings/__init__.py b/src/fastapi_app/lib/app/split_settings/__init__.py index 4d3b87b..793ebe0 100644 --- a/src/fastapi_app/lib/app/split_settings/__init__.py +++ b/src/fastapi_app/lib/app/split_settings/__init__.py @@ -1,10 +1,12 @@ from .api import * +from .app import * from .logger import * from .postgres import * from .project import * __all__ = [ "ApiSettings", + "AppSettings", "LoggingSettings", "PostgresSettings", "ProjectSettings", diff --git a/src/fastapi_app/lib/app/split_settings/app.py b/src/fastapi_app/lib/app/split_settings/app.py new file mode 100644 index 0000000..58e5e45 --- /dev/null +++ b/src/fastapi_app/lib/app/split_settings/app.py @@ -0,0 +1,25 @@ +import pydantic +import pydantic_settings + +import lib.app.split_settings.utils as app_split_settings_utils + + +class AppSettings(pydantic_settings.BaseSettings): + model_config = pydantic_settings.SettingsConfigDict( + env_file=app_split_settings_utils.ENV_PATH, + env_prefix="APP_", + env_file_encoding="utf-8", + extra="ignore", + ) + + title: str = "FastAPI" + version: str = "0.1.0" + docs_url: str = "/api/openapi" + openapi_url: str = "/api/openapi.json" + reload: bool = False + + @pydantic.field_validator("reload") + def validate_debug(cls, v: str | bool) -> bool: + if isinstance(v, bool): + return v + return v.lower() == "true"