pex.config.registry Namespace Reference

Classes
class	ConfigurableWrapper
class	Registry
class	RegistryAdaptor
class	RegistryField
class	RegistryInstanceDict

Functions
def	makeRegistry (doc, configBaseType=Config)
def	registerConfigurable (name, registry, ConfigClass=None)
def	registerConfig (name, registry, target)

Function Documentation

makeRegistry()

def pex.config.registry.makeRegistry	(		doc,
			configBaseType = Config
	)

Create a `Registry`.

Parameters
----------
doc : `str`
    Docstring for the created `Registry` (this is set as the ``__doc__``
    attribute of the `Registry` instance.
configBaseType : `lsst.pex.config.Config`-type
    Base type of config classes in the `Registry`
    (`lsst.pex.config.Registry.configBaseType`).

Returns
-------
registry : `Registry`
    Registry with ``__doc__`` and `~Registry.configBaseType` attributes
    set.

Definition at line 336 of file registry.py.

def makeRegistry(doc, configBaseType=Config):
    """Create a `Registry`.
 
    Parameters
    ----------
    doc : `str`
        Docstring for the created `Registry` (this is set as the ``__doc__``
        attribute of the `Registry` instance.
    configBaseType : `lsst.pex.config.Config`-type
        Base type of config classes in the `Registry`
        (`lsst.pex.config.Registry.configBaseType`).
 
    Returns
    -------
    registry : `Registry`
        Registry with ``__doc__`` and `~Registry.configBaseType` attributes
        set.
    """
    cls = type("Registry", (Registry,), {"__doc__": doc})
    return cls(configBaseType=configBaseType)
 
 

registerConfig()

def pex.config.registry.registerConfig	(		name,
			registry,
			target
	)

Decorator that adds a class as a ``ConfigClass`` in a `Registry` and
associates it with the given configurable.

Parameters
----------
name : `str`
    Name of the ``target`` in the ``registry``.
registry : `Registry`
    The registry containing the ``target``.
target : obj
    A configurable type, such as a subclass of `lsst.pipe.base.Task`.

See also
--------
registerConfigurable

Notes
-----
Internally, this decorator runs `Registry.register`.

Definition at line 386 of file registry.py.

def registerConfig(name, registry, target):
    """Decorator that adds a class as a ``ConfigClass`` in a `Registry` and
    associates it with the given configurable.
 
    Parameters
    ----------
    name : `str`
        Name of the ``target`` in the ``registry``.
    registry : `Registry`
        The registry containing the ``target``.
    target : obj
        A configurable type, such as a subclass of `lsst.pipe.base.Task`.
 
    See also
    --------
    registerConfigurable
 
    Notes
    -----
    Internally, this decorator runs `Registry.register`.
    """
    def decorate(cls):
        registry.register(name, target=target, ConfigClass=cls)
        return cls
    return decorate

registerConfigurable()

def pex.config.registry.registerConfigurable	(		name,
			registry,
			ConfigClass = None
	)

A decorator that adds a class as a configurable in a `Registry`
instance.

Parameters
----------
name : `str`
    Name of the target (the decorated class) in the ``registry``.
registry : `Registry`
    The `Registry` instance that the decorated class is added to.
ConfigClass : `lsst.pex.config.Config`-type, optional
    Config class associated with the configurable. If `None`, the class's
    ``ConfigClass`` attribute is used instead.

See also
--------
registerConfig

Notes
-----
Internally, this decorator runs `Registry.register`.

Definition at line 358 of file registry.py.

def registerConfigurable(name, registry, ConfigClass=None):
    """A decorator that adds a class as a configurable in a `Registry`
    instance.
 
    Parameters
    ----------
    name : `str`
        Name of the target (the decorated class) in the ``registry``.
    registry : `Registry`
        The `Registry` instance that the decorated class is added to.
    ConfigClass : `lsst.pex.config.Config`-type, optional
        Config class associated with the configurable. If `None`, the class's
        ``ConfigClass`` attribute is used instead.
 
    See also
    --------
    registerConfig
 
    Notes
    -----
    Internally, this decorator runs `Registry.register`.
    """
    def decorate(cls):
        registry.register(name, target=cls, ConfigClass=ConfigClass)
        return cls
    return decorate