Nếu bạn tránh viết bài kiểm thử vì cảm thấy chúng như một công việc vặt thì hướng dẫn về pytest này sẽ khiến bạn thay đổi suy nghĩ. Pytest loại bỏ hầu hết nghi lễ: không có lớp nào để kế thừa và không có phương pháp xác nhận đặc biệt nào cần ghi nhớ. Một bài kiểm tra có thể chỉ có hai dòng.

Chúng tôi sẽ xây dựng một giỏ hàng nhỏ và thử nghiệm nó từng bước một. Chúng tôi đã chạy mọi thứ trên Python 3.13 với pytest 9.2 và kết quả hiển thị là có thật, mặc dù chúng tôi đã cắt bớt đường dẫn tệp và chi tiết thời gian sẽ khác nhau trên máy của bạn.

Tại sao pytest?

Python đi kèm với unittest, hoạt động tốt, nhưng pytest thường là lựa chọn thuận tiện hơn. Đây là cách kiểm tra giống nhau trong mỗi:

Pytest cũng có thể chạy các bài kiểm tra unittest hiện có của bạn để bạn có thể chuyển đổi dần dần. Nó cũng có một hệ sinh thái plugin lớn, bao gồm pytest-cov để bao phủ và pytest-xdist để chạy song song.

Cài đặt pytest

Trước tiên, hãy tạo một môi trường ảo, như được giải thích trong Hướng dẫn về môi trường ảo Python của chúng tôi, sau đó cài đặt nó:

pip install pytest
pytest --version

# pytest 9.2.0

Tạo một thư mục dự án chứa hai tệp cart.py và test_cart.py. Pytest tự động tìm các bài kiểm tra bằng cách tuân theo các quy tắc đặt tên: các tệp có tên test_*.py hoặc *_test.py, các hàm bắt đầu bằng test và các lớp bắt đầu bằng Test. Nếu bài kiểm tra không được chọn, việc đặt tên không khớp là điều đầu tiên cần kiểm tra.

Mã để kiểm tra

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

Những bài kiểm tra đầu tiên của bạn

# test_cart.py
from cart import Cart

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

Đó là một bài kiểm tra hoàn chỉnh. Chạy pytest từ thư mục dự án và nó báo cáo một bài kiểm tra đã vượt qua. Nếu bạn gặp lỗi nhập, hãy chạy nó dưới dạng python -m pytest, thao tác này sẽ thêm thư mục hiện tại vào đường dẫn nhập.

Lỗi đọc

Đây là nơi pytest thực sự tỏa sáng. Đây là một thử nghiệm với giá trị mong đợi sai có chủ ý:

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

Và đây là những gì nó in ra khi chúng tôi chạy nó:

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

Dòng > đánh dấu dòng bị lỗi và dòng E hiển thị các giá trị thực tế. Bạn không cần phải thêm thông báo tùy chỉnh vì pytest viết lại các câu lệnh assert để chúng có thể báo cáo những gì chúng so sánh. Nó thực hiện tương tự đối với danh sách và từ điển, chỉ ra chính xác những mục nào khác nhau.

Kiểm tra ngoại lệ

Xử lý lỗi cũng là hành vi và nó đáng được kiểm tra. pytest.raises chỉ vượt qua nếu khối đưa ra ngoại lệ dự kiến:

import pytest

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

Đối số match tùy chọn sẽ kiểm tra thông báo bằng cách sử dụng biểu thức chính quy, do đó, một ValueError khác sẽ không vô tình bị bỏ qua. Để tìm hiểu cách phát hiện và xử lý các lỗi như thế này, hãy đọc hướng dẫn của chúng tôi về Xử lý ngoại lệ Python.

Đồ đạc: thiết lập có thể tái sử dụng

Hầu hết các bài kiểm tra đều cần chuẩn bị thứ gì đó trước tiên. fixture là một chức năng cung cấp nó. Trang trí nó bằng @pytest.fixture và bất kỳ thử nghiệm nào đặt tên nó làm đối số sẽ nhận được kết quả:

@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

Theo mặc định, mỗi bài kiểm tra sẽ có một giỏ hàng mới nên các bài kiểm tra không thể ảnh hưởng lẫn nhau. Pytest khớp tên đối số với tên của vật cố định và bạn không bao giờ tự gọi vật cố định. @pytest.fixture là một trình trang trí, được chúng tôi giải thích trong Các trình trang trí Python được giải thích.

Dọn dẹp với năng suất

Sử dụng yield thay vì return khi bạn cần dọn dẹp sau đó. Mã sau yield chạy khi quá trình kiểm tra kết thúc, ngay cả khi nó thất bại:

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

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

Chạy với -s để hiển thị kết quả in ra xác nhận rằng lệnh đã được mở, kiểm tra rồi đóng.

