Python 自定义异常的设计原则

千辰君_8573

千辰君_8573

2026-01-30

387人浏览

原创

自定义异常应继承Exception而非BaseException;类名须以Error结尾;__init__中必须调用super().__init__(message);仅在业务语义不匹配内置异常时才自定义。

python 自定义异常的设计原则

自定义异常该继承哪个基类

Python 中所有异常都应继承 Exception,而不是 BaseException(后者是系统退出、键盘中断等底层异常的父类)。继承 BaseException 会导致 except Exception: 捕获不到你的异常,还可能意外拦截 SystemExit 或 KeyboardInterrupt,破坏程序可控性。

实操建议:

  • 业务逻辑异常一律继承 Exception
  • 若需分类管理(如 API 错误、数据校验错误),可设中间抽象类,例如 class ValidationError(Exception): pass
  • 避免直接继承 RuntimeError 或 ValueError 除非语义完全匹配——否则会误导调用方对错误性质的判断

异常名要不要带 Error 后缀

要。PEP 8 明确建议异常类名以 Error 结尾(如 ConfigNotFoundError),这是 Python 社区通用约定。不加后缀(如 ConfigNotFound)会让使用者难以一眼识别其用途,也容易和普通类、数据类混淆。

常见错误现象:

  • IDE 在 raise 或 except 处缺少语法提示
  • 团队代码 review 时反复质疑“这个类到底是干啥的?”
  • 日志或监控系统按命名规则自动归类异常失败

__init__ 里要不要调用 super().__init__

要,且必须传入用户可读的错误消息。Python 异常的字符串表示(str(exc))、日志输出、调试器显示都依赖 args 元组,而 super().__init__(message) 正是填充它的标准方式。

Python Pep Authoring
Python Pep Authoring

依据官方 python/peps仓库规则起草、审阅、编辑或准备 Python 改进提案(PEP),用于处理 PEP 文本和元数据头部。

下载

实操建议:

  • 不要只写 pass 或空 __init__;否则 str(e) 返回空字符串,日志里只剩类名,无法定位问题
  • 避免在 __init__ 中做耗时操作(如网络请求、文件读取)——异常实例化应轻量
  • 若需附加结构化信息(如错误码、原始数据),用额外属性存储,例如 self.error_code = 4001,而非塞进 message

什么时候该抛出自定义异常,而不是用内置异常

当内置异常无法准确表达业务语义,或上层需要差异化处理时。比如用户权限不足,抛 PermissionError 看似合理,但它实际对应操作系统级权限,和业务角色权限不是同一维度;此时 InsufficientRoleError 更清晰,也方便 API 层统一转为 403 响应。

使用场景判断要点:

  • 是否有多处相同语义错误,且需被同一 except 块捕获?→ 适合自定义
  • 是否需要携带业务专属字段(如订单 ID、租户 code)?→ 自定义更易扩展
  • 是否希望在 Sentry 或 ELK 中按类型聚合统计?→ 命名明确的自定义异常更可靠
  • 反之,参数类型错用就用 TypeError,键不存在就用 KeyError,别为了“统一”强行包装

最易被忽略的一点:自定义异常类本身要能被序列化。如果走 RPC 或存入日志系统(如 JSON 格式),确保它不含不可序列化的属性(如 open 的 file 对象、lambda 函数),否则在跨进程/网络场景下会静默失败或报 TypeError: Object of type XXX is not JSON serializable。

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

相关文章

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

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

下载

相关标签:

python js json 操作系统

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2235

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3602

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1196

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

4139

7

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.18

1029

5

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.25

3260

5

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1858

5

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2964

5

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

2023.10.24

6244

49

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程