crabFunctions.CrabTask Class Reference

Class for a single CrabRequest e This class represents one crab3 task/request. More...

Public Member Functions
def	__init__ (self, taskname="", crab_config="", crabController=None, initUpdate=True, debuglevel="ERROR", datasetpath="", localDir="", outlfn="")
	The object constructor. More...
def	crab_folder (self)
def	crabConfig (self)
	Function to access crab config object or read it if unititalized. More...
def	crabFolder (self)
def	datasetpath (self)
def	handleNoState (self)
	Function to handle Task which received NOSTATE status. More...
def	isData (self)
	Property function to find out if task runs on data. More...
def	readLogArch (self, logArchName)
	Function to read log info from log.tar.gz. More...
def	resubmit_failed (self)
	Function to resubmit failed jobs in tasks. More...
def	test_print (self)
def	update (self)
	Function to update Task in associated Jobs. More...
def	updateJobStats (self, dCacheFileList=None)
	Function to update JobStatistics. More...

Public Attributes
	debug
	failureReason
	finalFiles
	isUpdating
	jobs
	lastUpdate
	localDir
	log
	maxjobnumber
	name
	nComplete
	nCooloff
	nFailed
	nFinished
	nIdle
	nJobs
	nRunning
	nTransferring
	nUnsubmitted
	outlfn
	resubmitCount
	state
	taskId
	totalEvents
	uuid

Private Attributes
	_crabConfig
	_crabFolder
	_datasetpath_default
	_isData

Detailed Description

Class for a single CrabRequest e This class represents one crab3 task/request.

Definition at line 371 of file crabFunctions.py.

Constructor & Destructor Documentation

__init__()

def crabFunctions.CrabTask.__init__	(		self,
			taskname = "",
			crab_config = "",
			crabController = None,
			initUpdate = True,
			debuglevel = "ERROR",
			datasetpath = "",
			localDir = "",
			outlfn = ""
	)

The object constructor.

Parameters

self	The object pointer.
taskname	The object pointer.
initUpdate	Flag if crab status should be called when an instance is created

Definition at line 386 of file crabFunctions.py.

                 outlfn = "" ,):

        # crab config as a python object should only be used via .config
        self._crabConfig = None

        self._crabFolder = None

        if taskname:
            self.name = taskname
        else:
            if not crab_config:
                raise ValueError("Either taskname or crab_config needs to be set")
            if not os.path.exists( crab_config):
                raise IOError("File %s not found" % crab_config )
            self.name = crab_config
            self.name = self.crabConfig.General.requestName
        self.uuid = uuid.uuid4()
        #~ self.lock = multiprocessing.Lock()
        #setup logging
        self.log = logging.getLogger( 'crabTask' )
        self.log.setLevel(logging.getLevelName(debuglevel))
        self.jobs = {}
        self.localDir = localDir
        self.outlfn = outlfn
        self.isUpdating = False
        self.taskId = -1
        #variables for statistics
        self.nJobs = 0
        self.state = "NOSTATE"
        self.maxjobnumber = 0
        self.nUnsubmitted   = 0
        self.nIdle = 0
        self.nRunning = 0
        self.nTransferring    = 0
        self.nCooloff    = 0
        self.nFailed    = 0
        self.nFinished    = 0
        self.nComplete    = 0
        self.failureReason = None
        self.lastUpdate = datetime.datetime.now().strftime( "%Y-%m-%d_%H.%M.%S" )

        self._isData = None
        self.resubmitCount = 0

        self.debug = False

        self.finalFiles = []
        self.totalEvents = 0


        self._datasetpath_default = datasetpath

        #start with first updates
        if initUpdate:
            self.update()
            self.updateJobStats()

Member Function Documentation

crab_folder()

def crabFunctions.CrabTask.crab_folder

(

self

)

Definition at line 506 of file crabFunctions.py.

References crabFunctions.CrabTask.crabConfig().

Referenced by crabFunctions.CrabTask.update().

    def crab_folder(self):
        return os.path.join( self.crabConfig.General.workArea,
            "crab_" + self.crabConfig.General.requestName)

