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 中是新增的。

参数:
warning_class

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

func可调用对象,可选

要测试的可调用对象

*args参数

func 的参数。

**kwargs关键字参数

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