Python装饰器怎么获取调用函数的函数名|极客笔记

Python装饰器怎么获取调用函数的函数名

1. 介绍

装饰器是Python中非常重要的概念之一。它允许我们在不修改原始函数代码的情况下，通过在函数定义之前添加装饰器来增强函数的功能。装饰器的一种常见应用场景是用于记录日志、验证用户权限、缓存函数结果等。

在使用装饰器的过程中，我们可能需要获取被装饰函数的函数名。本文将详细介绍在Python中如何获取调用函数的函数名。

2. 使用`name`属性获取函数名

每个Python函数都有一个特殊的属性__name__，该属性存储了函数的名称。我们可以通过访问被装饰函数的__name__属性来获取其函数名。下面是一个示例演示：

def decorator(func):
    def wrapper(*args, **kwargs):
        print("Calling function:", func.__name__)  # 获取函数名
        return func(*args, **kwargs)
    return wrapper

@decorator
def example_function():
    print("This is the example function.")

example_function()

运行结果：

Calling function: example_function
This is the example function.

在上面的示例中，我们定义了一个装饰器函数decorator，它使用一个内部函数wrapper来包装原始函数example_function。在包装函数中，我们通过访问func.__name__来获取被装饰函数的函数名，并将其打印出来。

3. 使用`functools.wraps`装饰器

虽然通过访问__name__属性可以获取被装饰函数的函数名，但是这种做法有一个问题：装饰器会改变包装函数的一些元信息，比如__name__、__doc__等。为了解决这个问题，Python标准库中提供了functools.wraps装饰器，它可以将被装饰函数的元信息复制到包装函数上。

下面是一个示例演示如何使用functools.wraps装饰器来获取函数名：

import functools

def decorator(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        print("Calling function:", func.__name__)  # 获取函数名
        return func(*args, **kwargs)
    return wrapper

@decorator
def example_function():
    print("This is the example function.")

example_function()

运行结果：

Calling function: example_function
This is the example function.

在上面的示例中，我们使用@functools.wraps(func)装饰器来修饰wrapper函数，它会将wrapper函数的元信息设置为被装饰函数的元信息。这样我们就可以通过访问func.__name__来获取被装饰函数的函数名，并将其打印出来。

4. 自定义装饰器函数参数传递函数名

有时候，我们可能需要在装饰器中传递被装饰函数的函数名作为参数。为了实现这个目标，我们可以对装饰器函数进行修改，使其接受额外的参数。

下面是一个示例演示如何将函数名作为参数传递给装饰器函数：

def decorator(func_name):
    def decorator_wrapper(func):
        def wrapper(*args, **kwargs):
            print("Calling function:", func_name)  # 获取函数名
            return func(*args, **kwargs)
        return wrapper
    return decorator_wrapper

@decorator("example_function")
def example_function():
    print("This is the example function.")

example_function()

运行结果：

Calling function: example_function
This is the example function.

在上面的示例中，我们定义了一个装饰器函数decorator，它接受一个字符串参数func_name，作为被装饰函数的函数名。然后，我们返回一个内部的装饰器函数decorator_wrapper，它接受被装饰函数func作为参数，并将func_name作为函数名传递给包装函数wrapper。