Trees       Indices       Help   
BuildBot 0.8.2
Package buildbot :: Module interfaces :: Class IStatus
[frames] | no frames]

Class IStatus

source code

zope.interface.Interface --+
                           |
                          IStatus

I am an object, obtainable from the buildmaster, which can provide status information.

Instance Methods
 
getProjectName()
Return the name of the project that this Buildbot is working for.		 source code
 
getProjectURL()
Return the URL of this Buildbot's project.		 source code
 
getBuildbotURL()
Return the URL of the top-most Buildbot status page, or None if this Buildbot does not provide a web status page.		 source code
 
getURLForThing(thing)
Return the URL of a page which provides information on 'thing', which should be an object that implements one of the status interfaces defined in buildbot.interfaces.		 source code
 
getChangeSources()
Return a list of IChangeSource objects.		 source code
 
getChange(number)
Return an IChange object.		 source code
 
getSchedulers()
Return a list of ISchedulerStatus objects for all currently-registered Schedulers.		 source code
 
getBuilderNames(categories=None)
Return a list of the names of all current Builders.		 source code
 
getBuilder(name)
Return the IBuilderStatus object for a given named Builder.		 source code
 
getSlaveNames()
Return a list of buildslave names, suitable for passing to getSlave().		 source code
 
getSlave(name)
Return the ISlaveStatus object for a given named buildslave.		 source code
 
getBuildSets()
Return a list of active (non-finished) IBuildSetStatus objects.		 source code
 
generateFinishedBuilds(builders=[], branches=[], num_builds=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 and working backwards.		 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.IStatus'
  __iro__ = (<InterfaceClass buildbot.interfaces.IStatus>, <Inte...
  __name__ = 'IStatus'
  __sro__ = (<InterfaceClass buildbot.interfaces.IStatus>, <Inte...
  dependents = <WeakKeyDictionary at 41509448>
Method Details

getURLForThing(thing)

source code 

Return the URL of a page which provides information on 'thing', which should be an object that implements one of the status interfaces defined in buildbot.interfaces. Returns None if no suitable page is available (or if no Waterfall is running).

getBuilder(name)

source code 

Return the IBuilderStatus object for a given named Builder. Raises KeyError if there is no Builder by that name.

generateFinishedBuilds(builders=[], branches=[], num_builds=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 and working backwards.

Parameters:
  • builders - this is a list of Builder names, and the generator will only produce builds that ran on the given Builders. If the list is empty, produce builds from all Builders.
  • branches - this is a list of branch names, and the generator will only produce builds that used the given branches. If the list is empty, produce builds from all branches.
  • num_builds - the generator will stop after providing this many builds. The default of None means to produce as many builds as possible.
  • 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 within any given Builder.

subscribe(receiver)

source code 

Register an IStatusReceiver to receive new status events. The receiver will immediately be sent a set of 'builderAdded' messages for all current builders. It will receive further 'builderAdded' and 'builderRemoved' messages as the config file is reloaded and builders come and go. It will also receive 'buildsetSubmitted' messages for all outstanding BuildSets (and each new BuildSet that gets submitted). No additional messages will be sent unless the receiver asks for them by calling .subscribe on the IBuilderStatus objects which accompany the addedBuilder message.

unsubscribe(receiver)

source code 

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


Class Variable Details

__iro__

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

__sro__

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

   Trees       Indices       Help   
BuildBot 0.8.2
Generated by Epydoc 3.0.1 on Fri Oct 29 10:00:41 2010 http://epydoc.sourceforge.net