|
lsst.pex.config
17.0.1
|
Public Member Functions | |
| def | validateTarget (self, target, ConfigClass) |
| def | __init__ (self, doc, target, ConfigClass=None, default=None, check=None) |
| def | __get__ (self, instance, owner=None, at=None, label="default") |
| def | __set__ (self, instance, value, at=None, label="assignment") |
| def | rename (self, instance) |
| def | save (self, outfile, instance) |
| def | freeze (self, instance) |
| def | toDict (self, instance) |
| def | validate (self, instance) |
| def | __deepcopy__ (self, memo) |
| def | __delete__ (self, instance, at=None, label='deletion') |
Public Attributes | |
| target | |
| ConfigClass | |
| dtype | |
| doc | |
| default | |
| check | |
| optional | |
| source | |
Static Public Attributes | |
| supportedTypes = set((str, bool, float, int, complex)) | |
A configuration field (`~lsst.pex.config.Field` subclass) that can be
can be retargeted towards a different configurable (often a
`lsst.pipe.base.Task` subclass).
The ``ConfigurableField`` is often used to configure subtasks, which are
tasks (`~lsst.pipe.base.Task`) called by a parent task.
Parameters
----------
doc : `str`
A description of the configuration field.
target : configurable class
The configurable target. Configurables have a ``ConfigClass``
attribute. Within the task framework, configurables are
`lsst.pipe.base.Task` subclasses)
ConfigClass : `lsst.pex.config.Config`-type, optional
The subclass of `lsst.pex.config.Config` expected as the configuration
class of the ``target``. If ``ConfigClass`` is unset then
``target.ConfigClass`` is used.
default : ``ConfigClass``-type, optional
The default configuration class. Normally this parameter is not set,
and defaults to ``ConfigClass`` (or ``target.ConfigClass``).
check : callable, optional
Callable that takes the field's value (the ``target``) as its only
positional argument, and returns `True` if the ``target`` is valid (and
`False` otherwise).
See also
--------
ChoiceField
ConfigChoiceField
ConfigDictField
ConfigField
DictField
Field
ListField
RangeField
RegistryField
Notes
-----
You can use the `ConfigurableInstance.apply` method to construct a
fully-configured configurable.
Definition at line 162 of file configurableField.py.
| def lsst.pex.config.configurableField.ConfigurableField.__init__ | ( | self, | |
| doc, | |||
| target, | |||
ConfigClass = None, |
|||
default = None, |
|||
check = None |
|||
| ) |
Definition at line 250 of file configurableField.py.
| def lsst.pex.config.configurableField.ConfigurableField.__deepcopy__ | ( | self, | |
| memo | |||
| ) |
Customize deep-copying, because we always want a reference to the original typemap. WARNING: this must be overridden by subclasses if they change the constructor signature!
Definition at line 338 of file configurableField.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.
| def lsst.pex.config.configurableField.ConfigurableField.__get__ | ( | self, | |
| instance, | |||
owner = None, |
|||
at = None, |
|||
label = "default" |
|||
| ) |
Definition at line 274 of file configurableField.py.
| def lsst.pex.config.configurableField.ConfigurableField.__set__ | ( | self, | |
| instance, | |||
| value, | |||
at = None, |
|||
label = "assignment" |
|||
| ) |
Definition at line 280 of file configurableField.py.
| def lsst.pex.config.configurableField.ConfigurableField.freeze | ( | self, | |
| instance | |||
| ) |
Definition at line 322 of file configurableField.py.
| def lsst.pex.config.configurableField.ConfigurableField.rename | ( | self, | |
| instance | |||
| ) |
Definition at line 300 of file configurableField.py.
| def lsst.pex.config.configurableField.ConfigurableField.save | ( | self, | |
| outfile, | |||
| instance | |||
| ) |
Definition at line 305 of file configurableField.py.
| def lsst.pex.config.configurableField.ConfigurableField.toDict | ( | self, | |
| instance | |||
| ) |
Definition at line 326 of file configurableField.py.
| def lsst.pex.config.configurableField.ConfigurableField.validate | ( | self, | |
| instance | |||
| ) |
Definition at line 330 of file configurableField.py.
| def lsst.pex.config.configurableField.ConfigurableField.validateTarget | ( | self, | |
| target, | |||
| ConfigClass | |||
| ) |
Validate the target and configuration class.
Parameters
----------
target
The configurable being verified.
ConfigClass : `lsst.pex.config.Config`-type or `None`
The configuration class associated with the ``target``. This can
be `None` if ``target`` has a ``ConfigClass`` attribute.
Raises
------
AttributeError
Raised if ``ConfigClass`` is `None` and ``target`` does not have a
``ConfigClass`` attribute.
TypeError
Raised if ``ConfigClass`` is not a `~lsst.pex.config.Config`
subclass.
ValueError
Raised if:
- ``target`` is not callable (callables have a ``__call__``
method).
- ``target`` is not startically defined (does not have
``__module__`` or ``__name__`` attributes).
Definition at line 208 of file configurableField.py.
| lsst.pex.config.configurableField.ConfigurableField.ConfigClass |
Definition at line 263 of file configurableField.py.
|
staticinherited |
| lsst.pex.config.configurableField.ConfigurableField.target |
Definition at line 262 of file configurableField.py.
1.8.13