VS Code 中的 Jupyter Notebooks

Jupyter（前身为 IPython Notebook）是一个开源项目，可让您轻松地将 Markdown 文本和可执行的 Python 源代码组合在一个称为 notebook (笔记本) 的画布上。Visual Studio Code 支持原生使用 Jupyter Notebooks，以及通过 Python 代码文件 使用。本主题介绍 Jupyter Notebooks 的原生支持，并演示如何：

• 创建、打开和保存 Jupyter Notebooks
• 使用 Jupyter 代码单元格
• 使用变量资源管理器和数据查看器查看、检查和筛选变量
• 连接到远程 Jupyter 服务器
• 调试 Jupyter Notebook

设置您的环境

要在 Jupyter Notebooks 中使用 Python，您必须在 VS Code 中激活一个 Anaconda 环境，或者在您已安装 Jupyter 包 的其他 Python 环境中。要选择一个环境，请使用命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中的 Python: Select Interpreter 命令。

激活适当的环境后，您可以创建和打开 Jupyter Notebook，连接到远程 Jupyter 服务器以运行代码单元格，以及将 Jupyter Notebook 导出为 Python 文件。

工作区信任

开始使用 Jupyter Notebooks 时，您需要确保在受信任的工作区中工作。有害代码可以嵌入到笔记本中，工作区信任功能允许您指定哪些文件夹及其内容应允许或限制自动代码执行。

如果您尝试在 VS Code 处于不受信任的工作区并运行受限模式时打开笔记本，您将无法执行单元格，并且富文本输出将被隐藏。

创建或打开 Jupyter Notebook

您可以通过从命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 运行 Create: New Jupyter Notebook 命令，或在工作区中创建一个新的 .ipynb 文件来创建 Jupyter Notebook。

接下来，使用右上角的内核选择器选择一个内核。

选择内核后，位于每个代码单元格右下角的语言选择器将自动更新为内核支持的语言。

如果您有一个现有的 Jupyter Notebook，您可以通过右键单击文件并选择用 VS Code 打开，或者通过 VS Code 文件资源管理器来打开它。

运行单元格

运行单个代码单元格

添加代码后，您可以使用单元格左侧的运行图标来运行一个单元格，输出将显示在代码单元格下方。

要运行选定的代码单元格，您还可以在命令模式和编辑模式下使用键盘快捷键。Ctrl+Enter 运行当前选定的单元格。Shift+Enter 运行当前选定的单元格并在其下方立即插入一个新单元格（焦点移动到新单元格）。Alt+Enter 运行当前选定的单元格并在其下方立即插入一个新单元格（焦点保留在当前单元格）。

运行多个代码单元格

运行多个代码单元格可以通过多种方式完成。您可以使用 Notebook 编辑器主工具栏中的双箭头来运行 Notebook 中的所有单元格，或者通过选择当前代码单元格上方或下方的全部运行、运行上方所有单元格或运行下方所有单元格。

运行节中的单元格

为了更轻松地运行笔记本中的相关单元格，您可以使用运行节中的单元格操作来运行由 Markdown 节标题分组的单元格。此操作在笔记本大纲视图和粘性滚动元素中可用。

在粘性滚动元素中，右键单击您选择的标题，并通过上下文菜单中的操作运行该节。在大纲视图中，选择悬停或选中时出现的工具栏图标，然后通过显示的操作运行单个单元格或一组单元格。

保存您的 Jupyter Notebook

您可以使用键盘快捷键 Ctrl+S 或文件 > 保存来保存您的 Jupyter Notebook。

导出您的 Jupyter Notebook

您可以将 Jupyter Notebook 导出为 Python 文件 (.py)、PDF 或 HTML 文件。要导出，请在主工具栏上选择 ... > 导出。然后您将看到一个文件格式选项的下拉列表。

注意：对于 PDF 导出，您必须安装 TeX。如果您没有安装，当您选择 PDF 选项时，系统会通知您需要安装它。另外，请注意，如果您的 Notebook 中只有 SVG 输出，它们将不会显示在 PDF 中。要在 PDF 中显示 SVG 图形，请确保您的输出包含非 SVG 图像格式，或者您可以先导出为 HTML，然后使用浏览器另存为 PDF。

在 Notebook 编辑器中处理代码单元格

Notebook 编辑器使您可以轻松地在 Jupyter Notebook 中创建、编辑和运行代码单元格。

创建代码单元格

默认情况下，一个空白笔记本会有一个空的代码单元格供您开始使用，而一个现有的笔记本会在底部放置一个。将您的代码添加到空的代码单元格中即可开始。

msg = "Hello world"
print(msg)

代码单元格模式

在处理代码单元格时，一个单元格可以处于三种状态：未选中、命令模式和编辑模式。代码单元格左侧的垂直条和编辑器边框显示了单元格的当前状态。当没有条可见时，单元格是未选中的。当一个单元格被选中时，它可以处于命令模式或编辑模式。

在命令模式下，单元格左侧会出现一个实心垂直条。该单元格可以被操作并接受键盘命令。

在编辑模式下，一个实心垂直条旁边会有一个围绕单元格编辑器的边框。可以修改单元格的内容（代码或 Markdown）。

要切换模式，您可以使用键盘或鼠标。在键盘上，按 Enter 键进入编辑模式，或按 Esc 键进入命令模式。用鼠标，单击单元格左侧的垂直条或代码单元格中代码/Markdown 区域之外的地方。

添加额外的代码单元格

您可以使用主工具栏、单元格的添加单元格工具栏（悬停时可见）以及通过键盘命令添加代码单元格。

要在当前选定的单元格下方添加一个新单元格，请使用主工具栏或单元格悬停工具栏中的加号图标。

当代码单元格处于命令模式时，使用 A 键在所选单元格上方添加一个单元格，使用 B 键在所选单元格下方添加一个单元格。

选择代码单元格

您可以使用鼠标或键盘上的上/下箭头键更改选定的代码单元格。当代码单元格处于命令模式时，您也可以使用 J 键（向下）和 K 键（向上）。

选择多个代码单元格

要选择多个单元格，请从一个处于选中模式的单元格开始。填充的背景表示选定的单元格。要选择连续的单元格，请按住 Shift 键并单击您要选择的最后一个单元格。要选择任意一组单元格，请按住 Ctrl 键并单击您想要添加到选择中的单元格。

移动代码单元格

您可以通过拖放来在笔记本中上下移动单元格。对于代码单元格，拖放区域位于单元格编辑器左侧，如下所示。对于已渲染的 Markdown 单元格，您可以单击任何位置来拖放单元格。

要移动多个单元格，您可以在选择中包含的任何单元格中使用相同的拖放区域。

键盘快捷键 Alt+Arrow 也可以移动一个或多个选定的单元格。

删除代码单元格

要删除代码，您可以使用代码单元格工具栏中的删除图标。当选定的代码单元格处于命令模式时，您可以使用键盘快捷键 dd。

撤销您的上一次更改

您可以使用 z 键撤销您的上一次更改，例如，如果您进行了意外的编辑，可以将其撤销到之前的正确状态，或者如果您意外删除了一个单元格，可以恢复它。

在代码和 Markdown 之间切换

Notebook 编辑器允许您轻松地在 Markdown 和代码之间更改代码单元格。选择单元格右下角的语言选择器将允许您在 Markdown 和（如果适用）所选内核支持的任何其他语言之间切换。

您还可以使用键盘更改单元格类型。当单元格被选中并处于命令模式时，M 键将单元格类型切换为 Markdown，Y 键将单元格类型切换为代码。

设置 Markdown 后，您可以向代码单元格输入 Markdown 格式的内容。

要渲染 Markdown 单元格，您可以选择单元格工具栏中的复选标记，或使用键盘快捷键 Ctrl+Enter 和 Shift+Enter。

清除输出或重启/中断内核

如果您想清除所有代码单元格的输出或重启/中断内核，您可以使用主 Notebook 编辑器工具栏来完成。

启用/禁用行号

当您处于命令模式时，可以使用 L 键在单个代码单元格中启用或禁用行号。

要为整个笔记本切换行号，请在任何单元格上处于命令模式时使用 Shift+L。

目录

要浏览您的笔记本，请打开活动栏中的文件资源管理器。然后在侧边栏中打开大纲选项卡。

您可以使用大纲视图中的筛选控件来包含 Markdown 标题、代码单元格和代码单元格符号。筛选器对应于以下设置：

• notebook.outline.showMarkdownHeadersOnly
• notebook.outline.showCodeCells
• notebook.outline.showCodeCellSymbols

注意：默认情况下，大纲只会显示 Markdown。要显示代码单元格，请启用以下设置：Notebook > Outline: Show Code Cells。

Jupyter Notebook 编辑器中的 IntelliSense 支持

Python Jupyter Notebook 编辑器窗口具有完整的 IntelliSense – 代码补全、成员列表、方法的快速信息和参数提示。您在 Notebook 编辑器窗口中输入代码的效率可以和在代码编辑器中一样高。

变量资源管理器和数据查看器

在 Python Notebook 中，可以查看、检查、排序和筛选当前 Jupyter 会话中的变量。在运行代码和单元格后，选择主工具栏中的变量图标，您将看到当前变量的列表，该列表会在代码中使用变量时自动更新。变量窗格将在笔记本底部打开。

数据查看器

要获取有关变量的更多信息，您也可以双击一行或使用变量旁边的在数据查看器中显示变量按钮，在数据查看器中更详细地查看变量。

或者，您可以使用其他扩展（如 Data Wrangler）提供的数据查看体验。Data Wrangler 扩展提供了一个丰富的用户界面来显示有关数据的见解，并帮助您执行数据分析、质量检查、转换等操作。在我们的文档中了解有关 Data Wrangler 扩展的更多信息。

筛选行

可以通过在每列顶部的文本框中键入来筛选数据查看器中的行。键入您要搜索的字符串，将找到该列中包含该字符串的任何行。

