lsst.pex.config.rangeField.RangeField Class Reference

Inheritance diagram for lsst.pex.config.rangeField.RangeField:

Public Member Functions
	__init__ (self, doc, dtype, default=None, optional=False, min=None, max=None, inclusiveMin=True, inclusiveMax=False, deprecated=None)

Public Attributes
	min
	max
	maxCheck
	minCheck
	rangeString

Static Public Attributes
dict	supportedTypes = {int, float}

Protected Member Functions
	_validateValue (self, value)

Detailed Description

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

Definition at line 34 of file rangeField.py.

Constructor & Destructor Documentation

__init__()

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

Reimplemented from lsst.pex.config.config.Field.

Definition at line 81 of file rangeField.py.

    ):
        if dtype not in self.supportedTypes:
            raise ValueError(f"Unsupported RangeField dtype {_typeStr(dtype)}")
        source = getStackFrame()
        if min is None and max is None:
            raise ValueError("min and max cannot both be None")
 
        if min is not None and max is not None:
            if min > max:
                raise ValueError(f"min = {min} > {max} = max")
            elif min == max and not (inclusiveMin and inclusiveMax):
                raise ValueError(f"min = max = {min} and min and max not both inclusive")
 
        self.min = min
        """Minimum value accepted in the range. If `None`, the range has no
        lower bound (equivalent to negative infinity).
        """
 
        self.max = max
        """Maximum value accepted in the range. If `None`, the range has no
        upper bound (equivalent to positive infinity).
        """
 
        if inclusiveMax:
            self.maxCheck = lambda x, y: True if y is None else x <= y
        else:
            self.maxCheck = lambda x, y: True if y is None else x < y
        if inclusiveMin:
            self.minCheck = lambda x, y: True if y is None else x >= y
        else:
            self.minCheck = lambda x, y: True if y is None else x > y
        self._setup(
            doc,
            dtype=dtype,
            default=default,
            check=None,
            optional=optional,
            source=source,
            deprecated=deprecated,
        )
        self.rangeString = "{}{},{}{}".format(
            ("[" if inclusiveMin else "("),
            ("-inf" if self.min is None else self.min),
            ("inf" if self.max is None else self.max),
            ("]" if inclusiveMax else ")"),
        )
        """String representation of the field's allowed range (`str`).
        """
 
        self.__doc__ += "\n\nValid Range = " + self.rangeString
 

Member Function Documentation

_validateValue()

lsst.pex.config.rangeField.RangeField._validateValue ( self, value )

protected

Validate a value.

Parameters
----------
value : object
    The value being validated.

Raises
------
TypeError
    Raised if the value's type is incompatible with the field's
    ``dtype``.
ValueError
    Raised if the value is rejected by the ``check`` method.

Reimplemented from lsst.pex.config.config.Field.

Definition at line 143 of file rangeField.py.

    def _validateValue(self, value):
        Field._validateValue(self, value)
        if not self.minCheck(value, self.min) or not self.maxCheck(value, self.max):
            msg = f"{value} is outside of valid range {self.rangeString}"
            raise ValueError(msg)

Member Data Documentation

max

lsst.pex.config.rangeField.RangeField.max

Definition at line 110 of file rangeField.py.

maxCheck

lsst.pex.config.rangeField.RangeField.maxCheck

Definition at line 116 of file rangeField.py.

min

lsst.pex.config.rangeField.RangeField.min

Definition at line 105 of file rangeField.py.

minCheck

lsst.pex.config.rangeField.RangeField.minCheck

Definition at line 120 of file rangeField.py.

rangeString

lsst.pex.config.rangeField.RangeField.rangeString

Definition at line 132 of file rangeField.py.

supportedTypes

dict lsst.pex.config.rangeField.RangeField.supportedTypes = {int, float}

static

Definition at line 76 of file rangeField.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/pex_config/g2cdde0e794+704103fe75/python/lsst/pex/config/rangeField.py