Wenn Sie es vermieden haben, Tests zu schreiben, weil sie sich wie eine lästige Pflicht anfühlen, sollte dieses Pytest-Tutorial Ihre Meinung ändern. Pytest macht den größten Teil der Zeremonie überflüssig: Es gibt keine Klassen, von denen geerbt werden kann, und keine speziellen Assertionsmethoden, die man sich merken muss. Ein Test kann nur aus zwei Zeilen bestehen.

Wir werden einen kleinen Einkaufswagen bauen und ihn Schritt für Schritt testen. Wir haben alles auf Python 3.13 mit Pytest 9.2 ausgeführt und die angezeigte Ausgabe ist real, obwohl wir die Dateipfade und Timing-Details gekürzt haben, die auf Ihrem Computer abweichen werden.

Warum Pytest?

Python wird mit unittest ausgeliefert, was gut funktioniert, aber pytest ist normalerweise die bequemere Wahl. Hier ist jeweils derselbe Check:

Pytest kann auch Ihre vorhandenen unittest Tests ausführen, sodass Sie schrittweise umsteigen können. Es verfügt außerdem über ein großes Plugin-Ökosystem, darunter pytest-cov für die Abdeckung und pytest-xdist für parallele Ausführungen.

Installieren Sie Pytest

Erstellen Sie zunächst eine virtuelle Umgebung, wie in unserem Tutorial zur virtuellen Python-Umgebung erläutert, und installieren Sie sie dann:

pip install pytest
pytest --version

# pytest 9.2.0

Erstellen Sie einen Projektordner mit zwei Dateien, cart.py und test_cart.py. Pytest findet Tests automatisch, indem es Benennungsregeln befolgt: Dateien mit den Namen test_*.py oder *_test.py, Funktionen, die mit test beginnen, und Klassen, die mit Test beginnen. Wenn ein Test nicht abgeholt wird, ist zunächst eine Nichtübereinstimmung der Namen zu prüfen.

Der zu testende Code

# cart.py
class Cart:
    def __init__(self):
        self.items = []

    def add(self, name, price, qty=1):
        if qty < 1:
            raise ValueError("qty must be at least 1")
        self.items.append((name, price, qty))

    def total(self, discount=0):
        subtotal = sum(price * qty for _, price, qty in self.items)
        return round(subtotal * (1 - discount / 100), 2)

Deine ersten Tests

# test_cart.py
from cart import Cart

def test_empty_cart_is_free():
    assert Cart().total() == 0

Das ist ein vollständiger Test. Führen Sie pytest aus dem Projektordner aus und es wird ein bestandener Test gemeldet. Wenn Sie einen Importfehler erhalten, führen Sie ihn als python -m pytest aus, wodurch der aktuelle Ordner zum Importpfad hinzugefügt wird.

Lesefehler

Hier glänzt Pytest wirklich. Hier ist ein Test mit einem bewusst falschen Erwartungswert:

def test_wrong_total():
    c = Cart()
    c.add("Keyboard", 1500)
    assert c.total() == 1400

Und das wurde gedruckt, als wir es ausgeführt haben:

    def test_wrong_total():
        c = Cart()
        c.add("Keyboard", 1500)
>       assert c.total() == 1400
E       assert 1500.0 == 1400
E        +  where 1500.0 = total()

FAILED fail_example.py::test_wrong_total - assert 1500.0 == 1400
============================== 1 failed in 0.12s ==============================

Die > markiert die fehlerhafte Zeile und die E-Zeilen zeigen die tatsächlichen Werte. Sie mussten keine benutzerdefinierte Nachricht hinzufügen, da Pytest assert Anweisungen umschreibt, damit sie berichten können, was sie verglichen haben. Das Gleiche gilt für Listen und Wörterbücher, wobei genau darauf hingewiesen wird, welche Elemente sich unterscheiden.

Ausnahmen testen

