Decorator có tham số và functools.wraps trong Python
Bài 2/6 · Chương 14
Decorator, iterator và generator
- 8 phút
- Trung cấp
- Python 3.14
- Cập nhật
Trong bài này · 11
Decorator có tham số trong Python là một hàm nhận cấu hình, như nhãn của nhật ký hay mức phụ thu, rồi trả về một decorator, viết @ghi_nhat_ky("Quầy 1") trên dòng def. Bạn cần nó khi cùng một việc bọc dùng cho nhiều hàm nhưng mỗi hàm một cấu hình, và đi kèm functools.wraps để hàm bọc vẫn mang tên, docstring của hàm gốc.
Cần biết trước: decorator, docstring và import.
Giữ tên và docstring bằng functools.wraps
Sau khi bọc, tên hàm trỏ tới hàm bọc, nên help() và __doc__ nói về hàm bọc thay cho hàm bạn viết. Module functools của thư viện chuẩn (bài functools giới thiệu các hàm khác của nó) có wraps, một decorator đặt ngay trên hàm bọc để chép các thông tin đó từ hàm gốc sang:
from functools import wraps
def ghi_nhat_ky(ham):
@wraps(ham)
def ham_boc(*args, **kwargs):
print("Gọi", ham.__name__, args)
return ham(*args, **kwargs)
return ham_boc
@ghi_nhat_ky
def tinh_tien(gia, so_ly=1):
"""Tính tiền một món: giá nhân số ly."""
return gia * so_ly
print(tinh_tien.__name__)
print(tinh_tien.__doc__)
print(tinh_tien.__wrapped__(29000, 2))KẾT QUẢ
tinh_tien
Tính tiền một món: giá nhân số ly.
58000@wraps(ham) chép __name__, __doc__ và vài thuộc tính khác của ham sang ham_boc, rồi gắn thêm __wrapped__ trỏ tới chính hàm gốc. Dòng cuối gọi hàm gốc qua __wrapped__, nên không có dòng nhật ký nào. wraps tự nó là một decorator có tham số: wraps(ham) trả về thứ bọc lấy ham_boc. Đổi @wraps(ham) thành # @wraps(ham) rồi chạy lại: dòng đầu in ham_boc thay cho tinh_tien, và dòng cuối báo lỗi vì không còn __wrapped__.
Decorator nhận tham số: ba tầng hàm
Hai quầy của quán dùng chung decorator ghi nhật ký, nhưng mỗi dòng nhật ký phải ghi tên quầy. Tên quầy là cấu hình, nên cần thêm một tầng hàm ngoài cùng nhận nó:
from functools import wraps
def ghi_nhat_ky(nhan):
def trang_tri(ham):
@wraps(ham)
def ham_boc(*args):
ket_qua = ham(*args)
print(f"[{nhan}] {ham.__name__}{args} = {ket_qua}")
return ket_qua
return ham_boc
return trang_tri
@ghi_nhat_ky("Quầy 1")
def tinh_tien(gia, so_ly=1):
return gia * so_ly
tinh_tien(29000, 2)KẾT QUẢ
[Quầy 1] tinh_tien(29000, 2) = 58000Ba tầng làm ba việc: ghi_nhat_ky(nhan) nhận cấu hình và trả về trang_tri, trang_tri(ham) là decorator thật nhận hàm gốc, còn ham_boc chạy ở mỗi lần gọi. Dòng @ghi_nhat_ky("Quầy 1") làm việc của tinh_tien = ghi_nhat_ky("Quầy 1")(tinh_tien): Python gọi tầng ngoài với "Quầy 1" trước, rồi đưa hàm cho thứ nó trả về. Cả hai tầng trong là closure, nên ham_boc vẫn đọc được nhan lúc chạy. Hình dung tầng ngoài như máy in nhãn: bạn đặt chữ, nó in ra một con dấu, rồi con dấu mới đóng lên hàm. Đổi "Quầy 1" thành "Quầy 2" rồi chạy lại: kết quả in ra [Quầy 2] tinh_tien(29000, 2) = 58000.
Chồng nhiều decorator lên một hàm
Một hàm được mang nhiều dòng @. Python bọc từ dòng gần def nhất ra ngoài: @ngoai rồi @trong trên def f làm việc của f = ngoai(trong(f)). Khi gọi, lớp ngoài cùng chạy trước, như bóc một củ hành:
def ghi_nhat_ky(nhan):
def trang_tri(ham):
def ham_boc(*args):
print(f"[{nhan}] vào")
ket_qua = ham(*args)
print(f"[{nhan}] ra")
return ket_qua
return ham_boc
return trang_tri
@ghi_nhat_ky("ngoài")
@ghi_nhat_ky("trong")
def tinh_tien(gia, so_ly):
return gia * so_ly
print(tinh_tien(32000, 2))KẾT QUẢ
[ngoài] vào
[trong] vào
[trong] ra
[ngoài] ra
64000ghi_nhat_ky("trong") bọc tinh_tien trước, rồi ghi_nhat_ky("ngoài") bọc hàm vừa bọc xong. Lời gọi đi vào lớp ngoài, qua lớp trong, tới hàm gốc, rồi trả kết quả ra theo chiều ngược lại. Ví dụ này bỏ @wraps cho ngắn. Với decorator chỉ ghi nhật ký, thứ tự chỉ đổi thứ tự dòng in, nhưng với decorator sửa kết quả thì thứ tự đổi cả con số.
Kiểm tra nhanh
Với
def a(f): return lambda x: f(x) + 1,def b(f): return lambda x: f(x) * 2,def g(x): return xvàg = a(b(g)), lệnhprint(g(5))in ra gì?12711
Trong ví dụ quầy, nếu viết
@ghi_nhat_kykhông có("Quầy 1")thì dòngtinh_tien(29000, 2)cho kết quả nào?- In
[Quầy 1] tinh_tien(29000, 2) = 58000như cũ - Python báo
TypeError, vìtinh_tienlúc đó làtrang_tri, hàm chỉ nhận một đối số - In
58000mà không có nhãn
- In
Những điều nào đúng sau khi đặt
@wraps(ham)trên hàm bọc?tinh_tien.__name__là"tinh_tien"tinh_tien.__wrapped__là hàm gốc chưa bọc- Hàm bọc không chạy nữa, lời gọi đi thẳng vào hàm gốc
help(tinh_tien)in docstring của hàm gốc
Điền tên hàm của module
functoolsđặt trên hàm bọc để giữ tên và docstring của hàm gốc:@functools.____(ham)
Bài tập
Viết decorator phụ thu theo mức
Mỗi dịp lễ, quán cộng một mức phụ thu khác nhau. Viết thân decorator có tham số phu_thu(phan_tram): nó trả về một decorator, decorator đó trả về hàm bọc nhận mọi đối số (*args, **kwargs), gọi hàm gốc rồi trả về tien + tien * phan_tram // 100, với tien là kết quả của hàm gốc. Dùng functools.wraps để hàm bọc giữ tên, docstring, các thuộc tính riêng gắn trên hàm gốc và __wrapped__.
Ví dụ: với @phu_thu(10) trên def tinh_tien(don_gia, so_ly=1), lời gọi tinh_tien(29000) trả về 31900. Hai dòng @phu_thu(10) trên @phu_thu(20) biến 10000 thành 13200.
Trả về: decorator; hàm bọc nó tạo ra trả về số tiền đã cộng phụ thu, một int.
from functools import wraps
def phu_thu(phan_tram):
pass # Viết thân hàm thay cho dòng nàyTóm tắt
Decorator có tham số có ba tầng: hàm nhận cấu hình, decorator nhận hàm gốc, hàm bọc chạy mỗi lần gọi.
@ten(cau_hinh)làm việc củaham = ten(cau_hinh)(ham); thiếu cặp ngoặc thì tầng giữa thế chỗ hàm.@wraps(ham)trên hàm bọc chép__name__,__doc__của hàm gốc và gắn__wrapped__trỏ tới nó.Không có
wraps,help()mô tả hàm bọc và docstring của hàm gốc biến mất.Nhiều dòng
@bọc từ dòng gầndefnhất ra ngoài; lúc gọi, lớp ngoài cùng chạy trước.Decorator sửa kết quả thì thứ tự chồng đổi cả con số.
Câu hỏi thường gặp
Tài liệu tiếng Anh viết decorator with arguments, trong Python đó là gì?
Đó chính là decorator có tham số của bài này: một hàm nhận cấu hình rồi trả về decorator thật. Bạn nhận ra nó ở dòng @ có cặp ngoặc chứa giá trị, như @ghi_nhat_ky("Quầy 1"). Decorator không có tham số, kiểu @ghi_nhat_ky của bài decorator, chỉ có hai tầng.
Không dùng functools.wraps thì có sao không?
Code vẫn tính đúng, nhưng thứ gì đọc thông tin của hàm cũng thấy hàm bọc: help() in tên ham_boc, docstring mất, và một decorator khác bọc bên ngoài mà ghi ham.__name__ vào nhật ký sẽ ghi ham_boc. Chỉ cần một dòng @wraps(ham), nên decorator trong thư viện thường có nó. Cách viết docstring cho help() đọc nằm ở bài docstring.
Tham số của wraps trong Python là gì, sao phải viết wraps(ham)?
Tham số là hàm gốc, thứ mà wraps lấy tên và docstring để chép sang. wraps cũng là một decorator có tham số: wraps(ham) tạo ra decorator, và decorator đó bọc lấy ham_boc. Viết @wraps không ngoặc thì wraps nhận nhầm ham_boc làm hàm gốc, và lời gọi hàm đã bọc báo lỗi, vì tinh_tien lúc đó là một functools.partial.
Có cách nào cho decorator dùng được cả có ngoặc và không ngoặc không?
Có, bằng cách kiểm tra đối số đầu tiên là hàm hay cấu hình, nhưng cách đó làm code khó đọc. Cách thường gặp hơn là luôn viết ngoặc, @ghi_nhat_ky(), và cho tầng ngoài một tham số mặc định như cách của bài tham số mặc định.
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.