我正在使用一个简单的基于单元测试的测试运行器来测试我的Django应用程序。

我的应用程序本身被配置为在settings.py中使用一个基本的日志记录器:

logging.basicConfig(level=logging.DEBUG)

并在我的应用程序代码使用:

logger = logging.getLogger(__name__)
logger.setLevel(getattr(settings, 'LOG_LEVEL', logging.DEBUG))

但是,在运行单元测试时,我想禁用日志记录,这样它就不会使测试结果输出混乱。有没有一种简单的方法以全局方式关闭日志记录,这样当我运行测试时,特定于应用程序的日志记录器就不会把东西写到控制台了?


当前回答

有没有一种简单的方法以全局方式关闭日志记录,这样当我运行测试时,特定于应用程序的日志记录器就不会把东西写到控制台了?

其他答案通过全局设置日志基础设施以忽略任何内容来防止“将内容写入控制台”。这是可行的,但我觉得这种方法太生硬了。我的方法是执行配置更改,只做防止日志泄漏到控制台上所需的事情。所以我在settings.py中添加了一个自定义日志过滤器:

from logging import Filter

class NotInTestingFilter(Filter):

    def filter(self, record):
        # Although I normally just put this class in the settings.py
        # file, I have my reasons to load settings here. In many
        # cases, you could skip the import and just read the setting
        # from the local symbol space.
        from django.conf import settings

        # TESTING_MODE is some settings variable that tells my code
        # whether the code is running in a testing environment or
        # not. Any test runner I use will load the Django code in a
        # way that makes it True.
        return not settings.TESTING_MODE

我配置Django日志使用过滤器:

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        'testing': {
            '()': NotInTestingFilter
        }
    },
    'formatters': {
        'verbose': {
            'format': ('%(levelname)s %(asctime)s %(module)s '
                       '%(process)d %(thread)d %(message)s')
        },
    },
    'handlers': {
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'filters': ['testing'],
            'formatter': 'verbose'
        },
    },
    'loggers': {
        'foo': {
            'handlers': ['console'],
            'level': 'DEBUG',
            'propagate': True,
        },
    }
}

最终结果是:当我在测试时,没有任何内容进入控制台,但其他内容保持不变。

为什么这么做?

我设计了包含日志记录指令的代码,这些指令仅在特定情况下触发,并且在出现问题时输出诊断所需的准确数据。因此,我测试了它们应该做什么,因此完全禁用日志记录对我来说是不可行的。我不想在软件投入生产后发现我认为应该记录的内容没有被记录。

此外,一些测试运行程序(例如Nose)将在测试期间捕获日志,并将日志的相关部分与测试失败一起输出。它有助于找出测试失败的原因。如果日志记录完全关闭,那么就无法捕获任何东西。

其他回答

logging.disable(logging.CRITICAL)

将禁用级别小于或等于CRITICAL的所有日志调用。可以重新启用日志记录

logging.disable(logging.NOTSET)

在我希望暂时抑制特定记录器的情况下,我写了一个我发现有用的小上下文管理器:

from contextlib import contextmanager
import logging

@contextmanager
def disable_logger(name):
    """Temporarily disable a specific logger."""
    logger = logging.getLogger(name)
    old_value = logger.disabled
    logger.disabled = True
    try:
        yield
    finally:
        logger.disabled = old_value

然后你可以这样使用它:

class MyTestCase(TestCase):
    def test_something(self):
        with disable_logger('<logger name>'):
            # code that causes the logger to fire

这样做的好处是,一旦with操作完成,记录器将被重新启用(或设置回其先前的状态)。

有没有一种简单的方法以全局方式关闭日志记录,这样当我运行测试时,特定于应用程序的日志记录器就不会把东西写到控制台了?

其他答案通过全局设置日志基础设施以忽略任何内容来防止“将内容写入控制台”。这是可行的,但我觉得这种方法太生硬了。我的方法是执行配置更改,只做防止日志泄漏到控制台上所需的事情。所以我在settings.py中添加了一个自定义日志过滤器:

from logging import Filter

class NotInTestingFilter(Filter):

    def filter(self, record):
        # Although I normally just put this class in the settings.py
        # file, I have my reasons to load settings here. In many
        # cases, you could skip the import and just read the setting
        # from the local symbol space.
        from django.conf import settings

        # TESTING_MODE is some settings variable that tells my code
        # whether the code is running in a testing environment or
        # not. Any test runner I use will load the Django code in a
        # way that makes it True.
        return not settings.TESTING_MODE

我配置Django日志使用过滤器:

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        'testing': {
            '()': NotInTestingFilter
        }
    },
    'formatters': {
        'verbose': {
            'format': ('%(levelname)s %(asctime)s %(module)s '
                       '%(process)d %(thread)d %(message)s')
        },
    },
    'handlers': {
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'filters': ['testing'],
            'formatter': 'verbose'
        },
    },
    'loggers': {
        'foo': {
            'handlers': ['console'],
            'level': 'DEBUG',
            'propagate': True,
        },
    }
}

最终结果是:当我在测试时,没有任何内容进入控制台,但其他内容保持不变。

为什么这么做?

我设计了包含日志记录指令的代码,这些指令仅在特定情况下触发,并且在出现问题时输出诊断所需的准确数据。因此,我测试了它们应该做什么,因此完全禁用日志记录对我来说是不可行的。我不想在软件投入生产后发现我认为应该记录的内容没有被记录。

此外,一些测试运行程序(例如Nose)将在测试期间捕获日志,并将日志的相关部分与测试失败一起输出。它有助于找出测试失败的原因。如果日志记录完全关闭,那么就无法捕获任何东西。

如果你想在2021年或以后考虑这个问题,你可能问错了问题

在现代版本的Django*中,使用开箱即用的配置,测试应该不会在屏幕上产生任何日志记录。因此,如果你在问这个问题,真正的答案可能是“某些东西配置错误”。这是因为(默认情况下):

打印日志消息到控制台需要debug为True 测试运行DEBUG=False

因此,如果您使用的记录器与在LOGGING['loggers']中定义的记录器相匹配,并且由“控制台”处理程序处理,那么测试应该不会在屏幕上产生任何日志记录。

如果你在测试中看到了什么,你也

日志记录器的名称与在设置中定义的内容不匹配。日志记录 正在使用DEBUG=True运行测试(需要重写) 已经从控制台处理程序的过滤器中删除了“require_debug_true”。

*现代版本的意思是:2.1及以上,即不古老。

我们使用structlog,禁用它有点复杂:

from structlog import DropEvent

def disable_logging_in_tests(_, __, event_dict):
    if len(sys.argv) > 1 and sys.argv[1] == 'test':
        raise DropEvent
    return event_dict


structlog.configure(
    processors=[
        ...
        disable_logging_in_tests,
    ]
    ...

)