get_flat_models_from_field() — fastapi Function Reference

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

Function python FastAPI Applications calls 3 called by 1

Entity Profile

FastAPI→ Applications→ get_flat_models_from_field() — fastapi Function Reference

Dependency Diagram

graph TD
  dc2b68f6_efc4_8d5c_5dca_76c377de10e0["get_flat_models_from_field()"]
  3e134d50_38c1_8523_f518_6686c1d9752b["v2.py"]
  dc2b68f6_efc4_8d5c_5dca_76c377de10e0 -->|defined in| 3e134d50_38c1_8523_f518_6686c1d9752b
  41e3e153_6be6_f36c_453e_3d06b11b55c4["get_flat_models_from_fields()"]
  41e3e153_6be6_f36c_453e_3d06b11b55c4 -->|calls| dc2b68f6_efc4_8d5c_5dca_76c377de10e0
  eda91ac5_1bd0_0d8b_6e77_6b82c2f46ce9["lenient_issubclass()"]
  dc2b68f6_efc4_8d5c_5dca_76c377de10e0 -->|calls| eda91ac5_1bd0_0d8b_6e77_6b82c2f46ce9
  f63bbc7e_ffcd_ab71_6957_68be35f4793a["get_flat_models_from_model()"]
  dc2b68f6_efc4_8d5c_5dca_76c377de10e0 -->|calls| f63bbc7e_ffcd_ab71_6957_68be35f4793a
  bac6078f_b791_0fe8_6d7e_8ee00c1d4eaa["get_flat_models_from_annotation()"]
  dc2b68f6_efc4_8d5c_5dca_76c377de10e0 -->|calls| bac6078f_b791_0fe8_6d7e_8ee00c1d4eaa
  style dc2b68f6_efc4_8d5c_5dca_76c377de10e0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/_compat/v2.py lines 404–417

def get_flat_models_from_field(
    field: ModelField, known_models: TypeModelSet
) -> TypeModelSet:
    field_type = field.field_info.annotation
    if lenient_issubclass(field_type, BaseModel):
        if field_type in known_models:
            return known_models
        known_models.add(field_type)
        get_flat_models_from_model(field_type, known_models=known_models)
    elif lenient_issubclass(field_type, Enum):
        known_models.add(field_type)
    else:
        get_flat_models_from_annotation(field_type, known_models=known_models)
    return known_models