[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / html / python / lib / module-pickle.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-cPickle.html" />
<link rel="prev" href="module-linecache.html" />
<link rel="parent" href="python.html" />
<link rel="next" href="node63.html" />
<meta name='aesop' content='information' />
<title>3.14 pickle -- Python object serialization</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="3.13 linecache  "
  href="module-linecache.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="3. Python Runtime Services"
  href="python.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="3.14.1 Relationship to other"
  href="node63.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="module-linecache.html">3.13 linecache  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="python.html">3. Python Runtime Services</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node63.html">3.14.1 Relationship to other</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION0051400000000000000000">
3.14 <tt class="module">pickle</tt> -- Python object serialization</A>
</H1>

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

<P>
<a id='l2h-631' xml:id='l2h-631'></a>
<a id='l2h-626' xml:id='l2h-626'></a><a id='l2h-627' xml:id='l2h-627'></a><a id='l2h-628' xml:id='l2h-628'></a><a id='l2h-629' xml:id='l2h-629'></a><a id='l2h-630' xml:id='l2h-630'></a>
<P>
The <tt class="module">pickle</tt> module implements a fundamental, but powerful
algorithm for serializing and de-serializing a Python object
structure.  ``Pickling'' is the process whereby a Python object
hierarchy is converted into a byte stream, and ``unpickling'' is the
inverse operation, whereby a byte stream is converted back into an
object hierarchy.  Pickling (and unpickling) is alternatively known as
``serialization'', ``marshalling,''<A NAME="tex2html14"
  HREF="#foot8963"><SUP>3.2</SUP></A> or ``flattening'',
however, to avoid confusion, the terms used here are ``pickling'' and
``unpickling''.

<P>
This documentation describes both the <tt class="module">pickle</tt> module and the 
<tt class="module"><a href="module-cPickle.html">cPickle</a></tt> module.

<P>
<BR><HR><H4>Footnotes</H4>
<DL>
<DT><A NAME="foot8963">... ``marshalling,''</A><A
 href="module-pickle.html#tex2html14"><SUP>3.2</SUP></A></DT>
<DD>Don't confuse this with
the <tt class="module"><a href="module-marshal.html">marshal</a></tt> module

</DD>
</DL>
<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>

<UL CLASS="ChildLinks">
<LI><A href="node63.html">3.14.1 Relationship to other Python modules</a>
<LI><A href="node64.html">3.14.2 Data stream format</a>
<LI><A href="node65.html">3.14.3 Usage</a>
<LI><A href="node66.html">3.14.4 What can be pickled and unpickled?</a>
<LI><A href="pickle-protocol.html">3.14.5 The pickle protocol</a>
<UL>
<LI><A href="pickle-inst.html">3.14.5.1 Pickling and unpickling normal class
    instances</a>
<LI><A href="node69.html">3.14.5.2 Pickling and unpickling extension types</a>
<LI><A href="node70.html">3.14.5.3 Pickling and unpickling external objects</a>
</ul>
<LI><A href="pickle-sub.html">3.14.6 Subclassing Unpicklers</a>
<LI><A href="pickle-example.html">3.14.7 Example</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<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="3.13 linecache  "
  href="module-linecache.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="3. Python Runtime Services"
  href="python.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="3.14.1 Relationship to other"
  href="node63.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="module-linecache.html">3.13 linecache  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="python.html">3. Python Runtime Services</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node63.html">3.14.1 Relationship to other</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
920dae64 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-cPickle.html" />
	13	<link rel="prev" href="module-linecache.html" />
	14	<link rel="parent" href="python.html" />
	15	<link rel="next" href="node63.html" />
	16	<meta name='aesop' content='information' />
	17	<title>3.14 pickle -- Python object serialization</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="3.13 linecache "
	25	href="module-linecache.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="3. Python Runtime Services"
	28	href="python.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="3.14.1 Relationship to other"
	31	href="node63.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="module-linecache.html">3.13 linecache </A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="python.html">3. Python Runtime Services</A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="node63.html">3.14.1 Relationship to other</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H1><A NAME="SECTION0051400000000000000000">
	56	3.14 <tt class="module">pickle</tt> -- Python object serialization</A>
	57	</H1>
	58
	59	<P>
	60	<A NAME="module-pickle"></A>
	61
	62	<P>
	63	<a id='l2h-631' xml:id='l2h-631'></a>
	64	<a id='l2h-626' xml:id='l2h-626'></a><a id='l2h-627' xml:id='l2h-627'></a><a id='l2h-628' xml:id='l2h-628'></a><a id='l2h-629' xml:id='l2h-629'></a><a id='l2h-630' xml:id='l2h-630'></a>
65	<P>
66	The <tt class="module">pickle</tt> module implements a fundamental, but powerful
67	algorithm for serializing and de-serializing a Python object
68	structure. ``Pickling'' is the process whereby a Python object
69	hierarchy is converted into a byte stream, and ``unpickling'' is the
70	inverse operation, whereby a byte stream is converted back into an
71	object hierarchy. Pickling (and unpickling) is alternatively known as
72	``serialization'', ``marshalling,''<A NAME="tex2html14"
73	HREF="#foot8963"><SUP>3.2</SUP></A> or ``flattening'',
74	however, to avoid confusion, the terms used here are ``pickling'' and
75	``unpickling''.
76
77	<P>
78	This documentation describes both the <tt class="module">pickle</tt> module and the
79	<tt class="module"><a href="module-cPickle.html">cPickle</a></tt> module.
80
81	<P>
82	<BR><HR><H4>Footnotes</H4>
83	<DL>
84	<DT><A NAME="foot8963">... ``marshalling,''</A><A
85	href="module-pickle.html#tex2html14"><SUP>3.2</SUP></A></DT>
86	<DD>Don't confuse this with
87	the <tt class="module"><a href="module-marshal.html">marshal</a></tt> module
88
89	</DD>
90	</DL>
91	<p><br /></p><hr class='online-navigation' />
92	<div class='online-navigation'>
93	<!--Table of Child-Links-->
94	<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>
95
96	<UL CLASS="ChildLinks">
97	<LI><A href="node63.html">3.14.1 Relationship to other Python modules</a>
98	<LI><A href="node64.html">3.14.2 Data stream format</a>
99	<LI><A href="node65.html">3.14.3 Usage</a>
100	<LI><A href="node66.html">3.14.4 What can be pickled and unpickled?</a>
101	<LI><A href="pickle-protocol.html">3.14.5 The pickle protocol</a>
102	<UL>
103	<LI><A href="pickle-inst.html">3.14.5.1 Pickling and unpickling normal class
104	instances</a>
105	<LI><A href="node69.html">3.14.5.2 Pickling and unpickling extension types</a>
106	<LI><A href="node70.html">3.14.5.3 Pickling and unpickling external objects</a>
107	</ul>
108	<LI><A href="pickle-sub.html">3.14.6 Subclassing Unpicklers</a>
109	<LI><A href="pickle-example.html">3.14.7 Example</a>
110	</ul>
111	<!--End of Table of Child-Links-->
112	</div>
113
114	<DIV CLASS="navigation">
115	<div class='online-navigation'>
116	<p></p><hr />
117	<table align="center" width="100%" cellpadding="0" cellspacing="2">
118	<tr>
119	<td class='online-navigation'><a rel="prev" title="3.13 linecache "
120	href="module-linecache.html"><img src='../icons/previous.png'
121	border='0' height='32' alt='Previous Page' width='32' /></A></td>
122	<td class='online-navigation'><a rel="parent" title="3. Python Runtime Services"
123	href="python.html"><img src='../icons/up.png'
124	border='0' height='32' alt='Up One Level' width='32' /></A></td>
125	<td class='online-navigation'><a rel="next" title="3.14.1 Relationship to other"
126	href="node63.html"><img src='../icons/next.png'
127	border='0' height='32' alt='Next Page' width='32' /></A></td>
128	<td align="center" width="100%">Python Library Reference</td>
129	<td class='online-navigation'><a rel="contents" title="Table of Contents"
130	href="contents.html"><img src='../icons/contents.png'
131	border='0' height='32' alt='Contents' width='32' /></A></td>
132	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
133	border='0' height='32' alt='Module Index' width='32' /></a></td>
134	<td class='online-navigation'><a rel="index" title="Index"
135	href="genindex.html"><img src='../icons/index.png'
136	border='0' height='32' alt='Index' width='32' /></A></td>
137	</tr></table>
138	<div class='online-navigation'>
139	<b class="navlabel">Previous:</b>
140	<a class="sectref" rel="prev" href="module-linecache.html">3.13 linecache </A>
141	<b class="navlabel">Up:</b>
142	<a class="sectref" rel="parent" href="python.html">3. Python Runtime Services</A>
143	<b class="navlabel">Next:</b>
144	<a class="sectref" rel="next" href="node63.html">3.14.1 Relationship to other</A>
145	</div>
146	</div>
147	<hr />
148	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
149	</DIV>
150	<!--End of Navigation Panel-->
151	<ADDRESS>
152	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
153	</ADDRESS>
154	</BODY>
155	</HTML>