小张最近遇到一件不大不小的事。他写了一个简单的登录测试脚本,用来帮同事验证一批用户的账号密码是否可用。脚本跑起来很快,刷刷刷一行行结果往外蹦,"成功""失败""成功""失败"......几十行看下来,他根本看不清哪些失败了。每次都要在长长的输出里一行行找"失败"两个字。
同事建议他试试colorama这个库。能让成功显示成绿色,失败显示成红色,一眼就能看出来问题出在哪。
colorama是谁?为什么需要它?
colorama是一个极其简单的Python第三方库,核心就干一件事:让你的命令行打印出彩色的字。它不需要依赖任何别的库,装上去就能用。
"命令行这不一直支持颜色吗?"你可能会问。问题没这么简单。
Linux和Mac的终端天生支持颜色,直接在字符串里加几个特殊转义符就行。但在Windows的命令提示符和旧版PowerShell里,你不做点什么,这些转义字符直接原样输出给你看------屏幕上出现一堆像\033[31msome red text这样乱七八糟的东西,而不是红色的文字。
colorama的价值就在这里。它帮你自动识别你用的是什么系统。Windows用户调用一下初始化,colorama会自动把颜色代码转换成合适的Win32 API调用;你代码不用动,在Linux、Mac和Windows上都能正常显示颜色。你只用写一套代码,到处都能跑出漂亮的效果。
安装它,只需要一行:
pip install colorama
跨平台的兼容性,colorama支持的Python版本也覆盖得很全:3.9、3.10、3.11、3.12、3.13,还有PyPy 3.11都在支持范围内。版本0.4.6之后对Python 3.12的兼容性也都完善了。
最简单的用法:Fore, Back, Style
colorama提供了三个核心类:
- Fore:控制文字的颜色
- Back:控制文字的背景色
- Style:控制文字的样式(加粗、变暗、高亮等)
举个最简单的例子,你要打印一个字"小红",让他显示成红色的:
swift
from colorama import init, Fore, Back, Style
init()
print(Fore.RED + "hello, red world")
print(Back.GREEN + "这是绿色的背景")
print(Style.BRIGHT + "这是高亮/加粗的文字")
这里可以看到一个小细节,Fore.RED、Back.GREEN这些常量本质上是一些"控制代码"的包装。把它们和普通字符串用+拼接在一起,然后再传给print()去打印,终端遇到这些代码时就知道"红色文字从这里开始"。但所有颜色常量都要用英文大写来写。
颜色做完别忘了关灯:你可能会踩的坑
你可能会想当然地以为,上面印完Fore.RED + "hello"之后,再打一句print("world")会自动恢复默认。但现实是很无情的。如果你直接敲进命令行,你会发现后面的文字依然是红色的。因为在终端看来,cmd.exe不是聪明人,你不说停止它就永远保持帮你设的那个颜色参数。
bash
print(Fore.RED + "这段话是红色的")
print("这段话也偷偷变成奇怪的颜色了??")
第二个print会继承上一个print设置的状态,输出也是红色的。你可能会觉得这样还行,用红色记录警告,但下一条可读性就很差了。更麻烦的是,你正在编写的复杂项目中可能会不小心让异常报错也跟着变成全红,大大降低代码查阅的愉悦感。这时候你需要做一件事:强制把颜色恢复回来。
手动重置颜色的方式是:
bash
print(Fore.RED + "红色的文字" + Fore.RESET)
print("现在恢复正常颜色了")
不过这只重置了前景的颜色,背景色和亮度风格还没回去,保险一些的完全重置要靠Style.RESET_ALL。
但代码里到处加+ Style.RESET_ALL很累人。更省力的办法用到init(autoreset=True):
python
from colorama import init, Fore
init(autoreset=True)
print(Fore.RED + "红色的文字")
print("自动恢复默认颜色,不用操心")
设置里autoreset=True意味着每行内所有颜色变化在call最后一步时都会自动执行重置命令,不干扰后面的代码。
实战例子:让登录日志"一目了然"
回到小张的登录测试脚本。原来的版本是这样的:
python
results = [
("user1", "登录成功"),
("user2", "登录失败 - 密码错误"),
("user3", "登录成功"),
("user4", "登录成功"),
("user5", "登录失败 - 账户锁定"),
]
for user, status in results:
print(f"{user}: {status}")
在色彩的世界里,我们可以改写东西:
python
from colorama import init, Fore
init(autoreset=True)
for user, status in results:
if "成功" in status:
color = Fore.GREEN
else:
color = Fore.RED
print(f"{user}: {color}{status}")
这么一改,输出调试瞬间一目了然。init(autoreset=True)确保每个print内部的颜色设定不会影响到下一行,后方的不同行不会意外变色了。
假如一段log同时用到前景、背景和高亮加粗,可以组合颜色样式可以:
bash
print(Fore.YELLOW + Back.BLUE + Style.BRIGHT + "关键日志" + Style.RESET_ALL)
print("后续执行指令恢复了")
这种组合可以产生醒目的提醒旗帜,让系统日志在复杂调试里一目了然。
从头到脚说完整个颜色表
colorama支持的全部颜色在这里:
- 红色、绿色、黄色、蓝色
- 洋红色(MAGENTA)、青色(CYAN)、白色、黑色
- 保留预设的颜色变淡的DEFAULT(还原回系统默认)
前景色(Fore): Fore.RED, Fore.GREEN, Fore.YELLOW, Fore.BLUE, Fore.MAGENTA, Fore.CYAN, Fore.WHITE, Fore.BLACK 背景色(Back): 对应红/绿/黄/蓝/洋红/青/白/黑等8种颜色 文字样式(Style): Style.DIM(变暗), Style.NORMAL(常规), Style.BRIGHT(高亮/加粗)
大部分普通应用只需要这三种,8种颜色已经足够满足八成场景的需求。
进阶技巧:高亮特定单词
你也可能只想把句子里的某个关键单词特殊标记。比如一行错误日志,只把"ERROR"涂红,其余文字保持默认。
实现这种局部着色有很多手段。假定有一个固定词需要高亮,可以用replace()把目标词包上颜色控制符:
arduino
from colorama import init, Fore
init(autoreset=True)
def highlight_word(text, word, color):
colored_word = color + word + Fore.RESET
return text.replace(word, colored_word)
log = "ERROR: Here comes some problem about file path"
print(highlight_word(log, "ERROR", Fore.RED))
这样实现起来代码干净,也好维护。
使用colorama没有正确初始化?两种通用做法
前面提到终端的彩色打印需要调用init()。关于初始化的调用方式,有两个主流用法:
init(autoreset=True):适合不想手动多次Reset的情况,每次颜色都会有效分隔开;init(convert=True, autoreset=True):显式打开ANSI转Win32转换,对某些老旧Windows环境更可靠。
其实在较新的colorama 0.4.6版本中,init()会自动检测系统环境,在大部分情况下直接init(autoreset=True)就够用了。
但在公司复杂的内部环境(非标准IDE的嵌入式终端)或者服务器集群测试情况下,有时色彩依然出不来的症状,可以试试一个更健壮的初始化方法------使用just_fix_windows_console()函数,专门解决Windows终端颜色穿透问题。这个函数比旧版的init()更可靠。
一个漂亮的控制台进度条
命令行工具绕不开的一个功能就是进度条。一个传统的进度条往往苍白无趣,但配合colorama,你可以把进度条打扮得专业又不刺眼:
ini
import time
from colorama import init, Fore, Style
init(autoreset=True)
def colored_progress_bar(percent):
bar_length = 50
filled = int(bar_length * percent)
if percent < 0.3:
bar_color = Fore.RED
elif percent < 0.7:
bar_color = Fore.YELLOW
else:
bar_color = Fore.GREEN
bar = '█' * filled + '-' * (bar_length - filled)
print(f"\r进度:[{bar_color}{bar}{Style.RESET_ALL}] {percent*100:.1f}%", end="", flush=True)
for i in range(101):
colored_progress_bar(i/100)
time.sleep(0.05)
print()
如果制作更复杂的色彩主题,还可以通过Python的类封装来统一管理。
高级整合:Colorama不要单打独斗
有的项目打印内容复杂、组合灵活,想要各种前置方便切换时可能会想:如果每一个print前面都要加Fore.RED、Back.CYAN、Style.BRIGHT这么多代码,好复杂。其实完全可以colorama和termcolor一起工作。先初始化colorama让它保障跨平台转换,再用termcolor.colored()简化色彩定义:
python
from colorama import init
init()
from termcolor import colored
print(colored('出错了!', 'red', 'on_white', attrs=['reverse']))
简简单单。colorama像是一个翻译器,专门负责在Windows系统内消化Windows看不懂的ANSI指令。高级样式包装可以按组合招来,为彩色文本带来动态视觉感。
当颜色真的出不来了:快速排查指南
可能在某个环境下你的代码意外输出了[31m文字,而不是彩色内容。直接排查思路:
- 检查是否调用了init() :
init(autoreset=True)这一行得写在所有打印颜色之前 - 升级colorama :有些环境太旧的话用
pip install --upgrade colorama解决 - 手动检测终端交互的限制 :在某些纯文本重定向场景,颜色代码会被系统扔掉。用
sys.stdout.isatty()检测当前是否终端环境 - 确认不是特殊IDE限制:有的IDE集成了对ANSI支持的设置需要手动开启
- 用直接方法验证兼容性 :试运行非常简单的
print(Fore.RED + "测试" + Style.RESET_ALL),看终端支不支持 - 跨平台注意:某些Windows的PowerShell 5.1等旧版本需要用户手动启用ANSI支持
- 换兼容的现代终端 :如果是Windows建议使用
Windows Terminal、Visual Studio Code的内建终端,它们对ANSI原生支持的认可度极高。
代码入库的适用场合
colorama就像你的老朋友一样小巧玲珑。推荐它用在简单脚本里、监控日志明显标记时,任何需要从大量输出里快速提取关键信息的地方都值得用起来。简洁的管理方法,明确的自定义颜色方案,让测试和调试事半功倍。追求更高级效果------例如渲染表格、实时进度条、终端图表------可以尝试rich这种丰富库,但在大部分彩色场景和跨平台润色上,我还是愿意选干干净净的colorama。
本质上colorama的核心理念是:让色彩不干扰你的逻辑,而你的逻辑不再被无色彩的"失败的搜索"淹没在沉默里。给字符串加点颜色是小事,但正是这些小事的积累,让终端上的交互和问题追踪变得直观而优雅。
小张搞明白了以后,跑去跟领导演示新版本的登录测试脚本运行结果。红色的"失败"大老远就能看到,绿色的"成功"如同一串绿灯顺利跑完。领导说了一个字:好。