简明 Python 编程规范

本文最初发表于赖勇浩（恋花蝶）的博客：http://blog.csdn.net/lanphaday，如蒙转载，必须保留全文完整，未经本人同意，不得用于商业目的。51Testing软件测试网 Lfh g$h$^$kT
简明 Python 编程规范51Testing软件测试网-Vu'H/z;a+Jw-e@
编码51Testing软件测试网 gX,``7f
    所有的 Python 脚本文件都应在文件头标上 # -*- coding:utf-8 -*- 。设置编辑器，默认保存为 utf-8 格式。
qW:RS(c0Pi0注释
V#i1|:c:k0    业界普遍认同 Python 的注释分为两种的概念，一种是由 # 开头的“真正的”注释，另一种是 docstrings。前者表明为何选择当前实现以及这种实现的原理和难点，后者表明如何使用这个包、模块、类、函数（方法），甚至包括使用示例和单元测试。51Testing软件测试网.|-me#x:X2WJ
    坚持适当注释原则。对不存在技术难点的代码坚持不注释，对存在技术难点的代码必须注释。但与注释不同，推荐对每一个包、模块、类、函数（方法）写 docstrings，除非代码一目了然，非常简单。51Testing软件测试网?h,q9N5bLl |*~)J,s
缩进51Testing软件测试网'N fA/q/y m7?P
    Python 依赖缩进来确定代码块的层次，行首空白符主要有两种：tab 和空格，但严禁两者混用。如果使用 tab 缩进，设定 tab 为 4 个空格。
Sg*v)HN�D4_b0    公司内部推荐使用 4 个空格的 tab 进行缩进。51Testing软件测试网jR!O)h2N%mv
空格
O$at2lC&KE0    空格在 Python 代码中是有意义的，因为 Python 的语法依赖于缩进，在行首的空格称为前导空格。在这一节不讨论前导空格相关的内容，只讨论非前导空格。非前导空格在 Python 代码中没有意义，但适当地加入非前导空格可以增进代码的可读性。51Testing软件测试网U0FtXoO'i8`a
1）在二元算术、逻辑运算符前后加空格：如 a = b + c；
h3x,]b?#lT%j$[T02）在一元前缀运算符后不加空格，如 if !flg: pass；
ss�[b"/-b"^03） “:”用在行尾时前后皆不加空格，如分枝、循环、函数和类定义语言；用在非行尾时两端加空格，如 dict 对象的定义 d = {‘key’ : ’value’}。
tts @?$A04）括号（含圆括号、方括号和花括号）前后不加空格，如 do_something(arg1, arg2)，而不是 do_something( arg1, arg2 )；51Testing软件测试网R)OQ.F!kKJqyJi
5）逗号后面加一个空格，前面不加空格；s51Testing软件测试网!yfN3mP$R;H
空行
8`9Wh'Vx(g0    适当的空行有利于增加代码的可读性，加空行可以参考如下几个准则：
M%@/u]9}+jN01）在类、函数的定义间加空行；
Y:uJ�LRr@/G;s W-u02）在 import 不同种类的模块间加工行；
&N{eRu03）在函数中的逻辑段落间加空行，即把相关的代码紧凑写在一起，作为一个逻辑段落，段落间以空行分隔；51Testing软件测试网Z9P}'cKo(`T
断行51Testing软件测试网.O%}1vf3H8Re
    尽管现在的宽屏显示器已经可以单屏显示超过 256 列字符，但本规范仍然坚持行的最大长度不得超过 78 个字符的标准。折叠长行的方法有以下几种方法：
.^c-jk V01) 为长变量名换一个短名，如：51Testing软件测试网+CMz.Fh!F5j
    this.is.a.very.long.variable_name = this.is.another.long.variable_name
C cq!] u b@h@0    应改为：
0n/f;Xq&O+I0    variable_name1 = this.is.a.very.long.variable_name51Testing软件测试网kkQL9M T9l
    variable_name2 = this.is.another.variable_name
