讲师中心 微信公众号
AI工具推荐 视频效率加速

Python项目中如何自定义异常类_继承Exception基类并添加业务错误码

浅墨大大_7242

浅墨大大_7242

发布时间:2026-04-08 14:23:03

|

277人浏览过

|

来源于php中文网

原创

业务异常必须继承Exception而非BaseException,以确保能被except Exception捕获;自定义异常应通过__init__接收code/message/details等参数,保留args[0]为message,并重写__str__添加错误码,避免异常类爆炸可采用工厂方法+错误码注册表统一管理。

python项目中如何自定义异常类_继承exception基类并添加业务错误码

为什么要继承 Exception 而不是 BaseException

直接继承 BaseException 会导致自定义异常无法被常规 except Exception: 捕获,因为 SystemExit、KeyboardInterrupt 等系统级异常也继承自它。业务异常必须走 Exception 这条链,否则上线后可能“捕不到错却报错消失”,排查时一头雾水。

常见错误现象:except Exception: 块完全不触发,日志里只看到未处理的 MyBusinessError 报错退出。

  • 所有业务异常类都应显式继承 Exception(或其子类如 ValueError)
  • 避免用 class MyError: 这种无继承写法——Python 3 中默认不继承任何类,等价于 object,不是异常类型
  • 不要重写 __init__ 时不调用 super().__init__(message),否则 str(exc) 返回空字符串

如何在自定义异常中安全携带错误码和上下文数据

错误码不能只靠类名区分(比如 UserNotFound 和 OrderNotFound 都是 404),得作为实例属性可读、可序列化。推荐用只读属性 + 初始化参数控制,避免运行时被意外修改。

使用场景:API 返回 JSON 时需透出 code 和 message;日志采集需统一提取 error_code 字段。

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

Claw Code Suite (Python-Only Edition)
Claw Code Suite (Python-Only Edition)

仅使用 Python 将 Claw Code 虚拟化框架与 OpenClaw 集成,提供 184 种工具和 200 多条命令,用于安全分析和代码质量...

下载
class BizError(Exception):
    def __init__(self, code: int, message: str, details: dict = None):
        super().__init__(message)
        self.code = code
        self.details = details or {}
<h1>使用</h1><p>raise BizError(code=1001, message="库存不足", details={"sku_id": "S123", "available": 0})
  • code 用 int 类型,方便前端 switch 判断,也兼容 Prometheus 等监控系统打点
  • 不要把 details 设为可变默认参数 {} —— 多次 raise 会共享同一字典对象
  • 若需区分错误等级(如警告/错误/严重),可额外加 level 属性,但别混用 logging 级别名(如 "ERROR"),改用枚举或整数

__str__ 和 __repr__ 怎么写才不影响调试和日志输出

默认 str(exc) 只返回 message,但运维查日志时往往需要一眼看到 code。重写 __str__ 加上错误码是合理做法;而 __repr__ 应保持“可重建对象”的风格,方便开发调试。

容易踩的坑:重写 __str__ 后导致 Sentry 或其他 APM 工具提取 message 失败——它们通常依赖 exc.args[0],而非 str(exc)。

  • 始终保留 message 在 args[0],即 super().__init__(message) 不可省
  • __str__ 可返回 f"[{self.code}] {self.args[0]}",既清晰又不破坏原有行为
  • __repr__ 建议返回 f"{self.__class__.__name__}({self.code!r}, {self.args[0]!r})",复制粘贴到 REPL 能直接执行

如何避免异常类爆炸——用工厂函数或注册表管理业务错误码

项目大了以后,几十个异常类散落在各模块,既难查找又易重复定义(比如两个模块都写了 UserLockedError(2003))。与其让每个错误码对应一个类,不如用单个基类 + 类方法生成实例,再配合模块级错误码注册表。

性能影响极小,但能显著降低维护成本,尤其适合微服务间错误码对齐场景。

# errors.py
class ErrorCode:
    USER_NOT_FOUND = 1001
    INSUFFICIENT_BALANCE = 1002
<p>class BizError(Exception):
_registry = {}</p><pre class="brush:php;toolbar:false;">def __init__(self, code: int, message: str, details: dict = None):
    super().__init__(message)
    self.code = code
    self.details = details or {}

@classmethod
def new(cls, code: int, message: str, **kwargs):
    return cls(code, message, kwargs)

使用

raise BizError.new(ErrorCode.USER_NOT_FOUND, "用户不存在")

  • 错误码常量统一收口在 ErrorCode 类或 errors.py,禁止硬编码数字
  • 不建议用 @unique 枚举类包装错误码——增加 import 依赖,且 IDE 对 Enum 成员的跳转支持不如普通属性
  • 如果团队用 OpenAPI,错误码注释可直接从 ErrorCode 类生成,避免文档和代码脱节

业务异常类本身不复杂,但一旦跨服务、跨语言、进日志系统、对接监控平台,错误码的类型、可读性、不可变性就会变成关键细节。最常被忽略的是 args[0] 的一致性——它决定了 80% 的日志解析和告警规则是否生效。

热门AI工具

更多
讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

1751

2023.07.20

python能做什么
python能做什么

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

4484

2023.07.25

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

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

1729

2023.07.31

python教程
python教程

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

26417

2023.08.03

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

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

3207

2023.08.04

python eval
python eval

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

3227

2023.08.04

scratch和python区别
scratch和python区别

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

1183

2023.08.11

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

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

596

2023.08.10

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

0

2026.10.16

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn