lsst.pex.config.configDictField.ConfigDictField Class Reference

Inheritance diagram for lsst.pex.config.configDictField.ConfigDictField:

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

Public Attributes
	keytype
	itemtype
	dictCheck
	itemCheck
	dtype
	doc
	default
	check
	optional
	source

Static Public Attributes
	DictClass = ConfigDict
	supportedTypes = set((str, bool, float, int, complex))

Detailed Description

A configuration field (`~lsst.pex.config.Field` subclass) that is a
mapping of keys to `~lsst.pex.config.Config` instances.

``ConfigDictField`` behaves like `DictField` except that the
``itemtype`` must be a `~lsst.pex.config.Config` subclass.

Parameters
----------
doc : `str`
    A description of the configuration field.
keytype : {`int`, `float`, `complex`, `bool`, `str`}
    The type of the mapping keys. All keys must have this type.
itemtype : `lsst.pex.config.Config`-type
    The type of the values in the mapping. This must be
    `~lsst.pex.config.Config` or a subclass.
default : optional
    Unknown.
default : ``itemtype``-dtype, optional
    Default value of this field.
optional : `bool`, optional
    If `True`, this configuration `~lsst.pex.config.Field` is *optional*.
    Default is `True`.

Raises
------
ValueError
    Raised if the inputs are invalid:

    - ``keytype`` or ``itemtype`` arguments are not supported types
      (members of `ConfigDictField.supportedTypes`.
    - ``dictCheck`` or ``itemCheck`` is not a callable function.

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

Notes
-----
You can use ``ConfigDictField`` to create name-to-config mappings. One use
case is for configuring mappings for dataset types in a Butler. In this
case, the dataset type names are arbitrary and user-selected while the
mapping configurations are known and fixed.

Definition at line 87 of file configDictField.py.

Constructor & Destructor Documentation

__init__()

def lsst.pex.config.configDictField.ConfigDictField.__init__	(		self,
			doc,
			keytype,
			itemtype,
			default = None,
			optional = False,
			dictCheck = None,
			itemCheck = None
	)

Definition at line 142 of file configDictField.py.

    def __init__(self, doc, keytype, itemtype, default=None, optional=False, dictCheck=None, itemCheck=None):
        source = getStackFrame()
        self._setup(doc=doc, dtype=ConfigDict, default=default, check=None,
                    optional=optional, source=source)
        if keytype not in self.supportedTypes:
            raise ValueError("'keytype' %s is not a supported type" %
                             _typeStr(keytype))
        elif not issubclass(itemtype, Config):
            raise ValueError("'itemtype' %s is not a supported type" %
                             _typeStr(itemtype))
        if dictCheck is not None and not hasattr(dictCheck, "__call__"):
            raise ValueError("'dictCheck' must be callable")
        if itemCheck is not None and not hasattr(itemCheck, "__call__"):
            raise ValueError("'itemCheck' must be callable")

        self.keytype = keytype
        self.itemtype = itemtype
        self.dictCheck = dictCheck
        self.itemCheck = itemCheck

Member Function Documentation

__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 551 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__()

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 476 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.dictField.DictField.__set__ (   self,   instance,   value,   at = None,   label = "assignment"  )

inherited

Definition at line 249 of file dictField.py.

    def __set__(self, instance, value, at=None, label="assignment"):
        if instance._frozen:
            msg = "Cannot modify a frozen Config. "\
                  "Attempting to set field to value %s" % value
            raise FieldValidationError(self, instance, msg)

        if at is None:
            at = getCallStack()
        if value is not None:
            value = self.DictClass(instance, self, value, at=at, label=label)
        else:
            history = instance._history.setdefault(self.name, [])
            history.append((value, at, label))

        instance._storage[self.name] = value

freeze()

def lsst.pex.config.configDictField.ConfigDictField.freeze	(		self,
			instance
	)

Definition at line 203 of file configDictField.py.

    def freeze(self, instance):
        configDict = self.__get__(instance)
        if configDict is not None:
            for k in configDict:
                configDict[k].freeze()

rename()

def lsst.pex.config.configDictField.ConfigDictField.rename	(		self,
			instance
	)

Definition at line 162 of file configDictField.py.

    def rename(self, instance):
        configDict = self.__get__(instance)
        if configDict is not None:
            for k in configDict:
                fullname = _joinNamePath(instance._name, self.name, k)
                configDict[k]._rename(fullname)

save()

def lsst.pex.config.configDictField.ConfigDictField.save	(		self,
			outfile,
			instance
	)

Definition at line 191 of file configDictField.py.

    def save(self, outfile, instance):
        configDict = self.__get__(instance)
        fullname = _joinNamePath(instance._name, self.name)
        if configDict is None:
            outfile.write(u"{}={!r}\n".format(fullname, configDict))
            return

        outfile.write(u"{}={!r}\n".format(fullname, {}))
        for v in configDict.values():
            outfile.write(u"{}={}()\n".format(v._name, _typeStr(v)))
            v._save(outfile)

toDict()

def lsst.pex.config.configDictField.ConfigDictField.toDict	(		self,
			instance
	)

Definition at line 180 of file configDictField.py.

    def toDict(self, instance):
        configDict = self.__get__(instance)
        if configDict is None:
            return None

        dict_ = {}
        for k in configDict:
            dict_[k] = configDict[k].toDict()

        return dict_

validate()

def lsst.pex.config.configDictField.ConfigDictField.validate	(		self,
			instance
	)

Definition at line 169 of file configDictField.py.

    def validate(self, instance):
        value = self.__get__(instance)
        if value is not None:
            for k in value:
                item = value[k]
                item.validate()
                if self.itemCheck is not None and not self.itemCheck(item):
                    msg = "Item at key %r is not a valid value: %s" % (k, item)
                    raise FieldValidationError(self, instance, msg)
        DictField.validate(self, instance)

Member Data Documentation

check

lsst.pex.config.config.Field.check

inherited

Definition at line 293 of file config.py.

default

lsst.pex.config.config.Field.default

inherited

Definition at line 289 of file config.py.

dictCheck

lsst.pex.config.configDictField.ConfigDictField.dictCheck

Definition at line 159 of file configDictField.py.

DictClass

lsst.pex.config.configDictField.ConfigDictField.DictClass = ConfigDict

static

Definition at line 140 of file configDictField.py.

doc

lsst.pex.config.config.Field.doc

inherited

Definition at line 280 of file config.py.

dtype

lsst.pex.config.config.Field.dtype

inherited

Definition at line 276 of file config.py.

itemCheck

lsst.pex.config.configDictField.ConfigDictField.itemCheck

Definition at line 160 of file configDictField.py.

itemtype

lsst.pex.config.configDictField.ConfigDictField.itemtype

Definition at line 158 of file configDictField.py.

keytype

lsst.pex.config.configDictField.ConfigDictField.keytype

Definition at line 157 of file configDictField.py.

optional

lsst.pex.config.config.Field.optional

inherited

Definition at line 297 of file config.py.

source

lsst.pex.config.config.Field.source

inherited

Definition at line 304 of file config.py.

supportedTypes

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

staticinherited

Definition at line 262 of file config.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/pex_config/17.0.1-2-g54f2ebc+9/python/lsst/pex/config/configDictField.py