DOTExport.DotExport Class Reference

Inheritance diagram for DOTExport.DotExport:

Public Member Functions
def	__init__ (self)
def	dotIndenter (self, dot)
def	export (self, data, filename, filetype)
def	get_png_size (self, filename)
def	processMap (self, mapdata)
def	selectNode (self, dotdata, node, depth_s)
def	write_output (self, dot, filename, filetype)

Public Attributes
	include_nodes
	shapes

Detailed Description

Export a CMSSW config file to DOT (http://www.graphviz.org) markup, either as raw markup or by invoking the dot program, as an image.

Definition at line 263 of file DOTExport.py.

Constructor & Destructor Documentation

def DOTExport.DotExport.__init__

(

self

)

Definition at line 297 of file DOTExport.py.

Referenced by DOTExport.DotExport.selectNode().

  def __init__(self):
    FileExportPlugin.__init__(self)
    
    #could make these customizeable in the general options dict
    self.shapes={}
    self.shapes['EDProducer']='box'
    self.shapes['EDFilter']='invhouse'
    self.shapes['EDAnalyzer']='house'
    self.shapes['OutputModule']='invtrapezium'
    self.shapes['ESSource']='Mdiamond'     
    self.shapes['ESProducer']='Msquare'
    self.shapes['Source']='ellipse'
    self.shapes['Service']='diamond'
    

Member Function Documentation

def DOTExport.DotExport.dotIndenter	(		self,
			dot
	)

Simple indenter for dot output, mainly to prettify it for human reading.

Definition at line 311 of file DOTExport.py.

References join().

Referenced by DOTExport.DotExport.export().

  def dotIndenter(self,dot):
    """
    Simple indenter for dot output, mainly to prettify it for human reading.
    """
    spaces = lambda d: ''.join([space]*d)
    newdot = ""
    depth = 0
    space = '  '
    for line in dot.splitlines():
      if '{' in line:
        newdot += spaces(depth)+line+'\n'
        depth += 1
      elif '}' in line:
        depth -= 1
        newdot += spaces(depth)+line+'\n'
      else:
        newdot += spaces(depth)+line+'\n'
    return newdot
  

def DOTExport.DotExport.export	(		self,
			data,
			filename,
			filetype
	)

Definition at line 465 of file DOTExport.py.

References DOTExport.DotExport.dotIndenter(), FileExportPlugin.FileExportPlugin.options, cmsswPreprocessor.CmsswPreprocessor.options, DTCalibrationWorker.DTCalibrationWorker.options, DTWorkflow.DTWorkflow.options, TestProcess.TestProcess.options, DOTExport.DotProducer.options, confdb.HLTProcess.options, production_tasks.Task.options, VisualizationOptions.options(), fireworks::OptionNode.options(), edmIntegrityCheck.IntegrityCheck.options, edm.print(), DOTExport.DotExport.selectNode(), DOTExport.DotProducer.shapes, cms::DDParsingContext.shapes, EcalLaserAnalyzer2.shapes, DOTExport.DotExport.shapes, and DOTExport.DotExport.write_output().

  def export(self,data,filename,filetype):
    #if not data.process():
    #  raise "DOTExport requires a cms.Process object"  
    
    #dot = self.produceDOT(data)
    dot_producer = DotProducer(data,self.options,self.shapes)
    dot = dot_producer()
    
    if len(dot_producer.nodes)>0:
    
      if self.options['node_graphs']:
        nodes = [n for n in dot_producer.nodes if data.type(dot_producer.nodes[n]['obj']) in ('EDAnalyzer','EDFilter','EDProducer','OutputModule')]
        for n in nodes:
          if self.options['node_graphs_restrict'] in n:
            try:
              node_dot = self.selectNode(dot,n,self.options['node_depth'])
              self.write_output(node_dot,filename.replace('.','_%s.'%n),filetype)
            except:
              pass
      else:
        dot = self.dotIndenter(dot)
        self.write_output(dot,filename,filetype)
    else:
      print("WARNING: Empty image. Not saved.")
    
  

def DOTExport.DotExport.get_png_size	(		self,
			filename
	)

Definition at line 491 of file DOTExport.py.

Referenced by DOTExport.DotExport.write_output().

  def get_png_size(self,filename):
    png_header = '\x89PNG\x0d\x0a\x1a\x0a'
    ihdr = 'IHDR'
    filedata = open(filename,'r').read(24)
    png_data = struct.unpack('>8s4s4sII',filedata)
    if not (png_data[0]==png_header and png_data[2]==ihdr):
      raise 'PNG header or IHDR not found'
    return png_data[3],png_data[4]
    

def DOTExport.DotExport.processMap	(		self,
			mapdata
	)

Re-process the client-side image-map produces when png+map is selected.
DOT will only ever put a single URL in the imagemap corresponding to a node, with the 'url' parameter (after html encoding) as the url, and the 'title' parameter as the title. This isn't useful behaviour for our purposes. We want probably several link areas, or a javascript link to make a menu appear, or other more complex behaviour.

If the option 'urlprocess' is turned on, this function is called, and it expects to find a dictionary it can eval in the url parameter. I can't think of a less messy way of passing data to this function without having inner access to DOT at the moment.

This function iterates through all the areas in the mapfile, replacing each one with one or more areas according to the rules in the dictionary stored in the URL parameter.

The dictionary should have structure:
{
  split_x:#,
  split_y:#,
  scale_x:#,
  scale_y:#,
  cells:[
      {
        top:#,
        left:#,
        width:#,
        height:#,
        html_attribute1:"...",
        html_attribute2:"..."
    ]
}
The imagemap is first scaled in size by scale_x and scale_y.
It is then split into split_x*split_y rectangular cells.
New areas are created for each defined cell with the defined top,left location and width,height. This will not check you aren't making new areas that overlap if you define them as such.
The areas then get attributes defined by html_attribute fields - eg, 'html_href':'mypage.htm' becomes 'href'='mypage.htm' in the area. Probably you want as a minimum to define html_href and html_alt. It would also be useful to set html_class to allow highlighting of different link types, or html_onclick/onmouseover for more exotic behaviour.

This will probably be quite sensitive to the presence of special characters, complex splitting schemes, etc. Use with caution.

This may be somewhat replaceable with the <html_label> and cut-down table format that graphviz provides, but I haven't had much of an experiment with that.

Definition at line 395 of file DOTExport.py.

References createfilelist.int, join(), and genParticles_cff.map.

Referenced by DOTExport.DotExport.write_output().

  def processMap(self,mapdata):
    """
    Re-process the client-side image-map produces when png+map is selected.
    DOT will only ever put a single URL in the imagemap corresponding to a node, with the 'url' parameter (after html encoding) as the url, and the 'title' parameter as the title. This isn't useful behaviour for our purposes. We want probably several link areas, or a javascript link to make a menu appear, or other more complex behaviour.
    
    If the option 'urlprocess' is turned on, this function is called, and it expects to find a dictionary it can eval in the url parameter. I can't think of a less messy way of passing data to this function without having inner access to DOT at the moment.
    
    This function iterates through all the areas in the mapfile, replacing each one with one or more areas according to the rules in the dictionary stored in the URL parameter.
    
    The dictionary should have structure:
    {
      split_x:#,
      split_y:#,
      scale_x:#,
      scale_y:#,
      cells:[
              {
                top:#,
                left:#,
                width:#,
                height:#,
                html_attribute1:"...",
                html_attribute2:"..."
            ]
    }
    The imagemap is first scaled in size by scale_x and scale_y.
    It is then split into split_x*split_y rectangular cells.
    New areas are created for each defined cell with the defined top,left location and width,height. This will not check you aren't making new areas that overlap if you define them as such.
    The areas then get attributes defined by html_attribute fields - eg, 'html_href':'mypage.htm' becomes 'href'='mypage.htm' in the area. Probably you want as a minimum to define html_href and html_alt. It would also be useful to set html_class to allow highlighting of different link types, or html_onclick/onmouseover for more exotic behaviour.
    
    This will probably be quite sensitive to the presence of special characters, complex splitting schemes, etc. Use with caution.
    
    This may be somewhat replaceable with the <html_label> and cut-down table format that graphviz provides, but I haven't had much of an experiment with that.
    """
    new_areas=[]
    area_default = {'split_x':1,'scale_x':1.,'split_y':1,'scale_y':1.,'cells':[]}
    cell_default = {'top':0,'left':0,'width':1,'height':1,'html_href':'#'}
    re_area = re.compile('<area.*?/>',re.DOTALL)
    #sometimes DOT comes up with negative coordinates, so we need to deal with them here (so all the other links will work at least)
    re_content = re.compile('href="(.*?)" title=".*?" alt="" coords="(-?[0-9]{1,6}),(-?[0-9]{1,6}),(-?[0-9]{1,6}),(-?[0-9]{1,6})"',re.DOTALL)
    re_htmlunquote = re.compile('&#([0-9]{1,3});')
    mapdata = re_htmlunquote.sub(lambda x: chr(int(x.group(1))),mapdata)
    areas = re_area.findall(mapdata)
    for area in areas:
      #print area
      data = re_content.search(area)
      baseurl = data.group(1)
      x1,y1,x2,y2 = map(int,(data.group(2),data.group(3),data.group(4),data.group(5)))
      rad_x,rad_y = int((x2-x1)*0.5),int((y2-y1)*0.5)
      centre_x,centre_y = x1+rad_x,y1+rad_y
      basedict = eval(baseurl)
      for ad in area_default:
        if not ad in basedict:
          basedict[ad]=area_default[ad]
      rad_x = int(rad_x*basedict['scale_x'])
      rad_y = int(rad_y*basedict['scale_y'])
      top_x,top_y = centre_x-rad_x,centre_y-rad_y
      split_x,split_y = int((2*rad_x)/basedict['split_x']),int((2*rad_y)/basedict['split_y'])
      
      for cell in basedict['cells']:
        for cd in cell_default:
          if not cd in cell:
            cell[cd]=cell_default[cd]
        x1,y1 = top_x+split_x*cell['left'],top_y+split_y*cell['top']
        x2,y2 = x1+split_x*cell['width'],y1+split_y*cell['height']
        area_html = '<area shape="rect" coords="%s,%s,%s,%s" %s />' % (x1,y1,x2,y2,' '.join(['%s="%s"'%(key.split('_',1)[1],value) for key, value in cell.items() if key.startswith('html_')]))
        new_areas.append(area_html)
    return '<map id="configbrowse" name="configbrowse">\n%s\n</map>'%('\n'.join(new_areas))  
    
    

def DOTExport.DotExport.selectNode	(		self,
			dotdata,
			node,
			depth_s
	)

Definition at line 330 of file DOTExport.py.

References DOTExport.DotExport.__init__(), funct.abs(), and createfilelist.int.

Referenced by DOTExport.DotExport.export().

  def selectNode(self,dotdata,node,depth_s):
    depth = int(depth_s)
    backtrace=False
    if depth<0:
      depth = abs(depth)
      backtrace=True
    re_link = re.compile(r'^\s*?(\w*?)->(\w*?)(?:\[.*?\])?$',re.MULTILINE)
    re_nodedef = re.compile(r'^\s*?(\w*?)(?:\[.*?\])?$',re.MULTILINE)
    re_title = re.compile(r'^label=\"(.*?)\"$',re.MULTILINE)
    re_nodeprops = re.compile(r'^\s*?('+node+r')\[(.*?)\]$',re.MULTILINE)
    
    nodes = re_nodedef.findall(dotdata)
    if not node in nodes:
      raise Exception("Selected node (%s) not found" % (node))
    links_l = re_link.findall(dotdata)
    links = {}
    for link in links_l:
      if not backtrace:
        if link[0] in links:
          links[link[0]] += [link[1]]
        else:
          links[link[0]] = [link[1]]
      if link[1] in links:
          links[link[1]] += [link[0]]
      else:
        links[link[1]] = [link[0]]
      
    def node_recursor(links,depthleft,start):
      if start in links:
        if depthleft==0:
          return links[start]+[start]
        else:
          result = [start]
          for l in links[start]:
            result.extend(node_recursor(links,depthleft-1,l))
          return result
      else:
        return [start]
    
    
    include_nodes = set(node_recursor(links,depth-1,node))
    include_nodes.add(node)
    
    class link_replacer:
      def __init__(self,include_nodes):
        self.include_nodes=include_nodes
      def __call__(self,match):
        if match.group(1) in self.include_nodes and match.group(2) in self.include_nodes:
          return match.group(0)
        return ''
    class node_replacer:
      def __init__(self,include_nodes):
        self.include_nodes=include_nodes
      def __call__(self,match):
        if match.group(1) in self.include_nodes:
          return match.group(0)
        return ''
    
    dotdata = re_link.sub(link_replacer(include_nodes),dotdata)
    dotdata = re_nodedef.sub(node_replacer(include_nodes),dotdata)
    dotdata = re_title.sub(r'label="\g<1>\\nDepth '+str(depth_s)+r' from node ' +node+r'"',dotdata,1)
    dotdata = re_nodeprops.sub('\\g<1>[\\g<2>,color="red"]',dotdata,1)
    
    return dotdata
   

def DOTExport.DotExport.write_output	(		self,
			dot,
			filename,
			filetype
	)

Definition at line 500 of file DOTExport.py.

References DOTExport.DotExport.get_png_size(), SiStripPI.max, FileExportPlugin.FileExportPlugin.options, cmsswPreprocessor.CmsswPreprocessor.options, DTCalibrationWorker.DTCalibrationWorker.options, DTWorkflow.DTWorkflow.options, DOTExport.DotProducer.options, TestProcess.TestProcess.options, confdb.HLTProcess.options, production_tasks.Task.options, VisualizationOptions.options(), fireworks::OptionNode.options(), edmIntegrityCheck.IntegrityCheck.options, edm.print(), and DOTExport.DotExport.processMap().

Referenced by DOTExport.DotExport.export().

  def write_output(self,dot,filename,filetype):
    #don't use try-except-finally here, we want any errors passed on so the enclosing program can decide how to handle them
    if filetype=='dot':
      dotfile = open(filename,'w')
      dotfile.write(dot)
      dotfile.close()
    elif filetype=='stdout':
      print(result)
    elif filetype=='pdf':
      dot_p = subprocess.Popen(['dot','-Tps2'],stdin=subprocess.PIPE,stdout=subprocess.PIPE)
      ps2 = dot_p.communicate(dot)[0]
      if not dot_p.returncode==0:
        raise "dot returned non-zero exit code: %s"%dot_p.returncode
      pdf_p = subprocess.Popen(['ps2pdf','-',filename],stdin=subprocess.PIPE)
      pdf_p.communicate(ps2)
      if not pdf_p.returncode==0:
        raise "ps2pdf returned non-zero exit code: %s"%pdf_p.returncode
    elif filetype=='png+map':
      if '.' in filename:
        filename = filename.split('.')[0]
      dot_p = subprocess.Popen(['dot','-Tpng','-o','%s.png'%filename,'-Tcmapx_np'],stdin=subprocess.PIPE,stdout=subprocess.PIPE)
      mapdata = dot_p.communicate(dot)[0]
      if not dot_p.returncode==0:
        raise "dot returned non-zero exit code: %s"%dot_p.returncode
      if self.options['urlprocess']:
        mapdata = self.processMap(mapdata)
      mapfile = open('%s.map'%filename,'w')
      mapfile.write(mapdata)
      mapfile.close()
      filesize = self.get_png_size('%s.png'%filename)
      if max(filesize) > self.options['png_max_size']:
        print("png image is too large (%s pixels/%s max pixels), deleting" % (filesize,self.options['png_max_size']))
        os.remove('%s.png'%filename)
        os.remove('%s.map'%filename)
    elif filetype=='png':
      dot_p = subprocess.Popen(['dot','-T%s'%(filetype),'-o',filename],stdin=subprocess.PIPE)
      dot_p.communicate(dot)
      if not dot_p.returncode==0:
        raise "dot returned non-zero exit code: %s"%dot_p.returncode
      filesize = self.get_png_size(filename)
      if max(filesize) > self.options['png_max_size']:
        print("png image is too large (%s pixels/%s max pixels), deleting" % (filesize,self.options['png_max_size']))
        os.remove(filename)
    else:
      dot_p = subprocess.Popen(['dot','-T%s'%(filetype),'-o',filename],stdin=subprocess.PIPE)
      dot_p.communicate(dot)
      if not dot_p.returncode==0:
        raise "dot returned non-zero exit code: %s"%dot_p.returncode
    
    

Member Data Documentation

DOTExport.DotExport.include_nodes

Definition at line 375 of file DOTExport.py.

DOTExport.DotExport.shapes

Definition at line 301 of file DOTExport.py.

Referenced by DOTExport.DotExport.export().

---

Generated for CMSSW Reference Manual by  1.8.11