lsst.pex.config
17.0.1-1-g703d48b+3
|
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) | |
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 32 of file listField.py.
def lsst.pex.config.listField.List.__init__ | ( | self, | |
config, | |||
field, | |||
value, | |||
at, | |||
label, | |||
setHistory = True |
|||
) |
Definition at line 59 of file listField.py.
def lsst.pex.config.listField.List.__contains__ | ( | self, | |
x | |||
) |
Definition at line 111 of file listField.py.
def lsst.pex.config.listField.List.__delitem__ | ( | self, | |
i, | |||
at = None , |
|||
label = "delitem" , |
|||
setHistory = True |
|||
) |
Definition at line 141 of file listField.py.
def lsst.pex.config.listField.List.__eq__ | ( | self, | |
other | |||
) |
Definition at line 182 of file listField.py.
def lsst.pex.config.listField.List.__getitem__ | ( | self, | |
i | |||
) |
Definition at line 138 of file listField.py.
def lsst.pex.config.listField.List.__iter__ | ( | self | ) |
Definition at line 151 of file listField.py.
def lsst.pex.config.listField.List.__len__ | ( | self | ) |
Definition at line 114 of file listField.py.
def lsst.pex.config.listField.List.__ne__ | ( | self, | |
other | |||
) |
Definition at line 195 of file listField.py.
def lsst.pex.config.listField.List.__repr__ | ( | self | ) |
Definition at line 176 of file listField.py.
def lsst.pex.config.listField.List.__setattr__ | ( | self, | |
attr, | |||
value, | |||
at = None , |
|||
label = "assignment" |
|||
) |
Definition at line 198 of file listField.py.
def lsst.pex.config.listField.List.__setitem__ | ( | self, | |
i, | |||
x, | |||
at = None , |
|||
label = "setitem" , |
|||
setHistory = True |
|||
) |
Definition at line 117 of file listField.py.
def lsst.pex.config.listField.List.__str__ | ( | self | ) |
Definition at line 179 of file listField.py.
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 154 of file listField.py.
def lsst.pex.config.listField.List.list | ( | self | ) |
Sequence of items contained by the `List` (`list`).
Definition at line 102 of file listField.py.
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 75 of file listField.py.
|
static |
Definition at line 107 of file listField.py.