Python中關於property使用的小技巧

Posted on by

property屬性

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

既要保護類的封裝特性，又要讓開發者可以使用 對象.屬性 的方式操作方法，@property 裝飾器，可以直接通過方法名來訪問方法，不需要在方法名後添加一對 () 小括號。

來看下求圓的面積的例子

class Circle(object):

    PI = 3.14

    def __init__(self, r):
        # r圓的半徑
        self.r = r
        self.__area = self.PI * self.r * self.r
    
    @property
    def area(self):
        return self.__area

    def get_area(self):
        return self.__area


In [2]: c = Circle(10)

In [3]: c.area
Out[3]: 314.0

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

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

  • 定義時，在實例方法的基礎上添加 @property 裝飾器；並且僅有一個 self 參數
  • 調用時，無需括號 ()
  實例方法：c.get_area()
  property裝飾的方法：c.area

具體實例

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

  • 根據用戶請求的當前頁和總數據條數計算出 m 和 n
  • 根據 m 和 n 去數據庫中請求數據
class Pager(object):
    
    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

# ipython測驗
In [2]: p = Pager(1)


In [3]: p.start		# 就是起始值，即：m
Out[3]: 0

In [4]: p.end		# 就是結束值，即：n
Out[4]: 10

In [5]: p = Pager(2)

In [6]: p.start
Out[6]: 10

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

property屬性的有兩種方式

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

裝飾器方式

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

Python中的類有舊式類 和 新式類，新式類 的屬性比 舊式類的屬性豐富。

舊式類

舊式類，具有一種 @property 裝飾器

   
class Goods:
    
    def __init__(self, name):
        self.name = name
        
    @property
    def price(self):
        return 100
    
# ipython測驗
In [10]: g = Goods('手表')

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

新式類

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

class Goods:
    """
    python3中默認繼承object類
    以python2、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')

        
# ipython測驗
In [13]: g = Goods()

In [14]: g.price
@property

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

In [16]: del g.price
@price.deleter
  • g.price 單獨調用自動執行 @property 修飾的 price 方法，並獲取方法的返回值
  • g.price = 100 賦值自動執行 @price.setter 修飾的 price 方法，並將 100 賦值給方法的參數
  • del g.price 刪除自動執行 @price.deleter 修飾的 price 方法

註意

  • 舊式類中的屬性隻有一種訪問方式，其對應被 @property 修飾的方法
  • 新式類中的屬性有三種訪問方式，並分別對應瞭三個被@property、@方法名.setter、@方法名.deleter 修飾的方法

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

# Goods類@property應用

class Goods(object):

    def __init__(self, name, price):
        # 原價
        self.original_price = price

        # 折扣
        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 self.original_price

        
# ipython測驗
In [22]: g = Goods('小米手機', 2000)

In [23]: g.price
Out[23]: 1600.0

In [24]: g.price = 3000

In [25]: g.price
Out[25]: 2400.0

In [26]: del g.price
刪除商品原價

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

<ipython-input-18-d5ea66eb7ece> in price(self)
     12     def price(self):
     13         # 實際價格 = 原價 * 折扣
---> 14         new_price = self.original_price * self.discount
     15         return new_price
     16

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

類屬性方式

創建值為 property 對象的類屬性，當使用類屬性的方式創建 property 屬性時，舊式類 和 新式類無區別

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

    BAR = property(get_bar)
    
    
# ipython 測驗
In [32]: f = Foo()

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

f.BAR 自動調用 get_bar() 方法，並獲取方法的返回值

property() 中有個四個參數

  • 第一個參數是方法名，調用 對象.屬性 時自動觸發執行方法
  • 第二個參數是方法名，調用 對象.屬性 ＝ XXX 時自動觸發執行方法
  • 第三個參數是方法名，調用 del 對象.屬性 時自動觸發執行方法
  • 第四個參數是字符串，調用 對象.屬性._doc_ ，此參數是該屬性的描述信息 
class Foo(object):

    def __init__(self, bar):
        self.bar = bar
    
    def get_bar(self):
        print('get_bar')
        return self.bar

    def set_bar(self, value): 
        """必須要有兩個參數"""
        print('set bar ' + value)
        self.bar = value

    def del_bar(self):
        print('del bar')
        del self.bar

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

    
# ipython測驗
In [50]: f = Foo('python')

In [51]: f.BAR
get_bar
Out[51]: 'python'

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

In [53]: f.BAR
get_bar
Out[53]: 'Java'

In [54]: del f.BAR
del bar

property對象與@property裝飾器對比

由於 類屬性方式 創建 property 對象屬性具有3種訪問方式，我們可以根據它們幾個屬性的訪問特點，分別將三個方法定義為對 同一個屬性：獲取、修改、刪除 ，跟 @property 裝飾器對比。

property對象類屬性

# Goods類 property對象類屬性 應用

class Goods(object):

    def __init__(self, name, price):
        # 原價
        self.original_price = price

        # 折扣
        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):
        print('刪除商品原價')
        del self.original_price

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

    
# ipython測驗
In [59]: g = Goods('Mac電腦', 9000)

In [60]: g.PRICE
Out[60]: 7200.0

In [61]: g.PRICE = 10000

In [62]: g.PRICE
Out[62]: 8000.0

In [63]: del g.PRICE
刪除商品原價

@property裝飾器

# Goods類 @property裝飾器 應用

class Goods(object):

    def __init__(self, name, price):
        # 原價
        self.original_price = price

        # 折扣
        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 self.original_price
        
        
# ipython測驗
In [59]: g = Goods('Mac電腦', 9000)

In [60]: g.PRICE
Out[60]: 7200.0

In [61]: g.PRICE = 10000

In [62]: g.PRICE
Out[62]: 8000.0

In [63]: del g.PRICE
刪除商品原價

可以發現兩種都可以實現但 @property 裝飾器的在 舊式類中隻有 @property ， 沒有@method.setter 和@method.deleter，新式類則兩種都可以使用。因此看大傢的習慣，選一種。

大自然用數百億年創造出我們現實世界，而程序員用幾百年創造出一個完全不同的虛擬世界。我們用鍵盤敲出一磚一瓦，用大腦構建一切。人們把1000視為權威，我們反其道行之，捍衛1024的地位。我們不是鍵盤俠，我們隻是平凡世界中不凡的締造者 。

到此這篇關於Python中關於property使用的小技巧的文章就介紹到這瞭,更多相關Python property 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：