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	__set__ (self, Config instance, Union[None, Mapping[str, ConfigurableAction], ConfigurableActionStruct] value, Iterable[StackFrame] at=None, str label='assigment')
Union[None, T, ConfigurableActionStruct]	__get__ (T self, Config instance, None owner=None, Iterable[StackFrame] at=None, str label="default")
def	rename (self, Config instance)
def	validate (self, instance)
def	toDict (self, instance)
def	save (self, outfile, instance)
def	freeze (self, instance)
def	rename (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
	dtype
	doc
	deprecated
	default
	check
	optional
	source

Static Public Attributes
	StructClass = ConfigurableActionStruct
	supportedTypes = set((str, bool, float, int, complex))

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 manor 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 199 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
	)

Definition at line 218 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

__delete__()

def lsst.pex.config.config.Field.__delete__ (   self,   instance,   at = None,   label = 'deletion'  )

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.

Definition at line 625 of file config.py.

    def __delete__(self, instance, at=None, label='deletion'):
        """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.
        """
        if at is None:
            at = getCallStack()
        self.__set__(instance, None, at=at, label=label)
 

__get__() [1/2]

def lsst.pex.config.config.Field.__get__ (   self,   instance,   owner = None,   at = None,   label = "default"  )

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.

Reimplemented in lsst.pex.config.configurableField.ConfigurableField.

Definition at line 550 of file config.py.

    def __get__(self, instance, owner=None, at=None, label="default"):
        """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.
        """
        if instance is None or not isinstance(instance, Config):
            return self
        else:
            return instance._storage[self.name]
 

__get__() [2/2]

Union[None, T, ConfigurableActionStruct] lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__	(	T	self,
		Config	instance,
		None	owner = None,
		Iterable[StackFrame]	at = None,
		str	label = "default"
	)

Definition at line 247 of file _configurableActionStructField.py.

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

__set__() [1/2]

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__set__	(		self,
		Config	instance,
		Union[None, Mapping[str, ConfigurableAction], ConfigurableActionStruct]	value,
		Iterable[StackFrame]	at = None,
		str	label = 'assigment'
	)

Definition at line 225 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 value == self.default:
            value = self.StructClass(instance, self, value, at=at, label=label)
        else:
            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
 

__set__() [2/2]

def lsst.pex.config.config.Field.__set__ (   self,   instance,   value,   at = None,   label = 'assignment'  )

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.

Reimplemented in lsst.pipe.tasks.configurableActions._configurableActionField.ConfigurableActionField, lsst.pex.config.listField.ListField, lsst.pex.config.dictField.DictField, lsst.pex.config.configurableField.ConfigurableField, lsst.pex.config.configField.ConfigField, and lsst.pex.config.configChoiceField.ConfigChoiceField.

Definition at line 568 of file config.py.

    def __set__(self, instance, value, at=None, label='assignment'):
        """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.
        """
        if instance._frozen:
            raise FieldValidationError(self, instance, "Cannot modify a frozen Config")
 
        history = instance._history.setdefault(self.name, [])
        if value is not None:
            value = _autocast(value, self.dtype)
            try:
                self._validateValue(value)
            except BaseException as e:
                raise FieldValidationError(self, instance, str(e))
 
        instance._storage[self.name] = value
        if at is None:
            at = getCallStack()
        history.append((value, at, label))
 

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 290 of file _configurableActionStructField.py.

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

rename() [1/2]

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.rename	(		self,
		Config	instance
	)

Definition at line 256 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():
                fullname = _joinNamePath(instance._name, self.name, k)
                v._rename(fullname)
 

rename() [2/2]

def lsst.pex.config.config.Field.rename (   self,   instance  )

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`.

Reimplemented in lsst.pex.config.configurableField.ConfigurableField, lsst.pex.config.configField.ConfigField, lsst.pex.config.configDictField.ConfigDictField, and lsst.pex.config.configChoiceField.ConfigChoiceField.

Definition at line 379 of file config.py.

    def rename(self, 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`.
        """
        pass
 

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 278 of file _configurableActionStructField.py.

    def save(self, outfile, instance):
        actionStruct = self.__get__(instance)
        fullname = _joinNamePath(instance._name, self.name)
        if actionStruct is None:
            outfile.write(u"{}={!r}\n".format(fullname, actionStruct))
            return
 
        outfile.write(u"{}={!r}\n".format(fullname, {}))
        for v in actionStruct:
            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 269 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,
			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 263 of file _configurableActionStructField.py.

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

Member Data Documentation

check

lsst.pex.config.config.Field.check

inherited

Definition at line 363 of file config.py.

default

lsst.pex.config.config.Field.default

inherited

Definition at line 359 of file config.py.

deprecated

lsst.pex.config.config.Field.deprecated

inherited

Definition at line 350 of file config.py.

doc

lsst.pex.config.config.Field.doc

inherited

Definition at line 346 of file config.py.

dtype

lsst.pex.config.config.Field.dtype

inherited

Definition at line 339 of file config.py.

optional

lsst.pex.config.config.Field.optional

inherited

Definition at line 367 of file config.py.

source

lsst.pex.config.config.Field.source

inherited

Definition at line 374 of file config.py.

StructClass

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

static

Definition at line 211 of file _configurableActionStructField.py.

supportedTypes

lsst.pex.config.config.Field.supportedTypes = set((str, bool, float, int, complex))

staticinherited

Definition at line 324 of file config.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-147-g0e635eb1+1acddb5be5/python/lsst/pipe/tasks/configurableActions/_configurableActionStructField.py