lsst.pex.config
16.0-5-gd0f1235+1
|
Public Member Functions | |
def | __init__ (self, doc, typemap, default=None, optional=False, multi=False) |
def | __get__ (self, instance, owner=None) |
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 | __deepcopy__ (self, memo) |
def | __get__ (self, instance, owner=None, at=None, label="default") |
def | __delete__ (self, instance, at=None, label='deletion') |
Public Attributes | |
typemap | |
multi | |
dtype | |
doc | |
default | |
check | |
optional | |
source | |
Static Public Attributes | |
instanceDictClass = ConfigInstanceDict | |
supportedTypes = set((str, bool, float, int, complex)) | |
ConfigChoiceFields allow the config to choose from a set of possible Config types. The set of allowable types is given by the typemap argument to the constructor The typemap object must implement typemap[name], which must return a Config subclass. While the typemap is shared by all instances of the field, each instance of the field has its own instance of a particular sub-config type For example: class AaaConfig(Config): somefield = Field(int, "...") TYPEMAP = {"A", AaaConfig} class MyConfig(Config): choice = ConfigChoiceField("doc for choice", TYPEMAP) instance = MyConfig() instance.choice['AAA'].somefield = 5 instance.choice = "AAA" Alternatively, the last line can be written: instance.choice.name = "AAA" Validation of this field is performed only the "active" selection. If active is None and the field is not optional, validation will fail. ConfigChoiceFields can allow single selections or multiple selections. Single selection fields set selection through property name, and multi-selection fields use the property names. ConfigChoiceFields also allow multiple values of the same type: TYPEMAP["CCC"] = AaaConfig TYPEMAP["BBB"] = AaaConfig When saving a config with a ConfigChoiceField, the entire set is saved, as well as the active selection
Definition at line 279 of file configChoiceField.py.
def lsst.pex.config.configChoiceField.ConfigChoiceField.__init__ | ( | self, | |
doc, | |||
typemap, | |||
default = None , |
|||
optional = False , |
|||
multi = False |
|||
) |
Definition at line 319 of file configChoiceField.py.
def lsst.pex.config.configChoiceField.ConfigChoiceField.__deepcopy__ | ( | self, | |
memo | |||
) |
Customize deep-copying, because we always want a reference to the original typemap. WARNING: this must be overridden by subclasses if they change the constructor signature!
Definition at line 406 of file configChoiceField.py.
|
inherited |
|
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.
def lsst.pex.config.configChoiceField.ConfigChoiceField.__get__ | ( | self, | |
instance, | |||
owner = None |
|||
) |
Definition at line 338 of file configChoiceField.py.
def lsst.pex.config.configChoiceField.ConfigChoiceField.__set__ | ( | self, | |
instance, | |||
value, | |||
at = None , |
|||
label = "assignment" |
|||
) |
Definition at line 344 of file configChoiceField.py.
def lsst.pex.config.configChoiceField.ConfigChoiceField.freeze | ( | self, | |
instance | |||
) |
Definition at line 391 of file configChoiceField.py.
def lsst.pex.config.configChoiceField.ConfigChoiceField.rename | ( | self, | |
instance | |||
) |
Definition at line 358 of file configChoiceField.py.
def lsst.pex.config.configChoiceField.ConfigChoiceField.save | ( | self, | |
outfile, | |||
instance | |||
) |
Definition at line 396 of file configChoiceField.py.
def lsst.pex.config.configChoiceField.ConfigChoiceField.toDict | ( | self, | |
instance | |||
) |
Definition at line 375 of file configChoiceField.py.
def lsst.pex.config.configChoiceField.ConfigChoiceField.validate | ( | self, | |
instance | |||
) |
Definition at line 363 of file configChoiceField.py.
|
static |
Definition at line 317 of file configChoiceField.py.
lsst.pex.config.configChoiceField.ConfigChoiceField.multi |
Definition at line 324 of file configChoiceField.py.
|
staticinherited |
lsst.pex.config.configChoiceField.ConfigChoiceField.typemap |
Definition at line 323 of file configChoiceField.py.