Jupyterlab Code Formatter 能够在 notebook 中对代码进行格式化,安装成功后,只需要点击代码格式化按钮。那么如何像在 pycharm 中一样使用快捷键对代码进行格式化呢,本篇记录一下。

安装格式化包

  1. 安装插件

    1
    pip install jupyterlab_code_formatter
  2. 安装格式化支持

    1
    pip install black isort
  3. 重启 Jupyterlab

设置快捷键

打开 Jupyterlab,点击 settings -> Advanced Settings Editor -> Keyboard Shortcuts

在 User Preferences 中输入(下面是针对单个单元格进行格式化)

1
2
3
4
5
6
7
8
9
"shortcuts": [
{
"command": "jupyterlab_code_formatter:black",
"keys": [
"Ctrl Alt L"
],
"selector": ".jp-Notebook.jp-mod-editMode"
}
]

我这里设置的快捷键是 Ctrl Alt L

如果想要针对整个 notebook 进行代码格式化,可以如下:

1
2
3
4
5
6
7
8
9
"shortcuts": [
{
"command": "jupyterlab_code_formatter:format_all",
"keys": [
"Ctrl Alt L"
],
"selector": ".jp-Notebook.jp-mod-editMode"
}
]

其他快捷键设置

比如,我想设置重启并允许所有单元格,方法如下:

打开 Keyboard Shortcuts 后搜索 restart,可定位到 runmenu:restart-and-run-all,把代码拷贝到右侧。设置快捷键,如我设置为 “Ctrl Alt R”

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"shortcuts": [
{
"command": "jupyterlab_code_formatter:format_all",
"keys": [
"Ctrl Alt L"
],
"selector": ".jp-Notebook.jp-mod-editMode"
},
{
"command": "runmenu:restart-and-run-all",
"keys": [
"Ctrl Alt R"
],
"selector": "[data-jp-code-runner]"
},
]
}

保存后,退出。即可使用快捷键。

参考链接

  1. jupyterlab-code-formatter Prerequisites and Installation Steps