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

Public Member Functions
	__init__ (self, config, field)

	types (self)

	__contains__ (self, k)

	__len__ (self)

	__iter__ (self)

	__getitem__ (self, k, at=None, label="default")

	__setitem__ (self, k, value, at=None, label="assignment")

	__setattr__ (self, attr, value, at=None, label="assignment")

	freeze (self)

	__reduce__ (self)

	keys (self)

	values (self)

	items (self)

	__new__ (cls, args, *kw)

	setDefaults (self)

	update (self, **kw)

	load (self, filename, root="config")

	loadFromStream (self, stream, root="config", filename=None, extraLocals=None)

	loadFromString (self, code, root="config", filename=None, extraLocals=None)

	save (self, filename, root="config")

	saveToString (self, skipImports=False)

	saveToStream (self, outfile, root="config", skipImports=False)

	toDict (self)

	validate (self)

	formatHistory (self, name, **kwargs)

	__delattr__ (self, attr, at=None, label="deletion")

	__eq__ (self, other)

	__ne__ (self, other)

	__str__ (self)

	__repr__ (self)

	compare (self, other, shortcut=True, rtol=1e-8, atol=1e-8, output=None)

	__init_subclass__ (cls, **kwargs)

Public Attributes
	types

Protected Member Functions
	_setSelection (self, value, at=None, label="assignment")

	_getNames (self)

	_setNames (self, value)

	_delNames (self)

	_getName (self)

	_setName (self, value)

	_delName (self)

	_getActive (self)

	_rename (self, fullname)

	_save (self, outfile)

	_collectImports (self)

	_fromPython (cls, config_py)

Protected Attributes
dict	_dict = {}

	_selection = None

	_config = config

	_field = field

	_typemap = None

bool	_frozen = True

	_name = name

dict	_fields = {}

	_source = getStackFrame()

Static Protected Attributes
dict	_storage [str, Any]

dict	_history [str, list[Any]]

set	_imports [Any]

Properties
	names = property(_getNames, _setNames, _delNames)

	name = property(_getName, _setName, _delName)

	active = property(_getActive)

	history = property(lambda x: x._history)

Detailed Description

Dictionary of instantiated configs, used to populate a
`~lsst.pex.config.ConfigChoiceField`.

Parameters
----------
config : `lsst.pex.config.Config`
    A configuration instance.
field : `lsst.pex.config.Field`-type
    A configuration field. Note that the `lsst.pex.config.Field.fieldmap`
    attribute must provide key-based access to configuration classes,
    (that is, ``typemap[name]``).

Definition at line 166 of file configChoiceField.py.

Constructor & Destructor Documentation

◆ init()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__init__	(	self,
		config,
		field )

Definition at line 180 of file configChoiceField.py.

    def __init__(self, config, field):
        collections.abc.Mapping.__init__(self)
        self._dict = {}
        self._selection = None
        self._config = config
        self._field = field
        self._history = config._history.setdefault(field.name, [])
        self.__doc__ = field.doc
        self._typemap = None
 

Member Function Documentation

◆ contains()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__contains__	(		self,
			k )

Definition at line 194 of file configChoiceField.py.

    def __contains__(self, k):
        return k in self.types
 

◆ delattr()

lsst.pex.config.config.Config.__delattr__	(	self,
		attr,
		at = None,
		label = "deletion" )

inherited

Definition at line 1585 of file config.py.

    def __delattr__(self, attr, at=None, label="deletion"):
        if attr in self._fields:
            if at is None:
                at = getCallStack()
            self._fields[attr].__delete__(self, at=at, label=label)
        else:
            object.__delattr__(self, attr)
 

◆ eq()

lsst.pex.config.config.Config.__eq__	(		self,
			other )

inherited

Definition at line 1593 of file config.py.

    def __eq__(self, other):
        if type(other) is type(self):
            for name in self._fields:
                thisValue = getattr(self, name)
                otherValue = getattr(other, name)
                if isinstance(thisValue, float) and math.isnan(thisValue):
                    if not math.isnan(otherValue):
                        return False
                elif thisValue != otherValue:
                    return False
            return True
        return False
 

◆ getitem()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__getitem__	(	self,
		k,
		at = None,
		label = "default" )

Definition at line 290 of file configChoiceField.py.

    def __getitem__(self, k, at=None, label="default"):
        try:
            value = self._dict[k]
        except KeyError:
            try:
                dtype = self.types[k]
            except Exception as e:
                raise FieldValidationError(
                    self._field, self._config, f"Unknown key {k!r} in Registry/ConfigChoiceField"
                ) from e
            name = _joinNamePath(self._config._name, self._field.name, k)
            if at is None:
                at = getCallStack()
                at.insert(0, dtype._source)
            value = self._dict.setdefault(k, dtype(__name=name, __at=at, __label=label))
        return value
 

◆ __init_subclass__()

lsst.pex.config.config.Config.__init_subclass__	(		cls,
		**	kwargs )

inherited

Run initialization for every subclass.

Specifically registers the subclass with a YAML representer
and YAML constructor (if pyyaml is available)

Definition at line 1662 of file config.py.

    def __init_subclass__(cls, **kwargs):
        """Run initialization for every subclass.
 
        Specifically registers the subclass with a YAML representer
        and YAML constructor (if pyyaml is available)
        """
        super().__init_subclass__(**kwargs)
 
        if not yaml:
            return
 
        yaml.add_representer(cls, _yaml_config_representer)
 

◆ iter()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__iter__ ( self )

Definition at line 200 of file configChoiceField.py.

    def __iter__(self):
        return iter(self.types)
 

◆ len()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__len__ ( self )

Definition at line 197 of file configChoiceField.py.

    def __len__(self):
        return len(self.types)
 

◆ ne()

lsst.pex.config.config.Config.__ne__	(		self,
			other )

inherited

