Giới thiệu

Doctest là một phương pháp kiểm tra đơn giản nhưng hữu ích cho các chương trình Python. So với bài kiểm tra đơn vị , doctest không yêu cầu tập lệnh độc lập để viết các trường hợp kiểm thử. Các trường hợp kiểm thử chỉ có thể được viết bằng thông tin doc (nội dung trong ba dấu nháy đơn / kép) của một hàm Python. Sau đó, những trường hợp này có thể kiểm tra chức năng bằng cách sử dụng doctestmô-đun.

Các doctesttìm kiếm mô-đun cho đoạn văn bản mà trông giống như phiên Python tương tác, và sau đó thực hiện những phiên để xác minh rằng họ làm việc chính xác như được hiển thị. ( tài liệu python )

Một ví dụ đơn giản

Hãy sử dụng doctest cho một abs()chức năng sai :

Kết quả như sau:

Như ví dụ trên cho thấy, doctest thực sự là một cách thuận tiện và đơn giản để kiểm tra chức năng.

Tóm lại, chỉ có 3 bước:

• nhập doctestmô-đun
• viết các trường hợp thử nghiệm trong ba dấu nháy đơn / kép bằng cách sử dụng
• sử dụng doctest.testmod()để chạy học thuyết

Nếu tất cả các trường hợp kiểm tra được thông qua, doctestsẽ không in gì.

Các mẹo khác của Doctest

1. Để in thêm thông tin

Trong doctest.testmod, có một tham số quan trọng được gọi là verbose.

Nó được đặt thành Falsemặc định, có nghĩa là khi chạy thử nghiệm, chỉ những trường hợp không thành công mới xuất ra thông tin chi tiết. Nếu bạn muốn nhận đầy đủ thông tin của mọi trường hợp, chỉ cần đặt nó thành True.

if __name__ == '__main__':
    doctest.testmod(verbose=True)

Trên thực tế, chúng tôi không phải viết if __name__ == '__main__':khối. Chúng tôi có thể chạy học thuyết trực tiếp trong thiết bị đầu cuối:

$ python -m doctest wrong_abs.py

$ python -m doctest -v wrong_abs.py

Đôi khi, nó có thể hơi lộn xộn nếu chúng ta đặt cả nhận xét và trường hợp kiểm tra bên dưới hàm. Đừng lo lắng, chúng tôi có thể đặt tất cả các trường hợp thử nghiệm vào một tệp độc lập và vẫn chạy học thuyết một cách hoàn hảo.

Ví dụ: hãy tạo một tệp có tên test_cases.txtvà đặt các trường hợp kiểm tra “kiểu tài liệu” vào đó:

Sau đó chạy học thuyết bằng lệnh này:

python -m doctest test_cases.txt

Phần kết luận

Doctest là một phương pháp kiểm tra dễ sử dụng cho các chương trình Python. Sử dụng tốt kỹ thuật này có thể giúp bạn nhận được mã không có lỗi.

Cảm ơn vì đã đọc.

Bài viết liên quan:

Sáu kỹ thuật gỡ lỗi cho lập trình viên Python

Các hướng dẫn Python khác:

Hướng dẫn Python cuối cùng (Tiếp tục cập nhật)