Làm thế nào để kiểm tra với Python của unittest rằng một cảnh báo đã được ném?

Question

Tôi có một chức năng sau đây trong Python và tôi muốn thử nghiệm với unittest rằng nếu hàm được 0 làm đối số, nó sẽ đưa ra một cảnh báo. Tôi đã cố gắng assertRaises, nhưng kể từ khi tôi không nâng cao cảnh báo, điều đó không hoạt động.

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

Cảm ơn bạn, Tomas

Answer 1

Bạn có thể sử dụng người quản lý catch_warnings ngữ cảnh. Về cơ bản, điều này cho phép bạn giả lập trình xử lý cảnh báo, để bạn có thể xác minh chi tiết cảnh báo. Xem official docs để có giải thích đầy đủ hơn và mã kiểm tra mẫu.

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 khá hữu ích và, tôi nghĩ, kinh điển. Đây là một cách khác để làm điều tương tự. Điều này đòi hỏi tuyệt vời của Michael Foord 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() 

Tiện lợi patch_object cho phép bạn thử phương pháp warn.

Answer 3

Bạn có thể viết hàm assertWarns của riêng mình để lồng vào bối cảnh catch_warnings. Tôi vừa mới thực hiện nó theo cách sau, với một 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)) 

Một ví dụ sử dụng:

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 
     ) 

Xét nghiệm này sẽ vượt qua khi có ít nhất một trong những cảnh báo do your_function là loại UserWarning .

Answer 4

Bắt đầu với Python 3.2, bạn có thể chỉ cần sử dụng phương thức assertWarns().

with self.assertWarns(Warning): 
    do_something()