aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2024-06-05 01:15:39 +0200
committerGitHub <noreply@github.com>2024-06-04 23:15:39 +0000
commita653562072eefed46dec41e831b02f5ec0084a38 (patch)
tree92be38eafdac76cd803b94fb04daf08e05ae964e
parent[3.13] gh-119553: Fix console when pressing Ctrl-C within a multiline block (... (diff)
downloadcpython-a653562072eefed46dec41e831b02f5ec0084a38.tar.gz
cpython-a653562072eefed46dec41e831b02f5ec0084a38.tar.bz2
cpython-a653562072eefed46dec41e831b02f5ec0084a38.zip
[3.13] gh-114616: Improve docs regarding changes to caches representation in dis (GH-120033) (#120079)
gh-114616: Improve docs regarding changes to caches representation in dis (GH-120033) (cherry picked from commit 770f3c1eadd3392c72fd55be47770234dd143a14) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
-rw-r--r--Doc/library/dis.rst7
-rw-r--r--Doc/whatsnew/3.13.rst7
2 files changed, 11 insertions, 3 deletions
diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst
index b9e2efab827..ca215888f09 100644
--- a/Doc/library/dis.rst
+++ b/Doc/library/dis.rst
@@ -336,9 +336,10 @@ operation is being performed, so the intermediate analysis object isn't useful:
Added the *show_caches* and *adaptive* parameters.
.. versionchanged:: 3.13
- The *show_caches* parameter is deprecated and has no effect. The *cache_info*
- field of each instruction is populated regardless of its value.
-
+ The *show_caches* parameter is deprecated and has no effect. The iterator
+ generates the :class:`Instruction` instances with the *cache_info*
+ field populated (regardless of the value of *show_caches*) and it no longer
+ generates separate items for the cache entries.
.. function:: findlinestarts(code)
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index e655710e083..b4b7cb9be52 100644
--- a/Doc/whatsnew/3.13.rst
+++ b/Doc/whatsnew/3.13.rst
@@ -694,6 +694,13 @@ dis
the ``show_offsets`` parameter.
(Contributed by Irit Katriel in :gh:`112137`.)
+* :meth:`~dis.get_instructions` no longer represents cache entries as
+ separate instructions. Instead, it returns them as part of the
+ :class:`~dis.Instruction`, in the new *cache_info* field. The
+ *show_caches* argument to :meth:`~dis.get_instructions` is
+ deprecated and no longer has any effect.
+ (Contributed by Irit Katriel in :gh:`112962`.)
+
.. _whatsnew313-doctest:
doctest