PEP8语法规范解释说明

PEP8规范解析

内容概要:

1.PEP8规范是什么?

2.PEP8相关内容

1.PEP8规范是什么

PEP是Python Enhancement Proposal的缩写,翻译为:“Python 增强提案”

每个PEP都是一份为Python社区提供的指导Python往更好的方向发展的技术文档,其中的第8号增强提案(PEP 8)是针对Python语言编订的代码风格指南。

那么他的主要目的是为了让大家书写Python代码更美观,更标准,更专业。

虽然我们如果不按照PEP规则去书写Python代码也可以正常运行

但是在多人开发的环境下,大家都按照PEP的规范去书写代码是一个很重要的事情。

2.PEP8相关内容介绍:

1.代码布局:

  • 缩进

1、使用空格来表示缩进而不要用制表符(Tab)。这一点对习惯了其他编程语言的人来说简直觉得不可理喻,因为绝大多数的程序员都会用Tab来表示缩进,但是要知道Python并没有像C/C++或Java那样的用花括号来构造一个代码块的语法,在Python中分支和循环结构都使用缩进来表示哪些代码属于同一个级别,鉴于此Python代码对缩进以及缩进宽度的依赖比其他很多语言都强得多。在不同的编辑器中,Tab的宽度可能是2、4或8个字符,甚至是其他更离谱的值,用Tab来表示缩进对Python代码来说可能是一场灾难。

2、和语法相关的每一层缩进都用4个空格来表示。

3、每行的字符数不要超过79个字符,如果表达式因太长而占据了多行,除了首行之外的其余各行都应该在正常的缩进宽度上再加上4个空格。

4、函数和类的定义,代码前后都要用两个空行进行分隔。

5、在同一个类中,各个方法之间应该用一个空行进行分隔。

6、二元运算符的左右两侧应该保留一个空格,而且只要一个空格就好。
  • 标识命名符

    PEP 8倡导用不同的命名风格来命名Python中不同的标识符,以便在阅读代码时能够通过标识符的名称来确定该标识符在Python中扮演了怎样的角色(在这一点上,Python自己的内置模块以及某些第三方模块都做得并不是很好)。

1、变量、函数和属性应该使用小写字母来拼写,如果有多个单词就使用下划线进行连接。

2、类中受保护的实例属性,应该以一个下划线开头。

3、类中私有的实例属性,应该以两个下划线开头。

4、类和异常的命名,应该每个单词首字母大写。

5、模块级别的常量,应该采用全大写字母,如果有多个单词就用下划线进行连接。

6、类的实例方法,应该把第一个参数命名为self以表示对象自身。

7、类的类方法,应该把第一个参数命名为cls以表示该类自身。
  • 表达语句与表达式
1、采用内联形式的否定词,而不要把否定词放在整个表达式的前面。例如if a is not b就比if not a is b更容易让人理解。

2、不要用检查长度的方式来判断字符串、列表等是否为None或者没有元素,应该用if not x这样的写法来检查它。

3、就算if分支、for循环、except异常捕获等中只有一行代码,也不要将代码和if、for、except等写在一起,分开写才会让代码更清晰。

4、import语句总是放在文件开头的地方。

5、引入模块的时候,from math import sqrt比import math更好。

6、如果有多个import语句,应该将其分为三部分,从上到下分别是Python标准模块、第三方模块和自定义模块,每个部分内部应该按照模块名称的字母表顺序来排列。
posted @ 2022-09-24 10:33  dd随风  阅读(49)  评论(0编辑  收藏  举报