Definition at line 1606 of file config.py.

    def __ne__(self, other):
        return not self.__eq__(other)
 

◆ new()

lsst.pex.config.config.Config.__new__	(		cls,
		*	args,
		**	kw )

inherited

Allocate a new `lsst.pex.config.Config` object.

In order to ensure that all Config object are always in a proper state
when handed to users or to derived `~lsst.pex.config.Config` classes,
some attributes are handled at allocation time rather than at
initialization.

This ensures that even if a derived `~lsst.pex.config.Config` class
implements ``__init__``, its author does not need to be concerned about
when or even the base ``Config.__init__`` should be called.

Definition at line 1025 of file config.py.

    def __new__(cls, *args, **kw):
        """Allocate a new `lsst.pex.config.Config` object.
 
        In order to ensure that all Config object are always in a proper state
        when handed to users or to derived `~lsst.pex.config.Config` classes,
        some attributes are handled at allocation time rather than at
        initialization.
 
        This ensures that even if a derived `~lsst.pex.config.Config` class
        implements ``__init__``, its author does not need to be concerned about
        when or even the base ``Config.__init__`` should be called.
        """
        name = kw.pop("__name", None)
        at = kw.pop("__at", getCallStack())
        # remove __label and ignore it
        kw.pop("__label", "default")
 
        instance = object.__new__(cls)
        instance._frozen = False
        instance._name = name
        instance._storage = {}
        instance._history = {}
        instance._imports = set()
        # load up defaults
        for field in instance._fields.values():
            instance._history[field.name] = []
            field.__set__(instance, field.default, at=at + [field.source], label="default")
        # set custom default-overrides
        instance.setDefaults()
        # set constructor overrides
        instance.update(__at=at, **kw)
        return instance
 

◆ reduce()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__reduce__ ( self )

Definition at line 373 of file configChoiceField.py.

    def __reduce__(self):
        raise UnexpectedProxyUsageError(
            f"Proxy container for config field {self._field.name} cannot "
            "be pickled; it should be converted to a built-in container before "
            "being assigned to other objects or variables."
        )
 
 

◆ repr()

lsst.pex.config.config.Config.__repr__ ( self )

inherited

Definition at line 1612 of file config.py.

    def __repr__(self):
        return "{}({})".format(
            _typeStr(self),
            ", ".join(f"{k}={v!r}" for k, v in self.toDict().items() if v is not None),
        )
 

◆ setattr()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__setattr__	(	self,
		attr,
		value,
		at = None,
		label = "assignment" )

Definition at line 341 of file configChoiceField.py.

    def __setattr__(self, attr, value, at=None, label="assignment"):
        if hasattr(getattr(self.__class__, attr, None), "__set__"):
            # This allows properties to work.
            object.__setattr__(self, attr, value)
        elif attr in self.__dict__ or attr in [
            "_history",
            "_field",
            "_config",
            "_dict",
            "_selection",
            "__doc__",
            "_typemap",
        ]:
            # This allows specific private attributes to work.
            object.__setattr__(self, attr, value)
        else:
            # We throw everything else.
            msg = f"{_typeStr(self._field)} has no attribute {attr}"
            raise FieldValidationError(self._field, self._config, msg)
 

◆ setitem()

lsst.pex.config.configChoiceField.ConfigInstanceDict.__setitem__	(	self,
		k,
		value,
		at = None,
		label = "assignment" )

Definition at line 307 of file configChoiceField.py.

    def __setitem__(self, k, value, at=None, label="assignment"):
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config, "Cannot modify a frozen Config")
 
        try:
            dtype = self.types[k]
        except Exception as e:
            raise FieldValidationError(self._field, self._config, f"Unknown key {k!r}") from e
 
        if value != dtype and type(value) is not dtype:
            msg = (
                f"Value {value} at key {k} is of incorrect type {_typeStr(value)}. "
                f"Expected type {_typeStr(dtype)}"
            )
            raise FieldValidationError(self._field, self._config, msg)
 
        if at is None:
            at = getCallStack()
        name = _joinNamePath(self._config._name, self._field.name, k)
        oldValue = self._dict.get(k, None)
        if oldValue is None:
            if value == dtype:
                self._dict[k] = value(__name=name, __at=at, __label=label)
            else:
                self._dict[k] = dtype(__name=name, __at=at, __label=label, **value._storage)
        else:
            if value == dtype:
                value = value()
            oldValue.update(__at=at, __label=label, **value._storage)
 

◆ str()

lsst.pex.config.config.Config.__str__ ( self )

inherited

Definition at line 1609 of file config.py.

    def __str__(self):
        return str(self.toDict())
 

◆ _collectImports()

lsst.pex.config.config.Config._collectImports ( self )

protectedinherited

Add module containing self to the list of things to import and
then loops over all the fields in the config calling a corresponding
collect method.

The field method will call _collectImports on any
configs it may own and return the set of things to import. This
returned set will be merged with the set of imports for this config
class.

Reimplemented in lsst.pex.config.configChoiceField.ConfigChoiceField.

Definition at line 1406 of file config.py.

    def _collectImports(self):
        """Add module containing self to the list of things to import and
        then loops over all the fields in the config calling a corresponding
        collect method.
 
        The field method will call _collectImports on any
        configs it may own and return the set of things to import. This
        returned set will be merged with the set of imports for this config
        class.
        """
        self._imports.add(self.__module__)
        for field in self._fields.values():
            field._collectImports(self, self._imports)
 

◆ _delName()

lsst.pex.config.configChoiceField.ConfigInstanceDict._delName ( self )

protected

Definition at line 255 of file configChoiceField.py.

    def _delName(self):
        if self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Multi-selection field has no attribute 'name'"
            )
        self._selection = None
 

◆ _delNames()

lsst.pex.config.configChoiceField.ConfigInstanceDict._delNames ( self )

protected

