lsst.pex.config.registry.RegistryInstanceDict Class Reference

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

Public Member Functions
def	__init__ (self, config, field)
def	apply (self, args, kw)
def	__setattr__ (self, attr, value)
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")

Public Attributes
	registry

Properties
	target = property(_getTarget)
	targets = property(_getTargets)
	types = property(lambda x: x._field.typemap)
	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.

Definition at line 220 of file registry.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 231 of file registry.py.

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

Member Function Documentation

__contains__()

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

inherited

Definition at line 154 of file configChoiceField.py.

    def __contains__(self, k):
        return k in self._field.typemap

__getitem__()

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

inherited

Definition at line 244 of file configChoiceField.py.

    def __getitem__(self, k, at=None, label="default"):
        try:
            value = self._dict[k]
        except KeyError:
            try:
                dtype = self._field.typemap[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 )

inherited

Definition at line 160 of file configChoiceField.py.

    def __iter__(self):
        return iter(self._field.typemap)

__len__()

def lsst.pex.config.configChoiceField.ConfigInstanceDict.__len__ (   self )

inherited

Definition at line 157 of file configChoiceField.py.

    def __len__(self):
        return len(self._field.typemap)

__setattr__() [1/2]

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

Definition at line 271 of file registry.py.

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

__setattr__() [2/2]

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

inherited

Definition at line 292 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__"]:
            # 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"  )

inherited

Definition at line 260 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._field.typemap[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 %k 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)

apply()

def lsst.pex.config.registry.RegistryInstanceDict.apply	(		self,
			args,
			kw
	)

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

If this is a multi-selection field, return a list obtained by calling
each active target with its corresponding active config.

Additional arguments will be passed on to the configurable target(s)

Definition at line 251 of file registry.py.

    def apply(self, *args, **kw):
        """Call the active target(s) with the active config as a keyword arg

        If this is a multi-selection field, return a list obtained by calling
        each active target with its corresponding active config.

        Additional arguments will be passed on to the configurable target(s)
        """
        if self.active is None:
            msg = "No selection has been made.  Options: %s" % \
                (" ".join(list(self._field.typemap.registry.keys())))
            raise FieldValidationError(self._field, self._config, msg)
        if self._field.multi:
            retvals = []
            for c in self._selection:
                retvals.append(self._field.typemap.registry[c](*args, config=self[c], **kw))
            return retvals
        else:
            return self._field.typemap.registry[self.name](*args, config=self[self.name], **kw)

Member Data Documentation

registry

lsst.pex.config.registry.RegistryInstanceDict.registry

Definition at line 233 of file registry.py.

Property Documentation

active

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

staticinherited

Definition at line 237 of file configChoiceField.py.

name

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

staticinherited

Definition at line 222 of file configChoiceField.py.

names

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

staticinherited

Definition at line 216 of file configChoiceField.py.

target

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

static

Definition at line 241 of file registry.py.

targets

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

static

Definition at line 249 of file registry.py.

types

lsst.pex.config.configChoiceField.ConfigInstanceDict.types = property(lambda x: x._field.typemap)

staticinherited

Definition at line 152 of file configChoiceField.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/pex_config/16.0-13-g118c103+3/python/lsst/pex/config/registry.py