【Python编码规范】从这里开头

原文作者：我辈李想
版权声明：文章原创，转载时请务必加上原文超链接、作者信息和本声明。

---

前言

如何命名模块、类、函数、常亮、变量等，使命名更规范;如何注释模块、类、函数、常亮、变量等，使代码更易读。python的编码格式

---

一、编码格式

Python2 中默认编码为 ASCII，假如内容为汉字，不指定编码便不能正确的输出及读取，比如我们想要指定编码为 UTF-8，Python 中通过在开头加入 # -- coding: UTF-8 -- 进行指定。

Python3 中默认编码为 UTF-8，因此在使用 Python3 时，我们通常不需指定编码。

若出现 Python编码问题（电脑的编码可能影响python的编码），可按照以下操作尝试解决：

import sys
reload(sys)
sys.setdefaultencoding('utf-8')

二、命名

序号	类型	规则	示例
1	项目	首字母大写+大写式驼峰	ProjectName
2	模块（文件、包名）	全部小写+下划线驼峰（尽量不要用下划线）	sys、html_parser
3	类	首字母大写+大写式驼峰	TestCase
4	函数	全部小写+下划线驼峰	path_url
5	常亮	常量使用以下划线分隔的大写命名	MEDIA_URL
6	变量	变量名尽量小写+下划线驼峰	num、this_is_var

三、缩进

• Python 采用代码缩进和冒号（ : ）来区分代码块之间的层次。
• 在 Python中，对于类定义、函数定义、流程控制语句、异常处理语句等，行尾的冒号和下一行的缩进，表示下一个代码块的开始，而缩进的结束则表示此代码块的结束。
• Python 中实现对代码的缩进，可以使用空格或者 Tab 键实现。但无论是手动敲空格，还是使用 Tab 键，通常情况下都是采用 4个空格长度作为一个缩进量（默认情况下，一个 Tab 键就表示 4 个空格）。
• 对于 Python缩进规则，初学者可以这样理解，Python 要求属于同一作用域中的各行代码，它们的缩进量必须一致，但具体缩进量为多少，并不做硬性规定。

if True:
    print(True)
else:
    print(False)

四、空行

• 顶层函数和类定义，前后用两个空行隔开
• 编码格式声明、模块导入、常量和全局变量声明、顶级定义和执行代码之间空两行
• 类里面方法定义用一个空行隔开
• 在函数或方法内部，可以在必要的地方空一行以增强节奏感，但应避免连续空行

五、注释

Python 中单行注释使用 #，多行注释（块注释、文档注释）使用三个单引号（‘’'）或三个双引号（“”"）

示例

# 我是单行注释

'''
我是多行注释
我是多行注释
'''

"""
我是多行注释
我是多行注释
"""

六、模块导入

• 导入应该放在文件顶部，位于模块注释和文档字符串之后，模块全局变量和常量之前。
• 导入应该按照从最通用到最不通用的顺序分组：标准库导入、第三方库导入、应用程序指定导入，分组之间空一行。
• 模块名称要短，使用小写，并避免使用特殊符号， 比如点和问号。
• 尽量保持模块名简单，以无需分开单词最佳（不推荐在两个单词之间使用下划线）。
• 每个导入应该独占一行。

模块导入建议

示例	评价
from modu import *	差， 不清楚具体从模块中导入了哪些内容
from modu import sqrt	稍好
import modu import modu.sqrt	最佳 ， 调用的时候直接使用modu.sqrt能比较清楚的知道当前方法属于哪个模块
import os	推荐
import os, sys	不推荐
from subprocess import Popen, PIPE	推荐

七、数据类型

整数：可以为任意大小、包含负数

浮点数：就是小数

字符串：以单引号 '、双引号"、三引号 ''' 或 """括起来的文本

布尔：只有 True、False 两种值

空值：用 None 表示

变量：是可变的

常量：不可变