python中property, setter装饰器

本文介绍了如何在Python中通过property装饰器优雅地处理类属性的读取和设置,包括私有变量的使用,以及通过getter和setter方法实现数据验证和格式化。使用property可以使得代码更加简洁且符合Python的约定,提高代码可读性。
摘要由CSDN通过智能技术生成

问题提出:

在python中用 “.” 操作来访问和改写类的属性成员时, 会调用__get__和__set__方法,在这种情况下,python会查找class.__dict__字典,对 对应值进行操作。比如C.x 会调用C.__get__访问最终读取C.dict[x]元素。

如果需要读取时对输出结果进行修饰或者对输入进行合法化检查,通常做法是自己写get和set函数,并通过调用get和set函数进行读写类成员属性。
如:

class Timer:
	def __init__(self, value = 0.0):
		self.time = time
		self.unit = 's'
	def get_time(self):
		return str(self.time) + ' ' + self.unit
	def set_time(self, value):
		if value < 0:
			raise ValueError('Time cannot be negative')
		self.time = value
t = Timer()
t.set_time(1.0)
t.get_time()

但是这样并不美观,那么有没有更好的方法呢?

解决方案

在变量x前面加上下划线_表示为私有变量_x, 并将变量名x设为property函数返回的对象(property object)
property函数的声明为

def property(fget=None, fset=None, fdel=None, doc=None) -> <property object>

其中 fget, fset, fdel对应变量操作的读取,设置,删除 函数。
而property对象 有三个类方法,即setter, getter 和delete,用于之后设置相应的函数。

实现效果

在操作类私有成员的时候调用__get__和__set__方法时,不再采用默认的读取字典的方法,而是使用property中fget和fset指定的方法,从而实现了方便的赋值操作。
注意,即使在__init__函数中调用赋值语句,也使用的是fset方法。

class Timer:
	def __init__(self, value=0.0):
	# 1.将变量加 _ 标志这是私有成员
		self._time = value
		self._unit = 's'
	
	def get_time(self):
		return str(self._time) + ' ' + self._unit
	
	def set_time(self, value):
		if value < 0:
			raise ValueError('Time cannot be negative')
		self._time = value
	# 将变量名复制为包含get和set方法的property 对象
	time = property(get_time, set_time)
t = Timer()
t.time = 1.0
print(t.time)

这样的访问和设置 和赋值语句一样非常自然了。
上面例子中,如果采用property对象的方法而不是property函数,那么

time = property()
time = time.getter(get_time)
time = time.setter(set_time)

property 装饰器

如果觉得在最后加上property 函数这样写类的时候 还是不自然,容易忘 会写错,那么装饰器可以让类的书写更简洁。
例子:

class Timer:
	def __init__(self, value= 0.0):
		self._time = value
		self._unit = 's'
	# 使用装饰器的时候,需要注意
	# 1. 装饰器名,函数需要一直
	# 2. property需要先声明,再写setter, 顺序不能倒过来
	@property
	def time(self):
		return str(self._time) +''+self._unit
	@time.setter
	def time(self, value):
		if value < 0:
			raise ValueError('Time cannot be negative')
		self._time = value
t = Timer()
t.time = 1.0
print(t.time)

这两个装饰器:

  • @property 装饰器会把成员函数x转换为getter, 相当于做了x = property(), x=x.getter(x_get)
  • @setter 装饰器会把成员函数x转换为setter, 相当于做了x=x.setter(x_set)。
    可以看到 我们实现了通过属性x来对私有变量_x进行操作。

转自:装饰器

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值