使用 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中文网其他相关文章！