anyquart_pydantic

anyquart extension for request and response validation with pydantic.

Annotate your route handlers with pydantic models and the body and response are validated automatically.

Install

pip install anyquart_pydantic

Usage

Here is a simple example:

# app.py
from pydantic import BaseModel

from anyquart import AnyQuart
from anyquart import jsonify

from anyquart_pydantic import AnyQuartPydantic

app = AnyQuart(__name__)
AnyQuartPydantic(app)


class User(BaseModel):
    email: str

class UserIn(User):
    password: str
    username: str | None = None

class UserOut(User):
    uid: str
    username: str

@app.route("/users", methods=["POST"])
async def create_user(user: UserIn) -> UserOut:
    if user.username is None:
        user.username = user.email.split("@")[0]
    # do other stuffs(e.g: save to the database)
    #
    # and return a new registered user with a generated uuid primary key from the database
    new_user = UserOut(
        uid="66b652e0-f114-46d7-b426-e0601233bab2",
        username=user.username
    )
    return new_user, 201

Run the application:

$ anyquart --app app:app run

send a request:

$ curl -X POST http://localhost:5000/users \
    -H "Content-Type: application/json" \
    -d '{"email": "foo@bar.com", "password": "super_secret!"}'

#response:
{
    "uid": "66b652e0-f114-46d7-b426-e0601233bab2",
    "username": "foo"
}

Contributing

Contributions are very welcome. Tests can be run with tox. To run tests on all environments in parallel tox -p, run test on specific environment tox -e py315 -- tests. You can also use uv uv sync.

License

MIT