Inheritance diagram for python.trfExe.scriptExecutor:

Collaboration diagram for python.trfExe.scriptExecutor:

Public Member Functions
def	__init__ (self, name='Script', trf=None, conf=None, inData=set(), outData=set(), exe=None, exeArgs=None, memMonitor=True)

def	exe (self)

def	exe (self, value)

def	exeArgs (self)

def	exeArgs (self, value)

def	preExecute (self, input=set(), output=set())

def	execute (self)

def	postExecute (self)

def	validate (self)

def	inData (self)

def	inData (self, value)

def	outData (self)

def	outData (self, value)

def	myMerger (self)
	Now define properties for these data members. More...

def	name (self)

def	name (self, value)

def	substep (self)

def	trf (self)

def	trf (self, value)

def	inDataUpdate (self, value)

def	outDataUpdate (self, value)

def	input (self)

def	output (self)

def	extraMetadata (self)

def	hasExecuted (self)

def	rc (self)

def	errMsg (self)

def	validation (self)

def	validation (self, value)

def	hasValidated (self)

def	isValidated (self)

def	first (self)

def	preExeStartTimes (self)

def	exeStartTimes (self)

def	exeStopTimes (self)

def	valStartTimes (self)

def	valStopTimes (self)

def	preExeCpuTime (self)

def	preExeWallTime (self)

def	cpuTime (self)

def	usrTime (self)

def	sysTime (self)

def	wallTime (self)

def	memStats (self)

def	memAnalysis (self)

def	postExeCpuTime (self)

def	postExeWallTime (self)

def	validationCpuTime (self)

def	validationWallTime (self)

def	cpuTimeTotal (self)

def	wallTimeTotal (self)

def	eventCount (self)

def	reSimEvent (self)

def	athenaMP (self)

def	dbMonitor (self)

def	setPreExeStart (self)

def	setValStart (self)

def	doAll (self, input=set(), output=set())
	Convenience function. More...

Public Attributes
	conf
	Executor configuration: More...

	inData

	outData

Private Member Functions
def	_buildStandardCommand (self)

Private Attributes
	_exe

	_exeArgs

	_echoOutput

	_cmd

	_memMonitor

	_input

	_output

	_logFileName

	_echologger

	_exeLogFile

	_echostream

	_hasExecuted

	_exeStart

	_memSummaryFile

	_memFullFile

	_rc
	Check rc. More...

	_exeStop

	_memStats

	_valStart

	_hasValidated

	_isValidated

	_errMsg

	_eventCount
	Check event counts (always do this by default) Do this here so that all script executors have this by default (covers most use cases with events) More...

	_valStop

	_name

	_inData

	_outData

	_extraMetadata

	_preExeStart

	_memLeakResult

	_athenaMP

	_athenaMT

	_athenaConcurrentEvents

	_dbMonitor

	_resimevents

	_alreadyInContainer

	_containerSetup

	_myMerger

	_trf

	_validation

Detailed Description

Definition at line 619 of file trfExe.py.

Constructor & Destructor Documentation

◆ init()

def python.trfExe.scriptExecutor.__init__	(	self,
		name = `'Script'`,
		trf = `None`,
		conf = `None`,
		inData = `set()`,
		outData = `set()`,
		exe = `None`,
		exeArgs = `None`,
		memMonitor = `True`
	)

Reimplemented in python.trfExe.DQMPostProcessExecutor, and python.trfExe.DQMergeExecutor.

Definition at line 620 of file trfExe.py.

     def __init__(self, name = 'Script', trf = None, conf = None, inData = set(), outData = set(), 
                  exe = None, exeArgs = None, memMonitor = True):
         # Name of the script we want to execute
         self._exe = exe
         
         # With arguments (currently this means paste in the corresponding _argdict entry)
         self._exeArgs = exeArgs
         
         super(scriptExecutor, self).__init__(name=name, trf=trf, conf=conf, inData=inData, outData=outData)
         
         self._extraMetadata.update({'script' : exe})
         
         # Decide if we echo script output to stdout
         self._echoOutput = False
  
         # Can either be written by base class or child   
         self._cmd = None
         
         self._memMonitor = memMonitor
  

Member Function Documentation

◆ _buildStandardCommand()

def python.trfExe.scriptExecutor._buildStandardCommand ( self )

private

