Table of Contents

Class: HappyDOM ../HappyDoc-r2_1/happydoclib/happydom.py

Base class for accessing documentation extracted from inputs.

Methods   
__getitem__
__init__
__str__
getFilename
getFullyQualifiedName
getName
getParent
getPath
getQualifiedName
getReference
getReferenceTargetName
getSymbolInfo
  __getitem__ 
__getitem__ ( self,  itemName )

Exceptions   
KeyError( 'Unrecognized name: "%s"' % itemName, itemName )
  __init__ 
__init__ (
        self,
        name,
        parent,
        filename,
        namespaces,
        )

Initialize the HappyDOM attributes.

Arguments

name
The name of this node.
parent
Reference to parent node.
filename
The name of the file represented by this node.
namespaces
A sequence of namespaces to be scanned, in order, when looking up a name.
  __str__ 
__str__ ( self )

  getFilename 
getFilename ( self )

Return the filename from which the object came.

  getFullyQualifiedName 
getFullyQualifiedName ( self )

Return a complete, unique, name representing this object.

  getName 
getName ( self )

Return the name of the object.

  getParent 
getParent ( self )

Return the parent node.

  getPath 
getPath ( self )

Returns a sequence of node names leading to this node.

  getQualifiedName 
getQualifiedName ( self,  transTable=string.maketrans( '/', '_' ) )

  getReference 
getReference (
        self,
        formatter,
        sourceNode,
        )

Return a reference to this module from sourceNode.

  getReferenceTargetName 
getReferenceTargetName ( self )

Return the name to use as a target for a reference such as a hyperlink.

  getSymbolInfo 
getSymbolInfo (
        self,
        name,
        tryParent=1,
        )

Look up the info record for the name.

Looks in the namespaces registered for this DOM node. If no value is found, None is returned.


Table of Contents

This document was automatically generated on Sat Aug 24 16:57:23 2002 by HappyDoc version 2.1