编写 Python 扩展

注意：如果您是 VS Code 扩展编写新手，建议您首先阅读 您的第一个扩展 教程，并尝试创建一个简单的 Hello World 扩展。

Python 扩展提供了 API，供其他扩展与用户机器上可用的 Python 环境进行交互。请查看 @vscode/python-extension npm 模块，它包含用于从您的扩展访问这些 API 的类型和辅助工具。

Python 扩展模板

Python 扩展模板 可帮助您开始为喜爱的 Python 工具构建 Visual Studio Code 扩展。它可以是 linter、格式化程序、代码分析工具，或者所有这些功能的组合。该模板将为您提供构建将您的工具集成到 VS Code 的扩展所需的基本构建块，并且它已经可以访问上述 Python API。

编程语言和框架

扩展模板包含两部分：扩展部分和语言服务器部分。扩展部分用 TypeScript 编写，语言服务器部分用 Python 编写，基于 pygls（Python 语言服务器）库。

使用此模板时，您将主要处理代码的 Python 部分。您将使用 语言服务器协议 将您的工具与扩展部分集成。pygls 当前适用于 LSP 的 3.16 版本。

TypeScript 部分负责与 VS Code 及其 UI 交互。扩展模板内置了一些可供您的工具使用的设置。如果您需要添加新设置来支持您的工具，您将需要处理一些 TypeScript。扩展模板包含一些设置的示例，您还可以查看我们团队为一些流行工具开发的扩展。

要求

1. VS Code 1.64.0 或更高版本
2. Python 3.7 或更高版本
3. node >= 14.19.0
4. npm >= 8.3.0（npm 随 node 一起安装，请检查 npm 版本，使用 npm install -g npm@8.3.0 进行更新）
5. 适用于 VS Code 的 Python 扩展

您应该知道如何创建和使用 Python 虚拟环境。

入门

要开始使用，请遵循模板 README 中的说明。您将了解到如何使用 模板创建您的存储库，以及如何安装必要的工具（例如 nox 任务运行器）和可选依赖项（测试支持）。

README 包含最新的说明，并详细介绍了如何自定义扩展的 package.json 占位符（<pythontool-module>、<pythontool-display-name> 等）。

模板的功能

通过模板创建扩展后，它将包含以下扩展贡献。假设 <pytool-module> 已替换为 mytool，而 <pytool-display-name> 已替换为 My Tool

1. 命令 My Tool: Restart Server（命令 ID：mytool.restart）。
2. 以下设置
   • mytool.logLevel
   • mytool.args
   • mytool.path
   • mytool.importStrategy
   • mytool.interpreter
   • mytool.showNotification
3. 以下扩展激活触发器
   • 在语言 python 上。
   • 在打开的工作区中找到带有 .py 扩展名的文件时。
   • 在命令 mytool.restart 上。
4. 日志输出通道 输出 > My Tool。

集成您的工具

生成的 bundled/tool/server.py 文件是您进行大部分更改的地方。文件中的 TODO 注释指出了各种自定义点。您还可以在模板中的其他位置（例如其他 Python 和 Markdown 文件）搜索 TODO 注释。即使您想保留 MIT 许可证，您也需要审查 LICENSE 文件。

示例

有几个从模板创建的示例实现

• Pylint - 在文件 open、save 和 close 上实现 linting 和代码操作。
• Flake8 - 实现 linting 和代码操作。
• Black Formatter - 集成 Black 格式化程序。
• autopep8 - 集成 autopep8 格式化程序。
• isort - 添加代码操作以排序导入。

您还可以查阅 语言服务器协议规范，以便更好地理解 pygls 语言服务器集成。

扩展开发

模板 README 详细介绍了模板中包含的 开发周期支持。模板包含命令和配置，因此您可以构建、运行、调试和测试您的扩展。

如果在开发过程中遇到问题，有一个 故障排除 部分可以帮助解决常见问题。

打包和发布

在发布您的扩展之前，您需要更新扩展 package.json 字段（例如 publisher 和 license）以适应您的特定扩展。您还需要更新辅助 Markdown 文件（CODE_OF_CONDUCT.md、CHANGELOG.md 等）。

一旦您的扩展准备好发布，就有一个 nox build-package 任务来创建 .vsix 文件，然后您可以将其上传到您的扩展 管理页面。

如果您是创建和发布 VS Code 扩展的新手，我们建议您遵循主 VS Code 扩展编写 主题中概述的最佳实践。在这里，您将找到指导，帮助您的扩展在 Marketplace 上看起来很棒，以及如何成为经过验证的发布者，以便用户放心地安装您的扩展。