PEP8---Python命名规则
常见的命名方式
Python 常用的命名规则有8种,如下
- 单个小写字符 如 b
- 单个大写字符 如 B
- 小写字母
- 小写字母间采用_连接 如 lower_case_with_underscore
- 大写字母
- 大写字母间采用_连接 如 UPPER_CASE_WITH_UNDERSCORES
- 驼峰状 如: CamelCase 注意:当单词中有缩写时,缩写采用全大写,因此 HTTPServerError 比 HttpServerErro更适合
- 混合大小写情况 如: mixedCase 与驼峰状的区别为 第一个字母小写
*首字母大写采用_连接 如: Capitalized_Words_With_Underscores
采用前段_和尾部_命名,如下:
- _single_leading_underscore : 表示内部变量,采用from M import * 无法引入前端_的变量
- single_trailing_underscore_ :用于避免和Python 内部默认关键字冲突
- __double_leading_underscore: 定义类属性, 编译时会触发 name mangling (class FooBar, __boo becomes _FooBar__boo)
- double_leading_and_trailing_underscore: Python 的魔法方法或属性,禁止自己创建魔术方法或属性
常见的命名规范
包和模块命名
模块和包均推荐采用 短且全小写字母命名。 模型可以采用包含_形式。
类名
类名推荐驼峰状命名。
异常命名
异常一般以类的形式定义,因此采用驼峰命名。
全局变量命名
若全局变量仅仅在模块内部使用,建议采用_命名或__all__ 避免全局变量被外部引用。
函数命名
函数命名采用全小写,为了增加可读性可以采用 _ 连接;考虑兼容性,可以采用混合大小写情况给函数命名。
函数和方法参数
类方法的第一个参数为cls, 实例方法的第一个参数为self .
若参数名和python 自带关键字冲突,采用参数名+ _ 作为参数。
方法和实例变量命名
- 采用函数命名法则,小写字母或小写字母间采用_ 链接增加可读性。
- 采用前面 _ 用于私有方法和变量命名
- 为了避免子类冲突 ,采用 __命名
常量
采用全大写,中间采用 _ 连接。