Package buildbot :: Module interfaces :: Class IBuilderStatus
[frames] | no frames]

Class IBuilderStatus

source code

zope.interface.Interface --+
                           |
                          IBuilderStatus

Instance Methods
 
getName()
Return the name of this Builder (a string).
source code
 
getCategory()
Return the category of this builder (a string).
source code
 
getState()
Return a tuple (state, builds) for this Builder.
source code
 
getSlaves()
Return a list of ISlaveStatus objects for the buildslaves that are used by this builder.
source code
 
getPendingBuildRequestStatuses()
Get a IBuildRequestStatus implementations for all unclaimed build requests.
source code
 
getCurrentBuilds()
Return a list containing an IBuildStatus object for each build currently in progress.
source code
 
getLastFinishedBuild()
Return the IBuildStatus object representing the last finished build, which may be None if the builder has not yet finished any builds.
source code
 
getBuild(number)
Return an IBuildStatus object for a historical build.
source code
 
getEvent(number)
Return an IStatusEvent object for a recent Event.
source code
 
generateFinishedBuilds(branches=[], num_builds=None, max_buildnum=None, finished_before=None, max_search=200)
Return a generator that will produce IBuildStatus objects each time you invoke its .next() method, starting with the most recent finished build, then the previous build, and so on back to the oldest build available.
source code
 
subscribe(receiver)
Register an IStatusReceiver to receive new status events.
source code
 
unsubscribe(receiver)
Unregister an IStatusReceiver.
source code
Class Variables
  __bases__ = (<InterfaceClass zope.interface.Interface>)
  __identifier__ = 'buildbot.interfaces.IBuilderStatus'
  __iro__ = (<InterfaceClass buildbot.interfaces.IBuilderStatus>...
  __name__ = 'IBuilderStatus'
  __sro__ = (<InterfaceClass buildbot.interfaces.IBuilderStatus>...
  dependents = <WeakKeyDictionary at 43408704>
Method Details

getState()

source code 

Return a tuple (state, builds) for this Builder. 'state' is the so-called 'big-status', indicating overall status (as opposed to which step is currently running). It is a string, one of 'offline', 'idle', or 'building'. 'builds' is a list of IBuildStatus objects (possibly empty) representing the currently active builds.

getPendingBuildRequestStatuses()

source code 

Get a IBuildRequestStatus implementations for all unclaimed build requests.

Returns:
list of objects via Deferred

getBuild(number)

source code 

Return an IBuildStatus object for a historical build. Each build is numbered (starting at 0 when the Builder is first added), getBuild(n) will retrieve the Nth such build. getBuild(-n) will retrieve a recent build, with -1 being the most recent build started. If the Builder is idle, this will be the same as getLastFinishedBuild(). If the Builder is active, it will be an unfinished build. This method will return None if the build is no longer available. Older builds are likely to have less information stored: Logs are the first to go, then Steps.

getEvent(number)

source code 

Return an IStatusEvent object for a recent Event. Builders connecting and disconnecting are events, as are ping attempts. getEvent(-1) will return the most recent event. Events are numbered, but it probably doesn't make sense to ever do getEvent(+n).

generateFinishedBuilds(branches=[], num_builds=None, max_buildnum=None, finished_before=None, max_search=200)

source code 

Return a generator that will produce IBuildStatus objects each time you invoke its .next() method, starting with the most recent finished build, then the previous build, and so on back to the oldest build available.

Parameters:
  • branches - this is a list of branch names, and the generator will only produce builds that involve the given branches. If the list is empty, the generator will produce all builds regardless of what branch they used.
  • num_builds - if provided, the generator will stop after providing this many builds. The default of None means to produce as many builds as possible.
  • max_buildnum - if provided, the generator will start by providing the build with this number, or the highest-numbered preceding build (i.e. the generator will not produce any build numbered *higher* than max_buildnum). The default of None means to start with the most recent finished build. -1 means the same as None. -2 means to start with the next-most-recent completed build, etc.
  • finished_before (int: a timestamp, seconds since the epoch) - if provided, do not produce any builds that finished after the given timestamp.
  • max_search (int) - this method may have to examine a lot of builds to find some that match the search parameters, especially if there aren't any matching builds. This argument imposes a hard limit on the number of builds that will be examined.

subscribe(receiver)

source code 

Register an IStatusReceiver to receive new status events. The receiver will be given builderChangedState, buildStarted, and buildFinished messages.

unsubscribe(receiver)

source code 

Unregister an IStatusReceiver. No further status messgaes will be delivered.


Class Variable Details

__iro__

Value:
(<InterfaceClass buildbot.interfaces.IBuilderStatus>,
 <InterfaceClass zope.interface.Interface>)

__sro__

Value:
(<InterfaceClass buildbot.interfaces.IBuilderStatus>,
 <InterfaceClass zope.interface.Interface>)