Embedding a Python shell inside a Python program

Question

I am making a sort of a science lab in Python, in which the user can create, modify and analyze all sorts of objects. I would like to put a Python shell inside the program, so the user could manipulate the objects through the shell. (Note: He could also manipulate the objects through the usual GUI.)

A mockup that illustrates this: http://cool-rr.com/physicsthing/physicsthing_mockup_thumb.gif

How can I make this sort of thing?

I considered using eval, but I understood that eval can't handle import, for example.

Answer 1

You are looking for code - Interpreter base classes, particularly code.interact().

Some examples from effbot.

Answer 2

Depending on your GUI framework, it may already has been done:

• For wxpython, look up "PyCrust" - it's very easy to embed into your app
• For PyQt, pyqtshell (Update 29.04.2011: these days called spyder)

Here's what I did to embed PyCrust into the application:

import wx.py.crust
...
...
# then call

crustFrame = wx.py.crust.CrustFrame(parent = self)
crustFrame.Show()

The self here refers to my main frame (derived from wx.Frame). This creates a PyCrust window that runs in your application and allows you to inspect everything stored in your main frame (because of the self).