In This Package:

csv_tools.py

Go to the documentation of this file.

"""
This funtionality is typically invoked from classmethods on DybDbi Row classes, eg::

   from DybDbi import GCalibPmtSpec
   GCalibPmtSpec.check( "$DBWRITERROOT/share/DYB_MC_AD1.txt", afterPulse="AfterPulseProb", sigmaSpe="SigmaSpeHigh", prePulse="PrePulseProb", description="Describ" )
   GCalibPmtSpec.import( "$DBWRITERROOT/share/DYB_MC_AD1.txt", afterPulse="AfterPulseProb", sigmaSpe="SigmaSpeHigh", prePulse="PrePulseProb", description="Describ" )
   GCalibPmtSpec.export( "$HOME/DYB_MC_AD1.txt" )

Implemented
~~~~~~~~~~~~

#. mapping csv field name to DBI attribute name 
#. writing in DB 

Todo 
~~~~~

#. many checks are missing 
#. inputing context info (for import) including MC/Data starttime task ...
#. command line client : OptionParserized 
#. investigate logcomments ... could automate dybsvn traclink@rev to the source csv ?

"""
import os,sys,csv
from mapper import Mapper
from csvrw import CSV

from DybDbi import ContextRange, Site, SimFlag, TimeStamp, DetectorId


def csv_check( cls, path, **kwargs ):
    """
    Check the validity of CSV file and correspondence with CSV fields and DBI attributes:: 

         from DybDbi import GCalibPmtSpec
         GCalibPmtSpec.csv_check( "$DBWRITERROOT/share/DYB_%s_AD1.txt" % "SAB", afterPulse="AfterPulseProb", sigmaSpe="SigmaSpeHigh", prePulse="PrePulseProb", description="Describ" ) 

    Manual mapping is required if field names do not match DBI attribute names
    (primitive case insensitive auto mapping is applied to avoid the need for tedious full mapping). 

    """
    csv_ = CSV( path, **kwargs )
    csv_.read()
    csv_.smry()
    if csv_.is_valid():
        print "csv is valid "
    else:
        print "csv is NOT valid "


def csv_compare( cls, path, **kwargs  ):
    """
    compare entries in CSV file with those found in DB 
    """
    csv_ = CSV( path, **kwargs )
    csv_.read() 


def csv_import( cls, path, **kwargs  ):
    """
    Import CSV file into Database 
    Using default writer context for now


    ContextRange::ContextRange(const int siteMask, const int simMask, const TimeStamp& tstart, const TimeStamp& tend)

ql> select * from CalibPmtSpecVld ;
+-------+---------------------+---------------------+----------+---------+---------+------+-------------+---------------------+---------------------+
| SEQNO | TIMESTART           | TIMEEND             | SITEMASK | SIMMASK | SUBSITE | TASK | AGGREGATENO | VERSIONDATE         | INSERTDATE          |
+-------+---------------------+---------------------+----------+---------+---------+------+-------------+---------------------+---------------------+
|    26 | 2011-01-22 08:15:17 | 2020-12-30 16:00:00 |      127 |       1 |       0 |    0 |          -1 | 2011-01-22 08:15:17 | 2011-02-25 08:10:15 | 
|    18 | 2010-06-21 07:49:24 | 2038-01-19 03:14:07 |       32 |       1 |       1 |    0 |          -1 | 2010-06-21 15:50:24 | 2010-07-19 12:49:29 | 
    


    HMM... Better to make this a classmethod on the writer rather than the Row class...
    OR do not shrinkwrap .. just leave as example
 
    """
    src = CSV( path, **kwargs )
    src.read()    ## exceptions are raised when invalid 
    
    mpr = Mapper( cls, src.fieldnames , **kwargs )

    wrt = cls.Wrt()
    cr = ContextRange( Site.kAll,  SimFlag.kData|SimFlag.kMC , TimeStamp.GetBOT() ,TimeStamp.GetEOT())
    wrt.ctx( contextrange=cr , dbno=0, versiondate=TimeStamp(0,0), subsite=0 , task=7, logcomment="DybDbi demo write" )

    for r in map(mpr,src):
        instance = cls.Create( **r )
        wrt.Write( instance )

    print wrt.Close()   


    
def csv_export( cls, path, **kwargs ):
    """
    Export the result of a default context DBI query as a CSV file 

    :param path: path of output file
    :param fieldnames:  optionally specifiy the field order with a list of fieldnames 

    .. note:: make the output more human readable with regular column widths

    """

    csv_ = CSV( path, **kwargs )




if __name__ == '__main__':

    from DybDbi import GCalibPmtSpec 
    #path = "$DBWRITERROOT/share/DYB_SAB_AD1.txt"
    path = "$DBWRITERROOT/share/DYB_MC_AD1.txt"
    #csv_check(GCalibPmtSpec, path , afterPulse="AfterPulseProb", sigmaSpe="SigmaSpeHigh", prePulse="PrePulseProb", description="Describ" )
    csv_import(GCalibPmtSpec, path , afterPulse="AfterPulseProb", sigmaSpe="SigmaSpeHigh", prePulse="PrePulseProb", description="Describ" )
   

---