buildbot.steps.python.BuildEPYDoc

Package buildbot :: Package steps :: Module python :: Class BuildEPYDoc

Class BuildEPYDoc

   BuildStep --+        
               |        
LoggingBuildStep --+    
                   |    
        ShellCommand --+
                       |
                      BuildEPYDoc

Method Summary
	`createSummary(self, log)` To create summary logs, do something like this: warnings = grep('^Warning:', log.getText()) self.addCompleteLog('warnings', warnings)
	`evaluateCommand(self, cmd)` Decide whether the command was SUCCESS, WARNINGS, or FAILURE.
Inherited from ShellCommand
	`__init__(self, workdir, description, descriptionDone, command, **kwargs)`
	`checkForOldSlaveAndLogfiles(self)`
	`describe(self, done)` Return a list of short strings to describe this step, for the status display.
	`setCommand(self, command)`
	`setupEnvironment(self, cmd)`
	`start(self)` Begin the step.
Inherited from LoggingBuildStep
	`checkDisconnect(self, f)`
	`commandComplete(self, cmd)` This is a general-purpose hook method for subclasses.
	`getColor(self, cmd, results)`
	`getText(self, cmd, results)`
	`getText2(self, cmd, results)` We have decided to add a short note about ourselves to the overall build description, probably because something went wrong.
	`interrupt(self, reason)` Halt the command, either because the user has decided to cancel the build ('reason' is a string), or because the slave has disconnected ('reason' is a ConnectionLost Failure).
	`maybeGetText2(self, cmd, results)`
	`setStatus(self, cmd, results)`
	`setupLogfiles(self, cmd, logfiles)` Set up any additional logfiles= logs.
	`startCommand(self, cmd, errorMessages)`
Inherited from BuildStep
	`acquireLocks(self, res)`
	`addCompleteLog(self, name, text)`
	`addHTMLLog(self, name, html)`
	`addLog(self, name)`
	`addLogObserver(self, logname, observer)`
	`addURL(self, name, url)` Add a BuildStep URL to this step.
	`failed(self, why)`
	`finished(self, results)`
	`getProperty(self, propname)`
	`getSlaveName(self)`
	`releaseLocks(self)`
	`runCommand(self, c)`
	`setProgress(self, metric, value)` BuildSteps can call self.setProgress() to announce progress along some metric.
	`setProperty(self, propname, value)`
	`setStepStatus(self, step_status)`
	`setupProgress(self)`
	`slaveVersion(self, command, oldversion)` Return the version number of the given slave command.
	`slaveVersionIsOlderThan(self, command, minversion)`
	`startStep(self, remote)` Begin the step.

Instance Variable Summary
`NoneType`	`command`: a list of argv strings (or WithProperties instances).
Inherited from ShellCommand
	`logfiles`: a dict mapping log NAMEs to workdir-relative FILENAMEs of their corresponding logfiles.
Inherited from BuildStep
`buildbot.process.base.Build`	`build`: the parent Build which is executing this step
`buildbot.status.progress.StepProgress`	`progress`: tracks ETA for the step
`buildbot.status.builder.BuildStepStatus`	`step_status`: collects output status

Class Variable Summary
`list`	`description` = `['building', 'epydocs']`
`list`	`descriptionDone` = `['epydoc']`
`str`	`name` = `'epydoc'`
Inherited from ShellCommand
`bool`	`flunkOnFailure` = `True`
Inherited from LoggingBuildStep
`list`	`parms` = `['build', 'name', 'locks', 'haltOnFailure', 'flu...`
`tuple`	`progressMetrics` = `('output',)`
Inherited from BuildStep
`bool`	`flunkOnWarnings` = `False`
`bool`	`haltOnFailure` = `False`
`list`	`locks` = `[]`
`bool`	`useProgress` = `True`
`bool`	`warnOnFailure` = `False`
`bool`	`warnOnWarnings` = `False`

Method Details

createSummary(self, log)

To create summary logs, do something like this: warnings = grep('^Warning:', log.getText()) self.addCompleteLog('warnings', warnings)

Overrides:: buildbot.process.buildstep.LoggingBuildStep.createSummary (inherited documentation)

evaluateCommand(self, cmd)

Decide whether the command was SUCCESS, WARNINGS, or FAILURE. Override this to, say, declare WARNINGS if there is any stderr activity, or to say that rc!=0 is not actually an error.

Overrides:: buildbot.process.buildstep.LoggingBuildStep.evaluateCommand (inherited documentation)

Instance Variable Details

command

a list of argv strings (or WithProperties instances). This will be used by start() to create a RemoteShellCommand instance.

Type:: NoneType
Value:: ['make', 'epydocs']

Class Variable Details

description

Type:: list
Value:: ['building', 'epydocs']

descriptionDone

Type:: list
Value:: ['epydoc']

name

Type:: str
Value:: 'epydoc'

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

http://epydoc.sf.net