lsst.pex.config.configChoiceField.ConfigInstanceDict Class Reference

Inheritance diagram for lsst.pex.config.configChoiceField.ConfigInstanceDict:

Public Member Functions
	__init__ (self, config, field)
	types (self)
	__contains__ (self, k)
	__len__ (self)
	__iter__ (self)
	__getitem__ (self, k, at=None, label="default")
	__setitem__ (self, k, value, at=None, label="assignment")
	__setattr__ (self, attr, value, at=None, label="assignment")
	freeze (self)
	__reduce__ (self)

Public Attributes
	types

Protected Member Functions
	_setSelection (self, value, at=None, label="assignment")
	_getNames (self)
	_setNames (self, value)
	_delNames (self)
	_getName (self)
	_setName (self, value)
	_delName (self)
	_getActive (self)
	_rename (self, fullname)

Protected Attributes
	_dict
	_selection
	_config
	_field
	_history
	_typemap

Properties
	names = property(_getNames, _setNames, _delNames)
	name = property(_getName, _setName, _delName)
	active = property(_getActive)

Detailed Description

Dictionary of instantiated configs, used to populate a
`~lsst.pex.config.ConfigChoiceField`.

Parameters
----------
config : `lsst.pex.config.Config`
    A configuration instance.
field : `lsst.pex.config.Field`-type
    A configuration field. Note that the `lsst.pex.config.Field.fieldmap`
    attribute must provide key-based access to configuration classes,
    (that is, ``typemap[name]``).

Definition at line 166 of file configChoiceField.py.

Constructor & Destructor Documentation

__init__()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__init__	(		self,
			config,
			field )

Reimplemented from lsst.pex.config.config.ConfigMeta.

Reimplemented in lsst.pex.config.registry.RegistryInstanceDict, lsst.pex.config.registry.RegistryField, and lsst.pex.config.configChoiceField.ConfigChoiceField.

Definition at line 180 of file configChoiceField.py.

    def __init__(self, config, field):
        collections.abc.Mapping.__init__(self)
        self._dict = {}
        self._selection = None
        self._config = config
        self._field = field
        self._history = config._history.setdefault(field.name, [])
        self.__doc__ = field.doc
        self._typemap = None
 

Member Function Documentation

__contains__()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__contains__	(		self,
			name )

Return `True` if the specified field exists in this config.

Parameters
----------
name : `str`
    Field name to test for.

Returns
-------
in : `bool`
    `True` if the specified field exists in the config.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 194 of file configChoiceField.py.

    def __contains__(self, k):
        return k in self.types
 

__getitem__()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__getitem__	(		self,
			k,
			at = None,
			label = "default" )

Definition at line 290 of file configChoiceField.py.

    def __getitem__(self, k, at=None, label="default"):
        try:
            value = self._dict[k]
        except KeyError:
            try:
                dtype = self.types[k]
            except Exception:
                raise FieldValidationError(
                    self._field, self._config, f"Unknown key {k!r} in Registry/ConfigChoiceField"
                )
            name = _joinNamePath(self._config._name, self._field.name, k)
            if at is None:
                at = getCallStack()
                at.insert(0, dtype._source)
            value = self._dict.setdefault(k, dtype(__name=name, __at=at, __label=label))
        return value
 

__iter__()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__iter__

(

self

)

Iterate over fields.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 200 of file configChoiceField.py.

    def __iter__(self):
        return iter(self.types)
 

__len__()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__len__

(

self

)

Definition at line 197 of file configChoiceField.py.

    def __len__(self):
        return len(self.types)
 

__reduce__()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__reduce__

(

self

)

Reduction for pickling (function with arguments to reproduce).

We need to condense and reconstitute the `~lsst.pex.config.Config`,
since it may contain lambdas (as the ``check`` elements) that cannot
be pickled.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 373 of file configChoiceField.py.

    def __reduce__(self):
        raise UnexpectedProxyUsageError(
            f"Proxy container for config field {self._field.name} cannot "
            "be pickled; it should be converted to a built-in container before "
            "being assigned to other objects or variables."
        )
 
 

__setattr__()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__setattr__	(		self,
			attr,
			value,
			at = None,
			label = "assignment" )

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.config.Config.

Reimplemented in lsst.pex.config.registry.RegistryInstanceDict.

Definition at line 341 of file configChoiceField.py.

    def __setattr__(self, attr, value, at=None, label="assignment"):
        if hasattr(getattr(self.__class__, attr, None), "__set__"):
            # This allows properties to work.
            object.__setattr__(self, attr, value)
        elif attr in self.__dict__ or attr in [
            "_history",
            "_field",
            "_config",
            "_dict",
            "_selection",
            "__doc__",
            "_typemap",
        ]:
            # This allows specific private attributes to work.
            object.__setattr__(self, attr, value)
        else:
            # We throw everything else.
            msg = f"{_typeStr(self._field)} has no attribute {attr}"
            raise FieldValidationError(self._field, self._config, msg)
 

__setitem__()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__setitem__	(		self,
			k,
			value,
			at = None,
			label = "assignment" )

Definition at line 307 of file configChoiceField.py.

    def __setitem__(self, k, value, at=None, label="assignment"):
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config, "Cannot modify a frozen Config")
 
        try:
            dtype = self.types[k]
        except Exception:
            raise FieldValidationError(self._field, self._config, f"Unknown key {k!r}")
 
        if value != dtype and type(value) is not dtype:
            msg = (
                f"Value {value} at key {k} is of incorrect type {_typeStr(value)}. "
                f"Expected type {_typeStr(dtype)}"
            )
            raise FieldValidationError(self._field, self._config, msg)
 
        if at is None:
            at = getCallStack()
        name = _joinNamePath(self._config._name, self._field.name, k)
        oldValue = self._dict.get(k, None)
        if oldValue is None:
            if value == dtype:
                self._dict[k] = value(__name=name, __at=at, __label=label)
            else:
                self._dict[k] = dtype(__name=name, __at=at, __label=label, **value._storage)
        else:
            if value == dtype:
                value = value()
            oldValue.update(__at=at, __label=label, **value._storage)
 

_delName()

lsst.pex.config.configChoiceField.ConfigInstanceDict._delName ( self )

protected

Definition at line 255 of file configChoiceField.py.

    def _delName(self):
        if self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Multi-selection field has no attribute 'name'"
            )
        self._selection = None
 

_delNames()

lsst.pex.config.configChoiceField.ConfigInstanceDict._delNames ( self )

protected

Definition at line 234 of file configChoiceField.py.

    def _delNames(self):
        if not self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Single-selection field has no attribute 'names'"
            )
        self._selection = None
 

_getActive()

lsst.pex.config.configChoiceField.ConfigInstanceDict._getActive ( self )

protected

Definition at line 274 of file configChoiceField.py.

    def _getActive(self):
        if self._selection is None:
            return None
 
        if self._field.multi:
            return [self[c] for c in self._selection]
        else:
            return self[self._selection]
 

_getName()

lsst.pex.config.configChoiceField.ConfigInstanceDict._getName ( self )

protected

Definition at line 241 of file configChoiceField.py.

    def _getName(self):
        if self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Multi-selection field has no attribute 'name'"
            )
        return self._selection
 

_getNames()

lsst.pex.config.configChoiceField.ConfigInstanceDict._getNames ( self )

protected

Definition at line 220 of file configChoiceField.py.

    def _getNames(self):
        if not self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Single-selection field has no attribute 'names'"
            )
        return self._selection
 

_rename()

lsst.pex.config.configChoiceField.ConfigInstanceDict._rename ( self, name )

protected

Rename this config object in its parent `~lsst.pex.config.Config`.

Parameters
----------
name : `str`
    New name for this config in its parent `~lsst.pex.config.Config`.

Notes
-----
This method uses the `~lsst.pex.config.Field.rename` method of
individual `lsst.pex.config.Field` instances.
`lsst.pex.config.Field` subclasses may need to implement a ``rename``
method for *this* method to work.

See Also
--------
lsst.pex.config.Field.rename

Reimplemented from lsst.pex.config.config.Config.

Definition at line 337 of file configChoiceField.py.

    def _rename(self, fullname):
        for k, v in self._dict.items():
            v._rename(_joinNamePath(name=fullname, index=k))
 

