Merge lp:~fdo.perez/ipython/trunk-dev into lp:ipython/0.11

[Fernando Perez]

[Fernando Perez (fdo.perez)]

I had to nuke my lp copy of my trunk because I did some local patch reordering, so I've just re-uploaded a fresh copy. The code is the same as before.

Ready for review.

[lp:~fdo.perez/ipython/trunk-dev]

1172. By Fernando Perez on 2009-03-14

Close https://bugs.launchpad.net/ipython/+bug/341726

Apply patch submitted by Alexander Clausen <alex-AT-gc-web.de>. Fixes
incorrect bug reporting URL for IPython and stale SVN references.

1173. By Fernando Perez on 2009-03-14

Fix https://bugs.launchpad.net/ipython/+bug/239054

- Made a more robust reset method to fully flush internal state and restore
the system to a clean state. We'll need to see later if %reset should just
call this. For now it's used to release resources.

1174. By Fernando Perez on 2009-03-14

Fix https://bugs.launchpad.net/ipython/+bug/284660

Since we now require python 2.4, I applied a simpler version of the patch
mentioned there, simply using the set() builtin everywhere.

1175. By Fernando Perez on 2009-03-15

Merging from upstream (with a few local cleanups when resolving conflicts).

1176. By Fernando Perez on 2009-03-15

Add a note about the conflict winpdb causes with PyTables.

1177. By Fernando Perez on 2009-03-16

Fix problems with multiline doctests and add docs about testing.

Also enabled some more testings that were blacklisted, now that the testing
machinery is more robust.

[Brian Granger (ellisonbg)]

I just had fun doing this code review. Launchpad has really improved its code review interface. I really like how you can look through the diffs for each file now!

One general comment: I know you like to code in a single branch, but it makes it more difficult to review a branch when there are many revisions on a wide range of topics. I don't think each revision should go in its own branch, but when there is a larger set of revisions addressing a single issue, having all of those revisions in a single topic branch would be nice and make review easier. Also, smaller branches allow code that *is* finished to get into trunk faster without waiting for unrelated code to be finished and reviewed. I am guilty of the "big branch" workflow myself though.

r1168:

As you go through file and clean up the copyright info, please convert the copyright header to our standard one that references the ipython development team. Any specific mention of module authors or maintainers should go into the module docstring.

r1169:

Are the numpy helper scripts for converting docstrings in place and working with our IPython?

How do we want to handle references in our docs. Sphinx can now create a nice references section in the pdf files, but you have to use a particular format for the references. The current form of the references you have put in::

    .. _PEP 257: http://www.python.org/peps/pep-0257.html

I don't think will end up in the references section. How does numpy handle such things. Have a look at how references are handled in the kernel documentation to see how I have been handling this. My way may not be the best. Let's figure out how all of us should handle this and then document it in our docs.

r1171:

In ipy_profile_zope.py. Should we just remove all the old __author__, etc. module attributes?

All other revisions are great.

review: Needs Fixing

[lp:~fdo.perez/ipython/trunk-dev]

1178. By Fernando Perez on 2009-03-16

Merging upstream changes from trunk (after fixing small conflicts).

[Fernando Perez (fdo.perez)]

Hey,

I know we talked offline about most of this, but I'll leave things
here for recording purposes.

On Mon, Mar 16, 2009 at 9:39 AM, Brian Granger <email address hidden> wrote:
> Review: Needs Fixing
> I just had fun doing this code review.  Launchpad has really improved its code review interface.  I really like how you can look through the diffs for each file now!

Yes, it's gotten much better. Launchpad is slowly but surely improving.

>
> One general comment:  I know you like to code in a single branch, but it makes it more difficult to review a branch when there are many revisions on a wide range of topics.  I don't think each revision should go in its own branch, but when there is a larger set of revisions addressing a single issue, having all of those revisions in a single topic branch would be nice and make review easier.  Also, smaller branches allow code that *is* finished to get into trunk faster without waiting for unrelated code to be finished and reviewed.  I am guilty of the "big branch" workflow myself though.

Me too, it's certainly a bad habit. As we spoke about, we could
probably settle on a workflow with:

- per-person permanent 'trunk-dev' branches, on which we do easy,
incremental reviewing and merging.
- short-lived 'feature branches' for standalone ideas, more like a
patch in other workflows, just a patch that keeps evolving and that's
easy to track as it changes.

I'll try to do better in the future on this, and I really appreciate
that you took the time to go over this much code. Many thanks.

>
> r1168:
>
> As you go through file and clean up the copyright info, please convert the copyright header to our standard one that references the ipython development team. Any specific mention of module authors or maintainers should go into the module docstring.

As I mentioned, I was really going after the 'import Release'
statements, not after the authorship notices. But from now on, I'll
try to cleanup the copyright notices as I work on files.

> r1169:
>
> Are the numpy helper scripts for converting docstrings in place and working with our IPython?
>
> How do we want to handle references in our docs.  Sphinx can now create a nice references section in the pdf files, but you have to use a particular format for the references.  The current form of the references you have put in::
>
>    .. _PEP 257: http://www.python.org/peps/pep-0257.html
>
> I don't think will end up in the references section.  How does numpy handle such things.  Have a look at how references are handled in the kernel documentation to see how I have been handling this.  My way may not be the best.  Let's figure out how all of us should handle this and then document it in our docs.

This one, I don't know. I'm going to look into what Matthew Brett did
for Nipy to see if I can find a good overall solution.

> r1171:
>
> In ipy_profile_zope.py.  Should we just remove all the old __author__, etc. module attributes?

I'll do what we discussed: put the authorship notes I find in the
top-level docstring. This has the added benefit of putting them in
the generated API docs.

> All other revisions are great.

Thanks again for reviewing such a monster!

I'l...

[lp:~fdo.perez/ipython/trunk-dev]

1179. By Fernando Perez on 2009-03-17

Merging from upstream trunk

1180. By Fernando Perez on 2009-03-17

Update copyright/author statements.

- Updated copyright statements to use the new form:

# Copyright (C) 2008-2009 The IPython Development Team

I left the old notices in place (just updating the year in some cases),
because as far as I know, old copyright statements are not meant to be
retroactively modified.

- Also, on most files, replaced __author__ marks with an 'Authors' section
in the module docstring. This reduces top-level code in the module, while
ensuring that the Author(s) get properly acknowledged in auto-generated API
docs (sphinx doesn't read __author__ marks, but it will include the module
docstring).

I only left a few in place for very old files that we ship externally, and
for those by Laurent: he had his authorship mark both in the docstring and
in __author__ variables, so I think out of courtesy it would be better to
ask him about it on the list. All the others were I found regular
__author__ variables, I moved them to the main docstring.

[Fernando Perez (fdo.perez)]

"""
> r1168:
>
> As you go through file and clean up the copyright info, please convert the copyright header to our standard one that references the ipython development team. Any specific mention of module authors or maintainers should go into the module docstring.

As I mentioned, I was really going after the 'import Release'
statements, not after the authorship notices. But from now on, I'll
try to cleanup the copyright notices as I work on files.
"""

I did try to update at least those where I went fixing __author__ marks, as per your other comment. See the log comment in
http://bazaar.launchpad.net/~fdo.perez/ipython/trunk-dev/revision/1180
for more details on the logic I used. I took the 'team' 2008 statement and pushed to 09, and just closed the year gap on the old statements but otherwise left them as they were. I think that's how copyright statements are supposed to be updated, but I'm not sure. Feel free to let me know if it should be done otherwise.

> r1169:
>
> Are the numpy helper scripts for converting docstrings in place and working with our IPython?

Yes, they are. I've started using numpy docstrings in all new functions, and they work fine. I haven't gone updating old ones though... I did add mention of this in the dev docs.

"""
> How do we want to handle references in our docs.  Sphinx can now create a nice references section in the pdf files, but you have to use a particular format for the references.  The current form of the references you have put in::
>
>    .. _PEP 257: http://www.python.org/peps/pep-0257.html
>
> I don't think will end up in the references section.  How does numpy handle such things.  Have a look at how references are handled in the kernel documentation to see how I have been handling this.  My way may not be the best.  Let's figure out how all of us should handle this and then document it in our docs.

This one, I don't know. I'm going to look into what Matthew Brett did
for Nipy to see if I can find a good overall solution.
"""

I have to admit that I'm stumped on how to handle this one. Since it's not anything new in this branch per se, are you OK with merging and working on it together on trunk? I'm happy to make any local changes to the branch before merging, but I don't have a full solution for the references problem.

"""
> r1171:
>
> In ipy_profile_zope.py.  Should we just remove all the old __author__, etc. module attributes?

I'll do what we discussed: put the authorship notes I find in the
top-level docstring. This has the added benefit of putting them in
the generated API docs.
"""

I did go through most, as noted in the changelog. There's only a few left of very old external files, and Laurent's, which we should ask him about on list.

Thanks for the review!

[lp:~fdo.perez/ipython/trunk-dev]

1181. By Fernando Perez on 2009-03-17

Add information about our testing system, test writing tips, etc.

[Brian Granger (ellisonbg)]

> I did try to update at least those where I went fixing __author__ marks, as per your other comment.  See the log comment in
> http://bazaar.launchpad.net/~fdo.perez/ipython/trunk-dev/revision/1180
> for more details on the logic I used.  I took the 'team' 2008 statement and pushed to 09, and just closed the year gap on the old statements but otherwise left them as they were.   I think that's how copyright statements are supposed to be updated, but I'm not sure.  Feel free to let me know if it should be done otherwise.

Sounds fine by me.

>> r1169:
>>
>> Are the numpy helper scripts for converting docstrings in place and working with our IPython?
>
> Yes, they are.  I've started using numpy docstrings in all new functions, and they work fine.  I haven't gone updating old ones though...  I did add mention of this in the dev docs.

Great, I will start to write my docstring to this format.

>> How do we want to handle references in our docs.  Sphinx can now create a nice references section in the pdf files, but you have to use a particular format for the references.  The current form of the references you have put in::
>>
>>    .. _PEP 257: http://www.python.org/peps/pep-0257.html
>>
>> I don't think will end up in the references section.  How does numpy handle such things.  Have a look at how references are handled in the kernel documentation to see how I have been handling this.  My way may not be the best.  Let's figure out how all of us should handle this and then document it in our docs.
>
>
> This one, I don't know. I'm going to look into what Matthew Brett did
> for Nipy to see if I can find a good overall solution.
> """
>
> I have to admit that I'm stumped on how to handle this one.  Since it's not anything new in this branch per se, are you OK with merging and working on it together on trunk?  I'm happy to make any local changes to the branch before merging, but I don't have a full solution for the references problem.

That is fine. Just do the merge and we can slowly figure this one out.
 It is not a big deal because our existing refs don't do anything in
particular in this area, so we will have to change things anyway.

> Thanks for the review!

No problem.

Brian

--
Brian E. Granger, Ph.D.
Assistant Professor of Physics
Cal Poly State University, San Luis Obispo
<email address hidden>
<email address hidden>

[lp:~fdo.perez/ipython/trunk-dev]

1182. By Fernando Perez on 2009-03-17

Add a .bzrignore file for cleaner 'bzr status' output

[Fernando Perez (fdo.perez)]

On Tue, Mar 17, 2009 at 7:15 AM, Brian Granger <email address hidden> wrote:

> That is fine. Just do the merge and we can slowly figure this one out.
>  It is not a big deal because our existing refs don't do anything in
> particular in this area, so we will have to change things anyway.

OK. I just did the merge, this is large enough that I'll put a
message on the list so everyone can test it.

Thanks again for the review work, this one was a lot to look at :)

Cheers,

f

=== modified file 'IPython/ColorANSI.py'
--- IPython/ColorANSI.py	2008-08-28 22:00:22 +0000
+++ IPython/ColorANSI.py	2009-03-11 06:53:19 +0000
@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 """Tools for coloring text in ANSI terminals.
-
-$Id: ColorANSI.py 2167 2007-03-21 06:57:50Z fperez $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2002-2006 Fernando Perez. <[e-mail]>
@@ -10,10 +9,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-
 __all__ = ['TermColors','InputTermColors','ColorScheme','ColorSchemeTable']
 
 import os
 
=== modified file 'IPython/ConfigLoader.py'
--- IPython/ConfigLoader.py	2008-02-28 18:21:11 +0000
+++ IPython/ConfigLoader.py	2009-03-11 06:53:19 +0000
@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 """Configuration loader
-
-$Id: ConfigLoader.py 1005 2006-01-12 08:39:26Z fperez $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez. <[e-mail]>
@@ -10,10 +9,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-
 import exceptions
 import os
 from pprint import pprint
@@ -73,14 +68,14 @@
         # avoid including the same file more than once
         if fname in self.included:
             return data
-        Xinfo = ultraTB.AutoFormattedTB()
+        Xinfo = ultraTB.AutoFormattedTB(color_scheme='NoColor')
         if convert==None and recurse_key : convert = {qwflat:recurse_key}
         # for production, change warn to 0:
         data.merge(read_dict(fname,convert,fs=self.field_sep,strip=1,
                              warn=0,no_empty=0,**kw))
         # keep track of successfully loaded files
         self.included.append(fname)
-        if recurse_key in data.keys():
+        if recurse_key in data:
             for incfilename in data[recurse_key]:
                 found=0
                 try:
 
=== modified file 'IPython/CrashHandler.py'
--- IPython/CrashHandler.py	2008-02-28 18:21:11 +0000
+++ IPython/CrashHandler.py	2009-03-11 06:53:19 +0000
@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 """sys.excepthook for IPython itself, leaves a detailed report on disk.
-
-$Id: CrashHandler.py 2908 2007-12-30 21:07:46Z vivainio $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez. <[e-mail]>
 
=== modified file 'IPython/DPyGetOpt.py'
--- IPython/DPyGetOpt.py	2008-02-28 18:21:11 +0000
+++ IPython/DPyGetOpt.py	2009-03-11 06:53:19 +0000
@@ -1,8 +1,6 @@
 # -*- coding: utf-8 -*-
 """DPyGetOpt -- Demiurge Python GetOptions Module
 
- $Id: DPyGetOpt.py 2872 2007-11-25 17:58:05Z fperez $
-
 This module is modeled after perl's Getopt::Long module-- which
 is, in turn, modeled after GNU's extended getopt() function.
 
@@ -32,8 +30,7 @@
 and -baz options that appear on within the parsed argument list
 must have a real number argument and that the accumulated list
 of values will be available under the name 'foo'
-
-$Id: DPyGetOpt.py 2872 2007-11-25 17:58:05Z fperez $"""
+"""
 
 #*****************************************************************************
 #
 
=== modified file 'IPython/Debugger.py'
--- IPython/Debugger.py	2008-06-07 06:50:18 +0000
+++ IPython/Debugger.py	2009-03-11 06:53:19 +0000
@@ -13,9 +13,7 @@
 changes. Licensing should therefore be under the standard Python terms.  For
 details on the PSF (Python Software Foundation) standard license, see:
 
-http://www.python.org/2.2.3/license.html
-
-$Id: Debugger.py 2913 2007-12-31 12:42:14Z vivainio $"""
+http://www.python.org/2.2.3/license.html"""
 
 #*****************************************************************************
 #
@@ -27,10 +25,6 @@
 #
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = 'Python'
-
 import bdb
 import cmd
 import linecache
@@ -39,7 +33,7 @@
 
 from IPython import PyColorize, ColorANSI, ipapi
 from IPython.genutils import Term
-from IPython.excolors import ExceptionColors
+from IPython.excolors import exception_colors
 
 # See if we can use pydb.
 has_pydb = False
@@ -210,7 +204,7 @@
 
             # Create color table: we copy the default one from the traceback
             # module and add a few attributes needed for debugging
-            self.color_scheme_table = ExceptionColors.copy()
+            self.color_scheme_table = exception_colors()
 
             # shorthands 
             C = ColorANSI.TermColors
@@ -257,8 +251,7 @@
 
             # Create color table: we copy the default one from the traceback
             # module and add a few attributes needed for debugging
-            ExceptionColors.set_active_scheme(color_scheme)
-            self.color_scheme_table = ExceptionColors.copy()
+            self.color_scheme_table = exception_colors()
 
             # shorthands 
             C = ColorANSI.TermColors
 
=== modified file 'IPython/Extensions/InterpreterExec.py'
--- IPython/Extensions/InterpreterExec.py	2008-02-28 18:21:11 +0000
+++ IPython/Extensions/InterpreterExec.py	2009-03-11 06:53:19 +0000
@@ -4,8 +4,7 @@
 We define a special input line filter to allow typing lines which begin with
 '~', '/' or '.'. If one of those strings is encountered, it is automatically
 executed.
-
-$Id: InterpreterExec.py 2724 2007-09-07 08:05:38Z fperez $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2004 W.J. van der Laan <[e-mail]>
@@ -15,11 +14,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__ = 'W.J. van der Laan <[e-mail]>, '\
-             '%s <%s>' %  Release.authors['Fernando']
-__license__ = Release.license
-
 # TODO: deprecated
 def prefilter_shell(self,line,continuation):
     """Alternate prefilter, modified for shell-like functionality.
 
=== modified file 'IPython/Extensions/clearcmd.py'
--- IPython/Extensions/clearcmd.py	2008-02-16 09:50:47 +0000
+++ IPython/Extensions/clearcmd.py	2009-03-10 19:39:05 +0000
@@ -5,43 +5,65 @@
 import gc
 ip = IPython.ipapi.get()
 
-
 def clear_f(self,arg):
     """ Clear various data (e.g. stored history data)
     
+    %clear in  - clear input history
     %clear out - clear output history
-    %clear in  - clear input history
     %clear shadow_compress - Compresses shadow history (to speed up ipython)
     %clear shadow_nuke - permanently erase all entries in shadow history
     %clear dhist - clear dir history
+    %clear array - clear only variables that are NumPy arrays
+    
+    Examples:
+
+    In [1]: clear in
+    Flushing input history
+
+    In [2]: clear shadow_compress
+    Compressing shadow history
+
+    In [3]: clear shadow_nuke
+    Erased all keys from shadow history
+
+    In [4]: clear dhist
+    Clearing directory history
     """
     
     api = self.getapi()
+    user_ns = self.user_ns  # local lookup, heavily used
+        
+    
     for target in arg.split():
+
         if target == 'out':
-            print "Flushing output cache (%d entries)" % len(api.user_ns['_oh'])
+            print "Flushing output cache (%d entries)" % len(user_ns['_oh'])
             self.outputcache.flush()
+
         elif target == 'in':
             print "Flushing input history"
-            from IPython import iplib
             pc = self.outputcache.prompt_count + 1
             for n in range(1, pc):
                 key = '_i'+`n`
+                user_ns.pop(key,None)
                 try:
-                    del self.user_ns[key]
+                    del user_ns[key]
                 except: pass
             # must be done in-place
             self.input_hist[:] = ['\n'] * pc 
             self.input_hist_raw[:] = ['\n'] * pc
+
         elif target == 'array':
+            # Support cleaning up numpy arrays
             try:
-                pylab=ip.IP.pylab
-                for x in self.user_ns.keys():
-                    if isinstance(self.user_ns[x],pylab.arraytype):
-                        del self.user_ns[x]
+                from numpy import ndarray
+                # This must be done with items and not iteritems because we're
+                # going to modify the dict in-place.
+                for x,val in user_ns.items():
+                    if isinstance(val,ndarray):
+                        del user_ns[x]
             except AttributeError:
-                print "Clear array only available in -pylab mode"
-            gc.collect()                
+                print "Clear array only works if Numpy is available."
 
         elif target == 'shadow_compress':
             print "Compressing shadow history"
@@ -51,16 +73,15 @@
             print "Erased all keys from shadow history "
             for k in ip.db.keys('shadowhist/*'):
                 del ip.db[k]
+
         elif target == 'dhist':
             print "Clearing directory history"
-            del ip.user_ns['_dh'][:]
-
-            
+            del user_ns['_dh'][:]
+
+    gc.collect()        
+
+# Activate the extension
 ip.expose_magic("clear",clear_f)
 import ipy_completers
 ipy_completers.quick_completer(
- '%clear','in out shadow_nuke shadow_compress dhist')
-    
-
-
-
+    '%clear','in out shadow_nuke shadow_compress dhist')
 
=== modified file 'IPython/Extensions/ext_rescapture.py'
--- IPython/Extensions/ext_rescapture.py	2008-02-16 09:50:47 +0000
+++ IPython/Extensions/ext_rescapture.py	2009-03-11 06:53:19 +0000
@@ -6,9 +6,6 @@
 var = %magic blah blah
 
 var = !ls
-
-$Id: genutils.py 1077 2006-01-24 18:15:27Z vivainio $
-
 """
 
 import IPython.ipapi
 
=== modified file 'IPython/Extensions/ipy_profile_zope.py'
--- IPython/Extensions/ipy_profile_zope.py	2008-02-16 09:50:47 +0000
+++ IPython/Extensions/ipy_profile_zope.py	2009-03-13 17:56:47 +0000
@@ -12,7 +12,6 @@
 
 __author__ = """Stefan Eletzhofer <[e-mail]>"""
 __docformat__ = 'plaintext'
-__revision__ = "$Revision$"
 
 from IPython import ipapi
 from IPython import Release
 
=== modified file 'IPython/Extensions/pspersistence.py'
--- IPython/Extensions/pspersistence.py	2008-06-03 20:03:02 +0000
+++ IPython/Extensions/pspersistence.py	2009-03-11 06:53:19 +0000
@@ -3,8 +3,6 @@
 %store magic for lightweight persistence.
 
 Stores variables, aliases etc. in PickleShare database.
-
-$Id: iplib.py 1107 2006-01-30 19:02:20Z vivainio $
 """
 
 import IPython.ipapi
 
=== modified file 'IPython/FakeModule.py'
--- IPython/FakeModule.py	2008-02-28 18:21:11 +0000
+++ IPython/FakeModule.py	2009-03-11 06:53:19 +0000
@@ -4,8 +4,7 @@
 
 Needed to allow pickle to correctly resolve namespaces during IPython
 sessions.
-
-$Id: FakeModule.py 2754 2007-09-09 10:16:59Z fperez $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2002-2004 Fernando Perez. <[e-mail]>
 
=== modified file 'IPython/Gnuplot2.py'
--- IPython/Gnuplot2.py	2008-02-28 18:21:11 +0000
+++ IPython/Gnuplot2.py	2009-03-11 06:53:19 +0000
@@ -12,8 +12,7 @@
 Gnuplot, so it should be safe to do:
 
 import IPython.Gnuplot2 as Gnuplot
-
-$Id: Gnuplot2.py 1210 2006-03-13 01:19:31Z fperez $"""
+"""
 
 import cStringIO
 import os
 
=== modified file 'IPython/GnuplotInteractive.py'
--- IPython/GnuplotInteractive.py	2008-02-28 18:21:11 +0000
+++ IPython/GnuplotInteractive.py	2009-03-11 06:53:19 +0000
@@ -9,8 +9,7 @@
 See gphelp() below for details on the services offered by this module.
 
 Inspired by a suggestion/request from Arnd Baecker.
-
-$Id: GnuplotInteractive.py 389 2004-10-09 07:59:30Z fperez $"""
+"""
 
 __all__ = ['Gnuplot','gp','gp_new','plot','plot2','splot','replot',
            'hardcopy','gpdata','gpfile','gpstring','gpfunc','gpgrid',
 
=== modified file 'IPython/GnuplotRuntime.py'
--- IPython/GnuplotRuntime.py	2008-02-28 18:21:11 +0000
+++ IPython/GnuplotRuntime.py	2009-03-11 06:53:19 +0000
@@ -47,8 +47,7 @@
 http://gnuplot-py.sourceforge.net/
 
 Inspired by a suggestion/request from Arnd Baecker.
-
-$Id: GnuplotRuntime.py 389 2004-10-09 07:59:30Z fperez $"""
+"""
 
 __all__ = ['Gnuplot','gp','gp_new','Data','File','Func','GridData',
            'pm3d_config','eps_fix_bbox']
 
=== modified file 'IPython/Itpl.py'
--- IPython/Itpl.py	2008-05-15 05:05:58 +0000
+++ IPython/Itpl.py	2009-03-11 06:53:19 +0000
@@ -27,7 +27,7 @@
     import Itpl
     sys.stdout = Itpl.filter()
     f = "fancy"
-    print "Isn't this $f?"
+    print "Is this not $f?"
     print "Standard output has been replaced with a $sys.stdout object."
     sys.stdout = Itpl.unfilter()
     print "Okay, back $to $normal."
@@ -43,9 +43,7 @@
     print str(s)
     foo = "bar"
     print str(s)
-
-$Id: Itpl.py 2918 2007-12-31 14:34:47Z vivainio $
-"""                   # ' -> close an open quote for stupid emacs
+"""
 
 #*****************************************************************************
 #
 
=== modified file 'IPython/Logger.py'
--- IPython/Logger.py	2008-08-14 12:48:09 +0000
+++ IPython/Logger.py	2009-03-11 06:53:19 +0000
@@ -1,8 +1,6 @@
 # -*- coding: utf-8 -*-
 """
 Logger class for IPython's logging facilities.
-
-$Id: Logger.py 2875 2007-11-26 08:37:39Z fperez $
 """
 
 #*****************************************************************************
@@ -16,11 +14,6 @@
 #****************************************************************************
 # Modules and globals
 
-from IPython import Release
-__author__  = '%s <%s>\n%s <%s>' % \
-              ( Release.authors['Janko'] + Release.authors['Fernando'] )
-__license__ = Release.license
-
 # Python standard modules
 import glob
 import os
 
=== modified file 'IPython/Magic.py'
--- IPython/Magic.py	2008-09-17 19:07:48 +0000
+++ IPython/Magic.py	2009-03-13 17:56:19 +0000
@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 """Magic functions for InteractiveShell.
-
-$Id: Magic.py 2996 2008-01-30 06:31:39Z fperez $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001 Janko Hauser <[e-mail]> and
@@ -14,11 +13,6 @@
 #****************************************************************************
 # Modules and globals
 
-from IPython import Release
-__author__  = '%s <%s>\n%s <%s>' % \
-              ( Release.authors['Janko'] + Release.authors['Fernando'] )
-__license__ = Release.license
-
 # Python standard modules
 import __builtin__
 import bdb
@@ -1050,10 +1044,33 @@
     def magic_reset(self, parameter_s=''):
         """Resets the namespace by removing all names defined by the user.
 
-        Input/Output history are left around in case you need them."""
-
-        ans = self.shell.ask_yes_no(
-          "Once deleted, variables cannot be recovered. Proceed (y/[n])? ")
+        Input/Output history are left around in case you need them.
+
+        Parameters
+        ----------
+          -y : force reset without asking for confirmation.
+
+        Examples
+        --------
+        In [6]: a = 1
+
+        In [7]: a
+        Out[7]: 1
+
+        In [8]: 'a' in _ip.user_ns
+        Out[8]: True
+
+        In [9]: %reset -f
+
+        In [10]: 'a' in _ip.user_ns
+        Out[10]: False
+        """
+
+        if parameter_s == '-f':
+            ans = True
+        else:
+            ans = self.shell.ask_yes_no(
+                "Once deleted, variables cannot be recovered. Proceed (y/[n])? ")
         if not ans:
             print 'Nothing done.'
             return
@@ -1063,7 +1080,7 @@
             
         # Also flush the private list of module references kept for script
         # execution protection
-        self.shell._user_main_modules[:] = []
+        self.shell.clear_main_mod_cache()
 
     def magic_logstart(self,parameter_s=''):
         """Start logging anywhere in a session.
@@ -1422,7 +1439,8 @@
             return None
 
     @testdec.skip_doctest
-    def magic_run(self, parameter_s ='',runner=None):
+    def magic_run(self, parameter_s ='',runner=None,
+                  file_finder=get_py_filename):
         """Run the named file inside IPython as a program.
 
         Usage:\\
@@ -1537,7 +1555,7 @@
                                           mode='list',list_all=1)
 
         try:
-            filename = get_py_filename(arg_lst[0])
+            filename = file_finder(arg_lst[0])
         except IndexError:
             warn('you must provide at least a filename.')
             print '\n%run:\n',OInspect.getdoc(self.magic_run)
@@ -1573,10 +1591,13 @@
             main_mod = FakeModule()
             prog_ns = main_mod.__dict__
             prog_ns['__name__'] = name
+            
             # The shell MUST hold a reference to main_mod so after %run exits,
             # the python deletion mechanism doesn't zero it out (leaving
-            # dangling references)
-            self.shell._user_main_modules.append(main_mod)
+            # dangling references).  However, we should drop old versions of
+            # main_mod.  There is now a proper API to manage this caching in
+            # the main shell object, we use that.            
+            self.shell.cache_main_mod(main_mod)
 
         # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
         # set the __file__ global in the script's namespace
 
=== modified file 'IPython/OInspect.py'
--- IPython/OInspect.py	2008-07-29 22:57:51 +0000
+++ IPython/OInspect.py	2009-03-11 06:53:19 +0000
@@ -5,8 +5,6 @@
 
 Similar in spirit to the inspect module, but all calls take a name argument to
 reference the name under which an object is being read.
-
-$Id: OInspect.py 2843 2007-10-15 21:22:32Z fperez $
 """
 
 #*****************************************************************************
@@ -16,10 +14,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-
 __all__ = ['Inspector','InspectColors']
 
 # stdlib modules
 
=== modified file 'IPython/OutputTrap.py'
--- IPython/OutputTrap.py	2008-02-28 18:21:11 +0000
+++ IPython/OutputTrap.py	2009-03-11 06:53:19 +0000
@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 """Class to trap stdout and stderr and log them separately.
-
-$Id: OutputTrap.py 958 2005-12-27 23:17:51Z fperez $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2004 Fernando Perez <[e-mail]>
@@ -10,10 +9,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-
 import exceptions
 import sys
 from cStringIO import StringIO
 
=== modified file 'IPython/Prompts.py'
--- IPython/Prompts.py	2008-02-28 18:21:11 +0000
+++ IPython/Prompts.py	2009-03-11 06:53:19 +0000
@@ -1,8 +1,7 @@
 # -*- coding: utf-8 -*-
 """
 Classes for handling input/output prompts.
-
-$Id: Prompts.py 3026 2008-02-07 16:03:16Z vivainio $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez <[e-mail]>
 
=== modified file 'IPython/PyColorize.py'
--- IPython/PyColorize.py	2008-08-23 22:34:55 +0000
+++ IPython/PyColorize.py	2009-03-11 06:53:19 +0000
@@ -1,34 +1,33 @@
 # -*- coding: utf-8 -*-
 """
-    Class and program to colorize python source code for ANSI terminals.
-
-    Based on an HTML code highlighter by Jurgen Hermann found at:
-    http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52298
-
-    Modifications by Fernando Perez ([e-mail]).
-
-    Information on the original HTML highlighter follows:
-    
-    MoinMoin - Python Source Parser
-
-    Title: Colorize Python source using the built-in tokenizer
-           
-    Submitter: Jurgen Hermann
-    Last Updated:2001/04/06
-           
-    Version no:1.2
-
-    Description:
-
-    This code is part of MoinMoin (http://moin.sourceforge.net/) and converts
-    Python source code to HTML markup, rendering comments, keywords,
-    operators, numeric and string literals in different colors.
-
-    It shows how to use the built-in keyword, token and tokenize modules to
-    scan Python source code and re-emit it with no changes to its original
-    formatting (which is the hard part).
-
-    $Id: PyColorize.py 2586 2007-08-06 19:30:09Z vivainio $"""
+Class and program to colorize python source code for ANSI terminals.
+
+Based on an HTML code highlighter by Jurgen Hermann found at:
+http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52298
+
+Modifications by Fernando Perez ([e-mail]).
+
+Information on the original HTML highlighter follows:
+
+MoinMoin - Python Source Parser
+
+Title: Colorize Python source using the built-in tokenizer
+
+Submitter: Jurgen Hermann
+Last Updated:2001/04/06
+
+Version no:1.2
+
+Description:
+
+This code is part of MoinMoin (http://moin.sourceforge.net/) and converts
+Python source code to HTML markup, rendering comments, keywords,
+operators, numeric and string literals in different colors.
+
+It shows how to use the built-in keyword, token and tokenize modules to
+scan Python source code and re-emit it with no changes to its original
+formatting (which is the hard part).
+"""
 
 __all__ = ['ANSICodeColors','Parser']
 
 
=== modified file 'IPython/Shell.py'
--- IPython/Shell.py	2008-08-24 06:10:55 +0000
+++ IPython/Shell.py	2009-03-11 06:53:19 +0000
@@ -3,8 +3,7 @@
 
 All the matplotlib support code was co-developed with John Hunter,
 matplotlib's author.
-
-$Id: Shell.py 3024 2008-02-07 15:34:42Z darren.dale $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez <[e-mail]>
@@ -13,10 +12,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-
 # Code begins
 # Stdlib imports
 import __builtin__
 
=== modified file 'IPython/UserConfig/ipythonrc'
--- IPython/UserConfig/ipythonrc	2008-02-28 18:21:11 +0000
+++ IPython/UserConfig/ipythonrc	2009-03-13 17:56:47 +0000
@@ -1,5 +1,4 @@
 # -*- Mode: Shell-Script -*-  Not really, but shows comments correctly
-# $Id: ipythonrc 2156 2007-03-19 02:32:19Z fperez $
 
 #***************************************************************************
 #
 
=== modified file 'IPython/__init__.py'
--- IPython/__init__.py	2008-08-02 09:05:40 +0000
+++ IPython/__init__.py	2009-03-11 06:53:19 +0000
@@ -25,9 +25,8 @@
 
   iii - serve as an embeddable, ready to go interpreter for your own programs.
 
-IPython requires Python 2.3 or newer.
-
-$Id: __init__.py 2399 2007-05-26 10:23:10Z vivainio $"""
+IPython requires Python 2.4 or newer.
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez. <[e-mail]>
 
=== modified file 'IPython/background_jobs.py'
--- IPython/background_jobs.py	2008-02-28 18:21:11 +0000
+++ IPython/background_jobs.py	2009-03-11 06:53:19 +0000
@@ -17,8 +17,6 @@
 
 (although ultimately no code from this text was used, as IPython's system is a
 separate implementation).
-
-$Id: background_jobs.py 994 2006-01-08 08:29:44Z fperez $
 """
 
 #*****************************************************************************
@@ -28,10 +26,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-
 # Code begins
 import sys
 import threading
 
=== modified file 'IPython/completer.py'
--- IPython/completer.py	2008-08-21 09:42:55 +0000
+++ IPython/completer.py	2009-03-11 01:24:53 +0000
@@ -6,7 +6,6 @@
 functionality specific to IPython, so this module will continue to live as an
 IPython-specific utility.
 
----------------------------------------------------------------------------
 Original rlcompleter documentation:
 
 This requires the latest extension to the readline module (the
 
=== modified file 'IPython/deep_reload.py'
--- IPython/deep_reload.py	2008-07-17 06:37:49 +0000
+++ IPython/deep_reload.py	2009-03-11 06:53:19 +0000
@@ -12,8 +12,7 @@
     >>> __builtin__.dreload = deep_reload.reload
     
 This code is almost entirely based on knee.py from the standard library.
-
-$Id: deep_reload.py 958 2005-12-27 23:17:51Z fperez $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001 Nathaniel Gray <[e-mail]>
@@ -22,12 +21,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release # do it explicitly so pydoc can see it - pydoc bug
-__author__  = '%s <%s>' %  Release.authors['Nathan']
-__license__ = Release.license
-__version__ = "0.5"
-__date__    = "21 August 2001"
-
 import __builtin__
 import imp
 import sys
 
=== modified file 'IPython/excolors.py'
--- IPython/excolors.py	2008-02-16 09:50:47 +0000
+++ IPython/excolors.py	2009-03-13 17:56:47 +0000
@@ -1,8 +1,7 @@
 # -*- coding: utf-8 -*-
 """
 Color schemes for exception handling code in IPython.
-
-$Id: Prompts.py 638 2005-07-18 03:01:41Z fperez $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2005-2006 Fernando Perez <[e-mail]>
@@ -11,99 +10,128 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-__version__ = Release.version
-
 #****************************************************************************
 # Required modules
 from IPython.ColorANSI import ColorSchemeTable, TermColors, ColorScheme
 
-ExceptionColors = ColorSchemeTable()
-
-# Populate it with color schemes
-C = TermColors # shorthand and local lookup
-ExceptionColors.add_scheme(ColorScheme(
-    'NoColor',
-    # The color to be used for the top line
-    topline = C.NoColor,
-
-    # The colors to be used in the traceback
-    filename = C.NoColor,
-    lineno = C.NoColor,
-    name = C.NoColor,
-    vName = C.NoColor,
-    val = C.NoColor,
-    em = C.NoColor,
-    
-    # Emphasized colors for the last frame of the traceback
-    normalEm = C.NoColor,
-    filenameEm = C.NoColor,
-    linenoEm = C.NoColor,
-    nameEm = C.NoColor,
-    valEm = C.NoColor,
-    
-    # Colors for printing the exception
-    excName = C.NoColor,
-    line = C.NoColor,
-    caret = C.NoColor,
-    Normal = C.NoColor
-    ))
-
-# make some schemes as instances so we can copy them for modification easily
-ExceptionColors.add_scheme(ColorScheme(
-    'Linux',
-    # The color to be used for the top line
-    topline = C.LightRed,
-
-    # The colors to be used in the traceback
-    filename = C.Green,
-    lineno = C.Green,
-    name = C.Purple,
-    vName = C.Cyan,
-    val = C.Green,
-    em = C.LightCyan,
-
-    # Emphasized colors for the last frame of the traceback
-    normalEm = C.LightCyan,
-    filenameEm = C.LightGreen,
-    linenoEm = C.LightGreen,
-    nameEm = C.LightPurple,
-    valEm = C.LightBlue,
-
-    # Colors for printing the exception
-    excName = C.LightRed,
-    line = C.Yellow,
-    caret = C.White,
-    Normal = C.Normal
-    ))
-
-# For light backgrounds, swap dark/light colors
-ExceptionColors.add_scheme(ColorScheme(
-    'LightBG',
-    # The color to be used for the top line
-    topline = C.Red,
-    
-    # The colors to be used in the traceback
-    filename = C.LightGreen,
-    lineno = C.LightGreen,
-    name = C.LightPurple,
-    vName = C.Cyan,
-    val = C.LightGreen,
-    em = C.Cyan,
-
-    # Emphasized colors for the last frame of the traceback
-    normalEm = C.Cyan,
-    filenameEm = C.Green,
-    linenoEm = C.Green,
-    nameEm = C.Purple,
-    valEm = C.Blue,
-
-    # Colors for printing the exception
-    excName = C.Red,
-    #line = C.Brown,  # brown often is displayed as yellow
-    line = C.Red,
-    caret = C.Normal,
-    Normal = C.Normal
-    ))
+def exception_colors():
+    """Return a color table with fields for exception reporting.
+
+    The table is an instance of ColorSchemeTable with schemes added for
+    'Linux', 'LightBG' and 'NoColor' and fields for exception handling filled
+    in.
+
+    Examples:
+
+    >>> ec = exception_colors()
+    >>> ec.active_scheme_name
+    ''
+    >>> print ec.active_colors
+    None
+
+    Now we activate a color scheme:    
+    >>> ec.set_active_scheme('NoColor')
+    >>> ec.active_scheme_name
+    'NoColor'
+    >>> ec.active_colors.keys()
+    ['em', 'caret', '__allownew', 'name', 'val', 'vName', 'Normal', 'normalEm',
+    'filename', 'linenoEm', 'excName', 'lineno', 'valEm', 'filenameEm',
+    'nameEm', 'line', 'topline']
+    """
+    
+    ex_colors = ColorSchemeTable()
+
+    # Populate it with color schemes
+    C = TermColors # shorthand and local lookup
+    ex_colors.add_scheme(ColorScheme(
+        'NoColor',
+        # The color to be used for the top line
+        topline = C.NoColor,
+
+        # The colors to be used in the traceback
+        filename = C.NoColor,
+        lineno = C.NoColor,
+        name = C.NoColor,
+        vName = C.NoColor,
+        val = C.NoColor,
+        em = C.NoColor,
+
+        # Emphasized colors for the last frame of the traceback
+        normalEm = C.NoColor,
+        filenameEm = C.NoColor,
+        linenoEm = C.NoColor,
+        nameEm = C.NoColor,
+        valEm = C.NoColor,
+
+        # Colors for printing the exception
+        excName = C.NoColor,
+        line = C.NoColor,
+        caret = C.NoColor,
+        Normal = C.NoColor
+        ))
+
+    # make some schemes as instances so we can copy them for modification easily
+    ex_colors.add_scheme(ColorScheme(
+        'Linux',
+        # The color to be used for the top line
+        topline = C.LightRed,
+
+        # The colors to be used in the traceback
+        filename = C.Green,
+        lineno = C.Green,
+        name = C.Purple,
+        vName = C.Cyan,
+        val = C.Green,
+        em = C.LightCyan,
+
+        # Emphasized colors for the last frame of the traceback
+        normalEm = C.LightCyan,
+        filenameEm = C.LightGreen,
+        linenoEm = C.LightGreen,
+        nameEm = C.LightPurple,
+        valEm = C.LightBlue,
+
+        # Colors for printing the exception
+        excName = C.LightRed,
+        line = C.Yellow,
+        caret = C.White,
+        Normal = C.Normal
+        ))
+
+    # For light backgrounds, swap dark/light colors
+    ex_colors.add_scheme(ColorScheme(
+        'LightBG',
+        # The color to be used for the top line
+        topline = C.Red,
+
+        # The colors to be used in the traceback
+        filename = C.LightGreen,
+        lineno = C.LightGreen,
+        name = C.LightPurple,
+        vName = C.Cyan,
+        val = C.LightGreen,
+        em = C.Cyan,
+
+        # Emphasized colors for the last frame of the traceback
+        normalEm = C.Cyan,
+        filenameEm = C.Green,
+        linenoEm = C.Green,
+        nameEm = C.Purple,
+        valEm = C.Blue,
+
+        # Colors for printing the exception
+        excName = C.Red,
+        #line = C.Brown,  # brown often is displayed as yellow
+        line = C.Red,
+        caret = C.Normal,
+        Normal = C.Normal,
+        ))
+
+    return ex_colors
+
+
+# For backwards compatibility, keep around a single global object.  Note that
+# this should NOT be used, the factory function should be used instead, since
+# these objects are stateful and it's very easy to get strange bugs if any code
+# modifies the module-level object's state.
+ExceptionColors = exception_colors()
 
=== modified file 'IPython/external/Itpl.py'
--- IPython/external/Itpl.py	2008-06-06 19:58:56 +0000
+++ IPython/external/Itpl.py	2009-03-11 06:53:19 +0000
@@ -27,7 +27,7 @@
     import Itpl
     sys.stdout = Itpl.filter()
     f = "fancy"
-    print "Isn't this $f?"
+    print "Is this not $f?"
     print "Standard output has been replaced with a $sys.stdout object."
     sys.stdout = Itpl.unfilter()
     print "Okay, back $to $normal."
@@ -43,9 +43,7 @@
     print str(s)
     foo = "bar"
     print str(s)
-
-$Id: Itpl.py 2305 2007-05-04 05:34:42Z bgranger $
-"""                   # ' -> close an open quote for stupid emacs
+"""
 
 #*****************************************************************************
 #
 
=== modified file 'IPython/genutils.py'
--- IPython/genutils.py	2008-09-03 23:31:20 +0000
+++ IPython/genutils.py	2009-03-11 06:53:19 +0000
@@ -1,11 +1,9 @@
 # -*- coding: utf-8 -*-
-"""
-General purpose utilities.
+"""General purpose utilities.
 
 This is a grab-bag of stuff I find useful in most programs I write. Some of
 these things are also convenient when working at the command line.
-
-$Id: genutils.py 2998 2008-01-31 10:06:04Z vivainio $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez. <[e-mail]>
@@ -14,10 +12,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-
 #****************************************************************************
 # required modules from the Python standard library
 import __main__
@@ -1234,11 +1228,11 @@
 def make_quoted_expr(s):
     """Return string s in appropriate quotes, using raw string if possible.
 
-    Effectively this turns string: cd \ao\ao\
-    to: r"cd \ao\ao\_"[:-1]
-
-    Note the use of raw string and padding at the end to allow trailing backslash.
-
+    XXX - example removed because it caused encoding errors in documentation
+    generation.  We need a new example that doesn't contain invalid chars.
+
+    Note the use of raw string and padding at the end to allow trailing
+    backslash.
     """
 
     tail = ''
 
=== modified file 'IPython/history.py'
--- IPython/history.py	2008-09-13 08:39:54 +0000
+++ IPython/history.py	2008-11-10 00:15:00 +0000
@@ -1,5 +1,4 @@
 # -*- coding: utf-8 -*-
-
 """ History related magics and functionality """
 
 # Stdlib imports
@@ -7,7 +6,7 @@
 import os
 
 # IPython imports
-from IPython.genutils import Term, ask_yes_no
+from IPython.genutils import Term, ask_yes_no, warn
 import IPython.ipapi
 
 def magic_history(self, parameter_s = ''):
@@ -47,8 +46,6 @@
       -f FILENAME: instead of printing the output to the screen, redirect it to
        the given file.  The file is always overwritten, though IPython asks for
        confirmation first if it already exists.
-      
-
     """
 
     ip = self.api
@@ -62,31 +59,28 @@
     try:
         outfname = opts['f']
     except KeyError:
-        outfile = Term.cout
+        outfile = Term.cout  # default
         # We don't want to close stdout at the end!
         close_at_end = False
     else:
         if os.path.exists(outfname):
-            ans = ask_yes_no("File %r exists. Overwrite?" % outfname)
-            if not ans:
+            if not ask_yes_no("File %r exists. Overwrite?" % outfname): 
                 print 'Aborting.'
                 return
-            else:
-                outfile = open(outfname,'w')
-                close_at_end = True
-                
-
-    if opts.has_key('t'):
+
+        outfile = open(outfname,'w')
+        close_at_end = True
+
+    if 't' in opts:
         input_hist = shell.input_hist
-    elif opts.has_key('r'):
+    elif 'r' in opts:
         input_hist = shell.input_hist_raw
     else:
         input_hist = shell.input_hist
-        
-    
+            
     default_length = 40
     pattern = None
-    if opts.has_key('g'):
+    if 'g' in opts:
         init = 1
         final = len(input_hist)
         parts = parameter_s.split(None,1)
@@ -138,13 +132,11 @@
         outfile.close()
 
 
-
 def magic_hist(self, parameter_s=''):
     """Alternate name for %history."""
     return self.magic_history(parameter_s)
 
 
-
 def rep_f(self, arg):
     r""" Repeat a command, or get command to input line for editing
 
@@ -173,11 +165,9 @@
     %rep foo
     
     Place the most recent line that has the substring "foo" to next input.
-    (e.g. 'svn ci -m foobar').
-    
+    (e.g. 'svn ci -m foobar').    
     """
     
-    
     opts,args = self.parse_options(arg,'',mode='list')
     ip = self.api    
     if not args:
@@ -206,7 +196,6 @@
                 ip.set_next_input(str(h).rstrip())
                 return
         
-
     try:
         lines = self.extract_input_slices(args, True)
         print "lines",lines
@@ -215,7 +204,6 @@
         print "Not found in recent history:", args
         
 
-
 _sentinel = object()
 
 class ShadowHist:
@@ -259,23 +247,12 @@
             if k == idx:
                 return v
 
-def test_shist():
-    from IPython.Extensions import pickleshare
-    db = pickleshare.PickleShareDB('~/shist')
-    s = ShadowHist(db)
-    s.add('hello')
-    s.add('world')
-    s.add('hello')
-    s.add('hello')
-    s.add('karhu')
-    print "all",s.all()
-    print s.get(2)
 
 def init_ipython(ip):
+    import ipy_completers
+
     ip.expose_magic("rep",rep_f)        
     ip.expose_magic("hist",magic_hist)            
     ip.expose_magic("history",magic_history)
 
-    import ipy_completers
     ipy_completers.quick_completer('%hist' ,'-g -t -r -n')
-#test_shist()
 
=== modified file 'IPython/hooks.py'
--- IPython/hooks.py	2008-06-07 06:50:18 +0000
+++ IPython/hooks.py	2009-03-11 06:53:19 +0000
@@ -31,8 +31,7 @@
 
 You can then enable the functionality by doing 'import myiphooks'
 somewhere in your configuration files or ipython command line.
-
-$Id: hooks.py 2998 2008-01-31 10:06:04Z vivainio $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2005 Fernando Perez. <[e-mail]>
@@ -41,11 +40,7 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
 from IPython import ipapi
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-__version__ = Release.version
 
 import os,bisect
 from genutils import Term,shell
 
=== modified file 'IPython/ipapi.py'
--- IPython/ipapi.py	2008-08-13 06:05:45 +0000
+++ IPython/ipapi.py	2009-03-11 01:24:53 +0000
@@ -24,7 +24,6 @@
 personal configuration (as opposed to boilerplate ipythonrc-PROFILENAME 
 stuff) in there. 
 
------------------------------------------------
 import IPython.ipapi
 ip = IPython.ipapi.get()
 
 
=== modified file 'IPython/iplib.py'
--- IPython/iplib.py	2008-08-14 12:50:55 +0000
+++ IPython/iplib.py	2009-03-13 17:56:19 +0000
@@ -2,10 +2,9 @@
 """
 IPython -- An enhanced Interactive Python
 
-Requires Python 2.3 or newer.
+Requires Python 2.4 or newer.
 
 This file contains all the classes and helper functions specific to IPython.
-
 """
 
 #*****************************************************************************
@@ -27,12 +26,6 @@
 #****************************************************************************
 # Modules and globals
 
-from IPython import Release
-__author__  = '%s <%s>\n%s <%s>' % \
-              ( Release.authors['Janko'] + Release.authors['Fernando'] )
-__license__ = Release.license
-__version__ = Release.version
-
 # Python standard modules
 import __main__
 import __builtin__
@@ -342,15 +335,19 @@
         # code ran is deleted.  Now that this object is a true module (needed
         # so docetst and other tools work correctly), the Python module
         # teardown mechanism runs over it, and sets to None every variable
-        # present in that module.  This means that later calls to functions
-        # defined in the script (which have become interactively visible after
-        # script exit) fail, because they hold references to objects that have
-        # become overwritten into None.  The only solution I see right now is
-        # to protect every FakeModule used by %run by holding an internal
-        # reference to it.  This private list will be used for that.  The
-        # %reset command will flush it as well.
-        self._user_main_modules = []
-
+        # present in that module.  Top-level references to objects from the
+        # script survive, because the user_ns is updated with them.  However,
+        # calling functions defined in the script that use other things from
+        # the script will fail, because the function's closure had references
+        # to the original objects, which are now all None.  So we must protect
+        # these modules from deletion by keeping a cache.  To avoid keeping
+        # stale modules around (we only need the one from the last run), we use
+        # a dict keyed with the full path to the script, so only the last
+        # version of the module is held in the cache.  The %reset command will
+        # flush this cache.  See the cache_main_mod() and clear_main_mod_cache()
+        # methods for details on use.
+        self._user_main_modules = {}
+        
         # List of input with multi-line handling.
         # Fill its zero entry, user counter starts at 1
         self.input_hist = InputList(['\n'])
@@ -601,10 +598,6 @@
         
         #TODO: remove this, redundant
         self.add_builtins()
-
-        
-        
-
     # end __init__
 
     def var_expand(self,cmd,depth=0):
@@ -633,16 +626,15 @@
         """
         rc = self.rc
         try:
-            self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db")            
+            self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db")
         except exceptions.UnicodeDecodeError:
             print "Your ipythondir can't be decoded to unicode!"
             print "Please set HOME environment variable to something that"
             print r"only has ASCII characters, e.g. c:\home"
             print "Now it is",rc.ipythondir
             sys.exit()
-        self.shadowhist = IPython.history.ShadowHist(self.db)            
-            
-    
+        self.shadowhist = IPython.history.ShadowHist(self.db)
+
     def post_config_initialization(self):
         """Post configuration init method
 
@@ -909,7 +901,6 @@
     call_pdb = property(_get_call_pdb,_set_call_pdb,None,
                         'Control auto-activation of pdb at exceptions')
  
-
     # These special functions get installed in the builtin namespace, to
     # provide programmatic (pure python) access to magics, aliases and system
     # calls.  This is important for logging, user scripting, and more.
@@ -1139,7 +1130,8 @@
                 inif = 'ipythonrc.ini'
             else:
                 inif = 'ipythonrc'
-            minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', inif : '# intentionally left blank' }    
+            minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults',
+                             inif : '# intentionally left blank' }
             os.makedirs(ipythondir, mode = 0777)
             for f, cont in minimal_setup.items():
                 open(ipythondir + '/' + f,'w').write(cont)
@@ -1298,7 +1290,6 @@
             finally:
                 readline.read_history_file(self.histfile)
         return wrapper
-                
             
     def pre_readline(self):
         """readline hook to be used at the start of each line.
@@ -1396,7 +1387,59 @@
         if self.rc.quiet:
             return True
         return ask_yes_no(prompt,default)
-    
+
+    def cache_main_mod(self,mod):
+        """Cache a main module.
+
+        When scripts are executed via %run, we must keep a reference to their
+        __main__ module (a FakeModule instance) around so that Python doesn't
+        clear it, rendering objects defined therein useless.
+
+        This method keeps said reference in a private dict, keyed by the
+        absolute path of the module object (which corresponds to the script
+        path).  This way, for multiple executions of the same script we only
+        keep one copy of __main__ (the last one), thus preventing memory leaks
+        from old references while allowing the objects from the last execution
+        to be accessible.
+
+        Parameters
+        ----------
+          mod : a module object
+
+        Examples
+        --------
+
+        In [10]: import IPython
+
+        In [11]: _ip.IP.cache_main_mod(IPython)
+
+        In [12]: IPython.__file__ in _ip.IP._user_main_modules
+        Out[12]: True
+        """
+        self._user_main_modules[os.path.abspath(mod.__file__) ] = mod
+
+    def clear_main_mod_cache(self):
+        """Clear the cache of main modules.
+
+        Mainly for use by utilities like %reset.
+
+        Examples
+        --------
+
+        In [15]: import IPython
+
+        In [16]: _ip.IP.cache_main_mod(IPython)
+
+        In [17]: len(_ip.IP._user_main_modules) > 0
+        Out[17]: True
+
+        In [18]: _ip.IP.clear_main_mod_cache()
+
+        In [19]: len(_ip.IP._user_main_modules) == 0
+        Out[19]: True
+        """
+        self._user_main_modules.clear()
+
     def _should_recompile(self,e):
         """Utility routine for edit_syntax_error"""
 
@@ -1552,8 +1595,6 @@
                         self.set_completer()
         except KeyboardInterrupt:
             self.write("\nKeyboardInterrupt\n")
-            
-        
 
     def mainloop(self,banner=None):
         """Creates the local namespace and starts the mainloop.
@@ -1576,7 +1617,9 @@
             try:
                 self.interact(banner)
                 #self.interact_with_readline()                
-                # XXX for testing of a readline-decoupled repl loop, call interact_with_readline above
+
+                # XXX for testing of a readline-decoupled repl loop, call
+                # interact_with_readline above
 
                 break
             except KeyboardInterrupt:
 
=== modified file 'IPython/ipmaker.py'
--- IPython/ipmaker.py	2008-06-04 08:15:46 +0000
+++ IPython/ipmaker.py	2009-03-11 06:53:19 +0000
@@ -5,8 +5,7 @@
 Requires Python 2.1 or better.
 
 This file contains the main make_IPython() starter function.
-
-$Id: ipmaker.py 2930 2008-01-11 07:03:11Z vivainio $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez. <[e-mail]>
 
=== modified file 'IPython/ipstruct.py'
--- IPython/ipstruct.py	2008-08-02 09:07:37 +0000
+++ IPython/ipstruct.py	2009-03-11 06:53:19 +0000
@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 """Mimic C structs with lots of extra functionality.
-
-$Id: ipstruct.py 1950 2006-11-28 19:15:35Z vivainio $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2004 Fernando Perez <[e-mail]>
@@ -10,10 +9,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-
 __all__ = ['Struct']
 
 import types
@@ -163,8 +158,22 @@
         return self.__dict__[key]
 
     def __contains__(self,key):
-        """Allows use of the 'in' operator."""
-        return self.__dict__.has_key(key)
+        """Allows use of the 'in' operator.
+
+        Examples:
+        >>> s = Struct(x=1)
+        >>> 'x' in s
+        True
+        >>> 'y' in s
+        False
+        >>> s[4] = None
+        >>> 4 in s
+        True
+        >>> s.z = None
+        >>> 'z' in s
+        True
+        """
+        return key in self.__dict__
 
     def __iadd__(self,other):
         """S += S2 is a shorthand for S.merge(S2)."""
@@ -246,12 +255,13 @@
         Optionally, one or more key=value pairs can be given at the end for
         direct update."""
 
-        # The funny name __loc_data__ is to prevent a common variable name which
-        # could be a fieled of a Struct to collide with this parameter. The problem
-        # would arise if the function is called with a keyword with this same name
-        # that a user means to add as a Struct field.
+        # The funny name __loc_data__ is to prevent a common variable name
+        # which could be a fieled of a Struct to collide with this
+        # parameter. The problem would arise if the function is called with a
+        # keyword with this same name that a user means to add as a Struct
+        # field.
         newdict = Struct.__make_dict(self,__loc_data__,**kw)
-        for k,v in newdict.items():
+        for k,v in newdict.iteritems():
             self[k] = v
 
     def merge(self,__loc_data__=None,__conflict_solve=None,**kw):
 
=== modified file 'IPython/kernel/core/ultraTB.py'
--- IPython/kernel/core/ultraTB.py	2008-06-06 19:41:55 +0000
+++ IPython/kernel/core/ultraTB.py	2009-03-11 06:53:19 +0000
@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# -*- coding: utf-8 -*-
 """
 ultraTB.py -- Spice up your tracebacks!
 
@@ -60,26 +59,15 @@
 You can implement other color schemes easily, the syntax is fairly
 self-explanatory. Please send back new schemes you develop to the author for
 possible inclusion in future releases.
-
-$Id: ultraTB.py 2480 2007-07-06 19:33:43Z fperez $"""
-
-__docformat__ = "restructuredtext en"
-
-#-------------------------------------------------------------------------------
-#  Copyright (C) 2008  The IPython Development Team
+"""
+
+#*****************************************************************************
+#       Copyright (C) 2001 Nathaniel Gray <[e-mail]>
+#       Copyright (C) 2001-2004 Fernando Perez <[e-mail]>
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
-#-------------------------------------------------------------------------------
-
-#-------------------------------------------------------------------------------
-# Imports
-#-------------------------------------------------------------------------------
-
-from IPython import Release
-__author__  = '%s <%s>\n%s <%s>' % (Release.authors['Nathan']+
-                                    Release.authors['Fernando'])
-__license__ = Release.license
+#*****************************************************************************
 
 # Required modules
 import inspect
@@ -104,7 +92,7 @@
 # Modified pdb which doesn't damage IPython's readline handling
 from IPython import Debugger, PyColorize
 from IPython.ipstruct import Struct
-from IPython.excolors import ExceptionColors
+from IPython.excolors import exception_colors
 from IPython.genutils import Term,uniq_stable,error,info
 
 # Globals
@@ -141,11 +129,18 @@
     FIXED version with which we monkeypatch the stdlib to work around a bug."""
 
     file = getsourcefile(object) or getfile(object)
-    module = getmodule(object, file)
-    if module:
-        lines = linecache.getlines(file, module.__dict__)
+    # If the object is a frame, then trying to get the globals dict from its
+    # module won't work. Instead, the frame object itself has the globals
+    # dictionary.
+    globals_dict = None
+    if inspect.isframe(object):
+        # XXX: can this ever be false?
+        globals_dict = object.f_globals
     else:
-        lines = linecache.getlines(file)
+        module = getmodule(object, file)
+        if module:
+            globals_dict = module.__dict__
+    lines = linecache.getlines(file, globals_dict)
     if not lines:
         raise IOError('could not get source code')
 
@@ -202,11 +197,31 @@
 if sys.version_info[:2] >= (2,5):
     inspect.findsource = findsource
 
+def fix_frame_records_filenames(records):
+    """Try to fix the filenames in each record from inspect.getinnerframes().
+
+    Particularly, modules loaded from within zip files have useless filenames
+    attached to their code object, and inspect.getinnerframes() just uses it.
+    """
+    fixed_records = []
+    for frame, filename, line_no, func_name, lines, index in records:
+        # Look inside the frame's globals dictionary for __file__, which should
+        # be better.
+        better_fn = frame.f_globals.get('__file__', None)
+        if isinstance(better_fn, str):
+            # Check the type just in case someone did something weird with
+            # __file__. It might also be None if the error occurred during
+            # import.
+            filename = better_fn
+        fixed_records.append((frame, filename, line_no, func_name, lines, index))
+    return fixed_records
+
+
 def _fixed_getinnerframes(etb, context=1,tb_offset=0):
     import linecache
     LNUM_POS, LINES_POS, INDEX_POS =  2, 4, 5
 
-    records  = inspect.getinnerframes(etb, context)
+    records  = fix_frame_records_filenames(inspect.getinnerframes(etb, context))
 
     # If the error is at the console, don't build any context, since it would
     # otherwise produce 5 blank lines printed out (there is no file at the
@@ -299,7 +314,7 @@
         self.call_pdb = call_pdb
 
         # Create color table
-        self.color_scheme_table = ExceptionColors 
+        self.color_scheme_table = exception_colors()
 
         self.set_colors(color_scheme)
         self.old_scheme = color_scheme  # save initial value for toggles
@@ -356,8 +371,8 @@
         
     def __call__(self, etype, value, elist):
         Term.cout.flush()
-        Term.cerr.flush()
         print >> Term.cerr, self.text(etype,value,elist)
+        Term.cerr.flush()
 
     def text(self,etype, value, elist,context=5):
         """Return a color formatted string with the traceback info."""
@@ -424,7 +439,8 @@
         
         Also lifted nearly verbatim from traceback.py
         """
-        
+
+        have_filedata = False
         Colors = self.Colors
         list = []
         try:
@@ -438,8 +454,9 @@
                 try:
                     msg, (filename, lineno, offset, line) = value
                 except:
-                    pass
+                    have_filedata = False
                 else:
+                    have_filedata = True
                     #print 'filename is',filename  # dbg
                     if not filename: filename = "<string>"
                     list.append('%s  File %s"%s"%s, line %s%d%s\n' % \
@@ -469,6 +486,12 @@
                                               Colors.Normal, s))
             else:
                 list.append('%s\n' % str(stype))
+
+        # vds:>>
+        if have_filedata:
+            __IPYTHON__.hooks.synchronize_with_editor(filename, lineno, 0)
+        # vds:<<
+
         return list
 
     def _some_str(self, value):
@@ -780,6 +803,15 @@
             for name in names:
                 value = text_repr(getattr(evalue, name))
                 exception.append('\n%s%s = %s' % (indent, name, value))
+
+        # vds: >>
+        if records:
+             filepath, lnum = records[-1][1:3]
+             #print "file:", str(file), "linenb", str(lnum) # dbg
+             filepath = os.path.abspath(filepath)
+             __IPYTHON__.hooks.synchronize_with_editor(filepath, lnum, 0)
+        # vds: <<
+                
         # return all our info assembled as a single string
         return '%s\n\n%s\n%s' % (head,'\n'.join(frames),''.join(exception[0]) )
 
@@ -834,8 +866,8 @@
         (etype, evalue, etb) = info or sys.exc_info()
         self.tb = etb
         Term.cout.flush()
-        Term.cerr.flush()
         print >> Term.cerr, self.text(etype, evalue, etb)
+        Term.cerr.flush()
 
     # Changed so an instance can just be called as VerboseTB_inst() and print
     # out the right info on its own.
@@ -845,7 +877,10 @@
             self.handler()
         else:
             self.handler((etype, evalue, etb))
-        self.debugger()
+        try:
+            self.debugger()
+        except KeyboardInterrupt:
+            print "\nKeyboardInterrupt"
 
 #----------------------------------------------------------------------------
 class FormattedTB(VerboseTB,ListTB):
@@ -953,14 +988,17 @@
         if out is None:
             out = Term.cerr
         Term.cout.flush()
-        out.flush()
         if tb_offset is not None:
             tb_offset, self.tb_offset = self.tb_offset, tb_offset
             print >> out, self.text(etype, evalue, etb)
             self.tb_offset = tb_offset
         else:
             print >> out, self.text(etype, evalue, etb)
-        self.debugger()
+        out.flush()
+        try:
+            self.debugger()
+        except KeyboardInterrupt:
+            print "\nKeyboardInterrupt"
 
     def text(self,etype=None,value=None,tb=None,context=5,mode=None):
         if etype is None:
 
=== modified file 'IPython/kernel/core/util.py'
--- IPython/kernel/core/util.py	2008-06-06 19:41:55 +0000
+++ IPython/kernel/core/util.py	2009-03-11 01:24:53 +0000
@@ -70,8 +70,8 @@
 def make_quoted_expr(s):
     """Return string s in appropriate quotes, using raw string if possible.
     
-    Effectively this turns string: cd \ao\ao\
-    to: r"cd \ao\ao\_"[:-1]
+    XXX - example removed because it caused encoding errors in documentation
+    generation.  We need a new example that doesn't contain invalid chars.
     
     Note the use of raw string and padding at the end to allow trailing
     backslash.
 
=== modified file 'IPython/kernel/scripts/ipcluster' (properties changed: -x to +x)
=== modified file 'IPython/kernel/scripts/ipcluster.py' (properties changed: -x to +x)
=== modified file 'IPython/kernel/scripts/ipcontroller' (properties changed: -x to +x)
=== modified file 'IPython/kernel/scripts/ipcontroller.py' (properties changed: -x to +x)
=== modified file 'IPython/kernel/scripts/ipengine' (properties changed: -x to +x)
=== modified file 'IPython/kernel/scripts/ipengine.py' (properties changed: -x to +x)
=== modified file 'IPython/macro.py'
--- IPython/macro.py	2008-02-16 09:50:47 +0000
+++ IPython/macro.py	2009-03-11 06:53:19 +0000
@@ -9,7 +9,6 @@
 
 import IPython.ipapi 
 
-
 from IPython.genutils import Term
 from IPython.ipapi import IPyAutocall
 
@@ -41,4 +40,4 @@
     
     def __getstate__(self):
         """ needed for safe pickling via %store """
-        return {'value': self.value}
 \ No newline at end of file
+        return {'value': self.value}
 
=== modified file 'IPython/numutils.py'
--- IPython/numutils.py	2008-02-28 18:21:11 +0000
+++ IPython/numutils.py	2009-03-11 06:53:19 +0000
@@ -4,8 +4,7 @@
 
 Most of this module requires Numerical Python or is meant to be used with it.
 See http://www.pfdubois.com/numpy for details.
-
-$Id: numutils.py 958 2005-12-27 23:17:51Z fperez $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2005 Fernando Perez <[e-mail]>
@@ -14,10 +13,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-
 __all__ = ['sum_flat','mean_flat','rms_flat','base_repr','binary_repr',
            'amin','amax','amap','zeros_like','empty_like',
            'frange','diagonal_matrix','identity',
 
=== modified file 'IPython/platutils.py'
--- IPython/platutils.py	2008-07-06 16:54:20 +0000
+++ IPython/platutils.py	2009-03-11 06:27:38 +0000
@@ -12,10 +12,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Ville']
-__license__ = Release.license
-
 import os
 import sys
 
@@ -35,8 +31,26 @@
 # Functionality that's logically common to all platforms goes here, each
 # platform-specific module only provides the bits that are OS-dependent.
 
-def freeze_term_title():
-    _platutils.ignore_termtitle = True
+# XXX - I'm still not happy with a module global for this, but at least now
+# there is a public, cross-platform way of toggling the term title control on
+# and off.  We should make this a stateful object later on so that each user
+# can have its own instance if needed.
+def toggle_set_term_title(val):
+    """Control whether set_term_title is active or not.
+
+    set_term_title() allows writing to the console titlebar.  In embedded
+    widgets this can cause problems, so this call can be used to toggle it on
+    or off as needed.
+
+    The default state of the module is for the function to be disabled.
+
+    Parameters
+    ----------
+      val : bool
+        If True, set_term_title() actually writes to the terminal (using the
+        appropriate platform-specific module).  If False, it is a no-op.
+    """
+    _platutils.ignore_termtitle = not(val)
 
 
 def set_term_title(title):
@@ -45,3 +59,12 @@
     if _platutils.ignore_termtitle:
         return
     _platutils.set_term_title(title)
+
+
+#-----------------------------------------------------------------------------
+# Deprecated functions
+#-----------------------------------------------------------------------------
+def freeze_term_title():
+    warnings.warn("This function is deprecated, use toggle_set_term_title()")
+    _platutils.ignore_termtitle = True
+
 
=== modified file 'IPython/platutils_posix.py'
--- IPython/platutils_posix.py	2008-07-06 16:54:20 +0000
+++ IPython/platutils_posix.py	2009-03-11 06:27:38 +0000
@@ -12,14 +12,10 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Ville']
-__license__ = Release.license
-
 import sys
 import os
 
-ignore_termtitle = False
+ignore_termtitle = True
 
 def _dummy_op(*a, **b):
     """ A no-op function """
@@ -27,7 +23,7 @@
 def _set_term_title_xterm(title):
     """ Change virtual terminal title in xterm-workalikes """
 
-    sys.stdout.write('\033]%d;%s\007' % (0,title))
+    sys.stdout.write('\033]0;%s\007' % title)
 
 
 if os.environ.get('TERM','') == 'xterm':
 
=== modified file 'IPython/platutils_win32.py'
--- IPython/platutils_win32.py	2008-07-06 16:54:20 +0000
+++ IPython/platutils_win32.py	2009-03-11 06:53:19 +0000
@@ -12,13 +12,9 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Ville']
-__license__ = Release.license
-
 import os
 
-ignore_termtitle = False
+ignore_termtitle = True
 
 try:
     import ctypes
 
=== modified file 'IPython/rlineimpl.py'
--- IPython/rlineimpl.py	2008-02-16 09:50:47 +0000
+++ IPython/rlineimpl.py	2009-03-11 06:53:19 +0000
@@ -5,8 +5,7 @@
 
 In addition to normal readline stuff, this module provides have_readline
 boolean and _outputfile variable used in genutils.
-
-$Id: Magic.py 1096 2006-01-28 20:08:02Z vivainio $"""
+"""
 
 import sys
 
@@ -53,4 +52,4 @@
         _rl.clear_history
     except AttributeError:
         def clear_history(): pass
-        _rl.clear_history = clear_history
 \ No newline at end of file
+        _rl.clear_history = clear_history
 
=== modified file 'IPython/shellglobals.py'
--- IPython/shellglobals.py	2008-03-22 15:03:36 +0000
+++ IPython/shellglobals.py	2009-03-11 06:53:19 +0000
@@ -1,6 +1,13 @@
-from IPython.genutils import Term,warn,error,flag_calls, ask_yes_no
-
-import thread,inspect
+"""Some globals used by the main Shell classes.
+"""
+
+#-----------------------------------------------------------------------------
+# Module imports
+#-----------------------------------------------------------------------------
+
+# stdlib
+import inspect
+import thread
 
 try:
     import ctypes
@@ -8,8 +15,12 @@
 except ImportError:
     HAS_CTYPES = False
 
+# our own
+from IPython.genutils import Term,warn,error,flag_calls, ask_yes_no
 
+#-----------------------------------------------------------------------------
 # Globals
+#-----------------------------------------------------------------------------
 # global flag to pass around information about Ctrl-C without exceptions
 KBINT = False
 
@@ -22,13 +33,11 @@
 # Tag when runcode() is active, for exception handling
 CODE_RUN = None
 
-
 #-----------------------------------------------------------------------------
 # This class is trivial now, but I want to have it in to publish a clean
 # interface. Later when the internals are reorganized, code that uses this
 # shouldn't have to change.
 
-
 if HAS_CTYPES:
     #  Add async exception support.  Trick taken from:
     # http://sebulba.wikispaces.com/recipe+thread2
@@ -81,16 +90,12 @@
         # Set global flag so that runsource can know that Ctrl-C was hit
         KBINT = True
 
+
 def run_in_frontend(src):
-    """ Check if source snippet can be run in the REPL thread, as opposed to GUI mainloop
-    
-    (to prevent unnecessary hanging of mainloop).  
-    
+    """ Check if source snippet can be run in the REPL thread, as opposed to
+    GUI mainloop (to prevent unnecessary hanging of mainloop).
     """
     
     if src.startswith('_ip.system(') and not '\n' in src:
         return True
     return False
-    
-    
-    
 
=== modified file 'IPython/strdispatch.py'
--- IPython/strdispatch.py	2008-07-30 20:08:19 +0000
+++ IPython/strdispatch.py	2009-03-11 06:53:19 +0000
@@ -8,7 +8,6 @@
 from IPython.hooks import CommandChainDispatcher
 import IPython.hooks
 
-
 # Code begins
 class StrDispatch(object):
     """Dispatch (lookup) a set of strings / regexps for match.
 
=== modified file 'IPython/testing/decorators.py'
--- IPython/testing/decorators.py	2008-09-15 02:07:52 +0000
+++ IPython/testing/decorators.py	2009-03-11 01:24:53 +0000
@@ -1,12 +1,10 @@
 """Decorators for labeling test objects.
 
-Decorators that merely return a modified version of the original
-function object are straightforward.  Decorators that return a new
-function object need to use
-nose.tools.make_decorator(original_function)(decorator) in returning
-the decorator, in order to preserve metadata such as function name,
-setup and teardown functions and so on - see nose.tools for more
-information.
+Decorators that merely return a modified version of the original function
+object are straightforward.  Decorators that return a new function object need
+to use nose.tools.make_decorator(original_function)(decorator) in returning the
+decorator, in order to preserve metadata such as function name, setup and
+teardown functions and so on - see nose.tools for more information.
 
 This module provides a set of useful decorators meant to be ready to use in
 your own tests.  See the bottom of the file for the ready-made ones, and if you
@@ -115,6 +113,115 @@
     
     return decor
 
+
+# Inspired by numpy's skipif, but uses the full apply_wrapper utility to
+# preserve function metadata better and allows the skip condition to be a
+# callable.
+def skipif(skip_condition, msg=None):
+    ''' Make function raise SkipTest exception if skip_condition is true
+
+    Parameters
+    ----------
+    skip_condition : bool or callable. 
+ 	Flag to determine whether to skip test.  If the condition is a 
+ 	callable, it is used at runtime to dynamically make the decision.  This 
+ 	is useful for tests that may require costly imports, to delay the cost 
+ 	until the test suite is actually executed.        
+    msg : string
+        Message to give on raising a SkipTest exception
+
+   Returns
+   -------
+   decorator : function
+       Decorator, which, when applied to a function, causes SkipTest
+       to be raised when the skip_condition was True, and the function
+       to be called normally otherwise.
+
+    Notes
+    -----
+    You will see from the code that we had to further decorate the
+    decorator with the nose.tools.make_decorator function in order to
+    transmit function name, and various other metadata.
+    '''
+
+    def skip_decorator(f):
+        # Local import to avoid a hard nose dependency and only incur the 
+        # import time overhead at actual test-time. 
+        import nose
+
+        # Allow for both boolean or callable skip conditions.
+        if callable(skip_condition):
+            skip_val = lambda : skip_condition()
+        else:
+            skip_val = lambda : skip_condition
+
+        def get_msg(func,msg=None):
+            """Skip message with information about function being skipped."""
+            if msg is None: out = 'Test skipped due to test condition.'
+            else: out = msg
+            return "Skipping test: %s. %s" % (func.__name__,out)
+
+        # We need to define *two* skippers because Python doesn't allow both
+        # return with value and yield inside the same function.
+        def skipper_func(*args, **kwargs):
+            """Skipper for normal test functions."""
+            if skip_val():
+                raise nose.SkipTest(get_msg(f,msg))
+            else:
+                return f(*args, **kwargs) 
+
+        def skipper_gen(*args, **kwargs):
+            """Skipper for test generators."""
+            if skip_val():
+                raise nose.SkipTest(get_msg(f,msg))
+            else:
+                for x in f(*args, **kwargs):
+                    yield x
+
+        # Choose the right skipper to use when building the actual generator.
+        if nose.util.isgenerator(f):
+            skipper = skipper_gen
+        else:
+            skipper = skipper_func
+            
+        return nose.tools.make_decorator(f)(skipper)
+
+    return skip_decorator
+
+# A version with the condition set to true, common case just to attacha message
+# to a skip decorator
+def skip(msg=None):
+    """Decorator factory - mark a test function for skipping from test suite.
+
+    :Parameters:
+      msg : string
+        Optional message to be added.
+
+    :Returns:
+       decorator : function
+         Decorator, which, when applied to a function, causes SkipTest
+         to be raised, with the optional message added.
+      """
+
+    return skipif(True,msg)
+
+
+#-----------------------------------------------------------------------------
+# Utility functions for decorators
+def numpy_not_available():
+    """Can numpy be imported?  Returns true if numpy does NOT import.
+
+    This is used to make a decorator to skip tests that require numpy to be
+    available, but delay the 'import numpy' to test execution time.
+    """
+    try:
+        import numpy
+        np_not_avail = False
+    except ImportError:
+        np_not_avail = True
+
+    return np_not_avail
+
 #-----------------------------------------------------------------------------
 # Decorators for public use
 
@@ -125,36 +232,13 @@
     omit from testing, while preserving the docstring for introspection, help,
     etc.""")                              
 
-def skip(msg=''):
-    """Decorator - mark a test function for skipping from test suite.
-
-    This function *is* already a decorator, it is not a factory like
-    make_label_dec or some of those in decorators_numpy.
-
-    :Parameters:
-
-      func : function
-        Test function to be skipped
-
-      msg : string
-        Optional message to be added.
-      """
-
-    import nose
-
-    def inner(func):
-
-        def wrapper(*a,**k):
-            if msg: out = '\n'+msg
-            else: out = ''
-            raise nose.SkipTest("Skipping test for function: %s%s" %
-                                (func.__name__,out))
-
-        return apply_wrapper(wrapper,func)
-
-    return inner
-
 # Decorators to skip certain tests on specific platforms.
-skip_win32 = skipif(sys.platform=='win32',"This test does not run under Windows")
+skip_win32 = skipif(sys.platform=='win32',
+                    "This test does not run under Windows")
 skip_linux = skipif(sys.platform=='linux2',"This test does not run under Linux")
-skip_osx = skipif(sys.platform=='darwin',"This test does not run under OSX")
+skip_osx = skipif(sys.platform=='darwin',"This test does not run under OS X")
+
+
+skipif_not_numpy = skipif(numpy_not_available,"This test requires numpy")
+
+skipknownfailure = skip('This test is known to fail')
 
=== modified file 'IPython/testing/decorators_numpy.py'
--- IPython/testing/decorators_numpy.py	2008-08-02 09:07:37 +0000
+++ IPython/testing/decorators_numpy.py	2009-03-11 01:24:53 +0000
@@ -46,13 +46,16 @@
         return t
     return set_test
 
-def skipif(skip_condition, msg=None):
+def skipif(skip_condition=True, msg=None):
     ''' Make function raise SkipTest exception if skip_condition is true
 
     Parameters
-    ---------
-    skip_condition : bool
-        Flag to determine whether to skip test (True) or not (False)
+    ----------
+    skip_condition : bool or callable. 
+ 	Flag to determine whether to skip test.  If the condition is a 
+ 	callable, it is used at runtime to dynamically make the decision.  This 
+ 	is useful for tests that may require costly imports, to delay the cost 
+ 	until the test suite is actually executed.        
     msg : string
         Message to give on raising a SkipTest exception
 
 
=== modified file 'IPython/testing/iptest.py'
--- IPython/testing/iptest.py	2008-08-24 06:37:40 +0000
+++ IPython/testing/iptest.py	2009-03-11 05:49:08 +0000
@@ -1,16 +1,53 @@
-#!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """IPython Test Suite Runner.
+
+This module provides a main entry point to a user script to test IPython itself
+from the command line.  The main() routine can be used in a similar manner to
+the ``nosetests`` script, and it takes similar arguments, but if no arguments
+are given it defaults to testing all of IPython.  This should be preferred to
+using plain ``nosetests`` because a number of nose plugins necessary to test
+IPython correctly are automatically configured by this code.
 """
 
+#-----------------------------------------------------------------------------
+# Module imports
+#-----------------------------------------------------------------------------
+
+# stdlib
 import sys
 import warnings
 
+# third-party
+import nose.plugins.builtin
 from nose.core import TestProgram
-import nose.plugins.builtin
 
+# Our own imports
 from IPython.testing.plugin.ipdoctest import IPythonDoctest
 
+#-----------------------------------------------------------------------------
+# Constants and globals
+#-----------------------------------------------------------------------------
+
+# For the IPythonDoctest plugin, we need to exclude certain patterns that cause
+# testing problems.  We should strive to minimize the number of skipped
+# modules, since this means untested code.  As the testing machinery
+# solidifies, this list should eventually become empty.
+EXCLUDE = ['IPython/external/',
+           'IPython/platutils_win32',
+           'IPython/frontend/cocoa',
+           'IPython_doctest_plugin',
+           'IPython/Gnuplot',
+           'IPython/Extensions/ipy_',
+           'IPython/Extensions/clearcmd',
+           'IPython/Extensions/PhysicalQIn',
+           'IPython/Extensions/scitedirector',
+           'IPython/testing/plugin',
+           ]
+
+#-----------------------------------------------------------------------------
+# Functions and classes
+#-----------------------------------------------------------------------------
+
 def main():
     """Run the IPython test suite.
     """
@@ -18,36 +55,39 @@
     warnings.filterwarnings('ignore', 
         'This will be removed soon.  Use IPython.testing.util instead')
 
-    
-    # construct list of plugins, omitting the existing doctest plugin
-    plugins = [IPythonDoctest()]
+    argv = sys.argv + [ '--with-ipdoctest',
+                        '--doctest-tests','--doctest-extension=txt',
+                        '--detailed-errors',
+                       
+                        # We add --exe because of setuptools' imbecility (it
+                        # blindly does chmod +x on ALL files).  Nose does the
+                        # right thing and it tries to avoid executables,
+                        # setuptools unfortunately forces our hand here.  This
+                        # has been discussed on the distutils list and the
+                        # setuptools devs refuse to fix this problem!
+                        '--exe',
+                        ]
+
+    # Detect if any tests were required by explicitly calling an IPython
+    # submodule or giving a specific path
+    has_tests = False
+    for arg in sys.argv:
+        if 'IPython' in arg or arg.endswith('.py') or \
+           (':' in arg and  '.py' in arg):
+            has_tests = True
+            break
+    # If nothing was specifically requested, test full IPython
+    if not has_tests:
+        argv.append('IPython')
+
+    # Construct list of plugins, omitting the existing doctest plugin.
+    plugins = [IPythonDoctest(EXCLUDE)]
     for p in nose.plugins.builtin.plugins:
         plug = p()
         if plug.name == 'doctest':
             continue
 
-        #print 'adding plugin:',plug.name  # dbg
+        #print '*** adding plugin:',plug.name  # dbg
         plugins.append(plug)
 
-    argv = sys.argv + ['--doctest-tests','--doctest-extension=txt',
-                       '--detailed-errors',
-                       
-                       # We add --exe because of setuptools' imbecility (it
-                       # blindly does chmod +x on ALL files).  Nose does the
-                       # right thing and it tries to avoid executables,
-                       # setuptools unfortunately forces our hand here.  This
-                       # has been discussed on the distutils list and the
-                       # setuptools devs refuse to fix this problem!
-                       '--exe',
-                       ]
-
-    has_ip = False
-    for arg in sys.argv:
-        if 'IPython' in arg:
-            has_ip = True
-            break
-
-    if not has_ip:
-        argv.append('IPython')
-
     TestProgram(argv=argv,plugins=plugins)
 
=== modified file 'IPython/testing/plugin/Makefile'
--- IPython/testing/plugin/Makefile	2008-09-03 15:54:03 +0000
+++ IPython/testing/plugin/Makefile	2008-11-09 05:54:34 +0000
@@ -36,8 +36,8 @@
 magic: plugin
 	$(NOSE) IPython.Magic
 
-ipipe: plugin
-	$(NOSE) IPython.Extensions.ipipe
+excolors: plugin
+	$(NOSE) IPython.excolors
 
 iplib: plugin
 	$(NOSE)  IPython.iplib
 
=== modified file 'IPython/testing/plugin/ipdoctest.py'
--- IPython/testing/plugin/ipdoctest.py	2008-08-24 06:10:55 +0000
+++ IPython/testing/plugin/ipdoctest.py	2009-03-11 05:49:08 +0000
@@ -65,13 +65,28 @@
 # test globals.  Once we move over to a clean magic system, this will be done
 # with much less ugliness.
 
+class py_file_finder(object):
+    def __init__(self,test_filename):
+        self.test_filename = test_filename
+        
+    def __call__(self,name):
+        from IPython.genutils import get_py_filename
+        try:
+            get_py_filename(name)
+        except IOError:
+            test_dir = os.path.dirname(self.test_filename)
+            new_path = os.path.join(test_dir,name)
+            return get_py_filename(new_path)
+    
+
 def _run_ns_sync(self,arg_s,runner=None):
     """Modified version of %run that syncs testing namespaces.
 
     This is strictly needed for running doctests that call %run.
     """
 
-    out = _ip.IP.magic_run_ori(arg_s,runner)
+    finder = py_file_finder(_run_ns_sync.test_filename)
+    out = _ip.IP.magic_run_ori(arg_s,runner,finder)
     _run_ns_sync.test_globs.update(_ip.user_ns)
     return out
 
@@ -129,8 +144,7 @@
 
     # Start IPython instance.  We customize it to start with minimal frills.
     user_ns,global_ns = IPython.ipapi.make_user_namespaces(ipnsdict(),dict())
-    
-    IPython.Shell.IPShell(['--classic','--noterm_title'],
+    IPython.Shell.IPShell(['--colors=NoColor','--noterm_title'],
                           user_ns,global_ns)
 
     # Deactivate the various python system hooks added by ipython for
@@ -172,13 +186,19 @@
     return os.path.splitext(filename)[1].lower() in ('.so','.pyd')
 
 
-class nodoc(object):
+class DocTestSkip(object):
+    """Object wrapper for doctests to be skipped."""
+    
+    ds_skip = """Doctest to skip.
+    >>> 1 #doctest: +SKIP
+    """
+
     def __init__(self,obj):
         self.obj = obj
 
     def __getattribute__(self,key):
         if key == '__doc__':
-            return None
+            return DocTestSkip.ds_skip
         else:
             return getattr(object.__getattribute__(self,'obj'),key)
 
@@ -222,7 +242,7 @@
 
         if hasattr(obj,"skip_doctest"):
             #print 'SKIPPING DOCTEST FOR:',obj  # dbg
-            obj = nodoc(obj)
+            obj = DocTestSkip(obj)
 
         doctest.DocTestFinder._find(self,tests, obj, name, module,
                                     source_lines, globs, seen)
@@ -638,7 +658,8 @@
         # when called (rather than unconconditionally updating test.globs here
         # for all examples, most of which won't be calling %run anyway).
         _run_ns_sync.test_globs = test.globs
-
+        _run_ns_sync.test_filename = test.filename
+        
         return super(IPDocTestRunner,self).run(test,
                                                compileflags,out,clear_globs)
 
@@ -656,6 +677,22 @@
     name = 'extdoctest'   # call nosetests with --with-extdoctest
     enabled = True
 
+    def __init__(self,exclude_patterns=None):
+        """Create a new ExtensionDoctest plugin.
+
+        Parameters
+        ----------
+
+        exclude_patterns : sequence of strings, optional
+          These patterns are compiled as regular expressions, subsequently used
+          to exclude any filename which matches them from inclusion in the test
+          suite (using pattern.search(), NOT pattern.match() ).
+        """
+        if exclude_patterns is None:
+            exclude_patterns = []
+        self.exclude_patterns = map(re.compile,exclude_patterns)
+        doctests.Doctest.__init__(self)
+
     def options(self, parser, env=os.environ):
         Plugin.options(self, parser, env)
         parser.add_option('--doctest-tests', action='store_true',
@@ -688,6 +725,7 @@
         self.globs = None
         self.extraglobs = None
 
+
     def loadTestsFromExtensionModule(self,filename):
         bpath,mod = os.path.split(filename)
         modname = os.path.splitext(mod)[0]
@@ -703,8 +741,8 @@
     # a  few modifications to control output checking.
 
     def loadTestsFromModule(self, module):
-        #print 'lTM',module  # dbg
-
+        #print '*** ipdoctest - lTM',module  # dbg
+        
         if not self.matches(module.__name__):
             log.debug("Doctest doesn't want module %s", module)
             return
@@ -733,8 +771,6 @@
 
 
     def loadTestsFromFile(self, filename):
-        #print 'lTF',filename  # dbg
-
         if is_extension_module(filename):
             for t in self.loadTestsFromExtensionModule(filename):
                 yield t
@@ -761,22 +797,10 @@
         Modified version that accepts extension modules as valid containers for
         doctests.
         """
-        print 'Filename:',filename  # dbg
-
-        # XXX - temporarily hardcoded list, will move to driver later
-        exclude = ['IPython/external/',
-                   'IPython/platutils_win32',
-                   'IPython/frontend/cocoa',
-                   'IPython_doctest_plugin',
-                   'IPython/Gnuplot',
-                   'IPython/Extensions/ipy_',
-                   'IPython/Extensions/PhysicalQIn',
-                   'IPython/Extensions/scitedirector',
-                   'IPython/testing/plugin',
-                   ]
-
-        for fex in exclude:
-            if fex in filename:  # substring
+        #print '*** ipdoctest- wantFile:',filename  # dbg
+
+        for pat in self.exclude_patterns:
+            if pat.search(filename):
                 #print '###>>> SKIP:',filename  # dbg
                 return False
 
@@ -791,6 +815,23 @@
     """
     name = 'ipdoctest'   # call nosetests with --with-ipdoctest
     enabled = True
+    
+    def makeTest(self, obj, parent):
+        """Look for doctests in the given object, which will be a
+        function, method or class.
+        """
+        # always use whitespace and ellipsis options
+        optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS
+
+        doctests = self.finder.find(obj, module=getmodule(parent))
+        if doctests:
+            for test in doctests:
+                if len(test.examples) == 0:
+                    continue
+
+                yield DocTestCase(test, obj=obj,
+                                  optionflags=optionflags,
+                                  checker=self.checker)
 
     def configure(self, options, config):
 
 
=== added file 'IPython/tests/tclass.py'
--- IPython/tests/tclass.py	1970-01-01 00:00:00 +0000
+++ IPython/tests/tclass.py	2009-03-13 17:56:19 +0000
@@ -0,0 +1,26 @@
+"""Simple script to instantiate a class for testing %run"""
+
+import sys
+
+# An external test will check that calls to f() work after %run
+class foo: pass
+
+def f():
+    return foo()
+
+# We also want to ensure that while objects remain available for immediate
+# access, objects from *previous* runs of the same script get collected, to
+# avoid accumulating massive amounts of old references.
+class C(object):
+    def __init__(self,name):
+        self.name = name
+        
+    def __del__(self):
+        print 'Deleting object:',self.name
+
+try:
+    name = sys.argv[1]
+except IndexError:
+    pass
+else:
+    c = C(name)
 
=== modified file 'IPython/tests/test_magic.py'
--- IPython/tests/test_magic.py	2008-09-17 19:01:11 +0000
+++ IPython/tests/test_magic.py	2009-03-13 17:56:19 +0000
@@ -1,8 +1,21 @@
-""" Tests for various magic functions
-
-Needs to be run by nose (to make ipython session available)
-
+"""Tests for various magic functions.
+
+Needs to be run by nose (to make ipython session available).
 """
+
+# Standard library imports
+import os
+import sys
+
+# Third-party imports
+import nose.tools as nt
+
+# From our own code
+from IPython.testing import decorators as dec
+
+#-----------------------------------------------------------------------------
+# Test functions begin
+
 def test_rehashx():
     # clear up everything
     _ip.IP.alias_table.clear()
@@ -19,3 +32,96 @@
     # rehashx must fill up syscmdlist
     scoms = _ip.db['syscmdlist']
     assert len(scoms) > 10
+
+
+def doctest_run_ns():
+    """Classes declared %run scripts must be instantiable afterwards.
+
+    In [11]: run tclass
+
+    In [12]: isinstance(f(),foo)
+    Out[12]: True
+    """
+
+    
+def doctest_run_ns2():
+    """Classes declared %run scripts must be instantiable afterwards.
+
+    In [3]: run tclass.py
+
+    In [4]: run tclass first_pass
+
+    In [5]: run tclass second_pass
+    Deleting object: first_pass
+    """
+
+
+def doctest_hist_f():
+    """Test %hist -f with temporary filename.
+
+    In [9]: import tempfile
+
+    In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-')
+
+    In [11]: %history -n -f $tfile 3
+    """
+
+
+def doctest_hist_r():
+    """Test %hist -r
+
+    XXX - This test is not recording the output correctly.  Not sure why...
+
+    In [6]: x=1
+
+    In [7]: hist -n -r 2
+    x=1  # random
+    hist -n -r 2  # random
+    """
+
+
+def test_shist():
+    # Simple tests of ShadowHist class - test generator.
+    import os, shutil, tempfile
+
+    from IPython.Extensions import pickleshare
+    from IPython.history import ShadowHist
+    
+    tfile = tempfile.mktemp('','tmp-ipython-')
+    
+    db = pickleshare.PickleShareDB(tfile)
+    s = ShadowHist(db)
+    s.add('hello')
+    s.add('world')
+    s.add('hello')
+    s.add('hello')
+    s.add('karhu')
+
+    yield nt.assert_equals,s.all(),[(1, 'hello'), (2, 'world'), (3, 'karhu')]
+    
+    yield nt.assert_equal,s.get(2),'world'
+    
+    shutil.rmtree(tfile)
+    
[e-mail]_not_numpy
+def test_numpy_clear_array_undec():
+    _ip.ex('import numpy as np')
+    _ip.ex('a = np.empty(2)')
+    
+    yield nt.assert_true,'a' in _ip.user_ns
+    _ip.magic('clear array')
+    yield nt.assert_false,'a' in _ip.user_ns
+    
+
[e-mail]()
+def test_fail_dec(*a,**k):
+    yield nt.assert_true, False
+
[e-mail]('This one shouldn not run')
+def test_fail_dec2(*a,**k):
+    yield nt.assert_true, False
+
[e-mail]
+def test_fail_dec3(*a,**k):
+    yield nt.assert_true, False
+
 
=== modified file 'IPython/twshell.py'
--- IPython/twshell.py	2008-04-26 07:17:18 +0000
+++ IPython/twshell.py	2009-03-11 06:53:19 +0000
@@ -1,3 +1,7 @@
+"""Twisted shell support.
+
+XXX - This module is missing proper docs.
+"""
 import sys
 
 from twisted.internet import reactor, threads
 
=== modified file 'IPython/ultraTB.py'
--- IPython/ultraTB.py	2008-08-24 06:10:55 +0000
+++ IPython/ultraTB.py	2009-03-11 06:53:19 +0000
@@ -59,8 +59,7 @@
 You can implement other color schemes easily, the syntax is fairly
 self-explanatory. Please send back new schemes you develop to the author for
 possible inclusion in future releases.
-
-$Id: ultraTB.py 2908 2007-12-30 21:07:46Z vivainio $"""
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2001 Nathaniel Gray <[e-mail]>
@@ -70,11 +69,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>\n%s <%s>' % (Release.authors['Nathan']+
-                                    Release.authors['Fernando'])
-__license__ = Release.license
-
 # Required modules
 import inspect
 import keyword
@@ -98,7 +92,7 @@
 # Modified pdb which doesn't damage IPython's readline handling
 from IPython import Debugger, PyColorize
 from IPython.ipstruct import Struct
-from IPython.excolors import ExceptionColors
+from IPython.excolors import exception_colors
 from IPython.genutils import Term,uniq_stable,error,info
 
 # Globals
@@ -320,7 +314,7 @@
         self.call_pdb = call_pdb
 
         # Create color table
-        self.color_scheme_table = ExceptionColors 
+        self.color_scheme_table = exception_colors()
 
         self.set_colors(color_scheme)
         self.old_scheme = color_scheme  # save initial value for toggles
 
=== modified file 'IPython/usage.py'
--- IPython/usage.py	2008-02-28 18:21:11 +0000
+++ IPython/usage.py	2009-03-11 06:53:19 +0000
@@ -6,13 +6,6 @@
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-# $Id: usage.py 2723 2007-09-07 07:44:16Z fperez $
-
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Fernando']
-__license__ = Release.license
-__version__ = Release.version
-
 __doc__ = """
 IPython -- An enhanced Interactive Python
 =========================================
@@ -650,5 +643,3 @@
 The following magic functions are currently available:
 
 """
-
-
 
=== modified file 'IPython/wildcard.py'
--- IPython/wildcard.py	2008-02-16 09:50:47 +0000
+++ IPython/wildcard.py	2009-03-11 06:53:19 +0000
@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 """Support for wildcard pattern matching in object inspection.
-
-$Id: OInspect.py 608 2005-07-06 17:52:32Z fperez $
 """
 
 #*****************************************************************************
 
=== modified file 'docs/Makefile'
--- docs/Makefile	2008-08-28 23:34:53 +0000
+++ docs/Makefile	2009-03-11 01:24:53 +0000
@@ -5,13 +5,14 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
+SRCDIR        = source
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
 
-.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
+.PHONY: help clean html web pickle htmlhelp latex changes linkcheck api
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
@@ -28,7 +29,7 @@
 	@echo "dist         all, and then puts the results in dist/"
 
 clean:
-	-rm -rf build/* dist/*
+	-rm -rf build/* dist/* $(SRCDIR)/api/generated
 
 pdf: latex
 	cd build/latex && make all-pdf
@@ -41,12 +42,16 @@
 	cp -al build/html dist/
 	@echo "Build finished.  Final docs are in dist/"
 
-html:
+html: api
 	mkdir -p build/html build/doctrees
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
 	@echo
 	@echo "Build finished. The HTML pages are in build/html."
 
+api:
+	python autogen_api.py
+	@echo "Build API docs finished."
+
 pickle:
 	mkdir -p build/pickle build/doctrees
 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
 
=== added file 'docs/autogen_api.py'
--- docs/autogen_api.py	1970-01-01 00:00:00 +0000
+++ docs/autogen_api.py	2009-03-11 01:24:53 +0000
@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+"""Script to auto-generate our API docs.
+"""
+# stdlib imports
+import os
+import sys
+
+# local imports
+sys.path.append(os.path.abspath('sphinxext'))
+from apigen import ApiDocWriter
+
+#*****************************************************************************
+if __name__ == '__main__':
+    pjoin = os.path.join
+    package = 'IPython'
+    outdir = pjoin('source','api','generated')
+    docwriter = ApiDocWriter(package,rst_extension='.txt')
+    docwriter.package_skip_patterns += [r'\.fixes$',
+                                        r'\.externals$',
+                                        r'\.Extensions',
+                                        r'\.kernel.config',
+                                        r'\.attic',
+                                        ]
+    docwriter.module_skip_patterns += [ r'\.FakeModule',
+                                        r'\.cocoa',
+                                        r'\.ipdoctest',
+                                        r'\.Gnuplot',
+                                        ]
+    docwriter.write_api_docs(outdir)
+    docwriter.write_index(outdir, 'gen',
+                          relative_to = pjoin('source','api')
+                          )
+    print '%d files written' % len(docwriter.written_modules)
 
=== added directory 'docs/source/api'
=== added file 'docs/source/api/index.txt'
--- docs/source/api/index.txt	1970-01-01 00:00:00 +0000
+++ docs/source/api/index.txt	2009-03-11 01:24:53 +0000
@@ -0,0 +1,12 @@
+.. _api-index:
+
+###################
+  The IPython API
+###################
+
+.. htmlonly::
+
+   :Release: |version|
+   :Date: |today|
+
+.. include:: generated/gen.txt
 
=== modified file 'docs/source/conf.py'
--- docs/source/conf.py	2008-09-14 07:58:49 +0000
+++ docs/source/conf.py	2009-03-11 01:24:53 +0000
@@ -36,9 +36,13 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc',
-              'inheritance_diagram', 'only_directives',
+              'sphinx.ext.doctest',
+              
+              'only_directives',
+              'inheritance_diagram',
               'ipython_console_highlighting', 
               # 'plot_directive', # disabled for now, needs matplotlib
+              'numpydoc',  # to preprocess docstrings
               ]
 
 # Add any paths that contain templates here, relative to this directory.
 
=== added file 'docs/source/development/coding_guide.txt'
--- docs/source/development/coding_guide.txt	1970-01-01 00:00:00 +0000
+++ docs/source/development/coding_guide.txt	2008-10-04 07:47:34 +0000
@@ -0,0 +1,141 @@
+==============
+ Coding guide
+==============
+
+
+Coding conventions
+==================
+
+In general, we'll try to follow the standard Python style conventions as
+described in Python's `PEP 8`_, the official Python Style Guide.
+
+.. _PEP 8: http://www.python.org/peps/pep-0008.html
+
+Other comments:
+
+- In a large file, top level classes and functions should be separated by 2-3
+  lines to make it easier to separate them visually.
+
+- Use 4 spaces for indentation, *never* use hard tabs.
+
+- Keep the ordering of methods the same in classes that have the same methods.
+  This is particularly true for classes that implement similar interfaces and
+  for interfaces that are similar.
+
+Naming conventions
+------------------
+
+In terms of naming conventions, we'll follow the guidelines of PEP 8.  Some of
+the existing code doesn't honor this perfectly, but for all new IPython code
+(and much existing code is being refactored), we'll use:
+
+- All ``lowercase`` module names.
+
+- ``CamelCase`` for class names.
+
+- ``lowercase_with_underscores`` for methods, functions, variables and
+  attributes.
+
+This may be confusing as some of the existing codebase uses a different
+convention (``lowerCamelCase`` for methods and attributes).  Slowly, we will
+move IPython over to the new convention, providing shadow names for backward
+compatibility in public interfaces.
+
+There are, however, some important exceptions to these rules.  In some cases,
+IPython code will interface with packages (Twisted, Wx, Qt) that use other
+conventions.  At some level this makes it impossible to adhere to our own
+standards at all times.  In particular, when subclassing classes that use other
+naming conventions, you must follow their naming conventions.  To deal with
+cases like this, we propose the following policy:
+
+- If you are subclassing a class that uses different conventions, use its
+  naming conventions throughout your subclass.  Thus, if you are creating a
+  Twisted Protocol class, used Twisted's
+  ``namingSchemeForMethodsAndAttributes.``
+
+- All IPython's official interfaces should use our conventions.  In some cases
+  this will mean that you need to provide shadow names (first implement
+  ``fooBar`` and then ``foo_bar = fooBar``).  We want to avoid this at all
+  costs, but it will probably be necessary at times.  But, please use this
+  sparingly!
+
+Implementation-specific *private* methods will use
+``_single_underscore_prefix``.  Names with a leading double underscore will
+*only* be used in special cases, as they makes subclassing difficult (such
+names are not easily seen by child classes).
+
+Occasionally some run-in lowercase names are used, but mostly for very short
+names or where we are implementing methods very similar to existing ones in a
+base class (like ``runlines()`` where ``runsource()`` and ``runcode()`` had
+established precedent).
+
+The old IPython codebase has a big mix of classes and modules prefixed with an
+explicit ``IP``. In Python this is mostly unnecessary, redundant and frowned
+upon, as namespaces offer cleaner prefixing. The only case where this approach
+is justified is for classes which are expected to be imported into external
+namespaces and a very generic name (like Shell) is too likely to clash with
+something else.  We'll need to revisit this issue as we clean up and refactor
+the code, but in general we should remove as many unnecessary ``IP``/``ip``
+prefixes as possible. However, if a prefix seems absolutely necessary the more
+specific ``IPY`` or ``ipy`` are preferred.
+
+
+.. _devel-testing:
+
+Testing system
+==============
+
+It is extremely important that all code contributed to IPython has tests. Tests
+should be written as unittests, doctests or as entities that the `Nose`_
+testing package will find. Regardless of how the tests are written, we will use
+`Nose`_ for discovering and running the tests. `Nose`_ will be required to run
+the IPython test suite, but will not be required to simply use IPython.
+
+.. _Nose: http://code.google.com/p/python-nose/
+
+Tests of `Twisted`__ using code should be written by subclassing the
+``TestCase`` class that comes with ``twisted.trial.unittest``. When this is
+done, `Nose`_ will be able to run the tests and the twisted reactor will be
+handled correctly.
+
+.. __: http://www.twistedmatrix.com
+
+Each subpackage in IPython should have its own ``tests`` directory that
+contains all of the tests for that subpackage. This allows each subpackage to
+be self-contained. If a subpackage has any dependencies beyond the Python
+standard library, the tests for that subpackage should be skipped if the
+dependencies are not found. This is very important so users don't get tests
+failing simply because they don't have dependencies.
+
+We also need to look into use Noses ability to tag tests to allow a more
+modular approach of running tests.
+
+.. _devel-config:
+
+Configuration system
+====================
+
+IPython uses `.ini`_ files for configuration purposes. This represents a huge
+improvement over the configuration system used in IPython. IPython works with
+these files using the `ConfigObj`_ package, which IPython includes as
+``ipython1/external/configobj.py``.
+
+Currently, we are using raw `ConfigObj`_ objects themselves. Each subpackage of
+IPython should contain a ``config`` subdirectory that contains all of the
+configuration information for the subpackage. To see how configuration
+information is defined (along with defaults) see at the examples in
+``ipython1/kernel/config`` and ``ipython1/core/config``. Likewise, to see how
+the configuration information is used, see examples in
+``ipython1/kernel/scripts/ipengine.py``.
+
+Eventually, we will add a new layer on top of the raw `ConfigObj`_ objects. We
+are calling this new layer, ``tconfig``, as it will use a `Traits`_-like
+validation model.  We won't actually use `Traits`_, but will implement
+something similar in pure Python.  But, even in this new system, we will still
+use `ConfigObj`_ and `.ini`_ files underneath the hood. Talk to Fernando if you
+are interested in working on this part of IPython. The current prototype of
+``tconfig`` is located in the IPython sandbox.
+
+.. _.ini: http://docs.python.org/lib/module-ConfigParser.html
+.. _ConfigObj: http://www.voidspace.org.uk/python/configobj.html
+.. _Traits: http://code.enthought.com/traits/
 
=== added file 'docs/source/development/doc_guide.txt'
--- docs/source/development/doc_guide.txt	1970-01-01 00:00:00 +0000
+++ docs/source/development/doc_guide.txt	2009-03-11 06:58:43 +0000
@@ -0,0 +1,103 @@
+.. _documenting-ipython:
+
+=====================
+ Documenting IPython
+=====================
+
+Standalone documentation
+========================
+
+All standalone documentation should be written in plain text (``.txt``) files
+using `reStructuredText`_ for markup and formatting. All such documentation
+should be placed in the top level directory ``docs`` of the IPython source
+tree. Or, when appropriate, a suitably named subdirectory should be used. The
+documentation in this location will serve as the main source for IPython
+documentation and all existing documentation should be converted to this
+format.
+
+The actual HTML and PDF docs are built using the Sphinx_ documentation
+generation tool.  Sphinx has been adopted as the default documentation tool for
+Python itself as of version 2.6, as well as by a number of projects that
+IPython is related with, such as numpy, scipy, matplotlib, sage and nipy.
+
+.. _reStructuredText: http://docutils.sourceforge.net/rst.html
+.. _Sphinx: http://sphinx.pocoo.org/
+
+
+The rest of this document is mostly taken from the `matploblib
+documentation`__; we are using a number of Sphinx tools and extensions written
+by the matplotlib team and will mostly follow their conventions, which are
+nicely spelled out in their guide.  What follows is thus a lightly adapted
+version of the matplotlib documentation guide, taken with permission from the
+MPL team.
+
+.. __: http://matplotlib.sourceforge.net/devel/documenting_mpl.html
+
+
+A bit of Python code::
+
+    for i in range(10):
+        print i,
+    print "A big number:",2**34
+
+An interactive Python session::
+
+    >>> from IPython import genutils
+    >>> genutils.get_ipython_dir()
+    '/home/fperez/.ipython'
+
+
+An IPython session:
+
+.. code-block:: ipython
+
+  In [7]: import IPython
+
+  In [8]: print "This IPython is version:",IPython.__version__
+  This IPython is version: 0.9.1
+
+  In [9]: 2+4
+  Out[9]: 6
+
+
+A bit of shell code:
+
+.. code-block:: bash
+
+    cd /tmp
+    echo "My home directory is: $HOME"
+    ls
+
+  
+Docstring format
+================
+
+Good docstrings are very important.  Unfortunately, Python itself only provides
+a rather loose standard for docstrings (`PEP 257`_), and there is no universally
+accepted convention for all the different parts of a complete docstring.
+However, the NumPy project has established a very reasonable standard, and has
+developed some tools to support the smooth inclusion of such docstrings in
+Sphinx-generated manuals.  Rather than inventing yet another pseudo-standard,
+IPython will be henceforth documented using the NumPy conventions; we carry
+copies of some of the NumPy support tools to remain self-contained, but share
+back upstream with NumPy any improvements or fixes we may make to the tools.
+
+The `NumPy documentation guidelines`_ contain detailed information on this
+standard, and for a quick overview, the NumPy `example docstring`_ is a useful
+read. 
+
+As in the past IPython used epydoc, currently many docstrings still use epydoc
+conventions.  We will update them as we go, but all new code should be fully
+documented using the NumPy standard.
+
+.. _PEP 257: http://www.python.org/peps/pep-0257.html
+.. _NumPy documentation guidelines: http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
+
+.. _example docstring: http://projects.scipy.org/numpy/browser/trunk/doc/EXAMPLE_DOCSTRING.txt
+
+Additional PEPs of interest regarding documentation of code.  While both of
+these were rejected, the ideas therein form much of the basis of docutils (the
+machinery to process reStructuredText):
+
+- `Docstring Processing System Framework <http://www.python.org/peps/pep-0256.html>`_
+- `Docutils Design Specification <http://www.python.org/peps/pep-0258.html>`_
 
=== modified file 'docs/source/development/index.txt'
--- docs/source/development/index.txt	2008-09-11 23:58:46 +0000
+++ docs/source/development/index.txt	2008-10-04 07:47:34 +0000
@@ -1,10 +1,13 @@
-==================
-Development
-==================
+===========================
+ IPython Developer's Guide
+===========================
 
 .. toctree::
    :maxdepth: 2
 
-   development.txt
+   overview.txt
+   coding_guide.txt
+   doc_guide.txt
    roadmap.txt
+
    notification_blueprint.txt
 
=== renamed file 'docs/source/development/development.txt' => 'docs/source/development/overview.txt'
--- docs/source/development/development.txt	2008-09-15 03:37:13 +0000
+++ docs/source/development/overview.txt	2008-10-04 07:47:34 +0000
@@ -1,32 +1,35 @@
+.. This file has a lot of bash but little python, set default role
+
+.. highlight:: bash
+
 .. _development:
 
 ==============================
-IPython development guidelines
+ IPython development overview
 ==============================
 
-
-Overview
-========
-
-IPython is the next generation of IPython.  It is named such for two reasons:
-
-- Eventually, IPython will become IPython version 1.0.
-- This new code base needs to be able to co-exist with the existing IPython until
-  it is a full replacement for it.  Thus we needed a different name.  We couldn't
-  use ``ipython`` (lowercase) as some files systems are case insensitive.
-
-There are two, no three, main goals of the IPython effort:
+Currently, IPython's development tree contains all of the code that used to be
+part of IPython since the project's inception in 2001, plus all of the effort
+that was known for a while (roughly 2004-2008) as ``IPython1``.  The IPyhton1
+development was meant to be an effort to:
 
 1. Clean up the existing codebase and write lots of tests.
-2. Separate the core functionality of IPython from the terminal to enable IPython
-   to be used from within a variety of GUI applications.
+
+2. Separate the core functionality of IPython from the terminal to enable
+   IPython to be used from within a variety of GUI applications.
+   
 3. Implement a system for interactive parallel computing.
 
 While the third goal may seem a bit unrelated to the main focus of IPython, it
 turns out that the technologies required for this goal are nearly identical
 with those required for goal two. This is the main reason the interactive
-parallel computing capabilities are being put into IPython proper. Currently
-the third of these goals is furthest along.
+parallel computing capabilities are being put into IPython proper.
+
+In the summer of 2008, the IPython1 code was merged back into the mainline, and
+now there is a unified codebase.  While the above goals aren't completely
+implemented for the older code, we do have a proper :ref:`testing system
+<devel-testing>` in place (though this is still evolving), unified
+documentation and partial implementations of the more separated components.
 
 This document describes IPython from the perspective of developers.  
 
@@ -46,16 +49,19 @@
   
 - **Tests**.  Each subpackage shoud have its own ``tests`` subdirectory that
   contains all of the tests for that package.  For information about writing
-  tests for IPython, see the `Testing System`_ section of this document.
+  tests for IPython, see the :ref:`Testing System <devel-testing>` section of
+  this document.
   
 - **Configuration**.  Each subpackage should have its own ``config``
   subdirectory that contains the configuration information for the components
   of the subpackage.  For information about how the IPython configuration
-  system works, see the `Configuration System`_ section of this document.
+  system works, see the :ref:`Configuration System <devel-config>` section of
+  this document.
   
 - **Scripts**.  Each subpackage should have its own ``scripts`` subdirectory
   that contains all of the command line scripts associated with the subpackage.
 
+  
 Installation and dependencies
 -----------------------------
    
@@ -117,266 +123,132 @@
     today 's IPython.  Other frontends will likely be more powerful and based
     on GUI toolkits.
 
-``notebook``
-    An application that allows users to work with IPython notebooks.
-
 ``tools``
     This is where general utilities go.
 
 
-Version control
-===============
-
-In the past, IPython development has been done using `Subversion`__.  Recently,
-we made the transition to using `Bazaar`__ and `Launchpad`__.  This makes it
-much easier for people to contribute code to IPython.  Here is a sketch of how
-to use Bazaar for IPython development.  First, you should install Bazaar.
-After you have done that, make sure that it is working by getting the latest
-main branch of IPython::
-
-    $ bzr branch lp:ipython
-
-Now you can create a new branch for you to do your work in::
-
-    $ bzr branch ipython ipython-mybranch
-
-The typical work cycle in this branch will be to make changes in
-``ipython-mybranch`` and then commit those changes using the commit command::
-
-    $ ...do work in ipython-mybranch...
-    $ bzr ci -m "the commit message goes here"
+Version control workflow
+========================
+
+All IPython development today is done using the `Bazaar`__ system for
+distributed version control and the `Launchpad`__ site for code hosting and bug
+tracking.  This makes it very easy for anyone to contribute code to IPython.
+
+.. __: http://bazaar-vcs.org
+.. __: http://launchpad.net/ipython
+
+If you are interested in contributing to IPython, you should familiarize a bit
+with how to use bazaar, but this document gives you a concise set of steps to
+get started.  If you are going to become heavily involved with creating code
+for IPython you'll eventually want to have a Launchpad account (free) so you
+can publish your own code on the site for review and merging, but small
+contributions can be simply sent via email to the IPython list as patches.
+
+Start by creating what Bazaar calls a `shared repository`_::
+
+    # You can choose any name you want instead of "ipython-repo"
+    bzr init-repo ipython-repo
+
+.. _shared repository: http://bazaar-vcs.org/SharedRepositoryTutorial
+
+This creates an empty repository where a lot of related branches can be kept,
+and they all reuse common storage.  This way, many operations are very fast and
+take up less space.  Now, go to the newly created repository and make a local
+branch of the public trunk::
+
+    cd ipython-repo
+    # This makes a local copy of the public trunk called "trunk-lp"
+    bzr branch lp:ipython trunk-lp
+
+The ``trunk-lp`` branch is meant to always be a pristine copy of the public
+trunk.  From here, make a personal development copy of the public trunk, where
+you'll make your changes::
+
+    bzr branch trunk-lp trunk-dev
+
+Now, your working area looks like this::
+    
+    maqroll[ipython-repo]> ls -a
+    ./  ../  .bzr/  trunk-dev/  trunk-lp/
+
+The ``.bzr`` directory is the Bazaar storage area, and you now have both the
+reference copy of the public trunk and one working copy for your own
+development.  You can later make further branches as needed (a common workflow
+is to make branches to contain specific feature implementations until they are
+ready to be merged).
+    
+The typical work cycle will be to make changes in ``trunk-dev`` and then commit
+those changes as often as needed::
+
+    cd trunk-dev
+    # ... implement cool new feature...
+    bzr commit -m "Commit message goes here."
 
 Please note that since we now don't use an old-style linear ChangeLog (that
 tends to cause problems with distributed version control systems), you should
-ensure that your log messages are reasonably detailed.  Use a docstring-like
-approach in the commit messages (including the second line being left
-*blank*)::
-
-  Single line summary of  changes being committed.
-
-  - more details when warranted ...
-  - including crediting outside contributors if they sent the
-    code/bug/idea!
+ensure that your log messages are reasonably detailed.  For non-trivial
+changes, use a docstring-like approach in the commit messages (including the
+second line being left *blank*).  Type ``bzr commit`` *without* the ``-m``
+switch, and Bazaar will open an editor where you can type a more detailed
+message::
+
+    Single line summary of changes being committed.
+
+    - more details when warranted ...
+    - including crediting outside contributors if they sent the
+      code/bug/idea!
 
 If we couple this with a policy of making single commits for each reasonably
 atomic change, the bzr log should give an excellent view of the project, and
-the `--short` log option becomes a nice summary.
-
-While working with this branch, it is a good idea to merge in changes that have
-been made upstream in the parent branch.  This can be done by doing::
-
-    $ bzr pull
+the ``--short`` log option becomes a nice summary.
+
+As you work on the branch, it's a good idea to frequently keep your copy of the
+trunk updated with respect to Launchpad.  This is done via::
+
+    cd trunk-lp
+    bzr pull
+
+Bazaar can then merge any changes that were done to the public trunk into your
+local branch via::
+
+    cd trunk-dev
+    bzr merge ../trunk-lp
+    bzr commit -m"Merged upstream changes"
+
+This workflow ensures that a local copy stays in sync with the public trunk,
+while allowing for local development to be pushed back for public review.
+
+Once your changes are ready for review, you can push them to Launchpad where
+the IPython team can review them and give you feedback.  The first time, use::
+
+    bzr push --remember \
+    bzr+ssh://<you>@bazaar.launchpad.net/~<you>/ipython/trunk-dev
+
+where ``<you>`` is your Launchpad user name. This will make this branch
+publicly visible to all.  In subsequent uses you can simply run in the branch::
+
+    bzr push
+
+.. note::
+
+    Before you can push your code to Launchpad, you need to configure your SSH
+    keys.  You can do this by clicking on ``Change details`` for your profile
+    and then clicking on the ``SSH Keys`` tab.  This should take you to a URL
+    of the form ``https://launchpad.net/~<you>/+editsshkeys`` with instructions
+    on how to upload your keys.
     
-If this command shows that the branches have diverged, then you should do a
-merge instead::
-
-    $ bzr merge lp:ipython
-
-If you want others to be able to see your branch, you can create an account
-with launchpad and push the branch to your own workspace::
-
-    $ bzr push bzr+ssh://<me>@bazaar.launchpad.net/~<me>/+junk/ipython-mybranch
-
-Finally, once the work in your branch is done, you can merge your changes back
-into the `ipython` branch by using merge::
-
-    $ cd ipython
-    $ merge ../ipython-mybranch
-    [resolve any conflicts]
-    $ bzr ci -m "Fixing that bug"
-    $ bzr push
-
-But this will require you to have write permissions to the `ipython` branch.
-It you don't you can tell one of the IPython devs about your branch and they
-can do the merge for you.
-
-More information about Bazaar workflows can be found `here`__.
-
-.. __: http://subversion.tigris.org/
-.. __: http://bazaar-vcs.org/
-.. __: http://www.launchpad.net/ipython
-.. __: http://doc.bazaar-vcs.org/bzr.dev/en/user-guide/index.html
-
-Documentation
-=============
-
-Standalone documentation
-------------------------
-
-All standalone documentation should be written in plain text (``.txt``) files
-using `reStructuredText`_ for markup and formatting. All such documentation
-should be placed in the top level directory ``docs`` of the IPython source
-tree. Or, when appropriate, a suitably named subdirectory should be used. The
-documentation in this location will serve as the main source for IPython
-documentation and all existing documentation should be converted to this
-format.
-
-In the future, the text files in the ``docs`` directory will be used to
-generate all forms of documentation for IPython. This include documentation on
-the IPython website as well as *pdf* documentation.
-
-.. _reStructuredText: http://docutils.sourceforge.net/rst.html
-
-Docstring format
-----------------
-
-Good docstrings are very important. All new code will use `Epydoc`_ for
-generating API docs, so we will follow the `Epydoc`_ conventions. More
-specifically, we will use `reStructuredText`_ for markup and formatting, since
-it is understood by a wide variety of tools. This means that if in the future
-we have any reason to change from `Epydoc`_ to something else, we'll have fewer
-transition pains.
-
-Details about using `reStructuredText`_ for docstrings can be found `here
-<http://epydoc.sourceforge.net/manual-othermarkup.html>`_.
-
-.. _Epydoc: http://epydoc.sourceforge.net/
-
-Additional PEPs of interest regarding documentation of code:
-
-- `Docstring Conventions <http://www.python.org/peps/pep-0257.html>`_
-- `Docstring Processing System Framework <http://www.python.org/peps/pep-0256.html>`_
-- `Docutils Design Specification <http://www.python.org/peps/pep-0258.html>`_
-
-
-Coding conventions
-==================
-
-General
--------
-
-In general, we'll try to follow the standard Python style conventions as
-described here:
-
-- `Style Guide for Python Code  <http://www.python.org/peps/pep-0008.html>`_  
-
-
-Other comments:
-
-- In a large file, top level classes and functions should be 
-  separated by 2-3 lines to make it easier to separate them visually.
-- Use 4 spaces for indentation.
-- Keep the ordering of methods the same in classes that have the same 
-  methods.  This is particularly true for classes that implement 
-  similar interfaces and for interfaces that are similar.
-
-Naming conventions
-------------------
-
-In terms of naming conventions, we'll follow the guidelines from the `Style
-Guide for Python Code`_.
-
-For all new IPython code (and much existing code is being refactored), we'll use:
-
-- All ``lowercase`` module names.
-
-- ``CamelCase`` for class names.
-
-- ``lowercase_with_underscores`` for methods, functions, variables and
-  attributes.
-
-This may be confusing as most of the existing IPython codebase uses a different
-convention (``lowerCamelCase`` for methods and attributes).  Slowly, we will
-move IPython over to the new convention, providing shadow names for backward
-compatibility in public interfaces.
-
-There are, however, some important exceptions to these rules.  In some cases,
-IPython code will interface with packages (Twisted, Wx, Qt) that use other
-conventions.  At some level this makes it impossible to adhere to our own
-standards at all times.  In particular, when subclassing classes that use other
-naming conventions, you must follow their naming conventions.  To deal with
-cases like this, we propose the following policy:
-
-- If you are subclassing a class that uses different conventions, use its
-  naming conventions throughout your subclass.  Thus, if you are creating a
-  Twisted Protocol class, used Twisted's
-  ``namingSchemeForMethodsAndAttributes.``
-
-- All IPython's official interfaces should use our conventions.  In some cases
-  this will mean that you need to provide shadow names (first implement
-  ``fooBar`` and then ``foo_bar = fooBar``).  We want to avoid this at all
-  costs, but it will probably be necessary at times.  But, please use this
-  sparingly!
-
-Implementation-specific *private* methods will use
-``_single_underscore_prefix``.  Names with a leading double underscore will
-*only* be used in special cases, as they makes subclassing difficult (such
-names are not easily seen by child classes).
-
-Occasionally some run-in lowercase names are used, but mostly for very short
-names or where we are implementing methods very similar to existing ones in a
-base class (like ``runlines()`` where ``runsource()`` and ``runcode()`` had
-established precedent).
-
-The old IPython codebase has a big mix of classes and modules prefixed with an
-explicit ``IP``. In Python this is mostly unnecessary, redundant and frowned
-upon, as namespaces offer cleaner prefixing. The only case where this approach
-is justified is for classes which are expected to be imported into external
-namespaces and a very generic name (like Shell) is too likely to clash with
-something else. We'll need to revisit this issue as we clean up and refactor
-the code, but in general we should remove as many unnecessary ``IP``/``ip``
-prefixes as possible. However, if a prefix seems absolutely necessary the more
-specific ``IPY`` or ``ipy`` are preferred.
-
-.. _devel_testing:
-
-Testing system
-==============
-
-It is extremely important that all code contributed to IPython has tests. Tests
-should be written as unittests, doctests or as entities that the `Nose`_
-testing package will find. Regardless of how the tests are written, we will use
-`Nose`_ for discovering and running the tests. `Nose`_ will be required to run
-the IPython test suite, but will not be required to simply use IPython.
-
-.. _Nose: http://code.google.com/p/python-nose/
-
-Tests of `Twisted`__ using code should be written by subclassing the
-``TestCase`` class that comes with ``twisted.trial.unittest``. When this is
-done, `Nose`_ will be able to run the tests and the twisted reactor will be
-handled correctly.
-
-.. __: http://www.twistedmatrix.com
-
-Each subpackage in IPython should have its own ``tests`` directory that
-contains all of the tests for that subpackage. This allows each subpackage to
-be self-contained. If a subpackage has any dependencies beyond the Python
-standard library, the tests for that subpackage should be skipped if the
-dependencies are not found. This is very important so users don't get tests
-failing simply because they don't have dependencies.
-
-We also need to look into use Noses ability to tag tests to allow a more
-modular approach of running tests.
-
-.. _devel_config:
-
-Configuration system
-====================
-
-IPython uses `.ini`_ files for configuration purposes. This represents a huge
-improvement over the configuration system used in IPython. IPython works with
-these files using the `ConfigObj`_ package, which IPython includes as
-``ipython1/external/configobj.py``.
-
-Currently, we are using raw `ConfigObj`_ objects themselves. Each subpackage of
-IPython should contain a ``config`` subdirectory that contains all of the
-configuration information for the subpackage. To see how configuration
-information is defined (along with defaults) see at the examples in
-``ipython1/kernel/config`` and ``ipython1/core/config``. Likewise, to see how
-the configuration information is used, see examples in
-``ipython1/kernel/scripts/ipengine.py``.
-
-Eventually, we will add a new layer on top of the raw `ConfigObj`_ objects. We
-are calling this new layer, ``tconfig``, as it will use a `Traits`_-like
-validation model.  We won't actually use `Traits`_, but will implement
-something similar in pure Python.  But, even in this new system, we will still
-use `ConfigObj`_ and `.ini`_ files underneath the hood. Talk to Fernando if you
-are interested in working on this part of IPython. The current prototype of
-``tconfig`` is located in the IPython sandbox.
-
-.. _.ini: http://docs.python.org/lib/module-ConfigParser.html
-.. _ConfigObj: http://www.voidspace.org.uk/python/configobj.html
-.. _Traits: http://code.enthought.com/traits/
+Once the branch is publicly visible, using the launchpad interface it can be
+marked for merging with the link marked *"Propose for merging into another
+branch"*, leaving the default choice of trunk as its target.  This way,
+Launchpad tracks what changes of this branch are new with respect to the trunk,
+others in the team can review it, and merge the changes into the trunk.
+
+The IPython team has a policy of reviewing all code (both from core members of
+the team and from external contributors) before merging it.  Code should be
+clearly documented (as explained further in this guide), clear and well tested.
+We will be happy to provide you with feedback for your code to be a great
+contribution to the project, and we've found that peer review of code is an
+excellent way to improve the quality of everyone's work.
 
 
 Installation and testing scenarios
@@ -386,43 +258,54 @@
 release an IPython version.  These scenarios represent different ways of
 installing IPython and its dependencies.
 
+
 Installation scenarios under Linux and OS X
 -------------------------------------------
 
-    1.  Install from tarball using ``python setup.py install``.
-        a.  With only readline+nose dependencies installed.
-        b.  With all dependencies installed (readline, zope.interface, Twisted,
-        foolscap, Sphinx, nose, pyOpenSSL).
-	    
-    2.  Install using easy_install.
-
-        a.  With only readline+nose dependencies installed.
-            i.  Default dependencies: ``easy_install ipython-0.9.beta3-py2.5.egg``
-            ii. Optional dependency sets: ``easy_install -f ipython-0.9.beta3-py2.5.egg IPython[kernel,doc,test,security]``
-
-        b.  With all dependencies already installed.
+1.  Install from tarball using ``python setup.py install``.
+
+  * With only readline+nose dependencies installed.
+
+  * With all dependencies installed (readline, zope.interface, Twisted,
+    foolscap, Sphinx, nose, pyOpenSSL).
+
+2.  Install using easy_install.
+
+  * With only readline+nose dependencies installed.
+    
+    * Default dependencies: ``easy_install ipython-0.9.beta3-py2.5.egg``
+
+    * Optional dependency sets:
+      ``easy_install -f ipython-0.9.beta3-py2.5.egg IPython[kernel,doc,test,security]``
+
+  * With all dependencies already installed.
 	
 
 Installation scenarios under Win32
 ----------------------------------
 
-	1.  Install everything from .exe installers
-	2.  easy_install?
+#. Install everything from .exe installers
+#. easy_install?
 
 
 Tests to run for these scenarios
 --------------------------------
 
-    1.  Run the full test suite.
-    2.  Start a controller and engines and try a few things by hand.
-        a.  Using ipcluster.
-        b.  Using ipcontroller/ipengine by hand.
-
-    3.  Run a few of the parallel examples.
-    4.  Try the kernel with and without security with and without PyOpenSSL
-        installed.
-    5.  Beat on the IPython terminal a bunch.
-    6.  Make sure that furl files are being put in proper locations.
+#. Run the full test suite.
+
+#. Start a controller and engines and try a few things by hand.
+
+   * Using ipcluster.
+   * Using ipcontroller/ipengine by hand.
+
+#. Run a few of the parallel examples.
+
+#. Try the kernel with and without security with and without PyOpenSSL
+   installed.
+
+#. Beat on the IPython terminal a bunch.
+
+#. Make sure that furl files are being put in proper locations.
 
 
 Release checklist
 
=== modified file 'docs/source/index.txt'
--- docs/source/index.txt	2008-09-15 03:37:13 +0000
+++ docs/source/index.txt	2009-03-11 01:24:53 +0000
@@ -17,10 +17,11 @@
    interactive/index.txt
    parallel/index.txt
    config/index.txt
+   faq.txt
+   history.txt
    changes.txt
    development/index.txt
-   faq.txt
-   history.txt
+   api/index.txt
    license_and_copyright.txt
    credits.txt
 
 
=== modified file 'docs/source/install/index.txt'
--- docs/source/install/index.txt	2008-09-11 23:49:58 +0000
+++ docs/source/install/index.txt	2008-10-04 05:37:23 +0000
@@ -1,8 +1,8 @@
 .. _install_index:
 
-==================
+============
 Installation
-==================
+============
 
 .. toctree::
    :maxdepth: 2
 
=== modified file 'docs/source/install/install.txt'
--- docs/source/install/install.txt	2008-09-13 15:14:14 +0000
+++ docs/source/install/install.txt	2008-10-04 07:47:34 +0000
@@ -1,77 +1,126 @@
+.. There's little Python in this file, so make the default language bash.
+
+.. highlight:: bash
+
 Overview
 ========
 
-This document describes the steps required to install IPython.  IPython is organized into a number of subpackages, each of which has its own dependencies.  All of the subpackages come with IPython, so you don't need to download and install them separately.  However, to use a given subpackage, you will need to install all of its dependencies.  
+This document describes the steps required to install IPython.  IPython is
+organized into a number of subpackages, each of which has its own dependencies.
+All of the subpackages come with IPython, so you don't need to download and
+install them separately.  However, to use a given subpackage, you will need to
+install all of its dependencies.
 
 
 Please let us know if you have problems installing IPython or any of its
-dependencies. IPython requires Python version 2.4 or greater.  We have not tested
-IPython with the upcoming 2.6 or 3.0 versions.
+dependencies. IPython requires Python version 2.4 or greater.  We have not
+tested IPython with the upcoming 2.6 or 3.0 versions, though preliminary
+reports of 2.6 usage are encouraging.  3.0 porting will take longer, however.
 
 .. warning::
 
-	IPython will not work with Python 2.3 or below.
-
-Some of the installation approaches use the :mod:`setuptools` package and its :command:`easy_install` command line program.  In many scenarios, this provides the most simple method of installing IPython and its dependencies.  It is not required though.  More information about :mod:`setuptools` can be found on its website.
-
-More general information about installing Python packages can be found in Python's documentation at http://www.python.org/doc/.
+    IPython will not work with Python 2.3 or below.
+
+Some of the installation approaches use the :mod:`setuptools` package and its
+:command:`easy_install` command line program.  In many scenarios, this provides
+the most simple method of installing IPython and its dependencies.  It is not
+required though.  More information about :mod:`setuptools` can be found on its
+website.
+
+More general information about installing Python packages can be found in
+Python's documentation at http://www.python.org/doc/.
+
 
 Installing IPython itself
 =========================
 
-Given a properly built Python, the basic interactive IPython shell will work with no external dependencies.  However, some Python distributions (particularly on Windows and OS X), don't come with a working :mod:`readline` module.  The IPython shell will work without :mod:`readline`, but will lack many features that users depend on, such as tab completion and command line editing.  See below for details of how to make sure you have a working :mod:`readline`.
+Given a properly built Python, the basic interactive IPython shell will work
+with no external dependencies.  However, some Python distributions
+(particularly on Windows and OS X), don't come with a working :mod:`readline`
+module.  The IPython shell will work without :mod:`readline`, but will lack
+many features that users depend on, such as tab completion and command line
+editing.  See below for details of how to make sure you have a working
+:mod:`readline`.
 
 Installation using easy_install
 -------------------------------
 
-If you have :mod:`setuptools` installed, the easiest way of getting IPython is to simple use :command:`easy_install`::
-
-	$ easy_install IPython
-
-That's it.
+If you have :mod:`setuptools` installed, the easiest way of getting IPython is
+to use :command:`easy_install`::
+
+    easy_install IPython
+
+Unless you've written a custom distutils script as explained `here`__, that will
+try to install either in a default system-wide location, which may require
+administrator access.  If that is the case, you can either run the command with
+root privileges::
+
+    sudo easy_install IPython
+
+or you can specify an alternate location, for example::
+
+    easy_install --prefix=~/usr/local IPython
+
+where this assumes that ``~/usr/local`` is a valid prefix for you to install
+packages to in your user account.
+
+.. __: http://docs.python.org/install/index.html#inst-config-files
+
 
 Installation from source
 ------------------------
 
-If you don't want to use :command:`easy_install`, or don't have it installed, just grab the latest stable build of IPython from `here <http://ipython.scipy.org/dist/>`_.  Then do the following::
-
-	$ tar -xzf ipython.tar.gz
-	$ cd ipython
-	$ python setup.py install
-
-If you are installing to a location (like ``/usr/local``) that requires higher permissions, you may need to run the last command with :command:`sudo`.
+If you don't want to use :command:`easy_install`, or don't have it installed,
+just grab the latest stable build of IPython from `here
+<http://ipython.scipy.org/dist/>`_.  Then do the following (using the
+appropriate version number)::
+
+    tar -xzf ipython.tar.gz
+    cd ipython
+    python setup.py install
+
+If you are installing to a location (like ``/usr/local``) that requires higher
+permissions, you may need to run the last command with :command:`sudo`.
 
 Windows
 -------
 
 There are a few caveats for Windows users.  The main issue is that a basic ``python setup.py install`` approach won't create ``.bat`` file or Start Menu shortcuts, which most users want.  To get an installation with these, there are two choices:
 
-1.  Install using :command:`easy_install`.
-
-2.  Install using our binary ``.exe`` Windows installer, which can be found at `here <http://ipython.scipy.org/dist/>`_
-
-3.  Install from source, but using :mod:`setuptools` (``python setupegg.py install``).
+#. Install using :command:`easy_install`.
+
+#. Install using our binary ``.exe`` Windows installer, which can be found at
+`here <http://ipython.scipy.org/dist/>`_
+
+#. Install from source, but using :mod:`setuptools` (``python setupegg.py
+   install``).
 
 Installing the development version
 ----------------------------------
 
-It is also possible to install the development version of IPython from our `Bazaar <http://bazaar-vcs.org/>`_ source code
-repository.  To do this you will need to have Bazaar installed on your system.  Then just do::
+It is also possible to install the development version of IPython from our
+`Bazaar <http://bazaar-vcs.org/>`_ source code repository.  To do this you will
+need to have Bazaar installed on your system.  Then just do::
 
-	$ bzr branch lp:ipython
-	$ cd ipython
-	$ python setup.py install
+    bzr branch lp:ipython
+    cd ipython
+    python setup.py install
 
 Again, this last step on Windows won't create ``.bat`` files or Start Menu shortcuts, so you will have to use one of the other approaches listed above.
 
-Some users want to be able to follow the development branch as it changes.  If you have :mod:`setuptools` installed, this is easy. Simply replace the last step by::
-
-	$ python setupegg.py develop
-
-This creates links in the right places and installs the command line script to the appropriate places.  Then, if you want to update your IPython at any time, just do::
-
-	$ bzr pull
-
+Some users want to be able to follow the development branch as it changes.  If
+you have :mod:`setuptools` installed, this is easy. Simply replace the last
+step by::
+
+    python setupegg.py develop
+
+This creates links in the right places and installs the command line script to
+the appropriate places.  Then, if you want to update your IPython at any time,
+just do::
+
+    bzr pull
+
+    
 Basic optional dependencies
 ===========================
 
@@ -86,17 +135,24 @@
 readline
 --------
 
-In principle, all Python distributions should come with a working :mod:`readline` module.  But, reality is not quite that simple.  There are two common situations where you won't have a working :mod:`readline` module:
+In principle, all Python distributions should come with a working
+:mod:`readline` module.  But, reality is not quite that simple.  There are two
+common situations where you won't have a working :mod:`readline` module:
 
 * If you are using the built-in Python on Mac OS X.
 
 * If you are running Windows, which doesn't have a :mod:`readline` module.
 
-On OS X, the built-in Python doesn't not have :mod:`readline` because of license issues.  Starting with OS X 10.5 (Leopard), Apple's built-in Python has a BSD-licensed not-quite-compatible readline replacement. As of IPython 0.9, many of the issues related to the differences between readline and libedit have been resolved.  For many users, libedit may be sufficient.
-
-Most users on OS X will want to get the full :mod:`readline` module.  To get a working :mod:`readline` module, just do (with :mod:`setuptools` installed)::
-
-	$ easy_install readline
+On OS X, the built-in Python doesn't not have :mod:`readline` because of
+license issues.  Starting with OS X 10.5 (Leopard), Apple's built-in Python has
+a BSD-licensed not-quite-compatible readline replacement. As of IPython 0.9,
+many of the issues related to the differences between readline and libedit have
+been resolved.  For many users, libedit may be sufficient.
+
+Most users on OS X will want to get the full :mod:`readline` module.  To get a
+working :mod:`readline` module, just do (with :mod:`setuptools` installed)::
+
+    easy_install readline
 
 .. note:
 
@@ -104,83 +160,112 @@
     official python.org binaries) already have readline installed so 
     you don't have to do this step.
 
-If needed, the readline egg can be build and installed from source (see the wiki page at http://ipython.scipy.org/moin/InstallationOSXLeopard).
+If needed, the readline egg can be build and installed from source (see the
+wiki page at http://ipython.scipy.org/moin/InstallationOSXLeopard).
 
-On Windows, you will need the PyReadline module.  PyReadline is a separate, Windows only implementation of readline that uses native Windows calls through :mod:`ctypes`.  The easiest way of installing PyReadline is you use the binary installer available `here <http://ipython.scipy.org/dist/>`_.  The :mod:`ctypes` module, which comes with Python 2.5 and greater, is required by PyReadline.  It is available for Python 2.4 at http://python.net/crew/theller/ctypes.
+On Windows, you will need the PyReadline module.  PyReadline is a separate,
+Windows only implementation of readline that uses native Windows calls through
+:mod:`ctypes`.  The easiest way of installing PyReadline is you use the binary
+installer available `here <http://ipython.scipy.org/dist/>`_.  The
+:mod:`ctypes` module, which comes with Python 2.5 and greater, is required by
+PyReadline.  It is available for Python 2.4 at
+http://python.net/crew/theller/ctypes.
 
 nose
 ----
 
-To run the IPython test suite you will need the :mod:`nose` package.  Nose provides a great way of sniffing out and running all of the IPython tests.  The simplest way of getting nose, is to use :command:`easy_install`::
+To run the IPython test suite you will need the :mod:`nose` package.  Nose
+provides a great way of sniffing out and running all of the IPython tests.  The
+simplest way of getting nose, is to use :command:`easy_install`::
 
-	$ easy_install nose
+    easy_install nose
 
 Another way of getting this is to do::
 
-    $ easy_install IPython[test]
-
-For more installation options, see the `nose website <http://somethingaboutorange.com/mrl/projects/nose/>`_.  Once you have nose installed, you can run IPython's test suite using the iptest command::
-
-	$ iptest
+    easy_install IPython[test]
+
+For more installation options, see the `nose website
+<http://somethingaboutorange.com/mrl/projects/nose/>`_.  Once you have nose
+installed, you can run IPython's test suite using the iptest command::
+
+    iptest
 
 
 pexpect
 -------
 
-The `pexpect <http://www.noah.org/wiki/Pexpect>`_ package is used in IPython's :command:`irunner` script.  On Unix platforms (including OS X), just do::
+The `pexpect <http://www.noah.org/wiki/Pexpect>`_ package is used in IPython's
+:command:`irunner` script.  On Unix platforms (including OS X), just do::
 
-	$ easy_install pexpect
+    easy_install pexpect
 
 Windows users are out of luck as pexpect does not run there.
 
 Dependencies for IPython.kernel (parallel computing)
 ====================================================
 
-The IPython kernel provides a nice architecture for parallel computing.  The main focus of this architecture is on interactive parallel computing.  These features require a number of additional packages:
+The IPython kernel provides a nice architecture for parallel computing.  The
+main focus of this architecture is on interactive parallel computing.  These
+features require a number of additional packages:
 
 * zope.interface (yep, we use interfaces)
 * Twisted (asynchronous networking framework)
 * Foolscap (a nice, secure network protocol)
 * pyOpenSSL (security for network connections)
 
-On a Unix style platform (including OS X), if you want to use :mod:`setuptools`, you can just do::
+On a Unix style platform (including OS X), if you want to use
+:mod:`setuptools`, you can just do::
 
-    $ easy_install IPython[kernel]    # the first three
-    $ easy_install IPython[security]  # pyOpenSSL
+    easy_install IPython[kernel]    # the first three
+    easy_install IPython[security]  # pyOpenSSL
 
 zope.interface and Twisted
 --------------------------
 
-On Unix style platforms (including OS X), the simplest way of getting the these is to use :command:`easy_install`::
-
-	$ easy_install zope.interface
-	$ easy_install Twisted
-
-Of course, you can also download the source tarballs from the `Twisted website <twistedmatrix.org>`_ and the `zope.interface page at PyPI <http://pypi.python.org/pypi/zope.interface>`_ and do the usual ``python setup.py install`` if you prefer.
-
-Windows is a bit different.  For zope.interface and Twisted, simply get the latest binary ``.exe`` installer from the Twisted website.  This installer includes both zope.interface and Twisted and should just work.
+On Unix style platforms (including OS X), the simplest way of getting the these
+is to use :command:`easy_install`::
+
+    easy_install zope.interface
+    easy_install Twisted
+
+Of course, you can also download the source tarballs from the `Twisted website
+<twistedmatrix.org>`_ and the `zope.interface page at PyPI
+<http://pypi.python.org/pypi/zope.interface>`_ and do the usual ``python
+setup.py install`` if you prefer.
+
+Windows is a bit different.  For zope.interface and Twisted, simply get the
+latest binary ``.exe`` installer from the Twisted website.  This installer
+includes both zope.interface and Twisted and should just work.
 
 Foolscap
 --------
 
-Foolscap uses Twisted to provide a very nice secure RPC protocol that we use to implement our parallel computing features.
+Foolscap uses Twisted to provide a very nice secure RPC protocol that we use to
+implement our parallel computing features.
 
 On all platforms a simple::
 
-    $ easy_install foolscap
+    easy_install foolscap
 
-should work.  You can also download the source tarballs from the `Foolscap website <http://foolscap.lothar.com/trac>`_ and do ``python setup.py install`` if you prefer.
+should work.  You can also download the source tarballs from the `Foolscap
+website <http://foolscap.lothar.com/trac>`_ and do ``python setup.py install``
+if you prefer.
 
 pyOpenSSL
 ---------
 
-IPython requires an older version of pyOpenSSL (0.6 rather than the current 0.7).  There are a couple of options for getting this:
-
-1.  Most Linux distributions have packages for pyOpenSSL.
-2.  The built-in Python 2.5 on OS X 10.5 already has it installed.
-3.  There are source tarballs on the pyOpenSSL website.  On Unix-like
-    platforms, these can be built using ``python seutp.py install``.
-4.  There is also a binary ``.exe`` Windows installer on the `pyOpenSSL website <http://pyopenssl.sourceforge.net/>`_.
+IPython requires an older version of pyOpenSSL (0.6 rather than the current
+0.7).  There are a couple of options for getting this:
+
+1. Most Linux distributions have packages for pyOpenSSL.
+
+2. The built-in Python 2.5 on OS X 10.5 already has it installed.
+
+3. There are source tarballs on the pyOpenSSL website.  On Unix-like
+   platforms, these can be built using ``python seutp.py install``.
+
+4. There is also a binary ``.exe`` Windows installer on the `pyOpenSSL website
+   <http://pyopenssl.sourceforge.net/>`_.
 
 Dependencies for IPython.frontend (the IPython GUI)
 ===================================================
@@ -188,4 +273,9 @@
 wxPython
 --------
 
-Starting with IPython 0.9, IPython has a new IPython.frontend package that has a nice wxPython based IPython GUI.  As you would expect, this GUI requires wxPython.  Most Linux distributions have wxPython packages available and the built-in Python on OS X comes with wxPython preinstalled.  For Windows, a binary installer is available on the `wxPython website <http://www.wxpython.org/>`_. 
 \ No newline at end of file
+Starting with IPython 0.9, IPython has a new IPython.frontend package that has
+a nice wxPython based IPython GUI.  As you would expect, this GUI requires
+wxPython.  Most Linux distributions have wxPython packages available and the
+built-in Python on OS X comes with wxPython preinstalled.  For Windows, a
+binary installer is available on the `wxPython website
+<http://www.wxpython.org/>`_.
 
=== modified file 'docs/source/interactive/reference.txt'
--- docs/source/interactive/reference.txt	2008-09-13 22:39:42 +0000
+++ docs/source/interactive/reference.txt	2009-03-11 01:24:53 +0000
@@ -496,9 +496,9 @@
     ip.expose_magic('impall', doimp)
 
 You can also define your own aliased names for magic functions. In your
-ipythonrc file, placing a line like:
+ipythonrc file, placing a line like::
 
-execute __IP.magic_cl = __IP.magic_clear
+    execute __IP.magic_cl = __IP.magic_clear
 
 will define %cl as a new name for %clear.
 
@@ -508,1572 +508,9 @@
 information on the '?' system) to get information about any particular
 magic function you are interested in.
 
-
-Magic commands
---------------
-
-The rest of this section is automatically generated for each release
-from the docstrings in the IPython code. Therefore the formatting is
-somewhat minimal, but this method has the advantage of having
-information always in sync with the code.
-
-A list of all the magic commands available in IPython's default
-installation follows. This is similar to what you'll see by simply
-typing %magic at the prompt, but that will also give you information
-about magic commands you may have added as part of your personal
-customizations.
-
-.. magic_start
-
-**%Exit**::
-
-	Exit IPython without confirmation.
-
-**%Pprint**::
-
-	Toggle pretty printing on/off.
-
-**%alias**::
-
-	Define an alias for a system command.
-
-        '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
-
-        Then, typing 'alias_name params' will execute the system command 'cmd
-        params' (from your underlying operating system).
-
-        Aliases have lower precedence than magic functions and Python normal
-        variables, so if 'foo' is both a Python variable and an alias, the
-        alias can not be executed until 'del foo' removes the Python variable.
-
-        You can use the %l specifier in an alias definition to represent the
-        whole line when the alias is called.  For example:
-
-          In [2]: alias all echo "Input in brackets: <%l>"\
-          In [3]: all hello world\
-          Input in brackets: <hello world>
-
-        You can also define aliases with parameters using %s specifiers (one
-        per parameter):
-        
-          In [1]: alias parts echo first %s second %s\
-          In [2]: %parts A B\
-          first A second B\
-          In [3]: %parts A\
-          Incorrect number of arguments: 2 expected.\
-          parts is an alias to: 'echo first %s second %s'
-
-        Note that %l and %s are mutually exclusive.  You can only use one or
-        the other in your aliases.
-
-        Aliases expand Python variables just like system calls using ! or !! 
-        do: all expressions prefixed with '$' get expanded.  For details of
-        the semantic rules, see PEP-215:
-        http://www.python.org/peps/pep-0215.html.  This is the library used by
-        IPython for variable expansion.  If you want to access a true shell
-        variable, an extra $ is necessary to prevent its expansion by IPython:
-
-        In [6]: alias show echo\
-        In [7]: PATH='A Python string'\
-        In [8]: show $PATH\
-        A Python string\
-        In [9]: show $$PATH\
-        /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
-
-        You can use the alias facility to acess all of $PATH.  See the %rehash
-        and %rehashx functions, which automatically create aliases for the
-        contents of your $PATH.
-
-        If called with no parameters, %alias prints the current alias table.
-
-**%autocall**::
-
-	Make functions callable without having to type parentheses.
-
-        Usage:
-
-           %autocall [mode]
-
-        The mode can be one of: 0->Off, 1->Smart, 2->Full.  If not given, the
-        value is toggled on and off (remembering the previous state).
-
-        In more detail, these values mean:
-
-        0 -> fully disabled
-
-        1 -> active, but do not apply if there are no arguments on the line.
-
-        In this mode, you get:
-
-        In [1]: callable
-        Out[1]: <built-in function callable>
-
-        In [2]: callable 'hello'
-        ------> callable('hello')
-        Out[2]: False
-
-        2 -> Active always.  Even if no arguments are present, the callable
-        object is called:
-
-        In [4]: callable
-        ------> callable()
-
-        Note that even with autocall off, you can still use '/' at the start of
-        a line to treat the first argument on the command line as a function
-        and add parentheses to it:
-
-        In [8]: /str 43
-        ------> str(43)
-        Out[8]: '43'
-
-**%autoindent**::
-
-	Toggle autoindent on/off (if available).
-
-**%automagic**::
-
-	Make magic functions callable without having to type the initial %.
-
-        Without argumentsl toggles on/off (when off, you must call it as
-        %automagic, of course).  With arguments it sets the value, and you can
-        use any of (case insensitive):
-
-         - on,1,True: to activate
-
-         - off,0,False: to deactivate.
-
-        Note that magic functions have lowest priority, so if there's a
-        variable whose name collides with that of a magic fn, automagic won't
-        work for that function (you get the variable instead). However, if you
-        delete the variable (del var), the previously shadowed magic function
-        becomes visible to automagic again.
-
-**%bg**::
-
-	Run a job in the background, in a separate thread.
-
-        For example,
-
-          %bg myfunc(x,y,z=1)
-
-        will execute 'myfunc(x,y,z=1)' in a background thread.  As soon as the
-        execution starts, a message will be printed indicating the job
-        number.  If your job number is 5, you can use
-
-          myvar = jobs.result(5)  or  myvar = jobs[5].result
-
-        to assign this result to variable 'myvar'.
-
-        IPython has a job manager, accessible via the 'jobs' object.  You can
-        type jobs? to get more information about it, and use jobs.<TAB> to see
-        its attributes.  All attributes not starting with an underscore are
-        meant for public use.
-
-        In particular, look at the jobs.new() method, which is used to create
-        new jobs.  This magic %bg function is just a convenience wrapper
-        around jobs.new(), for expression-based jobs.  If you want to create a
-        new job with an explicit function object and arguments, you must call
-        jobs.new() directly.
-
-        The jobs.new docstring also describes in detail several important
-        caveats associated with a thread-based model for background job
-        execution.  Type jobs.new? for details.
-
-        You can check the status of all jobs with jobs.status().
-
-        The jobs variable is set by IPython into the Python builtin namespace.
-        If you ever declare a variable named 'jobs', you will shadow this
-        name.  You can either delete your global jobs variable to regain
-        access to the job manager, or make a new name and assign it manually
-        to the manager (stored in IPython's namespace).  For example, to
-        assign the job manager to the Jobs name, use:
-
-          Jobs = __builtins__.jobs
-
-**%bookmark**::
-
-	Manage IPython's bookmark system.
-
-        %bookmark <name>       - set bookmark to current dir
-        %bookmark <name> <dir> - set bookmark to <dir>
-        %bookmark -l           - list all bookmarks
-        %bookmark -d <name>    - remove bookmark
-        %bookmark -r           - remove all bookmarks
-
-        You can later on access a bookmarked folder with:
-          %cd -b <name>
-        or simply '%cd <name>' if there is no directory called <name> AND
-        there is such a bookmark defined.
-
-        Your bookmarks persist through IPython sessions, but they are
-        associated with each profile.
-
-**%cd**::
-
-	Change the current working directory.
-
-        This command automatically maintains an internal list of directories
-        you visit during your IPython session, in the variable _dh. The
-        command %dhist shows this history nicely formatted. You can also
-        do 'cd -<tab>' to see directory history conveniently.
-
-        Usage:
-
-          cd 'dir': changes to directory 'dir'.
-
-          cd -: changes to the last visited directory.
-
-          cd -<n>: changes to the n-th directory in the directory history.
-
-          cd -b <bookmark_name>: jump to a bookmark set by %bookmark
-             (note: cd <bookmark_name> is enough if there is no
-              directory <bookmark_name>, but a bookmark with the name exists.)
-              'cd -b <tab>' allows you to tab-complete bookmark names. 
-
-        Options:
-
-        -q: quiet.  Do not print the working directory after the cd command is
-        executed.  By default IPython's cd command does print this directory,
-        since the default prompts do not display path information.
-        
-        Note that !cd doesn't work for this purpose because the shell where
-        !command runs is immediately discarded after executing 'command'.
-
-**%clear**::
-
-	 Clear various data (e.g. stored history data)
-    
-    %clear out - clear output history
-    %clear in  - clear input history
-    %clear shadow_compress - Compresses shadow history (to speed up ipython)
-    %clear shadow_nuke - permanently erase all entries in shadow history
-    %clear dhist - clear dir history
-
-**%color_info**::
-
-	Toggle color_info.
-
-        The color_info configuration parameter controls whether colors are
-        used for displaying object details (by things like %psource, %pfile or
-        the '?' system). This function toggles this value with each call.
-
-        Note that unless you have a fairly recent pager (less works better
-        than more) in your system, using colored object information displays
-        will not work properly. Test it and see.
-
-**%colors**::
-
-	Switch color scheme for prompts, info system and exception handlers.
-
-        Currently implemented schemes: NoColor, Linux, LightBG.
-
-        Color scheme names are not case-sensitive.
-
-**%cpaste**::
-
-	Allows you to paste & execute a pre-formatted code block from clipboard
-        
-        You must terminate the block with '--' (two minus-signs) alone on the
-        line. You can also provide your own sentinel with '%paste -s %%' ('%%' 
-        is the new sentinel for this operation)
-        
-        The block is dedented prior to execution to enable execution of method
-        definitions. '>' and '+' characters at the beginning of a line are
-        ignored, to allow pasting directly from e-mails or diff files. The
-        executed block is also assigned to variable named 'pasted_block' for
-        later editing with '%edit pasted_block'.
-        
-        You can also pass a variable name as an argument, e.g. '%cpaste foo'.
-        This assigns the pasted block to variable 'foo' as string, without 
-        dedenting or executing it.
-        
-        Do not be alarmed by garbled output on Windows (it's a readline bug). 
-        Just press enter and type -- (and press enter again) and the block 
-        will be what was just pasted.
-        
-        IPython statements (magics, shell escapes) are not supported (yet).
-
-**%debug**::
-
-	Activate the interactive debugger in post-mortem mode.
-
-        If an exception has just occurred, this lets you inspect its stack
-        frames interactively.  Note that this will always work only on the last
-        traceback that occurred, so you must call this quickly after an
-        exception that you wish to inspect has fired, because if another one
-        occurs, it clobbers the previous one.
-
-        If you want IPython to automatically do this on every exception, see
-        the %pdb magic for more details.
-
-**%dhist**::
-
-	Print your history of visited directories.
-
-        %dhist       -> print full history\
-        %dhist n     -> print last n entries only\
-        %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\
-
-        This history is automatically maintained by the %cd command, and
-        always available as the global list variable _dh. You can use %cd -<n>
-        to go to directory number <n>.
-        
-        Note that most of time, you should view directory history by entering
-        cd -<TAB>.
-
-**%dirs**::
-
-	Return the current directory stack.
-
-**%doctest_mode**::
-
-	Toggle doctest mode on and off.
-
-        This mode allows you to toggle the prompt behavior between normal
-        IPython prompts and ones that are as similar to the default IPython
-        interpreter as possible.
-
-        It also supports the pasting of code snippets that have leading '>>>'
-        and '...' prompts in them.  This means that you can paste doctests from
-        files or docstrings (even if they have leading whitespace), and the
-        code will execute correctly.  You can then use '%history -tn' to see
-        the translated history without line numbers; this will give you the
-        input after removal of all the leading prompts and whitespace, which
-        can be pasted back into an editor.
-
-        With these features, you can switch into this mode easily whenever you
-        need to do testing and changes to doctests, without having to leave
-        your existing IPython session.
-
-**%ed**::
-
-	Alias to %edit.
-
-**%edit**::
-
-	Bring up an editor and execute the resulting code.
-
-        Usage:
-          %edit [options] [args]
-
-        %edit runs IPython's editor hook.  The default version of this hook is
-        set to call the __IPYTHON__.rc.editor command.  This is read from your
-        environment variable $EDITOR.  If this isn't found, it will default to
-        vi under Linux/Unix and to notepad under Windows.  See the end of this
-        docstring for how to change the editor hook.
-
-        You can also set the value of this editor via the command line option
-        '-editor' or in your ipythonrc file. This is useful if you wish to use
-        specifically for IPython an editor different from your typical default
-        (and for Windows users who typically don't set environment variables).
-
-        This command allows you to conveniently edit multi-line code right in
-        your IPython session.
-        
-        If called without arguments, %edit opens up an empty editor with a
-        temporary file and will execute the contents of this file when you
-        close it (don't forget to save it!).
-
-
-        Options:
-
-        -n <number>: open the editor at a specified line number.  By default,
-        the IPython editor hook uses the unix syntax 'editor +N filename', but
-        you can configure this by providing your own modified hook if your
-        favorite editor supports line-number specifications with a different
-        syntax.
-        
-        -p: this will call the editor with the same data as the previous time
-        it was used, regardless of how long ago (in your current session) it
-        was.
-
-        -r: use 'raw' input.  This option only applies to input taken from the
-        user's history.  By default, the 'processed' history is used, so that
-        magics are loaded in their transformed version to valid Python.  If
-        this option is given, the raw input as typed as the command line is
-        used instead.  When you exit the editor, it will be executed by
-        IPython's own processor.
-        
-        -x: do not execute the edited code immediately upon exit. This is
-        mainly useful if you are editing programs which need to be called with
-        command line arguments, which you can then do using %run.
-
-
-        Arguments:
-
-        If arguments are given, the following possibilites exist:
-
-        - The arguments are numbers or pairs of colon-separated numbers (like
-        1 4:8 9). These are interpreted as lines of previous input to be
-        loaded into the editor. The syntax is the same of the %macro command.
-
-        - If the argument doesn't start with a number, it is evaluated as a
-        variable and its contents loaded into the editor. You can thus edit
-        any string which contains python code (including the result of
-        previous edits).
-
-        - If the argument is the name of an object (other than a string),
-        IPython will try to locate the file where it was defined and open the
-        editor at the point where it is defined. You can use `%edit function`
-        to load an editor exactly at the point where 'function' is defined,
-        edit it and have the file be executed automatically.
-
-        If the object is a macro (see %macro for details), this opens up your
-        specified editor with a temporary file containing the macro's data.
-        Upon exit, the macro is reloaded with the contents of the file.
-
-        Note: opening at an exact line is only supported under Unix, and some
-        editors (like kedit and gedit up to Gnome 2.8) do not understand the
-        '+NUMBER' parameter necessary for this feature. Good editors like
-        (X)Emacs, vi, jed, pico and joe all do.
-
-        - If the argument is not found as a variable, IPython will look for a
-        file with that name (adding .py if necessary) and load it into the
-        editor. It will execute its contents with execfile() when you exit,
-        loading any code in the file into your interactive namespace.
-
-        After executing your code, %edit will return as output the code you
-        typed in the editor (except when it was an existing file). This way
-        you can reload the code in further invocations of %edit as a variable,
-        via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
-        the output.
-
-        Note that %edit is also available through the alias %ed.
-
-        This is an example of creating a simple function inside the editor and
-        then modifying it. First, start up the editor:
-
-        In [1]: ed\
-        Editing... done. Executing edited code...\
-        Out[1]: 'def foo():\n    print "foo() was defined in an editing session"\n'
-
-        We can then call the function foo():
-        
-        In [2]: foo()\
-        foo() was defined in an editing session
-
-        Now we edit foo.  IPython automatically loads the editor with the
-        (temporary) file where foo() was previously defined:
-        
-        In [3]: ed foo\
-        Editing... done. Executing edited code...
-
-        And if we call foo() again we get the modified version:
-        
-        In [4]: foo()\
-        foo() has now been changed!
-
-        Here is an example of how to edit a code snippet successive
-        times. First we call the editor:
-
-        In [8]: ed\
-        Editing... done. Executing edited code...\
-        hello\
-        Out[8]: "print 'hello'\n"
-
-        Now we call it again with the previous output (stored in _):
-
-        In [9]: ed _\
-        Editing... done. Executing edited code...\
-        hello world\
-        Out[9]: "print 'hello world'\n"
-
-        Now we call it with the output #8 (stored in _8, also as Out[8]):
-
-        In [10]: ed _8\
-        Editing... done. Executing edited code...\
-        hello again\
-        Out[10]: "print 'hello again'\n"
-
-
-        Changing the default editor hook:
-
-        If you wish to write your own editor hook, you can put it in a
-        configuration file which you load at startup time.  The default hook
-        is defined in the IPython.hooks module, and you can use that as a
-        starting example for further modifications.  That file also has
-        general instructions on how to set a new hook for use once you've
-        defined it.
-
-**%env**::
-
-	List environment variables.
-
-**%exit**::
-
-	Exit IPython, confirming if configured to do so.
-
-        You can configure whether IPython asks for confirmation upon exit by
-        setting the confirm_exit flag in the ipythonrc file.
-
-**%hist**::
-
-	Alternate name for %history.
-
-**%history**::
-
-	Print input history (_i<n> variables), with most recent last.
-    
-    %history       -> print at most 40 inputs (some may be multi-line)\
-    %history n     -> print at most n inputs\
-    %history n1 n2 -> print inputs between n1 and n2 (n2 not included)\
-    
-    Each input's number <n> is shown, and is accessible as the
-    automatically generated variable _i<n>.  Multi-line statements are
-    printed starting at a new line for easy copy/paste.
-    
-
-    Options:
-
-      -n: do NOT print line numbers. This is useful if you want to get a
-      printout of many lines which can be directly pasted into a text
-      editor.
-
-      This feature is only available if numbered prompts are in use.
-
-      -t: (default) print the 'translated' history, as IPython understands it.
-      IPython filters your input and converts it all into valid Python source
-      before executing it (things like magics or aliases are turned into
-      function calls, for example). With this option, you'll see the native
-      history instead of the user-entered version: '%cd /' will be seen as
-      '_ip.magic("%cd /")' instead of '%cd /'.
-      
-      -r: print the 'raw' history, i.e. the actual commands you typed.
-      
-      -g: treat the arg as a pattern to grep for in (full) history.
-      This includes the "shadow history" (almost all commands ever written).
-      Use '%hist -g' to show full shadow history (may be very long).
-      In shadow history, every index nuwber starts with 0.
-
-      -f FILENAME: instead of printing the output to the screen, redirect it to
-       the given file.  The file is always overwritten, though IPython asks for
-       confirmation first if it already exists.
-
-**%logoff**::
-
-	Temporarily stop logging.
-
-        You must have previously started logging.
-
-**%logon**::
-
-	Restart logging.
-
-        This function is for restarting logging which you've temporarily
-        stopped with %logoff. For starting logging for the first time, you
-        must use the %logstart function, which allows you to specify an
-        optional log filename.
-
-**%logstart**::
-
-	Start logging anywhere in a session.
-
-        %logstart [-o|-r|-t] [log_name [log_mode]]
-
-        If no name is given, it defaults to a file named 'ipython_log.py' in your
-        current directory, in 'rotate' mode (see below).
-
-        '%logstart name' saves to file 'name' in 'backup' mode.  It saves your
-        history up to that point and then continues logging.
-
-        %logstart takes a second optional parameter: logging mode. This can be one
-        of (note that the modes are given unquoted):\
-          append: well, that says it.\
-          backup: rename (if exists) to name~ and start name.\
-          global: single logfile in your home dir, appended to.\
-          over  : overwrite existing log.\
-          rotate: create rotating logs name.1~, name.2~, etc.
-
-        Options:
-
-          -o: log also IPython's output.  In this mode, all commands which
-          generate an Out[NN] prompt are recorded to the logfile, right after
-          their corresponding input line.  The output lines are always
-          prepended with a '#[Out]# ' marker, so that the log remains valid
-          Python code.
-
-          Since this marker is always the same, filtering only the output from
-          a log is very easy, using for example a simple awk call:
-
-            awk -F'#\[Out\]# ' '{if($2) {print $2}}' ipython_log.py
-
-          -r: log 'raw' input.  Normally, IPython's logs contain the processed
-          input, so that user lines are logged in their final form, converted
-          into valid Python.  For example, %Exit is logged as
-          '_ip.magic("Exit").  If the -r flag is given, all input is logged
-          exactly as typed, with no transformations applied.
-
-          -t: put timestamps before each input line logged (these are put in
-          comments).
-
-**%logstate**::
-
-	Print the status of the logging system.
-
-**%logstop**::
-
-	Fully stop logging and close log file.
-
-        In order to start logging again, a new %logstart call needs to be made,
-        possibly (though not necessarily) with a new filename, mode and other
-        options.
-
-**%lsmagic**::
-
-	List currently available magic functions.
-
-**%macro**::
-
-	Define a set of input lines as a macro for future re-execution.
-
-        Usage:\
-          %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
-
-        Options:
-        
-          -r: use 'raw' input.  By default, the 'processed' history is used,
-          so that magics are loaded in their transformed version to valid
-          Python.  If this option is given, the raw input as typed as the
-          command line is used instead.
-
-        This will define a global variable called `name` which is a string
-        made of joining the slices and lines you specify (n1,n2,... numbers
-        above) from your input history into a single string. This variable
-        acts like an automatic function which re-executes those lines as if
-        you had typed them. You just type 'name' at the prompt and the code
-        executes.
-
-        The notation for indicating number ranges is: n1-n2 means 'use line
-        numbers n1,...n2' (the endpoint is included).  That is, '5-7' means
-        using the lines numbered 5,6 and 7.
-
-        Note: as a 'hidden' feature, you can also use traditional python slice
-        notation, where N:M means numbers N through M-1.
-
-        For example, if your history contains (%hist prints it):
-        
-          44: x=1\
-          45: y=3\
-          46: z=x+y\
-          47: print x\
-          48: a=5\
-          49: print 'x',x,'y',y\
-
-        you can create a macro with lines 44 through 47 (included) and line 49
-        called my_macro with:
-
-          In [51]: %macro my_macro 44-47 49
-
-        Now, typing `my_macro` (without quotes) will re-execute all this code
-        in one pass.
-
-        You don't need to give the line-numbers in order, and any given line
-        number can appear multiple times. You can assemble macros with any
-        lines from your input history in any order.
-
-        The macro is a simple object which holds its value in an attribute,
-        but IPython's display system checks for macros and executes them as
-        code instead of printing them when you type their name.
-
-        You can view a macro's contents by explicitly printing it with:
-        
-          'print macro_name'.
-
-        For one-off cases which DON'T contain magic function calls in them you
-        can obtain similar results by explicitly executing slices from your
-        input history with:
-
-          In [60]: exec In[44:48]+In[49]
-
-**%magic**::
-
-	Print information about the magic function system.
-
-**%mglob**::
-
-	    This program allows specifying filenames with "mglob" mechanism.
-    Supported syntax in globs (wilcard matching patterns)::
-    
-     *.cpp ?ellowo*                
-         - obvious. Differs from normal glob in that dirs are not included.
-           Unix users might want to write this as: "*.cpp" "?ellowo*"
-     rec:/usr/share=*.txt,*.doc    
-         - get all *.txt and *.doc under /usr/share, 
-           recursively
-     rec:/usr/share
-         - All files under /usr/share, recursively
-     rec:*.py
-         - All .py files under current working dir, recursively
-     foo                           
-         - File or dir foo
-     !*.bak readme*                   
-         - readme*, exclude files ending with .bak
-     !.svn/ !.hg/ !*_Data/ rec:.
-         - Skip .svn, .hg, foo_Data dirs (and their subdirs) in recurse.
-           Trailing / is the key, \ does not work!
-     dir:foo                       
-         - the directory foo if it exists (not files in foo)
-     dir:*                         
-         - all directories in current folder
-     foo.py bar.* !h* rec:*.py
-         - Obvious. !h* exclusion only applies for rec:*.py.
-           foo.py is *not* included twice.
-     @filelist.txt
-         - All files listed in 'filelist.txt' file, on separate lines.
-
-**%page**::
-
-	Pretty print the object and display it through a pager.
-        
-        %page [options] OBJECT
-
-        If no object is given, use _ (last output).
-        
-        Options:
-
-          -r: page str(object), don't pretty-print it.
-
-**%pdb**::
-
-	Control the automatic calling of the pdb interactive debugger.
-
-        Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
-        argument it works as a toggle.
-
-        When an exception is triggered, IPython can optionally call the
-        interactive pdb debugger after the traceback printout. %pdb toggles
-        this feature on and off.
-
-        The initial state of this feature is set in your ipythonrc
-        configuration file (the variable is called 'pdb').
-
-        If you want to just activate the debugger AFTER an exception has fired,
-        without having to type '%pdb on' and rerunning your code, you can use
-        the %debug magic.
-
-**%pdef**::
-
-	Print the definition header for any callable object.
-
-        If the object is a class, print the constructor information.
-
-**%pdoc**::
-
-	Print the docstring for an object.
-
-        If the given object is a class, it will print both the class and the
-        constructor docstrings.
-
-**%pfile**::
-
-	Print (or run through pager) the file where an object is defined.
-
-        The file opens at the line where the object definition begins. IPython
-        will honor the environment variable PAGER if set, and otherwise will
-        do its best to print the file in a convenient form.
-
-        If the given argument is not an object currently defined, IPython will
-        try to interpret it as a filename (automatically adding a .py extension
-        if needed). You can thus use %pfile as a syntax highlighting code
-        viewer.
-
-**%pinfo**::
-
-	Provide detailed information about an object.
-    
-        '%pinfo object' is just a synonym for object? or ?object.
-
-**%popd**::
-
-	Change to directory popped off the top of the stack.
-
-**%profile**::
-
-	Print your currently active IPyhton profile.
-
-**%prun**::
-
-	Run a statement through the python code profiler.
-
-        Usage:\
-          %prun [options] statement
-
-        The given statement (which doesn't require quote marks) is run via the
-        python profiler in a manner similar to the profile.run() function.
-        Namespaces are internally managed to work correctly; profile.run
-        cannot be used in IPython because it makes certain assumptions about
-        namespaces which do not hold under IPython.
-
-        Options:
-
-        -l <limit>: you can place restrictions on what or how much of the
-        profile gets printed. The limit value can be:
-
-          * A string: only information for function names containing this string
-          is printed.
-
-          * An integer: only these many lines are printed.
-
-          * A float (between 0 and 1): this fraction of the report is printed
-          (for example, use a limit of 0.4 to see the topmost 40% only).
-
-        You can combine several limits with repeated use of the option. For
-        example, '-l __init__ -l 5' will print only the topmost 5 lines of
-        information about class constructors.
-
-        -r: return the pstats.Stats object generated by the profiling. This
-        object has all the information about the profile in it, and you can
-        later use it for further analysis or in other functions.
-
-       -s <key>: sort profile by given key. You can provide more than one key
-        by using the option several times: '-s key1 -s key2 -s key3...'. The
-        default sorting key is 'time'.
-
-        The following is copied verbatim from the profile documentation
-        referenced below:
-
-        When more than one key is provided, additional keys are used as
-        secondary criteria when the there is equality in all keys selected
-        before them.
-        
-        Abbreviations can be used for any key names, as long as the
-        abbreviation is unambiguous.  The following are the keys currently
-        defined:
-
-                Valid Arg       Meaning\
-                  "calls"      call count\