Stowage/msgpack-python
2
0
Fork 0
mirror of https://github.com/msgpack/msgpack-python.git synced 2026-02-06 09:50:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

Warn about StopIteration in README

Browse source
This commit is contained in:
jnothman 2012-12-07 11:12:19 +11:00
parent 15f309c0b1
commit 56ef0d07de
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.rst
View file

@ -116,6 +116,9 @@ the result, or ignoring it. The latter two methods return the number of elements
in the upcoming container, so that each element in an array, or key-value pair
in a map, can be unpacked or skipped individually.
Warning: these methods raise ``StopIteration`` when called at the end of the
stream. Unless caught, this may silently break an iteration.
Each of these methods may optionally write the packed data it reads to a
callback function: