lsst.pex.config.listField.List Class Reference

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

Public Member Functions
	__init__ (self, config, field, value, at, label, setHistory=True)
	validateItem (self, i, x)
	list (self)
	__contains__ (self, x)
	__len__ (self)
None	__setitem__ (self, int i, FieldTypeVar x, Any at=None, str label="setitem", bool setHistory=True)
None	__setitem__ (self, slice i, Iterable[FieldTypeVar] x, Any at=None, str label="setitem", bool setHistory=True)
	__setitem__ (self, i, x, at=None, label="setitem", setHistory=True)
FieldTypeVar	__getitem__ (self, int i)
MutableSequence[FieldTypeVar]	__getitem__ (self, slice i)
	__getitem__ (self, i)
	__delitem__ (self, i, at=None, label="delitem", setHistory=True)
	__iter__ (self)
	insert (self, i, x, at=None, label="insert", setHistory=True)
	__repr__ (self)
	__str__ (self)
	__eq__ (self, other)
	__ne__ (self, other)
	__setattr__ (self, attr, value, at=None, label="assignment")
	__reduce__ (self)

Protected Member Functions
Config	_config (self)

Protected Attributes
	_field = field
	_config_ = weakref.ref(config)
Config	_history = self._config._history.setdefault(self._field.name, [])
list	_list = []
	_config

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 49 of file listField.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 76 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 as e:
                msg = f"Value {value} is of incorrect type {_typeStr(value)}. Sequence type expected"
                raise FieldValidationError(self._field, config, msg) from e
        if setHistory:
            self.history.append((list(self._list), at, label))
 

Member Function Documentation

__contains__()

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

Definition at line 136 of file listField.py.

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

__delitem__()

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

Definition at line 186 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__()

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

Definition at line 227 of file listField.py.

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

__getitem__() [1/3]

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

Definition at line 183 of file listField.py.

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

__getitem__() [2/3]

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

Definition at line 178 of file listField.py.

    def __getitem__(self, i: int) -> FieldTypeVar: ...
 

__getitem__() [3/3]

MutableSequence[FieldTypeVar] lsst.pex.config.listField.List.__getitem__	(		self,
		slice	i )

Definition at line 181 of file listField.py.

    def __getitem__(self, i: slice) -> MutableSequence[FieldTypeVar]: ...
 

__iter__()

lsst.pex.config.listField.List.__iter__

(

self

)

Definition at line 195 of file listField.py.

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

__len__()

lsst.pex.config.listField.List.__len__

(

self

)

Definition at line 139 of file listField.py.

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

__ne__()

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

Definition at line 242 of file listField.py.

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

__reduce__()

lsst.pex.config.listField.List.__reduce__

(

self

)

Definition at line 257 of file listField.py.

    def __reduce__(self):
        raise UnexpectedProxyUsageError(
            f"Proxy container for config field {self._field.name} cannot "
            "be pickled; it should be converted to a built-in container before "
            "being assigned to other objects or variables."
        )
 
 

__repr__()

lsst.pex.config.listField.List.__repr__

(

self

)

Definition at line 221 of file listField.py.

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

__setattr__()

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

Definition at line 245 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 = f"{_typeStr(self._field)} has no attribute {attr}"
            raise FieldValidationError(self._field, self._config, msg)
 

__setitem__() [1/3]

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

Definition at line 157 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))
 

__setitem__() [2/3]

None lsst.pex.config.listField.List.__setitem__	(		self,
		int	i,
		FieldTypeVar	x,
		Any	at = None,
		str	label = "setitem",
		bool	setHistory = True )

Definition at line 143 of file listField.py.

    ) -> None: ...
 

__setitem__() [3/3]

None lsst.pex.config.listField.List.__setitem__	(		self,
		slice	i,
		Iterable[FieldTypeVar]	x,
		Any	at = None,
		str	label = "setitem",
		bool	setHistory = True )

Definition at line 148 of file listField.py.

    ) -> None: ...
 

__str__()

lsst.pex.config.listField.List.__str__

(

self

)

Definition at line 224 of file listField.py.

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

_config()

Config lsst.pex.config.listField.List._config ( self )

protected

Definition at line 93 of file listField.py.

    def _config(self) -> Config:
        # Config Fields should never outlive their config class instance
        # assert that as such here
        value = self._config_()
        assert value is not None
        return value
 

insert()

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` or `None`,\
        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 198 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` or `None`,\
                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()

lsst.pex.config.listField.List.list

(

self

)

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

Definition at line 128 of file listField.py.

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

validateItem()

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 100 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 = (
                f"Item at position {i} with value {x} is of incorrect type {_typeStr(x)}. "
                f"Expected {_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 = f"Item at position {i} is not a valid value: {x}"
            raise FieldValidationError(self._field, self._config, msg)
 

Member Data Documentation

_config

lsst.pex.config.listField.List._config

protected

Definition at line 122 of file listField.py.

_config_

lsst.pex.config.listField.List._config_ = weakref.ref(config)

protected

Definition at line 78 of file listField.py.

_field

lsst.pex.config.listField.List._field = field

protected

Definition at line 77 of file listField.py.

_history

Config lsst.pex.config.listField.List._history = self._config._history.setdefault(self._field.name, [])

protected

Definition at line 79 of file listField.py.

_list

lsst.pex.config.listField.List._list = []

protected

Definition at line 80 of file listField.py.

Property Documentation

history

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

static

Definition at line 132 of file listField.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/pex_config/gabf8522325+cc757f8247/python/lsst/pex/config/listField.py