Definition at line 234 of file configChoiceField.py.

    def _delNames(self):
        if not self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Single-selection field has no attribute 'names'"
            )
        self._selection = None
 

◆ _fromPython()

lsst.pex.config.config.Config._fromPython	(		cls,
			config_py )

protectedinherited

Instantiate a `Config`-subclass from serialized Python form.

Parameters
----------
config_py : `str`
    A serialized form of the Config as created by
    `Config.saveToStream`.

Returns
-------
config : `Config`
    Reconstructed `Config` instant.

Definition at line 1676 of file config.py.

    def _fromPython(cls, config_py):
        """Instantiate a `Config`-subclass from serialized Python form.
 
        Parameters
        ----------
        config_py : `str`
            A serialized form of the Config as created by
            `Config.saveToStream`.
 
        Returns
        -------
        config : `Config`
            Reconstructed `Config` instant.
        """
        cls = _classFromPython(config_py)
        return unreduceConfig(cls, config_py)
 
 

◆ _getActive()

lsst.pex.config.configChoiceField.ConfigInstanceDict._getActive ( self )

protected

Definition at line 274 of file configChoiceField.py.

    def _getActive(self):
        if self._selection is None:
            return None
 
        if self._field.multi:
            return [self[c] for c in self._selection]
        else:
            return self[self._selection]
 

◆ _getName()

lsst.pex.config.configChoiceField.ConfigInstanceDict._getName ( self )

protected

Definition at line 241 of file configChoiceField.py.

    def _getName(self):
        if self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Multi-selection field has no attribute 'name'"
            )
        return self._selection
 

◆ _getNames()

lsst.pex.config.configChoiceField.ConfigInstanceDict._getNames ( self )

protected

Definition at line 220 of file configChoiceField.py.

    def _getNames(self):
        if not self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Single-selection field has no attribute 'names'"
            )
        return self._selection
 

◆ _rename()

lsst.pex.config.configChoiceField.ConfigInstanceDict._rename	(		self,
			name )

protected

Rename this config object in its parent `~lsst.pex.config.Config`.

Parameters
----------
name : `str`
    New name for this config in its parent `~lsst.pex.config.Config`.

Notes
-----
This method uses the `~lsst.pex.config.Field.rename` method of
individual `lsst.pex.config.Field` instances.
`lsst.pex.config.Field` subclasses may need to implement a ``rename``
method for *this* method to work.

See Also
--------
lsst.pex.config.Field.rename

Reimplemented from lsst.pex.config.config.Config.

Definition at line 337 of file configChoiceField.py.

    def _rename(self, fullname):
        for k, v in self._dict.items():
            v._rename(_joinNamePath(name=fullname, index=k))
 

◆ _save()

lsst.pex.config.config.Config._save	(		self,
			outfile )

protectedinherited

Save this config to an open stream object.

Parameters
----------
outfile : file-like object
    Destination file object write the config into. Accepts strings not
    bytes.

Definition at line 1394 of file config.py.

    def _save(self, outfile):
        """Save this config to an open stream object.
 
        Parameters
        ----------
        outfile : file-like object
            Destination file object write the config into. Accepts strings not
            bytes.
        """
        for field in self._fields.values():
            field.save(outfile, self)
 

◆ _setName()

lsst.pex.config.configChoiceField.ConfigInstanceDict._setName	(		self,
			value )

protected

Definition at line 248 of file configChoiceField.py.

    def _setName(self, value):
        if self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Multi-selection field has no attribute 'name'"
            )
        self._setSelection(value)
 

◆ _setNames()

lsst.pex.config.configChoiceField.ConfigInstanceDict._setNames	(		self,
			value )

protected

Definition at line 227 of file configChoiceField.py.

    def _setNames(self, value):
        if not self._field.multi:
            raise FieldValidationError(
                self._field, self._config, "Single-selection field has no attribute 'names'"
            )
        self._setSelection(value)
 

◆ _setSelection()

lsst.pex.config.configChoiceField.ConfigInstanceDict._setSelection	(	self,
		value,
		at = None,
		label = "assignment" )

protected

Definition at line 203 of file configChoiceField.py.

    def _setSelection(self, value, at=None, label="assignment"):
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config, "Cannot modify a frozen Config")
 
        if at is None:
            at = getCallStack(1)
 
        if value is None:
            self._selection = None
        elif self._field.multi:
            self._selection = SelectionSet(self, value, setHistory=False)
        else:
            if value not in self._dict:
                self.__getitem__(value, at=at)  # just invoke __getitem__ to make sure it's present
            self._selection = value
        self._history.append((value, at, label))
 

◆ compare()

lsst.pex.config.config.Config.compare	(	self,
		other,
		shortcut = True,
		rtol = 1e-8,
		atol = 1e-8,
		output = None )

inherited

Compare this configuration to another `~lsst.pex.config.Config` for
equality.

Parameters
----------
other : `lsst.pex.config.Config`
    Other `~lsst.pex.config.Config` object to compare against this
    config.
shortcut : `bool`, optional
    If `True`, return as soon as an inequality is found. Default is
    `True`.
rtol : `float`, optional
    Relative tolerance for floating point comparisons.
atol : `float`, optional
    Absolute tolerance for floating point comparisons.
output : callable, optional
    A callable that takes a string, used (possibly repeatedly) to
    report inequalities.

Returns
-------
isEqual : `bool`
    `True` when the two `lsst.pex.config.Config` instances are equal.
    `False` if there is an inequality.

See Also
--------
lsst.pex.config.compareConfigs

Notes
-----
Unselected targets of `~lsst.pex.config.RegistryField` fields and
unselected choices of `~lsst.pex.config.ConfigChoiceField` fields
are not considered by this method.

Floating point comparisons are performed by `numpy.allclose`.

