|
| __init__ (self, doc, registry, default=None, optional=False, multi=False, on_none=None) |
|
| __deepcopy__ (self, memo) |
|
| __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") |
|
| __get__ (self, instance, owner=None, at=None, label="default") |
|
None | __set__ (self, Config instance, ConfigInstanceDict|None value, Any at=None, str label="assignment") |
|
| rename (self, instance) |
|
| validate (self, instance) |
|
| toDict (self, instance) |
|
| freeze (self, instance) |
|
| save (self, outfile, instance) |
|
| __delete__ (self, instance, at=None, label="deletion") |
|
| types (self) |
|
| __contains__ (self, k) |
|
| __len__ (self) |
|
| __iter__ (self) |
|
| __getitem__ (self, k, at=None, label="default") |
|
| __setitem__ (self, k, value, at=None, label="assignment") |
|
| __setattr__ (self, attr, value, at=None, label="assignment") |
|
| __reduce__ (self) |
|
| keys (self) |
|
| values (self) |
|
| items (self) |
|
| __new__ (cls, *args, **kw) |
|
| setDefaults (self) |
|
| update (self, **kw) |
|
| load (self, filename, root="config") |
|
| loadFromStream (self, stream, root="config", filename=None, extraLocals=None) |
|
| loadFromString (self, code, root="config", filename=None, extraLocals=None) |
|
| saveToString (self, skipImports=False) |
|
| saveToStream (self, outfile, root="config", skipImports=False) |
|
| names (self) |
|
| formatHistory (self, name, **kwargs) |
|
| __delattr__ (self, attr, at=None, label="deletion") |
|
| __eq__ (self, other) |
|
| __ne__ (self, other) |
|
| __str__ (self) |
|
| __repr__ (self) |
|
| compare (self, other, shortcut=True, rtol=1e-8, atol=1e-8, output=None) |
|
| __init_subclass__ (cls, **kwargs) |
|
|
| _getOrMake (self, instance, label="default") |
|
| _collectImports (self, instance, imports) |
|
| _compare (self, instance1, instance2, shortcut, rtol, atol, output) |
|
| _setup (self, doc, dtype, default, check, optional, source, deprecated) |
|
| _validateValue (self, value) |
|
| _setSelection (self, value, at=None, label="assignment") |
|
| _getNames (self) |
|
| _setNames (self, value) |
|
| _delNames (self) |
|
| _getName (self) |
|
| _setName (self, value) |
|
| _delName (self) |
|
| _getActive (self) |
|
| _rename (self, fullname) |
|
| _save (self, outfile) |
|
| _fromPython (cls, config_py) |
|
Mapping[str, Any] | _parseTypingArgs (tuple[type,...]|tuple[str,...] params, Mapping[str, Any] kwds) |
|
dict | _storage [str, Any] |
|
dict | _fields [str, Field] |
|
dict | _history [str, list[Any]] |
|
set | _imports [Any] |
|
| names = property(_getNames, _setNames, _delNames) |
|
| name = property(_getName, _setName, _delName) |
|
| active = property(_getActive) |
|
| history = property(lambda x: x._history) |
|
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