Mac下搭建基于VSCode的Python开发环境

首先需要做的准备

1，安装VSCode
2，安装Python

VSCode安装Python扩展插件

在VSCode的扩展列表，搜索Python，安装即可。如图：

VsCode的Python插件

配置Python解释器
在VSCode的左下角，点击Python，然后上面弹框会提示你选择Python的解释器，选择哪个都可以（不过建议选择自己安装的那个）。如图：

点击Python 3.7.3

选红框里的那个

使用pip命令安装Python插件

【注意】在Windows下，配置了Python的环境变量之后，就可以直接执行pip命令。但是在Mac下，直接使用pip命令会提示指令不存在，需要到Python的安装目录的/bin 文件夹下，找到pip命令（或者会看到pip3 pip3.7）

pip list 可以查看当前以及安装的python插件。
pip install flake8 安装flake8，这是Python官方提供的静态代码规范检查工具。
pip install yapf 安装yapf，安装以后，在VSCode中，按Alt+Shift+F 可以自动格式化代码。

以上flake8和 yapf安装好了之后，还需要在设置中自己配置。
找到settings设置：
可以在项目左侧看到workSpace的setting.json，直接编辑即可。
想改全局的setting，可以在左上角 Code -> Prefercense -> Settings。

这里贴出部分设置。

// 将设置放入该文件，覆盖默认设置
{
    // lint python files using flake8.
    "python.linting.flake8Enabled": true,
    // 自定义设置
    "python.linting.flake8Args": [
        "--ignore=E262,E265,E266,E303",
        "--max-line-length=248"
    ],

    // provider for formatiing.
    "python.formatting.provider": "yapf",

    "python.pythonPath": "/Library/Frameworks/Python.framework/Versions/3.7/bin/python3"
}

PS：
由于flake8的静态代码检查，不通过会有一堆红线，对于有强迫症的孩子确实很难受，那么可以自定义设置flake8的检查设置，忽略部分告警，和修改部分检查规则。
可以在控制台执行：flake8 --help 来查看都有哪些配置。

这里贴出我使用的部分配置：
--ignore= 忽略部分代码规范的检查告警。
举个栗子：如果想配置忽略部分代码规范检查的告警，那么把鼠标停留在红线的代码处就会有提示如图：

flake8检查告警提示

这时候只需要把提示最后的那个编号，E265 追加到ignores= 后面即可。

--max-line-length=248 由于flake8检查的一行python代码最大长度太小，如果太长就会红色下划线告警，这里可以修改长度。

VSCode 设置

1）设置Tab为4个空格。
调出控制台：command + Shift + P
设置Tab为4个空格：控制台-> indent usingspace -> 设置为4

2）安装vscode-icons。
直接在VSCode的插件里，找到这个插件安装就好。该插件可以在文件列表用图标显示文件类型。

执行和调试Python代码

1）Debug模式执行当前文件。按F5。
2）执行选中代码，鼠标右键-> Run selection/Line in Python Terminal
3）执行当前文件全部代码，鼠标右键->Run Python File in Terminal
4）Debug文件。在VSCode左侧的Debug图标配置。（具体配置自己查吧）

小彩蛋
关于flake8 ignores，我目前整理出来的，可以自定选择是否忽略
E262,E265,E266,E303 是注释和空格相关的告警。
E226：在操作符前后必须加空格（例如 + - * / % ）操作
E231：在半角逗号（,）后必须加空格
E741：含糊不清容易令人误解的变量名

更多的话，可以查看Python的编程风格文档。

参考文档：
用VSCode写Python的正确姿势
 Google Python风格指南-中文版
 Python编码规范-菜鸟教程

最后编辑于：2019.04.29 17:47:59