Bỏ qua đến nội dung chính
Mục lục

Dunder methods và Python data model (magic method)

AIDev Team · duyệt: Nguyễn Việt Chung

Bài 12/17 · Chương 15

OOP nâng cao

  • 8 phút
  • Trung cấp
  • Python 3.14
  • Cập nhật

Magic method trong Python, còn gọi là dunder method vì tên có hai gạch dưới ở hai đầu như __len__, là phương thức mà Python tự gọi khi bạn dùng len(), +, in, for hay with với một object. Bộ quy tắc nối mỗi cú pháp với một phương thức như vậy là Python data model: viết đúng phương thức thì giỏ hàng tự viết của bạn dùng được ngoặc vuông và câu lệnh if như một dict có sẵn.

Cần biết trước: nạp chồng toán tử, iterator và next() và kiểu bất biến.

Python data model và bảng dunder methods

Bài nạp chồng toán tử đã cho thấy len(x) dẫn tới __len__. Chính xác hơn, Python tìm phương thức đó trên class của object, không trên bản thân object:

python
class GioHang:
    def __init__(self, cac_mon):
        self.cac_mon = list(cac_mon)
    def __len__(self):
        return len(self.cac_mon)

gio = GioHang(["trà đào", "bạc xỉu"])
print(len(gio), gio.__len__(), GioHang.__len__(gio))
gio.__len__ = lambda: 99
print(len(gio), gio.__len__())

KẾT QUẢ

2 2 2
2 99

len(gio) làm đúng việc của GioHang.__len__(gio). Gán một hàm vào gio.__len__ chỉ thêm một thuộc tính cho object, nên gọi thẳng gio.__len__() ra 99, còn len(gio) vẫn hỏi class và ra 2. Data model là bản hợp đồng giữa cú pháp và class: muốn đổi cách một phép toán chạy, bạn sửa class.

Nhóm việc

Bạn viết

Python gọi

Bài

In ra

str(x), repr(x)

__str__, __repr__

str và repr

So sánh

x == y, x < y

__eq__, __lt__

so sánh object

Toán tử, gọi như hàm

x + y, x(…)

__add__, __call__

nạp chồng toán tử

Kích thước, có mặt

len(x), y in x

__len__, __contains__

nạp chồng toán tử

Đúng hay sai

if x:, bool(x)

__bool__, nếu không có thì __len__

bài này

Ngoặc vuông

x[k], x[k] = v

__getitem__, __setitem__

bài này

Lặp

for m in x:

__iter__, __next__

iterator và next()

Khối with

with x:

__enter__, __exit__

context manager

Khóa dict, phần tử set

{x: 1}, {x}

__hash__ (cùng __eq__)

bài này

Đúng hay sai của object: __bool__()

if don: hỏi object có "đúng" không. Python gọi __bool__ của class; class không có __bool__ thì Python dùng __len__ và coi độ dài 0 là sai. Không có cả hai thì object luôn đúng:

python
class DonHang:
    def __init__(self, ma, cac_mon):
        self.ma, self.cac_mon = ma, cac_mon
    def __len__(self):
        return len(self.cac_mon)
class MaGiamGia:
    def __init__(self, ma, con_han):
        self.ma, self.con_han = ma, con_han
    def __bool__(self):
        return self.con_han
rong = DonHang("DH1024", [])
co_mon = DonHang("DH1025", ["trà đào"])
print(bool(rong), bool(co_mon))
ma = MaGiamGia("MA-MAU-01", False)
print("Áp mã" if ma else "Mã hết hạn")

KẾT QUẢ

False True
Mã hết hạn

Đơn rỗng là sai nhờ __len__ trả về 0, dù DonHang không có __bool__. Mã giảm giá thì tự nói mình đúng hay sai qua __bool__. __bool__ phải trả về đúng True hoặc False: trả về số 1 thì bool() dừng với TypeError. Đổi MaGiamGia("MA-MAU-01", False) thành MaGiamGia("MA-MAU-01", True) rồi chạy lại: dòng thứ hai in Áp mã.

