0

0

如何理解Python的装饰器并实现一个简单的日志装饰器?

夢幻星辰

夢幻星辰

发布时间:2025-09-03 19:05:01

|

682人浏览过

|

来源于php中文网

原创

装饰器是Python中用于扩展函数或类行为的语法糖,通过包装原函数添加日志、性能测试、权限验证等功能而不修改其源码。其核心在于函数是一等对象,可作为参数传递和返回。实现日志装饰器需定义接收函数的外层函数,内部创建包装函数执行额外逻辑后调用原函数,并用 @functools.wraps 保留原函数元信息。使用 @decorator 语法等价于 func = decorator(func)。带参数的装饰器实为装饰器工厂,返回真正装饰器,如按日志级别定制的 log_calls_level。装饰器广泛用于日志、缓存、权限控制等场景,实现关注点分离。对类方法和静态方法,装饰器应置于 @classmethod 或 @staticmethod 之前,注意应用顺序以避免类型冲突。

如何理解python的装饰器并实现一个简单的日志装饰器?

Python装饰器本质上是一种语法糖,允许你修改函数或类的行为,而无需修改其源代码。它就像给函数穿上了一件“外套”,这件外套可以添加额外的功能,例如日志记录、性能测试权限验证等。

理解装饰器的关键在于理解函数也是对象,可以作为参数传递给其他函数,并且可以作为其他函数的返回值。

解决方案:

要理解并实现一个简单的日志装饰器,可以分为以下几个步骤:

立即学习Python免费学习笔记(深入)”;

  1. 定义一个装饰器函数:这个函数接收一个函数作为参数,并返回一个新的函数(通常是原函数的包装)。
  2. 在装饰器函数内部定义一个包装函数:这个包装函数会执行一些额外的操作(例如日志记录),然后调用原始函数。
  3. 返回包装函数:装饰器函数返回这个包装函数,从而替换原始函数。

以下是一个简单的日志装饰器的例子:

import functools
import logging

logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')

def log_calls(func):
    @functools.wraps(func)  # 保留原函数的元信息
    def wrapper(*args, **kwargs):
        logging.info(f"Calling function: {func.__name__} with arguments: {args}, {kwargs}")
        result = func(*args, **kwargs)
        logging.info(f"Function {func.__name__} returned: {result}")
        return result
    return wrapper

@log_calls
def add(x, y):
    """This function adds two numbers."""
    return x + y

# 使用装饰器
result = add(5, 3)
print(result)

这个例子中,

log_calls
是一个装饰器函数,它接收一个函数
func
作为参数。
wrapper
函数是内部定义的包装函数,它会在调用
func
之前和之后记录日志。
@functools.wraps(func)
是一个重要的部分,它保留了原函数
func
的元信息,例如
__name__
(函数名) 和
__doc__
(文档字符串)。

使用

@log_calls
语法糖,相当于
add = log_calls(add)
。当你调用
add(5, 3)
时,实际上调用的是
wrapper(5, 3)

如何处理带参数的装饰器?

带参数的装饰器其实是“装饰器工厂”,它是一个函数,返回一个装饰器。例如,你可以修改上面的日志装饰器,让它能够指定日志级别:

dmSOBC SHOP网店系统
dmSOBC SHOP网店系统

dmSOBC SHOP网店系统由北京时代胜腾信息技术有限公司(http://www.webzhan.com)历时6个月开发完成,本着简单实用的理念,商城在功能上摒弃了外在装饰的一些辅助功能,尽可能的精简各项模块开发,做到有用的才开发,网店V1.0.0版本开发完成后得到了很多用户的使用并获得了好评,公司立即对网店进行升级,其中包括修正客户提出的一些意见和建议,现对广大用户提供免费试用版本,如您在使用

下载
import functools
import logging

def log_calls_level(level=logging.INFO):
    def log_decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            logging.log(level, f"Calling function: {func.__name__} with arguments: {args}, {kwargs}")
            result = func(*args, **kwargs)
            logging.log(level, f"Function {func.__name__} returned: {result}")
            return result
        return wrapper
    return log_decorator

@log_calls_level(level=logging.DEBUG) # 指定日志级别
def subtract(x, y):
    """This function subtracts two numbers."""
    return x - y

result = subtract(10, 4)
print(result)

在这个例子中,

log_calls_level
是一个装饰器工厂,它接收一个
level
参数,并返回一个装饰器
log_decorator
。使用
@log_calls_level(level=logging.DEBUG)
语法糖,相当于
subtract = log_calls_level(level=logging.DEBUG)(subtract)

装饰器在实际开发中有什么用?

装饰器在实际开发中有很多用途,例如:

  • 日志记录:像上面的例子一样,记录函数的调用和返回,方便调试和监控。
  • 性能测试:测量函数的执行时间,帮助优化代码。
  • 权限验证:检查用户是否有权限访问某个函数或资源。
  • 缓存:缓存函数的计算结果,避免重复计算。
  • 事务管理:在函数执行前后开启和关闭数据库事务。

装饰器可以有效地将这些横切关注点(cross-cutting concerns)从核心业务逻辑中分离出来,使代码更加清晰和易于维护。

装饰器如何处理类方法和静态方法?

对于类方法和静态方法,装饰器的使用方式略有不同,但原理是相同的。

对于类方法,装饰器需要放在

@classmethod
之前:

class MyClass:
    @log_calls
    @classmethod
    def my_class_method(cls):
        print("This is a class method")

MyClass.my_class_method()

对于静态方法,装饰器需要放在

@staticmethod
之前:

class MyClass:
    @log_calls
    @staticmethod
    def my_static_method():
        print("This is a static method")

MyClass.my_static_method()

需要注意的是,装饰器的顺序很重要。如果装饰器改变了函数的类型(例如,将一个普通函数变成一个类方法),那么需要确保

@classmethod
@staticmethod
在装饰器之后应用。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

298

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

212

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1502

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

624

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

633

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

589

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

172

2025.07.29

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

83

2025.08.07

java入门学习合集
java入门学习合集

本专题整合了java入门学习指南、初学者项目实战、入门到精通等等内容,阅读专题下面的文章了解更多详细学习方法。

1

2026.01.29

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 3.7万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号