Ø编码
所有的Python脚本文件都应在文件头标上#-*-coding:utf-8-*-。设置编辑器，默认保存为utf-8格式。
Ø注释
业界普遍认同Python的注释分为两种的概念，一种是由#开头的“真正的”注释，另一种是docstrings。前者表明为何选择当前实现以及这种实现的原理和难点，后者表明如何使用这个包、模块、类、函数(方法)，甚至包括使用示例和单元测试。
坚持适当注释原则。对不存在技术难点的代码坚持不注释，对存在技术难点的代码必须注释。但与注释不同，推荐对每一个包、模块、类、函数(方法)写docstrings，除非代码一目了然，非常简单。
Ø缩进
Python依赖缩进来确定代码块的层次，行首空白符主要有两种：tab和空格，但严禁两者混用。如果使用tab缩进，设定tab为4个空格。
公司内部推荐使用4个空格的tab进行缩进。
Ø空格
空格在Python代码中是有意义的，因为Python的语法依赖于缩进，在行首的空格称为前导空格。在这一节不讨论前导空格相关的内容，只讨论非前导空格。非前导空格在Python代码中没有意义，但适当地加入非前导空格可以增进代码的可读性。
1)在二元算术、逻辑运算符前后加空格：如a=b+c;
2)在一元前缀运算符后不加空格，如if!flg:pass;
3)“:”用在行尾时前后皆不加空格，如分枝、循环、函数和类定义语言;用在非行尾时两端加空格，如dict对象的定义d={‘key’:’value’}。
4)括号(含圆括号、方括号和花括号)前后不加空格，如do_something(arg1,arg2)，而不是do_something(arg1,arg2);
5)逗号后面加一个空格，前面不加空格;s
Ø空行
适当的空行有利于增加代码的可读性，加空行可以参考如下几个准则：
1)在类、函数的定义间加空行;
2)在import不同种类的模块间加空行;
3)在函数中的逻辑段落间加空行，即把相关的代码紧凑写在一起，作为一个逻辑段落，段落间以空行分隔;
Ø断行
尽管现在的宽屏显示器已经可以单屏显示超过256列字符，但本规范仍然坚持行的最大长度不得超过78个字符的标准。折叠长行的方法有以下几种方法：
1)为长变量名换一个短名，如：
this.is.a.very.long.variable_name=this.is.another.long.variable_name
应改为：
variable_name1=this.is.a.very.long.variable_name
variable_name2=this.is.another.variable_name
variable_name1=variable_name2s
2)在括号(包括圆括号、方括号和花括号)内换行，如：
classEdit(CBase):
def__init__(self,parent,width,
font=FONT,color=BLACK,pos=POS,style=0):
或：
very_very_very_long_variable_name=Edit(parent,\
width,\
font,\
color,\
pos)
如果行长到连第一个括号内的参数都放不下，则每个元素都单独占一行：
very_very_very_long_variable_name=ui.widgets.Edit(\
panrent,\
width,\
font,\
color,\
pos)
3)在长行加入续行符强行断行，断行的位置应在操作符前，且换行后多一个缩进，以使维护人员看代码的时候看到代码行首即可判定这里存在换行，如：
ifcolor==WHITEorcolor==BLACK\
orcolor==BLUE:#注意or操作符在新行的行首而不是旧行的行尾
do_something(color);
Ø命名
一致的命名可以给开发人员减少许多麻烦，而恰如其分的命名则可以大幅提高代码的可读性，降低维护成本。
Ø常量
常量名所有字母大写，由下划线连接各个单词，如
WHITE=0XFFFFFF
THIS_IS_A_CONSTANT=1
Ø变量
变量名全部小写，由下划线连接各个单词，如
color=WHITE
this_is_a_variable=1
不论是类成员变量还是全局变量，均不使用m或g前缀。私有类成员使用单一下划线前缀标识，多定义公开成员，少定义私有成员。
变量名不应带有类型信息，因为Python是动态类型语言。如iValue、names_list、dict_obj等都是不好的命名。
Ø函数
函数名的命名规则与变量名相同。
Ø类
类名单词首字母大写，不使用下划线连接单词，也不加入C、T等前缀。如：
classThisIsAClass(object):
passs
Ø模块
模块名全部小写，对于包内使用的模块，可以加一个下划线前缀，如
module.py
_internal_module.py
Ø包
包的命名规范与模块相同。
Ø缩写
命名应当尽量使用全拼写的单词，缩写的情况有如下两种：
1)常用的缩写，如XML、ID等，在命名时也应只大写首字母，如
classXmlParser(object):pass
2)命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式，如去除元音、包含辅音的首字符等方式，例如：
function缩写为fn
text缩写为txt
object缩写为obj
count缩写为cnt
number缩写为num，等。
Ø特定命名方式
主要是指__xxx__形式的系统保留字命名法。项目中也可以使用这种命名，它的意义在于这种形式的变量是只读的，这种形式的类成员函数尽量不要重载。如
classBase(object):
def__init__(self,id,parent=None):
self.__id__=id
self.__parent__=parent
def__message__(self,msgid):
#…略
其中__id__、__parent__和__message__都采用了系统保留字命名法。
Ø语句
import
import语句有以下几个原则需要遵守：
1)import的次序，先importPython内置模块，再import第三方模块，最后import自己开发的项目中的其它模块;这几种模块中用空行分隔开来。
2)一条import语句import一个模块。
3)当从模块中import多个对象且超过一行时，使用如下断行法(此语法py2.5以上版本才支持)：
frommoduleimport(obj1,obj2,obj3,obj4,
obj5,obj6)
4)不要使用frommoduleimport*，除非是import常量定义模块或其它你确保不会出现命名空间冲突的模块。
Ø赋值
对于赋值语言，主要是不要做无谓的对齐，如：
a=1#这是一个行注释
variable=2#另一个行注释
fn=callback_function#还是行注释
没有必要做这种对齐，原因有两点：一是这种对齐会打乱编程时的注意力，大脑要同时处理两件事(编程和对齐);二是以后阅读和维护都很困难，因为人眼的横向视野很窄，把三个字段看成一行很困难，而且维护时要增加一个更长的变量名也会破坏对齐。直接这样写为佳：
a=1#这是一个行注释
variable=2#另一个行注释
fn=callback_function#还是行注释
Ø分枝和循环
对于分枝和循环，有如下几点需要注意的：
1)不要写成一行，如：
if!flg:pass和foriinxrange(10):printi都不是好代码，应写成
if!flg:
pass
foriinxrange(10):
printi
注：本文档中出现写成一行的例子是因为排版的原因，不得作为编码中不断行的依据。
2)条件表达式的编写应该足够pythonic，如以下形式的条件表达式是拙劣的：
iflen(alist)!=0:do_something()
ifalist!=[]:do_something()
ifs!=“”:do_something()
ifvar!=None:do_something()
ifvar!=False:do_something()
上面的语句应该写成：
ifseq:do_somethin()#注意，这里命名也更改了
ifvar:do_something()
3)用得着的时候多使用循环语句的else分句，以简化代码。
Ø已有代码
对于项目中已有的代码，可能因为历史遗留原因不符合本规范，应当看作可以容忍的特例，允许存在;但不应在新的代码中延续旧的风格。
对于第三方模块，可能不符合本规范，也应看作可以容忍的特例，允许存在;但不应在新的代码中使用第三方模块的风格。
tab与空格混用的缩进是不可容忍的，在运行项目时应使用–t或–tt选项排查这种可能性存在。出现混用的情况时，如果是公司开发的基础类库代码，应当通知类库维护人员修改;第三方模块则可以通过提交patch等方式敦促开发者修正问题。
Ø已有风格
开发人员往往在加入项目之前已经形成自有的编码风格，加入项目后应以本规范为准编写代码。特别是匈牙利命名法，因为带有类型信息，并不适合Python编程，不应在Python项目中应用。
以上内容为大家介绍了简明Python编程规范，希望对大家有所帮助，如果想要了解更多Python相关知识，请关注IT培训机构:千锋教育。http://www.mobiletrain.org/
京公网安备 11010802030320号