Home       Trees       Index       Help   

epydoc 3.0alpha2

Package epydoc :: Module apidoc :: Class ModuleDoc
[hide private]
[frames] | no frames]

Class ModuleDoc
source code

API documentation information about a single module.

Instance Methods [hide private]
  apidoc_links(self, **filters)
  init_submodule_groups(self)
Initialize the submodule_groups attribute, based on the submodules and group_specs attributes.
  select_variables(self, group=None, value_type=None, public=None, imported=None)
Return a specified subset of this module's sorted_variables list.

Inherited from NamespaceDoc: __init__, group_names, init_sorted_variables, init_variable_groups

Inherited from NamespaceDoc (private): _init_grouping

Inherited from ValueDoc: __repr__, pyval_repr

Inherited from APIDoc: __cmp__, __hash__, __setattr__, __str__, merge_and_overwrite, pp, specialize_to

Inherited from APIDoc (private): _debug_setattr

Inherited from object: __delattr__, __getattribute__, __new__, __reduce__, __reduce_ex__


Class Variables [hide private]

Inherited from object: __class__


Instance Variables [hide private]

Inherited from ValueDoc: canonical_name, toktree

    Information about the Module
filename The name of the file that defines the module.
docformat The markup language used by docstrings in this module.
    Information about Submodules
submodules Modules contained by this module (if this module is a package).
submodule_groups A dictionary specifying what group each submodule belongs to.
    Information about Packages
package API documentation for the module's containing package.
is_package True if this ModuleDoc describes a package.
path If this ModuleDoc describes a package, then path contains a list of directories that constitute its path (i.e., the value of its __path__ variable).
    Information about Imported Variables
imports A list of the source names of variables imported into this module.

Inherited from ValueDoc: proxy_for

    Information about Variables

Inherited from NamespaceDoc: group_specs, sort_spec, sorted_variables, variable_groups, variables

    Value Representation

Inherited from ValueDoc: parse_repr, pyval

    Context

Inherited from ValueDoc: defining_module

    Docstrings

Inherited from APIDoc: docstring, docstring_lineno

    Information Extracted from Docstrings

Inherited from APIDoc: descr, extra_docstring_fields, metadata, summary

    Source Information

Inherited from APIDoc: docs_extracted_by


Method Details [hide private]

apidoc_links(self, **filters)

source code 
call graph 
Overrides: NamespaceDoc.apidoc_links

init_submodule_groups(self)

source code 
call graph 
Initialize the submodule_groups attribute, based on the submodules and group_specs attributes.

select_variables(self, group=None, value_type=None, public=None, imported=None)

source code 
Return a specified subset of this module's sorted_variables list. If value_type is given, then only return variables whose values have the specified type. If group is given, then only return variables that belong to the specified group.
Parameters:
  • value_type (string) - A string specifying the value type for which variables should be returned. Valid values are:
    • 'class' - variables whose values are classes or types.
    • 'function' - variables whose values are functions.
    • 'other' - variables whose values are not classes, exceptions, types, or functions.
  • group (string) - The name of the group for which variables should be returned. A complete list of the groups defined by this ModuleDoc is available in the group_names instance variable. The first element of this list is always the special group name '', which is used for variables that do not belong to any group.

Requires: The sorted_variables and groups attributes must be initialized before this method can be used. See init_sorted_variables() and init_groups().


Instance Variable Details [hide private]

filename

The name of the file that defines the module.
Type:
string
Value:
epydoc.apidoc.UNKNOWN

docformat

The markup language used by docstrings in this module.
Type:
string
Value:
epydoc.apidoc.UNKNOWN

submodules

Modules contained by this module (if this module is a package). (Note: on rare occasions, a module may have a submodule that is shadowed by a variable with the same name.)
Type:
list of ModuleDoc
Value:
epydoc.apidoc.UNKNOWN

submodule_groups

A dictionary specifying what group each submodule belongs to. The keys of the dictionary are group names, and the values are lists of ModuleDocs. The order that groups should be listed in should be taken from group_specs.
Type:
dict from str to list of APIDoc
Value:
epydoc.apidoc.UNKNOWN

package

API documentation for the module's containing package.
Type:
ModuleDoc
Value:
epydoc.apidoc.UNKNOWN

is_package

True if this ModuleDoc describes a package.
Type:
bool
Value:
epydoc.apidoc.UNKNOWN

path

If this ModuleDoc describes a package, then path contains a list of directories that constitute its path (i.e., the value of its __path__ variable).
Type:
list of str
Value:
epydoc.apidoc.UNKNOWN

imports

A list of the source names of variables imported into this module. This is used to construct import graphs.
Type:
list of DottedName
Value:
epydoc.apidoc.UNKNOWN

   Home       Trees       Index       Help   

epydoc 3.0alpha2

Generated by Epydoc 3.0alpha2 on Tue Apr 11 17:33:03 2006 http://epydoc.sf.net