Public Member Functions
def	__init__ (self, url, debug=False)

def	columns (self, workspace, table)

def	count (self, workspace, table, filter=None, query=None, tag=None)

def	data (self, workspace, table, template, columns=None, filter=None, query=None, order=None, tag=None)

def	dprint (self, args)

def	get (self, parts, data=None)

def	report (self, workspace, report)

def	reports (self, workspace)

def	tables (self, workspace)

def	tags (self)

def	templates (self, workspace, table)

def	workspaces (self)

Public Attributes
	app

	debug

	url

Detailed Description

RR API object

Definition at line 47 of file rrapi.py.

Constructor & Destructor Documentation

◆ init()

def rrapi.RRApi.__init__	(	self,
		url,
		debug = `False`
	)

Construct API object.
url: URL to RRv3 API, i.e. http://localhost:8080/rr_user
debug: should debug messages be printed out? Verbose!

Definition at line 52 of file rrapi.py.

     def __init__(self, url, debug = False):
         """
         Construct API object.
         url: URL to RRv3 API, i.e. http://localhost:8080/rr_user
         debug: should debug messages be printed out? Verbose!
         """
         self.debug = debug
         self.url = re.sub("/*$", "/api/", url)
         self.app = self.get(["app"])
         self.dprint("app = ", self.app)
 

Member Function Documentation

◆ columns()

def rrapi.RRApi.columns	(	self,
		workspace,
		table
	)

Get columns for table for workspace (all apps)

Definition at line 140 of file rrapi.py.

     def columns(self, workspace, table):
         """
         Get columns for table for workspace (all apps)
         """
         return self.get([workspace, table, "columns"])
 

◆ count()

def rrapi.RRApi.count	(	self,
		workspace,
		table,
		filter = `None`,
		query = `None`,
		tag = `None`
	)

Get number of rows for table for workspace with filter, query (all apps) or tag (USER app only)

Definition at line 152 of file rrapi.py.

     def count(self, workspace, table, filter = None, query = None, tag = None):
         """
         Get number of rows for table for workspace with filter, query (all apps) or tag (USER app only)
         """
 
         #
         # Constructing request path
         #
 
         req = [ workspace, table ]
         if tag != None:
             if self.app != "user":
                 raise RRApiError("Tags are possible only in user app")
             else:
                 req.append(tag)
         req.append("count")
 
         #
         # Constructing filter/query payload
         #
 
         filters = {}
         if filter != None:
             filters['filter'] = filter
         if query != None:
             filters['query'] = query
 
         return int(self.get(req, filters))
 

◆ data()

def rrapi.RRApi.data	(	self,
		workspace,
		table,
		template,
		columns = `None`,
		filter = `None`,
		query = `None`,
		order = `None`,
		tag = `None`
	)

Get data for table for workspace with filter, query (all apps) or tag (USER app only)

Definition at line 181 of file rrapi.py.

     def data(self, workspace, table, template, columns = None, filter = None, query = None, order = None, tag = None):
         """
         Get data for table for workspace with filter, query (all apps) or tag (USER app only)
         """
 
         #
         # Check req parameters
         #
 
         if not isinstance(workspace, str):
             raise RRApiError("workspace parameter must be str")
 
         #
         # Constructing request path
         #
 
         req = [ workspace, table, template ]
         if columns != None:
             req.append(",".join(columns))
         else:
             req.append("all")
         if order != None:
             req.append(",".join(order))
         else:
             req.append("none")
         if tag != None:
             if self.app != "user":
                 raise RRApiError("Tags are possible only in user app")
             else:
                 req.append(tag)
         req.append("data")
 
         #
         # Constructing filter/query payload
         #
 
         filters = {}
         if filter != None:
             filters['filter'] = filter
         if query != None:
             filters['query'] = query
 
         return self.get(req, filters)
 

◆ dprint()

def rrapi.RRApi.dprint	(	self,
		args
	)

Print debug information

Definition at line 63 of file rrapi.py.

