lsst.pex.config g38189d092c+6a8a80267a
Loading...
Searching...
No Matches
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 lsst.pex.config.configChoiceField.ConfigInstanceDict

Public Member Functions

def __init__ (self, doc, registry, default=None, optional=False, multi=False, on_none=None)
 
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 __class_getitem__ (cls, Union[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")
 
def __get__ (self, instance, owner=None, at=None, label="default")
 
None __set__ (self, Config instance, Optional[ConfigInstanceDict] value, Any at=None, str label="assignment")
 
def rename (self, instance)
 
def validate (self, instance)
 
def toDict (self, instance)
 
def freeze (self, instance)
 
def save (self, outfile, instance)
 
def __deepcopy__ (self, memo)
 
- Public Member Functions inherited from lsst.pex.config.config.Field
def __class_getitem__ (cls, Union[tuple[type,...], type, ForwardRef] params)
 
def __init__ (self, doc, dtype=None, default=None, check=None, optional=False, deprecated=None)
 
def rename (self, instance)
 
def validate (self, instance)
 
def freeze (self, instance)
 
def save (self, outfile, instance)
 
def toDict (self, instance)
 
"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")
 
def __get__ (self, instance, owner=None, at=None, label="default")
 
None __set__ (self, "Config" instance, Optional[FieldTypeVar] value, Any at=None, str label="assignment")
 
def __delete__ (self, instance, at=None, label="deletion")
 
- Public Member Functions inherited from lsst.pex.config.configChoiceField.ConfigInstanceDict
def __init__ (self, config, field)
 
def types (self)
 
def __contains__ (self, k)
 
def __len__ (self)
 
def __iter__ (self)
 
def __getitem__ (self, k, at=None, label="default")
 
def __setitem__ (self, k, value, at=None, label="assignment")
 
def __setattr__ (self, attr, value, at=None, label="assignment")
 
def freeze (self)
 
def __reduce__ (self)
 

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))
 

Additional Inherited Members

- Properties inherited from lsst.pex.config.configChoiceField.ConfigInstanceDict
 names = property(_getNames, _setNames, _delNames)
 
 name = property(_getName, _setName, _delName)
 
 active = property(_getActive)
 

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

Constructor & Destructor Documentation

◆ __init__()

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

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: