为什么将记录器编码设置为UTF-8以UNIX行结尾写入文件

Question

我创建了一个记录器，用于写入文本文件：

import logging
logger_dbg = logging.getLogger("dbg")
logger_dbg.setLevel(logging.DEBUG)
fh_dbg_log = logging.FileHandler('debug.log', mode='w', encoding='utf-8')
fh_dbg_log.setLevel(logging.DEBUG)
# Print time, logger-level and the call's location in a source file.
formatter = logging.Formatter(
    '%(asctime)s-%(levelname)s(%(module)s:%(lineno)d)  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S')
fh_dbg_log.setFormatter(formatter)
logger_dbg.addHandler(fh_dbg_log)
logger_dbg.propagate = False

然后，当我想记录一些信息时，我调用这个记录器：

logger_dbg.debug("Closing port...")
logger_dbg.debug("Port closed.")

问题是，尽管我在Windows7（64位）上运行了这个程序，但写入的日志文件debug.log使用了一个换行符（LF）：

2015-11-30 12:39:08-DEBUG(SerialThread:196)  Closing port...  2015-11-30 12:39:08-DEBUG(SerialThread:198)  Port closed.

奇怪的是，如果我在没有encoding='utf-8'参数的情况下设置记录器的文件句柄，那么换行符就会正确地写成CR/LF。

为什么将编码设置为UTF-8会导致Python使用不正确的换行符？

Answer 1

指定编码时，将使用codecs.open()而不是常规的open()调用。此函数始终以二进制模式打开文件，并在此基础上实现编码。这样，它可以保证任何编解码器都能工作，而不仅仅是基于ASCII的编解码器。这种选择的一个副作用是，在Windows上，换行符不再转换为平台约定！

你可以提交一个bug来修复这个问题，更好的解决方案是使用io.open()；io模块是新的Python 3 I/O框架，后移植到Python 2，它可以更好地处理文本模式，包括在Windows上正确处理换行符。

您可以修补logging.FileHandler._open方法以在本地修复此问题：

import io
from logging import FileHandler
_orig_open = FileHandler._open
_orig_emit = FileHandler.emit
def filehandler_open_patch(self):
    if self.encoding is not None:
        return io.open(self.baseFilename, self.mode, encoding=self.encoding)
    return _orig_open(self)
def filehandler_emit_patch(self, record):
    if not self.encoding:
        return _orig_emit(self, record)
    try:
        msg = self.format(record)
        stream = self.stream
        fs = u"%sn"
        if not isinstance(msg, unicode):
            msg = msg.decode('ASCII', 'replace')
        ufs = u'%sn'
        stream.write(ufs % msg)
        self.flush()
    except (KeyboardInterrupt, SystemExit):
        raise
    except:
        self.handleError(record)
FileHandler._open = filehandler_open_patch
FileHandler.emit = filehandler_emit_patch

FileHandler.emit()方法也需要修补，否则Unicode消息首先被编码为UTF-8，但io.open()文件对象只接受Unicode对象。