在 Visual Studio Code 中编辑 Python

Visual Studio Code 是一个用于 Python 源代码的功能强大的编辑工具。该编辑器包含各种功能，可帮助您在编写代码时提高工作效率。有关在 Visual Studio Code 中进行编辑的更多信息，请参阅基本编辑和代码导航。

在本概述中，我们将介绍由 Python 扩展提供的特定编辑功能，包括如何通过用户和工作区设置来自定义这些功能的步骤。

自动完成与 IntelliSense

IntelliSense 是与代码补全相关的代码编辑功能的总称。请花点时间查看以下示例。键入 print 时，请注意 IntelliSense 是如何填充自动补全选项的。当用户开始键入名为 greeting 的变量时，也会为其提供一个选项列表。

自动完成和 IntelliSense 适用于当前工作文件夹中的所有文件。它们也适用于安装在标准位置的 Python 包。

Pylance 是 VS Code 中 Python 的默认语言服务器，它与 Python 扩展一起安装以提供 IntelliSense 功能。

Pylance 基于微软的 Pyright 静态类型检查工具，利用类型存根（.pyi 文件）和惰性类型推断来提供高性能的开发体验。

有关 IntelliSense 的一般信息，请参阅 IntelliSense。

提示：查看 VS Code 的 IntelliCode 扩展。IntelliCode 为 Python 中的 IntelliSense 提供了一组 AI 辅助功能，例如根据当前代码上下文推断最相关的自动补全。有关详细信息，请参阅 VS Code 版 IntelliCode 常见问题解答。

自定义 IntelliSense 行为

默认启用整套 IntelliSense 功能可能会让您的开发体验变慢，因此 Python 扩展启用了一组最少的功能，既能让您保持工作效率，又能拥有高性能的体验。但是，您可以通过多种设置来根据您的喜好自定义分析引擎的行为。

启用自动导入

Pylance 为工作区中的模块以及您在环境中安装的包提供自动导入建议。当您在编辑器中键入时，您可能会获得补全建议。当您接受该建议时，自动导入将自动把相应的导入语句添加到您的文件中。

您可以在设置中将 python.analysis.autoImportCompletions 设置为 true 来启用自动导入。默认情况下，自动导入是禁用的。

为自定义包位置启用 IntelliSense

要为安装在非标准位置的包启用 IntelliSense，请将这些位置添加到 settings.json 文件中的 python.analysis.extraPaths 集合中（默认集合为空）。例如，如果您使用 Flask，您可能将 Google App Engine 安装在由 app.yaml 指定的自定义位置中。在这种情况下，您可以按如下方式指定这些位置

Windows

"python.analysis.extraPaths": [
    "C:/Program Files (x86)/Google/google_appengine",
    "C:/Program Files (x86)/Google/google_appengine/lib/flask-0.12"]

macOS/Linux

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

有关可用 IntelliSense 控件的完整列表，您可以参考 Python 扩展的代码分析设置和自动完成设置。

您还可以自定义自动完成和 IntelliSense 的一般行为，甚至完全禁用这些功能。您可以在自定义 IntelliSense 中了解更多信息。

使用人工智能增强补全功能

GitHub Copilot 是一款由 AI 驱动的代码补全工具，可以帮助你更快、更智能地编写代码。你可以在 VS Code 中使用 GitHub Copilot 扩展来生成代码，或从其生成的代码中学习。

GitHub Copilot 为众多语言和各种框架提供代码建议，它对 Python、JavaScript、TypeScript、Ruby、Go、C# 和 C++ 尤其有效。

你可以在 Copilot 文档中了解更多关于如何开始使用 Copilot 的信息。

导航

在编辑时，您可以右键单击不同的标识符以利用几个便捷的命令

• 转到定义（F12）从您的代码跳转到定义对象的代码。当您使用库时，此命令非常有用。

• 查看定义（⌥F12（Windows Alt+F12，Linux Ctrl+Shift+F10））与此类似，但直接在编辑器中显示定义（在编辑窗口中腾出空间以避免遮挡任何代码）。按 Escape 关闭查看窗口，或使用右上角的 x。

• 转到声明跳转到变量或其他对象在您的代码中声明的位置。

• 查看声明与之类似，但直接在编辑器中显示声明。同样，使用 Escape 或右上角的 x 来关闭查看窗口。

快速修复

添加导入

使用 Pylance 时，“添加导入”快速修复使您能够快速完成环境中安装的模块的导入语句。当您开始在编辑器中键入包名称时，可以使用代码操作自动补全这行源代码。将鼠标悬停在文本（标有波浪线）上并选择代码操作灯泡。然后，您可以从潜在导入列表中进行选择。

此代码操作还识别以下常见 Python 包的一些常用缩写：numpy 为 np，tensorflow 为 tf，pandas 为 pd，matplotlib.pyplot 为 plt，matplotlib 为 mpl，math 为 m，scipi.io 为 spio，scipy 为 sp，panel 为 pn，以及 holoviews 为 hv。

导入建议列表显示前 3 个高置信度的导入选项，优先级基于：最近使用的导入、来自同一模块的符号、来自标准库的符号、来自用户模块的符号、来自第三方包的符号，最后按模块和符号名称排序。

搜索更多导入匹配项

默认情况下，“添加导入”快速修复仅显示 3 个高置信度的导入选项。如果没有列出您要找的内容，您可以针对缺失导入错误使用 Pylance 的 搜索更多导入匹配项 快速修复。此快速修复会显示一个快速选择菜单，使您能够搜索与缺失导入符号前缀匹配的导入选项。

更改拼写

