ConfigurableInstance

class lsst.pex.config.ConfigurableInstance(config, field, at=None, label='default')

Bases: Generic[FieldTypeVar]

A retargetable configuration in a ConfigurableField that proxies a Config.

Notes

ConfigurableInstance implements __getattr__ and __setattr__ methods that forward to the Config it holds. ConfigurableInstance adds a retarget method.

The actual Config instance is accessed using the value property (e.g. to get its documentation). The associated configurable object (usually a Task) is accessed using the target property.

Attributes Summary

ConfigClass	The configuration class (read-only)
target	The targeted configurable (read-only).
value	The ConfigClass instance (lsst.pex.config.Config-type, read-only).

Methods Summary

apply(*args, **kw)	Call the configurable.
retarget(target[, ConfigClass, at, label])	Target a new configurable and ConfigClass.

Attributes Documentation

ConfigClass

The configuration class (read-only)

target

The targeted configurable (read-only).

value

The ConfigClass instance (lsst.pex.config.Config-type, read-only).

Methods Documentation

apply(*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.

retarget(target, ConfigClass=None, at=None, label='retarget')

Target a new configurable and ConfigClass.