Inheritance diagram for lsst.pex.config.registry.RegistryField:

Public Member Functions
	__init__ (self, doc, registry, default=None, optional=False, multi=False, on_none=None)

	__deepcopy__ (self, memo)

Public Attributes
	registry

Static Public Attributes
	instanceDictClass = RegistryInstanceDict

Protected Attributes
	_on_none

Detailed Description

A configuration field whose options are defined in a `Registry`.

Parameters
----------
doc : `str`
    A description of the field.
registry : `Registry`
    The registry that contains this field.
default : `str`, optional
    The default target key.
optional : `bool`, optional
    When `False`, `lsst.pex.config.Config.validate` fails if the field's
    value is `None`.
multi : `bool`, optional
    If `True`, the field allows multiple selections. The default is
    `False`.
on_none : `Callable`, optional
    A callable that should be invoked when ``apply`` is called but the
    selected name or names is `None`.  Will be passed the field attribute
    proxy (`RegistryInstanceDict`) and then all positional and keyword
    arguments passed to ``apply``.

See Also
--------
ChoiceField
ConfigChoiceField
ConfigDictField
ConfigField
ConfigurableField
DictField
Field
ListField
RangeField

Definition at line 340 of file registry.py.

Constructor & Destructor Documentation

◆ init()

lsst.pex.config.registry.RegistryField.__init__	(	self,
		doc,
		registry,
		default = None,
		optional = False,
		multi = False,
		on_none = None )

Reimplemented from lsst.pex.config.configChoiceField.ConfigChoiceField.

Definition at line 380 of file registry.py.

    def __init__(self, doc, registry, default=None, optional=False, multi=False, on_none=None):
        types = RegistryAdaptor(registry)
        self.registry = registry
        self._on_none = on_none
        ConfigChoiceField.__init__(self, doc, types, default, optional, multi)
 

Member Function Documentation

◆ deepcopy()

lsst.pex.config.registry.RegistryField.__deepcopy__	(		self,
			memo )

Customize deep-copying, want a reference to the original registry.

WARNING: this must be overridden by subclasses if they change the
constructor signature!

Reimplemented from lsst.pex.config.configChoiceField.ConfigChoiceField.

Definition at line 386 of file registry.py.

    def __deepcopy__(self, memo):
        """Customize deep-copying, want a reference to the original registry.
 
        WARNING: this must be overridden by subclasses if they change the
        constructor signature!
        """
        other = type(self)(
            doc=self.doc,
            registry=self.registry,
            default=copy.deepcopy(self.default),
            optional=self.optional,
            multi=self.multi,
            on_none=self._on_none,
        )
        other.source = self.source
        return other
 
 

Member Data Documentation

◆ _on_none

lsst.pex.config.registry.RegistryField._on_none

protected

Definition at line 383 of file registry.py.

◆ instanceDictClass

lsst.pex.config.registry.RegistryField.instanceDictClass = RegistryInstanceDict

static

Definition at line 376 of file registry.py.

◆ registry

lsst.pex.config.registry.RegistryField.registry

Definition at line 382 of file registry.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pex_config/gba4ed39666+c2a2e4ac27/python/lsst/pex/config/registry.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes