<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>astropy.io.misc.pickle_helpers — Astropy v0.2.4</title>
<link rel="stylesheet" href="../../../../_static/bootstrap-astropy.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../../',
VERSION: '0.2.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/sidebar.js"></script>
<link rel="shortcut icon" href="../../../../_static/astropy_logo.ico"/>
<link rel="top" title="Astropy v0.2.4" href="../../../../index.html" />
<link rel="up" title="Module code" href="../../../index.html" />
</head>
<body>
<div class="topbar">
<a class="brand" title="Documentation Home" href="../../../../index.html"></a>
<ul>
<li><a class="homelink" title="AstroPy Homepage" href="http://www.astropy.org"></a></li>
<li><a title="General Index" href="../../../../genindex.html">Index</a></li>
<li><a title="Python Module Index" href="../../../../py-modindex.html">Modules</a></li>
<li>
<form action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</li>
</ul>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li>
<a href="../../../../index.html">Astropy v0.2.4</a>
»
</li>
<li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for astropy.io.misc.pickle_helpers</h1><div class="highlight"><pre>
<span class="c"># Licensed under a 3-clause BSD style license - see LICENSE.rst</span>
<span class="sd">"""</span>
<span class="sd">This module contains simple input/output related functionality that is not</span>
<span class="sd">part of a larger framework or standard.</span>
<span class="sd">"""</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s">'fnpickle'</span><span class="p">,</span> <span class="s">'fnunpickle'</span><span class="p">]</span>
<div class="viewcode-block" id="fnunpickle"><a class="viewcode-back" href="../../../../_generated/astropy.io.misc.pickle_helpers.fnunpickle.html#astropy.io.misc.pickle_helpers.fnunpickle">[docs]</a><span class="k">def</span> <span class="nf">fnunpickle</span><span class="p">(</span><span class="n">fileorname</span><span class="p">,</span> <span class="n">number</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">usecPickle</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">""" Unpickle pickled objects from a specified file and return the contents.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> fileorname : str or `file`-like</span>
<span class="sd"> The file name or file from which to unpickle objects. If a file object,</span>
<span class="sd"> it should have been opened in binary mode.</span>
<span class="sd"> number : int</span>
<span class="sd"> If 0, a single object will be returned (the first in the file). If >0,</span>
<span class="sd"> this specifies the number of objects to be unpickled, and a list will</span>
<span class="sd"> be returned with exactly that many objects. If <0, all objects in the</span>
<span class="sd"> file will be unpickled and returned as a list.</span>
<span class="sd"> usecPickle : bool</span>
<span class="sd"> If True, the :mod:`cPickle` module is to be used in place of</span>
<span class="sd"> :mod:`pickle` (cPickle is faster). This only applies for python 2.x.</span>
<span class="sd"> Raises</span>
<span class="sd"> ------</span>
<span class="sd"> EOFError</span>
<span class="sd"> If `number` is >0 and there are fewer than `number` objects in the</span>
<span class="sd"> pickled file.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> contents : obj or list</span>
<span class="sd"> If `number` is 0, this is a individual object - the first one unpickled</span>
<span class="sd"> from the file. Otherwise, it is a list of objects unpickled from the</span>
<span class="sd"> file.</span>
<span class="sd"> """</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="k">if</span> <span class="n">usecPickle</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o"><</span> <span class="mi">3</span><span class="p">:</span> <span class="c"># pragma: py2</span>
<span class="kn">import</span> <span class="nn">cPickle</span> <span class="kn">as</span> <span class="nn">pickle</span>
<span class="k">else</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">pickle</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fileorname</span><span class="p">,</span> <span class="nb">basestring</span><span class="p">):</span>
<span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">fileorname</span><span class="p">,</span> <span class="s">'rb'</span><span class="p">)</span>
<span class="n">close</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">f</span> <span class="o">=</span> <span class="n">fileorname</span>
<span class="n">close</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">number</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> <span class="c"># get that number</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">number</span><span class="p">):</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">number</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span> <span class="c"># get all objects</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">eof</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">while</span> <span class="ow">not</span> <span class="n">eof</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">EOFError</span><span class="p">:</span>
<span class="n">eof</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">else</span><span class="p">:</span> <span class="c"># number==0</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="k">if</span> <span class="n">close</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">return</span> <span class="n">res</span>
</div>
<div class="viewcode-block" id="fnpickle"><a class="viewcode-back" href="../../../../_generated/astropy.io.misc.pickle_helpers.fnpickle.html#astropy.io.misc.pickle_helpers.fnpickle">[docs]</a><span class="k">def</span> <span class="nf">fnpickle</span><span class="p">(</span><span class="nb">object</span><span class="p">,</span> <span class="n">fileorname</span><span class="p">,</span> <span class="n">usecPickle</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">protocol</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">append</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="sd">"""Pickle an object to a specified file.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> object</span>
<span class="sd"> The python object to pickle.</span>
<span class="sd"> fileorname : str or `file`-like</span>
<span class="sd"> The filename or file into which the `object` should be pickled. If a</span>
<span class="sd"> file object, it should have been opened in binary mode.</span>
<span class="sd"> usecPickle : bool</span>
<span class="sd"> If True (default), the :mod:`cPickle` module is to be used in place of</span>
<span class="sd"> :mod:`pickle` (cPickle is faster). This only applies for python 2.x.</span>
<span class="sd"> protocol : int or None</span>
<span class="sd"> Pickle protocol to use - see the :mod:`pickle` module for details on</span>
<span class="sd"> these options. If None, the most recent protocol will be used.</span>
<span class="sd"> append : bool</span>
<span class="sd"> If True, the object is appended to the end of the file, otherwise the</span>
<span class="sd"> file will be overwritten (if a file object is given instead of a</span>
<span class="sd"> file name, this has no effect).</span>
<span class="sd"> """</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="k">if</span> <span class="n">usecPickle</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o"><</span> <span class="mi">3</span><span class="p">:</span> <span class="c"># pragma: py2</span>
<span class="kn">import</span> <span class="nn">cPickle</span> <span class="kn">as</span> <span class="nn">pickle</span>
<span class="k">else</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">pickle</span>
<span class="k">if</span> <span class="n">protocol</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">protocol</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">HIGHEST_PROTOCOL</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fileorname</span><span class="p">,</span> <span class="nb">basestring</span><span class="p">):</span>
<span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">fileorname</span><span class="p">,</span> <span class="s">'ab'</span> <span class="k">if</span> <span class="n">append</span> <span class="k">else</span> <span class="s">'wb'</span><span class="p">)</span>
<span class="n">close</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">f</span> <span class="o">=</span> <span class="n">fileorname</span>
<span class="n">close</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">pickle</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="nb">object</span><span class="p">,</span> <span class="n">f</span><span class="p">,</span> <span class="n">protocol</span><span class="o">=</span><span class="n">protocol</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="k">if</span> <span class="n">close</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Page Contents</h3>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="#">Back to Top</a></p>
<p>
© Copyright 2011-2013, The Astropy Developers.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
Last built 22 Oct 2013. <br/>
</p>
</footer>
</body>
</html>
