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 247 of file config.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 261 of file config.py.

    def __init__(self, field, config, msg):
        self.fieldType = type(field)
        """Type of the `~lsst.pex.config.Field` that incurred the error.
        """
 
        self.fieldName = field.name
        """Name of the `~lsst.pex.config.Field` instance that incurred the
        error (`str`).
 
        See also
        --------
        lsst.pex.config.Field.name
        """
 
        self.fullname = _joinNamePath(config._name, field.name)
        """Fully-qualified name of the `~lsst.pex.config.Field` instance
        (`str`).
        """
 
        self.history = config.history.setdefault(field.name, [])
        """Full history of all changes to the `~lsst.pex.config.Field`
        instance.
        """
 
        self.fieldSource = field.source
        """File and line number of the `~lsst.pex.config.Field` definition.
        """
 
        self.configSource = config._source
        error = (
            f"{self.fieldType.__name__} '{self.fullname}' failed validation: {msg}\n"
            f"For more information see the Field definition at:\n{self.fieldSource.format()}"
            f" and the Config definition at:\n{self.configSource.format()}"
        )
        super().__init__(error)
 
 

Member Data Documentation

configSource

lsst.pex.config.config.FieldValidationError.configSource

Definition at line 289 of file config.py.

fieldName

lsst.pex.config.config.FieldValidationError.fieldName

Definition at line 266 of file config.py.

fieldSource

lsst.pex.config.config.FieldValidationError.fieldSource

Definition at line 285 of file config.py.

fieldType

lsst.pex.config.config.FieldValidationError.fieldType

Definition at line 262 of file config.py.

fullname

lsst.pex.config.config.FieldValidationError.fullname

Definition at line 275 of file config.py.

history

lsst.pex.config.config.FieldValidationError.history

Definition at line 280 of file config.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/pex_config/g8534526c7b+8e1c6b434f/python/lsst/pex/config/config.py