pex.config.registry.RegistryInstanceDict Class Reference

Inheritance diagram for pex.config.registry.RegistryInstanceDict:

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

Public Attributes
	registry

Properties
	target = property(_getTarget)
	targets = property(_getTargets)
	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 225 of file registry.py.

Constructor & Destructor Documentation

__init__()

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

Reimplemented from pex.config.configChoiceField.ConfigInstanceDict.

Definition at line 236 of file registry.py.

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

Member Function Documentation

__contains__()

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

inherited

Definition at line 162 of file configChoiceField.py.

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

__getitem__()

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

inherited

Definition at line 252 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 pex.config.configChoiceField.ConfigInstanceDict.__iter__ (   self )

inherited

Definition at line 168 of file configChoiceField.py.

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

__len__()

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

inherited

Definition at line 165 of file configChoiceField.py.

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

__setattr__() [1/2]

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

Definition at line 276 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 pex.config.configChoiceField.ConfigInstanceDict.__setattr__ (   self,   attr,   value,   at = None,   label = "assignment"  )

inherited

Definition at line 300 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 pex.config.configChoiceField.ConfigInstanceDict.__setitem__ (   self,   k,   value,   at = None,   label = "assignment"  )

inherited

Definition at line 268 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 %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 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 256 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(self.types.registry.keys())
            raise FieldValidationError(self._field, self._config, msg)
        if self._field.multi:
            retvals = []
            for c in self._selection:
                retvals.append(self.types.registry[c](*args, config=self[c], **kw))
            return retvals
        else:
            return self.types.registry[self.name](*args, config=self[self.name], **kw)
 

freeze()

def pex.config.configChoiceField.ConfigInstanceDict.freeze (   self )

inherited

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 313 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 pex.config.configChoiceField.ConfigInstanceDict.types (   self )

inherited

Definition at line 159 of file configChoiceField.py.

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

Member Data Documentation

registry

pex.config.registry.RegistryInstanceDict.registry

Definition at line 238 of file registry.py.

Property Documentation

active

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

staticinherited

Definition at line 245 of file configChoiceField.py.

name

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

staticinherited

Definition at line 230 of file configChoiceField.py.

names

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

staticinherited

Definition at line 224 of file configChoiceField.py.

target

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

static

Definition at line 246 of file registry.py.

targets

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

static

Definition at line 254 of file registry.py.

---

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

• /j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/pex_config/20.0.0+34a42eae2c/python/lsst/pex/config/registry.py