Question

对于Python和Django来说相对较新我不确定如何最好地解决我的问题。我最终想出了一个解决方案，但似乎有点临时，或者至少，方法没有被用于目的。我无法在网上找到任何关于这个主题的内容，我认为我会在这里发布QA风格，所以至少有一个关于SO的答案，并且看看是否有其他人有改进或更多的＆＃34; Python化＆＃34;方法

我的问题是我正在为我无权修改的代码编写测试，而代码本身只输出对日志的响应 - 因此该方法需要能够介入并监听日志消息并声明它们是预期的。

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的说明。不如其他一些信息丰富，也没有比函数本身的命名约定更丰富的信息。但是，我没有保留任何公开文件，所以不能抱怨。

https://docs.djangoproject.com/en/dev/topics/logging/
https://docs.python.org/2/library/logging.html#logger-objects
https://docs.python.org/2/howto/logging-cookbook.html#filters-contextual
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)

Answer 2

感谢Pebbl的回答！只是想补充一点，使用contextmanager来安装/删除过滤器似乎更简洁：

logger_ = logging.getLogger('some.external.logger')

from contextlib import contextmanager

@contextmanager
def install_remove_filter(logger_to_filter, filter_to_add_remove):
    logger_to_filter.addFilter(filter_to_add_remove)
    yield
    logger_to_filter.removeFilter(filter_to_add_remove)

# the filter above
my_filter = ListenFilter()

# installing/removing the filter in the context of the call
with install_remove_filter(logger_, my_filter):
    call_some_function()

# access the internals of my_filter
# ....

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

2 个答案: