buildbot.process.properties.Properties

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

Class Properties

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.

Method Summary
	`__init__(self, **kwargs)`
	`__getitem__(self, name)` Just get the value for this property.
	`__getstate__(self)`
	`__repr__(self)`
	`__setstate__(self, d)`
	`asList(self)` Return the properties as a sorted list of (name, value, source)
	`getProperty(self, name, default)` Get the value for the given property.
	`getPropertySource(self, name)`
	`has_key(self, name)`
	`render(self, value)` Return a variant of value that has any WithProperties objects substituted.
	`setProperty(self, name, value, source)`
	`update(self, dict, source)` Update this object from a dictionary, with an explicit source specified.
	`updateFromProperties(self, other)` Update this object based on another object; the other object's
Inherited from ComparableMixin
	`__cmp__(self, them)`
	`__hash__(self)`

Class Variable Summary
`str`	`compare_attrs` = `'properties'`
Inherited from ComparableMixin
`Implements`	`__implemented__` = `<implementedBy buildbot.util.Comparabl...`
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`

Method Details

init(self, **kwargs)
(Constructor)

Parameters:: kwargs - initial property values (for testing)

getitem(self, name)
(Indexing operator)

Just get the value for this property.

asList(self)

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

getProperty(self, name, default=None)

Get the value for the given property.

render(self, value)

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

update(self, dict, source)

Update this object from a dictionary, with an explicit source specified.

updateFromProperties(self, other)

Update this object based on another object; the other object's

Class Variable Details

compare_attrs

Type:: str
Value:: 'properties'

Generated by Epydoc 2.1 on Tue Sep 16 09:15:59 2008

http://epydoc.sf.net