了解__getitem__方法

Question

我已经阅读了__getitem__Python文档中的大部分文档以及stackoverflow,因此这不是一个重复的问题.但我仍然无法理解它的含义.

所以我能理解的__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__首先使用？我也听说过__getitem__内部的Python调用.但它为什么这样做呢？

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

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__这取决于您计划如何抽象数据 - 在这种情况下,我们决定将建筑物视为地板容器(您还可以为建筑物实施迭代器,甚至可能切片 - 即一次获得多个楼层的数据 - 这取决于您的需求.

Answer 2

[]按键或索引获取项目的语法只是语法糖.

当您评估a[i]Python调用时a.__getitem__(i)(或者type(a).__getitem__(a, i),这种区别是关于继承模型,并且在这里并不重要).即使该类a可能没有明确定义此方法,它通常也是从祖先类继承的.

这里列出了所有(Python 2.7)特殊方法名称及其语义:https://docs.python.org/2.7/reference/datamodel.html#special-method-names

Answer 3

魔术方法__getitem__主要用于访问列表项、字典条目、数组元素等。它对于快速查找实例属性非常有用。

在这里，我用一个示例类 Person 展示了这一点，该类可以通过“姓名”、“年龄”和“dob”（出生日期）进行实例化。该__getitem__方法以一种可以访问索引实例属性的方式编写，例如名字或姓氏、日期、月份或年份等。

import copy

# Constants that can be used to index date of birth's Date-Month-Year
D = 0; M = 1; Y = -1

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

    def __getitem__(self, indx):
        print ("Calling __getitem__")
        p = copy.copy(self)

        p.name = p.name.split(" ")[indx]
        p.dob = p.dob[indx] # or, p.dob = p.dob.__getitem__(indx)
        return p

假设一个用户输入如下：

p = Person(name = 'Jonab Gutu', age = 20, dob=(1, 1, 1999))

在__getitem__方法的帮助下，用户可以访问索引属性。例如，

print p[0].name # print first (or last) name
print p[Y].dob  # print (Date or Month or ) Year of the 'date of birth'