(ABCs). You can then use :func:`isinstance` and :func:`issubclass` to check
whether an instance or a class implements a particular ABC. The
:mod:`collections.abc` module defines a set of useful ABCs such as
-:class:`Iterable`, :class:`Container`, and :class:`MutableMapping`.
+:class:`~collections.abc.Iterable`, :class:`~collections.abc.Container`, and
+:class:`~collections.abc.MutableMapping`.
For Python, many of the advantages of interface specifications can be obtained
by an appropriate test discipline for components. There is also a tool,
of partial coding sequences. The work of implementing this has already been
done for you: the built-in :func:`open` function can return a file-like object
that assumes the file's contents are in a specified encoding and accepts Unicode
-parameters for methods such as :meth:`read` and :meth:`write`. This works through
-:func:`open`\'s *encoding* and *errors* parameters which are interpreted just
-like those in :meth:`str.encode` and :meth:`bytes.decode`.
+parameters for methods such as :meth:`~io.TextIOBase.read` and
+:meth:`~io.TextIOBase.write`. This works through:func:`open`\'s *encoding* and
+*errors* parameters which are interpreted just like those in :meth:`str.encode`
+and :meth:`bytes.decode`.
Reading Unicode from a file is therefore simple::
and behaving like a stream returning data in encoding #2.
For example, if you have an input file *f* that's in Latin-1, you
-can wrap it with a :class:`StreamRecoder` to return bytes encoded in UTF-8::
+can wrap it with a :class:`~codecs.StreamRecoder` to return bytes encoded in
+UTF-8::
new_f = codecs.StreamRecoder(f,
# en/decoder: used by read() to encode its results and
html = response.read()
If you wish to retrieve a resource via URL and store it in a temporary location,
-you can do so via the :func:`urlretrieve` function::
+you can do so via the :func:`~urllib.request.urlretrieve` function::
import urllib.request
local_filename, headers = urllib.request.urlretrieve('http://python.org/')
Converts the use of iterator's :meth:`~iterator.next` methods to the
:func:`next` function. It also renames :meth:`next` methods to
- :meth:`~object.__next__`.
+ :meth:`~iterator.__next__`.
.. 2to3fixer:: nonzero
- Renames :meth:`~object.__nonzero__` to :meth:`~object.__bool__`.
+ Renames :meth:`__nonzero__` to :meth:`~object.__bool__`.
.. 2to3fixer:: numliterals
equivalent to calling :func:`_thread.exit`.
* Not all built-in functions that may block waiting for I/O allow other threads
- to run. (The most popular ones (:func:`time.sleep`, :meth:`file.read`,
+ to run. (The most popular ones (:func:`time.sleep`, :meth:`io.FileIO.read`,
:func:`select.select`) work as expected.)
* It is not possible to interrupt the :meth:`acquire` method on a lock --- the
MyIterable.register(Foo)
The ABC ``MyIterable`` defines the standard iterable method,
- :meth:`__iter__`, as an abstract method. The implementation given here can
- still be called from subclasses. The :meth:`get_iterator` method is also
- part of the ``MyIterable`` abstract base class, but it does not have to be
- overridden in non-abstract derived classes.
+ :meth:`~iterator.__iter__`, as an abstract method. The implementation given
+ here can still be called from subclasses. The :meth:`get_iterator` method
+ is also part of the ``MyIterable`` abstract base class, but it does not have
+ to be overridden in non-abstract derived classes.
The :meth:`__subclasshook__` class method defined here says that any class
- that has an :meth:`__iter__` method in its :attr:`__dict__` (or in that of
- one of its base classes, accessed via the :attr:`__mro__` list) is
- considered a ``MyIterable`` too.
+ that has an :meth:`~iterator.__iter__` method in its
+ :attr:`~object.__dict__` (or in that of one of its base classes, accessed
+ via the :attr:`~class.__mro__` list) is considered a ``MyIterable`` too.
Finally, the last line makes ``Foo`` a virtual subclass of ``MyIterable``,
- even though it does not define an :meth:`__iter__` method (it uses the
- old-style iterable protocol, defined in terms of :meth:`__len__` and
+ even though it does not define an :meth:`~iterator.__iter__` method (it uses
+ the old-style iterable protocol, defined in terms of :meth:`__len__` and
:meth:`__getitem__`). Note that this will not make ``get_iterator``
available as a method of ``Foo``, so it is provided separately.
channels have been closed. All arguments are optional. The *count*
parameter defaults to None, resulting in the loop terminating only when all
channels have been closed. The *timeout* argument sets the timeout
- parameter for the appropriate :func:`select` or :func:`poll` call, measured
- in seconds; the default is 30 seconds. The *use_poll* parameter, if true,
- indicates that :func:`poll` should be used in preference to :func:`select`
- (the default is ``False``).
+ parameter for the appropriate :func:`~select.select` or :func:`~select.poll`
+ call, measured in seconds; the default is 30 seconds. The *use_poll*
+ parameter, if true, indicates that :func:`~select.poll` should be used in
+ preference to :func:`~select.select` (the default is ``False``).
The *map* parameter is a dictionary whose items are the channels to watch.
As channels are closed they are deleted from their map. If *map* is
transmit the data but also the state. Note that you should send the *initial*
state (the one you passed to :func:`lin2adpcm`) along to the decoder, not the
final state (as returned by the coder). If you want to use
-:func:`struct.struct` to store the state in binary you can code the first
+:class:`struct.Struct` to store the state in binary you can code the first
element (the predicted value) in 16 bits and the second (the delta index) in 8.
The ADPCM coders have never been tried against other ADPCM coders, only against
.. function:: timegm(tuple)
- An unrelated but handy function that takes a time tuple such as returned by the
- :func:`gmtime` function in the :mod:`time` module, and returns the corresponding
- Unix timestamp value, assuming an epoch of 1970, and the POSIX encoding. In
- fact, :func:`time.gmtime` and :func:`timegm` are each others' inverse.
+ An unrelated but handy function that takes a time tuple such as returned by
+ the :func:`~time.gmtime` function in the :mod:`time` module, and returns the
+ corresponding Unix timestamp value, assuming an epoch of 1970, and the POSIX
+ encoding. In fact, :func:`time.gmtime` and :func:`timegm` are each others'
+ inverse.
The :mod:`calendar` module exports the following data attributes:
Class which represents a chunk. The *file* argument is expected to be a
file-like object. An instance of this class is specifically allowed. The
- only method that is needed is :meth:`read`. If the methods :meth:`seek` and
- :meth:`tell` are present and don't raise an exception, they are also used.
+ only method that is needed is :meth:`~io.IOBase.read`. If the methods
+ :meth:`~io.IOBase.seek` and :meth:`~io.IOBase.tell` are present and don't
+ raise an exception, they are also used.
If these methods are present and raise an exception, they are expected to not
have altered the object. If the optional argument *align* is true, chunks
are assumed to be aligned on 2-byte boundaries. If *align* is false, no
.. function:: interact(banner=None, readfunc=None, local=None)
- Convenience function to run a read-eval-print loop. This creates a new instance
- of :class:`InteractiveConsole` and sets *readfunc* to be used as the
- :meth:`raw_input` method, if provided. If *local* is provided, it is passed to
- the :class:`InteractiveConsole` constructor for use as the default namespace for
- the interpreter loop. The :meth:`interact` method of the instance is then run
- with *banner* passed as the banner to use, if provided. The console object is
- discarded after use.
+ Convenience function to run a read-eval-print loop. This creates a new
+ instance of :class:`InteractiveConsole` and sets *readfunc* to be used as
+ the :meth:`InteractiveConsole.raw_input` method, if provided. If *local* is
+ provided, it is passed to the :class:`InteractiveConsole` constructor for
+ use as the default namespace for the interpreter loop. The :meth:`interact`
+ method of the instance is then run with *banner* passed as the banner to
+ use, if provided. The console object is discarded after use.
.. function:: compile_command(source, filename="<input>", symbol="single")
The various functions or classes take the following arguments:
*encode* and *decode*: These must be functions or methods which have the same
- interface as the :meth:`encode`/:meth:`decode` methods of Codec instances (see
- Codec Interface). The functions/methods are expected to work in a stateless
- mode.
+ interface as the :meth:`~Codec.encode`/:meth:`~Codec.decode` methods of Codec
+ instances (see :ref:`Codec Interface <codec-objects>`). The functions/methods
+ are expected to work in a stateless mode.
*incrementalencoder* and *incrementaldecoder*: These have to be factory
functions providing the following interface:
The :class:`Codec` class defines the interface for stateless encoders/decoders.
-To simplify and standardize error handling, the :meth:`encode` and
-:meth:`decode` methods may implement different error handling schemes by
+To simplify and standardize error handling, the :meth:`~Codec.encode` and
+:meth:`~Codec.decode` methods may implement different error handling schemes by
providing the *errors* string argument. The following string values are defined
and implemented by all standard Python codecs:
The :class:`IncrementalEncoder` and :class:`IncrementalDecoder` classes provide
the basic interface for incremental encoding and decoding. Encoding/decoding the
input isn't done with one call to the stateless encoder/decoder function, but
-with multiple calls to the :meth:`encode`/:meth:`decode` method of the
-incremental encoder/decoder. The incremental encoder/decoder keeps track of the
-encoding/decoding process during method calls.
-
-The joined output of calls to the :meth:`encode`/:meth:`decode` method is the
-same as if all the single inputs were joined into one, and this input was
+with multiple calls to the
+:meth:`~IncrementalEncoder.encode`/:meth:`~IncrementalDecoder.decode` method of
+the incremental encoder/decoder. The incremental encoder/decoder keeps track of
+the encoding/decoding process during method calls.
+
+The joined output of calls to the
+:meth:`~IncrementalEncoder.encode`/:meth:`~IncrementalDecoder.decode` method is
+the same as if all the single inputs were joined into one, and this input was
encoded/decoded with the stateless encoder/decoder.
.. class:: Iterator
- ABC for classes that provide the :meth:`__iter__` and :meth:`__next__` methods.
- See also the definition of :term:`iterator`.
+ ABC for classes that provide the :meth:`~iterator.__iter__` and
+ :meth:`~iterator.__next__` methods. See also the definition of
+ :term:`iterator`.
.. class:: Sequence
MutableSequence
Equality tests between :class:`OrderedDict` objects are order-sensitive
and are implemented as ``list(od1.items())==list(od2.items())``.
Equality tests between :class:`OrderedDict` objects and other
-:class:`Mapping` objects are order-insensitive like regular dictionaries.
-This allows :class:`OrderedDict` objects to be substituted anywhere a
-regular dictionary is used.
+:class:`~collections.abc.Mapping` objects are order-insensitive like regular
+dictionaries. This allows :class:`OrderedDict` objects to be substituted
+anywhere a regular dictionary is used.
The :class:`OrderedDict` constructor and :meth:`update` method both accept
keyword arguments, but their order is lost because Python's function call
parser.
:mod:`configparser` objects behave as close to actual dictionaries as possible.
-The mapping interface is complete and adheres to the ``MutableMapping`` ABC.
+The mapping interface is complete and adheres to the
+:class:`~collections.abc.MutableMapping` ABC.
However, there are a few differences that should be taken into account:
* By default, all keys in sections are accessible in a case-insensitive manner
database has to be created. It defaults to octal ``0o666`` (and will be modified
by the prevailing umask).
- In addition to the methods provided by the :class:`collections.MutableMapping` class,
- :class:`dumbdbm` objects provide the following method:
+ In addition to the methods provided by the
+ :class:`collections.abc.MutableMapping` class, :class:`dumbdbm` objects
+ provide the following method:
.. method:: dumbdbm.sync()
By default, the diff control lines (those with ``***`` or ``---``) are created
with a trailing newline. This is helpful so that inputs created from
- :func:`file.readlines` result in diffs that are suitable for use with
- :func:`file.writelines` since both the inputs and outputs have trailing
+ :func:`io.IOBase.readlines` result in diffs that are suitable for use with
+ :func:`io.IOBase.writelines` since both the inputs and outputs have trailing
newlines.
For inputs that do not have trailing newlines, set the *lineterm* argument to
By default, the diff control lines (those with ``---``, ``+++``, or ``@@``) are
created with a trailing newline. This is helpful so that inputs created from
- :func:`file.readlines` result in diffs that are suitable for use with
- :func:`file.writelines` since both the inputs and outputs have trailing
+ :func:`io.IOBase.readlines` result in diffs that are suitable for use with
+ :func:`io.IOBase.writelines` since both the inputs and outputs have trailing
newlines.
For inputs that do not have trailing newlines, set the *lineterm* argument to
Compare two sequences of lines, and generate the delta (a sequence of lines).
- Each sequence must contain individual single-line strings ending with newlines.
- Such sequences can be obtained from the :meth:`readlines` method of file-like
- objects. The delta generated also consists of newline-terminated strings, ready
- to be printed as-is via the :meth:`writelines` method of a file-like object.
+ Each sequence must contain individual single-line strings ending with
+ newlines. Such sequences can be obtained from the
+ :meth:`~io.IOBase.readlines` method of file-like objects. The delta
+ generated also consists of newline-terminated strings, ready to be
+ printed as-is via the :meth:`~io.IOBase.writelines` method of a
+ file-like object.
.. _differ-examples:
This example compares two texts. First we set up the texts, sequences of
individual single-line strings ending with newlines (such sequences can also be
-obtained from the :meth:`readlines` method of file-like objects):
+obtained from the :meth:`~io.BaseIO.readlines` method of file-like objects):
>>> text1 = ''' 1. Beautiful is better than ugly.
... 2. Explicit is better than implicit.
.. exception:: EOFError
- Raised when one of the built-in functions (:func:`input` or :func:`raw_input`)
- hits an end-of-file condition (EOF) without reading any data. (N.B.: the
- :meth:`file.read` and :meth:`file.readline` methods return an empty string
- when they hit EOF.)
+ Raised when the :func:`input` function hits an end-of-file condition (EOF)
+ without reading any data. (N.B.: the :meth:`io.IOBase.read` and
+ :meth:`io.IOBase.readline` methods return an empty string when they hit EOF.)
.. exception:: FloatingPointError
executed, and so that a debugger can execute a script without running the risk
of losing control. The :func:`os._exit` function can be used if it is
absolutely positively necessary to exit immediately (for example, in the child
- process after a call to :func:`fork`).
+ process after a call to :func:`os.fork`).
The exception inherits from :exc:`BaseException` instead of :exc:`Exception` so
that it is not accidentally caught by code that catches :exc:`Exception`. This
.. exception:: BytesWarning
- Base class for warnings related to :class:`bytes` and :class:`buffer`.
+ Base class for warnings related to :class:`bytes` and :class:`bytearray`.
.. exception:: ResourceWarning
Class :class:`FileInput` is the implementation; its methods :meth:`filename`,
:meth:`fileno`, :meth:`lineno`, :meth:`filelineno`, :meth:`isfirstline`,
- :meth:`isstdin`, :meth:`nextfile` and :meth:`close` correspond to the functions
- of the same name in the module. In addition it has a :meth:`readline` method
- which returns the next input line, and a :meth:`__getitem__` method which
- implements the sequence behavior. The sequence must be accessed in strictly
- sequential order; random access and :meth:`readline` cannot be mixed.
+ :meth:`isstdin`, :meth:`nextfile` and :meth:`close` correspond to the
+ functions of the same name in the module. In addition it has a
+ :meth:`~io.TextIOBase.readline` method which returns the next input line,
+ and a :meth:`__getitem__` method which implements the sequence behavior.
+ The sequence must be accessed in strictly sequential order; random access
+ and :meth:`~io.TextIOBase.readline` cannot be mixed.
With *mode* you can specify which file mode will be passed to :func:`open`. It
must be one of ``'r'``, ``'rU'``, ``'U'`` and ``'rb'``.
Store a file in binary transfer mode. *cmd* should be an appropriate
``STOR`` command: ``"STOR filename"``. *file* is a :term:`file object`
- (opened in binary mode) which is read until EOF using its :meth:`read`
+ (opened in binary mode) which is read until EOF using its :meth:`~io.IOBase.read`
method in blocks of size *blocksize* to provide the data to be stored.
The *blocksize* argument defaults to 8192. *callback* is an optional single
parameter callable that is called on each block of data after it is sent.
Store a file in ASCII transfer mode. *cmd* should be an appropriate
``STOR`` command (see :meth:`storbinary`). Lines are read until EOF from the
- :term:`file object` *file* (opened in binary mode) using its :meth:`readline`
+ :term:`file object` *file* (opened in binary mode) using its :meth:`~io.IOBase.readline`
method to provide the data to be stored. *callback* is an optional single
parameter callable that is called on each line after it is sent.
.. class:: HTTPServer(server_address, RequestHandlerClass)
- This class builds on the :class:`TCPServer` class by storing the server
- address as instance variables named :attr:`server_name` and
+ This class builds on the :class:`~socketserver.TCPServer` class by storing
+ the server address as instance variables named :attr:`server_name` and
:attr:`server_port`. The server is accessible by the handler, typically
through the handler's :attr:`server` instance variable.
file's contents are returned; otherwise a directory listing is generated
by calling the :meth:`list_directory` method. This method uses
:func:`os.listdir` to scan the directory, and returns a ``404`` error
- response if the :func:`listdir` fails.
+ response if the :func:`~os.listdir` fails.
If the request was mapped to a file, it is opened and the contents are
returned. Any :exc:`OSError` exception in opening the requested file is
Opens socket to *port* at *host*. This method is implicitly called by
the :class:`IMAP4` constructor. The connection objects established by this
- method will be used in the ``read``, ``readline``, ``send``, and ``shutdown``
- methods. You may override this method.
+ method will be used in the :meth:`IMAP4.read`, :meth:`IMAP4.readline`,
+ :meth:`IMAP4.send`, and :meth:`IMAP4.shutdown` methods. You may override
+ this method.
.. method:: IMAP4.partial(message_num, message_part, start, length)
that raise AttributeError). It can also return descriptors objects
instead of instance members.
- If the instance :attr:`__dict__` is shadowed by another member (for example a
- property) then this function will be unable to find instance members.
+ If the instance :attr:`~object.__dict__` is shadowed by another member (for
+ example a property) then this function will be unable to find instance
+ members.
.. versionadded:: 3.2
The abstract base classes also provide default implementations of some
methods in order to help implementation of concrete stream classes. For
example, :class:`BufferedIOBase` provides unoptimized implementations of
- ``readinto()`` and ``readline()``.
+ :meth:`~IOBase.readinto` and :meth:`~IOBase.readline`.
At the top of the I/O hierarchy is the abstract base class :class:`IOBase`. It
defines the basic interface to a stream. Note, however, that there is no
The basic type used for binary data read from or written to a file is
:class:`bytes`. :class:`bytearray`\s are accepted too, and in some cases
- (such as :class:`readinto`) required. Text I/O classes work with
+ (such as :meth:`readinto`) required. Text I/O classes work with
:class:`str` data.
Note that calling any method (even inquiries) on a closed stream is
.. function:: accumulate(iterable[, func])
Make an iterator that returns accumulated sums. Elements may be any addable
- type including :class:`Decimal` or :class:`Fraction`. If the optional
- *func* argument is supplied, it should be a function of two arguments
- and it will be used instead of addition.
+ type including :class:`~decimal.Decimal` or :class:`~fractions.Fraction`.
+ If the optional *func* argument is supplied, it should be a function of two
+ arguments and it will be used instead of addition.
Equivalent to::
Set the "From " line to *from_*, which should be specified without a
leading "From " or trailing newline. For convenience, *time_* may be
specified and will be formatted appropriately and appended to *from_*. If
- *time_* is specified, it should be a :class:`struct_time` instance, a
+ *time_* is specified, it should be a :class:`time.struct_time` instance, a
tuple suitable for passing to :meth:`time.strftime`, or ``True`` (to use
:meth:`time.gmtime`).
Set the "From " line to *from_*, which should be specified without a
leading "From " or trailing newline. For convenience, *time_* may be
specified and will be formatted appropriately and appended to *from_*. If
- *time_* is specified, it should be a :class:`struct_time` instance, a
+ *time_* is specified, it should be a :class:`time.struct_time` instance, a
tuple suitable for passing to :meth:`time.strftime`, or ``True`` (to use
:meth:`time.gmtime`).
Return the ceiling of *x*, the smallest integer greater than or equal to *x*.
If *x* is not a float, delegates to ``x.__ceil__()``, which should return an
- :class:`Integral` value.
+ :class:`~numbers.Integral` value.
.. function:: copysign(x, y)
Return the floor of *x*, the largest integer less than or equal to *x*.
If *x* is not a float, delegates to ``x.__floor__()``, which should return an
- :class:`Integral` value.
+ :class:`~numbers.Integral` value.
.. function:: fmod(x, y)
.. function:: trunc(x)
- Return the :class:`Real` value *x* truncated to an :class:`Integral` (usually
- an integer). Delegates to ``x.__trunc__()``.
+ Return the :class:`~numbers.Real` value *x* truncated to an
+ :class:`~numbers.Integral` (usually an integer). Delegates to
+ ``x.__trunc__()``.
Note that :func:`frexp` and :func:`modf` have a different call/return pattern
-----------
:mod:`msilib` provides several classes that wrap the GUI tables in an MSI
-database. However, no standard user interface is provided; use :mod:`bdist_msi`
-to create MSI files with a user-interface for installing Python packages.
+database. However, no standard user interface is provided; use
+:mod:`~distutils.command.bdist_msi` to create MSI files with a user-interface
+for installing Python packages.
.. class:: Control(dlg, name)
be used in a :keyword:`with` statement.
-The following methods each map to exactly one :func:`ioctl` system call. The
+The following methods each map to exactly one :c:func:`ioctl` system call. The
correspondence is obvious: for example, :meth:`setfmt` corresponds to the
``SNDCTL_DSP_SETFMT`` ioctl, and :meth:`sync` to ``SNDCTL_DSP_SYNC`` (this can
be useful when consulting the OSS documentation). If the underlying
-:func:`ioctl` fails, they all raise :exc:`OSError`.
+:c:func:`ioctl` fails, they all raise :exc:`OSError`.
.. method:: oss_audio_device.nonblock()
.. attribute:: ExpatError.code
Expat's internal error number for the specific error. The
- :data:`errors.messages` dictionary maps these error numbers to Expat's error
- messages. For example::
+ :data:`errors.messages <xml.parsers.expat.errors.messages>` dictionary maps
+ these error numbers to Expat's error messages. For example::
from xml.parsers.expat import ParserCreate, ExpatError, errors
except ExpatError as err:
print("Error:", errors.messages[err.code])
- The :mod:`errors` module also provides error message constants and a
- dictionary :data:`~errors.codes` mapping these messages back to the error
- codes, see below.
+ The :mod:`~xml.parsers.expat.errors` module also provides error message
+ constants and a dictionary :data:`~xml.parsers.expat.errors.codes` mapping
+ these messages back to the error codes, see below.
.. attribute:: ExpatError.lineno
.. class:: Shelf(dict, protocol=None, writeback=False, keyencoding='utf-8')
- A subclass of :class:`collections.MutableMapping` which stores pickled values
- in the *dict* object.
+ A subclass of :class:`collections.abc.MutableMapping` which stores pickled
+ values in the *dict* object.
By default, version 0 pickles are used to serialize values. The version of the
pickle protocol can be specified with the *protocol* parameter. See the
RCVALL_*
Constants for Windows' WSAIoctl(). The constants are used as arguments to the
- :meth:`ioctl` method of socket objects.
+ :meth:`~socket.socket.ioctl` method of socket objects.
.. data:: TIPC_*
the request handler class :meth:`handle` method.
Another approach to handling multiple simultaneous requests in an environment
-that supports neither threads nor :func:`fork` (or where these are too expensive
-or inappropriate for the service) is to maintain an explicit table of partially
-finished requests and to use :func:`select` to decide which request to work on
-next (or whether to handle a new incoming request). This is particularly
-important for stream services where each client can potentially be connected for
-a long time (if threads or subprocesses cannot be used). See :mod:`asyncore`
-for another way to manage this.
+that supports neither threads nor :func:`~os.fork` (or where these are too
+expensive or inappropriate for the service) is to maintain an explicit table of
+partially finished requests and to use :func:`~select.select` to decide which
+request to work on next (or whether to handle a new incoming request). This is
+particularly important for stream services where each client can potentially be
+connected for a long time (if threads or subprocesses cannot be used). See
+:mod:`asyncore` for another way to manage this.
.. XXX should data and methods be intermingled, or separate?
how should the distinction between class and instance variables be drawn?
-:mod:`stat` --- Interpreting :func:`stat` results
-=================================================
+:mod:`stat` --- Interpreting :func:`~os.stat` results
+=====================================================
.. module:: stat
:synopsis: Utilities for interpreting the results of os.stat(),
Read until one from a list of a regular expressions matches.
The first argument is a list of regular expressions, either compiled
- (:class:`re.RegexObject` instances) or uncompiled (byte strings). The
+ (:ref:`regex objects <re-objects>`) or uncompiled (byte strings). The
optional second argument is a timeout, in seconds; the default is to block
indefinitely.
of many format specifiers in :func:`strftime` and :func:`strptime`.
Module :mod:`calendar`
- General calendar-related functions. :func:`timegm` is the inverse of
- :func:`gmtime` from this module.
+ General calendar-related functions. :func:`~calendar.timegm` is the
+ inverse of :func:`gmtime` from this module.
.. rubric:: Footnotes
Accessing any attribute not in this list will raise an `AttributeError`.
If `spec` is an object (rather than a list of strings) then
- :attr:`__class__` returns the class of the spec object. This allows mocks
- to pass `isinstance` tests.
+ :attr:`~instance.__class__` returns the class of the spec object. This
+ allows mocks to pass `isinstance` tests.
* `spec_set`: A stricter variant of `spec`. If used, attempting to *set*
or get an attribute on the mock that isn't on the object passed as
default) then a `MagicMock` will be created for you, with the API limited
to methods or attributes available on standard file handles.
- `read_data` is a string for the `read` method of the file handle to return.
- This is an empty string by default.
+ `read_data` is a string for the `~io.IOBase.read` method of the file handle
+ to return. This is an empty string by default.
Using `open` as a context manager is a great way to ensure your file handles
are closed properly and is becoming common::
| | Unicode. |
+----------------------------------+-----------------------------------------------+
| :exc:`BytesWarning` | Base category for warnings related to |
-| | :class:`bytes` and :class:`buffer`. |
+| | :class:`bytes` and :class:`bytearray`. |
+----------------------------------+-----------------------------------------------+
| :exc:`ResourceWarning` | Base category for warnings related to |
| | resource usage. |
.. note::
The file-like object is read-only and provides the following methods:
- :meth:`!read`, :meth:`!readline`, :meth:`!readlines`, :meth:`!__iter__`,
- :meth:`!__next__`.
+ :meth:`~io.BufferedIOBase.read`, :meth:`~io.IOBase.readline`,
+ :meth:`~io.IOBase.readlines`, :meth:`__iter__`,
+ :meth:`~iterator.__next__`.
.. note::
Documentation
-------------
+- Issue #18758: Fixed and improved cross-references.
+
- Issue #18743: Fix references to non-existant "StringIO" module.
- Issue #18783: Removed existing mentions of Python long type in docstrings,
projects / python / commitdiff