Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
modul:m450:learningunits:lu03:pytest [2024/11/19 10:05] – [Resultate mit Fliesskommazahlen] msutermodul:m450:learningunits:lu03:pytest [2026/11/17 07:56] (aktuell) – Fehler bei pytest.approx korrigiert, Testsuche, Ausführen, Lernziele, Kontrollfragen, Kompetenz-Tags admin
Zeile 1: Zeile 1:
 ====== LU03b - PyTest ====== ====== LU03b - PyTest ======
- +<WRAP center round info 80%> 
-<WRAP center round info 60%> +**Auf einen Blick**\\ 
-PyTest ist ein Test-Framework basierend auf Python. +[[https://docs.pytest.org/|PyTest]] ist das verbreitetste Test-Framework für Python. 
-Es eignet sich vor allem, um die Schnittstellen einzelner Funktionen zu testen.+Ein Test ist eine gewöhnliche Funktion, deren Name mit ''test_'' beginnt. Darin vergleicht ''assert'' das IST mit dem SOLL. 
 +PyTest findet alle Tests selbständig, führt sie aus und meldet, welche bestanden haben.
 </WRAP> </WRAP>
  
-===== Einstieg ===== +===== Lernziele ===== 
-Die Nutzung von PyTest in unserer IDE PyCharm ist relativ einfach.+Sie können 
 +  * PyTest in einem Projekt installieren, 
 +  * Testdateien und Testfunktionen so benennen, dass PyTest sie findet, 
 +  * Unit Tests mit ''assert'' schreiben und ausführen, 
 +  * Fliesskommazahlen mit ''pytest.approx'' vergleichen.
  
-==== Paket "pytest" installieren ==== +===== Installation ===== 
-Zuerst musst du das Paket ''pytest'' im Virtual Environment deines Projekts installieren. +PyTest wird im Virtual Environment des Projekts installiert. So bleiben die Pakete verschiedener Projekte voneinander getrennt.
-Gehe in den Tab ''Terminal'' von PyCharm. +
-Achte auf die Anzeige ''(venv) ...'' am Anfang des Prompts. +
-<code> +
-(venv) PS C:\BZZ\Python\MyProject>  +
-</code> +
-Falls diese Anzeige fehlt, musst du die virtuelle Umgebung zuerst aktivieren. +
-Gib dazu unter Windows den Befehl ''.\venv\Scripts\activate.ps1'' ein.+
  
-Nun kannst du pytest installieren. +Öffnen Sie in PyCharm den Tab **Terminal** und prüfen Sie, ob am Anfang der Zeile ''(venv)'' oder ''(.venv)'' steht. 
-<code> +Falls nicht, aktivieren Sie die virtuelle Umgebung:
-(venv) PS C:\BZZ\Python\MyProject> pip3 install pytest +
-</code>+
  
-Ich empfehle dir, die Pakete immer im Virtual Environment zu installieren. +^ Betriebssystem       ^ Befehl                           ^ 
-Dadurch gibt es weniger Probleme mit der Kompatiblität verschiedener Projekte.+| Windows (PowerShell) | ''.\.venv\Scripts\Activate.ps1''  | 
 +| macOS / Linux        | ''source .venv/bin/activate''    |
  
-==== Modul für Testfälle ==== +Danach installieren Sie PyTest: 
-Nachdem pytest installiert ist, erstellst du ein neues Modul (Python File) für deine Tests. +<code> 
-Als Dateinamen ergänze ich den Namen des zu testenden Moduls (z.B. main.py) um ''test_'' (z.B. test_main.py). +(.venv) PS C:\BZZ\Python\MyProject> pip install pytest
- +
-==== Unit Tests ==== +
- +
-Die einzelnen Unit Tests werden als Funktionen in Python programmiert. +
-Zum Beispiel: +
- +
-<code python> +
-def test_normal(): +
-    result = factorial(7) +
-    assert result == 5040+
 </code> </code>
  
-  * Der Funktionsname für den Test muss mit ''test_'' beginnen. Andernfalls erkennt ''pytest'' die Funktion nicht. +<WRAP center round tip 80%> 
-  * Wir rufen die zu testende Funktion (im Beispiel ''factorial'') mit den Testdaten auf. +Je nach Projekt heisst der Ordner ''venv'' oder ''.venv''. Passen Sie den Befehl entsprechend an. 
-  * Der Befehl ''assert'' vergleicht das tatsächliche Resultat mit dem erwarteten Resultat.+</WRAP>
  
-=== Assert === +===== Wie findet PyTest die Tests? ===== 
-Der Befehl ''assert'' ist eine spezielle Bedingung, die wir zum Testen und Debuggen von Code verwenden. +PyTest durchsucht den Projektordner nach Tests. Dabei gelten diese Regeln:
-Falls die Bedingung erfüllt ist, wird nichts gemacht. +
-Sonst wird eine ''AssertionError''-Exception geworfen. +
-Wir könnten das gleiche Resultat auch mit ''if''/''else'' erreichen:+
  
-^ assert ^ if / else ^ +^ Was                 ^ Regel                                                  ^ Beispiel                                   ^ 
-| <code python>assert result == 5040</code> | <code python> +| Testdatei           | Name beginnt mit ''test_'' **oder** endet mit ''_test.py'' | ''test_factorial.py'' oder ''main_test.py'' | 
-if result == 5040: +| Testfunktion        | Name beginnt mit ''test''                              | ''def test_zero():''                       | 
-    pass +| Testklasse (optional) | Name beginnt mit ''Test'', hat keinen Konstruktor     | ''class TestBankAccount:''                 | 
-else: + 
-    raise AssertionError +<WRAP center round important 80%> 
-</code> |+Heisst eine Funktion ''check_zero()'' statt ''test_zero()'', wird sie **nicht** ausgeführt und PyTest meldet keinen Fehler. Der Test fehlt dann einfach. 
 +</WRAP>
  
-===== Beispiel ===== +In den GitHub-Classroom-Aufträgen dieses Moduls liegen die Tests meistens in ''main_test.py''. Für eigene Projekte empfehlen wir ''test_<modulname>.py''.
-Anhand dieses einfachen Beispiels siehst du, wie eine Python-Funktion getestet werden kann.+
  
 +===== Ein erster Unit Test =====
 ==== factorial.py ==== ==== factorial.py ====
-Dieses Modul enthält eine Funktion um die Fakultät einer Zahl zu berechnen.+Dieses Modul berechnet die Fakultät einer Zahl.
  
 <code python> <code python>
Zeile 75: Zeile 60:
  
 ==== test_factorial.py ==== ==== test_factorial.py ====
-Dieses Modul enhält meine Unit Tests. 
 <code python> <code python>
 from factorial import factorial from factorial import factorial
Zeile 83: Zeile 67:
     result = factorial(7)     result = factorial(7)
     assert result == 5040     assert result == 5040
-    + 
 def test_zero(): def test_zero():
     result = factorial(0)     result = factorial(0)
-    assert result == 1 +    assert result == 1
 </code> </code>
  
-===== Resultate mit Fliesskommazahlen ===== +  * Die Testdatei importiert die Funktion, die getestet wird. 
-Bei Berechnungen mit Fliesskommazahlen gibt es immer kleine Abweichungen bei den Resultaten. +  * Jeder Test ruft die Funktion mit Testdaten auf (**Act**) und prüft das Ergebnis (**Assert**). 
-Daher würde der Befehl ''assert'' häufig Fehler melden, obwohl das Resultat grundsätzlich korrekt ist.+  * Pro Testfall gibt es eine eigene Testfunktion. So sieht man im Ergebnis sofort, welcher Fall fehlschlägt.
  
-Um diesem Problem zu begegnen, gibt es die Funktion [[https://docs.pytest.org/en/7.1.x/reference/reference.html#pytest-approx|pytest.approx()]]. +===== Tests ausführen ===== 
-Diese Funktion vergleicht die Werte unter Berücksichtigung einer geringen Toleranz. +^ Wo                  ^ Wie                                                                                   ^ 
-Beim Aufruf der Funktion muss zwingend das erwartete Resultat mitgegeben werden. +| Terminal            | ''pytest'' führt alle Tests aus, ''pytest -v'' zeigt jeden Test einzeln an.            | 
-Zusätzlich kennt die Funktion 3 optionale Argumente: +| Einzelne Datei      | ''pytest test_factorial.py''                                                          | 
-  * ''rel'': Erlaubte relative Abweichung. Default: 1/1'000'000 +| Einzelner Test      | ''pytest test_factorial.py::test_zero''                                               | 
-  * ''abs'': Erlaubte absolute Abweichung. Default: 1/1'000'000'000 +| PyCharm             | Grünes Dreieck neben der Testfunktion oder Rechtsklick auf die Datei → **Run 'pytest in …'** | 
-  * ''nan_ok'': Soll ''Not a Number'' erlaubt sein. Default: False+ 
 +Wie Sie das Ergebnis lesen, erfahren Sie in [[.:resultate|LU03d - Testresultate lesen]]. 
 + 
 +===== assert ===== 
 +''assert'' prüft eine Bedingung. Ist sie wahr, passiert nichts. Ist sie falsch, wird ein ''AssertionError'' ausgelöst und PyTest markiert den Test als fehlgeschlagen. 
 + 
 +^ assert ^ gleichwertig mit if / else ^ 
 +| <code python>assert result == 5040</code> | <code python> 
 +if result == 5040: 
 +    pass 
 +else: 
 +    raise AssertionError 
 +</code> | 
 + 
 +Mit ''assert'' lassen sich alle Vergleiche ausdrücken: 
 +<code python> 
 +assert result == 5040              # gleich 
 +assert result != 0                 # ungleich 
 +assert result > 0                  # grösser 
 +assert 'Anna' in names             # enthalten 
 +assert result is None              # ist None 
 +assert isinstance(result, int)     # richtiger Datentyp 
 +</code> 
 + 
 +===== Fliesskommazahlen vergleichen ===== 
 +Computer speichern Fliesskommazahlen nur ungefähr. Deshalb ergibt zum Beispiel ''0.1 + 0.2'' den Wert ''0.30000000000000004''. 
 +Ein Vergleich mit ''=='' schlägt dann fehl, obwohl das Resultat praktisch stimmt. 
 + 
 +Die Funktion [[https://docs.pytest.org/en/stable/reference/reference.html#pytest-approx|pytest.approx()]] vergleicht mit einer kleinen Toleranz: 
 + 
 +^ Argument  ^ Bedeutung                                       ^ Standardwert            ^ 
 +| ''rel''   | erlaubte **relative** Abweichung                | 1e-6 (ein Millionstel)  | 
 +| ''abs''   | erlaubte **absolute** Abweichung                | 1e-12                   | 
 +| ''nan_ok''| Darf ''NaN'' (Not a Number) gleich ''NaN'' sein? | False                   | 
 + 
 +Ein Wert gilt als gleich, wenn er **eine** der beiden Toleranzen einhält.
  
 ==== Beispiel ==== ==== Beispiel ====
-In diesem Beispiel testen wir eine Funktion, welche die Mehrwertsteuer (engl. **V**alue **A**dded **T**ax) berechnet. +Wir testen eine Funktion, welche die Mehrwertsteuer (8.1 %) berechnet. Für einen Betrag von CHF 1575.50 erwarten wir CHF 127.6155.
-Wir haben ein Total von CHF 1575.50 was gemäss Taschenrechner einer Steuer von CHF 127.6155 entspricht.+
  
 <code python> <code python>
 import pytest import pytest
 +from vat import calculate_vat
 +
  
-def calculate_vat(amount): 
-   return amount * 0.081 
-    
 def test_calculate_vat(): def test_calculate_vat():
-    total = 1575.50 +    vat = calculate_vat(1575.50) 
-    vat = calculate_vat(total) +    assert vat == pytest.approx(127.6155) 
-    pytest.approx(127.6155) == vat + 
-    + 
 +def test_calculate_vat_rappen(): 
 +    vat = calculate_vat(1575.50) 
 +    assert vat == pytest.approx(127.62, abs=0.005)
 </code> </code>
  
-Da ich hier keine Angaben für relative und absolute Abweichung gemacht habe, müsste das tatsächliche Ergebnis bis auf die zwölfte Nachkommastelle übereinstimmen. +  * Im ersten Test gilt die relative Standardtoleranz: Bei rund 127 darf das Resultat um etwa ±0.000128 abweichen. 
-===== Tutorials ===== +  * Im zweiten Test genügt es, wenn das Resultat auf den Rappen genau stimmt.
-  * [[https://www.tutorialspoint.com/pytest/index.htm|Tutorialpoints]] +
-  * [[https://www.youtube.com/watch?v=YbpKMIUjvK8|Youtube]]+
  
 +<WRAP center round important 80%>
 +Vergessen Sie das ''assert'' nicht! Die Zeile ''vat == pytest.approx(127.6155)'' allein berechnet zwar ''True'' oder ''False'', prüft aber nichts. Der Test wäre immer grün.
 +</WRAP>
 +
 +===== Kontrollfragen =====
 +  - Sie haben die Datei ''tests.py'' mit der Funktion ''test_sum()'' erstellt. PyTest meldet «no tests ran». Warum?
 +  - Mit welchem Befehl führen Sie nur den Test ''test_zero'' aus der Datei ''test_factorial.py'' aus?
 +  - Warum schreiben wir für jeden Testfall eine eigene Testfunktion?
 +  - Warum schlägt ''assert 0.1 + 0.2 == 0.3'' fehl, und wie schreiben Sie den Test richtig?
 +
 +===== Weiterführende Links =====
 +  * [[https://docs.pytest.org/en/stable/getting-started.html|PyTest: Get Started]]
 +  * [[https://docs.pytest.org/en/stable/how-to/assert.html|PyTest: Assertions]]
  
 ---- ----
-{{tag>M450-LU03}}+{{tag>M450-LU03 M450-C1I}}
 [[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/lu03/pytest.txt
  • Zuletzt geändert: 2026/11/17 07:56
  • von admin