Add NOTE for changing default value of use_list.

This commit is contained in:
INADA Naoki 2012-12-07 11:35:16 +09:00
parent f8d7dea762
commit dd5c76b955
3 changed files with 16 additions and 3 deletions

View file

@ -2,6 +2,12 @@
=====
:release date: in development
Inconpatible Changes
--------------------
* 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.
Changes
-------
* Add ``.skip()`` method to ``Unpacker`` (thanks to jnothman)

View file

@ -3,8 +3,8 @@ MessagePack Python Binding
===========================
:author: INADA Naoki
:version: 0.2.0
:date: 2012-06-27
:version: 0.3.0
:date: 2012-12-07
.. image:: https://secure.travis-ci.org/msgpack/msgpack-python.png
:target: https://travis-ci.org/#!/msgpack/msgpack-python
@ -16,6 +16,13 @@ WHAT IT IS
similar data to JSON. This package provides CPython bindings for reading and
writing MessagePack data.
NOTE for msgpack 0.2.x users
----------------------------
The default value of ``use_list`` keyword argument is ``True`` from 0.3.x.
You should pass the argument explicitly for backward compatibility.
HOW TO USE
-----------

View file

@ -327,7 +327,7 @@ cdef class Unpacker(object):
`read_size` is used as `file_like.read(read_size)`.
(default: min(1024**2, max_buffer_size))
If `use_list` is true, msgpack list is deserialized to Python list.
If `use_list` is true (default), msgpack list is deserialized to Python list.
Otherwise, it is deserialized to Python tuple.
`object_hook` is same to simplejson. If it is not None, it should be callable