Stowage/msgpack-python
2
0
Fork 0
mirror of https://github.com/msgpack/msgpack-python.git synced 2025-11-01 18:10:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add docstring about raising ValueError when there are extra bytes.

Browse source
This commit is contained in:
INADA Naoki 2012-09-23 11:16:59 +09:00
parent e8842efded
commit c3da845868
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
msgpack/_msgpack.pyx
View file

@ -217,8 +217,10 @@ cdef extern from "unpack.h":
def unpackb(object packed, object object_hook=None, object list_hook=None,
bint use_list=0, encoding=None, unicode_errors="strict",
):
"""Unpack packed_bytes to object. Returns an unpacked object.
Raises `ValueError` when `packed` contains extra bytes.
"""
Unpack packed_bytes to object. Returns an unpacked object."""
cdef template_context ctx
cdef size_t off = 0
cdef int ret
@ -268,14 +270,16 @@ def unpackb(object packed, object object_hook=None, object list_hook=None,
def unpack(object stream, object object_hook=None, object list_hook=None,
bint use_list=0, encoding=None, unicode_errors="strict",
):
"""
unpack an object from stream.
"""Unpack an object from `stream`.
Raises `ValueError` when `stream` has extra bytes.
"""
return unpackb(stream.read(), use_list=use_list,
object_hook=object_hook, list_hook=list_hook,
encoding=encoding, unicode_errors=unicode_errors,
)
cdef class Unpacker(object):
"""
Streaming unpacker.