2019-04-20发表2021-02-09更新后端开发5 分钟读完 (大约818个字)0次访问

Flask如何使用logging.FileHandler将日志保存到文件

需求

将日志尽可能往文件中输，自带的默认只输出到屏幕上。

代码

获取文件名

def get_custom_file_name():
    def make_dir(make_dir_path):
        path = make_dir_path.strip()
        if not os.path.exists(path):
            os.makedirs(path)
        return path
    log_dir = "ac_logs"
    file_name = 'logger-' + time.strftime('%Y-%m-%d', time.localtime(time.time())) + '.log'
    file_folder = os.path.abspath(os.path.dirname(__file__)) + os.sep + log_dir
    make_dir(file_folder)
    return file_folder + os.sep + file_name

配置logging

dictConfig({
    'version': 1,
    'formatters': {'default': {
        'format': '%(asctime)s - %(levelname)s - %(filename)s - %(funcName)s - %(lineno)s - %(message)s',
    }},
    'handlers': {
        'default': {
            'class': 'logging.StreamHandler',
            'stream': 'ext://flask.logging.wsgi_errors_stream',
            'formatter': 'default'
        },
        'custom': {
            'class' : 'logging.FileHandler',
            'formatter': 'default',
            'filename' : get_custom_file_name(),
            'encoding' : 'utf-8'
        },
    },
    'root': {
        'level': 'INFO',
        'handlers': ['custom']
    }
})

代码分析

在官方文档中，有一个默认的handler，当我添加一个自定义的handler，名叫custom的时候，读取配置失败，程序中断，也就无法继续执行下去，提示说，少一个叫做filename的参数。

loggin.FileHandler的构造函数中，有一个必填的参数，叫做filename。如下：

class FileHandler(StreamHandler):
    """
    A handler class which writes formatted logging records to disk files.
    """
    def __init__(self, filename, mode='a', encoding=None, delay=False):
        """
        Open the specified file and use it as the stream for logging.
        """
        # Issue #27493: add support for Path objects to be passed in
        filename = os.fspath(filename)
        #keep the absolute path, otherwise derived classes which use this
        #may come a cropper when the current directory changes
        self.baseFilename = os.path.abspath(filename)
        self.mode = mode
        self.encoding = encoding
        self.delay = delay

如何才能传入参数filename?

①进入dictConfig()

1
2
3

def dictConfig(config):
    """Configure logging using a dictionary."""
    dictConfigClass(config).configure()

②进入configure()，找到对handler的处理逻辑，如下：

# 前面的代码省略
# 获取handlers
handlers = config.get('handlers', EMPTY_DICT)
deferred = []
# 遍历其中的每一个handler
for name in sorted(handlers):
    try:
    	# 具体处理每一个handler
        handler = self.configure_handler(handlers[name])
        handler.name = name
        handlers[name] = handler
    except Exception as e:
        if 'target not configured yet' in str(e.__cause__):
            deferred.append(name)
        else:
            raise ValueError('Unable to configure handler '
                             '%r' % name) from e
# 后面的代码省略

③进入具体处理handler的逻辑，self.configure_handler()：

def configure_handler(self, config):
    # 省略代码若干行 ...
    if '()' in config:
        c = config.pop('()')
        if not callable(c):
            c = self.resolve(c)
        factory = c
    else:
        cname = config.pop('class')
        klass = self.resolve(cname)
        # 省略代码若干行 ...
        # 此处的kclass就是配置的class名所对应的类
        factory = klass
    props = config.pop('.', None)
    # 读取完类名，获取到该类、获取了formatter之后，接着读取conf里面的数据
    # 在这里将剩下所定义的参数，弄成dict类型的数据
    kwargs = {k: config[k] for k in config if valid_ident(k)}
    try:
    	# 直接将dict类型的数据作为函数入参，实例化出一个FileHandler
        result = factory(**kwargs)
    except TypeError as te:
        if "'stream'" not in str(te):
            raise