python.AtlCoolLib Namespace Reference

Classes
class	coolTool
class	RangeList
class	TimeStampToRLB

Functions
	transConn (conn)
	forceOpen (conn)
	readOpen (conn)
	ensureFolder (db, folder, spec, desc, version=cool.FolderVersioning.SINGLE_VERSION)
	athenaDesc (runLumi, datatype)
	timeVal (val)
	timeString (iovkey)
	indirectOpen (coolstr, readOnly=True, debug=False)
	replicaList ()
	pathResolver (leaf, retFile=True)
	getHostname ()
	tests ()

Detailed Description

Module defining utilities for ATLAS command line/python use of COOL

Function Documentation

athenaDesc()

python.AtlCoolLib.athenaDesc	(		runLumi,
			datatype )

Return the correct folder description string for Athena IOVDbSVc access
runLumi=True or False for timestamp
datatype= { AthenaAttributeList | CondAttrListCollection }

Definition at line 80 of file AtlCoolLib.py.

def athenaDesc(runLumi,datatype):
    """
    Return the correct folder description string for Athena IOVDbSVc access
    runLumi=True or False for timestamp
    datatype= { AthenaAttributeList | CondAttrListCollection }
    """
    if (runLumi):
        desc='<timeStamp>run-lumi</timeStamp>'
    else:
        desc='<timeStamp>time</timeStamp>'
    stype=71
    clid=0
    tname=''
    if (datatype=='CondAttrListCollection'):
        clid=1238547719
        tname='CondAttrListCollection'
    elif (datatype=='AthenaAttributeList'):
        clid=40774348
        tname='AthenaAttributeList'
    elif (datatype=='CondAttrListVec'):
        clid=55403898
        tname='CondAttrListVec'
 
    desc+='<addrHeader><address_header service_type=\"'+str(stype)+'\" clid=\"'+str(clid)+'\" /></addrHeader><typeName>'+tname+'</typeName>'
    return desc
 

ensureFolder()

python.AtlCoolLib.ensureFolder	(		db,
			folder,
			spec,
			desc,
			version = cool.FolderVersioning.SINGLE_VERSION )

Ensure folder exists, creating it if needed with given spec
Return COOL folder object

Definition at line 62 of file AtlCoolLib.py.

def ensureFolder(db,folder,spec,desc,version=cool.FolderVersioning.SINGLE_VERSION):
    """
    Ensure folder exists, creating it if needed with given spec
    Return COOL folder object
    """
    if (not db.existsFolder(folder)):
        print ('Attempting to create',folder,'with description',desc)
        try:
            # Deprecated/dropped:  db.createFolder(folder,spec,desc,version,True)
            folderSpec = cool.FolderSpecification(version,spec)
            db.createFolder(folder,folderSpec,desc,True)
            print ('Folder created')
        except Exception as e:
            print (e)
            print ('Could not create folder',folder)
            return None
    return db.getFolder(folder)
 

forceOpen()

python.AtlCoolLib.forceOpen

(

conn

)

Open COOL database with given connection, or force open if not possible
Return COOL database object, or None if cannot be opened
Database is opened in update mode

Definition at line 27 of file AtlCoolLib.py.

def forceOpen(conn):
    """
    Open COOL database with given connection, or force open if not possible
    Return COOL database object, or None if cannot be opened
    Database is opened in update mode
    """
    dbSvc=cool.DatabaseSvcFactory.databaseService()
    conn2=transConn(conn)
    try:
        db=dbSvc.openDatabase(conn2,False)
    except Exception as e:
        print (e)
        print ('Could not connect to',conn,'try to create it')
        try:
            db=dbSvc.createDatabase(conn2)
        except Exception as e:
            print (e)
            print ('Could not create the database - give up')
            return None
    return db
 

getHostname()

python.AtlCoolLib.getHostname

(

)

Definition at line 234 of file AtlCoolLib.py.

