|
def | __init__ (self, doc, dtype=None, allowed=None, default=None, optional=True, deprecated=None) |
|
def | __class_getitem__ (cls, 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, FieldTypeVar|None value, Any at=None, str label="assignment") |
|
def | __delete__ (self, instance, at=None, label="deletion") |
|
A configuration field (`~lsst.pex.config.Field` subclass) that allows a
user to select from a predefined set of values.
Use ``ChoiceField`` when a configuration can only take one of a predefined
set of values. Each choice must be of the same type.
Parameters
----------
doc : `str`
Documentation string that describes the configuration field.
dtype : class
The type of the field's choices. For example, `str` or `int`.
allowed : `dict`
The allowed values. Keys are the allowed choices (of ``dtype``-type).
Values are descriptions (`str`-type) of each choice.
default : ``dtype``-type, optional
The default value, which is of type ``dtype`` and one of the allowed
choices.
optional : `bool`, optional
If `True`, this configuration field is *optional*. Default is `True`.
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
--------
ConfigChoiceField
ConfigDictField
ConfigField
ConfigurableField
DictField
Field
ListField
RangeField
RegistryField