Jika Anda menghindari menulis tes karena terasa seperti sebuah tugas, tutorial pytest ini akan mengubah pikiran Anda. Pytest menghapus sebagian besar upacara: tidak ada kelas untuk diwarisi dan tidak ada metode pernyataan khusus yang perlu diingat. Sebuah tes bisa hanya dua baris.

Kami akan membuat keranjang belanja kecil dan mengujinya langkah demi langkah. Kami menjalankan semuanya di Python 3.13 dengan pytest 9.2, dan keluaran yang ditampilkan adalah nyata, meskipun kami memangkas jalur file dan detail waktu yang akan berbeda di mesin Anda.

Mengapa uji coba?

Python disertakan dengan unittest, yang berfungsi dengan baik, tetapi pytest biasanya merupakan pilihan yang lebih tepat. Berikut adalah cek yang sama di masing-masing:

Pytest juga dapat menjalankan pengujian unittest yang ada, sehingga Anda dapat beralih secara bertahap. Ia juga memiliki ekosistem plugin yang besar, termasuk pytest-cov untuk cakupan dan pytest-xdist untuk pengoperasian paralel.

Instal pytest

Buat lingkungan virtual terlebih dahulu, seperti yang dijelaskan dalam tutorial lingkungan virtual Python kami, lalu instal:

pip install pytest
pytest --version

# pytest 9.2.0

Buat folder proyek yang berisi dua file, cart.py dan test_cart.py. Pytest menemukan pengujian secara otomatis dengan mengikuti aturan penamaan: file bernama test_*.py atau *_test.py, fungsi yang dimulai dengan test, dan kelas yang dimulai dengan Test. Jika tes tidak diambil, ketidakcocokan penamaan adalah hal pertama yang harus diperiksa.

Kode untuk diuji

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

Tes pertamamu

# test_cart.py
from cart import Cart

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

Itu adalah ujian yang lengkap. Jalankan pytest dari folder proyek, dan ini melaporkan satu tes yang lulus. Jika Anda mendapatkan kesalahan impor, jalankan sebagai python -m pytest, yang menambahkan folder saat ini ke jalur impor.

Kegagalan membaca

Di sinilah pytest benar-benar bersinar. Berikut adalah tes dengan nilai yang diharapkan salah:

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

Dan inilah yang tercetak saat kami menjalankannya:

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

Tanda > menandai garis gagal, dan garis E menunjukkan nilai sebenarnya. Anda tidak perlu menambahkan pesan khusus, karena pytest menulis ulang pernyataan assert sehingga mereka dapat melaporkan apa yang mereka bandingkan. Hal yang sama berlaku untuk daftar dan kamus, menunjukkan item mana yang berbeda.

Pengecualian pengujian

Penanganan kesalahan juga merupakan perilaku, dan perlu diuji. pytest.raises lolos hanya jika blok tersebut memunculkan pengecualian yang diharapkan:

import pytest

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

Argumen opsional match memeriksa pesan menggunakan ekspresi reguler, sehingga ValueError yang berbeda tidak akan lewat begitu saja. Untuk mempelajari cara memunculkan dan menangani kesalahan seperti ini, baca panduan kami tentang penanganan pengecualian Python.

Perlengkapan: pengaturan yang dapat digunakan kembali

Kebanyakan tes memerlukan sesuatu yang dipersiapkan terlebih dahulu. perlengkapan adalah fungsi yang menyediakannya. Hiasi dengan @pytest.fixture, dan tes apa pun yang menamainya sebagai argumen akan menerima hasilnya:

@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

Setiap pengujian mendapat keranjang baru secara default, sehingga pengujian tidak dapat memengaruhi satu sama lain. Pytest mencocokkan nama argumen dengan nama perlengkapan, dan Anda tidak pernah memanggil perlengkapan itu sendiri. @pytest.fixture adalah dekorator, yang kami jelaskan di penjelasan dekorator Python.

Pembersihan dengan hasil

Gunakan yield daripada return ketika Anda perlu membersihkan setelahnya. Kode setelah yield berjalan ketika pengujian selesai, meskipun gagal:

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

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

Berjalan dengan -s untuk menampilkan hasil cetakan yang mengonfirmasi bahwa pesanan telah dibuka, diuji, lalu ditutup.

Cakupan perlengkapan dan conftest.py

Secara default, perlengkapan berjalan satu kali per pengujian. Untuk pengaturan yang mahal, seperti database atau browser, ubah masa pakainya dengan scope:

Masukkan perlengkapan yang digunakan oleh beberapa file ke dalam file bernama conftest.py. Pytest memuatnya secara otomatis, sehingga pengujian dapat menggunakan perlengkapannya tanpa impor. Namun berhati-hatilah dengan cakupan bersama, karena perubahan yang dilakukan pada satu pengujian dapat bocor ke pengujian berikutnya.

Parameterisasi: satu pengujian, banyak masukan

Daripada menyalin pengujian untuk setiap nilai, buatlah daftar kasusnya:

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

Setiap baris menjadi pengujiannya sendiri, dan Anda dapat melihatnya dalam keluaran verbose dari proses keseluruhan file kami:

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

Jika satu baris gagal, baris lainnya tetap berjalan, dan namanya memberi tahu Anda nilai mana yang menyebabkan masalah. Perhatikan bahwa kami menggabungkan parameterisasi dengan perlengkapan cart. Untuk memilih nilai yang kemungkinan besar menemukan bug, gunakan analisis nilai batas.

Perlengkapan bawaan yang berguna

Pytest mencakup beberapa perlengkapan siap pakai. Keduanya sangat berguna, dan keduanya lolos dalam proses kami:

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 memberikan setiap pengujian folder sementara yang unik, sehingga pengujian tidak pernah menyentuh file sebenarnya. monkeypatch mengubah variabel atau atribut lingkungan, dan membatalkan perubahan saat pengujian berakhir. Yang berguna lainnya adalah capsys, yang menangkap hasil cetakan sehingga Anda dapat memeriksanya.

Penanda: lewati dan xgagal

Penanda menambahkan label dan perilaku ke pengujian:

@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 tidak menjalankan tes sama sekali. xfail menjalankannya tetapi mengharapkan kegagalan, sehingga masalah yang diketahui tidak merusak build Anda. Dengan pengujian tambahan lainnya dalam file yang sama, proses kami diringkas sebagai 3 passed, 1 skipped, 1 xfailed. Omong-omong, tes pembulatan itu benar-benar gagal: dalam aritmatika floating point, 0,1 + 0,2 tidak persis 0,3. Gunakan pytest.approx(0.3) saat membandingkan desimal.

Anda juga dapat membuat penanda Anda sendiri, seperti @pytest.mark.slow, dan menjalankan penanda tersebut dengan pytest -m slow saja, atau mengabaikannya dengan -m "not slow". Daftarkan penanda khusus di file konfigurasi Anda untuk menghindari peringatan.

Bendera baris perintah yang berguna

Menjalankan pytest di CI

Pengujian menjadi sangat berharga jika dijalankan secara otomatis pada setiap perubahan. Pekerjaan GitHub Actions minimal terlihat seperti ini:

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 keluar dengan kode bukan nol ketika pengujian gagal, yang menyebabkan pipeline berhenti. Kami tidak menjalankan file alur kerja ini, jadi sesuaikan dengan proyek Anda. Panduan CI/CD Tindakan GitHub kami menjelaskan detailnya. Pytest juga berfungsi dengan baik untuk pengujian browser, seperti yang ditunjukkan dalam Tutorial Selenium Python dan Tutorial Model Objek Halaman kami.

Penutup

Anda sekarang memiliki apa yang Anda perlukan untuk sebagian besar rangkaian pengujian Python: pernyataan sederhana, perlengkapan untuk penyiapan, parameterisasi untuk variasi, dan beberapa tanda untuk kecepatan. Mulailah dari yang kecil. Pilih satu fungsi yang baru-baru ini Anda perbaiki bugnya dan tulis tes untuk bug tersebut terlebih dahulu. Jika Anda tidak yakin apa yang harus diuji di setiap level, baca tentang pengujian unit vs integrasi.

Pertanyaan yang sering diajukan

Teruslah belajar