Stowage/msgpack-python
2
0
Fork 0
mirror of https://github.com/msgpack/msgpack-python.git synced 2025-11-04 19:40:57 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add note about use_list.

Browse source
This commit is contained in:
INADA Naoki 2012-12-06 22:26:39 +09:00
parent a1577a8838
commit 15f309c0b1
1 changed files with 24 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.rst
View file

@ -42,6 +42,9 @@ To unpack it to list, Use ``use_list`` option.
>>> msgpack.unpackb(b'\x93\x01\x02\x03', use_list=True) >>> msgpack.unpackb(b'\x93\x01\x02\x03', use_list=True)
[1, 2, 3] [1, 2, 3]
The default behavior will be changed in the future. (probably 0.4)
You should always pass the ``use_list`` keyword argument.
Read the docstring for other options. Read the docstring for other options.
@ -151,6 +154,27 @@ or Windows SDK on Windows. (NOTE: Visual C++ Express 2010 doesn't support
amd64. Windows SDK is recommanded way to build amd64 msgpack without any fee.) amd64. Windows SDK is recommanded way to build amd64 msgpack without any fee.)
PERFORMANCE NOTE
-----------------
GC
^^
CPython's GC starts when growing allocated object.
This means unpacking may cause useless GC.
You can use ``gc.disable()`` when unpacking large message.
use_list
^^^^^^^^^
List is the default sequence type of Python.
But tuple is lighter than list.
You can use ``use_list=False`` while unpacking when performance is important.
Python's dict can't use list as key and MessagePack allows array for key of mapping.
``use_list=False`` allows unpacking such message.
Another way to unpacking such object is using ``object_pairs_hook``.
TEST TEST
---- ----
MessagePack uses `nosetest` for testing. MessagePack uses `nosetest` for testing.