python - 属性装饰器的下划线开头的变量

Question

我是 Python 新手。所以，如果这是一个基本问题，请原谅我。我在 Internet 和 SO 上研究了这个主题，但找不到解释。我正在使用 Anaconda 3.6 发行版。

我正在尝试为属性创建一个简单的 getter 和 setter。我将引导您解决我遇到的错误。

class Person:
    def __init__(self,name):
        self.name=name

bob = Person('Bob Smith')
print(bob.name)

这会打印名字 我同意我没有覆盖 print 或 getattribute 方法。此外，这里没有属性(property)。这是为了测试基本代码是否有效。

让我们修改代码以添加属性:

class Person:
    def __init__(self,name):
        self.name=name

    @property
    def name(self):
        "name property docs"
        print('fetch...')
        return self.name


bob = Person('Bob Smith')
print(bob.name)

当我在 PyCharm 中编写上面的代码时，我得到一个黄色灯泡图标，表明该变量必须是私有(private)的。我不明白其中的道理。

忽略上面的代码，如果我运行上面的代码，我会得到:

Traceback (most recent call last):   File "C:\..., in run_code
    exec(code_obj, self.user_global_ns, self.user_ns)   File "<ipython-input-25-62e9a426d2a9>", line 2, in <module>
    bob = Person('Bob Smith')   File "<ipython-input-24-6c55f4b7326f>", line 4, in __init__
    self.name=name AttributeError: can't set attribute

现在，我研究了这个主题，发现有两个修复方法(不知道为什么会这样):

修复 #1: 将变量 name 更改为 _name

class Person:
    def __init__(self,name):
        self._name=name #Changed name to _name

    @property
    def name(self):
        "name property docs"
        print('fetch...')
        return self._name #Changed name to _name


bob = Person('Bob Smith')
print(bob.name)

这很好用，因为它可以正确打印输出。

修复 #2:将属性名称从 name(self) 更改为 _name(self) 并从 恢复变量名称_name 到 name

class Person:
    def __init__(self,name):
        self.name=name #changed to name

    @property
    def _name(self): #Changed to _name
        "name property docs"
        print('fetch...')
        return self.name #changed to name


bob = Person('Bob Smith')
print(bob.name)

现在，这可以按预期打印。

作为下一步，我使用装饰器创建了 setter、getter 和 deleter 属性。它们遵循与上述类似的命名约定——即在变量名或方法名前加上 _ 前缀:

@_name.setter
def _name(self,value):
    "name property setter"
    print('change...')
    self.name=value

@_name.deleter
def _name(self):
    print('remove')
    del self.name


bob = Person('Bob Smith')
print(bob.name)
bob.name = 'Bobby Smith'
print(bob.name)
del bob.name

问题:我不太确定为什么 Python 3.x 强制在变量名或方法名中添加 _。

根据 Python property with public getter and private setter , What is the difference in python attributes with underscore in front and back , 和 https://www.python.org/dev/peps/pep-0008/#naming-conventions ，下划线前缀向用户表明该变量是私有(private)变量的弱指示，但没有额外的机制(通过 Python，类似于 Java 所做的)来检查或纠正此类行为。

所以，手头的一个大问题是，为什么我需要使用下划线来处理属性？我相信那些下划线前缀只是为了让用户知道这是一个私有(private)变量。

---

我正在使用 Lutz 的书来学习 Python，上面的例子是从他的书中得到的启发。

Answer 1

让我们对您的代码进行修复 1:

class Person:
    def __init__(self,name):
        self._name=name #Changed name to _name

    @property
    def name(self):
        "name property docs"
        print('fetch...')
        return self._name #Changed name to _name

bob = Person('Bob Smith')
print(bob.name)

• 您定义 self._name = name - 那是您的支持字段。
• 您定义一个方法 def name(self) - 并使用 @property 对其进行属性设置。
• 您通过 bob = Person('Bob Smith')
创建了您的类的一个实例

然后你做 print(bob.name) - 你在这里调用什么？

您的变量称为 self._name - bob.name() 将调用“非属性”方法。为什么 bob .name 仍然有效 - 它由 @property 装饰器完成。

如果你定义会发生什么:

def tata(self):
    print(self.name)  # also no () after self.name

bob = Person('Bob Smith') 
bob.tata()

它还会调用您的@property 方法，因为您可以通过'fetch...' 输出进行检查。所以每次调用 yourclassinstance.name 都会通过 @property 访问器 - 这就是为什么你不能同时拥有 self.name “变量”。

如果您从 def name(self) 内部访问 self.name - 您会收到循环调用 - 因此:堆栈溢出。

这是纯粹的观察——如果你想看看到底发生了什么，你必须检查 @property 实现。

您可以在此处更深入地了解主题:

• How do Python properties work?
• How does the @property decorator work in Python?
• What's the pythonic way to use getters and setters?

---

正如评论中所指出的，使用 getters/setters 是一种反模式除非他们实际上做某事:

class Person:
    """Silly example for properties and setter/deleter that do something."""
    def __init__(self,name):
        self._name = name  # bypass name setter by directly setting it
        self._name_access_counter = 0
        self._name_change_counter = 0
        self._name_history = [name]

    @property
    def name(self):
        """Counts any access and returns name + count"""
        self._name_access_counter += 1
        return f'{self._name} ({self._name_access_counter})'

    @name.setter
    def name(self, value):
      """Allow only 3 name changes, and enforce names to be CAPITALs"""
      if value == self._name:
        return
      new_value = str(value).upper()
      if self._name_change_counter < 3:
        self._name_change_counter += 1
        print(f'({self._name_change_counter}/3 changes: {self._name} => {new_value}')
        self._name_history.append(new_value)
        self._name = new_value
      else:
        print(f"no change allowed: {self._name} => {new_value} not set!")

    @name.deleter
    def name(self):
        """Misuse of del - resets counters/history for example purposes"""
        self._name_access_counter = 0
        self._name_change_counter = 0
        self._name_history = self._name_history[:1]  # keep initial name
        self._name = self._name_history[0] # reset to initial name
        print("deleted history and reset changes")

    @property
    def history(self):
      return self._name_history

用法:

p = Person("Maria")

print(list(p.name for _ in range(5)))

for name in ["Luigi", "Mario", 42, "King"]:
  p.name = name
  print(p.name)  # counter will count ANY get access
  
print(p.history)
del (p.name)
print(p.name)
print(p.history)

输出:

# get 5 times and print as list
['Maria (1)', 'Maria (2)', 'Maria (3)', 'Maria (4)', 'Maria (5)']

# try to change 4 times
(1/3 changes: Maria => LUIGI
LUIGI (6)
(2/3 changes: LUIGI => MARIO
MARIO (7)
(3/3 changes: MARIO => 42
42 (8)
no change allowed: 42 => KING not set!
42 (9)

# print history so far
['Maria', 'LUIGI', 'MARIO', 'KING']

# delete name, print name and history after delete
deleted history and reset changes
Maria (1)
['Maria']