Definition at line 1618 of file config.py.

    def compare(self, other, shortcut=True, rtol=1e-8, atol=1e-8, output=None):
        """Compare this configuration to another `~lsst.pex.config.Config` for
        equality.
 
        Parameters
        ----------
        other : `lsst.pex.config.Config`
            Other `~lsst.pex.config.Config` object to compare against this
            config.
        shortcut : `bool`, optional
            If `True`, return as soon as an inequality is found. Default is
            `True`.
        rtol : `float`, optional
            Relative tolerance for floating point comparisons.
        atol : `float`, optional
            Absolute tolerance for floating point comparisons.
        output : callable, optional
            A callable that takes a string, used (possibly repeatedly) to
            report inequalities.
 
        Returns
        -------
        isEqual : `bool`
            `True` when the two `lsst.pex.config.Config` instances are equal.
            `False` if there is an inequality.
 
        See Also
        --------
        lsst.pex.config.compareConfigs
 
        Notes
        -----
        Unselected targets of `~lsst.pex.config.RegistryField` fields and
        unselected choices of `~lsst.pex.config.ConfigChoiceField` fields
        are not considered by this method.
 
        Floating point comparisons are performed by `numpy.allclose`.
        """
        name1 = self._name if self._name is not None else "config"
        name2 = other._name if other._name is not None else "config"
        name = getComparisonName(name1, name2)
        return compareConfigs(name, self, other, shortcut=shortcut, rtol=rtol, atol=atol, output=output)
 

◆ formatHistory()

lsst.pex.config.config.Config.formatHistory	(		self,
			name,
		**	kwargs )

inherited

Format a configuration field's history to a human-readable format.

Parameters
----------
name : `str`
    Name of a `~lsst.pex.config.Field` in this config.
**kwargs
    Keyword arguments passed to `lsst.pex.config.history.format`.

Returns
-------
history : `str`
    A string containing the formatted history.

See Also
--------
lsst.pex.config.history.format

Definition at line 1523 of file config.py.

    def formatHistory(self, name, **kwargs):
        """Format a configuration field's history to a human-readable format.
 
        Parameters
        ----------
        name : `str`
            Name of a `~lsst.pex.config.Field` in this config.
        **kwargs
            Keyword arguments passed to `lsst.pex.config.history.format`.
 
        Returns
        -------
        history : `str`
            A string containing the formatted history.
 
        See Also
        --------
        lsst.pex.config.history.format
        """
        import lsst.pex.config.history as pexHist
 
        return pexHist.format(self, name, **kwargs)
 

◆ freeze()

lsst.pex.config.configChoiceField.ConfigInstanceDict.freeze ( self )

Freeze the config.

Invoking this freeze method will create a local copy of the field
attribute's typemap. This decouples this instance dict from the
underlying objects type map ensuring that and subsequent changes to the
typemap will not be reflected in this instance (i.e imports adding
additional registry entries).

Reimplemented from lsst.pex.config.config.Config.

Reimplemented in lsst.pex.config.configChoiceField.ConfigChoiceField.

Definition at line 361 of file configChoiceField.py.

    def freeze(self):
        """Freeze the config.
 
        Invoking this freeze method will create a local copy of the field
        attribute's typemap. This decouples this instance dict from the
        underlying objects type map ensuring that and subsequent changes to the
        typemap will not be reflected in this instance (i.e imports adding
        additional registry entries).
        """
        if self._typemap is None:
            self._typemap = copy.deepcopy(self.types)
 

◆ items()

lsst.pex.config.config.Config.items ( self )

inherited

Get configurations as ``(field name, field value)`` pairs.

Returns
-------
items : `~collections.abc.ItemsView`
    Iterator of tuples for each configuration. Tuple items are:

    0. Field name.
    1. Field value.

Definition at line 997 of file config.py.

    def items(self):
        """Get configurations as ``(field name, field value)`` pairs.
 
        Returns
        -------
        items : `~collections.abc.ItemsView`
            Iterator of tuples for each configuration. Tuple items are:
 
            0. Field name.
            1. Field value.
        """
        return self._storage.items()
 

◆ keys()

lsst.pex.config.config.Config.keys ( self )

inherited

Get field names.

Returns
-------
names : `~collections.abc.KeysView`
    List of `lsst.pex.config.Field` names.

Definition at line 977 of file config.py.

    def keys(self):
        """Get field names.
 
        Returns
        -------
        names : `~collections.abc.KeysView`
            List of `lsst.pex.config.Field` names.
        """
        return self._storage.keys()
 

◆ load()

lsst.pex.config.config.Config.load	(	self,
		filename,
		root = "config" )

inherited

Modify this config in place by executing the Python code in a
configuration file.

Parameters
----------
filename : `str`
    Name of the configuration file. A configuration file is Python
    module.
root : `str`, optional
    Name of the variable in file that refers to the config being
    overridden.

    For example, the value of root is ``"config"`` and the file
    contains::

        config.myField = 5

    Then this config's field ``myField`` is set to ``5``.

See Also
--------
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString

Definition at line 1142 of file config.py.

    def load(self, filename, root="config"):
        """Modify this config in place by executing the Python code in a
        configuration file.
 
        Parameters
        ----------
        filename : `str`
            Name of the configuration file. A configuration file is Python
            module.
        root : `str`, optional
            Name of the variable in file that refers to the config being
            overridden.
 
            For example, the value of root is ``"config"`` and the file
            contains::
 
                config.myField = 5
 
            Then this config's field ``myField`` is set to ``5``.
 
        See Also
        --------
        lsst.pex.config.Config.loadFromStream
        lsst.pex.config.Config.loadFromString
        lsst.pex.config.Config.save
        lsst.pex.config.Config.saveToStream
        lsst.pex.config.Config.saveToString
        """
        with open(filename) as f:
            code = compile(f.read(), filename=filename, mode="exec")
            self.loadFromString(code, root=root, filename=filename)
 

◆ loadFromStream()

lsst.pex.config.config.Config.loadFromStream	(	self,
		stream,
		root = "config",
		filename = None,
		extraLocals = None )

