如何用C#提取Python函数？求优化实现的最佳实践与NuGet包推荐

你的当前实现依赖正则表达式匹配，存在诸多局限性：

• 无法提取文件末尾的函数（正则依赖后续的def作为终止符）
• 函数内部嵌套def时，会提前截断内容
• 注释或字符串中的def会导致误匹配
• 无法处理多行函数定义、带装饰器的函数等复杂场景

以下是更可靠的改进方案：

最佳实践 #

• 放弃正则解析代码：正则仅适合简单文本模式匹配，无法处理Python代码的语法结构（嵌套、注释、字符串字面量等），解析代码的正确方式是使用抽象语法树（AST）。
• 利用Python原生解析能力：Python标准库的ast模块能精准解析代码生成AST，可可靠定位函数定义，避免手动匹配的各种漏洞。
• 区分顶层与嵌套函数：明确需求是提取顶层函数还是包含内部函数，通过AST可精准筛选节点类型。

推荐NuGet包与实现示例 #

1. Python.Runtime（Python.NET） #

通过嵌入Python环境，直接调用Python的ast模块完成解析，是最便捷的方案。

首先安装NuGet包：Python.Runtime

示例代码：

using Python.Runtime;
using System.IO;

class Program
{
    static void Main(string[] args)
    {
        PythonEngine.Initialize();
        var pythonFilePath = @"C:\Users\batchus\source\repos\app\states.py";
        var functionName = "processS";

        try
        {
            using (Py.GIL())
            {
                var code = File.ReadAllText(pythonFilePath);
                var astModule = Py.Import("ast");
                var astTree = astModule.parse(code);

                foreach (var node in astTree.body)
                {
                    // 检查是否是函数定义节点，且名称匹配
                    if (node.HasAttr("name") && node.name.ToString() == functionName)
                    {
                        // 将AST节点转回代码字符串（Python 3.9+支持ast.unparse）
                        var functionCode = astModule.unparse(node);
                        Console.WriteLine(functionCode);
                        return;
                    }
                }

                Console.WriteLine($"Function '{functionName}' not found.");
            }
        }
        finally
        {
            PythonEngine.Shutdown();
        }
    }
}

2. ANTLR4 #

如果需要纯C#实现，可使用ANTLR4生成Python语法解析器，手动遍历语法树提取函数。

步骤：

• 安装NuGet包：Antlr4.Runtime.Standard
• 下载官方Python 3语法文件Python3.g4
• 使用ANTLR工具生成C#版解析器代码
• 编写代码遍历语法树，匹配函数定义节点

示例核心逻辑：

using Antlr4.Runtime;
using Antlr4.Runtime.Tree;
using System.Text;

class Program
{
    static void Main(string[] args)
    {
        var pythonFilePath = @"C:\Users\batchus\source\repos\app\states.py";
        var functionName = "processS";
        var input = File.ReadAllText(pythonFilePath);

        var stream = new AntlrInputStream(input);
        var lexer = new Python3Lexer(stream);
        var tokens = new CommonTokenStream(lexer);
        var parser = new Python3Parser(tokens);
        var tree = parser.file_input();

        // 遍历语法树，查找目标函数
        var walker = new ParseTreeWalker();
        var listener = new FunctionExtractor(functionName);
        walker.Walk(listener, tree);

        if (!string.IsNullOrEmpty(listener.FunctionCode))
        {
            Console.WriteLine(listener.FunctionCode);
        }
        else
        {
            Console.WriteLine($"Function '{functionName}' not found.");
        }
    }
}

// 自定义ANTLR监听器，提取目标函数
class FunctionExtractor : Python3BaseListener
{
    private readonly string _targetFunction;
    public string FunctionCode { get; private set; }
    private bool _isTargetFunction;
    private readonly StringBuilder _codeBuilder = new();

    public FunctionExtractor(string targetFunction)
    {
        _targetFunction = targetFunction;
    }

    public override void EnterFuncdef(Python3Parser.FuncdefContext context)
    {
        var funcName = context.NAME().GetText();
        if (funcName == _targetFunction)
        {
            _isTargetFunction = true;
        }
    }

    public override void ExitFuncdef(Python3Parser.FuncdefContext context)
    {
        if (_isTargetFunction)
        {
            FunctionCode = _codeBuilder.ToString();
            _isTargetFunction = false;
        }
        _codeBuilder.Clear();
    }

    public override void VisitTerminal(ITerminalNode node)
    {
        if (_isTargetFunction)
        {
            _codeBuilder.Append(node.GetText());
        }
    }
}

总结 #

使用AST或语法解析器是提取代码元素的标准方案，完全规避正则的局限性。如果追求快速实现，优先选择Python.Runtime；如果需要纯C#环境，可基于ANTLR4构建解析逻辑。

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