写于面前

对此代码而言，相比叫写，它重多是朗诵之。

pep8

一如既往、代码编排

缩进，4个空格的缩进，编辑器都好形成这个作用；
每行最特别长79，换行可以动用反斜杠，换行点要以操作符的后面。
类与top-level函数定义之间空两行；类吃的计定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

次、文档编排

模块内容之逐条：模块说明与docstring—import—globals&constants—其他概念。其中import部分，又遵循正统、三正在和协调修顺序依次排放，之间空一行。
不用以同等句子import中大多只仓库，比如import os, sys不推荐。
假如用from XX import
XX引用库，可以简单‘module.’，都是可能出现命名冲突，这时就要动用import
XX。

老三、空格使用，

避免使用不必要的空格

各种右括号前不用加空格。
逗号、冒号、分号前不要加空格。
函数的左括号前毫不加空格。如Func(1)。
列的左括号前毫无加空格。如list[2]。
操作符左右每加一个空格，不要以对旅加空格。
函数默认参数使用的赋值符左右省略空格。
绝不用大半句子语句写于平行，尽管使‘；’允许。
if/for/while语句被，即使实行报告句只生一样句子，也必另起一行。

四、注释

总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！
注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。

避免无谓的笺注
施行注释，在同等句代码后加注。
```
print 'hello'  # 行注释
```
片注释，在平段落代码前加的笺注。在‘#’后加以相同空格。段落中为单纯发‘#’的实行间隔。
```
# Description : Module config.
# 
# Input : None
#
# Output : None
```

五、文档描述

否保有的共有模块、函数、类、方法勾勒docstrings；非共有的远非必要，但是可以写注释（在def的产一行）

单行注释请参考如下方式

def func():
    """Return a and b. tuple"""
    a = 1
    b = 2
    return a, b

六、命名规范

尽量避免动小写字母‘l’，大写字母‘O’等容易混淆的假名。
模块命名尽量少小，使用成套大写的点子，可以采用下划线。
包命名尽量短小，使用所有大写的法门，不可以运用下划线。
恍如的命名使用CapWords的法，模块内部使用的接近以_CapWords的方式。
坏命名使用CapWords+Error后缀的计。
全局变量尽量只在模块内有效，类似C语言中之static。实现方式有有限栽，一是__all__机制;二凡是前缀一个下划线。
函数命名使用所有大写的办法，可以行使下划线。
常量命名使用成套大写的主意，可以用下划线。
好像的属性（方法与变量）命名使用成套大写的方，可以采取下划线。
仿佛的习性有3种意向域public、non-public和subclass
API，可以掌握成C++中的public、private、protected，non-public属性前，前缀一长达下划线。
看似的性若与主要字名字冲突，后缀一下涂鸦，尽量不要采用缩略等其它方。
为避免与子类属性命名冲突，在看似的有的性质前，前缀两久下划线。比如：类Foo中宣称__a,访问时，只能通过Foo._Foo__a，避免歧义。如果子类也被Foo，那便无法了。
好像的措施第一独参数必须是self，而静态方法第一个参数必须是cls。

编程建议

编码中考虑到其它python实现之效率等问题，比如运算符‘+’在CPython（Python）中效率特别高，都是Jython中倒是十分低，所以理应下.join()的章程。
尽可能用‘is’‘is not’取代‘==’，比如if x is not None 要优于if x。
动基于类的十分，每个模块或担保都发好之不胜类，此很类继承自Exception。
坏中不要采用裸露的except，except后和实际的exceptions。
```
try:
    ...
except Exception as ex:
    raise ex
```
异常中try的代码尽可能少。

运用startswith() and endswith()代替切片进行排前缀或后缀的检讨。

str = "test123abc"
if str.startwith("test") and str.endwith("abc"):
    print 'yes'
else:
    print 'no'

# 不要使用下面的方式
if str[:4] == "test" and str[-3:] == 'abc':
    print 'yes'
else:
    print 'no'

运isinstance()比较对象的色。比如:

test = 'abc123'

print isinstance(test, int)  # False
print isinstance(test, str)  # True

澳门新莆京网站app

C语言PEP8 Python

写于面前

一如既往、代码编排

次、文档编排

老三、空格使用，

四、注释

五、文档描述

六、命名规范

编程建议

相关文章