在C#环境中动态调用IronPython脚本(一）

Posted 2020-07-03

   本文讲述用C#调用Ironpython运行环境，解析并运行动态pyhton脚本。这种情况应用在那些需要滞后规定行为的场合，例如，动态计算项（计算引擎），用户可以自定义计算内容、计算公式等。

        本文的代码适用于IronPython 2.7(需要下载及安装)及C#4.0，由于IronPython早期版本提供的Hosting API不同，对于网上搜索得到的代码，如果是早期版本代码（多数如此），并不能编译通过，所以本文强调代码的版本问题。

        本文代码需要引用两个命名空间IronPython和Microsoft.Scripting (文件位置分别为IronPython 2.7的安装目录下的IronPython.dll和Microsoft.Scripting.dll)。 

一、最简单的例子

        先看一个最简单的例子，C#环境与Python环境没有数据联系。       

[csharp] view plain copy

 

1. public static void test1()  
2. {  
3.       var engine = IronPython.Hosting.Python.CreateEngine();  
4.       engine.CreateScriptSourceFromString("print ‘hello world‘").Execute();  
5.       Console.ReadLine();  
6. }  

        如果IronPython环境建立好，运行test1()，就会得到正确的结果。如果只想运行一段脚本，就是这般简单。

二、C#环境调用Python环境函数

        以上的例子没有实用价值，再看第二个例子，这个例子演示了如何从C#环境调用Python环境中的函数以及类中方法。

[csharp] view plain copy

 

1. public static void test2()  
2.        {  
3.            var engine = Python.CreateEngine();  
4.            var scope = engine.CreateScope();  
5.            var source = engine.CreateScriptSourceFromString(  
6.                "def adder(arg1, arg2):\n" +  
7.                "   return arg1 + arg2\n" +  
8.                "\n" +  
9.                "def fun(arg1):\n" +  
10.                "   tel = {‘jack‘: 4098, ‘sape‘: 4139}\n" +  
11.                "   for k, v in arg1.iteritems():\n"+  
12.                "      tel[k]=v\n"+  
13.                "   return tel\n" +  
14.                "\n" +  
15.                "class MyClass(object):\n" +  
16.                "   def __init__(self, value):\n" +  
17.                "       self.value = value\n");  
18.            source.Execute(scope);  
19.   
20.            var adder = scope.GetVariable<Func<object, object, object>>("adder");  
21.            Console.WriteLine(adder(2, 2));  
22.   
23.            var fun = scope.GetVariable<Func<object, object>>("fun");  
24.            IronPython.Runtime.PythonDictionary inputDict = new IronPython.Runtime.PythonDictionary();  
25.            inputDict["abc"] = "abc";  
26.            inputDict["def"] = 456;  
27.            object res = fun(inputDict);  
28.            IronPython.Runtime.PythonDictionary outputDict = res as IronPython.Runtime.PythonDictionary;  
29.            foreach (var k in outputDict.Keys)  
30.            {  
31.                Console.WriteLine("key:"+ k.ToString()+" val:  " + outputDict[k].ToString());  
32.            }  
33.   
34.            var myClass = scope.GetVariable<Func<object, object>>("MyClass");  
35.            var myInstance = myClass("hello");  
36.   
37.            Console.WriteLine(engine.Operations.GetMember(myInstance, "value"));  
38.        }  

上面代码中，python中有两个函数和一个类，第一个函数的参数是简单数据类型，第二个是复杂数据类型（关于两个环境下复杂数据类型的对应，下面将论述）。无论是类还是函数，C#的调用方法都是通过ScriptScope.GetVariable，它的函数定义如下：

T GetVariable<T>(string name);

ScriptScope还有一个更“安全”的方法

boolTryGetVariable<T>(string name, out T value);

可以完成相似的操作。

这个例子，可以扩展C#的应用，例如，python有丰富的数学计算库，而C#在这方面较欠缺，这时，就可以采用上面的方式，计算部分采用现成的python库，而主控程序采用C#编制。

三、在Python环境中调用C#环境函数

现在看第三个例子，如果Python运行逻辑复杂，需要在运行过程中调用C#函数怎么办？

 

[csharp] view plain copy

 

1. public static void test3()  
2.         {  
3.             var engine = Python.CreateEngine();  
4.             var scope = engine.CreateScope();  
5.   
6.             scope.SetVariable("my_object_model", new CSharpClass ());  
7.             string pythonscript =  
8.                 "def fun(arg1):\n" +  
9.                 "   result = arg1+1\n" +  
10.                 "   return result\n" +  
11.                 "adder = fun(5) + my_object_model.Foo(2)\n" ;  
12.              engine.CreateScriptSourceFromString(pythonscript).Execute(scope);  
13.              Console.WriteLine(scope.GetVariable("adder"));  
14.         }  
15. Class CSharpClass  
16. {  
17.         public int Foo(int arg)  
18.         {  
19.            return  arg +1;  
20.         }  
21. }  

 

这个例子中，创建CShparpClass类，并将其作为“变量”传到Python环境中，在Python中就可以调用了。注意到C#中的类名可以和Python中不一样。

 

 

四、在Python环境中动态调用C#库

        在这种情况下，Python脚本和C#库都是“滞后”于主应用才编写出来的，可以满足用户现场定制行为（采用Python脚本），并且可以给Python脚本传入现场定制的参数。

首先，建立一个C#库，代码如下：

 

[csharp] view plain copy

 

1. namespace LibforPython  
2. {  
3.     public class PythonLib  
4.     {  
5.         public int Test(int x, string op)  
6.         {  
7.             switch (op.ToUpper())  
8.             {  
9.                 case "INC":  
10.                     return x + 1;  
11.                 case "DEC":  
12.                     return x - 1;  
13.             }  
14.             return x + 1;  
15.         }  
16.     }  
17. }  

编译成LibforPython.dll后拷贝到主运行程序的运行目录（二者同目录）。调用代码如下：

 

[csharp] view plain copy

 

1. public static void test4()  
2.   {  
3.       var engine = Python.CreateEngine();  
4.       var scope = engine.CreateScope();  
5.       engine.Runtime.LoadAssembly(Assembly.LoadFrom("LibforPython.dll"));              string pythonscript =  
6.          "from LibforPython import PythonLib\n" +  
7.          "o = PythonLib()\n" +  
8.          "res = o.Test(6,‘add‘)\n";  
9.       engine.CreateScriptSourceFromString(pythonscript).Execute(scope);  
10.       Console.WriteLine(scope.GetVariable("res"));  
11.   }  

 

运行以上程序即可。这个例子中，LibforPython.dll是在运行时才引入Python环境中的。对于预先已知的Python可能用到的接口，才用例三的办法更好些，对于预先无法预先定义或“遗忘”的接口，采用本例比较适合。

 

五、总结

    将Python环境“寄宿”于C#环境，进而动态执行用户自定义的脚本，是应用可配置性、灵活性的一种体现（其他动态语言也可以这么做，以Ironpython比较简单）。这一过程包括以下三步：

           var engine = Python.CreateEngine();

           var scope = engine.CreateScope();

           var source = engine.CreateScriptSourceFromString(“…”);

           source.Execute(scope);

Python环境与宿主环境的交互（参数传入、传出），则通过ScriptScop的GetVariable和SetVariable进行。