LSSTApplications
18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
|
Public Member Functions | |
def | __init__ (self, doc, dtype, default=None, check=None, deprecated=None) |
def | __get__ (self, instance, owner=None) |
def | __set__ (self, instance, value, at=None, label="assignment") |
def | rename (self, instance) |
def | save (self, outfile, instance) |
def | freeze (self, instance) |
def | toDict (self, instance) |
def | validate (self, instance) |
def | __get__ (self, instance, owner=None, at=None, label="default") |
def | __delete__ (self, instance, at=None, label='deletion') |
Public Attributes | |
dtype | |
doc | |
deprecated | |
default | |
check | |
optional | |
source | |
Static Public Attributes | |
supportedTypes = set((str, bool, float, int, complex)) | |
A configuration field (`~lsst.pex.config.Field` subclass) that takes a `~lsst.pex.config.Config`-type as a value. Parameters ---------- doc : `str` A description of the configuration field. dtype : `lsst.pex.config.Config`-type The type of the field, which must be a subclass of `lsst.pex.config.Config`. default : `lsst.pex.config.Config`, optional If default is `None`, the field will default to a default-constructed instance of ``dtype``. Additionally, to allow for fewer deep-copies, assigning an instance of ``ConfigField`` to ``dtype`` itself, is considered equivalent to assigning a default-constructed sub-config. This means that the argument default can be ``dtype``, as well as an instance of ``dtype``. check : callable, optional A callback function that validates the field's value, returning `True` if the value is valid, and `False` otherwise. deprecated : None or `str`, optional A description of why this Field is deprecated, including removal date. If not None, the string is appended to the docstring for this Field. See also -------- ChoiceField ConfigChoiceField ConfigDictField ConfigurableField DictField Field ListField RangeField RegistryField Notes ----- The behavior of this type of field is much like that of the base `Field` type. Assigning to ``ConfigField`` will update all of the fields in the configuration.
Definition at line 35 of file configField.py.
def pex.config.configField.ConfigField.__init__ | ( | self, | |
doc, | |||
dtype, | |||
default = None , |
|||
check = None , |
|||
deprecated = None |
|||
) |
Definition at line 81 of file configField.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.
Definition at line 573 of file config.py.
def pex.config.configField.ConfigField.__get__ | ( | self, | |
instance, | |||
owner = None |
|||
) |
Definition at line 91 of file configField.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.
Definition at line 498 of file config.py.
def pex.config.configField.ConfigField.__set__ | ( | self, | |
instance, | |||
value, | |||
at = None , |
|||
label = "assignment" |
|||
) |
Definition at line 102 of file configField.py.
def pex.config.configField.ConfigField.freeze | ( | self, | |
instance | |||
) |
Make this field read-only. Parameters ---------- instance : `lsst.pex.config.Config` The config instance that contains this field. Notes ----- Freezing is only relevant for fields that hold subconfigs. Fields which hold subconfigs should freeze each subconfig. **Subclasses should implement this method.**
Definition at line 181 of file configField.py.
def pex.config.configField.ConfigField.rename | ( | self, | |
instance | |||
) |
Rename the field in a `~lsst.pex.config.Config` (for internal use only). Parameters ---------- instance : `lsst.pex.config.Config` The config instance that contains this field. Notes ----- This method is invoked by the `lsst.pex.config.Config` object that contains this field and should not be called directly. Renaming is only relevant for `~lsst.pex.config.Field` instances that hold subconfigs. `~lsst.pex.config.Fields` that hold subconfigs should rename each subconfig with the full field name as generated by `lsst.pex.config.config._joinNamePath`.
Definition at line 130 of file configField.py.
def pex.config.configField.ConfigField.save | ( | self, | |
outfile, | |||
instance | |||
) |
Save this field to a file (for internal use only). Parameters ---------- outfile : file-like object A writeable field handle. instance : `Config` The `Config` instance that contains this field. Notes ----- This method is invoked by the `~lsst.pex.config.Config` object that contains this field and should not be called directly. The output consists of the documentation string (`lsst.pex.config.Field.doc`) formatted as a Python comment. The second line is formatted as an assignment: ``{fullname}={value}``. This output can be executed with Python.
Definition at line 157 of file configField.py.
def pex.config.configField.ConfigField.toDict | ( | self, | |
instance | |||
) |
Convert the field value so that it can be set as the value of an item in a `dict` (for internal use only). Parameters ---------- instance : `Config` The `Config` that contains this field. Returns ------- value : object The field's value. See *Notes*. Notes ----- This method invoked by the owning `~lsst.pex.config.Config` object and should not be called directly. Simple values are passed through. Complex data structures must be manipulated. For example, a `~lsst.pex.config.Field` holding a subconfig should, instead of the subconfig object, return a `dict` where the keys are the field names in the subconfig, and the values are the field values in the subconfig.
Definition at line 199 of file configField.py.
def pex.config.configField.ConfigField.validate | ( | self, | |
instance | |||
) |
Validate the field (for internal use only). Parameters ---------- instance : `lsst.pex.config.Config` The config instance that contains this field. Raises ------ lsst.pex.config.FieldValidationError Raised if verification fails. Notes ----- This method provides basic validation: - Ensures that the value is not `None` if the field is not optional. - Ensures type correctness. - Ensures that the user-provided ``check`` function is valid. Most `~lsst.pex.config.Field` subclasses should call `lsst.pex.config.field.Field.validate` if they re-implement `~lsst.pex.config.field.Field.validate`.
Definition at line 227 of file configField.py.
|
staticinherited |