numpy.testing.assert_warns#

testing.assert_warns(warning_class, *args, **kwargs)[source]#

除非给定的可调用对象抛出指定的警告,否则失败。

当使用参数 args 和关键字参数 kwargs 调用时,可调用对象应该抛出一个 warning_class 类别的警告。如果抛出了不同类型的警告,则不会捕获它。

如果在省略除警告类之外的所有参数的情况下调用,则可以用作上下文管理器

with assert_warns(SomeWarning):
    do_something()

作为上下文管理器的功能是 NumPy v1.11.0 中的新功能。

版本 1.4.0 中的新功能。

参数:
warning_classclass

定义 func 预计抛出的警告的类。

funccallable, optional

要测试的可调用对象

*argsArguments

func 的参数。

**kwargsKwargs

func 的关键字参数。

返回值:
func 返回的值。

示例

>>> import warnings
>>> def deprecated_func(num):
...     warnings.warn("Please upgrade", DeprecationWarning)
...     return num*num
>>> with np.testing.assert_warns(DeprecationWarning):
...     assert deprecated_func(4) == 16
>>> # or passing a func
>>> ret = np.testing.assert_warns(DeprecationWarning, deprecated_func, 4)
>>> assert ret == 16