lsst.pex.config.configurableField.ConfigurableInstance Class Reference

Inheritance diagram for lsst.pex.config.configurableField.ConfigurableInstance:

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

Protected Member Functions
Config	_config (self)

Protected Attributes
	_field
	_config
	_value

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

Parameters
----------
config : `~lsst.pex.config.Config`
    Config to proxy.
field : `~lsst.pex.config.ConfigurableField`
    Field to use.
at : `list` of `~lsst.pex.config.callStack.StackFrame` or `None`, optional
    Stack frame for history recording. Will be calculated if `None`.
label : `str`, optional
    Label to use for history recording.

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 50 of file configurableField.py.

Constructor & Destructor Documentation

__init__()

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

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

Definition at line 94 of file configurableField.py.

    def __init__(self, config, field, at=None, label="default"):
        object.__setattr__(self, "_config_", weakref.ref(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__()

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 202 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__()

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

Definition at line 182 of file configurableField.py.

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

__reduce__()

lsst.pex.config.configurableField.ConfigurableInstance.__reduce__

(

self

)

Definition at line 219 of file configurableField.py.

    def __reduce__(self):
        raise UnexpectedProxyUsageError(
            f"Proxy object for config field {self._field.name} cannot "
            "be pickled; it should be converted to a normal `Config` instance "
            "via the `value` property before being assigned to other objects "
            "or variables."
        )
 
 

__setattr__()

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 185 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)
 

_config()

Config lsst.pex.config.configurableField.ConfigurableInstance._config ( self )

protected

Definition at line 111 of file configurableField.py.

    def _config(self) -> Config:
        # Config Fields should never outlive their config class instance
        # assert that as such here
        assert self._config_() is not None
        return self._config_()
 

apply()

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

Call the configurable.

Parameters
----------
*args : `~typing.Any`
    Arguments to use when calling the configurable.
**kw : `~typing.Any`
    Keyword parameters to use when calling.

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 130 of file configurableField.py.

    def apply(self, *args, **kw):
        """Call the configurable.
 
        Parameters
        ----------
        *args : `~typing.Any`
            Arguments to use when calling the configurable.
        **kw : `~typing.Any`
            Keyword parameters to use when calling.
 
        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()

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

Target a new configurable and ConfigClass.

Parameters
----------
target : `type`
    Item to retarget.
ConfigClass : `type` or `None`, optional
    New config class to use.
at : `list` of `~lsst.pex.config.callStack.StackFrame` or `None`,\
        optional
    Stack for history recording.
label : `str`, optional
    Label for history recording.

Definition at line 148 of file configurableField.py.

    def retarget(self, target, ConfigClass=None, at=None, label="retarget"):
        """Target a new configurable and ConfigClass.
 
        Parameters
        ----------
        target : `type`
            Item to retarget.
        ConfigClass : `type` or `None`, optional
            New config class to use.
        at : `list` of `~lsst.pex.config.callStack.StackFrame` or `None`,\
                optional
            Stack for history recording.
        label : `str`, optional
            Label for history recording.
        """
        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 = f"retarget(target={_typeStr(target)}, ConfigClass={_typeStr(ConfigClass)})"
        history.append((msg, at, label))
 

Member Data Documentation

_config

lsst.pex.config.configurableField.ConfigurableInstance._config

protected

Definition at line 164 of file configurableField.py.

_field

lsst.pex.config.configurableField.ConfigurableInstance._field

protected

Definition at line 164 of file configurableField.py.

_value

lsst.pex.config.configurableField.ConfigurableInstance._value

protected

Definition at line 183 of file configurableField.py.

Property Documentation

ConfigClass

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

static

Definition at line 121 of file configurableField.py.

target

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

static

Definition at line 117 of file configurableField.py.

value

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

static

Definition at line 125 of file configurableField.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pex_config/gfbcc870c63+9a11dc8c8f/python/lsst/pex/config/configurableField.py