5 Commits
12 changed files with 224 additions and 149 deletions

No files matched your search

+1 -5
View File
@@ -1,10 +1,6 @@
# backend-python
Copier template for a Python backend, either as a `backend/` part next to other parts or alone at the root of the project (`layout`): a uv project with one Docker image and one `python -m <module>` entrypoint per service (`api`, `bot`, `userbot`, `worker`, `scheduler`), pydantic-settings, rich logging, optional Dishka, MongoDB or PostgreSQL, Redis, taskiq (in-memory, Redis or PostgreSQL broker), CryptoPay, pydantic-ai and a DynamicConfig stored in the database.
Ships `backend/docker-compose.yml` with root-relative paths and profiles per service, `docker-compose.override.yml.example` (published ports and the `caddy` network aliases, copied by `make env`), a `Makefile` with `fmt`, `check` (ruff, ty and `scripts/check_imports.py`, which keeps each service from importing the others' SDKs at startup), `build` and service-specific targets, `.env.example` and `CLAUDE.md`. Applied on top of the `infra` template, `layout: parts` or `layout: single` respectively.
`DB__HOST`/`DB__PORT` and `REDIS__HOST`/`REDIS__PORT` say where the service really is. The bundled container takes the host as its network alias and listens on the port, the override publishes it on the machine. For an external database, point them at it and leave its profile out of `COMPOSE_PROFILES`.
Copier template for a Python backend: a uv project, one Docker image, a `python -m <module>` entrypoint per service (`api`, `bot`, `userbot`, `worker`, `scheduler`), optional Dishka, MongoDB or PostgreSQL, Redis, taskiq, CryptoPay, pydantic-ai and a dynamic config in the database. A `backend/` part or the whole project (`layout`), on top of `infra`.
```sh
copier copy --trust -d project_name="My Thing" <this-repo> <dest>
+1 -1
View File
@@ -1,7 +1,7 @@
{%- set groups = [] -%}
{%- if layout == 'root' %}{% set _ = groups.append(["COMPOSE_PROFILES=" ~ ("external," if database != 'none' or use_redis else "") ~ "services"]) %}{% endif -%}
{%- set _ = groups.append(["RUN_ENVIRONMENT=prod", "TZ=UTC"]) -%}
{%- set _ = groups.append(["LOG__LEVEL=INFO", "LOG__LEVEL_EXTERNAL=WARNING", "LOG__SHOW_TIME=false", "LOG__CONSOLE_WIDTH=150"]) -%}
{%- set _ = groups.append(["LOG__LEVEL=INFO", "LOG__LEVEL_EXTERNAL=WARNING", "LOG__SHOW_TIME=false", "LOG__SHOW_LOCALS=false", "LOG__CONSOLE_WIDTH=150"]) -%}
{%- if database == 'mongo' %}{% set _ = groups.append(["DB__HOST=mongodb", "DB__PORT=27017", "DB__USER=" ~ project_slug, "DB__PASSWORD=" ~ project_slug, "DB__DB_NAME=" ~ project_slug, "DB__SCRIPTS_CONNECTION_URL=mongodb://" ~ project_slug ~ ":" ~ project_slug ~ "@localhost:27017/" ~ project_slug ~ "?authSource=admin"]) %}{% endif -%}
{%- if database == 'postgres' %}{% set _ = groups.append(["DB__HOST=postgres", "DB__PORT=5432", "DB__USER=" ~ project_slug, "DB__PASSWORD=" ~ project_slug, "DB__DB_NAME=" ~ project_slug, "DB__SCRIPTS_CONNECTION_URL=postgresql://" ~ project_slug ~ ":" ~ project_slug ~ "@localhost:5432/" ~ project_slug]) %}{% endif -%}
{%- if use_redis %}{% set _ = groups.append(["REDIS__HOST=redis", "REDIS__PORT=6379", "REDIS__CACHE_TTL=300", "REDIS__SCRIPTS_CONNECTION_URL=redis://localhost:6379/0"]) %}{% endif -%}
+3 -34
View File
@@ -4,23 +4,10 @@
{%- if 'taskiq_worker' in backend_services %}{% set _ = svc_modules.append("worker") %}{% endif -%}
{%- if 'kurigram_userbot' in backend_services %}{% set _ = svc_modules.append("userbot") %}{% endif -%}
{%- if 'scheduler' in backend_services and 'taskiq_worker' not in backend_services %}{% set _ = svc_modules.append("scheduler") %}{% endif -%}
{%- set app_services = [] -%}
{%- if 'api' in backend_services %}{% set _ = app_services.append("api") %}{% endif -%}
{%- if 'aiogram_bot' in backend_services %}{% set _ = app_services.append("bot") %}{% endif -%}
{%- if 'taskiq_worker' in backend_services %}{% set _ = app_services.append("worker") %}{% endif -%}
{%- if 'kurigram_userbot' in backend_services %}{% set _ = app_services.append("userbot") %}{% endif -%}
{%- if 'scheduler' in backend_services %}{% set _ = app_services.append("scheduler") %}{% endif -%}
{%- set has_script = dynamic_config and svc_modules -%}
{%- set has_scripts = dynamic_config or 'kurigram_userbot' in backend_services -%}
COMPOSE := {% if layout == 'part' %}cd .. && {% endif %}docker compose
{% if svc_modules %}IMAGE := {{ project_slug }}/backend
IMAGE_INPUTS := pyproject.toml uv.lock Dockerfile
CODE := src{% if has_scripts %} scripts{% endif %}{% if serve_spa %} ../frontend{% endif %}
SERVICES := {{ app_services | join(' ') }}
changed = ! git diff --quiet $(1) -- $(2) 2>/dev/null
stamp = { git update-ref $(1) HEAD 2>/dev/null || true; }
{% endif %}
.PHONY: {% if layout == 'root' %}env recreate rebuild restart logs down deploy {% endif %}fmt check{% if svc_modules %} build pre-deploy post-deploy{% endif %}{% if database == 'postgres' %} migrate revision{% endif %}{% if has_script %} script{% endif %}{% if 'kurigram_userbot' in backend_services %} session{% endif %}
.PHONY: {% if layout == 'root' %}env recreate rebuild restart logs down {% endif %}fmt check{% if svc_modules %} build{% endif %}{% if database == 'postgres' %} migrate revision{% endif %}{% if has_script %} script{% endif %}{% if 'kurigram_userbot' in backend_services %} session{% endif %}
fmt:
uv run ruff format
@@ -34,20 +21,6 @@ check:
{% endif %}{% if svc_modules %}
build:
$(COMPOSE) build {{ svc_modules[0] }}
pre-deploy:
@if $(call changed,refs/deploy/backend,$(IMAGE_INPUTS)) || ! docker image inspect $(IMAGE) >/dev/null 2>&1; then \
$(MAKE) build && $(call stamp,refs/deploy/backend) && $(call stamp,refs/deploy/backend-code); \
fi
{% if database == 'postgres' %} @$(COMPOSE) config --services | grep -qx postgres && $(COMPOSE) up -d postgres || true
$(MAKE) migrate
{% endif %}
post-deploy:
@if $(call changed,refs/deploy/backend-code,$(CODE)); then \
running=$$($(COMPOSE) ps --services --status running | grep -x $(addprefix -e ,$(SERVICES))); \
[ -z "$$running" ] || $(COMPOSE) restart $$running; \
$(call stamp,refs/deploy/backend-code); \
fi
{% endif %}{% if layout == 'root' %}
env:
@fresh=; test -f .env || { cp .env.example .env; fresh=1; }; \
@@ -74,11 +47,7 @@ logs:
down:
$(COMPOSE) down
{% if svc_modules %}
deploy: pre-deploy
$(COMPOSE) up -d
$(MAKE) post-deploy
{% endif %}{% endif %}{% if database == 'postgres' %}
{% endif %}{% if database == 'postgres' %}
migrate:
$(COMPOSE) run --rm migrator $(or $(filter-out $@,$(MAKECMDGOALS)),upgrade head)
@@ -14,7 +14,7 @@
{%- if 'scheduler' in backend_services %}{% set _ = app_services.append({'name': 'scheduler', 'command': ('[worker, scheduler]' if 'taskiq_worker' in backend_services else '[scheduler]')}) %}{% endif -%}
{%- macro backend_service(name, command) %} {{ name }}:
build: {{ part_dir }}
image: {{ project_slug }}/backend
image: {{ project_slug | replace('_', '-') }}/backend
profiles: [{{ name }}, services]
restart: unless-stopped
env_file:
@@ -87,7 +87,7 @@ services:
migrator:
build: {{ part_dir }}
image: {{ project_slug }}/backend
image: {{ project_slug | replace('_', '-') }}/backend
profiles: [migrate]
env_file:
- path: .env
@@ -261,10 +261,9 @@ async def read_config() -> DynamicConfigBase:
async def write_config(config: DynamicConfigBase) -> DynamicConfigBase:
await init_db()
doc = await DynamicConfig.get_or_create()
for name in DynamicConfigBase.model_fields:
setattr(doc, name, getattr(config, name))
await doc.save()
await DynamicConfig.update_config(
**{name: getattr(config, name) for name in DynamicConfigBase.model_fields}
)
return config
@@ -22,6 +22,7 @@ class LogSettings(Section):
level: str = "INFO"
level_external: str = "WARNING"
show_time: bool = False
show_locals: bool = False
console_width: int = 150
{% if database == 'mongo' %}
@@ -28,7 +28,7 @@ def setup_logging() -> None:
markup=True,
rich_tracebacks=True,
enable_link_path=False,
tracebacks_show_locals=True,
tracebacks_show_locals=env.log.show_locals,
omit_repeated_times=False,
show_time=env.log.show_time,
{%- if 'aiogram_bot' in backend_services %}
@@ -37,7 +37,7 @@ def setup_logging() -> None:
)
],
)
install(console=console, show_locals=True)
install(console=console, show_locals=env.log.show_locals)
logger = logging.getLogger("{{ project_slug }}")
@@ -22,6 +22,7 @@ class DynamicConfig(SQLModel, table=True):
id: int = SQLField(default=1, primary_key=True)
data: dict[str, Any] = SQLField(sa_column=Column(postgresql.JSONB, nullable=False))
version: int = SQLField(default=0)
updated_at: datetime | None = SQLField(
default=None,
sa_column=Column(
@@ -32,8 +33,19 @@ class DynamicConfig(SQLModel, table=True):
),
)
{%- else -%}
import time
from dataclasses import dataclass
from beanie import Document
from beanie.odm.operators.update import BaseUpdateOperator
from beanie.operators import Inc, Set
from pydantic import BaseModel, Field
from pymongo.errors import PyMongoError
from utils.logging import logger
CONFIG_CHECK_SECONDS = 5.0
CONFIG_TTL_SECONDS = 900.0
class BotConfig(BaseModel):
@@ -44,15 +56,69 @@ class DynamicConfigBase(BaseModel):
bot: BotConfig = Field(default_factory=BotConfig)
@dataclass
class _ConfigCache:
value: "DynamicConfig | None" = None
loaded_at: float = 0.0
checked_at: float = 0.0
_cache = _ConfigCache()
class DynamicConfig(DynamicConfigBase, Document):
version: int = 0
class Settings:
name = "config"
@classmethod
async def get_or_create(cls) -> "DynamicConfig":
config = await cls.find_one()
if config is None:
config = cls()
await config.save()
return config
now = time.monotonic()
current = _cache.value
if current is None:
current = await cls._reload()
elif now - _cache.loaded_at >= CONFIG_TTL_SECONDS:
current = await cls._reload_or_keep(current)
elif now - _cache.checked_at >= CONFIG_CHECK_SECONDS:
_cache.checked_at = now
current = await cls._refresh_if_changed(current)
return current.model_copy(deep=True)
@classmethod
async def update_config(
cls, *operations: BaseUpdateOperator, **sections: BaseModel
) -> "DynamicConfig":
current = await cls.get_or_create()
changes = [*operations, Set(sections)] if sections else [*operations]
await cls.find_one(cls.id == current.id).update(*changes, Inc({cls.version: 1}))
return (await cls._reload()).model_copy(deep=True)
@classmethod
async def _reload(cls) -> "DynamicConfig":
loaded = await cls.find_one() or await cls().insert()
_cache.value = loaded
_cache.loaded_at = _cache.checked_at = time.monotonic()
return loaded
@classmethod
async def _reload_or_keep(cls, current: "DynamicConfig") -> "DynamicConfig":
try:
return await cls._reload()
except PyMongoError as e:
logger.warning(f"Config reload failed, serving the cached copy: {e}")
return current
@classmethod
async def _refresh_if_changed(cls, current: "DynamicConfig") -> "DynamicConfig":
try:
stored = await cls.get_pymongo_collection().find_one(
{"_id": current.id}, {"version": 1}
)
except PyMongoError as e:
logger.warning(f"Config version check failed, serving the cached copy: {e}")
return current
if stored and stored.get("version", 0) == current.version:
return current
return await cls._reload_or_keep(current)
{%- endif %}
@@ -1,88 +1,139 @@
{% if use_redis -%}
import time
{%- if use_redis %}
from contextlib import suppress
{%- endif %}
from typing import Any
from pydantic import BaseModel
{%- if use_redis %}
from redis.exceptions import RedisError
{%- endif %}
from sqlalchemy import literal, update
from sqlalchemy.dialects.postgresql import JSONB
from sqlalchemy.exc import SQLAlchemyError
from sqlalchemy.ext.asyncio import async_sessionmaker
from sqlmodel import col, select
from sqlmodel.ext.asyncio.session import AsyncSession
from utils.db.models.config import DynamicConfig, DynamicConfigBase
from utils.logging import logger
{%- if use_redis %}
from .cache import RedisCache
{%- endif %}
CONFIG_CACHE_KEY = "config:dynamic"
CONFIG_ROW_ID = 1
CONFIG_CHECK_SECONDS = 5.0
CONFIG_TTL_SECONDS = 900.0
{%- if use_redis %}
CONFIG_CACHE_KEY = "config:dynamic"
{%- endif %}
class ConfigRepository:
def __init__(
self, sessionmaker: async_sessionmaker[AsyncSession], cache: RedisCache
self, sessionmaker: async_sessionmaker[AsyncSession]{% if use_redis %}, cache: RedisCache{% endif %}
) -> None:
self._sessionmaker = sessionmaker
{%- if use_redis %}
self._cache = cache
async def get(self) -> DynamicConfigBase:
return await self._cache.get_or_set_model(
CONFIG_CACHE_KEY, DynamicConfigBase, self._load
)
async def _load(self) -> DynamicConfigBase:
async with self._sessionmaker() as session:
row = await session.get(DynamicConfig, CONFIG_ROW_ID)
if row is None:
config = DynamicConfigBase()
session.add(DynamicConfig(id=CONFIG_ROW_ID, data=config.model_dump()))
await session.commit()
return config
return DynamicConfigBase.model_validate(row.data)
async def save(self, config: DynamicConfigBase) -> DynamicConfigBase:
async with self._sessionmaker() as session:
row = await session.get(DynamicConfig, CONFIG_ROW_ID)
if row is None:
session.add(DynamicConfig(id=CONFIG_ROW_ID, data=config.model_dump()))
else:
row.data = config.model_dump()
session.add(row)
await session.commit()
await self._cache.set_model(CONFIG_CACHE_KEY, config)
return config
async def reset(self) -> DynamicConfigBase:
return await self.save(DynamicConfigBase())
async def invalidate(self) -> None:
await self._cache.invalidate(CONFIG_CACHE_KEY)
{%- else -%}
from sqlalchemy.ext.asyncio import async_sessionmaker
from sqlmodel.ext.asyncio.session import AsyncSession
from utils.db.models.config import DynamicConfig, DynamicConfigBase
CONFIG_ROW_ID = 1
class ConfigRepository:
def __init__(self, sessionmaker: async_sessionmaker[AsyncSession]) -> None:
self._sessionmaker = sessionmaker
async def get(self) -> DynamicConfigBase:
async with self._sessionmaker() as session:
row = await session.get(DynamicConfig, CONFIG_ROW_ID)
if row is None:
config = DynamicConfigBase()
session.add(DynamicConfig(id=CONFIG_ROW_ID, data=config.model_dump()))
await session.commit()
return config
return DynamicConfigBase.model_validate(row.data)
async def save(self, config: DynamicConfigBase) -> DynamicConfigBase:
async with self._sessionmaker() as session:
row = await session.get(DynamicConfig, CONFIG_ROW_ID)
if row is None:
session.add(DynamicConfig(id=CONFIG_ROW_ID, data=config.model_dump()))
else:
row.data = config.model_dump()
session.add(row)
await session.commit()
return config
async def reset(self) -> DynamicConfigBase:
return await self.save(DynamicConfigBase())
{%- endif %}
self._value: DynamicConfigBase | None = None
self._version = -1
self._loaded_at = 0.0
self._checked_at = 0.0
async def get(self) -> DynamicConfigBase:
now = time.monotonic()
current = self._value
if current is None:
current = await self._reload()
elif now - self._loaded_at >= CONFIG_TTL_SECONDS:
current = await self._reload_or_keep(current)
elif now - self._checked_at >= CONFIG_CHECK_SECONDS:
self._checked_at = now
current = await self._refresh_if_changed(current)
return current.model_copy(deep=True)
async def save(self, config: DynamicConfigBase) -> DynamicConfigBase:
return await self._write(config.model_dump(mode="json"), merge=False)
async def update(self, **sections: BaseModel) -> DynamicConfigBase:
patch = {name: value.model_dump(mode="json") for name, value in sections.items()}
return await self._write(patch, merge=True)
async def reset(self) -> DynamicConfigBase:
return await self.save(DynamicConfigBase())
async def _write(self, data: dict[str, Any], *, merge: bool) -> DynamicConfigBase:
await self.get()
payload = literal(data, JSONB)
async with self._sessionmaker() as session:
await session.exec(
update(DynamicConfig)
.where(col(DynamicConfig.id) == CONFIG_ROW_ID)
.values(
data=col(DynamicConfig.data).op("||")(payload) if merge else payload,
version=col(DynamicConfig.version) + 1,
)
)
await session.commit()
return (await self._reload()).model_copy(deep=True)
async def _stored_version(self) -> int | None:
async with self._sessionmaker() as session:
query = select(DynamicConfig.version).where(
col(DynamicConfig.id) == CONFIG_ROW_ID
)
return (await session.exec(query)).first()
async def _reload(self) -> DynamicConfigBase:
{%- if use_redis %}
version = await self._stored_version()
if version is not None:
with suppress(RedisError):
key = f"{CONFIG_CACHE_KEY}:{version}"
cached = await self._cache.get_model(key, DynamicConfigBase)
if cached is not None:
return self._remember(cached, version)
{%- endif %}
async with self._sessionmaker() as session:
row = await session.get(DynamicConfig, CONFIG_ROW_ID)
if row is None:
row = DynamicConfig(
id=CONFIG_ROW_ID, data=DynamicConfigBase().model_dump(mode="json")
)
session.add(row)
await session.commit()
await session.refresh(row)
value = DynamicConfigBase.model_validate(row.data)
version = row.version
{%- if use_redis %}
with suppress(RedisError):
await self._cache.set_model(f"{CONFIG_CACHE_KEY}:{version}", value)
{%- endif %}
return self._remember(value, version)
def _remember(self, value: DynamicConfigBase, version: int) -> DynamicConfigBase:
self._value, self._version = value, version
self._loaded_at = self._checked_at = time.monotonic()
return value
async def _reload_or_keep(self, current: DynamicConfigBase) -> DynamicConfigBase:
try:
return await self._reload()
except SQLAlchemyError as e:
logger.warning(f"Config reload failed, serving the cached copy: {e}")
return current
async def _refresh_if_changed(
self, current: DynamicConfigBase
) -> DynamicConfigBase:
try:
version = await self._stored_version()
except SQLAlchemyError as e:
logger.warning(f"Config version check failed, serving the cached copy: {e}")
return current
if version == self._version:
return current
return await self._reload_or_keep(current)
@@ -1,13 +0,0 @@
## Checking commands
After writing code, always run from `backend/`:
```shell
ruff format
ruff check --fix
ty check
```
## Imports
Every service imports only what it needs to start. `make check` runs `scripts/check_imports.py`, which fails when a service loads a heavy package it is not allowed; `SERVICES` there is the contract, extend it on purpose.
- Package `__init__` files don't re-export clients or SDKs.
- An SDK used by one function is imported inside it. On an async path load it first with `await preload("<module>")` from `utils.imports`, so the event loop never waits on the import.
- Types used in Dishka provider signatures and `FromDishka[...]` stay real top-level imports.
@@ -0,0 +1,10 @@
## Checking commands
After writing code, always run from `backend/`:
```shell
make fmt
make check
```
{% if backend_services or dynamic_config %}
{% endif %}{% if backend_services %}Mind startup imports: `make check` runs `scripts/check_imports.py`.
{% endif %}{% if dynamic_config %}Change dynamic config only through its update methods.
{% endif %}
@@ -1,20 +1,16 @@
{%- set targets = [] -%}
{%- if database == 'postgres' %}{% set _ = targets.append("`make migrate` (`make migrate downgrade -1` to roll back), `make revision m=\"message\"`") %}{% endif -%}
{%- if database == 'postgres' %}{% set _ = targets.append("`make migrate`, `make revision m=\"message\"`") %}{% endif -%}
{%- if dynamic_config and backend_services %}{% set _ = targets.append("`make script name`") %}{% endif -%}
{%- if 'kurigram_userbot' in backend_services %}{% set _ = targets.append("`make session`") %}{% endif -%}
# {{ project_name }}
{% if project_description and project_description != project_name %}
{{ project_description }}
{% endif %}
Runs in Docker, locally the same way as in production. `COMPOSE_PROFILES` in `.env` selects the services that run on this machine. `docker-compose.override.yml` holds what differs between machines: published ports and the aliases on the external `caddy` network.
```sh
make env
make recreate
make env # .env and docker-compose.override.yml from the examples
make recreate # the services in COMPOSE_PROFILES
make check
```
`make env` creates `.env` and `docker-compose.override.yml` from their examples. `make recreate` starts the selected profiles, `make rebuild` builds the image first, `make logs`, `make restart` and `make down` do what they say.
{% if backend_services %}To deploy, `git pull && make deploy`. It runs `make pre-deploy`, which builds the image only when `pyproject.toml`, `uv.lock` or `Dockerfile` changed{% if database == 'postgres' %} and applies migrations{% endif %}, then `docker compose up -d`, then `make post-deploy`, which restarts the services whose mounted code changed. A deploy system with its own `up` step calls the two hooks around it. What was built and started is remembered as `refs/deploy/*` in the clone.
{% endif %}`make fmt` formats, `make check` runs ruff and ty.{% if targets %} Also {{ targets | join(", ") }}.{% endif %}
{% if targets %}
Also {{ targets | join(", ") }}.
{% endif %}