RangeField

class lsst.pex.config.RangeField(doc, dtype, default=None, optional=False, min=None, max=None, inclusiveMin=True, inclusiveMax=False, deprecated=None)

Bases: lsst.pex.config.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}

The field’s data type: either the int or float type.

default : int or float, optional

Default value for the field.

optional : bool, optional

When False, lsst.pex.config.Config.validate will fail if the field’s value is None.

min : int, 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, the min value is included in the allowed range.

inclusiveMax : bool, optional

If True, the max value is included in the allowed range.

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
ConfigField
ConfigurableField
DictField
Field
ListField
RegistryField

Attributes Summary

supportedTypes The set of data types allowed by RangeField instances (set containing int and float 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 containing int and float 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.

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.

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. Fields that hold subconfigs should rename each subconfig with the full field name as generated by lsst.pex.config.config._joinNamePath.

save(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 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:
instance : Config

The Config that contains this field.
Returns:
value : object

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 a dict 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.
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 call lsst.pex.config.field.Field.validate if they re-implement validate.