Python `getitem`和`setitem`

你是否曾考虑过Python的魔术方法如何使我们作为程序员的生活变得简单，几乎就像有一个友善的伙伴引导着我们一样？在这篇文章中，我们将探索Python的魔术方法getitem和setitem，揭示它们的奥秘，并了解它们如何帮助我们编写更加表达力强、人性化的代码。让我们开始吧！

理解魔术方法

魔术方法，又称为“dunder”方法（“double underscore”的缩写），是Python类中具有双下划线开头和结尾的特殊方法。它们允许我们定义类在特定情况下的行为，比如当我们想要访问或修改它们的属性时。其中两个魔术方法是getitem和setitem，它们用于定义如何检索和修改自定义类的属性。

getitem的魔力

getitem魔术方法允许我们定义如何使用方括号表示法访问自定义类的元素，就像我们处理列表、字典或其他内置Python对象一样。当我们定义一个带有getitem方法的类时，我们可以使用熟悉的语法访问其元素。

element = my_instance[index]

这是一个简单的自定义类MyList的示例，它使用getitem魔法方法模拟一个基本列表 –

第一步 - 用构造函数（__init__）定义MyList类，该构造函数以列表作为输入，并将其传递到data属性中。

第二步 - 实现__getitem__魔法函数，该函数以索引作为参数，返回data属性中给定索引处的元素。

第三步 - 创建一个MyList的示例，其中包含从1到5的数字列表。

第四步 - 使用方括号表示法打印索引为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])

输出

Setitem 的魔法

既然我们已经探讨了 getitem 方法，那么让我们来看看它的对应方法 setitem。setitem 魔法方法允许我们使用方括号的表示法来定义如何修改自定义类的元素。当我们在一个类中定义了 setitem 方法后，我们可以像这样修改它的元素 –

my_instance[index] = new_value

让我们扩展我们之前的MyList示例，包括setitem魔术方法-

步骤1 -使用构造函数（__init__）对MyList类进行描述，该构造函数以列表作为输入并将其存储在数据属性内。

步骤2 -实现__getitem__魔术方法，该方法以索引作为参数，并返回给定索引处数据特征的详细信息。

步骤3 -执行__setitem__魔术方法，该方法以索引和价格作为参数，并将成本委托给数据特征内给定索引处的对象。

步骤4 -使用从1到4的数字列表创建一个MyList的实例。

步骤5 -使用方括号表示法打印索引为1的元素。输出将为2。

步骤6 -使用方括号表示法将索引为1的元素修改为新值（42）。__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方法也应该支持。