0x1949 Team - FAZEMRX - MANAGER

Edit File: imputil.html

<!DOCTYPE html>

<title>31.3. imputil — Import utilities &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="31.4. zipimport — Import modules from Zip archives" href="zipimport.html" />
 <link rel="prev" title="31.2. importlib — Convenience wrappers for __import__()" href="importlib.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/imputil.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/imputil.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="zipimport.html" title="31.4. zipimport — Import modules from Zip archives"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="importlib.html" title="31.2. importlib — Convenience wrappers for __import__()"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="modules.html" accesskey="U">31. Importing Modules</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">31.3. <code class="xref py py-mod docutils literal notranslate">imputil</code> — Import utilities</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-imputil">
<h1>31.3. <a class="reference internal" href="#module-imputil" title="imputil: Manage and augment the import process. (deprecated)"><code class="xref py py-mod docutils literal notranslate">imputil</code></a> — Import utilities<a class="headerlink" href="#module-imputil" title="Permalink to this headline">¶</a></h1>
<div class="deprecated">
Deprecated since version 2.6: The <a class="reference internal" href="#module-imputil" title="imputil: Manage and augment the import process. (deprecated)"><code class="xref py py-mod docutils literal notranslate">imputil</code></a> module has been removed in Python 3.
</div>
This module provides a very handy and useful mechanism for custom
<a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> hooks. Compared to the older <code class="xref py py-mod docutils literal notranslate">ihooks</code> module,
<a class="reference internal" href="#module-imputil" title="imputil: Manage and augment the import process. (deprecated)"><code class="xref py py-mod docutils literal notranslate">imputil</code></a> takes a dramatically simpler and more straight-forward
approach to custom <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> functions.
<dl class="py class">
<dt class="sig sig-object py" id="imputil.ImportManager">
class imputil.ImportManager([fs_imp])<a class="headerlink" href="#imputil.ImportManager" title="Permalink to this definition">¶</a></dt>
<dd>Manage the import process.
<dl class="py method">
<dt class="sig sig-object py" id="imputil.ImportManager.install">
install([namespace])<a class="headerlink" href="#imputil.ImportManager.install" title="Permalink to this definition">¶</a></dt>
<dd>Install this ImportManager into the specified namespace.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="imputil.ImportManager.uninstall">
uninstall()<a class="headerlink" href="#imputil.ImportManager.uninstall" title="Permalink to this definition">¶</a></dt>
<dd>Restore the previous import mechanism.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="imputil.ImportManager.add_suffix">
add_suffix(suffix, importFunc)<a class="headerlink" href="#imputil.ImportManager.add_suffix" title="Permalink to this definition">¶</a></dt>
<dd>Undocumented.
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="imputil.Importer">
class imputil.Importer<a class="headerlink" href="#imputil.Importer" title="Permalink to this definition">¶</a></dt>
<dd>Base class for replacing standard import functions.
<dl class="py method">
<dt class="sig sig-object py" id="imputil.Importer.import_top">
import_top(name)<a class="headerlink" href="#imputil.Importer.import_top" title="Permalink to this definition">¶</a></dt>
<dd>Import a top-level module.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="imputil.Importer.get_code">
get_code(parent, modname, fqname)<a class="headerlink" href="#imputil.Importer.get_code" title="Permalink to this definition">¶</a></dt>
<dd>Find and retrieve the code for the given module.
parent specifies a parent module to define a context for importing.
It may be <code class="docutils literal notranslate">None</code>, indicating no particular context for the search.
modname specifies a single module (not dotted) within the parent.
fqname specifies the fully-qualified module name. This is a
(potentially) dotted name from the “root” of the module namespace
down to the modname.
If there is no parent, then modname==fqname.
This method should return <code class="docutils literal notranslate">None</code>, or a 3-tuple.
<blockquote>
<div><ul class="simple">
<li>If the module was not found, then <code class="docutils literal notranslate">None</code> should be returned.</li>
<li>The first item of the 2- or 3-tuple should be the integer 0 or 1,
specifying whether the module that was found is a package or not.</li>
<li>The second item is the code object for the module (it will be
executed within the new module’s namespace). This item can also
be a fully-loaded module object (e.g. loaded from a shared lib).</li>
<li>The third item is a dictionary of name/value pairs that will be
inserted into new module before the code object is executed. This
is provided in case the module’s code expects certain values (such
as where the module was found). When the second item is a module
object, then these names/values will be inserted after the module
has been loaded/initialized.</li>
</ul>
</div></blockquote>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="imputil.BuiltinImporter">
class imputil.BuiltinImporter<a class="headerlink" href="#imputil.BuiltinImporter" title="Permalink to this definition">¶</a></dt>
<dd>Emulate the import mechanism for built-in and frozen modules. This is a
sub-class of the <a class="reference internal" href="#imputil.Importer" title="imputil.Importer"><code class="xref py py-class docutils literal notranslate">Importer</code></a> class.
<dl class="py method">
<dt class="sig sig-object py" id="imputil.BuiltinImporter.get_code">
get_code(parent, modname, fqname)<a class="headerlink" href="#imputil.BuiltinImporter.get_code" title="Permalink to this definition">¶</a></dt>
<dd>Undocumented.
</dd></dl>

