LU04c - Test überspringen

Auf einen Blick
Manchmal soll ein Test bewusst nicht laufen: weil die Funktion noch nicht fertig ist oder weil der Test nur auf einem bestimmten Betriebssystem Sinn ergibt. Mit skip und skipif überspringt PyTest solche Tests und meldet sie in der Zusammenfassung mit s.

Lernziele

Sie können

Warum Tests überspringen?

Mit pytest werden alle Tests eines Projekts ausgeführt. Es gibt aber gute Gründe, einzelne Tests auszulassen:

@pytest.mark.skip

Dieser Dekorator überspringt den Test in jedem Fall. Mit reason geben Sie eine Begründung an.

import pytest
 
 
@pytest.mark.skip
def test_foo():
    ...
 
 
@pytest.mark.skip(reason='Funktion noch nicht fertig')
def test_bar():
    ...

@pytest.mark.skipif

Hier geben Sie eine Bedingung an. Ist sie erfüllt, wird der Test übersprungen.

import sys
import pytest
 
 
@pytest.mark.skipif(sys.version_info < (3, 10), reason='benötigt Python 3.10 oder neuer')
def test_match_statement():
    ...
 
 
@pytest.mark.skipif(sys.platform == 'win32', reason='nur unter macOS und Linux')
def test_file_permissions():
    ...

pytest.skip() innerhalb des Tests

Manchmal zeigt sich erst während der Vorbereitung, dass ein Test nicht sinnvoll laufen kann, zum Beispiel weil Testdaten fehlen. Dann rufen Sie pytest.skip() im Test auf. Die weiteren Anweisungen werden nicht mehr ausgeführt.

import pytest
 
 
def test_energy_price(test_values):
    if 'energy_price' not in test_values:
        pytest.skip('In "testdata.json" fehlt der Wert "energy_price".')
    assert float(test_values['energy_price']) > 0

Diese Variante eignet sich auch für Bedingungen, die zu kompliziert für skipif sind.

Übersprungene Tests in der Ausgabe

Übersprungene Tests erscheinen als s. Mit der Option -rs zeigt PyTest am Schluss auch die Begründung:

$ pytest -rs
test_main.py s..                                                        [100%]
=========================== short test summary info ============================
SKIPPED [1] test_main.py:4: Funktion noch nicht fertig
========================= 2 passed, 1 skipped in 0.02s =========================

Ein übersprungener Test prüft nichts. Vergessen Sie skip nicht in einem fertigen Projekt. Für Tests von Code, der noch nicht fertig ist, ist xfail meist die bessere Wahl: PyTest meldet dann, sobald der Code funktioniert (siehe LU04d).

Kontrollfragen

  1. Was ist der Unterschied zwischen @pytest.mark.skip und @pytest.mark.skipif?
  2. Schreiben Sie den Dekorator für einen Test, der nur unter Windows laufen soll.
  3. Wann verwenden Sie pytest.skip() innerhalb der Testfunktion statt eines Dekorators?
  4. Warum ist ein übersprungener Test in einem abgeschlossenen Projekt ein Warnsignal?

Marcel Suter