Skip to content

Commit

Permalink
gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section (GH-9…
Browse files Browse the repository at this point in the history
…8304)

(cherry picked from commit 8f30267)

Co-authored-by: C.A.M. Gerlach <[email protected]>
  • Loading branch information
miss-islington and CAM-Gerlach authored Oct 22, 2022
1 parent 24e8d0c commit 519b56a
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 16 deletions.
22 changes: 15 additions & 7 deletions Doc/library/inspect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -434,8 +434,10 @@ attributes:

Return ``True`` if the type of object is a :class:`~types.MethodWrapperType`.

These are instances of :class:`~types.MethodWrapperType`, such as :meth:`~object().__str__`,
:meth:`~object().__eq__` and :meth:`~object().__repr__`
These are instances of :class:`~types.MethodWrapperType`, such as :meth:`~object.__str__`,
:meth:`~object.__eq__` and :meth:`~object.__repr__`.

.. versionadded:: 3.11


.. function:: isroutine(object)
Expand Down Expand Up @@ -1206,12 +1208,13 @@ is considered deprecated and may be removed in the future.
number, start column offset, and end column offset associated with the
instruction being executed by the frame this record corresponds to.

.. versionchanged:: 3.5
Return a named tuple instead of a tuple.
.. versionchanged:: 3.5
Return a :term:`named tuple` instead of a :class:`tuple`.

.. versionchanged:: 3.11
:class:`!FrameInfo` is now a class instance
(that is backwards compatible with the previous :term:`named tuple`).

.. versionchanged:: 3.11
Changed the return object from a named tuple to a regular object (that is
backwards compatible with the previous named tuple).

.. class:: Traceback

Expand Down Expand Up @@ -1245,6 +1248,11 @@ is considered deprecated and may be removed in the future.
the instruction being executed by the frame this traceback corresponds
to.

.. versionchanged:: 3.11
:class:`!Traceback` is now a class instance
(that is backwards compatible with the previous :term:`named tuple`).


.. note::

Keeping references to frame objects, as found in the first element of the frame
Expand Down
29 changes: 20 additions & 9 deletions Doc/whatsnew/3.11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -775,22 +775,33 @@ IDLE and idlelib
* Include prompts when saving Shell with inputs and outputs.
(Contributed by Terry Jan Reedy in :gh:`95191`.)


.. _whatsnew311-inspect:

inspect
-------
* Add :func:`inspect.getmembers_static`: return all members without

* Add :func:`~inspect.getmembers_static` to return all members without
triggering dynamic lookup via the descriptor protocol. (Contributed by
Weipeng Hong in :issue:`30533`.)

* Add :func:`inspect.ismethodwrapper` for checking if the type of an object is a
:class:`~types.MethodWrapperType`. (Contributed by Hakan Çelik in :issue:`29418`.)
* Add :func:`~inspect.ismethodwrapper`
for checking if the type of an object is a :class:`~types.MethodWrapperType`.
(Contributed by Hakan Çelik in :issue:`29418`.)

* Change the frame-related functions in the :mod:`inspect` module to return a
regular object (that is backwards compatible with the old tuple-like
interface) that include the extended :pep:`657` position information (end
* Change the frame-related functions in the :mod:`inspect` module to return new
:class:`~inspect.FrameInfo` and :class:`~inspect.Traceback` class instances
(backwards compatible with the previous :term:`named tuple`-like interfaces)
that includes the extended :pep:`657` position information (end
line number, column and end column). The affected functions are:
:func:`inspect.getframeinfo`, :func:`inspect.getouterframes`, :func:`inspect.getinnerframes`,
:func:`inspect.stack` and :func:`inspect.trace`. (Contributed by Pablo Galindo in
:gh:`88116`.)

* :func:`inspect.getframeinfo`
* :func:`inspect.getouterframes`
* :func:`inspect.getinnerframes`,
* :func:`inspect.stack`
* :func:`inspect.trace`

(Contributed by Pablo Galindo in :gh:`88116`.)

locale
------
Expand Down

0 comments on commit 519b56a

Please sign in to comment.