t.p.reflect : module documentation

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.

Returns

(type: str.)

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

Parameters	classObj	A class object from which to collect method names.
	prefix	A native string giving a prefix. Each method with a name which begins with this prefix will be returned. (type: str)
Returns	A list of the names of matching methods of classObj (and base classes of classObj). (type: list of str)

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

Parameters	classObj	A class object from which to collect method names.
	dict	A dict which will be updated with the results of the accumulation. Items are added to this dictionary, with method names as keys and 1 as values. (type: dict)
	prefix	A native string giving a prefix. Each method of classObj (and base classes of classObj) with a name which begins with this prefix will be returned. (type: str)
	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.
Returns	None

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

Parameters	obj	An arbitrary object from which to collect methods.
	prefix	A native string giving a prefix. Each method of obj with a name which begins with this prefix will be returned. (type: str)
Returns	A list of the matching method objects. (type: list)

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

Parameters	obj	An arbitrary object to collect methods from.
	dict	A 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)
	prefix	A native string giving a prefix. Each method of obj with a name which begins with this prefix will be returned. (type: str)
	curClass	The class in the inheritance hierarchy at which to start collecting methods. Collection proceeds up. To collect all methods from obj, do not pass a value for this parameter.
Returns	None

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.

Parameters	name	Module name as it would have been passed to import. (type: str.)
	default	Value returned in case ImportError is raised while importing the module.
Returns	Module or default value.

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

Parameters	importName	The name of the module to import. (type: str)
Raises	Exception	if something bad happens. This can be any type of exception, since nobody knows what loading some arbitrary code might do.
	_NoModuleFound	if no module was found.

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

Parameters	name	The name of the object to return. (type: str)
Returns	the Python object identified by 'name'.
Raises	InvalidName	If the name is an empty string, starts or ends with a '.', or is otherwise syntactically incorrect.
	ModuleNotFound	If the name is syntactically correct but the module it specifies cannot be imported because it does not appear to exist.
	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.
	AttributeError	If an attribute of an object along the way cannot be accessed, or a module along the way is not found.

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.

Parameters	fn	A filesystem path to a module or package; bytes on Python 2, bytes or unicode on Python 3.
Returns	A hopefully importable module name. (type: str)

Return full import path of a class.

Helper function for safe_repr and safe_str.

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

Parameters	o	Any object.
Returns	(type: str)

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

Parameters	o	Any object.
Returns	(type: str)

this is more documentation for myself than useful code.

Return the class or type of object 'obj'. Returns sensible result for oldstyle and newstyle instances and types.

allYourBase(classObj, baseClass=None) -> list of all base classes that are subclasses of baseClass, unless it is None, in which case all bases will be added.

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 heirarchy wins. (XXX: If "higest" 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 heirarchy into a single list.

Assuming all class attributes of this name are lists.

An insanely CPU-intensive process for finding stuff.