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, str doc, Mapping[str, ConfigurableAction]|None default=None, bool optional=False, deprecated=None) | |
__class_getitem__ (cls, params) | |
__set__ (self, Config instance,(None|Mapping[str, ConfigurableAction]|SimpleNamespace|ConfigurableActionStruct|ConfigurableActionStructField|type[ConfigurableActionStructField]) value, Iterable[StackFrame] at=None, str label="assigment") | |
ConfigurableActionStruct[ActionTypeVar] | __get__ (self, None instance, Any owner=None, Any at=None, str label="default") |
ConfigurableActionStruct[ActionTypeVar] | __get__ (self, Config instance, Any owner=None, Any at=None, str label="default") |
__get__ (self, instance, owner=None, at=None, label="default") | |
rename (self, Config instance) | |
validate (self, Config instance) | |
toDict (self, instance) | |
save (self, outfile, instance) | |
freeze (self, instance) | |
Public Attributes | |
default | |
name | |
Static Public Attributes | |
StructClass = ConfigurableActionStruct | |
str | name |
Mapping | default [str, ConfigurableAction] | None |
Protected Member Functions | |
_collectImports (self, instance, imports) | |
_compare (self, instance1, instance2, shortcut, rtol, atol, output) | |
`ConfigurableActionStructField` is a `~lsst.pex.config.Field` subclass that allows a `ConfigurableAction` to be organized in a `~lsst.pex.config.Config` class in a manner similar to how a `~lsst.pipe.base.Struct` works. This class uses a `ConfigurableActionStruct` as an intermediary object to organize the `ConfigurableAction`. See its documentation for further information. Parameters ---------- doc : `str` Documentation string. default : `~collections.abc.Mapping` [ `str`, `ConfigurableAction` ] \ or `None`, optional Default value. optional : `bool`, optional If `True`, the field doesn't need to have a set value. deprecated : `bool` or `None`, 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.
Definition at line 249 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__init__ | ( | self, | |
str | doc, | ||
Mapping[str, ConfigurableAction] | None | default = None, | ||
bool | optional = False, | ||
deprecated = None ) |
Reimplemented from lsst.pex.config.config.Field.
Definition at line 282 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__class_getitem__ | ( | cls, | |
params ) |
Reimplemented from lsst.pex.config.config.Field.
Definition at line 300 of file _configurableActionStructField.py.
ConfigurableActionStruct[ActionTypeVar] lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__ | ( | self, | |
Config | instance, | ||
Any | owner = None, | ||
Any | at = None, | ||
str | label = "default" ) |
Reimplemented from lsst.pex.config.config.Field.
Definition at line 360 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__ | ( | self, | |
instance, | |||
owner = None, | |||
at = None, | |||
label = "default" ) |
Reimplemented from lsst.pex.config.config.Field.
Definition at line 364 of file _configurableActionStructField.py.
ConfigurableActionStruct[ActionTypeVar] lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__ | ( | self, | |
None | instance, | ||
Any | owner = None, | ||
Any | at = None, | ||
str | label = "default" ) |
Reimplemented from lsst.pex.config.config.Field.
Definition at line 355 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__set__ | ( | self, | |
Config | instance, | ||
( None | Mapping[str, ConfigurableAction] | SimpleNamespace | ConfigurableActionStruct | ConfigurableActionStructField | type[ConfigurableActionStructField] ) | value, | ||
Iterable[StackFrame] | at = None, | ||
str | label = "assigment" ) |
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 303 of file _configurableActionStructField.py.
|
protected |
Call the _collectImports method on all config objects the field may own, and union them with the supplied imports set. Parameters ---------- instance : instance or subclass of `lsst.pex.config.Config` A config object that has this field defined on it imports : `set` Set of python modules that need imported after persistence
Reimplemented from lsst.pex.config.config.Field.
Definition at line 414 of file _configurableActionStructField.py.
|
protected |
Compare two fields for equality. Parameters ---------- instance1 : `lsst.pex.config.Config` Left-hand side config instance to compare. instance2 : `lsst.pex.config.Config` Right-hand side config instance to compare. shortcut : `bool` If `True`, this function returns as soon as an inequality if found. rtol : `float` Relative tolerance for floating point comparisons. atol : `float` Absolute tolerance for floating point comparisons. output : callable A callable that takes a string, used (possibly repeatedly) to report inequalities. Returns ------- isEqual : 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 421 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.freeze | ( | self, | |
instance ) |
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.**
Reimplemented from lsst.pex.config.config.Field.
Definition at line 408 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.rename | ( | self, | |
Config | instance ) |
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.Field`\s that hold subconfigs should rename each subconfig with the full field name as generated by `lsst.pex.config.config._joinNamePath`.
Reimplemented from lsst.pex.config.config.Field.
Definition at line 371 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.save | ( | self, | |
outfile, | |||
instance ) |
Save this field to a file (for internal use only). Parameters ---------- outfile : file-like object A writeable field handle. instance : `~lsst.pex.config.Config` The `~lsst.pex.config.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.
Reimplemented from lsst.pex.config.config.Field.
Definition at line 394 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.toDict | ( | self, | |
instance ) |
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 : `~lsst.pex.config.Config` The `~lsst.pex.config.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.
Reimplemented from lsst.pex.config.config.Field.
Definition at line 385 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.validate | ( | self, | |
Config | instance ) |
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.validate` if they re-implement `~lsst.pex.config.Field.validate`.
Reimplemented from lsst.pex.config.config.Field.
Definition at line 379 of file _configurableActionStructField.py.
|
static |
Definition at line 280 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.default |
Definition at line 324 of file _configurableActionStructField.py.
|
static |
Definition at line 279 of file _configurableActionStructField.py.
lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.name |
Definition at line 452 of file _configurableActionStructField.py.
|
static |
Definition at line 275 of file _configurableActionStructField.py.