document BufferedIOBase.raw and TextIOBase.buffer

This commit is contained in:
Benjamin Peterson 2009-06-28 17:32:20 +00:00
parent 0289b15820
commit c609b6b04b
1 changed files with 13 additions and 1 deletions

View File

@ -359,9 +359,15 @@ I/O Base Classes
implementation, but wrap one like :class:`BufferedWriter` and
:class:`BufferedReader`.
:class:`BufferedIOBase` provides or overrides these methods in addition to
:class:`BufferedIOBase` provides or overrides these members in addition to
those from :class:`IOBase`:
.. attribute:: raw
The underlying raw stream (a :class:`RawIOBase` instance) that
:class:`BufferedIOBase` deals with. This is not part of the
:class:`BufferedIOBase` API and may not exist on some implementations.
.. method:: detach()
Separate the underlying raw stream from the buffer and return it.
@ -607,6 +613,12 @@ Text I/O
A string, a tuple of strings, or ``None``, indicating the newlines
translated so far.
.. attribute:: buffer
The underlying binary buffer (a :class:`BufferedIOBase` instance) that
:class:`TextIOBase` deals with. This is not part of the
:class:`TextIOBase` API and may not exist on some implementations.
.. method:: detach()
Separate the underlying buffer from the :class:`TextIOBase` and return it.