lsst.pex.config
17.0.1-2-g54f2ebc+8
|
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) |
def lsst.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 331 of file registry.py.
def lsst.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 381 of file registry.py.
def lsst.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 353 of file registry.py.