issue2551083 Replace BaseException and Exception with RoundupException

issue2551083 - Replace BaseException and Exception as base classes
with new RoundupException (inheriting from Exception) for most roundup
exceptions.

Author: rouilj

CHANGES.txt

@@ -62,6 +62,10 @@ Features:
   (Christof Meerwald)
 - Allow filtering by multiple date ranges or empty date. Date ranges are
   separated by comma, an empty date is represented by '-'
+- issue2551083 - Replace BaseException and Exception as base classes
+  with new RoundupException (inheriting from Exception) for most
+  roundup exceptions. (John Rouillard and Ralf Schlatterbeck on
+  request from Robert Klonner.)
 
 Fixed:
 

roundup/cgi/exceptions.py

@@ -7,8 +7,12 @@
 
 from roundup.anypy.html import html_escape
 
+from roundup.exceptions import RoundupException
 
-class HTTPException(BaseException):
+class RoundupCGIException(RoundupException):
+    pass
+
+class HTTPException(RoundupCGIException):
     pass
 
 
@@ -28,7 +32,7 @@ class PreconditionFailed(HTTPException):
     pass
 
 
-class DetectorError(BaseException):
+class DetectorError(RoundupException):
     """Raised when a detector throws an exception.
 Contains details of the exception."""
     def __init__(self, subject, html, txt):
@@ -51,15 +55,15 @@ class FormError(ValueError):
     pass
 
 
-class SendFile(BaseException):
+class SendFile(RoundupException):
     """Send a file from the database."""
 
 
-class SendStaticFile(BaseException):
+class SendStaticFile(RoundupException):
     """Send a static file from the instance html directory."""
 
 
-class SeriousError(BaseException):
+class SeriousError(RoundupException):
     """Raised when we can't reasonably display an error message on a
     templated page.
 

roundup/cgi/templating.py

@@ -167,10 +167,10 @@ def anti_csrf_nonce(client, lifetime=None):
 
 ### templating
 
-class NoTemplate(BaseException):
+class NoTemplate(RoundupException):
     pass
 
-class Unauthorised(BaseException):
+class Unauthorised(RoundupException):
     def __init__(self, action, klass, translator=None):
         self.action = action
         self.klass = klass

roundup/configuration.py

@@ -29,12 +29,14 @@
 else:
     import ConfigParser as configparser  # Python 2
 
+from exceptions import RoundupException
+
 # XXX i don't think this module needs string translation, does it?
 
 ### Exceptions
 
 
-class ConfigurationError(BaseException):
+class ConfigurationError(RoundupException):
     pass
 
 

roundup/exceptions.py

@@ -4,15 +4,20 @@
 __docformat__ = 'restructuredtext'
 
 
-class LoginError(BaseException):
+class RoundupException(Exception):
+    pass
+
+class LoginError(RoundupException):
     pass
 
 
-class Unauthorised(BaseException):
+class Unauthorised(RoundupException):
     pass
 
+class RejectBase(RoundupException):
+    pass
 
-class Reject(BaseException):
+class Reject(RejectBase):
     """An auditor may raise this exception when the current create or set
     operation should be stopped.
 

roundup/instance.py

@@ -46,6 +46,7 @@
 from roundup import hyperdb, backends, actions
 from roundup.cgi import client, templating
 from roundup.cgi import actions as cgi_actions
+from roundup.exceptions import RoundupException
 
 
 class Tracker:
@@ -271,7 +272,7 @@ def registerUtil(self, name, function):
         self.templating_utils[name] = function
 
 
-class TrackerError(BaseException):
+class TrackerError(RoundupException):
     pass
 
 

roundup/mailgw.py

@@ -118,6 +118,8 @@ class node. Any parts of other types are each stored in separate files
 except ImportError:
     gpg = None
 
+from exceptions import RoundupException
+
 SENDMAILDEBUG = os.environ.get('SENDMAILDEBUG', '')
 
 
@@ -129,17 +131,17 @@ class MailUsageError(ValueError):
     pass
 
 
-class MailUsageHelp(BaseException):
+class MailUsageHelp(RoundupException):
     """ We need to send the help message to the user. """
     pass
 
 
-class Unauthorized(BaseException):
+class Unauthorized(RoundupException):
     """ Access denied """
     pass
 
 
-class IgnoreMessage(BaseException):
+class IgnoreMessage(RoundupException):
     """ A general class of message that we should ignore. """
     pass