LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+0dd8ce4237,g1470d8bcf6+3ea6592b6f,g2079a07aa2+86d27d4dc4,g2305ad1205+5ca4c0b359,g295015adf3+d10818ec9d,g2a9a014e59+6f9be1b9cd,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+703ba97ebf,g487adcacf7+4fa16da234,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+ffa42b374e,g5a732f18d5+53520f316c,g64a986408d+0dd8ce4237,g858d7b2824+0dd8ce4237,g8a8a8dda67+585e252eca,g99cad8db69+d39438377f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+f1d96605c8,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e5339d463f,gc120e1dc64+da31e9920e,gc28159a63d+0e5473021a,gcf0d15dbbd+703ba97ebf,gdaeeff99f8+f9a426f77a,ge6526c86ff+889fc9d533,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf18bd8381d+7268b93478,gff1a9f87cc+0dd8ce4237,w.2024.16
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst.pex.config.config.FieldValidationError Class Reference
Inheritance diagram for lsst.pex.config.config.FieldValidationError:

Public Member Functions

 __init__ (self, field, config, msg)
 

Public Attributes

 fieldType
 
 fieldName
 
 fullname
 
 history
 
 fieldSource
 
 configSource
 

Detailed Description

Raised when a ``~lsst.pex.config.Field`` is not valid in a
particular ``~lsst.pex.config.Config``.

Parameters
----------
field : `lsst.pex.config.Field`
    The field that was not valid.
config : `lsst.pex.config.Config`
    The config containing the invalid field.
msg : `str`
    Text describing why the field was not valid.

Definition at line 252 of file config.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.pex.config.config.FieldValidationError.__init__ ( self,
field,
config,
msg )

Definition at line 266 of file config.py.

266 def __init__(self, field, config, msg):
267 self.fieldType = type(field)
268 """Type of the `~lsst.pex.config.Field` that incurred the error.
269 """
270
271 self.fieldName = field.name
272 """Name of the `~lsst.pex.config.Field` instance that incurred the
273 error (`str`).
274
275 See also
276 --------
277 lsst.pex.config.Field.name
278 """
279
280 self.fullname = _joinNamePath(config._name, field.name)
281 """Fully-qualified name of the `~lsst.pex.config.Field` instance
282 (`str`).
283 """
284
285 self.history = config.history.setdefault(field.name, [])
286 """Full history of all changes to the `~lsst.pex.config.Field`
287 instance.
288 """
289
290 self.fieldSource = field.source
291 """File and line number of the `~lsst.pex.config.Field` definition.
292 """
293
294 self.configSource = config._source
295 error = (
296 "%s '%s' failed validation: %s\n"
297 "For more information see the Field definition at:\n%s"
298 " and the Config definition at:\n%s"
299 % (
300 self.fieldType.__name__,
301 self.fullname,
302 msg,
303 self.fieldSource.format(),
304 self.configSource.format(),
305 )
306 )
307 super().__init__(error)
308
309

Member Data Documentation

◆ configSource

lsst.pex.config.config.FieldValidationError.configSource

Definition at line 294 of file config.py.

◆ fieldName

lsst.pex.config.config.FieldValidationError.fieldName

Definition at line 271 of file config.py.

◆ fieldSource

lsst.pex.config.config.FieldValidationError.fieldSource

Definition at line 290 of file config.py.

◆ fieldType

lsst.pex.config.config.FieldValidationError.fieldType

Definition at line 267 of file config.py.

◆ fullname

lsst.pex.config.config.FieldValidationError.fullname

Definition at line 280 of file config.py.

◆ history

lsst.pex.config.config.FieldValidationError.history

Definition at line 285 of file config.py.


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