Source code for schrodinger.application.jaguar.exceptions

"""
Some custom Jaguar exception classes
"""


class JaguarUserFacingException(Exception):
    """
    Base class for custom Jaguar exceptions. See JAGUAR-7506.

    The idea is to distinguish exceptions which are intended to be user-facing
    from those that are not.  The former include "expected" exceptions such as
    those arising from user error (e.g. invalid input file keywords) or
    issues unrelated to errors in the Jaguar code (such as disk space exceeded,
    file permissions invalid etc).  In these cases, a clear and informative
    message should be printed in the user-facing output files about the specific
    error encountered.  In many cases, a user can use this information to try
    to fix the issue and rerun the job.

    In contrast, exceptions arising from developer or coding errors, including
    all built-in exceptions, should NOT be specifically output in the user-facing
    files.  Such messages will typically be technical in nature, not useful,
    and potentially confusing to a user.  Instead, the exception should be
    suppressed, and a generic error message printed informing the user something
    went wrong and how they can report it or get help from us.

    Finally, there should never be any tracebacks printed in the
    user-facing files.  This is implemented using the mmshare global exception
    handler from cmdline utils, independently of the exception type.
    """


class JaguarRuntimeError(JaguarUserFacingException):
    pass


class JaguarIOError(JaguarUserFacingException):
    pass


class JaguarUnsupportedBasisSet(JaguarUserFacingException):
    """
    Unsupported basis set
    """
    pass


class xTBFailure(JaguarUserFacingException):
    pass