buildbot.status.builder.BuildStepStatus

Package buildbot :: Package status :: Module builder :: Class BuildStepStatus

Class BuildStepStatus

Versioned --+
            |
           BuildStepStatus

I represent a collection of output status for a buildbot.process.step.BuildStep.

Statistics contain any information gleaned from a step that is not in the form of a logfile. As an example, steps that run tests might gather statistics about the number of passed, failed, or skipped tests.

Method Summary
	`__init__(self, parent)`
	`__getstate__(self)`
	`__setstate__(self, d)`
	`addHTMLLog(self, name, html)`
	`addLog(self, name)`
	`addURL(self, name, url)`
	`getBuild(self)`
	`getColor(self)` Returns a single string with the color that should be used to display this step.
	`getETA(self)`
	`getExpectations(self)` Returns a list of tuples (name, current, target).
	`getLogs(self)`
	`getName(self)` Returns a short string with the name of this step.
tuple of int, list of strings	`getResults(self)` Return a tuple describing the results of the step.
	`getStatistic(self, name, default)` Return the given statistic, if present
	`getText(self)` Returns a list of strings which describe the step.
	`getTimes(self)`
	`getURLs(self)`
	`hasStatistic(self, name)` Return true if this step has a value for the given statistic.
	`isFinished(self)`
	`logFinished(self, log)`
	`sendETAUpdate(self, receiver, updateInterval)`
	`setColor(self, color)`
	`setName(self, stepname)`
	`setProgress(self, stepprogress)`
	`setStatistic(self, name, value)` Set the given statistic.
	`setText(self, text)`
	`setText2(self, text)`
	`stepFinished(self, results)`
	`stepStarted(self)`
	`subscribe(self, receiver, updateInterval)`
	`unsubscribe(self, receiver)`
	`upgradeToVersion1(self)`
	`upgradeToVersion2(self)`
	`waitUntilFinished(self)`
Inherited from Versioned
	`versionUpgrade(self)` (internal) Do a version upgrade.

Instance Variable Summary
dict of string -> `buildbot.status.builder.LogFile`	`logs`: logs of steps
dict	`statistics`: results from running this step

Class Variable Summary
`Implements`	`__implemented__` = `<implementedBy buildbot.status.builder...`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
string	`color`: color that this step feels best represents its current mood.
`NoneType`	`finished` = None
`list`	`finishedWatchers` = `[]`
`int`	`persistenceVersion` = 2
`buildbot.status.progress.StepProgress`	`progress`: tracks ETA for the step
`tuple`	`results` = `(None, [])`
`NoneType`	`started` = None
list of strings	`text`: list of short texts that describe the command and its status
list of strings	`text2`: list of short texts added to the overall build description
`dict`	`updates` = `{}`
`list`	`watchers` = `[]`
Inherited from Versioned
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`
`tuple`	`persistenceForgets` = `()`

Method Details

getColor(self)

Returns a single string with the color that should be used to display this step. 'green', 'orange', 'red', 'yellow' and 'purple' are the most likely ones.

getExpectations(self)

Returns a list of tuples (name, current, target).

getName(self)

Returns a short string with the name of this step. This string may have spaces in it.

getResults(self)

Return a tuple describing the results of the step. '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.

Returns:: (result, strings)
(type=tuple of int, list of strings)

getStatistic(self, name, default=None)

Return the given statistic, if present

getText(self)

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.

hasStatistic(self, name)

Return true if this step has a value for the given statistic.

setStatistic(self, name, value)

Set the given statistic. Usually called by subclasses.

Instance Variable Details

logs

logs of steps

Type:: dict of string -> buildbot.status.builder.LogFile

statistics

results from running this step

Type:: dict
Value:: {}

Class Variable Details

implemented

Type:: Implements
Value:: <implementedBy buildbot.status.builder.BuildStepStatus>

provides

Type:: ClassProvides
Value:: <zope.interface.declarations.ClassProvides object at 0x2b917801e190>

color

color that this step feels best represents its current mood. yellow,green,red,orange are the most likely choices, although purple indicates an exception

Type:: string
Value:: None

finished

Type:: NoneType
Value:: None

finishedWatchers

Type:: list
Value:: []

persistenceVersion

Type:: int
Value:: 2

progress

tracks ETA for the step

Type:: buildbot.status.progress.StepProgress
Value:: None

results

Type:: tuple
Value:: (None, [])

started

Type:: NoneType
Value:: None

text

list of short texts that describe the command and its status

Type:: list of strings
Value:: []

text2

list of short texts added to the overall build description

Type:: list of strings
Value:: []

updates

Type:: dict
Value:: {}

watchers

Type:: list
Value:: []

Generated by Epydoc 2.1 on Tue Sep 16 09:15:59 2008

http://epydoc.sf.net