在 VS Code 中试用

Visual Studio Code 中的 Python

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

本文仅概述 VS Code Python 扩展的不同功能。有关编辑、运行和调试代码的详细说明,请使用以下按钮。

Python 教程

安装 Python 和 Python 扩展

本教程将指导你安装 Python 并使用该扩展。你必须单独安装 Python 解释器,而不是通过扩展安装。如需快速安装,请使用 python.org 上的 Python从 VS Code Marketplace 安装扩展

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

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

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

适用于 Linux 的 Windows 子系统:如果你使用的是 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)运行单行或选定的代码。如果没有选定内容,智能发送将把光标所在行周围的最小可运行代码块发送到 Python 终端(Shift+Enter)。编辑器中选定内容的上下文菜单上提供了相同的运行 Python > 在 Python 终端中运行选定/行命令。每次在终端/REPL 中运行选定内容或一行时,都将使用相同的终端,直到该终端关闭。运行在终端中运行 Python 文件时也使用相同的终端。如果该终端仍在运行 REPL,则在运行 Python 文件之前应退出 REPL (exit()) 或切换到其他终端。

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

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

有关更具体的说明和运行代码的其他方法,请参阅运行代码教程

自动补全和智能感知

Python 扩展支持使用当前选定的解释器进行代码补全和智能感知。智能感知是一个通用术语,用于指代许多功能,包括所有文件以及内置和第三方模块中的智能代码补全(上下文相关的方法和变量建议)。

智能感知会在你键入时快速显示方法、类成员和文档。你还可以随时使用⌃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 调试支持,允许你设置断点、检查变量,并使用调试控制台深入了解程序如何逐步执行。调试多种不同类型的 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

选定的环境用于智能感知、自动补全、代码检查、格式化以及任何其他与语言相关的功能。当你通过终端运行或调试 Python,或使用终端:创建新终端命令创建新终端时,它也会被激活。

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

Python: Select Interpreter command

VS Code 会向你显示检测到的环境列表以及你手动添加到用户设置中的任何环境(请参阅配置 Python 环境)。

Jupyter Notebooks

要启用 VS Code 对 Jupyter notebook 文件 (.ipynb) 的 Python 支持,你可以安装 Jupyter 扩展。Python 和 Jupyter 扩展协同工作,为你提供出色的 VS Code Notebook 体验,让你能够直接查看和修改带有智能感知支持的代码单元格,以及运行和调试它们。

Jupyter notebook running in VS code in the Notebook Editor

你还可以通过Jupyter:导出到 Python 脚本命令将笔记本转换为 Python 代码文件并打开。笔记本的单元格在 Python 文件中用 #%% 注释分隔,Jupyter 扩展会显示运行单元格运行下方代码镜头。选择任一代码镜头将启动 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”过滤扩展列表。

上面显示的扩展是动态查询的。单击上面的扩展磁贴以阅读说明和评论,以决定哪个扩展最适合你。在市场中查看更多信息。

后续步骤