记一次 Windows 下 Python 3 的控制台虚拟终端序列(控制台颜色输出, colorama 库)的踩坑经历

修改

2022.7.31

感谢 @DavyZhou 的评论,对文章进行了一次大修改。

2022.8.2

我又踩到了坑上。我会加进去的。

[En]

I stepped on the pit again. I’ll add it.

前言

本人的电脑配置为 Windows 11 , Python 版本是 Anaconda python 3.9 ,此问题在以前用的 Windows 10, Python 3.7 应可以复现。
当然,如果老板发现了错误,或者有更简单的方法来纠正错误,我的解决方案可能不是最好的。

[En]

Of course, my solution may not be the best, if a boss sees a mistake or there is a simpler way to correct it.

(为了让大家了解详细的流程,文章可能有点水落石出,如果你觉得废话太多,可以从《如何支持虚拟终端》说起。)

[En]

(in order to let you understand the detailed process, the article may be a little watery, and you can start with “how to support virtual terminals” if you think there is a lot of nonsense.)

参考资料

标题 网址 控制台虚拟终端序列 – Microsoft
https://docs.microsoft.com/zh-cn/windows/console/console-virtual-terminal-sequences

console – PyPI
https://pypi.org/project/console/

Python – output of [31m text instead of color – stackoverflow
https://stackoverflow.com/questions/47432418/output-of-31m-text-instead-of-color

colorama – PyPI
https://pypi.org/project/colorama/

Python colorama not working with input? – Stack Overflow
https://stackoverflow.com/questions/32872612/python-colorama-not-working-with-input#answer-68958376

背景

最开始,我打算写一个文件数据处理小工具和别人共享,由于对性能要求的误判,我本来打算用 C++ 追求性能(做完后发现这个一周用一次的东西 C++ 最多每次能提速15秒),结果就因为同时需要输入中文文件名并且使用 UTF-8编码这件事一直踩坑,(2022年了微软连utf-8都没搞明白),于是还是打算采用 Python + Pyinstaller 。

因为我不想搞太麻烦,所以就没有使用 GUI 图形界面。但是这也太单调了,我想要控制台有不同的颜色,起码好看一点。我想起了以前看到过的 colorama 库,上次在 IDLE 跑出来一堆乱码,但我想这大概是 IDLE 的问题吧。然而,事情的发展远超出我的预料,在 cmd 上居然也跑不了?不过,在 C++ 探索中,我发现了这么一个东西——

控制台虚拟终端序列

控制台虚拟终端序列是这么一个东西(以下内容是 Microsoft Windows 官方的文档):

虚拟终端序列是控制字符序列,可在写入输出流时控制游标移动、控制台颜色和其他操作。 在输入流上也可以接收序列,以响应输出流查询信息序列,或在设置适当模式时作为用户输入的编码。
可以使用 GetConsoleMode 和 SetConsoleMode 函数配置此行为 。 本文档末尾包含了建议的启用虚拟终端行为的方法的示例。
以下序列的行为基于 VT100 和派生终端仿真器技术,尤其是 xterm 终端仿真器。 有关终端序列的详细信息,请访问 http://vt100.nethttp://invisible-island.net/xterm/ctlseqs/ctlseqs.html。

相信大家也发现,微软写的文件(尤其是中文版)有些模棱两可,整个页面都给出了一堆链接,不知道到哪里去找。

[En]

I believe you have also found that the documents written by Microsoft (especially the Chinese version) are a little ambiguous, and the whole page gives a bunch of links and doesn’t know where to find it.

简而言之,虚拟终端序列是一串控制字符序列,它们都以 ESC开始( ASCII 编码为十进制 27 ,八进制 33 ,十六进制 1B ,因此在 Python 中可以写作 \033\x1b ),而后大多数会跟一个 [(,再加上核心数字,最终一个字母。
在此,我们不讨论那么多,我当时只想要颜色,那么根据文档,很显然我们应该找”文本格式”,不过微软没有其他博主总结的好,搜一下 Python 控制台彩色输出结果一大把。

但我们不需要知道那么多,我们只需要一个图书馆–

[En]

But we don’t need to know that much, we just need a library–

colorama

先进行一下 pip install colorama

如果你有 IPython,你可以试一下这串代码:

from colorama import Fore, Back, Style
print(Fore.RED + "这一段字体颜色是红色" + Back.CYAN + "这一段还有青色背景"
      + Style.BRIGHT + "这一段更亮了" + Style.RESET_ALL + "这一段啥样式都没了")

结果如下所示(非常好):

[En]

The result is something like this (pretty good):

记一次 Windows 下 Python 3 的控制台虚拟终端序列(控制台颜色输出, colorama 库)的踩坑经历

不过,Colorama并不是本文的重点,网上的教程也是一搜一大把,但是问题就在于:

Colorama 靠什么实现?

我们注意到 Colorama的样式可以直接与字符串进行 +运算,这并不是因为它进行了重载,而是因为它就是一串字符串。不信看看:

In [1]: from colorama import Fore, Back, Style

In [2]: Fore.RED
Out[2]: '\x1b[31m'

In [3]: type(Fore.RED)
Out[3]: str

In [4]: Fore.RED + "这一段字体颜色是红色" + Back.CYAN + "这一段还有青色背景"
   ...: + Style.BRIGHT + "这一段更亮了" + Style.RESET_ALL + "这一段啥样式都没了"
Out[4]: '\x1b[31m这一段字体颜色是红色\x1b[46m这一段还有青色背景\x1b[1m这一段更亮了\x1b[0m这一段啥样式都没了'

对 C++ 控制台有过一定深入操作经验的肯定知道, C++ 很长一段时间都是调用 windows.h 内的 API 来实现的,但是现在这些繁杂的语法已经被 Microsoft 建议弃用了,同样改用虚拟终端序列。(它不仅可以在一定程度上降低或升高代码的复杂度,还可以更好地进行跨平台的支持(注:这一点目前还不清楚,不过趋势是这样)。)

那么,依赖虚拟终端序列有什么错呢?当然有。

[En]

So, what’s wrong with relying on virtual terminal sequences? Of course there is.

天坑 – 虚拟终端的支持

上面我在做 Colorama的示例的时候使用了 IPython而不是 Python自带的 shell ,这不止是因为 IPython使代码更好看、操作更方便,更主要是因为:
用 Python 自带的 Shell 它根本就不行!!!

不信我们试试:
打开默认的 cmd 或 Powershell ,输入”Python”,再把刚才的代码输入一遍:

>>> from colorama import Fore, Back, Style
>>> print(Fore.RED + "这一段字体颜色是红色" + Back.CYAN + "这一段还有青色背景" + Style.BRIGHT + "这一段更亮了" + Style.RESET_ALL + "这一段啥样式都没了")

然后,您会惊喜地发现输出如下所示:

[En]

Then you will be pleasantly surprised to find that the output looks like this:

记一次 Windows 下 Python 3 的控制台虚拟终端序列(控制台颜色输出, colorama 库)的踩坑经历

看到问题了吗?ESC字符输出成了乱码, cmd 下的 Python 压根儿就不支持虚拟终端!

Win11 有个”终端”软件,用它试试:

记一次 Windows 下 Python 3 的控制台虚拟终端序列(控制台颜色输出, colorama 库)的踩坑经历
(这咋又好了???)

再用 VS Code 试试。
不发图了,也可以支持。
然而,如果我们直接使用命令行运行 .py 文件或是直接双击打开,我们会发现它也是不支持颜色的。
上面说过了,”终端”软件是支持的,而 cmd 和 Powershell 是不支持的。

PyInstaller 由于变相打包了个 Python 虚拟机进去,所以生成的 .exe 文件的支持情况与上述打开方式完全相同。

什么原因?

事实上,原因的实质很简单:虚拟终端序列是否已经被支持。

[En]

In fact, the essence of the reason is simple: whether the virtual terminal sequence is already supported.

Windows 自带的 cmd 和 powershell 是不支持虚拟终端序列的。 Python 本身也不会自动启用。因此,两者一起,就无法正常输出了。
但是,”终端”软件默认开启了虚拟终端序列的支持,而 IPython 本身就一直在不停在使用控制台高级技能,所以某种程度上来说也是内置了。

如何支持虚拟终端?

其实这回 Microsoft 文档做的还算不错,给了一个示例:
https://docs.microsoft.com/zh-cn/windows/console/console-virtual-terminal-sequences#example-of-enabling-virtual-terminal-processing

如果你懒得翻问题也不大,但是有一个小小的问题:它好像是 C 语言诶(

好,那么现在你可以写一个 C-Extension 或者用 Cython 把它拿进来。
说实话这个方法应该也行,不过我们看看有没有更好的写法。(上述代码明显只能针对 Windows ,而且对嫌麻烦、开发经验不多或者希望只用 Python 完成小项目的人不太友好。)

所以,你对此无能为力了?事实上,确实有,而且很简单–

[En]

So, there’s nothing you can do about it? Actually, there is, and it’s very simple–

方案1: colorama.init() [新方案,实用快速]

当时大意了,知道看 console 的文档忘了看 colorama 的文档了。这里顺便提一嘴, pip 安装的库都可以去 https://pypi.org 上看文档。
上文档:https://pypi.org/project/colorama/#initialisation

因此,只要加个 init()初始化虚拟终端,把源代码改成这样就可以了(ps: 个人认为 init 函数可以用 as 取个别名,因为太容易跟自己代码撞上了):

from colorama import init, Fore, Back, Style
init()
print(Fore.RED + "这一段字体颜色是红色" + Back.CYAN + "这一段还有青色背景" + Style.BRIGHT + "这一段更亮了" + Style.RESET_ALL + "这一段啥样式都没了")

记一次 Windows 下 Python 3 的控制台虚拟终端序列(控制台颜色输出, colorama 库)的踩坑经历

没错,这样,就好了……吗?
其实并没有。在 Python shell 中可以实现,但是很玄学的地方就在于运行 Python 文件的时候不可以。根据 https://stackoverflow.com/questions/32872612/python-colorama-not-working-with-input#answer-68958376 ,看来如果是 Windows 平台,需要再进行一个 os.system("cls")

方案2: import console [原方案,鉴于 PyInstaller 的问题不建议使用]

ps: 可能由于设备环境不同没法用(尤其是打包后)。
而且截至 2022.7.31, colorama 最近更新在 2022.7.16 ,而 console 最近更新已经在2021.4 了。

同样地,先安装库 pip install console
官方文档在这:https://pypi.org/project/console/
(顺便说一句:安装了 console 就基本不需要 colorama 了, console 的支持非常全面,当然,模块加载时间也比较长。前面介绍 colorama 只不过是因为它宣传的最多,而且很少有人指出它的致命缺点。)

让我们再试一次,这次用不同的方式写:

[En]

Let’s try again, this time to write it differently:

from console import fg, bg, fx
print(fg.red + "这一段字体颜色是红色" + bg.cyan + "这一段还有青色背景" + fx.blink + "这一段更亮了" + fx.end + " 这一段啥样式都没了")

事实上,你会发现过渡相当顺利。

[En]

In fact, you will find that the transition is quite smooth.

我们再使用一下原来 cmd + Python + colorama 的配置,只不过加一个 import console,输入:

import console
from colorama import Fore, Back, Style
print(Fore.RED + "这一段字体颜色是红色" + Back.CYAN + "这一段还有青色背景" + Style.BRIGHT + "这 一段更亮了" + Style.RESET_ALL + "这一段啥样式都没了")

然后你就会发现:”console 我连用都没用,咋就又支持了?”运行效果(由于图一样,我就偷个懒,把之前的复制一份):

记一次 Windows 下 Python 3 的控制台虚拟终端序列(控制台颜色输出, colorama 库)的踩坑经历

这是为什么?(让我们在这里做一个粗浅的分析):

[En]

Why is this? (let’s do a shallow analysis here):

找一下 console的源码:
__init__.py里有:

detection is performed if not explicitly disabled
if (_env.PY_CONSOLE_AUTODETECT.value is None or
    _env.PY_CONSOLE_AUTODETECT.truthy):

    # detect palette, other modules are dependent
    from .detection import init as _init
    term_level = _init(using_terminfo=using_terminfo)

而且 if 的表达式在普通环境下一般是 True,所以就会调用 .detection.init

再继续看看 detection.py
… 我好像高估我自己了,有兴趣的自己可以去研究一下,大概是 env这个库的原因。

总之,这一机制使得 console这个库一旦被调用就可以直接提供虚拟终端的支持。

总结:

  1. 虚拟终端序列支持的锅
  2. 使用前先 os.system("cls")(Windows) colorama.init()

好了,这就是主要内容,如果你认为有用或者解决了问题,给作者点赞吧!

[En]

Well, this is the main content, if you think it is useful or solve the problem, give the author a like!

Original: https://www.cnblogs.com/cup11/p/16531945.html
Author: cup11
Title: 记一次 Windows 下 Python 3 的控制台虚拟终端序列(控制台颜色输出, colorama 库)的踩坑经历

原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/498951/

转载文章受原作者版权保护。转载请注明原作者出处!

(0)

大家都在看

亲爱的 Coder【最近整理,可免费获取】👉 最新必读书单  | 👏 面试题下载  | 🌎 免费的AI知识星球