crabConfig()

def crabFunctions.CrabTask.crabConfig

(

self

)

Function to access crab config object or read it if unititalized.

Parameters

self	CrabTask The object pointer.

Definition at line 464 of file crabFunctions.py.

References crabFunctions.CrabTask._crabConfig, AlignableObjectId::entry.name, XMLProcessor::_loaderBaseConfig.name, h4DSegm.name, TrackerSectorStruct.name, MuonGeometrySanityCheckPoint.name, classes.MonitorData.name, classes.OutputData.name, h2DSegm.name, geometry.Structure.name, plotscripts.SawTeethFunction.name, crabFunctions.CrabTask.name, and hTMaxCell.name.

Referenced by crabFunctions.CrabTask.crab_folder(), crabFunctions.CrabTask.crabFolder(), crabFunctions.CrabTask.datasetpath(), and crabFunctions.CrabTask.isData().

    def crabConfig( self ):
        if self._crabConfig is None:
            crab = CrabController()
            self._crabConfig = crab.readCrabConfig( self.name )
        return self._crabConfig

crabFolder()

def crabFunctions.CrabTask.crabFolder

(

self

)

Definition at line 479 of file crabFunctions.py.

References crabFunctions.CrabTask._crabFolder, crabFunctions.CrabTask.crabConfig(), relativeConstraints.error, crabFunctions.CrabTask.log, AlignableObjectId::entry.name, XMLProcessor::_loaderBaseConfig.name, h4DSegm.name, TrackerSectorStruct.name, MuonGeometrySanityCheckPoint.name, classes.MonitorData.name, classes.OutputData.name, h2DSegm.name, geometry.Structure.name, plotscripts.SawTeethFunction.name, crabFunctions.CrabTask.name, and hTMaxCell.name.

    def crabFolder( self ):
        if not self._crabFolder is None: return self._crabFolder
        crab = CrabController()
        if os.path.exists( os.path.join( self.crabConfig.General.workArea, crab._prepareFoldername( self.name ) ) ):
            self._crabFolder = os.path.join( self.crabConfig.General.workArea, crab._prepareFoldername( self.name ) )
            return self._crabFolder
        alternative_path = os.path.join(os.path.cwd(), crab._prepareFoldername( self.name ) )
        if os.path.exists( alternative_path ):
            self._crabFolder = alternative_path
            return self._crabFolder
        self.log.error( "Unable to find folder for Task")
        return ""

datasetpath()

def crabFunctions.CrabTask.datasetpath

(

self

)

Definition at line 471 of file crabFunctions.py.

References crabFunctions.CrabTask._datasetpath_default, and crabFunctions.CrabTask.crabConfig().

    def datasetpath( self ):
        try:
            return self.crabConfig.Data.inputDataset
        except:
            pass
        return self._datasetpath_default

handleNoState()

def crabFunctions.CrabTask.handleNoState

(

self

)

Function to handle Task which received NOSTATE status.

Parameters

self	CrabTask The object pointer.

Definition at line 541 of file crabFunctions.py.

References AlignableObjectId::entry.name, XMLProcessor::_loaderBaseConfig.name, h4DSegm.name, TrackerSectorStruct.name, MuonGeometrySanityCheckPoint.name, classes.MonitorData.name, classes.OutputData.name, h2DSegm.name, geometry.Structure.name, plotscripts.SawTeethFunction.name, crabFunctions.CrabTask.name, hTMaxCell.name, crabFunctions.CrabTask.resubmitCount, CastorLedAnalysis.state, HcalLedAnalysis.state, HcalPedestalAnalysis.state, CastorPedestalAnalysis.state, and crabFunctions.CrabTask.state.

