Skip to content

Commit 4b237e3

Browse files
committed
Specify which I/O ABC methods have implementations in the docs.
2 parents 746d043 + f04d1bb commit 4b237e3

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

Doc/library/io.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,25 @@ interface to a buffered raw stream (:class:`BufferedIOBase`). Finally,
185185
Argument names are not part of the specification, and only the arguments of
186186
:func:`open` are intended to be used as keyword arguments.
187187

188+
The following table summarizes the ABCs provided by the :mod:`io` module:
189+
190+
========================= ================== ======================== ==================================================
191+
ABC Inherits Stub Methods Mixin Methods and Properties
192+
========================= ================== ======================== ==================================================
193+
:class:`IOBase` ``fileno``, ``seek``, ``close``, ``closed``, ``__enter__``,
194+
and ``truncate`` ``__exit__``, ``flush``, ``isatty``, ``__iter__``,
195+
``__next__``, ``readable``, ``readline``,
196+
``readlines``, ``seekable``, ``tell``,
197+
``writable``, and ``writelines``
198+
:class:`RawIOBase` :class:`IOBase` ``readinto`` and Inherited :class:`IOBase` methods, ``read``,
199+
``write`` and ``readall``
200+
:class:`BufferedIOBase` :class:`IOBase` ``detach``, ``read``, Inherited :class:`IOBase` methods, ``readinto``
201+
``read1``, and ``write``
202+
:class:`TextIOBase` :class:`IOBase` ``detach``, ``read``, Inherited :class:`IOBase` methods, ``encoding``,
203+
``readline``, and ``errors``, and ``newlines``
204+
``write``
205+
========================= ================== ======================== ==================================================
206+
188207

189208
I/O Base Classes
190209
^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)