summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2009-06-28 17:32:20 (GMT)
committerBenjamin Peterson <benjamin@python.org>2009-06-28 17:32:20 (GMT)
commitc609b6b04bae561b2178d82e5e7011c55e17b05f (patch)
treed2bb97a44438a1a60609a88d849079b3f66e6649
parent0289b15820f6b43ae55b3e4e8733f5dc05682bb2 (diff)
downloadcpython-c609b6b04bae561b2178d82e5e7011c55e17b05f.zip
cpython-c609b6b04bae561b2178d82e5e7011c55e17b05f.tar.gz
cpython-c609b6b04bae561b2178d82e5e7011c55e17b05f.tar.bz2
document BufferedIOBase.raw and TextIOBase.buffer
-rw-r--r--Doc/library/io.rst14
1 files changed, 13 insertions, 1 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 5866113..71d3f67 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -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.