بتل کد Battle Codeدارد باز می‌شود…

جلسه‌ی 28: متدهای ویژه (dunder) Special Methods

با متدهای ویژه (dunder methods) اشیای خودمان را با سازوکارهای داخلی پایتون یکپارچه می‌کنیم: چاپ، مقایسه، مرتب‌سازی، len، عملگرها و پیمایش.

در این جلسه یاد می‌گیری

درس

print(obj) و str(obj) سراغ __str__ می‌روند (نمایش خوانا برای کاربر). repr(obj)، کنسول و نمایش اشیا داخل لیست از __repr__ استفاده می‌کنند (نمایش دقیق برای توسعه‌دهنده، ترجیحاً شبیه کدی که شیء را می‌سازد). اگر فقط یکی را می‌نویسید، __repr__ را بنویسید.

class Point:
    def __init__(self, x, y):
        self.x, self.y = x, y

    def __repr__(self):
        return f"Point(x={self.x}, y={self.y})"

    def __str__(self):
        return f"({self.x}, {self.y})"

p = Point(1, 2)
print(p, [p])

بدون __eq__، عملگر == فقط هویت را می‌سنجد. با تعریف آن برابری بر اساس مقدار می‌شود. اگر نوع دیگر پشتیبانی نمی‌شود NotImplemented برگردانید. توجه: تعریف __eq__ به‌طور پیش‌فرض __hash__ را حذف می‌کند و شیء دیگر کلید dict نمی‌شود، مگر __hash__ را هم بنویسید.

class Money:
    def __init__(self, amount, currency):
        self.amount, self.currency = amount, currency

    def __eq__(self, other):
        if not isinstance(other, Money):
            return NotImplemented
        return (self.amount, self.currency) == (other.amount, other.currency)

print(Money(5, "USD") == Money(5, "USD"))

sorted و min/max فقط به __lt__ (عملگر <) نیاز دارند. مقایسه‌ی tupleها راهی کوتاه برای ترتیب چندکلیدی است. functools.total_ordering بقیه‌ی عملگرها (<=، >، >=) را از __eq__ و __lt__ می‌سازد.

class Task:
    def __init__(self, priority, title):
        self.priority, self.title = priority, title

    def __lt__(self, other):
        return (self.priority, self.title) < (other.priority, other.title)

tasks = [Task(2, "deploy"), Task(1, "test"), Task(2, "backup")]
print([t.title for t in sorted(tasks)])

__len__ به len(obj) پاسخ می‌دهد و (در نبود __bool__) درستی شیء را هم تعیین می‌کند: شیء با طول صفر در if نادرست است. __add__ عملگر + را تعریف می‌کند و باید شیء جدید برگرداند، نه اینکه خودش را تغییر دهد.

class Playlist:
    def __init__(self, songs):
        self.songs = list(songs)

    def __len__(self):
        return len(self.songs)

    def __add__(self, other):
        return Playlist(self.songs + other.songs)

mix = Playlist(["a", "b"]) + Playlist(["c"])
print(len(mix), bool(Playlist([])))

اگر __iter__ یک iterator برگرداند، شیء در for، list()، sum() و in قابل‌استفاده می‌شود. ساده‌ترین راه، واگذاری به مجموعه‌ی داخلی است: return iter(self._items). (ساخت iterator با yield را در فاز ۷ می‌بینیم.)

class Inventory:
    def __init__(self):
        self._items = []

    def add(self, name):
        self._items.append(name)

    def __iter__(self):
        return iter(self._items)

inv = Inventory()
inv.add("cable")
inv.add("router")
print(list(inv), "router" in inv)

مثال‌های این جلسه

چالش‌ها

  1. Money Display (آسان)
  2. Debug Representation (آسان)
  3. Playlist Length (آسان)
  4. Version Equality (متوسط)
  5. Sort Tasks (متوسط)
  6. Adding Money (متوسط)
  7. Iterable Inventory (متوسط)
  8. Fraction Arithmetic (سخت)
  9. Vector Operators (سخت)
  10. Ranked Students (سخت)
  11. Contains Check (متوسط)
  12. Interval Intersection (سخت)

بیشتر بخوان

← جلسه‌ی 27: وراثت و ترکیب جلسه‌ی 29: dataclass و کلاس‌های انتزاعی →