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 logging
  29 import modulefinder
  30
  31 LOG = logging.getLogger('py2depgraph')
  32 LOG.setLevel(logging.DEBUG)
  33 _STREAM_HANDLER = logging.StreamHandler()
  34 _STREAM_HANDLER.setLevel(logging.CRITICAL)
  35 _STREAM_HANDLER.setFormatter(
  36     logging.Formatter('%(levelname)s - %(message)s'))
  37 LOG.addHandler(_STREAM_HANDLER)
  38
  39
  40 class mymf(modulefinder.ModuleFinder):
  41     def __init__(self,*args,**kwargs):
  42         self._depgraph = {}
  43         self._types = {}
  44         self._paths = {}
  45         self._last_caller = None
  46         modulefinder.ModuleFinder.__init__(self,*args,**kwargs)
  47
  48     def import_hook(self, name, caller=None, fromlist=None, level=-1):
  49         old_last_caller = self._last_caller
  50         try:
  51             self._last_caller = caller
  52             return modulefinder.ModuleFinder.import_hook(self,name,caller,fromlist, level)
  53         finally:
  54             self._last_caller = old_last_caller
  55         LOG.debug('after import_hook(%s, %s, %s, %s), last_caller is %s'
  56                   % (name, caller, fromlist, level, self._last_caller))
  57
  58     def import_module(self,partnam,fqname,parent):
  59         r = modulefinder.ModuleFinder.import_module(self,partnam,fqname,parent)
  60         if None not in [r, self._last_caller]:
  61             self._depgraph.setdefault(self._last_caller.__name__,{})[r.__name__] = 1
  62         return r
  63
  64     def load_module(self, fqname, fp, pathname, (suffix, mode, type)):
  65         r = modulefinder.ModuleFinder.load_module(self, fqname, fp, pathname, (suffix, mode, type))
  66         if r is not None:
  67             self._types[r.__name__] = type
  68             self._paths[r.__name__] = pathname
  69         return r
  70
  71
  72 if __name__=='__main__':
  73     from optparse import OptionParser
  74     from pprint import pprint
  75     import sys
  76
  77     usage = '%prog [options] path/to/script.py'
  78     p = OptionParser(usage=usage, description=__doc__)
  79     p.add_option('-v', '--verbose', default=0, action='count',
  80                  help='Increment verbosity.')
  81
  82     options,args = p.parse_args()
  83
  84     log_level = logging.CRITICAL - 10*options.verbose
  85     _STREAM_HANDLER.setLevel(log_level)
  86
  87     script = args[0]
  88
  89     debug = options.verbose
  90     debug = 0
  91     mf = mymf(path=sys.path[:], debug=debug, excludes=[])
  92     mf.run_script(script)
  93     pprint({'depgraph':mf._depgraph,'types':mf._types,'paths':mf._paths})