Utilities Namespace Reference

Namespaces
	ReleaseScripts

Classes
class	TestModuleCommand

Functions
def	_build_options (args)
def	convertToSingleModuleEndPaths (process)
def	convertToUnscheduled (proc)
def	createTaskWithAllProducersAndFilters (process)
def	getHltConfiguration (menu, args)
def	ignoreAllFiltersOnPath (path)
def	loadHltConfiguration (process, menu, args)
def	moduleLabelsInSequences (sequences)
def	modulesInSequences (sequences)

Variables
	__lastCallUnary
	_levelInTasks
	loadHltConfiguration
	onTask
	operator

Function Documentation

_build_options()

def Utilities._build_options (   args )

private

Definition at line 6 of file Utilities.py.

Referenced by getHltConfiguration(), and loadHltConfiguration().

def _build_options(**args):
    options = _options.HLTProcessOptions()
    for key, val in args.items():
        setattr(options, key, val)
    return options

convertToSingleModuleEndPaths()

def Utilities.convertToSingleModuleEndPaths

(

process

)

Remove the EndPaths in the Process with more than one module
and replace with new EndPaths each with only one module.

Definition at line 69 of file Utilities.py.

References mps_monitormerge.items.

Referenced by Utilities.TestModuleCommand.testConvertToSingleModuleEndPaths().

def convertToSingleModuleEndPaths(process):
    """Remove the EndPaths in the Process with more than one module
    and replace with new EndPaths each with only one module.
    """
    import FWCore.ParameterSet.Config as cms
    toRemove =[]
    added = []
    for n,ep in process.endpaths_().items():
        tsks = []
        ep.visit(cms.TaskVisitor(tsks))

        names = ep.moduleNames()
        if 1 == len(names):
            continue
        toRemove.append(n)
        for m in names:
            epName = m+"_endpath"
            setattr(process,epName,cms.EndPath(getattr(process,m),*tsks))
            added.append(epName)

    s = process.schedule_()
    if s:
        pathNames = [p.label_() for p in s]
        for rName in toRemove:
            pathNames.remove(rName)
        for n in added:
            pathNames.append(n)
        newS = cms.Schedule(*[getattr(process,n) for n in pathNames])
        if s._tasks:
          newS.associate(*s._tasks)
        process.setSchedule_(newS)

    for r in toRemove:
        delattr(process,r)

convertToUnscheduled()

def Utilities.convertToUnscheduled

(

proc

)

Definition at line 46 of file Utilities.py.

References print().

def convertToUnscheduled(proc):
  print("covertToUnscheduled is deprecated and no longer needed, and will be removed soon. Please update your configuration.")
  return proc

createTaskWithAllProducersAndFilters()

def Utilities.createTaskWithAllProducersAndFilters

(

process

)

Definition at line 62 of file Utilities.py.

Referenced by Utilities.TestModuleCommand.testCreateTaskWithAllProducersAndFilters().

def createTaskWithAllProducersAndFilters(process):
  from FWCore.ParameterSet.Config import Task

  l = [ p for p in process.producers.values()]
  l.extend( (f for f in process.filters.values()) )
  return Task(*l)

getHltConfiguration()

def Utilities.getHltConfiguration	(		menu,
			args
	)

Definition at line 13 of file Utilities.py.

References _build_options(), and GCP_Ntuples_cfg.dump.

def getHltConfiguration(menu, **args):
    args['menu'] = menu
    args['fragment'] = False
    options = _build_options(**args)

    try:
        foo = {'process': None}
        exec(_confdb.HLTProcess(options).dump(), globals(), foo)
        process = foo['process']
    except:
        raise Exception(f'query to ConfDB failed (output is not a valid python file)\n  args={args}')

    if not isinstance(process, cms.Process):
        raise Exception(f'query to ConfDB did not return a valid HLT menu (cms.Process not found)\n  args={args}')

    return process

ignoreAllFiltersOnPath()

def Utilities.ignoreAllFiltersOnPath

(

path

)

Given a 'Path', find all EDFilters and wrap them in 'cms.ignore'

Definition at line 2 of file Utilities.py.

References submitPVValidationJobs.__init__(), and default_text_conditions_cfi.object.

