Python單元測試之道：從入門到精通的全面指南

来源:https://www.cnblogs.com/xfuture/archive/2023/07/18/17562444.html
-Advertisement-
Play Games

**在這篇文章中，我們會深入探討Python單元測試的各個方面，包括它的基本概念、基礎知識、實踐方法、高級話題，如何在實際項目中進行單元測試，單元測試的最佳實踐，以及一些有用的工具和資源** ## 一、單元測試重要性 測試是軟體開發中不可或缺的一部分，它能夠幫助我們保證代碼的質量，減少bug，提高系 ...


在這篇文章中，我們會深入探討Python單元測試的各個方面，包括它的基本概念、基礎知識、實踐方法、高級話題，如何在實際項目中進行單元測試，單元測試的最佳實踐，以及一些有用的工具和資源

一、單元測試重要性

測試是軟體開發中不可或缺的一部分，它能夠幫助我們保證代碼的質量，減少bug，提高系統的穩定性。在各種測試方法中，單元測試由於其快速、有效的特性，特別受到開發者們的喜歡。本文將全面介紹Python中的單元測試。

1.1 為什麼單元測試重要？

在我們寫代碼的過程中，我們可能會遇到各種各樣的問題，而這些問題如果沒有得到妥善的處理，往往會在項目上線後變成難以預見的bug。這些bug不僅會影響用戶的使用體驗，還可能帶來嚴重的經濟損失。因此，單元測試就顯得尤為重要，它可以幫助我們在代碼開發的過程中就發現和解決問題，避免問題的積累和放大。

例如，我們在編寫一個簡單的加法函數時：

def add(x, y):
    return x + y

我們可以通過編寫一個簡單的單元測試，來保證這個函數的功能：

import unittest

class TestAdd(unittest.TestCase):
    def test_add(self):
        self.assertEqual(add(1, 2), 3)

通過運行這個測試，我們可以驗證add函數是否正常工作。

1.2 單元測試在Python中的應用

Python有一個內置的unittest模塊，我們可以使用它來進行單元測試。此外，Python社區也提供了一些其他的單元測試工具，如pytest，nose等。本文將主要介紹如何使用Python的unittest模塊來進行單元測試。

在Python的開發過程中，良好的單元測試不僅可以幫助我們保證代碼的質量，還可以作為文檔，幫助其他開發者理解和使用我們的代碼。因此，單元測試在Python的開發過程中占有非常重要的地位。

二、Python單元測試基礎知識

在介紹單元測試的具體操作之前，我們需要對一些基礎知識有所瞭解。在這一部分，我們將瞭解什麼是單元測試，以及Python的unittest模塊。

2.1 什麼是單元測試？

單元測試（Unit Testing）是一種軟體測試方法，它的目標是驗證代碼中各個獨立的單元（通常是函數、方法或類）的行為是否符合我們的預期。單元測試有許多優點，如快速、反饋即時、易於定位問題等，是測試驅動開發（TDD）的重要組成部分。

例如，我們有一個函數用於求一個數字的平方：

def square(n):
    return n * n

我們可以寫一個單元測試來驗證這個函數是否能正常工作：

import unittest

class TestSquare(unittest.TestCase):
    def test_square(self):
        self.assertEqual(square(2), 4)
        self.assertEqual(square(-2), 4)
        self.assertEqual(square(0), 0)

這樣，無論我們的代碼在何時被修改，都可以通過運行這個單元測試來快速檢查是否存在問題。

2.2 Python的unittest模塊簡介

Python的unittest模塊是Python標準庫中用於進行單元測試的模塊，它提供了一套豐富的API供我們編寫和運行單元測試。unittest模塊的使用主要包括三個步驟：

  1. 導入unittest模塊。
  2. 定義一個繼承自unittest.TestCase的測試類，然後在這個類中定義各種測試方法（方法名以test_開頭）。
  3. 在命令行中運行測試。

下麵是一個簡單的例子：

import unittest

class TestMath(unittest.TestCase):
    def test_add(self):
        self.assertEqual(1 + 1, 2)

    def test_subtract(self):
        self.assertEqual(3 - 2, 1)

