如何使用Python Rich API实现Jenkins控制台彩色美化输出

核心原因 #

Rich默认会自动检测当前运行环境的输出通道是否为交互式TTY终端，Jenkins构建过程的标准输出属于非交互式管道，Rich会自动关闭彩色ANSI码输出、仅保留基础文本格式，这也是安装AnsiColor插件后仍看不到彩色效果的核心原因——插件本身工作正常，但Rich根本没有输出带颜色的控制字符。

配置步骤 #

• Jenkins侧AnsiColor插件配置
  确认插件安装完成后，打开对应任务的配置页面：
  • 自由风格任务：在「构建环境」栏勾选Color ANSI Console Output，终端类型下拉选择xterm-256color，不要使用默认的xterm选项，避免24位真彩色、粗体等样式兼容问题。
  • Pipeline任务：在执行Python脚本的步骤外层包裹ANSI颜色配置块即可，示例：

    ansiColor('xterm-256color') {
        sh 'python your_rich_script.py'
    }
    

• 强制Rich绕过TTY检测输出ANSI格式
  三种实现方式任选其一即可，优先选无代码侵入的环境变量方案：
  1. 环境变量配置（无代码侵入）：在构建执行Python脚本前注入环境变量，FORCE_COLOR=1可强制开启基础彩色支持，需要真彩色效果额外添加TERM=xterm-256color COLORTERM=truecolor。
  2. 代码级Console初始化配置：初始化Rich控制台对象时手动指定参数，跳过自动检测：

     from rich.console import Console
     console = Console(
         force_terminal=True,
         color_system="truecolor" # 按需可替换为"256"适配更低版本终端
     )
     console.print("[bold green]Rich 彩色输出测试[/bold green]")
     

  3. 全局配置适配：如果脚本中多处使用Rich能力，可在入口处统一配置，无需修改所有Console初始化逻辑：

     from rich import reconfigure
     reconfigure(force_terminal=True, color_system="truecolor")
     

• 常见异常排查
  • 不要使用nohup启动Python进程、也不要先把输出重定向到日志文件再读取打印，这类操作会过滤或转义ANSI控制码，直接让Python进程的标准输出对接Jenkins构建流即可。
  • 如果是Docker容器内执行构建，启动容器时不要加-t参数分配伪终端，容易触发Rich的检测逻辑误判，配合前面提到的环境变量即可正常输出。
  • 配置后可先在构建步骤执行echo -e "\033[35mANSI彩色测试\033[0m"验证插件状态：如果输出为紫色文本，说明Jenkins侧配置正常，问题出在Rich的参数配置；如果该测试文本也无颜色，检查AnsiColor插件是否绑定了对应构建步骤，升级插件到适配当前Jenkins版本的最新发行版即可。

内容的提问来源于stack exchange，提问作者Andreii21