Changeset 3184

Timestamp:

05/30/07 22:29:50 (17 years ago)

Author:

jerome

Message:

Added some docstrings.

Location:

pykota/trunk/pykota

Files:

• accounter.py (modified) (1 diff)
• cgifuncs.py (modified) (1 diff)
• config.py (modified) (1 diff)
• dumper.py (modified) (1 diff)
• ipp.py (modified) (1 diff)
• logger.py (modified) (1 diff)
• reporter.py (modified) (4 diffs)
• reporters/html.py (modified) (1 diff)
• reporters/text.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)
• storages/sql.py (modified) (1 diff)
• tool.py (modified) (1 diff)
• version.py (modified) (1 diff)

pykota/trunk/pykota/accounter.py

@@ -22 +22 @@
 #
 #
+
+"""This module defines base classes used by all accounting methods."""
 
 import sys

pykota/trunk/pykota/cgifuncs.py

@@ -20 +20 @@
 #
 
+"""This module defines some helper functions to use in CGI scripts."""
+
 import sys
 import os

pykota/trunk/pykota/config.py

@@ -22 +22 @@
 #
 #
+
+"""This module defines classes used to parse PyKota configuration files."""
 
 import os

pykota/trunk/pykota/dumper.py

@@ -21 +21 @@
 #
 #
+
+"""This module handles all the data dumping facilities for PyKota."""
 
 import sys

pykota/trunk/pykota/ipp.py

@@ -24 +24 @@
 #
 #
+
+"""This module provides basic IPP request parsing facilities."""
 
 import sys

pykota/trunk/pykota/logger.py

@@ -23 +23 @@
 #
 
+"""This module defines base classes used by all logging backends."""
+
 import os
 import imp

pykota/trunk/pykota/reporter.py

@@ -23 +23 @@
 #
 
+"""This module defines bases classes used by all reporters."""
+
 import os
 import imp
@@ -46 +48 @@
         
     def getPrinterTitle(self, printer) :     
+        """Returns the formatted title for a given printer."""
         return (_("Report for %s quota on printer %s") % ((self.isgroup and "group") or "user", printer.Name)) + (" (%s)" % printer.Description)
         
     def getPrinterGraceDelay(self, printer) :    
+        """Returns the formatted grace delay for a given printer."""
         return _("Pages grace time: %i days") % self.tool.config.getGraceDelay(printer.Name)
         
     def getPrinterPrices(self, printer) :    
+        """Returns the formatted prices for a given printer."""
         return (_("Price per job: %.3f") % (printer.PricePerJob or 0.0), _("Price per page: %.3f") % (printer.PricePerPage or 0.0))
             
     def getReportHeader(self) :        
+        """Returns the correct header depending on users vs users groups."""
         if self.isgroup :
             return _("Group          overcharge   used    soft    hard    balance grace         total       paid warn")
@@ -61 +67 @@
             
     def getPrinterRealPageCounter(self, printer) :        
+        """Returns the formatted real page counter for a given printer."""
         msg = _("unknown")
         if printer.LastJob.Exists :
@@ -70 +77 @@
                 
     def getTotals(self, total, totalmoney) :            
+        """Returns the formatted totals."""
         return (_("Total : %9i") % (total or 0.0), ("%11s" % ("%7.2f" % (totalmoney or 0.0))[:11]))
             

pykota/trunk/pykota/reporters/html.py

@@ -22 +22 @@
 #
 #
+
+"""This module defines a class for HTML reporting."""
 
 import os

pykota/trunk/pykota/reporters/text.py

@@ -22 +22 @@
 #
 #
+
+"""This module defines a class for plain text reporting."""
 
 from pykota.reporter import BaseReporter

pykota/trunk/pykota/storages/ldapstorage.py

@@ -23 +23 @@
 #
 
-#
-# My IANA assigned number, for 
-# "Conseil Internet & Logiciels Libres, J�me Alet" 
-# is 16868. Use this as a base to create the LDAP schema.
-#
+"""This module defines a class to access to an LDAP database backend.
+
+My IANA assigned number, for 
+"Conseil Internet & Logiciels Libres, J�me Alet" 
+is 16868. Use this as a base to extend the LDAP schema.
+"""
 
 import sys

pykota/trunk/pykota/storages/mysqlstorage.py

@@ -23 +23 @@
 #
 #
+
+"""This module defines a class to access to a MySQL database backend."""
 
 import time

pykota/trunk/pykota/storages/pgstorage.py

@@ -22 +22 @@
 #
 #
+
+"""This module defines a class to access to a PostgreSQL database backend."""
 
 import time

pykota/trunk/pykota/storages/sqlitestorage.py

@@ -22 +22 @@
 #
 #
+
+"""This module defines a class to access to a SQLite database backend."""
 
 import time

pykota/trunk/pykota/storages/sql.py

@@ -22 +22 @@
 #
 #
+
+"""This module defines methods common to all relational backends."""
 
 from pykota.storage import StorageUser, StorageGroup, StoragePrinter, \

pykota/trunk/pykota/tool.py

@@ -22 +22 @@
 #
 #
+
+"""This module defines the base classes for PyKota command line tools."""
 
 import sys

pykota/trunk/pykota/version.py

@@ -22 +22 @@
 #
 
+"""This module defines some application level constants."""
+
 __version__ = "1.26alpha6_unofficial"