VSCode搭建Python开发环境

1. 安装 Python 环境

方法 1：直接官网下载 Python 安装。

安装包下载网址

方法 2：用 conda 管理 Python 环境。可在系统中安装多个 Python 版本，方便切换（推荐）。

Win10下用Conda搭建Python环境

2. 安装 VSCode

安装包下载网址

3. 安装相关扩展

Python

简介：Python 扩展，包括 IntelliSense(Pylance)、linting、调试、代码导航、代码格式化、重构、变量资源管理器、测试资源管理器等功能。

Pylance

简介：Pylance 是一个扩展，它与 Visual Studio 代码中的 Python 一起工作，以提供性能语言支持。Pylance 由微软的静态类型检查工具 Pyright 提供支持。使用 Pyright，Pylance 能够通过丰富的类型信息增强您的 Python IntelliSense 体验，帮助您更快地编写更好的代码。

Mypy Type Checker

简介：静态语法检查工具。

Black Formatter

简介：Pthon 代码格式化插件。

isort

简介：微软官方的，优化 Python 导包顺序。

【注意】

最近（2024.3.8 使用这个工具时会提示 python.isort 命令找不到，可以用下边的 Better isort 代替，用的感觉都一样。

Better isort

简介：优化 Python 导包顺序。

【说明】

需要使用 pip 安装 isort 包：pip install isort

3.1. 在线安装示例

这里以安装 Python 扩展为例。

直接在 VSCode 扩展里边搜索 Python 安装即可。

3.2. 离线安装示例

如果 VSCode 无法联网，在VSCode官方插件网址搜索 "Python" > 下载扩展 > 安装即可。

Step 1：搜索：

Step 2：下载：

Step 3：安装：

4. 选择 Python 解释器

4.1. 仅对当前工程生效

F1 打开 VSCode 的命令行，输入 python: select Interpreter 选择合适的 Python 版本。

可以看到在 .vscode/launch.json 中，Python 的安装目录已经加入：

{
	"python.pythonPath": "C:\\Program Files\\Python39\\python.exe"
}

此时 VSCode 左下角会显示已选择的 Python 解释器：

4.2. 对所有工程生效（推荐此种方法）

文件 > 首选项 > 设置 > 右上角第二个图标（打开设置 json）> 在 json 中添加如下内容：

{
	"python.pythonPath": "C:\\Program Files\\Python39\\python.exe"
}

【注意】

1、路径需要使用双斜杠

2、根据 Python 安装的实际路径相应修改

5. 代码自动补全

5.1. 配置第三方库路径

完成上述步骤后，编写 Python 代码会自动补全，自动补全一般对系统自带库支持比较友好。但是，如果你电脑有多个 Python 版本，或者你用了第三方库，那么就可能不会自动补全，例如使用 tensorflow 库时就不会自动补全提示。此时，需要指定第三方库的路径，具体设置方法参看："Python settings reference > AutoComplete settings > extraPaths"参数说明。这里给出一个 setting.json 的配置示例（工作区的 setting.json）：

其中 python.autoComplete.extraPaths 就是指定第三方库路径的，pip 安装的包都在 site-packages 里边，tensorflow 也在该文件夹下，这里指定到 site-packages 目录就行，不需要指定到 site-packages 下的 tensorflow 目录。

5.2. 类型注释

使用 Pylance 插件后就自动支持补全和方法提示了。此外，Python 声明变量不需要类型，这就造成了该变量是泛型，自动补全无法显示成员，但是如果我们确切的知道该变量的类型，就可以采用类型注释的方式，在变量后边加冒号和类型，例如：

其中：str 指定了 zhang 的类型是一个字符串，后边输入点号（.）就可以显示 zhang 的成员了。

6. 编写代码并运行

至此，环境已经搭建完毕。编写 Python 代码，然后如下方式运行：

总结：

总的 setting.json 配置项如下：

{
	"python.languageServer": "Pylance",
	"python.analysis.typeCheckingMode": "standard",
	"python.defaultInterpreterPath": "C:\\Program Files\\Python39\\python.exe", // 根据实际情况配置默认python解释器路径
	"[python]": {
	    "editor.defaultFormatter": "ms-python.black-formatter"
	},
	"black-formatter.args": [
	    "--line-length=120"
	]
}

7. VSCode 调试 Python 进入第三方库

单步调试 Python 文件无法进入第三方库的原因为：VSCode 的调试配置里有个重要的选项没配置，它就是 "justMyCode": false。这个选项默认是 true，是进不了第三方包源码的，所以要改成 false。

F1，输入 Debug: Open launch.json，打开配置文件，添加："justMyCode": false

8. VSCode 无法识别 conda

Win10 VScode 中选择 python 解释器后，不管是默认的运行功能或者 code-runner 插件，都会提示找不到 conda。此时把 conda 添加到系统环境变量 Path 中，同时打开 Win10 执行脚本的能力即可。

默认运行方式：

code-runner 方式：

添加系统环境变量：

打开脚本执行能力：

以管理员身份打开 PowerShell，输入命令 set-ExecutionPolicy RemoteSigned，选择 Y，打开脚本执行能力。

配置环境变量和打开脚本执行能力后，在 VSCode 中首次运行代码，会自动调用 conda init 指令，会把 conda 初始化指令写入 C:\Users\<user_name>\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1 中，写入的内容如下：

#region conda initialize
# !! Contents within this block are managed by 'conda init' !!
(& "C:\ProgramData\Miniconda3\Scripts\conda.exe" "shell.powershell" "hook") | Out-String | Invoke-Expression
#endregion

其实就类似于 Linux 下装完 miniconda 后，会提示运行 conda init 初始化指令，否则在 shell 终端也是无法识别 conda 命令的。