摘要：第一個(gè)函數(shù)創(chuàng)建了日志對象并返回該日志對象。第二個(gè)函數(shù)是我們的裝飾器函數(shù)。我們在一個(gè)中封裝傳遞的函數(shù)，當(dāng)中發(fā)生任何異常的時(shí)候，進(jìn)行日志記錄。

Python: How to Create an Exception Logging Decorator

exception_decor.py

import functools
import logging
 
def create_logger():
    """
    Creates a logging object and returns it
    """
    logger = logging.getLogger("example_logger")
    logger.setLevel(logging.INFO)
 
    # create the logging file handler
    fh = logging.FileHandler("/path/to/test.log")
 
    fmt = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
    formatter = logging.Formatter(fmt)
    fh.setFormatter(formatter)
 
    # add handler to logger object
    logger.addHandler(fh)
    return logger
 
 
def exception(function):
    """
    A decorator that wraps the passed in function and logs 
    exceptions should one occur
    """
    @functools.wraps(function)
    def wrapper(*args, **kwargs):
        logger = create_logger()
        try:
            return function(*args, **kwargs)
        except:
            # log the exception
            err = "There was an exception in  "
            err += function.__name__
            logger.exception(err)
 
            # re-raise the exception
            raise
    return wrapper

在該代碼中，有兩個(gè)函數(shù)。第一個(gè)函數(shù)創(chuàng)建了日志對象并返回該日志對象。第二個(gè)函數(shù)是我們的裝飾器函數(shù)。我們在一個(gè)try/except中封裝傳遞的函數(shù)，當(dāng)logger中發(fā)生任何異常的時(shí)候，進(jìn)行日志記錄。并且我還記錄了當(dāng)異常發(fā)生時(shí)的函數(shù)名稱。

現(xiàn)在讓我們測試下該裝飾器。

    from exception_decor import exception
     
    @exception
    def zero_divide():
        1 / 0
     
    if __name__ == "__main__":
        zero_divide()

運(yùn)行以上測試代碼后，會出現(xiàn)以下錯(cuò)誤日志：

2016-06-09 08:26:50,874 - example_logger - ERROR - There was an exception in  zero_divide
Traceback (most recent call last):
  File "/home/mike/exception_decor.py", line 29, in wrapper
    return function(*args, **kwargs)
  File "/home/mike/test_exceptions.py", line 5, in zero_divide
    1 / 0
ZeroDivisionError: integer division or modulo by zero

# exception_logger.py
 
import logging
 
def create_logger():
    """
    Creates a logging object and returns it
    """
    logger = logging.getLogger("example_logger")
    logger.setLevel(logging.INFO)
 
    # create the logging file handler
    fh = logging.FileHandler(r"/path/to/test.log")
 
    fmt = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
    formatter = logging.Formatter(fmt)
    fh.setFormatter(formatter)
 
    # add handler to logger object
    logger.addHandler(fh)
    return logger
 
logger = create_logger()

現(xiàn)在修改前面出現(xiàn)的裝飾器，以便可以接受 logger 作為參數(shù)。

# exception_decor.py
 
import functools
 
 
def exception(logger):
    """
    A decorator that wraps the passed in function and logs 
    exceptions should one occur
 
    @param logger: The logging object
    """
 
    def decorator(func):
 
        def wrapper(*args, **kwargs):
            try:
                return func(*args, **kwargs)
            except:
                # log the exception
                err = "There was an exception in  "
                err += func.__name__
                logger.exception(err)
 
            # re-raise the exception
            raise
        return wrapper
    return decorator

最后修改測試腳本：

from exception_decor import exception
from exception_logger import logger
 
@exception(logger)
def zero_divide():
    1 / 0
 
if __name__ == "__main__":
    zero_divide()