Request Validation#

When receiving data from a client it makes sense to check that they’ve sent it in a format you understand. This is done by validating the request data is correct against a schema you define. Quart-Schema allows validation of JSON data via decorating the route handler, as so,

from attrs import define
from quart_schema import validate_request

@define
class Todo:
    effort: int
    task: str

@app.route("/", methods=["POST'])
@validate_request(Todo)
async def index(data: Todo):
    ...

from dataclasses import dataclass

from quart_schema import validate_request

@dataclass
class Todo:
    effort: int
    task: str

@app.route("/", methods=["POST'])
@validate_request(Todo)
async def index(data: Todo):
    ...

from msgspec import Struct
from quart_schema import validate_request

class Todo(Struct):
    effort: int
    task: str

@app.route("/", methods=["POST'])
@validate_request(Todo)
async def index(data: Todo):
    ...

from pydantic import BaseModel
from quart_schema import validate_request

class Todo(BaseModel):
    effort: int
    task: str

@app.route("/", methods=["POST'])
@validate_request(Todo)
async def index(data: Todo):
    ...

this will expect the client to send a body with JSON structured to match the Todo class, for example,

{
  "effort": 2,
  "task": "Finish the docs"
}

If the client doesn’t supply correctly structured data they will receive a 400 (bad request) response without your route handler running. If the client does supploy correctly structured data it will be passed into your route handler as the data argument.

Form data#

By default the validate_request() decorator assumes the request body is JSON encoded. If the request body is form (application/x-www-form-urlencoded) encoded the source argument can be changed to validate the form data,

from attrs import define
from quart_schema import DataSource, validate_request

@define
class Todo:
    effort: int
    task: str

@app.route("/", methods=["POST'])
@validate_request(Todo, source=DataSource.FORM)
async def index(data: Todo):
    ...

from dataclasses import dataclass

from quart_schema import DataSource, validate_request

@dataclass
class Todo:
    effort: int
    task: str

@app.route("/", methods=["POST'])
@validate_request(Todo, source=DataSource.FORM)
async def index(data: Todo):
    ...

from msgspec import Struct
from quart_schema import DataSource, validate_request

class Todo(Struct):
    effort: int
    task: str

@app.route("/", methods=["POST'])
@validate_request(Todo, source=DataSource.FORM)
async def index(data: Todo):
    ...

from pydantic import BaseModel
from quart_schema import DataSource, validate_request

class Todo(BaseModel):
    effort: int
    task: str

@app.route("/", methods=["POST'])
@validate_request(Todo, source=DataSource.FORM)
async def index(data: Todo):
    ...

with everything working as in the JSON example above.

Note

Form encoded data is a flat structure, therefore Quart-Schema will raise a SchemaInvalidError if the model proposed has nested structures.

File data#

By default the validate_request() decorator assumes the request body is JSON encoded. If the request body has files it must be multipart (multipart/form-data) encoded and the source argument must be changed to validate the form data,

from dataclasses import dataclass

from pydantic import BaseModel
from quart_schema import DataSource, validate_request
from quart_schema.pydantic import File

class Upload(BaseModel):
    file: File

@app.route("/", methods=["POST'])
@validate_request(Upload, source=DataSource.FORM_MULTIPART)
async def index(data: Upload):
    file_content = data.file.read()

Warning

This currently only works with Pydantic types and validation.