</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="imputil.py_suffix_importer">
imputil.py_suffix_importer(filename, finfo, fqname)<a class="headerlink" href="#imputil.py_suffix_importer" title="Permalink to this definition">¶</a></dt>
<dd>Undocumented.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="imputil.DynLoadSuffixImporter">
class imputil.DynLoadSuffixImporter([desc])<a class="headerlink" href="#imputil.DynLoadSuffixImporter" title="Permalink to this definition">¶</a></dt>
<dd>Undocumented.
<dl class="py method">
<dt class="sig sig-object py" id="imputil.DynLoadSuffixImporter.import_file">
import_file(filename, finfo, fqname)<a class="headerlink" href="#imputil.DynLoadSuffixImporter.import_file" title="Permalink to this definition">¶</a></dt>
<dd>Undocumented.
</dd></dl>

</dd></dl>

<section id="examples">
<h2>31.3.1. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
This is a re-implementation of hierarchical module import.
This code is intended to be read, not executed. However, it does work
– all you need to do to enable it is “import knee”.
(The name is a pun on the clunkier predecessor of this module, “ni”.)
<div class="highlight-default notranslate"><div class="highlight"><pre>import sys, imp, __builtin__

# Replacement for __import__()
def import_hook(name, globals=None, locals=None, fromlist=None):
 parent = determine_parent(globals)
 q, tail = find_head_package(parent, name)
 m = load_tail(q, tail)
 if not fromlist:
 return q
 if hasattr(m, &quot;__path__&quot;):
 ensure_fromlist(m, fromlist)
 return m

def determine_parent(globals):
 if not globals or not globals.has_key(&quot;__name__&quot;):
 return None
 pname = globals[&#39;__name__&#39;]
 if globals.has_key(&quot;__path__&quot;):
 parent = sys.modules[pname]
 assert globals is parent.__dict__
 return parent
 if &#39;.&#39; in pname:
 i = pname.rfind(&#39;.&#39;)
 pname = pname[:i]
 parent = sys.modules[pname]
 assert parent.__name__ == pname
 return parent
 return None

def find_head_package(parent, name):
 if &#39;.&#39; in name:
 i = name.find(&#39;.&#39;)
 head = name[:i]
 tail = name[i+1:]
 else:
 head = name
 tail = &quot;&quot;
 if parent:
 qname = &quot;%s.%s&quot; % (parent.__name__, head)
 else:
 qname = head
 q = import_module(head, qname, parent)
 if q: return q, tail
 if parent:
 qname = head
 parent = None
 q = import_module(head, qname, parent)
 if q: return q, tail
 raise ImportError(&quot;No module named &quot; + qname)

def load_tail(q, tail):
 m = q
 while tail:
 i = tail.find(&#39;.&#39;)
 if i &lt; 0: i = len(tail)
 head, tail = tail[:i], tail[i+1:]
 mname = &quot;%s.%s&quot; % (m.__name__, head)
 m = import_module(head, mname, m)
 if not m:
 raise ImportError(&quot;No module named &quot; + mname)
 return m

def ensure_fromlist(m, fromlist, recursive=0):
 for sub in fromlist:
 if sub == &quot;*&quot;:
 if not recursive:
 try:
 all = m.__all__
 except AttributeError:
 pass
 else:
 ensure_fromlist(m, all, 1)
 continue
 if sub != &quot;*&quot; and not hasattr(m, sub):
 subname = &quot;%s.%s&quot; % (m.__name__, sub)
 submod = import_module(sub, subname, m)
 if not submod:
 raise ImportError(&quot;No module named &quot; + subname)

def import_module(partname, fqname, parent):
 try:
 return sys.modules[fqname]
 except KeyError:
 pass
 try:
 fp, pathname, stuff = imp.find_module(partname,
 parent and parent.__path__)
 except ImportError:
 return None
 try:
 m = imp.load_module(fqname, fp, pathname, stuff)
 finally:
 if fp: fp.close()
 if parent:
 setattr(parent, partname, m)
 return m

# Replacement for reload()
def reload_hook(module):
 name = module.__name__
 if &#39;.&#39; not in name:
 return import_module(name, name, None)
 i = name.rfind(&#39;.&#39;)
 pname = name[:i]
 parent = sys.modules[pname]
 return import_module(name[i+1:], name, parent)

# Save the original hooks
original_import = __builtin__.__import__
original_reload = __builtin__.reload

# Now install our hooks
__builtin__.__import__ = import_hook
__builtin__.reload = reload_hook
</pre></div>
</div>
Also see the <code class="xref py py-mod docutils literal notranslate">importers</code> module (which can be found
in <code class="file docutils literal notranslate">Demo/imputil/</code> in the Python source distribution) for additional
examples.
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">31.3. <code class="xref py py-mod docutils literal notranslate">imputil</code> — Import utilities</a><ul>
<li><a class="reference internal" href="#examples">31.3.1. Examples</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="importlib.html"
 title="previous chapter">31.2. <code class="xref py py-mod docutils literal notranslate">importlib</code> — Convenience wrappers for <code class="xref py py-func docutils literal notranslate">__import__()</code></a>
 <h4>Next topic</h4>
 <a href="zipimport.html"
 title="next chapter">31.4. <code class="xref py py-mod docutils literal notranslate">zipimport</code> — Import modules from Zip archives</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/imputil.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="zipimport.html" title="31.4. zipimport — Import modules from Zip archives"
 >next</a> |</li>
 <li class="right" >
 <a href="importlib.html" title="31.2. importlib — Convenience wrappers for __import__()"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="modules.html" >31. Importing Modules</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">31.3. <code class="xref py py-mod docutils literal notranslate">imputil</code> — Import utilities</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on November 21, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>