在Python中,类、方法、变量和属性的命名规则都有一些共同的约定,同时也有一些针对不同类型的特定建议。以下是一些基本的指导原则:
通用规则
- 明确性:名称应具有描述性,能够清晰地表达其代表的含义或用途。
- 简洁性:尽量使名称简短,同时不牺牲明确性。
- 避免冲突:不要使用可能与Python关键字或内置名称冲突的词汇。
类名
- 大驼峰命名法(PascalCase):每个单词的首字母大写,不使用下划线。例如:
MyClass
。
- 描述性:类名应该准确描述其所代表的事物。例如:
Customer
、EmailParser
。
变量和属性名
- 小写:通常都是小写字母。
- 下划线分隔:如果包含多个单词,使用下划线连接。例如:
my_variable
。
- 私有变量:通常会以单个下划线开头,表示这是一个保护成员,不应在类的外部直接访问。例如:
_private_var
。
- 特殊变量:如果是类中的特殊变量,可以以双下划线开头和结尾。例如:
__init__
。
方法名
- 小写:同变量名,方法名应该全为小写。
- 下划线分隔:多个单词以下划线分隔。例如:
my_method
。
- 私有方法:通常以一个下划线开头,表示这是一个非公开的方法,不应在类的外部调用。例如:
_private_method
。
- 特殊方法:特殊的方法或称为魔术方法,使用双下划线开头和结尾,例如:
__str__
、__repr__
。
常量