单个下划线(_)
通常有三种用法:
- 在python解释器: 单个下划线代表上次在交互解释期对话中(控制台)执行的结果.这种情况在标准的CPython解释器中首次被实现,接下来这种习惯也被保持下来:
>>> _ Traceback (most recent call last): File "<stdin>", line 1, in <module> NameError: name ‘_‘ is not defined >>> 42 >>> _ 42 >>> ‘alright!‘ if _ else ‘:(‘ ‘alright!‘ >>> _ ‘alright!‘
2.作为一个名称:这可能跟上一点有点相关。单个下划线被当作‘被抛弃‘的名称来使用。这样可能另下一个阅读你代码的人知道,根据惯例,下划线代表这只声明但不会被使用的变量。正如,你不会对计数循环的变量有兴趣:
n = 42 for _ in range(n): do_something()
3.I18n: 有时候也会遇到单个下划线声明为一个函数的情况。在这种情况下,这个函数通常是用作国际化以及本地化的字符转化以及查找。这习惯似乎是来源并仍会继续跟随对应的C语言的习惯。举个例子,正如在 Django documentation for translation里面,你可以看到:
from django.utils.translation import ugettext as _ from django.http import HttpResponse def my_view(request): output = _("Welcome to my site.") return HttpResponse(output)
在第二和第三两种用法有冲突,所以,应该避免同时用下划线作为‘被抛弃‘的变量以及i18n查找和转化。
在名称前加单个下划线(例如 _name)
在名称前加单个下划线,这样可以用来告诉程序员,这个变量是私有变量。这是一种惯例,来让下一个人(或者你自己)使用代码的时候,知道这个下划线变量只是用于内部调用的。正如Python 文档记录着:
a name prefixed with an underscore (e.g. _spam) should be treated as a non-public part of the API (whether it is a function, a method or a data member). It should be considered an implementation detail and subject to change without notice.
我说明这种惯例是因为,在解释器中,它代表着某些特定用法。如果你 from <module/package> import *,除非 module‘s/package‘s __all__文件明确的列出那些带单个下划线前缀的变量,否则所以这些变量都不会被导入。更多请参阅 "importing `*` from Python"
在名称前加两个下划线(例如 __name)
在名称面前添加两个下划线(特别是一个函数的名字)并不是一种惯例。对于解释器来说这是一种特殊的意义。Python会mangles(特性名词,不翻译,或者可以说让....失踪的意思)这些变量,从而避免子类定义的变量跟基类的冲突。正如 python文档有讲明,但凡这种形式的变量 __spam(至少两个前缀下划线,最多一个后缀下划线)都会被替换成 _classname__spam, 而在当前类 classname里面前缀的下划线都是被截取掉的。
可以看下面的例子:
>>> class A(object): ... def _internal_use(self): ... pass ... def __method_name(self): ... pass ... >>> dir(A()) [‘_A__method_name‘, ..., ‘_internal_use‘]
正如所说的,_internal_use 没有改变而 __method_name 被mangled到 _Classname__method_name.现在,如果你想声明一个A的子类, B,然后你要想重写A的__method_name也不是那么容易的:
>>>> class B(A): ... def __method_name(self): ... pass ... >>> dir(B()) [‘_A__method_name‘, ‘_B__method_name‘, ..., ‘_internal_use‘]
这种内定的特性,等同于Java 的final方法以及C++的普通方法(非虚函数)
名称前后都带有两个下划线(例如 __init__)
在Python里这代表这特殊方法。就我个人而言,这仅仅是一个惯例,可以让Python系统使用变量时,不会跟用户定义的变量冲突的一种方法。当Python 调用它们的时候,你可以典型的覆盖这些方法然后定义设定的行为。举个例子,你们在声明一个类的时候,都经常覆盖__init__方法。
没有人阻止你写你自己看起来像特殊方法的变量(但是,最好不要啦):
>>>> class C(object): ... def __mine__(self): ... pass ... >>> dir(C) ... [..., ‘__mine__‘, ...]
要远离这种类型的变量声明很容易,只要让Python自定义的特殊变量声明自己去遵循这种惯例就好。