Python日志模塊logging

在上一篇文章《Python系統模塊os》中我留了一個問題，就是python中怎么刪除非空的目錄，這里給出答案。Python刪除非空目錄使用的是shutil模塊。這個模塊一般用于復制文件，但是它也具有刪除非空目錄的能力。我們看一下它是怎么刪除的。

>>> os.makedirs('dir1/dir2')
>>> os.listdir('dir1')
['dir2']
>>> shutil.rmtree('dir1')
>>> os.listdir()
[]

在上面的示例代碼中，我先創建了一個兩級目錄 dir1/dir2，我使用shutil.rmtree()函數來刪除，可以看到可以直接刪除成功。它的用法就是直接給出對應的目錄路徑就可以了。

今天我要介紹的是python提供的日志記錄模塊logging，說到日志，相信不管是做開發的同學還是做日志的同學都知道，這個功能是非常重要的。因為從日志里面我們可以追蹤整個程序的運行過程，查看報錯信息，進行故障分析等等，應用可以說是非常廣泛。說到這里，學過Python基礎的同學可能會問，Python不是有print函數可以用來輸出調試信息嗎？
沒錯，print函數確實可以用來輸出，但是在實際的生產環境代碼中，日志需要劃分對應的級別，根據不同的目的輸出不同數量的日志。例如排錯的時候，就需要更詳細一點的日志，而正常運行的時候，輸出少量日志即可。這些功能都是print函數無法滿足的，而Python提供的logging庫則可以滿足需求，話不多說。我們來看這個模塊的一些知識。

日志級別

剛我們說到，不同的目的需要不同級別的日志。在logging模塊中，將日志劃分為7個級別，分別是：

• CRITICAL，災難級別，對應數值50
• ERROR，錯誤級別，對應數值40
• WARNING，警告級別，對應數值30（默認值）
• INFO，信息級別，對應數值20
• DEBUG，調試級別，對應數值10
• NOTEST，非測試，對應數值0

當你把日志級別設置為其中一個時，你在程序中進行輸出的時候，只有輸出位置的信息級別高于默認配置，才運行讓你把日志信息輸出到文件或者控制臺。也就是說，默認值是30，你輸出位置的級別是30，40，50，可以輸出，20，10，0級別的信息不允許輸出。
當你需要進行程序調試的時候，把日志級別改為DEBUG，那么能夠輸出的日志數值大于10就夠了，那么可以輸出的信息就更多，有利于調試。

格式化字符串

我們在各個應用程序的日志里看到的信息一般都會有一些標準格式，常見的是：
什么時候（日期 時間） 誰（哪個程序） 做了什么操作 導致了什么后果
而logging模塊中，也可以定制這樣的日志格式，它是通過不同格式的字符串來實現的，我們看一下常用的字符串有哪些。

• %(message)s，日志的內容，需要用戶自己提供信息字符串message
• %(asctime)s，日志的時間，默認格式是YYYY-mm-dd HH:MM:SS,sss，精確到毫秒
• %(funcName)s，日志調用的位置，即日志在哪個函數里被調用。便于排錯
• %(levelno)s，日志級別，使用INFO,DEBUG這樣的值
• %(lineno)s，日志調用的代碼行數，即在哪一行代碼處報錯，便于排錯。
• %(module)s，日志在哪個模塊被調用，便于排錯
• %(process)d / %(thread)d，進程/線程 ID，即調用日志模塊的進程/線程ID。
• %(processName)s / %(threadName)s，進程/ 線程名稱，即調用日志模塊的進程/線程ID。

基本知識就這些，我們來看一個簡單的示例：

import logging

# 格式化字符串
FORMAT = '%(asctime)-15s\t Log out info : %(thread)d %(threadName)s  %(message)s'

# 使用格式化字符串來初始化日志模塊輸出的日志格式
logging.basicConfig(format=FORMAT) 

# 輸出日志信息
logging.info("This is an info message")
logging.warning("This is a warning message")

代碼執行后的輸出結果是

2020-02-27 20:40:10,701  Log out info : 140552040826688 MainThread This is an warning message

我們在上面日志級別里說到，WARNING級別是默認級別，而低于這個級別的無法輸出。logging也為每個級別提供了對應的函數，例如這里代碼中的logging.info和logging.warning，就是用來輸出不同級別的日志信息。因此只有logging.warning的信息可以輸出，而logging.info級別因為低于WARNING，不允許輸出。輸出的內容包括我們定義的日期、線程ID，線程名稱，自定義的日志信息。

因此，在你的代碼中，在異常處理的時候，使用WARNING級別的信息，普通的調試信息則一般建議使用INFO級別來進行輸出。

修改日志級別和日期格式

當默認日志級別是WARNING的時候，INFO級別是無法輸出的，那么如果我們需要對程序進行調試的時候怎么辦呢？當然是修改默認的日志級別了，默認的日志級別可以在日志模塊初始化的時候進行設置，格式是：

logging.basicConfig(format=FROMAT, level=logging.INFO)

這樣就可以把日志默認級別改為INFO，如果還想輸出更多的信息進行調試，可以改為更低的DEBUG級別。但是同時別忘了，在你的程序中，輸出的日志定義的格式也需要分級的。

上面格式化字符串中我們看到，默認的日期格式是YYYY-mm-dd HH:MM:SS,sss，而每個開發人員可能習慣不一樣，或者說每個公司的標準不一樣，這個時候可能就需要修改日期格式了。這個參數的修改也是在日志模塊初始化的時候進行，用法是：

logging.basicConfig(format=FORMAT, datefmt='%Y/%m/%d %I:%M:%S')

在上面的示例中，我們將輸出的日期改為了上面的格式。這里%Y字樣的字符串，是日期格式化的內容，

• %Y表示YYYY
• %m表示mm
• %d表示dd
• %I表示HH格式，但是是12小時，24小時使用%H
• %M表示MM格式分鐘
• %S表示SS格式秒
  最終的輸出結果就是：

  2020/02/27 08:43:22  Log out info : 140034488715072 MainThread This is an warning message

輸出日志到文件

上面的基本配置中，沒有配置是否要把日志輸出到文件，那么它默認就會把文件輸出到控制臺。必須指定輸出文件的位置，才會自動輸出到文件中。配置格式如下：

logging.basicConfig(format=FORMAT,  filename='/var/log/demo.log')

這樣配置以后，日志就會自動輸出到/var/log/demo.log這個文件中，這里有幾個需要注意的地方：

1. 需要保證程序對這個日志文件有讀寫權限
2. 盡量使用絕對路徑，使用相對路徑，可能會因為程序執行的位置不同，導致日志文件出現在不同的位置
3. 還有一個filemode參數設置日志文件打開方式，默認值是'a'，即追加的方式。

以上就是logging模塊的基本用法，如果覺得對你有幫助，可以為我點個贊。