##// END OF EJS Templates
Refine package caching in GitHub actions. (#13985)
Refine package caching in GitHub actions. (#13985)

File last commit:

r27764:aefe51c6
r28178:e26539d6 merge
Show More
decorators.py
201 lines | 6.6 KiB | text/x-python | PythonLexer
Thomas Kluyver
Use better temp file for onlyif_unicode_paths test.
r3904 # -*- coding: utf-8 -*-
Fernando Perez
Checkpoint with more tests working....
r1420 """Decorators for labeling test objects.
Fernando Perez
Update decorators and test scripts.
r1848 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.
Fernando Perez
Checkpoint with more tests working....
r1420
Fernando Perez
Add new decorators to skip os-specific tests....
r1721 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.
Fernando Perez
Add new testing support machinery with better parametric tests....
r2368 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.
Paul Ivanov
make know failures report as 'K'...
r3511 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.
Fernando Perez
Add new testing support machinery with better parametric tests....
r2368
Fernando Perez
Checkpoint with more tests working....
r1420 """
Min RK
use py3compat.which in common locations
r21122 # Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
Fernando Perez
Add new testing support machinery with better parametric tests....
r2368
Paul Ivanov
skip tests when display variable is not set
r11970 import os
Hugo
Remove redundant Python 2 code
r24010 import shutil
import sys
Thomas Kluyver
Add test decorator onlyif_unicode_paths....
r3903 import tempfile
Fernando Perez
Add new testing support machinery with better parametric tests....
r2368 import unittest
Diego Garcia
use `import_module` instead of `__import__` ( FIX #10008 )
r22954 from importlib import import_module
Fernando Perez
Checkpoint with more tests working....
r1420
MinRK
remove decorator from external
r20813 from decorator import decorator
Fernando Perez
Checkpoint with more tests working....
r1420
Fernando Perez
Massive amount of work to improve the test suite, restores doctests....
r2414 # Expose the unittest-driven decorators
Thomas Kluyver
Use explicit relative imports...
r13347 from .ipunittest import ipdoctest, ipdocstring
Fernando Perez
Massive amount of work to improve the test suite, restores doctests....
r2414
Fernando Perez
Add new testing support machinery with better parametric tests....
r2368 #-----------------------------------------------------------------------------
# Classes and functions
#-----------------------------------------------------------------------------
Fernando Perez
Checkpoint with more tests working....
r1420
Fernando Perez
Add new testing support machinery with better parametric tests....
r2368 # Simple example of the basic idea
def as_unittest(func):
"""Decorator to make a simple function into a normal test via unittest."""
class Tester(unittest.TestCase):
def test(self):
func()
Tester.__name__ = func.__name__
return Tester
Fernando Perez
Checkpoint with more tests working....
r1420
# Utility functions
Fernando Perez
Update decorators and test scripts.
r1848 def skipif(skip_condition, msg=None):
Nikita Kniazev
Remove iptest and other Nose-dependent code
r27042 """Make function raise SkipTest exception if skip_condition is true
Fernando Perez
Update decorators and test scripts.
r1848
Parameters
Fernando Perez
Update docs for automatic API building.
r1850 ----------
Thomas Kluyver
Various docs fixes
r13595
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.
Fernando Perez
Update decorators and test scripts.
r1848 msg : string
Thomas Kluyver
Various docs fixes
r13595 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.
Nikita Kniazev
Remove iptest and other Nose-dependent code
r27042 """
if msg is None:
msg = "Test skipped due to test condition."
import pytest
assert isinstance(skip_condition, bool)
return pytest.mark.skipif(skip_condition, reason=msg)
Fernando Perez
Update decorators and test scripts.
r1848
Jason Grout
Fix typo in comment (insert space)
r6177 # A version with the condition set to true, common case just to attach a message
Fernando Perez
Update decorators and test scripts.
r1848 # to a skip decorator
def skip(msg=None):
"""Decorator factory - mark a test function for skipping from test suite.
Fernando Perez
Add new decorators to skip os-specific tests....
r1721
Fernando Perez
Add new testing support machinery with better parametric tests....
r2368 Parameters
----------
Fernando Perez
Add optional message to @skip test decorator.
r1560 msg : string
Optional message to be added.
Fernando Perez
Update decorators and test scripts.
r1848
Fernando Perez
Add new testing support machinery with better parametric tests....
r2368 Returns
-------
Fernando Perez
Update decorators and test scripts.
r1848 decorator : function
Decorator, which, when applied to a function, causes SkipTest
to be raised, with the optional message added.
Fernando Perez
Add optional message to @skip test decorator.
r1560 """
Matthias Bussonnier
Fix skip decorator....
r25097 if msg and not isinstance(msg, str):
raise ValueError('invalid object passed to `@skip` decorator, did you '
'meant `@skip()` with brackets ?')
return skipif(True, msg)
Gael Varoquaux
Fix tests when ipdoctest nose plugin is enable (Grrr, no isolation at...
r1505
Fernando Perez
Fix error in test decorator.
r1577
Fernando Perez
Add new @onlyif decorator, the reverse of @skipif....
r2452 def onlyif(condition, msg):
"""The reverse from skipif, see skipif for details."""
Nikita Kniazev
Remove iptest and other Nose-dependent code
r27042 return skipif(not condition, msg)
Fernando Perez
Add new @onlyif decorator, the reverse of @skipif....
r2452
Fernando Perez
Update decorators and test scripts.
r1848 #-----------------------------------------------------------------------------
# Utility functions for decorators
Paul Ivanov
skip sympy tests if sympy not installed
r3504 def module_not_available(module):
"""Can module be imported? Returns true if module does NOT import.
Fernando Perez
Fix error in test decorator.
r1577
Paul Ivanov
skip sympy tests if sympy not installed
r3504 This is used to make a decorator to skip tests that require module to be
Fernando Perez
Update decorators and test scripts.
r1848 available, but delay the 'import numpy' to test execution time.
"""
try:
Diego Garcia
use `import_module` instead of `__import__` ( FIX #10008 )
r22954 mod = import_module(module)
Paul Ivanov
skip sympy tests if sympy not installed
r3504 mod_not_avail = False
Fernando Perez
Update decorators and test scripts.
r1848 except ImportError:
Paul Ivanov
skip sympy tests if sympy not installed
r3504 mod_not_avail = True
Fernando Perez
Update decorators and test scripts.
r1848
Paul Ivanov
remove unnecessary yield
r3505 return mod_not_avail
Fernando Perez
Update decorators and test scripts.
r1848
Paul Ivanov
skip tests when display variable is not set
r11970
Fernando Perez
Update decorators and test scripts.
r1848 #-----------------------------------------------------------------------------
# Decorators for public use
Fernando Perez
Add new decorators to skip os-specific tests....
r1721 # Decorators to skip certain tests on specific platforms.
Fernando Perez
Merging upstream changes from trunk (after fixing small conflicts).
r1872 skip_win32 = skipif(sys.platform == 'win32',
Fernando Perez
Update decorators and test scripts.
r1848 "This test does not run under Windows")
MinRK
check linux with startswith('linux') instead of =='linux2'...
r4138 skip_linux = skipif(sys.platform.startswith('linux'),
Fernando Perez
Merging upstream changes from trunk (after fixing small conflicts).
r1872 "This test does not run under Linux")
skip_osx = skipif(sys.platform == 'darwin',"This test does not run under OS X")
Fernando Perez
Update decorators and test scripts.
r1848
Jorgen Stenarson
Moved skip decorator to testing and created similar ones for OSX and linux, create delete testdirs in module setup/teardown
r1803 # Decorators to skip tests if not on specific platforms.
Fernando Perez
Merging upstream changes from trunk (after fixing small conflicts).
r1872 skip_if_not_win32 = skipif(sys.platform != 'win32',
"This test only runs under Windows")
MinRK
check linux with startswith('linux') instead of =='linux2'...
r4138 skip_if_not_linux = skipif(not sys.platform.startswith('linux'),
Fernando Perez
Merging upstream changes from trunk (after fixing small conflicts).
r1872 "This test only runs under Linux")
Paul Ivanov
skip tests when display variable is not set
r11970
_x11_skip_cond = (sys.platform not in ('darwin', 'win32') and
Paul Ivanov
use get, for when DISPLAY variable isn't defined
r12135 os.environ.get('DISPLAY', '') == '')
Paul Ivanov
skip tests when display variable is not set
r11970 _x11_skip_msg = "Skipped under *nix when X11/XOrg not available"
skip_if_no_x11 = skipif(_x11_skip_cond, _x11_skip_msg)
Fernando Perez
Merging upstream changes from trunk (after fixing small conflicts).
r1872 # Other skip decorators
Fernando Perez
Update decorators and test scripts.
r1848
MinRK
add generic @skip_without(mod) test decorator
r5146 # generic skip without module
skip_without = lambda mod: skipif(module_not_available(mod), "This test requires %s" % mod)
Jens Hedegaard Nielsen
Add skipif_not_matplotlib decorator
r4788
MinRK
add generic @skip_without(mod) test decorator
r5146 skipif_not_numpy = skip_without('numpy')
skipif_not_matplotlib = skip_without('matplotlib')
Fernando Perez
Fixes for test suite in win32 when all dependencies (esp. Twisted) are...
r2461 # A null 'decorator', useful to make more readable code that needs to pick
# between different decorators based on OS or other conditions
null_deco = lambda f: f
Thomas Kluyver
Add test decorator onlyif_unicode_paths....
r3903
# Some tests only run where we can use unicode paths. Note that we can't just
# check os.path.supports_unicode_filenames, which is always False on Linux.
try:
Thomas Kluyver
Use better temp file for onlyif_unicode_paths test.
r3904 f = tempfile.NamedTemporaryFile(prefix=u"tmp€")
Thomas Kluyver
Add test decorator onlyif_unicode_paths....
r3903 except UnicodeEncodeError:
unicode_paths = False
else:
unicode_paths = True
Thomas Kluyver
Use better temp file for onlyif_unicode_paths test.
r3904 f.close()
Thomas Kluyver
Add test decorator onlyif_unicode_paths....
r3903
onlyif_unicode_paths = onlyif(unicode_paths, ("This test is only applicable "
"where we can use unicode in filenames."))
Takafumi Arakaki
Add tests for IPython.lib.latextools
r7858
def onlyif_cmds_exist(*commands):
"""
Decorator to skip test when at least one of `commands` is not found.
"""
Matthias Bussonnier
remove some iptest legacy code.
r27358 assert (
os.environ.get("IPTEST_WORKING_DIR", None) is None
), "iptest deprecated since IPython 8.0"
Takafumi Arakaki
Add tests for IPython.lib.latextools
r7858 for cmd in commands:
Nikita Kniazev
Fix onlyif_cmds_exist skip message
r26967 reason = f"This test runs only if command '{cmd}' is installed"
Hugo
Remove redundant Python 2 code
r24010 if not shutil.which(cmd):
Matthias Bussonnier
remove some iptest legacy code.
r27358 import pytest
Matthias Bussonnier
make skip also skip with pytest
r26185
Matthias Bussonnier
remove some iptest legacy code.
r27358 return pytest.mark.skip(reason=reason)
Takafumi Arakaki
Add tests for IPython.lib.latextools
r7858 return null_deco