Fehlerbehandlung ist ebenfalls Verhalten und verdient Tests. pytest.raises besteht nur dann, wenn der Block die erwartete Ausnahme auslöst:

import pytest

def test_rejects_zero_qty():
    with pytest.raises(ValueError, match="at least 1"):
        Cart().add("Pen", 10, qty=0)

Das optionale Argument match prüft die Nachricht mithilfe eines regulären Ausdrucks, sodass nicht versehentlich ein anderes Argument ValueError übergeben wird. Um zu erfahren, wie Sie Fehler wie diesen auslösen und behandeln, lesen Sie unseren Leitfaden zur Python-Ausnahmebehandlung.

Vorrichtungen: wiederverwendbare Einrichtung

Bei den meisten Tests muss zunächst etwas vorbereitet werden. Ein Gerät ist eine Funktion, die es bereitstellt. Dekorieren Sie es mit @pytest.fixture, und jeder Test, der es als Argument benennt, erhält das Ergebnis:

@pytest.fixture
def cart():
    c = Cart()
    c.add("Keyboard", 1500)
    c.add("Mouse", 500, qty=2)
    return c

def test_total(cart):
    assert cart.total() == 2500

Jeder Test erhält standardmäßig einen neuen Warenkorb, sodass sich die Tests nicht gegenseitig beeinflussen können. Pytest gleicht den Argumentnamen mit dem Namen des Fixtures ab, und Sie rufen das Fixture nie selbst auf. @pytest.fixture ist ein Dekorator, den wir in Python-Dekoratoren erklärt erklären.

Aufräumen mit Ertrag

Verwenden Sie yield anstelle von return, wenn Sie anschließend aufräumen müssen. Code nach yield wird ausgeführt, wenn der Test abgeschlossen ist, auch wenn er fehlgeschlagen ist:

@pytest.fixture
def temp_db():
    print("\nopen db")
    yield {"users": []}
    print("close db")

def test_db(temp_db):
    assert temp_db["users"] == []

Wenn Sie mit -s laufen, um die gedruckte Ausgabe anzuzeigen, wurde bestätigt, dass die Bestellung geöffnet war. Testen Sie sie und schließen Sie sie dann.

Fixture-Bereich und conftest.py

Standardmäßig wird ein Fixture einmal pro Test ausgeführt. Bei teuren Setups wie einer Datenbank oder einem Browser ändern Sie deren Lebensdauer mit scope:

Legen Sie Fixtures, die von mehreren Dateien verwendet werden, in einer Datei namens conftest.py ab. Pytest lädt es automatisch, sodass Tests seine Fixtures ohne Import verwenden können. Seien Sie jedoch vorsichtig bei gemeinsam genutzten Bereichen, da eine von einem Test vorgenommene Änderung in den nächsten übergehen kann.

Parametrisieren: ein Test, viele Eingaben

Anstatt für jeden Wert einen Test zu kopieren, listen Sie die Fälle auf:

@pytest.mark.parametrize("discount, expected", [
    (0, 2500),
    (10, 2250),
    (100, 0),
])
def test_discount(cart, discount, expected):
    assert cart.total(discount) == expected

Jede Zeile wird zu einem eigenen Test, und Sie können dies in der ausführlichen Ausgabe unserer Ausführung der vollständigen Datei sehen:

test_cart.py::test_total PASSED                        [ 16%]
test_cart.py::test_discount[0-2500] PASSED             [ 33%]
test_cart.py::test_discount[10-2250] PASSED            [ 50%]
test_cart.py::test_discount[100-0] PASSED              [ 66%]
test_cart.py::test_rejects_zero_qty PASSED             [ 83%]
test_cart.py::test_empty_cart_is_free PASSED           [100%]

============================== 6 passed in 0.05s ==============================

