|
| __init__ (self, doc, keytype=None, itemtype=None, default=None, optional=False, dictCheck=None, itemCheck=None, deprecated=None) |
|
| validate (self, instance) |
|
None | __set__ (self, Config instance, Mapping[KeyTypeVar, ItemTypeVar]|None value, Any at=None, str label="assignment") |
|
| toDict (self, instance) |
|
| __class_getitem__ (cls, tuple[type,...]|type|ForwardRef params) |
|
| rename (self, instance) |
|
| freeze (self, instance) |
|
| save (self, outfile, 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") |
|
| __get__ (self, instance, owner=None, at=None, label="default") |
|
| __delete__ (self, instance, at=None, label="deletion") |
|
ItemTypeVar | __getitem__ (self, KeyTypeVar k) |
|
int | __len__ (self) |
|
Iterator[KeyTypeVar] | __iter__ (self) |
|
bool | __contains__ (self, Any k) |
|
None | __setitem__ (self, KeyTypeVar k, ItemTypeVar x, Any at=None, str label="setitem", bool setHistory=True) |
|
None | __delitem__ (self, KeyTypeVar k, Any at=None, str label="delitem", bool setHistory=True) |
|
| __repr__ (self) |
|
| __str__ (self) |
|
| __setattr__ (self, attr, value, at=None, label="assignment") |
|
| __reduce__ (self) |
|
A configuration field (`~lsst.pex.config.Field` subclass) that maps keys
and values.
The types of both items and keys are restricted to these builtin types:
`int`, `float`, `complex`, `bool`, and `str`). All keys share the same type
and all values share the same type. Keys can have a different type from
values.
Parameters
----------
doc : `str`
A documentation string that describes the configuration field.
keytype : {`int`, `float`, `complex`, `bool`, `str`}, optional
The type of the mapping keys. All keys must have this type. Optional
if keytype and itemtype are supplied as typing arguments to the class.
itemtype : {`int`, `float`, `complex`, `bool`, `str`}, optional
Type of the mapping values. Optional if keytype and itemtype are
supplied as typing arguments to the class.
default : `dict`, optional
The default mapping.
optional : `bool`, optional
If `True`, the field doesn't need to have a set value.
dictCheck : callable
A function that validates the dictionary as a whole.
itemCheck : callable
A function that validates individual mapping values.
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
Field
ListField
RangeField
RegistryField
Examples
--------
This field maps has `str` keys and `int` values:
>>> from lsst.pex.config import Config, DictField
>>> class MyConfig(Config):
... field = DictField(
... doc="Example string-to-int mapping field.",
... keytype=str, itemtype=int,
... default={})
...
>>> config = MyConfig()
>>> config.field['myKey'] = 42
>>> print(config.field)
{'myKey': 42}
None lsst.pex.config.dictField.DictField.__set__ |
( |
| self, |
|
|
Config | instance, |
|
|
Mapping[KeyTypeVar, ItemTypeVar] | None | value, |
|
|
Any | at = None, |
|
|
str | label = "assignment" ) |
Set an attribute on the config instance.
Parameters
----------
instance : `lsst.pex.config.Config`
The config instance that contains this field.
value : obj
Value to set on this field.
at : `list` of `~lsst.pex.config.callStack.StackFrame` or `None`,\
optional
The call stack (created by
`lsst.pex.config.callStack.getCallStack`).
label : `str`, optional
Event label for the history.
Notes
-----
This method is invoked by the owning `lsst.pex.config.Config` object
and should not be called directly.
Derived `~lsst.pex.config.Field` classes may need to override the
behavior. When overriding ``__set__``, `~lsst.pex.config.Field` authors
should follow the following rules:
- Do not allow modification of frozen configs.
- Validate the new value **before** modifying the field. Except if the
new value is `None`. `None` is special and no attempt should be made
to validate it until `lsst.pex.config.Config.validate` is called.
- Do not modify the `~lsst.pex.config.Config` instance to contain
invalid values.
- If the field is modified, update the history of the
`lsst.pex.config.field.Field` to reflect the changes.
In order to decrease the need to implement this method in derived
`~lsst.pex.config.Field` types, value validation is performed in the
`lsst.pex.config.Field._validateValue`. If only the validation step
differs in the derived `~lsst.pex.config.Field`, it is simpler to
implement `lsst.pex.config.Field._validateValue` than to reimplement
``__set__``. More complicated behavior, however, may require
reimplementation.
Reimplemented from lsst.pex.config.config.Field.