Trees | Indices | Help |
|
---|
|
zope.interface.Interface --+ | IBuildStepStatus
I hold status for a single BuildStep.
Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Class Variables | |
__bases__ =
|
|
__identifier__ =
|
|
__iro__ =
|
|
__name__ =
|
|
__sro__ =
|
|
dependents = <WeakKeyDictionary at 50967544>
|
Method Details |
Returns a short string with the name of this step. This string may have spaces in it. |
Returns a tuple of (start, end). 'start' and 'end' are the times (seconds since the epoch) when the Step started and finished. If the step has not yet started, 'start' will be None. If the step is still running, 'end' will be None. |
Returns a list of tuples (name, current, target). Each tuple describes a single axis along which the step's progress can be measured. 'name' is a string which describes the axis itself, like 'filesCompiled' or 'tests run' or 'bytes of output'. 'current' is a number with the progress made so far, while 'target' is the value that we expect (based upon past experience) to get to when the build is finished. 'current' will change over time until the step is finished. It is 'None' until the step starts. When the build is finished, 'current' may or may not equal 'target' (which is merely the expectation based upon previous builds). |
Returns a dictionary of URLs. Each key is a link name (a short string, like 'results' or 'coverage'), and each value is a URL. These links will be displayed along with the LogFiles. |
Returns a list of IStatusLog objects. If the step has not yet finished, this list may be incomplete (asking again later may give you more of them). |
Return a boolean. True means the step has finished, False means it is still running. |
Return a Deferred that will fire when the step finishes. If the step has already finished, this deferred will fire right away. The callback is given this IBuildStepStatus instance as an argument. |
Returns the number of seconds from now in which the step is expected to finish, or None if we can't make a guess. This guess will be refined over time. |
Returns a list of strings which describe the step. These are intended to be displayed in a narrow column. If more space is available, the caller should join them together with spaces before presenting them to the user. |
Return a tuple describing the results of the step: (result, strings). 'result' is one of the constants in buildbot.status.builder: SUCCESS, WARNINGS, FAILURE, or SKIPPED. 'strings' is an optional list of strings that the step wants to append to the overall build's results. These strings are usually more terse than the ones returned by getText(): in particular, successful Steps do not usually contribute any text to the overall build. |
Register an IStatusReceiver to receive new status events. The receiver will be given logStarted and logFinished messages. It will also be given a ETAUpdate message every 'updateInterval' seconds. |
Unregister an IStatusReceiver. No further status messgaes will be delivered. |
Class Variable Details |
__iro__
|
__sro__
|
Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Wed Nov 21 16:22:43 2012 | http://epydoc.sourceforge.net |