if __name__ == '__main__':
    unittest.main()

在命令行中運行這個腳本，就會執行所有的測試方法，然後輸出測試結果。

三、Python單元測試實踐

瞭解了單元測試的基礎知識後，我們將開始實踐。在這一部分，我們將演示如何在Python中編寫和運行單元測試。

3.1 如何寫一個基本的單元測試？

在Python中，我們可以使用unittest模塊來編寫單元測試。一個基本的單元測試通常包含以下幾個部分：

  1. 導入unittest模塊。
  2. 定義一個繼承自unittest.TestCase的測試類。
  3. 在這個測試類中定義各種測試方法（方法名以test_開頭）。
  4. 在這些測試方法中使用unittest.TestCase的各種斷言方法來檢查被測代碼的行為。

例如，我們有以下一個函數：

def divide(x, y):
    if y == 0:
        raise ValueError("Can not divide by zero!")
    return x / y

我們可以這樣編寫單元測試：

import unittest

class TestDivide(unittest.TestCase):
    def test_divide(self):
        self.assertEqual(divide(4, 2), 2)
        self.assertEqual(divide(-4, 2), -2)
        self.assertRaises(ValueError, divide, 4, 0)

if __name__ == '__main__':
    unittest.main()

在這個例子中，我們使用了unittest.TestCase的assertEqual方法和assertRaises方法來檢查divide函數的行為。

3.2 測試用例、測試套件和測試運行器的概念和創建

在unittest模塊中，我們有以下幾個重要的概念：

  • 測試用例（Test Case）：一個測試用例就是一個完整的測試流程，包括測試前的準備環節、執行測試動作和測試後的清掃環節。在unittest模塊中，一個測試用例就是一個unittest.TestCase的實例。
  • 測試套件（Test Suite）：測試套件是一系列的測試用例或測試套件的集合。我們可以使用unittest.TestSuite類來創建測試套件。
  • 測試運行器（Test Runner）：測試運行器是用來執行和控制測試的。我們可以使用unittest.TextTestRunner類來創建一個簡單的文本測試運行器。

以下是一個例子：

import unittest

class TestMath(unittest.TestCase):
    # 測試用例
    def test_add(self):
        self.assertEqual(1 + 1, 2)

    def test_subtract(self):
        self.assertEqual(3 - 2, 1)

# 創建測試套件
suite = unittest.TestSuite()
suite.addTest(TestMath('test_add'))
suite.addTest(TestMath('test_subtract'))

# 創建測試運行器
runner = unittest.TextTestRunner()
runner.run(suite)

在這個例子中，我們創建了一個包含兩個測試用例的測試套件，然後用一個文本測試運行器來執行這個測試套件。

3.3 使用setUp和tearDown處理測試前後的準備和清理工作

在編寫單元測試時，我們經常需要在每個測試方法執行前後做一些準備和清理工作。例如，我們可能需要在每個測試方法開始前創建一些對象，然後在每個測試方法結束後銷毀這些對象。我們可以在測試類中定義setUp和tearDown方法來實現這些功能。

import unittest

class TestDatabase(unittest.TestCase):
    def setUp(self):
        # 創建資料庫連接
        self.conn = create_database_connection()

    def tearDown(self):
        # 關閉資料庫連接
        self.conn.close()

    def test_insert(self):
        # 使用資料庫連接進行測試
        self.conn.insert(...)

在這個例子中，我們在setUp方法中創建了一個資料庫連接，在tearDown方法中關閉了這個資料庫連接。這樣，我們就可以在每個測試方法中使用這個資料庫連接進行測試，而不需要在每個測試方法中都創建和銷毀資料庫連接。

四、Python單元測試高級話題

我們已經瞭解了Python單元測試的基本概念和使用方法。現在，我們將深入探討一些高級話題，包括測試驅動開發（TDD）、模擬對象（Mocking）和參數化測試。

4.1 測試驅動開發（TDD）

