read_items() — fastapi Function Reference

Architecture documentation for the read_items() function in tutorial006_an_py39.py from the fastapi codebase.

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  8c96279c_107b_94ee_f0ce_bba2fb0dd3e4["read_items()"]
  13e1bb87_05d6_9aff_6445_932c17b214e5["tutorial006_an_py39.py"]
  8c96279c_107b_94ee_f0ce_bba2fb0dd3e4 -->|defined in| 13e1bb87_05d6_9aff_6445_932c17b214e5
  style 8c96279c_107b_94ee_f0ce_bba2fb0dd3e4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/path_params_numeric_validations/tutorial006_an_py39.py lines 9–20

async def read_items(
    *,
    item_id: Annotated[int, Path(title="The ID of the item to get", ge=0, le=1000)],
    q: str,
    size: Annotated[float, Query(gt=0, lt=10.5)],
):
    results = {"item_id": item_id}
    if q:
        results.update({"q": q})
    if size:
        results.update({"size": size})
    return results