Package buildbot :: Package steps :: Module python :: Class PyLint
[frames] | no frames]

Class PyLint

source code

   process.buildstep.BuildStep --+        
                                 |        
process.buildstep.LoggingBuildStep --+    
                                     |    
                    shell.ShellCommand --+
                                         |
                                        PyLint

A command that knows about pylint output. It's a good idea to add --output-format=parseable to your command, since it includes the filename in the message.

Instance Methods
 
createSummary(self, log)
To create summary logs, do something like this: warnings = grep('^Warning:', log.getText()) self.addCompleteLog('warnings', warnings)
source code
 
evaluateCommand(self, cmd)
Decide whether the command was SUCCESS, WARNINGS, or FAILURE.
source code

Inherited from shell.ShellCommand: __init__, buildCommandKwargs, describe, getWorkdir, setBuild, setCommand, setDefaultWorkdir, setStepStatus, setupEnvironment, start

Inherited from process.buildstep.LoggingBuildStep: addLogFile, checkDisconnect, commandComplete, getText, getText2, interrupt, maybeGetText2, setStatus, setupLogfiles, startCommand

Inherited from process.buildstep.BuildStep: acquireLocks, addCompleteLog, addFactoryArguments, addHTMLLog, addLog, addLogObserver, addURL, failed, finished, getLog, getProperty, getSlaveName, getStepFactory, releaseLocks, runCommand, setBuildSlave, setProgress, setProperty, setupProgress, slaveVersion, slaveVersionIsOlderThan, startStep

Class Variables
  name = 'pylint'
  description = ['running', 'pylint']
  descriptionDone = ['pylint']
  MESSAGES = {'C': 'convention', 'E': 'error', 'F': 'fatal', 'I'...
  flunkingIssues = ['F', 'E']

Inherited from shell.ShellCommand: flunkOnFailure, renderables

Inherited from process.buildstep.LoggingBuildStep: cmd, parms, progressMetrics

Inherited from process.buildstep.BuildStep: alwaysRun, doStepIf, flunkOnWarnings, haltOnFailure, locks, useProgress, warnOnFailure, warnOnWarnings

Instance Variables

Inherited from shell.ShellCommand: command, lazylogfiles, logfiles

Inherited from process.buildstep.BuildStep: build, progress, step_status

Method Details

createSummary(self, log)

source code 

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

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

evaluateCommand(self, cmd)

source code 

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: process.buildstep.LoggingBuildStep.evaluateCommand
(inherited documentation)

Class Variable Details

MESSAGES

Value:
{'C': 'convention',
 'E': 'error',
 'F': 'fatal',
 'I': 'info',
 'R': 'refactor',
 'W': 'warning'}