Visual Studio Code 中的 Python

在 Visual Studio Code 中使用 Microsoft Python 扩展开发 Python 既简单有趣又高效。该扩展将 VS Code 转变为出色的 Python 编辑器,并适用于任何操作系统以及各种 Python 解释器。它充分利用 VS Code 的强大功能,提供自动补全、IntelliSense、代码检查(Linting)、调试和单元测试,以及在不同 Python 环境(包括虚拟环境和 conda 环境)之间轻松切换的能力。

本文仅概述了适用于 VS Code 的 Python 扩展的不同功能。如需了解编辑、运行和调试代码的详细操作指南,请使用下方的按钮。

Python 教程

安装 Python 和 Python 扩展

本教程将指导您完成 Python 的安装及扩展的使用。您必须自行安装 Python 解释器,该过程独立于扩展安装。如需快速安装,请使用 python.org 提供的 Python,并从 VS Code 市场安装该扩展

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

安装好 Python 版本后,请使用 Python: Select Interpreter(Python:选择解释器)命令进行选择。如果 VS Code 没有自动定位到您要查找的解释器,请参考环境 - 手动指定解释器

您可以通过设置来配置 Python 扩展。更多信息请参阅 Python 设置参考

Windows Subsystem for Linux (WSL):如果您使用 Windows,WSL 是进行 Python 开发的绝佳方式。您可以在 Windows 上运行 Linux 发行版,且通常已预装 Python。配合 WSL 扩展,您可以在 WSL 环境中获得完整的 VS Code 编辑和调试支持。欲了解更多信息,请访问在 WSL 中开发或尝试在 WSL 中工作教程。

运行 Python 代码

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

print("Hello World")

Python 扩展提供了快捷方式,以便使用当前选定的解释器运行 Python 代码(通过命令面板中的 Python: Select Interpreter 选择)。要运行当前的 Python 文件,请点击编辑器右上角的 Run Python File(运行 Python 文件)播放按钮。

Using the run python file in terminal button

您也可以使用 Python: Run Selection/Line in Python Terminal(Python:在 Python 终端运行选定内容/行)命令(Shift+Enter)运行单行或选定的代码段。如果没有选中任何内容,智能发送(Smart Send)功能会将光标所在位置周围最小的可运行代码块发送到 Python 终端。编辑器内选定内容的右键菜单中也有一个相同的 Run Python > Run Selection/Line in Python Terminal 命令。只要终端未关闭,每次运行选定内容或行时都会使用同一个终端。该终端也用于 Run Python File in Terminal(在终端中运行 Python 文件)。如果该终端仍在运行 REPL,您应该先退出 REPL (exit()) 或切换到另一个终端,然后再运行 Python 文件。

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

如果需要,该命令会打开 Python 终端;您也可以使用 Python: Start Terminal REPL(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 的信息。

代码检查

代码检查(Linting)会分析您的 Python 代码以查找潜在错误,使您可以轻松导航并修复各种问题。

Python 扩展可以应用多种不同的检查工具,包括 Pylint、pycodestyle、Flake8、mypy、pydocstyle、prospector 和 pylama。请参阅代码检查 (Linting)

调试

无需再用 print 语句进行调试了!VS Code 通过 Python 调试器扩展为 Python 提供了出色的调试支持,允许您设置断点、检查变量,并使用调试控制台深入了解程序的逐行执行过程。您可以调试多种类型的 Python 应用程序,包括多线程、Web 和远程应用程序。

有关 Python 调试的更具体信息(例如配置 launch.json 设置和实现远程调试),请参阅调试 (Debugging)。常规的 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,或者使用 Terminal: Create New Terminal(终端:创建新终端)命令创建新终端时,该环境也会被激活。

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

Python: Select Interpreter command

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

Jupyter Notebook

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

Jupyter notebook running in VS code in the Notebook Editor

您还可以通过 Jupyter: Export to Python Script(Jupyter:导出为 Python 脚本)命令将 Notebook 转换为 Python 代码文件并打开。Notebook 的单元格在 Python 文件中以 #%% 注释分隔,Jupyter 扩展会显示 Run Cell(运行单元格)或 Run Below(运行下方代码)的 CodeLens。选择任一 CodeLens 都会启动 Jupyter 服务器并在 Python 交互窗口中运行该单元格。

Jupyter notebook running in VS Code and the Python interactive window

您还可以连接到远程 Jupyter 服务器来运行 Notebook。更多信息,请参阅 Jupyter 支持

测试

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

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

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

配置

Python 扩展为其各项功能提供了广泛的设置。这些设置在相关主题中有详细说明,例如编辑代码代码检查调试测试。完整列表请见设置参考

Python 配置文件模板

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

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

Create Profile dropdown with profile templates

选择配置文件模板后,您可以查看其中的设置和扩展,如果不想在新配置文件中包含某些项目,可以将其移除。基于模板创建新配置文件后,对设置、扩展或 UI 所做的更改将保存在您的配置文件中。

Microsoft Python 扩展提供了本文中描述的所有功能。通过安装其他热门的 Python 扩展,可以为 VS Code 添加更多的 Python 语言支持。

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

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

后续步骤

© . This site is unofficial and not affiliated with Microsoft.