如何在C#中获取IronPython脚本的Python调用栈？

我之前也碰到过完全一样的问题——用System.Diagnostics.StackTrace拿到的全是IronPython解释器的CLR调用栈，根本看不到Python脚本里的函数调用链。要解决这个问题，得借助IronPython自身的Runtime API来直接获取Python执行上下文的栈帧信息。

核心思路 #

IronPython提供了访问当前Python执行栈的方法，通过ScriptEngine的Operations属性可以拿到当前的栈帧，然后遍历栈帧链就能得到完整的Python调用栈。

具体实现步骤 #

1. 准备C#可被Python调用的类

首先，在C#中创建一个类，接收ScriptEngine实例（用来获取Python执行上下文），并实现被Python调用的方法：

using IronPython.Hosting;
using IronPython.Runtime;
using Microsoft.Scripting.Hosting;
using System;

public class PythonInteropService
{
    private readonly ScriptEngine _pythonEngine;

    public PythonInteropService(ScriptEngine engine)
    {
        _pythonEngine = engine;
    }

    public void LogPythonCallStack()
    {
        // 获取当前Python执行的栈帧
        var currentFrame = _pythonEngine.Operations.GetFrame();
        
        if (currentFrame == null)
        {
            Console.WriteLine("无法获取Python调用栈：当前没有活跃的Python执行上下文");
            return;
        }

        Console.WriteLine("=== Python调用栈 ===");
        while (currentFrame != null)
        {
            // 提取栈帧关键信息：函数名、脚本文件、行号
            string functionName = currentFrame.FunctionName;
            string scriptFile = currentFrame.GetFileName();
            int lineNumber = currentFrame.GetFileLineNumber();

            Console.WriteLine($"> {functionName} | 文件：{scriptFile} | 行号：{lineNumber}");

            // 遍历上一层栈帧
            currentFrame = currentFrame.GetPreviousFrame();
        }
    }
}

2. 配置IronPython环境并运行脚本

接下来，在C#中初始化IronPython引擎，将PythonInteropService实例注入到Python环境，然后执行测试脚本：

class Program
{
    static void Main(string[] args)
    {
        // 初始化IronPython引擎
        var engine = Python.CreateEngine();
        var scope = engine.CreateScope();

        // 将C#服务实例注入Python环境
        var interopService = new PythonInteropService(engine);
        scope.SetVariable("interop", interopService);

        // 测试Python脚本（包含多层函数调用）
        string pythonScript = @"
def inner_func():
    # 调用C#方法
    interop.LogPythonCallStack()

def middle_func():
    inner_func()

def outer_func():
    middle_func()

# 触发调用链
outer_func()
";

        // 执行脚本
        engine.Execute(pythonScript, scope);
    }
}

3. 运行结果

执行后，控制台会输出Python层面的完整调用栈：

=== Python调用栈 ===
> inner_func | 文件：<string> | 行号：4
> middle_func | 文件：<string> | 行号：7
> outer_func | 文件：<string> | 行号：10
> <module> | 文件：<string> | 行号：13

关键API说明 #

• _pythonEngine.Operations.GetFrame()：获取当前正在执行的Python栈帧，返回PythonStackFrame类型对象。
• PythonStackFrame.FunctionName：获取当前栈帧对应的Python函数名。
• PythonStackFrame.GetFileName()：获取当前栈帧所在的Python脚本文件名（如果是字符串脚本会显示<string>）。
• PythonStackFrame.GetFileLineNumber()：获取当前调用在脚本中的行号。
• PythonStackFrame.GetPreviousFrame()：获取上一层栈帧，用于遍历整个调用链。

注意事项 #

• 确保在Python调用C#方法的同步执行上下文中获取栈帧，如果是异步调用可能无法拿到有效栈帧。
• 需要引用IronPython的NuGet包：IronPython和Microsoft.Scripting（版本建议与IronPython匹配）。

内容的提问来源于stack exchange，提问作者Antonio Luna