LSSTApplications  19.0.0-14-gb0260a2+2d714fc2ef,20.0.0+34a42eae2c,20.0.0+76f397ef0c,20.0.0+8558dd3f48,20.0.0+a6b6977b51,20.0.0+b2ea66fa67,20.0.0+cc669a8b45,20.0.0+d561663fb5,20.0.0+d778e99126,20.0.0+efe67588cf,20.0.0+f45b7d88f4,20.0.0+f7c597f720,20.0.0+fb43bee9b9,20.0.0+fb4d547e0d,20.0.0-1-g10df615+d8b88ec1b5,20.0.0-1-g253301a+a6b6977b51,20.0.0-1-g498fb60+ff88705a28,20.0.0-1-g4d801e7+ce0d01dabd,20.0.0-1-g5b95a8c+24eaf908b3,20.0.0-1-g8a53f90+2817c06967,20.0.0-1-gc96f8cb+fb4d547e0d,20.0.0-1-gd1c87d7+2817c06967,20.0.0-1-gdb27ee5+abab67204f,20.0.0-13-ge998c5c+9f8c516ffa,20.0.0-18-g08fba245+88079d2923,20.0.0-2-gec03fae+fb98bf9d97,20.0.0-3-gdd5c15c+a61313b210,20.0.0-34-gdb4d86a+b43b2c05ff,20.0.0-4-g4a2362f+f45b7d88f4,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-5-gac0d578b1+a8c4e2ada3,20.0.0-5-gfcebe35+cfceff6a24,20.0.0-6-g01203fff+e332440eaf,20.0.0-8-gea2affd+48c001ce3c,20.0.0-9-gabd0d4c+abab67204f,20.0.0-9-gf3ab18e+fb4d547e0d,w.2020.33
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pex.config.dictField.DictField Class Reference
Inheritance diagram for pex.config.dictField.DictField:
pex.config.config.Field pex.config.configDictField.ConfigDictField

Public Member Functions

def __init__ (self, doc, keytype, itemtype, default=None, optional=False, dictCheck=None, itemCheck=None, deprecated=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
 
 deprecated
 
 default
 
 check
 
 optional
 
 source
 

Static Public Attributes

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

Detailed Description

A configuration field (`~lsst.pex.config.Field` subclass) that maps keys
and values.

The types of both items and keys are restricted to these builtin types:
`int`, `float`, `complex`, `bool`, and `str`). All keys share the same type
and all values share the same type. Keys can have a different type from
values.

Parameters
----------
doc : `str`
    A documentation string that describes the configuration field.
keytype : {`int`, `float`, `complex`, `bool`, `str`}
    The type of the mapping keys. All keys must have this type.
itemtype : {`int`, `float`, `complex`, `bool`, `str`}
    Type of the mapping values.
default : `dict`, optional
    The default mapping.
optional : `bool`, optional
    If `True`, the field doesn't need to have a set value.
dictCheck : callable
    A function that validates the dictionary as a whole.
itemCheck : callable
    A function that validates individual mapping values.
deprecated : None or `str`, optional
    A description of why this Field is deprecated, including removal date.
    If not None, the string is appended to the docstring for this Field.

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

Examples
--------
This field maps has `str` keys and `int` values:

>>> from lsst.pex.config import Config, DictField
>>> class MyConfig(Config):
...     field = DictField(
...         doc="Example string-to-int mapping field.",
...         keytype=str, itemtype=int,
...         default={})
...
>>> config = MyConfig()
>>> config.field['myKey'] = 42
>>> print(config.field)
{'myKey': 42}

Definition at line 144 of file dictField.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented in pex.config.configDictField.ConfigDictField.

Definition at line 204 of file dictField.py.

204  def __init__(self, doc, keytype, itemtype, default=None, optional=False, dictCheck=None, itemCheck=None,
205  deprecated=None):
206  source = getStackFrame()
207  self._setup(doc=doc, dtype=Dict, default=default, check=None,
208  optional=optional, source=source, deprecated=deprecated)
209  if keytype not in self.supportedTypes:
210  raise ValueError("'keytype' %s is not a supported type" %
211  _typeStr(keytype))
212  elif itemtype is not None and itemtype not in self.supportedTypes:
213  raise ValueError("'itemtype' %s is not a supported type" %
214  _typeStr(itemtype))
215  if dictCheck is not None and not hasattr(dictCheck, "__call__"):
216  raise ValueError("'dictCheck' must be callable")
217  if itemCheck is not None and not hasattr(itemCheck, "__call__"):
218  raise ValueError("'itemCheck' must be callable")
219 
220  self.keytype = keytype
221  self.itemtype = itemtype
222  self.dictCheck = dictCheck
223  self.itemCheck = itemCheck
224 

