一、Python代码风格指南
- PEP8: Python代码风格指南
PEP8 提供了 Python 代码的编写约定. 本节知识点旨在提高代码的可读性, 并使其在各种 Python 代码中编写风格保持一致
(一)缩进
- 缩进使用4个空格, 空格是首选的缩进方式. Python3 不允许混合使用制表符和空格来缩进.
(二)换行
- 每一行最大长度限制在79个字符以内.
- 顶层函数、类的定义, 前后使用两个空行隔开
- import 导入建议在不同的行
- 导入建议在不同的行, 例如:
import os
import sys - 不建议如下导包
import os, sys - 但是可以如下:
from subprocess import Popen, PIPE
- 导入建议在不同的行, 例如:
- 避免将小的代码块和 if/for/while 放在同一行, 要避免代码行太长.
- if foo == ‘blah’: do_blah_thing()
- for x in lst: total += x
- while t < 10: t = delay()
(三)导入包的顺序
- 导包位于文件顶部, 在模块注释、文档字符串之后, 全局变量、常量之前. 导入按照以下顺序分组:
- 标准库导入
- 相关第三方导入
- 本地应用/库导入
- 在每一组导入之间加入空行
(三)统一性
- Python 中定义字符串使用双引号、单引号是相同的, 尽量保持使用同一方式定义字符串. 当一个字符串内部包含单引号或者双引号时, 在最外层使用不同的符号来避免使用反斜杠转义, 从而提高可读性.
(四)空格
- 表达式和语句中的空格:
- 避免在小括号()、方括号[]、花括号{}后跟空格.
- 避免在逗号,、分号;、冒号:之前添加空格
- 冒号在切片中就像二元运算符, 两边要有相同数量的空格. 如果某个切片参数省略, 空格也省略.
- 避免为了和另外一个赋值语句对齐, 在赋值运算符附加多个空格.
- 避免在表达式尾部添加空格, 因为尾部空格通常看不见, 会产生混乱.
- 总是在