在 VS Code 中尝试 ！

创作 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 编写，语言服务器部分在 pygls（Python 语言服务器）库之上用 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 注释。您需要检查 LICENSE 文件，即使您希望保留 MIT 许可。

示例

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

  • Pylint - 在文件 open、save 和 close 时实现 linting 和 Code Actions。
  • Flake8 - 实现 linting 和 Code Actions。
  • Black Formatter - 集成 Black 格式化工具。
  • autopep8 - 集成 autopep8 格式化工具。
  • isort - 添加 Code Actions 以排序导入。

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

扩展开发

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

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

打包和发布

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

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

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

9/28/2022