File: //proc/3/root/usr/lib/python2.4/inspect.pyc
m
=5Dc @ s d Z d Z d Z d k Z d k Z d k Z d k Z d k Z d k Z d k Z d k
Z
d k Z d Z d Z
d Z d Z d Z d Z d
Z d Z d Z d
Z d Z d d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z! d Z" h Z# d Z$ d Z% d Z& d f d YZ' d e( f d YZ) d! f d" YZ* d# Z+ d$ Z, d% Z- d& Z. d' d( Z/ d@ \ Z0 Z1 Z2 Z3 d- Z4 d. Z5 d/ Z6 d0 Z7 e7 d1 Z8 d d d e9 d2 d3 d4 e7 d5 Z: e9 d6 d7 d8 e7 d9 Z; d) d: Z< d; Z= d) d< Z> d) d= Z? e i@ ZA d) d> ZB d) d? ZC d S(A su 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
s Ka-Ping Yee <ping@lfw.org>s
1 Jan 2001Nc C s t | t i S( s Return true if the object is a module.
Module objects provide these attributes:
__doc__ documentation string
__file__ filename (missing for built-in modules)N( t
isinstancet objectt typest
ModuleType( R ( ( t /usr/lib/python2.4/inspect.pyt ismodule" s c C s t | t i p
t | d S( s Return true if the object is a class.
Class objects provide these attributes:
__doc__ documentation string
__module__ name of module in which this class was definedt __bases__N( R R R t ClassTypet hasattr( R ( ( R t isclass* s c C s t | t i S( s Return true if the object is an instance method.
Instance method objects provide these attributes:
__doc__ documentation string
__name__ name with which this method was defined
im_class class object in which this method belongs
im_func function object containing implementation of method
im_self instance to which this method is bound, or NoneN( R R R t
MethodType( R ( ( R t ismethod2 s c C sH t | d o8 t | d o' t | o t | o t | S( s Return true if the object is a method descriptor.
But not if ismethod() or isclass() or isfunction() are true.
This is new in Python 2.2, and, for example, is true of int.__add__.
An object passing this test has a __get__ attribute but not a __set__
attribute, but beyond that the set of attributes varies. __name__ is
usually sensible, and __doc__ often is.
Methods implemented via descriptors that also pass one of the other
tests return false from the ismethoddescriptor() test, simply because
the other tests promise more -- you can, e.g., count on having the
im_func attribute (etc) when an object passes ismethod().t __get__t __set__N( R R R t
isfunctionR ( R ( ( R t ismethoddescriptor= s
c C s t | d o
t | d S( s Return true if the object is a data descriptor.
Data descriptors have both a __get__ and a __set__ attribute. Examples are
properties (defined in Python) and getsets and members (defined in C).
Typically, data descriptors will also have __name__ and __doc__ attributes
(properties, getsets, and members have both of these attributes), but this
is not guaranteed.R
R N( R R ( R ( ( R t isdatadescriptorQ s c C s t | t i S( s Return true if the object is a user-defined function.
Function objects provide these attributes:
__doc__ documentation string
__name__ name with which this function was defined
func_code code object containing compiled function bytecode
func_defaults tuple of any default values for arguments
func_doc (same as __doc__)
func_globals global namespace in which this function was defined
func_name (same as __name__)N( R R R t FunctionType( R ( ( R R [ s
c C s t | t i S( sb Return true if the object is a traceback.
Traceback objects provide these attributes:
tb_frame frame object at this level
tb_lasti index of last attempted instruction in bytecode
tb_lineno current line number in Python source code
tb_next next inner traceback object (called by this level)N( R R R t
TracebackType( R ( ( R t istracebackh s c C s t | t i S( s| Return true if the object is a frame object.
Frame objects provide these attributes:
f_back next outer frame object (this frame's caller)
f_builtins built-in namespace seen by this frame
f_code code object being executed in this frame
f_exc_traceback traceback if raised in this frame, or None
f_exc_type exception type if raised in this frame, or None
f_exc_value exception value if raised in this frame, or None
f_globals global namespace seen by this frame
f_lasti index of last attempted instruction in bytecode
f_lineno current line number in Python source code
f_locals local namespace seen by this frame
f_restricted 0 or 1 if frame is in restricted execution mode
f_trace tracing function for this frame, or NoneN( R R R t FrameType( R ( ( R t isframer s c C s t | t i S( su Return true if the object is a code object.
Code objects provide these attributes:
co_argcount number of arguments (not including * or ** args)
co_code string of raw compiled bytecode
co_consts tuple of constants used in the bytecode
co_filename name of file in which this code object was created
co_firstlineno number of first line in Python source code
co_flags bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=**arg
co_lnotab encoded mapping of line numbers to bytecode indices
co_name name with which this code object was defined
co_names tuple of names of local variables
co_nlocals number of local variables
co_stacksize virtual machine stack space required
co_varnames tuple of names of arguments and local variablesN( R R R t CodeType( R ( ( R t iscode s c C s t | t i S( s, Return true if the object is a built-in function or method.
Built-in functions and methods provide these attributes:
__doc__ documentation string
__name__ original name of this function or method
__self__ instance to which a method is bound, or NoneN( R R R t BuiltinFunctionType( R ( ( R t isbuiltin s c C s1 t | p$ t | p t | p
t | S( s< Return true if the object is any kind of function or method.N( R R R R R ( R ( ( R t isroutine s c C sf g } xO t | D]A } t | | } | p
| | o | i | | f q q W| i | S( s Return all members of an object as (name, value) pairs sorted by name.
Optionally, only return members that satisfy a given predicate.N( t resultst dirR t keyt getattrt valuet predicatet appendt sort( R R R R R ( ( R t
getmembers s
c
C s t | } t | } g } x[| D]S} | | i j o | i | } n t | | } t | d d } | d j o0 x- | D]! } | | i j o | } Pq q Wn | d j o! | | i j o | i | } n t | | } t | t o
d } n_ t | t o
d } nE t | t o
d } n+ t | p
t | o
d } n d } | i | | | | f q% W| S( s 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.
t __objclass__s
static methods class methodt propertyt methodt dataN( t getmrot clst mroR t namest resultt namet __dict__t objR t Nonet homeclst baset obj_via_getattrR t staticmethodt kindt classmethodR% R R R! (
R) R/ R- R5 R* R, R2 R3 R1 R+ ( ( R t classify_class_attrs s<
c C sG | | j o d Sn | i | x | i D] } t | | q, Wd S( N( R) t accumR! R R2 t _searchbases( R) R8 R2 ( ( R R9 s
c C s< t | d o | i Sn g } t | | t | Sd S( sH Return tuple of base classes (including cls) in method resolution order.t __mro__N( R R) R: R, R9 t tuple( R) R, ( ( R R( s
c C s, t i | } t | t t i | S( sB Return the indent size, in spaces, at the start of a line of text.N( t stringt
expandtabst linet explinet lent lstrip( R> R? ( ( R t
indentsize
s c C s y
| i } Wn t j
o d Sn Xt | t i p d Sn y t i t i
| d } Wn t j
o d Sn!Xt
i } xQ | d D]E } t t i | } | o# t | | } t | | } q q W| o | d i | d <n | t
i j o6 x3 t d t | D] } | | | | | <q Wn x" | o | d o | i q@Wx% | o | d o | i d qeWt i | d Sd S( s Get the documentation string for an object.
All tabs are expanded to spaces. To clean up docstrings that are
indented to line up with blocks of code, any whitespace than can be
uniformly removed from the second line onwards is removed.s
i i iN( R t __doc__t doct AttributeErrorR0 R R t StringTypesR< t splitR= t linest UnicodeErrort syst maxintt marginR> R@ RA t contentt indentt mint ranget it popt join( R RM RN RQ RD RH RL R> ( ( R t getdoc s>
c C s t | o+ t | d o | i Sn t d n t | o@ t i i | i } t | d o | i Sn t d n t
| o
| i } n t | o
| i
} n t | o
| i } n t | o
| i } n t | o | i Sn t d d S( s@ Work out which source or compiled file an object was defined in.t __file__s arg is a built-in modules arg is a built-in classsN arg is not a module, class, method, function, traceback, frame, or code objectN( R R R RU t TypeErrorR RJ t modulest gett
__module__R t im_funcR t func_codeR t tb_frameR t f_codeR t co_filename( R ( ( R t getfile3 s*
c C s~ t i i | } t d t i } | i xC | D]; \ } } } } | | | j o | | | | | f Sq; q; Wd S( sD Get the module name, suffix, mode, and module type for a given file.c C s& | \ } } } t | | | | f S( N( t suffixt modet mtypeR@ ( t .0R` Ra Rb ( ( R t <lambda>N s N(
t ost patht basenamet filenamet mapt impt get_suffixest suffixesR" t neglenR` Ra Rb ( Rf R` Rm Rh Rb Ra Rl ( ( R t
getmoduleinfoK s
c C s# t | } | o | d Sn d S( s1 Return the module name for a given file, or None.i N( Rn Rf t info( Rf Ro ( ( R t
getmodulenameU s c C s t | } t i | d d d g j o | d d } n xS t i D]E \ } } } d | j o) t i | t
| | j o d SqK qK Wt i
i | o | Sn d S( sE Return the Python source file an object was defined in, if it exists.is .pycs .pyos .pyt bN( R_ R Rh R< t lowerRj Rk R` Ra R5 R@ R0 Re Rf t exists( R R5 R` Rh Ra ( ( R t
getsourcefileZ s
. c C s/ t i i t i i t | p
t | S( s Return an absolute path to the source or compiled file for an object.
The idea is for each object to have a unique origin, so this routine
normalizes the result as much as possible.N( Re Rf t normcaset abspathRt R R_ ( R ( ( R t
getabsfilef s c C s t | o | Sn t | d o t i i | i Sn y t | } Wn t j
o d Sn X| t j o t i i t | Sn xJ t i i D]9 } t | d o# | i t t i i t | <q q W| t j o t i i t | Sn t i d } t | d p d Sn t | | i o+ t | | i } | | j o | Sq`n t i d } t | | i o+ t | | i } | | j o | Sqn d S( sA Return the module an object was defined in, or None if not found.RY RU t __main__t __name__t __builtin__N( R R R RJ RW RX RY Rw t fileRV R0 t
modulesbyfilet valuest moduleRy Re Rf t realpatht mainR t
mainobjectt builtint
builtinobject( R R R~ R{ R R R ( ( R t getmodulep s:
'
c C s t | p
t | } t i | } | p t d n t | o | d f Sn t | oo | i
} t i
d | d } xL t t | D]( } | i | | o | | f Sq q Wt d n t | o
| i } n t | o
| i } n t | o
| i } n t | o
| i } n t | o t | d p t d n | i d } t i
d } x5 | d j o' | i | | o Pn | d } qW| | f Sn t d
d S( sb Return the entire source file and starting line number for an object.
The argument may be a module, class, method, function, traceback, frame,
or code object. The source code is returned as a list of all the lines
in the file and the line number indexes a line in that list. An IOError
is raised if the source code cannot be retrieved.s could not get source codei s ^\s*class\s*s \bs could not find class definitiont co_firstlinenos" could not find function definitioni s+ ^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)s could not find code objectN( Rt R R_ R{ t linecachet getlinesRH t IOErrorR R Ry R- t ret compilet patRP R@ RQ t matchR RZ R R[ R R\ R R] R R R t lnum( R R R{ R R- RH RQ ( ( R t
findsource sF
c C s
y t | \ } } Wn t t f j
o d Sn Xt | od } | o | d d d j o
d } n xB | t | j o. t
i | | d d g j o | d } qr W| t | j o | | d d j ot g } | } xQ | t | j o= | | d d j o( | i t
i | | | d } q Wt
i | d Sqn| d j ot | | } | d } | d j ozt
i | | d d j o\t | | | j oEt
i t
i | | g } | d j o | d } t
i t
i | | } xv | d d j o` t | | | j oI | g | d *| d } | d j o Pn t
i t
i | | } qWn x0 | o( t
i | d d j o g | d *qWx0 | o( t
i | d d j o g | d )qWt
i | d Sqn d S( sw Get lines of comments immediately preceding an object's source code.
Returns None when source can't be found.
i i s #!i t t #iN( R R RH R R RV R0 R t startR@ R< t stript commentst endR! R= RS RB RN RA t comment( R RN R R R R RH R ( ( R t getcomments sT
3( (
B
(
% ! !t
ListReaderc B s t Z d Z d Z d Z RS( sC Provide a readline() method to return lines from a list of strings.c C s | | _ d | _ d S( Ni ( RH t selft index( R RH ( ( R t __init__ s c C sC | i } | t | i j o | d | _ | i | Sn d Sd S( Ni R ( R R RQ R@ RH ( R RQ ( ( R t readline s
( Ry RY RC R R ( ( ( R R s t
EndOfBlockc B s t Z RS( N( Ry RY ( ( ( R R s t BlockFinderc B s t Z d Z d Z d Z RS( s@ Provide a tokeneater() method to detect the end of a code block.c C s1 d | _ t | _ t | _ t | _ d | _ d S( Ni ( R RN t Falset islambdat startedt passlinet last( R ( ( R R s
c
C sS | \ } } | \ } } | i pA | d j o' | d j o
t | _ n t | _ n t | _ n | t i j o t
| _ | | _ n | i o n | i o t | i n | t i j o | i d | _ t | _ nr | t i j o4 | i d | _ | i d j o t | i qOn. | t i j o | d j o t | i n d S( Nt deft classt lambdai i ( R R R ( t srowt scolt erowt ecolR R t tokent TrueR R t typet tokenizet NEWLINER R R t INDENTRN t DEDENTt NAME(
R R R t .6t .8R> R R R R ( ( R t
tokeneater s,
( Ry RY RC R R ( ( ( R R s c C sR y# t i t | i t i Wn$ t j
o } | | i d Sn X| d S( s@ Extract the block of code at the top of the given list of lines.i i N( R R RH R R R R t eobt args( RH R ( ( R t getblock s #c C sI t | \ } } t | o | d f Sn t | | | d f Sd S( s Return a list of source lines and starting line number for an object.
The argument may be a module, class, method, function, traceback, frame,
or code object. The source code is returned as a list of the lines
corresponding to the object and the line number indicates where in the
original source file the first line of code was found. An IOError is
raised if the source code cannot be retrieved.i i N( R R RH R R R ( R R RH ( ( R t getsourcelines s
c C s" t | \ } } t i | d S( s Return the text of the source code for an object.
The argument may be a module, class, method, function, traceback, frame,
or code object. The source code is returned as a single string. An
IOError is raised if the source code cannot be retrieved.R N( R R RH R R< RS ( R R RH ( ( R t getsource- s c C sr g } | i d d xR | D]J } | i | | i f | | j o! | i t | | | | q q W| S( s- Recursive helper function for getclasstree().R c C s | i | i f S( N( t cRY Ry ( R ( ( R Rd : s N( R t classesR" R R! R t childrent walktree( R R t parentR R ( ( R R 7 s
%i c C s h } g } x | D] } | i o] xx | i D]K } | | j o g | | <n | | i | | o | | j o Pq- q- Wq | | j o | i | q q Wx, | D]$ } | | j o | i | q q Wt | | d S( s Arrange the given list of classes into a hierarchy of nested lists.
Where a nested list appears, it contains classes derived from the class
whose entry immediately precedes the list. Each entry is a 2-tuple
containing a class and a tuple of its base classes. If the 'unique'
argument is true, exactly one entry appears in the returned structure
for each class in the given list. Otherwise, classes using multiple
inheritance and their descendants will appear multiple times.N(
R t rootsR R R R R! t uniqueR R0 ( R R R R R R ( ( R t getclasstreeA s(
i i i i c C s{ t | p t d n | i } | i } | i } t | | } d } xt | D]}
| |
d d d g j og g g } } } xq| t | j o]t | | } | d } | t i j o/t i | } t | | t | | d d } | d } | d d g j o | i | | i | q| d
j o | i | | | p | d g | d <Pq| d d | d <x] | d d j oK | i | i } | | g | | )| p Pn | d d | d <qW| p Pqqq q W| d | |
<q[ q[ Wd }
| i t @o | i | }
| d } n d } | i t @o | i | } n | |
| f S(
s Get information about the arguments accepted by a code object.
Three things are returned: (args, varargs, varkw), where 'args' is
a list of argument names (possibly containing nested lists), and
'varargs' and 'varkw' are the names of the * and ** arguments or None.s arg is not a code objecti i R t .i i t UNPACK_TUPLEt UNPACK_SEQUENCEt
STORE_FASTiN(! R t coRV t co_codet codet co_argcountt nargst co_varnamesR+ t listR t stepRP RQ t stackt remaint countR@ t ordt opt dist
HAVE_ARGUMENTt opnameR R! RR t sizeR0 t varargst co_flagst
CO_VARARGSt varkwt CO_VARKEYWORDS( R R R+ R R R R R R R R R R RQ R R ( ( R t getargs^ s`
&
c C sb t | o
| i } n t | p t d n t | i \ } } } | | | | i
f S( sl Get the names and default values of a function's arguments.
A tuple of four things is returned: (args, varargs, varkw, defaults).
'args' is a list of the argument names (it may contain nested lists).
'varargs' and 'varkw' are the names of the * and ** arguments or None.
'defaults' is an n-tuple of the default values of the last n arguments.
s arg is not a Python functionN( R t funcRZ R RV R R[ R R R t
func_defaults( R R R R ( ( R t
getargspec s
c C s+ t | i \ } } } | | | | i f S( sW Get information about arguments passed into a particular frame.
A tuple of four things is returned: (args, varargs, varkw, locals).
'args' is a list of the argument names (it may contain nested lists).
'varargs' and 'varkw' are the names of the * and ** arguments or None.
'locals' is the locals dictionary of the given frame.N( R t frameR] R R R t f_locals( R R R R ( ( R t getargvalues s c C sC t | d j o d | d d Sn d t i | d d Sd S( Ni t (i s ,)s , t )( R@ t seqR< RS ( R ( ( R t joinseq s c C sM t | t i t i g j o | t | | d | Sn | | Sd S( s7 Recursively walk a sequence, stringifying each element.c C s t | | | S( N( t strseqt oR t j( R R R ( ( R Rd s N( R R R t ListTypet TupleTypeRS Ri t convert( R R RS ( ( R R s c C s d | S( Nt *( R- ( R- ( ( R Rd s c C s d | S( Ns **( R- ( R- ( ( R Rd s c C s d t | S( Nt =( t reprR ( R ( ( R Rd s c
C s g } | o t | t | }
n xm t t | D]Y } t | | | | } | o) | |
j o | | | | |
} n | i | q: W| d j o | i | | n | d j o | i | | n d t i | d d S( sg Format an argument spec from the 4 values returned by getargspec.
The first four arguments are (args, varargs, varkw, defaults). The
other four arguments are the corresponding optional formatting functions
that are called to turn names and values into strings. The ninth
argument is an optional function to format the sequence of arguments.R s , R N( t specst defaultsR@ R t firstdefaultRP RQ R t formatargRS t spect formatvalueR! R R0 t
formatvarargsR t formatvarkwR< (
R R R R R R R R RS RQ R R R ( ( R t
formatargspec s
c C s d | S( NR ( R- ( R- ( ( R Rd s c C s d | S( Ns **( R- ( R- ( ( R Rd s c C s d t | S( NR ( R R ( R ( ( R Rd s c C s | | | d } g } x7 t t | D]# }
| i t
| |
| | q+ W| o% | i | | | | | n | o% | i | | | | | n d t i | d d S( sf Format an argument spec from the 4 values returned by getargvalues.
The first four arguments are (args, varargs, varkw, locals). The
next four arguments are the corresponding optional formatting functions
that are called to turn names and values into strings. The ninth
argument is an optional function to format the sequence of arguments.c C s | | | | | S( N( R R- R t locals( R- R R R ( ( R R s R s , R N( R R R R R RP R@ R RQ R! R RS R R R R R< ( R R R R R R R R RS R RQ R ( ( R t formatargvalues s !%%c C s. t | o | i } | i } n
| i } t | p t d n t | p
t | } | d j o | d | d } y t
| \ } } Wn t j
o d } } qXt | d } t d t | t | | } | | | | !} | d | } n d } } | | | i i | | f S( s Get information about a frame or traceback object.
A tuple of five things is returned: the filename, the line number of
the current line, the function name, a list of lines of context from
the source code, and the index of the current line within that list.
The optional second argument specifies the number of lines of context
to return, which are centered around the current line.s& arg is not a frame or traceback objecti i i N( R R t tb_linenot linenoR\ t f_linenoR RV Rt R_ Rh t contextR R RH R R R0 R t maxRO R@ R] t co_name( R R R R RH Rh R R ( ( R t getframeinfo s(
"
c C s | i S( sC Get the line number from a frame object, allowing for optimization.N( R R ( R ( ( R t getlineno s c C s? g } x2 | o* | i | f t | | | i } q W| S( s Get a list of records for a frame and all higher (calling) frames.
Each record contains a frame object, filename, line number, function
name, a list of lines of context, and index within the context.N( t framelistR R! R R t f_back( R R R ( ( R t getouterframes s c C sB g } x5 | o- | i | i f t | | | i } q W| S( s Get a list of records for a traceback's frame and all lower frames.
Each record contains a frame object, filename, line number, function
name, a list of lines of context, and index within the context.N( R t tbR! R\ R R t tb_next( R R R ( ( R t getinnerframes$ s c C s t t i d | S( s@ Return a list of records for the stack above the caller's frame.i N( R RJ t _getframeR ( R ( ( R R 1 s c C s t t i d | S( sC Return a list of records for the stack below the current exception.i N( R RJ t exc_infoR ( R ( ( R t trace5 s ( i i i i (D RC t
__author__t __date__RJ Re R R< R R Rj R R R R R R R R R R R R R R0 R# R7 R9 R( RB RT R_ Rn Rp Rt Rw R| R R R R t ExceptionR R R R R R R t CO_OPTIMIZEDt CO_NEWLOCALSR R R R R R R t strR R R R R R R t currentframeR R (? R R R R R RB Rp R R_ R R R Rw R Rn R R R R R R R Rj R R R R R R R R R R R< R R R# R R RJ R R9 R R( R R R RT R R R7 R R R R| R
R R R Rt R Re R ( ( R t ? sh Q
G
$
* -
!
;
*! !