[OpenSPARC-T2-DV] / tools / src / nas,5.n2.os.2 / lib / python / html / python / lib / module-pickletools.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<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>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<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>
</tr></table>
<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>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION00201100000000000000000">
18.11 <tt class="module">pickletools</tt> -- Tools for pickle developers.</A>
</H1>

<P>
<A NAME="module-pickletools"></A>

<P>
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.

<P>
<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>
<dd>
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>

<P>
<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>
<dd>
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.
</dl>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<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>
</tr></table>
<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>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
Commit	Line	Data
86530b38 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="lib.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="lib.html" title='Python Library Reference' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="next" href="module-distutils.html" />
	13	<link rel="prev" href="module-dis.html" />
	14	<link rel="parent" href="language.html" />
	15	<link rel="next" href="module-distutils.html" />
	16	<meta name='aesop' content='information' />
	17	<title>18.11 pickletools -- Tools for pickle developers.</title>
	18	</head>
	19	<body>
	20	<DIV CLASS="navigation">
	21	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	22	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	23	<tr>
	24	<td class='online-navigation'><a rel="prev" title="18.10.1 Python Byte Code"
	25	href="bytecodes.html"><img src='../icons/previous.png'
	26	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	27	<td class='online-navigation'><a rel="parent" title="18. Python Language Services"
	28	href="language.html"><img src='../icons/up.png'
	29	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	30	<td class='online-navigation'><a rel="next" title="18.12 distutils "
	31	href="module-distutils.html"><img src='../icons/next.png'
	32	border='0' height='32' alt='Next Page' width='32' /></A></td>
	33	<td align="center" width="100%">Python Library Reference</td>
	34	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	35	href="contents.html"><img src='../icons/contents.png'
	36	border='0' height='32' alt='Contents' width='32' /></A></td>
	37	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
	38	border='0' height='32' alt='Module Index' width='32' /></a></td>
	39	<td class='online-navigation'><a rel="index" title="Index"
	40	href="genindex.html"><img src='../icons/index.png'
	41	border='0' height='32' alt='Index' width='32' /></A></td>
	42	</tr></table>
	43	<div class='online-navigation'>
	44	<b class="navlabel">Previous:</b>
	45	<a class="sectref" rel="prev" href="bytecodes.html">18.10.1 Python Byte Code</A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="language.html">18. Python Language Services</A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="module-distutils.html">18.12 distutils </A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H1><A NAME="SECTION00201100000000000000000">
	56	18.11 <tt class="module">pickletools</tt> -- Tools for pickle developers.</A>
	57	</H1>
	58
	59	<P>
	60	<A NAME="module-pickletools"></A>
	61
	62	<P>
	63	This module contains various constants relating to the intimate
	64	details of the <tt class="module"><a href="module-pickle.html">pickle</a></tt> module, some lengthy comments about
65	the implementation, and a few useful functions for analyzing pickled
66	data. The contents of this module are useful for Python core
67	developers who are working on the <tt class="module">pickle</tt> and <tt class="module">cPickle</tt>
68	implementations; ordinary users of the <tt class="module">pickle</tt> module probably
69	won't find the <tt class="module">pickletools</tt> module relevant.
70
71	<P>
72	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
73	<td><nobr><b><tt id='l2h-5016' xml:id='l2h-5016' class="function">dis</tt></b>(</nobr></td>
74	<td><var>pickle</var><big>[</big><var>, out=None, memo=None, indentlevel=4</var><big>]</big><var></var>)</td></tr></table></dt>
75	<dd>
76	Outputs a symbolic disassembly of the pickle to the file-like object
77	<var>out</var>, defaulting to <code>sys.stdout</code>. <var>pickle</var> can be a
78	string or a file-like object. <var>memo</var> can be a Python dictionary
79	that will be used as the pickle's memo; it can be used to perform
80	disassemblies across multiple pickles created by the same pickler.
81	Successive levels, indicated by <code>MARK</code> opcodes in the stream, are
82	indented by <var>indentlevel</var> spaces.
83	</dl>
84
85	<P>
86	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
87	<td><nobr><b><tt id='l2h-5017' xml:id='l2h-5017' class="function">genops</tt></b>(</nobr></td>
88	<td><var>pickle</var>)</td></tr></table></dt>
89	<dd>
90	Provides an iterator over all of the opcodes in a pickle, returning a
91	sequence of <code>(<var>opcode</var>, <var>arg</var>, <var>pos</var>)</code> triples.
92	<var>opcode</var> is an instance of an <tt class="class">OpcodeInfo</tt> class; <var>arg</var>
93	is the decoded value, as a Python object, of the opcode's argument;
94	<var>pos</var> is the position at which this opcode is located.
95	<var>pickle</var> can be a string or a file-like object.
96	</dl>
97
98	<DIV CLASS="navigation">
99	<div class='online-navigation'>
100	<p></p><hr />
101	<table align="center" width="100%" cellpadding="0" cellspacing="2">
102	<tr>
103	<td class='online-navigation'><a rel="prev" title="18.10.1 Python Byte Code"
104	href="bytecodes.html"><img src='../icons/previous.png'
105	border='0' height='32' alt='Previous Page' width='32' /></A></td>
106	<td class='online-navigation'><a rel="parent" title="18. Python Language Services"
107	href="language.html"><img src='../icons/up.png'
108	border='0' height='32' alt='Up One Level' width='32' /></A></td>
109	<td class='online-navigation'><a rel="next" title="18.12 distutils "
110	href="module-distutils.html"><img src='../icons/next.png'
111	border='0' height='32' alt='Next Page' width='32' /></A></td>
112	<td align="center" width="100%">Python Library Reference</td>
113	<td class='online-navigation'><a rel="contents" title="Table of Contents"
114	href="contents.html"><img src='../icons/contents.png'
115	border='0' height='32' alt='Contents' width='32' /></A></td>
116	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
117	border='0' height='32' alt='Module Index' width='32' /></a></td>
118	<td class='online-navigation'><a rel="index" title="Index"
119	href="genindex.html"><img src='../icons/index.png'
120	border='0' height='32' alt='Index' width='32' /></A></td>
121	</tr></table>
122	<div class='online-navigation'>
123	<b class="navlabel">Previous:</b>
124	<a class="sectref" rel="prev" href="bytecodes.html">18.10.1 Python Byte Code</A>
125	<b class="navlabel">Up:</b>
126	<a class="sectref" rel="parent" href="language.html">18. Python Language Services</A>
127	<b class="navlabel">Next:</b>
128	<a class="sectref" rel="next" href="module-distutils.html">18.12 distutils </A>
129	</div>
130	</div>
131	<hr />
132	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
133	</DIV>
134	<!--End of Navigation Panel-->
135	<ADDRESS>
136	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
137	</ADDRESS>
138	</BODY>
139	</HTML>