python.trfExeStepTools Namespace Reference

Functions
	commonExecutorStepName (name)
	loadSplitConfig (config)
	getTotalExecutorSteps (executor, argdict=None)
	getExecutorStepEventCounts (executor, argdict=None)

Variables
str	executorStepSuffix = 'ExecutorStep'

Function Documentation

commonExecutorStepName()

python.trfExeStepTools.commonExecutorStepName

(

name

)

Remove executor step suffix from executor name.

Definition at line 7 of file trfExeStepTools.py.

def commonExecutorStepName(name):
    """Remove executor step suffix from executor name."""
    if executorStepSuffix in name:
        name, _sep, _tail = name.rpartition(executorStepSuffix)
    return name
 
 

getExecutorStepEventCounts()

python.trfExeStepTools.getExecutorStepEventCounts	(		executor,
			argdict = None )

Get executor step event counts from executor config.

Definition at line 44 of file trfExeStepTools.py.

def getExecutorStepEventCounts(executor, argdict=None):
    """Get executor step event counts from executor config."""
    if not argdict:
        argdict = executor.conf.argdict
    if 'splitConfig' not in argdict:
        return []
 
    maxEvents = argdict['maxEvents'].returnMyValue(exe=executor)
    skipEvents = argdict['skipEvents'].returnMyValue(exe=executor)
    splitConfig = argdict['splitConfig'].returnMyValue(exe=executor)
    if not splitConfig:
        return []
 
    steps, fractions = loadSplitConfig(splitConfig)
 
    if sum(fractions) != 1:
        raise ValueError('Event fractions should total to 1!')
 
    counts = []
    for i in range(len(fractions) - 1):
        counts.append(round(maxEvents * fractions[i]))
    counts.append(maxEvents - sum(counts))
 
    sums = []
    for i in range(len(fractions)):
        sums.append(skipEvents + sum(counts[:i]))
 
    return counts, sums

getTotalExecutorSteps()

python.trfExeStepTools.getTotalExecutorSteps	(		executor,
			argdict = None )

Get total executor steps from executor.

Definition at line 29 of file trfExeStepTools.py.

def getTotalExecutorSteps(executor, argdict=None):
    """Get total executor steps from executor."""
    if not argdict:
        argdict = executor.conf.argdict
    if 'splitConfig' not in argdict:
        return 0
 
    splitConfig = argdict['splitConfig'].returnMyValue(exe=executor)
    if not splitConfig:
        return 0
 
    steps, fractions = loadSplitConfig(splitConfig)
    return steps
 
 

loadSplitConfig()

python.trfExeStepTools.loadSplitConfig

(

config

)

Load splitting configuration from file.

Definition at line 14 of file trfExeStepTools.py.

def loadSplitConfig(config):
    """Load splitting configuration from file."""
    parts = config.split('.')
    if len(parts) < 2:
        raise ValueError('Splitting config should be of the form Package.Module.Function or Package.Function if defined in __init__.py')
 
    function = parts[-1]
    module = '.'.join(parts[:-1])
 
    from importlib import import_module
    loaded_module = import_module(module)
    function_def = getattr(loaded_module, function)
    return function_def()
 
 

Variable Documentation

executorStepSuffix

str python.trfExeStepTools.executorStepSuffix = 'ExecutorStep'

Definition at line 4 of file trfExeStepTools.py.