BUG

Python编码规范

介绍

养成良好的编程习惯是非常重要的,不仅可以让代码简洁、美观,也有助于阅读。在学习Python的过程中,有时感觉比较迷茫的一点有时候一个功能的实现有多种方法,那么采用哪种方法,哪种写法可以让自己的代码更高效,更Pythonic呢?所以决定整理一份自己的编程规范出来,不仅包括一些代码、布局、命名规范,也会积累一些我在日常学习中遇到的比较高效、简洁或者更有Python范的写法。

前六节内容主要根据PEP8编码规范撰写,转载自https://www.jianshu.com/p/52f4416c267d,其余内容为本人日常积累。

一、代码编排

1.缩进。4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格。

2.每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。

3.类和top-level函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。

二、文档编排

1.模块内容的顺序:模块说明、docstring、import、globals&constants、其他定义。其中import部分,又按标准、第三方和自己编写顺序依次排放,之间空一行。

2.不要在一句import中多个库,比如import os, sys不推荐。

三、空格的使用

  1. 总体原则:避免不必要的空格。
  2. 各种右括号前不要加空格。
  3. 逗号、冒号、分号前不要加空格。
  4. 函数的左括号前不要加空格。如Func(1)
  5. 序列的左括号前不要加空格。如list[2]
  6. 操作符左右各加一个空格,不要为了对齐增加空格。
  7. 函数默认参数使用的赋值符左右省略空格。
  8. 不要将多句语句写在同一行,尽管使用允许。
  9. if/for/while语句中,即使执行语句只有一句,也必须另起一行。

四、注释

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

1.块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如:

# Description : Module config.
# 
# Input : None
#
# Output : None

2.行注释,在一句代码后加注释。比如:(但是这种方式尽量少使用)

x = x + 1       # Increment x

3.避免无谓的注释。

五、文档描述

  1. 为所有的共有模块、函数、类、方法写docstrings;非共有的没有必要,但是可以写注释(在def的下一行)。
  2. 如果docstring要换行,参考如下例子,详见PEP 257
"""
Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""

六、命名规范

总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。

  1. 尽量单独使用小写字母‘l’,大写字母‘O’等容易混淆的字母。
  2. 模块命名尽量短小,使用全部小写的方式,可以使用下划线。
  3. 包命名尽量短小,使用全部小写的方式,不可以使用下划线。
  4. 类的命名使用大写单词的方式,模块内部使用的类采用_CapWords的方式。
  5. 异常命名使用大写单词+Error后缀的方式。
  6. 全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是all机制;二是前缀一个下划线。
  7. 函数命名使用全部小写的方式,可以使用下划线。
  8. 常量命名使用全部大写的方式,可以使用下划线。
  9. 类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。
  10. 类的属性有3种作用域publicnon-publicsubclass API,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。
  11. 类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。
  12. 为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。
  13. 类的方法第一个参数必须是self,而静态方法第一个参数必须是cls

七、实践总结

1.使用列表推导式读取文件内容:

def get_list(path):
    with open(path, 'r', encoding='utf-8') as f:
        lst = [ line.strip() for line in f ]
    return lst

2.生成排列可以用product:

from itertools import product
l = [1, 2, 3]
print list(product(l, l))
print list(product(l, repeat=4))

组合的话可以用combinations:

from itertools import combinations
print list(combinations([1,2,3,4,5], 3))

3.统计一个字符串中子字符串的个数

s= 'abababab'

# 不重复统计
s.count('aba')  # 2次

# 重复统计
import re
reg=re.compile("(?=aba)")
length=len(reg.findall(s))  # 3次