python编码风格

最新推荐文章于 2022-05-10 11:05:42 发布

结婚兔

最新推荐文章于 2022-05-10 11:05:42 发布

阅读量391

点赞数

分类专栏： Python

9 篇文章 0 订阅

订阅专栏

#!/usr/bin/env python           #在文件头部 ( 第一行 ) 加上 设置 Python 解释器
# -*- coding: utf-8 -*-         #在文件头部 ( 第二行 ) 加上 在编辑器中设置以 UTF-8 默认编码保存文件

docstring 是 Python 特有的注释风格,它是模块、类或函数的第一个语句,可以通过 doc 方法访问
用英语撰写注释,短注释可以忽略末尾的句号 (.)
docstring 为每个模块、类或函数撰写 docstring 推荐使用三个双引号 (”””) 来定义 docsting , 不推荐使用三个单引号 (''')
模块的 docsting 放在文件头部,版权信息之后

”””This is a one line docstring.””” ”””The title of a multiline docstring: After title is the content.You can write it as long as needed. ”””

把 import 语句放在文件头部,在模块 docstring 之后,在模块全局变量或全局常量之前
按照从一般到特殊的原则分组 import 语句,先 import 标准库,然后 import 第三方库,最后 import 程序中的自定义库
在不同分组的 import 语句之间加空行
每个 import 语句只导入一个模块

import sys import time from PyQt.QtCore import SIGNAL, QTimer

使用中文字符,在文件头部加上

# import sys
# reload(sys)
# sys.setdefaultencoding('utf-8')

一行代码的长度不能超过 79 个字符
在括号 ( 圆括号、方括号、花括号 ) 内部折行是推荐使用的方式

fooBar(self, width, height, color='balck', design=None, x='foo', emphasis=None, highlight=0)

需要时可以在表达式两侧加上额外的括号

if (width == 0 and height == 0 and
color == 'red' and empasis == 'strong'):

括号内的长字符串可以直接写成两个短字符串

x = ('This will build a very long long '
'long long long long long long string')

使用续行符号,折行的位置可以在逗号 (,) 后或运算符前,折行后要多一个缩进

from PyQt4.QtCore import QTextCodec, SIGNAL, SLOT, \
QLibraryInfo, QTimer

veryLongVariableA = veryLongVariableB \

+ verLongVariableC

逗号 (,) 、冒号 (:) 后要加空格
二元运算符前后要加空格,如赋值运算符 (=) 、比较运算符 (==, <, >, !=, <=, >=, in, not in, is, is not) 和逻辑运算符 (and, or, not)
算数运算符前后要加空格

逗号 (,) 、冒号 (:) 前不加空格参数列表、索引 (index) 或切片 (slice) 的前括号 ( 圆括号, 方括号)前不加空格前括号 ( 圆括号、方括号、花括号 ) 后不加空格,后括号前不加空格一元运算符前后不加空格
函数或方法定义或调用时参数列表中的等号 (=) 前后不加空格
冒号 (:) 在行尾时不加空格,如类定义、函数定义、分支语句、循环语句

def main():
    //do something

if __name__ == '__main__':
    main()

关注