測試驅動開發（Test-Driven Development，簡稱TDD）是一種軟體開發方法，它強調在編寫代碼之前先編寫單元測試。TDD的基本步驟是：

  1. 先寫一個失敗的單元測試。
  2. 編寫代碼，使得這個單元測試通過。
  3. 重構代碼，使得代碼更好。

TDD有助於我們保持代碼的質量，也使得我們的代碼更容易維護和修改。

4.2 模擬對象（Mocking）

在編寫單元測試時，我們有時需要模擬一些外部的、不可控的因素，如時間、資料庫、網路請求等。Python的unittest.mock模塊提供了一種創建模擬對象的方法，我們可以用它來模擬外部的、不可控的因素。

例如，假設我們有一個函數，它會根據當前時間來決定返回什麼結果：

import datetime

def get_greeting():
    current_hour = datetime.datetime.now().hour
    if current_hour < 12:
        return "Good morning!"
    elif current_hour < 18:
        return "Good afternoon!"
    else:
        return "Good evening!"

我們可以使用unittest.mock來模擬當前時間，以便測試這個函數：

import unittest
from unittest.mock import patch

class TestGreeting(unittest.TestCase):
    @patch('datetime.datetime')
    def test_get_greeting(self, mock_datetime):
        mock_datetime.now.return_value.hour = 9
        self.assertEqual(get_greeting(), "Good morning!")

        mock_datetime.now.return_value.hour = 15
        self.assertEqual(get_greeting(), "Good afternoon!")

        mock_datetime.now.return_value.hour = 20
        self.assertEqual(get_greeting(), "Good evening!")

if __name__ == '__main__':
    unittest.main()

在這個例子中，我們使用unittest.mock.patch來模擬datetime.datetime對象，然後設置其now方法的返回值。

4.3 參數化測試

參數化測試是一種單元測試技術，它允許我們使用不同的輸入數據來運行相同的測試。在Python的unittest模塊中，我們可以使用unittest.subTest上下文管理器來實現參數化測試。

以下是一個例子：

import unittest

class TestSquare(unittest.TestCase):
    def test_square(self):
        for i in range(-10, 11):
            with self.subTest(i=i):
                self.assertEqual(square(i), i * i)

if __name__ == '__main__':
    unittest.main()

在這個例子中，我們使用unittest.subTest上下文管理器來運行20個不同的測試，每個測試都使用不同的輸入數據。

五、實戰演練：Python單元測試的完整項目示例

在這一部分，我們將通過一個簡單的項目來展示如何在實踐中應用Python單元測試。我們將創建一個簡單的“分數計算器”應用，它可以執行分數的加、減、乘、除運算。

5.1 創建項目

首先，我們創建一個新的Python項目，併在項目中創建一個fraction_calculator.py文件。在這個文件中，我們定義一個Fraction類，用來表示分數。這個類有兩個屬性：分子（numerator）和分母（denominator）。

# fraction_calculator.py

class Fraction:
    def __init__(self, numerator, denominator):
        if denominator == 0:
            raise ValueError("Denominator cannot be zero!")
        self.numerator = numerator
        self.denominator = denominator

5.2 編寫單元測試

然後，我們創建一個test_fraction_calculator.py文件，在這個文件中，我們編寫單元測試來測試Fraction類。

# test_fraction_calculator.py

import unittest
from fraction_calculator import Fraction

class TestFraction(unittest.TestCase):
    def test_create_fraction(self):
        f = Fraction(1, 2)
        self.assertEqual(f.numerator, 1)
        self.assertEqual(f.denominator, 2)

    def test_create_fraction_with_zero_denominator(self):
        with self.assertRaises(ValueError):
            Fraction(1, 0)

if __name__ == '__main__':
    unittest.main()

在這個測試類中，我們創建了兩個測試方法：test_create_fraction測試正常創建分數，test_create_fraction_with_zero_denominator測試當分母為零時應拋出異常。

5.3 執行單元測試

最後，我們在命令行中運行test_fraction_calculator.py文件，執行單元測試。

python -m unittest test_fraction_calculator.py

如果所有的測試都通過，那麼我們就可以有信心地說，我們的Fraction類是正確的。

5.4 擴展項目

