/ HappyDoc3-r3_1 / happydoclib / parseinfo / suite.py / SuiteInfoBase
Base class for information gathering classes.
Default implementation assumes that the user is interested
in learning about functions and classes defined within the
parse tree used for initialization. This makes implementation
of MethodInfo easy. Other derived classes add behavior to
find other information.
Methods
|
|
|
getFilename
|
getFilename ( self )
|
|
getConfigurationValues
|
getConfigurationValues ( self )
Return any HappyDoc configuration values related to this object.
|
|
__getitem__
|
__getitem__ ( self, itemName )
Exceptions
|
|
KeyError( 'Unrecognized name: "%s"' % itemName, itemName )
|
|
|
getName
|
getName ( self )
Return this info object's name.
|
|
getCommentKey
|
getCommentKey ( self )
|
|
_extractInfo
|
_extractInfo ( self, tree )
Pull information out of the parse tree.
|
|
_extractConfigurationValues
|
_extractConfigurationValues ( self )
Default implementation does nothing.
|
|
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.
|
|
getDocString
|
getDocString ( self )
Return any __doc__ string value found for the object.
|
|
getComment
|
getComment ( self )
Return any comments for the object.
|
|
_extractSummary
|
_extractSummary ( self, text )
Extract a summary text from a larger body.
|
|
getDocStringFormat
|
getDocStringFormat ( self )
Returns the docstring converter format name for the docstring for this object.
|
|
__init__
|
__init__ (
self,
name,
parent,
filename,
tree,
commentInfo={},
defaultConfigValues={},
)
Initialize the info extractor.
Parameters:
- name
- name of this object
- parent
- parent object (e.g. Module for Class)
- filename
- file which contains the tree
- tree
- parse tree from which to extract information
- commentInfo
- comments extracted from source file where
this object was found
|
|
getSummaryAndFormat
|
getSummaryAndFormat ( self )
Return a summary of the __doc__ string for this object and the docstring converter name for the format of the text.
|
|
|