extension ¤

Bases: Extension

Griffe extension for Pydantic.

Parameters:

• schema (bool, default: False ) –

  Whether to compute and store the JSON schema of models.

Methods:

• on_attribute_instance –

  Handle Pydantic fields.

• on_class_instance –

  Detect and prepare Pydantic models.

• on_class_members –

  Finalize the Pydantic model data.

• on_function_instance –

  Handle Pydantic field validators.

• on_package_loaded –

  Detect models once the whole package is loaded.

on_attribute_instance(
    *, node: AST | ObjectNode, attr: Attribute
) -> None

on_class_instance(
    *, node: AST | ObjectNode, cls: Class
) -> None

on_class_members(
    *, node: AST | ObjectNode, cls: Class
) -> None

on_function_instance(
    *, node: AST | ObjectNode, func: Function
) -> None

on_package_loaded(*, pkg: Module) -> None