Python 代码风格指引摘录

Python 代码风格指引摘录

原网站：
英文：https://legacy.python.org/dev/peps/pep-0008/#prescriptive-naming-conventions
中文繁体：https://wiki.jiayun.info/PEP_8_–_Style_Guide_for_Python_Code#.E5.91.BD.E5.90.8D.E6.85.A3.E4.BE.8B

愚蠢的一致性是小心眼中的妖怪

• Guido的重要简介之一：代码被阅读的次数，远大于被撰写的次数。

代码编排

• 不要混用tab和空格
• 每一行限制在79个字符内，有利于多个视窗并排
• 可以用反斜杠 \ 会更好
• 最高层级的function和class用两个空行，里面的用一个

import

• import两个module应该分两行
• import放在最开始的位置
• 对import进行分组

空白

• 各种括号紧连的地方不用空格
• 逗号，分号，冒号前不用空格
• 函数调用的参数左括号前不用空格
• 索引的左括号前不用空格
• 二元运算符前后使用空格
• 等号被用于关键字参数或预设参数值时，不用空格

注释

• #后加一个空格

文件字串

• public的module，function，class，method都要写文件字串，放在def行下，用’’’

命名惯例

• module：小写字母与下划线
• package：小写字母，不鼓励下划线
• class: 首字母大写，内部使用的class名称前加一个下划线
• function：小写字母与下划线
• instance method 的第一个参数用self
• class method 的第一个参数用cls
• 当参数名称与关键字冲突时，最好加下划线，如print_