is_pydantic_v1_model_instance() — fastapi Function Reference

Architecture documentation for the is_pydantic_v1_model_instance() function in shared.py from the fastapi codebase.

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ is_pydantic_v1_model_instance() — fastapi Function Reference

Dependency Diagram

graph TD
  6598ef7b_c8de_afd2_19f8_8a88b5fb5900["is_pydantic_v1_model_instance()"]
  3e898b29_4dd8_c417_2d9b_a84d867423b4["shared.py"]
  6598ef7b_c8de_afd2_19f8_8a88b5fb5900 -->|defined in| 3e898b29_4dd8_c417_2d9b_a84d867423b4
  style 6598ef7b_c8de_afd2_19f8_8a88b5fb5900 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/_compat/shared.py lines 180–189

def is_pydantic_v1_model_instance(obj: Any) -> bool:
    # TODO: remove this function once the required version of Pydantic fully
    # removes pydantic.v1
    try:
        with warnings.catch_warnings():
            warnings.simplefilter("ignore", UserWarning)
            from pydantic import v1
    except ImportError:  # pragma: no cover
        return False
    return isinstance(obj, v1.BaseModel)