add_non_field_param_to_dependency() — fastapi Function Reference

Architecture documentation for the add_non_field_param_to_dependency() function in utils.py from the fastapi codebase.

Function python DependencyInjection ParamFunctions called by 1

Entity Profile

DependencyInjection→ ParamFunctions→ add_non_field_param_to_dependency() — fastapi Function Reference

Dependency Diagram

graph TD
  2f0d48f2_69ad_85f8_c209_9aadf3b96b05["add_non_field_param_to_dependency()"]
  9e602cbf_3139_86ae_5666_97b8806942de["utils.py"]
  2f0d48f2_69ad_85f8_c209_9aadf3b96b05 -->|defined in| 9e602cbf_3139_86ae_5666_97b8806942de
  097a7e41_8095_d61f_b849_128514c58040["get_dependant()"]
  097a7e41_8095_d61f_b849_128514c58040 -->|calls| 2f0d48f2_69ad_85f8_c209_9aadf3b96b05
  style 2f0d48f2_69ad_85f8_c209_9aadf3b96b05 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/dependencies/utils.py lines 332–353

def add_non_field_param_to_dependency(
    *, param_name: str, type_annotation: Any, dependant: Dependant
) -> Optional[bool]:
    if lenient_issubclass(type_annotation, Request):
        dependant.request_param_name = param_name
        return True
    elif lenient_issubclass(type_annotation, WebSocket):
        dependant.websocket_param_name = param_name
        return True
    elif lenient_issubclass(type_annotation, HTTPConnection):
        dependant.http_connection_param_name = param_name
        return True
    elif lenient_issubclass(type_annotation, Response):
        dependant.response_param_name = param_name
        return True
    elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):
        dependant.background_tasks_param_name = param_name
        return True
    elif lenient_issubclass(type_annotation, SecurityScopes):
        dependant.security_scopes_param_name = param_name
        return True
    return None