Stowage/msgpack-python
2
0
Fork 0
mirror of https://github.com/msgpack/msgpack-python.git synced 2025-10-31 09:30:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve docstrings.

Browse source
This commit is contained in:
INADA Naoki 2012-12-10 00:39:04 +09:00
parent c7161e9403
commit 4480227e06
1 changed files with 23 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

27
msgpack/_msgpack.pyx
View file

@ -426,6 +426,7 @@ cdef class Unpacker(object):
init_ctx(&self.ctx, object_hook, object_pairs_hook, list_hook, use_list, cenc, cerr)
def feed(self, object next_bytes):
"""Append `next_bytes` to internal buffer."""
cdef char* buf
cdef Py_ssize_t buf_len
if self.file_like is not None:
@ -523,7 +524,11 @@ cdef class Unpacker(object):
"""
unpack one object
If write_bytes is not None, it will be called with parts of the raw message as it is unpacked.
If write_bytes is not None, it will be called with parts of the raw
message as it is unpacked.
When there are not enough bytes for unpacking, `unpack()` raises
`OutOfData` Exception.
"""
return self._unpack(template_construct, write_bytes)
@ -531,16 +536,30 @@ cdef class Unpacker(object):
"""
read and ignore one object, returning None
If write_bytes is not None, it will be called with parts of the raw message as it is unpacked.
If write_bytes is not None, it will be called with parts of the raw
message as it is unpacked.
When there are not enough bytes for unpacking, `unpack()` raises
`OutOfData` Exception.
"""
return self._unpack(template_skip, write_bytes)
def read_array_header(self, object write_bytes=None):
"""assuming the next object is an array, return its size n, such that the next n unpack() calls will iterate over its contents."""
"""assuming the next object is an array, return its size n, such that
the next n unpack() calls will iterate over its contents.
When there are not enough bytes for unpacking, `unpack()` raises
`OutOfData` Exception.
"""
return self._unpack(read_array_header, write_bytes)
def read_map_header(self, object write_bytes=None):
"""assuming the next object is a map, return its size n, such that the next n * 2 unpack() calls will iterate over its key-value pairs."""
"""assuming the next object is a map, return its size n, such that the
next n * 2 unpack() calls will iterate over its key-value pairs.
When there are not enough bytes for unpacking, `unpack()` raises
`OutOfData` Exception.
"""
return self._unpack(read_map_header, write_bytes)
def __iter__(self):