在Python中,对象名称前的单前导下划线和双前导下划线代表什么?


当前回答

到目前为止,答案很好,但缺少一些花絮。一个前导下划线不仅仅是一个约定:如果使用from foobar import*,并且foobar模块没有定义__all__列表,那么从模块导入的名称不包括前导下划线的名称。假设这主要是一个惯例,因为这个案例是一个相当模糊的角落;-)。

前导下划线约定不仅广泛用于私有名称,也广泛用于C++所称的受保护的名称,例如,完全打算由子类重写的方法的名称(即使是必须重写的方法,因为在基类中它们引发NotImplementedError!-)通常是单前导下划线名称,以向使用该类(或子类)实例的代码指示不打算直接调用所述方法。

例如,要使线程安全队列具有与FIFO不同的排队规则,可以导入queue,将queue.queue子类化,并重写_get和_put等方法;“客户端代码”从不调用这些(“钩子”)方法,而是调用(“组织”)公共方法,如put和get(这被称为模板方法设计模式——例如,请参见此处,以获取基于我关于该主题的演讲视频的有趣演示,并添加了摘要)。

编辑:会谈描述中的视频链接现已断开。你可以在这里和这里找到前两个视频。

其他回答

根据Python中下划线的含义

单前导下划线(_var):表示名称仅供内部使用的命名约定。通常不由Python解释器强制执行(通配符导入除外),仅作为程序员的提示。单尾下划线(var_):按惯例使用,以避免与Python关键字的命名冲突。双前导下划线(__var):在类上下文中使用时触发名称更改。由Python解释器强制执行。双前导和尾随下划线(__var__):表示Python语言定义的特殊方法。避免为自己的属性使用此命名方案。单下划线(_):有时用作临时或不重要变量的名称(“不在乎”)。另外:Python REPL中最后一个表达式的结果。

到目前为止,答案很好,但缺少一些花絮。一个前导下划线不仅仅是一个约定:如果使用from foobar import*,并且foobar模块没有定义__all__列表,那么从模块导入的名称不包括前导下划线的名称。假设这主要是一个惯例,因为这个案例是一个相当模糊的角落;-)。

前导下划线约定不仅广泛用于私有名称,也广泛用于C++所称的受保护的名称,例如,完全打算由子类重写的方法的名称(即使是必须重写的方法,因为在基类中它们引发NotImplementedError!-)通常是单前导下划线名称,以向使用该类(或子类)实例的代码指示不打算直接调用所述方法。

例如,要使线程安全队列具有与FIFO不同的排队规则,可以导入queue,将queue.queue子类化,并重写_get和_put等方法;“客户端代码”从不调用这些(“钩子”)方法,而是调用(“组织”)公共方法,如put和get(这被称为模板方法设计模式——例如,请参见此处,以获取基于我关于该主题的演讲视频的有趣演示,并添加了摘要)。

编辑:会谈描述中的视频链接现已断开。你可以在这里和这里找到前两个视频。

_foo:只是惯例。程序员指示变量是私有的(无论在Python中意味着什么)。__foo:这有真正的意义。解释器将此名称替换为_classname__foo,以确保该名称不会与其他类中的类似名称重叠。__foo__:只是惯例。Python系统使用不会与用户名冲突的名称的方法。

在Python世界中,没有其他形式的下划线有意义。此外,在这些约定中,类、变量、全局等之间没有区别。

对于方法,可以使用双下划线隐藏私有“方法”,模式如下:

# Private methods of MyClass
def _MyClass__do_something(obj:'MyClass'):
    print('_MyClass__do_something() called. type(obj) = {}'.format(type(obj)))

class MyClass():
    def __init__(self):
        __do_something(self)

mc = MyClass()

输出:

_MyClass__do_something() called. type(obj) = <class '__main__.MyClass'>

我今天在尝试对类方法使用双下划线时遇到了这个问题,并得到了NameError:name“_<class><method>”未定义错误。

Python中不存在只能从对象内部访问的“私有”实例变量。然而,大多数Python代码都遵循一个惯例:前缀为下划线的名称(例如_spam)应被视为API的非公共部分(无论是函数、方法还是数据成员)。应将其视为实施细节,如有更改,恕不另行通知。

参考https://docs.python.org/2/tutorial/classes.html#private-变量和类本地引用