python的统一编码规范说明

目前业界比较流行的Python的编码规范目前主要有PEP8的编程、Google的编码风格、Python Guide和Pocoo StyleGuide等等，我认为无论是哪一种编码规范和风格，最重要的是要在团队中有一套统一或者近乎一致的编码规范和风格，这样才能确保协作效率和降低沟通成本。目前我所在的团队并没有一套规范，那么这个伟大的任务又要落在我手里来实现啦，哇哈哈:-D。

先说明一下，设计这套统一编码规范的原则只有一个：Simple is the best，简单实用是核心指导原则，编码规范要符合编码习惯和提升代码可读性。这套编码规范是基于PEP8规范的，但是同时参考Google的编码风格和大神编写的"Strunk & White"风格。

命名格式

文件名：全小写,可使用下划线
包：应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如my_package。
模块：与包的规范同。如mymodule。
类：总是使用首字母大写单词串。如MyClass。内部类可以使用额外的前导下划线。
函数&方法：函数名应该为小写，可以用下划线风格单词以增加可读性。如：myfunction，my_example_function。
*注意*：混合大小写仅被允许用于这种风格已经占据优势的时候，以便保持向后兼容。
函数和方法的参数：总使用“self”作为实例方法的第一个参数。总使用“cls”作为类方法的第一个参数。
如果一个函数的参数名称和保留的关键字冲突，通常使用一个后缀下划线好于使用缩写或奇怪的拼写。
变量
变量名全部小写，由下划线连接各个单词。如color = WHITE，this_is_a_variable = 1
*注意*：
1.不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识，多定义公开成员，少定义私有成员。
3.变量名不应带有类型信息，因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
常量:常量名所有字母大写，由下划线连接各个单词如MAX_OVERFLOW，TOTAL。
异常:以“Error”作为后缀。
缩写:命名应当尽量使用全拼写的单词，缩写的情况有如下两种：
1.常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。
2.命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。
例如：
function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num，等。