Member Function Documentation

◆ __delete__()

def pex.config.config.Field.__delete__ (   self,
  instance,
  at = None,
  label = 'deletion' 
)
inherited
Delete an attribute from a `lsst.pex.config.Config` instance.

Parameters
----------
instance : `lsst.pex.config.Config`
    The config instance that contains this field.
at : `list` of `lsst.pex.config.callStack.StackFrame`
    The call stack (created by
    `lsst.pex.config.callStack.getCallStack`).
label : `str`, optional
    Event label for the history.

Notes
-----
This is invoked by the owning `~lsst.pex.config.Config` object and
should not be called directly.

Definition at line 573 of file config.py.

573  def __delete__(self, instance, at=None, label='deletion'):
574  """Delete an attribute from a `lsst.pex.config.Config` instance.
575 
576  Parameters
577  ----------
578  instance : `lsst.pex.config.Config`
579  The config instance that contains this field.
580  at : `list` of `lsst.pex.config.callStack.StackFrame`
581  The call stack (created by
582  `lsst.pex.config.callStack.getCallStack`).
583  label : `str`, optional
584  Event label for the history.
585 
586  Notes
587  -----
588  This is invoked by the owning `~lsst.pex.config.Config` object and
589  should not be called directly.
590  """
591  if at is None:
592  at = getCallStack()
593  self.__set__(instance, None, at=at, label=label)
594 

◆ __get__()

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

Reimplemented in pex.config.configurableField.ConfigurableField.

Definition at line 498 of file config.py.

498  def __get__(self, instance, owner=None, at=None, label="default"):
499  """Define how attribute access should occur on the Config instance
500  This is invoked by the owning config object and should not be called
501  directly
502 
503  When the field attribute is accessed on a Config class object, it
504  returns the field object itself in order to allow inspection of
505  Config classes.
506 
507  When the field attribute is access on a config instance, the actual
508  value described by the field (and held by the Config instance) is
509  returned.
510  """
511  if instance is None or not isinstance(instance, Config):
512  return self
513  else:
514  return instance._storage[self.name]
515 

◆ __set__()

def pex.config.dictField.DictField.__set__ (   self,
  instance,
  value,
  at = None,
  label = "assignment" 
)
Set an attribute on the config instance.

Parameters
----------
instance : `lsst.pex.config.Config`
    The config instance that contains this field.
value : obj
    Value to set on this field.
at : `list` of `lsst.pex.config.callStack.StackFrame`
    The call stack (created by
    `lsst.pex.config.callStack.getCallStack`).
label : `str`, optional
    Event label for the history.

Notes
-----
This method is invoked by the owning `lsst.pex.config.Config` object
and should not be called directly.

Derived `~lsst.pex.config.Field` classes may need to override the
behavior. When overriding ``__set__``, `~lsst.pex.config.Field` authors
should follow the following rules:

- Do not allow modification of frozen configs.
- Validate the new value **before** modifying the field. Except if the
  new value is `None`. `None` is special and no attempt should be made
  to validate it until `lsst.pex.config.Config.validate` is called.
- Do not modify the `~lsst.pex.config.Config` instance to contain
  invalid values.
- If the field is modified, update the history of the
  `lsst.pex.config.field.Field` to reflect the changes.

In order to decrease the need to implement this method in derived
`~lsst.pex.config.Field` types, value validation is performed in the
`lsst.pex.config.Field._validateValue`. If only the validation step
differs in the derived `~lsst.pex.config.Field`, it is simpler to
implement `lsst.pex.config.Field._validateValue` than to reimplement
``__set__``. More complicated behavior, however, may require
reimplementation.

Reimplemented from pex.config.config.Field.

Definition at line 258 of file dictField.py.

258  def __set__(self, instance, value, at=None, label="assignment"):
259  if instance._frozen:
260  msg = "Cannot modify a frozen Config. "\
261  "Attempting to set field to value %s" % value
262  raise FieldValidationError(self, instance, msg)
263 
264  if at is None:
265  at = getCallStack()
266  if value is not None:
267  value = self.DictClass(instance, self, value, at=at, label=label)
268  else:
269  history = instance._history.setdefault(self.name, [])
270  history.append((value, at, label))
271 
272  instance._storage[self.name] = value
273 

◆ freeze()

def pex.config.config.Field.freeze (   self,
  instance 
)
inherited
Make this field read-only (for internal use only).

Parameters
----------
instance : `lsst.pex.config.Config`
    The config instance that contains this field.

Notes
-----
Freezing is only relevant for fields that hold subconfigs. Fields which
hold subconfigs should freeze each subconfig.

**Subclasses should implement this method.**

Reimplemented in pex.config.configChoiceField.ConfigChoiceField, pex.config.configurableField.ConfigurableField, pex.config.configDictField.ConfigDictField, and pex.config.configField.ConfigField.

Definition at line 377 of file config.py.

377  def freeze(self, instance):
378  """Make this field read-only (for internal use only).
379 
380  Parameters
381  ----------
382  instance : `lsst.pex.config.Config`
383  The config instance that contains this field.
384 
385  Notes
386  -----
387  Freezing is only relevant for fields that hold subconfigs. Fields which
388  hold subconfigs should freeze each subconfig.
389 
390  **Subclasses should implement this method.**
391  """
392  pass
393 

◆ rename()

def pex.config.config.Field.rename (   self,
  instance 
)
inherited
Rename the field in a `~lsst.pex.config.Config` (for internal use
only).

Parameters
----------
instance : `lsst.pex.config.Config`
    The config instance that contains this field.

Notes
-----
This method is invoked by the `lsst.pex.config.Config` object that
contains this field and should not be called directly.

Renaming is only relevant for `~lsst.pex.config.Field` instances that
hold subconfigs. `~lsst.pex.config.Fields` that hold subconfigs should
rename each subconfig with the full field name as generated by
`lsst.pex.config.config._joinNamePath`.

Reimplemented in pex.config.configChoiceField.ConfigChoiceField, pex.config.configurableField.ConfigurableField, pex.config.configDictField.ConfigDictField, and pex.config.configField.ConfigField.

Definition at line 327 of file config.py.

327  def rename(self, instance):
328  """Rename the field in a `~lsst.pex.config.Config` (for internal use
329  only).
330 
331  Parameters
332  ----------
333  instance : `lsst.pex.config.Config`
334  The config instance that contains this field.
335 
336  Notes
337  -----
338  This method is invoked by the `lsst.pex.config.Config` object that
339  contains this field and should not be called directly.
340 
341  Renaming is only relevant for `~lsst.pex.config.Field` instances that
342  hold subconfigs. `~lsst.pex.config.Fields` that hold subconfigs should
343  rename each subconfig with the full field name as generated by
344  `lsst.pex.config.config._joinNamePath`.
345  """
346  pass
347 

◆ save()

def pex.config.config.Field.save (   self,
  outfile,
  instance 
)
inherited
Save this field to a file (for internal use only).

Parameters
----------
outfile : file-like object
    A writeable field handle.
instance : `Config`
    The `Config` instance that contains this field.

Notes
-----
This method is invoked by the `~lsst.pex.config.Config` object that
contains this field and should not be called directly.

The output consists of the documentation string
(`lsst.pex.config.Field.doc`) formatted as a Python comment. The second
line is formatted as an assignment: ``{fullname}={value}``.

This output can be executed with Python.

Reimplemented in pex.config.configChoiceField.ConfigChoiceField, pex.config.configurableField.ConfigurableField, pex.config.configDictField.ConfigDictField, and pex.config.configField.ConfigField.

Definition at line 435 of file config.py.

435  def save(self, outfile, instance):
436  """Save this field to a file (for internal use only).
437 
438  Parameters
439  ----------
440  outfile : file-like object
441  A writeable field handle.
442  instance : `Config`
443  The `Config` instance that contains this field.
444 
445  Notes
446  -----
447  This method is invoked by the `~lsst.pex.config.Config` object that
448  contains this field and should not be called directly.
449 
450  The output consists of the documentation string
451  (`lsst.pex.config.Field.doc`) formatted as a Python comment. The second
452  line is formatted as an assignment: ``{fullname}={value}``.
453 
454  This output can be executed with Python.
455  """
456  value = self.__get__(instance)
457  fullname = _joinNamePath(instance._name, self.name)
458 
459  if self.deprecated and value == self.default:
460  return
461 
462  # write full documentation string as comment lines
463  # (i.e. first character is #)
464  doc = "# " + str(self.doc).replace("\n", "\n# ")
465  if isinstance(value, float) and (math.isinf(value) or math.isnan(value)):
466  # non-finite numbers need special care
467  outfile.write(u"{}\n{}=float('{!r}')\n\n".format(doc, fullname, value))
468  else:
469  outfile.write(u"{}\n{}={!r}\n\n".format(doc, fullname, value))
470 

