PayloadInformation Class Reference

Public Member Functions
	from_json (cls, payload, iov=None)
	__init__ (self, payload_id, name, revision, checksum, payload_url, base_url, iov_id=None, iov=None)
	url (self)
	__hash__ (self)
	__eq__ (self, other)
	__lt__ (self, other)
	readable_iov (self)

Public Attributes
	name = name
	name of the payload
	checksum = checksum
	checksum of the payload
tuple	iov = iov
	interval of validity
	revision = revision
	revision, not used for comparisons
	payload_id = payload_id
	payload id in CDB, not used for comparisons
	iov_id = iov_id
	iov id in CDB, not used for comparisons
	base_url = base_url
	base url
	payload_url = payload_url
	payload url

Detailed Description

Small container class to help compare payload information for efficient
comparison between globaltags

Definition at line 136 of file __init__.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			payload_id,
			name,
			revision,
			checksum,
			payload_url,
			base_url,
			iov_id = None,
			iov = None )

Create a new object from the given information

Definition at line 162 of file __init__.py.

    def __init__(self, payload_id, name, revision, checksum, payload_url, base_url, iov_id=None, iov=None):
        """
        Create a new object from the given information
        """
        
        self.name = name
        
        self.checksum = checksum
        
        self.iov = iov
        
        self.revision = revision
        
        self.payload_id = payload_id
        
        self.iov_id = iov_id
        
        self.base_url = base_url
        
        self.payload_url = payload_url
 

Member Function Documentation

__eq__()

__eq__	(		self,
			other )

Check if two payloads are equal

Definition at line 192 of file __init__.py.

    def __eq__(self, other):
        """Check if two payloads are equal"""
        return (self.name, self.checksum, self.iov) == (other.name, other.checksum, other.iov)
 

__hash__()

__hash__

(

self

)

Make object hashable

Definition at line 188 of file __init__.py.

    def __hash__(self):
        """Make object hashable"""
        return hash((self.name, self.checksum, self.iov))
 

__lt__()

__lt__	(		self,
			other )

Sort payloads by name, iov, revision

Definition at line 196 of file __init__.py.

    def __lt__(self, other):
        """Sort payloads by name, iov, revision"""
        return (self.name.lower(), self.iov, self.revision) < (other.name.lower(), other.iov, other.revision)
 

from_json()

from_json	(		cls,
			payload,
			iov = None )

Set all internal members from the json information of the payload and the iov.

Arguments:
    payload (dict): json information of the payload as returned by REST api
    iov (dict): json information of the iov as returned by REST api

Definition at line 141 of file __init__.py.

    def from_json(cls, payload, iov=None):
        """Set all internal members from the json information of the payload and the iov.
 
        Arguments:
            payload (dict): json information of the payload as returned by REST api
            iov (dict): json information of the iov as returned by REST api
        """
        if iov is None:
            iov = {"payloadIovId": None, "expStart": None, "runStart": None, "expEnd": None, "runEnd": None}
 
        return cls(
            payload['payloadId'],
            payload['basf2Module']['name'],
            payload['revision'],
            payload['checksum'],
            payload['payloadUrl'],
            payload['baseUrl'],
            iov['payloadIovId'],
            (iov["expStart"], iov["runStart"], iov["expEnd"], iov["runEnd"]),
        )
 

readable_iov()

readable_iov

(

self

)

return a human readable name for the IoV

Definition at line 200 of file __init__.py.

    def readable_iov(self):
        """return a human readable name for the IoV"""
        if self.iov is None:
            return "none"
 
        if self.iov == (0, 0, -1, -1):
            return "always"
 
        e1, r1, e2, r2 = self.iov
        if e1 == e2:
            if r1 == 0 and r2 == -1:
                return f"exp {e1}"
            elif r2 == -1:
                return f"exp {e1}, runs {r1}+"
            elif r1 == r2:
                return f"exp {e1}, run {r1}"
            else:
                return f"exp {e1}, runs {r1} - {r2}"
        else:
            if e2 == -1 and r1 == 0:
                return f"exp {e1} - forever"
            elif e2 == -1:
                return f"exp {e1}, run {r1} - forever"
            elif r1 == 0 and r2 == -1:
                return f"exp {e1}-{e2}, all runs"
            elif r2 == -1:
                return f"exp {e1}, run {r1} - exp {e2}, all runs"
            else:
                return f"exp {e1}, run {r1} - exp {e2}, run {r2}"
 
 

url()

url

(

self

)

Return the full url to the payload on the server

Definition at line 184 of file __init__.py.

    def url(self):
        """Return the full url to the payload on the server"""
        return urllib.parse.urljoin(self.base_url + '/', self.payload_url)
 

Member Data Documentation

base_url

base_url = base_url

base url

Definition at line 179 of file __init__.py.

checksum

checksum = checksum

checksum of the payload

Definition at line 169 of file __init__.py.

iov

iov = iov

interval of validity

Definition at line 171 of file __init__.py.

iov_id

iov_id = iov_id

iov id in CDB, not used for comparisons

Definition at line 177 of file __init__.py.

name

name = name

name of the payload

Definition at line 167 of file __init__.py.

payload_id

payload_id = payload_id

payload id in CDB, not used for comparisons

Definition at line 175 of file __init__.py.

payload_url

payload_url = payload_url

payload url

Definition at line 181 of file __init__.py.

revision

revision = revision

revision, not used for comparisons

Definition at line 173 of file __init__.py.

---

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

• framework/scripts/conditions_db/__init__.py