Python中下划线在变量名和方法名中的含义

梦里梦外; 2023-01-23 07:54 208阅读 0赞

### Python中下划线在变量名和方法名中的含义 ###

单下划线和双下划线在Python变量名和方法名中的含义，有些仅仅是作为约定，用于提示开发人员；而另一些则对Python解释器有特殊含义。

python中的下划线主要分为如下几类：

☆前置单下划线，如

\_var，主要是用于将变量或方法定义为私有属性。它对于程序员而言是一种提示，这里的私有属性并非如java中的私有，而是一种约定俗成，想强行访问仍旧可以正常访问。

☆后置单下划线，如

var\_,主要用于将变量区别，如变量名称和关键字冲突，后面加个下划线区别开来。

☆前置双下划线，如

\_\_var,类中带前置双下划线的变量或方法，都会触发python解释器的名称修饰，是不能直接通过该名称去访问到的，实现了一定程度上的隔离。

☆前后都有双下划线，如

\_\_var\_\_, 常见的有\_\_init\_\_()对象构造函数，这类方法是python中的魔法方法（特殊方法），用于特殊用途。

☆单下划线本身，如

\_ 在Python REPLs如IDLE Shell中是一个特殊变量（可以表示一个临时值），它表示解释器计算的最后一个表达式的结果。

下面举例解读之。

**前置单下划线**

class Test:
        def __init__(self):
            self.foo = 11
            self._bar = 23
    #实例化这个类并尝试访问在__init__构造函数中定义的foo和_bar属性，会发生什么情况？
    t = Test()
    print(t.foo) #输出：11
    print(t._bar) #输出：23

可以看到，\_bar前面的单下划线并没有阻止我们“进入”这个类访问变量的值。

这是因为Python中的前置单下划线只是一个公认的约定，至少在涉及变量名和方法名时是这样的。但是前置下划线会影响从模块中导入名称的方式。

**后置单下划线**

有时，某个变量最合适的名称已被Python语言中的关键字占用。因此，诸如class或def的名称不能用作Python中的变量名。在这种情况下，可以追加一个下划线来绕过命名冲突：

def make\_object(name, class\_):

pass

用一个后置单下划线来避免与Python关键字的命名冲突是一个约定。PEP 8定义并解释了这个约定。

**前置双下划线**

以双下划线开头的Python类属性（变量和方法）不是约定的意义，双下划线前缀会让Python解释器重写属性名称，以避免子类中的命名冲突，这也称为名称改写（name mangling）

class Test:
        def __init__(self):
            self.foo = 11
            self._bar = 23
            self.__baz = 42
    #实例化这个类并用内置的dir()函数来看看这个对象的属性：
    t = Test()
    print(dir(t))
    print(t._Test__baz) # 在外部访问__baz变量名时，应使用 _类名__变量名即_Test__baz

运行之，输出：

\['\_Test\_\_baz', '\_\_class\_\_', '\_\_delattr\_\_', '\_\_dict\_\_', '\_\_dir\_\_', '\_\_doc\_\_', '\_\_eq\_\_', '\_\_format\_\_', '\_\_ge\_\_', '\_\_getattribute\_\_', '\_\_gt\_\_', '\_\_hash\_\_', '\_\_init\_\_', '\_\_init\_subclass\_\_', '\_\_le\_\_', '\_\_lt\_\_', '\_\_module\_\_', '\_\_ne\_\_', '\_\_new\_\_', '\_\_reduce\_\_', '\_\_reduce\_ex\_\_', '\_\_repr\_\_', '\_\_setattr\_\_', '\_\_sizeof\_\_', '\_\_str\_\_', '\_\_subclasshook\_\_', '\_\_weakref\_\_', '\_bar', 'foo'\]

现在，看一看这个带有对象属性的列表，并留意原始变量名foo、\_bar和\_ bazi有何差异：

self.foo变量没有改动，在属性列表中显示为foo。

self.\_bar也一样，在类中显示为\_bar。前面说了，在这种情况下前置下划线仅仅是一个约定，是对程序员的一个提示。

对于self.\_\_baz，在该列表中找不到\_\_baz这个变量。仔细观察就会看到，这个对象上有一个名为\_Test\_\_baz的属性。这是Python解释器应用名称改写之后的名称，是为了防止子类覆盖这些变量。

对于前置双下划线的变量，在外部访问该变量名时，应使用 \_类名\_\_变量名；直接访问\_\_变量名是不存在的。

用双下划线修饰方法亦如此——名称改写也适用于方法名。

用双下划线修饰属性或者方法，会出发名称修饰，即在外部访问时，该方法名或变量名会变为\_类名\_\_变量名；直接访问\_\_变量名是不存在的。例子：

class A(object):
        def __init__(self):
            self.__private=10
        def __private_method(self):
            return 'ABC'
    t=A()
    #下句输出：10，若用print(t.__private)报错：AttributeError: 'A' object has no attribute '__private'
    print(t._A__private)
    #下句输出：ABC，若用print(t.__private_method())报错：AttributeError: 'A' object has no attribute '__private_method'
    print(t._A__private_method())

**前后都有双下划线**

由双下划线包围的变量，则不会发生名称改写，由双下划线包围的方法通常被称为魔法方法（特殊方法）。

前后由双下划线包围的变量不受Python解释器的影响：

class B(object):
        def __init__(self):
            self.__private__=10
    t=B()
    print(t.__private__) #输出：10

就命名约定而言，最好避免在自己的程序中使用以双下划线开头和结尾的名称，因为Python语言用于定义的特殊方法。

**单下划线本身**

\_ 在Python REPLs如IDLE Shell中是一个特殊变量（可以表示一个临时值），它表示解释器计算的最后一个表达式的结果。

例子：

![20210713181922550.png][]

参考；[https://mp.weixin.qq.com/s/Z9BqZrsZVZgSeja9VYdK0w][https_mp.weixin.qq.com_s_Z9BqZrsZVZgSeja9VYdK0w]

[20210713181922550.png]: /images/20221004/d8fd1ba5ca764d0ba8ebbc168fa2657e.png
[https_mp.weixin.qq.com_s_Z9BqZrsZVZgSeja9VYdK0w]: https://mp.weixin.qq.com/s/Z9BqZrsZVZgSeja9VYdK0w