inherited

Modify this Config in place by executing the Python code in the
provided stream.

Parameters
----------
stream : file-like object, `str`, `bytes`, or `~types.CodeType`
    Stream containing configuration override code.  If this is a
    code object, it should be compiled with ``mode="exec"``.
root : `str`, optional
    Name of the variable in file that refers to the config being
    overridden.

    For example, the value of root is ``"config"`` and the file
    contains::

        config.myField = 5

    Then this config's field ``myField`` is set to ``5``.
filename : `str`, optional
    Name of the configuration file, or `None` if unknown or contained
    in the stream. Used for error reporting.
extraLocals : `dict` of `str` to `object`, optional
    Any extra variables to include in local scope when loading.

Notes
-----
For backwards compatibility reasons, this method accepts strings, bytes
and code objects as well as file-like objects.  New code should use
`loadFromString` instead for most of these types.

See Also
--------
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromString
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString

Definition at line 1174 of file config.py.

    def loadFromStream(self, stream, root="config", filename=None, extraLocals=None):
        """Modify this Config in place by executing the Python code in the
        provided stream.
 
        Parameters
        ----------
        stream : file-like object, `str`, `bytes`, or `~types.CodeType`
            Stream containing configuration override code.  If this is a
            code object, it should be compiled with ``mode="exec"``.
        root : `str`, optional
            Name of the variable in file that refers to the config being
            overridden.
 
            For example, the value of root is ``"config"`` and the file
            contains::
 
                config.myField = 5
 
            Then this config's field ``myField`` is set to ``5``.
        filename : `str`, optional
            Name of the configuration file, or `None` if unknown or contained
            in the stream. Used for error reporting.
        extraLocals : `dict` of `str` to `object`, optional
            Any extra variables to include in local scope when loading.
 
        Notes
        -----
        For backwards compatibility reasons, this method accepts strings, bytes
        and code objects as well as file-like objects.  New code should use
        `loadFromString` instead for most of these types.
 
        See Also
        --------
        lsst.pex.config.Config.load
        lsst.pex.config.Config.loadFromString
        lsst.pex.config.Config.save
        lsst.pex.config.Config.saveToStream
        lsst.pex.config.Config.saveToString
        """
        if hasattr(stream, "read"):
            if filename is None:
                filename = getattr(stream, "name", "?")
            code = compile(stream.read(), filename=filename, mode="exec")
        else:
            code = stream
        self.loadFromString(code, root=root, filename=filename, extraLocals=extraLocals)
 

◆ loadFromString()

lsst.pex.config.config.Config.loadFromString	(	self,
		code,
		root = "config",
		filename = None,
		extraLocals = None )

inherited

Modify this Config in place by executing the Python code in the
provided string.

Parameters
----------
code : `str`, `bytes`, or `~types.CodeType`
    Stream containing configuration override code.
root : `str`, optional
    Name of the variable in file that refers to the config being
    overridden.

    For example, the value of root is ``"config"`` and the file
    contains::

        config.myField = 5

    Then this config's field ``myField`` is set to ``5``.
filename : `str`, optional
    Name of the configuration file, or `None` if unknown or contained
    in the stream. Used for error reporting.
extraLocals : `dict` of `str` to `object`, optional
    Any extra variables to include in local scope when loading.

Raises
------
ValueError
    Raised if a key in extraLocals is the same value as the value of
    the root argument.

See Also
--------
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString

Definition at line 1221 of file config.py.

    def loadFromString(self, code, root="config", filename=None, extraLocals=None):
        """Modify this Config in place by executing the Python code in the
        provided string.
 
        Parameters
        ----------
        code : `str`, `bytes`, or `~types.CodeType`
            Stream containing configuration override code.
        root : `str`, optional
            Name of the variable in file that refers to the config being
            overridden.
 
            For example, the value of root is ``"config"`` and the file
            contains::
 
                config.myField = 5
 
            Then this config's field ``myField`` is set to ``5``.
        filename : `str`, optional
            Name of the configuration file, or `None` if unknown or contained
            in the stream. Used for error reporting.
        extraLocals : `dict` of `str` to `object`, optional
            Any extra variables to include in local scope when loading.
 
        Raises
        ------
        ValueError
            Raised if a key in extraLocals is the same value as the value of
            the root argument.
 
        See Also
        --------
        lsst.pex.config.Config.load
        lsst.pex.config.Config.loadFromStream
        lsst.pex.config.Config.save
        lsst.pex.config.Config.saveToStream
        lsst.pex.config.Config.saveToString
        """
        if filename is None:
            # try to determine the file name; a compiled string
            # has attribute "co_filename",
            filename = getattr(code, "co_filename", "?")
        with RecordingImporter() as importer:
            globals = {"__file__": filename}
            local = {root: self}
            if extraLocals is not None:
                # verify the value of root was not passed as extra local args
                if root in extraLocals:
                    raise ValueError(
                        f"{root} is reserved and cannot be used as a variable name in extraLocals"
                    )
                local.update(extraLocals)
            exec(code, globals, local)
 
        self._imports.update(importer.getModules())
 

◆ save()

lsst.pex.config.config.Config.save	(	self,
		filename,
		root = "config" )

inherited

Save a Python script to the named file, which, when loaded,
reproduces this config.

Parameters
----------
filename : `str`
    Desination filename of this configuration.
root : `str`, optional
    Name to use for the root config variable. The same value must be
    used when loading (see `lsst.pex.config.Config.load`).

See Also
--------
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.saveToString
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString

Reimplemented in lsst.pex.config.configChoiceField.ConfigChoiceField.

