Python语法规范

Python语法规范

写在前面：程序阅读的次数比编写的次数要多得多。

昨天我们讲到，我们想要学习Python，就一定要养成良好的编写代码的习惯，那今天，阿槽就带大家来学习一下Python的语法规范。

以下内容精炼自Python的PEP8文档，文档原文链接：https://www.python.org/dev/peps/pep-0008/

目录

• 规范的优先程度
• 命名规范
• 注释规范
• 代码布局规范

规范的优先程度

在PEP8文档中目录的第二行是这么一句话：A Foolish Consistency is the Hobgoblin of Little Minds（愚蠢的一致性是小头脑的妖精），这句话说明什么呢？说明一件事，这个语法规范其实很大程度上是一种建议，没有过多的强制性，那为什么我们还要学呢？

要知道，我们代码的维护和阅读的次数是远远高于我们编写代码的次数，所以，我们应当注重代码的可读性问题，而PEP8的这一段内容则是告诉我们一件事：我们不应当为了遵守语言规范而遵守语言规范，我们应当尊重组织内部、项目内部、代码内部的语言规范。

所以呢，我们规范的优先程度是按照以下方向进行划分的（从高到低）：

1. PEP8的规范
2. 团队内部的规范
3. 项目内部的规范
4. 代码内部的规范

当然，如果我们在使用Python语言规范之后也不能让其他适应Python规范代码的人阅读代码的时候，我们也可以不遵守Python规范。

命名规范

Python的命名规范其实跟其他编程语言的命名规范是很相似的。下面就来给大家介绍一下：

我能用什么作为变量等的名字？

• 字母：Python是一门区分大小写的编程语言，所以，变量名是大写还是小写，这件事情非常重要；
• 下划线：下划线可以作为变量名的一部分，尤其是我们所命的名是由多个单词组合而成的时候；
• 数字：数字不能用在命名的开头，一般使用时习惯放在名称的末尾。

命名时有什么需要注意的？

• 最好使用有特定意义的单词作为名称，这样能极大的提高代码的可读性
• 如果名称中出现缩写词，请记得将缩写词的每个字母都大写
• 不建议使用混合大小写，如果出现多个单词作为名称，请在单词之间用下划线作为间隔（这点和Java有所不同）
• 如果是在給类名命名时，习惯上我们命名的首字母是大写，其他时候我们首选的命名形式是小写字母+下划线
• 不是所有的单词都能作为名称使用：我们不能使用python的关键字或函数的名字作为函数，这会导致关键字或函数不能使用。
• 对于常量，我们可以使用全部字母大写的形式将它与变量区分开来

注释规范

所谓的注释规范就是我们怎么样去写注释，这常常有利于我们阅读代码和让别人阅读代码。

为什么要写注释？

注释是为了解释一句或多句代码的作用，好的注释能都极大地提高代码的可读性。也有利于代码的维护等

怎样进行注释？

1. 使用井号（#）：井号后面加一个空格，再写你要注释的内容，这是最规范的写法
2. 使用一对三引号(’’’ ‘’’)：三引号中间写上你要注释的内容

在哪里添加注释？（什么时候加）

1. 一般情况下，注释都是放在代码的上方，也可以紧跟着代码放在代码那一行的后面，但是绝对不要放在代码的下面，这会让阅读者产生误会的。
2. 在多数企业中，常常会要求程序员在代码的开头用注释的方式说明时间、作者、代码用途等内容
3. 在定义函数的时候添加注释，以说明函数的用途
4. 在一些比较绕或者说比较难的代码前后添加注释

最后一点：如果不是为了教学，我绝对不建议使用一行代码一行注释的形式，因为这会极大地降低代码的可阅读性。

布局规范

缩进

什么时候用缩进呢？

这么说吧，只要你见到有英文的冒号（:）你在下一行就要加一级缩进。

还有一种情况是什么呢？就是当一个括号里面的内容太长了，想要分行显示的时候，就可以通过缩进来使得代码的内容垂直对齐，提高可读性。

一个缩进是多少？

通常而言，一级缩进等于1个Tab键和4个空格

Tab键还是空格

通常情况下，建议大家使用空格键而不是Tab键，因为使用空格键的话能够减少因为Tab键和空格键的混用而产生报错的概率。当然这也不是绝对的，只要我们坚持只用一种就行了。

空行

空行是什么？

空行就是在某段代码前后添加的、空白的行

加在什么地方？

空行通常加在所有import语句的下面，定义函数的前后，定义类的后面……

总之，就是加在某段功能已经完整了的代码的下面

科学地import

import 的4种方法：

import numpy
import bs4.BeautifulSoup
form bs4 import BeautifulSoup as BS
import numpy as np