[Python-checkins] gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section (GH-98304)

miss-islington webhook-mailer at python.org
Sat Oct 22 15:21:07 EDT 2022


https://github.com/python/cpython/commit/519b56a5c79e00c9d97aadacefec893effdc396d
commit: 519b56a5c79e00c9d97aadacefec893effdc396d
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-10-22T12:21:01-07:00
summary:

gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section (GH-98304)

(cherry picked from commit 8f30267ab49e1ef3ac3165a102b2196336547c8a)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach at Gerlach.CAM>

files:
M Doc/library/inspect.rst
M Doc/whatsnew/3.11.rst

diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index 700cd9122cd3..44f1ae04c9e3 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -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)
@@ -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
 
@@ -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
diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index 507b06b8c568..c143a418f3c5 100644
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -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
 ------



More information about the Python-checkins mailing list