graph LR
reducer_override["reducer_override"]
_should_pickle_by_reference["_should_pickle_by_reference"]
_is_registered_pickle_by_value["_is_registered_pickle_by_value"]
_save_reduce_pickle5["_save_reduce_pickle5"]
save_global["save_global"]
save_function["save_function"]
_should_pickle_by_reference -- "queries" --> _is_registered_pickle_by_value
save_global -- "consults" --> _should_pickle_by_reference
save_function -- "consults" --> _should_pickle_by_reference
save_global -- "calls" --> _save_reduce_pickle5
save_function -- "calls" --> _save_reduce_pickle5
The Pickle Protocol Integration subsystem in cloudpickle is responsible for managing the interaction with Python's standard pickle module, determining when cloudpickle's custom serialization logic should be applied versus when to defer to pickle's default behavior. This ensures compatibility while extending pickle's capabilities for complex Python objects.
The primary entry point and dispatcher for cloudpickle's custom serialization logic, intercepting the standard pickling process. It acts as a central hub, directing the pickling process to cloudpickle's specialized reduction methods for specific object types that require custom handling.
Related Classes/Methods:
The core decision-making component that determines whether an object requires cloudpickle's custom value-based serialization or can be handled by standard pickle's reference-based serialization. It serves as a crucial gatekeeper, deciding whether an object should be serialized by reference or by value.
Related Classes/Methods:
A helper component that supports _should_pickle_by_reference by checking if an object type has been explicitly marked for custom value-based pickling. It provides a lookup mechanism for value-based serialization registrations.
Related Classes/Methods:
Encapsulates the specific custom serialization logic for objects when using Pickle Protocol 5, handling the actual byte-level representation for cloudpickle-specific objects. It implements the actual custom serialization logic for objects requiring specialized handling.
Related Classes/Methods:
Manages the custom saving process for global objects, deciding the appropriate serialization strategy (custom vs. default) and invoking the relevant custom logic. It orchestrates decision-making and delegates to appropriate custom serialization logic.
Related Classes/Methods:
Manages the custom saving process for function objects, similar to save_global, determining the serialization strategy and delegating to custom logic when necessary. It handles custom saving for functions, including closures and dynamically created functions.
Related Classes/Methods: