python

部分PEP8规范

本文字数: 822 阅读时长: 3 分钟
阅读次数次

概述

​PEP是Python Enhancement Proposal的缩写，通常翻译为“Python增强提案”。
​每个PEP都是一份为Python社区提供的指导Python往更好的方向发展的技术文档，
其中的第8号增强提案（PEP 8）是针对Python语言编订的代码风格指南。

空格使用

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

代码布局

  • 1.每行最大长度为120
  • 2.class需要空两行
  • 3.缩进为4空格表示

文档编排

  • 1.导入包需要按照内置包、第三方包、自己写的包的顺序分块导入
  • 2.不要在import一句中导入多个库，如import time, math
  • 3.为了避免库冲突少使用from xxx import xxx，改用import xxx，xxx.xxx调用

注释使用

  • 1.当一段代码发生变化时，第一件事就是要修改注释！

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

    1
    2
    3
    4
    5
    # Description : Module config.
    # 
    # Input : None
    #
    # Output : None

  • 3.行注释，在一句代码后加注释。比如：(但是这种方式尽量少使用)

    1
    x = x + 1       # Increment x

  • 4.避免无谓的注释。

命名规范

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