Inheritance diagram for lsst.pex.config.config.Config:

Public Member Functions
	__iter__ (self)

	keys (self)

	values (self)

	items (self)

	__contains__ (self, name)

	__new__ (cls, args, *kw)

Config	copy (self)

	__reduce__ (self)

	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)

	freeze (self)

	toDict (self)

	names (self)

	validate (self)

	formatHistory (self, name, **kwargs)

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

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

Protected Member Functions
	_save (self, outfile)

	_collectImports (self)

	_rename (self, name)

	_fromPython (cls, config_py)

Protected Attributes
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
	history = property(lambda x: x._history)

Detailed Description

Base class for configuration (*config*) objects.

Notes
-----
A ``Config`` object will usually have several `~lsst.pex.config.Field`
instances as class attributes. These are used to define most of the base
class behavior.

``Config`` implements a mapping API that provides many `dict`-like methods,
such as `keys`, `values`, and `items`. ``Config`` instances also support
the ``in`` operator to test if a field is in the config. Unlike a `dict`,
``Config`` classes are not subscriptable. Instead, access individual
fields as attributes of the configuration instance.

Examples
--------
Config classes are subclasses of ``Config`` that have
`~lsst.pex.config.Field` instances (or instances of
`~lsst.pex.config.Field` subclasses) as class attributes:

>>> from lsst.pex.config import Config, Field, ListField
>>> class DemoConfig(Config):
...     intField = Field(doc="An integer field", dtype=int, default=42)
...     listField = ListField(
...         doc="List of favorite beverages.",
...         dtype=str,
...         default=["coffee", "green tea", "water"],
...     )
>>> config = DemoConfig()

Configs support many `dict`-like APIs:

>>> config.keys()
['intField', 'listField']
>>> "intField" in config
True

Individual fields can be accessed as attributes of the configuration:

>>> config.intField
42
>>> config.listField.append("earl grey tea")
>>> print(config.listField)
['coffee', 'green tea', 'water', 'earl grey tea']

Definition at line 929 of file config.py.

Member Function Documentation

◆ contains()

lsst.pex.config.config.Config.__contains__	(		self,
			name )

Return `True` if the specified field exists in this config.

Parameters
----------
name : `str`
    Field name to test for.

Returns
-------
in : `bool`
    `True` if the specified field exists in the config.

Definition at line 1018 of file config.py.

    def __contains__(self, name):
        """Return `True` if the specified field exists in this config.
 
        Parameters
        ----------
        name : `str`
            Field name to test for.
 
        Returns
        -------
        in : `bool`
            `True` if the specified field exists in the config.
        """
        return self._storage.__contains__(name)
 

◆ delattr()

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

Definition at line 1617 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 )

Definition at line 1625 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
 

◆ __init_subclass__()

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

Run initialization for every subclass.

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

Definition at line 1694 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.config.Config.__iter__ ( self )

Iterate over fields.

Definition at line 981 of file config.py.

    def __iter__(self):
        """Iterate over fields."""
        return self._fields.__iter__()
 

◆ ne()

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

Definition at line 1638 of file config.py.

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

◆ new()

lsst.pex.config.config.Config.__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.

Definition at line 1033 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.config.Config.__reduce__ ( self )

Reduction for pickling (function with arguments to reproduce).

We need to condense and reconstitute the `~lsst.pex.config.Config`,
since it may contain lambdas (as the ``check`` elements) that cannot
be pickled.

Definition at line 1090 of file config.py.

    def __reduce__(self):
        """Reduction for pickling (function with arguments to reproduce).
 
        We need to condense and reconstitute the `~lsst.pex.config.Config`,
        since it may contain lambdas (as the ``check`` elements) that cannot
        be pickled.
        """
        # The stream must be in characters to match the API but pickle
        # requires bytes
        stream = io.StringIO()
        self.saveToStream(stream)
        return (unreduceConfig, (self.__class__, stream.getvalue().encode()))
 

◆ repr()

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

Definition at line 1644 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.config.Config.__setattr__	(	self,
		attr,
		value,
		at = None,
		label = "assignment" )

Set an attribute (such as a field's value).

Notes
-----
Unlike normal Python objects, `~lsst.pex.config.Config` objects are
locked such that no additional attributes nor properties may be added
to them dynamically.

Although this is not the standard Python behavior, it helps to protect
users from accidentally mispelling a field name, or trying to set a
non-existent field.

Definition at line 1582 of file config.py.

    def __setattr__(self, attr, value, at=None, label="assignment"):
        """Set an attribute (such as a field's value).
 
        Notes
        -----
        Unlike normal Python objects, `~lsst.pex.config.Config` objects are
        locked such that no additional attributes nor properties may be added
        to them dynamically.
 
        Although this is not the standard Python behavior, it helps to protect
        users from accidentally mispelling a field name, or trying to set a
        non-existent field.
        """
        if attr in self._fields:
            if self._fields[attr].deprecated is not None:
                fullname = _joinNamePath(self._name, self._fields[attr].name)
                warnings.warn(
                    f"Config field {fullname} is deprecated: {self._fields[attr].deprecated}",
                    FutureWarning,
                    stacklevel=2,
                )
            if at is None:
                at = getCallStack()
            # This allows Field descriptors to work.
            self._fields[attr].__set__(self, value, at=at, label=label)
        elif hasattr(getattr(self.__class__, attr, None), "__set__"):
            # This allows properties and other non-Field descriptors to work.
            return object.__setattr__(self, attr, value)
        elif attr in self.__dict__ or attr in ("_name", "_history", "_storage", "_frozen", "_imports"):
            # This allows specific private attributes to work.
            self.__dict__[attr] = value
        else:
            # We throw everything else.
            raise AttributeError(f"{_typeStr(self)} has no attribute {attr}")
 

◆ str()

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

Definition at line 1641 of file config.py.

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

◆ _collectImports()

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

protected

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 1438 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)
 

◆ _fromPython()

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

protected

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 1708 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)
 
 

◆ _rename()

lsst.pex.config.config.Config._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 in lsst.pex.config.configChoiceField.ConfigInstanceDict.

Definition at line 1506 of file config.py.

    def _rename(self, name):
        """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
        """
        self._name = name
        for field in self._fields.values():
            field.rename(self)
 

◆ _save()

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

protected

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 1426 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)
 

◆ compare()

