o bP@sdZddlZddlZddlZddlZddlZddlZddlZddlm Z ddl m Z m Z ddl mZmZddlmZddlmZeedZd d ZdKd d ZdLd dZdMddZddZddZeZdKddZGddde Z!Gddde"Z#Gddde#Z$Gddde#Z%dd Z&d!d"Z'd#d$Z(d%d&Z)d'd(Z*d)d*Z+d+eej,ee-fd,e.d-e-fd.d/Z/d0d1Z0d,e.d-e-fd2d3Z1Gd4d5d5Z2d6d7Z3d8d9Z4dKd:d;Z5dKdd?Z7d@dAZ8dBdCZ9dDdEZ:dFdGZ;e8dddddfdHdIZdIdS)Nzt Standardized versions of various cool and/or strange things that you can do with Python's reflection capabilities. N)deque)IOBaseStringIO)TypeUnion) nativeString)_fullyQualifiedNamecCi}t|||t|S)a Given a class object C{classObj}, returns a list of method names that match the string C{prefix}. @param classObj: A class object from which to collect method names. @param prefix: A native string giving a prefix. Each method with a name which begins with this prefix will be returned. @type prefix: L{str} @return: A list of the names of matching methods of C{classObj} (and base classes of C{classObj}). @rtype: L{list} of L{str} )addMethodNamesToDictlistkeys)classObjprefixdctr8/usr/lib/python3/dist-packages/twisted/python/reflect.pyprefixedMethodNamess  rcCs|jD] }t||||q|dus||jvrA|jD]'\}}|t|d}t|tjur@|dt||kr@t|r@d||<qdSdS)aJ This goes through C{classObj} (and its bases) and puts method names starting with 'prefix' in 'dict' with a value of 1. if baseClass isn't None, methods will only be added if classObj is-a baseClass If the class in question has the methods 'prefix_methodname' and 'prefix_methodname2', the resulting dict should look something like: {"methodname": 1, "methodname2": 1}. @param classObj: A class object from which to collect method names. @param dict: A L{dict} which will be updated with the results of the accumulation. Items are added to this dictionary, with method names as keys and C{1} as values. @type dict: L{dict} @param prefix: A native string giving a prefix. Each method of C{classObj} (and base classes of C{classObj}) with a name which begins with this prefix will be returned. @type prefix: L{str} @param baseClass: A class object at which to stop searching upwards for new methods. To collect all method names, do not pass a value for this parameter. @return: L{None} N) __bases__r __dict__itemslentypetypes FunctionType)rdictr baseClassbasenamemethodoptNamerrrr 0s r cCr )a Given an object C{obj}, returns a list of method objects that match the string C{prefix}. @param obj: An arbitrary object from which to collect methods. @param prefix: A native string giving a prefix. Each method of C{obj} with a name which begins with this prefix will be returned. @type prefix: L{str} @return: A list of the matching method objects. @rtype: L{list} )accumulateMethodsr values)objrrrrrprefixedMethodsZs  r%cCs|s|j}|jD] }|turt||||q|jD](\}}|t|d}t|tj urC|dt||krCt|rCt ||||<qdS)a Given an object C{obj}, add all methods that begin with C{prefix}. @param obj: An arbitrary object to collect methods from. @param dict: A L{dict} which will be updated with the results of the accumulation. Items are added to this dictionary, with method names as keys and corresponding instance method objects as values. @type dict: L{dict} @param prefix: A native string giving a prefix. Each method of C{obj} with a name which begins with this prefix will be returned. @type prefix: L{str} @param curClass: The class in the inheritance hierarchy at which to start collecting methods. Collection proceeds up. To collect all methods from C{obj}, do not pass a value for this parameter. @return: L{None} N) __class__robjectr"rrrrrrgetattr)r$rrcurClassrrr r!rrrr"ms r"cCs6t|}|ddd}|}|D]}t||}q|S)z) Return a module given its name. .rN) __import__splitr()rtopLevelpackagesmprrr namedModules  r1cCs.|d}td|dd}t||dS)z1 Get a fully named module-global object. r*N)r,r1joinr()r classSplitmodulerrr namedObjects r6cCs"zt|WSty|YSw)ak Try to import a module given its name, returning C{default} value if C{ImportError} is raised during import. @param name: Module name as it would have been passed to C{import}. @type name: C{str}. @param default: Value returned in case C{ImportError} is raised while importing the module. @return: Module or default value. )r1 ImportError)rdefaultrrr requireModules   r9c@eZdZdZdS)_NoModuleFoundz2 No module was found because none exists. N__name__ __module__ __qualname____doc__rrrrr;r;c@r:) InvalidNamezG The given name is not a dot-separated list of Python objects. Nr<rrrrrBrArBc@r:)ModuleNotFoundz_ The module associated with the given name doesn't exist and it can't be imported. Nr<rrrrrCrArCc@r:)ObjectNotFoundz_ The object associated with the given name doesn't exist and it can't be imported. Nr<rrrrrDrArDcCsZzt|WSty,t\}}}|r)|jjd}||kr$|||j}|stw)a Import the given name as a module, then walk the stack to determine whether the failure was the module not existing, or some code in the module (for example a dependent import) failing. This can be helpful to determine whether any actual application code was run. For example, to distiguish administrative error (entering the wrong module name), from programmer error (writing buggy code in a module that fails to import). @param importName: The name of the module to import. @type importName: C{str} @raise Exception: if something bad happens. This can be any type of exception, since nobody knows what loading some arbitrary code might do. @raise _NoModuleFound: if no module was found. r=) r+r7sysexc_infotb_frame f_globalswith_tracebacktb_nextr;) importNameexcTypeexcValue excTracebackexecNamerrr_importAndCheckStacks    rPcCs|std|d}d|vrtd|fd}|dd}|sQ|r;d|}zt|}Wn!ty:|Ynwt|dkrHtd|t|d|r |}|ddD]}t ||}qY|S) a Retrieve a Python object by its fully qualified name from the global Python module namespace. The first part of the name, that describes a module, will be discovered and imported. Each subsequent part of the name is treated as the name of an attribute of the object specified by all of the name which came before it. For example, the fully-qualified name of this object is 'twisted.python.reflect.namedAny'. @type name: L{str} @param name: The name of the object to return. @raise InvalidName: If the name is an empty string, starts or ends with a '.', or is otherwise syntactically incorrect. @raise ModuleNotFound: If the name is syntactically correct but the module it specifies cannot be imported because it does not appear to exist. @raise ObjectNotFound: If the name is syntactically correct, includes at least one '.', but the module it specifies cannot be imported because it does not appear to exist. @raise AttributeError: If an attribute of an object along the way cannot be accessed, or a module along the way is not found. @return: the Python object identified by 'name'. zEmpty module namer*r zOname must be a string giving a '.'-separated list of Python identifiers, not %rNrzNo module named z does not name an object) rBr,r3rPr;poprrCrDr()rnamestopLevelPackage moduleNames trialnamer$nrrrnamedAnys6         rWcCst|trd}nd}tj|}tj|}|s"tj|dd}ttj|d} tj|}tj tj ||rMd ttj|t|}n |Sq-)aY Convert a name in the filesystem to the name of the Python module it is. This is aggressive about getting a module name back from a file; it will always return a string. Aggressive means 'sometimes wrong'; it won't look at the Python path or try to do any error checking: don't use this method unless you already know that the filename you're talking about is a Python module. @param fn: A filesystem path to a module or package; C{bytes} on Python 2, C{bytes} or C{unicode} on Python 3. @return: A hopefully importable module name. @rtype: C{str} s __init__.pyz __init__.pyNr2rrz{}.{}) isinstancebytesospathabspathbasenamersplitextdirnameexistsr3format)fninitPyfullNamermodNamerrrfilenameToModuleName9s$    rfcCs|jd|jS)z- Return full import path of a class. r*)r>r=)clazzrrrqual_srhcCs$z|jWStyt|YSwN)r& BaseExceptionr)xrrr_determineClassfs   rlc CsRt|}z|jWSty(zt|WYSty'dt|YYSww)Nz)rlr=rjstrid)rkcrrr_determineClassNamems  rp formatteroreturncCs8t}tj|dt|}|}d|t||j|S)a} Helper function for L{safe_repr} and L{safe_str}. Called when C{repr} or C{str} fail. Returns a string containing info about C{o} and the latest exception. @param formatter: C{str} or C{repr}. @type formatter: C{type} @param o: Any object. @rtype: C{str} @return: A string containing information about C{o} and the raised exception. )filez*<{} instance at 0x{:x} with {} error: {}>)r traceback print_excrpgetvaluerarnr=)rqrrio classNametbValuerrr _safeFormatxs r{cCs(zt|WStytt|YSw)z Returns a string representation of an object, or a string containing a traceback, if that object's __repr__ raised an exception. @param o: Any object. @rtype: C{str} )reprrjr{rrrrr safe_reprs   r~cCsRt|trz|dWStyYnwzt|WSty(tt|YSw)z Returns a string representation of an object, or a string containing a traceback, if that object's __str__ raised an exception. @param o: Any object. zutf-8)rXrYdecoderjrmr{r}rrrsafe_strs     rc@s eZdZdZddZddZdS) QueueMethodz6 I represent a method that doesn't exist yet. cCs||_||_dSri)rcalls)selfrrrrr__init__s zQueueMethod.__init__cGs|j|j|fdSri)rappendr)rargsrrr__call__szQueueMethod.__call__N)r=r>r?r@rrrrrrrs rcCsBtt||jd|j}t||urtd|d|d|S)Nr*zCouldn't find z as )rmpickle whichmoduler=r6 Exception)funcqualNamerrr fullFuncNames rcCst|S)z3 Return the class or type of object 'obj'. r)r$rrrgetClasssrcCsF|jD]}t|||q|dus||jvr!||j|idSdS)a Accumulate all attributes of a given name in a class hierarchy into a single dictionary. Assuming all class attributes of this name are dictionaries. If any of the dictionaries being accumulated have the same key, the one highest in the class hierarchy wins. (XXX: If "highest" means "closest to the starting class".) Ex:: class Soy: properties = {"taste": "bland"} class Plant: properties = {"colour": "green"} class Seaweed(Plant): pass class Lunch(Soy, Seaweed): properties = {"vegan": 1 } dct = {} accumulateClassDict(Lunch, "properties", dct) print(dct) {"taste": "bland", "colour": "green", "vegan": 1} N)raccumulateClassDictupdaterget)rattradictrrrrrrs rcCsF|jD]}t|||q|dus||jvr!||j|gdSdS)z Accumulate all attributes of a given name in a class hierarchy into a single list. Assuming all class attributes of this name are lists. N)raccumulateClassListextendrr)rrlistObjrrrrrrs rcCs||uSrirabrrrisSamercCs||kSrirrrrrisLikerrcCsttj|tdS)Nz sys.modules)objgreprEmodulesr)goalrrrmodgrep srcCs t||uSrir)startrrrrisOfType rcCs t||tSri)rr)rtrrr findInstancesrrc Csd|durg}|dur i}|||r||t||vr&|t||ur&dS|dur4|dkr0dS|d8}||t|<||||f}t|trv|D]*\} } t| |||dt| dg|Rt| |||dt| dg|RqI|St|ttt frt |D]\} } t|| |||dt | dg|Rq|St|t j rt|j|||dg|Rt|j|||d g|Rt|jj|||d g|R|St|d r|jD]\} } t| |||d | g|Rq|St|tjrt||||d g|R|St|t tt jt jtttdtfs"t|jdvr% |S|r0tdt|||S)a L{objgrep} finds paths between C{start} and C{goal}. Starting at the python object C{start}, we will loop over every reachable reference, tring to find the python object C{goal} (i.e. every object C{candidate} for whom C{eq(candidate, goal)} is truthy), and return a L{list} of L{str}, where each L{str} is Python syntax for a path between C{start} and C{goal}. Since this can be slightly difficult to visualize, here's an example:: >>> class Holder: ... def __init__(self, x): ... self.x = x ... >>> start = Holder({"irrelevant": "ignore", ... "relevant": [7, 1, 3, 5, 7]}) >>> for path in objgrep(start, 7): ... print("start" + path) start.x['relevant'][0] start.x['relevant'][4] This can be useful, for example, when debugging stateful graphs of objects attached to a socket, trying to figure out where a particular connection is attached. @param start: The object to start looking at. @param goal: The object to search for. @param eq: A 2-argument predicate which takes an object found by traversing references starting at C{start}, as well as C{goal}, and returns a boolean. @param path: The prefix of the path to include in every return value; empty by default. @param paths: The result object to append values to; a list of strings. @param seen: A dictionary mapping ints (object IDs) to objects already seen. @param showUnknowns: if true, print a message to C{stdout} when encountering objects that C{objgrep} does not know how to traverse. @param maxDepth: The maximum number of object references to attempt traversing before giving up. If an integer, limit to that many links, if C{None}, unlimited. @return: A list of strings representing python object paths starting at C{start} and terminating at C{goal}. Nrr{}[]z .__self__z .__func__z.__self__.__class__rr*z())wrapper_descriptormethod_descriptormember_descriptorgetset_descriptorz unknown type)rrnrXrrrr|r tupler enumeratermr MethodType__self____func__r&hasattrrweakref ReferenceTypeintrBuiltinMethodType RegexTypefloatrrr=print) rreqr[pathsseen showUnknownsmaxDepthrkvidx_elemrrrrsl>      &(",    r)rBrCrDrr1r6 namedClassrWr9r~rrr r%r"rrhrrrrrrrrrrffullyQualifiedNameri)r )r N)?r@rZrrerErurr collectionsrrxrrtypingrrtwisted.python.compatrtwisted.python.deprecaterrrcompilerrr r%r"r1r6rr9rr; ValueErrorrBrCrDrPrWrfrhrlrprrmr'r{r~rrrrrrrrrrrr__all__removerrrrsl     * +  @&$    %  w!