Definition at line 1277 of file config.py.

    def save(self, filename, root="config"):
        """Save a Python script to the named file, which, when loaded,
        reproduces this config.
 
        Parameters
        ----------
        filename : `str`
            Desination filename of this configuration.
        root : `str`, optional
            Name to use for the root config variable. The same value must be
            used when loading (see `lsst.pex.config.Config.load`).
 
        See Also
        --------
        lsst.pex.config.Config.saveToStream
        lsst.pex.config.Config.saveToString
        lsst.pex.config.Config.load
        lsst.pex.config.Config.loadFromStream
        lsst.pex.config.Config.loadFromString
        """
        d = os.path.dirname(filename)
        with tempfile.NamedTemporaryFile(mode="w", delete=False, dir=d) as outfile:
            self.saveToStream(outfile, root)
            # tempfile is hardcoded to create files with mode '0600'
            # for an explantion of these antics see:
            # https://stackoverflow.com/questions/10291131/how-to-use-os-umask-in-python
            umask = os.umask(0o077)
            os.umask(umask)
            os.chmod(outfile.name, (~umask & 0o666))
            # chmod before the move so we get quasi-atomic behavior if the
            # source and dest. are on the same filesystem.
            # os.rename may not work across filesystems
            shutil.move(outfile.name, filename)
 

◆ saveToStream()

lsst.pex.config.config.Config.saveToStream	(	self,
		outfile,
		root = "config",
		skipImports = False )

inherited

Save a configuration file to a stream, which, when loaded,
reproduces this config.

Parameters
----------
outfile : file-like object
    Destination file object write the config into. Accepts strings not
    bytes.
root : `str`, optional
    Name to use for the root config variable. The same value must be
    used when loading (see `lsst.pex.config.Config.load`).
skipImports : `bool`, optional
    If `True` then do not include ``import`` statements in output,
    this is to support human-oriented output from ``pipetask`` where
    additional clutter is not useful.

See Also
--------
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToString
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString

Definition at line 1339 of file config.py.

    def saveToStream(self, outfile, root="config", skipImports=False):
        """Save a configuration file to a stream, which, when loaded,
        reproduces this config.
 
        Parameters
        ----------
        outfile : file-like object
            Destination file object write the config into. Accepts strings not
            bytes.
        root : `str`, optional
            Name to use for the root config variable. The same value must be
            used when loading (see `lsst.pex.config.Config.load`).
        skipImports : `bool`, optional
            If `True` then do not include ``import`` statements in output,
            this is to support human-oriented output from ``pipetask`` where
            additional clutter is not useful.
 
        See Also
        --------
        lsst.pex.config.Config.save
        lsst.pex.config.Config.saveToString
        lsst.pex.config.Config.load
        lsst.pex.config.Config.loadFromStream
        lsst.pex.config.Config.loadFromString
        """
        tmp = self._name
        self._rename(root)
        try:
            if not skipImports:
                self._collectImports()
                # Remove self from the set, as it is handled explicitly below
                self._imports.remove(self.__module__)
                configType = type(self)
                typeString = _typeStr(configType)
                outfile.write(f"import {configType.__module__}\n")
                # We are required to write this on a single line because
                # of later regex matching, rather than adopting black style
                # formatting.
                outfile.write(
                    f'assert type({root}) is {typeString}, f"config is of type '
                    f'{{type({root}).__module__}}.{{type({root}).__name__}} instead of {typeString}"\n\n'
                )
                for imp in sorted(self._imports):
                    if imp in sys.modules and sys.modules[imp] is not None:
                        outfile.write(f"import {imp}\n")
            self._save(outfile)
        finally:
            self._rename(tmp)
 

◆ saveToString()

lsst.pex.config.config.Config.saveToString	(		self,
			skipImports = False )

inherited

Return the Python script form of this configuration as an executable
string.

Parameters
----------
skipImports : `bool`, optional
    If `True` then do not include ``import`` statements in output,
    this is to support human-oriented output from ``pipetask`` where
    additional clutter is not useful.

Returns
-------
code : `str`
    A code string readable by `loadFromString`.

See Also
--------
lsst.pex.config.Config.save
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.loadFromString

Definition at line 1311 of file config.py.

    def saveToString(self, skipImports=False):
        """Return the Python script form of this configuration as an executable
        string.
 
        Parameters
        ----------
        skipImports : `bool`, optional
            If `True` then do not include ``import`` statements in output,
            this is to support human-oriented output from ``pipetask`` where
            additional clutter is not useful.
 
        Returns
        -------
        code : `str`
            A code string readable by `loadFromString`.
 
        See Also
        --------
        lsst.pex.config.Config.save
        lsst.pex.config.Config.saveToStream
        lsst.pex.config.Config.load
        lsst.pex.config.Config.loadFromStream
        lsst.pex.config.Config.loadFromString
        """
        buffer = io.StringIO()
        self.saveToStream(buffer, skipImports=skipImports)
        return buffer.getvalue()
 

◆ setDefaults()

lsst.pex.config.config.Config.setDefaults ( self )

inherited

Subclass hook for computing defaults.

Notes
-----
Derived `~lsst.pex.config.Config` classes that must compute defaults
rather than using the `~lsst.pex.config.Field` instances's defaults
should do so here. To correctly use inherited defaults,
implementations of ``setDefaults`` must call their base class's
``setDefaults``.

Reimplemented in lsst.pipe.tasks.background.MaskObjectsConfig, lsst.pipe.tasks.dataFrameActions._actions.NanoJansky, lsst.ip.diffim.dipoleMeasurement.DipoleMeasurementConfig, lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig, lsst.ip.isr.ampOffset.AmpOffsetConfig, lsst.meas.algorithms.computeExPsf.ComputeExPsfConfig, lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig, lsst.meas.algorithms.noise_covariance.ComputeNoiseCorrelationConfig, lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxConfig, lsst.meas.algorithms.scaleVariance.ScaleVarianceConfig, lsst.meas.base.forcedMeasurement.ForcedMeasurementConfig, lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedConfig, lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFrameConfig, lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedConfig, and lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxSingleFrameConfig.

