Add changelog entry and update docs for importorskip

This commit is contained in:
Bruno Oliveira 2019-01-05 12:55:39 -02:00
parent be7eb22e88
commit 0c4898670c
2 changed files with 10 additions and 3 deletions

View File

@ -0,0 +1,2 @@
``pytest.importorskip`` now supports a ``reason`` parameter, which will be shown when the
requested module cannot be imported.

View File

@ -138,9 +138,14 @@ xfail.Exception = XFailed
def importorskip(modname, minversion=None, reason=None):
""" return imported module if it has at least "minversion" as its
__version__ attribute. If no minversion is specified the a skip
is only triggered if the module can not be imported.
"""Imports and returns the requested module ``modname``, or skip the current test
if the module cannot be imported.
:param str modname: the name of the module to import
:param str minversion: if given, the imported module ``__version__`` attribute must be
at least this minimal version, otherwise the test is still skipped.
:param str reason: if given, this reason is shown as the message when the module
cannot be imported.
"""
import warnings