inspect Namespace Reference

Data Structures
class	ListReader
class	EndOfBlock
class	BlockFinder

Functions
def	ismodule
def	isclass
def	ismethod
def	ismethoddescriptor
def	isfunction
def	istraceback
def	isframe
def	iscode
def	isbuiltin
def	isroutine
def	getmembers
def	classify_class_attrs
def	getmro
def	indentsize
def	getdoc
def	getfile
def	getmoduleinfo
def	getmodulename
def	getsourcefile
def	getabsfile
def	getmodule
def	findsource
def	getcomments
def	getblock
def	getsourcelines
def	getsource
def	walktree
def	getclasstree
def	getargs
def	getargspec
def	getargvalues
def	joinseq
def	strseq
def	formatargspec
def	formatargvalues
def	getframeinfo
def	getlineno
def	getouterframes
def	getinnerframes
def	currentframe
def	stack
def	trace

Variables
string	__author__ = 'Ka-Ping Yee <ping@lfw.org>'
string	__date__ = '1 Jan 2001'
dictionary	modulesbyfile = {}

Detailed Description

Get useful information from live Python objects.

This module encapsulates the interface provided by the internal special
attributes (func_*, co_*, im_*, tb_*, etc.) in a friendlier fashion.
It also provides some help for examining source code and class layout.

Here are some of the useful functions provided by this module:

    ismodule(), isclass(), ismethod(), isfunction(), istraceback(),
        isframe(), iscode(), isbuiltin(), isroutine() - check object types
    getmembers() - get members of an object that satisfy a given condition

    getfile(), getsourcefile(), getsource() - find an object's source code
    getdoc(), getcomments() - get documentation on an object
    getmodule() - determine the module that an object came from
    getclasstree() - arrange classes so as to represent their hierarchy

    getargspec(), getargvalues() - get info about function arguments
    formatargspec(), formatargvalues() - format an argument spec
    getouterframes(), getinnerframes() - get info about frames
    currentframe() - get the current stack frame
    stack(), trace() - get info about frames on the stack or in a traceback

Function Documentation

def inspect.classify_class_attrs

(

cls)

Return list of attribute-descriptor tuples.

For each name in dir(cls), the return list contains a 4-tuple
with these elements:

    0. The name (a string).

    1. The kind of attribute this is, one of these strings:
           'class method'    created via classmethod()
           'static method'   created via staticmethod()
           'property'        created via property()
           'method'          any other flavor of method
           'data'            not a method

    2. The class which defined this attribute (a class).

    3. The object as obtained directly from the defining class's
       __dict__, not via getattr.  This is especially important for
       data attributes:  C.data is just a data object, but
       C.__dict__['data'] may be a data descriptor with additional
       info, like a __doc__ string.

Definition at line 166 of file inspect.py.

References sre_parse.dir, getmro(), ismethod(), and ismethoddescriptor().

def classify_class_attrs(cls):
    """Return list of attribute-descriptor tuples.

    For each name in dir(cls), the return list contains a 4-tuple
    with these elements:

        0. The name (a string).

        1. The kind of attribute this is, one of these strings:
               'class method'    created via classmethod()
               'static method'   created via staticmethod()
               'property'        created via property()
               'method'          any other flavor of method
               'data'            not a method

        2. The class which defined this attribute (a class).

        3. The object as obtained directly from the defining class's
           __dict__, not via getattr.  This is especially important for
           data attributes:  C.data is just a data object, but
           C.__dict__['data'] may be a data descriptor with additional
           info, like a __doc__ string.
    """

    mro = getmro(cls)
    names = dir(cls)
    result = []
    for name in names:
        # Get the object associated with the name.
        # Getting an obj from the __dict__ sometimes reveals more than
        # using getattr.  Static and class methods are dramatic examples.
        if name in cls.__dict__:
            obj = cls.__dict__[name]
        else:
            obj = getattr(cls, name)

        # Figure out where it was defined.
        homecls = getattr(obj, "__objclass__", None)
        if homecls is None:
            # search the dicts.
            for base in mro:
                if name in base.__dict__:
                    homecls = base
                    break

        # Get the object again, in order to get it from the defining
        # __dict__ instead of via getattr (if possible).
        if homecls is not None and name in homecls.__dict__:
            obj = homecls.__dict__[name]

        # Also get the object via getattr.
        obj_via_getattr = getattr(cls, name)

        # Classify the object.
        if isinstance(obj, staticmethod):
            kind = "static method"
        elif isinstance(obj, classmethod):
            kind = "class method"
        elif isinstance(obj, property):
            kind = "property"
        elif (ismethod(obj_via_getattr) or
              ismethoddescriptor(obj_via_getattr)):
            kind = "method"
        else:
            kind = "data"

        result.append((name, kind, homecls, obj))

    return result