languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-10-15 05:53:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Bug #873146] Document pickletools module (haven't tested the LaTeX yet)

Browse source
This commit is contained in:
Andrew M. Kuchling 2004-08-07 16:53:59 +00:00
parent d0c53fedd0
commit 8def876d36
2 changed files with 33 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Doc/lib/lib.tex
View file

@ -322,6 +322,7 @@ and how to embed it in other applications.
\input{libpycompile} % really py_compile
\input{libcompileall}
\input{libdis}
\input{libpickletools}
\input{distutils}
\input{compiler} % compiler package

32
Doc/lib/libpickletools.tex Normal file
View file

@ -0,0 +1,32 @@
\section{\module{pickletools} --- Tools for pickle developers.}
\declaremodule{standard}{pickletools}
\modulesynopsis{Contains extensive comments about the pickle protocols and pickle-machine opcodes, as well as some useful functions.}
This module contains various constants relating to the intimate
details of the \refmodule{pickle} module, some lengthy comments about
the implementation, and a few useful functions for analyzing pickled
data. The contents of this module are useful for Python core
developers who are working on the \module{pickle} and \module{cPickle}
implementations; ordinary users of the \module{pickle} module probably
won't find the \module{pickletools} module relevant.
\begin{funcdesc}{dis}{pickle\optional{, out=None, memo=None, indentlevel=4}}
Outputs a symbolic disassembly of the pickle to the file-like object
\var{out}, defaulting to \code{sys.stdout}. \var{pickle} can be a
string or a file-like object. \var{memo} can be a Python dictionary
that will be used as the pickle's memo; it can be used to perform
disassemblies across multiple pickles created by the same pickler.
Successive levels, indicated by \code{MARK} opcodes in the stream, are
indented by \var{indentlevel} spaces.
\end{funcdesc}
\begin{funcdesc}{genops}{pickle}
Provides an iterator over all of the opcodes in a pickle, returning a
sequence of \code{(\var{opcode}, \var{arg}, \var{pos})} triples.
\var{opcode} is an instance of an \class{OpcodeInfo} class; \var{arg}
is the decoded value, as a Python object, of the opcode's argument;
\var{pos} is the position at which this opcode is located.
\var{pickle} can be a string or a file-like object.
\end{funcdesc}