z fc @ s d Z d Z d Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z
d d l Z d d l m
Z
d d l m Z d^ \ Z Z Z Z d_ \ Z Z Z d` Z d Z d Z d Z d Z d Z e e d r
d Z n d Z e e d r1d Z n d Z d Z d Z! d Z" d Z# d Z$ d Z% d Z& d! Z' d" Z( d d# Z* e d$ d% Z+ d& Z, d' Z- d( Z. d) Z/ d* Z0 d+ Z1 d, Z2 e d- d. Z3 d/ Z4 d0 Z5 d1 Z6 d d2 Z7 i Z8 i Z9 d d3 Z: d4 Z; d5 Z< d6 e= f d7 YZ> d8 da d9 YZ? d: Z@ d; ZA d< ZB d= ZC d> d? ZD e d@ dA ZE dB ZF e dC dD ZG dE ZH e dF dG ZI dH ZJ dI ZK eK dJ ZL d d d eM dK dL dM eK dN ZN eM dO dP dQ eK dR ZO dS ZP e dT dU ZQ d dV ZR dW ZS d dX ZT d dY ZU e e dZ re jV ZW n d d[ ZW d d\ ZX d d] ZY d S(b s 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(), isgeneratorfunction(),
isgenerator(), 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(), getcallargs() - 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 s
1 Jan 2001iN( t
attrgetter( t
namedtuplei i i i i i i@ i c C s t | t j 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)( t
isinstancet typest
ModuleType( t object( ( s /usr/lib64/python2.7/inspect.pyt ismodule3 s c C s t | t t j f 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 defined( R t typeR t ClassType( R ( ( s /usr/lib64/python2.7/inspect.pyt isclass; s c C s t | t j 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 None( R R t
MethodType( R ( ( s /usr/lib64/python2.7/inspect.pyt ismethodC s c C sD t | d oC t | d oC t | oC t | oC 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__( t hasattrR t
isfunctionR ( R ( ( s /usr/lib64/python2.7/inspect.pyt ismethoddescriptorN 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 ( R ( R ( ( s /usr/lib64/python2.7/inspect.pyt isdatadescriptorb s t MemberDescriptorTypec C s t | t j S( s Return true if the object is a member descriptor.
Member descriptors are specialized descriptors defined in extension
modules.( R R R ( R ( ( s /usr/lib64/python2.7/inspect.pyt ismemberdescriptorn s c C s t S( s Return true if the object is a member descriptor.
Member descriptors are specialized descriptors defined in extension
modules.( t False( R ( ( s /usr/lib64/python2.7/inspect.pyR v s t GetSetDescriptorTypec C s t | t j S( s Return true if the object is a getset descriptor.
getset descriptors are specialized descriptors defined in extension
modules.( R R R ( R ( ( s /usr/lib64/python2.7/inspect.pyt isgetsetdescriptor s c C s t S( s Return true if the object is a getset descriptor.
getset descriptors are specialized descriptors defined in extension
modules.( R ( R ( ( s /usr/lib64/python2.7/inspect.pyR s c C s t | t j 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__)( R R t FunctionType( R ( ( s /usr/lib64/python2.7/inspect.pyR s c C s, t t | s t | o( | j j t @ S( s Return true if the object is a user-defined generator function.
Generator function objects provide the same attributes as functions.
See help(isfunction) for a list of attributes.( t boolR R t func_codet co_flagst CO_GENERATOR( R ( ( s /usr/lib64/python2.7/inspect.pyt isgeneratorfunction s c C s t | t j S( s Return true if the object is a generator.
Generator objects provide these attributes:
__iter__ defined to support iteration over container
close raises a new GeneratorExit exception inside the
generator to terminate the iteration
gi_code code object
gi_frame frame object or possibly None once the generator has
been exhausted
gi_running set to 1 when generator is executing, 0 otherwise
next return the next item from the container
send resumes the generator and "sends" a value that becomes
the result of the current yield-expression
throw used to raise an exception inside the generator( R R t
GeneratorType( R ( ( s /usr/lib64/python2.7/inspect.pyt isgenerator s c C s t | t j 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)( R R t
TracebackType( R ( ( s /usr/lib64/python2.7/inspect.pyt istraceback s c C s t | t j 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 None( R R t FrameType( R ( ( s /usr/lib64/python2.7/inspect.pyt isframe s c C s t | t j 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 variables( R R t CodeType( R ( ( s /usr/lib64/python2.7/inspect.pyt iscode s c C s t | t j 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 None( R R t BuiltinFunctionType( R ( ( s /usr/lib64/python2.7/inspect.pyt isbuiltin s c C s. t | p- t | p- t | p- t | S( s< Return true if the object is any kind of function or method.( R& R R R ( R ( ( s /usr/lib64/python2.7/inspect.pyt isroutine s c C s t t | t o | j t @ S( s: Return true if the object is an abstract base class (ABC).( R R R t __flags__t TPFLAGS_IS_ABSTRACT( R ( ( s /usr/lib64/python2.7/inspect.pyt
isabstract s c C s~ g } xg t | D]Y } y t | | } Wn t k
rB q n X| sV | | r | j | | f q q W| j | S( s Return all members of an object as (name, value) pairs sorted by name.
Optionally, only return members that satisfy a given predicate.( t dirt getattrt AttributeErrort appendt sort( R t predicatet resultst keyt value( ( s /usr/lib64/python2.7/inspect.pyt
getmembers s
t Attributes name kind defining_class objectc
C sb t | } t | } g } x=| D]5} d } x\ | f | D], } | | j k r? | j | } | } Pq? q? Wt | | } t | d | } t | t r d } n t | t r d } n~ t | t r d } nf t | r d } nQ t
| rd } n< t | | } t | s)t | r2d } n d } | } | j t
| | | | 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 getmroR+ t Nonet __dict__R, R t staticmethodt classmethodR7 R R R R. R5 (
t clst mrot namest resultt namet homeclst baset objt kindt obj_via_getattr( ( s /usr/lib64/python2.7/inspect.pyt classify_class_attrs s<
c C sB | | k r d S| j | x | j D] } t | | q' Wd S( N( R. t __bases__t _searchbases( R? t accumRE ( ( s /usr/lib64/python2.7/inspect.pyRK K s
c C s7 t | d r | j Sg } t | | t | Sd S( sH Return tuple of base classes (including cls) in method resolution order.t __mro__N( R RM RK t tuple( R? RB ( ( s /usr/lib64/python2.7/inspect.pyR: S s
c C s, t j | } t | t t j | S( sB Return the indent size, in spaces, at the start of a line of text.( t stringt
expandtabst lent lstrip( t linet expline( ( s /usr/lib64/python2.7/inspect.pyt
indentsize] s c C sB y
| j } Wn t k
r! d SXt | t j s8 d St | 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.N( t __doc__R- R; R R t StringTypest cleandoc( R t doc( ( s /usr/lib64/python2.7/inspect.pyt getdocb s
c C sK y t j t j | d } Wn t k
r3 d SXt j } xO | d D]C } t t j | } | rH t | | } t | | } qH qH W| r | d j | d s N( t ost patht basenamet mapt impt get_suffixesR/ Rs ( Rw t filenamet suffixest neglent suffixt modet mtype( ( s /usr/lib64/python2.7/inspect.pyt
getmoduleinfo s
c C s t | } | r | d Sd S( s1 Return the module name for a given file, or None.i N( R ( Rw Rt ( ( s /usr/lib64/python2.7/inspect.pyt
getmodulename s c C s t | } t j | d d k r6 | d d } n xM t j D]? \ } } } d | k rC t j | t | | k rC d SqC Wt j j | r | St
t | | d r | S| t j
k r | Sd S( s Return the filename that can be used to locate an object's source.
Return None if no way can be identified to get the source.
is .pycs .pyos .pyt bt
__loader__N( s .pycs .pyo( Rr RO t lowerRz R{ RQ R; Rv Rw t existsR t getmodulet linecachet cache( R R| R R RG ( ( s /usr/lib64/python2.7/inspect.pyt
getsourcefile s ,c C sC | d k r' t | p! t | } n t j j t j j | 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( R; R Rr Rv Rw t normcaset abspath( R t _filename( ( s /usr/lib64/python2.7/inspect.pyt
getabsfile s c
C s t | r | St | d r2 t j j | j S| d k r^ | t k r^ t j j t | Sy t | | } Wn t k
r d SX| t k r t j j t | Sx t j j
D] \ } } t | r t | d r | j } | t j | d k rq n | t | W| |
f St 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.i is <>s source code not availables could not get source codei s ^(\s*)class\s*s \bt cs could not find class definitiont co_firstlinenos" could not find function definitions+ ^(\s*def\s)|(.*(?Pn t j t j | | } qWn x- | rt j | d d k rg | d *qdWx- | rt j | d d k rg | d )qWt j
| d Sn 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 (
R R Ri R; R RQ RO t stripR. RP Rb RU RR ( R Rc R t startt commentst endRf t comment( ( s /usr/lib64/python2.7/inspect.pyt getcommentsH sJ .&)
)
)
#""t
EndOfBlockc B s e Z RS( ( R Rm ( ( ( s /usr/lib64/python2.7/inspect.pyR u s t BlockFinderc B s e 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 i ( Rf R t islambdat startedt passlinet last( t self( ( s /usr/lib64/python2.7/inspect.pyt __init__y s
c
C s8 | \ } } | \ } } | j s] | d k rQ | d k rE t | _ n t | _ n t | _ n | t j k r t | _ | | _ | j r4t q4n | j r n | t j k r | j
d | _
t | _ nj | t j k r| j
d | _
| j
d k r4t q4n0 | j
d k r4| t j t j
f k r4t n d S( Nt deft classt lambdai i ( R R R ( R t TrueR R t tokenizet NEWLINER R R t INDENTRf t DEDENTt COMMENTt NL(
R R t tokent srow_scolt erow_ecolRS t srowt scolt erowt ecol( ( s /usr/lib64/python2.7/inspect.pyt
tokeneater s0 '( R Rm RV R R ( ( ( s /usr/lib64/python2.7/inspect.pyR w s c C sN t } y t j t | j | j Wn t t f k
rB n X| | j S( s@ Extract the block of code at the top of the given list of lines.( R R t itert nextR R t IndentationErrorR ( Rc t blockfinder( ( s /usr/lib64/python2.7/inspect.pyt getblock s c C sz t | \ } } t | r* | j } n t | sT t | r^ | j j d k r^ | d f St | | | 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.s i i N( R R Ro R R" Rp t co_nameR ( R Rc R ( ( s /usr/lib64/python2.7/inspect.pyt getsourcelines s
c C s" t | \ } } t j | 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 ( R RO Rb ( R Rc R ( ( s /usr/lib64/python2.7/inspect.pyt getsource s c C sv g } | j d t d d xP | D]H } | j | | j f | | k r& | j t | | | | q& q& W| S( s- Recursive helper function for getclasstree().R2 Rm R ( R/ R R. RJ t walktree( t classest childrent parentR1 R ( ( s /usr/lib64/python2.7/inspect.pyR s
$i c C s i } g } x | D] } | j r x | j D]Y } | | k rK g | | t | d k r" d | d d Sd t j | d d Sd S( Ni t (i s ,)s , t )( RQ RO Rb ( t seq( ( s /usr/lib64/python2.7/inspect.pyt joinseqI s c C sB t | t t f k r4 | t | | d | S| | Sd S( s7 Recursively walk a sequence, stringifying each element.c S s t | | | S( N( t strseq( t oR t j( ( s /usr/lib64/python2.7/inspect.pyRu R R N( R R RN Ry ( R t convertRb ( ( s /usr/lib64/python2.7/inspect.pyR O s c C s d | S( Nt *( ( RC ( ( s /usr/lib64/python2.7/inspect.pyRu X R c C s d | S( Ns **( ( RC ( ( s /usr/lib64/python2.7/inspect.pyRu Y R c C s d t | S( Nt =( t repr( R3 ( ( s /usr/lib64/python2.7/inspect.pyRu Z R c C s g } | r% t | t | }
n xf t | D]X \ } } t | | | }
| r} | |
k r} |
| | | |
}
n | j |
q2 W| d k r | j | | n | d k r | j | | n d t j | 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( RQ t enumerateR R. R; RO Rb ( R R R t defaultst formatargt
formatvarargst formatvarkwt formatvalueRb t specst firstdefaultRg t argt spec( ( s /usr/lib64/python2.7/inspect.pyt
formatargspecV s c C s d | S( NR
( ( RC ( ( s /usr/lib64/python2.7/inspect.pyRu r R c C s d | S( Ns **( ( RC ( ( s /usr/lib64/python2.7/inspect.pyRu s R c C s d t | S( NR ( R ( R3 ( ( s /usr/lib64/python2.7/inspect.pyRu t R c C s | | | d } g }
x7 t t | D]# } |
j t | | | | q+ W| r| |
j | | | | | n | r |
j | | | | | n d t j |
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 S s | | | | | S( N( ( RC t localsR R ( ( s /usr/lib64/python2.7/inspect.pyR | s R s , R ( R` RQ R. R RO Rb ( R R R R R R R R Rb R R Rg ( ( s /usr/lib64/python2.7/inspect.pyt formatargvaluesp s !$$c s t | \ } } } } | j } i g f d f d } t | r | j d k r | j f | } n t | } | t | }
t | } | r t | n d } x* t | | D] \ }
} |
| q W| r*| | k r | | | | q | d n d | k oA| k n rt d | | r[d n d | | d k rsd n d |
f nS | d k r|
r| r| rt d
| |
f qqt d | |
f n xg | D]_ }
t |
t r|
| k r| |
r&t d | |
f q? |
| j
|
qqW| rxA t | | | D]( \ }
} | |
s^ |
| q^q^Wn | r | | nw | rt t | } y t
Wn t k
rn+ Xt | t
r| j t j d
} n t d | | f n | t g | D] }
| |
r'|
^ q' } | r| | } t d | | rnd n d | | d k rd n d |
f n S( s Get the mapping of arguments to values.
A dict is returned, with keys the function argument names (including the
names of the * and ** arguments, if any), and values the respective bound
values from 'positional' and 'named'.c s t | t r | | s
E
. C -)
=
` !