Referenced by crabFunctions.CrabTask.update().

    def handleNoState( self ):
        crab = CrabController()
        if "The CRAB3 server backend could not resubmit your task because the Grid scheduler answered with an error." in task.failureReason:
            # move folder and try it again
            cmd = 'mv %s bak_%s' %(crab._prepareFoldername( self.name ),crab._prepareFoldername( self.name ))
            p = subprocess.Popen(cmd,stdout=subprocess.PIPE, shell=True)#,shell=True,universal_newlines=True)
            (out,err) = p.communicate()
            self.state = "SHEDERR"
            configName = '%s_cfg.py' %(crab._prepareFoldername( self.name ))
            crab.submit( configName )

        elif task.failureReason is not None:
            self.state = "ERRHANDLE"
            crab.resubmit( self.name )
        self.resubmitCount += 1

isData()

def crabFunctions.CrabTask.isData

(

self

)

Property function to find out if task runs on data.

Parameters

self	CrabTask The object pointer.

Definition at line 447 of file crabFunctions.py.

References crabFunctions.CrabTask._isData, crabFunctions.CrabTask.crabConfig(), AlignableObjectId::entry.name, XMLProcessor::_loaderBaseConfig.name, h4DSegm.name, TrackerSectorStruct.name, MuonGeometrySanityCheckPoint.name, classes.MonitorData.name, classes.OutputData.name, h2DSegm.name, geometry.Structure.name, plotscripts.SawTeethFunction.name, crabFunctions.CrabTask.name, and hTMaxCell.name.

    def isData( self ):
        if self._isData is None:
            try:
                test = self.crabConfig.Data.lumiMask
                self._isData = True
            except:
                if self.name.startswith( "Data_" ):
                    self._isData = True
                else:
                    self._isData = False
        return self._isData

readLogArch()

def crabFunctions.CrabTask.readLogArch	(		self,
			logArchName
	)

Function to read log info from log.tar.gz.

Parameters

self	The object pointer.
logArchName	path to the compressed log file

Returns

a dictionary with parsed info

Definition at line 598 of file crabFunctions.py.

References createfilelist.int, print(), and submitPVValidationJobs.split().

    def readLogArch(self, logArchName):
        JobNumber = logArchName.split("/")[-1].split("_")[1].split(".")[0]
        log = {'readEvents' : 0}
        with tarfile.open( logArchName, "r") as tar:
            try:
                JobXmlFile = tar.extractfile('FrameworkJobReport-%s.xml' % JobNumber)
                root = ET.fromstring( JobXmlFile.read() )
                for child in root:
                    if child.tag == 'InputFile':
                        for subchild in child:
                            if subchild.tag == 'EventsRead':
                                nEvents = int(subchild.text)
                                log.update({'readEvents' : nEvents})
                                break
                        break
            except:
                print("Can not parse / read %s" % logArchName)
        return log

resubmit_failed()

def crabFunctions.CrabTask.resubmit_failed

(

self

)

Function to resubmit failed jobs in tasks.

Parameters

self	CrabTask The object pointer.

Definition at line 495 of file crabFunctions.py.

References crabFunctions.CrabTask.jobs, relativeConstraints.keys, crabFunctions.CrabTask.lastUpdate, AlignableObjectId::entry.name, XMLProcessor::_loaderBaseConfig.name, h4DSegm.name, TrackerSectorStruct.name, MuonGeometrySanityCheckPoint.name, classes.MonitorData.name, classes.OutputData.name, h2DSegm.name, geometry.Structure.name, plotscripts.SawTeethFunction.name, crabFunctions.CrabTask.name, and hTMaxCell.name.

    def resubmit_failed( self ):
        failedJobIds = []
        controller =  CrabController()
        for jobkey in self.jobs.keys():
            job = self.jobs[jobkey]
            if job['State'] == 'failed':
                failedJobIds.append( job['JobIds'][-1] )
        controller.resubmit( self.name, joblist = failedJobIds )
        self.lastUpdate = datetime.datetime.now().strftime( "%Y-%m-%d_%H.%M.%S" )

test_print()

def crabFunctions.CrabTask.test_print

(

self

)

Definition at line 557 of file crabFunctions.py.

References crabFunctions.CrabTask.uuid.

    def test_print(self):
        return self.uuid

update()

def crabFunctions.CrabTask.update

(

self

)

Function to update Task in associated Jobs.

Parameters

self	CrabTask The object pointer.

Definition at line 512 of file crabFunctions.py.

References crabFunctions.CrabTask.crab_folder(), crabFunctions.CrabTask.debug, crabFunctions.CrabTask.failureReason, crabFunctions.CrabTask.handleNoState(), crabFunctions.CrabTask.isUpdating, crabFunctions.CrabTask.jobs, crabFunctions.CrabTask.lastUpdate, crabFunctions.CrabTask.log, AlignableObjectId::entry.name, XMLProcessor::_loaderBaseConfig.name, h4DSegm.name, TrackerSectorStruct.name, MuonGeometrySanityCheckPoint.name, classes.MonitorData.name, classes.OutputData.name, h2DSegm.name, geometry.Structure.name, plotscripts.SawTeethFunction.name, crabFunctions.CrabTask.name, hTMaxCell.name, Mpslibclass.jobdatabase.nJobs, crabFunctions.CrabTask.nJobs, crabFunctions.CrabTask.resubmitCount, CosmicNavigationSchool::CosmicNavigationSchoolConfiguration.self, DDLSAX2FileHandler.self(), CastorLedAnalysis.state, HcalLedAnalysis.state, HcalPedestalAnalysis.state, CastorPedestalAnalysis.state, crabFunctions.CrabTask.state, and crabFunctions.CrabTask.updateJobStats().

Referenced by progressbar.ProgressBar.__next__(), MatrixUtil.Matrix.__setitem__(), MatrixUtil.Steps.__setitem__(), dqm-mbProfile.Profile.finish(), progressbar.ProgressBar.finish(), and MatrixUtil.Steps.overwrite().

    def update(self):
        #~ self.lock.acquire()
        self.log.debug( "Start update for task %s" % self.name )
        self.isUpdating = True
        controller =  CrabController()
        self.state = "UPDATING"
        # check if we should drop this sample due to missing info

        self.log.debug( "Try to get status for task" )
        self.state , self.jobs,self.failureReason = controller.status(self.crab_folder)
        self.log.debug( "Found state: %s" % self.state )
        if self.state=="FAILED":
            #try it once more
            time.sleep(2)
            self.state , self.jobs,self.failureReason = controller.status(self.crab_folder)
        self.nJobs = len(self.jobs)
        self.updateJobStats()
        if self.state == "NOSTATE":
            self.log.debug( "Trying to resubmit because of NOSTATE" )
            if self.resubmitCount < 3: self.self.handleNoState()
        # add to db if not
        # Final solution inf state not yet found
        self.isUpdating = False
        self.lastUpdate = datetime.datetime.now().strftime( "%Y-%m-%d_%H.%M.%S" )
        #~ self.lock.release()

updateJobStats()

def crabFunctions.CrabTask.updateJobStats	(		self,
			dCacheFileList = None
	)

Function to update JobStatistics.

Parameters

self	The object pointer.
dCacheFilelist	A list of files on the dCache

Definition at line 563 of file crabFunctions.py.

References any(), createfilelist.int, crabFunctions.CrabTask.jobs, relativeConstraints.keys, AlignableObjectId::entry.name, XMLProcessor::_loaderBaseConfig.name, h4DSegm.name, TrackerSectorStruct.name, MuonGeometrySanityCheckPoint.name, classes.MonitorData.name, classes.OutputData.name, h2DSegm.name, geometry.Structure.name, plotscripts.SawTeethFunction.name, crabFunctions.CrabTask.name, hTMaxCell.name, crabFunctions.CrabTask.nComplete, and print().

Referenced by crabFunctions.CrabTask.update().

    def updateJobStats(self,dCacheFileList = None):
        jobKeys = sorted(self.jobs.keys())
        try:
            intJobkeys = [int(x) for x in jobKeys]
        except:
            print("error parsing job numers to int")

        #maxjobnumber = max(intJobkeys)

        stateDict = {'unsubmitted':0,'idle':0,'running':0,'transferring':0,'cooloff':0,'failed':0,'finished':0}
        nComplete = 0

        # loop through jobs
        for key in jobKeys:
            job = self.jobs[key]
             #check if all completed files are on decache
            for statekey in stateDict.keys():
                if statekey in job['State']:
                    stateDict[statekey]+=1
                    # check if finished fails are found on dCache if dCacheFilelist is given
                    if dCacheFileList is not None:
                        outputFilename = "%s_%s"%( self.name, key)
                        if 'finished' in statekey and any(outputFilename in s for s in dCacheFileList):
                            nComplete +=1

        for state in stateDict:
            attrname = "n" + state.capitalize()
            setattr(self, attrname, stateDict[state])
        self.nComplete = nComplete

Member Data Documentation

_crabConfig

crabFunctions.CrabTask._crabConfig

private

Definition at line 389 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.crabConfig().

_crabFolder

crabFunctions.CrabTask._crabFolder

private

Definition at line 391 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.crabFolder().

_datasetpath_default

crabFunctions.CrabTask._datasetpath_default

private

Definition at line 436 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.datasetpath().

_isData

crabFunctions.CrabTask._isData

private

Definition at line 427 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.isData().

debug

crabFunctions.CrabTask.debug

Definition at line 430 of file crabFunctions.py.

Referenced by util.rrapi.RRApi.dprint(), rrapi.RRApi.dprint(), pkg.AbstractPkg.generate(), rrapi.RRApi.get(), util.rrapi.RRApi.get(), pkg.AbstractPkg.get_kwds(), runTauIdMVA.TauIDEmbedder.load_againstElectronMVA6(), runTauIdMVA.TauIDEmbedder.loadMVA_WPs_run2_2017(), crabFunctions.CrabTask.update(), and pkg.AbstractPkg.write().

failureReason

crabFunctions.CrabTask.failureReason

Definition at line 424 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.update().

finalFiles

crabFunctions.CrabTask.finalFiles

Definition at line 432 of file crabFunctions.py.

isUpdating

crabFunctions.CrabTask.isUpdating

Definition at line 410 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.update().

jobs

crabFunctions.CrabTask.jobs

Definition at line 407 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.resubmit_failed(), crabFunctions.CrabTask.update(), and crabFunctions.CrabTask.updateJobStats().

lastUpdate

crabFunctions.CrabTask.lastUpdate

Definition at line 425 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.resubmit_failed(), and crabFunctions.CrabTask.update().

localDir

crabFunctions.CrabTask.localDir

Definition at line 408 of file crabFunctions.py.

log

crabFunctions.CrabTask.log

Definition at line 405 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.crabFolder(), personalPlayback.Playback.do_create_lumi(), personalPlayback.Playback.do_exec(), personalPlayback.FrameworkJob.do_exec(), conddbCopyTest.CopyTest.execute(), personalPlayback.FrameworkJob.start_run(), crabFunctions.CrabTask.update(), and conditionUploadTest.UploadTest.upload().

maxjobnumber

crabFunctions.CrabTask.maxjobnumber

Definition at line 415 of file crabFunctions.py.

name

crabFunctions.CrabTask.name

Definition at line 394 of file crabFunctions.py.

