python - 理解 __getitem__ 方法

Question

我已经浏览了Python文档中__getitem__的大部分文档，但我仍然无法理解它的含义。

所以我能理解的是 __getitem__ 用于实现 self[key] 之类的调用。但是它有什么用呢？

假设我有一个以这种方式定义的 python 类:

class Person:
    def __init__(self,name,age):
        self.name = name
        self.age = age

    def __getitem__(self,key):
        print ("Inside `__getitem__` method!")
        return getattr(self,key)

p = Person("Subhayan",32)
print (p["age"])

这会按预期返回结果。但是为什么首先要使用 __getitem__ 呢？我还听说 Python 在内部调用 __getitem__。但是为什么会这样呢？

有人可以详细解释一下吗？

Answer 1

马聪很好地解释了 __getitem__ 的用途——但我想给你一个可能有用的例子。想象一个模拟建筑物的类。在建筑物的数据中，它包含许多属性，包括对占据每层楼的公司的描述:

如果不使用 __getitem__ 我们会有这样的类:

class Building(object):
     def __init__(self, floors):
         self._floors = [None]*floors
     def occupy(self, floor_number, data):
          self._floors[floor_number] = data
     def get_floor_data(self, floor_number):
          return self._floors[floor_number]

building1 = Building(4) # Construct a building with 4 floors
building1.occupy(0, 'Reception')
building1.occupy(1, 'ABC Corp')
building1.occupy(2, 'DEF Inc')
print( building1.get_floor_data(2) )

然而，我们可以使用 __getitem__(及其对应的 __setitem__)来“更好地”使用 Building 类。

class Building(object):
     def __init__(self, floors):
         self._floors = [None]*floors
     def __setitem__(self, floor_number, data):
          self._floors[floor_number] = data
     def __getitem__(self, floor_number):
          return self._floors[floor_number]

building1 = Building(4) # Construct a building with 4 floors
building1[0] = 'Reception'
building1[1] = 'ABC Corp'
building1[2] = 'DEF Inc'
print( building1[2] )

您是否像这样使用 __setitem__ 实际上取决于您计划如何抽象数据 - 在这种情况下，我们决定将建筑物视为楼层的容器(您也可以实现迭代器对于建筑物，甚至可能切片的能力 - 即一次获取多个楼层的数据 - 这取决于您需要什么。