8000 Use roles :data: and :const: for referencing module variables by serhiy-storchaka · Pull Request #129507 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

Use roles :data: and :const: for referencing module variables #129507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/howto/free-threading-python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Identifying free-threaded Python
================================

To check if the current interpreter supports free-threading, :option:`python -VV <-V>`
and :attr:`sys.version` contain "experimental free-threading build".
and :data:`sys.version` contain "experimental free-threading build".
The new :func:`sys._is_gil_enabled` function can be used to check whether
the GIL is actually disabled in the running process.

Expand Down
6 changes: 3 additions & 3 deletions Doc/library/datetime.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The :mod:`!datetime` module exports the following constants:
The largest year number allowed in a :class:`date` or :class:`.datetime` object.
:const:`MAXYEAR` is 9999.

.. attribute:: UTC
.. data:: UTC

Alias for the UTC time zone singleton :attr:`datetime.timezone.utc`.

Expand Down Expand Up @@ -970,7 +970,7 @@ Other constructors, all class methods:

.. deprecated:: 3.12

Use :meth:`datetime.now` with :attr:`UTC` instead.
Use :meth:`datetime.now` with :const:`UTC` instead.


.. classmethod:: datetime.fromtimestamp(timestamp, tz=None)
Expand Down Expand Up @@ -1042,7 +1042,7 @@ Other constructors, all class methods:

.. deprecated:: 3.12

Use :meth:`datetime.fromtimestamp` with :attr:`UTC` instead.
Use :meth:`datetime.fromtimestamp` with :const:`UTC` instead.


