在Python中获取方法参数名称

Question

给定 Python 函数：

def aMethod(arg1, arg2):
    pass

如何提取参数的数量和名称。即，鉴于我有一个对 func 的引用，我希望 func.[something] 返回（“arg1”，“arg2”）。

其使用场景是我有一个装饰器，并且我希望按照它们在实际函数中作为键出现的顺序来使用方法参数。即，当我调用 aMethod("a", "b") 时，打印“a,b”的装饰器看起来如何？

Answer 1

查看检查模块 - 这将检查各种代码对象属性。

>>> inspect.getfullargspec(aMethod)
(['arg1', 'arg2'], None, None, None)

其他结果是* args和** kwargs变量的名称，以及提供的默认值。即

>>> def foo(a,b,c=4, *arglist, **keywords): pass
>>> inspect.getfullargspec(foo)
(['a', 'b', 'c'], 'arglist', 'keywords', (4,))

请注意，在某些Python实现中，某些可调用内容可能无法内省。例如，在CPython中，C中定义的一些内置函数不提供有关其参数的元数据。因此，如果您使用内置函数ValueError，则将获得inspect.getfullargspec()。

从Python 3.3开始，你也可以使用 inspect.signature（）以了解可调用对象的调用签名：

>>> inspect.signature(foo)
<Signature (a, b, c=4, *arglist, **keywords)>

Answer 2

在 CPython 中，参数的数量为

aMethod.func_code.co_argcount

他们的名字在开头

aMethod.func_code.co_varnames

这些是 CPython 的实现细节，因此这可能不适用于其他 Python 实现，例如 IronPython 和 Jython。

承认“传递”参数的一种可移植方法是使用签名定义您的函数 func(*args, **kwargs). 。这在例如matplotlib，外部 API 层将大量关键字参数传递给较低级别​​的 API。

Answer 3

在装饰器方法中，您可以通过以下方式列出原始方法的参数：

import inspect, itertools 

def my_decorator():

        def decorator(f):

            def wrapper(*args, **kwargs):

                # if you want arguments names as a list:
                args_name = inspect.getargspec(f)[0]
                print(args_name)

                # if you want names and values as a dictionary:
                args_dict = dict(itertools.izip(args_name, args))
                print(args_dict)

                # if you want values as a list:
                args_values = args_dict.values()
                print(args_values)

如果**kwargs对您很重要，那么它会有点复杂：

        def wrapper(*args, **kwargs):

            args_name = list(OrderedDict.fromkeys(inspect.getargspec(f)[0] + kwargs.keys()))
            args_dict = OrderedDict(list(itertools.izip(args_name, args)) + list(kwargs.iteritems()))
            args_values = args_dict.values()

示例：

@my_decorator()
def my_function(x, y, z=3):
    pass


my_function(1, y=2, z=3, w=0)
# prints:
# ['x', 'y', 'z', 'w']
# {'y': 2, 'x': 1, 'z': 3, 'w': 0}
# [1, 2, 3, 0]

Answer 4

我认为使用装饰器，我认为这对你想要的东西起作用。

class LogWrappedFunction(object):
    def __init__(self, function):
        self.function = function

    def logAndCall(self, *arguments, **namedArguments):
        print "Calling %s with arguments %s and named arguments %s" %\
                      (self.function.func_name, arguments, namedArguments)
        self.function.__call__(*arguments, **namedArguments)

def logwrap(function):
    return LogWrappedFunction(function).logAndCall

@logwrap
def doSomething(spam, eggs, foo, bar):
    print "Doing something totally awesome with %s and %s." % (spam, eggs)


doSomething("beans","rice", foo="wiggity", bar="wack")

运行它，它将产生以下输出：

C:\scripts>python decoratorExample.py
Calling doSomething with arguments ('beans', 'rice') and named arguments {'foo':
 'wiggity', 'bar': 'wack'}
Doing something totally awesome with beans and rice.

Answer 5

