Introduction
fastapi-filters is a library that provides filtering/sorting feature for FastAPI
applications.
Installation
pip install fastapi-filters
Quickstart
Define filters using a FilterSet class:
from fastapi import Depends, FastAPI
from pydantic import BaseModel
from fastapi_filters import FilterField, FilterSet, SortingValues, create_sorting
app = FastAPI()
class UserOut(BaseModel):
name: str
surname: str
age: int
class UserFilters(FilterSet):
name: FilterField[str]
surname: FilterField[str]
age: FilterField[int]
@app.get("/users")
async def get_users(
filters: UserFilters = Depends(),
sorting: SortingValues = Depends(create_sorting("name", "age")),
) -> list[UserOut]:
pass
Query parameters are auto-generated based on field types:
GET /users?name[eq]=Steve&age[gt]=30&sort=+age
fastapi-filters supports SQLAlchemy, Tortoise ORM, Beanie (MongoDB), and raw SQL integrations.
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from fastapi_filters.ext.sqlalchemy import apply_filters_and_sorting
@app.get("/users")
async def get_users(
db: AsyncSession = Depends(get_db),
filters: UserFilters = Depends(),
sorting: SortingValues = Depends(create_sorting("name", "age")),
) -> list[UserOut]:
stmt = apply_filters_and_sorting(select(User), filters, sorting)
return (await db.scalars(stmt)).all()
Metadata
Release files for fastapi-filters 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fastapi_filters-0.5.0.tar.gz | 222.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fastapi_filters-0.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 245.9 kB
Release files / fastapi_filters-0.5.0.tar.gz
| Download URL | fastapi_filters-0.5.0.tar.gz |
|---|---|
| Size | 222.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7ffea1b317502184eb0b00933b6e4cfc7299c491be4cae234455df3983e355ca
|
|
BLAKE2b-256 checksum How to use checksums |
20f6bf90e4bdc51cb917174a9172fdc6c2439e8c8063771773bec7b164ccd409
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.20 {"installer":{"name":"uv","version":"0.11.20","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / fastapi_filters-0.5.0-py3-none-any.whl
| Download URL | fastapi_filters-0.5.0-py3-none-any.whl |
|---|---|
| Size | 23.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6c61ad770bd43732ba48575ed05cc627010ae3d357794aff120ab131aeec8a1f
|
|
BLAKE2b-256 checksum How to use checksums |
192cc66f62edc8528fe914c6f69da07472ee56e3de61508d23ceb9b2b3cda232
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.20 {"installer":{"name":"uv","version":"0.11.20","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|