|
lsst.pex.config
17.0.1
|
Public Member Functions | |
| def | __init__ (self, doc, dtype, default=None, optional=False, min=None, max=None, inclusiveMin=True, inclusiveMax=False) |
| def | rename (self, instance) |
| def | validate (self, instance) |
| def | freeze (self, instance) |
| def | save (self, outfile, instance) |
| def | toDict (self, instance) |
| def | __get__ (self, instance, owner=None, at=None, label="default") |
| def | __set__ (self, instance, value, at=None, label='assignment') |
| def | __delete__ (self, instance, at=None, label='deletion') |
Public Attributes | |
| min | |
| max | |
| maxCheck | |
| minCheck | |
| rangeString | |
| dtype | |
| doc | |
| default | |
| check | |
| optional | |
| source | |
Static Public Attributes | |
| supportedTypes = set((int, float)) | |
A configuration field (`lsst.pex.config.Field` subclass) that requires
the value to be in a specific numeric range.
Parameters
----------
doc : `str`
A description of the field.
dtype : {`int`-type, `float`-type}
The field's data type: either the `int` or `float` type.
default : `int` or `float`, optional
Default value for the field.
optional : `bool`, optional
When `False`, `lsst.pex.config.Config.validate` will fail if the
field's value is `None`.
min : int, float, or `None`, optional
Minimum value accepted in the range. If `None`, the range has no
lower bound (equivalent to negative infinity).
max : `int`, `float`, or None, optional
Maximum value accepted in the range. If `None`, the range has no
upper bound (equivalent to positive infinity).
inclusiveMin : `bool`, optional
If `True` (default), the ``min`` value is included in the allowed
range.
inclusiveMax : `bool`, optional
If `True` (default), the ``max`` value is included in the allowed
range.
See also
--------
ChoiceField
ConfigChoiceField
ConfigDictField
ConfigField
ConfigurableField
DictField
Field
ListField
RegistryField
Definition at line 29 of file rangeField.py.
| def lsst.pex.config.rangeField.RangeField.__init__ | ( | self, | |
| doc, | |||
| dtype, | |||
default = None, |
|||
optional = False, |
|||
min = None, |
|||
max = None, |
|||
inclusiveMin = True, |
|||
inclusiveMax = False |
|||
| ) |
Definition at line 76 of file rangeField.py.
|
inherited |
Delete an attribute from a `lsst.pex.config.Config` instance.
Parameters
----------
instance : `lsst.pex.config.Config`
The config instance that contains this field.
at : `list` of `lsst.pex.config.callStack.StackFrame`
The call stack (created by
`lsst.pex.config.callStack.getCallStack`).
label : `str`, optional
Event label for the history.
Notes
-----
This is invoked by the owning `~lsst.pex.config.Config` object and
should not be called directly.
|
inherited |
Define how attribute access should occur on the Config instance This is invoked by the owning config object and should not be called directly When the field attribute is accessed on a Config class object, it returns the field object itself in order to allow inspection of Config classes. When the field attribute is access on a config instance, the actual value described by the field (and held by the Config instance) is returned.
|
inherited |
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`
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.
|
inherited |
Make this field read-only (for internal use only).
Parameters
----------
instance : `lsst.pex.config.Config`
The config instance that contains this field.
Notes
-----
Freezing is only relevant for fields that hold subconfigs. Fields which
hold subconfigs should freeze each subconfig.
**Subclasses should implement this method.**
|
inherited |
Rename the field in a `~lsst.pex.config.Config` (for internal use
only).
Parameters
----------
instance : `lsst.pex.config.Config`
The config instance that contains this field.
Notes
-----
This method is invoked by the `lsst.pex.config.Config` object that
contains this field and should not be called directly.
Renaming is only relevant for `~lsst.pex.config.Field` instances that
hold subconfigs. `~lsst.pex.config.Fields` that hold subconfigs should
rename each subconfig with the full field name as generated by
`lsst.pex.config.config._joinNamePath`.
|
inherited |
Save this field to a file (for internal use only).
Parameters
----------
outfile : file-like object
A writeable field handle.
instance : `Config`
The `Config` instance that contains this field.
Notes
-----
This method is invoked by the `~lsst.pex.config.Config` object that
contains this field and should not be called directly.
The output consists of the documentation string
(`lsst.pex.config.Field.doc`) formatted as a Python comment. The second
line is formatted as an assignment: ``{fullname}={value}``.
This output can be executed with Python.
|
inherited |
Convert the field value so that it can be set as the value of an
item in a `dict` (for internal use only).
Parameters
----------
instance : `Config`
The `Config` that contains this field.
Returns
-------
value : object
The field's value. See *Notes*.
Notes
-----
This method invoked by the owning `~lsst.pex.config.Config` object and
should not be called directly.
Simple values are passed through. Complex data structures must be
manipulated. For example, a `~lsst.pex.config.Field` holding a
subconfig should, instead of the subconfig object, return a `dict`
where the keys are the field names in the subconfig, and the values are
the field values in the subconfig.
|
inherited |
Validate the field (for internal use only).
Parameters
----------
instance : `lsst.pex.config.Config`
The config instance that contains this field.
Raises
------
lsst.pex.config.FieldValidationError
Raised if verification fails.
Notes
-----
This method provides basic validation:
- Ensures that the value is not `None` if the field is not optional.
- Ensures type correctness.
- Ensures that the user-provided ``check`` function is valid.
Most `~lsst.pex.config.Field` subclasses should call
`lsst.pex.config.field.Field.validate` if they re-implement
`~lsst.pex.config.field.Field.validate`.
| lsst.pex.config.rangeField.RangeField.max |
Definition at line 94 of file rangeField.py.
| lsst.pex.config.rangeField.RangeField.maxCheck |
Definition at line 100 of file rangeField.py.
| lsst.pex.config.rangeField.RangeField.min |
Definition at line 89 of file rangeField.py.
| lsst.pex.config.rangeField.RangeField.minCheck |
Definition at line 104 of file rangeField.py.
| lsst.pex.config.rangeField.RangeField.rangeString |
Definition at line 108 of file rangeField.py.
|
static |
Definition at line 70 of file rangeField.py.
1.8.13