Class DocIndex
source code
[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:
-
entirely outside (eg os.path)
-
inside but not known (eg a submodule that we didn't look at?)
-
container of current thing not examined?
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.)
Additionally, the index defines two sets of 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.
|
|
|
| Call Graph |
|---|
|
|
|
get_vardoc(self,
name)
Return the VariableDoc with the given name, or
None if this index does not contain a
VariableDoc with the given name. |
source code
call graph
|
|
| Call Graph |
|---|
|
|
|
get_valdoc(self,
name)
Return the ValueDoc with the given name, or
None if this index does not contain a
ValueDoc with the given name. |
source code
call graph
|
|
| Call Graph |
|---|
|
|
|
|
| Call Graph |
|---|
|
|
|
|
| Call Graph |
|---|
|
|
|
|
| Call Graph |
|---|
|
dict from str to ClassDoc or
list
|
|
| Call Graph |
|---|
|
|
|
|
| Call Graph |
|---|
|
|
|
container(self,
api_doc)
Return the ValueDoc that contains the given
APIDoc, or None if its container is not in
the index. |
source code
call graph
|
|
| Call Graph |
|---|
|
|
|
|
|
|
|
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.
|
|
|
| Call Graph |
|---|
Create a new documentation index, based on the given root set of
ValueDocs. If any APIDocs reachable from the
root set does not have a canonical name, then it will be assigned one.
etc.
- Parameters:
root - A list of ValueDocs.
|
|
|
| Call Graph |
|---|
Look for an APIDoc named name, relative to
context. Return the APIDoc if one is found;
otherwise, return None. find looks in the
following places, in order:
-
Function parameters (if one matches, return
None)
-
All enclosing namespaces, from closest to furthest.
-
If
name starts with 'self', then strip it
off and look for the remaining part of the name using
find
-
Builtins
-
Parameter attributes
-
Classes at module level (if the name is not ambiguous)
- Parameters:
|
|
|
| Call Graph |
|---|
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.
- Parameters:
docs (list of APIDoc) - containers of the objects to collect - Returns:
dict from str to ClassDoc or
list
- mapping from objects name to the object(s) with that name
|
|
|
| Call Graph |
|---|
Return a list of all ValueDocs that can be reached,
directly or indirectly from this DocIndex's root set.
- Parameters:
filters - A set of filters that can be used to prevent
reachable_valdocs from following specific link types
when looking for ValueDocs that can be reached from
the root set. See APIDoc.apidoc_links for a more
complete description.
|
|
Initialize the callers and callees
variables, given a Stat object from the pstats
module.
Warning:
This method uses undocumented data structures inside of
profile_stats.
|
|
Update the dictionary mapping from pstat.Stat funciton
ids to RoutineDocs. pstat.Stat function ids
are tuples of (filename, lineno, funcname).
|
mlclasses
A 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.
- Type:
dict from str to ClassDoc or
list
|
callers
A dictionary mapping from RoutineDocs in this index to
lists of RoutineDocs for the routine's callers. This
dictionary is initialized by calling read_profiling_info().
- Type:
list of RoutineDoc
|
callees
A dictionary mapping from RoutineDocs in this index to
lists of RoutineDocs for the routine's callees. This
dictionary is initialized by calling read_profiling_info().
- Type:
list of RoutineDoc
|
_funcid_to_doc
A mapping from profile 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.
|