Package perforce :: Module results :: Class Results

Class Results

object --+
         |
        Results

A utility class for storing the results of a Perforce command.

This class is adaptable to the IOutputConsumer class.

Instance Methods

__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

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

Instance Variables
`list` of perforce.Message, perforce.forms.Form, `dict` and FileData objects.	all A list of all events (messages, records, fileChunks and forms) output from a Perforce command in the order they occurred.
`list` of perforce.Message objects.	errors A list of all error messages output from a Perforce command.
`list` of FileData objects.	fileChunks A list of file chunks output from a Perforce command.
`list` of perforce.forms.Form objects.	forms A list of forms output from a Perforce command.
`list` of perforce.Message objects.	infos A list of all info messages output from a Perforce command in the order they occurred.
`list` of perforce.Message objects.	messages A list of all messages output from a Perforce command in the order they occurred.
`list` of `dict` objects.	records A list of the records output from a Perforce command.
`list` of perforce.Message objects.	warnings A list of all warning messages output from a Perforce command.

Properties
Inherited from `object`: `__class__`

Method Details

init(self)
(Constructor)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

Instance Variable Details

errors

A list of all error messages output from a Perforce command. Error messages are output when an operation fails for some reason.

fileChunks

A list of file chunks output from a Perforce command. File chunks are typically output from 'print' commands. A file chunk is either text or binary.

forms

A list of forms output from a Perforce command. Typically only one form is output per command, however a list is used here so that the same Results object can be used for multiple commands.

infos

A list of all info messages output from a Perforce command in the order they occurred. Info messages are typically output when something succeeds.

records

A list of the records output from a Perforce command. Records are typically output from commands that request information about Perforce entities.

warnings

A list of all warning messages output from a Perforce command. Warning messages are typically output when an operation fails partially or in a non-critical way. eg. a 'sync' operation reporting that 'all file(s) are up to date'.