SequenceTypes.Task Class Reference

Inheritance diagram for SequenceTypes.Task:

Public Member Functions
def	__init__ (self, items)
def	__iter__ (self)
def	__repr__ (self)
def	__setattr__ (self, name, value)
def	__str__ (self)
def	add (self, items)
def	contains (self, mod)
def	copy (self)
def	copyAndExclude (self, listOfModulesToExclude)
def	dumpPython (self, options=PrintOptions())
def	dumpPythonNoNewline (self, options=PrintOptions())
def	expandAndClone (self)
def	fillContents (self, taskContents, options=PrintOptions())
def	isLeaf (self)
def	moduleNames (self)
def	remove (self, something)
def	replace (self, original, replacement)
def	resolve (self, processDict, keepIfCannotResolve=False)
def	visit (self, visitor)
Public Member Functions inherited from Mixins._Labelable
def	__str__ (self)
def	dumpSequenceConfig (self)
def	dumpSequencePython (self, options=PrintOptions())
def	hasLabel_ (self)
def	label (self)
def	label_ (self)
def	setLabel (self, label)

Private Member Functions
def	_errorstr (self)
def	_isTaskComponent (self)
def	_place (self, name, proc)

Private Attributes
	_collection

Detailed Description

Holds EDProducers, EDFilters, ESProducers, ESSources, Services, and Tasks.
A Task can be associated with Sequences, Paths, EndPaths and the Schedule.
An EDProducer or EDFilter will be enabled to run unscheduled if it is on
a task associated with the Schedule or any scheduled Path or EndPath (directly
or indirectly through Sequences) and not be on any scheduled Path or EndPath.
ESSources, ESProducers, and Services will be enabled to run if they are on
a Task associated with the Schedule or a scheduled Path or EndPath.  In other
cases, they will be enabled to run if and only if they are not on a Task attached
to the process.

Definition at line 1269 of file SequenceTypes.py.

Constructor & Destructor Documentation

def SequenceTypes.Task.__init__	(		self,
			items
	)

Definition at line 1281 of file SequenceTypes.py.

    def __init__(self, *items):
        self._collection = OrderedSet()
        self.add(*items)

Member Function Documentation

def SequenceTypes.Task.__iter__

(

self

)

Definition at line 1352 of file SequenceTypes.py.

References SequenceTypes._SequenceCollection._collection, and SequenceTypes.Task._collection.

    def __iter__(self):
        for key in self._collection:
            yield key

def SequenceTypes.Task.__repr__

(

self

)

Definition at line 1367 of file SequenceTypes.py.

References str.

    def __repr__(self):
        s = str(self)
        return "cms."+type(self).__name__+'('+s+')\n'

def SequenceTypes.Task.__setattr__	(		self,
			name,
			value
	)

Definition at line 1285 of file SequenceTypes.py.

Referenced by GenObject.GenObject.setValue().

    def __setattr__(self,name,value):
        if not name.startswith("_"):
            raise AttributeError("You cannot set parameters for Task objects.")
        else:
            self.__dict__[name] = value

def SequenceTypes.Task.__str__

(

self

)

Definition at line 1356 of file SequenceTypes.py.

References SequenceTypes._ModuleSequenceType.visit(), and SequenceTypes.Task.visit().

    def __str__(self):
        l = []
        v = ModuleNodeVisitor(l)
        self.visit(v)
        s = ''
        for i in l:
            if s:
                s += ', '
            s += str (i)
        return s

def SequenceTypes.Task._errorstr (   self )

private

Definition at line 1349 of file SequenceTypes.py.

    def _errorstr(self):
        return "Task(...)"

def SequenceTypes.Task._isTaskComponent (   self )

private

Definition at line 1336 of file SequenceTypes.py.

    def _isTaskComponent(self):
        return True

def SequenceTypes.Task._place (   self,   name,   proc  )

private

Definition at line 1299 of file SequenceTypes.py.

    def _place(self, name, proc):
        proc._placeTask(name,self)

def SequenceTypes.Task.add	(		self,
			items
	)

Definition at line 1291 of file SequenceTypes.py.

