pydantic_settings.attrs_docs

Module Contents

pydantic_settings.attrs_docs.apply_attributes_docs(model: Type[AnyPydanticModel], *, override_existing: bool = True) → None

Apply model attributes documentation in-place. Resulted docs are placed inside field.schema.description for pydantic model field.

Parameters

• model – any pydantic model

• override_existing – override existing descriptions

pydantic_settings.attrs_docs.MC

pydantic_settings.attrs_docs.with_attrs_docs(model_cls: Type[MC]) → Type[MC]

pydantic_settings.attrs_docs.with_attrs_docs(*, override_existing: bool = True) → Callable[[Type[MC]], Type[MC]]

Applies apply_attributes_docs().