Zrozumienie metody __getitem__

Przejrzałem większość dokumentacji __getitem__w dokumentacji Pythona, ale nadal nie jestem w stanie pojąć jej znaczenia.

Wszystko, co mogę zrozumieć, to to, że __getitem__jest używany do wykonywania wywołań takich jak self[key]. Ale jaki z tego pożytek?

Powiedzmy, że mam klasę Pythona zdefiniowaną w ten sposób:

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"])

To zwraca wyniki zgodnie z oczekiwaniami. Ale po co używać __getitem__w pierwszej kolejności? Słyszałem również, że Python wywołuje __getitem__wewnętrznie. Ale dlaczego to robi?

Czy ktoś mógłby wyjaśnić to bardziej szczegółowo?

Cong Ma dobrze sobie radzi, wyjaśniając, do czego __getitem__służy - ale chcę podać przykład, który może być przydatny. Wyobraź sobie klasę, która modeluje budynek. W danych dla budynku zawiera szereg atrybutów, w tym opisy firm zajmujących poszczególne piętra:

Bez użycia __getitem__mielibyśmy taką klasę:

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) )

Moglibyśmy jednak użyć __getitem__(i jej odpowiednika __setitem__), aby uczynić użycie klasy Building „przyjemniejszym”.

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] )

To, czy użyjesz w __setitem__ten sposób, naprawdę zależy od tego, jak planujesz wyodrębnić swoje dane - w tym przypadku zdecydowaliśmy się traktować budynek jako kontener pięter (i możesz również zaimplementować iterator dla budynku, a może nawet możliwość cięcia - tzn. uzyskaj dane z więcej niż jednego piętra na raz - zależy to od Twoich potrzeb.

[]Składnia coraz przedmiot przez klucz lub indeks jest tylko cukier składni.

Podczas oceny a[i]wywołań Pythona a.__getitem__(i)(lub type(a).__getitem__(a, i), ale to rozróżnienie dotyczy modeli dziedziczenia i nie jest tutaj ważne). Nawet jeśli klasa of anie może jawnie definiować tej metody, zwykle jest ona dziedziczona z klasy nadrzędnej.

Wszystkie specjalne nazwy metod (Python 2.7) i ich semantyka są wymienione tutaj: https://docs.python.org/2.7/reference/datamodel.html#special-method-names

Metoda magiczna __getitem__jest zasadniczo używana do uzyskiwania dostępu do elementów list, pozycji słownika, elementów tablic itp. Jest bardzo przydatna do szybkiego wyszukiwania atrybutów instancji.

Tutaj pokazuję to z przykładową klasą Osoba, której instancje można utworzyć za pomocą „imienia”, „wieku” i „daty urodzenia”. __getitem__Metoda jest napisany w taki sposób, że można uzyskać dostęp do indeksowanych atrybutów przykład, takie jak imię lub nazwisko, dnia, miesiąca lub roku DOB itp

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

Załóżmy, że jedno wejście użytkownika jest następujące:

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

Za pomocą __getitem__metody użytkownik może uzyskać dostęp do indeksowanych atrybutów. na przykład,

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