lsst.pex.config  17.0.1-1-g703d48b+3
Public Member Functions | Properties | List of all members
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.

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.

◆ __getattr__()

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

Definition at line 126 of file configurableField.py.

◆ __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.

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

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

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: