使用 PyInterceptor 分析 API

PyInterceptor：用於非侵入性分析的 Python 函式呼叫攔截器

PyInterceptor 是一個目前正在開發的 Python 函式庫（可在 GitHub 上找到），設計用於非侵入式攔截和分析函式呼叫。 想像一下，需要與 Python API 互動的 Python 用戶端的詳細資訊（函數名稱、參數、傳回值、執行時間），無需修改現有程式碼。 PyInterceptor 滿足了這項需求。

這篇 dev.to 文章介紹了 PyInterceptor 的核心概念、用例和應用。

Python 呼叫攔截與處理

核心原則

圖 1 — 呼叫攔截概述：阻塞與非阻塞攔截

函數呼叫攔截分為兩類：阻塞和非阻塞（圖1）。 阻塞攔截捕獲呼叫資訊並立即返回，而不執行目標函數。這有利於在單元測試期間建立模擬或存根。 非阻塞攔截收集信息，然後執行目標函數，在繼續之前捕獲其返回值。 PyInterceptor 支援這兩種模式。

用例

攔截Python API呼叫提供了眾多應用：

• 自動模擬/存根建立：利用阻塞模式半自動產生用於單元測試的模擬和存根。 PyInterceptor 允許自訂攔截器可呼叫來傳回模擬資料。
• 結構化日誌記錄：將攔截的參數和元資料轉發到日誌系統。
• 增強偵錯：透過追蹤函數呼叫及其參數更有效地找出錯誤。
• 通話統計產生：收集效能指標。
• 還有更多...

詳細實作

圖 2 — 詳細資料：包括 handler() 函數和攔截器() 可呼叫

PyInterceptor 透過插入 handler 函式來攔截針對 API 的呼叫。此處理程序會擷取元資料（參數、時間戳記等），將其儲存在 CallInfo 物件中，並管理呼叫轉送。

在阻塞模式下，處理程序將 CallInfo 傳遞給使用者定義的 可呼叫攔截器。 此可呼叫處理資訊（日誌記錄、統計資料等）。 然後處理程序傳回攔截器的結果。

在非阻塞模式下，處理程序執行目標函數，將其回傳值加到CallInfo，然後呼叫攔截器。 與阻塞模式不同，實際的目標函數的回傳值會傳回給呼叫者。

說明性程式碼範例

此範例示範了 PyInterceptor 與算術 API 和 Processor 類別的使用，將所有方法呼叫記錄到 JSON 檔案。

import json
from pathlib import Path
from typing import List

from interceptor import intercept, get_methods, CallInfo


class API:
    # ... (API methods remain unchanged) ...


class Processor:
    # ... (Processor methods remain unchanged) ...


class JSONLogger:
    # ... (JSONLogger class remains unchanged) ...


if __name__ == '__main__':
    # ... (Main method remains unchanged) ...

main方法建立一個JSONLogger實例（充當攔截器），使用intercept()攔截API和Processor方法，執行Processor方法，並將日誌儲存到「logs.json」。 JSON 輸出包含每個函數呼叫的詳細記錄。

未來的增強

PyInterceptor 的計畫改進包括：

• 全面的 API 文件和 CI/CD 管道。
• 用於簡化類別/方法攔截的 Python 裝飾器。
• 用於管理記憶體使用的設定選項（複製與引用 CallInfo 資料）。
• 針對常見用例的預先建置攔截器實作。

歡迎您的回饋！ 如果您覺得本文有幫助或對未來發展有建議，請發表評論。

以上是使用 PyInterceptor 分析 API的詳細內容。更多資訊請關注PHP中文網其他相關文章！