Changeset 3288 for pykota/trunk/pykota

Timestamp:

01/11/08 19:08:24 (16 years ago)

Author:

jerome

Message:

Moved all exceptions definitions to a dedicated module.

Location:

pykota/trunk/pykota

Files:

• accounter.py (modified) (1 diff)
• accounters/hardware.py (modified) (1 diff)
• accounters/ink.py (modified) (2 diffs)
• accounters/software.py (modified) (1 diff)
• config.py (modified) (1 diff)
• cups.py (modified) (1 diff)
• dumper.py (modified) (1 diff)
• errors.py (copied) (copied from pykota/trunk/pykota/cups.py) (1 diff)
• logger.py (modified) (1 diff)
• reporter.py (modified) (1 diff)
• storage.py (modified) (1 diff)
• storages/ldapstorage.py (modified) (1 diff)
• storages/mysqlstorage.py (modified) (1 diff)
• storages/pgstorage.py (modified) (1 diff)
• storages/sqlitestorage.py (modified) (1 diff)
• tool.py (modified) (2 diffs)

pykota/trunk/pykota/accounter.py

@@ -27 +27 @@
 import imp
 
-class PyKotaAccounterError(Exception):
-    """An exception for Accounter related stuff."""
-    def __init__(self, message = ""):
-        self.message = message
-        Exception.__init__(self, message)
-    def __repr__(self):
-        return self.message
-    __str__ = __repr__
-    
+from pykota.errors import PyKotaAccounterError
+
 class AccounterBase :    
     """A class to account print usage by querying printers."""

pykota/trunk/pykota/accounters/hardware.py

@@ -25 +25 @@
 import popen2
 
-from pykota.accounter import AccounterBase, PyKotaAccounterError
+from pykota.errors import PyKotaAccounterError
+from pykota.accounter import AccounterBase
 from pykota.accounters import snmp, pjl
 

pykota/trunk/pykota/accounters/ink.py

@@ -21 +21 @@
 #
 
+"""This module handles ink accounting in PyKota."""
+
 import os
-from pykota.accounter import AccounterBase, PyKotaAccounterError
 
+from pykota.errors import PyKotaAccounterError
+from pykota.accounter import AccounterBase
 
 class Accounter(AccounterBase) :
@@ -50 +53 @@
         colorspace = colorspace.lower()
         if colorspace not in ("cmyk", "bw", "cmy", "rgb", "gc") :
-            raise PyKotaAccounterError, "Invalid parameters for ink accounter : [%s]" % self.arguments
+            raise PyKotaAccounterError, _("Invalid parameters for ink accounter : [%s]") % self.arguments
             
         try :    

pykota/trunk/pykota/accounters/software.py

@@ -21 +21 @@
 #
 
+"""This module handles software page counting for PyKota."""
+
 import os
 import popen2
-from pykota.accounter import AccounterBase, PyKotaAccounterError
+
+from pykota.errors import PyKotaAccounterError
+from pykota.accounter import AccounterBase
 
 class Accounter(AccounterBase) :

pykota/trunk/pykota/config.py

@@ -27 +27 @@
 import ConfigParser
 
-class PyKotaConfigError(Exception):
-    """An exception for PyKota config related stuff."""
-    def __init__(self, message = ""):
-        self.message = message
-        Exception.__init__(self, message)
-    def __repr__(self):
-        return self.message
-    __str__ = __repr__
-    
+from pykota.errors import PyKotaConfigError    
+
 class PyKotaConfig :
     """A class to deal with PyKota's configuration."""

pykota/trunk/pykota/cups.py

@@ -22 +22 @@
 """This module implements some CUPS specific classes."""
 
-from pykota.tool import PyKotaToolError
+from pykota.errors import PyKotaToolError
 try :
     from pkipplib import pkipplib

pykota/trunk/pykota/dumper.py

@@ -35 +35 @@
     sys.stderr.write("The jaxml Python module is not installed. XML output is disabled.\n")
     sys.stderr.write("Download jaxml from http://www.librelogiciel.com/software/ or from your Debian archive of choice\n")
-    hasJAXML = 0
+    hasJAXML = False
 else :    
-    hasJAXML = 1
+    hasJAXML = True
 
 from pykota import version
-from pykota.tool import PyKotaTool, PyKotaToolError, PyKotaCommandLineError, N_
+from pykota.tool import PyKotaTool, N_
+from pykota.errors import PyKotaToolError, PyKotaCommandLineError
 
 class DumPyKota(PyKotaTool) :        

