]> granicus.if.org Git - python/commitdiff
Specify which I/O ABC methods have implementations in the docs.
authorAndrew Svetlov <andrew.svetlov@gmail.com>
Thu, 6 Dec 2012 10:20:56 +0000 (12:20 +0200)
committerAndrew Svetlov <andrew.svetlov@gmail.com>
Thu, 6 Dec 2012 10:20:56 +0000 (12:20 +0200)
Doc/library/io.rst

index 62eaf6d7be3c610cc447050a0239d89bf6d1b418..7cab6850e61c97c17b4ec8d420f19124bf33de19 100644 (file)
@@ -189,6 +189,25 @@ interface to a buffered raw stream (:class:`BufferedIOBase`). Finally,
 Argument names are not part of the specification, and only the arguments of
 :func:`open` are intended to be used as keyword arguments.
 
+The following table summarizes the ABCs provided by the :mod:`io` module:
+
+=========================  ==================  ========================  ==================================================
+ABC                        Inherits            Stub Methods              Mixin Methods and Properties
+=========================  ==================  ========================  ==================================================
+:class:`IOBase`                                ``fileno``, ``seek``,     ``close``, ``closed``, ``__enter__``,
+                                               and ``truncate``          ``__exit__``, ``flush``, ``isatty``, ``__iter__``,
+                                                                         ``__next__``, ``readable``, ``readline``,
+                                                                         ``readlines``, ``seekable``, ``tell``,
+                                                                         ``writable``, and ``writelines``
+:class:`RawIOBase`         :class:`IOBase`     ``readinto`` and          Inherited :class:`IOBase` methods, ``read``,
+                                               ``write``                 and ``readall``
+:class:`BufferedIOBase`    :class:`IOBase`     ``detach``, ``read``,     Inherited :class:`IOBase` methods, ``readinto``
+                                               ``read1``, and ``write``
+:class:`TextIOBase`        :class:`IOBase`     ``detach``, ``read``,     Inherited :class:`IOBase` methods, ``encoding``,
+                                               ``readline``, and         ``errors``, and ``newlines``
+                                               ``write``
+=========================  ==================  ========================  ==================================================
+
 
 I/O Base Classes
 ^^^^^^^^^^^^^^^^