VSCode 配置 Python 开发环境

2023-11-25 · 阅读时长 3 分钟 · micromamba python venv vscode

使用 VSCode 开发 Python 是替代 PyCharm 的一个很好选择，有丰富的扩展和第三方工具可以使用，安装配置好它们，会让开发工作事半功倍。下面列举推荐安装的扩展和工具：

扩展

Material Icon There
- VSCode图标，很好看
Python
- 微软官方扩展，一定要装
Pylance
- 微软官方扩展，一定要装
autoDocstring
Python Environment Manager
Ruff
Code Runner
Qt for Python

工具

Micromamba
- 使用 Micromamba 来配置 Python 开发环境有几个好处：
  - micromamba 是一个包管理器，可方便的同时安装几个软件，形成一个独立的开发环境，与其它项目的开发环境完全隔离。
  - micromamba 安装的软件，不会在系统留下痕迹，不会污染本地系统。
  - micromamba 只配置 python 基础环境，不影响 python 虚拟环境，同一个基础环境可提供给多个虚拟环境使用。

配置 Micromamba

Windows环境

下载

推荐使用 PowerShell¹

1> Invoke-Webrequest -URI https://micro.mamba.pm/api/micromamba/win-64/latest -OutFile micromamba.tar.bz2
2> tar xf micromamba.tar.bz2
3> MOVE -Force Library\bin\micromamba.exe micromamba.exe
4>.\micromamba.exe --help
5# 查看输出

安装²

1> .\micromamba.exe shell init -s powershell

默认位置为 $HOME/micromamba，也就是 C:\Users\username\micromamba 。如果想自己指定位置，可以加上 “-p <path>” 参数。

同时会在 PowerShell 的 Profile 文件中（相当于 Bash 的 .bashrc）添加以下代码，保证每次启动 PowerShell 时，都会自动初始化 Micromamba 。

 1# $HOME/Documents/WindowsPowerShell/profile.ps1
 2
 3#region mamba initialize
 4# !! Contents within this block are managed by 'mamba shell init' !!
 5$Env:MAMBA_ROOT_PREFIX = "C:\Users\username\micromamba"
 6$Env:MAMBA_EXE = "C:\Users\username\.micromamba\Library\bin\micromamba.exe"
 7(& $Env:MAMBA_EXE 'shell' 'hook' -s 'powershell' -p $Env:MAMBA_ROOT_PREFIX) | Out-String | Invoke-Expression
 8#endregion
 9
10# 加入设置 micromamba 别名的命令。
11# 设置别名后，即方便使用，也可配合 VSCode 的配置，实现自动启动开发环境。
12> Set-Alias -name conda -value micromamba

1# 配置包通道
2> conda config append channels conda-forge
3
4# 查看 micromamba 设置
5> conda info

创建 Python 版本

1# env.yml
2name: PyQt
3channels:
4  - conda-forge
5  - free
6dependencies:
7  - python 3.11
8  - mingw 4.7

1> cd ~/micromamba
2> conda create -f env.yml

配置 VSCode²

配置 Venv 路径

使用 “ctrl+,” 打开设置界面，搜索 venv ，出现两个结果：

选项	值
Python: Venv Folders	如果安装时使用默认位置，就填写 micromamba，下面的不用设置
Python: Venv Path	如果安装时没有使用默认位置，就填写安装位置，上面的不用设置
Python: Conda Path	直接输入conda 即可

重启VSCode，进入 Python 项目，就可以看到右下角的 Python 环境了，如果创建了多个环境，可以通过这里切换。这里需要注意 vscode 可以识别多个 Python 版本，但无法正确配置它们。所以创建不同的 Python 版本后，还要为项目选择解释器。

使用 Python 虚拟环境

使用项目终端界面，创建虚拟环境。

 1# 先激活 micromamba 环境
 2PS "Your Project Path"> conda activate PyQt
 3
 4# 创建Python虚拟环境
 5# --upgrade 参数是升级虚拟环境用的，新建虚拟环境时要去掉。
 6(PyQt) PS "Your Project Path"> python -m venv --system-site-packages --prompt myproject --upgrade-deps --upgrade .venv
 7# 查看项目资源管理器，看到 .venv 文件夹就成功了。
 8
 9# 激活Python虚拟环境
10(PyQt) PS "Your Project Path"> Activate.ps1
11
12# 成功进入虚拟环境
13(myproject) (PyQt) PS "Your Project Path">
14
15# 重启 vscode 再次进入项目终端，不一定会看到项目前缀[^3]。VsCode已经自动修你激活了Python虚拟环境，不需要再操作。
16# 安装包里不需要激活 micromamba 环境，否则包将被安装到 micromamba 环境中。

其它配置

选项	值
Editor: Default Formatter	Ruff
Python > Terminal: ACtivate Env In Current Terminal	勾选
Python > Terminal: Focus After Launch	勾选
Python: Language Server	Pylance
Pylthon > Analysis: Type Checking Mode	basic