Definition at line 706 of file trfExe.py.

     def _buildStandardCommand(self):
         if self._exe:
             self._cmd = [self.exe, ]
         else:
             raise trfExceptions.TransformExecutionException(trfExit.nameToCode('TRF_EXEC_SETUP_FAIL'), 
                                                             'No executor set in {0}'.format(self.__class__.__name__))
         for arg in self.exeArgs:
             if arg in self.conf.argdict:
                 # If we have a list then add each element to our list, else just str() the argument value
                 # Note if there are arguments which need more complex transformations then
                 # consider introducing a special toExeArg() method.
                 if isinstance(self.conf.argdict[arg].value, list):
                     self._cmd.extend([ str(v) for v in self.conf.argdict[arg].value])
                 else:
                     self._cmd.append(str(self.conf.argdict[arg].value))
  
  

◆ athenaMP()

def python.trfExe.transformExecutor.athenaMP ( self )

inherited

Definition at line 452 of file trfExe.py.

     def athenaMP(self):
         return self._athenaMP
  

◆ cpuTime()

def python.trfExe.transformExecutor.cpuTime ( self )

inherited

Definition at line 366 of file trfExe.py.

     def cpuTime(self):
         if self._exeStart and self._exeStop:
             return calcCpuTime(self._exeStart, self._exeStop)
         else:
             return None
  

◆ cpuTimeTotal()

def python.trfExe.transformExecutor.cpuTimeTotal ( self )

inherited

Definition at line 430 of file trfExe.py.

     def cpuTimeTotal(self):
         if self._preExeStart and self._valStop:
             return calcCpuTime(self._preExeStart, self._valStop)
         else:
             return None
  

◆ dbMonitor()

def python.trfExe.transformExecutor.dbMonitor ( self )

inherited

Definition at line 456 of file trfExe.py.

     def dbMonitor(self):
         return self._dbMonitor

◆ doAll()

def python.trfExe.transformExecutor.doAll	(	self,
		input = `set()`,
		output = `set()`
	)

inherited

Convenience function.

Definition at line 499 of file trfExe.py.

     def doAll(self, input=set(), output=set()):
         self.preExecute(input, output)
         self.execute()
         self.postExecute()
         self.validate()
  

◆ errMsg()

def python.trfExe.transformExecutor.errMsg ( self )

inherited

Definition at line 304 of file trfExe.py.

     def errMsg(self):
         return self._errMsg
     

◆ eventCount()

def python.trfExe.transformExecutor.eventCount ( self )

inherited

Definition at line 444 of file trfExe.py.

     def eventCount(self):
         return self._eventCount
  

◆ exe() [1/2]

def python.trfExe.scriptExecutor.exe ( self )

Definition at line 641 of file trfExe.py.

     def exe(self):
         return self._exe
     

◆ exe() [2/2]

def python.trfExe.scriptExecutor.exe	(	self,
		value
	)

Definition at line 645 of file trfExe.py.

     def exe(self, value):
         self._exe = value
         self._extraMetadata['script'] = value
  

◆ exeArgs() [1/2]

def python.trfExe.scriptExecutor.exeArgs ( self )

Definition at line 650 of file trfExe.py.

     def exeArgs(self):
         return self._exeArgs
     

◆ exeArgs() [2/2]

def python.trfExe.scriptExecutor.exeArgs	(	self,
		value
	)

Definition at line 654 of file trfExe.py.

     def exeArgs(self, value):
         self._exeArgs = value
 #        self._extraMetadata['scriptArgs'] = value
  

◆ execute()

def python.trfExe.scriptExecutor.execute ( self )

Reimplemented from python.trfExe.transformExecutor.

Reimplemented in python.trfExe.bsMergeExecutor, and python.trfExe.POOLMergeExecutor.

