__str__ và __repr__ trong Python: in object cho dễ đọc
Bài 6/17 · Chương 13
Lập trình hướng đối tượng
- 5 phút
- Cơ bản
- Python 3.14
- Cập nhật
Trong bài này · 10
__str__ và __repr__ trong Python là hai phương thức quyết định object hiện ra thế nào khi in. __str__ cho chuỗi dễ đọc với người dùng, còn __repr__ cho chuỗi rõ ràng với người viết code, thứ bạn cần khi gỡ lỗi. Không viết hai phương thức này thì print() một object chỉ cho ra tên class và một địa chỉ bộ nhớ.
Cần biết trước: __init__ và self, f-string và return.
Vì sao print() object khó đọc
Với class TaiKhoan của bài __init__ và self, print(tk) in ra dòng dạng <__main__.TaiKhoan object at 0x7f3a...>. Đó là tên class kèm địa chỉ của object trong bộ nhớ; địa chỉ đổi theo từng lần chạy và không cho biết chủ tài khoản là ai, số dư bao nhiêu. Python in như vậy vì nó chưa biết bạn muốn tài khoản hiện ra thế nào. Hai phương thức dưới đây nói cho Python biết.
__str__(): chuỗi cho người đọc
__str__(self) trả về một chuỗi. print(obj), str(obj) và f"{obj}" đều gọi nó:
class TaiKhoan:
def __init__(self, chu, so_du=0):
self.chu = chu
self.so_du = so_du
def __str__(self):
so = f"{self.so_du:,}".replace(",", ".")
return f"{self.chu}: {so} đ"
tk = TaiKhoan("Trần Thu Hà", 2000000)
print(tk)
print(f"Chủ: {tk}")KẾT QUẢ
Trần Thu Hà: 2.000.000 đ
Chủ: Trần Thu Hà: 2.000.000 đChuỗi trả về là thứ người dùng thấy trên hóa đơn hay màn hình, nên viết theo thói quen đọc của họ, như dấu chấm ngăn nghìn của bài định dạng tiền VND. Đổi 2000000 thành 150000 rồi chạy lại: dòng đầu in Trần Thu Hà: 150.000 đ.
__repr__(): chuỗi cho người viết code
__repr__(self) cũng trả về chuỗi, nhưng chuỗi đó nên trông như lệnh tạo lại object, để khi gỡ lỗi bạn thấy ngay giá trị và kiểu của từng thuộc tính. Hàm repr(x) gọi nó. Với chuỗi, repr() thêm dấu nháy; trong f-string, viết !r sau tên là lấy repr() của giá trị:
class TaiKhoan:
def __init__(self, chu, so_du=0):
self.chu = chu
self.so_du = so_du
def __repr__(self):
return f"TaiKhoan({self.chu!r}, {self.so_du!r})"
tk = TaiKhoan("Trần Thu Hà", 2000000)
print(repr(tk))
print([tk, TaiKhoan("Lê Minh Tâm")])
print(tk, repr("Lan"), repr(2000000))KẾT QUẢ
TaiKhoan('Trần Thu Hà', 2000000)
[TaiKhoan('Trần Thu Hà', 2000000), TaiKhoan('Lê Minh Tâm', 0)]
TaiKhoan('Trần Thu Hà', 2000000) 'Lan' 2000000Khi in một list, Python gọi __repr__ của từng phần tử, kể cả khi class có __str__. Class chỉ có __repr__ thì print(tk) cũng dùng nó, như dòng cuối. Vì vậy, nếu chỉ viết một phương thức, hãy viết __repr__; thêm __str__ khi người dùng cần một dạng khác. Hai dạng giống ảnh hồ sơ và ảnh đời thường: một bản đầy đủ để đối chiếu, một bản dễ nhìn để khoe.
Kiểm tra nhanh
Class có
__str__trả về"Lan: 0 đ".print(tk)in ra gì?Lan: 0 đ'Lan: 0 đ'<__main__.TaiKhoan object at 0x...>
__str__viếtprint(self.chu)thay choreturn.print(tk)dẫn tới gì?- In tên chủ một lần, không lỗi
- In tên chủ rồi báo lỗi
TypeError - Báo lỗi
AttributeError
f"{'Lan'!r}"trả về gì?"Lan""!rLan""'Lan'"
Class chỉ có
__str__, không có__repr__. Khiprint([tk]), Python gọi gì cho phần tử?__str__của phần tử__repr__mặc định, in tên class và địa chỉ- Báo lỗi
TypeError
Bài tập
__repr__ cho giao dịch
Class GiaoDich có ba thuộc tính loai, so_tien, ghi_chu. Viết thân phương thức __repr__(self) trả về chuỗi dạng gọi class, giá trị lấy theo repr(), cách nhau bởi dấu phẩy và một dấu cách. Ví dụ: GiaoDich("chi", 45000, "Cà phê").__repr__() trả về GiaoDich('chi', 45000, 'Cà phê').
Trả về: chuỗi tạo lại giao dịch, một str.
class GiaoDich:
def __init__(self, loai, so_tien, ghi_chu=""):
self.loai = loai
self.so_tien = so_tien
self.ghi_chu = ghi_chu
def __repr__(self):
pass # Viết thân hàm thay cho dòng nàyTóm tắt
print(obj)không có__str__hay__repr__chỉ in tên class và địa chỉ bộ nhớ.__str__trả về chuỗi cho người đọc;print(),str()và f-string gọi nó.__repr__trả về chuỗi cho người viết code, nên trông như lệnh tạo lại object;repr()và khi in list gọi nó.Class chỉ có
__repr__thìprint()cũng dùng__repr__.Dùng
!rtrong f-string để giá trị chuỗi giữ dấu nháy; cả hai phương thức phảireturnmột chuỗi.
Câu hỏi thường gặp
Hàm str() và repr() khác nhau thế nào?
str() cho dạng dễ đọc với người dùng, repr() cho dạng rõ ràng với người viết code. Với chuỗi "Lan", str() cho Lan còn repr() cho 'Lan', nên nhìn là biết đó là chuỗi. Với số nguyên, hai hàm cho cùng kết quả.
Hàm repr Python dùng vào việc gì?
Chủ yếu để gỡ lỗi: print(repr(x)) cho thấy cả kiểu của giá trị, như dấu nháy của chuỗi hay khoảng trắng thừa ở cuối, thứ print(x) giấu đi. Trong f-string, {x!r} làm cùng việc; cú pháp f-string có ở bài f-string.
Có cách nào khỏi viết __repr__ bằng tay không?
Có. @dataclass tự sinh __init__ và __repr__ từ danh sách thuộc tính, như bài dataclass trình bày. Bài này viết tay để bạn hiểu Python gọi gì và khi nào.
Chủ đề
Bài này có hữu ích?
Hỏi đáp
Tham vấn chuyên môn
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.