尝试以扩展 VS Code 中的代理模式!

Python 交互式窗口

Jupyter(前身为 IPython Notebook)是一个开源项目,可让您轻松地在一个称为笔记本的画布上结合 Markdown 文本和可执行 Python 源代码。Visual Studio Code 原生支持使用 Jupyter 笔记本,也支持通过 Python 代码文件使用。本主题介绍通过 Python 代码文件提供的支持,并演示如何:

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

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

激活相应环境后,您可以创建并运行类 Jupyter 代码单元格,连接到远程 Jupyter 服务器以运行代码单元格,并将 Python 文件导出为 Jupyter 笔记本。

Jupyter 代码单元格

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

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

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

注意:请确保将上面显示的代码保存到以 .py 扩展名结尾的文件中。

当 Python 扩展检测到代码单元格时,它会添加运行单元格 (Run Cell) 和调试单元格 (Debug Cell) CodeLens 装饰。第一个单元格还包括运行下方 (Run Below),所有后续单元格都包括运行上方 (Run Above)

Jupyter adornments for code cells in the VS Code editor

注意:默认情况下,调试单元格 (Debug Cell) 只会进入用户代码。如果要进入非用户代码,则需要在 Jupyter 扩展设置中取消选中仅调试我的代码 (Debug Just My Code) (⌘, (Windows、Linux Ctrl+,))。

运行单元格 (Run Cell) 仅适用于单个代码单元格。运行下方 (Run Below) 出现在第一个单元格上,会运行文件中的所有代码。运行上方 (Run Above) 适用于所有代码单元格,直到(但不包括)具有装饰的单元格。例如,您可以使用运行上方 (Run Above) 在运行特定单元格之前初始化运行时环境的状态。

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

Code cells running in a Python Interactive window

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

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

其他命令和键盘快捷方式

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

命令 键盘快捷方式
Python: 转到下一个单元格 Ctrl+Alt+]
Python: 转到上一个单元格 Ctrl+Alt+[
Python: 向上扩展选择单元格 Ctrl+Shift+Alt+[
Python: 向下扩展选择单元格 Ctrl+Shift+Alt+]
Python: 向上移动选定单元格 Ctrl+; U
Python: 向下移动选定单元格 Ctrl+; D
Python: 在上方插入单元格 Ctrl+; A
Python: 在下方插入单元格 Ctrl+; B
Python: 在此位置下方插入单元格 Ctrl+; S
Python: 删除选定单元格 Ctrl+; X
Python: 将单元格更改为代码 Ctrl+; C
Python: 将单元格更改为 Markdown Ctrl+; M

使用 Python 交互式窗口

前面提到的 Python 交互式窗口可以用作带有任意代码(无论有无代码单元格)的独立控制台。要将窗口用作控制台,请从命令面板中打开它,使用Jupyter: Create Interactive Window命令。然后,您可以输入代码,使用 Enter 换行,使用 Shift+Enter 运行代码。

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

IntelliSense

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

IntelliSense in the Python Interactive window

绘图查看器

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

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

Plot Viewer with the Python Interactive window

注意:Python 交互式窗口支持渲染使用 matplotlibAltair 创建的绘图。

变量查看器和数据查看器

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

Variables Explorer

有关变量的其他信息,您还可以双击一行或使用在数据查看器中显示变量 (Show variable in data viewer) 按钮,在数据查看器中查看变量的更详细视图。打开后,您可以通过搜索行来筛选值。

Data Viewer

连接到远程 Jupyter 服务器

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

连接到远程 Jupyter 服务器

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

  2. 选择您希望如何连接到 Jupyter 服务器。提示提供 Jupyter 服务器 URI

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

    Prompt to supply a Jupyter server URI

  4. Python 交互式窗口通过显示 URI(在下图中已模糊处理)来指示代码的运行位置

    The Python Interactive window showing that code is running on a remote Jupyter server

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

将 Jupyter 笔记本转换为 Python 代码文件

当您激活了安装有 Jupyter 的环境后,可以在 VS Code 中打开 Jupyter 笔记本文件(.ipynb),然后将其转换为 Python 代码。转换文件后,您可以像运行任何其他 Python 文件一样运行代码,也可以使用 VS Code 调试器。在 VS Code 中打开和调试笔记本是查找和解决代码错误的一种便捷方法,而这在 Jupyter 笔记本中很难直接完成。

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

Icon to convert a Jupyter notebook file

选择转换图标,然后选择“Python Script”,等待几秒钟,然后 VS Code 会在一个未命名文件中打开转换后的笔记本。笔记本的单元格在 Python 文件中用 # %% 注释分隔;Markdown 单元格完全转换为以 # %% [markdown] 为前缀的注释,并在交互式窗口中与代码和图表等输出一起渲染为 HTML

Jupyter notebook running in VS Code and the Python Interactive window

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

调试 Jupyter 笔记本

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

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

  2. 按照上一节所述将笔记本的 .ipynb 文件导入 VS Code。(如果您使用的是基于云的 Jupyter 环境,例如 Azure Notebooks,请先下载文件。)

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

    • 对于整个笔记本,打开命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 并运行Jupyter: Debug Current File in Python Interactive Window命令。
    • 对于单个单元格,请使用出现在单元格上方的调试单元格 (Debug Cell) 装饰。调试器将专门从该单元格中的代码开始。默认情况下,调试单元格 (Debug Cell) 只会进入用户代码。如果要进入非用户代码,则需要在 Jupyter 扩展设置中取消选中仅调试我的代码 (Debug Just My Code) (⌘, (Windows、Linux Ctrl+,))。
  4. 要熟悉 VS Code 的一般调试功能,例如检查变量、设置断点和其他活动,请查看VS Code 调试

  5. 发现问题时,停止调试器,更正代码,保存文件,然后再次启动调试器。

  6. 当您确信所有代码都正确无误时。保存文件,然后按照以下部分所述导出笔记本。然后,您可以将笔记本上传到您的常规 Jupyter 环境。

导出 Jupyter 笔记本

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

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

导出内容后,VS Code 会显示一个提示,您可以通过该提示在浏览器中打开笔记本。