read_user_item() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ read_user_item() — fastapi Function Reference

Dependency Diagram

graph TD
  b7cad411_5c7d_602b_fcc6_5a19ebfe4e1f["read_user_item()"]
  21b6e8ae_b821_894f_1b2b_6321459f7ca9["tutorial004_py310.py"]
  b7cad411_5c7d_602b_fcc6_5a19ebfe4e1f -->|defined in| 21b6e8ae_b821_894f_1b2b_6321459f7ca9
  style b7cad411_5c7d_602b_fcc6_5a19ebfe4e1f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params/tutorial004_py310.py lines 7–17

async def read_user_item(
    user_id: int, item_id: str, q: 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