Skip to content

gh-151950: Fix dangling class reference in pickletools docs #152209

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.

Sign up for GitHub

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

Open
BHUVANSH855 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

gh-151950: Fix dangling class reference in pickletools docs #152209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c819cac
gh-151950: Fix dangling reference in pickletools docs
BHUVANSH855 Jun 25, 2026
b20de99
gh-151950: Export pickletools public classes
BHUVANSH855 Nov 3, 2026
662e176
gh-151950: Update pickletools export test
BHUVANSH855 Nov 3, 2026
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
42 changes: 39 additions & 3 deletions Doc/library/pickletools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,47 @@ Programmatic interface
.. function:: genops(pickle)

Provides an :term:`iterator` over all of the opcodes in a pickle, returning a
sequence of ``(opcode, arg, pos)`` triples. *opcode* is an instance of an
:class:`OpcodeInfo` class; *arg* is the decoded value, as a Python object, of
the opcode's argument; *pos* is the position at which this opcode is located.
sequence of ``(opcode, arg, pos)`` triples. *opcode* is an instance of
:class:`OpcodeInfo`; *arg* is the decoded value, as a Python object, of the

@StanFromIreland StanFromIreland Jul 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert the change moving "the" let's not have churn. Also we can remove the "an" before OpcodeInfo.

@hugovk hugovk Nov 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs WG monthly meeting triage: please move "the" back.

opcode's argument; *pos* is the position at which this opcode is located.
*pickle* can be a string or a file-like object.

.. class:: OpcodeInfo

@StanFromIreland StanFromIreland Jul 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't in pickletools.__all__ so if we're documenting it we should add it there, and also ArgumentDescriptor and StackObject. They are technically already public per PEP 387, and we do return them, so I think we should expose them properly.

@hugovk hugovk Nov 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs WG monthly meeting triage: please either add these __all__ in to pickletools.py, or say why they don't need adding.


Represents information about a pickle opcode.

Instances of this class are returned as the first element of the tuples
yielded by :func:`genops`.

.. attribute:: name

The symbolic name of the opcode.

.. attribute:: code

The one-character opcode value.

.. attribute:: arg

The descriptor for the opcode argument, or ``None`` if the opcode has
no argument.

.. attribute:: stack_before

A list describing the stack before the opcode executes.

.. attribute:: stack_after

A list describing the stack after the opcode executes.

.. attribute:: proto

The pickle protocol version in which the opcode was introduced.

.. attribute:: doc

A human-readable description of the opcode.

.. function:: optimize(picklestring)

Returns a new equivalent pickle string after eliminating unused ``PUT``
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Doc/library/lzma.rst
Doc/library/mmap.rst
Doc/library/multiprocessing.rst
Doc/library/optparse.rst
Doc/library/pickletools.rst
Doc/library/pyexpat.rst
Doc/library/select.rst
Doc/library/socket.rst
Expand Down
9 changes: 8 additions & 1 deletion Lib/pickletools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,14 @@

lazy from _colorize import decolor, get_theme

__all__ = ['dis', 'genops', 'optimize']
__all__ = [
'dis',
'genops',
'optimize',
'ArgumentDescriptor',
'StackObject',
'OpcodeInfo',
]

bytes_types = pickle.bytes_types

Expand Down
5 changes: 2 additions & 3 deletions Lib/test/test_pickletools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,7 @@ def test__all__(self):
'bytes_types',
'UP_TO_NEWLINE', 'TAKEN_FROM_ARGUMENT1',
'TAKEN_FROM_ARGUMENT4', 'TAKEN_FROM_ARGUMENT4U',
'TAKEN_FROM_ARGUMENT8U', 'ArgumentDescriptor',
'TAKEN_FROM_ARGUMENT8U',
'read_uint1', 'read_uint2', 'read_int4', 'read_uint4',
'read_uint8', 'read_stringnl', 'read_stringnl_noescape',
'read_stringnl_noescape_pair', 'read_string1',
Expand All @@ -508,12 +508,11 @@ def test__all__(self):
'unicodestringnl', 'unicodestring1', 'unicodestring4',
'unicodestring8', 'decimalnl_short', 'decimalnl_long',
'floatnl', 'float8', 'long1', 'long4',
'StackObject',
'pyint', 'pylong', 'pyinteger_or_bool', 'pybool', 'pyfloat',
'pybytes_or_str', 'pystring', 'pybytes', 'pybytearray',
'pyunicode', 'pynone', 'pytuple', 'pylist', 'pydict',
'pyset', 'pyfrozenset', 'pybuffer', 'anyobject',
'markobject', 'stackslice', 'OpcodeInfo', 'opcodes',
'markobject', 'stackslice', 'opcodes',
'code2op',
}
support.check__all__(self, pickletools, not_exported=not_exported)
Expand Down
Loading