_setName()

lsst.pex.config.configChoiceField.ConfigInstanceDict._setName ( self, value )

protected

Definition at line 248 of file configChoiceField.py.

    def _setName(self, value):
        if self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Multi-selection field has no attribute 'name'"
            )
        self._setSelection(value)
 

_setNames()

lsst.pex.config.configChoiceField.ConfigInstanceDict._setNames ( self, value )

protected

Definition at line 227 of file configChoiceField.py.

    def _setNames(self, value):
        if not self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Single-selection field has no attribute 'names'"
            )
        self._setSelection(value)
 

_setSelection()

lsst.pex.config.configChoiceField.ConfigInstanceDict._setSelection ( self, value, at = None, label = "assignment" )

protected

Definition at line 203 of file configChoiceField.py.

    def _setSelection(self, value, at=None, label="assignment"):
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config, "Cannot modify a frozen Config")
 
        if at is None:
            at = getCallStack(1)
 
        if value is None:
            self._selection = None
        elif self._field.multi:
            self._selection = SelectionSet(self, value, setHistory=False)
        else:
            if value not in self._dict:
                self.__getitem__(value, at=at)  # just invoke __getitem__ to make sure it's present
            self._selection = value
        self._history.append((value, at, label))
 

freeze()

lsst.pex.config.configChoiceField.ConfigInstanceDict.freeze

(

self

)

Freeze the config.

Invoking this freeze method will create a local copy of the field
attribute's typemap. This decouples this instance dict from the
underlying objects type map ensuring that and subsequent changes to the
typemap will not be reflected in this instance (i.e imports adding
additional registry entries).

Reimplemented from lsst.pex.config.config.Config.

Reimplemented in lsst.pex.config.configChoiceField.ConfigChoiceField.

Definition at line 361 of file configChoiceField.py.

    def freeze(self):
        """Freeze the config.
 
        Invoking this freeze method will create a local copy of the field
        attribute's typemap. This decouples this instance dict from the
        underlying objects type map ensuring that and subsequent changes to the
        typemap will not be reflected in this instance (i.e imports adding
        additional registry entries).
        """
        if self._typemap is None:
            self._typemap = copy.deepcopy(self.types)
 

types()

lsst.pex.config.configChoiceField.ConfigInstanceDict.types

(

self

)

Definition at line 191 of file configChoiceField.py.

    def types(self):
        return self._typemap if self._typemap is not None else self._field.typemap
 

Member Data Documentation

_config

lsst.pex.config.configChoiceField.ConfigInstanceDict._config

protected

Definition at line 184 of file configChoiceField.py.

_dict

lsst.pex.config.configChoiceField.ConfigInstanceDict._dict

protected

Definition at line 182 of file configChoiceField.py.

_field

lsst.pex.config.configChoiceField.ConfigInstanceDict._field

protected

Definition at line 185 of file configChoiceField.py.

_history

lsst.pex.config.configChoiceField.ConfigInstanceDict._history

protected

Definition at line 186 of file configChoiceField.py.

_selection

lsst.pex.config.configChoiceField.ConfigInstanceDict._selection

protected

Definition at line 183 of file configChoiceField.py.

_typemap

lsst.pex.config.configChoiceField.ConfigInstanceDict._typemap

protected

Definition at line 188 of file configChoiceField.py.

types

lsst.pex.config.configChoiceField.ConfigInstanceDict.types

Definition at line 198 of file configChoiceField.py.

Property Documentation

active

lsst.pex.config.configChoiceField.ConfigInstanceDict.active = property(_getActive)

static

Definition at line 283 of file configChoiceField.py.

name

lsst.pex.config.configChoiceField.ConfigInstanceDict.name = property(_getName, _setName, _delName)

static

Definition at line 268 of file configChoiceField.py.

names

lsst.pex.config.configChoiceField.ConfigInstanceDict.names = property(_getNames, _setNames, _delNames)

static

Definition at line 262 of file configChoiceField.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/pex_config/g89c8672015+f4add4ffd5/python/lsst/pex/config/configChoiceField.py