buildbot.status.progress.StepProgress

Package buildbot :: Package status :: Module progress :: Class StepProgress

Class StepProgress

I keep track of how much progress a single BuildStep has made.

Progress is measured along various axes. Time consumed is one that is available for all steps. Amount of command output is another, and may be better quantified by scanning the output for markers to derive number of files compiled, directories walked, tests run, etc.

I am created when the build begins, and given to a BuildProgress object so it can track the overall progress of the whole build.

Method Summary
	`__init__(self, name, metricNames)`
	`finish(self)` This stops the 'time' metric and marks the step as finished overall.
	`remaining(self)`
	`setBuildProgress(self, bp)`
	`setExpectations(self, metrics)` The step can call this to explicitly set a target value for one of its metrics.
	`setExpectedTime(self, seconds)`
	`setProgress(self, metric, value)` The step calls this as progress is made along various axes.
	`start(self)`
	`totalTime(self)`

Class Variable Summary
`NoneType`	`buildProgress` = None
`bool`	`debug` = `False`
`NoneType`	`expectedTime` = None
`NoneType`	`startTime` = None
`NoneType`	`stopTime` = None

Method Details

finish(self)

This stops the 'time' metric and marks the step as finished overall. It should be called after the last .setProgress has been done for each axis.

setExpectations(self, metrics)

The step can call this to explicitly set a target value for one of its metrics. E.g., ShellCommands knows how many commands it will execute, so it could set the 'commands' expectation.

setProgress(self, metric, value)

The step calls this as progress is made along various axes.

Class Variable Details

buildProgress

Type:: NoneType
Value:: None

debug

Type:: bool
Value:: False

expectedTime

Type:: NoneType
Value:: None

startTime

Type:: NoneType
Value:: None

stopTime

Type:: NoneType
Value:: None

Generated by Epydoc 2.1 on Sun Dec 10 22:04:45 2006

http://epydoc.sf.net