PyShell
+PyShell
PyShell is an interactive, Python shell. It shares the same base code as PyCrust, but doesn't have any of the extra features that appear in the PyCrust notebook interface.
-
PyShell running on Mandrake Linux.
This document will show you how to use the Py programs and the Py library of Python source code modules. Py is the new name for the project that began as PyCrust. Py is officially part of wxPython, and includes PyCrust, so PyCrust is no longer distributed separately.
Source code documentation for developers is available at:
http://www.orbtech.com/www/wx/epydoc/public/wx.py-module.html
Besides being a delicious dessert, Py is the name for a collection of whimsically-named Python programs and modules that began as the PyCrust project. So Py is really several things: a set of standalone @@ -99,7 +100,7 @@ Python and wxPython, so it works equally well on Windows, Linux and Mac OS X.
This project began with a program I created called PyCrust - an interactive, graphical Python shell, developed using the wxPython GUI toolkit. For about two years, PyCrust was hosted on SourceForge. @@ -136,7 +137,7 @@ use during development, or as an interface for users of your programs. These modules are the same ones used by all the Py programs.
These are the standalone applications in the Py collection:
PyAlaCarte is a Python source code editor. It is designed to have a simple, single-file interface. As a standalone application, it is good for simple, short editing tasks. But it is really meant to be @@ -156,42 +157,42 @@ more of an example of how to embed the Py editor into a wxPython application.
PyCrust is an interactive, Python shell. But it's more than just a shell. It includes a tabbed notebook containing a namespace tree (PyFilling), and several other things.
PyFilling is a namespace viewer. It isn't really useful as a standalone program, but it does illustrate how to make use of the -underlying filling module.
+underlying filling module.PyShell is an interactive, Python shell. It shares the same base code as PyCrust, but doesn't have any of the extra features that appear in the PyCrust notebook interface.
PyShell running on Mandrake Linux.
PyWrap is a runtime utility that lets you run an existing wxPython program with a PyCrust frame at the same time. Inside the PyCrust -shell namespace, the local variable app is assigned to your +shell namespace, the local variable app is assigned to your application instance. In this way you can introspect your entire application within the PyCrust shell, as well as the PyFilling namespace viewer.
Py was designed to be modular. That means graphical code is kept separate from non-graphical code, and many of the Py modules can be used by other programs. Likewise, other programs can supply some of @@ -202,7 +203,7 @@ required, PyCrust will work just as well with your interpreter as with its default interpreter.
This section lists all the changes that have been made to the Py programs and modules, since the beginning.
+Applied a series of enhancments by Franz Steinaeusler, Adi Sieker, and +Sebastian Haase, up until their 7-31-2005 version. (Their next +version broke some existing functionality, and added some confusing +hacks, and I didn't feel that the incremental gains were worth the +loss at that point so I stopped at 7-31-2005.)
+Their changes include the following:
+On top of these changes I (Robin Dunn) added the following:
+Removed wxd decorators in favor of new SWIG-generated docstrings.
Removed docs tabs from crust interface: * wxPython Docs @@ -230,12 +283,12 @@ programs and modules, since the beginning.
empty dictionary.Fun and games with dynamic renaming. Details of any other changes were lost in the confusion. I'll try to do better in the future.
Changed to the new prefix-less "wx" package:
import wx @@ -244,7 +297,7 @@ import wxfrom wxPython import wx-Fixed typo in PyWrap.py:
+Fixed typo in PyWrap.py:
if __name__ == '__main__': main(sys.argv) @@ -256,7 +309,7 @@ if __name__ == '__main__':Added pretty-print Display tab to Crust, based on suggestion from Jason Whitlark.
-Improved Can* checks in EditWindow, since STC is too lenient, +
Improved Can* checks in EditWindow, since STC is too lenient, particularly when it is set to read-only but returns True for CanPaste() (seems like an STC bug to me):
@@ -278,13 +331,13 @@ def CanPaste(self):
PyCrust is dead! Long live Py!
Fixed bug in introspect.py on introspecting objects occurring +
Fixed bug in introspect.py on introspecting objects occurring immediately after a secondary prompt, like this:
>>> l = [1, 2, 3] @@ -299,21 +352,21 @@ immediately after a secondary prompt, like this:
Added PyAlaMode and PyAlaCarte code editors.
-Major refactoring to support editor and shell from the same +
Major refactoring to support editor and shell from the same base.
Renamed program files:
Removed disabling of autocomplete for lists of 2000 items or more. The current implementation of wxSTC can now handle lists this big.
-Improved handling of sys.path to mimic the standard Python shell.
+Improved handling of sys.path to mimic the standard Python shell.
Added fontIncrease, fontDecrease, fontDefault signals, receivers and keybindings:
@@ -332,7 +385,7 @@ documentation and docstrings for wxPython classes and functions.
Filling.tree now expands tuples as well as lists. (It should have +
Filling.tree now expands tuples as well as lists. (It should have done this all along, I just never noticed this omission before.)
Added this True/False test to all modules:
@@ -342,18 +395,18 @@ except NameError:
True = 1==1
False = 1==0
-Added wxd directory with decoration classes.
+Added wxd directory with decoration classes.
Wrapped sys.ps1, sys.ps2, and sys.ps3 in str(). +
Wrapped sys.ps1, sys.ps2, and sys.ps3 in str(). (Thanks, Kieran Holland.)
Fixed minor things found by PyChecker.
-Changed locals to use __main__.__dict__ and added code to clean up +
Changed locals to use __main__.__dict__ and added code to clean up the namespace, making it as close to the regular Python environment as possible. This solves the problem of pickling and unpickling instances of classes defined in the shell.
-Made shell.PasteAndRun() a little more forgiving when it finds a +
Made shell.PasteAndRun() a little more forgiving when it finds a ps2 prompt line with no trailing space, such when you copy code from a web page.
Improved autocomplete behavior by adding these to shell:
@@ -361,10 +414,10 @@ web page. self.AutoCompSetAutoHide(False) self.AutoCompStops(' .,;:([)]}\'"\\<>%^&+-=*/|`') -Added decor directory, decorator.py, stcDecor.py, and -stcConstants.py. These all serve the purpose of adding docstrings -to existing wxPython classes, in particular the wxStyledTextCtrl.
-Added wrap.py, a command line utility for running a wxPython app +
Added decor directory, decorator.py, stcDecor.py, and +stcConstants.py. These all serve the purpose of adding docstrings +to existing wxPython classes, in particular the wxStyledTextCtrl.
+Added wrap.py, a command line utility for running a wxPython app with additional runtime-tools loaded, such as PyCrust (the only tool at this point).
Flushed the clipboard Cut/Copy operations so that selections will @@ -380,24 +433,24 @@ func = 3 .
More Filling!!! The namespace tree is now dynamically updated.
Improved keyboard handling with Autocomplete active. You can now use Enter as well as Tab to select an item from the list.
Disabled autocomplete for lists of 2000 items or more. The current implementation of wxSTC can't handle lists this big.
-Changed filling to always display docstrings for objects. This is +
Changed filling to always display docstrings for objects. This is useful for objects whose docstrings have been decorated, rather than coming directly from the source code. (Hmmm. Sounds like someone is doing some decorating. I wonder where that would be helpful? <wink>)
-Fixed handling of icon. Added images.py file.
+Fixed handling of icon. Added images.py file.
Added "help" to startup banner info.
-Made all wx and stc imports explicit. No more import *.
-Replaced use of the wx module's true and false with -Python's True and False.
-Changed introspect.getRoot() to use tokenize module. This +
Made all wx and stc imports explicit. No more import *.
+Replaced use of the wx module's true and false with +Python's True and False.
+Changed introspect.getRoot() to use tokenize module. This does a slightly better job than the previous parsing routine and the code is clearer.
Improved handling of whitespace and empty types during introspection.
@@ -413,131 +466,131 @@ wxPython Version: 2.3.3.1 Platform: linux2Added copy plus and paste plus to shell menu.
-Moved shell menu from shell.py to shellmenu.py.
-Added sys.stdin.readlines() support.
-Added time.sleep() in readline() and OnIdle() event +
Moved shell menu from shell.py to shellmenu.py.
+Added sys.stdin.readlines() support.
+Added time.sleep() in readline() and OnIdle() event handler to free up the CPU.
Tweaked getAttributeNames() to pick up a few more attributes:
+Tweaked getAttributeNames() to pick up a few more attributes:
'__bases__', '__class__', '__dict__', '__name__', 'func_closure', 'func_code', 'func_defaults', 'func_dict', 'func_doc', 'func_globals', 'func_name'
Added a tests directory and unit tests.
-Improved support for empty types in the shell: [], () and -{} as far as when call tips and autocompletion are available.
-Added support for the other triple string - ''''''.
-Refactored introspect.py to improve testability.
+Improved support for empty types in the shell: [], () and +{} as far as when call tips and autocompletion are available.
+Added support for the other triple string - ''''''.
+Refactored introspect.py to improve testability.
Improved call tips for unbound methods by leaving the "self" parameter, since unbound methods require an instance be passed.
Fixed call tip bug where a tip was displayed when a "(" was typed after an object that wasn't callable.
-Fixed getAllAttributeNames when str(object) fails.
+Fixed getAllAttributeNames when str(object) fails.
Added brace highlighting. (Thank you, Kevin Altis.)
-Fixed problem displaying unicode objects in PyFilling.
-Changed how filling.py checks for expandable objects. Lists are +
Fixed problem displaying unicode objects in PyFilling.
+Changed how filling.py checks for expandable objects. Lists are now expandable objects.
Made the key handling more robust when there is an active text selection that includes text prior to the last primary prompt. Thanks to Raul Cota for pointing this out.
Fixed wxSTC problem with brace highlighting and non-us keyboards. (Thank you for the patch, Jean-Michel Fauth.)
-Added busy = wxBusyCursor() to key points in shell and -filling.
-Added OnCloseWindow handler to ShellFrame and CrustFrame.
-Default to SetWrapMode(1) for shell and namespace viewer.
-Added shell.wrap() and shell.zoom().
+Added busy = wxBusyCursor() to key points in shell and +filling.
+Added OnCloseWindow handler to ShellFrame and CrustFrame.
+Default to SetWrapMode(1) for shell and namespace viewer.
+Added shell.wrap() and shell.zoom().
Added autoCompleteKeys hooks for Raul Cota.
Cleaned up various little key handling bugs.
Changed input methods to get values from shell, rather than dialog -boxes. Renamed readIn to readline and readRaw to -raw_input.
+boxes. Renamed readIn to readline and readRaw to +raw_input.Fixed OnChar() issues effecting European keyboards, as reported by +
Fixed OnChar() issues effecting European keyboards, as reported by Jean-Michel Fauth.
-Fixed introspect.py issue with xmlrpc objects reported by Kevin +
Fixed introspect.py issue with xmlrpc objects reported by Kevin Altis.
Fixed some introspect/PyFilling issues with regard to Python 2.2.
Fixed font background color as reported by Keith J. Farmer. (Thanks)
Fixed problem with call tips and autocompletion inside multiline commands as report by Kevin Altis.
-Improved OnKeyDown handling of cut/copy/paste operations based on +
Improved OnKeyDown handling of cut/copy/paste operations based on feedback from Syver Enstad. (Thanks)
-Added a shell.help() method to display some help info.
+Added a shell.help() method to display some help info.
Changed sort of items in the namespace viewer to case insensitive.
-Changed attributes.sort(lambda x, y: cmp(x.upper(), y.upper())) in +
Changed attributes.sort(lambda x, y: cmp(x.upper(), y.upper())) in advance of an upcoming fix to an autocompletion matching bug in wxSTC.
Improved support for ZODB by allowing namespace drilldown into BTrees.
-Added shell.PasteAndRun() to support pasting multiple commands into +
Added shell.PasteAndRun() to support pasting multiple commands into the shell from the clipboard. Ctrl+Shift+V or v.
Enter now always processes a command (or copies down a previous one.) To insert a line break, press Ctrl+Enter.
Escape key clears the current, unexecuted command.
History retrieval changed to replace current command. Added new keys to insert from history - Shift+Up and Shift+Down.
-Better call tips on objects with __call__ methods.
+Better call tips on objects with __call__ methods.
Improved call tip positioning calculation.
Changed how command history retrieval functions work. Added Alt-P, Alt-N as keybindings for Retrieve-Previous, Retrieve-Next.
Added full support for multi-line commands, similar to IDLE.
-Changed introspect.getAttributeNames() to do a case insensitive +
Changed introspect.getAttributeNames() to do a case insensitive sort.
Changed Cut/Copy/Paste to deal with prompts intelligently. Cut and Copy remove all prompts. Paste can handle prompted or not-prompted text.
-Added CopyWithPrompts() method attached to Ctrl-Shift-C for those +
Added CopyWithPrompts() method attached to Ctrl-Shift-C for those times when you really do want all the prompts left intact.
Improved handling of the shell's read-only zone.
-Changed CrustFrame.__init__ parameter spec to include all -parameters allowed by a wxFrame.
-Changed FillingText to be read-only.
-Renamed PyCrust.py to PyCrustApp.py to eliminate -package/module name conflicts that kept you from doing from PyCrust -import shell inside files located in the PyCrust directory.
-Renamed PyFilling.py to PyFillingApp.py and PyShell.py to -PyShellApp.py to maintain consistency.
-Removed the __date__ property from all modules.
-Fixed bug in introspect.getCallTip(), reported by Kevin Altis.
+Changed CrustFrame.__init__ parameter spec to include all +parameters allowed by a wxFrame.
+Changed FillingText to be read-only.
+Renamed PyCrust.py to PyCrustApp.py to eliminate +package/module name conflicts that kept you from doing from PyCrust +import shell inside files located in the PyCrust directory.
+Renamed PyFilling.py to PyFillingApp.py and PyShell.py to +PyShellApp.py to maintain consistency.
+Removed the __date__ property from all modules.
+Fixed bug in introspect.getCallTip(), reported by Kevin Altis.
Changed Shell.run() to always position to the end of existing +
Changed Shell.run() to always position to the end of existing text, as suggested by Raul Cota.
-Changed introspect.getAllAttributeNames() to break circular -references in object.__class__, which occurs in Zope/ZODB +
Changed introspect.getAllAttributeNames() to break circular +references in object.__class__, which occurs in Zope/ZODB extension classes.
-Changed filling.FillingTree.getChildren() to introspect extension +
Changed filling.FillingTree.getChildren() to introspect extension classes.
-Fixed minor bugs in introspect.getCallTip() that were interfering +
Fixed minor bugs in introspect.getCallTip() that were interfering with call tips for Zope/ZODB extension class methods.
In preparation for wxPython 2.3.2, added code to fix a font sizing problem. Versions of wxPython prior to 2.3.2 had a sizing bug on Win platform where the font was 2 points larger than what was specified.
-Added a hack to introspect.getAllAttributeNames() to "wake up" +
Added a hack to introspect.getAllAttributeNames() to "wake up" ZODB objects that are asleep - in a "ghost" state. Otherwise it returns incomplete info.
Added PyFilling.py and filling.py.
-PyShell.py and PyFilling.py can now be run standalone, as well -as PyCrust.py.
-Added crust.py and moved some code from PyCrust.py to it.
+Added PyFilling.py and filling.py.
+PyShell.py and PyFilling.py can now be run standalone, as well +as PyCrust.py.
+Added crust.py and moved some code from PyCrust.py to it.
Added command history retrieval features submitted by Richie Hindle.
-Changed shell.write() to replace line endings with OS-specific -endings. Changed shell.py and interpreter.py to use -os.linesep in strings having hardcoded line endings.
-Added shell.redirectStdin(), shell.redirectStdout() and -shell.redirectStderr() to allow the surrounding app to toggle -requests that the specified sys.std* be redirected to the shell. +
Changed shell.write() to replace line endings with OS-specific +endings. Changed shell.py and interpreter.py to use +os.linesep in strings having hardcoded line endings.
+Added shell.redirectStdin(), shell.redirectStdout() and +shell.redirectStderr() to allow the surrounding app to toggle +requests that the specified sys.std* be redirected to the shell. These can also be run from within the shell itself, of course.
The shell now adds the current working directory "." to the search path:
@@ -547,34 +600,34 @@ sys.path.insert(0, os.curdir)Added support for distutils installations.
Changed default font size under Linux to:
'size' : 12, 'lnsize' : 10,-
Changed Shell to expect a parameter referencing an Interpreter +
Changed Shell to expect a parameter referencing an Interpreter class, rather than an intepreter instance, to facilitate subclassing of Interpreter, which effectively broke when the Editor class was eliminated.
-Fixed PyCrustAlaCarte.py, which had been broken by previous +
Fixed PyCrustAlaCarte.py, which had been broken by previous changes.
-Created InterpreterAlaCarte class as an example for use in the +
Created InterpreterAlaCarte class as an example for use in the demo.
-Split PyCrust.py into PyCrust.py and PyShell.py in -anticipation of PyFilling.py.
+Split PyCrust.py into PyCrust.py and PyShell.py in +anticipation of PyFilling.py.
Added patch to PyCrust.py to fix wxPython bug:
+Added patch to PyCrust.py to fix wxPython bug:
wxID_SELECTALL = NewId() # This *should* be defined by wxPython.
Shortened module names by dropping "PyCrust" as a prefix.
-Changed version to VERSION in version module.
+Changed version to VERSION in version module.
Added Options menu to PyCrust application.
Eliminated the Editor class (and editor module) by merging with Shell. This means that Shell "is a" wxStyledTextCtrl rather than "has a". @@ -583,18 +636,18 @@ Plus, Shell will be much easier for gui toolkits/designers to deal with now.
Added introspect module.
-Moved some functionality from PyCrustInterp to introspect.
-Changed introspect.getRoot() to no longer remove whitespace from +
Added introspect module.
+Moved some functionality from PyCrustInterp to introspect.
+Changed introspect.getRoot() to no longer remove whitespace from the command. This was a remnant of a previous approach that, when left as part of the current approach, turned out to be a really bad thing.
-Changed introspect.getRoot() to allow commands of '', "", -"""""", [], (), and {} to pass through. This allows +
Changed introspect.getRoot() to allow commands of '', "", +"""""", [], (), and {} to pass through. This allows you to type them, followed by a dot, and get autocomplete options on them.
-Changed introspect.getRoot() to identify some situations where +
Changed introspect.getRoot() to identify some situations where strings shouldn't be considered roots. For example:
>>> import PyCrust # To illustrate the potential problem.
@@ -620,7 +673,7 @@ and that is NOT handled properly. For example:
>>> len('This is PyCrust.py')
More code needs to be written to handle more complex situations.
-Added locals=None parameter to Shell.__init__().
+Added locals=None parameter to Shell.__init__().
Added support for magic attribute retrieval. Users can change this with:
@@ -634,45 +687,45 @@ exclude one or the other or both with: >>> shell.editor.autoCompleteExcludeDouble = 1
Mostly just a final version change before creating a release.
Changed version/revision handling.
Fixed bugs.
Removed lots of cruft.
Added lots of docstrings.
Imported to CVS repository at SourceForge.
Added call tips.
Renamed several files.
Added command autocompletion.
Added menus to PyCrust.py: File, Edit and Help.
-Added sample applications: PyCrustAlaCarte.py, -PyCrustAlaMode.py, and PyCrustMinimus.py.
+Added sample applications: PyCrustAlaCarte.py, +PyCrustAlaMode.py, and PyCrustMinimus.py.
Added basic syntax coloring much like Boa.
Added read-only logging much like IDLE.
Can retrieve a previous command by putting the cursor back on that line and hitting enter.
-Stdin and raw_input operate properly so you can now do help() and -license() without hanging.
+Stdin and raw_input operate properly so you can now do help() and +license() without hanging.
Redefined "quit", "exit", and "close" to display a better-than-nothing response.
Home key honors the prompt.
Created SourceForge account, but nothing was posted.
Blame it all on IDLE, Boa and PythonWin. I was using all three, got frustrated with their dissimilarities, and began to let everyone know how I felt. At the same time, Scintilla looked like an interesting