欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  后端开发

Python编程规范

程序员文章站 2022-05-12 14:57:50
...
适当的空行有利于增加代码的可读性,加空行可以参考如下几个准则:

1) 在类、函数的定义间加空行;

2) 在 import 不同种类的模块间加空行;

3) 在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起,作为一个逻辑段落,段落间以空行分隔;

> 断行

尽管现在的宽屏显示器已经可以单屏显示超过 256 列字符,但本规范仍然坚持行的最大长度不得超过 80 个字符的标准。折叠长行的方法有以下几种方法:

1) 为长变量名换一个短名,如:

this.is.a.very.long.variable_name = this.is.another.long.variable_name

应改为:

variable_name1 = this.is.a.very.long.variable_name
variable_name2 = this.is.another.variable_name
variable_name1 = variable_name2s

2) Python会将圆括号、中括号和花括号中的行隐式的连接起来,你可以利用这个特点。如需要,你可以在表达式外围增加一对额外的圆括号

3) 在长行加入续行符强行断行,断行的位置应在操作符前,且换行后多一个缩进,以使维护人员看代码的时候看到代码行首即可判定这里存在换行,如:

if color == WHITE or color == BLACK \
    or color == BLUE: # 注意 or 操作符在新行的行首而不是旧行的行尾
do_something(color);

> 字符串

1) 避免在循环中用+和+=操作符来累加字符串。由于字符串是不可变的,这样做会创建不必要的临时对象,并且导致二次方而不是线性的运行时间。作为替代方案,你可以将每个子串加入列表,然后在循环结束后用 .join 连接列表。(也可以将每个子串写入一个 cStringIO.StringIO 缓存中)

2) 为多行字符串使用三重双引号而非三重单引号。不过要注意, 通常用隐式行连接更清晰,因为多行字符串与程序其他部分的缩进方式不一致。

> 命名

一致的命名可以给开发人员减少许多麻烦,而恰如其分的命名则可以大幅提高代码的可读性,降低维护成本。

>> 常量

常量名所有字母大写,由下划线连接各个单词,如

WHITE = 0XFFFFFF
THIS_IS_A_CONSTANT = 1

>> 变量

变量名全部小写,由下划线连接各个单词,如

color = WHITE
this_is_a_variable = 1

私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。

变量名不应带有类型信息,因为 Python 是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。

>> 函数

函数名的命名规则与变量名相同。

>> 类

对类名使用大写字母开头的单词(如CapWords, 即Pascal风格),不使用下划线连接单词。如:

class ThisIsAClass(object):pass

>> 模块

模块名全部小写,对于包内使用的模块,可以加一个下划线前缀,如

module.py_
internal_module.py

>> 包

包的命名规范与模块相同。

>> 缩写

命名应当尽量使用全拼写的单词,缩写的情况有如下两种:

1) 常用的缩写,如 XML、ID等,在命名时也应只大写首字母,如

class XmlParser(object):pass

2) 命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式,如去除元音、包含辅音的首字符等方式,例如:

function 缩写为 fn

text 缩写为 txt

object 缩写为 obj

count 缩写为 cnt

number 缩写为 num,等。

>> 特定命名方式

主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名,它的意义在于这种形式的变量是只读的,这种形式的类成员函数尽量不要重载。如

class Base(object):
    def __init__(self, id, parent =None):
        self.__id__ = id
        self.__parent__ = parent    def __message__(self, msgid):
        # …略

其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。

>> 导入格式

1) import 的次序,先 import Python 内置模块,再 import 第三方模块,最后 import 自己开发的项目中的其它模块;这几种模块用空行分隔开来。

2) 每个import应该独占一行。

3) 不要使用 from module import *,除非是 import 常量定义模块或其它你确保不会出现命名空间冲突的模块。

> 赋值

对于赋值语言,主要是不要做无谓的对齐,如

a            = 1                               # 这是一个行注释
variable = 2                               # 另一个行注释
fn           = callback_function    # 还是行注释

没有必要做这种对齐,原因有两点:一是这种对齐会打乱编程时的注意力,大脑要同时处理两件事(编程和对齐);二是以后阅读和维护都很困难,因为人眼的横向视野很窄,把三个字段看成一行很困难,而且维护时要增加一个更长的变量名也会破坏对齐。直接这样写为佳:

a = 1 # 这是一个行注释
variable = 2 # 另一个行注释
fn = callback_function # 还是行注释

> 语句

通常每个语句应该独占一行。不过, 如果测试结果与测试语句在一行放得下, 你也可以将它们放在同一行。如果是if语句, 只有在没有else时才能这样做。特别地,绝不要对 try/except 这样做,因为try和except不能放在同一行。

相关标签: Python