當然，我們的項目還遠遠沒有完成。Fraction類還需要添加許多功能，如加、減、乘、除運算，約簡分數，轉換為浮點數等。對於每一個新的功能，我們都需要編寫相應的單元測試來確保其正確性。並且，我們也需要不斷地運行這些單元測試，以確保我們的修改沒有破壞已有的功能。

單元測試是一個持續的過程，而不是一次性的任務。只有不斷地編寫和運行單元測試，我們才能保證我們的代碼的質量和可靠性。

六、Python單元測試的最佳實踐

在實際編寫和執行Python單元測試的過程中，有一些最佳實踐可以幫助我們提高工作效率，並保證測試的質量和可靠性。

6.1 始終先編寫測試

按照測試驅動開發（TDD）的原則，我們應該先編寫測試，然後再編寫能通過測試的代碼。這樣可以幫助我們更清晰地理解我們要實現的功能，同時也能保證我們的代碼是可測試的。

6.2 保持測試的獨立性

每個測試都應該是獨立的，不依賴於其他測試。如果測試之間有依賴關係，那麼一個測試失敗可能會導致其他測試也失敗，這會使得測試結果難以理解，也會使得測試更難維護。

6.3 測試所有可能的情況

我們應該儘可能地測試所有可能的情況，包括正常情況、邊界情況和異常情況。例如，如果我們有一個函數，它接受一個在0到100之間的整數作為參數，那麼我們應該測試這個函數在參數為0、50、100和其他值時的行為。

6.4 使用模擬對象

在測試涉及到外部系統（如資料庫、網路服務等）的代碼時，我們可以使用模擬對象（Mocking）來代替真實的外部系統。這樣可以使得測試更快、更穩定，並且更易於控制。

6.5 定期運行測試

我們應該定期運行我們的測試，以確保我們的代碼沒有被破壞。一種常見的做法是在每次提交代碼之前運行測試。此外，我們還可以使用持續集成（Continuous Integration）工具，如Jenkins、Travis CI等，來自動運行我們的測試。

6.6 使用代碼覆蓋率工具

代碼覆蓋率是一個度量標準，用來表示我們的測試覆蓋了多少代碼。我們可以使用代碼覆蓋率工具，如coverage.py，來度量我們的代碼覆蓋率，並努力提高這個指標。但是，請記住，代碼覆蓋率並不能保證我們的測試的質量和完整性。它只是一個工具，我們不能過分依賴它。

# 運行代碼覆蓋率工具的示例
# 在命令行中輸入以下命令：

$ coverage run --source=. -m unittest discover
$ coverage report

以上的命令將首先運行你的所有單元測試，並收集代碼覆蓋率信息。然後，它將顯示一個代碼覆蓋率報告，這個報告將告訴你哪些代碼被測試覆蓋了，哪些代碼沒有被覆蓋。

七、工具和資源

在進行Python單元測試時，有一些工具和資源可以幫助我們提高效率和質量。

7.1 Python內置的unittest模塊

Python內置的unittest模塊是一個強大的單元測試框架，提供了豐富的斷言方法、測試套件、測試運行器等功能。如果你想要進行單元測試，unittest模塊是一個很好的開始。

# unittest模塊的基本使用
import unittest

class TestMyFunction(unittest.TestCase):
    def test_add(self):
        self.assertEqual(add(1, 2), 3)

if __name__ == '__main__':
    unittest.main()

7.2 pytest

pytest是一個流行的Python測試框架，比unittest更簡潔，更強大。它不僅可以用於單元測試，還可以用於功能測試、集成測試等。

# pytest的基本使用
def test_add():
    assert add(1, 2) == 3

7.3 mock

mock模塊可以幫助你創建模擬對象，以便在測試中替代真實的對象。這對於測試依賴於外部系統或難以構造的對象的代碼非常有用。

# mock模塊的基本使用
from unittest.mock import Mock

# 創建一個模擬對象
mock = Mock()
# 設置模擬對象的返回值
mock.return_value = 42
# 使用模擬對象
assert mock() == 42

7.4 coverage.py

coverage.py是一個代碼覆蓋率工具，可以幫助你找出哪些代碼沒有被測試覆蓋。

