[gnue] r9802 - trunk/gnue-common/src/apps

[johannes]

Author: johannes
Date: 2007-11-14 03:57:51 -0600 (Wed, 14 Nov 2007)
New Revision: 9802

Modified:
   trunk/gnue-common/src/apps/errors.py
Log:
Start of PEP8-ification


Modified: trunk/gnue-common/src/apps/errors.py
===================================================================
--- trunk/gnue-common/src/apps/errors.py        2007-11-14 09:37:41 UTC (rev 
9801)
+++ trunk/gnue-common/src/apps/errors.py        2007-11-14 09:57:51 UTC (rev 
9802)
@@ -38,233 +38,236 @@
 # unicode messages.
 # =============================================================================
 
-class gException (Exception):
-  """
-  The same as the builtin python Exception, but can handle messages that are
-  unicode strings.  This exception is available as the builtin class
-  "gException".  All other user-defined exceptions should be derived from this
-  class.
+class gException(Exception):
+    """
+    The same as the builtin python Exception, but can handle messages that are
+    unicode strings.  This exception is available as the builtin class
+    "gException".  All other user-defined exceptions should be derived from
+    this class.
 
-  @ivar message: The error message.
-  @type message: Unicode
-  @ivar group: The group or category of the exception. Can be one of 'system',
-    'admin', 'application', or 'user'.
-  @ivar name: The name of the exception. If set, this will be returned by
-    L{getName} and L{getException} instead of the class name of the exception.
-  @ivar detail: The detail information to the exception. If set, this will be
-    returned by L{getDetail} and L{getException} instead of the traceback.
-  """
-  def __init__ (self, message, group = 'system'):
-    self.message = message
-    self.group   = group
-    self.name    = None
-    self.detail  = None
-    exceptions.Exception.__init__ (self, o(message))
+    @ivar message: The error message.
+    @type message: Unicode
+    @ivar group: The group or category of the exception. Can be one of 
'system',
+      'admin', 'application', or 'user'.
+    @ivar name: The name of the exception. If set, this will be returned by
+      L{getName} and L{getException} instead of the class name of the 
exception.
+    @ivar detail: The detail information to the exception. If set, this will be
+      returned by L{getDetail} and L{getException} instead of the traceback.
+    """
+    def __init__(self, message, group='system'):
+        self.message = message
+        self.group   = group
+        self.name    = None
+        self.detail  = None
+        exceptions.Exception.__init__(self, o(message))
 
-  # ---------------------------------------------------------------------------
-  # Get the type of the exception
-  # ---------------------------------------------------------------------------
 
-  def getGroup (self):
-    """
-    Return the group of the exception.
+    # -------------------------------------------------------------------------
+    # Get the type of the exception
+    # -------------------------------------------------------------------------
 
-    @return: Group of the exception, one of 'system', 'admin', 'application',
-      or 'user'.
-    """
-    return self.group
+    def getGroup(self):
+        """
+        Return the group of the exception.
 
+        @return: Group of the exception, one of 'system', 'admin',
+            'application', or 'user'.
+        """
+        return self.group
 
-  # ---------------------------------------------------------------------------
-  # Return the name of the exception
-  # ---------------------------------------------------------------------------
 
-  def getName (self, aType = None):
-    """
-    Return the exception's name, which is the classname of the exception class
-    unless overwritten with L{name}.
+    # -------------------------------------------------------------------------
+    # Return the name of the exception
+    # -------------------------------------------------------------------------
 
-    @return: Name of the exception.
-    @rtype: Unicode
-    """
-    rep = self.name or "%s" % (sys.exc_info () [0] or aType)
-    return self._fmtUnicode (rep.split ('.') [-1])
+    def getName(self, aType=None):
+        """
+        Return the exception's name, which is the classname of the exception
+        class unless overwritten with L{name}.
 
+        @return: Name of the exception.
+        @rtype: Unicode
+        """
+        rep = self.name or "%s" % (sys.exc_info()[0] or aType)
+        return self._fmtUnicode(rep.split('.')[-1])
 
-  # ---------------------------------------------------------------------------
-  # Get the detail of an exception
-  # ---------------------------------------------------------------------------
 
-  def getDetail (self, count = None, type = None, value = None, trace = None):
-    """
-    Return the exception's detail, which is the traceback unless overwritten
-    with L{detail}.
+    # -------------------------------------------------------------------------
+    # Get the detail of an exception
+    # -------------------------------------------------------------------------
 
-    Optionally, a number of lines can be skipped at the beginning of the
-    traceback (if the detail I{is} the traceback).
+    def getDetail(self, count=None, type=None, value=None, trace=None):
+        """
+        Return the exception's detail, which is the traceback unless
+        overwritten with L{detail}.
 
