Package qm :: Package test :: Package web :: Module web :: Class StorageResultsStream
[hide private]
[frames] | no frames]

Class StorageResultsStream

source code

            object --+        
                     |        
   extension.Extension --+    
                         |    
result_stream.ResultStream --+
                             |
                            StorageResultsStream

A 'StorageResultsStream' stores results.

A 'StorageResultsStream' does not write any output. It simply stores the results for future display.

Nested Classes [hide private]

Inherited from extension.Extension: Type, __metaclass__

Instance Methods [hide private]
 
__init__(self)
Construct a 'StorageResultsStream'.
source code
 
GetAnnotations(self)
Return the annotations for this run.
source code
 
WriteAnnotation(self, key, value)
Output an annotation for this run.
source code
 
WriteResult(self, result)
Output a test result.
source code
 
Summarize(self)
Output summary information about the results.
source code
 
Start(self, test_ids)
Start collecting results.
source code
 
IsFinished(self)
Return true iff no more results are forthcoming.
source code
 
GetTestResults(self)
Return the accumulated test results.
source code
 
GetTestResultsInOrder(self)
Return the test results in the order they appeared.
source code
 
GetResourceResults(self)
Return the accumulated resource results.
source code
 
GetResult(self, name)
Return the 'Result' with the indicated 'name'.
source code

Inherited from result_stream.ResultStream: WriteAllAnnotations

Inherited from extension.Extension: GetClassName, GetExplicitArguments, MakeDomDocument, MakeDomElement, Write, __getattr__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from result_stream.ResultStream: expected_outcomes, kind

Inherited from extension.Extension: arguments

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

Construct a 'StorageResultsStream'.

Overrides: object.__init__

WriteAnnotation(self, key, value)

source code 

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: result_stream.ResultStream.WriteAnnotation
(inherited documentation)

WriteResult(self, result)

source code 

Output a test result.

'result' -- A 'Result'.

Overrides: result_stream.ResultStream.WriteResult

Summarize(self)

source code 

Output summary information about the results.

When this method is called, the test run is complete. Summary information should be displayed for the user, if appropriate. Any finalization, such as the closing of open files, should also be performed at this point.

Derived class methods may override this method. They should, however, invoke this version before returning.

Overrides: result_stream.ResultStream.Summarize

Start(self, test_ids)

source code 

Start collecting results.

'test_ids' -- The names of the tests that we are about to run.

Start collecting new results. Discard results for the 'test_ids', but not for other tests.

IsFinished(self)

source code 

Return true iff no more results are forthcoming.

returns -- True if no more results will be written to this stream.

GetTestResults(self)

source code 

Return the accumulated test results.

returns -- A dictionary mapping test names to 'Result' objects.

GetTestResultsInOrder(self)

source code 

Return the test results in the order they appeared.

returns -- A sequence of test results, in the order that they appeared.

GetResourceResults(self)

source code 

Return the accumulated resource results.

returns -- A dictionary mapping resource names to 'Result' objects.

GetResult(self, name)

source code 

Return the 'Result' with the indicated 'name'.

'name' -- A string giving the name of a test or resource result.

returns -- The 'Result' instance corresponding to 'name'.