在本教程中,您将学习Python @property装饰器。一种在面向对象程序设计中使用getter和setter的pythonic方式。
Python编程为我们提供了一个内置的@property
装饰器,该装饰器使面向对象编程中的getter和setter的使用变得更加容易。
在详细介绍什么是@property
装饰器之前,让我们首先对为什么首先需要使用它进行直观了解。
没有getter和setter的类
让我们假设我们决定建立一个以摄氏度为单位存储温度的类。它还将实现一种将温度转换为华氏度的方法。一种方法如下:
class Celsius:
def __init__(self, temperature = 0):
self.temperature = temperature
def to_fahrenheit(self):
return (self.temperature * 1.8) + 32
我们可以根据需要创建对象,并根据需要操纵temperature
属性:
# Basic method of setting and getting attributes in Python
class Celsius:
def __init__(self, temperature=0):
self.temperature = temperature
def to_fahrenheit(self):
return (self.temperature * 1.8) + 32
# Create a new object
human = Celsius()
# Set the temperature
human.temperature = 37
# Get the temperature attribute
print(human.temperature)
# Get the to_fahrenheit method
print(human.to_fahrenheit())
输出
37 98.60000000000001
转换为华氏温度时,多余的小数位是由于浮点运算错误引起的。要了解更多信息,请访问Python浮点算术错误。
每当我们temperature
如上所述分配或检索任何对象属性时,Python都会在对象的内置__dict__
字典属性中进行搜索。
>>> human.__dict__
{'temperature': 37}
因此,man.temperature
内部变为man.__dict__['temperature']
。
使用getter和setter
假设我们要扩展 摄氏温度上面定义的类。我们知道任何物体的温度都不能低于-273.15摄氏度(热力学中的绝对零)
让我们更新代码以实现此值约束。
解决上述限制的一个显而易见的解决方案是隐藏属性temperature
(将其设为私有),并定义新的getter和setter方法来对其进行操作。可以按照以下步骤进行操作:
# Making Getters and Setter methods
class Celsius:
def __init__(self, temperature=0):
self.set_temperature(temperature)
def to_fahrenheit(self):
return (self.get_temperature() * 1.8) + 32
# getter method
def get_temperature(self):
return self._temperature
# setter method
def set_temperature(self, value):
if value < -273.15:
raise ValueError("Temperature below -273.15 is not possible.")
self._temperature = value
如我们所见,以上方法引入了两个newget_temperature()
和set_temperature()
方法。
此外,temperature
被替换为_temperature
。_
开头的下划线用于表示Python中的私有变量。
现在,让我们使用以下实现:
# Making Getters and Setter methods
class Celsius:
def __init__(self, temperature=0):
self.set_temperature(temperature)
def to_fahrenheit(self):
return (self.get_temperature() * 1.8) + 32
# getter method
def get_temperature(self):
return self._temperature
# setter method
def set_temperature(self, value):
if value < -273.15:
raise ValueError("Temperature below -273.15 is not possible.")
self._temperature = value
# Create a new object, set_temperature() internally called by __init__
human = Celsius(37)
# Get the temperature attribute via a getter
print(human.get_temperature())
# Get the to_fahrenheit method, get_temperature() called by the method itself
print(human.to_fahrenheit())
# new constraint implementation
human.set_temperature(-300)
# Get the to_fahreheit method
print(human.to_fahrenheit())
输出
37 98.60000000000001 Traceback (most recent call last): File "<string>", line 30, in <module> File "<string>", line 16, in set_temperature ValueError: Temperature below -273.15 is not possible.
此更新成功实施了新限制。我们不再允许将温度设置为低于-273.15摄氏度。
注意:私有变量实际上在Python中不存在。有一些简单的准则可以遵循。语言本身没有任何限制。
>>> human._temperature = -300
>>> human.get_temperature()
-300
但是,上述更新的最大问题是,实现我们上一类的所有程序都必须将代码从obj.temperature
to修改,obj.get_temperature()
并且所有表达式都喜欢obj.temperature = val
to obj.set_temperature(val)
。
在处理成千上万行代码时,这种重构可能会引起问题。
总而言之,我们的新更新不向后兼容。这是@property
救援的地方。
物业类别
解决上述问题的一种Python方法是使用property
该类。这是我们如何更新代码的方法:
# using property class
class Celsius:
def __init__(self, temperature=0):
self.temperature = temperature
def to_fahrenheit(self):
return (self.temperature * 1.8) + 32
# getter
def get_temperature(self):
print("Getting value...")
return self._temperature
# setter
def set_temperature(self, value):
print("Setting value...")
if value < -273.15:
raise ValueError("Temperature below -273.15 is not possible")
self._temperature = value
# creating a property object
temperature = property(get_temperature, set_temperature)
我们print()
在内部添加了一个函数get_temperature()
,set_temperature()
以清楚地观察它们是否正在执行。
代码的最后一行是一个属性对象temperature
。简而言之,property将一些代码(get_temperature
和set_temperature
)附加到成员属性访问(temperature
)。
让我们使用以下更新代码:
# using property class
class Celsius:
def __init__(self, temperature=0):
self.temperature = temperature
def to_fahrenheit(self):
return (self.temperature * 1.8) + 32
# getter
def get_temperature(self):
print("Getting value...")
return self._temperature
# setter
def set_temperature(self, value):
print("Setting value...")
if value < -273.15:
raise ValueError("Temperature below -273.15 is not possible")
self._temperature = value
# creating a property object
temperature = property(get_temperature, set_temperature)
human = Celsius(37)
print(human.temperature)
print(human.to_fahrenheit())
human.temperature = -300
输出
Setting value... Getting value... 37 Getting value... 98.60000000000001 Setting value... Traceback (most recent call last): File "<string>", line 31, in <module> File "<string>", line 18, in set_temperature ValueError: Temperature below -273 is not possible
如我们所见,任何检索到的值的代码temperature
都会自动调用,get_temperature()
而不是字典(__dict__)查找。同样,任何将值分配给的代码temperature
都会自动调用set_temperature()
。
我们甚至可以看到上面的内容,set_temperature()
即使在创建对象时也是如此。
>>> human = Celsius(37)
Setting value...
你能猜出为什么吗?
原因是创建对象时,__init__()
将调用该方法。此方法已行self.temperature = temperature
。此表达式自动调用set_temperature()
。
同样,任何访问,例如c.temperature
自动调用get_temperature()
。这就是财产的作用。这里还有一些例子。
>>> human.temperature
Getting value
37
>>> human.temperature = 37
Setting value
>>> c.to_fahrenheit()
Getting value
98.60000000000001
通过使用property
,我们可以看到在实现值约束时不需要进行任何修改。因此,我们的实现是向后兼容的。
注意:实际温度值存储在私有_temperature
变量中。该temperature
属性是一个属性对象,它提供此私有变量的接口。
@property装饰器
在Python中,property()
是创建并返回property
对象的内置函数。该函数的语法为:
property(fget=None, fset=None, fdel=None, doc=None)
在哪里,
fget
是获取属性值的函数fset
是设置属性值的功能fdel
是删除属性的功能doc
是一个字符串(如评论)
从实现中可以看出,这些函数参数是可选的。因此,可以按如下所示简单地创建属性对象。
>>> property()
<property object at 0x0000000003239B38>
对象的属性有三种方法,getter()
,setter()
,和deleter()
指定fget
,fset
并fdel
在稍后的点。这意味着,该行:
temperature = property(get_temperature,set_temperature)
可以细分为:
# make empty property
temperature = property()
# assign fget
temperature = temperature.getter(get_temperature)
# assign fset
temperature = temperature.setter(set_temperature)
这两段代码是等效的。
熟悉Python Decorators的程序员可以认识到上述构造可以实现为装饰器。
我们甚至无法定义名称get_temperature
,set_temperature
因为它们是不必要的,因此会污染类名称空间。
为此,我们temperature
在定义getter和setter函数的同时重用了该名称。让我们看一下如何将其实现为装饰器:
# Using @property decorator
class Celsius:
def __init__(self, temperature=0):
self.temperature = temperature
def to_fahrenheit(self):
return (self.temperature * 1.8) + 32
@property
def temperature(self):
print("Getting value...")
return self._temperature
@temperature.setter
def temperature(self, value):
print("Setting value...")
if value < -273.15:
raise ValueError("Temperature below -273 is not possible")
self._temperature = value
# create an object
human = Celsius(37)
print(human.temperature)
print(human.to_fahrenheit())
coldest_thing = Celsius(-300)
输出
Setting value... Getting value... 37 Getting value... 98.60000000000001 Setting value... Traceback (most recent call last): File "<string>", line 29, in <module> File "<string>", line 4, in __init__ File "<string>", line 18, in temperature ValueError: Temperature below -273 is not possible
上面的实现是简单而有效的。这是推荐的使用方式property
。