<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"module-distutils.html" />
<link rel=
"prev" href=
"module-dis.html" />
<link rel=
"parent" href=
"language.html" />
<link rel=
"next" href=
"module-distutils.html" />
<meta name='aesop' content='information'
/>
<title>18.11 pickletools -- Tools for pickle developers.
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"18.10.1 Python Byte Code"
href=
"bytecodes.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"18. Python Language Services"
href=
"language.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"18.12 distutils "
href=
"module-distutils.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"bytecodes.html">18.10.1 Python Byte Code
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"language.html">18. Python Language Services
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-distutils.html">18.12 distutils
</A>
<!--End of Navigation Panel-->
<H1><A NAME=
"SECTION00201100000000000000000">
18.11 <tt class=
"module">pickletools
</tt> -- Tools for pickle developers.
</A>
<A NAME=
"module-pickletools"></A>
This module contains various constants relating to the intimate
details of the
<tt class=
"module"><a href=
"module-pickle.html">pickle
</a></tt> 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
<tt class=
"module">pickle
</tt> and
<tt class=
"module">cPickle
</tt>
implementations; ordinary users of the
<tt class=
"module">pickle
</tt> module probably
won't find the
<tt class=
"module">pickletools
</tt> module relevant.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5016' xml:id='l2h-
5016'
class=
"function">dis
</tt></b>(
</nobr></td>
<td><var>pickle
</var><big>[
</big><var>, out=None, memo=None, indentlevel=
4</var><big>]
</big><var></var>)
</td></tr></table></dt>
Outputs a symbolic disassembly of the pickle to the file-like object
<var>out
</var>, defaulting to
<code>sys.stdout
</code>.
<var>pickle
</var> can be a
string or a file-like object.
<var>memo
</var> 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
</code> opcodes in the stream, are
indented by
<var>indentlevel
</var> spaces.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
5017' xml:id='l2h-
5017'
class=
"function">genops
</tt></b>(
</nobr></td>
<td><var>pickle
</var>)
</td></tr></table></dt>
Provides an iterator over all of the opcodes in a pickle, returning a
sequence of
<code>(
<var>opcode
</var>,
<var>arg
</var>,
<var>pos
</var>)
</code> triples.
<var>opcode
</var> is an instance of an
<tt class=
"class">OpcodeInfo
</tt> class;
<var>arg
</var>
is the decoded value, as a Python object, of the opcode's argument;
<var>pos
</var> is the position at which this opcode is located.
<var>pickle
</var> can be a string or a file-like object.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"18.10.1 Python Byte Code"
href=
"bytecodes.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"18. Python Language Services"
href=
"language.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"18.12 distutils "
href=
"module-distutils.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"bytecodes.html">18.10.1 Python Byte Code
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"language.html">18. Python Language Services
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-distutils.html">18.12 distutils
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.