lsst.pex.config  21.0.0-1-ga51b5d4+f5e6047307
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pex.config.registry.RegistryField Class Reference
Inheritance diagram for lsst.pex.config.registry.RegistryField:
lsst.pex.config.configChoiceField.ConfigChoiceField lsst.pex.config.config.Field

Public Member Functions

def __init__ (self, doc, registry, default=None, optional=False, multi=False)
 
def __deepcopy__ (self, memo)
 
- Public Member Functions inherited from lsst.pex.config.configChoiceField.ConfigChoiceField
def __init__ (self, doc, typemap, default=None, optional=False, multi=False, deprecated=None)
 
def __get__ (self, instance, owner=None)
 
def __set__ (self, instance, value, at=None, label="assignment")
 
def rename (self, instance)
 
def validate (self, instance)
 
def toDict (self, instance)
 
def freeze (self, instance)
 
def save (self, outfile, instance)
 
- Public Member Functions inherited from lsst.pex.config.config.Field
def __get__ (self, instance, owner=None, at=None, label="default")
 
def __delete__ (self, instance, at=None, label='deletion')
 

Public Attributes

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

Static Public Attributes

 instanceDictClass = RegistryInstanceDict
 
- Static Public Attributes inherited from lsst.pex.config.configChoiceField.ConfigChoiceField
 instanceDictClass = ConfigInstanceDict
 
- Static Public Attributes inherited from lsst.pex.config.config.Field
 supportedTypes = set((str, bool, float, int, complex))
 

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`.

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

Member Function Documentation

◆ __deepcopy__()

def 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.


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