lsst.pex.config.configChoiceField.ConfigChoiceField Class Reference

Inheritance diagram for lsst.pex.config.configChoiceField.ConfigChoiceField:

Public Member Functions
def	__init__ (self, doc, typemap, default=None, optional=False, multi=False)
def	__get__ (self, instance, owner=None)
def	__set__ (self, instance, value, at=None, label="assignment")
def	rename (self, instance)
def	validate (self, instance)
def	toDict (self, instance)
def	freeze (self, instance)
def	save (self, outfile, instance)
def	__deepcopy__ (self, memo)
def	__get__ (self, instance, owner=None, at=None, label="default")
def	__delete__ (self, instance, at=None, label='deletion')

Public Attributes
	typemap
	multi
	dtype
	doc
	default
	check
	optional
	source

Static Public Attributes
	instanceDictClass = ConfigInstanceDict
	supportedTypes = set((str, bool, float, int, complex))

Detailed Description

A configuration field (`~lsst.pex.config.Field` subclass) that allows a
user to choose from a set of `~lsst.pex.config.Config` types.

Parameters
----------
doc : `str`
    Documentation string for the field.
typemap : `dict`-like
    A mapping between keys and `~lsst.pex.config.Config`-types as values.
    See *Examples* for details.
default : `str`, optional
    The default configuration name.
optional : `bool`, optional
    When `False`, `lsst.pex.config.Config.validate` will fail if the
    field's value is `None`.
multi : `bool`, optional
    If `True`, the field allows multiple selections. In this case, set the
    selections by assigning a sequence to the ``names`` attribute of the
    field.

    If `False`, the field allows only a single selection. In this case,
    set the active config by assigning the config's key from the
    ``typemap`` to the field's ``name`` attribute (see *Examples*).

See also
--------
ChoiceField
ConfigDictField
ConfigField
ConfigurableField
DictField
Field
ListField
RangeField
RegistryField

Notes
-----
``ConfigChoiceField`` instances can allow either single selections or
multiple selections, depending on the ``multi`` parameter. For
single-selection fields, set the selection with the ``name`` attribute.
For multi-selection fields, set the selection though the ``names``
attribute.

This field is validated only against the active selection. If the
``active`` attribute is `None` and the field is not optional, validation
will fail.

When saving a configuration with a ``ConfigChoiceField``, the entire set is
saved, as well as the active selection.

Examples
--------
While the ``typemap`` is shared by all instances of the field, each
instance of the field has its own instance of a particular sub-config type.

For example, ``AaaConfig`` is a config object

>>> from lsst.pex.config import Config, ConfigChoiceField, Field
>>> class AaaConfig(Config):
...     somefield = Field("doc", int)
...

The ``MyConfig`` config has a ``ConfigChoiceField`` field called ``choice``
that maps the ``AaaConfig`` type to the ``"AAA"`` key:

>>> TYPEMAP = {"AAA", AaaConfig}
>>> class MyConfig(Config):
...     choice = ConfigChoiceField("doc for choice", TYPEMAP)
...

Creating an instance of ``MyConfig``:

>>> instance = MyConfig()

Setting value of the field ``somefield`` on the "AAA" key of the ``choice``
field:

>>> instance.choice['AAA'].somefield = 5

**Selecting the active configuration**

Make the ``"AAA"`` key the active configuration value for the ``choice``
field:

>>> instance.choice = "AAA"

Alternatively, the last line can be written:

>>> instance.choice.name = "AAA"

(If the config instance allows multiple selections, you'd assign a sequence
to the ``names`` attribute instead.)

``ConfigChoiceField`` instances also allow multiple values of the same type:

>>> TYPEMAP["CCC"] = AaaConfig
>>> TYPEMAP["BBB"] = AaaConfig

Definition at line 306 of file configChoiceField.py.

Constructor & Destructor Documentation

__init__()

def lsst.pex.config.configChoiceField.ConfigChoiceField.__init__	(		self,
			doc,
			typemap,
			default = None,
			optional = False,
			multi = False
	)

