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

Question

作为 Python 和 Django 的新手，我不知道如何最好地解决我的问题。我最终确实想出了一个解决方案，但它似乎有点权宜之计，或者至少，方法没有被用于目的。由于无法在网上找到有关该主题的任何内容，我想我应该在这里以 QA 风格发布此内容，以便至少有一个关于 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。不像其他一些函数那么丰富，也不比函数本身的命名约定更丰富。但是，我不维护任何公共文档，所以不能抱怨。

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)