在 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 基于 Microsoft 的 Pyright 静态类型检查工具，利用类型存根 (.pyi 文件) 和延迟类型推断，以提供高性能的开发体验。

有关 IntelliSense 的更多信息，请参阅IntelliSense。

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

自定义 IntelliSense 行为

默认情况下启用全套 IntelliSense 功能最终可能会使您的开发体验感觉更慢，因此 Python 扩展启用了一组最少的功能，使您可以在保持高性能体验的同时提高工作效率。但是，您可以通过多个设置自定义分析引擎的行为。

启用自动导入

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

您可以通过在您的设置中将 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 中了解更多信息。

使用 AI 增强补全

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 工具。