Recommend max_buffer_len instead of max_(str|bin|ext)_len

This commit is contained in:
Inada Naoki 2019-01-25 21:27:46 +09:00
parent 9951b89455
commit 280308e8ce
3 changed files with 34 additions and 13 deletions

View file

@ -208,12 +208,12 @@ class Unpacker(object):
You should set this parameter when unpacking data from untrusted source.
:param int max_str_len:
(deprecated) Limits max length of str.
(default: max_buffer_size or 1024*1024)
Deprecated, use *max_buffer_size* instead.
Limits max length of str. (default: max_buffer_size or 1024*1024)
:param int max_bin_len:
(deprecated) Limits max length of bin.
(default: max_buffer_size or 1024*1024)
Deprecated, use *max_buffer_size* instead.
Limits max length of bin. (default: max_buffer_size or 1024*1024)
:param int max_array_len:
Limits max length of array.
@ -224,18 +224,18 @@ class Unpacker(object):
(default: max_buffer_size//2 or 32*1024)
:param int max_ext_len:
(deprecated) Limits max size of ext type.
(default: max_buffer_size or 1024*1024)
Deprecated, use *max_buffer_size* instead.
Limits max size of ext type. (default: max_buffer_size or 1024*1024)
example of streaming deserialize from file-like object::
Example of streaming deserialize from file-like object::
unpacker = Unpacker(file_like, raw=False)
unpacker = Unpacker(file_like, raw=False, max_buffer_size=10*1024*1024)
for o in unpacker:
process(o)
example of streaming deserialize from socket::
Example of streaming deserialize from socket::
unpacker = Unpacker(raw=False)
unpacker = Unpacker(raw=False, max_buffer_size=10*1024*1024)
while True:
buf = sock.recv(1024**2)
if not buf: