File: standard_library.html

package info (click to toggle)
python-future 0.15.2-4~bpo8%2B1
links: PTS, VCS
area: main
in suites: jessie-backports
size: 8,420 kB
sloc: python: 42,496; makefile: 141; sh: 45
file content (1339 lines) | stat: -rw-r--r-- 130,240 bytes
parent folder | download | duplicates (2)

<!DOCTYPE html>


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>future.standard_library &mdash; Python-Future  documentation</title>
    
    <link rel="stylesheet" href="../../_static/basic.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/my-styles.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/bootswatch-3.3.4/cerulean/bootstrap.min.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../',
        VERSION:     '',
        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/js/jquery-1.11.0.min.js"></script>
    <script type="text/javascript" src="../../_static/js/jquery-fix.js"></script>
    <script type="text/javascript" src="../../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
    <script type="text/javascript" src="../../_static/bootstrap-sphinx.js"></script>
    <link rel="shortcut icon" href="../../_static/python-future-icon-32.ico"/>
    <link rel="top" title="Python-Future  documentation" href="../../index.html" />
    <link rel="up" title="Module code" href="../index.html" />

<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">

<script type="text/javascript">
  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'UA-19344199-2']);
  _gaq.push(['_trackPageview']);
</script>

  </head>
  <body role="document">

<a href="https://github.com/PythonCharmers/python-future"><img style="position: absolute; top: 45px; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" alt="Fork me on GitHub"></a>
<div id="navbar" class="navbar navbar-inverse navbar-default navbar-fixed-top">

    <div class="container">

      <div class="navbar-header">

        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>

        <a class="logo"> <img height="32" width="32" src="_static/python-future-logo-textless-transparent.png" /></a>
        <a class="navbar-brand" href="../../index.html">Python-Future</a>
        <span class="navbar-text navbar-version pull-left"><b></b></span>
      </div>
        <div class="collapse navbar-collapse nav-collapse">
          <ul class="nav navbar-nav">
            <li class="divider-vertical"></li>
            
                <li><a href="../../overview.html">Overview</a></li>
                <li><a href="../../compatible_idioms.html">Cheat Sheet</a></li>
                <li><a href="../../faq.html">FAQ</a></li>
            
            
              <li class="dropdown globaltoc-container">
  <a role="button"
     id="dLabelGlobalToc"
     data-toggle="dropdown"
     data-target="#"
     href="../../index.html">Contents <b class="caret"></b></a>
  <ul class="dropdown-menu globaltoc"
      role="menu"
      aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="../../whatsnew.html">What&#8217;s New</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../whatsnew.html#what-s-new-in-version-0-15-0-2015-07-25">What&#8217;s new in version 0.15.0 (2015-07-25)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../whatsnew.html#what-s-new-in-version-0-14-3-2014-12-15">What&#8217;s new in version 0.14.3 (2014-12-15)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../whatsnew.html#what-s-new-in-version-0-14-2-2014-11-21">What&#8217;s new in version 0.14.2 (2014-11-21)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../whatsnew.html#what-s-new-in-version-0-14-1-2014-10-02">What&#8217;s new in version 0.14.1 (2014-10-02)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../whatsnew.html#what-s-new-in-version-0-14-2014-10-02">What&#8217;s new in version 0.14 (2014-10-02)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../whatsnew.html#bug-fixes">Bug fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../whatsnew.html#internal-cleanups">Internal cleanups</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../whatsnew.html#deprecations">Deprecations</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../whatsnew.html#previous-versions">Previous versions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../overview.html">Overview: Easy, clean, reliable Python 2/3 compatibility</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../overview.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview.html#code-examples">Code examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview.html#automatic-conversion-to-py2-3-compatible-code">Automatic conversion to Py2/3-compatible code</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../overview.html#futurize-2-to-both">Futurize: 2 to both</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../overview.html#automatic-translation">Automatic translation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview.html#licensing">Licensing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview.html#next-steps">Next steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../quickstart.html">Quick-start guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html#if-you-are-writing-code-from-scratch">If you are writing code from scratch</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html#to-convert-existing-python-3-code">To convert existing Python 3 code</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html#to-convert-existing-python-2-code">To convert existing Python 2 code</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html#standard-library-reorganization">Standard library reorganization</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html#python-2-only-dependencies">Python 2-only dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html#next-steps">Next steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../compatible_idioms.html">Cheat Sheet: Writing Python 2-3 compatible code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../compatible_idioms.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../compatible_idioms.html#essential-syntax-differences">Essential syntax differences</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#print">print</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#raising-exceptions">Raising exceptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#catching-exceptions">Catching exceptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#division">Division</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#long-integers">Long integers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#octal-constants">Octal constants</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#backtick-repr">Backtick repr</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#metaclasses">Metaclasses</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../compatible_idioms.html#strings-and-bytes">Strings and bytes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#unicode-text-string-literals">Unicode (text) string literals</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#byte-string-literals">Byte-string literals</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#basestring">basestring</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#unicode">unicode</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#stringio">StringIO</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../compatible_idioms.html#imports-relative-to-a-package">Imports relative to a package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../compatible_idioms.html#dictionaries">Dictionaries</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#iterating-through-dict-keys-values-items">Iterating through <code class="docutils literal"><span class="pre">dict</span></code> keys/values/items</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#dict-keys-values-items-as-a-list">dict keys/values/items as a list</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../compatible_idioms.html#custom-class-behaviour">Custom class behaviour</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#custom-iterators">Custom iterators</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#custom-str-methods">Custom <code class="docutils literal"><span class="pre">__str__</span></code> methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#custom-nonzero-vs-bool-method">Custom <code class="docutils literal"><span class="pre">__nonzero__</span></code> vs <code class="docutils literal"><span class="pre">__bool__</span></code> method:</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../compatible_idioms.html#lists-versus-iterators">Lists versus iterators</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#xrange">xrange</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#range">range</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#map">map</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#imap">imap</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#zip-izip">zip, izip</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#filter-ifilter">filter, ifilter</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../compatible_idioms.html#other-builtins">Other builtins</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#file-io-with-open">File IO with open()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#reduce">reduce()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#raw-input">raw_input()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#input">input()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#file">file()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#execfile">execfile()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#unichr">unichr()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#intern">intern()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#apply">apply()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#chr">chr()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#cmp">cmp()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#reload">reload()</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../compatible_idioms.html#standard-library">Standard library</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#dbm-modules">dbm modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#commands-subprocess-modules">commands / subprocess modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#subprocess-check-output">subprocess.check_output()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#collections-counter-and-ordereddict">collections: Counter and OrderedDict</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#stringio-module">StringIO module</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#http-module">http module</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#xmlrpc-module">xmlrpc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#html-escaping-and-entities">html escaping and entities</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#html-parsing">html parsing</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#urllib-module">urllib module</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#tkinter">Tkinter</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#socketserver">socketserver</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#copy-reg-copyreg">copy_reg, copyreg</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#configparser">configparser</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#queue">queue</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#repr-reprlib">repr, reprlib</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#userdict-userlist-userstring">UserDict, UserList, UserString</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../compatible_idioms.html#itertools-filterfalse-zip-longest">itertools: filterfalse, zip_longest</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../imports.html">Imports</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../imports.html#future-imports">__future__ imports</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../imports.html#imports-of-builtins">Imports of builtins</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../imports.html#implicit-imports">Implicit imports</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../imports.html#explicit-imports">Explicit imports</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../imports.html#standard-library-imports">Standard library imports</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../imports.html#direct-imports">Direct imports</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../imports.html#aliased-imports">Aliased imports</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../imports.html#external-standard-library-backports">External standard-library backports</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../imports.html#included-full-backports">Included full backports</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../imports.html#using-python-2-only-dependencies-on-python-3">Using Python 2-only dependencies on Python 3</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../imports.html#should-i-import-unicode-literals">Should I import unicode_literals?</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../imports.html#benefits">Benefits</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../imports.html#drawbacks">Drawbacks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../imports.html#others-perspectives">Others&#8217; perspectives</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../imports.html#next-steps">Next steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../what_else.html">What else you need to know</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#bytes">bytes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#str">str</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#dict">dict</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../what_else.html#memory-efficiency-and-alternatives">Memory-efficiency and alternatives</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#int">int</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#isinstance">isinstance</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#passing-data-to-from-python-2-libraries">Passing data to/from Python 2 libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#native-string-type">Native string type</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#open">open()</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#custom-str-methods">Custom __str__ methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#custom-iterators">Custom iterators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#binding-a-method-to-a-class">Binding a method to a class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../what_else.html#metaclasses">Metaclasses</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../automatic_conversion.html">Automatic conversion to Py2/3</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../automatic_conversion.html#futurize-py2-to-py2-3"><code class="docutils literal"><span class="pre">futurize</span></code>: Py2 to Py2/3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../automatic_conversion.html#stage-1-safe-fixes">Stage 1: &#8220;safe&#8221; fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../automatic_conversion.html#stage-2-py3-style-code-with-wrappers-for-py2">Stage 2: Py3-style code with wrappers for Py2</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../automatic_conversion.html#separating-text-from-bytes">Separating text from bytes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../automatic_conversion.html#post-conversion">Post-conversion</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../automatic_conversion.html#futurize-quick-start-guide"><code class="docutils literal"><span class="pre">futurize</span></code> quick-start guide</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../automatic_conversion.html#step-0-setup">Step 0: setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../automatic_conversion.html#step-1-modern-py2-code">Step 1: modern Py2 code</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../automatic_conversion.html#step-2-working-py3-code-that-still-supports-py2">Step 2: working Py3 code that still supports Py2</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../automatic_conversion.html#pasteurize-py3-to-py2-3"><code class="docutils literal"><span class="pre">pasteurize</span></code>: Py3 to Py2/3</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../automatic_conversion.html#known-limitations">Known limitations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Frequently Asked Questions (FAQ)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../faq.html#who-is-this-for">Who is this for?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../faq.html#why-upgrade-to-python-3">Why upgrade to Python 3?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../faq.html#porting-philosophy">Porting philosophy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#why-write-python-3-style-code">Why write Python 3-style code?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#can-t-i-just-roll-my-own-py2-3-compatibility-layer">Can&#8217;t I just roll my own Py2/3 compatibility layer?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#what-inspired-this-project">What inspired this project?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../faq.html#maturity">Maturity</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#how-well-has-it-been-tested">How well has it been tested?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#is-the-api-stable">Is the API stable?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../faq.html#relationship-between-python-future-and-other-compatibility-tools">Relationship between python-future and other compatibility tools</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#how-does-this-relate-to-2to3">How does this relate to <code class="docutils literal"><span class="pre">2to3</span></code>?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#can-i-maintain-a-python-2-codebase-and-use-2to3-to-automatically-convert-to-python-3-in-the-setup-script">Can I maintain a Python 2 codebase and use 2to3 to automatically convert to Python 3 in the setup script?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#what-is-the-relationship-between-future-and-six">What is the relationship between <code class="docutils literal"><span class="pre">future</span></code> and <code class="docutils literal"><span class="pre">six</span></code>?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#what-is-the-relationship-between-python-future-and-python-modernize">What is the relationship between <code class="docutils literal"><span class="pre">python-future</span></code> and <code class="docutils literal"><span class="pre">python-modernize</span></code>?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../faq.html#platform-and-version-support">Platform and version support</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#which-versions-of-python-does-python-future-support">Which versions of Python does <code class="docutils literal"><span class="pre">python-future</span></code> support?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../faq.html#support">Support</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#is-there-a-mailing-list">Is there a mailing list?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../faq.html#contributing">Contributing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#can-i-help">Can I help?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../faq.html#where-is-the-repo">Where is the repo?</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../stdlib_incompatibilities.html">Standard library incompatibilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../stdlib_incompatibilities.html#array-array">array.array()</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stdlib_incompatibilities.html#array-array-read">array.array.read()</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stdlib_incompatibilities.html#base64-decodebytes-and-base64-encodebytes">base64.decodebytes() and base64.encodebytes()</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stdlib_incompatibilities.html#re-ascii">re.ASCII</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stdlib_incompatibilities.html#struct-pack">struct.pack()</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../older_interfaces.html">Older interfaces</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../older_interfaces.html#context-manager-for-import-hooks">Context-manager for import hooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../older_interfaces.html#future-moves-interface"><code class="docutils literal"><span class="pre">future.moves</span></code> interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../older_interfaces.html#comparing-future-moves-and-six-moves">Comparing future.moves and six.moves</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../older_interfaces.html#import-and-from-import-functions"><code class="docutils literal"><span class="pre">import_</span></code> and <code class="docutils literal"><span class="pre">from_import</span></code> functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../older_interfaces.html#install-hooks-call">install_hooks() call</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changes in previous versions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-13-1-2014-09-23">Changes in version 0.13.1 (2014-09-23)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-13-2014-08-13">Changes in version 0.13 (2014-08-13)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#deprecations">Deprecations</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#new-features">New features</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#bug-fixes">Bug fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-12-4-2014-07-18">Changes in version 0.12.4 (2014-07-18)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-12-3-2014-06-19">Changes in version 0.12.3 (2014-06-19)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-12-2-2014-05-25">Changes in version 0.12.2 (2014-05-25)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-12-1-2014-05-14">Changes in version 0.12.1 (2014-05-14)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-12-0-2014-05-06">Changes in version 0.12.0 (2014-05-06)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#more-robust-standard-library-import-hooks">More robust standard-library import hooks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#newobject-base-object-defines-fallback-py2-compatible-special-methods"><code class="docutils literal"><span class="pre">newobject</span></code> base object defines fallback Py2-compatible special methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#past-builtins-module-improved"><code class="docutils literal"><span class="pre">past.builtins</span></code> module improved</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#surrogateescape-error-handler"><code class="docutils literal"><span class="pre">surrogateescape</span></code> error handler</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#newlist-type"><code class="docutils literal"><span class="pre">newlist</span></code> type</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#listvalues-and-listitems"><code class="docutils literal"><span class="pre">listvalues</span></code> and <code class="docutils literal"><span class="pre">listitems</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#tests">Tests</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#refactoring-of-future-standard-library-future-backports">Refactoring of <code class="docutils literal"><span class="pre">future.standard_library.*</span></code> -&gt; <code class="docutils literal"><span class="pre">future.backports</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#backported-http-server-and-urllib-modules">Backported <code class="docutils literal"><span class="pre">http.server</span></code> and <code class="docutils literal"><span class="pre">urllib</span></code> modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#internal-refactoring">Internal refactoring</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id1">Bug fixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-11-4-2014-05-25">Changes in version 0.11.4 (2014-05-25)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-11-3-2014-02-27">Changes in version 0.11.3 (2014-02-27)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#improved-compatibility-with-requests">Improved compatibility with <code class="docutils literal"><span class="pre">requests</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#conversion-scripts-explicitly-install-import-hooks">Conversion scripts explicitly install import hooks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#futurize-script-no-longer-adds-unicode-literals-by-default"><code class="docutils literal"><span class="pre">futurize</span></code> script no longer adds <code class="docutils literal"><span class="pre">unicode_literals</span></code> by default</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-11-2014-01-28">Changes in version 0.11 (2014-01-28)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#past-package"><code class="docutils literal"><span class="pre">past</span></code> package</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#auto-translation-of-python-2-modules-upon-import">Auto-translation of Python 2 modules upon import</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#separate-pasteurize-script">Separate <code class="docutils literal"><span class="pre">pasteurize</span></code> script</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#pow">pow()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#input-no-longer-disabled-globally-on-py2">input() no longer disabled globally on Py2</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#deprecated-feature-auto-installation-of-standard-library-import-hooks">Deprecated feature: auto-installation of standard-library import hooks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#internal-changes">Internal changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-10-2-2014-01-11">Changes in version 0.10.2 (2014-01-11)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#new-context-manager-interface-to-standard-library-hooks">New context-manager interface to standard_library hooks</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-10-0-2013-12-02">Changes in version 0.10.0 (2013-12-02)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#backported-dict-type">Backported <code class="docutils literal"><span class="pre">dict</span></code> type</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#utility-functions-raise-and-exec">Utility functions <code class="docutils literal"><span class="pre">raise_</span></code> and <code class="docutils literal"><span class="pre">exec_</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#bugfixes">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-9-2013-11-06">Changes in version 0.9 (2013-11-06)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#isinstance-checks-are-supported-natively-with-backported-types"><code class="docutils literal"><span class="pre">isinstance</span></code> checks are supported natively with backported types</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#futurize-minimal-imports-by-default"><code class="docutils literal"><span class="pre">futurize</span></code>: minimal imports by default</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#looser-type-checking-for-the-backported-str-object">Looser type-checking for the backported <code class="docutils literal"><span class="pre">str</span></code> object</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#suspend-hooks-context-manager-added-to-future-standard-library">suspend_hooks() context manager added to <code class="docutils literal"><span class="pre">future.standard_library</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#changes-in-version-0-8-2013-10-28">Changes in version 0.8 (2013-10-28)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#python-2-6-support">Python 2.6 support</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#unused-modules-removed">Unused modules removed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#isinstance-added-to-future-builtins-v0-8-2">isinstance() added to <code class="docutils literal"><span class="pre">future.builtins</span></code> (v0.8.2)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#summary-of-all-changes">Summary of all changes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../credits.html">Licensing and credits</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../credits.html#licence">Licence</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../credits.html#sponsor">Sponsor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../credits.html#authors">Authors</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../credits.html#development-lead">Development Lead</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../credits.html#patches">Patches</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../credits.html#suggestions-and-feedback">Suggestions and Feedback</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../credits.html#other-credits">Other Credits</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../reference.html">API Reference (in progress)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../reference.html#module-future.builtins">future.builtins Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../reference.html#module-future.types">Backported types from Python 3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../reference.html#for-more-information">For more information:</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../reference.html#range">range()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../reference.html#super">super()</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../reference.html#round">round()</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../reference.html#module-future.standard_library">future.standard_library Interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../reference.html#limitations">Limitations</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../reference.html#module-future.utils">future.utils Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../reference.html#module-past.builtins">past.builtins Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../reference.html#module-past.types">Forward-ported types from Python 2</a></li>
</ul>
</li>
</ul>
</ul>
</li>
              
                <li class="dropdown">
  <a role="button"
     id="dLabelLocalToc"
     data-toggle="dropdown"
     data-target="#"
     href="#">Page <b class="caret"></b></a>
  <ul class="dropdown-menu localtoc"
      role="menu"
      aria-labelledby="dLabelLocalToc"></ul>
</li>
              
            
            
            
            
            
          </ul>

          
            
<form class="navbar-form navbar-right" action="../../search.html" method="get">
 <div class="form-group">
  <input type="text" name="q" class="form-control" placeholder="Search" />
 </div>
  <input type="hidden" name="check_keywords" value="yes" />
  <input type="hidden" name="area" value="default" />
</form>
          

        </div>
    </div>
  </div>

<div class="container">
  <div class="row">
      <div class="col-md-3">
        <div id="sidebar" class="bs-sidenav" role="complementary"><!--<h3>Python-Future</h3>
<p>-->
  <h4>Easy, clean, reliable Python 2/3 compatibility</h4>
  <a href="http://python-future.org">Table of Contents</a>
<!--
</p>
<h3>Other Formats</h3>
<p>
  You can download the documentation in other formats as well:
</p>
<ul>
  <li><a href="http://jinja.pocoo.org/docs/jinja-docs.pdf">as PDF</a>
  <li><a href="http://jinja.pocoo.org/docs/jinja-docs.zip">as zipped HTML</a>
</ul>
-->
<!--<h3>Useful Links</h3>
<ul>
  <li><a href="http://pypi.python.org/pypi/future">on PyPI</a></li>
  <li><a href="https://github.com/PythonCharmers/python-future">on GitHub</a></li>
</ul>
--><ul>
<li class="toctree-l1"><a class="reference internal" href="../../whatsnew.html">What&#8217;s New</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../overview.html">Overview: Easy, clean, reliable Python 2/3 compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../quickstart.html">Quick-start guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../compatible_idioms.html">Cheat Sheet: Writing Python 2-3 compatible code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../imports.html">Imports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../what_else.html">What else you need to know</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../automatic_conversion.html">Automatic conversion to Py2/3</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Frequently Asked Questions (FAQ)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../stdlib_incompatibilities.html">Standard library incompatibilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../older_interfaces.html">Older interfaces</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changes in previous versions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../credits.html">Licensing and credits</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../reference.html">API Reference (in progress)</a></li>
</ul>

        </div>
      </div>
    <div class="col-md-9">
      
  <h1>Source code for future.standard_library</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Python 3 reorganized the standard library (PEP 3108). This module exposes</span>
<span class="sd">several standard library modules to Python 2 under their new Python 3</span>
<span class="sd">names.</span>

<span class="sd">It is designed to be used as follows::</span>

<span class="sd">    from future import standard_library</span>
<span class="sd">    standard_library.install_aliases()</span>

<span class="sd">And then these normal Py3 imports work on both Py3 and Py2::</span>

<span class="sd">    import builtins</span>
<span class="sd">    import configparser</span>
<span class="sd">    import copyreg</span>
<span class="sd">    import queue</span>
<span class="sd">    import reprlib</span>
<span class="sd">    import socketserver</span>
<span class="sd">    import winreg    # on Windows only</span>
<span class="sd">    import test.support</span>
<span class="sd">    import html, html.parser, html.entites</span>
<span class="sd">    import http, http.client, http.server</span>
<span class="sd">    import http.cookies, http.cookiejar</span>
<span class="sd">    import urllib.parse, urllib.request, urllib.response, urllib.error, urllib.robotparser</span>
<span class="sd">    import xmlrpc.client, xmlrpc.server</span>

<span class="sd">    import _thread</span>
<span class="sd">    import _dummy_thread</span>
<span class="sd">    import _markupbase</span>

<span class="sd">    from itertools import filterfalse, zip_longest</span>
<span class="sd">    from sys import intern</span>
<span class="sd">    from collections import UserDict, UserList, UserString</span>
<span class="sd">    from collections import OrderedDict, Counter     # even on Py2.6</span>
<span class="sd">    from subprocess import getoutput, getstatusoutput</span>
<span class="sd">    from subprocess import check_output              # even on Py2.6</span>

<span class="sd">(The renamed modules and functions are still available under their old</span>
<span class="sd">names on Python 2.)</span>

<span class="sd">This is a cleaner alternative to this idiom (see</span>
<span class="sd">http://docs.pythonsprints.com/python3_porting/py-porting.html)::</span>

<span class="sd">    try:</span>
<span class="sd">        import queue</span>
<span class="sd">    except ImportError:</span>
<span class="sd">        import Queue as queue</span>


<span class="sd">Limitations</span>
<span class="sd">-----------</span>
<span class="sd">We don&#39;t currently support these modules, but would like to::</span>

<span class="sd">    import dbm</span>
<span class="sd">    import dbm.dumb</span>
<span class="sd">    import dbm.gnu</span>
<span class="sd">    import collections.abc  # on Py33</span>
<span class="sd">    import pickle     # should (optionally) bring in cPickle on Python 2</span>

<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span>

<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">imp</span>
<span class="kn">import</span> <span class="nn">contextlib</span>
<span class="kn">import</span> <span class="nn">types</span>
<span class="kn">import</span> <span class="nn">copy</span>
<span class="kn">import</span> <span class="nn">os</span>

<span class="c"># Make a dedicated logger; leave the root logger to be configured</span>
<span class="c"># by the application.</span>
<span class="n">flog</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s">&#39;future_stdlib&#39;</span><span class="p">)</span>
<span class="n">_formatter</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">BASIC_FORMAT</span><span class="p">)</span>
<span class="n">_handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span>
<span class="n">_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">_formatter</span><span class="p">)</span>
<span class="n">flog</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">_handler</span><span class="p">)</span>
<span class="n">flog</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">WARN</span><span class="p">)</span>

<span class="kn">from</span> <span class="nn">future.utils</span> <span class="kn">import</span> <span class="n">PY2</span><span class="p">,</span> <span class="n">PY3</span>

<span class="c"># The modules that are defined under the same names on Py3 but with</span>
<span class="c"># different contents in a significant way (e.g. submodules) are:</span>
<span class="c">#   pickle (fast one)</span>
<span class="c">#   dbm</span>
<span class="c">#   urllib</span>
<span class="c">#   test</span>
<span class="c">#   email</span>

<span class="n">REPLACED_MODULES</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="s">&#39;test&#39;</span><span class="p">,</span> <span class="s">&#39;urllib&#39;</span><span class="p">,</span> <span class="s">&#39;pickle&#39;</span><span class="p">,</span> <span class="s">&#39;dbm&#39;</span><span class="p">])</span>  <span class="c"># add email and dbm when we support it</span>

<span class="c"># The following module names are not present in Python 2.x, so they cause no</span>
<span class="c"># potential clashes between the old and new names:</span>
<span class="c">#   http</span>
<span class="c">#   html</span>
<span class="c">#   tkinter</span>
<span class="c">#   xmlrpc</span>
<span class="c"># Keys: Py2 / real module names</span>
<span class="c"># Values: Py3 / simulated module names</span>
<span class="n">RENAMES</span> <span class="o">=</span> <span class="p">{</span>
           <span class="c"># &#39;cStringIO&#39;: &#39;io&#39;,  # there&#39;s a new io module in Python 2.6</span>
                                 <span class="c"># that provides StringIO and BytesIO</span>
           <span class="c"># &#39;StringIO&#39;: &#39;io&#39;,   # ditto</span>
           <span class="c"># &#39;cPickle&#39;: &#39;pickle&#39;,</span>
           <span class="s">&#39;__builtin__&#39;</span><span class="p">:</span> <span class="s">&#39;builtins&#39;</span><span class="p">,</span>
           <span class="s">&#39;copy_reg&#39;</span><span class="p">:</span> <span class="s">&#39;copyreg&#39;</span><span class="p">,</span>
           <span class="s">&#39;Queue&#39;</span><span class="p">:</span> <span class="s">&#39;queue&#39;</span><span class="p">,</span>
           <span class="s">&#39;future.moves.socketserver&#39;</span><span class="p">:</span> <span class="s">&#39;socketserver&#39;</span><span class="p">,</span>
           <span class="s">&#39;ConfigParser&#39;</span><span class="p">:</span> <span class="s">&#39;configparser&#39;</span><span class="p">,</span>
           <span class="s">&#39;repr&#39;</span><span class="p">:</span> <span class="s">&#39;reprlib&#39;</span><span class="p">,</span>
           <span class="c"># &#39;FileDialog&#39;: &#39;tkinter.filedialog&#39;,</span>
           <span class="c"># &#39;tkFileDialog&#39;: &#39;tkinter.filedialog&#39;,</span>
           <span class="c"># &#39;SimpleDialog&#39;: &#39;tkinter.simpledialog&#39;,</span>
           <span class="c"># &#39;tkSimpleDialog&#39;: &#39;tkinter.simpledialog&#39;,</span>
           <span class="c"># &#39;tkColorChooser&#39;: &#39;tkinter.colorchooser&#39;,</span>
           <span class="c"># &#39;tkCommonDialog&#39;: &#39;tkinter.commondialog&#39;,</span>
           <span class="c"># &#39;Dialog&#39;: &#39;tkinter.dialog&#39;,</span>
           <span class="c"># &#39;Tkdnd&#39;: &#39;tkinter.dnd&#39;,</span>
           <span class="c"># &#39;tkFont&#39;: &#39;tkinter.font&#39;,</span>
           <span class="c"># &#39;tkMessageBox&#39;: &#39;tkinter.messagebox&#39;,</span>
           <span class="c"># &#39;ScrolledText&#39;: &#39;tkinter.scrolledtext&#39;,</span>
           <span class="c"># &#39;Tkconstants&#39;: &#39;tkinter.constants&#39;,</span>
           <span class="c"># &#39;Tix&#39;: &#39;tkinter.tix&#39;,</span>
           <span class="c"># &#39;ttk&#39;: &#39;tkinter.ttk&#39;,</span>
           <span class="c"># &#39;Tkinter&#39;: &#39;tkinter&#39;,</span>
           <span class="s">&#39;_winreg&#39;</span><span class="p">:</span> <span class="s">&#39;winreg&#39;</span><span class="p">,</span>
           <span class="s">&#39;thread&#39;</span><span class="p">:</span> <span class="s">&#39;_thread&#39;</span><span class="p">,</span>
           <span class="s">&#39;dummy_thread&#39;</span><span class="p">:</span> <span class="s">&#39;_dummy_thread&#39;</span><span class="p">,</span>
           <span class="c"># &#39;anydbm&#39;: &#39;dbm&#39;,   # causes infinite import loop</span>
           <span class="c"># &#39;whichdb&#39;: &#39;dbm&#39;,  # causes infinite import loop</span>
           <span class="c"># anydbm and whichdb are handled by fix_imports2</span>
           <span class="c"># &#39;dbhash&#39;: &#39;dbm.bsd&#39;,</span>
           <span class="c"># &#39;dumbdbm&#39;: &#39;dbm.dumb&#39;,</span>
           <span class="c"># &#39;dbm&#39;: &#39;dbm.ndbm&#39;,</span>
           <span class="c"># &#39;gdbm&#39;: &#39;dbm.gnu&#39;,</span>
           <span class="s">&#39;future.moves.xmlrpc&#39;</span><span class="p">:</span> <span class="s">&#39;xmlrpc&#39;</span><span class="p">,</span>
           <span class="c"># &#39;future.backports.email&#39;: &#39;email&#39;,    # for use by urllib</span>
           <span class="c"># &#39;DocXMLRPCServer&#39;: &#39;xmlrpc.server&#39;,</span>
           <span class="c"># &#39;SimpleXMLRPCServer&#39;: &#39;xmlrpc.server&#39;,</span>
           <span class="c"># &#39;httplib&#39;: &#39;http.client&#39;,</span>
           <span class="c"># &#39;htmlentitydefs&#39; : &#39;html.entities&#39;,</span>
           <span class="c"># &#39;HTMLParser&#39; : &#39;html.parser&#39;,</span>
           <span class="c"># &#39;Cookie&#39;: &#39;http.cookies&#39;,</span>
           <span class="c"># &#39;cookielib&#39;: &#39;http.cookiejar&#39;,</span>
           <span class="c"># &#39;BaseHTTPServer&#39;: &#39;http.server&#39;,</span>
           <span class="c"># &#39;SimpleHTTPServer&#39;: &#39;http.server&#39;,</span>
           <span class="c"># &#39;CGIHTTPServer&#39;: &#39;http.server&#39;,</span>
           <span class="c"># &#39;future.backports.test&#39;: &#39;test&#39;,  # primarily for renaming test_support to support</span>
           <span class="c"># &#39;commands&#39;: &#39;subprocess&#39;,</span>
           <span class="c"># &#39;urlparse&#39; : &#39;urllib.parse&#39;,</span>
           <span class="c"># &#39;robotparser&#39; : &#39;urllib.robotparser&#39;,</span>
           <span class="c"># &#39;abc&#39;: &#39;collections.abc&#39;,   # for Py33</span>
           <span class="c"># &#39;future.utils.six.moves.html&#39;: &#39;html&#39;,</span>
           <span class="c"># &#39;future.utils.six.moves.http&#39;: &#39;http&#39;,</span>
           <span class="s">&#39;future.moves.html&#39;</span><span class="p">:</span> <span class="s">&#39;html&#39;</span><span class="p">,</span>
           <span class="s">&#39;future.moves.http&#39;</span><span class="p">:</span> <span class="s">&#39;http&#39;</span><span class="p">,</span>
           <span class="c"># &#39;future.backports.urllib&#39;: &#39;urllib&#39;,</span>
           <span class="c"># &#39;future.utils.six.moves.urllib&#39;: &#39;urllib&#39;,</span>
           <span class="s">&#39;future.moves._markupbase&#39;</span><span class="p">:</span> <span class="s">&#39;_markupbase&#39;</span><span class="p">,</span>
          <span class="p">}</span>


<span class="c"># It is complicated and apparently brittle to mess around with the</span>
<span class="c"># ``sys.modules`` cache in order to support &quot;import urllib&quot; meaning two</span>
<span class="c"># different things (Py2.7 urllib and backported Py3.3-like urllib) in different</span>
<span class="c"># contexts. So we require explicit imports for these modules.</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">RENAMES</span><span class="o">.</span><span class="n">values</span><span class="p">())</span> <span class="o">&amp;</span> <span class="nb">set</span><span class="p">(</span><span class="n">REPLACED_MODULES</span><span class="p">))</span> <span class="o">==</span> <span class="mi">0</span>


<span class="c"># Harmless renames that we can insert.</span>
<span class="c"># These modules need names from elsewhere being added to them:</span>
<span class="c">#   subprocess: should provide getoutput and other fns from commands</span>
<span class="c">#               module but these fns are missing: getstatus, mk2arg,</span>
<span class="c">#               mkarg</span>
<span class="c">#   re:         needs an ASCII constant that works compatibly with Py3</span>

<span class="c"># etc: see lib2to3/fixes/fix_imports.py</span>

<span class="c"># (New module name, new object name, old module name, old object name)</span>
<span class="n">MOVES</span> <span class="o">=</span> <span class="p">[(</span><span class="s">&#39;collections&#39;</span><span class="p">,</span> <span class="s">&#39;UserList&#39;</span><span class="p">,</span> <span class="s">&#39;UserList&#39;</span><span class="p">,</span> <span class="s">&#39;UserList&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;collections&#39;</span><span class="p">,</span> <span class="s">&#39;UserDict&#39;</span><span class="p">,</span> <span class="s">&#39;UserDict&#39;</span><span class="p">,</span> <span class="s">&#39;UserDict&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;collections&#39;</span><span class="p">,</span> <span class="s">&#39;UserString&#39;</span><span class="p">,</span><span class="s">&#39;UserString&#39;</span><span class="p">,</span> <span class="s">&#39;UserString&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;itertools&#39;</span><span class="p">,</span> <span class="s">&#39;filterfalse&#39;</span><span class="p">,</span><span class="s">&#39;itertools&#39;</span><span class="p">,</span> <span class="s">&#39;ifilterfalse&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;itertools&#39;</span><span class="p">,</span> <span class="s">&#39;zip_longest&#39;</span><span class="p">,</span><span class="s">&#39;itertools&#39;</span><span class="p">,</span> <span class="s">&#39;izip_longest&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;sys&#39;</span><span class="p">,</span> <span class="s">&#39;intern&#39;</span><span class="p">,</span><span class="s">&#39;__builtin__&#39;</span><span class="p">,</span> <span class="s">&#39;intern&#39;</span><span class="p">),</span>
         <span class="c"># The re module has no ASCII flag in Py2, but this is the default.</span>
         <span class="c"># Set re.ASCII to a zero constant. stat.ST_MODE just happens to be one</span>
         <span class="c"># (and it exists on Py2.6+).</span>
         <span class="p">(</span><span class="s">&#39;re&#39;</span><span class="p">,</span> <span class="s">&#39;ASCII&#39;</span><span class="p">,</span><span class="s">&#39;stat&#39;</span><span class="p">,</span> <span class="s">&#39;ST_MODE&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;base64&#39;</span><span class="p">,</span> <span class="s">&#39;encodebytes&#39;</span><span class="p">,</span><span class="s">&#39;base64&#39;</span><span class="p">,</span> <span class="s">&#39;encodestring&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;base64&#39;</span><span class="p">,</span> <span class="s">&#39;decodebytes&#39;</span><span class="p">,</span><span class="s">&#39;base64&#39;</span><span class="p">,</span> <span class="s">&#39;decodestring&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;subprocess&#39;</span><span class="p">,</span> <span class="s">&#39;getoutput&#39;</span><span class="p">,</span> <span class="s">&#39;commands&#39;</span><span class="p">,</span> <span class="s">&#39;getoutput&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;subprocess&#39;</span><span class="p">,</span> <span class="s">&#39;getstatusoutput&#39;</span><span class="p">,</span> <span class="s">&#39;commands&#39;</span><span class="p">,</span> <span class="s">&#39;getstatusoutput&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;subprocess&#39;</span><span class="p">,</span> <span class="s">&#39;check_output&#39;</span><span class="p">,</span> <span class="s">&#39;future.backports.misc&#39;</span><span class="p">,</span> <span class="s">&#39;check_output&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;math&#39;</span><span class="p">,</span> <span class="s">&#39;ceil&#39;</span><span class="p">,</span> <span class="s">&#39;future.backports.misc&#39;</span><span class="p">,</span> <span class="s">&#39;ceil&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;collections&#39;</span><span class="p">,</span> <span class="s">&#39;OrderedDict&#39;</span><span class="p">,</span> <span class="s">&#39;future.backports.misc&#39;</span><span class="p">,</span> <span class="s">&#39;OrderedDict&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;collections&#39;</span><span class="p">,</span> <span class="s">&#39;Counter&#39;</span><span class="p">,</span> <span class="s">&#39;future.backports.misc&#39;</span><span class="p">,</span> <span class="s">&#39;Counter&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;itertools&#39;</span><span class="p">,</span> <span class="s">&#39;count&#39;</span><span class="p">,</span> <span class="s">&#39;future.backports.misc&#39;</span><span class="p">,</span> <span class="s">&#39;count&#39;</span><span class="p">),</span>
         <span class="p">(</span><span class="s">&#39;reprlib&#39;</span><span class="p">,</span> <span class="s">&#39;recursive_repr&#39;</span><span class="p">,</span> <span class="s">&#39;future.backports.misc&#39;</span><span class="p">,</span> <span class="s">&#39;recursive_repr&#39;</span><span class="p">),</span>

<span class="c"># This is no use, since &quot;import urllib.request&quot; etc. still fails:</span>
<span class="c">#          (&#39;urllib&#39;, &#39;error&#39;, &#39;future.moves.urllib&#39;, &#39;error&#39;),</span>
<span class="c">#          (&#39;urllib&#39;, &#39;parse&#39;, &#39;future.moves.urllib&#39;, &#39;parse&#39;),</span>
<span class="c">#          (&#39;urllib&#39;, &#39;request&#39;, &#39;future.moves.urllib&#39;, &#39;request&#39;),</span>
<span class="c">#          (&#39;urllib&#39;, &#39;response&#39;, &#39;future.moves.urllib&#39;, &#39;response&#39;),</span>
<span class="c">#          (&#39;urllib&#39;, &#39;robotparser&#39;, &#39;future.moves.urllib&#39;, &#39;robotparser&#39;),</span>
        <span class="p">]</span>


<span class="c"># A minimal example of an import hook:</span>
<span class="c"># class WarnOnImport(object):</span>
<span class="c">#     def __init__(self, *args):</span>
<span class="c">#         self.module_names = args</span>
<span class="c">#</span>
<span class="c">#     def find_module(self, fullname, path=None):</span>
<span class="c">#         if fullname in self.module_names:</span>
<span class="c">#             self.path = path</span>
<span class="c">#             return self</span>
<span class="c">#         return None</span>
<span class="c">#</span>
<span class="c">#     def load_module(self, name):</span>
<span class="c">#         if name in sys.modules:</span>
<span class="c">#             return sys.modules[name]</span>
<span class="c">#         module_info = imp.find_module(name, self.path)</span>
<span class="c">#         module = imp.load_module(name, *module_info)</span>
<span class="c">#         sys.modules[name] = module</span>
<span class="c">#         flog.warning(&quot;Imported deprecated module %s&quot;, name)</span>
<span class="c">#         return module</span>


<div class="viewcode-block" id="RenameImport"><a class="viewcode-back" href="../../reference.html#future.standard_library.RenameImport">[docs]</a><span class="k">class</span> <span class="nc">RenameImport</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    A class for import hooks mapping Py3 module names etc. to the Py2 equivalents.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="c"># Different RenameImport classes are created when importing this module from</span>
    <span class="c"># different source files. This causes isinstance(hook, RenameImport) checks</span>
    <span class="c"># to produce inconsistent results. We add this RENAMER attribute here so</span>
    <span class="c"># remove_hooks() and install_hooks() can find instances of these classes</span>
    <span class="c"># easily:</span>
    <span class="n">RENAMER</span> <span class="o">=</span> <span class="bp">True</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">old_to_new</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;</span>
<span class="sd">        Pass in a dictionary-like object mapping from old names to new</span>
<span class="sd">        names. E.g. {&#39;ConfigParser&#39;: &#39;configparser&#39;, &#39;cPickle&#39;: &#39;pickle&#39;}</span>
<span class="sd">        &#39;&#39;&#39;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">old_to_new</span> <span class="o">=</span> <span class="n">old_to_new</span>
        <span class="n">both</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">old_to_new</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="o">&amp;</span> <span class="nb">set</span><span class="p">(</span><span class="n">old_to_new</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>
        <span class="k">assert</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">both</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">and</span>
                <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">old_to_new</span><span class="o">.</span><span class="n">values</span><span class="p">()))</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">old_to_new</span><span class="o">.</span><span class="n">values</span><span class="p">())),</span> \
               <span class="s">&#39;Ambiguity in renaming (handler not implemented)&#39;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">new_to_old</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">new</span><span class="p">,</span> <span class="n">old</span><span class="p">)</span> <span class="k">for</span> <span class="p">(</span><span class="n">old</span><span class="p">,</span> <span class="n">new</span><span class="p">)</span> <span class="ow">in</span> <span class="n">old_to_new</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>

    <span class="k">def</span> <span class="nf">find_module</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fullname</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="c"># Handles hierarchical importing: package.module.module2</span>
        <span class="n">new_base_names</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="n">s</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">new_to_old</span><span class="p">])</span>
        <span class="c"># Before v0.12: Was: if fullname in set(self.old_to_new) | new_base_names:</span>
        <span class="k">if</span> <span class="n">fullname</span> <span class="ow">in</span> <span class="n">new_base_names</span><span class="p">:</span>
            <span class="k">return</span> <span class="bp">self</span>
        <span class="k">return</span> <span class="bp">None</span>

    <span class="k">def</span> <span class="nf">load_module</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
        <span class="n">path</span> <span class="o">=</span> <span class="bp">None</span>
        <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
        <span class="k">elif</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">new_to_old</span><span class="p">:</span>
            <span class="c"># New name. Look up the corresponding old (Py2) name:</span>
            <span class="n">oldname</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">new_to_old</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
            <span class="n">module</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_and_load_module</span><span class="p">(</span><span class="n">oldname</span><span class="p">)</span>
            <span class="c"># module.__future_module__ = True</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">module</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_and_load_module</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
        <span class="c"># In any case, make it available under the requested (Py3) name</span>
        <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">module</span>
        <span class="k">return</span> <span class="n">module</span>

    <span class="k">def</span> <span class="nf">_find_and_load_module</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Finds and loads it. But if there&#39;s a . in the name, handles it</span>
<span class="sd">        properly.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">bits</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span>
        <span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="n">bits</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
            <span class="c"># Treat the first bit as a package</span>
            <span class="n">packagename</span> <span class="o">=</span> <span class="n">bits</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
            <span class="n">package</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_and_load_module</span><span class="p">(</span><span class="n">packagename</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
            <span class="k">try</span><span class="p">:</span>
                <span class="n">path</span> <span class="o">=</span> <span class="n">package</span><span class="o">.</span><span class="n">__path__</span>
            <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
                <span class="c"># This could be e.g. moves.</span>
                <span class="n">flog</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&#39;Package {0} has no __path__.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">package</span><span class="p">))</span>
                <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span>
                    <span class="k">return</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
                <span class="n">flog</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&#39;What to do here?&#39;</span><span class="p">)</span>

        <span class="n">name</span> <span class="o">=</span> <span class="n">bits</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
        <span class="n">module_info</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">find_module</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">imp</span><span class="o">.</span><span class="n">load_module</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="o">*</span><span class="n">module_info</span><span class="p">)</span>

</div>
<div class="viewcode-block" id="hooks"><a class="viewcode-back" href="../../reference.html#future.standard_library.hooks">[docs]</a><span class="k">class</span> <span class="nc">hooks</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Acts as a context manager. Saves the state of sys.modules and restores it</span>
<span class="sd">    after the &#39;with&#39; block.</span>

<span class="sd">    Use like this:</span>

<span class="sd">    &gt;&gt;&gt; from future import standard_library</span>
<span class="sd">    &gt;&gt;&gt; with standard_library.hooks():</span>
<span class="sd">    ...     import http.client</span>
<span class="sd">    &gt;&gt;&gt; import requests</span>

<span class="sd">    For this to work, http.client will be scrubbed from sys.modules after the</span>
<span class="sd">    &#39;with&#39; block. That way the modules imported in the &#39;with&#39; block will</span>
<span class="sd">    continue to be accessible in the current namespace but not from any</span>
<span class="sd">    imported modules (like requests).</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="c"># flog.debug(&#39;Entering hooks context manager&#39;)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">old_sys_modules</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">hooks_were_installed</span> <span class="o">=</span> <span class="n">detect_hooks</span><span class="p">()</span>
        <span class="c"># self.scrubbed = scrub_py2_sys_modules()</span>
        <span class="n">install_hooks</span><span class="p">()</span>
        <span class="k">return</span> <span class="bp">self</span>

    <span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
        <span class="c"># flog.debug(&#39;Exiting hooks context manager&#39;)</span>
        <span class="c"># restore_sys_modules(self.scrubbed)</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">hooks_were_installed</span><span class="p">:</span>
            <span class="n">remove_hooks</span><span class="p">()</span>
        <span class="c"># scrub_future_sys_modules()</span>

<span class="c"># Sanity check for is_py2_stdlib_module(): We aren&#39;t replacing any</span>
<span class="c"># builtin modules names:</span></div>
<span class="k">if</span> <span class="n">PY2</span><span class="p">:</span>
    <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">RENAMES</span><span class="o">.</span><span class="n">values</span><span class="p">())</span> <span class="o">&amp;</span> <span class="nb">set</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">builtin_module_names</span><span class="p">))</span> <span class="o">==</span> <span class="mi">0</span>


<div class="viewcode-block" id="is_py2_stdlib_module"><a class="viewcode-back" href="../../reference.html#future.standard_library.is_py2_stdlib_module">[docs]</a><span class="k">def</span> <span class="nf">is_py2_stdlib_module</span><span class="p">(</span><span class="n">m</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Tries to infer whether the module m is from the Python 2 standard library.</span>
<span class="sd">    This may not be reliable on all systems.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="n">PY3</span><span class="p">:</span>
        <span class="k">return</span> <span class="bp">False</span>
    <span class="k">if</span> <span class="ow">not</span> <span class="s">&#39;stdlib_path&#39;</span> <span class="ow">in</span> <span class="n">is_py2_stdlib_module</span><span class="o">.</span><span class="n">__dict__</span><span class="p">:</span>
        <span class="n">stdlib_files</span> <span class="o">=</span> <span class="p">[</span><span class="n">contextlib</span><span class="o">.</span><span class="n">__file__</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">__file__</span><span class="p">,</span> <span class="n">copy</span><span class="o">.</span><span class="n">__file__</span><span class="p">]</span>
        <span class="n">stdlib_paths</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">f</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">stdlib_files</span><span class="p">]</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">stdlib_paths</span><span class="p">))</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
            <span class="c"># This seems to happen on travis-ci.org. Very strange. We&#39;ll try to</span>
            <span class="c"># ignore it.</span>
            <span class="n">flog</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s">&#39;Multiple locations found for the Python standard &#39;</span>
                         <span class="s">&#39;library: </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">stdlib_paths</span><span class="p">)</span>
        <span class="c"># Choose the first one arbitrarily</span>
        <span class="n">is_py2_stdlib_module</span><span class="o">.</span><span class="n">stdlib_path</span> <span class="o">=</span> <span class="n">stdlib_paths</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>

    <span class="k">if</span> <span class="n">m</span><span class="o">.</span><span class="n">__name__</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">builtin_module_names</span><span class="p">:</span>
        <span class="k">return</span> <span class="bp">True</span>

    <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="s">&#39;__file__&#39;</span><span class="p">):</span>
        <span class="n">modpath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">__file__</span><span class="p">)</span>
        <span class="k">if</span> <span class="p">(</span><span class="n">modpath</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">is_py2_stdlib_module</span><span class="o">.</span><span class="n">stdlib_path</span><span class="p">)</span> <span class="ow">and</span>
            <span class="s">&#39;site-packages&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">modpath</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
            <span class="k">return</span> <span class="bp">True</span>

    <span class="k">return</span> <span class="bp">False</span>

</div>
<div class="viewcode-block" id="scrub_py2_sys_modules"><a class="viewcode-back" href="../../reference.html#future.standard_library.scrub_py2_sys_modules">[docs]</a><span class="k">def</span> <span class="nf">scrub_py2_sys_modules</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Removes any Python 2 standard library modules from ``sys.modules`` that</span>
<span class="sd">    would interfere with Py3-style imports using import hooks. Examples are</span>
<span class="sd">    modules with the same names (like urllib or email).</span>

<span class="sd">    (Note that currently import hooks are disabled for modules like these</span>
<span class="sd">    with ambiguous names anyway ...)</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="n">PY3</span><span class="p">:</span>
        <span class="k">return</span> <span class="p">{}</span>
    <span class="n">scrubbed</span> <span class="o">=</span> <span class="p">{}</span>
    <span class="k">for</span> <span class="n">modulename</span> <span class="ow">in</span> <span class="n">REPLACED_MODULES</span> <span class="o">&amp;</span> <span class="nb">set</span><span class="p">(</span><span class="n">RENAMES</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="n">modulename</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span>
            <span class="k">continue</span>

        <span class="n">module</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">modulename</span><span class="p">]</span>

        <span class="k">if</span> <span class="n">is_py2_stdlib_module</span><span class="p">(</span><span class="n">module</span><span class="p">):</span>
            <span class="n">flog</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&#39;Deleting (Py2) {} from sys.modules&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">modulename</span><span class="p">))</span>
            <span class="n">scrubbed</span><span class="p">[</span><span class="n">modulename</span><span class="p">]</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">modulename</span><span class="p">]</span>
            <span class="k">del</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">modulename</span><span class="p">]</span>
    <span class="k">return</span> <span class="n">scrubbed</span>

</div>
<div class="viewcode-block" id="scrub_future_sys_modules"><a class="viewcode-back" href="../../reference.html#future.standard_library.scrub_future_sys_modules">[docs]</a><span class="k">def</span> <span class="nf">scrub_future_sys_modules</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Deprecated.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">return</span> <span class="p">{}</span>    
</div>
<div class="viewcode-block" id="suspend_hooks"><a class="viewcode-back" href="../../reference.html#future.standard_library.suspend_hooks">[docs]</a><span class="k">class</span> <span class="nc">suspend_hooks</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Acts as a context manager. Use like this:</span>

<span class="sd">    &gt;&gt;&gt; from future import standard_library</span>
<span class="sd">    &gt;&gt;&gt; standard_library.install_hooks()</span>
<span class="sd">    &gt;&gt;&gt; import http.client</span>
<span class="sd">    &gt;&gt;&gt; # ...</span>
<span class="sd">    &gt;&gt;&gt; with standard_library.suspend_hooks():</span>
<span class="sd">    &gt;&gt;&gt;     import requests     # incompatible with ``future``&#39;s standard library hooks</span>

<span class="sd">    If the hooks were disabled before the context, they are not installed when</span>
<span class="sd">    the context is left.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">hooks_were_installed</span> <span class="o">=</span> <span class="n">detect_hooks</span><span class="p">()</span>
        <span class="n">remove_hooks</span><span class="p">()</span>
        <span class="c"># self.scrubbed = scrub_future_sys_modules()</span>
        <span class="k">return</span> <span class="bp">self</span>

    <span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hooks_were_installed</span><span class="p">:</span>
            <span class="n">install_hooks</span><span class="p">()</span>
        <span class="c"># restore_sys_modules(self.scrubbed)</span>

</div>
<div class="viewcode-block" id="restore_sys_modules"><a class="viewcode-back" href="../../reference.html#future.standard_library.restore_sys_modules">[docs]</a><span class="k">def</span> <span class="nf">restore_sys_modules</span><span class="p">(</span><span class="n">scrubbed</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Add any previously scrubbed modules back to the sys.modules cache,</span>
<span class="sd">    but only if it&#39;s safe to do so.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">clash</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">)</span> <span class="o">&amp;</span> <span class="nb">set</span><span class="p">(</span><span class="n">scrubbed</span><span class="p">)</span>
    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">clash</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
        <span class="c"># If several, choose one arbitrarily to raise an exception about</span>
        <span class="n">first</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">clash</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
        <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s">&#39;future module {} clashes with Py2 module&#39;</span>
                          <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">first</span><span class="p">))</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">scrubbed</span><span class="p">)</span>

</div>
<div class="viewcode-block" id="install_aliases"><a class="viewcode-back" href="../../reference.html#future.standard_library.install_aliases">[docs]</a><span class="k">def</span> <span class="nf">install_aliases</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Monkey-patches the standard library in Py2.6/7 to provide</span>
<span class="sd">    aliases for better Py3 compatibility.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="n">PY3</span><span class="p">:</span>
        <span class="k">return</span>
    <span class="c"># if hasattr(install_aliases, &#39;run_already&#39;):</span>
    <span class="c">#     return</span>
    <span class="k">for</span> <span class="p">(</span><span class="n">newmodname</span><span class="p">,</span> <span class="n">newobjname</span><span class="p">,</span> <span class="n">oldmodname</span><span class="p">,</span> <span class="n">oldobjname</span><span class="p">)</span> <span class="ow">in</span> <span class="n">MOVES</span><span class="p">:</span>
        <span class="nb">__import__</span><span class="p">(</span><span class="n">newmodname</span><span class="p">)</span>
        <span class="c"># We look up the module in sys.modules because __import__ just returns the</span>
        <span class="c"># top-level package:</span>
        <span class="n">newmod</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">newmodname</span><span class="p">]</span>
        <span class="c"># newmod.__future_module__ = True</span>

        <span class="nb">__import__</span><span class="p">(</span><span class="n">oldmodname</span><span class="p">)</span>
        <span class="n">oldmod</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">oldmodname</span><span class="p">]</span>

        <span class="n">obj</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">oldmod</span><span class="p">,</span> <span class="n">oldobjname</span><span class="p">)</span>
        <span class="nb">setattr</span><span class="p">(</span><span class="n">newmod</span><span class="p">,</span> <span class="n">newobjname</span><span class="p">,</span> <span class="n">obj</span><span class="p">)</span>

    <span class="c"># Hack for urllib so it appears to have the same structure on Py2 as on Py3</span>
    <span class="kn">import</span> <span class="nn">urllib</span>
    <span class="kn">from</span> <span class="nn">future.backports.urllib</span> <span class="kn">import</span> <span class="n">request</span>
    <span class="kn">from</span> <span class="nn">future.backports.urllib</span> <span class="kn">import</span> <span class="n">response</span>
    <span class="kn">from</span> <span class="nn">future.backports.urllib</span> <span class="kn">import</span> <span class="n">parse</span>
    <span class="kn">from</span> <span class="nn">future.backports.urllib</span> <span class="kn">import</span> <span class="n">error</span>
    <span class="kn">from</span> <span class="nn">future.backports.urllib</span> <span class="kn">import</span> <span class="n">robotparser</span>
    <span class="n">urllib</span><span class="o">.</span><span class="n">request</span> <span class="o">=</span> <span class="n">request</span>
    <span class="n">urllib</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="n">response</span>
    <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span> <span class="o">=</span> <span class="n">parse</span>
    <span class="n">urllib</span><span class="o">.</span><span class="n">error</span> <span class="o">=</span> <span class="n">error</span>
    <span class="n">urllib</span><span class="o">.</span><span class="n">robotparser</span> <span class="o">=</span> <span class="n">robotparser</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">&#39;urllib.request&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">request</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">&#39;urllib.response&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">response</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">&#39;urllib.parse&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">parse</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">&#39;urllib.error&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">error</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">&#39;urllib.robotparser&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">robotparser</span>

    <span class="c"># Patch the test module so it appears to have the same structure on Py2 as on Py3</span>
    <span class="k">try</span><span class="p">:</span>
        <span class="kn">import</span> <span class="nn">test</span>
    <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
        <span class="k">pass</span>
    <span class="k">try</span><span class="p">:</span>
        <span class="kn">from</span> <span class="nn">future.moves.test</span> <span class="kn">import</span> <span class="n">support</span>
    <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
        <span class="k">pass</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="n">test</span><span class="o">.</span><span class="n">support</span> <span class="o">=</span> <span class="n">support</span>
        <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">&#39;test.support&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">support</span>

    <span class="c"># Patch the dbm module so it appears to have the same structure on Py2 as on Py3</span>
    <span class="k">try</span><span class="p">:</span>
        <span class="kn">import</span> <span class="nn">dbm</span>
    <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
        <span class="k">pass</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="kn">from</span> <span class="nn">future.moves.dbm</span> <span class="kn">import</span> <span class="n">dumb</span>
        <span class="n">dbm</span><span class="o">.</span><span class="n">dumb</span> <span class="o">=</span> <span class="n">dumb</span>
        <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">&#39;dbm.dumb&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">dumb</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="kn">from</span> <span class="nn">future.moves.dbm</span> <span class="kn">import</span> <span class="n">gnu</span>
        <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
            <span class="k">pass</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">dbm</span><span class="o">.</span><span class="n">gnu</span> <span class="o">=</span> <span class="n">gnu</span>
            <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">&#39;dbm.gnu&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">gnu</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="kn">from</span> <span class="nn">future.moves.dbm</span> <span class="kn">import</span> <span class="n">ndbm</span>
        <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
            <span class="k">pass</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">dbm</span><span class="o">.</span><span class="n">ndbm</span> <span class="o">=</span> <span class="n">ndbm</span>
            <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">&#39;dbm.ndbm&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ndbm</span>

    <span class="c"># install_aliases.run_already = True</span>

</div>
<div class="viewcode-block" id="install_hooks"><a class="viewcode-back" href="../../reference.html#future.standard_library.install_hooks">[docs]</a><span class="k">def</span> <span class="nf">install_hooks</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    This function installs the future.standard_library import hook into</span>
<span class="sd">    sys.meta_path.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="n">PY3</span><span class="p">:</span>
        <span class="k">return</span>

    <span class="n">install_aliases</span><span class="p">()</span>

    <span class="n">flog</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&#39;sys.meta_path was: {0}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">meta_path</span><span class="p">))</span>
    <span class="n">flog</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&#39;Installing hooks ...&#39;</span><span class="p">)</span>

    <span class="c"># Add it unless it&#39;s there already</span>
    <span class="n">newhook</span> <span class="o">=</span> <span class="n">RenameImport</span><span class="p">(</span><span class="n">RENAMES</span><span class="p">)</span>
    <span class="k">if</span> <span class="ow">not</span> <span class="n">detect_hooks</span><span class="p">():</span>
        <span class="n">sys</span><span class="o">.</span><span class="n">meta_path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">newhook</span><span class="p">)</span>
    <span class="n">flog</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&#39;sys.meta_path is now: {0}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">meta_path</span><span class="p">))</span>

</div>
<div class="viewcode-block" id="enable_hooks"><a class="viewcode-back" href="../../reference.html#future.standard_library.enable_hooks">[docs]</a><span class="k">def</span> <span class="nf">enable_hooks</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Deprecated. Use install_hooks() instead. This will be removed by</span>
<span class="sd">    ``future`` v1.0.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">install_hooks</span><span class="p">()</span>

</div>
<div class="viewcode-block" id="remove_hooks"><a class="viewcode-back" href="../../reference.html#future.standard_library.remove_hooks">[docs]</a><span class="k">def</span> <span class="nf">remove_hooks</span><span class="p">(</span><span class="n">scrub_sys_modules</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    This function removes the import hook from sys.meta_path.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="n">PY3</span><span class="p">:</span>
        <span class="k">return</span>
    <span class="n">flog</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&#39;Uninstalling hooks ...&#39;</span><span class="p">)</span>
    <span class="c"># Loop backwards, so deleting items keeps the ordering:</span>
    <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">hook</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="nb">enumerate</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">meta_path</span><span class="p">))[::</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
        <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">hook</span><span class="p">,</span> <span class="s">&#39;RENAMER&#39;</span><span class="p">):</span>
            <span class="k">del</span> <span class="n">sys</span><span class="o">.</span><span class="n">meta_path</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>

    <span class="c"># Explicit is better than implicit. In the future the interface should</span>
    <span class="c"># probably change so that scrubbing the import hooks requires a separate</span>
    <span class="c"># function call. Left as is for now for backward compatibility with</span>
    <span class="c"># v0.11.x.</span>
    <span class="k">if</span> <span class="n">scrub_sys_modules</span><span class="p">:</span>
        <span class="n">scrub_future_sys_modules</span><span class="p">()</span>

</div>
<div class="viewcode-block" id="disable_hooks"><a class="viewcode-back" href="../../reference.html#future.standard_library.disable_hooks">[docs]</a><span class="k">def</span> <span class="nf">disable_hooks</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Deprecated. Use remove_hooks() instead. This will be removed by</span>
<span class="sd">    ``future`` v1.0.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">remove_hooks</span><span class="p">()</span>

</div>
<div class="viewcode-block" id="detect_hooks"><a class="viewcode-back" href="../../reference.html#future.standard_library.detect_hooks">[docs]</a><span class="k">def</span> <span class="nf">detect_hooks</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Returns True if the import hooks are installed, False if not.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">flog</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&#39;Detecting hooks ...&#39;</span><span class="p">)</span>
    <span class="n">present</span> <span class="o">=</span> <span class="nb">any</span><span class="p">([</span><span class="nb">hasattr</span><span class="p">(</span><span class="n">hook</span><span class="p">,</span> <span class="s">&#39;RENAMER&#39;</span><span class="p">)</span> <span class="k">for</span> <span class="n">hook</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">meta_path</span><span class="p">])</span>
    <span class="k">if</span> <span class="n">present</span><span class="p">:</span>
        <span class="n">flog</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&#39;Detected.&#39;</span><span class="p">)</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="n">flog</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&#39;Not detected.&#39;</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">present</span>


<span class="c"># As of v0.12, this no longer happens implicitly:</span>
<span class="c"># if not PY3:</span>
<span class="c">#     install_hooks()</span>

</div>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">sys</span><span class="p">,</span> <span class="s">&#39;py2_modules&#39;</span><span class="p">):</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">py2_modules</span> <span class="o">=</span> <span class="p">{}</span>

<div class="viewcode-block" id="cache_py2_modules"><a class="viewcode-back" href="../../reference.html#future.standard_library.cache_py2_modules">[docs]</a><span class="k">def</span> <span class="nf">cache_py2_modules</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Currently this function is unneeded, as we are not attempting to provide import hooks</span>
<span class="sd">    for modules with ambiguous names: email, urllib, pickle.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">py2_modules</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
        <span class="k">return</span>
    <span class="k">assert</span> <span class="ow">not</span> <span class="n">detect_hooks</span><span class="p">()</span>
    <span class="kn">import</span> <span class="nn">urllib</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">py2_modules</span><span class="p">[</span><span class="s">&#39;urllib&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">urllib</span>

    <span class="kn">import</span> <span class="nn">email</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">py2_modules</span><span class="p">[</span><span class="s">&#39;email&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">email</span>

    <span class="kn">import</span> <span class="nn">pickle</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">py2_modules</span><span class="p">[</span><span class="s">&#39;pickle&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">pickle</span>

    <span class="c"># Not all Python installations have test module. (Anaconda doesn&#39;t, for example.)</span>
    <span class="c"># try:</span>
    <span class="c">#     import test</span>
    <span class="c"># except ImportError:</span>
    <span class="c">#     sys.py2_modules[&#39;test&#39;] = None</span>
    <span class="c"># sys.py2_modules[&#39;test&#39;] = test</span>

    <span class="c"># import dbm</span>
    <span class="c"># sys.py2_modules[&#39;dbm&#39;] = dbm</span>

</div>
<div class="viewcode-block" id="import_"><a class="viewcode-back" href="../../reference.html#future.standard_library.import_">[docs]</a><span class="k">def</span> <span class="nf">import_</span><span class="p">(</span><span class="n">module_name</span><span class="p">,</span> <span class="n">backport</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Pass a (potentially dotted) module name of a Python 3 standard library</span>
<span class="sd">    module. This function imports the module compatibly on Py2 and Py3 and</span>
<span class="sd">    returns the top-level module.</span>

<span class="sd">    Example use:</span>
<span class="sd">        &gt;&gt;&gt; http = import_(&#39;http.client&#39;)</span>
<span class="sd">        &gt;&gt;&gt; http = import_(&#39;http.server&#39;)</span>
<span class="sd">        &gt;&gt;&gt; urllib = import_(&#39;urllib.request&#39;)</span>

<span class="sd">    Then:</span>
<span class="sd">        &gt;&gt;&gt; conn = http.client.HTTPConnection(...)</span>
<span class="sd">        &gt;&gt;&gt; response = urllib.request.urlopen(&#39;http://mywebsite.com&#39;)</span>
<span class="sd">        &gt;&gt;&gt; # etc.</span>

<span class="sd">    Use as follows:</span>
<span class="sd">        &gt;&gt;&gt; package_name = import_(module_name)</span>

<span class="sd">    On Py3, equivalent to this:</span>

<span class="sd">        &gt;&gt;&gt; import module_name</span>

<span class="sd">    On Py2, equivalent to this if backport=False:</span>

<span class="sd">        &gt;&gt;&gt; from future.moves import module_name</span>

<span class="sd">    or to this if backport=True:</span>

<span class="sd">        &gt;&gt;&gt; from future.backports import module_name</span>

<span class="sd">    except that it also handles dotted module names such as ``http.client``</span>
<span class="sd">    The effect then is like this:</span>

<span class="sd">        &gt;&gt;&gt; from future.backports import module</span>
<span class="sd">        &gt;&gt;&gt; from future.backports.module import submodule</span>
<span class="sd">        &gt;&gt;&gt; module.submodule = submodule</span>

<span class="sd">    Note that this would be a SyntaxError in Python:</span>

<span class="sd">        &gt;&gt;&gt; from future.backports import http.client</span>

<span class="sd">    &quot;&quot;&quot;</span>
    <span class="c"># Python 2.6 doesn&#39;t have importlib in the stdlib, so it requires</span>
    <span class="c"># the backported ``importlib`` package from PyPI as a dependency to use</span>
    <span class="c"># this function:</span>
    <span class="kn">import</span> <span class="nn">importlib</span>

    <span class="k">if</span> <span class="n">PY3</span><span class="p">:</span>
        <span class="k">return</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">module_name</span><span class="p">)</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="c"># client.blah = blah</span>
        <span class="c"># Then http.client = client</span>
        <span class="c"># etc.</span>
        <span class="k">if</span> <span class="n">backport</span><span class="p">:</span>
            <span class="n">prefix</span> <span class="o">=</span> <span class="s">&#39;future.backports&#39;</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">prefix</span> <span class="o">=</span> <span class="s">&#39;future.moves&#39;</span>
        <span class="n">parts</span> <span class="o">=</span> <span class="n">prefix</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="n">module_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span>

        <span class="n">modules</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">part</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">parts</span><span class="p">):</span>
            <span class="n">sofar</span> <span class="o">=</span> <span class="s">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">parts</span><span class="p">[:</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">])</span>
            <span class="n">modules</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span><span class="n">sofar</span><span class="p">))</span>
        <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">part</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="nb">enumerate</span><span class="p">(</span><span class="n">parts</span><span class="p">))):</span>
            <span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
                <span class="k">break</span>
            <span class="nb">setattr</span><span class="p">(</span><span class="n">modules</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">part</span><span class="p">,</span> <span class="n">modules</span><span class="p">[</span><span class="n">i</span><span class="p">])</span>

        <span class="c"># Return the next-most top-level module after future.backports / future.moves:</span>
        <span class="k">return</span> <span class="n">modules</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>

</div>
<div class="viewcode-block" id="from_import"><a class="viewcode-back" href="../../reference.html#future.standard_library.from_import">[docs]</a><span class="k">def</span> <span class="nf">from_import</span><span class="p">(</span><span class="n">module_name</span><span class="p">,</span> <span class="o">*</span><span class="n">symbol_names</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Example use:</span>
<span class="sd">        &gt;&gt;&gt; HTTPConnection = from_import(&#39;http.client&#39;, &#39;HTTPConnection&#39;)</span>
<span class="sd">        &gt;&gt;&gt; HTTPServer = from_import(&#39;http.server&#39;, &#39;HTTPServer&#39;)</span>
<span class="sd">        &gt;&gt;&gt; urlopen, urlparse = from_import(&#39;urllib.request&#39;, &#39;urlopen&#39;, &#39;urlparse&#39;)</span>

<span class="sd">    Equivalent to this on Py3:</span>

<span class="sd">        &gt;&gt;&gt; from module_name import symbol_names[0], symbol_names[1], ...</span>

<span class="sd">    and this on Py2:</span>

<span class="sd">        &gt;&gt;&gt; from future.moves.module_name import symbol_names[0], ...</span>

<span class="sd">    or:</span>

<span class="sd">        &gt;&gt;&gt; from future.backports.module_name import symbol_names[0], ...</span>

<span class="sd">    except that it also handles dotted module names such as ``http.client``.</span>
<span class="sd">    &quot;&quot;&quot;</span>

    <span class="k">if</span> <span class="n">PY3</span><span class="p">:</span>
        <span class="k">return</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">module_name</span><span class="p">)</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="k">if</span> <span class="s">&#39;backport&#39;</span> <span class="ow">in</span> <span class="n">kwargs</span> <span class="ow">and</span> <span class="nb">bool</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;backport&#39;</span><span class="p">]):</span>
            <span class="n">prefix</span> <span class="o">=</span> <span class="s">&#39;future.backports&#39;</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">prefix</span> <span class="o">=</span> <span class="s">&#39;future.moves&#39;</span>
        <span class="n">parts</span> <span class="o">=</span> <span class="n">prefix</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="n">module_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span>
        <span class="n">module</span> <span class="o">=</span> <span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span><span class="n">prefix</span> <span class="o">+</span> <span class="s">&#39;.&#39;</span> <span class="o">+</span> <span class="n">module_name</span><span class="p">)</span>
        <span class="n">output</span> <span class="o">=</span> <span class="p">[</span><span class="nb">getattr</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">symbol_names</span><span class="p">]</span>
        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">output</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">output</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">output</span>

</div>
<div class="viewcode-block" id="exclude_local_folder_imports"><a class="viewcode-back" href="../../reference.html#future.standard_library.exclude_local_folder_imports">[docs]</a><span class="k">class</span> <span class="nc">exclude_local_folder_imports</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    A context-manager that prevents standard library modules like configparser</span>
<span class="sd">    from being imported from the local python-future source folder on Py3.</span>

<span class="sd">    (The presence of a configparser folder would otherwise prevent setuptools</span>
<span class="sd">    from running on Py3.)</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
        <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">module_names</span> <span class="o">=</span> <span class="n">args</span>
        <span class="c"># Disallow dotted module names like http.client:</span>
        <span class="k">if</span> <span class="nb">any</span><span class="p">([</span><span class="s">&#39;.&#39;</span> <span class="ow">in</span> <span class="n">m</span> <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">module_names</span><span class="p">]):</span>
            <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">&#39;Dotted module names are not supported&#39;</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">old_sys_path</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">old_sys_modules</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">)</span>
        <span class="k">if</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">&lt;</span> <span class="mi">3</span><span class="p">:</span>
            <span class="k">return</span>
        <span class="n">FUTURE_SOURCE_SUBFOLDERS</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;future&#39;</span><span class="p">,</span> <span class="s">&#39;past&#39;</span><span class="p">,</span> <span class="s">&#39;libfuturize&#39;</span><span class="p">,</span> <span class="s">&#39;configparser&#39;</span><span class="p">]</span>

        <span class="c"># Look for the future source folder:</span>
        <span class="k">for</span> <span class="n">folder</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">old_sys_path</span><span class="p">:</span>
            <span class="k">if</span> <span class="nb">all</span><span class="p">([</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">folder</span><span class="p">,</span> <span class="n">subfolder</span><span class="p">))</span>
                    <span class="k">for</span> <span class="n">subfolder</span> <span class="ow">in</span> <span class="n">FUTURE_SOURCE_SUBFOLDERS</span><span class="p">]):</span>
                <span class="c"># Found it. Remove it.</span>
                <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">folder</span><span class="p">)</span>

        <span class="c"># Ensure we import the system module:</span>
        <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">module_names</span><span class="p">:</span>
            <span class="c"># Delete the module and any submodules from sys.modules:</span>
            <span class="c"># for key in list(sys.modules):</span>
            <span class="c">#     if key == m or key.startswith(m + &#39;.&#39;):</span>
            <span class="c">#         try:</span>
            <span class="c">#             del sys.modules[key]</span>
            <span class="c">#         except KeyError:</span>
            <span class="c">#             pass</span>
            <span class="k">try</span><span class="p">:</span>
                <span class="n">module</span> <span class="o">=</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
            <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
                <span class="c"># There&#39;s a problem importing the system module. E.g. the</span>
                <span class="c"># winreg module is not available except on Windows.</span>
                <span class="k">pass</span>

    <span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
        <span class="c"># Restore sys.path and sys.modules:</span>
        <span class="n">sys</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">old_sys_path</span>
        <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">old_sys_modules</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="o">-</span> <span class="nb">set</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
            <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">m</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">old_sys_modules</span><span class="p">[</span><span class="n">m</span><span class="p">]</span>
</div>
<span class="n">TOP_LEVEL_MODULES</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;builtins&#39;</span><span class="p">,</span>
                     <span class="s">&#39;configparser&#39;</span><span class="p">,</span>
                     <span class="s">&#39;copyreg&#39;</span><span class="p">,</span>
                     <span class="s">&#39;html&#39;</span><span class="p">,</span>
                     <span class="s">&#39;http&#39;</span><span class="p">,</span>
                     <span class="s">&#39;queue&#39;</span><span class="p">,</span>
                     <span class="s">&#39;reprlib&#39;</span><span class="p">,</span>
                     <span class="s">&#39;socketserver&#39;</span><span class="p">,</span>
                     <span class="s">&#39;test&#39;</span><span class="p">,</span>
                     <span class="s">&#39;tkinter&#39;</span><span class="p">,</span>
                     <span class="s">&#39;winreg&#39;</span><span class="p">,</span>
                     <span class="s">&#39;xmlrpc&#39;</span><span class="p">,</span>
                     <span class="s">&#39;_dummy_thread&#39;</span><span class="p">,</span>
                     <span class="s">&#39;_markupbase&#39;</span><span class="p">,</span>
                     <span class="s">&#39;_thread&#39;</span><span class="p">,</span>
                    <span class="p">]</span>

<span class="k">def</span> <span class="nf">import_top_level_modules</span><span class="p">():</span>
    <span class="k">with</span> <span class="n">exclude_local_folder_imports</span><span class="p">(</span><span class="o">*</span><span class="n">TOP_LEVEL_MODULES</span><span class="p">):</span>
        <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">TOP_LEVEL_MODULES</span><span class="p">:</span>
            <span class="k">try</span><span class="p">:</span>
                <span class="nb">__import__</span><span class="p">(</span><span class="n">m</span><span class="p">)</span>
            <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>     <span class="c"># e.g. winreg</span>
                <span class="k">pass</span>
</pre></div>

    </div>
      
  </div>
</div>

<footer class="footer">
  <div class="container">
    <p class="pull-right">
      <a href="#">Back to top</a>
      
    </p>
    <p>
        &copy; Copyright 2013-2015, Python Charmers Pty Ltd, Australia.<br/>
    </p>
  </div>
</footer>
<div class="footer">
<script type="text/javascript">
  (function() {
    var ga = document.createElement('script');
    ga.src = ('https:' == document.location.protocol ?
              'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
    ga.setAttribute('async', 'true');
    document.documentElement.firstChild.appendChild(ga);
  })();
</script>
</div>

  </body>
</html>