python.hanwriter.Document Class Reference

Inheritance diagram for python.hanwriter.Document:

Collaboration diagram for python.hanwriter.Document:

Public Member Functions
def	__init__ (self, top_level_algorithm='WorstCaseSummary')
def	addOutput (self, name, algorithm, annotations={}, attributes={})
def	getAlgorithm (self, name)
def	getReference (self, name)
def	addSubDir (self, name)
def	addHistogram (self, histogram, algorithm, annotations={}, output=DQHanConfMaker._default_output, attributes={})
def	getSubDir (self, name)
def	tohan (self, encoding=None)
def	toprettyhan (self, indent="\t", newl="\n", encoding=None)
def	writehan (self, writer, indent="", addindent="", newl="")
def	appendChild (self, child)
def	setAttribute (self, key, attribute)
def	removeAttribute (self, key)
def	getAttribute (self, key)
def	getSubNode (self, name, nodetype)
def	__str__ (self)
def	getAlgorithm (self)
def	getOutputPath (self, append=None, delimiter="/")
def	tohan (self, encoding=None)
def	toprettyhan (self, indent="\t", newl="\n", encoding=None)
def	writehan (self, writer, indent="", addindent="", newl="")
def	appendChild (self, child)
def	setAttribute (self, key, attribute)
def	removeAttribute (self, key)
def	getAttribute (self, key)
def	getSubNode (self, name, nodetype)
def	__str__ (self)

Public Attributes
	nodeType
	acceptChild
	root_output_level
	subnodes
	attributes
	name
	father
	subnodes
	attributes
	name

Detailed Description

Class representing a han document

Definition at line 510 of file hanwriter.py.

Constructor & Destructor Documentation

__init__()

def python.hanwriter.Document.__init__	(		self,
			top_level_algorithm = 'WorstCaseSummary'
	)

Creates an empty han document with a top level output

Reimplemented from python.hanwriter.HanDir.

Definition at line 517 of file hanwriter.py.

    def __init__(self, top_level_algorithm='WorstCaseSummary'):
        """
        Creates an empty han document with a top level output
        """
        HanDir.__init__(self, '')
        HanOutput.__init__(self, '')
        self.nodeType = Node.DOCUMENT
        self.acceptChild = [Node.ALGORITHM, Node.DIR, Node.HIST, Node.OUTPUT, Node.REFERENCE, Node.THRESHOLD,
                            Node.COMPALG]
        self.root_output_level = HanOutput('top_level', top_level_algorithm)
        self.appendChild(self.root_output_level)

Member Function Documentation

__str__() [1/2]

def python.hanwriter.Node.__str__ (   self )

inherited

Definition at line 191 of file hanwriter.py.

    def __str__(self):
        return "HanNode: "+self.name+" ("+DQHanConfMaker._get_NodeType(self.nodeType)+") Attributes:"+str(self.attributes)+" SubNodes: "+str(self.subnodes)
 
 
# HanHistogram class
# This class represents the configuration for a histogram

__str__() [2/2]

def python.hanwriter.Node.__str__ (   self )

inherited

Definition at line 191 of file hanwriter.py.

    def __str__(self):
        return "HanNode: "+self.name+" ("+DQHanConfMaker._get_NodeType(self.nodeType)+") Attributes:"+str(self.attributes)+" SubNodes: "+str(self.subnodes)
 
 
# HanHistogram class
# This class represents the configuration for a histogram

addHistogram()

def python.hanwriter.HanDir.addHistogram (   self,   histogram,   algorithm,   annotations = {},   output = DQHanConfMaker._default_output,   attributes = {}  )

inherited

Adds to the directory a histogram specifying the histogram name, the algorithm and the output path.

Definition at line 417 of file hanwriter.py.

    def addHistogram(self, histogram, algorithm, annotations={}, output=DQHanConfMaker._default_output, attributes={}):
        """
        Adds to the directory a histogram specifying the histogram name, the algorithm and the output path.
        """
        histo = HanHistogram(histogram, algorithm,
                             annotations, output, attributes)
        self.appendChild(histo)
        return histo

addOutput()

def python.hanwriter.Document.addOutput	(		self,
			name,
			algorithm,
			annotations = {},
			attributes = {}
	)

Adds a sub output element with name and algorithm

