企业项目管理、ORK、研发管理与敏捷开发工具平台

网站首页 > 精选文章 正文

VsCode Python插件配置最佳实践——搞定配置只需要三步

wudianyun 2025-02-26 14:08:01 精选文章 28 ℃

工欲善其事,必先利其器。

背景

近期在我们组的新进来同学,之前用的学生邮箱注册的一些小伙伴 PyCharm 原来的授权逐渐过期,免费开源的 VsCode 越来越成为 python 开发者的首选,他们都在我的蛊惑下转到VsCode进行开发,在实际使用过程中,配置 VsCode Python环境不是那么容易正常工作起来。

另外本来团队平时是以 Go 语言开发为主,但有些 cms 或者定时任务脚本还是用 Python 写的,时不时还是要使用 Python 进行开发,一些老鸟也沉陷其中,不能自拔。

本文根据在实际使用过程中,经过反复摸索,最终总结了三步,可以彻底搞定 VsCode Python 开发环境配置。

前提:你的电脑已经安装好 Python3 环境

具体步骤

步骤1:必需的 VsCode 插件安装

Pyhton
PyLance

上面2个插件都是由微软开发,支持的效果比较好。PyLance是 Python Languase Server,提供编辑器的主要方法提示,跳转等功能。

步骤2:自动格式化代码配置

安装Yapf,它是由 Google 开发的一款开源 Python 代码格式工具,全称为 Yet Another Python Formatter ,官方仓库为 GitHub - google/yapf: A formatter for Python files。

安装方法,在终端执行下面的命名即可全局安装。

pip install yapf 

步骤3:打开全局settings.json文件

打开后,在合适的位置加上下面2个配置项:

"python.languageServer": "Pylance",
"python.formatting.provider": "yapf",

也串可以用ctrl+, 打开可视化配置



经历上面三步,基本的配置就完毕了,重启一下vscode,应该可以正常工作了。

可能遇到的问题

有的项目需要指定 PYTHONPATH环境变量才能工作

vscode有两个重要的配置文件:launch.json和settings.json。launch.json是使用VS Code运行调试程序的启动设置,包括设置环境变量,使用哪个解释器,debug类型以及程序入口等等。settings.json是VS Code程序的设置选项,包括快捷键,插件设置等等。

我们可以在launch.json文件中添加env相关的属性,

示例参考

{

"name": "Python: 当前文件",

"type": "python",

"request": "launch",

"program": "${file}",

"console": "integratedTerminal",

"env": {"PYTHONPATH":"${workspaceFolder}"},

}

`
也可以通过 direnv 插件来设置,这个可以自行搜索使用就可以了。

最后

如果你安装有任何问题,可留言交流。

最近发表
标签列表