如果您想查找完全匹配，请在您的筛选器前加上“=”

可以通过键入正则表达式来进行更复杂的筛选。

保存绘图

要从您的笔记本中保存绘图，只需将鼠标悬停在输出上，然后选择右上角的保存图标。

注意：支持渲染使用 matplotlib 和 Altair 创建的绘图。

自定义笔记本差异比较

在底层，Jupyter Notebooks 是 JSON 文件。JSON 文件中的片段被渲染为由三个组件组成的单元格：输入、输出和元数据。使用基于行的差异比较来比较在笔记本中所做的更改是困难且难以解析的。笔记本的富文本差异比较编辑器使您可以轻松地查看单元格每个组件的更改。

您甚至可以自定义您希望在差异比较视图中显示的更改类型。在右上角，选择工具栏中的溢出菜单项，以自定义您希望包含的单元格组件。输入差异将始终显示。

要了解有关 VS Code 中 Git 集成的更多信息，请访问VS Code 中的源代码管理。

调试 Jupyter Notebook

有两种不同的方式来调试 Jupyter notebook：一种是称为“逐行运行”的更简单的模式，另一种是完整的调试模式。

注意：这两个功能都需要 ipykernel 6+。有关安装或升级 ipykernel 的详细信息，请参阅此维基页面。

逐行运行

逐行运行可让您一次执行一个单元格的一行，而不会被其他 VS Code 调试功能分心。要开始，请选择单元格工具栏中的逐行运行按钮。

使用相同的按钮向前执行一条语句。您可以选择单元格的停止按钮提前停止，或工具栏中的继续按钮继续运行到单元格末尾。

调试单元格

如果您想使用 VS Code 支持的全套调试功能，例如断点和单步进入其他单元格和模块的能力，您可以使用完整的 VS Code 调试器。

1. 首先，通过单击笔记本单元格的左边距来设置您需要的任何断点。
2. 然后选择运行按钮旁边菜单中的调试单元格按钮。这将在调试会话中运行该单元格，并将在任何运行的代码中的断点处暂停，即使它在不同的单元格或 .py 文件中。
3. 您可以像在 VS Code 中通常那样使用调试视图、调试控制台和调试工具栏中的所有按钮。

请注意，在 jupyter notebook 中调试单元格不使用 launch.json 中的任何调试配置。它可以通过诸如 jupyter.debugJustMyCode 之类的设置进行自定义。

在笔记本中搜索

您可以使用键盘快捷键 Ctrl/Cmd + F 在笔记本中搜索（或通过筛选搜索选项搜索其部分内容）。单击筛选选项（漏斗图标）以在以下内容中搜索：

• Markdown 单元格输入 (Markdown Source)
• Markdown 单元格输出 (Rendered Markdown)
• 代码单元格输入 (Code Cell Source)
• 代码单元格输出 (Cell Output)

默认情况下，笔记本搜索仅筛选单元格输入。

连接到远程 Jupyter 服务器

通过连接到远程 Jupyter 服务器，您可以将 Jupyter Notebook 中的密集计算卸载到其他计算机上。连接后，代码单元格在远程服务器上运行，而不是在本地计算机上运行。

连接到远程 Jupyter 服务器：

1. 打开笔记本右上角的内核选择器按钮（或从命令面板运行 Notebook: Select Notebook Kernel 命令）。

   

2. 选择 Existing Jupyter Server 选项以连接到现有的 Jupyter 服务器。

   

3. 要首次连接到现有服务器，请选择 Enter the URL of the running Jupyter server。

   

4. 当提示 Enter the URL of the running Jupyter server 时，提供服务器的 URI（主机名），并包含带有 ?token= URL 参数的身份验证令牌。（如果您在启用了身份验证令牌的 VS Code 终端中启动服务器，带有令牌的 URL 通常会出现在终端输出中，您可以从中复制。）或者，您可以在提供 URI 后指定用户名和密码。

   

注意：为了增加安全性，Microsoft 建议使用 SSL 和令牌支持等安全预防措施配置您的 Jupyter 服务器。这有助于确保发送到 Jupyter 服务器的请求得到身份验证，并且与远程服务器的连接是加密的。有关保护笔记本服务器的指导，请参阅 Jupyter 文档。

数据科学配置文件模板

配置文件可让您根据当前项目或任务快速切换扩展、设置和 UI 布局。为了帮助您开始使用 Jupyter Notebooks，您可以使用数据科学配置文件模板，这是一个包含有用扩展、设置和代码片段的精选配置文件。您可以按原样使用配置文件模板，也可以将其用作起点，为自己的工作流程进行进一步自定义。

您通过“**配置文件**”>“**创建配置文件...**”下拉菜单选择一个配置文件模板

选择配置文件模板后，您可以查看设置和扩展，如果您不想在新配置文件中包含它们，可以删除单个项目。根据模板创建新配置文件后，对设置、扩展或 UI 的更改将持久保存在您的配置文件中。