ó æNXc@srdZddlZddlZddlZddlZddlmZddlmZmZddl Tddl m Z m Z d„Z d „Zdd „Zdd „Zdd „Zd „Zd„Zd„ZeejdkdƒZeejjdƒdƒZeejdkdƒZeejdkdƒZeejjdƒ dƒZeejdkdƒZejd+ko‹ejjddƒdkZ dZ!ee e!ƒZ"d„Z#d„Z$e$dƒZ%e$dƒZ&e$d ƒZ'e(e)d!ƒZ*e(ej+d"d#kd$ƒZ,d%„Z-yej.d&d'ƒZ/Wne0k r<e1Z2nXe)Z2e/j3ƒee2d(ƒZ4d)„Z5d*„Z6dS(,sDecorators 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. This module provides a set of useful decorators meant to be ready to use in your own tests. See the bottom of the file for the ready-made ones, and if you find yourself writing a new one that may be of generic use, add it here. Included decorators: Lightweight testing that remains unittest-compatible. - An @as_unittest decorator can be used to tag any normal parameter-less function as a unittest TestCase. Then, both nose and normal unittest will recognize it as such. This will make it easier to migrate away from Nose if we ever need/want to while maintaining very lightweight tests. NOTE: This file contains IPython-specific decorators. Using the machinery in IPython.external.decorators, we import either numpy.testing.decorators if numpy is available, OR use equivalent code in IPython.external._decorators, which we've copied verbatim from numpy. iÿÿÿÿN(t decoratori(t ipdoctestt ipdocstring(t*(t string_typestwhichcs/dtjf‡fd†ƒY}ˆj|_|S(sDDecorator to make a simple function into a normal test via unittest.tTestercseZ‡fd†ZRS(cs ˆƒdS(N((tself(tfunc(sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyttest<s(t__name__t __module__R ((R(sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyR;s(tunittesttTestCaseR (RR((RsR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyt as_unittest9s cCs+ddl}t||jj|ƒ|ƒƒS(s…Apply a wrapper to a function for decoration. This mixes Michele Simionato's decorator tool with nose's make_decorator, to apply a wrapper in a decorator so that all nose attributes, as well as function signature and other properties, survive the decoration cleanly. This will ensure that wrapped functions can still be well introspected via IPython, for example. iÿÿÿÿN(t nose.toolsRttoolstmake_decorator(twrapperRtnose((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyt apply_wrapperEs cs€t|tƒr|g‰n|‰d„}xˆD]}t||tƒq1W‡fd†}|dkrsd|}n||_|S(s Factory function to create a decorator that applies one or more labels. Parameters ---------- label : string 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. ds : string An optional docstring for the resulting decorator. If not given, a default docstring is auto-generated. Returns ------- A decorator. Examples -------- A simple labeling decorator: >>> slow = make_label_dec('slow') >>> slow.__doc__ "Labels a test as 'slow'." And one that uses multiple labels and a custom docstring: >>> rare = make_label_dec(['slow','hard'], ... "Mix labels 'slow' and 'hard' for rare tests.") >>> rare.__doc__ "Mix labels 'slow' and 'hard' for rare tests." Now, let's test using this one: >>> @rare ... def f(): pass ... >>> >>> f.slow True >>> f.hard True cSsdS(N(tNone(((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyt‡scs%xˆD]}t||tƒqW|S(N(tsetattrtTrue(tftlabel(tlabels(sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytdecorŒs sLabels a test as %r.N(t isinstanceRRRRt__doc__(RtdsttmpR((RsR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytmake_label_decSs-      cs‡‡fd†}|S(sœ 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. cs©ddl‰tˆƒr!ˆ‰n‡fd†‰dd„‰‡‡‡‡‡fd†}‡‡‡‡‡fd†}ˆjjˆƒr|}n|}ˆjjˆƒ|ƒS(NiÿÿÿÿcsˆS(N(((tskip_condition(sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyRÁscSs,|dkrd}n|}d|j|fS(s;Skip message with information about function being skipped.s#Test skipped due to test condition.sSkipping test: %s. %sN(RR (Rtmsgtout((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytget_msgÃs cs5ˆƒr$ˆjˆˆˆƒƒ‚n ˆ||ŽSdS(s"Skipper for normal test functions.N(tSkipTest(targstkwargs(RR%RR#tskip_val(sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyt skipper_funcËs c?sGˆƒr$ˆjˆˆˆƒƒ‚nxˆ||ŽD] }|Vq4WdS(sSkipper for test generators.N(R&(R'R(tx(RR%RR#R)(sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyt skipper_genÒs (RtcallableRtutilt isgeneratorRR(RR*R,tskipper(R"R#(RR%RR)sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytskip_decorator¸s      ((R"R#R1((R#R"sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytskipifœs*cCs tt|ƒS(sYDecorator factory - mark a test function for skipping from test suite. Parameters ---------- msg : string Optional message to be added. Returns ------- decorator : function Decorator, which, when applied to a function, causes SkipTest to be raised, with the optional message added. (R2R(R#((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytskipæscs:tˆƒr‡fd†}n‡fd†}t||ƒS(s0The reverse from skipif, see skipif for details.csˆƒ S(N(((t condition(sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyRüscsˆ S(N(((R4(sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyRþs(R-R2(R4R#R"((R4sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytonlyiføs cCs4yt|ƒ}t}Wntk r/t}nX|S(s×Can module be imported? Returns true if module does NOT import. This is used to make a decorator to skip tests that require module to be available, but delay the 'import numpy' to test execution time. (t __import__tFalset ImportErrorR(tmoduletmodt mod_not_avail((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytmodule_not_availables     cCsd„}||_||ƒS(sÏReturn a dummy function decorated with dec, with the given name. Examples -------- import IPython.testing.decorators as dec setup = dec.decorated_dummy(dec.skip_if_no_x11, __name__) cSsdS(N(R(((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyRs(R (tdectnametdummy((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytdecorated_dummys  twin32s$This test does not run under Windowstlinuxs"This test does not run under Linuxtdarwins!This test does not run under OS Xs!This test only runs under WindowssThis test only runs under LinuxsThis test only runs under OSXtDISPLAYts.Skipped under *nix when X11/XOrg not availablecCstrtt|ƒSdS(N(t_x11_skip_condR@tskip_if_no_x11R(R>((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytskip_file_no_x11:scCstt|ƒd|ƒS(NsThis test requires %s(R2R<(R:((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyR@stnumpyt matplotlibtsympysThis test is known to failiis'This test is known to fail on Python 3.cCs|S(N((R((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pyROstprefixutmp€sCThis test is only applicable where we can use unicode in filenames.cGs4x-|D]%}t|ƒstdj|ƒƒSqWtS(sN Decorator to skip test when at least one of `commands` is not found. s1This test runs only if command '{0}' is installed(RR3tformatt null_deco(tcommandstcmd((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytonlyif_cmds_exist_s    cGs4x|D]}t|ƒrtSqWtdj|ƒƒS(sL Decorator to skip test unless at least one of `commands` is found. s;This test runs only if one of the commands {0} is installed(RRNR3RM(RORP((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytonlyif_any_cmd_existsis    (sdarwinswin32(7RtsystosttempfileR Rt ipunittestRRtIPython.external.decoratorstIPython.utils.py3compatRRRRRR!R2R3R5R<R@tplatformt skip_win32t startswitht skip_linuxtskip_osxtskip_if_not_win32tskip_if_not_linuxtskip_if_not_osxtenvirontgetRFt _x11_skip_msgRGRHt skip_withouttskipif_not_numpytskipif_not_matplotlibtskipif_not_sympytknownfailureifRtskip_known_failuret version_infotknown_failure_py3RNtNamedTemporaryFileRtUnicodeEncodeErrorR7t unicode_pathstclosetonlyif_unicode_pathsRQRR(((sR/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/testing/decorators.pytsb       I J