Menggunakan pernyataan cetak hanya untuk debug

Saya telah banyak coding dengan Python akhir-akhir ini. Dan saya telah bekerja dengan data yang belum pernah saya tangani sebelumnya, menggunakan rumus yang belum pernah dilihat sebelumnya dan menangani file besar. Semua ini membuat saya menulis banyak pernyataan cetak untuk memverifikasi apakah semuanya berjalan dengan baik dan mengidentifikasi titik-titik kegagalan. Namun, secara umum, mengeluarkan begitu banyak informasi bukanlah praktik yang baik. Bagaimana cara menggunakan pernyataan cetak hanya ketika saya ingin men-debug dan membiarkannya dilewati ketika saya tidak ingin mereka dicetak?

The loggingmodul memiliki segala sesuatu yang Anda inginkan. Ini mungkin tampak berlebihan pada awalnya, tetapi gunakan hanya bagian yang Anda butuhkan. Saya akan merekomendasikan menggunakan logging.basicConfiguntuk beralih tingkat penebangan untuk stderrdan metode log sederhana , debug, info, warning, errordan 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))

Cara sederhana untuk melakukannya adalah dengan memanggil fungsi logging:

DEBUG = True

def log(s):
    if DEBUG:
        print s

log("hello world")

Kemudian Anda dapat mengubah nilai DEBUGdan menjalankan kode Anda dengan atau tanpa logging.

loggingModul standar memiliki mekanisme yang lebih rumit untuk ini.

Gunakan modul perpustakaan built-in logging daripada mencetak.

Anda membuat Loggerobjek (katakanlah logger), lalu setelah itu, setiap kali Anda menyisipkan cetakan debug, Anda cukup meletakkan:

logger.debug("Some string")

Anda dapat menggunakan logger.setLeveldi awal program untuk mengatur tingkat keluaran. Jika Anda menyetelnya ke DEBUG, semua debug akan dicetak. Setel ke INFO atau lebih tinggi dan segera semua debug akan hilang.

Anda juga dapat menggunakannya untuk mencatat hal-hal yang lebih serius, pada level yang berbeda (INFO, PERINGATAN, dan ERROR).

Pertama, saya akan kedua nominasi kerangka logging python . Namun, berhati-hatilah saat menggunakannya. Secara khusus: biarkan kerangka logging memperluas variabel Anda, jangan lakukan sendiri. Misalnya, alih-alih:

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

pastikan Anda melakukan:

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

karena meskipun terlihat serupa, versi pertama akan dikenakan biaya repr () meskipun dinonaktifkan . Versi kedua menghindari ini. Demikian pula, jika Anda menggulung sendiri, saya menyarankan sesuatu seperti:

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

debug = debug_stdout

dipanggil melalui:

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

yang akan, sekali lagi, menghindari overhead jika Anda menonaktifkannya dengan melakukan:

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

debug = debug_noop

Overhead komputasi string tersebut mungkin tidak masalah kecuali jika 1) mahal untuk dihitung atau 2) pernyataan debug berada di tengah, katakanlah, loop n ^ 3 atau sesuatu. Bukannya aku tahu apa-apa tentang itu.

Saya tidak tahu tentang orang lain, tapi saya terbiasa mendefinisikan "konstanta global" ( DEBUG) dan kemudian fungsi global ( debug(msg)) yang msghanya akan mencetak jika DEBUG == True.

Kemudian saya menulis pernyataan debug saya seperti:

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

... kemudian saya mengambil unit testing dan tidak pernah melakukan ini lagi! :)