Python 命名规范

1. 通用规范：

1. 命名只能以字母或者_下划线开头
2. 名字不能包含空格

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

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

2. 文件名

全小写,可使用下划线

3. 包 package_name

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

4. 模块 module_name

与包的规范相同，如 mymodule

import decoder
import html_parser

#不推荐的这种命名
import Decoder

5. 类 ClassName

总是使用首字母大写单词串，如 MyClass ( CamelCase 驼峰命名)，内部类可以使用额外的前导下划线

class Person():
    pass

class Elc_Car(Car):
    pass

class _PrivateCar(Car):
    pass

6. 函数/方法 function_name

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

def calculator():
    pass

def private_computer():
    pass

class Person():
    def _private_func():
        pass

注意：混合大小写仅被允许用于这种风格已经占据优势的时候，以便保持向后兼容

7. 变量 var_name

• 变量名一般小写，多个单词用_下划线隔开，如 color = WHITE，this_is_a_variable = 1
• 不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。
• 私有类成员使用单一下划线前缀标识，多定义公开成员，少定义私有成员。
• 变量名不应带有类型信息，因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。

count = 0     
animal_count = 100

8. 全局变量

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

9. 常量

• 常量名所有字母大写，由下划线连接各个单词如 MAX_OVERFLOW，TOTAL。

10. 异常 ExceptionName

• 以Error作为后缀

  try:         
      pass     
  except ValueError as result:         
      pass

11. 参数 function_parameter_name

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

12. 常用的命名缩写

命名应当尽量使用全拼写的单词，缩写的情况有如下两种：

1. 常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。
2. 命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。

例如：

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

13. 前导后缀下划线说明

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

14. 特定命名方式

主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名，它的意义在于这种形式的变量是只读的，这种形式的类成员函数尽量不要重载。如

class Base(object):

    def __init__(self, id, parent = None):
        self.__id__ = id
        self.__parent__ = parent

    def __message__(self, msgid):
        \# …略
# 其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。

15. 附: Google Python命名规范

module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name

参考资料

1. Python命名规范
2. python命名规范-2