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, using pickle by default.

Parameters:

• value (Any)

• protocol (int)

Return type:

bytes

loads(value)

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

Parameters:

value (bytes | None)

Return type:

Any

class cachelib.serializers.UWSGISerializer

Bases: BaseSerializer

Default serializer for UWSGICache.

class cachelib.serializers.SimpleSerializer

Bases: BaseSerializer

Default serializer for SimpleCache.

class cachelib.serializers.FileSystemSerializer

Bases: BaseSerializer

Default serializer for FileSystemCache.

class cachelib.serializers.RedisSerializer

Bases: BaseRedisSerializer

Default serializer for RedisCache.

class cachelib.serializers.ValkeySerializer

Bases: BaseRedisSerializer

Default serializer for ValkeyCache.

class cachelib.serializers.DynamoDbSerializer

Bases: RedisSerializer

Default serializer for DynamoDbCache.

loads(value)

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

Parameters:

value (Any)

Return type:

Any

class cachelib.serializers.MongoDbSerializer

Bases: BaseSerializer

Default serializer for MongoDbCache.