写在前面
对于代码来说,读取频率远远大于编写。 ——Guido
所以我们在写代码的时候要有良好的代码习惯,关于Python的大家可以先看一下这两个文档:
然后呢要我们自己自觉的遵守可能会在不经意的时候出现错误,所以我们需要一些工具的小小的帮助。人之所以强大就是会使用工具。
使用工具
我在这里会写到三个我经常使用的工具,使用都还比较简单。
Pycharm
Pycharm是经常用到的一个编辑器,然后里面有关于代码格式化的一些提示,你在书写代码的时候如果不合规则那么就会出现提示,就像是这样:
代码格式错误提示这有助于我们在写的时候从源头上减少格式问题,如果是已经写了呢?我们可以使用Ctrl +Alt +L来快速代码格式化,就像是这样:
格式化后的效果
提示:如果你使用了TIM或者是QQ,记得修改热键,不然会出问题。
用起来是不是很简单,但是这个的格式化效果并不彻底,只是一些基础的问题,基本上在写代码的时候注意一下就可以避免这些问题。
YAPF
什么是yapf?
YAPF 是Google 开发的一个用来格式化Python 代码的工具。
安装:
pip install yapf
安装好后就可以开始使用了,我们来看一下它常用的参数:
-h | - help显示此帮助消息并退出 |
---|---|
-v | - version显示版本号并退出 |
-d | - 显示你的代码和标准的区别并给出修改意见 |
-i | - in- place对文件进行更改 |
-r | - 递归以递归方式运行目录 |
-l START-END- lines START-END | 行重定义行的范围,从一开始 |
-e PATTERN | - 排除要从格式中排除的文件的PATTERN 模式 - |
我们在使用的时候加上参数可以帮我们达到想要的效果,试几个参数:
yapf支持两种格式,Pep8和Google的格式,更多的你还可以自己设置,更多的知识请你移步它的官方文档:
yapf的GItHub仓库
pylama
安装:
pip install pylama
然后可以很方便的使用,在命令行中输入pylama加上文件或者是文件夹,她会显示你不合规范的地方在哪,结合修改就好。
https://github.com/klen/pylama
网友评论