现已发布!阅读 10 月份的更新功能和修复。

Visual Studio Code 中的 Python

在 Visual Studio Code 中使用 Microsoft Python 扩展 进行 Python 开发非常简单、有趣且高效。该扩展使 VS Code 成为出色的 Python 编辑器,并在各种 Python 解释器上适用于任何操作系统。它利用 VS Code 的所有功能,提供自动补全和 IntelliSense、代码校验、调试和单元测试,以及轻松地在 Python 环境之间切换的能力,包括虚拟环境和 conda 环境。

本文仅概述了 VS Code 的 Python 扩展的不同功能。有关编辑、运行和调试代码的逐步操作指南,请使用下面的按钮。

Python 教程

安装 Python 和 Python 扩展

教程 将指导您完成安装 Python 和使用扩展的过程。您必须自己安装 Python 解释器,它与扩展分开。要快速安装,请使用 来自 python.org 的 Python从 VS Code 市场安装扩展

注意:为了帮助您开始 Python 开发,您可以使用包含有用扩展、设置和 Python 代码段的 Python 配置文件模板

安装 Python 版本后,请使用 Python: 选择解释器 命令进行选择。如果 VS Code 未自动找到您要查找的解释器,请参阅 环境 - 手动指定解释器

您可以通过设置配置 Python 扩展。在 Python 设置参考 中了解更多信息。

Windows Subsystem for Linux:如果您使用的是 Windows,WSL 是进行 Python 开发的绝佳方式。您可以在 Windows 上运行 Linux 发行版,并且 Python 通常已安装。与 WSL 扩展结合使用时,您可以在 WSL 上下文中运行,并获得完整的 VS Code 编辑和调试支持。要了解更多信息,请转到 在 WSL 中开发 或尝试 在 WSL 中工作 教程。

运行 Python 代码

要体验 Python,请创建一个名为 hello.py 的文件(使用 文件资源管理器)并粘贴以下代码

print("Hello World")

然后,Python 扩展将提供使用当前选择的解释器运行 Python 代码的快捷方式(Python: 选择解释器,位于命令面板中)。要运行活动 Python 文件,请单击编辑器右上角的 运行 Python 文件 播放按钮。

Using the run python file in terminal button

您还可以使用 Python: 在 Python 终端中运行选择/行 命令 (Shift+Enter) 运行单个行或代码选择。如果没有选择,Smart Send 将将光标所在行周围最小的可运行代码块发送到 Python 终端 (Shift+Enter)。选择编辑器中的选择后,上下文菜单中会有一个相同的 运行 Python > 在 Python 终端中运行选择/行 命令。每次在终端/REPL 中运行选择或一行时,都会使用同一个终端,直到该终端关闭。同一个终端也用于 在终端中运行 Python 文件。如果该终端仍在运行 REPL,则应退出 REPL (exit()) 或切换到另一个终端,然后再运行 Python 文件。

Python 扩展会根据选择的第一个非空行自动删除缩进,并根据需要将所有其他行向左移动。

该命令将在需要时打开 Python 终端;您还可以使用 Python: 启动终端 REPL 命令直接打开交互式 REPL 环境,该命令会激活使用当前选择的解释器运行的终端,然后运行 Python REPL。

有关更详细的逐步操作指南和其他运行代码的方法,请参阅 运行代码教程

自动补全和 IntelliSense

Python 扩展使用当前选择的解释器支持代码补全和 IntelliSense。 IntelliSense 是指多种功能的通用术语,包括跨所有文件的智能代码补全(上下文方法和变量建议)以及内置模块和第三方模块的智能代码补全。

IntelliSense 会在您键入时快速显示方法、类成员和文档。您还可以使用 ⌃Space (Windows、Linux Ctrl+Space) 在任何时候触发补全。将鼠标悬停在标识符上将显示有关它们的更多信息。

IntelliSense and autocomplete for Python code

使用 AI 增强补全功能

GitHub Copilot 是一款由 AI 支持的代码补全工具,可帮助您更快、更智能地编写代码。您可以在 VS Code 中使用 GitHub Copilot 扩展 生成代码,或从它生成的代码中学习。

GitHub Copilot extension in the VS Code Marketplace

GitHub Copilot 为除 Python 之外的多种语言和各种框架提供建议,包括 JavaScript、TypeScript、Ruby、Go、C# 和 C++。

您可以在 Copilot 文档 中详细了解如何开始使用 Copilot。

代码校验

代码校验会分析您的 Python 代码以查找潜在错误,便于您导航到并更正不同的问题。

Python 扩展可以应用多种代码校验器,包括 Pylint、pycodestyle、Flake8、mypy、pydocstyle、prospector 和 pylama。请参阅 代码校验

调试

告别print语句调试!VS Code 为 Python 提供了强大的调试支持,通过 Python Debugger 扩展,您可以设置断点、检查变量,并使用调试控制台深入了解程序的执行过程。调试多种类型的 Python 应用程序,包括多线程、Web 和远程应用程序。

有关 Python 调试的更详细的信息,例如配置 launch.json 设置和实现远程调试,请参见 调试。有关 VS Code 通用调试信息,请参见 调试文档

此外,DjangoFlask 教程提供了在 Web 应用程序中实现调试的示例,包括调试 Django 模板。

环境

Python 扩展会自动检测安装在标准位置的 Python 解释器。它还会检测 conda 环境以及工作区文件夹中的虚拟环境。请参见 配置 Python 环境

当前环境显示在 VS Code 状态栏的右侧。

Status Bar showing a selected interpreter

状态栏还指示是否未选择解释器。

Status bar showing no selected Python interpreter

所选环境用于 IntelliSense、自动完成、代码检查、格式化以及任何其他语言相关的功能。当您在终端中运行或调试 Python,或使用 终端:创建新终端 命令创建新终端时,也会激活它。

要更改当前解释器(包括切换到 conda 或虚拟环境),请在状态栏上选择解释器名称,或使用 Python:选择解释器 命令。

Python: Select Interpreter command

VS Code 会为您提供一个检测到的环境列表,以及您手动添加到用户设置中的任何环境(请参见 配置 Python 环境)。

Jupyter 笔记本

要为 VS Code 中的 Jupyter 笔记本 文件 (.ipynb) 启用 Python 支持,您可以安装 Jupyter 扩展。Python 和 Jupyter 扩展协同工作,在 VS Code 中为您提供出色的笔记本体验,使您能够直接查看和修改代码单元格,并提供 IntelliSense 支持,以及运行和调试它们。

Jupyter notebook running in VS code in the Notebook Editor

您也可以使用 Jupyter:导出到 Python 脚本 命令将笔记本转换为 Python 代码文件并打开它。笔记本的单元格在 Python 文件中使用 #%% 注释分隔,Jupyter 扩展显示 运行单元格运行下方 CodeLens。选择任一 CodeLens 将启动 Jupyter 服务器并在 Python 交互式窗口中运行单元格。

Jupyter notebook running in VS Code and the Python interactive window

您还可以连接到远程 Jupyter 服务器来运行您的笔记本。有关更多信息,请参见 Jupyter 支持

测试

Python 扩展支持使用 Python 的内置 unittest 框架和 pytest 进行 测试

为了运行测试,您必须在项目设置中启用一个支持的测试框架。每个框架都有其自己的特定设置,例如用于识别测试发现路径和模式的参数。

发现测试后,VS Code 提供各种命令(在状态栏、命令面板和其他位置)来运行和调试测试。这些命令还允许您运行单个测试文件和方法。

配置

Python 扩展为其各种功能提供各种设置。这些设置在各自的主题中都有描述,例如 编辑代码代码检查调试测试。完整的列表可在 设置参考 中找到。

Python 配置文件模板

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

您可以通过 配置文件 > 创建配置文件... 下拉菜单选择配置文件模板。

Create Profile dropdown with profile templates

选择配置文件模板后,您可以查看设置和扩展,并删除不需要包含在新的配置文件中的单个项目。在基于模板创建新的配置文件后,对设置、扩展或 UI 所做的更改将保留在您的配置文件中。

Microsoft Python 扩展 提供了本文之前描述的所有功能。通过安装其他流行的 Python 扩展,可以为 VS Code 添加额外的 Python 语言支持。

  1. 打开 扩展 视图 (⇧⌘X (Windows, Linux Ctrl+Shift+X)).
  2. 通过键入 'python' 来过滤扩展列表。

以上显示的扩展是动态查询的。点击上面的扩展磁贴以阅读描述和评论,以决定哪个扩展最适合您。在 市场 中了解更多信息。

后续步骤