Changeset 3184 for pykota

Show
Ignore:
Timestamp:
05/30/07 22:29:50 (17 years ago)
Author:
jerome
Message:

Added some docstrings.

Location:
pykota/trunk/pykota
Files:
16 modified

Legend:

Unmodified
Added
Removed
  • pykota/trunk/pykota/accounter.py

    r3133 r3184  
    2222# 
    2323# 
     24 
     25"""This module defines base classes used by all accounting methods.""" 
    2426 
    2527import sys 
  • pykota/trunk/pykota/cgifuncs.py

    r3133 r3184  
    2020# 
    2121 
     22"""This module defines some helper functions to use in CGI scripts.""" 
     23 
    2224import sys 
    2325import os 
  • pykota/trunk/pykota/config.py

    r3180 r3184  
    2222# 
    2323# 
     24 
     25"""This module defines classes used to parse PyKota configuration files.""" 
    2426 
    2527import os 
  • pykota/trunk/pykota/dumper.py

    r3166 r3184  
    2121# 
    2222# 
     23 
     24"""This module handles all the data dumping facilities for PyKota.""" 
    2325 
    2426import sys 
  • pykota/trunk/pykota/ipp.py

    r3133 r3184  
    2424# 
    2525# 
     26 
     27"""This module provides basic IPP request parsing facilities.""" 
    2628 
    2729import sys 
  • pykota/trunk/pykota/logger.py

    r3133 r3184  
    2323# 
    2424 
     25"""This module defines base classes used by all logging backends.""" 
     26 
    2527import os 
    2628import imp 
  • pykota/trunk/pykota/reporter.py

    r3133 r3184  
    2323# 
    2424 
     25"""This module defines bases classes used by all reporters.""" 
     26 
    2527import os 
    2628import imp 
     
    4648         
    4749    def getPrinterTitle(self, printer) :      
     50        """Returns the formatted title for a given printer.""" 
    4851        return (_("Report for %s quota on printer %s") % ((self.isgroup and "group") or "user", printer.Name)) + (" (%s)" % printer.Description) 
    4952         
    5053    def getPrinterGraceDelay(self, printer) :     
     54        """Returns the formatted grace delay for a given printer.""" 
    5155        return _("Pages grace time: %i days") % self.tool.config.getGraceDelay(printer.Name) 
    5256         
    5357    def getPrinterPrices(self, printer) :     
     58        """Returns the formatted prices for a given printer.""" 
    5459        return (_("Price per job: %.3f") % (printer.PricePerJob or 0.0), _("Price per page: %.3f") % (printer.PricePerPage or 0.0)) 
    5560             
    5661    def getReportHeader(self) :         
     62        """Returns the correct header depending on users vs users groups.""" 
    5763        if self.isgroup : 
    5864            return _("Group          overcharge   used    soft    hard    balance grace         total       paid warn") 
     
    6167             
    6268    def getPrinterRealPageCounter(self, printer) :         
     69        """Returns the formatted real page counter for a given printer.""" 
    6370        msg = _("unknown") 
    6471        if printer.LastJob.Exists : 
     
    7077                 
    7178    def getTotals(self, total, totalmoney) :             
     79        """Returns the formatted totals.""" 
    7280        return (_("Total : %9i") % (total or 0.0), ("%11s" % ("%7.2f" % (totalmoney or 0.0))[:11])) 
    7381             
  • pykota/trunk/pykota/reporters/html.py

    r3133 r3184  
    2222# 
    2323# 
     24 
     25"""This module defines a class for HTML reporting.""" 
    2426 
    2527import os 
  • pykota/trunk/pykota/reporters/text.py

    r3133 r3184  
    2222# 
    2323# 
     24 
     25"""This module defines a class for plain text reporting.""" 
    2426 
    2527from pykota.reporter import BaseReporter 
  • pykota/trunk/pykota/storages/ldapstorage.py

    r3168 r3184  
    2323# 
    2424 
    25 # 
    26 # My IANA assigned number, for  
    27 # "Conseil Internet & Logiciels Libres, J�me Alet"  
    28 # is 16868. Use this as a base to create the LDAP schema. 
    29 # 
     25"""This module defines a class to access to an LDAP database backend. 
     26 
     27My IANA assigned number, for  
     28"Conseil Internet & Logiciels Libres, J�me Alet"  
     29is 16868. Use this as a base to extend the LDAP schema. 
     30""" 
    3031 
    3132import sys 
  • pykota/trunk/pykota/storages/mysqlstorage.py

    r3183 r3184  
    2323# 
    2424# 
     25 
     26"""This module defines a class to access to a MySQL database backend.""" 
    2527 
    2628import time 
  • pykota/trunk/pykota/storages/pgstorage.py

    r3182 r3184  
    2222# 
    2323# 
     24 
     25"""This module defines a class to access to a PostgreSQL database backend.""" 
    2426 
    2527import time 
  • pykota/trunk/pykota/storages/sqlitestorage.py

    r3183 r3184  
    2222# 
    2323# 
     24 
     25"""This module defines a class to access to a SQLite database backend.""" 
    2426 
    2527import time 
  • pykota/trunk/pykota/storages/sql.py

    r3165 r3184  
    2222# 
    2323# 
     24 
     25"""This module defines methods common to all relational backends.""" 
    2426 
    2527from pykota.storage import StorageUser, StorageGroup, StoragePrinter, \ 
  • pykota/trunk/pykota/tool.py

    r3173 r3184  
    2222# 
    2323# 
     24 
     25"""This module defines the base classes for PyKota command line tools.""" 
    2426 
    2527import sys 
  • pykota/trunk/pykota/version.py

    r3181 r3184  
    2222# 
    2323 
     24"""This module defines some application level constants.""" 
     25 
    2426__version__ = "1.26alpha6_unofficial" 
    2527