Reimplemented from python.hanwriter.HanOutput.

Definition at line 535 of file hanwriter.py.

    def addOutput(self, name, algorithm, annotations={}, attributes={}):
        """
        Adds a sub output element with name and algorithm
        """
        # forward to root region
        return HanOutput.addOutput(self.root_output_level, name, algorithm, annotations, attributes)

addSubDir()

def python.hanwriter.HanDir.addSubDir (   self,   name  )

inherited

Adds a subdirectory called name to the current directory and returns the newly created sub directory

Definition at line 402 of file hanwriter.py.

    def addSubDir(self, name):
        """
        Adds a subdirectory called name to the current directory and returns the newly created sub directory
        """
        subdir = HanDir(name)
        self.appendChild(subdir)
        return subdir

appendChild() [1/2]

def python.hanwriter.Node.appendChild (   self,   child  )

inherited

Add a sub node to this node

Definition at line 127 of file hanwriter.py.

    def appendChild(self, child):
        """
        Add a sub node to this node
        """
        try:
            if child.nodeType not in self.acceptChild:
                msg = " Node: "+DQHanConfMaker._get_NodeType(self.nodeType)
                msg += " Cannot have a child of type:", child.nodeType
                raise HanCannotCreateConf(msg)
        except Exception:
            raise HanCannotCreateConf(
                "Object:"+str(child)+" is not a valid Node")
        if not self.subnodes:
            self.subnodes = []
        self.subnodes += [child]
 

appendChild() [2/2]

def python.hanwriter.Node.appendChild (   self,   child  )

inherited

Add a sub node to this node

Definition at line 127 of file hanwriter.py.

    def appendChild(self, child):
        """
        Add a sub node to this node
        """
        try:
            if child.nodeType not in self.acceptChild:
                msg = " Node: "+DQHanConfMaker._get_NodeType(self.nodeType)
                msg += " Cannot have a child of type:", child.nodeType
                raise HanCannotCreateConf(msg)
        except Exception:
            raise HanCannotCreateConf(
                "Object:"+str(child)+" is not a valid Node")
        if not self.subnodes:
            self.subnodes = []
        self.subnodes += [child]
 

getAlgorithm() [1/2]

def python.hanwriter.HanOutput.getAlgorithm (   self )

inherited

Gets the algorithm attribute

Definition at line 469 of file hanwriter.py.

    def getAlgorithm(self):
        """
        Gets the algorithm attribute
        """
        if 'algorithm' in self.attributes:
            return self.getAttribute('algorithm')

getAlgorithm() [2/2]

def python.hanwriter.Document.getAlgorithm	(		self,
			name
	)

retrieves the algorithm han object associated with name

Definition at line 545 of file hanwriter.py.

    def getAlgorithm(self, name):
        """
        retrieves the algorithm han object associated with name
        """
        return self.getSubNode(name, Node.ALGORITHM)

getAttribute() [1/2]

def python.hanwriter.Node.getAttribute (   self,   key  )

inherited

Gets the attribute identified by the key, None if not found

Definition at line 169 of file hanwriter.py.

    def getAttribute(self, key):
        """
        Gets the attribute identified by the key, None if not found
        """
        if self.attributes and key in self.attributes:
            return self.attributes[key]
        return None

getAttribute() [2/2]

def python.hanwriter.Node.getAttribute (   self,   key  )

inherited

Gets the attribute identified by the key, None if not found

Definition at line 169 of file hanwriter.py.

    def getAttribute(self, key):
        """
        Gets the attribute identified by the key, None if not found
        """
        if self.attributes and key in self.attributes:
            return self.attributes[key]
        return None

getOutputPath()

def python.hanwriter.HanOutput.getOutputPath (   self,   append = None,   delimiter = "/"  )

inherited

Creates the complete path of this output directory

Definition at line 494 of file hanwriter.py.

    def getOutputPath(self, append=None, delimiter="/"):
        """
        Creates the complete path of this output directory
        """
        name = self.name
        if append:
            name = name + append
        if self.father:
            name = self.father.getOutputPath(delimiter+name, delimiter)
        return name
 
# Class document
# This class represents the han document.
# This class is a set of nodes
 
 

getReference()

def python.hanwriter.Document.getReference	(		self,
			name
	)

retrieves the han reference associated with name

