py2depgraph.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright 2004      Toby Dickenson
   4 # Copyright 2008-2011 W. Trevor King
   5 #
   6 # Permission is hereby granted, free of charge, to any person obtaining
   7 # a copy of this software and associated documentation files (the
   8 # "Software"), to deal in the Software without restriction, including
   9 # without limitation the rights to use, copy, modify, merge, publish,
  10 # distribute, sublicense, and/or sell copies of the Software, and to
  11 # permit persons to whom the Software is furnished to do so, subject
  12 # to the following conditions:
  13 #
  14 # The above copyright notice and this permission notice shall be included
  15 # in all copies or substantial portions of the Software.
  16 #
  17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  20 # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  21 # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  22 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  23 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24
  25 """Extract a tree of module imports from a Python script.
  26 """
  27
  28 import modulefinder
  29
  30 class mymf(modulefinder.ModuleFinder):
  31     def __init__(self,*args,**kwargs):
  32         self._depgraph = {}
  33         self._types = {}
  34         self._paths = {}
  35         self._last_caller = None
  36         modulefinder.ModuleFinder.__init__(self,*args,**kwargs)
  37
  38     def import_hook(self, name, caller=None, fromlist=None, level=-1):
  39         old_last_caller = self._last_caller
  40         try:
  41             self._last_caller = caller
  42             return modulefinder.ModuleFinder.import_hook(self,name,caller,fromlist, level)
  43         finally:
  44             self._last_caller = old_last_caller
  45
  46     def import_module(self,partnam,fqname,parent):
  47         r = modulefinder.ModuleFinder.import_module(self,partnam,fqname,parent)
  48         if r is not None:
  49             self._depgraph.setdefault(self._last_caller.__name__,{})[r.__name__] = 1
  50         return r
  51
  52     def load_module(self, fqname, fp, pathname, (suffix, mode, type)):
  53         r = modulefinder.ModuleFinder.load_module(self, fqname, fp, pathname, (suffix, mode, type))
  54         if r is not None:
  55             self._types[r.__name__] = type
  56             self._paths[r.__name__] = pathname
  57         return r
  58
  59
  60 if __name__=='__main__':
  61     from optparse import OptionParser
  62     from pprint import pprint
  63     import sys
  64
  65     usage = '%prog [options] path/to/script.py'
  66     p = OptionParser(usage=usage, description=__doc__)
  67     p.add_option('-v', '--verbose', default=0, action='count',
  68                  help='Increment verbosity.')
  69
  70     options,args = p.parse_args()
  71
  72     script = args[0]
  73
  74     mf = mymf(path=sys.path[:], debug=options.verbose, excludes=[])
  75     mf.run_script(script)
  76     pprint({'depgraph':mf._depgraph,'types':mf._types,'paths':mf._paths})