view roundup/exceptions.py @ 5636:528b902f98fc

Make pretty print mode the default. Turn off using pretty=false. This makes use by humans (e.g. in browser) or printing when debugging easier. With gzip and other compression the extra whitespace is not a major issue. Idea from: https://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#pretty-print-gzip
author John Rouillard <rouilj@ieee.org>
date Thu, 07 Mar 2019 18:08:32 -0500
parents 32f95ec6bd8e
children 292c9dfd06bd
line wrap: on
line source

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

__docformat__ = 'restructuredtext'

class LoginError(BaseException):
    pass

class Unauthorised(BaseException):
    pass

class Reject(BaseException):
    """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/