lsst.pex.config.listField.List Class Reference

Inheritance diagram for lsst.pex.config.listField.List:

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

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

Detailed Description

List collection used internally by `ListField`.

Parameters
----------
config : `lsst.pex.config.Config`
    Config instance that contains the ``field``.
field : `ListField`
    Instance of the `ListField` using this ``List``.
value : sequence
    Sequence of values that are inserted into this ``List``.
at : `list` of `lsst.pex.config.callStack.StackFrame`
    The call stack (created by `lsst.pex.config.callStack.getCallStack`).
label : `str`
    Event label for the history.
setHistory : `bool`, optional
    Enable setting the field's history, using the value of the ``at``
    parameter. Default is `True`.

Raises
------
FieldValidationError
    Raised if an item in the ``value`` parameter does not have the
    appropriate type for this field or does not pass the
    `ListField.itemCheck` method of the ``field`` parameter.

Definition at line 39 of file listField.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 66 of file listField.py.

    def __init__(self, config, field, value, at, label, setHistory=True):
        self._field = field
        self._config_ = weakref.ref(config)
        self._history = self._config._history.setdefault(self._field.name, [])
        self._list = []
        self.__doc__ = field.doc
        if value is not None:
            try:
                for i, x in enumerate(value):
                    self.insert(i, x, setHistory=False)
            except TypeError:
                msg = "Value %s is of incorrect type %s. Sequence type expected" % (value, _typeStr(value))
                raise FieldValidationError(self._field, config, msg)
        if setHistory:
            self.history.append((list(self._list), at, label))
 

Member Function Documentation

__contains__()

def lsst.pex.config.listField.List.__contains__	(		self,
			x
	)

Definition at line 125 of file listField.py.

    def __contains__(self, x):
        return x in self._list
 

__delitem__()

def lsst.pex.config.listField.List.__delitem__	(		self,
			i,
			at = None,
			label = "delitem",
			setHistory = True
	)

Definition at line 155 of file listField.py.

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

__eq__()

def lsst.pex.config.listField.List.__eq__	(		self,
			other
	)

Definition at line 196 of file listField.py.

    def __eq__(self, other):
        try:
            if len(self) != len(other):
                return False
 
            for i, j in zip(self, other):
                if i != j:
                    return False
            return True
        except AttributeError:
            # other is not a sequence type
            return False
 

__getitem__()

def lsst.pex.config.listField.List.__getitem__	(		self,
			i
	)

Definition at line 152 of file listField.py.

    def __getitem__(self, i):
        return self._list[i]
 

__iter__()

def lsst.pex.config.listField.List.__iter__

(

self

)

Definition at line 165 of file listField.py.

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

__len__()

def lsst.pex.config.listField.List.__len__

(

self

)

Definition at line 128 of file listField.py.

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

__ne__()

def lsst.pex.config.listField.List.__ne__	(		self,
			other
	)

Definition at line 209 of file listField.py.

    def __ne__(self, other):
        return not self.__eq__(other)
 

__repr__()

def lsst.pex.config.listField.List.__repr__

(

self

)

Definition at line 190 of file listField.py.

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

__setattr__()

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

Definition at line 212 of file listField.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", "_list", "__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.listField.List.__setitem__	(		self,
			i,
			x,
			at = None,
			label = "setitem",
			setHistory = True
	)

Definition at line 131 of file listField.py.

    def __setitem__(self, i, x, at=None, label="setitem", setHistory=True):
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config,
                                       "Cannot modify a frozen Config")
        if isinstance(i, slice):
            k, stop, step = i.indices(len(self))
            for j, xj in enumerate(x):
                xj = _autocast(xj, self._field.itemtype)
                self.validateItem(k, xj)
                x[j] = xj
                k += step
        else:
            x = _autocast(x, self._field.itemtype)
            self.validateItem(i, x)
 
        self._list[i] = x
        if setHistory:
            if at is None:
                at = getCallStack()
            self.history.append((list(self._list), at, label))
 

__str__()

def lsst.pex.config.listField.List.__str__

(

self

)

Definition at line 193 of file listField.py.

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

insert()

def lsst.pex.config.listField.List.insert	(		self,
			i,
			x,
			at = None,
			label = "insert",
			setHistory = True
	)

Insert an item into the list at the given index.

Parameters
----------
i : `int`
    Index where the item is inserted.
x : object
    Item that is inserted.
at : `list` of `lsst.pex.config.callStack.StackFrame`, optional
    The call stack (created by
    `lsst.pex.config.callStack.getCallStack`).
label : `str`, optional
    Event label for the history.
setHistory : `bool`, optional
    Enable setting the field's history, using the value of the ``at``
    parameter. Default is `True`.

Definition at line 168 of file listField.py.

    def insert(self, i, x, at=None, label="insert", setHistory=True):
        """Insert an item into the list at the given index.
 
        Parameters
        ----------
        i : `int`
            Index where the item is inserted.
        x : object
            Item that is inserted.
        at : `list` of `lsst.pex.config.callStack.StackFrame`, optional
            The call stack (created by
            `lsst.pex.config.callStack.getCallStack`).
        label : `str`, optional
            Event label for the history.
        setHistory : `bool`, optional
            Enable setting the field's history, using the value of the ``at``
            parameter. Default is `True`.
        """
        if at is None:
            at = getCallStack()
        self.__setitem__(slice(i, i), [x], at=at, label=label, setHistory=setHistory)
 

list()

def lsst.pex.config.listField.List.list

(

self

)

Sequence of items contained by the `List` (`list`).

Definition at line 116 of file listField.py.

    def list(self):
        """Sequence of items contained by the `List` (`list`).
        """
        return self._list
 

validateItem()

def lsst.pex.config.listField.List.validateItem	(		self,
			i,
			x
	)

Validate an item to determine if it can be included in the list.

Parameters
----------
i : `int`
    Index of the item in the `list`.
x : object
    Item in the `list`.

Raises
------
FieldValidationError
    Raised if an item in the ``value`` parameter does not have the
    appropriate type for this field or does not pass the field's
    `ListField.itemCheck` method.

Definition at line 89 of file listField.py.

    def validateItem(self, i, x):
        """Validate an item to determine if it can be included in the list.
 
        Parameters
        ----------
        i : `int`
            Index of the item in the `list`.
        x : object
            Item in the `list`.
 
        Raises
        ------
        FieldValidationError
            Raised if an item in the ``value`` parameter does not have the
            appropriate type for this field or does not pass the field's
            `ListField.itemCheck` method.
        """
 
        if not isinstance(x, self._field.itemtype) and x is not None:
            msg = "Item at position %d with value %s is of incorrect type %s. Expected %s" % \
                (i, x, _typeStr(x), _typeStr(self._field.itemtype))
            raise FieldValidationError(self._field, self._config, msg)
 
        if self._field.itemCheck is not None and not self._field.itemCheck(x):
            msg = "Item at position %d is not a valid value: %s" % (i, x)
            raise FieldValidationError(self._field, self._config, msg)
 

Property Documentation

history

lsst.pex.config.listField.List.history = property(lambda x: x._history)

static

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