Package buildbot :: Package process :: Module properties :: Class Properties

Class Properties

util.ComparableMixin --+
                       |
                      Properties


I represent a set of properties that can be interpolated into various
strings in buildsteps.

@ivar properties: dictionary mapping property values to tuples 
    (value, source), where source is a string identifing the source
    of the property.

Objects of this class can be read like a dictionary -- in this case,
only the property value is returned.

As a special case, a property value of None is returned as an empty 
string when used as a mapping.

Instance Methods

__init__(self, **kwargs)

source code

__getstate__(self)

source code

__setstate__(self, d)

source code

__contains__(self, name)

source code

__getitem__(self, name)
Just get the value for this property.

source code

has_key(self, name)

source code

getProperty(self, name, default=None)
Get the value for the given property.

source code

getPropertySource(self, name)

source code

asList(self)
Return the properties as a sorted list of (name, value, source)

source code

__repr__(self)

source code

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

source code

update(self, dict, source, runtime=False)
Update this object from a dictionary, with an explicit source specified.

source code

updateFromProperties(self, other)
Update this object based on another object; the other object's

source code

updateFromPropertiesNoRuntime(self, other)
Update this object based on another object, but don't include properties that were marked as runtime.

source code

render(self, value)
Return a variant of value that has any WithProperties objects substituted.

source code

Inherited from util.ComparableMixin: __cmp__, __hash__, __providedBy__

Class Variables
	compare_attrs = `('properties')`
Inherited from `util.ComparableMixin`: `__implemented__`, `__provides__`

Method Details

init(self, **kwargs)
(Constructor)

source code

Parameters:

kwargs - initial property values (for testing)

render(self, value)

source code

Return a variant of value that has any WithProperties objects substituted. This recurses into Python's compound data types.

Class Properties

__init__(self, **kwargs) (Constructor)

render(self, value)

init(self, **kwargs)
(Constructor)