Pydantic · Decorator
computed_field
@computed_field adds a property or cached property to serialized Pydantic models and dataclasses. It is useful for derived values and values that should be cached.
Last updated
Syntax
computed_field(func: PropertyT, /) -> PropertyT
computed_field(*, alias: str | None = None, alias_priority: int | None = None, exclude_if: Callable[[Any], bool] | None = None, title: str | None = None, field_title_generator: Callable[[str, ComputedFieldInfo], str] | None = None, description: str | None = None, deprecated: Deprecated | str | bool | None = None, examples: list[Any] | None = None, json_schema_extra: JsonDict | Callable[[JsonDict], None] | None = None, repr: bool = True, return_type: Any = PydanticUndefined) -> Callable[[PropertyT], PropertyT]In-depth API docs are only for subscribers: parameters, examples, common mistakes and interview practice.
SubscribeRelated
BaseModelFieldComputedFieldInfocached_propertymodel_dump