06_Python代码编写PEP8规范

内容摘要： 写代码使用正确的缩进格式和变量命名有助于阅读，有时候看见变量名称或函数名字，就能大概理解函数意义，甚至不用去看文档，这种用户与程序员之间的心灵相通，往往是高手追求的境界。今天我们聊一聊Python世界中的PEP8规范。

1、PEP8规范是什么？

PEP8是Python世界中非常流行的编码规范之一。好的代码编写习惯，可以增加代码的可读性，这也是我们为什么要遵守规范的首要原因。关于PEP8的介绍很多，该规范主要从以下几个方面给出了Python代码编写建议：

• 代码缩进样式，包括每行长度
• 空格的使用方法
• 注释的规范性
• 变量的命名方法
• 编码的建议
• 文档的编写

PS：具体的规范内容太多了，感兴趣的百度吧！

2、能自动格式化吗？

如果自己没有按照PEP8规范编码，也没关系，可以找个工具来完成。Autopep8就是一个这样的工具，它按照pep8规范来决定代码中的那部分需要被排版，Autopep8可以修复大部分pep8工具中报告的排版问题。

安装方法如下：

pip install autopep8

运行方法（你的代码yourcode.py）：

autopep8 --in-place --aggressive --aggressive yourcode.py

打开代码看看，是不是排版更漂亮了？

3、养成好的习惯

我们团队在写代码时候的一些不成文规则：

• 类名称第一个字母大写，类方法全部小写，且采用snake命名原则，需要采用有意义的英文单词或简写，尽量避免拼音；

• 在类中，私有方法前面加下划线，不允许外部访问的类方法加两个下滑线；

• 尽量用类来归类不同功能的函数，建议通过定义类方法或静态方法实现；

• 完成不同功能的类放到不同的文件中，一个代码文件尽量不要超过2000行；

• 类的继承关系不要太复杂，继承关系尽量不超过3级；

• 初始化类的参数设置和保存要尽量支持JSON接口，数据支持HDF5格式；

• 尽量减小第三方库的依赖，对于小规模的三方库可以通过改写纳入；

• 需要编写Docstring，保持代码的优雅性，并提供单元测试脚本和测试通过的

一句话总结：任何事情都不是绝对的，常言道：尽信书不如无书！任何规范都是要符合实际情况，而且语言也是在不断的变化之中，在知道足够多的情况下，活学活用才是王道。