python入门之编码风格规范分享
python入门之编码风格规范分享：
本项目并非 google 官方项目, 而是由国内程序员凭热情创建和维护。
如果你关注的是 google 官方英文版, 请移步google style guide
以下代码中yes表示推荐，no表示不推荐。
分号
不要在行尾加分号, 也不要用分号将两条命令放在同一行。
行长度
每行不超过80个字符
以下情况除外：
长的导入模块语句
注释里的url
不要使用反斜杠连接行。
python会将圆括号, 中括号和花括号中的行隐式的连接起来, 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号。
推荐:foo_bar(self,width,height,color='black',design=none,x='foo',emphasis=none,highlight=0)if(width==0andheight==0andcolor=='red'andemphasis=='strong'):
如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接:
x=('这是一个非常长非常长非常长非常长 ''非常长非常长非常长非常长非常长非常长的字符串')
在注释中，如果必要，将长的url放在一行上。
yes:# see details at#no:# see details at# \# v2.0/csv_file_name_extension_full_specification.html
注意上面例子中的元素缩进; 你可以在本文的 :ref:`缩进`部分找到解释.
括号
宁缺毋滥的使用括号
除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用括号是可以的.
yes:iffoo:bar()whilex:x=bar()ifxandy:bar()ifnotx:bar()returnfoofor(x,y)indict.items():...no:if(x):bar()ifnot(x):bar()return(foo)缩进
用4个空格来缩进代码
绝对不要用tab, 也不要tab和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素(见 :ref:`行长度` 部分的示例), 或者使用4空格的悬挂式缩进(这时第一行不应该有参数):
yes:# 与起始变量对齐foo=long_function_name(var_one,var_two,var_three,var_four)# 字典中与起始值对齐foo={long_dictionary_key:value1+value2,...}# 4 个空格缩进，第一行不需要foo=long_function_name(var_one,var_two,var_three,var_four)# 字典中 4 个空格缩进foo={long_dictionary_key:long_dictionary_value,...}no:# 第一行有空格是禁止的foo=long_function_name(var_one,var_two,var_three,var_four)# 2 个空格是禁止的foo=long_function_name(var_one,var_two,var_three,var_four)# 字典中没有处理缩进foo={long_dictionary_key:long_dictionary_value,...}空行
顶级定义之间空两行, 方法定义之间空一行
顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.
空格
按照标准的排版规范来使用标点两边的空格
括号内不要有空格.
按照标准的排版规范来使用标点两边的空格
yes:spam(ham[1],{eggs:2},[])no:spam(ham[1],{eggs:2},[])
不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾).
yes:ifx==4:printx,y x,y=y,xno:ifx==4:printx,y x,y=y,x
参数列表, 索引或切片的左括号前不应加空格.
yes:spam(1)no:spam(1)yes:dict['key']=list[index]no:dict['key']=list[index]
在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, , !=, , =, in, not in, is, is not), 布尔(and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己好好判断. 不过两侧务必要保持一致.
yes:x==1no:x<1
当'='用于指示关键字参数或默认参数值时, 不要在其两侧使用空格.
yes:defcomplex(real,imag=0.0):returnmagic(r=real,i=imag)no:defcomplex(real,imag=0.0):returnmagic(r=real,i=imag)
不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等):
yes:foo=1000# 注释long_name=2# 注释不需要对齐dictionary={foo:1,long_name:2,}no:foo=1000# 注释long_name=2# 注释不需要对齐dictionary={foo:1,long_name:2,}shebang
大部分.py文件不必以#!作为文件的开始. 根据pep-394, 程序的main文件应该以 #!/usr/bin/python2或者 #!/usr/bin/python3开始.
(译者注: 在计算机科学中,shebang(也称为hashbang)是一个由井号和叹号构成的字符串行(#!), 其出现在文本文件的第一行的前两个字符. 在文件中存在shebang的情况下, 类unix操作系统的程序载入器会分析shebang后的内容, 将这些内容作为解释器指令, 并调用该指令, 并将载有shebang的文件路径作为该解释器的参数. 例如, 以指令#!/bin/sh开头的文件在执行时会实际调用/bin/sh程序.)
#!先用于帮助内核找到python解释器, 但是在导入模块时, 将会被忽略. 因此只有被直接执行的文件中才有必要加入#!.
注释
确保对模块, 函数, 方法和行内注释使用正确的风格
文档字符串
python有一种独一无二的的注释方式: 使用文档字符串. 文档字符串是包, 模块, 类或函数里的第一个语句. 这些字符串可以通过对象的__doc__成员被自动提取, 并且被pydoc所用. (你可以在你的模块上运行pydoc试一把, 看看它长什么样). 我们对文档字符串的惯例是使用三重双引号(pep-257). 一个文档字符串应该这样组织: 首先是一行以句号, 问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行). 接着是一个空行. 接着是文档字符串剩下的部分, 它应该与文档字符串的第一行的第一个引号对齐. 下面有更多文档字符串的格式化规范.
模块
每个文件应该包含一个许可样板. 根据项目使用的许可(例如, apache 2.0, bsd, lgpl, gpl), 选择合适的样板.
函数和方法
下文所指的函数,包括函数, 方法, 以及生成器.
一个函数必须要有文档字符串, 除非它满足以下条件:
外部不可见
非常短小
简单明了
文档字符串应该包含函数做什么, 以及输入和输出的详细描述. 通常, 不应该描述怎么做, 除非是一些复杂的算法. 文档字符串应该提供足够的信息, 当别人编写代码调用该函数时, 他不需要看一行代码, 只要看文档字符串就可以了. 对于复杂的代码, 在代码旁边加注释会比使用文档字符串更有意义.
关于函数的几个方面应该在特定的小节中进行描述记录， 这几个方面如下文所述. 每节应该以一个标题行开始. 标题行以冒号结尾. 除标题行外, 节的其他内容应被缩进2个空格.
args:列出每个参数的名字, 并在名字后使用一个冒号和一个空格, 分隔对该参数的描述.如果描述太长超过了单行80字符,使用2或者4个空格的悬挂缩进(与文件其他部分保持一致). 描述应该包括所需的类型和含义. 如果一个函数接受*foo(可变长度参数列表)或者**bar (任意关键字参数), 应该详细列出*foo和**bar.returns: (或者 yields: 用于生成器)描述返回值的类型和语义. 如果函数返回none, 这一部分可以省略.raises:列出与接口有关的所有异常.
deffetch_bigtable_rows(big_table,keys,other_silly_variable=none):fetches rows from a bigtable. retrieves rows pertaining to the given keys from the table instance represented by big_table. silly things may happen if other_silly_variable is not none. args: big_table: an open bigtable table instance. keys: a sequence of strings representing the key of each table row to fetch. other_silly_variable: another optional variable, that has a much longer name than the other args, and which does nothing. returns: a dict mapping keys to the corresponding table row data fetched. each row is represented as a tuple of strings. for example: {'serak': ('rigel vii', 'preparer'), 'zim': ('irk', 'invader'), 'lrrr': ('omicron persei 8', 'emperor')} if a key from the keys argument is missing from the dictionary, then that row was not found in the table. raises: ioerror: an error occurred accessing the bigtable.table object. pass
类
类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性(attributes), 那么文档中应该有一个属性(attributes)段. 并且应该遵守和函数参数相同的格式.
classsampleclass(object):summary of class here. longer class information.... longer class information.... attributes: likes_spam: a boolean indicating if we like spam or not. eggs: an integer count of the eggs we have laid. def__init__(self,likes_spam=false):inits sampleclass with blah.self.likes_spam=likes_spamself.eggs=0defpublic_method(self):performs operation blah.
块注释和行注释
最需要写注释的是代码中那些技巧性的部分. 如果你在下次代码审查的时候必须解释一下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释.
# we use a weighted dictionary search to find out where i is in# the array. we extrapolate position based on the largest num# in the array and the array size and then do binary search to# get the exact number.ifi&(i-1)==0:# true iff i is a power of 2
为了提高可读性, 注释应该至少离开代码2个空格.
另一方面, 绝不要描述代码. 假设阅读代码的人比你更懂python, 他只是不知道你的代码要做什么.
# bad comment: now go through the b array and make sure whenever i occurs# the next element is i+1类
如果一个类不继承自其它类, 就显式的从object继承. 嵌套类也一样.
yes:classsampleclass(object):passclassouterclass(object):classinnerclass(object):passclasschildclass(parentclass):explicitly inherits from another class already.no:classsampleclass:passclassouterclass:classinnerclass:pass
继承自object是为了使属性(properties)正常工作, 并且这样可以保护你的代码, 使其不受python 3000的一个特殊的潜在不兼容性影响. 这样做也定义了一些特殊的方法, 这些方法实现了对象的默认语义, 包括__new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__.
字符串yes:x=a+b x='%s, %s!'%(imperative,expletive)x='{}, {}!'.format(imperative,expletive)x='name: %s; score: %d'%(name,n)x='name: {}; score: {}'.format(name,n)no:x='%s%s'%(a,b)# use + in this casex='{}{}'.format(a,b)# use + in this casex=imperative+', '+expletive+'!'x='name: '+name+'; score: '+str(n)
避免在循环中用+和+=操作符来累加字符串. 由于字符串是不可变的, 这样做会创建不必要的临时对象, 并且导致二次方而不是线性的运行时间. 作为替代方案, 你可以将每个子串加入列表, 然后在循环结束后用.join连接列表. (也可以将每个子串写入一个cstringio.stringio缓存中.)
yes:items=['']forlast_name,first_nameinemployee_list:items.append(''%(last_name,first_name))items.append('
%s, %s
')employee_table=''.join(items)no:employee_table=''forlast_name,first_nameinemployee_list:employee_table+=''%(last_name,first_name)employee_table+=' %s, %s
在同一个文件中, 保持使用字符串引号的一致性. 使用单引号'或者双引号之一用以引用字符串, 并在同一文件中沿用. 在字符串内可以使用另外一种引号, 以避免在字符串中使用. pylint已经加入了这一检查.
yes:python('why are you hiding your eyes?')gollum(i'm scared of lint errors.)narrator('good! thought a happy python reviewer.')no:python(why are you hiding your eyes?)gollum('the lint. it burns. it burns us.')gollum(always the great lint. watching. watching.)
为多行字符串使用三重双引号而非三重单引号'''. 当且仅当项目中使用单引号'来引用字符串时, 才可能会使用三重'''为非文档字符串的多行字符串来标识引用. 文档字符串必须使用三重双引号. 不过要注意, 通常用隐式行连接更清晰, 因为多行字符串与程序其他部分的缩进方式不一致.
yes:print(this is much nicer.\ndo it this way.\n)no:printthis is pretty ugly. don't do this. 文件和sockets
在文件和sockets结束时, 显式的关闭它.
除文件外, sockets或其他类似文件的对象在没有必要的情况下打开, 会有许多副作用, 例如:
它们可能会消耗有限的系统资源, 如文件描述符. 如果这些资源在使用后没有及时归还系统, 那么用于处理这些对象的代码会将资源消耗殆尽.
持有文件将会阻止对于文件的其他诸如移动、删除之类的操作.
仅仅是从逻辑上关闭文件和sockets, 那么它们仍然可能会被其共享的程序在无意中进行读或者写操作. 只有当它们真正被关闭后, 对于它们尝试进行读或者写操作将会跑出异常, 并使得问题快速显现出来.
而且, 幻想当文件对象析构时, 文件和sockets会自动关闭, 试图将文件对象的生命周期和文件的状态绑定在一起的想法, 都是不现实的. 因为有如下原因:
没有任何方法可以确保运行环境会真正的执行文件的析构. 不同的python实现采用不同的内存管理技术, 比如延时垃圾处理机制. 延时垃圾处理机制可能会导致对象生命周期被任意无限制的延长.
对于文件意外的引用,会导致对于文件的持有时间超出预期(比如对于异常的跟踪, 包含有全局变量等).
推荐使用以管理文件:
withopen(hello.txt)ashello_file:forlineinhello_file:printline
对于不支持使用with语句的类似文件的对象,使用 contextlib.closing():
importcontextlibwithcontextlib.closing(urllib.urlopen())asfront_page:forlineinfront_page:printline
legacy appengine 中python 2.5的代码如使用with语句, 需要添加 from __future__ import with_statement.
todo注释
为临时代码使用todo注释, 它是一种短期解决方案. 不算完美, 但够好了.
todo注释应该在所有开头处包含todo字符串, 紧跟着是用括号括起来的你的名字, email地址或其它标识符. 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主要目的是为了有一个统一的todo格式, 这样添加注释的人就可以搜索到(并可以按需提供更多细节). 写了todo注释并不保证写的人会亲自解决问题. 当你写了一个todo, 请注上你的名字.
# todo(kl@gmail.com): use a * here for string repetition.# todo(zeke) change this to use relations.
如果你的todo是将来做某事的形式, 那么请确保你包含了一个指定的日期(2009年11月解决)或者一个特定的事件(等到所有的客户都可以处理xml请求就移除这些代码).
导入格式
每个导入应该独占一行
yes:importosimportsysno:importos,sys
导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:
标准库导入
第三方库导入
应用程序指定导入
每种分组中, 应该根据每个模块的完整包路径按字典序排序, 忽略大小写.
importfoofromfooimportbarfromfoo.barimportba***romfoo.barimportquuxfromfoobimportar语句
通常每个语句应该独占一行
不过, 如果测试结果与测试语句在一行放得下, 你也可以将它们放在同一行. 如果是if语句, 只有在没有else时才能这样做. 特别地, 绝不要对try/except这样做, 因为try和except不能放在同一行.
yes:iffoo:bar(foo)no:iffoo:bar(foo)else:baz(foo)try:bar(foo)exceptvalueerror:baz(foo)try:bar(foo)exceptvalueerror:baz(foo)访问控制
在python中, 对于琐碎又不太重要的访问函数, 你应该直接使用公有变量来取代它们, 这样可以避免额外的函数调用开销. 当添加更多功能时, 你可以用属性(property)来保持语法的一致性.
(译者注: 重视封装的面向对象程序员看到这个可能会很反感, 因为他们一直被教育: 所有成员变量都必须是私有的! 其实, 那真的是有点麻烦啊. 试着去接受pythonic哲学吧)
另一方面, 如果访问更复杂, 或者变量的访问开销很显著, 那么你应该使用像get_foo()和set_foo()这样的函数调用. 如果之前的代码行为允许通过属性(property)访问 , 那么就不要将新的访问函数与属性绑定. 这样, 任何试图通过老方法访问变量的代码就没法运行, 使用者也就会意识到复杂性发生了变化.
命名
module_name, package_name, classname, method_name, exceptionname, function_name, global_var_name, instance_var_name, function_parameter_name, local_var_name.
应该避免的名称
单字符名称, 除了计数器和迭代器.
包/模块名中的连字符(-)
双下划线开头并结尾的名称(python保留, 例如__init__)
命名约定
所谓内部(internal)表示仅模块内可用, 或者, 在类内是保护或私有的.
用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含).
用双下划线(__)开头的实例变量或方法表示类内私有.
将相关的类和顶级函数放在同一个模块里. 不像java, 没必要限制一个类一个模块.
对类名使用大写字母开头的单词(如capwords, 即pascal风格), 但是模块名应该用小写加下划线的方式(如lower_with_under.py). 尽管已经有很多现存的模块使用类似于capwords.py这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰.
python之父guido推荐的规范
type public internal
moduleslower_with_under_lower_with_under
packageslower_with_under
classescapwords_capwords
exceptionscapwords
functionslower_with_under()_lower_with_under()
global/class constantscaps_with_under_caps_with_under
global/class variableslower_with_under_lower_with_under
instance variableslower_with_under_lower_with_under (protected) or __lower_with_under (private)
method nameslower_with_under()_lower_with_under() (protected) or __lower_with_under() (private)
function/method parameterslower_with_under
local variableslower_with_under
main
即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个main()函数中.
在python中, pydoc以及单元测试要求模块必须是可导入的. 你的代码应该在执行主程序前总是检查if __name__ == '__main__', 这样当模块被导入时主程序就不会被执行.
defmain():...if__name__=='__main__':main()
所有的顶级代码在模块导入时都会被执行. 要小心不要去调用函数, 创建对象, 或者执行那些不应该在使用pydoc时执行的操作.
组态王与单片机多机串口通信的设计
过车辆计算网关平台推动软件定义的汽车
如何增强Wi-Fi信号
为什么心脏起搏器容易受到攻击
英特尔开发48核智能手机平板电脑芯片
python入门之编码风格规范分享
打游戏用哪种蓝牙耳机比较好，618打游戏买什么蓝牙耳机好
mos管开关电路
过年送什么礼物好？2022年货节好物推荐
苹果再压三星，明年上演的iphone8拍照提升：支持光学防抖
PCB库问题有哪一些
全局数据包通信简介
亚马逊 Luna 云游戏登陆安卓平台，仅支持部分 Pixel 、三星及一加手机
什么是景区气象站，关于它的特点以及注意事项
光华芯音频Codec大全，光华芯产品选型表汇总
富士通推出24款具有LCD控制功能的新型宽电压8位微控制器
sense-id:不间断式LORA物联网关
电子线束标准设计的五个阶段
万物互联时代，我们的生活将会有更多的可能性
输电网配电系统的组成、功能及作用
本项目并非 google 官方项目, 而是由国内程序员凭热情创建和维护。
如果你关注的是 google 官方英文版, 请移步google style guide
以下代码中yes表示推荐，no表示不推荐。
分号
不要在行尾加分号, 也不要用分号将两条命令放在同一行。
行长度
每行不超过80个字符
以下情况除外：
长的导入模块语句
注释里的url
不要使用反斜杠连接行。
python会将圆括号, 中括号和花括号中的行隐式的连接起来, 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号。
推荐:foo_bar(self,width,height,color='black',design=none,x='foo',emphasis=none,highlight=0)if(width==0andheight==0andcolor=='red'andemphasis=='strong'):
如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接:
x=('这是一个非常长非常长非常长非常长 ''非常长非常长非常长非常长非常长非常长的字符串')
在注释中，如果必要，将长的url放在一行上。
yes:# see details at#no:# see details at# \# v2.0/csv_file_name_extension_full_specification.html
注意上面例子中的元素缩进; 你可以在本文的 :ref:`缩进`部分找到解释.
括号
宁缺毋滥的使用括号
除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用括号是可以的.
yes:iffoo:bar()whilex:x=bar()ifxandy:bar()ifnotx:bar()returnfoofor(x,y)indict.items():...no:if(x):bar()ifnot(x):bar()return(foo)缩进
用4个空格来缩进代码
绝对不要用tab, 也不要tab和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素(见 :ref:`行长度` 部分的示例), 或者使用4空格的悬挂式缩进(这时第一行不应该有参数):
yes:# 与起始变量对齐foo=long_function_name(var_one,var_two,var_three,var_four)# 字典中与起始值对齐foo={long_dictionary_key:value1+value2,...}# 4 个空格缩进，第一行不需要foo=long_function_name(var_one,var_two,var_three,var_four)# 字典中 4 个空格缩进foo={long_dictionary_key:long_dictionary_value,...}no:# 第一行有空格是禁止的foo=long_function_name(var_one,var_two,var_three,var_four)# 2 个空格是禁止的foo=long_function_name(var_one,var_two,var_three,var_four)# 字典中没有处理缩进foo={long_dictionary_key:long_dictionary_value,...}空行
顶级定义之间空两行, 方法定义之间空一行
顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.
空格
按照标准的排版规范来使用标点两边的空格
括号内不要有空格.
按照标准的排版规范来使用标点两边的空格
yes:spam(ham[1],{eggs:2},[])no:spam(ham[1],{eggs:2},[])
不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾).
yes:ifx==4:printx,y x,y=y,xno:ifx==4:printx,y x,y=y,x
参数列表, 索引或切片的左括号前不应加空格.
yes:spam(1)no:spam(1)yes:dict['key']=list[index]no:dict['key']=list[index]
在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, , !=, , =, in, not in, is, is not), 布尔(and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己好好判断. 不过两侧务必要保持一致.
yes:x==1no:x<1
当'='用于指示关键字参数或默认参数值时, 不要在其两侧使用空格.
yes:defcomplex(real,imag=0.0):returnmagic(r=real,i=imag)no:defcomplex(real,imag=0.0):returnmagic(r=real,i=imag)
不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等):
yes:foo=1000# 注释long_name=2# 注释不需要对齐dictionary={foo:1,long_name:2,}no:foo=1000# 注释long_name=2# 注释不需要对齐dictionary={foo:1,long_name:2,}shebang
大部分.py文件不必以#!作为文件的开始. 根据pep-394, 程序的main文件应该以 #!/usr/bin/python2或者 #!/usr/bin/python3开始.
(译者注: 在计算机科学中,shebang(也称为hashbang)是一个由井号和叹号构成的字符串行(#!), 其出现在文本文件的第一行的前两个字符. 在文件中存在shebang的情况下, 类unix操作系统的程序载入器会分析shebang后的内容, 将这些内容作为解释器指令, 并调用该指令, 并将载有shebang的文件路径作为该解释器的参数. 例如, 以指令#!/bin/sh开头的文件在执行时会实际调用/bin/sh程序.)
#!先用于帮助内核找到python解释器, 但是在导入模块时, 将会被忽略. 因此只有被直接执行的文件中才有必要加入#!.
注释
确保对模块, 函数, 方法和行内注释使用正确的风格
文档字符串
python有一种独一无二的的注释方式: 使用文档字符串. 文档字符串是包, 模块, 类或函数里的第一个语句. 这些字符串可以通过对象的__doc__成员被自动提取, 并且被pydoc所用. (你可以在你的模块上运行pydoc试一把, 看看它长什么样). 我们对文档字符串的惯例是使用三重双引号(pep-257). 一个文档字符串应该这样组织: 首先是一行以句号, 问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行). 接着是一个空行. 接着是文档字符串剩下的部分, 它应该与文档字符串的第一行的第一个引号对齐. 下面有更多文档字符串的格式化规范.
模块
每个文件应该包含一个许可样板. 根据项目使用的许可(例如, apache 2.0, bsd, lgpl, gpl), 选择合适的样板.
函数和方法
下文所指的函数,包括函数, 方法, 以及生成器.
一个函数必须要有文档字符串, 除非它满足以下条件:
外部不可见
非常短小
简单明了
文档字符串应该包含函数做什么, 以及输入和输出的详细描述. 通常, 不应该描述怎么做, 除非是一些复杂的算法. 文档字符串应该提供足够的信息, 当别人编写代码调用该函数时, 他不需要看一行代码, 只要看文档字符串就可以了. 对于复杂的代码, 在代码旁边加注释会比使用文档字符串更有意义.
关于函数的几个方面应该在特定的小节中进行描述记录， 这几个方面如下文所述. 每节应该以一个标题行开始. 标题行以冒号结尾. 除标题行外, 节的其他内容应被缩进2个空格.
args:列出每个参数的名字, 并在名字后使用一个冒号和一个空格, 分隔对该参数的描述.如果描述太长超过了单行80字符,使用2或者4个空格的悬挂缩进(与文件其他部分保持一致). 描述应该包括所需的类型和含义. 如果一个函数接受*foo(可变长度参数列表)或者**bar (任意关键字参数), 应该详细列出*foo和**bar.returns: (或者 yields: 用于生成器)描述返回值的类型和语义. 如果函数返回none, 这一部分可以省略.raises:列出与接口有关的所有异常.
deffetch_bigtable_rows(big_table,keys,other_silly_variable=none):fetches rows from a bigtable. retrieves rows pertaining to the given keys from the table instance represented by big_table. silly things may happen if other_silly_variable is not none. args: big_table: an open bigtable table instance. keys: a sequence of strings representing the key of each table row to fetch. other_silly_variable: another optional variable, that has a much longer name than the other args, and which does nothing. returns: a dict mapping keys to the corresponding table row data fetched. each row is represented as a tuple of strings. for example: {'serak': ('rigel vii', 'preparer'), 'zim': ('irk', 'invader'), 'lrrr': ('omicron persei 8', 'emperor')} if a key from the keys argument is missing from the dictionary, then that row was not found in the table. raises: ioerror: an error occurred accessing the bigtable.table object. pass
类
类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性(attributes), 那么文档中应该有一个属性(attributes)段. 并且应该遵守和函数参数相同的格式.
classsampleclass(object):summary of class here. longer class information.... longer class information.... attributes: likes_spam: a boolean indicating if we like spam or not. eggs: an integer count of the eggs we have laid. def__init__(self,likes_spam=false):inits sampleclass with blah.self.likes_spam=likes_spamself.eggs=0defpublic_method(self):performs operation blah.
块注释和行注释
最需要写注释的是代码中那些技巧性的部分. 如果你在下次代码审查的时候必须解释一下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释.
# we use a weighted dictionary search to find out where i is in# the array. we extrapolate position based on the largest num# in the array and the array size and then do binary search to# get the exact number.ifi&(i-1)==0:# true iff i is a power of 2
为了提高可读性, 注释应该至少离开代码2个空格.
另一方面, 绝不要描述代码. 假设阅读代码的人比你更懂python, 他只是不知道你的代码要做什么.
# bad comment: now go through the b array and make sure whenever i occurs# the next element is i+1类
如果一个类不继承自其它类, 就显式的从object继承. 嵌套类也一样.
yes:classsampleclass(object):passclassouterclass(object):classinnerclass(object):passclasschildclass(parentclass):explicitly inherits from another class already.no:classsampleclass:passclassouterclass:classinnerclass:pass
继承自object是为了使属性(properties)正常工作, 并且这样可以保护你的代码, 使其不受python 3000的一个特殊的潜在不兼容性影响. 这样做也定义了一些特殊的方法, 这些方法实现了对象的默认语义, 包括__new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__.
字符串yes:x=a+b x='%s, %s!'%(imperative,expletive)x='{}, {}!'.format(imperative,expletive)x='name: %s; score: %d'%(name,n)x='name: {}; score: {}'.format(name,n)no:x='%s%s'%(a,b)# use + in this casex='{}{}'.format(a,b)# use + in this casex=imperative+', '+expletive+'!'x='name: '+name+'; score: '+str(n)
避免在循环中用+和+=操作符来累加字符串. 由于字符串是不可变的, 这样做会创建不必要的临时对象, 并且导致二次方而不是线性的运行时间. 作为替代方案, 你可以将每个子串加入列表, 然后在循环结束后用.join连接列表. (也可以将每个子串写入一个cstringio.stringio缓存中.)
yes:items=['']forlast_name,first_nameinemployee_list:items.append(''%(last_name,first_name))items.append('
%s, %s
')employee_table=''.join(items)no:employee_table=''forlast_name,first_nameinemployee_list:employee_table+=''%(last_name,first_name)employee_table+=' %s, %s
在同一个文件中, 保持使用字符串引号的一致性. 使用单引号'或者双引号之一用以引用字符串, 并在同一文件中沿用. 在字符串内可以使用另外一种引号, 以避免在字符串中使用. pylint已经加入了这一检查.
yes:python('why are you hiding your eyes?')gollum(i'm scared of lint errors.)narrator('good! thought a happy python reviewer.')no:python(why are you hiding your eyes?)gollum('the lint. it burns. it burns us.')gollum(always the great lint. watching. watching.)
为多行字符串使用三重双引号而非三重单引号'''. 当且仅当项目中使用单引号'来引用字符串时, 才可能会使用三重'''为非文档字符串的多行字符串来标识引用. 文档字符串必须使用三重双引号. 不过要注意, 通常用隐式行连接更清晰, 因为多行字符串与程序其他部分的缩进方式不一致.
yes:print(this is much nicer.\ndo it this way.\n)no:printthis is pretty ugly. don't do this. 文件和sockets
在文件和sockets结束时, 显式的关闭它.
除文件外, sockets或其他类似文件的对象在没有必要的情况下打开, 会有许多副作用, 例如:
它们可能会消耗有限的系统资源, 如文件描述符. 如果这些资源在使用后没有及时归还系统, 那么用于处理这些对象的代码会将资源消耗殆尽.
持有文件将会阻止对于文件的其他诸如移动、删除之类的操作.
仅仅是从逻辑上关闭文件和sockets, 那么它们仍然可能会被其共享的程序在无意中进行读或者写操作. 只有当它们真正被关闭后, 对于它们尝试进行读或者写操作将会跑出异常, 并使得问题快速显现出来.
而且, 幻想当文件对象析构时, 文件和sockets会自动关闭, 试图将文件对象的生命周期和文件的状态绑定在一起的想法, 都是不现实的. 因为有如下原因:
没有任何方法可以确保运行环境会真正的执行文件的析构. 不同的python实现采用不同的内存管理技术, 比如延时垃圾处理机制. 延时垃圾处理机制可能会导致对象生命周期被任意无限制的延长.
对于文件意外的引用,会导致对于文件的持有时间超出预期(比如对于异常的跟踪, 包含有全局变量等).
推荐使用以管理文件:
withopen(hello.txt)ashello_file:forlineinhello_file:printline
对于不支持使用with语句的类似文件的对象,使用 contextlib.closing():
importcontextlibwithcontextlib.closing(urllib.urlopen())asfront_page:forlineinfront_page:printline
legacy appengine 中python 2.5的代码如使用with语句, 需要添加 from __future__ import with_statement.
todo注释
为临时代码使用todo注释, 它是一种短期解决方案. 不算完美, 但够好了.
todo注释应该在所有开头处包含todo字符串, 紧跟着是用括号括起来的你的名字, email地址或其它标识符. 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主要目的是为了有一个统一的todo格式, 这样添加注释的人就可以搜索到(并可以按需提供更多细节). 写了todo注释并不保证写的人会亲自解决问题. 当你写了一个todo, 请注上你的名字.
# todo(kl@gmail.com): use a * here for string repetition.# todo(zeke) change this to use relations.
如果你的todo是将来做某事的形式, 那么请确保你包含了一个指定的日期(2009年11月解决)或者一个特定的事件(等到所有的客户都可以处理xml请求就移除这些代码).
导入格式
每个导入应该独占一行
yes:importosimportsysno:importos,sys
导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:
标准库导入
第三方库导入
应用程序指定导入
每种分组中, 应该根据每个模块的完整包路径按字典序排序, 忽略大小写.
importfoofromfooimportbarfromfoo.barimportba***romfoo.barimportquuxfromfoobimportar语句
通常每个语句应该独占一行
不过, 如果测试结果与测试语句在一行放得下, 你也可以将它们放在同一行. 如果是if语句, 只有在没有else时才能这样做. 特别地, 绝不要对try/except这样做, 因为try和except不能放在同一行.
yes:iffoo:bar(foo)no:iffoo:bar(foo)else:baz(foo)try:bar(foo)exceptvalueerror:baz(foo)try:bar(foo)exceptvalueerror:baz(foo)访问控制
在python中, 对于琐碎又不太重要的访问函数, 你应该直接使用公有变量来取代它们, 这样可以避免额外的函数调用开销. 当添加更多功能时, 你可以用属性(property)来保持语法的一致性.
(译者注: 重视封装的面向对象程序员看到这个可能会很反感, 因为他们一直被教育: 所有成员变量都必须是私有的! 其实, 那真的是有点麻烦啊. 试着去接受pythonic哲学吧)
另一方面, 如果访问更复杂, 或者变量的访问开销很显著, 那么你应该使用像get_foo()和set_foo()这样的函数调用. 如果之前的代码行为允许通过属性(property)访问 , 那么就不要将新的访问函数与属性绑定. 这样, 任何试图通过老方法访问变量的代码就没法运行, 使用者也就会意识到复杂性发生了变化.
命名
module_name, package_name, classname, method_name, exceptionname, function_name, global_var_name, instance_var_name, function_parameter_name, local_var_name.
应该避免的名称
单字符名称, 除了计数器和迭代器.
包/模块名中的连字符(-)
双下划线开头并结尾的名称(python保留, 例如__init__)
命名约定
所谓内部(internal)表示仅模块内可用, 或者, 在类内是保护或私有的.
用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含).
用双下划线(__)开头的实例变量或方法表示类内私有.
将相关的类和顶级函数放在同一个模块里. 不像java, 没必要限制一个类一个模块.
对类名使用大写字母开头的单词(如capwords, 即pascal风格), 但是模块名应该用小写加下划线的方式(如lower_with_under.py). 尽管已经有很多现存的模块使用类似于capwords.py这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰.
python之父guido推荐的规范
type public internal
moduleslower_with_under_lower_with_under
packageslower_with_under
classescapwords_capwords
exceptionscapwords
functionslower_with_under()_lower_with_under()
global/class constantscaps_with_under_caps_with_under
global/class variableslower_with_under_lower_with_under
instance variableslower_with_under_lower_with_under (protected) or __lower_with_under (private)
method nameslower_with_under()_lower_with_under() (protected) or __lower_with_under() (private)
function/method parameterslower_with_under
local variableslower_with_under
main
即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个main()函数中.
在python中, pydoc以及单元测试要求模块必须是可导入的. 你的代码应该在执行主程序前总是检查if __name__ == '__main__', 这样当模块被导入时主程序就不会被执行.
defmain():...if__name__=='__main__':main()
所有的顶级代码在模块导入时都会被执行. 要小心不要去调用函数, 创建对象, 或者执行那些不应该在使用pydoc时执行的操作.
组态王与单片机多机串口通信的设计
过车辆计算网关平台推动软件定义的汽车
如何增强Wi-Fi信号
为什么心脏起搏器容易受到攻击
英特尔开发48核智能手机平板电脑芯片
python入门之编码风格规范分享
打游戏用哪种蓝牙耳机比较好，618打游戏买什么蓝牙耳机好
mos管开关电路
过年送什么礼物好？2022年货节好物推荐
苹果再压三星，明年上演的iphone8拍照提升：支持光学防抖
PCB库问题有哪一些
全局数据包通信简介
亚马逊 Luna 云游戏登陆安卓平台，仅支持部分 Pixel 、三星及一加手机
什么是景区气象站，关于它的特点以及注意事项
光华芯音频Codec大全，光华芯产品选型表汇总
富士通推出24款具有LCD控制功能的新型宽电压8位微控制器
sense-id:不间断式LORA物联网关
电子线束标准设计的五个阶段
万物互联时代，我们的生活将会有更多的可能性
输电网配电系统的组成、功能及作用