G0u#eK`,cD6Y0    variable_name1 = variable_name2s
(X-dz/|7D0?2d02) 在括号（包括圆括号、方括号和花括号）内换行，如：
"e X$Y[8X./"qn0    class Edit(CBase):
UB T3Y-wG2/Y+y$Ds0        def __init__(self, parent, width, 51Testing软件测试网[�{3IE1C�fY5C:Ed
                                font = FONT, color = BLACK, pos = POS, style = 0):51Testing软件测试网 pC qc W)MBb
    或：51Testing软件测试网!D.vU+m"E |d@L1e W
    very_very_very_long_variable_name = Edit(parent, /51Testing软件测试网,p|ig/4W9T }w;b
                                                                            width, /51Testing软件测试网;vn$G+Jz2s6PUh
                                                                            font, /51Testing软件测试网"gg6z-j"I B9~k
                                                                            color, /51Testing软件测试网#`0@kK8O
                                                                            pos)
S-s[r6cI0    如果行长到连第一个括号内的参数都放不下，则每个元素都单独占一行：51Testing软件测试网Q1| dhB$d9U$g U"|
    very_very_very_long_variable_name = ui.widgets.Edit( /51Testing软件测试网2x'jR8X I9DB#`
                                                                                    panrent, /51Testing软件测试网'D*R$zG `
                                                                                    width, /51Testing软件测试网j s$X#R,V,O^w
                                                                                    font, /51Testing软件测试网t:R#i%r~/!e
                                                                                    color, /
*U$FN7|&[0                                                                                    pos)
*]1|:~X0L.RX&J03) 在长行加入续行符强行断行，断行的位置应在操作符前，且换行后多一个缩进，以使维护人员看代码的时候看到代码行首即可判定这里存在换行，如：51Testing软件测试网R,c%k9~~$lFr&gI
if color == WHITE or color == BLACK /
1BA!xk)e2JF3a0or color == BLUE: # 注意 or 操作符在新行的行首而不是旧行的行尾
])g@�I%w0do_something(color);
1`S#nSm)imXrt0命名
E0v?!{"h.p l3f6A0    一致的命名可以给开发人员减少许多麻烦，而恰如其分的命名则可以大幅提高代码的可读性，降低维护成本。
4tsp,ox N]0常量
z/n1o"L0_0 常量名所有字母大写，由下划线连接各个单词，如
X?s:l6o|'XK8V0WHITE = 0XFFFFFF51Testing软件测试网XZ k&Au6k(T
THIS_IS_A_CONSTANT = 151Testing软件测试网)?,]%P9DL
变量51Testing软件测试网 J Yx uA sR
    变量名全部小写，由下划线连接各个单词，如
/m |(no2}{0color = WHITE
:p,VyD0drQ`0this_is_a_variable = 151Testing软件测试网+q]+_8a8G(LW
    不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。私有类成员使用单一下划线前缀标识，多定义公开成员，少定义私有成员。51Testing软件测试网 fZ#]W$~:eT$i
    变量名不应带有类型信息，因为 Python 是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。51Testing软件测试网s4t9lYLG"D
函数51Testing软件测试网"@ J4pU.Ci5k
    函数名的命名规则与变量名相同。51Testing软件测试网G#p1w|lI y
类51Testing软件测试网oI;lVW AN
    类名单词首字母大写，不使用下划线连接单词，也不加入 C、T 等前缀。如：51Testing软件测试网,AD ]e/$E*a)Z!Q