◆ toDict()

def pex.config.dictField.DictField.toDict (   self,
  instance 
)
Convert this field's key-value pairs into a regular `dict`.

Parameters
----------
instance : `lsst.pex.config.Config`
    The configuration that contains this field.

Returns
-------
result : `dict` or `None`
    If this field has a value of `None`, then this method returns
    `None`. Otherwise, this method returns the field's value as a
    regular Python `dict`.

Reimplemented from pex.config.config.Field.

Reimplemented in pex.config.configDictField.ConfigDictField.

Definition at line 274 of file dictField.py.

274  def toDict(self, instance):
275  """Convert this field's key-value pairs into a regular `dict`.
276 
277  Parameters
278  ----------
279  instance : `lsst.pex.config.Config`
280  The configuration that contains this field.
281 
282  Returns
283  -------
284  result : `dict` or `None`
285  If this field has a value of `None`, then this method returns
286  `None`. Otherwise, this method returns the field's value as a
287  regular Python `dict`.
288  """
289  value = self.__get__(instance)
290  return dict(value) if value is not None else None
291 

◆ validate()

def pex.config.dictField.DictField.validate (   self,
  instance 
)
Validate the field's value (for internal use only).

Parameters
----------
instance : `lsst.pex.config.Config`
    The configuration that contains this field.

Returns
-------
isValid : `bool`
    `True` is returned if the field passes validation criteria (see
    *Notes*). Otherwise `False`.

Notes
-----
This method validates values according to the following criteria:

- A non-optional field is not `None`.
- If a value is not `None`, is must pass the `ConfigField.dictCheck`
  user callback functon.

Individual item checks by the `ConfigField.itemCheck` user callback
function are done immediately when the value is set on a key. Those
checks are not repeated by this method.

Reimplemented from pex.config.config.Field.

Reimplemented in pex.config.configDictField.ConfigDictField.

Definition at line 225 of file dictField.py.

225  def validate(self, instance):
226  """Validate the field's value (for internal use only).
227 
228  Parameters
229  ----------
230  instance : `lsst.pex.config.Config`
231  The configuration that contains this field.
232 
233  Returns
234  -------
235  isValid : `bool`
236  `True` is returned if the field passes validation criteria (see
237  *Notes*). Otherwise `False`.
238 
239  Notes
240  -----
241  This method validates values according to the following criteria:
242 
243  - A non-optional field is not `None`.
244  - If a value is not `None`, is must pass the `ConfigField.dictCheck`
245  user callback functon.
246 
247  Individual item checks by the `ConfigField.itemCheck` user callback
248  function are done immediately when the value is set on a key. Those
249  checks are not repeated by this method.
250  """
251  Field.validate(self, instance)
252  value = self.__get__(instance)
253  if value is not None and self.dictCheck is not None \
254  and not self.dictCheck(value):
255  msg = "%s is not a valid value" % str(value)
256  raise FieldValidationError(self, instance, msg)
257 

Member Data Documentation

◆ check

pex.config.config.Field.check
inherited

Definition at line 311 of file config.py.

◆ default

pex.config.config.Field.default
inherited

Definition at line 307 of file config.py.

◆ deprecated

pex.config.config.Field.deprecated
inherited

Definition at line 298 of file config.py.

◆ dictCheck

pex.config.dictField.DictField.dictCheck

Definition at line 221 of file dictField.py.

◆ DictClass

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

Definition at line 202 of file dictField.py.

◆ doc

pex.config.config.Field.doc
inherited

Definition at line 294 of file config.py.

◆ dtype

pex.config.config.Field.dtype
inherited

Definition at line 287 of file config.py.

◆ itemCheck

pex.config.dictField.DictField.itemCheck

Definition at line 222 of file dictField.py.

◆ itemtype

pex.config.dictField.DictField.itemtype

Definition at line 220 of file dictField.py.

◆ keytype

pex.config.dictField.DictField.keytype

Definition at line 219 of file dictField.py.

◆ optional

pex.config.config.Field.optional
inherited

Definition at line 315 of file config.py.

◆ source

pex.config.config.Field.source
inherited

Definition at line 322 of file config.py.

◆ supportedTypes

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

Definition at line 272 of file config.py.


The documentation for this class was generated from the following file:
pex.config.callStack.getStackFrame
def getStackFrame(relative=0)
Definition: callStack.py:58
pex.config.history.format
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174
pex.config.callStack.getCallStack
def getCallStack(skip=0)
Definition: callStack.py:175
pex.config.wrap.validate
validate
Definition: wrap.py:295