Python中property的使用技巧

property属性#

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

既要保护类的封装特性,又要让开发者可以使用 对象.属性 的方式操作方法,@property 装饰器,可以直接通过方法名来访问方法,不需要在方法名后添加一对 () 小括号。

来看下求圆的面积的例子

1
class Circle(object):
2

3
    PI = 3.14
4

5
    def __init__(self, r):
6
        # r圆的半径
7
        self.r = r
8
        self.__area = self.PI * self.r * self.r
9

10
    @property
11
    def area(self):
12
        return self.__area
13

14
    def get_area(self):
15
        return self.__area
16

17
In [2]: c = Circle(10)
18

19
In [3]: c.area
20
Out[3]: 314.0
21

22
In [4]: c.get_area()
23
Out[4]: 314.0

property属性的定义和调用要注意一下几点:

1
定义时,在实例方法的基础上添加 `@property` 装饰器;并且仅有一个 `self` 参数

1
调用时,无需括号 `()`

1
  实例方法:c.get_area()
2
  property装饰的方法:c.area
3
12

具体实例#

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

1
根据用户请求的当前页和总数据条数计算出 m 和 n

1
根据 m 和 n 去数据库中请求数据

1
class Pager(object):
2

3
    def __init__(self, current_page):
4

5
        # 用户当前请求的页码(第一页、第二页...)
6
        self.current_page = current_page
7

8
        # 每页默认显示10条数据
9
        self.per_items = 10
10

11
    @property
12
    def start(self):
13
        val = (self.current_page - 1) * self.per_items
14
        return val
15

16
    @property
17
    def end(self):
18
        val = self.current_page * self.per_items
19
        return val
20

21
# ipython测验
22
In [2]: p = Pager(1)
23

24
In [3]: p.start    # 就是起始值,即:m
25
Out[3]: 0
26

27
In [4]: p.end    # 就是结束值,即:n
28
Out[4]: 10
29

30
In [5]: p = Pager(2)
31

32
In [6]: p.start
33
Out[6]: 10
34

35
In [7]: p.end
36
Out[7]: 20

property属性的有两种方式#

1
**装饰器** 即:在方法上应用装饰器 `@property`

1
**类属性** 即:在类中定义值为 `property` 对象的类属性 `property()`

装饰器方式#

在类的实例方法上应用 @property 装饰器

Python中的类有旧式类 和 新式类,新式类 的属性比 旧式类的属性丰富。

旧式类#

旧式类,具有一种 @property 装饰器

1
class Goods:
2

3
    def __init__(self, name):
4
        self.name = name
5

6
    @property
7
    def price(self):
8
        return 100
9

10
# ipython测验
11
In [10]: g = Goods('手表')
12

13
In [11]: g.price
14
Out[11]: 100

新式类#

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

1
class Goods:
2
    """
3
    python3中默认继承object类
4
    以python2、3执行此程序的结果不同,因为只有在python3中才有@xxx.setter  @xxx.deleter
5
    """
6
    @property
7
    def price(self):
8
        print('@property')
9

10
    @price.setter
11
    def price(self, value):
12
        print('@price.setter')
13

14
    @price.deleter
15
    def price(self):
16
        print('@price.deleter')
17

18
# ipython测验
19
In [13]: g = Goods()
20

21
In [14]: g.price
22
@property
23

24
In [15]: g.price = 100
25
@price.setter
26

27
In [16]: del g.price
28
@price.deleter

1
`g.price` 单独调用自动执行 `@property` 修饰的 `price` 方法,并获取方法的返回值

1
`g.price = 100` 赋值自动执行 `@price.setter` 修饰的 `price` 方法,并将 `100` 赋值给方法的参数

1
`del g.price` 删除自动执行 `@price.deleter` 修饰的 `price` 方法

注意#

1
旧式类中的属性只有一种访问方式,其对应被 `@property` 修饰的方法

1
新式类中的属性有三种访问方式,并分别对应了三个被`@property`、`@方法名.setter`、`@方法名.deleter` 修饰的方法

由于新式类中具有三种访问方式,我们可以根据它们几个属性的访问特点,分别将三个方法定义为对同一个属性:获取、修改、删除。

1
# Goods类@property应用
2

3
class Goods(object):
4

5
    def __init__(self, name, price):
6
        # 原价
7
        self.original_price = price
8

9
        # 折扣
10
        self.discount = 0.8
11

12
    @property
13
    def price(self):
14
        # 实际价格 = 原价 * 折扣
15
        new_price = self.original_price * self.discount
16
        return new_price
17

18
    @price.setter
19
    def price(self, value):
20
        self.original_price = value
21

22
    @price.deleter
23
    def price(self):
24
        print('删除商品原价')
25
        del self.original_price
26

27
# ipython测验
28
In [22]: g = Goods('小米手机', 2000)
29

30
In [23]: g.price
31
Out[23]: 1600.0
32

33
In [24]: g.price = 3000
34

35
In [25]: g.price
36
Out[25]: 2400.0
37

38
In [26]: del g.price
39
删除商品原价
40

41
In [27]: g.price
42
---------------------------------------------------------------------------
43
AttributeError                            Traceback (most recent call last)
44
<ipython-input-27-38ee45b469f2> in <module>
45
----> 1 g.price
46

47
<ipython-input-18-d5ea66eb7ece> in price(self)
48
     12     def price(self):
49
     13         # 实际价格 = 原价 * 折扣
50
---> 14         new_price = self.original_price * self.discount
51
     15         return new_price
52
     16
53

54
AttributeError: 'Goods' object has no attribute 'original_price'

类属性方式#

创建值为 property 对象的类属性,当使用类属性的方式创建 property 属性时,旧式类和新式类无区别

1
class Foo:
2

3
    def get_bar(self):
4
        return 'get_bar'
5

6
    BAR = property(get_bar)
7

8
# ipython 测验
9
In [32]: f = Foo()
10

11
In [33]: f.BAR
12
Out[33]: 'get_bar'

f.BAR 自动调用 get_bar() 方法,并获取方法的返回值

property() 中有个四个参数

1
第一个参数是方法名,调用 **对象.属性** 时自动触发执行方法

1
第二个参数是方法名,调用 **对象.属性 = XXX** 时自动触发执行方法

1
第三个参数是方法名,调用 **del 对象.属性** 时自动触发执行方法

1
第四个参数是字符串,调用 **对象.属性._*doc*****_** ,此参数是该属性的描述信息

1
class Foo(object):
2

3
    def __init__(self, bar):
4
        self.bar = bar
5

6
    def get_bar(self):
7
        print('get_bar')
8
        return self.bar
9

10
    def set_bar(self, value):
11
        """必须要有两个参数"""
12
        print('set bar ' + value)
13
        self.bar = value
14

15
    def del_bar(self):
16
        print('del bar')
17
        del self.bar
18

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

21
# ipython测验
22
In [50]: f = Foo('python')
23

24
In [51]: f.BAR
25
get_bar
26
Out[51]: 'python'
27

28
In [52]: f.BAR = 'Java'
29
set bar Java
30

31
In [53]: f.BAR
32
get_bar
33
Out[53]: 'Java'
34

35
In [54]: del f.BAR
36
del bar

property对象与@property装饰器对比#

由于 类属性方式 创建 property 对象属性具有3种访问方式,我们可以根据它们几个属性的访问特点,分别将三个方法定义为对 同一个属性:获取、修改、删除 ,跟 @property 装饰器对比。

property对象类属性#

1
# Goods类 property对象类属性 应用
2

3
class Goods(object):
4

5
    def __init__(self, name, price):
6
        # 原价
7
        self.original_price = price
8

9
        # 折扣
10
        self.discount = 0.8
11

12
    def get_price(self):
13
        # 实际价格 = 原价 * 折扣
14
        new_price = self.original_price * self.discount
15
        return new_price
16

17
    def set_price(self, value):
18
        self.original_price = value
19

20
    def del_price(self):
21
        print('删除商品原价')
22
        del self.original_price
23

24
    PRICE = property(get_price, set_price, del_price, "price description")
25

26
# ipython测验
27
In [59]: g = Goods('Mac电脑', 9000)
28

29
In [60]: g.PRICE
30
Out[60]: 7200.0
31

32
In [61]: g.PRICE = 10000
33

34
In [62]: g.PRICE
35
Out[62]: 8000.0
36

37
In [63]: del g.PRICE
38
删除商品原价

@property装饰器#

1
# Goods类 @property装饰器 应用
2

3
class Goods(object):
4

5
    def __init__(self, name, price):
6
        # 原价
7
        self.original_price = price
8

9
        # 折扣
10
        self.discount = 0.8
11

12
    @property
13
    def price(self):
14
        # 实际价格 = 原价 * 折扣
15
        new_price = self.original_price * self.discount
16
        return new_price
17

18
    @price.setter
19
    def price(self, value):
20
        self.original_price = value
21

22
    @price.deleter
23
    def price(self):
24
        print('删除商品原价')
25
        del self.original_price
26

27
# ipython测验
28
In [59]: g = Goods('Mac电脑', 9000)
29

30
In [60]: g.PRICE
31
Out[60]: 7200.0
32

33
In [61]: g.PRICE = 10000
34

35
In [62]: g.PRICE
36
Out[62]: 8000.0
37

38
In [63]: del g.PRICE
39
删除商品原价

可以发现两种都可以实现但 @property 装饰器的在旧式类中只有 @property , 没有@method.setter 和

@method.deleter,新式类则两种都可以使用.

音乐

音乐