Add edmDumpClassVersion and checkDictionaryUpdate.py scripts to check class version and checksum updates #45423
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| class XmlParser(object): | ||
| """Parses a classes_def.xml file looking for class declarations that contain | ||
| ClassVersion attributes. Once found looks for sub-elements named 'version' | ||
| which contain the ClassVersion to checksum mappings. | ||
| """ | ||
|
|
||
| #The following are constants used to describe what data is kept | ||
| # in which index in the 'classes' member data | ||
| originalNameIndex=0 | ||
| classVersionIndex=1 | ||
| versionsToChecksumIndex = 2 | ||
|
|
||
| def __init__(self, filename, includeNonVersionedClasses=False, normalizeClassNames=True): | ||
|
There was a problem hiding this comment. The |
||
| self._file = filename | ||
| self.classes = dict() | ||
| self._presentClass = None | ||
| self._includeNonVersionedClasses = includeNonVersionedClasses | ||
| self._normalizeClassNames = normalizeClassNames | ||
| self.readClassesDefXML() | ||
| def readClassesDefXML(self): | ||
| import xml.parsers.expat | ||
| p = xml.parsers.expat.ParserCreate() | ||
| p.StartElementHandler = self.start_element | ||
| p.EndElementHandler = self.end_element | ||
| f = open(self._file) | ||
| # Replace any occurence of <>& in the attribute values by the xml parameter | ||
| rxml, nxml = f.read(), '' | ||
| q1,q2 = 0,0 | ||
| for c in rxml : | ||
| if (q1 or q2) and c == '<' : nxml += '<' | ||
| elif (q1 or q2) and c == '>' : nxml += '>' | ||
| # elif (q1 or q2) and c == '&' : nxml += '&' | ||
| else : nxml += c | ||
| if c == '"' : q1 = not q1 | ||
| if c == "'" : q2 = not q2 | ||
| try : p.Parse(nxml) | ||
| except xml.parsers.expat.ExpatError as e : | ||
| print ('--->> edmCheckClassVersion: ERROR: parsing selection file ',self._file) | ||
| print ('--->> edmCheckClassVersion: ERROR: Error is:', e) | ||
| raise | ||
| f.close() | ||
| def start_element(self,name,attrs): | ||
| if name in ('class','struct'): | ||
| if 'name' in attrs: | ||
| if 'ClassVersion' in attrs: | ||
| normalizedName = self.genNName(attrs['name']) | ||
| self.classes[normalizedName]=[attrs['name'],int(attrs['ClassVersion']),[]] | ||
| self._presentClass=normalizedName | ||
| elif self._includeNonVersionedClasses: | ||
| # skip transient data products | ||
| if not ('persistent' in attrs and attrs['persistent'] == "false"): | ||
| normalizedName = self.genNName(attrs['name']) | ||
| self.classes[normalizedName]=[attrs['name'],-1,[]] | ||
| if name == 'version': | ||
| self.classes[self._presentClass][XmlParser.versionsToChecksumIndex].append([int(attrs['ClassVersion']), | ||
| int(attrs['checksum'])]) | ||
| pass | ||
| def end_element(self,name): | ||
| if name in ('class','struct'): | ||
| self._presentClass = None | ||
| def genNName(self, name ): | ||
| if not self._normalizeClassNames: | ||
| return name | ||
| n_name = " ".join(name.split()) | ||
| for e in [ ['long long unsigned int', 'unsigned long long'], | ||
| ['long long int', 'long long'], | ||
| ['unsigned short int', 'unsigned short'], | ||
| ['short unsigned int', 'unsigned short'], | ||
| ['short int', 'short'], | ||
| ['long unsigned int', 'unsigned long'], | ||
| ['unsigned long int', 'unsigned long'], | ||
| ['long int', 'long'], | ||
| ['std::string', 'std::basic_string<char>']] : | ||
| n_name = n_name.replace(e[0],e[1]) | ||
| n_name = n_name.replace(' ','') | ||
| return n_name | ||
|
|
||
| def initCheckClass(): | ||
| """Must be called before checkClass()""" | ||
| import ROOT | ||
| ROOT.gROOT.ProcessLine("class checkclass {public: int f(char const* name) {TClass* cl = TClass::GetClass(name); bool b = false; cl->GetCheckSum(b); return (int)b;} };") | ||
| ROOT.gROOT.ProcessLine("checkclass checkTheClass;") | ||
|
|
||
|
|
||
| #The following are error codes returned from checkClass | ||
| noError = 0 | ||
| errorRootDoesNotMatchClassDef =1 | ||
| errorMustUpdateClassVersion=2 | ||
| errorMustAddChecksum=3 | ||
|
|
||
| def checkClass(name,version,versionsToChecksums): | ||
| import ROOT | ||
| c = ROOT.TClass.GetClass(name) | ||
| if not c: | ||
| raise RuntimeError("failed to load dictionary for class '"+name+"'") | ||
| temp = "checkTheClass.f(" + '"' + name + '"' + ");" | ||
| retval = ROOT.gROOT.ProcessLine(temp) | ||
| if retval == 0 : | ||
| raise RuntimeError("TClass::GetCheckSum: Failed to load dictionary for base class. See previous Error message") | ||
| classChecksum = c.GetCheckSum() | ||
| classVersion = c.GetClassVersion() | ||
|
|
||
| #does this version match what is in the file? | ||
| if version != classVersion: | ||
| return (errorRootDoesNotMatchClassDef,classVersion,classChecksum) | ||
|
|
||
| #is the version already in our list? | ||
| found = False | ||
|
|
||
| for v,cs in versionsToChecksums: | ||
| if v == version: | ||
| found = True | ||
| if classChecksum != cs: | ||
| return (errorMustUpdateClassVersion,classVersion,classChecksum) | ||
| break | ||
| if not found and classVersion != 0: | ||
| return (errorMustAddChecksum,classVersion,classChecksum) | ||
| return (noError,classVersion,classChecksum) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| import argparse | ||
|
|
||
| import FWCore.Utilities.ClassesDefXmlUtils as ClassesDefUtils | ||
|
|
||
| def main(args): | ||
| #Need to not have ROOT load .rootlogon.(C|py) since it can cause interference. | ||
makortel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| import ROOT | ||
| ROOT.PyConfig.DisableRootLogon = True | ||
|
|
||
| #Keep ROOT from trying to use X11 | ||
| ROOT.gROOT.SetBatch(True) | ||
| ROOT.gROOT.ProcessLine(".autodict") | ||
| if args.library is not None: | ||
| if ROOT.gSystem.Load(args.library) < 0 : | ||
| raise RuntimeError("failed to load library '"+args.library+"'") | ||
|
|
||
| ClassesDefUtils.initCheckClass() | ||
| p = ClassesDefUtils.XmlParser(args.xmlfile, includeNonVersionedClasses=True, normalizeClassNames=False) | ||
| for name, info in p.classes.items(): | ||
| (error, version, checksum) = ClassesDefUtils.checkClass(name, 0, {}) | ||
| print(name, version, checksum) | ||
|
|
||
| if __name__ == "__main__": | ||
| parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, | ||
| description="Prints class versions and checksums for all non-transient clases defined in a given classes_def.xml file") | ||
| parser.add_argument("-l","--lib", dest="library", type=str, | ||
| help="specify the library to load. If not set classes are found using the PluginManager") | ||
| parser.add_argument("-x","--xml_file", dest="xmlfile",default="./classes_def.xml", type=str, | ||
| help="the classes_def.xml file to read") | ||
|
|
||
| args = parser.parse_args() | ||
| main(args) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I moved the code from
edmCheckClassVersionthat I wanted to re-use into this file (with a few changes that I'll note below).There is enough of somewhat complicated code shared between
edmCheckClassVersionandedmDumpClassVersionthat I'd prefer to have theedmDumpClassVersionin CMSSW rather than in cms-bot (which then implies the need to backport to 14_0_X).