当未解析的变量或缺失的导入诊断可能是由拼写错误引起时，Pylance 会显示 更改拼写 快速修复。此代码操作根据在工作区中找到的最接近匹配项，建议该符号的正确拼写。

注意：对于用户符号，这些快速修复将仅从定义它们的文件中建议导入。不支持从用户符号为外部/导入的文件中获取导入建议。

另请注意，对于来自已安装包的符号（通常位于您的 Python 环境的 site-packages 文件夹下），这些快速修复仅建议在包的根文件夹中定义的符号，例如在其 __init__.py 文件中定义的符号。您可以通过 python.analysis.packageIndexDepths 设置为特定包自定义此行为，但请注意这可能会影响 Pylance 的性能。

代码重构

Python 扩展通过 Pylance 扩展添加了以下重构功能：提取变量、提取方法、重命名模块、移动符号和实现所有继承的抽象类。它还支持实现其他重构功能的扩展，例如排序导入。

提取变量

提取当前作用域内所选文本的所有相似出现项，并将其替换为新变量。

您可以通过选择要提取为变量的代码行来调用此命令。然后选择显示在它旁边的小灯泡。

提取方法

提取当前作用域内所选表达式或块的所有相似出现项，并将其替换为方法调用。

您可以通过选择要提取为方法的代码行来调用此命令。然后选择显示在它旁边的小灯泡。

重命名模块

重命名 Python 文件/模块后，Pylance 可以找到可能需要更新的所有实例，并为您提供所有更改的预览。

要自定义需要更新哪些引用，您可以在重构预览中按行或按文件级别切换复选框。做出选择后，您可以选择应用重构或放弃重构。

移动符号

Pylance 扩展提供了两个代码操作来简化将符号移动到不同文件的过程

• 将符号移动到...：显示文件选择器以选择要将符号移动到的目标文件。
• 将符号移动到新文件：创建一个带有符号名称的新文件，该文件位于调用代码操作的源文件所在的同一目录中。

您可以通过将鼠标悬停在要移动的符号上，然后选择所需操作旁边出现的小灯泡来访问这些代码操作。或者，您可以右键单击该符号并从上下文菜单中选择重构...。

实现所有继承的抽象类

在 Python 中，抽象类充当其他类的“蓝图”，并通过为子类提供清晰的结构和遵循要求来帮助构建模块化、可重用的代码。要在 Python 中定义抽象类，您可以创建一个继承自 abc 模块中的 ABC 类的类，并使用 @abstractmethod 装饰器为其方法添加注解。然后，您可以创建继承自此抽象类的新类，并为基础方法定义实现。

Pylance 提供了一项代码操作来简化创建这些类的过程。当您定义一个继承自抽象类的新类时，您现在可以使用 实现所有继承的抽象类 代码操作来自动实现来自父类的所有抽象方法和属性

排序导入

Python 扩展支持实现排序导入功能的扩展，例如 isort 和 Ruff。此命令将来自同一模块的特定导入合并为一个 import 语句，并按字母顺序组织 import 语句。

您可以通过安装支持排序导入的扩展，然后打开命令面板（⇧⌘P（Windows、Linux Ctrl+Shift+P））并运行组织导入来调用此功能。

提示：您可以为 editor.action.organizeImports 命令指定键盘快捷方式。

疑难解答

有关常见的 IntelliSense 和 Python 编辑问题的帮助，请查看下表

Pylance 诊断

默认情况下，Pylance 在“问题”面板中为 Python 文件提供诊断。

下面列出了 Pylance 提供的一些最常见的诊断以及如何修复它们。

importResolveSourceFailure

当 Pylance 能够找到导入包的类型存根但找不到包本身时，就会发生此错误。当您尝试导入的包未安装在所选的 Python 环境中时，可能会发生这种情况。

如何修复

• 如果该包已安装在不同的解释器或内核中，请选择正确的解释器。
• 如果未安装该包，您可以通过在激活的终端中运行以下命令来安装它：python -m pip install {package_name}。

importResolveFailure

当 Pylance 既找不到您正在导入的包或模块，也找不到其类型存根时，就会发生此错误。

如何修复

• 如果您正在导入一个模块，请确保它存在于您的工作区中或包含在 python.autoComplete.extraPaths 设置中的位置。
• 如果您正在导入一个未安装的包，您可以通过在激活的终端中运行以下命令来安装它：python -m pip install {package_name}。
• 如果您正在导入一个已安装在不同解释器或内核中的包，请选择正确的解释器。
• 如果您使用的是可编辑安装，并且当前设置为使用导入钩子，请考虑改用仅包含文件路径的 .pth 文件，以增强兼容性并确保更顺畅的导入行为。在 Pyright 文档中了解更多信息。

importCycleDetected

当 Pylance 检测到两个或多个模块之间存在循环依赖关系时，就会发生此错误。

如何修复

尝试重新排序您的导入语句以打破循环依赖。

可以通过 python.analysis.diagnosticSeverityOverrides 设置自定义 Pylance 诊断的严重性。有关详细信息，请检查设置参考。

下一步计划

• 代码检查 - 启用、配置和应用各种 Python 代码检查工具。
• 调试 - 了解如何在本地和远程调试 Python。
• 测试 - 配置测试环境并发现、运行和调试测试。
• 基本编辑 - 了解功能强大的 VS Code 编辑器。
• 代码导航 - 在源代码中快速跳转。
• IntelliSense - 了解 IntelliSense 功能。
• Jupyter 支持 - 了解如何开始使用 Jupyter Notebooks。
• Python 扩展模板 - 创建一个扩展以集成您最喜欢的 Python 工具。