read_user_item() — fastapi Function Reference

Architecture documentation for the read_user_item() function in tutorial004_py39.py from the fastapi codebase.

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ read_user_item() — fastapi Function Reference

Dependency Diagram

graph TD
  fd5c8a6d_3c17_d5d4_2513_e967bfd39eb6["read_user_item()"]
  28cd7db9_f024_b937_ab06_ae4be7006bc2["tutorial004_py39.py"]
  fd5c8a6d_3c17_d5d4_2513_e967bfd39eb6 -->|defined in| 28cd7db9_f024_b937_ab06_ae4be7006bc2
  style fd5c8a6d_3c17_d5d4_2513_e967bfd39eb6 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params/tutorial004_py39.py lines 9–19

async def read_user_item(
    user_id: int, item_id: str, q: Union[str, None] = None, short: bool = False
):
    item = {"item_id": item_id, "owner_id": user_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )
    return item