]> git.saurik.com Git - wxWidgets.git/blame_incremental - wxPython/docs/PyManual.html
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
'[1219035] cleanup: miscellaneous' and minor source cleaning.
[wxWidgets.git] / wxPython / docs / PyManual.html
... / ...
CommitLineData
1<?xml version="1.0" encoding="iso-8859-1" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
6<meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" />
7<title>The Py Manual</title>
8<meta name="author" content="Patrick K. O'Brien" />
9<meta name="organization" content="Orbtech" />
10<meta name="date" content="2004-04-15" />
11<link rel="stylesheet" href="default.css" type="text/css" />
12</head>
13<body>
14<div class="document" id="the-py-manual">
15<h1 class="title">The Py Manual</h1>
16<h2 class="subtitle" id="py-served-fresh-daily">Py - Served Fresh Daily</h2>
17<table class="docinfo" frame="void" rules="none">
18<col class="docinfo-name" />
19<col class="docinfo-content" />
20<tbody valign="top">
21<tr><th class="docinfo-name">Author:</th>
22<td>Patrick K. O'Brien</td></tr>
23<tr><th class="docinfo-name">Contact:</th>
24<td><a class="first last reference" href="mailto:pobrien&#64;orbtech.com">pobrien&#64;orbtech.com</a></td></tr>
25<tr><th class="docinfo-name">Organization:</th>
26<td><a class="first last reference" href="http://www.orbtech.com/">Orbtech</a></td></tr>
27<tr><th class="docinfo-name">Date:</th>
28<td>2004-04-15</td></tr>
29<tr><th class="docinfo-name">Revision:</th>
30<td>1.5</td></tr>
31</tbody>
32</table>
33<div class="contents topic" id="contents">
34<p class="topic-title first"><a name="contents">Contents</a></p>
35<ul class="simple">
36<li><a class="reference" href="#introduction" id="id3" name="id3">Introduction</a></li>
37<li><a class="reference" href="#developer-reference" id="id4" name="id4">Developer Reference</a></li>
38<li><a class="reference" href="#what-is-py" id="id5" name="id5">What is Py?</a></li>
39<li><a class="reference" href="#pycrust-is-dead-long-live-py" id="id6" name="id6">PyCrust is dead! Long live Py!</a></li>
40<li><a class="reference" href="#py-standalone-programs" id="id7" name="id7">Py standalone programs</a></li>
41<li><a class="reference" href="#pyalacarte" id="id8" name="id8">PyAlaCarte</a></li>
42<li><a class="reference" href="#pyalamode" id="id9" name="id9">PyAlaMode</a></li>
43<li><a class="reference" href="#pycrust" id="id10" name="id10">PyCrust</a></li>
44<li><a class="reference" href="#pyfilling" id="id11" name="id11">PyFilling</a></li>
45<li><a class="reference" href="#pyshell" id="id12" name="id12">PyShell</a></li>
46<li><a class="reference" href="#pywrap" id="id13" name="id13">PyWrap</a></li>
47<li><a class="reference" href="#py-modules" id="id14" name="id14">Py modules</a></li>
48<li><a class="reference" href="#projects-using-py" id="id15" name="id15">Projects using Py</a></li>
49<li><a class="reference" href="#history-of-changes" id="id16" name="id16">History of changes</a><ul>
50<li><a class="reference" href="#to-2004" id="id17" name="id17">0.9.4 (1/25/2004 to //2004)</a></li>
51<li><a class="reference" href="#to-1-24-2004" id="id18" name="id18">0.9.3 (9/25/2003 to 1/24/2004)</a></li>
52<li><a class="reference" href="#to-9-25-2003" id="id19" name="id19">0.9.2 (5/3/2003 to 9/25/2003)</a></li>
53<li><a class="reference" href="#to-5-2-2003" id="id20" name="id20">0.9.1 (3/21/2003 to 5/2/2003)</a></li>
54<li><a class="reference" href="#to-3-20-2003" id="id21" name="id21">0.9 (2/27/2003 to 3/20/2003)</a></li>
55<li><a class="reference" href="#to-2-26-2003" id="id22" name="id22">0.8.2 (1/5/2003 to 2/26/2003)</a></li>
56<li><a class="reference" href="#to-12-25-2002" id="id23" name="id23">0.8.1 (12/20/2002 to 12/25/2002)</a></li>
57<li><a class="reference" href="#to-12-16-2002" id="id24" name="id24">0.8 (10/29/2002 to 12/16/2002)</a></li>
58<li><a class="reference" href="#to-8-27-2002" id="id25" name="id25">0.7.2 (2/22/2002 to 8/27/2002)</a></li>
59<li><a class="reference" href="#to-2-21-2002" id="id26" name="id26">0.7.1 (12/12/2001 to 2/21/2002)</a></li>
60<li><a class="reference" href="#to-12-11-2001" id="id27" name="id27">0.7 (10/15/2001 to 12/11/2001)</a></li>
61<li><a class="reference" href="#to-10-12-2001" id="id28" name="id28">0.6.1 (9/19/2001 to 10/12/2001)</a></li>
62<li><a class="reference" href="#to-9-12-2001" id="id29" name="id29">0.6 (8/21/2001 to 9/12/2001)</a></li>
63<li><a class="reference" href="#to-8-20-2001" id="id30" name="id30">0.5.4 (8/17/2001 to 8/20/2001)</a></li>
64<li><a class="reference" href="#id1" id="id31" name="id31">0.5.3 (8/16/2001)</a></li>
65<li><a class="reference" href="#to-8-15-2001" id="id32" name="id32">0.5.2 (8/14/2001 to 8/15/2001)</a></li>
66<li><a class="reference" href="#to-8-14-2001" id="id33" name="id33">0.5.1 (8/10/2001 to 8/14/2001)</a></li>
67<li><a class="reference" href="#id2" id="id34" name="id34">0.5 (8/8/2001)</a></li>
68<li><a class="reference" href="#to-8-7-2001" id="id35" name="id35">0.4 (8/4/2001 to 8/7/2001)</a></li>
69<li><a class="reference" href="#to-8-3-2001" id="id36" name="id36">0.3 (8/2/2001 to 8/3/2001)</a></li>
70<li><a class="reference" href="#to-8-2-2001" id="id37" name="id37">0.2 (7/30/2001 to 8/2/2001)</a></li>
71<li><a class="reference" href="#to-7-19-2001" id="id38" name="id38">0.1 (7/1/2001 to 7/19/2001)</a></li>
72<li><a class="reference" href="#in-the-beginning-there-was-pie-7-1-2001" id="id39" name="id39">In the beginning, there was pie... (7/1/2001)</a></li>
73</ul>
74</li>
75</ul>
76</div>
77<div class="section" id="introduction">
78<h1><a class="toc-backref" href="#id3" name="introduction">Introduction</a></h1>
79<p>This document will show you how to use the Py programs and the Py
80library of Python source code modules. Py is the new name for the
81project that began as PyCrust. Py is officially part of <a class="reference" href="http://www.wxpython.org/">wxPython</a>,
82and includes PyCrust, so PyCrust is no longer distributed separately.</p>
83</div>
84<div class="section" id="developer-reference">
85<h1><a class="toc-backref" href="#id4" name="developer-reference">Developer Reference</a></h1>
86<p>Source code documentation for developers is available at:</p>
87<p><a class="reference" href="http://www.orbtech.com/www/wx/epydoc/public/wx.py-module.html">http://www.orbtech.com/www/wx/epydoc/public/wx.py-module.html</a></p>
88</div>
89<div class="section" id="what-is-py">
90<h1><a class="toc-backref" href="#id5" name="what-is-py">What is Py?</a></h1>
91<p>Besides being <a class="reference" href="http://www.wikipedia.org/wiki/Pie">a delicious dessert</a>, Py is the name for a collection
92of whimsically-named Python programs and modules that began as the
93PyCrust project. So Py is really several things: a set of standalone
94programs, including the original PyCrust program, a library of Python
95source code modules that can be used in your own programs, and as many
96examples of bad &quot;pie&quot; puns as I can come up with. (If you're going to
97do something, you might as well do it all the way, right?) Py uses
98Python and wxPython, so it works equally well on Windows, Linux and
99Mac OS X.</p>
100</div>
101<div class="section" id="pycrust-is-dead-long-live-py">
102<h1><a class="toc-backref" href="#id6" name="pycrust-is-dead-long-live-py">PyCrust is dead! Long live Py!</a></h1>
103<p>This project began with a program I created called PyCrust - an
104interactive, graphical Python shell, developed using the wxPython GUI
105toolkit. For about two years, PyCrust was hosted on <a class="reference" href="http://www.sf.net/projects/pycrust/">SourceForge</a>.
106Shortly after I created PyCrust, the wxPython folks started including
107it in their distribution. As the PyCrust project grew, it reached a
108point where I thought the original PyCrust name was too confining. I
109was using the PyCrust code base to develop programs that weren't just
110Python shells any more.</p>
111<p>Around that same time, the wxPython folks asked me if I'd be willing
112to move all my wxPython-related projects into the <a class="reference" href="http://cvs.wxWidgets.org">wxPython CVS
113repository</a>, and become part of the <a class="reference" href="http://www.wxpython.org/">wxPython</a>/<a class="reference" href="http://www.wxWidgets.org/">wxWidgets</a> developer team.
114I decided the time was right to restructure the PyCrust project.
115During the move, the PyCrust package was renamed to &quot;py&quot; (lowercase
116&quot;p&quot;) and the collection of programs and modules as a whole became
117known as &quot;Py&quot; (with a capital &quot;P&quot;).</p>
118<p>The original goal of PyCrust was to be the best interactive, graphical
119Python shell (of course, I claimed it was the &quot;flakiest&quot; Python
120shell). And that was all I wanted it to be. But little by little I
121found myself developing a wider variety of tools for wxPython
122applications. Eventually I'll create a debugger (PySlice, perhaps)
123and whatever else is needed to one day become a complete wxPython
124application development environment (PyFactory?). In the mean time,
125PyCrust is still the flakiest Python shell, and the other Py programs
126are equally tasty.</p>
127<p>At this point, Py has standalone programs that include Python code
128editors (PyAlaCarte and PyAlaMode), interactive Python shells (PyCrust
129and PyShell), and a runtime wrapper (PyWrap). The runtime wrapper
130utility provides you with runtime introspection capabilities for your
131wxPython programs without having to include PyCrust or PyShell in your
132program, and without having to alter one line of your source code.</p>
133<p>Py also contains a collection of modules that you can use in your own
134wxPython applications to provide similar services, either for your own
135use during development, or as an interface for users of your programs.
136These modules are the same ones used by all the Py programs.</p>
137</div>
138<div class="section" id="py-standalone-programs">
139<h1><a class="toc-backref" href="#id7" name="py-standalone-programs">Py standalone programs</a></h1>
140<p>These are the standalone applications in the Py collection:</p>
141<ul class="simple">
142<li>PyAlaCarte</li>
143<li>PyAlaMode</li>
144<li>PyCrust</li>
145<li>PyFilling</li>
146<li>PyShell</li>
147<li>PyWrap</li>
148</ul>
149</div>
150<div class="section" id="pyalacarte">
151<h1><a class="toc-backref" href="#id8" name="pyalacarte">PyAlaCarte</a></h1>
152<p>PyAlaCarte is a Python source code editor. It is designed to have a
153simple, single-file interface. As a standalone application, it is
154good for simple, short editing tasks. But it is really meant to be
155more of an example of how to embed the Py editor into a wxPython
156application.</p>
157</div>
158<div class="section" id="pyalamode">
159<h1><a class="toc-backref" href="#id9" name="pyalamode">PyAlaMode</a></h1>
160<p>PyAlaMode is a Python source code editor.</p>
161</div>
162<div class="section" id="pycrust">
163<h1><a class="toc-backref" href="#id10" name="pycrust">PyCrust</a></h1>
164<p>PyCrust is an interactive, Python shell. But it's more than just a
165shell. It includes a tabbed notebook containing a namespace tree
166(PyFilling), and several other things.</p>
167</div>
168<div class="section" id="pyfilling">
169<h1><a class="toc-backref" href="#id11" name="pyfilling">PyFilling</a></h1>
170<p>PyFilling is a namespace viewer. It isn't really useful as a
171standalone program, but it does illustrate how to make use of the
172underlying <tt class="docutils literal"><span class="pre">filling</span></tt> module.</p>
173</div>
174<div class="section" id="pyshell">
175<h1><a class="toc-backref" href="#id12" name="pyshell">PyShell</a></h1>
176<p>PyShell is an interactive, Python shell. It shares the same base code
177as PyCrust, but doesn't have any of the extra features that appear in
178the PyCrust notebook interface.</p>
179<div class="figure">
180<div class="image"><img alt="screenshots/PyShell.png" src="screenshots/PyShell.png" /></div>
181<p class="caption">PyShell running on Mandrake Linux.</p>
182</div>
183</div>
184<div class="section" id="pywrap">
185<h1><a class="toc-backref" href="#id13" name="pywrap">PyWrap</a></h1>
186<p>PyWrap is a runtime utility that lets you run an existing wxPython
187program with a PyCrust frame at the same time. Inside the PyCrust
188shell namespace, the local variable <tt class="docutils literal"><span class="pre">app</span></tt> is assigned to your
189application instance. In this way you can introspect your entire
190application within the PyCrust shell, as well as the PyFilling
191namespace viewer.</p>
192</div>
193<div class="section" id="py-modules">
194<h1><a class="toc-backref" href="#id14" name="py-modules">Py modules</a></h1>
195<p>Py was designed to be modular. That means graphical code is kept
196separate from non-graphical code, and many of the Py modules can be
197used by other programs. Likewise, other programs can supply some of
198the modules needed by Py. For example, you could supply a customized
199interpreter module and plug it in to the PyCrust standalone
200application. As long as it supports the minimum functionality
201required, PyCrust will work just as well with your interpreter as with
202its default interpreter.</p>
203</div>
204<div class="section" id="projects-using-py">
205<h1><a class="toc-backref" href="#id15" name="projects-using-py">Projects using Py</a></h1>
206<ul class="simple">
207<li><a class="reference" href="http://conflictsolver.sourceforge.net/">Conflict Solver</a></li>
208<li><a class="reference" href="http://www.gnumed.org/">Gnumed</a></li>
209<li>PyGist</li>
210<li><a class="reference" href="http://www.pythoncard.org/">PythonCard</a></li>
211<li><a class="reference" href="http://rpy.sourceforge.net/">RPy</a></li>
212<li><a class="reference" href="http://www.scipy.org/">SciPy</a></li>
213<li><a class="reference" href="http://www.sim42.org/">Sim42</a></li>
214<li><a class="reference" href="http://linus.yorktown.arlington.k12.va.us/CS/APCSC/student_sites/David_Mayo/wxGasp">wxGasp</a></li>
215</ul>
216</div>
217<div class="section" id="history-of-changes">
218<h1><a class="toc-backref" href="#id16" name="history-of-changes">History of changes</a></h1>
219<p>This section lists all the changes that have been made to the Py
220programs and modules, since the beginning.</p>
221<div class="section" id="to-2004">
222<h2><a class="toc-backref" href="#id17" name="to-2004">0.9.4 (1/25/2004 to //2004)</a></h2>
223<p>Removed wxd decorators in favor of new SWIG-generated docstrings.</p>
224<p>Removed docs tabs from crust interface:
225* wxPython Docs
226* wxSTC Docs</p>
227<p>Fixed Calltip tab refresh problem on Windows.</p>
228<p>shell.autoCompleteAutoHide added with default of False.</p>
229<p>Changed default namespace of Shell to __main__.__dict__, instead of an
230empty dictionary.</p>
231</div>
232<div class="section" id="to-1-24-2004">
233<h2><a class="toc-backref" href="#id18" name="to-1-24-2004">0.9.3 (9/25/2003 to 1/24/2004)</a></h2>
234<p>Fun and games with dynamic renaming. Details of any other changes
235were lost in the confusion. I'll try to do better in the future.</p>
236</div>
237<div class="section" id="to-9-25-2003">
238<h2><a class="toc-backref" href="#id19" name="to-9-25-2003">0.9.2 (5/3/2003 to 9/25/2003)</a></h2>
239<p>Changed to the new prefix-less &quot;wx&quot; package:</p>
240<pre class="literal-block">
241import wx
242</pre>
243<p>instead of:</p>
244<pre class="literal-block">
245from wxPython import wx
246</pre>
247<p>Fixed typo in <tt class="docutils literal"><span class="pre">PyWrap.py</span></tt>:</p>
248<pre class="literal-block">
249if __name__ == '__main__':
250 main(sys.argv)
251</pre>
252<p>should have been:</p>
253<pre class="literal-block">
254if __name__ == '__main__':
255 main()
256</pre>
257<p>Added pretty-print Display tab to Crust, based on suggestion from
258Jason Whitlark.</p>
259<p>Improved <tt class="docutils literal"><span class="pre">Can*</span></tt> checks in <tt class="docutils literal"><span class="pre">EditWindow</span></tt>, since STC is too lenient,
260particularly when it is set to read-only but returns True for
261CanPaste() (seems like an STC bug to me):</p>
262<pre class="literal-block">
263def CanCopy(self):
264 &quot;&quot;&quot;Return True if text is selected and can be copied.&quot;&quot;&quot;
265 return self.GetSelectionStart() != self.GetSelectionEnd()
266
267def CanCut(self):
268 &quot;&quot;&quot;Return True if text is selected and can be cut.&quot;&quot;&quot;
269 return self.CanCopy() and self.CanEdit()
270
271def CanEdit(self):
272 &quot;&quot;&quot;Return True if editing should succeed.&quot;&quot;&quot;
273 return not self.GetReadOnly()
274
275def CanPaste(self):
276 &quot;&quot;&quot;Return True if pasting should succeed.&quot;&quot;&quot;
277 return stc.StyledTextCtrl.CanPaste(self) and self.CanEdit()
278</pre>
279</div>
280<div class="section" id="to-5-2-2003">
281<h2><a class="toc-backref" href="#id20" name="to-5-2-2003">0.9.1 (3/21/2003 to 5/2/2003)</a></h2>
282<p>PyCrust is dead! Long live Py!</p>
283<ul class="simple">
284<li>Renamed <tt class="docutils literal"><span class="pre">PyCrust</span></tt> package to <tt class="docutils literal"><span class="pre">py</span></tt>.</li>
285<li>Moved code to wxPython's CVS repository.</li>
286</ul>
287<p>Fixed bug in <tt class="docutils literal"><span class="pre">introspect.py</span></tt> on introspecting objects occurring
288immediately after a secondary prompt, like this:</p>
289<pre class="literal-block">
290&gt;&gt;&gt; l = [1, 2, 3]
291&gt;&gt;&gt; for n in range(3):
292... l. &lt;-- failed to popup autocomplete list
293</pre>
294<p>Added documentation files:</p>
295<ul class="simple">
296<li>PyManual.txt</li>
297<li>wxPythonManual.txt</li>
298<li>wxPythonPackage.txt</li>
299<li>wxPythonExamples.txt</li>
300</ul>
301<p>Added PyAlaMode and PyAlaCarte code editors.</p>
302<p>Major refactoring to support <tt class="docutils literal"><span class="pre">editor</span></tt> and <tt class="docutils literal"><span class="pre">shell</span></tt> from the same
303base.</p>
304<p>Renamed program files:</p>
305<ul class="simple">
306<li><tt class="docutils literal"><span class="pre">PyCrustApp.py</span></tt> to <tt class="docutils literal"><span class="pre">PyCrust.py</span></tt></li>
307<li><tt class="docutils literal"><span class="pre">PyFillingApp.py</span></tt> to <tt class="docutils literal"><span class="pre">PyFilling.py</span></tt></li>
308<li><tt class="docutils literal"><span class="pre">PyShellApp.py</span></tt> to <tt class="docutils literal"><span class="pre">PyShell.py</span></tt></li>
309<li><tt class="docutils literal"><span class="pre">wrap.py</span></tt> to <tt class="docutils literal"><span class="pre">PyWrap.py</span></tt></li>
310</ul>
311<p>Removed disabling of autocomplete for lists of 2000 items or more.
312The current implementation of wxSTC can now handle lists this big.</p>
313<p>Improved handling of <tt class="docutils literal"><span class="pre">sys.path</span></tt> to mimic the standard Python shell.</p>
314</div>
315<div class="section" id="to-3-20-2003">
316<h2><a class="toc-backref" href="#id21" name="to-3-20-2003">0.9 (2/27/2003 to 3/20/2003)</a></h2>
317<p>Added fontIncrease, fontDecrease, fontDefault signals, receivers and
318keybindings:</p>
319<pre class="literal-block">
320Ctrl+] Increase font size.
321Ctrl+[ Decrease font size.
322Ctrl+= Default font size.
323</pre>
324<p>Continued enhancement of the decorator capability to provide better
325documentation and docstrings for wxPython classes and functions.</p>
326<p>Introduced new tabbed interface:</p>
327<ul class="simple">
328<li>Namespace</li>
329<li>Calltip</li>
330<li>Session</li>
331<li>Dispatcher</li>
332<li>wxPython Docs</li>
333<li>wxSTC Docs</li>
334</ul>
335<p><tt class="docutils literal"><span class="pre">Filling.tree</span></tt> now expands tuples as well as lists. (It should have
336done this all along, I just never noticed this omission before.)</p>
337<p>Added this True/False test to all modules:</p>
338<pre class="literal-block">
339try:
340 True
341except NameError:
342 True = 1==1
343 False = 1==0
344</pre>
345<p>Added <tt class="docutils literal"><span class="pre">wxd</span></tt> directory with decoration classes.</p>
346</div>
347<div class="section" id="to-2-26-2003">
348<h2><a class="toc-backref" href="#id22" name="to-2-26-2003">0.8.2 (1/5/2003 to 2/26/2003)</a></h2>
349<p>Wrapped <tt class="docutils literal"><span class="pre">sys.ps1</span></tt>, <tt class="docutils literal"><span class="pre">sys.ps2</span></tt>, and <tt class="docutils literal"><span class="pre">sys.ps3</span></tt> in <tt class="docutils literal"><span class="pre">str()</span></tt>.
350(Thanks, Kieran Holland.)</p>
351<p>Fixed minor things found by PyChecker.</p>
352<p>Changed locals to use <tt class="docutils literal"><span class="pre">__main__.__dict__</span></tt> and added code to clean up
353the namespace, making it as close to the regular Python environment as
354possible. This solves the problem of pickling and unpickling
355instances of classes defined in the shell.</p>
356<p>Made <tt class="docutils literal"><span class="pre">shell.PasteAndRun()</span></tt> a little more forgiving when it finds a
357ps2 prompt line with no trailing space, such when you copy code from a
358web page.</p>
359<p>Improved autocomplete behavior by adding these to shell:</p>
360<pre class="literal-block">
361self.AutoCompSetAutoHide(False)
362self.AutoCompStops(' .,;:([)]}\'&quot;\\&lt;&gt;%^&amp;+-=*/|`')
363</pre>
364<p>Added <tt class="docutils literal"><span class="pre">decor</span></tt> directory, <tt class="docutils literal"><span class="pre">decorator.py</span></tt>, <tt class="docutils literal"><span class="pre">stcDecor.py</span></tt>, and
365<tt class="docutils literal"><span class="pre">stcConstants.py</span></tt>. These all serve the purpose of adding docstrings
366to existing wxPython classes, in particular the <tt class="docutils literal"><span class="pre">wxStyledTextCtrl</span></tt>.</p>
367<p>Added <tt class="docutils literal"><span class="pre">wrap.py</span></tt>, a command line utility for running a wxPython app
368with additional runtime-tools loaded, such as PyCrust (the only tool
369at this point).</p>
370<p>Flushed the clipboard Cut/Copy operations so that selections will
371exist in the clipboard even after PyCrust has been closed.</p>
372<p>Improved the suppression of docstrings for simple data types appearing
373in the namespace viewer.</p>
374<p>Better handling of autocompletion with numeric types; no
375autocompletion when typing a dot after an integer. If the
376autocompletion is desired, type a space before the dot:</p>
377<pre class="literal-block">
378func = 3 .
379</pre>
380<p>More Filling!!! The namespace tree is now dynamically updated.</p>
381</div>
382<div class="section" id="to-12-25-2002">
383<h2><a class="toc-backref" href="#id23" name="to-12-25-2002">0.8.1 (12/20/2002 to 12/25/2002)</a></h2>
384<p>Improved keyboard handling with Autocomplete active. You can now use
385Enter as well as Tab to select an item from the list.</p>
386<p>Disabled autocomplete for lists of 2000 items or more. The current
387implementation of wxSTC can't handle lists this big.</p>
388<p>Changed <tt class="docutils literal"><span class="pre">filling</span></tt> to always display docstrings for objects. This is
389useful for objects whose docstrings have been decorated, rather than
390coming directly from the source code. (Hmmm. Sounds like someone is
391doing some decorating. I wonder where that would be helpful? &lt;wink&gt;)</p>
392<p>Fixed handling of icon. Added <tt class="docutils literal"><span class="pre">images.py</span></tt> file.</p>
393</div>
394<div class="section" id="to-12-16-2002">
395<h2><a class="toc-backref" href="#id24" name="to-12-16-2002">0.8 (10/29/2002 to 12/16/2002)</a></h2>
396<p>Added &quot;help&quot; to startup banner info.</p>
397<p>Made all <tt class="docutils literal"><span class="pre">wx</span></tt> and <tt class="docutils literal"><span class="pre">stc</span></tt> imports explicit. No more <tt class="docutils literal"><span class="pre">import</span> <span class="pre">*</span></tt>.</p>
398<p>Replaced use of the <tt class="docutils literal"><span class="pre">wx</span></tt> module's <tt class="docutils literal"><span class="pre">true</span></tt> and <tt class="docutils literal"><span class="pre">false</span></tt> with
399Python's <tt class="docutils literal"><span class="pre">True</span></tt> and <tt class="docutils literal"><span class="pre">False</span></tt>.</p>
400<p>Changed <tt class="docutils literal"><span class="pre">introspect.getRoot()</span></tt> to use <tt class="docutils literal"><span class="pre">tokenize</span></tt> module. This
401does a slightly better job than the previous parsing routine and the
402code is clearer.</p>
403<p>Improved handling of whitespace and empty types during introspection.</p>
404<p>Fixed cut/copy clipboard problem under Linux. (Robin Dunn rocks!!!)</p>
405<p>Added shell.about() which works like this:</p>
406<pre class="literal-block">
407&gt;&gt;&gt; shell.about()
408PyCrust Version: 0.8
409Shell Revision: 1.80
410Interpreter Revision: 1.15
411Python Version: 2.2.2
412wxPython Version: 2.3.3.1
413Platform: linux2
414</pre>
415<p>Added copy plus and paste plus to shell menu.</p>
416<p>Moved shell menu from <tt class="docutils literal"><span class="pre">shell.py</span></tt> to <tt class="docutils literal"><span class="pre">shellmenu.py</span></tt>.</p>
417<p>Added <tt class="docutils literal"><span class="pre">sys.stdin.readlines()</span></tt> support.</p>
418<p>Added <tt class="docutils literal"><span class="pre">time.sleep()</span></tt> in <tt class="docutils literal"><span class="pre">readline()</span></tt> and <tt class="docutils literal"><span class="pre">OnIdle()</span></tt> event
419handler to free up the CPU.</p>
420</div>
421<div class="section" id="to-8-27-2002">
422<h2><a class="toc-backref" href="#id25" name="to-8-27-2002">0.7.2 (2/22/2002 to 8/27/2002)</a></h2>
423<p>Tweaked <tt class="docutils literal"><span class="pre">getAttributeNames()</span></tt> to pick up a few more attributes:</p>
424<pre class="literal-block">
425'__bases__', '__class__', '__dict__', '__name__', 'func_closure',
426'func_code', 'func_defaults', 'func_dict', 'func_doc',
427'func_globals', 'func_name'
428</pre>
429<p>Added a tests directory and unit tests.</p>
430<p>Improved support for empty types in the shell: <tt class="docutils literal"><span class="pre">[]</span></tt>, <tt class="docutils literal"><span class="pre">()</span></tt> and
431<tt class="docutils literal"><span class="pre">{}</span></tt> as far as when call tips and autocompletion are available.</p>
432<p>Added support for the other triple string - <tt class="docutils literal"><span class="pre">''''''</span></tt>.</p>
433<p>Refactored <tt class="docutils literal"><span class="pre">introspect.py</span></tt> to improve testability.</p>
434<p>Improved call tips for unbound methods by leaving the &quot;self&quot;
435parameter, since unbound methods require an instance be passed.</p>
436<p>Fixed call tip bug where a tip was displayed when a &quot;(&quot; was typed
437after an object that wasn't callable.</p>
438<p>Fixed <tt class="docutils literal"><span class="pre">getAllAttributeNames</span></tt> when <tt class="docutils literal"><span class="pre">str(object)</span></tt> fails.</p>
439<p>Added brace highlighting. (Thank you, Kevin Altis.)</p>
440<p>Fixed problem displaying unicode objects in <tt class="docutils literal"><span class="pre">PyFilling</span></tt>.</p>
441<p>Changed how <tt class="docutils literal"><span class="pre">filling.py</span></tt> checks for expandable objects. Lists are
442now expandable objects.</p>
443<p>Made the key handling more robust when there is an active text
444selection that includes text prior to the last primary prompt. Thanks
445to Raul Cota for pointing this out.</p>
446<p>Fixed wxSTC problem with brace highlighting and non-us keyboards.
447(Thank you for the patch, Jean-Michel Fauth.)</p>
448<p>Added <tt class="docutils literal"><span class="pre">busy</span> <span class="pre">=</span> <span class="pre">wxBusyCursor()</span></tt> to key points in <tt class="docutils literal"><span class="pre">shell</span></tt> and
449<tt class="docutils literal"><span class="pre">filling</span></tt>.</p>
450<p>Added <tt class="docutils literal"><span class="pre">OnCloseWindow</span></tt> handler to <tt class="docutils literal"><span class="pre">ShellFrame</span></tt> and <tt class="docutils literal"><span class="pre">CrustFrame</span></tt>.</p>
451<p>Default to <tt class="docutils literal"><span class="pre">SetWrapMode(1)</span></tt> for shell and namespace viewer.</p>
452<p>Added <tt class="docutils literal"><span class="pre">shell.wrap()</span></tt> and <tt class="docutils literal"><span class="pre">shell.zoom()</span></tt>.</p>
453<p>Added autoCompleteKeys hooks for Raul Cota.</p>
454<p>Cleaned up various little key handling bugs.</p>
455<p>Changed input methods to get values from shell, rather than dialog
456boxes. Renamed <tt class="docutils literal"><span class="pre">readIn</span></tt> to <tt class="docutils literal"><span class="pre">readline</span></tt> and <tt class="docutils literal"><span class="pre">readRaw</span></tt> to
457<tt class="docutils literal"><span class="pre">raw_input</span></tt>.</p>
458</div>
459<div class="section" id="to-2-21-2002">
460<h2><a class="toc-backref" href="#id26" name="to-2-21-2002">0.7.1 (12/12/2001 to 2/21/2002)</a></h2>
461<p>Fixed <tt class="docutils literal"><span class="pre">OnChar()</span></tt> issues effecting European keyboards, as reported by
462Jean-Michel Fauth.</p>
463<p>Fixed <tt class="docutils literal"><span class="pre">introspect.py</span></tt> issue with xmlrpc objects reported by Kevin
464Altis.</p>
465<p>Fixed some introspect/PyFilling issues with regard to Python 2.2.</p>
466<p>Fixed font background color as reported by Keith J. Farmer. (Thanks)</p>
467<p>Fixed problem with call tips and autocompletion inside multiline
468commands as report by Kevin Altis.</p>
469<p>Improved <tt class="docutils literal"><span class="pre">OnKeyDown</span></tt> handling of cut/copy/paste operations based on
470feedback from Syver Enstad. (Thanks)</p>
471<p>Added a <tt class="docutils literal"><span class="pre">shell.help()</span></tt> method to display some help info.</p>
472<p>Changed sort of items in the namespace viewer to case insensitive.</p>
473<p>Changed <tt class="docutils literal"><span class="pre">attributes.sort(lambda</span> <span class="pre">x,</span> <span class="pre">y:</span> <span class="pre">cmp(x.upper(),</span> <span class="pre">y.upper()))</span></tt> in
474advance of an upcoming fix to an autocompletion matching bug in wxSTC.</p>
475<p>Improved support for ZODB by allowing namespace drilldown into BTrees.</p>
476<p>Added <tt class="docutils literal"><span class="pre">shell.PasteAndRun()</span></tt> to support pasting multiple commands into
477the shell from the clipboard. Ctrl+Shift+V or v.</p>
478<p>Enter now always processes a command (or copies down a previous one.)
479To insert a line break, press Ctrl+Enter.</p>
480<p>Escape key clears the current, unexecuted command.</p>
481<p>History retrieval changed to replace current command. Added new keys
482to insert from history - Shift+Up and Shift+Down.</p>
483<p>Better call tips on objects with <tt class="docutils literal"><span class="pre">__call__</span></tt> methods.</p>
484<p>Improved call tip positioning calculation.</p>
485</div>
486<div class="section" id="to-12-11-2001">
487<h2><a class="toc-backref" href="#id27" name="to-12-11-2001">0.7 (10/15/2001 to 12/11/2001)</a></h2>
488<p>Changed how command history retrieval functions work. Added Alt-P,
489Alt-N as keybindings for Retrieve-Previous, Retrieve-Next.</p>
490<p>Added full support for multi-line commands, similar to IDLE.</p>
491<p>Changed <tt class="docutils literal"><span class="pre">introspect.getAttributeNames()</span></tt> to do a case insensitive
492sort.</p>
493<p>Changed Cut/Copy/Paste to deal with prompts intelligently. Cut and
494Copy remove all prompts. Paste can handle prompted or not-prompted
495text.</p>
496<p>Added <tt class="docutils literal"><span class="pre">CopyWithPrompts()</span></tt> method attached to Ctrl-Shift-C for those
497times when you really do want all the prompts left intact.</p>
498<p>Improved handling of the shell's read-only zone.</p>
499<p>Changed <tt class="docutils literal"><span class="pre">CrustFrame.__init__</span></tt> parameter spec to include all
500parameters allowed by a <tt class="docutils literal"><span class="pre">wxFrame</span></tt>.</p>
501<p>Changed <tt class="docutils literal"><span class="pre">FillingText</span></tt> to be read-only.</p>
502<p>Renamed <tt class="docutils literal"><span class="pre">PyCrust.py</span></tt> to <tt class="docutils literal"><span class="pre">PyCrustApp.py</span></tt> to eliminate
503package/module name conflicts that kept you from doing <tt class="docutils literal"><span class="pre">from</span> <span class="pre">PyCrust</span>
504<span class="pre">import</span> <span class="pre">shell</span></tt> inside files located in the <tt class="docutils literal"><span class="pre">PyCrust</span></tt> directory.</p>
505<p>Renamed <tt class="docutils literal"><span class="pre">PyFilling.py</span></tt> to <tt class="docutils literal"><span class="pre">PyFillingApp.py</span></tt> and <tt class="docutils literal"><span class="pre">PyShell.py</span></tt> to
506<tt class="docutils literal"><span class="pre">PyShellApp.py</span></tt> to maintain consistency.</p>
507<p>Removed the <tt class="docutils literal"><span class="pre">__date__</span></tt> property from all modules.</p>
508<p>Fixed bug in <tt class="docutils literal"><span class="pre">introspect.getCallTip()</span></tt>, reported by Kevin Altis.</p>
509</div>
510<div class="section" id="to-10-12-2001">
511<h2><a class="toc-backref" href="#id28" name="to-10-12-2001">0.6.1 (9/19/2001 to 10/12/2001)</a></h2>
512<p>Changed <tt class="docutils literal"><span class="pre">Shell.run()</span></tt> to always position to the end of existing
513text, as suggested by Raul Cota.</p>
514<p>Changed <tt class="docutils literal"><span class="pre">introspect.getAllAttributeNames()</span></tt> to break circular
515references in <tt class="docutils literal"><span class="pre">object.__class__</span></tt>, which occurs in Zope/ZODB
516extension classes.</p>
517<p>Changed <tt class="docutils literal"><span class="pre">filling.FillingTree.getChildren()</span></tt> to introspect extension
518classes.</p>
519<p>Fixed minor bugs in <tt class="docutils literal"><span class="pre">introspect.getCallTip()</span></tt> that were interfering
520with call tips for Zope/ZODB extension class methods.</p>
521<p>In preparation for wxPython 2.3.2, added code to fix a font sizing
522problem. Versions of wxPython prior to 2.3.2 had a sizing bug on Win
523platform where the font was 2 points larger than what was specified.</p>
524<p>Added a hack to <tt class="docutils literal"><span class="pre">introspect.getAllAttributeNames()</span></tt> to &quot;wake up&quot;
525ZODB objects that are asleep - in a &quot;ghost&quot; state. Otherwise it
526returns incomplete info.</p>
527</div>
528<div class="section" id="to-9-12-2001">
529<h2><a class="toc-backref" href="#id29" name="to-9-12-2001">0.6 (8/21/2001 to 9/12/2001)</a></h2>
530<p>Added <tt class="docutils literal"><span class="pre">PyFilling.py</span></tt> and <tt class="docutils literal"><span class="pre">filling.py</span></tt>.</p>
531<p><tt class="docutils literal"><span class="pre">PyShell.py</span></tt> and <tt class="docutils literal"><span class="pre">PyFilling.py</span></tt> can now be run standalone, as well
532as <tt class="docutils literal"><span class="pre">PyCrust.py</span></tt>.</p>
533<p>Added <tt class="docutils literal"><span class="pre">crust.py</span></tt> and moved some code from <tt class="docutils literal"><span class="pre">PyCrust.py</span></tt> to it.</p>
534<p>Added command history retrieval features submitted by Richie Hindle.</p>
535<p>Changed <tt class="docutils literal"><span class="pre">shell.write()</span></tt> to replace line endings with OS-specific
536endings. Changed <tt class="docutils literal"><span class="pre">shell.py</span></tt> and <tt class="docutils literal"><span class="pre">interpreter.py</span></tt> to use
537<tt class="docutils literal"><span class="pre">os.linesep</span></tt> in strings having hardcoded line endings.</p>
538<p>Added <tt class="docutils literal"><span class="pre">shell.redirectStdin()</span></tt>, <tt class="docutils literal"><span class="pre">shell.redirectStdout()</span></tt> and
539<tt class="docutils literal"><span class="pre">shell.redirectStderr()</span></tt> to allow the surrounding app to toggle
540requests that the specified <tt class="docutils literal"><span class="pre">sys.std*</span></tt> be redirected to the shell.
541These can also be run from within the shell itself, of course.</p>
542<p>The shell now adds the current working directory &quot;.&quot; to the search
543path:</p>
544<pre class="literal-block">
545sys.path.insert(0, os.curdir)
546</pre>
547<p>Added support for distutils installations.</p>
548</div>
549<div class="section" id="to-8-20-2001">
550<h2><a class="toc-backref" href="#id30" name="to-8-20-2001">0.5.4 (8/17/2001 to 8/20/2001)</a></h2>
551<p>Changed default font size under Linux to:</p>
552<pre class="literal-block">
553'size' : 12,
554'lnsize' : 10,
555</pre>
556<p>Changed <tt class="docutils literal"><span class="pre">Shell</span></tt> to expect a parameter referencing an Interpreter
557class, rather than an intepreter instance, to facilitate subclassing
558of Interpreter, which effectively broke when the Editor class was
559eliminated.</p>
560<p>Fixed <tt class="docutils literal"><span class="pre">PyCrustAlaCarte.py</span></tt>, which had been broken by previous
561changes.</p>
562<p>Created <tt class="docutils literal"><span class="pre">InterpreterAlaCarte</span></tt> class as an example for use in the
563demo.</p>
564<p>Split <tt class="docutils literal"><span class="pre">PyCrust.py</span></tt> into <tt class="docutils literal"><span class="pre">PyCrust.py</span></tt> and <tt class="docutils literal"><span class="pre">PyShell.py</span></tt> in
565anticipation of <tt class="docutils literal"><span class="pre">PyFilling.py</span></tt>.</p>
566</div>
567<div class="section" id="id1">
568<h2><a class="toc-backref" href="#id31" name="id1">0.5.3 (8/16/2001)</a></h2>
569<p>Added patch to <tt class="docutils literal"><span class="pre">PyCrust.py</span></tt> to fix wxPython bug:</p>
570<pre class="literal-block">
571wxID_SELECTALL = NewId() # This *should* be defined by wxPython.
572</pre>
573</div>
574<div class="section" id="to-8-15-2001">
575<h2><a class="toc-backref" href="#id32" name="to-8-15-2001">0.5.2 (8/14/2001 to 8/15/2001)</a></h2>
576<p>Shortened module names by dropping &quot;PyCrust&quot; as a prefix.</p>
577<p>Changed <tt class="docutils literal"><span class="pre">version</span></tt> to <tt class="docutils literal"><span class="pre">VERSION</span></tt> in <tt class="docutils literal"><span class="pre">version</span></tt> module.</p>
578<p>Added Options menu to PyCrust application.</p>
579<p>Eliminated the Editor class (and editor module) by merging with Shell.
580This means that Shell &quot;is a&quot; wxStyledTextCtrl rather than &quot;has a&quot;.
581There just wasn't enough non-gui code to justify the separation.
582Plus, Shell will be much easier for gui toolkits/designers to deal
583with now.</p>
584</div>
585<div class="section" id="to-8-14-2001">
586<h2><a class="toc-backref" href="#id33" name="to-8-14-2001">0.5.1 (8/10/2001 to 8/14/2001)</a></h2>
587<p>Added <tt class="docutils literal"><span class="pre">introspect</span></tt> module.</p>
588<p>Moved some functionality from <tt class="docutils literal"><span class="pre">PyCrustInterp</span></tt> to <tt class="docutils literal"><span class="pre">introspect</span></tt>.</p>
589<p>Changed <tt class="docutils literal"><span class="pre">introspect.getRoot()</span></tt> to no longer remove whitespace from
590the command. This was a remnant of a previous approach that, when
591left as part of the current approach, turned out to be a really bad
592thing.</p>
593<p>Changed <tt class="docutils literal"><span class="pre">introspect.getRoot()</span></tt> to allow commands of <tt class="docutils literal"><span class="pre">''</span></tt>, <tt class="docutils literal"><span class="pre">&quot;&quot;</span></tt>,
594<tt class="docutils literal"><span class="pre">&quot;&quot;&quot;&quot;&quot;&quot;</span></tt>, <tt class="docutils literal"><span class="pre">[]</span></tt>, <tt class="docutils literal"><span class="pre">()</span></tt>, and <tt class="docutils literal"><span class="pre">{}</span></tt> to pass through. This allows
595you to type them, followed by a dot, and get autocomplete options on
596them.</p>
597<p>Changed <tt class="docutils literal"><span class="pre">introspect.getRoot()</span></tt> to identify some situations where
598strings shouldn't be considered roots. For example:</p>
599<pre class="literal-block">
600&gt;&gt;&gt; import PyCrust # To illustrate the potential problem.
601&gt;&gt;&gt; len('PyCrust.py')
602</pre>
603<p>Typing the dot at the end of &quot;PyCrust&quot; in the second line above should
604NOT result in an autocompletion list because &quot;PyCrust&quot; is part of a
605string in this context, not a reference to the PyCrust module object.
606Similar reasoning applies to call tips. For example:</p>
607<pre class="literal-block">
608&gt;&gt;&gt; len('dir(')
609</pre>
610<p>Typing the left paren at the end of &quot;dir&quot; should NOT result in a call
611tip.</p>
612<p>Both features now behave properly in the examples given. However,
613there is still the case where whitespace precedes the potential root
614and that is NOT handled properly. For example:</p>
615<pre class="literal-block">
616&gt;&gt;&gt; len('this is a dir(')
617</pre>
618<p>and:</p>
619<pre class="literal-block">
620&gt;&gt;&gt; len('This is PyCrust.py')
621</pre>
622<p>More code needs to be written to handle more complex situations.</p>
623<p>Added <tt class="docutils literal"><span class="pre">locals=None</span></tt> parameter to <tt class="docutils literal"><span class="pre">Shell.__init__()</span></tt>.</p>
624<p>Added support for magic attribute retrieval. Users can change this
625with:</p>
626<pre class="literal-block">
627&gt;&gt;&gt; shell.editor.autoCompleteIncludeMagic = 0
628</pre>
629<p>Added the ability to set filters on auto completion to exclude
630attributes prefixed with a single or double underscore. Users can
631exclude one or the other or both with:</p>
632<pre class="literal-block">
633&gt;&gt;&gt; shell.editor.autoCompleteExcludeSingle = 1
634&gt;&gt;&gt; shell.editor.autoCompleteExcludeDouble = 1
635</pre>
636</div>
637<div class="section" id="id2">
638<h2><a class="toc-backref" href="#id34" name="id2">0.5 (8/8/2001)</a></h2>
639<p>Mostly just a final version change before creating a release.</p>
640</div>
641<div class="section" id="to-8-7-2001">
642<h2><a class="toc-backref" href="#id35" name="to-8-7-2001">0.4 (8/4/2001 to 8/7/2001)</a></h2>
643<p>Changed version/revision handling.</p>
644<p>Fixed bugs.</p>
645</div>
646<div class="section" id="to-8-3-2001">
647<h2><a class="toc-backref" href="#id36" name="to-8-3-2001">0.3 (8/2/2001 to 8/3/2001)</a></h2>
648<p>Removed lots of cruft.</p>
649<p>Added lots of docstrings.</p>
650<p>Imported to CVS repository at SourceForge.</p>
651<p>Added call tips.</p>
652</div>
653<div class="section" id="to-8-2-2001">
654<h2><a class="toc-backref" href="#id37" name="to-8-2-2001">0.2 (7/30/2001 to 8/2/2001)</a></h2>
655<p>Renamed several files.</p>
656<p>Added command autocompletion.</p>
657<p>Added menus to PyCrust.py: File, Edit and Help.</p>
658<p>Added sample applications: <tt class="docutils literal"><span class="pre">PyCrustAlaCarte.py</span></tt>,
659<tt class="docutils literal"><span class="pre">PyCrustAlaMode.py</span></tt>, and <tt class="docutils literal"><span class="pre">PyCrustMinimus.py</span></tt>.</p>
660</div>
661<div class="section" id="to-7-19-2001">
662<h2><a class="toc-backref" href="#id38" name="to-7-19-2001">0.1 (7/1/2001 to 7/19/2001)</a></h2>
663<p>Added basic syntax coloring much like Boa.</p>
664<p>Added read-only logging much like IDLE.</p>
665<p>Can retrieve a previous command by putting the cursor back on that
666line and hitting enter.</p>
667<p>Stdin and raw_input operate properly so you can now do <tt class="docutils literal"><span class="pre">help()</span></tt> and
668<tt class="docutils literal"><span class="pre">license()</span></tt> without hanging.</p>
669<p>Redefined &quot;quit&quot;, &quot;exit&quot;, and &quot;close&quot; to display a better-than-nothing
670response.</p>
671<p>Home key honors the prompt.</p>
672<p>Created SourceForge account, but nothing was posted.</p>
673</div>
674<div class="section" id="in-the-beginning-there-was-pie-7-1-2001">
675<h2><a class="toc-backref" href="#id39" name="in-the-beginning-there-was-pie-7-1-2001">In the beginning, there was pie... (7/1/2001)</a></h2>
676<p>Blame it all on IDLE, Boa and PythonWin. I was using all three, got
677frustrated with their dissimilarities, and began to let everyone know
678how I felt. At the same time, Scintilla looked like an interesting
679tool to build a shell around. And while I didn't receive much in the
680way of positive feedback, let alone encouragement, I just couldn't let
681go of the idea of a Scintilla-based Python shell. Then the PythonCard
682project got to the point where they were talking about including a
683shell in their development environment. That was all the incentive I
684needed. PyCrust had to happen...</p>
685</div>
686</div>
687</div>
688</body>
689</html>
wxWidgets (Impactor)