testing.decorators

Module: testing.decorators

Extend numpy’s decorators to use nipy’s gui and data labels.

Functions

nipy.testing.decorators.if_datasource(ds, msg)

nipy.testing.decorators.if_example_data(f)

nipy.testing.decorators.if_templates(f)

nipy.testing.decorators.make_label_dec(label, ds=None)

Factory function to create a decorator that applies one or more labels.

Parameters:

labelstr or sequence

One or more labels that will be applied by the decorator to the functions it decorates. Labels are attributes of the decorated function with their value set to True.

dsstr

An optional docstring for the resulting decorator. If not given, a default docstring is auto-generated.

Returns:

ldecfunction

A decorator.

Examples

>>> slow = make_label_dec('slow')
>>> print(slow.__doc__)
Labels a test as 'slow'

>>> rare = make_label_dec(['slow','hard'],
... "Mix labels 'slow' and 'hard' for rare tests")
>>> @rare
... def f(): pass
...
>>>
>>> f.slow
True
>>> f.hard
True

nipy.testing.decorators.needs_mpl_agg(func)

Decorator requiring matplotlib with agg backend

nipy.testing.decorators.needs_review(msg)

Skip a test that needs further review.

Parameters:

msgstring

msg regarding the review that needs to be done