Package qm :: Package test :: Module file_result_stream :: Class FileResultStream

Class FileResultStream

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

Known Subclasses:

A 'FileResultStream' writes its output to a file.

A 'FileResultStream' is an abstract base class for other result stream classes that store results in a single file. The file to which results should be written can be specified using either the 'filename' argument or the 'file' argument. The latter is for use by QMTest internally.

Nested Classes

[hide private]

Inherited from extension.Extension: Type, __metaclass__

Instance Methods

[hide private]

__init__(self, arguments=None, **args)
Construct a new 'Extension'.

source code

Inherited from result_stream.ResultStream: Summarize, WriteAllAnnotations, WriteAnnotation, WriteResult

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 = [<<class 'qm.fields.TextField'> filename>, <<class...
A list of the arguments to the extension class.

_is_binary_file = 0
If true, the file written is a binary file.

_argument_dictionary = {'expected_outcomes': <<class 'qm.field...
A map from argument names to 'Field' instances.

_argument_list = [<<class 'qm.fields.PythonField'> expected_ou...
A list of all the 'Field's in this class.

file = None
hash(x)

filename = ''

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 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: object.__init__: (inherited documentation)

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:

[<<class 'qm.fields.TextField'> filename>,
 <<class 'qm.fields.PythonField'> file>]

_is_binary_file

If true, the file written is a binary file.

This flag can be overridden by derived classes.

Value:

_argument_dictionary

A map from argument names to 'Field' instances.

A map from the names of arguments for this class to the corresponding 'Field'.

Value:

{'expected_outcomes': <<class 'qm.fields.PythonField'> expected_outcom
es>,
 'file': <<class 'qm.fields.PythonField'> file>,
 'filename': <<class 'qm.fields.TextField'> filename>}

_argument_list

A list of all the 'Field's in this class.

This list combines the complete list of 'arguments'. 'Field's appear in the order reached by a pre-order breadth-first traversal of the hierarchy, starting from the most derived class.

Value:

[<<class 'qm.fields.PythonField'> expected_outcomes>,
 <<class 'qm.fields.PythonField'> file>,
 <<class 'qm.fields.TextField'> filename>]

Class FileResultStream

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

arguments

_is_binary_file

_argument_dictionary

_argument_list

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