[Python-checkins] cpython (merge 3.3 -> default): Merge issue #16243: add example for inspect.formatargspec

andrew.svetlov python-checkins at python.org
Fri Oct 26 23:29:01 CEST 2012


http://hg.python.org/cpython/rev/a0337031a6b7
changeset:   79952:a0337031a6b7
parent:      79949:2b7e58153d11
parent:      79951:9d3b616fc702
user:        Andrew Svetlov <andrew.svetlov at gmail.com>
date:        Sat Oct 27 00:28:49 2012 +0300
summary:
  Merge issue #16243: add example for inspect.formatargspec

Patch by Berker Peksag.

files:
  Doc/library/inspect.rst |  11 +++++++++--
  1 files changed, 9 insertions(+), 2 deletions(-)


diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -716,7 +716,7 @@
    locals dictionary of the given frame.
 
 
-.. function:: formatargspec(args[, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations, formatarg, formatvarargs, formatvarkw, formatvalue, formatreturns, formatannotations])
+.. function:: formatargspec(args[, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations[, formatarg, formatvarargs, formatvarkw, formatvalue, formatreturns, formatannotations]])
 
    Format a pretty argument spec from the values returned by
    :func:`getargspec` or :func:`getfullargspec`.
@@ -725,7 +725,14 @@
    ``defaults``, ``kwonlyargs``, ``kwonlydefaults``, ``annotations``). The
    other five arguments are the corresponding optional formatting functions
    that are called to turn names and values into strings. The last argument
-   is an optional function to format the sequence of arguments.
+   is an optional function to format the sequence of arguments. For example::
+
+    >>> from inspect import formatargspec, getfullargspec
+    >>> def f(a: int, b: float):
+    ...     pass
+    ...
+    >>> formatargspec(*getfullargspec(f))
+    '(a: int, b: float)'
 
 
 .. function:: formatargvalues(args[, varargs, varkw, locals, formatarg, formatvarargs, formatvarkw, formatvalue])

-- 
Repository URL: http://hg.python.org/cpython


More information about the Python-checkins mailing list