Home       Trees       Index       Help   

epydoc 3.0alpha2

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

Class RoutineDoc
source code

API documentation information about a single routine.

Instance Methods [hide private]
  all_args(self)

Inherited from ValueDoc: __repr__, apidoc_links, pyval_repr

Inherited from APIDoc: __cmp__, __hash__, __init__, __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

    Signature
posargs The names of the routine's positional arguments.
posarg_defaults API documentation for the positional arguments' default values.
vararg The name of the routine's vararg argument, or None if it has no vararg argument.
kwarg The name of the routine's keyword argument, or None if it has no keyword argument.
lineno The line number of the first line of the function's signature.
    Information Extracted from Docstrings
arg_descrs A list of descriptions of the routine's arguments.
arg_types Descriptions of the expected types for the routine's arguments, encoded as a dictionary mapping from argument names to type descriptions.
return_descr A description of the value returned by this routine.
return_type A description of expected type for the value returned by this routine.
exception_descrs A list of descriptions of exceptions that the routine might raise.

Inherited from APIDoc: descr, extra_docstring_fields, metadata, summary

    Value Representation

Inherited from ValueDoc: parse_repr, pyval

    Context

Inherited from ValueDoc: defining_module

    Information about Imported Variables

Inherited from ValueDoc: proxy_for

    Docstrings

Inherited from APIDoc: docstring, docstring_lineno

    Source Information

Inherited from APIDoc: docs_extracted_by


Method Details [hide private]

all_args(self)

source code 
call graph 
Returns:
A list of the names of all arguments (positional, vararg, and keyword), in order. If a positional argument consists of a tuple of names, then that tuple will be flattened.

Instance Variable Details [hide private]

posargs

The names of the routine's positional arguments. If an argument list contains "unpacking" arguments, then their names will be specified using nested lists. E.g., if a function's argument list is ((x1,y1), (x2,y2)), then posargs will be [['x1','y1'], ['x2','y2']].
Type:
list
Value:
epydoc.apidoc.UNKNOWN

posarg_defaults

API documentation for the positional arguments' default values. This list has the same length as posargs, and each element of posarg_defaults describes the corresponding argument in posargs. For positional arguments with no default, posargs_defaults will contain None.
Type:
list of ValueDoc or None
Value:
epydoc.apidoc.UNKNOWN

vararg

The name of the routine's vararg argument, or None if it has no vararg argument.
Type:
string or None
Value:
epydoc.apidoc.UNKNOWN

kwarg

The name of the routine's keyword argument, or None if it has no keyword argument.
Type:
string or None
Value:
epydoc.apidoc.UNKNOWN

lineno

The line number of the first line of the function's signature. For Python functions, this is equal to func.func_code.co_firstlineno. The first line of a file is considered line 1.
Type:
int
Value:
epydoc.apidoc.UNKNOWN

arg_descrs

A list of descriptions of the routine's arguments. Each element of this list is a tuple (arg, descr), where arg is an argument name (or a tuple of of argument names); and descr is a ParsedDocstring describing the argument(s) specified by arg.
Type:
list
Value:
epydoc.apidoc.UNKNOWN

arg_types

Descriptions of the expected types for the routine's arguments, encoded as a dictionary mapping from argument names to type descriptions.
Type:
dict from string to ParsedDocstring
Value:
epydoc.apidoc.UNKNOWN

return_descr

A description of the value returned by this routine.
Type:
ParsedDocstring
Value:
epydoc.apidoc.UNKNOWN

return_type

A description of expected type for the value returned by this routine.
Type:
ParsedDocstring
Value:
epydoc.apidoc.UNKNOWN

exception_descrs

A list of descriptions of exceptions that the routine might raise. Each element of this list is a tuple (exc, descr), where exc is a string contianing the exception name; and descr is a ParsedDocstring describing the circumstances under which the exception specified by exc is raised.
Type:
list
Value:
epydoc.apidoc.UNKNOWN

   Home       Trees       Index       Help   

epydoc 3.0alpha2

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