我认为您正在寻找的是本地方法 -

In [6]: def test(a, b):print locals()
   ...: 

In [7]: test(1,2)              
{'a': 1, 'b': 2}

Answer 6

Python 3版本是：

def _get_args_dict(fn, args, kwargs):
    args_names = fn.__code__.co_varnames[:fn.__code__.co_argcount]
    return {**dict(zip(args_names, args)), **kwargs}

该方法返回包含args和kwargs的字典。

Answer 7

Python 3.5 +：

  

弃用警告：不推荐使用inspect.getargspec（），而是使用inspect.signature（）

所以以前：

func_args = inspect.getargspec(function).args

现在：

func_args = list(inspect.signature(function).parameters.keys())

测试：

'arg' in list(inspect.signature(function).parameters.keys())

鉴于我们有函数'function'，它接受参数'arg'，这将评估为True，否则为False。

Python控制台的示例：

Python 3.6.0 (v3.6.0:41df79263a11, Dec 23 2016, 07:18:10) [MSC v.1900 32 bit (Intel)] on win32
>>> import inspect
>>> 'iterable' in list(inspect.signature(sum).parameters.keys())
True

Answer 8

在Python 3. +中使用Signature对象，一种简单的方法来获取参数名称与值之间的映射，使用Signature的bind()方法！

例如，这是一个用于打印地图的装饰器：

import inspect

def decorator(f):
    def wrapper(*args, **kwargs):
        bound_args = inspect.signature(f).bind(*args, **kwargs)
        bound_args.apply_defaults()
        print(dict(bound_args.arguments))

        return f(*args, **kwargs)

    return wrapper

@decorator
def foo(x, y, param_with_default="bars", **kwargs):
    pass

foo(1, 2, extra="baz")
# This will print: {'kwargs': {'extra': 'baz'}, 'param_with_default': 'bars', 'y': 2, 'x': 1}

Answer 9

返回参数名称列表，负责部分和常规函数：

def get_func_args(f):
    if hasattr(f, 'args'):
        return f.args
    else:
        return list(inspect.signature(f).parameters)

Answer 10

更新 Brian的回答：

如果Python 3中的函数具有仅关键字参数，则需要使用inspect.getfullargspec：

def yay(a, b=10, *, c=20, d=30):
    pass
inspect.getfullargspec(yay)

得出这个：

FullArgSpec(args=['a', 'b'], varargs=None, varkw=None, defaults=(10,), kwonlyargs=['c', 'd'], kwonlydefaults={'c': 20, 'd': 30}, annotations={})

Answer 11

在python 3中，下面是将*args和**kwargs转换为dict（使用OrderedDict for python <！> lt; 3.6来维护<=>订单）：

from functools import wraps

def display_param(func):
    @wraps(func)
    def wrapper(*args, **kwargs):

        param = inspect.signature(func).parameters
        all_param = {
            k: args[n] if n < len(args) else v.default
            for n, (k, v) in enumerate(param.items()) if k != 'kwargs'
        }
        all_param .update(kwargs)
        print(all_param)

        return func(**all_param)
    return wrapper

Answer 12

要稍微更新 Brian的答案，现在有一个很好的inspect.signature后退端口可供您使用较旧的python版本： funcsigs 。 所以我的个人偏好将用于

try:  # python 3.3+
    from inspect import signature
except ImportError:
    from funcsigs import signature

def aMethod(arg1, arg2):
    pass

sig = signature(aMethod)
print(sig)

为了好玩，如果你有兴趣玩Signature对象，甚至动态创建随机签名函数，你可以看一下我的 makefun 项目。

Answer 13

dir()和vars()现在呢？

似乎完全按照<！>＃8230;

进行

必须在功能范围内调用。

但要小心它会返回所有局部变量，所以一定要在函数的最开头做这些变量。

另请注意，正如评论中所指出的，这不允许从范围之外完成。所以不完全是OP的场景，但仍然与问题标题相匹配。因此，我的答案。