to interrupt an operation).
If the given signal isn't handled by Python (it was set to
- :data:`signal.SIG_DFL` or :data:`signal.SIG_IGN`), it will be ignored.
+ :py:const:`signal.SIG_DFL` or :py:const:`signal.SIG_IGN`), it will be ignored.
If *signum* is outside of the allowed range of signal numbers, ``-1``
is returned. Otherwise, ``0`` is returned. The error indicator is
Note on a bug in popen2: unless your program calls ``wait()`` or
``waitpid()``, finished child processes are never removed, and eventually
calls to popen2 will fail because of a limit on the number of child
- processes. Calling :func:`os.waitpid` with the :data:`os.WNOHANG` option can
+ processes. Calling :func:`os.waitpid` with the :const:`os.WNOHANG` option can
prevent this; a good place to insert such a call would be before calling
``popen2`` again.
python setup.py install --user
-Files will be installed into subdirectories of :data:`site.USER_BASE` (written
+Files will be installed into subdirectories of :const:`site.USER_BASE` (written
as :file:`{userbase}` hereafter). This scheme installs pure Python modules and
-extension modules in the same location (also known as :data:`site.USER_SITE`).
+extension modules in the same location (also known as :const:`site.USER_SITE`).
Here are the values for UNIX, including macOS:
=============== ===========================================================
there is no guarantee that the interruption will happen immediately.
If given, *signum* is the number of the signal to simulate.
- If *signum* is not given, :data:`signal.SIGINT` is simulated.
+ If *signum* is not given, :const:`signal.SIGINT` is simulated.
If the given signal isn't handled by Python (it was set to
- :data:`signal.SIG_DFL` or :data:`signal.SIG_IGN`), this function does
+ :const:`signal.SIG_DFL` or :const:`signal.SIG_IGN`), this function does
nothing.
.. versionchanged:: 3.10
In addition to enabling the debug mode, consider also:
* setting the log level of the :ref:`asyncio logger <asyncio-logger>` to
- :py:data:`logging.DEBUG`, for example the following snippet of code
+ :py:const:`logging.DEBUG`, for example the following snippet of code
can be run at startup of the application::
logging.basicConfig(level=logging.DEBUG)
asyncio uses the :mod:`logging` module and all logging is performed
via the ``"asyncio"`` logger.
-The default log level is :py:data:`logging.INFO`, which can be easily
+The default log level is :py:const:`logging.INFO`, which can be easily
adjusted::
logging.getLogger("asyncio").setLevel(logging.WARNING)
Open a streaming transport connection to a given
address specified by *host* and *port*.
- The socket family can be either :py:data:`~socket.AF_INET` or
- :py:data:`~socket.AF_INET6` depending on *host* (or the *family*
+ The socket family can be either :py:const:`~socket.AF_INET` or
+ :py:const:`~socket.AF_INET6` depending on *host* (or the *family*
argument, if provided).
- The socket type will be :py:data:`~socket.SOCK_STREAM`.
+ The socket type will be :py:const:`~socket.SOCK_STREAM`.
*protocol_factory* must be a callable returning an
:ref:`asyncio protocol <asyncio-protocol>` implementation.
.. versionchanged:: 3.6
- The socket option :py:data:`~socket.TCP_NODELAY` is set by default
+ The socket option :py:const:`~socket.TCP_NODELAY` is set by default
for all TCP connections.
.. versionchanged:: 3.7
Create a datagram connection.
- The socket family can be either :py:data:`~socket.AF_INET`,
- :py:data:`~socket.AF_INET6`, or :py:data:`~socket.AF_UNIX`,
+ The socket family can be either :py:const:`~socket.AF_INET`,
+ :py:const:`~socket.AF_INET6`, or :py:const:`~socket.AF_UNIX`,
depending on *host* (or the *family* argument, if provided).
- The socket type will be :py:data:`~socket.SOCK_DGRAM`.
+ The socket type will be :py:const:`~socket.SOCK_DGRAM`.
*protocol_factory* must be a callable returning a
:ref:`protocol <asyncio-protocol>` implementation.
* *reuse_port* tells the kernel to allow this endpoint to be bound to the
same port as other existing endpoints are bound to, so long as they all
set this flag when being created. This option is not supported on Windows
- and some Unixes. If the :py:data:`~socket.SO_REUSEPORT` constant is not
+ and some Unixes. If the :py:const:`~socket.SO_REUSEPORT` constant is not
defined then this capability is unsupported.
* *allow_broadcast* tells the kernel to allow this endpoint to send
.. versionchanged:: 3.8.1
The *reuse_address* parameter is no longer supported, as using
- :py:data:`~sockets.SO_REUSEADDR` poses a significant security concern for
+ :py:const:`~sockets.SO_REUSEADDR` poses a significant security concern for
UDP. Explicitly passing ``reuse_address=True`` will raise an exception.
When multiple processes with differing UIDs assign sockets to an
For supported platforms, *reuse_port* can be used as a replacement for
similar functionality. With *reuse_port*,
- :py:data:`~sockets.SO_REUSEPORT` is used instead, which specifically
+ :py:const:`~sockets.SO_REUSEPORT` is used instead, which specifically
prevents processes with differing UIDs from assigning sockets to the same
socket address.
Create a Unix connection.
- The socket family will be :py:data:`~socket.AF_UNIX`; socket
- type will be :py:data:`~socket.SOCK_STREAM`.
+ The socket family will be :py:const:`~socket.AF_UNIX`; socket
+ type will be :py:const:`~socket.SOCK_STREAM`.
A tuple of ``(transport, protocol)`` is returned on success.
ssl_shutdown_timeout=None, \
start_serving=True)
- Create a TCP server (socket type :data:`~socket.SOCK_STREAM`) listening
+ Create a TCP server (socket type :const:`~socket.SOCK_STREAM`) listening
on *port* of the *host* address.
Returns a :class:`Server` object.
be selected (note that if *host* resolves to multiple network interfaces,
a different random port will be selected for each interface).
- * *family* can be set to either :data:`socket.AF_INET` or
- :data:`~socket.AF_INET6` to force the socket to use IPv4 or IPv6.
+ * *family* can be set to either :const:`socket.AF_INET` or
+ :const:`~socket.AF_INET6` to force the socket to use IPv4 or IPv6.
If not set, the *family* will be determined from host name
- (defaults to :data:`~socket.AF_UNSPEC`).
+ (defaults to :const:`~socket.AF_UNSPEC`).
* *flags* is a bitmask for :meth:`getaddrinfo`.
.. versionchanged:: 3.6
Added *ssl_handshake_timeout* and *start_serving* parameters.
- The socket option :py:data:`~socket.TCP_NODELAY` is set by default
+ The socket option :py:const:`~socket.TCP_NODELAY` is set by default
for all TCP connections.
.. versionchanged:: 3.11
start_serving=True)
Similar to :meth:`loop.create_server` but works with the
- :py:data:`~socket.AF_UNIX` socket family.
+ :py:const:`~socket.AF_UNIX` socket family.
*path* is the name of a Unix domain socket, and is required,
unless a *sock* argument is provided. Abstract Unix sockets,
* :meth:`loop.create_unix_connection` and
:meth:`loop.create_unix_server` are not supported.
- The :data:`socket.AF_UNIX` socket family is specific to Unix.
+ The :const:`socket.AF_UNIX` socket family is specific to Unix.
* :meth:`loop.add_signal_handler` and
:meth:`loop.remove_signal_handler` are not supported.
Stop the child process.
- On POSIX systems this method sends :py:data:`signal.SIGTERM` to the
+ On POSIX systems this method sends :py:const:`signal.SIGTERM` to the
child process.
On Windows the Win32 API function :c:func:`TerminateProcess` is
Raised when an operation would block on an object (e.g. socket) set
for non-blocking operation.
- Corresponds to :c:data:`errno` :py:data:`~errno.EAGAIN`, :py:data:`~errno.EALREADY`,
- :py:data:`~errno.EWOULDBLOCK` and :py:data:`~errno.EINPROGRESS`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.EAGAIN`, :py:const:`~errno.EALREADY`,
+ :py:const:`~errno.EWOULDBLOCK` and :py:const:`~errno.EINPROGRESS`.
In addition to those of :exc:`OSError`, :exc:`BlockingIOError` can have
one more attribute:
.. exception:: ChildProcessError
Raised when an operation on a child process failed.
- Corresponds to :c:data:`errno` :py:data:`~errno.ECHILD`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.ECHILD`.
.. exception:: ConnectionError
A subclass of :exc:`ConnectionError`, raised when trying to write on a
pipe while the other end has been closed, or trying to write on a socket
which has been shutdown for writing.
- Corresponds to :c:data:`errno` :py:data:`~errno.EPIPE` and :py:data:`~errno.ESHUTDOWN`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.EPIPE` and :py:const:`~errno.ESHUTDOWN`.
.. exception:: ConnectionAbortedError
A subclass of :exc:`ConnectionError`, raised when a connection attempt
is aborted by the peer.
- Corresponds to :c:data:`errno` :py:data:`~errno.ECONNABORTED`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.ECONNABORTED`.
.. exception:: ConnectionRefusedError
A subclass of :exc:`ConnectionError`, raised when a connection attempt
is refused by the peer.
- Corresponds to :c:data:`errno` :py:data:`~errno.ECONNREFUSED`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.ECONNREFUSED`.
.. exception:: ConnectionResetError
A subclass of :exc:`ConnectionError`, raised when a connection is
reset by the peer.
- Corresponds to :c:data:`errno` :py:data:`~errno.ECONNRESET`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.ECONNRESET`.
.. exception:: FileExistsError
Raised when trying to create a file or directory which already exists.
- Corresponds to :c:data:`errno` :py:data:`~errno.EEXIST`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.EEXIST`.
.. exception:: FileNotFoundError
Raised when a file or directory is requested but doesn't exist.
- Corresponds to :c:data:`errno` :py:data:`~errno.ENOENT`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.ENOENT`.
.. exception:: InterruptedError
Raised when a system call is interrupted by an incoming signal.
- Corresponds to :c:data:`errno` :py:data:`~errno.EINTR`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.EINTR`.
.. versionchanged:: 3.5
Python now retries system calls when a syscall is interrupted by a
Raised when a file operation (such as :func:`os.remove`) is requested
on a directory.
- Corresponds to :c:data:`errno` :py:data:`~errno.EISDIR`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.EISDIR`.
.. exception:: NotADirectoryError
something which is not a directory. On most POSIX platforms, it may also be
raised if an operation attempts to open or traverse a non-directory file as if
it were a directory.
- Corresponds to :c:data:`errno` :py:data:`~errno.ENOTDIR`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.ENOTDIR`.
.. exception:: PermissionError
Raised when trying to run an operation without the adequate access
rights - for example filesystem permissions.
- Corresponds to :c:data:`errno` :py:data:`~errno.EACCES`,
- :py:data:`~errno.EPERM`, and :py:data:`~errno.ENOTCAPABLE`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.EACCES`,
+ :py:const:`~errno.EPERM`, and :py:const:`~errno.ENOTCAPABLE`.
.. versionchanged:: 3.11.1
- WASI's :py:data:`~errno.ENOTCAPABLE` is now mapped to
+ WASI's :py:const:`~errno.ENOTCAPABLE` is now mapped to
:exc:`PermissionError`.
.. exception:: ProcessLookupError
Raised when a given process doesn't exist.
- Corresponds to :c:data:`errno` :py:data:`~errno.ESRCH`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.ESRCH`.
.. exception:: TimeoutError
Raised when a system function timed out at the system level.
- Corresponds to :c:data:`errno` :py:data:`~errno.ETIMEDOUT`.
+ Corresponds to :c:data:`errno` :py:const:`~errno.ETIMEDOUT`.
.. versionadded:: 3.3
All the above :exc:`OSError` subclasses were added.
which the lock starts, relative to *whence*, and *whence* is as with
:func:`io.IOBase.seek`, specifically:
- * :const:`0` -- relative to the start of the file (:data:`os.SEEK_SET`)
- * :const:`1` -- relative to the current buffer position (:data:`os.SEEK_CUR`)
- * :const:`2` -- relative to the end of the file (:data:`os.SEEK_END`)
+ * :const:`0` -- relative to the start of the file (:const:`os.SEEK_SET`)
+ * :const:`1` -- relative to the current buffer position (:const:`os.SEEK_CUR`)
+ * :const:`2` -- relative to the end of the file (:const:`os.SEEK_END`)
The default for *start* is 0, which means to start at the beginning of the file.
The default for *len* is 0 which means to lock to the end of the file. The
.. seealso::
Module :mod:`os`
- If the locking flags :data:`~os.O_SHLOCK` and :data:`~os.O_EXLOCK` are
+ If the locking flags :const:`~os.O_SHLOCK` and :const:`~os.O_EXLOCK` are
present in the :mod:`os` module (on BSD only), the :func:`os.open`
function provides an alternative to the :func:`lockf` and :func:`flock`
functions.
.. versionchanged:: 3.4
The class now supports hostname check with
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
- :data:`ssl.HAS_SNI`).
+ :const:`ssl.HAS_SNI`).
.. versionchanged:: 3.9
If the *timeout* parameter is set to be zero, it will raise a
.. versionchanged:: 3.4
The method now supports hostname check with
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
- :data:`ssl.HAS_SNI`).
+ :const:`ssl.HAS_SNI`).
.. method:: FTP_TLS.ccc()
.. versionchanged:: 3.2
This class now supports HTTPS virtual hosts if possible (that is,
- if :data:`ssl.HAS_SNI` is true).
+ if :const:`ssl.HAS_SNI` is true).
.. versionchanged:: 3.4
The *strict* parameter was removed. HTTP 0.9-style "Simple Responses" are
.. versionchanged:: 3.4
The class now supports hostname check with
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
- :data:`ssl.HAS_SNI`).
+ :const:`ssl.HAS_SNI`).
.. versionchanged:: 3.9
The optional *timeout* parameter was added.
.. versionchanged:: 3.4
The method now supports hostname check with
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
- :data:`ssl.HAS_SNI`).
+ :const:`ssl.HAS_SNI`).
.. method:: IMAP4.status(mailbox, names)
.. versionadded:: 3.3
Some operating systems could support additional values, like
- :data:`os.SEEK_HOLE` or :data:`os.SEEK_DATA`. The valid values
+ :const:`os.SEEK_HOLE` or :const:`os.SEEK_DATA`. The valid values
for a file could depend on it being open in text or binary mode.
.. method:: seekable()
Returns the logger used by :mod:`multiprocessing`. If necessary, a new one
will be created.
- When first created the logger has level :data:`logging.NOTSET` and no
+ When first created the logger has level :const:`logging.NOTSET` and no
default handler. Messages sent to this logger will not by default propagate
to the root logger.
help option. When :mod:`optparse` prints the usage string, it expands
``%prog`` to ``os.path.basename(sys.argv[0])`` (or to ``prog`` if you
passed that keyword argument). To suppress a usage message, pass the
- special value :data:`optparse.SUPPRESS_USAGE`.
+ special value :const:`optparse.SUPPRESS_USAGE`.
``option_list`` (default: ``[]``)
A list of Option objects to populate the parser with. The options in
Help text to print for this option when listing all available options after
the user supplies a :attr:`~Option.help` option (such as ``--help``). If
no help text is supplied, the option will be listed without help text. To
- hide this option, use the special value :data:`optparse.SUPPRESS_HELP`.
+ hide this option, use the special value :const:`optparse.SUPPRESS_HELP`.
.. attribute:: Option.metavar
If no :attr:`~Option.help` string is supplied for an option, it will still be
listed in the help message. To omit an option entirely, use the special value
- :data:`optparse.SUPPRESS_HELP`.
+ :const:`optparse.SUPPRESS_HELP`.
:mod:`optparse` automatically adds a :attr:`~Option.help` option to all
OptionParsers, so you do not normally need to create one.
Set the usage string according to the rules described above for the ``usage``
constructor keyword argument. Passing ``None`` sets the default usage
- string; use :data:`optparse.SUPPRESS_USAGE` to suppress a usage message.
+ string; use :const:`optparse.SUPPRESS_USAGE` to suppress a usage message.
.. method:: OptionParser.print_usage(file=None)
:data:`environ` and :data:`environb` are synchronized (modifying
:data:`environb` updates :data:`environ`, and vice versa).
- :data:`environb` is only available if :data:`supports_bytes_environ` is
+ :data:`environb` is only available if :const:`supports_bytes_environ` is
``True``.
.. versionadded:: 3.2
future environment changes.
- :func:`getenvb` is only available if :data:`supports_bytes_environ`
+ :func:`getenvb` is only available if :const:`supports_bytes_environ`
is ``True``.
.. availability:: Unix.
In Linux kernel older than 5.3, the files pointed by *src* and *dst*
must reside in the same filesystem, otherwise an :exc:`OSError` is
- raised with :attr:`~OSError.errno` set to :data:`errno.EXDEV`.
+ raised with :attr:`~OSError.errno` set to :const:`errno.EXDEV`.
This copy is done without the additional cost of transferring data
from the kernel to user space and then back into the kernel. Additionally,
.. versionadded:: 3.3
Some operating systems could support additional values, like
- :data:`os.SEEK_HOLE` or :data:`os.SEEK_DATA`.
+ :const:`os.SEEK_HOLE` or :const:`os.SEEK_DATA`.
.. function:: open(path, flags, mode=0o777, *, dir_fd=None)
If some data was successfully read, it will return the number of bytes read.
If no bytes were read, it will return ``-1`` and set errno to
- :data:`errno.EAGAIN`.
+ :const:`errno.EAGAIN`.
.. availability:: Linux >= 4.14.
*offset_dst*. The offset associated to the file descriptor that refers to a
pipe must be ``None``. The files pointed by *src* and *dst* must reside in
the same filesystem, otherwise an :exc:`OSError` is raised with
- :attr:`~OSError.errno` set to :data:`errno.EXDEV`.
+ :attr:`~OSError.errno` set to :const:`errno.EXDEV`.
This copy is done without the additional cost of transferring data
from the kernel to user space and then back into the kernel. Additionally,
Set the flags of *path* to the numeric *flags*. *flags* may take a combination
(bitwise OR) of the following values (as defined in the :mod:`stat` module):
- * :data:`stat.UF_NODUMP`
- * :data:`stat.UF_IMMUTABLE`
- * :data:`stat.UF_APPEND`
- * :data:`stat.UF_OPAQUE`
- * :data:`stat.UF_NOUNLINK`
- * :data:`stat.UF_COMPRESSED`
- * :data:`stat.UF_HIDDEN`
- * :data:`stat.SF_ARCHIVED`
- * :data:`stat.SF_IMMUTABLE`
- * :data:`stat.SF_APPEND`
- * :data:`stat.SF_NOUNLINK`
- * :data:`stat.SF_SNAPSHOT`
+ * :const:`stat.UF_NODUMP`
+ * :const:`stat.UF_IMMUTABLE`
+ * :const:`stat.UF_APPEND`
+ * :const:`stat.UF_OPAQUE`
+ * :const:`stat.UF_NOUNLINK`
+ * :const:`stat.UF_COMPRESSED`
+ * :const:`stat.UF_HIDDEN`
+ * :const:`stat.SF_ARCHIVED`
+ * :const:`stat.SF_IMMUTABLE`
+ * :const:`stat.SF_APPEND`
+ * :const:`stat.SF_NOUNLINK`
+ * :const:`stat.SF_SNAPSHOT`
This function can support :ref:`not following symlinks <follow_symlinks>`.
following values (as defined in the :mod:`stat` module) or bitwise ORed
combinations of them:
- * :data:`stat.S_ISUID`
- * :data:`stat.S_ISGID`
- * :data:`stat.S_ENFMT`
- * :data:`stat.S_ISVTX`
- * :data:`stat.S_IREAD`
- * :data:`stat.S_IWRITE`
- * :data:`stat.S_IEXEC`
- * :data:`stat.S_IRWXU`
- * :data:`stat.S_IRUSR`
- * :data:`stat.S_IWUSR`
- * :data:`stat.S_IXUSR`
- * :data:`stat.S_IRWXG`
- * :data:`stat.S_IRGRP`
- * :data:`stat.S_IWGRP`
- * :data:`stat.S_IXGRP`
- * :data:`stat.S_IRWXO`
- * :data:`stat.S_IROTH`
- * :data:`stat.S_IWOTH`
- * :data:`stat.S_IXOTH`
+ * :const:`stat.S_ISUID`
+ * :const:`stat.S_ISGID`
+ * :const:`stat.S_ENFMT`
+ * :const:`stat.S_ISVTX`
+ * :const:`stat.S_IREAD`
+ * :const:`stat.S_IWRITE`
+ * :const:`stat.S_IEXEC`
+ * :const:`stat.S_IRWXU`
+ * :const:`stat.S_IRUSR`
+ * :const:`stat.S_IWUSR`
+ * :const:`stat.S_IXUSR`
+ * :const:`stat.S_IRWXG`
+ * :const:`stat.S_IRGRP`
+ * :const:`stat.S_IWGRP`
+ * :const:`stat.S_IXGRP`
+ * :const:`stat.S_IRWXO`
+ * :const:`stat.S_IROTH`
+ * :const:`stat.S_IWOTH`
+ * :const:`stat.S_IXOTH`
This function can support :ref:`specifying a file descriptor <path_fd>`,
:ref:`paths relative to directory descriptors <dir_fd>` and :ref:`not
Send signal *sig* to the process *pid*. Constants for the specific signals
available on the host platform are defined in the :mod:`signal` module.
- Windows: The :data:`signal.CTRL_C_EVENT` and
- :data:`signal.CTRL_BREAK_EVENT` signals are special signals which can
+ Windows: The :const:`signal.CTRL_C_EVENT` and
+ :const:`signal.CTRL_BREAK_EVENT` signals are special signals which can
only be sent to console processes which share a common console window,
e.g., some subprocesses. Any other value for *sig* will cause the process
to be unconditionally killed by the TerminateProcess API, and the exit code
This flag indicates that the file descriptor will be non-blocking.
If the process referred to by the file descriptor has not yet terminated,
then an attempt to wait on the file descriptor using :manpage:`waitid(2)`
- will immediately return the error :data:`~errno.EAGAIN` rather than blocking.
+ will immediately return the error :const:`~errno.EAGAIN` rather than blocking.
.. availability:: Linux >= 5.10
.. versionadded:: 3.12
* :attr:`!si_pid` (process ID)
* :attr:`!si_uid` (real user ID of the child)
- * :attr:`!si_signo` (always :data:`~signal.SIGCHLD`)
+ * :attr:`!si_signo` (always :const:`~signal.SIGCHLD`)
* :attr:`!si_status` (the exit status or signal number, depending on :attr:`!si_code`)
* :attr:`!si_code` (see :data:`CLD_EXITED` for possible values)
.. function:: WIFCONTINUED(status)
Return ``True`` if a stopped child has been resumed by delivery of
- :data:`~signal.SIGCONT` (if the process has been continued from a job
+ :const:`~signal.SIGCONT` (if the process has been continued from a job
control stop), otherwise return ``False``.
See :data:`WCONTINUED` option.
``/dev/urandom`` devices.
The flags argument is a bit mask that can contain zero or more of the
- following values ORed together: :py:data:`os.GRND_RANDOM` and
+ following values ORed together: :py:const:`os.GRND_RANDOM` and
:py:data:`GRND_NONBLOCK`.
See also the `Linux getrandom() manual page
.. versionchanged:: 3.4
The class now supports hostname check with
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
- :data:`ssl.HAS_SNI`).
+ :const:`ssl.HAS_SNI`).
.. versionchanged:: 3.9
If the *timeout* parameter is set to be zero, it will raise a
This method supports hostname checking via
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
- :data:`ssl.HAS_SNI`).
+ :const:`ssl.HAS_SNI`).
.. versionadded:: 3.4
database file is opened for reading and writing. The optional *flag* parameter
has the same interpretation as the *flag* parameter of :func:`dbm.open`.
- By default, pickles created with :data:`pickle.DEFAULT_PROTOCOL` are used
+ By default, pickles created with :const:`pickle.DEFAULT_PROTOCOL` are used
to serialize values. The version of the pickle protocol can be specified
with the *protocol* parameter.
mutated).
.. versionchanged:: 3.10
- :data:`pickle.DEFAULT_PROTOCOL` is now used as the default pickle
+ :const:`pickle.DEFAULT_PROTOCOL` is now used as the default pickle
protocol.
.. versionchanged:: 3.11
A subclass of :class:`collections.abc.MutableMapping` which stores pickled
values in the *dict* object.
- By default, pickles created with :data:`pickle.DEFAULT_PROTOCOL` are used
+ By default, pickles created with :const:`pickle.DEFAULT_PROTOCOL` are used
to serialize values. The version of the pickle protocol can be specified
with the *protocol* parameter. See the :mod:`pickle` documentation for a
discussion of the pickle protocols.
Added context manager support.
.. versionchanged:: 3.10
- :data:`pickle.DEFAULT_PROTOCOL` is now used as the default pickle
+ :const:`pickle.DEFAULT_PROTOCOL` is now used as the default pickle
protocol.
.. versionchanged:: 3.4
The class now supports hostname check with
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
- :data:`ssl.HAS_SNI`).
+ :const:`ssl.HAS_SNI`).
.. versionchanged:: 3.9
If the *timeout* parameter is set to be zero, it will raise a
.. versionchanged:: 3.4
The method now supports hostname check with
:attr:`SSLContext.check_hostname` and *Server Name Indicator* (see
- :data:`~ssl.HAS_SNI`).
+ :const:`~ssl.HAS_SNI`).
.. versionchanged:: 3.5
The error raised for lack of STARTTLS support is now the
state, and can't be immediately reused.
There is a :mod:`socket` flag to set, in order to prevent this,
-:data:`socket.SO_REUSEADDR`::
+:const:`socket.SO_REUSEADDR`::
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
Can be ``"DEFERRED"`` (default), ``"EXCLUSIVE"`` or ``"IMMEDIATE"``;
or ``None`` to disable opening transactions implicitly.
Has no effect unless :attr:`Connection.autocommit` is set to
- :data:`~sqlite3.LEGACY_TRANSACTION_CONTROL` (the default).
+ :const:`~sqlite3.LEGACY_TRANSACTION_CONTROL` (the default).
:type isolation_level: str | None
:param bool check_same_thread:
See :attr:`Connection.autocommit` and
:ref:`sqlite3-transaction-control-autocommit` for more information.
*autocommit* currently defaults to
- :data:`~sqlite3.LEGACY_TRANSACTION_CONTROL`.
+ :const:`~sqlite3.LEGACY_TRANSACTION_CONTROL`.
The default will change to ``False`` in a future Python release.
:type autocommit: bool
.. method:: seek(offset, origin=os.SEEK_SET, /)
Set the current access position of the blob to *offset*. The *origin*
- argument defaults to :data:`os.SEEK_SET` (absolute blob positioning).
- Other values for *origin* are :data:`os.SEEK_CUR` (seek relative to the
- current position) and :data:`os.SEEK_END` (seek relative to the blob’s
+ argument defaults to :const:`os.SEEK_SET` (absolute blob positioning).
+ Other values for *origin* are :const:`os.SEEK_CUR` (seek relative to the
+ current position) and :const:`os.SEEK_END` (seek relative to the blob’s
end).
The settings are: :data:`PROTOCOL_TLS_CLIENT` or
:data:`PROTOCOL_TLS_SERVER`, :data:`OP_NO_SSLv2`, and :data:`OP_NO_SSLv3`
with high encryption cipher suites without RC4 and
- without unauthenticated cipher suites. Passing :data:`~Purpose.SERVER_AUTH`
+ without unauthenticated cipher suites. Passing :const:`~Purpose.SERVER_AUTH`
as *purpose* sets :data:`~SSLContext.verify_mode` to :data:`CERT_REQUIRED`
and either loads CA certificates (when at least one of *cafile*, *capath* or
*cadata* is given) or uses :meth:`SSLContext.load_default_certs` to load
load CA certificates from other locations, too.
The *purpose* flag specifies what kind of CA certificates are loaded. The
- default settings :data:`Purpose.SERVER_AUTH` loads certificates, that are
+ default settings :const:`Purpose.SERVER_AUTH` loads certificates, that are
flagged and trusted for TLS web server authentication (client side
- sockets). :data:`Purpose.CLIENT_AUTH` loads CA certificates for client
+ sockets). :const:`Purpose.CLIENT_AUTH` loads CA certificates for client
certificate verification on the server side.
.. versionadded:: 3.4
Wrap an existing Python socket *sock* and return an instance of
:attr:`SSLContext.sslsocket_class` (default :class:`SSLSocket`). The
returned SSL socket is tied to the context, its settings and certificates.
- *sock* must be a :data:`~socket.SOCK_STREAM` socket; other
+ *sock* must be a :const:`~socket.SOCK_STREAM` socket; other
socket types are unsupported.
The parameter ``server_side`` is a boolean which identifies whether
Return the current value of the flags that are used for
:c:func:`dlopen` calls. Symbolic names for the flag values can be
found in the :mod:`os` module (``RTLD_xxx`` constants, e.g.
- :data:`os.RTLD_LAZY`).
+ :const:`os.RTLD_LAZY`).
.. availability:: Unix.
``sys.setdlopenflags(0)``. To share symbols across extension modules, call as
``sys.setdlopenflags(os.RTLD_GLOBAL)``. Symbolic names for the flag values
can be found in the :mod:`os` module (``RTLD_xxx`` constants, e.g.
- :data:`os.RTLD_LAZY`).
+ :const:`os.RTLD_LAZY`).
.. availability:: Unix.
platforms, it is a file-like object whose :attr:`!file` attribute is the
underlying true file object.
- The :py:data:`os.O_TMPFILE` flag is used if it is available and works
+ The :py:const:`os.O_TMPFILE` flag is used if it is available and works
(Linux-specific, requires Linux kernel 3.11 or later).
On platforms that are neither Posix nor Cygwin, TemporaryFile is an alias
.. versionchanged:: 3.5
- The :py:data:`os.O_TMPFILE` flag is now used if available.
+ The :py:const:`os.O_TMPFILE` flag is now used if available.
.. versionchanged:: 3.8
Added *errors* parameter.
.. function:: with_pymalloc()
- Return :data:`_testcapi.WITH_PYMALLOC`.
+ Return :const:`_testcapi.WITH_PYMALLOC`.
.. function:: requires(resource, msg=None)
Alternatively you can just use ``vars(my_mock)`` (instance members) and
``dir(type(my_mock))`` (type members) to bypass the filtering irrespective of
-:data:`mock.FILTER_DIR`.
+:const:`mock.FILTER_DIR`.
mock_open
.. versionchanged:: 3.2
HTTPS virtual hosts are now supported if possible (that is, if
- :data:`ssl.HAS_SNI` is true).
+ :const:`ssl.HAS_SNI` is true).
.. versionadded:: 3.2
*data* can be an iterable object.
1. Expat 2.4.1 and newer is not vulnerable to the "billion laughs" and
"quadratic blowup" vulnerabilities. Items still listed as vulnerable due to
potential reliance on system-provided libraries. Check
- :data:`pyexpat.EXPAT_VERSION`.
+ :const:`pyexpat.EXPAT_VERSION`.
2. :mod:`xml.etree.ElementTree` doesn't expand external entities and raises a
:exc:`ParserError` when an entity occurs.
3. :mod:`xml.dom.minidom` doesn't expand external entities and simply returns
.. cmdoption:: --with-tzpath=<list of absolute paths separated by pathsep>
- Select the default time zone search path for :data:`zoneinfo.TZPATH`.
+ Select the default time zone search path for :const:`zoneinfo.TZPATH`.
See the :ref:`Compile-time configuration
<zoneinfo_data_compile_time_config>` of the :mod:`zoneinfo` module.
Build the ``_decimal`` extension module using a thread-local context rather
than a coroutine-local context (default), see the :mod:`decimal` module.
- See :data:`decimal.HAVE_CONTEXTVAR` and the :mod:`contextvars` module.
+ See :const:`decimal.HAVE_CONTEXTVAR` and the :mod:`contextvars` module.
.. versionadded:: 3.9
:issue:`8484`.)
The version of OpenSSL being used is now available as the module
- attributes :data:`ssl.OPENSSL_VERSION` (a string),
- :data:`ssl.OPENSSL_VERSION_INFO` (a 5-tuple), and
- :data:`ssl.OPENSSL_VERSION_NUMBER` (an integer). (Added by Antoine
+ attributes :const:`ssl.OPENSSL_VERSION` (a string),
+ :const:`ssl.OPENSSL_VERSION_INFO` (a 5-tuple), and
+ :const:`ssl.OPENSSL_VERSION_NUMBER` (an integer). (Added by Antoine
Pitrou; :issue:`8321`.)
* The :mod:`struct` module will no longer silently ignore overflow
address space, where one of the file descriptors must refer to a
pipe. (Contributed by Pablo Galindo in :issue:`41625`.)
-Add :data:`~os.O_EVTONLY`, :data:`~os.O_FSYNC`, :data:`~os.O_SYMLINK`
-and :data:`~os.O_NOFOLLOW_ANY` for macOS.
+Add :const:`~os.O_EVTONLY`, :const:`~os.O_FSYNC`, :const:`~os.O_SYMLINK`
+and :const:`~os.O_NOFOLLOW_ANY` for macOS.
(Contributed by Dong-hee Na in :issue:`43106`.)
os.path
shelve
------
-The :mod:`shelve` module now uses :data:`pickle.DEFAULT_PROTOCOL` by default
+The :mod:`shelve` module now uses :const:`pickle.DEFAULT_PROTOCOL` by default
instead of :mod:`pickle` protocol ``3`` when creating shelves.
(Contributed by Zackery Spytz in :issue:`34204`.)
(Contributed by Christian Heimes in :pep:`644` and :issue:`43669`.)
The ssl module has preliminary support for OpenSSL 3.0.0 and new option
-:data:`~ssl.OP_IGNORE_UNEXPECTED_EOF`.
+:const:`~ssl.OP_IGNORE_UNEXPECTED_EOF`.
(Contributed by Christian Heimes in :issue:`38820`, :issue:`43794`,
:issue:`43788`, :issue:`43791`, :issue:`43799`, :issue:`43920`,
:issue:`43789`, and :issue:`43811`.)
The ssl module uses heap-types and multi-phase initialization.
(Contributed by Christian Heimes in :issue:`42333`.)
-A new verify flag :data:`~ssl.VERIFY_X509_PARTIAL_CHAIN` has been added.
+A new verify flag :const:`~ssl.VERIFY_X509_PARTIAL_CHAIN` has been added.
(Contributed by l0x in :issue:`40849`.)
sqlite3
-------
:func:`_thread.interrupt_main` now takes an optional signal number to
-simulate (the default is still :data:`signal.SIGINT`).
+simulate (the default is still :const:`signal.SIGINT`).
(Contributed by Antoine Pitrou in :issue:`43356`.)
threading
* :data:`~ssl.PROTOCOL_SSLv2`, :data:`~ssl.PROTOCOL_SSLv3`,
:data:`~ssl.PROTOCOL_SSLv23`, :data:`~ssl.PROTOCOL_TLSv1`,
:data:`~ssl.PROTOCOL_TLSv1_1`, :data:`~ssl.PROTOCOL_TLSv1_2`, and
- :data:`~ssl.PROTOCOL_TLS` are deprecated in favor of
- :data:`~ssl.PROTOCOL_TLS_CLIENT` and :data:`~ssl.PROTOCOL_TLS_SERVER`
+ :const:`~ssl.PROTOCOL_TLS` are deprecated in favor of
+ :const:`~ssl.PROTOCOL_TLS_CLIENT` and :const:`~ssl.PROTOCOL_TLS_SERVER`
* :func:`~ssl.wrap_socket` is replaced by :meth:`ssl.SSLContext.wrap_socket`
* Added the :func:`~enum.global_enum` enum decorator,
which adjusts :meth:`~object.__repr__` and :meth:`~object.__str__`
to show values as members of their module rather than the enum class.
- For example, ``'re.ASCII'`` for the :data:`~re.ASCII` member
+ For example, ``'re.ASCII'`` for the :const:`~re.ASCII` member
of :class:`re.RegexFlag` rather than ``'RegexFlag.ASCII'``.
* Enhanced :class:`~enum.Flag` to support
* On Unix, if the ``sem_clockwait()`` function is available in the C library
(glibc 2.30 and newer), the :meth:`threading.Lock.acquire` method now uses
- the monotonic clock (:data:`time.CLOCK_MONOTONIC`) for the timeout, rather
- than using the system clock (:data:`time.CLOCK_REALTIME`), to not be affected
+ the monotonic clock (:const:`time.CLOCK_MONOTONIC`) for the timeout, rather
+ than using the system clock (:const:`time.CLOCK_REALTIME`), to not be affected
by system clock changes.
(Contributed by Victor Stinner in :issue:`41710`.)
(Contributed by Serhiy Storchaka in :gh:`91760`.)
* In the :mod:`re` module, the :func:`!re.template` function
- and the corresponding :data:`!re.TEMPLATE` and :data:`!re.T` flags
+ and the corresponding :const:`!re.TEMPLATE` and :const:`!re.T` flags
are deprecated, as they were undocumented and lacked an obvious purpose.
They will be removed in Python 3.13.
(Contributed by Serhiy Storchaka and Miro Hrončok in :gh:`92728`.)
csv
---
-* Add :data:`~csv.QUOTE_NOTNULL` and :data:`~csv.QUOTE_STRINGS` flags to
+* Add :const:`~csv.QUOTE_NOTNULL` and :const:`~csv.QUOTE_STRINGS` flags to
provide finer grained control of ``None`` and empty strings by
:class:`~csv.writer` objects.
os
--
-* Add :data:`os.PIDFD_NONBLOCK` to open a file descriptor
+* Add :const:`os.PIDFD_NONBLOCK` to open a file descriptor
for a process with :func:`os.pidfd_open` in non-blocking mode.
(Contributed by Kumar Aditya in :gh:`93312`.)
algorithm" error.
* The version of OpenSSL being used is now accessible using the module
- attributes :data:`ssl.OPENSSL_VERSION` (a string),
- :data:`ssl.OPENSSL_VERSION_INFO` (a 5-tuple), and
- :data:`ssl.OPENSSL_VERSION_NUMBER` (an integer).
+ attributes :const:`ssl.OPENSSL_VERSION` (a string),
+ :const:`ssl.OPENSSL_VERSION_INFO` (a 5-tuple), and
+ :const:`ssl.OPENSSL_VERSION_NUMBER` (an integer).
(Contributed by Antoine Pitrou in :issue:`8850`, :issue:`1589`, :issue:`8322`,
:issue:`5639`, :issue:`4870`, :issue:`8484`, and :issue:`8321`.)
* :func:`open` gets a new *opener* parameter: the underlying file descriptor
for the file object is then obtained by calling *opener* with (*file*,
- *flags*). It can be used to use custom flags like :data:`os.O_CLOEXEC` for
+ *flags*). It can be used to use custom flags like :const:`os.O_CLOEXEC` for
example. The ``'x'`` mode was added: open for exclusive creation, failing if
the file already exists.
* :func:`print`: added the *flush* keyword argument. If the *flush* keyword
* If Python is compiled without threads, the C version automatically
disables the expensive thread local context machinery. In this case,
- the variable :data:`~decimal.HAVE_THREADS` is set to ``False``.
+ the variable :const:`~decimal.HAVE_THREADS` is set to ``False``.
API changes
~~~~~~~~~~~
--
* The :mod:`os` module has a new :func:`~os.pipe2` function that makes it
- possible to create a pipe with :data:`~os.O_CLOEXEC` or
- :data:`~os.O_NONBLOCK` flags set atomically. This is especially useful to
+ possible to create a pipe with :const:`~os.O_CLOEXEC` or
+ :const:`~os.O_NONBLOCK` flags set atomically. This is especially useful to
avoid race conditions in multi-threaded programs.
* The :mod:`os` module has a new :func:`~os.sendfile` function which provides
* Some platforms now support additional constants for the :func:`~os.lseek`
function, such as ``os.SEEK_HOLE`` and ``os.SEEK_DATA``.
-* New constants :data:`~os.RTLD_LAZY`, :data:`~os.RTLD_NOW`,
- :data:`~os.RTLD_GLOBAL`, :data:`~os.RTLD_LOCAL`, :data:`~os.RTLD_NODELETE`,
- :data:`~os.RTLD_NOLOAD`, and :data:`~os.RTLD_DEEPBIND` are available on
+* New constants :const:`~os.RTLD_LAZY`, :const:`~os.RTLD_NOW`,
+ :const:`~os.RTLD_GLOBAL`, :const:`~os.RTLD_LOCAL`, :const:`~os.RTLD_NODELETE`,
+ :const:`~os.RTLD_NOLOAD`, and :const:`~os.RTLD_DEEPBIND` are available on
platforms that support them. These are for use with the
:func:`sys.setdlopenflags` function, and supersede the similar constants
defined in :mod:`ctypes` and :mod:`DLFCN`. (Contributed by Victor Stinner
Command strings can now be bytes objects on posix platforms. (Contributed by
Victor Stinner in :issue:`8513`.)
-A new constant :data:`~subprocess.DEVNULL` allows suppressing output in a
+A new constant :const:`~subprocess.DEVNULL` allows suppressing output in a
platform-independent fashion. (Contributed by Ross Lagerwall in
:issue:`5870`.)
doctest
-------
-A new :ref:`option flag <doctest-options>`, :data:`~doctest.FAIL_FAST`, halts
+A new :ref:`option flag <doctest-options>`, :const:`~doctest.FAIL_FAST`, halts
test running as soon as the first failure is detected. (Contributed by R.
David Murray and Daniel Urban in :issue:`16522`.)
than the resolution of a particular filesystem's file modification time field.
(Contributed by Mark Levitt in :issue:`18149`.)
-New module attribute :data:`~filecmp.DEFAULT_IGNORES` provides the list of
+New module attribute :const:`~filecmp.DEFAULT_IGNORES` provides the list of
directories that are used as the default value for the *ignore* parameter of
the :func:`~filecmp.dircmp` function. (Contributed by Eli Bendersky in
:issue:`15442`.)
root on Windows. (Contributed by Tim Golden in :issue:`9035`.)
:func:`os.open` supports two new flags on platforms that provide them,
-:data:`~os.O_PATH` (un-opened file descriptor), and :data:`~os.O_TMPFILE`
+:const:`~os.O_PATH` (un-opened file descriptor), and :const:`~os.O_TMPFILE`
(unnamed temporary file; as of 3.4.0 release available only on Linux systems
with a kernel version of 3.11 or newer that have uapi headers). (Contributed
by Christian Heimes in :issue:`18673` and Benjamin Peterson, respectively.)
stdlib serialization protocols, with new :func:`~plistlib.load`,
:func:`~plistlib.dump`, :func:`~plistlib.loads`, and :func:`~plistlib.dumps`
functions. (The older API is now deprecated.) In addition to the already
-supported XML plist format (:data:`~plistlib.FMT_XML`), it also now supports
-the binary plist format (:data:`~plistlib.FMT_BINARY`). (Contributed by Ronald
+supported XML plist format (:const:`~plistlib.FMT_XML`), it also now supports
+the binary plist format (:const:`~plistlib.FMT_BINARY`). (Contributed by Ronald
Oussoren and others in :issue:`14455`.)
socket
------
-The socket module now supports the :data:`~socket.CAN_BCM` protocol on
+The socket module now supports the :const:`~socket.CAN_BCM` protocol on
platforms that support it. (Contributed by Brian Thorne in :issue:`15359`.)
Socket objects have new methods to get or set their :ref:`inheritable flag
using the new :mod:`enum` module. This allows meaningful names to be printed
during debugging, instead of integer "magic numbers".
-The :data:`~socket.AF_LINK` constant is now available on BSD and OSX.
+The :const:`~socket.AF_LINK` constant is now available on BSD and OSX.
:func:`~socket.inet_pton` and :func:`~socket.inet_ntop` are now supported
on Windows. (Contributed by Atsuo Ishimoto in :issue:`7171`.)
If OpenSSL 0.9.8 or later is available, :class:`~ssl.SSLContext` has a new
attribute :attr:`~ssl.SSLContext.verify_flags` that can be used to control the
certificate verification process by setting it to some combination of the new
-constants :data:`~ssl.VERIFY_DEFAULT`, :data:`~ssl.VERIFY_CRL_CHECK_LEAF`,
-:data:`~ssl.VERIFY_CRL_CHECK_CHAIN`, or :data:`~ssl.VERIFY_X509_STRICT`.
+constants :const:`~ssl.VERIFY_DEFAULT`, :const:`~ssl.VERIFY_CRL_CHECK_LEAF`,
+:const:`~ssl.VERIFY_CRL_CHECK_CHAIN`, or :const:`~ssl.VERIFY_X509_STRICT`.
OpenSSL does not do any CRL verification by default. (Contributed by
Christien Heimes in :issue:`8813`.)
PEP 475: Retry system calls failing with EINTR
----------------------------------------------
-An :py:data:`errno.EINTR` error code is returned whenever a system call, that
+An :py:const:`errno.EINTR` error code is returned whenever a system call, that
is waiting for I/O, is interrupted by a signal. Previously, Python would
raise :exc:`InterruptedError` in such cases. This meant that, when writing a
Python application, the developer had two choices:
:func:`~os.writev`;
* special cases: :func:`os.close` and :func:`os.dup2` now ignore
- :py:data:`~errno.EINTR` errors; the syscall is not retried (see the PEP
+ :py:const:`~errno.EINTR` errors; the syscall is not retried (see the PEP
for the rationale);
* :mod:`select` functions: :func:`devpoll.poll() <select.devpoll.poll>`,
exhaustion. (Contributed by Victor Stinner in :issue:`22181`.)
New :func:`~os.get_blocking` and :func:`~os.set_blocking` functions allow
-getting and setting a file descriptor's blocking mode (:data:`~os.O_NONBLOCK`.)
+getting and setting a file descriptor's blocking mode (:const:`~os.O_NONBLOCK`.)
(Contributed by Victor Stinner in :issue:`22054`.)
The :func:`~os.truncate` and :func:`~os.ftruncate` functions are now supported
The new
:meth:`SSLSocket.selected_alpn_protocol() <ssl.SSLSocket.selected_alpn_protocol>`
returns the protocol that was selected during the TLS handshake.
-The :data:`~ssl.HAS_ALPN` flag indicates whether ALPN support is present.
+The :const:`~ssl.HAS_ALPN` flag indicates whether ALPN support is present.
Other Changes
in Python 3.5, all old ``.pyo`` files from previous versions of Python are
invalid regardless of this PEP.
-* The :mod:`socket` module now exports the :data:`~socket.CAN_RAW_FD_FRAMES`
+* The :mod:`socket` module now exports the :const:`~socket.CAN_RAW_FD_FRAMES`
constant on linux 3.6 and greater.
* The :func:`ssl.cert_time_to_seconds` function now interprets the input time
------
The :func:`~socket.socket.ioctl` function now supports the
-:data:`~socket.SIO_LOOPBACK_FAST_PATH` control code.
+:const:`~socket.SIO_LOOPBACK_FAST_PATH` control code.
(Contributed by Daniel Stokes in :issue:`26536`.)
The :meth:`~socket.socket.getsockopt` constants ``SO_DOMAIN``,
(Contributed by Christian Heimes in :issue:`27744`.)
The socket module now supports the address family
-:data:`~socket.AF_ALG` to interface with Linux Kernel crypto API. ``ALG_*``,
+:const:`~socket.AF_ALG` to interface with Linux Kernel crypto API. ``ALG_*``,
``SOL_ALG`` and :meth:`~socket.socket.sendmsg_afalg` were added.
(Contributed by Christian Heimes in :issue:`27744` with support from
Victor Stinner.)
compatibility across platforms.
(Contributed by Christian Heimes in :issue:`32454`.)
-The :mod:`socket` module now exposes the :data:`socket.TCP_CONGESTION`
-(Linux 2.6.13), :data:`socket.TCP_USER_TIMEOUT` (Linux 2.6.37), and
-:data:`socket.TCP_NOTSENT_LOWAT` (Linux 3.12) constants.
+The :mod:`socket` module now exposes the :const:`socket.TCP_CONGESTION`
+(Linux 2.6.13), :const:`socket.TCP_USER_TIMEOUT` (Linux 2.6.37), and
+:const:`socket.TCP_NOTSENT_LOWAT` (Linux 3.12) constants.
(Contributed by Omar Sandoval in :issue:`26273` and
Nathaniel J. Smith in :issue:`29728`.)
-Support for :data:`socket.AF_VSOCK` sockets has been added to allow
+Support for :const:`socket.AF_VSOCK` sockets has been added to allow
communication between virtual machines and their hosts.
(Contributed by Cathy Avery in :issue:`27584`.)
The :func:`subprocess.run` function accepts the new *capture_output*
keyword argument. When true, stdout and stderr will be captured.
-This is equivalent to passing :data:`subprocess.PIPE` as *stdout* and
+This is equivalent to passing :const:`subprocess.PIPE` as *stdout* and
*stderr* arguments.
(Contributed by Bo Bayles in :issue:`32102`.)
New clock identifiers have been added:
-* :data:`time.CLOCK_BOOTTIME` (Linux): Identical to
- :data:`time.CLOCK_MONOTONIC`, except it also includes any time that the
+* :const:`time.CLOCK_BOOTTIME` (Linux): Identical to
+ :const:`time.CLOCK_MONOTONIC`, except it also includes any time that the
system is suspended.
-* :data:`time.CLOCK_PROF` (FreeBSD, NetBSD and OpenBSD): High-resolution
+* :const:`time.CLOCK_PROF` (FreeBSD, NetBSD and OpenBSD): High-resolution
per-process CPU timer.
-* :data:`time.CLOCK_UPTIME` (FreeBSD, OpenBSD): Time whose absolute value is
+* :const:`time.CLOCK_UPTIME` (FreeBSD, OpenBSD): Time whose absolute value is
the time the system has been running and not suspended, providing accurate
uptime measurement.
time
----
-Added new clock :data:`~time.CLOCK_UPTIME_RAW` for macOS 10.12.
+Added new clock :const:`~time.CLOCK_UPTIME_RAW` for macOS 10.12.
(Contributed by Joannah Nanjekye in :issue:`35702`.)
fcntl
-----
-Added constants :data:`~fcntl.F_OFD_GETLK`, :data:`~fcntl.F_OFD_SETLK`
-and :data:`~fcntl.F_OFD_SETLKW`.
+Added constants :const:`~fcntl.F_OFD_GETLK`, :const:`~fcntl.F_OFD_SETLK`
+and :const:`~fcntl.F_OFD_SETLKW`.
(Contributed by Dong-hee Na in :issue:`38602`.)
ftplib
os
--
-Added :data:`~os.CLD_KILLED` and :data:`~os.CLD_STOPPED` for :attr:`si_code`.
+Added :const:`~os.CLD_KILLED` and :const:`~os.CLD_STOPPED` for :attr:`si_code`.
(Contributed by Dong-hee Na in :issue:`38493`.)
Exposed the Linux-specific :func:`os.pidfd_open` (:issue:`38692`) and
-:data:`os.P_PIDFD` (:issue:`38713`) for process management with file
+:const:`os.P_PIDFD` (:issue:`38713`) for process management with file
descriptors.
The :func:`os.unsetenv` function is now also available on Windows.
socket
------
-The :mod:`socket` module now exports the :data:`~socket.CAN_RAW_JOIN_FILTERS`
+The :mod:`socket` module now exports the :const:`~socket.CAN_RAW_JOIN_FILTERS`
constant on Linux 4.1 and greater.
(Contributed by Stefan Tatschner and Zackery Spytz in :issue:`25780`.)
-The socket module now supports the :data:`~socket.CAN_J1939` protocol on
+The socket module now supports the :const:`~socket.CAN_J1939` protocol on
platforms that support it. (Contributed by Karl Ding in :issue:`40291`.)
The socket module now has the :func:`socket.send_fds` and
``__VENV_PROMPT__`` is set to ``""``.
* The :meth:`select.epoll.unregister` method no longer ignores the
- :data:`~errno.EBADF` error.
+ :const:`~errno.EBADF` error.
(Contributed by Victor Stinner in :issue:`39239`.)
* The *compresslevel* parameter of :class:`bz2.BZ2File` became keyword-only,
.. nonce: YoYoYo
.. section: Library
-Add a new :data:`os.RWF_APPEND` flag for :func:`os.pwritev`.
+Add a new :const:`os.RWF_APPEND` flag for :func:`os.pwritev`.
..
.. nonce: ZCk0_c
.. section: Library
-:data:`~mmap.MAP_POPULATE` constant has now been added to the list of
+:const:`~mmap.MAP_POPULATE` constant has now been added to the list of
exported :mod:`mmap` module flags.
..
.. nonce: 9wXTtY
.. section: Library
-The :mod:`shelve` module now uses :data:`pickle.DEFAULT_PROTOCOL` by default
+The :mod:`shelve` module now uses :const:`pickle.DEFAULT_PROTOCOL` by default
instead of :mod:`pickle` protocol ``3``.
..
.. nonce: SwcSuU
.. section: Library
-Added :data:`~os.O_EVTONLY`, :data:`~os.O_FSYNC`, :data:`~os.O_SYMLINK` and
-:data:`~os.O_NOFOLLOW_ANY` for macOS. Patch by Dong-hee Na.
+Added :const:`~os.O_EVTONLY`, :const:`~os.O_FSYNC`, :const:`~os.O_SYMLINK` and
+:const:`~os.O_NOFOLLOW_ANY` for macOS. Patch by Dong-hee Na.
..
.. nonce: a7Dote
.. section: Library
-Adds :data:`resource.RLIMIT_KQUEUES` constant from FreeBSD to the
+Adds :const:`resource.RLIMIT_KQUEUES` constant from FreeBSD to the
:mod:`resource` module.
..
.. section: Library
Expose ``X509_V_FLAG_ALLOW_PROXY_CERTS`` as
-:data:`~ssl.VERIFY_ALLOW_PROXY_CERTS` to allow proxy certificate validation
+:const:`~ssl.VERIFY_ALLOW_PROXY_CERTS` to allow proxy certificate validation
as explained in
https://www.openssl.org/docs/man1.1.1/man7/proxy-certificates.html.
.. nonce: -1XPDH
.. section: Library
-Add :data:`ssl.OP_IGNORE_UNEXPECTED_EOF` constants (OpenSSL 3.0.0)
+Add :const:`ssl.OP_IGNORE_UNEXPECTED_EOF` constants (OpenSSL 3.0.0)
..
On Unix, if the ``sem_clockwait()`` function is available in the C library
(glibc 2.30 and newer), the :meth:`threading.Lock.acquire` method now uses
-the monotonic clock (:data:`time.CLOCK_MONOTONIC`) for the timeout, rather
-than using the system clock (:data:`time.CLOCK_REALTIME`), to not be
+the monotonic clock (:const:`time.CLOCK_MONOTONIC`) for the timeout, rather
+than using the system clock (:const:`time.CLOCK_REALTIME`), to not be
affected by system clock changes. Patch by Victor Stinner.
..
.. section: Library
Fix the :func:`os.set_inheritable` function on FreeBSD 14 for file
-descriptor opened with the :data:`~os.O_PATH` flag: ignore the
-:data:`~errno.EBADF` error on ``ioctl()``, fallback on the ``fcntl()``
+descriptor opened with the :const:`~os.O_PATH` flag: ignore the
+:const:`~errno.EBADF` error on ``ioctl()``, fallback on the ``fcntl()``
implementation. Patch by Victor Stinner.
..
.. nonce: jeiPiX
.. section: Library
-Added :data:`signal.SIGSTKFLT` on platforms where this signal is defined.
+Added :const:`signal.SIGSTKFLT` on platforms where this signal is defined.
..
.. nonce: HFtERN
.. section: Library
-Fix :data:`signal.NSIG` value on FreeBSD to accept signal numbers greater
-than 32, like :data:`signal.SIGRTMIN` and :data:`signal.SIGRTMAX`. Patch by
+Fix :const:`signal.NSIG` value on FreeBSD to accept signal numbers greater
+than 32, like :const:`signal.SIGRTMIN` and :const:`signal.SIGRTMAX`. Patch by
Victor Stinner.
..
.. nonce: 6eoc8k
.. section: Core and Builtins
-On WASI :data:`~errno.ENOTCAPABLE` is now mapped to :exc:`PermissionError`.
+On WASI :const:`~errno.ENOTCAPABLE` is now mapped to :exc:`PermissionError`.
The :mod:`errno` modules exposes the new error number. ``getpath.py`` now
ignores :exc:`PermissionError` when it cannot open landmark files
``pybuilddir.txt`` and ``pyenv.cfg``.
.. nonce: i807-g
.. section: Library
-Fail gracefully if :data:`~errno.EPERM` or :data:`~errno.ENOSYS` is raised
+Fail gracefully if :const:`~errno.EPERM` or :const:`~errno.ENOSYS` is raised
when loading :mod:`!crypt` methods. This may happen when trying to load
``MD5`` on a Linux kernel with :abbr:`FIPS (Federal Information Processing
Standard)` enabled.
.. nonce: VT34A5
.. section: Library
-Fix check for existence of :data:`os.EFD_CLOEXEC`, :data:`os.EFD_NONBLOCK`
-and :data:`os.EFD_SEMAPHORE` flags on older kernel versions where these
+Fix check for existence of :const:`os.EFD_CLOEXEC`, :const:`os.EFD_NONBLOCK`
+and :const:`os.EFD_SEMAPHORE` flags on older kernel versions where these
flags are not present. Patch by Kumar Aditya.
..
.. nonce: HY0Uzj
.. section: Library
-Add :data:`os.PIDFD_NONBLOCK` flag to open a file descriptor for a process
+Add :const:`os.PIDFD_NONBLOCK` flag to open a file descriptor for a process
with :func:`os.pidfd_open` in non-blocking mode. Patch by Kumar Aditya.
..
.. nonce: nSGEkG
.. section: Core and Builtins
-Expose :data:`~socket.ETH_P_ALL` and some of the :ref:`ETHERTYPE_* constants
+Expose :const:`~socket.ETH_P_ALL` and some of the :ref:`ETHERTYPE_* constants
<socket-ethernet-types>` in :mod:`socket`. Patch by Noam Cohen.
..
.. nonce: ZoOY5G
.. section: Library
-Add an :data:`~ssl.OP_ENABLE_KTLS` option for enabling the use of the kernel
+Add an :const:`~ssl.OP_ENABLE_KTLS` option for enabling the use of the kernel
TLS (kTLS). Patch by Illia Volochii.
..
.. nonce: yP4Na0
.. section: Core and Builtins
-Add :data:`ssl.OP_LEGACY_SERVER_CONNECT`
+Add :const:`ssl.OP_LEGACY_SERVER_CONNECT`
..
.. nonce: mHRdQn
.. section: Library
-Add :data:`socket.IP_PKTINFO` constant.
+Add :const:`socket.IP_PKTINFO` constant.
..
.. nonce: Vxz0Mr
.. section: Library
-Add :data:`mmap.MAP_ALIGNED_SUPER` FreeBSD and :data:`mmap.MAP_CONCEAL`
+Add :const:`mmap.MAP_ALIGNED_SUPER` FreeBSD and :const:`mmap.MAP_CONCEAL`
OpenBSD constants to :mod:`mmap`. Patch by Yeojin Kim.
..
TLS-level EOF. It now raises :exc:`~ssl.SSLEOFError`, matching the behavior
in previous versions of OpenSSL. The :attr:`~ssl.SSLContext.options`
attribute on :class:`~ssl.SSLContext` also no longer includes
-:data:`~ssl.OP_IGNORE_UNEXPECTED_EOF` by default. This option may be set to
+:const:`~ssl.OP_IGNORE_UNEXPECTED_EOF` by default. This option may be set to
specify the previous OpenSSL 3.0 behavior.
..
.. section: Library
Improve performance of :meth:`pathlib.Path.glob` by using
-:data:`re.IGNORECASE` to implement case-insensitive matching.
+:const:`re.IGNORECASE` to implement case-insensitive matching.
..
.. nonce: 564i32
.. section: Library
-Add :data:`~csv.QUOTE_STRINGS` and :data:`~csv.QUOTE_NOTNULL` to the suite
+Add :const:`~csv.QUOTE_STRINGS` and :const:`~csv.QUOTE_NOTNULL` to the suite
of :mod:`csv` module quoting styles.
..
.. nonce: ilNIWN
.. section: Library
-Add new :data:`socket.TCP_CONGESTION` (Linux 2.6.13) and
-:data:`socket.TCP_USER_TIMEOUT` (Linux 2.6.37) constants. Patch written by
+Add new :const:`socket.TCP_CONGESTION` (Linux 2.6.13) and
+:const:`socket.TCP_USER_TIMEOUT` (Linux 2.6.37) constants. Patch written by
Omar Sandoval.
..
.. nonce: 37jMwb
.. section: Library
-Add new :data:`socket.TCP_NOTSENT_LOWAT` (Linux 3.12) constant. Patch by
+Add new :const:`socket.TCP_NOTSENT_LOWAT` (Linux 3.12) constant. Patch by
Nathaniel J. Smith.
..
.. nonce: ilNIWN
.. section: Library
-Add new :data:`socket.TCP_CONGESTION` (Linux 2.6.13) and
-:data:`socket.TCP_USER_TIMEOUT` (Linux 2.6.37) constants. Patch written by
+Add new :const:`socket.TCP_CONGESTION` (Linux 2.6.13) and
+:const:`socket.TCP_USER_TIMEOUT` (Linux 2.6.37) constants. Patch written by
Omar Sandoval.
..
.. nonce: DYQL0g
.. section: Library
-Add 3 new clock identifiers: :data:`time.CLOCK_BOOTTIME`,
-:data:`time.CLOCK_PROF` and :data:`time.CLOCK_UPTIME`.
+Add 3 new clock identifiers: :const:`time.CLOCK_BOOTTIME`,
+:const:`time.CLOCK_PROF` and :const:`time.CLOCK_UPTIME`.
..
.. nonce: _ct_0H
.. section: Library
-The :data:`time.CLOCK_UPTIME_RAW` constant is now available for macOS 10.12.
+The :const:`time.CLOCK_UPTIME_RAW` constant is now available for macOS 10.12.
..
.. section: Tests
Fix ``test_imap4_host_default_value()`` of ``test_imaplib``: catch also
-:data:`errno.ENETUNREACH` error.
+:const:`errno.ENETUNREACH` error.
..
.. nonce: bmhquU
.. section: Library
-Add :data:`os.P_PIDFD` constant, which may be passed to :func:`os.waitid` to
+Add :const:`os.P_PIDFD` constant, which may be passed to :func:`os.waitid` to
wait on a Linux process file descriptor.
..
.. nonce: 7jvYFA
.. section: Library
-Added constants :data:`~fcntl.F_OFD_GETLK`, :data:`~fcntl.F_OFD_SETLK` and
-:data:`~fcntl.F_OFD_SETLKW` to the :mod:`fcntl` module. Patch by Dong-hee
+Added constants :const:`~fcntl.F_OFD_GETLK`, :const:`~fcntl.F_OFD_SETLK` and
+:const:`~fcntl.F_OFD_SETLKW` to the :mod:`fcntl` module. Patch by Dong-hee
Na.
..
.. nonce: 86ExWB
.. section: Library
-Added :data:`~os.CLD_KILLED` and :data:`~os.CLD_STOPPED` for
+Added :const:`~os.CLD_KILLED` and :const:`~os.CLD_STOPPED` for
:attr:`si_code`. Patch by Dong-hee Na.
..
.. nonce: 9w-IGF
.. section: Library
-Add missing :data:`stat.S_IFDOOR`, :data:`stat.S_IFPORT`,
-:data:`stat.S_IFWHT`, :func:`stat.S_ISDOOR`, :func:`stat.S_ISPORT`, and
+Add missing :const:`stat.S_IFDOOR`, :const:`stat.S_IFPORT`,
+:const:`stat.S_IFWHT`, :func:`stat.S_ISDOOR`, :func:`stat.S_ISPORT`, and
:func:`stat.S_ISWHT` values to the Python implementation of :mod:`stat`.
..
.. nonce: -0g2O3
.. section: Windows
-Make :data:`winreg.REG_MULTI_SZ` support zero-length strings.
+Make :const:`winreg.REG_MULTI_SZ` support zero-length strings.
..
.. nonce: kIjVge
.. section: Library
-Expose :data:`~socket.CAN_RAW_JOIN_FILTERS` in the :mod:`socket` module.
+Expose :const:`~socket.CAN_RAW_JOIN_FILTERS` in the :mod:`socket` module.
..
.. nonce: HFpHZS
.. section: Library
-Add :data:`time.CLOCK_TAI` constant if the operating system support it.
+Add :const:`time.CLOCK_TAI` constant if the operating system support it.
..
projects / thirdparty / Python / cpython.git / commitdiff
