Repolode
jupyterlab-contrib

jupyterlab-contrib/jupyterlab_code_formatter

为 JupyterLab 提供代码格式化功能,可调用 black、isort、yapf 等格式化工具整理 Notebook 单元格代码。

Star
907
Fork
71
未关闭 Issue
27
最近提交
3个月前

这是什么?

jupyterlab_code_formatter 是一个 JupyterLab 插件,可以在不离开编辑器的情况下,对 Notebook 单元格和文件运行代码格式化工具。插件通过服务端组件调用外部格式化程序,因此你在 Python 项目中已经使用的格式化工具可以直接在 JupyterLab 中使用。

默认配置下,Python 代码使用 isort 和 black 进行格式化。项目相关标签还包括 autopep8、yapf 和 R 语言格式化支持,并可通过配置选择使用哪种格式化工具以及调用方式。安装时使用 pip 安装本包,再安装所需的格式化工具,然后重启 JupyterLab 即可。

该扩展由 Python 服务端扩展和 npm 前端扩展两部分组成,遇到问题时可以分别检查两部分是否已正确安装并启用。

核心功能

  • 01在 JupyterLab 内直接格式化 Notebook 单元格和代码。
  • 02调用 black、isort 等外部格式化工具,Python 默认使用 isort 与 black。
  • 03支持 autopep8、yapf 以及 R 语言的代码格式化。
  • 04可配置所用的格式化工具及调用参数。
  • 05通过 pip 安装,包含服务端和前端两部分组件。

适用场景

  • 在分享数据科学 Notebook 之前统一代码风格。
  • 在 JupyterLab 中按照 black 或 isort 的规范整理 Python 代码。
  • 在 JupyterLab 会话中格式化 R 代码(需安装对应的格式化工具)。

快速上手

  1. 1

    安装该软件包

    pip install jupyterlab-code-formatter
  2. 2

    安装受支持的格式化工具(Python 默认使用 isort 和 black)

    pip install black isort
  3. 3

    重启 JupyterLab

  4. 4

    配置插件(参见配置文档)

收录于专题

标签

#jupyterlab#python#code-formatter#black#isort#yapf#jupyter-extension#autopep8#jupyterlab-extension#jupyterlab-extensions

常见问题

jupyterlab_code_formatter 是什么?
为 JupyterLab 提供代码格式化功能,可调用 black、isort、yapf 等格式化工具整理 Notebook 单元格代码。 jupyterlab_code_formatter 是一个 JupyterLab 插件,可以在不离开编辑器的情况下,对 Notebook 单元格和文件运行代码格式化工具。插件通过服务端组件调用外部格式化程序,因此你在 Python 项目中已经使用的格式化工具可以直接在 JupyterLab 中使用。
jupyterlab_code_formatter 可以免费使用吗?用的什么许可证?
jupyterlab_code_formatter 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
jupyterlab_code_formatter 还在维护吗?
半年内有更新。jupyterlab_code_formatter 最近一次提交是在 2026年8月7日。
jupyterlab_code_formatter 适合用来做什么?
在分享数据科学 Notebook 之前统一代码风格。 在 JupyterLab 中按照 black 或 isort 的规范整理 Python 代码。 在 JupyterLab 会话中格式化 R 代码(需安装对应的格式化工具)。
jupyterlab_code_formatter 怎么安装和运行?
安装该软件包: pip install jupyterlab-code-formatter 安装受支持的格式化工具(Python 默认使用 isort 和 black): pip install black isort 重启 JupyterLab 配置插件(参见配置文档)
在哪里获取 jupyterlab_code_formatter?
源代码和安装说明在 GitHub 上:https://github.com/jupyterlab-contrib/jupyterlab_code_formatter

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目