一文詳述 Python 中的 property 語法
property() 函式的作用是在新式類中返回屬性值。
Python中有一個property的語法,它類似於C#的get set語法,其功能有以下兩點:
- 將類方法設定為只讀屬性;
- 實現屬性的getter和setter方法;
下面開始本文的重點介紹,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屬性,能夠簡化呼叫者在獲取資料的流程。
總結
到此這篇關於一文詳述 Python 中的 property 語法的文章就介紹到這了,更多相關Python 中的 property 語法內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!