Python教學

Python assert 語句用法與範例

本篇 ShengYu 介紹 Python assert 用法與範例，在軟體開發過程中，確保程式碼按預期執行是至關重要的。Python 提供了許多工具來幫助開發者檢查和除錯程式碼，其中 assert 語句是一個非常有用的工具。在這篇文章中，我們將深入探討 Python 的 assert 語句，了解它的用途、語法和一些實際範例。

什麼是 Python assert 語句？

assert 語句是一個用於除錯的工具，它可以幫助開發者檢查程式碼中的假設是否成立。簡單來說，assert 語句會評估一個表達式，如果該表達式為假，則會引發一個 AssertionError 並且程式會中止執行。這種機制能夠在開發過程中捕捉到意料之外的錯誤，確保程式碼在預期的情況下執行。

assert 語句的語法

assert 語句的基本語法如下：

1
assert condition, "Error message"
  • condition 是一個布爾表達式。如果 condition 為假，則會引發 AssertionError。
  • "Error message" 是可選的。如果提供，當 AssertionError 被引發時，這條資訊會被顯示出來。

assert 語句的用途

  1. 檢查函式的輸入參數：
    在函式的開始處使用 assert 語句可以確保傳遞給函式的參數符合預期。例如，假設我們有一個計算平方根的函式，我們可以使用 assert 語句來確保輸入是一個非負數：

    1
    2
    3
    4
    5
    6
    def calculate_square_root(x):
        assert x >= 0, "The input must be non-negative."
        return x ** 0.5

    print(calculate_square_root(4))  # 輸出: 2.0
    print(calculate_square_root(-1)) # 引發 AssertionError 並顯示 "The input must be non-negative."

  2. 檢查函式的回傳值：
    assert 語句還可以用來檢查函式的回傳值是否符合預期。例如，在一個函式中，我們希望找到清單中的第一個偶數，我們可以使用 assert 語句來確保回傳值是偶數：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    def get_even_number(numbers):
        for num in numbers:
            if num % 2 == 0:
                return num
        assert False, "No even number found in the list."

    numbers = [1, 3, 5, 7, 10]
    print(get_even_number(numbers))  # 輸出: 10
    numbers = [1, 3, 5, 7]
    print(get_even_number(numbers))  # 引發 AssertionError 並顯示 "No even number found in the list."

  3. 內部一致性檢查：
    在程式碼中，某些情況下我們需要確保某些內部狀態是一致的。這時候 assert 語句可以幫助我們檢查這些內部狀態。例如，在一個除法函式中，我們可以使用 assert 語句來確保除數不為零：

    1
    2
    3
    4
    5
    6
    def divide(a, b):
        assert b != 0, "Division by zero is not allowed."
        return a / b

    print(divide(10, 2))  # 輸出: 5.0
    print(divide(10, 0))  # 引發 AssertionError 並顯示 "Division by zero is not allowed."

assert 語句在開發和生產環境中的應用

需要注意的是，assert 語句主要用於開發和測試階段。這是因為在執行 Python 解釋器時使用 -O（優化）選項，可以禁用所有的 assert 語句。這意味著 assert 語句不應被用來替代正式的錯誤處理機制，如拋出和捕獲異常等。

1
python -O your_script.py

上面的指令將以優化模式執行 your_script.py，所有的 assert 語句將被跳過，不會進行檢查。

總結

Python 的 assert 語句是一個強大的工具，能夠幫助開發者在開發和測試過程中檢查程式碼的假設是否成立。透過使用 assert 語句，我們可以有效地捕捉意料之外的錯誤，確保程式按預期執行。然而，需要注意的是，assert 語句不應被用於生產環境中的錯誤處理，而應該僅用於開發和測試階段。希望這篇文章能夠幫助你更好地理解和使用 Python 的 assert 語句，提升程式碼質量和穩定性。

以上就是 Python assert 用法與範例的介紹，
如果你覺得我的文章寫得不錯、對你有幫助的話記得 Facebook 按讚支持一下！

其它相關文章推薦
Python 新手入門教學懶人包