mirror of
https://github.com/python/cpython.git
synced 2025-11-24 12:20:42 +00:00
[3.14] GH-101100: Remove some entries from `nitpick_ignore` (GH-138464) (#138683)
* GH-101100: Remove some entries from ``nitpick_ignore`` (GH-138464)
(cherry picked from commit 22cb9ba8f9)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Update check-warnings.py
---------
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
parent
dee3428120
commit
829c81ae21
18 changed files with 33 additions and 34 deletions
|
|
@ -221,13 +221,6 @@ nitpick_ignore = [
|
|||
('envvar', 'USER'),
|
||||
('envvar', 'USERNAME'),
|
||||
('envvar', 'USERPROFILE'),
|
||||
# Deprecated function that was never documented:
|
||||
('py:func', 'getargspec'),
|
||||
('py:func', 'inspect.getargspec'),
|
||||
# Undocumented modules that users shouldn't have to worry about
|
||||
# (implementation details of `os.path`):
|
||||
('py:mod', 'ntpath'),
|
||||
('py:mod', 'posixpath'),
|
||||
]
|
||||
|
||||
# Temporary undocumented names.
|
||||
|
|
@ -242,8 +235,6 @@ nitpick_ignore += [
|
|||
('py:meth', '_SubParsersAction.add_parser'),
|
||||
# Attributes/methods/etc. that definitely should be documented better,
|
||||
# but are deferred for now:
|
||||
('py:attr', '__annotations__'),
|
||||
('py:meth', '__missing__'),
|
||||
('py:attr', '__wrapped__'),
|
||||
]
|
||||
|
||||
|
|
|
|||
|
|
@ -758,9 +758,9 @@ stack manipulations such as ``dup``, ``drop``, ``swap``, ``over``, ``pick``,
|
|||
|
||||
.. attribute:: default_factory
|
||||
|
||||
This attribute is used by the :meth:`__missing__` method; it is
|
||||
initialized from the first argument to the constructor, if present, or to
|
||||
``None``, if absent.
|
||||
This attribute is used by the :meth:`~defaultdict.__missing__` method;
|
||||
it is initialized from the first argument to the constructor, if present,
|
||||
or to ``None``, if absent.
|
||||
|
||||
.. versionchanged:: 3.9
|
||||
Added merge (``|``) and update (``|=``) operators, specified in
|
||||
|
|
|
|||
|
|
@ -439,7 +439,7 @@ Module contents
|
|||
function is used.
|
||||
|
||||
This function is not strictly required, because any Python
|
||||
mechanism for creating a new class with :attr:`!__annotations__` can
|
||||
mechanism for creating a new class with :attr:`~object.__annotations__` can
|
||||
then apply the :func:`@dataclass <dataclass>` function to convert that class to
|
||||
a dataclass. This function is provided as a convenience. For
|
||||
example::
|
||||
|
|
|
|||
|
|
@ -1086,6 +1086,11 @@ iterations of the loop.
|
|||
Pushes ``co_consts[consti]`` onto the stack.
|
||||
|
||||
|
||||
.. opcode:: LOAD_CONST_IMMORTAL (consti)
|
||||
|
||||
Works as :opcode:`LOAD_CONST`, but is more efficient for immortal objects.
|
||||
|
||||
|
||||
.. opcode:: LOAD_SMALL_INT (i)
|
||||
|
||||
Pushes the integer ``i`` onto the stack.
|
||||
|
|
|
|||
|
|
@ -1179,7 +1179,7 @@ Classes and functions
|
|||
:func:`signature` in Python 3.5, but that decision has been reversed
|
||||
in order to restore a clearly supported standard interface for
|
||||
single-source Python 2/3 code migrating away from the legacy
|
||||
:func:`getargspec` API.
|
||||
:func:`!getargspec` API.
|
||||
|
||||
.. versionchanged:: 3.7
|
||||
Python only explicitly guaranteed that it preserved the declaration
|
||||
|
|
|
|||
|
|
@ -42,8 +42,8 @@ the :mod:`glob` module.)
|
|||
a path that is *always* in one of the different formats. They all have the
|
||||
same interface:
|
||||
|
||||
* :mod:`posixpath` for UNIX-style paths
|
||||
* :mod:`ntpath` for Windows paths
|
||||
* :mod:`!posixpath` for UNIX-style paths
|
||||
* :mod:`!ntpath` for Windows paths
|
||||
|
||||
|
||||
.. versionchanged:: 3.8
|
||||
|
|
|
|||
|
|
@ -311,7 +311,7 @@ Pure paths provide the following methods and properties:
|
|||
.. attribute:: PurePath.parser
|
||||
|
||||
The implementation of the :mod:`os.path` module used for low-level path
|
||||
parsing and joining: either :mod:`posixpath` or :mod:`ntpath`.
|
||||
parsing and joining: either :mod:`!posixpath` or :mod:`!ntpath`.
|
||||
|
||||
.. versionadded:: 3.13
|
||||
|
||||
|
|
|
|||
|
|
@ -5014,13 +5014,13 @@ can be used interchangeably to index the same dictionary entry.
|
|||
|
||||
.. index:: __missing__()
|
||||
|
||||
If a subclass of dict defines a method :meth:`__missing__` and *key*
|
||||
If a subclass of dict defines a method :meth:`~object.__missing__` and *key*
|
||||
is not present, the ``d[key]`` operation calls that method with the key *key*
|
||||
as argument. The ``d[key]`` operation then returns or raises whatever is
|
||||
returned or raised by the ``__missing__(key)`` call.
|
||||
No other operations or methods invoke :meth:`__missing__`. If
|
||||
:meth:`__missing__` is not defined, :exc:`KeyError` is raised.
|
||||
:meth:`__missing__` must be a method; it cannot be an instance variable::
|
||||
No other operations or methods invoke :meth:`~object.__missing__`. If
|
||||
:meth:`~object.__missing__` is not defined, :exc:`KeyError` is raised.
|
||||
:meth:`~object.__missing__` must be a method; it cannot be an instance variable::
|
||||
|
||||
>>> class Counter(dict):
|
||||
... def __missing__(self, key):
|
||||
|
|
@ -5034,7 +5034,8 @@ can be used interchangeably to index the same dictionary entry.
|
|||
1
|
||||
|
||||
The example above shows part of the implementation of
|
||||
:class:`collections.Counter`. A different ``__missing__`` method is used
|
||||
:class:`collections.Counter`.
|
||||
A different :meth:`!__missing__` method is used
|
||||
by :class:`collections.defaultdict`.
|
||||
|
||||
.. describe:: d[key] = value
|
||||
|
|
|
|||
|
|
@ -1067,8 +1067,8 @@ subject value:
|
|||
|
||||
.. note:: Key-value pairs are matched using the two-argument form of the mapping
|
||||
subject's ``get()`` method. Matched key-value pairs must already be present
|
||||
in the mapping, and not created on-the-fly via :meth:`__missing__` or
|
||||
:meth:`~object.__getitem__`.
|
||||
in the mapping, and not created on-the-fly via :meth:`~object.__missing__`
|
||||
or :meth:`~object.__getitem__`.
|
||||
|
||||
In simple terms ``{KEY1: P1, KEY2: P2, ... }`` matches only if all the following
|
||||
happens:
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ from pathlib import Path
|
|||
from typing import TextIO
|
||||
|
||||
# Fail if NEWS nit found before this line number
|
||||
NEWS_NIT_THRESHOLD = 1700
|
||||
NEWS_NIT_THRESHOLD = 7850
|
||||
|
||||
# Exclude these whether they're dirty or clean,
|
||||
# because they trigger a rebuild of dirty files.
|
||||
|
|
|
|||
|
|
@ -1074,7 +1074,7 @@ Function Annotations
|
|||
information about the types used by user-defined functions (see :pep:`3107` and
|
||||
:pep:`484` for more information).
|
||||
|
||||
:term:`Annotations <function annotation>` are stored in the :attr:`!__annotations__`
|
||||
:term:`Annotations <function annotation>` are stored in the :attr:`~object.__annotations__`
|
||||
attribute of the function as a dictionary and have no effect on any other part of the
|
||||
function. Parameter annotations are defined by a colon after the parameter name, followed
|
||||
by an expression evaluating to the value of the annotation. Return annotations are
|
||||
|
|
|
|||
|
|
@ -458,7 +458,7 @@ Some smaller changes made to the core Python language are:
|
|||
:class:`~collections.defaultdict`, :class:`~shelve.Shelf`,
|
||||
:class:`~configparser.ConfigParser`, or :mod:`dbm`. It is also useful with
|
||||
custom :class:`dict` subclasses that normalize keys before look-up or that
|
||||
supply a :meth:`__missing__` method for unknown keys::
|
||||
supply a :meth:`~object.__missing__` method for unknown keys::
|
||||
|
||||
>>> import shelve
|
||||
>>> d = shelve.open('tmp.shl')
|
||||
|
|
|
|||
|
|
@ -1039,7 +1039,7 @@ As part of the implementation of the new :mod:`enum` module, the
|
|||
metaclasses. (Contributed by Ethan Furman in :issue:`18929` and
|
||||
:issue:`19030`.)
|
||||
|
||||
:func:`~inspect.getfullargspec` and :func:`~inspect.getargspec`
|
||||
:func:`~inspect.getfullargspec` and :func:`!getargspec`
|
||||
now use the :func:`~inspect.signature` API. This allows them to
|
||||
support a much broader range of callables, including those with
|
||||
``__signature__`` attributes, those with metadata provided by argument
|
||||
|
|
|
|||
|
|
@ -2324,7 +2324,7 @@ The previously undocumented ``from_function`` and ``from_builtin`` methods of
|
|||
:meth:`Signature.from_callable() <inspect.Signature.from_callable>`
|
||||
method instead. (Contributed by Yury Selivanov in :issue:`24248`.)
|
||||
|
||||
The :func:`inspect.getargspec` function is deprecated and scheduled to be
|
||||
The :func:`!inspect.getargspec` function is deprecated and scheduled to be
|
||||
removed in Python 3.6. (See :issue:`20438` for details.)
|
||||
|
||||
The :mod:`inspect` :func:`~inspect.getfullargspec`,
|
||||
|
|
|
|||
|
|
@ -1224,7 +1224,7 @@ generator expression scopes as if they were positional-only parameters called
|
|||
``implicit0``. (Contributed by Jelle Zijlstra in :issue:`19611`.)
|
||||
|
||||
To reduce code churn when upgrading from Python 2.7 and the legacy
|
||||
:func:`inspect.getargspec` API, the previously documented deprecation of
|
||||
:func:`!inspect.getargspec` API, the previously documented deprecation of
|
||||
:func:`inspect.getfullargspec` has been reversed. While this function is
|
||||
convenient for single/source Python 2/3 code bases, the richer
|
||||
:func:`inspect.signature` interface remains the recommended approach for new
|
||||
|
|
|
|||
|
|
@ -4330,7 +4330,7 @@ and ``sendfile`` inside ``IocpProactor``.
|
|||
.. nonce: GsBL9-
|
||||
.. section: Library
|
||||
|
||||
Fixed :meth:`collections.UserDict.get` to not call :meth:`__missing__` when
|
||||
Fixed :meth:`collections.UserDict.get` to not call :meth:`~object.__missing__` when
|
||||
a value is not found. This matches the behavior of :class:`dict`. Patch by
|
||||
Bar Harel.
|
||||
|
||||
|
|
|
|||
|
|
@ -264,7 +264,8 @@ Improve performance of :func:`os.path.join` and :func:`os.path.expanduser`.
|
|||
.. nonce: hqk9Hn
|
||||
.. section: Library
|
||||
|
||||
Raise :exc:`TypeError` for non-paths in :func:`posixpath.relpath`.
|
||||
Raise :exc:`TypeError` for non-paths in :func:`posixpath.relpath
|
||||
<os.path.relpath>`.
|
||||
|
||||
..
|
||||
|
||||
|
|
@ -273,7 +274,8 @@ Raise :exc:`TypeError` for non-paths in :func:`posixpath.relpath`.
|
|||
.. nonce: l6rWlj
|
||||
.. section: Library
|
||||
|
||||
Preserve mailbox ownership when rewriting in :func:`mailbox.mbox.flush`.
|
||||
Preserve mailbox ownership when rewriting in :func:`mailbox.mbox.flush
|
||||
<mailbox.Mailbox.flush>`.
|
||||
Patch by Tony Mountifield.
|
||||
|
||||
..
|
||||
|
|
|
|||
|
|
@ -192,7 +192,7 @@ The :class:`ctypes.py_object` type now supports subscription, making it a
|
|||
.. nonce: cX4yTn
|
||||
.. section: Library
|
||||
|
||||
Add the :attr:`zipfile.ZipFile.data_offset` attribute, which stores the
|
||||
Add the :attr:`!zipfile.ZipFile.data_offset` attribute, which stores the
|
||||
offset to the beginning of ZIP data in a file when available. When the
|
||||
:class:`zipfile.ZipFile` is opened in either mode ``'w'`` or ``'x'`` and the
|
||||
underlying file does not support ``tell()``, the value will be ``None``
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue