X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c66cd08ab73f5cabafd533e87650234422f4415c..8c065688b7120799bf58fada396bce4e431132a6:/wxPython/docs/PyManual.html diff --git a/wxPython/docs/PyManual.html b/wxPython/docs/PyManual.html index 73ba351eb2..1a1199e639 100644 --- a/wxPython/docs/PyManual.html +++ b/wxPython/docs/PyManual.html @@ -3,7 +3,7 @@ - + The Py Manual @@ -30,64 +30,65 @@ 1.5 -
-

Contents

+
+

Contents

-
-

Introduction

+
+

Introduction

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.

-
-

Developer Reference

+
+

Developer Reference

Source code documentation for developers is available at:

http://www.orbtech.com/www/wx/epydoc/public/wx.py-module.html

-
-

What is Py?

+
+

What is Py?

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 @@ -98,8 +99,8 @@ do something, you might as well do it all the way, right?) Py uses Python and wxPython, so it works equally well on Windows, Linux and Mac OS X.

-
-

PyCrust is dead! Long live Py!

+
+

PyCrust is dead! Long live Py!

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. @@ -135,8 +136,8 @@ wxPython applications to provide similar services, either for your own use during development, or as an interface for users of your programs. These modules are the same ones used by all the Py programs.

-
-

Py standalone programs

+
+

Py standalone programs

These are the standalone applications in the Py collection:

  • PyAlaCarte
  • @@ -147,42 +148,42 @@ These modules are the same ones used by all the Py programs.

  • PyWrap
-
-

PyAlaCarte

+
+

PyAlaCarte

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 more of an example of how to embed the Py editor into a wxPython application.

-
-

PyAlaMode

+
+

PyAlaMode

PyAlaMode is a Python source code editor.

-
-

PyCrust

+
+

PyCrust

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

+
+

PyFilling

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.

-
-

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.

-
screenshots/PyShell.png
+screenshots/PyShell.png

PyShell running on Mandrake Linux.

-
-

PyWrap

+
+

PyWrap

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 @@ -190,8 +191,8 @@ application instance. In this way you can introspect your entire application within the PyCrust shell, as well as the PyFilling namespace viewer.

-
-

Py modules

+
+

Py modules

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 @@ -201,8 +202,8 @@ application. As long as it supports the minimum functionality required, PyCrust will work just as well with your interpreter as with its default interpreter.

-
-

Projects using Py

+
+

Projects using Py

-
-

History of changes

+
+

History of changes

This section lists all the changes that have been made to the Py programs and modules, since the beginning.

-
-

