Python私有属性(private attributes)及其调用

亦凉 2022-03-30 05:43 393阅读 0赞

# Python中的私有属性 #

在面向对象(Object Oriented Design)的情景下，所谓私有属性(private attributes)，包括私有方法和私有变量，指的是只供一个类或者实例内部使用的方法和变量。这些方法和变量不应当被在类和实例的外部调用。然而，在Python的设计下并没有对类或者实例属性真正的访问限制(例如像Java中的关键字`private`)。

由于在面向对象设计中，这是一类非常有用的抽象模式，所以对于这一类情景，Python中提供了一种名义上的私有属性定义规范。一般来说，类定义中\_\_以两个下划线(例如`__func()`)开头的方法或变量\_\_被认为是私有属性。以这种格式定义的方法或变量一般来说应当是仅供类的内部调用。对于以这种格式定义的私有属性，python并没有强制性的访问限制，而是采用了所谓的\_\_名字改编(name mangling)\_\_。名字改编指的是Python会将类中定义的所有以至少两个下划线开头，至多一个下划线结尾的属性(包括方法和变量)的名称改编为`_类名__方法名`的格式。例如对于`__func()`，其会被改编为`_classname__func()`。\_注意在改编的时候，类名中包含的所有前缀下划线都将被忽略。\_只要在类中定义了复合上述格式的属性，不论该属性是方法还是变量，这一名字改编的过程总是会发生。另外，名字改编还可以使得子类在重载父类的方法时避免产生命名冲突。

在Python中，这一约定一般只是用来避免错误的方法调用，但完全无法阻止从外部调用这些被认为是“私有”的属性。下面的例子说明了这一现象。

class foo(object):
        def __init__(self):
            self.__var = 1
        def __bar(self):
            print('bar')
    
    f = foo()
    
    hasattr(f, '__bar')  # False
    hasattr(f, '_foo__bar')  #True
    hasattr(f, '__var')  # False
    hasattr(f, '_foo__var')  # True
    
    f.__bar()  # AttributeError: 'foo' object has no attribute '__bar'
    f._foo__bar()  # will print out 'bar'
    f._foo_var  # 1

# 对私有属性的单元测试 #

很多时候，虽然我们定义了以双下划线做前缀的属性作为“私有”属性，但我们在进行单元测试的时候往往还是需要测试或者mock这些私有属性。那么这些时候我们就要注意使用被改编过的名字来调用这些属性或者mock这些属性。

> Reference  
> [https://docs.python.org/3.5/tutorial/classes.html\#private-variables][https_docs.python.org_3.5_tutorial_classes.html_private-variables]

[https_docs.python.org_3.5_tutorial_classes.html_private-variables]: https://docs.python.org/3.5/tutorial/classes.html#private-variables