diff options
author | Benjamin Peterson <benjamin@python.org> | 2010-03-30 17:58:13 (GMT) |
---|---|---|
committer | Benjamin Peterson <benjamin@python.org> | 2010-03-30 17:58:13 (GMT) |
commit | 7e213255cee76f692dded963ec726b39319646c0 (patch) | |
tree | 73fb707550d69a479a8007a4bddb11faca6303ea /Doc/library | |
parent | ec71794cb825ff391c02c4ae942f03a31a68c061 (diff) | |
download | cpython-7e213255cee76f692dded963ec726b39319646c0.zip cpython-7e213255cee76f692dded963ec726b39319646c0.tar.gz cpython-7e213255cee76f692dded963ec726b39319646c0.tar.bz2 |
add inspect.getcallargs, which binds function arguments like a normal call #3135
Patch by George Sakkis
Diffstat (limited to 'Doc/library')
-rw-r--r-- | Doc/library/inspect.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst index 29dc6ae..075b26f 100644 --- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -504,6 +504,32 @@ Classes and functions metatype is in use, cls will be the first element of the tuple. +.. function:: getcallargs(func[, *args][, **kwds]) + + Bind the *args* and *kwds* to the argument names of the Python function or + method *func*, as if it was called with them. For bound methods, bind also the + first argument (typically named ``self``) to the associated instance. A dict + is returned, mapping the argument names (including the names of the ``*`` and + ``**`` arguments, if any) to their values from *args* and *kwds*. In case of + invoking *func* incorrectly, i.e. whenever ``func(*args, **kwds)`` would raise + an exception because of incompatible signature, an exception of the same type + and the same or similar message is raised. For example:: + + >>> from inspect import getcallargs + >>> def f(a, b=1, *pos, **named): + ... pass + >>> getcallargs(f, 1, 2, 3) + {'a': 1, 'named': {}, 'b': 2, 'pos': (3,)} + >>> getcallargs(f, a=2, x=4) + {'a': 2, 'named': {'x': 4}, 'b': 1, 'pos': ()} + >>> getcallargs(f) + Traceback (most recent call last): + ... + TypeError: f() takes at least 1 argument (0 given) + + .. versionadded:: 2.7 + + .. _inspect-stack: The interpreter stack |