pep8python编码规范整理

《pep8python编码规范整理》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、决定开始Pyth，之路/,利用业余时间，争取更深入学习Python。编程语言不是艺术，而疋工作或者说是工拉，所以整理并遵循一套编码规范是十分必要的。所以今天下午我枢据PEP8整理了一份，以后都照此编码了，还会持续更新。PEP8Python编码规范一代码编排1缩进。4个空格的缩进（编辑器都可以完成此功能），不使用Tap，更不能混合使用Tap和空格。2每行最大长度79,换行可以使用反斜杠，最好使用圆括号。换行点要在操作符的后边敲回车。3类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。二文档编排1模块内界的顺序：枚:块

2、说明和docstring—import—globals&constants—其他定义。其屮import部分，又按标准、三方和自己编写顺序依次排放，之间空一行。2不要在一句import中多个痺，比如importos,sys不推荐。3如果采用什omXXimportXX引用库，可以省略‘module.’，都是可能出现命名冲突，这时就要采用importXX。三空格的使用总体原则，避免不必要的空格。1各种右括号前不要加空格。2逗号、冒号、分号前不要加空格。3函数的左括号前不要加空格。如Func（l｝。4序列的左拈号前不要加空格。如list[2】。5操作符左右各加一个空格，不要为了对齐增加空格。6

3、函数默认参数使用的赋[符左右省略空格。7不要将多句语句写在同一行，尽管使用允许。8if/for/while语句中，即使执行语句只有一句，也必须另起一行。四注释总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。1块注释，在一段代码前增加的注释。在后加一空格。段落之间以只有‘#’的行间隔。比如：#Description:Moduleconfig.##Input:None材林Output:None2行注释，在一句代码后加注释。比如：x=

4、x+1#Incrementx但是这种方式尽量少使用。3避免无谓的注释。五文档描述1为所有的共有模块、函数、类、方法写docstdngs;非共有的没有必要，但是可以写注释（在def的下一行）。2如果docstring要换行，参考如下例子，详见PEP257"""ReturnafoobangOptionalplotzsaystofrobnicatethebizbazfirst.六命名规范总体原则，新编代码必须按下而命名风格进行，现存库的编码尽量保持风格。1尽量单独使用小写字母‘I’，大写字母‘0’等容易混淆的字母。2模块命名尽量短小，使用全部小写的方式，可以使用下划线。3包命名尽量短小，使用

5、全部小写的方式，不可以使用下划线。4类的命名使用CapWords的方式，模块内部使用的类采的方式。5异常命名使用CapWords+Error后缀的方式。6全局变量尽量只在模块内有效，类似C语言中的static。实现方法有两种，一是_311_机制;二是前缀一个下划线。7函数命名使用全部小写的方式，可以使用下划线。8常量命名使川全部大写的方式，可以使用下划线。9类的属性(方法和变i)命名使用全部小写的方式，可以使用下划线。9类的属性有3种作用域public、non-public和subclassAPI,可以理解成C++中的public、private、protected,non-publi

6、c属性前，前缀一条下划线。11类的属性若与关键字名字冲突，后缀一下划线，尽i不要使用缩略等其他方式。12为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。比如：类Foo中声明_a,访问时，只能通过Foo._Foo_a，避免歧义。如果子类也叫Foo，那就无能力力了。13类的方法第一个参数必须是self，而静态方法第一个参数必须是cis。七编码建议1编码中考虑到其他python实现的效率等问题，比如运算符‘+’在CPython(Python)中效率很高，都是jython中却非常低，所以应该采用.join()的方式。2尽可能使用‘is’‘isnot’取代‘==’，比如ifxisno

7、tNone要优于ifx。3使用基于类的异常，每个模块或包都有自己的异常类，此异常类继承自Exception。4异常中不要使用裸露的except,except后跟具体的exceptions。5异常中try的代码尽可能少。比如：try:value=collection[key]exceptKeyError:returnkey_not_found(key)else:returnhandle_value(value)要优于try:#Toobroad!r