Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles
(untagged)

IronTextBox2

0.00/5 (No votes)
20 Jun 2008 2  
A CLI control for IronPython 2.0B2+.

Introduction

As of this writing, IronPython version 2 (IP2) is now in beta after months of alpha builds so I decided it was safe enough to start on the next version of IronTextBox to work with IP2. If you are working with IP1.1, here is the version of IronTextBox that will work with IP1.1. Many new IronPython users often ask how to host an IronPythonEngine within a Form, or for simple out of the box code to look at. I first created IronTextBox when IronPython was rather new. Since then, many improvements and other development tools have been developed by Microsoft to help dissect Python code, like IronPython Studio. IronTextBox is still pretty handy because you can quickly browse to one Python file on the fly and get it running in the CLI.

IronTextBox.dll Library

IronTextBox was designed to be a CLI-like control to be drag-n-dropped into a Form or other .NET controls.

  • UIIronTextBox: is the main namespace
  • UIIronTextBox.IPEWrapper: Overridden Stream class to handle IP output
  • UIIronTextBox.Paths: Easily accessible common paths
  • UIIronTextBox.Utils: Not much here, just some early experimentation with debugging

IronTextBox.dll Classes

What's Different in IronTextBox 2?

Too much has changed from IronPython 1.1 but one of the biggest changes in my mind is the PythonEngine and running Python code. IP2 is more centered around the namespace Microsoft.Scripting. So, you can not easily create a PythonEngine object and start running. In IronTextBox, I created three methods which pretty much handle the main things that need to happen and to easily replace IronTextBox version 1 code:

/// Executes the Python file within the IronTextBox environment.
/// A nice way to quickly get a Python module in CLI to test or use.
object DoIPExecuteFile(string pyfile)
{
    ScriptSource source = engine.CreateScriptSourceFromFile(pyfile);
    return source.Execute(scope);
}

/// Executes the code in SourceCodeKind.SingleStatement to fire the command event
/// Use DoIPEvaluate if you do not wish to fire the commandevent
object DoIPExecute(string pycode)
{
    ScriptSource source = engine.CreateScriptSourceFromString(pycode, 
                          SourceCodeKind.SingleStatement);
    return source.Execute(scope);
}

/// Executes the code in SourceCodeKind.Expression not to fire the command event
/// Use DoIPExecute if you do wish to fire the commandevent
object DoIPEvaluate(string pycode)
{
    ScriptSource source = engine.CreateScriptSourceFromString(pycode, 
                          SourceCodeKind.Expression);
    return source.Execute(scope);
}

Here are some details on what's new in each file:

//Paths.cs - version 2.0.2.0b
//
// WHAT'S NEW:
//      - Updated IronPython_Tutorial to point to IronPython 2.0B2 path
//      - Added Python25Dirs 
////////////////////////////////////
//IronTextBox.cs - version 2.0.2.0b
//WHAT'S NEW: 
//      -IronPython 2.0B2 Support
//      -Removed ParsetheText() since IronPython.Compiler.Ast removed in IP2SimEnter();
//      -Added DoIPExecuteFile(), DoIPExecute(), DoIPEvaluate()
////////////////////////////////////

Usage

When using IronTextBox, your executable directory must contain:

  • IronTextBox.dll
  • IronPython.dll
  • IronPython.Modules.dll
  • Microsoft.Scripting.Core.dll
  • Microsoft.Scripting.dll

Just add references to these in your project and set Properties for Copy Local to True. All of these files (besides IronTextBox.dll, of course) is found in the IronPython 2.0B2 download.

Tip: try including the files above if you receive the following exception: "Microsoft.Scripting.InvalidImplementationException : Type 'IronPython.Runtime.PythonContext' doesn't provide a suitable public constructor or its implementation is faulty."

Running this Demo

  1. Make sure you have downloaded and extracted IronPython 2.0B2 (or try IronPython's main website for the latest release). FYI: I have hardcoded the IronPython script folder to Environment.SpecialFolder.MyDocuments + @"\Visual Studio 2008\Projects\IronPython-2.0B2\Tutorial" in the project. However, I have implemented an OpenFileDialog to correct any incorrect paths.
  2. Download and unzip this article's .NET solution and project files.
  3. From MS VC# 2008 Solution Explorer, add a reference by browsing to IronPython.dll, IronPython.Modules.dll, Microsoft.Scripting.Core.dll, Microsoft.Scripting.Core.dll, and Microsoft.Scripting.dll located where you extracted the IronPython download.

If you are new to IronPython, you may run the IronTextBox command 'runfile' and then browse to IronPython-2.0B2\Tutorial\first.py; notice how you may use add, factorial, and print hi. You can run a 'dir()' command to see what is available.

Conclusion

IronTextBox v2 can be dropped into a Form to provide a Command Line Interface (CLI) with IronPython 2.0B2. The previous version of IronTextBox works with IP1.1. IronTextBox also displays ways to work with IronPython 2.0B2.

References

Updates

  • 5/26/08
    • Article and IronTextBox version 2.0.2.0 posted.
  • 6/10/08
    • Compiled and tested with IronPython 2.03B.
    • Updated source License from GNU to Expat/MIT.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here