Ngoặc vuông: __getitem__() và __setitem__()

Bảng giá của quán cần tra theo tên món mà không phân biệt hoa thường hay khoảng trắng thừa. Hai phương thức nối ngoặc vuông vào class: bang[k] gọi __getitem__(k), còn bang[k] = v gọi __setitem__(k, v):

python
class BangGia:
    def __init__(self):
        self._gia = {}
    def __setitem__(self, ten, gia):
        self._gia[ten.strip().lower()] = gia
    def __getitem__(self, ten):
        return self._gia[ten.strip().lower()]

bang = BangGia()
bang["Trà Đào"] = 35000
bang[" bạc xỉu "] = 32000
print(bang["trà đào"], bang["BẠC XỈU"])
print(bang._gia)

KẾT QUẢ

35000 32000
{'trà đào': 35000, 'bạc xỉu': 32000}

Cả hai phương thức chuẩn hóa tên theo cùng một cách, nên ghi "Trà Đào" rồi đọc "trà đào" vẫn ra một giá. Thứ nằm trong ngoặc vuông được chuyển nguyên vào tham số, là chuỗi, số hay tuple đều được. Đọc một món chưa có thì self._gia[…] báo KeyError như dict thường. Đổi bang[" bạc xỉu "] = 32000 thành bang["Bạc Xỉu"] = 29000 rồi chạy lại: dòng đầu in 35000 29000.

So bằng và làm khóa: __eq__() và __hash__()

Set và khóa dict dùng hai phương thức: __hash__ cho ra một số nguyên để tìm nhanh, rồi __eq__ xác nhận hai object bằng nhau. Hai sản phẩm cùng mã là một, nên cả hai phương thức chỉ dựa vào mã:

python
class SanPham:
    def __init__(self, ma, ten):
        self.ma, self.ten = ma, ten
    def __eq__(self, khac):
        if not isinstance(khac, SanPham):
            return NotImplemented
        return self.ma == khac.ma
    def __hash__(self):
        return hash(self.ma)

kho = {SanPham("SP01", "Trà đào")}
kho.add(SanPham("SP01", "Trà đào túi lọc"))
print(len(kho))
print(SanPham("SP01", "?") in kho, SanPham("SP02", "?") in kho)

KẾT QUẢ

1
True False

Hàm hash() tính số đó cho giá trị bất biến như chuỗi mã, và bài bảng băm giải thích nó dùng để làm gì. Luật phải giữ: hai object bằng nhau theo __eq__ thì __hash__ trả về cùng một số. Vì vậy __hash__ chỉ dùng các thuộc tính mà __eq__ dùng, và các thuộc tính đó không được đổi sau khi tạo object.

Lỗi trên còn có thông báo. Lỗi kế tiếp thì không.

Kiểm tra nhanh

  1. Trong ví dụ giỏ hàng ở mục đầu, sau dòng gio.__len__ = lambda: 99, len(gio) trả về gì?

    • 2
    • 99
    • Báo lỗi TypeError
  2. Class DonHang có __len__ mà không có __bool__. Với một đơn chưa có món nào, if don: chạy nhánh nào?

    • Nhánh if, vì object luôn đúng
    • Nhánh else, vì __len__ trả về 0
    • Không nhánh nào, Python báo lỗi vì thiếu __bool__
  3. Những câu nào đúng về __eq__ và __hash__?

    • Class viết __eq__ mà không viết __hash__ thì object không bỏ vào set được
    • __hash__ nên tính từ mọi thuộc tính, kể cả thuộc tính sẽ đổi
    • Hai object bằng nhau theo __eq__ phải có cùng giá trị __hash__
    • Viết __hash__ là đủ để == so theo nội dung
  4. Class BangGia chỉ có __getitem__. Dòng bang["trà đào"] = 35000 cho kết quả gì?

    • Python tự thêm khóa "trà đào" vào bảng
    • Báo lỗi KeyError
    • Báo lỗi TypeError, vì class không có __setitem__
