get_schema_from_model_field() — fastapi Function Reference

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

Function python FastAPI Responses calls 1

Entity Profile

FastAPI→ Responses→ get_schema_from_model_field() — fastapi Function Reference

Dependency Diagram

graph TD
  a21af4d6_5aa1_b041_33f7_a06cfd72eab6["get_schema_from_model_field()"]
  3e134d50_38c1_8523_f518_6686c1d9752b["v2.py"]
  a21af4d6_5aa1_b041_33f7_a06cfd72eab6 -->|defined in| 3e134d50_38c1_8523_f518_6686c1d9752b
  fac9f9ed_ff79_d2bb_8ad2_67c368ec00c8["_has_computed_fields()"]
  a21af4d6_5aa1_b041_33f7_a06cfd72eab6 -->|calls| fac9f9ed_ff79_d2bb_8ad2_67c368ec00c8
  style a21af4d6_5aa1_b041_33f7_a06cfd72eab6 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/_compat/v2.py lines 196–224

def get_schema_from_model_field(
    *,
    field: ModelField,
    model_name_map: ModelNameMap,
    field_mapping: dict[
        tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
    ],
    separate_input_output_schemas: bool = True,
) -> dict[str, Any]:
    override_mode: Union[Literal["validation"], None] = (
        None
        if (separate_input_output_schemas or _has_computed_fields(field))
        else "validation"
    )
    field_alias = (
        (field.validation_alias or field.alias)
        if field.mode == "validation"
        else (field.serialization_alias or field.alias)
    )

    # This expects that GenerateJsonSchema was already used to generate the definitions
    json_schema = field_mapping[(field, override_mode or field.mode)]
    if "$ref" not in json_schema:
        # TODO remove when deprecating Pydantic v1
        # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207
        json_schema["title"] = field.field_info.title or field_alias.title().replace(
            "_", " "
        )
    return json_schema