lsst.pex.config.configChoiceField.ConfigInstanceDict Class Reference

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

Public Member Functions
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)

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 144 of file configChoiceField.py.

Constructor & Destructor Documentation

__init__()

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

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

Definition at line 157 of file configChoiceField.py.

    def __init__(self, config, field):
        collections.abc.Mapping.__init__(self)
        self._dict = 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__()

def lsst.pex.config.configChoiceField.ConfigInstanceDict.__contains__	(		self,
			k
	)

Definition at line 171 of file configChoiceField.py.

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

__getitem__()

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

Definition at line 261 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,
                                           "Unknown key %r in Registry/ConfigChoiceField" % k)
            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__()

def lsst.pex.config.configChoiceField.ConfigInstanceDict.__iter__

(

self

)

Definition at line 177 of file configChoiceField.py.

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

__len__()

def lsst.pex.config.configChoiceField.ConfigInstanceDict.__len__

(

self

)

Definition at line 174 of file configChoiceField.py.

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

__setattr__()

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

Definition at line 309 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 = "%s has no attribute %s" % (_typeStr(self._field), attr)
            raise FieldValidationError(self._field, self._config, msg)
 

__setitem__()

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

Definition at line 277 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, "Unknown key %r" % k)
 
        if value != dtype and type(value) != dtype:
            msg = "Value %s at key %s is of incorrect type %s. Expected type %s" % \
                (value, k, _typeStr(value), _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)
 

freeze()

def lsst.pex.config.configChoiceField.ConfigInstanceDict.freeze

(

self

)

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

Definition at line 322 of file configChoiceField.py.

    def freeze(self):
        """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()

def lsst.pex.config.configChoiceField.ConfigInstanceDict.types

(

self

)

Definition at line 168 of file configChoiceField.py.

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

Property Documentation

active

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

static

Definition at line 254 of file configChoiceField.py.

name

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

static

Definition at line 239 of file configChoiceField.py.

names

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

static

Definition at line 233 of file configChoiceField.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pex_config/22.0.1-2-gd1925c9+bf4f0e694f/python/lsst/pex/config/configChoiceField.py