Definition at line 409 of file configChoiceField.py.

    def __init__(self, doc, typemap, default=None, optional=False, multi=False):
        source = getStackFrame()
        self._setup(doc=doc, dtype=self.instanceDictClass, default=default, check=None, optional=optional,
                    source=source)
        self.typemap = typemap
        self.multi = multi

Member Function Documentation

__deepcopy__()

def lsst.pex.config.configChoiceField.ConfigChoiceField.__deepcopy__	(		self,
			memo
	)

Customize deep-copying, because we always want a reference to the
original typemap.

WARNING: this must be overridden by subclasses if they change the
constructor signature!

Definition at line 496 of file configChoiceField.py.

    def __deepcopy__(self, memo):
        """Customize deep-copying, because we always want a reference to the
        original typemap.

        WARNING: this must be overridden by subclasses if they change the
        constructor signature!
        """
        other = type(self)(doc=self.doc, typemap=self.typemap, default=copy.deepcopy(self.default),
                           optional=self.optional, multi=self.multi)
        other.source = self.source
        return other

__delete__()

def lsst.pex.config.config.Field.__delete__ (   self,   instance,   at = None,   label = 'deletion'  )

inherited

Delete an attribute from a `lsst.pex.config.Config` instance.

Parameters
----------
instance : `lsst.pex.config.Config`
    The config instance that contains this field.
at : `list` of `lsst.pex.config.callStack.StackFrame`
    The call stack (created by
    `lsst.pex.config.callStack.getCallStack`).
label : `str`, optional
    Event label for the history.

Notes
-----
This is invoked by the owning `~lsst.pex.config.Config` object and
should not be called directly.

Definition at line 528 of file config.py.

    def __delete__(self, instance, at=None, label='deletion'):
        """Delete an attribute from a `lsst.pex.config.Config` instance.

        Parameters
        ----------
        instance : `lsst.pex.config.Config`
            The config instance that contains this field.
        at : `list` of `lsst.pex.config.callStack.StackFrame`
            The call stack (created by
            `lsst.pex.config.callStack.getCallStack`).
        label : `str`, optional
            Event label for the history.

        Notes
        -----
        This is invoked by the owning `~lsst.pex.config.Config` object and
        should not be called directly.
        """
        if at is None:
            at = getCallStack()
        self.__set__(instance, None, at=at, label=label)

__get__() [1/2]

def lsst.pex.config.configChoiceField.ConfigChoiceField.__get__	(		self,
			instance,
			owner = None
	)

Definition at line 428 of file configChoiceField.py.

    def __get__(self, instance, owner=None):
        if instance is None or not isinstance(instance, Config):
            return self
        else:
            return self._getOrMake(instance)

__get__() [2/2]

def lsst.pex.config.config.Field.__get__ (   self,   instance,   owner = None,   at = None,   label = "default"  )

inherited

Define how attribute access should occur on the Config instance
This is invoked by the owning config object and should not be called
directly

When the field attribute is accessed on a Config class object, it
returns the field object itself in order to allow inspection of
Config classes.

When the field attribute is access on a config instance, the actual
value described by the field (and held by the Config instance) is
returned.

Definition at line 453 of file config.py.

    def __get__(self, instance, owner=None, at=None, label="default"):
        """Define how attribute access should occur on the Config instance
        This is invoked by the owning config object and should not be called
        directly

        When the field attribute is accessed on a Config class object, it
        returns the field object itself in order to allow inspection of
        Config classes.

        When the field attribute is access on a config instance, the actual
        value described by the field (and held by the Config instance) is
        returned.
        """
        if instance is None or not isinstance(instance, Config):
            return self
        else:
            return instance._storage[self.name]

__set__()

def lsst.pex.config.configChoiceField.ConfigChoiceField.__set__	(		self,
			instance,
			value,
			at = None,
			label = "assignment"
	)

