property是内置的装饰器,用于创建特定属性的getter、setter和deleter方法。
property装饰器可以帮助我们实现封装性和数据的访问控制。(建议使用)
通常与getter、setter和deleter方法一起使用,用于获取、设置和删除特定属性的值。 这样做的好处是,可以隐藏底层实现细节,使得属性的访问更加灵活和可控。
示例
class Circle:
def __init__(self, age):
self._age = age
@property
def radius(self):
print("Getting radius")
return self._age
# 创建Circle对象
circle = Circle(18)
# 使用property的getter方法
print(circle.radius) # 输出: Getting radius 18
需要注意的是,虽然使用property装饰器可以让方法看起来像属性一样访问,但在背后仍然是方法的调用。这使得我们可以在访问属性时执行自定义的逻辑,而不仅仅是简单地返回属性的值。
property.setter
@property.setter是property装饰器的一个变体,用于定义属性的setter方法。它与@property配合使用,用于创建一个可写的属性,允许对属性进行赋值操作。
class Circle:
def __init__(self, age):
self._age = age
@property
def radius(self):
print("Getting radius")
return self._age
@radius.setter
def radius(self, value):
print("Setting radius")
if value >= 0:
self._age = value
else:
raise ValueError("Radius cannot be negative.")
# 创建Circle对象
circle = Circle(18)
# 使用property的setter方法
circle.radius = 27
print(circle.radius)
# Setting radius
# Getting radius
# 27
运用
class FileWriter:
def __init__(self):
self.datas = None
@property
def file_content(self):
return self.datas
@file_content.setter
def file_content(self, path):
with open(path, 'r') as file:
self.datas = file.read()
# 创建FileWriter对象
writer = FileWriter('1弧形.csv')
# 使用属性读取文件内容
print(writer.file_content) # 输出文件的内容
# 使用属性设置文件内容
writer.file_content = r"C:\Users\admin\Desktop\Log\20230706_13_54_20.log"
# 再次读取文件内容
print(writer.file_content) # 输出'New content'
乍一看是不是觉得,明明可以写在一个函数里面,现在却要分开写了,完全没必要。
直白点说,这样写看着很是牛逼的感觉。在使用Ctrl+鼠标点击file_content看到是return self.datas的file_content方法。一定程度上隐藏实现细节。
如果我想在类里面的其他函数获取读取的值,怎么操作:
class FileWriter:
def __init__(self):
self.datas = None
@property
def file_content(self):
return self.datas
@file_content.setter
def file_content(self, path):
with open(path, 'r') as file:
self.datas = file.read()
def get_data(self):
print(self.file_content)
# 创建FileWriter对象
writer = FileWriter()
# 使用属性读取文件内容
print(writer.file_content) # 输出文件的内容
# 使用属性设置文件内容
writer.file_content = r"C:\Users\admin\Desktop\Log\20230706_13_54_20.log"
writer.get_data()
就这样就可以了,大大提高了灵活性,对于自己而言,维护性也是非常不错的,封装性也是达到了。如果再给我一次重写以前代码的机会,我会把之前的读取文件代码改成这样(装杯(B))。
当然,你也可以单纯的使用property。
property.deleter
这个一般很少用到,因为在下写的项目都不大。
清理资源、阻止属性的进一步访问、阻止属性的进一步访问
class Person:
def __init__(self, name):
self._name = name
@property
def name(self):
return self._name
@name.setter
def name(self, value):
self._name = value
@name.deleter
def name(self):
del self._name
# 创建Person对象
person = Person("Alice")
# 获取属性值
print(person.name) # 输出: Alice
# 删除属性
del person.name
# 再次获取属性值(会引发AttributeError异常)
print(person.name)
# 抛出异常: AttributeError: 'Person' object has no attribute '_name'
什么时候适合使用?
1、封装属性访问:当你想要控制属性的访问方式时,可以使用property来定义属性的getter和setter方法。这样可以隐藏属性的具体实现细节,通过方法调用的方式来读取和设置属性值,从而提供更好的封装性和访问控制。
2、数据验证和处理:使用property可以在属性的getter和setter方法中添加验证逻辑,确保属性值的合法性和一致性。你可以在setter方法中进行输入验证、范围检查、类型转换等操作,以确保属性值满足特定的要求。
3、计算属性:有时候,某些属性的值是根据其他属性计算得出的,而不是直接存储的。使用property可以定义这样的计算属性,通过getter方法根据其他属性的值计算出结果,并返回给调用者。
4、兼容性和向后兼容:当你需要对已有代码进行扩展或修改时,使用property可以保持代码的向后兼容性。你可以在保持属性访问方式不变的前提下,添加新的验证逻辑、计算逻辑或其他功能,而不会影响到已有代码的调用方式。
5、简化接口:当你希望将方法调用转换为属性访问时,可以使用property。这样可以简化调用者的代码,使其更具可读性和易用性。