.. classmethod:: datetime.fromordinal(ordinal)
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/decimal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2262,7 +2262,7 @@ value for :attr:`~Context.prec` as well [#]_::
Decimal('904625697166532776746648320380374280103671755200316906558262375061821325312')


For inexact results, :attr:`MAX_PREC` is far too large on 64-bit platforms and
For inexact results, :const:`MAX_PREC` is far too large on 64-bit platforms and
the available memory will be insufficient::

>>> Decimal(1) / 3
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/filecmp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ The :class:`dircmp` class
are the same type as *self*, if *self* is a subclass of
:class:`dircmp`.

.. attribute:: DEFAULT_IGNORES
.. data:: DEFAULT_IGNORES

.. versionadded:: 3.4

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/importlib.metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ Mapping import to distribution packages
.. function:: packages_distributions()

Return a mapping from the top level module and import package
names found via :attr:`sys.meta_path` to the names of the distribution
names found via :data:`sys.meta_path` to the names of the distribution
packages (if any) that provide the corresponding files.

To allow for namespace packages (which may have members provided by
Expand Down
20 changes: 10 additions & 10 deletions Doc/library/importlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -746,7 +746,7 @@ ABC hierarchy::
suitable for reading (same as :attr:`pathlib.Path.open`).

When opening as text, accepts encoding parameters such as those
accepted by :attr:`io.TextIOWrapper`.
accepted by :class:`io.TextIOWrapper`.

.. method:: read_bytes()

Expand Down Expand Up @@ -794,34 +794,34 @@ ABC hierarchy::
This module contains the various objects that help :keyword:`import`
find and load modules.

.. attribute:: SOURCE_SUFFIXES
.. data:: SOURCE_SUFFIXES

A list of strings representing the recognized file suffixes for source
modules.

.. versionadded:: 3.3

.. attribute:: DEBUG_BYTECODE_SUFFIXES
.. data:: DEBUG_BYTECODE_SUFFIXES

A list of strings representing the file suffixes for non-optimized bytecode
modules.

.. versionadded:: 3.3

.. deprecated:: 3.5
Use :attr:`BYTECODE_SUFFIXES` instead.
Use :const:`BYTECODE_SUFFIXES` instead.

.. attribute:: OPTIMIZED_BYTECODE_SUFFIXES
.. data:: OPTIMIZED_BYTECODE_SUFFIXES

A list of strings representing the file suffixes for optimized bytecode
modules.

.. versionadded:: 3.3

.. deprecated:: 3.5
Use :attr:`BYTECODE_SUFFIXES` instead.
Use :const:`BYTECODE_SUFFIXES` instead.

.. attribute:: BYTECODE_SUFFIXES
.. data:: BYTECODE_SUFFIXES

A list of strings representing the recognized file suffixes for bytecode
modules (including the leading dot).
Expand All @@ -831,7 +831,7 @@ find and load modules.
.. versionchanged:: 3.5
The value is no longer dependent on ``__debug__``.

.. attribute:: EXTENSION_SUFFIXES
.. data:: EXTENSION_SUFFIXES

A list of strings representing the recognized file suffixes for
extension modules.
Expand Down Expand Up @@ -1109,7 +1109,7 @@ find and load modules.
.. method:: is_package(fullname)

Returns ``True`` if the file path points to a package's ``__init__``
module based on :attr:`EXTENSION_SUFFIXES`.
module based on :const:`EXTENSION_SUFFIXES`.

.. method:: get_code(fullname)

Expand Down Expand Up @@ -1294,7 +1294,7 @@ find and load modules.
This module contains the various objects that help in the construction of
an :term:`importer`.

.. attribute:: MAGIC_NUMBER
.. data:: MAGIC_NUMBER

The bytes which represent the bytecode version number. If you need help with
loading/writing bytecode then cons F438 ider :class:`importlib.abc.SourceLoader`.
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ in a module, ``__name__`` is the module's name in the Python package namespace.

If no handler is attached to this logger (or any of its ancestors,
taking into account the relevant :attr:`Logger.propagate` attributes),
the message will be sent to the handler set on :attr:`lastResort`.
the message will be sent to the handler set on :data:`lastResort`.

.. versionchanged:: 3.2
The *stack_info* parameter was added.
Expand Down Expand Up @@ -1495,7 +1495,7 @@ functions.
Module-Level Attributes
-----------------------

.. attribute:: lastResort
.. data:: lastResort

A "handler of last resort" is available through this attribute. This
is a :class:`StreamHandler` writing to ``sys.stderr`` with a level of
Expand All @@ -1507,7 +1507,7 @@ Module-Level Attributes

.. versionadded:: 3.2

.. attribute:: raiseExceptions
.. data:: raiseExceptions

Used to see if exceptions during handling should be propagated.

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/plistlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ This module defines the following functions:

When *aware_datetime* is true, fields with type ``datetime.datetime`` will
be created as :ref:`aware object <datetime-naive-aware>`, with
:attr:`!tzinfo` as :attr:`datetime.UTC`.
:attr:`!tzinfo` as :const:`datetime.UTC`.

XML data for the :data:`FMT_XML` format is parsed using the Expat parser
from :mod:`xml.parsers.expat` -- see its documentation for possible
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/select.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ The module defines the following:
:exc:`InterruptedError`.


.. attribute:: PIPE_BUF
.. data:: PIPE_BUF

The minimum number of bytes which can be written without blocking to a pipe
when the pipe has been reported as ready for writing by :func:`~select.select`,
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/site.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ are skipped. For the tail part, it uses the empty string and then
:file:`lib/site-packages` (on Windows) or
:file:`lib/python{X.Y[t]}/site-packages` (on Unix and macOS). (The
optional suffix "t" indicates the :term:`free threading` build, and is
appended if ``"t"`` is present in the :attr:`sys.abiflags` constant.)
appended if ``"t"`` is present in the :data:`sys.abiflags` constant.)
For each
of the distinct head-tail combinations, it sees if it refers to an existing
directory, and if so, adds it to ``sys.path`` and also inspects the newly
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/ssl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1937,8 +1937,8 @@ to speed up repeated connections from the same clients.

A :class:`TLSVersion` enum member representing the highest supported
TLS version. The value defaults to :attr:`TLSVersion.MAXIMUM_SUPPORTED`.
The attribute is read-only for protocols other than :attr:`PROTOCOL_TLS`,
:attr:`PROTOCOL_TLS_CLIENT`, and :attr:`PROTOCOL_TLS_SERVER`.
The attribute is read-only for protocols other than :const:`PROTOCOL_TLS`,
:const:`PROTOCOL_TLS_CLIENT`, and :const:`PROTOCOL_TLS_SERVER`.

The attributes :attr:`~SSLContext.maximum_version`,
:attr:`~SSLContext.minimum_version` and
Expand All @@ -1961,7 +1961,7 @@ to speed up repeated connections from the same clients.
.. attribute:: SSLContext.num_tickets

Control the number of TLS 1.3 session tickets of a
:attr:`PROTOCOL_TLS_SERVER` context. The setting has no impact on TLS
:const:`PROTOCOL_TLS_SERVER` context. The setting has no impact on TLS
1.0 to 1.2 connections.

.. versionadded:: 3.8
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/2.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ convert them to Unicode using the ``mbcs`` encoding.
Other systems also allow Unicode strings as file names but convert them to byte
strings before passing them to the system, which can cause a :exc:`UnicodeError`
to be raised. Applications can test whether arbitrary Unicode strings are
supported as file names by checking :attr:`os.path.supports_unicode_filenames`,
supported as file names by checking :const:`os.path.supports_unicode_filenames`,
a Boolean value.

Under MacOS, :func:`os.listdir` may now return Unicode filenames.
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/2.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1602,7 +1602,7 @@ changes, or look through the Subversion logs for all the details.
identifier instead of the previous default value of ``'python'``.
(Changed by Sean Reifschneider; :issue:`8451`.)

* The :attr:`sys.version_info` value is now a named tuple, with attributes
* The :data:`sys.version_info` value is now a named tuple, with attributes
named :attr:`!major`, :attr:`!minor`, :attr:`!micro`,
:attr:`!releaselevel`, and :attr:`!serial`. (Contributed by Ross
Light; :issue:`4285`.)
Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/3.12.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1467,8 +1467,8 @@ imp
``imp.NullImporter`` Insert ``None`` into ``sys.path_importer_cache``
``imp.cache_from_source()`` :func:`importlib.util.cache_from_source`
``imp.find_module()`` :func:`importlib.util.find_spec`
``imp.get_magic()`` :attr:`importlib.util.MAGIC_NUMBER`
``imp.get_suffixes()`` :attr:`importlib.machinery.SOURCE_SUFFIXES`, :attr:`importlib.machinery.EXTENSION_SUFFIXES`, and :attr:`importlib.machinery.BYTECODE_SUFFIXES`
``imp.get_magic()`` :const:`importlib.util.MAGIC_NUMBER`
``imp.get_suffixes()`` :const:`importlib.machinery.SOURCE_SUFFIXES`, :const:`importlib.machinery.EXTENSION_SUFFIXES`, and :const:`importlib.machinery.BYTECODE_SUFFIXES`
``imp.get_tag()`` :attr:`sys.implementation.cache_tag <sys.implementation>`
``imp.load_module()`` :func:`importlib.import_module`
``imp.new_module(name)`` ``types.ModuleType(name)``
Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/3.13.rst
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ enabled at runtime using the environment variable :envvar:`PYTHON_GIL` or
the command-line option :option:`-X gil=1`.

To check if the current interpreter supports free-threading, :option:`python -VV <-V>`
and :attr:`sys.version` contain "experimental free-threading build".
and :data:`sys.version` contain "experimental free-threading build".
The new :func:`!sys._is_gil_enabled` function can be used to check whether
the GIL is actually disabled in the running process.

Expand Down Expand Up @@ -1062,7 +1062,7 @@ os
which makes the newly spawned process use the current process environment.
(Contributed by Jakub Kulik in :gh:`113119`.)

* :func:`~os.posix_spawn` can now use the :attr:`~os.POSIX_SPAWN_CLOSEFROM`
* :func:`~os.posix_spawn` can now use the :const:`~os.POSIX_SPAWN_CLOSEFROM`
attribute in the *file_actions* parameter on platforms that support
:c:func:`!posix_spawn_file_actions_addclosefrom_np`.
(Contributed by Jakub Kulik in :gh:`113117`.)
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -994,7 +994,7 @@ The :func:`~importlib.reload` function has been moved from :mod:`!imp` to
:mod:`importlib` as part of the :mod:`!imp` module deprecation. (Contributed by
Berker Peksag in :issue:`18193`.)

:mod:`importlib.util` now has a :data:`~importlib.util.MAGIC_NUMBER` attribute
:mod:`importlib.util` now has a :const:`~importlib.util.MAGIC_NUMBER` attribute
providing access to the bytecode version number. This replaces the
:func:`!get_magic` function in the deprecated :mod:`!imp` module.
(Contributed by Brett Cannon in :issue:`18192`.)
Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.11.0a4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -775,8 +775,8 @@ Ensure that :func:`math.expm1` does not raise on underflow.
.. nonce: s9PuyF
.. section: Library

Adding :attr:`F_DUP2FD` and :attr:`F_DUP2FD_CLOEXEC` constants from FreeBSD
into the fcntl module.
Adding :const:`!F_DUP2FD` and :const:`!F_DUP2FD_CLOEXEC` constants from FreeBSD
into the :mod:`fcntl` module.

..

Expand Down
6 changes: 3 additions & 3 deletions Misc/NEWS.d/3.14.0a1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -798,7 +798,7 @@ when used with ``happy_eyeballs_delay``

Fixed :exc:`AssertionError` when using
:func:`!asyncio.staggered.staggered_race` with
:attr:`asyncio.eager_task_factory`.
:data:`asyncio.eager_task_factory`.

..

Expand Down Expand Up @@ -1755,8 +1755,8 @@ Adjust ``cmath.tanh(nanj)`` and ``cmath.tanh(infj)`` for recent C standards.
Remove internal frames from tracebacks shown in
:class:`code.InteractiveInterpreter` with non-default
:func:`sys.excepthook`. Save correct tracebacks in
:attr:`sys.last_traceback` and update ``__traceback__`` attribute of
:attr:`sys.last_value` and :attr:`sys.last_exc`.
:data:`sys.last_traceback` and update ``__traceback__`` attribute of
:data:`sys.last_value` and :data:`sys.last_exc`.

..

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Add missing Deprecation warnings for :attr:`importlib.machinery.DEBUG_BYTECODE_SUFFIXES`, :attr:`importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES`, :class:`importlib.machinery.WindowsRegistryFinder`, :class:`importlib.abc.ResourceLoader`, :meth:`importlib.abc.SourceLoader.path_mtime`.
Add missing Deprecation warnings for :const:`importlib.machinery.DEBUG_BYTECODE_SUFFIXES`, :const:`importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES`, :class:`importlib.machinery.WindowsRegistryFinder`, :class:`importlib.abc.ResourceLoader`, :meth:`importlib.abc.SourceLoader.path_mtime`.
Loading
0