本文将讨论Python中下划线(_)字符的使用方法。我们将会看到,正如Python中的很多事情,下划线的不同用法大多数(并非所有)只是常用惯例而已。
单下划线(_)
通常情况下,会在以下3种场景中使用:
1、在解释器中:在这种情况下,“_”代表交互式解释器会话中上一条执行的语句的结果。这种用法首先被标准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、国际化:也许你也曾看到”_“会被作为一个函数来使用。这种情况下,它通常用于实现国际化和本地化字符串之间翻译查找的函数名称,这似乎源自并遵循相应的C约定。例如,在Django文档“转换”章节中,你将能看到如下代码:
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文档中所述:
以下划线“_”为前缀的名称(如_spam)应该被视为API中非公开的部分(不管是函数、方法还是数据成员)。此时,应该将它们看作是一种实现细节,在修改它们时无需对外部通知。
正如上面所说,这确实类似一种惯例,因为它对解释器来说确实有一定的意义,如果你写了代码“from <模块/包名> import *”,那么以“_”开头的名称都不会被导入,除非模块或包中的“__all__”列表显式地包含了它们。了解更多请查看“Importing * in Python”。
名称前的双下划线(如:__shahriar)
名称(具体为一个方法名)前双下划线(__)的用法并不是一种惯例,对解释器来说它有特定的意义。Python中的这种用法是为了避免与子类定义的名称冲突。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”却被变成了“_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内部定义的特殊名称遵循这种约定。
问一:下划线变量
单下划线开头的变量,Pyhthon规定为内部变量(私有变量),from M import * 时,这种变量并不会导入进来,例如:
foo.py
#foo.py
bar = 10
bar2 = 11
_bar = 20
__bar = 30
foo2.py
#foo2.py
from foo import *
if __name__ == '__main__':
print locals()
执行 python foo2.py,输出:
{'bar2': 11, 'bar': 10, '...省略'}
输入结果中并没有 _bar和__bar,因为它们都是以下划线开头的变量,所以没有导入进来,但是如果你非要把这些变量导入进来也是可以的,使用import时,明确导入具体的变量时就行了。如:
#foo2.py
from foo import *
from foo import _bar
from foo import __bar
if __name__ == '__main__':
print locals()
输出:
{'_bar': 20, 'bar2': 11, 'bar': 10, '__bar': 30, ‘...省略'}
单下划线结尾的变量:用于避免于Python关键字冲突的变量,如class_:
Tkinter.Toplevel(master, class_='ClassName')
如上所说的变量讲的是定义在模块中的变量,属于模块中的属性,如果这些变量定义在函数里面,那它和普通的变量没什么两样的,都是局部变量。此外,单下划线同样适用于函数。
双下划线开头的变量:它在模块中还是当作单下划线看待,但出现在类中作为类属性就不一样了,在运行时该类属性会被“混淆",不能直接访问,需要在该变量前加上下划线和类名才能访问。如:
class Foo(object):
boo = 40
_boo = 50
__boo = 60 # _Foo__boo
def __init__(self):
self.__booo = 70
def __test(self): #_Foo__test
print "__test"
if __name__ == '__main__':
print Foo.boo
print Foo._boo
print Foo._Foo__boo
foo = Foo()
print foo._Foo__booo
foo._Foo__test()
这样可以防止与父类或子类中同名的__xxx属性发生冲突。
开始和结尾都有的双下划线的变量:此类变量属于魔法对象,如:init,file,你永远不要自己也发明个出来。
问二:ALL
__all__对象是装有字符串的列表对象,他会覆盖 from import * 的默认行为:如
#foo.py
__all__ = ['bar', 'baz']
waz = 5
bar = 10
def baz(): return 'baz'
from foo import *
print bar
print baz
# 异常
print waz
在foo.py里面定义了__all__后,import * 就会按照 __all__定义的内容导入,所以这里 print waz就抛异常了,因为它不在 __all__里面。为外,你可以把下划线开头的变量的字符串形式加入到__all__中,这样 import * 也能看到这些变量。
参考:
http://foofish.net/python.html