SciPy

numpy.testing.assert_warns

numpy.testing.assert_warns(warning_class, func, *args, **kw)[source]

Fail unless the given callable throws the specified warning.

A warning of class warning_class should be thrown by the callable when invoked with arguments args and keyword arguments kwargs. If a different type of warning is thrown, it will not be caught, and the test case will be deemed to have suffered an error.

Parameters :

warning_class : class

The class defining the warning that func is expected to throw.

func : callable

The callable to test.

*args : Arguments

Arguments passed to func.

**kwargs : Kwargs

Keyword arguments passed to func.

Returns :

The value returned by `func`. :