博客

python __getitem__使用方法详解

  • Post category:Python

Python的特殊方法 __getitem__ 是用来实现类似序列（list, str等）对象的索引操作的方法。本篇攻略将详细讲解 __getitem__ 方法的使用方法和示例。

1. 使用方法

__getitem__ 是一个魔法方法，用于实现索引操作，定义如下：

def __getitem__(self, key):
    pass

其中，key 表示索引，可以是整数、切片对象（slice）、元组、甚至可以是任意类型的对象。

在定义一个类时，如果想要让该类的对象支持索引操作，需要实现 __getitem__ 方法，并且该方法需要返回索引所对应的值。

下面是一个简单的类，用于存储英雄联盟游戏中的英雄信息，并支持下标访问：

class Heroes:
    def __init__(self, heroes_list):
        self.heroes_list = heroes_list

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

在该例子中，Heroes 类接受一个英雄列表作为参数，并在 __init__ 方法中保存起来。而在 __getitem__ 方法中，只需要将索引 index 作为参数传入，即可实现下标访问该类对象。

2. 示例

2.1 访问列表中的元素

下面的例子展示了如何使用 __getitem__ 方法访问一个列表中的元素：

my_list = ['a', 'b', 'c']
class MyList:
    def __init__(self, lst):
        self.lst = lst

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

ml = MyList(my_list)

print(ml[1]) # 'b'

在此示例中，我们自定义了一个 MyList 类，将列表 my_list 作为参数传入类的构造函数中。在 __getitem__ 方法中，我们使用了传入的索引 index 来访问 self.lst 中对应的元素，并将其返回。当我们使用自定义的下标访问 MyList 对象时，实际上是调用了该对象的 __getitem__ 方法。

2.2 切片操作

下面的例子展示了如何使用 __getitem__ 方法实现类似 list 对象的切片操作：

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

    def __getitem__(self, slc):
        if isinstance(slc, slice):
            return self.data[slc.start: slc.stop: slc.step]
        elif isinstance(slc, int):
            return self.data[slc]
        else:
            raise TypeError(f"Expected slice or int, but got {type(slc)}")

lst = [1, 2, 3, 4, 5]
ml = MyList(lst)

print(ml[1:4]) # [2, 3, 4]

在此示例中，我们自定义了一个 MyList 类，将列表 lst 作为参数传入类的构造函数中。在 __getitem__ 方法中，我们对传入的 slice 类型和整数类型参数进行了判断，以实现对于该类型参数的不同处理。当传入参数是 slice 类型时，我们则获取该切片（slice）对应的元素。当传入参数是整数类型时，则直接访问对应位置的元素。

总结

本篇攻略详细讲解了 __getitem__ 方法的使用方法。只要理解了该方法的原理和使用，我们就能够更加灵活地定义自己的类，并实现下标访问——使之拥有类似于 list,str 之类 Python 内置类型对象的特性。

Tags: