CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Private Member Functions | Private Attributes
html.Page Class Reference
Inheritance diagram for html.Page:
html.TrackingIterPage

Public Member Functions

def __init__
 
def addPlotSet
 
def addTable
 
def isEmpty
 
def write
 

Private Member Functions

def _appendColumnHeader
 
def _appendLegend
 
def _formatLegend
 
def _formatPlotSets
 
def _formatTables
 
def _mapSectionName
 
def _orderSets
 

Private Attributes

 _columnHeaders
 
 _columnHeadersIndex
 
 _content
 
 _legends
 
 _plotSets
 
 _sectionLegendIndex
 
 _tables
 

Detailed Description

Definition at line 350 of file html.py.

Constructor & Destructor Documentation

def html.Page.__init__ (   self,
  title,
  sampleName 
)

Definition at line 351 of file html.py.

351 
352  def __init__(self, title, sampleName):
353  self._content = [
354  '<html>',
355  ' <head>',
356  ' <title>%s</title>' % title,
357  ' </head>',
358  ' <body>',
359  ' '+sampleName,
360  ' <br/>',
361  ' <br/>',
362  ]
363 
364  self._plotSets = {}
365  self._tables = {}
html.Page._content
_content
Definition: html.py:352
html.Page._plotSets
_plotSets
Definition: html.py:363
html.Page.__init__
def __init__
Definition: html.py:351
html.Page._tables
_tables
Definition: html.py:364

Member Function Documentation

def html.Page._appendColumnHeader (   self,
  header 
)
private

Definition at line 474 of file html.py.

References html.Table._columnHeaders, html.Page._columnHeaders, html.Page._columnHeadersIndex, and str.

Referenced by html.Page._formatTables().

474 
475  def _appendColumnHeader(self, header):
476  leg = ""
477  if header in self._columnHeadersIndex:
478  leg = self._columnHeadersIndex[header]
479  else:
480  leg = str(chr(ord('A')+len(self._columnHeaders)))
481  self._columnHeaders.append("%s: %s" % (leg, header))
482  self._columnHeadersIndex[header] = leg
483  return leg
html.Page._columnHeaders
_columnHeaders
Definition: html.py:388
html.Page._columnHeadersIndex
_columnHeadersIndex
Definition: html.py:389
str
#define str(s)
Definition: TestProcessor.cc:54
html.Page._appendColumnHeader
def _appendColumnHeader
Definition: html.py:474
def html.Page._appendLegend (   self,
  section 
)
private

Definition at line 406 of file html.py.

References html.Page._legends, html.Page._sectionLegendIndex, and html._sectionNameLegend().

Referenced by html.Page._formatPlotSets(), and html.Page._formatTables().

406 
407  def _appendLegend(self, section):
408  leg = ""
409  legends = _sectionNameLegend()
410  if section in legends:
411  if section in self._sectionLegendIndex:
412  leg = self._sectionLegendIndex[section]
413  else:
414  legnum = len(self._legends)+1
415  leg = "<sup>%d</sup>" % legnum
416  leg2 = "<sup>%d)</sup>" % legnum
417  self._legends.append("%s %s" % (leg2, legends[section]))
418  self._sectionLegendIndex[section] = leg
419  return leg
html.Page._legends
_legends
Definition: html.py:386
html._sectionNameLegend
def _sectionNameLegend
Definition: html.py:261
html.Page._appendLegend
def _appendLegend
Definition: html.py:406
html.Page._sectionLegendIndex
_sectionLegendIndex
Definition: html.py:387
def html.Page._formatLegend (   self)
private

Definition at line 538 of file html.py.

References html.Page._legends.

538 
539  def _formatLegend(self):
540  if len(self._legends) > 0:
541  self._content.extend([
542  ' <br/>'
543  ' Details:</br>',
544  ])
545  for leg in self._legends:
546  self._content.append(' %s<br/>' % leg)
547 
html.Page._legends
_legends
Definition: html.py:386
html.Page._formatLegend
def _formatLegend
Definition: html.py:538
def html.Page._formatPlotSets (   self)
private

Definition at line 420 of file html.py.

References html.Page._appendLegend(), html.Page._mapSectionName(), html.Page._orderSets(), and html.Page._plotSets.

420 
421  def _formatPlotSets(self):
422  self._content.extend([
423  ' <table>'
424  ' <tr>',
425  ])
426 
427  fileTable = []
428 
429  sections = self._orderSets(list(self._plotSets.keys()))
430  for isec, section in enumerate(sections):
431  leg = self._appendLegend(section)
432 
433  self._content.extend([
434  ' <td>%s%s</td>' % (self._mapSectionName(section), leg),
435  ])
436  files = [(os.path.basename(f), f) for f in self._plotSets[section]]
437  for row in fileTable:
438  found = False
439  for i, (bsf, f) in enumerate(files):
440  if bsf == row[0]:
441  row.append(f)
442  found = True
443  del files[i]
444  break
445  if not found:
446  row.append(None)
447  for bsf, f in files:
448  fileTable.append( [bsf] + [None]*isec + [f] )
449 
450  self._content.extend([
451  ' </tr>',
452  ])
453 
454  for row in fileTable:
455  self._content.append(' <tr>')
456  bs = row[0]
457  for elem in row[1:]:
458  if elem is not None:
459  self._content.append(' <td><a href="%s">%s</a></td>' % (elem, bs))
460  else:
461  self._content.append(' <td></td>')
462  self._content.append(' </tr>')
463 
464 
465  self._content.extend([
466  ' </table>',
467  ])
468 
469  if len(fileTable):
470  first_row = fileTable[0]
471  self._content.extend([
472  ' <a href="%s">Browse Folder</a>' % (first_row[1][0:first_row[1].rfind('/')])
473  ])
html.Page._formatPlotSets
def _formatPlotSets
Definition: html.py:420
html.Page._orderSets
def _orderSets
Definition: html.py:551
html.Page._plotSets
_plotSets
Definition: html.py:363
html.Page._appendLegend
def _appendLegend
Definition: html.py:406
html.Page._mapSectionName
def _mapSectionName
Definition: html.py:548
def html.Page._formatTables (   self)
private

Definition at line 484 of file html.py.

References html.Page._appendColumnHeader(), html.Page._appendLegend(), html.Table._columnHeaders, html.Page._columnHeaders, html.Page._columnHeadersIndex, html.Page._mapSectionName(), html.Page._orderSets(), html.Page._tables, SiStripPI.max, and str.

484 
485  def _formatTables(self):
486  def _allNone(row):
487  for item in row:
488  if item is not None:
489  return False
490  return True
491 
492  sections = self._orderSets(list(self._tables.keys()))
493  for isec, section in enumerate(sections):
494  leg = self._appendLegend(section)
495 
496  table = self._tables[section]
497  self._content.extend([
498  ' <br/>',
499  ' %s%s' % (self._mapSectionName(section), leg),
500  ' <table border="1">'
501  ])
502 
503  # table is stored in column-row, need to transpose
504  data = table.tableAsRowColumn()
505 
506  self._content.extend([
507  ' <tr>'
508  ' <td></td>'
509  ])
510  heads = table.columnHeaders()
511  if max(map(lambda h: len(h), heads)) > 20:
512  heads = [self._appendColumnHeader(h) for h in heads]
513  for head in heads:
514  self._content.append(' <td>%s</td>' % head)
515  self._content.append(' </tr>')
516 
517  for irow, row in enumerate(data):
518  # Skip row if all values are non-existent
519  if _allNone(row):
520  continue
521 
522  self._content.extend([
523  ' <tr>'
524  ' <td>%s</td>' % table.rowHeaders()[irow]
525  ])
526  # align the number columns to right
527  for icol, item in enumerate(row):
528  formatted = str(item) if item is not None else ""
529  self._content.append(' <td align="right">%s</td>' % formatted)
530  self._content.append(' </tr>')
531 
532  self._content.append(' </table>')
533 
534  for shortenedColumnHeader in self._columnHeaders:
535  self._content.append(' %s<br/>' % shortenedColumnHeader)
536  self._columnHeaders = []
537  self._columnHeadersIndex = {}
html.Page._formatTables
def _formatTables
Definition: html.py:484
html.Page._columnHeaders
_columnHeaders
Definition: html.py:388
html.Page._orderSets
def _orderSets
Definition: html.py:551
html.Page._appendLegend
def _appendLegend
Definition: html.py:406
html.Page._columnHeadersIndex
_columnHeadersIndex
Definition: html.py:389
html.Page._mapSectionName
def _mapSectionName
Definition: html.py:548
html.Page._tables
_tables
Definition: html.py:364
str
#define str(s)
Definition: TestProcessor.cc:54
html.Page._appendColumnHeader
def _appendColumnHeader
Definition: html.py:474
def html.Page._mapSectionName (   self,
  section 
)
private

Definition at line 548 of file html.py.

Referenced by html.Page._formatPlotSets(), and html.Page._formatTables().

548 
549  def _mapSectionName(self, section):
550  return _sectionNameMapOrder.get(section, section)
html.Page._mapSectionName
def _mapSectionName
Definition: html.py:548
def html.Page._orderSets (   self,
  keys 
)
private

Definition at line 551 of file html.py.

Referenced by html.Page._formatPlotSets(), and html.Page._formatTables().

551 
552  def _orderSets(self, keys):
553  keys_sorted = sorted(keys)
554  ret = []
555  for section in _sectionNameMapOrder.keys():
556  if section in keys_sorted:
557  ret.append(section)
558  keys_sorted.remove(section)
559  ret.extend(keys_sorted)
560  return ret
html.Page._orderSets
def _orderSets
Definition: html.py:551
def html.Page.addPlotSet (   self,
  section,
  plotSet 
)

Definition at line 366 of file html.py.

References html.Page._plotSets.

366 
367  def addPlotSet(self, section, plotSet):
368  if section in self._plotSets:
369  self._plotSets[section].extend(plotSet)
370  else:
371  self._plotSets[section] = plotSet
html.Page.addPlotSet
def addPlotSet
Definition: html.py:366
html.Page._plotSets
_plotSets
Definition: html.py:363
def html.Page.addTable (   self,
  section,
  table 
)

Definition at line 372 of file html.py.

References html.Page._tables.

372 
373  def addTable(self, section, table):
374  self._tables[section] = table
html.Page._tables
_tables
Definition: html.py:364
html.Page.addTable
def addTable
Definition: html.py:372
def html.Page.isEmpty (   self)

Definition at line 375 of file html.py.

References html.Page._tables.

Referenced by plotting.Plot.clone().

375 
376  def isEmpty(self):
377  for plotSet in self._plotSets.values():
378  if len(plotSet) > 0:
379  return False
380 
381  if len(self._tables) > 0:
382  return False
383 
384  return True
html.Page._tables
_tables
Definition: html.py:364
html.Page.isEmpty
def isEmpty
Definition: html.py:375
def html.Page.write (   self,
  fileName 
)

Definition at line 385 of file html.py.

385 
386  def write(self, fileName):
387  self._legends = []
388  self._sectionLegendIndex = {}
389  self._columnHeaders = []
390  self._columnHeadersIndex = {}
391  self._formatPlotSets()
392  self._formatTables()
393  self._formatLegend()
394 
395  self._content.extend([
396  ' </body>',
397  '</html>',
398  ])
399 
400  #print "Writing HTML report page", fileName
401  f = open(fileName, "w")
402  for line in self._content:
403  f.write(line)
404  f.write("\n")
405  f.close()
html.Page._formatPlotSets
def _formatPlotSets
Definition: html.py:420
html.Page._legends
_legends
Definition: html.py:386
html.Page._content
_content
Definition: html.py:352
html.Page._formatTables
def _formatTables
Definition: html.py:484
html.Page._formatLegend
def _formatLegend
Definition: html.py:538
html.Page._columnHeaders
_columnHeaders
Definition: html.py:388
html.Page.write
def write
Definition: html.py:385
html.Page._columnHeadersIndex
_columnHeadersIndex
Definition: html.py:389
html.Page._sectionLegendIndex
_sectionLegendIndex
Definition: html.py:387

Member Data Documentation

html.Page._columnHeaders
private

Definition at line 388 of file html.py.

Referenced by html.Page._appendColumnHeader(), and html.Page._formatTables().

html.Page._columnHeadersIndex
private

Definition at line 389 of file html.py.

Referenced by html.Page._appendColumnHeader(), and html.Page._formatTables().

html.Page._content
private

Definition at line 352 of file html.py.

html.Page._legends
private

Definition at line 386 of file html.py.

Referenced by html.Page._appendLegend(), and html.Page._formatLegend().

html.Page._plotSets
private

Definition at line 363 of file html.py.

Referenced by html.Page._formatPlotSets(), and html.Page.addPlotSet().

html.Page._sectionLegendIndex
private

Definition at line 387 of file html.py.

Referenced by html.Page._appendLegend().

html.Page._tables
private

Definition at line 364 of file html.py.

Referenced by html.Page._formatTables(), html.Page.addTable(), and html.Page.isEmpty().

Generated for CMSSW Reference Manual by doxygen 1.8.5