I am trying my luck with embedded IronPython 2 using the DLR so I thought I would share some of the steps to make that happen.
Prereqs:
- Microsoft.Scripting.dll
- IronPython.dll
- IronPython.Modules.dll
These all come from the IronPython2 beta 1 release--and yes you need all of them. Failing to add IronPython.Modules.dll as a reference results in strange errors when trying to get the scripting engine which can be confusing.
The interface to IronPython and presumably other DLR languages is through the Microsoft.Scripting.Hosting.ScriptEngine class. There seems to be about a billion ways to get the engine here is what worked for me:
ScriptEngine engine;
engine = PythonEngine.CurrentEngine;
This gets/creates the ScriptEngine for IronPython. Next we create a Microsoft.Scripting.Hosting.ScriptScope which allows for variables to be bound on the embedder's end before the script is run. It also can be inspected after the script is run.
ScriptScope scope = engine.CreateScope();
Now all that is left is to load the script woooo. Doing this creates a Microsoft.Scripting.Hosting.ScriptSource object which can have fun things done to it.
ScriptSource source = engine.CreateScriptSourceFromFile("myScript.py");
source.Execute(scope);
This loads a script and then executes it using the scope that was created. The contents of the scope can be examined afterwards like I said which can be useful if you want to create factories that return an extended C#/CLR class that can then be used like normal.
TacticsGame game = scope.GetVariable("game");
This gets the global "game" form the script. In order for this to work right you need to add the assembly references to your script. This can be done in two ways. First you can do it the normal way from inside the script:
import clr
clr.AddReference("MyAssembly.dll")
This works but its kind of annoying if MyAssembly.dll is actually the same assembly that the script is being hosted in or some other assembly that is known. Another way is to call engine.Runtime.LoadAssembly and feed it assemblies it should know about. See System.Reflection.Assembly for some ways of getting these assemblies.
Hopefully this works a bit better than boo did!
- Embedding example
- An informative but trying on the eyes tutorial.
- IronPython Website
- In all of its official and incompletely documented glory.