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__的魔力，创建既迷人又实用的代码。祝您编码愉快！