如何在Python脚本中正确实现GitLab可折叠区块？含嵌套可行性疑问

问题背景 #

按照GitLab官方文档示例编写的可折叠section上下文管理器，实际使用时出现异常：两个section之间的普通输出（如print("After first section")）被错误折叠进前一个区块。用户曾通过添加虚拟临时区块的方式规避问题，但该方案繁琐冗余，需要更简洁的正确实现，同时想确认GitLab是否支持嵌套可折叠区块。

原官方示例代码：

@contextmanager
def gitlab_section(name, header):
    print(f'\033[0Ksection_start:{int(time.time())}:{name}[collapsed=true]\r\033[0K{header}')
    yield
    print(f'\033[0Ksection_end:{int(time.time())}:{name}:\r\033[0K')

异常使用场景：

with gitlab_section('first', 'First'):
    print('first section')

print("After first section")

with gitlab_section('second', 'Second'):
    print('second section')

错误原因分析 #

出现该问题的核心原因有两点：

1. 标准输出缓冲：Python的print默认会缓冲输出，导致section的开始/结束标记和普通输出的顺序混乱，GitLab无法正确识别section边界。
2. 标记输出格式：原示例中section_end的输出未处理换行，后续的普通输出可能被GitLab识别为前一个section的内容。

正确实现方案 #

通过处理输出缓冲、使用唯一section标识符、规范标记输出格式，即可解决该问题，实现简洁可靠的可折叠section：

import time
import sys
from contextlib import contextmanager

@contextmanager
def gitlab_section(name, header, collapsed=True):
    # 刷新前置输出，确保标记顺序正确
    sys.stdout.flush()
    # 生成唯一section ID，避免同名section冲突
    section_id = f"{name}_{int(time.time() * 1000)}"
    # 输出section开始标记，确保header单独成行
    print(f'\033[0Ksection_start:{int(time.time())}:{section_id}[collapsed={"true" if collapsed else "false"}]\r\033[0K{header}')
    sys.stdout.flush()
    try:
        yield
    finally:
        # 刷新section内的所有输出
        sys.stdout.flush()
        # 输出section结束标记
        print(f'\033[0Ksection_end:{int(time.time())}:{section_id}\r\033[0K')
        sys.stdout.flush()
        # 添加换行分隔，避免后续输出被误识别
        print()

使用示例 #

with gitlab_section('first', 'First Section'):
    print('第一区块内容行1')
    print('第一区块内容行2')

print("这行内容不会被折叠，属于全局日志")

with gitlab_section('second', 'Second Section', collapsed=False):
    print('第二区块默认展开')

嵌套可折叠区块支持 #

GitLab CI完全支持嵌套可折叠区块，只需在已开启的section内部再次调用gitlab_section即可，示例如下：

with gitlab_section('parent', '父级区块'):
    print('父级区块内容')
    with gitlab_section('child', '子级区块'):
        print('嵌套在父级内的子区块内容')
    print('回到父级区块的内容')

在GitLab的job日志中，父级区块折叠时会隐藏所有子区块，展开后子区块可独立折叠/展开。

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