|
def | __init__ (self, doc, dtype, default=None, optional=False, listCheck=None, itemCheck=None, length=None, minLength=None, maxLength=None, deprecated=None) |
|
def | validate (self, instance) |
|
def | __set__ (self, instance, value, at=None, label="assignment") |
|
def | toDict (self, instance) |
|
def | __init__ (self, doc, dtype, default=None, check=None, optional=False, deprecated=None) |
|
def | rename (self, instance) |
|
def | validate (self, instance) |
|
def | freeze (self, instance) |
|
def | save (self, outfile, instance) |
|
def | toDict (self, instance) |
|
def | __get__ (self, instance, owner=None, at=None, label="default") |
|
def | __set__ (self, instance, value, at=None, label='assignment') |
|
def | __delete__ (self, instance, at=None, label='deletion') |
|
A configuration field (`~lsst.pex.config.Field` subclass) that contains
a list of values of a specific type.
Parameters
----------
doc : `str`
A description of the field.
dtype : class
The data type of items in the list.
default : sequence, optional
The default items for the field.
optional : `bool`, optional
Set whether the field is *optional*. When `False`,
`lsst.pex.config.Config.validate` will fail if the field's value is
`None`.
listCheck : callable, optional
A callable that validates the list as a whole.
itemCheck : callable, optional
A callable that validates individual items in the list.
length : `int`, optional
If set, this field must contain exactly ``length`` number of items.
minLength : `int`, optional
If set, this field must contain *at least* ``minLength`` number of
items.
maxLength : `int`, optional
If set, this field must contain *no more than* ``maxLength`` number of
items.
deprecated : None or `str`, optional
A description of why this Field is deprecated, including removal date.
If not None, the string is appended to the docstring for this Field.
See also
--------
ChoiceField
ConfigChoiceField
ConfigDictField
ConfigField
ConfigurableField
DictField
Field
RangeField
RegistryField