Skipping tests

Python TDD with pytest (5 Part Series)

1 Python TDD with Pytest — Getting Started
2 Asserting Exceptions with Pytest
3 Capturing print statements while debugging
4 Skipping tests
5 Writing DRYer tests using Pytest parametrize

Sometimes you might want to skip a particular test while executing others for some reason. Maybe the database guy isn’t done setting up and that particular test requires a database connection. Instead of having to wait, you can just write the test and instruct pytest to skip it, giving the appropriate reason so it doesn’t look like you just skipped a failing test to keep your test suite green.

There’s a couple of ways to do this. The simplest is to use the @pytest.mark.skip decorator like so:

import pytest

def test_stuff(): # this test will be executed     pass

@pytest.mark.skip(reason="just testing if skip works")
def test_other_stuff(): # this one will be skipped     pass

Enter fullscreen mode Exit fullscreen mode

Running your tests should produce the output below:

collected 2 items
skip.py .s                           [100%]

===================== 1 passed, 1 skipped in 0.05 seconds ===============

Enter fullscreen mode Exit fullscreen mode

Notice the little s. It shows the test that was skipped. Pytest also tells us that 1 passed, 1 skipped. If you need a more verbose output, you can use the -rs flag pytest skip.py -rs:

collected 2 items
skip.py .s                    [100%]
==================== short test summary info ===============
SKIP [1] skip.py:14: just testing if skip works

=================== 1 passed, 1 skipped in 0.02 seconds ==========

Enter fullscreen mode Exit fullscreen mode

The test above was skipped even before it started. This isn’t always ideal. You can have more control over how the test is skipped by using the pytest.skip(reason) function:

import pytest

def setup_stuff():
    return False

def test_stuff(): # this test will be executed     pass

def test_other_stuff(): # this one will be skipped if setup_stuff() returns false     if not setup_stuff():
        pytest.skip("setup failed")
    else:
        pass

Enter fullscreen mode Exit fullscreen mode

collected 2 items
skip.py .s                  [100%]
=================== short test summary info =============================
SKIP [1] skip.py:12: setup failed

==================== 1 passed, 1 skipped in 0.05 seconds =================

Enter fullscreen mode Exit fullscreen mode

If you prefer to check that the condition is satisfied before the test starts, then you can use skipif:

import pytest

def setup_stuff():
    return False

def test_stuff(): # this test will be executed     pass

@pytest.mark.skipif(not setup_stuff(), reason="setup failed")
def test_other_stuff(): # this one will be skipped if setup_stuff() returns false     pass

Enter fullscreen mode Exit fullscreen mode

collected 2 items
skip.py .s                  [100%]
=================== short test summary info =============================
SKIP [1] skip.py:12: setup failed

==================== 1 passed, 1 skipped in 0.05 seconds =================

Enter fullscreen mode Exit fullscreen mode

There are many other ways you can customize your tests to skip depending on certain conditions as explained in the docs.

Python TDD with pytest (5 Part Series)

1 Python TDD with Pytest — Getting Started
2 Asserting Exceptions with Pytest
3 Capturing print statements while debugging
4 Skipping tests
5 Writing DRYer tests using Pytest parametrize

原文链接：Skipping tests