lsst.pex.config
18.1.0-3-g6b74884
|
Public Member Functions | |
def | __init__ (self, doc, registry, default=None, optional=False, multi=False) |
def | __deepcopy__ (self, memo) |
def | __get__ (self, instance, owner=None) |
def | __get__ (self, instance, owner=None, at=None, label="default") |
def | __set__ (self, instance, value, at=None, label="assignment") |
def | rename (self, instance) |
def | validate (self, instance) |
def | toDict (self, instance) |
def | freeze (self, instance) |
def | save (self, outfile, instance) |
def | __delete__ (self, instance, at=None, label='deletion') |
Public Attributes | |
registry | |
typemap | |
multi | |
dtype | |
doc | |
deprecated | |
default | |
check | |
optional | |
source | |
Static Public Attributes | |
instanceDictClass = RegistryInstanceDict | |
supportedTypes = set((str, bool, float, int, complex)) | |
A configuration field whose options are defined in a `Registry`. Parameters ---------- doc : `str` A description of the field. registry : `Registry` The registry that contains this field. default : `str`, optional The default target key. optional : `bool`, optional When `False`, `lsst.pex.config.Config.validate` fails if the field's value is `None`. multi : `bool`, optional If `True`, the field allows multiple selections. The default is `False`. See also -------- ChoiceField ConfigChoiceField ConfigDictField ConfigField ConfigurableField DictField Field ListField RangeField
Definition at line 277 of file registry.py.
def pex.config.registry.RegistryField.__init__ | ( | self, | |
doc, | |||
registry, | |||
default = None , |
|||
optional = False , |
|||
multi = False |
|||
) |
Definition at line 312 of file registry.py.
def pex.config.registry.RegistryField.__deepcopy__ | ( | self, | |
memo | |||
) |
Customize deep-copying, want a reference to the original registry. WARNING: this must be overridden by subclasses if they change the constructor signature!
Definition at line 317 of file registry.py.
|
inherited |
Delete an attribute from a `lsst.pex.config.Config` instance. Parameters ---------- instance : `lsst.pex.config.Config` The config instance that contains this field. at : `list` of `lsst.pex.config.callStack.StackFrame` The call stack (created by `lsst.pex.config.callStack.getCallStack`). label : `str`, optional Event label for the history. Notes ----- This is invoked by the owning `~lsst.pex.config.Config` object and should not be called directly.
|
inherited |
Definition at line 430 of file configChoiceField.py.
|
inherited |
Define how attribute access should occur on the Config instance This is invoked by the owning config object and should not be called directly When the field attribute is accessed on a Config class object, it returns the field object itself in order to allow inspection of Config classes. When the field attribute is access on a config instance, the actual value described by the field (and held by the Config instance) is returned.
|
inherited |
Definition at line 436 of file configChoiceField.py.
|
inherited |
Definition at line 483 of file configChoiceField.py.
|
inherited |
Definition at line 450 of file configChoiceField.py.
|
inherited |
Definition at line 498 of file configChoiceField.py.
|
inherited |
Definition at line 467 of file configChoiceField.py.
|
inherited |
Definition at line 455 of file configChoiceField.py.
|
static |
Definition at line 308 of file registry.py.
|
inherited |
Definition at line 416 of file configChoiceField.py.
pex.config.registry.RegistryField.registry |
Definition at line 314 of file registry.py.
|
staticinherited |
|
inherited |
Definition at line 415 of file configChoiceField.py.