lsst.pex.config
14.0-2-g319577b+2
|
Public Member Functions | |
def | __init__ (self, doc, keytype, itemtype, default=None, optional=False, dictCheck=None, itemCheck=None) |
def | validate (self, instance) |
def | __set__ (self, instance, value, at=None, label="assignment") |
def | toDict (self, instance) |
def | rename (self, instance) |
def | freeze (self, instance) |
def | save (self, outfile, instance) |
def | __get__ (self, instance, owner=None, at=None, label="default") |
def | __delete__ (self, instance, at=None, label='deletion') |
Public Attributes | |
keytype | |
itemtype | |
dictCheck | |
itemCheck | |
dtype | |
doc | |
default | |
check | |
optional | |
source | |
Static Public Attributes | |
DictClass = Dict | |
supportedTypes = set((str, unicode, basestring, oldStringType, bool, float, int, complex)) | |
Defines a field which is a mapping of values Both key and item types are restricted to builtin POD types: (int, float, complex, bool, str) Users can provide two check functions: dictCheck: used to validate the dict as a whole, and itemCheck: used to validate each item individually For example to define a field which is a mapping from names to int values: class MyConfig(Config): field = DictField( doc="example string-to-int mapping field", keytype=str, itemtype=int, default= {})
Definition at line 141 of file dictField.py.
def lsst.pex.config.dictField.DictField.__init__ | ( | self, | |
doc, | |||
keytype, | |||
itemtype, | |||
default = None , |
|||
optional = False , |
|||
dictCheck = None , |
|||
itemCheck = None |
|||
) |
Definition at line 162 of file dictField.py.
|
inherited |
|
inherited |
Define how attribute access should occur on the Config instance This is invoked by the owning config object and should not be called directly When the field attribute is accessed on a Config class object, it returns the field object itself in order to allow inspection of Config classes. When the field attribute is access on a config instance, the actual value described by the field (and held by the Config instance) is returned.
def lsst.pex.config.dictField.DictField.__set__ | ( | self, | |
instance, | |||
value, | |||
at = None , |
|||
label = "assignment" |
|||
) |
Definition at line 195 of file dictField.py.
|
inherited |
|
inherited |
Rename an instance of this field, not the field itself. This is invoked by the owning config object and should not be called directly Only useful for fields which hold sub-configs. Fields which hold subconfigs should rename each sub-config with the full field name as generated by _joinNamePath
|
inherited |
def lsst.pex.config.dictField.DictField.toDict | ( | self, | |
instance | |||
) |
Definition at line 211 of file dictField.py.
def lsst.pex.config.dictField.DictField.validate | ( | self, | |
instance | |||
) |
DictField validation ensures that non-optional fields are not None, and that non-None values comply with dictCheck. Individual Item checks are applied at set time and are not re-checked.
Definition at line 182 of file dictField.py.
lsst.pex.config.dictField.DictField.dictCheck |
Definition at line 179 of file dictField.py.
|
static |
Definition at line 160 of file dictField.py.
lsst.pex.config.dictField.DictField.itemCheck |
Definition at line 180 of file dictField.py.
lsst.pex.config.dictField.DictField.itemtype |
Definition at line 178 of file dictField.py.
lsst.pex.config.dictField.DictField.keytype |
Definition at line 177 of file dictField.py.
|
staticinherited |