python coding style guide 的快速落地实践
机器和人各有所长,如coding style检查这种可自动化的工作理应交给机器去完成,故发此文帮助你在几分钟内实现coding style的自动检查。
1.有哪些著名的Python Coding Style Guide
- PEP8
https://www.python.org/dev/peps/pep-0008/
发明Python语言丰碑人物Guido van Rossum的亲自写的Coding Style, 知名度5颗星,可操作性5颗星。
- Google Python Coding Style Guide
http://google-styleguide.googlecode.com/svn/trunk/pyguide.html
Google内部广泛使用Python作为开发语言,此Coding Style 在坊间流传很广,知名度5颗星,可操作性5颗星。值得一提的是Guido也曾经在Google工作过一段时间。
2.Flake8 - Coding Style检查自动化
的利器
你可能听说过pep8,这是一个根据PEP8
规范检查python代码style的自动化工具。flake8
是对pep8
进行了包装,充分发挥了插件化的优势,增加了如代码复杂度,函数、变量命名习惯,import顺序等检查。
2.1 安装Flake8
安装flake8,同时安装一些有用的插件。
- pep8-nameing
https://github.com/PyCQA/pep8-naming
命名检查
- flake8-import-order
https://github.com/public/flake8-import-order
import 顺序检查,可以有两种风格顺序检查cryptography, google。如google
的意思是import顺序是(1)标准库(2)第三方库(3)本地项目库。代码检查时可以通过--import-order-style=google
来指定。
- flake8-todo
https://github.com/schlamar/flake8-todo
检查代码中的todo。
- flake8-quotes
https://github.com/zheller/flake8-quotes/
检查单双引号的使用是否正确。
具体安装命令如下:
$ pip install flake8
$ pip install pep8-naming
$ pip install flake8-import-order
$ pip install flake8-todo
$ pip install flake8-quotes
检查安装了哪些插件: