lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField Class Reference

Inheritance diagram for lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField:

Public Member Functions
def	__init__ (self, str doc, Optional[Mapping[str, ConfigurableAction]] default=None, bool optional=False, deprecated=None)
def	__class_getitem__ (cls, params)
def	__set__ (self, Config instance, Union[None, Mapping[str, ConfigurableAction], SimpleNamespace, Struct, 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)

Public Attributes
	default

Static Public Attributes
	StructClass = ConfigurableActionStruct

Detailed Description

`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 implements a `ConfigurableActionStruct` as an intermediary
object to organize the `ConfigurableActions`. See it's documentation for
futher information.

Definition at line 230 of file _configurableActionStructField.py.

Constructor & Destructor Documentation

__init__()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__init__	(		self,
		str	doc,
		Optional[Mapping[str, ConfigurableAction]]	default = None,
		bool	optional = False,
			deprecated = None
	)

Reimplemented from lsst.pex.config.config.Field.

Definition at line 249 of file _configurableActionStructField.py.

                 deprecated=None):
        source = getStackFrame()
        self._setup(doc=doc, dtype=self.__class__, default=default, check=None,
                    optional=optional, source=source, deprecated=deprecated)
 

Member Function Documentation

__class_getitem__()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__class_getitem__	(		cls,
			params
	)

Reimplemented from lsst.pex.config.config.Field.

Definition at line 256 of file _configurableActionStructField.py.

    def __class_getitem__(cls, params):
        return GenericAlias(cls, params)
 

__get__() [1/3]

ConfigurableActionStruct[ActionTypeVar] lsst.pipe.tasks.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 313 of file _configurableActionStructField.py.

    ) -> ConfigurableActionStruct[ActionTypeVar]:
        ...
 

__get__() [2/3]

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__	(		self,
			instance,
			owner = None,
			at = None,
			label = 'default'
	)

Reimplemented from lsst.pex.config.config.Field.

Definition at line 322 of file _configurableActionStructField.py.

    ):
        if instance is None or not isinstance(instance, Config):
            return self
        else:
            field: Optional[ConfigurableActionStruct] = instance._storage[self.name]
            return field
 

__get__() [3/3]

ConfigurableActionStruct[ActionTypeVar] lsst.pipe.tasks.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 303 of file _configurableActionStructField.py.

    ) -> ConfigurableActionStruct[ActionTypeVar]:
        ...
 

__set__()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__set__	(		self,
		Config	instance,
		Union[None, Mapping[str, ConfigurableAction], SimpleNamespace, Struct, 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.

Definition at line 259 of file _configurableActionStructField.py.

                at: Iterable[StackFrame] = None, label: str = 'assigment'):
        if instance._frozen:
            msg = "Cannot modify a frozen Config. "\
                  "Attempting to set field to value %s" % value
            raise FieldValidationError(self, instance, msg)
 
        if at is None:
            at = getCallStack()
 
        if value is None or (self.default is not None and self.default == value):
            value = self.StructClass(instance, self, value, at=at, label=label)
        else:
            # An actual value is being assigned check for what it is
            if isinstance(value, self.StructClass):
                # If this is a ConfigurableActionStruct, we need to make our
                # own copy that references this current field
                value = self.StructClass(instance, self, value._attrs, at=at, label=label)
            elif isinstance(value, (SimpleNamespace, Struct)):
                # If this is a a python analogous container, we need to make
                # a ConfigurableActionStruct initialized with this data
                value = self.StructClass(instance, self, vars(value), at=at, label=label)
 
            elif type(value) == ConfigurableActionStructField:
                raise ValueError("ConfigurableActionStructFields can only be used in a class body declaration"
                                 f"Use a {self.StructClass}, SimpleNamespace or Struct")
            else:
                raise ValueError(f"Unrecognized value {value}, cannot be assigned to this field")
 
            history = instance._history.setdefault(self.name, [])
            history.append((value, at, label))
 
        if not isinstance(value, ConfigurableActionStruct):
            raise FieldValidationError(self, instance,
                                       "Can only assign things that are subclasses of Configurable Action")
        instance._storage[self.name] = value
 

freeze()

def lsst.pipe.tasks.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 372 of file _configurableActionStructField.py.

    def freeze(self, instance):
        actionStruct = self.__get__(instance)
        if actionStruct is not None:
            for v in actionStruct:
                v.freeze()
 

rename()

def lsst.pipe.tasks.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.Fields` 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 335 of file _configurableActionStructField.py.

    def rename(self, instance: Config):
        actionStruct: ConfigurableActionStruct = self.__get__(instance)
        if actionStruct is not None:
            for k, v in actionStruct.items():
                base_name = _joinNamePath(instance._name, self.name)
                fullname = _joinNamePath(base_name, k)
                v._rename(fullname)
 

save()

def lsst.pipe.tasks.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 : `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.

Reimplemented from lsst.pex.config.config.Field.

Definition at line 358 of file _configurableActionStructField.py.

    def save(self, outfile, instance):
        actionStruct = self.__get__(instance)
        fullname = _joinNamePath(instance._name, self.name)
 
        # Ensure that a struct is always empty before assigning to it.
        outfile.write(f"{fullname}=None\n")
 
        if actionStruct is None:
            return
 
        for _, v in sorted(actionStruct.items()):
            outfile.write(u"{}={}()\n".format(v._name, _typeStr(v)))
            v._save(outfile)
 

toDict()

def lsst.pipe.tasks.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 : `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.

Reimplemented from lsst.pex.config.config.Field.

Definition at line 349 of file _configurableActionStructField.py.

    def toDict(self, instance):
        actionStruct = self.__get__(instance)
        if actionStruct is None:
            return None
 
        dict_ = {k: v.toDict() for k, v in actionStruct.items()}
 
        return dict_
 

validate()

def lsst.pipe.tasks.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.Field.validate` if they re-implement
`~lsst.pex.config.field.Field.validate`.

Reimplemented from lsst.pex.config.config.Field.

Definition at line 343 of file _configurableActionStructField.py.

    def validate(self, instance: Config):
        value = self.__get__(instance)
        if value is not None:
            for item in value:
                item.validate()
 

Member Data Documentation

default

lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.default

Definition at line 275 of file _configurableActionStructField.py.

StructClass

lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.StructClass = ConfigurableActionStruct

static

Definition at line 242 of file _configurableActionStructField.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-5.0.1/Linux64/pipe_tasks/g91fc1fa0cf+82a115f028/python/lsst/pipe/tasks/configurableActions/_configurableActionStructField.py