CommonUtil Namespace Reference

Functions
def	count_dups (l)
def	findInList (mylist, element)
def	flatten (obj)
def	guessUnit (inverseubval)
def	inclusiveRange (start, stop, step)
def	is_floatstr (s)
def	is_intstr (s)
def	lumiUnitForPrint (t)
def	pack (high, low)
def	packArraytoBlob (iarray)
def	packListstrtoCLOB (iListstr, separator=')
def	packToString (high, low)
def	pairwise (lst)
def	parselumicorrector (correctorStr)
def	parseTime (iTime)
def	splitlistToRangeString (inPut)
def	timeStamptoDate (i)
def	timeStamptoUTC (i)
def	tolegalJSON (inputstring)
def	transposed (lists, defaultval=None)
def	unpack (i)
def	unpackBlobtoArray (iblob, itemtypecode)
def	unpackCLOBtoListstr (iStr, separator=')
def	unpackFromString (i)
def	unpackLumiid (i)

Variables
	a
	b
	lst
	myblob
	nested
	pp
	result
	seqbag

Detailed Description

This module collects some frequently used helper functions

Function Documentation

def CommonUtil.count_dups

(

l

)

report the number of duplicates in a python list

Definition at line 137 of file CommonUtil.py.

Referenced by lumiQueryAPI.allruns().

def count_dups(l):
    """
    report the number of duplicates in a python list
    """
    from collections import defaultdict
    tally=defaultdict(int)
    for x in l:
        tally[x]+=1
    return tally.items()

def CommonUtil.findInList	(		mylist,
			element
	)

check if an element is in the list

Definition at line 110 of file CommonUtil.py.

def findInList(mylist,element):
    """
    check if an element is in the list
    """
    pos=-1
    try:
        pos=mylist.index(element)
    except ValueError:
        pos=-1
    return pos!=-1

def CommonUtil.flatten

(

obj

)

Given nested lists or tuples, returns a single flattened list

Definition at line 4 of file CommonUtil.py.

Referenced by python.rootplot.root2matplotlib.Hist2D.box(), python.rootplot.core.divide_axes(), and lumiReport.toCSVLumiByLSXing().

def flatten(obj):
    '''Given nested lists or tuples, returns a single flattened list'''
    result = []
    for piece in obj:
        if hasattr (piece, '__iter__') and not isinstance (piece, basestring):
            result.extend( flatten (piece) )
        else:
            result.append (piece)
    return result

def CommonUtil.guessUnit

(

inverseubval

)

input:
    float value in 1/ub
output:
    printable value (value(float),unit(str)) unit in [1/kb,1/b,1/mb,1/ub,1/nb,1/pb,1/fb]

Definition at line 59 of file CommonUtil.py.

References objects.autophobj.float.

Referenced by lumiReport.toScreenLumiByLS(), lumiReport.toScreenOverview(), lumiReport.toScreenTotDelivered(), and lumiReport.toScreenTotEffective().

def guessUnit(inverseubval):
    '''
    input:
        float value in 1/ub
    output:
        printable value (value(float),unit(str)) unit in [1/kb,1/b,1/mb,1/ub,1/nb,1/pb,1/fb]
    '''
    if inverseubval>=1.0e-09 and inverseubval<1.0e-06:
        denomitor=1.0e-09
        unitstring='/kb'
        return (float(inverseubval)/float(denomitor),unitstring)
    if inverseubval>=1.0e-06 and inverseubval<1.0e-03:
        denomitor=1.0e-06
        unitstring='/b'
        return (float(inverseubval)/float(denomitor),unitstring)
    if inverseubval>=1.0e-03 and inverseubval<1.0:
        denomitor=1.0e-03
        unitstring='/mb'
        return (float(inverseubval)/float(denomitor),unitstring)
    if inverseubval>=1.0 and inverseubval<1.0e3:
        unitstring='/ub'
        return (inverseubval,unitstring)
    if inverseubval>=1.0e3 and inverseubval<1.0e06:
        denomitor=1.0e3
        unitstring='/nb'
        return (float(inverseubval)/float(denomitor),unitstring)
    if inverseubval>=1.0e6 and inverseubval<1.0e9:
        denomitor=1.0e6
        unitstring='/pb'
        return (float(inverseubval)/float(denomitor),unitstring)
    if inverseubval>=1.0e9 and inverseubval<1.0e12:
        denomitor=1.0e9
        unitstring='/fb'
        return (float(inverseubval)/float(denomitor),unitstring)
    if inverseubval>=1.0e12 and inverseubval<1.0e15:
        denomitor=1.0e12
        unitstring='/ab'
        return (float(inverseubval)/float(denomitor),unitstring)
    return (float(inverseubval),'/ub')

def CommonUtil.inclusiveRange	(		start,
			stop,
			step
	)

return range including the stop value

Definition at line 190 of file CommonUtil.py.

def inclusiveRange(start,stop,step):
    """return range including the stop value
    """
    v=start
    while v<stop:
        yield v
        v+=step
    if v>=stop:
        yield stop
        

def CommonUtil.is_floatstr

(

s

)

test if a string can be converted to a float

Definition at line 128 of file CommonUtil.py.

References objects.autophobj.float.

Referenced by inputFilesetParser.inputFilesetParser.fieldtotal(), and inputFilesetParser.inputFilesetParser.fieldvalues().

def is_floatstr(s):
    """
    test if a string can be converted to a float
    """
    try:
        float(s)
        return True
    except ValueError:
        return False

def CommonUtil.is_intstr

(

s

)

test if a string can be converted to a int

Definition at line 120 of file CommonUtil.py.

References createfilelist.int.

Referenced by inputFilesetParser.inputFilesetParser.fieldtotal(), inputFilesetParser.inputFilesetParser.fieldvalues(), and inputFilesetParser.inputFilesetParser.runsWithresult().

def is_intstr(s):
    """test if a string can be converted to a int
    """
    try:
        int(s)
        return True
    except ValueError:
        return False

def CommonUtil.lumiUnitForPrint

(

t

)

input : largest lumivalue
output: (unitstring,denomitor)

Definition at line 30 of file CommonUtil.py.

Referenced by lumiReport.toScreenLSEffective(), and lumiReport.toScreenLumiByLS().

def lumiUnitForPrint(t):
    '''
    input : largest lumivalue
    output: (unitstring,denomitor)
    '''
    unitstring='/ub'
    denomitor=1.0
    if t>=1.0e3 and t<1.0e06:
        denomitor=1.0e3
        unitstring='/nb'
    elif t>=1.0e6 and t<1.0e9:
        denomitor=1.0e6
        unitstring='/pb'
    elif t>=1.0e9 and t<1.0e12:
        denomitor=1.0e9
        unitstring='/fb'
    elif t>=1.0e12 and t<1.0e15:
        denomitor=1.0e12
        unitstring='/ab'
    elif t<1.0 and t>=1.0e-3: #left direction
        denomitor=1.0e-03
        unitstring='/mb'
    elif t<1.0e-03 and t>=1.0e-06:
        denomitor=1.0e-06
        unitstring='/b'
    elif t<1.0e-06 and t>=1.0e-09:
        denomitor=1.0e-9
        unitstring='/kb'
    return (unitstring,denomitor)

def CommonUtil.pack	(		high,
			low
	)

pack high,low 32bit unsigned int to one unsigned 64bit long long
   Note:the print value of result number may appear signed, if the sign bit is used.

Definition at line 154 of file CommonUtil.py.

Referenced by packToString().

def pack(high,low):
    """pack high,low 32bit unsigned int to one unsigned 64bit long long
       Note:the print value of result number may appear signed, if the sign bit is used.
    """
    h=high<<32
    return (h|low)

def CommonUtil.packArraytoBlob

(

iarray

)

Inputs:
inputarray: a python array

Definition at line 220 of file CommonUtil.py.

Referenced by generateDummyData.hlt(), queryDataSource.hltFromOldLumi(), queryDataSource.hltFromRuninfoV2(), generateDummyData.lumiSummary(), generateDummyData.trg(), and queryDataSource.trgFromOldLumi().

def packArraytoBlob(iarray):
    '''
    Inputs:
    inputarray: a python array
    '''
    result=coral.Blob()
    result.write(iarray.tostring())
    return result

def CommonUtil.packListstrtoCLOB	(		iListstr,
			separator = '
	)

pack list of string of comma separated large string CLOB

Definition at line 244 of file CommonUtil.py.

def packListstrtoCLOB(iListstr,separator=','):
    '''
    pack list of string of comma separated large string CLOB
    '''
    return separator.join(iListstr)

def CommonUtil.packToString	(		high,
			low
	)

pack high,low 32bit unsigned int to one unsigned 64bit long long in string format
   Note:the print value of result number may appear signed, if the sign bit is used.

Definition at line 160 of file CommonUtil.py.

References pack().

def packToString(high,low):
    """pack high,low 32bit unsigned int to one unsigned 64bit long long in string format
       Note:the print value of result number may appear signed, if the sign bit is used.
    """
    fmt="%u"
    return fmt%pack(high,low)

def CommonUtil.pairwise

(

lst

)

yield item i and item i+1 in lst. e.g.
(lst[0], lst[1]), (lst[1], lst[2]), ..., (lst[-1], None)

from http://code.activestate.com/recipes/409825-look-ahead-one-item-during-iteration

Definition at line 98 of file CommonUtil.py.

def pairwise(lst):
    """
    yield item i and item i+1 in lst. e.g.
    (lst[0], lst[1]), (lst[1], lst[2]), ..., (lst[-1], None)
    
    from http://code.activestate.com/recipes/409825-look-ahead-one-item-during-iteration
    """
    if not len(lst): return
    #yield None, lst[0]
    for i in range(len(lst)-1):
        yield lst[i], lst[i+1]
    yield lst[-1], None

def CommonUtil.parselumicorrector

(

correctorStr

)

output: (functionname,parametersinuppercase[])

Definition at line 271 of file CommonUtil.py.

Referenced by normDML.normValueById().

def parselumicorrector(correctorStr):
    '''
    output: (functionname,parametersinuppercase[])
    '''
    cleancorrectorStr=correctorStr.replace(' ','')#in case of whitespace by mistake
    [correctorFunc,paramsStr]=cleancorrectorStr.split(':')
    params=paramsStr.split(',')
    return (correctorFunc,params)

def CommonUtil.parseTime

(

iTime

)

input string of the ("^\d\d/\d\d/\d\d \d\d:\d\d:\d\d$|^\d{6}$|^\d{4}$" format
output (runnum,fillnum,timeStr)

Definition at line 14 of file CommonUtil.py.

References createfilelist.int.

def parseTime(iTime):
    '''
    input string of the ("^\d\d/\d\d/\d\d \d\d:\d\d:\d\d$|^\d{6}$|^\d{4}$" format
    output (runnum,fillnum,timeStr)
    '''
    if not iTime: return (None,None,None)
    p=re.compile('^\d\d/\d\d/\d\d \d\d:\d\d:\d\d$')
    if re.match(p,iTime):
        return (None,None,iTime)
    p=re.compile('^\d{6}$')
    if re.match(p,iTime):
        return (int(iTime),None,None)
    p=re.compile('^\d{4}$')
    if re.match(p,iTime):
        return (None,int(iTime),None)
    

def CommonUtil.splitlistToRangeString

(

inPut

)

Definition at line 256 of file CommonUtil.py.

Referenced by lumiReport.toScreenOverview(), and lumiReport.toScreenTotEffective().

def splitlistToRangeString (inPut):
    result = []
    first = inPut[0]
    last = inPut[0]
    result.append ([inPut[0]])
    counter = 0
    for i in inPut[1:]:
        if i == last+1:
            result[counter].append (i)
        else:
            counter += 1
            result.append ([i])
        last = i
    return ', '.join (['['+str (min (x))+'-'+str (max (x))+']' for x in result])

def CommonUtil.timeStamptoDate

(

i

)

convert 64bit timestamp to local date in string format

Definition at line 176 of file CommonUtil.py.

References unpack().

def timeStamptoDate(i):
    """convert 64bit timestamp to local date in string format
    """
    return time.ctime(unpack(i)[0])

def CommonUtil.timeStamptoUTC

(

i

)

convert 64bit timestamp to Universal Time in string format

Definition at line 180 of file CommonUtil.py.

References unpack().

def timeStamptoUTC(i):
    """convert 64bit timestamp to Universal Time in string format
    """
    t=unpack(i)[0]
    return time.strftime("%a, %d %b %Y %H:%M:%S +0000",time.gmtime(t))

def CommonUtil.tolegalJSON

(

inputstring

)

convert json like string to legal json string
add double quote around json keys if they are not there, change single quote to double quote around keys

Definition at line 200 of file CommonUtil.py.

References harvestTrackValidationPlots.str.

def tolegalJSON(inputstring):
   '''
   convert json like string to legal json string
   add double quote around json keys if they are not there, change single quote to double quote around keys
   '''
   strresult=inputstring.strip()
   strresult=re.sub("\s+","",strresult)
   try:
       mydict=ast.literal_eval(strresult)
   except SyntaxError:
       print 'error in converting string to dict'
       raise
   result={}
   for k,v in mydict.items():
       if not isinstance(k,str):
           result[str(k)]=v
       else:
           result[k]=v
   return re.sub("'",'"',str(result))

def CommonUtil.transposed	(		lists,
			defaultval = None
	)

transposing list of lists
from http://code.activestate.com/recipes/410687-transposing-a-list-of-lists-with-different-lengths/

Definition at line 146 of file CommonUtil.py.

References genParticles_cff.map.

Referenced by TkRotation2D< Scalar >.rotate(), specificLumi.specificlumiTofile(), and lumiReport.toCSVLumiByLSXing().

def transposed(lists, defaultval=None):
    """
    transposing list of lists
    from http://code.activestate.com/recipes/410687-transposing-a-list-of-lists-with-different-lengths/
    """
    if not lists: return []
    #return map(lambda *row: [elem or defaultval for elem in row], *lists)
    return map(lambda *row: [elem for elem in row or defaultval], *lists)

def CommonUtil.unpack

(

i

)

unpack 64bit unsigned long long into 2 32bit unsigned int, return tuple (high,low)

Definition at line 166 of file CommonUtil.py.

References reco.return().

Referenced by timeStamptoDate(), timeStamptoUTC(), unpackFromString(), and unpackLumiid().

def unpack(i):
    """unpack 64bit unsigned long long into 2 32bit unsigned int, return tuple (high,low)
    """
    high=i>>32
    low=i&0xFFFFFFFF
    return(high,low)

def CommonUtil.unpackBlobtoArray	(		iblob,
			itemtypecode
	)

Inputs:
iblob: coral.Blob
itemtypecode: python array type code 

Definition at line 229 of file CommonUtil.py.

Referenced by dataDML.beamInfoById(), lumiQueryAPI.beamIntensityForRun(), dataDML.hltLSById(), dataDML.lumiLSById(), and dataDML.trgLSById().

def unpackBlobtoArray(iblob,itemtypecode):
    '''
    Inputs:
    iblob: coral.Blob
    itemtypecode: python array type code 
    '''
    if itemtypecode not in ['c','b','B','u','h','H','i','I','l','L','f','d']:
        raise RuntimeError('unsupported typecode '+itemtypecode)
    result=array.array(itemtypecode)
    blobstr=iblob.readline()
    if not blobstr :
        return None
    result.fromstring(blobstr)
    return result

def CommonUtil.unpackCLOBtoListstr	(		iStr,
			separator = '
	)

unpack a large string to list of string

Definition at line 250 of file CommonUtil.py.

References split.

def unpackCLOBtoListstr(iStr,separator=','):
    '''
    unpack a large string to list of string
    '''
    return [i.strip() for i in iStr.strip().split(separator)]

def CommonUtil.unpackFromString

(

i

)

unpack 64bit unsigned long long in string format into 2 32bit unsigned int, return tuple(high,low)

Definition at line 172 of file CommonUtil.py.

References createfilelist.int, and unpack().

def unpackFromString(i):
    """unpack 64bit unsigned long long in string format into 2 32bit unsigned int, return tuple(high,low)
    """
    return unpack(int(i))

def CommonUtil.unpackLumiid

(

i

)

unpack 64bit lumiid to dictionary {'run','lumisection'}

Definition at line 185 of file CommonUtil.py.

References unpack().

def unpackLumiid(i):
    """unpack 64bit lumiid to dictionary {'run','lumisection'}
    """
    j=unpack(i)
    return {'run':j[0],'lumisection':j[1]}

Variable Documentation

CommonUtil.a

Definition at line 283 of file CommonUtil.py.

CommonUtil.b

Definition at line 315 of file CommonUtil.py.

CommonUtil.lst

Definition at line 287 of file CommonUtil.py.

CommonUtil.myblob

Definition at line 312 of file CommonUtil.py.

CommonUtil.nested

Definition at line 281 of file CommonUtil.py.

Referenced by edm.contextual_find().

CommonUtil.pp

Definition at line 296 of file CommonUtil.py.

CommonUtil.result

Definition at line 294 of file CommonUtil.py.

CommonUtil.seqbag

Definition at line 289 of file CommonUtil.py.