fastapi Architecture Docs
Home / Function/ get_flat_params() — fastapi Function Reference

get_flat_params() — fastapi Function Reference

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

Function python DependencyInjection Resolver calls 2 called by 2

Entity Profile

Dependency Diagram

graph TD
  ae5e875d_4a7a_fe4f_43bc_0f9490438b9f["get_flat_params()"]
  9e602cbf_3139_86ae_5666_97b8806942de["utils.py"]
  ae5e875d_4a7a_fe4f_43bc_0f9490438b9f -->|defined in| 9e602cbf_3139_86ae_5666_97b8806942de
  200f313e_38b9_296f_f9aa_afdeacb6b8ad["get_openapi_path()"]
  200f313e_38b9_296f_f9aa_afdeacb6b8ad -->|calls| ae5e875d_4a7a_fe4f_43bc_0f9490438b9f
  ca85dbd8_2c4a_3a15_71e8_da853c7f62ce["get_fields_from_routes()"]
  ca85dbd8_2c4a_3a15_71e8_da853c7f62ce -->|calls| ae5e875d_4a7a_fe4f_43bc_0f9490438b9f
  df2bd000_d29c_ac4b_5eca_426e3122a385["get_flat_dependant()"]
  ae5e875d_4a7a_fe4f_43bc_0f9490438b9f -->|calls| df2bd000_d29c_ac4b_5eca_426e3122a385
  c37f239e_d34d_5c2b_ce28_2b7463c61051["_get_flat_fields_from_params()"]
  ae5e875d_4a7a_fe4f_43bc_0f9490438b9f -->|calls| c37f239e_d34d_5c2b_ce28_2b7463c61051
  style ae5e875d_4a7a_fe4f_43bc_0f9490438b9f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/dependencies/utils.py lines 192–198

def get_flat_params(dependant: Dependant) -> list[ModelField]:
    flat_dependant = get_flat_dependant(dependant, skip_repeats=True)
    path_params = _get_flat_fields_from_params(flat_dependant.path_params)
    query_params = _get_flat_fields_from_params(flat_dependant.query_params)
    header_params = _get_flat_fields_from_params(flat_dependant.header_params)
    cookie_params = _get_flat_fields_from_params(flat_dependant.cookie_params)
    return path_params + query_params + header_params + cookie_params

Domain

Subdomains

Defined In

Calls

Called By

Source

Frequently Asked Questions

What does get_flat_params() do?
get_flat_params() is a function in the fastapi codebase, defined in fastapi/dependencies/utils.py.
Where is get_flat_params() defined?
get_flat_params() is defined in fastapi/dependencies/utils.py at line 192.
What does get_flat_params() call?
get_flat_params() calls 2 function(s): _get_flat_fields_from_params, get_flat_dependant.
What calls get_flat_params()?
get_flat_params() is called by 2 function(s): get_fields_from_routes, get_openapi_path.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free