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

Added some docstrings.

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • 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