Referenced by counter.Counter.register(), SequenceTypes.Task.remove(), and SequenceTypes.Task.replace().

    def add(self, *items):
        for item in items:
            if not isinstance(item, _ConfigureComponent) or not item._isTaskComponent():
                if not isinstance(item, TaskPlaceholder):
                    raise RuntimeError("Adding an entry of type '" + type(item).__name__ + "'to a Task.\n"
                                       "It is illegal to add this type to a Task.")
            self._collection.add(item)

def SequenceTypes.Task.contains	(		self,
			mod
	)

Definition at line 1377 of file SequenceTypes.py.

References SequenceTypes._ModuleSequenceType.visit(), and SequenceTypes.Task.visit().

Referenced by LumiList.LumiList.__contains__().

    def contains(self, mod):
        visitor = ContainsModuleVisitor(mod)
        self.visit(visitor)
        return visitor.result()

def SequenceTypes.Task.copy

(

self

)

Definition at line 1381 of file SequenceTypes.py.

References SequenceTypes._SequenceCollection._collection, and SequenceTypes.Task._collection.

    def copy(self):
        return Task(*self._collection)

def SequenceTypes.Task.copyAndExclude	(		self,
			listOfModulesToExclude
	)

Returns a copy of the sequence which excludes those module in 'listOfModulesToExclude'

Definition at line 1383 of file SequenceTypes.py.

References SequenceTypes._ModuleSequenceType.visit(), and SequenceTypes.Task.visit().

    def copyAndExclude(self,listOfModulesToExclude):
        """Returns a copy of the sequence which excludes those module in 'listOfModulesToExclude'"""
        # You can exclude instances of these types EDProducer, EDFilter, ESSource, ESProducer,
        # Service, or Task.
        # Mostly this is very intuitive, but there are some complications in cases
        # where objects that contain other objects are involved. See the comments
        # for the _MutatingSequenceVisitor.
        for i in listOfModulesToExclude:
            if not i._isTaskComponent():
                raise TypeError("copyAndExclude can only exclude objects that can be placed on a Task")
        v = _CopyAndExcludeSequenceVisitor(listOfModulesToExclude)
        self.visit(v)
        return Task(*v.result(self))

def SequenceTypes.Task.dumpPython	(		self,
			options = PrintOptions()
	)

Definition at line 1313 of file SequenceTypes.py.

References SequenceTypes._ModuleSequenceType.dumpPythonNoNewline(), and SequenceTypes.Task.dumpPythonNoNewline().

    def dumpPython(self, options=PrintOptions()):
        s = self.dumpPythonNoNewline(options)
        return s + "\n"

def SequenceTypes.Task.dumpPythonNoNewline	(		self,
			options = PrintOptions()
	)

Returns a string which is the python representation of the object

Definition at line 1317 of file SequenceTypes.py.

References SequenceTypes._SequenceCollection._collection, and SequenceTypes.Task._collection.

Referenced by SequenceTypes.Task.dumpPython().

    def dumpPythonNoNewline(self, options=PrintOptions()):
        """Returns a string which is the python representation of the object"""
        taskContents = set()
        for i in self._collection:
            if isinstance(i, Task):
                i.fillContents(taskContents, options)
            else:
                taskContents.add(i.dumpSequencePython(options))
        s=''
        iFirst = True
        for item in sorted(taskContents):
            if not iFirst:
                s += ", "
            iFirst = False
            s += item
        if len(taskContents) > 255:
            return "cms.Task(*[" + s + "])"
        return "cms.Task(" + s + ")"

def SequenceTypes.Task.expandAndClone

(

self

)

Definition at line 1396 of file SequenceTypes.py.

References SequenceTypes._ModuleSequenceType.visit(), and SequenceTypes.Task.visit().

    def expandAndClone(self):
        # Name of this function is not very good. It makes a shallow copy with all
        # the subTasks flattened out (removed), but keeping all the
        # modules that were in those subTasks as well as the top level
        # ones.
        l = []
        v = ModuleNodeVisitor(l)
        self.visit(v)
        return Task(*l)

def SequenceTypes.Task.fillContents	(		self,
			taskContents,
			options = PrintOptions()
	)

