一文詳述 Python 中的 property 語法-有解無憂

在大多數語言的程式中，一個類，每有一個屬性，就會對應 setter 和 getter，基本都是標配，

示例：

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

設定私有屬性的目的就是不想讓資料被誤取出來，增加一個方法去獲取私有屬性或者設定私有屬性，那么就保證將來想獲取屬性的時候就獲取，想設定的時候還可以進行過濾，

其他語言基本都是這么做的，但是 Python 不推薦， Python 有 property，

一、什么是property屬性

一種用起來像是使用的實體屬性一樣的特殊屬性，可以對應于某個方法，

class Foo:
    def func(self):
        pass

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

foo_obj = Foo()
foo_obj.func()  # 呼叫實體方法
foo_obj.prop  # 呼叫property屬性

示例：

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

obj = Goods()
ret = obj.size  # 呼叫屬性
print(ret)  # 100

obj.size 會自動地去呼叫 size 方法，回傳 size 方法的回傳值，

property屬性的定義和呼叫要注意以下幾點：

定義時，在實體方法的基礎上添加 @property 裝飾器；
僅有一個self引數；
呼叫時，無需括號，

那 property 屬性到底是用來干什么的？下面看一個實體，

對于京東商城中顯示電腦主機的串列頁面，每次請求不可能把資料庫中的所有內容都顯示到頁面上，而是通過分頁的功能區域顯示，所以在向資料庫中請求資料時就要顯示的指定獲取從第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)
p.start  # 就是起始值，即：m
p.end  # 就是結束值，即：n

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

二、property屬性的有兩種方式

裝飾器即：在方法上應用裝飾器，
類屬性即：在類中定義值為 property 物件的類屬性，

1、裝飾器方式

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

Python中的類有經典類和新式類，新式類的屬性比經典類的屬性豐富，（如果類繼object，那么該類是新式類）

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

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

obj = Goods()
# 自動執行 @property 修飾的 price 方法，并獲取方法的回傳值
result = obj.price  
print(result)  # laowang

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

python3 中默認繼承object類，只有在 python3 中才有@xxx.setter @xxx.deleter，

class Goods:
    
    @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()
# 自動執行 @property 修飾的 price 方法，并獲取方法的回傳值
obj.price  # @property
# 自動執行 @price.setter 修飾的 price 方法，并將  123 賦值給方法的引數
obj.price = 123  # @price.setter
# 自動執行 @price.deleter 修飾的 price 方法
del obj.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):
        del self.original_price

obj = Goods()
obj.price         # 獲取商品價格
obj.price = 200   # 修改商品原價
del obj.price     # 洗掉商品原價

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方法中有個四個引數

第一個引數是方法名，呼叫物件.屬性時自動觸發執行方法，
第二個引數是方法名，呼叫物件.屬性＝ XXX 時自動觸發執行方法，
第三個引數是方法名，呼叫 del 物件.屬性時自動觸發執行方法，
第四個引數是字串，呼叫物件.屬性.__doc__ ，此引數是該屬性的描述資訊，

示例：

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()
# 自動呼叫第一個引數中定義的方法：get_bar
obj.BAR  # getter...
# 自動呼叫第二個引數中定義的方法：set_bar方法，并將“alex”當作引數傳入
obj.BAR = "alex"  # setter...
# 自動獲取第四個引數中設定的值：description...
desc = Foo.BAR.__doc__
print(desc)  # description...
# 自動呼叫第三個引數中定義的方法：del_bar方法
del obj.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         # 獲取商品價格
obj.PRICE = 200   # 修改商品原價
del obj.PRICE     # 洗掉商品原價

綜上所述:

定義property屬性共有兩種方式，分別是【裝飾器】和【類屬性】，而【裝飾器】方式針對經典類和新式類又有所不同，
通過使用property屬性，能夠簡化呼叫者在獲取資料的流程，

編程的朝圣之路

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/5071.html

標籤：Python

上一篇：python爬取酷我音樂(收費也可)

下一篇：虛擬機linux安裝anaconda3卡在Unpacking payload ...