Public Member Functions
	__init__ (self, line, basedir)

	normalize (self, name=None, root_version=61408)

	checksum (self)

	__repr__ (self)

	__eq__ (self, other)

	__le__ (self, other)

	__lt__ (self, other)

	__hash__ (self)

	iov_tuple (self)

	iov_str (self)

Public Attributes
	revision = revision
	revision stored in the file

	module = name.split("/")[1]
	module name

	filename = os.path.join(basedir, f"dbstore_{self.module}_rev_{self.revision}.root")
	filename

dict	firstRun = {"exp": iov[0], "run": iov[1]}
	experiment/run of the first run

dict	finalRun = {"exp": iov[2], "run": iov[3]}
	experiment/run of the final run

	payload = None
	payload id, to be filled later

	iov = None
	iov id, to be filled later

Private Attributes
	__checksum = None
	variable for checksum, calculated on first access

tuple	__id = (self.module,) + tuple(iov)
	object to uniquely identify this entry (payload + iov)

Detailed Description

Class to keep information about an entry in the testing payloads storage file

Definition at line 25 of file testing_payloads.py.

Constructor & Destructor Documentation

◆ init()

__init__	(	self,
		line,
		basedir )

Create new entry from line in testing payloads storage file

Definition at line 28 of file testing_payloads.py.

    def __init__(self, line, basedir):
        """Create new entry from line in testing payloads storage file"""
        try:
            name, revision, iov = line.split()
        except ValueError:
            raise ValueError("line must be of the form 'dbstore/<payloadname> <revision> "
                             "<firstExp>,<firstRun>,<finalExp>,<finalRun>'")
 
        
        self.revision = revision
 
        try:
            
            self.module = name.split("/")[1]
        except IndexError:
            raise ValueError("payload name must be of the form dbstore/<payloadname>")
 
        try:
            iov = [int(e) for e in iov.split(",")]
        except ValueError:
            raise ValueError("experiment and run numbers must be integers")
 
        if len(iov) != 4:
            raise ValueError("IoV needs to be four values (firstExp,firstRun,finalExp,finalRun)")
 
        
        self.filename = os.path.join(basedir, f"dbstore_{self.module}_rev_{self.revision}.root")
        
        self.firstRun = {"exp": iov[0], "run": iov[1]}
        
        self.finalRun = {"exp": iov[2], "run": iov[3]}
        
        self.__checksum = None
        
        self.__id = (self.module,) + tuple(iov)
        
        self.payload = None
        
        self.iov = None
 

Member Function Documentation

◆ eq()

__eq__	(		self,
			other )

Compare to other entries, only consider package, module and iov for equality

Definition at line 84 of file testing_payloads.py.

    def __eq__(self, other):
        """Compare to other entries, only consider package, module and iov for equality"""
        return self.__id == other.__id
 

◆ hash()

__hash__ ( self )

Provide hash function to be able to create a set

Definition at line 96 of file testing_payloads.py.

    def __hash__(self):
        """Provide hash function to be able to create a set"""
        return hash(self.__id)
 

◆ le()

__le__	(		self,
			other )

Compare to other entries, only consider package, module and iov for equality

Definition at line 88 of file testing_payloads.py.

    def __le__(self, other):
        """Compare to other entries, only consider package, module and iov for equality"""
        return self.__id <= other.__id
 

◆ lt()

__lt__	(		self,
			other )

Compare to other entries, only consider package, module and iov for equality

Definition at line 92 of file testing_payloads.py.

    def __lt__(self, other):
        """Compare to other entries, only consider package, module and iov for equality"""
        return self.__id < other.__id
 

◆ repr()

__repr__ ( self )

Convert to useful string representation

Definition at line 80 of file testing_payloads.py.

    def __repr__(self):
        """Convert to useful string representation"""
        return repr(self.__id + (self.filename,))
 

◆ checksum()

checksum ( self )

Return checksum, calculated on first access

Definition at line 74 of file testing_payloads.py.

    def checksum(self):
        """Return checksum, calculated on first access"""
        if self.__checksum is None:
            self.__checksum = file_checksum(self.filename)
        return self.__checksum
 

◆ iov_str()

iov_str ( self )

String representation of IoV

Definition at line 105 of file testing_payloads.py.

    def iov_str(self):
        """String representation of IoV"""
        return f"{self.firstRun['exp']}/{self.firstRun['run']} - {self.finalRun['exp']}/{self.finalRun['run']}"
 
 

◆ iov_tuple()

iov_tuple ( self )

Return a tuple with the valid exp,run range

Definition at line 101 of file testing_payloads.py.

    def iov_tuple(self):
        """Return a tuple with the valid exp,run range"""
        return self.firstRun['exp'], self.firstRun['run'], self.finalRun['exp'], self.finalRun['run']
 

◆ normalize()

normalize	(	self,
		name = None,
		root_version = 61408 )

Normalize the root file to have the same checksum for the same content

Definition at line 68 of file testing_payloads.py.

    def normalize(self, name=None, root_version=61408):
        """Normalize the root file to have the same checksum for the same content"""
        normalize_file(self.filename, in_place=True, name=name, root_version=root_version)
        self.__checksum = file_checksum(self.filename)
 

Member Data Documentation

◆ __checksum

__checksum = None

private

variable for checksum, calculated on first access

Definition at line 60 of file testing_payloads.py.

◆ __id

__id = (self.module,) + tuple(iov)

private

object to uniquely identify this entry (payload + iov)

Definition at line 62 of file testing_payloads.py.

◆ filename

filename = os.path.join(basedir, f"dbstore_{self.module}_rev_{self.revision}.root")

filename

Definition at line 54 of file testing_payloads.py.

◆ finalRun

dict finalRun = {"exp": iov[2], "run": iov[3]}

experiment/run of the final run

Definition at line 58 of file testing_payloads.py.

◆ firstRun

dict firstRun = {"exp": iov[0], "run": iov[1]}

experiment/run of the first run

Definition at line 56 of file testing_payloads.py.

◆ iov

iov = None

iov id, to be filled later

Definition at line 66 of file testing_payloads.py.

◆ module

module = name.split("/")[1]

module name

Definition at line 41 of file testing_payloads.py.

◆ payload

payload = None

payload id, to be filled later

Definition at line 64 of file testing_payloads.py.

◆ revision

revision = revision

revision stored in the file

Definition at line 37 of file testing_payloads.py.

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

framework/scripts/conditions_db/testing_payloads.py

Public Member Functions

Public Attributes

Private Attributes