使用 VS Code 配置 Python 解释器、虚拟环境、终端、运行调试、格式化和代码检查。
在 VS Code 的扩展市场中安装:
| 扩展 | 发布者 | 用途 |
|---|---|---|
| Python | Microsoft | Python 运行、调试、解释器选择 |
| Pylance | Microsoft | 类型提示、补全、导入分析 |
| Ruff | Astral Software | 代码检查与格式化 |
| Jupyter | Microsoft | Jupyter Notebook 支持,按需安装 |
建议至少安装:
Python
Pylance
Ruff
推荐通过“打开文件夹”打开整个项目,而不是只打开一个 Python 文件。
菜单:
文件 → 打开文件夹
例如:
my-project/
├── .venv/
├── main.py
├── requirements.txt
└── README.md
这样 VS Code 才能更稳定地识别:
在项目根目录打开终端:
python -m venv .venv
激活环境后安装依赖:
python -m pip install -r requirements.txt
在 VS Code 中选择解释器:
按下 Ctrl + Shift + P;
输入:
Python: Select Interpreter
选择项目中的 .venv:
Windows:
.venv\Scripts\python.exe
Ubuntu / Debian:
.venv/bin/python
选择后,可以在 VS Code 右下角确认当前 Python 版本和解释器。
打开 VS Code 集成终端,执行:
python -c "import sys; print(sys.executable)"
输出路径应包含:
.venv
例如 Windows:
C:\Projects\my-project\.venv\Scripts\python.exe
例如 Ubuntu:
/home/user/my-project/.venv/bin/python
如果希望 VS Code 集成终端默认打开 Command Prompt(CMD):
settings.json 中添加以下内容;settings.json 文件;{
"terminal.integrated.defaultProfile.windows": "Command Prompt"
}
如果原本已有其他设置,应在现有 JSON 对象中添加,并注意每个配置项之间需要使用逗号分隔。
示例:
{
"terminal.integrated.defaultProfile.windows": "Command Prompt",
"editor.formatOnSave": true
}
settings.json 配置以下是一个适合 Python 开发的基础配置,可按需添加到 VS Code 的 settings.json:
{
"terminal.integrated.defaultProfile.windows": "Command Prompt",
"editor.formatOnSave": true,
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.codeActionsOnSave": {
"source.fixAll.ruff": "explicit",
"source.organizeImports.ruff": "explicit"
}
},
"python.analysis.typeCheckingMode": "basic"
}
配置说明:
| 配置 | 作用 |
|---|---|
terminal.integrated.defaultProfile.windows |
Windows 默认使用 CMD 终端 |
editor.formatOnSave |
保存文件时自动格式化 |
editor.defaultFormatter |
Python 文件使用 Ruff Formatter |
source.fixAll.ruff |
保存时执行 Ruff 可自动修复的问题 |
source.organizeImports.ruff |
保存时整理 import 顺序 |
python.analysis.typeCheckingMode |
Pylance 使用基础类型检查 |
上述 Ruff 配置需要安装 Ruff 扩展。
先在项目虚拟环境中安装 Ruff:
python -m pip install ruff
然后确认 VS Code 已安装:
Ruff
扩展。
手动执行代码检查:
ruff check .
手动格式化:
ruff format .
自动修复部分问题:
ruff check . --fix
python main.py
带参数运行:
python main.py --mode test
打开 Python 文件后,可以点击右上角的运行按钮:
Run Python File
注意确认右下角已选择正确的 .venv 解释器。
最简单的方式:
打开需要调试的 Python 文件;
在行号左侧单击,添加断点;
按下 F5;
选择:
Python File
常用调试快捷键:
| 快捷键 | 操作 |
|---|---|
F5 |
开始或继续调试 |
Shift + F5 |
停止调试 |
F10 |
单步跳过 |
F11 |
单步进入 |
Shift + F11 |
单步跳出 |
F9 |
添加或删除断点 |
launch.json:带参数调试如果经常需要带参数运行,可在项目目录创建:
.vscode/launch.json
示例:
{
"version": "0.2.0",
"configurations": [
{
"name": "Python:当前文件",
"type": "debugpy",
"request": "launch",
"program": "${file}",
"console": "integratedTerminal",
"args": [
"--mode",
"test"
]
}
]
}
执行调试时,程序等同于:
python current_file.py --mode test
如果某些配置只适用于当前项目,可以在项目中创建:
.vscode/settings.json
示例:
{
"editor.formatOnSave": true,
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff"
},
"python.analysis.typeCheckingMode": "basic"
}
全局设置适合个人固定习惯;工作区设置适合项目特定要求。
通常是 VS Code 选择了错误的 Python 解释器。
执行:
Ctrl + Shift + P
→ Python: Select Interpreter
→ 选择 .venv 对应的 Python
随后确认:
python -c "import sys; print(sys.executable)"
检查右下角解释器是否指向项目 .venv。
必要时关闭当前终端,重新打开一个新终端,再执行:
python -c "import sys; print(sys.executable)"
import 报红,但程序实际可以运行通常也是 Pylance 使用的解释器与运行解释器不一致。
处理顺序:
选择正确解释器;
执行:
Developer: Reload Window
确认依赖安装在当前 .venv:
python -m pip list
确认:
已安装 Ruff 扩展;
已在当前环境安装 Ruff:
python -m pip install ruff
settings.json 中包含:
{
"editor.formatOnSave": true,
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff"
}
}
.venv 时报权限错误可以改用 Command Prompt:
.venv\Scripts\activate.bat
或按需调整当前用户的执行策略:
Set-ExecutionPolicy -Scope CurrentUser RemoteSigned