lsst.pex.config gaa9e307f6b+436704ae70
|
Public Member Functions | |
def | __init__ (self, str doc, Mapping[str, ConfigurableAction]|None default=None, bool optional=False, deprecated=None) |
def | __class_getitem__ (cls, params) |
def | __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") |
def | __get__ (self, instance, owner=None, at=None, label="default") |
def | rename (self, Config instance) |
def | validate (self, Config instance) |
def | toDict (self, instance) |
def | save (self, outfile, instance) |
def | freeze (self, instance) |
![]() | |
def | __class_getitem__ (cls, tuple[type,...]|type|ForwardRef params) |
def | __init__ (self, doc, dtype=None, default=None, check=None, optional=False, deprecated=None) |
def | rename (self, instance) |
def | validate (self, instance) |
def | freeze (self, instance) |
def | save (self, outfile, instance) |
def | toDict (self, 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") |
def | __get__ (self, instance, owner=None, at=None, label="default") |
None | __set__ (self, Config instance, FieldTypeVar|None value, Any at=None, str label="assignment") |
def | __delete__ (self, instance, at=None, label="deletion") |
Public Attributes | |
default | |
![]() | |
dtype | |
doc | |
deprecated | |
default | |
check | |
optional | |
source | |
Static Public Attributes | |
StructClass = ConfigurableActionStruct | |
![]() | |
dictionary | supportedTypes = {str, bool, float, int, complex} |
`ConfigurableActionStructField` is a `~lsst.pex.config.Field` subclass that allows `ConfigurableAction`\ s 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.
def 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.
def lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__class_getitem__ | ( | cls, | |
params | |||
) |
Reimplemented from lsst.pex.config.config.Field.
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.
def lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__ | ( | self, | |
instance, | |||
owner = None , |
|||
at = None , |
|||
label = "default" |
|||
) |
Reimplemented from lsst.pex.config.config.Field.
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.
def 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` 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.
def 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.
def 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.
def 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.
def 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.
def 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.