Hướng dẫn log in python
Mình thấy bài này khá hay và hữu ích nên share lại từ bài gốc của tác giả dangsonbk. Bạn có thể đọc thêm series Python cơ bản thường sử dụng trong công việc của tác giả Võ Duy Tuấn nữa nhé, rất hữu ích! Show Sử dụng logging trong PythonThói quen của mình và có lẽ cũng là thói quen của nhiều người lúc mới học
Python cũng như khi viết những script nhỏ để lấy thông tin chương trình lúc runtime đó là sử dụng
Tuy nhiên khi chương trình lớn dần lên, một vấn đề khá đau đầu nảy sinh đó là thông tin được print ra khá điên loạn, không được phân loại, mất thời gian xác định cũng như giảm hiệu suất của chương trình. Hàm print mặc định sẽ xuất nội dung ra stdout và nội dung log in ra thường rất hay bị nhầm với dữ liệu khác. Giải pháp mình muốn giới thiệu trong bài viết này đó là sử dụng module logging. Đây là module tiêu chuẩn (được pack kèm bộ cài mặc định) do cộng đồng Python phát triển, dễ dàng sử dụng và cực kỳ linh hoạt. Logging cung cấp cho lập trình viên những tiện ích như: Phân chia level cho các thông báo lỗi, cho phép tuỳ chọn mức độ nghiêm trọng của các thông báo, cho phép hoặc không cho phép hiển thị một thông báo đã được phân loại. Cho phép cấu hình output của thông báo lỗi là trên console hoặc file hoặc nguồn khác Lập trình viên có thể chọn các mức sau khi viết nội dung log, các mức được liệt kê có độ nghiêm trọng lớn dần: Mức Nội dung
Sử dụng module logging cơ bảnVí dụ đơn giản nhất khi sử dụng logging:
Mặc định, mức thông báo sẽ được đặt ở mức
Bạn cũng có thể log ra file:
Nội dung được in ra sẽ tương tự khi bạn in ra console:
Cần chú ý là nội dung log mới sẽ ghi nối tiếp vào cùng 1 file với nội dung log cũ (lần chạy trước đó), trong trường hợp nội dung cũ không còn quan trọng nữa, có thể setup để logging luôn tạo log mới bằng cách chỉnh chế độ filemode khi config:
Log ra nhiều nguồn cùng lúcViệc sử dụng logger cơ bản chỉ cho phép chúng ta in log ra một nguồn tại một thời điểm, trong ví dụ trên, khi đặt
Đoạn code trên sẽ tạo file log và in nội dung log vào file đó tương tự như việc bổ xung config
Ngoài FileHandler và StreamHandler, logging còn hỗ trợ rất nhiều handles khác nữa. Chi tiết ở đây. In nội dung biếnĐể in nội dung biến, bạn chỉ cần đưa chuỗi format vào sau đó truyền các biến tương ứng với format trong đối số. Xem ví dụ sau để hiểu rõ hơn.
Chú ý là bạn không cần format chuỗi trước khi truyền vào hàm Format nội dung và thêm các thông tin chi tiết về logLogging cho phép thêm các thông tin chi tiết hơn về chương trình khi gọi log như: Vị trí gọi log (dòng code), tên module gọi log, file đang chạy ... Một config đầy đủ có thể như sau:
Thông tin in ra sẽ như sau:
Việc phân loại chi tiết như trên rất hữu ích khi bạn phải phân tích các file log dài, khi đó bạn có thể dùng các chương trình soạn thảo code để filter hoặc search các thông tin tương ứng một cách nhanh chóng. Logging trong exception (in thông tin Traceback)Việc ghi log ra khi có exception là rất cần thiết, tuy nhiên ghi log ra mà không có thông tin chi tiết về exception đó thì không có ý nghĩa lắm. Để bổ xung thông tin khi bắt được exception chúng ta chỉ cần thêm config exc_info=True
Thông tin in ra:
Bạn cũng có thể gọi Sử dụng logging trong nhiều modulechi tiết Nếu phần mềm của bạn có nhiều modules thì đây là một cách đơn giản để setup hệ thống logging xuyên suốt cả phần mềm:
Kết quả:
Kết hợp với việc format nội dung logging như đã nêu trước đó, bạn có thể in ra thông tin log được gọi từ module nào. Trên đây là khái quát một số ví dụ đơn giản sử dụng logging, bạn có thể khám phá thêm một số tính năng phức tạp hơn của logging ở: advanced logging tutorial Tham khảo:
|