This example builds an articles listing endpoint that supports offset pagination, cursor pagination, full-text search, faceted filtering, and sorting — all from a single CrudFactory definition.
import uuid
+
+from sqlalchemy import Boolean, ForeignKey, String, Text
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
+
+from fastapi_toolsets.models import CreatedAtMixin
+
+
+class Base(DeclarativeBase):
+ pass
+
+
+class Category(Base):
+ __tablename__ = "categories"
+
+ id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4)
+ name: Mapped[str] = mapped_column(String(64), unique=True)
+
+ articles: Mapped[list["Article"]] = relationship(back_populates="category")
+
+
+class Article(Base, CreatedAtMixin):
+ __tablename__ = "articles"
+
+ id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4)
+ title: Mapped[str] = mapped_column(String(256))
+ body: Mapped[str] = mapped_column(Text)
+ status: Mapped[str] = mapped_column(String(32))
+ published: Mapped[bool] = mapped_column(Boolean, default=False)
+ category_id: Mapped[uuid.UUID | None] = mapped_column(
+ ForeignKey("categories.id"), nullable=True
+ )
+
+ category: Mapped["Category | None"] = relationship(back_populates="articles")
+import datetime
+import uuid
+
+from fastapi_toolsets.schemas import PydanticBase
+
+
+class ArticleRead(PydanticBase):
+ id: uuid.UUID
+ created_at: datetime.datetime
+ title: str
+ status: str
+ published: bool
+ category_id: uuid.UUID | None
+Declare searchable_fields, facet_fields, and order_fields once on CrudFactory. All endpoints built from this class share the same defaults and can override them per call.
from fastapi_toolsets.crud import CrudFactory
+
+from .models import Article, Category
+
+ArticleCrud = CrudFactory(
+ model=Article,
+ cursor_column=Article.created_at,
+ searchable_fields=[ # default fields for full-text search
+ Article.title,
+ Article.body,
+ (Article.category, Category.name),
+ ],
+ facet_fields=[ # fields exposed as filter dropdowns
+ Article.status,
+ (Article.category, Category.name),
+ ],
+ order_fields=[ # fields exposed for client-driven ordering
+ Article.title,
+ Article.created_at,
+ ],
+)
+from typing import Annotated
+
+from fastapi import Depends
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
+
+from fastapi_toolsets.db import create_db_context, create_db_dependency
+
+DATABASE_URL = "postgresql+asyncpg://postgres:postgres@localhost:5432/postgres"
+
+engine = create_async_engine(url=DATABASE_URL, future=True)
+async_session_maker = async_sessionmaker(bind=engine, expire_on_commit=False)
+
+get_db = create_db_dependency(session_maker=async_session_maker)
+get_db_context = create_db_context(session_maker=async_session_maker)
+
+
+SessionDep = Annotated[AsyncSession, Depends(get_db)]
+Deploy a Postgres DB with docker
+ +from fastapi import FastAPI
+
+from fastapi_toolsets.exceptions import init_exceptions_handlers
+
+from .routes import router
+
+app = FastAPI()
+init_exceptions_handlers(app=app)
+app.include_router(router=router)
+Best for admin panels or any UI that needs a total item count and numbered pages.
+from typing import Annotated
+
+from fastapi import APIRouter, Depends
+
+from fastapi_toolsets.crud import OrderByClause
+from fastapi_toolsets.schemas import (
+ CursorPaginatedResponse,
+ OffsetPaginatedResponse,
+ PaginatedResponse,
+)
+
+from .crud import ArticleCrud
+from .db import SessionDep
+from .models import Article
+from .schemas import ArticleRead
+
+router = APIRouter(prefix="/articles")
+
+
+@router.get("/offset")
+async def list_articles_offset(
+ session: SessionDep,
+ params: Annotated[
+ dict,
+ Depends(ArticleCrud.offset_params(default_page_size=20, max_page_size=100)),
+ ],
+ filter_by: Annotated[dict[str, list[str]], Depends(ArticleCrud.filter_params())],
+ order_by: Annotated[
+ OrderByClause | None,
+ Depends(ArticleCrud.order_params(default_field=Article.created_at)),
+ ],
+ search: str | None = None,
+) -> OffsetPaginatedResponse[ArticleRead]:
+ return await ArticleCrud.offset_paginate(
+ session=session,
+ **params,
+Example request
+GET /articles/offset?page=2&items_per_page=10&search=fastapi&status=published&order_by=title&order=asc
+Example response
+{
+ "status": "SUCCESS",
+ "data": [
+ { "id": "3f47ac69-...", "title": "FastAPI tips", "status": "published", ... }
+ ],
+ "pagination": {
+ "total_count": 42,
+ "page": 2,
+ "items_per_page": 10,
+ "has_more": true
+ },
+ "filter_attributes": {
+ "status": ["archived", "draft", "published"],
+ "name": ["backend", "frontend", "python"]
+ }
+}
+filter_attributes always reflects the values visible after applying the active filters. Use it to populate filter dropdowns on the client.
Best for feeds, infinite scroll, or any high-throughput API where offset performance degrades.
+ order_by=order_by,
+ schema=ArticleRead,
+ )
+
+
+@router.get("/cursor")
+async def list_articles_cursor(
+ session: SessionDep,
+ params: Annotated[
+ dict,
+ Depends(ArticleCrud.cursor_params(default_page_size=20, max_page_size=100)),
+ ],
+ filter_by: Annotated[dict[str, list[str]], Depends(ArticleCrud.filter_params())],
+ order_by: Annotated[
+ OrderByClause | None,
+ Depends(ArticleCrud.order_params(default_field=Article.created_at)),
+ ],
+ search: str | None = None,
+) -> CursorPaginatedResponse[ArticleRead]:
+ return await ArticleCrud.cursor_paginate(
+ session=session,
+Example request
+ +Example response
+{
+ "status": "SUCCESS",
+ "data": [
+ { "id": "3f47ac69-...", "title": "FastAPI tips", "status": "published", ... }
+ ],
+ "pagination": {
+ "next_cursor": "eyJ2YWx1ZSI6ICIzZjQ3YWM2OS0uLi4ifQ==",
+ "prev_cursor": null,
+ "items_per_page": 10,
+ "has_more": true
+ },
+ "filter_attributes": {
+ "status": ["published"],
+ "name": ["backend", "python"]
+ }
+}
+Pass next_cursor as the cursor query parameter on the next request to advance to the next page.
Both endpoints inherit the same searchable_fields declared on ArticleCrud:
Search is case-insensitive and uses a LIKE %query% pattern. Pass a SearchConfig instead of a plain string to control case sensitivity or switch to match_mode="all" (AND across all fields instead of OR).
A modular collection of production-ready utilities for FastAPI. Install only what you need — from async CRUD and database helpers to CLI tooling, Prometheus metrics, and pytest fixtures. Each module is independently installable via optional extras, keeping your dependency footprint minimal.
+
+
+
+
Documentation: https://fastapi-toolsets.d3vyce.fr
+Source Code: https://github.com/d3vyce/fastapi-toolsets
+The base package includes the core modules (CRUD, database, schemas, exceptions, fixtures, dependencies, model mixins, logging):
+ +Install only the extras you need:
+uv add "fastapi-toolsets[cli]"
+uv add "fastapi-toolsets[metrics]"
+uv add "fastapi-toolsets[pytest]"
+Or install everything:
+ +CrudFactory, built-in full-text/faceted search and Offset/Cursor pagination.PathDependency, BodyDependency) for automatic DB lookups from path or body parametersUUIDMixin, CreatedAtMixin, UpdatedAtMixin, TimestampMixin)Response, PaginatedResponse, and PydanticBaseconfigure_logging and get_loggerpytest-xdist support, and table cleanup utilitiesMIT License - see LICENSE for details.
+Contributions are welcome! Please feel free to submit issues and pull requests.
+ + + + + + + + + + + + + + + +This page covers every breaking change introduced in v2.0 and the steps required to update your code.
+schema is now required in offset_paginate() and cursor_paginate()¶Calls that omit schema will now raise a TypeError at runtime.
Previously schema was optional; omitting it returned raw SQLAlchemy model instances inside the response. It is now a required keyword argument and the response always contains serialized schema instances.
as_response removed from create(), get(), and update()¶Passing as_response to these methods will raise a TypeError at runtime.
The as_response=True shorthand is replaced by passing a schema directly. The return value is a Response[schema] when schema is provided, or the raw model instance when it is not.
delete(): as_response renamed and return type changed¶as_response is gone, and the plain (non-response) call no longer returns True.
Two changes were made to delete():
as_response parameter is renamed to return_response.return_response=True, the method now returns None on success instead of True.paginate() alias removed¶Any call to crud.paginate(...) will raise AttributeError at runtime.
The paginate shorthand was an alias for offset_paginate. It has been removed; call offset_paginate directly.
api_error raises TypeError at class definition time¶Unfinished or stub exception subclasses that previously compiled fine will now fail on import.
+In v1, a subclass without api_error would only fail when the exception was raised. In v2, __init_subclass__ validates this at class definition time.
For shared base classes that are not meant to be raised directly, use abstract=True:
class BillingError(ApiException, abstract=True):
+ """Base for all billing-related errors — not raised directly."""
+
+class PaymentRequiredError(BillingError):
+ api_error = ApiError(code=402, msg="Payment Required", desc="...", err_code="BILLING-402")
+Pagination alias removed¶Pagination was already deprecated in v1 and is fully removed in v2, you now need to use OffsetPagination or CursorPagination.
Typer-based command-line interface for managing your FastAPI application, with built-in fixture commands integration.
+The cli module provides a manager entry point built with Typer. It allow custom commands to be added in addition of the fixture commands when a FixtureRegistry and a database context are configured.
Configure the CLI in your pyproject.toml:
[tool.fastapi-toolsets]
+cli = "myapp.cli:cli" # Custom Typer app
+fixtures = "myapp.fixtures:registry" # FixtureRegistry instance
+db_context = "myapp.db:db_context" # Async context manager for sessions
+All fields are optional. Without configuration, the manager command still works but no command are available.
# Manager commands
+manager --help
+
+ Usage: manager [OPTIONS] COMMAND [ARGS]...
+
+ FastAPI utilities CLI.
+
+╭─ Options ────────────────────────────────────────────────────────────────────────╮
+│ --install-completion Install completion for the current shell. │
+│ --show-completion Show completion for the current shell, to copy it │
+│ or customize the installation. │
+│ --help Show this message and exit. │
+╰──────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────────────────────╮
+│ check-db │
+│ fixtures Manage database fixtures. │
+╰──────────────────────────────────────────────────────────────────────────────────╯
+
+# Fixtures commands
+manager fixtures --help
+
+ Usage: manager fixtures [OPTIONS] COMMAND [ARGS]...
+
+ Manage database fixtures.
+
+╭─ Options ────────────────────────────────────────────────────────────────────────╮
+│ --help Show this message and exit. │
+╰──────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────────────────────╮
+│ list List all registered fixtures. │
+│ load Load fixtures into the database. │
+╰──────────────────────────────────────────────────────────────────────────────────╯
+You can extend the CLI by providing your own Typer app. The manager entry point will merge your app's commands with the built-in ones:
# myapp/cli.py
+import typer
+
+cli = typer.Typer()
+
+@cli.command()
+def hello():
+ print("Hello from my app!")
+Generic async CRUD operations for SQLAlchemy models with search, pagination, and many-to-many support.
+Info
+This module has been coded and tested to be compatible with PostgreSQL only.
+The crud module provides AsyncCrud, an abstract base class with a full suite of async database operations, and CrudFactory, a convenience function to instantiate it for a given model.
from fastapi_toolsets.crud import CrudFactory
+from myapp.models import User
+
+UserCrud = CrudFactory(model=User)
+CrudFactory dynamically creates a class named AsyncUserCrud with User as its model.
get_or_none added in v2.2
# Create
+user = await UserCrud.create(session=session, obj=UserCreateSchema(username="alice"))
+
+# Get one (raises NotFoundError if not found)
+user = await UserCrud.get(session=session, filters=[User.id == user_id])
+
+# Get one or None (never raises)
+user = await UserCrud.get_or_none(session=session, filters=[User.id == user_id])
+
+# Get first or None
+user = await UserCrud.first(session=session, filters=[User.email == email])
+
+# Get multiple
+users = await UserCrud.get_multi(session=session, filters=[User.is_active == True])
+
+# Update
+user = await UserCrud.update(session=session, obj=UserUpdateSchema(username="bob"), filters=[User.id == user_id])
+
+# Delete
+await UserCrud.delete(session=session, filters=[User.id == user_id])
+
+# Count / exists
+count = await UserCrud.count(session=session, filters=[User.is_active == True])
+exists = await UserCrud.exists(session=session, filters=[User.email == email])
+Three methods fetch a single record — choose based on how you want to handle the "not found" case and whether you need strict uniqueness:
+| Method | +Not found | +Multiple results | +
|---|---|---|
get |
+raises NotFoundError |
+raises MultipleResultsFound |
+
get_or_none |
+returns None |
+raises MultipleResultsFound |
+
first |
+returns None |
+returns the first match silently | +
Use get when the record must exist (e.g. a detail endpoint that should return 404):
Use get_or_none when the record may not exist but you still want strict uniqueness enforcement:
user = await UserCrud.get_or_none(session=session, filters=[User.email == email])
+if user is None:
+ ... # handle missing case without catching an exception
+Use first when you only care about any one match and don't need uniqueness:
Added in v1.1 (only offset_pagination via paginate if <v1.1)
Two pagination strategies are available. Both return a PaginatedResponse but differ in how they navigate through results.
| + | offset_paginate |
+cursor_paginate |
+
|---|---|---|
| Total count | +Yes | +No | +
| Jump to arbitrary page | +Yes | +No | +
| Performance on deep pages | +Degrades | +Constant | +
| Stable under concurrent inserts | +No | +Yes | +
| Search compatible | +Yes | +Yes | +
| Use case | +Admin panels, numbered pagination | +Feeds, APIs, infinite scroll | +
@router.get(
+ "",
+ response_model=PaginatedResponse[User],
+)
+async def get_users(
+ session: SessionDep,
+ items_per_page: int = 50,
+ page: int = 1,
+):
+ return await crud.UserCrud.offset_paginate(
+ session=session,
+ items_per_page=items_per_page,
+ page=page,
+ )
+The offset_paginate method returns a PaginatedResponse whose pagination field is an OffsetPagination object:
{
+ "status": "SUCCESS",
+ "data": ["..."],
+ "pagination": {
+ "total_count": 100,
+ "page": 1,
+ "items_per_page": 20,
+ "has_more": true
+ }
+}
+@router.get(
+ "",
+ response_model=PaginatedResponse[UserRead],
+)
+async def list_users(
+ session: SessionDep,
+ cursor: str | None = None,
+ items_per_page: int = 20,
+):
+ return await UserCrud.cursor_paginate(
+ session=session,
+ cursor=cursor,
+ items_per_page=items_per_page,
+ )
+The cursor_paginate method returns a PaginatedResponse whose pagination field is a CursorPagination object:
{
+ "status": "SUCCESS",
+ "data": ["..."],
+ "pagination": {
+ "next_cursor": "eyJ2YWx1ZSI6ICIzZjQ3YWM2OS0uLi4ifQ==",
+ "prev_cursor": null,
+ "items_per_page": 20,
+ "has_more": true
+ }
+}
+Pass next_cursor as the cursor query parameter on the next request to advance to the next page. prev_cursor is set on pages 2+ and points back to the first item of the current page. Both are null when there is no adjacent page.
The cursor column is set once on CrudFactory via the cursor_column parameter. It must be monotonically ordered for stable results:
Warning
+Random UUID v4 PKs are not suitable as cursor columns because their ordering is non-deterministic.
+Note
+cursor_column is required. Calling cursor_paginate on a CRUD class that has no cursor_column configured raises a ValueError.
The cursor value is base64-encoded when returned to the client and decoded back to the correct Python type on the next request. The following SQLAlchemy column types are supported:
+| SQLAlchemy type | +Python type | +
|---|---|
Integer, BigInteger, SmallInteger |
+int |
+
Uuid |
+uuid.UUID |
+
DateTime |
+datetime.datetime |
+
Date |
+datetime.date |
+
Float, Numeric |
+decimal.Decimal |
+
# Paginate by the primary key
+PostCrud = CrudFactory(model=Post, cursor_column=Post.id)
+
+# Paginate by a timestamp column instead
+PostCrud = CrudFactory(model=Post, cursor_column=Post.created_at)
+Two search strategies are available, both compatible with offset_paginate and cursor_paginate.
| + | Full-text search | +Faceted search | +
|---|---|---|
| Input | +Free-text string | +Exact column values | +
| Relationship support | +Yes | +Yes | +
| Use case | +Search bars | +Filter dropdowns | +
You can use both search strategies in the same endpoint!
+Added in v2.2.1
The model's primary key is always included in searchable_fields automatically, so searching by ID works out of the box without any configuration. When no searchable_fields are declared, only the primary key is searched.
Declare searchable_fields on the CRUD class. Relationship traversal is supported via tuples:
PostCrud = CrudFactory(
+ model=Post,
+ searchable_fields=[
+ Post.title,
+ Post.content,
+ (Post.author, User.username), # search across relationship
+ ],
+)
+You can override searchable_fields per call with search_fields:
This allows searching with both offset_paginate and cursor_paginate:
@router.get(
+ "",
+ response_model=PaginatedResponse[User],
+)
+async def get_users(
+ session: SessionDep,
+ items_per_page: int = 50,
+ page: int = 1,
+ search: str | None = None,
+):
+ return await crud.UserCrud.offset_paginate(
+ session=session,
+ items_per_page=items_per_page,
+ page=page,
+ search=search,
+ )
+@router.get(
+ "",
+ response_model=PaginatedResponse[User],
+)
+async def get_users(
+ session: SessionDep,
+ cursor: str | None = None,
+ items_per_page: int = 50,
+ search: str | None = None,
+):
+ return await crud.UserCrud.cursor_paginate(
+ session=session,
+ items_per_page=items_per_page,
+ cursor=cursor,
+ search=search,
+ )
+Added in v1.2
Declare facet_fields on the CRUD class to return distinct column values alongside paginated results. This is useful for populating filter dropdowns or building faceted search UIs.
Facet fields use the same syntax as searchable_fields — direct columns or relationship tuples:
UserCrud = CrudFactory(
+ model=User,
+ facet_fields=[
+ User.status,
+ User.country,
+ (User.role, Role.name), # value from a related model
+ ],
+)
+You can override facet_fields per call:
The distinct values are returned in the filter_attributes field of PaginatedResponse:
{
+ "status": "SUCCESS",
+ "data": ["..."],
+ "pagination": { "..." },
+ "filter_attributes": {
+ "status": ["active", "inactive"],
+ "country": ["DE", "FR", "US"],
+ "name": ["admin", "editor", "viewer"]
+ }
+}
+Use filter_by to pass the client's chosen filter values directly — no need to build SQLAlchemy conditions by hand. Any unknown key raises InvalidFacetFilterError.
The keys in filter_by are the same keys the client received in filter_attributes.
Keys are normally the terminal column.key (e.g. "name" for Role.name). When two facet fields share the same column key (e.g. (Build.project, Project.name) and (Build.os, Os.name)), the relationship name is prepended automatically: "project__name" and "os__name".
filter_by and filters can be combined — both are applied with AND logic.
Use filter_params() to generate a dict with the facet filter values from the query parameters:
from typing import Annotated
+
+from fastapi import Depends
+
+UserCrud = CrudFactory(
+ model=User,
+ facet_fields=[User.status, User.country, (User.role, Role.name)],
+)
+
+@router.get("", response_model_exclude_none=True)
+async def list_users(
+ session: SessionDep,
+ page: int = 1,
+ filter_by: Annotated[dict[str, list[str]], Depends(UserCrud.filter_params())],
+) -> PaginatedResponse[UserRead]:
+ return await UserCrud.offset_paginate(
+ session=session,
+ page=page,
+ filter_by=filter_by,
+ )
+Both single-value and multi-value query parameters work:
+GET /users?status=active → filter_by={"status": ["active"]}
+GET /users?status=active&country=FR → filter_by={"status": ["active"], "country": ["FR"]}
+GET /users?role=admin&role=editor → filter_by={"role": ["admin", "editor"]} (IN clause)
+Added in v1.3
Declare order_fields on the CRUD class to expose client-driven column ordering via order_by and order query parameters.
Call order_params() to generate a FastAPI dependency that maps the query parameters to an OrderByClause expression:
from typing import Annotated
+
+from fastapi import Depends
+from fastapi_toolsets.crud import OrderByClause
+
+@router.get("")
+async def list_users(
+ session: SessionDep,
+ order_by: Annotated[OrderByClause | None, Depends(UserCrud.order_params())],
+) -> PaginatedResponse[UserRead]:
+ return await UserCrud.offset_paginate(session=session, order_by=order_by)
+The dependency adds two query parameters to the endpoint:
+| Parameter | +Type | +
|---|---|
order_by |
+str | null |
+
order |
+asc or desc |
+
GET /users?order_by=name&order=asc → ORDER BY users.name ASC
+GET /users?order_by=name&order=desc → ORDER BY users.name DESC
+An unknown order_by value raises InvalidOrderFieldError (HTTP 422).
You can also pass order_fields directly to order_params() to override the class-level defaults without modifying them:
Added in v1.1
By default, SQLAlchemy relationships are not loaded unless explicitly requested. Instead of using lazy="selectin" on model definitions (which is implicit and applies globally), define a default_load_options on the CRUD class to control loading strategy explicitly.
Warning
+Avoid using lazy="selectin" on model relationships. It fires silently on every query, cannot be disabled per-call, and can cause unexpected cascading loads through deep relationship chains. Use default_load_options instead.
from sqlalchemy.orm import selectinload
+
+ArticleCrud = CrudFactory(
+ model=Article,
+ default_load_options=[
+ selectinload(Article.category),
+ selectinload(Article.tags),
+ ],
+)
+default_load_options applies automatically to all read operations (get, first, get_multi, offset_paginate, cursor_paginate). When load_options is passed at call-site, it fully replaces default_load_options for that query — giving you precise per-call control:
# Only loads category, tags are not loaded
+article = await ArticleCrud.get(
+ session=session,
+ filters=[Article.id == article_id],
+ load_options=[selectinload(Article.category)],
+)
+
+# Loads nothing — useful for write-then-refresh flows or lightweight checks
+articles = await ArticleCrud.get_multi(session=session, load_options=[])
+Use m2m_fields to map schema fields containing lists of IDs to SQLAlchemy relationships. The CRUD class resolves and validates all IDs before persisting:
PostCrud = CrudFactory(
+ model=Post,
+ m2m_fields={"tag_ids": Post.tags},
+)
+
+post = await PostCrud.create(session=session, obj=PostCreateSchema(title="Hello", tag_ids=[1, 2, 3]))
+Atomic INSERT ... ON CONFLICT DO UPDATE using PostgreSQL:
await UserCrud.upsert(
+ session=session,
+ obj=UserCreateSchema(email="alice@example.com", username="alice"),
+ index_elements=[User.email],
+ set_={"username"},
+)
+Added in v1.1
Pass a Pydantic schema class to create, get, update, or offset_paginate to serialize the result directly into that schema and wrap it in a Response[schema] or PaginatedResponse[schema]:
class UserRead(PydanticBase):
+ id: UUID
+ username: str
+
+@router.get(
+ "/{uuid}",
+ responses=generate_error_responses(NotFoundError),
+)
+async def get_user(session: SessionDep, uuid: UUID) -> Response[UserRead]:
+ return await crud.UserCrud.get(
+ session=session,
+ filters=[User.id == uuid],
+ schema=UserRead,
+ )
+
+@router.get("")
+async def list_users(session: SessionDep, page: int = 1) -> PaginatedResponse[UserRead]:
+ return await crud.UserCrud.offset_paginate(
+ session=session,
+ page=page,
+ schema=UserRead,
+ )
+The schema must have from_attributes=True (or inherit from PydanticBase) so it can be built from SQLAlchemy model instances.
SQLAlchemy async session management with transactions, table locking, and row-change polling.
+Info
+This module has been coded and tested to be compatible with PostgreSQL only.
+The db module provides helpers to create FastAPI dependencies and context managers for AsyncSession, along with utilities for nested transactions, table lock and polling for row changes.
Use create_db_dependency to create a FastAPI dependency that yields a session and auto-commits on success:
from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker
+from fastapi_toolsets.db import create_db_dependency
+
+engine = create_async_engine(url="postgresql+asyncpg://...", future=True)
+session_maker = async_sessionmaker(bind=engine, expire_on_commit=False)
+
+get_db = create_db_dependency(session_maker=session_maker)
+
+@router.get("/users")
+async def list_users(session: AsyncSession = Depends(get_db)):
+ ...
+Use create_db_context for sessions outside request handlers (e.g. background tasks, CLI commands):
from fastapi_toolsets.db import create_db_context
+
+db_context = create_db_context(session_maker=session_maker)
+
+async def seed():
+ async with db_context() as session:
+ ...
+get_transaction handles savepoints automatically, allowing safe nesting:
from fastapi_toolsets.db import get_transaction
+
+async def create_user_with_role(session=session):
+ async with get_transaction(session=session):
+ ...
+ async with get_transaction(session=session): # uses savepoint
+ ...
+lock_tables acquires PostgreSQL table-level locks before executing critical sections:
from fastapi_toolsets.db import lock_tables
+
+async with lock_tables(session=session, tables=[User], mode="EXCLUSIVE"):
+ # No other transaction can modify User until this block exits
+ ...
+Available lock modes are defined in LockMode: ACCESS_SHARE, ROW_SHARE, ROW_EXCLUSIVE, SHARE_UPDATE_EXCLUSIVE, SHARE, SHARE_ROW_EXCLUSIVE, EXCLUSIVE, ACCESS_EXCLUSIVE.
wait_for_row_change polls a row until a specific column changes value, useful for waiting on async side effects:
from fastapi_toolsets.db import wait_for_row_change
+
+# Wait up to 30s for order.status to change
+await wait_for_row_change(
+ session=session,
+ model=Order,
+ pk_value=order_id,
+ columns=[Order.status],
+ interval=1.0,
+ timeout=30.0,
+)
+Added in v2.1
create_database creates a database at a given URL. It connects to server_url and issues a CREATE DATABASE statement:
from fastapi_toolsets.db import create_database
+
+SERVER_URL = "postgresql+asyncpg://postgres:postgres@localhost/postgres"
+
+await create_database(db_name="myapp_test", server_url=SERVER_URL)
+For test isolation with automatic cleanup, use create_worker_database from the pytest module instead — it handles drop-before, create, and drop-after automatically.
Added in v2.1
cleanup_tables truncates all tables:
from fastapi_toolsets.db import cleanup_tables
+
+@pytest.fixture(autouse=True)
+async def clean(db_session):
+ yield
+ await cleanup_tables(session=db_session, base=Base)
+FastAPI dependency factories for automatic model resolution from path and body parameters.
+The dependencies module provides two factory functions that create FastAPI dependencies to fetch a model instance from the database automatically — either from a path parameter or from a request body field — and inject it directly into your route handler.
PathDependency¶PathDependency resolves a model from a URL path parameter and injects it into the route handler. Raises NotFoundError automatically if the record does not exist.
from fastapi_toolsets.dependencies import PathDependency
+
+UserDep = PathDependency(model=User, field=User.id, session_dep=get_db)
+
+@router.get("/users/{user_id}")
+async def get_user(user: User = UserDep):
+ return user
+By default the parameter name is inferred from the field (user_id for User.id). You can override it:
UserDep = PathDependency(model=User, field=User.id, session_dep=get_db, param_name="id")
+
+@router.get("/users/{id}")
+async def get_user(user: User = UserDep):
+ return user
+BodyDependency¶BodyDependency resolves a model from a field in the request body. Useful when a body contains a foreign key and you want the full object injected:
from fastapi_toolsets.dependencies import BodyDependency
+
+RoleDep = BodyDependency(model=Role, field=Role.id, session_dep=get_db, body_field="role_id")
+
+@router.post("/users")
+async def create_user(body: UserCreateSchema, role: Role = RoleDep):
+ user = User(username=body.username, role=role)
+ ...
+Structured API exceptions with consistent error responses and automatic OpenAPI documentation.
+The exceptions module provides a set of pre-built HTTP exceptions and a FastAPI exception handler that formats all errors — including validation errors — into a uniform ErrorResponse.
Register the exception handlers on your FastAPI app at startup:
+from fastapi import FastAPI
+from fastapi_toolsets.exceptions import init_exceptions_handlers
+
+app = FastAPI()
+init_exceptions_handlers(app=app)
+This registers handlers for:
+ApiException — all custom exceptions belowHTTPException — Starlette/FastAPI HTTP errorsRequestValidationError — Pydantic request validation (422)ResponseValidationError — Pydantic response validation (422)Exception — unhandled errors (500)It also patches app.openapi() to replace the default Pydantic 422 schema with a structured example matching the ErrorResponse format.
| Exception | +Status | +Default message | +
|---|---|---|
UnauthorizedError |
+401 | +Unauthorized | +
ForbiddenError |
+403 | +Forbidden | +
NotFoundError |
+404 | +Not Found | +
ConflictError |
+409 | +Conflict | +
NoSearchableFieldsError |
+400 | +No Searchable Fields | +
InvalidFacetFilterError |
+400 | +Invalid Facet Filter | +
InvalidOrderFieldError |
+422 | +Invalid Order Field | +
All built-in exceptions accept optional keyword arguments to customise the response for a specific raise site without changing the class defaults:
+| Argument | +Effect | +
|---|---|
detail |
+Overrides both str(exc) (log output) and the message field in the response body |
+
desc |
+Overrides the description field |
+
data |
+Overrides the data field |
+
raise NotFoundError(detail="User 42 not found", desc="No user with that ID exists in the database.")
+Subclass ApiException and define an api_error class variable:
from fastapi_toolsets.exceptions import ApiException
+from fastapi_toolsets.schemas import ApiError
+
+class PaymentRequiredError(ApiException):
+ api_error = ApiError(
+ code=402,
+ msg="Payment Required",
+ desc="Your subscription has expired.",
+ err_code="BILLING-402",
+ )
+Warning
+Subclasses that do not define api_error raise a TypeError at class creation time, not at raise time.
__init__¶Override __init__ to compute detail, desc, or data dynamically, then delegate to super().__init__():
class OrderValidationError(ApiException):
+ api_error = ApiError(
+ code=422,
+ msg="Order Validation Failed",
+ desc="One or more order fields are invalid.",
+ err_code="ORDER-422",
+ )
+
+ def __init__(self, *field_errors: str) -> None:
+ super().__init__(
+ f"{len(field_errors)} validation error(s)",
+ desc=", ".join(field_errors),
+ data={"errors": [{"message": e} for e in field_errors]},
+ )
+Use abstract=True when creating a shared base that is not meant to be raised directly:
class BillingError(ApiException, abstract=True):
+ """Base for all billing-related errors."""
+
+class PaymentRequiredError(BillingError):
+ api_error = ApiError(code=402, msg="Payment Required", desc="...", err_code="BILLING-402")
+
+class SubscriptionExpiredError(BillingError):
+ api_error = ApiError(code=402, msg="Subscription Expired", desc="...", err_code="BILLING-402-EXP")
+Use generate_error_responses to add error schemas to your endpoint's OpenAPI spec:
from fastapi_toolsets.exceptions import generate_error_responses, NotFoundError, ForbiddenError
+
+@router.get(
+ "/users/{id}",
+ responses=generate_error_responses(NotFoundError, ForbiddenError),
+)
+async def get_user(...): ...
+Multiple exceptions sharing the same HTTP status code are grouped under one entry, each appearing as a named example keyed by its err_code. This keeps the OpenAPI UI readable when several error variants map to the same status.
Dependency-aware database seeding with context-based loading strategies.
+The fixtures module lets you define named fixtures with dependencies between them, then load them into the database in the correct order. Fixtures can be scoped to contexts (e.g. base data, testing data) so that only the relevant ones are loaded for each environment.
from fastapi_toolsets.fixtures import FixtureRegistry, Context
+
+fixtures = FixtureRegistry()
+
+@fixtures.register
+def roles():
+ return [
+ Role(id=1, name="admin"),
+ Role(id=2, name="user"),
+ ]
+
+@fixtures.register(depends_on=["roles"], contexts=[Context.TESTING])
+def test_users():
+ return [
+ User(id=1, username="alice", role_id=1),
+ User(id=2, username="bob", role_id=2),
+ ]
+Dependencies declared via depends_on are resolved topologically — roles will always be loaded before test_users.
By context with load_fixtures_by_context:
from fastapi_toolsets.fixtures import load_fixtures_by_context
+
+async with db_context() as session:
+ await load_fixtures_by_context(session=session, registry=fixtures, context=Context.TESTING)
+Directly with load_fixtures:
from fastapi_toolsets.fixtures import load_fixtures
+
+async with db_context() as session:
+ await load_fixtures(session=session, registry=fixtures)
+Context is an enum with predefined values:
| Context | +Description | +
|---|---|
Context.BASE |
+Core data required in all environments | +
Context.TESTING |
+Data only loaded during tests | +
Context.PRODUCTION |
+Data only loaded in production | +
A fixture with no contexts defined takes Context.BASE by default.
LoadStrategy controls how the fixture loader handles rows that already exist:
| Strategy | +Description | +
|---|---|
LoadStrategy.INSERT |
+Insert only, fail on duplicates | +
LoadStrategy.UPSERT |
+Insert or update on conflict | +
LoadStrategy.SKIP |
+Skip rows that already exist | +
Split fixtures definitions across modules and merge them:
+from myapp.fixtures.dev import dev_fixtures
+from myapp.fixtures.prod import prod_fixtures
+
+fixtures = fixturesRegistry()
+fixtures.include_registry(registry=dev_fixtures)
+fixtures.include_registry(registry=prod_fixtures)
+
+## Pytest integration
+
+Use [`register_fixtures`](../reference/pytest.md#fastapi_toolsets.pytest.plugin.register_fixtures) to expose each fixture in your registry as an injectable pytest fixture named `fixture_{name}` by default:
+
+```python
+# conftest.py
+import pytest
+from fastapi_toolsets.pytest import create_db_session, register_fixtures
+from app.fixtures import registry
+from app.models import Base
+
+DATABASE_URL = "postgresql+asyncpg://user:pass@localhost/test_db"
+
+@pytest.fixture
+async def db_session():
+ async with create_db_session(database_url=DATABASE_URL, base=Base, cleanup=True) as session:
+ yield session
+
+register_fixtures(registry=registry, namespace=globals())
+# test_users.py
+async def test_user_can_login(fixture_users: list[User], fixture_roles: list[Role]):
+ ...
+The load order is resolved automatically from the depends_on declarations in your registry. Each generated fixture receives db_session as a dependency and returns the list of loaded model instances.
Fixtures can be triggered from the CLI. See the CLI module for setup instructions.
+Lightweight logging utilities with consistent formatting and uvicorn integration.
+The logger module provides two helpers: one to configure the root logger (and uvicorn loggers) at startup, and one to retrieve a named logger anywhere in your codebase.
Call configure_logging once at application startup:
This sets up a stdout handler with a consistent format and also configures uvicorn's access and error loggers so all log output shares the same style.
+from fastapi_toolsets.logger import get_logger
+
+logger = get_logger(name=__name__)
+logger.info("User created")
+When called without arguments, get_logger auto-detects the caller's module name via frame inspection:
Prometheus metrics integration with a decorator-based registry and multi-process support.
+The metrics module provides a MetricsRegistry to declare Prometheus metrics with decorators, and an init_metrics function to mount a /metrics endpoint on your FastAPI app.
from fastapi import FastAPI
+from fastapi_toolsets.metrics import MetricsRegistry, init_metrics
+
+app = FastAPI()
+metrics = MetricsRegistry()
+
+init_metrics(app=app, registry=metrics)
+This mounts the /metrics endpoint that Prometheus can scrape.
Providers are called once at startup by init_metrics. The return value (the Prometheus metric object) is stored in the registry and can be retrieved later with registry.get(name).
Use providers when you want deferred initialization: the Prometheus metric is not registered with the global CollectorRegistry until init_metrics runs, not at import time. This is particularly useful for testing — importing the module in a test suite without calling init_metrics leaves no metrics registered, avoiding cross-test pollution.
It is also useful when metrics are defined across multiple modules and merged with include_registry: any code that needs a metric can call metrics.get() on the shared registry instead of importing the metric directly from its origin module.
If neither of these applies to you, declaring metrics at module level (e.g. HTTP_REQUESTS = Counter(...)) is simpler and equally valid.
from prometheus_client import Counter, Histogram
+
+@metrics.register
+def http_requests():
+ return Counter("http_requests_total", "Total HTTP requests", ["method", "status"])
+
+@metrics.register
+def request_duration():
+ return Histogram("request_duration_seconds", "Request duration")
+To use a provider's metric elsewhere (e.g. in a middleware), call metrics.get() inside the handler — not at module level, as providers are only initialized when init_metrics runs:
async def metrics_middleware(request: Request, call_next):
+ response = await call_next(request)
+ metrics.get("http_requests").labels(
+ method=request.method, status=response.status_code
+ ).inc()
+ return response
+Collectors are called on every scrape. Use them for metrics that reflect current state (e.g. gauges).
+Declare the metric at module level
+Do not instantiate the Prometheus metric inside the collector function. Doing so recreates it on every scrape, raising ValueError: Duplicated timeseries in CollectorRegistry. Declare it once at module level instead:
from prometheus_client import Gauge
+
+_queue_depth = Gauge("queue_depth", "Current queue depth")
+
+@metrics.register(collect=True)
+def collect_queue_depth():
+ _queue_depth.set(get_current_queue_depth())
+Split metrics definitions across modules and merge them:
+from myapp.metrics.http import http_metrics
+from myapp.metrics.db import db_metrics
+
+metrics = MetricsRegistry()
+metrics.include_registry(registry=http_metrics)
+metrics.include_registry(registry=db_metrics)
+Multi-process support is enabled automatically when the PROMETHEUS_MULTIPROC_DIR environment variable is set. No code changes are required.
Environment variable name
+The correct variable is PROMETHEUS_MULTIPROC_DIR (not PROMETHEUS_MULTIPROCESS_DIR).
Added in v2.0
Reusable SQLAlchemy 2.0 mixins for common column patterns, designed to be composed freely on any DeclarativeBase model.
The models module provides mixins that each add a single, well-defined column behaviour. They work with standard SQLAlchemy 2.0 declarative syntax and are fully compatible with AsyncSession.
from fastapi_toolsets.models import UUIDMixin, TimestampMixin
+
+class Article(Base, UUIDMixin, TimestampMixin):
+ __tablename__ = "articles"
+
+ title: Mapped[str]
+ content: Mapped[str]
+All timestamp columns are timezone-aware (TIMESTAMPTZ). All defaults are server-side, so they are also applied when inserting rows via raw SQL outside the ORM.
UUIDMixin¶Adds a id: UUID primary key generated server-side by PostgreSQL using gen_random_uuid() (requires PostgreSQL 13+). The value is retrieved via RETURNING after insert, so it is available on the Python object immediately after flush().
from fastapi_toolsets.models import UUIDMixin
+
+class User(Base, UUIDMixin):
+ __tablename__ = "users"
+
+ username: Mapped[str]
+
+# id is None before flush
+user = User(username="alice")
+await session.flush()
+print(user.id) # UUID('...')
+CreatedAtMixin¶Adds a created_at: datetime column set to NOW() on insert. The column has no onupdate hook — it is intentionally immutable after the row is created.
from fastapi_toolsets.models import UUIDMixin, CreatedAtMixin
+
+class Order(Base, UUIDMixin, CreatedAtMixin):
+ __tablename__ = "orders"
+
+ total: Mapped[float]
+UpdatedAtMixin¶Adds an updated_at: datetime column set to NOW() on insert and automatically updated to NOW() on every ORM-level update (via SQLAlchemy's onupdate hook).
from fastapi_toolsets.models import UUIDMixin, UpdatedAtMixin
+
+class Post(Base, UUIDMixin, UpdatedAtMixin):
+ __tablename__ = "posts"
+
+ title: Mapped[str]
+
+post = Post(title="Hello")
+await session.flush()
+await session.refresh(post)
+
+post.title = "Hello World"
+await session.flush()
+await session.refresh(post)
+print(post.updated_at)
+Note
+updated_at is updated by SQLAlchemy at ORM flush time. If you update rows via raw SQL (e.g. UPDATE posts SET ...), the column will not be updated automatically — use a database trigger if you need that guarantee.
TimestampMixin¶Convenience mixin that combines CreatedAtMixin and UpdatedAtMixin. Equivalent to inheriting both.
from fastapi_toolsets.models import UUIDMixin, TimestampMixin
+
+class Article(Base, UUIDMixin, TimestampMixin):
+ __tablename__ = "articles"
+
+ title: Mapped[str]
+All mixins can be combined in any order. The only constraint is that exactly one primary key must be defined — either via UUIDMixin or directly on the model.
from fastapi_toolsets.models import UUIDMixin, TimestampMixin
+
+class Event(Base, UUIDMixin, TimestampMixin):
+ __tablename__ = "events"
+ name: Mapped[str]
+
+class Counter(Base, UpdatedAtMixin):
+ __tablename__ = "counters"
+ id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+ value: Mapped[int]
+Testing helpers for FastAPI applications with async client, database sessions, and parallel worker support.
+The pytest module provides utilities for setting up async test clients, managing test database sessions, and supporting parallel test execution with pytest-xdist.
Use create_async_client to get an httpx.AsyncClient configured for your FastAPI app:
from fastapi_toolsets.pytest import create_async_client
+
+@pytest.fixture
+async def http_client(db_session):
+ async def _override_get_db():
+ yield db_session
+
+ async with create_async_client(
+ app=app,
+ base_url="http://127.0.0.1/api/v1",
+ dependency_overrides={get_db: _override_get_db},
+ ) as c:
+ yield c
+Use create_db_session to create an isolated AsyncSession for a test, combined with create_worker_database to set up a per-worker database:
from fastapi_toolsets.pytest import create_worker_database, create_db_session
+
+@pytest.fixture(scope="session")
+async def worker_db_url():
+ async with create_worker_database(
+ database_url=str(settings.SQLALCHEMY_DATABASE_URI)
+ ) as url:
+ yield url
+
+
+@pytest.fixture
+async def db_session(worker_db_url):
+ async with create_db_session(
+ database_url=worker_db_url, base=Base, cleanup=True
+ ) as session:
+ yield session
+Info
+In this example, the database is reset between each test using the argument cleanup=True.
Use worker_database_url to derive the per-worker URL manually if needed:
from fastapi_toolsets.pytest import worker_database_url
+
+url = worker_database_url("postgresql+asyncpg://user:pass@localhost/test_db", default_test_db="test")
+# e.g. "postgresql+asyncpg://user:pass@localhost/test_db_gw0" under xdist
+The examples above are already compatible with parallel test execution with pytest-xdist.
Warning
+Since V2.1.0 cleanup_tables now live in fastapi_toolsets.db. For backward compatibility the function is still available in fastapi_toolsets.pytest, but this will be remove in V3.0.0.
If you want to manually clean up a database you can use cleanup_tables, this will truncate all tables between tests for fast isolation:
from fastapi_toolsets.db import cleanup_tables
+
+@pytest.fixture(autouse=True)
+async def clean(db_session):
+ yield
+ await cleanup_tables(session=db_session, base=Base)
+Standardized Pydantic response models for consistent API responses across your FastAPI application.
+The schemas module provides generic response wrappers that enforce a uniform response structure. All models use from_attributes=True for ORM compatibility and validate_assignment=True for runtime type safety.
Response[T]¶The most common wrapper for a single resource response.
+from fastapi_toolsets.schemas import Response
+
+@router.get("/users/{id}")
+async def get_user(user: User = UserDep) -> Response[UserSchema]:
+ return Response(data=user, message="User retrieved")
+PaginatedResponse[T]¶Wraps a list of items with pagination metadata and optional facet values. The pagination field accepts either OffsetPagination or CursorPagination depending on the strategy used.
OffsetPagination¶Page-number based. Requires total_count so clients can compute the total number of pages.
from fastapi_toolsets.schemas import PaginatedResponse, OffsetPagination
+
+@router.get("/users")
+async def list_users() -> PaginatedResponse[UserSchema]:
+ return PaginatedResponse(
+ data=users,
+ pagination=OffsetPagination(
+ total_count=100,
+ items_per_page=10,
+ page=1,
+ has_more=True,
+ ),
+ )
+CursorPagination¶Cursor based. Efficient for large or frequently updated datasets where offset pagination is impractical. Provides opaque next_cursor / prev_cursor tokens; no total count is exposed.
from fastapi_toolsets.schemas import PaginatedResponse, CursorPagination
+
+@router.get("/events")
+async def list_events() -> PaginatedResponse[EventSchema]:
+ return PaginatedResponse(
+ data=events,
+ pagination=CursorPagination(
+ next_cursor="eyJpZCI6IDQyfQ==",
+ prev_cursor=None,
+ items_per_page=20,
+ has_more=True,
+ ),
+ )
+The optional filter_attributes field is populated when facet_fields are configured on the CRUD class (see Filter attributes). It is None by default and can be hidden from API responses with response_model_exclude_none=True.
ErrorResponse¶Returned automatically by the exceptions handler.
+cli¶Here's the reference for the CLI configuration helpers used to load settings from pyproject.toml.
You can import them directly from fastapi_toolsets.cli.config:
from fastapi_toolsets.cli.config import (
+ import_from_string,
+ get_config_value,
+ get_fixtures_registry,
+ get_db_context,
+ get_custom_cli,
+)
+fastapi_toolsets.cli.config.import_from_string(import_path)
+
+¶Import an object from a dotted string path.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ import_path
+ |
+
+ str
+ |
+
+
+
+ Import path in |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ Any
+ |
+
+
+
+ The imported attribute + |
+
Raises:
+| Type | +Description | +
|---|---|
+ BadParameter
+ |
+
+
+
+ If the import path is invalid or import fails + |
+
fastapi_toolsets.cli.config.get_config_value(key, required=False)
+
+¶Get a configuration value from pyproject.toml.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ key
+ |
+
+ str
+ |
+
+
+
+ The configuration key in [tool.fastapi-toolsets]. + |
+ + required + | +
+ required
+ |
+
+ bool
+ |
+
+
+
+ If True, raises an error when the key is missing. + |
+
+ False
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ Any | None
+ |
+
+
+
+ The configuration value, or None if not found and not required. + |
+
Raises:
+| Type | +Description | +
|---|---|
+ BadParameter
+ |
+
+
+
+ If required=True and the key is missing. + |
+
fastapi_toolsets.cli.config.get_fixtures_registry()
+
+¶Import and return the fixtures registry from config.
+ + +fastapi_toolsets.cli.config.get_db_context()
+
+¶Import and return the db_context function from config.
+ + +fastapi_toolsets.cli.config.get_custom_cli()
+
+¶Import and return the custom CLI Typer instance from config.
+ + +fastapi_toolsets.cli.utils.async_command(func)
+
+¶crud¶Here's the reference for the CRUD classes, factory, and search utilities.
+You can import the main symbols from fastapi_toolsets.crud:
from fastapi_toolsets.crud import CrudFactory, AsyncCrud
+from fastapi_toolsets.crud.search import SearchConfig, get_searchable_fields, build_search_filters
+fastapi_toolsets.crud.factory.AsyncCrud
+
+
+¶
+ Bases: Generic[ModelType]
Generic async CRUD operations for SQLAlchemy models.
+Subclass this and set the model class variable, or use CrudFactory.
count(session, filters=None, *, joins=None, outer_join=False)
+
+
+ async
+ classmethod
+
+
+¶Count records matching the filters.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ filters
+ |
+
+ list[Any] | None
+ |
+
+
+
+ List of SQLAlchemy filter conditions + |
+
+ None
+ |
+
+ joins
+ |
+
+ JoinType | None
+ |
+
+
+
+ List of (model, condition) tuples for joining related tables + |
+
+ None
+ |
+
+ outer_join
+ |
+
+ bool
+ |
+
+
+
+ Use LEFT OUTER JOIN instead of INNER JOIN + |
+
+ False
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ int
+ |
+
+
+
+ Number of matching records + |
+
create(session, obj, *, schema=None)
+
+
+ async
+ classmethod
+
+
+¶Create a new record in the database.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ obj
+ |
+
+ BaseModel
+ |
+
+
+
+ Pydantic model with data to create + |
+ + required + | +
+ schema
+ |
+
+ type[BaseModel] | None
+ |
+
+
+
+ Pydantic schema to serialize the result into. When provided,
+the result is automatically wrapped in a |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ ModelType | Response[Any]
+ |
+
+
+
+ Created model instance, or |
+
cursor_paginate(session, *, cursor=None, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, items_per_page=20, search=None, search_fields=None, facet_fields=None, filter_by=None, schema)
+
+
+ async
+ classmethod
+
+
+¶Get paginated results using cursor-based pagination.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session. + |
+ + required + | +
+ cursor
+ |
+
+ str | None
+ |
+
+
+
+ Cursor string from a previous |
+
+ None
+ |
+
+ filters
+ |
+
+ list[Any] | None
+ |
+
+
+
+ List of SQLAlchemy filter conditions. + |
+
+ None
+ |
+
+ joins
+ |
+
+ JoinType | None
+ |
+
+
+
+ List of |
+
+ None
+ |
+
+ outer_join
+ |
+
+ bool
+ |
+
+
+
+ Use LEFT OUTER JOIN instead of INNER JOIN. + |
+
+ False
+ |
+
+ load_options
+ |
+
+ Sequence[ExecutableOption] | None
+ |
+
+
+
+ SQLAlchemy loader options. Falls back to
+ |
+
+ None
+ |
+
+ order_by
+ |
+
+ OrderByClause | None
+ |
+
+
+
+ Additional ordering applied after the cursor column. + |
+
+ None
+ |
+
+ items_per_page
+ |
+
+ int
+ |
+
+
+
+ Number of items per page (default 20). + |
+
+ 20
+ |
+
+ search
+ |
+
+ str | SearchConfig | None
+ |
+
+
+
+ Search query string or SearchConfig object. + |
+
+ None
+ |
+
+ search_fields
+ |
+
+ Sequence[SearchFieldType] | None
+ |
+
+
+
+ Fields to search in (overrides class default). + |
+
+ None
+ |
+
+ facet_fields
+ |
+
+ Sequence[FacetFieldType] | None
+ |
+
+
+
+ Columns to compute distinct values for (overrides class default). + |
+
+ None
+ |
+
+ filter_by
+ |
+
+ dict[str, Any] | BaseModel | None
+ |
+
+
+
+ Dict of {column_key: value} to filter by declared facet fields. +Keys must match the column.key of a facet field. Scalar → equality, +list → IN clause. Raises InvalidFacetFilterError for unknown keys. + |
+
+ None
+ |
+
+ schema
+ |
+
+ type[BaseModel]
+ |
+
+
+
+ Optional Pydantic schema to serialize each item into. + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ PaginatedResponse[Any]
+ |
+
+
+
+ PaginatedResponse with CursorPagination metadata + |
+
delete(session, filters, *, return_response=False)
+
+
+ async
+ classmethod
+
+
+¶Delete records from the database.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ filters
+ |
+
+ list[Any]
+ |
+
+
+
+ List of SQLAlchemy filter conditions + |
+ + required + | +
+ return_response
+ |
+
+ bool
+ |
+
+
+
+ When |
+
+ False
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ None | Response[None]
+ |
+
+
+
+
|
+
exists(session, filters, *, joins=None, outer_join=False)
+
+
+ async
+ classmethod
+
+
+¶Check if a record exists.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ filters
+ |
+
+ list[Any]
+ |
+
+
+
+ List of SQLAlchemy filter conditions + |
+ + required + | +
+ joins
+ |
+
+ JoinType | None
+ |
+
+
+
+ List of (model, condition) tuples for joining related tables + |
+
+ None
+ |
+
+ outer_join
+ |
+
+ bool
+ |
+
+
+
+ Use LEFT OUTER JOIN instead of INNER JOIN + |
+
+ False
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ bool
+ |
+
+
+
+ True if at least one record matches + |
+
filter_params(*, facet_fields=None)
+
+
+ classmethod
+
+
+¶Return a FastAPI dependency that collects facet filter values from query parameters.
+Args:
+ facet_fields: Override the facet fields for this dependency. Falls back to the
+ class-level facet_fields if not provided.
Returns:
+| Type | +Description | +
|---|---|
+ Callable[..., Awaitable[dict[str, list[str]]]]
+ |
+
+
+
+ An async dependency function named |
+
+ Callable[..., Awaitable[dict[str, list[str]]]]
+ |
+
+
+
+
|
+
+ Callable[..., Awaitable[dict[str, list[str]]]]
+ |
+
+
+
+ request (absent/ |
+
Raises:
+| Type | +Description | +
|---|---|
+ ValueError
+ |
+
+
+
+ If no facet fields are configured on this CRUD class and none are
+provided via |
+
first(session, filters=None, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None)
+
+
+ async
+ classmethod
+
+
+¶Get the first matching record, or None.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ filters
+ |
+
+ list[Any] | None
+ |
+
+
+
+ List of SQLAlchemy filter conditions + |
+
+ None
+ |
+
+ joins
+ |
+
+ JoinType | None
+ |
+
+
+
+ List of (model, condition) tuples for joining related tables + |
+
+ None
+ |
+
+ outer_join
+ |
+
+ bool
+ |
+
+
+
+ Use LEFT OUTER JOIN instead of INNER JOIN + |
+
+ False
+ |
+
+ with_for_update
+ |
+
+ bool
+ |
+
+
+
+ Lock the row for update + |
+
+ False
+ |
+
+ load_options
+ |
+
+ Sequence[ExecutableOption] | None
+ |
+
+
+
+ SQLAlchemy loader options (e.g., selectinload) + |
+
+ None
+ |
+
+ schema
+ |
+
+ type[BaseModel] | None
+ |
+
+
+
+ Pydantic schema to serialize the result into. When provided,
+the result is automatically wrapped in a |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ ModelType | Response[Any] | None
+ |
+
+
+
+ Model instance, |
+
+ ModelType | Response[Any] | None
+ |
+
+
+
+ or |
+
get(session, filters, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None)
+
+
+ async
+ classmethod
+
+
+¶Get exactly one record. Raises NotFoundError if not found.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ filters
+ |
+
+ list[Any]
+ |
+
+
+
+ List of SQLAlchemy filter conditions + |
+ + required + | +
+ joins
+ |
+
+ JoinType | None
+ |
+
+
+
+ List of (model, condition) tuples for joining related tables + |
+
+ None
+ |
+
+ outer_join
+ |
+
+ bool
+ |
+
+
+
+ Use LEFT OUTER JOIN instead of INNER JOIN + |
+
+ False
+ |
+
+ with_for_update
+ |
+
+ bool
+ |
+
+
+
+ Lock the row for update + |
+
+ False
+ |
+
+ load_options
+ |
+
+ Sequence[ExecutableOption] | None
+ |
+
+
+
+ SQLAlchemy loader options (e.g., selectinload) + |
+
+ None
+ |
+
+ schema
+ |
+
+ type[BaseModel] | None
+ |
+
+
+
+ Pydantic schema to serialize the result into. When provided,
+the result is automatically wrapped in a |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ ModelType | Response[Any]
+ |
+
+
+
+ Model instance, or |
+
Raises:
+| Type | +Description | +
|---|---|
+ NotFoundError
+ |
+
+
+
+ If no record found + |
+
+ MultipleResultsFound
+ |
+
+
+
+ If more than one record found + |
+
get_multi(session, *, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, limit=None, offset=None)
+
+
+ async
+ classmethod
+
+
+¶Get multiple records from the database.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ filters
+ |
+
+ list[Any] | None
+ |
+
+
+
+ List of SQLAlchemy filter conditions + |
+
+ None
+ |
+
+ joins
+ |
+
+ JoinType | None
+ |
+
+
+
+ List of (model, condition) tuples for joining related tables + |
+
+ None
+ |
+
+ outer_join
+ |
+
+ bool
+ |
+
+
+
+ Use LEFT OUTER JOIN instead of INNER JOIN + |
+
+ False
+ |
+
+ load_options
+ |
+
+ Sequence[ExecutableOption] | None
+ |
+
+
+
+ SQLAlchemy loader options + |
+
+ None
+ |
+
+ order_by
+ |
+
+ OrderByClause | None
+ |
+
+
+
+ Column or list of columns to order by + |
+
+ None
+ |
+
+ limit
+ |
+
+ int | None
+ |
+
+
+
+ Max number of rows to return + |
+
+ None
+ |
+
+ offset
+ |
+
+ int | None
+ |
+
+
+
+ Rows to skip + |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ Sequence[ModelType]
+ |
+
+
+
+ List of model instances + |
+
get_or_none(session, filters, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None)
+
+
+ async
+ classmethod
+
+
+¶Get exactly one record, or None if not found.
Like :meth:get but returns None instead of raising
+:class:~fastapi_toolsets.exceptions.NotFoundError when no record
+matches the filters.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ filters
+ |
+
+ list[Any]
+ |
+
+
+
+ List of SQLAlchemy filter conditions + |
+ + required + | +
+ joins
+ |
+
+ JoinType | None
+ |
+
+
+
+ List of (model, condition) tuples for joining related tables + |
+
+ None
+ |
+
+ outer_join
+ |
+
+ bool
+ |
+
+
+
+ Use LEFT OUTER JOIN instead of INNER JOIN + |
+
+ False
+ |
+
+ with_for_update
+ |
+
+ bool
+ |
+
+
+
+ Lock the row for update + |
+
+ False
+ |
+
+ load_options
+ |
+
+ Sequence[ExecutableOption] | None
+ |
+
+
+
+ SQLAlchemy loader options (e.g., selectinload) + |
+
+ None
+ |
+
+ schema
+ |
+
+ type[BaseModel] | None
+ |
+
+
+
+ Pydantic schema to serialize the result into. When provided,
+the result is automatically wrapped in a |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ ModelType | Response[Any] | None
+ |
+
+
+
+ Model instance, |
+
+ ModelType | Response[Any] | None
+ |
+
+
+
+ or |
+
Raises:
+| Type | +Description | +
|---|---|
+ MultipleResultsFound
+ |
+
+
+
+ If more than one record found + |
+
offset_paginate(session, *, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, page=1, items_per_page=20, search=None, search_fields=None, facet_fields=None, filter_by=None, schema)
+
+
+ async
+ classmethod
+
+
+¶Get paginated results using offset-based pagination.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ filters
+ |
+
+ list[Any] | None
+ |
+
+
+
+ List of SQLAlchemy filter conditions + |
+
+ None
+ |
+
+ joins
+ |
+
+ JoinType | None
+ |
+
+
+
+ List of (model, condition) tuples for joining related tables + |
+
+ None
+ |
+
+ outer_join
+ |
+
+ bool
+ |
+
+
+
+ Use LEFT OUTER JOIN instead of INNER JOIN + |
+
+ False
+ |
+
+ load_options
+ |
+
+ Sequence[ExecutableOption] | None
+ |
+
+
+
+ SQLAlchemy loader options + |
+
+ None
+ |
+
+ order_by
+ |
+
+ OrderByClause | None
+ |
+
+
+
+ Column or list of columns to order by + |
+
+ None
+ |
+
+ page
+ |
+
+ int
+ |
+
+
+
+ Page number (1-indexed) + |
+
+ 1
+ |
+
+ items_per_page
+ |
+
+ int
+ |
+
+
+
+ Number of items per page + |
+
+ 20
+ |
+
+ search
+ |
+
+ str | SearchConfig | None
+ |
+
+
+
+ Search query string or SearchConfig object + |
+
+ None
+ |
+
+ search_fields
+ |
+
+ Sequence[SearchFieldType] | None
+ |
+
+
+
+ Fields to search in (overrides class default) + |
+
+ None
+ |
+
+ facet_fields
+ |
+
+ Sequence[FacetFieldType] | None
+ |
+
+
+
+ Columns to compute distinct values for (overrides class default) + |
+
+ None
+ |
+
+ filter_by
+ |
+
+ dict[str, Any] | BaseModel | None
+ |
+
+
+
+ Dict of {column_key: value} to filter by declared facet fields. +Keys must match the column.key of a facet field. Scalar → equality, +list → IN clause. Raises InvalidFacetFilterError for unknown keys. + |
+
+ None
+ |
+
+ schema
+ |
+
+ type[BaseModel]
+ |
+
+
+
+ Pydantic schema to serialize each item into. + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ PaginatedResponse[Any]
+ |
+
+
+
+ PaginatedResponse with OffsetPagination metadata + |
+
order_params(*, order_fields=None, default_field=None, default_order='asc')
+
+
+ classmethod
+
+
+¶Return a FastAPI dependency that resolves order query params into an order_by clause.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ order_fields
+ |
+
+ Sequence[QueryableAttribute[Any]] | None
+ |
+
+
+
+ Override the allowed order fields. Falls back to the class-level
+ |
+
+ None
+ |
+
+ default_field
+ |
+
+ QueryableAttribute[Any] | None
+ |
+
+
+
+ Field to order by when |
+
+ None
+ |
+
+ default_order
+ |
+
+ Literal['asc', 'desc']
+ |
+
+
+
+ Default order direction when |
+
+ 'asc'
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ Callable[..., Awaitable[OrderByClause | None]]
+ |
+
+
+
+ An async dependency function named |
+
+ Callable[..., Awaitable[OrderByClause | None]]
+ |
+
+
+
+
|
+
Raises:
+| Type | +Description | +
|---|---|
+ ValueError
+ |
+
+
+
+ If no order fields are configured on this CRUD class and none are
+provided via |
+
+ InvalidOrderFieldError
+ |
+
+
+
+ When the request provides an unknown |
+
update(session, obj, filters, *, exclude_unset=True, exclude_none=False, schema=None)
+
+
+ async
+ classmethod
+
+
+¶Update a record in the database.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ obj
+ |
+
+ BaseModel
+ |
+
+
+
+ Pydantic model with update data + |
+ + required + | +
+ filters
+ |
+
+ list[Any]
+ |
+
+
+
+ List of SQLAlchemy filter conditions + |
+ + required + | +
+ exclude_unset
+ |
+
+ bool
+ |
+
+
+
+ Exclude fields not explicitly set in the schema + |
+
+ True
+ |
+
+ exclude_none
+ |
+
+ bool
+ |
+
+
+
+ Exclude fields with None value + |
+
+ False
+ |
+
+ schema
+ |
+
+ type[BaseModel] | None
+ |
+
+
+
+ Pydantic schema to serialize the result into. When provided,
+the result is automatically wrapped in a |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ ModelType | Response[Any]
+ |
+
+
+
+ Updated model instance, or |
+
Raises:
+| Type | +Description | +
|---|---|
+ NotFoundError
+ |
+
+
+
+ If no record found + |
+
upsert(session, obj, index_elements, *, set_=None, where=None)
+
+
+ async
+ classmethod
+
+
+¶Create or update a record (PostgreSQL only).
+Uses INSERT ... ON CONFLICT for atomic upsert.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ DB async session + |
+ + required + | +
+ obj
+ |
+
+ BaseModel
+ |
+
+
+
+ Pydantic model with data + |
+ + required + | +
+ index_elements
+ |
+
+ list[str]
+ |
+
+
+
+ Columns for ON CONFLICT (unique constraint) + |
+ + required + | +
+ set_
+ |
+
+ BaseModel | None
+ |
+
+
+
+ Pydantic model for ON CONFLICT DO UPDATE SET + |
+
+ None
+ |
+
+ where
+ |
+
+ WhereHavingRole | None
+ |
+
+
+
+ WHERE clause for ON CONFLICT DO UPDATE + |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ ModelType | None
+ |
+
+
+
+ Model instance + |
+
fastapi_toolsets.crud.factory.CrudFactory(model, *, searchable_fields=None, facet_fields=None, order_fields=None, m2m_fields=None, default_load_options=None, cursor_column=None)
+
+¶Create a CRUD class for a specific model.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ model
+ |
+
+ type[ModelType]
+ |
+
+
+
+ SQLAlchemy model class + |
+ + required + | +
+ searchable_fields
+ |
+
+ Sequence[SearchFieldType] | None
+ |
+
+
+
+ Optional list of searchable fields + |
+
+ None
+ |
+
+ facet_fields
+ |
+
+ Sequence[FacetFieldType] | None
+ |
+
+
+
+ Optional list of columns to compute distinct values for in paginated
+responses. Supports direct columns ( |
+
+ None
+ |
+
+ order_fields
+ |
+
+ Sequence[QueryableAttribute[Any]] | None
+ |
+
+
+
+ Optional list of model attributes that callers are allowed to order by
+via |
+
+ None
+ |
+
+ m2m_fields
+ |
+
+ M2MFieldType | None
+ |
+
+
+
+ Optional mapping for many-to-many relationships. +Maps schema field names (containing lists of IDs) to +SQLAlchemy relationship attributes. + |
+
+ None
+ |
+
+ default_load_options
+ |
+
+ Sequence[ExecutableOption] | None
+ |
+
+
+
+ Default SQLAlchemy loader options applied to all read
+queries when no explicit |
+
+ None
+ |
+
+ cursor_column
+ |
+
+ Any | None
+ |
+
+
+
+ Required to call |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ type[AsyncCrud[ModelType]]
+ |
+
+
+
+ AsyncCrud subclass bound to the model + |
+
from fastapi_toolsets.crud import CrudFactory
+from myapp.models import User, Post
+
+UserCrud = CrudFactory(User)
+PostCrud = CrudFactory(Post)
+
+# With searchable fields:
+UserCrud = CrudFactory(
+ User,
+ searchable_fields=[User.username, User.email, (User.role, Role.name)]
+)
+
+# With many-to-many fields:
+# Schema has `tag_ids: list[UUID]`, model has `tags` relationship to Tag
+PostCrud = CrudFactory(
+ Post,
+ m2m_fields={"tag_ids": Post.tags},
+)
+
+# With facet fields for filter dropdowns / faceted search:
+UserCrud = CrudFactory(
+ User,
+ facet_fields=[User.status, User.country, (User.role, Role.name)],
+)
+
+# With a fixed cursor column for cursor_paginate:
+PostCrud = CrudFactory(
+ Post,
+ cursor_column=Post.created_at,
+)
+
+# With default load strategy (replaces lazy="selectin" on the model):
+ArticleCrud = CrudFactory(
+ Article,
+ default_load_options=[selectinload(Article.category), selectinload(Article.tags)],
+)
+
+# Override default_load_options for a specific call:
+article = await ArticleCrud.get(
+ session,
+ [Article.id == 1],
+ load_options=[selectinload(Article.category)], # tags won't load
+)
+
+# Usage
+user = await UserCrud.get(session, [User.id == 1])
+posts = await PostCrud.get_multi(session, filters=[Post.user_id == user.id])
+
+# Create with M2M - tag_ids are automatically resolved
+post = await PostCrud.create(session, PostCreate(title="Hello", tag_ids=[id1, id2]))
+
+# With search
+result = await UserCrud.offset_paginate(session, search="john")
+
+# With joins (inner join by default):
+users = await UserCrud.get_multi(
+ session,
+ joins=[(Post, Post.user_id == User.id)],
+ filters=[Post.published == True],
+)
+
+# With outer join:
+users = await UserCrud.get_multi(
+ session,
+ joins=[(Post, Post.user_id == User.id)],
+ outer_join=True,
+)
+fastapi_toolsets.crud.search.SearchConfig
+
+
+
+ dataclass
+
+
+¶Advanced search configuration.
+ + +Attributes:
+| Name | +Type | +Description | +
|---|---|---|
query |
+
+ str
+ |
+
+
+
+ The search string + |
+
fields |
+
+ Sequence[SearchFieldType] | None
+ |
+
+
+
+ Fields to search (columns or tuples for relationships) + |
+
case_sensitive |
+
+ bool
+ |
+
+
+
+ Case-sensitive search (default: False) + |
+
match_mode |
+
+ Literal['any', 'all']
+ |
+
+
+
+ "any" (OR) or "all" (AND) to combine fields + |
+
fastapi_toolsets.crud.search.get_searchable_fields(model, *, include_relationships=True, max_depth=1)
+
+
+ cached
+
+
+¶Auto-detect String fields on a model and its relationships.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ model
+ |
+
+ type[DeclarativeBase]
+ |
+
+
+
+ SQLAlchemy model class + |
+ + required + | +
+ include_relationships
+ |
+
+ bool
+ |
+
+
+
+ Include fields from many-to-one/one-to-one relationships + |
+
+ True
+ |
+
+ max_depth
+ |
+
+ int
+ |
+
+
+
+ Max depth for relationship traversal (default: 1) + |
+
+ 1
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ list[SearchFieldType]
+ |
+
+
+
+ List of columns and tuples (relationship, column) + |
+
fastapi_toolsets.crud.search.build_search_filters(model, search, search_fields=None, default_fields=None)
+
+¶Build SQLAlchemy filter conditions for search.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ model
+ |
+
+ type[DeclarativeBase]
+ |
+
+
+
+ SQLAlchemy model class + |
+ + required + | +
+ search
+ |
+
+ str | SearchConfig
+ |
+
+
+
+ Search string or SearchConfig + |
+ + required + | +
+ search_fields
+ |
+
+ Sequence[SearchFieldType] | None
+ |
+
+
+
+ Fields specified per-call (takes priority) + |
+
+ None
+ |
+
+ default_fields
+ |
+
+ Sequence[SearchFieldType] | None
+ |
+
+
+
+ Default fields (from ClassVar) + |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ tuple[list[ColumnElement[bool]], list[InstrumentedAttribute[Any]]]
+ |
+
+
+
+ Tuple of (filter_conditions, joins_needed) + |
+
Raises:
+| Type | +Description | +
|---|---|
+ NoSearchableFieldsError
+ |
+
+
+
+ If no searchable field has been configured + |
+
db¶Here's the reference for all database session utilities, transaction helpers, and locking functions.
+You can import them directly from fastapi_toolsets.db:
from fastapi_toolsets.db import (
+ LockMode,
+ cleanup_tables,
+ create_database,
+ create_db_dependency,
+ create_db_context,
+ get_transaction,
+ lock_tables,
+ wait_for_row_change,
+)
+fastapi_toolsets.db.LockMode
+
+
+¶PostgreSQL table lock modes.
+See: https://www.postgresql.org/docs/current/explicit-locking.html
+ + + + + + + + + + + +fastapi_toolsets.db.create_db_dependency(session_maker)
+
+¶Create a FastAPI dependency for database sessions.
+Creates a dependency function that yields a session and auto-commits +if a transaction is active when the request completes.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session_maker
+ |
+
+ async_sessionmaker[AsyncSession]
+ |
+
+
+
+ Async session factory from create_session_factory() + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ Callable[[], AsyncGenerator[AsyncSession, None]]
+ |
+
+
+
+ An async generator function usable with FastAPI's Depends() + |
+
from fastapi import Depends
+from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine, async_sessionmaker
+from fastapi_toolsets.db import create_db_dependency
+
+engine = create_async_engine("postgresql+asyncpg://...")
+SessionLocal = async_sessionmaker(engine, expire_on_commit=False)
+get_db = create_db_dependency(SessionLocal)
+
+@app.get("/users")
+async def list_users(session: AsyncSession = Depends(get_db)):
+ ...
+fastapi_toolsets.db.create_db_context(session_maker)
+
+¶Create a context manager for database sessions.
+Creates a context manager for use outside of FastAPI request handlers, +such as in background tasks, CLI commands, or tests.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session_maker
+ |
+
+ async_sessionmaker[AsyncSession]
+ |
+
+
+
+ Async session factory from create_session_factory() + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ Callable[[], AbstractAsyncContextManager[AsyncSession]]
+ |
+
+
+
+ An async context manager function + |
+
from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker
+from fastapi_toolsets.db import create_db_context
+
+engine = create_async_engine("postgresql+asyncpg://...")
+SessionLocal = async_sessionmaker(engine, expire_on_commit=False)
+get_db_context = create_db_context(SessionLocal)
+
+async def background_task():
+ async with get_db_context() as session:
+ user = await UserCrud.get(session, [User.id == 1])
+ ...
+fastapi_toolsets.db.get_transaction(session)
+
+
+ async
+
+
+¶Get a transaction context, handling nested transactions.
+If already in a transaction, creates a savepoint (nested transaction). +Otherwise, starts a new transaction.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ AsyncSession instance + |
+ + required + | +
Yields:
+| Type | +Description | +
|---|---|
+ AsyncGenerator[AsyncSession, None]
+ |
+
+
+
+ The session within the transaction context + |
+
fastapi_toolsets.db.lock_tables(session, tables, *, mode=LockMode.SHARE_UPDATE_EXCLUSIVE, timeout='5s')
+
+
+ async
+
+
+¶Lock PostgreSQL tables for the duration of a transaction.
+Acquires table-level locks that are held until the transaction ends. +Useful for preventing concurrent modifications during critical operations.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ AsyncSession instance + |
+ + required + | +
+ tables
+ |
+
+ list[type[DeclarativeBase]]
+ |
+
+
+
+ List of SQLAlchemy model classes to lock + |
+ + required + | +
+ mode
+ |
+
+ LockMode
+ |
+
+
+
+ Lock mode (default: SHARE UPDATE EXCLUSIVE) + |
+
+ SHARE_UPDATE_EXCLUSIVE
+ |
+
+ timeout
+ |
+
+ str
+ |
+
+
+
+ Lock timeout (default: "5s") + |
+
+ '5s'
+ |
+
Yields:
+| Type | +Description | +
|---|---|
+ AsyncGenerator[AsyncSession, None]
+ |
+
+
+
+ The session with locked tables + |
+
Raises:
+| Type | +Description | +
|---|---|
+ SQLAlchemyError
+ |
+
+
+
+ If lock cannot be acquired within timeout + |
+
from fastapi_toolsets.db import lock_tables, LockMode
+
+async with lock_tables(session, [User, Account]):
+ # Tables are locked with SHARE UPDATE EXCLUSIVE mode
+ user = await UserCrud.get(session, [User.id == 1])
+ user.balance += 100
+
+# With custom lock mode
+async with lock_tables(session, [Order], mode=LockMode.EXCLUSIVE):
+ # Exclusive lock - no other transactions can access
+ await process_order(session, order_id)
+fastapi_toolsets.db.wait_for_row_change(session, model, pk_value, *, columns=None, interval=0.5, timeout=None)
+
+
+ async
+
+
+¶Poll a database row until a change is detected.
+Queries the row every interval seconds and returns the model instance
+once a change is detected in any column (or only the specified columns).
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ AsyncSession instance + |
+ + required + | +
+ model
+ |
+
+ type[_M]
+ |
+
+
+
+ SQLAlchemy model class + |
+ + required + | +
+ pk_value
+ |
+
+ Any
+ |
+
+
+
+ Primary key value of the row to watch + |
+ + required + | +
+ columns
+ |
+
+ list[str] | None
+ |
+
+
+
+ Optional list of column names to watch. If None, all columns + are watched. + |
+
+ None
+ |
+
+ interval
+ |
+
+ float
+ |
+
+
+
+ Polling interval in seconds (default: 0.5) + |
+
+ 0.5
+ |
+
+ timeout
+ |
+
+ float | None
+ |
+
+
+
+ Maximum time to wait in seconds. None means wait forever. + |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ _M
+ |
+
+
+
+ The refreshed model instance with updated values + |
+
Raises:
+| Type | +Description | +
|---|---|
+ NotFoundError
+ |
+
+
+
+ If the row does not exist or is deleted during polling + |
+
+ TimeoutError
+ |
+
+
+
+ If timeout expires before a change is detected + |
+
from fastapi_toolsets.db import wait_for_row_change
+
+# Wait for any column to change
+updated = await wait_for_row_change(session, User, user_id)
+
+# Watch specific columns with a timeout
+updated = await wait_for_row_change(
+ session, User, user_id,
+ columns=["status", "email"],
+ interval=1.0,
+ timeout=30.0,
+)
+fastapi_toolsets.db.create_database(db_name, *, server_url)
+
+
+ async
+
+
+¶Create a database.
+Connects to server_url using AUTOCOMMIT isolation and issues a
+CREATE DATABASE statement for db_name.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ db_name
+ |
+
+ str
+ |
+
+
+
+ Name of the database to create. + |
+ + required + | +
+ server_url
+ |
+
+ str
+ |
+
+
+
+ URL used for server-level DDL (must point to an existing +database on the same server). + |
+ + required + | +
fastapi_toolsets.db.cleanup_tables(session, base)
+
+
+ async
+
+
+¶Truncate all tables for fast between-test cleanup.
+Executes a single TRUNCATE … RESTART IDENTITY CASCADE statement
+across every table in base's metadata, which is significantly faster
+than dropping and re-creating tables between tests.
This is a no-op when the metadata contains no tables.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ An active async database session. + |
+ + required + | +
+ base
+ |
+
+ type[DeclarativeBase]
+ |
+
+
+
+ SQLAlchemy DeclarativeBase class containing model metadata. + |
+ + required + | +
dependencies¶Here's the reference for the FastAPI dependency factory functions.
+You can import them directly from fastapi_toolsets.dependencies:
fastapi_toolsets.dependencies.PathDependency(model, field, *, session_dep, param_name=None)
+
+¶Create a dependency that fetches a DB object from a path parameter.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ model
+ |
+
+ type[ModelType]
+ |
+
+
+
+ SQLAlchemy model class + |
+ + required + | +
+ field
+ |
+
+ Any
+ |
+
+
+
+ Model field to filter by (e.g., User.id) + |
+ + required + | +
+ session_dep
+ |
+
+ SessionDependency
+ |
+
+
+
+ Session dependency function (e.g., get_db) + |
+ + required + | +
+ param_name
+ |
+
+ str | None
+ |
+
+
+
+ Path parameter name (defaults to model_field, e.g., user_id) + |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ ModelType
+ |
+
+
+
+ A Depends() instance that resolves to the model instance + |
+
Raises:
+| Type | +Description | +
|---|---|
+ NotFoundError
+ |
+
+
+
+ If no matching record is found + |
+
fastapi_toolsets.dependencies.BodyDependency(model, field, *, session_dep, body_field)
+
+¶Create a dependency that fetches a DB object from a body field.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ model
+ |
+
+ type[ModelType]
+ |
+
+
+
+ SQLAlchemy model class + |
+ + required + | +
+ field
+ |
+
+ Any
+ |
+
+
+
+ Model field to filter by (e.g., User.id) + |
+ + required + | +
+ session_dep
+ |
+
+ SessionDependency
+ |
+
+
+
+ Session dependency function (e.g., get_db) + |
+ + required + | +
+ body_field
+ |
+
+ str
+ |
+
+
+
+ Name of the field in the request body + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ ModelType
+ |
+
+
+
+ A Depends() instance that resolves to the model instance + |
+
Raises:
+| Type | +Description | +
|---|---|
+ NotFoundError
+ |
+
+
+
+ If no matching record is found + |
+
exceptions¶Here's the reference for all exception classes and handler utilities.
+You can import them directly from fastapi_toolsets.exceptions:
from fastapi_toolsets.exceptions import (
+ ApiException,
+ UnauthorizedError,
+ ForbiddenError,
+ NotFoundError,
+ ConflictError,
+ NoSearchableFieldsError,
+ InvalidFacetFilterError,
+ InvalidOrderFieldError,
+ generate_error_responses,
+ init_exceptions_handlers,
+)
+fastapi_toolsets.exceptions.exceptions.ApiException
+
+
+¶
+ Bases: Exception
Base exception for API errors with structured response.
+ + + + + + + + + + + +__init__(detail=None, *, desc=None, data=None)
+
+¶Initialize the exception.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ detail
+ |
+
+ str | None
+ |
+
+
+
+ Optional human-readable message + |
+
+ None
+ |
+
+ desc
+ |
+
+ str | None
+ |
+
+
+
+ Optional per-instance override for the |
+
+ None
+ |
+
+ data
+ |
+
+ Any
+ |
+
+
+
+ Optional per-instance override for the |
+
+ None
+ |
+
fastapi_toolsets.exceptions.exceptions.UnauthorizedError
+
+
+¶
+ Bases: ApiException
HTTP 401 - User is not authenticated.
+ + + + + + + + + + + +__init__(detail=None, *, desc=None, data=None)
+
+¶Initialize the exception.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ detail
+ |
+
+ str | None
+ |
+
+
+
+ Optional human-readable message + |
+
+ None
+ |
+
+ desc
+ |
+
+ str | None
+ |
+
+
+
+ Optional per-instance override for the |
+
+ None
+ |
+
+ data
+ |
+
+ Any
+ |
+
+
+
+ Optional per-instance override for the |
+
+ None
+ |
+
fastapi_toolsets.exceptions.exceptions.ForbiddenError
+
+
+¶
+ Bases: ApiException
HTTP 403 - User lacks required permissions.
+ + + + + + + + + + + +__init__(detail=None, *, desc=None, data=None)
+
+¶Initialize the exception.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ detail
+ |
+
+ str | None
+ |
+
+
+
+ Optional human-readable message + |
+
+ None
+ |
+
+ desc
+ |
+
+ str | None
+ |
+
+
+
+ Optional per-instance override for the |
+
+ None
+ |
+
+ data
+ |
+
+ Any
+ |
+
+
+
+ Optional per-instance override for the |
+
+ None
+ |
+
fastapi_toolsets.exceptions.exceptions.NotFoundError
+
+
+¶
+ Bases: ApiException
HTTP 404 - Resource not found.
+ + + + + + + + + + + +__init__(detail=None, *, desc=None, data=None)
+
+¶Initialize the exception.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ detail
+ |
+
+ str | None
+ |
+
+
+
+ Optional human-readable message + |
+
+ None
+ |
+
+ desc
+ |
+
+ str | None
+ |
+
+
+
+ Optional per-instance override for the |
+
+ None
+ |
+
+ data
+ |
+
+ Any
+ |
+
+
+
+ Optional per-instance override for the |
+
+ None
+ |
+
fastapi_toolsets.exceptions.exceptions.ConflictError
+
+
+¶
+ Bases: ApiException
HTTP 409 - Resource conflict.
+ + + + + + + + + + + +__init__(detail=None, *, desc=None, data=None)
+
+¶Initialize the exception.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ detail
+ |
+
+ str | None
+ |
+
+
+
+ Optional human-readable message + |
+
+ None
+ |
+
+ desc
+ |
+
+ str | None
+ |
+
+
+
+ Optional per-instance override for the |
+
+ None
+ |
+
+ data
+ |
+
+ Any
+ |
+
+
+
+ Optional per-instance override for the |
+
+ None
+ |
+
fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError
+
+
+¶
+ Bases: ApiException
Raised when search is requested but no searchable fields are available.
+ + + + + + + + + + + + + +fastapi_toolsets.exceptions.exceptions.InvalidFacetFilterError
+
+
+¶
+ Bases: ApiException
Raised when filter_by contains a key not declared in facet_fields.
+ + + + + + + + + + + +__init__(key, valid_keys)
+
+¶Initialize the exception.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ key
+ |
+
+ str
+ |
+
+
+
+ The unknown filter key provided by the caller. + |
+ + required + | +
+ valid_keys
+ |
+
+ set[str]
+ |
+
+
+
+ Set of valid keys derived from the declared facet_fields. + |
+ + required + | +
fastapi_toolsets.exceptions.exceptions.InvalidOrderFieldError
+
+
+¶
+ Bases: ApiException
Raised when order_by contains a field not in the allowed order fields.
+ + + + + + + + + + + +__init__(field, valid_fields)
+
+¶fastapi_toolsets.exceptions.exceptions.generate_error_responses(*errors)
+
+¶Generate OpenAPI response documentation for exceptions.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ *errors
+ |
+
+ type[ApiException]
+ |
+
+
+
+ Exception classes that inherit from ApiException. + |
+
+ ()
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ dict[int | str, dict[str, Any]]
+ |
+
+
+
+ Dict suitable for FastAPI's |
+
fastapi_toolsets.exceptions.handler.init_exceptions_handlers(app)
+
+¶Register exception handlers and custom OpenAPI schema on a FastAPI app.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ app
+ |
+
+ FastAPI
+ |
+
+
+
+ FastAPI application instance. + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ FastAPI
+ |
+
+
+
+ The same FastAPI instance (for chaining). + |
+
fixtures¶Here's the reference for the fixture registry, enums, and loading utilities.
+You can import them directly from fastapi_toolsets.fixtures:
from fastapi_toolsets.fixtures import (
+ Context,
+ LoadStrategy,
+ Fixture,
+ FixtureRegistry,
+ load_fixtures,
+ load_fixtures_by_context,
+ get_obj_by_attr,
+)
+fastapi_toolsets.fixtures.enum.Context
+
+
+¶Predefined fixture contexts.
+ + + + + + + + + + + +BASE = 'base'
+
+
+ class-attribute
+ instance-attribute
+
+
+¶Base fixtures loaded in all environments.
+ +DEVELOPMENT = 'development'
+
+
+ class-attribute
+ instance-attribute
+
+
+¶Development fixtures.
+ +PRODUCTION = 'production'
+
+
+ class-attribute
+ instance-attribute
+
+
+¶Production-only fixtures.
+ +TESTING = 'testing'
+
+
+ class-attribute
+ instance-attribute
+
+
+¶Test fixtures.
+ +fastapi_toolsets.fixtures.enum.LoadStrategy
+
+
+¶Strategy for loading fixtures into the database.
+ + + + + + + + + + + +INSERT = 'insert'
+
+
+ class-attribute
+ instance-attribute
+
+
+¶Insert new records. Fails if record already exists.
+ +MERGE = 'merge'
+
+
+ class-attribute
+ instance-attribute
+
+
+¶Insert or update based on primary key (SQLAlchemy merge).
+ +SKIP_EXISTING = 'skip_existing'
+
+
+ class-attribute
+ instance-attribute
+
+
+¶Insert only if record doesn't exist (based on primary key).
+ +fastapi_toolsets.fixtures.registry.Fixture
+
+
+
+ dataclass
+
+
+¶A fixture definition with metadata.
+ + + + + + + + + + + +fastapi_toolsets.fixtures.registry.FixtureRegistry
+
+
+¶Registry for managing fixtures with dependencies.
+ + +from fastapi_toolsets.fixtures import FixtureRegistry, Context
+
+fixtures = FixtureRegistry()
+
+@fixtures.register
+def roles():
+ return [
+ Role(id=1, name="admin"),
+ Role(id=2, name="user"),
+ ]
+
+@fixtures.register(depends_on=["roles"])
+def users():
+ return [
+ User(id=1, username="admin", role_id=1),
+ ]
+
+@fixtures.register(depends_on=["users"], contexts=[Context.TESTING])
+def test_data():
+ return [
+ Post(id=1, title="Test", user_id=1),
+ ]
+get(name)
+
+¶Get a fixture by name.
+ + +get_all()
+
+¶Get all registered fixtures.
+ + +get_by_context(*contexts)
+
+¶Get fixtures for specific contexts.
+ + +include_registry(registry)
+
+¶Include another FixtureRegistry in the same current FixtureRegistry.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ registry
+ |
+
+ FixtureRegistry
+ |
+
+
+
+ The |
+ + required + | +
Raises:
+| Type | +Description | +
|---|---|
+ ValueError
+ |
+
+
+
+ If a fixture name already exists in the current registry + |
+
register(func=None, *, name=None, depends_on=None, contexts=None)
+
+¶Register a fixture function.
+Can be used as a decorator with or without arguments.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ func
+ |
+
+ Callable[[], Sequence[DeclarativeBase]] | None
+ |
+
+
+
+ Fixture function returning list of model instances + |
+
+ None
+ |
+
+ name
+ |
+
+ str | None
+ |
+
+
+
+ Fixture name (defaults to function name) + |
+
+ None
+ |
+
+ depends_on
+ |
+
+ list[str] | None
+ |
+
+
+
+ List of fixture names this depends on + |
+
+ None
+ |
+
+ contexts
+ |
+
+ list[str | Context] | None
+ |
+
+
+
+ List of contexts this fixture belongs to + |
+
+ None
+ |
+
resolve_context_dependencies(*contexts)
+
+¶Resolve all fixtures for contexts with dependencies.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ *contexts
+ |
+
+ str | Context
+ |
+
+
+
+ Contexts to load + |
+
+ ()
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ list[str]
+ |
+
+
+
+ List of fixture names in load order + |
+
resolve_dependencies(*names)
+
+¶Resolve fixture dependencies in topological order.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ *names
+ |
+
+ str
+ |
+
+
+
+ Fixture names to resolve + |
+
+ ()
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ list[str]
+ |
+
+
+
+ List of fixture names in load order (dependencies first) + |
+
Raises:
+| Type | +Description | +
|---|---|
+ KeyError
+ |
+
+
+
+ If a fixture is not found + |
+
+ ValueError
+ |
+
+
+
+ If circular dependency detected + |
+
fastapi_toolsets.fixtures.utils.load_fixtures(session, registry, *names, strategy=LoadStrategy.MERGE)
+
+
+ async
+
+
+¶Load specific fixtures by name with dependencies.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ Database session + |
+ + required + | +
+ registry
+ |
+
+ FixtureRegistry
+ |
+
+
+
+ Fixture registry + |
+ + required + | +
+ *names
+ |
+
+ str
+ |
+
+
+
+ Fixture names to load (dependencies auto-resolved) + |
+
+ ()
+ |
+
+ strategy
+ |
+
+ LoadStrategy
+ |
+
+
+
+ How to handle existing records + |
+
+ MERGE
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ dict[str, list[DeclarativeBase]]
+ |
+
+
+
+ Dict mapping fixture names to loaded instances + |
+
fastapi_toolsets.fixtures.utils.load_fixtures_by_context(session, registry, *contexts, strategy=LoadStrategy.MERGE)
+
+
+ async
+
+
+¶Load all fixtures for specific contexts.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ session
+ |
+
+ AsyncSession
+ |
+
+
+
+ Database session + |
+ + required + | +
+ registry
+ |
+
+ FixtureRegistry
+ |
+
+
+
+ Fixture registry + |
+ + required + | +
+ *contexts
+ |
+
+ str | Context
+ |
+
+
+
+ Contexts to load (e.g., Context.BASE, Context.TESTING) + |
+
+ ()
+ |
+
+ strategy
+ |
+
+ LoadStrategy
+ |
+
+
+
+ How to handle existing records + |
+
+ MERGE
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ dict[str, list[DeclarativeBase]]
+ |
+
+
+
+ Dict mapping fixture names to loaded instances + |
+
fastapi_toolsets.fixtures.utils.get_obj_by_attr(fixtures, attr_name, value)
+
+¶Get a SQLAlchemy model instance by matching an attribute value.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ fixtures
+ |
+
+ Callable[[], Sequence[ModelType]]
+ |
+
+
+
+ A fixture function registered via |
+ + required + | +
+ attr_name
+ |
+
+ str
+ |
+
+
+
+ Name of the attribute to match against. + |
+ + required + | +
+ value
+ |
+
+ Any
+ |
+
+
+
+ Value to match. + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ ModelType
+ |
+
+
+
+ The first model instance where the attribute matches the given value. + |
+
Raises:
+| Type | +Description | +
|---|---|
+ StopIteration
+ |
+
+
+
+ If no matching object is found in the fixture group. + |
+
logger¶Here's the reference for the logging utilities.
+You can import them directly from fastapi_toolsets.logger:
fastapi_toolsets.logger.configure_logging(level='INFO', fmt=DEFAULT_FORMAT, logger_name=None)
+
+¶Configure logging with a stdout handler and consistent format.
+Sets up a :class:~logging.StreamHandler writing to stdout with the
+given format and level. Also configures the uvicorn loggers so that
+FastAPI access logs use the same format.
Calling this function multiple times is safe -- existing handlers are +replaced rather than duplicated.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ level
+ |
+
+ LogLevel | int
+ |
+
+
+
+ Log level (e.g. |
+
+ 'INFO'
+ |
+
+ fmt
+ |
+
+ str
+ |
+
+
+
+ Log format string. Defaults to
+ |
+
+ DEFAULT_FORMAT
+ |
+
+ logger_name
+ |
+
+ str | None
+ |
+
+
+
+ Logger name to configure. |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ Logger
+ |
+
+
+
+ The configured Logger instance. + |
+
fastapi_toolsets.logger.get_logger(name=_SENTINEL)
+
+¶Return a logger with the given name.
+A thin convenience wrapper around :func:logging.getLogger that keeps
+logging imports consistent across the codebase.
When called without arguments, the caller's __name__ is used
+automatically, so get_logger() in a module is equivalent to
+logging.getLogger(__name__). Pass None explicitly to get the
+root logger.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ name
+ |
+
+ str | None
+ |
+
+
+
+ Logger name. Defaults to the caller's |
+
+ _SENTINEL
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ Logger
+ |
+
+
+
+ A Logger instance. + |
+
metrics¶Here's the reference for the Prometheus metrics registry and endpoint handler.
+You can import them directly from fastapi_toolsets.metrics:
fastapi_toolsets.metrics.registry.Metric
+
+
+
+ dataclass
+
+
+¶A metric definition with metadata.
+ + + + + + + + + + + +fastapi_toolsets.metrics.registry.MetricsRegistry
+
+
+¶Registry for managing Prometheus metric providers and collectors.
+ + + + + + + + + + + +get(name)
+
+¶Return the metric instance created by a provider.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ name
+ |
+
+ str
+ |
+
+
+
+ The metric name (defaults to the provider function name). + |
+ + required + | +
Raises:
+| Type | +Description | +
|---|---|
+ KeyError
+ |
+
+
+
+ If the metric name is unknown or |
+
get_all()
+
+¶Get all registered metric definitions.
+ + +get_collectors()
+
+¶Get collectors (called on each scrape).
+ + +get_providers()
+
+¶Get metric providers (called once at init).
+ + +include_registry(registry)
+
+¶Include another :class:MetricsRegistry into this one.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ registry
+ |
+
+ MetricsRegistry
+ |
+
+
+
+ The registry to merge in. + |
+ + required + | +
Raises:
+| Type | +Description | +
|---|---|
+ ValueError
+ |
+
+
+
+ If a metric name already exists in the current registry. + |
+
register(func=None, *, name=None, collect=False)
+
+¶Register a metric provider or collector function.
+Can be used as a decorator with or without arguments.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ func
+ |
+
+ Callable[..., Any] | None
+ |
+
+
+
+ The metric function to register. + |
+
+ None
+ |
+
+ name
+ |
+
+ str | None
+ |
+
+
+
+ Metric name (defaults to function name). + |
+
+ None
+ |
+
+ collect
+ |
+
+ bool
+ |
+
+
+
+ If |
+
+ False
+ |
+
fastapi_toolsets.metrics.handler.init_metrics(app, registry, *, path='/metrics')
+
+¶Register a Prometheus /metrics endpoint on a FastAPI app.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ app
+ |
+
+ FastAPI
+ |
+
+
+
+ FastAPI application instance. + |
+ + required + | +
+ registry
+ |
+
+ MetricsRegistry
+ |
+
+
+
+ A :class: |
+ + required + | +
+ path
+ |
+
+ str
+ |
+
+
+
+ URL path for the metrics endpoint (default |
+
+ '/metrics'
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ FastAPI
+ |
+
+
+
+ The same FastAPI instance (for chaining). + |
+
models¶Here's the reference for the SQLAlchemy model mixins provided by the models module.
You can import them directly from fastapi_toolsets.models:
from fastapi_toolsets.models import (
+ UUIDMixin,
+ CreatedAtMixin,
+ UpdatedAtMixin,
+ TimestampMixin,
+)
+fastapi_toolsets.models.UUIDMixin
+
+
+¶Mixin that adds a UUID primary key auto-generated by the database.
+ + + + + + + + + + + +fastapi_toolsets.models.CreatedAtMixin
+
+
+¶Mixin that adds a created_at timestamp column.
fastapi_toolsets.models.UpdatedAtMixin
+
+
+¶Mixin that adds an updated_at timestamp column.
fastapi_toolsets.models.TimestampMixin
+
+
+¶
+ Bases: CreatedAtMixin, UpdatedAtMixin
Mixin that combines created_at and updated_at timestamp columns.
pytest¶Here's the reference for all testing utilities and pytest fixtures.
+You can import them directly from fastapi_toolsets.pytest:
from fastapi_toolsets.pytest import (
+ register_fixtures,
+ create_async_client,
+ create_db_session,
+ worker_database_url,
+ create_worker_database,
+ cleanup_tables,
+)
+fastapi_toolsets.pytest.plugin.register_fixtures(registry, namespace, *, prefix='fixture_', session_fixture='db_session', strategy=LoadStrategy.MERGE)
+
+¶Register pytest fixtures from a FixtureRegistry.
+Automatically creates pytest fixtures for each fixture in the registry. +Dependencies are resolved via pytest fixture dependencies.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ registry
+ |
+
+ FixtureRegistry
+ |
+
+
+
+ The FixtureRegistry containing fixtures + |
+ + required + | +
+ namespace
+ |
+
+ dict[str, Any]
+ |
+
+
+
+ The module's globals() dict to add fixtures to + |
+ + required + | +
+ prefix
+ |
+
+ str
+ |
+
+
+
+ Prefix for generated fixture names (default: "fixture_") + |
+
+ 'fixture_'
+ |
+
+ session_fixture
+ |
+
+ str
+ |
+
+
+
+ Name of the db session fixture (default: "db_session") + |
+
+ 'db_session'
+ |
+
+ strategy
+ |
+
+ LoadStrategy
+ |
+
+
+
+ Loading strategy for fixtures (default: MERGE) + |
+
+ MERGE
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ list[str]
+ |
+
+
+
+ List of created fixture names + |
+
# conftest.py
+from app.fixtures import fixtures
+from fastapi_toolsets.pytest_plugin import register_fixtures
+
+register_fixtures(fixtures, globals())
+
+# Creates fixtures like:
+# - fixture_roles
+# - fixture_users (depends on fixture_roles if users depends on roles)
+# - fixture_posts (depends on fixture_users if posts depends on users)
+fastapi_toolsets.pytest.utils.create_async_client(app, base_url='http://test', dependency_overrides=None)
+
+
+ async
+
+
+¶Create an async httpx client for testing FastAPI applications.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ app
+ |
+
+ Any
+ |
+
+
+
+ FastAPI application instance. + |
+ + required + | +
+ base_url
+ |
+
+ str
+ |
+
+
+
+ Base URL for requests. Defaults to "http://test". + |
+
+ 'http://test'
+ |
+
+ dependency_overrides
+ |
+
+ dict[Callable[..., Any], Callable[..., Any]] | None
+ |
+
+
+
+ Optional mapping of original dependencies to
+their test replacements. Applied via |
+
+ None
+ |
+
Yields:
+| Type | +Description | +
|---|---|
+ AsyncGenerator[AsyncClient, None]
+ |
+
+
+
+ An AsyncClient configured for the app. + |
+
from fastapi import FastAPI
+from fastapi_toolsets.pytest import create_async_client
+
+app = FastAPI()
+
+@pytest.fixture
+async def client():
+ async with create_async_client(app) as c:
+ yield c
+
+async def test_endpoint(client: AsyncClient):
+ response = await client.get("/health")
+ assert response.status_code == 200
+from fastapi_toolsets.pytest import create_async_client, create_db_session
+from app.db import get_db
+
+@pytest.fixture
+async def db_session():
+ async with create_db_session(DATABASE_URL, Base, cleanup=True) as session:
+ yield session
+
+@pytest.fixture
+async def client(db_session):
+ async def override():
+ yield db_session
+
+ async with create_async_client(
+ app, dependency_overrides={get_db: override}
+ ) as c:
+ yield c
+fastapi_toolsets.pytest.utils.create_db_session(database_url, base, *, echo=False, expire_on_commit=False, drop_tables=True, cleanup=False)
+
+
+ async
+
+
+¶Create a database session for testing.
+Creates tables before yielding the session and optionally drops them after. +Each call creates a fresh engine and session for test isolation.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ database_url
+ |
+
+ str
+ |
+
+
+
+ Database connection URL (e.g., "postgresql+asyncpg://..."). + |
+ + required + | +
+ base
+ |
+
+ type[DeclarativeBase]
+ |
+
+
+
+ SQLAlchemy DeclarativeBase class containing model metadata. + |
+ + required + | +
+ echo
+ |
+
+ bool
+ |
+
+
+
+ Enable SQLAlchemy query logging. Defaults to False. + |
+
+ False
+ |
+
+ expire_on_commit
+ |
+
+ bool
+ |
+
+
+
+ Expire objects after commit. Defaults to False. + |
+
+ False
+ |
+
+ drop_tables
+ |
+
+ bool
+ |
+
+
+
+ Drop tables after test. Defaults to True. + |
+
+ True
+ |
+
+ cleanup
+ |
+
+ bool
+ |
+
+
+
+ Truncate all tables after test using
+:func: |
+
+ False
+ |
+
Yields:
+| Type | +Description | +
|---|---|
+ AsyncGenerator[AsyncSession, None]
+ |
+
+
+
+ An AsyncSession ready for database operations. + |
+
from fastapi_toolsets.pytest import create_db_session
+from app.models import Base
+
+DATABASE_URL = "postgresql+asyncpg://user:pass@localhost/test_db"
+
+@pytest.fixture
+async def db_session():
+ async with create_db_session(
+ DATABASE_URL, Base, cleanup=True
+ ) as session:
+ yield session
+
+async def test_create_user(db_session: AsyncSession):
+ user = User(name="test")
+ db_session.add(user)
+ await db_session.commit()
+fastapi_toolsets.pytest.utils.worker_database_url(database_url, default_test_db)
+
+¶Derive a per-worker database URL for pytest-xdist parallel runs.
+Appends _{worker_name} to the database name so each xdist worker
+operates on its own database. When not running under xdist,
+_{default_test_db} is appended instead.
The worker name is read from the PYTEST_XDIST_WORKER environment
+variable (set automatically by xdist in each worker process).
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ database_url
+ |
+
+ str
+ |
+
+
+
+ Original database connection URL. + |
+ + required + | +
+ default_test_db
+ |
+
+ str
+ |
+
+
+
+ Suffix appended to the database name when
+ |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ str
+ |
+
+
+
+ A database URL with a worker- or default-specific database name. + |
+
fastapi_toolsets.pytest.utils.create_worker_database(database_url, default_test_db='test_db')
+
+
+ async
+
+
+¶Create and drop a per-worker database for pytest-xdist isolation.
+Derives a worker-specific database URL using :func:worker_database_url,
+then delegates to :func:~fastapi_toolsets.db.create_database to create
+and drop it. Intended for use as a session-scoped fixture.
When running under xdist the database name is suffixed with the worker
+name (e.g. _gw0). Otherwise it is suffixed with default_test_db.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ database_url
+ |
+
+ str
+ |
+
+
+
+ Original database connection URL (used as the server +connection and as the base for the worker database name). + |
+ + required + | +
+ default_test_db
+ |
+
+ str
+ |
+
+
+
+ Suffix appended to the database name when
+ |
+
+ 'test_db'
+ |
+
Yields:
+| Type | +Description | +
|---|---|
+ AsyncGenerator[str, None]
+ |
+
+
+
+ The worker-specific database URL. + |
+
from fastapi_toolsets.pytest import create_worker_database, create_db_session
+
+DATABASE_URL = "postgresql+asyncpg://postgres:postgres@localhost/test_db"
+
+@pytest.fixture(scope="session")
+async def worker_db_url():
+ async with create_worker_database(DATABASE_URL) as url:
+ yield url
+
+@pytest.fixture
+async def db_session(worker_db_url):
+ async with create_db_session(
+ worker_db_url, Base, cleanup=True
+ ) as session:
+ yield session
+schemas¶Here's the reference for all response models and types provided by the schemas module.
You can import them directly from fastapi_toolsets.schemas:
from fastapi_toolsets.schemas import (
+ PydanticBase,
+ ResponseStatus,
+ ApiError,
+ BaseResponse,
+ Response,
+ ErrorResponse,
+ OffsetPagination,
+ CursorPagination,
+ PaginatedResponse,
+)
+fastapi_toolsets.schemas.PydanticBase
+
+
+¶
+ Bases: BaseModel
Base class for all Pydantic models with common configuration.
+ + + + + + + + + + + +fastapi_toolsets.schemas.ResponseStatus
+
+
+¶fastapi_toolsets.schemas.ApiError
+
+
+¶
+ Bases: PydanticBase
Structured API error definition.
+Used to define standard error responses with consistent format.
+ + +Attributes:
+| Name | +Type | +Description | +
|---|---|---|
code |
+
+ int
+ |
+
+
+
+ HTTP status code + |
+
msg |
+
+ str
+ |
+
+
+
+ Short error message + |
+
desc |
+
+ str
+ |
+
+
+
+ Detailed error description + |
+
err_code |
+
+ str
+ |
+
+
+
+ Application-specific error code (e.g., "AUTH-401") + |
+
fastapi_toolsets.schemas.BaseResponse
+
+
+¶
+ Bases: PydanticBase
Base response structure for all API responses.
+ + +Attributes:
+| Name | +Type | +Description | +
|---|---|---|
status |
+
+ ResponseStatus
+ |
+
+
+
+ SUCCESS or FAIL + |
+
message |
+
+ str
+ |
+
+
+
+ Human-readable message + |
+
error_code |
+
+ str | None
+ |
+
+
+
+ Error code if status is FAIL, None otherwise + |
+
fastapi_toolsets.schemas.Response
+
+
+¶
+ Bases: BaseResponse, Generic[DataT]
Generic API response with data payload.
+ + + + + + + + + + + + + +fastapi_toolsets.schemas.ErrorResponse
+
+
+¶
+ Bases: BaseResponse
Error response with additional description field.
+Used for error responses that need more context.
+ + + + + + + + + + + +fastapi_toolsets.schemas.OffsetPagination
+
+
+¶
+ Bases: PydanticBase
Pagination metadata for offset-based list responses.
+ + +Attributes:
+| Name | +Type | +Description | +
|---|---|---|
total_count |
+
+ int
+ |
+
+
+
+ Total number of items across all pages + |
+
items_per_page |
+
+ int
+ |
+
+
+
+ Number of items per page + |
+
page |
+
+ int
+ |
+
+
+
+ Current page number (1-indexed) + |
+
has_more |
+
+ bool
+ |
+
+
+
+ Whether there are more pages + |
+
fastapi_toolsets.schemas.CursorPagination
+
+
+¶
+ Bases: PydanticBase
Pagination metadata for cursor-based list responses.
+ + +Attributes:
+| Name | +Type | +Description | +
|---|---|---|
next_cursor |
+
+ str | None
+ |
+
+
+
+ Encoded cursor for the next page, or None on the last page. + |
+
prev_cursor |
+
+ str | None
+ |
+
+
+
+ Encoded cursor for the previous page, or None on the first page. + |
+
items_per_page |
+
+ int
+ |
+
+
+
+ Number of items requested per page. + |
+
has_more |
+
+ bool
+ |
+
+
+
+ Whether there is at least one more page after this one. + |
+
fastapi_toolsets.schemas.PaginatedResponse
+
+
+¶
+ Bases: BaseResponse, Generic[DataT]
Paginated API response for list endpoints.
+ + + + + + + + + + + +A modular collection of production-ready utilities for FastAPI. Install only what you need — from async CRUD and database helpers to CLI tooling, Prometheus metrics, and pytest fixtures. Each module is independently installable via optional extras, keeping your dependency footprint minimal.
Documentation: https://fastapi-toolsets.d3vyce.fr
Source Code: https://github.com/d3vyce/fastapi-toolsets
","path":["FastAPI Toolsets"],"tags":[]},{"location":"#installation","level":2,"title":"Installation","text":"The base package includes the core modules (CRUD, database, schemas, exceptions, fixtures, dependencies, model mixins, logging):
uv add fastapi-toolsets\nInstall only the extras you need:
uv add \"fastapi-toolsets[cli]\"\nuv add \"fastapi-toolsets[metrics]\"\nuv add \"fastapi-toolsets[pytest]\"\nOr install everything:
uv add \"fastapi-toolsets[all]\"\nCrudFactory, built-in full-text/faceted search and Offset/Cursor pagination.PathDependency, BodyDependency) for automatic DB lookups from path or body parametersUUIDMixin, CreatedAtMixin, UpdatedAtMixin, TimestampMixin)Response, PaginatedResponse, and PydanticBaseconfigure_logging and get_loggerpytest-xdist support, and table cleanup utilitiesMIT License - see LICENSE for details.
","path":["FastAPI Toolsets"],"tags":[]},{"location":"#contributing","level":2,"title":"Contributing","text":"Contributions are welcome! Please feel free to submit issues and pull requests.
","path":["FastAPI Toolsets"],"tags":[]},{"location":"examples/pagination-search/","level":1,"title":"Pagination & search","text":"This example builds an articles listing endpoint that supports offset pagination, cursor pagination, full-text search, faceted filtering, and sorting — all from a single CrudFactory definition.
import uuid\n\nfrom sqlalchemy import Boolean, ForeignKey, String, Text\nfrom sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship\n\nfrom fastapi_toolsets.models import CreatedAtMixin\n\n\nclass Base(DeclarativeBase):\n pass\n\n\nclass Category(Base):\n __tablename__ = \"categories\"\n\n id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4)\n name: Mapped[str] = mapped_column(String(64), unique=True)\n\n articles: Mapped[list[\"Article\"]] = relationship(back_populates=\"category\")\n\n\nclass Article(Base, CreatedAtMixin):\n __tablename__ = \"articles\"\n\n id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4)\n title: Mapped[str] = mapped_column(String(256))\n body: Mapped[str] = mapped_column(Text)\n status: Mapped[str] = mapped_column(String(32))\n published: Mapped[bool] = mapped_column(Boolean, default=False)\n category_id: Mapped[uuid.UUID | None] = mapped_column(\n ForeignKey(\"categories.id\"), nullable=True\n )\n\n category: Mapped[\"Category | None\"] = relationship(back_populates=\"articles\")\nimport datetime\nimport uuid\n\nfrom fastapi_toolsets.schemas import PydanticBase\n\n\nclass ArticleRead(PydanticBase):\n id: uuid.UUID\n created_at: datetime.datetime\n title: str\n status: str\n published: bool\n category_id: uuid.UUID | None\nDeclare searchable_fields, facet_fields, and order_fields once on CrudFactory. All endpoints built from this class share the same defaults and can override them per call.
from fastapi_toolsets.crud import CrudFactory\n\nfrom .models import Article, Category\n\nArticleCrud = CrudFactory(\n model=Article,\n cursor_column=Article.created_at,\n searchable_fields=[ # default fields for full-text search\n Article.title,\n Article.body,\n (Article.category, Category.name),\n ],\n facet_fields=[ # fields exposed as filter dropdowns\n Article.status,\n (Article.category, Category.name),\n ],\n order_fields=[ # fields exposed for client-driven ordering\n Article.title,\n Article.created_at,\n ],\n)\nfrom typing import Annotated\n\nfrom fastapi import Depends\nfrom sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine\n\nfrom fastapi_toolsets.db import create_db_context, create_db_dependency\n\nDATABASE_URL = \"postgresql+asyncpg://postgres:postgres@localhost:5432/postgres\"\n\nengine = create_async_engine(url=DATABASE_URL, future=True)\nasync_session_maker = async_sessionmaker(bind=engine, expire_on_commit=False)\n\nget_db = create_db_dependency(session_maker=async_session_maker)\nget_db_context = create_db_context(session_maker=async_session_maker)\n\n\nSessionDep = Annotated[AsyncSession, Depends(get_db)]\nDeploy a Postgres DB with docker
docker run -d --name postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=postgres -p 5432:5432 postgres:18-alpine\nfrom fastapi import FastAPI\n\nfrom fastapi_toolsets.exceptions import init_exceptions_handlers\n\nfrom .routes import router\n\napp = FastAPI()\ninit_exceptions_handlers(app=app)\napp.include_router(router=router)\nBest for admin panels or any UI that needs a total item count and numbered pages.
routes.py:1:36from typing import Annotated\n\nfrom fastapi import APIRouter, Depends\n\nfrom fastapi_toolsets.crud import OrderByClause\nfrom fastapi_toolsets.schemas import (\n CursorPaginatedResponse,\n OffsetPaginatedResponse,\n PaginatedResponse,\n)\n\nfrom .crud import ArticleCrud\nfrom .db import SessionDep\nfrom .models import Article\nfrom .schemas import ArticleRead\n\nrouter = APIRouter(prefix=\"/articles\")\n\n\n@router.get(\"/offset\")\nasync def list_articles_offset(\n session: SessionDep,\n params: Annotated[\n dict,\n Depends(ArticleCrud.offset_params(default_page_size=20, max_page_size=100)),\n ],\n filter_by: Annotated[dict[str, list[str]], Depends(ArticleCrud.filter_params())],\n order_by: Annotated[\n OrderByClause | None,\n Depends(ArticleCrud.order_params(default_field=Article.created_at)),\n ],\n search: str | None = None,\n) -> OffsetPaginatedResponse[ArticleRead]:\n return await ArticleCrud.offset_paginate(\n session=session,\n **params,\nExample request
GET /articles/offset?page=2&items_per_page=10&search=fastapi&status=published&order_by=title&order=asc\nExample response
{\n \"status\": \"SUCCESS\",\n \"data\": [\n { \"id\": \"3f47ac69-...\", \"title\": \"FastAPI tips\", \"status\": \"published\", ... }\n ],\n \"pagination\": {\n \"total_count\": 42,\n \"page\": 2,\n \"items_per_page\": 10,\n \"has_more\": true\n },\n \"filter_attributes\": {\n \"status\": [\"archived\", \"draft\", \"published\"],\n \"name\": [\"backend\", \"frontend\", \"python\"]\n }\n}\nfilter_attributes always reflects the values visible after applying the active filters. Use it to populate filter dropdowns on the client.
Best for feeds, infinite scroll, or any high-throughput API where offset performance degrades.
routes.py:39:59 order_by=order_by,\n schema=ArticleRead,\n )\n\n\n@router.get(\"/cursor\")\nasync def list_articles_cursor(\n session: SessionDep,\n params: Annotated[\n dict,\n Depends(ArticleCrud.cursor_params(default_page_size=20, max_page_size=100)),\n ],\n filter_by: Annotated[dict[str, list[str]], Depends(ArticleCrud.filter_params())],\n order_by: Annotated[\n OrderByClause | None,\n Depends(ArticleCrud.order_params(default_field=Article.created_at)),\n ],\n search: str | None = None,\n) -> CursorPaginatedResponse[ArticleRead]:\n return await ArticleCrud.cursor_paginate(\n session=session,\nExample request
GET /articles/cursor?items_per_page=10&status=published&order_by=created_at&order=desc\nExample response
{\n \"status\": \"SUCCESS\",\n \"data\": [\n { \"id\": \"3f47ac69-...\", \"title\": \"FastAPI tips\", \"status\": \"published\", ... }\n ],\n \"pagination\": {\n \"next_cursor\": \"eyJ2YWx1ZSI6ICIzZjQ3YWM2OS0uLi4ifQ==\",\n \"prev_cursor\": null,\n \"items_per_page\": 10,\n \"has_more\": true\n },\n \"filter_attributes\": {\n \"status\": [\"published\"],\n \"name\": [\"backend\", \"python\"]\n }\n}\nPass next_cursor as the cursor query parameter on the next request to advance to the next page.
Both endpoints inherit the same searchable_fields declared on ArticleCrud:
Search is case-insensitive and uses a LIKE %query% pattern. Pass a SearchConfig instead of a plain string to control case sensitivity or switch to match_mode=\"all\" (AND across all fields instead of OR).
from fastapi_toolsets.crud import SearchConfig\n\n# Both title AND body must contain \"fastapi\"\nresult = await ArticleCrud.offset_paginate(\n session,\n search=SearchConfig(query=\"fastapi\", case_sensitive=True, match_mode=\"all\"),\n search_fields=[Article.title, Article.body],\n)\nThis page covers every breaking change introduced in v2.0 and the steps required to update your code.
","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#crud","level":2,"title":"CRUD","text":"","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#schema-is-now-required-in-offset_paginate-and-cursor_paginate","level":3,"title":"schema is now required in offset_paginate() and cursor_paginate()","text":"Calls that omit schema will now raise a TypeError at runtime.
Previously schema was optional; omitting it returned raw SQLAlchemy model instances inside the response. It is now a required keyword argument and the response always contains serialized schema instances.
v1)Now (v2) # schema omitted — returned raw model instances\nresult = await UserCrud.offset_paginate(session=session, page=1)\nresult = await UserCrud.cursor_paginate(session=session, cursor=token)\nresult = await UserCrud.offset_paginate(session=session, page=1, schema=UserRead)\nresult = await UserCrud.cursor_paginate(session=session, cursor=token, schema=UserRead)\nas_response removed from create(), get(), and update()","text":"Passing as_response to these methods will raise a TypeError at runtime.
The as_response=True shorthand is replaced by passing a schema directly. The return value is a Response[schema] when schema is provided, or the raw model instance when it is not.
v1)Now (v2) user = await UserCrud.create(session=session, obj=data, as_response=True)\nuser = await UserCrud.get(session=session, filters=filters, as_response=True)\nuser = await UserCrud.update(session=session, obj=data, filters, as_response=True)\nuser = await UserCrud.create(session=session, obj=data, schema=UserRead)\nuser = await UserCrud.get(session=session, filters=filters, schema=UserRead)\nuser = await UserCrud.update(session=session, obj=data, filters, schema=UserRead)\ndelete(): as_response renamed and return type changed","text":"as_response is gone, and the plain (non-response) call no longer returns True.
Two changes were made to delete():
as_response parameter is renamed to return_response.return_response=True, the method now returns None on success instead of True.v1)Now (v2) ok = await UserCrud.delete(session=session, filters=filters)\nif ok: # True on success\n ...\n\nresponse = await UserCrud.delete(session=session, filters=filters, as_response=True)\nawait UserCrud.delete(session=session, filters=filters) # returns None\n\nresponse = await UserCrud.delete(session=session, filters=filters, return_response=True)\npaginate() alias removed","text":"Any call to crud.paginate(...) will raise AttributeError at runtime.
The paginate shorthand was an alias for offset_paginate. It has been removed; call offset_paginate directly.
v1)Now (v2) result = await UserCrud.paginate(session=session, page=2, items_per_page=20, schema=UserRead)\nresult = await UserCrud.offset_paginate(session=session, page=2, items_per_page=20, schema=UserRead)\napi_error raises TypeError at class definition time","text":"Unfinished or stub exception subclasses that previously compiled fine will now fail on import.
In v1, a subclass without api_error would only fail when the exception was raised. In v2, __init_subclass__ validates this at class definition time.
v1)Now (v2) class MyError(ApiException):\n pass # fine until raised\nclass MyError(ApiException):\n pass # TypeError: MyError must define an 'api_error' class attribute.\nFor shared base classes that are not meant to be raised directly, use abstract=True:
class BillingError(ApiException, abstract=True):\n \"\"\"Base for all billing-related errors — not raised directly.\"\"\"\n\nclass PaymentRequiredError(BillingError):\n api_error = ApiError(code=402, msg=\"Payment Required\", desc=\"...\", err_code=\"BILLING-402\")\nPagination alias removed","text":"Pagination was already deprecated in v1 and is fully removed in v2, you now need to use OffsetPagination or CursorPagination.
Typer-based command-line interface for managing your FastAPI application, with built-in fixture commands integration.
","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#installation","level":2,"title":"Installation","text":"uvpipuv add \"fastapi-toolsets[cli]\"\npip install \"fastapi-toolsets[cli]\"\nThe cli module provides a manager entry point built with Typer. It allow custom commands to be added in addition of the fixture commands when a FixtureRegistry and a database context are configured.
Configure the CLI in your pyproject.toml:
[tool.fastapi-toolsets]\ncli = \"myapp.cli:cli\" # Custom Typer app\nfixtures = \"myapp.fixtures:registry\" # FixtureRegistry instance\ndb_context = \"myapp.db:db_context\" # Async context manager for sessions\nAll fields are optional. Without configuration, the manager command still works but no command are available.
# Manager commands\nmanager --help\n\n Usage: manager [OPTIONS] COMMAND [ARGS]...\n\n FastAPI utilities CLI.\n\n╭─ Options ────────────────────────────────────────────────────────────────────────╮\n│ --install-completion Install completion for the current shell. │\n│ --show-completion Show completion for the current shell, to copy it │\n│ or customize the installation. │\n│ --help Show this message and exit. │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n╭─ Commands ───────────────────────────────────────────────────────────────────────╮\n│ check-db │\n│ fixtures Manage database fixtures. │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n\n# Fixtures commands\nmanager fixtures --help\n\n Usage: manager fixtures [OPTIONS] COMMAND [ARGS]...\n\n Manage database fixtures.\n\n╭─ Options ────────────────────────────────────────────────────────────────────────╮\n│ --help Show this message and exit. │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n╭─ Commands ───────────────────────────────────────────────────────────────────────╮\n│ list List all registered fixtures. │\n│ load Load fixtures into the database. │\n╰──────────────────────────────────────────────────────────────────────────────────╯\nYou can extend the CLI by providing your own Typer app. The manager entry point will merge your app's commands with the built-in ones:
# myapp/cli.py\nimport typer\n\ncli = typer.Typer()\n\n@cli.command()\ndef hello():\n print(\"Hello from my app!\")\n[tool.fastapi-toolsets]\ncli = \"myapp.cli:cli\"\nAPI Reference
","path":["Modules","CLI"],"tags":[]},{"location":"module/crud/","level":1,"title":"CRUD","text":"Generic async CRUD operations for SQLAlchemy models with search, pagination, and many-to-many support.
Info
This module has been coded and tested to be compatible with PostgreSQL only.
","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#overview","level":2,"title":"Overview","text":"The crud module provides AsyncCrud, an abstract base class with a full suite of async database operations, and CrudFactory, a convenience function to instantiate it for a given model.
from fastapi_toolsets.crud import CrudFactory\nfrom myapp.models import User\n\nUserCrud = CrudFactory(model=User)\nCrudFactory dynamically creates a class named AsyncUserCrud with User as its model.
get_or_none added in v2.2
# Create\nuser = await UserCrud.create(session=session, obj=UserCreateSchema(username=\"alice\"))\n\n# Get one (raises NotFoundError if not found)\nuser = await UserCrud.get(session=session, filters=[User.id == user_id])\n\n# Get one or None (never raises)\nuser = await UserCrud.get_or_none(session=session, filters=[User.id == user_id])\n\n# Get first or None\nuser = await UserCrud.first(session=session, filters=[User.email == email])\n\n# Get multiple\nusers = await UserCrud.get_multi(session=session, filters=[User.is_active == True])\n\n# Update\nuser = await UserCrud.update(session=session, obj=UserUpdateSchema(username=\"bob\"), filters=[User.id == user_id])\n\n# Delete\nawait UserCrud.delete(session=session, filters=[User.id == user_id])\n\n# Count / exists\ncount = await UserCrud.count(session=session, filters=[User.is_active == True])\nexists = await UserCrud.exists(session=session, filters=[User.email == email])\nThree methods fetch a single record — choose based on how you want to handle the \"not found\" case and whether you need strict uniqueness:
Method Not found Multiple resultsget raises NotFoundError raises MultipleResultsFound get_or_none returns None raises MultipleResultsFound first returns None returns the first match silently Use get when the record must exist (e.g. a detail endpoint that should return 404):
user = await UserCrud.get(session=session, filters=[User.id == user_id])\nUse get_or_none when the record may not exist but you still want strict uniqueness enforcement:
user = await UserCrud.get_or_none(session=session, filters=[User.email == email])\nif user is None:\n ... # handle missing case without catching an exception\nUse first when you only care about any one match and don't need uniqueness:
user = await UserCrud.first(session=session, filters=[User.is_active == True])\nAdded in v1.1 (only offset_pagination via paginate if <v1.1)
Two pagination strategies are available. Both return a PaginatedResponse but differ in how they navigate through results.
offset_paginate cursor_paginate Total count Yes No Jump to arbitrary page Yes No Performance on deep pages Degrades Constant Stable under concurrent inserts No Yes Search compatible Yes Yes Use case Admin panels, numbered pagination Feeds, APIs, infinite scroll","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#offset-pagination","level":3,"title":"Offset pagination","text":"@router.get(\n \"\",\n response_model=PaginatedResponse[User],\n)\nasync def get_users(\n session: SessionDep,\n items_per_page: int = 50,\n page: int = 1,\n):\n return await crud.UserCrud.offset_paginate(\n session=session,\n items_per_page=items_per_page,\n page=page,\n )\nThe offset_paginate method returns a PaginatedResponse whose pagination field is an OffsetPagination object:
{\n \"status\": \"SUCCESS\",\n \"data\": [\"...\"],\n \"pagination\": {\n \"total_count\": 100,\n \"page\": 1,\n \"items_per_page\": 20,\n \"has_more\": true\n }\n}\n@router.get(\n \"\",\n response_model=PaginatedResponse[UserRead],\n)\nasync def list_users(\n session: SessionDep,\n cursor: str | None = None,\n items_per_page: int = 20,\n):\n return await UserCrud.cursor_paginate(\n session=session,\n cursor=cursor,\n items_per_page=items_per_page,\n )\nThe cursor_paginate method returns a PaginatedResponse whose pagination field is a CursorPagination object:
{\n \"status\": \"SUCCESS\",\n \"data\": [\"...\"],\n \"pagination\": {\n \"next_cursor\": \"eyJ2YWx1ZSI6ICIzZjQ3YWM2OS0uLi4ifQ==\",\n \"prev_cursor\": null,\n \"items_per_page\": 20,\n \"has_more\": true\n }\n}\nPass next_cursor as the cursor query parameter on the next request to advance to the next page. prev_cursor is set on pages 2+ and points back to the first item of the current page. Both are null when there is no adjacent page.
The cursor column is set once on CrudFactory via the cursor_column parameter. It must be monotonically ordered for stable results:
Warning
Random UUID v4 PKs are not suitable as cursor columns because their ordering is non-deterministic.
Note
cursor_column is required. Calling cursor_paginate on a CRUD class that has no cursor_column configured raises a ValueError.
The cursor value is base64-encoded when returned to the client and decoded back to the correct Python type on the next request. The following SQLAlchemy column types are supported:
SQLAlchemy type Python typeInteger, BigInteger, SmallInteger int Uuid uuid.UUID DateTime datetime.datetime Date datetime.date Float, Numeric decimal.Decimal # Paginate by the primary key\nPostCrud = CrudFactory(model=Post, cursor_column=Post.id)\n\n# Paginate by a timestamp column instead\nPostCrud = CrudFactory(model=Post, cursor_column=Post.created_at)\nTwo search strategies are available, both compatible with offset_paginate and cursor_paginate.
You can use both search strategies in the same endpoint!
","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#full-text-search","level":3,"title":"Full-text search","text":"Added in v2.2.1
The model's primary key is always included in searchable_fields automatically, so searching by ID works out of the box without any configuration. When no searchable_fields are declared, only the primary key is searched.
Declare searchable_fields on the CRUD class. Relationship traversal is supported via tuples:
PostCrud = CrudFactory(\n model=Post,\n searchable_fields=[\n Post.title,\n Post.content,\n (Post.author, User.username), # search across relationship\n ],\n)\nYou can override searchable_fields per call with search_fields:
result = await UserCrud.offset_paginate(\n session=session,\n search_fields=[User.country],\n)\nThis allows searching with both offset_paginate and cursor_paginate:
@router.get(\n \"\",\n response_model=PaginatedResponse[User],\n)\nasync def get_users(\n session: SessionDep,\n items_per_page: int = 50,\n page: int = 1,\n search: str | None = None,\n):\n return await crud.UserCrud.offset_paginate(\n session=session,\n items_per_page=items_per_page,\n page=page,\n search=search,\n )\n@router.get(\n \"\",\n response_model=PaginatedResponse[User],\n)\nasync def get_users(\n session: SessionDep,\n cursor: str | None = None,\n items_per_page: int = 50,\n search: str | None = None,\n):\n return await crud.UserCrud.cursor_paginate(\n session=session,\n items_per_page=items_per_page,\n cursor=cursor,\n search=search,\n )\nAdded in v1.2
Declare facet_fields on the CRUD class to return distinct column values alongside paginated results. This is useful for populating filter dropdowns or building faceted search UIs.
Facet fields use the same syntax as searchable_fields — direct columns or relationship tuples:
UserCrud = CrudFactory(\n model=User,\n facet_fields=[\n User.status,\n User.country,\n (User.role, Role.name), # value from a related model\n ],\n)\nYou can override facet_fields per call:
result = await UserCrud.offset_paginate(\n session=session,\n facet_fields=[User.country],\n)\nThe distinct values are returned in the filter_attributes field of PaginatedResponse:
{\n \"status\": \"SUCCESS\",\n \"data\": [\"...\"],\n \"pagination\": { \"...\" },\n \"filter_attributes\": {\n \"status\": [\"active\", \"inactive\"],\n \"country\": [\"DE\", \"FR\", \"US\"],\n \"name\": [\"admin\", \"editor\", \"viewer\"]\n }\n}\nUse filter_by to pass the client's chosen filter values directly — no need to build SQLAlchemy conditions by hand. Any unknown key raises InvalidFacetFilterError.
The keys in filter_by are the same keys the client received in filter_attributes.
Keys are normally the terminal column.key (e.g. \"name\" for Role.name). When two facet fields share the same column key (e.g. (Build.project, Project.name) and (Build.os, Os.name)), the relationship name is prepended automatically: \"project__name\" and \"os__name\".
filter_by and filters can be combined — both are applied with AND logic.
Use filter_params() to generate a dict with the facet filter values from the query parameters:
from typing import Annotated\n\nfrom fastapi import Depends\n\nUserCrud = CrudFactory(\n model=User,\n facet_fields=[User.status, User.country, (User.role, Role.name)],\n)\n\n@router.get(\"\", response_model_exclude_none=True)\nasync def list_users(\n session: SessionDep,\n page: int = 1,\n filter_by: Annotated[dict[str, list[str]], Depends(UserCrud.filter_params())],\n) -> PaginatedResponse[UserRead]:\n return await UserCrud.offset_paginate(\n session=session,\n page=page,\n filter_by=filter_by,\n )\nBoth single-value and multi-value query parameters work:
GET /users?status=active → filter_by={\"status\": [\"active\"]}\nGET /users?status=active&country=FR → filter_by={\"status\": [\"active\"], \"country\": [\"FR\"]}\nGET /users?role=admin&role=editor → filter_by={\"role\": [\"admin\", \"editor\"]} (IN clause)\nAdded in v1.3
Declare order_fields on the CRUD class to expose client-driven column ordering via order_by and order query parameters.
UserCrud = CrudFactory(\n model=User,\n order_fields=[\n User.name,\n User.created_at,\n ],\n)\nCall order_params() to generate a FastAPI dependency that maps the query parameters to an OrderByClause expression:
from typing import Annotated\n\nfrom fastapi import Depends\nfrom fastapi_toolsets.crud import OrderByClause\n\n@router.get(\"\")\nasync def list_users(\n session: SessionDep,\n order_by: Annotated[OrderByClause | None, Depends(UserCrud.order_params())],\n) -> PaginatedResponse[UserRead]:\n return await UserCrud.offset_paginate(session=session, order_by=order_by)\nThe dependency adds two query parameters to the endpoint:
Parameter Typeorder_by str | null order asc or desc GET /users?order_by=name&order=asc → ORDER BY users.name ASC\nGET /users?order_by=name&order=desc → ORDER BY users.name DESC\nAn unknown order_by value raises InvalidOrderFieldError (HTTP 422).
You can also pass order_fields directly to order_params() to override the class-level defaults without modifying them:
UserOrderParams = UserCrud.order_params(order_fields=[User.name])\nAdded in v1.1
By default, SQLAlchemy relationships are not loaded unless explicitly requested. Instead of using lazy=\"selectin\" on model definitions (which is implicit and applies globally), define a default_load_options on the CRUD class to control loading strategy explicitly.
Warning
Avoid using lazy=\"selectin\" on model relationships. It fires silently on every query, cannot be disabled per-call, and can cause unexpected cascading loads through deep relationship chains. Use default_load_options instead.
from sqlalchemy.orm import selectinload\n\nArticleCrud = CrudFactory(\n model=Article,\n default_load_options=[\n selectinload(Article.category),\n selectinload(Article.tags),\n ],\n)\ndefault_load_options applies automatically to all read operations (get, first, get_multi, offset_paginate, cursor_paginate). When load_options is passed at call-site, it fully replaces default_load_options for that query — giving you precise per-call control:
# Only loads category, tags are not loaded\narticle = await ArticleCrud.get(\n session=session,\n filters=[Article.id == article_id],\n load_options=[selectinload(Article.category)],\n)\n\n# Loads nothing — useful for write-then-refresh flows or lightweight checks\narticles = await ArticleCrud.get_multi(session=session, load_options=[])\nUse m2m_fields to map schema fields containing lists of IDs to SQLAlchemy relationships. The CRUD class resolves and validates all IDs before persisting:
PostCrud = CrudFactory(\n model=Post,\n m2m_fields={\"tag_ids\": Post.tags},\n)\n\npost = await PostCrud.create(session=session, obj=PostCreateSchema(title=\"Hello\", tag_ids=[1, 2, 3]))\nAtomic INSERT ... ON CONFLICT DO UPDATE using PostgreSQL:
await UserCrud.upsert(\n session=session,\n obj=UserCreateSchema(email=\"alice@example.com\", username=\"alice\"),\n index_elements=[User.email],\n set_={\"username\"},\n)\nAdded in v1.1
Pass a Pydantic schema class to create, get, update, or offset_paginate to serialize the result directly into that schema and wrap it in a Response[schema] or PaginatedResponse[schema]:
class UserRead(PydanticBase):\n id: UUID\n username: str\n\n@router.get(\n \"/{uuid}\",\n responses=generate_error_responses(NotFoundError),\n)\nasync def get_user(session: SessionDep, uuid: UUID) -> Response[UserRead]:\n return await crud.UserCrud.get(\n session=session,\n filters=[User.id == uuid],\n schema=UserRead,\n )\n\n@router.get(\"\")\nasync def list_users(session: SessionDep, page: int = 1) -> PaginatedResponse[UserRead]:\n return await crud.UserCrud.offset_paginate(\n session=session,\n page=page,\n schema=UserRead,\n )\nThe schema must have from_attributes=True (or inherit from PydanticBase) so it can be built from SQLAlchemy model instances.
API Reference
","path":["Modules","CRUD"],"tags":[]},{"location":"module/db/","level":1,"title":"DB","text":"SQLAlchemy async session management with transactions, table locking, and row-change polling.
Info
This module has been coded and tested to be compatible with PostgreSQL only.
","path":["Modules","DB"],"tags":[]},{"location":"module/db/#overview","level":2,"title":"Overview","text":"The db module provides helpers to create FastAPI dependencies and context managers for AsyncSession, along with utilities for nested transactions, table lock and polling for row changes.
Use create_db_dependency to create a FastAPI dependency that yields a session and auto-commits on success:
from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker\nfrom fastapi_toolsets.db import create_db_dependency\n\nengine = create_async_engine(url=\"postgresql+asyncpg://...\", future=True)\nsession_maker = async_sessionmaker(bind=engine, expire_on_commit=False)\n\nget_db = create_db_dependency(session_maker=session_maker)\n\n@router.get(\"/users\")\nasync def list_users(session: AsyncSession = Depends(get_db)):\n ...\nUse create_db_context for sessions outside request handlers (e.g. background tasks, CLI commands):
from fastapi_toolsets.db import create_db_context\n\ndb_context = create_db_context(session_maker=session_maker)\n\nasync def seed():\n async with db_context() as session:\n ...\nget_transaction handles savepoints automatically, allowing safe nesting:
from fastapi_toolsets.db import get_transaction\n\nasync def create_user_with_role(session=session):\n async with get_transaction(session=session):\n ...\n async with get_transaction(session=session): # uses savepoint\n ...\nlock_tables acquires PostgreSQL table-level locks before executing critical sections:
from fastapi_toolsets.db import lock_tables\n\nasync with lock_tables(session=session, tables=[User], mode=\"EXCLUSIVE\"):\n # No other transaction can modify User until this block exits\n ...\nAvailable lock modes are defined in LockMode: ACCESS_SHARE, ROW_SHARE, ROW_EXCLUSIVE, SHARE_UPDATE_EXCLUSIVE, SHARE, SHARE_ROW_EXCLUSIVE, EXCLUSIVE, ACCESS_EXCLUSIVE.
wait_for_row_change polls a row until a specific column changes value, useful for waiting on async side effects:
from fastapi_toolsets.db import wait_for_row_change\n\n# Wait up to 30s for order.status to change\nawait wait_for_row_change(\n session=session,\n model=Order,\n pk_value=order_id,\n columns=[Order.status],\n interval=1.0,\n timeout=30.0,\n)\nAdded in v2.1
create_database creates a database at a given URL. It connects to server_url and issues a CREATE DATABASE statement:
from fastapi_toolsets.db import create_database\n\nSERVER_URL = \"postgresql+asyncpg://postgres:postgres@localhost/postgres\"\n\nawait create_database(db_name=\"myapp_test\", server_url=SERVER_URL)\nFor test isolation with automatic cleanup, use create_worker_database from the pytest module instead — it handles drop-before, create, and drop-after automatically.
Added in v2.1
cleanup_tables truncates all tables:
from fastapi_toolsets.db import cleanup_tables\n\n@pytest.fixture(autouse=True)\nasync def clean(db_session):\n yield\n await cleanup_tables(session=db_session, base=Base)\nAPI Reference
","path":["Modules","DB"],"tags":[]},{"location":"module/dependencies/","level":1,"title":"Dependencies","text":"FastAPI dependency factories for automatic model resolution from path and body parameters.
","path":["Modules","Dependencies"],"tags":[]},{"location":"module/dependencies/#overview","level":2,"title":"Overview","text":"The dependencies module provides two factory functions that create FastAPI dependencies to fetch a model instance from the database automatically — either from a path parameter or from a request body field — and inject it directly into your route handler.
PathDependency","text":"PathDependency resolves a model from a URL path parameter and injects it into the route handler. Raises NotFoundError automatically if the record does not exist.
from fastapi_toolsets.dependencies import PathDependency\n\nUserDep = PathDependency(model=User, field=User.id, session_dep=get_db)\n\n@router.get(\"/users/{user_id}\")\nasync def get_user(user: User = UserDep):\n return user\nBy default the parameter name is inferred from the field (user_id for User.id). You can override it:
UserDep = PathDependency(model=User, field=User.id, session_dep=get_db, param_name=\"id\")\n\n@router.get(\"/users/{id}\")\nasync def get_user(user: User = UserDep):\n return user\nBodyDependency","text":"BodyDependency resolves a model from a field in the request body. Useful when a body contains a foreign key and you want the full object injected:
from fastapi_toolsets.dependencies import BodyDependency\n\nRoleDep = BodyDependency(model=Role, field=Role.id, session_dep=get_db, body_field=\"role_id\")\n\n@router.post(\"/users\")\nasync def create_user(body: UserCreateSchema, role: Role = RoleDep):\n user = User(username=body.username, role=role)\n ...\nAPI Reference
","path":["Modules","Dependencies"],"tags":[]},{"location":"module/exceptions/","level":1,"title":"Exceptions","text":"Structured API exceptions with consistent error responses and automatic OpenAPI documentation.
","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#overview","level":2,"title":"Overview","text":"The exceptions module provides a set of pre-built HTTP exceptions and a FastAPI exception handler that formats all errors — including validation errors — into a uniform ErrorResponse.
Register the exception handlers on your FastAPI app at startup:
from fastapi import FastAPI\nfrom fastapi_toolsets.exceptions import init_exceptions_handlers\n\napp = FastAPI()\ninit_exceptions_handlers(app=app)\nThis registers handlers for:
ApiException — all custom exceptions belowHTTPException — Starlette/FastAPI HTTP errorsRequestValidationError — Pydantic request validation (422)ResponseValidationError — Pydantic response validation (422)Exception — unhandled errors (500)It also patches app.openapi() to replace the default Pydantic 422 schema with a structured example matching the ErrorResponse format.
UnauthorizedError 401 Unauthorized ForbiddenError 403 Forbidden NotFoundError 404 Not Found ConflictError 409 Conflict NoSearchableFieldsError 400 No Searchable Fields InvalidFacetFilterError 400 Invalid Facet Filter InvalidOrderFieldError 422 Invalid Order Field","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#per-instance-overrides","level":3,"title":"Per-instance overrides","text":"All built-in exceptions accept optional keyword arguments to customise the response for a specific raise site without changing the class defaults:
Argument Effectdetail Overrides both str(exc) (log output) and the message field in the response body desc Overrides the description field data Overrides the data field raise NotFoundError(detail=\"User 42 not found\", desc=\"No user with that ID exists in the database.\")\nSubclass ApiException and define an api_error class variable:
from fastapi_toolsets.exceptions import ApiException\nfrom fastapi_toolsets.schemas import ApiError\n\nclass PaymentRequiredError(ApiException):\n api_error = ApiError(\n code=402,\n msg=\"Payment Required\",\n desc=\"Your subscription has expired.\",\n err_code=\"BILLING-402\",\n )\nWarning
Subclasses that do not define api_error raise a TypeError at class creation time, not at raise time.
__init__","text":"Override __init__ to compute detail, desc, or data dynamically, then delegate to super().__init__():
class OrderValidationError(ApiException):\n api_error = ApiError(\n code=422,\n msg=\"Order Validation Failed\",\n desc=\"One or more order fields are invalid.\",\n err_code=\"ORDER-422\",\n )\n\n def __init__(self, *field_errors: str) -> None:\n super().__init__(\n f\"{len(field_errors)} validation error(s)\",\n desc=\", \".join(field_errors),\n data={\"errors\": [{\"message\": e} for e in field_errors]},\n )\nUse abstract=True when creating a shared base that is not meant to be raised directly:
class BillingError(ApiException, abstract=True):\n \"\"\"Base for all billing-related errors.\"\"\"\n\nclass PaymentRequiredError(BillingError):\n api_error = ApiError(code=402, msg=\"Payment Required\", desc=\"...\", err_code=\"BILLING-402\")\n\nclass SubscriptionExpiredError(BillingError):\n api_error = ApiError(code=402, msg=\"Subscription Expired\", desc=\"...\", err_code=\"BILLING-402-EXP\")\nUse generate_error_responses to add error schemas to your endpoint's OpenAPI spec:
from fastapi_toolsets.exceptions import generate_error_responses, NotFoundError, ForbiddenError\n\n@router.get(\n \"/users/{id}\",\n responses=generate_error_responses(NotFoundError, ForbiddenError),\n)\nasync def get_user(...): ...\nMultiple exceptions sharing the same HTTP status code are grouped under one entry, each appearing as a named example keyed by its err_code. This keeps the OpenAPI UI readable when several error variants map to the same status.
API Reference
","path":["Modules","Exceptions"],"tags":[]},{"location":"module/fixtures/","level":1,"title":"Fixtures","text":"Dependency-aware database seeding with context-based loading strategies.
","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#overview","level":2,"title":"Overview","text":"The fixtures module lets you define named fixtures with dependencies between them, then load them into the database in the correct order. Fixtures can be scoped to contexts (e.g. base data, testing data) so that only the relevant ones are loaded for each environment.
from fastapi_toolsets.fixtures import FixtureRegistry, Context\n\nfixtures = FixtureRegistry()\n\n@fixtures.register\ndef roles():\n return [\n Role(id=1, name=\"admin\"),\n Role(id=2, name=\"user\"),\n ]\n\n@fixtures.register(depends_on=[\"roles\"], contexts=[Context.TESTING])\ndef test_users():\n return [\n User(id=1, username=\"alice\", role_id=1),\n User(id=2, username=\"bob\", role_id=2),\n ]\nDependencies declared via depends_on are resolved topologically — roles will always be loaded before test_users.
By context with load_fixtures_by_context:
from fastapi_toolsets.fixtures import load_fixtures_by_context\n\nasync with db_context() as session:\n await load_fixtures_by_context(session=session, registry=fixtures, context=Context.TESTING)\nDirectly with load_fixtures:
from fastapi_toolsets.fixtures import load_fixtures\n\nasync with db_context() as session:\n await load_fixtures(session=session, registry=fixtures)\nContext is an enum with predefined values:
Context.BASE Core data required in all environments Context.TESTING Data only loaded during tests Context.PRODUCTION Data only loaded in production A fixture with no contexts defined takes Context.BASE by default.
LoadStrategy controls how the fixture loader handles rows that already exist:
LoadStrategy.INSERT Insert only, fail on duplicates LoadStrategy.UPSERT Insert or update on conflict LoadStrategy.SKIP Skip rows that already exist","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#merging-registries","level":2,"title":"Merging registries","text":"Split fixtures definitions across modules and merge them:
from myapp.fixtures.dev import dev_fixtures\nfrom myapp.fixtures.prod import prod_fixtures\n\nfixtures = fixturesRegistry()\nfixtures.include_registry(registry=dev_fixtures)\nfixtures.include_registry(registry=prod_fixtures)\n\n## Pytest integration\n\nUse [`register_fixtures`](../reference/pytest.md#fastapi_toolsets.pytest.plugin.register_fixtures) to expose each fixture in your registry as an injectable pytest fixture named `fixture_{name}` by default:\n\n```python\n# conftest.py\nimport pytest\nfrom fastapi_toolsets.pytest import create_db_session, register_fixtures\nfrom app.fixtures import registry\nfrom app.models import Base\n\nDATABASE_URL = \"postgresql+asyncpg://user:pass@localhost/test_db\"\n\n@pytest.fixture\nasync def db_session():\n async with create_db_session(database_url=DATABASE_URL, base=Base, cleanup=True) as session:\n yield session\n\nregister_fixtures(registry=registry, namespace=globals())\n# test_users.py\nasync def test_user_can_login(fixture_users: list[User], fixture_roles: list[Role]):\n ...\nThe load order is resolved automatically from the depends_on declarations in your registry. Each generated fixture receives db_session as a dependency and returns the list of loaded model instances.
Fixtures can be triggered from the CLI. See the CLI module for setup instructions.
API Reference
","path":["Modules","Fixtures"],"tags":[]},{"location":"module/logger/","level":1,"title":"Logger","text":"Lightweight logging utilities with consistent formatting and uvicorn integration.
","path":["Modules","Logger"],"tags":[]},{"location":"module/logger/#overview","level":2,"title":"Overview","text":"The logger module provides two helpers: one to configure the root logger (and uvicorn loggers) at startup, and one to retrieve a named logger anywhere in your codebase.
Call configure_logging once at application startup:
from fastapi_toolsets.logger import configure_logging\n\nconfigure_logging(level=\"INFO\")\nThis sets up a stdout handler with a consistent format and also configures uvicorn's access and error loggers so all log output shares the same style.
","path":["Modules","Logger"],"tags":[]},{"location":"module/logger/#getting-a-logger","level":2,"title":"Getting a logger","text":"from fastapi_toolsets.logger import get_logger\n\nlogger = get_logger(name=__name__)\nlogger.info(\"User created\")\nWhen called without arguments, get_logger auto-detects the caller's module name via frame inspection:
# Equivalent to get_logger(name=__name__)\nlogger = get_logger()\nAPI Reference
","path":["Modules","Logger"],"tags":[]},{"location":"module/metrics/","level":1,"title":"Metrics","text":"Prometheus metrics integration with a decorator-based registry and multi-process support.
","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#installation","level":2,"title":"Installation","text":"uvpipuv add \"fastapi-toolsets[metrics]\"\npip install \"fastapi-toolsets[metrics]\"\nThe metrics module provides a MetricsRegistry to declare Prometheus metrics with decorators, and an init_metrics function to mount a /metrics endpoint on your FastAPI app.
from fastapi import FastAPI\nfrom fastapi_toolsets.metrics import MetricsRegistry, init_metrics\n\napp = FastAPI()\nmetrics = MetricsRegistry()\n\ninit_metrics(app=app, registry=metrics)\nThis mounts the /metrics endpoint that Prometheus can scrape.
Providers are called once at startup by init_metrics. The return value (the Prometheus metric object) is stored in the registry and can be retrieved later with registry.get(name).
Use providers when you want deferred initialization: the Prometheus metric is not registered with the global CollectorRegistry until init_metrics runs, not at import time. This is particularly useful for testing — importing the module in a test suite without calling init_metrics leaves no metrics registered, avoiding cross-test pollution.
It is also useful when metrics are defined across multiple modules and merged with include_registry: any code that needs a metric can call metrics.get() on the shared registry instead of importing the metric directly from its origin module.
If neither of these applies to you, declaring metrics at module level (e.g. HTTP_REQUESTS = Counter(...)) is simpler and equally valid.
from prometheus_client import Counter, Histogram\n\n@metrics.register\ndef http_requests():\n return Counter(\"http_requests_total\", \"Total HTTP requests\", [\"method\", \"status\"])\n\n@metrics.register\ndef request_duration():\n return Histogram(\"request_duration_seconds\", \"Request duration\")\nTo use a provider's metric elsewhere (e.g. in a middleware), call metrics.get() inside the handler — not at module level, as providers are only initialized when init_metrics runs:
async def metrics_middleware(request: Request, call_next):\n response = await call_next(request)\n metrics.get(\"http_requests\").labels(\n method=request.method, status=response.status_code\n ).inc()\n return response\nCollectors are called on every scrape. Use them for metrics that reflect current state (e.g. gauges).
Declare the metric at module level
Do not instantiate the Prometheus metric inside the collector function. Doing so recreates it on every scrape, raising ValueError: Duplicated timeseries in CollectorRegistry. Declare it once at module level instead:
from prometheus_client import Gauge\n\n_queue_depth = Gauge(\"queue_depth\", \"Current queue depth\")\n\n@metrics.register(collect=True)\ndef collect_queue_depth():\n _queue_depth.set(get_current_queue_depth())\nSplit metrics definitions across modules and merge them:
from myapp.metrics.http import http_metrics\nfrom myapp.metrics.db import db_metrics\n\nmetrics = MetricsRegistry()\nmetrics.include_registry(registry=http_metrics)\nmetrics.include_registry(registry=db_metrics)\nMulti-process support is enabled automatically when the PROMETHEUS_MULTIPROC_DIR environment variable is set. No code changes are required.
Environment variable name
The correct variable is PROMETHEUS_MULTIPROC_DIR (not PROMETHEUS_MULTIPROCESS_DIR).
API Reference
","path":["Modules","Metrics"],"tags":[]},{"location":"module/models/","level":1,"title":"Models","text":"Added in v2.0
Reusable SQLAlchemy 2.0 mixins for common column patterns, designed to be composed freely on any DeclarativeBase model.
The models module provides mixins that each add a single, well-defined column behaviour. They work with standard SQLAlchemy 2.0 declarative syntax and are fully compatible with AsyncSession.
from fastapi_toolsets.models import UUIDMixin, TimestampMixin\n\nclass Article(Base, UUIDMixin, TimestampMixin):\n __tablename__ = \"articles\"\n\n title: Mapped[str]\n content: Mapped[str]\nAll timestamp columns are timezone-aware (TIMESTAMPTZ). All defaults are server-side, so they are also applied when inserting rows via raw SQL outside the ORM.
UUIDMixin","text":"Adds a id: UUID primary key generated server-side by PostgreSQL using gen_random_uuid() (requires PostgreSQL 13+). The value is retrieved via RETURNING after insert, so it is available on the Python object immediately after flush().
from fastapi_toolsets.models import UUIDMixin\n\nclass User(Base, UUIDMixin):\n __tablename__ = \"users\"\n\n username: Mapped[str]\n\n# id is None before flush\nuser = User(username=\"alice\")\nawait session.flush()\nprint(user.id) # UUID('...')\nCreatedAtMixin","text":"Adds a created_at: datetime column set to NOW() on insert. The column has no onupdate hook — it is intentionally immutable after the row is created.
from fastapi_toolsets.models import UUIDMixin, CreatedAtMixin\n\nclass Order(Base, UUIDMixin, CreatedAtMixin):\n __tablename__ = \"orders\"\n\n total: Mapped[float]\nUpdatedAtMixin","text":"Adds an updated_at: datetime column set to NOW() on insert and automatically updated to NOW() on every ORM-level update (via SQLAlchemy's onupdate hook).
from fastapi_toolsets.models import UUIDMixin, UpdatedAtMixin\n\nclass Post(Base, UUIDMixin, UpdatedAtMixin):\n __tablename__ = \"posts\"\n\n title: Mapped[str]\n\npost = Post(title=\"Hello\")\nawait session.flush()\nawait session.refresh(post)\n\npost.title = \"Hello World\"\nawait session.flush()\nawait session.refresh(post)\nprint(post.updated_at)\nNote
updated_at is updated by SQLAlchemy at ORM flush time. If you update rows via raw SQL (e.g. UPDATE posts SET ...), the column will not be updated automatically — use a database trigger if you need that guarantee.
TimestampMixin","text":"Convenience mixin that combines CreatedAtMixin and UpdatedAtMixin. Equivalent to inheriting both.
from fastapi_toolsets.models import UUIDMixin, TimestampMixin\n\nclass Article(Base, UUIDMixin, TimestampMixin):\n __tablename__ = \"articles\"\n\n title: Mapped[str]\nAll mixins can be combined in any order. The only constraint is that exactly one primary key must be defined — either via UUIDMixin or directly on the model.
from fastapi_toolsets.models import UUIDMixin, TimestampMixin\n\nclass Event(Base, UUIDMixin, TimestampMixin):\n __tablename__ = \"events\"\n name: Mapped[str]\n\nclass Counter(Base, UpdatedAtMixin):\n __tablename__ = \"counters\"\n id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)\n value: Mapped[int]\nAPI Reference
","path":["Modules","Models"],"tags":[]},{"location":"module/pytest/","level":1,"title":"Pytest","text":"Testing helpers for FastAPI applications with async client, database sessions, and parallel worker support.
","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#installation","level":2,"title":"Installation","text":"uvpipuv add \"fastapi-toolsets[pytest]\"\npip install \"fastapi-toolsets[pytest]\"\nThe pytest module provides utilities for setting up async test clients, managing test database sessions, and supporting parallel test execution with pytest-xdist.
Use create_async_client to get an httpx.AsyncClient configured for your FastAPI app:
from fastapi_toolsets.pytest import create_async_client\n\n@pytest.fixture\nasync def http_client(db_session):\n async def _override_get_db():\n yield db_session\n\n async with create_async_client(\n app=app,\n base_url=\"http://127.0.0.1/api/v1\",\n dependency_overrides={get_db: _override_get_db},\n ) as c:\n yield c\nUse create_db_session to create an isolated AsyncSession for a test, combined with create_worker_database to set up a per-worker database:
from fastapi_toolsets.pytest import create_worker_database, create_db_session\n\n@pytest.fixture(scope=\"session\")\nasync def worker_db_url():\n async with create_worker_database(\n database_url=str(settings.SQLALCHEMY_DATABASE_URI)\n ) as url:\n yield url\n\n\n@pytest.fixture\nasync def db_session(worker_db_url):\n async with create_db_session(\n database_url=worker_db_url, base=Base, cleanup=True\n ) as session:\n yield session\nInfo
In this example, the database is reset between each test using the argument cleanup=True.
Use worker_database_url to derive the per-worker URL manually if needed:
from fastapi_toolsets.pytest import worker_database_url\n\nurl = worker_database_url(\"postgresql+asyncpg://user:pass@localhost/test_db\", default_test_db=\"test\")\n# e.g. \"postgresql+asyncpg://user:pass@localhost/test_db_gw0\" under xdist\nThe examples above are already compatible with parallel test execution with pytest-xdist.
Warning
Since V2.1.0 cleanup_tables now live in fastapi_toolsets.db. For backward compatibility the function is still available in fastapi_toolsets.pytest, but this will be remove in V3.0.0.
If you want to manually clean up a database you can use cleanup_tables, this will truncate all tables between tests for fast isolation:
from fastapi_toolsets.db import cleanup_tables\n\n@pytest.fixture(autouse=True)\nasync def clean(db_session):\n yield\n await cleanup_tables(session=db_session, base=Base)\nAPI Reference
","path":["Modules","Pytest"],"tags":[]},{"location":"module/schemas/","level":1,"title":"Schemas","text":"Standardized Pydantic response models for consistent API responses across your FastAPI application.
","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#overview","level":2,"title":"Overview","text":"The schemas module provides generic response wrappers that enforce a uniform response structure. All models use from_attributes=True for ORM compatibility and validate_assignment=True for runtime type safety.
Response[T]","text":"The most common wrapper for a single resource response.
from fastapi_toolsets.schemas import Response\n\n@router.get(\"/users/{id}\")\nasync def get_user(user: User = UserDep) -> Response[UserSchema]:\n return Response(data=user, message=\"User retrieved\")\nPaginatedResponse[T]","text":"Wraps a list of items with pagination metadata and optional facet values. The pagination field accepts either OffsetPagination or CursorPagination depending on the strategy used.
OffsetPagination","text":"Page-number based. Requires total_count so clients can compute the total number of pages.
from fastapi_toolsets.schemas import PaginatedResponse, OffsetPagination\n\n@router.get(\"/users\")\nasync def list_users() -> PaginatedResponse[UserSchema]:\n return PaginatedResponse(\n data=users,\n pagination=OffsetPagination(\n total_count=100,\n items_per_page=10,\n page=1,\n has_more=True,\n ),\n )\nCursorPagination","text":"Cursor based. Efficient for large or frequently updated datasets where offset pagination is impractical. Provides opaque next_cursor / prev_cursor tokens; no total count is exposed.
from fastapi_toolsets.schemas import PaginatedResponse, CursorPagination\n\n@router.get(\"/events\")\nasync def list_events() -> PaginatedResponse[EventSchema]:\n return PaginatedResponse(\n data=events,\n pagination=CursorPagination(\n next_cursor=\"eyJpZCI6IDQyfQ==\",\n prev_cursor=None,\n items_per_page=20,\n has_more=True,\n ),\n )\nThe optional filter_attributes field is populated when facet_fields are configured on the CRUD class (see Filter attributes). It is None by default and can be hidden from API responses with response_model_exclude_none=True.
ErrorResponse","text":"Returned automatically by the exceptions handler.
API Reference
","path":["Modules","Schemas"],"tags":[]},{"location":"reference/cli/","level":1,"title":"cli","text":"Here's the reference for the CLI configuration helpers used to load settings from pyproject.toml.
You can import them directly from fastapi_toolsets.cli.config:
from fastapi_toolsets.cli.config import (\n import_from_string,\n get_config_value,\n get_fixtures_registry,\n get_db_context,\n get_custom_cli,\n)\nfastapi_toolsets.cli.config.import_from_string(import_path)","text":"Import an object from a dotted string path.
Parameters:
Name Type Description Defaultimport_path str Import path in \"module.submodule:attribute\" format
Returns:
Type DescriptionAny The imported attribute
Raises:
Type DescriptionBadParameter If the import path is invalid or import fails
","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_config_value","level":2,"title":"fastapi_toolsets.cli.config.get_config_value(key, required=False)","text":"get_config_value(key: str, required: Literal[True]) -> Any\nget_config_value(\n key: str, required: bool = False\n) -> Any | None\nGet a configuration value from pyproject.toml.
Parameters:
Name Type Description Defaultkey str The configuration key in [tool.fastapi-toolsets].
requiredrequired bool If True, raises an error when the key is missing.
False Returns:
Type DescriptionAny | None The configuration value, or None if not found and not required.
Raises:
Type DescriptionBadParameter If required=True and the key is missing.
","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_fixtures_registry","level":2,"title":"fastapi_toolsets.cli.config.get_fixtures_registry()","text":"Import and return the fixtures registry from config.
","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_db_context","level":2,"title":"fastapi_toolsets.cli.config.get_db_context()","text":"Import and return the db_context function from config.
","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_custom_cli","level":2,"title":"fastapi_toolsets.cli.config.get_custom_cli()","text":"Import and return the custom CLI Typer instance from config.
","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.utils.async_command","level":2,"title":"fastapi_toolsets.cli.utils.async_command(func)","text":"Decorator to run an async function as a sync CLI command.
Example@fixture_cli.command(\"load\")\n@async_command\nasync def load(ctx: typer.Context) -> None:\n async with get_db_context() as session:\n await load_fixtures(session, registry)\ncrud","text":"Here's the reference for the CRUD classes, factory, and search utilities.
You can import the main symbols from fastapi_toolsets.crud:
from fastapi_toolsets.crud import CrudFactory, AsyncCrud\nfrom fastapi_toolsets.crud.search import SearchConfig, get_searchable_fields, build_search_filters\nfastapi_toolsets.crud.factory.AsyncCrud","text":" Bases: Generic[ModelType]
Generic async CRUD operations for SQLAlchemy models.
Subclass this and set the model class variable, or use CrudFactory.
count(session, filters=None, *, joins=None, outer_join=False) async classmethod","text":"Count records matching the filters.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredfilters list[Any] | None List of SQLAlchemy filter conditions
None joins JoinType | None List of (model, condition) tuples for joining related tables
None outer_join bool Use LEFT OUTER JOIN instead of INNER JOIN
False Returns:
Type Descriptionint Number of matching records
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.create","level":3,"title":"create(session, obj, *, schema=None) async classmethod","text":"create(\n session: AsyncSession,\n obj: BaseModel,\n *,\n schema: type[SchemaType],\n) -> Response[SchemaType]\ncreate(\n session: AsyncSession,\n obj: BaseModel,\n *,\n schema: None = ...,\n) -> ModelType\nCreate a new record in the database.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredobj BaseModel Pydantic model with data to create
requiredschema type[BaseModel] | None Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
None Returns:
Type DescriptionModelType | Response[Any] Created model instance, or Response[schema] when schema is given.
cursor_paginate(session, *, cursor=None, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, items_per_page=20, search=None, search_fields=None, facet_fields=None, filter_by=None, schema) async classmethod","text":"Get paginated results using cursor-based pagination.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session.
requiredcursor str | None Cursor string from a previous CursorPagination. Omit (or pass None) to start from the beginning.
None filters list[Any] | None List of SQLAlchemy filter conditions.
None joins JoinType | None List of (model, condition) tuples for joining related tables.
None outer_join bool Use LEFT OUTER JOIN instead of INNER JOIN.
False load_options Sequence[ExecutableOption] | None SQLAlchemy loader options. Falls back to default_load_options when not provided.
None order_by OrderByClause | None Additional ordering applied after the cursor column.
None items_per_page int Number of items per page (default 20).
20 search str | SearchConfig | None Search query string or SearchConfig object.
None search_fields Sequence[SearchFieldType] | None Fields to search in (overrides class default).
None facet_fields Sequence[FacetFieldType] | None Columns to compute distinct values for (overrides class default).
None filter_by dict[str, Any] | BaseModel | None Dict of {column_key: value} to filter by declared facet fields. Keys must match the column.key of a facet field. Scalar → equality, list → IN clause. Raises InvalidFacetFilterError for unknown keys.
None schema type[BaseModel] Optional Pydantic schema to serialize each item into.
requiredReturns:
Type DescriptionPaginatedResponse[Any] PaginatedResponse with CursorPagination metadata
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.delete","level":3,"title":"delete(session, filters, *, return_response=False) async classmethod","text":"delete(\n session: AsyncSession,\n filters: list[Any],\n *,\n return_response: Literal[True],\n) -> Response[None]\ndelete(\n session: AsyncSession,\n filters: list[Any],\n *,\n return_response: Literal[False] = ...,\n) -> None\nDelete records from the database.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredfilters list[Any] List of SQLAlchemy filter conditions
requiredreturn_response bool When True, returns Response[None] instead of None. Useful for API endpoints that expect a consistent response envelope.
False Returns:
Type DescriptionNone | Response[None] None, or Response[None] when return_response=True.
exists(session, filters, *, joins=None, outer_join=False) async classmethod","text":"Check if a record exists.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredfilters list[Any] List of SQLAlchemy filter conditions
requiredjoins JoinType | None List of (model, condition) tuples for joining related tables
None outer_join bool Use LEFT OUTER JOIN instead of INNER JOIN
False Returns:
Type Descriptionbool True if at least one record matches
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.filter_params","level":3,"title":"filter_params(*, facet_fields=None) classmethod","text":"Return a FastAPI dependency that collects facet filter values from query parameters. Args: facet_fields: Override the facet fields for this dependency. Falls back to the class-level facet_fields if not provided.
Returns:
Type DescriptionCallable[..., Awaitable[dict[str, list[str]]]] An async dependency function named {Model}FilterParams that resolves to a
Callable[..., Awaitable[dict[str, list[str]]]] dict[str, list[str]] containing only the keys that were supplied in the
Callable[..., Awaitable[dict[str, list[str]]]] request (absent/None parameters are excluded).
Raises:
Type DescriptionValueError If no facet fields are configured on this CRUD class and none are provided via facet_fields.
first(session, filters=None, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None) async classmethod","text":"first(\n session: AsyncSession,\n filters: list[Any] | None = None,\n *,\n joins: JoinType | None = None,\n outer_join: bool = False,\n with_for_update: bool = False,\n load_options: Sequence[ExecutableOption] | None = None,\n schema: type[SchemaType],\n) -> Response[SchemaType] | None\nfirst(\n session: AsyncSession,\n filters: list[Any] | None = None,\n *,\n joins: JoinType | None = None,\n outer_join: bool = False,\n with_for_update: bool = False,\n load_options: Sequence[ExecutableOption] | None = None,\n schema: None = ...,\n) -> ModelType | None\nGet the first matching record, or None.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredfilters list[Any] | None List of SQLAlchemy filter conditions
None joins JoinType | None List of (model, condition) tuples for joining related tables
None outer_join bool Use LEFT OUTER JOIN instead of INNER JOIN
False with_for_update bool Lock the row for update
False load_options Sequence[ExecutableOption] | None SQLAlchemy loader options (e.g., selectinload)
None schema type[BaseModel] | None Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
None Returns:
Type DescriptionModelType | Response[Any] | None Model instance, Response[schema] when schema is given,
ModelType | Response[Any] | None or None when no record matches.
get(session, filters, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None) async classmethod","text":"get(\n session: AsyncSession,\n filters: list[Any],\n *,\n joins: JoinType | None = None,\n outer_join: bool = False,\n with_for_update: bool = False,\n load_options: Sequence[ExecutableOption] | None = None,\n schema: type[SchemaType],\n) -> Response[SchemaType]\nget(\n session: AsyncSession,\n filters: list[Any],\n *,\n joins: JoinType | None = None,\n outer_join: bool = False,\n with_for_update: bool = False,\n load_options: Sequence[ExecutableOption] | None = None,\n schema: None = ...,\n) -> ModelType\nGet exactly one record. Raises NotFoundError if not found.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredfilters list[Any] List of SQLAlchemy filter conditions
requiredjoins JoinType | None List of (model, condition) tuples for joining related tables
None outer_join bool Use LEFT OUTER JOIN instead of INNER JOIN
False with_for_update bool Lock the row for update
False load_options Sequence[ExecutableOption] | None SQLAlchemy loader options (e.g., selectinload)
None schema type[BaseModel] | None Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
None Returns:
Type DescriptionModelType | Response[Any] Model instance, or Response[schema] when schema is given.
Raises:
Type DescriptionNotFoundError If no record found
MultipleResultsFound If more than one record found
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.get_multi","level":3,"title":"get_multi(session, *, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, limit=None, offset=None) async classmethod","text":"Get multiple records from the database.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredfilters list[Any] | None List of SQLAlchemy filter conditions
None joins JoinType | None List of (model, condition) tuples for joining related tables
None outer_join bool Use LEFT OUTER JOIN instead of INNER JOIN
False load_options Sequence[ExecutableOption] | None SQLAlchemy loader options
None order_by OrderByClause | None Column or list of columns to order by
None limit int | None Max number of rows to return
None offset int | None Rows to skip
None Returns:
Type DescriptionSequence[ModelType] List of model instances
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.get_or_none","level":3,"title":"get_or_none(session, filters, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None) async classmethod","text":"get_or_none(\n session: AsyncSession,\n filters: list[Any],\n *,\n joins: JoinType | None = None,\n outer_join: bool = False,\n with_for_update: bool = False,\n load_options: Sequence[ExecutableOption] | None = None,\n schema: type[SchemaType],\n) -> Response[SchemaType] | None\nget_or_none(\n session: AsyncSession,\n filters: list[Any],\n *,\n joins: JoinType | None = None,\n outer_join: bool = False,\n with_for_update: bool = False,\n load_options: Sequence[ExecutableOption] | None = None,\n schema: None = ...,\n) -> ModelType | None\nGet exactly one record, or None if not found.
Like :meth:get but returns None instead of raising :class:~fastapi_toolsets.exceptions.NotFoundError when no record matches the filters.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredfilters list[Any] List of SQLAlchemy filter conditions
requiredjoins JoinType | None List of (model, condition) tuples for joining related tables
None outer_join bool Use LEFT OUTER JOIN instead of INNER JOIN
False with_for_update bool Lock the row for update
False load_options Sequence[ExecutableOption] | None SQLAlchemy loader options (e.g., selectinload)
None schema type[BaseModel] | None Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
None Returns:
Type DescriptionModelType | Response[Any] | None Model instance, Response[schema] when schema is given,
ModelType | Response[Any] | None or None when no record matches.
Raises:
Type DescriptionMultipleResultsFound If more than one record found
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.offset_paginate","level":3,"title":"offset_paginate(session, *, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, page=1, items_per_page=20, search=None, search_fields=None, facet_fields=None, filter_by=None, schema) async classmethod","text":"Get paginated results using offset-based pagination.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredfilters list[Any] | None List of SQLAlchemy filter conditions
None joins JoinType | None List of (model, condition) tuples for joining related tables
None outer_join bool Use LEFT OUTER JOIN instead of INNER JOIN
False load_options Sequence[ExecutableOption] | None SQLAlchemy loader options
None order_by OrderByClause | None Column or list of columns to order by
None page int Page number (1-indexed)
1 items_per_page int Number of items per page
20 search str | SearchConfig | None Search query string or SearchConfig object
None search_fields Sequence[SearchFieldType] | None Fields to search in (overrides class default)
None facet_fields Sequence[FacetFieldType] | None Columns to compute distinct values for (overrides class default)
None filter_by dict[str, Any] | BaseModel | None Dict of {column_key: value} to filter by declared facet fields. Keys must match the column.key of a facet field. Scalar → equality, list → IN clause. Raises InvalidFacetFilterError for unknown keys.
None schema type[BaseModel] Pydantic schema to serialize each item into.
requiredReturns:
Type DescriptionPaginatedResponse[Any] PaginatedResponse with OffsetPagination metadata
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.order_params","level":3,"title":"order_params(*, order_fields=None, default_field=None, default_order='asc') classmethod","text":"Return a FastAPI dependency that resolves order query params into an order_by clause.
Parameters:
Name Type Description Defaultorder_fields Sequence[QueryableAttribute[Any]] | None Override the allowed order fields. Falls back to the class-level order_fields if not provided.
None default_field QueryableAttribute[Any] | None Field to order by when order_by query param is absent. If None and no order_by is provided, no ordering is applied.
None default_order Literal['asc', 'desc'] Default order direction when order is absent (\"asc\" or \"desc\").
'asc' Returns:
Type DescriptionCallable[..., Awaitable[OrderByClause | None]] An async dependency function named {Model}OrderParams that resolves to an
Callable[..., Awaitable[OrderByClause | None]] OrderByClause (or None). Pass it to Depends() in your route.
Raises:
Type DescriptionValueError If no order fields are configured on this CRUD class and none are provided via order_fields.
InvalidOrderFieldError When the request provides an unknown order_by value.
update(session, obj, filters, *, exclude_unset=True, exclude_none=False, schema=None) async classmethod","text":"update(\n session: AsyncSession,\n obj: BaseModel,\n filters: list[Any],\n *,\n exclude_unset: bool = True,\n exclude_none: bool = False,\n schema: type[SchemaType],\n) -> Response[SchemaType]\nupdate(\n session: AsyncSession,\n obj: BaseModel,\n filters: list[Any],\n *,\n exclude_unset: bool = True,\n exclude_none: bool = False,\n schema: None = ...,\n) -> ModelType\nUpdate a record in the database.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredobj BaseModel Pydantic model with update data
requiredfilters list[Any] List of SQLAlchemy filter conditions
requiredexclude_unset bool Exclude fields not explicitly set in the schema
True exclude_none bool Exclude fields with None value
False schema type[BaseModel] | None Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
None Returns:
Type DescriptionModelType | Response[Any] Updated model instance, or Response[schema] when schema is given.
Raises:
Type DescriptionNotFoundError If no record found
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.upsert","level":3,"title":"upsert(session, obj, index_elements, *, set_=None, where=None) async classmethod","text":"Create or update a record (PostgreSQL only).
Uses INSERT ... ON CONFLICT for atomic upsert.
Parameters:
Name Type Description Defaultsession AsyncSession DB async session
requiredobj BaseModel Pydantic model with data
requiredindex_elements list[str] Columns for ON CONFLICT (unique constraint)
requiredset_ BaseModel | None Pydantic model for ON CONFLICT DO UPDATE SET
None where WhereHavingRole | None WHERE clause for ON CONFLICT DO UPDATE
None Returns:
Type DescriptionModelType | None Model instance
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.CrudFactory","level":2,"title":"fastapi_toolsets.crud.factory.CrudFactory(model, *, searchable_fields=None, facet_fields=None, order_fields=None, m2m_fields=None, default_load_options=None, cursor_column=None)","text":"Create a CRUD class for a specific model.
Parameters:
Name Type Description Defaultmodel type[ModelType] SQLAlchemy model class
requiredsearchable_fields Sequence[SearchFieldType] | None Optional list of searchable fields
None facet_fields Sequence[FacetFieldType] | None Optional list of columns to compute distinct values for in paginated responses. Supports direct columns (User.status) and relationship tuples ((User.role, Role.name)). Can be overridden per call.
None order_fields Sequence[QueryableAttribute[Any]] | None Optional list of model attributes that callers are allowed to order by via order_params(). Can be overridden per call.
None m2m_fields M2MFieldType | None Optional mapping for many-to-many relationships. Maps schema field names (containing lists of IDs) to SQLAlchemy relationship attributes.
None default_load_options Sequence[ExecutableOption] | None Default SQLAlchemy loader options applied to all read queries when no explicit load_options are passed. Use this instead of lazy=\"selectin\" on the model so that loading strategy is explicit and per-CRUD. Overridden entirely (not merged) when load_options is provided at call-site.
None cursor_column Any | None Required to call cursor_paginate. Must be monotonically ordered (e.g. integer PK, UUID v7, timestamp). See the cursor pagination docs for supported column types.
None Returns:
Type Descriptiontype[AsyncCrud[ModelType]] AsyncCrud subclass bound to the model
Examplefrom fastapi_toolsets.crud import CrudFactory\nfrom myapp.models import User, Post\n\nUserCrud = CrudFactory(User)\nPostCrud = CrudFactory(Post)\n\n# With searchable fields:\nUserCrud = CrudFactory(\n User,\n searchable_fields=[User.username, User.email, (User.role, Role.name)]\n)\n\n# With many-to-many fields:\n# Schema has `tag_ids: list[UUID]`, model has `tags` relationship to Tag\nPostCrud = CrudFactory(\n Post,\n m2m_fields={\"tag_ids\": Post.tags},\n)\n\n# With facet fields for filter dropdowns / faceted search:\nUserCrud = CrudFactory(\n User,\n facet_fields=[User.status, User.country, (User.role, Role.name)],\n)\n\n# With a fixed cursor column for cursor_paginate:\nPostCrud = CrudFactory(\n Post,\n cursor_column=Post.created_at,\n)\n\n# With default load strategy (replaces lazy=\"selectin\" on the model):\nArticleCrud = CrudFactory(\n Article,\n default_load_options=[selectinload(Article.category), selectinload(Article.tags)],\n)\n\n# Override default_load_options for a specific call:\narticle = await ArticleCrud.get(\n session,\n [Article.id == 1],\n load_options=[selectinload(Article.category)], # tags won't load\n)\n\n# Usage\nuser = await UserCrud.get(session, [User.id == 1])\nposts = await PostCrud.get_multi(session, filters=[Post.user_id == user.id])\n\n# Create with M2M - tag_ids are automatically resolved\npost = await PostCrud.create(session, PostCreate(title=\"Hello\", tag_ids=[id1, id2]))\n\n# With search\nresult = await UserCrud.offset_paginate(session, search=\"john\")\n\n# With joins (inner join by default):\nusers = await UserCrud.get_multi(\n session,\n joins=[(Post, Post.user_id == User.id)],\n filters=[Post.published == True],\n)\n\n# With outer join:\nusers = await UserCrud.get_multi(\n session,\n joins=[(Post, Post.user_id == User.id)],\n outer_join=True,\n)\nfastapi_toolsets.crud.search.SearchConfig dataclass","text":"Advanced search configuration.
Attributes:
Name Type Descriptionquery str The search string
fields Sequence[SearchFieldType] | None Fields to search (columns or tuples for relationships)
case_sensitive bool Case-sensitive search (default: False)
match_mode Literal['any', 'all'] \"any\" (OR) or \"all\" (AND) to combine fields
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.search.get_searchable_fields","level":2,"title":"fastapi_toolsets.crud.search.get_searchable_fields(model, *, include_relationships=True, max_depth=1) cached","text":"Auto-detect String fields on a model and its relationships.
Parameters:
Name Type Description Defaultmodel type[DeclarativeBase] SQLAlchemy model class
requiredinclude_relationships bool Include fields from many-to-one/one-to-one relationships
True max_depth int Max depth for relationship traversal (default: 1)
1 Returns:
Type Descriptionlist[SearchFieldType] List of columns and tuples (relationship, column)
","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.search.build_search_filters","level":2,"title":"fastapi_toolsets.crud.search.build_search_filters(model, search, search_fields=None, default_fields=None)","text":"Build SQLAlchemy filter conditions for search.
Parameters:
Name Type Description Defaultmodel type[DeclarativeBase] SQLAlchemy model class
requiredsearch str | SearchConfig Search string or SearchConfig
requiredsearch_fields Sequence[SearchFieldType] | None Fields specified per-call (takes priority)
None default_fields Sequence[SearchFieldType] | None Default fields (from ClassVar)
None Returns:
Type Descriptiontuple[list[ColumnElement[bool]], list[InstrumentedAttribute[Any]]] Tuple of (filter_conditions, joins_needed)
Raises:
Type DescriptionNoSearchableFieldsError If no searchable field has been configured
","path":["Reference","crud"],"tags":[]},{"location":"reference/db/","level":1,"title":"db","text":"Here's the reference for all database session utilities, transaction helpers, and locking functions.
You can import them directly from fastapi_toolsets.db:
from fastapi_toolsets.db import (\n LockMode,\n cleanup_tables,\n create_database,\n create_db_dependency,\n create_db_context,\n get_transaction,\n lock_tables,\n wait_for_row_change,\n)\nfastapi_toolsets.db.LockMode","text":" Bases: str, Enum
PostgreSQL table lock modes.
See: https://www.postgresql.org/docs/current/explicit-locking.html
","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.create_db_dependency","level":2,"title":"fastapi_toolsets.db.create_db_dependency(session_maker)","text":"Create a FastAPI dependency for database sessions.
Creates a dependency function that yields a session and auto-commits if a transaction is active when the request completes.
Parameters:
Name Type Description Defaultsession_maker async_sessionmaker[AsyncSession] Async session factory from create_session_factory()
requiredReturns:
Type DescriptionCallable[[], AsyncGenerator[AsyncSession, None]] An async generator function usable with FastAPI's Depends()
Examplefrom fastapi import Depends\nfrom sqlalchemy.ext.asyncio import AsyncSession, create_async_engine, async_sessionmaker\nfrom fastapi_toolsets.db import create_db_dependency\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False)\nget_db = create_db_dependency(SessionLocal)\n\n@app.get(\"/users\")\nasync def list_users(session: AsyncSession = Depends(get_db)):\n ...\nfastapi_toolsets.db.create_db_context(session_maker)","text":"Create a context manager for database sessions.
Creates a context manager for use outside of FastAPI request handlers, such as in background tasks, CLI commands, or tests.
Parameters:
Name Type Description Defaultsession_maker async_sessionmaker[AsyncSession] Async session factory from create_session_factory()
requiredReturns:
Type DescriptionCallable[[], AbstractAsyncContextManager[AsyncSession]] An async context manager function
Examplefrom sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker\nfrom fastapi_toolsets.db import create_db_context\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False)\nget_db_context = create_db_context(SessionLocal)\n\nasync def background_task():\n async with get_db_context() as session:\n user = await UserCrud.get(session, [User.id == 1])\n ...\nfastapi_toolsets.db.get_transaction(session) async","text":"Get a transaction context, handling nested transactions.
If already in a transaction, creates a savepoint (nested transaction). Otherwise, starts a new transaction.
Parameters:
Name Type Description Defaultsession AsyncSession AsyncSession instance
requiredYields:
Type DescriptionAsyncGenerator[AsyncSession, None] The session within the transaction context
Exampleasync with get_transaction(session):\n session.add(model)\n # Auto-commits on exit, rolls back on exception\nfastapi_toolsets.db.lock_tables(session, tables, *, mode=LockMode.SHARE_UPDATE_EXCLUSIVE, timeout='5s') async","text":"Lock PostgreSQL tables for the duration of a transaction.
Acquires table-level locks that are held until the transaction ends. Useful for preventing concurrent modifications during critical operations.
Parameters:
Name Type Description Defaultsession AsyncSession AsyncSession instance
requiredtables list[type[DeclarativeBase]] List of SQLAlchemy model classes to lock
requiredmode LockMode Lock mode (default: SHARE UPDATE EXCLUSIVE)
SHARE_UPDATE_EXCLUSIVE timeout str Lock timeout (default: \"5s\")
'5s' Yields:
Type DescriptionAsyncGenerator[AsyncSession, None] The session with locked tables
Raises:
Type DescriptionSQLAlchemyError If lock cannot be acquired within timeout
Examplefrom fastapi_toolsets.db import lock_tables, LockMode\n\nasync with lock_tables(session, [User, Account]):\n # Tables are locked with SHARE UPDATE EXCLUSIVE mode\n user = await UserCrud.get(session, [User.id == 1])\n user.balance += 100\n\n# With custom lock mode\nasync with lock_tables(session, [Order], mode=LockMode.EXCLUSIVE):\n # Exclusive lock - no other transactions can access\n await process_order(session, order_id)\nfastapi_toolsets.db.wait_for_row_change(session, model, pk_value, *, columns=None, interval=0.5, timeout=None) async","text":"Poll a database row until a change is detected.
Queries the row every interval seconds and returns the model instance once a change is detected in any column (or only the specified columns).
Parameters:
Name Type Description Defaultsession AsyncSession AsyncSession instance
requiredmodel type[_M] SQLAlchemy model class
requiredpk_value Any Primary key value of the row to watch
requiredcolumns list[str] | None Optional list of column names to watch. If None, all columns are watched.
None interval float Polling interval in seconds (default: 0.5)
0.5 timeout float | None Maximum time to wait in seconds. None means wait forever.
None Returns:
Type Description_M The refreshed model instance with updated values
Raises:
Type DescriptionNotFoundError If the row does not exist or is deleted during polling
TimeoutError If timeout expires before a change is detected
Examplefrom fastapi_toolsets.db import wait_for_row_change\n\n# Wait for any column to change\nupdated = await wait_for_row_change(session, User, user_id)\n\n# Watch specific columns with a timeout\nupdated = await wait_for_row_change(\n session, User, user_id,\n columns=[\"status\", \"email\"],\n interval=1.0,\n timeout=30.0,\n)\nfastapi_toolsets.db.create_database(db_name, *, server_url) async","text":"Create a database.
Connects to server_url using AUTOCOMMIT isolation and issues a CREATE DATABASE statement for db_name.
Parameters:
Name Type Description Defaultdb_name str Name of the database to create.
requiredserver_url str URL used for server-level DDL (must point to an existing database on the same server).
required Examplefrom fastapi_toolsets.db import create_database\n\nSERVER_URL = \"postgresql+asyncpg://postgres:postgres@localhost/postgres\"\nawait create_database(\"myapp_test\", server_url=SERVER_URL)\nfastapi_toolsets.db.cleanup_tables(session, base) async","text":"Truncate all tables for fast between-test cleanup.
Executes a single TRUNCATE … RESTART IDENTITY CASCADE statement across every table in base's metadata, which is significantly faster than dropping and re-creating tables between tests.
This is a no-op when the metadata contains no tables.
Parameters:
Name Type Description Defaultsession AsyncSession An active async database session.
requiredbase type[DeclarativeBase] SQLAlchemy DeclarativeBase class containing model metadata.
required Example@pytest.fixture\nasync def db_session(worker_db_url):\n async with create_db_session(worker_db_url, Base) as session:\n yield session\n await cleanup_tables(session, Base)\ndependencies","text":"Here's the reference for the FastAPI dependency factory functions.
You can import them directly from fastapi_toolsets.dependencies:
from fastapi_toolsets.dependencies import PathDependency, BodyDependency\nfastapi_toolsets.dependencies.PathDependency(model, field, *, session_dep, param_name=None)","text":"Create a dependency that fetches a DB object from a path parameter.
Parameters:
Name Type Description Defaultmodel type[ModelType] SQLAlchemy model class
requiredfield Any Model field to filter by (e.g., User.id)
requiredsession_dep SessionDependency Session dependency function (e.g., get_db)
requiredparam_name str | None Path parameter name (defaults to model_field, e.g., user_id)
None Returns:
Type DescriptionModelType A Depends() instance that resolves to the model instance
Raises:
Type DescriptionNotFoundError If no matching record is found
ExampleUserDep = PathDependency(User, User.id, session_dep=get_db)\n\n@router.get(\"/user/{id}\")\nasync def get(\n user: User = UserDep,\n): ...\nfastapi_toolsets.dependencies.BodyDependency(model, field, *, session_dep, body_field)","text":"Create a dependency that fetches a DB object from a body field.
Parameters:
Name Type Description Defaultmodel type[ModelType] SQLAlchemy model class
requiredfield Any Model field to filter by (e.g., User.id)
requiredsession_dep SessionDependency Session dependency function (e.g., get_db)
requiredbody_field str Name of the field in the request body
requiredReturns:
Type DescriptionModelType A Depends() instance that resolves to the model instance
Raises:
Type DescriptionNotFoundError If no matching record is found
ExampleUserDep = BodyDependency(\n User, User.ctfd_id, session_dep=get_db, body_field=\"user_id\"\n)\n\n@router.post(\"/assign\")\nasync def assign(\n user: User = UserDep,\n): ...\nexceptions","text":"Here's the reference for all exception classes and handler utilities.
You can import them directly from fastapi_toolsets.exceptions:
from fastapi_toolsets.exceptions import (\n ApiException,\n UnauthorizedError,\n ForbiddenError,\n NotFoundError,\n ConflictError,\n NoSearchableFieldsError,\n InvalidFacetFilterError,\n InvalidOrderFieldError,\n generate_error_responses,\n init_exceptions_handlers,\n)\nfastapi_toolsets.exceptions.exceptions.ApiException","text":" Bases: Exception
Base exception for API errors with structured response.
","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ApiException.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"Initialize the exception.
Parameters:
Name Type Description Defaultdetail str | None Optional human-readable message
None desc str | None Optional per-instance override for the description field in the HTTP response body.
None data Any Optional per-instance override for the data field in the HTTP response body.
None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.UnauthorizedError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.UnauthorizedError","text":" Bases: ApiException
HTTP 401 - User is not authenticated.
","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.UnauthorizedError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"Initialize the exception.
Parameters:
Name Type Description Defaultdetail str | None Optional human-readable message
None desc str | None Optional per-instance override for the description field in the HTTP response body.
None data Any Optional per-instance override for the data field in the HTTP response body.
None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ForbiddenError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.ForbiddenError","text":" Bases: ApiException
HTTP 403 - User lacks required permissions.
","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ForbiddenError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"Initialize the exception.
Parameters:
Name Type Description Defaultdetail str | None Optional human-readable message
None desc str | None Optional per-instance override for the description field in the HTTP response body.
None data Any Optional per-instance override for the data field in the HTTP response body.
None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NotFoundError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.NotFoundError","text":" Bases: ApiException
HTTP 404 - Resource not found.
","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NotFoundError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"Initialize the exception.
Parameters:
Name Type Description Defaultdetail str | None Optional human-readable message
None desc str | None Optional per-instance override for the description field in the HTTP response body.
None data Any Optional per-instance override for the data field in the HTTP response body.
None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ConflictError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.ConflictError","text":" Bases: ApiException
HTTP 409 - Resource conflict.
","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ConflictError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"Initialize the exception.
Parameters:
Name Type Description Defaultdetail str | None Optional human-readable message
None desc str | None Optional per-instance override for the description field in the HTTP response body.
None data Any Optional per-instance override for the data field in the HTTP response body.
None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError","text":" Bases: ApiException
Raised when search is requested but no searchable fields are available.
","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError.__init__","level":3,"title":"__init__(model)","text":"Initialize the exception.
Parameters:
Name Type Description Defaultmodel type The model class that has no searchable fields configured.
required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidFacetFilterError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.InvalidFacetFilterError","text":" Bases: ApiException
Raised when filter_by contains a key not declared in facet_fields.
","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidFacetFilterError.__init__","level":3,"title":"__init__(key, valid_keys)","text":"Initialize the exception.
Parameters:
Name Type Description Defaultkey str The unknown filter key provided by the caller.
requiredvalid_keys set[str] Set of valid keys derived from the declared facet_fields.
required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidOrderFieldError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.InvalidOrderFieldError","text":" Bases: ApiException
Raised when order_by contains a field not in the allowed order fields.
","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidOrderFieldError.__init__","level":3,"title":"__init__(field, valid_fields)","text":"Initialize the exception.
Parameters:
Name Type Description Defaultfield str The unknown order field provided by the caller.
requiredvalid_fields list[str] List of valid field names.
required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.generate_error_responses","level":2,"title":"fastapi_toolsets.exceptions.exceptions.generate_error_responses(*errors)","text":"Generate OpenAPI response documentation for exceptions.
Parameters:
Name Type Description Default*errors type[ApiException] Exception classes that inherit from ApiException.
() Returns:
Type Descriptiondict[int | str, dict[str, Any]] Dict suitable for FastAPI's responses parameter.
fastapi_toolsets.exceptions.handler.init_exceptions_handlers(app)","text":"Register exception handlers and custom OpenAPI schema on a FastAPI app.
Parameters:
Name Type Description Defaultapp FastAPI FastAPI application instance.
requiredReturns:
Type DescriptionFastAPI The same FastAPI instance (for chaining).
","path":["Reference","exceptions"],"tags":[]},{"location":"reference/fixtures/","level":1,"title":"fixtures","text":"Here's the reference for the fixture registry, enums, and loading utilities.
You can import them directly from fastapi_toolsets.fixtures:
from fastapi_toolsets.fixtures import (\n Context,\n LoadStrategy,\n Fixture,\n FixtureRegistry,\n load_fixtures,\n load_fixtures_by_context,\n get_obj_by_attr,\n)\nfastapi_toolsets.fixtures.enum.Context","text":" Bases: str, Enum
Predefined fixture contexts.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.BASE","level":3,"title":"BASE = 'base' class-attribute instance-attribute","text":"Base fixtures loaded in all environments.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.DEVELOPMENT","level":3,"title":"DEVELOPMENT = 'development' class-attribute instance-attribute","text":"Development fixtures.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.PRODUCTION","level":3,"title":"PRODUCTION = 'production' class-attribute instance-attribute","text":"Production-only fixtures.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.TESTING","level":3,"title":"TESTING = 'testing' class-attribute instance-attribute","text":"Test fixtures.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy","level":2,"title":"fastapi_toolsets.fixtures.enum.LoadStrategy","text":" Bases: str, Enum
Strategy for loading fixtures into the database.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy.INSERT","level":3,"title":"INSERT = 'insert' class-attribute instance-attribute","text":"Insert new records. Fails if record already exists.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy.MERGE","level":3,"title":"MERGE = 'merge' class-attribute instance-attribute","text":"Insert or update based on primary key (SQLAlchemy merge).
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy.SKIP_EXISTING","level":3,"title":"SKIP_EXISTING = 'skip_existing' class-attribute instance-attribute","text":"Insert only if record doesn't exist (based on primary key).
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.Fixture","level":2,"title":"fastapi_toolsets.fixtures.registry.Fixture dataclass","text":"A fixture definition with metadata.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry","level":2,"title":"fastapi_toolsets.fixtures.registry.FixtureRegistry","text":"Registry for managing fixtures with dependencies.
Examplefrom fastapi_toolsets.fixtures import FixtureRegistry, Context\n\nfixtures = FixtureRegistry()\n\n@fixtures.register\ndef roles():\n return [\n Role(id=1, name=\"admin\"),\n Role(id=2, name=\"user\"),\n ]\n\n@fixtures.register(depends_on=[\"roles\"])\ndef users():\n return [\n User(id=1, username=\"admin\", role_id=1),\n ]\n\n@fixtures.register(depends_on=[\"users\"], contexts=[Context.TESTING])\ndef test_data():\n return [\n Post(id=1, title=\"Test\", user_id=1),\n ]\nget(name)","text":"Get a fixture by name.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.get_all","level":3,"title":"get_all()","text":"Get all registered fixtures.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.get_by_context","level":3,"title":"get_by_context(*contexts)","text":"Get fixtures for specific contexts.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.include_registry","level":3,"title":"include_registry(registry)","text":"Include another FixtureRegistry in the same current FixtureRegistry.
Parameters:
Name Type Description Defaultregistry FixtureRegistry The FixtureRegistry to include
Raises:
Type DescriptionValueError If a fixture name already exists in the current registry
Exampleregistry = FixtureRegistry()\ndev_registry = FixtureRegistry()\n\n@dev_registry.register\ndef dev_data():\n return [...]\n\nregistry.include_registry(registry=dev_registry)\nregister(func=None, *, name=None, depends_on=None, contexts=None)","text":"Register a fixture function.
Can be used as a decorator with or without arguments.
Parameters:
Name Type Description Defaultfunc Callable[[], Sequence[DeclarativeBase]] | None Fixture function returning list of model instances
None name str | None Fixture name (defaults to function name)
None depends_on list[str] | None List of fixture names this depends on
None contexts list[str | Context] | None List of contexts this fixture belongs to
None Example @fixtures.register\ndef roles():\n return [Role(id=1, name=\"admin\")]\n\n@fixtures.register(depends_on=[\"roles\"], contexts=[Context.TESTING])\ndef test_users():\n return [User(id=1, username=\"test\", role_id=1)]\nresolve_context_dependencies(*contexts)","text":"Resolve all fixtures for contexts with dependencies.
Parameters:
Name Type Description Default*contexts str | Context Contexts to load
() Returns:
Type Descriptionlist[str] List of fixture names in load order
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.resolve_dependencies","level":3,"title":"resolve_dependencies(*names)","text":"Resolve fixture dependencies in topological order.
Parameters:
Name Type Description Default*names str Fixture names to resolve
() Returns:
Type Descriptionlist[str] List of fixture names in load order (dependencies first)
Raises:
Type DescriptionKeyError If a fixture is not found
ValueError If circular dependency detected
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.utils.load_fixtures","level":2,"title":"fastapi_toolsets.fixtures.utils.load_fixtures(session, registry, *names, strategy=LoadStrategy.MERGE) async","text":"Load specific fixtures by name with dependencies.
Parameters:
Name Type Description Defaultsession AsyncSession Database session
requiredregistry FixtureRegistry Fixture registry
required*names str Fixture names to load (dependencies auto-resolved)
() strategy LoadStrategy How to handle existing records
MERGE Returns:
Type Descriptiondict[str, list[DeclarativeBase]] Dict mapping fixture names to loaded instances
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.utils.load_fixtures_by_context","level":2,"title":"fastapi_toolsets.fixtures.utils.load_fixtures_by_context(session, registry, *contexts, strategy=LoadStrategy.MERGE) async","text":"Load all fixtures for specific contexts.
Parameters:
Name Type Description Defaultsession AsyncSession Database session
requiredregistry FixtureRegistry Fixture registry
required*contexts str | Context Contexts to load (e.g., Context.BASE, Context.TESTING)
() strategy LoadStrategy How to handle existing records
MERGE Returns:
Type Descriptiondict[str, list[DeclarativeBase]] Dict mapping fixture names to loaded instances
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.utils.get_obj_by_attr","level":2,"title":"fastapi_toolsets.fixtures.utils.get_obj_by_attr(fixtures, attr_name, value)","text":"Get a SQLAlchemy model instance by matching an attribute value.
Parameters:
Name Type Description Defaultfixtures Callable[[], Sequence[ModelType]] A fixture function registered via @registry.register that returns a sequence of SQLAlchemy model instances.
attr_name str Name of the attribute to match against.
requiredvalue Any Value to match.
requiredReturns:
Type DescriptionModelType The first model instance where the attribute matches the given value.
Raises:
Type DescriptionStopIteration If no matching object is found in the fixture group.
","path":["Reference","fixtures"],"tags":[]},{"location":"reference/logger/","level":1,"title":"logger","text":"Here's the reference for the logging utilities.
You can import them directly from fastapi_toolsets.logger:
from fastapi_toolsets.logger import configure_logging, get_logger\nfastapi_toolsets.logger.configure_logging(level='INFO', fmt=DEFAULT_FORMAT, logger_name=None)","text":"Configure logging with a stdout handler and consistent format.
Sets up a :class:~logging.StreamHandler writing to stdout with the given format and level. Also configures the uvicorn loggers so that FastAPI access logs use the same format.
Calling this function multiple times is safe -- existing handlers are replaced rather than duplicated.
Parameters:
Name Type Description Defaultlevel LogLevel | int Log level (e.g. \"DEBUG\", \"INFO\", or logging.DEBUG).
'INFO' fmt str Log format string. Defaults to \"%(asctime)s - %(name)s - %(levelname)s - %(message)s\".
DEFAULT_FORMAT logger_name str | None Logger name to configure. None (the default) configures the root logger so all loggers inherit the settings.
None Returns:
Type DescriptionLogger The configured Logger instance.
Examplefrom fastapi_toolsets.logger import configure_logging\n\nlogger = configure_logging(\"DEBUG\")\nlogger.info(\"Application started\")\nfastapi_toolsets.logger.get_logger(name=_SENTINEL)","text":"Return a logger with the given name.
A thin convenience wrapper around :func:logging.getLogger that keeps logging imports consistent across the codebase.
When called without arguments, the caller's __name__ is used automatically, so get_logger() in a module is equivalent to logging.getLogger(__name__). Pass None explicitly to get the root logger.
Parameters:
Name Type Description Defaultname str | None Logger name. Defaults to the caller's __name__. Pass None to get the root logger.
_SENTINEL Returns:
Type DescriptionLogger A Logger instance.
Examplefrom fastapi_toolsets.logger import get_logger\n\nlogger = get_logger() # uses caller's __name__\nlogger = get_logger(\"myapp\") # explicit name\nlogger = get_logger(None) # root logger\nmetrics","text":"Here's the reference for the Prometheus metrics registry and endpoint handler.
You can import them directly from fastapi_toolsets.metrics:
from fastapi_toolsets.metrics import Metric, MetricsRegistry, init_metrics\nfastapi_toolsets.metrics.registry.Metric dataclass","text":"A metric definition with metadata.
","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry","level":2,"title":"fastapi_toolsets.metrics.registry.MetricsRegistry","text":"Registry for managing Prometheus metric providers and collectors.
","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get","level":3,"title":"get(name)","text":"Return the metric instance created by a provider.
Parameters:
Name Type Description Defaultname str The metric name (defaults to the provider function name).
requiredRaises:
Type DescriptionKeyError If the metric name is unknown or init_metrics has not been called yet.
get_all()","text":"Get all registered metric definitions.
","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get_collectors","level":3,"title":"get_collectors()","text":"Get collectors (called on each scrape).
","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get_providers","level":3,"title":"get_providers()","text":"Get metric providers (called once at init).
","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.include_registry","level":3,"title":"include_registry(registry)","text":"Include another :class:MetricsRegistry into this one.
Parameters:
Name Type Description Defaultregistry MetricsRegistry The registry to merge in.
requiredRaises:
Type DescriptionValueError If a metric name already exists in the current registry.
","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.register","level":3,"title":"register(func=None, *, name=None, collect=False)","text":"Register a metric provider or collector function.
Can be used as a decorator with or without arguments.
Parameters:
Name Type Description Defaultfunc Callable[..., Any] | None The metric function to register.
None name str | None Metric name (defaults to function name).
None collect bool If True, the function is called on every scrape. If False (default), called once at init time.
False","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.handler.init_metrics","level":2,"title":"fastapi_toolsets.metrics.handler.init_metrics(app, registry, *, path='/metrics')","text":"Register a Prometheus /metrics endpoint on a FastAPI app.
Parameters:
Name Type Description Defaultapp FastAPI FastAPI application instance.
requiredregistry MetricsRegistry A :class:MetricsRegistry containing providers and collectors.
path str URL path for the metrics endpoint (default /metrics).
'/metrics' Returns:
Type DescriptionFastAPI The same FastAPI instance (for chaining).
Examplefrom fastapi import FastAPI\nfrom fastapi_toolsets.metrics import MetricsRegistry, init_metrics\n\nmetrics = MetricsRegistry()\napp = FastAPI()\ninit_metrics(app, registry=metrics)\nmodels","text":"Here's the reference for the SQLAlchemy model mixins provided by the models module.
You can import them directly from fastapi_toolsets.models:
from fastapi_toolsets.models import (\n UUIDMixin,\n CreatedAtMixin,\n UpdatedAtMixin,\n TimestampMixin,\n)\nfastapi_toolsets.models.UUIDMixin","text":"Mixin that adds a UUID primary key auto-generated by the database.
","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.CreatedAtMixin","level":2,"title":"fastapi_toolsets.models.CreatedAtMixin","text":"Mixin that adds a created_at timestamp column.
fastapi_toolsets.models.UpdatedAtMixin","text":"Mixin that adds an updated_at timestamp column.
fastapi_toolsets.models.TimestampMixin","text":" Bases: CreatedAtMixin, UpdatedAtMixin
Mixin that combines created_at and updated_at timestamp columns.
pytest","text":"Here's the reference for all testing utilities and pytest fixtures.
You can import them directly from fastapi_toolsets.pytest:
from fastapi_toolsets.pytest import (\n register_fixtures,\n create_async_client,\n create_db_session,\n worker_database_url,\n create_worker_database,\n cleanup_tables,\n)\nfastapi_toolsets.pytest.plugin.register_fixtures(registry, namespace, *, prefix='fixture_', session_fixture='db_session', strategy=LoadStrategy.MERGE)","text":"Register pytest fixtures from a FixtureRegistry.
Automatically creates pytest fixtures for each fixture in the registry. Dependencies are resolved via pytest fixture dependencies.
Parameters:
Name Type Description Defaultregistry FixtureRegistry The FixtureRegistry containing fixtures
requirednamespace dict[str, Any] The module's globals() dict to add fixtures to
requiredprefix str Prefix for generated fixture names (default: \"fixture_\")
'fixture_' session_fixture str Name of the db session fixture (default: \"db_session\")
'db_session' strategy LoadStrategy Loading strategy for fixtures (default: MERGE)
MERGE Returns:
Type Descriptionlist[str] List of created fixture names
Example# conftest.py\nfrom app.fixtures import fixtures\nfrom fastapi_toolsets.pytest_plugin import register_fixtures\n\nregister_fixtures(fixtures, globals())\n\n# Creates fixtures like:\n# - fixture_roles\n# - fixture_users (depends on fixture_roles if users depends on roles)\n# - fixture_posts (depends on fixture_users if posts depends on users)\nfastapi_toolsets.pytest.utils.create_async_client(app, base_url='http://test', dependency_overrides=None) async","text":"Create an async httpx client for testing FastAPI applications.
Parameters:
Name Type Description Defaultapp Any FastAPI application instance.
requiredbase_url str Base URL for requests. Defaults to \"http://test\".
'http://test' dependency_overrides dict[Callable[..., Any], Callable[..., Any]] | None Optional mapping of original dependencies to their test replacements. Applied via app.dependency_overrides before yielding and cleaned up after.
None Yields:
Type DescriptionAsyncGenerator[AsyncClient, None] An AsyncClient configured for the app.
Examplefrom fastapi import FastAPI\nfrom fastapi_toolsets.pytest import create_async_client\n\napp = FastAPI()\n\n@pytest.fixture\nasync def client():\n async with create_async_client(app) as c:\n yield c\n\nasync def test_endpoint(client: AsyncClient):\n response = await client.get(\"/health\")\n assert response.status_code == 200\nfrom fastapi_toolsets.pytest import create_async_client, create_db_session\nfrom app.db import get_db\n\n@pytest.fixture\nasync def db_session():\n async with create_db_session(DATABASE_URL, Base, cleanup=True) as session:\n yield session\n\n@pytest.fixture\nasync def client(db_session):\n async def override():\n yield db_session\n\n async with create_async_client(\n app, dependency_overrides={get_db: override}\n ) as c:\n yield c\nfastapi_toolsets.pytest.utils.create_db_session(database_url, base, *, echo=False, expire_on_commit=False, drop_tables=True, cleanup=False) async","text":"Create a database session for testing.
Creates tables before yielding the session and optionally drops them after. Each call creates a fresh engine and session for test isolation.
Parameters:
Name Type Description Defaultdatabase_url str Database connection URL (e.g., \"postgresql+asyncpg://...\").
requiredbase type[DeclarativeBase] SQLAlchemy DeclarativeBase class containing model metadata.
requiredecho bool Enable SQLAlchemy query logging. Defaults to False.
False expire_on_commit bool Expire objects after commit. Defaults to False.
False drop_tables bool Drop tables after test. Defaults to True.
True cleanup bool Truncate all tables after test using :func:cleanup_tables. Defaults to False.
False Yields:
Type DescriptionAsyncGenerator[AsyncSession, None] An AsyncSession ready for database operations.
Examplefrom fastapi_toolsets.pytest import create_db_session\nfrom app.models import Base\n\nDATABASE_URL = \"postgresql+asyncpg://user:pass@localhost/test_db\"\n\n@pytest.fixture\nasync def db_session():\n async with create_db_session(\n DATABASE_URL, Base, cleanup=True\n ) as session:\n yield session\n\nasync def test_create_user(db_session: AsyncSession):\n user = User(name=\"test\")\n db_session.add(user)\n await db_session.commit()\nfastapi_toolsets.pytest.utils.worker_database_url(database_url, default_test_db)","text":"Derive a per-worker database URL for pytest-xdist parallel runs.
Appends _{worker_name} to the database name so each xdist worker operates on its own database. When not running under xdist, _{default_test_db} is appended instead.
The worker name is read from the PYTEST_XDIST_WORKER environment variable (set automatically by xdist in each worker process).
Parameters:
Name Type Description Defaultdatabase_url str Original database connection URL.
requireddefault_test_db str Suffix appended to the database name when PYTEST_XDIST_WORKER is not set.
Returns:
Type Descriptionstr A database URL with a worker- or default-specific database name.
","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.utils.create_worker_database","level":2,"title":"fastapi_toolsets.pytest.utils.create_worker_database(database_url, default_test_db='test_db') async","text":"Create and drop a per-worker database for pytest-xdist isolation.
Derives a worker-specific database URL using :func:worker_database_url, then delegates to :func:~fastapi_toolsets.db.create_database to create and drop it. Intended for use as a session-scoped fixture.
When running under xdist the database name is suffixed with the worker name (e.g. _gw0). Otherwise it is suffixed with default_test_db.
Parameters:
Name Type Description Defaultdatabase_url str Original database connection URL (used as the server connection and as the base for the worker database name).
requireddefault_test_db str Suffix appended to the database name when PYTEST_XDIST_WORKER is not set. Defaults to \"test_db\".
'test_db' Yields:
Type DescriptionAsyncGenerator[str, None] The worker-specific database URL.
Examplefrom fastapi_toolsets.pytest import create_worker_database, create_db_session\n\nDATABASE_URL = \"postgresql+asyncpg://postgres:postgres@localhost/test_db\"\n\n@pytest.fixture(scope=\"session\")\nasync def worker_db_url():\n async with create_worker_database(DATABASE_URL) as url:\n yield url\n\n@pytest.fixture\nasync def db_session(worker_db_url):\n async with create_db_session(\n worker_db_url, Base, cleanup=True\n ) as session:\n yield session\nschemas","text":"Here's the reference for all response models and types provided by the schemas module.
You can import them directly from fastapi_toolsets.schemas:
from fastapi_toolsets.schemas import (\n PydanticBase,\n ResponseStatus,\n ApiError,\n BaseResponse,\n Response,\n ErrorResponse,\n OffsetPagination,\n CursorPagination,\n PaginatedResponse,\n)\nfastapi_toolsets.schemas.PydanticBase","text":" Bases: BaseModel
Base class for all Pydantic models with common configuration.
","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.ResponseStatus","level":2,"title":"fastapi_toolsets.schemas.ResponseStatus","text":" Bases: str, Enum
Standard API response status.
","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.ApiError","level":2,"title":"fastapi_toolsets.schemas.ApiError","text":" Bases: PydanticBase
Structured API error definition.
Used to define standard error responses with consistent format.
Attributes:
Name Type Descriptioncode int HTTP status code
msg str Short error message
desc str Detailed error description
err_code str Application-specific error code (e.g., \"AUTH-401\")
","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.BaseResponse","level":2,"title":"fastapi_toolsets.schemas.BaseResponse","text":" Bases: PydanticBase
Base response structure for all API responses.
Attributes:
Name Type Descriptionstatus ResponseStatus SUCCESS or FAIL
message str Human-readable message
error_code str | None Error code if status is FAIL, None otherwise
","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.Response","level":2,"title":"fastapi_toolsets.schemas.Response","text":" Bases: BaseResponse, Generic[DataT]
Generic API response with data payload.
ExampleResponse[UserRead](data=user, message=\"User retrieved\")\nfastapi_toolsets.schemas.ErrorResponse","text":" Bases: BaseResponse
Error response with additional description field.
Used for error responses that need more context.
","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.OffsetPagination","level":2,"title":"fastapi_toolsets.schemas.OffsetPagination","text":" Bases: PydanticBase
Pagination metadata for offset-based list responses.
Attributes:
Name Type Descriptiontotal_count int Total number of items across all pages
items_per_page int Number of items per page
page int Current page number (1-indexed)
has_more bool Whether there are more pages
","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.CursorPagination","level":2,"title":"fastapi_toolsets.schemas.CursorPagination","text":" Bases: PydanticBase
Pagination metadata for cursor-based list responses.
Attributes:
Name Type Descriptionnext_cursor str | None Encoded cursor for the next page, or None on the last page.
prev_cursor str | None Encoded cursor for the previous page, or None on the first page.
items_per_page int Number of items requested per page.
has_more bool Whether there is at least one more page after this one.
","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.PaginatedResponse","level":2,"title":"fastapi_toolsets.schemas.PaginatedResponse","text":" Bases: BaseResponse, Generic[DataT]
Paginated API response for list endpoints.
","path":["Reference","schemas"],"tags":[]}]} \ No newline at end of file diff --git a/v2.2/sitemap.xml b/v2.2/sitemap.xml new file mode 100644 index 0000000..87383c5 --- /dev/null +++ b/v2.2/sitemap.xml @@ -0,0 +1,78 @@ + +