PyLance類型檢查與自定義裝飾器沖突的解決方法
python開發中，靜態類型檢查工具（如PyLance）經常會與自定義裝飾器產生類型檢查錯誤或警告。本文將通過一個示例，演示如何解決PyLance在自定義裝飾器中報告的類型不匹配問題。
問題示例:
以下代碼片段展示了一個自定義裝飾器execute和被裝飾的函數query_data_source：
def execute(func): def inner_wrapper(*args, **kwargs) -> result[any]: # 問題所在 with Session.begin() as session: result = session.execute(func(*args, **kwargs)) return result return inner_wrapper @execute def query_data_source( start_id: int = 1, max_results_amount: int = 10 ) -> select: # PyLance認為此處返回類型為select stmt = ( select( datasource.id, datasource.name, datasource.source_url, datasource.author, datasource.description, datasource.cover_image_url, datasource.start_date, datasource.end_date, ) .where(datasource.id >= start_id) .limit(max_results_amount) .order_by(datasource.id) ) return stmt
運行時該代碼沒有問題，但PyLance會警告query_data_source的返回類型不匹配，因為它推斷出execute裝飾器改變了返回類型為result[any]。
解決方案:
為了解決此問題，我們需要在裝飾器定義中添加更精確的類型提示，明確裝飾后函數的返回類型。修改后的代碼如下：
from typing import Callable, Any def execute(func: Callable[..., Result]) -> Callable[..., Result]: # 添加類型提示 def inner_wrapper(*args, **kwargs) -> Result[Any]: with Session.begin() as session: result = session.execute(func(*args, **kwargs)) return result return inner_wrapper
通過在execute裝飾器中添加Callable[…, Result]類型提示，我們告訴PyLance裝飾后的函數返回Result類型。 …表示參數數量和類型不確定，Result假設是自定義類型或已導入的類型。 這解決了PyLance的類型檢查錯誤，并確保類型信息準確無誤。
此方法適用于許多自定義裝飾器的類型檢查問題。 通過添加合適的類型提示，可以有效地與類型檢查工具協同工作，提高代碼質量和可維護性。 記住根據你的實際情況替換Result和session為你的代碼中使用的實際類型和對象。
? 版權聲明
文章版權歸作者所有，未經允許請勿轉載。
THE END
