gh-114616: Improve docs regarding changes to caches representation in dis (#120033)

This commit is contained in:
Irit Katriel 2024-06-05 00:00:02 +01:00 committed by GitHub
parent 69b3e8ea56
commit 770f3c1ead
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 3 deletions

View File

@ -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)

View File

@ -706,6 +706,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