<!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>get_readable_fileobj — 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="Astropy Core Package Utilities (astropy.utils)" href="../utils/index.html" />
<link rel="next" title="get_file_contents" href="astropy.utils.data.get_file_contents.html" />
<link rel="prev" title="ProgressBarOrSpinner" href="astropy.utils.console.ProgressBarOrSpinner.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 class="right">
<a href="astropy.utils.data.get_file_contents.html" title="get_file_contents">
next »
</a>
</li>
<li class="right">
<a href="astropy.utils.console.ProgressBarOrSpinner.html" title="ProgressBarOrSpinner">
« previous
</a>
|
</li>
<li>
<a href="../index.html">Astropy v0.2.4</a>
»
</li>
<li><a href="../utils/index.html" accesskey="U">Astropy Core Package Utilities (<tt class="docutils literal"><span class="pre">astropy.utils</span></tt>)</a> »</li>
<li>get_readable_fileobj</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="get-readable-fileobj">
<h1>get_readable_fileobj<a class="headerlink" href="#get-readable-fileobj" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="astropy.utils.data.get_readable_fileobj">
<tt class="descclassname">astropy.utils.data.</tt><tt class="descname">get_readable_fileobj</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/utils/data.py#L82" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="reference internal" href="../_modules/astropy/utils/data.html#get_readable_fileobj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.utils.data.get_readable_fileobj" title="Permalink to this definition">¶</a></dt>
<dd><p>Given a filename or a readable file-like object, return a context
manager that yields a readable file-like object.</p>
<p>This supports passing filenames, URLs, and readable file-like
objects, any of which can be compressed in gzip or bzip2.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>name_or_obj</strong> : str or file-like object</p>
<blockquote>
<div><p>The filename of the file to access (if given as a string), or
the file-like object to access.</p>
<p>If a file-like object, it must be opened in binary mode.</p>
</div></blockquote>
<p><strong>encoding</strong> : str, optional</p>
<blockquote>
<div><p>When <tt class="xref py py-obj docutils literal"><span class="pre">None</span></tt> (default), returns a file-like object with a
<tt class="xref py py-obj docutils literal"><span class="pre">read</span></tt> method that on Python 2.x returns <tt class="xref py py-obj docutils literal"><span class="pre">bytes</span></tt> objects and
on Python 3.x returns <tt class="xref py py-obj docutils literal"><span class="pre">str</span></tt> (<tt class="xref py py-obj docutils literal"><span class="pre">unicode</span></tt>) objects, using
<tt class="xref py py-obj docutils literal"><span class="pre">locale.getpreferredencoding()</span></tt> as an encoding. This matches
the default behavior of the built-in <tt class="xref py py-obj docutils literal"><span class="pre">open</span></tt> when no <tt class="xref py py-obj docutils literal"><span class="pre">mode</span></tt>
argument is provided.</p>
<p>When <tt class="xref py py-obj docutils literal"><span class="pre">'binary'</span></tt>, returns a file-like object where its <tt class="xref py py-obj docutils literal"><span class="pre">read</span></tt>
method returns <tt class="xref py py-obj docutils literal"><span class="pre">bytes</span></tt> objects.</p>
<p>When another string, it is the name of an encoding, and the
file-like object’s <tt class="xref py py-obj docutils literal"><span class="pre">read</span></tt> method will return <tt class="xref py py-obj docutils literal"><span class="pre">str</span></tt> (<tt class="xref py py-obj docutils literal"><span class="pre">unicode</span></tt>)
objects, decoded from binary using the given encoding.</p>
</div></blockquote>
<p><strong>cache</strong> : bool, optional</p>
<blockquote class="last">
<div><p>Whether to cache the contents of remote URLs.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>This function is a context manager, and should be used for example
as:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">with</span> <span class="n">get_readable_fileobj</span><span class="p">(</span><span class="s">'file.dat'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="n">contents</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Page Contents</h3>
<ul>
<li><a class="reference internal" href="#">get_readable_fileobj</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="../_sources/_generated/astropy.utils.data.get_readable_fileobj.txt"
rel="nofollow">Page Source</a>
<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>
