Python装饰器进阶:如何正确实现带参数的类方法装饰器

浅杰姑娘_9949

浅杰姑娘_9949

2026-05-21

304人浏览

原创

Python装饰器进阶:如何正确实现带参数的类方法装饰器

本文详解如何修复因装饰器参数设计不当导致的“missing 1 required positional argument”错误,通过静态方法+闭包组合构建可传参的类内装饰器,适用于日志捕获、异常处理等场景。

本文详解如何修复因装饰器参数设计不当导致的“missing 1 required positional argument”错误,通过静态方法+闭包组合构建可传参的类内装饰器,适用于日志捕获、异常处理等场景。

在 Python 中,为类定义带参数的装饰器(如 @Logger.catch(file_path='...'))时,常见的误区是将装饰器实现为普通实例方法或类方法——这会导致 Python 尝试将被装饰函数自动作为第一个参数传入,从而与显式声明的 file_path 参数冲突,引发 TypeError: Logger.catch() missing 1 required positional argument: 'func'。

根本原因在于:装饰器调用语法 @Logger.catch(file_path=...) 实际上先执行 Logger.catch(file_path=...),期望其返回一个真正的装饰器(即接收 func 的函数),而非直接尝试装饰。而原代码中 catch(func, file_path=None) 是一个两参数方法,当仅传入 file_path 时,func 无处可来,自然报错。

✅ 正确解法是采用 三层嵌套结构 + @staticmethod:

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

同时,必须将 catch 声明为 @staticmethod,避免隐式绑定 self 或 cls,确保调用链纯净。

Secure Python Code Sandbox
Secure Python Code Sandbox

安全 Python 代码沙箱:在隔离的沙箱中执行任意 Python 代码,预装 requests、NumPy、pandas 库。返回 stdout、stderr。

下载

以下是修复后的完整 Logger 类示例(含健壮性增强):

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_no = last_frame.lineno
                        filename = last_frame.filename
                        func_name = last_frame.name
                    else:
                        line_no = filename = func_name = "unknown"

                    # 调用统一错误日志方法(需自行实现)
                    Logger.error(
                        log_msg=str(e),
                        highlighting=True,
                        print_out=True,
                        line=[line_no, filename, func_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(f"\033[91m{msg}\033[0m" if highlighting else msg)

        if file_path:
            try:
                with open(file_path, "a", encoding="utf-8") as f:
                    f.write(f"{msg}\n")
            except OSError as write_err:
                print(f"[WARN] Failed to write log to {file_path}: {write_err}")

使用方式保持不变,且完全兼容:

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

example_function()  # 输出错误信息并写入日志文件

⚠️ 注意事项:

  • 不要省略 raise —— 否则异常会被吞掉,不利于调试;
  • file_path 应支持 None(默认不写文件)并做异常防护,避免因磁盘满/权限不足导致日志功能拖垮主逻辑;
  • 若需支持异步函数,需额外实现 async def wrapper(...) 并用 await func(...),本例为同步场景;
  • @staticmethod 是关键:若误用 @classmethod,cls 会抢占第一个参数位;若无任何装饰器,则 self 会强制注入。

通过这种模式,你不仅能解决当前崩溃问题,还能复用该结构开发任意带配置参数的装饰器(如重试、超时、性能分析等),大幅提升工具类的灵活性与工程化水平。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1791

4

python能做什么
python能做什么

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

2023.07.25

4724

7

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

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

2023.07.31

1749

3

python教程
python教程

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

2023.08.03

28077

23

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

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

2023.08.04

3387

5

python eval
python eval

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

2023.08.04

3387

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2623

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习