Python.NET项目：在.NET中嵌入Python的完整指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01048/article/details/148507608

Python.NET项目：在.NET中嵌入Python的完整指南

pythonnet Python for .NET is a package that gives Python programmers nearly seamless integration with the .NET Common Language Runtime (CLR) and provides a powerful application scripting tool for .NET developers. 项目地址: https://gitcode.com/gh_mirrors/py/pythonnet

前言

Python.NET是一个强大的工具，它允许开发者在.NET环境中无缝集成Python代码。本文将深入探讨如何在.NET应用程序中嵌入Python运行时，并介绍关键概念和最佳实践。

安全警告

在使用Python.NET时，必须注意一个重要安全限制：由于Python代码在Python.NET下运行本质上是不可验证的，它会完全绕过CLR的安全基础设施。因此，开发者应当：

仅将Python程序集用于可信代码
避免在安全敏感的环境中使用不受信任的Python脚本
考虑实施额外的安全层来验证Python代码

核心概念

Python.NET提供了一系列公共类，这些类封装了Python C-API的功能子集，包括：

PyObject：所有Python对象的基类
PyList：对应Python列表
PyDict：对应Python字典
PyTuple：对应Python元组

基础集成步骤

要在.NET应用中嵌入Python，需要遵循以下基本流程：

引用Python.Runtime.dll：通过包管理器或直接引用添加依赖
初始化Python引擎：调用PythonEngine.Initialize()
导入Python模块：使用PyModule.Import(name)导入所需模块

最佳实践是尽早导入Python模块并让Python代码接管大部分逻辑，而不是编写大量托管嵌入代码。

全局解释器锁(GIL)管理

Python使用全局解释器锁(GIL)来保证线程安全，这在嵌入场景中尤为重要。关键要点：

任何与Python.Runtime命名空间的交互都必须先获取GIL
唯一例外是PythonEngine.Initialize方法，它可以在启动时无GIL调用
使用Py.GIL()上下文管理器来安全获取和释放GIL

GIL使用示例

// 推荐方式1：使用using语句
using (Py.GIL())
{
    PythonEngine.Exec("doStuff()");
}

// 推荐方式2：C# 8.0简化语法
{
    using var _ = Py.GIL();
    PythonEngine.Exec("doStuff()");
}

// 显式方式：手动管理
var gil = Py.GIL();
try
{
    PythonEngine.Exec("doStuff()");
}
finally
{
    gil.Dispose();
}

Py.GIL()内部封装了Python C-API的PyGILState_Ensure和PyGILState_Release函数。

将C#对象传递到Python环境

开发者经常需要将.NET对象传递给Python脚本处理。以下是一个完整示例：

定义C#类

public class Person
{
    public Person(string firstName, string lastName)
    {
        FirstName = firstName;
        LastName = lastName;
    }

    public string FirstName { get; set; }
    public string LastName { get; set; }
}

转换和传递对象

// 创建.NET对象
Person person = new Person("John", "Smith");

// 获取GIL
using (Py.GIL())
{
    // 创建Python作用域
    using (PyModule scope = Py.CreateScope())
    {
        // 将Person对象转换为PyObject
        PyObject pyPerson = person.ToPython();

        // 在Python作用域中创建变量
        scope.Set("person", pyPerson);

        // 在Python中使用该对象
        string code = "fullName = person.FirstName + ' ' + person.LastName";
        scope.Exec(code);
    }
}