RangeField¶
- class lsst.pex.config.RangeField(doc, dtype, default=None, optional=False, min=None, max=None, inclusiveMin=True, inclusiveMax=False, deprecated=None)¶
Bases:
Field
A configuration field (
lsst.pex.config.Field
subclass) that requires the value to be in a specific numeric range.- Parameters:
- doc
str
A description of the field.
- dtype{
int
-type,float
-type} - default
int
orfloat
, optional Default value for the field.
- optional
bool
, optional When
False
,lsst.pex.config.Config.validate
will fail if the field’s value isNone
.- minint, float, or
None
, optional Minimum value accepted in the range. If
None
, the range has no lower bound (equivalent to negative infinity).- max
int
,float
, or None, optional Maximum value accepted in the range. If
None
, the range has no upper bound (equivalent to positive infinity).- inclusiveMin
bool
, optional If
True
, themin
value is included in the allowed range.- inclusiveMax
bool
, optional If
True
, themax
value is included in the allowed range.- deprecatedNone 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.
- doc
See also
Attributes Summary
The set of data types allowed by
RangeField
instances (set
containingint
andfloat
types).Methods Summary
freeze
(instance)Make this field read-only (for internal use only).
rename
(instance)Rename the field in a
Config
(for internal use only).save
(outfile, instance)Save this field to a file (for internal use only).
toDict
(instance)Convert the field value so that it can be set as the value of an item in a
dict
(for internal use only).validate
(instance)Validate the field (for internal use only).
Attributes Documentation
- supportedTypes = {<class 'float'>, <class 'int'>}¶
The set of data types allowed by
RangeField
instances (set
containingint
andfloat
types).
Methods Documentation
- freeze(instance)¶
Make this field read-only (for internal use only).
- Parameters:
- instance
lsst.pex.config.Config
The config instance that contains this field.
- instance
Notes
Freezing is only relevant for fields that hold subconfigs. Fields which hold subconfigs should freeze each subconfig.
Subclasses should implement this method.
- rename(instance)¶
Rename the field in a
Config
(for internal use only).- Parameters:
- instance
lsst.pex.config.Config
The config instance that contains this field.
- instance
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
Field
instances that hold subconfigs.Field
s that hold subconfigs should rename each subconfig with the full field name as generated bylsst.pex.config.config._joinNamePath
.
- save(outfile, instance)¶
Save this field to a file (for internal use only).
- Parameters:
Notes
This method is invoked by the
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.
- toDict(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:
- Returns:
- valueobject
The field’s value. See Notes.
Notes
This method invoked by the owning
Config
object and should not be called directly.Simple values are passed through. Complex data structures must be manipulated. For example, a
Field
holding a subconfig should, instead of the subconfig object, return adict
where the keys are the field names in the subconfig, and the values are the field values in the subconfig.
- validate(instance)¶
Validate the field (for internal use only).
- Parameters:
- instance
lsst.pex.config.Config
The config instance that contains this field.
- instance
- 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
Field
subclasses should calllsst.pex.config.Field.validate
if they re-implementvalidate
.