-    @param count: Number of lines to skip at the beginning of the traceback.
-    @return: Detail information for the exception.
-    @rtype: Unicode
-    """
-    if self.detail is not None:
-      return self._fmtUnicode (self.detail, i18n.get_encoding ())
+        Optionally, a number of lines can be skipped at the beginning of the
+        traceback (if the detail I{is} the traceback).
 
-    if sys.exc_info () == (None, None, None):
-      tStack = traceback.format_exception (type, value, trace)
-    else:
-      tStack = traceback.format_exception (*sys.exc_info ())
-    if count is not None:
-      del tStack [1:count + 1]
-    return self._fmtUnicode ("%s" % string.join (tStack), i18n.get_encoding ())
+        @param count: Number of lines to skip at the beginning of the 
traceback.
+        @return: Detail information for the exception.
+        @rtype: Unicode
+        """
+        if self.detail is not None:
+            return self._fmtUnicode(self.detail, i18n.get_encoding())
 
+        if sys.exc_info() == (None, None, None):
+            tStack = traceback.format_exception(type, value, trace)
+        else:
+            tStack = traceback.format_exception(*sys.exc_info())
 
-  # ---------------------------------------------------------------------------
-  # Get the message of an exception
-  # ---------------------------------------------------------------------------
+        if count is not None:
+            del tStack[1:count + 1]
 
-  def getMessage (self):
-    """
-    Return the message of an exception.
-    @return: Message of the exception.
-    @rtype: Unicode
-    """
-    return self._fmtUnicode (self.message)
+        return self._fmtUnicode("%s" % string.join(tStack), 
i18n.get_encoding())
 
 
-  # ---------------------------------------------------------------------------
-  # Make sure a given text is a unicode string
-  # ---------------------------------------------------------------------------
+    # -------------------------------------------------------------------------
+    # Get the message of an exception
+    # -------------------------------------------------------------------------
 
-  def _fmtUnicode (self, text, encoding = None):
-    """
-    Return a given text as unicode string using an optional encoding or the
-    system's default encoding.
+    def getMessage(self):
+        """
+        Return the message of an exception.
+        @return: Message of the exception.
+        @rtype: Unicode
+        """
+        return self._fmtUnicode(self.message)
 
-    @param text: String to be encoded. If this string is already unicode no
-      modification will take place.
-    @param encoding: Encoding to use (if None, system default encoding will
-      take place)
-    @return: Unicode representation of the text parameter.
-    """
-    if isinstance (text, types.UnicodeType):
-      return text
-    else:
-      if encoding is not None:
-        return unicode (text, encoding, 'replace')
-      else:
-        return unicode (text, errors = 'replace')
 
+    # -------------------------------------------------------------------------
+    # Make sure a given text is a unicode string
+    # -------------------------------------------------------------------------
 
+    def _fmtUnicode(self, text, encoding=None):
+        """
+        Return a given text as unicode string using an optional encoding or the
+        system's default encoding.
+
+        @param text: String to be encoded. If this string is already unicode no
+          modification will take place.
+        @param encoding: Encoding to use (if None, system default encoding will
+          take place)
+        @return: Unicode representation of the text parameter.
+        """
+        if isinstance(text, types.UnicodeType):
+            return text
+        else:
+            if encoding is not None:
+                return unicode(text, encoding, 'replace')
+            else:
+                return unicode(text, errors='replace')
+
+
 # =============================================================================
 # System Error
 # =============================================================================
 
-class SystemError (gException):
-  """
-  This exception class should be used for exceptions indicating a bug in GNUe.
-  Whenever such an exception is raised, one have found such a bug :)
-  """
-  def __init__ (self, message):
-    gException.__init__ (self, message, 'system')
+class SystemError(gException):
+    """
+    This exception class should be used for exceptions indicating a bug in
+    GNUe.  Whenever such an exception is raised, one have found such a bug :)
+    """
+    def __init__(self, message):
+        gException.__init__(self, message, 'system')
 
 
 # =============================================================================
 # Administrative Errors
 # =============================================================================
 
-class AdminError (gException):
-  """
-  This exception class should be used for exceptions indicating a
-  misconfiguration in a widest sense. This could be a missing module for a
-  dbdriver as well as an 'out of disk space' error.
-  """
-  def __init__ (self, message):
-    gException.__init__ (self, message, 'admin')
+class AdminError(gException):
+    """
+    This exception class should be used for exceptions indicating a
+    misconfiguration in a widest sense. This could be a missing module for a
+    dbdriver as well as an 'out of disk space' error.
+    """
+    def __init__(self, message):
+        gException.__init__(self, message, 'admin')
 
 
 # =============================================================================
 # Application Errors
 # =============================================================================
 
-class ApplicationError (gException):
-  """
-  This class should be used for errors caused by applications like a corrupt
-  trigger code, or a misformed xml-file and so on.
-  """
-  def __init__ (self, message):
-    gException.__init__ (self, message, 'application')
+class ApplicationError(gException):
+    """
+    This class should be used for errors caused by applications like a corrupt
+    trigger code, or a misformed xml-file and so on.
+    """
+    def __init__(self, message):
+        gException.__init__(self, message, 'application')
 
 
 # =============================================================================
 # User Errors
 # =============================================================================
 