Definition at line 723 of file trfExe.py.

     def execute(self):
         self._hasExecuted = True
         msg.info('Starting execution of {0} ({1})'.format(self._name, self._cmd))
         
         self._exeStart = os.times()
         msg.debug('exeStart time is {0}'.format(self._exeStart))
         if ('execOnly' in self.conf.argdict and self.conf.argdict['execOnly'] is True):
             msg.info('execOnly flag is set - execution will now switch, replacing the transform')
             os.execvp(self._cmd[0], self._cmd)
  
         encargs = {'encoding' : 'utf8'}
         try:
             # if we are already inside a container, then
             # must map /srv of the nested container to /srv of the parent container:
             # https://twiki.atlas-canada.ca/bin/view/AtlasCanada/Containers#Mount_point_summary
             if self._alreadyInContainer and self._containerSetup is not None:
                 msg.info("chdir /srv to launch a nested container for the substep")
                 os.chdir("/srv")
             p = subprocess.Popen(self._cmd, shell = False, stdout = subprocess.PIPE, stderr = subprocess.STDOUT, bufsize = 1, **encargs)
             # go back to the original working directory immediately after to store prmon in it
             if self._alreadyInContainer and self._containerSetup is not None:
                 msg.info("chdir {} after launching the nested container".format(self._workdir))
                 os.chdir(self._workdir)
  
             if self._memMonitor:
                 try:
                     self._memSummaryFile = 'prmon.summary.' + self._name + '.json'
                     self._memFullFile = 'prmon.full.' + self._name
                     memMonitorCommand = ['prmon', '--pid', str(p.pid), '--filename', 'prmon.full.' + self._name, 
                                          '--json-summary', self._memSummaryFile, '--log-filename', 'prmon.' + self._name + '.log',
                                          '--interval', '30']
                     mem_proc = subprocess.Popen(memMonitorCommand, shell = False, close_fds=True, **encargs)
                     # TODO - link mem.full.current to mem.full.SUBSTEP
                 except Exception as e:
                     msg.warning('Failed to spawn memory monitor for {0}: {1}'.format(self._name, e))
                     self._memMonitor = False
             
             while p.poll() is None:
                 line = p.stdout.readline()
                 if line:
                     self._echologger.info(line.rstrip())
             # Hoover up remaining buffered output lines
             for line in p.stdout:
                 self._echologger.info(line.rstrip())
     
             self._rc = p.returncode
             msg.info('%s executor returns %d', self._name, self._rc)
             self._exeStop = os.times()
             msg.debug('exeStop time is {0}'.format(self._exeStop))
         except OSError as e:
             errMsg = 'Execution of {0} failed and raised OSError: {1}'.format(self._cmd[0], e)
             msg.error(errMsg)
             raise trfExceptions.TransformExecutionException(trfExit.nameToCode('TRF_EXEC'), errMsg)
         finally:
             if self._memMonitor:
                 try:
                     mem_proc.send_signal(signal.SIGUSR1)
                     countWait = 0
                     while (not mem_proc.poll()) and countWait < 10:
                         time.sleep(0.1)
                         countWait += 1
                 except OSError:
                     pass
         
         

◆ exeStartTimes()

def python.trfExe.transformExecutor.exeStartTimes ( self )

inherited

Definition at line 336 of file trfExe.py.

     def exeStartTimes(self):
         return self._exeStart
  

◆ exeStopTimes()

def python.trfExe.transformExecutor.exeStopTimes ( self )

inherited

Definition at line 340 of file trfExe.py.

     def exeStopTimes(self):
         return self._exeStop
  

◆ extraMetadata()

def python.trfExe.transformExecutor.extraMetadata ( self )

inherited

Definition at line 292 of file trfExe.py.

     def extraMetadata(self):
         return self._extraMetadata
     

◆ first()

def python.trfExe.transformExecutor.first ( self )

inherited

Note: At the moment only athenaExecutor sets this property, but that might be changed...

Definition at line 325 of file trfExe.py.

     def first(self):
         if hasattr(self, '_first'):
             return self._first
         else:
             return None
  

◆ hasExecuted()

def python.trfExe.transformExecutor.hasExecuted ( self )

inherited

Definition at line 296 of file trfExe.py.

     def hasExecuted(self):
         return self._hasExecuted
     

◆ hasValidated()

def python.trfExe.transformExecutor.hasValidated ( self )

inherited

Definition at line 316 of file trfExe.py.

     def hasValidated(self):
         return self._hasValidated
     

◆ inData() [1/2]

def python.trfExe.transformExecutor.inData ( self )

inherited

Definition at line 235 of file trfExe.py.

     def inData(self):
         
         if '_inData' in dir(self):
             return self._inData
         return None
     

◆ inData() [2/2]

def python.trfExe.transformExecutor.inData	(	self,
		value
	)

inherited

Definition at line 242 of file trfExe.py.

     def inData(self, value):
         self._inData = set(value)
         

◆ inDataUpdate()

def python.trfExe.transformExecutor.inDataUpdate	(	self,
		value
	)

inherited

Definition at line 245 of file trfExe.py.

     def inDataUpdate(self, value):
         
         if '_inData' in dir(self):
             self._inData.update(value)
         else:
             
             self.inData = value

◆ input()

