pdeps.py

#! /usr/bin/env python

# pdeps
#
# Find dependencies between a bunch of Python modules.
#
# Usage:
# pdeps file1.py file2.py ...
#
# Output:
# Four tables separated by lines like '--- Closure ---':
# 1) Direct dependencies, listing which module imports which other modules
# 2) The inverse of (1)
# 3) Indirect dependencies, or the closure of the above
# 4) The inverse of (3)
#
# To do:
# - command line options to select output type
# - option to automatically scan the Python library for referenced modules
# - option to limit output to particular modules


importsys
importre
importos


# Main program
#
defmain():
args=sys.argv[1:]
ifnotargs:
print'usage: pdeps file.py file.py ...'
return2
#
table= {}
forarginargs:
process(arg, table)
#
print'--- Uses ---'
printresults(table)
#
print'--- Used By ---'
inv=inverse(table)
printresults(inv)
#
print'--- Closure of Uses ---'
reach=closure(table)
printresults(reach)
#
print'--- Closure of Used By ---'
invreach=inverse(reach)
printresults(invreach)
#
return0


# Compiled regular expressions to search for import statements
#
m_import=re.compile('^[ \t]*from[ \t]+([^ \t]+)[ \t]+')
m_from=re.compile('^[ \t]*import[ \t]+([^#]+)')


# Collect data from one file
#
defprocess(filename, table):
fp=open(filename, 'r')
mod=os.path.basename(filename)
ifmod[-3:] =='.py':
mod=mod[:-3]
table[mod] =list= []
while1:
line=fp.readline()
ifnotline: break
whileline[-1:] =='\\':
nextline=fp.readline()
ifnotnextline: break
line=line[:-1] +nextline
ifm_import.match(line) >=0:
 (a, b), (a1, b1) =m_import.regs[:2]
elifm_from.match(line) >=0:
 (a, b), (a1, b1) =m_from.regs[:2]
else: continue
words=line[a1:b1].split(',')
# print '#', line, words
forwordinwords:
word=word.strip()
ifwordnotinlist:
list.append(word)


# Compute closure (this is in fact totally general)
#
defclosure(table):
modules=table.keys()
#
# Initialize reach with a copy of table
#
reach= {}
formodinmodules:
reach[mod] =table[mod][:]
#
# Iterate until no more change
#
change=1
whilechange:
change=0
formodinmodules:
formoinreach[mod]:
ifmoinmodules:
forminreach[mo]:
ifmnotinreach[mod]:
reach[mod].append(m)
change=1
#
returnreach


# Invert a table (this is again totally general).
# All keys of the original table are made keys of the inverse,
# so there may be empty lists in the inverse.
#
definverse(table):
inv= {}
forkeyintable.keys():
ifnotinv.has_key(key):
inv[key] = []
foritemintable[key]:
store(inv, item, key)
returninv


# Store "item" in "dict" under "key".
# The dictionary maps keys to lists of items.
# If there is no list for the key yet, it is created.
#
defstore(dict, key, item):
ifdict.has_key(key):
dict[key].append(item)
else:
dict[key] = [item]


# Tabulate results neatly
#
defprintresults(table):
modules=table.keys()
maxlen=0
formodinmodules: maxlen=max(maxlen, len(mod))
modules.sort()
formodinmodules:
list=table[mod]
list.sort()
printmod.ljust(maxlen), ':',
ifmodinlist:
print'(*)',
forrefinlist:
printref,
print


# Call main and honor exit status
if__name__=='__main__':
try:
sys.exit(main())
exceptKeyboardInterrupt:
sys.exit(1)