xlsxwriter设置表头行格式未生效 格式错误应用到空单元格

问题描述 #

需要为xlsx文件内的所有工作表设置表头行格式，为表头添加指定背景色。但实际为目标行添加格式时，格式并未应用到存储实际数据的列，反而被应用到了其余所有空列。

已使用的代码 #

for sheet_name in xlwriter.sheets:
    ws = xlwriter.sheets[sheet_name]
    ws.freeze_panes(1, 0) # 冻结首行
    
    cell_format = workbook.add_format({'bg_color': 'yellow'})
    cell_format.set_bold()
    cell_format.set_font_color('red')
    cell_format.set_border(1)
    ws.set_row(0, cell_format = cell_format)

备注：已尝试过平台推荐的其他同类问题解决方案，均未生效。

问题原因 #

该现象由XlsxWriter的格式优先级规则导致：

• set_row()设置的是行级默认格式，仅对没有单独配置过单元格格式的位置生效
• 写入表头数据时（尤其是通过pandas等第三方库导出表格的场景），存在实际数据的表头单元格会被写入操作自动附加默认单元格格式，单元格格式优先级高于行级格式，因此不会套用自定义的表头样式
• 无数据的空列单元格没有单独配置格式，会直接继承行级默认格式，最终出现空列带格式、实际数据列表头无格式的异常效果
• 额外注意：上述代码在循环内重复创建相同的格式对象，会造成不必要的文件体积增加，还可能触发格式兼容问题，格式对象建议在工作簿层级统一创建一次。

解决方案 #

放弃用set_row()给整行套默认格式的思路，直接给有实际数据的表头单元格单独绑定格式即可，参考实现如下：

# 工作簿层级统一创建表头格式，不要在工作表循环内重复创建
header_format = workbook.add_format()
header_format.set_bg_color('yellow')
header_format.set_bold()
header_format.set_font_color('red')
header_format.set_border(1)

for sheet_name in xlwriter.sheets:
    ws = xlwriter.sheets[sheet_name]
    ws.freeze_panes(1, 0) # 冻结首行
    
    # 替换为当前工作表的实际数据列数，pandas场景下可直接通过df.shape[1]获取
    data_col_count = 当前表实际数据列数
    # 遍历所有实际存在数据的列，给对应表头单元格设置格式
    for col_idx in range(data_col_count):
        # 读取原有表头文本，避免重写时丢失内容，pandas场景可直接取df.columns[col_idx]
        header_val = ws.cell(0, col_idx).value
        ws.write(0, col_idx, header_val, header_format)

如果是配合pandas导出表格的场景，也可以直接在df.to_excel()方法中传入表头格式参数，从写入阶段就直接应用样式，从根源避免后续格式覆盖问题。

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