Python全景系列之装饰器使用的全面讲解

更新时间：2023年05月31日 14:22:25 作者：techlead_krischang

装饰器在Python中扮演了重要的角色，文将深入探讨装饰器的所有相关主题，包括装饰器的基础知识、实现与使用、工作原理等，需要的可以参考一下

Python 装饰器深入探讨

在 Python 中，装饰器提供了一种简洁的方式，用来修改或增强函数和类的行为。装饰器在语法上表现为一个前置于函数或类定义之前的特殊标记：

@simple_decorator
def hello_world():
    print("Hello, world!")

在这个例子中，simple_decorator 是一个装饰器，它作用于下方的 hello_world 函数。装饰器在概念上就像一个包装器，它可以在被装饰的函数执行前后插入任意的代码，进而改变被装饰函数的行为。

参数化装饰器

我们还可以进一步将装饰器参数化，这让装饰器的行为更具灵活性。比如，我们可以定义一个装饰器，让它在函数执行前后打印自定义的消息：

def message_decorator(before_message, after_message):
    def decorator(func):
        def wrapper(*args, **kwargs):
            print(before_message)
            result = func(*args, **kwargs)
            print(after_message)
            return result
        return wrapper
    return decorator

@message_decorator("Start", "End")
def hello_world():
    print("Hello, world!")

在这个例子中，message_decorator 是一个参数化装饰器，它接受两个参数，分别代表函数执行前后要打印的消息。

理解装饰器的工作原理

在 Python 中，函数是第一类对象。这意味着函数和其他对象一样，可以作为变量进行赋值，可以作为参数传给其他函数，可以作为其他函数的返回值，甚至可以在一个函数里面定义另一个函数。这个特性是实现装饰器的基础。

def decorator(func):
    def wrapper():
        print('Before function execution')
        func()
        print('After function execution')
    return wrapper

def hello_world():
    print('Hello, world!')

decorated_hello = decorator(hello_world)
decorated_hello()

在这个例子中，decorator 函数接收一个函数 hello_world 作为参数，并返回了一个新的函数 wrapped_func。这个新函数在 hello_world 函数执行前后分别打印一条消息。我们可以看到，装饰器实际上是一个返回函数的函数。

函数签名保持

默认情况下，装饰器会“掩盖”掉原函数的名字和文档字符串。这是因为在装饰器内部，我们返回了一个全新的函数。我们可以使用 functools.wraps 来解决这个问题：

import functools
def decorator(func):
    @functools.wraps(func)
    def wrapper():
        print('Before function execution')
        func()
        print('After function execution')
    return wrapper
@decorator
def hello_world():
    "Prints 'Hello, world!'"
    print('Hello, world!')
print(hello_world.__name__)
print(hello_world.__doc__)

这样，使用装饰器后的函数名和文档字符串能够保持不变。

Python 装饰器的应用实例

装饰器在实际的 Python 编程中有许多应用场景，比如日志记录、性能测试、事务处理、缓存、权限校验等。

一个常见的应用就是使用装饰器进行日志记录：

import logging

def log_decorator(func):
    logging.basicConfig(level=logging.INFO)
    
    def wrapper(*args, **kwargs):
        logging.info(f'Running "{func.__name__}" with arguments {args} and kwargs {kwargs}')
        result = func(*args, **kwargs)
        logging.info(f'Finished "{func.__name__}" with result {result}')
        return result
    
    return wrapper

@log_decorator
def add(x, y):
    return x + y

这个装饰器记录了函数的名称，函数调用的参数，以及函数返回的结果。

装饰器链

Python 允许我们将多个装饰器应用到一个函数上，形成一个装饰器链。例如，我们可以同时应用日志装饰器和性能测试装饰器：

import time
import logging
from functools import wraps

def log_decorator(func):
    logging.basicConfig(level=logging.INFO)
    
    @wraps(func)
    def wrapper(*args, **kwargs):
        logging.info(f'Running "{func.__name__}" with arguments {args} and kwargs {kwargs}')
        result = func(*args, **kwargs)
        logging.info(f'Finished "{func.__name__}" with result {result}')
        return result

    return wrapper

