Как проверить с помощью unittest Python, что было выдано предупреждение? - PullRequest
Новая
       23

Как проверить с помощью unittest Python, что было выдано предупреждение?

52 голосов
/ 08 октября 2010

У меня есть следующая функция в Python, и я хочу проверить с помощью unittest, что если функция получает 0 в качестве аргумента, она выдает предупреждение.Я уже пробовал assertRaises, но так как я не выдвигаю предупреждение, это не работает.

def isZero(i):
    if i != 0:
        print "OK"
    else:
        warning = Warning("the input is 0!") 
        print warning
    return i

Ответы [ 4 ]

48 голосов
/ 08 октября 2010

Вы можете использовать менеджер контекста catch_warnings. По сути, это позволяет вам высмеивать обработчик предупреждений, чтобы вы могли проверить детали предупреждения. См. официальные документы для более полного объяснения и примера тестового кода. 

import warnings

def fxn():
    warnings.warn("deprecated", DeprecationWarning)

with warnings.catch_warnings(record=True) as w:
    # Cause all warnings to always be triggered.
    warnings.simplefilter("always")
    # Trigger a warning.
    fxn()
    # Verify some things
    assert len(w) == 1
    assert issubclass(w[-1].category, DeprecationWarning)
    assert "deprecated" in str(w[-1].message)
41 голосов
/ 29 июня 2016

Начиная с Python 3.2, вы можете просто использовать метод assertWarns(). 

with self.assertWarns(Warning):
    do_something()
18 голосов
/ 17 октября 2012

Вы можете написать свою собственную функцию assertWarns для инкапсуляции контекста catch_warnings. Я только что реализовал это следующим образом, с помощью mixin: 

class WarningTestMixin(object):
    'A test which checks if the specified warning was raised'

    def assertWarns(self, warning, callable, *args, **kwds):
        with warnings.catch_warnings(record=True) as warning_list:
            warnings.simplefilter('always')

            result = callable(*args, **kwds)

            self.assertTrue(any(item.category == warning for item in warning_list))

Пример использования: 

class SomeTest(WarningTestMixin, TestCase):
    'Your testcase'

    def test_something(self):
        self.assertWarns(
            UserWarning,
            your_function_which_issues_a_warning,
            5, 10, 'john', # args
            foo='bar'      # kwargs
        )

Тест пройдет, если хотя бы одно из предупреждений, выданных your_function, относится к типу UserWarning.

6 голосов
/ 08 октября 2010

@ ire_and_curses ' answer весьма полезен и, думаю, каноничен. Вот еще один способ сделать то же самое. Для этого требуется превосходная Mock библиотека Майкла Фурда . 

import unittest, warnings
from mock import patch_object

def isZero( i):
   if i != 0:
     print "OK"
   else:
     warnings.warn( "the input is 0!")
   return i

class Foo(unittest.TestCase):
    @patch_object(warnings, 'warn')
    def test_is_zero_raises_warning(self, mock_warn):
        isZero(0)
        self.assertTrue(mock_warn.called)

if __name__ == '__main__':
    unittest.main()

Отличная patch_object позволяет вам смоделировать метод warn.

...