使用 logzero 在 Python 中進行簡單紀錄檔記錄

快速了解一個方便的紀錄檔庫，來幫助你掌握這個重要的程式設計概念。

logzero 庫使紀錄檔記錄就像列印語句一樣容易，是簡單性的傑出代表。我不確定 logzero 的名稱是否要與 pygame-zero、GPIO Zero 和 guizero 這樣的 “zero 樣板庫”契合，但是肯定屬於該類別。它是一個 Python 庫，可以使紀錄檔記錄變得簡單明瞭。

你可以使用它基本的記錄到標準輸出的紀錄檔記錄，就像你可以使用 print 來獲得資訊和偵錯一樣，學習它的更高階紀錄檔記錄（例如記錄到檔案）的學習曲線也很平滑。

首先，使用 pip 安裝 logzero：

$ sudo pip3 install logzero

在 Python 檔案中，匯入 logger 並嘗試以下一個或所有紀錄檔範例：

from logzero import loggerlogger.debug("hello")logger.info("info")logger.warning("warning")logger.error("error")

輸出以易於閱讀的方式自動著色：

因此現在不要再使用 print 來了解發生了什麼，而應使用有相關紀錄檔級別的紀錄檔器。

在 Python 中將紀錄檔寫入檔案

如果你閱讀至此，並會在你寫程式碼時做一點改變，這對我就足夠了。如果你要了解更多，請繼續閱讀！

寫到標準輸出對於測試新程式不錯，但是僅當你登入到執行指令碼的計算機時才有用。在很多時候，你需要遠端執行程式碼並在事後檢視錯誤。這種情況下，記錄到檔案很有幫助。讓我們嘗試一下：

from logzero import logger, logfilelogfile('/home/pi/test.log')

現在，你的紀錄檔條目將記錄到檔案 test.log 中。記住確保指令碼有許可權寫入該檔案及其目錄結構。

你也可以指定更多選項：

logfile('/home/pi/test.log', maxBytes=1e6, backupCount=3)

現在，當提供給 test.log 檔案的資料達到 1MB（10⁶ 位元組）時，它將通過 test.log.1、test.log.2 等檔案輪替寫入。這種行為可以避免系統開啟和關閉大量 I/O 密集的紀錄檔檔案，以至於系統無法開啟和關閉。更專業一點，你或許還要記錄到 /var/log。假設你使用的是 Linux，那麼建立一個目錄並將使用者設為所有者，以便可以寫入該目錄：

$ sudo mkdir /var/log/test$ sudo chown pi /var/log/test

然後在你的 Python 程式碼中，更改 logfile 路徑：

logfile('/var/log/test/test.log', maxBytes=1e6, backupCount=3)

當要在 logfile 中捕獲異常時，可以使用 logging.exception：

try:    c = a / bexcept Exception as e:    logger.exception(e)

這將輸出（在 b 為零的情況下）：

[E 190422 23:41:59 test:9] division by zero     Traceback (most recent call last):       File "test.py", line 7, in         c = a / b     ZeroDivisionError: division by zero

你會得到紀錄檔，還有完整回溯。另外，你可以使用 logging.error 並隱藏回溯：

try:    c = a / bexcept Exception as e:    logger.error(f"{e.__class__.__name__}: {e}")

現在，將產生更簡潔的結果：

[E 190423 00:04:16 test:9] ZeroDivisionError: division by zero

你可以在 logzero.readthedocs.io 中閱讀更多選項。

logzero 為教育而生

對於新手程式設計師來說，紀錄檔記錄可能是一個具有挑戰性的概念。大多數框架依賴於流控制和大量變數操作來生成有意義的紀錄檔，但是 logzero 不同。由於它的語法類似於 print 語句，因此它在教育上很成功，因為它無需解釋其他概念。在你的下個專案中試試它。

此文章最初發布在我的部落格上，經許可重新發布。