-class UserError (gException):
-  """
-  This class should be used for exceptions where a user did something wrong, or
-  a situation has occured which isn't dramatic, but the user has to be informed
-  of. Example: wrong password or the user has entered non-numeric data into a
-  numeric field, and so on.
-  """
-  def __init__ (self, message):
-    gException.__init__ (self, message, 'user')
+class UserError(gException):
+    """
+    This class should be used for exceptions where a user did something wrong,
+    or a situation has occured which isn't dramatic, but the user has to be
+    informed of. Example: wrong password or the user has entered non-numeric
+    data into a numeric field, and so on.
+    """
+    def __init__(self, message):
+        gException.__init__(self, message, 'user')
 
 
 # =============================================================================
 # Exceptions raised on a remote site/process
 # =============================================================================
 
-class RemoteError (gException):
-  """
-  This class is used for transporting an exception raised at a remote point.
-  Once it has been created it never changes it's contents. A remote error
-  usually contains System-, Admin- or User-Errors.
-  """
-  def __init__ (self, group, name, message, detail):
-    gException.__init__ (self, message)
-    self.group  = group
-    self.name   = name
-    self.detail = detail
+class RemoteError(gException):
+    """
+    This class is used for transporting an exception raised at a remote point.
+    Once it has been created it never changes it's contents. A remote error
+    usually contains System-, Admin- or User-Errors.
+    """
+    def __init__(self, group, name, message, detail):
+        gException.__init__(self, message)
+        self.group  = group
+        self.name   = name
+        self.detail = detail
 
 
 # -----------------------------------------------------------------------------
 # Get a tuple (type, name, message, detail) for the last exception raised
 # -----------------------------------------------------------------------------
 
-def getException (count = None, aType = None, aValue = None, aTrace = None):
-  """
-  Return textual information about an exception.
+def getException(count=None, aType=None, aValue=None, aTrace=None):
+    """
+    Return textual information about an exception.
 
-  This function creates a tuple (group, name, message, detail) for the last
-  exception raised. The optional parameter determines the number of lines
-  skipped from the detail traceback.
+    This function creates a tuple (group, name, message, detail) for the last
+    exception raised. The optional parameter determines the number of lines
+    skipped from the detail traceback.
 
-  The intended use of this function is to get the text to be displayed in error
-  messages.
+    The intended use of this function is to get the text to be displayed in
+    error messages.
 
-  @param count: number of lines to skip in the traceback
-  @return: tuple with group, name, message and detail of the last exception.
-  """
-  (sType, sValue, sTrace) = sys.exc_info ()
-  aType  = aType  or sType
-  aValue = aValue or sValue
-  aTrace = aTrace or sTrace
+    @param count: number of lines to skip in the traceback
+    @return: tuple with group, name, message and detail of the last exception.
+    """
+    (sType, sValue, sTrace) = sys.exc_info()
+    aType  = aType  or sType
+    aValue = aValue or sValue
+    aTrace = aTrace or sTrace
 
-  if isinstance (aValue, gException):
-    return (aValue.getGroup (), aValue.getName (aType), aValue.getMessage (),
-            aValue.getDetail (count, aType, aValue, aTrace))
-  else:
-    # Exception was not a descendant of gException, so we construct the tuple
-    # from the exception information
-    lines = traceback.format_exception (aType, aValue, aTrace)
-    if count is not None:
-      del lines [1:count + 1]
+    if isinstance(aValue, gException):
+        return (aValue.getGroup(), aValue.getName(aType), aValue.getMessage(),
+                aValue.getDetail(count, aType, aValue, aTrace))
+    else:
+        # Exception was not a descendant of gException, so we construct the
+        # tuple from the exception information
+        lines = traceback.format_exception(aType, aValue, aTrace)
+        if count is not None:
+            del lines[1:count + 1]
 
-    name = unicode ("%s" % aType, i18n.get_encoding (), 'replace')
-    name = name.split ('.') [-1]
-    message = unicode ("%s" % aValue, i18n.get_encoding (), 'replace')
-    detail  = string.join (lines)
-    if isinstance (detail, types.StringType):
-      detail = unicode (detail, i18n.get_encoding (), 'replace')
-    return ('system', name, message, detail)
+        name = unicode("%s" % aType, i18n.get_encoding(), 'replace')
+        name = name.split('.')[-1]
+        message = unicode("%s" % aValue, i18n.get_encoding(), 'replace')
+        detail  = string.join(lines)
+        if isinstance(detail, types.StringType):
+            detail = unicode(detail, i18n.get_encoding(), 'replace')
+        return ('system', name, message, detail)