Document inspect.getfullargspec(). Fixes #1121.

This commit is contained in:
Georg Brandl 2007-09-12 19:04:21 +00:00
parent 546e2d66b6
commit 138bcb569e
1 changed files with 25 additions and 4 deletions

View File

@ -376,10 +376,31 @@ Classes and functions
Get the names and default values of a function's arguments. A tuple of four Get the names and default values of a function's arguments. A tuple of four
things is returned: ``(args, varargs, varkw, defaults)``. *args* is a list of things is returned: ``(args, varargs, varkw, defaults)``. *args* is a list of
the argument names (it may contain nested lists). *varargs* and *varkw* are the the argument names. *varargs* and *varkw* are the names of the ``*`` and
names of the ``*`` and ``**`` arguments or ``None``. *defaults* is a tuple of ``**`` arguments or ``None``. *defaults* is a tuple of default argument
default argument values or None if there are no default arguments; if this tuple values or None if there are no default arguments; if this tuple has *n*
has *n* elements, they correspond to the last *n* elements listed in *args*. elements, they correspond to the last *n* elements listed in *args*.
.. deprecated:: 3.0
Use :func:`getfullargspec` instead, which provides information about
keyword-only arguments.
.. function:: getfullargspec(func)
Get the names and default values of a function's arguments. A tuple of seven
things is returned:
``(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)``
*args* is a list of the argument names. *varargs* and *varkw* are the names
of the ``*`` and ``**`` arguments or ``None``. *defaults* is an n-tuple of
the default values of the last n arguments. *kwonlyargs* is a list of
keyword-only argument names. *kwonlydefaults* is a dictionary mapping names
from kwonlyargs to defaults. *annotations* is a dictionary mapping argument
names to annotations.
The first four items in the tuple correspond to :func:`getargspec`.
.. function:: getargvalues(frame) .. function:: getargvalues(frame)