Please enable Javascript to view the contents

vscode配置Python开发环境

 ·  ☕ 7 分钟

Python是世界上最好的编程语言,Vscode是宇宙最强编辑器,你把这两个结合起来是什么?必须是左青龙右白虎,整条gai最靓的仔。

vscode配置python开发环境主要内容有:

  1. 安装python解释器
  2. 验证 Python环境
  3. vscode安装python插件
  4. vscode选择python解释器
  5. 运行 Python 文件
  6. 代码格式化
  7. 代码调试
  8. 配置python虚拟环境
  9. vscode中使用jupyter notebook

1 安装 Python 解释器

安装python的方式有:

  1. 官网下载安装 Welcome to Python.org
  2. 微软商城下载 win 10 电脑可以微软应用商店下载python. (微软真是啥都往商店里放,不理解的是xbox one游戏机安装python干什么用,区域又不支持)
  3. 安装Anaconda Anaconda | The World’s Most Popular Data Science Platform 如果使用Python主要是为了做与数据科学相关的工作,那么你可以考虑通过Anaconda进行下载安装。除了Python解释器,Anaconda还包含了许多用于数据科学的依赖库和工具及conda,conda既是软件包管理,又是环境管理器。
  4. Windows Subsystem for Linux(WSL,Windows的Linux子系统) 如果你在Windows系统下进行Python开发,但又想要拥有Linux的开发环境,则可以选择使用Windows Subsystem for Linux进行Python开发。

2 验证 Python环境

在macOS/Linux下,在命令行中输入以下命令。

python3 --version

在Windows下,在命令行中输入以下命令。

py -3  --version

如果安装了多个版本的Python,则可以在命令行中输入py -0来查看所有安装的Python版本。默认的解释器会被标上星号(*)。


3 安装 Python 插件

打开vscode插件面板,搜索python,找到微软出品的python插件,点击安装即可。


4 选择 Python 解释器

Python是一门解释型语言,为了能够运行Python代码,我们需要告诉VisualStudio Code使用哪一个Python解释器。

启动vscode,通过Ctrl+Shift+P打开命令面板,然后输入并执行Python:Select Interpreter命令。

如上图,vscode会自动列出了当前机器上所有可用的Python解释器。其中,后缀为(‘base’:conda)的是Anaconda的Python解释器。

选择一个适用的python.exe之后,vscode会将python.exe的路径存储在工作区设置里。位于项目根目录的.vscode文件夹内的settings.json文件。你也可以直接修改python.pythonPath该路径。

同时vscode蓝色状态栏左下角也会显示python解释器版本,如上图 Python 3.8.5 32-bit,点击将弹出Python解释器选择对话框,可重新选择Python解释器版本。


5 运行 Python 文件

通过vscode打开某项目文件夹,新建hello.py文件,随意打印一些字符串,单击右上角的绿色运行按钮即可执行该python文件。

通过终端可以看到,执行过程是先找到解释器的绝对路径,再找到hello.py的绝对路径,最后输出执行结果。

以下操作与绿色执行按钮效果一样:

在文件编辑区域的右键菜单中选择“在终端中运行python文件”命令。

在文件资源管理器中右键单击一个Python文件,然后在弹出的菜单中选择“在终端中运行python文件”命令

在编辑区域的右键菜单(以及文件资源管理器右键)中,选择Run Current File in Python InteractiveWindow命令,会打开一个Python交互式窗口,并执行Python文件中的代码。


6 代码格式化

Python插件支持3种Python代码格式化工具:autopep8(默认使用)、black及yapf。

在python文件中按 Shift + Alt + F可以格式化文档,如果未安装相关的格式化工具,vscode 将提示安装。

同样,可以通过修改工作区.vscode setting.json中python.formatting.provider设置项配置使用哪一个代码格式化工具。

代码格式化效果如下


7 代码调试

对于一个简单的Python项目,Python插件支持一键调试,无须任何额外配置。

首先,打开你需要调试的Python文件,在相应的代码行处按下F9快捷键添加断点,或者单击编辑区域左侧的边槽添加断点。添加断点后,左侧的边槽会出现一个红色圆点。

打开左侧debug面板,点击运行和调试。

选择Python File,即可进入当前文件的调试界面。

对于一些更复杂的项目,需要创建调试配置,以便后续进行定制化调试。

Visual Studio Code的调试配置存储在.vscode文件夹的launch.json文件中。切换到调试视图,单击“创建launch.json文件”链接。

同样,需要根据你的项目,在Python File、Django、Flask等中选择一个。

这里只是为了说明,选择Python File。Python插件会在.vscode文件夹中创建并打开一个launch.json文件,它定义了调试所需要的配置。

简单解释一下launch.json各配置项:

  • name 用来命名配置名称的,因为在configurations列表中可以定义多个配置,不同的配置命名要相互区分。
  • type和request是必须项,在不同的配置中都要存在的,而它们的值也是固定的。“type”: “python” , “request”: “launch”。
  • program,用来指定项目运行时的入口文件的,其中${file}表示当前文件,${workspaceFolder}表示项目根目录,对于django项目来说,入口文件应该是项目根目录下的manage.py文件,所以可以配置为"program": “${workspaceFolder}\\manage.py”。
  • consloe,用来指定程序的输出在哪里。integratedTerminal 表示vscode的集成终端;internalConsole 表示 vscode 调试控制台;externalTerminal 表示 操作系统终端。

Django应用调试配置如下:

args设置项用来指定传给Python程序的参数。每一个以空格分割的参数都需要以数组的形式来定义。

一般我们运行django项目的命令是: python manage.py runserver 0.0.0.0:8080

这个命令分为两部分,第一部分是python解释器,已经在settings.json里设置了,剩下的参数manage.py runserver 0.0.0.0:8080我们需要在launch.json中设置。

其中manage.py 交给了program 配置项,runserver 0.0.0.0:8080 等交给args。


8 虚拟环境配置

在实际项目开发中,不同项目使用的框架库并不一样,或使用框架的版本不一样。这意味着一个Python安装可能无法满足每个应用程序的要求。如果应用程序A需要特定模块的1.0版本但应用程序B需要2.0版本,则需求存在冲突,安装版本1.0或2.0将导致某一个应用程序无法运行。

这个问题的解决方案是创建一个 虚拟环境(virtual environment),一个目录树,其中安装有特定Python版本,以及许多其他包。

创建虚拟环境的工具主要为:

以conda为例子,创建一个python38的python环境

通过vscode打开python项目文件夹,在终端运行 conda activate python38 即可激活该环境。

图中红色线框内的(python38)即为当前环境标识符。


9 在vscode中使用Jupyter Notebooks

Jupyter Notebook是基于网页的用于交互计算的应用程序。其可被应用于全过程计算:开发、文档编写、运行代码和展示结果。——Jupyter Notebook官方介绍

开发Jupyter Notebook需要使用Anaconda环境,或者使用安装了jupyter pip包的Python环境。

使用快捷键Ctrl+Shift+P打开命令面板,然后输入并执行Python:Create NewBlank Jupyter Notebook,就能创建一个新的Jupyter Notebook文件。

参考资料

分享

码中人
作者
码中人
Web Developer