read_items() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  08fc3ef0_6f65_3a1f_8db4_00f132c68bb5["read_items()"]
  834e3fc6_2ac7_ef56_6314_c1384c682c2d["tutorial003_an_py39.py"]
  08fc3ef0_6f65_3a1f_8db4_00f132c68bb5 -->|defined in| 834e3fc6_2ac7_ef56_6314_c1384c682c2d
  style 08fc3ef0_6f65_3a1f_8db4_00f132c68bb5 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/path_params_numeric_validations/tutorial003_an_py39.py lines 9–15

async def read_items(
    item_id: Annotated[int, Path(title="The ID of the item to get")], q: str
):
    results = {"item_id": item_id}
    if q:
        results.update({"q": q})
    return results