References HcalOfflineHarvesting.debug, PedestalTask.debug, QIE10Task.debug, QIE11Task.debug, RecHitTask.debug, UMNioTask.debug, ZDCTask.debug, HcalOnlineHarvesting.debug, HFRaddamTask.debug, LaserTask.debug, NoCQTask.debug, RawTask.debug, TPTask.debug, DigiTask.debug, LEDTask.debug, DTDigiToRawModule.debug, CSCRPCData.debug, CSCTMBScope.debug, DTDigiToRaw.debug, ALIUtils.debug, crabFunctions.CrabController.debug, DTSegmentsTask.debug, DTOccupancyEfficiency.debug, CSCGEMData.debug, DTTTrigCorrectionFirst.debug, DTDDUUnpacker.debug, pkg.AbstractPkg.debug, CSCDCCEventData.debug, DTT0CalibrationRMS.debug, DTTTrigWriter.debug, DTTPDeadWriter.debug, TritonService::FallbackOpts.debug, PPSAlignmentConfigurationESSource.debug, DTOccupancyPoint.debug, DTNoiseComputation.debug, DTROS25Unpacker.debug, util.rrapi.RRApi.debug, rrapi.RRApi.debug, DTT0Calibration.debug, DTTTrigSyncT0Only.debug, DTEfficiencyTask.debug, PythiaFilterEMJetHeep.debug, DTTTrigCalibration.debug, CSCDDUEventData.debug, DTRunConditionVar.debug, DTChamberEfficiencyTask.debug, HCALResponse.debug, DTChamberEfficiency.debug, FCDTask.debug, CSCDCCUnpacker.debug, CSCComparatorData.debug, DTTMax.debug, DTVDriftCalibration.debug, DTTTrigSyncFromDB.debug, CSCTMBData.debug, DTTTrigSyncTOFCorr.debug, CSCEventData.debug, BaseParticlePropagator.debug, CSCTMBHeader.debug, CSCALCTTrailer.debug, notcub::CachingHostAllocator.debug, notcub::CachingDeviceAllocator.debug, CSCALCTHeader.debug, crabFunctions.CrabTask.debug, Pythia8::PowhegHooksBB4L.debug, HltDiff.debug, and print().

Referenced by rrapi.RRApi.get().

     def dprint(self, *args):
         """
         Print debug information
         """
         if self.debug: 
             print("RRAPI:", end=' ')
             for arg in args:
                 print(arg, end=' ') 
             print()
 

◆ get()

def rrapi.RRApi.get	(	self,
		parts,
		data = `None`
	)

General API call (do not use it directly!)

Definition at line 73 of file rrapi.py.

References HcalOfflineHarvesting.debug, HcalOnlineHarvesting.debug, HFRaddamTask.debug, LaserTask.debug, NoCQTask.debug, PedestalTask.debug, QIE10Task.debug, QIE11Task.debug, RecHitTask.debug, UMNioTask.debug, ZDCTask.debug, RawTask.debug, TPTask.debug, DigiTask.debug, LEDTask.debug, DTDigiToRawModule.debug, CSCRPCData.debug, DTDigiToRaw.debug, CSCTMBScope.debug, ALIUtils.debug, crabFunctions.CrabController.debug, DTSegmentsTask.debug, DTOccupancyEfficiency.debug, CSCGEMData.debug, pkg.AbstractPkg.debug, DTTTrigCorrectionFirst.debug, DTDDUUnpacker.debug, CSCDCCEventData.debug, DTTTrigWriter.debug, DTT0CalibrationRMS.debug, DTTPDeadWriter.debug, TritonService::FallbackOpts.debug, PPSAlignmentConfigurationESSource.debug, DTOccupancyPoint.debug, DTNoiseComputation.debug, DTROS25Unpacker.debug, util.rrapi.RRApi.debug, rrapi.RRApi.debug, DTT0Calibration.debug, DTTTrigSyncT0Only.debug, DTEfficiencyTask.debug, PythiaFilterEMJetHeep.debug, DTTTrigCalibration.debug, CSCDDUEventData.debug, DTRunConditionVar.debug, DTChamberEfficiencyTask.debug, HCALResponse.debug, FCDTask.debug, DTChamberEfficiency.debug, CSCDCCUnpacker.debug, CSCComparatorData.debug, DTTMax.debug, DTVDriftCalibration.debug, DTTTrigSyncFromDB.debug, CSCTMBData.debug, DTTTrigSyncTOFCorr.debug, CSCEventData.debug, BaseParticlePropagator.debug, CSCTMBHeader.debug, CSCALCTTrailer.debug, notcub::CachingHostAllocator.debug, notcub::CachingDeviceAllocator.debug, CSCALCTHeader.debug, crabFunctions.CrabTask.debug, Pythia8::PowhegHooksBB4L.debug, HltDiff.debug, DeadROC_duringRun.dir, util.rrapi.RRApi.dprint(), rrapi.RRApi.dprint(), join(), submitPVValidationJobs.split(), str, rrapi.RRApiError.url, util.rrapi.RRApiError.url, rrapi.RRApi.url, util.rrapi.RRApi.url, LumiList.LumiList.url, and TritonService::Server.url.

