Jeśli unikałeś pisania testów, ponieważ wydawało Ci się to uciążliwe, ten samouczek dotyczący testów Pythona powinien zmienić Twoje zdanie. Pytest usuwa większość ceremonii: nie ma klas, z których można dziedziczyć, ani żadnych specjalnych metod potwierdzania do zapamiętania. Test może składać się tylko z dwóch linii.

Zbudujemy mały koszyk i przetestujemy go krok po kroku. Uruchomiliśmy wszystko w Pythonie 3.13 z pytestem 9.2, a pokazane dane wyjściowe są prawdziwe, chociaż przycięliśmy ścieżki plików i szczegóły taktowania, które będą się różnić na twoim komputerze.

Dlaczego pytest?

Python jest dostarczany z unittest, co działa dobrze, ale pytest jest zwykle wygodniejszym wyborem. Oto ta sama kontrola w każdym przypadku:

Pytest może również uruchomić istniejące unittest testy, dzięki czemu możesz przełączać się stopniowo. Ma również duży ekosystem wtyczek, w tym pytest-cov dla zasięgu i pytest-xdist dla przebiegów równoległych.

Zainstaluj pytest

Najpierw utwórz środowisko wirtualne, jak wyjaśniono w naszym samouczku dotyczącym środowiska wirtualnego Pythona, a następnie zainstaluj je:

pip install pytest
pytest --version

# pytest 9.2.0

Utwórz folder projektu zawierający dwa pliki, cart.py i test_cart.py. Pytest znajduje testy automatycznie, stosując następujące zasady nazewnictwa: pliki o nazwach test_*.py lub *_test.py, funkcje zaczynające się od test i klasy zaczynające się od Test. Jeśli test nie zostanie odebrany, pierwszą rzeczą do sprawdzenia jest niezgodność nazewnictwa.

Kod do przetestowania

# 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)

Twoje pierwsze testy

# test_cart.py
from cart import Cart

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

To kompletny test. Uruchom pytest z folderu projektu i zgłosi jeden test pozytywny. Jeśli pojawi się błąd importu, uruchom go jako python -m pytest, co spowoduje dodanie bieżącego folderu do ścieżki importu.

Błędy w czytaniu

Tutaj pytest naprawdę błyszczy. Oto test z celowo błędną wartością oczekiwaną:

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

A oto co wyświetliło się po uruchomieniu:

    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 ==============================

> oznacza błędną linię, a E linie pokazują rzeczywiste wartości. Nie musiałeś dodawać niestandardowej wiadomości, ponieważ pytest przepisuje assert instrukcje, aby mogli zgłosić to, co porównali. Robi to samo z listami i słownikami, wskazując dokładnie, które elementy się różnią.

Testowanie wyjątków

Obsługa błędów to także zachowanie i zasługuje na testy. pytest.raises przechodzi tylko wtedy, gdy blok zgłosi oczekiwany wyjątek:

import pytest

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

Opcjonalny argument match sprawdza wiadomość przy użyciu wyrażenia regularnego, więc inny argument ValueError nie zostanie przekazany przez przypadek. Aby dowiedzieć się, jak zgłaszać i obsługiwać takie błędy, przeczytaj nasz przewodnik po obsłudze wyjątków w Pythonie.

Oprawy: konfiguracja wielokrotnego użytku

Większość testów wymaga najpierw czegoś przygotowanego. urządzenie to funkcja, która je udostępnia. Udekoruj go @pytest.fixture, a każdy test, który nazwie go jako argument, otrzyma wynik:

@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

Każdy test domyślnie otrzymuje nowy koszyk, więc testy nie mogą na siebie wpływać. Pytest dopasowuje nazwę argumentu do nazwy urządzenia i nigdy nie wywołujesz tego urządzenia samodzielnie. @pytest.fixture to dekorator, co wyjaśnimy w Wyjaśnienie dekoratorów Pythona.

Oczyszczanie z wydajnością

Użyj yield zamiast return, jeśli chcesz później posprzątać. Kod po yield jest uruchamiany po zakończeniu testu, nawet jeśli zakończył się niepowodzeniem:

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

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

