在Python中获取方法参数名称

时间:2008-10-20 14:22:03

标签: python decorator introspection python-datamodel

鉴于Python函数:

def aMethod(arg1, arg2):
    pass

如何提取参数的数量和名称。即,鉴于我有func的引用,我想要返回func。[something](“arg1”,“arg2”)。

这种情况的使用场景是我有一个装饰器,我希望使用方法参数的顺序与它们为实际函数出现的顺序相同。即,当我调用aMethod(“a”,“b”)时,装饰器看起来如何打印“a,b”?

15 个答案:

答案 0 :(得分:315)

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

>>> 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)>

答案 1 :(得分:94)

在CPython中,参数的数量是

aMethod.func_code.co_argcount

他们的名字在

的开头
aMethod.func_code.co_varnames

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

允许“传递”参数的一种便携方式是使用签名func(*args, **kwargs)定义您的函数。这在例如使用中很多。 matplotlib,其中外部API层将大量关键字参数传递给较低级别​​的API。

答案 2 :(得分:21)

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

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]

答案 3 :(得分:13)

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

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.

答案 4 :(得分:12)

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


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

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

答案 5 :(得分:7)

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的字典。

答案 6 :(得分:6)

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())

鉴于我们有功能&#39;功能&#39;这需要参数&#39; arg&#39;,这将评估为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

答案 7 :(得分:4)

在Python 3. +中使用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}

答案 8 :(得分:2)

Brian's answer的更新:

如果Python 3中的函数只有关键字参数,那么您需要使用<WebView source={{ html: "<img src={require('./images/google_signin.png')} /><h1>Hello</h1>" }} />

inspect.getfullargspec

得出这个:

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

答案 9 :(得分:2)

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

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

答案 10 :(得分:2)

这是不使用任何模块即可获取功能参数的另一种方法。

def get_parameters(func):
    keys = func.__code__.co_varnames[:func.__code__.co_argcount][::-1]
    sorter = {j: i for i, j in enumerate(keys[::-1])} 
    values = func.__defaults__[::-1]
    kwargs = {i: j for i, j in zip(keys, values)}
    sorted_args = tuple(
        sorted([i for i in keys if i not in kwargs], key=sorter.get)
    )
    sorted_kwargs = {}
    for i in sorted(kwargs.keys(), key=sorter.get):
        sorted_kwargs[i] = kwargs[i]      
    return sorted_args, sorted_kwargs


def f(a, b, c="hello", d="world"): var = a


print(get_parameters(f))

输出:

(('a', 'b'), {'c': 'hello', 'd': 'world'})

答案 11 :(得分:1)

在python 3中,下面是将*args**kwargs变成dict(对于python <3.6使用OrderedDict来维护dict的顺序):

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

答案 12 :(得分:0)

要稍微更新Brian's answer,现在有一个不错的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项目。

答案 13 :(得分:0)

inspect.signature非常慢。最快的方法是

def f(a, b=1, *args, c, d=1, **kwargs):
   pass

f_code = f.__code__
f_code.co_varnames[:f_code.co_argcount + f_code.co_kwonlyargcount]  # ('a', 'b', 'c', 'd')

答案 14 :(得分:-1)

现在dir()vars()呢?

似乎只是在做超级简单的问题......

必须在功能范围内调用。

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

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