def python.trfExe.transformExecutor.input ( self )

inherited

Note: This returns the actual input data with which this executor ran (c.f. inData which returns all the possible data types this executor could run with)

Definition at line 276 of file trfExe.py.

     def input(self):
         
         if '_input' in dir(self):
             return self._input
         return None
     

◆ isValidated()

def python.trfExe.transformExecutor.isValidated ( self )

inherited

Definition at line 320 of file trfExe.py.

     def isValidated(self):
         return self._isValidated
     

◆ memAnalysis()

def python.trfExe.transformExecutor.memAnalysis ( self )

inherited

Definition at line 398 of file trfExe.py.

     def memAnalysis(self):
         return self._memLeakResult
  

◆ memStats()

def python.trfExe.transformExecutor.memStats ( self )

inherited

Definition at line 394 of file trfExe.py.

     def memStats(self):
         return self._memStats
  

◆ myMerger()

def python.trfExe.transformExecutor.myMerger ( self )

inherited

Now define properties for these data members.

Definition at line 207 of file trfExe.py.

     def myMerger(self):
         return self._myMerger
  

◆ name() [1/2]

def python.trfExe.transformExecutor.name ( self )

inherited

Definition at line 211 of file trfExe.py.

     def name(self):
         return self._name
  

◆ name() [2/2]

def python.trfExe.transformExecutor.name	(	self,
		value
	)

inherited

Definition at line 215 of file trfExe.py.

     def name(self, value):
         self._name = value
  

◆ outData() [1/2]

def python.trfExe.transformExecutor.outData ( self )

inherited

Definition at line 255 of file trfExe.py.

     def outData(self):
         
         if '_outData' in dir(self):
             return self._outData
         return None
  

◆ outData() [2/2]

def python.trfExe.transformExecutor.outData	(	self,
		value
	)

inherited

Definition at line 262 of file trfExe.py.

     def outData(self, value):
         self._outData = set(value)
     

◆ outDataUpdate()

def python.trfExe.transformExecutor.outDataUpdate	(	self,
		value
	)

inherited

Definition at line 265 of file trfExe.py.

     def outDataUpdate(self, value):
         
         if '_outData' in dir(self):
             self._outData.update(value)
         else:
             
             self.outData = value
     

◆ output()

def python.trfExe.transformExecutor.output ( self )

inherited

Note: This returns the actual output data with which this executor ran (c.f. outData which returns all the possible data types this executor could run with)

Definition at line 285 of file trfExe.py.

     def output(self):
         
         if '_output' in dir(self):
             return self._output
         return None
     

◆ postExeCpuTime()

def python.trfExe.transformExecutor.postExeCpuTime ( self )

inherited

Definition at line 402 of file trfExe.py.

     def postExeCpuTime(self):
         if self._exeStop and self._valStart:
             return calcCpuTime(self._exeStop, self._valStart)
         else:
             return None
  

◆ postExecute()

def python.trfExe.scriptExecutor.postExecute ( self )

Reimplemented from python.trfExe.transformExecutor.

Reimplemented in python.trfExe.bsMergeExecutor, and python.trfExe.athenaExecutor.

Definition at line 788 of file trfExe.py.

     def postExecute(self):
         if hasattr(self._exeLogFile, 'close'):
             self._exeLogFile.close()
         if self._memMonitor:
             try:
                 memFile = open(self._memSummaryFile)
                 self._memStats = json.load(memFile)
             except Exception as e:
                 msg.warning('Failed to load JSON memory summmary file {0}: {1}'.format(self._memSummaryFile, e))
                 self._memMonitor = False
                 self._memStats = {}
  
  

◆ postExeWallTime()

def python.trfExe.transformExecutor.postExeWallTime ( self )

inherited

Definition at line 409 of file trfExe.py.

     def postExeWallTime(self):
         if self._exeStop and self._valStart:
             return calcWallTime(self._exeStop, self._valStart)
         else:
             return None
  

◆ preExeCpuTime()

def python.trfExe.transformExecutor.preExeCpuTime ( self )

inherited

Definition at line 352 of file trfExe.py.

     def preExeCpuTime(self):
         if self._preExeStart and self._exeStart:
             return calcCpuTime(self._preExeStart, self._exeStart)
         else:
             return None
  

◆ preExecute()

def python.trfExe.scriptExecutor.preExecute	(	self,
		input = `set()`,
		output = `set()`
	)

Reimplemented from python.trfExe.transformExecutor.