Referenced by ElectronMVAID.ElectronMVAID.__call__(), FWLite.ElectronMVAID.__call__(), dirstructure.Directory.__create_pie_image(), DisplayManager.DisplayManager.__del__(), dqm_interfaces.DirID.__eq__(), dirstructure.Directory.__get_full_path(), dirstructure.Comparison.__get_img_name(), dirstructure.Comparison.__make_image(), core.autovars.NTupleVariable.__repr__(), core.autovars.NTupleObjectType.__repr__(), core.autovars.NTupleObject.__repr__(), core.autovars.NTupleCollection.__repr__(), dirstructure.Directory.__repr__(), dqm_interfaces.DirID.__repr__(), dirstructure.Comparison.__repr__(), config.Service.__setattr__(), config.CFG.__str__(), counter.Counter.__str__(), average.Average.__str__(), FWLite.WorkingPoints._reformat_cut_definitions(), core.autovars.NTupleObjectType.addSubObjects(), core.autovars.NTupleObjectType.addVariables(), core.autovars.NTupleObjectType.allVars(), dataset.CMSDataset.buildListOfFiles(), dataset.LocalDataset.buildListOfFiles(), dataset.CMSDataset.buildListOfFilesDBS(), dirstructure.Directory.calcStats(), crabFunctions.CrabTask.crabConfig(), crabFunctions.CrabTask.crabFolder(), validation.Sample.digest(), python.rootplot.utilities.Hist.divide(), python.rootplot.utilities.Hist.divide_wilson(), DisplayManager.DisplayManager.Draw(), TreeCrawler.Package.dump(), core.autovars.NTupleVariable.fillBranch(), core.autovars.NTupleObject.fillBranches(), core.autovars.NTupleCollection.fillBranchesScalar(), core.autovars.NTupleCollection.fillBranchesVector(), core.autovars.NTupleCollection.get_cpp_declaration(), core.autovars.NTupleCollection.get_cpp_wrapper_class(), core.autovars.NTupleCollection.get_py_wrapper_class(), utils.StatisticalTest.get_status(), production_tasks.Task.getname(), dataset.CMSDataset.getPrimaryDatasetEntries(), dataset.PrivateDataset.getPrimaryDatasetEntries(), crabFunctions.CrabTask.handleNoState(), VIDSelectorBase.VIDSelectorBase.initialize(), crabFunctions.CrabTask.isData(), personalPlayback.Applet.log(), core.autovars.NTupleVariable.makeBranch(), core.autovars.NTupleObject.makeBranches(), core.autovars.NTupleCollection.makeBranchesScalar(), core.autovars.NTupleCollection.makeBranchesVector(), dirstructure.Directory.print_report(), dataset.BaseDataset.printInfo(), dataset.Dataset.printInfo(), crabFunctions.CrabTask.resubmit_failed(), production_tasks.MonitorJobs.run(), python.rootplot.utilities.Hist.TGraph(), python.rootplot.utilities.Hist.TH1F(), crabFunctions.CrabTask.update(), crabFunctions.CrabTask.updateJobStats(), counter.Counter.write(), and average.Average.write().

nComplete

crabFunctions.CrabTask.nComplete

Definition at line 423 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.updateJobStats().

nCooloff

crabFunctions.CrabTask.nCooloff

Definition at line 420 of file crabFunctions.py.

nFailed

crabFunctions.CrabTask.nFailed

Definition at line 421 of file crabFunctions.py.

nFinished

crabFunctions.CrabTask.nFinished

Definition at line 422 of file crabFunctions.py.

nIdle

crabFunctions.CrabTask.nIdle

Definition at line 417 of file crabFunctions.py.

nJobs

crabFunctions.CrabTask.nJobs

Definition at line 413 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.update().

nRunning

crabFunctions.CrabTask.nRunning

Definition at line 418 of file crabFunctions.py.

nTransferring

crabFunctions.CrabTask.nTransferring

Definition at line 419 of file crabFunctions.py.

nUnsubmitted

crabFunctions.CrabTask.nUnsubmitted

Definition at line 416 of file crabFunctions.py.

outlfn

crabFunctions.CrabTask.outlfn

Definition at line 409 of file crabFunctions.py.

resubmitCount

crabFunctions.CrabTask.resubmitCount

Definition at line 428 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.handleNoState(), and crabFunctions.CrabTask.update().

state

crabFunctions.CrabTask.state

Definition at line 414 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.handleNoState(), and crabFunctions.CrabTask.update().

taskId

crabFunctions.CrabTask.taskId

Definition at line 411 of file crabFunctions.py.

totalEvents

crabFunctions.CrabTask.totalEvents

Definition at line 433 of file crabFunctions.py.

uuid

crabFunctions.CrabTask.uuid

Definition at line 402 of file crabFunctions.py.

Referenced by crabFunctions.CrabTask.test_print().