Functions
def	addIndex (filename, njobs, index=None)

def	boolfromstring (string, name)

def	cache (function)

def	castorDirExists (path)

def	clean_name (s)

def	conddb (args)

def	cppboolstring (string, name)

def	getCommandOutput2 (command)

def	parsecolor (color)

def	parsestyle (style)

def	pythonboolstring (string, name)

def	recursivesubclasses (cls)

def	replaceByMap (target, the_map)
	— Helpers —############################ More...

def	replacelast (string, old, new, count=1)

Variables
	conddbcode = None

list	fileExtensions = ["_cfg.py", ".sh", ".root"]

Function Documentation

def helperFunctions.addIndex	(	filename,
		njobs,
		index = `None`
	)

Definition at line 91 of file helperFunctions.py.

References replacelast(), and str.

Referenced by genericValidation.GenericValidation.createFiles(), genericValidation.GenericValidationData.createScript(), and genericValidation.GenericValidationData.getRepMap().

 def addIndex(filename, njobs, index = None):
     if index is None:
         return [addIndex(filename, njobs, i) for i in range(njobs)]
     if njobs == 1:
         return filename
 
     fileExtension = None
     for extension in fileExtensions:
         if filename.endswith(extension):
             fileExtension = extension
     if fileExtension is None:
         raise AllInOneError(fileName + " does not end with any of the extensions "
                                      + str(fileExtensions))
     return replacelast(filename, fileExtension, "_" + str(index) + fileExtension)
 

def helperFunctions.boolfromstring	(	string,
		name
	)

Takes a string from the configuration file
and makes it into a bool

Definition at line 167 of file helperFunctions.py.

References electrons_cff.bool, createfilelist.int, and str.

Referenced by pythonboolstring().

 def boolfromstring(string, name):
     """
     Takes a string from the configuration file
     and makes it into a bool
     """
     #try as a string, not case sensitive
     if string.lower() == "true": return True
     if string.lower() == "false": return False
     #try as a number
     try:
         return str(bool(int(string)))
     except ValueError:
         pass
     #out of options
     raise ValueError("{} has to be true or false!".format(name))
     
 

def helperFunctions.cache ( function )

Definition at line 153 of file helperFunctions.py.

References edm.print().

Referenced by EcalHitResponse.analogSignalAmplitude(), SiStripLAProfileBooker.analyze(), DTCalibrationMap.getConsts(), ConvBremPFTrackFinder.getConvBremPFRecTracks(), edm::RootTree.getEntry(), BeamConditionsMonitor.globalBeginLuminosityBlock(), RectangularEtaPhiTrackingRegion.hits(), CosmicTrackingRegion.hits_(), DeepFlavourTFJetTagsProducer.initializeGlobalCache(), DeepDoubleBTFJetTagsProducer.initializeGlobalCache(), DeepBoostedJetTagsProducer.initializeGlobalCache(), PhysicsTools::MVAModuleHelper< Record, Object, Filler >.operator()(), ClusterShapeTrackFilterProducer.produce(), HIPixelTrackFilterProducer.produce(), SiPixelDigiToRaw.produce(), edm::PtrVectorBase.PtrVectorBase(), edm::RootEmbeddedFileSequence.readOneEvent(), edm::RootFile.RootFile(), edm::EmbeddedRootSource.runHelper(), ClusterShapeTrajectoryFilter.setEvent(), PhysicsTools::MVAModuleHelper< Record, Object, Filler >.setEventSetup(), PhysicsTools::MVAModuleHelper< Record, Object, Filler >.train(), edm::refcoreimpl.tryToSetCacheItemForFirstTime(), and reco::FlavorHistoryEvent.~FlavorHistoryEvent().

 def cache(function):
     cache = {}
     def newfunction(*args, **kwargs):
         try:
             return cache[args, tuple(sorted(six.iteritems(kwargs)))]
         except TypeError:
             print(args, tuple(sorted(six.iteritems(kwargs))))
             raise
         except KeyError:
             cache[args, tuple(sorted(six.iteritems(kwargs)))] = function(*args, **kwargs)
             return newfunction(*args, **kwargs)
     newfunction.__name__ = function.__name__
     return newfunction
 

def helperFunctions.castorDirExists ( path )

This function checks if the directory given by `path` exists.

Arguments:
- `path`: Path to castor directory

Definition at line 64 of file helperFunctions.py.

References getCommandOutput2().

 def castorDirExists(path):
     """This function checks if the directory given by `path` exists.
 
     Arguments:
     - `path`: Path to castor directory
     """
 
     if path[-1] == "/":
         path = path[:-1]
     containingPath = os.path.join( *path.split("/")[:-1] )
     dirInQuestion = path.split("/")[-1]
     try:
         rawLines = getCommandOutput2("rfdir /"+containingPath).splitlines()
     except RuntimeError:
         return False
     for line in rawLines:
         if line.split()[0][0] == "d":
             if line.split()[8] == dirInQuestion:
                 return True
     return False
 

def helperFunctions.clean_name ( s )

