如何在Python中检测控制台是否支持ANSI转义码？

Question

为了检测控制台是否正确 sys.stderr 或 sys.stdout，我做了以下测试：

if hasattr(sys.stderr, "isatty") and sys.stderr.isatty():
   if platform.system()=='Windows':
       # win code (ANSI not supported but there are alternatives)
   else:
       # use ANSI escapes
else:
   # no colors, usually this is when you redirect the output to a file

现在，通过运行此 Python 代码时，问题变得更加复杂IDE（如 PyCharm）。最近 PyCharm 添加了对 ANSI 的支持，但第一次测试失败：它具有 isatty 属性，但设置为 False。

我想修改逻辑，以便它能够正确检测输出是否支持 ANSI 着色。一个要求是，在任何情况下，当输出重定向到文件时，我都不应该输出任何内容（对于控制台来说，这是可以接受的）。

更新

在 https://gist.github.com/1316877 添加了更复杂的 ANSI 测试脚本

Answer 1

Django 用户可以使用 django.core.management.color.supports_color 函数。

if supports_color():
    ...

他们使用的代码是：

def supports_color():
    """
    Returns True if the running system's terminal supports color, and False
    otherwise.
    """
    plat = sys.platform
    supported_platform = plat != 'Pocket PC' and (plat != 'win32' or
                                                  'ANSICON' in os.environ)
    # isatty is not always implemented, #6223.
    is_a_tty = hasattr(sys.stdout, 'isatty') and sys.stdout.isatty()
    return supported_platform and is_a_tty

请参阅 https://github。 com/django/django/blob/master/django/core/management/color.py

Answer 2

我可以告诉你其他人是如何解决这个问题的，但这并不漂亮。如果您以 ncurses 为例（它需要能够在各种不同的终端上运行），您会发现它们使用 终端能力数据库，用于存储各种终端及其能力。关键是，即使他们也永远无法自动“检测”这些东西。

我不知道是否有跨平台 termcap，但可能值得您花时间寻找它。即使它在那里，它也可能没有列出您的终端，您可能必须手动添加它。

Answer 3

\x1B[6n 是一个标准的（据我所知）ANSI 转义码，用于查询用户光标的位置。如果发送到标准输出，终端应将 \x1B[{line};{column}R 写入标准输入。如果达到此结果，则可以假设支持 ANSI 转义码。主要问题是检测这个回复。

Windows

msvcrt.getch 可用于从 stdin 检索字符，而无需等待按下 Enter 键。这与 msvcrt.kbhit 结合使用，后者检测 stdin 是否正在等待读取，并生成在本文的带有注释的代码部分中找到的代码。

Unix/with termios

警告：我（不明智地）没有测试这个特定的 tty/select/termios 代码，但过去知道类似的代码可以工作。
可以使用 tty.setraw 和 select.select 复制 getch 和 kbhit。因此，我们可以如下定义这些函数：

from termios import TCSADRAIN, tcgetattr, tcsetattr
from select import select
from tty import setraw
from sys import stdin

def getch() -> bytes:
    fd = stdin.fileno()                        # get file descriptor of stdin
    old_settings = tcgetattr(fd)               # save settings (important!)

    try:                                       # setraw accomplishes a few things,
        setraw(fd)                             # such as disabling echo and wait.

        return stdin.read(1).encode()          # consistency with the Windows func
    finally:                                   # means output should be in bytes
        tcsetattr(fd, TCSADRAIN, old_settings) # finally, undo setraw (important!)

def kbhit() -> bool:                           # select.select checks if fds are
    return bool(select([stdin], [], [], 0)[0]) # ready for reading/writing/error

然后可以将其与以下代码一起使用。

带注释的代码

from sys import stdin, stdout

def isansitty() -> bool:
    """
    The response to \x1B[6n should be \x1B[{line};{column}R according to
    https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797. If this
    doesn't work, then it is unlikely ANSI escape codes are supported.
    """

    while kbhit():                         # clear stdin before sending escape in
        getch()                            # case user accidentally presses a key

    stdout.write("\x1B[6n")                # alt: print(end="\x1b[6n", flush=True)
    stdout.flush()                         # double-buffered stdout needs flush 

    stdin.flush()                          # flush stdin to make sure escape works
    if kbhit():                            # ANSI won't work if stdin is empty
        if ord(getch()) == 27 and kbhit(): # check that response starts with \x1B[
            if getch() == b"[":
                while kbhit():             # read stdin again, to remove the actual
                    getch()                # value returned by the escape

                return stdout.isatty()     # lastly, if stdout is a tty, ANSI works
                                           # so True should be returned. Otherwise,
    return False                           # return False

带注释的完整代码

如果您需要，这里是原始代码。

from sys import stdin, stdout
from platform import system


if system() == "Windows":
    from msvcrt import getch, kbhit

else:
    from termios import TCSADRAIN, tcgetattr, tcsetattr
    from select import select
    from tty import setraw
    from sys import stdin

    def getch() -> bytes:
        fd = stdin.fileno()
        old_settings = tcgetattr(fd)

        try:
            setraw(fd)

            return stdin.read(1).encode()
        finally:
            tcsetattr(fd, TCSADRAIN, old_settings)

    def kbhit() -> bool:
        return bool(select([stdin], [], [], 0)[0])

def isansitty() -> bool:
    """
    Checks if stdout supports ANSI escape codes and is a tty.
    """

    while kbhit():
        getch()

    stdout.write("\x1b[6n")
    stdout.flush()

    stdin.flush()
    if kbhit():
        if ord(getch()) == 27 and kbhit():
            if getch() == b"[":
                while kbhit():
                    getch()

                return stdout.isatty()

    return False

来源

不分先后：

• https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797
• https://docs.python.org/3/library/select.html
• https://docs.python.org/3/library/tty.html
• https://docs.python.org/3/library/termios.html
• https://www.lihaoyi.com/post/BuildyourownCommandLinewithANSIescapecodes.html#user-input
• https ://stackoverflow.com/a/1052115/15081390