pykota/trunk/pykota/errors.py

@@ -20 +20 @@
 #
 
-"""This module implements some CUPS specific classes."""
+"""This module defines ALL PyKota specific exceptions."""
 
-from pykota.tool import PyKotaToolError
-try :
-    from pkipplib import pkipplib
-except ImportError :        
-    raise RuntimeError, "The python-pkipplib module is now mandatory. You can download pkipplib from http://www.pykota.com/"
-
-class JobTicket :    
-    """A class to hold CUPS print job informations."""
-    def __init__(self, jobid=None, printername=None, copies=1, filename=None, \
-                       options=None) :
-        """Initializes a print job's information."""
-        self.JobId = jobid
-        self.PrinterName = printername
-        self.Copies = copies
-        self.FileName = filename
-        self.Options = options
-        self.Charset = None
-        self.OriginatingUserName = None
-        self.OriginalUserName = None
-        self.Title = None
-        self.BillingCode = None
-        self.OriginatingHostName = None
-        self.TimeAtCreation = None
-        self.TimeAtProcessing = None
-        self.MimeType = None
-        self.UUID = None
-        if self.JobId is not None :
-            self.retrieveAttributesFromCUPS()
+class PyKotaError(Exception) :
+    """Mother class of all PyKota exceptions."""
+    def __init__(self, value) :
+        """Saves the value passed as a parameter."""
+        self.value = value
         
-    def getAttributeTypeAndValue(self, ippanswer, attribute, category="job") :    
-        """Retrieves a particular attribute's type and value from an IPP answer.
+    def __str__(self) :    
+        """Returns an unicode string representation."""
+        try :
+            return unicode(self.value, errors="replace")
+        except TypeError :    
+            return unicode(self.value) # None and strings which are already unicode
         
-           Returns a tuple of the form (type, value).
-        """
-        try :
-            return getattr(ippanswer, category)[attribute][0]
-        except KeyError :    
-            return (None, None)
-            
-    def retrieveAttributesFromCUPS(self) :
-        """Retrieve attribute's values from CUPS."""
-        server = pkipplib.CUPS() # TODO : username and password and/or encryption
-        answer = server.getJobAttributes(self.JobId)
-        if answer is None :
-            raise PyKotaToolError, "Network error while querying the CUPS server : %s" \
-                                      % server.lastErrorMessage
-        (dummy, self.Charset) = self.getAttributeTypeAndValue(answer, "attributes-charset", "operation")
-        (dummy, self.OriginatingUserName) = self.getAttributeTypeAndValue(answer, "job-originating-user-name")
-        (dummy, self.Title) = self.getAttributeTypeAndValue(answer, "job-name")
-        (dummy, self.BillingCode) = self.getAttributeTypeAndValue(answer, "job-billing")
-        (dummy, self.OriginatingHostName) = self.getAttributeTypeAndValue(answer, "job-originating-host-name")
-        (dummy, self.UUID) = self.getAttributeTypeAndValue(answer, "job-uuid")
-        (dummy, self.TimeAtCreation) = self.getAttributeTypeAndValue(answer, "time-at-creation")
-        (dummy, self.TimeAtProcessing) = self.getAttributeTypeAndValue(answer, "time-at-processing")
-        (dummy, self.MimeType) = self.getAttributeTypeAndValue(answer, "document-format")
-        
-        for attrib in ("OriginatingUserName", 
-                       "OriginatingHostName",
-                       "Title", 
-                       "BillingCode",
-                       "PrinterName",
-                       "Options",
-                       "Charset",
-                       "UUID",
-                       "MimeType") :
-            try :           
-                setattr(self, attrib, 
-                              getattr(self, attrib).decode("UTF-8", "replace"))
-            except AttributeError :                  
-                pass
-                
-        self.OriginalUserName = self.OriginatingUserName[:]
+class PyKotaToolError(PyKotaError) :
+    """PyKota Exception for all executables."""
+    pass
     
-if __name__ == "__main__" :    
-    import sys
-    if len(sys.argv) != 2 :
-        sys.stderr.write("usage : python cups.py jobid\n")
-    else :    
-        job = JobTicket(int(sys.argv[1]), "FakePrinter")
-        for attribute in ("PrinterName", "Charset", "JobId", "Copies", 
-                          "FileName", "OriginatingUserName", 
-                          "Title", "BillingCode", "OriginatingHostName", 
-                          "TimeAtCreation", "TimeAtProcessing", "UUID", 
-                          "MimeType") :
-            sys.stdout.write("%s : %s\n" % (attribute, repr(getattr(job, attribute))))
+class PyKotaToolError(PyKotaError) :
+    """PyKota Exception for all executables."""
+    pass
+    
+class PyKotaCommandLineError(PyKotaToolError) :
+    """PyKota Exception for errors on executables' command line."""
+    pass
+    
+class PyKotaStorageError(PyKotaError) :
+    """PyKota Exception for database backend related errors."""
+    pass
+    
+class PyKotaConfigError(PyKotaError) :
+    """PyKota Exception for errors in PyKota's configuration."""
+    pass
+    
+class PyKotaAccounterError(PyKotaError) :
+    """PyKota Exception for errors in PyKota accounters."""
+    pass
+    
+class PyKotaReporterError(PyKotaError) :
+    """PyKota Exception for errors in PyKota report generators."""
+    pass
+    
+class PyKotaLoggingError(PyKotaError) :
+    """PyKota Exception for errors in PyKota logging."""
+    pass

pykota/trunk/pykota/logger.py

@@ -26 +26 @@
 import imp
 
-class PyKotaLoggingError(Exception):
-    """An exception for logging related stuff."""
-    def __init__(self, message = ""):
-        self.message = message
-        Exception.__init__(self, message)
-    def __repr__(self):
-        return self.message
-    __str__ = __repr__
+from pykota.errors import PyKotaLoggingError
 
 def openLogger(backend) :

pykota/trunk/pykota/reporter.py

@@ -27 +27 @@
 from mx import DateTime
 
-class PyKotaReporterError(Exception):
-    """An exception for Reporter related stuff."""
-    def __init__(self, message = ""):
-        self.message = message
-        Exception.__init__(self, message)
-    def __repr__(self):
-        return self.message
-    __str__ = __repr__
+from pykota.errors import PyKotaReporterError
     
 class BaseReporter :    

pykota/trunk/pykota/storage.py

@@ -27 +27 @@
 from mx import DateTime
 
-class PyKotaStorageError(Exception):
-    """An exception for database related stuff."""
-    def __init__(self, message = ""):
-        self.message = message
-        Exception.__init__(self, message)
-    def __repr__(self):
-        return self.message
-    __str__ = __repr__
-        
-        
+from pykota.errors import PyKotaStorageError
+
 class StorageObject :
     """Object present in the database."""

pykota/trunk/pykota/storages/ldapstorage.py

@@ -37 +37 @@
 from mx import DateTime
 
-from pykota.storage import PyKotaStorageError, BaseStorage, \
+from pykota.errors import PyKotaStorageError
+from pykota.storage import BaseStorage, \
                            StorageUser, StorageGroup, StoragePrinter, \
                            StorageJob, StorageLastJob, StorageUserPQuota, \

pykota/trunk/pykota/storages/mysqlstorage.py

@@ -25 +25 @@
 import time
 
-from pykota.storage import PyKotaStorageError, BaseStorage
+from pykota.errors import PyKotaStorageError
+from pykota.storage import BaseStorage
 from pykota.storages.sql import SQLStorage
 

pykota/trunk/pykota/storages/pgstorage.py

@@ -26 +26 @@
 from types import StringType
 
-from pykota.storage import PyKotaStorageError, BaseStorage
+from pykota.errors import PyKotaStorageError
+from pykota.storage import BaseStorage
 from pykota.storages.sql import SQLStorage
 

pykota/trunk/pykota/storages/sqlitestorage.py

@@ -25 +25 @@
 import time
 
-from pykota.storage import PyKotaStorageError, BaseStorage
+from pykota.errors import PyKotaStorageError
+from pykota.storage import BaseStorage
 from pykota.storages.sql import SQLStorage
 

pykota/trunk/pykota/tool.py

@@ -39 +39 @@
 from mx import DateTime
 
+from pykota.errors import PyKotaCommandLineError
 from pykota import config, storage, logger
 from pykota.version import __version__, __author__, __years__, __gplblurb__
@@ -46 +47 @@
     return message
 
-class PyKotaToolError(Exception):
-    """An exception for PyKota related stuff."""
-    def __init__(self, message = ""):
-        self.message = message
-        Exception.__init__(self, message)
-    def __repr__(self):
-        return self.message.encode(sys.stdout.encoding or "UTF-8", "replace")
-    __str__ = __repr__
-    
-class PyKotaCommandLineError(PyKotaToolError) :    
-    """An exception for Pykota command line tools."""
-    pass
-    
 def crashed(message="Bug in PyKota") :    
     """Minimal crash method."""