Stowage/msgpack-python
2
0
Fork 0
mirror of https://github.com/msgpack/msgpack-python.git synced 2025-10-20 04:13:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update docstring

Browse source
This commit is contained in:
Inada Naoki 2020-12-04 17:23:09 +09:00
parent 8fb709f2e0
commit 44bc2bd439
3 changed files with 63 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

25
msgpack/fallback.py
View file

@ -744,7 +744,7 @@ class Packer(object):
"""
MessagePack Packer
Usage:
Usage::
packer = Packer()
astream.write(packer.pack(a))
@ -784,6 +784,29 @@ class Packer(object):
:param str unicode_errors:
The error handler for encoding unicode. (default: 'strict')
DO NOT USE THIS!! This option is kept for very specific usage.
Example of streaming deserialize from file-like object::
unpacker = Unpacker(file_like)
for o in unpacker:
process(o)
Example of streaming deserialize from socket::
unpacker = Unpacker()
while True:
buf = sock.recv(1024**2)
if not buf:
break
unpacker.feed(buf)
for o in unpacker:
process(o)
Raises ``ExtraData`` when *packed* contains extra bytes.
Raises ``OutOfData`` when *packed* is incomplete.
Raises ``FormatError`` when *packed* is not valid msgpack.
Raises ``StackError`` when *packed* contains too nested.
Other exceptions can be raised during unpacking.
"""
def __init__(