python - 如何获取方法参数名称？

Question

给定 Python 函数：

def a_method(arg1, arg2):
    pass

如何提取参数的数量和名称。即，鉴于我有一个参考func，我想要func.[something]返回("arg1", "arg2")。

使用场景是我有一个装饰器，并且我希望按照它们作为键出现在实际函数中的相同顺序使用方法参数。即，"a,b"当我打电话时，装饰器会如何打印a_method("a", "b")？

Answer 1

看看这个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 中定义的一些内置函数不提供有关其参数的元数据。结果，ValueError如果您inspect.getfullargspec()在内置函数上使用，您将得到一个。

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

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

Answer 2

在 CPython 中，参数的数量是

a_method.func_code.co_argcount

他们的名字在开头

a_method.func_code.co_varnames

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

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

Answer 3

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 4

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

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 5

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

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

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

Answer 6

Python 3.5+：

弃用警告：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

Answer 7

我认为使用装饰器可以满足您的需求。

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

Answer 10

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

Answer 11

更新布莱恩的回答：

如果 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 12

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

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

Answer 13

在python 3中，下面是make *argsand **kwargsinto a dict（OrderedDict用于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

Answer 14

为了更新一点布赖恩的回答，现在有一个不错的反向移植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 15

我在谷歌上搜索如何打印函数名称和为分配提供的参数我必须创建一个装饰器来打印它们，我使用了这个：

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

Answer 16

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

def my_func(v, axis):
  pass

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

Answer 17

dir()现在呢vars()？

似乎在做超级简单的事情……</p>

必须从函数范围内调用。

但要小心它会返回所有局部变量，因此如果需要，请务必在函数的最开始执行此操作。

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