prefect.serializers

Serializer implementations for converting objects to bytes and bytes to objects.

All serializers are based on the Serializer class and include a type string that allows them to be referenced without referencing the actual class. For example, you can get often specify the JSONSerializer with the string "json". Some serializers support additional settings for configuration of serialization. These are stored on the instance so the same settings can be used to load saved objects.

All serializers must implement dumps and loads which convert objects to bytes and bytes to an object respectively.

Functions

prefect_json_object_encoder ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L59" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

prefect_json_object_encoder(obj: Any) -> Any

JSONEncoder.default for encoding objects into JSON with extended type support.

Raises a TypeError to fallback on other encoders on failure.

prefect_json_object_decoder ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L83" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

prefect_json_object_decoder(result: dict[str, Any]) -> Any

JSONDecoder.object_hook for decoding objects from JSON when previously encoded with prefect_json_object_encoder

Classes

Serializer ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L110" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A serializer that can encode objects of type 'D' into bytes.

Methods:

dumps ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L152" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

dumps(self, obj: D) -> bytes

Encode the object into a blob of bytes.

loads ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L156" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

loads(self, blob: bytes) -> D

Decode the blob of bytes into an object.

UnknownSerializer ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L168" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Opaque placeholder for serializers that are unavailable in the current process.

This allows persisted result metadata to be inspected without importing the custom serializer implementation. Actual serialization work still fails when attempted.

Methods:

dumps ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L184" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

dumps(self, obj: Any) -> bytes

dumps ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L152" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

dumps(self, obj: D) -> bytes

Encode the object into a blob of bytes.

loads ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L190" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

loads(self, blob: bytes) -> Any

loads ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L156" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

loads(self, blob: bytes) -> D

Decode the blob of bytes into an object.

PickleSerializer ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L197" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Serializes objects using the pickle protocol.

• Uses cloudpickle by default. See picklelib for using alternative libraries.
• Stores the version of the pickle library to check for compatibility during deserialization.
• Wraps pickles in base64 for safe transmission.

Methods:

check_picklelib ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L213" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

check_picklelib(cls, value: str) -> str

dumps ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L216" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

dumps(self, obj: D) -> bytes

loads ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L221" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

loads(self, blob: bytes) -> D

JSONSerializer ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L226" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Serializes data to JSON.

Input types must be compatible with the stdlib json library.

Wraps the json library to serialize to UTF-8 bytes instead of string types.

Methods:

dumps ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L270" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

dumps(self, obj: D) -> bytes

dumps_kwargs_cannot_contain_default ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L259" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

dumps_kwargs_cannot_contain_default(cls, value: dict[str, Any]) -> dict[str, Any]

loads ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L281" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

loads(self, blob: bytes) -> D

loads_kwargs_cannot_contain_object_hook ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L265" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

loads_kwargs_cannot_contain_object_hook(cls, value: dict[str, Any]) -> dict[str, Any]

CompressedSerializer ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L289" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Wraps another serializer, compressing its output. Uses lzma by default. See compressionlib for using alternative libraries.

Attributes:

• serializer: The serializer to use before compression.
• compressionlib: The import path of a compression module to use. Must have methods compress(bytes) -> bytes and decompress(bytes) -> bytes.
• level: If not null, the level of compression to pass to compress.

Methods:

check_compressionlib ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L311" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

check_compressionlib(cls, value: str) -> str

dumps ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L314" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

dumps(self, obj: D) -> bytes

loads ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L319" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

loads(self, blob: bytes) -> D

validate_serializer ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L307" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_serializer(cls, value: Union[str, Serializer[D]]) -> Serializer[D]

CompressedPickleSerializer ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L325" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A compressed serializer preconfigured to use the pickle serializer.

CompressedJSONSerializer ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/serializers.py#L335" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A compressed serializer preconfigured to use the json serializer.