asyncio: document the IncompleteReadError exception

This commit is contained in:
Victor Stinner 2014-01-27 11:58:49 +01:00
parent 9a2e75be24
commit b7f19ff94b
1 changed files with 20 additions and 1 deletions

View File

@ -98,7 +98,10 @@ StreamReader
.. method:: readexactly(n)
XXX
Read exactly *n* bytes. Raise an :exc:`IncompleteReadError` if the end of
the stream is reached before *n* can be read, the
:attr:`IncompleteReadError.partial` attribute of the exception contains
the partial read bytes.
This method returns a :ref:`coroutine object <coroutine>`.
@ -208,6 +211,22 @@ StreamReaderProtocol
XXX
IncompleteReadError
===================
.. exception:: IncompleteReadError
Incomplete read error.
.. attribute:: expected
Total number of expected bytes (:class:`int`).
.. attribute:: partial
Read bytes string before the end of stream was reached (:class:`bytes`).
Example
=======