Edit File: modulefinder.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>30.5. modulefinder — Find modules used by a script — Python v2.6.6 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.6.6', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python v2.6.6 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python v2.6.6 documentation" href="../index.html" /> <link rel="up" title="30. Importing Modules" href="modules.html" /> <link rel="next" title="30.6. runpy — Locating and executing Python modules" href="runpy.html" /> <link rel="prev" title="30.4. pkgutil — Package extension utility" href="pkgutil.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li> <li class="right" > <a href="runpy.html" title="30.6. runpy — Locating and executing Python modules" accesskey="N">next</a> |</li> <li class="right" > <a href="pkgutil.html" title="30.4. pkgutil — Package extension utility" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.6.6 documentation</a> »</li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="modules.html" accesskey="U">30. Importing Modules</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-modulefinder"> <h1>30.5. <tt class="xref docutils literal"><span class="pre">modulefinder</span></tt> — Find modules used by a script<a class="headerlink" href="#module-modulefinder" title="Permalink to this headline">¶</a></h1> <p class="versionadded"> <span class="versionmodified">New in version 2.3.</span></p> <p>This module provides a <a title="modulefinder.ModuleFinder" class="reference internal" href="#modulefinder.ModuleFinder"><tt class="xref docutils literal"><span class="pre">ModuleFinder</span></tt></a> class that can be used to determine the set of modules imported by a script. <tt class="docutils literal"><span class="pre">modulefinder.py</span></tt> can also be run as a script, giving the filename of a Python script as its argument, after which a report of the imported modules will be printed.</p> <dl class="function"> <dt id="modulefinder.AddPackagePath"> <tt class="descclassname">modulefinder.</tt><tt class="descname">AddPackagePath</tt><big>(</big><em>pkg_name</em>, <em>path</em><big>)</big><a class="headerlink" href="#modulefinder.AddPackagePath" title="Permalink to this definition">¶</a></dt> <dd>Record that the package named <em>pkg_name</em> can be found in the specified <em>path</em>.</dd></dl> <dl class="function"> <dt id="modulefinder.ReplacePackage"> <tt class="descclassname">modulefinder.</tt><tt class="descname">ReplacePackage</tt><big>(</big><em>oldname</em>, <em>newname</em><big>)</big><a class="headerlink" href="#modulefinder.ReplacePackage" title="Permalink to this definition">¶</a></dt> <dd>Allows specifying that the module named <em>oldname</em> is in fact the package named <em>newname</em>. The most common usage would be to handle how the <tt class="xref docutils literal"><span class="pre">_xmlplus</span></tt> package replaces the <tt class="xref docutils literal"><span class="pre">xml</span></tt> package.</dd></dl> <dl class="class"> <dt id="modulefinder.ModuleFinder"> <em class="property">class </em><tt class="descclassname">modulefinder.</tt><tt class="descname">ModuleFinder</tt><big>(</big><span class="optional">[</span><em>path=None</em>, <em>debug=0</em>, <em>excludes=</em><span class="optional">[</span><span class="optional">]</span>, <em>replace_paths=</em><span class="optional">[</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#modulefinder.ModuleFinder" title="Permalink to this definition">¶</a></dt> <dd><p>This class provides <a title="modulefinder.ModuleFinder.run_script" class="reference internal" href="#modulefinder.ModuleFinder.run_script"><tt class="xref docutils literal"><span class="pre">run_script()</span></tt></a> and <a title="modulefinder.ModuleFinder.report" class="reference internal" href="#modulefinder.ModuleFinder.report"><tt class="xref docutils literal"><span class="pre">report()</span></tt></a> methods to determine the set of modules imported by a script. <em>path</em> can be a list of directories to search for modules; if not specified, <tt class="docutils literal"><span class="pre">sys.path</span></tt> is used. <em>debug</em> sets the debugging level; higher values make the class print debugging messages about what it’s doing. <em>excludes</em> is a list of module names to exclude from the analysis. <em>replace_paths</em> is a list of <tt class="docutils literal"><span class="pre">(oldpath,</span> <span class="pre">newpath)</span></tt> tuples that will be replaced in module paths.</p> <dl class="method"> <dt id="modulefinder.ModuleFinder.report"> <tt class="descname">report</tt><big>(</big><big>)</big><a class="headerlink" href="#modulefinder.ModuleFinder.report" title="Permalink to this definition">¶</a></dt> <dd>Print a report to standard output that lists the modules imported by the script and their paths, as well as modules that are missing or seem to be missing.</dd></dl> <dl class="method"> <dt id="modulefinder.ModuleFinder.run_script"> <tt class="descname">run_script</tt><big>(</big><em>pathname</em><big>)</big><a class="headerlink" href="#modulefinder.ModuleFinder.run_script" title="Permalink to this definition">¶</a></dt> <dd>Analyze the contents of the <em>pathname</em> file, which must contain Python code.</dd></dl> <dl class="attribute"> <dt id="modulefinder.ModuleFinder.modules"> <tt class="descname">modules</tt><a class="headerlink" href="#modulefinder.ModuleFinder.modules" title="Permalink to this definition">¶</a></dt> <dd>A dictionary mapping module names to modules. See <a class="reference internal" href="#modulefinder-example"><em>Example usage of ModuleFinder</em></a></dd></dl> </dd></dl> <div class="section" id="example-usage-of-modulefinder"> <span id="modulefinder-example"></span><h2>30.5.1. Example usage of <a title="modulefinder.ModuleFinder" class="reference internal" href="#modulefinder.ModuleFinder"><tt class="xref docutils literal"><span class="pre">ModuleFinder</span></tt></a><a class="headerlink" href="#example-usage-of-modulefinder" title="Permalink to this headline">¶</a></h2> <p>The script that is going to get analyzed later on (bacon.py):</p> <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">re</span><span class="o">,</span> <span class="nn">itertools</span> <span class="k">try</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">baconhameggs</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">import</span> <span class="nn">guido.python.ham</span> <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> <span class="k">pass</span> </pre></div> </div> <p>The script that will output the report of bacon.py:</p> <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">modulefinder</span> <span class="kn">import</span> <span class="n">ModuleFinder</span> <span class="n">finder</span> <span class="o">=</span> <span class="n">ModuleFinder</span><span class="p">()</span> <span class="n">finder</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="s">'bacon.py'</span><span class="p">)</span> <span class="k">print</span> <span class="s">'Loaded modules:'</span> <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">mod</span> <span class="ow">in</span> <span class="n">finder</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span> <span class="k">print</span> <span class="s">'</span><span class="si">%s</span><span class="s">: '</span> <span class="o">%</span> <span class="n">name</span><span class="p">,</span> <span class="k">print</span> <span class="s">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mod</span><span class="o">.</span><span class="n">globalnames</span><span class="o">.</span><span class="n">keys</span><span class="p">()[:</span><span class="mi">3</span><span class="p">])</span> <span class="k">print</span> <span class="s">'-'</span><span class="o">*</span><span class="mi">50</span> <span class="k">print</span> <span class="s">'Modules not imported:'</span> <span class="k">print</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">finder</span><span class="o">.</span><span class="n">badmodules</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">())</span> </pre></div> </div> <p>Sample output (may vary depending on the architecture):</p> <div class="highlight-python"><pre>Loaded modules: _types: copy_reg: _inverted_registry,_slotnames,__all__ sre_compile: isstring,_sre,_optimize_unicode _sre: sre_constants: REPEAT_ONE,makedict,AT_END_LINE sys: re: __module__,finditer,_expand itertools: __main__: re,itertools,baconhameggs sre_parse: __getslice__,_PATTERNENDERS,SRE_FLAG_UNICODE array: types: __module__,IntType,TypeType --------------------------------------------------- Modules not imported: guido.python.ham baconhameggs</pre> </div> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference external" href="#">30.5. <tt class="docutils literal"><span class="pre">modulefinder</span></tt> — Find modules used by a script</a><ul> <li><a class="reference external" href="#example-usage-of-modulefinder">30.5.1. Example usage of <tt class="docutils literal"><span class="pre">ModuleFinder</span></tt></a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="pkgutil.html" title="previous chapter">30.4. <tt class="docutils literal"><span class="pre">pkgutil</span></tt> — Package extension utility</a></p> <h4>Next topic</h4> <p class="topless"><a href="runpy.html" title="next chapter">30.6. <tt class="docutils literal docutils literal"><span class="pre">runpy</span></tt> — Locating and executing Python modules</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/library/modulefinder.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" size="18" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../modindex.html" title="Global Module Index" >modules</a> |</li> <li class="right" > <a href="runpy.html" title="30.6. runpy — Locating and executing Python modules" >next</a> |</li> <li class="right" > <a href="pkgutil.html" title="30.4. pkgutil — Package extension utility" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.6.6 documentation</a> »</li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="modules.html" >30. Importing Modules</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2011, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Jul 20, 2011. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6. </div> </body> </html>
Back to File Manager