Skip to content

[3.13] gh-114616: Improve docs regarding changes to caches representation in dis (GH-120033) #120079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Doc/library/dis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
7 changes: 7 additions & 0 deletions Doc/whatsnew/3.13.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading