Python 中的下划线命名规则

目录

1 变量

1.1 _xxx

1.2 __xxx

1.3 __xxx__

1.4 xxx_

1.5

2 函数和方法

2.1 受保护方法:小写和一个前导下划线

2.2 特殊方法:小写和两个前导下划线,两个后置下划线

3. 类

4. 模块和包

5.参考文献


如何定义python中变量名,函数名,类名以及包名


1 变量

1.1 _xxx

单下划线开头的变量,表明这是一个受保护(protected)的变量,原则上不允许直接访问,但是外部类还是可以访问到这个变量。因为这只是一个程序员之间的约定,用于警告说明这是一个受保护的变量,外部类不要去访问它。 以单下划线'_'为前缀的名称,如_xxx,应该被视为API中非公开的部分(不管是函数,方法还是数据成员)。此时,应该将它们看做一种实现细节,在修改他们时无需对外部通知。 如果你写了代码‘from <模块/包名> import *’,那么以'_'开头的名称都不会被导入,除非模块或包中的'__all__'列表显示地包含了它们。不过值得注意的是,如果使用import a_module这样导入模块,仍然可以用a_module._some_var这样的形式访问到这样的对象。

1.2 __xxx

双下划线开头的,表示的是私有类型(private)的变量,只能允许这个类本身进行访问,甚至它的子类也不可以,用于命名一个类属性(类变量),调用时名字会被改变(在类Student内部,__name会变成_student__name,如self._Student__name)。双下划线开头的实例变量是不是一定不能从外部访问呢?其实也不是,仍然可以通过_Student__name来访问__name变量。

>>> class A(object): 
...     def _internal_use(self): 
...         pass
...     def __method_name(self): 
...         pass
... 
>>> dir(A()) 
['_A__method_name', ..., '_internal_use']

1.3 __xxx__

以双下划线开头,并且以双下划线结尾的,是内置变量,内置变量是可以直接访问的,如__init__,__import__或是__file__。所以,不要自己定义这类变量。

1.4 xxx_

单下划线结尾的变量一般只是为了避免与Python关键字的命名冲突。

1.5

USER_CONSTANT,大写加下划线,对于不会发生改变的全局变量,使用大写加下划线。


2 函数和方法

总体而言应该使用,小写和下划线。但有些比较老的库使用的是混合大小写,即首单词小写,之后每个单词第一个字母大写,其余小写。但现在,小写和下划线已经成为规范。

2.1 受保护方法:小写和一个前导下划线

这里和受保护变量一样,并不是真正的受保护权限。同时也应该注意一般函数不要使用两个前导下划线(当遇到两个前导下划线时,Python的名称改编特性将发挥作用)。特殊函数后面会提及。

def _secrete(self):
    print "don't test me."

2.2 特殊方法:小写和两个前导下划线,两个后置下划线

这种风格只应用于特殊函数,比如操作符重载等。对Python系统来说,这将确保不会与用户自定义的名称冲突。通常,你将会覆写这些方法,并在里面实现你所需要的功能,以便Python调用它们。例如,当定义一个类时,你经常会覆写'init'方法。

def __add__(self, other):
    return int.__add__(other)

这种风格只应用于特殊函数,比如操作符重载等。


3. 类

类总是使用驼峰式命名,即所有单词首字母大写其余字母小写。类名应该简写,精确,并足以从中理解类所完成的工作。 常见的一个方法是使用表示其类型或者特性的后缀,例如: SQLEngine

MimeTypes

对于基类而言,可以使用一个 Base 或者 Abstract 前缀

BaseCookie

AbstractGroup

class UserProfile(object):
    def __init__(self, profile):
        return self._profile = profile

    def profile(self):
        return self._profile

4. 模块和包

除了特殊模块init之外,模块名称都是用不带下划线的小写字母。若是实现了一个协议,那么通常使用lib作为后缀。

import smtplib

5.参考文献

Python 中的下划线命名规则

关于python中的下划线

你可能感兴趣的:(Python)