Python装饰器工厂:为日志捕获功能正确实现带参数的类方法装饰器

风芳姑娘_9248

风芳姑娘_9248

2026-05-21

695人浏览

原创

Python装饰器工厂:为日志捕获功能正确实现带参数的类方法装饰器

本文详解如何修正因装饰器参数传递错误导致的 TypeError,通过静态方法+闭包结构构建可接收配置参数(如 file_path)的装饰器工厂,确保 @Logger.catch(file_path=...) 语法正常工作。

本文详解如何修正因装饰器参数传递错误导致的 `typeerror`,通过静态方法+闭包结构构建可接收配置参数(如 `file_path`)的装饰器工厂,确保 `@logger.catch(file_path=...)` 语法正常工作。

在 Python 中,当希望装饰器支持自定义参数(例如 @Logger.catch(file_path='log.txt')),它本质上是一个装饰器工厂(decorator factory):先调用工厂函数传入配置,再返回真正的装饰器函数。而原代码中 catch 被定义为普通实例方法(隐含 self 参数),又未正确处理 func 的传入时机,导致解释器误将 'tests/example.log' 当作 func,从而抛出 missing 1 required positional argument: 'func' 错误。

正确做法是将 catch 声明为 @staticmethod,使其脱离实例绑定,并采用三层嵌套结构:

  • 第一层:接收装饰器配置参数(如 file_path);
  • 第二层:接收被装饰的函数 func,返回包装器;
  • 第三层:wrapper 执行实际逻辑(try/except + 日志记录)。

以下是修复后的完整实现示例:

import sys
import traceback

class Logger:
    @staticmethod
    def catch(file_path=None):
        def decorator(func):
            def wrapper(*args, **kwargs):
                try:
                    return func(*args, **kwargs)
                except Exception as e:
                    _, _, tb = sys.exc_info()
                    traceback_info = traceback.extract_tb(tb)
                    if traceback_info:
                        last_frame = traceback_info[-1]
                        line = last_frame[1]
                        file = last_frame[0]
                        function_name = last_frame[2]
                    else:
                        line = file = function_name = "?"

                    # 假设 Logger.error 已正确定义(需自行实现)
                    Logger.error(
                        log_msg=str(e),
                        highlighting=True,
                        print_out=True,
                        line=[line, file, function_name],
                        file_path=file_path
                    )
                    raise  # 重新抛出异常,避免静默吞掉错误
            return wrapper
        return decorator

    @staticmethod
    def error(log_msg, highlighting, print_out, line, file_path=None):
        # 示例:简单控制台输出 + 可选文件写入
        msg = f"[ERROR] {log_msg} | File: {line[1]}, Line: {line[0]}, Func: {line[2]}"
        if print_out:
            print(msg)
        if file_path:
            try:
                with open(file_path, "a") as f:
                    f.write(msg + "\n")
            except OSError as write_err:
                print(f"[WARN] Failed to write log to {file_path}: {write_err}")

✅ 使用方式保持不变,且完全符合预期:

python学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载
@Logger.catch(file_path='tests/example.log')
def example_function():
    var1 = 5
    var = 0
    result = var1 / var  # 触发 ZeroDivisionError
    print(result)

⚠️ 注意事项:

  • @staticmethod 是关键——若使用 @classmethod 或普通方法,func 会与 self/cls 冲突;
  • wrapper 中建议 raise 原始异常(除非明确需要静默处理),否则调用链将中断;
  • traceback.extract_tb(tb) 返回列表可能为空,务必做边界检查(如上示例);
  • Logger.error 需独立实现并确保线程安全(如多线程场景下推荐使用 threading.Lock 或 logging 模块替代自定义方案)。

通过该模式,你不仅能解决当前崩溃问题,还可轻松扩展其他参数(如 level='WARNING'、include_stack=True 等),构建灵活、可复用的日志装饰器体系。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1811

4

python能做什么
python能做什么

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

2023.07.25

4824

7

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

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

2023.07.31

1769

3

python教程
python教程

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

2023.08.03

28817

23

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

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

2023.08.04

3447

5

python eval
python eval

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

2023.08.04

3467

5

scratch和python区别
scratch和python区别

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

2023.08.11

1223

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2683

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习