lsst.pex.config.configurableField.ConfigurableInstance Class Reference

Public Member Functions
def	__init__ (self, config, field, at=None, label="default")
def	apply (self, args, kw)
def	retarget (self, target, ConfigClass=None, at=None, label="retarget")
def	__getattr__ (self, name)
def	__setattr__ (self, name, value, at=None, label="assignment")
def	__delattr__ (self, name, at=None, label="delete")

Properties
	target = property(lambda x: x._target)
	ConfigClass = property(lambda x: x._ConfigClass)
	value = property(lambda x: x._value)

Detailed Description

A retargetable configuration in a `ConfigurableField` that proxies
a `~lsst.pex.config.Config`.

Notes
-----
``ConfigurableInstance`` implements ``__getattr__`` and ``__setattr__``
methods that forward to the `~lsst.pex.config.Config` it holds.
``ConfigurableInstance`` adds a `retarget` method.

The actual `~lsst.pex.config.Config` instance is accessed using the
``value`` property (e.g. to get its documentation).  The associated
configurable object (usually a `~lsst.pipe.base.Task`) is accessed
using the ``target`` property.

Definition at line 31 of file configurableField.py.

Constructor & Destructor Documentation

__init__()

def lsst.pex.config.configurableField.ConfigurableInstance.__init__	(		self,
			config,
			field,
			at = None,
			label = "default"
	)

Definition at line 64 of file configurableField.py.

    def __init__(self, config, field, at=None, label="default"):
        object.__setattr__(self, "_config", config)
        object.__setattr__(self, "_field", field)
        object.__setattr__(self, "__doc__", config)
        object.__setattr__(self, "_target", field.target)
        object.__setattr__(self, "_ConfigClass", field.ConfigClass)
        object.__setattr__(self, "_value", None)

        if at is None:
            at = getCallStack()
        at += [self._field.source]
        self.__initValue(at, label)

        history = config._history.setdefault(field.name, [])
        history.append(("Targeted and initialized from defaults", at, label))

Member Function Documentation

__delattr__()

def lsst.pex.config.configurableField.ConfigurableInstance.__delattr__	(		self,
			name,
			at = None,
			label = "delete"
	)

Pretend to be an isntance of  ConfigClass.
Attributes defiend by ConfigurableInstance will shadow those defined in ConfigClass

Definition at line 145 of file configurableField.py.

    def __delattr__(self, name, at=None, label="delete"):
        """
        Pretend to be an isntance of  ConfigClass.
        Attributes defiend by ConfigurableInstance will shadow those defined in ConfigClass
        """
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config, "Cannot modify a frozen Config")

        try:
            # attribute exists in the ConfigurableInstance wrapper
            object.__delattr__(self, name)
        except AttributeError:
            if at is None:
                at = getCallStack()
            self._value.__delattr__(name, at=at, label=label)

__getattr__()

def lsst.pex.config.configurableField.ConfigurableInstance.__getattr__	(		self,
			name
	)

Definition at line 126 of file configurableField.py.

    def __getattr__(self, name):
        return getattr(self._value, name)

__setattr__()

def lsst.pex.config.configurableField.ConfigurableInstance.__setattr__	(		self,
			name,
			value,
			at = None,
			label = "assignment"
	)

Pretend to be an instance of ConfigClass.

Attributes defined by ConfigurableInstance will shadow those defined in ConfigClass

Definition at line 129 of file configurableField.py.

    def __setattr__(self, name, value, at=None, label="assignment"):
        """Pretend to be an instance of ConfigClass.

        Attributes defined by ConfigurableInstance will shadow those defined in ConfigClass
        """
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config, "Cannot modify a frozen Config")

        if name in self.__dict__:
            # attribute exists in the ConfigurableInstance wrapper
            object.__setattr__(self, name, value)
        else:
            if at is None:
                at = getCallStack()
            self._value.__setattr__(name, value, at=at, label=label)

apply()

def lsst.pex.config.configurableField.ConfigurableInstance.apply	(		self,
			args,
			kw
	)

Call the configurable.

Notes
-----
In addition to the user-provided positional and keyword arguments,
the configurable is also provided a keyword argument ``config`` with
the value of `ConfigurableInstance.value`.

Definition at line 93 of file configurableField.py.

    def apply(self, *args, **kw):
        """Call the configurable.

        Notes
        -----
        In addition to the user-provided positional and keyword arguments,
        the configurable is also provided a keyword argument ``config`` with
        the value of `ConfigurableInstance.value`.
        """
        return self.target(*args, config=self.value, **kw)

retarget()

def lsst.pex.config.configurableField.ConfigurableInstance.retarget	(		self,
			target,
			ConfigClass = None,
			at = None,
			label = "retarget"
	)

Target a new configurable and ConfigClass

Definition at line 104 of file configurableField.py.

    def retarget(self, target, ConfigClass=None, at=None, label="retarget"):
        """Target a new configurable and ConfigClass
        """
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config, "Cannot modify a frozen Config")

        try:
            ConfigClass = self._field.validateTarget(target, ConfigClass)
        except BaseException as e:
            raise FieldValidationError(self._field, self._config, e.message)

        if at is None:
            at = getCallStack()
        object.__setattr__(self, "_target", target)
        if ConfigClass != self.ConfigClass:
            object.__setattr__(self, "_ConfigClass", ConfigClass)
            self.__initValue(at, label)

        history = self._config._history.setdefault(self._field.name, [])
        msg = "retarget(target=%s, ConfigClass=%s)" % (_typeStr(target), _typeStr(ConfigClass))
        history.append((msg, at, label))

Property Documentation

ConfigClass

lsst.pex.config.configurableField.ConfigurableInstance.ConfigClass = property(lambda x: x._ConfigClass)

static

Definition at line 84 of file configurableField.py.

target

lsst.pex.config.configurableField.ConfigurableInstance.target = property(lambda x: x._target)

static

Definition at line 80 of file configurableField.py.

value

lsst.pex.config.configurableField.ConfigurableInstance.value = property(lambda x: x._value)

static

Definition at line 88 of file configurableField.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/pex_config/18.1.0/python/lsst/pex/config/configurableField.py