diff options
| author | Antoine Pitrou <solipsis@pitrou.net> | 2011-10-12 18:57:23 +0200 |
|---|---|---|
| committer | Antoine Pitrou <solipsis@pitrou.net> | 2011-10-12 18:57:23 +0200 |
| commit | f55011f8b63d3b046c1ec580312bc52ca47d721b (patch) | |
| tree | 67dc37443d86d918ac91681c083c1d83d3c3e09b | |
| parent | 442ee03d35870216b45150512a0dc384409b39ff (diff) | |
| download | cpython-git-f55011f8b63d3b046c1ec580312bc52ca47d721b.tar.gz | |
Update doc for BlockingIOError and its alias in the io module
| -rw-r--r-- | Doc/library/exceptions.rst | 9 | ||||
| -rw-r--r-- | Doc/library/io.rst | 12 |
2 files changed, 11 insertions, 10 deletions
diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst index 67f2c63bdc..ca8e4d8b6d 100644 --- a/Doc/library/exceptions.rst +++ b/Doc/library/exceptions.rst @@ -396,6 +396,15 @@ depending on the system error code. Corresponds to :c:data:`errno` ``EAGAIN``, ``EALREADY``, ``EWOULDBLOCK`` and ``EINPROGRESS``. + In addition to those of :exc:`OSError`, :exc:`BlockingIOError` can have + one more attribute: + + .. attribute:: characters_written + + An integer containing the number of characters written to the stream + before it blocked. This attribute is available when using the + buffered I/O classes from the :mod:`io` module. + .. exception:: ChildProcessError Raised when an operation on a child process failed. diff --git a/Doc/library/io.rst b/Doc/library/io.rst index 76c856edad..86faa5827b 100644 --- a/Doc/library/io.rst +++ b/Doc/library/io.rst @@ -109,16 +109,8 @@ High-level Module Interface .. exception:: BlockingIOError - Error raised when blocking would occur on a non-blocking stream. It inherits - :exc:`IOError`. - - In addition to those of :exc:`IOError`, :exc:`BlockingIOError` has one - attribute: - - .. attribute:: characters_written - - An integer containing the number of characters written to the stream - before it blocked. + This is a compatibility alias for the builtin :exc:`BlockingIOError` + exception. .. exception:: UnsupportedOperation |