Safe typed filtering for FastAPI, MongoDB, SQL, SQLAlchemy, SQLModel, and ODMs.
Paramora turns user-controlled HTTP query parameters like:
/items?price__gte=10&status__in=free,busy&sort=-created_at&limit=20into safe, typed backend query outputs for MongoDB, raw SQL, SQLAlchemy, SQLModel, and Mongo ODM adapters.
It helps FastAPI teams avoid hand-written filtering code, unsafe raw backend query exposure, inconsistent validation, and repeated pagination/sorting logic.
Status: Paramora is alpha software. Public APIs, backend emitter contracts, AST details, and error shapes may change before
1.0.
FastAPI makes endpoint code ergonomic, but filtering APIs often grow into messy manual parsing:
price = request.query_params.get("price__gte")
status = request.query_params.get("status__in")
query = {}
if price:
query["price"] = {"$gte": float(price)}
if status:
query["status"] = {"$in": status.split(",")}Paramora lets you declare the query surface once:
from datetime import datetime
from typing import Annotated
from paramora import Query, QueryContract, query_field
class ItemQuery(QueryContract):
status: Annotated[str, query_field("eq", "in")]
active: bool
created_at: Annotated[datetime, query_field("gte", "lte", sortable=True)]
price: Annotated[float, query_field("eq", "gte", "lte")]
item_query = Query(ItemQuery)Then Paramora handles:
- allowed fields and operators
- type coercion for
str,int,float,bool,datetime, andEnum - strict vs loose validation
- sorting and pagination
- structured FastAPI
422errors - MongoDB, raw SQL, SQLAlchemy, SQLModel, and ODM emitter outputs
uv add paramoraor:
pip install paramoraOptional backend extras:
uv add "paramora[sqlalchemy]"
uv add "paramora[sqlmodel]"
uv add "paramora[postgres]"
uv add "paramora[odm]"
uv add "paramora[all]"Paramora supports Python 3.10+ and FastAPI 0.115+.
Python 3.10 is the compatibility baseline. Runtime code intentionally avoids Python 3.11+/3.12+ only syntax so a wide range of FastAPI applications can adopt Paramora.
from datetime import datetime
from typing import Annotated
from fastapi import Depends, FastAPI
from paramora import CompiledQuery, MongoQuery, Query, QueryContract, query_field
app = FastAPI()
class ItemQuery(QueryContract):
status: Annotated[str, query_field("eq", "in")]
active: bool
created_at: Annotated[datetime, query_field("gte", "lte", sortable=True)]
price: Annotated[float, query_field("eq", "gt", "gte", "lt", "lte")]
item_query: Query[MongoQuery] = Query(ItemQuery, default_limit=20, max_limit=100)
@app.get("/items")
def list_items(query: CompiledQuery[MongoQuery] = Depends(item_query)):
mongo = query.output
docs = (
collection
.find(mongo.filter)
.sort(mongo.sort)
.skip(mongo.offset)
.limit(mongo.limit)
)
return list(docs)from datetime import datetime
from typing import Annotated
from fastapi import Depends, FastAPI
from paramora import (
CompiledQuery,
Query,
QueryContract,
SqlQuery,
SqliteEmitter,
query_field,
)
app = FastAPI()
class ItemQuery(QueryContract):
status: Annotated[str, query_field("eq", "in")]
created_at: Annotated[datetime, query_field("gte", "lte", sortable=True)]
price: Annotated[float, query_field("eq", "gte", "lte")]
item_query: Query[SqlQuery] = Query(ItemQuery, emitter=SqliteEmitter())
@app.get("/items")
def list_items(query: CompiledQuery[SqlQuery] = Depends(item_query)):
sql = query.output
statement = sql.select_statement("items", columns=("id", "status", "price"))
rows = connection.execute(statement.text, statement.params).fetchall()
return [dict(row) for row in rows]Values are always returned as bound parameters. Paramora does not interpolate user values into SQL strings.
from datetime import datetime
from typing import Annotated
import sqlalchemy as sa
from fastapi import Depends, FastAPI
from paramora import CompiledQuery, Query, QueryContract, query_field
from paramora.emitters.sqlalchemy import SqlAlchemyEmitter, SqlAlchemyQuery
metadata = sa.MetaData()
items = sa.Table(
"items",
metadata,
sa.Column("id", sa.Integer, primary_key=True),
sa.Column("status", sa.String),
sa.Column("price", sa.Float),
sa.Column("created_at", sa.DateTime),
)
class ItemQuery(QueryContract):
status: Annotated[str, query_field("eq", "in")]
price: Annotated[float, query_field("gte", "lte")]
created_at: Annotated[datetime, query_field("gte", "lte", sortable=True)]
item_query: Query[SqlAlchemyQuery] = Query(
ItemQuery,
emitter=SqlAlchemyEmitter.from_table(items),
)
app = FastAPI()
@app.get("/items")
def list_items(query: CompiledQuery[SqlAlchemyQuery] = Depends(item_query)):
statement = query.output.apply(sa.select(items))
return {"sql": str(statement)}Query(MyContract)enables strict mode. It rejects unknown fields, unsupported operators, invalid values, unsafe sorting, and oversized limits.Query()enables loose mode. It accepts unknown fields for trusted tools and prototypes, while still rejecting raw backend operator injection and unsafe SQL identifiers.
Use strict mode for public APIs.
The full documentation site is available at:
https://ehsanahmadzadeh.github.io/Paramora/
Useful pages:
- Quickstart
- Usage guide
- How-to guides
- MongoDB backend
- Raw SQL backend
- SQLAlchemy and SQLModel
- Mongo ODM adapters
- Testing strategy
- Continuous Integration
- Benchmarking
Install the full development environment:
uv sync --group dev --group docsRun the same local quality gate that CI expects:
scripts/check.shIndividual helper scripts are also available:
scripts/format.sh # Format and apply safe lint fixes
scripts/test.sh # Run pytest, forwarding any extra arguments
scripts/docs.sh serve # Serve the documentation site locally
scripts/docs.sh build # Build docs with MkDocs strict mode
scripts/benchmark.sh # Run benchmark scenariosThe CI pipeline runs quality gates and the full test suite across every supported Python version: 3.10, 3.11, 3.12, 3.13, and 3.14. Coverage is generated on each Python version and uploaded to Codecov so regressions are visible from the README badge and pull requests.
The development environment installs optional backend test dependencies so
SQLAlchemy, SQLModel, MongoDB-compatible mongomock, and ODM-related tests can
run when possible.
Paramora is early and contributor-friendly. Good first contributions include:
- improving examples
- adding backend edge-case tests
- improving documentation recipes
- expanding SQLAlchemy / SQLModel coverage
- improving benchmarks and profiling scripts
See CONTRIBUTING.md.
Paramora is released under the MIT License.