numpy.testing.assert_warns#

testing.assert_warns(warning_class, *args, **kwargs)[源代码]#

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

当使用参数 args 和关键字参数 kwargs 调用时,应该抛出一个类 warning_class 的警告.如果抛出不同类型的警告,将不会被捕获.

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

with assert_warns(SomeWarning):
    do_something()

作为上下文管理器使用的能力是在 NumPy v1.11.0 中新增的.

在 1.4.0 版本加入.

参数:
warning_classclass

定义 func 预期抛出的警告的类.

func可调用,可选

可调用以进行测试

*args参数

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
On this page