Python中的__getitem__和__setitem__

---

您是否曾經想過Python的魔法方法是如何簡化我們程式設計師的生活的，就好像我們有一個樂於助人的夥伴在引導我們前進？在本文中，我們將探討Python的魔法方法__getitem__和__setitem__，揭開它們的奧秘，並瞭解它們如何幫助我們編寫更具表現力、更人性化的程式碼。讓我們開始吧！

理解魔法方法

魔法方法，也稱為“dunder”方法（“雙下劃線”的縮寫），是Python類中獨特的具有雙下劃線作為名稱開頭和結尾的方法。它們允許我們定義我們的類在特定情況下應該如何行為，例如當我們需要訪問或修改其元素時。其中兩個魔法方法是__getitem__和__setitem__，它們用於定義我們如何檢索和修改自定義類的元素。

__getitem__的魔力

__getitem__魔法方法允許我們定義如何使用方括號表示法訪問自定義類的元素，就像我們使用列表、字典或其他內建Python物件一樣。當我們使用__getitem__方法定義一個類時，我們可以使用熟悉的語法訪問其元素：

element = my_instance[index]

這是一個名為MyList的簡單自定義類的示例，它使用__getitem__魔法方法模擬一個基本列表：

步驟1 − 定義MyList類，其建構函式(__init__)接收一個列表作為輸入，並將它儲存在data屬性中。

步驟2 − 實現__getitem__魔法方法，它接收一個索引作為引數，並返回data屬性中給定索引處的元素。

步驟3 − 建立一個包含從1到5的數字列表的MyList例項。

步驟4 − 使用方括號表示法列印索引1處的元素。輸出將為2。

示例

class MyList:
   def __init__(self, data):
      self.data = data

   def __getitem__(self, index):
      return self.data[index]

my_list = MyList([1, 2, 3, 4, 5])
print(my_list[1])  

輸出

2

__setitem__的魅力

現在我們已經探索了__getitem__，讓我們來看看它的對應方法__setitem__。__setitem__魔法方法允許我們使用方括號表示法定義如何修改自定義類的元素。當我們使用__setitem__方法定義一個類時，我們可以像這樣修改其元素：

my_instance[index] = new_value

讓我們擴充套件之前的MyList示例以包含__setitem__魔法方法：

步驟1 − 定義MyList類，其建構函式(__init__)接收一個列表作為輸入，並將它儲存在data屬性中。

步驟2 − 實現__getitem__魔法方法，它接收一個索引作為引數，並返回data屬性中給定索引處的元素。

步驟3 − 實現__setitem__魔法方法，它接收一個索引和一個值作為引數，並將該值賦給data屬性中給定索引處的元素。

步驟4 − 建立一個包含從1到4的數字列表的MyList例項。

步驟5 − 使用方括號表示法列印索引1處的元素。輸出將為2。

步驟6 − 透過使用方括號表示法賦值新值(42)來修改索引1處的元素。__setitem__方法將處理修改。

步驟7 − 再次使用方括號表示法列印索引1處的元素。由於步驟6中的修改，輸出現在將為42。

示例

class MyList:
   def __init__(self, data):
      self.data = data

   def __getitem__(self, index):
      return self.data[index]

   def __setitem__(self, index, value):
      self.data[index] = value

my_list = MyList([1, 2, 3, 4, 5])
print(my_list[1])  # Output: 2

my_list[1] = 42
print(my_list[1]) 

輸出

2
42

使用__getitem__和__setitem__的最佳實踐

現在我們已經瞭解了__getitem__和__setitem__的魔力，讓我們回顧一下使用這些方法建立更人性化程式碼的最佳實踐：

• 使您的程式碼直觀 − 使用__getitem__和__setitem__時，目標是直觀的行為，類似於列表、字典或陣列等內建Python物件。這將使您的自定義類更容易理解和使用。

• 優雅地處理極端情況 − 準備好處理極端情況，例如無效索引或鍵。您可以引發適當的異常，例如索引無效時的IndexError或鍵無效時的KeyError，以告知使用者問題所在。

• 使用清晰的變數名 − 定義__getitem__和__setitem__方法時，請為索引和值使用清晰且具有描述性的變數名。這將使您的程式碼更易於閱讀和維護。

• 不要忘記切片 − 考慮在您的__getitem__和__setitem__方法中支援切片操作，使您的自定義類更通用且更方便使用。

• 保持一致性 − 如果您的類同時實現了__getitem__和__setitem__，請確保它們的行為保持一致。例如，如果您的__getitem__方法支援負索引，則您的__setitem__方法也應該支援。

結論

在本文中，我們探索了__getitem__和__setitem__魔法方法的神奇世界。這些強大的工具使我們能夠建立具有直觀且熟悉行為的自定義類，模仿內建Python物件，並使我們的程式碼更具表現力且更人性化。

透過遵循我們討論的最佳實踐，您將能夠利用__getitem__和__setitem__的強大功能來建立自定義類，讓您的程式設計師同事感覺如同使用第二語言一般自然，從而促進協作和理解。因此，請繼續在您的Python專案中傳播__getitem__和__setitem__的魔力，建立既迷人又實用的程式碼。祝您編碼愉快！