1、背景
代码规范化是开发一致性很重要的一步,平常比较注意CPP、PHP、前端代码的规范化,补充下python代码的规范化工具
2、事前准备
对python代码规范化一般是采用flake8,flake8是一款python代码规范扫描工具。
为了在本地进行针对flake8的代码自动格式化,需要先在本地安装flake8,(前提是本地有安装python)。
有两种方法安装,一种是直接命令行使用pip安装(推荐),另一种是借助vscode安装。
2.1、使用pip安装flake8
- 打开命令行窗口(同时按Win R,输入cmd)
- 输入:
python -m pip install flake8
,回车运行等待结果即可
【注意】前提是必须将python的路径添加至环境变量。
运行完显示successfully
在vscode中打开设置,搜索python.linting.flake8enabled
,在Settings界面中勾选 【Whether to lint Python files using flake8】 来启用。
2.2、使用vscode安装flake8
在没有安装flake8的情况下,如果直接在设置中勾选启用,也会检测并提醒你安装:
- 在VScode中打开设置,搜索
python.linting.flake8enabled
- 在Settings界面中勾选 Whether to lint Python files using flake8
3. 此时右下角会弹框询问:Linter flake8 is not installed,点击Install安装,等待命令行运行成功即可。
3、安装代码格式化插件
此时当编辑python代码文件时,如果邮件文件选择【格式化文件】或者直接使用快捷键【Shift Alt F】,都会在右下角弹框提醒你没有对应插件,是否要安装。
vscode提供了三种插件,这里可以选择默认的autopep8安装:
vscode会通过命令行自动安装,等待运行完显示successfully
此时就可以通过快捷键【Shift Alt F】对python代码格式化了。
参考资料:
- python代码规范利器-Flake8
- vscode写python时的代码错误提醒和自动格式化的方法