qm.test.classes.pickle_result_stream.PickleResultStream

Package qm :: Package test :: Package classes :: Module pickle_result_stream :: Class PickleResultStream

[show private | hide private]

Type PickleResultStream

object --+            
         |            
 Extension --+        
             |        
  ResultStream --+    
                 |    
  FileResultStream --+
                     |
                    PickleResultStream

A 'PickleResultStream' writes out results as Python pickles.

See also 'PickleResultReader', which does the reverse.

Method Summary
	`__init__(self, **args)` Construct a new 'Extension'.
	`WriteAnnotation(self, key, value)` Output an annotation for this run.
	`WriteResult(self, result)` Output a test result.
Inherited from ResultStream
	`Summarize(self)` Output summary information about the results.
	`WriteAllAnnotations(self, annotations)` Output all annotations in 'annotations' to this stream.
Inherited from 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
`list`	`arguments` = `[<<class 'qm.fields.IntegerField'> protocol_...`
`NoneType`	`expected_outcomes` = None
`NoneType`	`file` = None
`str`	`filename` = `''`
`int`	`protocol_version` = 1
Inherited from ResultStream
`str`	`kind` = `'result_stream'`

Method Details

init(self, arguments=None, **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:: qm.test.file_result_stream.FileResultStream.__init__ (inherited documentation)

WriteAnnotation(self, key, value)

Output an annotation for this run.

Subclasses should override this if they want to store/display annotations; the default implementation simply discards them.

'key' -- the key value as a string.

'value' -- the value of this annotation as a string.

Overrides:: qm.test.result_stream.ResultStream.WriteAnnotation (inherited documentation)

WriteResult(self, result)

Output a test result.

Subclasses must override this method; the default implementation raises a 'NotImplementedError'.

'result' -- A 'Result'.

Overrides:: qm.test.result_stream.ResultStream.WriteResult (inherited documentation)

Class Variable Details

arguments

Type:: list
Value:: [<<class 'qm.fields.IntegerField'> protocol_version>]

expected_outcomes

Type:: NoneType
Value:: None

file

Type:: NoneType
Value:: None

filename

Type:: str
Value:: ''

protocol_version

Type:: int
Value:: 1

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

http://epydoc.sf.net