PEP8规范---Style Guide for Python Code
PEP8 简介
1. PEP是 Python Enhancement Proposal 的缩写,通常翻译为:Python增强提案 enhance 增强改善(V) Proposal 提议建议(n)
2. 每个PEP都是一份为Python社区提供的指导Python往更好的方向发展的技术文档,其中的第8号增强提案(PEP 8)是针对Python语言编订的代码风格指南。
3. 尽管我们可以在保证语法没有问题的前提下随意书写Python代码,但是在实际开发中,采用一致的风格书写出可读性强的代码是每个专业的程序员应该做到的事情,也是每个公司的编程规范中会提出的要求,这些在多人协作开发一个项目(团队开发)的时候显得尤为重要。
一 缩进与对齐 Indentation and
空格的使用 Spaces
1. 使用空格而不是tab键来缩进。(空格是首选的缩进方式。制表符Tab只能用于与同样使用制表符缩进的代码保持一致。)
2. 和语法相关的每一层缩进都用4个空格来表示。
3. 在 list dict tuple set 参数列表的,后面加一个空格。
4. 括号(), {}, [] 内的两端不需要空格。
5. 在注释符号 # 后面加一个空格 ,行内注释 #号要与代码至少两个空格分隔。
6. 避免使用无关的空格:
6.1 小括号,中括号或者大括号里面与数据间不要有空格。
比如不要出现这种( aaaa ),应是这样(aaa)
6.2 逗号,分号;或者冒号: 之前不要有空格。
比如 不要这样 if x == 4 : print x , y ; x , y = y , x
应该这样 if x == 4: print x, y; x, y = y, x
6.3 函数参数的左括号之前不要有空格。
不要这样spam (1)
应该这样spam(1)
7. 一般在使用到 +号 —号 =号 时两边各加一个空格,特殊情况除外。
8. 函数和类的定义,代码前后都要用两个空行进行分隔。
9. 在同一个类中,各个方法之间应该用一个空行进行分隔。
行的最大长度 Maximum Line Length
1. 每行代码应尽量的少于79个字符,,文档和注释限制在72个字符
长表达式换行
1. 一个长表达式被分成多行表示的时候要添加额外的4个空格来保持缩进的美观。
2. 通过小括号内表达式的换行方式将长串折成多行。这种方式应该优先使用,而不是使用反斜杠续行。
3. 代码换行时应该优先使用圆括号、方括号和花括号中的隐式续行。
4. 在二元运算法的换行时,推荐以二元运算符作为新行的开始。
二 空行 Blank Lines
1. 即使是简单的语句,即使可以使用分号,不推荐写在同一行,比如简单的if/for/while语句也应该分行写。
2. 不要把多个语句写在一行,然后用 ; 隔开。
最好如下这样
if foo == 'blah':
do_blah_thing()
do_one()
do_two()
do_three()
不要如下这样
if foo == 'blah': do_blah_thing()
do_one(); do_two(); do_three()
3. 函数内逻辑无关的段落之间空一行,不要过度使用空行
4. function 和 class 顶上两个空行
5. class 的 method 之间一个空行
三 导入 Imports
1. 导入顺序:首应该是标准库,第三方库,以及本地模块,且需要加空行分隔。
标识符命名
1. 变量、函数和属性应该使用小写字母来拼写,如果有多个单词就使用下划线进行连接。
2. 常量通常定义在模块级,通过下划线分隔的全大写字母命名。例如: MAX_OVERFLOW 和 TOTAL
表达式和语句
。。。。。。
标签:空行,空格,缩进,do,python,PEP8,---,Python,代码 From: https://www.cnblogs.com/tengyifan888/p/16726793.html