Transforms a string into a valid variable or method name.

Arguments:
- `s`: input string

Definition at line 242 of file helperFunctions.py.

Referenced by geometryComparison.GeometryComparison.getRepMap().

 def clean_name(s):
     """Transforms a string into a valid variable or method name.
 
     Arguments:
     - `s`: input string
     """
 
     # Remove invalid characters
     s = re.sub(r"[^0-9a-zA-Z_]", "", s)
 
     # Remove leading characters until we find a letter or underscore
     s = re.sub(r"^[^a-zA-Z_]+", "", s)
 
     return s

def helperFunctions.conddb ( args )

Wrapper for conddb, so that you can run
conddb("--db", "myfile.db", "listTags"),
like from the command line, without explicitly
dealing with all the functions in CondCore/Utilities.
getcommandoutput2(conddb ...) doesn't work, it imports
the wrong sqlalchemy in CondCore/Utilities/python/conddblib.py

Definition at line 199 of file helperFunctions.py.

References getCommandOutput2(), and digitizers_cfi.strip.

Referenced by alignment.Alignment.__getConditions(), and alignment.Alignment.__testDbExist().

 def conddb(*args):
     """
     Wrapper for conddb, so that you can run
     conddb("--db", "myfile.db", "listTags"),
     like from the command line, without explicitly
     dealing with all the functions in CondCore/Utilities.
     getcommandoutput2(conddb ...) doesn't work, it imports
     the wrong sqlalchemy in CondCore/Utilities/python/conddblib.py
     """
     global conddbcode
     from tempfile import mkdtemp, NamedTemporaryFile
 
     if conddbcode is None:
         conddbfile = getCommandOutput2("which conddb").strip()
         tmpdir = mkdtemp()
         getCommandOutput2("2to3 -f print -o " + tmpdir + " -n -w " + conddbfile)
 
         with open(os.path.join(tmpdir, "conddb")) as f:
             conddb = f.read()
 
         conddbcode = conddb.replace("sys.exit", "sysexit")
 
     def sysexit(number):
         if number != 0:
             raise AllInOneError("conddb exited with status {}".format(number))
     namespace = {"sysexit": sysexit, "conddboutput": ""}
 
     bkpargv = sys.argv
     sys.argv[1:] = args
     bkpstdout = sys.stdout
     try:
         with NamedTemporaryFile(bufsize=0) as sys.stdout:
             exec(conddbcode, namespace)
             namespace["main"]()
             with open(sys.stdout.name) as f:
                 result = f.read()
     finally:
         sys.argv[:] = bkpargv
         sys.stdout = bkpstdout
 
     return result
 
 

def helperFunctions.cppboolstring	(	string,
		name
	)

Takes a string from the configuration file
and makes it into a bool string for a C++ template

Definition at line 191 of file helperFunctions.py.

References pythonboolstring().

Referenced by plottingOptions.PlottingOptionsZMuMu.__init__(), plottingOptions.PlottingOptionsOffline.__init__(), and plottingOptions.PlottingOptionsPrimaryVertex.__init__().

 def cppboolstring(string, name):
     """
     Takes a string from the configuration file
     and makes it into a bool string for a C++ template
     """
     return pythonboolstring(string, name).lower()
 

def helperFunctions.getCommandOutput2 ( command )

This function executes `command` and returns it output.

Arguments:
- `command`: Shell command to be invoked by this function.

Definition at line 49 of file helperFunctions.py.

Referenced by castorDirExists(), conddb(), geometryComparison.GeometryComparison.createScript(), validateAlignments.main(), validateAlignments.ParallelMergeJob.runJob(), and validateAlignments.ValidationJob.runJob().

 def getCommandOutput2(command):
     """This function executes `command` and returns it output.
 
     Arguments:
     - `command`: Shell command to be invoked by this function.
     """
 
     child = os.popen(command)
     data = child.read()
     err = child.close()
     if err:
         raise RuntimeError('%s failed w/ exit code %d' % (command, err))
     return data
 
 

def helperFunctions.parsecolor ( color )

Definition at line 106 of file helperFunctions.py.

References createfilelist.int, and str.

Referenced by preexistingValidation.PreexistingValidation.getRepMap().

 def parsecolor(color):
     try: #simplest case: it's an int
         return int(color)
     except ValueError:
         pass
 
     try:   #kRed, kBlue, ...
         color = str(getattr(ROOT, color))
         return int(color)
     except (AttributeError, ValueError):
         pass
 
     if color.count("+") + color.count("-") == 1:  #kRed+5, kGreen-2
         if "+" in color:                          #don't want to deal with nonassociativity of -
             split = color.split("+")
             color1 = parsecolor(split[0])
             color2 = parsecolor(split[1])
             return color1 + color2
 
         if "-" in color:
             split = color.split("-")
             color1 = parsecolor(split[0])
             color2 = parsecolor(split[1])
             return color1 - color2
 
     raise AllInOneError("color has to be an integer, a ROOT constant (kRed, kBlue, ...), or a two-term sum or difference (kGreen-5)!")
 

