Git使用nbdime合并Jupyter notebook后出现验证错误如何解决

问题表现 #

在Git环境中使用3.1.1版本nbdime工具合并Jupyter Notebook文件时弹出验证错误，点击'OK'按钮可完成合并操作，但后续每次打开合并后的Notebook文件都会重复弹出该验证错误提示。

已合并出错文件的修复方案 #

• 命令行快速修复：进入出错Notebook所在目录，执行nbformat自带的校验修复命令：

  jupyter nbconvert --to notebook --inplace 你的出错文件名.ipynb
  

  该命令会按照当前环境的标准Jupyter Notebook格式重新序列化文件，自动清除nbdime合并残留的非法字段、未清理完全的冲突标记、不符合schema规范的元数据，执行完成后重开Notebook就不会再弹出验证错误。
• 界面操作快速修复：打开弹出错误的Notebook，直接点击顶部菜单栏File-Save and Checkpoint，Jupyter保存文件时会自动按照标准格式重写内容，保存后关闭重开即可消除弹窗，该方法仅适合临时处理单个文件。

根源避免同类问题的配置方案 #

3.1.1版本nbdime存在已知缺陷，合并输出Notebook时不会自动做格式合规性校验，容易残留非法内容导致重复报错，按以下步骤配置可彻底规避问题：

• 升级nbdime到修复了该格式校验缺陷的版本，终端执行：

  pip install --upgrade nbdime>=3.2.0
  

• 配置Git使用带自动校验的nbdime合并驱动，终端执行：

  nbdime config-git --enable --set-merge-driver validated
  

  配置完成后，后续所有通过Git触发的Notebook合并操作，nbdime在输出合并结果前都会自动完成格式校验与非法内容清理，不会再产出打开就触发验证错误的Notebook文件。

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