Python开发规范.docx
- 文档编号:3233037
- 上传时间:2022-11-20
- 格式:DOCX
- 页数:13
- 大小:47.87KB
Python开发规范.docx
《Python开发规范.docx》由会员分享,可在线阅读,更多相关《Python开发规范.docx(13页珍藏版)》请在冰豆网上搜索。
Python开发规范
Python开发规范
总则
概况:
Python风格规范,包含了部分Google风格规范和PEP8规范。
包括Django项目目录结构的一些规范,为适应我们实际需求,提高开发中代码更加可观性、易读性拟定的规范。
第一章命名规范
1.1模块
模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况)
#正确的模块名
importdecoder
importhtml_parser
#不推荐的模块名
importDecoder
类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头classFarm():
pass
classAnimalFarm(Farm):
pass
class_PrivateFarm(Farm):
pass
将相关的类和顶级函数放在同一个模块里.不像Java,没必要限制一个类一个模块.
1.2类名
函数名一律小写,如有多个单词,用下划线隔开
defrun():
pass
defrun_with_env():
pass
私有函数在函数前加一个下划线_
classPerson():
def_private_func():
pass
1.3函数
编写函数的几个原则
函数设计要尽量短小,嵌套层次不宜过深;
函数申明应做到合理、简单、易于使用,函数名应能正确反映函数大体功能,参数设计应简洁明了,参数个数不宜过多;
函数参数设计应考虑向下兼容;
一个函数只做一件事,尽量保证函数语句粒度的一致性;
1.4变量名
避免只用大小写来区分不同的对象;
避免使用容易引起混淆的名称,变量名应与所解决的问题域一致;
不要害怕过长的变量名;
常量使用以下划线分隔的大写命名
MAX_OVERFLOW=100
ClassFooBar:
deffoo_bar(self,print_):
print(print_)
变量名尽量小写,如有多个单词,用下划线隔开
if__name__=='__main__':
count=0
school_name=''
常量采用全大写,如有多个单词,使用下划线隔开
MAX_CLIENT=100
MAX_CONNECTION=1000
CONNECTION_TIMEOUT=600
1.5常量
1.6其他规则
1.所谓”内部(Internal)”表示仅模块内可用,或者,在类内是保护或私有的.
2.用单下划线(_)开头表示模块变量或函数是protected的(使用import*from时不会包含).
3.用双下划线(__)开头的实例变量或方法表示类内私有.
4.将相关的类和顶级函数放在同一个模块里.不像Java,没必要限制一个类一个模块.
5.对类名使用大写字母开头的单词(如CapWords,即Pascal风格),但是模块名应该用小写加下划线的方式(如lower_with_under.py).
1.7应该避免的名称
1.单字符名称
2.包/模块名中使用连字符(-)而不使用下划线(_)
3.双下划线开头并结尾的名称(如__init__)
第二章简明概述
2.1编码
如无特殊情况,文件一律使用UTF-8编码
如无特殊情况,文件头部必须加入#--coding:
utf-8--标识
2.2代码格式
2.2.1、缩进统一使用4个空格进行缩进
2.2.2、行宽每行代码尽量不超过80个字符(在特殊情况下可以略微超过80,但最长不得超过120)
2.2.3不要使用反斜杠连接行
2.2.4Python会将圆括号,中括号和花括号中的行隐式的连接起来,你可以利用这个特点.如果需要,你可以在表达式外围增加一对额外的圆括号.
2.2.5对于行连接的情况,你应该要么垂直对齐换行的元素,或者使用4空格的悬挂式缩进(这时第一行不应该有参数):
理由:
这在查看side-by-side的diff时很有帮助
方便在控制台下查看代码
太长可能是设计有缺陷
2.3引号
简单说,自然语言使用双引号,机器标示使用单引号,因此代码里多数应该使用单引号自然语言使用双引号“…”
例如错误信息;很多情况还是unicode,使用u”你好世界”
机器标识使用单引号‘…’
例如dict里的key
正则表达式使用原生的双引号r”…”
文档字符串(docstring)使用三个双引号“”“……”“”
2.4空行
模块级函数和类定义之间空两行;
classA:
def__init__(self):
pass
defhello(self):
pass
defmain():
pass
```
可以使用多个空行分隔多组相关的函数
函数中可以使用空行分隔出逻辑相关的代码
类成员函数之间空一行;
正确的写法
i=i+1
submitted+=1
x=x*2-1
hypot2=x*x+y*y
c=(a+b)*(a-b)
不推荐的写法
i=i+1
submitted+=1
x=x*2-1
hypot2=x*x+y*y
c=(a+b)*(a-b)
函数的参数列表中,,之后要有空格
正确的写法
defcomplex(real,imag):
pass
不推荐的写法
defcomplex(real,imag):
pass
函数的参数列表中,默认值等号两边不要添加空格
正确的写法
defcomplex(real,imag=0.0):
pass
不推荐的写法
defcomplex(real,imag=0.0):
pass
左括号之后,右括号之前不要加多余的空格
正确的写法
spam(ham[1],{eggs:
2})
不推荐的写法
spam(ham[1],{eggs:
2})
字典对象的左括号之前不要多余的空格
正确的写法
dict['key']=list[index]
不推荐的写法
dict['key']=list[index]
不要为对齐赋值语句而使用的额外空格
正确的写法
x=1
y=2
long_variable=3
不推荐的写法
x=1
y=2
long_variable=3
2.5空格
1.括号内不要有空格
2.不要在逗号,分号,冒号前面加空格,而应该在它们的后面加
3.二元操作符两边都要加上一个空格(=,==,<,>,!
=,in,not...)
4.当’=’用于指示关键字参数或默认参数值时
5.不要用空格来垂直对齐多行间的标记,因为这会成为维护的负担(适用于:
#,=等)
2.6换行
第三章注释规范
3.1文档字符串
Python使用文档字符串作为注释方式:
文档字符串是包,模块,类或函数里的第一个语句.这些字符串可以通过对象的doc成员被自动提取,并且被pydoc所用.我们对文档字符串的惯例是使用三重双引号”“”(PEP-257).
一个文档字符串应该这样组织:
1.首先是一行以句号,问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行).接着是一个空行.
2.接着是文档字符串剩下的部分,它应该与文档字符串的第一行的第一个引号对齐.
3.2行内注释(PEP8)
行内注释是与代码语句同行的注释
1.行内注释和代码至少要有两个空格分隔
2.注释由#和一个空格开始,如下:
x=x+1#Compensateforborder
3.3模块注释
每个文件应该最好包含一个许可样板.根据项目使用的许可(例如,Apache2.0,BSD,LGPL,GPL),选择合适的样板.
#-*-coding:
utf-8-*-
#(C)Zoneyet,Inc.2018-2019
#Allrightsreserved
#LicensedunderSimplifiedBSDLicense(seeLICENSE)
3.4函数和方法
一个函数必须要有文档字符串,除非它满足以下条件:
1.外部不可见
2.非常短小
3.简单明了
文档字符串应该包含函数做什么,以及输入和输出的详细描述
文档字符串应该提供足够的信息,当别人编写代码调用该函数时,他不需要看一行代码,只要看文档字符串就可以了
对于复杂的代码,在代码旁边加注释会比使用文档字符串更有意义.
3.5类
类应该在其定义下有一个用于描述该类的文档字符串.如果你的类有公共属性(Attributes),那么文档中应该有一个属性(Attributes)段.并且应该遵守和函数参数相同的格式.
1.1、块注释
“#”号后空一格,段落件用空行分开(同样需要“#”号)
#块注释
#块注释
#
#块注释
#块注释
1.2、行注释
至少使用两个空格和语句分开,注意不要使用无意义的注释
#正确的写法
x=x+1#边框加粗一个像素
3.6块注释和行注释
不推荐的注释
#不推荐的写法(无意义的注释)
x=x+1#x加1
1.3、建议
在代码的关键部分(或比较复杂的地方),能写注释的要尽量写注释
比较重要的注释段,使用多个等号隔开,可以更加醒目,突出重要性
app=create_app(name,options)
#=====================================
#请勿在此处添加getpost等app路由行为!
!
!
#=====================================
if__name__=='__main__':
app.run()
3.7TODO注释
1.TODO注释应该在所有开头处包含”TODO”字符串,紧跟着是用括号括起来的你的名字,email地址或其它标识符.然后是一个可选的冒号.接着必须有一行注释,解释要做什么
2.如果你的TODO是”将来做某事”的形式,那么请确保你包含了一个指定的日期(“2009年11月解决”)或者一个特定的事件
第四章其他规范
4.1模块导入
1.每个导入应该独占一行
2.模块导入顺序
1标注库导入
2第三方库导入
3应用程序指定导入
3.
正确的写法
importos
importsys
不推荐的写法
importsys,os
正确的写法
fromsubprocessimportPopen,PIPE
import语句应该使用absoluteimport
正确的写法
fromfoo.barimportBar
不推荐的写法
from..barimportBar
import语句应该放在文件头部,置于模块说明及docstring之后,于全局变量之前;
import语句应该按照顺序排列,每组之间用一个空行分隔
importos
importsys
importmsgpack
importzmq
importfoo
导入其他模块的类定义时,可以使用相对导入
frommyclassimportMyClass
每种分
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- Python 开发 规范