Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
modul:m450:learningunits:lu04:skip [2025/03/27 09:14] – kmaurizimodul:m450:learningunits:lu04:skip [2026/11/17 08:03] (aktuell) – Aktualisiert: Doku-Links, Beispiel für pytest.skip vereinfacht, Ausgabe -rs, Lernziele, Kontrollfragen, Kompetenz-Tags admin
Zeile 1: Zeile 1:
 ====== LU04c - Test überspringen ====== ====== LU04c - Test überspringen ======
- +<WRAP center round info 80%> 
-<WRAP center round info 60%> +**Auf einen Blick**\\ 
-Je nach Situation oder Umgebung wollen wir einzelne Tests nicht durchführen. +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. 
-Mittels ''skip'' können wir einen Test überspringen.+Mit ''skip'' und ''skipif'' überspringt PyTest solche Tests und meldet sie in der Zusammenfassung mit ''s''.
 </WRAP> </WRAP>
  
-//Siehe auch [[https://docs.pytest.org/en/6.2.x/skipping.html|PyTest - Skipping]]//+===== Lernziele ===== 
 +Sie können 
 +  * einen Test mit ''@pytest.mark.skip'' immer überspringen, 
 +  * einen Test mit ''@pytest.mark.skipif'' abhängig von einer Bedingung überspringen, 
 +  * ''pytest.skip()'' innerhalb eines Tests einsetzen, 
 +  * begründen, wann ''skip'' und wann ''xfail'' ([[.:xfail|LU04d]]) die bessere Wahl ist.
  
-Wenn wir im Terminal ''pytest'' eingeben, werden alle Tests innerhalb unseres Projekt durchgeführt. +===== Warum Tests überspringen? ===== 
-Es gibt jedoch gute Gründe, weshalb ein Test nicht ausgeführt werden soll. +Mit ''pytest'' werden alle Tests eines Projekts ausgeführt. Es gibt aber gute Gründe, einzelne Tests auszulassen: 
-Vielleicht ist die Funktion die getestet werden soll noch gar nicht fertig programmiert. +  * Die Funktion ist noch nicht programmiert. Der Test würde ständig fehlschlagen, obwohl wir das schon wissen. 
-Dann würde der Test ständig als fehlerhaft angezeigt, obwohl wir dies schon im vorhinein wussten. +  * Der Test ist nur unter Windows sinnvoll und kann unter macOS oder Linux gar nicht laufen. 
-Andere Tests machen vielleicht nur in einer bestimmten Umgebung überhaupt Sinn. +  * Der Test braucht ein Paket oder eine Python-Version, die nicht überall vorhanden ist.
-Zum Beispiel könnte ein Test nur unter Windows relevant sind und kann unter Linux gar nicht ausgeführt werden.+
  
-===== Decorator ===== +===== @pytest.mark.skip ===== 
- +Dieser Dekorator überspringt den Test in jedem Fall. Mit ''reason'' geben Sie eine Begründung an.
-==== @pytest.mark.skip ==== +
-Die einfachste Möglichkeit zum Überspringen eines Tests ist der Decorator ''@pytest.mark.skip'' +
-Damit wird dieser Test in jedem Fall übersprungen. +
-Dieser Dekorator ist sinnvoll, wenn die zu testende Funktion noch fehlerhaft ist und der Test aktuell immer scheitern würde.+
  
 <code python> <code python>
 +import pytest
 +
 +
 @pytest.mark.skip @pytest.mark.skip
 def test_foo(): def test_foo():
-   ... +    ... 
-    + 
-@pytest.mark.skip(reason='test currently impossible')+ 
 +@pytest.mark.skip(reason='Funktion noch nicht fertig')
 def test_bar(): def test_bar():
     ...     ...
 </code> </code>
  
-''skip'' hat einen optionalen Parameter ''reason='...' '' mit dem wir eine Begründung angeben können. +===== @pytest.mark.skipif ===== 
-Diese Begründung wird dann in der Zusammenfassung von PyTest angezeigt. +Hier geben Sie eine Bedingung an. Ist sie erfüllt, wird der Test übersprungen.
- +
-==== @pytest.mark.skipif ==== +
-Der Dekorator ''@pytest.mark.skipif'' erlaubt es uns eine Bedingung anzugeben. +
-Ist diese Bedingung erfüllt, so wird der Test übersprungen. +
-Dadurch können wir zum Beispiel einen Test abhängig von der Python-Version ausführen oder nicht.+
  
 <code python> <code python>
 import sys import sys
 +import pytest
  
  
-@pytest.mark.skipif(sys.version_info < (3, 7), reason='requires python3.7 or higher') +@pytest.mark.skipif(sys.version_info < (3, 10), reason='benötigt Python 3.10 oder neuer') 
-def test_function():+def test_match_statement(): 
 +    ... 
 + 
 + 
 +@pytest.mark.skipif(sys.platform == 'win32', reason='nur unter macOS und Linux') 
 +def test_file_permissions():
     ...     ...
 </code> </code>
  
-===== Innerhalb der Funktion ===== +===== pytest.skip() innerhalb des Tests ===== 
-Nebst den Dekorators können wir ''pytest.skip'' auch innerhalb der Testfunktion aufrufen. +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.
-Tritt zum Beispiel beim Vorbereiten des Tests ein Problem auf, können wir die weitere Ausführung des Tests überspringen. +
-Auch bei relativ komplexen Bedingungen ist diese Variante besser geeignet als der Dekorator mit ''pytest.mark.skipif''.+
  
-/*TODO SuMa - Beispiel*/ 
 <code python> <code python>
-def test_setup(monkeypatch, capsys, test_values): +import pytest
-    if isinstance(test_values, dict) and \ +
-            isinstance(test_values['energy_price'], float) and \ +
-            isinstance(test_values['client1'], str) and \ +
-            isinstance(test_values['client2'], str) and \ +
-            isinstance(test_values['client3'], str): +
-        print('\tSetup erfolgreich') +
-    else: +
-        pytest.skip('\tDie Datei "testdata.json" fehlt oder ist fehlerhaft. Kontaktieren Sie Ihre Lehrperson.')+
  
  
-@pytest.fixture +def test_energy_price(test_values): 
-def test_values(): +    if 'energy_price' not in test_values: 
-    try: +        pytest.skip('In "testdata.json" fehlt der Wert "energy_price".') 
-        with open('./testdata.json') as json_file: +    assert float(test_values['energy_price']) > 0 
-            data = json.load(json_file) +</code>
-            data['energy_price'] = float(data['energy_price']) +
-            return data +
-    except FileNotFoundError: +
-        return 'Die Datei "testdata.json" fehlt. Kontaktieren Sie Ihre Lehrperson'+
  
 +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:
 +
 +<code>
 +$ 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 =========================
 </code> </code>
 +
 +<WRAP center round important 80%>
 +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 [[.:xfail|LU04d]]).
 +</WRAP>
 +
 +===== Kontrollfragen =====
 +  - Was ist der Unterschied zwischen ''@pytest.mark.skip'' und ''@pytest.mark.skipif''?
 +  - Schreiben Sie den Dekorator für einen Test, der nur unter Windows laufen soll.
 +  - Wann verwenden Sie ''pytest.skip()'' innerhalb der Testfunktion statt eines Dekorators?
 +  - Warum ist ein übersprungener Test in einem abgeschlossenen Projekt ein Warnsignal?
 +
 +===== Weiterführende Links =====
 +  * [[https://docs.pytest.org/en/stable/how-to/skipping.html|PyTest: How to use skip and xfail]]
  
 ---- ----
-{{tag>M450-LU04}}+{{tag>M450-LU04 M450-C1A}}
 [[https://creativecommons.org/licenses/by-nc-sa/4.0/|{{https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png}}]] Marcel Suter [[https://creativecommons.org/licenses/by-nc-sa/4.0/|{{https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png}}]] Marcel Suter
 +
  • modul/m450/learningunits/lu04/skip.txt
  • Zuletzt geändert: 2026/11/17 08:03
  • von admin