当前位置:

首页 > 编程开发 > Python装饰器怎么用?简单日志装饰器实现方法

Python装饰器怎么用?简单日志装饰器实现方法

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

本文目录

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

    如何理解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)。

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

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

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

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 Python
    相关文章 更多
    python删除一个列表里的重复元素的方法与代码示例
    python删除一个列表里的重复元素的方法与代码示例

    学习如何使用Python高效删除列表中的重复元素。本文提供5种常见方法的代码示例,涵盖保持顺序与不保持顺序的场景,适合初学者和进阶开发者参考。

    Python写接口的步骤及完整代码示例
    Python写接口的步骤及完整代码示例

    详细讲解使用Python编写Web接口的核心步骤与完整代码示例,涵盖环境准备、路由定义、数据校验、服务启动及调试测试方法。

    codex怎么读取word文档及docx文件操作教程
    codex怎么读取word文档及docx文件操作教程

    介绍如何利用编程工具读取和解析Word文档(docx格式),涵盖基础文本提取代码示例、结构化数据处理逻辑,以及处理复杂排版时的技术局限与替代方案。

    怎么在Python中调用C语言代码提升性能
    怎么在Python中调用C语言代码提升性能

    详细讲解在Python中调用C语言代码提升性能的完整实践指南,包含原理分析、编译步骤、ctypes与CFFI具体实现、性能对比及常见陷阱。

    Python与C语言的性能差异及底层原理
    Python与C语言的性能差异及底层原理

    深入解析Python与C语言在执行效率上的数量级差异,从编译机制、变量内存布局、动态类型推断到GIL锁,系统阐明底层核心原理。

    Python和C语言哪个更适合编程入门
    Python和C语言哪个更适合编程入门

    客观对比Python与C语言在心智负担、底层机制与学习反馈上的核心差异,提供清晰有据的选择标准与切实的入门学习路径。

    selenium上传文件教程本地文件路径设置方法
    selenium上传文件教程本地文件路径设置方法

    深入解析Selenium处理文件上传的技术细节,涵盖标准HTML控件的路径直接注入法与非标准控件的系统级模拟方案,提供Windows与Linux环境下的路径设置最佳实践及常见异常排查。

    大数据开发语言选型:Java对比Scala与Python的优缺点及适用场景
    大数据开发语言选型:Java对比Scala与Python的优缺点及适用场景

    针对大数据工程场景,系统对比Java、Scala与Python在执行性能、生态结合、开发效率和维护成本上的核心差异,给出清晰的架构选型依据与落地方案。

    langgraph python guide中文入门教程详解
    langgraph python guide中文入门教程详解

    本篇LangGraph Python中文入门教程详解,系统梳理StateGraph状态机定义、节点编写、边与条件路由、检查点持久化(MemorySaver)等核心机制,提供从环境安装到完整循环智能体构建的代码示例与实操指导。

    Windows 安装 Python:从官方入口到虚拟环境的可复现实践
    Windows 安装 Python:从官方入口到虚拟环境的可复现实践

    面向后端开发者,基于 Python 官方文档说明如何在 Windows 上安装 Python、创建 venv 虚拟环境及使用 pip 管理依赖。包含可复制命令、验证方法及工具选择边界,避免常见配置误区。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。