Functions
def	bsBugFix ()

def	costumFormatter (inp)

def	fillContentTemplate (domains)

def	generateTree (tree)

def	generateTreeViewPage (tree, name)

def	getClasses (classesPagePath)

def	getFiles (filesPagePath)

def	getPackages (packagesPagePath)

def	prepareTemplate ()

Variables
	classes

	cmsswVersion

	contentTmpl

	contentTmplOrg

	data

	dataSrc

	file

	files

	fName

	githubBase

	htmlFileName

	htmlFilePath

	htmlFullPath

	htmlPage

	link

	loopLimit

	packages

	page

	successFlag

	tree

	treeViewTmpl

Function Documentation

◆ bsBugFix()

def MainPageGenerator.bsBugFix ( )

Definition at line 125 of file MainPageGenerator.py.

 def bsBugFix():
     # this function fixes script tag bug of beautifulsoup (bs). bs is escaping
     # javascript operators according to the html escape characters, such as
     # > -> "&gt;". The method to ged rid of this issue is to replace script
     # tags with their original versions in the string level
     html = str(htmlPage)
     for scriptTag in BeautifulSoup(contentTmplOrg).findAll('script'):
         js = scriptTag.text
         html = html.replace(str(scriptTag), '<script>%s</script>' % js)
     return html
  

References str.

◆ costumFormatter()

def MainPageGenerator.costumFormatter ( inp )

Definition at line 121 of file MainPageGenerator.py.

 def costumFormatter(inp):
     if inp.find_parent("script") is None: return EntitySubstitution.substitute_html(inp) 
     else: return inp
  

◆ fillContentTemplate()

def MainPageGenerator.fillContentTemplate ( domains )

Definition at line 136 of file MainPageGenerator.py.

 def fillContentTemplate(domains):
     rows = ''
     rowTmpl = '<tr id="{0}"><td width="50%">{1}</td><td>{2}</td></tr>'
     aTmpl = """<tr style="padding:0"><td colspan="2" style="padding:0">
                <div class="accordion" id="{0}">
                <iframe width="100%" height="250px" frameborder="0" 
                data-src="iframes/{0}.html"> </iframe>
                </div></td></tr>"""
     domainNames = domains.keys()
     domainNames.sort()
     for domain in domainNames:
         persons = domains[domain].keys()
         persons.sort() 
         cCell = ''
         for person in persons:
             email = domains[domain][person]
             cCell = cCell+'<a href="mailto:{0}">{0}<a/>, '.format(person,email)
         cCell = cCell.rstrip(', ')
         escapedDomainName = domain.replace(' ', '')
         rows  = rows + rowTmpl.format(escapedDomainName, domain, cCell)
         rows  = rows + aTmpl.format(escapedDomainName)
     contentTmpl.find('table').append(BeautifulSoup(rows))
     # put cmssw version
     contentTmpl.find('h2', {'id' : 'version'}).append(cmsswVersion)
     content = htmlPage.find('div', {'class' : 'contents'})
     content.append(contentTmpl)
  

References mps_setup.append, and relativeConstraints.keys.

◆ generateTree()

def MainPageGenerator.generateTree ( tree )

Definition at line 163 of file MainPageGenerator.py.

 def generateTree(tree):
     if type(tree) == dict and len(tree) == 0: return BeautifulSoup('')
     # our recursive function to generate domain tree views
     root = BeautifulSoup('<ul></ul>')
     names = tree.keys(); names.sort()
     for name in names:
         node = BeautifulSoup('<li><div></div></li>')
         if type(tree[name]) == dict:
             title = BeautifulSoup('<span class="folder"></span>')
             title.span.append(name)
             node.li.append(title)
             # __git__ and __packageDoc__ are special keys which address links,
             # github and packade documentation links. please see in the section
             # that we merge all what we have (under the __main__ block)
             for i in ['__git__', '__packageDoc__']:
                 if not i in tree[name]: continue
                 link = BeautifulSoup(' <a></a>')
                 link.a['target'] = '_blank'
                 link.a['href']   = tree[name][i]
                 link.a.append('[%s]' % i.replace('_', ''))
                 del tree[name][i]
                 title.span.append(link)
             if len(tree[name]) == 0:
                 title.span['class'] = 'emptyFolder'
             else: node.li.div['class'] = 'hitarea expandable-hitarea'
             node.li.append(generateTree(tree[name]))
         elif type(tree[name]) == str or type(tree[name]) == unicode:
             link = BeautifulSoup('<a><span class="file"></span></a>')
             link.a['target'] = '_blank'
             link.a['href']   = tree[name]
             link.a.span.append(name)
             node.li.append(link)
         else:
             node.li.append(name)
         root.ul.append(node)
     return root
  

Referenced by generateTreeViewPage().

◆ generateTreeViewPage()

def MainPageGenerator.generateTreeViewPage	(	tree,
		name
	)

Definition at line 200 of file MainPageGenerator.py.

 def generateTreeViewPage(tree, name):
     page = BeautifulSoup(treeViewTmpl)
     treeTag = page.find('ul', {'id' : 'browser'})
     treeTag.append(generateTree(tree))
     twikiLink = page.find('a', {'id' : 'twiki'})
     if name in data['TWIKI_PAGES']:
         twikiLink['href'] = data['TWIKI_PAGES'][name]
     else:
         twikiLink.extract()
     return page
     
  

References generateTree().

◆ getClasses()

def MainPageGenerator.getClasses ( classesPagePath )

Definition at line 99 of file MainPageGenerator.py.

 def getClasses(classesPagePath):
     data = {}
     with open(classesPagePath) as f: page = f.read()
     page  = BeautifulSoup(page)
     content = page.find('div', {'class' : 'contents'})
     for cell in content.findAll('td'):
         aTag = cell.find('a')
         if not aTag or not aTag.has_key('href'): continue
         data[aTag.text] = '../' + aTag['href']
     return data
  

◆ getFiles()

def MainPageGenerator.getFiles ( filesPagePath )

Definition at line 40 of file MainPageGenerator.py.

 def getFiles(filesPagePath):
     data = {}
     # read and parse files.html to get the file hierarchy
     with open(filesPagePath) as f: page = f.read()
     page = BeautifulSoup(page)
     # please have a look at the files.html page to understand the approach.
     # in short, we use number of '_' character in the id attr to read the
     # file hierarchy.
     table     = page.find('table', {'class' : 'directory'})
     level     = 0
     path      = []
     for row in table.findAll('tr'):
         # first cell is the cell where the info is stored
         id   = row['id']; cell = row.find('td') 
         text = cell.text; url  = '../' + cell.find('a')['href']
         currentLevel = id.count('_')
         # if current level is more than old one, push current item
         if currentLevel > level:
             path.append(text)
         # if current level equals to old one, pop anmd push (replace)
         elif currentLevel == level:
             path.pop(len(path) - 1)
             path.append(text)
         else:
         # if current level is less than old one, pop all items to blance
         # the level. 'plus one' in the loop is to replace last item
             for i in range(level - currentLevel + 1):
                 path.pop(len(path) - 1)
             path.append(text)
         level = id.count('_')
         # skip files which are not interface
         if not 'interface' in path: continue
         # no need to have 'interface' node on the tree
         pathWithoutInterface = copy.copy(path)
         pathWithoutInterface.remove('interface')
         # conver the path into tree structure
         node = data
         for i in pathWithoutInterface:
             if not node.has_key(i):
                 node[i] = {}
             node = node[i]
     return data
  

References FastTimerService_cff.range.

◆ getPackages()

def MainPageGenerator.getPackages ( packagesPagePath )

Definition at line 83 of file MainPageGenerator.py.

 def getPackages(packagesPagePath):
     data = {}
     with open(packagesPagePath) as f: page = f.read()
     page  = BeautifulSoup(page)
     table = page.find('table', {'class' : 'directory'})
     for row in table.findAll('tr'):
         cell = row.find('td')
         url  = '../' + cell.find('a')['href']
         # yeah, it is not that good method to parse a string but it is
         # simple... please see the pages.html file.
         pkg = cell.text.replace('Package ', '').split('/')
         if not data.has_key(pkg[0]): data[pkg[0]] = {}
         if len(pkg) == 2: data[pkg[0]][pkg[1]] = url
         else: data[pkg[0]][pkg[0]] = url
     return data
  

References submitPVValidationJobs.split().

◆ prepareTemplate()

def MainPageGenerator.prepareTemplate ( )

Definition at line 110 of file MainPageGenerator.py.

 def prepareTemplate():
     # please notice the following hard coded tags and class names, you may need
     # to change them in future if doxygen changes its html output structure
     header  = htmlPage.find('div', {'class' : 'header'})
     content = htmlPage.find('div', {'class' : 'contents'})
  
     for tag in header.findAll():
         tag.extract()
     for tag in content.findAll():
         tag.extract()
  

Variable Documentation

◆ classes

MainPageGenerator.classes

Definition at line 262 of file MainPageGenerator.py.

◆ cmsswVersion

MainPageGenerator.cmsswVersion

Definition at line 36 of file MainPageGenerator.py.

◆ contentTmpl

MainPageGenerator.contentTmpl

Definition at line 32 of file MainPageGenerator.py.

◆ contentTmplOrg

MainPageGenerator.contentTmplOrg

Definition at line 31 of file MainPageGenerator.py.

◆ data

MainPageGenerator.data

Definition at line 35 of file MainPageGenerator.py.

◆ dataSrc

MainPageGenerator.dataSrc

Definition at line 33 of file MainPageGenerator.py.

◆ file

MainPageGenerator.file

Definition at line 279 of file MainPageGenerator.py.

◆ files

MainPageGenerator.files

Definition at line 256 of file MainPageGenerator.py.

◆ fName

MainPageGenerator.fName

Definition at line 301 of file MainPageGenerator.py.

Referenced by FilterSelection.acceptMap(), XMLDocument.addAttribute(), OMTFReconstruction.beginRun(), CaloMeanResponse.CaloMeanResponse(), classNameFinder(), OMTFPatternMaker.endJob(), OMTFReconstruction.endJob(), XMLConfigWriter.finaliseXMLDocument(), JetCorrector.getJetCorrector(), omtf::RpcLinkMap.init(), edm::RootInputFileSequence.initTheFile(), L1TMuonOverlapParamsESProducer.L1TMuonOverlapParamsESProducer(), XMLDocument.newElement(), XMLDocument.newValue(), ParticlePDG.ParticlePDG(), FilterSelection.print(), l1t::XmlConfigParser.readDOMFromFile(), CSCSectorReceiverLUT.readLUTsFromFile(), CaloMeanResponse.readResponse(), HCalSD.readWeightFromFile(), XMLConfigReader.setConfigFile(), XMLConfigReader.setEventsFile(), XMLConfigReader.setPatternsFile(), TTClusterAlgorithm< T >.TTClusterAlgorithm(), TTStubAlgorithm< T >.TTStubAlgorithm(), SummaryOutputProducer.write(), EcalDccWeightBuilder.writeWeightToAsciiFile(), and EcalDccWeightBuilder.writeWeightToRootFile().

◆ githubBase

MainPageGenerator.githubBase

Definition at line 34 of file MainPageGenerator.py.

◆ htmlFileName

MainPageGenerator.htmlFileName

Definition at line 22 of file MainPageGenerator.py.

◆ htmlFilePath

MainPageGenerator.htmlFilePath

Definition at line 21 of file MainPageGenerator.py.

◆ htmlFullPath

MainPageGenerator.htmlFullPath

Definition at line 20 of file MainPageGenerator.py.

◆ htmlPage

MainPageGenerator.htmlPage

Definition at line 23 of file MainPageGenerator.py.

◆ link

MainPageGenerator.link

Definition at line 271 of file MainPageGenerator.py.

