在 VSCode 中保存时格式化 Jupyter notebook

Question

每当我在 VSCode 中保存时，我都会使用black自动格式化我所有的 Python 代码。 我想要相同的功能，但在 VSCode 的 Jupyter 笔记本中。

此答案显示如何从右键单击上下文菜单或键盘快捷键右键单击并设置单元格或整个笔记本的格式。 我可以在保存时发生这种情况吗？

看起来有一个与此相关的问题，但它已经超过一年了。

有什么好的解决方法吗？ 也许是一种将格式笔记本选项设置为与保存相同的键绑定的方法？

更新：

如果你喜欢我希望添加此功能，请 go 到问题并投票，开发人员说他们需要大量投票才能考虑。

Answer 1

根据Github还没有计划。

我认为您只能手动格式化。

Answer 2

来自 janosh 对 GitHub 的回复：

有一个设置editor.codeActionsOnSave但它不允许运行任意 shell 命令（出于安全原因？）所以你需要安装像Run On Save这样的扩展并让它调用black path/to/file.ipynb on保存事件。

可悲的是，由于 VS Code 尚未公开笔记本的生命周期事件，因此即使这样现在也不起作用。 要对此表示赞同的问题是：改进工作区 API 以支持（至少）保存事件的笔记本生命周期

如果两者都实现了，您应该能够将其添加到您的设置中以自动格式化 Jupyter 笔记本：

"emeraldwalk.runonsave": {
  "commands": [
    {
      "match": "\\.ipynb$",
      "cmd": "black ${file}"
    }
  ]
}

Answer 3

一个足够简单的解决方案是按照您的建议将格式笔记本选项设置为与保存相同的键绑定。 以下是如何使用 VSCode 任务执行此操作：

tasks.json（在命令面板“任务：打开用户任务”中）：

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "cmd:save",
            "command": "${command:workbench.action.files.save}"
        },
        {
            "label": "cmd:format-notebook",
            "command": "${command:notebook.format}"
        },
        {
            "label": "cmd:format-notebook+save",
            "dependsOrder": "sequence",
            "dependsOn": [
                "cmd:format-notebook",
                "cmd:save"
            ]
        }
    ]
}

keybindings.json（在命令面板“首选项：打开键盘快捷方式（JSON）”中）：

[
    {
        "key": "ctrl+s",
        "command": "workbench.action.tasks.runTask",
        "args": "cmd:format-notebook+save"
    }
]