如何获取方法参数名称?


236

鉴于Python函数:

def a_method(arg1, arg2):
    pass

如何提取参数的数量和名称。即,鉴于我有提及func,因此我希望func.[something]返回("arg1", "arg2")

这样做的使用场景是我有一个装饰器,并且我希望以与实际函数作为键一样的顺序使用方法参数。即,"a,b"我致电时装饰工的外观如何a_method("a", "b")


1
有关几乎相同问题的答案的不同列表,请参见此其他stackoverflow帖子
dan mackinlay 2011年

1
您的标题具有误导性:当人们在使用“功能”一词说“方法”时,通常会想到一种类方法。对于功能,您选择的答案(来自Jouni K. Seppanen)很好。但是对于(类)方法,它不起作用,应该使用(来自Brian的)检查解决方案。
12

Answers:


351

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

>>> inspect.getfullargspec(a_method)
(['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)>

29
代码如何才能知道默认(4,)参数c具体对应于关键字参数?
fatuhoku

63
@fatuhoku我在想同样的事情。事实证明它并不是模棱两可的,因为您只能在连续块的末尾添加默认参数。来自文档:“如果该元组具有n个元素,则它们对应于args中列出的最后n个元素”
Soverman

9
我认为,自从Python 3.x getargspec(...)替换为inspector.signature(func)
迭戈·安德烈斯·迪亚斯·埃斯皮诺萨

2
在2.6版中进行了更改:返回一个命名的元组ArgSpec(args,varargs,关键字,默认值)。
theannouncer

4
没错,Python 3中的@DiegoAndrésDíazEspinoza- inspect.getargspec过时,但替换为inspect.getfullargspec
j08lue

100

在CPython中,参数数量为

a_method.func_code.co_argcount

他们的名字在

a_method.func_code.co_varnames

这些是CPython的实现细节,因此在其他Python实现(例如IronPython和Jython)中可能不起作用。

接受“传递”参数的一种可移植方式是使用签名定义函数func(*args, **kwargs)。这在matplotlib中经常使用,其中外部API层将许多关键字参数传递给较低级别​​的API。


co_varnames确实适用于标准Python,但此方法不是可取的,因为它还会显示内部参数。
MattK

11
为什么不使用aMethod.func_code.co_varnames [:aMethod.func_code.co_argcount]?
hochl 2011年

之后*argsdef foo(x, *args, y, **kwargs): # foo.__code__.co_argcount == 1
无法


请改为使用检查。否则,您的代码将无法与3.4+中的functools.wraps配合使用。见stackoverflow.com/questions/147816/...
布莱恩McCutchon

22

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

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]

该答案部分已过时,应该进行更新。
Imago

15

我认为您要寻找的是locals方法-


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

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

7
这在函数(装饰器)所关心的上下文之外是无用的。
Piotr Dobrogost,2011年

8
尽管这不是这里问题的答案,但实际上正是我在寻找的东西。
javabeangrinder

15

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


请注意,[:fn.__code__.co_argcount]如果要查找函数参数,则非常重要-否则它还包括在函数内创建的名称。
Soren Bjornstad

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.

11

Python 3.5以上版本:

DeprecationWarning:不建议使用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

7

在带有Signature对象的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}

6

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

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

2

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

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

2

更新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={})

2

在python 3中,下面是make *args**kwargsinto dictOrderedDict用于python <3.6维护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

1

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

0

要稍微更新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项目。


-3

怎么样dir()vars()现在?

似乎完全可以简单地完成被要求的工作……

必须在功能范围内调用。

但请注意,它将返回所有局部变量,因此请确保在函数的开始处进行此操作(如果需要)。

还要注意,正如注释中指出的那样,这不允许在范围之外进行操作。因此,OP的情况不完全相同,但仍与问题标题匹配。因此,我的答案。


dir()返回所有变量名['var1','var2']的列表,vars()返回格式为{'var1':0,'var2':'something'}的字典,位于当前本地范围内。如果有人想稍后在函数中使用参数变量名称,则应将其保存在另一个局部变量中,因为稍后在函数中可以声明另一个局部变量的地方调用它会“污染”此列表。如果他们想在函数外部使用它,则必须至少运行一次函数并将其保存在全局变量中。因此最好使用检查模块。
Peter Majko
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.