Referenced by sipixelobjects::PixelFEDCabling.addLink(), GEMDigiModule.addLinks(), ME0DigiModel.addLinks(), GEMPadDigiClusterValidation.analyze(), GEMPadDigiValidation.analyze(), GEMStripDigiValidation.analyze(), GEMRecHitValidation.analyze(), L1TStage2uGMT.analyze(), L1TCSCTF.analyze(), CSCHitAssociator.associateCSCHitId(), CSCHitAssociator.associateHitId(), EcalABAnalyzer.beginJob(), DTDataIntegrityUrosOffline.bookHistosROS(), DTDataIntegrityTask.bookHistosROS(), DTReadOutMapping.cacheMap(), l1t::stage2::emtf.convert_GEM_location(), convert_L2toL1_card(), convert_L2toL1_link(), l1t::stage2::emtf.convert_RPC_location(), L1TMuonProducer.convertMuons(), SiPixelFedCablingTree.det2fedMap(), SiPixelFedCablingTree.det2PathMap(), tmtt::MiniHTstage.exec(), tmtt::MuxHToutputs.exec(), DTBlockedROChannelsTest.fillChamberMap(), SiPixelFrameReverter.findLinkInFed(), DTReadOutMapping.geometryToReadOut(), get_towerPhi_fromCardLinkTower(), l1t::MP7BufferDumpToRaw.getBlocks(), getEta_fromL2LinkCardTowerCrystal(), SiPixelROCsStatusAndMappingWrapper.getModToUnpRegionalAsync(), RPCAMCLinkMapHandler.getNewObjects(), RPCDCCLinkMapHandler.getNewObjects(), getPhi_fromL2LinkCardTowerCrystal(), DTDataIntegrityTest.getROS(), l1t::stage2::CaloSetup.getUnpackers(), HLTMuonTrimuonL3Filter.hltFilter(), HLTMuonL3PreFilter.hltFilter(), HLTMuonDimuonL3Filter.hltFilter(), HOTPDigiTwinMux.HOTPDigiTwinMux(), RPCReadOutMappingWithFastSearch.init(), DTHitAssociator.initEvent(), DTReadOutMapping.insertReadOutGeometryLink(), CTPPSPixelDataFormatter.interpretRawData(), PixelDataFormatter.interpretRawData(), CSCSPRecord.LCT(), CSCSPRecord.LCTs(), tmtt::MuxHToutputs.linkID(), tmtt::MiniHTstage.linkIDLoadBalanced(), PixelEndcapLinkMaker.links(), PixelBarrelLinkMaker.links(), omtf.mapEleIndex2CscDet(), SiPixelFedCablingMap::Key.operator<(), operator<<(), l1t::stage2::BMTFPackerInputs.pack(), omtf::CscPacker.pack(), SiPixelFedCablingTree.pathToDetUnit(), SiPixelFedCablingTree.pathToDetUnitHasDetUnit(), DTuROSRawToDigi.process(), DTuROSDigiToRaw.process(), PFAnalysis.processBlocks(), RPCCPPFUnpacker.processCPPF(), RPCTwinMuxRawToDigi.processRPCRecord(), RPCCPPFUnpacker.processRXRecord(), RPCCPPFUnpacker.processTXRecord(), DTDataIntegrityUrosOffline.processuROS(), DTDataIntegrityTask.processuROS(), MuonLinksProducerForHLT.produce(), CSCTFPacker.produce(), HLTMuonL2SelectorForL3IO.produce(), CSCTFUnpacker.produce(), L3MuonCandidateProducer.produce(), HLTScoutingMuonProducer.produce(), L2MuonSeedGeneratorFromL1T.produce(), RPCReadOutMapping.rawDataFrame(), DTReadOutMapping.readOutToGeometry(), LaserSorter.renameAsBackup(), tmtt::MuxHToutputs.sanityCheck(), boost::serialization.save(), CSCCorrelatedLCTDigi.setMPCLink(), SiPixelFedCablingMap.SiPixelFedCablingMap(), SiPixelROCsStatusAndMappingWrapper.SiPixelROCsStatusAndMappingWrapper(), L1TMuonProducer.splitAndConvertMuons(), DTBlockedROChannelsTest.theDDU(), DTDataIntegrityUrosOffline.theDDU(), DTDataIntegrityTask.theDDU(), DTuROSRawToDigi.theDDU(), DTuROSDigiToRaw.theLNK(), DTBlockedROChannelsTest.theROB(), DTuROSRawToDigi.theROB(), DTBlockedROChannelsTest.theROS(), DTDataIntegrityUrosOffline.theROS(), DTDataIntegrityTask.theROS(), DTuROSRawToDigi.theROS(), SiPixelFrameConverter.toRoc(), l1t::stage2::CaloTowerUnpacker.unpack(), omtf::MuonUnpacker.unpack(), CSCSPRecord.unpack(), and PixelDataFormatter.unpackFEDErrors().

◆ loopLimit

MainPageGenerator.loopLimit

Definition at line 236 of file MainPageGenerator.py.

◆ packages

MainPageGenerator.packages

Definition at line 259 of file MainPageGenerator.py.

◆ page

MainPageGenerator.page

Definition at line 300 of file MainPageGenerator.py.

◆ successFlag

MainPageGenerator.successFlag