Definition at line 1071 of file config.py.

    def setDefaults(self):
        """Subclass hook for computing defaults.
 
        Notes
        -----
        Derived `~lsst.pex.config.Config` classes that must compute defaults
        rather than using the `~lsst.pex.config.Field` instances's defaults
        should do so here. To correctly use inherited defaults,
        implementations of ``setDefaults`` must call their base class's
        ``setDefaults``.
        """
        pass
 

◆ toDict()

lsst.pex.config.config.Config.toDict ( self )

inherited

Make a dictionary of field names and their values.

Returns
-------
dict_ : `dict`
    Dictionary with keys that are `~lsst.pex.config.Field` names.
    Values are `~lsst.pex.config.Field` values.

See Also
--------
lsst.pex.config.Field.toDict

Notes
-----
This method uses the `~lsst.pex.config.Field.toDict` method of
individual fields. Subclasses of `~lsst.pex.config.Field` may need to
implement a ``toDict`` method for *this* method to work.

Reimplemented in lsst.pex.config.configChoiceField.ConfigChoiceField.

Definition at line 1420 of file config.py.

    def toDict(self):
        """Make a dictionary of field names and their values.
 
        Returns
        -------
        dict_ : `dict`
            Dictionary with keys that are `~lsst.pex.config.Field` names.
            Values are `~lsst.pex.config.Field` values.
 
        See Also
        --------
        lsst.pex.config.Field.toDict
 
        Notes
        -----
        This method uses the `~lsst.pex.config.Field.toDict` method of
        individual fields. Subclasses of `~lsst.pex.config.Field` may need to
        implement a ``toDict`` method for *this* method to work.
        """
        dict_ = {}
        for name, field in self._fields.items():
            dict_[name] = field.toDict(self)
        return dict_
 

◆ types()

lsst.pex.config.configChoiceField.ConfigInstanceDict.types ( self )

Definition at line 191 of file configChoiceField.py.

    def types(self):
        return self._typemap if self._typemap is not None else self._field.typemap
 

◆ update()

lsst.pex.config.config.Config.update	(		self,
		**	kw )

inherited

Update values of fields specified by the keyword arguments.

Parameters
----------
**kw
    Keywords are configuration field names. Values are configuration
    field values.

Notes
-----
The ``__at`` and ``__label`` keyword arguments are special internal
keywords. They are used to strip out any internal steps from the
history tracebacks of the config. Do not modify these keywords to
subvert a `~lsst.pex.config.Config` instance's history.

Examples
--------
This is a config with three fields:

>>> from lsst.pex.config import Config, Field
>>> class DemoConfig(Config):
...     fieldA = Field(doc="Field A", dtype=int, default=42)
...     fieldB = Field(doc="Field B", dtype=bool, default=True)
...     fieldC = Field(doc="Field C", dtype=str, default="Hello world")
>>> config = DemoConfig()

These are the default values of each field:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
fieldA: 42
fieldB: True
fieldC: 'Hello world'

Using this method to update ``fieldA`` and ``fieldC``:

>>> config.update(fieldA=13, fieldC="Updated!")

Now the values of each field are:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
fieldA: 13
fieldB: True
fieldC: 'Updated!'

Definition at line 1084 of file config.py.

    def update(self, **kw):
        """Update values of fields specified by the keyword arguments.
 
        Parameters
        ----------
        **kw
            Keywords are configuration field names. Values are configuration
            field values.
 
        Notes
        -----
        The ``__at`` and ``__label`` keyword arguments are special internal
        keywords. They are used to strip out any internal steps from the
        history tracebacks of the config. Do not modify these keywords to
        subvert a `~lsst.pex.config.Config` instance's history.
 
        Examples
        --------
        This is a config with three fields:
 
        >>> from lsst.pex.config import Config, Field
        >>> class DemoConfig(Config):
        ...     fieldA = Field(doc="Field A", dtype=int, default=42)
        ...     fieldB = Field(doc="Field B", dtype=bool, default=True)
        ...     fieldC = Field(doc="Field C", dtype=str, default="Hello world")
        >>> config = DemoConfig()
 
        These are the default values of each field:
 
        >>> for name, value in config.iteritems():
        ...     print(f"{name}: {value}")
        fieldA: 42
        fieldB: True
        fieldC: 'Hello world'
 
        Using this method to update ``fieldA`` and ``fieldC``:
 
        >>> config.update(fieldA=13, fieldC="Updated!")
 
        Now the values of each field are:
 
        >>> for name, value in config.iteritems():
        ...     print(f"{name}: {value}")
        fieldA: 13
        fieldB: True
        fieldC: 'Updated!'
        """
        at = kw.pop("__at", getCallStack())
        label = kw.pop("__label", "update")
 
        for name, value in kw.items():
            try:
                field = self._fields[name]
                field.__set__(self, value, at=at, label=label)
            except KeyError as e:
                e.add_note(f"No field of name {name} exists in config type {_typeStr(self)}")
                raise
 

◆ validate()

lsst.pex.config.config.Config.validate ( self )

inherited

Validate the Config, raising an exception if invalid.

Raises
------
lsst.pex.config.FieldValidationError
    Raised if verification fails.

Notes
-----
The base class implementation performs type checks on all fields by
calling their `~lsst.pex.config.Field.validate` methods.

Complex single-field validation can be defined by deriving new Field
types. For convenience, some derived `lsst.pex.config.Field`-types
(`~lsst.pex.config.ConfigField` and
`~lsst.pex.config.ConfigChoiceField`) are defined in
``lsst.pex.config`` that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived
`~lsst.pex.config.Config` classes after calling this method, and base
validation is complete.

