pydantic.functional_serializers
This module contains related classes and functions for serialization.
Bases: PydanticErrorMixin, NameError
A subclass of NameError raised when handling undefined annotations during CoreSchema generation.
Default: name
@classmethod
def from_name_error(cls, name_error: NameError) -> Self
Convert a NameError to a PydanticUndefinedAnnotation error.
Self — Converted PydanticUndefinedAnnotation error.
NameError to be converted.
Plain serializers use a function to modify the output of serialization.
Type: core_schema.SerializerFunction
Type: Any Default: PydanticUndefined
Type: Literal['always', 'unless-none', 'json', 'json-unless-none'] Default: 'always'
def __get_pydantic_core_schema__(
source_type: Any,
handler: _annotated_handlers.GetCoreSchemaHandler,
) -> core_schema.CoreSchema
Gets the Pydantic core schema.
core_schema.CoreSchema — The Pydantic core schema.
The source type.
The GetCoreSchemaHandler instance.
Wrap serializers receive the raw inputs along with a handler function that applies the standard serialization logic, and can modify the resulting value before returning it as the final output of serialization.
Type: core_schema.WrapSerializerFunction
Type: Any Default: PydanticUndefined
Type: Literal['always', 'unless-none', 'json', 'json-unless-none'] Default: 'always'
def __get_pydantic_core_schema__(
source_type: Any,
handler: _annotated_handlers.GetCoreSchemaHandler,
) -> core_schema.CoreSchema
This method is used to get the Pydantic core schema of the class.
core_schema.CoreSchema — The generated core schema of the class.
Source type.
Core schema handler.
def field_serializer(
__field: str,
fields: str = (),
return_type: Any = ...,
when_used: Literal['always', 'unless-none', 'json', 'json-unless-none'] = ...,
check_fields: bool | None = ...,
) -> Callable[[_PlainSerializeMethodType], _PlainSerializeMethodType]
def field_serializer(
__field: str,
fields: str = (),
mode: Literal['plain'],
return_type: Any = ...,
when_used: Literal['always', 'unless-none', 'json', 'json-unless-none'] = ...,
check_fields: bool | None = ...,
) -> Callable[[_PlainSerializeMethodType], _PlainSerializeMethodType]
def field_serializer(
__field: str,
fields: str = (),
mode: Literal['wrap'],
return_type: Any = ...,
when_used: Literal['always', 'unless-none', 'json', 'json-unless-none'] = ...,
check_fields: bool | None = ...,
) -> Callable[[_WrapSerializeMethodType], _WrapSerializeMethodType]
Decorator that enables custom field serialization.
See Custom serializers for more information.
Four signatures are supported:
(self, value: Any, info: FieldSerializationInfo)(self, value: Any, nxt: SerializerFunctionWrapHandler, info: FieldSerializationInfo)(value: Any, info: SerializationInfo)(value: Any, nxt: SerializerFunctionWrapHandler, info: SerializationInfo)
Callable[[Any], Any] — The decorator function.
Which field(s) the method should be called on.
The serialization mode.
plainmeans the function will be called instead of the default serialization logic,wrapmeans the function will be called with an argument to optionally call the default serialization logic.
Optional return type for the function, if omitted it will be inferred from the type annotation.
Determines the serializer will be used for serialization.
Whether to check that the fields actually exist on the model.
def model_serializer(__f: FuncType) -> FuncType
def model_serializer(
mode: Literal['plain', 'wrap'] = ...,
when_used: Literal['always', 'unless-none', 'json', 'json-unless-none'] = 'always',
return_type: Any = ...,
) -> Callable[[FuncType], FuncType]
Decorator that enables custom model serialization.
See Custom serializers for more information.
Callable[[Any], Any] — The decorator function.
The function to be decorated.
The serialization mode.
'plain'means the function will be called instead of the default serialization logic'wrap'means the function will be called with an argument to optionally call the default serialization logic.
Determines when this serializer should be used.
The return type for the function. If omitted it will be inferred from the type annotation.
Default: TypeVar('FuncType', bound=(Callable[..., Any]))
Default: TypeVar('AnyType')