Reimplemented in python.trfExe.archiveExecutor, python.trfExe.bsMergeExecutor, python.trfExe.NTUPMergeExecutor, python.trfExe.DQMPostProcessExecutor, python.trfExe.DQMergeExecutor, python.trfExe.reductionFrameworkExecutor, python.trfExe.POOLMergeExecutor, and python.trfExe.athenaExecutor.

Definition at line 658 of file trfExe.py.

     def preExecute(self, input = set(), output = set()):
         self.setPreExeStart()
         msg.debug('scriptExecutor: Preparing for execution of {0} with inputs {1} and outputs {2}'.format(self.name, input, output))
  
         self._input = input
         self._output = output
         
         
         if self._cmd is None:
             self._buildStandardCommand()
         msg.info('Will execute script as %s', self._cmd)
         
         # Define this here to have it for environment detection messages
         self._logFileName = "log.{0}".format(self._name)
         
         
         if 'TRF_ECHO' in os.environ:
             msg.info('TRF_ECHO envvar is set - enabling command echoing to stdout')
             self._echoOutput = True
         elif 'TRF_NOECHO' in os.environ:
             msg.info('TRF_NOECHO envvar is set - disabling command echoing to stdout')
             self._echoOutput = False
         # PS1 is for sh, bash; prompt is for tcsh and zsh
         elif isInteractiveEnv():
             msg.info('Interactive environment detected (stdio or stdout is a tty) - enabling command echoing to stdout')
             self._echoOutput = True
         elif 'TZHOME' in os.environ:
             msg.info('Tier-0 environment detected - enabling command echoing to stdout')
             self._echoOutput = True
         if self._echoOutput is False:
             msg.info('Batch/grid running - command outputs will not be echoed. Logs for {0} are in {1}'.format(self._name, self._logFileName))
  
         # Now setup special loggers for logging execution messages to stdout and file
         self._echologger = logging.getLogger(self._name)
         self._echologger.setLevel(logging.INFO)
         self._echologger.propagate = False
  
         encargs = {'encoding' : 'utf-8'}
         self._exeLogFile = logging.FileHandler(self._logFileName, mode='w', **encargs)
         self._exeLogFile.setFormatter(logging.Formatter('%(asctime)s %(message)s', datefmt='%H:%M:%S'))
         self._echologger.addHandler(self._exeLogFile)
         
         if self._echoOutput:
             self._echostream = logging.StreamHandler(_encoding_stream(sys.stdout))
             self._echostream.setFormatter(logging.Formatter('%(name)s %(asctime)s %(message)s', datefmt='%H:%M:%S'))
             self._echologger.addHandler(self._echostream)
  

◆ preExeStartTimes()

def python.trfExe.transformExecutor.preExeStartTimes ( self )

inherited

Definition at line 332 of file trfExe.py.

     def preExeStartTimes(self):
         return self._preExeStart
     

◆ preExeWallTime()

def python.trfExe.transformExecutor.preExeWallTime ( self )

inherited

Definition at line 359 of file trfExe.py.

     def preExeWallTime(self):
         if self._preExeStart and self._exeStart:
             return calcWallTime(self._preExeStart, self._exeStart)
         else:
             return None
  

◆ rc()

def python.trfExe.transformExecutor.rc ( self )

inherited

Definition at line 300 of file trfExe.py.

     def rc(self):
         return self._rc
     

◆ reSimEvent()

def python.trfExe.transformExecutor.reSimEvent ( self )

inherited

Definition at line 448 of file trfExe.py.

     def reSimEvent(self):
         return self._resimevents
  

◆ setPreExeStart()

def python.trfExe.transformExecutor.setPreExeStart ( self )

inherited

Definition at line 461 of file trfExe.py.

     def setPreExeStart(self):
         if self._preExeStart is None:
             self._preExeStart = os.times()
             msg.debug('preExeStart time is {0}'.format(self._preExeStart))
  

◆ setValStart()

def python.trfExe.transformExecutor.setValStart ( self )

inherited

Definition at line 466 of file trfExe.py.

     def setValStart(self):
         if self._valStart is None:
             self._valStart = os.times()
             msg.debug('valStart time is {0}'.format(self._valStart))
  

◆ substep()

def python.trfExe.transformExecutor.substep ( self )

inherited

Reimplemented in python.trfExe.athenaExecutor.

Definition at line 219 of file trfExe.py.

     def substep(self):
         if '_substep' in dir(self):
             return self._substep
         return None
     