Đúng hết lần đầu +15 XP

Bài tập

Cho giỏ hàng dùng được ngoặc vuông và if

Giỏ hàng lưu số lượng từng món trong dict self._sl. Tên món được chuẩn hóa bằng ten.strip().lower() trước khi ghi hay đọc. Viết thân ba phương thức:

  • __setitem__(self, ten, so_luong): gio[ten] = so_luong đặt số lượng của món (ghi đè số cũ). Số lượng 0 thì bỏ món khỏi giỏ.

  • __getitem__(self, ten): gio[ten] cho số lượng của món, món chưa có thì 0.

  • __bool__(self): giỏ đúng khi có ít nhất một món.

Trả về: __getitem__ một int, __bool__ một bool.

python
class GioHang:
    def __init__(self):
        self._sl = {}
    def __setitem__(self, ten, so_luong):
        pass  # Viết thân các phương thức thay cho các dòng pass
    def __getitem__(self, ten):
        pass
    def __bool__(self):
        pass

Tóm tắt

  • Python data model nối cú pháp với phương thức dunder: len(x) chạy type(x).__len__(x), Python tìm trên class.

  • if x: và bool(x) gọi __bool__, thiếu thì dùng __len__; __bool__ phải trả về True hoặc False.

  • x[k] gọi __getitem__(k), x[k] = v gọi __setitem__(k, v): hai phương thức riêng.

  • Viết __eq__ thì object mất __hash__ mặc định, không vào set hay làm khóa dict được.

  • __hash__ dùng đúng các thuộc tính __eq__ so và các thuộc tính đó không đổi.

Câu hỏi thường gặp

Dunder method khác phương thức thường ở điểm nào?

Về cách viết thì giống hệt: cùng def, cùng self. Khác ở chỗ Python tự gọi chúng khi gặp một cú pháp, như len() gọi __len__. Bạn ít khi gọi thẳng x.__len__(); viết len(x) cho dễ đọc và để Python tìm đúng phương thức trên class.

Ngoài bảng trên, data model của Python còn những nhóm phương thức nào?

Còn nhiều nhóm: các toán tử khác như __sub__, __mul__, phép so sánh __le__, __gt__, cách đọc thuộc tính __getattr__. Tài liệu "Data model" của Python liệt kê đủ. Phép + và các toán tử thuộc bài nạp chồng toán tử.

Có nên tự đặt tên phương thức dạng __ten__ không?

Không nên. Tên có hai gạch dưới ở hai đầu được dành cho Python, và một bản Python sau có thể dùng đúng tên bạn chọn. Phương thức riêng của class thì đặt tên thường, hoặc một gạch dưới đầu cho chi tiết nội bộ như bài đóng gói dạy.

Object có __getitem__ thì lặp bằng for được không?

Được, với kiểu cũ: không có __iter__ thì for gọi __getitem__(0), __getitem__(1) và tăng dần chỉ số cho tới khi gặp IndexError. Cách đó hợp với class giống list. Class giống dict như BangGia nên viết __iter__, như bài iterator và next() dạy.

Chủ đề

magic method python

Bài này có hữu ích?

Hỏi đáp

Đang tải câu hỏi…

Tham vấn chuyên môn

Nguyễn Việt Chung

Nhà sáng lập AIDev và VietPlatform · Thạc sĩ AI MSE

  • Tốt nghiệp thủ khoa xuất sắc Thạc sĩ AI MSE.
  • Đồng sáng lập, CTO E-University, SVOnline: số hóa 10+ đại học, 40.000+ sinh viên.
  • Xây hệ thống AI cho doanh nghiệp tại VietPlatform.
Biên soạn: AIDev Team · Rà soát · Quy trình biên tập