X*dZddlZddlZddlZddlZddlmZmZdZd&dZ d&dZ d&dZ d Z d Z d Ze ejd k(d Ze ejj#ddZe ejdk(dZe ejd k7dZe ejj#d dZe ejdk7dZejdvxrej.j1dddk(ZdZe eeZdZdZedZedZedZ dZ! ejDd Z#d!Z$e#jKe e$d#Z'd$Z(d%Z)y#e&$rd"Z$YwxYw)'aDecorators 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. N) string_typeswhichc`Gfddtj}j|_|S)zDDecorator to make a simple function into a normal test via unittest.ceZdZfdZy)as_unittest..TestercyN)selffuncs E/usr/lib/python3/dist-packages/ipython_genutils/testing/decorators.pytestz as_unittest..Tester.test2s FN)__name__ __module__ __qualname__r)r srTesterr1s rr)unittestTestCaser)r rs` r as_unittestr/s'""mmFO Mrct|tr|gn|d}D]}t||dfd}|d|z}||_|S)a 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 cyr r r rrz make_label_dec..qrTc0D]}t||d|S)NT)setattr)flabellabelss rdecorzmake_label_dec..decorvs# "E AeD ! "rzLabels a test as %r.) isinstancerr__doc__)rdstmpr!r s @rmake_label_decr&=s`Z%& C E$   z #e +EM Lrcfd}|S)a 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. cddltrnfdddfd}fd}jjr|}n|}jj |S)NrcSr r )skip_conditionsrrz0skipif..skip_decorator..src4|d}n|}d|jd|S)z;Skip message with information about function being skipped.z#Test skipped due to test condition.zSkipping test: z. r)r msgouts rget_msgz/skipif..skip_decorator..get_msgs!{"GC#.2mmC@ @rcRrj|i|S)z"Skipper for normal test functions.SkipTest)argskwargsrr/r-noseskip_vals r skipper_funcz4skipif..skip_decorator..skipper_funcs-zmmGAcN33$)&))rc?nKrj|i|D]}|yw)zSkipper for test generators.Nr1)r3r4xrr/r-r5r6s r skipper_genz3skipif..skip_decorator..skipper_gens?zmmGAcN33D+F+AGs25r )r5callableutil isgeneratortoolsmake_decorator) rr7r:skipperr/r5r6r-r*s ` @@@rskip_decoratorzskipif..skip_decoratorsp  N #%H.H A * *   99  #!G"G+tzz((+G44rr )r*r-rAs`` rskipifrBs8(5T rctd|S)aYDecorator 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. T)rB)r-s rskiprDs $s rcHtrfd}nfd}t||S)z0The reverse from skipif, see skipif for details.c Sr r  conditionsrrzonlyif..s ik/rc  Sr r rGsrrzonlyif..s i-r)r;rB)rHr-r*s` ronlyifrJs$ 1/ .# &&rcfd}|S)zCan 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. c< t}y#t$rYywxYw)NFT) __import__ ImportError)modmodules rrHz'module_not_available..conditions' V$C  s  r )rPrHs` rmodule_not_availablerQs  rc&d}||_||S)zReturn 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__) cyr r r rrrz!decorated_dummy..rrr,)decnamedummys rdecorated_dummyrWs EEN u:rwin32z$This test does not run under Windowslinuxz"This test does not run under Linuxdarwinz!This test does not run under OS Xz!This test only runs under WindowszThis test only runs under LinuxzThis test only runs under OSX)rZrXDISPLAYz.Skipped under *nix when X11/XOrg not availablec2trtt|SdSr )_x11_skip_condrWskip_if_no_x11)rUs rskip_file_no_x11r`$s4B?>4 0LLrc2tt|d|zS)NzThis test requires %s)rBrQ)rOs rrr*s6"6s";=TWZ=Znumpy matplotlibsympyc|Sr r )rs rrr4sarutmp€)prefixTFzCThis test is only applicable where we can use unicode in filenames.cj|D])}t|rtdj|cStS)zN Decorator to skip test when at least one of `commands` is not found. z1This test runs only if command '{0}' is installed)rrDformat null_decocommandscmds ronlyif_cmds_existrmDs=4Sz''-vc{4 44 rcj|D]}t|stcStdj|S)zL Decorator to skip test unless at least one of `commands` is found. z;This test runs only if one of the commands {0} is installed)rrirDrhrjs ronlyif_any_cmd_existsroNs> :  %vh/ 11rr )*r#sysostempfiler py3compatrrrr&rBrDrJrQrWplatform skip_win32 startswith skip_linuxskip_osxskip_if_not_win32skip_if_not_linuxskip_if_not_osxenvirongetr^ _x11_skip_msgr_r` skip_withoutskipif_not_numpyskipif_not_matplotlibskipif_not_sympyriNamedTemporaryFiler unicode_pathscloseUnicodeEncodeErroronlyif_unicode_pathsrmror rrrs@ ,CRFT$'   CLLG+:< CLL++G48: #,,(*+N O3<<72>@s||66w??<>18:,,&996**..B/25@  6M \ ($\2(  ###95AMGGIm/MO1)Ms,E!!E+*E+