numpy 1.22.4 Pypi GitHub Homepage
Other Docs
NotesParametersReturns
knownfailureif(fail_condition, msg=None)

Make function raise KnownFailureException exception if given condition is true.

If the condition is a callable, it is used at runtime to dynamically make the decision. This is useful for tests that may require costly imports, to delay the cost until the test suite is actually executed.

Notes

The decorator itself is decorated with the nose.tools.make_decorator function in order to transmit function name, and various other metadata.

Parameters

fail_condition : bool or callable

Flag to determine whether to mark the decorated test as a known failure (if True) or not (if False).

msg : str, optional

Message to give on raising a KnownFailureException exception. Default is None.

Returns

decorator : function

Decorator, which, when applied to a function, causes KnownFailureException to be raised when :None:None:`fail_condition` is True, and the function to be called normally otherwise.

deprecated

This decorator is retained for compatibility with the nose testing framework, which is being phased out. Please use the nose2 or pytest frameworks instead.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


GitHub : /numpy/testing/_private/decorators.py#191
type: <class 'function'>
Commit: