/ HappyDoc3-r3_1 / happydoclib / scanner.py / Scanner
Scanner for Python source files.
The scanner finds the files to be documented, and adds nodes to
the package tree.
Methods
|
|
|
getPackageTrees
|
getPackageTrees ( self )
Retrieve the list of PackageTrees found by the scanner.
|
|
buildPackageTree
|
buildPackageTree (
self,
directoryName,
parent=None,
)
Scan a directory and build a PackageTree representing its contents.
Scans through the directory finding files and other
directories. When a directory is found, recurses to scan it.
Returns a single PackageTree instance rooted at directoryName.
|
|
walk
|
walk ( self, callback )
Walk the PackageTree, calling the callback at each node.
|
|
_parseOne
|
_parseOne ( self, packageTreeNode )
|
|
parsePackageTree
|
parsePackageTree ( self )
|
|
__init__
|
__init__ (
self,
inputDirectories,
ignorePatterns=DEFAULT_IGNORE_PATTERNS,
includeComments=1,
)
Exceptions
|
|
ValueError( 'No such directory %s' % dir_name )
|
|
|
|