Coverage for python/lsst/pex/config/choiceField.py : 62%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# This file is part of pex_config. # # Developed for the LSST Data Management System. # This product includes software developed by the LSST Project # (http://www.lsst.org). # See the COPYRIGHT file at the top-level directory of this distribution # for details of code ownership. # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>.
"""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`.
See also -------- ConfigChoiceField ConfigDictField ConfigField ConfigurableField DictField Field ListField RangeField RegistryField """
raise ValueError("ChoiceFields must allow at least one choice")
check=None, optional=optional)
raise ValueError("ChoiceField's allowed choice %s is of incorrect type %s. Expected %s" % (choice, _typeStr(choice), _typeStr(dtype)))
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) |