class ThisIsAClass(object):51Testing软件测试网 Af,dur5]&Q`
    passs51Testing软件测试网2g$U+X7^9x$h4m
模块51Testing软件测试网r^f;Z~j
    模块名全部小写，对于包内使用的模块，可以加一个下划线前缀，如
V2^2pV1@s#H0module.py
,J9Bh.Ka@v},d0_internal_module.py
y*Hg{$t"RSeI.e0包
(qz,O5RY+A,UD0    包的命名规范与模块相同。
l!yt['@6_0缩写51Testing软件测试网2?}#M f1U4O|;d"p L
    命名应当尽量使用全拼写的单词，缩写的情况有如下两种：51Testing软件测试网2c%dthQKd YU5Q
1）常用的缩写，如 XML、ID等，在命名时也应只大写首字母，如
rp$XO9e}Ro0class XmlParser(object):pass
.o }O0S4m ]02）命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式，如去除元音、包含辅音的首字符等方式，例如：51Testing软件测试网o,KtG@t
function 缩写为 fn51Testing软件测试网tZktC_
text 缩写为 txt
&CA*r p)Y'k0object 缩写为 obj51Testing软件测试网On F$HzQ%^ c?"S
count 缩写为 cnt
3e+RX%PY NdF0number 缩写为 num，等。
'/&e,]j_R1?u0特定命名方式51Testing软件测试网 vqj-eL!|
    主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名，它的意义在于这种形式的变量是只读的，这种形式的类成员函数尽量不要重载。如51Testing软件测试网'X5EHkt[UObY
class Base(object):
(E%w&RP1J-^N?0    def __init__(self, id, parent = None):
;b'}n~:{W*o0        self.__id__ = id
#u*so"|z(M!^e/@0        self.__parent__ = parent
/?n#['JE"f%|1T(P0    def __message__(self, msgid):51Testing软件测试网*R-U/E.jf_njN
        # …略51Testing软件测试网C�q-m-]0qA
其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。
F KRaMjyc&]0语句51Testing软件测试网p_sx#V
import51Testing软件测试网'A!s!fHEVe2u5Y
    import 语句有以下几个原则需要遵守：
e_GG+B1n,k01） import 的次序，先 import Python 内置模块，再 import 第三方模块，最后 import 自己开发的项目中的其它模块；这几种模块中用空行分隔开来。
br.L&/$^B�rkC02）一条 import 语句 import 一个模块。51Testing软件测试网G(D@} Ky
3）当从模块中 import 多个对象且超过一行时，使用如下断行法（此语法 py2.5 以上版本才支持）：
'E1inZ/V;t|Ve0from module import (obj1, obj2, obj3, obj4,
2K1G~T:j2w-O(Z0                                    obj5, obj6)
*/+A!Iu nT{/{]~04）不要使用 from module import *，除非是 import 常量定义模块或其它你确保不会出现命名空间冲突的模块。
d| G1/?1n,j$ff1x0赋值
9CA/5W hqnYPn"@0    对于赋值语言，主要是不要做无谓的对齐，如：51Testing软件测试网{k6J2P B"kl#D IT
a   = 1     # 这是一个行注释
V|cEE6If r5i0variable  = 2     # 另一个行注释
ZcoutoelU*zs0fn   = callback_function  # 还是行注释
1d3D-d U*@z7Gj0没有必要做这种对齐，原因有两点：一是这种对齐会打乱编程时的注意力，大脑要同时处理两件事（编程和对齐）；二是以后阅读和维护都很困难，因为人眼的横向视野很窄，把三个字段看成一行很困难，而且维护时要增加一个更长的变量名也会破坏对齐。直接这样写为佳：
6]$VI@3I gv7b0a = 1 # 这是一个行注释
`d9b&{H6KZsv7K0variable = 2 # 另一个行注释
-}h|w1x1r0fn = callback_function # 还是行注释51Testing软件测试网 A.|I:?1dS5j
分枝和循环51Testing软件测试网Z^h~!K
    对于分枝和循环，有如下几点需要注意的：51Testing软件测试网,B5}9}5Z[4oGD
1) 不要写成一行，如：
e(d,f`�vk0if !flg: pass 和 for i in xrange(10): print i都不是好代码，应写成
H�X3c:Zkp%sx4t0if !flg:
8QSu?$k A&KSe0    pass51Testing软件测试网 wxL(|F4[�d
for i in xrange(10):
$~9? }$Ei4JZ0    print i
(t/a#T6xt$UP#g0注：本文档中出现写成一行的例子是因为排版的原因，不得作为编码中不断行的依据。
`"AjEk02) 条件表达式的编写应该足够 pythonic，如以下形式的条件表达式是拙劣的：
MJ0a4n9kO0if len(alist) != 0: do_something()51Testing软件测试网"t!y7n.Tr0a)Rc6Iw
if alist != []: do_something()
x,Ek%JIm�lt0if s != “”: do_something()
Qbs!m#C Z0qwN0if var != None: do_something()51Testing软件测试网tF xd8BK
if var != False: do_something()51Testing软件测试网8}6K#xr,K6aq
上面的语句应该写成：
3p&P3l.W/bz"}n0S0if seq: do_somethin() # 注意，这里命名也更改了51Testing软件测试网/m*N,A4M&/+_3q3d
if var: do_something()
Gm;Y7a!U$}#et;jx03) 用得着的时候多使用循环语句的 else 分句，以简化代码。51Testing软件测试网[e-b5aWa_5UM J3J
已有代码
.}?.Z%bu)`0U(O0@-|0    对于项目中已有的代码，可能因为历史遗留原因不符合本规范，应当看作可以容忍的特例，允许存在；但不应在新的代码中延续旧的风格。51Testing软件测试网ZDp9A)TB'G!yy:UL
    对于第三方模块，可能不符合本规范，也应看作可以容忍的特例，允许存在；但不应在新的代码中使用第三方模块的风格。
A#s4V5h9_Jo.C8i!q;o0    tab 与空格混用的缩进是不可容忍的，在运行项目时应使用 –t 或 –tt 选项排查这种可能性存在。出现混用的情况时，如果是公司开发的基础类库代码，应当通知类库维护人员修改；第三方模块则可以通过提交 patch 等方式敦促开发者修正问题。51Testing软件测试网�/$]j-vd!o6Ga/b
已有风格51Testing软件测试网j t,{-D&wn.PcD
    开发人员往往在加入项目之前已经形成自有的编码风格，加入项目后应以本规范为准编写代码。特别是匈牙利命名法，因为带有类型信息，并不适合 Python 编程，不应在 Python 项目中应用。

简明 Python 编程规范相关推荐

简明 Python 编程规范v2
赖勇浩(http://laiyonghao.com) 注:之前发布一篇<简明 Python 编程规范>(见:http://blog.csdn.net/lanphaday/article/d ...
简单叙述python的编程规范_简明 Python 编程规范
注:之前发布一篇<简明 Python 编程规范>(见:http://blog.csdn.net/lanphaday/article/details/2834883),本是我给当时所在的公司 ...
简述python程序的书写规范_简明的 Python 编程规范
简明的 Python 编程规范使用编码规范编写程序,不仅可以别人让后面维护的人更方便,同时也方便自己检查程序.以下是百分网小编精心为大家整理的简明的 Python 编程规范,希望对大家编写程序有所帮 ...
python使用符号#表示单行注释-【经济金融及Python应用讲义】Python编程规范之注释...
原标题:[经济金融及Python应用讲义]Python编程规范之注释来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么 ...
python使用符号表示单行注释-Python编程规范之注释
来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了. 可以发现,在编写代码的过程中,我们 ...
python代码注释规范-Python编程规范之注释
来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了. 可以发现,在编写代码的过程中,我们 ...
Python编程规范及性能优化
为什么80%的码农都做不了架构师?>>> Ptyhon编程规范编码所有的 Python 脚本文件都应在文件头标上 # -*- coding:utf-8 -*- .设置编辑器 ...
Python 编程规范 —— TODO 注释（结合 PyCharm）
编程是代码和注释的统一: TODO 自然表示需要做而未做的一些待完成的事项,有助于事后的检索,以及对整体项目做进一步的修改迭代. # TODO(kl@gmail.com): Use a "* ...
Python 编程规范和软件开发目录规范的重要性
文章目录 1 编程规范的重要性 1.1 注释 Python 中的特殊注释 1.2 规范命名变量: 1.2.1 变量定义规则: 1.2.2 变量规范命名注意事项: 1.2.3 总体命名规则: 1.3 排 ...

简明 Python 编程规范

简明 Python 编程规范相关推荐

最新文章

热门文章