VSCode Python 扩展项目教程

VSCode Python 扩展项目教程

vscode-python Python extension for Visual Studio Code 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-python

1. 项目的目录结构及介绍

VSCode Python 扩展项目的目录结构如下：

vscode-python/
├── config/
├── devcontainer/
├── github/
├── vscode/
├── build/
├── images/
├── languages/
├── pythonExtensionApi/
├── python_files/
├── resources/
├── schemas/
├── scripts/
├── src/
├── syntaxes/
├── types/
├── typings/
├── .editorconfig
├── .eslintignore
├── .eslintrc
├── .git-blame-ignore-revs
├── .gitattributes
├── .gitignore
├── .npmrc
├── .nvmrc
├── .prettierrc.js
├── .sonarcloud.properties
├── .vscodeignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── SUPPORT.md
├── ThirdPartyNotices-Repository.txt
├── cgmanifest.json
├── gulpfile.js
├── icon.png
├── noxfile.py
├── package-lock.json
├── package.json
├── package.nls.json
├── requirements.in
├── requirements.txt
├── sprint-planning.github-issues
├── tsconfig.browser.json
├── tsconfig.extension.json
├── tsconfig.json
├── tsfmt.json
└── vscode-python-signing.csproj

目录结构介绍

• config/: 包含项目的配置文件。
• devcontainer/: 包含开发容器的配置文件。
• github/: 包含与 GitHub 相关的配置和脚本。
• vscode/: 包含与 Visual Studio Code 相关的配置和脚本。
• build/: 包含构建项目的脚本和配置。
• images/: 包含项目中使用的图像文件。
• languages/: 包含语言相关的配置和脚本。
• pythonExtensionApi/: 包含 Python 扩展的 API 相关文件。
• python_files/: 包含 Python 文件的示例和测试文件。
• resources/: 包含项目资源文件。
• schemas/: 包含 JSON 模式文件。
• scripts/: 包含项目的脚本文件。
• src/: 包含项目的源代码。
• syntaxes/: 包含语法定义文件。
• types/: 包含 TypeScript 类型定义文件。
• typings/: 包含 TypeScript 类型声明文件。
• .editorconfig: 编辑器配置文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc: ESLint 配置文件。
• .git-blame-ignore-revs: Git 忽略修订的配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件。
• .npmrc: npm 配置文件。
• .nvmrc: Node 版本管理配置文件。
• .prettierrc.js: Prettier 配置文件。
• .sonarcloud.properties: SonarCloud 配置文件。
• .vscodeignore: VSCode 忽略文件。
• CHANGELOG.md: 项目变更日志。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目自述文件。
• SECURITY.md: 安全指南。
• SUPPORT.md: 支持指南。
• ThirdPartyNotices-Repository.txt: 第三方通知文件。
• cgmanifest.json: 组件清单文件。
• gulpfile.js: Gulp 构建脚本。
• icon.png: 项目图标。
• noxfile.py: Nox 配置文件。
• package-lock.json: npm 锁定文件。
• package.json: npm 包配置文件。
• package.nls.json: npm 多语言配置文件。
• requirements.in: Python 依赖文件。
• requirements.txt: Python 依赖文件。
• sprint-planning.github-issues: 冲刺计划 GitHub 问题文件。
• tsconfig.browser.json: TypeScript 浏览器配置文件。
• tsconfig.extension.json: TypeScript 扩展配置文件。
• tsconfig.json: TypeScript 配置文件。
• tsfmt.json: TypeScript 格式化配置文件。
• vscode-python-signing.csproj: VSCode Python 签名项目文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/extension.ts，该文件是 VSCode Python 扩展的入口文件。它负责初始化扩展并注册各种命令和服务。

src/extension.ts 文件介绍

• 初始化扩展: 该文件首先初始化扩展，并注册各种命令和服务。
• 注册命令: 注册了多个命令，如 Python: Select Interpreter、Python: Start Terminal REPL 等。
• 注册服务: 注册了多个服务，如调试服务、测试服务等。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

.vscodeignore

该文件用于指定在打包扩展时需要忽略的文件和目录。

package.json

该文件是 npm 包配置文件，包含了扩展的基本信息、依赖项、命令等。

tsconfig.json

该文件是 TypeScript 配置文件，用于配置 TypeScript 编译选项。

.eslintrc

该文件是 ESLint 配置文件，用于配置代码风格检查规则。

.prettierrc.js

该文件是 Prettier 配置文件，用于配置代码格式化规则。

requirements.txt

该文件是 Python 依赖文件，列出了项目所需的 Python 包及其版本。

gulpfile.js

该文件是 Gulp 构建脚本，用于自动化构建任务。

README.md

该文件是项目的自述文件，包含了项目的介绍、安装指南、使用说明等。

LICENSE

该文件是项目的许可证文件，规定了项目的使用许可。

CONTRIBUTING.md

该文件是贡献指南，指导开发者如何为项目贡献代码。

CODE_OF_CONDUCT.md

该文件是行为准则，规定了项目社区的行为规范。

SECURITY.md

该文件是安全指南，提供了项目的安全相关信息和指南。

SUPPORT.md

该文件是支持指南，提供了项目的支持相关信息和指南。

CHANGELOG.md

该文件是变更日志，记录了项目的版本变更历史。

vscode-python Python extension for Visual Studio Code 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-python