pex.config.config.FieldValidationError Class Reference

Inheritance diagram for pex.config.config.FieldValidationError:

Public Member Functions
def	__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 144 of file config.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 158 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 = "%s '%s' failed validation: %s\n"\
                "For more information see the Field definition at:\n%s"\
                " and the Config definition at:\n%s" % \
            (self.fieldType.__name__, self.fullname, msg,
             self.fieldSource.format(), self.configSource.format())
        super().__init__(error)
 
 

Member Data Documentation

configSource

pex.config.config.FieldValidationError.configSource

Definition at line 186 of file config.py.

fieldName

pex.config.config.FieldValidationError.fieldName

Definition at line 163 of file config.py.

fieldSource

pex.config.config.FieldValidationError.fieldSource

Definition at line 182 of file config.py.

fieldType

pex.config.config.FieldValidationError.fieldType

Definition at line 159 of file config.py.

fullname

pex.config.config.FieldValidationError.fullname

Definition at line 172 of file config.py.

history

pex.config.config.FieldValidationError.history

Definition at line 177 of file config.py.

---

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

• /j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/pex_config/20.0.0+34a42eae2c/python/lsst/pex/config/config.py