拓展01 :代码风格/Python Style
代码规范
关于代码规范,详细内容可以看 PEP 8
这是Python官方对于代码规范的要求。
以下我来总结几点重要内容。
关于空格
- 使用空格来表示缩进而不要用制表符(Tab)。
- 和语法相关的每一层缩进都用4个空格来表示。
- 每行的字符数不要超过79个字符,如果表达式因太长而占据了多行,除了首行之外的其余各行都应该在正常的缩进宽度上再加上4个空格。
- 函数和类的定义,代码前后都要用两个空行进行分隔。
- 在同一个类中,各个方法之间应该用一个空行进行分隔。
- 二元运算符的左右两侧应该保留一个空格,而且只要一个空格就好。
- 注释时代码后面空两格,
#
后空一格。
命名
- 常量通常在模块级别定义,并写入所有大写字母,并以下划线分隔单词。例如 :
MAX_OVERFLOWTOTAL
。 - 必须以字⺟(a-z, A-Z)或下划线(_)开头,只允许出现英⽂字⺟、数字、下划线,对⼤⼩写敏感(例如,name 和 Name 是不同的变量),不可使⽤ Python 保留关键字。
例如这些是合法的
my_variable = 1
user_name = 'John'
total_count = 50
is_valid = True
例如这些是不合法的
123_variable(不能以数字开头)
my-variable(不能使用中划线)
if(不能使用关键字)
常用的命名规范
常⽤命名规范:
- 使用小写字母:变量名通常使用小写字母。
- 多个单词用下划线分隔:例如
user_name
、first_name
。 - 类名采用大驼峰命名法:即每个单词的首字母大写,如
MyClass
。
引入模块
当引入模块时
- import语句总是放在文件开头的地方。
- 引入模块的时候,from math import sqrt比import math更好。
- 如果有多个import语句,应该将其分为三部分,从上到下分别是Python标准模块、第三方模块和自定义模块,每个部分内部应该按照模块名称的字母表顺序来排列。