如何获得方法参数名?

给定Python函数:

def a_method(arg1, arg2):
pass

如何提取参数的数量和名称。例如，假设我有一个func的引用，我希望func.[something]返回("arg1", "arg2")。

它的使用场景是，我有一个装饰器，我希望使用方法参数的顺序与它们在实际函数中作为键出现的顺序相同。例如，当我调用a_method("a", "b")时，打印"a,b"的装饰器看起来会怎样?

238101 次浏览
小开

在CPython中，参数的数量是

a_method.func_code.co_argcount

他们的名字在开头

a_method.func_code.co_varnames

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

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

小开
最佳答案

看一看inspect模块——它将为你检查各种代码对象属性。

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

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

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

注意，在Python的某些实现中，一些可调用对象可能不是可内省的。例如，在CPython中，一些用C定义的内置函数不提供关于其参数的元数据。因此，如果在内置函数上使用inspect.getfullargspec()，则会得到ValueError。

从Python 3.3开始，你可以使用inspect.signature()来查看可调用对象的调用签名:

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

这里有一些东西，我认为会为你想要的工作，使用装饰。

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.
小开

我觉得你要找的是当地人的方法


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


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

在decorator方法中，你可以这样列出原始方法的参数:

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]
小开

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

小开

现在dir()和vars()呢?

似乎做什么是被要求超级简单…

必须从函数范围内调用。

但要注意，它将返回所有局部变量，所以如果需要，请确保在函数的最开始执行。

还要注意，正如评论中指出的那样，这不允许从作用域之外执行此操作。所以不完全是OP的情况，但仍然符合题目。这就是我的回答。

小开

布莱恩的回答的更新:

如果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={})
小开

返回参数名列表，负责部分和正则函数:

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

Python 3.5 +:

DeprecationWarning: inspect.getargspec()自Python 3.0起已弃用，请使用inspect.signature()或inspect.getfullargspec()

所以之前:

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
小开

在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}
小开

在python 3中，下面是将*args和**kwargs转换为dict(对于python <使用OrderedDict;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
小开
要稍微更新一下布莱恩的回答，现在有一个很好的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项目。

小开

下面是另一种不使用任何模块获得函数参数的方法。

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 = {
i: kwargs[i] for i in sorted(kwargs.keys(), key=sorter.get)
}
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'})
小开

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

我在谷歌上搜索如何打印函数名，并为赋值提供参数，我必须创建一个装饰器来打印它们，我使用了这个:

def print_func_name_and_args(func):
    

def wrapper(*args, **kwargs):
print(f"Function name: '{func.__name__}' supplied args: '{args}'")
func(args[0], args[1], args[2])
return wrapper




@print_func_name_and_args
def my_function(n1, n2, n3):
print(n1 * n2 * n3)
    

my_function(1, 2, 3)


#Function name: 'my_function' supplied args: '(1, 2, 3)'
小开

是否可以使用inspect API从下面代码中的lambda func fun读取常量参数值-1 ?

def my_func(v, axis):
pass


fun = lambda v: my_func(v, axis=-1)
小开

从python 3.0开始，简单易读的答案:

import inspect




args_names = inspect.signature(function).parameters.keys()
args_dict = {
**dict(zip(args_names, args)),
**kwargs,
}
小开

操作一些函数的参数名称的最简单方法:

parameters_list = list(inspect.signature(self.YOUR_FUNCTION).parameters))

结果:

['YOUR_FUNCTION_parameter_name_0', 'YOUR_FUNCTION_parameter_name_1', ...]

这样做会更容易，因为你得到了具体的一个:

parameters_list = list(inspect.signature(self.YOUR_FUNCTION).parameters)[0]

结果:

'YOUR_FUNCTION_parameter_name_0'
小开

对于那些像我一样正在寻找将所有参数及其值(默认值或非默认值)放入一个字典的解决方案的人，我还有另一个建议。

import inspect


def get_arguments(func, args, kwargs, is_method=False):
offset = 1 if is_method else 0
specs = inspect.getfullargspec(func)
d = {}
for i, parameter in enumerate(specs.args[offset:]):
i += offset
if i < len(args):
d[parameter] = args[i]
elif parameter in kwargs:
d[parameter] = kwargs[parameter]
else:
d[parameter] = specs.defaults[i - len(args)]
return d

现在在这样的装饰器中打印get_arguments的返回值

def a_function_decorator(func):
def inner(*args, **kwargs):
print(get_arguments(func, args, kwargs))
return func(*args, **kwargs)


return inner

把它应用到一个函数上

@a_function_decorator
def foo(a, b, c="default_c", d="default_d"):
pass

会给我们

foo(1, 2, d="eek")
# {'a': 1, 'b': 2, 'c': 'default_c', 'd': 'eek'}


foo(1, 2, "blah")
# {'a': 1, 'b': 2, 'c': 'blah', 'd': 'default_c'}


foo(1, 2)
# {'a': 1, 'b': 2, 'c': 'default_c', 'd': 'default_d'}

方法也是一样

def a_method_decorator(func):
def inner(*args, **kwargs):
print(get_arguments(func, args, kwargs, is_method=True))
return func(*args, **kwargs)


return inner


class Bar:
@a_method_decorator
def foo(self, a, b, c="default_c", d="default_d"):
pass


Bar().foo(1, 2, d="eek")
#{'a': 1, 'b': 2, 'c': 'default_c', 'd': 'eek'}
Bar().foo(1, 2, "blah")
# {'a': 1, 'b': 2, 'c': 'blah', 'd': 'default_c'}
Bar().foo(1, 2)
# {'a': 1, 'b': 2, 'c': 'default_c', 'd': 'default_d'}

它当然不是最漂亮的解决方案，但它是我见过的第一个完全符合我要求的解决方案。


提交答案