0.9.4 (1/25/2004 to //2004)

+
+

0.9.5 (12/23/2005)

+

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:

+
    +
  • The Autocomplete and Calltip windows can now be opened manually with +Ctrl-Space and Ctrl-Shift-Space.
  • +
  • In the stand alone PyCrust app the various option settings, window +size and position, and etc. are saved and restored at the next run.
  • +
  • Added a help dialog bound to the F1 key that shows the key bindings.
  • +
  • Added a new text completion function that suggests words from the +history. Bound to Shift-Return.
  • +
  • F11 will toggle the maximized state of the frame.
  • +
  • switched to Bind() from wx.EVT_*().
  • +
  • Display of line numbers can be toggled.
  • +
  • F12 toggles a "free edit" mode of the shell buffer. This mode is +useful, for example, if you would like to remove some output or +errors or etc. from the buffer before doing a copy/paste. The free +edit mode is designated by the use of a red, non-flashing caret.
  • +
  • Ctrl-Shift-F will fold/unfold (hide/show) the selected lines.
  • +
+

On top of these changes I (Robin Dunn) added the following:

+
    +
  • General code cleanup and fixes.
  • +
  • Use wx.StandardPaths to determine the location of the config files.
  • +
  • Remove Orbtech attributions from the UI, they've been there long +enough.
  • +
  • Use wx.SP_LIVE_UPDATE on crust and filling windows.
  • +
  • Extended the saving of the config info and other new features to the +PyShell app too. Additionally, other apps that embed a PyCrust or a +PyShell can pass their own wx.Config object and have the Py code +save/restore its settings to/from there.
  • +
  • All of the classes with config info get an opportunity to save/load +their own settings instead of putting all the save/load code in one +place that then has to reach all over the place to do anything.
  • +
  • Enable editing of the startup python code, which will either be the +file pointed to by PYTHONSTARTUP or a file in the config dir if +PYTHONSTARTUP is not set in the environment.
  • +
  • Added an option to skip the running of the startup code when +PyShell or PyCrust starts.
  • +
  • PyCrust adds a pp(item) function to the shell's namespace that +pretty prints the item in the Display tab of the notebook. Added +code to raise that tab when pp() is called.
  • +
  • Added an option for whether to insert text for function parameters +when popping up the call tip.
  • +
  • Added Find and Find-Next functions that use the wx.FindReplaceDialog.
  • +
+
+
+

0.9.4 (1/25/2004 to //2004)

Removed wxd decorators in favor of new SWIG-generated docstrings.

Removed docs tabs from crust interface: * wxPython Docs @@ -229,13 +282,13 @@ programs and modules, since the beginning.

Changed default namespace of Shell to __main__.__dict__, instead of an empty dictionary.

-
-

0.9.3 (9/25/2003 to 1/24/2004)

+
+

0.9.3 (9/25/2003 to 1/24/2004)

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.

-
-

0.9.2 (5/3/2003 to 9/25/2003)

+
+

0.9.2 (5/3/2003 to 9/25/2003)

Changed to the new prefix-less "wx" package:

 import wx
@@ -277,8 +330,8 @@ def CanPaste(self):
     return stc.StyledTextCtrl.CanPaste(self) and self.CanEdit()
 
-
-

0.9.1 (3/21/2003 to 5/2/2003)

+
+

0.9.1 (3/21/2003 to 5/2/2003)

PyCrust is dead! Long live Py!

  • Renamed PyCrust package to py.
  • @@ -312,8 +365,8 @@ base.

    The current implementation of wxSTC can now handle lists this big.

    Improved handling of sys.path to mimic the standard Python shell.

-
-

0.9 (2/27/2003 to 3/20/2003)

+
+

0.9 (2/27/2003 to 3/20/2003)

Added fontIncrease, fontDecrease, fontDefault signals, receivers and keybindings:

@@ -344,8 +397,8 @@ except NameError:
 

Added wxd directory with decoration classes.

-
-

0.8.2 (1/5/2003 to 2/26/2003)

+
+

0.8.2 (1/5/2003 to 2/26/2003)

Wrapped sys.ps1, sys.ps2, and sys.ps3 in str(). (Thanks, Kieran Holland.)

Fixed minor things found by PyChecker.

@@ -379,8 +432,8 @@ func = 3 .

More Filling!!! The namespace tree is now dynamically updated.

-
-

0.8.1 (12/20/2002 to 12/25/2002)

+
+

0.8.1 (12/20/2002 to 12/25/2002)

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 @@ -391,8 +444,8 @@ 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.

-
-

0.8 (10/29/2002 to 12/16/2002)

+
+

0.8 (10/29/2002 to 12/16/2002)

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 @@ -418,8 +471,8 @@ Platform: linux2

Added time.sleep() in readline() and OnIdle() event handler to free up the CPU.

-
-

0.7.2 (2/22/2002 to 8/27/2002)

+
+

0.7.2 (2/22/2002 to 8/27/2002)

Tweaked getAttributeNames() to pick up a few more attributes:

 '__bases__', '__class__', '__dict__', '__name__', 'func_closure',
@@ -456,8 +509,8 @@ to Raul Cota for pointing this out.

boxes. Renamed readIn to readline and readRaw to raw_input.

-
-

0.7.1 (12/12/2001 to 2/21/2002)

+
+

0.7.1 (12/12/2001 to 2/21/2002)

Fixed OnChar() issues effecting European keyboards, as reported by Jean-Michel Fauth.

Fixed introspect.py issue with xmlrpc objects reported by Kevin @@ -483,8 +536,8 @@ to insert from history - Shift+Up and Shift+Down.

Better call tips on objects with __call__ methods.

Improved call tip positioning calculation.

-
-

0.7 (10/15/2001 to 12/11/2001)

+
+

0.7 (10/15/2001 to 12/11/2001)

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.

@@ -507,8 +560,8 @@ package/module name conflicts that kept you from doing __date__ property from all modules.

Fixed bug in introspect.getCallTip(), reported by Kevin Altis.

-
-

0.6.1 (9/19/2001 to 10/12/2001)

+
+

0.6.1 (9/19/2001 to 10/12/2001)

Changed Shell.run() to always position to the end of existing text, as suggested by Raul Cota.

Changed introspect.getAllAttributeNames() to break circular @@ -525,8 +578,8 @@ platform where the font was 2 points larger than what was specified.

ZODB objects that are asleep - in a "ghost" state. Otherwise it returns incomplete info.

-
-

0.6 (8/21/2001 to 9/12/2001)

+
+

0.6 (8/21/2001 to 9/12/2001)

Added PyFilling.py and filling.py.

PyShell.py and PyFilling.py can now be run standalone, as well as PyCrust.py.

@@ -546,8 +599,8 @@ sys.path.insert(0, os.curdir)

Added support for distutils installations.

-
-

0.5.4 (8/17/2001 to 8/20/2001)

+
+

0.5.4 (8/17/2001 to 8/20/2001)

Changed default font size under Linux to:

 'size'   : 12,
@@ -564,15 +617,15 @@ demo.

Split PyCrust.py into PyCrust.py and PyShell.py in anticipation of PyFilling.py.

-
-

0.5.3 (8/16/2001)

+
+

0.5.3 (8/16/2001)

Added patch to PyCrust.py to fix wxPython bug:

 wxID_SELECTALL = NewId() # This *should* be defined by wxPython.
 
-
-

0.5.2 (8/14/2001 to 8/15/2001)

+
+

0.5.2 (8/14/2001 to 8/15/2001)

Shortened module names by dropping "PyCrust" as a prefix.

Changed version to VERSION in version module.

Added Options menu to PyCrust application.

@@ -582,8 +635,8 @@ There just wasn't enough non-gui code to justify the separation. Plus, Shell will be much easier for gui toolkits/designers to deal with now.

-
-

0.5.1 (8/10/2001 to 8/14/2001)

+
+

0.5.1 (8/10/2001 to 8/14/2001)

Added introspect module.

Moved some functionality from PyCrustInterp to introspect.

Changed introspect.getRoot() to no longer remove whitespace from @@ -634,32 +687,32 @@ exclude one or the other or both with:

>>> shell.editor.autoCompleteExcludeDouble = 1
-
-

0.5 (8/8/2001)

+
+

0.5 (8/8/2001)

Mostly just a final version change before creating a release.

-
-

0.4 (8/4/2001 to 8/7/2001)

+
+

0.4 (8/4/2001 to 8/7/2001)

Changed version/revision handling.

Fixed bugs.

-
-

0.3 (8/2/2001 to 8/3/2001)

+
+

0.3 (8/2/2001 to 8/3/2001)

Removed lots of cruft.

Added lots of docstrings.

Imported to CVS repository at SourceForge.

Added call tips.

-
-

0.2 (7/30/2001 to 8/2/2001)

+
+

0.2 (7/30/2001 to 8/2/2001)

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.

-
-

0.1 (7/1/2001 to 7/19/2001)

+
+

0.1 (7/1/2001 to 7/19/2001)

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 @@ -671,8 +724,8 @@ response.

Home key honors the prompt.

Created SourceForge account, but nothing was posted.

-
-

In the beginning, there was pie... (7/1/2001)

+
+

In the beginning, there was pie... (7/1/2001)

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