python - 以编程方式监听发送到 Python/Django 记录器的日志消息

Question

作为 Python 和 Django 的新手，我不确定如何最好地解决我的问题。我最终确实想出了一个解决方案，但它似乎有点权宜之计，或者至少，方法没有被用于目的。无法在网上找到关于该主题的任何信息，我想我会在这里发布 Q-A 风格，以便至少有一个关于 SO 的答案，并看看是否有其他人有改进或更“pythonic”的方法。

我的问题是我正在为我没有修改权限的代码编写测试，并且代码本身只输出对日志的响应——所以该方法需要是可以介入并收听日志的东西消息并断言它们符合预期。

import logging

logger = logging.getLogger('shrubbery')

# do stuff
other_code_that_cant_be_altered_that_will_trigger_log_messages()

# assert that the log messages are as we expected
assert_messages_be_good_and_expected()

Answer 1

所以在阅读了一些页面之后，我发现有一些日志记录功能可能对我有用。我特别喜欢对 addHandler、addFilter 的描述。不如其他一些信息丰富，也不比函数本身的命名约定信息丰富。但是，我不维护任何公共(public)文档，所以不能提示。

1. https://docs.djangoproject.com/en/dev/topics/logging/
2. https://docs.python.org/2/library/logging.html#logger-objects
3. https://docs.python.org/2/howto/logging-cookbook.html#filters-contextual
4. http://www.onlamp.com/pub/a/python/2005/06/02/logging.html

经过反复试验，我将以下内容放在一起。我的第一次尝试是使用 addHandler，但这似乎比 addFilter 涉及更多，而且缺乏文档。所以基本上代码设置了一个伪造的日志过滤器，它监听每条日志消息，并将它们附加到范围更远的数组中。它总是返回 true，因此日志消息永远不会丢失。我不确定这是否是最优的，或者是否有更好的语义方式，但它确实有效。

import logging

messages = []
logger = logging.getLogger('shrubbery')

# use a filter to listen out for the log
class ListenFilter(logging.Filter):
    def filter(self, record):
        messages.append(record.getMessage())
        return True

# plug our filter listener in
f = ListenFilter()
logger.addFilter(f)

# do stuff
other_code_that_cant_be_altered_that_will_trigger_log_messages()

# do more stuff, this time reading messages
assert_messages_be_good_and_expected(messages)

# tidy up
logger.removeFilter(f)