Chỉ sử dụng câu lệnh in để gỡ lỗi

Tôi đã viết mã rất nhiều bằng Python trong thời gian gần đây. Và tôi đã làm việc với dữ liệu mà tôi chưa từng làm việc trước đây, sử dụng các công thức chưa từng thấy trước đây và xử lý các tệp lớn. Tất cả những điều này khiến tôi phải viết rất nhiều bản báo cáo để xác minh xem mọi việc có ổn không và xác định những điểm không thành công. Tuy nhiên, nói chung, xuất ra quá nhiều thông tin không phải là một cách thực hành tốt. Làm cách nào để chỉ sử dụng câu lệnh in khi tôi muốn gỡ lỗi và bỏ qua chúng khi tôi không muốn in chúng?

Các loggingmô-đun có mọi thứ bạn có thể muốn. Thoạt nghe có vẻ thừa nhưng chỉ sử dụng những phần bạn cần. Tôi khuyên bạn nên sử dụng logging.basicConfigđể chuyển đổi mức độ khai thác gỗ để stderrvà phương pháp đơn giản log , debug, info, warning, errorvà critical.

import logging, sys
logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)
logging.debug('A debug message!')
logging.info('We processed %d records', len(processed_records))

Một cách đơn giản để làm điều này là gọi một hàm ghi nhật ký:

DEBUG = True

def log(s):
    if DEBUG:
        print s

log("hello world")

Sau đó, bạn có thể thay đổi giá trị của DEBUG và chạy mã của mình có hoặc không ghi nhật ký.

loggingMô-đun tiêu chuẩn có một cơ chế phức tạp hơn cho việc này.

Sử dụng mô-đun thư viện tích hợp ghi nhật ký thay vì in.

Bạn tạo một Loggerđối tượng (giả sử logger), và sau đó, bất cứ khi nào bạn chèn bản in gỡ lỗi, bạn chỉ cần đặt:

logger.debug("Some string")

Bạn có thể sử dụng logger.setLevelkhi bắt đầu chương trình để đặt mức đầu ra. Nếu bạn đặt nó thành Gỡ lỗi, nó sẽ in tất cả các bản gỡ lỗi. Đặt nó thành INFO hoặc cao hơn và ngay lập tức tất cả các gỡ lỗi sẽ biến mất.

Bạn cũng có thể sử dụng nó để ghi lại những thứ nghiêm trọng hơn, ở các cấp độ khác nhau (THÔNG TIN, CẢNH BÁO và LỖI).

Đầu tiên, tôi sẽ đề cử thứ hai về khung ghi nhật ký của python . Tuy nhiên, hãy cẩn thận một chút về cách bạn sử dụng nó. Cụ thể: hãy để khung ghi nhật ký mở rộng các biến của bạn, đừng tự làm điều đó. Ví dụ, thay vì:

logging.debug("datastructure: %r" % complex_dict_structure)

hãy chắc chắn rằng bạn làm:

logging.debug("datastructure: %r", complex_dict_structure)

bởi vì trong khi chúng trông giống nhau, phiên bản đầu tiên phải chịu chi phí repr () ngay cả khi nó bị vô hiệu hóa . Phiên bản thứ hai tránh điều này. Tương tự như vậy, nếu bạn tự cuộn, tôi sẽ đề xuất một cái gì đó như:

def debug_stdout(sfunc):
    print(sfunc())

debug = debug_stdout

được gọi qua:

debug(lambda: "datastructure: %r" % complex_dict_structure)

điều này một lần nữa sẽ tránh được chi phí nếu bạn vô hiệu hóa nó bằng cách:

def debug_noop(*args, **kwargs):
    pass

debug = debug_noop

Chi phí tính toán các chuỗi đó có lẽ không thành vấn đề trừ khi chúng 1) tốn kém để tính toán hoặc 2) câu lệnh gỡ lỗi nằm ở giữa, chẳng hạn, một vòng lặp n ^ 3 hoặc một cái gì đó. Không phải là tôi sẽ biết bất cứ điều gì về điều đó.

Tôi không biết về những người khác, nhưng tôi đã được sử dụng để xác định một "hằng số toàn cầu" ( DEBUG) và sau đó là một hàm toàn cầu ( debug(msg)) sẽ msgchỉ in nếuDEBUG == True .

Sau đó, tôi viết các câu lệnh gỡ lỗi của mình như:

debug('My value: %d' % value)

... sau đó tôi chọn thử nghiệm đơn vị và không bao giờ làm điều này nữa! :)