『無為則無心』Python日志 — 68、logging日志模塊的封裝

目錄

• 1、日志模塊封裝
• 2、日志模塊的調用

1、日志模塊封裝

首先我們把之前學過的代碼語句封裝到模塊的方法中。

可以把該模塊封裝到commo目錄中。

"""
簡單封裝log方法

我們之后也可以把一些常量提取的配置文件中。
自己網上去學習。
"""

import os
import time
import logging.handlers

# 日志打印等級
LEVELS = {
    'debug': logging.DEBUG,
    'info': logging.INFO,
    'warning': logging.WARNING,
    'error': logging.ERROR,
    'critical': logging.CRITICAL
}

# 創建一個日志
logger = logging.getLogger()
level = 'default'


# 創建日志文件方法
def create_file(filename):
    path = filename[0:filename.rfind('/')]
    if not os.path.isdir(path):
        os.makedirs(path)
    if not os.path.isfile(filename):
        fd = open(filename, mode='w', encoding='utf-8')
        fd.close()
    else:
        pass


# 給logger添加handler 添加內容到日志處理器中
def set_handler(levels):
    if levels == 'error':
        logger.addHandler(MyLog.err_handler)
    logger.addHandler(MyLog.handler)


# 在記錄日志之后移除日志處理器
def remove_handler(levels):
    if levels == 'error':
        logger.removeHandler(MyLog.err_handler)
    logger.removeHandler(MyLog.handler)

# 獲取當前時間
def get_current_time():
    return time.strftime(MyLog.date, time.localtime(time.time()))


# 封裝框架的log模塊
class MyLog:
    # 把日志輸入到log目錄中
    path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
    log_file = path + '/Log/log.log'
    err_file = path + '/Log/err.log'
    logger.setLevel(LEVELS.get(level, logging.NOTSET))
    create_file(log_file)
    create_file(err_file)
    date = '%Y-%m-%d %H:%M:%S'

    # 創建一個handler，用於寫入日志文件
    handler = logging.FileHandler(log_file, encoding='utf-8')
    err_handler = logging.FileHandler(err_file, encoding='utf-8')

    @staticmethod
    def debug(log_meg):
        set_handler('debug')
        # 文件中輸出模式
        logger.debug("[DEBUG " + get_current_time() + "]" + log_meg)
        remove_handler('debug')

    @staticmethod
    def info(log_meg):
        set_handler('info')
        logger.info("[INFO " + get_current_time() + "]" + log_meg)
        remove_handler('info')

    @staticmethod
    def warning(log_meg):
        set_handler('warning')
        logger.warning("[WARNING " + get_current_time() + "]" + log_meg)
        remove_handler('warning')

    @staticmethod
    def error(log_meg):
        set_handler('error')
        logger.error("[ERROR " + get_current_time() + "]" + log_meg)
        remove_handler('error')

    @staticmethod
    def critical(log_meg):
        set_handler('critical')
        logger.error("[CRITICAL " + get_current_time() + "]" + log_meg)
        remove_handler('critical')

    # 設置控制台輸出格式
    formatter = logging.Formatter(
        '[%(asctime)s] [%(levelname)s] %(message)s', '%Y-%m-%d %H:%M:%S')
    # 再創建一個handler，用於輸出到控制台
    console = logging.StreamHandler()
    console.setFormatter(formatter)
    logger.addHandler(console)
    console.setLevel(logging.NOTSET)


if __name__ == "__main__":
    MyLog.debug("This is debug message")
    MyLog.info("This is info message")
    MyLog.warning("This is warning message")
    MyLog.error("This is error")
    MyLog.critical("This is critical message")

運行結果如下：

[2021-01-16 22:41:53] [DEBUG] [DEBUG 2021-01-16 22:41:53]This is debug message
[2021-01-16 22:41:53] [INFO] [INFO 2021-01-16 22:41:53]This is info message
[2021-01-16 22:41:53] [WARNING] [WARNING 2021-01-16 22:41:53]This is warning message
[2021-01-16 22:41:53] [ERROR] [ERROR 2021-01-16 22:41:53]This is error
[2021-01-16 22:41:53] [ERROR] [CRITICAL 2021-01-16 22:41:53]This is critical message

2、日志模塊的調用

我們在寫測試用例的時候，也就是在script目錄編寫測試用例。

使用下面的方式進行日志模塊的調用。

"""
測試新增學院接口
"""

# 測試用例是在unittest框架下編寫
import unittest
from interface.add_departments import Add_department  # 導入新增學院接口
from common.getKeyword_forResult import GetKeyword  # 返回值處理接口
from common.common_log import MyLog


# 測試添加和查詢學院的關聯型接口
class Test_Add_Dep(unittest.TestCase):
    def setUp(self) -> None:
        self.url = "http://127.0.0.1:8000/api/departments/"
        # 實例化Add_department
        self.add_dep = Add_department(self.url)

    # 測試添加學院完整性實現
    def test_add_dep(self):
        """
        測試添加學院接口
        :return:
        """

        # 封裝請求參數
        data = {
            "data": [
                {
                    "dep_id": "T101",
                    "dep_name": "Test學院",
                    "master_name": "Test-Master",
                    "slogan": "Here is Slogan"
                }
            ]
        }

        try:
            # 新增學院
            response = self.add_dep.add_dep(data)
            if GetKeyword.get_keyword(response["already_exist"], "count") == 0:
                # 獲取添加成功后的dep.id
                res_dep_id = GetKeyword.get_keyword(response["create_success"], "dep_id")
                # 1.輸出添加學院成功日志信息
                MyLog.info("添加學院成功！")
            else:
                res_dep_id = GetKeyword.get_keyword(response["already_exist"], "dep_id")
                # 2.輸出添加學院已存在日志信息
                MyLog.info("您添加的學院已存在！")
        except Exception as error:
            # 3.輸出添加學院錯誤日志信息
            MyLog.error("添加學院參數錯誤！")

        expect = "T101"
        self.assertEqual(res_dep_id, expect)


if __name__ == '__main__':
    unittest.main()

說明：

我們通過簡單的例子，來模擬日志模塊如何封裝，在用例中如何使用。

但是在實際的工作做會比上面復雜的多，

所以在這里我們知道日志模塊如何定義，如何使用就可以了。