การทำความเข้าใจวิธี __getitem__


143

ฉันได้อ่านเอกสารส่วนใหญ่__getitem__ใน Python docs แล้ว แต่ฉันยังไม่สามารถเข้าใจความหมายของมันได้

ดังนั้นสิ่งที่ฉันเข้าใจก็__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__ภายใน แต่ทำไมมันถึงทำ?

ใครช่วยอธิบายรายละเอียดเพิ่มเติมได้ไหม


สิ่งนี้อาจเป็นที่สนใจสำหรับการใช้งานตัวอย่างหนึ่ง: How to อย่างถูกต้อง subclass dict และแทนที่getitem & setitem
roganjosh

4
__getitem__ใช้ในตัวอย่างของคุณไม่ได้ทำให้ความรู้สึกมาก แต่คิดว่าคุณต้องเขียน list- ที่กำหนดเองหรือพจนานุกรมเช่น class []ที่มีการทำงานที่มีรหัสที่มีอยู่ที่การใช้งาน นั่นเป็นสถานการณ์ที่__getitem__มีประโยชน์
Pieter Witvoet

คำตอบ:


160

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

อย่างไรก็ตามเราสามารถใช้__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 สัญกรณ์ object [index] ไม่ได้ใช้เพื่อรับคุณสมบัติ / ตัวแปร / แอ็ตทริบิวต์ของคลาส - มันกำลังจัดทำดัชนีบนอ็อบเจ็กต์คอนเทนเนอร์ - ตัวอย่างเช่นการดึงอ็อบเจ็กต์ลูกจากพาเรนต์โดยที่พาเรนต์เก็บรายชื่อของเด็กไว้ ในตัวอย่างของฉัน - คลาสอาคารเป็นคอนเทนเนอร์ (ในกรณีนี้คือชื่อชั้น) แต่อาจเป็นคลาสคอนเทนเนอร์สำหรับคลาสชั้นก็ได้
Tony Suffolk 66

ยกเว้นจะไม่รองรับlen()และคุณจะได้รับTypeError:TypeError: object of type 'Building' has no len()
Ciasto piekarz

การสนับสนุน len (และคุณสมบัติอื่น ๆ เช่นการวนซ้ำ ฯลฯ ) ไม่ใช่จุดประสงค์ของตัวอย่างของฉัน การใช้เมธอด dunder_len เป็นเรื่องเล็กน้อย
Tony Suffolk 66

@ TonySuffolk66: ถูกต้องหรือไม่ที่ ____len____ กำหนดค่าที่สามารถทำซ้ำได้สำหรับดัชนี (ชั้น) ในตัวอย่างของคุณที่ ____getitem____ ลูป?
Alex

74

[]ไวยากรณ์สำหรับการรับรายการโดยคีย์หรือดัชนีเป็นเพียงน้ำตาลไวยากรณ์

เมื่อคุณประเมินการ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' (วันเดือนปีเกิด) __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'

ตัวอย่างยอดเยี่ยม! ฉันกำลังค้นหาทั้งหมดเกี่ยวกับวิธีใช้getitemเมื่อมีพารามิเตอร์หลายตัวในinitและฉันกำลังดิ้นรนเพื่อค้นหาการใช้งานที่เหมาะสมและในที่สุดก็เห็นสิ่งนี้! โหวตแล้วขอบคุณ!
Rahul P
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.