lsst.pex.config  16.0-5-gd0f1235+4
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pex.config.dictField.DictField Class Reference
Inheritance diagram for lsst.pex.config.dictField.DictField:
lsst.pex.config.config.Field lsst.pex.config.configDictField.ConfigDictField

Public Member Functions

def __init__ (self, doc, keytype, itemtype, default=None, optional=False, dictCheck=None, itemCheck=None)
 
def validate (self, instance)
 
def __set__ (self, instance, value, at=None, label="assignment")
 
def toDict (self, instance)
 
def rename (self, instance)
 
def freeze (self, instance)
 
def save (self, outfile, instance)
 
def __get__ (self, instance, owner=None, at=None, label="default")
 
def __delete__ (self, instance, at=None, label='deletion')
 

Public Attributes

 keytype
 
 itemtype
 
 dictCheck
 
 itemCheck
 
 dtype
 
 doc
 
 default
 
 check
 
 optional
 
 source
 

Static Public Attributes

 DictClass = Dict
 
 supportedTypes = set((str, bool, float, int, complex))
 

Detailed Description

Defines a field which is a mapping of values

Both key and item types are restricted to builtin POD types:
    (int, float, complex, bool, str)

Users can provide two check functions:
    dictCheck: used to validate the dict as a whole, and
    itemCheck: used to validate each item individually

For example to define a field which is a mapping from names to int values:

class MyConfig(Config):
    field = DictField(
            doc="example string-to-int mapping field",
            keytype=str, itemtype=int,
            default= {})

Definition at line 140 of file dictField.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pex.config.dictField.DictField.__init__ (   self,
  doc,
  keytype,
  itemtype,
  default = None,
  optional = False,
  dictCheck = None,
  itemCheck = None 
)

Definition at line 161 of file dictField.py.

Member Function Documentation

◆ __delete__()

def lsst.pex.config.config.Field.__delete__ (   self,
  instance,
  at = None,
  label = 'deletion' 
)
inherited
Describe how attribute deletion should occur on the Config instance.
This is invoked by the owning config object and should not be called
directly

Definition at line 329 of file config.py.

◆ __get__()

def lsst.pex.config.config.Field.__get__ (   self,
  instance,
  owner = None,
  at = None,
  label = "default" 
)
inherited
Define how attribute access should occur on the Config instance
This is invoked by the owning config object and should not be called
directly

When the field attribute is accessed on a Config class object, it
returns the field object itself in order to allow inspection of
Config classes.

When the field attribute is access on a config instance, the actual
value described by the field (and held by the Config instance) is
returned.

Definition at line 272 of file config.py.

◆ __set__()

def lsst.pex.config.dictField.DictField.__set__ (   self,
  instance,
  value,
  at = None,
  label = "assignment" 
)

Definition at line 194 of file dictField.py.

◆ freeze()

def lsst.pex.config.config.Field.freeze (   self,
  instance 
)
inherited
Make this field read-only.
Only important for fields which hold sub-configs.
Fields which hold subconfigs should freeze each sub-config.

Definition at line 211 of file config.py.

◆ rename()

def lsst.pex.config.config.Field.rename (   self,
  instance 
)
inherited
Rename an instance of this field, not the field itself.
This is invoked by the owning config object and should not be called
directly

Only useful for fields which hold sub-configs.
Fields which hold subconfigs should rename each sub-config with
the full field name as generated by _joinNamePath

Definition at line 186 of file config.py.

◆ save()

def lsst.pex.config.config.Field.save (   self,
  outfile,
  instance 
)
inherited
Saves an instance of this field to file.
This is invoked by the owning config object, and should not be called
directly

outfile ---- an open output stream.

Definition at line 238 of file config.py.

◆ toDict()

def lsst.pex.config.dictField.DictField.toDict (   self,
  instance 
)

Definition at line 210 of file dictField.py.

◆ validate()

def lsst.pex.config.dictField.DictField.validate (   self,
  instance 
)
DictField validation ensures that non-optional fields are not None,
    and that non-None values comply with dictCheck.
Individual Item checks are applied at set time and are not re-checked.

Definition at line 181 of file dictField.py.

Member Data Documentation

◆ check

lsst.pex.config.config.Field.check
inherited

Definition at line 182 of file config.py.

◆ default

lsst.pex.config.config.Field.default
inherited

Definition at line 181 of file config.py.

◆ dictCheck

lsst.pex.config.dictField.DictField.dictCheck

Definition at line 178 of file dictField.py.

◆ DictClass

lsst.pex.config.dictField.DictField.DictClass = Dict
static

Definition at line 159 of file dictField.py.

◆ doc

lsst.pex.config.config.Field.doc
inherited

Definition at line 179 of file config.py.

◆ dtype

lsst.pex.config.config.Field.dtype
inherited

Definition at line 178 of file config.py.

◆ itemCheck

lsst.pex.config.dictField.DictField.itemCheck

Definition at line 179 of file dictField.py.

◆ itemtype

lsst.pex.config.dictField.DictField.itemtype

Definition at line 177 of file dictField.py.

◆ keytype

lsst.pex.config.dictField.DictField.keytype

Definition at line 176 of file dictField.py.

◆ optional

lsst.pex.config.config.Field.optional
inherited

Definition at line 183 of file config.py.

◆ source

lsst.pex.config.config.Field.source
inherited

Definition at line 184 of file config.py.

◆ supportedTypes

lsst.pex.config.config.Field.supportedTypes = set((str, bool, float, int, complex))
staticinherited

Definition at line 153 of file config.py.


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