Python 函式是程式碼組織和重用的關鍵。理解不同引數型別如位置、關鍵字、預設和可變長度引數，能提升程式碼的靈活性。清晰的檔案對於程式碼維護至關重要，Docstring 和 Annotation 提供了有效的檔案編寫方式。Doctest 則能直接在檔案中嵌入測試案例，確保程式碼的正確性。純函式的設計原則，包含避免修改全域狀態、不修改輸入引數、不依賴外部狀態以及總是傳回一個值，有助於提升程式碼的可預測性和可測試性，進而提升整體程式碼品質。
Python函式進階應用與檔案編寫
函式基礎與進階特性
Python中的函式是程式設計的核心元素，不僅能夠提升程式碼的可讀性與可維護性，還具備多樣化的應用方式。函式支援多種引數傳遞方式，包括位置引數、關鍵字引數、預設引數及可變長度引數等，滿足不同場景的需求。
函式引數詳解
- 位置引數：依照函式定義時的引數順序傳遞，是最基礎的引數傳遞方式。
def 計算總和(x, y):
# 將兩個數字相加並傳回結果
return x + y
結果 = 計算總和(3, 5)
print(結果) # 輸出: 8
內容解密：
此範例展示瞭如何使用位置引數呼叫函式。x和y依照定義順序接收引數值，順序的正確性直接影響運算結果。
- 關鍵字引數：透過指定引數名稱傳遞，可提升程式碼可讀性並允許非順序傳參。
def 計算差值(x, y):
# 計算兩個數字的差值
return x - y
結果 = 計算差值(x=10, y=3)
print(結果) # 輸出: 7
內容解密：
使用關鍵字引數可明確指定引數對應關係，即使改變引數順序也不影響結果，使函式呼叫更具彈性。
- 預設引數：為引數設定預設值，在未傳入對應引數時使用預設值。
def 問候(name, greeting="您好"):
# 根據提供的名字和問候語進行問候
print(f"{greeting}, {name}!")
問候("張三") # 輸出: 您好, 張三!
問候("李四", "早安") # 輸出: 早安, 李四!
內容解密：
預設引數機制允許函式在未提供特定引數時使用預設值，增強函式的靈活性與適用範圍。
- 可變長度引數：支援任意數量的引數傳遞，包含位置引數與關鍵字引數兩種形式。
def 計算乘積(*args):
# 計算任意數量的數字的乘積
結果 = 1
for arg in args:
結果 *= arg
return 結果
結果 = 計算乘積(2, 3, 4)
print(結果) # 輸出: 24
內容解密：
使用*args可接收任意數量的位置引數，並透過迴圈處理這些引數，實作可變引數的運算邏輯。
def 列印值(**kwargs):
# 列印任意數量的關鍵字引數
for key, value in kwargs.items():
print(f"{key} = {value}")
列印值(name="張三", age=30, city="臺北")
# 輸出:
# name = 張三
# age = 30
# city = 臺北
內容解密：
**kwargs用於接收任意數量的關鍵字引數，並以字典形式處理這些引數，提供高度彈性的函式介面。
函式檔案編寫規範
良好的檔案是確保程式碼可維護性的關鍵。Python提供了docstring與annotation兩種主要機制來進行函式檔案編寫。
Docstring使用
Docstring是Python中專門用於函式、模組或類別說明的字串，能夠透過內建的help()函式存取。
- 單行Docstring：適用於簡單函式的說明。
def 加法(x, y):
"""將兩個數字相加並傳回結果"""
return x + y
內容解密：
簡短的docstring能夠快速說明函式功能，幫助開發者理解函式用途。
- 多行Docstring：適用於較為複雜的函式，需要詳細說明函式功能、引數及回傳值。
def 問候(name):
"""
對給定的名字進行問候。
本函式接收一個名字作為輸入並在控制檯列印問候訊息。
不回傳任何值。
Args:
name (str): 要問候的名字。
Returns:
None
"""
print(f"您好, {name}!")
內容解密：
詳細的docstring能夠提供完整的函式使用資訊，包括引數說明、回傳值及可能的副作用。
Annotation使用
Annotation提供了一種可選的元資料新增方式，用於函式引數與回傳值的型別標註。
def 加法(x: int, y: int) -> int:
"""將兩個整數相加並傳回結果"""
return x + y
內容解密：
使用annotation能夠明確函式引數與回傳值的預期型別，提升程式碼的可讀性與可維護性。
函式測試：Doctest應用
Doctest是Python內建的一種測試機制，能夠直接在docstring中撰寫測試案例。
def 加法(x: int, y: int) -> int:
"""
將兩個整數相加並傳回結果
Examples:
>>> 加法(2, 3)
5
"""
return x + y
內容解密：
透過doctest能夠在檔案中直接驗證函式的正確性，既是檔案也是測試案例，確保函式行為符合預期。
Mermaid流程圖範例：函式呼叫流程
flowchart TD
A[開始] --> B{引數檢查}
B -->|引數有效| C[執行函式]
B -->|引數無效| D[回報錯誤]
C --> E[傳回結果]
D --> E
圖表翻譯：
此圖展示了函式呼叫的基本流程。首先進行引數檢查，若引數有效則執行函式邏輯；若引數無效，則回報錯誤。無論結果如何，最終都會傳回相應的處理結果。該流程清晰地說明瞭函式呼叫過程中的錯誤處理機制。
Python 中的 doctest 編寫
在 Python 程式開發中，doctest 是一種非常實用的測試工具，可以幫助開發者確保程式碼的正確性並提供良好的檔案說明。本文將深入探討 Python 中 doctest 的語法、最佳實踐以及相關應用。
doctest 的基本語法
doctest 主要寫在函式的 docstring 中，由一系列輸入/輸出配對組成。每個配對包含提示字串、函式呼叫和預期輸出結果。以下是一個簡單的範例：
def 加法(x, y):
"""
將兩個數字相加並傳回結果。
>>> 加法(2, 3)
5
>>> 加法(-1, 1)
0
"""
return x + y
內容解密：
此範例定義了一個名為 加法 的函式，用於計算兩個數字的和。docstring 中的 doctest 包含了兩個測試案例，分別驗證了不同輸入情況下的輸出結果。這種寫法不僅提供了測試功能，也作為函式使用說明的檔案。
執行 doctest
要執行 doctest，需要使用 Python 內建的 doctest 模組。只需要在模組的結尾呼叫 doctest.testmod() 函式即可：
import doctest
def 加法(x, y):
"""
將兩個數字相加並傳回結果。
>>> 加法(2, 3)
5
>>> 加法(-1, 1)
0
"""
return x + y
if __name__ == '__main__':
doctest.testmod()
內容解密：
當執行此模組時，doctest.testmod() 會自動搜尋並執行所有 docstring 中的 doctest。如果所有測試透過，不會輸出任何資訊；若有測試失敗，則會顯示錯誤訊息。
編寫 doctest 的最佳實踐
編寫有效的 doctest 需要遵循一些最佳實踐：
- 為所有函式和方法編寫 doctest
- 每個測試案例只包含一個輸入/輸出配對
- 使用描述性的提示字串
- 避免使用未定義的變數
- 複雜測試案例使用 assert 陳述式
- 多行輸出使用三重引號
flowchart TD
A[開始編寫doctest] --> B{是否遵循最佳實踐?}
B -->|是| C[執行doctest]
B -->|否| D[修改doctest]
C --> E{測試結果正確?}
E -->|是| F[完成]
E -->|否| G[除錯並修改程式碼]
D --> B
圖表翻譯：
此圖示展示了編寫和執行 doctest 的流程。首先開始編寫 doctest，然後檢查是否遵循最佳實踐。如果符合最佳實踐，則執行 doctest 並檢查測試結果。如果測試結果正確，則流程完成；否則需要進行除錯和修改程式碼。如果一開始沒有遵循最佳實踐，則需要修改 doctest 後再重新檢查。
Python 函式設計：純函式的寫法與應用
在 Python 程式設計中，函式是構成程式的基本單元。良好的函式設計能夠提升程式碼的可讀性、可維護性和可重用性。其中，純函式（Pure Function）是一種特殊的函式，具有可預測性、易於測試等優點。本文將深入探討純函式的定義、特性以及如何在 Python 中撰寫純函式。
純函式的定義與特性
純函式是指那些不會產生副作用（Side Effects）且對於相同的輸入總是產生相同輸出的函式。純函式具有以下特性：
- 不修改全域狀態：純函式不應修改任何全域變數或外部狀態。
- 不修改輸入引數：純函式不應直接修改其輸入引數，若需要修改，應建立新的物件或複製輸入物件。
- 不依賴外部狀態：純函式的行為不應受外部狀態（如全域變數、檔案或資料函式庫）的影響。
- 總是傳回一個值：純函式應根據輸入引數計算並傳回一個值。
撰寫純函式的範例
以下將透過幾個範例來說明如何撰寫純函式。
避免修改全域狀態
# 不純函式：修改全域變數
計數 = 0
def 不純函式_加一():
global 計數
計數 += 1
# 純函式：不修改全域狀態
def 純函式_加一(num):
return num + 1
避免修改輸入引數
# 不純函式_ _append_list(item,尤達):
尤達.append(item)
# 純函式：建立新列表而不修改輸入
def 純函式_append_list(item, 列表):
return 列表 + [item]
避免依賴外部狀態
import datetime
# 不純函式：依賴外部狀態（目前時間）
def 不純函式_get_current_time():
return datetime.datetime.now()
# 純函式：接受時間引數，不依賴外部狀態
def 純函式_format_time(時間):
return 時間.strftime("%Y-%m-%d %H:%M:%S")
總是傳回一個值
# 不純函式：列印值而非傳回
def 不純函式_print_hello(name):
print("您好, " + name)
# 純函式：傳回問候字串
def 純函式_get_greeting(name):
return "您好, " + name
純函式的實際應用
以下是一個計算矩形面積的純函式範例：
def 計算面積(長度, 寬度):
return 長度 * 寬度
這個函式接受兩個輸入引數（長度和寬度），並傳回它們的乘積（矩形的面積）。它不修改任何輸入引數、不依賴外部狀態，且總是傳回一個值。
使用關鍵字引數提升函式彈性
在 Python 中，可以使用關鍵字引數（Keyword Arguments）來提升函式的彈性和可讀性。關鍵字引數允許在呼叫函式時明確指定引數名稱，從而無需依賴引數順序。
def 問候(name, greeting):
print(f"{greeting}, {name}!")
# 使用位置引數呼叫
問候("張三", "您好")
# 使用關鍵字引數呼叫
問候(name="李四", greeting="早安")
問候(greeting="午安", name="王五")
使用 *args 和 **kwargs 處理可變引數
Python 提供了 *args 和 **kwargs 這兩種語法來處理可變數量的引數。
*args用於收集任意數量的位置引數，並將它們封裝成一個元組（tuple）。**kwargs用於收集任意數量的關鍵字引數，並將它們封裝成一個字典（dictionary）。
def my_function(*args):
for arg in args:
print(arg)
def my_function(**kwargs):
for key, value in kwargs.items():
print(f"{key}: {value}")
def my_function(*args, **kwargs):
for arg in args:
print(arg)
for key, value in kwargs.items():
print(f"{key}: {value}")
Mermaid 圖表：純函式與不純函式的比較
flowchart TD
A[函式呼叫] --> B{是否為純函式？}
B -->|是| C[產生預期輸出]
B -->|否| D[可能產生副作用或依賴外部狀態]
C --> E[易於測試和維護]
D --> F[可能導致不可預期的結果]
圖表翻譯：
此圖示展示了純函式與不純函式在呼叫時的行為差異。純函式總是根據輸入引數產生相同的輸出，而不純函式可能受到外部狀態的影響或產生副作用。純函式具有更好的可測試性和可維護性。
從技術架構視角來看，Python 函式的進階應用，包含多樣化的引數傳遞機制和檔案編寫規範，展現了其高度的靈活性和程式碼組織能力。深入分析函式的各種特性，例如關鍵字引數、預設引數、可變長度引數，以及docstring和annotation的運用，可以顯著提升程式碼的可讀性和可維護性。然而，開發者仍需注意避免過度使用可變長度引數，以免降低程式碼的可理解性。同時，對於複雜的函式邏輯，更應注重檔案的完整性和清晰度，才能有效降低後續維護成本。隨著Python生態的持續發展，預計會有更多程式碼分析工具和最佳實務的出現，進一步提升函式設計的效率和品質。對於追求程式碼品質的開發者而言，持續學習和應用這些新工具和最佳實務將至關重要。玄貓認為，掌握Python函式的進階特性，並遵循良好的檔案編寫規範，是Python開發者精程式式設計能力的必經之路。