Referenced by Options.Options.__getitem__(), betterConfigParser.BetterConfigParser.__updateDict(), submitPVValidationJobs.BetterConfigParser.__updateDict(), rrapi.RRApi.columns(), rrapi.RRApi.count(), rrapi.RRApi.data(), betterConfigParser.BetterConfigParser.getCompares(), betterConfigParser.BetterConfigParser.getGeneral(), betterConfigParser.BetterConfigParser.getResultingSection(), submitPVValidationJobs.BetterConfigParser.getResultingSection(), rrapi.RRApi.report(), rrapi.RRApi.reports(), rrapi.RRApi.tables(), rrapi.RRApi.tags(), rrapi.RRApi.templates(), and rrapi.RRApi.workspaces().

     def get(self, parts, data = None):
         """
         General API call (do not use it directly!)
         """
 
         #
         # Constructing request path
         #
 
         callurl = self.url + "/".join(urllib.quote(p) for p in parts)
 
         #
         # Constructing data payload
         #
 
         sdata = None
         if data != None:
             sdata = json.dumps(data)
 
         #
         # Do the query and respond
         #
 
         self.dprint(callurl, "with payload", sdata)
 
         resp = urllib.urlopen(callurl, sdata)
 
         has_getcode = "getcode" in dir(resp)
         if self.debug: 
             if has_getcode:
                 self.dprint("Response", resp.getcode(), " ".join(str(resp.info()).split("\r\n")))
             else:
                 self.dprint("Response", " ".join(str(resp.info()).split("\r\n")))
 
         if not has_getcode or resp.getcode() == 200:
             rdata = resp.read()
             if re.search("json", resp.info().gettype()):
                 try:
                     return json.loads(rdata)
                 except TypeError as e:
                     self.dprint(e)
                     return rdata
             else:
                 return rdata
         else:
             raise RRApiError(resp)
 

◆ report()

def rrapi.RRApi.report	(	self,
		workspace,
		report
	)

Get report data (USER app only)

Definition at line 233 of file rrapi.py.

     def report(self, workspace, report):
         """
         Get report data (USER app only)
         """
         if self.app != "user":
             raise RRApiError("Reports available only in user app")
         return self.get([workspace, report, "data"])
 
 

◆ reports()

def rrapi.RRApi.reports	(	self,
		workspace
	)

Get available reports (USER app only)

Definition at line 225 of file rrapi.py.

     def reports(self, workspace):
         """
         Get available reports (USER app only)
         """
         if self.app != "user":
             raise RRApiError("Reports available only in user app")
         return self.get([workspace, "reports"])
     

◆ tables()

def rrapi.RRApi.tables	(	self,
		workspace
	)

Get tables for workspace (all apps)

Definition at line 134 of file rrapi.py.

     def tables(self, workspace):
         """
         Get tables for workspace (all apps)
         """
         return self.get([workspace, "tables"])
 

◆ tags()

def rrapi.RRApi.tags ( self )

Get version tags (USER app only)

Definition at line 120 of file rrapi.py.

     def tags(self):
         """
         Get version tags (USER app only)
         """
         if self.app != "user":
             raise RRApiError("Tags call is possible only in user app")
         return self.get(["tags"])
 

◆ templates()

def rrapi.RRApi.templates	(	self,
		workspace,
		table
	)

Get output templates for table for workspace (all apps)

Definition at line 146 of file rrapi.py.

     def templates(self, workspace, table):
         """
         Get output templates for table for workspace (all apps)
         """
         return self.get([workspace, table, "templates"])
 

◆ workspaces()

def rrapi.RRApi.workspaces ( self )

Get workspaces (all apps)

Definition at line 128 of file rrapi.py.

     def workspaces(self):
         """
         Get workspaces (all apps)
         """
         return self.get(["workspaces"])
 

Member Data Documentation

◆ app

rrapi.RRApi.app

Definition at line 60 of file rrapi.py.

Referenced by rrapi.RRApi.count(), rrapi.RRApi.data(), rrapi.RRApi.report(), rrapi.RRApi.reports(), and rrapi.RRApi.tags().

◆ debug

rrapi.RRApi.debug

Definition at line 58 of file rrapi.py.

Referenced by rrapi.RRApi.dprint(), rrapi.RRApi.get(), runTauIdMVA.TauIDEmbedder.loadMVA_WPs_run2_2017(), and runTauIdMVA.TauIDEmbedder.runTauID().

◆ url

rrapi.RRApi.url

Definition at line 59 of file rrapi.py.