lsst.pex.config.registry.RegistryInstanceDict Class Reference

Inheritance diagram for lsst.pex.config.registry.RegistryInstanceDict:

Public Member Functions
	__init__ (self, config, field)
	apply (self, *args, **kwargs)
	apply_with (self, selection, *args, **kwargs)
	__setattr__ (self, attr, value)

Public Attributes
	registry

Protected Member Functions
	_getTarget (self)
	_getTargets (self)

Protected Attributes
	_field
	_config
	_selection

Properties
	target = property(_getTarget)
	targets = property(_getTargets)

Detailed Description

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

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

Definition at line 244 of file registry.py.

Constructor & Destructor Documentation

__init__()

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

Reimplemented from lsst.pex.config.configChoiceField.ConfigInstanceDict.

Definition at line 255 of file registry.py.

    def __init__(self, config, field):
        ConfigInstanceDict.__init__(self, config, field)
        self.registry = field.registry
 

Member Function Documentation

__setattr__()

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

Set an attribute (such as a field's value).

Notes
-----
Unlike normal Python objects, `~lsst.pex.config.Config` objects are
locked such that no additional attributes nor properties may be added
to them dynamically.

Although this is not the standard Python behavior, it helps to protect
users from accidentally mispelling a field name, or trying to set a
non-existent field.

Reimplemented from lsst.pex.config.configChoiceField.ConfigInstanceDict.

Definition at line 333 of file registry.py.

    def __setattr__(self, attr, value):
        if attr == "registry":
            object.__setattr__(self, attr, value)
        else:
            ConfigInstanceDict.__setattr__(self, attr, value)
 
 

_getTarget()

lsst.pex.config.registry.RegistryInstanceDict._getTarget ( self )

protected

Definition at line 259 of file registry.py.

    def _getTarget(self):
        if self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Multi-selection field has no attribute 'target'"
            )
        return self.types.registry[self._selection]
 

_getTargets()

lsst.pex.config.registry.RegistryInstanceDict._getTargets ( self )

protected

Definition at line 268 of file registry.py.

    def _getTargets(self):
        if not self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Single-selection field has no attribute 'targets'"
            )
        return [self.types.registry[c] for c in self._selection]
 

apply()

lsst.pex.config.registry.RegistryInstanceDict.apply	(		self,
		*	args,
		**	kwargs )

Call the active target(s) with the active config as a keyword arg.

Parameters
----------
*args, **kwargs : `~typing.Any
    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.

Definition at line 277 of file registry.py.

    def apply(self, *args, **kwargs):
        """Call the active target(s) with the active config as a keyword arg.
 
        Parameters
        ----------
        *args, **kwargs : `~typing.Any
            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.
        """
        if self.active is None:
            if self._field._on_none is not None:
                return self._field._on_none(self, *args, **kwargs)
            msg = "No selection has been made.  Options: %s" % " ".join(self.types.registry.keys())
            raise FieldValidationError(self._field, self._config, msg)
        return self.apply_with(self._selection, *args, **kwargs)
 

apply_with()

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.

Definition at line 299 of file registry.py.

    def 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.
        """
        if self._field.multi:
            retvals = []
            for c in selection:
                retvals.append(self.types.registry[c](*args, config=self[c], **kwargs))
            return retvals
        else:
            return self.types.registry[selection](*args, config=self[selection], **kwargs)
 

Member Data Documentation

_config

lsst.pex.config.registry.RegistryInstanceDict._config

protected

Definition at line 262 of file registry.py.

_field

lsst.pex.config.registry.RegistryInstanceDict._field

protected

Definition at line 262 of file registry.py.

_selection

lsst.pex.config.registry.RegistryInstanceDict._selection

protected

Definition at line 297 of file registry.py.

registry

lsst.pex.config.registry.RegistryInstanceDict.registry

Definition at line 257 of file registry.py.

Property Documentation

target

lsst.pex.config.registry.RegistryInstanceDict.target = property(_getTarget)

static

Definition at line 266 of file registry.py.

targets

lsst.pex.config.registry.RegistryInstanceDict.targets = property(_getTargets)

static

Definition at line 275 of file registry.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/gba4ed39666+9664299f35/python/lsst/pex/config/registry.py