◆ sysTime()

def python.trfExe.transformExecutor.sysTime ( self )

inherited

Definition at line 380 of file trfExe.py.

     def sysTime(self):
         if self._exeStart and self._exeStop:
             return self._exeStop[3] - self._exeStart[3]
         else:
             return None
  

◆ trf() [1/2]

def python.trfExe.transformExecutor.trf ( self )

inherited

Definition at line 225 of file trfExe.py.

     def trf(self):
         if '_trf' in dir(self):
             return self._trf
         return None
     

◆ trf() [2/2]

def python.trfExe.transformExecutor.trf	(	self,
		value
	)

inherited

Definition at line 231 of file trfExe.py.

     def trf(self, value):
         self._trf = value
         

◆ usrTime()

def python.trfExe.transformExecutor.usrTime ( self )

inherited

Definition at line 373 of file trfExe.py.

     def usrTime(self):
         if self._exeStart and self._exeStop:
             return self._exeStop[2] - self._exeStart[2]
         else:
             return None
         

◆ validate()

def python.trfExe.scriptExecutor.validate ( self )

Reimplemented from python.trfExe.transformExecutor.

Reimplemented in python.trfExe.DQMPostProcessExecutor, python.trfExe.DQMergeExecutor, python.trfExe.optionalAthenaExecutor, and python.trfExe.athenaExecutor.

Definition at line 801 of file trfExe.py.

     def validate(self):
         if self._valStart is None:
             self._valStart = os.times()
             msg.debug('valStart time is {0}'.format(self._valStart))
         self._hasValidated = True
         
         
         if self._rc == 0:
             msg.info('Executor {0} validated successfully (return code {1})'.format(self._name, self._rc))
             self._isValidated = True
             self._errMsg = ''
         else:
             # Want to learn as much as possible from the non-zero code
             # this is a bit hard in general, although one can do signals.
             # Probably need to be more specific per exe, i.e., athena non-zero codes
             self._isValidated = False
             if self._rc < 0:
                 # Map return codes to what the shell gives (128 + SIGNUM)
                 self._rc = 128 - self._rc
             if trfExit.codeToSignalname(self._rc) != "":
                 self._errMsg = '{0} got a {1} signal (exit code {2})'.format(self._name, trfExit.codeToSignalname(self._rc), self._rc)
             else:
                 self._errMsg = 'Non-zero return code from %s (%d)' % (self._name, self._rc)
             raise trfExceptions.TransformValidationException(trfExit.nameToCode('TRF_EXEC_FAIL'), self._errMsg)
  
         
         if 'checkEventCount' in self.conf.argdict and self.conf.argdict['checkEventCount'].returnMyValue(exe=self) is False:
             msg.info('Event counting for substep {0} is skipped'.format(self.name))
         else:
             if 'mpi' in self.conf.argdict and not mpi.mpiShouldValidate():
                 msg.info('MPI mode -- skipping output event count check')
             else:
                 checkcount=trfValidation.eventMatch(self)
                 checkcount.decide()
                 self._eventCount = checkcount.eventCount
                 msg.info('Event counting for substep {0} passed'.format(self.name))
  
         self._valStop = os.times()
         msg.debug('valStop time is {0}'.format(self._valStop))
  
  
  

◆ validation() [1/2]

def python.trfExe.transformExecutor.validation ( self )

inherited

Definition at line 308 of file trfExe.py.

     def validation(self):
         return self._validation
     

◆ validation() [2/2]

def python.trfExe.transformExecutor.validation	(	self,
		value
	)

inherited

Definition at line 312 of file trfExe.py.

     def validation(self, value):
         self._validation = value
         

◆ validationCpuTime()

def python.trfExe.transformExecutor.validationCpuTime ( self )

inherited

Definition at line 416 of file trfExe.py.

     def validationCpuTime(self):
         if self._valStart and self._valStop:
             return calcCpuTime(self._valStart, self._valStop)
         else:
             return None
     

◆ validationWallTime()

def python.trfExe.transformExecutor.validationWallTime ( self )

inherited

Definition at line 423 of file trfExe.py.

     def validationWallTime(self):
         if self._valStart and self._valStop:
             return calcWallTime(self._valStart, self._valStop)
         else:
             return None
  

◆ valStartTimes()

def python.trfExe.transformExecutor.valStartTimes ( self )

inherited

Definition at line 344 of file trfExe.py.

     def valStartTimes(self):
         return self._valStart
  

◆ valStopTimes()

def python.trfExe.transformExecutor.valStopTimes ( self )

inherited

Definition at line 348 of file trfExe.py.

     def valStopTimes(self):
         return self._valStop
     

◆ wallTime()

def python.trfExe.transformExecutor.wallTime ( self )

inherited

Definition at line 387 of file trfExe.py.

     def wallTime(self):
         if self._exeStart and self._exeStop:
             return calcWallTime(self._exeStart, self._exeStop)
         else:
             return None
         

◆ wallTimeTotal()

def python.trfExe.transformExecutor.wallTimeTotal ( self )

inherited

Definition at line 437 of file trfExe.py.

     def wallTimeTotal(self):
         if self._preExeStart and self._valStop:
             return calcWallTime(self._preExeStart, self._valStop)
         else:
             return None
         

Member Data Documentation

◆ _alreadyInContainer

python.trfExe.transformExecutor._alreadyInContainer

privateinherited

Definition at line 198 of file trfExe.py.

◆ _athenaConcurrentEvents

python.trfExe.transformExecutor._athenaConcurrentEvents

privateinherited

Definition at line 195 of file trfExe.py.

◆ _athenaMP

python.trfExe.transformExecutor._athenaMP

privateinherited

Definition at line 193 of file trfExe.py.

◆ _athenaMT

python.trfExe.transformExecutor._athenaMT

privateinherited

Definition at line 194 of file trfExe.py.

◆ _cmd

python.trfExe.scriptExecutor._cmd

private

Definition at line 635 of file trfExe.py.

◆ _containerSetup

python.trfExe.transformExecutor._containerSetup

privateinherited

Definition at line 199 of file trfExe.py.

◆ _dbMonitor

python.trfExe.transformExecutor._dbMonitor

privateinherited

Definition at line 196 of file trfExe.py.

◆ _echologger

python.trfExe.scriptExecutor._echologger

private

Definition at line 692 of file trfExe.py.

◆ _echoOutput

python.trfExe.scriptExecutor._echoOutput

private

Note: Query the environment for echo configuration Let the manual envars always win over auto-detected settings

Definition at line 632 of file trfExe.py.

◆ _echostream

python.trfExe.scriptExecutor._echostream

private

Definition at line 702 of file trfExe.py.

◆ _errMsg

python.trfExe.scriptExecutor._errMsg

private

Definition at line 811 of file trfExe.py.

◆ _eventCount

python.trfExe.scriptExecutor._eventCount

private

Check event counts (always do this by default) Do this here so that all script executors have this by default (covers most use cases with events)

Definition at line 836 of file trfExe.py.

◆ _exe

python.trfExe.scriptExecutor._exe

private

Definition at line 622 of file trfExe.py.

◆ _exeArgs

python.trfExe.scriptExecutor._exeArgs

private

Definition at line 625 of file trfExe.py.

◆ _exeLogFile

python.trfExe.scriptExecutor._exeLogFile

private

Definition at line 697 of file trfExe.py.

◆ _exeStart

python.trfExe.scriptExecutor._exeStart

private

Definition at line 727 of file trfExe.py.

◆ _exeStop

python.trfExe.scriptExecutor._exeStop

private

Definition at line 770 of file trfExe.py.

◆ _extraMetadata

python.trfExe.transformExecutor._extraMetadata

privateinherited

Definition at line 181 of file trfExe.py.

◆ _hasExecuted

python.trfExe.scriptExecutor._hasExecuted

private

Definition at line 724 of file trfExe.py.

◆ _hasValidated

python.trfExe.scriptExecutor._hasValidated

private

Definition at line 805 of file trfExe.py.

◆ _inData

python.trfExe.transformExecutor._inData

privateinherited

Definition at line 144 of file trfExe.py.

◆ _input

python.trfExe.scriptExecutor._input

private

Definition at line 662 of file trfExe.py.

◆ _isValidated

python.trfExe.scriptExecutor._isValidated

private

Definition at line 810 of file trfExe.py.

◆ _logFileName

python.trfExe.scriptExecutor._logFileName

private

Note: If an inherited class has set self._cmd leave it alone

Definition at line 671 of file trfExe.py.

◆ _memFullFile

python.trfExe.scriptExecutor._memFullFile

private

Definition at line 750 of file trfExe.py.

◆ _memLeakResult

python.trfExe.transformExecutor._memLeakResult

privateinherited

Definition at line 190 of file trfExe.py.

