Pandas使用ExcelWriter时if_sheet_exists='replace'参数不生效问题

问题原因 #

你遇到的问题是if_sheet_exists参数的版本兼容性问题：该参数是pandas 1.4.0版本新增的特性，若你使用的pandas版本低于1.4.0，该参数会被直接忽略，追加模式（mode='a'）下就会默认生成带数字后缀的新工作表，不会覆盖原有同名工作表。同时需确保依赖的openpyxl引擎版本不低于3.0.0，避免出现引擎兼容异常。

解决方案 #

方案1：升级依赖版本（推荐） #

首先升级pandas和openpyxl到符合要求的版本：

pip install --upgrade pandas>=1.4.0 openpyxl>=3.0.0

升级完成后你原来的代码即可正常生效，补全导入语句后的完整代码如下：

import os
import pandas as pd

def save_excel_sheet(df, filepath, sheetname, index=False):
    # 文件不存在则直接创建
    if not os.path.exists(filepath):
        df.to_excel(filepath, sheet_name=sheetname, index=index)
    # 文件存在则覆盖指定工作表，保留其余工作表
    else:
        with pd.ExcelWriter(filepath, engine='openpyxl', if_sheet_exists='replace', mode='a') as writer:
            df.to_excel(writer, sheet_name=sheetname, index=index)

方案2：低版本兼容实现 #

如果无法升级pandas版本，可以手动读取原有工作簿，先删除目标同名工作表（如果存在），再写入新的工作表，逻辑如下：

import os
import pandas as pd
from openpyxl import load_workbook

def save_excel_sheet(df, filepath, sheetname, index=False):
    if not os.path.exists(filepath):
        df.to_excel(filepath, sheet_name=sheetname, index=index)
    else:
        # 读取原有工作簿
        book = load_workbook(filepath)
        # 如果存在同名工作表则先删除
        if sheetname in book.sheetnames:
            del book[sheetname]
        # 写入新的工作表
        with pd.ExcelWriter(filepath, engine='openpyxl') as writer:
            writer.book = book
            writer.sheets = {ws.title: ws for ws in book.worksheets}
            df.to_excel(writer, sheet_name=sheetname, index=index)

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