API Reference

read_msgpack(path_or_buf[, encoding, iterator])	Load msgpack pandas object from the specified
to_msgpack(path_or_buf, *args, **kwargs)	msgpack (serialize) object to input file path

pandas_msgpack.read_msgpack(path_or_buf, encoding='utf-8', iterator=False, **kwargs)

Load msgpack pandas object from the specified file path

Parameters:

path_or_buf : string File path, BytesIO like or string

encoding: Encoding for decoding msgpack str type

iterator : boolean, if True, return an iterator to the unpacker

(default is False)

Returns:

obj : type of object stored in file

pandas_msgpack.to_msgpack(path_or_buf, *args, **kwargs)

msgpack (serialize) object to input file path

Parameters:

path_or_buf : string File path, buffer-like, or None

if None, return generated string

args : an object or objects to serialize

encoding: encoding for unicode objects

append : boolean whether to append to an existing msgpack

(default is False)

compress : type of compressor (zlib or blosc), default to None (no

compression)