lsst.pex.config gba4ed39666+1ac82b564f
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected 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 lsst.pex.config.config.Config lsst.pex.config.config.ConfigMeta

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
 __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)
 
- Public Member Functions inherited from lsst.pex.config.config.Field
 __delete__ (self, instance, at=None, label="deletion")
 
- Public Member Functions inherited from lsst.pex.config.configChoiceField.ConfigInstanceDict
 types (self)
 
 __contains__ (self, k)
 
 __len__ (self)
 
 __iter__ (self)
 
 __getitem__ (self, k, at=None, label="default")
 
 __setitem__ (self, k, value, at=None, label="assignment")
 
 __setattr__ (self, attr, value, at=None, label="assignment")
 
 __reduce__ (self)
 
- Public Member Functions inherited from lsst.pex.config.config.Config
 keys (self)
 
 values (self)
 
 items (self)
 
 __new__ (cls, *args, **kw)
 
 setDefaults (self)
 
 update (self, **kw)
 
 load (self, filename, root="config")
 
 loadFromStream (self, stream, root="config", filename=None, extraLocals=None)
 
 loadFromString (self, code, root="config", filename=None, extraLocals=None)
 
 saveToString (self, skipImports=False)
 
 saveToStream (self, outfile, root="config", skipImports=False)
 
 names (self)
 
 formatHistory (self, name, **kwargs)
 
 __delattr__ (self, attr, at=None, label="deletion")
 
 __eq__ (self, other)
 
 __ne__ (self, other)
 
 __str__ (self)
 
 __repr__ (self)
 
 compare (self, other, shortcut=True, rtol=1e-8, atol=1e-8, output=None)
 
 __init_subclass__ (cls, **kwargs)
 

Public Attributes

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

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
str name
 
dict supportedTypes = {str, bool, float, int, complex}
 

Protected Attributes

 _on_none
 
- Protected Attributes inherited from lsst.pex.config.configChoiceField.ConfigInstanceDict
 _dict
 
 _selection
 
 _config
 
 _field
 
 _history
 
 _typemap
 
- Protected Attributes inherited from lsst.pex.config.config.Config
 _imports
 
 _frozen
 
 _name
 
- Protected Attributes inherited from lsst.pex.config.config.ConfigMeta
 _fields
 
 _source
 

Additional Inherited Members

- Protected Member Functions inherited from lsst.pex.config.configChoiceField.ConfigChoiceField
 _getOrMake (self, instance, label="default")
 
 _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)
 
- Protected Member Functions inherited from lsst.pex.config.configChoiceField.ConfigInstanceDict
 _setSelection (self, value, at=None, label="assignment")
 
 _getNames (self)
 
 _setNames (self, value)
 
 _delNames (self)
 
 _getName (self)
 
 _setName (self, value)
 
 _delName (self)
 
 _getActive (self)
 
 _rename (self, fullname)
 
- Protected Member Functions inherited from lsst.pex.config.config.Config
 _save (self, outfile)
 
 _fromPython (cls, config_py)
 
- Static Protected Member Functions inherited from lsst.pex.config.config.Field
Mapping[str, Any] _parseTypingArgs (tuple[type,...]|tuple[str,...] params, Mapping[str, Any] kwds)
 
- Static Protected Attributes inherited from lsst.pex.config.config.Config
dict _storage [str, Any]
 
dict _fields [str, Field]
 
dict _history [str, list[Any]]
 
set _imports [Any]
 
- Properties inherited from lsst.pex.config.configChoiceField.ConfigInstanceDict
 names = property(_getNames, _setNames, _delNames)
 
 name = property(_getName, _setName, _delName)
 
 active = property(_getActive)
 
- Properties inherited from lsst.pex.config.config.Config
 history = property(lambda x: x._history)
 

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

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

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.


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