Home       Trees       Indices       Help   
Package qm :: Package test :: Package classes :: Module text_result_stream :: Class TextResultStream
[hide private]
[frames] | no frames]

Class TextResultStream

source code

                 object --+            
                          |            
        extension.Extension --+        
                              |        
     result_stream.ResultStream --+    
                                  |    
file_result_stream.FileResultStream --+
                                      |
                                     TextResultStream

A 'TextResultStream' displays test results textually.

A 'TextResultStream' displays information textually, in human readable form. This 'ResultStream' is used when QMTest is run without a graphical user interface.

Nested Classes [hide private]

Inherited from extension.Extension: Type, __metaclass__

Instance Methods [hide private]
 
__init__(self, arguments=None, **args)
Construct a 'TextResultStream'.		 source code
 
WriteResult(self, result)
Output a test or resource result.		 source code
 
Summarize(self)
Output summary information about the results.		 source code
 
_DisplayStatistics(self)
Write out statistical information about the results.		 source code
 
_SummarizeTestStats(self)
Generate statistics about the overall results.		 source code
 
_SummarizeRelativeTestStats(self)
Generate statistics showing results relative to expectations.		 source code
 
_FormatStatistics(self, format)
Output statistical information.		 source code
 
_SummarizeResults(self, results)
Summarize each of the results.		 source code
 
_DisplayResult(self, result, format)
Display 'result'.		 source code
 
_DisplayAnnotations(self, result)
Display the annotations associated with 'result'.		 source code
 
_WriteOutcome(self, name, kind, outcome, expected_outcome=None)
Write a line indicating the outcome of a test or resource.		 source code
 
_DisplayHeading(self, heading)
Display 'heading'.		 source code

Inherited from result_stream.ResultStream: WriteAllAnnotations, WriteAnnotation

Inherited from result_stream.ResultStream (private): _GetExpectedOutcome

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]
  arguments = [qm.fields.EnumerationField(name= "format", title=...
A list of the arguments to the extension class.

Inherited from file_result_stream.FileResultStream: file, filename

Inherited from file_result_stream.FileResultStream (private): _argument_dictionary, _argument_list, _is_binary_file

Inherited from result_stream.ResultStream: expected_outcomes, kind

Inherited from extension.Extension (private): _allow_arg_names_matching_class_vars

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, arguments=None, **args)
(Constructor)

source code 

Construct a 'TextResultStream'.

'args' -- As for 'Extension.__init__'.

Overrides: object.__init__

WriteResult(self, result)

source code 

Output a test or resource 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.

Overrides: result_stream.ResultStream.Summarize

_DisplayStatistics(self)

source code 

Write out statistical information about the results.

Write out statistical information about the results.

_FormatStatistics(self, format)

source code 

Output statistical information.

'format' -- A format string with (optional) fill-ins corresponding to statistical information.

The formatted string is written to the result file.

_SummarizeResults(self, results)

source code 

Summarize each of the results.

'results' -- The sequence of 'Result' objects to summarize.

_DisplayResult(self, result, format)

source code 

Display 'result'.

'result' -- The 'Result' of a test or resource execution.

'format' -- The format to use when displaying results.

_DisplayAnnotations(self, result)

source code 

Display the annotations associated with 'result'.

'result' -- The 'Result' to dispay.

_WriteOutcome(self, name, kind, outcome, expected_outcome=None)

source code 

Write a line indicating the outcome of a test or resource.

'name' -- The name of the test or resource.

'kind' -- The kind of result being displayed.

'outcome' -- A string giving the outcome.

'expected_outcome' -- If not 'None', the expected outcome.

_DisplayHeading(self, heading)

source code 

Display 'heading'.

'heading' -- The string to use as a heading for the next section of the report.


Class Variable Details [hide private]

arguments

A list of the arguments to the extension class.

Each element of this list should be an instance of 'Field'. The 'Field' instance describes the argument.

Derived classes may redefine this class variable. However, derived classes should not explicitly include the arguments from base classes; QMTest will automatically combine all the arguments found throughout the class hierarchy.

Value:
[qm.fields.EnumerationField(name= "format", title= "Format", descripti\
on= """The output format used by this result stream.

            There are three sections to the output:

            (S) Summary statistics.

            (I) Individual test-by-test results.
...

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Dec 23 12:30:41 2011 http://epydoc.sourceforge.net