Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit05ea7e5

Browse files
[3.11]gh-101100: Fix most Sphinx nitpicks ininspect.rst (GH-112662) (#112667)
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662)(cherry picked from commit45650d1)Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
1 parent36ad8e6 commit05ea7e5

File tree

5 files changed

+19
-9
lines changed

5 files changed

+19
-9
lines changed

‎Doc/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,9 @@
149149
('envvar','USER'),
150150
('envvar','USERNAME'),
151151
('envvar','USERPROFILE'),
152+
# Deprecated function that was never documented:
153+
('py:func','getargspec'),
154+
('py:func','inspect.getargspec'),
152155
]
153156

154157
# Temporary undocumented names.

‎Doc/library/inspect.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ attributes (see :ref:`import-mod-attrs` for module attributes):
273273

274274
:func:`getmembers` will only return class attributes defined in the
275275
metaclass when the argument is a class and those attributes have been
276-
listed in the metaclass' custom:meth:`__dir__`.
276+
listed in the metaclass' custom:meth:`~object.__dir__`.
277277

278278

279279
..function::getmembers_static(object[, predicate])
@@ -466,12 +466,13 @@ attributes (see :ref:`import-mod-attrs` for module attributes):
466466
has a:meth:`~object.__get__` method but not a:meth:`~object.__set__`
467467
method, but beyond that the set of attributes varies. A
468468
:attr:`~definition.__name__` attribute is usually
469-
sensible, and:attr:`__doc__` often is.
469+
sensible, and:attr:`!__doc__` often is.
470470

471471
Methods implemented via descriptors that also pass one of the other tests
472472
return ``False`` from the:func:`ismethoddescriptor` test, simply because the
473473
other tests promise more -- you can, e.g., count on having the
474-
:attr:`__func__` attribute (etc) when an object passes:func:`ismethod`.
474+
:ref:`__func__<instance-methods>` attribute (etc) when an object passes
475+
:func:`ismethod`.
475476

476477

477478
..function::isdatadescriptor(object)
@@ -482,7 +483,7 @@ attributes (see :ref:`import-mod-attrs` for module attributes):
482483
Examples are properties (defined in Python), getsets, and members. The
483484
latter two are defined in C and there are more specific tests available for
484485
those types, which is robust across Python implementations. Typically, data
485-
descriptors will also have:attr:`~definition.__name__` and:attr:`__doc__` attributes
486+
descriptors will also have:attr:`~definition.__name__` and:attr:`!__doc__` attributes
486487
(properties, getsets, and members have both of these attributes), but this is
487488
not guaranteed.
488489

@@ -1401,7 +1402,8 @@ Fetching attributes statically
14011402

14021403
Both:func:`getattr` and:func:`hasattr` can trigger code execution when
14031404
fetching or checking for the existence of attributes. Descriptors, like
1404-
properties, will be invoked and:meth:`__getattr__` and:meth:`__getattribute__`
1405+
properties, will be invoked and:meth:`~object.__getattr__` and
1406+
:meth:`~object.__getattribute__`
14051407
may be called.
14061408

14071409
For cases where you want passive introspection, like documentation tools, this
@@ -1411,7 +1413,8 @@ but avoids executing code when it fetches attributes.
14111413
..function::getattr_static(obj, attr, default=None)
14121414

14131415
Retrieve attributes without triggering dynamic lookup via the
1414-
descriptor protocol,:meth:`__getattr__` or:meth:`__getattribute__`.
1416+
descriptor protocol,:meth:`~object.__getattr__`
1417+
or:meth:`~object.__getattribute__`.
14151418

14161419
Note: this function may not be able to retrieve all attributes
14171420
that getattr can fetch (like dynamically created attributes)

‎Doc/reference/datamodel.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -627,6 +627,8 @@ code object; see the description of internal types below. The
627627
module.
628628

629629

630+
.. _instance-methods:
631+
630632
Instance methods
631633
^^^^^^^^^^^^^^^^
632634

‎Doc/whatsnew/2.6.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1677,8 +1677,9 @@ Some smaller changes made to the core Python language are:
16771677
(:issue:`1591665`)
16781678

16791679
* Instance method objects have new attributes for the object and function
1680-
comprising the method; the new synonym for:attr:`im_self` is
1681-
:attr:`__self__`, and:attr:`im_func` is also available as:attr:`__func__`.
1680+
comprising the method; the new synonym for:attr:`!im_self` is
1681+
:ref:`__self__<instance-methods>`, and:attr:`!im_func` is also available as
1682+
:ref:`__func__<instance-methods>`.
16821683
The old names are still supported in Python 2.6, but are gone in 3.0.
16831684

16841685
* An obscure change: when you use the:func:`locals` function inside a

‎Doc/whatsnew/2.7.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -860,7 +860,8 @@ Some smaller changes made to the core Python language are:
860860
861861
* When using ``@classmethod`` and ``@staticmethod`` to wrap
862862
methods as class or static methods, the wrapper object now
863-
exposes the wrapped function as their:attr:`__func__` attribute.
863+
exposes the wrapped function as their:ref:`__func__<instance-methods>`
864+
attribute.
864865
(Contributed by Amaury Forgeot d'Arc, after a suggestion by
865866
George Sakkis;:issue:`5982`.)
866867

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp