Serializers¶

class cachelib.serializers.BaseSerializer¶

Bases: object

This is the base interface for all default serializers.

BaseSerializer.load and BaseSerializer.dump will default to pickle.load and pickle.dump. This is currently used only by FileSystemCache which dumps/loads to/from a file stream.

dump(value, f, protocol=pickle.HIGHEST_PROTOCOL)¶

Parameters:

value (int)
f (IO[bytes])
protocol (int)

Return type:

None

load(f)¶

Parameters:: f (BinaryIO)
Return type:: Any

dumps(value, protocol=pickle.HIGHEST_PROTOCOL)¶

Parameters:

value (Any)
protocol (int)

Return type:

bytes | None

loads(bvalue)¶

Parameters:: bvalue (bytes)
Return type:: Any

class cachelib.serializers.BaseRedisSerializer¶

Bases: BaseSerializer

Base serializer for Redis compatible caches.

dumps(value, protocol=pickle.HIGHEST_PROTOCOL)¶

Dumps an object into a string for redis. Integers are stored as plain ASCII so they remain compatible with the native INCRBY/DECRBY operations used by inc()/dec(); everything else is pickled.

Parameters:

value (Any)
protocol (int)

Return type:

bytes

loads(value)¶

The reversal of dumps(). This might be called with None.

Parameters:: value (bytes | None)
Return type:: Any

class cachelib.serializers.JSONSerializer¶

Bases: BaseSerializer

Generic JSON serializer for caches.

Use this serializer if you want to serialize to JSON instead of pickle. Note that JSON does not support serialization of Python bytes objects. If you need to cache bytes, use the default pickle-based serializer. This serializer is not used by default.

dump(value, f, *args, **kwargs)¶