Wenn eine Zeile fehlschlägt, werden die anderen weiterhin ausgeführt, und der Name sagt Ihnen genau, welche Werte das Problem verursacht haben. Beachten Sie, dass wir parametrisieren mit der Vorrichtung cart kombiniert haben. Um Werte auszuwählen, die wahrscheinlich Fehler finden, verwenden Sie die Randwertanalyse.

Nützliche Einbauten

Pytest enthält mehrere vorgefertigte Vorrichtungen. Diese beiden sind besonders praktisch und haben in unserem Test bestanden:

def test_write_report(tmp_path):
    report = tmp_path / "report.txt"
    report.write_text("passed")
    assert report.read_text() == "passed"

def read_mode():
    return os.environ.get("APP_MODE", "dev")

def test_mode(monkeypatch):
    monkeypatch.setenv("APP_MODE", "staging")
    assert read_mode() == "staging"

tmp_path gibt jedem Test einen eindeutigen temporären Ordner, sodass Tests niemals echte Dateien berühren. monkeypatch ändert Umgebungsvariablen oder Attribute und macht die Änderung rückgängig, wenn der Test endet. Ein weiteres nützliches Tool ist capsys, das die gedruckte Ausgabe erfasst, damit Sie sie überprüfen können.

Markierungen: Skip und Xfail

Markierungen fügen Tests Beschriftungen und Verhalten hinzu:

@pytest.mark.skip(reason="payment sandbox is down")
def test_payment():
    assert False

@pytest.mark.xfail(reason="floating point")
def test_rounding():
    assert 0.1 + 0.2 == 0.3

skip führt den Test überhaupt nicht durch. xfail führt es aus, erwartet jedoch einen Fehler, sodass Ihr Build nicht durch ein bekanntes Problem beschädigt wird. Mit den anderen zusätzlichen Tests in derselben Datei wurde unser Lauf als 3 passed, 1 skipped, 1 xfailed zusammengefasst. Dieser Rundungstest schlägt übrigens tatsächlich fehl: In der Gleitkomma-Arithmetik ist 0,1 + 0,2 nicht genau 0,3. Verwenden Sie pytest.approx(0.3), wenn Sie Dezimalzahlen vergleichen.

Sie können auch eigene Markierungen erstellen, z. B. @pytest.mark.slow, und diese mit pytest -m slow nur ausführen oder sie mit -m "not slow" weglassen. Registrieren Sie benutzerdefinierte Markierungen in Ihrer Konfigurationsdatei, um Warnungen zu vermeiden.

Nützliche Befehlszeilen-Flags

Pytest in CI ausführen

Tests sind am wertvollsten, wenn sie bei jeder Änderung automatisch ausgeführt werden. Ein minimaler GitHub Actions-Job sieht so aus:

steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-python@v5
    with:
      python-version: "3.13"
  - run: pip install -r requirements.txt
  - run: python -m pytest

Pytest wird mit einem Code ungleich Null beendet, wenn Tests fehlschlagen, was dazu führt, dass die Pipeline stoppt. Wir haben diese Workflow-Datei nicht ausgeführt. Passen Sie sie daher an Ihr Projekt an. Unser GitHub Actions CI/CD-Leitfaden erklärt die Details. Pytest eignet sich auch gut für Browsertests, wie unser Selenium Python-Tutorial und unser Page Object Model-Tutorial zeigen.

Fazit

Sie haben jetzt alles, was Sie für die meisten Python-Testsuiten benötigen: einfache Asserts, Fixtures für die Einrichtung, Parametrisierung für Variationen und ein paar Flags für die Geschwindigkeit. Fangen Sie klein an. Wählen Sie eine Funktion aus, in der Sie kürzlich einen Fehler behoben haben, und schreiben Sie zunächst einen Test für diesen Fehler. Wenn Sie sich nicht sicher sind, was Sie auf den einzelnen Ebenen testen sollen, lesen Sie den Abschnitt über Einheits- und Integrationstests.

Häufige Fragen

Lerne weiter