乐趣区

关于python:Python-命名规范

jiezi

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
退出移动版