文章目录
编码格式声明
缩进
引号
空行
导入模块
命名规范
编码格式声明
通常,编码格式声明是必需的。如果 python 源码文件没有声明编码格式,python 解释器会默认使用 ASCII 编码,一旦源码文件包含非ASCII编码的字符,python 解释器就会报错。以 UTF-8 为例,以下两种编码格式声明都是合乎规则的
缩进
统一使用 4 个空格进行缩进。绝对不要用tab, 也不要tab和空格混用。对于行连接的情况,我一般使用4空格的悬挂式缩进。例如:
引号
自然语言使用双引号机器标识使用单引号正则表达式使用双引号空行
编码格式声明、模块导入、常量和全局变量声明、顶级定义和执行代码之间空两行顶级定义之间空两行,方法定义之间空一行在函数或方法内部,可以在必要的地方空一行以增强节奏感,但应避免连续空行导入模块
导入总应该放在文件顶部,位于模块注释和文档字符串之后,模块全局变量和常量之前。导入应该按照从最通用到最不通用的顺序分组,分组之间空一行
标准库导入第三方库导入应用程序指定导入命名规范
模块尽量使用小写命名,首字母保持小写,尽量不要用下划线类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头函数名一律小写,如有多个单词,用下划线隔开私有函数可用一个下划线开头变量名尽量小写, 如有多个单词,用下划线隔开常量采用全大写,如有多个单词,使用下划线隔开