Release Date: 2020-02-17
- Remove Python 2 support from the
msgpack/_cmsgpack.
msgpack/fallback still supports Python 2.
- Remove
encoding option from the Packer and Unpacker.
- Unpacker: The default value of
max_buffer_size is changed to 100MiB.
- Unpacker:
strict_map_key is True by default now.
- Unpacker: String map keys are interned.
- Drop old buffer protocol support.
- Support Timestamp type.
- Support serializing and decerializing
datetime object
with tzinfo.
- Unpacker:
Fix Unpacker.read_bytes() in fallback implementation. (#352)
Release Date: 2019-09-20
- Support Python 3.8.
- Update Cython to 0.29.13 for support Python 3.8.
- Some small optimizations.
Release Date: 2019-01-25
This release is for mitigating pain caused by v0.6.0 reduced max input limits
for security reason.
unpackb(data) configures max_*_len options from len(data),
instead of static default sizes.Unpacker(max_buffer_len=N) configures max_*_len options from N,
instead of static default sizes.max_bin_len, max_str_len, and max_ext_len are deprecated.
Since this is minor release, it's document only deprecation.
Release Date: 2018-11-30
This release contains some backward incompatible changes for security reason (DoS).
- unpacker: Default value of input limits are smaller than before to avoid DoS attack.
If you need to handle large data, you need to specify limits manually. (#319)
- Unpacker doesn't wrap underlaying
ValueError (including UnicodeError) into
UnpackValueError. If you want to catch all exception during unpack, you need
to use try ... except Exception with minimum try code block. (#323, #233)
PackValueError and PackOverflowError are also removed. You need to catch
normal ValueError and OverflowError. (#323, #233)- Unpacker has
strict_map_key option now. When it is true, only bytes and str
(unicode in Python 2) are allowed for map keys. It is recommended to avoid
hashdos. Default value of this option is False for backward compatibility reason.
But it will be changed True in 1.0. (#296, #334)
- Extension modules are merged. There is
msgpack._cmsgpack instead of
msgpack._packer and msgpack._unpacker. (#314, #328)
- Add
Unpacker.getbuffer() method. (#320)
- unpacker:
msgpack.StackError is raised when input data contains too
nested data. (#331)
- unpacker:
msgpack.FormatError is raised when input data is not valid
msgpack format. (#331)
- Fix fallback.Unpacker.feed() dropped unused data from buffer (#287)
- Resurrect fallback.unpack() and _unpacker.unpack().
They were removed at 0.5.5 but it breaks backward compatibility. (#288, #290)
- Fix memory leak in pure Python Unpacker.feed() (#283)
- Fix unpack() didn't support raw option (#285)
- Undeprecate
unicode_errors option. (#278)
- Fixed regression when passing
unicode_errors to Packer but not encoding. (#277)
- Add
raw option to Unpacker. It is preferred way than encoding option.
- Packer.pack() reset buffer on exception (#274)
- Remove FutureWarning about use_bin_type option (#271)
There are some deprecations. Please read changes carefully.
- Drop Python 2.6 and ~3.4 support. Python 2.7 and 3.5+ are supported.
- Deprecate useless custom exceptions. Use ValueError instead of PackValueError,
Exception instead of PackException and UnpackException, etc...
See msgpack/exceptions.py
- Add strict_types option to packer. It can be used to serialize subclass of
builtin types. For example, when packing object which type is subclass of dict,
default() is called. default() is called for tuple too.
- Pure Python implementation supports packing memoryview object.
- Support packing bytearray.
- Add
Unpacker.tell(). And write_bytes option is deprecated.
- Fixed zero length raw can't be decoded when encoding is specified. (#236)
- Calling ext_hook with wrong length. (Only on Windows, maybe. #203)
- Memory leak when unpack is failed
- Reduce compiler warnings while building extension module
- unpack() now accepts ext_hook argument like Unpacker and unpackb()
- Update Cython version to 0.23.4
- default function is called when integer overflow
- fallback.Unpacker: Fix Data corruption when OutOfData.
This bug only affects "Streaming unpacking."
- Fix test failure on pytest 2.3. (by @ktdreyer)
- Fix typos in ChangeLog. (Thanks to @dmick)
- Improve README.rst (by @msabramo)
- Unpacker may unpack wrong uint32 value on 32bit or LLP64 environment. (#101)
- Build failed on Windows Python 2.7.
- Unpacker doesn't increment refcount of ExtType hook.
- Packer raises no exception for inputs doesn't fit to msgpack format.
- fallback.Unpacker.feed() supports bytearray.
- Unpacker doesn't increment refcount of hooks. Hooks may be GCed while unpacking.
- Unpacker may read unfilled internal buffer.
- Raises TypeError instead of ValueError when packer receives unsupported type.
- Support New msgpack spec.
- Default value of
use_list is True for now. (It was False for 0.2.x)
You should pass it explicitly for compatibility to 0.2.x.
- Unpacker.unpack() and some unpack methods now raise OutOfData instead of
StopIteration. StopIteration is used for iterator protocol only.
- Pure Python fallback module is added. (thanks to bwesterb)
- Add
.skip() method to Unpacker (thanks to jnothman)
- Add capturing feature. You can pass the writable object to
Unpacker.unpack() as a second parameter.
- Add
Packer.pack_array_header and Packer.pack_map_header.
These methods only pack header of each type.
- Add
autoreset option to Packer (default: True).
Packer doesn't return packed bytes and clear internal buffer.
- Add
Packer.pack_map_pairs. It packs sequence of pair to map type.
- Fix SEGV when object_hook or object_pairs_hook raise Exception. (#39)
- Warn when use_list is not specified. It's default value will be changed in 0.3.
- Can't pack subclass of dict.
- Add
use_single_float option to Packer. When it is true, packs float
object in single precision format.
unpack() didn't restores gc state when it called with gc disabled.
unpack() doesn't control gc now instead of restoring gc state collectly.
User can control gc state when gc cause performance issue.Unpacker's read_size option didn't used.
- Add
max_buffer_size parameter to Unpacker. It limits internal buffer size
and allows unpack data from untrusted source safely.
- Unpacker's buffer reallocation algorithm is less greedy now. It cause performance
decrease in rare case but memory efficient and don't allocate than
max_buffer_size.
- Fix msgpack didn't work on SPARC Solaris. It was because choosing wrong byteorder
on compilation time. Use
sys.byteorder to get correct byte order.
Very thanks to Chris Casey for giving test environment to me.
- Drop supporting Python 2.5 and unify tests for Py2 and Py3.
- Use new version of msgpack-c. It packs correctly on big endian platforms.
- Remove deprecated packs and unpacks API.
- #8 Packing subclass of dict raises TypeError. (Thanks to Steeve Morin.)
- Don't accept subtype of list and tuple as msgpack list. (Steeve Morin)
It allows customize how it serialized with
default argument.
- Fix wrong error message. (David Wolever)
- Fix memory leak while unpacking when
object_hook or list_hook is used.
(Steeve Morin)
- setup.py works on Python 2.5 (Steffen Siering)
- Optimization for serializing dict.
- Re-enable packs/unpacks removed at 0.1.11. It will be removed when 0.2 is released.
- Include test code for Python3 to sdist. (Johan Bergström)
- Fix compilation error on MSVC. (davidgaleano)
- Add
encoding and unicode_errors option to packer and unpacker.
When this option is specified, (un)packs unicode object instead of bytes.
This enables using msgpack as a replacement of json. (tailhook)
use_list option is added to unpack(b) like Unpacker.
(Use keyword argument because order of parameters are different)
- Fix typo.
- Add MemoryError check.
- Support
loads and dumps aliases for API compatibility with
simplejson and pickle.
- Add object_hook and list_hook option to unpacker. It allows you to
hook unpacking mapping type and array type.
- Add default option to packer. It allows you to pack unsupported types.
- unpacker accepts (old) buffer types.
- Fix segv around
Unpacker.feed or Unpacker(file).
- Add object_hook and list_hook option to unpacker. It allows you to
hook unpacking mapping type and array type.
- Add default option to packer. It allows you to pack unsupported types.
- unpacker accepts (old) buffer types.
- Compilation error on win32.