Python 日志记录 sys.exit('message')

Question

我遵循 this guide 如何利用 Python 的 logging 模块。

现在我的每个 .py 文件都通过调用

来获取其记录器

logger = logging.getLogger(__name__)

主 .py 文件设置日志记录读取 json 配置文件。

import os
import json
import logging.config


def setup_logging(
    default_path='logging.json',
    default_level=logging.INFO,
    env_key='LOG_CFG'
):
    path = default_path
    value = os.getenv(env_key, None)
    if value:
        path = value
    if os.path.exists(path):
        with open(path, 'rt') as f:
            config = json.load(f)
        logging.config.dictConfig(config)
    else:
        logging.basicConfig(level=default_level)


setup_logging()

但是，我有很多代码是在没有正确记录的情况下编写的，它们只是在退出前打印一条错误消息。

# when error occurs
sys.exit('error message')

我想知道是否有办法捕获这些错误，以与其他错误相同的方式格式化它们（带时间戳）并将它们保存在记录器使用的同一个 error.log 文件中.

这是我的配置文件，logging.json

{
    "version": 1,
    "disable_existing_loggers": false,
    "formatters": {
        "simple": {
            "format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
        }
    },

    "handlers": {
        "console": {
            "class": "logging.StreamHandler",
            "level": "DEBUG",
            "formatter": "simple",
            "stream": "ext://sys.stdout"
        },

        "info_file_handler": {
            "class": "logging.handlers.RotatingFileHandler",
            "level": "INFO",
            "formatter": "simple",
            "filename": "info.log",
            "maxBytes": 10485760,
            "backupCount": 20,
            "encoding": "utf8"
        },

        "error_file_handler": {
            "class": "logging.handlers.RotatingFileHandler",
            "level": "ERROR",
            "formatter": "simple",
            "filename": "errors.log",
            "maxBytes": 10485760,
            "backupCount": 20,
            "encoding": "utf8"
        }
    },

    "loggers": {
        "my_module": {
            "level": "ERROR",
            "handlers": ["console"],
            "propagate": false
        }
    },

    "root": {
        "level": "DEBUG",
        "handlers": ["console", "info_file_handler", "error_file_handler"]
    }
}

Answer 1

由于 sys.exit 是通过引发 SystemExit 异常实现的，您可以捕获异常并记录它：

import logging
import sys
import os

logging.basicConfig(level=logging.DEBUG)
logger = logging.getLogger('example')

def function_will_exit():
    sys.exit('some error log')

try:
    function_will_exit()
except SystemExit as e:
    # this log will include traceback
    logger.exception('function_will_exit failed with exception')
    # this log will just include content in sys.exit
    logger.error(str(e))

    # if you don't need exception traceback from Python
    # os._exit(1)
    raise

Python 日志记录 sys.exit('message')

Python logging sys.exit('message')

python

logging

exit