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
在装饰器之后应用。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

713

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

625

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

738

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

617

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1235

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

574

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

696

2023.08.11

俄罗斯搜索引擎Yandex最新官方入口网址
俄罗斯搜索引擎Yandex最新官方入口网址

Yandex官方入口网址是https://yandex.com;用户可通过网页端直连或移动端浏览器直接访问,无需登录即可使用搜索、图片、新闻、地图等全部基础功能,并支持多语种检索与静态资源精准筛选。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1

2025.12.29

热门下载

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

精品课程

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

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.6万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

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

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