Python 的 logging 模組提供強大的日誌記錄功能，除了基本用法外，更能透過多個 Handler 設定、自訂 Formatter 等技巧，精細控制日誌輸出。搭配裝飾器，可以簡潔地記錄函式的進入、引數、回傳值，提升程式碼的可追蹤性。整合測試框架與除錯工具，例如 pytest 搭配 pdb，能有效重現和分析測試失敗場景。針對遠端或容器化環境，remote-pdb 等工具提供遠端除錯能力。此外，cProfile 和 snakeviz 則協助進行效能分析，找出程式碼瓶頸並進行最佳化。多執行緒環境的錯誤監控，則需注意日誌訊息的執行緒識別，避免訊息混淆。
使用 logging 模組進行日誌記錄
除了互動式除錯，日誌記錄也是診斷程式問題的重要工具。Python 的logging模組提供了一個靈活的框架來發出日誌記錄。以下是使用logging模組的範例：
import logging
import sys
# 建立一個自定義的logger
logger = logging.getLogger('advanced_debugger')
logger.setLevel(logging.DEBUG)
# 建立handlers來輸出日誌到控制檯和檔案
console_handler = logging.StreamHandler(sys.stdout)
file_handler = logging.FileHandler('application_debug.log')
# 設定handlers的日誌級別
console_handler.setLevel(logging.DEBUG)
file_handler.setLevel(logging.INFO)
# 定義formatters來包含詳細的上下文資訊
console_format = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_format = logging.Formatter('%(asctime)s - %(levelname)s - %(filename)s:%(lineno)d - %(message)s')
console_handler.setFormatter(console_format)
file_handler.setFormatter(file_format)
# 將handlers新增到logger
logger.addHandler(console_handler)
logger.addHandler(file_handler)
# 使用logger發出日誌記錄
logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')
這個範例展示瞭如何建立一個自定義的 logger，設定其日誌級別，建立 handlers 來輸出日誌到控制檯和檔案，並定義 formatters 來包含詳細的上下文資訊。最後，使用 logger 發出不同級別的日誌記錄。
使用多個 Handler 來捕捉不同層級的日誌
在日誌組態中，使用多個 handler 來捕捉不同層級的日誌是一種常見的做法。這種方法可以讓開發者根據不同的需求，將日誌輸出到不同的目的地，例如控制檯、檔案或網路。
組態 Logger 和 Handler
以下是組態 logger 和 handler 的範例：
import logging
# 建立一個 logger
logger = logging.getLogger('my_logger')
# 設定 logger 的層級
logger.setLevel(logging.DEBUG)
# 建立一個控制檯 handler
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.INFO)
# 建立一個檔案 handler
file_handler = logging.FileHandler('log_file.log')
file_handler.setLevel(logging.DEBUG)
# 設定 handler 的格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)
# 將 handler 新增到 logger
logger.addHandler(console_handler)
logger.addHandler(file_handler)
在這個範例中，我們建立了一個 logger，並設定其層級為 DEBUG。然後，我們建立了兩個 handler：一個控制檯 handler 和一個檔案 handler。控制檯 handler 的層級設定為 INFO，檔案 handler 的層級設定為 DEBUG。最後，我們將兩個 handler 新增到 logger 中。
使用 Logger 來記錄日誌
以下是使用 logger 來記錄日誌的範例：
def process_data(data):
logger.debug('Entering process_data with data: %s', data)
if not data:
logger.error('Received empty data list')
raise ValueError('Data list cannot be empty')
try:
result = sum(data) / len(data)
logger.info('Computed average: %.2f', result)
except Exception as e:
logger.exception('Exception occurred during processing')
raise e
return result
在這個範例中，我們定義了一個函式 process_data，該函式使用 logger 來記錄日誌。當函式執行時，logger 會將日誌輸出到控制檯和檔案中。
使用自訂 Decorator 來豐富日誌訊息
以下是使用自訂 decorator 來豐富日誌訊息的範例：
import functools
import logging
logger = logging.getLogger('advanced_debugger')
def log_calls(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
logger.debug('Calling %s with arguments: %s, %s', func.__name__, args, kwargs)
try:
result = func(*args, **kwargs)
logger.debug('Result: %s', result)
return result
except Exception as e:
logger.exception('Exception occurred during calling %s', func.__name__)
raise e
return wrapper
@log_calls
def add(a, b):
return a + b
在這個範例中，我們定義了一個自訂 decorator log_calls，該 decorator 會將函式呼叫的詳細資訊記錄到日誌中。然後，我們使用該 decorator 來裝飾函式 add，使得函式呼叫時會記錄詳細的日誌資訊。
使用裝飾器進行函式呼叫記錄
在軟體開發中，瞭解程式的執行流程對於除錯和最佳化至關重要。使用裝飾器（decorator）是一種有效的方法，可以在不修改原始程式碼的情況下，為函式新增額外的功能。以下是使用裝飾器進行函式呼叫記錄的範例：
import logging
import functools
# 設定logger
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
# 定義裝飾器
def log_calls(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
logger.debug(f"Entering function: {func.__name__} with args: {args}, kwargs: {kwargs}")
result = func(*args, **kwargs)
logger.debug(f"Exiting function: {func.__name__} with result: {result}")
return result
return wrapper
# 使用裝飾器
@log_calls
def complex_operation(x, y):
# 模擬一個複雜的運算，可能包含邊界情況。
if y == 0:
logger.warning("Division by zero")
return None
return x / y
# 範例使用
if __name__ == '__main__':
complex_operation(10, 2)
complex_operation(10, 0)
這個範例展示瞭如何使用裝飾器自動記錄函式的呼叫，包括輸入引數和傳回值。這種技術可以幫助開發者系統地捕捉函式呼叫流程，從而提高程式的可追蹤性，特別是在深度巢狀或多執行緒應用中。
整合除錯工具與測試框架
另一種有用的方法是將除錯工具與測試框架整合在一起。高階開發者通常在測試案例中使用斷點（breakpoint）來除錯失敗的測試，在測試套件的上下文中。例如，Pytest 允許透過--pdb旗標與 pdb 整合，這可以在測試失敗時自動啟動互動式會話。例如：
pytest --maxfail=1 --disable-warnings --pdb
這個命令列旗標尤其對於重現間歇性或在特定測試條件下發生的測試失敗很有用。能夠在失敗時刻與測試環境進行互動，為完善測試和底層程式碼提供了無價的反饋迴圈。
遠端除錯
遠端除錯是一個進階主題，允許開發者將除錯器附加到正在執行的過程中。像remote-pdb和rpdb這樣的函式庫允許對除錯會話進行遠端連線，這在生產環境或容器化環境中尤其有用，因為在這些環境中，區域性存取可能受到限制。以下是使用remote_pdb進行遠端除錯的最小範例：
import remote_pdb
def problematic_function():
# 模擬一個執行時問題，需要遠端檢查。
a = 10
b = 0
remote_pdb.set_trace() # 啟動遠端除錯會話。
return a / b
這些技術和工具可以幫助開發者更有效地診斷和修復軟體中的問題，特別是在複雜或分散式系統中。
進階除錯技術
在軟體開發中，除錯是一個至關重要的步驟。Python 提供了多種工具和技術來幫助開發者診斷和修復程式碼中的錯誤。在本文中，我們將探討一些進階的除錯技術，包括使用 cProfile 進行效能分析和在多執行緒環境中進行錯誤監控。
效能分析
效能分析是指分析程式碼的執行時間和資源使用情況，以便找出效能瓶頸和最佳化程式碼。Python 的標準函式庫中提供了 cProfile 模組，可以用來收集程式碼的執行時間和呼叫次數等資訊。以下是一個使用 cProfile 進行效能分析的範例：
import cProfile
def my_function():
#...
if __name__ == '__main__':
profiler = cProfile.Profile()
profiler.enable()
my_function()
profiler.disable()
profiler.print_stats()
這個範例中，我們建立了一個 cProfile 物件，啟用它，然後呼叫 my_function()。最後，我們停用 cProfile 並列印預出執行時間和呼叫次數等資訊。
多執行緒環境中的錯誤監控
在多執行緒環境中，錯誤監控會更加複雜，因為多個執行緒可能會同時執行相同的程式碼。為瞭解決這個問題，我們可以使用日誌記錄（logging）來記錄每個執行緒的執行情況。以下是一個範例：
import threading
import logging
logger = logging.getLogger('advanced_debugger')
formatter = logging.Formatter('%(asctime)s - %(threadName)s - %(levelname)s - %(message)s')
handler = logging.StreamHandler()
handler.setFormatter(formatter)
logger.addHandler(handler)
logger.setLevel(logging.DEBUG)
def worker():
logger.debug("Worker thread executing")
threads = []
for i in range(5):
t = threading.Thread(target=worker, name=f"Worker-{i}")
threads.append(t)
t.start()
for t in threads:
t.join()
這個範例中，我們建立了一個日誌記錄器（logger），並設定它的格式和級別。然後，我們建立了多個執行緒，每個執行緒都會呼叫 worker() 函式，並將其名稱設為 “Worker-"。最後，我們啟動所有執行緒並等待它們完成。
使用 snakeviz 進行視覺化
snakeviz 是一個視覺化工具，可以用來分析 cProfile 收集的資料。以下是一個範例：
python -m cProfile -o output.prof my_script.py
snakeviz output.prof
這個範例中，我們首先使用 cProfile 收集資料，然後使用 snakeviz 將資料視覺化。
從效能評估和實務落地的角度來看，Python 的 logging 模組和進階除錯技術為開發者提供了強大的工具，能有效提升程式碼品質和開發效率。本文涵蓋了從基本日誌記錄到多執行緒環境除錯、效能分析以及遠端除錯等多個導向，展現瞭如何利用這些技術診斷和解決程式問題。分析不同除錯方法的優缺點，例如 pdb 的互動式除錯能力適用於開發階段的細粒度程式碼追蹤，而 logging 模組則更適合記錄程式執行時的狀態資訊，方便事後分析。技術限制方面，日誌記錄本身會帶來效能損耗，需要謹慎組態日誌級別和輸出方式，例如善用多個 Handler 來區分不同層級的日誌訊息。此外，遠端除錯的安全性也需特別考量，避免暴露敏感資訊。展望未來，預期會有更多整合式的除錯工具出現，例如結合程式碼分析和機器學習技術，自動偵測潛在錯誤並提供修復建議。對於追求高效能和高可靠性的應用程式，玄貓建議深入研究 cProfile 和 snakeviz 等效能分析工具，並將日誌記錄和錯誤監控機制整合到持續整合/持續佈署流程中，以建立更完善的程式碼品質保障體系。
