“”“

全网最详细的使用说明,转发敬之!!!

“””

VS Code 是免费开源的工具,并且是微软旗下产品,如果能够媲美 PyCharm 的话,也不失为一个良好的选择。

VS Code是一个相当优秀的 IDE ,具备开源、跨平台、模块化、插件丰富、启动时间快、颜值高、可高度定制等等优秀的特质,最近几年流行度也是越来越高。

今天来跟大家分享下在 VS Code 下配置和使用 Python,作为对 PyCharm 的替代选择之一。

01 软件准备

既然是在 VS Code 中进行 Python 环境配置,在配置之前需要安装好 Python 和 VS Code。

Python 安装

关于 Python 的安装,可以从 Python 官网下载 Python 进行安装,也可以通过 ​​Anaconda​​​ 来安装,Lemon 建议直接安装 ​​Anaconda​​ 。

​Anaconda​​​ 是一个开源的 Python 发行版本,其包含了 ​​conda​​、Python 等 100 多个科学包及其依赖项。

​Anaconda​​ 官方网站下载地址如下:

​https://www.anaconda.com/products/individual​

在 编写此文时,Anaconda 对应的 Python 版本是 Python 3.8,大家可以下载跟电脑系统对应的版本进行安装。

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进Anaconda

VS Code 安装

关于 VS Code 安装,在微软官方网站:https://code.visualstudio.com/ 提供免费下载,VS Code 支持 Windows , Linux , Mac OS 三种操作系统,建议去官方下载,不要在第三方软件下载网站下载,第三方软件下载站的猫腻太多了。

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_02VS Code 官网

02 在终端运行程序

在没有安装其他 Python 插件的情况下,可以在 VS Code 中通过使用终端 (Terminal)直接运行 python 代码,使用这种方式,可以省去配置过程。

在 VS Code 菜单栏选择 "view - Terminal" (中文菜单:查看—终端),或者直接快捷键 「 Ctrl + ` 」 打开终端,会在下方产生一个 CMD 控制台。

可以在终端中通过输入 ​​python xxx.py​​ 来运行程序,效果如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_03

需要注意一下的是,当前的文件夹是否和Python脚本文件处于同一个目录,如果不在同一个目录则要 cd 进去。

03 Python 环境配置

Python插件

在 VS Code 中配置 Python 环境,第一个要安装的插件,就是 ​​Python​​ 插件。

​Python​​​ 插件的全称是 ​​Python extension for Visual Studio Code​​,它是一个 Visual Studio Code 扩展,具有对 Python 语言的丰富支持(对于该语言的所有受支持版本:> = 3.6),包括诸如 IntelliSense,linting,调试,代码导航,代码格式,Jupyter Notebook 支持,重构,变量之类的功能资源管理器,测试资源管理器,代码段等等!

VS Code超详细Python配置指南,看这一篇就够了[转]_高亮_04 VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_05

​Python​​​ 插件对 Jupyter Notebook 的支持建立在安装 ​​Jupyter​​ 插件的基础上,这个在本文后续会提到。

代码补齐

在 VS Code 插件市场中有多个代码补齐的工具,这里 Lemon 还是推荐 ​​Pylance​​ 。

​Pylance​​​ 是微软推出的一个快速而且功能丰富的Python语言扩展。​​Pylance​​ 于 2020年7月发布,目前在 VS Code 市场中,安装量已有 60多万,足见其关注度。

VS Code超详细Python配置指南,看这一篇就够了[转]_python_06

​Pylance​​ 主要有如下特性:

  • Docstrings
  • 参数提示
  • 自动导入
  • 代码补全
  • 代码诊断
  • 引用和跳转
  • 代码大纲
  • 类型检查
  • 支持多工作区
  • 带有类型信息的签名帮助
  • 兼容 IntelliCode 和 Jupyter notebook

安装后,代码输入效果如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_07

需要运行 Python 程序时,可以在程序文件(​​py文件​​​)里右键,选择 ​​Run Python File in Terminal​​ 来运行程序,或者 点击右上角的绿色三角形来运行程序,演示如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_python_08

自动格式化代码

Yapf 是谷歌开源的一个用于格式化 Python 代码的工具,可以一键美化代码。支持两种规范:​​PEP8​​​ 和 ​​Google Style​​ 。

在 VS Code 中使用 ​​yapf​​ 需要先安装该工具,步骤如下:

step 1: 打开终端,输入 "pip install yapf", 安装 ​​yapf​​ ,如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_09在终端安装yapf

step 2: 在设置中设置使用 ​​yapf​​,具体设置过程如下:

在 VS Code 左下角点击设置按钮,选择 “Settings”,如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_python_10

在下面界面的右上角点击箭头所示,转到 ​​settings.json​​,

VS Code超详细Python配置指南,看这一篇就够了[转]_python_11

在 ​​settings.json​​ 里进行设置 "python.formatting.provider": "yapf", 图示如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_高亮_12

step 3: 完成上述设置后,就可以对代码格式进行自动格式化了,快捷键是 Alt+Shift+F 。

下面是代码自动格式化演示的效果:

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_13

Jupyter Notebook 支持

众所周知,python 代码,除了通常使用的 ​​.py​​​ 文件外,对于数据科学而言, Jupyter Notebook 也是大家的重要选项,因此,VS Code 中也提供了 Jupyter Notebook 的支持插件,在 VS Code 扩展市场中的名称是 ​​Jupyter​​,如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_python_14

在安装 ​​Jupyter​​​ 插件之后, Jupyter Notebook 的 ​​ipynb​​ 文件打开后的效果如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_python_15

高亮缩进

当代码缩进层次较多时,为了视觉上容易识别,一般希望可以多个缩进以不同颜色进行高亮显示, VS Code 中 ​​indent-rainbow​​ 插件可以实现这个功能。

VS Code超详细Python配置指南,看这一篇就够了[转]_高亮_16

在安装之前,代码的效果如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_17

在安装 ​​indent-rainbow​​ 之后,代码的效果如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_python_18

括号高亮

当代码层次很多时,除了缩进的效果外,还有一个经常遇到的情况,就是各类括号,包括 ​​()​​​ 、​​[]​​​、​​{}​​​ ;VS Code 中 ​​Bracket Pair Colorizer​​ 插件可以列出来括号高亮的效果,尤其是多组嵌套括号。

VS Code超详细Python配置指南,看这一篇就够了[转]_python_19

在安装 ​​Bracket Pair Colorizer​​ 之后,代码的效果如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_python_20

注释高亮

Lemon 在这里还推荐一个插件,这个插件用于程序语言编写时对注释的高亮。

咱们在编写程序的时候,总会涉及一些需要注意或者后续继续完成,或者需要提醒团队其他人员的注释内容,因此,有必要在代码中进行不同的说明,这个时候,在注释中进行不同的高亮,就会有很好的效果。

VS Code 扩展市场中,提供了 ​​Better Comments​​ 等类似的插件,来高亮注释。

VS Code超详细Python配置指南,看这一篇就够了[转]_高亮_21

在 ​​Better Comments​​​ 插件中, 有 5 中类型的注释高亮,分别用符号 ​​* ? ! // todo​​ 来区分,示例效果如下:

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_22

VS Code 中还有许多优秀的插件,欢迎大家来留言区推荐你最喜欢的插件或编辑工具!



接下来点击文件下面的新建文件,如下图所示

VS Code超详细Python配置指南,看这一篇就够了[转]_高亮_23

4、然后选择语言版本为python,如下图所示

VS Code超详细Python配置指南,看这一篇就够了[转]_高亮_24

5、接着输入python语言,如下图所示

VS Code超详细Python配置指南,看这一篇就够了[转]_python_25

VS Code超详细Python配置指南,看这一篇就够了[转]_python_26

6、最后右键文件,选择run code即可运行了

VS Code超详细Python配置指南,看这一篇就够了[转]_高亮_27

也可以进行保存,保存时输入文件名。

综上所述,在vs code中创建并运行python文件,需要先安装python扩展,然后在创建python文件。

运行Hello World

使用Python运行​​hello.py​​很简单。 在编辑器中单击鼠标右键,然后选择“在终端中运行Python文件” (自动保存文件):

VS Code超详细Python配置指南,看这一篇就够了[转]_高亮_28

该命令打开一个终端面板,在其中自动**Python解释器,然后运行​​python3 hello.py​​​ (macOS / Linux)或​​python hello.py​​ (Windows):

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_29

在VS Code中可以运行Python的另外两种方法:

  • 选择一行或多行,然后按Shift + Enter或右键单击并选择在Python终端中运行选择/行。 此命令非常便于测试文件的一部分。
  • 使用Python:Start REPL命令打开当前所选Python解释器的REPL终端。 然后,在REPL中,您可以一次输入和运行一行代码。

配置并运行调试器

现在让我们尝试调试我们的简单Hello World程序。

首先,通过将光标放在​​print​​​调用上并按F9 ,在​​hello.py​​的第2行设置断点。 或者,只需点击编号左边的排水沟旁边的排水沟即可。 排水沟中出现一个红色圆圈。

VS Code超详细Python配置指南,看这一篇就够了[转]_python_30

接下来,选择侧栏中的Debug View:VS Code超详细Python配置指南,看这一篇就够了[转]_python_31

然后选择调试工具栏上的设置图标(或使用Debug > Open configurations菜单命令):

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_32

片刻之后,该命令会创建一个​​launch.json​​文件,其中包含许多配置,这些配置显示在配置下拉列表中:

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_33

注意 :VS Code将JSON文件用于其所有各种配置; ​​launch.json​​是包含调试配置的文件的标准名称。

​调试配置​​中详细说明了这些不同的​​配置​​ ; 现在,只需选择Python:当前文件(Integrated Terminal) ,这是使用当前选择的Python解释器运行编辑器中显示的当前文件的配置。

要在程序启动时自动停止第一行的调试器,请在​​"stopOnEntry": true​​中为“Python:Current File”配置添加​​"stopOnEntry": true​​设置,以便整个配置如下所示:

{ " name ": "Python: Current File (Integrated Terminal)" , " type ": "python" , " request ": "launch" , " program ": "${file}" , " console ": "integratedTerminal" , " stopOnEntry ": true },

提示:如果需要指定包含要用于调试的解释器的确切文件夹, ​​pythonPath​​在配置中包含​​pythonPath​​的条目,例如​​"pythonPath": "${workspaceFolder}"​​或​​"pythonPath": "${workspaceFolder}/.venv"​​ 。

保存​​launch.json​​​ ,在编辑器中切换到​​hello.py​​​ ,然后通过选择Debug工具栏中的绿色箭头或按F5运行调试器。 由于​​stopOnEntry​​设置为true,因此调试器会在文件的第一行停止。 当前行在左边距中用黄色箭头表示。 如果此时检查“ 局部变量”窗口,则会看到只定义了自动dunder变量:

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_34

顶部显示一个调试工具栏,其中包含从左到右的以下命令:继续( F5 ),跳过( F10 ),步入( F11),退出( Shift+F11 ),重启( Ctrl+Shift+F5 ),然后停止( Shift+F5 )。

VS Code超详细Python配置指南,看这一篇就够了[转]_python_35

状态栏还会更改颜色(许多主题中为橙色)以指示调试模式。 Python调试控制台也会自动出现在右下方面板中,以显示与程序输出一起运行的命令。

要继续运行程序,请在调试工具栏上选择继续命令( F5 )。 调试器将程序运行到下一个断点。 现在定义的​​msg​​变量显示在“ 本地”窗格中

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_36

您还可以在调试控制台中使用变量(如果您没有看到它,请在VS Code的右下方区域选择Debug Console,或从...菜单中选择它。)然后尝试输入以下行,一个一,在控制台底部的>提示符下:

msg msg.capitalize() msg.split()

VS Code超详细Python配置指南,看这一篇就够了[转]_缩进_37

再次选择绿色箭头以运行程序完成。 如果切换回它,则“ Python Hello Console ”中会出现“Hello World”,一旦程序完成,VS Code将退出调试模式。

如果重新启动调试器,请记住在配置中设置​​stopOnEntry​​ ,以便在运行任何代码之前调试器停止。 要一直运行到第一个断点,请从配置中删除该条目。

要在程序完成之前停止运行程序,请使用调试工具栏上的红色方块停止按钮( Shift+F5 ),或使用Debug> Stop debugging菜单命令。

有关完整的详细信息,请参阅​​调试配置​​ ,其中包括有关如何使用特定Python解释器进行调试的详细信息。

提示:使用Logpoints而不是print语句 :开发人员经常使用print语句丢弃源代码,以快速检查变量,而无需逐步调试调试器中的每行代码。 在VS Code中,您可以改为使用Logpoints 。 Logpoint就像一个断点,除了它将消息记录到控制台并且不会停止程序。 有关更多信息,请参阅主VS Code调试文章中的​​Logpoints​​ 。

故障排除

如果由于某种原因VS Code不为您生成​​launch.json​​ ,请在项目文件夹中创建​​.vscode/launch.json​​文件(如果需要,创建​​.vscode​​文件夹),然后将以下内容粘贴到​​launch.json​​ :

{ " version ": "0.2.0" , " configurations ": [ { " name ": "Python: Current File (Integrated Terminal)" , " type ": "python" , " request ": "launch" , " program ": "${file}" , " console ": "integratedTerminal" }, ] }

如果你看到如下所示的“SyntaxError:invalid syntax”,你试图在​​launch.json​​当前在编辑器中显示时启动调试器,这不是像​​hello.py​​这样的Python代码:

// Use IntelliSense to learn about possible attributes. ^ SyntaxError: invalid syntax

选择​​hello.py​​然后重试。 或者,通过在​​configuration​​数组中的​​launch.json​​添加以下行,专门为​​hello.py​​文件创建调试配置。 然后在调试器下拉列表中选择此配置并再次启动调试器。

{ " name ": "Python: hello.py" , " type ": "python" , " request ": "launch" , " program ": "${workspaceFolder}/hello.py" , " console ": "integratedTerminal" },

安装和使用包

现在让我们举一个更有趣的例子。 在Python中,包是通过​​PyPI​​获取任意数量的有用代码库的方式。 对于此示例,您可以使用​​matplotlib​​和​​numpy​​包来创建与数据科学相同的图形绘图。 (请注意,matplotlib在Windows子系统Linux中运行时无法显示图形,因为它缺少必要的UI支持。)

返回Explorer视图(左侧最顶部的图标,显示文件),创建一个名为​​standardplot.py​​的新文件,并粘贴以下源代码:

import matplotlib.pyplot as plt import matplotlib as mpl import numpy as np x = np.linspace( 0 , 20 , 100 )

提示 :如果您手动输入上述代码,您可能会发现当您在行尾按Enter键时,自动完成会更改​​as​​关键字后面的名称。 要避免这种情况,请键入空格,然后按Enter键。

接下来,尝试使用“Python:当前文件”配置在调试器中运行该文件,如上一节中所述。 (如果仍然有​​"stopOnEntry": true​​在该配置中为​​"stopOnEntry": true​​ ,则需要再次选择run命令才能继续。)

除非您使用Anaconda发行版或之前已安装​​matplotlib​​包,否则您应该看到消息“ModuleNotFoundError:No module named'matplotlib'”。 此类消息表明您的系统中没有所需的软件包。

要安装​​matplotlib​​软件包(它还将​​numpy​​安装为依赖项),请停止调试器并从命令选项板运行终端:创建新的集成终端 ( Ctrl+Shift+` ))。 此命令将打开所选解释器的命令提示符。 然后根据您的操作系统输入以下命令(如果Python解释器安装在文件系统的受保护区域,则命令可能需要提升):

注意 :如果您无法安装软件包或遇到其他问题,请​​在GitHub上提出问题,​​以便我们帮助您进行调查。

现在重新运行程序(带或不带调试器),片刻之后会出现一个带有输出的绘图窗口:

 VS Code超详细Python配置指南,看这一篇就够了[转]_python_38