PyTest: skip entire module/file (python 2 and 3)

Question

I want to skip an entire test if imports don't work:

try:
  import networkx
except:
  import pytest
  pytest.skip()

This works fine with python-2.7 and python-3.5, both using pytest-2.8.1. When I try to run the code in python-3.6 with pytest-3.0.5 I get the following error:

Using pytest.skip outside of a test is not allowed. If you are trying to decorate a test function, use the @pytest.mark.skip or @pytest.mark.skipif decorators instead.

How can I write code/tests that works on all mentioned environments? I already tried to rewrite the except block like this but then it only works for the newest configuration:

try:
  pytest.skip()
except:
  pytestmark = pytest.mark.skip

score 21 · Accepted Answer · edited Jun 16 '21 at 15:53

21

A more straightforward solution would be to use pytest.importorskip instead.

edited Jun 16 '21 at 15:53

Matthew Strawbridge

19,940
10
72
93

answered Feb 28 '17 at 23:14

The Compiler

11,126
4
40
54

This is also an elegant solution. I don't know how to specify, e.g. `from networkx.algorithms import bipartite` with `importorskip`, though. – mattmilten Mar 01 '17 at 07:25
1

`bipartite = pytest.importorskip("networkx.algorithms").bipartite` (or just do the import separately after `importorskip`) – The Compiler Mar 01 '17 at 11:09
That link mentions `skipif` instruction just below it. – ArekBulski Feb 08 '18 at 21:57

score 17 · Answer 2 · answered Feb 25 '22 at 11:08

17

You can use pytest.skip with allow_module_level=True to skip the remaining tests of a module:

pytest.skip(allow_module_level=True)

See example in: https://docs.pytest.org/en/latest/how-to/skipping.html#skipping-test-functions

answered Feb 25 '22 at 11:08

Conchylicultor

4,631
2
37
40

score 10 · Answer 3 · answered Feb 28 '17 at 15:03

10

I figured it out myself. The skip block needs to check the version of pytest:

if pytest.__version__ < "3.0.0":
  pytest.skip()
else:
  pytestmark = pytest.mark.skip

answered Feb 28 '17 at 15:03

mattmilten

6,242
3
35
65

1

out of curiosity: Why do you need your testsuite to work with pytest 2.8.1 too? – The Compiler Feb 28 '17 at 23:14
3

I like my code to be as backward-compatible as possible and this was just the version I had installed on another machine. – mattmilten Mar 01 '17 at 07:21

PyTest: skip entire module/file (python 2 and 3)

3 Answers3