迹忆客 专注技术分享

本教程将讨论使用 Python 快速获取函数调用详细信息的几种方法。 这在分析大型代码库时特别有用，一目了然地弄清楚函数在做什么变得很困难。

我们没有在代码中来回走动，而是使用 signature() 函数和装饰器为这个确切问题提供了更智能的解决方案。

在 Python 中使用 signature() 获取函数调用详细信息

获取此信息的最简单方法是使用 inspect.signature() 函数。 Python 3.5+ 的文档推荐使用这个函数。

inspect.signature() 接受各种可调用对象。 这包括函数、类和 functools.partial() 对象。

该函数返回可调用对象的注解。 如果无法提供签名，则该函数会引发 ValueError； 如果不支持对象类型，则会引发 TypeError。

示例代码：

import inspect

def foo(x, y, a="anything"):
    pass

print(inspect.signature(foo))

它应该在您的终端上打印以下内容。

(x, y, a="anything")

在 Python 中使用装饰器获取函数调用细节

Python 中的函数有一些我们可以利用的属性。 这些属性中有 __code__ 。

__code__ 属性还有我们可以使用的属性。 下面，您可以找到它们中的每一个，并解释它们的作用。

在此之下，我们将包含一个代码片段来编写可以执行此任务的函数。 我们使用 __name__ 属性来获取函数名称。

1. co_varnames 返回传递给函数的参数名称和函数内部使用的局部变量的元组。
2. co_argcount 返回参数的数量。 但是，此计数不包括仅限关键字的参数 (kwargs)、*args 和 **args。

我们已经包含了一种在代码片段中打印所有这些参数的方法。

def get_func_dets(func):
    # the point of using argcount is to ensure we only get
    argument_names = func.__code__.co_varnames[:func.__code__.co_argcount]
    func_name = func.__name__

    # getting variable length arguments and keyword arguments
    def inner_fun(*args, **kwargs):
        print(func_name, "(", end = "")

        print(", ".join('%s = %r' % ent
            for ent in zip(argument_names, args[:len(argument_names)])), end=", ")

        print("args = ", list(args[len(argument_names):]), end=",")
        print("kwargs =", kwargs, end="")
        print(")")

    return inner_func