lsst.pex.config gba4ed39666+e464e2e6f0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
lsst.pex.config.configDictField.ConfigDict Class Reference
Inheritance diagram for lsst.pex.config.configDictField.ConfigDict:
lsst.pex.config.dictField.Dict lsst.pex.config.config.Config lsst.pex.config.config.ConfigMeta

Public Member Functions

 __init__ (self, config, field, value, at, label)
 
 __setitem__ (self, k, x, at=None, label="setitem", setHistory=True)
 
 __delitem__ (self, k, at=None, label="delitem")
 
- Public Member Functions inherited from lsst.pex.config.dictField.Dict
ItemTypeVar __getitem__ (self, KeyTypeVar k)
 
int __len__ (self)
 
Iterator[KeyTypeVar] __iter__ (self)
 
bool __contains__ (self, Any k)
 
 __repr__ (self)
 
 __str__ (self)
 
 __setattr__ (self, attr, value, at=None, label="assignment")
 
 __reduce__ (self)
 
- Public Member Functions inherited from lsst.pex.config.config.Config
 __iter__ (self)
 
 keys (self)
 
 values (self)
 
 items (self)
 
 __contains__ (self, name)
 
 __new__ (cls, *args, **kw)
 
 __reduce__ (self)
 
 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)
 
 save (self, filename, root="config")
 
 saveToString (self, skipImports=False)
 
 saveToStream (self, outfile, root="config", skipImports=False)
 
 freeze (self)
 
 toDict (self)
 
 names (self)
 
 validate (self)
 
 formatHistory (self, name, **kwargs)
 
 __setattr__ (self, attr, value, at=None, label="assignment")
 
 __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)
 

Protected Attributes

 _field
 
 _config
 
- Protected Attributes inherited from lsst.pex.config.dictField.Dict
 _field
 
 _config_
 
 _dict
 
 _history
 
 _config
 
- 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.dictField.Dict
Config _config (self)
 
- Protected Member Functions inherited from lsst.pex.config.config.Config
 _save (self, outfile)
 
 _collectImports (self)
 
 _rename (self, name)
 
 _fromPython (cls, config_py)
 
- 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.dictField.Dict
 history = property(lambda x: x._history)
 
- Properties inherited from lsst.pex.config.config.Config
 history = property(lambda x: x._history)
 

Detailed Description

Internal representation of a dictionary of configuration classes.

Much like `Dict`, `ConfigDict` is a custom `MutableMapper` which tracks
the history of changes to any of its items.

Parameters
----------
config : `~lsst.pex.config.Config`
    Config to use.
field : `~lsst.pex.config.ConfigDictField`
    Field to use.
value : `~typing.Any`
    Value to store in dict.
at : `list` of `~lsst.pex.config.callStack.StackFrame` or `None`, optional
    Stack frame for history recording. Will be calculated if `None`.
label : `str`, optional
    Label to use for history recording.

Constructor & Destructor Documentation

◆ __init__()

lsst.pex.config.configDictField.ConfigDict.__init__ ( self,
config,
field,
value,
at,
label )

Reimplemented from lsst.pex.config.dictField.Dict.

Member Function Documentation

◆ __delitem__()

lsst.pex.config.configDictField.ConfigDict.__delitem__ ( self,
k,
at = None,
label = "delitem" )

Reimplemented from lsst.pex.config.dictField.Dict.

◆ __setitem__()

lsst.pex.config.configDictField.ConfigDict.__setitem__ ( self,
k,
x,
at = None,
label = "setitem",
setHistory = True )

Reimplemented from lsst.pex.config.dictField.Dict.


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