python.trfArgClasses Namespace Reference

Classes
class	argFactory
	Factory class used to generate argument class instances for argparse. More...
class	argAction
class	argActionFactory
	Factory class used to generate argparse actions, actions should be used when arguments are used without value, like boolean flags. More...
class	argument
	Basic argument class holding a value which can be get and set. More...
class	argString
	String type argument. More...
class	argInt
	Int type argument. More...
class	argFloat
	Float type argument. More...
class	argBool
	Boolean type argument. More...
class	argList
	List of string arguments. More...
class	argIntList
	List of int arguments. More...
class	argKeyFloatValueList
class	argFile
	File argument class. More...
class	argYODAFile
class	argAthenaFile
	Athena file class. More...
class	argBSFile
	ByteStream file class. More...
class	argPOOLFile
	POOL file class. More...
class	argHITSFile
class	argEVNT_TRFile
class	argRDOFile
class	argEVNTFile
class	argHISTFile
	Data quality histogram file class. More...
class	argNTUPFile
	NTUP (plain ROOT) file class. More...
class	argBZ2File
	TarBZ filetype. More...
class	argFTKIPFile
	Class which defines a special input file format used in FTK simulation. More...
class	argHepEvtAsciiFile
	HEP ASCII file. More...
class	argLHEFile
	LHE ASCII file. More...
class	argSubstep
	Base class for substep arguments. More...
class	argSubstepList
	Argument class for substep lists, suitable for preExec/postExec. More...
class	argSubstepString
	String substep argument. More...
class	argSubstepBool
	Boolean substep argument. More...
class	argSubstepInt
	Int substep argument. More...
class	argSubstepFloat
	Float substep argument. More...
class	argSubstepSteering
	Special argument class to hold steering information. More...
class	argSubstepConditions
	Substep class for conditionsTag. More...
class	trfArgParser

Functions
	strToBool (string)
	Small utility to convert a string value to a boolean.
	dictSubstepMerge (dict1, dict2)
	special dictionary merger which is used for substep type arguments

Variables
	msg = logging.getLogger(__name__)

Function Documentation

dictSubstepMerge()

python.trfArgClasses.dictSubstepMerge	(		dict1,
			dict2 )

special dictionary merger which is used for substep type arguments

Uses set class to get the unique list of keys. Any key present in only one dictionary is unaltered. If the values are lists they are catenated, otherwise the values are picked from the dictionary in which it is set.

Parameters

c dict1 First dictionary

Parameters

c dict2 Second dictionary

Returns

Merged dictionary @raise trfExceptions.TransformArgException If both dictionaries contain non-list keys which are not the same.

Definition at line 2660 of file trfArgClasses.py.

def dictSubstepMerge(dict1, dict2):
    mergeDict = {}
    allKeys = set(dict1) | set(dict2)
    # Find the value type - lists are special...
    listType = False
    if len(dict1) > 0:
        if isinstance(list(dict1.values())[0], list):
            listType = True
    elif len(dict2) > 0:
        if isinstance(list(dict2.values())[0], list):
            listType = True
    if listType:
        for key in allKeys:
            mergeDict[key] = dict1.get(key, []) + dict2.get(key, [])
    else:
        for key in allKeys:
            if key in dict1 and key in dict2:
                # Don't really know what to do if these clash...
                if dict1[key] != dict2[key]:
                    raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'), 
                                                              'Merging substep arguments found clashing values for substep {0}: {1}!={2}'.format(key, dict1[key], dict2[key]))
                mergeDict[key] = dict1[key]
            elif key in dict1:
                mergeDict[key] = dict1[key]
            else:
                mergeDict[key] = dict2[key]
                
    return mergeDict
 
 

strToBool()

python.trfArgClasses.strToBool

(

string

)

Small utility to convert a string value to a boolean.

Definition at line 2639 of file trfArgClasses.py.

def strToBool(string):
    try:
        msg.debug("converting string {string} to boolean".format(string = string))
        if string.lower() == 'false':
            return False
        elif string.lower() == 'true':
            return True
        else:
            raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'), 'Failed to convert string "{0}" to bool (expected "false" or "true" case-insensitive )'.format(string))
    except AttributeError:
        raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'), 'Failed to convert value {0} to bool'.format(string))
 

Variable Documentation

msg

python.trfArgClasses.msg = logging.getLogger(__name__)

Definition at line 17 of file trfArgClasses.py.