epydoc.docparser

Module docparser

Extract API documentation about python objects by parsing their source code.

The function parse_docs(), which provides the main interface of this module, reads and parses the Python source code for a module, and uses it to create an APIDoc object containing the API documentation for the variables and values defined in that modules.

Currently, parse_docs() extracts documentation from the following source code constructions:

module docstring

import statements

class definition blocks

function definition blocks

assignment statements

simple assignment statements
assignment statements with multiple '='s
assignment statements with unpacked left-hand sides
assignment statements that wrap a function in classmethod or staticmethod.
assignment to special variables __path__, __all__, and __docformat__.

delete statements

parse_docs() does not yet support the following source code constructions:

assignment statements that create properties

By default, parse_docs() will expore the contents of top-level try and if blocks. If desired, parse_docs() can also be configured to explore the contents of while and for blocks. (See the configuration constants, below.)

To Do: Make it possible to extend the functionality of parse_docs(), by replacing process_line with a dispatch table that can be customized (similarly to docintrospector.register_introspector()).

Classes

[hide private]

ParseError
An exception that is used to signify that docparser encountered syntactically invalid Python code while processing a Python source file.

Functions

[hide private]

Module parser

ValueDoc

parse_docs(filename=None, name=None, context=None, is_script=False)
Generate the API documentation for a specified object by parsing Python source files, and return it as a ValueDoc.

source code
call graph

_parse_package(package_dir)
If the given directory is a package directory, then parse its __init__.py file (and the __init__.py files of all ancestor packages); and return its ModuleDoc. source code
call graph

handle_special_module_vars(module_doc)

source code
call graph

_module_var_toktree(module_doc, name)

source code
call graph

Module Lookup

_find(name, package_doc=None)
Return the API documentaiton for the object whose name is name. source code
call graph

_is_submodule_import_var(module_doc, var_name)
Return true if var_name is the name of a variable in module_doc that just contains an imported_from link to a submodule of the same name. source code
call graph

_find_in_namespace(name, namespace_doc)

source code
call graph

_get_filename(identifier, path=None)

source code
call graph

File tokenization loop

process_file(module_doc)
Read the given ModuleDoc's file, and add variables corresponding to any objects defined in that file. source code
call graph

add_to_group(container, api_doc, group_name)

source code
call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph

script_guard(line) Detect the idiomatic trick `if __name__ == "__main__")`
add_to_group(container, api_doc, group_name)	source code call graph