Inheritance diagram for lsst.pex.config.choiceField.ChoiceField:

Public Member Functions
	__init__ (self, doc, dtype=None, allowed=None, default=None, optional=True, deprecated=None)

Public Attributes
	allowed

	source

Protected Member Functions
	_validateValue (self, value)

Detailed Description

A configuration field (`~lsst.pex.config.Field` subclass) that allows a
user to select from a predefined set of values.

Use ``ChoiceField`` when a configuration can only take one of a predefined
set of values. Each choice must be of the same type.

Parameters
----------
doc : `str`
    Documentation string that describes the configuration field.
dtype : class
    The type of the field's choices. For example, `str` or `int`.
allowed : `dict`
    The allowed values. Keys are the allowed choices (of ``dtype``-type).
    Values are descriptions (`str`-type) of each choice.
default : ``dtype``-type, optional
    The default value, which is of type ``dtype`` and one of the allowed
    choices.
optional : `bool`, optional
    If `True`, this configuration field is *optional*. Default is `True`.
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
--------
ConfigChoiceField
ConfigDictField
ConfigField
ConfigurableField
DictField
Field
ListField
RangeField
RegistryField

Definition at line 34 of file choiceField.py.

Constructor & Destructor Documentation

◆ init()

lsst.pex.config.choiceField.ChoiceField.__init__	(	self,
		doc,
		dtype = None,
		allowed = None,
		default = None,
		optional = True,
		deprecated = None )

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

Definition at line 72 of file choiceField.py.

    def __init__(self, doc, dtype=None, allowed=None, default=None, optional=True, deprecated=None):
        if dtype is None:
            raise ValueError("supplied dtype must not be None")
        if allowed is None:
            raise ValueError("supplied allowed mapping must not be None")
        self.allowed = dict(allowed)
        if optional and None not in self.allowed:
            self.allowed[None] = "Field is optional"
 
        if len(self.allowed) == 0:
            raise ValueError("ChoiceFields must allow at least one choice")
 
        Field.__init__(
            self, doc=doc, dtype=dtype, default=default, check=None, optional=optional, deprecated=deprecated
        )
 
        self.__doc__ += "\n\nAllowed values:\n\n"
        for choice, choiceDoc in self.allowed.items():
            if choice is not None and not isinstance(choice, dtype):
                raise ValueError(
                    "ChoiceField's allowed choice %s is of incorrect type %s. Expected %s"
                    % (choice, _typeStr(choice), _typeStr(dtype))
                )
            self.__doc__ += "{}\n  {}\n".format(f"``{str(choice)!r}``", choiceDoc)
 
        self.source = getStackFrame()
 

Member Function Documentation

◆ _validateValue()

lsst.pex.config.choiceField.ChoiceField._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 99 of file choiceField.py.

    def _validateValue(self, value):
        Field._validateValue(self, value)
        if value not in self.allowed:
            msg = "Value {} is not allowed.\n\tAllowed values: [{}]".format(
                value, ", ".join(str(key) for key in self.allowed)
            )
            raise ValueError(msg)

Member Data Documentation

◆ allowed

lsst.pex.config.choiceField.ChoiceField.allowed

Definition at line 77 of file choiceField.py.

◆ source

lsst.pex.config.choiceField.ChoiceField.source

Definition at line 97 of file choiceField.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pex_config/gba4ed39666+c2a2e4ac27/python/lsst/pex/config/choiceField.py

Public Member Functions

Public Attributes

Protected Member Functions