Phạm vi cố định và conftest.py

Theo mặc định, lịch thi đấu chạy một lần cho mỗi lần kiểm tra. Đối với thiết lập đắt tiền, chẳng hạn như cơ sở dữ liệu hoặc trình duyệt, hãy thay đổi thời gian tồn tại của nó bằng scope:

Đặt các thiết bị cố định được nhiều tệp sử dụng vào một tệp có tên conftest.py. Pytest tự động tải nó nên các bài kiểm tra có thể sử dụng các thiết bị cố định của nó mà không cần nhập. Tuy nhiên, hãy cẩn thận với phạm vi được chia sẻ vì thay đổi được thực hiện bởi một thử nghiệm có thể bị rò rỉ sang thử nghiệm tiếp theo.

Tham số hóa: một thử nghiệm, nhiều đầu vào

Thay vì sao chép bài kiểm tra cho từng giá trị, hãy liệt kê các trường hợp:

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

Mỗi hàng sẽ trở thành bài kiểm tra riêng và bạn có thể thấy điều này trong kết quả chi tiết từ quá trình chạy tệp hoàn chỉnh của chúng tôi:

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

Nếu một hàng bị lỗi, các hàng khác vẫn chạy và tên cho bạn biết chính xác giá trị nào đã gây ra sự cố. Lưu ý rằng chúng tôi đã kết hợp tham số hóa với bộ cố định cart. Để chọn các giá trị có khả năng tìm thấy lỗi, hãy sử dụng phân tích giá trị biên.

Đồ đạc tích hợp hữu ích

Pytest bao gồm một số đồ đạc làm sẵn. Hai cái này đặc biệt hữu ích và cả hai đều vượt qua trong lần chạy của chúng tôi:

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 cung cấp cho mỗi bài kiểm tra một thư mục tạm thời duy nhất, do đó các bài kiểm tra không bao giờ chạm vào các tệp thực. monkeypatch thay đổi các biến hoặc thuộc tính môi trường và hoàn tác thay đổi khi quá trình kiểm tra kết thúc. Một tính năng hữu ích khác là capsys, ghi lại kết quả in để bạn có thể kiểm tra.

Điểm đánh dấu: bỏ qua và xfail

Điểm đánh dấu thêm nhãn và hành vi vào bài kiểm tra:

@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 hoàn toàn không chạy thử nghiệm. xfail chạy nó nhưng dự kiến ​​sẽ thất bại, vì vậy một sự cố đã biết sẽ không làm hỏng bản dựng của bạn. Với các thử nghiệm bổ sung khác trong cùng một tệp, quá trình chạy của chúng tôi được tóm tắt là 3 passed, 1 skipped, 1 xfailed. Nhân tiện, bài kiểm tra làm tròn đó thực sự không thành công: trong số học dấu phẩy động, 0,1 + 0,2 không chính xác là 0,3. Sử dụng pytest.approx(0.3) khi so sánh số thập phân.

Bạn cũng có thể tạo điểm đánh dấu của riêng mình, chẳng hạn như @pytest.mark.slow và chỉ chạy những điểm có pytest -m slow hoặc bỏ chúng đi bằng -m "not slow". Đăng ký các điểm đánh dấu tùy chỉnh trong tệp cấu hình của bạn để tránh cảnh báo.

Cờ dòng lệnh hữu ích

Chạy pytest trong CI

Các thử nghiệm có giá trị nhất khi chúng chạy tự động sau mỗi thay đổi. Một công việc GitHub Actions tối thiểu trông như thế này:

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 thoát với mã khác 0 khi kiểm tra thất bại, đây là nguyên nhân khiến đường ống dừng lại. Chúng tôi không thực thi tệp quy trình công việc này, vì vậy hãy điều chỉnh nó cho phù hợp với dự án của bạn. Hướng dẫn CI/CD GitHub Actions của chúng tôi giải thích chi tiết. Pytest cũng hoạt động tốt cho các thử nghiệm trình duyệt, như Hướng dẫn về Selenium Python và Hướng dẫn về Mô hình đối tượng trang của chúng tôi.

Lời kết

Giờ đây, bạn đã có những thứ mình cần cho hầu hết các bộ thử nghiệm Python: xác nhận đơn giản, đồ đạc cố định để thiết lập, tham số hóa cho các biến thể và một vài cờ cho tốc độ. Bắt đầu nhỏ. Chọn một chức năng mà bạn vừa sửa một lỗi và viết bài kiểm tra lỗi đó trước. Nếu bạn không chắc chắn nên kiểm tra cái gì ở mỗi cấp độ, hãy đọc phần kiểm thử đơn vị và kiểm thử tích hợp.

Câu hỏi thường gặp

Tiếp tục học hỏi