<!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>Module: utils.encoding — IPython 2.3.0 documentation</title> <link rel="stylesheet" href="../../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../', VERSION: '2.3.0', 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> <link rel="top" title="IPython 2.3.0 documentation" href="../../index.html" /> <link rel="up" title="The IPython API" href="../index.html" /> <link rel="next" title="Module: utils.frame" href="IPython.utils.frame.html" /> <link rel="prev" title="Module: utils.doctestreload" href="IPython.utils.doctestreload.html" /> </head> <body> <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px"> <a href="http://ipython.org/"><img src="../../_static/logo.png" border="0" alt="IPython Documentation"/></a> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="IPython.utils.frame.html" title="Module: utils.frame" accesskey="N">next</a> |</li> <li class="right" > <a href="IPython.utils.doctestreload.html" title="Module: utils.doctestreload" accesskey="P">previous</a> |</li> <li><a href="http://ipython.org">home</a>| </li> <li><a href="../../search.html">search</a>| </li> <li><a href="../../index.html">documentation </a> »</li> <li><a href="../index.html" accesskey="U">The IPython API</a> »</li> </ul> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../../index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Module: <tt class="docutils literal"><span class="pre">utils.encoding</span></tt></a><ul> <li><a class="reference internal" href="#functions">2 Functions</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="IPython.utils.doctestreload.html" title="previous chapter">Module: <tt class="docutils literal"><span class="pre">utils.doctestreload</span></tt></a></p> <h4>Next topic</h4> <p class="topless"><a href="IPython.utils.frame.html" title="next chapter">Module: <tt class="docutils literal"><span class="pre">utils.frame</span></tt></a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/api/generated/IPython.utils.encoding.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-IPython.utils.encoding"> <span id="module-utils-encoding"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">utils.encoding</span></tt><a class="headerlink" href="#module-IPython.utils.encoding" title="Permalink to this headline">¶</a></h1> <p>Utilities for dealing with text encodings</p> <div class="section" id="functions"> <h2>2 Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="IPython.utils.encoding.get_stream_enc"> <tt class="descclassname">IPython.utils.encoding.</tt><tt class="descname">get_stream_enc</tt><big>(</big><em>stream</em>, <em>default=None</em><big>)</big><a class="headerlink" href="#IPython.utils.encoding.get_stream_enc" title="Permalink to this definition">¶</a></dt> <dd><p>Return the given stream’s encoding or a default.</p> <p>There are cases where <tt class="docutils literal"><span class="pre">sys.std*</span></tt> might not actually be a stream, so check for the encoding attribute prior to returning it, and return a default if it doesn’t exist or evaluates as False. <tt class="docutils literal"><span class="pre">default</span></tt> is None if not provided.</p> </dd></dl> <dl class="function"> <dt id="IPython.utils.encoding.getdefaultencoding"> <tt class="descclassname">IPython.utils.encoding.</tt><tt class="descname">getdefaultencoding</tt><big>(</big><em>prefer_stream=True</em><big>)</big><a class="headerlink" href="#IPython.utils.encoding.getdefaultencoding" title="Permalink to this definition">¶</a></dt> <dd><p>Return IPython’s guess for the default encoding for bytes as text.</p> <p>If prefer_stream is True (default), asks for stdin.encoding first, to match the calling Terminal, but that is often None for subprocesses.</p> <p>Then fall back on locale.getpreferredencoding(), which should be a sensible platform default (that respects LANG environment), and finally to sys.getdefaultencoding() which is the most conservative option, and usually ASCII on Python 2 or UTF8 on Python 3.</p> </dd></dl> </div> </div> </div> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="IPython.utils.frame.html" title="Module: utils.frame" >next</a> |</li> <li class="right" > <a href="IPython.utils.doctestreload.html" title="Module: utils.doctestreload" >previous</a> |</li> <li><a href="http://ipython.org">home</a>| </li> <li><a href="../../search.html">search</a>| </li> <li><a href="../../index.html">documentation </a> »</li> <li><a href="../index.html" >The IPython API</a> »</li> </ul> </div> <div class="footer"> © Copyright The IPython Development Team. Last updated on Sep 02, 2015. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. </div> </body> </html>