Uruchomienie z -s w celu wyświetlenia wydruku potwierdziło, że zamówienie zostało otwarte, przetestuj, a następnie zamknij.

Zakres urządzeń i conftest.py

Domyślnie urządzenie uruchamia się raz na test. W przypadku kosztownej konfiguracji, takiej jak baza danych lub przeglądarka, zmień jej czas życia za pomocą scope:

Umieść urządzenia używane przez kilka plików w pliku o nazwie conftest.py. Pytest ładuje go automatycznie, więc testy mogą używać jego urządzeń bez importu. Należy jednak zachować ostrożność w przypadku zakresów współdzielonych, ponieważ zmiana dokonana w jednym teście może przedostać się do następnego.

Parametryzacja: jeden test, wiele danych wejściowych

Zamiast kopiować test dla każdej wartości, wymień przypadki:

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

Każdy wiersz staje się osobnym testem, co można zobaczyć w pełnych wynikach naszego uruchomienia całego pliku:

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 ==============================

Jeśli jeden wiersz ulegnie awarii, pozostałe nadal działają, a nazwa dokładnie informuje, które wartości spowodowały problem. Zauważ, że połączyliśmy parametryzację z urządzeniem cart. Aby wybrać wartości, które prawdopodobnie znajdą błędy, użyj analizy wartości granicznych.

Przydatne wbudowane elementy wyposażenia

Pytest zawiera kilka gotowych urządzeń. Te dwa są szczególnie przydatne i oba przeszły w naszym biegu:

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 przydziela każdemu testowi unikalny folder tymczasowy, więc testy nigdy nie dotykają prawdziwych plików. monkeypatch zmienia zmienne środowiskowe lub atrybuty i cofa zmianę po zakończeniu testu. Innym przydatnym jest capsys, który przechwytuje wydruki, abyś mógł je sprawdzić.

Znaczniki: pomiń i xfail

Markery dodają etykiety i zachowania do testów:

@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 w ogóle nie przeprowadza testu. xfail uruchamia go, ale spodziewa się awarii, więc znany problem nie zakłóca kompilacji. Z innymi dodatkowymi testami w tym samym pliku, nasz przebieg podsumowano jako 3 passed, 1 skipped, 1 xfailed. Nawiasem mówiąc, ten test zaokrąglania naprawdę zawodzi: w arytmetyce zmiennoprzecinkowej 0,1 + 0,2 to nie dokładnie 0,3. Użyj pytest.approx(0.3) przy porównywaniu ułamków dziesiętnych.

Możesz także utworzyć własne znaczniki, takie jak @pytest.mark.slow i uruchamiać tylko te z pytest -m slow lub pominąć je za pomocą -m "not slow". Zarejestruj niestandardowe znaczniki w pliku konfiguracyjnym, aby uniknąć ostrzeżeń.

Przydatne flagi wiersza poleceń

Uruchamianie pytestu w CI

Testy są najcenniejsze, gdy uruchamiają się automatycznie przy każdej zmianie. Minimalne zadanie GitHub Actions wygląda następująco:

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 kończy działanie z niezerowym kodem, gdy testy kończą się niepowodzeniem, co powoduje zatrzymanie potoku. Nie wykonaliśmy tego pliku przepływu pracy, więc dostosuj go do swojego projektu. Szczegóły znajdziesz w naszym przewodniku CI/CD dotyczącym działań w GitHub. Pytest sprawdza się również dobrze w testach przeglądarek, jak pokazują nasze samouczek Selenium Python i samouczek dotyczący modelu obiektu strony.

Podsumowanie

Masz teraz to, czego potrzebujesz do większości zestawów testów Pythona: zwykłe potwierdzenia, urządzenia do konfiguracji, parametryzacja dla odmian i kilka flag zwiększających szybkość. Zacznij od małych rzeczy. Wybierz jedną funkcję, w której ostatnio naprawiłeś błąd, i najpierw napisz test pod kątem tego błędu. Jeśli nie masz pewności, co przetestować na każdym poziomie, przeczytaj o testowaniu jednostkowym a integracyjnym.

Najczęstsze pytania

Ucz się dalej