Definition at line 554 of file hanwriter.py.

    def getReference(self, name):
        """
        retrieves the han reference associated with name
        """
        return self.getSubNode(name, Node.REFERENCE)
 
 
# Add a DQParameter object to the HanDocument
# @param handocument: the document containing the configuration @c handocument: a HanDocument object
# @param dqparameter: the DQParameter object @c dqparameter: a DQParameter object
# @param output: the output element for the result
# @note: This function is used internally and should not be used by users of this module

getSubDir()

def python.hanwriter.HanDir.getSubDir (   self,   name  )

inherited

returns the sub-directory called name

Definition at line 428 of file hanwriter.py.

    def getSubDir(self, name):
        """
        returns the sub-directory called name
        """
        return self.getSubNode(name, Node.DIR)
 
# Class for han output
# This class implements the han output
 
 

getSubNode() [1/2]

def python.hanwriter.Node.getSubNode (   self,   name,   nodetype  )

inherited

Returns the sub-node identified by name and nodetype

Definition at line 181 of file hanwriter.py.

    def getSubNode(self, name, nodetype):
        """
        Returns the sub-node identified by name and nodetype
        """
        if self.subnodes:
            for sn in self.subnodes:
                if sn.nodeType == nodetype and sn.name == name:
                    return sn
        return None
 

getSubNode() [2/2]

def python.hanwriter.Node.getSubNode (   self,   name,   nodetype  )

inherited

Returns the sub-node identified by name and nodetype

Definition at line 181 of file hanwriter.py.

    def getSubNode(self, name, nodetype):
        """
        Returns the sub-node identified by name and nodetype
        """
        if self.subnodes:
            for sn in self.subnodes:
                if sn.nodeType == nodetype and sn.name == name:
                    return sn
        return None
 

removeAttribute() [1/2]

def python.hanwriter.Node.removeAttribute (   self,   key  )

inherited

Removes attribute identified by key

Definition at line 157 of file hanwriter.py.

    def removeAttribute(self, key):
        """
        Removes attribute identified by key
        """
        if self.attributes and key in self.attributes:
            del self.attributes[key]
            return True
        return False

removeAttribute() [2/2]

def python.hanwriter.Node.removeAttribute (   self,   key  )

inherited

Removes attribute identified by key

Definition at line 157 of file hanwriter.py.

    def removeAttribute(self, key):
        """
        Removes attribute identified by key
        """
        if self.attributes and key in self.attributes:
            del self.attributes[key]
            return True
        return False

setAttribute() [1/2]

def python.hanwriter.Node.setAttribute (   self,   key,   attribute  )

inherited

The attribute identified by key is added to this node

Definition at line 146 of file hanwriter.py.

    def setAttribute(self, key, attribute):
        """
        The attribute identified by key is added to this node
        """
        if not self.attributes:
            self.attributes = {}
        self.attributes[key] = attribute

setAttribute() [2/2]

def python.hanwriter.Node.setAttribute (   self,   key,   attribute  )

inherited

The attribute identified by key is added to this node

Definition at line 146 of file hanwriter.py.

    def setAttribute(self, key, attribute):
        """
        The attribute identified by key is added to this node
        """
        if not self.attributes:
            self.attributes = {}
        self.attributes[key] = attribute

tohan() [1/2]

def python.hanwriter.Node.tohan (   self,   encoding = None  )

inherited

convert the object in a valid han script block

Definition at line 75 of file hanwriter.py.

    def tohan(self, encoding=None):
        """
        convert the object in a valid han script block
        """
        return self.toprettyhan("", "", encoding)
 

tohan() [2/2]

def python.hanwriter.Node.tohan (   self,   encoding = None  )

inherited

convert the object in a valid han script block

Definition at line 75 of file hanwriter.py.

    def tohan(self, encoding=None):
        """
        convert the object in a valid han script block
        """
        return self.toprettyhan("", "", encoding)
 

toprettyhan() [1/2]

def python.hanwriter.Node.toprettyhan (   self,   indent = "\t",   newl = "\n",   encoding = None  )

inherited

convert the object in a formatted han string

