让你的代码符合PEP8标准——sublime text 2 安装及使用 Python Flake8 Lint 插件

上周看到一个招Python工程师的要求，其中有一条就是要求代码符合PEP8标准。

PEP8标准之前就听说过，是Python官方推荐的一个代码标准。并不是强制要求，只是推荐大家使用，增加代码可读性。

因为我的代码一直都是自己写自己看，所以也就没有考虑PEP8。不过看到这个招聘要求，感觉自己还是应该学习一下，毕竟以后代码会有别人看，规范一点方便自己也方便他人嘛。

一、PEP8标准

首先了解一下什么是PEP8标准吧。

点击这里可以查看官方的PEP8详细要求。是英文版，大家如果阅读起来比较吃力的话可以自己去搜中文版。

看完标准之后，大家会发现，具体细节要求非常多。。。对于一个初次接触PEP8标准的人来说，如果只靠自己的判断来修改的话不仅不准确而且效率很低，所以我们自然就想到了使用插件。

二、安装及配置Python Flake8 Lint插件

我使用的是sublime text 2，这个编辑器挺对我胃口的，所以就去github上找了一下sublime text 2上的PEP8插件。找了有两三个吧，最后准备使用：

Python Flake8 Lint

下面就说一下安装步骤吧。

首先，点击页面中的按钮下载ZIP压缩包，然后解压并把文件夹的名字改为：Python Flake8 Lint 。

改完名之后，按照你使用的系统把这个文件夹复制到对应的路径里：

• OS X:

~/Library/Application Support/Sublime Text 2/Packages/

• Linux:

~/.config/sublime-text-2/Packages/

• Windows:

%APPDATA%/Sublime Text 2/Packages/

我用的是mac，所以就复制到“~/Library/Application Support/Sublime Text 2/Packages/”这个目录当中。

复制好之后，打开st2，点击"Preferences" -> "Package Settings" -> "Python Flake8 Lint" -> "Settings - Default"，会自动打开一个文件。我们把这个文件的内容全选然后复制，然后打开"Preferences" -> "Package Settings" -> "Python Flake8 Lint" -> "Settings - User"，会自动打开一个空文件，我们把刚才复制的内容粘贴进去，这时候就可以进行设置了。

具体的设置我就不介绍了，大家看注释就明白了，我说一下ignore这项吧。

因为我不太赞同PEP8里关于一行不超过79个字符的规定，所以我决定忽略这条规则。于是我在ignore后面的[]中加上对应的编号W191（后面讲如何获取编号），这时代码变成了 "ignore": ["W191"], 保存之后就可以生效了。

对了，因为不需要flake8的检测，所以我把"pyflakes": false,这个设置成了false。

三、插件的使用

插件的使用很简单，有两种方式触发。第一种是保存的时候会自动触发，第二种是按下“ctrl+花键+8(mac)”或者“ctrl+alt+8”来触发。

触发之后会自动检测代码，如果有不符合PEP8的地方会出现一个列表框，如图：

大家可以看到中间那个列表框就是错误信息。

前面说到一行79个字符对应的编号是W191，这里就要揭秘这个编号是怎么来的了。

其实很简单，大家看列表框里错误信息的开头，看到了吧~~~那个就是对应的编号。

你想忽略哪一条就把对应的编号加入到ignore里就可以了。

如果大家对错误信息不是很清楚的话可以结合PEP8标准来看，基本上信息已经很清楚了，照着改就好了。

 

还有一个小技巧：点击错误信息会自动跳转到那一行。

四、总结

这个插件还是挺好用的，挺方便。

我安装上之后，用了一个小时时间把我的浪漫1点的Python代码全部改成了符合PEP8标准的代码，感觉看起来确实舒服了很多。

以后的Python项目准备全部符合PEP8标准。