summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorINADA Naoki <songofacandy@gmail.com>2015-01-14 10:02:55 +0900
committerINADA Naoki <songofacandy@gmail.com>2015-01-14 10:02:55 +0900
commit5025b51d3bd77a681576fcfb9cec8fe1ba5cce34 (patch)
treee7ce523e6d2ded923edbe87dd7f42b00ea100419
parentd14a7885c773ddf05e4431f3b43e506eb77de593 (diff)
parent35947630b72c5fabd5bec8b482fff41cdbad7094 (diff)
downloadmsgpack-python-5025b51d3bd77a681576fcfb9cec8fe1ba5cce34.tar.gz
Merge branch 'master' of github.com:msgpack/msgpack-python
-rw-r--r--README.rst22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index ae19984..1481681 100644
--- a/README.rst
+++ b/README.rst
@@ -8,6 +8,10 @@ MessagePack for Python
.. image:: https://secure.travis-ci.org/msgpack/msgpack-python.png
:target: https://travis-ci.org/#!/msgpack/msgpack-python
+
+.. image:: https://pypip.in/version/msgpack-python/badge.svg
+ :target: https://pypi.python.org/pypi/msgpack-python/
+ :alt: Latest Version
What's this
------------
@@ -52,6 +56,8 @@ It is non-string binary like Python 3's ``bytes``.
To use *bin* type for packing ``bytes``, pass ``use_bin_type=True`` to
packer argument.
+.. code-block:: pycon
+
>>> import msgpack
>>> packed = msgpack.packb([b'spam', u'egg'], use_bin_type=True)
>>> msgpack.unpackb(packed, encoding='utf-8')
@@ -62,6 +68,8 @@ binary can be unpacked by unpackers supporting msgpack-2.0.
To use *ext* type, pass ``msgpack.ExtType`` object to packer.
+.. code-block:: pycon
+
>>> import msgpack
>>> packed = msgpack.packb(msgpack.ExtType(42, b'xyzzy'))
>>> msgpack.unpackb(packed)
@@ -95,7 +103,7 @@ msgpack provides ``dumps`` and ``loads`` as alias for compatibility with
``pack`` and ``dump`` packs to file-like object.
``unpack`` and ``load`` unpacks from file-like object.
-::
+.. code-block:: pycon
>>> import msgpack
>>> msgpack.packb([1, 2, 3])
@@ -103,7 +111,9 @@ msgpack provides ``dumps`` and ``loads`` as alias for compatibility with
>>> msgpack.unpackb(_)
[1, 2, 3]
-``unpack`` unpacks msgpack's array to Python's list, but can unpack to tuple::
+``unpack`` unpacks msgpack's array to Python's list, but can unpack to tuple:
+
+.. code-block:: pycon
>>> msgpack.unpackb(b'\x93\x01\x02\x03', use_list=False)
(1, 2, 3)
@@ -119,7 +129,7 @@ Streaming unpacking
``Unpacker`` is a "streaming unpacker". It unpacks multiple objects from one
stream (or from bytes provided through its ``feed`` method).
-::
+.. code-block:: python
import msgpack
from io import BytesIO
@@ -141,7 +151,7 @@ Packing/unpacking of custom data type
It is also possible to pack/unpack custom data types. Here is an example for
``datetime.datetime``.
-::
+.. code-block:: python
import datetime
@@ -175,6 +185,8 @@ Extended types
It is also possible to pack/unpack custom data types using the msgpack 2.0 feature.
+.. code-block:: pycon
+
>>> import msgpack
>>> import array
>>> def default(obj):
@@ -209,7 +221,7 @@ in a map, can be unpacked or skipped individually.
Each of these methods may optionally write the packed data it reads to a
callback function:
-::
+.. code-block:: python
from io import BytesIO