djangoflash.codec — Flash serialization codecs

This package provides some built-in flash serialization codecs.

djangoflash.codec.get_codec(module)

Creates and returns the codec defined in the given module path (ex: "myapp.mypackage.mymodule"). The argument can also be an alias to a built-in codec, such as "json", "json_zlib" or "pickle".

BaseCodec Class

class djangoflash.codec.BaseCodec

Bases: object

Base codec implementation. All codec implementations must extend this class.

decode(encoded_flash)

Empty implementation that raises NotImplementedError.

decode_signed(encoded_flash)

Restores the flash object from the given encoded-and-signed data.

encode(flash)

Empty implementation that raises NotImplementedError.

encode_and_sign(flash)

Returns an encoded-and-signed version of the given flash.

Built-in serialization codecs

• djangoflash.codec.json_impl — JSON-based codec implementation
• djangoflash.codec.json_zlib_impl — JSON/zlib-based codec implementation
• djangoflash.codec.pickle_impl — Pickle-based codec implementation

See also

Django-Flash overview