参考博客:
python代码规范和命名规范
https://blog.csdn.net/warm77/article/details/78353632
python编程规范
首先注意避免的名字
永远不要使用字母‘l’(小写的L),‘O’(大写的O),或者‘I’(大写的I)作为单字符变量名。
在有些字体里,这些字符无法和数字0和1区分,如果想用‘l’,用‘L’代替。
1.项目名
例如01_python基础,My_project
2.模块名
模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况)(加入下划线可改善可读性)
# 正确的模块名
import decoder
import html_parser
# 不推荐的模块名
import Decoder
3.包名
和模块名的规范相同
4.类名
类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头
class Farm(): pass class AnimalFarm(Farm): pass class _PrivateFarm(Farm): pass
将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.
在接口被文档化并且主要被用于调用的情况下,可以使用函数的命名风格代替。
注意,对于内置的变量命名有一个单独的约定:大部分内置变量是单个单词(或者两个单词连接在一起),首字母大写的命名法只用于异常名或者内部的常量。
5.函数名&方法
函数名一律小写,如有多个单词,用下划线隔开
def run():
pass
def run_with_env():
pass
私有函数在函数前加一个下划线_
class Person(): def _private_func(): pass
类内部函数命名,用单下划线(_)开头(该函数可被继承访问)
类内私有函数命名,用双下划线(__)开头(该函数不可被继承访问)
*注意*:混合大小写仅被允许用于这种风格已经占据优势的时候,以便保持向后兼容。
6.变量名
变量名尽量小写, 如有多个单词,用下划线隔开
if __name__ == '__main__': count = 0 school_name = ''
常量采用全大写,如有多个单词,使用下划线隔开
MAX_CLIENT = 100 MAX_CONNECTION = 1000 CONNECTION_TIMEOUT = 600
*注意*:
1.不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
3.变量名不应带有类型信息,因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
7.常量
常量使用以下划线分隔的全大写命名
MAX_OVERFLOW = 100 Class FooBar: def foo_bar(self, print_): print(print_)
8.异常
以“Error”作为后缀。
因为异常一般都是类,所有类的命名方法在这里也适用。然而,你需要在异常名后面加上“Error”后缀(如果异常确实是一个错误)。
附:Google Python命名规范
module_name
package_name
ClassName
method_name
ExceptionName
function_name
GLOBAL_VAR_NAME
instance_var_name
function_parameter_name
local_var_name