lsst.pex.config.config Namespace Reference

Classes
class	_PexConfigGenericAlias
class	Config
class	ConfigMeta
class	Field
class	FieldValidationError
class	RecordingImporter
class	UnexpectedProxyUsageError

Functions
def	unreduceConfig (cls, stream)

Variables
	GenericAlias = type(Mapping[int, int])
	yaml = None
tuple	YamlLoaders = ()
	doImport = None
dictionary	genericAliasKwds = {"_root": True}
	FieldTypeVar = TypeVar("FieldTypeVar")
	Loader

Function Documentation

unreduceConfig()

def lsst.pex.config.config.unreduceConfig	(		cls,
			stream
	)

Create a `~lsst.pex.config.Config` from a stream.

Parameters
----------
cls : `lsst.pex.config.Config`-type
    A `lsst.pex.config.Config` type (not an instance) that is instantiated
    with configurations in the ``stream``.
stream : file-like object, `str`, or compiled string
    Stream containing configuration override code.

Returns
-------
config : `lsst.pex.config.Config`
    Config instance.

See also
--------
lsst.pex.config.Config.loadFromStream

Definition at line 1717 of file config.py.

def unreduceConfig(cls, stream):
    """Create a `~lsst.pex.config.Config` from a stream.
 
    Parameters
    ----------
    cls : `lsst.pex.config.Config`-type
        A `lsst.pex.config.Config` type (not an instance) that is instantiated
        with configurations in the ``stream``.
    stream : file-like object, `str`, or compiled string
        Stream containing configuration override code.
 
    Returns
    -------
    config : `lsst.pex.config.Config`
        Config instance.
 
    See also
    --------
    lsst.pex.config.Config.loadFromStream
    """
    config = cls()
    config.loadFromStream(stream)
    return config

Variable Documentation

doImport

lsst.pex.config.config.doImport = None

Definition at line 78 of file config.py.

FieldTypeVar

lsst.pex.config.config.FieldTypeVar = TypeVar("FieldTypeVar")

Definition at line 107 of file config.py.

GenericAlias

lsst.pex.config.config.GenericAlias = type(Mapping[int, int])

Definition at line 54 of file config.py.

genericAliasKwds

dictionary lsst.pex.config.config.genericAliasKwds = {"_root": True}

Definition at line 82 of file config.py.

Loader

lsst.pex.config.config.Loader

Definition at line 206 of file config.py.

yaml

lsst.pex.config.config.yaml = None

Definition at line 61 of file config.py.

YamlLoaders

tuple lsst.pex.config.config.YamlLoaders = ()

Definition at line 77 of file config.py.