Python之frame对象

frame对象

在 Python 中，frame 对象是一种用于表示执行栈中的函数调用的数据结构。每个正在执行的函数都会有一个对应的 frame 对象，它会记录函数的相关信息，如局部变量、调用栈、代码指针、全局变量等等。

通过 frame 对象，可以实现函数调用的跟踪、调试、性能分析等功能。在调用栈中，当前正在执行的函数的 frame 对象通常被称为当前帧。在 Python 解释器内部，每次调用函数时，都会创建一个新的 frame 对象并将其推入执行栈，以表示该函数调用。

除了解释器内部使用外，frame 对象还可以通过 inspect 模块进行获取和操作。可以获取函数的局部变量、全局变量、函数参数、代码对象等信息。使用 frame 对象可以实现一些高级的 Python 功能，如动态调用、装饰器、闭包等等。

frame的属性

示例代码1：

import inspect
from objprint import op


def f():
    frame = inspect.currentframe()
    op(frame, honor_existing=False, depth=1)


f()

这段 Python 代码使用了 inspect 和 objprint 模块来打印当前帧的信息。

• inspect.currentframe() 函数返回当前的执行帧对象。这个对象中包含了一些有用的信息，比如当前执行函数的名称、文件名、行号、代码对象等等。

• objprint 是一个 Python 模块，它提供了一种简便的方式来打印 Python 对象。在这里，op 函数接收一个帧对象和一些可选参数，并打印出该对象的信息。

• honor_existing 参数表示是否要尊重对象中已经存在的 str 和 repr 方法，如果设置为 False，则会强制根据对象的类型重新格式化打印信息。在这里，我们将其设置为 False 来保证打印出的信息是一个更加详细的对象信息而不是字符串。

• depth 参数表示打印结构的深度，如果设置为 0，则只打印对象的类型。在这里，我们将其设置为 1 来保证打印出的信息包含当前帧对象的一些基本信息。

运行结果：

<frame 0x7fc39b84fe20
  .f_back = <frame 0x7fc39b849a40 ... >,
  .f_builtins = { ... },
  .f_code = <code 0x7fc39b75f3c0 ... >,
  .f_globals = { ... },
  .f_lasti = 18,
  .f_lineno = 7,
  .f_locals = { ... },
  .f_trace = None,
  .f_trace_lines = True,
  .f_trace_opcodes = False
>

这个结果是当前帧对象的信息。帧对象是 Python 中用于执行代码的数据结构，在解释器中的栈中压入一个新的帧对象来执行每个函数。

解释一下每个属性的含义：

• .f_back 表示调用当前函数的函数的帧对象，也就是前一个帧对象。
• .f_builtins 表示内置命名空间，包含了所有内置变量和函数。
• .f_code 表示当前正在执行的代码对象。
• .f_globals 表示全局命名空间，包含了所有全局变量和函数。
• .f_lasti 表示最后一次执行的指令的字节码偏移量。
• .f_lineno 表示当前正在执行的代码所在的行号。
• .f_locals 表示本地命名空间，包含了所有函数的本地变量。
• .f_trace 表示当前跟踪函数的跟踪函数（如果有）。
• .f_trace_lines 表示是否跟踪源代码行，并记录到跟踪函数中。
• .f_trace_opcodes 表示是否跟踪执行的字节码，并记录到跟踪函数中。

这些属性包含了当前帧对象的重要信息，它使得解释器能够在执行函数时跟踪上下文、管理变量和调用栈等等。

应用实例

利用 Python 的 frame 对象，可以实现一些高级的功能，包括调试、跟踪、性能分析、代码注入等等，下面列出一些具体的功能：

1. 调试：可以利用 frame 对象获取当前正在执行的函数的信息，如变量值、代码位置等等，实现自定义的调试器。
2. 跟踪：可以利用 frame 对象在 Python 解释器中跟踪函数的调用和返回，统计函数调用次数和执行时间等等。
3. 性能分析：可以利用 frame 对象监控 Python 代码的性能，统计函数调用次数、执行时间和内存使用等指标，进行性能分析和优化。
4. 代码注入：可以利用 frame 对象在 Python 解释器中动态注入代码，实现一些高级功能，如动态修改代码、进行 AOP 编程等等。

拿到调用函数的局部变量

import inspect
from objprint import op


def f():
    frame = inspect.currentframe()
    print(frame.f_back.f_locals)


def g():
    a = 3
    b = 4
    f()
    return a + b


g()

输出：
函数g中的局部变量a和b

当前函数在哪里被调用

import inspect
from objprint import op


def f():
    frame = inspect.currentframe()
    print(frame.f_back.f_code.co_filename)
    print(frame.f_back.f_lineno)


def g():
    a = 3
    b = 4
    f()
    return a + b


g()

输出：
显示函数f被调用的文件名和行数