◆ _memMonitor

python.trfExe.scriptExecutor._memMonitor

private

Definition at line 637 of file trfExe.py.

◆ _memStats

python.trfExe.scriptExecutor._memStats

private

Definition at line 794 of file trfExe.py.

◆ _memSummaryFile

python.trfExe.scriptExecutor._memSummaryFile

private

Definition at line 749 of file trfExe.py.

◆ _myMerger

python.trfExe.transformExecutor._myMerger

privateinherited

Definition at line 202 of file trfExe.py.

◆ _name

python.trfExe.transformExecutor._name

privateinherited

Definition at line 141 of file trfExe.py.

◆ _outData

python.trfExe.transformExecutor._outData

privateinherited

Definition at line 145 of file trfExe.py.

◆ _output

python.trfExe.scriptExecutor._output

private

Definition at line 663 of file trfExe.py.

◆ _preExeStart

python.trfExe.transformExecutor._preExeStart

privateinherited

Note: Place holders for resource consumption. CPU and walltime are available for all executors but currently only athena is instrumented to fill in memory stats (and then only if PerfMonSD is enabled).

Definition at line 186 of file trfExe.py.

◆ _rc

python.trfExe.scriptExecutor._rc

private

Check rc.

Definition at line 768 of file trfExe.py.

◆ _resimevents

python.trfExe.transformExecutor._resimevents

privateinherited

Definition at line 197 of file trfExe.py.

◆ _trf

python.trfExe.transformExecutor._trf

privateinherited

Definition at line 232 of file trfExe.py.

◆ _validation

python.trfExe.transformExecutor._validation

privateinherited

Definition at line 313 of file trfExe.py.

◆ _valStart

python.trfExe.scriptExecutor._valStart

private

Definition at line 803 of file trfExe.py.

◆ _valStop

python.trfExe.scriptExecutor._valStop

private

Definition at line 839 of file trfExe.py.

◆ conf

python.trfExe.transformExecutor.conf

inherited

Executor configuration:

Note: that if conf and trf are None then we'll probably set the conf up later (this is allowed and expected to be done once the master transform has figured out what it's doing for this job)

Definition at line 163 of file trfExe.py.

◆ inData

python.trfExe.transformExecutor.inData

inherited

Note: Protect against _inData not yet being defined; Use normal setter

Definition at line 251 of file trfExe.py.

◆ outData

python.trfExe.transformExecutor.outData

inherited

Note: Protect against _outData not yet being defined; Use normal setter

Definition at line 271 of file trfExe.py.

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

trfExe.py

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _buildStandardCommand()

◆ athenaMP()

◆ cpuTime()

◆ cpuTimeTotal()

◆ dbMonitor()

◆ doAll()

◆ errMsg()

◆ eventCount()

◆ exe() [1/2]

◆ exe() [2/2]

◆ exeArgs() [1/2]

◆ exeArgs() [2/2]

◆ execute()

◆ exeStartTimes()

◆ exeStopTimes()

◆ extraMetadata()

◆ first()

◆ hasExecuted()

◆ hasValidated()

◆ inData() [1/2]

◆ inData() [2/2]

◆ inDataUpdate()

◆ input()

◆ isValidated()

◆ memAnalysis()

◆ memStats()

◆ myMerger()

◆ name() [1/2]

◆ name() [2/2]

◆ outData() [1/2]

◆ outData() [2/2]

◆ outDataUpdate()

◆ output()

◆ postExeCpuTime()

◆ postExecute()

◆ postExeWallTime()

◆ preExeCpuTime()

◆ preExecute()

◆ preExeStartTimes()

◆ preExeWallTime()

◆ rc()

◆ reSimEvent()

◆ setPreExeStart()

◆ setValStart()

◆ substep()

◆ sysTime()

◆ trf() [1/2]

◆ trf() [2/2]

◆ usrTime()

◆ validate()

◆ validation() [1/2]

◆ validation() [2/2]

◆ validationCpuTime()

◆ validationWallTime()

◆ valStartTimes()

◆ valStopTimes()

◆ wallTime()

◆ wallTimeTotal()

Member Data Documentation

◆ _alreadyInContainer

◆ _athenaConcurrentEvents

◆ _athenaMP

◆ _athenaMT

◆ _cmd

◆ _containerSetup

◆ _dbMonitor

◆ _echologger

◆ _echoOutput

◆ _echostream

◆ _errMsg

◆ _eventCount

◆ _exe

◆ init()