lsst.pex.config.registry.RegistryField Class Reference

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 Member Functions inherited from lsst.pex.config.configChoiceField.ConfigChoiceField
	__init__ (self, doc, typemap, default=None, optional=False, multi=False, deprecated=None)
	__class_getitem__ (cls, tuple[type,...]|type|ForwardRef params)
ConfigChoiceField	__get__ (self, None instance, Any owner=None, Any at=None, str label="default")
ConfigInstanceDict	__get__ (self, Config instance, Any owner=None, Any at=None, str label="default")
	__get__ (self, instance, owner=None, at=None, label="default")
None	__set__ (self, Config instance, ConfigInstanceDict|None value, Any at=None, str label="assignment")
	rename (self, instance)
	validate (self, instance)
	toDict (self, instance)
	freeze (self, instance)
	save (self, outfile, instance)
	__deepcopy__ (self, memo)
Public Member Functions inherited from lsst.pex.config.config.Field
	__class_getitem__ (cls, tuple[type,...]|type|ForwardRef params)
	__init__ (self, doc, dtype=None, default=None, check=None, optional=False, deprecated=None)
Field[FieldTypeVar]	__get__ (self, None instance, Any owner=None, Any at=None, str label="default")
FieldTypeVar	__get__ (self, Config instance, Any owner=None, Any at=None, str label="default")
	__get__ (self, instance, owner=None, at=None, label="default")
None	__set__ (self, Config instance, FieldTypeVar|None value, Any at=None, str label="assignment")
	__delete__ (self, instance, at=None, label="deletion")

Public Attributes
	registry = registry
Public Attributes inherited from lsst.pex.config.configChoiceField.ConfigChoiceField
	typemap = typemap
	multi = multi
Public Attributes inherited from lsst.pex.config.config.Field
	dtype = dtype
	doc = doc
	deprecated = deprecated
	default = default
	check = check
	optional = optional
	source = source

Protected Attributes
	_on_none = on_none

Additional Inherited Members
Static Public Attributes inherited from lsst.pex.config.configChoiceField.ConfigChoiceField
	instanceDictClass = ConfigInstanceDict
Static Public Attributes inherited from lsst.pex.config.config.Field
dict	supportedTypes = {str, bool, float, int, complex}
Protected Member Functions inherited from lsst.pex.config.configChoiceField.ConfigChoiceField
	_getOrMake (self, instance, label="default")
Any	_copy_storage (self, Config old, Config new)
	_collectImports (self, instance, imports)
	_compare (self, instance1, instance2, shortcut, rtol, atol, output)
Protected Member Functions inherited from lsst.pex.config.config.Field
	_setup (self, doc, dtype, default, check, optional, source, deprecated)
	_validateValue (self, value)
Static Protected Member Functions inherited from lsst.pex.config.config.Field
Mapping[str, Any]	_parseTypingArgs (tuple[type,...]|tuple[str,...] params, Mapping[str, Any] kwds)

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

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!

---

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

• python/lsst/pex/config/registry.py