Python命名规范

阅读 400 评论0

所有命名规范都要准守这三条

1.命名只能以字母或者_下划线开头

#错误类名
class 4_Person():
  pass
#错误函数名
def 漂亮():
  pass

2.名字不能包含空格

3.名字不能与关键字重合

#错误函数名，与关键字and重合
def and():
    pass

关键字参考《如何写一个函数》

不能将字符l(小写字母l)，'O''o'(大小写字母o)、'I'(大写字母I)用作变量名称，防止和数字0、1混淆

模块 module_name

与包的规范相同，如mymodule

import decoder
import html_parser
#不推荐的这种命名
import Decoder

包 package_name

应该是简短的、小写的名字，如果下划线可以改善可读性可以加入，如mypackage

类 ClassName

总是使用首字母大写单词串，如MyClass(CamelCase驼峰命名)

class Person():
    pass
class Elc_Car(Car):
    pass
class _PrivateCar(Car):
    pass

内部类可以使用额外的前导下划线

函数 function_name

全部小写，如有多个单词，用_下划线隔开，私有函数可用前导下划线，如例3

def calculator():
    pass
def private_computer():
    pass
class Person():
    def _private_func():
        pass

方法 method_name

同函数，小写 + 下划线

变量 var_name

变量名一般小写，多个单词用_下划线隔开，同函数命名
私有类成员使用单一下划线前缀标识
变量名不应该带有类型信息，如num_list,ani_dict等

count = 0     
animal_count = 100

全局变量

全部大写，多个单词用_下划线隔开，如需要阻止导入模块内的全局变量，可以加一个前导下划线，GLOBAL_VAR_NAME，_GLOBAL_VAL
常量和全局变量命名规范相同

异常 ExceptionName

以Error作为后缀

try:         
    pass     
except ValueError as result:         
    pass

参数 function_parameter_name

如果一个函数的参数名称和保留的关键字冲突，通常使用一个后缀下划线

常用的命名缩写

function 缩写为fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num

前导后缀下划线说明

一个前导下划线：表示非公有
一个后缀下划线：避免关键字冲突
两个前导下划线：当命名一个类属性引起名称冲突时使用
两个前导和后缀下划线：有特殊用途的对象或者属性，例如__init__和__str__

评论列表