python.AtlCoolLib.coolTool Class Reference

Collaboration diagram for python.AtlCoolLib.coolTool:

Public Member Functions
def	__init__ (self, name, readonly, minarg, maxarg, longopts)
def	procopts (self, opts)

Public Attributes
	name
	readonly
	runLumi
	runmin
	runmax
	lumimin
	lumimax
	tsmin
	tsmax
	since
	until
	debug
	conn
	db

Private Member Functions
def	_usage1 (self)
def	_usage2 (self)
def	_procopts (self, opts)

Detailed Description

Class coolTool implements a base for python command-line tools to access
and set data in COOL folders
Incomplete baseclass implementation - clients must implement the following:
 - setup(self,args) - set additional arguments
 - usage(self) - print usage
 - execute(self) - execute command
 - procopts(self,opts) - (optional) - process additional command switches

Definition at line 287 of file AtlCoolLib.py.

Constructor & Destructor Documentation

__init__()

def python.AtlCoolLib.coolTool.__init__	(		self,
			name,
			readonly,
			minarg,
			maxarg,
			longopts
	)

Initialise class and process command line options and switches

Definition at line 297 of file AtlCoolLib.py.

    def __init__(self,name,readonly,minarg,maxarg,longopts):
        """
        Initialise class and process command line options and switches
        """
        self.name=name
        self.readonly=readonly
        self.runLumi=True
        self.runmin=0
        self.runmax=(1 << 31)-1
        self.lumimin=0
        self.lumimax=(1 << 32)-2
        self.tsmin=cool.ValidityKeyMin
        self.tsmax=cool.ValidityKeyMax
        self.since=cool.ValidityKeyMin
        self.until=cool.ValidityKeyMax
        self.debug=False
        # get and process options - note only use long options format
        try:
            fullopts=longopts+['r=','rs=','ru=','l=','ls=','lu=','ts=','tu=','debug']
            opts,args=getopt.getopt(sys.argv[1:],'',fullopts)
        except getopt.GetoptError as e:
            print (e)
            self.usage()
            sys.exit(1)
        if len(args)<minarg or len(args)>maxarg:
            print (name,'takes between',minarg,'and',maxarg,'non-optional parameters')
            self.usage()
            sys.exit(1)
        # set standard parameters
        self.conn=transConn(str(args[0]))
        # allow derived class to set parameters
        self.setup(args[1:])
        self._procopts(opts)
        self.procopts(opts)
        # open database connection and execute command
        if self.readonly:
            self.db=indirectOpen(self.conn,debug=self.debug)
        else:
            self.db=forceOpen(self.conn)
        self.execute()
 

Member Function Documentation

_procopts()

def python.AtlCoolLib.coolTool._procopts (   self,   opts  )

private

Definition at line 355 of file AtlCoolLib.py.

    def _procopts(self,opts):
        # process the standard parameters
        for o,a in opts:
            if (o=='--rs'): self.runmin=int(a)
            if (o=='--ru'): self.runmax=int(a)
            if (o=='--r'):
                self.runmin=int(a)
                self.runmax=int(a)
            if (o=='--ls'): self.lumimin=int(a)
            if (o=='--lu'): self.lumimax=int(a)
            if (o=='--l'):
                self.lumimin=int(a)
                self.lumimax=int(a)
            if (o=='--ts'):
                self.tsmin=timeVal(a)*1000000000
                self.runLumi=False
            if (o=='--tu'):
                self.tsmax=timeVal(a)*1000000000
                self.runLumi=False
            if (o=='--debug'): self.debug=True
        # now set the real interval of validity
        if (self.runLumi):
            print ('>== Data valid for run,LB [',self.runmin,',',self.lumimin,'] to [',self.runmax,',',self.lumimax,']')
            self.since=(self.runmin << 32)+self.lumimin
            self.until=(self.runmax << 32)+self.lumimax+1
        else:
            self.since=self.tsmin
            self.until=self.tsmax
            print ('>== Data valid for timestamps (sec) from ',self.since/1000000000,'(',timeString(self.since),') to ',self.until/1000000000,'(',timeString(self.until),')')
        # check IOV is OK
        if (self.until<self.since):
            print ('ERROR in IOV definition: until<since')
            sys.exit(1)
 

_usage1()

def python.AtlCoolLib.coolTool._usage1 (   self )

private

Definition at line 338 of file AtlCoolLib.py.

    def _usage1(self):
        # base implementation of usage - first part
        print ('Usage:',self.name,' {<options>} dbname ',)
        

_usage2()

def python.AtlCoolLib.coolTool._usage2 (   self )

private

Definition at line 342 of file AtlCoolLib.py.

    def _usage2(self):
        # base implementation of usage - second part
        print ('Options to specify IOV (default valid for all intervals)')
        print ('--rs=<first run>')
        print ('--ru=<last run> (inclusive)')
        print ('--r=<run> (only single run)')
        print ('--ls=<lumi block since>')
        print ('--l=<lumi block> (only single LB)')
        print ('--lu=<lumi block until> (inclusive)')
        print ('--ts=<initial timestamp> (in seconds)')
        print ('--tu=<final timestamp> (in seconds)')
        print ('--debug: Enable debugging information')
 

procopts()

def python.AtlCoolLib.coolTool.procopts	(		self,
			opts
	)

Definition at line 389 of file AtlCoolLib.py.

    def procopts(self,opts):
        # default implementation of procopts - do nothing
        pass
 
 

Member Data Documentation

conn

python.AtlCoolLib.coolTool.conn

Definition at line 326 of file AtlCoolLib.py.

db

python.AtlCoolLib.coolTool.db

Definition at line 333 of file AtlCoolLib.py.

debug

python.AtlCoolLib.coolTool.debug

Definition at line 312 of file AtlCoolLib.py.

lumimax

python.AtlCoolLib.coolTool.lumimax

Definition at line 307 of file AtlCoolLib.py.

lumimin

python.AtlCoolLib.coolTool.lumimin

Definition at line 306 of file AtlCoolLib.py.

name

python.AtlCoolLib.coolTool.name

Definition at line 301 of file AtlCoolLib.py.

readonly

python.AtlCoolLib.coolTool.readonly

Definition at line 302 of file AtlCoolLib.py.

runLumi

python.AtlCoolLib.coolTool.runLumi

Definition at line 303 of file AtlCoolLib.py.

runmax

python.AtlCoolLib.coolTool.runmax

Definition at line 305 of file AtlCoolLib.py.

runmin

python.AtlCoolLib.coolTool.runmin

Definition at line 304 of file AtlCoolLib.py.

since

python.AtlCoolLib.coolTool.since

Definition at line 310 of file AtlCoolLib.py.

tsmax

python.AtlCoolLib.coolTool.tsmax

Definition at line 309 of file AtlCoolLib.py.

tsmin

python.AtlCoolLib.coolTool.tsmin

Definition at line 308 of file AtlCoolLib.py.

until

python.AtlCoolLib.coolTool.until

Definition at line 311 of file AtlCoolLib.py.

---

The documentation for this class was generated from the following file:

• AtlCoolLib.py