用 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 中的測試函數是一個以 test_ 開頭的簡單 Python 函數。 每個測試函數都是單獨的測試案例。 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

Fixtures 和測試設置

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) 的絕佳工具，其中測試在實際代碼之前編寫。 使用 PyTest 進行持續測試可確保在整個開發過程中，您的代碼庫保持穩健和無錯誤。