Python命名规范
★ 类属性命名规范
-
类属性通常采用大写字母、下划线分隔的方式命名,遵循以下规范:
1. 如果类属性是常量,通常使用全大写的字母表示,多个单词之间用下划线分隔,例如:MAX_SIZE。 2. 如果类属性表示一个布尔值或状态,通常使用is或has开头,例如:is_running、has_finished。 3. 如果类属性表示一个私有属性,通常在属性名前加上一个下划线,例如:_count。 4. 如果类属性表示一个类方法或静态方法,通常使用驼峰式命名法,例如:getMaxSize()。 5. 如果类属性表示一个类变量或实例变量,通常使用小写字母、下划线分隔的方式命名,例如:instance_count。
★ 私有化命名规范
命名格式 | 说明 |
---|---|
xx | 公有变量; 没有任何前缀的变量被视为"公有"的变量. 在 Python 中,并没有像其他编程语言那样显式定义"公有变量"。Python 中的变量默认是可见的 |
_x | 单前置下划线,使用"from somemodule import *" 的方式从一个包导入所有资源, _x不会被导入 但通过 "from somemodule import _x"的方式是可以导入的; 对象属性名以单下划线开头,表示该属性是“受保护的”,通常,这种命名方式用于防止属性被外部直接访问;这不是语法上的要求,而是一种编程的约定,所以实质上依然可以通过 对象._x 的方式访问该属性;一般 在使用IDE软件编写代码是不会提示该属性 |
__xx | 双前置下划线,避免与子类中的属性命名冲突,无法在外部直接访问(本质是名字重整为"_类名__xx"所以访问不到); 一般用于定义类的私有属性 |
__xx__ |
双前后下划线,用户名字空间的魔法对象或属性 |
xx_ | 单后置下划线,用于避免与Python关键词的冲突 |