; "Ic@sdZdZdZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl m Z ddlmZdb\ZZZZdc\ZZZddZdZdZdZdZdZeedo dZn dZeedo dZn dZdZ dZ!dZ"dZ#dZ$dZ%d Z&d!Z'd"Z"d#Z(dd$Z*ed%d&Z+d'Z,d(Z-d)Z.d*Z/d+Z0d,Z1d-Z2ed.d/Z3d0Z4d1Z5d2Z6dd3Z7iZ8iZ9dd4Z:d5Z;d6Z<Gd7d8e=Z>Gd9d:Z?d;Z@d<ZAd=ZBd>ZCdd?ZDed@dAZEdBZFdCZGedDdEZHdFZIedGdHZJdIZKedJdKZLdLZMdMZNeNdNZOddOZPdPZQddddeiieRdQdRdSdTePeNdU ZSeRdVdWdXeNdYZTedZd[ZUdd\ZVd]ZWdd^ZXdd_ZYejZZ[dd`Z\ddaZ]dS(fuGet useful information from live Python objects. This module encapsulates the interface provided by the internal special attributes (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() - get info about function arguments getfullargspec() - same, with support for Python-3000 features 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 uKa-Ping Yee u 1 Jan 2001iN(u attrgetter(u namedtupleiiiiii i@icCst|tjS(uReturn true if the object is a module. Module objects provide these attributes: __doc__ documentation string __file__ filename (missing for built-in modules)(u isinstanceutypesu ModuleType(uobject((u$/mit/python/lib/python3.0/inspect.pyuismodule4scCst|tp t|dS(uReturn true if the object is a class. Class objects provide these attributes: __doc__ documentation string __module__ name of module in which this class was definedu __bases__(u isinstanceutypeuhasattr(uobject((u$/mit/python/lib/python3.0/inspect.pyuisclass<scCst|tjS(u_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 __func__ function object containing implementation of method __self__ instance to which this method is bound(u isinstanceutypesu MethodType(uobject((u$/mit/python/lib/python3.0/inspect.pyuismethodDscCsHt|do8t|d o't| ot| o t| S(uReturn 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 __func__ attribute (etc) when an object passes ismethod().u__get__u__set__(uhasattruismethodu isfunctionuisclass(uobject((u$/mit/python/lib/python3.0/inspect.pyuismethoddescriptorNs cCst|do t|dS(uReturn 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.u__set__u__get__(uhasattr(uobject((u$/mit/python/lib/python3.0/inspect.pyuisdatadescriptorbsuMemberDescriptorTypecCst|tjS(uReturn true if the object is a member descriptor. Member descriptors are specialized descriptors defined in extension modules.(u isinstanceutypesuMemberDescriptorType(uobject((u$/mit/python/lib/python3.0/inspect.pyuismemberdescriptornscCsdS(uReturn true if the object is a member descriptor. Member descriptors are specialized descriptors defined in extension modules.F(uFalse(uobject((u$/mit/python/lib/python3.0/inspect.pyuismemberdescriptorvsuGetSetDescriptorTypecCst|tjS(uReturn true if the object is a getset descriptor. getset descriptors are specialized descriptors defined in extension modules.(u isinstanceutypesuGetSetDescriptorType(uobject((u$/mit/python/lib/python3.0/inspect.pyuisgetsetdescriptorscCsdS(uReturn true if the object is a getset descriptor. getset descriptors are specialized descriptors defined in extension modules.F(uFalse(uobject((u$/mit/python/lib/python3.0/inspect.pyuisgetsetdescriptorscCst|tjS(u(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 __code__ code object containing compiled function bytecode __defaults__ tuple of any default values for arguments __globals__ global namespace in which this function was defined __annotations__ dict of parameter annotations __kwdefaults__ dict of keyword only parameters with defaults(u isinstanceutypesu FunctionType(uobject((u$/mit/python/lib/python3.0/inspect.pyu isfunctions cCs4t|p t|o|jjt@odSdS(uReturn true if the object is a user-defined generator function. Generator function objects provides same attributes as functions. See isfunction.__doc__ for attributes listing.NT(u isfunctionuismethodu__code__uco_flagsu CO_GENERATORuTrue(uobject((u$/mit/python/lib/python3.0/inspect.pyuisgeneratorfunctionscCst|tjS(u Return true if the object is a generator. Generator objects provide these attributes: __iter__ defined to support interation 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(u isinstanceutypesu GeneratorType(uobject((u$/mit/python/lib/python3.0/inspect.pyu isgeneratorscCst|tjS(ubReturn 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)(u isinstanceutypesu TracebackType(uobject((u$/mit/python/lib/python3.0/inspect.pyu istracebackscCst|tjS(u`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_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_trace tracing function for this frame, or None(u isinstanceutypesu FrameType(uobject((u$/mit/python/lib/python3.0/inspect.pyuisframes cCst|tjS(uuReturn 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(u isinstanceutypesuCodeType(uobject((u$/mit/python/lib/python3.0/inspect.pyuiscodescCst|tjS(u,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(u isinstanceutypesuBuiltinFunctionType(uobject((u$/mit/python/lib/python3.0/inspect.pyu isbuiltinscCs1t|p$t|pt|p t|S(u<Return true if the object is any kind of function or method.(u isbuiltinu isfunctionuismethoduismethoddescriptor(uobject((u$/mit/python/lib/python3.0/inspect.pyu isroutines   cCst|tjS(u0Return true if the object is a generator object.(u isinstanceutypesu GeneratorType(uobject((u$/mit/python/lib/python3.0/inspect.pyu isgeneratorscCst|to |jt@S(u:Return true if the object is an abstract base class (ABC).(u isinstanceutypeu __flags__uTPFLAGS_IS_ABSTRACT(uobject((u$/mit/python/lib/python3.0/inspect.pyu isabstractscCsfg}xOt|D]A}t||}| p ||o|j||fqqW|j|S(uReturn all members of an object as (name, value) pairs sorted by name. Optionally, only return members that satisfy a given predicate.(udirugetattruappendusort(uobjectu predicateuresultsukeyuvalue((u$/mit/python/lib/python3.0/inspect.pyu getmemberss  u Attributeuname kind defining_class objectc Cst|}t|}g}x^|D]V}||jko|j|}nt||}t|dd}|dko0x-|D]!}||jko |}PqqWn|dk o!||jko|j|}nt||}t|to d} n_t|to d} nEt|to d} n+t |p t |o d} nd} |j t || ||q%W|S(uReturn 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. u __objclass__u static methodu class methodupropertyumethodudataN( ugetmroudiru__dict__ugetattruNoneu isinstanceu staticmethodu classmethodupropertyu isfunctionuismethoddescriptoruappendu Attribute( uclsumrounamesuresultunameuobjuhomeclsubaseuobj_via_getattrukind((u$/mit/python/lib/python3.0/inspect.pyuclassify_class_attrss<           cCsD||kodS|j|x|jD]}t||q)WdS(N(uappendu __bases__u _searchbases(uclsuaccumubase((u$/mit/python/lib/python3.0/inspect.pyu _searchbasesLs    cCs9t|do|jSg}t||t|SdS(uHReturn tuple of base classes (including cls) in method resolution order.u__mro__N(uhasattru__mro__u _searchbasesutuple(uclsuresult((u$/mit/python/lib/python3.0/inspect.pyugetmroTs  cCs&|j}t|t|jS(uBReturn the indent size, in spaces, at the start of a line of text.(u expandtabsulenulstrip(ulineuexpline((u$/mit/python/lib/python3.0/inspect.pyu indentsize^s c CsGy |j}Wntk o dSYnXt|tpdSt|S(uGet 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(u__doc__uAttributeErroruNoneu isinstanceustrucleandoc(uobjectudoc((u$/mit/python/lib/python3.0/inspect.pyugetdoccs  c Cs]y|jjd}Wntk o dSYn'Xtj}xT|ddD]B}t|j}|o#t||}t||}qNqNW|o|dj|ds N(uosupathubasenameuimpu get_suffixesusortu ModuleInfo(upathufilenameusuffixesuneglenusuffixumodeumtype((u$/mit/python/lib/python3.0/inspect.pyu getmoduleinfos cCs t|}|o |dSdS(u1Return the module name for a given file, or None.iN(u getmoduleinfo(upathuinfo((u$/mit/python/lib/python3.0/inspect.pyu getmodulenames cCst|}|ddjdko|ddd}nxStjD]E\}}}d|ko)|t| dj|kodSqNWtjj|o|St t ||do|SdS( uEReturn the Python source file an object was defined in, if it exists.iNu.pycu.pyou.pyubu __loader__(u.pycu.pyo( ugetfileuloweruimpu get_suffixesulenuNoneuosupathuexistsuhasattru getmodule(uobjectufilenameusuffixumodeukind((u$/mit/python/lib/python3.0/inspect.pyu getsourcefiles  1 cCsF|dkot|p t|}ntjjtjj|S(uReturn 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(uNoneu getsourcefileugetfileuosupathunormcaseuabspath(uobjectu _filename((u$/mit/python/lib/python3.0/inspect.pyu getabsfiles c Cs!t|o|St|dotjj|jS|dk o"|tkotjjt|Syt||}Wnt k o dSYnX|tkotjjt|Sxtjj D]\}}t|ott|dod|j }|t j|dkoqn|t |HsN(utypeulistutupleumap(uobjectuconvertujoin((u$/mit/python/lib/python3.0/inspect.pyustrseqEscCsKt|to1|jd|fko|jS|jd|jSt|S(Nubuiltinsu.(u isinstanceutypeu __module__u__name__urepr(u annotationu base_module((u$/mit/python/lib/python3.0/inspect.pyuformatannotationLs cs%t|ddfd}|S(Nu __module__cs t|S(N(uformatannotation(u annotation(umodule(u$/mit/python/lib/python3.0/inspect.pyu_formatannotationUs(ugetattruNone(uobjectu_formatannotation((umoduleu$/mit/python/lib/python3.0/inspect.pyuformatannotationrelativetoSscCsd|S(u*((uname((u$/mit/python/lib/python3.0/inspect.pyu\scCsd|S(u**((uname((u$/mit/python/lib/python3.0/inspect.pyu]scCsdt|S(u=(urepr(uvalue((u$/mit/python/lib/python3.0/inspect.pyu^scCsd|S(u -> ((utext((u$/mit/python/lib/python3.0/inspect.pyu_sc sfd}g}|ot|t|}nxmtt|D]Y}t|||| }|o)||ko|| |||}n|j|qOW|dk o|j|||n|o|jdn|oSxP|D]D}||}||ko|| ||7}n|j|qWn|dk o|j| ||nddj|d}dko|| d7}n|S(uFormat an argument spec from the values returned by getargspec or getfullargspec. The first seven arguments are (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations). The other five arguments are the corresponding optional formatting functions that are called to turn names and values into strings. The last argument is an optional function to format the sequence of arguments.cs9|}|ko|d|7}n|S(Nu: ((uarguresult(uformatannotationu formatargu annotations(u$/mit/python/lib/python3.0/inspect.pyuformatargandannotationjs  u*u(u, u)ureturnN(ulenurangeustrsequappenduNoneujoin(uargsuvarargsuvarkwudefaultsu kwonlyargsukwonlydefaultsu annotationsu formatargu formatvarargsu formatvarkwu formatvalueu formatreturnsuformatannotationujoinuformatargandannotationuspecsu firstdefaultuiuspecu kwonlyarguresult((u formatarguformatannotationu annotationsu$/mit/python/lib/python3.0/inspect.pyu formatargspecYs6     cCsd|S(u*((uname((u$/mit/python/lib/python3.0/inspect.pyuscCsd|S(u**((uname((u$/mit/python/lib/python3.0/inspect.pyuscCsdt|S(u=(urepr(uvalue((u$/mit/python/lib/python3.0/inspect.pyusc Cs|||d} g} x7tt|D]#} | jt|| | |q+W|o%| j|||||n|o%| j|||||nddj| dS(ufFormat 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.cSs|||||S(N((unameulocalsu formatargu formatvalue((u$/mit/python/lib/python3.0/inspect.pyuconvertsu(u, u)(urangeulenuappendustrsequjoin( uargsuvarargsuvarkwulocalsu formatargu formatvarargsu formatvarkwu formatvalueujoinuconvertuspecsui((u$/mit/python/lib/python3.0/inspect.pyuformatargvaluess !%%u Tracebacku+filename lineno function code_context indexc Cs5t|o|j}|j}n |j}t|ptdnt|p t|}|dko|d|d}yt|\}}Wnt k od}}YqXt |d}t dt |t ||}||||}|d|}n d}}t|||jj||S(uGet 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.u&arg is not a frame or traceback objectiiiN(u istracebacku tb_linenoutb_frameuf_linenouisframeu TypeErroru getsourcefileugetfileu findsourceuIOErroruNoneumaxuminulenu Tracebackuf_codeuco_name(uframeucontextulinenoufilenameustartulinesulnumuindex((u$/mit/python/lib/python3.0/inspect.pyu getframeinfos&      " cCs|jS(uCGet the line number from a frame object, allowing for optimization.(uf_lineno(uframe((u$/mit/python/lib/python3.0/inspect.pyu getlinenoscCs?g}x2|o*|j|ft|||j}q W|S(uGet 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.(uappendu getframeinfouf_back(uframeucontextu framelist((u$/mit/python/lib/python3.0/inspect.pyugetouterframess cCsBg}x5|o-|j|jft|||j}q W|S(uGet 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.(uappendutb_frameu getframeinfoutb_next(utbucontextu framelist((u$/mit/python/lib/python3.0/inspect.pyugetinnerframess  cCsttjd|S(u@Return a list of records for the stack above the caller's frame.i(ugetouterframesusysu _getframe(ucontext((u$/mit/python/lib/python3.0/inspect.pyustackscCsttjd|S(uCReturn a list of records for the stack below the current exception.i(ugetinnerframesusysuexc_info(ucontext((u$/mit/python/lib/python3.0/inspect.pyutraces(iiii(ii i@i((^u__doc__u __author__u__date__usysuosutypesustringureudisuimputokenizeu linecacheuoperatoru attrgetteru collectionsu namedtupleu CO_OPTIMIZEDu CO_NEWLOCALSu CO_VARARGSuCO_VARKEYWORDSu CO_NESTEDu CO_GENERATORu CO_NOFREEuTPFLAGS_IS_ABSTRACTuismoduleuisclassuismethoduismethoddescriptoruisdatadescriptoruhasattruismemberdescriptoruisgetsetdescriptoru isfunctionuisgeneratorfunctionu isgeneratoru istracebackuisframeuiscodeu isbuiltinu isroutineu isabstractuNoneu getmembersu Attributeuclassify_class_attrsu _searchbasesugetmrou indentsizeugetdocucleandocugetfileu ModuleInfou getmoduleinfou getmodulenameu getsourcefileu getabsfileu modulesbyfileu_filesbymodnameu getmoduleu findsourceu getcommentsu Exceptionu EndOfBlocku BlockFinderugetblockugetsourcelinesu getsourceuwalktreeu getclasstreeu Argumentsugetargsu _getfullargsuArgSpecu getargspecu FullArgSpecugetfullargspecuArgInfou getargvaluesujoinsequstrsequformatannotationuformatannotationrelativetoustru formatargspecuformatargvaluesu Tracebacku getframeinfou getlinenougetouterframesugetinnerframesu _getframeu currentframeustackutrace(((u$/mit/python/lib/python3.0/inspect.pyus                         G         . = -'            )  !