在终端上为Python着色异常

时间:2013-02-08 15:30:31

标签: python exception colors

是否有一种简单的方法可以在命令行上对异常的消息进行着色?例如

def g():    f()
def f():    1/0
g()

给出错误

Traceback (most recent call last):
  File "test.py", line 3, in <module>
    g()
  File "test.py", line 1, in g
    def g():    f()
  File "test.py", line 2, in f
    def f():    1/0
ZeroDivisionError: integer division or modulo by zero

我想在终端上对“整数除法或模数为零”进行着色或突出显示,以便我可以快速从长回溯中选择它(仅限Linux)。理想情况下,我不想为每个Exception编写一个自定义类,但不知何故捕获并格式化所有类型。

编辑:评论中链接的问题提供了如何使用外部软件解决问题的示例,但我对内部Python解决方案感兴趣。

4 个答案:

答案 0 :(得分:11)

您可以为sys.excepthook handler分配自定义功能。只要存在未处理的异常(因此退出解释器),就会调用该函数。

import sys

def myexcepthook(type, value, tb):
    import traceback
    from pygments import highlight
    from pygments.lexers import get_lexer_by_name
    from pygments.formatters import TerminalFormatter

    tbtext = ''.join(traceback.format_exception(type, value, tb))
    lexer = get_lexer_by_name("pytb", stripall=True)
    formatter = TerminalFormatter()
    sys.stderr.write(highlight(tbtext, lexer, formatter))

sys.excepthook = myexcepthook

此版本使用pygments library将回溯文本转换为使用ANSI着色格式化的文本,然后再将其写入stderr

答案 1 :(得分:4)

使用IPython模块找到了另一种方法,这可能是每个人都已安装的依赖项:

from IPython.core.ultratb import ColorTB
c = ColorTB()
exc = sys.exc_info()
print(''.join(c.structured_traceback(*exc)))

答案 2 :(得分:2)

查看colorama(或任何其他着色)模块。然后你可以用以下内容包装整个应用程序:

import traceback
from colorama import Fore, init
init( )

try:
    // your app
except Exception:
    print Fore.RED + traceback.format_exc( ) + Fore.RESET
    // possibly raise again or log to db

答案 3 :(得分:1)

这将解决方案@freakish共享,并使着色成为异常的一部分,而不是要求用户为每个异常消息添加颜色。显然,它仅适用于自定义异常,因此可能与OP所寻找的不完全相同。

from colorama import Fore, init
init()

class Error (Exception):
    def __init__ (self, message):
        super().__init__(Fore.RED + message)

class BadConfigFile (Error):
    pass

raise BadConfigFile("some error message")

这将以红色显示“某些错误消息”的回溯。将“错误”作为基类意味着您可以创建其他所有异常,这些异常都将继承消息的颜色。