/ HappyDoc3-r3_1 / happydoclib / packagetree.py / PackageTree
Tree of package information.
Access each child node using the standard mapping de-reference
syntax ([], .get(), etc.).
Methods
|
|
|
getSummaryAndFormat
|
getSummaryAndFormat ( self )
Returns a tuple containing a one line summary of the
documentation for the node and the format of that
string as understood by the docstring converter plugins.
Exceptions
|
|
NotImplementedError( 'getSummaryAndFormat' )
|
|
|
getSubNodes
|
getSubNodes ( self, mimetypes=[] )
Returns the children of this node.
If mimetype is not none, returns only the children with that
mimetype.
|
|
getImportData
|
getImportData ( self )
Returns a list of the symbols which are imported.
|
|
getInputFilename
|
getInputFilename ( self )
Returns the original input filename that created the node.
|
|
getRelativeFilename
|
getRelativeFilename ( self )
Returns the filename relative to the root of the input area.
|
|
getName
|
getName ( self )
Returns the name of this tree node.
|
|
getPathToNode
|
getPathToNode ( self, otherNode )
Returns a sequence of nodes to be traversed to reach the otherNode.
The sequence assumes that traversal begins at the current node.
A .. indicates moving up to the parent one level.
|
|
findNodeFromDottedName
|
findNodeFromDottedName (
self,
dottedNodeName,
tryParent=1,
tryModuleExtensions=1,
)
Find the node referenced by the dotted name given.
The dottedNodeName happydoclib.scanner retuns the node for
this module. If the named node cannot be found, the return
value is None.
|
|
getPath
|
getPath ( self, useCanonicalName=0 )
Return the path from the root to this node.
Returns a tuple of node names, beginning with the root node
and ending with this node.
|
|
__cmp__
|
__cmp__ ( self, other )
Comparison by name for sorting.
The name check is case insensitive.
|
|
getDocStringAndFormat
|
getDocStringAndFormat ( self )
Returns a tuple containing the actual documentation string
and the format of that docstring as understood by the
docstring converters plugins.
Exceptions
|
|
NotImplementedError( 'getDocStringAndFormat' )
|
|
|
getOneLiner
|
getOneLiner ( self )
|
|
__repr__
|
__repr__ ( self )
|
|
__init__
|
__init__ (
self,
parent,
name,
)
|
|
getCanonicalName
|
getCanonicalName ( self )
Returns the canonical, full, name of the this tree node.
|
|
getParent
|
getParent ( self )
Returns the parent node for this tree.
If there is no parent (root of the tree), returns None.
|
|
walk
|
walk ( self, callback )
Walk the PackageTree, calling the callback at each node.
|
|
addSubNode
|
addSubNode ( self, node )
Insert a child node under this node.
Create a new PackageTree node, set its parent to be ourself,
and save it as one of our children.
|
|
__len__
|
__len__ ( self )
Define this to always return 1, so checks like if node work properly.
|
|
getMimeType
|
getMimeType ( self )
Returns the (mimetype, encoding) setting for this node.
|
|
|