Definition at line 86 of file hanwriter.py.

    def toprettyhan(self, indent="\t", newl="\n", encoding=None):
        """
        convert the object in a formatted han string
        """
        # restore the following in a future tdaq release
        # writer = DQHanConfMaker._get_StringIO()
        import io
        import six
        writer = io.BytesIO() if six.PY2 else io.StringIO()
        if encoding is not None:
            import codecs
            writer = codecs.lookup(encoding)[3](writer)
        self.writehan(writer, "", indent, newl)
        return writer.getvalue()
 

toprettyhan() [2/2]

def python.hanwriter.Node.toprettyhan (   self,   indent = "\t",   newl = "\n",   encoding = None  )

inherited

convert the object in a formatted han string

Definition at line 86 of file hanwriter.py.

    def toprettyhan(self, indent="\t", newl="\n", encoding=None):
        """
        convert the object in a formatted han string
        """
        # restore the following in a future tdaq release
        # writer = DQHanConfMaker._get_StringIO()
        import io
        import six
        writer = io.BytesIO() if six.PY2 else io.StringIO()
        if encoding is not None:
            import codecs
            writer = codecs.lookup(encoding)[3](writer)
        self.writehan(writer, "", indent, newl)
        return writer.getvalue()
 

writehan() [1/2]

def python.hanwriter.Node.writehan (   self,   writer,   indent = "",   addindent = "",   newl = ""  )

inherited

Converts the object in a han string and writes it in the writer object

Definition at line 106 of file hanwriter.py.

    def writehan(self, writer, indent="", addindent="", newl=""):
        """
        Converts the object in a han string and writes it in the writer object
        """
        writer.write(
            indent+DQHanConfMaker._get_NodeType(self.nodeType)+" "+self.name)
        # if it is a document do not need to add { }
        if self.nodeType != Node.DOCUMENT:
            writer.write(" { %s" % (newl))
        if self.attributes:
            for key, attribute in self.attributes.items():
                writer.write("%s %s = %s%s" % (indent, key, attribute, newl))
        if self.subnodes:
            for node in self.subnodes:
                node.writehan(writer, indent+addindent, addindent, newl)
        if self.nodeType != Node.DOCUMENT:
            writer.write("%s}%s" % (indent, newl))
 

writehan() [2/2]

def python.hanwriter.Node.writehan (   self,   writer,   indent = "",   addindent = "",   newl = ""  )

inherited

Converts the object in a han string and writes it in the writer object

Definition at line 106 of file hanwriter.py.

    def writehan(self, writer, indent="", addindent="", newl=""):
        """
        Converts the object in a han string and writes it in the writer object
        """
        writer.write(
            indent+DQHanConfMaker._get_NodeType(self.nodeType)+" "+self.name)
        # if it is a document do not need to add { }
        if self.nodeType != Node.DOCUMENT:
            writer.write(" { %s" % (newl))
        if self.attributes:
            for key, attribute in self.attributes.items():
                writer.write("%s %s = %s%s" % (indent, key, attribute, newl))
        if self.subnodes:
            for node in self.subnodes:
                node.writehan(writer, indent+addindent, addindent, newl)
        if self.nodeType != Node.DOCUMENT:
            writer.write("%s}%s" % (indent, newl))
 

Member Data Documentation

acceptChild

python.hanwriter.Document.acceptChild

Definition at line 524 of file hanwriter.py.

attributes [1/2]

python.hanwriter.Node.attributes

inherited

Definition at line 66 of file hanwriter.py.

attributes [2/2]

python.hanwriter.Node.attributes

inherited

Definition at line 66 of file hanwriter.py.

father

python.hanwriter.HanOutput.father

inherited

Definition at line 461 of file hanwriter.py.

name [1/2]

python.hanwriter.Node.name

inherited

Definition at line 70 of file hanwriter.py.

name [2/2]

python.hanwriter.Node.name

inherited

Definition at line 70 of file hanwriter.py.

nodeType

python.hanwriter.Document.nodeType

Definition at line 523 of file hanwriter.py.

root_output_level

python.hanwriter.Document.root_output_level

Definition at line 526 of file hanwriter.py.

subnodes [1/2]

python.hanwriter.Node.subnodes

inherited

Definition at line 65 of file hanwriter.py.

subnodes [2/2]

python.hanwriter.Node.subnodes

inherited

Definition at line 65 of file hanwriter.py.

---

The documentation for this class was generated from the following file:

• hanwriter.py