python（58）：python下划线

2023-08-23 23:04:58

详解Python中的下划线

本文将讨论Python中下划线（_）字符的使用方法。我们将会看到，正如Python中的很多事情，下划线的不同用法大多数（并非所有）只是常用惯例而已。

单下划线（_）

通常情况下，会在以下3种场景中使用：

1、在解释器中：在这种情况下，“_”代表交互式解释器会话中上一条执行的语句的结果。这种用法首先被标准CPython解释器采用，然后其他类型的解释器也先后采用。

Python

>>> _ Traceback (most recent call last):

File "<stdin>", line 1, in <module>

NameError: name '_' is not defined

>>> 42

>>> _

>>> 'alright!' if _ else ':('

'alright!'

>>> _

'alright!'

2、作为一个名称：这与上面一点稍微有些联系，此时“_”作为临时性的名称使用。这样，当其他人阅读你的代码时将会知道，你分配了一个特定的名称，但是并不会在后面再次用到该名称。例如，下面的例子中，你可能对循环计数中的实际值并不感兴趣，此时就可以使用“_”。

Python

n = 42

for _ in range(n):

do_something()

3、国际化：也许你也曾看到”_“会被作为一个函数来使用。这种情况下，它通常用于实现国际化和本地化字符串之间翻译查找的函数名称，这似乎源自并遵循相应的C约定。例如，在Django文档“转换”章节中，你将能看到如下代码：

Python

from django.utils.translation import ugettext as _

from django.http import HttpResponse

def my_view(request):

output = _("Welcome to my site.")

return HttpResponse(output)

可以发现，场景二和场景三中的使用方法可能会相互冲突，所以我们需要避免在使用“_”作为国际化查找转换功能的代码块中同时使用“_”作为临时名称。

名称前的单下划线（如：_shahriar）

Python中不存在真正的私有方法。为了实现类似于c++中私有方法，可以在类的方法或属性前加一个“_”单下划线，意味着该方法或属性不应该去调用，它并不属于API。

程序员使用名称前的单下划线，用于指定该名称属性为“私有”。这有点类似于惯例，为了使其他人（或你自己）使用这些代码时将会知道以“_”开头的名称只供内部使用。正如Python文档中所述：

以下划线“_”为前缀的名称（如_spam）应该被视为API中非公开的部分（不管是函数、方法还是数据成员）。此时，应该将它们看作是一种实现细节，在修改它们时无需对外部通知。

正如上面所说，这确实类似一种惯例，因为它对解释器来说确实有一定的意义，如果你写了代码“from <模块/包名> import *”，那么以“_”开头的名称都不会被导入，除非模块或包中的“__all__”列表显式地包含了它们。了解更多请查看“Importing * in Python”。

在使用property时，经常出现这个问题：

class BaseForm(StrAndUnicode):

    ...

    def _get_errors(self):

        "Returns an ErrorDict for the data provided for the form"

        if self._errors is None:

            self.full_clean()

        return self._errors

    errors = property(_get_errors)

上面的代码片段来自于django源码（django/forms/forms.py）。这里的errors是一个属性，属于API的一部分，但是_get_errors是私有的，是不应该访问的，但可以通过errors来访问该错误结果。

名称前的双下划线（如：__shahriar）

名称（具体为一个方法名）前双下划线（__）的用法并不是一种惯例，对解释器来说它有特定的意义。Python中的这种用法是为了避免与子类定义的名称冲突。Python文档指出，“__spam”这种形式（至少两个前导下划线，最多一个后续下划线）的任何标识符将会被“_classname__spam”这种形式原文取代，在这里“classname”是去掉前导下划线的当前类名。例如下面的例子：

Python

>>> class A(object):

... def _internal_use(self):

... pass

... def __method_name(self):

... pass

...

>>> dir(A())

['_A__method_name', ..., '_internal_use']

正如所预料的，“_internal_use”并未改变，而“__method_name”却被变成了“_ClassName__method_name”。此时，如果你创建A的一个子类B，那么你将不能轻易地覆写A中的方法“__method_name”。

Python

>>> class B(A):

... def __method_name(self):

... pass

...

>>> dir(B())

['_A__method_name', '_B__method_name', ..., '_internal_use']

这里的功能几乎和Java中的final方法和C++类中标准方法（非虚方法）一样。

样例：

这个双下划线更会造成更多混乱，但它并不是用来标识一个方法或属性是私有的，真正作用是用来避免子类覆盖其内容。

让我们来看一个例子：

class A(object):

    def __method(self):

        print "I'm a method in A"

    def method(self):

        self.__method() a = A() a.method()

输出是这样的：

$ python example.py

I'm a method in A

很好，出现了预计的结果。

我们给A添加一个子类，并重新实现一个__method：

class B(A):

    def __method(self):

        print "I'm a method in B" 

b = B()

b.method()

现在，结果是这样的：

$ python example.py

I'm a method in A

就像我们看到的一样，B.method()不能调用B.__method的方法。实际上，它是"__"两个下划线的功能的正常显示。

因此，在我们创建一个以"__"两个下划线开始的方法时，这意味着这个方法不能被重写，它只允许在该类的内部中使用。

在Python中如是做的？很简单，它只是把方法重命名了，如下：

a = A()

a._A__method()  # never use this!! please!

$ python example.py

I'm a method in A

如果你试图调用a.__method，它还是无法运行的，就如上面所说，只可以在类的内部调用__method。

名称前后的双下划线（如：init）

这种用法表示Python中特殊的方法名。其实，这只是一种惯例，对Python系统来说，这将确保不会与用户自定义的名称冲突。通常，你将会覆写这些方法，并在里面实现你所需要的功能，以便Python调用它们。例如，当定义一个类时，你经常会覆写“__init__”方法。

虽然你也可以编写自己的特殊方法名，但不要这样做。

Python

>>> class C(object):

... def __mine__(self):

... pass

...

>>> dir(C)

... [..., '__mine__', ...]

其实，很容易摆脱这种类型的命名，而只让Python内部定义的特殊名称遵循这种约定。

`"xx"前后各双下划线`

当你看到"__this__"的时，就知道不要调用它。为什么？因为它的意思是它是用于Python调用的，如下：

>>> name = "igor"

>>> name.__len__() 4

>>> len(name) 4

>>> number = 10

>>> number.__add__(20) 30

>>> number + 20 30

“__xx__”经常是操作符或本地函数调用的magic methods。在上面的例子中，提供了一种重写类的操作符的功能。

在特殊的情况下，它只是python调用的hook。例如，__init__()函数是当对象被创建初始化时调用的;__new__()是用来创建实例。

class CrazyNumber(object):

    def __init__(self, n):

        self.n = n

    def __add__(self, other):

        return self.n - other

    def __sub__(self, other):

        return self.n + other

    def __str__(self):

        return str(self.n) 

num = CrazyNumber(10)

print num # 10

print num + 5 # 5

print num - 20 # 30

另一个例子

class Room(object):

    def __init__(self):

        self.people = []

    def add(self, person):

        self.people.append(person)

    def __len__(self):

        return len(self.people)

room = Room()

room.add("Igor")

print len(room) # 1

结论

使用_one_underline来表示该方法或属性是私有的，不属于API；
当创建一个用于python调用或一些特殊情况时，使用__two_underline__；
使用__just_to_underlines，来避免子类的重写！

码农公寓

详解Python中的下划线

单下划线（_）

名称前的单下划线（如：_shahriar）

名称前的双下划线（如：__shahriar）

名称前后的双下划线（如：__init__）

"__xx__"前后各双下划线

结论

相关文章

名称前后的双下划线（如：init）

`"xx"前后各双下划线`