lsst.pex.config.config.Config.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`.

Definition at line 1650 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)
 

◆ copy()

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

Return a deep copy of this config.

Notes
-----
The returned config object is not frozen, even if the original was.
If a nested config object is copied, it retains the name from its
original hierarchy.

Nested objects are only shared between the new and old configs if they
are not possible to modify via the config's interfaces (e.g. entries
in the the history list are not copied, but the lists themselves are,
so modifications to one copy do not modify the other).

Reimplemented in lsst.pex.config.configurableActions._configurableAction.ConfigurableAction.

Definition at line 1066 of file config.py.

    def copy(self) -> Config:
        """Return a deep copy of this config.
 
        Notes
        -----
        The returned config object is not frozen, even if the original was.
        If a nested config object is copied, it retains the name from its
        original hierarchy.
 
        Nested objects are only shared between the new and old configs if they
        are not possible to modify via the config's interfaces (e.g. entries
        in the the history list are not copied, but the lists themselves are,
        so modifications to one copy do not modify the other).
        """
        instance = object.__new__(type(self))
        instance._frozen = False
        instance._name = self._name
        instance._history = {k: list(v) for k, v in self._history.items()}
        instance._imports = set(self._imports)
        # Important to set up storage last, since fields sometimes store
        # proxy objects that reference their parent (especially for history).
        instance._storage = {k: self._fields[k]._copy_storage(self, instance) for k in self._storage}
        return instance
 

◆ formatHistory()

lsst.pex.config.config.Config.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

Definition at line 1555 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.config.Config.freeze ( self )

Make this config, and all subconfigs, read-only.

Reimplemented in lsst.pex.config.configChoiceField.ConfigChoiceField, and lsst.pex.config.configChoiceField.ConfigInstanceDict.

Definition at line 1420 of file config.py.

    def freeze(self):
        """Make this config, and all subconfigs, read-only."""
        self._frozen = True
        for field in self._fields.values():
            field.freeze(self)
 

◆ items()

lsst.pex.config.config.Config.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.

Definition at line 1005 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 )

Get field names.

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

Definition at line 985 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" )

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 1174 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 )

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 1206 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 )

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 1253 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())
 

◆ names()

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

Get all the field names in the config, recursively.

Returns
-------
names : `list` of `str`
    Field names.

Definition at line 1476 of file config.py.

    def names(self):
        """Get all the field names in the config, recursively.
 
        Returns
        -------
        names : `list` of `str`
            Field names.
        """
        #
        # Rather than sort out the recursion all over again use the
        # pre-existing saveToStream()
        #
        with io.StringIO() as strFd:
            self.saveToStream(strFd, "config")
            contents = strFd.getvalue()
            strFd.close()
        #
        # Pull the names out of the dumped config
        #
        keys = []
        for line in contents.split("\n"):
            if re.search(r"^((assert|import)\s+|\s*$|#)", line):
                continue
 
            mat = re.search(r"^(?:config\.)?([^=]+)\s*=\s*.*", line)
            if mat:
                keys.append(mat.group(1))
 
        return keys
 

◆ save()

lsst.pex.config.config.Config.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

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

Definition at line 1309 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 )

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 1371 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 )

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 1343 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 )

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.pipe.tasks.measurementDriver.ForcedMeasurementDriverConfig, 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.base.simple_forced_measurement.SimpleForcedMeasurementConfig, 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 1103 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 )

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 1452 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_
 

◆ update()

lsst.pex.config.config.Config.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!'

Definition at line 1116 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 )

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.ip.isr.ampOffset.AmpOffsetConfig, lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory, lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig, lsst.meas.algorithms.treecorrUtils.TreecorrConfig, lsst.meas.base.baseMeasurement.BaseMeasurementConfig, lsst.meas.base.baseMeasurement.SimpleBaseMeasurementConfig, and lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxConfig.

Definition at line 1529 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 )

Get field values.

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

Definition at line 995 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

◆ _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

protected

Definition at line 1422 of file config.py.

◆ _history

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

staticprotected

Definition at line 978 of file config.py.

◆ _imports

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

staticprotected

Definition at line 979 of file config.py.

◆ _name

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

protected

Definition at line 1525 of file config.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]

staticprotected

Definition at line 976 of file config.py.

Property Documentation

◆ history

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

static

Definition at line 1578 of file config.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/pex_config/ga9e74d7ce9+43ac651df0/python/lsst/pex/config/config.py

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ __contains__()

◆ __delattr__()

◆ __eq__()

◆ __init_subclass__()

◆ __iter__()

◆ __ne__()

◆ __new__()

◆ __reduce__()

◆ __repr__()

◆ __setattr__()

◆ __str__()

◆ _collectImports()

◆ _fromPython()

◆ _rename()

◆ _save()

◆ compare()

◆ copy()

◆ formatHistory()

◆ freeze()

◆ items()

◆ keys()

◆ load()

◆ loadFromStream()

◆ loadFromString()

◆ names()

◆ save()

◆ saveToStream()

◆ saveToString()

◆ setDefaults()

◆ toDict()

◆ update()

◆ validate()

◆ values()

Member Data Documentation

◆ _fields

◆ _frozen

◆ _history

◆ _imports

◆ _name

◆ _source

◆ _storage

Property Documentation

◆ history

◆ contains()

◆ delattr()

◆ eq()

◆ iter()

◆ ne()

◆ new()

◆ reduce()

◆ repr()

◆ setattr()

◆ str()