logging-exceptions 0.1.9

自动记录异常

将日志消息附加到异常

import logging
import logging_exceptions as exlog

e = ValueError("Wrong value")
logger = logging.getLogger(__name__)
with exlog.log_to_exception(logger, e):
    logger.critical("This is a %s log mressage", "long")
raise e # The exception can also be raised inside the with statement

如果没有捕获错误，则在程序终止时显示日志消息。

捕获错误并在自定义日志级别下显示日志消息

import logging_exceptions as exlog
import logging
try:
    e = ValueError("Wrong value")
    logger = logging.getLogger(__name__)
    with exlog.log_to_exception(logger, e):
        logger.critical("This is a %s log mressage", "long")
        raise e
except ValueError as err:
    exlog.log(err, level=logging.DEBUG, with_stacktrace=False)

在这里，exlog.log是exlog.log_exception的同义词

从不同的函数名和行号进行日志记录

log_exception中的代码调用Logger对象的_log函数。为了避免记录log_to_exception的函数名和行号，logging_exception调用logging.setLoggerClass(ExlogLogger)将导入logging_exception后创建的所有日志记录器的类设置为ExlogLogger。

ExlogLogger是本模块定义的logging.Logger的子类。它覆盖了findCaller以更多地控制记录的调用者。除了忽略logging_exceptions中定义的函数外，ExlogLogger类还有公开属性ignored_functions。

通过将函数名添加到ignored_functions中，可以记录匹配函数的父函数而不是匹配函数作为调用者。

特别是，可以在辅助函数中使用上下文管理器logging_exceptions.log_at_caller来临时更新记录器的ignored_functions，以便记录函数的调用者而不是函数。

以下代码将生成一个函数名为foo的日志消息，而不是helper_function

import logging_exceptions as exlog
logger = logging.get_logger(__name__)
def helper_function():
   with exlog.log_at_caller(logger):
     logger.log("This is a log message")
def foo():
   helper_function()

命令行便利函数

以下便捷函数与异常处理无直接关联，但如果你使用argparse，它们会很有用。

将‘–verbose’、‘–debug’和‘–quiet’选项添加到argparse.Argumentparser实例中。

import argparse
import logging_exceptions as exlog

parser=argparse.ArgumentParser("Some help text")
exlog.update_parser(parser)
args = parser.parse_args()

logging.basicConfig()
# The following call updates the log levels of the root logger
# and potential some other loggers.
exlog.config_from_args(args)

现在可以通过以下方式从命令行使用脚本

# Set the log-level for the loggers with the names `path.to.module1`
# and `path.to.module2` to DEBUG.
python script.py --debug path.to.module1,path.to.module2