Definition at line 1302 of file SequenceTypes.py.

References SequenceTypes._SequenceCollection._collection, SequenceTypes.Task._collection, and Mixins._Labelable.hasLabel_().

    def fillContents(self, taskContents, options=PrintOptions()):
        # only dump the label, if possible
        if self.hasLabel_():
            taskContents.add(_Labelable.dumpSequencePython(self, options))
        else:
            for i in self._collection:
                if isinstance(i, Task):
                    i.fillContents(taskContents, options)
                else:
                    taskContents.add(i.dumpSequencePython(options))

def SequenceTypes.Task.isLeaf

(

self

)

Definition at line 1339 of file SequenceTypes.py.

    def isLeaf(self):
        return False

def SequenceTypes.Task.moduleNames

(

self

)

Returns a set containing the names of all modules being used

Definition at line 1371 of file SequenceTypes.py.

References SequenceTypes._ModuleSequenceType.visit(), and SequenceTypes.Task.visit().

    def moduleNames(self):
        """Returns a set containing the names of all modules being used"""
        result = set()
        visitor = NodeNameVisitor(result)
        self.visit(visitor)
        return result

def SequenceTypes.Task.remove	(		self,
			something
	)

Remove the first occurrence of a module
   Returns 'True' if the module has been removed, False if it was not found

Definition at line 1427 of file SequenceTypes.py.

References OOTPileupCorrectionColl.add(), StringMap.add(), CSCAnodeDataFormat.add(), sistrip::WarningSummary.add(), RPCAMCLinkCounters.add(), PuppiAlgo.add(), StorableDoubleMap< T >.add(), btagbtvdeep::DeepBoostedJetFeatures.add(), CSCRPCData.add(), RPCLinkSynchroStat.add(), Majority< T >.add(), edm::ExceptionToActionTable.add(), rpcrawtodigi::EventRecords.add(), CSCAnodeData.add(), ESCrcKchipFast.add(), HcalIndexLookup.add(), sipixelobjects::PixelFEDLink.add(), SiStripMiscalibrate::Entry.add(), SiPixelDetSummary.add(), LinkConnSpec.add(), pos::PixelConfig.add(), DigiCollectionFP420.add(), DccSpec.add(), helper::CandDecayStoreManager.add(), TriggerBoardSpec.add(), CSCCFEBData.add(), LinkBoardSpec.add(), edm::helper::Filler< Map >.add(), RPCLinkSynchroStat::LinkBoard.add(), EventWithHistory.add(), sistrip::LinearFit.add(), pat::EventHypothesis.add(), beamerCreator.Out.add(), Averages.add(), AlignmentSurfaceDeformations.add(), SiStripPI::Entry.add(), TkHistoMap.add(), RPCReadOutMapping.add(), OrderedSet.OrderedSet.add(), CSCDDUEventData.add(), FWTypeToRepresentations.add(), edm::ConfigurationDescriptions.add(), CSCAnodeData2007.add(), CSCCLCTData.add(), FWParameterizable.add(), FWConfigurationManager.add(), FWViewManagerManager.add(), SiStripDetSummary.add(), DTKeyedConfig.add(), L1TriggerKeyExt.add(), CSCDigiToRaw.add(), L1TriggerKey.add(), CSCAnodeData2006.add(), AlignmentParameterBuilder.add(), SiStripQuality.add(), edm::CountAndLimit.add(), edm::service::ELlimitsTable.add(), FWEventItemsManager.add(), DTVDriftCalibration::cellInfo.add(), edm::EventSetupImpl.add(), reco::Vertex.add(), reco::CastorTower.add(), sistrip::MeanAndStdDev.add(), amc13::Packet.add(), GEMROmap.add(), edm::StatsCount.add(), edm::eventsetup::EventSetupProvider.add(), reco::CastorCluster.add(), edm::Association< C >::Filler.add(), edm::eventsetup::EventSetupRecordProvider.add(), AlignmentParameterSelector.add(), edm::ParameterSetDescription.add(), PrimaryVertexValidation.add(), CSCALCTs2006.add(), Phase2ITPixelCluster.add(), SiPixelQuality.add(), GEMROMapping.add(), SiPixelCluster.add(), edm::Association< C >.add(), CSCEventData.add(), jsoncollector::IntJ.add(), pos::PixelConfigList.add(), edm::WaitingTaskList.add(), edm::eventsetup::EventSetupRecordImpl.add(), MicroME.add(), CTPPSRPAlignmentCorrectionData.add(), CSCTMBHeader.add(), Folder.add(), popcon::PopConSourceHandler< T >.add(), o2olib.O2OJobMgr.add(), CSCALCTHeader.add(), edm::ValueMap< T >.add(), PhysicsTools::Calibration::MVAComputerContainer.add(), pat::MET::PackedMETUncertainty.add(), SequenceTypes.Task.add(), SequenceTypes._ModuleSequenceType.visit(), and SequenceTypes.Task.visit().

    def remove(self, something):
        """Remove the first occurrence of a module
           Returns 'True' if the module has been removed, False if it was not found"""
        # You can remove instances of these types EDProducer, EDFilter, ESSource,
        # ESProducer, Service, or Task,
        #
        # Mostly this is very intuitive, but there are some complications in cases
        # where objects that contain other objects are involved. See the comments
        # for the _MutatingSequenceVisitor.
        #
        # Works very similar to copyAndExclude, there are 2 differences. This changes
        # the object itself instead of making a copy and second it only removes
        # the first instance of the argument instead of all of them.
        if not something._isTaskComponent():
           raise TypeError("remove only works with objects that can be placed on a Task")
        v = _CopyAndRemoveFirstSequenceVisitor(something)
        self.visit(v)
        if v.didRemove():
            self._collection.clear()
            self.add(*v.result(self))
        return v.didRemove()

def SequenceTypes.Task.replace	(		self,
			original,
			replacement
	)

Finds all instances of 'original' and substitutes 'replacement' for them.
   Returns 'True' if a replacement occurs.

Definition at line 1405 of file SequenceTypes.py.

References OOTPileupCorrectionColl.add(), StringMap.add(), CSCAnodeDataFormat.add(), sistrip::WarningSummary.add(), RPCAMCLinkCounters.add(), PuppiAlgo.add(), StorableDoubleMap< T >.add(), btagbtvdeep::DeepBoostedJetFeatures.add(), CSCRPCData.add(), RPCLinkSynchroStat.add(), Majority< T >.add(), edm::ExceptionToActionTable.add(), rpcrawtodigi::EventRecords.add(), HcalIndexLookup.add(), CSCAnodeData.add(), ESCrcKchipFast.add(), sipixelobjects::PixelFEDLink.add(), SiStripMiscalibrate::Entry.add(), SiPixelDetSummary.add(), LinkConnSpec.add(), pos::PixelConfig.add(), DigiCollectionFP420.add(), DccSpec.add(), helper::CandDecayStoreManager.add(), TriggerBoardSpec.add(), CSCCFEBData.add(), LinkBoardSpec.add(), edm::helper::Filler< Map >.add(), RPCLinkSynchroStat::LinkBoard.add(), EventWithHistory.add(), sistrip::LinearFit.add(), pat::EventHypothesis.add(), beamerCreator.Out.add(), Averages.add(), AlignmentSurfaceDeformations.add(), SiStripPI::Entry.add(), RPCReadOutMapping.add(), TkHistoMap.add(), OrderedSet.OrderedSet.add(), CSCDDUEventData.add(), FWTypeToRepresentations.add(), edm::ConfigurationDescriptions.add(), CSCAnodeData2007.add(), CSCCLCTData.add(), FWParameterizable.add(), FWConfigurationManager.add(), FWViewManagerManager.add(), SiStripDetSummary.add(), DTKeyedConfig.add(), L1TriggerKeyExt.add(), CSCDigiToRaw.add(), L1TriggerKey.add(), CSCAnodeData2006.add(), SiStripQuality.add(), AlignmentParameterBuilder.add(), edm::CountAndLimit.add(), FWEventItemsManager.add(), edm::service::ELlimitsTable.add(), DTVDriftCalibration::cellInfo.add(), edm::EventSetupImpl.add(), reco::Vertex.add(), reco::CastorTower.add(), sistrip::MeanAndStdDev.add(), amc13::Packet.add(), GEMROmap.add(), edm::StatsCount.add(), edm::eventsetup::EventSetupProvider.add(), reco::CastorCluster.add(), edm::Association< C >::Filler.add(), edm::eventsetup::EventSetupRecordProvider.add(), AlignmentParameterSelector.add(), edm::ParameterSetDescription.add(), PrimaryVertexValidation.add(), CSCALCTs2006.add(), SiPixelQuality.add(), Phase2ITPixelCluster.add(), SiPixelCluster.add(), GEMROMapping.add(), edm::Association< C >.add(), CSCEventData.add(), jsoncollector::IntJ.add(), pos::PixelConfigList.add(), edm::WaitingTaskList.add(), edm::eventsetup::EventSetupRecordImpl.add(), MicroME.add(), CTPPSRPAlignmentCorrectionData.add(), CSCTMBHeader.add(), Folder.add(), popcon::PopConSourceHandler< T >.add(), o2olib.O2OJobMgr.add(), CSCALCTHeader.add(), edm::ValueMap< T >.add(), PhysicsTools::Calibration::MVAComputerContainer.add(), pat::MET::PackedMETUncertainty.add(), SequenceTypes.Task.add(), str, SequenceTypes._ModuleSequenceType.visit(), and SequenceTypes.Task.visit().

    def replace(self, original, replacement):
        """Finds all instances of 'original' and substitutes 'replacement' for them.
           Returns 'True' if a replacement occurs."""
        # This works for either argument being of type EDProducer, EDFilter, ESProducer,
        # ESSource, Service, or Task.
        #
        # Mostly this is very intuitive, but there are some complications in cases
        # where objects that contain other objects are involved. See the comments
        # for the _MutatingSequenceVisitor.

        if not original._isTaskComponent() or (not replacement is None and not replacement._isTaskComponent()):
           raise TypeError("The Task replace function only works with objects that can be placed on a Task\n" + \
                           "           replace was called with original type = " + str(type(original)) + "\n" + \
                           "           and replacement type = " + str(type(replacement)) + "\n")
        else:
            v = _CopyAndReplaceSequenceVisitor(original,replacement)
            self.visit(v)
            if v.didReplace():
                self._collection.clear()
                self.add(*v.result(self))
            return v.didReplace()

