類的property特性

目錄

• 1、什麼是 property特性
• 2、簡單示例
• 3、 property屬性的兩種方式
  • 3.1 裝飾器
  • 3.2 類屬性方式
• 4、property+類的封裝
• 5、應用
  • 5.1 私有屬性添加getter和setter方法
  • 5.2 使用property升級getter和setter方法
  • 5.3 使用property取代getter和setter方法
• 6、練習

1、什麼是 property特性

• property裝飾器用於將被裝飾的方法假裝成一個數據屬性，在使用時能夠不用加括號而直接使用

# ############### 定義 ###############
class Foo:
    def func(self):
        pass

    # 定義property屬性
    @property
    def prop(self):
        pass


# ############### 調用 ###############
foo_obj = Foo()
foo_obj.func()  # 調用實例方法
foo_obj.prop  # 調用property屬性

以下的例子用於說明如何定一個簡單的property屬性：

class Goods(object):
    @property
    def size(self):
        return 100


g = Goods()
print(g.size)

100

property屬性的定義和調用要注意一下幾點：

1. 定義時，在實例方法的基礎上添加 @property 裝飾器；而且僅有一個self參數

2. 調用時，無需括號

2、簡單示例

對於京東商城中顯示電腦主機的列表頁面，每次請求不可能把數據庫中的全部內容都顯示到頁面上，而是經過分頁的功能局部顯示，因此在向數據庫中請求數據時就要顯示的指定獲取從第m條到第n條的全部數據 這個分頁的功能包括：

1. 根據用戶請求的當前頁和總數據條數計算出 m 和 n

2. 根據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

0

print(p.end)  # 就是結束值，即：n

10

從上述可見Python的property屬性的功能是：property屬性內部進行一系列的邏輯計算，最終將計算結果返回。

3、 property屬性的兩種方式

1. 裝飾器 即：在方法上應用裝飾器（推薦使用）

2. 類屬性 即：在類中定義值爲property對象的類屬性（Python2歷史遺留）

3.1 裝飾器

在類的實例方法上應用 @property 裝飾器

Python中的類有經典類和新式類，新式類的屬性比經典類的屬性豐富。（ 若是類繼object，那麼該類是新式類 ）

經典類，具備一種 @property 裝飾器：

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


# ############### 調用 ###############
obj = Goods()
result = obj.price  # 自動執行 @property 修飾的 price 方法，並獲取方法的返回值
print(result)

laowang

新式類，具備三種 @property 裝飾器：

#coding=utf-8
# ############### 定義 ###############
class Goods:
    """python3中默認繼承object類
        以python二、3執行此程序的結果不一樣，由於只有在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 方法，並獲取方法的返回值

@property

obj.price = 123  # 自動執行 @price.setter 修飾的 price 方法，並將  123 賦值給方法的參數

@price.setter

del obj.price  # 自動執行 @price.deleter 修飾的 price 方法

@price.deleter

注意：

• 經典類中的屬性只有一種訪問方式，其對應被 @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):
        print('del')
        del self.original_price


obj = Goods()
print(obj.price)  # 獲取商品價格

80.0

obj.price = 200  # 修改商品原價
print(obj.price)

160.0

del obj.price  # 刪除商品原價

del

3.2 類屬性方式

建立值爲property對象的類屬性

注意：當使用類屬性的方式建立property屬性時，經典類和新式類無區別

class Foo:
    def get_bar(self):
        return 'laowang'

    BAR = property(get_bar)


obj = Foo()
reuslt = obj.BAR  # 自動調用get_bar方法，並獲取方法的返回值
print(reuslt)

laowang

property方法中有個四個參數

1. 第一個參數是方法名，調用 對象.屬性 時自動觸發執行方法

2. 第二個參數是方法名，調用 對象.屬性 ＝ XXX 時自動觸發執行方法

3. 第三個參數是方法名，調用 del 對象.屬性 時自動觸發執行方法

4. 第四個參數是字符串，調用 對象.屬性.__doc__ ，此參數是該屬性的描述信息

#coding=utf-8
class Foo(object):
    def get_bar(self):
        print("getter...")
        return 'laowang'

    def set_bar(self, value):
        """必須兩個參數"""
        print("setter...")
        return 'set value' + value

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

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


obj = Foo()

obj.BAR  # 自動調用第一個參數中定義的方法：get_bar

getter...





'laowang'

obj.BAR = "alex"  # 自動調用第二個參數中定義的方法：set_bar方法，並將「alex」看成參數傳入

setter...

desc = Foo.BAR.__doc__  # 自動獲取第四個參數中設置的值：description...
print(desc)

description...

del obj.BAR  # 自動調用第三個參數中定義的方法：del_bar方法

deleter...

因爲類屬性方式建立property屬性具備3種訪問方式，咱們能夠根據它們幾個屬性的訪問特色，分別將三個方法定義爲對同一個屬性：獲取、修改、刪除

class Goods(object):
    def __init__(self):
        # 原價
        self.original_price = 100
        # 折扣
        self.discount = 0.8

    def get_price(self):
        # 實際價格 = 原價 * 折扣
        new_price = self.original_price * self.discount
        return new_price

    def set_price(self, value):
        self.original_price = value

    def del_price(self):
        del self.original_price

    PRICE = property(get_price, set_price, del_price, '價格屬性描述...')


obj = Goods()
obj.PRICE  # 獲取商品價格

80.0

obj.PRICE = 200  # 修改商品原價
print(obj.PRICE)

160.0

del obj.PRICE  # 刪除商品原價

綜上所述:

• 定義property屬性共有兩種方式，分別是【裝飾器】和【類屬性】，而【裝飾器】方式針對經典類和新式類又有所不一樣。

• 經過使用property屬性，可以簡化調用者在獲取數據的流程

4、property+類的封裝

class People:
    def __init__(self, name):
        self.__name = name

    @property  # 查看obj.name
    def name(self):
        return '<名字是：%s>' % self.__name


peo1 = People('nick')

print(peo1.name)

<名字是：nick>

try:
    peo1.name = 'EGON'
except Exception as e:
    print(e)

can't set attribute

5、應用

5.1 私有屬性添加getter和setter方法

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:不是整型數字")

5.2 使用property升級getter和setter方法

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方法

100

5.3 使用property取代getter和setter方法

從新實現一個屬性的設置和讀取方法,可作邊界斷定

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

    # 使用裝飾器對money進行裝飾，那麼會自動添加一個叫money的屬性，當調用獲取money的值時，調用裝飾的方法
    @property
    def money(self):
        return self.__money

    # 使用裝飾器對money進行裝飾，當對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)

100

6、練習

計算圓的周長和麪積

import math


class Circle:
    def __init__(self, radius):  # 圓的半徑radius
        self.radius = radius

    @property
    def area(self):
        return math.pi * self.radius**2  # 計算面積

    @property
    def perimeter(self):
        return 2 * math.pi * self.radius  # 計算周長


c = Circle(10)

print(c.radius)

10

print(c.area)  # 能夠向訪問數據屬性同樣去訪問area，會觸發一個函數的執行，動態計算出一個值

314.1592653589793

print(c.perimeter)  # 同上

62.83185307179586