[Python-checkins] r73624 - python/branches/py3k/Doc/library/io.rst

benjamin.peterson python-checkins at python.org
Sun Jun 28 19:32:20 CEST 2009


Author: benjamin.peterson
Date: Sun Jun 28 19:32:20 2009
New Revision: 73624

Log:
document BufferedIOBase.raw and TextIOBase.buffer

Modified:
   python/branches/py3k/Doc/library/io.rst

Modified: python/branches/py3k/Doc/library/io.rst
==============================================================================
--- python/branches/py3k/Doc/library/io.rst	(original)
+++ python/branches/py3k/Doc/library/io.rst	Sun Jun 28 19:32:20 2009
@@ -359,9 +359,15 @@
    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 @@
       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.


More information about the Python-checkins mailing list