Vscode Python Workspace 设定流程
这里记录一下,使用 vscode 编写一个 Python 项目时,个人觉得比较舒服的配置方法:
预先准备
首先保存项目文件夹为工作区,获得 xxx.code-workspace
文件,以后通过它打开工作区。
禁用不需要的插件。
一些重要的 Python 插件需要安装:
- black formatter:linter
- isort: 对导入排序
- mypy: 类型检查(可以根据类型提示进行静态类型检查,不过不是很聪明……可选)
Python 虚拟环境
使用虚拟 python 环境可以把项目的依赖项安装到项目文件夹下,不会“污染”电脑本身的 python 软件库 🐒
打开工作区后,ctrl+shift+p
运行创建虚拟环境的命令,或者手动创建[1],下面是通过 vscode 创建虚拟环境的步骤。
实际上是运行了命令 /bin/python3 -m venv --without-pip .venv
,这里存在一个问题,可能会由于网络原因卡在安装 pip 的步骤。
所以还是推荐手动创建虚拟环境,使用 virtualenv .venv
创建环境。
从右下角选择解释器,选择“在工作区级别选择”,之后可以选择创建好的虚拟环境。
配置任务
可以配置一些常用任务,例如使用 pipreqs
更新项目依赖项,因此在 xxx.code-workspace
中设置一些 Task,最终配置内容如下:
(这里设置了每次打开工作区,自动执行 requirements.txt
的更新)
2023.10.23 update: pipreqs 我直接在命令行打了,也没有很麻烦……
{
"folders": [
{
"path": "."
}
],
"settings": {
"python.defaultInterpreterPath": ".venv/bin/python"
},
"tasks": {
"version": "2.0.0",
"tasks": [
{
"label": "requirements",
"type": "shell",
"command": "pipreqs",
"args": [
".",
"--savepath",
"requirements.txt",
"--encoding=utf-8",
"--force",
"--mode",
"no-pin"
],
"options": {
"cwd": "${workspaceFolder}/"
},
"presentation": {
"reveal": "never",
"panel": "dedicated",
"showReuseMessage": false,
"clear": false
},
"runOptions": {
"runOn": "folderOpen"
}
}
]
}
}