| Home | Trees | Indices | Help |
|
|---|
|
|
[xx] out of date.
An index that .. hmm... it *can't* be used to access some things, cuz they're not at the root level. Do I want to add them or what? And if so, then I have a sort of a new top level. hmm.. so basically the question is what to do with a name that's not in the root var's name space. 2 types:An index of all the APIDoc objects that can be reached
from a root set of ValueDocs.
The members of this index can be accessed by dotted name. In
particular, DocIndex defines two mappings, accessed via the
get_vardoc() and get_valdoc() methods, which can be used to access
VariableDocs or ValueDocs respectively by name.
(Two separate mappings are necessary because a single name can be used to
refer to both a variable and to the value contained by that
variable.)
ValueDocs:
"reachable ValueDocs" and "contained
ValueDocs". The reachable
ValueDocs are defined as the set of all
ValueDocs that can be reached from the root set by following
any sequence of pointers to ValueDocs or
VariableDocs. The contained ValueDocs are defined as the
set of all ValueDocs that can be reached from the root set
by following only the ValueDoc pointers defined by
non-imported VariableDocs. For example, if the root set
contains a module m, then the contained
ValueDocs includes the ValueDocs for any
functions, variables, or classes defined in that module, as well as
methods and variables defined in classes defined in the module. The
reachable ValueDocs includes all of those
ValueDocs, as well as ValueDocs for any values
imported into the module, and base classes for classes defined in the
module.
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
dict from str to ClassDoc or
list
|
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
list
|
root The list of ValueDocs to document.
|
||
dict from str to ClassDoc or
list
|
mlclasses A mapping from class names to ClassDoc. |
||
list of RoutineDoc
|
callers A dictionary mapping from RoutineDocs in this index
to lists of RoutineDocs for the routine's callers.
|
||
list of RoutineDoc
|
callees A dictionary mapping from RoutineDocs in this index
to lists of RoutineDocs for the routine's callees.
|
||
|
_funcid_to_doc A mapping from profile function ids to corresponding
APIDoc objects.
|
|||
|
_container_cache A cache for the container() method, to increase speed. |
|||
|
_get_cache A cache for the get_vardoc() and get_valdoc() methods, to increase speed. |
|||
|
|||
ValueDocs. If any APIDocs reachable from the
root set does not have a canonical name, then it will be assigned one.
etc.
|
APIDoc named name, relative to
context. Return the APIDoc if one is found;
otherwise, return None. find looks in the
following places, in order:
|
Gather all the classes defined in a list of modules. Very often people refers to classes only by class name, even if they are not imported in the namespace. Linking to such classes will fail if we look for them only in nested namespaces. Allow them to retrieve only by name.
|
ValueDocs that can be reached,
directly or indirectly from this DocIndex's root set.
|
Stat object from the pstats
module.
Warning:
This method uses undocumented data structures inside of
|
pstat.Stat funciton
ids to RoutineDocs. pstat.Stat function ids
are tuples of (filename, lineno, funcname).
|
|
|||
mlclassesA mapping from class names to ClassDoc. Contains classes defined at module level for modules in root and which can be used as fallback by find() if looking in containing namespaces fails.
|
callersA dictionary mapping fromRoutineDocs in this index to
lists of RoutineDocs for the routine's callers. This
dictionary is initialized by calling read_profiling_info().
|
calleesA dictionary mapping fromRoutineDocs in this index to
lists of RoutineDocs for the routine's callees. This
dictionary is initialized by calling read_profiling_info().
|
_funcid_to_docA mapping fromprofile function ids to corresponding
APIDoc objects. A function id is a tuple of the form
(filename, lineno, funcname). This is used to update the callers
and callees variables.
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0beta1 on Tue Feb 27 06:03:33 2007 | http://epydoc.sourceforge.net |