view roundup/exceptions.py @ 7076:d3d20e145cea

bug: cleaner error message on OptionUnsetError in initialize We got a scary traceback when a: roundup.configuration.OptionUnsetError exception was raised during tracker.init(). Capture the exception and raise a UsageError that is printed more cleanly. It now reads: Error: In tracker/config.ini - MAIL_DOMAIN is not set and has no default
author John Rouillard <rouilj@ieee.org>
date Thu, 24 Nov 2022 20:57:17 -0500
parents c177e7128dc9
children e16b7d47fdb2
line wrap: on
line source

"""Exceptions for use across all Roundup components.
"""

__docformat__ = 'restructuredtext'


class RoundupException(Exception):
    pass

class LoginError(RoundupException):
    pass


class Unauthorised(RoundupException):
    pass

class RejectBase(RoundupException):
    pass

class Reject(RejectBase):
    """An auditor may raise this exception when the current create or set
    operation should be stopped.

    It is up to the specific interface invoking the create or set to
    handle this exception sanely. For example:

    - mailgw will trap and ignore Reject for file attachments and messages
    - cgi will trap and present the exception in a nice format
    """
    pass


class RejectRaw(Reject):
    """
    Performs the same function as Reject, except HTML in the message is not
    escaped when displayed to the user.
    """
    pass


class UsageError(ValueError):
    pass

# vim: set filetype=python ts=4 sw=4 et si

Roundup Issue Tracker: http://roundup-tracker.org/