| Home | Trees | Index | Help |
|
|---|
| Package epydoc :: Module objdoc :: Class FuncDoc |
|
ObjDoc --+
|
FuncDoc
ObjDoc), and the following
function-specific pieces of documentation:
None.
None.
| Method Summary | |
|---|---|
__init__(self,
uid,
verbosity)
| |
__repr__(self)
| |
list of Var
|
Return the keyword parameters for the function/method documented by this FuncDoc. |
Inherited from ObjDoc:
_sort
| |
| Accessors | |
list of Var
|
Return the positional parameters for the function/method documented by this FuncDoc. |
Var or None
|
Return the vararg parameter for the function/method documented by this FuncDoc, or None if it has no vararg
parameter. |
Var or None
|
Return the keyword parameter for the function/method documented by this FuncDoc, or None if it has no keyword
parameter. |
Var or None
|
Return the return value for the function/method documented by this FuncDoc, or None if it has no return value. |
list of Raise
|
Return a list of exceptions that may be raised by the function/method documented by this FuncDoc. |
Link or None
|
Return the method overridden by the method documented by this FuncDoc; or None if the method documented by
this FuncDoc does not override any method, or if this
FuncDoc documents a function. |
boolean
|
Return true if the method documented by this FuncDoc overrides
another method, and its signature matches the signature of the overridden
method. |
list of Var
|
Return a (flat) list of all parameters for the function/method documented by this FuncDoc. |
Inherited from ObjDoc:
by_group,
defines_groups,
descr,
field_values,
fields,
groups,
has_docstring,
sortorder,
summary,
uid
| |
| Inheritance | |
Find the method that this method overrides. | |
| Signature Parsing | |
_init_signature(self,
func)
| |
_params_to_vars(self,
params,
defaults)
| |
boolean
|
Return true if the signature of childfunc matches the signature
of basefunc well enough that we should inherit its
documentation. |
None
|
Construct the signature for a builtin function or method from its docstring. |
| Error Handling | |
Inherited from ObjDoc:
_print_errors
| |
| Docstring Parsing | |
Process a field from this object's docstring. | |
| Instance Variable Summary | |
|---|---|
Var |
_kwarg_param: This function's keyword parameter, or None if it has
none. |
list of Var |
_params: A list of this function's normal parameters. |
list of Raise |
_raises: The exceptions that may be raised by this function. |
Var |
_return: This function's return value. |
Var |
_vararg_param: This function's vararg parameter, or None if it has
none. |
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 | |
|---|---|
SRE_Pattern |
_SIGNATURE_RE: A regular expression that is used to check whether a builtin function
or method has a signature in its docstring. |
| Error Reporting | |
list |
_param_mismatches: A dictionary whose keys are pairs (uid, base_uid), where uid is a
method whose parameters do not match the parameters of its base class
base_uid. |
| Docstring Parsing | |
Inherited from ObjDoc:
STANDARD_FIELDS
| |
| Method Details |
|---|
parameters(self)
|
vararg(self)
|
kwarg(self)
|
returns(self)
|
raises(self)
|
overrides(self)
|
matches_override(self)
|
parameter_list(self)
|
find_override(self, bases)Find the method that this method overrides. |
_signature_match(self, basespec, childspec)
|
_init_builtin_signature(self, func)Construct the signature for a builtin function or method from its docstring. If the docstring uses the standard convention of including a signature in the first line of the docstring (and formats that signature according to standard conventions), then it will be used to extract a signature. Otherwise, the signature will be set to a single varargs variable named"...".
|
keywords(self)
|
_process_field(self, tag, arg, descr, warnings)Process a field from this object's docstring.ObjDoc._process_field be overridden by child classes of
ObjDoc, and called as the default case.
|
| Instance Variable Details |
|---|
_kwarg_paramThis function's keyword parameter, orNone if it has
none.
|
_paramsA list of this function's normal parameters.
|
_raisesThe exceptions that may be raised by this function.
|
_returnThis function's return value.
|
_vararg_paramThis function's vararg parameter, orNone if it has
none.
|
| Class Variable Details |
|---|
_param_mismatchesA dictionary whose keys are pairs (uid, base_uid), where uid is a method whose parameters do not match the parameters of its base class base_uid.
|
| Home | Trees | Index | Help |
|
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:16 2004 | http://epydoc.sf.net |