python的property属性

1、什么是property属性

一种用起来像是使用的实例属性一样的特殊属性，可以对应于某个方法

# ############# 定义 ##############
class Foo:
    def fun(self):
        pass

    # 定义property属性,必须返回一个值
    @property
    def prop(self):
        return 100

# ############# 调用 ################
foo_obj = Foo()
foo_obj.fun()  # 调用实例方法
print(foo_obj.prop)  # 调用属性
           

property属性的定义和调用要注意以下几点：

• 定义时，在实例方法的基础上添加

  @property

  装饰器，并且仅有

  self

  一个参数
• 调用时，无需括号

方法： foo_obj.func()
property属性：foo_obj.prop
           

2、简单的实例

对于京东商城中显示电脑主机的列表页面，每次请求不可能把数据库中的所有内容都显示到页面上，而是通过分页的功能局部显示，所以在向数据库中请求数据时就要显示的指定获取从第m条到第n条的所有数据，这个分页的功能包括：

• 根据用户请求的当前页和总数据条数计算出m和n
• 根据m和n去数据库中请求数据

class Pager:
    def __init__(self, current_page):
        # 用户请求当前的页码（第一页，第二页。。。）
        self.current_page = current_page
        # 每页默认显示10条数据
        self.per_items = 10

    @property
    def start(self):
        val = (self.current_page - 1) * (self.per_items)
        return val

    @property
    def end(self):
        val = self.current_page * self.per_items
        return val


p = Pager(1)
print(p.start)  # 就是起始值，即：m
print(p.end)  # 就是结束值，即：n
           

从上述可见：

python的

property

属性的功能是：property属性内部进行一系列的逻辑计算，最终将结果返回

3、property属性的两种方式

• 装饰器 即：在方法上应用装饰器
• 类属性 即：在类中定义值为property对象的类属性

3.1 装饰器方式

在类的实例方法上应用

@property

装饰器

Python中的类有 经典类 和 新式类 ，新式类 的属性比 经典类 的属性丰富。（如果类继承object，那么该类是新式类）

经典类，具有一种@property装饰器

class Goods:
    @property
    def price(self):
        return "laowang"


obj = Goods()
result = obj.price  # 自动执行 @property 修饰的price方法，并获取方法的返回值
print(result)
           

新式类，具有三种@property装饰器

class Goods:
    """
    只有在python3中才有@xxx.setter  @xxx.deleter
    """
    @property
    def price(self):
        print("@property")

    @price.setter
    def price(self, value):
        print("@price.setter")

    @price.deleter
    def price(self):
        print("@price.deleter")


obj = Goods()
obj.price  # 自动执行 @property 修饰的 price 方法，并获取方法的返回值
obj.price = 123 # 自动执行 @price.setter 修饰的 price 方法，并将 123 赋值给方法的参数
del obj.price  # 自动执行 @price.deleter 修饰的price方法
           

注意：

• 经典类中的属性只有一种访问方式，其对应被

  @property

  修饰的方法
• 新式类中的属性有三种访问方式，并分别对应了三个被

  @property

  、

  @方法名.setter

  、

  @方法名.deleter

新式类的实例

class Goods(object):

    def __init__(self):
        # 原价
        self.original_price = 100
        # 折扣
        self.discount = 0.8

    @property
    def price(self):
        # 实际价格 = 原价 * 折扣
        new_price = self.original_price * self.discount
        return new_price

    @price.setter
    def price(self, value):
        self.original_price = value

    @price.deleter
    def price(self):
        del self.original_price


obj = Goods()
obj.price = 200  # 修改商品原价
print(obj.price)  # 获取商品价格
del obj.price  # 删除商品原价
           

3.2 类属性方式，创建值为property对象的类属性值

• 当使用类属性的方式床啊进property属性时， 经典类 和 新式类 无区别

class Foo:
    def get_bar(self):
        return "lao"

    BAR = property(get_bar)


obj = Foo()
result = obj.BAR  # 自动调用 get_bar 方法，并获取方法的返回值
print(result)
           

property方法中有四个参数：

• 第一个：方法名，调用 对象.属性 时自动触发执行方法
• 第二个：方法名，调用 对象.属性 = XXX 时自动触发执行方法
• 第三个：方法名，调用 del 对象.属性 时自动触发执行方法
• 第四个：字符串，调用 对象.属性.__doc__，此参数是该属性的描述信息

class Foo(object):
    def get_bar(self):
        print("getter....")
        return 'lao'

    def set_bar(self, value):
        """必须两个参数"""
        print("setter....")
        return 'set value '+ value

    def del_bar(self):
        print("deleter....")
        return 'lao'

    BAR = property(get_bar, set_bar, del_bar, "description...")


obj = Foo()

obj.BAR  # 自动调用第一个参数中调用的方法：get_bar
obj.BAR = 'alex'  # 自动调用第二个参数中调用的方法：set_bar，并将‘alex’仿做参数传入
desc = Foo.BAR.__doc__  # 自动获取第四个参数中设置的值：description...
print(desc)
del obj.BAR
           

由于 类属性方式 创建

property

属性具体有三种访问方式，我们可以根据他们几个属性的访问特点，分别将三个方法定义为同一属性：获取、修改、删除

3、总结

• 定义

  property

  属性共有两种方式，分别是【装饰器】和【类属性】，而【装饰器】方式针对经典类和新式类又有所不同
• 通过使用

  property

  属性，能够简化调用者在获取数据的流程

4、应用

我们都知道，对于类方法的变量属于私有变量，是无法进行读写的，我们便可以使用

property

的

getter

和

setter

来进行私有变量的读写。

4.1 类属性方式

class Money(object):
	def __init__(self):
		self.__money = 0

	def getMoney(self):
		return self.__money

	def setMoney(self, value):
		if isinstance(value, int):
			self.__money = value
		else:
			print("error：不是整型数字")

	# 定义一个属性，当对这个money设置值时调用setMoney，获取值时调用getMoney
	money = property(getMoney, setMoney)


a = Money()
a.money = 100  # 调用setMoney方法
print(a.money)  # 调用getMoney方法 
           

4.2 装饰器

class Money(object):
	def __init__(self):
		self.__money = 0

	@property
	def money(self):
		return self.__money

	@money.setter
	def money(self, value):
		if isinstance(value, int):
			self.__money = value
		else:
			print("error：不是整型数字")


a = Money()
a.money = 100
print(a.money)