# coverage.py的基本使用
coverage run --source=. -m unittest discover
coverage report

7.5 Python Testing

Python Testing是一個關於Python測試的網站，提供了許多有關Python測試的教程、工具、書籍和其他資源。網址是：http://pythontesting.net

八、總結

希望通過本文，你對Python單元測試有了更深入的理解和應用。單元測試是軟體開發過程中非常重要的一環，正確地進行單元測試可以幫助我們提高代碼質量，發現和修複問題，以及提高開發效率。Python提供了一系列強大的工具來進行單元測試，這些工具能夠幫助我們編寫更好的單元測試。

在編寫單元測試的過程中，我們不僅可以發現和修複問題，還可以深入理解我們的代碼和業務邏輯，提高我們的編程技能。

如有幫助，請多關註
個人微信公眾號：【Python全視角】
TeahLead_KrisChang，10+年的互聯網和人工智慧從業經驗，10年+技術和業務團隊管理經驗，同濟軟體工程本科，復旦工程管理碩士，阿裡雲認證雲服務資深架構師，上億營收AI產品業務負責人。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Docker學習路線7：構建容器鏡像
    容器鏡像是可執行的軟體包，包括運行應用程式所需的所有內容：代碼、運行時、系統工具、庫和設置。通過構建自定義鏡像，您可以在任何支持Docker的平臺上無縫地部署應用程式及其所有依賴項。 ### Dockerfile 構建容器鏡像的關鍵組件是 **`Dockerfile`**。它本質上是一個包含有關如何 ...
  • 07_預處理
    # 預處理 ## 動態庫和靜態庫 > 庫: 將源文件生成的二進位文件 只需要鏈接即可生成可執行文件 ## 製作靜態庫 ``` linux gcc -c fun.c -o fun.o ar rc libtestlib.a fun.o ``` ### 使用靜態庫 #### 庫和工程在同一目錄下 ``` ...
  • 線性基學習筆記
    ## 概念 定義：給定數集 $S$，以異或運算張成的數集與 $S$ 相同的極大線性無關集，稱為原數集的一個線性基。 簡單地說，線性基是一個數的集合。每個序列都擁有至少一個線性基。取線性基中若幹個數異或起來可以得到原序列中的任何一個數。 ## 性質 - 性質一 > - 取線性基中若幹個數異或起來可以得 ...
  • Python基礎（3）
    # 面向對象編程 根據類來創建對象稱為實例化。這裡只過一下大概的面向對象的內容，不做細講。可以直接查閱資料。https://www.runoob.com/python3/python3-class.html ## 創建和使用類及實例 給出一個類的使用例子： ```python class Dog: ...
  • Python基礎（2）
    # if 語句 給出一個簡單的示例 ```python cars = ["audi", "bmw", "subaru", "toyota"] for car in cars: if car == "bmw": print(car.upper()) else: print(car.title()) ` ...
  • 構建數據中台的三要素：方法論、組織和技術
    知道要轉型，要建設數據中台，卻不知咋做，咋辦？ 現在有很多講“如何建設數據中台”文章，觀點各不相同： - 數據中台是數據建設方法論，按照數據中台設計方法和規範實施就可建成數據中台 - 數據中台背後是數據部門組織架構變更，把原先分散的組織架構形成一個統一中台部門，就建成數據中台 - 一些大數據公司說， ...
  • 高性能網路設計秘笈：深入剖析Linux網路IO與epoll
    本文介紹了網路IO模型，引入了epoll作為Linux系統中高性能網路編程的核心工具。通過分析epoll的特點與優勢，並給出使用epoll的註意事項和實踐技巧，該文章為讀者提供了寶貴的指導。 ...
  • 簡單瞭解下最近正火的SwissTable
    去年看到位元組跳動給golang提了issue建議把map的底層實現改成SwissTable的時候，我就有想寫這篇博客了，不過因為種種原因一直拖著。 直到最近遇golang官方開始討論為了是否要接受SwissTable作為map的預設實現，以及實際遇到了一個hashtable有關的問題，促使我重新思考 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類