Example - decompose.py - Revision history

PeterHarding at 06:53, 4 June 2012

2012-06-04T06:53:23Z

@@ Line 157: / Line 157: @@
     describe(mod)
 </pre>
 [[Category:Python]]

PeterHarding at 06:50, 4 June 2012

2012-06-04T06:50:38Z

← Older revision		Revision as of 16:50, 4 June 2012
Line 1:		Line 1:
	=Python Script to Decompose Module/Class Components=		=Python Script to Decompose Module/Class Components=

	~~ActiveState recipe 553262 -~~ [http://code.activestate.com/recipes/553262-list-classes-methods-and-functions-in-a-module/]		[http://code.activestate.com/recipes/553262-list-classes-methods-and-functions-in-a-module/ ActiveState recipe 553262]

PeterHarding at 06:50, 4 June 2012

2012-06-04T06:50:11Z

← Older revision		Revision as of 16:50, 4 June 2012
Line 1:		Line 1:
	=Python Script to Decompose Module/Class Components=		=Python Script to Decompose Module/Class Components=

	ActiveState recipe 553262 - http://~~www~~.activestate.com/~~recipe~~-~~553262~~-1]		ActiveState recipe 553262 - [http://code.activestate.com/recipes/553262-list-classes-methods-and-functions-in-a-module/]

PeterHarding: Created page with "=Python Script to Decompose Module/Class Components= ActiveState recipe 553262 - http://www.activestate.com/recipe-553262-1]

 #!/usr/bin/env python # Describe classes,..."

2012-06-04T06:48:56Z

Created page with "=Python Script to Decompose Module/Class Components= ActiveState recipe 553262 - http://www.activestate.com/recipe-553262-1] <pre> #!/usr/bin/env python # Describe classes,..."

New page

=Python Script to Decompose Module/Class Components=

ActiveState recipe 553262 - http://www.activestate.com/recipe-553262-1]

<pre>
#!/usr/bin/env python
# Describe classes, methods and functions in a module.
# Works with user-defined modules, all Python library
# modules, including built-in modules.
#
# recipe-553262-1
#

import inspect
import os, sys

INDENT=0

def wi(*args):
""" Function to print lines indented according to level """

if INDENT: print ' '*INDENT,
for arg in args: print arg,
print

def indent():
""" Increase indentation """

global INDENT
INDENT += 4

def dedent():
""" Decrease indentation """

global INDENT
INDENT -= 4

def describe_builtin(obj):
""" Describe a builtin function """

wi('+Built-in Function: %s' % obj.__name__)
# Built-in functions cannot be inspected by
# inspect.getargspec. We have to try and parse
# the __doc__ attribute of the function.
docstr = obj.__doc__
args = ''

if docstr:
items = docstr.split('\n')
if items:
func_descr = items[0]
s = func_descr.replace(obj.__name__,'')
idx1 = s.find('(')
idx2 = s.find(')',idx1)
if idx1 != -1 and idx2 != -1 and (idx2>idx1+1):
args = s[idx1+1:idx2]
wi('\t-Method Arguments:', args)

if args=='':
wi('\t-Method Arguments: None')

print

def describe_func(obj, method=False):
""" Describe the function object passed as argument.
If this is a method object, the second argument will
be passed as True """

if method:
wi('+Method: %s' % obj.__name__)
else:
wi('+Function: %s' % obj.__name__)

try:
arginfo = inspect.getargspec(obj)
except TypeError:
print
return

args = arginfo[0]
argsvar = arginfo[1]

if args:
if args[0] == 'self':
wi('\t%s is an instance method' % obj.__name__)
args.pop(0)

wi('\t-Method Arguments:', args)

if arginfo[3]:
dl = len(arginfo[3])
al = len(args)
defargs = args[al-dl:al]
wi('\t--Default arguments:',zip(defargs, arginfo[3]))

if arginfo[1]:
wi('\t-Positional Args Param: %s' % arginfo[1])
if arginfo[2]:
wi('\t-Keyword Args Param: %s' % arginfo[2])

print

def describe_klass(obj):
""" Describe the class object passed as argument,
including its methods """

wi('+Class: %s' % obj.__name__)

indent()

count = 0

for name in obj.__dict__:
item = getattr(obj, name)
if inspect.ismethod(item):
count += 1;describe_func(item, True)

if count==0:
wi('(No members)')

dedent()
print

def describe(module):
""" Describe the module object passed as argument
including its classes and functions """

wi('[Module: %s]\n' % module.__name__)

indent()

count = 0

for name in dir(module):
obj = getattr(module, name)
if inspect.isclass(obj):
count += 1; describe_klass(obj)
elif (inspect.ismethod(obj) or inspect.isfunction(obj)):
count +=1 ; describe_func(obj)
elif inspect.isbuiltin(obj):
count += 1; describe_builtin(obj)

if count==0:
wi('(No members)')

dedent()

if __name__ == "__main__":
import sys

if len(sys.argv)<2:
sys.exit('Usage: %s <module>' % sys.argv[0])

module = sys.argv[1].replace('.py','')
mod = __import__(module)
describe(mod)
</pre>

[[Category:Python]]