lsst.pex.config.configChoiceField.SelectionSet Class Reference

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

Public Member Functions
def	__init__ (self, dict_, value, at=None, label="assignment", setHistory=True)
def	add (self, value, at=None)
def	discard (self, value, at=None)
def	__len__ (self)
def	__iter__ (self)
def	__contains__ (self, value)
def	__repr__ (self)
def	__str__ (self)

Detailed Description

A mutable set class that tracks the selection of multi-select
`~lsst.pex.config.ConfigChoiceField` objects.

Parameters
----------
dict_ : `ConfigInstanceDict`
    The dictionary of instantiated configs.
value
    The selected key.
at : `lsst.pex.config.callStack.StackFrame`, optional
    The call stack when the selection was made.
label : `str`, optional
    Label for history tracking.
setHistory : `bool`, optional
    Add this even to the history, if `True`.

Notes
-----
This class allows a user of a multi-select
`~lsst.pex.config.ConfigChoiceField` to add or discard items from the set
of active configs. Each change to the selection is tracked in the field's
history.

Definition at line 40 of file configChoiceField.py.

Constructor & Destructor Documentation

__init__()

def lsst.pex.config.configChoiceField.SelectionSet.__init__	(		self,
			dict_,
			value,
			at = None,
			label = "assignment",
			setHistory = True
	)

Definition at line 65 of file configChoiceField.py.

    def __init__(self, dict_, value, at=None, label="assignment", setHistory=True):
        if at is None:
            at = getCallStack()
        self._dict = dict_
        self._field = self._dict._field
        self._config_ = weakref.ref(self._dict._config)
        self.__history = self._config._history.setdefault(self._field.name, [])
        if value is not None:
            try:
                for v in value:
                    if v not in self._dict:
                        # invoke __getitem__ to ensure it's present
                        self._dict.__getitem__(v, at=at)
            except TypeError:
                msg = "Value %s is of incorrect type %s. Sequence type expected" % (value, _typeStr(value))
                raise FieldValidationError(self._field, self._config, msg)
            self._set = set(value)
        else:
            self._set = set()
 
        if setHistory:
            self.__history.append(("Set selection to %s" % self, at, label))
 

Member Function Documentation

__contains__()

def lsst.pex.config.configChoiceField.SelectionSet.__contains__	(		self,
			value
	)

Definition at line 134 of file configChoiceField.py.

    def __contains__(self, value):
        return value in self._set
 

__iter__()

def lsst.pex.config.configChoiceField.SelectionSet.__iter__

(

self

)

Definition at line 131 of file configChoiceField.py.

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

__len__()

def lsst.pex.config.configChoiceField.SelectionSet.__len__

(

self

)

Definition at line 128 of file configChoiceField.py.

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

__repr__()

def lsst.pex.config.configChoiceField.SelectionSet.__repr__

(

self

)

Definition at line 137 of file configChoiceField.py.

    def __repr__(self):
        return repr(list(self._set))
 

__str__()

def lsst.pex.config.configChoiceField.SelectionSet.__str__

(

self

)

Definition at line 140 of file configChoiceField.py.

    def __str__(self):
        return str(list(self._set))
 
 

add()

def lsst.pex.config.configChoiceField.SelectionSet.add	(		self,
			value,
			at = None
	)

Add a value to the selected set.

Definition at line 95 of file configChoiceField.py.

    def add(self, value, at=None):
        """Add a value to the selected set.
        """
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config,
                                       "Cannot modify a frozen Config")
 
        if at is None:
            at = getCallStack()
 
        if value not in self._dict:
            # invoke __getitem__ to make sure it's present
            self._dict.__getitem__(value, at=at)
 
        self.__history.append(("added %s to selection" % value, at, "selection"))
        self._set.add(value)
 

discard()

def lsst.pex.config.configChoiceField.SelectionSet.discard	(		self,
			value,
			at = None
	)

Discard a value from the selected set.

Definition at line 112 of file configChoiceField.py.

    def discard(self, value, at=None):
        """Discard a value from the selected set.
        """
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config,
                                       "Cannot modify a frozen Config")
 
        if value not in self._dict:
            return
 
        if at is None:
            at = getCallStack()
 
        self.__history.append(("removed %s from selection" % value, at, "selection"))
        self._set.discard(value)
 

---

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-1-g87000a6+536b1ee016/python/lsst/pex/config/configChoiceField.py