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

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

logging.basicConfig(level=logging.DEBUG)

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

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

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


当前回答

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

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

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

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

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

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

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

其他回答

我喜欢Hassek的自定义测试运行器的想法。值得注意的是,Django testsuiterunner不再是Django 1.6+中的默认测试运行器,它已经被DiscoverRunner所取代。对于默认行为,测试运行器应该更像:

import logging

from django.test.runner import DiscoverRunner

class NoLoggingTestRunner(DiscoverRunner):
    def run_tests(self, test_labels, extra_tests=None, **kwargs):

        # disable logging below CRITICAL while testing
        logging.disable(logging.CRITICAL)

        return super(NoLoggingTestRunner, self).run_tests(test_labels, extra_tests, **kwargs)

如果你正在使用pytest,你可以安装超级有用的pytest-mock插件,并定义一个自动使用的会话范围的fixture,可以由env var触发:

# conftest.py

import os
import pytest


@pytest.fixture(autouse=True, scope="session")
def _shut_logger(session_mocker):
    if os.getenv("SHUT_LOGGER", None):
        return session_mocker.patch("foo.logger")

因为你在Django中,你可以添加这些行到你的settings.py:

import sys
import logging

if len(sys.argv) > 1 and sys.argv[1] == 'test':
    logging.disable(logging.CRITICAL)

这样就不必在测试的每个setUp()中都添加这一行。

您还可以通过这种方式对您的测试需求进行一些方便的更改。

还有另一种“更好”或“更清晰”的方法可以向测试中添加细节,那就是创建自己的测试运行器。

就像这样创建一个类:

import logging

from django.test.simple import DjangoTestSuiteRunner
from django.conf import settings

class MyOwnTestRunner(DjangoTestSuiteRunner):
    def run_tests(self, test_labels, extra_tests=None, **kwargs):

        # Don't show logging messages while testing
        logging.disable(logging.CRITICAL)

        return super(MyOwnTestRunner, self).run_tests(test_labels, extra_tests, **kwargs)

现在添加到你的settings.py文件:

TEST_RUNNER = "PATH.TO.PYFILE.MyOwnTestRunner"
#(for example, 'utils.mytest_runner.MyOwnTestRunner')

这让您可以做另一种方法做不到的非常方便的修改,即让Django只测试您想要的应用程序。你可以通过改变test_labels来添加这一行到测试运行器:

if not test_labels:
    test_labels = ['my_app1', 'my_app2', ...]

我的一些测试包含关于日志输出的断言,因此更改日志级别会破坏它们。相反,我改变了Django LOGGING设置,在运行测试时使用NullHandler:

if 'test' in sys.argv:
    _LOG_HANDLERS = ['null']
else:
    _LOG_HANDLERS = ['console']
    
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'simple': {
            'format': '%(levelname)s %(message)s'
        },
    },
    'handlers': {
        'null': {
            'level': 'DEBUG',
            'class': 'logging.NullHandler',
        },
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'formatter': 'simple',
        },
    },
    'loggers': {
        'django': {
            'handlers': _LOG_HANDLERS,
            'propagate': True,
            'level': 'INFO',
        },
    }
}

b.h.

对我来说,在conftest.py:

 import confing
 # disable logging for tests
 [logging.disable(level) for level in [logging.DEBUG,
                                       logging.INFO,
                                       logging.ERROR,
                                       logging.CRITICAL]]