numpy.testing.decorators
index
/usr/lib/python2.6/dist-packages/numpy/testing/decorators.py

Decorators for labeling test objects
 
Decorators that merely return a modified version of the original
function object are straightforward.  Decorators that return a new
function object need to use
nose.tools.make_decorator(original_function)(decorator) in returning
the decorator, in order to preserve metadata such as function name,
setup and teardown functions and so on - see nose.tools for more
information.

 
Functions
       
knownfailureif(fail_condition, msg=None)
Make function raise KnownFailureTest exception if fail_condition is true
 
 Parameters
 ----------
 fail_condition : bool or callable.
     Flag to determine whether to mark test as known failure (True)
     or not (False).  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.
 msg : string
     Message to give on raising a KnownFailureTest exception
 
Returns
-------
decorator : function
    Decorator, which, when applied to a function, causes SkipTest
    to be raised when the skip_condition was True, and the function
    to be called normally otherwise.
 
 Notes
 -----
 You will see from the code that we had to further decorate the
 decorator with the nose.tools.make_decorator function in order to
 transmit function name, and various other metadata.
setastest(tf=True)
Signals to nose that this function is or is not a test
 
Parameters
----------
tf : bool
    If True specifies this is a test, not a test otherwise
 
e.g
>>> from numpy.testing.decorators import setastest
>>> @setastest(False)
... def func_with_test_in_name(arg1, arg2): pass
...
>>>
 
This decorator cannot use the nose namespace, because it can be
called from a non-test module. See also istest and nottest in
nose.tools
skipif(skip_condition, msg=None)
Make function raise SkipTest exception if skip_condition is true
 
 Parameters
 ----------
 skip_condition : bool or callable.
     Flag to determine whether to skip test.  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.
 msg : string
     Message to give on raising a SkipTest exception
 
Returns
-------
decorator : function
    Decorator, which, when applied to a function, causes SkipTest
    to be raised when the skip_condition was True, and the function
    to be called normally otherwise.
 
 Notes
 -----
 You will see from the code that we had to further decorate the
 decorator with the nose.tools.make_decorator function in order to
 transmit function name, and various other metadata.
slow(t)
Labels a test as 'slow'.
 
The exact definition of a slow test is obviously both subjective and
hardware-dependent, but in general any individual test that requires more
than a second or two should be labeled as slow (the whole suite consits of
thousands of tests, so even a second is significant).

 
Data
        __file__ = '/usr/lib/python2.6/dist-packages/numpy/testing/decorators.pyc'
__name__ = 'numpy.testing.decorators'