def getHostname():
    "Get the hostname including domain name if possible"
    if ('ATLAS_CONDDB' in os.environ):
        name=os.environ['ATLAS_CONDDB']
    else:
        try:
            name=os.environ['HOSTNAME']
        except Exception:
            # try socket lib (for Mac) as HOSTNAME does not contain os.environ
            import socket
            try:
                name=socket.getfqdn()
            except Exception:
                name='unknown'
    # check name has a . (and doesn't end with .local, as macs default to), 
    # otherwise try command hostname --fqdn
    if (name.find('.')>=0 and name[-6:]!=".local"): 
        return name
    else:
        if (name[-6:]==".local"):
            print ("WARNING. Hostname is ",name, " which does not define a domain. Consider setting $ATLAS_CONDDB to avoid this")
            return "unknown"
 
    import subprocess
    try:
        name=subprocess.check_output('hostname --fqdn').decode('utf-8')
    except Exception:
        name='unknown'
    
    #Calling hostname wrong will fill 'name' with error message
    if (name.find('illegal')>-1 or name.find('unrecognized')>-1):
      print ("WARNING. hostname --fqdn returned the following:",name)
      print ("Consider setting $ATLAS_CONDDB to avoid this.")
      return "unknown"
    return name
    
 
# test code

indirectOpen()

python.AtlCoolLib.indirectOpen	(		coolstr,
			readOnly = True,
			debug = False )

Obtain a connection to the database coolstr (e.g.
   COOLONL_INDET/OFLP200) using Oracle servers only, bypassing SQLite files
   and simulating the action of DBReplicaSvc to choose the correct one.
   Returns None in case a connection cannot be established.
   debug=True produces debug printout to show servers being tried

Definition at line 129 of file AtlCoolLib.py.

def indirectOpen(coolstr,readOnly=True,debug=False):
    """Obtain a connection to the database coolstr (e.g.
       COOLONL_INDET/OFLP200) using Oracle servers only, bypassing SQLite files
       and simulating the action of DBReplicaSvc to choose the correct one.
       Returns None in case a connection cannot be established.
       debug=True produces debug printout to show servers being tried"""
    dbSvc=cool.DatabaseSvcFactory.databaseService()
    connstr=transConn(coolstr)
    
    # split the name into schema and dbinstance
    splitname=connstr.split('/')
    forceSQLite='ATLAS_COOL_FORCESQLITE' in os.environ
    if (debug and forceSQLite):
        print ("ATLAS_COOL_FORCESQLITE: Force consideration of SQLite replicas")
    if (len(splitname)!=2 or readOnly is False or forceSQLite):
        try:
            db=dbSvc.openDatabase(connstr,readOnly)
        except Exception as e:
            # if writeable connection on readonly filesystem, get
            # 'cannot be established error' - retry readonly
            if (not readOnly and ('attempt to write a readonly database' in e.__repr__())):
                print ("Writeable open failed - retry in readonly mode")
                db=dbSvc.openDatabase(connstr,True)
            else:
                raise
        return db
    if (debug): print ("Trying to establish connection for %s from Oracle" % connstr)
    schema=splitname[0]
    dbinst=splitname[1]
    # list of servers to try, first one at beginning
    serverlist=replicaList()
    if (debug): print (serverlist)
    # will pop candidates from end of list - so reverse it first
    serverlist.reverse()
    while len(serverlist)>0:
        server=serverlist.pop()
        # deal with frontier server - use only if FRONTIER_SERVER is set
        if server=='ATLF':
            if ('FRONTIER_SERVER' in os.environ):
                connstr='frontier://ATLF/();schema=ATLAS_%s;dbname=%s' % (schema,dbinst)
            else:
                # skip ATLF replica if FRONTIER_SERVER not set
                continue
        elif server=='atlas_dd': continue
        else:
            connstr='oracle://%s;schema=ATLAS_%s;dbname=%s' % (server,schema,dbinst)
        if (debug): print ("Attempting to open %s" % connstr)
        try:
            dbconn=dbSvc.openDatabase(connstr)
            if (dbconn is not None and dbconn.isOpen()):
                if (debug): print ("Established connection to %s" % server)
                return dbconn
            if (debug): print ("Cannot connect to %s" % server)
        except Exception:
            if (debug): print ("Exception connecting to %s" % server)
    # all replicas tried - give up
    print ("All available replicas tried - giving up")
    return None
 

pathResolver()

python.AtlCoolLib.pathResolver	(		leaf,
			retFile = True )

Find the file leaf using the DATAPATH variable to look for it
Return a read-only file object, or None if not found.
If retFile is false, just return the pathname.
Current directory takes precendence if file is there

Definition at line 212 of file AtlCoolLib.py.

def pathResolver(leaf,retFile=True):
    """Find the file leaf using the DATAPATH variable to look for it
    Return a read-only file object, or None if not found.
    If retFile is false, just return the pathname.
    Current directory takes precendence if file is there"""
    try:
        paths=os.environ['DATAPATH'].split(':')
    except Exception:
        # DATAPATH not set - just use current directory
        paths=[]
    paths=['.']+paths
    for path in paths:
        try:
            os.stat(path+'/'+leaf)
            if (retFile):
                return open(path+'/'+leaf,'r')
            else:
                return path+'/'+leaf
        except OSError:
            pass
    return None
 

readOpen()

python.AtlCoolLib.readOpen

(

conn

)

Open COOL database with given connection for reading

Definition at line 48 of file AtlCoolLib.py.

def readOpen(conn):
    """
    Open COOL database with given connection for reading
    """
    dbSvc=cool.DatabaseSvcFactory.databaseService()
    conn2=transConn(conn)
    try:
        db=dbSvc.openDatabase(conn2,True)
    except Exception as e:
        print (e)
        print ('Could not connect to',conn)
        return None
    return db
    

replicaList()

python.AtlCoolLib.replicaList

(

)

Return list of Oracle database server names to try, mimicing action of
Athena DBReplicaSvc

Definition at line 188 of file AtlCoolLib.py.

def replicaList():
    """Return list of Oracle database server names to try, mimicing action of
    Athena DBReplicaSvc"""
    configfile=pathResolver('dbreplica.config')
    if configfile is None:
        print ("Cannot find dbreplica.config")
        return None
    hostname=getHostname()
    best=0
    serverlist=[]
    for line in configfile.readlines():
        epos=line.find('=')
        if (epos>0 and line[0]!="#"):
            domains=line[0:epos].split()
            for dom in domains:
                if ((hostname[-len(dom):]==dom and len(dom)>best) or (best==0 and dom=='default')):
                    best=len(dom)
                    serverlist=line[epos+1:].split()
    configfile.close()
    if (len(serverlist)==0):
        print ("No suitable servers found")
        return None
    return serverlist
            

tests()

python.AtlCoolLib.tests

(

)

Definition at line 272 of file AtlCoolLib.py.

def tests():
    print ('AtlCoolLib tests')
    db=forceOpen("TESTCOOL")
    if (db is None):
        print ('Could not create test database')
        sys.exit(1)
    spec=cool.RecordSpecification()
    spec.extend('testString',cool.StorageType.String255)
    folder=ensureFolder(db,'/TEST/TEST1',spec,athenaDesc(True,'CondAttrListCollection'),cool.FolderVersioning.MULTI_VERSION)
    if (folder is None):
        print ('Could not create test folder')
        sys.exit(1)
    print ('All done')
    return
 

timeString()

python.AtlCoolLib.timeString

(

iovkey

)

Definition at line 119 of file AtlCoolLib.py.

def timeString(iovkey):
    "Convert the IOVkey (63 bit) to a string representing timestamp"
    if (iovkey==cool.ValidityKeyMin):
        return "ValidityKeyMin"
    elif (iovkey==cool.ValidityKeyMax):
        return "ValidityKeyMax"
    else:
        stime=int(iovkey/1000000000)
        return time.asctime(time.gmtime(stime))+" UTC"
 

timeVal()

python.AtlCoolLib.timeVal

(

val

)

Definition at line 106 of file AtlCoolLib.py.

def timeVal(val):
    "Convert argument to time in seconds, treating as a literal or date"
    try:
        a=int(val)
        return a
    except ValueError:
        try:
            ts=time.strptime(val+'/UTC','%Y-%m-%d:%H:%M:%S/%Z')
            return int(calendar.timegm(ts))
        except ValueError:
            print ("ERROR in time specification, use e.g. 2007-05-25:14:01:00")
            sys.exit(-1)
        

transConn()

python.AtlCoolLib.transConn

(

conn

)

Translate simple connection string (no slash) to mycool.db with given
instance, all others left alone

Definition at line 17 of file AtlCoolLib.py.

def transConn(conn):
    """
    Translate simple connection string (no slash) to mycool.db with given
    instance, all others left alone
    """
    if ('/' not in conn):
        return 'sqlite://X;schema=mycool.db;dbname='+conn
    else:
        return conn