jupytext-ebp 1.12.0a1

FORK FOR EBP USE ONLY

你是否一直希望Jupyter笔记本是纯文本文档？希望能在你最喜欢的IDE中编辑它们？并在进行版本控制时获得清晰且具有意义的差异？那么... Jupytext可能是你正在寻找的工具！

Jupytext是Jupyter的一个插件，可以将Jupyter笔记本保存为以下格式：

• Markdown文件（或MyST Markdown文件，或R Markdown文档）
• 多种语言的脚本。

用例

Jupytext的常见用例如下：

• 对Jupyter笔记本进行版本控制
• 使用你最喜欢的文本编辑器编辑、合并或重构笔记本
• 对笔记本应用Q&A检查。

安装

你可以使用以下命令安装Jupytext：

• pip install jupytext
• 或 conda install jupytext -c conda-forge。

请注意，Jupytext包括一个Jupyter Lab扩展。在Jupytext的最新版本中，此扩展仅与Jupyter Lab >= 3.0兼容。如果你使用Jupyter Lab 2.x，请继续使用Jupytext 1.8.2，或者在你最新的pip或conda版本的Jupytext之上安装一个与Jupyter Lab 2.x兼容的扩展版本

jupyter labextension install jupyterlab-jupytext@1.2.2  # For Jupyter Lab 2.x

然后，重新启动你的Jupyter服务器（有关安装详情，请参阅文档中的安装部分）。

当安装 Jupytext 后，.py 和 .md 文件将显示笔记本图标。您确实可以像笔记本一样打开和运行这些文件。

在 Jupyter Notebook 中点击文本文件

（点击上面的图片在 上尝试）

在 Jupyter Lab 中右键单击并选择 “使用笔记本打开”

（点击上面的图片在 上尝试）

成对笔记本

使用 Jupytext 的最便捷方式可能是通过 成对笔记本。

要将给定的 .ipynb 或文本笔记本与另一种笔记本格式配对，可以使用以下方法：

Jupyter Lab 中的 “将笔记本与...配对” 命令



Jupyter Notebook 中的 “将笔记本与...配对” 菜单项



命令行中的 jupytext

例如：

jupytext --set-formats ipynb,py:percent notebook.ipynb

请参阅 文档。

或本地或全局的 jupytext.toml 配置文件。

例如，以下内容：

formats = "ipynb,py:percent"

请参阅 文档。

当您在 Jupyter 中保存配对笔记本时，磁盘上的 .ipynb 文件和文本版本都会更新。

当在 Jupyter 中打开或 重新加载 配对笔记本时，输入单元从文本文件加载，并与来自 .ipynb 文件的输出单元组合。

您可以使用您喜欢的编辑器编辑笔记本的文本表示形式，并通过简单地 重新加载 笔记本（在 Jupyter Notebook 中为 Ctrl+R，在 Jupyter Lab 中为 “重新加载笔记本”）在 Jupyter 中获取更改。并且当您 保存 笔记本时，更改会传播到 .ipynb 文件。

或者，您可以在命令行中运行 jupytext --sync notebook.ipynb 以同步两种表示。

哪种文本格式？

Jupytext 实现了许多 Jupyter Notebook 的文本 格式。如果您的笔记本主要是由代码组成的，您可能更喜欢将其保存为脚本

• 使用 百分格式，这是一种具有显式单元分隔符（# %%）的格式，被许多 IDE（Spyder、Hydrogen、VS Code、PyCharm 和 PTVS）支持
• 或者，如果您更喜欢看到更少的单元标记，请使用 轻格式

如果您的笔记本包含比代码更多的文本，如果您正在编写文档或书籍，您可能希望将您的笔记本保存为 Markdown 文档

• 如果您希望将笔记本作为 .md 文件（不包括其输出）在 GitHub 上渲染，请使用 Jupytext Markdown 格式
• 如果您想使用 Sphinx 或 Jupyter Book 渲染您的笔记本，请使用 MyST Markdown 格式，这是一种“实现了 reStructuredText 最佳部分”的 markdown 格式。
• 如果您想在 RStudio 中打开您的 Jupyter Notebook，请使用 R Markdown 格式。

更多资源？

如果您是 Jupytext 的初学者，可以从 常见问题解答 或 教程 开始，或者从对 Jupytext 的简要介绍开始：