get_model_fields() — fastapi Function Reference

Architecture documentation for the get_model_fields() function in v2.py from the fastapi codebase.

Function python FastAPI Applications calls 1 called by 2

Entity Profile

FastAPI→ Applications→ get_model_fields() — fastapi Function Reference

Dependency Diagram

graph TD
  2a403be5_8229_574a_aded_dd7fb4e261f4["get_model_fields()"]
  3e134d50_38c1_8523_f518_6686c1d9752b["v2.py"]
  2a403be5_8229_574a_aded_dd7fb4e261f4 -->|defined in| 3e134d50_38c1_8523_f518_6686c1d9752b
  d5a14994_47ba_0528_2be7_4ee420c3ec29["get_cached_model_fields()"]
  d5a14994_47ba_0528_2be7_4ee420c3ec29 -->|calls| 2a403be5_8229_574a_aded_dd7fb4e261f4
  f63bbc7e_ffcd_ab71_6957_68be35f4793a["get_flat_models_from_model()"]
  f63bbc7e_ffcd_ab71_6957_68be35f4793a -->|calls| 2a403be5_8229_574a_aded_dd7fb4e261f4
  eda91ac5_1bd0_0d8b_6e77_6b82c2f46ce9["lenient_issubclass()"]
  2a403be5_8229_574a_aded_dd7fb4e261f4 -->|calls| eda91ac5_1bd0_0d8b_6e77_6b82c2f46ce9
  style 2a403be5_8229_574a_aded_dd7fb4e261f4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/_compat/v2.py lines 337–352

def get_model_fields(model: type[BaseModel]) -> list[ModelField]:
    model_fields: list[ModelField] = []
    for name, field_info in model.model_fields.items():
        type_ = field_info.annotation
        if lenient_issubclass(type_, (BaseModel, dict)) or is_dataclass(type_):
            model_config = None
        else:
            model_config = model.model_config
        model_fields.append(
            ModelField(
                field_info=field_info,
                name=name,
                config=model_config,
            )
        )
    return model_fields