Python中对象名称前单下划线和双下划线的含义

技术背景

在Python编程中，对象名称前的单下划线和双下划线有着特定的含义和用途。这些命名约定虽然在语法上不会强制限制访问，但它们在Python社区中被广泛使用，用于向其他开发者传达代码的设计意图，例如表示某个属性或方法是私有的、内部使用的，或者是特殊的内置方法等。理解这些命名约定对于编写规范、易于维护的Python代码至关重要。

实现步骤

单下划线（_var）

• 内部使用标识：在类中，以单下划线开头的属性或方法通常表示该属性或方法是为类内部使用而设计的。这只是一种约定，Python解释器并不会强制执行访问限制。

class MyClass:
    def __init__(self):
        self._internal_variable = 10

    def _internal_method(self):
        return self._internal_variable * 2

obj = MyClass()
print(obj._internal_variable)  # 可以正常访问，但不建议这么做
print(obj._internal_method())  # 可以正常调用，但不建议这么做

• 模块导入限制：在模块中，使用单下划线开头的函数或变量在使用from module import *语句导入时不会被导入。

# module.py
_var = 10
var = 20

# main.py
from module import *
print(var)  # 输出20
# print(_var)  # 会引发NameError，因为_var未被导入

双下划线（__var）

• 名称修饰（Name Mangling）：当在类中使用双下划线开头（最多一个尾随下划线）的标识符时，Python解释器会对其进行名称修饰。具体来说，会将其替换为_classname__var的形式，其中classname是当前类的名称。这主要用于避免在子类中意外覆盖父类的属性或方法。

class Parent:
    def __init__(self):
        self.__private_variable = 10

    def __private_method(self):
        return self.__private_variable * 2

class Child(Parent):
    def __init__(self):
        super().__init__()

parent = Parent()
# print(parent.__private_variable)  # 会引发AttributeError
print(parent._Parent__private_variable)  # 可以通过修饰后的名称访问

child = Child()
print(child._Parent__private_variable)  # 子类也可以通过修饰后的名称访问父类的私有属性

双下划线开头和结尾（__var__）

这种命名方式通常用于Python的特殊方法（也称为魔术方法），这些方法由Python解释器在特定情况下自动调用，例如__init__用于对象初始化，__str__用于返回对象的字符串表示等。

class MyClass:
    def __init__(self, value):
        self.value = value

    def __str__(self):
        return f"MyClass with value: {self.value}"

obj = MyClass(10)
print(obj)  # 会调用__str__方法，输出"MyClass with value: 10"

核心代码

单下划线示例

class BaseForm:
    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)

双下划线示例

class A:
    def __test(self):
        print("I'm a test method in class A")

    def test(self):
        self.__test()

a = A()
a.test()
# a.__test()  # 会引发AttributeError
a._A__test()  # 可以通过修饰后的名称调用

双下划线开头和结尾示例

class FalseCalculator:
    def __init__(self, number):
        self.number = number

    def __add__(self, number):
        return self.number - number

    def __sub__(self, number):
        return self.number + number

number = FalseCalculator(20)
print(number + 10)  # 输出10
print(number - 20)  # 输出40

最佳实践

• 单下划线：当你希望向其他开发者表明某个属性或方法是内部使用的，不应该被外部直接访问时，使用单下划线。同时，在模块中使用单下划线来避免不必要的全局命名冲突。
• 双下划线：当你需要确保某个属性或方法不会被子类意外覆盖时，使用双下划线。但要注意，这并不是真正的私有性，只是一种名称修饰机制。
• 双下划线开头和结尾：只在定义Python的特殊方法时使用这种命名方式，不要在自己的普通属性或方法中使用，以免与Python的内置机制冲突。

常见问题

单下划线是否真的是私有的？

不是。单下划线只是一种约定，Python解释器并不会阻止你访问以单下划线开头的属性或方法。但在实际编程中，应该尊重这种约定，避免直接访问这些内部使用的元素。

双下划线可以完全保证属性或方法不被访问吗？

不能。双下划线只是通过名称修饰来避免意外的覆盖和访问，但你仍然可以通过修饰后的名称来访问这些属性或方法。例如，obj._ClassName__private_variable。

如何正确使用这些命名约定？

要根据代码的设计意图来选择合适的命名约定。如果只是想表示内部使用，使用单下划线；如果需要防止子类覆盖，使用双下划线；如果是定义特殊方法，使用双下划线开头和结尾的命名。同时，要遵循Python社区的约定，提高代码的可读性和可维护性。