用 Pytest 寫 Python 測試

安裝 PyTest

要開始使用 PyTest，第一步是安裝框架。 使用 Python 的套件管理器 pip 可以輕鬆完成此操作。 在虛擬環境中，執行指令 pip install pytest 將設定 PyTest，讓您開始編寫和執行測試。

# Install pytest using pip
pip install pytest

# Install pytest using pip
pip install pytest

寫出你的第一個測試函數

PyTest 中的測試函數是一個簡單的 Python 函數，以單字 test_ 開頭。 每個測試函數都是獨立的測試案例。 PyTest 會自動識別這些函數，並將其作為測試套件的一部分運行。

# Basic test function example
def test_example():
    # This is a simple test that checks if the addition is correct
    assert 1 + 1 == 2

# Basic test function example
def test_example():
    # This is a simple test that checks if the addition is correct
    assert 1 + 1 == 2

測試發現

PyTest 的測試發現機制會自動辨識測試檔案和測試函數。 通常，測試檔案以 test_*.py 的格式命名，測試函數以 test_ 開頭。 此約定有助於 PyTest 定位並執行給定目錄中的所有測試。

測試類別和模組

為了更好地組織測試，可以將測試分組為測試類別和測試模組。 測試類別是以 Test 為前綴的 Python 類，其中包含多個測試方法。 這種分類有助於管理和建立多個測試和測試套件。

# Example of a test class
class TestMathOperations:
    def test_addition(self):
        assert 1 + 1 == 2

    def test_subtraction(self):
        assert 5 - 3 == 2

# Example of a test class
class TestMathOperations:
    def test_addition(self):
        assert 1 + 1 == 2

    def test_subtraction(self):
        assert 5 - 3 == 2

夾具和測試裝置

PyTest fixtures 是為測試函數設定前提條件的強大工具。 它們有助於在測試函數運行之前建立必要的物件、建立資料庫連接或配置環境。

import pytest

# Define a fixture for setting up resources
@pytest.fixture
def setup_data():
    # Setup code here (e.g., create database connections)
    return {"key": "value"}

def test_widget(setup_data):
    # Use the fixture data in the test
    assert setup_data["key"] == "value"

import pytest

# Define a fixture for setting up resources
@pytest.fixture
def setup_data():
    # Setup code here (e.g., create database connections)
    return {"key": "value"}

def test_widget(setup_data):
    # Use the fixture data in the test
    assert setup_data["key"] == "value"

參數化測試

PyTest 允許對測試進行參數化，從而使同一個測試函數能夠使用不同的資料集運行。 這對於使用各種輸入值測試函數特別有用。

import pytest

# Parameterized test example
@pytest.mark.parametrize("input,expected", [
    (1, 2),
    (2, 3),
    (3, 4),
])
def test_increment(input, expected):
    assert input + 1 == expected

import pytest

# Parameterized test example
@pytest.mark.parametrize("input,expected", [
    (1, 2),
    (2, 3),
    (3, 4),
])
def test_increment(input, expected):
    assert input + 1 == expected

處理測試失敗

PyTest 在測試失敗時提供詳細信息，包括具體的測試函數、失敗行和回溯資訊。 這份詳細的測試輸出有助於快速辨識和解決問題。

測試覆蓋率和報告

使用 PyTest，您可以產生有關測試套件覆蓋率的詳細報告。 這包括測試期間執行了程式碼的哪些部分的信息，有助於識別未測試的程式碼。

與其他工具集成

PyTest 可與其他 Python 測試工具和框架無縫集成，增強其功能，使其成為滿足各種測試需求的通用選擇。

編寫有效的測試案例

在編寫測試案例時，重要的是保持用例簡潔、重點突出且彼此獨立。 理想情況下，每個測試函數都應該測試程式碼的單一方面。 清晰且具有描述性的測試函數名稱對於理解測試的目的至關重要。

整理測試文件

隨著測試套件的不斷增長，組織測試文件和模組變得至關重要。 將類似的測試分組，並使用清晰的命名約定，有助於維護可擴展且易於管理的測試套件。

持續測試和測試驅動開發

PyTest 是一個優秀的測試驅動開發 (TDD) 工具，在 TDD 中，測試是在編寫實際程式碼之前編寫的。 使用 PyTest 進行持續測試，可確保您的程式碼庫在整個開發過程中保持健全且無錯誤。