Skip to content

Commit 82dfad3

Browse files
committed
Fix New I/O Library refernces
1 parent e65c236 commit 82dfad3

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

Doc/whatsnew/2.6.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1029,7 +1029,7 @@ PEP 3116: New I/O Library
10291029

10301030
Python's built-in file objects support a number of methods, but
10311031
file-like objects don't necessarily support all of them. Objects that
1032-
imitate files usually support :meth:`read` and :meth:`write`, but they
1032+
imitate files usually support :meth:`~io.TextIOBase.read` and :meth:`~io.TextIOBase.write`, but they
10331033
may not support :meth:`readline`, for example. Python 3.0 introduces
10341034
a layered I/O library in the :mod:`io` module that separates buffering
10351035
and text-handling features from the fundamental read and write
@@ -1038,47 +1038,47 @@ operations.
10381038
There are three levels of abstract base classes provided by
10391039
the :mod:`io` module:
10401040

1041-
* :class:`RawIOBase` defines raw I/O operations: :meth:`read`,
1042-
:meth:`readinto`,
1043-
:meth:`write`, :meth:`seek`, :meth:`tell`, :meth:`truncate`,
1044-
and :meth:`close`.
1041+
* :class:`~io.RawIOBase` defines raw I/O operations: :meth:`~io.RawIOBase.read`,
1042+
:meth:`~io.RawIOBase.readinto`,
1043+
:meth:`~io.RawIOBase.write`, :meth:`~io.IOBase.seek`, :meth:`~io.IOBase.tell`, :meth:`~io.IOBase.truncate`,
1044+
and :meth:`~io.IOBase.close`.
10451045
Most of the methods of this class will often map to a single system call.
1046-
There are also :meth:`readable`, :meth:`writable`, and :meth:`seekable`
1046+
There are also :meth:`~io.IOBase.readable`, :meth:`~io.IOBase.writable`, and :meth:`~io.IOBase.seekable`
10471047
methods for determining what operations a given object will allow.
10481048

10491049
Python 3.0 has concrete implementations of this class for files and
10501050
sockets, but Python 2.6 hasn't restructured its file and socket objects
10511051
in this way.
10521052

1053-
* :class:`BufferedIOBase` is an abstract base class that
1053+
* :class:`~io.BufferedIOBase` is an abstract base class that
10541054
buffers data in memory to reduce the number of
10551055
system calls used, making I/O processing more efficient.
1056-
It supports all of the methods of :class:`RawIOBase`,
1057-
and adds a :attr:`raw` attribute holding the underlying raw object.
1056+
It supports all of the methods of :class:`~io.RawIOBase`,
1057+
and adds a :attr:`~io.BufferedIOBase.raw` attribute holding the underlying raw object.
10581058

10591059
There are five concrete classes implementing this ABC.
1060-
:class:`BufferedWriter` and :class:`BufferedReader` are for objects
1061-
that support write-only or read-only usage that have a :meth:`seek`
1062-
method for random access. :class:`BufferedRandom` objects support
1060+
:class:`~io.BufferedWriter` and :class:`~io.BufferedReader` are for objects
1061+
that support write-only or read-only usage that have a :meth:`~io.IOBase.seek`
1062+
method for random access. :class:`~io.BufferedRandom` objects support
10631063
read and write access upon the same underlying stream, and
1064-
:class:`BufferedRWPair` is for objects such as TTYs that have both
1064+
:class:`~io.BufferedRWPair` is for objects such as TTYs that have both
10651065
read and write operations acting upon unconnected streams of data.
1066-
The :class:`BytesIO` class supports reading, writing, and seeking
1066+
The :class:`~io.BytesIO` class supports reading, writing, and seeking
10671067
over an in-memory buffer.
10681068

10691069
.. index::
10701070
single: universal newlines; What's new
10711071

1072-
* :class:`TextIOBase`: Provides functions for reading and writing
1072+
* :class:`~io.TextIOBase`: Provides functions for reading and writing
10731073
strings (remember, strings will be Unicode in Python 3.0),
1074-
and supporting :term:`universal newlines`. :class:`TextIOBase` defines
1074+
and supporting :term:`universal newlines`. :class:`~io.TextIOBase` defines
10751075
the :meth:`readline` method and supports iteration upon
10761076
objects.
10771077

1078-
There are two concrete implementations. :class:`TextIOWrapper`
1078+
There are two concrete implementations. :class:`~io.TextIOWrapper`
10791079
wraps a buffered I/O object, supporting all of the methods for
1080-
text I/O and adding a :attr:`buffer` attribute for access
1081-
to the underlying object. :class:`StringIO` simply buffers
1080+
text I/O and adding a :attr:`~io.TextIOBase.buffer` attribute for access
1081+
to the underlying object. :class:`~io.StringIO` simply buffers
10821082
everything in memory without ever writing anything to disk.
10831083

10841084
(In Python 2.6, :class:`io.StringIO` is implemented in

0 commit comments

Comments
 (0)