lsst.pex.config
14.0-2-g319577b+12
|
Public Member Functions | |
def | __init__ (self, doc, dtype, default=None, optional=False, listCheck=None, itemCheck=None, length=None, minLength=None, maxLength=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 | |
listCheck | |
itemCheck | |
itemtype | |
length | |
minLength | |
maxLength | |
dtype | |
doc | |
default | |
check | |
optional | |
source | |
Static Public Attributes | |
supportedTypes = set((str, unicode, basestring, oldStringType, bool, float, int, complex)) | |
Defines a field which is a container of values of type dtype If length is not None, then instances of this field must match this length exactly. If minLength is not None, then instances of the field must be no shorter then minLength If maxLength is not None, then instances of the field must be no longer than maxLength Additionally users can provide two check functions: listCheck - used to validate the list as a whole, and itemCheck - used to validate each item individually
Definition at line 154 of file listField.py.
def lsst.pex.config.listField.ListField.__init__ | ( | self, | |
doc, | |||
dtype, | |||
default = None , |
|||
optional = False , |
|||
listCheck = None , |
|||
itemCheck = None , |
|||
length = None , |
|||
minLength = None , |
|||
maxLength = None |
|||
) |
Definition at line 171 of file listField.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.listField.ListField.__set__ | ( | self, | |
instance, | |||
value, | |||
at = None , |
|||
label = "assignment" |
|||
) |
Definition at line 225 of file listField.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.listField.ListField.toDict | ( | self, | |
instance | |||
) |
Definition at line 240 of file listField.py.
def lsst.pex.config.listField.ListField.validate | ( | self, | |
instance | |||
) |
ListField validation ensures that non-optional fields are not None, and that non-None values comply with length requirements and that the list passes listCheck if supplied by the user. Individual Item checks are applied at set time and are not re-checked.
Definition at line 201 of file listField.py.
lsst.pex.config.listField.ListField.itemCheck |
Definition at line 195 of file listField.py.
lsst.pex.config.listField.ListField.itemtype |
Definition at line 196 of file listField.py.
lsst.pex.config.listField.ListField.length |
Definition at line 197 of file listField.py.
lsst.pex.config.listField.ListField.listCheck |
Definition at line 194 of file listField.py.
lsst.pex.config.listField.ListField.maxLength |
Definition at line 199 of file listField.py.
lsst.pex.config.listField.ListField.minLength |
Definition at line 198 of file listField.py.
|
staticinherited |