lsst.pex.config gb673666cb6+6a8a80267a
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Properties | List of all members
lsst.pex.config.registry.RegistryInstanceDict Class Reference
Inheritance diagram for lsst.pex.config.registry.RegistryInstanceDict:
lsst.pex.config.configChoiceField.ConfigInstanceDict

Public Member Functions

def __init__ (self, config, field)
 
def apply (self, *args, **kwargs)
 
def apply_with (self, selection, *args, **kwargs)
 
def __setattr__ (self, attr, value)
 
- Public Member Functions inherited from lsst.pex.config.configChoiceField.ConfigInstanceDict
def __init__ (self, config, field)
 
def types (self)
 
def __contains__ (self, k)
 
def __len__ (self)
 
def __iter__ (self)
 
def __getitem__ (self, k, at=None, label="default")
 
def __setitem__ (self, k, value, at=None, label="assignment")
 
def __setattr__ (self, attr, value, at=None, label="assignment")
 
def freeze (self)
 
def __reduce__ (self)
 

Public Attributes

 registry
 

Properties

 target = property(_getTarget)
 
 targets = property(_getTargets)
 
- Properties inherited from lsst.pex.config.configChoiceField.ConfigInstanceDict
 names = property(_getNames, _setNames, _delNames)
 
 name = property(_getName, _setName, _delName)
 
 active = property(_getActive)
 

Detailed Description

Dictionary of instantiated configs, used to populate a `RegistryField`.

Parameters
----------
config : `lsst.pex.config.Config`
    Configuration instance.
field : `RegistryField`
    Configuration field.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pex.config.registry.RegistryInstanceDict.__init__ (   self,
  config,
  field 
)

Member Function Documentation

◆ __setattr__()

def lsst.pex.config.registry.RegistryInstanceDict.__setattr__ (   self,
  attr,
  value 
)

◆ apply()

def lsst.pex.config.registry.RegistryInstanceDict.apply (   self,
args,
**  kwargs 
)
Call the active target(s) with the active config as a keyword arg.

Parameters
----------
selection : `str` or `~collections.abc.Iterable` [ `str` ]
    Name or names of targets, depending on whether ``multi=True``.
*args, **kwargs
    Additional arguments will be passed on to the configurable
    target(s).

Returns
-------
result
    If this is a single-selection field, the return value from calling
    the target. If this is a multi-selection field, a list thereof.

◆ apply_with()

def lsst.pex.config.registry.RegistryInstanceDict.apply_with (   self,
  selection,
args,
**  kwargs 
)
Call named target(s) with the corresponding config as a keyword
arg.

Parameters
----------
selection : `str` or `~collections.abc.Iterable` [ `str` ]
    Name or names of targets, depending on whether ``multi=True``.
*args, **kwargs
    Additional arguments will be passed on to the configurable
    target(s).

Returns
-------
result
    If this is a single-selection field, the return value from calling
    the target. If this is a multi-selection field, a list thereof.

Notes
-----
This method ignores the current selection in the ``name`` or ``names``
attribute, which is usually not what you want.  This method is most
useful in ``on_none`` callbacks provided at field construction, which
allow a context-dependent default to be used when no selection is
configured.

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