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

Question

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

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

Спасибо, Томас

Answer 1

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

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) 

Answer 2

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

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.

Answer 3

Вы можете написать собственную функцию 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 ,

Answer 4

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

with self.assertWarns(Warning): 
    do_something()