From e23ee4163e1ef14ece55c8584ea28ff6c27fb49e Mon Sep 17 00:00:00 2001 From: Artem Litvinov Date: Wed, 27 Sep 2023 20:19:43 +0100 Subject: [PATCH 01/18] feat: alembic init --- src/fastapi_app/alembic.ini | 114 +++++++++++++++++++++++++ src/fastapi_app/alembic/README | 1 + src/fastapi_app/alembic/env.py | 89 +++++++++++++++++++ src/fastapi_app/alembic/script.py.mako | 26 ++++++ 4 files changed, 230 insertions(+) create mode 100644 src/fastapi_app/alembic.ini create mode 100644 src/fastapi_app/alembic/README create mode 100644 src/fastapi_app/alembic/env.py create mode 100644 src/fastapi_app/alembic/script.py.mako diff --git a/src/fastapi_app/alembic.ini b/src/fastapi_app/alembic.ini new file mode 100644 index 0000000..5d23107 --- /dev/null +++ b/src/fastapi_app/alembic.ini @@ -0,0 +1,114 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +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 +# 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-dateutil library that can be +# installed by adding `alembic[tz]` to the pip requirements +# string value is passed to dateutil.tz.gettz() +# 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 = os # Use os.pathsep. Default configuration used for new projects. + +# 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 = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +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 diff --git a/src/fastapi_app/alembic/README b/src/fastapi_app/alembic/README new file mode 100644 index 0000000..e0d0858 --- /dev/null +++ b/src/fastapi_app/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration with an async dbapi. \ No newline at end of file diff --git a/src/fastapi_app/alembic/env.py b/src/fastapi_app/alembic/env.py new file mode 100644 index 0000000..9f2d519 --- /dev/null +++ b/src/fastapi_app/alembic/env.py @@ -0,0 +1,89 @@ +import asyncio +from logging.config import fileConfig + +from sqlalchemy import pool +from sqlalchemy.engine import Connection +from sqlalchemy.ext.asyncio import async_engine_from_config + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# 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 = None + +# 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 do_run_migrations(connection: Connection) -> None: + context.configure(connection=connection, target_metadata=target_metadata) + + with context.begin_transaction(): + context.run_migrations() + + +async def run_async_migrations() -> None: + """In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + connectable = async_engine_from_config( + config.get_section(config.config_ini_section, {}), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + async with connectable.connect() as connection: + await connection.run_sync(do_run_migrations) + + await connectable.dispose() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode.""" + + asyncio.run(run_async_migrations()) + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/src/fastapi_app/alembic/script.py.mako b/src/fastapi_app/alembic/script.py.mako new file mode 100644 index 0000000..fbc4b07 --- /dev/null +++ b/src/fastapi_app/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"} From 84bfcdac5b1af1f1b8f85018aa4a1b5ef6d79daa Mon Sep 17 00:00:00 2001 From: ksieuk Date: Thu, 28 Sep 2023 21:28:13 +0300 Subject: [PATCH 02/18] fix add errors --- .../lib/api/v1/handlers/health/__init__.py | 5 +++++ src/fastapi_app/lib/app/errors.py | 22 +++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 src/fastapi_app/lib/api/v1/handlers/health/__init__.py create mode 100644 src/fastapi_app/lib/app/errors.py 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/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", +] From 659271d2b005eed195aa518178c003be4f3e9b8d Mon Sep 17 00:00:00 2001 From: ksieuk Date: Thu, 28 Sep 2023 21:28:22 +0300 Subject: [PATCH 03/18] add handler --- .../lib/api/v1/handlers/health/liveness_probe.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 src/fastapi_app/lib/api/v1/handlers/health/liveness_probe.py 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..0468869 --- /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.Healthy, + summary="Статус работоспособности", + description="Проверяет доступность сервиса FastAPI.", +) +async def health(): + return api_shemas.Healthy(status="healthy") From 832726d8aed2abccc73bc9fb1af0662becce67d1 Mon Sep 17 00:00:00 2001 From: ksieuk Date: Thu, 28 Sep 2023 21:28:32 +0300 Subject: [PATCH 04/18] add app settings --- src/fastapi_app/lib/app/app.py | 144 ++++++++++++++++++++++++---- src/fastapi_app/lib/app/settings.py | 9 -- 2 files changed, 125 insertions(+), 28 deletions(-) diff --git a/src/fastapi_app/lib/app/app.py b/src/fastapi_app/lib/app/app.py index 6e24e89..98aa680 100644 --- a/src/fastapi_app/lib/app/app.py +++ b/src/fastapi_app/lib/app/app.py @@ -1,36 +1,142 @@ +import dataclasses import logging +import logging.config as logging_config +import typing import fastapi +import uvicorn +import lib.app.errors as app_errors import lib.app.settings as app_settings +import lib.app.split_settings as app_split_settings +import lib.api.v1.handlers as api_v1_handlers logger = logging.getLogger(__name__) class Application: - def __init__(self) -> None: - self.settings = app_settings - self.logger = logging.getLogger(__name__) - self.producer = None + 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 + # self.logger = logging.getLogger(__name__) + # self.producer = None - def create_app(self) -> fastapi.FastAPI: - app = fastapi.FastAPI( - title="FastAPI", - version="0.1.0", - docs_url="/api/openapi", - openapi_url="/api/openapi.json", + # def create_app(self) -> fastapi.FastAPI: + # app = fastapi.FastAPI( + # title=self._settings.app.title, + # version=self._settings.app.version, + # docs_url=self._settings.app.docs_url, + # openapi_url=self._settings.app.openapi_url, + # default_response_class=fastapi.responses.ORJSONResponse, + # ) + # + # @app.on_event("startup") + # async def startup_event(): + # self.logger.info("Starting server") + # + # @app.on_event("shutdown") + # async def shutdown_event(): + # self.logger.info("Shutting down server") + # + # return app + + @classmethod + def from_settings(cls, settings: app_settings.Settings) -> typing.Self: + # Logging + + # logging.basicConfig( + # level=settings.LOGS_MIN_LEVEL, + # format=settings.LOGS_FORMAT, + # ) + 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/settings.py b/src/fastapi_app/lib/app/settings.py index e3853ea..48bfd46 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 @@ -17,10 +15,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()) -) From fd84a03d59bcaa56e08f13c710e4af89f19a688f Mon Sep 17 00:00:00 2001 From: ksieuk Date: Thu, 28 Sep 2023 21:28:49 +0300 Subject: [PATCH 05/18] add Healthy model --- src/fastapi_app/lib/api/v1/schemas/entity.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/fastapi_app/lib/api/v1/schemas/entity.py b/src/fastapi_app/lib/api/v1/schemas/entity.py index 73c898f..d363b6c 100644 --- a/src/fastapi_app/lib/api/v1/schemas/entity.py +++ b/src/fastapi_app/lib/api/v1/schemas/entity.py @@ -6,3 +6,7 @@ import pydantic class Token(pydantic.BaseModel): sub: uuid.UUID exp: int | None = None + + +class Healthy(pydantic.BaseModel): + status: str = pydantic.Field(..., example="healthy", description="Схема доступности сервиса") From 8f6ddef639b9d239f0e6a888177afafe7fbd01ff Mon Sep 17 00:00:00 2001 From: ksieuk Date: Thu, 28 Sep 2023 21:29:15 +0300 Subject: [PATCH 06/18] add app values --- src/fastapi_app/.env.example | 2 ++ 1 file changed, 2 insertions(+) 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 From 28507551b09a3379bbb088bddddcf74429221ea6 Mon Sep 17 00:00:00 2001 From: ksieuk Date: Thu, 28 Sep 2023 21:29:26 +0300 Subject: [PATCH 07/18] add app settings --- src/fastapi_app/lib/app/settings.py | 1 + 1 file changed, 1 insertion(+) diff --git a/src/fastapi_app/lib/app/settings.py b/src/fastapi_app/lib/app/settings.py index 48bfd46..95e727e 100644 --- a/src/fastapi_app/lib/app/settings.py +++ b/src/fastapi_app/lib/app/settings.py @@ -6,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() ) From 8f0365e8d209586c2ef1152726b6145d369c79fe Mon Sep 17 00:00:00 2001 From: ksieuk Date: Thu, 28 Sep 2023 21:30:31 +0300 Subject: [PATCH 08/18] change architecture --- src/fastapi_app/bin/__main__.py | 36 ++++++++++++++----- .../lib/api/v1/handlers/__init__.py | 5 +++ .../lib/api/v1/schemas/__init__.py | 6 ++++ src/fastapi_app/lib/app/__init__.py | 11 ++++++ src/fastapi_app/lib/app/app.py | 2 +- 5 files changed, 51 insertions(+), 9 deletions(-) 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/schemas/__init__.py b/src/fastapi_app/lib/api/v1/schemas/__init__.py index e69de29..e8ff274 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 .entity import * + +__all__ = [ + "Healthy", + "Token", +] 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 98aa680..f7d6b1c 100644 --- a/src/fastapi_app/lib/app/app.py +++ b/src/fastapi_app/lib/app/app.py @@ -6,10 +6,10 @@ 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 -import lib.api.v1.handlers as api_v1_handlers logger = logging.getLogger(__name__) From b580ac9cd9b4690658641d737b0a2e551d8249dc Mon Sep 17 00:00:00 2001 From: ksieuk Date: Thu, 28 Sep 2023 21:30:38 +0300 Subject: [PATCH 09/18] add app settings --- src/fastapi_app/lib/app/app.py | 6 ++++++ src/fastapi_app/lib/app/split_settings/__init__.py | 2 ++ 2 files changed, 8 insertions(+) diff --git a/src/fastapi_app/lib/app/app.py b/src/fastapi_app/lib/app/app.py index f7d6b1c..17b5b48 100644 --- a/src/fastapi_app/lib/app/app.py +++ b/src/fastapi_app/lib/app/app.py @@ -14,6 +14,12 @@ import lib.app.split_settings as app_split_settings logger = logging.getLogger(__name__) +@dataclasses.dataclass +class DisposableResource: + name: str + dispose_callback: typing.Awaitable[typing.Any] + + class Application: def __init__( self, 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", From 08026be5d753cfea9a499071d2795baf0991bb8d Mon Sep 17 00:00:00 2001 From: ksieuk Date: Fri, 29 Sep 2023 15:26:32 +0300 Subject: [PATCH 10/18] add app settings --- src/fastapi_app/lib/app/split_settings/app.py | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 src/fastapi_app/lib/app/split_settings/app.py 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" From a113809bc7eb456d2c793a29db59dd8642c4b61a Mon Sep 17 00:00:00 2001 From: ksieuk Date: Fri, 29 Sep 2023 15:29:48 +0300 Subject: [PATCH 11/18] remove debug code --- src/fastapi_app/lib/app/app.py | 25 ------------------------- 1 file changed, 25 deletions(-) diff --git a/src/fastapi_app/lib/app/app.py b/src/fastapi_app/lib/app/app.py index 17b5b48..ea25a43 100644 --- a/src/fastapi_app/lib/app/app.py +++ b/src/fastapi_app/lib/app/app.py @@ -30,36 +30,11 @@ class Application: self._settings = settings self._fastapi_app = fastapi_app self._disposable_resources = disposable_resources - # self.logger = logging.getLogger(__name__) - # self.producer = None - - # def create_app(self) -> fastapi.FastAPI: - # app = fastapi.FastAPI( - # title=self._settings.app.title, - # version=self._settings.app.version, - # docs_url=self._settings.app.docs_url, - # openapi_url=self._settings.app.openapi_url, - # default_response_class=fastapi.responses.ORJSONResponse, - # ) - # - # @app.on_event("startup") - # async def startup_event(): - # self.logger.info("Starting server") - # - # @app.on_event("shutdown") - # async def shutdown_event(): - # self.logger.info("Shutting down server") - # - # return app @classmethod def from_settings(cls, settings: app_settings.Settings) -> typing.Self: # Logging - # logging.basicConfig( - # level=settings.LOGS_MIN_LEVEL, - # format=settings.LOGS_FORMAT, - # ) logging_config.dictConfig(app_split_settings.get_logging_config(**settings.logger.model_dump())) logger.info("Initializing application") From 3e36da648186ffaba161c7005d5bb7dfc5749fc0 Mon Sep 17 00:00:00 2001 From: ksieuk Date: Fri, 29 Sep 2023 15:35:40 +0300 Subject: [PATCH 12/18] rename schemas --- .../lib/api/v1/handlers/health/liveness_probe.py | 4 ++-- src/fastapi_app/lib/api/v1/schemas/__init__.py | 6 +++--- src/fastapi_app/lib/api/v1/schemas/{entity.py => base.py} | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) rename src/fastapi_app/lib/api/v1/schemas/{entity.py => base.py} (71%) 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 index 0468869..bbfed63 100644 --- a/src/fastapi_app/lib/api/v1/handlers/health/liveness_probe.py +++ b/src/fastapi_app/lib/api/v1/handlers/health/liveness_probe.py @@ -7,9 +7,9 @@ router = fastapi.APIRouter() @router.get( "/", - response_model=api_shemas.Healthy, + response_model=api_shemas.HealthSchema, summary="Статус работоспособности", description="Проверяет доступность сервиса FastAPI.", ) async def health(): - return api_shemas.Healthy(status="healthy") + return api_shemas.HealthSchema(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 e8ff274..679042e 100644 --- a/src/fastapi_app/lib/api/v1/schemas/__init__.py +++ b/src/fastapi_app/lib/api/v1/schemas/__init__.py @@ -1,6 +1,6 @@ -from .entity import * +from .base import * __all__ = [ - "Healthy", - "Token", + "HealthSchema", + "TokenSchema", ] diff --git a/src/fastapi_app/lib/api/v1/schemas/entity.py b/src/fastapi_app/lib/api/v1/schemas/base.py similarity index 71% rename from src/fastapi_app/lib/api/v1/schemas/entity.py rename to src/fastapi_app/lib/api/v1/schemas/base.py index d363b6c..2941484 100644 --- a/src/fastapi_app/lib/api/v1/schemas/entity.py +++ b/src/fastapi_app/lib/api/v1/schemas/base.py @@ -3,10 +3,10 @@ import uuid import pydantic -class Token(pydantic.BaseModel): +class TokenSchema(pydantic.BaseModel): sub: uuid.UUID exp: int | None = None -class Healthy(pydantic.BaseModel): +class HealthSchema(pydantic.BaseModel): status: str = pydantic.Field(..., example="healthy", description="Схема доступности сервиса") From 3e0f0d07b01815789d9b6ff54f098757827812f8 Mon Sep 17 00:00:00 2001 From: ksieuk Date: Fri, 29 Sep 2023 15:38:41 +0300 Subject: [PATCH 13/18] fix rename schemas --- src/fastapi_app/lib/api/v1/handlers/health/liveness_probe.py | 4 ++-- src/fastapi_app/lib/api/v1/schemas/__init__.py | 2 +- src/fastapi_app/lib/api/v1/schemas/base.py | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) 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 index bbfed63..d3fbbce 100644 --- a/src/fastapi_app/lib/api/v1/handlers/health/liveness_probe.py +++ b/src/fastapi_app/lib/api/v1/handlers/health/liveness_probe.py @@ -7,9 +7,9 @@ router = fastapi.APIRouter() @router.get( "/", - response_model=api_shemas.HealthSchema, + response_model=api_shemas.HealthResponseModel, summary="Статус работоспособности", description="Проверяет доступность сервиса FastAPI.", ) async def health(): - return api_shemas.HealthSchema(status="healthy") + 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 679042e..ff434eb 100644 --- a/src/fastapi_app/lib/api/v1/schemas/__init__.py +++ b/src/fastapi_app/lib/api/v1/schemas/__init__.py @@ -1,6 +1,6 @@ from .base import * __all__ = [ - "HealthSchema", + "HealthResponseModel", "TokenSchema", ] diff --git a/src/fastapi_app/lib/api/v1/schemas/base.py b/src/fastapi_app/lib/api/v1/schemas/base.py index 2941484..071f79a 100644 --- a/src/fastapi_app/lib/api/v1/schemas/base.py +++ b/src/fastapi_app/lib/api/v1/schemas/base.py @@ -3,10 +3,10 @@ import uuid import pydantic -class TokenSchema(pydantic.BaseModel): +class TokenResponseModel(pydantic.BaseModel): sub: uuid.UUID exp: int | None = None -class HealthSchema(pydantic.BaseModel): +class HealthResponseModel(pydantic.BaseModel): status: str = pydantic.Field(..., example="healthy", description="Схема доступности сервиса") From 21331bd74314bc775a5097097f5c0d78c2829ea1 Mon Sep 17 00:00:00 2001 From: ksieuk Date: Fri, 29 Sep 2023 15:42:56 +0300 Subject: [PATCH 14/18] fix rename schemas --- src/fastapi_app/lib/api/v1/schemas/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/fastapi_app/lib/api/v1/schemas/__init__.py b/src/fastapi_app/lib/api/v1/schemas/__init__.py index ff434eb..06d8e5f 100644 --- a/src/fastapi_app/lib/api/v1/schemas/__init__.py +++ b/src/fastapi_app/lib/api/v1/schemas/__init__.py @@ -2,5 +2,5 @@ from .base import * __all__ = [ "HealthResponseModel", - "TokenSchema", + "TokenResponseModel", ] From e394cc6846fcfb45055d0fb47aab68b201ac39c6 Mon Sep 17 00:00:00 2001 From: ksieuk Date: Fri, 29 Sep 2023 15:44:18 +0300 Subject: [PATCH 15/18] fix example --- src/fastapi_app/lib/api/v1/schemas/base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/fastapi_app/lib/api/v1/schemas/base.py b/src/fastapi_app/lib/api/v1/schemas/base.py index 071f79a..47dd8c3 100644 --- a/src/fastapi_app/lib/api/v1/schemas/base.py +++ b/src/fastapi_app/lib/api/v1/schemas/base.py @@ -9,4 +9,4 @@ class TokenResponseModel(pydantic.BaseModel): class HealthResponseModel(pydantic.BaseModel): - status: str = pydantic.Field(..., example="healthy", description="Схема доступности сервиса") + status: str = pydantic.Field(..., examples=["healthy"], description="Схема доступности сервиса") From 24c6605f3a8007d536f77cd129d084736b2bf341 Mon Sep 17 00:00:00 2001 From: ksieuk Date: Fri, 29 Sep 2023 15:45:05 +0300 Subject: [PATCH 16/18] fix default value --- src/fastapi_app/lib/api/v1/schemas/base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/fastapi_app/lib/api/v1/schemas/base.py b/src/fastapi_app/lib/api/v1/schemas/base.py index 47dd8c3..3de6237 100644 --- a/src/fastapi_app/lib/api/v1/schemas/base.py +++ b/src/fastapi_app/lib/api/v1/schemas/base.py @@ -9,4 +9,4 @@ class TokenResponseModel(pydantic.BaseModel): class HealthResponseModel(pydantic.BaseModel): - status: str = pydantic.Field(..., examples=["healthy"], description="Схема доступности сервиса") + status: str = pydantic.Field(default=..., examples=["healthy"], description="Схема доступности сервиса") From 7e3c91296227c7dc17619d3f73cdb2262e497bcc Mon Sep 17 00:00:00 2001 From: Artem Litvinov Date: Fri, 29 Sep 2023 15:38:11 +0100 Subject: [PATCH 17/18] feat: alembic settings --- src/fastapi_app/alembic/env.py | 14 ++++---------- src/fastapi_app/lib/models/__init__.py | 3 +++ src/fastapi_app/lib/models/base_sqlalchemy.py | 3 +++ 3 files changed, 10 insertions(+), 10 deletions(-) create mode 100644 src/fastapi_app/lib/models/__init__.py create mode 100644 src/fastapi_app/lib/models/base_sqlalchemy.py diff --git a/src/fastapi_app/alembic/env.py b/src/fastapi_app/alembic/env.py index 9f2d519..9e2caf7 100644 --- a/src/fastapi_app/alembic/env.py +++ b/src/fastapi_app/alembic/env.py @@ -5,6 +5,8 @@ from sqlalchemy import pool from sqlalchemy.engine import Connection from sqlalchemy.ext.asyncio import async_engine_from_config +import lib.app.settings as app_settings +import lib.models as models from alembic import context # this is the Alembic Config object, which provides @@ -12,20 +14,12 @@ from alembic import context config = context.config # 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 = None +config.set_main_option("sqlalchemy.url", app_settings.settings.postgres.dsn) -# 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. +target_metadata = models.Base.metadata def run_migrations_offline() -> None: diff --git a/src/fastapi_app/lib/models/__init__.py b/src/fastapi_app/lib/models/__init__.py new file mode 100644 index 0000000..130e2e2 --- /dev/null +++ b/src/fastapi_app/lib/models/__init__.py @@ -0,0 +1,3 @@ +from .base_sqlalchemy import Base + +__all__ = ["Base"] diff --git a/src/fastapi_app/lib/models/base_sqlalchemy.py b/src/fastapi_app/lib/models/base_sqlalchemy.py new file mode 100644 index 0000000..e3af184 --- /dev/null +++ b/src/fastapi_app/lib/models/base_sqlalchemy.py @@ -0,0 +1,3 @@ +import sqlalchemy.ext.declarative + +Base = sqlalchemy.ext.declarative.declarative_base() From a69531767fceb02881b43fcc2c958d8d042adfab Mon Sep 17 00:00:00 2001 From: Artem Litvinov Date: Fri, 29 Sep 2023 16:59:12 +0100 Subject: [PATCH 18/18] feat: update migrations filename --- src/fastapi_app/alembic.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/fastapi_app/alembic.ini b/src/fastapi_app/alembic.ini index 5d23107..08770e1 100644 --- a/src/fastapi_app/alembic.ini +++ b/src/fastapi_app/alembic.ini @@ -58,7 +58,7 @@ version_path_separator = os # Use os.pathsep. Default configuration used for ne # are written from script.py.mako # output_encoding = utf-8 -sqlalchemy.url = driver://user:pass@localhost/dbname +file_template = %%(year)d-%%(month).2d-%%(day).2d_%%(rev)s_%%(slug)s [post_write_hooks]