def SequenceTypes.Task.resolve	(		self,
			processDict,
			keepIfCannotResolve = False
	)

Definition at line 1449 of file SequenceTypes.py.

References SequenceTypes._SequenceCollection._collection, and SequenceTypes.Task._collection.

    def resolve(self, processDict,keepIfCannotResolve=False):
        temp = OrderedSet()
        for i in self._collection:
            if isinstance(i, Task) or isinstance(i, TaskPlaceholder):
                temp.add(i.resolve(processDict,keepIfCannotResolve))
            else:
                temp.add(i)
        self._collection = temp
        return self

def SequenceTypes.Task.visit	(		self,
			visitor
	)

Definition at line 1342 of file SequenceTypes.py.

References SequenceTypes._SequenceCollection._collection, and SequenceTypes.Task._collection.

Referenced by SequenceTypes.Task.__str__(), SequenceTypes.Task.contains(), SequenceTypes.Task.copyAndExclude(), SequenceTypes.Task.expandAndClone(), SequenceTypes.Task.moduleNames(), SequenceTypes.Task.remove(), and SequenceTypes.Task.replace().

    def visit(self,visitor):
        for i in self._collection:
            visitor.enter(i)
            if not i.isLeaf():
                i.visit(visitor)
            visitor.leave(i)

Member Data Documentation

SequenceTypes.Task._collection

private

Definition at line 1282 of file SequenceTypes.py.

Referenced by SequenceTypes.Task.__iter__(), SequenceTypes.Task.copy(), trackingPlots.TrackingSummaryTable.create(), SequenceTypes.Task.dumpPythonNoNewline(), SequenceTypes.Task.fillContents(), SequenceTypes.Task.resolve(), and SequenceTypes.Task.visit().