twisted.python.reflect : API documentation

Standardized versions of various cool and/or strange things that you can do with Python's reflection capabilities.

Function	fullyQualifiedName	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.
Class	Settable	No summary
Class	AccessorType	Metaclass that generates properties automatically.
Class	PropertyAccessor	A mixin class for Python 2.2 that uses AccessorType.
Class	Accessor	No summary
Class	Summer	Extend from this class to get the capability to maintain 'related sums'. Have a tuple in your class like the following:
Class	QueueMethod	I represent a method that doesn't exist yet.
Function	funcinfo	this is more documentation for myself than useful code.
Function	fullFuncName	Undocumented
Function	qual	Return full import path of a class.
Function	getcurrent	Undocumented
Function	getClass	Return the class or type of object 'obj'. Returns sensible result for oldstyle and newstyle instances and types.
Function	isinst	Undocumented
Function	namedModule	Return a module given its name.
Function	namedObject	Get a fully named module-global object.
Class	InvalidName	The given name is not a dot-separated list of Python objects.
Class	ModuleNotFound	The module associated with the given name doesn't exist and it can't be imported.
Class	ObjectNotFound	The object associated with the given name doesn't exist and it can't be imported.
Function	namedAny	No summary
Function	macro	macro(name, source, **identifiers)
Function	safe_repr	safe_repr(anything) -> string
Function	safe_str	safe_str(anything) -> string
Function	allYourBase	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.
Function	accumulateBases	Undocumented
Function	prefixedMethodNames	A list of method names with a given prefix in a given class.
Function	addMethodNamesToDict	No summary
Function	prefixedMethods	A list of methods with a given prefix on a given instance.
Function	accumulateMethods	No summary
Function	accumulateClassDict	Accumulate all attributes of a given name in a class heirarchy into a single dictionary.
Function	accumulateClassList	Accumulate all attributes of a given name in a class heirarchy into a single list.
Function	isSame	Undocumented
Function	isLike	Undocumented
Function	modgrep	Undocumented
Function	isOfType	Undocumented
Function	findInstances	Undocumented
Function	objgrep	An insanely CPU-intensive process for finding stuff.
Function	filenameToModuleName	Convert a name in the filesystem to the name of the Python module it is.
Class	_NoModuleFound	No module was found because none exists.
Function	_importAndCheckStack	No summary
Function	_determineClass	Undocumented
Function	_determineClassName	Undocumented
Function	_safeFormat	Helper function for `safe_repr` and `safe_str`.
Function	_accumulateBases	Undocumented

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

this is more documentation for myself than useful code.

Return full import path of a class.

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

Return a module given its name.

Get a fully named module-global object.

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

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.

macro(name, source, **identifiers)

This allows you to create macro-like behaviors in python.

Helper function for safe_repr and safe_str.

safe_repr(anything) -> string

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

safe_str(anything) -> string

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

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.

A list of method names with a given prefix in a given class.

addMethodNamesToDict(classObj, dict, prefix, baseClass=None) -> dict 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}.

A list of methods with a given prefix on a given instance.

accumulateMethods(instance, dict, prefix) I recurse through the bases of instance.__class__, and add methods beginning with 'prefix' to 'dict', in the form of {'methodname':*instance*method_object}.

Accumulate all attributes of a given name in a class heirarchy 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.

Convert a name in the filesystem to the name of the Python module it is.

This is agressive about getting a module name back from a file; it will always return a string. Agressive 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.

t.p.reflect : module documentation