Functional Serializers
This module contains related classes and functions for serialization.
Plain serializers use a function to modify the output of serialization.
The serializer function.
Type: core_schema.SerializerFunction
The return type for the function. If omitted it will be inferred from the type annotation.
Type: Any
Determines when this serializer should be used. Accepts a string with values 'always',
'unless-none', 'json', and 'json-unless-none'. Defaults to ‘always’.
Type: Literal[‘always’, ‘unless-none’, ‘json’, ‘json-unless-none’]
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.
The serializer function to be wrapped.
Type: core_schema.WrapSerializerFunction
The return type for the function. If omitted it will be inferred from the type annotation.
Type: Any
Determines when this serializer should be used. Accepts a string with values 'always',
'unless-none', 'json', and 'json-unless-none'. Defaults to ‘always’.
Type: Literal[‘always’, ‘unless-none’, ‘json’, ‘json-unless-none’]
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.