Reimplemented in lsst.fgcmcal.sedterms.Sedterm, lsst.pex.config.configChoiceField.ConfigChoiceField, lsst.pex.config.configurableActions.tests.ActionTest1, lsst.pex.config.configurableActions.tests.ActionTest2, lsst.pex.config.configurableActions.tests.ActionTest3, lsst.pex.config.configurableActions.tests.TestDivideAction, lsst.pipe.tasks.background.MaskObjectsConfig, lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig, lsst.afw.geom.transformConfig.RadialTransformConfig, lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory, lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig, lsst.meas.algorithms.treecorrUtils.TreecorrConfig, lsst.meas.base.baseMeasurement.BaseMeasurementConfig, and lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxConfig.

Definition at line 1497 of file config.py.

    def validate(self):
        """Validate the Config, raising an exception if invalid.
 
        Raises
        ------
        lsst.pex.config.FieldValidationError
            Raised if verification fails.
 
        Notes
        -----
        The base class implementation performs type checks on all fields by
        calling their `~lsst.pex.config.Field.validate` methods.
 
        Complex single-field validation can be defined by deriving new Field
        types. For convenience, some derived `lsst.pex.config.Field`-types
        (`~lsst.pex.config.ConfigField` and
        `~lsst.pex.config.ConfigChoiceField`) are defined in
        ``lsst.pex.config`` that handle recursing into subconfigs.
 
        Inter-field relationships should only be checked in derived
        `~lsst.pex.config.Config` classes after calling this method, and base
        validation is complete.
        """
        for field in self._fields.values():
            field.validate(self)
 

◆ values()

lsst.pex.config.config.Config.values ( self )

inherited

Get field values.

Returns
-------
values : `~collections.abc.ValuesView`
    Iterator of field values.

Definition at line 987 of file config.py.

    def values(self):
        """Get field values.
 
        Returns
        -------
        values : `~collections.abc.ValuesView`
            Iterator of field values.
        """
        return self._storage.values()
 

Member Data Documentation

◆ _config

lsst.pex.config.configChoiceField.ConfigInstanceDict._config = config

protected

Definition at line 184 of file configChoiceField.py.

◆ _dict

dict lsst.pex.config.configChoiceField.ConfigInstanceDict._dict = {}

protected

Definition at line 182 of file configChoiceField.py.

◆ _field

lsst.pex.config.configChoiceField.ConfigInstanceDict._field = field

protected

Definition at line 185 of file configChoiceField.py.

◆ _fields

dict lsst.pex.config.config.ConfigMeta._fields = {}

protectedinherited

Definition at line 228 of file config.py.

◆ _frozen

bool lsst.pex.config.config.Config._frozen = True

protectedinherited

Definition at line 1390 of file config.py.

◆ _history

dict lsst.pex.config.config.Config._history [str, list[Any]]

staticprotectedinherited

Definition at line 970 of file config.py.

◆ _imports

lsst.pex.config.config.Config._imports [Any]

staticprotectedinherited

Definition at line 971 of file config.py.

◆ _name

lsst.pex.config.config.Config._name = name

protectedinherited

Definition at line 1493 of file config.py.

◆ _selection

lsst.pex.config.configChoiceField.ConfigInstanceDict._selection = None

protected

Definition at line 183 of file configChoiceField.py.

◆ _source

lsst.pex.config.config.ConfigMeta._source = getStackFrame()

protectedinherited

Definition at line 229 of file config.py.

◆ _storage

dict lsst.pex.config.config.Config._storage [str, Any]

staticprotectedinherited

Definition at line 968 of file config.py.

◆ _typemap

lsst.pex.config.configChoiceField.ConfigInstanceDict._typemap = None

protected

Definition at line 188 of file configChoiceField.py.

◆ types

lsst.pex.config.configChoiceField.ConfigInstanceDict.types

Definition at line 198 of file configChoiceField.py.

Property Documentation

◆ active

lsst.pex.config.configChoiceField.ConfigInstanceDict.active = property(_getActive)

static

Definition at line 283 of file configChoiceField.py.

◆ history

lsst.pex.config.config.Config.history = property(lambda x: x._history)

staticinherited

Definition at line 1546 of file config.py.

◆ name

lsst.pex.config.configChoiceField.ConfigInstanceDict.name = property(_getName, _setName, _delName)

static

Definition at line 268 of file configChoiceField.py.

◆ names

lsst.pex.config.configChoiceField.ConfigInstanceDict.names = property(_getNames, _setNames, _delNames)

static

Definition at line 262 of file configChoiceField.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/pex_config/gabf8522325+94c30d56e9/python/lsst/pex/config/configChoiceField.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __contains__()

◆ __delattr__()

◆ __eq__()

◆ __getitem__()

◆ __init_subclass__()

◆ __iter__()

◆ __len__()

◆ __ne__()

◆ __new__()

◆ __reduce__()

◆ __repr__()

◆ __setattr__()

◆ __setitem__()

◆ __str__()

◆ _collectImports()

◆ _delName()

◆ _delNames()

◆ _fromPython()

◆ _getActive()

◆ _getName()

◆ _getNames()

◆ _rename()

◆ _save()

◆ _setName()

◆ _setNames()

◆ _setSelection()

◆ compare()

◆ formatHistory()

◆ freeze()

◆ items()

◆ keys()

◆ load()

◆ loadFromStream()

◆ loadFromString()

◆ save()

◆ saveToStream()

◆ saveToString()

◆ setDefaults()

◆ toDict()

◆ types()

◆ update()

◆ validate()

◆ values()

Member Data Documentation

◆ _config

◆ _dict

◆ _field

◆ _fields

◆ _frozen

◆ _history

◆ _imports

◆ _name

◆ _selection

◆ _source

◆ _storage

◆ _typemap

◆ types

Property Documentation

◆ active

◆ history

◆ name

◆ names

◆ init()

◆ contains()

◆ delattr()

◆ eq()

◆ getitem()

◆ iter()

◆ len()

◆ ne()

◆ new()

◆ reduce()

◆ repr()

◆ setattr()

◆ setitem()

◆ str()