lsst.pex.config.dictField.Dict Class Reference

Inheritance diagram for lsst.pex.config.dictField.Dict:

Public Member Functions
def	__init__ (self, config, field, value, at, label, setHistory=True)
def	__getitem__ (self, k)
def	__len__ (self)
def	__iter__ (self)
def	__contains__ (self, k)
def	__setitem__ (self, k, x, at=None, label="setitem", setHistory=True)
def	__delitem__ (self, k, at=None, label="delitem", setHistory=True)
def	__repr__ (self)
def	__str__ (self)
def	__setattr__ (self, attr, value, at=None, label="assignment")

Properties
	history = property(lambda x: x._history)

Detailed Description

An internal mapping container.

This class emulates a `dict`, but adds validation and provenance.

Definition at line 39 of file dictField.py.

Constructor & Destructor Documentation

__init__()

def lsst.pex.config.dictField.Dict.__init__	(		self,
			config,
			field,
			value,
			at,
			label,
			setHistory = True
	)

Definition at line 45 of file dictField.py.

    def __init__(self, config, field, value, at, label, setHistory=True):
        self._field = field
        self._config_ = weakref.ref(config)
        self._dict = {}
        self._history = self._config._history.setdefault(self._field.name, [])
        self.__doc__ = field.doc
        if value is not None:
            try:
                for k in value:
                    # do not set history per-item
                    self.__setitem__(k, value[k], at=at, label=label, setHistory=False)
            except TypeError:
                msg = "Value %s is of incorrect type %s. Mapping type expected." % \
                    (value, _typeStr(value))
                raise FieldValidationError(self._field, self._config, msg)
        if setHistory:
            self._history.append((dict(self._dict), at, label))
 

Member Function Documentation

__contains__()

def lsst.pex.config.dictField.Dict.__contains__	(		self,
			k
	)

Definition at line 83 of file dictField.py.

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

__delitem__()

def lsst.pex.config.dictField.Dict.__delitem__	(		self,
			k,
			at = None,
			label = "delitem",
			setHistory = True
	)

Definition at line 123 of file dictField.py.

    def __delitem__(self, k, at=None, label="delitem", setHistory=True):
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config,
                                       "Cannot modify a frozen Config")
 
        del self._dict[k]
        if setHistory:
            if at is None:
                at = getCallStack()
            self._history.append((dict(self._dict), at, label))
 

__getitem__()

def lsst.pex.config.dictField.Dict.__getitem__	(		self,
			k
	)

Definition at line 74 of file dictField.py.

    def __getitem__(self, k):
        return self._dict[k]
 

__iter__()

def lsst.pex.config.dictField.Dict.__iter__

(

self

)

Definition at line 80 of file dictField.py.

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

__len__()

def lsst.pex.config.dictField.Dict.__len__

(

self

)

Definition at line 77 of file dictField.py.

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

__repr__()

def lsst.pex.config.dictField.Dict.__repr__

(

self

)

Definition at line 134 of file dictField.py.

    def __repr__(self):
        return repr(self._dict)
 

__setattr__()

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

Definition at line 140 of file dictField.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 ["_field", "_config_", "_history", "_dict", "__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.dictField.Dict.__setitem__	(		self,
			k,
			x,
			at = None,
			label = "setitem",
			setHistory = True
	)

Reimplemented in lsst.pex.config.configDictField.ConfigDict.

Definition at line 86 of file dictField.py.

    def __setitem__(self, k, x, at=None, label="setitem", setHistory=True):
        if self._config._frozen:
            msg = "Cannot modify a frozen Config. "\
                "Attempting to set item at key %r to value %s" % (k, x)
            raise FieldValidationError(self._field, self._config, msg)
 
        # validate keytype
        k = _autocast(k, self._field.keytype)
        if type(k) != self._field.keytype:
            msg = "Key %r is of type %s, expected type %s" % \
                (k, _typeStr(k), _typeStr(self._field.keytype))
            raise FieldValidationError(self._field, self._config, msg)
 
        # validate itemtype
        x = _autocast(x, self._field.itemtype)
        if self._field.itemtype is None:
            if type(x) not in self._field.supportedTypes and x is not None:
                msg = "Value %s at key %r is of invalid type %s" % (x, k, _typeStr(x))
                raise FieldValidationError(self._field, self._config, msg)
        else:
            if type(x) != self._field.itemtype and x is not None:
                msg = "Value %s at key %r is of incorrect type %s. Expected type %s" % \
                    (x, k, _typeStr(x), _typeStr(self._field.itemtype))
                raise FieldValidationError(self._field, self._config, msg)
 
        # validate item using itemcheck
        if self._field.itemCheck is not None and not self._field.itemCheck(x):
            msg = "Item at key %r is not a valid value: %s" % (k, x)
            raise FieldValidationError(self._field, self._config, msg)
 
        if at is None:
            at = getCallStack()
 
        self._dict[k] = x
        if setHistory:
            self._history.append((dict(self._dict), at, label))
 

__str__()

def lsst.pex.config.dictField.Dict.__str__

(

self

)

Definition at line 137 of file dictField.py.

    def __str__(self):
        return str(self._dict)
 

Property Documentation

history

lsst.pex.config.dictField.Dict.history = property(lambda x: x._history)

static

Definition at line 70 of file dictField.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/dictField.py