|
def | __init__ (self, doc, registry, default=None, optional=False, multi=False, on_none=None) |
|
def | __deepcopy__ (self, memo) |
|
def | __init__ (self, doc, typemap, default=None, optional=False, multi=False, deprecated=None) |
|
def | __class_getitem__ (cls, 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, ConfigInstanceDict|None 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, 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") |
|
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) |
|
def | __iter__ (self) |
|
def | keys (self) |
|
def | values (self) |
|
def | items (self) |
|
def | __contains__ (self, name) |
|
def | __new__ (cls, *args, **kw) |
|
def | __reduce__ (self) |
|
def | setDefaults (self) |
|
def | update (self, **kw) |
|
def | load (self, filename, root="config") |
|
def | loadFromStream (self, stream, root="config", filename=None) |
|
def | loadFromString (self, code, root="config", filename=None) |
|
def | save (self, filename, root="config") |
|
def | saveToString (self, skipImports=False) |
|
def | saveToStream (self, outfile, root="config", skipImports=False) |
|
def | freeze (self) |
|
def | toDict (self) |
|
def | names (self) |
|
def | validate (self) |
|
def | formatHistory (self, name, **kwargs) |
|
def | __setattr__ (self, attr, value, at=None, label="assignment") |
|
def | __delattr__ (self, attr, at=None, label="deletion") |
|
def | __eq__ (self, other) |
|
def | __ne__ (self, other) |
|
def | __str__ (self) |
|
def | __repr__ (self) |
|
def | compare (self, other, shortcut=True, rtol=1e-8, atol=1e-8, output=None) |
|
def | __init_subclass__ (cls, **kwargs) |
|
def | __init__ (cls, name, bases, dict_) |
|
def | __setattr__ (cls, name, value) |
|
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`.
on_none: `Callable`, optional
A callable that should be invoked when ``apply`` is called but the
selected name or names is `None`. Will be passed the field attribute
proxy (`RegistryInstanceDict`) and then all positional and keyword
arguments passed to ``apply``.
See Also
--------
ChoiceField
ConfigChoiceField
ConfigDictField
ConfigField
ConfigurableField
DictField
Field
ListField
RangeField