def timer_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f'Function "{func.__name__}" took {end_time - start_time} seconds to run.')
        return result

    return wrapper

@log_decorator
@timer_decorator
def add(x, y):
    time.sleep(2)
    return x + y

在这个例子中，@log_decorator 和 @timer_decorator 两个装饰器被同时应用到 add 函数上，它们分别负责记录日志和测量函数运行时间。

One More Thing: 自动注册装饰器

一个有趣的装饰器应用是自动注册。这个装饰器会在装饰函数时自动将函数添加到一个列表或字典中，这样我们就可以在程序的其他地方访问到这个列表或字典，知道有哪些函数被装饰过。

# 装饰器将函数注册到一个列表中
def register_decorator(func_list):
    def decorator(func):
        func_list.append(func)
        return func
    return decorator

# 自动注册函数
registered_functions = []
@register_decorator(registered_functions)
def foo():
    pass

@register_decorator(registered_functions)
def bar():
    pass

print(registered_functions)  # 输出: [<function foo at 0x10d38d160>, <function bar at 0x10d38d1f0>]

这个装饰器可以用于自动注册路由、插件系统、命令行参数处理等场景，能够大大提高代码的灵活性和可扩展性。

总结

Python 装饰器是一种强大的工具，它可以让我们更有效地管理和组织代码。希望通过这篇文章，你能够更深入地理解装饰器的工作原理和用法，从而在你的项目中更好地使用装饰器。

到此这篇关于Python全景系列之装饰器使用的全面讲解的文章就介绍到这了,更多相关Python装饰器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Python创建Excel的4种方式小结
这篇文章主要为大家详细介绍了Python中创建Excel的4种常见方式,文中的示例代码简洁易懂,具有一定的参考价值,感兴趣的小伙伴可以学习一下
2025-02-02
Python中的pickle模块解析
这篇文章主要介绍了Python中的pickle模块解析,pickle 模块和 json 模块很像,都有序列化的功能,不过 pickle 模块更加局限一些只能对 python 使用,它可以对一个 python 对象结构的二进制序列化和反序列化,需要的朋友可以参考下
2023-09-09
深入解析Python高效记录重试日志的两种方法
在日常开发中,临时性错误是程序员最常遇到的挑战之一,本文将深入解析两种高效记录重试日志的方法——钩子函数法和装饰器封装法,帮助你轻松构建健壮的应用程序,感兴趣的可以了解下
2025-06-06
Python编写屏幕网格生成工具
这篇文章主要为大家详细介绍了如何通过Python编写屏幕网格生成工具,可以定期绘制一个透明的网格,感兴趣的小伙伴可以跟随小编一起学习一下
2024-12-12
利用python实现xml与数据库读取转换的方法
这篇文章主要给大家介绍了关于利用python实现xml与数据库读取转换的方法，文中通过示例代码介绍的非常详细，对大家具有一定的参考学习价值，需要的朋友们下面来一起看看吧。
2017-06-06
Python数据结构与算法中的栈详解(3)
这篇文章主要为大家详细介绍了Python中的栈，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助
2022-03-03
python BeautifulSoup使用方法详解
Beautiful Soup 是用Python写的一个HTML/XML的解析器，它可以很好的处理不规范标记并生成剖析树(parse tree)。它提供简单又常用的导航（navigating），搜索以及修改剖析树的操作。它可以大大节省你的编程时间,下面我们就看看他是如何使用
2013-11-11
python label与one-hot之间的互相转换方式
这篇文章主要介绍了python label与one-hot之间的互相转换方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-02-02
Python中if和elif的用法示例及区别详解
这篇文章主要给大家介绍了关于Python中if和elif的用法示例及区别的相关资料,除了基本的if和else语句外,elif（即else if）也是一个非常重要的组成部分,需要的朋友可以参考下
2024-04-04
Python使用xlrd和xlwt实现自动化操作Excel
这篇文章主要介绍了Python使用xlrd和xlwt实现自动化操作Excel，xlwt只能对Excel进行写操作。xlwt和xlrd不光名字像，连很多函数和操作格式也是完全相
2022-08-08