GitPython拉取中文命名分支出现GBK编码错误的技术咨询

问题背景 #

Python版本：3.11.3
使用GitPython编写的代码：

os.environ["PYTHONIOENCODING"] = "utf-8"
os.environ["PYTHONUTF8"] = "on"

repo = Repo(repo_path)
remote = repo.remote()
remote.fetch()

当仓库存在名为“测试分支”的中文分支时，抛出错误：

git.exc.CommandError: Cmd('<stderr-pump>') failed due to: UnicodeDecodeError('gbk' codec can't decode byte 0xad in position 54: illegal multibyte sequence')

已设置PYTHONUTF8=1和PYTHONIOENCODING='utf-8'但无效，咨询以下问题：

1. fetch方法是否支持encoding='utf-8'这类参数？
2. 如何使用UTF-8编码执行fetch操作？
3. 为何会自动选择GBK编码？

解答 #

1. fetch方法是否支持encoding='utf-8'这类参数？ #

GitPython的fetch方法不直接支持encoding参数，它底层调用的是Git命令行工具，编码问题需要通过配置Git环境或调整GitPython的命令执行编码逻辑解决，无法直接给fetch方法传递编码参数。

2. 如何使用UTF-8编码执行fetch操作？ #

有两种可行的解决方式：

• 配置Git全局/仓库编码为UTF-8：
  可以先通过命令行设置Git编码，也可以在Python代码中直接修改仓库配置：

  # 修改当前仓库的编码配置
  config_writer = repo.config_writer()
  config_writer.set_value("core", "quotepath", "false").release()
  config_writer.set_value("i18n", "commitencoding", "utf-8").release()
  config_writer.set_value("i18n", "logoutputencoding", "utf-8").release()
  

  也可以通过命令行全局设置：

  git config --global core.quotepath false
  git config --global i18n.commitencoding utf-8
  git config --global i18n.logoutputencoding utf-8
  

• 手动构造fetch命令并指定编码：
  绕过GitPython的fetch封装，直接调用Git命令并指定解码编码：

  from git import Git
  git = Git(repo_path)
  git.execute(["git", "fetch"], universal_newlines=True, encoding="utf-8")
  

3. 为何会自动选择GBK编码？ #

这是因为你的操作系统默认编码为GBK（比如中文Windows系统），Git会继承系统默认编码来输出内容；而GitPython在未明确指定编码时，会使用系统默认编码去解码Git命令的输出，因此触发了GBK解码错误。另外，PYTHONIOENCODING和PYTHONUTF8仅影响Python自身的IO编码，对Git命令行工具的输出编码规则没有直接影响，Git的编码配置是独立的。

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