qm.extension.Extension

Package qm :: Module extension :: Class Extension

[show private | hide private]

Type Extension

object --+
         |
        Extension

Known Subclasses:: Database, ExpectationDatabase, ResultReader, ResultStream, RunDatabase, Runnable, Suite

A class derived from 'Extension' is a QM extension.

A variety of different classes are derived from 'Extension'. All of these classes can be derived from by users to produce customized QM extensions.

'Extension' is an abstract class.

Method Summary
	`__init__(self, **args)` Construct a new 'Extension'.
	`__getattr__(self, name)`
	`GetClassName(self)` Return the name of the extension class.
	`GetExplicitArguments(self)` Return the arguments to this extension instance.
	`MakeDomDocument(self)` Create a DOM document for 'self'.
	`MakeDomElement(self, document, element)` Create a DOM node for 'self'.
	`Write(self, file)` Write an XML description of 'self' to a file.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
`type`	`__metaclass__` = `qm.extension.Type`
`list`	`arguments` = `[]`
`NoneType`	`kind` = None
`type`	`Type` = `qm.extension.Type`

Method Details

init(self, **args)
(Constructor)

Construct a new 'Extension'.

'args': Keyword arguments providing values for Extension parameters. The values should be appropriate for the corresponding fields. Derived classes must pass along any unrecognized keyword arguments to this method so that additional arguments can be added in the future without necessitating changes to derived classes.

This method will place all of the arguments into this objects instance dictionary.

Derived classes may override this method, but should call this method during their processing.

Overrides:: __builtin__.object.__init__

GetClassName(self)

Return the name of the extension class.

returns -- A string giving the name of this etension class.

GetExplicitArguments(self)

Return the arguments to this extension instance.

returns -- A dictionary mapping argument names to their values. Computed arguments are ommitted from the dictionary.

MakeDomDocument(self)

Create a DOM document for 'self'.

'extension_class' -- A class derived from 'Extension'.

'arguments' -- The arguments to the extension class.

returns -- A new DOM document corresponding to an instance of the extension class.

MakeDomElement(self, document, element=None)

Create a DOM node for 'self'.

'document' -- The DOM document that will contain the new element.

'element' -- If not 'None' the extension element to which items will be added. Otherwise, a new element will be created by this function.

returns -- A new DOM element corresponding to an instance of the extension class. The caller is responsible for attaching it to the 'document'.

Write(self, file)

Write an XML description of 'self' to a file.

'file' -- A file object to which the data should be written.

Class Variable Details

arguments

Type:: list
Value:: []

kind

Type:: NoneType
Value:: None

Generated by Epydoc 2.1 on Thu Sep 27 15:49:07 2007

http://epydoc.sf.net