def helperFunctions.parsestyle ( style )

Definition at line 133 of file helperFunctions.py.

References createfilelist.int, and str.

Referenced by preexistingValidation.PreexistingValidation.getRepMap().

 def parsestyle(style):
     try: #simplest case: it's an int
         return int(style)
     except ValueError:
         pass
 
     try: #kStar, kDot, ...
         style = str(getattr(ROOT,style))
         return int(style)
     except (AttributeError, ValueError):
         pass
 
     raise AllInOneError("style has to be an integer or a ROOT constant (kDashed, kStar, ...)!")
 

def helperFunctions.pythonboolstring	(	string,
		name
	)

Takes a string from the configuration file
and makes it into a bool string for a python template

Definition at line 184 of file helperFunctions.py.

References boolfromstring(), and str.

Referenced by primaryVertexValidation.PrimaryVertexValidation.__init__(), offlineValidation.OfflineValidation.__init__(), cppboolstring(), and geometryComparison.GeometryComparison.createConfiguration().

 def pythonboolstring(string, name):
     """
     Takes a string from the configuration file
     and makes it into a bool string for a python template
     """
     return str(boolfromstring(string, name))
 

def helperFunctions.recursivesubclasses ( cls )

Definition at line 147 of file helperFunctions.py.

Referenced by presentation.ValidationPlots.validationclass().

 def recursivesubclasses(cls):
     result = [cls]
     for subcls in cls.__subclasses__():
         result += recursivesubclasses(subcls)
     return result
 

def helperFunctions.replaceByMap	(	target,
		the_map
	)

— Helpers —############################

This function replaces `.oO[key]Oo.` by `the_map[key]` in target.

Arguments:
- `target`: String which contains symbolic tags of the form `.oO[key]Oo.`
- `the_map`: Dictionary which has to contain the `key`s in `target` as keys

Definition at line 10 of file helperFunctions.py.

References str.

Referenced by zMuMuValidation.ZMuMuValidation.appendToPlots(), geometryComparison.GeometryComparison.createConfiguration(), genericValidation.GenericValidation.createFiles(), validateAlignments.createMergeScript(), genericValidation.ValidationWithPlots.createPlottingScript(), geometryComparison.GeometryComparison.createScript(), genericValidation.ValidationWithComparison.doComparison(), genericValidation.ParallelValidation.doInitMerge(), genericValidation.ParallelValidation.doMerge(), genericValidation.ValidationWithPlots.doRunPlots(), zMuMuValidation.ZMuMuValidation.filesToCompare(), alignment.Alignment.getConditions(), genericValidation.GenericValidationData.getRepMap(), offlineValidation.OfflineValidation.initMerge(), and plottingOptions.PlottingOptionsTrackSplitting.validsubdets().

 def replaceByMap(target, the_map):
     """This function replaces `.oO[key]Oo.` by `the_map[key]` in target.
 
     Arguments:
     - `target`: String which contains symbolic tags of the form `.oO[key]Oo.`
     - `the_map`: Dictionary which has to contain the `key`s in `target` as keys
     """
 
     result = target
     for key in the_map:
         lifeSaver = 10e3
         iteration = 0
         while ".oO[" in result and "]Oo." in result:
             for key in the_map:
                 try:
                     result = result.replace(".oO["+key+"]Oo.",the_map[key])
                 except TypeError:   #try a dict
                     try:
                         for keykey, value in six.iteritems(the_map[key]):
                            result = result.replace(".oO[" + key + "['" + keykey + "']]Oo.", value)
                            result = result.replace(".oO[" + key + '["' + keykey + '"]]Oo.', value)
                     except AttributeError:   #try a list
                         try:
                             for index, value in enumerate(the_map[key]):
                                 result = result.replace(".oO[" + key + "[" + str(index) + "]]Oo.", value)
                         except TypeError:
                             raise TypeError("Something is wrong in replaceByMap!  Need a string, dict, or list, but the_map(%s)=%s!"%(repr(key), repr(the_map[key])))
                 iteration += 1
             if iteration > lifeSaver:
                 problematicLines = ""
                 for line in result.splitlines():
                     if  ".oO[" in result and "]Oo." in line:
                         problematicLines += "%s\n"%line
                 msg = ("Oh Dear, there seems to be an endless loop in "
                        "replaceByMap!!\n%s\n%s"%(problematicLines, the_map))
                 raise AllInOneError(msg)
     return result
 
 

def helperFunctions.replacelast	(	string,
		old,
		new,
		count = `1`
	)

Replace the last occurances of a string

Definition at line 85 of file helperFunctions.py.

Referenced by addIndex().

 def replacelast(string, old, new, count = 1):
     """Replace the last occurances of a string"""
     return new.join(string.rsplit(old,count))
 

Variable Documentation

helperFunctions.conddbcode = None

Definition at line 198 of file helperFunctions.py.

list helperFunctions.fileExtensions = ["_cfg.py", ".sh", ".root"]

Definition at line 89 of file helperFunctions.py.

Functions

Variables

Function Documentation

Variable Documentation