Python 交互式窗口

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

• 使用类似 Jupyter 的代码单元格
• 在 Python 交互式窗口中运行代码
• 使用变量浏览器和数据查看器查看、检查和筛选变量
• 连接到远程 Jupyter 服务器
• 调试 Jupyter Notebook
• 导出 Jupyter Notebook

要使用 Jupyter Notebook，您必须在 VS Code 中激活 Anaconda 环境，或者安装了 Jupyter 包 的其他 Python 环境。要选择环境，请使用命令面板中的“Python: Select Interpreter”命令 (⇧⌘P（Windows、Linux Ctrl+Shift+P）)。

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

Jupyter 代码单元格

您可以使用 # %% 注释在 Python 代码中定义类似 Jupyter 的代码单元格

# %%
msg = "Hello World"
print(msg)

# %%
msg = "Hello again"
print(msg)

注意：请确保将上面显示的代码保存在扩展名为 .py 的文件中。

当 Python 扩展检测到代码单元格时，它会添加“运行单元格”和“调试单元格”CodeLens 修饰。第一个单元格还包括“运行下方”，所有后续单元格都包括“运行上方”。

注意：默认情况下，“调试单元格”仅步入用户代码。如果您想步入非用户代码，需要在 Jupyter 扩展设置中取消选中“仅调试我的代码” (⌘,（Windows、Linux Ctrl+,）)。

“运行单元格”仅应用于一个代码单元格。“运行下方”出现在第一个单元格上，运行文件中的所有代码。“运行上方”应用于所有代码单元格，直到（但不包括）带有修饰的单元格。例如，您可以使用“运行上方”在运行特定单元格之前初始化运行时环境的状态。

选择命令会启动 Jupyter（如果需要，可能需要一分钟），然后会在 Python 交互式窗口 中运行相应的单元格。

您也可以使用 (Ctrl+Enter) 或“Python: Run Selection/Line in Python Terminal”命令 (Shift+Enter) 运行代码单元格。使用此命令后，Python 扩展会自动将光标移到下一个单元格。如果您在文件中的最后一个单元格，扩展会自动插入另一个 # %% 分隔符来创建新单元格，这模仿了 Jupyter Notebook 的行为。

您也可以单击行号左侧的边距来设置断点。然后，您可以使用“调试单元格”为该代码单元格启动调试会话。调试器会在断点处停止执行，并允许您逐行单步调试代码并检查变量（有关详细信息，请参阅调试）。

其他命令和键盘快捷方式

下表列出了使用代码单元格时支持的其他命令和键盘快捷方式。

使用 Python 交互式窗口

前面提到的 Python 交互式窗口 可以作为独立控制台使用，运行任意代码（带或不带代码单元格）。要将窗口用作控制台，请使用命令面板中的“Jupyter: Create Interactive Window”命令打开它。然后您可以在其中键入代码，使用 Enter 换行，使用 Shift+Enter 运行代码。

要将窗口与文件一起使用，请使用命令面板中的“Jupyter: Run Current File in Python Interactive Window”命令。

IntelliSense

Python 交互式窗口具有完整的 IntelliSense 功能 - 代码补全、成员列表、方法的快速信息和参数提示。在 Python 交互式窗口中键入代码与在代码编辑器中一样高效。

绘图查看器

绘图查看器让您可以更深入地处理绘图。在查看器中，您可以平移、缩放和导航当前会话中的绘图。您还可以将绘图导出为 PDF、SVG 和 PNG 格式。

在 Python 交互式窗口中，双击任意绘图即可在查看器中打开它，或选择绘图左上角的展开按钮。

注意：Python 交互式窗口支持渲染使用 matplotlib 和 Altair 创建的绘图。

变量浏览器和数据查看器

在 Python 交互式窗口中，可以查看、检查和筛选当前 Jupyter 会话中的变量。运行代码和单元格后，选择交互式窗口工具栏中的“变量”按钮以打开变量浏览器，您将看到当前变量列表，这些变量会随着代码中使用而自动更新。

有关变量的其他信息，您还可以双击行或使用“在数据查看器中显示变量”按钮在数据查看器中查看变量的更详细视图。打开后，您可以通过搜索行来筛选值。

连接到远程 Jupyter 服务器

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

连接到远程 Jupyter 服务器

1. 从命令面板运行“Jupyter: Specify local or remote Jupyter server for connections”命令 (⇧⌘P（Windows、Linux Ctrl+Shift+P）)。

2. 选择您想要如何连接到 Jupyter 服务器。

3. 如果是远程工作，在提示时提供服务器的 URI（主机名），并在 URL 参数中包含 ?token= 认证令牌。（如果您在启用了认证令牌的 VS Code 终端中启动服务器，带有令牌的 URL 通常会出现在终端输出中，您可以从中复制它。）或者，您可以在提供 URI 后指定用户名和密码。

   

4. Python 交互式窗口通过显示 URI（在下面的图片中模糊处理）来指示代码在哪里运行

   

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

将 Jupyter Notebook 转换为 Python 代码文件

当您激活了安装有 Jupyter 的环境后，您可以在 VS Code 中打开 Jupyter Notebook 文件（.ipynb），然后将其转换为 Python 代码。转换文件后，您可以像运行任何其他 Python 文件一样运行代码，并且可以使用 VS Code 调试器。在 VS Code 中打开和调试 Notebook 是一种查找和解决代码错误的便捷方法，而直接在 Jupyter Notebook 中这样做是很困难的。

打开 Notebook 文件时，Visual Studio Code 会自动在 Notebook 编辑器中打开它。使用工具栏上的转换图标将 Notebook (.ipynb) 文件转换为 Python 文件 (.py)。

选择转换图标，然后选择“Python Script”，等待几秒钟，然后 VS Code 会在无标题文件中打开转换后的 Notebook。Notebook 中的单元格在 Python 文件中用 # %% 注释分隔；Markdown 单元格完全转换为以 # %% [markdown] 开头的注释，并在交互式窗口中与代码和输出（如图表）一起渲染为 HTML。

注意：首次在 Python 文件中运行代码单元格时，Python 扩展会启动 Jupyter 服务器。服务器启动和 Python 交互式窗口 显示代码结果可能需要一些时间。

调试 Jupyter Notebook

Visual Studio Code 调试器允许您逐行执行代码、设置断点、检查状态和分析问题。使用调试器是查找和纠正 Notebook 代码中问题的有用方法。

1. 在 VS Code 中，激活已安装 Jupyter 的 Python 环境，如本文开头所述。

2. 将 Notebook 的 .ipynb 文件导入 VS Code，如上一节所述。（如果您使用的是基于云的 Jupyter 环境，例如 Azure Notebooks，请先下载文件。）

3. 要启动调试器，请使用以下选项之一

   • 对于整个 Notebook，打开命令面板 (⇧⌘P（Windows、Linux Ctrl+Shift+P）) 并运行“Jupyter: Debug Current File in Python Interactive Window”命令。
   • 对于单个单元格，使用出现在单元格上方的“调试单元格”修饰。调试器专门针对该单元格中的代码启动。默认情况下，“调试单元格”仅步入用户代码。如果您想步入非用户代码，需要在 Jupyter 扩展设置中取消选中“仅调试我的代码” (⌘,（Windows、Linux Ctrl+,）)。

4. 要熟悉 VS Code 的通用调试功能，例如检查变量、设置断点和其他活动，请查阅VS Code 调试。

5. 找到问题后，停止调试器，更正代码，保存文件，然后再次启动调试器。

6. 当您确定所有代码都正确无误后。保存文件，然后按下一节所述导出 Notebook。然后您可以将 Notebook 上传到您的常规 Jupyter 环境。

导出 Jupyter Notebook

除了打开 Jupyter Notebook 外，您还可以使用命令面板 (⇧⌘P（Windows、Linux Ctrl+Shift+P）) 中的以下命令之一，将 VS Code 中的 Python 文件内容导出到 Jupyter Notebook（扩展名为 .ipynb）。

• “Jupyter: Export Current Python File as Jupyter Notebook”：使用 # %% 和 # %% [markdown] 分隔符创建包含当前文件内容的 Jupyter Notebook，以指定各自的单元格类型。
• “Jupyter: Export Current Python File and Output as Jupyter Notebook”：创建包含当前文件内容的 Jupyter Notebook，并包含代码单元格的输出。
• “Jupyter: Export Interactive Window as Jupyter Notebook”：创建包含 Python 交互式窗口内容的 Jupyter Notebook。

导出内容后，VS Code 会显示一个提示，您可以通过它在浏览器中打开 Notebook。