get_cookie_or_token() — fastapi Function Reference

Architecture documentation for the get_cookie_or_token() function in tutorial002_an_py39.py from the fastapi codebase.

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ get_cookie_or_token() — fastapi Function Reference

Dependency Diagram

graph TD
  6149fa02_fdff_e3a4_66b0_a5524d51d816["get_cookie_or_token()"]
  891d4554_fd2c_26f0_e3bd_6bfe635f8c6e["tutorial002_an_py39.py"]
  6149fa02_fdff_e3a4_66b0_a5524d51d816 -->|defined in| 891d4554_fd2c_26f0_e3bd_6bfe635f8c6e
  style 6149fa02_fdff_e3a4_66b0_a5524d51d816 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/websockets/tutorial002_an_py39.py lines 66–73

async def get_cookie_or_token(
    websocket: WebSocket,
    session: Annotated[Union[str, None], Cookie()] = None,
    token: Annotated[Union[str, None], Query()] = None,
):
    if session is None and token is None:
        raise WebSocketException(code=status.WS_1008_POLICY_VIOLATION)
    return session or token