LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, doc, dtype=None, default=None, optional=False, listCheck=None, itemCheck=None, length=None, minLength=None, maxLength=None, deprecated=None) | |
validate (self, instance) | |
None | __set__ (self, Config instance, Iterable[FieldTypeVar]|None value, Any at=None, str label="assignment") |
toDict (self, instance) | |
Public Attributes | |
listCheck | |
itemCheck | |
itemtype | |
length | |
minLength | |
maxLength | |
name | |
Protected Member Functions | |
_compare (self, instance1, instance2, shortcut, rtol, atol, output) | |
A configuration field (`~lsst.pex.config.Field` subclass) that contains a list of values of a specific type. Parameters ---------- doc : `str` A description of the field. dtype : class, optional The data type of items in the list. Optional if supplied as typing argument to the class. default : sequence, optional The default items for the field. optional : `bool`, optional Set whether the field is *optional*. When `False`, `lsst.pex.config.Config.validate` will fail if the field's value is `None`. listCheck : callable, optional A callable that validates the list as a whole. itemCheck : callable, optional A callable that validates individual items in the list. length : `int`, optional If set, this field must contain exactly ``length`` number of items. minLength : `int`, optional If set, this field must contain *at least* ``minLength`` number of items. maxLength : `int`, optional If set, this field must contain *no more than* ``maxLength`` number of items. 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 DictField Field RangeField RegistryField
Definition at line 265 of file listField.py.
lsst.pex.config.listField.ListField.__init__ | ( | self, | |
doc, | |||
dtype = None, | |||
default = None, | |||
optional = False, | |||
listCheck = None, | |||
itemCheck = None, | |||
length = None, | |||
minLength = None, | |||
maxLength = None, | |||
deprecated = None ) |
Reimplemented from lsst.pex.config.config.Field.
Definition at line 311 of file listField.py.
None lsst.pex.config.listField.ListField.__set__ | ( | self, | |
Config | instance, | ||
Iterable[FieldTypeVar] | 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.
Definition at line 427 of file listField.py.
|
protected |
Compare two config instances for equality with respect to this field. `lsst.pex.config.config.compare` is the primary user of this method. Parameters ---------- instance1 : `lsst.pex.config.Config` Left-hand-side `~lsst.pex.config.Config` instance in the comparison. instance2 : `lsst.pex.config.Config` Right-hand-side `~lsst.pex.config.Config` instance in the comparison. shortcut : `bool` If `True`, return as soon as an **inequality** is found. rtol : `float` Relative tolerance for floating point comparisons. atol : `float` Absolute tolerance for floating point comparisons. output : callable If not None, a callable that takes a `str`, used (possibly repeatedly) to report inequalities. Returns ------- equal : `bool` `True` if the fields are equal; `False` otherwise. Notes ----- Floating point comparisons are performed by `numpy.allclose`.
Reimplemented from lsst.pex.config.config.Field.
Definition at line 466 of file listField.py.
lsst.pex.config.listField.ListField.toDict | ( | self, | |
instance ) |
Convert the value of this field to a plain `list`. `lsst.pex.config.Config.toDict` is the primary user of this method. Parameters ---------- instance : `lsst.pex.config.Config` The config instance that contains this field. Returns ------- `list` Plain `list` of items, or `None` if the field is not set.
Reimplemented from lsst.pex.config.config.Field.
Definition at line 448 of file listField.py.
lsst.pex.config.listField.ListField.validate | ( | self, | |
instance ) |
Validate the field. Parameters ---------- instance : `lsst.pex.config.Config` The config instance that contains this field. Raises ------ lsst.pex.config.FieldValidationError Raised if: - The field is not optional, but the value is `None`. - The list itself does not meet the requirements of the ``length``, ``minLength``, or ``maxLength`` attributes. - The ``listCheck`` callable returns `False`. Notes ----- Individual item checks (``itemCheck``) are applied when each item is set and are not re-checked by this method.
Reimplemented from lsst.pex.config.config.Field.
Definition at line 387 of file listField.py.
lsst.pex.config.listField.ListField.itemCheck |
Definition at line 363 of file listField.py.
lsst.pex.config.listField.ListField.itemtype |
Definition at line 368 of file listField.py.
lsst.pex.config.listField.ListField.length |
Definition at line 372 of file listField.py.
lsst.pex.config.listField.ListField.listCheck |
Definition at line 359 of file listField.py.
lsst.pex.config.listField.ListField.maxLength |
Definition at line 382 of file listField.py.
lsst.pex.config.listField.ListField.minLength |
Definition at line 377 of file listField.py.
lsst.pex.config.listField.ListField.name |
Definition at line 502 of file listField.py.