| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module objdoc :: Class ModuleDoc | 
 | 
ObjDoc --+
         |
        ModuleDoc
ObjDoc), and the following module-specific 
pieces of documentation:
| Method Summary | |
|---|---|
| __init__(self,
          uid,
          verbosity) | |
| __repr__(self) | |
| Inherited from ObjDoc:_sort | |
| Accessors | |
| listofLink | Return a list of all functions defined by the module/package documented by this ModuleDoc. | 
| listofLink | Return a list of all classes defined by the module/package documented by this ModuleDoc, sorted by name. | 
| listofVar | Return a list of all variables defined by the module/package documented by this ModuleDoc, sorted by name. | 
| listofLink | Return a list of all functions contained in the module/package documented by this ModuleDocthat are not defined by that module/package, 
sorted by name. | 
| listofLink | Return a list of all classes contained in the module/package documented by this ModuleDocthat are not defined by that module/package, 
sorted by name. | 
| UIDorNone | Return the package that contains the module documented by this ModuleDoc, orNoneif no package contains the 
module. | 
| boolean | Return true if this ModuleDocdocuments a package (not a 
module). | 
| boolean | Return true if this ModuleDocdocuments a module (not a 
package). | 
| listofLink | Return a list of the known modules and subpackages conained in the package documented by this ModuleDoc, sorted by name. | 
| listofVar | Return a list of all variables contained in the module/package documented by this ModuleDocthat are not defined by that module/package, 
sorted by name. | 
| listofLink | Return a list of all modules that are imported by the module/package documented by this ModuleDoc, sorted by name. | 
| Inherited from ObjDoc:by_group,defines_groups,descr,field_values,fields,groups,has_docstring,sortorder,summary,uid | |
| Modifiers | |
| remove_autogenerated_variables(self) | |
| None | Register submodules for the package doumented by this ModuleDoc. | 
| Import Detection | |
| A helper function for _find_imported_variables: for every 
variablevset by the given 
left-hand-side of an equation, setdefined_variables[v]=1. | |
| If possible, read the module's python documentation, and try to figure out which variables were imported. | |
| Error Handling | |
| Inherited from ObjDoc:_print_errors | |
| Docstring Parsing | |
| Process a field from this object's docstring. | |
| Instance Variable Summary | |
|---|---|
| listofLink | _classes: A list of all classes contained in the module/package. | 
| listofLink | _functions: A list of all functions contained in the module/package. | 
| listofLink | _modules: A list of all modules conained in the package (package only). | 
| listofVar | _variables: A list of all variables defined by this module/package. | 
| Inherited from ObjDoc:_uid | |
| Error Handling | |
| Inherited from ObjDoc:_field_warnings,_misc_warnings,_parse_errors,_parse_warnings | |
| Docstring Parsing | |
| Inherited from ObjDoc:_descr,_fields | |
| Class Variable Summary | |
|---|---|
| tuple | _EXPR_STMT_PATTERN=(264, (265, (266, ['expr_stmt']), (... | 
| tuple | _LHS_PATTERN=(292, (293, (294, (295, (297, (298, (299,... | 
| Docstring Parsing | |
| Inherited from ObjDoc:STANDARD_FIELDS | |
| Method Details | 
|---|
| functions(self)
 | 
| classes(self)
 | 
| variables(self)
 | 
| imported_functions(self)
 | 
| imported_classes(self)
 | 
| package(self)
 | 
| ispackage(self)
 | 
| ismodule(self)
 | 
| modules(self)
 | 
| imported_variables(self)
 | 
| imported_modules(self)
 | 
| add_modules(self, modules)Register submodules for the package doumented by thisModuleDoc. This must be done externally, since we can't 
  determine the submodules of a package through introspection alone. This 
  is automatically called byDocMap.addwhen new modules are added to 
  aDocMap.
 | 
| _find_defined_vars(self, lhs_testlist, defined_variables)A helper function for_find_imported_variables: for every 
  variablevset by the given 
  left-hand-side of an equation, setdefined_variables[v]=1.
 | 
| _find_imported_variables(self)If possible, read the module's python documentation, and try to figure out which variables were imported. To decide which variables were imported, we use the following heuristic: if a variable isn't defined in the lhs of a top-level statement, then it's probably imported. Note that this isn't 100% effective. E.g., if someone usesglobal, uses atry/exceptblock, 
  or directly modifies their modules'__dict__, then we'll 
  be fooled.
 | 
| _process_field(self, tag, arg, descr, warnings)Process a field from this object's docstring.ObjDoc._process_fieldbe overridden by child classes ofObjDoc, and called as the default case.
 | 
| Instance Variable Details | 
|---|
| _classesA list of all classes contained in the module/package.
 | 
| _functionsA list of all functions contained in the module/package.
 | 
| _modulesA list of all modules conained in the package (package only).
 | 
| _variablesA list of all variables defined by this module/package.
 | 
| Class Variable Details | 
|---|
| _EXPR_STMT_PATTERN
 | 
| _LHS_PATTERN
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:10 2004 | http://epydoc.sf.net |