调试模式

在你最需要的时候赋予你超级力量

调试模式是一个小巧的库，它将强大的调试工具放在你的指尖。

你将获得什么

如果激活了debug_mode（见下文），你将可以从任何地方访问以下功能

• 来自icecream库的ic。一个更好的打印语句，用于调试目的。
• 来自ipdb的函数装饰器iex，如果装饰的函数引发异常，它将启动调试会话。对于那些不知道问题出在哪里的情况非常有用。
• 来自wat的wat，允许你更深入地检查所有变量。

此外，当你使用breakpoint()或set_trace()开始调试时，你将进入ipdb，这是一个更好的pdb，那里也有wat可用。

最后，debug_mode将在当前目录下创建一个名为_debug的文件夹，并将其路径存储在名为debug_folder的名称下，使其全局可访问。这是一个放置绘图、临时文件等的绝佳地方。

用法

要使用它，只需导入并导出DBG环境变量。

在你的代码中，你通常会有以下一行代码在那里坐着，什么也不做。

import debug_mode

这没有开销，真的什么也不做。然而，🐛 BUG 警报 🐛，现在你需要尽你所能来解决问题。要激活 debug_mode，你只需要导出 DBG，它可以持有任何值，只需要存在即可。你可以通过许多方式实现这一点。

在你的当前终端中，你可以这样做

export DBG=1

之后你代码的所有运行都会激活调试模式。否则，你也可以只为下一次脚本调用使用它

DBG=1 python myscript.py

或者如果你想让它始终开启，你可以从你的 bashrc、zshrc... 导出

让 Ruff 满意

我个人使用 Ruff 对所有的代码进行 linting。可以理解的是，他对那些他一无所知的全局对象并不满意，并且会大声呼喊你，例如使用 "undefined" ic。

你可以在你的 pyproject.toml 中添加以下 Ruff 配置

[tool.ruff]
builtins = ["ic", "iex", "wat"]

如果你已经在 pyproject 中有 [tool.ruff] 部分，只需添加 builtins 部分。

安装

调试模式在 PyPI 上可用

pip install debug-mode

但你也可以将 debug_mode 文件夹复制到你的项目中，并将其需求添加到你的项目中。

pip install icecream ipdb wat-inspector

致谢

如果你在项目中发现这很有用，请留下一个 ⭐。