def ignoreAllFiltersOnPath(path):
  """Given a 'Path', find all EDFilters and wrap them in 'cms.ignore'
  """
  import FWCore.ParameterSet.Config as cms
  from FWCore.ParameterSet.SequenceTypes import _MutatingSequenceVisitor, _UnarySequenceOperator

  class IgnoreFilters(object):
    def __init__(self):
      self.__lastCallUnary = False
      self.onTask = False
    def __call__(self, obj):
      if self.onTask:
        return obj
      elif isinstance(obj,_UnarySequenceOperator):
        self.__lastCallUnary = True
      elif obj.isLeaf() and isinstance(obj, cms.EDFilter) and not self.__lastCallUnary:
        return cms.ignore(obj)
      else:
        self.__lastCallUnary = False
      return obj
  class IgnoreFiltersVisitor(_MutatingSequenceVisitor):
    def __init__(self):
      self.operator = IgnoreFilters()
      self._levelInTasks = 0
      super(type(self),self).__init__(self.operator)
    def enter(self,visitee):
      if isinstance(visitee, cms.Task):
        self._levelInTasks += 1
      self.operator.onTask = (self._levelInTasks > 0)
      super(IgnoreFiltersVisitor,self).enter(visitee)
    def leave(self,visitee):
      if self._levelInTasks > 0:
        if isinstance(visitee, cms.Task):
          self._levelInTasks -= 1
      super(IgnoreFiltersVisitor,self).leave(visitee)

  mutator = IgnoreFiltersVisitor()
  path.visit(mutator)
  if mutator._didApply():
    path._seq = mutator.result(path)[0]
    path._tasks.clear()
    path.associate(*mutator.result(path)[1])
  return path

loadHltConfiguration()

def Utilities.loadHltConfiguration	(		process,
			menu,
			args
	)

Definition at line 31 of file Utilities.py.

References _build_options(), GCP_Ntuples_cfg.dump, and loadHltConfiguration.

def loadHltConfiguration(process, menu, **args):
    args['menu'] = menu
    args['fragment'] = True
    options = _build_options(**args)

    try:
        hlt = {'fragment': None}
        exec(_confdb.HLTProcess(options).dump(), globals(), hlt)
        process2 = hlt['fragment']
    except:
        raise Exception(f'query to ConfDB failed (output is not a valid python file)\n  args={args}')

    if not isinstance(process2, cms.Process):
        raise Exception(f'query to ConfDB did not return a valid HLT menu (cms.Process not found)\n  args={args}')

    process.extend( process2 )

    return process

moduleLabelsInSequences()

def Utilities.moduleLabelsInSequences

(

sequences

)

Definition at line 59 of file Utilities.py.

References modulesInSequences().

def moduleLabelsInSequences(* sequences):
  return [module.label_() for module in modulesInSequences(* sequences)]

modulesInSequences()

def Utilities.modulesInSequences

(

sequences

)

Definition at line 51 of file Utilities.py.

Referenced by moduleLabelsInSequences().

def modulesInSequences(* sequences):
  from FWCore.ParameterSet.SequenceTypes import ModuleNodeVisitor
  modules = []
  for sequence in sequences:
    sequence.visit(ModuleNodeVisitor(modules))
  return modules

Variable Documentation

__lastCallUnary

Utilities.__lastCallUnary

private

Definition at line 10 of file Utilities.py.

_levelInTasks

Utilities._levelInTasks

private

Definition at line 25 of file Utilities.py.

loadHltConfiguration

Utilities.loadHltConfiguration

Definition at line 52 of file Utilities.py.

Referenced by loadHltConfiguration().

onTask

Utilities.onTask

Definition at line 11 of file Utilities.py.

operator

Utilities.operator

Definition at line 24 of file Utilities.py.

Referenced by AlcaBeamMonitorClient.AlcaBeamMonitorClient(), SiStripCalibLorentzAngle.algoBeginJob(), SiStripGainFromCalibTree.algoEndJob(), BeamConditionsMonitor.BeamConditionsMonitor(), BeamMonitorBx.BeamMonitorBx(), PFDQMEventSelector.beginJob(), DQMMessageLoggerClient.beginJob(), DQMFEDIntegrityClient.beginJob(), DQMOfflineHLTEventInfoClient.beginJob(), GenericBenchmarkAnalyzer.beginJob(), LaserDQM.beginJob(), DQMLumiMonitor.beginJob(), PFTester.beginJob(), StripValidationPlots.beginJob(), SiPixelDQMRocLevelAnalyzer.beginJob(), TestSuite.beginJob(), DQMDaqInfo.beginJob(), FourVectorHLT.beginJob(), DQMStoreStats.beginJob(), SiStripLAProfileBooker.beginRun(), SiStripCommissioningSource.beginRun(), SiStripDigiValid.bookHistograms(), TrackingTruthValid.bookHistograms(), SiPixelDigiValid.bookHistograms(), TrackerHitAnalyzer.bookHistograms(), TkConvValidator.bookHistograms(), SiPixelTrackingRecHitsValid.bookHistograms(), ConversionPostprocessing.ConversionPostprocessing(), SiStripCommissioningOfflineDbClient.createHistos(), CSCDCCUnpacker.CSCDCCUnpacker(), DAQSource.DAQSource(), TrackerOfflineValidation::DirectoryWrapper.DirectoryWrapper(), DQMEDHarvester.DQMEDHarvester(), Phase2OTHarvestTrackingParticles.dqmEndJob(), DQMGenericClient.dqmEndRun(), HLTGenValClient.dqmEndRun(), DQMGlobalEDAnalyzerBase< dtsegment2dsl::Histograms, Args... >.DQMGlobalEDAnalyzerBase(), DTnoiseDBValidation.DTnoiseDBValidation(), DTt0DBValidation.DTt0DBValidation(), EcalBarrelMonitorDbModule.EcalBarrelMonitorDbModule(), EgHLTOfflineSummaryClient.EgHLTOfflineSummaryClient(), APVValidationPlots.endJob(), SiStripApvGainInspector.endJob(), EDMtoMEConverter.endLuminosityBlockProduce(), MEtoEDMConverter.endLuminosityBlockProduce(), DQMRivetClient.endRun(), DQMGenericTnPClient.endRun(), EDMtoMEConverter.endRunProduce(), MEtoEDMConverter.endRunProduce(), ESDaqInfoTask.ESDaqInfoTask(), ESDataCertificationTask.ESDataCertificationTask(), ESDcsInfoTask.ESDcsInfoTask(), FedRawDataInputSource.FedRawDataInputSource(), SiStripQualityDQM.fillGrandSummaryMEs(), FourVectorHLT.FourVectorHLT(), GenFilterEfficiencyProducer.GenFilterEfficiencyProducer(), FWEvePtr< T >.get(), SiStripCablingDQM.getActiveDetIds(), GlobalHitsProdHistStripper.GlobalHitsProdHistStripper(), GlobalMuonMatchAnalyzer.GlobalMuonMatchAnalyzer(), HLTInclusiveVBFClient.HLTInclusiveVBFClient(), HLTOverallSummary.HLTOverallSummary(), HLTPrescaler.HLTPrescaler(), HLTPrescaleRecorder.HLTPrescaleRecorder(), HLTScalersClient.HLTScalersClient(), DQMFEDIntegrityClient.initialize(), DQMOfflineHLTEventInfoClient.initialize(), SiStripBadAPVandHotStripAlgorithmFromClusterOccupancy.initializeDQMHistograms(), L1ScalersClient.L1ScalersClient(), cond::persistency::PayloadProxy< cond::persistency::KeyList >.loadPayload(), TkHistoMap.loadServices(), SiStripFedCablingBuilderFromDb.make(), MonitorElementsDb.MonitorElementsDb(), MuonTrackAnalyzer.MuonTrackAnalyzer(), MuonTrackResidualAnalyzer.MuonTrackResidualAnalyzer(), NoiseTask.NoiseTask(), funct::RootIntegrator.operator()(), EncodedTruthId.operator<(), EncodedTruthId.operator==(), PedsOnlyTask.PedsOnlyTask(), PFJetBenchmarkAnalyzer.PFJetBenchmarkAnalyzer(), PFMETBenchmarkAnalyzer.PFMETBenchmarkAnalyzer(), PFTauElecRejectionBenchmarkAnalyzer.PFTauElecRejectionBenchmarkAnalyzer(), PhotonPostprocessing.PhotonPostprocessing(), evf::FastMonitoringService.preBeginJob(), BuildTrackerMapPlugin.read(), DQMRootSource.readElements(), recoBSVTagInfoValidationAnalyzer.recoBSVTagInfoValidationAnalyzer(), RecoDisplacedMuonValidator.RecoDisplacedMuonValidator(), RecoMuonValidator.RecoMuonValidator(), SiStripClassToMonitorCondData.save(), dqm::DQMFileSaverPB.saveLumi(), SiPixelFolderOrganizer.SiPixelFolderOrganizer(), SiStripFolderOrganizer.SiStripFolderOrganizer(), SiStripGainFromCalibTree.SiStripGainFromCalibTree(), SiStripGainFromData.SiStripGainFromData(), StatisticsFilter.StatisticsFilter(), TrackEfficiencyMonitor.TrackEfficiencyMonitor(), and TrackerOfflineValidationSummary.TrackerOfflineValidationSummary().