python.DQUtilities.IDBSDefectWriter Class Reference

Collaboration diagram for python.DQUtilities.IDBSDefectWriter:

Public Member Functions
def	__init__ (self, fileName, forceNew=False, dbName='IDBSDQ', tag='nominal', user='sys:dqBeamSpot')
def	__del__ (self)
def	connect (self, fileName, forceNew=False, dbName='IDBSDQ', tag='nominal')
def	defectType (self, t)
def	add (self, runMin=0, runMax=(1<< 31) -1, lbMin=0, lbMax=(1<< 32) -1)
def	complete (self, runMin, runMax)
def	writeDefects (self, tag='nominal', nonpresent=False)
def	dump (self, filename=None)

Public Attributes
	defect
	iovs
	user
	db
	officialDb

Private Member Functions
def	_writeDefect (self, defect, since, until, tag='nominal', description='', comment='', present=True, recoverable=False)

Detailed Description

Class for writing BS defects to an sqlite file

Definition at line 19 of file DQUtilities.py.

Constructor & Destructor Documentation

__init__()

def python.DQUtilities.IDBSDefectWriter.__init__	(		self,
			fileName,
			forceNew = False,
			dbName = 'IDBSDQ',
			tag = 'nominal',
			user = 'sys:dqBeamSpot'
	)

Initialise database connection 

Definition at line 24 of file DQUtilities.py.

    def __init__(self,fileName, forceNew=False, dbName='IDBSDQ', tag='nominal', user='sys:dqBeamSpot'):        """
        Initialise database connection 
        """
        self.defect         = None
        self.iovs           = IOVSet()
        self.user           = user
        
        #self.allowedDefects = DefectsDB('').defect_names
 
        if not fileName: fileName = 'tmp.'+str(os.getpid())+'.db'
 
        self.connect(fileName, forceNew, dbName, tag)
        
        pass
 
 

__del__()

def python.DQUtilities.IDBSDefectWriter.__del__

(

self

)

Delete db to clear connection

Definition at line 40 of file DQUtilities.py.

    def __del__(self):
        """
        Delete db to clear connection
        """
 
        os.system('[[ -f tmp.%s.db ]] && rm tmp.%s.db' %(os.getpid(), os.getpid()))
        del self.db
        pass
 
 

Member Function Documentation

_writeDefect()

def python.DQUtilities.IDBSDefectWriter._writeDefect (   self,   defect,   since,   until,   tag = 'nominal',   description = '',   comment = '',   present = True,   recoverable = False  )

private

Write a single defect to the database

Definition at line 158 of file DQUtilities.py.

    def _writeDefect(self,defect, since, until, tag='nominal', description='', comment='', present=True, recoverable=False):
        """
        Write a single defect to the database
        """
 
        if defect not in self.db.defect_names:
            self.db.create_defect(defect, description)
 
        self.db.insert(defect, since, until, comment, self.user, present, recoverable) 
        
        return
 

add()

def python.DQUtilities.IDBSDefectWriter.add	(		self,
			runMin = 0,
			runMax = (1 << 31)-1,
			lbMin = 0,
			lbMax = (1 << 32)-1
	)

Add iovs which are NOT defective to the list
Note, lbMax is exclusive here (and inclusive when shown on defect web page). 

Definition at line 72 of file DQUtilities.py.

    def add(self,runMin=0, runMax=(1 << 31)-1, lbMin=0, lbMax=(1 << 32)-1):
        """
        Add iovs which are NOT defective to the list
        Note, lbMax is exclusive here (and inclusive when shown on defect web page). 
        """
 
        # Make since and until and convert to syntactially nice RunLumiType
        since = RunLumiType((runMin << 32)+lbMin)
        until = RunLumiType((runMax << 32)+lbMax)
 
        # IoVs which are not defective (i.e. beamspot good)
        self.iovs.add(since, until, self.defect, False) 
        return 
 
 

complete()

def python.DQUtilities.IDBSDefectWriter.complete	(		self,
			runMin,
			runMax
	)

Complete a list of IoVs to cover all LBs in a run, treating empty ones as having 'emptyState'

Definition at line 87 of file DQUtilities.py.

    def complete(self, runMin, runMax):
        """
        Complete a list of IoVs to cover all LBs in a run, treating empty ones as having 'emptyState'
 
        """
 
        # Create an IOV set covering the entire run(s)
        run_lbs = fetch_iovs("EOR", runs=(runMin, runMax), what=[], with_channel=False)
    
 
        #         run_lbs = IOVSet()
        #         lbMin = 1
        #         lbMax = (1 << 32) -1  # Note, lbMax is exclusive
        #         since = RunLumiType((runMin << 32)+lbMin)
        #         until = RunLumiType((runMax << 32)+lbMax)
        #         run_lbs.add(since, until)
 
        if not len(run_lbs):
            print ("WARNING: No LBs in run according to EOR_Params - are we running before the run has finished?")
 
        def lbsStartAtOne(iov):
            "Change LBs starting at 0 to start at 1"
            return iov._replace(since=RunLumi(iov.since.run, 1))
 
        # Start LBs from 1 rather than 0 (at request of P. Onyisi) as long as run has more than one LB (else skip)
        run_lbs = [lbsStartAtOne(iov) for iov in run_lbs if iov.until.lumi > 1]
 
        # Empty IOV set for adding full list of LBs too
        iovs = IOVSet()        
 
        # Ask official DB if an IoV is currently defective so can unset only those if doing reprocessing 
        defectsCurrentlyInDb = self.officialDb.retrieve((runMin, 0), (runMax+1, 0), [self.defect]) 
 
        # Order IOVs to avoid since > until
        self.iovs = IOVSet(sorted(self.iovs))
 
        #for since, until, (run_lb, iov, dbDefect) in process_iovs(run_lbs.solidify(RANGEIOV_VAL), self.iovs.solidify(DEFECTIOV_VAL), defectsCurrentlyInDb):
        for since, until, (run_lb, iov, dbDefect) in process_iovs(run_lbs, self.iovs.solidify(DEFECTIOV_VAL), defectsCurrentlyInDb):        
            if not run_lb: continue  # Check valid
            
#             # Start LBs from 1 rather than 0 (at request of P. Onyisi)
#             # If this makes since==until, i.e. it was a [0->1) LB range then skip
#             if since.lumi==0:
#                 since = RunLumiType((since.run << 32)+since.lumi+1)
#                 if since==until: continue
 
            # Add iovs from self.iovs treating empty ones as defective (i.e. beamspot bad/missing)
            if iov:
                # These are not defective
                if dbDefect and dbDefect.present:
                    # Only store not defective IoVs if they are present on the Db so we can unset them
                    # (don't want to write not present defects to Db unless really chaning an existing defect)
                    iovs.add(since, until, self.defect, False)
            else:
                # These are defective
                iovs.add(since, until, self.defect, True)
                
        self.iovs = iovs
        return
 

connect()

def python.DQUtilities.IDBSDefectWriter.connect	(		self,
			fileName,
			forceNew = False,
			dbName = 'IDBSDQ',
			tag = 'nominal'
	)

Open connection to defect DB

Definition at line 50 of file DQUtilities.py.

    def connect(self, fileName, forceNew=False, dbName='IDBSDQ', tag='nominal'):
        """
        Open connection to defect DB
        """
        
        connString =  'sqlite://;schema=%s;dbname=%s' % (fileName,dbName)
 
        if forceNew and os.path.exists(fileName):
            os.remove(fileName)
 
        self.db = DefectsDB(connString, read_only=False, create=True, tag=(tag, 'HEAD')) # Second tag is for virtual defects, which we are not interested in
 
        self.officialDb = DefectsDB()
 
        return
 

defectType()

def python.DQUtilities.IDBSDefectWriter.defectType	(		self,
			t
	)

Set defect type

Definition at line 66 of file DQUtilities.py.

    def defectType(self,t):
        """
        Set defect type
        """
        self.defect = t
        

dump()

def python.DQUtilities.IDBSDefectWriter.dump	(		self,
			filename = None
	)

Dump defects to a file given by filename or stdout if no filename given

Definition at line 170 of file DQUtilities.py.

    def dump(self, filename = None):
        """
        Dump defects to a file given by filename or stdout if no filename given
        """
 
        from DQUtils.utils import pprint_objects
 
        if filename is not None:
            f = open(filename.replace('.db', '.txt'), "w")
            # If not defects then nothing will be in the database and we write an empty file
            if len(self.iovs):
                pprint_objects(self.db.retrieve(primary_only=True, nonpresent=True), f)
            f.close()
        else:
            if len(self.iovs):
                self.iovs.pprint()
            else:
                 print ('\nNo DQ defects')
 
        #         with open(filename.replace('.db', '.txt'), "w") as f:
        #             pprint_objects(self.db.retrieve(), f)
 
            
        return
 
 

writeDefects()

def python.DQUtilities.IDBSDefectWriter.writeDefects	(		self,
			tag = 'nominal',
			nonpresent = False
	)

Write all defects to the database.  If 'nonpresent' is True then write the absent ones too

Definition at line 147 of file DQUtilities.py.

    def writeDefects(self, tag='nominal', nonpresent=False):
        """
        Write all defects to the database.  If 'nonpresent' is True then write the absent ones too
        """
 
        with self.db.storage_buffer:            
            for since, until, defect, present in self.iovs:
                if not present and not nonpresent: continue
                #print (since, until, present)
                self._writeDefect(defect, since, until, present = present)
 

Member Data Documentation

db

python.DQUtilities.IDBSDefectWriter.db

Definition at line 60 of file DQUtilities.py.

defect

python.DQUtilities.IDBSDefectWriter.defect

Definition at line 28 of file DQUtilities.py.

iovs

python.DQUtilities.IDBSDefectWriter.iovs

Definition at line 29 of file DQUtilities.py.

officialDb

python.DQUtilities.IDBSDefectWriter.officialDb

Definition at line 62 of file DQUtilities.py.

user

python.DQUtilities.IDBSDefectWriter.user

Definition at line 30 of file DQUtilities.py.

---

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

• DQUtilities.py