Python - loguru日志庫，高效輸出控制台日志和日志記錄

安裝loguru

loguru的PyPI地址為：https://pypi.org/project/loguru/

GitHub倉庫地址為：https://github.com/Delgan/loguru

我們可以直接使用pip命令對其進行安裝

pip install loguru 

或者下載其源碼，使用Python命令進行安裝。

 

loguru簡單使用

from loguru import logger

logger.info("中文loguru")
logger.debug("中文loguru")
logger.error("中文loguru")
logger.warning("中文loguru")

運行結果

2020-03-07 15:51:05.752 | INFO     | __main__:info:23 - 中文loguru
2020-03-07 15:51:05.753 | DEBUG    | __main__:debug:26 - 中文loguru
2020-03-07 15:51:05.753 | WARNING  | __main__:warning:29 - 中文loguru
2020-03-07 15:51:05.753 | ERROR    | __main__:error:32 - 中文loguru

可以看到其默認的輸出格式是包含【時間、級別、模塊名、行號以及日志信息】，不需要手動創建  logger ，直接使用即可，另外其輸出還是彩色的，看起來會更加友好。

 

loguru保留日志文件

一般情況，我們都需要將日志輸出保存到文件中，loguru直接通過 add() 方法，就可以配置一個日志文件，如下代碼所示：

# coding:utf-8
from loguru import logger

logger.add("interface_log_{time}.log", rotation="500MB", encoding="utf-8", enqueue=True, compression="zip", retention="10 days")
logger.info("中文test")
logger.debug("中文test")
logger.error("中文test")
logger.warning("中文test")

然后就去interface_log_2020-03-07-15:55.log查看日志

包含知識點

• 第一個參數是保存日志信息的文件路徑，像我寫的后綴多了個 {time} ，就是獲取當前時間節點，這樣就會自動創建新的日志；這個time應該是庫里自帶的變量，如果你想自己定義time也可以的哦，具體可以看看下面封裝類的實現形式！
• 當你需要輸出中文日志的時候，請加上 encoding="utf-8" ，避免出現亂碼 
• enqueue=True 代表異步寫入，官方的大概意思是：在多進程同時往日志文件寫日志的時候使用隊列達到異步功效
• rotation 可以理解成日志的創建時機，可以有多種寫法
  • rotation="500 MB" ：當日志文件達到500MB時就會重新生成一個文件
  • rotation="12:00" ：每天12點就會創建新的文件、
  • rotation="1 week" ：每隔一周創建一個log
• retention 配置日志的最長保留時間，官方例子： "1 week, 3 days"、"2 months" 
• compression 配置文件的壓縮格式，可以配置常見的格式 zip、tar、gz、tar.gz 等

 

loguru字符串輸出

最重要的！loguru還提供了字符串格式化輸出日志的功能，如下面代碼

logger.info('If you are using Python {}, prefer {feature} of course!', 3.6, feature='f-strings')
n1 = "cool"
n2 = [1, 2, 3]
logger.info(f'If you are using Python {n1}, prefer {n2} of course!')

運行結果

2020-03-07 16:19:25.363 | INFO     | __main__:<module>:43 - If you are using Python 3.6, prefer f-strings of course!
2020-03-07 16:19:25.364 | INFO     | __main__:<module>:46 - If you are using Python cool, prefer [1, 2, 3] of course!

可以看到，只要你會Python字符串格式化輸出，這個簡直信手拈來！

 

loguru封裝類，可以直接拿去用！

日志輸出路徑：你的項目路徑下的log文件夾下

注意：這個是工具類，需要放在項目路徑下的util文件夾之類的，不能直接放項目路徑下哈，不然路徑會生成錯誤哦

"""
操作日志記錄
"""
import time
from loguru import logger
from pathlib import Path

project_path = Path.cwd().parent
log_path = Path(project_path, "log")
t = time.strftime("%Y_%m_%d")


class Loggings:
    __instance = None
    logger.add(f"{log_path}/interface_log_{t}.log", rotation="500MB", encoding="utf-8", enqueue=True,
               retention="10 days")

    def __new__(cls, *args, **kwargs):
        if not cls.__instance:
            cls.__instance = super(Loggings, cls).__new__(cls, *args, **kwargs)

        return cls.__instance

    def info(self, msg):
        return logger.info(msg)

    def debug(self, msg):
        return logger.debug(msg)

    def warning(self, msg):
        return logger.warning(msg)

    def error(self, msg):
        return logger.error(msg)


loggings = Loggings()
if __name__ == '__main__':
    loggings.info("中文test")
    loggings.debug("中文test")
    loggings.warning("中文test")
    loggings.error("中文test")

    logger.info('If you are using Python {}, prefer {feature} of course!', 3.6, feature='f-strings')
    n1 = "cool"
    n2 = [1, 2, 3]
    logger.info(f'If you are using Python {n1}, prefer {n2} of course!')