twisted.python.reflect

Return the fully qualified name of a module, class, method or function. Classes and functions need to be module level ones to be correctly qualified.

Given a class object classObj, returns a list of method names that match the string prefix.

This goes through 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}.

Given an object obj, returns a list of method objects that match the string prefix.

Given an object obj, add all methods that begin with prefix.

Return a module given its name.

Get a fully named module-global object.

Try to import a module given its name, returning default value if ImportError is raised during import.

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'.

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.

Return full import path of a class.

Returns a string representation of an object, or a string containing a traceback, if that object's __repr__ raised an exception.

Returns a string representation of an object, or a string containing a traceback, if that object's __str__ raised an exception.

Undocumented

Return the class or type of object 'obj'.

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}

Accumulate all attributes of a given name in a class hierarchy into a single list.

Assuming all class attributes of this name are lists.

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

objgrep finds paths between start and goal.

Starting at the python object start, we will loop over every reachable reference, tring to find the python object goal (i.e. every object candidate for whom eq(candidate, goal) is truthy), and return a list of str, where each str is Python syntax for a path between start and 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.