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

Class IProperties

source code

zope.interface.Interface --+
                           |
                          IProperties

An object providing access to build properties

Instance Methods
 
getProperty(name, default=None)
Get the named property, returning the default if the property does not exist.
source code
 
hasProperty(name)
Return true if the named property exists.
source code
 
has_key(name)
Deprecated name for hasProperty.
source code
 
setProperty(name, value, source, runtime=False)
Set the given property, overwriting any existing value.
source code
 
getProperties()
Get the buildbot.process.properties.Properties instance storing these properties.
source code
 
getBuild()
Get the buildbot.process.build.Build instance for the current build.
source code
 
render(value)
Render @code{value} as an IRenderable.
source code
Class Variables
  __bases__ = (<InterfaceClass zope.interface.Interface>)
  __identifier__ = 'buildbot.interfaces.IProperties'
  __iro__ = (<InterfaceClass buildbot.interfaces.IProperties>, <...
  __name__ = 'IProperties'
  __sro__ = (<InterfaceClass buildbot.interfaces.IProperties>, <...
  dependents = <WeakKeyDictionary at 37398216>
Method Details

getProperty(name, default=None)

source code 

Get the named property, returning the default if the property does not exist.

Parameters:
  • name (string) - property name
  • default - default value (default: @code{None})
Returns:
property value

hasProperty(name)

source code 

Return true if the named property exists.

Parameters:
  • name (string) - property name
Returns:
boolean

setProperty(name, value, source, runtime=False)

source code 

Set the given property, overwriting any existing value. The source describes the source of the value for human interpretation.

Parameters:
  • name (string) - property name
  • value (JSON-able value) - property value
  • source (string) - property source
  • runtime (boolean) - (optional) whether this property was set during the build's runtime: usually left at its default value

getProperties()

source code 

Get the buildbot.process.properties.Properties instance storing these properties. Note that the interface for this class is not stable, so where possible the other methods of this interface should be used.

Returns:
buildbot.process.properties.Properties instance

getBuild()

source code 

Get the buildbot.process.build.Build instance for the current build. Note that this object is not available after the build is complete, at which point this method will return None.

Try to avoid using this method, as the API of Build instances is not well-defined.

@returns buildbot.process.build.Build instance

render(value)

source code 

Render @code{value} as an IRenderable. This essentially coerces @code{value} to an IRenderable and calls its @getRenderingFor method.

Returns:
rendered value

Class Variable Details

__iro__

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

__sro__

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