Definition at line 434 of file configChoiceField.py.

    def __set__(self, instance, value, at=None, label="assignment"):
        if instance._frozen:
            raise FieldValidationError(self, instance, "Cannot modify a frozen Config")
        if at is None:
            at = getCallStack()
        instanceDict = self._getOrMake(instance)
        if isinstance(value, self.instanceDictClass):
            for k, v in value.items():
                instanceDict.__setitem__(k, v, at=at, label=label)
            instanceDict._setSelection(value._selection, at=at, label=label)

        else:
            instanceDict._setSelection(value, at=at, label=label)

freeze()

def lsst.pex.config.configChoiceField.ConfigChoiceField.freeze	(		self,
			instance
	)

Definition at line 481 of file configChoiceField.py.

    def freeze(self, instance):
        instanceDict = self.__get__(instance)
        for v in instanceDict.values():
            v.freeze()

rename()

def lsst.pex.config.configChoiceField.ConfigChoiceField.rename	(		self,
			instance
	)

Definition at line 448 of file configChoiceField.py.

    def rename(self, instance):
        instanceDict = self.__get__(instance)
        fullname = _joinNamePath(instance._name, self.name)
        instanceDict._rename(fullname)

save()

def lsst.pex.config.configChoiceField.ConfigChoiceField.save	(		self,
			outfile,
			instance
	)

Definition at line 486 of file configChoiceField.py.

    def save(self, outfile, instance):
        instanceDict = self.__get__(instance)
        fullname = _joinNamePath(instance._name, self.name)
        for v in instanceDict.values():
            v._save(outfile)
        if self.multi:
            outfile.write(u"{}.names={!r}\n".format(fullname, instanceDict.names))
        else:
            outfile.write(u"{}.name={!r}\n".format(fullname, instanceDict.name))

toDict()

def lsst.pex.config.configChoiceField.ConfigChoiceField.toDict	(		self,
			instance
	)

Definition at line 465 of file configChoiceField.py.

    def toDict(self, instance):
        instanceDict = self.__get__(instance)

        dict_ = {}
        if self.multi:
            dict_["names"] = instanceDict.names
        else:
            dict_["name"] = instanceDict.name

        values = {}
        for k, v in instanceDict.items():
            values[k] = v.toDict()
        dict_["values"] = values

        return dict_

validate()

def lsst.pex.config.configChoiceField.ConfigChoiceField.validate	(		self,
			instance
	)

Definition at line 453 of file configChoiceField.py.

    def validate(self, instance):
        instanceDict = self.__get__(instance)
        if instanceDict.active is None and not self.optional:
            msg = "Required field cannot be None"
            raise FieldValidationError(self, instance, msg)
        elif instanceDict.active is not None:
            if self.multi:
                for a in instanceDict.active:
                    a.validate()
            else:
                instanceDict.active.validate()

Member Data Documentation

check

lsst.pex.config.config.Field.check

inherited

Definition at line 284 of file config.py.

default

lsst.pex.config.config.Field.default

inherited

Definition at line 280 of file config.py.

doc

lsst.pex.config.config.Field.doc

inherited

Definition at line 271 of file config.py.

dtype

lsst.pex.config.config.Field.dtype

inherited

Definition at line 267 of file config.py.

instanceDictClass

lsst.pex.config.configChoiceField.ConfigChoiceField.instanceDictClass = ConfigInstanceDict

static

Definition at line 407 of file configChoiceField.py.

multi

lsst.pex.config.configChoiceField.ConfigChoiceField.multi

Definition at line 414 of file configChoiceField.py.

optional

lsst.pex.config.config.Field.optional

inherited

Definition at line 288 of file config.py.

source

lsst.pex.config.config.Field.source

inherited

Definition at line 295 of file config.py.

supportedTypes

lsst.pex.config.config.Field.supportedTypes = set((str, bool, float, int, complex))

staticinherited

Definition at line 253 of file config.py.

typemap

lsst.pex.config.configChoiceField.ConfigChoiceField.typemap

Definition at line 413 of file configChoiceField.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/pex_config/16.0-13-g118c103+3/python/lsst/pex/config/configChoiceField.py