__getitem__メソッドについて


138

私は__getitem__Pythonドキュメントのほとんどのドキュメントを読み終えましたが、それでもその意味を理解できません。

だから私が理解できるのは、それ__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__内部的に呼び出すことも聞いたことがあります。しかし、なぜそれを行うのですか?

誰かがこれをより詳細に説明できますか?


これは一つの例で使用するために興味がある可能性がありますどのように適切にサブクラスのdictとオーバーライドのGetItemSetItem関数
roganjosh

4
__getitem__例での使用はあまり意味がありませんが、を使用する既存のコードで動作する必要があるカスタムのリストまたは辞書のようなクラスを作成する必要があると想像してください[]。それ__getitem__は便利な状況です。
Pieter Witvoet

回答:


157

Cong Maは何__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) )

ただし、Buildingクラスの使用方法を「より良く」するために__getitem__(およびその対応物__setitem__)を使用することもできます。

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__このように使用するかどうかは、データをどのように抽象化するかによって異なります。この場合、建物を床のコンテナーとして扱うことにしました(また、建物のイテレーターを実装することもできます。 -つまり、一度に複数のフロアのデータを取得します-それは必要なものによって異なります。


15
答えを何度か読んだ後で初めて学んだことを共有します。一度getitem取得したら、その関数を明示的に呼び出す必要はありません。彼がbuilding1[2]それを呼び出すと、それ自体が内部的にgetitemを呼び出します。したがって、@ tony-suffolk-66のポイントは、クラスのすべてのプロパティ/変数は、実行時にobjectname [variablename]を呼び出すだけで取得できるということです。最初ははっきりしなかったのでこれを明確にし、誰かに役立つことを願ってここに書きます。冗長な場合は削除してください
mithunpaul

3
@mithunpaulオブジェクトの[インデックス]表記は、クラスのプロパティ/変数/属性を取得するために使用されません。たとえば、コンテナオブジェクトのインデックスです。たとえば、親が子のリストを保持している親から子オブジェクトを取得します。私の例では、Buildingクラスはコンテナー(この場合はFloor名)ですが、Floorクラスのコンテナークラスにすることもできます。
トニーサフォーク66

それをサポートしないことを除いてlen()、あなたは次のようになりますTypeErrorTypeError: object of type 'Building' has no len()
Ciasto piekarz

len(および反復などの他の機能)のサポートは、私の例の目的ではありませんでした。ただし、dunder_lenメソッドの実装は簡単です。
トニーサフォーク66

@ TonySuffolk66:____getitem____がループする例の____len____がインデックス(フロア)のイテラブルを決定することは正しいですか?
アレックス・

73

[]キーまたはインデックスでアイテムを取得するための構文は、単なる構文糖衣です。

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にリストされています


8

マジックメソッド__getitem__は基本的に、リストアイテム、ディクショナリエントリ、配列要素などにアクセスするために使用されます。インスタンス属性のクイックルックアップに非常に役立ちます。

ここでは、 'name'、 'age'、および 'dob'(生年月日)によってインスタンス化できるクラスPersonの例でこれを示しています。この__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

1つのユーザー入力が次のようであるとします。

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'

素晴らしい例!initに複数のパラメーターがある場合にgetitemを実装する方法についていろいろと検索していましたが、適切な実装を見つけるのに苦労していましたが、ついにこれを見つけました!賛成とありがとう!
Rahul P
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.