import sys
from warnings import warn
__all__ = [
"FailedMinimization",
"ImportBackendError",
"InvalidArchiveHost",
"InvalidBackend",
"InvalidInterpCode",
"InvalidMeasurement",
"InvalidModel",
"InvalidModifier",
"InvalidNameReuse",
"InvalidOptimizer",
"InvalidPatchLookup",
"InvalidPatchSet",
"InvalidPdfData",
"InvalidPdfParameters",
"InvalidSpecification",
"InvalidTestStatistic",
"InvalidWorkspaceOperation",
"PatchSetVerificationError",
"UnspecifiedPOI",
"Unsupported",
]
def __dir__():
return __all__
class Unsupported(Exception):
"""
Unsupported exceptions are raised when something is requested, that is not supported by the current configuration.
"""
[docs]
class InvalidMeasurement(Exception):
"""
InvalidMeasurement is raised when a specified measurement is invalid given the specification.
"""
[docs]
class InvalidNameReuse(Exception):
pass
class SchemaNotFound(FileNotFoundError):
"""
SchemaNotFound is raised when a given schema does not exist in the local file system.
"""
[docs]
class InvalidSpecification(Exception):
"""
InvalidSpecification is raised when a specification does not validate against the given schema.
"""
def __init__(self, ValidationError, schema=None):
self.exc_info = sys.exc_info()
self.parent = ValidationError
self.schema = schema
self.path = ''
for item in ValidationError.path:
if isinstance(item, int):
self.path += f'[{item}]'
else:
self.path += f'.{item}'
self.path = self.path.lstrip('.')
self.instance = ValidationError.instance
message = f"{ValidationError.message}.\n\tPath: {self.path}\n\tInstance: {self.instance} Schema: {self.schema}"
# Call the base class constructor with the parameters it needs
super().__init__(message)
class InvalidArchiveHost(Exception):
"""InvalidArchiveHost is raised when a given patchset archive url is not an approved host."""
class InvalidArchive(Exception):
"""InvalidArchive is raised when a given patchset archive url does not return a valid response."""
[docs]
class InvalidPatchSet(Exception):
"""InvalidPatchSet is raised when a given patchset object does not have the right configuration, even though it validates correctly against the schema."""
[docs]
class InvalidPatchLookup(Exception):
"""InvalidPatchLookup is raised when the patch lookup from a patchset object has failed"""
[docs]
class PatchSetVerificationError(Exception):
"""PatchSetVerificationError is raised when the workspace digest does not match the patchset digests as part of the verification procedure"""
[docs]
class InvalidWorkspaceOperation(Exception):
"""InvalidWorkspaceOperation is raised when an operation on a workspace fails."""
class UnspecifiedPOI(Exception):
"""
UnspecifiedPOI is raised when a given model does not have POI(s) defined but is used in contexts that need it.
This can occur when e.g. trying to calculate CLs on a POI-less model.
"""
[docs]
class InvalidModel(Exception):
"""
InvalidModel is raised when a given model does not have the right configuration, even though it validates correctly against the schema.
This can occur, for example, when the provided parameter of interest to fit against does not get declared in the specification provided.
"""
[docs]
class InvalidModifier(Exception):
"""
InvalidModifier is raised when an invalid modifier is requested. This includes:
- creating a custom modifier with the wrong structure
- initializing a modifier that does not exist, or has not been loaded
"""
[docs]
class InvalidInterpCode(Exception):
"""
InvalidInterpCode is raised when an invalid/unimplemented interpolation code is requested.
"""
class InvalidTestStatistic(Exception):
"""
InvalidTestStatistic is raised when an invalid/unimplemented test statistic is requested.
"""
[docs]
class ImportBackendError(Exception):
"""
MissingLibraries is raised when something is imported by sustained an import error due to missing additional, non-default libraries.
"""
[docs]
class InvalidBackend(Exception):
"""
InvalidBackend is raised when trying to set a backend that does not exist.
"""
[docs]
class InvalidOptimizer(Exception):
"""
InvalidOptimizer is raised when trying to set an optimizer that does not exist.
"""
[docs]
class InvalidPdfParameters(Exception):
"""
InvalidPdfParameters is raised when trying to evaluate a pdf with invalid parameters.
"""
[docs]
class InvalidPdfData(Exception):
"""
InvalidPdfData is raised when trying to evaluate a pdf with invalid data.
"""
class FailedMinimization(Exception):
"""
FailedMinimization is raised when a minimization did not succeed.
"""
def __init__(self, result):
self.result = result
message = getattr(
result, 'message', "Unknown failure. See fit result for more details."
)
super().__init__(message)
# Deprecated APIs
def _deprecated_api_warning(
deprecated_api, new_api, deprecated_release, remove_release
):
warn(
f"{deprecated_api} is deprecated in favor of {new_api} as of pyhf v{deprecated_release} and will be removed in pyhf v{remove_release}."
+ f" Please use {new_api}.",
DeprecationWarning,
stacklevel=3, # Raise to user level
)