一文詳述 Python 中的 property 語法

更新時間：2020年09月01日 09:24:26 作者：小名叫小明

這篇文章主要介紹了一文詳述 Python 中的 property 語法,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

property() 函數(shù)的作用是在新式類中返回屬性值。

Python中有一個property的語法，它類似于C#的get set語法，其功能有以下兩點(diǎn)：

將類方法設(shè)置為只讀屬性；
實(shí)現(xiàn)屬性的getter和setter方法；

下面開始本文的重點(diǎn)介紹，Python 中的 property 語法介紹，具體內(nèi)容如下所示：

在大多數(shù)語言的程序中，一個類，每有一個屬性，就會對應(yīng) setter 和 getter，基本都是標(biāo)配。

示例：

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

設(shè)置私有屬性的目的就是不想讓數(shù)據(jù)被誤取出來，增加一個方法去獲取私有屬性或者設(shè)置私有屬性，那么就保證將來想獲取屬性的時候就獲取，想設(shè)置的時候還可以進(jìn)行過濾。

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

一、什么是property屬性

一種用起來像是使用的實(shí)例屬性一樣的特殊屬性，可以對應(yīng)于某個方法。

class Foo:
  def func(self):
    pass

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

foo_obj = Foo()
foo_obj.func() # 調(diào)用實(shí)例方法
foo_obj.prop # 調(diào)用property屬性

示例：

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

obj = Goods()
ret = obj.size # 調(diào)用屬性
print(ret) # 100

obj.size 會自動地去調(diào)用 size 方法，返回 size 方法的返回值。

property屬性的定義和調(diào)用要注意以下幾點(diǎn)：

定義時，在實(shí)例方法的基礎(chǔ)上添加 @property 裝飾器；
僅有一個self參數(shù)；
調(diào)用時，無需括號。

那 property 屬性到底是用來干什么的？下面看一個實(shí)例。

對于京東商城中顯示電腦主機(jī)的列表頁面，每次請求不可能把數(shù)據(jù)庫中的所有內(nèi)容都顯示到頁面上，而是通過分頁的功能局部顯示，所以在向數(shù)據(jù)庫中請求數(shù)據(jù)時就要顯示的指定獲取從第m條到第n條的所有數(shù)據(jù)，這個分頁的功能包括：

根據(jù)用戶請求的當(dāng)前頁和總數(shù)據(jù)條數(shù)計(jì)算出 m 和 n。
根據(jù)m 和 n 去數(shù)據(jù)庫中請求數(shù)據(jù)。

class Pager:
  def __init__(self, current_page):
    # 用戶當(dāng)前請求的頁碼（第一頁、第二頁...）
    self.current_page = current_page
    # 每頁默認(rèn)顯示10條數(shù)據(jù)
    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 # 就是結(jié)束值，即：n

從上述可見，Python 的 property 屬性的功能是：property屬性內(nèi)部進(jìn)行一系列的邏輯計(jì)算，最終將計(jì)算結(jié)果返回。

二、property屬性的有兩種方式

裝飾器即：在方法上應(yīng)用裝飾器。
類屬性即：在類中定義值為 property 對象的類屬性。

1、裝飾器方式

在類的實(shí)例方法上應(yīng)用 @property 裝飾器。

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

經(jīng)典類，具有一種 @property 裝飾器。

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

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

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

python3 中默認(rèn)繼承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()
# 自動執(zhí)行 @property 修飾的 price 方法，并獲取方法的返回值
obj.price # @property
# 自動執(zhí)行 @price.setter 修飾的 price 方法，并將 123 賦值給方法的參數(shù)
obj.price = 123 # @price.setter
# 自動執(zhí)行 @price.deleter 修飾的 price 方法
del obj.price # @price.deleter

注意：

經(jīng)典類中的屬性只有一種訪問方式，其對應(yīng)被 @property 修飾的方法。
新式類中的屬性有三種訪問方式，并分別對應(yīng)了三個被@property、@方法名.setter、@方法名.deleter修飾的方法。

由于新式類中具有三種訪問方式，我們可以根據(jù)它們幾個屬性的訪問特點(diǎn)，分別將三個方法定義為對同一個屬性：獲取、修改、刪除。

示例：

class Goods(object):

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

  @property
  def price(self):
    # 實(shí)際價格 = 原價 * 折扣
    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、類屬性方式

創(chuàng)建值為 property 對象的類屬性。

當(dāng)使用類屬性的方式創(chuàng)建property屬性時，經(jīng)典類和新式類無區(qū)別。

示例：

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

  BAR = property(get_bar)

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

property方法中有個四個參數(shù)

第一個參數(shù)是方法名，調(diào)用對象.屬性時自動觸發(fā)執(zhí)行方法。
第二個參數(shù)是方法名，調(diào)用對象.屬性＝ XXX 時自動觸發(fā)執(zhí)行方法。
第三個參數(shù)是方法名，調(diào)用 del 對象.屬性時自動觸發(fā)執(zhí)行方法。第四個參數(shù)是字符串，調(diào)用對象.屬性.__doc__ ，此參數(shù)是該屬性的描述信息。

示例：

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

  def set_bar(self, value):
    """必須兩個參數(shù)"""
    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()
# 自動調(diào)用第一個參數(shù)中定義的方法：get_bar
obj.BAR # getter...
# 自動調(diào)用第二個參數(shù)中定義的方法：set_bar方法，并將“alex”當(dāng)作參數(shù)傳入
obj.BAR = "alex" # setter...
# 自動獲取第四個參數(shù)中設(shè)置的值：description...
desc = Foo.BAR.__doc__
print(desc) # description...
# 自動調(diào)用第三個參數(shù)中定義的方法：del_bar方法
del obj.BAR # deleter...

由于類屬性方式創(chuàng)建 property 屬性具有3種訪問方式，我們可以根據(jù)它們幾個屬性的訪問特點(diǎn)，分別將三個方法定義為對同一個屬性：獲取、修改、刪除。

class Goods(object):

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

  def get_price(self):
    # 實(shí)際價格 = 原價 * 折扣
    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   # 刪除商品原價

綜上所述: