31.6. modulefinder — Find modules used by a script

New in version 2.3.

Source code: Lib/modulefinder.py

This module provides a ModuleFinder class that can be used to determine the set of modules imported by a script. modulefinder.py 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.

modulefinder.AddPackagePath(pkg_name, path)

Record that the package named pkg_name can be found in the specified path.

modulefinder.ReplacePackage(oldname, newname)

Allows specifying that the module named oldname is in fact the package named newname. The most common usage would be to handle how the _xmlplus package replaces the xml package.

class modulefinder.ModuleFinder([path=None, debug=0, excludes=[], replace_paths=[]])

This class provides run_script() and report() methods to determine the set of modules imported by a script. path can be a list of directories to search for modules; if not specified, sys.path is used. debug sets the debugging level; higher values make the class print debugging messages about what it’s doing. excludes is a list of module names to exclude from the analysis. replace_paths is a list of (oldpath, newpath) tuples that will be replaced in module paths.


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.


Analyze the contents of the pathname file, which must contain Python code.


A dictionary mapping module names to modules. See Example usage of ModuleFinder

31.6.1. Example usage of ModuleFinder

The script that is going to get analyzed later on (bacon.py):

import re, itertools

    import baconhameggs
except ImportError:

    import guido.python.ham
except ImportError:

The script that will output the report of bacon.py:

from modulefinder import ModuleFinder

finder = ModuleFinder()

print 'Loaded modules:'
for name, mod in finder.modules.iteritems():
    print '%s: ' % name,
    print ','.join(mod.globalnames.keys()[:3])

print '-'*50
print 'Modules not imported:'
print '\n'.join(finder.badmodules.iterkeys())

Sample output (may vary depending on the architecture):

Loaded modules:
copy_reg:  _inverted_registry,_slotnames,__all__
sre_compile:  isstring,_sre,_optimize_unicode
sre_constants:  REPEAT_ONE,makedict,AT_END_LINE
re:  __module__,finditer,_expand
__main__:  re,itertools,baconhameggs
sre_parse:  __getslice__,_PATTERNENDERS,SRE_FLAG_UNICODE
types:  __module__,IntType,TypeType
Modules not imported: