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