Bất kỳ ứng dụng sản xuất nào cũng có thể có một số hướng dẫn về cách thức và những gì cần được đăng nhập vào ứng dụng của bạn. Thông thường, những hướng dẫn này bắt nguồn từ các mẫu phổ biến trong ngành, chẳng hạn như “ghi nhật ký tất cả các trường hợp ngoại lệ”. Tuy nhiên, việc triển khai các hướng dẫn này được dành cho từng nhà phát triển và dẫn đến cùng một tập hợp các câu lệnh ghi nhật ký được lặp lại trong toàn bộ cơ sở mã. Chẳng hạn, để ghi nhật ký tất cả các ngoại lệ, bạn sẽ có một câu lệnh ghi nhật ký trong mỗi khối
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Một cách tiếp cận để giảm bớt vấn đề này là sử dụng tính năng trang trí của Python. Bài viết này sẽ cung cấp một cái nhìn tổng quan ngắn gọn về các bộ trang trí và trình bày cách tạo một bộ trang trí để trừu tượng hóa các câu lệnh ghi nhật ký phổ biến này. Bạn có thể đọc thêm về các công cụ trang trí và nhiều cách chúng có thể được sử dụng trong Tài liệu cơ bản tuyệt vời này về Công cụ trang trí Python
trang trí là gì
Trình trang trí là một chức năng nhận một chức năng khác và mở rộng hành vi của nó mà không sửa đổi nó một cách rõ ràng. Chúng còn được gọi là hàm bậc cao
Các chức năng của Python là công dân hạng nhất. Điều này có nghĩa là các hàm có thể được truyền dưới dạng đối số hoặc có thể là đối tượng của phép gán. Vì vậy, nếu bạn có một hàm
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
def sum[a, b=10]:
return a+b
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Vì các chức năng hoạt động giống như một đối tượng, bạn có thể gán
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Mẫu này phổ biến đến mức Python có một đường cú pháp để trang trí một chức năng. Vì vậy, thay vì
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Trình trang trí nhật ký
Chúng ta sẽ tạo một trình trang trí xử lý hai tình huống ghi nhật ký phổ biến - ghi nhật ký ngoại lệ dưới dạng LỖI và đối số phương thức ghi nhật ký dưới dạng nhật ký GỠ LỖI
Hãy bắt đầu bằng cách nắm bắt các ngoại lệ và ghi nhật ký bằng thư viện python
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Ngoài việc thiết lập
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Vì hàm
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Chúng tôi ghi nhật ký các tham số ở mức GỠ LỖI vì chúng tôi không muốn nhật ký của mình lộn xộn với tất cả các đối số chức năng. Ghi nhật ký gỡ lỗi có thể được bật trên hệ thống của chúng tôi khi cần thiết. Hãy nhớ rằng điều này sẽ ghi tất cả các giá trị đối số vào nhật ký bao gồm mọi dữ liệu PII hoặc bí mật
Trình trang trí ghi nhật ký cơ bản này có vẻ tốt và đã thực hiện những gì chúng tôi đặt ra ban đầu để đạt được. Miễn là một phương thức được trang trí bằng trình trang trí
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Tuy nhiên, trong một dự án thực tế, bản thân
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
Để bắt chước kịch bản này, chúng ta sẽ bắt đầu với việc có một lớp tạo bộ ghi nhật ký cho chúng ta. Bây giờ chúng ta sẽ tạo bộ ghi cơ bản nhưng bạn có thể tưởng tượng lớp cấu hình hành vi của bộ ghi theo yêu cầu
def sum[a, b=10]:
return a+b
Vì tại thời điểm viết trình trang trí, chúng tôi không biết liệu chức năng cơ bản sẽ chuyển cho chúng tôi
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Đoạn mã trên trông khá đáng sợ nhưng hãy để tôi tóm tắt nó. Trình trang trí
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Không có logger nào được thông qua. Đây là kịch bản tương tự những gì chúng tôi đã làm cho đến trước đó. Trình trang trí được sử dụng đơn giản như câu lệnh
01 ở đầu hàm. Trong trường hợp này, decorator lấy một logger bằng cách gọi phương thức>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
45 và sử dụng nó cho phần còn lại của phương thức>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
41 được thông qua. Trình trang trí>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
01 của chúng tôi hiện có thể chấp nhận phiên bản của>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
41 làm đối số. Sau đó, nó có thể gọi phương thức>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
49 để tạo bộ ghi nhật ký lồng nhau và sử dụng phần còn lại của nó>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
42 được thông qua. Trong trường hợp thứ ba này, chúng ta có thể chuyển chính bộ ghi nhật ký thay vì chuyển lớp>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
41>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Chúng tôi vẫn chưa hoàn thành. Ngay cả ở dạng hiện tại, trình trang trí nhật ký của chúng tôi bị hạn chế. Một hạn chế là chúng ta phải có sẵn
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Nhưng nếu hàm là một phần của lớp thì
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
Vì vậy, mục tiêu của chúng tôi là nắm bắt
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
Để làm điều này, chúng tôi sẽ lặp lại đối số
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
def my_decorator[func]:
def wrapper[*args, **kwargs]:
# do something before `sum`
result = func[*args, **kwargs]
# do something after `sum`
return result
return wrapper
sum = my_decorator[sum]
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Trình trang trí ở trên đủ chung để hoạt động cho 2 kịch bản khác ngoài 3 kịch bản mà chúng ta đã thảo luận trước đây -
7 hoặcdef my_decorator[func]: def wrapper[*args, **kwargs]: # do something before `sum` result = func[*args, **kwargs] # do something after `sum` return result return wrapper sum = my_decorator[sum]
41 được chuyển sang phương thức trang trí>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
7 hoặcdef my_decorator[func]: def wrapper[*args, **kwargs]: # do something before `sum` result = func[*args, **kwargs] # do something after `sum` return result return wrapper sum = my_decorator[sum]
41 được truyền cho phương thức lớp>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
64 lưu trữ chức năng được trang trí>>> sum >>> sum.__code__.co_varnames # Names of local variables ['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Một điều bổ sung mà chúng tôi đã làm là bọc tất cả mã trước khi gọi hàm được trang trí
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
>>> sum
>>> sum.__code__.co_varnames # Names of local variables
['a', 'b']
Trình trang trí ở trên là một điểm khởi đầu tốt và có thể được mở rộng hoặc đơn giản hóa theo yêu cầu. Nó làm giảm khả năng bỏ lỡ việc ghi nhật ký ngoại lệ và chuẩn hóa các thông báo lỗi trên toàn ứng dụng