|
def | __init__ (self, doc, registry, default=None, optional=False, multi=False) |
|
def | __deepcopy__ (self, memo) |
|
def | __init__ (self, doc, typemap, default=None, optional=False, multi=False, deprecated=None) |
|
def | __class_getitem__ (cls, Union[tuple[type,...], type, ForwardRef] params) |
|
"ConfigChoiceField" | __get__ (self, None instance, Any owner=None, Any at=None, str label="default") |
|
ConfigInstanceDict | __get__ (self, Config instance, Any owner=None, Any at=None, str label="default") |
|
def | __get__ (self, instance, owner=None, at=None, label="default") |
|
None | __set__ (self, Config instance, Optional[ConfigInstanceDict] value, Any at=None, str label="assignment") |
|
def | rename (self, instance) |
|
def | validate (self, instance) |
|
def | toDict (self, instance) |
|
def | freeze (self, instance) |
|
def | save (self, outfile, instance) |
|
def | __deepcopy__ (self, memo) |
|
def | __class_getitem__ (cls, Union[tuple[type,...], type, ForwardRef] params) |
|
def | __init__ (self, doc, dtype=None, 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) |
|
"Field[FieldTypeVar]" | __get__ (self, None instance, Any owner=None, Any at=None, str label="default") |
|
FieldTypeVar | __get__ (self, "Config" instance, Any owner=None, Any at=None, str label="default") |
|
def | __get__ (self, instance, owner=None, at=None, label="default") |
|
None | __set__ (self, "Config" instance, Optional[FieldTypeVar] value, Any at=None, str label="assignment") |
|
def | __delete__ (self, instance, at=None, label="deletion") |
|
def | __init__ (self, config, field) |
|
def | types (self) |
|
def | __contains__ (self, k) |
|
def | __len__ (self) |
|
def | __iter__ (self) |
|
def | __getitem__ (self, k, at=None, label="default") |
|
def | __setitem__ (self, k, value, at=None, label="assignment") |
|
def | __setattr__ (self, attr, value, at=None, label="assignment") |
|
def | freeze (self) |
|
def | __reduce__ (self) |
|
A configuration field whose options are defined in a `Registry`.
Parameters
----------
doc : `str`
A description of the field.
registry : `Registry`
The registry that contains this field.
default : `str`, optional
The default target key.
optional : `bool`, optional
When `False`, `lsst.pex.config.Config.validate` fails if the field's
value is `None`.
multi : `bool`, optional
If `True`, the field allows multiple selections. The default is
`False`.
See also
--------
ChoiceField
ConfigChoiceField
ConfigDictField
ConfigField
ConfigurableField
DictField
Field
ListField
RangeField