更好地格式化跟踪信息。
项目描述
注意:这仍然是一个早期预发布版本。它对我有效,除了SyntaxError的一些不完美之处,但没有保证。
Tracefront使您的跟踪信息更美观且实用,就像在 nose-progressive
(当然,失败部分和测试名称只是那个测试运行器的一部分。)
我的动机是什么?
明智地使用颜色和其他格式化使跟踪信息易于扫描。在调试时,很容易滑动到函数名称列表以保持位置。
使用相对路径(可选)和省略冗余文字更适合有限的屏幕空间。
编辑器快捷键(见下文)让您可以直接跳转到编辑器中的任何问题行。
编辑器快捷键
对于跟踪信息中的每个帧,Tracefront提供了一个编辑器快捷键。这是文件系统路径和行号的组合,这种格式被vi、emacs、BBEdit命令行工具以及其他许多编辑器所理解。
vi +361 apps/notifications/tests.py # test_notification_completeness
只需三击(或类似操作)来选择该行,并将其复制粘贴到命令行。您将直接到达您选择的编辑器中的问题行。作为额外奖励,编辑器快捷键比默认的回溯格式化更紧凑,如果您有大量输出需要测试运行器打印,这将非常方便。如果输出看起来像要发送到功能齐全的终端,它甚至会使用颜色。
您可以通过设置以下任一项来设置要使用的编辑器,Tracefront将按顺序检查这些设置
$TRACEFRONT_EDITOR 环境变量
$EDITOR 环境变量
安装
只需这样做...
pip install tracefront
……您的所有回溯都将变得美观且对任何执行此操作的程序都很有帮助
imports traceback
将来,我正在考虑使用更深入的邪恶来使其更加隐晦地激活。
选项
Tracefront 通过设置环境变量进行配置。
- TRACEFRONT_ABSOLUTE_PATHS=1
将此设置为 1 以始终使用绝对路径而不是相对于当前工作目录的路径。
- TRACEFRONT_EDITOR=<editor>
构建编辑器快捷键时要使用的编辑器
- TRACEFRONT_FUNCTION_COLOR=<0..15>
用于在回溯中显示函数名称的 ANSI 颜色编号
- TRACEFRONT_DIM_COLOR=<0..15>
用于在回溯中显示强调文本(如编辑器快捷键)的 ANSI 颜色编号
工作原理
Tracefront 是对默认回溯模块的阴影,对大多数内容进行调用,但替换核心格式化部分。如果一个程序对格式化回溯的组成做出了假设,它可能会崩溃,但这很奇怪,因为还有更多方便的表示方法。
许可证
Tracefront 在 MIT 许可下。请参阅 LICENSE 文件。
版本历史
- 0.4 (2012-07-08)
使 TRACEFRONT_FUNCTION_COLOR 和 TRACEFRONT_DIM_COLOR 正常工作。(msabramo)
使测试在 Python 2.5 下运行。(msabramo)
添加 Travis CI。(msabramo)
解决虚假的 python setup.py test 错误信息。(msabramo)
- 0.3 (2012-03-22)
尽早获取当前工作目录,这样我们更有可能得到正确的相对路径(例如,在运行 nosetests 时)。
使 tox 形状完美。现在测试可以在 Python 2.5 下通过。
更彻底地安装。这将捕获由解释器本身抛出的回溯,而不仅仅是显式格式化的回溯——只要程序在某个时刻导入了 traceback 模块。
修补 print_list(),这是最后需要美化的主要例程。我们仍然需要完善 SyntaxError 的最后几行的显示。
- 0.2 (2012-03-17)
始终使用终端代码。(Django 使用 format_list 而不是 print_tb,但我想让它有颜色。)
在 readme 中记录所有选项。
- 0.1 (2012-03-16)
从 nose-progressive 中提取了回溯格式化内容。几乎没有测试。可能会擦除您的驱动器。