##// END OF EJS Templates
- applied Nicolas Pernetty's patch to improve support for (X)Emacs under Win32....
fperez -
Show More
@@ -1,164 +1,170 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Tools for coloring text in ANSI terminals.
3 3
4 $Id: ColorANSI.py 1005 2006-01-12 08:39:26Z fperez $"""
4 $Id: ColorANSI.py 2152 2007-03-18 20:13:35Z fperez $"""
5 5
6 6 #*****************************************************************************
7 7 # Copyright (C) 2002-2006 Fernando Perez. <fperez@colorado.edu>
8 8 #
9 9 # Distributed under the terms of the BSD License. The full license is in
10 10 # the file COPYING, distributed as part of this software.
11 11 #*****************************************************************************
12 12
13 13 from IPython import Release
14 14 __author__ = '%s <%s>' % Release.authors['Fernando']
15 15 __license__ = Release.license
16 16
17 17 __all__ = ['TermColors','InputTermColors','ColorScheme','ColorSchemeTable']
18 18
19 19 import os
20 20
21 21 from IPython.ipstruct import Struct
22 22
23 23 def make_color_table(in_class):
24 24 """Build a set of color attributes in a class.
25 25
26 26 Helper function for building the *TermColors classes."""
27 27
28 28 color_templates = (
29 29 ("Black" , "0;30"),
30 30 ("Red" , "0;31"),
31 31 ("Green" , "0;32"),
32 32 ("Brown" , "0;33"),
33 33 ("Blue" , "0;34"),
34 34 ("Purple" , "0;35"),
35 35 ("Cyan" , "0;36"),
36 36 ("LightGray" , "0;37"),
37 37 ("DarkGray" , "1;30"),
38 38 ("LightRed" , "1;31"),
39 39 ("LightGreen" , "1;32"),
40 40 ("Yellow" , "1;33"),
41 41 ("LightBlue" , "1;34"),
42 42 ("LightPurple" , "1;35"),
43 43 ("LightCyan" , "1;36"),
44 44 ("White" , "1;37"), )
45 45
46 46 for name,value in color_templates:
47 47 setattr(in_class,name,in_class._base % value)
48 48
49 49 class TermColors:
50 50 """Color escape sequences.
51 51
52 52 This class defines the escape sequences for all the standard (ANSI?)
53 53 colors in terminals. Also defines a NoColor escape which is just the null
54 54 string, suitable for defining 'dummy' color schemes in terminals which get
55 55 confused by color escapes.
56 56
57 57 This class should be used as a mixin for building color schemes."""
58 58
59 59 NoColor = '' # for color schemes in color-less terminals.
60 60 Normal = '\033[0m' # Reset normal coloring
61 61 _base = '\033[%sm' # Template for all other colors
62 62
63 63 # Build the actual color table as a set of class attributes:
64 64 make_color_table(TermColors)
65 65
66 66 class InputTermColors:
67 67 """Color escape sequences for input prompts.
68 68
69 69 This class is similar to TermColors, but the escapes are wrapped in \001
70 70 and \002 so that readline can properly know the length of each line and
71 71 can wrap lines accordingly. Use this class for any colored text which
72 72 needs to be used in input prompts, such as in calls to raw_input().
73 73
74 74 This class defines the escape sequences for all the standard (ANSI?)
75 75 colors in terminals. Also defines a NoColor escape which is just the null
76 76 string, suitable for defining 'dummy' color schemes in terminals which get
77 77 confused by color escapes.
78 78
79 79 This class should be used as a mixin for building color schemes."""
80 80
81 81 NoColor = '' # for color schemes in color-less terminals.
82 Normal = '\001\033[0m\002' # Reset normal coloring
83 _base = '\001\033[%sm\002' # Template for all other colors
82
83 if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs':
84 # (X)emacs on W32 gets confused with \001 and \002 so we remove them
85 Normal = '\033[0m' # Reset normal coloring
86 _base = '\033[%sm' # Template for all other colors
87 else:
88 Normal = '\001\033[0m\002' # Reset normal coloring
89 _base = '\001\033[%sm\002' # Template for all other colors
84 90
85 91 # Build the actual color table as a set of class attributes:
86 92 make_color_table(InputTermColors)
87 93
88 94 class ColorScheme:
89 95 """Generic color scheme class. Just a name and a Struct."""
90 96 def __init__(self,__scheme_name_,colordict=None,**colormap):
91 97 self.name = __scheme_name_
92 98 if colordict is None:
93 99 self.colors = Struct(**colormap)
94 100 else:
95 101 self.colors = Struct(colordict)
96 102
97 103 def copy(self,name=None):
98 104 """Return a full copy of the object, optionally renaming it."""
99 105 if name is None:
100 106 name = self.name
101 107 return ColorScheme(name,self.colors.__dict__)
102 108
103 109 class ColorSchemeTable(dict):
104 110 """General class to handle tables of color schemes.
105 111
106 112 It's basically a dict of color schemes with a couple of shorthand
107 113 attributes and some convenient methods.
108 114
109 115 active_scheme_name -> obvious
110 116 active_colors -> actual color table of the active scheme"""
111 117
112 118 def __init__(self,scheme_list=None,default_scheme=''):
113 119 """Create a table of color schemes.
114 120
115 121 The table can be created empty and manually filled or it can be
116 122 created with a list of valid color schemes AND the specification for
117 123 the default active scheme.
118 124 """
119 125
120 126 # create object attributes to be set later
121 127 self.active_scheme_name = ''
122 128 self.active_colors = None
123 129
124 130 if scheme_list:
125 131 if default_scheme == '':
126 132 raise ValueError,'you must specify the default color scheme'
127 133 for scheme in scheme_list:
128 134 self.add_scheme(scheme)
129 135 self.set_active_scheme(default_scheme)
130 136
131 137 def copy(self):
132 138 """Return full copy of object"""
133 139 return ColorSchemeTable(self.values(),self.active_scheme_name)
134 140
135 141 def add_scheme(self,new_scheme):
136 142 """Add a new color scheme to the table."""
137 143 if not isinstance(new_scheme,ColorScheme):
138 144 raise ValueError,'ColorSchemeTable only accepts ColorScheme instances'
139 145 self[new_scheme.name] = new_scheme
140 146
141 147 def set_active_scheme(self,scheme,case_sensitive=0):
142 148 """Set the currently active scheme.
143 149
144 150 Names are by default compared in a case-insensitive way, but this can
145 151 be changed by setting the parameter case_sensitive to true."""
146 152
147 153 scheme_names = self.keys()
148 154 if case_sensitive:
149 155 valid_schemes = scheme_names
150 156 scheme_test = scheme
151 157 else:
152 158 valid_schemes = [s.lower() for s in scheme_names]
153 159 scheme_test = scheme.lower()
154 160 try:
155 161 scheme_idx = valid_schemes.index(scheme_test)
156 162 except ValueError:
157 163 raise ValueError,'Unrecognized color scheme: ' + scheme + \
158 164 '\nValid schemes: '+str(scheme_names).replace("'', ",'')
159 165 else:
160 166 active = scheme_names[scheme_idx]
161 167 self.active_scheme_name = active
162 168 self.active_colors = self[active].colors
163 169 # Now allow using '' as an index for the current active scheme
164 170 self[''] = self[active]
@@ -1,1751 +1,1752 b''
1 1 # -*- coding: utf-8 -*-
2 2 """
3 3 General purpose utilities.
4 4
5 5 This is a grab-bag of stuff I find useful in most programs I write. Some of
6 6 these things are also convenient when working at the command line.
7 7
8 $Id: genutils.py 2108 2007-02-23 00:31:17Z fperez $"""
8 $Id: genutils.py 2152 2007-03-18 20:13:35Z fperez $"""
9 9
10 10 #*****************************************************************************
11 11 # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu>
12 12 #
13 13 # Distributed under the terms of the BSD License. The full license is in
14 14 # the file COPYING, distributed as part of this software.
15 15 #*****************************************************************************
16 16
17 17 from IPython import Release
18 18 __author__ = '%s <%s>' % Release.authors['Fernando']
19 19 __license__ = Release.license
20 20
21 21 #****************************************************************************
22 22 # required modules from the Python standard library
23 23 import __main__
24 24 import commands
25 25 import os
26 26 import re
27 27 import shlex
28 28 import shutil
29 29 import sys
30 30 import tempfile
31 31 import time
32 32 import types
33 33 import warnings
34 34
35 35 # Other IPython utilities
36 36 from IPython.Itpl import Itpl,itpl,printpl
37 37 from IPython import DPyGetOpt
38 38 from path import path
39 39 if os.name == "nt":
40 40 from IPython.winconsole import get_console_size
41 41
42 42 #****************************************************************************
43 43 # Exceptions
44 44 class Error(Exception):
45 45 """Base class for exceptions in this module."""
46 46 pass
47 47
48 48 #----------------------------------------------------------------------------
49 49 class IOStream:
50 50 def __init__(self,stream,fallback):
51 51 if not hasattr(stream,'write') or not hasattr(stream,'flush'):
52 52 stream = fallback
53 53 self.stream = stream
54 54 self._swrite = stream.write
55 55 self.flush = stream.flush
56 56
57 57 def write(self,data):
58 58 try:
59 59 self._swrite(data)
60 60 except:
61 61 try:
62 62 # print handles some unicode issues which may trip a plain
63 63 # write() call. Attempt to emulate write() by using a
64 64 # trailing comma
65 65 print >> self.stream, data,
66 66 except:
67 67 # if we get here, something is seriously broken.
68 68 print >> sys.stderr, \
69 69 'ERROR - failed to write data to stream:', self.stream
70 70
71 71 class IOTerm:
72 72 """ Term holds the file or file-like objects for handling I/O operations.
73 73
74 74 These are normally just sys.stdin, sys.stdout and sys.stderr but for
75 75 Windows they can can replaced to allow editing the strings before they are
76 76 displayed."""
77 77
78 78 # In the future, having IPython channel all its I/O operations through
79 79 # this class will make it easier to embed it into other environments which
80 80 # are not a normal terminal (such as a GUI-based shell)
81 81 def __init__(self,cin=None,cout=None,cerr=None):
82 82 self.cin = IOStream(cin,sys.stdin)
83 83 self.cout = IOStream(cout,sys.stdout)
84 84 self.cerr = IOStream(cerr,sys.stderr)
85 85
86 86 # Global variable to be used for all I/O
87 87 Term = IOTerm()
88 88
89 89 import IPython.rlineimpl as readline
90 90 # Remake Term to use the readline i/o facilities
91 91 if sys.platform == 'win32' and readline.have_readline:
92 92
93 93 Term = IOTerm(cout=readline._outputfile,cerr=readline._outputfile)
94 94
95 95
96 96 #****************************************************************************
97 97 # Generic warning/error printer, used by everything else
98 98 def warn(msg,level=2,exit_val=1):
99 99 """Standard warning printer. Gives formatting consistency.
100 100
101 101 Output is sent to Term.cerr (sys.stderr by default).
102 102
103 103 Options:
104 104
105 105 -level(2): allows finer control:
106 106 0 -> Do nothing, dummy function.
107 107 1 -> Print message.
108 108 2 -> Print 'WARNING:' + message. (Default level).
109 109 3 -> Print 'ERROR:' + message.
110 110 4 -> Print 'FATAL ERROR:' + message and trigger a sys.exit(exit_val).
111 111
112 112 -exit_val (1): exit value returned by sys.exit() for a level 4
113 113 warning. Ignored for all other levels."""
114 114
115 115 if level>0:
116 116 header = ['','','WARNING: ','ERROR: ','FATAL ERROR: ']
117 117 print >> Term.cerr, '%s%s' % (header[level],msg)
118 118 if level == 4:
119 119 print >> Term.cerr,'Exiting.\n'
120 120 sys.exit(exit_val)
121 121
122 122 def info(msg):
123 123 """Equivalent to warn(msg,level=1)."""
124 124
125 125 warn(msg,level=1)
126 126
127 127 def error(msg):
128 128 """Equivalent to warn(msg,level=3)."""
129 129
130 130 warn(msg,level=3)
131 131
132 132 def fatal(msg,exit_val=1):
133 133 """Equivalent to warn(msg,exit_val=exit_val,level=4)."""
134 134
135 135 warn(msg,exit_val=exit_val,level=4)
136 136
137 137 #---------------------------------------------------------------------------
138 138 # Debugging routines
139 139 #
140 140 def debugx(expr,pre_msg=''):
141 141 """Print the value of an expression from the caller's frame.
142 142
143 143 Takes an expression, evaluates it in the caller's frame and prints both
144 144 the given expression and the resulting value (as well as a debug mark
145 145 indicating the name of the calling function. The input must be of a form
146 146 suitable for eval().
147 147
148 148 An optional message can be passed, which will be prepended to the printed
149 149 expr->value pair."""
150 150
151 151 cf = sys._getframe(1)
152 152 print '[DBG:%s] %s%s -> %r' % (cf.f_code.co_name,pre_msg,expr,
153 153 eval(expr,cf.f_globals,cf.f_locals))
154 154
155 155 # deactivate it by uncommenting the following line, which makes it a no-op
156 156 #def debugx(expr,pre_msg=''): pass
157 157
158 158 #----------------------------------------------------------------------------
159 159 StringTypes = types.StringTypes
160 160
161 161 # Basic timing functionality
162 162
163 163 # If possible (Unix), use the resource module instead of time.clock()
164 164 try:
165 165 import resource
166 166 def clocku():
167 167 """clocku() -> floating point number
168 168
169 169 Return the *USER* CPU time in seconds since the start of the process.
170 170 This is done via a call to resource.getrusage, so it avoids the
171 171 wraparound problems in time.clock()."""
172 172
173 173 return resource.getrusage(resource.RUSAGE_SELF)[0]
174 174
175 175 def clocks():
176 176 """clocks() -> floating point number
177 177
178 178 Return the *SYSTEM* CPU time in seconds since the start of the process.
179 179 This is done via a call to resource.getrusage, so it avoids the
180 180 wraparound problems in time.clock()."""
181 181
182 182 return resource.getrusage(resource.RUSAGE_SELF)[1]
183 183
184 184 def clock():
185 185 """clock() -> floating point number
186 186
187 187 Return the *TOTAL USER+SYSTEM* CPU time in seconds since the start of
188 188 the process. This is done via a call to resource.getrusage, so it
189 189 avoids the wraparound problems in time.clock()."""
190 190
191 191 u,s = resource.getrusage(resource.RUSAGE_SELF)[:2]
192 192 return u+s
193 193
194 194 def clock2():
195 195 """clock2() -> (t_user,t_system)
196 196
197 197 Similar to clock(), but return a tuple of user/system times."""
198 198 return resource.getrusage(resource.RUSAGE_SELF)[:2]
199 199
200 200 except ImportError:
201 201 # There is no distinction of user/system time under windows, so we just use
202 202 # time.clock() for everything...
203 203 clocku = clocks = clock = time.clock
204 204 def clock2():
205 205 """Under windows, system CPU time can't be measured.
206 206
207 207 This just returns clock() and zero."""
208 208 return time.clock(),0.0
209 209
210 210 def timings_out(reps,func,*args,**kw):
211 211 """timings_out(reps,func,*args,**kw) -> (t_total,t_per_call,output)
212 212
213 213 Execute a function reps times, return a tuple with the elapsed total
214 214 CPU time in seconds, the time per call and the function's output.
215 215
216 216 Under Unix, the return value is the sum of user+system time consumed by
217 217 the process, computed via the resource module. This prevents problems
218 218 related to the wraparound effect which the time.clock() function has.
219 219
220 220 Under Windows the return value is in wall clock seconds. See the
221 221 documentation for the time module for more details."""
222 222
223 223 reps = int(reps)
224 224 assert reps >=1, 'reps must be >= 1'
225 225 if reps==1:
226 226 start = clock()
227 227 out = func(*args,**kw)
228 228 tot_time = clock()-start
229 229 else:
230 230 rng = xrange(reps-1) # the last time is executed separately to store output
231 231 start = clock()
232 232 for dummy in rng: func(*args,**kw)
233 233 out = func(*args,**kw) # one last time
234 234 tot_time = clock()-start
235 235 av_time = tot_time / reps
236 236 return tot_time,av_time,out
237 237
238 238 def timings(reps,func,*args,**kw):
239 239 """timings(reps,func,*args,**kw) -> (t_total,t_per_call)
240 240
241 241 Execute a function reps times, return a tuple with the elapsed total CPU
242 242 time in seconds and the time per call. These are just the first two values
243 243 in timings_out()."""
244 244
245 245 return timings_out(reps,func,*args,**kw)[0:2]
246 246
247 247 def timing(func,*args,**kw):
248 248 """timing(func,*args,**kw) -> t_total
249 249
250 250 Execute a function once, return the elapsed total CPU time in
251 251 seconds. This is just the first value in timings_out()."""
252 252
253 253 return timings_out(1,func,*args,**kw)[0]
254 254
255 255 #****************************************************************************
256 256 # file and system
257 257
258 258 def arg_split(s,posix=False):
259 259 """Split a command line's arguments in a shell-like manner.
260 260
261 261 This is a modified version of the standard library's shlex.split()
262 262 function, but with a default of posix=False for splitting, so that quotes
263 263 in inputs are respected."""
264 264
265 265 lex = shlex.shlex(s, posix=posix)
266 266 lex.whitespace_split = True
267 267 return list(lex)
268 268
269 269 def system(cmd,verbose=0,debug=0,header=''):
270 270 """Execute a system command, return its exit status.
271 271
272 272 Options:
273 273
274 274 - verbose (0): print the command to be executed.
275 275
276 276 - debug (0): only print, do not actually execute.
277 277
278 278 - header (''): Header to print on screen prior to the executed command (it
279 279 is only prepended to the command, no newlines are added).
280 280
281 281 Note: a stateful version of this function is available through the
282 282 SystemExec class."""
283 283
284 284 stat = 0
285 285 if verbose or debug: print header+cmd
286 286 sys.stdout.flush()
287 287 if not debug: stat = os.system(cmd)
288 288 return stat
289 289
290 290 # This function is used by ipython in a lot of places to make system calls.
291 291 # We need it to be slightly different under win32, due to the vagaries of
292 292 # 'network shares'. A win32 override is below.
293 293
294 294 def shell(cmd,verbose=0,debug=0,header=''):
295 295 """Execute a command in the system shell, always return None.
296 296
297 297 Options:
298 298
299 299 - verbose (0): print the command to be executed.
300 300
301 301 - debug (0): only print, do not actually execute.
302 302
303 303 - header (''): Header to print on screen prior to the executed command (it
304 304 is only prepended to the command, no newlines are added).
305 305
306 306 Note: this is similar to genutils.system(), but it returns None so it can
307 307 be conveniently used in interactive loops without getting the return value
308 308 (typically 0) printed many times."""
309 309
310 310 stat = 0
311 311 if verbose or debug: print header+cmd
312 312 # flush stdout so we don't mangle python's buffering
313 313 sys.stdout.flush()
314 314 if not debug:
315 315 os.system(cmd)
316 316
317 317 # override shell() for win32 to deal with network shares
318 318 if os.name in ('nt','dos'):
319 319
320 320 shell_ori = shell
321 321
322 322 def shell(cmd,verbose=0,debug=0,header=''):
323 323 if os.getcwd().startswith(r"\\"):
324 324 path = os.getcwd()
325 325 # change to c drive (cannot be on UNC-share when issuing os.system,
326 326 # as cmd.exe cannot handle UNC addresses)
327 327 os.chdir("c:")
328 328 # issue pushd to the UNC-share and then run the command
329 329 try:
330 330 shell_ori('"pushd %s&&"'%path+cmd,verbose,debug,header)
331 331 finally:
332 332 os.chdir(path)
333 333 else:
334 334 shell_ori(cmd,verbose,debug,header)
335 335
336 336 shell.__doc__ = shell_ori.__doc__
337 337
338 338 def getoutput(cmd,verbose=0,debug=0,header='',split=0):
339 339 """Dummy substitute for perl's backquotes.
340 340
341 341 Executes a command and returns the output.
342 342
343 343 Accepts the same arguments as system(), plus:
344 344
345 345 - split(0): if true, the output is returned as a list split on newlines.
346 346
347 347 Note: a stateful version of this function is available through the
348 348 SystemExec class.
349 349
350 350 This is pretty much deprecated and rarely used,
351 351 genutils.getoutputerror may be what you need.
352 352
353 353 """
354 354
355 355 if verbose or debug: print header+cmd
356 356 if not debug:
357 357 output = os.popen(cmd).read()
358 358 # stipping last \n is here for backwards compat.
359 359 if output.endswith('\n'):
360 360 output = output[:-1]
361 361 if split:
362 362 return output.split('\n')
363 363 else:
364 364 return output
365 365
366 366 def getoutputerror(cmd,verbose=0,debug=0,header='',split=0):
367 367 """Return (standard output,standard error) of executing cmd in a shell.
368 368
369 369 Accepts the same arguments as system(), plus:
370 370
371 371 - split(0): if true, each of stdout/err is returned as a list split on
372 372 newlines.
373 373
374 374 Note: a stateful version of this function is available through the
375 375 SystemExec class."""
376 376
377 377 if verbose or debug: print header+cmd
378 378 if not cmd:
379 379 if split:
380 380 return [],[]
381 381 else:
382 382 return '',''
383 383 if not debug:
384 384 pin,pout,perr = os.popen3(cmd)
385 385 tout = pout.read().rstrip()
386 386 terr = perr.read().rstrip()
387 387 pin.close()
388 388 pout.close()
389 389 perr.close()
390 390 if split:
391 391 return tout.split('\n'),terr.split('\n')
392 392 else:
393 393 return tout,terr
394 394
395 395 # for compatibility with older naming conventions
396 396 xsys = system
397 397 bq = getoutput
398 398
399 399 class SystemExec:
400 400 """Access the system and getoutput functions through a stateful interface.
401 401
402 402 Note: here we refer to the system and getoutput functions from this
403 403 library, not the ones from the standard python library.
404 404
405 405 This class offers the system and getoutput functions as methods, but the
406 406 verbose, debug and header parameters can be set for the instance (at
407 407 creation time or later) so that they don't need to be specified on each
408 408 call.
409 409
410 410 For efficiency reasons, there's no way to override the parameters on a
411 411 per-call basis other than by setting instance attributes. If you need
412 412 local overrides, it's best to directly call system() or getoutput().
413 413
414 414 The following names are provided as alternate options:
415 415 - xsys: alias to system
416 416 - bq: alias to getoutput
417 417
418 418 An instance can then be created as:
419 419 >>> sysexec = SystemExec(verbose=1,debug=0,header='Calling: ')
420 420
421 421 And used as:
422 422 >>> sysexec.xsys('pwd')
423 423 >>> dirlist = sysexec.bq('ls -l')
424 424 """
425 425
426 426 def __init__(self,verbose=0,debug=0,header='',split=0):
427 427 """Specify the instance's values for verbose, debug and header."""
428 428 setattr_list(self,'verbose debug header split')
429 429
430 430 def system(self,cmd):
431 431 """Stateful interface to system(), with the same keyword parameters."""
432 432
433 433 system(cmd,self.verbose,self.debug,self.header)
434 434
435 435 def shell(self,cmd):
436 436 """Stateful interface to shell(), with the same keyword parameters."""
437 437
438 438 shell(cmd,self.verbose,self.debug,self.header)
439 439
440 440 xsys = system # alias
441 441
442 442 def getoutput(self,cmd):
443 443 """Stateful interface to getoutput()."""
444 444
445 445 return getoutput(cmd,self.verbose,self.debug,self.header,self.split)
446 446
447 447 def getoutputerror(self,cmd):
448 448 """Stateful interface to getoutputerror()."""
449 449
450 450 return getoutputerror(cmd,self.verbose,self.debug,self.header,self.split)
451 451
452 452 bq = getoutput # alias
453 453
454 454 #-----------------------------------------------------------------------------
455 455 def mutex_opts(dict,ex_op):
456 456 """Check for presence of mutually exclusive keys in a dict.
457 457
458 458 Call: mutex_opts(dict,[[op1a,op1b],[op2a,op2b]...]"""
459 459 for op1,op2 in ex_op:
460 460 if op1 in dict and op2 in dict:
461 461 raise ValueError,'\n*** ERROR in Arguments *** '\
462 462 'Options '+op1+' and '+op2+' are mutually exclusive.'
463 463
464 464 #-----------------------------------------------------------------------------
465 465 def get_py_filename(name):
466 466 """Return a valid python filename in the current directory.
467 467
468 468 If the given name is not a file, it adds '.py' and searches again.
469 469 Raises IOError with an informative message if the file isn't found."""
470 470
471 471 name = os.path.expanduser(name)
472 472 if not os.path.isfile(name) and not name.endswith('.py'):
473 473 name += '.py'
474 474 if os.path.isfile(name):
475 475 return name
476 476 else:
477 477 raise IOError,'File `%s` not found.' % name
478 478
479 479 #-----------------------------------------------------------------------------
480 480 def filefind(fname,alt_dirs = None):
481 481 """Return the given filename either in the current directory, if it
482 482 exists, or in a specified list of directories.
483 483
484 484 ~ expansion is done on all file and directory names.
485 485
486 486 Upon an unsuccessful search, raise an IOError exception."""
487 487
488 488 if alt_dirs is None:
489 489 try:
490 490 alt_dirs = get_home_dir()
491 491 except HomeDirError:
492 492 alt_dirs = os.getcwd()
493 493 search = [fname] + list_strings(alt_dirs)
494 494 search = map(os.path.expanduser,search)
495 495 #print 'search list for',fname,'list:',search # dbg
496 496 fname = search[0]
497 497 if os.path.isfile(fname):
498 498 return fname
499 499 for direc in search[1:]:
500 500 testname = os.path.join(direc,fname)
501 501 #print 'testname',testname # dbg
502 502 if os.path.isfile(testname):
503 503 return testname
504 504 raise IOError,'File' + `fname` + \
505 505 ' not found in current or supplied directories:' + `alt_dirs`
506 506
507 507 #----------------------------------------------------------------------------
508 508 def file_read(filename):
509 509 """Read a file and close it. Returns the file source."""
510 510 fobj = open(filename,'r');
511 511 source = fobj.read();
512 512 fobj.close()
513 513 return source
514 514
515 515 def file_readlines(filename):
516 516 """Read a file and close it. Returns the file source using readlines()."""
517 517 fobj = open(filename,'r');
518 518 lines = fobj.readlines();
519 519 fobj.close()
520 520 return lines
521 521
522 522 #----------------------------------------------------------------------------
523 523 def target_outdated(target,deps):
524 524 """Determine whether a target is out of date.
525 525
526 526 target_outdated(target,deps) -> 1/0
527 527
528 528 deps: list of filenames which MUST exist.
529 529 target: single filename which may or may not exist.
530 530
531 531 If target doesn't exist or is older than any file listed in deps, return
532 532 true, otherwise return false.
533 533 """
534 534 try:
535 535 target_time = os.path.getmtime(target)
536 536 except os.error:
537 537 return 1
538 538 for dep in deps:
539 539 dep_time = os.path.getmtime(dep)
540 540 if dep_time > target_time:
541 541 #print "For target",target,"Dep failed:",dep # dbg
542 542 #print "times (dep,tar):",dep_time,target_time # dbg
543 543 return 1
544 544 return 0
545 545
546 546 #-----------------------------------------------------------------------------
547 547 def target_update(target,deps,cmd):
548 548 """Update a target with a given command given a list of dependencies.
549 549
550 550 target_update(target,deps,cmd) -> runs cmd if target is outdated.
551 551
552 552 This is just a wrapper around target_outdated() which calls the given
553 553 command if target is outdated."""
554 554
555 555 if target_outdated(target,deps):
556 556 xsys(cmd)
557 557
558 558 #----------------------------------------------------------------------------
559 559 def unquote_ends(istr):
560 560 """Remove a single pair of quotes from the endpoints of a string."""
561 561
562 562 if not istr:
563 563 return istr
564 564 if (istr[0]=="'" and istr[-1]=="'") or \
565 565 (istr[0]=='"' and istr[-1]=='"'):
566 566 return istr[1:-1]
567 567 else:
568 568 return istr
569 569
570 570 #----------------------------------------------------------------------------
571 571 def process_cmdline(argv,names=[],defaults={},usage=''):
572 572 """ Process command-line options and arguments.
573 573
574 574 Arguments:
575 575
576 576 - argv: list of arguments, typically sys.argv.
577 577
578 578 - names: list of option names. See DPyGetOpt docs for details on options
579 579 syntax.
580 580
581 581 - defaults: dict of default values.
582 582
583 583 - usage: optional usage notice to print if a wrong argument is passed.
584 584
585 585 Return a dict of options and a list of free arguments."""
586 586
587 587 getopt = DPyGetOpt.DPyGetOpt()
588 588 getopt.setIgnoreCase(0)
589 589 getopt.parseConfiguration(names)
590 590
591 591 try:
592 592 getopt.processArguments(argv)
593 593 except:
594 594 print usage
595 595 warn(`sys.exc_value`,level=4)
596 596
597 597 defaults.update(getopt.optionValues)
598 598 args = getopt.freeValues
599 599
600 600 return defaults,args
601 601
602 602 #----------------------------------------------------------------------------
603 603 def optstr2types(ostr):
604 604 """Convert a string of option names to a dict of type mappings.
605 605
606 606 optstr2types(str) -> {None:'string_opts',int:'int_opts',float:'float_opts'}
607 607
608 608 This is used to get the types of all the options in a string formatted
609 609 with the conventions of DPyGetOpt. The 'type' None is used for options
610 610 which are strings (they need no further conversion). This function's main
611 611 use is to get a typemap for use with read_dict().
612 612 """
613 613
614 614 typeconv = {None:'',int:'',float:''}
615 615 typemap = {'s':None,'i':int,'f':float}
616 616 opt_re = re.compile(r'([\w]*)([^:=]*:?=?)([sif]?)')
617 617
618 618 for w in ostr.split():
619 619 oname,alias,otype = opt_re.match(w).groups()
620 620 if otype == '' or alias == '!': # simple switches are integers too
621 621 otype = 'i'
622 622 typeconv[typemap[otype]] += oname + ' '
623 623 return typeconv
624 624
625 625 #----------------------------------------------------------------------------
626 626 def read_dict(filename,type_conv=None,**opt):
627 627
628 628 """Read a dictionary of key=value pairs from an input file, optionally
629 629 performing conversions on the resulting values.
630 630
631 631 read_dict(filename,type_conv,**opt) -> dict
632 632
633 633 Only one value per line is accepted, the format should be
634 634 # optional comments are ignored
635 635 key value\n
636 636
637 637 Args:
638 638
639 639 - type_conv: A dictionary specifying which keys need to be converted to
640 640 which types. By default all keys are read as strings. This dictionary
641 641 should have as its keys valid conversion functions for strings
642 642 (int,long,float,complex, or your own). The value for each key
643 643 (converter) should be a whitespace separated string containing the names
644 644 of all the entries in the file to be converted using that function. For
645 645 keys to be left alone, use None as the conversion function (only needed
646 646 with purge=1, see below).
647 647
648 648 - opt: dictionary with extra options as below (default in parens)
649 649
650 650 purge(0): if set to 1, all keys *not* listed in type_conv are purged out
651 651 of the dictionary to be returned. If purge is going to be used, the
652 652 set of keys to be left as strings also has to be explicitly specified
653 653 using the (non-existent) conversion function None.
654 654
655 655 fs(None): field separator. This is the key/value separator to be used
656 656 when parsing the file. The None default means any whitespace [behavior
657 657 of string.split()].
658 658
659 659 strip(0): if 1, strip string values of leading/trailinig whitespace.
660 660
661 661 warn(1): warning level if requested keys are not found in file.
662 662 - 0: silently ignore.
663 663 - 1: inform but proceed.
664 664 - 2: raise KeyError exception.
665 665
666 666 no_empty(0): if 1, remove keys with whitespace strings as a value.
667 667
668 668 unique([]): list of keys (or space separated string) which can't be
669 669 repeated. If one such key is found in the file, each new instance
670 670 overwrites the previous one. For keys not listed here, the behavior is
671 671 to make a list of all appearances.
672 672
673 673 Example:
674 674 If the input file test.ini has:
675 675 i 3
676 676 x 4.5
677 677 y 5.5
678 678 s hi ho
679 679 Then:
680 680
681 681 >>> type_conv={int:'i',float:'x',None:'s'}
682 682 >>> read_dict('test.ini')
683 683 {'i': '3', 's': 'hi ho', 'x': '4.5', 'y': '5.5'}
684 684 >>> read_dict('test.ini',type_conv)
685 685 {'i': 3, 's': 'hi ho', 'x': 4.5, 'y': '5.5'}
686 686 >>> read_dict('test.ini',type_conv,purge=1)
687 687 {'i': 3, 's': 'hi ho', 'x': 4.5}
688 688 """
689 689
690 690 # starting config
691 691 opt.setdefault('purge',0)
692 692 opt.setdefault('fs',None) # field sep defaults to any whitespace
693 693 opt.setdefault('strip',0)
694 694 opt.setdefault('warn',1)
695 695 opt.setdefault('no_empty',0)
696 696 opt.setdefault('unique','')
697 697 if type(opt['unique']) in StringTypes:
698 698 unique_keys = qw(opt['unique'])
699 699 elif type(opt['unique']) in (types.TupleType,types.ListType):
700 700 unique_keys = opt['unique']
701 701 else:
702 702 raise ValueError, 'Unique keys must be given as a string, List or Tuple'
703 703
704 704 dict = {}
705 705 # first read in table of values as strings
706 706 file = open(filename,'r')
707 707 for line in file.readlines():
708 708 line = line.strip()
709 709 if len(line) and line[0]=='#': continue
710 710 if len(line)>0:
711 711 lsplit = line.split(opt['fs'],1)
712 712 try:
713 713 key,val = lsplit
714 714 except ValueError:
715 715 key,val = lsplit[0],''
716 716 key = key.strip()
717 717 if opt['strip']: val = val.strip()
718 718 if val == "''" or val == '""': val = ''
719 719 if opt['no_empty'] and (val=='' or val.isspace()):
720 720 continue
721 721 # if a key is found more than once in the file, build a list
722 722 # unless it's in the 'unique' list. In that case, last found in file
723 723 # takes precedence. User beware.
724 724 try:
725 725 if dict[key] and key in unique_keys:
726 726 dict[key] = val
727 727 elif type(dict[key]) is types.ListType:
728 728 dict[key].append(val)
729 729 else:
730 730 dict[key] = [dict[key],val]
731 731 except KeyError:
732 732 dict[key] = val
733 733 # purge if requested
734 734 if opt['purge']:
735 735 accepted_keys = qwflat(type_conv.values())
736 736 for key in dict.keys():
737 737 if key in accepted_keys: continue
738 738 del(dict[key])
739 739 # now convert if requested
740 740 if type_conv==None: return dict
741 741 conversions = type_conv.keys()
742 742 try: conversions.remove(None)
743 743 except: pass
744 744 for convert in conversions:
745 745 for val in qw(type_conv[convert]):
746 746 try:
747 747 dict[val] = convert(dict[val])
748 748 except KeyError,e:
749 749 if opt['warn'] == 0:
750 750 pass
751 751 elif opt['warn'] == 1:
752 752 print >>sys.stderr, 'Warning: key',val,\
753 753 'not found in file',filename
754 754 elif opt['warn'] == 2:
755 755 raise KeyError,e
756 756 else:
757 757 raise ValueError,'Warning level must be 0,1 or 2'
758 758
759 759 return dict
760 760
761 761 #----------------------------------------------------------------------------
762 762 def flag_calls(func):
763 763 """Wrap a function to detect and flag when it gets called.
764 764
765 765 This is a decorator which takes a function and wraps it in a function with
766 766 a 'called' attribute. wrapper.called is initialized to False.
767 767
768 768 The wrapper.called attribute is set to False right before each call to the
769 769 wrapped function, so if the call fails it remains False. After the call
770 770 completes, wrapper.called is set to True and the output is returned.
771 771
772 772 Testing for truth in wrapper.called allows you to determine if a call to
773 773 func() was attempted and succeeded."""
774 774
775 775 def wrapper(*args,**kw):
776 776 wrapper.called = False
777 777 out = func(*args,**kw)
778 778 wrapper.called = True
779 779 return out
780 780
781 781 wrapper.called = False
782 782 wrapper.__doc__ = func.__doc__
783 783 return wrapper
784 784
785 785 #----------------------------------------------------------------------------
786 786 class HomeDirError(Error):
787 787 pass
788 788
789 789 def get_home_dir():
790 790 """Return the closest possible equivalent to a 'home' directory.
791 791
792 792 We first try $HOME. Absent that, on NT it's $HOMEDRIVE\$HOMEPATH.
793 793
794 794 Currently only Posix and NT are implemented, a HomeDirError exception is
795 795 raised for all other OSes. """
796 796
797 797 isdir = os.path.isdir
798 798 env = os.environ
799 799 try:
800 800 homedir = env['HOME']
801 801 if not isdir(homedir):
802 802 # in case a user stuck some string which does NOT resolve to a
803 803 # valid path, it's as good as if we hadn't foud it
804 804 raise KeyError
805 805 return homedir
806 806 except KeyError:
807 807 if os.name == 'posix':
808 808 raise HomeDirError,'undefined $HOME, IPython can not proceed.'
809 809 elif os.name == 'nt':
810 810 # For some strange reason, win9x returns 'nt' for os.name.
811 811 try:
812 812 homedir = os.path.join(env['HOMEDRIVE'],env['HOMEPATH'])
813 813 if not isdir(homedir):
814 814 homedir = os.path.join(env['USERPROFILE'])
815 815 if not isdir(homedir):
816 816 raise HomeDirError
817 817 return homedir
818 818 except:
819 819 try:
820 820 # Use the registry to get the 'My Documents' folder.
821 821 import _winreg as wreg
822 822 key = wreg.OpenKey(wreg.HKEY_CURRENT_USER,
823 823 "Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders")
824 824 homedir = wreg.QueryValueEx(key,'Personal')[0]
825 825 key.Close()
826 826 if not isdir(homedir):
827 827 e = ('Invalid "Personal" folder registry key '
828 828 'typically "My Documents".\n'
829 829 'Value: %s\n'
830 830 'This is not a valid directory on your system.' %
831 831 homedir)
832 832 raise HomeDirError(e)
833 833 return homedir
834 834 except HomeDirError:
835 835 raise
836 836 except:
837 837 return 'C:\\'
838 838 elif os.name == 'dos':
839 839 # Desperate, may do absurd things in classic MacOS. May work under DOS.
840 840 return 'C:\\'
841 841 else:
842 842 raise HomeDirError,'support for your operating system not implemented.'
843 843
844 844 #****************************************************************************
845 845 # strings and text
846 846
847 847 class LSString(str):
848 848 """String derivative with a special access attributes.
849 849
850 850 These are normal strings, but with the special attributes:
851 851
852 852 .l (or .list) : value as list (split on newlines).
853 853 .n (or .nlstr): original value (the string itself).
854 854 .s (or .spstr): value as whitespace-separated string.
855 855
856 856 Any values which require transformations are computed only once and
857 857 cached.
858 858
859 859 Such strings are very useful to efficiently interact with the shell, which
860 860 typically only understands whitespace-separated options for commands."""
861 861
862 862 def get_list(self):
863 863 try:
864 864 return self.__list
865 865 except AttributeError:
866 866 self.__list = self.split('\n')
867 867 return self.__list
868 868
869 869 l = list = property(get_list)
870 870
871 871 def get_spstr(self):
872 872 try:
873 873 return self.__spstr
874 874 except AttributeError:
875 875 self.__spstr = self.replace('\n',' ')
876 876 return self.__spstr
877 877
878 878 s = spstr = property(get_spstr)
879 879
880 880 def get_nlstr(self):
881 881 return self
882 882
883 883 n = nlstr = property(get_nlstr)
884 884
885 885 def get_paths(self):
886 886 try:
887 887 return self.__paths
888 888 except AttributeError:
889 889 self.__paths = [path(p) for p in self.split('\n') if os.path.exists(p)]
890 890 return self.__paths
891 891
892 892 p = paths = property(get_paths)
893 893
894 894
895 895 #----------------------------------------------------------------------------
896 896 class SList(list):
897 897 """List derivative with a special access attributes.
898 898
899 899 These are normal lists, but with the special attributes:
900 900
901 901 .l (or .list) : value as list (the list itself).
902 902 .n (or .nlstr): value as a string, joined on newlines.
903 903 .s (or .spstr): value as a string, joined on spaces.
904 904
905 905 Any values which require transformations are computed only once and
906 906 cached."""
907 907
908 908 def get_list(self):
909 909 return self
910 910
911 911 l = list = property(get_list)
912 912
913 913 def get_spstr(self):
914 914 try:
915 915 return self.__spstr
916 916 except AttributeError:
917 917 self.__spstr = ' '.join(self)
918 918 return self.__spstr
919 919
920 920 s = spstr = property(get_spstr)
921 921
922 922 def get_nlstr(self):
923 923 try:
924 924 return self.__nlstr
925 925 except AttributeError:
926 926 self.__nlstr = '\n'.join(self)
927 927 return self.__nlstr
928 928
929 929 n = nlstr = property(get_nlstr)
930 930
931 931 def get_paths(self):
932 932 try:
933 933 return self.__paths
934 934 except AttributeError:
935 935 self.__paths = [path(p) for p in self if os.path.exists(p)]
936 936 return self.__paths
937 937
938 938 p = paths = property(get_paths)
939 939
940 940 #----------------------------------------------------------------------------
941 941 def esc_quotes(strng):
942 942 """Return the input string with single and double quotes escaped out"""
943 943
944 944 return strng.replace('"','\\"').replace("'","\\'")
945 945
946 946 #----------------------------------------------------------------------------
947 947 def make_quoted_expr(s):
948 948 """Return string s in appropriate quotes, using raw string if possible.
949 949
950 950 Effectively this turns string: cd \ao\ao\
951 951 to: r"cd \ao\ao\_"[:-1]
952 952
953 953 Note the use of raw string and padding at the end to allow trailing backslash.
954 954
955 955 """
956 956
957 957 tail = ''
958 958 tailpadding = ''
959 959 raw = ''
960 960 if "\\" in s:
961 961 raw = 'r'
962 962 if s.endswith('\\'):
963 963 tail = '[:-1]'
964 964 tailpadding = '_'
965 965 if '"' not in s:
966 966 quote = '"'
967 967 elif "'" not in s:
968 968 quote = "'"
969 969 elif '"""' not in s and not s.endswith('"'):
970 970 quote = '"""'
971 971 elif "'''" not in s and not s.endswith("'"):
972 972 quote = "'''"
973 973 else:
974 974 # give up, backslash-escaped string will do
975 975 return '"%s"' % esc_quotes(s)
976 976 res = itpl("$raw$quote$s$tailpadding$quote$tail")
977 977 return res
978 978
979 979
980 980 #----------------------------------------------------------------------------
981 981 def raw_input_multi(header='', ps1='==> ', ps2='..> ',terminate_str = '.'):
982 982 """Take multiple lines of input.
983 983
984 984 A list with each line of input as a separate element is returned when a
985 985 termination string is entered (defaults to a single '.'). Input can also
986 986 terminate via EOF (^D in Unix, ^Z-RET in Windows).
987 987
988 988 Lines of input which end in \\ are joined into single entries (and a
989 989 secondary continuation prompt is issued as long as the user terminates
990 990 lines with \\). This allows entering very long strings which are still
991 991 meant to be treated as single entities.
992 992 """
993 993
994 994 try:
995 995 if header:
996 996 header += '\n'
997 997 lines = [raw_input(header + ps1)]
998 998 except EOFError:
999 999 return []
1000 1000 terminate = [terminate_str]
1001 1001 try:
1002 1002 while lines[-1:] != terminate:
1003 1003 new_line = raw_input(ps1)
1004 1004 while new_line.endswith('\\'):
1005 1005 new_line = new_line[:-1] + raw_input(ps2)
1006 1006 lines.append(new_line)
1007 1007
1008 1008 return lines[:-1] # don't return the termination command
1009 1009 except EOFError:
1010 1010 print
1011 1011 return lines
1012 1012
1013 1013 #----------------------------------------------------------------------------
1014 1014 def raw_input_ext(prompt='', ps2='... '):
1015 1015 """Similar to raw_input(), but accepts extended lines if input ends with \\."""
1016 1016
1017 1017 line = raw_input(prompt)
1018 1018 while line.endswith('\\'):
1019 1019 line = line[:-1] + raw_input(ps2)
1020 1020 return line
1021 1021
1022 1022 #----------------------------------------------------------------------------
1023 1023 def ask_yes_no(prompt,default=None):
1024 1024 """Asks a question and returns an integer 1/0 (y/n) answer.
1025 1025
1026 1026 If default is given (one of 'y','n'), it is used if the user input is
1027 1027 empty. Otherwise the question is repeated until an answer is given.
1028 1028
1029 1029 An EOF is treated as the default answer. If there is no default, an
1030 1030 exception is raised to prevent infinite loops.
1031 1031
1032 1032 Valid answers are: y/yes/n/no (match is not case sensitive)."""
1033 1033
1034 1034 answers = {'y':True,'n':False,'yes':True,'no':False}
1035 1035 ans = None
1036 1036 while ans not in answers.keys():
1037 1037 try:
1038 1038 ans = raw_input(prompt+' ').lower()
1039 1039 if not ans: # response was an empty string
1040 1040 ans = default
1041 1041 except KeyboardInterrupt:
1042 1042 pass
1043 1043 except EOFError:
1044 1044 if default in answers.keys():
1045 1045 ans = default
1046 1046 print
1047 1047 else:
1048 1048 raise
1049 1049
1050 1050 return answers[ans]
1051 1051
1052 1052 #----------------------------------------------------------------------------
1053 1053 def marquee(txt='',width=78,mark='*'):
1054 1054 """Return the input string centered in a 'marquee'."""
1055 1055 if not txt:
1056 1056 return (mark*width)[:width]
1057 1057 nmark = (width-len(txt)-2)/len(mark)/2
1058 1058 if nmark < 0: nmark =0
1059 1059 marks = mark*nmark
1060 1060 return '%s %s %s' % (marks,txt,marks)
1061 1061
1062 1062 #----------------------------------------------------------------------------
1063 1063 class EvalDict:
1064 1064 """
1065 1065 Emulate a dict which evaluates its contents in the caller's frame.
1066 1066
1067 1067 Usage:
1068 1068 >>>number = 19
1069 1069 >>>text = "python"
1070 1070 >>>print "%(text.capitalize())s %(number/9.0).1f rules!" % EvalDict()
1071 1071 """
1072 1072
1073 1073 # This version is due to sismex01@hebmex.com on c.l.py, and is basically a
1074 1074 # modified (shorter) version of:
1075 1075 # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66018 by
1076 1076 # Skip Montanaro (skip@pobox.com).
1077 1077
1078 1078 def __getitem__(self, name):
1079 1079 frame = sys._getframe(1)
1080 1080 return eval(name, frame.f_globals, frame.f_locals)
1081 1081
1082 1082 EvalString = EvalDict # for backwards compatibility
1083 1083 #----------------------------------------------------------------------------
1084 1084 def qw(words,flat=0,sep=None,maxsplit=-1):
1085 1085 """Similar to Perl's qw() operator, but with some more options.
1086 1086
1087 1087 qw(words,flat=0,sep=' ',maxsplit=-1) -> words.split(sep,maxsplit)
1088 1088
1089 1089 words can also be a list itself, and with flat=1, the output will be
1090 1090 recursively flattened. Examples:
1091 1091
1092 1092 >>> qw('1 2')
1093 1093 ['1', '2']
1094 1094 >>> qw(['a b','1 2',['m n','p q']])
1095 1095 [['a', 'b'], ['1', '2'], [['m', 'n'], ['p', 'q']]]
1096 1096 >>> qw(['a b','1 2',['m n','p q']],flat=1)
1097 1097 ['a', 'b', '1', '2', 'm', 'n', 'p', 'q'] """
1098 1098
1099 1099 if type(words) in StringTypes:
1100 1100 return [word.strip() for word in words.split(sep,maxsplit)
1101 1101 if word and not word.isspace() ]
1102 1102 if flat:
1103 1103 return flatten(map(qw,words,[1]*len(words)))
1104 1104 return map(qw,words)
1105 1105
1106 1106 #----------------------------------------------------------------------------
1107 1107 def qwflat(words,sep=None,maxsplit=-1):
1108 1108 """Calls qw(words) in flat mode. It's just a convenient shorthand."""
1109 1109 return qw(words,1,sep,maxsplit)
1110 1110
1111 1111 #----------------------------------------------------------------------------
1112 1112 def qw_lol(indata):
1113 1113 """qw_lol('a b') -> [['a','b']],
1114 1114 otherwise it's just a call to qw().
1115 1115
1116 1116 We need this to make sure the modules_some keys *always* end up as a
1117 1117 list of lists."""
1118 1118
1119 1119 if type(indata) in StringTypes:
1120 1120 return [qw(indata)]
1121 1121 else:
1122 1122 return qw(indata)
1123 1123
1124 1124 #-----------------------------------------------------------------------------
1125 1125 def list_strings(arg):
1126 1126 """Always return a list of strings, given a string or list of strings
1127 1127 as input."""
1128 1128
1129 1129 if type(arg) in StringTypes: return [arg]
1130 1130 else: return arg
1131 1131
1132 1132 #----------------------------------------------------------------------------
1133 1133 def grep(pat,list,case=1):
1134 1134 """Simple minded grep-like function.
1135 1135 grep(pat,list) returns occurrences of pat in list, None on failure.
1136 1136
1137 1137 It only does simple string matching, with no support for regexps. Use the
1138 1138 option case=0 for case-insensitive matching."""
1139 1139
1140 1140 # This is pretty crude. At least it should implement copying only references
1141 1141 # to the original data in case it's big. Now it copies the data for output.
1142 1142 out=[]
1143 1143 if case:
1144 1144 for term in list:
1145 1145 if term.find(pat)>-1: out.append(term)
1146 1146 else:
1147 1147 lpat=pat.lower()
1148 1148 for term in list:
1149 1149 if term.lower().find(lpat)>-1: out.append(term)
1150 1150
1151 1151 if len(out): return out
1152 1152 else: return None
1153 1153
1154 1154 #----------------------------------------------------------------------------
1155 1155 def dgrep(pat,*opts):
1156 1156 """Return grep() on dir()+dir(__builtins__).
1157 1157
1158 1158 A very common use of grep() when working interactively."""
1159 1159
1160 1160 return grep(pat,dir(__main__)+dir(__main__.__builtins__),*opts)
1161 1161
1162 1162 #----------------------------------------------------------------------------
1163 1163 def idgrep(pat):
1164 1164 """Case-insensitive dgrep()"""
1165 1165
1166 1166 return dgrep(pat,0)
1167 1167
1168 1168 #----------------------------------------------------------------------------
1169 1169 def igrep(pat,list):
1170 1170 """Synonym for case-insensitive grep."""
1171 1171
1172 1172 return grep(pat,list,case=0)
1173 1173
1174 1174 #----------------------------------------------------------------------------
1175 1175 def indent(str,nspaces=4,ntabs=0):
1176 1176 """Indent a string a given number of spaces or tabstops.
1177 1177
1178 1178 indent(str,nspaces=4,ntabs=0) -> indent str by ntabs+nspaces.
1179 1179 """
1180 1180 if str is None:
1181 1181 return
1182 1182 ind = '\t'*ntabs+' '*nspaces
1183 1183 outstr = '%s%s' % (ind,str.replace(os.linesep,os.linesep+ind))
1184 1184 if outstr.endswith(os.linesep+ind):
1185 1185 return outstr[:-len(ind)]
1186 1186 else:
1187 1187 return outstr
1188 1188
1189 1189 #-----------------------------------------------------------------------------
1190 1190 def native_line_ends(filename,backup=1):
1191 1191 """Convert (in-place) a file to line-ends native to the current OS.
1192 1192
1193 1193 If the optional backup argument is given as false, no backup of the
1194 1194 original file is left. """
1195 1195
1196 1196 backup_suffixes = {'posix':'~','dos':'.bak','nt':'.bak','mac':'.bak'}
1197 1197
1198 1198 bak_filename = filename + backup_suffixes[os.name]
1199 1199
1200 1200 original = open(filename).read()
1201 1201 shutil.copy2(filename,bak_filename)
1202 1202 try:
1203 1203 new = open(filename,'wb')
1204 1204 new.write(os.linesep.join(original.splitlines()))
1205 1205 new.write(os.linesep) # ALWAYS put an eol at the end of the file
1206 1206 new.close()
1207 1207 except:
1208 1208 os.rename(bak_filename,filename)
1209 1209 if not backup:
1210 1210 try:
1211 1211 os.remove(bak_filename)
1212 1212 except:
1213 1213 pass
1214 1214
1215 1215 #----------------------------------------------------------------------------
1216 1216 def get_pager_cmd(pager_cmd = None):
1217 1217 """Return a pager command.
1218 1218
1219 1219 Makes some attempts at finding an OS-correct one."""
1220 1220
1221 1221 if os.name == 'posix':
1222 1222 default_pager_cmd = 'less -r' # -r for color control sequences
1223 1223 elif os.name in ['nt','dos']:
1224 1224 default_pager_cmd = 'type'
1225 1225
1226 1226 if pager_cmd is None:
1227 1227 try:
1228 1228 pager_cmd = os.environ['PAGER']
1229 1229 except:
1230 1230 pager_cmd = default_pager_cmd
1231 1231 return pager_cmd
1232 1232
1233 1233 #-----------------------------------------------------------------------------
1234 1234 def get_pager_start(pager,start):
1235 1235 """Return the string for paging files with an offset.
1236 1236
1237 1237 This is the '+N' argument which less and more (under Unix) accept.
1238 1238 """
1239 1239
1240 1240 if pager in ['less','more']:
1241 1241 if start:
1242 1242 start_string = '+' + str(start)
1243 1243 else:
1244 1244 start_string = ''
1245 1245 else:
1246 1246 start_string = ''
1247 1247 return start_string
1248 1248
1249 1249 #----------------------------------------------------------------------------
1250 if os.name == "nt":
1250 # (X)emacs on W32 doesn't like to be bypassed with msvcrt.getch()
1251 if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs':
1251 1252 import msvcrt
1252 1253 def page_more():
1253 1254 """ Smart pausing between pages
1254 1255
1255 1256 @return: True if need print more lines, False if quit
1256 1257 """
1257 1258 Term.cout.write('---Return to continue, q to quit--- ')
1258 1259 ans = msvcrt.getch()
1259 1260 if ans in ("q", "Q"):
1260 1261 result = False
1261 1262 else:
1262 1263 result = True
1263 1264 Term.cout.write("\b"*37 + " "*37 + "\b"*37)
1264 1265 return result
1265 1266 else:
1266 1267 def page_more():
1267 1268 ans = raw_input('---Return to continue, q to quit--- ')
1268 1269 if ans.lower().startswith('q'):
1269 1270 return False
1270 1271 else:
1271 1272 return True
1272 1273
1273 1274 esc_re = re.compile(r"(\x1b[^m]+m)")
1274 1275
1275 1276 def page_dumb(strng,start=0,screen_lines=25):
1276 1277 """Very dumb 'pager' in Python, for when nothing else works.
1277 1278
1278 1279 Only moves forward, same interface as page(), except for pager_cmd and
1279 1280 mode."""
1280 1281
1281 1282 out_ln = strng.splitlines()[start:]
1282 1283 screens = chop(out_ln,screen_lines-1)
1283 1284 if len(screens) == 1:
1284 1285 print >>Term.cout, os.linesep.join(screens[0])
1285 1286 else:
1286 1287 last_escape = ""
1287 1288 for scr in screens[0:-1]:
1288 1289 hunk = os.linesep.join(scr)
1289 1290 print >>Term.cout, last_escape + hunk
1290 1291 if not page_more():
1291 1292 return
1292 1293 esc_list = esc_re.findall(hunk)
1293 1294 if len(esc_list) > 0:
1294 1295 last_escape = esc_list[-1]
1295 1296 print >>Term.cout, last_escape + os.linesep.join(screens[-1])
1296 1297
1297 1298 #----------------------------------------------------------------------------
1298 1299 def page(strng,start=0,screen_lines=0,pager_cmd = None):
1299 1300 """Print a string, piping through a pager after a certain length.
1300 1301
1301 1302 The screen_lines parameter specifies the number of *usable* lines of your
1302 1303 terminal screen (total lines minus lines you need to reserve to show other
1303 1304 information).
1304 1305
1305 1306 If you set screen_lines to a number <=0, page() will try to auto-determine
1306 1307 your screen size and will only use up to (screen_size+screen_lines) for
1307 1308 printing, paging after that. That is, if you want auto-detection but need
1308 1309 to reserve the bottom 3 lines of the screen, use screen_lines = -3, and for
1309 1310 auto-detection without any lines reserved simply use screen_lines = 0.
1310 1311
1311 1312 If a string won't fit in the allowed lines, it is sent through the
1312 1313 specified pager command. If none given, look for PAGER in the environment,
1313 1314 and ultimately default to less.
1314 1315
1315 1316 If no system pager works, the string is sent through a 'dumb pager'
1316 1317 written in python, very simplistic.
1317 1318 """
1318 1319
1319 1320 # Ugly kludge, but calling curses.initscr() flat out crashes in emacs
1320 1321 TERM = os.environ.get('TERM','dumb')
1321 1322 if TERM in ['dumb','emacs'] and os.name != 'nt':
1322 1323 print strng
1323 1324 return
1324 1325 # chop off the topmost part of the string we don't want to see
1325 1326 str_lines = strng.split(os.linesep)[start:]
1326 1327 str_toprint = os.linesep.join(str_lines)
1327 1328 num_newlines = len(str_lines)
1328 1329 len_str = len(str_toprint)
1329 1330
1330 1331 # Dumb heuristics to guesstimate number of on-screen lines the string
1331 1332 # takes. Very basic, but good enough for docstrings in reasonable
1332 1333 # terminals. If someone later feels like refining it, it's not hard.
1333 1334 numlines = max(num_newlines,int(len_str/80)+1)
1334 1335
1335 1336 if os.name == "nt":
1336 1337 screen_lines_def = get_console_size(defaulty=25)[1]
1337 1338 else:
1338 1339 screen_lines_def = 25 # default value if we can't auto-determine
1339 1340
1340 1341 # auto-determine screen size
1341 1342 if screen_lines <= 0:
1342 1343 if TERM=='xterm':
1343 1344 try:
1344 1345 import curses
1345 1346 if hasattr(curses,'initscr'):
1346 1347 use_curses = 1
1347 1348 else:
1348 1349 use_curses = 0
1349 1350 except ImportError:
1350 1351 use_curses = 0
1351 1352 else:
1352 1353 # curses causes problems on many terminals other than xterm.
1353 1354 use_curses = 0
1354 1355 if use_curses:
1355 1356 scr = curses.initscr()
1356 1357 screen_lines_real,screen_cols = scr.getmaxyx()
1357 1358 curses.endwin()
1358 1359 screen_lines += screen_lines_real
1359 1360 #print '***Screen size:',screen_lines_real,'lines x',\
1360 1361 #screen_cols,'columns.' # dbg
1361 1362 else:
1362 1363 screen_lines += screen_lines_def
1363 1364
1364 1365 #print 'numlines',numlines,'screenlines',screen_lines # dbg
1365 1366 if numlines <= screen_lines :
1366 1367 #print '*** normal print' # dbg
1367 1368 print >>Term.cout, str_toprint
1368 1369 else:
1369 1370 # Try to open pager and default to internal one if that fails.
1370 1371 # All failure modes are tagged as 'retval=1', to match the return
1371 1372 # value of a failed system command. If any intermediate attempt
1372 1373 # sets retval to 1, at the end we resort to our own page_dumb() pager.
1373 1374 pager_cmd = get_pager_cmd(pager_cmd)
1374 1375 pager_cmd += ' ' + get_pager_start(pager_cmd,start)
1375 1376 if os.name == 'nt':
1376 1377 if pager_cmd.startswith('type'):
1377 1378 # The default WinXP 'type' command is failing on complex strings.
1378 1379 retval = 1
1379 1380 else:
1380 1381 tmpname = tempfile.mktemp('.txt')
1381 1382 tmpfile = file(tmpname,'wt')
1382 1383 tmpfile.write(strng)
1383 1384 tmpfile.close()
1384 1385 cmd = "%s < %s" % (pager_cmd,tmpname)
1385 1386 if os.system(cmd):
1386 1387 retval = 1
1387 1388 else:
1388 1389 retval = None
1389 1390 os.remove(tmpname)
1390 1391 else:
1391 1392 try:
1392 1393 retval = None
1393 1394 # if I use popen4, things hang. No idea why.
1394 1395 #pager,shell_out = os.popen4(pager_cmd)
1395 1396 pager = os.popen(pager_cmd,'w')
1396 1397 pager.write(strng)
1397 1398 pager.close()
1398 1399 retval = pager.close() # success returns None
1399 1400 except IOError,msg: # broken pipe when user quits
1400 1401 if msg.args == (32,'Broken pipe'):
1401 1402 retval = None
1402 1403 else:
1403 1404 retval = 1
1404 1405 except OSError:
1405 1406 # Other strange problems, sometimes seen in Win2k/cygwin
1406 1407 retval = 1
1407 1408 if retval is not None:
1408 1409 page_dumb(strng,screen_lines=screen_lines)
1409 1410
1410 1411 #----------------------------------------------------------------------------
1411 1412 def page_file(fname,start = 0, pager_cmd = None):
1412 1413 """Page a file, using an optional pager command and starting line.
1413 1414 """
1414 1415
1415 1416 pager_cmd = get_pager_cmd(pager_cmd)
1416 1417 pager_cmd += ' ' + get_pager_start(pager_cmd,start)
1417 1418
1418 1419 try:
1419 1420 if os.environ['TERM'] in ['emacs','dumb']:
1420 1421 raise EnvironmentError
1421 1422 xsys(pager_cmd + ' ' + fname)
1422 1423 except:
1423 1424 try:
1424 1425 if start > 0:
1425 1426 start -= 1
1426 1427 page(open(fname).read(),start)
1427 1428 except:
1428 1429 print 'Unable to show file',`fname`
1429 1430
1430 1431 #----------------------------------------------------------------------------
1431 1432 def snip_print(str,width = 75,print_full = 0,header = ''):
1432 1433 """Print a string snipping the midsection to fit in width.
1433 1434
1434 1435 print_full: mode control:
1435 1436 - 0: only snip long strings
1436 1437 - 1: send to page() directly.
1437 1438 - 2: snip long strings and ask for full length viewing with page()
1438 1439 Return 1 if snipping was necessary, 0 otherwise."""
1439 1440
1440 1441 if print_full == 1:
1441 1442 page(header+str)
1442 1443 return 0
1443 1444
1444 1445 print header,
1445 1446 if len(str) < width:
1446 1447 print str
1447 1448 snip = 0
1448 1449 else:
1449 1450 whalf = int((width -5)/2)
1450 1451 print str[:whalf] + ' <...> ' + str[-whalf:]
1451 1452 snip = 1
1452 1453 if snip and print_full == 2:
1453 1454 if raw_input(header+' Snipped. View (y/n)? [N]').lower() == 'y':
1454 1455 page(str)
1455 1456 return snip
1456 1457
1457 1458 #****************************************************************************
1458 1459 # lists, dicts and structures
1459 1460
1460 1461 def belong(candidates,checklist):
1461 1462 """Check whether a list of items appear in a given list of options.
1462 1463
1463 1464 Returns a list of 1 and 0, one for each candidate given."""
1464 1465
1465 1466 return [x in checklist for x in candidates]
1466 1467
1467 1468 #----------------------------------------------------------------------------
1468 1469 def uniq_stable(elems):
1469 1470 """uniq_stable(elems) -> list
1470 1471
1471 1472 Return from an iterable, a list of all the unique elements in the input,
1472 1473 but maintaining the order in which they first appear.
1473 1474
1474 1475 A naive solution to this problem which just makes a dictionary with the
1475 1476 elements as keys fails to respect the stability condition, since
1476 1477 dictionaries are unsorted by nature.
1477 1478
1478 1479 Note: All elements in the input must be valid dictionary keys for this
1479 1480 routine to work, as it internally uses a dictionary for efficiency
1480 1481 reasons."""
1481 1482
1482 1483 unique = []
1483 1484 unique_dict = {}
1484 1485 for nn in elems:
1485 1486 if nn not in unique_dict:
1486 1487 unique.append(nn)
1487 1488 unique_dict[nn] = None
1488 1489 return unique
1489 1490
1490 1491 #----------------------------------------------------------------------------
1491 1492 class NLprinter:
1492 1493 """Print an arbitrarily nested list, indicating index numbers.
1493 1494
1494 1495 An instance of this class called nlprint is available and callable as a
1495 1496 function.
1496 1497
1497 1498 nlprint(list,indent=' ',sep=': ') -> prints indenting each level by 'indent'
1498 1499 and using 'sep' to separate the index from the value. """
1499 1500
1500 1501 def __init__(self):
1501 1502 self.depth = 0
1502 1503
1503 1504 def __call__(self,lst,pos='',**kw):
1504 1505 """Prints the nested list numbering levels."""
1505 1506 kw.setdefault('indent',' ')
1506 1507 kw.setdefault('sep',': ')
1507 1508 kw.setdefault('start',0)
1508 1509 kw.setdefault('stop',len(lst))
1509 1510 # we need to remove start and stop from kw so they don't propagate
1510 1511 # into a recursive call for a nested list.
1511 1512 start = kw['start']; del kw['start']
1512 1513 stop = kw['stop']; del kw['stop']
1513 1514 if self.depth == 0 and 'header' in kw.keys():
1514 1515 print kw['header']
1515 1516
1516 1517 for idx in range(start,stop):
1517 1518 elem = lst[idx]
1518 1519 if type(elem)==type([]):
1519 1520 self.depth += 1
1520 1521 self.__call__(elem,itpl('$pos$idx,'),**kw)
1521 1522 self.depth -= 1
1522 1523 else:
1523 1524 printpl(kw['indent']*self.depth+'$pos$idx$kw["sep"]$elem')
1524 1525
1525 1526 nlprint = NLprinter()
1526 1527 #----------------------------------------------------------------------------
1527 1528 def all_belong(candidates,checklist):
1528 1529 """Check whether a list of items ALL appear in a given list of options.
1529 1530
1530 1531 Returns a single 1 or 0 value."""
1531 1532
1532 1533 return 1-(0 in [x in checklist for x in candidates])
1533 1534
1534 1535 #----------------------------------------------------------------------------
1535 1536 def sort_compare(lst1,lst2,inplace = 1):
1536 1537 """Sort and compare two lists.
1537 1538
1538 1539 By default it does it in place, thus modifying the lists. Use inplace = 0
1539 1540 to avoid that (at the cost of temporary copy creation)."""
1540 1541 if not inplace:
1541 1542 lst1 = lst1[:]
1542 1543 lst2 = lst2[:]
1543 1544 lst1.sort(); lst2.sort()
1544 1545 return lst1 == lst2
1545 1546
1546 1547 #----------------------------------------------------------------------------
1547 1548 def mkdict(**kwargs):
1548 1549 """Return a dict from a keyword list.
1549 1550
1550 1551 It's just syntactic sugar for making ditcionary creation more convenient:
1551 1552 # the standard way
1552 1553 >>>data = { 'red' : 1, 'green' : 2, 'blue' : 3 }
1553 1554 # a cleaner way
1554 1555 >>>data = dict(red=1, green=2, blue=3)
1555 1556
1556 1557 If you need more than this, look at the Struct() class."""
1557 1558
1558 1559 return kwargs
1559 1560
1560 1561 #----------------------------------------------------------------------------
1561 1562 def list2dict(lst):
1562 1563 """Takes a list of (key,value) pairs and turns it into a dict."""
1563 1564
1564 1565 dic = {}
1565 1566 for k,v in lst: dic[k] = v
1566 1567 return dic
1567 1568
1568 1569 #----------------------------------------------------------------------------
1569 1570 def list2dict2(lst,default=''):
1570 1571 """Takes a list and turns it into a dict.
1571 1572 Much slower than list2dict, but more versatile. This version can take
1572 1573 lists with sublists of arbitrary length (including sclars)."""
1573 1574
1574 1575 dic = {}
1575 1576 for elem in lst:
1576 1577 if type(elem) in (types.ListType,types.TupleType):
1577 1578 size = len(elem)
1578 1579 if size == 0:
1579 1580 pass
1580 1581 elif size == 1:
1581 1582 dic[elem] = default
1582 1583 else:
1583 1584 k,v = elem[0], elem[1:]
1584 1585 if len(v) == 1: v = v[0]
1585 1586 dic[k] = v
1586 1587 else:
1587 1588 dic[elem] = default
1588 1589 return dic
1589 1590
1590 1591 #----------------------------------------------------------------------------
1591 1592 def flatten(seq):
1592 1593 """Flatten a list of lists (NOT recursive, only works for 2d lists)."""
1593 1594
1594 1595 return [x for subseq in seq for x in subseq]
1595 1596
1596 1597 #----------------------------------------------------------------------------
1597 1598 def get_slice(seq,start=0,stop=None,step=1):
1598 1599 """Get a slice of a sequence with variable step. Specify start,stop,step."""
1599 1600 if stop == None:
1600 1601 stop = len(seq)
1601 1602 item = lambda i: seq[i]
1602 1603 return map(item,xrange(start,stop,step))
1603 1604
1604 1605 #----------------------------------------------------------------------------
1605 1606 def chop(seq,size):
1606 1607 """Chop a sequence into chunks of the given size."""
1607 1608 chunk = lambda i: seq[i:i+size]
1608 1609 return map(chunk,xrange(0,len(seq),size))
1609 1610
1610 1611 #----------------------------------------------------------------------------
1611 1612 # with is a keyword as of python 2.5, so this function is renamed to withobj
1612 1613 # from its old 'with' name.
1613 1614 def with_obj(object, **args):
1614 1615 """Set multiple attributes for an object, similar to Pascal's with.
1615 1616
1616 1617 Example:
1617 1618 with_obj(jim,
1618 1619 born = 1960,
1619 1620 haircolour = 'Brown',
1620 1621 eyecolour = 'Green')
1621 1622
1622 1623 Credit: Greg Ewing, in
1623 1624 http://mail.python.org/pipermail/python-list/2001-May/040703.html.
1624 1625
1625 1626 NOTE: up until IPython 0.7.2, this was called simply 'with', but 'with'
1626 1627 has become a keyword for Python 2.5, so we had to rename it."""
1627 1628
1628 1629 object.__dict__.update(args)
1629 1630
1630 1631 #----------------------------------------------------------------------------
1631 1632 def setattr_list(obj,alist,nspace = None):
1632 1633 """Set a list of attributes for an object taken from a namespace.
1633 1634
1634 1635 setattr_list(obj,alist,nspace) -> sets in obj all the attributes listed in
1635 1636 alist with their values taken from nspace, which must be a dict (something
1636 1637 like locals() will often do) If nspace isn't given, locals() of the
1637 1638 *caller* is used, so in most cases you can omit it.
1638 1639
1639 1640 Note that alist can be given as a string, which will be automatically
1640 1641 split into a list on whitespace. If given as a list, it must be a list of
1641 1642 *strings* (the variable names themselves), not of variables."""
1642 1643
1643 1644 # this grabs the local variables from the *previous* call frame -- that is
1644 1645 # the locals from the function that called setattr_list().
1645 1646 # - snipped from weave.inline()
1646 1647 if nspace is None:
1647 1648 call_frame = sys._getframe().f_back
1648 1649 nspace = call_frame.f_locals
1649 1650
1650 1651 if type(alist) in StringTypes:
1651 1652 alist = alist.split()
1652 1653 for attr in alist:
1653 1654 val = eval(attr,nspace)
1654 1655 setattr(obj,attr,val)
1655 1656
1656 1657 #----------------------------------------------------------------------------
1657 1658 def getattr_list(obj,alist,*args):
1658 1659 """getattr_list(obj,alist[, default]) -> attribute list.
1659 1660
1660 1661 Get a list of named attributes for an object. When a default argument is
1661 1662 given, it is returned when the attribute doesn't exist; without it, an
1662 1663 exception is raised in that case.
1663 1664
1664 1665 Note that alist can be given as a string, which will be automatically
1665 1666 split into a list on whitespace. If given as a list, it must be a list of
1666 1667 *strings* (the variable names themselves), not of variables."""
1667 1668
1668 1669 if type(alist) in StringTypes:
1669 1670 alist = alist.split()
1670 1671 if args:
1671 1672 if len(args)==1:
1672 1673 default = args[0]
1673 1674 return map(lambda attr: getattr(obj,attr,default),alist)
1674 1675 else:
1675 1676 raise ValueError,'getattr_list() takes only one optional argument'
1676 1677 else:
1677 1678 return map(lambda attr: getattr(obj,attr),alist)
1678 1679
1679 1680 #----------------------------------------------------------------------------
1680 1681 def map_method(method,object_list,*argseq,**kw):
1681 1682 """map_method(method,object_list,*args,**kw) -> list
1682 1683
1683 1684 Return a list of the results of applying the methods to the items of the
1684 1685 argument sequence(s). If more than one sequence is given, the method is
1685 1686 called with an argument list consisting of the corresponding item of each
1686 1687 sequence. All sequences must be of the same length.
1687 1688
1688 1689 Keyword arguments are passed verbatim to all objects called.
1689 1690
1690 1691 This is Python code, so it's not nearly as fast as the builtin map()."""
1691 1692
1692 1693 out_list = []
1693 1694 idx = 0
1694 1695 for object in object_list:
1695 1696 try:
1696 1697 handler = getattr(object, method)
1697 1698 except AttributeError:
1698 1699 out_list.append(None)
1699 1700 else:
1700 1701 if argseq:
1701 1702 args = map(lambda lst:lst[idx],argseq)
1702 1703 #print 'ob',object,'hand',handler,'ar',args # dbg
1703 1704 out_list.append(handler(args,**kw))
1704 1705 else:
1705 1706 out_list.append(handler(**kw))
1706 1707 idx += 1
1707 1708 return out_list
1708 1709
1709 1710 #----------------------------------------------------------------------------
1710 1711 def import_fail_info(mod_name,fns=None):
1711 1712 """Inform load failure for a module."""
1712 1713
1713 1714 if fns == None:
1714 1715 warn("Loading of %s failed.\n" % (mod_name,))
1715 1716 else:
1716 1717 warn("Loading of %s from %s failed.\n" % (fns,mod_name))
1717 1718
1718 1719 #----------------------------------------------------------------------------
1719 1720 # Proposed popitem() extension, written as a method
1720 1721
1721 1722
1722 1723 class NotGiven: pass
1723 1724
1724 1725 def popkey(dct,key,default=NotGiven):
1725 1726 """Return dct[key] and delete dct[key].
1726 1727
1727 1728 If default is given, return it if dct[key] doesn't exist, otherwise raise
1728 1729 KeyError. """
1729 1730
1730 1731 try:
1731 1732 val = dct[key]
1732 1733 except KeyError:
1733 1734 if default is NotGiven:
1734 1735 raise
1735 1736 else:
1736 1737 return default
1737 1738 else:
1738 1739 del dct[key]
1739 1740 return val
1740 1741
1741 1742 def wrap_deprecated(func, suggest = '<nothing>'):
1742 1743 def newFunc(*args, **kwargs):
1743 1744 warnings.warn("Call to deprecated function %s, use %s instead" %
1744 1745 ( func.__name__, suggest),
1745 1746 category=DeprecationWarning,
1746 1747 stacklevel = 2)
1747 1748 return func(*args, **kwargs)
1748 1749 return newFunc
1749 1750
1750 1751 #*************************** end of file <genutils.py> **********************
1751 1752
@@ -1,642 +1,642 b''
1 1 # -*- coding: utf-8 -*-
2 2 #*****************************************************************************
3 3 # Copyright (C) 2001-2004 Fernando Perez. <fperez@colorado.edu>
4 4 #
5 5 # Distributed under the terms of the BSD License. The full license is in
6 6 # the file COPYING, distributed as part of this software.
7 7 #*****************************************************************************
8 8
9 # $Id: usage.py 2010 2006-12-20 15:29:17Z vivainio $
9 # $Id: usage.py 2152 2007-03-18 20:13:35Z fperez $
10 10
11 11 from IPython import Release
12 12 __author__ = '%s <%s>' % Release.authors['Fernando']
13 13 __license__ = Release.license
14 14 __version__ = Release.version
15 15
16 16 __doc__ = """
17 17 IPython -- An enhanced Interactive Python
18 18 =========================================
19 19
20 20 A Python shell with automatic history (input and output), dynamic object
21 21 introspection, easier configuration, command completion, access to the system
22 22 shell and more.
23 23
24 24 IPython can also be embedded in running programs. See EMBEDDING below.
25 25
26 26
27 27 USAGE
28 28 ipython [options] files
29 29
30 30 If invoked with no options, it executes all the files listed in
31 31 sequence and drops you into the interpreter while still acknowledging
32 32 any options you may have set in your ipythonrc file. This behavior is
33 33 different from standard Python, which when called as python -i will
34 34 only execute one file and will ignore your configuration setup.
35 35
36 36 Please note that some of the configuration options are not available at
37 37 the command line, simply because they are not practical here. Look into
38 38 your ipythonrc configuration file for details on those. This file
39 39 typically installed in the $HOME/.ipython directory.
40 40
41 41 For Windows users, $HOME resolves to C:\\Documents and
42 42 Settings\\YourUserName in most instances, and _ipython is used instead
43 43 of .ipython, since some Win32 programs have problems with dotted names
44 44 in directories.
45 45
46 46 In the rest of this text, we will refer to this directory as
47 47 IPYTHONDIR.
48 48
49 49
50 50 SPECIAL THREADING OPTIONS
51 51 The following special options are ONLY valid at the beginning of the
52 52 command line, and not later. This is because they control the initial-
53 53 ization of ipython itself, before the normal option-handling mechanism
54 54 is active.
55 55
56 -gthread, -qthread, -wthread, -pylab
56 -gthread, -qthread, -q4thread, -wthread, -pylab
57 57
58 58 Only ONE of these can be given, and it can only be given as the
59 59 first option passed to IPython (it will have no effect in any
60 60 other position). They provide threading support for the GTK, QT
61 61 and WXWidgets toolkits, and for the matplotlib library.
62 62
63 With any of the first three options, IPython starts running a
63 With any of the first four options, IPython starts running a
64 64 separate thread for the graphical toolkit's operation, so that
65 65 you can open and control graphical elements from within an
66 IPython command line, without blocking. All three provide
67 essentially the same functionality, respectively for GTK, QT and
68 WXWidgets (via their Python interfaces).
66 IPython command line, without blocking. All four provide
67 essentially the same functionality, respectively for GTK, QT3,
68 QT4 and WXWidgets (via their Python interfaces).
69 69
70 70 Note that with -wthread, you can additionally use the -wxversion
71 71 option to request a specific version of wx to be used. This
72 72 requires that you have the 'wxversion' Python module installed,
73 73 which is part of recent wxPython distributions.
74 74
75 75 If -pylab is given, IPython loads special support for the mat-
76 76 plotlib library (http://matplotlib.sourceforge.net), allowing
77 77 interactive usage of any of its backends as defined in the
78 78 user's .matplotlibrc file. It automatically activates GTK, QT
79 79 or WX threading for IPyhton if the choice of matplotlib backend
80 80 requires it. It also modifies the %run command to correctly
81 81 execute (without blocking) any matplotlib-based script which
82 82 calls show() at the end.
83 83
84 -tk The -g/q/wthread options, and -pylab (if matplotlib is
84 -tk The -g/q/q4/wthread options, and -pylab (if matplotlib is
85 85 configured to use GTK, QT or WX), will normally block Tk
86 86 graphical interfaces. This means that when GTK, QT or WX
87 87 threading is active, any attempt to open a Tk GUI will result in
88 88 a dead window, and possibly cause the Python interpreter to
89 89 crash. An extra option, -tk, is available to address this
90 90 issue. It can ONLY be given as a SECOND option after any of the
91 above (-gthread, -qthread, -wthread or -pylab).
91 above (-gthread, -qthread, q4thread, -wthread or -pylab).
92 92
93 93 If -tk is given, IPython will try to coordinate Tk threading
94 94 with GTK, QT or WX. This is however potentially unreliable, and
95 95 you will have to test on your platform and Python configuration
96 96 to determine whether it works for you. Debian users have
97 97 reported success, apparently due to the fact that Debian builds
98 98 all of Tcl, Tk, Tkinter and Python with pthreads support. Under
99 99 other Linux environments (such as Fedora Core 2/3), this option
100 100 has caused random crashes and lockups of the Python interpreter.
101 101 Under other operating systems (Mac OSX and Windows), you'll need
102 102 to try it to find out, since currently no user reports are
103 103 available.
104 104
105 105 There is unfortunately no way for IPython to determine at run-
106 106 time whether -tk will work reliably or not, so you will need to
107 107 do some experiments before relying on it for regular work.
108 108
109 109 A WARNING ABOUT SIGNALS AND THREADS
110 110
111 111 When any of the thread systems (GTK, QT or WX) are active, either
112 112 directly or via -pylab with a threaded backend, it is impossible to
113 113 interrupt long-running Python code via Ctrl-C. IPython can not pass
114 114 the KeyboardInterrupt exception (or the underlying SIGINT) across
115 115 threads, so any long-running process started from IPython will run to
116 116 completion, or will have to be killed via an external (OS-based)
117 117 mechanism.
118 118
119 119 To the best of my knowledge, this limitation is imposed by the Python
120 120 interpreter itself, and it comes from the difficulty of writing
121 121 portable signal/threaded code. If any user is an expert on this topic
122 122 and can suggest a better solution, I would love to hear about it. In
123 123 the IPython sources, look at the Shell.py module, and in particular at
124 124 the runcode() method.
125 125
126 126 REGULAR OPTIONS
127 127 After the above threading options have been given, regular options can
128 128 follow in any order. All options can be abbreviated to their shortest
129 129 non-ambiguous form and are case-sensitive. One or two dashes can be
130 130 used. Some options have an alternate short form, indicated after a |.
131 131
132 132 Most options can also be set from your ipythonrc configuration file.
133 133 See the provided examples for assistance. Options given on the comman-
134 134 dline override the values set in the ipythonrc file.
135 135
136 136 All options with a [no] prepended can be specified in negated form
137 137 (using -nooption instead of -option) to turn the feature off.
138 138
139 139 -h, --help
140 140 Show summary of options.
141 141
142 142 -pylab This can only be given as the first option passed to IPython (it
143 143 will have no effect in any other position). It adds special sup-
144 144 port for the matplotlib library (http://matplotlib.source-
145 145 forge.net), allowing interactive usage of any of its backends as
146 146 defined in the user's .matplotlibrc file. It automatically
147 147 activates GTK or WX threading for IPyhton if the choice of mat-
148 148 plotlib backend requires it. It also modifies the @run command
149 149 to correctly execute (without blocking) any matplotlib-based
150 150 script which calls show() at the end.
151 151
152 152 -autocall <val>
153 153 Make IPython automatically call any callable object even if you
154 154 didn't type explicit parentheses. For example, 'str 43' becomes
155 155 'str(43)' automatically. The value can be '0' to disable the
156 156 feature, '1' for 'smart' autocall, where it is not applied if
157 157 there are no more arguments on the line, and '2' for 'full'
158 158 autocall, where all callable objects are automatically called
159 159 (even if no arguments are present). The default is '1'.
160 160
161 161 -[no]autoindent
162 162 Turn automatic indentation on/off.
163 163
164 164 -[no]automagic
165 165 Make magic commands automatic (without needing their first char-
166 166 acter to be %). Type %magic at the IPython prompt for more
167 167 information.
168 168
169 169 -[no]autoedit_syntax
170 170 When a syntax error occurs after editing a file, automatically
171 171 open the file to the trouble causing line for convenient fixing.
172 172
173 173 -[no]banner
174 174 Print the intial information banner (default on).
175 175
176 176 -c <command>
177 177 Execute the given command string, and set sys.argv to ['c'].
178 178 This is similar to the -c option in the normal Python inter-
179 179 preter.
180 180
181 181 -cache_size|cs <n>
182 182 Size of the output cache (maximum number of entries to hold in
183 183 memory). The default is 1000, you can change it permanently in
184 184 your config file. Setting it to 0 completely disables the
185 185 caching system, and the minimum value accepted is 20 (if you
186 186 provide a value less than 20, it is reset to 0 and a warning is
187 187 issued). This limit is defined because otherwise you'll spend
188 188 more time re-flushing a too small cache than working.
189 189
190 190 -classic|cl
191 191 Gives IPython a similar feel to the classic Python prompt.
192 192
193 193 -colors <scheme>
194 194 Color scheme for prompts and exception reporting. Currently
195 195 implemented: NoColor, Linux, and LightBG.
196 196
197 197 -[no]color_info
198 198 IPython can display information about objects via a set of func-
199 199 tions, and optionally can use colors for this, syntax highlight-
200 200 ing source code and various other elements. However, because
201 201 this information is passed through a pager (like 'less') and
202 202 many pagers get confused with color codes, this option is off by
203 203 default. You can test it and turn it on permanently in your
204 204 ipythonrc file if it works for you. As a reference, the 'less'
205 205 pager supplied with Mandrake 8.2 works ok, but that in RedHat
206 206 7.2 doesn't.
207 207
208 208 Test it and turn it on permanently if it works with your system.
209 209 The magic function @color_info allows you to toggle this inter-
210 210 actively for testing.
211 211
212 212 -[no]confirm_exit
213 213 Set to confirm when you try to exit IPython with an EOF (Con-
214 214 trol-D in Unix, Control-Z/Enter in Windows). Note that using the
215 215 magic functions @Exit or @Quit you can force a direct exit,
216 216 bypassing any confirmation.
217 217
218 218 -[no]debug
219 219 Show information about the loading process. Very useful to pin
220 220 down problems with your configuration files or to get details
221 221 about session restores.
222 222
223 223 -[no]deep_reload
224 224 IPython can use the deep_reload module which reloads changes in
225 225 modules recursively (it replaces the reload() function, so you
226 226 don't need to change anything to use it). deep_reload() forces a
227 227 full reload of modules whose code may have changed, which the
228 228 default reload() function does not.
229 229
230 230 When deep_reload is off, IPython will use the normal reload(),
231 231 but deep_reload will still be available as dreload(). This fea-
232 232 ture is off by default [which means that you have both normal
233 233 reload() and dreload()].
234 234
235 235 -editor <name>
236 236 Which editor to use with the @edit command. By default, IPython
237 237 will honor your EDITOR environment variable (if not set, vi is
238 238 the Unix default and notepad the Windows one). Since this editor
239 239 is invoked on the fly by IPython and is meant for editing small
240 240 code snippets, you may want to use a small, lightweight editor
241 241 here (in case your default EDITOR is something like Emacs).
242 242
243 243 -ipythondir <name>
244 244 The name of your IPython configuration directory IPYTHONDIR.
245 245 This can also be specified through the environment variable
246 246 IPYTHONDIR.
247 247
248 248 -log|l Generate a log file of all input. The file is named
249 249 ipython_log.py in your current directory (which prevents logs
250 250 from multiple IPython sessions from trampling each other). You
251 251 can use this to later restore a session by loading your logfile
252 252 as a file to be executed with option -logplay (see below).
253 253
254 254 -logfile|lf
255 255 Specify the name of your logfile.
256 256
257 257 -logplay|lp
258 258 Replay a previous log. For restoring a session as close as pos-
259 259 sible to the state you left it in, use this option (don't just
260 260 run the logfile). With -logplay, IPython will try to reconstruct
261 261 the previous working environment in full, not just execute the
262 262 commands in the logfile.
263 263 When a session is restored, logging is automatically turned on
264 264 again with the name of the logfile it was invoked with (it is
265 265 read from the log header). So once you've turned logging on for
266 266 a session, you can quit IPython and reload it as many times as
267 267 you want and it will continue to log its history and restore
268 268 from the beginning every time.
269 269
270 270 Caveats: there are limitations in this option. The history vari-
271 271 ables _i*,_* and _dh don't get restored properly. In the future
272 272 we will try to implement full session saving by writing and
273 273 retrieving a failed because of inherent limitations of Python's
274 274 Pickle module, so this may have to wait.
275 275
276 276 -[no]messages
277 277 Print messages which IPython collects about its startup process
278 278 (default on).
279 279
280 280 -[no]pdb
281 281 Automatically call the pdb debugger after every uncaught excep-
282 282 tion. If you are used to debugging using pdb, this puts you
283 283 automatically inside of it after any call (either in IPython or
284 284 in code called by it) which triggers an exception which goes
285 285 uncaught.
286 286
287 287 -[no]pprint
288 288 IPython can optionally use the pprint (pretty printer) module
289 289 for displaying results. pprint tends to give a nicer display of
290 290 nested data structures. If you like it, you can turn it on per-
291 291 manently in your config file (default off).
292 292
293 293 -profile|p <name>
294 294 Assume that your config file is ipythonrc-<name> (looks in cur-
295 295 rent dir first, then in IPYTHONDIR). This is a quick way to keep
296 296 and load multiple config files for different tasks, especially
297 297 if you use the include option of config files. You can keep a
298 298 basic IPYTHONDIR/ipythonrc file and then have other 'profiles'
299 299 which include this one and load extra things for particular
300 300 tasks. For example:
301 301
302 302 1) $HOME/.ipython/ipythonrc : load basic things you always want.
303 303 2) $HOME/.ipython/ipythonrc-math : load (1) and basic math-
304 304 related modules.
305 305 3) $HOME/.ipython/ipythonrc-numeric : load (1) and Numeric and
306 306 plotting modules.
307 307
308 308 Since it is possible to create an endless loop by having circu-
309 309 lar file inclusions, IPython will stop if it reaches 15 recur-
310 310 sive inclusions.
311 311
312 312 -prompt_in1|pi1 <string>
313 313 Specify the string used for input prompts. Note that if you are
314 314 using numbered prompts, the number is represented with a '\#' in
315 315 the string. Don't forget to quote strings with spaces embedded
316 316 in them. Default: 'In [\#]: '.
317 317
318 318 Most bash-like escapes can be used to customize IPython's
319 319 prompts, as well as a few additional ones which are IPython-spe-
320 320 cific. All valid prompt escapes are described in detail in the
321 321 Customization section of the IPython HTML/PDF manual.
322 322
323 323 -prompt_in2|pi2 <string>
324 324 Similar to the previous option, but used for the continuation
325 325 prompts. The special sequence '\D' is similar to '\#', but with
326 326 all digits replaced dots (so you can have your continuation
327 327 prompt aligned with your input prompt). Default: ' .\D.: '
328 328 (note three spaces at the start for alignment with 'In [\#]').
329 329
330 330 -prompt_out|po <string>
331 331 String used for output prompts, also uses numbers like
332 332 prompt_in1. Default: 'Out[\#]:'.
333 333
334 334 -quick Start in bare bones mode (no config file loaded).
335 335
336 336 -rcfile <name>
337 337 Name of your IPython resource configuration file. normally
338 338 IPython loads ipythonrc (from current directory) or
339 339 IPYTHONDIR/ipythonrc. If the loading of your config file fails,
340 340 IPython starts with a bare bones configuration (no modules
341 341 loaded at all).
342 342
343 343 -[no]readline
344 344 Use the readline library, which is needed to support name com-
345 345 pletion and command history, among other things. It is enabled
346 346 by default, but may cause problems for users of X/Emacs in
347 347 Python comint or shell buffers.
348 348
349 349 Note that emacs 'eterm' buffers (opened with M-x term) support
350 350 IPython's readline and syntax coloring fine, only 'emacs' (M-x
351 351 shell and C-c !) buffers do not.
352 352
353 353 -screen_length|sl <n>
354 354 Number of lines of your screen. This is used to control print-
355 355 ing of very long strings. Strings longer than this number of
356 356 lines will be sent through a pager instead of directly printed.
357 357
358 358 The default value for this is 0, which means IPython will auto-
359 359 detect your screen size every time it needs to print certain
360 360 potentially long strings (this doesn't change the behavior of
361 361 the 'print' keyword, it's only triggered internally). If for
362 362 some reason this isn't working well (it needs curses support),
363 363 specify it yourself. Otherwise don't change the default.
364 364
365 365 -separate_in|si <string>
366 366 Separator before input prompts. Default '0.
367 367
368 368 -separate_out|so <string>
369 369 Separator before output prompts. Default: 0 (nothing).
370 370
371 371 -separate_out2|so2 <string>
372 372 Separator after output prompts. Default: 0 (nothing).
373 373
374 374 -nosep Shorthand for '-separate_in 0 -separate_out 0 -separate_out2 0'.
375 375 Simply removes all input/output separators.
376 376
377 377 -upgrade
378 378 Allows you to upgrade your IPYTHONDIR configuration when you
379 379 install a new version of IPython. Since new versions may
380 380 include new command lines options or example files, this copies
381 381 updated ipythonrc-type files. However, it backs up (with a .old
382 382 extension) all files which it overwrites so that you can merge
383 383 back any custimizations you might have in your personal files.
384 384
385 385 -Version
386 386 Print version information and exit.
387 387
388 388 -wxversion <string>
389 389 Select a specific version of wxPython (used in conjunction with
390 390 -wthread). Requires the wxversion module, part of recent
391 391 wxPython distributions.
392 392
393 393 -xmode <modename>
394 394 Mode for exception reporting. The valid modes are Plain, Con-
395 395 text, and Verbose.
396 396
397 397 - Plain: similar to python's normal traceback printing.
398 398
399 399 - Context: prints 5 lines of context source code around each
400 400 line in the traceback.
401 401
402 402 - Verbose: similar to Context, but additionally prints the vari-
403 403 ables currently visible where the exception happened (shortening
404 404 their strings if too long). This can potentially be very slow,
405 405 if you happen to have a huge data structure whose string repre-
406 406 sentation is complex to compute. Your computer may appear to
407 407 freeze for a while with cpu usage at 100%. If this occurs, you
408 408 can cancel the traceback with Ctrl-C (maybe hitting it more than
409 409 once).
410 410
411 411
412 412 EMBEDDING
413 413 It is possible to start an IPython instance inside your own Python pro-
414 414 grams. In the documentation example files there are some illustrations
415 415 on how to do this.
416 416
417 417 This feature allows you to evalutate dynamically the state of your
418 418 code, operate with your variables, analyze them, etc. Note however
419 419 that any changes you make to values while in the shell do NOT propagate
420 420 back to the running code, so it is safe to modify your values because
421 421 you won't break your code in bizarre ways by doing so.
422 422 """
423 423
424 424 cmd_line_usage = __doc__
425 425
426 426 #---------------------------------------------------------------------------
427 427 interactive_usage = """
428 428 IPython -- An enhanced Interactive Python
429 429 =========================================
430 430
431 431 IPython offers a combination of convenient shell features, special commands
432 432 and a history mechanism for both input (command history) and output (results
433 433 caching, similar to Mathematica). It is intended to be a fully compatible
434 434 replacement for the standard Python interpreter, while offering vastly
435 435 improved functionality and flexibility.
436 436
437 437 At your system command line, type 'ipython -help' to see the command line
438 438 options available. This document only describes interactive features.
439 439
440 440 Warning: IPython relies on the existence of a global variable called __IP which
441 441 controls the shell itself. If you redefine __IP to anything, bizarre behavior
442 442 will quickly occur.
443 443
444 444 MAIN FEATURES
445 445
446 446 * Access to the standard Python help. As of Python 2.1, a help system is
447 447 available with access to object docstrings and the Python manuals. Simply
448 448 type 'help' (no quotes) to access it.
449 449
450 450 * Magic commands: type %magic for information on the magic subsystem.
451 451
452 452 * System command aliases, via the %alias command or the ipythonrc config file.
453 453
454 454 * Dynamic object information:
455 455
456 456 Typing ?word or word? prints detailed information about an object. If
457 457 certain strings in the object are too long (docstrings, code, etc.) they get
458 458 snipped in the center for brevity.
459 459
460 460 Typing ??word or word?? gives access to the full information without
461 461 snipping long strings. Long strings are sent to the screen through the less
462 462 pager if longer than the screen, printed otherwise.
463 463
464 464 The ?/?? system gives access to the full source code for any object (if
465 465 available), shows function prototypes and other useful information.
466 466
467 467 If you just want to see an object's docstring, type '%pdoc object' (without
468 468 quotes, and without % if you have automagic on).
469 469
470 470 Both %pdoc and ?/?? give you access to documentation even on things which are
471 471 not explicitely defined. Try for example typing {}.get? or after import os,
472 472 type os.path.abspath??. The magic functions %pdef, %source and %file operate
473 473 similarly.
474 474
475 475 * Completion in the local namespace, by typing TAB at the prompt.
476 476
477 477 At any time, hitting tab will complete any available python commands or
478 478 variable names, and show you a list of the possible completions if there's
479 479 no unambiguous one. It will also complete filenames in the current directory.
480 480
481 481 This feature requires the readline and rlcomplete modules, so it won't work
482 482 if your Python lacks readline support (such as under Windows).
483 483
484 484 * Search previous command history in two ways (also requires readline):
485 485
486 486 - Start typing, and then use Ctrl-p (previous,up) and Ctrl-n (next,down) to
487 487 search through only the history items that match what you've typed so
488 488 far. If you use Ctrl-p/Ctrl-n at a blank prompt, they just behave like
489 489 normal arrow keys.
490 490
491 491 - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches
492 492 your history for lines that match what you've typed so far, completing as
493 493 much as it can.
494 494
495 495 * Persistent command history across sessions (readline required).
496 496
497 497 * Logging of input with the ability to save and restore a working session.
498 498
499 499 * System escape with !. Typing !ls will run 'ls' in the current directory.
500 500
501 501 * The reload command does a 'deep' reload of a module: changes made to the
502 502 module since you imported will actually be available without having to exit.
503 503
504 504 * Verbose and colored exception traceback printouts. See the magic xmode and
505 505 xcolor functions for details (just type %magic).
506 506
507 507 * Input caching system:
508 508
509 509 IPython offers numbered prompts (In/Out) with input and output caching. All
510 510 input is saved and can be retrieved as variables (besides the usual arrow
511 511 key recall).
512 512
513 513 The following GLOBAL variables always exist (so don't overwrite them!):
514 514 _i: stores previous input.
515 515 _ii: next previous.
516 516 _iii: next-next previous.
517 517 _ih : a list of all input _ih[n] is the input from line n.
518 518
519 519 Additionally, global variables named _i<n> are dynamically created (<n>
520 520 being the prompt counter), such that _i<n> == _ih[<n>]
521 521
522 522 For example, what you typed at prompt 14 is available as _i14 and _ih[14].
523 523
524 524 You can create macros which contain multiple input lines from this history,
525 525 for later re-execution, with the %macro function.
526 526
527 527 The history function %hist allows you to see any part of your input history
528 528 by printing a range of the _i variables. Note that inputs which contain
529 529 magic functions (%) appear in the history with a prepended comment. This is
530 530 because they aren't really valid Python code, so you can't exec them.
531 531
532 532 * Output caching system:
533 533
534 534 For output that is returned from actions, a system similar to the input
535 535 cache exists but using _ instead of _i. Only actions that produce a result
536 536 (NOT assignments, for example) are cached. If you are familiar with
537 537 Mathematica, IPython's _ variables behave exactly like Mathematica's %
538 538 variables.
539 539
540 540 The following GLOBAL variables always exist (so don't overwrite them!):
541 541 _ (one underscore): previous output.
542 542 __ (two underscores): next previous.
543 543 ___ (three underscores): next-next previous.
544 544
545 545 Global variables named _<n> are dynamically created (<n> being the prompt
546 546 counter), such that the result of output <n> is always available as _<n>.
547 547
548 548 Finally, a global dictionary named _oh exists with entries for all lines
549 549 which generated output.
550 550
551 551 * Directory history:
552 552
553 553 Your history of visited directories is kept in the global list _dh, and the
554 554 magic %cd command can be used to go to any entry in that list.
555 555
556 556 * Auto-parentheses and auto-quotes (adapted from Nathan Gray's LazyPython)
557 557
558 558 1. Auto-parentheses
559 559 Callable objects (i.e. functions, methods, etc) can be invoked like
560 560 this (notice the commas between the arguments):
561 561 >>> callable_ob arg1, arg2, arg3
562 562 and the input will be translated to this:
563 563 --> callable_ob(arg1, arg2, arg3)
564 564 You can force auto-parentheses by using '/' as the first character
565 565 of a line. For example:
566 566 >>> /globals # becomes 'globals()'
567 567 Note that the '/' MUST be the first character on the line! This
568 568 won't work:
569 569 >>> print /globals # syntax error
570 570
571 571 In most cases the automatic algorithm should work, so you should
572 572 rarely need to explicitly invoke /. One notable exception is if you
573 573 are trying to call a function with a list of tuples as arguments (the
574 574 parenthesis will confuse IPython):
575 575 In [1]: zip (1,2,3),(4,5,6) # won't work
576 576 but this will work:
577 577 In [2]: /zip (1,2,3),(4,5,6)
578 578 ------> zip ((1,2,3),(4,5,6))
579 579 Out[2]= [(1, 4), (2, 5), (3, 6)]
580 580
581 581 IPython tells you that it has altered your command line by
582 582 displaying the new command line preceded by -->. e.g.:
583 583 In [18]: callable list
584 584 -------> callable (list)
585 585
586 586 2. Auto-Quoting
587 587 You can force auto-quoting of a function's arguments by using ',' as
588 588 the first character of a line. For example:
589 589 >>> ,my_function /home/me # becomes my_function("/home/me")
590 590
591 591 If you use ';' instead, the whole argument is quoted as a single
592 592 string (while ',' splits on whitespace):
593 593 >>> ,my_function a b c # becomes my_function("a","b","c")
594 594 >>> ;my_function a b c # becomes my_function("a b c")
595 595
596 596 Note that the ',' MUST be the first character on the line! This
597 597 won't work:
598 598 >>> x = ,my_function /home/me # syntax error
599 599 """
600 600
601 601 quick_reference = r"""
602 602 IPython -- An enhanced Interactive Python - Quick Reference Card
603 603 ================================================================
604 604
605 605 obj?, obj??, ?obj,??obj : Get help, or more help for object
606 606 ?os.p* : List names in os starting with p
607 607
608 608 Example magic:
609 609
610 610 %alias d ls -F : 'd' is now an alias for 'ls -F'
611 611 alias d ls -F : Works if 'alias' not a python name
612 612 alist = %alias : Get list of aliases to 'alist'
613 613
614 614 System commands:
615 615
616 616 !cp a.txt b/ : System command escape, calls os.system()
617 617 cp a.txt b/ : after %rehashx, most system commands work without !
618 618 cp ${f}.txt $bar : Variable expansion in magics and system commands
619 619 files = !ls /usr : Capture sytem command output
620 620 files.s, files.l, files.n: "a b c", ['a','b','c'], 'a\nb\nc'
621 621 cd /usr/share : Obvious, also 'cd d:\home\_ipython' works
622 622
623 623 History:
624 624
625 625 _i, _ii, _iii : Previous, next previous, next next previous input
626 626 _i4, _ih[2:5] : Input history line 4, lines 2-4
627 627 exec _i81 : Execute input history line #81 again
628 628 _, __, ___ : previous, next previous, next next previous output
629 629 _dh : Directory history
630 630 _oh : Output history
631 631 %hist : Command history
632 632
633 633 Autocall:
634 634
635 635 f 1,2 : f(1,2)
636 636 /f 1,2 : f(1,2) (forced autoparen)
637 637 ,f 1 2 : f("1","2")
638 638 ;f 1 2 : f("1 2")
639 639
640 640 """
641 641
642 642
@@ -1,6327 +1,6332 b''
1 2007-03-18 Fernando Perez <Fernando.Perez@colorado.edu>
2
3 * IPython/ColorANSI.py (InputTermColors.Normal): applied Nicolas
4 Pernetty's patch to improve support for (X)Emacs under Win32.
5
1 6 2007-03-17 Fernando Perez <Fernando.Perez@colorado.edu>
2 7
3 8 * IPython/Shell.py (hijack_wx): ipmort WX with current semantics
4 9 to quiet a deprecation warning that fires with Wx 2.8. Thanks to
5 10 a report by Nik Tautenhahn.
6 11
7 12 2007-03-16 Walter Doerwald <walter@livinglogic.de>
8 13
9 14 * setup.py: Add the igrid help files to the list of data files
10 15 to be installed alongside igrid.
11 16 * IPython/Extensions/igrid.py: (Patch by Nik Tautenhahn)
12 17 Show the input object of the igrid browser as the window tile.
13 18 Show the object the cursor is on in the statusbar.
14 19
15 20 2007-03-15 Ville Vainio <vivainio@gmail.com>
16 21
17 22 * Extensions/ipy_stock_completers.py: Fixed exception
18 23 on mismatching quotes in %run completer. Patch by
19 24 JοΏ½rgen Stenarson. Closes #127.
20 25
21 26 2007-03-14 Ville Vainio <vivainio@gmail.com>
22 27
23 28 * Extensions/ext_rehashdir.py: Do not do auto_alias
24 29 in %rehashdir, it clobbers %store'd aliases.
25 30
26 31 * UserConfig/ipy_profile_sh.py: envpersist.py extension
27 32 (beefed up %env) imported for sh profile.
28 33
29 34 2007-03-10 Walter Doerwald <walter@livinglogic.de>
30 35
31 36 * IPython/Extensions/ipipe.py: Prefer ibrowse over igrid
32 37 as the default browser.
33 38 * IPython/Extensions/igrid.py: Make a few igrid attributes private.
34 39 As igrid displays all attributes it ever encounters, fetch() (which has
35 40 been renamed to _fetch()) doesn't have to recalculate the display attributes
36 41 every time a new item is fetched. This should speed up scrolling.
37 42
38 43 2007-03-10 Fernando Perez <Fernando.Perez@colorado.edu>
39 44
40 45 * IPython/iplib.py (InteractiveShell.__init__): fix for Alex
41 46 Schmolck's recently reported tab-completion bug (my previous one
42 47 had a problem). Patch by Dan Milstein <danmil-AT-comcast.net>.
43 48
44 49 2007-03-09 Walter Doerwald <walter@livinglogic.de>
45 50
46 51 * IPython/Extensions/igrid.py: Patch by Nik Tautenhahn:
47 52 Close help window if exiting igrid.
48 53
49 54 2007-03-02 JοΏ½rgen Stenarson <jorgen.stenarson@bostream.nu>
50 55
51 56 * IPython/Extensions/ipy_defaults.py: Check if readline is available
52 57 before calling functions from readline.
53 58
54 59 2007-03-02 Walter Doerwald <walter@livinglogic.de>
55 60
56 61 * IPython/Extensions/igrid.py: Add Nik Tautenhahns igrid extension.
57 62 igrid is a wxPython-based display object for ipipe. If your system has
58 63 wx installed igrid will be the default display. Without wx ipipe falls
59 64 back to ibrowse (which needs curses). If no curses is installed ipipe
60 65 falls back to idump.
61 66
62 67 2007-03-01 Fernando Perez <Fernando.Perez@colorado.edu>
63 68
64 69 * IPython/iplib.py (split_user_inputBROKEN): temporarily disable
65 70 my changes from yesterday, they introduced bugs. Will reactivate
66 71 once I get a correct solution, which will be much easier thanks to
67 72 Dan Milstein's new prefilter test suite.
68 73
69 74 2007-02-28 Fernando Perez <Fernando.Perez@colorado.edu>
70 75
71 76 * IPython/iplib.py (split_user_input): fix input splitting so we
72 77 don't attempt attribute accesses on things that can't possibly be
73 78 valid Python attributes. After a bug report by Alex Schmolck.
74 79 (InteractiveShell.__init__): brown-paper bag fix; regexp broke
75 80 %magic with explicit % prefix.
76 81
77 82 2007-02-27 Fernando Perez <Fernando.Perez@colorado.edu>
78 83
79 84 * IPython/Shell.py (IPShellGTK.mainloop): update threads calls to
80 85 avoid a DeprecationWarning from GTK.
81 86
82 87 2007-02-22 Fernando Perez <Fernando.Perez@colorado.edu>
83 88
84 89 * IPython/genutils.py (clock): I modified clock() to return total
85 90 time, user+system. This is a more commonly needed metric. I also
86 91 introduced the new clocku/clocks to get only user/system time if
87 92 one wants those instead.
88 93
89 94 ***WARNING: API CHANGE*** clock() used to return only user time,
90 95 so if you want exactly the same results as before, use clocku
91 96 instead.
92 97
93 98 2007-02-22 Ville Vainio <vivainio@gmail.com>
94 99
95 100 * IPython/Extensions/ipy_p4.py: Extension for improved
96 101 p4 (perforce version control system) experience.
97 102 Adds %p4 magic with p4 command completion and
98 103 automatic -G argument (marshall output as python dict)
99 104
100 105 2007-02-19 Fernando Perez <Fernando.Perez@colorado.edu>
101 106
102 107 * IPython/demo.py (Demo.re_stop): make dashes optional in demo
103 108 stop marks.
104 109 (ClearingMixin): a simple mixin to easily make a Demo class clear
105 110 the screen in between blocks and have empty marquees. The
106 111 ClearDemo and ClearIPDemo classes that use it are included.
107 112
108 113 2007-02-18 Fernando Perez <Fernando.Perez@colorado.edu>
109 114
110 115 * IPython/irunner.py (pexpect_monkeypatch): patch pexpect to
111 116 protect against exceptions at Python shutdown time. Patch
112 117 sumbmitted to upstream.
113 118
114 119 2007-02-14 Walter Doerwald <walter@livinglogic.de>
115 120
116 121 * IPython/Extensions/ibrowse.py: If entering the first object level
117 122 (i.e. the object for which the browser has been started) fails,
118 123 now the error is raised directly (aborting the browser) instead of
119 124 running into an empty levels list later.
120 125
121 126 2007-02-03 Walter Doerwald <walter@livinglogic.de>
122 127
123 128 * IPython/Extensions/ipipe.py: Add an xrepr implementation
124 129 for the noitem object.
125 130
126 131 2007-01-31 Fernando Perez <Fernando.Perez@colorado.edu>
127 132
128 133 * IPython/completer.py (Completer.attr_matches): Fix small
129 134 tab-completion bug with Enthought Traits objects with units.
130 135 Thanks to a bug report by Tom Denniston
131 136 <tom.denniston-AT-alum.dartmouth.org>.
132 137
133 138 2007-01-27 Fernando Perez <Fernando.Perez@colorado.edu>
134 139
135 140 * IPython/Extensions/ipy_stock_completers.py (runlistpy): fix a
136 141 bug where only .ipy or .py would be completed. Once the first
137 142 argument to %run has been given, all completions are valid because
138 143 they are the arguments to the script, which may well be non-python
139 144 filenames.
140 145
141 146 * IPython/irunner.py (InteractiveRunner.run_source): major updates
142 147 to irunner to allow it to correctly support real doctesting of
143 148 out-of-process ipython code.
144 149
145 150 * IPython/Magic.py (magic_cd): Make the setting of the terminal
146 151 title an option (-noterm_title) because it completely breaks
147 152 doctesting.
148 153
149 154 * IPython/demo.py: fix IPythonDemo class that was not actually working.
150 155
151 156 2007-01-24 Fernando Perez <Fernando.Perez@colorado.edu>
152 157
153 158 * IPython/irunner.py (main): fix small bug where extensions were
154 159 not being correctly recognized.
155 160
156 161 2007-01-23 Walter Doerwald <walter@livinglogic.de>
157 162
158 163 * IPython/Extensions/ipipe.py (xiter): Make sure that iterating
159 164 a string containing a single line yields the string itself as the
160 165 only item.
161 166
162 167 * IPython/Extensions/ibrowse.py (ibrowse): Avoid entering an
163 168 object if it's the same as the one on the last level (This avoids
164 169 infinite recursion for one line strings).
165 170
166 171 2007-01-17 Fernando Perez <Fernando.Perez@colorado.edu>
167 172
168 173 * IPython/ultraTB.py (AutoFormattedTB.__call__): properly flush
169 174 all output streams before printing tracebacks. This ensures that
170 175 user output doesn't end up interleaved with traceback output.
171 176
172 177 2007-01-10 Ville Vainio <vivainio@gmail.com>
173 178
174 179 * Extensions/envpersist.py: Turbocharged %env that remembers
175 180 env vars across sessions; e.g. "%env PATH+=;/opt/scripts" or
176 181 "%env VISUAL=jed".
177 182
178 183 2007-01-05 Fernando Perez <Fernando.Perez@colorado.edu>
179 184
180 185 * IPython/iplib.py (showtraceback): ensure that we correctly call
181 186 custom handlers in all cases (some with pdb were slipping through,
182 187 but I'm not exactly sure why).
183 188
184 189 * IPython/Debugger.py (Tracer.__init__): added new class to
185 190 support set_trace-like usage of IPython's enhanced debugger.
186 191
187 192 2006-12-24 Ville Vainio <vivainio@gmail.com>
188 193
189 194 * ipmaker.py: more informative message when ipy_user_conf
190 195 import fails (suggest running %upgrade).
191 196
192 197 * tools/run_ipy_in_profiler.py: Utility to see where
193 198 the time during IPython startup is spent.
194 199
195 200 2006-12-20 Ville Vainio <vivainio@gmail.com>
196 201
197 202 * 0.7.3 is out - merge all from 0.7.3 branch to trunk
198 203
199 204 * ipapi.py: Add new ipapi method, expand_alias.
200 205
201 206 * Release.py: Bump up version to 0.7.4.svn
202 207
203 208 2006-12-17 Ville Vainio <vivainio@gmail.com>
204 209
205 210 * Extensions/jobctrl.py: Fixed &cmd arg arg...
206 211 to work properly on posix too
207 212
208 213 * Release.py: Update revnum (version is still just 0.7.3).
209 214
210 215 2006-12-15 Ville Vainio <vivainio@gmail.com>
211 216
212 217 * scripts/ipython_win_post_install: create ipython.py in
213 218 prefix + "/scripts".
214 219
215 220 * Release.py: Update version to 0.7.3.
216 221
217 222 2006-12-14 Ville Vainio <vivainio@gmail.com>
218 223
219 224 * scripts/ipython_win_post_install: Overwrite old shortcuts
220 225 if they already exist
221 226
222 227 * Release.py: release 0.7.3rc2
223 228
224 229 2006-12-13 Ville Vainio <vivainio@gmail.com>
225 230
226 231 * Branch and update Release.py for 0.7.3rc1
227 232
228 233 2006-12-13 Fernando Perez <Fernando.Perez@colorado.edu>
229 234
230 235 * IPython/Shell.py (IPShellWX): update for current WX naming
231 236 conventions, to avoid a deprecation warning with current WX
232 237 versions. Thanks to a report by Danny Shevitz.
233 238
234 239 2006-12-12 Ville Vainio <vivainio@gmail.com>
235 240
236 241 * ipmaker.py: apply david cournapeau's patch to make
237 242 import_some work properly even when ipythonrc does
238 243 import_some on empty list (it was an old bug!).
239 244
240 245 * UserConfig/ipy_user_conf.py, UserConfig/ipythonrc:
241 246 Add deprecation note to ipythonrc and a url to wiki
242 247 in ipy_user_conf.py
243 248
244 249
245 250 * Magic.py (%run): %run myscript.ipy now runs myscript.ipy
246 251 as if it was typed on IPython command prompt, i.e.
247 252 as IPython script.
248 253
249 254 * example-magic.py, magic_grepl.py: remove outdated examples
250 255
251 256 2006-12-11 Fernando Perez <Fernando.Perez@colorado.edu>
252 257
253 258 * IPython/iplib.py (debugger): prevent a nasty traceback if %debug
254 259 is called before any exception has occurred.
255 260
256 261 2006-12-08 Ville Vainio <vivainio@gmail.com>
257 262
258 263 * Extensions/ipy_stock_completers.py: fix cd completer
259 264 to translate /'s to \'s again.
260 265
261 266 * completer.py: prevent traceback on file completions w/
262 267 backslash.
263 268
264 269 * Release.py: Update release number to 0.7.3b3 for release
265 270
266 271 2006-12-07 Ville Vainio <vivainio@gmail.com>
267 272
268 273 * Extensions/ipy_signals.py: Ignore ctrl+C in IPython process
269 274 while executing external code. Provides more shell-like behaviour
270 275 and overall better response to ctrl + C / ctrl + break.
271 276
272 277 * tools/make_tarball.py: new script to create tarball straight from svn
273 278 (setup.py sdist doesn't work on win32).
274 279
275 280 * Extensions/ipy_stock_completers.py: fix cd completer to give up
276 281 on dirnames with spaces and use the default completer instead.
277 282
278 283 * Revision.py: Change version to 0.7.3b2 for release.
279 284
280 285 2006-12-05 Ville Vainio <vivainio@gmail.com>
281 286
282 287 * Magic.py, iplib.py, completer.py: Apply R. Bernstein's
283 288 pydb patch 4 (rm debug printing, py 2.5 checking)
284 289
285 290 2006-11-30 Walter Doerwald <walter@livinglogic.de>
286 291 * IPython/Extensions/ibrowse.py: Add two new commands to ibrowse:
287 292 "refresh" (mapped to "r") refreshes the screen by restarting the iterator.
288 293 "refreshfind" (mapped to "R") does the same but tries to go back to the same
289 294 object the cursor was on before the refresh. The command "markrange" is
290 295 mapped to "%" now.
291 296 * IPython/Extensions/ibrowse.py: Make igrpentry and ipwdentry comparable.
292 297
293 298 2006-11-29 Fernando Perez <Fernando.Perez@colorado.edu>
294 299
295 300 * IPython/Magic.py (magic_debug): new %debug magic to activate the
296 301 interactive debugger on the last traceback, without having to call
297 302 %pdb and rerun your code. Made minor changes in various modules,
298 303 should automatically recognize pydb if available.
299 304
300 305 2006-11-28 Ville Vainio <vivainio@gmail.com>
301 306
302 307 * completer.py: If the text start with !, show file completions
303 308 properly. This helps when trying to complete command name
304 309 for shell escapes.
305 310
306 311 2006-11-27 Ville Vainio <vivainio@gmail.com>
307 312
308 313 * ipy_stock_completers.py: bzr completer submitted by Stefan van
309 314 der Walt. Clean up svn and hg completers by using a common
310 315 vcs_completer.
311 316
312 317 2006-11-26 Ville Vainio <vivainio@gmail.com>
313 318
314 319 * Remove ipconfig and %config; you should use _ip.options structure
315 320 directly instead!
316 321
317 322 * genutils.py: add wrap_deprecated function for deprecating callables
318 323
319 324 * iplib.py: deprecate ipmagic, ipsystem, ipalias. Use _ip.magic and
320 325 _ip.system instead. ipalias is redundant.
321 326
322 327 * Magic.py: %rehashdir no longer aliases 'cmdname' to 'cmdname.exe' on
323 328 win32, but just 'cmdname'. Other extensions (non-'exe') are still made
324 329 explicit.
325 330
326 331 * ipy_stock_completers.py: 'hg' (mercurial VCS) now has a custom
327 332 completer. Try it by entering 'hg ' and pressing tab.
328 333
329 334 * macro.py: Give Macro a useful __repr__ method
330 335
331 336 * Magic.py: %whos abbreviates the typename of Macro for brevity.
332 337
333 338 2006-11-24 Walter Doerwald <walter@livinglogic.de>
334 339 * IPython/Extensions/astyle.py: Do a relative import of ipipe, so that
335 340 we don't get a duplicate ipipe module, where registration of the xrepr
336 341 implementation for Text is useless.
337 342
338 343 * IPython/Extensions/ipipe.py: Fix __xrepr__() implementation for ils.
339 344
340 345 * IPython/Extensions/ibrowse.py: Fix keymapping for the enter command.
341 346
342 347 2006-11-24 Ville Vainio <vivainio@gmail.com>
343 348
344 349 * Magic.py, manual_base.lyx: Kirill Smelkov patch:
345 350 try to use "cProfile" instead of the slower pure python
346 351 "profile"
347 352
348 353 2006-11-23 Ville Vainio <vivainio@gmail.com>
349 354
350 355 * manual_base.lyx: Kirill Smelkov patch: Fix wrong
351 356 Qt+IPython+Designer link in documentation.
352 357
353 358 * Extensions/ipy_pydb.py: R. Bernstein's patch for passing
354 359 correct Pdb object to %pydb.
355 360
356 361
357 362 2006-11-22 Walter Doerwald <walter@livinglogic.de>
358 363 * IPython/Extensions/astyle.py: Text needs it's own implemenation of the
359 364 generic xrepr(), otherwise the list implementation would kick in.
360 365
361 366 2006-11-21 Ville Vainio <vivainio@gmail.com>
362 367
363 368 * upgrade_dir.py: Now actually overwrites a nonmodified user file
364 369 with one from UserConfig.
365 370
366 371 * ipy_profile_sh.py: Add dummy "depth" to var_expand lambda,
367 372 it was missing which broke the sh profile.
368 373
369 374 * completer.py: file completer now uses explicit '/' instead
370 375 of os.path.join, expansion of 'foo' was broken on win32
371 376 if there was one directory with name 'foobar'.
372 377
373 378 * A bunch of patches from Kirill Smelkov:
374 379
375 380 * [patch 9/9] doc: point bug-tracker URL to IPythons trac-tickets.
376 381
377 382 * [patch 7/9] Implement %page -r (page in raw mode) -
378 383
379 384 * [patch 5/9] ScientificPython webpage has moved
380 385
381 386 * [patch 4/9] The manual mentions %ds, should be %dhist
382 387
383 388 * [patch 3/9] Kill old bits from %prun doc.
384 389
385 390 * [patch 1/9] Fix typos here and there.
386 391
387 392 2006-11-08 Ville Vainio <vivainio@gmail.com>
388 393
389 394 * completer.py (attr_matches): catch all exceptions raised
390 395 by eval of expr with dots.
391 396
392 397 2006-11-07 Fernando Perez <Fernando.Perez@colorado.edu>
393 398
394 399 * IPython/iplib.py (runsource): Prepend an 'if 1:' to the user
395 400 input if it starts with whitespace. This allows you to paste
396 401 indented input from any editor without manually having to type in
397 402 the 'if 1:', which is convenient when working interactively.
398 403 Slightly modifed version of a patch by Bo Peng
399 404 <bpeng-AT-rice.edu>.
400 405
401 406 2006-11-03 Fernando Perez <Fernando.Perez@colorado.edu>
402 407
403 408 * IPython/irunner.py (main): modified irunner so it automatically
404 409 recognizes the right runner to use based on the extension (.py for
405 410 python, .ipy for ipython and .sage for sage).
406 411
407 412 * IPython/iplib.py (InteractiveShell.ipconfig): new builtin, also
408 413 visible in ipapi as ip.config(), to programatically control the
409 414 internal rc object. There's an accompanying %config magic for
410 415 interactive use, which has been enhanced to match the
411 416 funtionality in ipconfig.
412 417
413 418 * IPython/Magic.py (magic_system_verbose): Change %system_verbose
414 419 so it's not just a toggle, it now takes an argument. Add support
415 420 for a customizable header when making system calls, as the new
416 421 system_header variable in the ipythonrc file.
417 422
418 423 2006-11-03 Walter Doerwald <walter@livinglogic.de>
419 424
420 425 * IPython/Extensions/ipipe.py: xrepr(), xiter() and xattrs() are now
421 426 generic functions (using Philip J. Eby's simplegeneric package).
422 427 This makes it possible to customize the display of third-party classes
423 428 without having to monkeypatch them. xiter() no longer supports a mode
424 429 argument and the XMode class has been removed. The same functionality can
425 430 be implemented via IterAttributeDescriptor and IterMethodDescriptor.
426 431 One consequence of the switch to generic functions is that xrepr() and
427 432 xattrs() implementation must define the default value for the mode
428 433 argument themselves and xattrs() implementations must return real
429 434 descriptors.
430 435
431 436 * IPython/external: This new subpackage will contain all third-party
432 437 packages that are bundled with IPython. (The first one is simplegeneric).
433 438
434 439 * IPython/Extensions/ipipe.py (ifile/ils): Readd output of the parent
435 440 directory which as been dropped in r1703.
436 441
437 442 * IPython/Extensions/ipipe.py (iless): Fixed.
438 443
439 444 * IPython/Extensions/ibrowse: Fixed sorting under Python 2.3.
440 445
441 446 2006-11-03 Fernando Perez <Fernando.Perez@colorado.edu>
442 447
443 448 * IPython/iplib.py (InteractiveShell.var_expand): fix stack
444 449 handling in variable expansion so that shells and magics recognize
445 450 function local scopes correctly. Bug reported by Brian.
446 451
447 452 * scripts/ipython: remove the very first entry in sys.path which
448 453 Python auto-inserts for scripts, so that sys.path under IPython is
449 454 as similar as possible to that under plain Python.
450 455
451 456 * IPython/completer.py (IPCompleter.file_matches): Fix
452 457 tab-completion so that quotes are not closed unless the completion
453 458 is unambiguous. After a request by Stefan. Minor cleanups in
454 459 ipy_stock_completers.
455 460
456 461 2006-11-02 Ville Vainio <vivainio@gmail.com>
457 462
458 463 * ipy_stock_completers.py: Add %run and %cd completers.
459 464
460 465 * completer.py: Try running custom completer for both
461 466 "foo" and "%foo" if the command is just "foo". Ignore case
462 467 when filtering possible completions.
463 468
464 469 * UserConfig/ipy_user_conf.py: install stock completers as default
465 470
466 471 * iplib.py (history_saving_wrapper), debugger(), ipy_pydb.py:
467 472 simplified readline history save / restore through a wrapper
468 473 function
469 474
470 475
471 476 2006-10-31 Ville Vainio <vivainio@gmail.com>
472 477
473 478 * strdispatch.py, completer.py, ipy_stock_completers.py:
474 479 Allow str_key ("command") in completer hooks. Implement
475 480 trivial completer for 'import' (stdlib modules only). Rename
476 481 ipy_linux_package_managers.py to ipy_stock_completers.py.
477 482 SVN completer.
478 483
479 484 * Extensions/ledit.py: %magic line editor for easily and
480 485 incrementally manipulating lists of strings. The magic command
481 486 name is %led.
482 487
483 488 2006-10-30 Ville Vainio <vivainio@gmail.com>
484 489
485 490 * Debugger.py, iplib.py (debugger()): Add last set of Rocky
486 491 Bernsteins's patches for pydb integration.
487 492 http://bashdb.sourceforge.net/pydb/
488 493
489 494 * strdispatch.py, iplib.py, completer.py, IPython/__init__.py,
490 495 Extensions/ipy_linux_package_managers.py, hooks.py: Implement
491 496 custom completer hook to allow the users to implement their own
492 497 completers. See ipy_linux_package_managers.py for example. The
493 498 hook name is 'complete_command'.
494 499
495 500 2006-10-28 Fernando Perez <Fernando.Perez@colorado.edu>
496 501
497 502 * IPython/UserConfig/ipythonrc-scipy: minor cleanups to remove old
498 503 Numeric leftovers.
499 504
500 505 * ipython.el (py-execute-region): apply Stefan's patch to fix
501 506 garbled results if the python shell hasn't been previously started.
502 507
503 508 * IPython/genutils.py (arg_split): moved to genutils, since it's a
504 509 pretty generic function and useful for other things.
505 510
506 511 * IPython/OInspect.py (getsource): Add customizable source
507 512 extractor. After a request/patch form W. Stein (SAGE).
508 513
509 514 * IPython/irunner.py (InteractiveRunner.run_source): reset tty
510 515 window size to a more reasonable value from what pexpect does,
511 516 since their choice causes wrapping bugs with long input lines.
512 517
513 518 2006-10-28 Ville Vainio <vivainio@gmail.com>
514 519
515 520 * Magic.py (%run): Save and restore the readline history from
516 521 file around %run commands to prevent side effects from
517 522 %runned programs that might use readline (e.g. pydb).
518 523
519 524 * extensions/ipy_pydb.py: Adds %pydb magic when imported, for
520 525 invoking the pydb enhanced debugger.
521 526
522 527 2006-10-23 Walter Doerwald <walter@livinglogic.de>
523 528
524 529 * IPython/Extensions/ipipe.py (ifile): Remove all methods that
525 530 call the base class method and propagate the return value to
526 531 ifile. This is now done by path itself.
527 532
528 533 2006-10-15 Fernando Perez <Fernando.Perez@colorado.edu>
529 534
530 535 * IPython/ipapi.py (IPApi.__init__): Added new entry to public
531 536 api: set_crash_handler(), to expose the ability to change the
532 537 internal crash handler.
533 538
534 539 * IPython/CrashHandler.py (CrashHandler.__init__): abstract out
535 540 the various parameters of the crash handler so that apps using
536 541 IPython as their engine can customize crash handling. Ipmlemented
537 542 at the request of SAGE.
538 543
539 544 2006-10-14 Ville Vainio <vivainio@gmail.com>
540 545
541 546 * Magic.py, ipython.el: applied first "safe" part of Rocky
542 547 Bernstein's patch set for pydb integration.
543 548
544 549 * Magic.py (%unalias, %alias): %store'd aliases can now be
545 550 removed with '%unalias'. %alias w/o args now shows most
546 551 interesting (stored / manually defined) aliases last
547 552 where they catch the eye w/o scrolling.
548 553
549 554 * Magic.py (%rehashx), ext_rehashdir.py: files with
550 555 'py' extension are always considered executable, even
551 556 when not in PATHEXT environment variable.
552 557
553 558 2006-10-12 Ville Vainio <vivainio@gmail.com>
554 559
555 560 * jobctrl.py: Add new "jobctrl" extension for spawning background
556 561 processes with "&find /". 'import jobctrl' to try it out. Requires
557 562 'subprocess' module, standard in python 2.4+.
558 563
559 564 * iplib.py (expand_aliases, handle_alias): Aliases expand transitively,
560 565 so if foo -> bar and bar -> baz, then foo -> baz.
561 566
562 567 2006-10-09 Fernando Perez <Fernando.Perez@colorado.edu>
563 568
564 569 * IPython/Magic.py (Magic.parse_options): add a new posix option
565 570 to allow parsing of input args in magics that doesn't strip quotes
566 571 (if posix=False). This also closes %timeit bug reported by
567 572 Stefan.
568 573
569 574 2006-10-03 Ville Vainio <vivainio@gmail.com>
570 575
571 576 * iplib.py (raw_input, interact): Return ValueError catching for
572 577 raw_input. Fixes infinite loop for sys.stdin.close() or
573 578 sys.stdout.close().
574 579
575 580 2006-09-27 Fernando Perez <Fernando.Perez@colorado.edu>
576 581
577 582 * IPython/irunner.py (InteractiveRunner.run_source): small fixes
578 583 to help in handling doctests. irunner is now pretty useful for
579 584 running standalone scripts and simulate a full interactive session
580 585 in a format that can be then pasted as a doctest.
581 586
582 587 * IPython/iplib.py (InteractiveShell.__init__): Install exit/quit
583 588 on top of the default (useless) ones. This also fixes the nasty
584 589 way in which 2.5's Quitter() exits (reverted [1785]).
585 590
586 591 * IPython/Debugger.py (Pdb.__init__): Fix ipdb to work with python
587 592 2.5.
588 593
589 594 * IPython/ultraTB.py (TBTools.set_colors): Make sure that ipdb
590 595 color scheme is updated as well when color scheme is changed
591 596 interactively.
592 597
593 598 2006-09-27 Ville Vainio <vivainio@gmail.com>
594 599
595 600 * iplib.py (raw_input): python 2.5 closes stdin on quit -> avoid
596 601 infinite loop and just exit. It's a hack, but will do for a while.
597 602
598 603 2006-08-25 Walter Doerwald <walter@livinglogic.de>
599 604
600 605 * IPython/Extensions/ipipe.py (ils): Add arguments dirs and files to
601 606 the constructor, this makes it possible to get a list of only directories
602 607 or only files.
603 608
604 609 2006-08-12 Ville Vainio <vivainio@gmail.com>
605 610
606 611 * Fakemodule.py, OInspect.py: Reverted 2006-08-11 mods,
607 612 they broke unittest
608 613
609 614 2006-08-11 Ville Vainio <vivainio@gmail.com>
610 615
611 616 * Fakemodule.py, OInspect.py: remove 2006-08-09 monkepatch
612 617 by resolving issue properly, i.e. by inheriting FakeModule
613 618 from types.ModuleType. Pickling ipython interactive data
614 619 should still work as usual (testing appreciated).
615 620
616 621 2006-08-09 Fernando Perez <Fernando.Perez@colorado.edu>
617 622
618 623 * IPython/OInspect.py: monkeypatch inspect from the stdlib if
619 624 running under python 2.3 with code from 2.4 to fix a bug with
620 625 help(). Reported by the Debian maintainers, Norbert Tretkowski
621 626 <norbert-AT-tretkowski.de> and Alexandre Fayolle
622 627 <afayolle-AT-debian.org>.
623 628
624 629 2006-08-04 Walter Doerwald <walter@livinglogic.de>
625 630
626 631 * IPython/Extensions/ibrowse.py: Fixed the help message in the footer
627 632 (which was displaying "quit" twice).
628 633
629 634 2006-07-28 Walter Doerwald <walter@livinglogic.de>
630 635
631 636 * IPython/Extensions/ipipe.py: Fix isort.__iter__() (was still using
632 637 the mode argument).
633 638
634 639 2006-07-27 Walter Doerwald <walter@livinglogic.de>
635 640
636 641 * IPython/Extensions/ipipe.py: Fix getglobals() if we're
637 642 not running under IPython.
638 643
639 644 * IPython/Extensions/ipipe.py: Rename XAttr to AttributeDetail
640 645 and make it iterable (iterating over the attribute itself). Add two new
641 646 magic strings for __xattrs__(): If the string starts with "-", the attribute
642 647 will not be displayed in ibrowse's detail view (but it can still be
643 648 iterated over). This makes it possible to add attributes that are large
644 649 lists or generator methods to the detail view. Replace magic attribute names
645 650 and _attrname() and _getattr() with "descriptors": For each type of magic
646 651 attribute name there's a subclass of Descriptor: None -> SelfDescriptor();
647 652 "foo" -> AttributeDescriptor("foo"); "foo()" -> MethodDescriptor("foo");
648 653 "-foo" -> IterAttributeDescriptor("foo"); "-foo()" -> IterMethodDescriptor("foo");
649 654 foo() -> FunctionDescriptor(foo). Magic strings returned from __xattrs__()
650 655 are still supported.
651 656
652 657 * IPython/Extensions/ibrowse.py: If fetching the next row from the input
653 658 fails in ibrowse.fetch(), the exception object is added as the last item
654 659 and item fetching is canceled. This prevents ibrowse from aborting if e.g.
655 660 a generator throws an exception midway through execution.
656 661
657 662 * IPython/Extensions/ipipe.py: Turn ifile's properties mimetype and
658 663 encoding into methods.
659 664
660 665 2006-07-26 Ville Vainio <vivainio@gmail.com>
661 666
662 667 * iplib.py: history now stores multiline input as single
663 668 history entries. Patch by Jorgen Cederlof.
664 669
665 670 2006-07-18 Walter Doerwald <walter@livinglogic.de>
666 671
667 672 * IPython/Extensions/ibrowse.py: Make cursor visible over
668 673 non existing attributes.
669 674
670 675 2006-07-14 Walter Doerwald <walter@livinglogic.de>
671 676
672 677 * IPython/Extensions/ipipe.py (ix): Use os.popen4() so that the
673 678 error output of the running command doesn't mess up the screen.
674 679
675 680 2006-07-13 Walter Doerwald <walter@livinglogic.de>
676 681
677 682 * IPython/Extensions/ipipe.py (isort): Make isort usable without
678 683 argument. This sorts the items themselves.
679 684
680 685 2006-07-12 Walter Doerwald <walter@livinglogic.de>
681 686
682 687 * IPython/Extensions/ipipe.py (eval, ifilter, isort, ieval):
683 688 Compile expression strings into code objects. This should speed
684 689 up ifilter and friends somewhat.
685 690
686 691 2006-07-08 Ville Vainio <vivainio@gmail.com>
687 692
688 693 * Magic.py: %cpaste now strips > from the beginning of lines
689 694 to ease pasting quoted code from emails. Contributed by
690 695 Stefan van der Walt.
691 696
692 697 2006-06-29 Ville Vainio <vivainio@gmail.com>
693 698
694 699 * ipmaker.py, Shell.py: qt4agg matplotlib backend support for pylab
695 700 mode, patch contributed by Darren Dale. NEEDS TESTING!
696 701
697 702 2006-06-28 Walter Doerwald <walter@livinglogic.de>
698 703
699 704 * IPython/Extensions/ibrowse.py: Give the ibrowse cursor row
700 705 a blue background. Fix fetching new display rows when the browser
701 706 scrolls more than a screenful (e.g. by using the goto command).
702 707
703 708 2006-06-27 Ville Vainio <vivainio@gmail.com>
704 709
705 710 * Magic.py (_inspect, _ofind) Apply David Huard's
706 711 patch for displaying the correct docstring for 'property'
707 712 attributes.
708 713
709 714 2006-06-23 Walter Doerwald <walter@livinglogic.de>
710 715
711 716 * IPython/Extensions/ibrowse.py: Put the documentation of the keyboard
712 717 commands into the methods implementing them.
713 718
714 719 2006-06-22 Fernando Perez <Fernando.Perez@colorado.edu>
715 720
716 721 * ipython.el (ipython-indentation-hook): cleanup patch, submitted
717 722 by Kov Chai <tchaikov-AT-gmail.com>. He notes that the original
718 723 autoindent support was authored by Jin Liu.
719 724
720 725 2006-06-22 Walter Doerwald <walter@livinglogic.de>
721 726
722 727 * IPython/Extensions/ibrowse.py: Replace the plain dictionaries used
723 728 for keymaps with a custom class that simplifies handling.
724 729
725 730 2006-06-19 Walter Doerwald <walter@livinglogic.de>
726 731
727 732 * IPython/Extensions/ibrowse.py: ibrowse now properly handles terminal
728 733 resizing. This requires Python 2.5 to work.
729 734
730 735 2006-06-16 Walter Doerwald <walter@livinglogic.de>
731 736
732 737 * IPython/Extensions/ibrowse.py: Add two new commands to
733 738 ibrowse: "hideattr" (mapped to "h") hides the attribute under
734 739 the cursor. "unhiderattrs" (mapped to "H") reveals all hidden
735 740 attributes again. Remapped the help command to "?". Display
736 741 keycodes in the range 0x01-0x1F as CTRL-xx. Add CTRL-a and CTRL-e
737 742 as keys for the "home" and "end" commands. Add three new commands
738 743 to the input mode for "find" and friends: "delend" (CTRL-K)
739 744 deletes to the end of line. "incsearchup" searches upwards in the
740 745 command history for an input that starts with the text before the cursor.
741 746 "incsearchdown" does the same downwards. Removed a bogus mapping of
742 747 the x key to "delete".
743 748
744 749 2006-06-15 Ville Vainio <vivainio@gmail.com>
745 750
746 751 * iplib.py, hooks.py: Added new generate_prompt hook that can be
747 752 used to create prompts dynamically, instead of the "old" way of
748 753 assigning "magic" strings to prompt_in1 and prompt_in2. The old
749 754 way still works (it's invoked by the default hook), of course.
750 755
751 756 * Prompts.py: added generate_output_prompt hook for altering output
752 757 prompt
753 758
754 759 * Release.py: Changed version string to 0.7.3.svn.
755 760
756 761 2006-06-15 Walter Doerwald <walter@livinglogic.de>
757 762
758 763 * IPython/Extensions/ibrowse.py: Change _BrowserLevel.moveto() so that
759 764 the call to fetch() always tries to fetch enough data for at least one
760 765 full screen. This makes it possible to simply call moveto(0,0,True) in
761 766 the constructor. Fix typos and removed the obsolete goto attribute.
762 767
763 768 2006-06-12 Ville Vainio <vivainio@gmail.com>
764 769
765 770 * ipy_profile_sh.py: applied Krisha Mohan Gundu's patch for
766 771 allowing $variable interpolation within multiline statements,
767 772 though so far only with "sh" profile for a testing period.
768 773 The patch also enables splitting long commands with \ but it
769 774 doesn't work properly yet.
770 775
771 776 2006-06-12 Walter Doerwald <walter@livinglogic.de>
772 777
773 778 * IPython/Extensions/ibrowse.py (_dodisplay): Display the length of the
774 779 input history and the position of the cursor in the input history for
775 780 the find, findbackwards and goto command.
776 781
777 782 2006-06-10 Walter Doerwald <walter@livinglogic.de>
778 783
779 784 * IPython/Extensions/ibrowse.py: Add a class _CommandInput that
780 785 implements the basic functionality of browser commands that require
781 786 input. Reimplement the goto, find and findbackwards commands as
782 787 subclasses of _CommandInput. Add an input history and keymaps to those
783 788 commands. Add "\r" as a keyboard shortcut for the enterdefault and
784 789 execute commands.
785 790
786 791 2006-06-07 Ville Vainio <vivainio@gmail.com>
787 792
788 793 * iplib.py: ipython mybatch.ipy exits ipython immediately after
789 794 running the batch files instead of leaving the session open.
790 795
791 796 2006-06-07 Fernando Perez <Fernando.Perez@colorado.edu>
792 797
793 798 * IPython/iplib.py (InteractiveShell.__init__): update BSD fix, as
794 799 the original fix was incomplete. Patch submitted by W. Maier.
795 800
796 801 2006-06-07 Ville Vainio <vivainio@gmail.com>
797 802
798 803 * iplib.py,Magic.py, ipmaker.py (magic_rehashx):
799 804 Confirmation prompts can be supressed by 'quiet' option.
800 805 _ip.options.quiet = 1 means "assume yes for all yes/no queries".
801 806
802 807 2006-06-06 *** Released version 0.7.2
803 808
804 809 2006-06-06 Fernando Perez <Fernando.Perez@colorado.edu>
805 810
806 811 * IPython/Release.py (version): Made 0.7.2 final for release.
807 812 Repo tagged and release cut.
808 813
809 814 2006-06-05 Ville Vainio <vivainio@gmail.com>
810 815
811 816 * Magic.py (magic_rehashx): Honor no_alias list earlier in
812 817 %rehashx, to avoid clobbering builtins in ipy_profile_sh.py
813 818
814 819 * upgrade_dir.py: try import 'path' module a bit harder
815 820 (for %upgrade)
816 821
817 822 2006-06-03 Fernando Perez <Fernando.Perez@colorado.edu>
818 823
819 824 * IPython/genutils.py (ask_yes_no): treat EOF as a default answer
820 825 instead of looping 20 times.
821 826
822 827 * IPython/ipmaker.py (make_IPython): honor -ipythondir flag
823 828 correctly at initialization time. Bug reported by Krishna Mohan
824 829 Gundu <gkmohan-AT-gmail.com> on the user list.
825 830
826 831 * IPython/Release.py (version): Mark 0.7.2 version to start
827 832 testing for release on 06/06.
828 833
829 834 2006-05-31 Fernando Perez <Fernando.Perez@colorado.edu>
830 835
831 836 * scripts/irunner: thin script interface so users don't have to
832 837 find the module and call it as an executable, since modules rarely
833 838 live in people's PATH.
834 839
835 840 * IPython/irunner.py (InteractiveRunner.__init__): added
836 841 delaybeforesend attribute to control delays with newer versions of
837 842 pexpect. Thanks to detailed help from pexpect's author, Noah
838 843 Spurrier <noah-AT-noah.org>. Noted how to use the SAGE runner
839 844 correctly (it works in NoColor mode).
840 845
841 846 * IPython/iplib.py (handle_normal): fix nasty crash reported on
842 847 SAGE list, from improper log() calls.
843 848
844 849 2006-05-31 Ville Vainio <vivainio@gmail.com>
845 850
846 851 * upgrade_dir.py, Magic.py (magic_upgrade): call upgrade_dir
847 852 with args in parens to work correctly with dirs that have spaces.
848 853
849 854 2006-05-30 Fernando Perez <Fernando.Perez@colorado.edu>
850 855
851 856 * IPython/Logger.py (Logger.logstart): add option to log raw input
852 857 instead of the processed one. A -r flag was added to the
853 858 %logstart magic used for controlling logging.
854 859
855 860 2006-05-29 Fernando Perez <Fernando.Perez@colorado.edu>
856 861
857 862 * IPython/iplib.py (InteractiveShell.__init__): add check for the
858 863 *BSDs to omit --color from all 'ls' aliases, since *BSD ls doesn't
859 864 recognize the option. After a bug report by Will Maier. This
860 865 closes #64 (will do it after confirmation from W. Maier).
861 866
862 867 * IPython/irunner.py: New module to run scripts as if manually
863 868 typed into an interactive environment, based on pexpect. After a
864 869 submission by Ken Schutte <kschutte-AT-csail.mit.edu> on the
865 870 ipython-user list. Simple unittests in the tests/ directory.
866 871
867 872 * tools/release: add Will Maier, OpenBSD port maintainer, to
868 873 recepients list. We are now officially part of the OpenBSD ports:
869 874 http://www.openbsd.org/ports.html ! Many thanks to Will for the
870 875 work.
871 876
872 877 2006-05-26 Fernando Perez <Fernando.Perez@colorado.edu>
873 878
874 879 * IPython/ipmaker.py (make_IPython): modify sys.argv fix (below)
875 880 so that it doesn't break tkinter apps.
876 881
877 882 * IPython/iplib.py (_prefilter): fix bug where aliases would
878 883 shadow variables when autocall was fully off. Reported by SAGE
879 884 author William Stein.
880 885
881 886 * IPython/OInspect.py (Inspector.__init__): add a flag to control
882 887 at what detail level strings are computed when foo? is requested.
883 888 This allows users to ask for example that the string form of an
884 889 object is only computed when foo?? is called, or even never, by
885 890 setting the object_info_string_level >= 2 in the configuration
886 891 file. This new option has been added and documented. After a
887 892 request by SAGE to be able to control the printing of very large
888 893 objects more easily.
889 894
890 895 2006-05-25 Fernando Perez <Fernando.Perez@colorado.edu>
891 896
892 897 * IPython/ipmaker.py (make_IPython): remove the ipython call path
893 898 from sys.argv, to be 100% consistent with how Python itself works
894 899 (as seen for example with python -i file.py). After a bug report
895 900 by Jeffrey Collins.
896 901
897 902 * IPython/Shell.py (MatplotlibShellBase._matplotlib_config): Fix
898 903 nasty bug which was preventing custom namespaces with -pylab,
899 904 reported by M. Foord. Minor cleanup, remove old matplotlib.matlab
900 905 compatibility (long gone from mpl).
901 906
902 907 * IPython/ipapi.py (make_session): name change: create->make. We
903 908 use make in other places (ipmaker,...), it's shorter and easier to
904 909 type and say, etc. I'm trying to clean things before 0.7.2 so
905 910 that I can keep things stable wrt to ipapi in the chainsaw branch.
906 911
907 912 * ipython.el: fix the py-pdbtrack-input-prompt variable so that
908 913 python-mode recognizes our debugger mode. Add support for
909 914 autoindent inside (X)emacs. After a patch sent in by Jin Liu
910 915 <m.liu.jin-AT-gmail.com> originally written by
911 916 doxgen-AT-newsmth.net (with minor modifications for xemacs
912 917 compatibility)
913 918
914 919 * IPython/Debugger.py (Pdb.format_stack_entry): fix formatting of
915 920 tracebacks when walking the stack so that the stack tracking system
916 921 in emacs' python-mode can identify the frames correctly.
917 922
918 923 * IPython/ipmaker.py (make_IPython): make the internal (and
919 924 default config) autoedit_syntax value false by default. Too many
920 925 users have complained to me (both on and off-list) about problems
921 926 with this option being on by default, so I'm making it default to
922 927 off. It can still be enabled by anyone via the usual mechanisms.
923 928
924 929 * IPython/completer.py (Completer.attr_matches): add support for
925 930 PyCrust-style _getAttributeNames magic method. Patch contributed
926 931 by <mscott-AT-goldenspud.com>. Closes #50.
927 932
928 933 * IPython/iplib.py (InteractiveShell.__init__): remove the
929 934 deletion of exit/quit from __builtin__, which can break
930 935 third-party tools like the Zope debugging console. The
931 936 %exit/%quit magics remain. In general, it's probably a good idea
932 937 not to delete anything from __builtin__, since we never know what
933 938 that will break. In any case, python now (for 2.5) will support
934 939 'real' exit/quit, so this issue is moot. Closes #55.
935 940
936 941 * IPython/genutils.py (with_obj): rename the 'with' function to
937 942 'withobj' to avoid incompatibilities with Python 2.5, where 'with'
938 943 becomes a language keyword. Closes #53.
939 944
940 945 * IPython/FakeModule.py (FakeModule.__init__): add a proper
941 946 __file__ attribute to this so it fools more things into thinking
942 947 it is a real module. Closes #59.
943 948
944 949 * IPython/Magic.py (magic_edit): add -n option to open the editor
945 950 at a specific line number. After a patch by Stefan van der Walt.
946 951
947 952 2006-05-23 Fernando Perez <Fernando.Perez@colorado.edu>
948 953
949 954 * IPython/iplib.py (edit_syntax_error): fix crash when for some
950 955 reason the file could not be opened. After automatic crash
951 956 reports sent by James Graham <jgraham-AT-ast.cam.ac.uk> and
952 957 Charles Dolan <charlespatrickdolan-AT-yahoo.com>.
953 958 (_should_recompile): Don't fire editor if using %bg, since there
954 959 is no file in the first place. From the same report as above.
955 960 (raw_input): protect against faulty third-party prefilters. After
956 961 an automatic crash report sent by Dirk Laurie <dirk-AT-sun.ac.za>
957 962 while running under SAGE.
958 963
959 964 2006-05-23 Ville Vainio <vivainio@gmail.com>
960 965
961 966 * ipapi.py: Stripped down ip.to_user_ns() to work only as
962 967 ip.to_user_ns("x1 y1"), which exposes vars x1 and y1. ipapi.get()
963 968 now returns None (again), unless dummy is specifically allowed by
964 969 ipapi.get(allow_dummy=True).
965 970
966 971 2006-05-18 Fernando Perez <Fernando.Perez@colorado.edu>
967 972
968 973 * IPython: remove all 2.2-compatibility objects and hacks from
969 974 everywhere, since we only support 2.3 at this point. Docs
970 975 updated.
971 976
972 977 * IPython/ipapi.py (IPApi.__init__): Cleanup of all getters.
973 978 Anything requiring extra validation can be turned into a Python
974 979 property in the future. I used a property for the db one b/c
975 980 there was a nasty circularity problem with the initialization
976 981 order, which right now I don't have time to clean up.
977 982
978 983 * IPython/Shell.py (MTInteractiveShell.runcode): Fix, I think,
979 984 another locking bug reported by Jorgen. I'm not 100% sure though,
980 985 so more testing is needed...
981 986
982 987 2006-05-17 Fernando Perez <Fernando.Perez@colorado.edu>
983 988
984 989 * IPython/ipapi.py (IPApi.to_user_ns): New function to inject
985 990 local variables from any routine in user code (typically executed
986 991 with %run) directly into the interactive namespace. Very useful
987 992 when doing complex debugging.
988 993 (IPythonNotRunning): Changed the default None object to a dummy
989 994 whose attributes can be queried as well as called without
990 995 exploding, to ease writing code which works transparently both in
991 996 and out of ipython and uses some of this API.
992 997
993 998 2006-05-16 Fernando Perez <Fernando.Perez@colorado.edu>
994 999
995 1000 * IPython/hooks.py (result_display): Fix the fact that our display
996 1001 hook was using str() instead of repr(), as the default python
997 1002 console does. This had gone unnoticed b/c it only happened if
998 1003 %Pprint was off, but the inconsistency was there.
999 1004
1000 1005 2006-05-15 Ville Vainio <vivainio@gmail.com>
1001 1006
1002 1007 * Oinspect.py: Only show docstring for nonexisting/binary files
1003 1008 when doing object??, closing ticket #62
1004 1009
1005 1010 2006-05-13 Fernando Perez <Fernando.Perez@colorado.edu>
1006 1011
1007 1012 * IPython/Shell.py (MTInteractiveShell.runsource): Fix threading
1008 1013 bug, closes http://www.scipy.net/roundup/ipython/issue55. A lock
1009 1014 was being released in a routine which hadn't checked if it had
1010 1015 been the one to acquire it.
1011 1016
1012 1017 2006-05-07 Fernando Perez <Fernando.Perez@colorado.edu>
1013 1018
1014 1019 * IPython/Release.py (version): put out 0.7.2.rc1 for testing.
1015 1020
1016 1021 2006-04-11 Ville Vainio <vivainio@gmail.com>
1017 1022
1018 1023 * iplib.py, ipmaker.py: .ipy extension now means "ipython batch file"
1019 1024 in command line. E.g. "ipython test.ipy" runs test.ipy with ipython
1020 1025 prefilters, allowing stuff like magics and aliases in the file.
1021 1026
1022 1027 * Prompts.py, Extensions/clearcmd.py, ipy_system_conf.py: %clear magic
1023 1028 added. Supported now are "%clear in" and "%clear out" (clear input and
1024 1029 output history, respectively). Also fixed CachedOutput.flush to
1025 1030 properly flush the output cache.
1026 1031
1027 1032 * Extensions/pspersistence.py: Fix %store to avoid "%store obj.attr"
1028 1033 half-success (and fail explicitly).
1029 1034
1030 1035 2006-03-28 Ville Vainio <vivainio@gmail.com>
1031 1036
1032 1037 * iplib.py: Fix quoting of aliases so that only argless ones
1033 1038 are quoted
1034 1039
1035 1040 2006-03-28 Ville Vainio <vivainio@gmail.com>
1036 1041
1037 1042 * iplib.py: Quote aliases with spaces in the name.
1038 1043 "c:\program files\blah\bin" is now legal alias target.
1039 1044
1040 1045 * ext_rehashdir.py: Space no longer allowed as arg
1041 1046 separator, since space is legal in path names.
1042 1047
1043 1048 2006-03-16 Ville Vainio <vivainio@gmail.com>
1044 1049
1045 1050 * upgrade_dir.py: Take path.py from Extensions, correcting
1046 1051 %upgrade magic
1047 1052
1048 1053 * ipmaker.py: Suggest using %upgrade if ipy_user_conf.py isn't found.
1049 1054
1050 1055 * hooks.py: Only enclose editor binary in quotes if legal and
1051 1056 necessary (space in the name, and is an existing file). Fixes a bug
1052 1057 reported by Zachary Pincus.
1053 1058
1054 1059 2006-03-13 Fernando Perez <Fernando.Perez@colorado.edu>
1055 1060
1056 1061 * Manual: thanks to a tip on proper color handling for Emacs, by
1057 1062 Eric J Haywiser <ejh1-AT-MIT.EDU>.
1058 1063
1059 1064 * ipython.el: close http://www.scipy.net/roundup/ipython/issue57
1060 1065 by applying the provided patch. Thanks to Liu Jin
1061 1066 <m.liu.jin-AT-gmail.com> for the contribution. No problems under
1062 1067 XEmacs/Linux, I'm trusting the submitter that it actually helps
1063 1068 under win32/GNU Emacs. Will revisit if any problems are reported.
1064 1069
1065 1070 2006-03-12 Fernando Perez <Fernando.Perez@colorado.edu>
1066 1071
1067 1072 * IPython/Gnuplot2.py (_FileClass): update for current Gnuplot.py
1068 1073 from SVN, thanks to a patch by Ryan Woodard <rywo@bas.ac.uk>.
1069 1074
1070 1075 2006-03-12 Ville Vainio <vivainio@gmail.com>
1071 1076
1072 1077 * Magic.py (magic_timeit): Added %timeit magic, contributed by
1073 1078 Torsten Marek.
1074 1079
1075 1080 2006-03-12 Fernando Perez <Fernando.Perez@colorado.edu>
1076 1081
1077 1082 * IPython/Magic.py (magic_macro): fix so that the n1-n2 syntax for
1078 1083 line ranges works again.
1079 1084
1080 1085 2006-03-11 Fernando Perez <Fernando.Perez@colorado.edu>
1081 1086
1082 1087 * IPython/iplib.py (showtraceback): add back sys.last_traceback
1083 1088 and friends, after a discussion with Zach Pincus on ipython-user.
1084 1089 I'm not 100% sure, but after thinking about it quite a bit, it may
1085 1090 be OK. Testing with the multithreaded shells didn't reveal any
1086 1091 problems, but let's keep an eye out.
1087 1092
1088 1093 In the process, I fixed a few things which were calling
1089 1094 self.InteractiveTB() directly (like safe_execfile), which is a
1090 1095 mistake: ALL exception reporting should be done by calling
1091 1096 self.showtraceback(), which handles state and tab-completion and
1092 1097 more.
1093 1098
1094 1099 2006-03-01 Ville Vainio <vivainio@gmail.com>
1095 1100
1096 1101 * Extensions/ipipe.py: Added Walter Doerwald's "ipipe" module.
1097 1102 To use, do "from ipipe import *".
1098 1103
1099 1104 2006-02-24 Ville Vainio <vivainio@gmail.com>
1100 1105
1101 1106 * Magic.py, upgrade_dir.py: %upgrade magic added. Does things more
1102 1107 "cleanly" and safely than the older upgrade mechanism.
1103 1108
1104 1109 2006-02-21 Ville Vainio <vivainio@gmail.com>
1105 1110
1106 1111 * Magic.py: %save works again.
1107 1112
1108 1113 2006-02-15 Ville Vainio <vivainio@gmail.com>
1109 1114
1110 1115 * Magic.py: %Pprint works again
1111 1116
1112 1117 * Extensions/ipy_sane_defaults.py: Provide everything provided
1113 1118 in default ipythonrc, to make it possible to have a completely empty
1114 1119 ipythonrc (and thus completely rc-file free configuration)
1115 1120
1116 1121 2006-02-11 Fernando Perez <Fernando.Perez@colorado.edu>
1117 1122
1118 1123 * IPython/hooks.py (editor): quote the call to the editor command,
1119 1124 to allow commands with spaces in them. Problem noted by watching
1120 1125 Ian Oswald's video about textpad under win32 at
1121 1126 http://showmedo.com/videoListPage?listKey=PythonIPythonSeries
1122 1127
1123 1128 * IPython/UserConfig/ipythonrc: Replace @ signs with % when
1124 1129 describing magics (we haven't used @ for a loong time).
1125 1130
1126 1131 * IPython/ultraTB.py (VerboseTB.text.text_repr): Added patch
1127 1132 contributed by marienz to close
1128 1133 http://www.scipy.net/roundup/ipython/issue53.
1129 1134
1130 1135 2006-02-10 Ville Vainio <vivainio@gmail.com>
1131 1136
1132 1137 * genutils.py: getoutput now works in win32 too
1133 1138
1134 1139 * completer.py: alias and magic completion only invoked
1135 1140 at the first "item" in the line, to avoid "cd %store"
1136 1141 nonsense.
1137 1142
1138 1143 2006-02-09 Ville Vainio <vivainio@gmail.com>
1139 1144
1140 1145 * test/*: Added a unit testing framework (finally).
1141 1146 '%run runtests.py' to run test_*.
1142 1147
1143 1148 * ipapi.py: Exposed runlines and set_custom_exc
1144 1149
1145 1150 2006-02-07 Ville Vainio <vivainio@gmail.com>
1146 1151
1147 1152 * iplib.py: don't split "f 1 2" to "f(1,2)" in autocall,
1148 1153 instead use "f(1 2)" as before.
1149 1154
1150 1155 2006-02-05 Fernando Perez <Fernando.Perez@colorado.edu>
1151 1156
1152 1157 * IPython/demo.py (IPythonDemo): Add new classes to the demo
1153 1158 facilities, for demos processed by the IPython input filter
1154 1159 (IPythonDemo), and for running a script one-line-at-a-time as a
1155 1160 demo, both for pure Python (LineDemo) and for IPython-processed
1156 1161 input (IPythonLineDemo). After a request by Dave Kohel, from the
1157 1162 SAGE team.
1158 1163 (Demo.edit): added an edit() method to the demo objects, to edit
1159 1164 the in-memory copy of the last executed block.
1160 1165
1161 1166 * IPython/Magic.py (magic_edit): add '-r' option for 'raw'
1162 1167 processing to %edit, %macro and %save. These commands can now be
1163 1168 invoked on the unprocessed input as it was typed by the user
1164 1169 (without any prefilters applied). After requests by the SAGE team
1165 1170 at SAGE days 2006: http://modular.ucsd.edu/sage/days1/schedule.html.
1166 1171
1167 1172 2006-02-01 Ville Vainio <vivainio@gmail.com>
1168 1173
1169 1174 * setup.py, eggsetup.py: easy_install ipython==dev works
1170 1175 correctly now (on Linux)
1171 1176
1172 1177 * ipy_user_conf,ipmaker: user config changes, removed spurious
1173 1178 warnings
1174 1179
1175 1180 * iplib: if rc.banner is string, use it as is.
1176 1181
1177 1182 * Magic: %pycat accepts a string argument and pages it's contents.
1178 1183
1179 1184
1180 1185 2006-01-30 Ville Vainio <vivainio@gmail.com>
1181 1186
1182 1187 * pickleshare,pspersistence,ipapi,Magic: persistence overhaul.
1183 1188 Now %store and bookmarks work through PickleShare, meaning that
1184 1189 concurrent access is possible and all ipython sessions see the
1185 1190 same database situation all the time, instead of snapshot of
1186 1191 the situation when the session was started. Hence, %bookmark
1187 1192 results are immediately accessible from othes sessions. The database
1188 1193 is also available for use by user extensions. See:
1189 1194 http://www.python.org/pypi/pickleshare
1190 1195
1191 1196 * hooks.py: Two new hooks, 'shutdown_hook' and 'late_startup_hook'.
1192 1197
1193 1198 * aliases can now be %store'd
1194 1199
1195 1200 * path.py moved to Extensions so that pickleshare does not need
1196 1201 IPython-specific import. Extensions added to pythonpath right
1197 1202 at __init__.
1198 1203
1199 1204 * iplib.py: ipalias deprecated/redundant; aliases are converted and
1200 1205 called with _ip.system and the pre-transformed command string.
1201 1206
1202 1207 2006-01-29 Fernando Perez <Fernando.Perez@colorado.edu>
1203 1208
1204 1209 * IPython/iplib.py (interact): Fix that we were not catching
1205 1210 KeyboardInterrupt exceptions properly. I'm not quite sure why the
1206 1211 logic here had to change, but it's fixed now.
1207 1212
1208 1213 2006-01-29 Ville Vainio <vivainio@gmail.com>
1209 1214
1210 1215 * iplib.py: Try to import pyreadline on Windows.
1211 1216
1212 1217 2006-01-27 Ville Vainio <vivainio@gmail.com>
1213 1218
1214 1219 * iplib.py: Expose ipapi as _ip in builtin namespace.
1215 1220 Makes ipmagic (-> _ip.magic), ipsystem (-> _ip.system)
1216 1221 and ip_set_hook (-> _ip.set_hook) redundant. % and !
1217 1222 syntax now produce _ip.* variant of the commands.
1218 1223
1219 1224 * "_ip.options().autoedit_syntax = 2" automatically throws
1220 1225 user to editor for syntax error correction without prompting.
1221 1226
1222 1227 2006-01-27 Ville Vainio <vivainio@gmail.com>
1223 1228
1224 1229 * ipmaker.py: Give "realistic" sys.argv for scripts (without
1225 1230 'ipython' at argv[0]) executed through command line.
1226 1231 NOTE: this DEPRECATES calling ipython with multiple scripts
1227 1232 ("ipython a.py b.py c.py")
1228 1233
1229 1234 * iplib.py, hooks.py: Added configurable input prefilter,
1230 1235 named 'input_prefilter'. See ext_rescapture.py for example
1231 1236 usage.
1232 1237
1233 1238 * ext_rescapture.py, Magic.py: Better system command output capture
1234 1239 through 'var = !ls' (deprecates user-visible %sc). Same notation
1235 1240 applies for magics, 'var = %alias' assigns alias list to var.
1236 1241
1237 1242 * ipapi.py: added meta() for accessing extension-usable data store.
1238 1243
1239 1244 * iplib.py: added InteractiveShell.getapi(). New magics should be
1240 1245 written doing self.getapi() instead of using the shell directly.
1241 1246
1242 1247 * Magic.py: %store now allows doing %store foo > ~/myfoo.txt and
1243 1248 %store foo >> ~/myfoo.txt to store variables to files (in clean
1244 1249 textual form, not a restorable pickle).
1245 1250
1246 1251 * ipmaker.py: now import ipy_profile_PROFILENAME automatically
1247 1252
1248 1253 * usage.py, Magic.py: added %quickref
1249 1254
1250 1255 * iplib.py: ESC_PAREN fixes: /f 1 2 -> f(1,2), not f(1 2).
1251 1256
1252 1257 * GetoptErrors when invoking magics etc. with wrong args
1253 1258 are now more helpful:
1254 1259 GetoptError: option -l not recognized (allowed: "qb" )
1255 1260
1256 1261 2006-01-25 Fernando Perez <Fernando.Perez@colorado.edu>
1257 1262
1258 1263 * IPython/demo.py (Demo.show): Flush stdout after each block, so
1259 1264 computationally intensive blocks don't appear to stall the demo.
1260 1265
1261 1266 2006-01-24 Ville Vainio <vivainio@gmail.com>
1262 1267
1263 1268 * iplib.py, hooks.py: 'result_display' hook can return a non-None
1264 1269 value to manipulate resulting history entry.
1265 1270
1266 1271 * ipapi.py: Moved TryNext here from hooks.py. Moved functions
1267 1272 to instance methods of IPApi class, to make extending an embedded
1268 1273 IPython feasible. See ext_rehashdir.py for example usage.
1269 1274
1270 1275 * Merged 1071-1076 from branches/0.7.1
1271 1276
1272 1277
1273 1278 2006-01-23 Fernando Perez <Fernando.Perez@colorado.edu>
1274 1279
1275 1280 * tools/release (daystamp): Fix build tools to use the new
1276 1281 eggsetup.py script to build lightweight eggs.
1277 1282
1278 1283 * Applied changesets 1062 and 1064 before 0.7.1 release.
1279 1284
1280 1285 * IPython/Magic.py (magic_history): Add '-r' option to %hist, to
1281 1286 see the raw input history (without conversions like %ls ->
1282 1287 ipmagic("ls")). After a request from W. Stein, SAGE
1283 1288 (http://modular.ucsd.edu/sage) developer. This information is
1284 1289 stored in the input_hist_raw attribute of the IPython instance, so
1285 1290 developers can access it if needed (it's an InputList instance).
1286 1291
1287 1292 * Versionstring = 0.7.2.svn
1288 1293
1289 1294 * eggsetup.py: A separate script for constructing eggs, creates
1290 1295 proper launch scripts even on Windows (an .exe file in
1291 1296 \python24\scripts).
1292 1297
1293 1298 * ipapi.py: launch_new_instance, launch entry point needed for the
1294 1299 egg.
1295 1300
1296 1301 2006-01-23 Ville Vainio <vivainio@gmail.com>
1297 1302
1298 1303 * Added %cpaste magic for pasting python code
1299 1304
1300 1305 2006-01-22 Ville Vainio <vivainio@gmail.com>
1301 1306
1302 1307 * Merge from branches/0.7.1 into trunk, revs 1052-1057
1303 1308
1304 1309 * Versionstring = 0.7.2.svn
1305 1310
1306 1311 * eggsetup.py: A separate script for constructing eggs, creates
1307 1312 proper launch scripts even on Windows (an .exe file in
1308 1313 \python24\scripts).
1309 1314
1310 1315 * ipapi.py: launch_new_instance, launch entry point needed for the
1311 1316 egg.
1312 1317
1313 1318 2006-01-22 Fernando Perez <Fernando.Perez@colorado.edu>
1314 1319
1315 1320 * IPython/OInspect.py (Inspector.pinfo): fix bug where foo?? or
1316 1321 %pfile foo would print the file for foo even if it was a binary.
1317 1322 Now, extensions '.so' and '.dll' are skipped.
1318 1323
1319 1324 * IPython/Shell.py (MTInteractiveShell.__init__): Fix threading
1320 1325 bug, where macros would fail in all threaded modes. I'm not 100%
1321 1326 sure, so I'm going to put out an rc instead of making a release
1322 1327 today, and wait for feedback for at least a few days.
1323 1328
1324 1329 * IPython/iplib.py (handle_normal): fix (finally? somehow I doubt
1325 1330 it...) the handling of pasting external code with autoindent on.
1326 1331 To get out of a multiline input, the rule will appear for most
1327 1332 users unchanged: two blank lines or change the indent level
1328 1333 proposed by IPython. But there is a twist now: you can
1329 1334 add/subtract only *one or two spaces*. If you add/subtract three
1330 1335 or more (unless you completely delete the line), IPython will
1331 1336 accept that line, and you'll need to enter a second one of pure
1332 1337 whitespace. I know it sounds complicated, but I can't find a
1333 1338 different solution that covers all the cases, with the right
1334 1339 heuristics. Hopefully in actual use, nobody will really notice
1335 1340 all these strange rules and things will 'just work'.
1336 1341
1337 1342 2006-01-21 Fernando Perez <Fernando.Perez@colorado.edu>
1338 1343
1339 1344 * IPython/iplib.py (interact): catch exceptions which can be
1340 1345 triggered asynchronously by signal handlers. Thanks to an
1341 1346 automatic crash report, submitted by Colin Kingsley
1342 1347 <tercel-AT-gentoo.org>.
1343 1348
1344 1349 2006-01-20 Ville Vainio <vivainio@gmail.com>
1345 1350
1346 1351 * Ipython/Extensions/ext_rehashdir.py: Created a usable example
1347 1352 (%rehashdir, very useful, try it out) of how to extend ipython
1348 1353 with new magics. Also added Extensions dir to pythonpath to make
1349 1354 importing extensions easy.
1350 1355
1351 1356 * %store now complains when trying to store interactively declared
1352 1357 classes / instances of those classes.
1353 1358
1354 1359 * Extensions/ipy_system_conf.py, UserConfig/ipy_user_conf.py,
1355 1360 ipmaker.py: Config rehaul. Now ipy_..._conf.py are always imported
1356 1361 if they exist, and ipy_user_conf.py with some defaults is created for
1357 1362 the user.
1358 1363
1359 1364 * Startup rehashing done by the config file, not InterpreterExec.
1360 1365 This means system commands are available even without selecting the
1361 1366 pysh profile. It's the sensible default after all.
1362 1367
1363 1368 2006-01-20 Fernando Perez <Fernando.Perez@colorado.edu>
1364 1369
1365 1370 * IPython/iplib.py (raw_input): I _think_ I got the pasting of
1366 1371 multiline code with autoindent on working. But I am really not
1367 1372 sure, so this needs more testing. Will commit a debug-enabled
1368 1373 version for now, while I test it some more, so that Ville and
1369 1374 others may also catch any problems. Also made
1370 1375 self.indent_current_str() a method, to ensure that there's no
1371 1376 chance of the indent space count and the corresponding string
1372 1377 falling out of sync. All code needing the string should just call
1373 1378 the method.
1374 1379
1375 1380 2006-01-18 Fernando Perez <Fernando.Perez@colorado.edu>
1376 1381
1377 1382 * IPython/Magic.py (magic_edit): fix check for when users don't
1378 1383 save their output files, the try/except was in the wrong section.
1379 1384
1380 1385 2006-01-17 Fernando Perez <Fernando.Perez@colorado.edu>
1381 1386
1382 1387 * IPython/Magic.py (magic_run): fix __file__ global missing from
1383 1388 script's namespace when executed via %run. After a report by
1384 1389 Vivian.
1385 1390
1386 1391 * IPython/Debugger.py (Pdb.__init__): Fix breakage with '%run -d'
1387 1392 when using python 2.4. The parent constructor changed in 2.4, and
1388 1393 we need to track it directly (we can't call it, as it messes up
1389 1394 readline and tab-completion inside our pdb would stop working).
1390 1395 After a bug report by R. Bernstein <rocky-AT-panix.com>.
1391 1396
1392 1397 2006-01-16 Ville Vainio <vivainio@gmail.com>
1393 1398
1394 1399 * Ipython/magic.py: Reverted back to old %edit functionality
1395 1400 that returns file contents on exit.
1396 1401
1397 1402 * IPython/path.py: Added Jason Orendorff's "path" module to
1398 1403 IPython tree, http://www.jorendorff.com/articles/python/path/.
1399 1404 You can get path objects conveniently through %sc, and !!, e.g.:
1400 1405 sc files=ls
1401 1406 for p in files.paths: # or files.p
1402 1407 print p,p.mtime
1403 1408
1404 1409 * Ipython/iplib.py:"," and ";" autoquoting-upon-autocall
1405 1410 now work again without considering the exclusion regexp -
1406 1411 hence, things like ',foo my/path' turn to 'foo("my/path")'
1407 1412 instead of syntax error.
1408 1413
1409 1414
1410 1415 2006-01-14 Ville Vainio <vivainio@gmail.com>
1411 1416
1412 1417 * IPython/ipapi.py (ashook, asmagic, options): Added convenience
1413 1418 ipapi decorators for python 2.4 users, options() provides access to rc
1414 1419 data.
1415 1420
1416 1421 * IPython/Magic.py (magic_cd): %cd now accepts backslashes
1417 1422 as path separators (even on Linux ;-). Space character after
1418 1423 backslash (as yielded by tab completer) is still space;
1419 1424 "%cd long\ name" works as expected.
1420 1425
1421 1426 * IPython/ipapi.py,hooks.py,iplib.py: Hooks now implemented
1422 1427 as "chain of command", with priority. API stays the same,
1423 1428 TryNext exception raised by a hook function signals that
1424 1429 current hook failed and next hook should try handling it, as
1425 1430 suggested by Walter DΓΆrwald <walter@livinglogic.de>. Walter also
1426 1431 requested configurable display hook, which is now implemented.
1427 1432
1428 1433 2006-01-13 Ville Vainio <vivainio@gmail.com>
1429 1434
1430 1435 * IPython/platutils*.py: platform specific utility functions,
1431 1436 so far only set_term_title is implemented (change terminal
1432 1437 label in windowing systems). %cd now changes the title to
1433 1438 current dir.
1434 1439
1435 1440 * IPython/Release.py: Added myself to "authors" list,
1436 1441 had to create new files.
1437 1442
1438 1443 * IPython/iplib.py (handle_shell_escape): fixed logical flaw in
1439 1444 shell escape; not a known bug but had potential to be one in the
1440 1445 future.
1441 1446
1442 1447 * IPython/ipapi.py (added),OInspect.py,iplib.py: "Public"
1443 1448 extension API for IPython! See the module for usage example. Fix
1444 1449 OInspect for docstring-less magic functions.
1445 1450
1446 1451
1447 1452 2006-01-13 Fernando Perez <Fernando.Perez@colorado.edu>
1448 1453
1449 1454 * IPython/iplib.py (raw_input): temporarily deactivate all
1450 1455 attempts at allowing pasting of code with autoindent on. It
1451 1456 introduced bugs (reported by Prabhu) and I can't seem to find a
1452 1457 robust combination which works in all cases. Will have to revisit
1453 1458 later.
1454 1459
1455 1460 * IPython/genutils.py: remove isspace() function. We've dropped
1456 1461 2.2 compatibility, so it's OK to use the string method.
1457 1462
1458 1463 2006-01-12 Fernando Perez <Fernando.Perez@colorado.edu>
1459 1464
1460 1465 * IPython/iplib.py (InteractiveShell.__init__): fix regexp
1461 1466 matching what NOT to autocall on, to include all python binary
1462 1467 operators (including things like 'and', 'or', 'is' and 'in').
1463 1468 Prompted by a bug report on 'foo & bar', but I realized we had
1464 1469 many more potential bug cases with other operators. The regexp is
1465 1470 self.re_exclude_auto, it's fairly commented.
1466 1471
1467 1472 2006-01-12 Ville Vainio <vivainio@gmail.com>
1468 1473
1469 1474 * IPython/iplib.py (make_quoted_expr,handle_shell_escape):
1470 1475 Prettified and hardened string/backslash quoting with ipsystem(),
1471 1476 ipalias() and ipmagic(). Now even \ characters are passed to
1472 1477 %magics, !shell escapes and aliases exactly as they are in the
1473 1478 ipython command line. Should improve backslash experience,
1474 1479 particularly in Windows (path delimiter for some commands that
1475 1480 won't understand '/'), but Unix benefits as well (regexps). %cd
1476 1481 magic still doesn't support backslash path delimiters, though. Also
1477 1482 deleted all pretense of supporting multiline command strings in
1478 1483 !system or %magic commands. Thanks to Jerry McRae for suggestions.
1479 1484
1480 1485 * doc/build_doc_instructions.txt added. Documentation on how to
1481 1486 use doc/update_manual.py, added yesterday. Both files contributed
1482 1487 by JΓΆrgen Stenarson <jorgen.stenarson-AT-bostream.nu>. This slates
1483 1488 doc/*.sh for deprecation at a later date.
1484 1489
1485 1490 * /ipython.py Added ipython.py to root directory for
1486 1491 zero-installation (tar xzvf ipython.tgz; cd ipython; python
1487 1492 ipython.py) and development convenience (no need to keep doing
1488 1493 "setup.py install" between changes).
1489 1494
1490 1495 * Made ! and !! shell escapes work (again) in multiline expressions:
1491 1496 if 1:
1492 1497 !ls
1493 1498 !!ls
1494 1499
1495 1500 2006-01-12 Fernando Perez <Fernando.Perez@colorado.edu>
1496 1501
1497 1502 * IPython/ipstruct.py (Struct): Rename IPython.Struct to
1498 1503 IPython.ipstruct, to avoid local shadowing of the stdlib 'struct'
1499 1504 module in case-insensitive installation. Was causing crashes
1500 1505 under win32. Closes http://www.scipy.net/roundup/ipython/issue49.
1501 1506
1502 1507 * IPython/Magic.py (magic_pycat): Fix pycat, patch by Marien Zwart
1503 1508 <marienz-AT-gentoo.org>, closes
1504 1509 http://www.scipy.net/roundup/ipython/issue51.
1505 1510
1506 1511 2006-01-11 Fernando Perez <Fernando.Perez@colorado.edu>
1507 1512
1508 1513 * IPython/Shell.py (IPShellGTK.on_timer): Finally fix the
1509 1514 problem of excessive CPU usage under *nix and keyboard lag under
1510 1515 win32.
1511 1516
1512 1517 2006-01-10 *** Released version 0.7.0
1513 1518
1514 1519 2006-01-10 Fernando Perez <Fernando.Perez@colorado.edu>
1515 1520
1516 1521 * IPython/Release.py (revision): tag version number to 0.7.0,
1517 1522 ready for release.
1518 1523
1519 1524 * IPython/Magic.py (magic_edit): Add print statement to %edit so
1520 1525 it informs the user of the name of the temp. file used. This can
1521 1526 help if you decide later to reuse that same file, so you know
1522 1527 where to copy the info from.
1523 1528
1524 1529 2006-01-09 Fernando Perez <Fernando.Perez@colorado.edu>
1525 1530
1526 1531 * setup_bdist_egg.py: little script to build an egg. Added
1527 1532 support in the release tools as well.
1528 1533
1529 1534 2006-01-08 Fernando Perez <Fernando.Perez@colorado.edu>
1530 1535
1531 1536 * IPython/Shell.py (IPShellWX.__init__): add support for WXPython
1532 1537 version selection (new -wxversion command line and ipythonrc
1533 1538 parameter). Patch contributed by Arnd Baecker
1534 1539 <arnd.baecker-AT-web.de>.
1535 1540
1536 1541 * IPython/iplib.py (embed_mainloop): fix tab-completion in
1537 1542 embedded instances, for variables defined at the interactive
1538 1543 prompt of the embedded ipython. Reported by Arnd.
1539 1544
1540 1545 * IPython/Magic.py (magic_autocall): Fix %autocall magic. Now
1541 1546 it can be used as a (stateful) toggle, or with a direct parameter.
1542 1547
1543 1548 * IPython/ultraTB.py (_fixed_getinnerframes): remove debug assert which
1544 1549 could be triggered in certain cases and cause the traceback
1545 1550 printer not to work.
1546 1551
1547 1552 2006-01-07 Fernando Perez <Fernando.Perez@colorado.edu>
1548 1553
1549 1554 * IPython/iplib.py (_should_recompile): Small fix, closes
1550 1555 http://www.scipy.net/roundup/ipython/issue48. Patch by Scott.
1551 1556
1552 1557 2006-01-04 Fernando Perez <Fernando.Perez@colorado.edu>
1553 1558
1554 1559 * IPython/Shell.py (IPShellGTK.mainloop): fix bug in the GTK
1555 1560 backend for matplotlib (100% cpu utiliziation). Thanks to Charlie
1556 1561 Moad for help with tracking it down.
1557 1562
1558 1563 * IPython/iplib.py (handle_auto): fix autocall handling for
1559 1564 objects which support BOTH __getitem__ and __call__ (so that f [x]
1560 1565 is left alone, instead of becoming f([x]) automatically).
1561 1566
1562 1567 * IPython/Magic.py (magic_cd): fix crash when cd -b was used.
1563 1568 Ville's patch.
1564 1569
1565 1570 2006-01-03 Fernando Perez <Fernando.Perez@colorado.edu>
1566 1571
1567 1572 * IPython/iplib.py (handle_auto): changed autocall semantics to
1568 1573 include 'smart' mode, where the autocall transformation is NOT
1569 1574 applied if there are no arguments on the line. This allows you to
1570 1575 just type 'foo' if foo is a callable to see its internal form,
1571 1576 instead of having it called with no arguments (typically a
1572 1577 mistake). The old 'full' autocall still exists: for that, you
1573 1578 need to set the 'autocall' parameter to 2 in your ipythonrc file.
1574 1579
1575 1580 * IPython/completer.py (Completer.attr_matches): add
1576 1581 tab-completion support for Enthoughts' traits. After a report by
1577 1582 Arnd and a patch by Prabhu.
1578 1583
1579 1584 2006-01-02 Fernando Perez <Fernando.Perez@colorado.edu>
1580 1585
1581 1586 * IPython/ultraTB.py (_fixed_getinnerframes): added Alex
1582 1587 Schmolck's patch to fix inspect.getinnerframes().
1583 1588
1584 1589 * IPython/iplib.py (InteractiveShell.__init__): significant fixes
1585 1590 for embedded instances, regarding handling of namespaces and items
1586 1591 added to the __builtin__ one. Multiple embedded instances and
1587 1592 recursive embeddings should work better now (though I'm not sure
1588 1593 I've got all the corner cases fixed, that code is a bit of a brain
1589 1594 twister).
1590 1595
1591 1596 * IPython/Magic.py (magic_edit): added support to edit in-memory
1592 1597 macros (automatically creates the necessary temp files). %edit
1593 1598 also doesn't return the file contents anymore, it's just noise.
1594 1599
1595 1600 * IPython/completer.py (Completer.attr_matches): revert change to
1596 1601 complete only on attributes listed in __all__. I realized it
1597 1602 cripples the tab-completion system as a tool for exploring the
1598 1603 internals of unknown libraries (it renders any non-__all__
1599 1604 attribute off-limits). I got bit by this when trying to see
1600 1605 something inside the dis module.
1601 1606
1602 1607 2005-12-31 Fernando Perez <Fernando.Perez@colorado.edu>
1603 1608
1604 1609 * IPython/iplib.py (InteractiveShell.__init__): add .meta
1605 1610 namespace for users and extension writers to hold data in. This
1606 1611 follows the discussion in
1607 1612 http://projects.scipy.org/ipython/ipython/wiki/RefactoringIPython.
1608 1613
1609 1614 * IPython/completer.py (IPCompleter.complete): small patch to help
1610 1615 tab-completion under Emacs, after a suggestion by John Barnard
1611 1616 <barnarj-AT-ccf.org>.
1612 1617
1613 1618 * IPython/Magic.py (Magic.extract_input_slices): added support for
1614 1619 the slice notation in magics to use N-M to represent numbers N...M
1615 1620 (closed endpoints). This is used by %macro and %save.
1616 1621
1617 1622 * IPython/completer.py (Completer.attr_matches): for modules which
1618 1623 define __all__, complete only on those. After a patch by Jeffrey
1619 1624 Collins <jcollins_boulder-AT-earthlink.net>. Also, clean up and
1620 1625 speed up this routine.
1621 1626
1622 1627 * IPython/Logger.py (Logger.log): fix a history handling bug. I
1623 1628 don't know if this is the end of it, but the behavior now is
1624 1629 certainly much more correct. Note that coupled with macros,
1625 1630 slightly surprising (at first) behavior may occur: a macro will in
1626 1631 general expand to multiple lines of input, so upon exiting, the
1627 1632 in/out counters will both be bumped by the corresponding amount
1628 1633 (as if the macro's contents had been typed interactively). Typing
1629 1634 %hist will reveal the intermediate (silently processed) lines.
1630 1635
1631 1636 * IPython/Magic.py (magic_run): fix a subtle bug which could cause
1632 1637 pickle to fail (%run was overwriting __main__ and not restoring
1633 1638 it, but pickle relies on __main__ to operate).
1634 1639
1635 1640 * IPython/iplib.py (InteractiveShell): fix pdb calling: I'm now
1636 1641 using properties, but forgot to make the main InteractiveShell
1637 1642 class a new-style class. Properties fail silently, and
1638 1643 mysteriously, with old-style class (getters work, but
1639 1644 setters don't do anything).
1640 1645
1641 1646 2005-12-30 Fernando Perez <Fernando.Perez@colorado.edu>
1642 1647
1643 1648 * IPython/Magic.py (magic_history): fix history reporting bug (I
1644 1649 know some nasties are still there, I just can't seem to find a
1645 1650 reproducible test case to track them down; the input history is
1646 1651 falling out of sync...)
1647 1652
1648 1653 * IPython/iplib.py (handle_shell_escape): fix bug where both
1649 1654 aliases and system accesses where broken for indented code (such
1650 1655 as loops).
1651 1656
1652 1657 * IPython/genutils.py (shell): fix small but critical bug for
1653 1658 win32 system access.
1654 1659
1655 1660 2005-12-29 Fernando Perez <Fernando.Perez@colorado.edu>
1656 1661
1657 1662 * IPython/iplib.py (showtraceback): remove use of the
1658 1663 sys.last_{type/value/traceback} structures, which are non
1659 1664 thread-safe.
1660 1665 (_prefilter): change control flow to ensure that we NEVER
1661 1666 introspect objects when autocall is off. This will guarantee that
1662 1667 having an input line of the form 'x.y', where access to attribute
1663 1668 'y' has side effects, doesn't trigger the side effect TWICE. It
1664 1669 is important to note that, with autocall on, these side effects
1665 1670 can still happen.
1666 1671 (ipsystem): new builtin, to complete the ip{magic/alias/system}
1667 1672 trio. IPython offers these three kinds of special calls which are
1668 1673 not python code, and it's a good thing to have their call method
1669 1674 be accessible as pure python functions (not just special syntax at
1670 1675 the command line). It gives us a better internal implementation
1671 1676 structure, as well as exposing these for user scripting more
1672 1677 cleanly.
1673 1678
1674 1679 * IPython/macro.py (Macro.__init__): moved macros to a standalone
1675 1680 file. Now that they'll be more likely to be used with the
1676 1681 persistance system (%store), I want to make sure their module path
1677 1682 doesn't change in the future, so that we don't break things for
1678 1683 users' persisted data.
1679 1684
1680 1685 * IPython/iplib.py (autoindent_update): move indentation
1681 1686 management into the _text_ processing loop, not the keyboard
1682 1687 interactive one. This is necessary to correctly process non-typed
1683 1688 multiline input (such as macros).
1684 1689
1685 1690 * IPython/Magic.py (Magic.format_latex): patch by Stefan van der
1686 1691 Walt <stefan-AT-sun.ac.za> to fix latex formatting of docstrings,
1687 1692 which was producing problems in the resulting manual.
1688 1693 (magic_whos): improve reporting of instances (show their class,
1689 1694 instead of simply printing 'instance' which isn't terribly
1690 1695 informative).
1691 1696
1692 1697 * IPython/genutils.py (shell): commit Jorgen Stenarson's patch
1693 1698 (minor mods) to support network shares under win32.
1694 1699
1695 1700 * IPython/winconsole.py (get_console_size): add new winconsole
1696 1701 module and fixes to page_dumb() to improve its behavior under
1697 1702 win32. Contributed by Alexander Belchenko <bialix-AT-ukr.net>.
1698 1703
1699 1704 * IPython/Magic.py (Macro): simplified Macro class to just
1700 1705 subclass list. We've had only 2.2 compatibility for a very long
1701 1706 time, yet I was still avoiding subclassing the builtin types. No
1702 1707 more (I'm also starting to use properties, though I won't shift to
1703 1708 2.3-specific features quite yet).
1704 1709 (magic_store): added Ville's patch for lightweight variable
1705 1710 persistence, after a request on the user list by Matt Wilkie
1706 1711 <maphew-AT-gmail.com>. The new %store magic's docstring has full
1707 1712 details.
1708 1713
1709 1714 * IPython/iplib.py (InteractiveShell.post_config_initialization):
1710 1715 changed the default logfile name from 'ipython.log' to
1711 1716 'ipython_log.py'. These logs are real python files, and now that
1712 1717 we have much better multiline support, people are more likely to
1713 1718 want to use them as such. Might as well name them correctly.
1714 1719
1715 1720 * IPython/Magic.py: substantial cleanup. While we can't stop
1716 1721 using magics as mixins, due to the existing customizations 'out
1717 1722 there' which rely on the mixin naming conventions, at least I
1718 1723 cleaned out all cross-class name usage. So once we are OK with
1719 1724 breaking compatibility, the two systems can be separated.
1720 1725
1721 1726 * IPython/Logger.py: major cleanup. This one is NOT a mixin
1722 1727 anymore, and the class is a fair bit less hideous as well. New
1723 1728 features were also introduced: timestamping of input, and logging
1724 1729 of output results. These are user-visible with the -t and -o
1725 1730 options to %logstart. Closes
1726 1731 http://www.scipy.net/roundup/ipython/issue11 and a request by
1727 1732 William Stein (SAGE developer - http://modular.ucsd.edu/sage).
1728 1733
1729 1734 2005-12-28 Fernando Perez <Fernando.Perez@colorado.edu>
1730 1735
1731 1736 * IPython/iplib.py (handle_shell_escape): add Ville's patch to
1732 1737 better handle backslashes in paths. See the thread 'More Windows
1733 1738 questions part 2 - \/ characters revisited' on the iypthon user
1734 1739 list:
1735 1740 http://scipy.net/pipermail/ipython-user/2005-June/000907.html
1736 1741
1737 1742 (InteractiveShell.__init__): fix tab-completion bug in threaded shells.
1738 1743
1739 1744 (InteractiveShell.__init__): change threaded shells to not use the
1740 1745 ipython crash handler. This was causing more problems than not,
1741 1746 as exceptions in the main thread (GUI code, typically) would
1742 1747 always show up as a 'crash', when they really weren't.
1743 1748
1744 1749 The colors and exception mode commands (%colors/%xmode) have been
1745 1750 synchronized to also take this into account, so users can get
1746 1751 verbose exceptions for their threaded code as well. I also added
1747 1752 support for activating pdb inside this exception handler as well,
1748 1753 so now GUI authors can use IPython's enhanced pdb at runtime.
1749 1754
1750 1755 * IPython/ipmaker.py (make_IPython): make the autoedit_syntax flag
1751 1756 true by default, and add it to the shipped ipythonrc file. Since
1752 1757 this asks the user before proceeding, I think it's OK to make it
1753 1758 true by default.
1754 1759
1755 1760 * IPython/Magic.py (magic_exit): make new exit/quit magics instead
1756 1761 of the previous special-casing of input in the eval loop. I think
1757 1762 this is cleaner, as they really are commands and shouldn't have
1758 1763 a special role in the middle of the core code.
1759 1764
1760 1765 2005-12-27 Fernando Perez <Fernando.Perez@colorado.edu>
1761 1766
1762 1767 * IPython/iplib.py (edit_syntax_error): added support for
1763 1768 automatically reopening the editor if the file had a syntax error
1764 1769 in it. Thanks to scottt who provided the patch at:
1765 1770 http://www.scipy.net/roundup/ipython/issue36 (slightly modified
1766 1771 version committed).
1767 1772
1768 1773 * IPython/iplib.py (handle_normal): add suport for multi-line
1769 1774 input with emtpy lines. This fixes
1770 1775 http://www.scipy.net/roundup/ipython/issue43 and a similar
1771 1776 discussion on the user list.
1772 1777
1773 1778 WARNING: a behavior change is necessarily introduced to support
1774 1779 blank lines: now a single blank line with whitespace does NOT
1775 1780 break the input loop, which means that when autoindent is on, by
1776 1781 default hitting return on the next (indented) line does NOT exit.
1777 1782
1778 1783 Instead, to exit a multiline input you can either have:
1779 1784
1780 1785 - TWO whitespace lines (just hit return again), or
1781 1786 - a single whitespace line of a different length than provided
1782 1787 by the autoindent (add or remove a space).
1783 1788
1784 1789 * IPython/completer.py (MagicCompleter.__init__): new 'completer'
1785 1790 module to better organize all readline-related functionality.
1786 1791 I've deleted FlexCompleter and put all completion clases here.
1787 1792
1788 1793 * IPython/iplib.py (raw_input): improve indentation management.
1789 1794 It is now possible to paste indented code with autoindent on, and
1790 1795 the code is interpreted correctly (though it still looks bad on
1791 1796 screen, due to the line-oriented nature of ipython).
1792 1797 (MagicCompleter.complete): change behavior so that a TAB key on an
1793 1798 otherwise empty line actually inserts a tab, instead of completing
1794 1799 on the entire global namespace. This makes it easier to use the
1795 1800 TAB key for indentation. After a request by Hans Meine
1796 1801 <hans_meine-AT-gmx.net>
1797 1802 (_prefilter): add support so that typing plain 'exit' or 'quit'
1798 1803 does a sensible thing. Originally I tried to deviate as little as
1799 1804 possible from the default python behavior, but even that one may
1800 1805 change in this direction (thread on python-dev to that effect).
1801 1806 Regardless, ipython should do the right thing even if CPython's
1802 1807 '>>>' prompt doesn't.
1803 1808 (InteractiveShell): removed subclassing code.InteractiveConsole
1804 1809 class. By now we'd overridden just about all of its methods: I've
1805 1810 copied the remaining two over, and now ipython is a standalone
1806 1811 class. This will provide a clearer picture for the chainsaw
1807 1812 branch refactoring.
1808 1813
1809 1814 2005-12-26 Fernando Perez <Fernando.Perez@colorado.edu>
1810 1815
1811 1816 * IPython/ultraTB.py (VerboseTB.text): harden reporting against
1812 1817 failures for objects which break when dir() is called on them.
1813 1818
1814 1819 * IPython/FlexCompleter.py (Completer.__init__): Added support for
1815 1820 distinct local and global namespaces in the completer API. This
1816 1821 change allows us to properly handle completion with distinct
1817 1822 scopes, including in embedded instances (this had never really
1818 1823 worked correctly).
1819 1824
1820 1825 Note: this introduces a change in the constructor for
1821 1826 MagicCompleter, as a new global_namespace parameter is now the
1822 1827 second argument (the others were bumped one position).
1823 1828
1824 1829 2005-12-25 Fernando Perez <Fernando.Perez@colorado.edu>
1825 1830
1826 1831 * IPython/iplib.py (embed_mainloop): fix tab-completion in
1827 1832 embedded instances (which can be done now thanks to Vivian's
1828 1833 frame-handling fixes for pdb).
1829 1834 (InteractiveShell.__init__): Fix namespace handling problem in
1830 1835 embedded instances. We were overwriting __main__ unconditionally,
1831 1836 and this should only be done for 'full' (non-embedded) IPython;
1832 1837 embedded instances must respect the caller's __main__. Thanks to
1833 1838 a bug report by Yaroslav Bulatov <yaroslavvb-AT-gmail.com>
1834 1839
1835 1840 2005-12-24 Fernando Perez <Fernando.Perez@colorado.edu>
1836 1841
1837 1842 * setup.py: added download_url to setup(). This registers the
1838 1843 download address at PyPI, which is not only useful to humans
1839 1844 browsing the site, but is also picked up by setuptools (the Eggs
1840 1845 machinery). Thanks to Ville and R. Kern for the info/discussion
1841 1846 on this.
1842 1847
1843 1848 2005-12-23 Fernando Perez <Fernando.Perez@colorado.edu>
1844 1849
1845 1850 * IPython/Debugger.py (Pdb.__init__): Major pdb mode enhancements.
1846 1851 This brings a lot of nice functionality to the pdb mode, which now
1847 1852 has tab-completion, syntax highlighting, and better stack handling
1848 1853 than before. Many thanks to Vivian De Smedt
1849 1854 <vivian-AT-vdesmedt.com> for the original patches.
1850 1855
1851 1856 2005-12-08 Fernando Perez <Fernando.Perez@colorado.edu>
1852 1857
1853 1858 * IPython/Shell.py (IPShellGTK.mainloop): fix mainloop() calling
1854 1859 sequence to consistently accept the banner argument. The
1855 1860 inconsistency was tripping SAGE, thanks to Gary Zablackis
1856 1861 <gzabl-AT-yahoo.com> for the report.
1857 1862
1858 1863 2005-11-15 Fernando Perez <Fernando.Perez@colorado.edu>
1859 1864
1860 1865 * IPython/iplib.py (InteractiveShell.post_config_initialization):
1861 1866 Fix bug where a naked 'alias' call in the ipythonrc file would
1862 1867 cause a crash. Bug reported by Jorgen Stenarson.
1863 1868
1864 1869 2005-11-15 Fernando Perez <Fernando.Perez@colorado.edu>
1865 1870
1866 1871 * IPython/ipmaker.py (make_IPython): cleanups which should improve
1867 1872 startup time.
1868 1873
1869 1874 * IPython/iplib.py (runcode): my globals 'fix' for embedded
1870 1875 instances had introduced a bug with globals in normal code. Now
1871 1876 it's working in all cases.
1872 1877
1873 1878 * IPython/Magic.py (magic_psearch): Finish wildcard cleanup and
1874 1879 API changes. A new ipytonrc option, 'wildcards_case_sensitive'
1875 1880 has been introduced to set the default case sensitivity of the
1876 1881 searches. Users can still select either mode at runtime on a
1877 1882 per-search basis.
1878 1883
1879 1884 2005-11-13 Fernando Perez <Fernando.Perez@colorado.edu>
1880 1885
1881 1886 * IPython/wildcard.py (NameSpace.__init__): fix resolution of
1882 1887 attributes in wildcard searches for subclasses. Modified version
1883 1888 of a patch by Jorgen.
1884 1889
1885 1890 2005-11-12 Fernando Perez <Fernando.Perez@colorado.edu>
1886 1891
1887 1892 * IPython/iplib.py (embed_mainloop): Fix handling of globals for
1888 1893 embedded instances. I added a user_global_ns attribute to the
1889 1894 InteractiveShell class to handle this.
1890 1895
1891 1896 2005-10-31 Fernando Perez <Fernando.Perez@colorado.edu>
1892 1897
1893 1898 * IPython/Shell.py (IPShellGTK.mainloop): Change timeout_add to
1894 1899 idle_add, which fixes horrible keyboard lag problems under gtk 2.6
1895 1900 (reported under win32, but may happen also in other platforms).
1896 1901 Bug report and fix courtesy of Sean Moore <smm-AT-logic.bm>
1897 1902
1898 1903 2005-10-15 Fernando Perez <Fernando.Perez@colorado.edu>
1899 1904
1900 1905 * IPython/Magic.py (magic_psearch): new support for wildcard
1901 1906 patterns. Now, typing ?a*b will list all names which begin with a
1902 1907 and end in b, for example. The %psearch magic has full
1903 1908 docstrings. Many thanks to JΓΆrgen Stenarson
1904 1909 <jorgen.stenarson-AT-bostream.nu>, author of the patches
1905 1910 implementing this functionality.
1906 1911
1907 1912 2005-09-27 Fernando Perez <Fernando.Perez@colorado.edu>
1908 1913
1909 1914 * Manual: fixed long-standing annoyance of double-dashes (as in
1910 1915 --prefix=~, for example) being stripped in the HTML version. This
1911 1916 is a latex2html bug, but a workaround was provided. Many thanks
1912 1917 to George K. Thiruvathukal <gthiruv-AT-luc.edu> for the detailed
1913 1918 help, and Michael Tobis <mtobis-AT-gmail.com> for getting the ball
1914 1919 rolling. This seemingly small issue had tripped a number of users
1915 1920 when first installing, so I'm glad to see it gone.
1916 1921
1917 1922 2005-09-27 Fernando Perez <Fernando.Perez@colorado.edu>
1918 1923
1919 1924 * IPython/Extensions/numeric_formats.py: fix missing import,
1920 1925 reported by Stephen Walton.
1921 1926
1922 1927 2005-09-24 Fernando Perez <Fernando.Perez@colorado.edu>
1923 1928
1924 1929 * IPython/demo.py: finish demo module, fully documented now.
1925 1930
1926 1931 * IPython/genutils.py (file_read): simple little utility to read a
1927 1932 file and ensure it's closed afterwards.
1928 1933
1929 1934 2005-09-23 Fernando Perez <Fernando.Perez@colorado.edu>
1930 1935
1931 1936 * IPython/demo.py (Demo.__init__): added support for individually
1932 1937 tagging blocks for automatic execution.
1933 1938
1934 1939 * IPython/Magic.py (magic_pycat): new %pycat magic for showing
1935 1940 syntax-highlighted python sources, requested by John.
1936 1941
1937 1942 2005-09-22 Fernando Perez <Fernando.Perez@colorado.edu>
1938 1943
1939 1944 * IPython/demo.py (Demo.again): fix bug where again() blocks after
1940 1945 finishing.
1941 1946
1942 1947 * IPython/genutils.py (shlex_split): moved from Magic to here,
1943 1948 where all 2.2 compatibility stuff lives. I needed it for demo.py.
1944 1949
1945 1950 * IPython/demo.py (Demo.__init__): added support for silent
1946 1951 blocks, improved marks as regexps, docstrings written.
1947 1952 (Demo.__init__): better docstring, added support for sys.argv.
1948 1953
1949 1954 * IPython/genutils.py (marquee): little utility used by the demo
1950 1955 code, handy in general.
1951 1956
1952 1957 * IPython/demo.py (Demo.__init__): new class for interactive
1953 1958 demos. Not documented yet, I just wrote it in a hurry for
1954 1959 scipy'05. Will docstring later.
1955 1960
1956 1961 2005-09-20 Fernando Perez <Fernando.Perez@colorado.edu>
1957 1962
1958 1963 * IPython/Shell.py (sigint_handler): Drastic simplification which
1959 1964 also seems to make Ctrl-C work correctly across threads! This is
1960 1965 so simple, that I can't beleive I'd missed it before. Needs more
1961 1966 testing, though.
1962 1967 (KBINT): Never mind, revert changes. I'm sure I'd tried something
1963 1968 like this before...
1964 1969
1965 1970 * IPython/genutils.py (get_home_dir): add protection against
1966 1971 non-dirs in win32 registry.
1967 1972
1968 1973 * IPython/iplib.py (InteractiveShell.alias_table_validate): fix
1969 1974 bug where dict was mutated while iterating (pysh crash).
1970 1975
1971 1976 2005-09-06 Fernando Perez <Fernando.Perez@colorado.edu>
1972 1977
1973 1978 * IPython/iplib.py (handle_auto): Fix inconsistency arising from
1974 1979 spurious newlines added by this routine. After a report by
1975 1980 F. Mantegazza.
1976 1981
1977 1982 2005-09-05 Fernando Perez <Fernando.Perez@colorado.edu>
1978 1983
1979 1984 * IPython/Shell.py (hijack_gtk): remove pygtk.require("2.0")
1980 1985 calls. These were a leftover from the GTK 1.x days, and can cause
1981 1986 problems in certain cases (after a report by John Hunter).
1982 1987
1983 1988 * IPython/iplib.py (InteractiveShell.__init__): Trap exception if
1984 1989 os.getcwd() fails at init time. Thanks to patch from David Remahl
1985 1990 <chmod007-AT-mac.com>.
1986 1991 (InteractiveShell.__init__): prevent certain special magics from
1987 1992 being shadowed by aliases. Closes
1988 1993 http://www.scipy.net/roundup/ipython/issue41.
1989 1994
1990 1995 2005-08-31 Fernando Perez <Fernando.Perez@colorado.edu>
1991 1996
1992 1997 * IPython/iplib.py (InteractiveShell.complete): Added new
1993 1998 top-level completion method to expose the completion mechanism
1994 1999 beyond readline-based environments.
1995 2000
1996 2001 2005-08-19 Fernando Perez <Fernando.Perez@colorado.edu>
1997 2002
1998 2003 * tools/ipsvnc (svnversion): fix svnversion capture.
1999 2004
2000 2005 * IPython/iplib.py (InteractiveShell.__init__): Add has_readline
2001 2006 attribute to self, which was missing. Before, it was set by a
2002 2007 routine which in certain cases wasn't being called, so the
2003 2008 instance could end up missing the attribute. This caused a crash.
2004 2009 Closes http://www.scipy.net/roundup/ipython/issue40.
2005 2010
2006 2011 2005-08-16 Fernando Perez <fperez@colorado.edu>
2007 2012
2008 2013 * IPython/ultraTB.py (VerboseTB.text): don't crash if object
2009 2014 contains non-string attribute. Closes
2010 2015 http://www.scipy.net/roundup/ipython/issue38.
2011 2016
2012 2017 2005-08-14 Fernando Perez <fperez@colorado.edu>
2013 2018
2014 2019 * tools/ipsvnc: Minor improvements, to add changeset info.
2015 2020
2016 2021 2005-08-12 Fernando Perez <fperez@colorado.edu>
2017 2022
2018 2023 * IPython/iplib.py (runsource): remove self.code_to_run_src
2019 2024 attribute. I realized this is nothing more than
2020 2025 '\n'.join(self.buffer), and having the same data in two different
2021 2026 places is just asking for synchronization bugs. This may impact
2022 2027 people who have custom exception handlers, so I need to warn
2023 2028 ipython-dev about it (F. Mantegazza may use them).
2024 2029
2025 2030 2005-07-29 Fernando Perez <Fernando.Perez@colorado.edu>
2026 2031
2027 2032 * IPython/genutils.py: fix 2.2 compatibility (generators)
2028 2033
2029 2034 2005-07-18 Fernando Perez <fperez@colorado.edu>
2030 2035
2031 2036 * IPython/genutils.py (get_home_dir): fix to help users with
2032 2037 invalid $HOME under win32.
2033 2038
2034 2039 2005-07-17 Fernando Perez <fperez@colorado.edu>
2035 2040
2036 2041 * IPython/Prompts.py (str_safe): Make unicode-safe. Also remove
2037 2042 some old hacks and clean up a bit other routines; code should be
2038 2043 simpler and a bit faster.
2039 2044
2040 2045 * IPython/iplib.py (interact): removed some last-resort attempts
2041 2046 to survive broken stdout/stderr. That code was only making it
2042 2047 harder to abstract out the i/o (necessary for gui integration),
2043 2048 and the crashes it could prevent were extremely rare in practice
2044 2049 (besides being fully user-induced in a pretty violent manner).
2045 2050
2046 2051 * IPython/genutils.py (IOStream.__init__): Simplify the i/o stuff.
2047 2052 Nothing major yet, but the code is simpler to read; this should
2048 2053 make it easier to do more serious modifications in the future.
2049 2054
2050 2055 * IPython/Extensions/InterpreterExec.py: Fix auto-quoting in pysh,
2051 2056 which broke in .15 (thanks to a report by Ville).
2052 2057
2053 2058 * IPython/Itpl.py (Itpl.__init__): add unicode support (it may not
2054 2059 be quite correct, I know next to nothing about unicode). This
2055 2060 will allow unicode strings to be used in prompts, amongst other
2056 2061 cases. It also will prevent ipython from crashing when unicode
2057 2062 shows up unexpectedly in many places. If ascii encoding fails, we
2058 2063 assume utf_8. Currently the encoding is not a user-visible
2059 2064 setting, though it could be made so if there is demand for it.
2060 2065
2061 2066 * IPython/ipmaker.py (make_IPython): remove old 2.1-specific hack.
2062 2067
2063 2068 * IPython/Struct.py (Struct.merge): switch keys() to iterator.
2064 2069
2065 2070 * IPython/background_jobs.py: moved 2.2 compatibility to genutils.
2066 2071
2067 2072 * IPython/genutils.py: Add 2.2 compatibility here, so all other
2068 2073 code can work transparently for 2.2/2.3.
2069 2074
2070 2075 2005-07-16 Fernando Perez <fperez@colorado.edu>
2071 2076
2072 2077 * IPython/ultraTB.py (ExceptionColors): Make a global variable
2073 2078 out of the color scheme table used for coloring exception
2074 2079 tracebacks. This allows user code to add new schemes at runtime.
2075 2080 This is a minimally modified version of the patch at
2076 2081 http://www.scipy.net/roundup/ipython/issue35, many thanks to pabw
2077 2082 for the contribution.
2078 2083
2079 2084 * IPython/FlexCompleter.py (Completer.attr_matches): Add a
2080 2085 slightly modified version of the patch in
2081 2086 http://www.scipy.net/roundup/ipython/issue34, which also allows me
2082 2087 to remove the previous try/except solution (which was costlier).
2083 2088 Thanks to Gaetan Lehmann <gaetan.lehmann-AT-jouy.inra.fr> for the fix.
2084 2089
2085 2090 2005-06-08 Fernando Perez <fperez@colorado.edu>
2086 2091
2087 2092 * IPython/iplib.py (write/write_err): Add methods to abstract all
2088 2093 I/O a bit more.
2089 2094
2090 2095 * IPython/Shell.py (IPShellGTK.mainloop): Fix GTK deprecation
2091 2096 warning, reported by Aric Hagberg, fix by JD Hunter.
2092 2097
2093 2098 2005-06-02 *** Released version 0.6.15
2094 2099
2095 2100 2005-06-01 Fernando Perez <fperez@colorado.edu>
2096 2101
2097 2102 * IPython/iplib.py (MagicCompleter.file_matches): Fix
2098 2103 tab-completion of filenames within open-quoted strings. Note that
2099 2104 this requires that in ~/.ipython/ipythonrc, users change the
2100 2105 readline delimiters configuration to read:
2101 2106
2102 2107 readline_remove_delims -/~
2103 2108
2104 2109
2105 2110 2005-05-31 *** Released version 0.6.14
2106 2111
2107 2112 2005-05-29 Fernando Perez <fperez@colorado.edu>
2108 2113
2109 2114 * IPython/ultraTB.py (VerboseTB.text): Fix crash for tracebacks
2110 2115 with files not on the filesystem. Reported by Eliyahu Sandler
2111 2116 <eli@gondolin.net>
2112 2117
2113 2118 2005-05-22 Fernando Perez <fperez@colorado.edu>
2114 2119
2115 2120 * IPython/iplib.py: Fix a few crashes in the --upgrade option.
2116 2121 After an initial report by LUK ShunTim <shuntim.luk@polyu.edu.hk>.
2117 2122
2118 2123 2005-05-19 Fernando Perez <fperez@colorado.edu>
2119 2124
2120 2125 * IPython/iplib.py (safe_execfile): close a file which could be
2121 2126 left open (causing problems in win32, which locks open files).
2122 2127 Thanks to a bug report by D Brown <dbrown2@yahoo.com>.
2123 2128
2124 2129 2005-05-18 Fernando Perez <fperez@colorado.edu>
2125 2130
2126 2131 * IPython/Shell.py (MatplotlibShellBase.mplot_exec): pass all
2127 2132 keyword arguments correctly to safe_execfile().
2128 2133
2129 2134 2005-05-13 Fernando Perez <fperez@colorado.edu>
2130 2135
2131 2136 * ipython.1: Added info about Qt to manpage, and threads warning
2132 2137 to usage page (invoked with --help).
2133 2138
2134 2139 * IPython/iplib.py (MagicCompleter.python_func_kw_matches): Added
2135 2140 new matcher (it goes at the end of the priority list) to do
2136 2141 tab-completion on named function arguments. Submitted by George
2137 2142 Sakkis <gsakkis-AT-eden.rutgers.edu>. See the thread at
2138 2143 http://www.scipy.net/pipermail/ipython-dev/2005-April/000436.html
2139 2144 for more details.
2140 2145
2141 2146 * IPython/Magic.py (magic_run): Added new -e flag to ignore
2142 2147 SystemExit exceptions in the script being run. Thanks to a report
2143 2148 by danny shevitz <danny_shevitz-AT-yahoo.com>, about this
2144 2149 producing very annoying behavior when running unit tests.
2145 2150
2146 2151 2005-05-12 Fernando Perez <fperez@colorado.edu>
2147 2152
2148 2153 * IPython/iplib.py (handle_auto): fixed auto-quoting and parens,
2149 2154 which I'd broken (again) due to a changed regexp. In the process,
2150 2155 added ';' as an escape to auto-quote the whole line without
2151 2156 splitting its arguments. Thanks to a report by Jerry McRae
2152 2157 <qrs0xyc02-AT-sneakemail.com>.
2153 2158
2154 2159 * IPython/ultraTB.py (VerboseTB.text): protect against rare but
2155 2160 possible crashes caused by a TokenError. Reported by Ed Schofield
2156 2161 <schofield-AT-ftw.at>.
2157 2162
2158 2163 2005-05-06 Fernando Perez <fperez@colorado.edu>
2159 2164
2160 2165 * IPython/Shell.py (hijack_wx): Fix to work with WX v.2.6.
2161 2166
2162 2167 2005-04-29 Fernando Perez <fperez@colorado.edu>
2163 2168
2164 2169 * IPython/Shell.py (IPShellQt): Thanks to Denis Rivière
2165 2170 <nudz-AT-free.fr>, Yann Cointepas <yann-AT-sapetnioc.org> and Benjamin
2166 2171 Thyreau <Benji2-AT-decideur.info>, we now have a -qthread option
2167 2172 which provides support for Qt interactive usage (similar to the
2168 2173 existing one for WX and GTK). This had been often requested.
2169 2174
2170 2175 2005-04-14 *** Released version 0.6.13
2171 2176
2172 2177 2005-04-08 Fernando Perez <fperez@colorado.edu>
2173 2178
2174 2179 * IPython/Magic.py (Magic._ofind): remove docstring evaluation
2175 2180 from _ofind, which gets called on almost every input line. Now,
2176 2181 we only try to get docstrings if they are actually going to be
2177 2182 used (the overhead of fetching unnecessary docstrings can be
2178 2183 noticeable for certain objects, such as Pyro proxies).
2179 2184
2180 2185 * IPython/iplib.py (MagicCompleter.python_matches): Change the API
2181 2186 for completers. For some reason I had been passing them the state
2182 2187 variable, which completers never actually need, and was in
2183 2188 conflict with the rlcompleter API. Custom completers ONLY need to
2184 2189 take the text parameter.
2185 2190
2186 2191 * IPython/Extensions/InterpreterExec.py: Fix regexp so that magics
2187 2192 work correctly in pysh. I've also moved all the logic which used
2188 2193 to be in pysh.py here, which will prevent problems with future
2189 2194 upgrades. However, this time I must warn users to update their
2190 2195 pysh profile to include the line
2191 2196
2192 2197 import_all IPython.Extensions.InterpreterExec
2193 2198
2194 2199 because otherwise things won't work for them. They MUST also
2195 2200 delete pysh.py and the line
2196 2201
2197 2202 execfile pysh.py
2198 2203
2199 2204 from their ipythonrc-pysh.
2200 2205
2201 2206 * IPython/FlexCompleter.py (Completer.attr_matches): Make more
2202 2207 robust in the face of objects whose dir() returns non-strings
2203 2208 (which it shouldn't, but some broken libs like ITK do). Thanks to
2204 2209 a patch by John Hunter (implemented differently, though). Also
2205 2210 minor improvements by using .extend instead of + on lists.
2206 2211
2207 2212 * pysh.py:
2208 2213
2209 2214 2005-04-06 Fernando Perez <fperez@colorado.edu>
2210 2215
2211 2216 * IPython/ipmaker.py (make_IPython): Make multi_line_specials on
2212 2217 by default, so that all users benefit from it. Those who don't
2213 2218 want it can still turn it off.
2214 2219
2215 2220 * IPython/UserConfig/ipythonrc: Add multi_line_specials to the
2216 2221 config file, I'd forgotten about this, so users were getting it
2217 2222 off by default.
2218 2223
2219 2224 * IPython/iplib.py (ipmagic): big overhaul of the magic system for
2220 2225 consistency. Now magics can be called in multiline statements,
2221 2226 and python variables can be expanded in magic calls via $var.
2222 2227 This makes the magic system behave just like aliases or !system
2223 2228 calls.
2224 2229
2225 2230 2005-03-28 Fernando Perez <fperez@colorado.edu>
2226 2231
2227 2232 * IPython/iplib.py (handle_auto): cleanup to use %s instead of
2228 2233 expensive string additions for building command. Add support for
2229 2234 trailing ';' when autocall is used.
2230 2235
2231 2236 2005-03-26 Fernando Perez <fperez@colorado.edu>
2232 2237
2233 2238 * ipython.el: Fix http://www.scipy.net/roundup/ipython/issue31.
2234 2239 Bugfix by A. Schmolck, the ipython.el maintainer. Also make
2235 2240 ipython.el robust against prompts with any number of spaces
2236 2241 (including 0) after the ':' character.
2237 2242
2238 2243 * IPython/Prompts.py (Prompt2.set_p_str): Fix spurious space in
2239 2244 continuation prompt, which misled users to think the line was
2240 2245 already indented. Closes debian Bug#300847, reported to me by
2241 2246 Norbert Tretkowski <tretkowski-AT-inittab.de>.
2242 2247
2243 2248 2005-03-23 Fernando Perez <fperez@colorado.edu>
2244 2249
2245 2250 * IPython/Prompts.py (Prompt1.__str__): Make sure that prompts are
2246 2251 properly aligned if they have embedded newlines.
2247 2252
2248 2253 * IPython/iplib.py (runlines): Add a public method to expose
2249 2254 IPython's code execution machinery, so that users can run strings
2250 2255 as if they had been typed at the prompt interactively.
2251 2256 (InteractiveShell.__init__): Added getoutput() to the __IPYTHON__
2252 2257 methods which can call the system shell, but with python variable
2253 2258 expansion. The three such methods are: __IPYTHON__.system,
2254 2259 .getoutput and .getoutputerror. These need to be documented in a
2255 2260 'public API' section (to be written) of the manual.
2256 2261
2257 2262 2005-03-20 Fernando Perez <fperez@colorado.edu>
2258 2263
2259 2264 * IPython/iplib.py (InteractiveShell.set_custom_exc): new system
2260 2265 for custom exception handling. This is quite powerful, and it
2261 2266 allows for user-installable exception handlers which can trap
2262 2267 custom exceptions at runtime and treat them separately from
2263 2268 IPython's default mechanisms. At the request of FrΓ©dΓ©ric
2264 2269 Mantegazza <mantegazza-AT-ill.fr>.
2265 2270 (InteractiveShell.set_custom_completer): public API function to
2266 2271 add new completers at runtime.
2267 2272
2268 2273 2005-03-19 Fernando Perez <fperez@colorado.edu>
2269 2274
2270 2275 * IPython/OInspect.py (getdoc): Add a call to obj.getdoc(), to
2271 2276 allow objects which provide their docstrings via non-standard
2272 2277 mechanisms (like Pyro proxies) to still be inspected by ipython's
2273 2278 ? system.
2274 2279
2275 2280 * IPython/iplib.py (InteractiveShell.__init__): back off the _o/_e
2276 2281 automatic capture system. I tried quite hard to make it work
2277 2282 reliably, and simply failed. I tried many combinations with the
2278 2283 subprocess module, but eventually nothing worked in all needed
2279 2284 cases (not blocking stdin for the child, duplicating stdout
2280 2285 without blocking, etc). The new %sc/%sx still do capture to these
2281 2286 magical list/string objects which make shell use much more
2282 2287 conveninent, so not all is lost.
2283 2288
2284 2289 XXX - FIX MANUAL for the change above!
2285 2290
2286 2291 (runsource): I copied code.py's runsource() into ipython to modify
2287 2292 it a bit. Now the code object and source to be executed are
2288 2293 stored in ipython. This makes this info accessible to third-party
2289 2294 tools, like custom exception handlers. After a request by FrΓ©dΓ©ric
2290 2295 Mantegazza <mantegazza-AT-ill.fr>.
2291 2296
2292 2297 * IPython/UserConfig/ipythonrc: Add up/down arrow keys to
2293 2298 history-search via readline (like C-p/C-n). I'd wanted this for a
2294 2299 long time, but only recently found out how to do it. For users
2295 2300 who already have their ipythonrc files made and want this, just
2296 2301 add:
2297 2302
2298 2303 readline_parse_and_bind "\e[A": history-search-backward
2299 2304 readline_parse_and_bind "\e[B": history-search-forward
2300 2305
2301 2306 2005-03-18 Fernando Perez <fperez@colorado.edu>
2302 2307
2303 2308 * IPython/Magic.py (magic_sc): %sc and %sx now use the fancy
2304 2309 LSString and SList classes which allow transparent conversions
2305 2310 between list mode and whitespace-separated string.
2306 2311 (magic_r): Fix recursion problem in %r.
2307 2312
2308 2313 * IPython/genutils.py (LSString): New class to be used for
2309 2314 automatic storage of the results of all alias/system calls in _o
2310 2315 and _e (stdout/err). These provide a .l/.list attribute which
2311 2316 does automatic splitting on newlines. This means that for most
2312 2317 uses, you'll never need to do capturing of output with %sc/%sx
2313 2318 anymore, since ipython keeps this always done for you. Note that
2314 2319 only the LAST results are stored, the _o/e variables are
2315 2320 overwritten on each call. If you need to save their contents
2316 2321 further, simply bind them to any other name.
2317 2322
2318 2323 2005-03-17 Fernando Perez <fperez@colorado.edu>
2319 2324
2320 2325 * IPython/Prompts.py (BasePrompt.cwd_filt): a few more fixes for
2321 2326 prompt namespace handling.
2322 2327
2323 2328 2005-03-16 Fernando Perez <fperez@colorado.edu>
2324 2329
2325 2330 * IPython/Prompts.py (CachedOutput.__init__): Fix default and
2326 2331 classic prompts to be '>>> ' (final space was missing, and it
2327 2332 trips the emacs python mode).
2328 2333 (BasePrompt.__str__): Added safe support for dynamic prompt
2329 2334 strings. Now you can set your prompt string to be '$x', and the
2330 2335 value of x will be printed from your interactive namespace. The
2331 2336 interpolation syntax includes the full Itpl support, so
2332 2337 ${foo()+x+bar()} is a valid prompt string now, and the function
2333 2338 calls will be made at runtime.
2334 2339
2335 2340 2005-03-15 Fernando Perez <fperez@colorado.edu>
2336 2341
2337 2342 * IPython/Magic.py (magic_history): renamed %hist to %history, to
2338 2343 avoid name clashes in pylab. %hist still works, it just forwards
2339 2344 the call to %history.
2340 2345
2341 2346 2005-03-02 *** Released version 0.6.12
2342 2347
2343 2348 2005-03-02 Fernando Perez <fperez@colorado.edu>
2344 2349
2345 2350 * IPython/iplib.py (handle_magic): log magic calls properly as
2346 2351 ipmagic() function calls.
2347 2352
2348 2353 * IPython/Magic.py (magic_time): Improved %time to support
2349 2354 statements and provide wall-clock as well as CPU time.
2350 2355
2351 2356 2005-02-27 Fernando Perez <fperez@colorado.edu>
2352 2357
2353 2358 * IPython/hooks.py: New hooks module, to expose user-modifiable
2354 2359 IPython functionality in a clean manner. For now only the editor
2355 2360 hook is actually written, and other thigns which I intend to turn
2356 2361 into proper hooks aren't yet there. The display and prefilter
2357 2362 stuff, for example, should be hooks. But at least now the
2358 2363 framework is in place, and the rest can be moved here with more
2359 2364 time later. IPython had had a .hooks variable for a long time for
2360 2365 this purpose, but I'd never actually used it for anything.
2361 2366
2362 2367 2005-02-26 Fernando Perez <fperez@colorado.edu>
2363 2368
2364 2369 * IPython/ipmaker.py (make_IPython): make the default ipython
2365 2370 directory be called _ipython under win32, to follow more the
2366 2371 naming peculiarities of that platform (where buggy software like
2367 2372 Visual Sourcesafe breaks with .named directories). Reported by
2368 2373 Ville Vainio.
2369 2374
2370 2375 2005-02-23 Fernando Perez <fperez@colorado.edu>
2371 2376
2372 2377 * IPython/iplib.py (InteractiveShell.__init__): removed a few
2373 2378 auto_aliases for win32 which were causing problems. Users can
2374 2379 define the ones they personally like.
2375 2380
2376 2381 2005-02-21 Fernando Perez <fperez@colorado.edu>
2377 2382
2378 2383 * IPython/Magic.py (magic_time): new magic to time execution of
2379 2384 expressions. After a request by Charles Moad <cmoad-AT-indiana.edu>.
2380 2385
2381 2386 2005-02-19 Fernando Perez <fperez@colorado.edu>
2382 2387
2383 2388 * IPython/ConfigLoader.py (ConfigLoader.load): Allow empty strings
2384 2389 into keys (for prompts, for example).
2385 2390
2386 2391 * IPython/Prompts.py (BasePrompt.set_p_str): Fix to allow empty
2387 2392 prompts in case users want them. This introduces a small behavior
2388 2393 change: ipython does not automatically add a space to all prompts
2389 2394 anymore. To get the old prompts with a space, users should add it
2390 2395 manually to their ipythonrc file, so for example prompt_in1 should
2391 2396 now read 'In [\#]: ' instead of 'In [\#]:'.
2392 2397 (BasePrompt.__init__): New option prompts_pad_left (only in rc
2393 2398 file) to control left-padding of secondary prompts.
2394 2399
2395 2400 * IPython/Magic.py (Magic.profile_missing_notice): Don't crash if
2396 2401 the profiler can't be imported. Fix for Debian, which removed
2397 2402 profile.py because of License issues. I applied a slightly
2398 2403 modified version of the original Debian patch at
2399 2404 http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=294500.
2400 2405
2401 2406 2005-02-17 Fernando Perez <fperez@colorado.edu>
2402 2407
2403 2408 * IPython/genutils.py (native_line_ends): Fix bug which would
2404 2409 cause improper line-ends under win32 b/c I was not opening files
2405 2410 in binary mode. Bug report and fix thanks to Ville.
2406 2411
2407 2412 * IPython/iplib.py (handle_auto): Fix bug which I introduced when
2408 2413 trying to catch spurious foo[1] autocalls. My fix actually broke
2409 2414 ',/' autoquote/call with explicit escape (bad regexp).
2410 2415
2411 2416 2005-02-15 *** Released version 0.6.11
2412 2417
2413 2418 2005-02-14 Fernando Perez <fperez@colorado.edu>
2414 2419
2415 2420 * IPython/background_jobs.py: New background job management
2416 2421 subsystem. This is implemented via a new set of classes, and
2417 2422 IPython now provides a builtin 'jobs' object for background job
2418 2423 execution. A convenience %bg magic serves as a lightweight
2419 2424 frontend for starting the more common type of calls. This was
2420 2425 inspired by discussions with B. Granger and the BackgroundCommand
2421 2426 class described in the book Python Scripting for Computational
2422 2427 Science, by H. P. Langtangen: http://folk.uio.no/hpl/scripting
2423 2428 (although ultimately no code from this text was used, as IPython's
2424 2429 system is a separate implementation).
2425 2430
2426 2431 * IPython/iplib.py (MagicCompleter.python_matches): add new option
2427 2432 to control the completion of single/double underscore names
2428 2433 separately. As documented in the example ipytonrc file, the
2429 2434 readline_omit__names variable can now be set to 2, to omit even
2430 2435 single underscore names. Thanks to a patch by Brian Wong
2431 2436 <BrianWong-AT-AirgoNetworks.Com>.
2432 2437 (InteractiveShell.__init__): Fix bug which would cause foo[1] to
2433 2438 be autocalled as foo([1]) if foo were callable. A problem for
2434 2439 things which are both callable and implement __getitem__.
2435 2440 (init_readline): Fix autoindentation for win32. Thanks to a patch
2436 2441 by Vivian De Smedt <vivian-AT-vdesmedt.com>.
2437 2442
2438 2443 2005-02-12 Fernando Perez <fperez@colorado.edu>
2439 2444
2440 2445 * IPython/ipmaker.py (make_IPython): Disabled the stout traps
2441 2446 which I had written long ago to sort out user error messages which
2442 2447 may occur during startup. This seemed like a good idea initially,
2443 2448 but it has proven a disaster in retrospect. I don't want to
2444 2449 change much code for now, so my fix is to set the internal 'debug'
2445 2450 flag to true everywhere, whose only job was precisely to control
2446 2451 this subsystem. This closes issue 28 (as well as avoiding all
2447 2452 sorts of strange hangups which occur from time to time).
2448 2453
2449 2454 2005-02-07 Fernando Perez <fperez@colorado.edu>
2450 2455
2451 2456 * IPython/Magic.py (magic_edit): Fix 'ed -p' not working when the
2452 2457 previous call produced a syntax error.
2453 2458
2454 2459 * IPython/OInspect.py (Inspector.pinfo): Fix crash when inspecting
2455 2460 classes without constructor.
2456 2461
2457 2462 2005-02-06 Fernando Perez <fperez@colorado.edu>
2458 2463
2459 2464 * IPython/iplib.py (MagicCompleter.complete): Extend the list of
2460 2465 completions with the results of each matcher, so we return results
2461 2466 to the user from all namespaces. This breaks with ipython
2462 2467 tradition, but I think it's a nicer behavior. Now you get all
2463 2468 possible completions listed, from all possible namespaces (python,
2464 2469 filesystem, magics...) After a request by John Hunter
2465 2470 <jdhunter-AT-nitace.bsd.uchicago.edu>.
2466 2471
2467 2472 2005-02-05 Fernando Perez <fperez@colorado.edu>
2468 2473
2469 2474 * IPython/Magic.py (magic_prun): Fix bug where prun would fail if
2470 2475 the call had quote characters in it (the quotes were stripped).
2471 2476
2472 2477 2005-01-31 Fernando Perez <fperez@colorado.edu>
2473 2478
2474 2479 * IPython/iplib.py (InteractiveShell.__init__): reduce reliance on
2475 2480 Itpl.itpl() to make the code more robust against psyco
2476 2481 optimizations.
2477 2482
2478 2483 * IPython/Itpl.py (Itpl.__str__): Use a _getframe() call instead
2479 2484 of causing an exception. Quicker, cleaner.
2480 2485
2481 2486 2005-01-28 Fernando Perez <fperez@colorado.edu>
2482 2487
2483 2488 * scripts/ipython_win_post_install.py (install): hardcode
2484 2489 sys.prefix+'python.exe' as the executable path. It turns out that
2485 2490 during the post-installation run, sys.executable resolves to the
2486 2491 name of the binary installer! I should report this as a distutils
2487 2492 bug, I think. I updated the .10 release with this tiny fix, to
2488 2493 avoid annoying the lists further.
2489 2494
2490 2495 2005-01-27 *** Released version 0.6.10
2491 2496
2492 2497 2005-01-27 Fernando Perez <fperez@colorado.edu>
2493 2498
2494 2499 * IPython/numutils.py (norm): Added 'inf' as optional name for
2495 2500 L-infinity norm, included references to mathworld.com for vector
2496 2501 norm definitions.
2497 2502 (amin/amax): added amin/amax for array min/max. Similar to what
2498 2503 pylab ships with after the recent reorganization of names.
2499 2504 (spike/spike_odd): removed deprecated spike/spike_odd functions.
2500 2505
2501 2506 * ipython.el: committed Alex's recent fixes and improvements.
2502 2507 Tested with python-mode from CVS, and it looks excellent. Since
2503 2508 python-mode hasn't released anything in a while, I'm temporarily
2504 2509 putting a copy of today's CVS (v 4.70) of python-mode in:
2505 2510 http://ipython.scipy.org/tmp/python-mode.el
2506 2511
2507 2512 * scripts/ipython_win_post_install.py (install): Win32 fix to use
2508 2513 sys.executable for the executable name, instead of assuming it's
2509 2514 called 'python.exe' (the post-installer would have produced broken
2510 2515 setups on systems with a differently named python binary).
2511 2516
2512 2517 * IPython/PyColorize.py (Parser.__call__): change explicit '\n'
2513 2518 references to os.linesep, to make the code more
2514 2519 platform-independent. This is also part of the win32 coloring
2515 2520 fixes.
2516 2521
2517 2522 * IPython/genutils.py (page_dumb): Remove attempts to chop long
2518 2523 lines, which actually cause coloring bugs because the length of
2519 2524 the line is very difficult to correctly compute with embedded
2520 2525 escapes. This was the source of all the coloring problems under
2521 2526 Win32. I think that _finally_, Win32 users have a properly
2522 2527 working ipython in all respects. This would never have happened
2523 2528 if not for Gary Bishop and Viktor Ransmayr's great help and work.
2524 2529
2525 2530 2005-01-26 *** Released version 0.6.9
2526 2531
2527 2532 2005-01-25 Fernando Perez <fperez@colorado.edu>
2528 2533
2529 2534 * setup.py: finally, we have a true Windows installer, thanks to
2530 2535 the excellent work of Viktor Ransmayr
2531 2536 <viktor.ransmayr-AT-t-online.de>. The docs have been updated for
2532 2537 Windows users. The setup routine is quite a bit cleaner thanks to
2533 2538 this, and the post-install script uses the proper functions to
2534 2539 allow a clean de-installation using the standard Windows Control
2535 2540 Panel.
2536 2541
2537 2542 * IPython/genutils.py (get_home_dir): changed to use the $HOME
2538 2543 environment variable under all OSes (including win32) if
2539 2544 available. This will give consistency to win32 users who have set
2540 2545 this variable for any reason. If os.environ['HOME'] fails, the
2541 2546 previous policy of using HOMEDRIVE\HOMEPATH kicks in.
2542 2547
2543 2548 2005-01-24 Fernando Perez <fperez@colorado.edu>
2544 2549
2545 2550 * IPython/numutils.py (empty_like): add empty_like(), similar to
2546 2551 zeros_like() but taking advantage of the new empty() Numeric routine.
2547 2552
2548 2553 2005-01-23 *** Released version 0.6.8
2549 2554
2550 2555 2005-01-22 Fernando Perez <fperez@colorado.edu>
2551 2556
2552 2557 * IPython/Shell.py (MatplotlibShellBase.mplot_exec): I removed the
2553 2558 automatic show() calls. After discussing things with JDH, it
2554 2559 turns out there are too many corner cases where this can go wrong.
2555 2560 It's best not to try to be 'too smart', and simply have ipython
2556 2561 reproduce as much as possible the default behavior of a normal
2557 2562 python shell.
2558 2563
2559 2564 * IPython/iplib.py (InteractiveShell.__init__): Modified the
2560 2565 line-splitting regexp and _prefilter() to avoid calling getattr()
2561 2566 on assignments. This closes
2562 2567 http://www.scipy.net/roundup/ipython/issue24. Note that Python's
2563 2568 readline uses getattr(), so a simple <TAB> keypress is still
2564 2569 enough to trigger getattr() calls on an object.
2565 2570
2566 2571 2005-01-21 Fernando Perez <fperez@colorado.edu>
2567 2572
2568 2573 * IPython/Shell.py (MatplotlibShellBase.magic_run): Fix the %run
2569 2574 docstring under pylab so it doesn't mask the original.
2570 2575
2571 2576 2005-01-21 *** Released version 0.6.7
2572 2577
2573 2578 2005-01-21 Fernando Perez <fperez@colorado.edu>
2574 2579
2575 2580 * IPython/Shell.py (MTInteractiveShell.runcode): Trap a crash with
2576 2581 signal handling for win32 users in multithreaded mode.
2577 2582
2578 2583 2005-01-17 Fernando Perez <fperez@colorado.edu>
2579 2584
2580 2585 * IPython/OInspect.py (Inspector.pinfo): Fix crash when inspecting
2581 2586 instances with no __init__. After a crash report by Norbert Nemec
2582 2587 <Norbert-AT-nemec-online.de>.
2583 2588
2584 2589 2005-01-14 Fernando Perez <fperez@colorado.edu>
2585 2590
2586 2591 * IPython/ultraTB.py (VerboseTB.text): Fix bug in reporting of
2587 2592 names for verbose exceptions, when multiple dotted names and the
2588 2593 'parent' object were present on the same line.
2589 2594
2590 2595 2005-01-11 Fernando Perez <fperez@colorado.edu>
2591 2596
2592 2597 * IPython/genutils.py (flag_calls): new utility to trap and flag
2593 2598 calls in functions. I need it to clean up matplotlib support.
2594 2599 Also removed some deprecated code in genutils.
2595 2600
2596 2601 * IPython/Shell.py (MatplotlibShellBase.mplot_exec): small fix so
2597 2602 that matplotlib scripts called with %run, which don't call show()
2598 2603 themselves, still have their plotting windows open.
2599 2604
2600 2605 2005-01-05 Fernando Perez <fperez@colorado.edu>
2601 2606
2602 2607 * IPython/Shell.py (IPShellGTK.__init__): Patch by Andrew Straw
2603 2608 <astraw-AT-caltech.edu>, to fix gtk deprecation warnings.
2604 2609
2605 2610 2004-12-19 Fernando Perez <fperez@colorado.edu>
2606 2611
2607 2612 * IPython/Shell.py (MTInteractiveShell.runcode): Get rid of
2608 2613 parent_runcode, which was an eyesore. The same result can be
2609 2614 obtained with Python's regular superclass mechanisms.
2610 2615
2611 2616 2004-12-17 Fernando Perez <fperez@colorado.edu>
2612 2617
2613 2618 * IPython/Magic.py (Magic.magic_sc): Fix quote stripping problem
2614 2619 reported by Prabhu.
2615 2620 (Magic.magic_sx): direct all errors to Term.cerr (defaults to
2616 2621 sys.stderr) instead of explicitly calling sys.stderr. This helps
2617 2622 maintain our I/O abstractions clean, for future GUI embeddings.
2618 2623
2619 2624 * IPython/genutils.py (info): added new utility for sys.stderr
2620 2625 unified info message handling (thin wrapper around warn()).
2621 2626
2622 2627 * IPython/ultraTB.py (VerboseTB.text): Fix misreported global
2623 2628 composite (dotted) names on verbose exceptions.
2624 2629 (VerboseTB.nullrepr): harden against another kind of errors which
2625 2630 Python's inspect module can trigger, and which were crashing
2626 2631 IPython. Thanks to a report by Marco Lombardi
2627 2632 <mlombard-AT-ma010192.hq.eso.org>.
2628 2633
2629 2634 2004-12-13 *** Released version 0.6.6
2630 2635
2631 2636 2004-12-12 Fernando Perez <fperez@colorado.edu>
2632 2637
2633 2638 * IPython/Shell.py (IPShellGTK.mainloop): catch RuntimeErrors
2634 2639 generated by pygtk upon initialization if it was built without
2635 2640 threads (for matplotlib users). After a crash reported by
2636 2641 Leguijt, Jaap J SIEP-EPT-RES <Jaap.Leguijt-AT-shell.com>.
2637 2642
2638 2643 * IPython/ipmaker.py (make_IPython): fix small bug in the
2639 2644 import_some parameter for multiple imports.
2640 2645
2641 2646 * IPython/iplib.py (ipmagic): simplified the interface of
2642 2647 ipmagic() to take a single string argument, just as it would be
2643 2648 typed at the IPython cmd line.
2644 2649 (ipalias): Added new ipalias() with an interface identical to
2645 2650 ipmagic(). This completes exposing a pure python interface to the
2646 2651 alias and magic system, which can be used in loops or more complex
2647 2652 code where IPython's automatic line mangling is not active.
2648 2653
2649 2654 * IPython/genutils.py (timing): changed interface of timing to
2650 2655 simply run code once, which is the most common case. timings()
2651 2656 remains unchanged, for the cases where you want multiple runs.
2652 2657
2653 2658 * IPython/Shell.py (MatplotlibShellBase._matplotlib_config): Fix a
2654 2659 bug where Python2.2 crashes with exec'ing code which does not end
2655 2660 in a single newline. Python 2.3 is OK, so I hadn't noticed this
2656 2661 before.
2657 2662
2658 2663 2004-12-10 Fernando Perez <fperez@colorado.edu>
2659 2664
2660 2665 * IPython/Magic.py (Magic.magic_prun): changed name of option from
2661 2666 -t to -T, to accomodate the new -t flag in %run (the %run and
2662 2667 %prun options are kind of intermixed, and it's not easy to change
2663 2668 this with the limitations of python's getopt).
2664 2669
2665 2670 * IPython/Magic.py (Magic.magic_run): Added new -t option to time
2666 2671 the execution of scripts. It's not as fine-tuned as timeit.py,
2667 2672 but it works from inside ipython (and under 2.2, which lacks
2668 2673 timeit.py). Optionally a number of runs > 1 can be given for
2669 2674 timing very short-running code.
2670 2675
2671 2676 * IPython/genutils.py (uniq_stable): new routine which returns a
2672 2677 list of unique elements in any iterable, but in stable order of
2673 2678 appearance. I needed this for the ultraTB fixes, and it's a handy
2674 2679 utility.
2675 2680
2676 2681 * IPython/ultraTB.py (VerboseTB.text): Fix proper reporting of
2677 2682 dotted names in Verbose exceptions. This had been broken since
2678 2683 the very start, now x.y will properly be printed in a Verbose
2679 2684 traceback, instead of x being shown and y appearing always as an
2680 2685 'undefined global'. Getting this to work was a bit tricky,
2681 2686 because by default python tokenizers are stateless. Saved by
2682 2687 python's ability to easily add a bit of state to an arbitrary
2683 2688 function (without needing to build a full-blown callable object).
2684 2689
2685 2690 Also big cleanup of this code, which had horrendous runtime
2686 2691 lookups of zillions of attributes for colorization. Moved all
2687 2692 this code into a few templates, which make it cleaner and quicker.
2688 2693
2689 2694 Printout quality was also improved for Verbose exceptions: one
2690 2695 variable per line, and memory addresses are printed (this can be
2691 2696 quite handy in nasty debugging situations, which is what Verbose
2692 2697 is for).
2693 2698
2694 2699 * IPython/ipmaker.py (make_IPython): Do NOT execute files named in
2695 2700 the command line as scripts to be loaded by embedded instances.
2696 2701 Doing so has the potential for an infinite recursion if there are
2697 2702 exceptions thrown in the process. This fixes a strange crash
2698 2703 reported by Philippe MULLER <muller-AT-irit.fr>.
2699 2704
2700 2705 2004-12-09 Fernando Perez <fperez@colorado.edu>
2701 2706
2702 2707 * IPython/Shell.py (MatplotlibShellBase.use): Change pylab support
2703 2708 to reflect new names in matplotlib, which now expose the
2704 2709 matlab-compatible interface via a pylab module instead of the
2705 2710 'matlab' name. The new code is backwards compatible, so users of
2706 2711 all matplotlib versions are OK. Patch by J. Hunter.
2707 2712
2708 2713 * IPython/OInspect.py (Inspector.pinfo): Add to object? printing
2709 2714 of __init__ docstrings for instances (class docstrings are already
2710 2715 automatically printed). Instances with customized docstrings
2711 2716 (indep. of the class) are also recognized and all 3 separate
2712 2717 docstrings are printed (instance, class, constructor). After some
2713 2718 comments/suggestions by J. Hunter.
2714 2719
2715 2720 2004-12-05 Fernando Perez <fperez@colorado.edu>
2716 2721
2717 2722 * IPython/iplib.py (MagicCompleter.complete): Remove annoying
2718 2723 warnings when tab-completion fails and triggers an exception.
2719 2724
2720 2725 2004-12-03 Fernando Perez <fperez@colorado.edu>
2721 2726
2722 2727 * IPython/Magic.py (magic_prun): Fix bug where an exception would
2723 2728 be triggered when using 'run -p'. An incorrect option flag was
2724 2729 being set ('d' instead of 'D').
2725 2730 (manpage): fix missing escaped \- sign.
2726 2731
2727 2732 2004-11-30 *** Released version 0.6.5
2728 2733
2729 2734 2004-11-30 Fernando Perez <fperez@colorado.edu>
2730 2735
2731 2736 * IPython/Magic.py (Magic.magic_run): Fix bug in breakpoint
2732 2737 setting with -d option.
2733 2738
2734 2739 * setup.py (docfiles): Fix problem where the doc glob I was using
2735 2740 was COMPLETELY BROKEN. It was giving the right files by pure
2736 2741 accident, but failed once I tried to include ipython.el. Note:
2737 2742 glob() does NOT allow you to do exclusion on multiple endings!
2738 2743
2739 2744 2004-11-29 Fernando Perez <fperez@colorado.edu>
2740 2745
2741 2746 * IPython/usage.py (__doc__): cleaned up usage docstring, by using
2742 2747 the manpage as the source. Better formatting & consistency.
2743 2748
2744 2749 * IPython/Magic.py (magic_run): Added new -d option, to run
2745 2750 scripts under the control of the python pdb debugger. Note that
2746 2751 this required changing the %prun option -d to -D, to avoid a clash
2747 2752 (since %run must pass options to %prun, and getopt is too dumb to
2748 2753 handle options with string values with embedded spaces). Thanks
2749 2754 to a suggestion by Matthew Arnison <maffew-AT-cat.org.au>.
2750 2755 (magic_who_ls): added type matching to %who and %whos, so that one
2751 2756 can filter their output to only include variables of certain
2752 2757 types. Another suggestion by Matthew.
2753 2758 (magic_whos): Added memory summaries in kb and Mb for arrays.
2754 2759 (magic_who): Improve formatting (break lines every 9 vars).
2755 2760
2756 2761 2004-11-28 Fernando Perez <fperez@colorado.edu>
2757 2762
2758 2763 * IPython/Logger.py (Logger.log): Fix bug in syncing the input
2759 2764 cache when empty lines were present.
2760 2765
2761 2766 2004-11-24 Fernando Perez <fperez@colorado.edu>
2762 2767
2763 2768 * IPython/usage.py (__doc__): document the re-activated threading
2764 2769 options for WX and GTK.
2765 2770
2766 2771 2004-11-23 Fernando Perez <fperez@colorado.edu>
2767 2772
2768 2773 * IPython/Shell.py (start): Added Prabhu's big patch to reactivate
2769 2774 the -wthread and -gthread options, along with a new -tk one to try
2770 2775 and coordinate Tk threading with wx/gtk. The tk support is very
2771 2776 platform dependent, since it seems to require Tcl and Tk to be
2772 2777 built with threads (Fedora1/2 appears NOT to have it, but in
2773 2778 Prabhu's Debian boxes it works OK). But even with some Tk
2774 2779 limitations, this is a great improvement.
2775 2780
2776 2781 * IPython/Prompts.py (prompt_specials_color): Added \t for time
2777 2782 info in user prompts. Patch by Prabhu.
2778 2783
2779 2784 2004-11-18 Fernando Perez <fperez@colorado.edu>
2780 2785
2781 2786 * IPython/genutils.py (ask_yes_no): Add check for a max of 20
2782 2787 EOFErrors and bail, to avoid infinite loops if a non-terminating
2783 2788 file is fed into ipython. Patch submitted in issue 19 by user,
2784 2789 many thanks.
2785 2790
2786 2791 * IPython/iplib.py (InteractiveShell.handle_auto): do NOT trigger
2787 2792 autoquote/parens in continuation prompts, which can cause lots of
2788 2793 problems. Closes roundup issue 20.
2789 2794
2790 2795 2004-11-17 Fernando Perez <fperez@colorado.edu>
2791 2796
2792 2797 * debian/control (Build-Depends-Indep): Fix dpatch dependency,
2793 2798 reported as debian bug #280505. I'm not sure my local changelog
2794 2799 entry has the proper debian format (Jack?).
2795 2800
2796 2801 2004-11-08 *** Released version 0.6.4
2797 2802
2798 2803 2004-11-08 Fernando Perez <fperez@colorado.edu>
2799 2804
2800 2805 * IPython/iplib.py (init_readline): Fix exit message for Windows
2801 2806 when readline is active. Thanks to a report by Eric Jones
2802 2807 <eric-AT-enthought.com>.
2803 2808
2804 2809 2004-11-07 Fernando Perez <fperez@colorado.edu>
2805 2810
2806 2811 * IPython/genutils.py (page): Add a trap for OSError exceptions,
2807 2812 sometimes seen by win2k/cygwin users.
2808 2813
2809 2814 2004-11-06 Fernando Perez <fperez@colorado.edu>
2810 2815
2811 2816 * IPython/iplib.py (interact): Change the handling of %Exit from
2812 2817 trying to propagate a SystemExit to an internal ipython flag.
2813 2818 This is less elegant than using Python's exception mechanism, but
2814 2819 I can't get that to work reliably with threads, so under -pylab
2815 2820 %Exit was hanging IPython. Cross-thread exception handling is
2816 2821 really a bitch. Thaks to a bug report by Stephen Walton
2817 2822 <stephen.walton-AT-csun.edu>.
2818 2823
2819 2824 2004-11-04 Fernando Perez <fperez@colorado.edu>
2820 2825
2821 2826 * IPython/iplib.py (raw_input_original): store a pointer to the
2822 2827 true raw_input to harden against code which can modify it
2823 2828 (wx.py.PyShell does this and would otherwise crash ipython).
2824 2829 Thanks to a bug report by Jim Flowers <james.flowers-AT-lgx.com>.
2825 2830
2826 2831 * IPython/Shell.py (MTInteractiveShell.runsource): Cleaner fix for
2827 2832 Ctrl-C problem, which does not mess up the input line.
2828 2833
2829 2834 2004-11-03 Fernando Perez <fperez@colorado.edu>
2830 2835
2831 2836 * IPython/Release.py: Changed licensing to BSD, in all files.
2832 2837 (name): lowercase name for tarball/RPM release.
2833 2838
2834 2839 * IPython/OInspect.py (getdoc): wrap inspect.getdoc() safely for
2835 2840 use throughout ipython.
2836 2841
2837 2842 * IPython/Magic.py (Magic._ofind): Switch to using the new
2838 2843 OInspect.getdoc() function.
2839 2844
2840 2845 * IPython/Shell.py (sigint_handler): Hack to ignore the execution
2841 2846 of the line currently being canceled via Ctrl-C. It's extremely
2842 2847 ugly, but I don't know how to do it better (the problem is one of
2843 2848 handling cross-thread exceptions).
2844 2849
2845 2850 2004-10-28 Fernando Perez <fperez@colorado.edu>
2846 2851
2847 2852 * IPython/Shell.py (signal_handler): add signal handlers to trap
2848 2853 SIGINT and SIGSEGV in threaded code properly. Thanks to a bug
2849 2854 report by Francesc Alted.
2850 2855
2851 2856 2004-10-21 Fernando Perez <fperez@colorado.edu>
2852 2857
2853 2858 * IPython/Extensions/InterpreterExec.py (prefilter_shell): Fix @
2854 2859 to % for pysh syntax extensions.
2855 2860
2856 2861 2004-10-09 Fernando Perez <fperez@colorado.edu>
2857 2862
2858 2863 * IPython/Magic.py (Magic.magic_whos): modify output of Numeric
2859 2864 arrays to print a more useful summary, without calling str(arr).
2860 2865 This avoids the problem of extremely lengthy computations which
2861 2866 occur if arr is large, and appear to the user as a system lockup
2862 2867 with 100% cpu activity. After a suggestion by Kristian Sandberg
2863 2868 <Kristian.Sandberg@colorado.edu>.
2864 2869 (Magic.__init__): fix bug in global magic escapes not being
2865 2870 correctly set.
2866 2871
2867 2872 2004-10-08 Fernando Perez <fperez@colorado.edu>
2868 2873
2869 2874 * IPython/Magic.py (__license__): change to absolute imports of
2870 2875 ipython's own internal packages, to start adapting to the absolute
2871 2876 import requirement of PEP-328.
2872 2877
2873 2878 * IPython/genutils.py (__author__): Fix coding to utf-8 on all
2874 2879 files, and standardize author/license marks through the Release
2875 2880 module instead of having per/file stuff (except for files with
2876 2881 particular licenses, like the MIT/PSF-licensed codes).
2877 2882
2878 2883 * IPython/Debugger.py: remove dead code for python 2.1
2879 2884
2880 2885 2004-10-04 Fernando Perez <fperez@colorado.edu>
2881 2886
2882 2887 * IPython/iplib.py (ipmagic): New function for accessing magics
2883 2888 via a normal python function call.
2884 2889
2885 2890 * IPython/Magic.py (Magic.magic_magic): Change the magic escape
2886 2891 from '@' to '%', to accomodate the new @decorator syntax of python
2887 2892 2.4.
2888 2893
2889 2894 2004-09-29 Fernando Perez <fperez@colorado.edu>
2890 2895
2891 2896 * IPython/Shell.py (MatplotlibShellBase.use): Added a wrapper to
2892 2897 matplotlib.use to prevent running scripts which try to switch
2893 2898 interactive backends from within ipython. This will just crash
2894 2899 the python interpreter, so we can't allow it (but a detailed error
2895 2900 is given to the user).
2896 2901
2897 2902 2004-09-28 Fernando Perez <fperez@colorado.edu>
2898 2903
2899 2904 * IPython/Shell.py (MatplotlibShellBase.mplot_exec):
2900 2905 matplotlib-related fixes so that using @run with non-matplotlib
2901 2906 scripts doesn't pop up spurious plot windows. This requires
2902 2907 matplotlib >= 0.63, where I had to make some changes as well.
2903 2908
2904 2909 * IPython/ipmaker.py (make_IPython): update version requirement to
2905 2910 python 2.2.
2906 2911
2907 2912 * IPython/iplib.py (InteractiveShell.mainloop): Add an optional
2908 2913 banner arg for embedded customization.
2909 2914
2910 2915 * IPython/Magic.py (Magic.__init__): big cleanup to remove all
2911 2916 explicit uses of __IP as the IPython's instance name. Now things
2912 2917 are properly handled via the shell.name value. The actual code
2913 2918 is a bit ugly b/c I'm doing it via a global in Magic.py, but this
2914 2919 is much better than before. I'll clean things completely when the
2915 2920 magic stuff gets a real overhaul.
2916 2921
2917 2922 * ipython.1: small fixes, sent in by Jack Moffit. He also sent in
2918 2923 minor changes to debian dir.
2919 2924
2920 2925 * IPython/iplib.py (InteractiveShell.__init__): Fix adding a
2921 2926 pointer to the shell itself in the interactive namespace even when
2922 2927 a user-supplied dict is provided. This is needed for embedding
2923 2928 purposes (found by tests with Michel Sanner).
2924 2929
2925 2930 2004-09-27 Fernando Perez <fperez@colorado.edu>
2926 2931
2927 2932 * IPython/UserConfig/ipythonrc: remove []{} from
2928 2933 readline_remove_delims, so that things like [modname.<TAB> do
2929 2934 proper completion. This disables [].TAB, but that's a less common
2930 2935 case than module names in list comprehensions, for example.
2931 2936 Thanks to a report by Andrea Riciputi.
2932 2937
2933 2938 2004-09-09 Fernando Perez <fperez@colorado.edu>
2934 2939
2935 2940 * IPython/Shell.py (IPShellGTK.mainloop): reorder to avoid
2936 2941 blocking problems in win32 and osx. Fix by John.
2937 2942
2938 2943 2004-09-08 Fernando Perez <fperez@colorado.edu>
2939 2944
2940 2945 * IPython/Shell.py (IPShellWX.OnInit): Fix output redirection bug
2941 2946 for Win32 and OSX. Fix by John Hunter.
2942 2947
2943 2948 2004-08-30 *** Released version 0.6.3
2944 2949
2945 2950 2004-08-30 Fernando Perez <fperez@colorado.edu>
2946 2951
2947 2952 * setup.py (isfile): Add manpages to list of dependent files to be
2948 2953 updated.
2949 2954
2950 2955 2004-08-27 Fernando Perez <fperez@colorado.edu>
2951 2956
2952 2957 * IPython/Shell.py (start): I've disabled -wthread and -gthread
2953 2958 for now. They don't really work with standalone WX/GTK code
2954 2959 (though matplotlib IS working fine with both of those backends).
2955 2960 This will neeed much more testing. I disabled most things with
2956 2961 comments, so turning it back on later should be pretty easy.
2957 2962
2958 2963 * IPython/iplib.py (InteractiveShell.__init__): Fix accidental
2959 2964 autocalling of expressions like r'foo', by modifying the line
2960 2965 split regexp. Closes
2961 2966 http://www.scipy.net/roundup/ipython/issue18, reported by Nicholas
2962 2967 Riley <ipythonbugs-AT-sabi.net>.
2963 2968 (InteractiveShell.mainloop): honor --nobanner with banner
2964 2969 extensions.
2965 2970
2966 2971 * IPython/Shell.py: Significant refactoring of all classes, so
2967 2972 that we can really support ALL matplotlib backends and threading
2968 2973 models (John spotted a bug with Tk which required this). Now we
2969 2974 should support single-threaded, WX-threads and GTK-threads, both
2970 2975 for generic code and for matplotlib.
2971 2976
2972 2977 * IPython/ipmaker.py (__call__): Changed -mpthread option to
2973 2978 -pylab, to simplify things for users. Will also remove the pylab
2974 2979 profile, since now all of matplotlib configuration is directly
2975 2980 handled here. This also reduces startup time.
2976 2981
2977 2982 * IPython/Shell.py (IPShellGTK.run): Fixed bug where mainloop() of
2978 2983 shell wasn't being correctly called. Also in IPShellWX.
2979 2984
2980 2985 * IPython/iplib.py (InteractiveShell.__init__): Added option to
2981 2986 fine-tune banner.
2982 2987
2983 2988 * IPython/numutils.py (spike): Deprecate these spike functions,
2984 2989 delete (long deprecated) gnuplot_exec handler.
2985 2990
2986 2991 2004-08-26 Fernando Perez <fperez@colorado.edu>
2987 2992
2988 2993 * ipython.1: Update for threading options, plus some others which
2989 2994 were missing.
2990 2995
2991 2996 * IPython/ipmaker.py (__call__): Added -wthread option for
2992 2997 wxpython thread handling. Make sure threading options are only
2993 2998 valid at the command line.
2994 2999
2995 3000 * scripts/ipython: moved shell selection into a factory function
2996 3001 in Shell.py, to keep the starter script to a minimum.
2997 3002
2998 3003 2004-08-25 Fernando Perez <fperez@colorado.edu>
2999 3004
3000 3005 * IPython/Shell.py (IPShellWX.wxexit): fixes to WX threading, by
3001 3006 John. Along with some recent changes he made to matplotlib, the
3002 3007 next versions of both systems should work very well together.
3003 3008
3004 3009 2004-08-24 Fernando Perez <fperez@colorado.edu>
3005 3010
3006 3011 * IPython/Magic.py (Magic.magic_prun): cleanup some dead code. I
3007 3012 tried to switch the profiling to using hotshot, but I'm getting
3008 3013 strange errors from prof.runctx() there. I may be misreading the
3009 3014 docs, but it looks weird. For now the profiling code will
3010 3015 continue to use the standard profiler.
3011 3016
3012 3017 2004-08-23 Fernando Perez <fperez@colorado.edu>
3013 3018
3014 3019 * IPython/Shell.py (IPShellWX.__init__): Improvements to the WX
3015 3020 threaded shell, by John Hunter. It's not quite ready yet, but
3016 3021 close.
3017 3022
3018 3023 2004-08-22 Fernando Perez <fperez@colorado.edu>
3019 3024
3020 3025 * IPython/iplib.py (InteractiveShell.interact): tab cleanups, also
3021 3026 in Magic and ultraTB.
3022 3027
3023 3028 * ipython.1: document threading options in manpage.
3024 3029
3025 3030 * scripts/ipython: Changed name of -thread option to -gthread,
3026 3031 since this is GTK specific. I want to leave the door open for a
3027 3032 -wthread option for WX, which will most likely be necessary. This
3028 3033 change affects usage and ipmaker as well.
3029 3034
3030 3035 * IPython/Shell.py (matplotlib_shell): Add a factory function to
3031 3036 handle the matplotlib shell issues. Code by John Hunter
3032 3037 <jdhunter-AT-nitace.bsd.uchicago.edu>.
3033 3038 (IPShellMatplotlibWX.__init__): Rudimentary WX support. It's
3034 3039 broken (and disabled for end users) for now, but it puts the
3035 3040 infrastructure in place.
3036 3041
3037 3042 2004-08-21 Fernando Perez <fperez@colorado.edu>
3038 3043
3039 3044 * ipythonrc-pylab: Add matplotlib support.
3040 3045
3041 3046 * matplotlib_config.py: new files for matplotlib support, part of
3042 3047 the pylab profile.
3043 3048
3044 3049 * IPython/usage.py (__doc__): documented the threading options.
3045 3050
3046 3051 2004-08-20 Fernando Perez <fperez@colorado.edu>
3047 3052
3048 3053 * ipython: Modified the main calling routine to handle the -thread
3049 3054 and -mpthread options. This needs to be done as a top-level hack,
3050 3055 because it determines which class to instantiate for IPython
3051 3056 itself.
3052 3057
3053 3058 * IPython/Shell.py (MTInteractiveShell.__init__): New set of
3054 3059 classes to support multithreaded GTK operation without blocking,
3055 3060 and matplotlib with all backends. This is a lot of still very
3056 3061 experimental code, and threads are tricky. So it may still have a
3057 3062 few rough edges... This code owes a lot to
3058 3063 http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/65109, by
3059 3064 Brian # McErlean and John Finlay, to Antoon Pardon for fixes, and
3060 3065 to John Hunter for all the matplotlib work.
3061 3066
3062 3067 * IPython/ipmaker.py (__call__): Added -thread and -mpthread
3063 3068 options for gtk thread and matplotlib support.
3064 3069
3065 3070 2004-08-16 Fernando Perez <fperez@colorado.edu>
3066 3071
3067 3072 * IPython/iplib.py (InteractiveShell.__init__): don't trigger
3068 3073 autocall for things like p*q,p/q,p+q,p-q, when p is callable. Bug
3069 3074 reported by Stephen Walton <stephen.walton-AT-csun.edu>.
3070 3075
3071 3076 2004-08-11 Fernando Perez <fperez@colorado.edu>
3072 3077
3073 3078 * setup.py (isfile): Fix build so documentation gets updated for
3074 3079 rpms (it was only done for .tgz builds).
3075 3080
3076 3081 2004-08-10 Fernando Perez <fperez@colorado.edu>
3077 3082
3078 3083 * genutils.py (Term): Fix misspell of stdin stream (sin->cin).
3079 3084
3080 3085 * iplib.py : Silence syntax error exceptions in tab-completion.
3081 3086
3082 3087 2004-08-05 Fernando Perez <fperez@colorado.edu>
3083 3088
3084 3089 * IPython/Prompts.py (Prompt2.set_colors): Fix incorrectly set
3085 3090 'color off' mark for continuation prompts. This was causing long
3086 3091 continuation lines to mis-wrap.
3087 3092
3088 3093 2004-08-01 Fernando Perez <fperez@colorado.edu>
3089 3094
3090 3095 * IPython/ipmaker.py (make_IPython): Allow the shell class used
3091 3096 for building ipython to be a parameter. All this is necessary
3092 3097 right now to have a multithreaded version, but this insane
3093 3098 non-design will be cleaned up soon. For now, it's a hack that
3094 3099 works.
3095 3100
3096 3101 * IPython/Shell.py (IPShell.__init__): Stop using mutable default
3097 3102 args in various places. No bugs so far, but it's a dangerous
3098 3103 practice.
3099 3104
3100 3105 2004-07-31 Fernando Perez <fperez@colorado.edu>
3101 3106
3102 3107 * IPython/iplib.py (complete): ignore SyntaxError exceptions to
3103 3108 fix completion of files with dots in their names under most
3104 3109 profiles (pysh was OK because the completion order is different).
3105 3110
3106 3111 2004-07-27 Fernando Perez <fperez@colorado.edu>
3107 3112
3108 3113 * IPython/iplib.py (InteractiveShell.__init__): build dict of
3109 3114 keywords manually, b/c the one in keyword.py was removed in python
3110 3115 2.4. Patch by Anakim Border <aborder-AT-users.sourceforge.net>.
3111 3116 This is NOT a bug under python 2.3 and earlier.
3112 3117
3113 3118 2004-07-26 Fernando Perez <fperez@colorado.edu>
3114 3119
3115 3120 * IPython/ultraTB.py (VerboseTB.text): Add another
3116 3121 linecache.checkcache() call to try to prevent inspect.py from
3117 3122 crashing under python 2.3. I think this fixes
3118 3123 http://www.scipy.net/roundup/ipython/issue17.
3119 3124
3120 3125 2004-07-26 *** Released version 0.6.2
3121 3126
3122 3127 2004-07-26 Fernando Perez <fperez@colorado.edu>
3123 3128
3124 3129 * IPython/Magic.py (Magic.magic_cd): Fix bug where 'cd -N' would
3125 3130 fail for any number.
3126 3131 (Magic.magic_bookmark): Fix bug where 'bookmark -l' would fail for
3127 3132 empty bookmarks.
3128 3133
3129 3134 2004-07-26 *** Released version 0.6.1
3130 3135
3131 3136 2004-07-26 Fernando Perez <fperez@colorado.edu>
3132 3137
3133 3138 * ipython_win_post_install.py (run): Added pysh shortcut for Windows.
3134 3139
3135 3140 * IPython/iplib.py (protect_filename): Applied Ville's patch for
3136 3141 escaping '()[]{}' in filenames.
3137 3142
3138 3143 * IPython/Magic.py (shlex_split): Fix handling of '*' and '?' for
3139 3144 Python 2.2 users who lack a proper shlex.split.
3140 3145
3141 3146 2004-07-19 Fernando Perez <fperez@colorado.edu>
3142 3147
3143 3148 * IPython/iplib.py (InteractiveShell.init_readline): Add support
3144 3149 for reading readline's init file. I follow the normal chain:
3145 3150 $INPUTRC is honored, otherwise ~/.inputrc is used. Thanks to a
3146 3151 report by Mike Heeter. This closes
3147 3152 http://www.scipy.net/roundup/ipython/issue16.
3148 3153
3149 3154 2004-07-18 Fernando Perez <fperez@colorado.edu>
3150 3155
3151 3156 * IPython/iplib.py (__init__): Add better handling of '\' under
3152 3157 Win32 for filenames. After a patch by Ville.
3153 3158
3154 3159 2004-07-17 Fernando Perez <fperez@colorado.edu>
3155 3160
3156 3161 * IPython/iplib.py (InteractiveShell._prefilter): fix bug where
3157 3162 autocalling would be triggered for 'foo is bar' if foo is
3158 3163 callable. I also cleaned up the autocall detection code to use a
3159 3164 regexp, which is faster. Bug reported by Alexander Schmolck.
3160 3165
3161 3166 * IPython/Magic.py (Magic.magic_pinfo): Fix bug where strings with
3162 3167 '?' in them would confuse the help system. Reported by Alex
3163 3168 Schmolck.
3164 3169
3165 3170 2004-07-16 Fernando Perez <fperez@colorado.edu>
3166 3171
3167 3172 * IPython/GnuplotInteractive.py (__all__): added plot2.
3168 3173
3169 3174 * IPython/Gnuplot2.py (Gnuplot.plot2): added new function for
3170 3175 plotting dictionaries, lists or tuples of 1d arrays.
3171 3176
3172 3177 * IPython/Magic.py (Magic.magic_hist): small clenaups and
3173 3178 optimizations.
3174 3179
3175 3180 * IPython/iplib.py:Remove old Changelog info for cleanup. This is
3176 3181 the information which was there from Janko's original IPP code:
3177 3182
3178 3183 03.05.99 20:53 porto.ifm.uni-kiel.de
3179 3184 --Started changelog.
3180 3185 --make clear do what it say it does
3181 3186 --added pretty output of lines from inputcache
3182 3187 --Made Logger a mixin class, simplifies handling of switches
3183 3188 --Added own completer class. .string<TAB> expands to last history
3184 3189 line which starts with string. The new expansion is also present
3185 3190 with Ctrl-r from the readline library. But this shows, who this
3186 3191 can be done for other cases.
3187 3192 --Added convention that all shell functions should accept a
3188 3193 parameter_string This opens the door for different behaviour for
3189 3194 each function. @cd is a good example of this.
3190 3195
3191 3196 04.05.99 12:12 porto.ifm.uni-kiel.de
3192 3197 --added logfile rotation
3193 3198 --added new mainloop method which freezes first the namespace
3194 3199
3195 3200 07.05.99 21:24 porto.ifm.uni-kiel.de
3196 3201 --added the docreader classes. Now there is a help system.
3197 3202 -This is only a first try. Currently it's not easy to put new
3198 3203 stuff in the indices. But this is the way to go. Info would be
3199 3204 better, but HTML is every where and not everybody has an info
3200 3205 system installed and it's not so easy to change html-docs to info.
3201 3206 --added global logfile option
3202 3207 --there is now a hook for object inspection method pinfo needs to
3203 3208 be provided for this. Can be reached by two '??'.
3204 3209
3205 3210 08.05.99 20:51 porto.ifm.uni-kiel.de
3206 3211 --added a README
3207 3212 --bug in rc file. Something has changed so functions in the rc
3208 3213 file need to reference the shell and not self. Not clear if it's a
3209 3214 bug or feature.
3210 3215 --changed rc file for new behavior
3211 3216
3212 3217 2004-07-15 Fernando Perez <fperez@colorado.edu>
3213 3218
3214 3219 * IPython/Logger.py (Logger.log): fixed recent bug where the input
3215 3220 cache was falling out of sync in bizarre manners when multi-line
3216 3221 input was present. Minor optimizations and cleanup.
3217 3222
3218 3223 (Logger): Remove old Changelog info for cleanup. This is the
3219 3224 information which was there from Janko's original code:
3220 3225
3221 3226 Changes to Logger: - made the default log filename a parameter
3222 3227
3223 3228 - put a check for lines beginning with !@? in log(). Needed
3224 3229 (even if the handlers properly log their lines) for mid-session
3225 3230 logging activation to work properly. Without this, lines logged
3226 3231 in mid session, which get read from the cache, would end up
3227 3232 'bare' (with !@? in the open) in the log. Now they are caught
3228 3233 and prepended with a #.
3229 3234
3230 3235 * IPython/iplib.py (InteractiveShell.init_readline): added check
3231 3236 in case MagicCompleter fails to be defined, so we don't crash.
3232 3237
3233 3238 2004-07-13 Fernando Perez <fperez@colorado.edu>
3234 3239
3235 3240 * IPython/Gnuplot2.py (Gnuplot.hardcopy): add automatic generation
3236 3241 of EPS if the requested filename ends in '.eps'.
3237 3242
3238 3243 2004-07-04 Fernando Perez <fperez@colorado.edu>
3239 3244
3240 3245 * IPython/iplib.py (InteractiveShell.handle_shell_escape): Fix
3241 3246 escaping of quotes when calling the shell.
3242 3247
3243 3248 2004-07-02 Fernando Perez <fperez@colorado.edu>
3244 3249
3245 3250 * IPython/Prompts.py (CachedOutput.update): Fix problem with
3246 3251 gettext not working because we were clobbering '_'. Fixes
3247 3252 http://www.scipy.net/roundup/ipython/issue6.
3248 3253
3249 3254 2004-07-01 Fernando Perez <fperez@colorado.edu>
3250 3255
3251 3256 * IPython/Magic.py (Magic.magic_cd): integrated bookmark handling
3252 3257 into @cd. Patch by Ville.
3253 3258
3254 3259 * IPython/iplib.py (InteractiveShell.post_config_initialization):
3255 3260 new function to store things after ipmaker runs. Patch by Ville.
3256 3261 Eventually this will go away once ipmaker is removed and the class
3257 3262 gets cleaned up, but for now it's ok. Key functionality here is
3258 3263 the addition of the persistent storage mechanism, a dict for
3259 3264 keeping data across sessions (for now just bookmarks, but more can
3260 3265 be implemented later).
3261 3266
3262 3267 * IPython/Magic.py (Magic.magic_bookmark): New bookmark system,
3263 3268 persistent across sections. Patch by Ville, I modified it
3264 3269 soemwhat to allow bookmarking arbitrary dirs other than CWD. Also
3265 3270 added a '-l' option to list all bookmarks.
3266 3271
3267 3272 * IPython/iplib.py (InteractiveShell.atexit_operations): new
3268 3273 center for cleanup. Registered with atexit.register(). I moved
3269 3274 here the old exit_cleanup(). After a patch by Ville.
3270 3275
3271 3276 * IPython/Magic.py (get_py_filename): added '~' to the accepted
3272 3277 characters in the hacked shlex_split for python 2.2.
3273 3278
3274 3279 * IPython/iplib.py (file_matches): more fixes to filenames with
3275 3280 whitespace in them. It's not perfect, but limitations in python's
3276 3281 readline make it impossible to go further.
3277 3282
3278 3283 2004-06-29 Fernando Perez <fperez@colorado.edu>
3279 3284
3280 3285 * IPython/iplib.py (file_matches): escape whitespace correctly in
3281 3286 filename completions. Bug reported by Ville.
3282 3287
3283 3288 2004-06-28 Fernando Perez <fperez@colorado.edu>
3284 3289
3285 3290 * IPython/ipmaker.py (__call__): Added per-profile histories. Now
3286 3291 the history file will be called 'history-PROFNAME' (or just
3287 3292 'history' if no profile is loaded). I was getting annoyed at
3288 3293 getting my Numerical work history clobbered by pysh sessions.
3289 3294
3290 3295 * IPython/iplib.py (InteractiveShell.__init__): Internal
3291 3296 getoutputerror() function so that we can honor the system_verbose
3292 3297 flag for _all_ system calls. I also added escaping of #
3293 3298 characters here to avoid confusing Itpl.
3294 3299
3295 3300 * IPython/Magic.py (shlex_split): removed call to shell in
3296 3301 parse_options and replaced it with shlex.split(). The annoying
3297 3302 part was that in Python 2.2, shlex.split() doesn't exist, so I had
3298 3303 to backport it from 2.3, with several frail hacks (the shlex
3299 3304 module is rather limited in 2.2). Thanks to a suggestion by Ville
3300 3305 Vainio <vivainio@kolumbus.fi>. For Python 2.3 there should be no
3301 3306 problem.
3302 3307
3303 3308 (Magic.magic_system_verbose): new toggle to print the actual
3304 3309 system calls made by ipython. Mainly for debugging purposes.
3305 3310
3306 3311 * IPython/GnuplotRuntime.py (gnu_out): fix bug for cygwin, which
3307 3312 doesn't support persistence. Reported (and fix suggested) by
3308 3313 Travis Caldwell <travis_caldwell2000@yahoo.com>.
3309 3314
3310 3315 2004-06-26 Fernando Perez <fperez@colorado.edu>
3311 3316
3312 3317 * IPython/Logger.py (Logger.log): fix to handle correctly empty
3313 3318 continue prompts.
3314 3319
3315 3320 * IPython/Extensions/InterpreterExec.py (pysh): moved the pysh()
3316 3321 function (basically a big docstring) and a few more things here to
3317 3322 speedup startup. pysh.py is now very lightweight. We want because
3318 3323 it gets execfile'd, while InterpreterExec gets imported, so
3319 3324 byte-compilation saves time.
3320 3325
3321 3326 2004-06-25 Fernando Perez <fperez@colorado.edu>
3322 3327
3323 3328 * IPython/Magic.py (Magic.magic_cd): Fixed to restore usage of 'cd
3324 3329 -NUM', which was recently broken.
3325 3330
3326 3331 * IPython/iplib.py (InteractiveShell.handle_shell_escape): allow !
3327 3332 in multi-line input (but not !!, which doesn't make sense there).
3328 3333
3329 3334 * IPython/UserConfig/ipythonrc: made autoindent on by default.
3330 3335 It's just too useful, and people can turn it off in the less
3331 3336 common cases where it's a problem.
3332 3337
3333 3338 2004-06-24 Fernando Perez <fperez@colorado.edu>
3334 3339
3335 3340 * IPython/iplib.py (InteractiveShell._prefilter): big change -
3336 3341 special syntaxes (like alias calling) is now allied in multi-line
3337 3342 input. This is still _very_ experimental, but it's necessary for
3338 3343 efficient shell usage combining python looping syntax with system
3339 3344 calls. For now it's restricted to aliases, I don't think it
3340 3345 really even makes sense to have this for magics.
3341 3346
3342 3347 2004-06-23 Fernando Perez <fperez@colorado.edu>
3343 3348
3344 3349 * IPython/Extensions/InterpreterExec.py (prefilter_shell): Added
3345 3350 $var=cmd <=> @sc var=cmd and $$var=cmd <=> @sc -l var=cmd.
3346 3351
3347 3352 * IPython/Magic.py (Magic.magic_rehashx): modified to handle
3348 3353 extensions under Windows (after code sent by Gary Bishop). The
3349 3354 extensions considered 'executable' are stored in IPython's rc
3350 3355 structure as win_exec_ext.
3351 3356
3352 3357 * IPython/genutils.py (shell): new function, like system() but
3353 3358 without return value. Very useful for interactive shell work.
3354 3359
3355 3360 * IPython/Magic.py (Magic.magic_unalias): New @unalias function to
3356 3361 delete aliases.
3357 3362
3358 3363 * IPython/iplib.py (InteractiveShell.alias_table_update): make
3359 3364 sure that the alias table doesn't contain python keywords.
3360 3365
3361 3366 2004-06-21 Fernando Perez <fperez@colorado.edu>
3362 3367
3363 3368 * IPython/Magic.py (Magic.magic_rehash): Fix crash when
3364 3369 non-existent items are found in $PATH. Reported by Thorsten.
3365 3370
3366 3371 2004-06-20 Fernando Perez <fperez@colorado.edu>
3367 3372
3368 3373 * IPython/iplib.py (complete): modified the completer so that the
3369 3374 order of priorities can be easily changed at runtime.
3370 3375
3371 3376 * IPython/Extensions/InterpreterExec.py (prefilter_shell):
3372 3377 Modified to auto-execute all lines beginning with '~', '/' or '.'.
3373 3378
3374 3379 * IPython/Magic.py (Magic.magic_sx): modified @sc and @sx to
3375 3380 expand Python variables prepended with $ in all system calls. The
3376 3381 same was done to InteractiveShell.handle_shell_escape. Now all
3377 3382 system access mechanisms (!, !!, @sc, @sx and aliases) allow the
3378 3383 expansion of python variables and expressions according to the
3379 3384 syntax of PEP-215 - http://www.python.org/peps/pep-0215.html.
3380 3385
3381 3386 Though PEP-215 has been rejected, a similar (but simpler) one
3382 3387 seems like it will go into Python 2.4, PEP-292 -
3383 3388 http://www.python.org/peps/pep-0292.html.
3384 3389
3385 3390 I'll keep the full syntax of PEP-215, since IPython has since the
3386 3391 start used Ka-Ping Yee's reference implementation discussed there
3387 3392 (Itpl), and I actually like the powerful semantics it offers.
3388 3393
3389 3394 In order to access normal shell variables, the $ has to be escaped
3390 3395 via an extra $. For example:
3391 3396
3392 3397 In [7]: PATH='a python variable'
3393 3398
3394 3399 In [8]: !echo $PATH
3395 3400 a python variable
3396 3401
3397 3402 In [9]: !echo $$PATH
3398 3403 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
3399 3404
3400 3405 (Magic.parse_options): escape $ so the shell doesn't evaluate
3401 3406 things prematurely.
3402 3407
3403 3408 * IPython/iplib.py (InteractiveShell.call_alias): added the
3404 3409 ability for aliases to expand python variables via $.
3405 3410
3406 3411 * IPython/Magic.py (Magic.magic_rehash): based on the new alias
3407 3412 system, now there's a @rehash/@rehashx pair of magics. These work
3408 3413 like the csh rehash command, and can be invoked at any time. They
3409 3414 build a table of aliases to everything in the user's $PATH
3410 3415 (@rehash uses everything, @rehashx is slower but only adds
3411 3416 executable files). With this, the pysh.py-based shell profile can
3412 3417 now simply call rehash upon startup, and full access to all
3413 3418 programs in the user's path is obtained.
3414 3419
3415 3420 * IPython/iplib.py (InteractiveShell.call_alias): The new alias
3416 3421 functionality is now fully in place. I removed the old dynamic
3417 3422 code generation based approach, in favor of a much lighter one
3418 3423 based on a simple dict. The advantage is that this allows me to
3419 3424 now have thousands of aliases with negligible cost (unthinkable
3420 3425 with the old system).
3421 3426
3422 3427 2004-06-19 Fernando Perez <fperez@colorado.edu>
3423 3428
3424 3429 * IPython/iplib.py (__init__): extended MagicCompleter class to
3425 3430 also complete (last in priority) on user aliases.
3426 3431
3427 3432 * IPython/Itpl.py (Itpl.__str__): fixed order of globals/locals in
3428 3433 call to eval.
3429 3434 (ItplNS.__init__): Added a new class which functions like Itpl,
3430 3435 but allows configuring the namespace for the evaluation to occur
3431 3436 in.
3432 3437
3433 3438 2004-06-18 Fernando Perez <fperez@colorado.edu>
3434 3439
3435 3440 * IPython/iplib.py (InteractiveShell.runcode): modify to print a
3436 3441 better message when 'exit' or 'quit' are typed (a common newbie
3437 3442 confusion).
3438 3443
3439 3444 * IPython/Magic.py (Magic.magic_colors): Added the runtime color
3440 3445 check for Windows users.
3441 3446
3442 3447 * IPython/iplib.py (InteractiveShell.user_setup): removed
3443 3448 disabling of colors for Windows. I'll test at runtime and issue a
3444 3449 warning if Gary's readline isn't found, as to nudge users to
3445 3450 download it.
3446 3451
3447 3452 2004-06-16 Fernando Perez <fperez@colorado.edu>
3448 3453
3449 3454 * IPython/genutils.py (Stream.__init__): changed to print errors
3450 3455 to sys.stderr. I had a circular dependency here. Now it's
3451 3456 possible to run ipython as IDLE's shell (consider this pre-alpha,
3452 3457 since true stdout things end up in the starting terminal instead
3453 3458 of IDLE's out).
3454 3459
3455 3460 * IPython/Prompts.py (Prompt2.set_colors): prevent crashes for
3456 3461 users who haven't # updated their prompt_in2 definitions. Remove
3457 3462 eventually.
3458 3463 (multiple_replace): added credit to original ASPN recipe.
3459 3464
3460 3465 2004-06-15 Fernando Perez <fperez@colorado.edu>
3461 3466
3462 3467 * IPython/iplib.py (InteractiveShell.__init__): add 'cp' to the
3463 3468 list of auto-defined aliases.
3464 3469
3465 3470 2004-06-13 Fernando Perez <fperez@colorado.edu>
3466 3471
3467 3472 * setup.py (scriptfiles): Don't trigger win_post_install unless an
3468 3473 install was really requested (so setup.py can be used for other
3469 3474 things under Windows).
3470 3475
3471 3476 2004-06-10 Fernando Perez <fperez@colorado.edu>
3472 3477
3473 3478 * IPython/Logger.py (Logger.create_log): Manually remove any old
3474 3479 backup, since os.remove may fail under Windows. Fixes bug
3475 3480 reported by Thorsten.
3476 3481
3477 3482 2004-06-09 Fernando Perez <fperez@colorado.edu>
3478 3483
3479 3484 * examples/example-embed.py: fixed all references to %n (replaced
3480 3485 with \\# for ps1/out prompts and with \\D for ps2 prompts). Done
3481 3486 for all examples and the manual as well.
3482 3487
3483 3488 2004-06-08 Fernando Perez <fperez@colorado.edu>
3484 3489
3485 3490 * IPython/Prompts.py (Prompt2.set_p_str): fixed all prompt
3486 3491 alignment and color management. All 3 prompt subsystems now
3487 3492 inherit from BasePrompt.
3488 3493
3489 3494 * tools/release: updates for windows installer build and tag rpms
3490 3495 with python version (since paths are fixed).
3491 3496
3492 3497 * IPython/UserConfig/ipythonrc: modified to use \# instead of %n,
3493 3498 which will become eventually obsolete. Also fixed the default
3494 3499 prompt_in2 to use \D, so at least new users start with the correct
3495 3500 defaults.
3496 3501 WARNING: Users with existing ipythonrc files will need to apply
3497 3502 this fix manually!
3498 3503
3499 3504 * setup.py: make windows installer (.exe). This is finally the
3500 3505 integration of an old patch by Cory Dodt <dodt-AT-fcoe.k12.ca.us>,
3501 3506 which I hadn't included because it required Python 2.3 (or recent
3502 3507 distutils).
3503 3508
3504 3509 * IPython/usage.py (__doc__): update docs (and manpage) to reflect
3505 3510 usage of new '\D' escape.
3506 3511
3507 3512 * IPython/Prompts.py (ROOT_SYMBOL): Small fix for Windows (which
3508 3513 lacks os.getuid())
3509 3514 (CachedOutput.set_colors): Added the ability to turn coloring
3510 3515 on/off with @colors even for manually defined prompt colors. It
3511 3516 uses a nasty global, but it works safely and via the generic color
3512 3517 handling mechanism.
3513 3518 (Prompt2.__init__): Introduced new escape '\D' for continuation
3514 3519 prompts. It represents the counter ('\#') as dots.
3515 3520 *** NOTE *** THIS IS A BACKWARDS-INCOMPATIBLE CHANGE. Users will
3516 3521 need to update their ipythonrc files and replace '%n' with '\D' in
3517 3522 their prompt_in2 settings everywhere. Sorry, but there's
3518 3523 otherwise no clean way to get all prompts to properly align. The
3519 3524 ipythonrc shipped with IPython has been updated.
3520 3525
3521 3526 2004-06-07 Fernando Perez <fperez@colorado.edu>
3522 3527
3523 3528 * setup.py (isfile): Pass local_icons option to latex2html, so the
3524 3529 resulting HTML file is self-contained. Thanks to
3525 3530 dryice-AT-liu.com.cn for the tip.
3526 3531
3527 3532 * pysh.py: I created a new profile 'shell', which implements a
3528 3533 _rudimentary_ IPython-based shell. This is in NO WAY a realy
3529 3534 system shell, nor will it become one anytime soon. It's mainly
3530 3535 meant to illustrate the use of the new flexible bash-like prompts.
3531 3536 I guess it could be used by hardy souls for true shell management,
3532 3537 but it's no tcsh/bash... pysh.py is loaded by the 'shell'
3533 3538 profile. This uses the InterpreterExec extension provided by
3534 3539 W.J. van der Laan <gnufnork-AT-hetdigitalegat.nl>
3535 3540
3536 3541 * IPython/Prompts.py (PromptOut.__str__): now it will correctly
3537 3542 auto-align itself with the length of the previous input prompt
3538 3543 (taking into account the invisible color escapes).
3539 3544 (CachedOutput.__init__): Large restructuring of this class. Now
3540 3545 all three prompts (primary1, primary2, output) are proper objects,
3541 3546 managed by the 'parent' CachedOutput class. The code is still a
3542 3547 bit hackish (all prompts share state via a pointer to the cache),
3543 3548 but it's overall far cleaner than before.
3544 3549
3545 3550 * IPython/genutils.py (getoutputerror): modified to add verbose,
3546 3551 debug and header options. This makes the interface of all getout*
3547 3552 functions uniform.
3548 3553 (SystemExec.getoutputerror): added getoutputerror to SystemExec.
3549 3554
3550 3555 * IPython/Magic.py (Magic.default_option): added a function to
3551 3556 allow registering default options for any magic command. This
3552 3557 makes it easy to have profiles which customize the magics globally
3553 3558 for a certain use. The values set through this function are
3554 3559 picked up by the parse_options() method, which all magics should
3555 3560 use to parse their options.
3556 3561
3557 3562 * IPython/genutils.py (warn): modified the warnings framework to
3558 3563 use the Term I/O class. I'm trying to slowly unify all of
3559 3564 IPython's I/O operations to pass through Term.
3560 3565
3561 3566 * IPython/Prompts.py (Prompt2._str_other): Added functionality in
3562 3567 the secondary prompt to correctly match the length of the primary
3563 3568 one for any prompt. Now multi-line code will properly line up
3564 3569 even for path dependent prompts, such as the new ones available
3565 3570 via the prompt_specials.
3566 3571
3567 3572 2004-06-06 Fernando Perez <fperez@colorado.edu>
3568 3573
3569 3574 * IPython/Prompts.py (prompt_specials): Added the ability to have
3570 3575 bash-like special sequences in the prompts, which get
3571 3576 automatically expanded. Things like hostname, current working
3572 3577 directory and username are implemented already, but it's easy to
3573 3578 add more in the future. Thanks to a patch by W.J. van der Laan
3574 3579 <gnufnork-AT-hetdigitalegat.nl>
3575 3580 (prompt_specials): Added color support for prompt strings, so
3576 3581 users can define arbitrary color setups for their prompts.
3577 3582
3578 3583 2004-06-05 Fernando Perez <fperez@colorado.edu>
3579 3584
3580 3585 * IPython/genutils.py (Term.reopen_all): Added Windows-specific
3581 3586 code to load Gary Bishop's readline and configure it
3582 3587 automatically. Thanks to Gary for help on this.
3583 3588
3584 3589 2004-06-01 Fernando Perez <fperez@colorado.edu>
3585 3590
3586 3591 * IPython/Logger.py (Logger.create_log): fix bug for logging
3587 3592 with no filename (previous fix was incomplete).
3588 3593
3589 3594 2004-05-25 Fernando Perez <fperez@colorado.edu>
3590 3595
3591 3596 * IPython/Magic.py (Magic.parse_options): fix bug where naked
3592 3597 parens would get passed to the shell.
3593 3598
3594 3599 2004-05-20 Fernando Perez <fperez@colorado.edu>
3595 3600
3596 3601 * IPython/Magic.py (Magic.magic_prun): changed default profile
3597 3602 sort order to 'time' (the more common profiling need).
3598 3603
3599 3604 * IPython/OInspect.py (Inspector.pinfo): flush the inspect cache
3600 3605 so that source code shown is guaranteed in sync with the file on
3601 3606 disk (also changed in psource). Similar fix to the one for
3602 3607 ultraTB on 2004-05-06. Thanks to a bug report by Yann Le Du
3603 3608 <yann.ledu-AT-noos.fr>.
3604 3609
3605 3610 * IPython/Magic.py (Magic.parse_options): Fixed bug where commands
3606 3611 with a single option would not be correctly parsed. Closes
3607 3612 http://www.scipy.net/roundup/ipython/issue14. This bug had been
3608 3613 introduced in 0.6.0 (on 2004-05-06).
3609 3614
3610 3615 2004-05-13 *** Released version 0.6.0
3611 3616
3612 3617 2004-05-13 Fernando Perez <fperez@colorado.edu>
3613 3618
3614 3619 * debian/: Added debian/ directory to CVS, so that debian support
3615 3620 is publicly accessible. The debian package is maintained by Jack
3616 3621 Moffit <jack-AT-xiph.org>.
3617 3622
3618 3623 * Documentation: included the notes about an ipython-based system
3619 3624 shell (the hypothetical 'pysh') into the new_design.pdf document,
3620 3625 so that these ideas get distributed to users along with the
3621 3626 official documentation.
3622 3627
3623 3628 2004-05-10 Fernando Perez <fperez@colorado.edu>
3624 3629
3625 3630 * IPython/Logger.py (Logger.create_log): fix recently introduced
3626 3631 bug (misindented line) where logstart would fail when not given an
3627 3632 explicit filename.
3628 3633
3629 3634 2004-05-09 Fernando Perez <fperez@colorado.edu>
3630 3635
3631 3636 * IPython/Magic.py (Magic.parse_options): skip system call when
3632 3637 there are no options to look for. Faster, cleaner for the common
3633 3638 case.
3634 3639
3635 3640 * Documentation: many updates to the manual: describing Windows
3636 3641 support better, Gnuplot updates, credits, misc small stuff. Also
3637 3642 updated the new_design doc a bit.
3638 3643
3639 3644 2004-05-06 *** Released version 0.6.0.rc1
3640 3645
3641 3646 2004-05-06 Fernando Perez <fperez@colorado.edu>
3642 3647
3643 3648 * IPython/ultraTB.py (ListTB.text): modified a ton of string +=
3644 3649 operations to use the vastly more efficient list/''.join() method.
3645 3650 (FormattedTB.text): Fix
3646 3651 http://www.scipy.net/roundup/ipython/issue12 - exception source
3647 3652 extract not updated after reload. Thanks to Mike Salib
3648 3653 <msalib-AT-mit.edu> for pinning the source of the problem.
3649 3654 Fortunately, the solution works inside ipython and doesn't require
3650 3655 any changes to python proper.
3651 3656
3652 3657 * IPython/Magic.py (Magic.parse_options): Improved to process the
3653 3658 argument list as a true shell would (by actually using the
3654 3659 underlying system shell). This way, all @magics automatically get
3655 3660 shell expansion for variables. Thanks to a comment by Alex
3656 3661 Schmolck.
3657 3662
3658 3663 2004-04-04 Fernando Perez <fperez@colorado.edu>
3659 3664
3660 3665 * IPython/iplib.py (InteractiveShell.interact): Added a special
3661 3666 trap for a debugger quit exception, which is basically impossible
3662 3667 to handle by normal mechanisms, given what pdb does to the stack.
3663 3668 This fixes a crash reported by <fgibbons-AT-llama.med.harvard.edu>.
3664 3669
3665 3670 2004-04-03 Fernando Perez <fperez@colorado.edu>
3666 3671
3667 3672 * IPython/genutils.py (Term): Standardized the names of the Term
3668 3673 class streams to cin/cout/cerr, following C++ naming conventions
3669 3674 (I can't use in/out/err because 'in' is not a valid attribute
3670 3675 name).
3671 3676
3672 3677 * IPython/iplib.py (InteractiveShell.interact): don't increment
3673 3678 the prompt if there's no user input. By Daniel 'Dang' Griffith
3674 3679 <pythondev-dang-AT-lazytwinacres.net>, after a suggestion from
3675 3680 Francois Pinard.
3676 3681
3677 3682 2004-04-02 Fernando Perez <fperez@colorado.edu>
3678 3683
3679 3684 * IPython/genutils.py (Stream.__init__): Modified to survive at
3680 3685 least importing in contexts where stdin/out/err aren't true file
3681 3686 objects, such as PyCrust (they lack fileno() and mode). However,
3682 3687 the recovery facilities which rely on these things existing will
3683 3688 not work.
3684 3689
3685 3690 2004-04-01 Fernando Perez <fperez@colorado.edu>
3686 3691
3687 3692 * IPython/Magic.py (Magic.magic_sx): modified (as well as @sc) to
3688 3693 use the new getoutputerror() function, so it properly
3689 3694 distinguishes stdout/err.
3690 3695
3691 3696 * IPython/genutils.py (getoutputerror): added a function to
3692 3697 capture separately the standard output and error of a command.
3693 3698 After a comment from dang on the mailing lists. This code is
3694 3699 basically a modified version of commands.getstatusoutput(), from
3695 3700 the standard library.
3696 3701
3697 3702 * IPython/iplib.py (InteractiveShell.handle_shell_escape): added
3698 3703 '!!' as a special syntax (shorthand) to access @sx.
3699 3704
3700 3705 * IPython/Magic.py (Magic.magic_sx): new magic, to execute a shell
3701 3706 command and return its output as a list split on '\n'.
3702 3707
3703 3708 2004-03-31 Fernando Perez <fperez@colorado.edu>
3704 3709
3705 3710 * IPython/FakeModule.py (FakeModule.__init__): added __nonzero__
3706 3711 method to dictionaries used as FakeModule instances if they lack
3707 3712 it. At least pydoc in python2.3 breaks for runtime-defined
3708 3713 functions without this hack. At some point I need to _really_
3709 3714 understand what FakeModule is doing, because it's a gross hack.
3710 3715 But it solves Arnd's problem for now...
3711 3716
3712 3717 2004-02-27 Fernando Perez <fperez@colorado.edu>
3713 3718
3714 3719 * IPython/Logger.py (Logger.create_log): Fix bug where 'rotate'
3715 3720 mode would behave erratically. Also increased the number of
3716 3721 possible logs in rotate mod to 999. Thanks to Rod Holland
3717 3722 <rhh@StructureLABS.com> for the report and fixes.
3718 3723
3719 3724 2004-02-26 Fernando Perez <fperez@colorado.edu>
3720 3725
3721 3726 * IPython/genutils.py (page): Check that the curses module really
3722 3727 has the initscr attribute before trying to use it. For some
3723 3728 reason, the Solaris curses module is missing this. I think this
3724 3729 should be considered a Solaris python bug, but I'm not sure.
3725 3730
3726 3731 2004-01-17 Fernando Perez <fperez@colorado.edu>
3727 3732
3728 3733 * IPython/genutils.py (Stream.__init__): Changes to try to make
3729 3734 ipython robust against stdin/out/err being closed by the user.
3730 3735 This is 'user error' (and blocks a normal python session, at least
3731 3736 the stdout case). However, Ipython should be able to survive such
3732 3737 instances of abuse as gracefully as possible. To simplify the
3733 3738 coding and maintain compatibility with Gary Bishop's Term
3734 3739 contributions, I've made use of classmethods for this. I think
3735 3740 this introduces a dependency on python 2.2.
3736 3741
3737 3742 2004-01-13 Fernando Perez <fperez@colorado.edu>
3738 3743
3739 3744 * IPython/numutils.py (exp_safe): simplified the code a bit and
3740 3745 removed the need for importing the kinds module altogether.
3741 3746
3742 3747 2004-01-06 Fernando Perez <fperez@colorado.edu>
3743 3748
3744 3749 * IPython/Magic.py (Magic.magic_sc): Made the shell capture system
3745 3750 a magic function instead, after some community feedback. No
3746 3751 special syntax will exist for it, but its name is deliberately
3747 3752 very short.
3748 3753
3749 3754 2003-12-20 Fernando Perez <fperez@colorado.edu>
3750 3755
3751 3756 * IPython/iplib.py (InteractiveShell.handle_shell_assign): Added
3752 3757 new functionality, to automagically assign the result of a shell
3753 3758 command to a variable. I'll solicit some community feedback on
3754 3759 this before making it permanent.
3755 3760
3756 3761 * IPython/OInspect.py (Inspector.pinfo): Fix crash when info was
3757 3762 requested about callables for which inspect couldn't obtain a
3758 3763 proper argspec. Thanks to a crash report sent by Etienne
3759 3764 Posthumus <etienne-AT-apple01.cs.vu.nl>.
3760 3765
3761 3766 2003-12-09 Fernando Perez <fperez@colorado.edu>
3762 3767
3763 3768 * IPython/genutils.py (page): patch for the pager to work across
3764 3769 various versions of Windows. By Gary Bishop.
3765 3770
3766 3771 2003-12-04 Fernando Perez <fperez@colorado.edu>
3767 3772
3768 3773 * IPython/Gnuplot2.py (PlotItems): Fixes for working with
3769 3774 Gnuplot.py version 1.7, whose internal names changed quite a bit.
3770 3775 While I tested this and it looks ok, there may still be corner
3771 3776 cases I've missed.
3772 3777
3773 3778 2003-12-01 Fernando Perez <fperez@colorado.edu>
3774 3779
3775 3780 * IPython/iplib.py (InteractiveShell._prefilter): Fixed a bug
3776 3781 where a line like 'p,q=1,2' would fail because the automagic
3777 3782 system would be triggered for @p.
3778 3783
3779 3784 * IPython/DPyGetOpt.py (DPyGetOpt.processArguments): Tab-related
3780 3785 cleanups, code unmodified.
3781 3786
3782 3787 * IPython/genutils.py (Term): added a class for IPython to handle
3783 3788 output. In most cases it will just be a proxy for stdout/err, but
3784 3789 having this allows modifications to be made for some platforms,
3785 3790 such as handling color escapes under Windows. All of this code
3786 3791 was contributed by Gary Bishop, with minor modifications by me.
3787 3792 The actual changes affect many files.
3788 3793
3789 3794 2003-11-30 Fernando Perez <fperez@colorado.edu>
3790 3795
3791 3796 * IPython/iplib.py (file_matches): new completion code, courtesy
3792 3797 of Jeff Collins. This enables filename completion again under
3793 3798 python 2.3, which disabled it at the C level.
3794 3799
3795 3800 2003-11-11 Fernando Perez <fperez@colorado.edu>
3796 3801
3797 3802 * IPython/numutils.py (amap): Added amap() fn. Simple shorthand
3798 3803 for Numeric.array(map(...)), but often convenient.
3799 3804
3800 3805 2003-11-05 Fernando Perez <fperez@colorado.edu>
3801 3806
3802 3807 * IPython/numutils.py (frange): Changed a call from int() to
3803 3808 int(round()) to prevent a problem reported with arange() in the
3804 3809 numpy list.
3805 3810
3806 3811 2003-10-06 Fernando Perez <fperez@colorado.edu>
3807 3812
3808 3813 * IPython/DPyGetOpt.py (DPyGetOpt.processArguments): changed to
3809 3814 prevent crashes if sys lacks an argv attribute (it happens with
3810 3815 embedded interpreters which build a bare-bones sys module).
3811 3816 Thanks to a report/bugfix by Adam Hupp <hupp-AT-cs.wisc.edu>.
3812 3817
3813 3818 2003-09-24 Fernando Perez <fperez@colorado.edu>
3814 3819
3815 3820 * IPython/Magic.py (Magic._ofind): blanket except around getattr()
3816 3821 to protect against poorly written user objects where __getattr__
3817 3822 raises exceptions other than AttributeError. Thanks to a bug
3818 3823 report by Oliver Sander <osander-AT-gmx.de>.
3819 3824
3820 3825 * IPython/FakeModule.py (FakeModule.__repr__): this method was
3821 3826 missing. Thanks to bug report by Ralf Schmitt <ralf-AT-brainbot.com>.
3822 3827
3823 3828 2003-09-09 Fernando Perez <fperez@colorado.edu>
3824 3829
3825 3830 * IPython/iplib.py (InteractiveShell._prefilter): fix bug where
3826 3831 unpacking a list whith a callable as first element would
3827 3832 mistakenly trigger autocalling. Thanks to a bug report by Jeffery
3828 3833 Collins.
3829 3834
3830 3835 2003-08-25 *** Released version 0.5.0
3831 3836
3832 3837 2003-08-22 Fernando Perez <fperez@colorado.edu>
3833 3838
3834 3839 * IPython/ultraTB.py (VerboseTB.linereader): Improved handling of
3835 3840 improperly defined user exceptions. Thanks to feedback from Mark
3836 3841 Russell <mrussell-AT-verio.net>.
3837 3842
3838 3843 2003-08-20 Fernando Perez <fperez@colorado.edu>
3839 3844
3840 3845 * IPython/OInspect.py (Inspector.pinfo): changed String Form
3841 3846 printing so that it would print multi-line string forms starting
3842 3847 with a new line. This way the formatting is better respected for
3843 3848 objects which work hard to make nice string forms.
3844 3849
3845 3850 * IPython/iplib.py (InteractiveShell.handle_auto): Fix bug where
3846 3851 autocall would overtake data access for objects with both
3847 3852 __getitem__ and __call__.
3848 3853
3849 3854 2003-08-19 *** Released version 0.5.0-rc1
3850 3855
3851 3856 2003-08-19 Fernando Perez <fperez@colorado.edu>
3852 3857
3853 3858 * IPython/deep_reload.py (load_tail): single tiny change here
3854 3859 seems to fix the long-standing bug of dreload() failing to work
3855 3860 for dotted names. But this module is pretty tricky, so I may have
3856 3861 missed some subtlety. Needs more testing!.
3857 3862
3858 3863 * IPython/ultraTB.py (VerboseTB.linereader): harden against user
3859 3864 exceptions which have badly implemented __str__ methods.
3860 3865 (VerboseTB.text): harden against inspect.getinnerframes crashing,
3861 3866 which I've been getting reports about from Python 2.3 users. I
3862 3867 wish I had a simple test case to reproduce the problem, so I could
3863 3868 either write a cleaner workaround or file a bug report if
3864 3869 necessary.
3865 3870
3866 3871 * IPython/Magic.py (Magic.magic_edit): fixed bug where after
3867 3872 making a class 'foo', file 'foo.py' couldn't be edited. Thanks to
3868 3873 a bug report by Tjabo Kloppenburg.
3869 3874
3870 3875 * IPython/ultraTB.py (VerboseTB.debugger): hardened against pdb
3871 3876 crashes. Wrapped the pdb call in a blanket try/except, since pdb
3872 3877 seems rather unstable. Thanks to a bug report by Tjabo
3873 3878 Kloppenburg <tjabo.kloppenburg-AT-unix-ag.uni-siegen.de>.
3874 3879
3875 3880 * IPython/Release.py (version): release 0.5.0-rc1. I want to put
3876 3881 this out soon because of the critical fixes in the inner loop for
3877 3882 generators.
3878 3883
3879 3884 * IPython/Magic.py (Magic.getargspec): removed. This (and
3880 3885 _get_def) have been obsoleted by OInspect for a long time, I
3881 3886 hadn't noticed that they were dead code.
3882 3887 (Magic._ofind): restored _ofind functionality for a few literals
3883 3888 (those in ["''",'""','[]','{}','()']). But it won't work anymore
3884 3889 for things like "hello".capitalize?, since that would require a
3885 3890 potentially dangerous eval() again.
3886 3891
3887 3892 * IPython/iplib.py (InteractiveShell._prefilter): reorganized the
3888 3893 logic a bit more to clean up the escapes handling and minimize the
3889 3894 use of _ofind to only necessary cases. The interactive 'feel' of
3890 3895 IPython should have improved quite a bit with the changes in
3891 3896 _prefilter and _ofind (besides being far safer than before).
3892 3897
3893 3898 * IPython/Magic.py (Magic.magic_edit): Fixed old bug (but rather
3894 3899 obscure, never reported). Edit would fail to find the object to
3895 3900 edit under some circumstances.
3896 3901 (Magic._ofind): CRITICAL FIX. Finally removed the eval() calls
3897 3902 which were causing double-calling of generators. Those eval calls
3898 3903 were _very_ dangerous, since code with side effects could be
3899 3904 triggered. As they say, 'eval is evil'... These were the
3900 3905 nastiest evals in IPython. Besides, _ofind is now far simpler,
3901 3906 and it should also be quite a bit faster. Its use of inspect is
3902 3907 also safer, so perhaps some of the inspect-related crashes I've
3903 3908 seen lately with Python 2.3 might be taken care of. That will
3904 3909 need more testing.
3905 3910
3906 3911 2003-08-17 Fernando Perez <fperez@colorado.edu>
3907 3912
3908 3913 * IPython/iplib.py (InteractiveShell._prefilter): significant
3909 3914 simplifications to the logic for handling user escapes. Faster
3910 3915 and simpler code.
3911 3916
3912 3917 2003-08-14 Fernando Perez <fperez@colorado.edu>
3913 3918
3914 3919 * IPython/numutils.py (sum_flat): rewrote to be non-recursive.
3915 3920 Now it requires O(N) storage (N=size(a)) for non-contiguous input,
3916 3921 but it should be quite a bit faster. And the recursive version
3917 3922 generated O(log N) intermediate storage for all rank>1 arrays,
3918 3923 even if they were contiguous.
3919 3924 (l1norm): Added this function.
3920 3925 (norm): Added this function for arbitrary norms (including
3921 3926 l-infinity). l1 and l2 are still special cases for convenience
3922 3927 and speed.
3923 3928
3924 3929 2003-08-03 Fernando Perez <fperez@colorado.edu>
3925 3930
3926 3931 * IPython/Magic.py (Magic.magic_edit): Removed all remaining string
3927 3932 exceptions, which now raise PendingDeprecationWarnings in Python
3928 3933 2.3. There were some in Magic and some in Gnuplot2.
3929 3934
3930 3935 2003-06-30 Fernando Perez <fperez@colorado.edu>
3931 3936
3932 3937 * IPython/genutils.py (page): modified to call curses only for
3933 3938 terminals where TERM=='xterm'. After problems under many other
3934 3939 terminals were reported by Keith Beattie <KSBeattie-AT-lbl.gov>.
3935 3940
3936 3941 * IPython/iplib.py (complete): removed spurious 'print "IE"' which
3937 3942 would be triggered when readline was absent. This was just an old
3938 3943 debugging statement I'd forgotten to take out.
3939 3944
3940 3945 2003-06-20 Fernando Perez <fperez@colorado.edu>
3941 3946
3942 3947 * IPython/genutils.py (clock): modified to return only user time
3943 3948 (not counting system time), after a discussion on scipy. While
3944 3949 system time may be a useful quantity occasionally, it may much
3945 3950 more easily be skewed by occasional swapping or other similar
3946 3951 activity.
3947 3952
3948 3953 2003-06-05 Fernando Perez <fperez@colorado.edu>
3949 3954
3950 3955 * IPython/numutils.py (identity): new function, for building
3951 3956 arbitrary rank Kronecker deltas (mostly backwards compatible with
3952 3957 Numeric.identity)
3953 3958
3954 3959 2003-06-03 Fernando Perez <fperez@colorado.edu>
3955 3960
3956 3961 * IPython/iplib.py (InteractiveShell.handle_magic): protect
3957 3962 arguments passed to magics with spaces, to allow trailing '\' to
3958 3963 work normally (mainly for Windows users).
3959 3964
3960 3965 2003-05-29 Fernando Perez <fperez@colorado.edu>
3961 3966
3962 3967 * IPython/ipmaker.py (make_IPython): Load site._Helper() as help
3963 3968 instead of pydoc.help. This fixes a bizarre behavior where
3964 3969 printing '%s' % locals() would trigger the help system. Now
3965 3970 ipython behaves like normal python does.
3966 3971
3967 3972 Note that if one does 'from pydoc import help', the bizarre
3968 3973 behavior returns, but this will also happen in normal python, so
3969 3974 it's not an ipython bug anymore (it has to do with how pydoc.help
3970 3975 is implemented).
3971 3976
3972 3977 2003-05-22 Fernando Perez <fperez@colorado.edu>
3973 3978
3974 3979 * IPython/FlexCompleter.py (Completer.attr_matches): fixed to
3975 3980 return [] instead of None when nothing matches, also match to end
3976 3981 of line. Patch by Gary Bishop.
3977 3982
3978 3983 * IPython/ipmaker.py (make_IPython): Added same sys.excepthook
3979 3984 protection as before, for files passed on the command line. This
3980 3985 prevents the CrashHandler from kicking in if user files call into
3981 3986 sys.excepthook (such as PyQt and WxWindows have a nasty habit of
3982 3987 doing). After a report by Kasper Souren <Kasper.Souren-AT-ircam.fr>
3983 3988
3984 3989 2003-05-20 *** Released version 0.4.0
3985 3990
3986 3991 2003-05-20 Fernando Perez <fperez@colorado.edu>
3987 3992
3988 3993 * setup.py: added support for manpages. It's a bit hackish b/c of
3989 3994 a bug in the way the bdist_rpm distutils target handles gzipped
3990 3995 manpages, but it works. After a patch by Jack.
3991 3996
3992 3997 2003-05-19 Fernando Perez <fperez@colorado.edu>
3993 3998
3994 3999 * IPython/numutils.py: added a mockup of the kinds module, since
3995 4000 it was recently removed from Numeric. This way, numutils will
3996 4001 work for all users even if they are missing kinds.
3997 4002
3998 4003 * IPython/Magic.py (Magic._ofind): Harden against an inspect
3999 4004 failure, which can occur with SWIG-wrapped extensions. After a
4000 4005 crash report from Prabhu.
4001 4006
4002 4007 2003-05-16 Fernando Perez <fperez@colorado.edu>
4003 4008
4004 4009 * IPython/iplib.py (InteractiveShell.excepthook): New method to
4005 4010 protect ipython from user code which may call directly
4006 4011 sys.excepthook (this looks like an ipython crash to the user, even
4007 4012 when it isn't). After a patch by Gary Bishop <gb-AT-cs.unc.edu>.
4008 4013 This is especially important to help users of WxWindows, but may
4009 4014 also be useful in other cases.
4010 4015
4011 4016 * IPython/ultraTB.py (AutoFormattedTB.__call__): Changed to allow
4012 4017 an optional tb_offset to be specified, and to preserve exception
4013 4018 info if given. After a patch by Gary Bishop <gb-AT-cs.unc.edu>.
4014 4019
4015 4020 * ipython.1 (Default): Thanks to Jack's work, we now have manpages!
4016 4021
4017 4022 2003-05-15 Fernando Perez <fperez@colorado.edu>
4018 4023
4019 4024 * IPython/iplib.py (InteractiveShell.user_setup): Fix crash when
4020 4025 installing for a new user under Windows.
4021 4026
4022 4027 2003-05-12 Fernando Perez <fperez@colorado.edu>
4023 4028
4024 4029 * IPython/iplib.py (InteractiveShell.handle_emacs): New line
4025 4030 handler for Emacs comint-based lines. Currently it doesn't do
4026 4031 much (but importantly, it doesn't update the history cache). In
4027 4032 the future it may be expanded if Alex needs more functionality
4028 4033 there.
4029 4034
4030 4035 * IPython/CrashHandler.py (CrashHandler.__call__): Added platform
4031 4036 info to crash reports.
4032 4037
4033 4038 * IPython/iplib.py (InteractiveShell.mainloop): Added -c option,
4034 4039 just like Python's -c. Also fixed crash with invalid -color
4035 4040 option value at startup. Thanks to Will French
4036 4041 <wfrench-AT-bestweb.net> for the bug report.
4037 4042
4038 4043 2003-05-09 Fernando Perez <fperez@colorado.edu>
4039 4044
4040 4045 * IPython/genutils.py (EvalDict.__getitem__): Renamed EvalString
4041 4046 to EvalDict (it's a mapping, after all) and simplified its code
4042 4047 quite a bit, after a nice discussion on c.l.py where Gustavo
4043 4048 CΓ³rdova <gcordova-AT-sismex.com> suggested the new version.
4044 4049
4045 4050 2003-04-30 Fernando Perez <fperez@colorado.edu>
4046 4051
4047 4052 * IPython/genutils.py (timings_out): modified it to reduce its
4048 4053 overhead in the common reps==1 case.
4049 4054
4050 4055 2003-04-29 Fernando Perez <fperez@colorado.edu>
4051 4056
4052 4057 * IPython/genutils.py (timings_out): Modified to use the resource
4053 4058 module, which avoids the wraparound problems of time.clock().
4054 4059
4055 4060 2003-04-17 *** Released version 0.2.15pre4
4056 4061
4057 4062 2003-04-17 Fernando Perez <fperez@colorado.edu>
4058 4063
4059 4064 * setup.py (scriptfiles): Split windows-specific stuff over to a
4060 4065 separate file, in an attempt to have a Windows GUI installer.
4061 4066 That didn't work, but part of the groundwork is done.
4062 4067
4063 4068 * IPython/UserConfig/ipythonrc: Added M-i, M-o and M-I for
4064 4069 indent/unindent with 4 spaces. Particularly useful in combination
4065 4070 with the new auto-indent option.
4066 4071
4067 4072 2003-04-16 Fernando Perez <fperez@colorado.edu>
4068 4073
4069 4074 * IPython/Magic.py: various replacements of self.rc for
4070 4075 self.shell.rc. A lot more remains to be done to fully disentangle
4071 4076 this class from the main Shell class.
4072 4077
4073 4078 * IPython/GnuplotRuntime.py: added checks for mouse support so
4074 4079 that we don't try to enable it if the current gnuplot doesn't
4075 4080 really support it. Also added checks so that we don't try to
4076 4081 enable persist under Windows (where Gnuplot doesn't recognize the
4077 4082 option).
4078 4083
4079 4084 * IPython/iplib.py (InteractiveShell.interact): Added optional
4080 4085 auto-indenting code, after a patch by King C. Shu
4081 4086 <kingshu-AT-myrealbox.com>. It's off by default because it doesn't
4082 4087 get along well with pasting indented code. If I ever figure out
4083 4088 how to make that part go well, it will become on by default.
4084 4089
4085 4090 * IPython/Prompts.py (Prompt1.auto_rewrite): Fixed bug which would
4086 4091 crash ipython if there was an unmatched '%' in the user's prompt
4087 4092 string. Reported by Thorsten Kampe <thorsten-AT-thorstenkampe.de>.
4088 4093
4089 4094 * IPython/iplib.py (InteractiveShell.interact): removed the
4090 4095 ability to ask the user whether he wants to crash or not at the
4091 4096 'last line' exception handler. Calling functions at that point
4092 4097 changes the stack, and the error reports would have incorrect
4093 4098 tracebacks.
4094 4099
4095 4100 * IPython/Magic.py (Magic.magic_page): Added new @page magic, to
4096 4101 pass through a peger a pretty-printed form of any object. After a
4097 4102 contribution by Olivier Aubert <oaubert-AT-bat710.univ-lyon1.fr>
4098 4103
4099 4104 2003-04-14 Fernando Perez <fperez@colorado.edu>
4100 4105
4101 4106 * IPython/iplib.py (InteractiveShell.user_setup): Fixed bug where
4102 4107 all files in ~ would be modified at first install (instead of
4103 4108 ~/.ipython). This could be potentially disastrous, as the
4104 4109 modification (make line-endings native) could damage binary files.
4105 4110
4106 4111 2003-04-10 Fernando Perez <fperez@colorado.edu>
4107 4112
4108 4113 * IPython/iplib.py (InteractiveShell.handle_help): Modified to
4109 4114 handle only lines which are invalid python. This now means that
4110 4115 lines like 'x=1 #?' execute properly. Thanks to Jeffery Collins
4111 4116 for the bug report.
4112 4117
4113 4118 2003-04-01 Fernando Perez <fperez@colorado.edu>
4114 4119
4115 4120 * IPython/iplib.py (InteractiveShell.showtraceback): Fixed bug
4116 4121 where failing to set sys.last_traceback would crash pdb.pm().
4117 4122 Thanks to Jeffery D. Collins <Jeff.Collins-AT-vexcel.com> for the bug
4118 4123 report.
4119 4124
4120 4125 2003-03-25 Fernando Perez <fperez@colorado.edu>
4121 4126
4122 4127 * IPython/Magic.py (Magic.magic_prun): rstrip() output of profiler
4123 4128 before printing it (it had a lot of spurious blank lines at the
4124 4129 end).
4125 4130
4126 4131 * IPython/Gnuplot2.py (Gnuplot.hardcopy): fixed bug where lpr
4127 4132 output would be sent 21 times! Obviously people don't use this
4128 4133 too often, or I would have heard about it.
4129 4134
4130 4135 2003-03-24 Fernando Perez <fperez@colorado.edu>
4131 4136
4132 4137 * setup.py (scriptfiles): renamed the data_files parameter from
4133 4138 'base' to 'data' to fix rpm build issues. Thanks to Ralf Ahlbrink
4134 4139 for the patch.
4135 4140
4136 4141 2003-03-20 Fernando Perez <fperez@colorado.edu>
4137 4142
4138 4143 * IPython/genutils.py (error): added error() and fatal()
4139 4144 functions.
4140 4145
4141 4146 2003-03-18 *** Released version 0.2.15pre3
4142 4147
4143 4148 2003-03-18 Fernando Perez <fperez@colorado.edu>
4144 4149
4145 4150 * setupext/install_data_ext.py
4146 4151 (install_data_ext.initialize_options): Class contributed by Jack
4147 4152 Moffit for fixing the old distutils hack. He is sending this to
4148 4153 the distutils folks so in the future we may not need it as a
4149 4154 private fix.
4150 4155
4151 4156 * MANIFEST.in: Extensive reorganization, based on Jack Moffit's
4152 4157 changes for Debian packaging. See his patch for full details.
4153 4158 The old distutils hack of making the ipythonrc* files carry a
4154 4159 bogus .py extension is gone, at last. Examples were moved to a
4155 4160 separate subdir under doc/, and the separate executable scripts
4156 4161 now live in their own directory. Overall a great cleanup. The
4157 4162 manual was updated to use the new files, and setup.py has been
4158 4163 fixed for this setup.
4159 4164
4160 4165 * IPython/PyColorize.py (Parser.usage): made non-executable and
4161 4166 created a pycolor wrapper around it to be included as a script.
4162 4167
4163 4168 2003-03-12 *** Released version 0.2.15pre2
4164 4169
4165 4170 2003-03-12 Fernando Perez <fperez@colorado.edu>
4166 4171
4167 4172 * IPython/ColorANSI.py (make_color_table): Finally fixed the
4168 4173 long-standing problem with garbage characters in some terminals.
4169 4174 The issue was really that the \001 and \002 escapes must _only_ be
4170 4175 passed to input prompts (which call readline), but _never_ to
4171 4176 normal text to be printed on screen. I changed ColorANSI to have
4172 4177 two classes: TermColors and InputTermColors, each with the
4173 4178 appropriate escapes for input prompts or normal text. The code in
4174 4179 Prompts.py got slightly more complicated, but this very old and
4175 4180 annoying bug is finally fixed.
4176 4181
4177 4182 All the credit for nailing down the real origin of this problem
4178 4183 and the correct solution goes to Jack Moffit <jack-AT-xiph.org>.
4179 4184 *Many* thanks to him for spending quite a bit of effort on this.
4180 4185
4181 4186 2003-03-05 *** Released version 0.2.15pre1
4182 4187
4183 4188 2003-03-03 Fernando Perez <fperez@colorado.edu>
4184 4189
4185 4190 * IPython/FakeModule.py: Moved the former _FakeModule to a
4186 4191 separate file, because it's also needed by Magic (to fix a similar
4187 4192 pickle-related issue in @run).
4188 4193
4189 4194 2003-03-02 Fernando Perez <fperez@colorado.edu>
4190 4195
4191 4196 * IPython/Magic.py (Magic.magic_autocall): new magic to control
4192 4197 the autocall option at runtime.
4193 4198 (Magic.magic_dhist): changed self.user_ns to self.shell.user_ns
4194 4199 across Magic.py to start separating Magic from InteractiveShell.
4195 4200 (Magic._ofind): Fixed to return proper namespace for dotted
4196 4201 names. Before, a dotted name would always return 'not currently
4197 4202 defined', because it would find the 'parent'. s.x would be found,
4198 4203 but since 'x' isn't defined by itself, it would get confused.
4199 4204 (Magic.magic_run): Fixed pickling problems reported by Ralf
4200 4205 Ahlbrink <RAhlbrink-AT-RosenInspection.net>. The fix was similar to
4201 4206 that I'd used when Mike Heeter reported similar issues at the
4202 4207 top-level, but now for @run. It boils down to injecting the
4203 4208 namespace where code is being executed with something that looks
4204 4209 enough like a module to fool pickle.dump(). Since a pickle stores
4205 4210 a named reference to the importing module, we need this for
4206 4211 pickles to save something sensible.
4207 4212
4208 4213 * IPython/ipmaker.py (make_IPython): added an autocall option.
4209 4214
4210 4215 * IPython/iplib.py (InteractiveShell._prefilter): reordered all of
4211 4216 the auto-eval code. Now autocalling is an option, and the code is
4212 4217 also vastly safer. There is no more eval() involved at all.
4213 4218
4214 4219 2003-03-01 Fernando Perez <fperez@colorado.edu>
4215 4220
4216 4221 * IPython/Magic.py (Magic._ofind): Changed interface to return a
4217 4222 dict with named keys instead of a tuple.
4218 4223
4219 4224 * IPython: Started using CVS for IPython as of 0.2.15pre1.
4220 4225
4221 4226 * setup.py (make_shortcut): Fixed message about directories
4222 4227 created during Windows installation (the directories were ok, just
4223 4228 the printed message was misleading). Thanks to Chris Liechti
4224 4229 <cliechti-AT-gmx.net> for the heads up.
4225 4230
4226 4231 2003-02-21 Fernando Perez <fperez@colorado.edu>
4227 4232
4228 4233 * IPython/iplib.py (InteractiveShell._prefilter): Fixed catching
4229 4234 of ValueError exception when checking for auto-execution. This
4230 4235 one is raised by things like Numeric arrays arr.flat when the
4231 4236 array is non-contiguous.
4232 4237
4233 4238 2003-01-31 Fernando Perez <fperez@colorado.edu>
4234 4239
4235 4240 * IPython/genutils.py (SystemExec.bq): Fixed bug where bq would
4236 4241 not return any value at all (even though the command would get
4237 4242 executed).
4238 4243 (xsys): Flush stdout right after printing the command to ensure
4239 4244 proper ordering of commands and command output in the total
4240 4245 output.
4241 4246 (SystemExec/xsys/bq): Switched the names of xsys/bq and
4242 4247 system/getoutput as defaults. The old ones are kept for
4243 4248 compatibility reasons, so no code which uses this library needs
4244 4249 changing.
4245 4250
4246 4251 2003-01-27 *** Released version 0.2.14
4247 4252
4248 4253 2003-01-25 Fernando Perez <fperez@colorado.edu>
4249 4254
4250 4255 * IPython/Magic.py (Magic.magic_edit): Fixed problem where
4251 4256 functions defined in previous edit sessions could not be re-edited
4252 4257 (because the temp files were immediately removed). Now temp files
4253 4258 are removed only at IPython's exit.
4254 4259 (Magic.magic_run): Improved @run to perform shell-like expansions
4255 4260 on its arguments (~users and $VARS). With this, @run becomes more
4256 4261 like a normal command-line.
4257 4262
4258 4263 * IPython/Shell.py (IPShellEmbed.__call__): Fixed a bunch of small
4259 4264 bugs related to embedding and cleaned up that code. A fairly
4260 4265 important one was the impossibility to access the global namespace
4261 4266 through the embedded IPython (only local variables were visible).
4262 4267
4263 4268 2003-01-14 Fernando Perez <fperez@colorado.edu>
4264 4269
4265 4270 * IPython/iplib.py (InteractiveShell._prefilter): Fixed
4266 4271 auto-calling to be a bit more conservative. Now it doesn't get
4267 4272 triggered if any of '!=()<>' are in the rest of the input line, to
4268 4273 allow comparing callables. Thanks to Alex for the heads up.
4269 4274
4270 4275 2003-01-07 Fernando Perez <fperez@colorado.edu>
4271 4276
4272 4277 * IPython/genutils.py (page): fixed estimation of the number of
4273 4278 lines in a string to be paged to simply count newlines. This
4274 4279 prevents over-guessing due to embedded escape sequences. A better
4275 4280 long-term solution would involve stripping out the control chars
4276 4281 for the count, but it's potentially so expensive I just don't
4277 4282 think it's worth doing.
4278 4283
4279 4284 2002-12-19 *** Released version 0.2.14pre50
4280 4285
4281 4286 2002-12-19 Fernando Perez <fperez@colorado.edu>
4282 4287
4283 4288 * tools/release (version): Changed release scripts to inform
4284 4289 Andrea and build a NEWS file with a list of recent changes.
4285 4290
4286 4291 * IPython/ColorANSI.py (__all__): changed terminal detection
4287 4292 code. Seems to work better for xterms without breaking
4288 4293 konsole. Will need more testing to determine if WinXP and Mac OSX
4289 4294 also work ok.
4290 4295
4291 4296 2002-12-18 *** Released version 0.2.14pre49
4292 4297
4293 4298 2002-12-18 Fernando Perez <fperez@colorado.edu>
4294 4299
4295 4300 * Docs: added new info about Mac OSX, from Andrea.
4296 4301
4297 4302 * IPython/Gnuplot2.py (String): Added a String PlotItem class to
4298 4303 allow direct plotting of python strings whose format is the same
4299 4304 of gnuplot data files.
4300 4305
4301 4306 2002-12-16 Fernando Perez <fperez@colorado.edu>
4302 4307
4303 4308 * IPython/iplib.py (InteractiveShell.interact): fixed default (y)
4304 4309 value of exit question to be acknowledged.
4305 4310
4306 4311 2002-12-03 Fernando Perez <fperez@colorado.edu>
4307 4312
4308 4313 * IPython/ipmaker.py: removed generators, which had been added
4309 4314 by mistake in an earlier debugging run. This was causing trouble
4310 4315 to users of python 2.1.x. Thanks to Abel Daniel <abli-AT-freemail.hu>
4311 4316 for pointing this out.
4312 4317
4313 4318 2002-11-17 Fernando Perez <fperez@colorado.edu>
4314 4319
4315 4320 * Manual: updated the Gnuplot section.
4316 4321
4317 4322 * IPython/GnuplotRuntime.py: refactored a lot all this code, with
4318 4323 a much better split of what goes in Runtime and what goes in
4319 4324 Interactive.
4320 4325
4321 4326 * IPython/ipmaker.py: fixed bug where import_fail_info wasn't
4322 4327 being imported from iplib.
4323 4328
4324 4329 * IPython/GnuplotInteractive.py (magic_gpc): renamed @gp to @gpc
4325 4330 for command-passing. Now the global Gnuplot instance is called
4326 4331 'gp' instead of 'g', which was really a far too fragile and
4327 4332 common name.
4328 4333
4329 4334 * IPython/Gnuplot2.py (eps_fix_bbox): added this to fix broken
4330 4335 bounding boxes generated by Gnuplot for square plots.
4331 4336
4332 4337 * IPython/genutils.py (popkey): new function added. I should
4333 4338 suggest this on c.l.py as a dict method, it seems useful.
4334 4339
4335 4340 * IPython/Gnuplot2.py (Gnuplot.plot): Overhauled plot and replot
4336 4341 to transparently handle PostScript generation. MUCH better than
4337 4342 the previous plot_eps/replot_eps (which I removed now). The code
4338 4343 is also fairly clean and well documented now (including
4339 4344 docstrings).
4340 4345
4341 4346 2002-11-13 Fernando Perez <fperez@colorado.edu>
4342 4347
4343 4348 * IPython/Magic.py (Magic.magic_edit): fixed docstring
4344 4349 (inconsistent with options).
4345 4350
4346 4351 * IPython/Gnuplot2.py (Gnuplot.hardcopy): hardcopy had been
4347 4352 manually disabled, I don't know why. Fixed it.
4348 4353 (Gnuplot._plot_eps): added new plot_eps/replot_eps to get directly
4349 4354 eps output.
4350 4355
4351 4356 2002-11-12 Fernando Perez <fperez@colorado.edu>
4352 4357
4353 4358 * IPython/genutils.py (ask_yes_no): trap EOF and ^C so that they
4354 4359 don't propagate up to caller. Fixes crash reported by François
4355 4360 Pinard.
4356 4361
4357 4362 2002-11-09 Fernando Perez <fperez@colorado.edu>
4358 4363
4359 4364 * IPython/ipmaker.py (make_IPython): fixed problem with writing
4360 4365 history file for new users.
4361 4366 (make_IPython): fixed bug where initial install would leave the
4362 4367 user running in the .ipython dir.
4363 4368 (make_IPython): fixed bug where config dir .ipython would be
4364 4369 created regardless of the given -ipythondir option. Thanks to Cory
4365 4370 Dodt <cdodt-AT-fcoe.k12.ca.us> for the bug report.
4366 4371
4367 4372 * IPython/genutils.py (ask_yes_no): new function for asking yes/no
4368 4373 type confirmations. Will need to use it in all of IPython's code
4369 4374 consistently.
4370 4375
4371 4376 * IPython/CrashHandler.py (CrashHandler.__call__): changed the
4372 4377 context to print 31 lines instead of the default 5. This will make
4373 4378 the crash reports extremely detailed in case the problem is in
4374 4379 libraries I don't have access to.
4375 4380
4376 4381 * IPython/iplib.py (InteractiveShell.interact): changed the 'last
4377 4382 line of defense' code to still crash, but giving users fair
4378 4383 warning. I don't want internal errors to go unreported: if there's
4379 4384 an internal problem, IPython should crash and generate a full
4380 4385 report.
4381 4386
4382 4387 2002-11-08 Fernando Perez <fperez@colorado.edu>
4383 4388
4384 4389 * IPython/iplib.py (InteractiveShell.interact): added code to trap
4385 4390 otherwise uncaught exceptions which can appear if people set
4386 4391 sys.stdout to something badly broken. Thanks to a crash report
4387 4392 from henni-AT-mail.brainbot.com.
4388 4393
4389 4394 2002-11-04 Fernando Perez <fperez@colorado.edu>
4390 4395
4391 4396 * IPython/iplib.py (InteractiveShell.interact): added
4392 4397 __IPYTHON__active to the builtins. It's a flag which goes on when
4393 4398 the interaction starts and goes off again when it stops. This
4394 4399 allows embedding code to detect being inside IPython. Before this
4395 4400 was done via __IPYTHON__, but that only shows that an IPython
4396 4401 instance has been created.
4397 4402
4398 4403 * IPython/Magic.py (Magic.magic_env): I realized that in a
4399 4404 UserDict, instance.data holds the data as a normal dict. So I
4400 4405 modified @env to return os.environ.data instead of rebuilding a
4401 4406 dict by hand.
4402 4407
4403 4408 2002-11-02 Fernando Perez <fperez@colorado.edu>
4404 4409
4405 4410 * IPython/genutils.py (warn): changed so that level 1 prints no
4406 4411 header. Level 2 is now the default (with 'WARNING' header, as
4407 4412 before). I think I tracked all places where changes were needed in
4408 4413 IPython, but outside code using the old level numbering may have
4409 4414 broken.
4410 4415
4411 4416 * IPython/iplib.py (InteractiveShell.runcode): added this to
4412 4417 handle the tracebacks in SystemExit traps correctly. The previous
4413 4418 code (through interact) was printing more of the stack than
4414 4419 necessary, showing IPython internal code to the user.
4415 4420
4416 4421 * IPython/UserConfig/ipythonrc.py: Made confirm_exit 1 by
4417 4422 default. Now that the default at the confirmation prompt is yes,
4418 4423 it's not so intrusive. François' argument that ipython sessions
4419 4424 tend to be complex enough not to lose them from an accidental C-d,
4420 4425 is a valid one.
4421 4426
4422 4427 * IPython/iplib.py (InteractiveShell.interact): added a
4423 4428 showtraceback() call to the SystemExit trap, and modified the exit
4424 4429 confirmation to have yes as the default.
4425 4430
4426 4431 * IPython/UserConfig/ipythonrc.py: removed 'session' option from
4427 4432 this file. It's been gone from the code for a long time, this was
4428 4433 simply leftover junk.
4429 4434
4430 4435 2002-11-01 Fernando Perez <fperez@colorado.edu>
4431 4436
4432 4437 * IPython/UserConfig/ipythonrc.py: new confirm_exit option
4433 4438 added. If set, IPython now traps EOF and asks for
4434 4439 confirmation. After a request by François Pinard.
4435 4440
4436 4441 * IPython/Magic.py (Magic.magic_Exit): New @Exit and @Quit instead
4437 4442 of @abort, and with a new (better) mechanism for handling the
4438 4443 exceptions.
4439 4444
4440 4445 2002-10-27 Fernando Perez <fperez@colorado.edu>
4441 4446
4442 4447 * IPython/usage.py (__doc__): updated the --help information and
4443 4448 the ipythonrc file to indicate that -log generates
4444 4449 ./ipython.log. Also fixed the corresponding info in @logstart.
4445 4450 This and several other fixes in the manuals thanks to reports by
4446 4451 François Pinard <pinard-AT-iro.umontreal.ca>.
4447 4452
4448 4453 * IPython/Logger.py (Logger.switch_log): Fixed error message to
4449 4454 refer to @logstart (instead of @log, which doesn't exist).
4450 4455
4451 4456 * IPython/iplib.py (InteractiveShell._prefilter): fixed
4452 4457 AttributeError crash. Thanks to Christopher Armstrong
4453 4458 <radix-AT-twistedmatrix.com> for the report/fix. This bug had been
4454 4459 introduced recently (in 0.2.14pre37) with the fix to the eval
4455 4460 problem mentioned below.
4456 4461
4457 4462 2002-10-17 Fernando Perez <fperez@colorado.edu>
4458 4463
4459 4464 * IPython/ConfigLoader.py (ConfigLoader.load): Fixes for Windows
4460 4465 installation. Thanks to Leonardo Santagada <retype-AT-terra.com.br>.
4461 4466
4462 4467 * IPython/iplib.py (InteractiveShell._prefilter): Many changes to
4463 4468 this function to fix a problem reported by Alex Schmolck. He saw
4464 4469 it with list comprehensions and generators, which were getting
4465 4470 called twice. The real problem was an 'eval' call in testing for
4466 4471 automagic which was evaluating the input line silently.
4467 4472
4468 4473 This is a potentially very nasty bug, if the input has side
4469 4474 effects which must not be repeated. The code is much cleaner now,
4470 4475 without any blanket 'except' left and with a regexp test for
4471 4476 actual function names.
4472 4477
4473 4478 But an eval remains, which I'm not fully comfortable with. I just
4474 4479 don't know how to find out if an expression could be a callable in
4475 4480 the user's namespace without doing an eval on the string. However
4476 4481 that string is now much more strictly checked so that no code
4477 4482 slips by, so the eval should only happen for things that can
4478 4483 really be only function/method names.
4479 4484
4480 4485 2002-10-15 Fernando Perez <fperez@colorado.edu>
4481 4486
4482 4487 * Updated LyX to 1.2.1 so I can work on the docs again. Added Mac
4483 4488 OSX information to main manual, removed README_Mac_OSX file from
4484 4489 distribution. Also updated credits for recent additions.
4485 4490
4486 4491 2002-10-10 Fernando Perez <fperez@colorado.edu>
4487 4492
4488 4493 * README_Mac_OSX: Added a README for Mac OSX users for fixing
4489 4494 terminal-related issues. Many thanks to Andrea Riciputi
4490 4495 <andrea.riciputi-AT-libero.it> for writing it.
4491 4496
4492 4497 * IPython/UserConfig/ipythonrc.py: Fixes to various small issues,
4493 4498 thanks to Thorsten Kampe <thorsten-AT-thorstenkampe.de>.
4494 4499
4495 4500 * setup.py (make_shortcut): Fixes for Windows installation. Thanks
4496 4501 to Fredrik Kant <fredrik.kant-AT-front.com> and Syver Enstad
4497 4502 <syver-en-AT-online.no> who both submitted patches for this problem.
4498 4503
4499 4504 * IPython/iplib.py (InteractiveShell.embed_mainloop): Patch for
4500 4505 global embedding to make sure that things don't overwrite user
4501 4506 globals accidentally. Thanks to Richard <rxe-AT-renre-europe.com>
4502 4507
4503 4508 * IPython/Gnuplot2.py (gp): Patch for Gnuplot.py 1.6
4504 4509 compatibility. Thanks to Hayden Callow
4505 4510 <h.callow-AT-elec.canterbury.ac.nz>
4506 4511
4507 4512 2002-10-04 Fernando Perez <fperez@colorado.edu>
4508 4513
4509 4514 * IPython/Gnuplot2.py (PlotItem): Added 'index' option for
4510 4515 Gnuplot.File objects.
4511 4516
4512 4517 2002-07-23 Fernando Perez <fperez@colorado.edu>
4513 4518
4514 4519 * IPython/genutils.py (timing): Added timings() and timing() for
4515 4520 quick access to the most commonly needed data, the execution
4516 4521 times. Old timing() renamed to timings_out().
4517 4522
4518 4523 2002-07-18 Fernando Perez <fperez@colorado.edu>
4519 4524
4520 4525 * IPython/Shell.py (IPShellEmbed.restore_system_completer): fixed
4521 4526 bug with nested instances disrupting the parent's tab completion.
4522 4527
4523 4528 * IPython/iplib.py (all_completions): Added Alex Schmolck's
4524 4529 all_completions code to begin the emacs integration.
4525 4530
4526 4531 * IPython/Gnuplot2.py (zip_items): Added optional 'titles'
4527 4532 argument to allow titling individual arrays when plotting.
4528 4533
4529 4534 2002-07-15 Fernando Perez <fperez@colorado.edu>
4530 4535
4531 4536 * setup.py (make_shortcut): changed to retrieve the value of
4532 4537 'Program Files' directory from the registry (this value changes in
4533 4538 non-english versions of Windows). Thanks to Thomas Fanslau
4534 4539 <tfanslau-AT-gmx.de> for the report.
4535 4540
4536 4541 2002-07-10 Fernando Perez <fperez@colorado.edu>
4537 4542
4538 4543 * IPython/ultraTB.py (VerboseTB.debugger): enabled workaround for
4539 4544 a bug in pdb, which crashes if a line with only whitespace is
4540 4545 entered. Bug report submitted to sourceforge.
4541 4546
4542 4547 2002-07-09 Fernando Perez <fperez@colorado.edu>
4543 4548
4544 4549 * IPython/ultraTB.py (VerboseTB.nullrepr): fixed rare crash when
4545 4550 reporting exceptions (it's a bug in inspect.py, I just set a
4546 4551 workaround).
4547 4552
4548 4553 2002-07-08 Fernando Perez <fperez@colorado.edu>
4549 4554
4550 4555 * IPython/iplib.py (InteractiveShell.__init__): fixed reference to
4551 4556 __IPYTHON__ in __builtins__ to show up in user_ns.
4552 4557
4553 4558 2002-07-03 Fernando Perez <fperez@colorado.edu>
4554 4559
4555 4560 * IPython/GnuplotInteractive.py (magic_gp_set_default): changed
4556 4561 name from @gp_set_instance to @gp_set_default.
4557 4562
4558 4563 * IPython/ipmaker.py (make_IPython): default editor value set to
4559 4564 '0' (a string), to match the rc file. Otherwise will crash when
4560 4565 .strip() is called on it.
4561 4566
4562 4567
4563 4568 2002-06-28 Fernando Perez <fperez@colorado.edu>
4564 4569
4565 4570 * IPython/iplib.py (InteractiveShell.safe_execfile): fix importing
4566 4571 of files in current directory when a file is executed via
4567 4572 @run. Patch also by RA <ralf_ahlbrink-AT-web.de>.
4568 4573
4569 4574 * setup.py (manfiles): fix for rpm builds, submitted by RA
4570 4575 <ralf_ahlbrink-AT-web.de>. Now we have RPMs!
4571 4576
4572 4577 * IPython/ipmaker.py (make_IPython): fixed lookup of default
4573 4578 editor when set to '0'. Problem was, '0' evaluates to True (it's a
4574 4579 string!). A. Schmolck caught this one.
4575 4580
4576 4581 2002-06-27 Fernando Perez <fperez@colorado.edu>
4577 4582
4578 4583 * IPython/ipmaker.py (make_IPython): fixed bug when running user
4579 4584 defined files at the cmd line. __name__ wasn't being set to
4580 4585 __main__.
4581 4586
4582 4587 * IPython/Gnuplot2.py (zip_items): improved it so it can plot also
4583 4588 regular lists and tuples besides Numeric arrays.
4584 4589
4585 4590 * IPython/Prompts.py (CachedOutput.__call__): Added output
4586 4591 supression for input ending with ';'. Similar to Mathematica and
4587 4592 Matlab. The _* vars and Out[] list are still updated, just like
4588 4593 Mathematica behaves.
4589 4594
4590 4595 2002-06-25 Fernando Perez <fperez@colorado.edu>
4591 4596
4592 4597 * IPython/ConfigLoader.py (ConfigLoader.load): fixed checking of
4593 4598 .ini extensions for profiels under Windows.
4594 4599
4595 4600 * IPython/OInspect.py (Inspector.pinfo): improved alignment of
4596 4601 string form. Fix contributed by Alexander Schmolck
4597 4602 <a.schmolck-AT-gmx.net>
4598 4603
4599 4604 * IPython/GnuplotRuntime.py (gp_new): new function. Returns a
4600 4605 pre-configured Gnuplot instance.
4601 4606
4602 4607 2002-06-21 Fernando Perez <fperez@colorado.edu>
4603 4608
4604 4609 * IPython/numutils.py (exp_safe): new function, works around the
4605 4610 underflow problems in Numeric.
4606 4611 (log2): New fn. Safe log in base 2: returns exact integer answer
4607 4612 for exact integer powers of 2.
4608 4613
4609 4614 * IPython/Magic.py (get_py_filename): fixed it not expanding '~'
4610 4615 properly.
4611 4616
4612 4617 2002-06-20 Fernando Perez <fperez@colorado.edu>
4613 4618
4614 4619 * IPython/genutils.py (timing): new function like
4615 4620 Mathematica's. Similar to time_test, but returns more info.
4616 4621
4617 4622 2002-06-18 Fernando Perez <fperez@colorado.edu>
4618 4623
4619 4624 * IPython/Magic.py (Magic.magic_save): modified @save and @r
4620 4625 according to Mike Heeter's suggestions.
4621 4626
4622 4627 2002-06-16 Fernando Perez <fperez@colorado.edu>
4623 4628
4624 4629 * IPython/GnuplotRuntime.py: Massive overhaul to the Gnuplot
4625 4630 system. GnuplotMagic is gone as a user-directory option. New files
4626 4631 make it easier to use all the gnuplot stuff both from external
4627 4632 programs as well as from IPython. Had to rewrite part of
4628 4633 hardcopy() b/c of a strange bug: often the ps files simply don't
4629 4634 get created, and require a repeat of the command (often several
4630 4635 times).
4631 4636
4632 4637 * IPython/ultraTB.py (AutoFormattedTB.__call__): changed to
4633 4638 resolve output channel at call time, so that if sys.stderr has
4634 4639 been redirected by user this gets honored.
4635 4640
4636 4641 2002-06-13 Fernando Perez <fperez@colorado.edu>
4637 4642
4638 4643 * IPython/Shell.py (IPShell.__init__): Changed IPythonShell to
4639 4644 IPShell. Kept a copy with the old names to avoid breaking people's
4640 4645 embedded code.
4641 4646
4642 4647 * IPython/ipython: simplified it to the bare minimum after
4643 4648 Holger's suggestions. Added info about how to use it in
4644 4649 PYTHONSTARTUP.
4645 4650
4646 4651 * IPython/Shell.py (IPythonShell): changed the options passing
4647 4652 from a string with funky %s replacements to a straight list. Maybe
4648 4653 a bit more typing, but it follows sys.argv conventions, so there's
4649 4654 less special-casing to remember.
4650 4655
4651 4656 2002-06-12 Fernando Perez <fperez@colorado.edu>
4652 4657
4653 4658 * IPython/Magic.py (Magic.magic_r): new magic auto-repeat
4654 4659 command. Thanks to a suggestion by Mike Heeter.
4655 4660 (Magic.magic_pfile): added behavior to look at filenames if given
4656 4661 arg is not a defined object.
4657 4662 (Magic.magic_save): New @save function to save code snippets. Also
4658 4663 a Mike Heeter idea.
4659 4664
4660 4665 * IPython/UserConfig/GnuplotMagic.py (plot): Improvements to
4661 4666 plot() and replot(). Much more convenient now, especially for
4662 4667 interactive use.
4663 4668
4664 4669 * IPython/Magic.py (Magic.magic_run): Added .py automatically to
4665 4670 filenames.
4666 4671
4667 4672 2002-06-02 Fernando Perez <fperez@colorado.edu>
4668 4673
4669 4674 * IPython/Struct.py (Struct.__init__): modified to admit
4670 4675 initialization via another struct.
4671 4676
4672 4677 * IPython/genutils.py (SystemExec.__init__): New stateful
4673 4678 interface to xsys and bq. Useful for writing system scripts.
4674 4679
4675 4680 2002-05-30 Fernando Perez <fperez@colorado.edu>
4676 4681
4677 4682 * MANIFEST.in: Changed docfile selection to exclude all the lyx
4678 4683 documents. This will make the user download smaller (it's getting
4679 4684 too big).
4680 4685
4681 4686 2002-05-29 Fernando Perez <fperez@colorado.edu>
4682 4687
4683 4688 * IPython/iplib.py (_FakeModule.__init__): New class introduced to
4684 4689 fix problems with shelve and pickle. Seems to work, but I don't
4685 4690 know if corner cases break it. Thanks to Mike Heeter
4686 4691 <korora-AT-SDF.LONESTAR.ORG> for the bug reports and test cases.
4687 4692
4688 4693 2002-05-24 Fernando Perez <fperez@colorado.edu>
4689 4694
4690 4695 * IPython/Magic.py (Macro.__init__): fixed magics embedded in
4691 4696 macros having broken.
4692 4697
4693 4698 2002-05-21 Fernando Perez <fperez@colorado.edu>
4694 4699
4695 4700 * IPython/Magic.py (Magic.magic_logstart): fixed recently
4696 4701 introduced logging bug: all history before logging started was
4697 4702 being written one character per line! This came from the redesign
4698 4703 of the input history as a special list which slices to strings,
4699 4704 not to lists.
4700 4705
4701 4706 2002-05-20 Fernando Perez <fperez@colorado.edu>
4702 4707
4703 4708 * IPython/Prompts.py (CachedOutput.__init__): made the color table
4704 4709 be an attribute of all classes in this module. The design of these
4705 4710 classes needs some serious overhauling.
4706 4711
4707 4712 * IPython/DPyGetOpt.py (DPyGetOpt.setPosixCompliance): fixed bug
4708 4713 which was ignoring '_' in option names.
4709 4714
4710 4715 * IPython/ultraTB.py (FormattedTB.__init__): Changed
4711 4716 'Verbose_novars' to 'Context' and made it the new default. It's a
4712 4717 bit more readable and also safer than verbose.
4713 4718
4714 4719 * IPython/PyColorize.py (Parser.__call__): Fixed coloring of
4715 4720 triple-quoted strings.
4716 4721
4717 4722 * IPython/OInspect.py (__all__): new module exposing the object
4718 4723 introspection facilities. Now the corresponding magics are dummy
4719 4724 wrappers around this. Having this module will make it much easier
4720 4725 to put these functions into our modified pdb.
4721 4726 This new object inspector system uses the new colorizing module,
4722 4727 so source code and other things are nicely syntax highlighted.
4723 4728
4724 4729 2002-05-18 Fernando Perez <fperez@colorado.edu>
4725 4730
4726 4731 * IPython/ColorANSI.py: Split the coloring tools into a separate
4727 4732 module so I can use them in other code easier (they were part of
4728 4733 ultraTB).
4729 4734
4730 4735 2002-05-17 Fernando Perez <fperez@colorado.edu>
4731 4736
4732 4737 * IPython/UserConfig/GnuplotMagic.py (magic_gp_set_instance):
4733 4738 fixed it to set the global 'g' also to the called instance, as
4734 4739 long as 'g' was still a gnuplot instance (so it doesn't overwrite
4735 4740 user's 'g' variables).
4736 4741
4737 4742 * IPython/iplib.py (InteractiveShell.__init__): Added In/Out
4738 4743 global variables (aliases to _ih,_oh) so that users which expect
4739 4744 In[5] or Out[7] to work aren't unpleasantly surprised.
4740 4745 (InputList.__getslice__): new class to allow executing slices of
4741 4746 input history directly. Very simple class, complements the use of
4742 4747 macros.
4743 4748
4744 4749 2002-05-16 Fernando Perez <fperez@colorado.edu>
4745 4750
4746 4751 * setup.py (docdirbase): make doc directory be just doc/IPython
4747 4752 without version numbers, it will reduce clutter for users.
4748 4753
4749 4754 * IPython/Magic.py (Magic.magic_run): Add explicit local dict to
4750 4755 execfile call to prevent possible memory leak. See for details:
4751 4756 http://mail.python.org/pipermail/python-list/2002-February/088476.html
4752 4757
4753 4758 2002-05-15 Fernando Perez <fperez@colorado.edu>
4754 4759
4755 4760 * IPython/Magic.py (Magic.magic_psource): made the object
4756 4761 introspection names be more standard: pdoc, pdef, pfile and
4757 4762 psource. They all print/page their output, and it makes
4758 4763 remembering them easier. Kept old names for compatibility as
4759 4764 aliases.
4760 4765
4761 4766 2002-05-14 Fernando Perez <fperez@colorado.edu>
4762 4767
4763 4768 * IPython/UserConfig/GnuplotMagic.py: I think I finally understood
4764 4769 what the mouse problem was. The trick is to use gnuplot with temp
4765 4770 files and NOT with pipes (for data communication), because having
4766 4771 both pipes and the mouse on is bad news.
4767 4772
4768 4773 2002-05-13 Fernando Perez <fperez@colorado.edu>
4769 4774
4770 4775 * IPython/Magic.py (Magic._ofind): fixed namespace order search
4771 4776 bug. Information would be reported about builtins even when
4772 4777 user-defined functions overrode them.
4773 4778
4774 4779 2002-05-11 Fernando Perez <fperez@colorado.edu>
4775 4780
4776 4781 * IPython/__init__.py (__all__): removed FlexCompleter from
4777 4782 __all__ so that things don't fail in platforms without readline.
4778 4783
4779 4784 2002-05-10 Fernando Perez <fperez@colorado.edu>
4780 4785
4781 4786 * IPython/__init__.py (__all__): removed numutils from __all__ b/c
4782 4787 it requires Numeric, effectively making Numeric a dependency for
4783 4788 IPython.
4784 4789
4785 4790 * Released 0.2.13
4786 4791
4787 4792 * IPython/Magic.py (Magic.magic_prun): big overhaul to the
4788 4793 profiler interface. Now all the major options from the profiler
4789 4794 module are directly supported in IPython, both for single
4790 4795 expressions (@prun) and for full programs (@run -p).
4791 4796
4792 4797 2002-05-09 Fernando Perez <fperez@colorado.edu>
4793 4798
4794 4799 * IPython/Magic.py (Magic.magic_doc): fixed to show docstrings of
4795 4800 magic properly formatted for screen.
4796 4801
4797 4802 * setup.py (make_shortcut): Changed things to put pdf version in
4798 4803 doc/ instead of doc/manual (had to change lyxport a bit).
4799 4804
4800 4805 * IPython/Magic.py (Profile.string_stats): made profile runs go
4801 4806 through pager (they are long and a pager allows searching, saving,
4802 4807 etc.)
4803 4808
4804 4809 2002-05-08 Fernando Perez <fperez@colorado.edu>
4805 4810
4806 4811 * Released 0.2.12
4807 4812
4808 4813 2002-05-06 Fernando Perez <fperez@colorado.edu>
4809 4814
4810 4815 * IPython/Magic.py (Magic.magic_hist): small bug fixed (recently
4811 4816 introduced); 'hist n1 n2' was broken.
4812 4817 (Magic.magic_pdb): added optional on/off arguments to @pdb
4813 4818 (Magic.magic_run): added option -i to @run, which executes code in
4814 4819 the IPython namespace instead of a clean one. Also added @irun as
4815 4820 an alias to @run -i.
4816 4821
4817 4822 * IPython/UserConfig/GnuplotMagic.py (magic_gp_set_instance):
4818 4823 fixed (it didn't really do anything, the namespaces were wrong).
4819 4824
4820 4825 * IPython/Debugger.py (__init__): Added workaround for python 2.1
4821 4826
4822 4827 * IPython/__init__.py (__all__): Fixed package namespace, now
4823 4828 'import IPython' does give access to IPython.<all> as
4824 4829 expected. Also renamed __release__ to Release.
4825 4830
4826 4831 * IPython/Debugger.py (__license__): created new Pdb class which
4827 4832 functions like a drop-in for the normal pdb.Pdb but does NOT
4828 4833 import readline by default. This way it doesn't muck up IPython's
4829 4834 readline handling, and now tab-completion finally works in the
4830 4835 debugger -- sort of. It completes things globally visible, but the
4831 4836 completer doesn't track the stack as pdb walks it. That's a bit
4832 4837 tricky, and I'll have to implement it later.
4833 4838
4834 4839 2002-05-05 Fernando Perez <fperez@colorado.edu>
4835 4840
4836 4841 * IPython/Magic.py (Magic.magic_oinfo): fixed formatting bug for
4837 4842 magic docstrings when printed via ? (explicit \'s were being
4838 4843 printed).
4839 4844
4840 4845 * IPython/ipmaker.py (make_IPython): fixed namespace
4841 4846 identification bug. Now variables loaded via logs or command-line
4842 4847 files are recognized in the interactive namespace by @who.
4843 4848
4844 4849 * IPython/iplib.py (InteractiveShell.safe_execfile): Fixed bug in
4845 4850 log replay system stemming from the string form of Structs.
4846 4851
4847 4852 * IPython/Magic.py (Macro.__init__): improved macros to properly
4848 4853 handle magic commands in them.
4849 4854 (Magic.magic_logstart): usernames are now expanded so 'logstart
4850 4855 ~/mylog' now works.
4851 4856
4852 4857 * IPython/iplib.py (complete): fixed bug where paths starting with
4853 4858 '/' would be completed as magic names.
4854 4859
4855 4860 2002-05-04 Fernando Perez <fperez@colorado.edu>
4856 4861
4857 4862 * IPython/Magic.py (Magic.magic_run): added options -p and -f to
4858 4863 allow running full programs under the profiler's control.
4859 4864
4860 4865 * IPython/ultraTB.py (FormattedTB.__init__): Added Verbose_novars
4861 4866 mode to report exceptions verbosely but without formatting
4862 4867 variables. This addresses the issue of ipython 'freezing' (it's
4863 4868 not frozen, but caught in an expensive formatting loop) when huge
4864 4869 variables are in the context of an exception.
4865 4870 (VerboseTB.text): Added '--->' markers at line where exception was
4866 4871 triggered. Much clearer to read, especially in NoColor modes.
4867 4872
4868 4873 * IPython/Magic.py (Magic.magic_run): bugfix: -n option had been
4869 4874 implemented in reverse when changing to the new parse_options().
4870 4875
4871 4876 2002-05-03 Fernando Perez <fperez@colorado.edu>
4872 4877
4873 4878 * IPython/Magic.py (Magic.parse_options): new function so that
4874 4879 magics can parse options easier.
4875 4880 (Magic.magic_prun): new function similar to profile.run(),
4876 4881 suggested by Chris Hart.
4877 4882 (Magic.magic_cd): fixed behavior so that it only changes if
4878 4883 directory actually is in history.
4879 4884
4880 4885 * IPython/usage.py (__doc__): added information about potential
4881 4886 slowness of Verbose exception mode when there are huge data
4882 4887 structures to be formatted (thanks to Archie Paulson).
4883 4888
4884 4889 * IPython/ipmaker.py (make_IPython): Changed default logging
4885 4890 (when simply called with -log) to use curr_dir/ipython.log in
4886 4891 rotate mode. Fixed crash which was occuring with -log before
4887 4892 (thanks to Jim Boyle).
4888 4893
4889 4894 2002-05-01 Fernando Perez <fperez@colorado.edu>
4890 4895
4891 4896 * Released 0.2.11 for these fixes (mainly the ultraTB one which
4892 4897 was nasty -- though somewhat of a corner case).
4893 4898
4894 4899 * IPython/ultraTB.py (AutoFormattedTB.text): renamed __text to
4895 4900 text (was a bug).
4896 4901
4897 4902 2002-04-30 Fernando Perez <fperez@colorado.edu>
4898 4903
4899 4904 * IPython/UserConfig/GnuplotMagic.py (magic_gp): Minor fix to add
4900 4905 a print after ^D or ^C from the user so that the In[] prompt
4901 4906 doesn't over-run the gnuplot one.
4902 4907
4903 4908 2002-04-29 Fernando Perez <fperez@colorado.edu>
4904 4909
4905 4910 * Released 0.2.10
4906 4911
4907 4912 * IPython/__release__.py (version): get date dynamically.
4908 4913
4909 4914 * Misc. documentation updates thanks to Arnd's comments. Also ran
4910 4915 a full spellcheck on the manual (hadn't been done in a while).
4911 4916
4912 4917 2002-04-27 Fernando Perez <fperez@colorado.edu>
4913 4918
4914 4919 * IPython/Magic.py (Magic.magic_logstart): Fixed bug where
4915 4920 starting a log in mid-session would reset the input history list.
4916 4921
4917 4922 2002-04-26 Fernando Perez <fperez@colorado.edu>
4918 4923
4919 4924 * IPython/iplib.py (InteractiveShell.wait): Fixed bug where not
4920 4925 all files were being included in an update. Now anything in
4921 4926 UserConfig that matches [A-Za-z]*.py will go (this excludes
4922 4927 __init__.py)
4923 4928
4924 4929 2002-04-25 Fernando Perez <fperez@colorado.edu>
4925 4930
4926 4931 * IPython/iplib.py (InteractiveShell.__init__): Added __IPYTHON__
4927 4932 to __builtins__ so that any form of embedded or imported code can
4928 4933 test for being inside IPython.
4929 4934
4930 4935 * IPython/UserConfig/GnuplotMagic.py: (magic_gp_set_instance):
4931 4936 changed to GnuplotMagic because it's now an importable module,
4932 4937 this makes the name follow that of the standard Gnuplot module.
4933 4938 GnuplotMagic can now be loaded at any time in mid-session.
4934 4939
4935 4940 2002-04-24 Fernando Perez <fperez@colorado.edu>
4936 4941
4937 4942 * IPython/numutils.py: removed SIUnits. It doesn't properly set
4938 4943 the globals (IPython has its own namespace) and the
4939 4944 PhysicalQuantity stuff is much better anyway.
4940 4945
4941 4946 * IPython/UserConfig/example-gnuplot.py (g2): Added gnuplot
4942 4947 embedding example to standard user directory for
4943 4948 distribution. Also put it in the manual.
4944 4949
4945 4950 * IPython/numutils.py (gnuplot_exec): Changed to take a gnuplot
4946 4951 instance as first argument (so it doesn't rely on some obscure
4947 4952 hidden global).
4948 4953
4949 4954 * IPython/UserConfig/ipythonrc.py: put () back in accepted
4950 4955 delimiters. While it prevents ().TAB from working, it allows
4951 4956 completions in open (... expressions. This is by far a more common
4952 4957 case.
4953 4958
4954 4959 2002-04-23 Fernando Perez <fperez@colorado.edu>
4955 4960
4956 4961 * IPython/Extensions/InterpreterPasteInput.py: new
4957 4962 syntax-processing module for pasting lines with >>> or ... at the
4958 4963 start.
4959 4964
4960 4965 * IPython/Extensions/PhysicalQ_Interactive.py
4961 4966 (PhysicalQuantityInteractive.__int__): fixed to work with either
4962 4967 Numeric or math.
4963 4968
4964 4969 * IPython/UserConfig/ipythonrc-numeric.py: reorganized the
4965 4970 provided profiles. Now we have:
4966 4971 -math -> math module as * and cmath with its own namespace.
4967 4972 -numeric -> Numeric as *, plus gnuplot & grace
4968 4973 -physics -> same as before
4969 4974
4970 4975 * IPython/Magic.py (Magic.magic_magic): Fixed bug where
4971 4976 user-defined magics wouldn't be found by @magic if they were
4972 4977 defined as class methods. Also cleaned up the namespace search
4973 4978 logic and the string building (to use %s instead of many repeated
4974 4979 string adds).
4975 4980
4976 4981 * IPython/UserConfig/example-magic.py (magic_foo): updated example
4977 4982 of user-defined magics to operate with class methods (cleaner, in
4978 4983 line with the gnuplot code).
4979 4984
4980 4985 2002-04-22 Fernando Perez <fperez@colorado.edu>
4981 4986
4982 4987 * setup.py: updated dependency list so that manual is updated when
4983 4988 all included files change.
4984 4989
4985 4990 * IPython/ipmaker.py (make_IPython): Fixed bug which was ignoring
4986 4991 the delimiter removal option (the fix is ugly right now).
4987 4992
4988 4993 * IPython/UserConfig/ipythonrc-physics.py: simplified not to load
4989 4994 all of the math profile (quicker loading, no conflict between
4990 4995 g-9.8 and g-gnuplot).
4991 4996
4992 4997 * IPython/CrashHandler.py (CrashHandler.__call__): changed default
4993 4998 name of post-mortem files to IPython_crash_report.txt.
4994 4999
4995 5000 * Cleanup/update of the docs. Added all the new readline info and
4996 5001 formatted all lists as 'real lists'.
4997 5002
4998 5003 * IPython/ipmaker.py (make_IPython): removed now-obsolete
4999 5004 tab-completion options, since the full readline parse_and_bind is
5000 5005 now accessible.
5001 5006
5002 5007 * IPython/iplib.py (InteractiveShell.init_readline): Changed
5003 5008 handling of readline options. Now users can specify any string to
5004 5009 be passed to parse_and_bind(), as well as the delimiters to be
5005 5010 removed.
5006 5011 (InteractiveShell.__init__): Added __name__ to the global
5007 5012 namespace so that things like Itpl which rely on its existence
5008 5013 don't crash.
5009 5014 (InteractiveShell._prefilter): Defined the default with a _ so
5010 5015 that prefilter() is easier to override, while the default one
5011 5016 remains available.
5012 5017
5013 5018 2002-04-18 Fernando Perez <fperez@colorado.edu>
5014 5019
5015 5020 * Added information about pdb in the docs.
5016 5021
5017 5022 2002-04-17 Fernando Perez <fperez@colorado.edu>
5018 5023
5019 5024 * IPython/ipmaker.py (make_IPython): added rc_override option to
5020 5025 allow passing config options at creation time which may override
5021 5026 anything set in the config files or command line. This is
5022 5027 particularly useful for configuring embedded instances.
5023 5028
5024 5029 2002-04-15 Fernando Perez <fperez@colorado.edu>
5025 5030
5026 5031 * IPython/Logger.py (Logger.log): Fixed a nasty bug which could
5027 5032 crash embedded instances because of the input cache falling out of
5028 5033 sync with the output counter.
5029 5034
5030 5035 * IPython/Shell.py (IPythonShellEmbed.__init__): added a debug
5031 5036 mode which calls pdb after an uncaught exception in IPython itself.
5032 5037
5033 5038 2002-04-14 Fernando Perez <fperez@colorado.edu>
5034 5039
5035 5040 * IPython/iplib.py (InteractiveShell.showtraceback): pdb mucks up
5036 5041 readline, fix it back after each call.
5037 5042
5038 5043 * IPython/ultraTB.py (AutoFormattedTB.__text): made text a private
5039 5044 method to force all access via __call__(), which guarantees that
5040 5045 traceback references are properly deleted.
5041 5046
5042 5047 * IPython/Prompts.py (CachedOutput._display): minor fixes to
5043 5048 improve printing when pprint is in use.
5044 5049
5045 5050 2002-04-13 Fernando Perez <fperez@colorado.edu>
5046 5051
5047 5052 * IPython/Shell.py (IPythonShellEmbed.__call__): SystemExit
5048 5053 exceptions aren't caught anymore. If the user triggers one, he
5049 5054 should know why he's doing it and it should go all the way up,
5050 5055 just like any other exception. So now @abort will fully kill the
5051 5056 embedded interpreter and the embedding code (unless that happens
5052 5057 to catch SystemExit).
5053 5058
5054 5059 * IPython/ultraTB.py (VerboseTB.__init__): added a call_pdb flag
5055 5060 and a debugger() method to invoke the interactive pdb debugger
5056 5061 after printing exception information. Also added the corresponding
5057 5062 -pdb option and @pdb magic to control this feature, and updated
5058 5063 the docs. After a suggestion from Christopher Hart
5059 5064 (hart-AT-caltech.edu).
5060 5065
5061 5066 2002-04-12 Fernando Perez <fperez@colorado.edu>
5062 5067
5063 5068 * IPython/Shell.py (IPythonShellEmbed.__init__): modified to use
5064 5069 the exception handlers defined by the user (not the CrashHandler)
5065 5070 so that user exceptions don't trigger an ipython bug report.
5066 5071
5067 5072 * IPython/ultraTB.py (ColorTB.__init__): made the color scheme
5068 5073 configurable (it should have always been so).
5069 5074
5070 5075 2002-03-26 Fernando Perez <fperez@colorado.edu>
5071 5076
5072 5077 * IPython/Shell.py (IPythonShellEmbed.__call__): many changes here
5073 5078 and there to fix embedding namespace issues. This should all be
5074 5079 done in a more elegant way.
5075 5080
5076 5081 2002-03-25 Fernando Perez <fperez@colorado.edu>
5077 5082
5078 5083 * IPython/genutils.py (get_home_dir): Try to make it work under
5079 5084 win9x also.
5080 5085
5081 5086 2002-03-20 Fernando Perez <fperez@colorado.edu>
5082 5087
5083 5088 * IPython/Shell.py (IPythonShellEmbed.__init__): leave
5084 5089 sys.displayhook untouched upon __init__.
5085 5090
5086 5091 2002-03-19 Fernando Perez <fperez@colorado.edu>
5087 5092
5088 5093 * Released 0.2.9 (for embedding bug, basically).
5089 5094
5090 5095 * IPython/Shell.py (IPythonShellEmbed.__call__): Trap SystemExit
5091 5096 exceptions so that enclosing shell's state can be restored.
5092 5097
5093 5098 * Changed magic_gnuplot.py to magic-gnuplot.py to standardize
5094 5099 naming conventions in the .ipython/ dir.
5095 5100
5096 5101 * IPython/iplib.py (InteractiveShell.init_readline): removed '-'
5097 5102 from delimiters list so filenames with - in them get expanded.
5098 5103
5099 5104 * IPython/Shell.py (IPythonShellEmbed.__call__): fixed bug with
5100 5105 sys.displayhook not being properly restored after an embedded call.
5101 5106
5102 5107 2002-03-18 Fernando Perez <fperez@colorado.edu>
5103 5108
5104 5109 * Released 0.2.8
5105 5110
5106 5111 * IPython/iplib.py (InteractiveShell.user_setup): fixed bug where
5107 5112 some files weren't being included in a -upgrade.
5108 5113 (InteractiveShell.init_readline): Added 'set show-all-if-ambiguous
5109 5114 on' so that the first tab completes.
5110 5115 (InteractiveShell.handle_magic): fixed bug with spaces around
5111 5116 quotes breaking many magic commands.
5112 5117
5113 5118 * setup.py: added note about ignoring the syntax error messages at
5114 5119 installation.
5115 5120
5116 5121 * IPython/UserConfig/magic_gnuplot.py (magic_gp): finished
5117 5122 streamlining the gnuplot interface, now there's only one magic @gp.
5118 5123
5119 5124 2002-03-17 Fernando Perez <fperez@colorado.edu>
5120 5125
5121 5126 * IPython/UserConfig/magic_gnuplot.py: new name for the
5122 5127 example-magic_pm.py file. Much enhanced system, now with a shell
5123 5128 for communicating directly with gnuplot, one command at a time.
5124 5129
5125 5130 * IPython/Magic.py (Magic.magic_run): added option -n to prevent
5126 5131 setting __name__=='__main__'.
5127 5132
5128 5133 * IPython/UserConfig/example-magic_pm.py (magic_pm): Added
5129 5134 mini-shell for accessing gnuplot from inside ipython. Should
5130 5135 extend it later for grace access too. Inspired by Arnd's
5131 5136 suggestion.
5132 5137
5133 5138 * IPython/iplib.py (InteractiveShell.handle_magic): fixed bug when
5134 5139 calling magic functions with () in their arguments. Thanks to Arnd
5135 5140 Baecker for pointing this to me.
5136 5141
5137 5142 * IPython/numutils.py (sum_flat): fixed bug. Would recurse
5138 5143 infinitely for integer or complex arrays (only worked with floats).
5139 5144
5140 5145 2002-03-16 Fernando Perez <fperez@colorado.edu>
5141 5146
5142 5147 * setup.py: Merged setup and setup_windows into a single script
5143 5148 which properly handles things for windows users.
5144 5149
5145 5150 2002-03-15 Fernando Perez <fperez@colorado.edu>
5146 5151
5147 5152 * Big change to the manual: now the magics are all automatically
5148 5153 documented. This information is generated from their docstrings
5149 5154 and put in a latex file included by the manual lyx file. This way
5150 5155 we get always up to date information for the magics. The manual
5151 5156 now also has proper version information, also auto-synced.
5152 5157
5153 5158 For this to work, an undocumented --magic_docstrings option was added.
5154 5159
5155 5160 2002-03-13 Fernando Perez <fperez@colorado.edu>
5156 5161
5157 5162 * IPython/ultraTB.py (TermColors): fixed problem with dark colors
5158 5163 under CDE terminals. An explicit ;2 color reset is needed in the escapes.
5159 5164
5160 5165 2002-03-12 Fernando Perez <fperez@colorado.edu>
5161 5166
5162 5167 * IPython/ultraTB.py (TermColors): changed color escapes again to
5163 5168 fix the (old, reintroduced) line-wrapping bug. Basically, if
5164 5169 \001..\002 aren't given in the color escapes, lines get wrapped
5165 5170 weirdly. But giving those screws up old xterms and emacs terms. So
5166 5171 I added some logic for emacs terms to be ok, but I can't identify old
5167 5172 xterms separately ($TERM=='xterm' for many terminals, like konsole).
5168 5173
5169 5174 2002-03-10 Fernando Perez <fperez@colorado.edu>
5170 5175
5171 5176 * IPython/usage.py (__doc__): Various documentation cleanups and
5172 5177 updates, both in usage docstrings and in the manual.
5173 5178
5174 5179 * IPython/Prompts.py (CachedOutput.set_colors): cleanups for
5175 5180 handling of caching. Set minimum acceptabe value for having a
5176 5181 cache at 20 values.
5177 5182
5178 5183 * IPython/iplib.py (InteractiveShell.user_setup): moved the
5179 5184 install_first_time function to a method, renamed it and added an
5180 5185 'upgrade' mode. Now people can update their config directory with
5181 5186 a simple command line switch (-upgrade, also new).
5182 5187
5183 5188 * IPython/Magic.py (Magic.magic_pfile): Made @pfile an alias to
5184 5189 @file (convenient for automagic users under Python >= 2.2).
5185 5190 Removed @files (it seemed more like a plural than an abbrev. of
5186 5191 'file show').
5187 5192
5188 5193 * IPython/iplib.py (install_first_time): Fixed crash if there were
5189 5194 backup files ('~') in .ipython/ install directory.
5190 5195
5191 5196 * IPython/ipmaker.py (make_IPython): fixes for new prompt
5192 5197 system. Things look fine, but these changes are fairly
5193 5198 intrusive. Test them for a few days.
5194 5199
5195 5200 * IPython/Prompts.py (CachedOutput.__init__): Massive rewrite of
5196 5201 the prompts system. Now all in/out prompt strings are user
5197 5202 controllable. This is particularly useful for embedding, as one
5198 5203 can tag embedded instances with particular prompts.
5199 5204
5200 5205 Also removed global use of sys.ps1/2, which now allows nested
5201 5206 embeddings without any problems. Added command-line options for
5202 5207 the prompt strings.
5203 5208
5204 5209 2002-03-08 Fernando Perez <fperez@colorado.edu>
5205 5210
5206 5211 * IPython/UserConfig/example-embed-short.py (ipshell): added
5207 5212 example file with the bare minimum code for embedding.
5208 5213
5209 5214 * IPython/Shell.py (IPythonShellEmbed.set_dummy_mode): added
5210 5215 functionality for the embeddable shell to be activated/deactivated
5211 5216 either globally or at each call.
5212 5217
5213 5218 * IPython/Prompts.py (Prompt1.auto_rewrite): Fixes the problem of
5214 5219 rewriting the prompt with '--->' for auto-inputs with proper
5215 5220 coloring. Now the previous UGLY hack in handle_auto() is gone, and
5216 5221 this is handled by the prompts class itself, as it should.
5217 5222
5218 5223 2002-03-05 Fernando Perez <fperez@colorado.edu>
5219 5224
5220 5225 * IPython/Magic.py (Magic.magic_logstart): Changed @log to
5221 5226 @logstart to avoid name clashes with the math log function.
5222 5227
5223 5228 * Big updates to X/Emacs section of the manual.
5224 5229
5225 5230 * Removed ipython_emacs. Milan explained to me how to pass
5226 5231 arguments to ipython through Emacs. Some day I'm going to end up
5227 5232 learning some lisp...
5228 5233
5229 5234 2002-03-04 Fernando Perez <fperez@colorado.edu>
5230 5235
5231 5236 * IPython/ipython_emacs: Created script to be used as the
5232 5237 py-python-command Emacs variable so we can pass IPython
5233 5238 parameters. I can't figure out how to tell Emacs directly to pass
5234 5239 parameters to IPython, so a dummy shell script will do it.
5235 5240
5236 5241 Other enhancements made for things to work better under Emacs'
5237 5242 various types of terminals. Many thanks to Milan Zamazal
5238 5243 <pdm-AT-zamazal.org> for all the suggestions and pointers.
5239 5244
5240 5245 2002-03-01 Fernando Perez <fperez@colorado.edu>
5241 5246
5242 5247 * IPython/ipmaker.py (make_IPython): added a --readline! option so
5243 5248 that loading of readline is now optional. This gives better
5244 5249 control to emacs users.
5245 5250
5246 5251 * IPython/ultraTB.py (__date__): Modified color escape sequences
5247 5252 and now things work fine under xterm and in Emacs' term buffers
5248 5253 (though not shell ones). Well, in emacs you get colors, but all
5249 5254 seem to be 'light' colors (no difference between dark and light
5250 5255 ones). But the garbage chars are gone, and also in xterms. It
5251 5256 seems that now I'm using 'cleaner' ansi sequences.
5252 5257
5253 5258 2002-02-21 Fernando Perez <fperez@colorado.edu>
5254 5259
5255 5260 * Released 0.2.7 (mainly to publish the scoping fix).
5256 5261
5257 5262 * IPython/Logger.py (Logger.logstate): added. A corresponding
5258 5263 @logstate magic was created.
5259 5264
5260 5265 * IPython/Magic.py: fixed nested scoping problem under Python
5261 5266 2.1.x (automagic wasn't working).
5262 5267
5263 5268 2002-02-20 Fernando Perez <fperez@colorado.edu>
5264 5269
5265 5270 * Released 0.2.6.
5266 5271
5267 5272 * IPython/OutputTrap.py (OutputTrap.__init__): added a 'quiet'
5268 5273 option so that logs can come out without any headers at all.
5269 5274
5270 5275 * IPython/UserConfig/ipythonrc-scipy.py: created a profile for
5271 5276 SciPy.
5272 5277
5273 5278 * IPython/iplib.py (InteractiveShell.embed_mainloop): Changed so
5274 5279 that embedded IPython calls don't require vars() to be explicitly
5275 5280 passed. Now they are extracted from the caller's frame (code
5276 5281 snatched from Eric Jones' weave). Added better documentation to
5277 5282 the section on embedding and the example file.
5278 5283
5279 5284 * IPython/genutils.py (page): Changed so that under emacs, it just
5280 5285 prints the string. You can then page up and down in the emacs
5281 5286 buffer itself. This is how the builtin help() works.
5282 5287
5283 5288 * IPython/Prompts.py (CachedOutput.__call__): Fixed issue with
5284 5289 macro scoping: macros need to be executed in the user's namespace
5285 5290 to work as if they had been typed by the user.
5286 5291
5287 5292 * IPython/Magic.py (Magic.magic_macro): Changed macros so they
5288 5293 execute automatically (no need to type 'exec...'). They then
5289 5294 behave like 'true macros'. The printing system was also modified
5290 5295 for this to work.
5291 5296
5292 5297 2002-02-19 Fernando Perez <fperez@colorado.edu>
5293 5298
5294 5299 * IPython/genutils.py (page_file): new function for paging files
5295 5300 in an OS-independent way. Also necessary for file viewing to work
5296 5301 well inside Emacs buffers.
5297 5302 (page): Added checks for being in an emacs buffer.
5298 5303 (page): fixed bug for Windows ($TERM isn't set in Windows). Fixed
5299 5304 same bug in iplib.
5300 5305
5301 5306 2002-02-18 Fernando Perez <fperez@colorado.edu>
5302 5307
5303 5308 * IPython/iplib.py (InteractiveShell.init_readline): modified use
5304 5309 of readline so that IPython can work inside an Emacs buffer.
5305 5310
5306 5311 * IPython/ultraTB.py (AutoFormattedTB.__call__): some fixes to
5307 5312 method signatures (they weren't really bugs, but it looks cleaner
5308 5313 and keeps PyChecker happy).
5309 5314
5310 5315 * IPython/ipmaker.py (make_IPython): added hooks Struct to __IP
5311 5316 for implementing various user-defined hooks. Currently only
5312 5317 display is done.
5313 5318
5314 5319 * IPython/Prompts.py (CachedOutput._display): changed display
5315 5320 functions so that they can be dynamically changed by users easily.
5316 5321
5317 5322 * IPython/Extensions/numeric_formats.py (num_display): added an
5318 5323 extension for printing NumPy arrays in flexible manners. It
5319 5324 doesn't do anything yet, but all the structure is in
5320 5325 place. Ultimately the plan is to implement output format control
5321 5326 like in Octave.
5322 5327
5323 5328 * IPython/Magic.py (Magic.lsmagic): changed so that bound magic
5324 5329 methods are found at run-time by all the automatic machinery.
5325 5330
5326 5331 2002-02-17 Fernando Perez <fperez@colorado.edu>
5327 5332
5328 5333 * setup_Windows.py (make_shortcut): documented. Cleaned up the
5329 5334 whole file a little.
5330 5335
5331 5336 * ToDo: closed this document. Now there's a new_design.lyx
5332 5337 document for all new ideas. Added making a pdf of it for the
5333 5338 end-user distro.
5334 5339
5335 5340 * IPython/Logger.py (Logger.switch_log): Created this to replace
5336 5341 logon() and logoff(). It also fixes a nasty crash reported by
5337 5342 Philip Hisley <compsys-AT-starpower.net>. Many thanks to him.
5338 5343
5339 5344 * IPython/iplib.py (complete): got auto-completion to work with
5340 5345 automagic (I had wanted this for a long time).
5341 5346
5342 5347 * IPython/Magic.py (Magic.magic_files): Added @files as an alias
5343 5348 to @file, since file() is now a builtin and clashes with automagic
5344 5349 for @file.
5345 5350
5346 5351 * Made some new files: Prompts, CrashHandler, Magic, Logger. All
5347 5352 of this was previously in iplib, which had grown to more than 2000
5348 5353 lines, way too long. No new functionality, but it makes managing
5349 5354 the code a bit easier.
5350 5355
5351 5356 * IPython/iplib.py (IPythonCrashHandler.__call__): Added version
5352 5357 information to crash reports.
5353 5358
5354 5359 2002-02-12 Fernando Perez <fperez@colorado.edu>
5355 5360
5356 5361 * Released 0.2.5.
5357 5362
5358 5363 2002-02-11 Fernando Perez <fperez@colorado.edu>
5359 5364
5360 5365 * Wrote a relatively complete Windows installer. It puts
5361 5366 everything in place, creates Start Menu entries and fixes the
5362 5367 color issues. Nothing fancy, but it works.
5363 5368
5364 5369 2002-02-10 Fernando Perez <fperez@colorado.edu>
5365 5370
5366 5371 * IPython/iplib.py (InteractiveShell.safe_execfile): added an
5367 5372 os.path.expanduser() call so that we can type @run ~/myfile.py and
5368 5373 have thigs work as expected.
5369 5374
5370 5375 * IPython/genutils.py (page): fixed exception handling so things
5371 5376 work both in Unix and Windows correctly. Quitting a pager triggers
5372 5377 an IOError/broken pipe in Unix, and in windows not finding a pager
5373 5378 is also an IOError, so I had to actually look at the return value
5374 5379 of the exception, not just the exception itself. Should be ok now.
5375 5380
5376 5381 * IPython/ultraTB.py (ColorSchemeTable.set_active_scheme):
5377 5382 modified to allow case-insensitive color scheme changes.
5378 5383
5379 5384 2002-02-09 Fernando Perez <fperez@colorado.edu>
5380 5385
5381 5386 * IPython/genutils.py (native_line_ends): new function to leave
5382 5387 user config files with os-native line-endings.
5383 5388
5384 5389 * README and manual updates.
5385 5390
5386 5391 * IPython/genutils.py: fixed unicode bug: use types.StringTypes
5387 5392 instead of StringType to catch Unicode strings.
5388 5393
5389 5394 * IPython/genutils.py (filefind): fixed bug for paths with
5390 5395 embedded spaces (very common in Windows).
5391 5396
5392 5397 * IPython/ipmaker.py (make_IPython): added a '.ini' to the rc
5393 5398 files under Windows, so that they get automatically associated
5394 5399 with a text editor. Windows makes it a pain to handle
5395 5400 extension-less files.
5396 5401
5397 5402 * IPython/iplib.py (InteractiveShell.init_readline): Made the
5398 5403 warning about readline only occur for Posix. In Windows there's no
5399 5404 way to get readline, so why bother with the warning.
5400 5405
5401 5406 * IPython/Struct.py (Struct.__str__): fixed to use self.__dict__
5402 5407 for __str__ instead of dir(self), since dir() changed in 2.2.
5403 5408
5404 5409 * Ported to Windows! Tested on XP, I suspect it should work fine
5405 5410 on NT/2000, but I don't think it will work on 98 et al. That
5406 5411 series of Windows is such a piece of junk anyway that I won't try
5407 5412 porting it there. The XP port was straightforward, showed a few
5408 5413 bugs here and there (fixed all), in particular some string
5409 5414 handling stuff which required considering Unicode strings (which
5410 5415 Windows uses). This is good, but hasn't been too tested :) No
5411 5416 fancy installer yet, I'll put a note in the manual so people at
5412 5417 least make manually a shortcut.
5413 5418
5414 5419 * IPython/iplib.py (Magic.magic_colors): Unified the color options
5415 5420 into a single one, "colors". This now controls both prompt and
5416 5421 exception color schemes, and can be changed both at startup
5417 5422 (either via command-line switches or via ipythonrc files) and at
5418 5423 runtime, with @colors.
5419 5424 (Magic.magic_run): renamed @prun to @run and removed the old
5420 5425 @run. The two were too similar to warrant keeping both.
5421 5426
5422 5427 2002-02-03 Fernando Perez <fperez@colorado.edu>
5423 5428
5424 5429 * IPython/iplib.py (install_first_time): Added comment on how to
5425 5430 configure the color options for first-time users. Put a <return>
5426 5431 request at the end so that small-terminal users get a chance to
5427 5432 read the startup info.
5428 5433
5429 5434 2002-01-23 Fernando Perez <fperez@colorado.edu>
5430 5435
5431 5436 * IPython/iplib.py (CachedOutput.update): Changed output memory
5432 5437 variable names from _o,_oo,_ooo,_o<n> to simply _,__,___,_<n>. For
5433 5438 input history we still use _i. Did this b/c these variable are
5434 5439 very commonly used in interactive work, so the less we need to
5435 5440 type the better off we are.
5436 5441 (Magic.magic_prun): updated @prun to better handle the namespaces
5437 5442 the file will run in, including a fix for __name__ not being set
5438 5443 before.
5439 5444
5440 5445 2002-01-20 Fernando Perez <fperez@colorado.edu>
5441 5446
5442 5447 * IPython/ultraTB.py (VerboseTB.linereader): Fixed printing of
5443 5448 extra garbage for Python 2.2. Need to look more carefully into
5444 5449 this later.
5445 5450
5446 5451 2002-01-19 Fernando Perez <fperez@colorado.edu>
5447 5452
5448 5453 * IPython/iplib.py (InteractiveShell.showtraceback): fixed to
5449 5454 display SyntaxError exceptions properly formatted when they occur
5450 5455 (they can be triggered by imported code).
5451 5456
5452 5457 2002-01-18 Fernando Perez <fperez@colorado.edu>
5453 5458
5454 5459 * IPython/iplib.py (InteractiveShell.safe_execfile): now
5455 5460 SyntaxError exceptions are reported nicely formatted, instead of
5456 5461 spitting out only offset information as before.
5457 5462 (Magic.magic_prun): Added the @prun function for executing
5458 5463 programs with command line args inside IPython.
5459 5464
5460 5465 2002-01-16 Fernando Perez <fperez@colorado.edu>
5461 5466
5462 5467 * IPython/iplib.py (Magic.magic_hist): Changed @hist and @dhist
5463 5468 to *not* include the last item given in a range. This brings their
5464 5469 behavior in line with Python's slicing:
5465 5470 a[n1:n2] -> a[n1]...a[n2-1]
5466 5471 It may be a bit less convenient, but I prefer to stick to Python's
5467 5472 conventions *everywhere*, so users never have to wonder.
5468 5473 (Magic.magic_macro): Added @macro function to ease the creation of
5469 5474 macros.
5470 5475
5471 5476 2002-01-05 Fernando Perez <fperez@colorado.edu>
5472 5477
5473 5478 * Released 0.2.4.
5474 5479
5475 5480 * IPython/iplib.py (Magic.magic_pdef):
5476 5481 (InteractiveShell.safe_execfile): report magic lines and error
5477 5482 lines without line numbers so one can easily copy/paste them for
5478 5483 re-execution.
5479 5484
5480 5485 * Updated manual with recent changes.
5481 5486
5482 5487 * IPython/iplib.py (Magic.magic_oinfo): added constructor
5483 5488 docstring printing when class? is called. Very handy for knowing
5484 5489 how to create class instances (as long as __init__ is well
5485 5490 documented, of course :)
5486 5491 (Magic.magic_doc): print both class and constructor docstrings.
5487 5492 (Magic.magic_pdef): give constructor info if passed a class and
5488 5493 __call__ info for callable object instances.
5489 5494
5490 5495 2002-01-04 Fernando Perez <fperez@colorado.edu>
5491 5496
5492 5497 * Made deep_reload() off by default. It doesn't always work
5493 5498 exactly as intended, so it's probably safer to have it off. It's
5494 5499 still available as dreload() anyway, so nothing is lost.
5495 5500
5496 5501 2002-01-02 Fernando Perez <fperez@colorado.edu>
5497 5502
5498 5503 * Released 0.2.3 (contacted R.Singh at CU about biopython course,
5499 5504 so I wanted an updated release).
5500 5505
5501 5506 2001-12-27 Fernando Perez <fperez@colorado.edu>
5502 5507
5503 5508 * IPython/iplib.py (InteractiveShell.interact): Added the original
5504 5509 code from 'code.py' for this module in order to change the
5505 5510 handling of a KeyboardInterrupt. This was necessary b/c otherwise
5506 5511 the history cache would break when the user hit Ctrl-C, and
5507 5512 interact() offers no way to add any hooks to it.
5508 5513
5509 5514 2001-12-23 Fernando Perez <fperez@colorado.edu>
5510 5515
5511 5516 * setup.py: added check for 'MANIFEST' before trying to remove
5512 5517 it. Thanks to Sean Reifschneider.
5513 5518
5514 5519 2001-12-22 Fernando Perez <fperez@colorado.edu>
5515 5520
5516 5521 * Released 0.2.2.
5517 5522
5518 5523 * Finished (reasonably) writing the manual. Later will add the
5519 5524 python-standard navigation stylesheets, but for the time being
5520 5525 it's fairly complete. Distribution will include html and pdf
5521 5526 versions.
5522 5527
5523 5528 * Bugfix: '.' wasn't being added to sys.path. Thanks to Prabhu
5524 5529 (MayaVi author).
5525 5530
5526 5531 2001-12-21 Fernando Perez <fperez@colorado.edu>
5527 5532
5528 5533 * Released 0.2.1. Barring any nasty bugs, this is it as far as a
5529 5534 good public release, I think (with the manual and the distutils
5530 5535 installer). The manual can use some work, but that can go
5531 5536 slowly. Otherwise I think it's quite nice for end users. Next
5532 5537 summer, rewrite the guts of it...
5533 5538
5534 5539 * Changed format of ipythonrc files to use whitespace as the
5535 5540 separator instead of an explicit '='. Cleaner.
5536 5541
5537 5542 2001-12-20 Fernando Perez <fperez@colorado.edu>
5538 5543
5539 5544 * Started a manual in LyX. For now it's just a quick merge of the
5540 5545 various internal docstrings and READMEs. Later it may grow into a
5541 5546 nice, full-blown manual.
5542 5547
5543 5548 * Set up a distutils based installer. Installation should now be
5544 5549 trivially simple for end-users.
5545 5550
5546 5551 2001-12-11 Fernando Perez <fperez@colorado.edu>
5547 5552
5548 5553 * Released 0.2.0. First public release, announced it at
5549 5554 comp.lang.python. From now on, just bugfixes...
5550 5555
5551 5556 * Went through all the files, set copyright/license notices and
5552 5557 cleaned up things. Ready for release.
5553 5558
5554 5559 2001-12-10 Fernando Perez <fperez@colorado.edu>
5555 5560
5556 5561 * Changed the first-time installer not to use tarfiles. It's more
5557 5562 robust now and less unix-dependent. Also makes it easier for
5558 5563 people to later upgrade versions.
5559 5564
5560 5565 * Changed @exit to @abort to reflect the fact that it's pretty
5561 5566 brutal (a sys.exit()). The difference between @abort and Ctrl-D
5562 5567 becomes significant only when IPyhton is embedded: in that case,
5563 5568 C-D closes IPython only, but @abort kills the enclosing program
5564 5569 too (unless it had called IPython inside a try catching
5565 5570 SystemExit).
5566 5571
5567 5572 * Created Shell module which exposes the actuall IPython Shell
5568 5573 classes, currently the normal and the embeddable one. This at
5569 5574 least offers a stable interface we won't need to change when
5570 5575 (later) the internals are rewritten. That rewrite will be confined
5571 5576 to iplib and ipmaker, but the Shell interface should remain as is.
5572 5577
5573 5578 * Added embed module which offers an embeddable IPShell object,
5574 5579 useful to fire up IPython *inside* a running program. Great for
5575 5580 debugging or dynamical data analysis.
5576 5581
5577 5582 2001-12-08 Fernando Perez <fperez@colorado.edu>
5578 5583
5579 5584 * Fixed small bug preventing seeing info from methods of defined
5580 5585 objects (incorrect namespace in _ofind()).
5581 5586
5582 5587 * Documentation cleanup. Moved the main usage docstrings to a
5583 5588 separate file, usage.py (cleaner to maintain, and hopefully in the
5584 5589 future some perlpod-like way of producing interactive, man and
5585 5590 html docs out of it will be found).
5586 5591
5587 5592 * Added @profile to see your profile at any time.
5588 5593
5589 5594 * Added @p as an alias for 'print'. It's especially convenient if
5590 5595 using automagic ('p x' prints x).
5591 5596
5592 5597 * Small cleanups and fixes after a pychecker run.
5593 5598
5594 5599 * Changed the @cd command to handle @cd - and @cd -<n> for
5595 5600 visiting any directory in _dh.
5596 5601
5597 5602 * Introduced _dh, a history of visited directories. @dhist prints
5598 5603 it out with numbers.
5599 5604
5600 5605 2001-12-07 Fernando Perez <fperez@colorado.edu>
5601 5606
5602 5607 * Released 0.1.22
5603 5608
5604 5609 * Made initialization a bit more robust against invalid color
5605 5610 options in user input (exit, not traceback-crash).
5606 5611
5607 5612 * Changed the bug crash reporter to write the report only in the
5608 5613 user's .ipython directory. That way IPython won't litter people's
5609 5614 hard disks with crash files all over the place. Also print on
5610 5615 screen the necessary mail command.
5611 5616
5612 5617 * With the new ultraTB, implemented LightBG color scheme for light
5613 5618 background terminals. A lot of people like white backgrounds, so I
5614 5619 guess we should at least give them something readable.
5615 5620
5616 5621 2001-12-06 Fernando Perez <fperez@colorado.edu>
5617 5622
5618 5623 * Modified the structure of ultraTB. Now there's a proper class
5619 5624 for tables of color schemes which allow adding schemes easily and
5620 5625 switching the active scheme without creating a new instance every
5621 5626 time (which was ridiculous). The syntax for creating new schemes
5622 5627 is also cleaner. I think ultraTB is finally done, with a clean
5623 5628 class structure. Names are also much cleaner (now there's proper
5624 5629 color tables, no need for every variable to also have 'color' in
5625 5630 its name).
5626 5631
5627 5632 * Broke down genutils into separate files. Now genutils only
5628 5633 contains utility functions, and classes have been moved to their
5629 5634 own files (they had enough independent functionality to warrant
5630 5635 it): ConfigLoader, OutputTrap, Struct.
5631 5636
5632 5637 2001-12-05 Fernando Perez <fperez@colorado.edu>
5633 5638
5634 5639 * IPython turns 21! Released version 0.1.21, as a candidate for
5635 5640 public consumption. If all goes well, release in a few days.
5636 5641
5637 5642 * Fixed path bug (files in Extensions/ directory wouldn't be found
5638 5643 unless IPython/ was explicitly in sys.path).
5639 5644
5640 5645 * Extended the FlexCompleter class as MagicCompleter to allow
5641 5646 completion of @-starting lines.
5642 5647
5643 5648 * Created __release__.py file as a central repository for release
5644 5649 info that other files can read from.
5645 5650
5646 5651 * Fixed small bug in logging: when logging was turned on in
5647 5652 mid-session, old lines with special meanings (!@?) were being
5648 5653 logged without the prepended comment, which is necessary since
5649 5654 they are not truly valid python syntax. This should make session
5650 5655 restores produce less errors.
5651 5656
5652 5657 * The namespace cleanup forced me to make a FlexCompleter class
5653 5658 which is nothing but a ripoff of rlcompleter, but with selectable
5654 5659 namespace (rlcompleter only works in __main__.__dict__). I'll try
5655 5660 to submit a note to the authors to see if this change can be
5656 5661 incorporated in future rlcompleter releases (Dec.6: done)
5657 5662
5658 5663 * More fixes to namespace handling. It was a mess! Now all
5659 5664 explicit references to __main__.__dict__ are gone (except when
5660 5665 really needed) and everything is handled through the namespace
5661 5666 dicts in the IPython instance. We seem to be getting somewhere
5662 5667 with this, finally...
5663 5668
5664 5669 * Small documentation updates.
5665 5670
5666 5671 * Created the Extensions directory under IPython (with an
5667 5672 __init__.py). Put the PhysicalQ stuff there. This directory should
5668 5673 be used for all special-purpose extensions.
5669 5674
5670 5675 * File renaming:
5671 5676 ipythonlib --> ipmaker
5672 5677 ipplib --> iplib
5673 5678 This makes a bit more sense in terms of what these files actually do.
5674 5679
5675 5680 * Moved all the classes and functions in ipythonlib to ipplib, so
5676 5681 now ipythonlib only has make_IPython(). This will ease up its
5677 5682 splitting in smaller functional chunks later.
5678 5683
5679 5684 * Cleaned up (done, I think) output of @whos. Better column
5680 5685 formatting, and now shows str(var) for as much as it can, which is
5681 5686 typically what one gets with a 'print var'.
5682 5687
5683 5688 2001-12-04 Fernando Perez <fperez@colorado.edu>
5684 5689
5685 5690 * Fixed namespace problems. Now builtin/IPyhton/user names get
5686 5691 properly reported in their namespace. Internal namespace handling
5687 5692 is finally getting decent (not perfect yet, but much better than
5688 5693 the ad-hoc mess we had).
5689 5694
5690 5695 * Removed -exit option. If people just want to run a python
5691 5696 script, that's what the normal interpreter is for. Less
5692 5697 unnecessary options, less chances for bugs.
5693 5698
5694 5699 * Added a crash handler which generates a complete post-mortem if
5695 5700 IPython crashes. This will help a lot in tracking bugs down the
5696 5701 road.
5697 5702
5698 5703 * Fixed nasty bug in auto-evaluation part of prefilter(). Names
5699 5704 which were boud to functions being reassigned would bypass the
5700 5705 logger, breaking the sync of _il with the prompt counter. This
5701 5706 would then crash IPython later when a new line was logged.
5702 5707
5703 5708 2001-12-02 Fernando Perez <fperez@colorado.edu>
5704 5709
5705 5710 * Made IPython a package. This means people don't have to clutter
5706 5711 their sys.path with yet another directory. Changed the INSTALL
5707 5712 file accordingly.
5708 5713
5709 5714 * Cleaned up the output of @who_ls, @who and @whos. @who_ls now
5710 5715 sorts its output (so @who shows it sorted) and @whos formats the
5711 5716 table according to the width of the first column. Nicer, easier to
5712 5717 read. Todo: write a generic table_format() which takes a list of
5713 5718 lists and prints it nicely formatted, with optional row/column
5714 5719 separators and proper padding and justification.
5715 5720
5716 5721 * Released 0.1.20
5717 5722
5718 5723 * Fixed bug in @log which would reverse the inputcache list (a
5719 5724 copy operation was missing).
5720 5725
5721 5726 * Code cleanup. @config was changed to use page(). Better, since
5722 5727 its output is always quite long.
5723 5728
5724 5729 * Itpl is back as a dependency. I was having too many problems
5725 5730 getting the parametric aliases to work reliably, and it's just
5726 5731 easier to code weird string operations with it than playing %()s
5727 5732 games. It's only ~6k, so I don't think it's too big a deal.
5728 5733
5729 5734 * Found (and fixed) a very nasty bug with history. !lines weren't
5730 5735 getting cached, and the out of sync caches would crash
5731 5736 IPython. Fixed it by reorganizing the prefilter/handlers/logger
5732 5737 division of labor a bit better. Bug fixed, cleaner structure.
5733 5738
5734 5739 2001-12-01 Fernando Perez <fperez@colorado.edu>
5735 5740
5736 5741 * Released 0.1.19
5737 5742
5738 5743 * Added option -n to @hist to prevent line number printing. Much
5739 5744 easier to copy/paste code this way.
5740 5745
5741 5746 * Created global _il to hold the input list. Allows easy
5742 5747 re-execution of blocks of code by slicing it (inspired by Janko's
5743 5748 comment on 'macros').
5744 5749
5745 5750 * Small fixes and doc updates.
5746 5751
5747 5752 * Rewrote @history function (was @h). Renamed it to @hist, @h is
5748 5753 much too fragile with automagic. Handles properly multi-line
5749 5754 statements and takes parameters.
5750 5755
5751 5756 2001-11-30 Fernando Perez <fperez@colorado.edu>
5752 5757
5753 5758 * Version 0.1.18 released.
5754 5759
5755 5760 * Fixed nasty namespace bug in initial module imports.
5756 5761
5757 5762 * Added copyright/license notes to all code files (except
5758 5763 DPyGetOpt). For the time being, LGPL. That could change.
5759 5764
5760 5765 * Rewrote a much nicer README, updated INSTALL, cleaned up
5761 5766 ipythonrc-* samples.
5762 5767
5763 5768 * Overall code/documentation cleanup. Basically ready for
5764 5769 release. Only remaining thing: licence decision (LGPL?).
5765 5770
5766 5771 * Converted load_config to a class, ConfigLoader. Now recursion
5767 5772 control is better organized. Doesn't include the same file twice.
5768 5773
5769 5774 2001-11-29 Fernando Perez <fperez@colorado.edu>
5770 5775
5771 5776 * Got input history working. Changed output history variables from
5772 5777 _p to _o so that _i is for input and _o for output. Just cleaner
5773 5778 convention.
5774 5779
5775 5780 * Implemented parametric aliases. This pretty much allows the
5776 5781 alias system to offer full-blown shell convenience, I think.
5777 5782
5778 5783 * Version 0.1.17 released, 0.1.18 opened.
5779 5784
5780 5785 * dot_ipython/ipythonrc (alias): added documentation.
5781 5786 (xcolor): Fixed small bug (xcolors -> xcolor)
5782 5787
5783 5788 * Changed the alias system. Now alias is a magic command to define
5784 5789 aliases just like the shell. Rationale: the builtin magics should
5785 5790 be there for things deeply connected to IPython's
5786 5791 architecture. And this is a much lighter system for what I think
5787 5792 is the really important feature: allowing users to define quickly
5788 5793 magics that will do shell things for them, so they can customize
5789 5794 IPython easily to match their work habits. If someone is really
5790 5795 desperate to have another name for a builtin alias, they can
5791 5796 always use __IP.magic_newname = __IP.magic_oldname. Hackish but
5792 5797 works.
5793 5798
5794 5799 2001-11-28 Fernando Perez <fperez@colorado.edu>
5795 5800
5796 5801 * Changed @file so that it opens the source file at the proper
5797 5802 line. Since it uses less, if your EDITOR environment is
5798 5803 configured, typing v will immediately open your editor of choice
5799 5804 right at the line where the object is defined. Not as quick as
5800 5805 having a direct @edit command, but for all intents and purposes it
5801 5806 works. And I don't have to worry about writing @edit to deal with
5802 5807 all the editors, less does that.
5803 5808
5804 5809 * Version 0.1.16 released, 0.1.17 opened.
5805 5810
5806 5811 * Fixed some nasty bugs in the page/page_dumb combo that could
5807 5812 crash IPython.
5808 5813
5809 5814 2001-11-27 Fernando Perez <fperez@colorado.edu>
5810 5815
5811 5816 * Version 0.1.15 released, 0.1.16 opened.
5812 5817
5813 5818 * Finally got ? and ?? to work for undefined things: now it's
5814 5819 possible to type {}.get? and get information about the get method
5815 5820 of dicts, or os.path? even if only os is defined (so technically
5816 5821 os.path isn't). Works at any level. For example, after import os,
5817 5822 os?, os.path?, os.path.abspath? all work. This is great, took some
5818 5823 work in _ofind.
5819 5824
5820 5825 * Fixed more bugs with logging. The sanest way to do it was to add
5821 5826 to @log a 'mode' parameter. Killed two in one shot (this mode
5822 5827 option was a request of Janko's). I think it's finally clean
5823 5828 (famous last words).
5824 5829
5825 5830 * Added a page_dumb() pager which does a decent job of paging on
5826 5831 screen, if better things (like less) aren't available. One less
5827 5832 unix dependency (someday maybe somebody will port this to
5828 5833 windows).
5829 5834
5830 5835 * Fixed problem in magic_log: would lock of logging out if log
5831 5836 creation failed (because it would still think it had succeeded).
5832 5837
5833 5838 * Improved the page() function using curses to auto-detect screen
5834 5839 size. Now it can make a much better decision on whether to print
5835 5840 or page a string. Option screen_length was modified: a value 0
5836 5841 means auto-detect, and that's the default now.
5837 5842
5838 5843 * Version 0.1.14 released, 0.1.15 opened. I think this is ready to
5839 5844 go out. I'll test it for a few days, then talk to Janko about
5840 5845 licences and announce it.
5841 5846
5842 5847 * Fixed the length of the auto-generated ---> prompt which appears
5843 5848 for auto-parens and auto-quotes. Getting this right isn't trivial,
5844 5849 with all the color escapes, different prompt types and optional
5845 5850 separators. But it seems to be working in all the combinations.
5846 5851
5847 5852 2001-11-26 Fernando Perez <fperez@colorado.edu>
5848 5853
5849 5854 * Wrote a regexp filter to get option types from the option names
5850 5855 string. This eliminates the need to manually keep two duplicate
5851 5856 lists.
5852 5857
5853 5858 * Removed the unneeded check_option_names. Now options are handled
5854 5859 in a much saner manner and it's easy to visually check that things
5855 5860 are ok.
5856 5861
5857 5862 * Updated version numbers on all files I modified to carry a
5858 5863 notice so Janko and Nathan have clear version markers.
5859 5864
5860 5865 * Updated docstring for ultraTB with my changes. I should send
5861 5866 this to Nathan.
5862 5867
5863 5868 * Lots of small fixes. Ran everything through pychecker again.
5864 5869
5865 5870 * Made loading of deep_reload an cmd line option. If it's not too
5866 5871 kosher, now people can just disable it. With -nodeep_reload it's
5867 5872 still available as dreload(), it just won't overwrite reload().
5868 5873
5869 5874 * Moved many options to the no| form (-opt and -noopt
5870 5875 accepted). Cleaner.
5871 5876
5872 5877 * Changed magic_log so that if called with no parameters, it uses
5873 5878 'rotate' mode. That way auto-generated logs aren't automatically
5874 5879 over-written. For normal logs, now a backup is made if it exists
5875 5880 (only 1 level of backups). A new 'backup' mode was added to the
5876 5881 Logger class to support this. This was a request by Janko.
5877 5882
5878 5883 * Added @logoff/@logon to stop/restart an active log.
5879 5884
5880 5885 * Fixed a lot of bugs in log saving/replay. It was pretty
5881 5886 broken. Now special lines (!@,/) appear properly in the command
5882 5887 history after a log replay.
5883 5888
5884 5889 * Tried and failed to implement full session saving via pickle. My
5885 5890 idea was to pickle __main__.__dict__, but modules can't be
5886 5891 pickled. This would be a better alternative to replaying logs, but
5887 5892 seems quite tricky to get to work. Changed -session to be called
5888 5893 -logplay, which more accurately reflects what it does. And if we
5889 5894 ever get real session saving working, -session is now available.
5890 5895
5891 5896 * Implemented color schemes for prompts also. As for tracebacks,
5892 5897 currently only NoColor and Linux are supported. But now the
5893 5898 infrastructure is in place, based on a generic ColorScheme
5894 5899 class. So writing and activating new schemes both for the prompts
5895 5900 and the tracebacks should be straightforward.
5896 5901
5897 5902 * Version 0.1.13 released, 0.1.14 opened.
5898 5903
5899 5904 * Changed handling of options for output cache. Now counter is
5900 5905 hardwired starting at 1 and one specifies the maximum number of
5901 5906 entries *in the outcache* (not the max prompt counter). This is
5902 5907 much better, since many statements won't increase the cache
5903 5908 count. It also eliminated some confusing options, now there's only
5904 5909 one: cache_size.
5905 5910
5906 5911 * Added 'alias' magic function and magic_alias option in the
5907 5912 ipythonrc file. Now the user can easily define whatever names he
5908 5913 wants for the magic functions without having to play weird
5909 5914 namespace games. This gives IPython a real shell-like feel.
5910 5915
5911 5916 * Fixed doc/?/?? for magics. Now all work, in all forms (explicit
5912 5917 @ or not).
5913 5918
5914 5919 This was one of the last remaining 'visible' bugs (that I know
5915 5920 of). I think if I can clean up the session loading so it works
5916 5921 100% I'll release a 0.2.0 version on c.p.l (talk to Janko first
5917 5922 about licensing).
5918 5923
5919 5924 2001-11-25 Fernando Perez <fperez@colorado.edu>
5920 5925
5921 5926 * Rewrote somewhat oinfo (?/??). Nicer, now uses page() and
5922 5927 there's a cleaner distinction between what ? and ?? show.
5923 5928
5924 5929 * Added screen_length option. Now the user can define his own
5925 5930 screen size for page() operations.
5926 5931
5927 5932 * Implemented magic shell-like functions with automatic code
5928 5933 generation. Now adding another function is just a matter of adding
5929 5934 an entry to a dict, and the function is dynamically generated at
5930 5935 run-time. Python has some really cool features!
5931 5936
5932 5937 * Renamed many options to cleanup conventions a little. Now all
5933 5938 are lowercase, and only underscores where needed. Also in the code
5934 5939 option name tables are clearer.
5935 5940
5936 5941 * Changed prompts a little. Now input is 'In [n]:' instead of
5937 5942 'In[n]:='. This allows it the numbers to be aligned with the
5938 5943 Out[n] numbers, and removes usage of ':=' which doesn't exist in
5939 5944 Python (it was a Mathematica thing). The '...' continuation prompt
5940 5945 was also changed a little to align better.
5941 5946
5942 5947 * Fixed bug when flushing output cache. Not all _p<n> variables
5943 5948 exist, so their deletion needs to be wrapped in a try:
5944 5949
5945 5950 * Figured out how to properly use inspect.formatargspec() (it
5946 5951 requires the args preceded by *). So I removed all the code from
5947 5952 _get_pdef in Magic, which was just replicating that.
5948 5953
5949 5954 * Added test to prefilter to allow redefining magic function names
5950 5955 as variables. This is ok, since the @ form is always available,
5951 5956 but whe should allow the user to define a variable called 'ls' if
5952 5957 he needs it.
5953 5958
5954 5959 * Moved the ToDo information from README into a separate ToDo.
5955 5960
5956 5961 * General code cleanup and small bugfixes. I think it's close to a
5957 5962 state where it can be released, obviously with a big 'beta'
5958 5963 warning on it.
5959 5964
5960 5965 * Got the magic function split to work. Now all magics are defined
5961 5966 in a separate class. It just organizes things a bit, and now
5962 5967 Xemacs behaves nicer (it was choking on InteractiveShell b/c it
5963 5968 was too long).
5964 5969
5965 5970 * Changed @clear to @reset to avoid potential confusions with
5966 5971 the shell command clear. Also renamed @cl to @clear, which does
5967 5972 exactly what people expect it to from their shell experience.
5968 5973
5969 5974 Added a check to the @reset command (since it's so
5970 5975 destructive, it's probably a good idea to ask for confirmation).
5971 5976 But now reset only works for full namespace resetting. Since the
5972 5977 del keyword is already there for deleting a few specific
5973 5978 variables, I don't see the point of having a redundant magic
5974 5979 function for the same task.
5975 5980
5976 5981 2001-11-24 Fernando Perez <fperez@colorado.edu>
5977 5982
5978 5983 * Updated the builtin docs (esp. the ? ones).
5979 5984
5980 5985 * Ran all the code through pychecker. Not terribly impressed with
5981 5986 it: lots of spurious warnings and didn't really find anything of
5982 5987 substance (just a few modules being imported and not used).
5983 5988
5984 5989 * Implemented the new ultraTB functionality into IPython. New
5985 5990 option: xcolors. This chooses color scheme. xmode now only selects
5986 5991 between Plain and Verbose. Better orthogonality.
5987 5992
5988 5993 * Large rewrite of ultraTB. Much cleaner now, with a separation of
5989 5994 mode and color scheme for the exception handlers. Now it's
5990 5995 possible to have the verbose traceback with no coloring.
5991 5996
5992 5997 2001-11-23 Fernando Perez <fperez@colorado.edu>
5993 5998
5994 5999 * Version 0.1.12 released, 0.1.13 opened.
5995 6000
5996 6001 * Removed option to set auto-quote and auto-paren escapes by
5997 6002 user. The chances of breaking valid syntax are just too high. If
5998 6003 someone *really* wants, they can always dig into the code.
5999 6004
6000 6005 * Made prompt separators configurable.
6001 6006
6002 6007 2001-11-22 Fernando Perez <fperez@colorado.edu>
6003 6008
6004 6009 * Small bugfixes in many places.
6005 6010
6006 6011 * Removed the MyCompleter class from ipplib. It seemed redundant
6007 6012 with the C-p,C-n history search functionality. Less code to
6008 6013 maintain.
6009 6014
6010 6015 * Moved all the original ipython.py code into ipythonlib.py. Right
6011 6016 now it's just one big dump into a function called make_IPython, so
6012 6017 no real modularity has been gained. But at least it makes the
6013 6018 wrapper script tiny, and since ipythonlib is a module, it gets
6014 6019 compiled and startup is much faster.
6015 6020
6016 6021 This is a reasobably 'deep' change, so we should test it for a
6017 6022 while without messing too much more with the code.
6018 6023
6019 6024 2001-11-21 Fernando Perez <fperez@colorado.edu>
6020 6025
6021 6026 * Version 0.1.11 released, 0.1.12 opened for further work.
6022 6027
6023 6028 * Removed dependency on Itpl. It was only needed in one place. It
6024 6029 would be nice if this became part of python, though. It makes life
6025 6030 *a lot* easier in some cases.
6026 6031
6027 6032 * Simplified the prefilter code a bit. Now all handlers are
6028 6033 expected to explicitly return a value (at least a blank string).
6029 6034
6030 6035 * Heavy edits in ipplib. Removed the help system altogether. Now
6031 6036 obj?/?? is used for inspecting objects, a magic @doc prints
6032 6037 docstrings, and full-blown Python help is accessed via the 'help'
6033 6038 keyword. This cleans up a lot of code (less to maintain) and does
6034 6039 the job. Since 'help' is now a standard Python component, might as
6035 6040 well use it and remove duplicate functionality.
6036 6041
6037 6042 Also removed the option to use ipplib as a standalone program. By
6038 6043 now it's too dependent on other parts of IPython to function alone.
6039 6044
6040 6045 * Fixed bug in genutils.pager. It would crash if the pager was
6041 6046 exited immediately after opening (broken pipe).
6042 6047
6043 6048 * Trimmed down the VerboseTB reporting a little. The header is
6044 6049 much shorter now and the repeated exception arguments at the end
6045 6050 have been removed. For interactive use the old header seemed a bit
6046 6051 excessive.
6047 6052
6048 6053 * Fixed small bug in output of @whos for variables with multi-word
6049 6054 types (only first word was displayed).
6050 6055
6051 6056 2001-11-17 Fernando Perez <fperez@colorado.edu>
6052 6057
6053 6058 * Version 0.1.10 released, 0.1.11 opened for further work.
6054 6059
6055 6060 * Modified dirs and friends. dirs now *returns* the stack (not
6056 6061 prints), so one can manipulate it as a variable. Convenient to
6057 6062 travel along many directories.
6058 6063
6059 6064 * Fixed bug in magic_pdef: would only work with functions with
6060 6065 arguments with default values.
6061 6066
6062 6067 2001-11-14 Fernando Perez <fperez@colorado.edu>
6063 6068
6064 6069 * Added the PhysicsInput stuff to dot_ipython so it ships as an
6065 6070 example with IPython. Various other minor fixes and cleanups.
6066 6071
6067 6072 * Version 0.1.9 released, 0.1.10 opened for further work.
6068 6073
6069 6074 * Added sys.path to the list of directories searched in the
6070 6075 execfile= option. It used to be the current directory and the
6071 6076 user's IPYTHONDIR only.
6072 6077
6073 6078 2001-11-13 Fernando Perez <fperez@colorado.edu>
6074 6079
6075 6080 * Reinstated the raw_input/prefilter separation that Janko had
6076 6081 initially. This gives a more convenient setup for extending the
6077 6082 pre-processor from the outside: raw_input always gets a string,
6078 6083 and prefilter has to process it. We can then redefine prefilter
6079 6084 from the outside and implement extensions for special
6080 6085 purposes.
6081 6086
6082 6087 Today I got one for inputting PhysicalQuantity objects
6083 6088 (from Scientific) without needing any function calls at
6084 6089 all. Extremely convenient, and it's all done as a user-level
6085 6090 extension (no IPython code was touched). Now instead of:
6086 6091 a = PhysicalQuantity(4.2,'m/s**2')
6087 6092 one can simply say
6088 6093 a = 4.2 m/s**2
6089 6094 or even
6090 6095 a = 4.2 m/s^2
6091 6096
6092 6097 I use this, but it's also a proof of concept: IPython really is
6093 6098 fully user-extensible, even at the level of the parsing of the
6094 6099 command line. It's not trivial, but it's perfectly doable.
6095 6100
6096 6101 * Added 'add_flip' method to inclusion conflict resolver. Fixes
6097 6102 the problem of modules being loaded in the inverse order in which
6098 6103 they were defined in
6099 6104
6100 6105 * Version 0.1.8 released, 0.1.9 opened for further work.
6101 6106
6102 6107 * Added magics pdef, source and file. They respectively show the
6103 6108 definition line ('prototype' in C), source code and full python
6104 6109 file for any callable object. The object inspector oinfo uses
6105 6110 these to show the same information.
6106 6111
6107 6112 * Version 0.1.7 released, 0.1.8 opened for further work.
6108 6113
6109 6114 * Separated all the magic functions into a class called Magic. The
6110 6115 InteractiveShell class was becoming too big for Xemacs to handle
6111 6116 (de-indenting a line would lock it up for 10 seconds while it
6112 6117 backtracked on the whole class!)
6113 6118
6114 6119 FIXME: didn't work. It can be done, but right now namespaces are
6115 6120 all messed up. Do it later (reverted it for now, so at least
6116 6121 everything works as before).
6117 6122
6118 6123 * Got the object introspection system (magic_oinfo) working! I
6119 6124 think this is pretty much ready for release to Janko, so he can
6120 6125 test it for a while and then announce it. Pretty much 100% of what
6121 6126 I wanted for the 'phase 1' release is ready. Happy, tired.
6122 6127
6123 6128 2001-11-12 Fernando Perez <fperez@colorado.edu>
6124 6129
6125 6130 * Version 0.1.6 released, 0.1.7 opened for further work.
6126 6131
6127 6132 * Fixed bug in printing: it used to test for truth before
6128 6133 printing, so 0 wouldn't print. Now checks for None.
6129 6134
6130 6135 * Fixed bug where auto-execs increase the prompt counter by 2 (b/c
6131 6136 they have to call len(str(sys.ps1)) ). But the fix is ugly, it
6132 6137 reaches by hand into the outputcache. Think of a better way to do
6133 6138 this later.
6134 6139
6135 6140 * Various small fixes thanks to Nathan's comments.
6136 6141
6137 6142 * Changed magic_pprint to magic_Pprint. This way it doesn't
6138 6143 collide with pprint() and the name is consistent with the command
6139 6144 line option.
6140 6145
6141 6146 * Changed prompt counter behavior to be fully like
6142 6147 Mathematica's. That is, even input that doesn't return a result
6143 6148 raises the prompt counter. The old behavior was kind of confusing
6144 6149 (getting the same prompt number several times if the operation
6145 6150 didn't return a result).
6146 6151
6147 6152 * Fixed Nathan's last name in a couple of places (Gray, not Graham).
6148 6153
6149 6154 * Fixed -Classic mode (wasn't working anymore).
6150 6155
6151 6156 * Added colored prompts using Nathan's new code. Colors are
6152 6157 currently hardwired, they can be user-configurable. For
6153 6158 developers, they can be chosen in file ipythonlib.py, at the
6154 6159 beginning of the CachedOutput class def.
6155 6160
6156 6161 2001-11-11 Fernando Perez <fperez@colorado.edu>
6157 6162
6158 6163 * Version 0.1.5 released, 0.1.6 opened for further work.
6159 6164
6160 6165 * Changed magic_env to *return* the environment as a dict (not to
6161 6166 print it). This way it prints, but it can also be processed.
6162 6167
6163 6168 * Added Verbose exception reporting to interactive
6164 6169 exceptions. Very nice, now even 1/0 at the prompt gives a verbose
6165 6170 traceback. Had to make some changes to the ultraTB file. This is
6166 6171 probably the last 'big' thing in my mental todo list. This ties
6167 6172 in with the next entry:
6168 6173
6169 6174 * Changed -Xi and -Xf to a single -xmode option. Now all the user
6170 6175 has to specify is Plain, Color or Verbose for all exception
6171 6176 handling.
6172 6177
6173 6178 * Removed ShellServices option. All this can really be done via
6174 6179 the magic system. It's easier to extend, cleaner and has automatic
6175 6180 namespace protection and documentation.
6176 6181
6177 6182 2001-11-09 Fernando Perez <fperez@colorado.edu>
6178 6183
6179 6184 * Fixed bug in output cache flushing (missing parameter to
6180 6185 __init__). Other small bugs fixed (found using pychecker).
6181 6186
6182 6187 * Version 0.1.4 opened for bugfixing.
6183 6188
6184 6189 2001-11-07 Fernando Perez <fperez@colorado.edu>
6185 6190
6186 6191 * Version 0.1.3 released, mainly because of the raw_input bug.
6187 6192
6188 6193 * Fixed NASTY bug in raw_input: input line wasn't properly parsed
6189 6194 and when testing for whether things were callable, a call could
6190 6195 actually be made to certain functions. They would get called again
6191 6196 once 'really' executed, with a resulting double call. A disaster
6192 6197 in many cases (list.reverse() would never work!).
6193 6198
6194 6199 * Removed prefilter() function, moved its code to raw_input (which
6195 6200 after all was just a near-empty caller for prefilter). This saves
6196 6201 a function call on every prompt, and simplifies the class a tiny bit.
6197 6202
6198 6203 * Fix _ip to __ip name in magic example file.
6199 6204
6200 6205 * Changed 'tar -x -f' to 'tar xvf' in auto-installer. This should
6201 6206 work with non-gnu versions of tar.
6202 6207
6203 6208 2001-11-06 Fernando Perez <fperez@colorado.edu>
6204 6209
6205 6210 * Version 0.1.2. Just to keep track of the recent changes.
6206 6211
6207 6212 * Fixed nasty bug in output prompt routine. It used to check 'if
6208 6213 arg != None...'. Problem is, this fails if arg implements a
6209 6214 special comparison (__cmp__) which disallows comparing to
6210 6215 None. Found it when trying to use the PhysicalQuantity module from
6211 6216 ScientificPython.
6212 6217
6213 6218 2001-11-05 Fernando Perez <fperez@colorado.edu>
6214 6219
6215 6220 * Also added dirs. Now the pushd/popd/dirs family functions
6216 6221 basically like the shell, with the added convenience of going home
6217 6222 when called with no args.
6218 6223
6219 6224 * pushd/popd slightly modified to mimic shell behavior more
6220 6225 closely.
6221 6226
6222 6227 * Added env,pushd,popd from ShellServices as magic functions. I
6223 6228 think the cleanest will be to port all desired functions from
6224 6229 ShellServices as magics and remove ShellServices altogether. This
6225 6230 will provide a single, clean way of adding functionality
6226 6231 (shell-type or otherwise) to IP.
6227 6232
6228 6233 2001-11-04 Fernando Perez <fperez@colorado.edu>
6229 6234
6230 6235 * Added .ipython/ directory to sys.path. This way users can keep
6231 6236 customizations there and access them via import.
6232 6237
6233 6238 2001-11-03 Fernando Perez <fperez@colorado.edu>
6234 6239
6235 6240 * Opened version 0.1.1 for new changes.
6236 6241
6237 6242 * Changed version number to 0.1.0: first 'public' release, sent to
6238 6243 Nathan and Janko.
6239 6244
6240 6245 * Lots of small fixes and tweaks.
6241 6246
6242 6247 * Minor changes to whos format. Now strings are shown, snipped if
6243 6248 too long.
6244 6249
6245 6250 * Changed ShellServices to work on __main__ so they show up in @who
6246 6251
6247 6252 * Help also works with ? at the end of a line:
6248 6253 ?sin and sin?
6249 6254 both produce the same effect. This is nice, as often I use the
6250 6255 tab-complete to find the name of a method, but I used to then have
6251 6256 to go to the beginning of the line to put a ? if I wanted more
6252 6257 info. Now I can just add the ? and hit return. Convenient.
6253 6258
6254 6259 2001-11-02 Fernando Perez <fperez@colorado.edu>
6255 6260
6256 6261 * Python version check (>=2.1) added.
6257 6262
6258 6263 * Added LazyPython documentation. At this point the docs are quite
6259 6264 a mess. A cleanup is in order.
6260 6265
6261 6266 * Auto-installer created. For some bizarre reason, the zipfiles
6262 6267 module isn't working on my system. So I made a tar version
6263 6268 (hopefully the command line options in various systems won't kill
6264 6269 me).
6265 6270
6266 6271 * Fixes to Struct in genutils. Now all dictionary-like methods are
6267 6272 protected (reasonably).
6268 6273
6269 6274 * Added pager function to genutils and changed ? to print usage
6270 6275 note through it (it was too long).
6271 6276
6272 6277 * Added the LazyPython functionality. Works great! I changed the
6273 6278 auto-quote escape to ';', it's on home row and next to '. But
6274 6279 both auto-quote and auto-paren (still /) escapes are command-line
6275 6280 parameters.
6276 6281
6277 6282
6278 6283 2001-11-01 Fernando Perez <fperez@colorado.edu>
6279 6284
6280 6285 * Version changed to 0.0.7. Fairly large change: configuration now
6281 6286 is all stored in a directory, by default .ipython. There, all
6282 6287 config files have normal looking names (not .names)
6283 6288
6284 6289 * Version 0.0.6 Released first to Lucas and Archie as a test
6285 6290 run. Since it's the first 'semi-public' release, change version to
6286 6291 > 0.0.6 for any changes now.
6287 6292
6288 6293 * Stuff I had put in the ipplib.py changelog:
6289 6294
6290 6295 Changes to InteractiveShell:
6291 6296
6292 6297 - Made the usage message a parameter.
6293 6298
6294 6299 - Require the name of the shell variable to be given. It's a bit
6295 6300 of a hack, but allows the name 'shell' not to be hardwired in the
6296 6301 magic (@) handler, which is problematic b/c it requires
6297 6302 polluting the global namespace with 'shell'. This in turn is
6298 6303 fragile: if a user redefines a variable called shell, things
6299 6304 break.
6300 6305
6301 6306 - magic @: all functions available through @ need to be defined
6302 6307 as magic_<name>, even though they can be called simply as
6303 6308 @<name>. This allows the special command @magic to gather
6304 6309 information automatically about all existing magic functions,
6305 6310 even if they are run-time user extensions, by parsing the shell
6306 6311 instance __dict__ looking for special magic_ names.
6307 6312
6308 6313 - mainloop: added *two* local namespace parameters. This allows
6309 6314 the class to differentiate between parameters which were there
6310 6315 before and after command line initialization was processed. This
6311 6316 way, later @who can show things loaded at startup by the
6312 6317 user. This trick was necessary to make session saving/reloading
6313 6318 really work: ideally after saving/exiting/reloading a session,
6314 6319 *everything* should look the same, including the output of @who. I
6315 6320 was only able to make this work with this double namespace
6316 6321 trick.
6317 6322
6318 6323 - added a header to the logfile which allows (almost) full
6319 6324 session restoring.
6320 6325
6321 6326 - prepend lines beginning with @ or !, with a and log
6322 6327 them. Why? !lines: may be useful to know what you did @lines:
6323 6328 they may affect session state. So when restoring a session, at
6324 6329 least inform the user of their presence. I couldn't quite get
6325 6330 them to properly re-execute, but at least the user is warned.
6326 6331
6327 6332 * Started ChangeLog.
@@ -1,406 +1,406 b''
1 1 .\" Hey, EMACS: -*- nroff -*-
2 2 .\" First parameter, NAME, should be all caps
3 3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 4 .\" other parameters are allowed: see man(7), man(1)
5 5 .TH IPYTHON 1 "November 30, 2004"
6 6 .\" Please adjust this date whenever revising the manpage.
7 7 .\"
8 8 .\" Some roff macros, for reference:
9 9 .\" .nh disable hyphenation
10 10 .\" .hy enable hyphenation
11 11 .\" .ad l left justify
12 12 .\" .ad b justify to both left and right margins
13 13 .\" .nf disable filling
14 14 .\" .fi enable filling
15 15 .\" .br insert line break
16 16 .\" .sp <n> insert n+1 empty lines
17 17 .\" for manpage-specific macros, see man(7) and groff_man(7)
18 18 .\" .SH section heading
19 19 .\" .SS secondary section heading
20 20 .\"
21 21 .\"
22 22 .\" To preview this page as plain text: nroff -man ipython.1
23 23 .\"
24 24 .SH NAME
25 25 ipython \- An Enhanced Interactive Python
26 26 .SH SYNOPSIS
27 27 .B ipython
28 28 .RI [ options ] " files" ...
29 29 .SH DESCRIPTION
30 30 An interactive Python shell with automatic history (input and output),
31 31 dynamic object introspection, easier configuration, command
32 32 completion, access to the system shell, integration with numerical and
33 33 scientific computing tools, and more.
34 34 .SH SPECIAL THREADING OPTIONS
35 35 The following special options are ONLY valid at the beginning of the command
36 36 line, and not later. This is because they control the initialization of
37 37 ipython itself, before the normal option-handling mechanism is active.
38 38 .TP
39 .B \-gthread, \-qthread, \-wthread, \-pylab
39 .B \-gthread, \-qthread, \-q4thread, \-wthread, \-pylab
40 40 Only ONE of these can be given, and it can only be given as the first option
41 passed to IPython (it will have no effect in any other position). They
42 provide threading support for the GTK, QT and WXWidgets toolkits, and for the
41 passed to IPython (it will have no effect in any other position). They provide
42 threading support for the GTK, QT3, QT4 and WXWidgets toolkits, and for the
43 43 matplotlib library.
44 44 .br
45 45 .sp 1
46 With any of the first three options, IPython starts running a separate thread
46 With any of the first four options, IPython starts running a separate thread
47 47 for the graphical toolkit's operation, so that you can open and control
48 48 graphical elements from within an IPython command line, without blocking. All
49 three provide essentially the same functionality, respectively for GTK, QT and
50 WXWidgets (via their Python interfaces).
49 four provide essentially the same functionality, respectively for GTK, QT3, QT4
50 and WXWidgets (via their Python interfaces).
51 51 .br
52 52 .sp 1
53 53 Note that with \-wthread, you can additionally use the \-wxversion option to
54 54 request a specific version of wx to be used. This requires that you have the
55 55 'wxversion' Python module installed, which is part of recent wxPython
56 56 distributions.
57 57 .br
58 58 .sp 1
59 59 If \-pylab is given, IPython loads special support for the matplotlib library
60 60 (http://matplotlib.sourceforge.net), allowing interactive usage of any of its
61 61 backends as defined in the user's .matplotlibrc file. It automatically
62 62 activates GTK, QT or WX threading for IPyhton if the choice of matplotlib
63 63 backend requires it. It also modifies the %run command to correctly execute
64 64 (without blocking) any matplotlib-based script which calls show() at the end.
65 65 .TP
66 66 .B \-tk
67 The \-g/q/wthread options, and \-pylab (if matplotlib is configured to use
67 The \-g/q/q4/wthread options, and \-pylab (if matplotlib is configured to use
68 68 GTK, QT or WX), will normally block Tk graphical interfaces. This means that
69 69 when GTK, QT or WX threading is active, any attempt to open a Tk GUI will
70 70 result in a dead window, and possibly cause the Python interpreter to crash.
71 71 An extra option, \-tk, is available to address this issue. It can ONLY be
72 72 given as a SECOND option after any of the above (\-gthread, \-qthread,
73 73 \-wthread or \-pylab).
74 74 .br
75 75 .sp 1
76 76 If \-tk is given, IPython will try to coordinate Tk threading with GTK, QT or
77 77 WX. This is however potentially unreliable, and you will have to test on your
78 78 platform and Python configuration to determine whether it works for you.
79 79 Debian users have reported success, apparently due to the fact that Debian
80 80 builds all of Tcl, Tk, Tkinter and Python with pthreads support. Under other
81 81 Linux environments (such as Fedora Core 2), this option has caused random
82 82 crashes and lockups of the Python interpreter. Under other operating systems
83 83 (Mac OSX and Windows), you'll need to try it to find out, since currently no
84 84 user reports are available.
85 85 .br
86 86 .sp 1
87 87 There is unfortunately no way for IPython to determine at runtime whether \-tk
88 88 will work reliably or not, so you will need to do some experiments before
89 89 relying on it for regular work.
90 90 .
91 91 .SS A WARNING ABOUT SIGNALS AND THREADS
92 92 When any of the thread systems (GTK, QT or WX) are active, either directly or
93 93 via \-pylab with a threaded backend, it is impossible to interrupt
94 94 long-running Python code via Ctrl\-C. IPython can not pass the
95 95 KeyboardInterrupt exception (or the underlying SIGINT) across threads, so any
96 96 long-running process started from IPython will run to completion, or will have
97 97 to be killed via an external (OS-based) mechanism.
98 98 .br
99 99 .sp 1
100 100 To the best of my knowledge, this limitation is imposed by the Python
101 101 interpreter itself, and it comes from the difficulty of writing portable
102 102 signal/threaded code. If any user is an expert on this topic and can suggest
103 103 a better solution, I would love to hear about it. In the IPython sources,
104 104 look at the Shell.py module, and in particular at the runcode() method.
105 105 .
106 106 .SH REGULAR OPTIONS
107 107 After the above threading options have been given, regular options can follow
108 108 in any order. All options can be abbreviated to their shortest non-ambiguous
109 109 form and are case-sensitive. One or two dashes can be used. Some options
110 110 have an alternate short form, indicated after a |.
111 111 .br
112 112 .sp 1
113 113 Most options can also be set from your ipythonrc configuration file.
114 114 See the provided examples for assistance. Options given on the
115 115 commandline override the values set in the ipythonrc file.
116 116 .br
117 117 .sp 1
118 118 All options with a [no] prepended can be specified in negated form
119 119 (\-nooption instead of \-option) to turn the feature off.
120 120 .TP
121 121 .B \-h, \-\-help
122 122 Show summary of options.
123 123 .TP
124 124 .B \-autocall <val>
125 125 Make IPython automatically call any callable object even if you didn't type
126 126 explicit parentheses. For example, 'str 43' becomes
127 127 'str(43)' automatically. The value can be '0' to disable the
128 128 feature, '1' for 'smart' autocall, where it is not applied if
129 129 there are no more arguments on the line, and '2' for 'full'
130 130 autocall, where all callable objects are automatically called
131 131 (even if no arguments are present). The default is '1'.
132 132 .TP
133 133 .B \-[no]autoindent
134 134 Turn automatic indentation on/off.
135 135 .TP
136 136 .B \-[no]automagic
137 137 Make magic commands automatic (without needing their first character
138 138 to be %). Type %magic at the IPython prompt for more information.
139 139 .TP
140 140 .B \-[no]autoedit_syntax
141 141 When a syntax error occurs after editing a file, automatically open the file
142 142 to the trouble causing line for convenient fixing.
143 143 .TP
144 144 .B \-[no]banner
145 145 Print the intial information banner (default on).
146 146 .TP
147 147 .B \-c <command>
148 148 Execute the given command string, and set sys.argv to ['c']. This is similar
149 149 to the \-c option in the normal Python interpreter.
150 150 .TP
151 151 .B \-cache_size|cs <n>
152 152 Size of the output cache (maximum number of entries to hold in
153 153 memory). The default is 1000, you can change it permanently in your
154 154 config file. Setting it to 0 completely disables the caching system,
155 155 and the minimum value accepted is 20 (if you provide a value less than
156 156 20, it is reset to 0 and a warning is issued). This limit is defined
157 157 because otherwise you'll spend more time re-flushing a too small cache
158 158 than working.
159 159 .TP
160 160 .B \-classic|cl
161 161 Gives IPython a similar feel to the classic Python prompt.
162 162 .TP
163 163 .B \-colors <scheme>
164 164 Color scheme for prompts and exception reporting. Currently
165 165 implemented: NoColor, Linux, and LightBG.
166 166 .TP
167 167 .B \-[no]color_info
168 168 IPython can display information about objects via a set of functions,
169 169 and optionally can use colors for this, syntax highlighting source
170 170 code and various other elements. However, because this information is
171 171 passed through a pager (like 'less') and many pagers get confused with
172 172 color codes, this option is off by default. You can test it and turn
173 173 it on permanently in your ipythonrc file if it works for you. As a
174 174 reference, the 'less' pager supplied with Mandrake 8.2 works ok, but
175 175 that in RedHat 7.2 doesn't.
176 176 .br
177 177 .sp 1
178 178 Test it and turn it on permanently if it works with your system. The
179 179 magic function @color_info allows you to toggle this interactively for
180 180 testing.
181 181 .TP
182 182 .B \-[no]confirm_exit
183 183 Set to confirm when you try to exit IPython with an EOF (Control-D in
184 184 Unix, Control-Z/Enter in Windows). Note that using the magic functions
185 185 @Exit or @Quit you can force a direct exit, bypassing any
186 186 confirmation.
187 187 .TP
188 188 .B \-[no]debug
189 189 Show information about the loading process. Very useful to pin down
190 190 problems with your configuration files or to get details about session
191 191 restores.
192 192 .TP
193 193 .B \-[no]deep_reload
194 194 IPython can use the deep_reload module which reloads changes in
195 195 modules recursively (it replaces the reload() function, so you don't
196 196 need to change anything to use it). deep_reload() forces a full reload
197 197 of modules whose code may have changed, which the default reload()
198 198 function does not.
199 199 .br
200 200 .sp 1
201 201 When deep_reload is off, IPython will use the normal reload(), but
202 202 deep_reload will still be available as dreload(). This feature is off
203 203 by default [which means that you have both normal reload() and
204 204 dreload()].
205 205 .TP
206 206 .B \-editor <name>
207 207 Which editor to use with the @edit command. By default, IPython will
208 208 honor your EDITOR environment variable (if not set, vi is the Unix
209 209 default and notepad the Windows one). Since this editor is invoked on
210 210 the fly by IPython and is meant for editing small code snippets, you
211 211 may want to use a small, lightweight editor here (in case your default
212 212 EDITOR is something like Emacs).
213 213 .TP
214 214 .B \-ipythondir <name>
215 215 The name of your IPython configuration directory IPYTHONDIR. This can
216 216 also be specified through the environment variable IPYTHONDIR.
217 217 .TP
218 218 .B \-log|l
219 219 Generate a log file of all input. The file is named ipython_log.py in your
220 220 current directory (which prevents logs from multiple IPython sessions from
221 221 trampling each other). You can use this to later restore a session by loading
222 222 your logfile as a file to be executed with option -logplay (see below).
223 223 .TP
224 224 .B \-logfile|lf
225 225 Specify the name of your logfile.
226 226 .TP
227 227 .B \-logplay|lp
228 228 Replay a previous log. For restoring a session as close as possible to
229 229 the state you left it in, use this option (don't just run the
230 230 logfile). With \-logplay, IPython will try to reconstruct the previous
231 231 working environment in full, not just execute the commands in the
232 232 logfile.
233 233 .br
234 234 .sh 1
235 235 When a session is restored, logging is automatically turned on again
236 236 with the name of the logfile it was invoked with (it is read from the
237 237 log header). So once you've turned logging on for a session, you can
238 238 quit IPython and reload it as many times as you want and it will
239 239 continue to log its history and restore from the beginning every time.
240 240 .br
241 241 .sp 1
242 242 Caveats: there are limitations in this option. The history variables
243 243 _i*,_* and _dh don't get restored properly. In the future we will try
244 244 to implement full session saving by writing and retrieving a
245 245 'snapshot' of the memory state of IPython. But our first attempts
246 246 failed because of inherent limitations of Python's Pickle module, so
247 247 this may have to wait.
248 248 .TP
249 249 .B \-[no]messages
250 250 Print messages which IPython collects about its startup process
251 251 (default on).
252 252 .TP
253 253 .B \-[no]pdb
254 254 Automatically call the pdb debugger after every uncaught exception. If
255 255 you are used to debugging using pdb, this puts you automatically
256 256 inside of it after any call (either in IPython or in code called by
257 257 it) which triggers an exception which goes uncaught.
258 258 .TP
259 259 .B \-[no]pprint
260 260 IPython can optionally use the pprint (pretty printer) module for
261 261 displaying results. pprint tends to give a nicer display of nested
262 262 data structures. If you like it, you can turn it on permanently in
263 263 your config file (default off).
264 264 .TP
265 265 .B \-profile|p <name>
266 266 Assume that your config file is ipythonrc-<name> (looks in current dir
267 267 first, then in IPYTHONDIR). This is a quick way to keep and load
268 268 multiple config files for different tasks, especially if you use the
269 269 include option of config files. You can keep a basic
270 270 IPYTHONDIR/ipythonrc file and then have other 'profiles' which include
271 271 this one and load extra things for particular tasks. For example:
272 272 .br
273 273 .sp 1
274 274 1) $HOME/.ipython/ipythonrc : load basic things you always want.
275 275 .br
276 276 2) $HOME/.ipython/ipythonrc-math : load (1) and basic math-related
277 277 modules.
278 278 .br
279 279 3) $HOME/.ipython/ipythonrc-numeric : load (1) and Numeric and
280 280 plotting modules.
281 281 .br
282 282 .sp 1
283 283 Since it is possible to create an endless loop by having circular file
284 284 inclusions, IPython will stop if it reaches 15 recursive inclusions.
285 285 .TP
286 286 .B \-prompt_in1|pi1 <string>
287 287 Specify the string used for input prompts. Note that if you are using
288 288 numbered prompts, the number is represented with a '\\#' in the
289 289 string. Don't forget to quote strings with spaces embedded in
290 290 them. Default: 'In [\\#]: '.
291 291 .br
292 292 .sp 1
293 293 Most bash-like escapes can be used to customize IPython's prompts, as well as
294 294 a few additional ones which are IPython-specific. All valid prompt escapes
295 295 are described in detail in the Customization section of the IPython HTML/PDF
296 296 manual.
297 297 .TP
298 298 .B \-prompt_in2|pi2 <string>
299 299 Similar to the previous option, but used for the continuation prompts. The
300 300 special sequence '\\D' is similar to '\\#', but with all digits replaced dots
301 301 (so you can have your continuation prompt aligned with your input
302 302 prompt). Default: ' .\\D.: ' (note three spaces at the start for alignment
303 303 with 'In [\\#]').
304 304 .TP
305 305 .B \-prompt_out|po <string>
306 306 String used for output prompts, also uses numbers like prompt_in1.
307 307 Default: 'Out[\\#]:'.
308 308 .TP
309 309 .B \-quick
310 310 Start in bare bones mode (no config file loaded).
311 311 .TP
312 312 .B \-rcfile <name>
313 313 Name of your IPython resource configuration file. normally IPython
314 314 loads ipythonrc (from current directory) or IPYTHONDIR/ipythonrc. If
315 315 the loading of your config file fails, IPython starts with a bare
316 316 bones configuration (no modules loaded at all).
317 317 .TP
318 318 .B \-[no]readline
319 319 Use the readline library, which is needed to support name completion
320 320 and command history, among other things. It is enabled by default, but
321 321 may cause problems for users of X/Emacs in Python comint or shell
322 322 buffers.
323 323 .br
324 324 .sp 1
325 325 Note that emacs 'eterm' buffers (opened with M-x term) support
326 326 IPython's readline and syntax coloring fine, only 'emacs' (M-x shell
327 327 and C-c !) buffers do not.
328 328 .TP
329 329 .B \-screen_length|sl <n>
330 330 Number of lines of your screen. This is used to control printing of
331 331 very long strings. Strings longer than this number of lines will be
332 332 sent through a pager instead of directly printed.
333 333 .br
334 334 .sp 1
335 335 The default value for this is 0, which means IPython will auto-detect
336 336 your screen size every time it needs to print certain potentially long
337 337 strings (this doesn't change the behavior of the 'print' keyword, it's
338 338 only triggered internally). If for some reason this isn't working well
339 339 (it needs curses support), specify it yourself. Otherwise don't change
340 340 the default.
341 341 .TP
342 342 .B \-separate_in|si <string>
343 343 Separator before input prompts. Default '\n'.
344 344 .TP
345 345 .B \-separate_out|so <string>
346 346 Separator before output prompts. Default: 0 (nothing).
347 347 .TP
348 348 .B \-separate_out2|so2 <string>
349 349 Separator after output prompts. Default: 0 (nothing).
350 350 .TP
351 351 .B \-nosep
352 352 Shorthand for '\-separate_in 0 \-separate_out 0 \-separate_out2 0'.
353 353 Simply removes all input/output separators.
354 354 .TP
355 355 .B \-upgrade
356 356 Allows you to upgrade your IPYTHONDIR configuration when you install a
357 357 new version of IPython. Since new versions may include new command
358 358 lines options or example files, this copies updated ipythonrc-type
359 359 files. However, it backs up (with a .old extension) all files which
360 360 it overwrites so that you can merge back any custimizations you might
361 361 have in your personal files.
362 362 .TP
363 363 .B \-Version
364 364 Print version information and exit.
365 365 .TP
366 366 .B -wxversion <string>
367 367 Select a specific version of wxPython (used in conjunction with
368 368 \-wthread). Requires the wxversion module, part of recent wxPython
369 369 distributions.
370 370 .TP
371 371 .B \-xmode <modename>
372 372 Mode for exception reporting. The valid modes are Plain, Context, and
373 373 Verbose.
374 374 .br
375 375 .sp 1
376 376 \- Plain: similar to python's normal traceback printing.
377 377 .br
378 378 .sp 1
379 379 \- Context: prints 5 lines of context source code around each line in the
380 380 traceback.
381 381 .br
382 382 .sp 1
383 383 \- Verbose: similar to Context, but additionally prints the variables
384 384 currently visible where the exception happened (shortening their strings if
385 385 too long). This can potentially be very slow, if you happen to have a huge
386 386 data structure whose string representation is complex to compute. Your
387 387 computer may appear to freeze for a while with cpu usage at 100%. If this
388 388 occurs, you can cancel the traceback with Ctrl-C (maybe hitting it more than
389 389 once).
390 390 .
391 391 .SH EMBEDDING
392 392 It is possible to start an IPython instance inside your own Python
393 393 programs. In the documentation example files there are some
394 394 illustrations on how to do this.
395 395 .br
396 396 .sp 1
397 397 This feature allows you to evalutate dynamically the state of your
398 398 code, operate with your variables, analyze them, etc. Note however
399 399 that any changes you make to values while in the shell do NOT
400 400 propagate back to the running code, so it is safe to modify your
401 401 values because you won't break your code in bizarre ways by doing so.
402 402 .SH AUTHOR
403 403 IPython was written by Fernando Perez <fperez@colorado.edu>, based on earlier
404 404 code by Janko Hauser <jh@comunit.de> and Nathaniel Gray
405 405 <n8gray@caltech.edu>. This manual page was written by Jack Moffitt
406 406 <jack@xiph.org>, for the Debian project (but may be used by others).
This diff has been collapsed as it changes many lines, (8815 lines changed) Show them Hide them
@@ -1,9549 +1,10460 b''
1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
2 \lyxformat 221
1 #LyX 1.4.3 created this file. For more info see http://www.lyx.org/
2 \lyxformat 245
3 \begin_document
4 \begin_header
3 5 \textclass article
4 6 \begin_preamble
5 7 %\usepackage{ae,aecompl}
6 8 \usepackage{color}
7 9
8 10 % A few colors to replace the defaults for certain link types
9 11 \definecolor{orange}{cmyk}{0,0.4,0.8,0.2}
10 12 \definecolor{darkorange}{rgb}{.71,0.21,0.01}
11 13 \definecolor{darkred}{rgb}{.52,0.08,0.01}
12 14 \definecolor{darkgreen}{rgb}{.12,.54,.11}
13 15
14 16 % Use and configure listings package for nicely formatted code
15 17 \usepackage{listings}
16 18 \lstset{
17 19 language=Python,
18 20 basicstyle=\small\ttfamily,
19 21 commentstyle=\ttfamily\color{blue},
20 22 stringstyle=\ttfamily\color{darkorange},
21 23 showstringspaces=false,
22 24 breaklines=true,
23 25 postbreak = \space\dots
24 26 }
25 27
26 28 \usepackage[%pdftex, % needed for pdflatex
27 29 breaklinks=true, % so long urls are correctly broken across lines
28 30 colorlinks=true,
29 31 urlcolor=blue,
30 32 linkcolor=darkred,
31 33 citecolor=darkgreen,
32 34 ]{hyperref}
33 35
34 36 \usepackage{html}
35 37
36 38 % This helps prevent overly long lines that stretch beyond the margins
37 39 \sloppy
38 40
39 41 % Define a \codelist command which either uses listings for latex, or
40 42 % plain verbatim for html (since latex2html doesn't understand the
41 43 % listings package).
42 44 \usepackage{verbatim}
43 45 \newcommand{\codelist}[1] {
44 46 \latex{\lstinputlisting{#1}}
45 47 \html{\verbatiminput{#1}}
46 48 }
47 49 \end_preamble
48 50 \language english
49 51 \inputencoding latin1
50 52 \fontscheme palatino
51 53 \graphics default
52 54 \paperfontsize 11
53 \spacing single
54 \papersize Default
55 \paperpackage a4
56 \use_geometry 1
57 \use_amsmath 0
58 \use_natbib 0
59 \use_numerical_citations 0
55 \spacing single
56 \papersize default
57 \use_geometry true
58 \use_amsmath 1
59 \cite_engine basic
60 \use_bibtopic false
60 61 \paperorientation portrait
61 62 \leftmargin 1in
62 63 \topmargin 1in
63 64 \rightmargin 1in
64 65 \bottommargin 1in
65 66 \secnumdepth 3
66 67 \tocdepth 3
67 68 \paragraph_separation skip
68 69 \defskip medskip
69 70 \quotes_language english
70 \quotes_times 2
71 71 \papercolumns 1
72 72 \papersides 2
73 73 \paperpagestyle fancy
74 \tracking_changes false
75 \output_changes true
76 \end_header
74 77
75 \layout Title
78 \begin_body
76 79
80 \begin_layout Title
77 81 IPython
78 \newline
82 \newline
79 83
80 \size larger
84 \size larger
81 85 An enhanced Interactive Python
82 \size large
86 \size large
83 87
84 \newline
88 \newline
85 89 User Manual, v.
86 90 __version__
87 \layout Author
91 \end_layout
88 92
93 \begin_layout Author
89 94 Fernando PοΏ½rez
90 95 \begin_inset Foot
91 collapsed true
96 status collapsed
92 97
93 \layout Standard
98 \begin_layout Standard
94 99
95
96 \size scriptsize
100 \size scriptsize
97 101 Department of Applied Mathematics, University of Colorado at Boulder.
98 102
99 \family typewriter
103 \family typewriter
100 104 <Fernando.Perez@colorado.edu>
101 \end_inset
105 \end_layout
102 106
107 \end_inset
103 108
104 \layout Standard
105 109
110 \end_layout
106 111
112 \begin_layout Standard
107 113 \begin_inset ERT
108 status Collapsed
114 status collapsed
115
116 \begin_layout Standard
109 117
110 \layout Standard
111 118
112 \backslash
119 \backslash
113 120 latex{
114 \end_inset
121 \end_layout
122
123 \end_inset
115 124
116 125
117 126 \begin_inset LatexCommand \tableofcontents{}
118 127
119 \end_inset
128 \end_inset
120 129
121 130
122 131 \begin_inset ERT
123 status Collapsed
132 status collapsed
133
134 \begin_layout Standard
124 135
125 \layout Standard
126 136 }
127 \end_inset
137 \end_layout
128 138
139 \end_inset
129 140
130 \layout Standard
131 141
142 \end_layout
132 143
144 \begin_layout Standard
133 145 \begin_inset ERT
134 status Open
146 status open
135 147
136 \layout Standard
148 \begin_layout Standard
137 149
138 \backslash
150
151 \backslash
139 152 html{
140 \backslash
153 \backslash
141 154 bodytext{bgcolor=#ffffff}}
142 \end_inset
155 \end_layout
156
157 \end_inset
158
143 159
160 \end_layout
144 161
145 \layout Section
146 \pagebreak_top
162 \begin_layout Standard
163
164 \newpage
165
166 \end_layout
167
168 \begin_layout Section
147 169 Overview
148 \layout Standard
170 \end_layout
149 171
172 \begin_layout Standard
150 173 One of Python's most useful features is its interactive interpreter.
151 174 This system allows very fast testing of ideas without the overhead of creating
152 175 test files as is typical in most programming languages.
153 176 However, the interpreter supplied with the standard Python distribution
154 177 is somewhat limited for extended interactive use.
155 \layout Standard
178 \end_layout
156 179
180 \begin_layout Standard
157 181 IPython is a free software project (released under the BSD license) which
158 182 tries to:
159 \layout Enumerate
183 \end_layout
160 184
185 \begin_layout Enumerate
161 186 Provide an interactive shell superior to Python's default.
162 187 IPython has many features for object introspection, system shell access,
163 188 and its own special command system for adding functionality when working
164 189 interactively.
165 190 It tries to be a very efficient environment both for Python code development
166 191 and for exploration of problems using Python objects (in situations like
167 192 data analysis).
168 \layout Enumerate
193 \end_layout
169 194
195 \begin_layout Enumerate
170 196 Serve as an embeddable, ready to use interpreter for your own programs.
171 197 IPython can be started with a single call from inside another program,
172 198 providing access to the current namespace.
173 199 This can be very useful both for debugging purposes and for situations
174 200 where a blend of batch-processing and interactive exploration are needed.
175 \layout Enumerate
201 \end_layout
176 202
203 \begin_layout Enumerate
177 204 Offer a flexible framework which can be used as the base environment for
178 205 other systems with Python as the underlying language.
179 206 Specifically scientific environments like Mathematica, IDL and Matlab inspired
180 207 its design, but similar ideas can be useful in many fields.
181 \layout Enumerate
208 \end_layout
182 209
210 \begin_layout Enumerate
183 211 Allow interactive testing of threaded graphical toolkits.
184 212 IPython has support for interactive, non-blocking control of GTK, Qt and
185 213 WX applications via special threading flags.
186 214 The normal Python shell can only do this for Tkinter applications.
187 \layout Subsection
215 \end_layout
188 216
217 \begin_layout Subsection
189 218 Main features
190 \layout Itemize
219 \end_layout
191 220
221 \begin_layout Itemize
192 222 Dynamic object introspection.
193 223 One can access docstrings, function definition prototypes, source code,
194 224 source files and other details of any object accessible to the interpreter
195 225 with a single keystroke (`
196 \family typewriter
226 \family typewriter
197 227 ?
198 \family default
228 \family default
199 229 ', and using `
200 \family typewriter
230 \family typewriter
201 231 ??
202 \family default
232 \family default
203 233 ' provides additional detail).
204 \layout Itemize
234 \end_layout
205 235
236 \begin_layout Itemize
206 237 Searching through modules and namespaces with `
207 \family typewriter
238 \family typewriter
208 239 *
209 \family default
240 \family default
210 241 ' wildcards, both when using the `
211 \family typewriter
242 \family typewriter
212 243 ?
213 \family default
244 \family default
214 245 ' system and via the
215 \family typewriter
246 \family typewriter
216 247 %psearch
217 \family default
248 \family default
218 249 command.
219 \layout Itemize
250 \end_layout
220 251
252 \begin_layout Itemize
221 253 Completion in the local namespace, by typing TAB at the prompt.
222 254 This works for keywords, methods, variables and files in the current directory.
223 255 This is supported via the readline library, and full access to configuring
224 256 readline's behavior is provided.
225 \layout Itemize
257 \end_layout
226 258
259 \begin_layout Itemize
227 260 Numbered input/output prompts with command history (persistent across sessions
228 261 and tied to each profile), full searching in this history and caching of
229 262 all input and output.
230 \layout Itemize
263 \end_layout
231 264
265 \begin_layout Itemize
232 266 User-extensible `magic' commands.
233 267 A set of commands prefixed with
234 \family typewriter
268 \family typewriter
235 269 %
236 \family default
270 \family default
237 271 is available for controlling IPython itself and provides directory control,
238 272 namespace information and many aliases to common system shell commands.
239 \layout Itemize
273 \end_layout
240 274
275 \begin_layout Itemize
241 276 Alias facility for defining your own system aliases.
242 \layout Itemize
277 \end_layout
243 278
279 \begin_layout Itemize
244 280 Complete system shell access.
245 281 Lines starting with ! are passed directly to the system shell, and using
246 282 !! captures shell output into python variables for further use.
247 \layout Itemize
283 \end_layout
248 284
285 \begin_layout Itemize
249 286 Background execution of Python commands in a separate thread.
250 287 IPython has an internal job manager called
251 \family typewriter
288 \family typewriter
252 289 jobs
253 \family default
290 \family default
254 291 , and a conveninence backgrounding magic function called
255 \family typewriter
292 \family typewriter
256 293 %bg
257 \family default
294 \family default
258 295 .
259 \layout Itemize
296 \end_layout
260 297
298 \begin_layout Itemize
261 299 The ability to expand python variables when calling the system shell.
262 300 In a shell command, any python variable prefixed with
263 \family typewriter
301 \family typewriter
264 302 $
265 \family default
303 \family default
266 304 is expanded.
267 305 A double
268 \family typewriter
306 \family typewriter
269 307 $$
270 \family default
308 \family default
271 309 allows passing a literal
272 \family typewriter
310 \family typewriter
273 311 $
274 \family default
312 \family default
275 313 to the shell (for access to shell and environment variables like
276 \family typewriter
314 \family typewriter
277 315 $PATH
278 \family default
316 \family default
279 317 ).
280 \layout Itemize
318 \end_layout
281 319
320 \begin_layout Itemize
282 321 Filesystem navigation, via a magic
283 \family typewriter
322 \family typewriter
284 323 %cd
285 \family default
324 \family default
286 325 command, along with a persistent bookmark system (using
287 \family typewriter
326 \family typewriter
288 327 %bookmark
289 \family default
328 \family default
290 329 ) for fast access to frequently visited directories.
291 \layout Itemize
330 \end_layout
292 331
332 \begin_layout Itemize
293 333 A lightweight persistence framework via the
294 \family typewriter
334 \family typewriter
295 335 %store
296 \family default
336 \family default
297 337 command, which allows you to save arbitrary Python variables.
298 338 These get restored automatically when your session restarts.
299 \layout Itemize
339 \end_layout
300 340
341 \begin_layout Itemize
301 342 Automatic indentation (optional) of code as you type (through the readline
302 343 library).
303 \layout Itemize
344 \end_layout
304 345
346 \begin_layout Itemize
305 347 Macro system for quickly re-executing multiple lines of previous input with
306 348 a single name.
307 349 Macros can be stored persistently via
308 \family typewriter
350 \family typewriter
309 351 %store
310 \family default
352 \family default
311 353 and edited via
312 \family typewriter
354 \family typewriter
313 355 %edit
314 \family default
356 \family default
315 357 .
316 358
317 \layout Itemize
359 \end_layout
318 360
361 \begin_layout Itemize
319 362 Session logging (you can then later use these logs as code in your programs).
320 363 Logs can optionally timestamp all input, and also store session output
321 364 (marked as comments, so the log remains valid Python source code).
322 \layout Itemize
365 \end_layout
323 366
367 \begin_layout Itemize
324 368 Session restoring: logs can be replayed to restore a previous session to
325 369 the state where you left it.
326 \layout Itemize
370 \end_layout
327 371
372 \begin_layout Itemize
328 373 Verbose and colored exception traceback printouts.
329 374 Easier to parse visually, and in verbose mode they produce a lot of useful
330 375 debugging information (basically a terminal version of the cgitb module).
331 \layout Itemize
376 \end_layout
332 377
378 \begin_layout Itemize
333 379 Auto-parentheses: callable objects can be executed without parentheses:
334 380
335 \family typewriter
381 \family typewriter
336 382 `sin 3'
337 \family default
383 \family default
338 384 is automatically converted to
339 \family typewriter
385 \family typewriter
340 386 `sin(3)
341 \family default
387 \family default
342 388 '.
343 \layout Itemize
389 \end_layout
344 390
391 \begin_layout Itemize
345 392 Auto-quoting: using `
346 \family typewriter
393 \family typewriter
347 394 ,
348 \family default
395 \family default
349 396 ' or `
350 \family typewriter
397 \family typewriter
351 398 ;
352 \family default
399 \family default
353 400 ' as the first character forces auto-quoting of the rest of the line:
354 \family typewriter
355 `,my_function a\SpecialChar ~
401 \family typewriter
402 `,my_function a\InsetSpace ~
356 403 b'
357 \family default
404 \family default
358 405 becomes automatically
359 \family typewriter
406 \family typewriter
360 407 `my_function("a","b")'
361 \family default
408 \family default
362 409 , while
363 \family typewriter
364 `;my_function a\SpecialChar ~
410 \family typewriter
411 `;my_function a\InsetSpace ~
365 412 b'
366 \family default
413 \family default
367 414 becomes
368 \family typewriter
415 \family typewriter
369 416 `my_function("a b")'
370 \family default
417 \family default
371 418 .
372 \layout Itemize
419 \end_layout
373 420
421 \begin_layout Itemize
374 422 Extensible input syntax.
375 423 You can define filters that pre-process user input to simplify input in
376 424 special situations.
377 425 This allows for example pasting multi-line code fragments which start with
378 426
379 \family typewriter
427 \family typewriter
380 428 `>>>'
381 \family default
429 \family default
382 430 or
383 \family typewriter
431 \family typewriter
384 432 `...'
385 \family default
433 \family default
386 434 such as those from other python sessions or the standard Python documentation.
387 \layout Itemize
435 \end_layout
388 436
437 \begin_layout Itemize
389 438 Flexible configuration system.
390 439 It uses a configuration file which allows permanent setting of all command-line
391 440 options, module loading, code and file execution.
392 441 The system allows recursive file inclusion, so you can have a base file
393 442 with defaults and layers which load other customizations for particular
394 443 projects.
395 \layout Itemize
444 \end_layout
396 445
446 \begin_layout Itemize
397 447 Embeddable.
398 448 You can call IPython as a python shell inside your own python programs.
399 449 This can be used both for debugging code or for providing interactive abilities
400 450 to your programs with knowledge about the local namespaces (very useful
401 451 in debugging and data analysis situations).
402 \layout Itemize
452 \end_layout
403 453
454 \begin_layout Itemize
404 455 Easy debugger access.
405 456 You can set IPython to call up an enhanced version of the Python debugger
406 457 (
407 \family typewriter
458 \family typewriter
408 459 pdb
409 \family default
460 \family default
410 461 ) every time there is an uncaught exception.
411 462 This drops you inside the code which triggered the exception with all the
412 463 data live and it is possible to navigate the stack to rapidly isolate the
413 464 source of a bug.
414 465 The
415 \family typewriter
466 \family typewriter
416 467 %run
417 \family default
468 \family default
418 469 magic command --with the
419 \family typewriter
470 \family typewriter
420 471 -d
421 \family default
472 \family default
422 473 option-- can run any script under
423 \family typewriter
474 \family typewriter
424 475 pdb
425 \family default
476 \family default
426 477 's control, automatically setting initial breakpoints for you.
427 478 This version of
428 \family typewriter
479 \family typewriter
429 480 pdb
430 \family default
481 \family default
431 482 has IPython-specific improvements, including tab-completion and traceback
432 483 coloring support.
433 \layout Itemize
484 \end_layout
434 485
486 \begin_layout Itemize
435 487 Profiler support.
436 488 You can run single statements (similar to
437 \family typewriter
489 \family typewriter
438 490 profile.run()
439 \family default
491 \family default
440 492 ) or complete programs under the profiler's control.
441 493 While this is possible with standard
442 \family typewriter
494 \family typewriter
443 495 cProfile
444 \family default
496 \family default
445 497 or
446 \family typewriter
498 \family typewriter
447 499 profile
448 \family default
500 \family default
449 501 modules, IPython wraps this functionality with magic commands (see
450 \family typewriter
502 \family typewriter
451 503 `%prun'
452 \family default
504 \family default
453 505 and
454 \family typewriter
506 \family typewriter
455 507 `%run -p
456 \family default
508 \family default
457 509 ') convenient for rapid interactive work.
458 \layout Subsection
510 \end_layout
459 511
512 \begin_layout Subsection
460 513 Portability and Python requirements
461 \layout Standard
514 \end_layout
462 515
516 \begin_layout Standard
463 517
464 \series bold
518 \series bold
465 519 Python requirements:
466 \series default
520 \series default
467 521 IPython requires with Python version 2.3 or newer.
468 522 If you are still using Python 2.2 and can not upgrade, the last version
469 523 of IPython which worked with Python 2.2 was 0.6.15, so you will have to use
470 524 that.
471 \layout Standard
525 \end_layout
472 526
527 \begin_layout Standard
473 528 IPython is developed under
474 \series bold
529 \series bold
475 530 Linux
476 \series default
531 \series default
477 532 , but it should work in any reasonable Unix-type system (tested OK under
478 533 Solaris and the *BSD family, for which a port exists thanks to Dryice Liu).
479 \layout Standard
534 \end_layout
480 535
536 \begin_layout Standard
481 537
482 \series bold
538 \series bold
483 539 Mac OS X
484 \series default
540 \series default
485 541 : it works, apparently without any problems (thanks to Jim Boyle at Lawrence
486 542 Livermore for the information).
487 543 Thanks to Andrea Riciputi, Fink support is available.
488 \layout Standard
544 \end_layout
489 545
546 \begin_layout Standard
490 547
491 \series bold
548 \series bold
492 549 CygWin
493 \series default
550 \series default
494 551 : it works mostly OK, though some users have reported problems with prompt
495 552 coloring.
496 553 No satisfactory solution to this has been found so far, you may want to
497 554 disable colors permanently in the
498 \family typewriter
555 \family typewriter
499 556 ipythonrc
500 \family default
557 \family default
501 558 configuration file if you experience problems.
502 559 If you have proper color support under cygwin, please post to the IPython
503 560 mailing list so this issue can be resolved for all users.
504 \layout Standard
561 \end_layout
505 562
563 \begin_layout Standard
506 564
507 \series bold
565 \series bold
508 566 Windows
509 \series default
567 \series default
510 568 : it works well under Windows XP/2k, and I suspect NT should behave similarly.
511 Section\SpecialChar ~
569 Section\InsetSpace ~
512 570
513 571 \begin_inset LatexCommand \ref{sub:Under-Windows}
514 572
515 \end_inset
573 \end_inset
516 574
517 575 describes installation details for Windows, including some additional tools
518 576 needed on this platform.
519 \layout Standard
577 \end_layout
520 578
579 \begin_layout Standard
521 580 Windows 9x support is present, and has been reported to work fine (at least
522 581 on WinME).
523 \layout Standard
582 \end_layout
524 583
584 \begin_layout Standard
525 585 Note, that I have very little access to and experience with Windows development.
526 586 However, an excellent group of Win32 users (led by Ville Vainio), consistently
527 587 contribute bugfixes and platform-specific enhancements, so they more than
528 588 make up for my deficiencies on that front.
529 In fact, Win32 users report using IPython as a system shell (see Sec.\SpecialChar ~
589 In fact, Win32 users report using IPython as a system shell (see Sec.\InsetSpace ~
530 590
531 591 \begin_inset LatexCommand \ref{sec:IPython-as-shell}
532 592
533 \end_inset
593 \end_inset
534 594
535 595 for details), as it offers a level of control and features which the default
536 596
537 \family typewriter
597 \family typewriter
538 598 cmd.exe
539 \family default
599 \family default
540 600 doesn't provide.
541 \layout Subsection
601 \end_layout
542 602
603 \begin_layout Subsection
543 604 Location
544 \layout Standard
605 \end_layout
545 606
607 \begin_layout Standard
546 608 IPython is generously hosted at
547 609 \begin_inset LatexCommand \htmlurl{http://ipython.scipy.org}
548 610
549 \end_inset
611 \end_inset
550 612
551 613 by the Enthought, Inc and the SciPy project.
552 614 This site offers downloads, subversion access, mailing lists and a bug
553 615 tracking system.
554 616 I am very grateful to Enthought (
555 617 \begin_inset LatexCommand \htmlurl{http://www.enthought.com}
556 618
557 \end_inset
619 \end_inset
558 620
559 621 ) and all of the SciPy team for their contribution.
560 \layout Section
561
622 \end_layout
562 623
624 \begin_layout Section
563 625 \begin_inset LatexCommand \label{sec:install}
564 626
565 \end_inset
627 \end_inset
566 628
567 629 Installation
568 \layout Subsection
630 \end_layout
569 631
632 \begin_layout Subsection
570 633 Instant instructions
571 \layout Standard
634 \end_layout
572 635
636 \begin_layout Standard
573 637 If you are of the impatient kind, under Linux/Unix simply untar/unzip the
574 638 download, then install with
575 \family typewriter
639 \family typewriter
576 640 `python setup.py install'
577 \family default
641 \family default
578 642 .
579 643 Under Windows, double-click on the provided
580 \family typewriter
644 \family typewriter
581 645 .exe
582 \family default
646 \family default
583 647 binary installer.
584 \layout Standard
648 \end_layout
585 649
650 \begin_layout Standard
586 651 Then, take a look at Sections
587 652 \begin_inset LatexCommand \ref{sec:good_config}
588 653
589 \end_inset
654 \end_inset
590 655
591 656 for configuring things optimally and
592 657 \begin_inset LatexCommand \ref{sec:quick_tips}
593 658
594 \end_inset
659 \end_inset
595 660
596 661 for quick tips on efficient use of IPython.
597 662 You can later refer to the rest of the manual for all the gory details.
598 \layout Standard
663 \end_layout
599 664
665 \begin_layout Standard
600 666 See the notes in sec.
601 667
602 668 \begin_inset LatexCommand \ref{sec:upgrade}
603 669
604 \end_inset
670 \end_inset
605 671
606 672 for upgrading IPython versions.
607 \layout Subsection
673 \end_layout
608 674
675 \begin_layout Subsection
609 676 Detailed Unix instructions (Linux, Mac OS X, etc.)
610 \layout Standard
677 \end_layout
611 678
679 \begin_layout Standard
612 680 For RPM based systems, simply install the supplied package in the usual
613 681 manner.
614 682 If you download the tar archive, the process is:
615 \layout Enumerate
683 \end_layout
616 684
685 \begin_layout Enumerate
617 686 Unzip/untar the
618 \family typewriter
687 \family typewriter
619 688 ipython-XXX.tar.gz
620 \family default
689 \family default
621 690 file wherever you want (
622 \family typewriter
691 \family typewriter
623 692 XXX
624 \family default
693 \family default
625 694 is the version number).
626 695 It will make a directory called
627 \family typewriter
696 \family typewriter
628 697 ipython-XXX.
629 698
630 \family default
699 \family default
631 700 Change into that directory where you will find the files
632 \family typewriter
701 \family typewriter
633 702 README
634 \family default
703 \family default
635 704 and
636 \family typewriter
705 \family typewriter
637 706 setup.py
638 \family default
707 \family default
639 708 .
640 709
641 \family typewriter
710 \family typewriter
642 711 O
643 \family default
712 \family default
644 713 nce you've completed the installation, you can safely remove this directory.
645 714
646 \layout Enumerate
715 \end_layout
647 716
717 \begin_layout Enumerate
648 718 If you are installing over a previous installation of version 0.2.0 or earlier,
649 719 first remove your
650 \family typewriter
720 \family typewriter
651 721 $HOME/.ipython
652 \family default
722 \family default
653 723 directory, since the configuration file format has changed somewhat (the
654 724 '=' were removed from all option specifications).
655 725 Or you can call ipython with the
656 \family typewriter
726 \family typewriter
657 727 -upgrade
658 \family default
728 \family default
659 729 option and it will do this automatically for you.
660 \layout Enumerate
730 \end_layout
661 731
732 \begin_layout Enumerate
662 733 IPython uses distutils, so you can install it by simply typing at the system
663 734 prompt (don't type the
664 \family typewriter
735 \family typewriter
665 736 $
666 \family default
737 \family default
667 738 )
668 \newline
739 \newline
669 740
670 \family typewriter
741 \family typewriter
671 742 $ python setup.py install
672 \family default
743 \family default
673 744
674 \newline
745 \newline
675 746 Note that this assumes you have root access to your machine.
676 747 If you don't have root access or don't want IPython to go in the default
677 748 python directories, you'll need to use the
678 749 \begin_inset ERT
679 status Collapsed
750 status collapsed
751
752 \begin_layout Standard
680 753
681 \layout Standard
682 754
683 \backslash
755 \backslash
684 756 verb|--home|
685 \end_inset
757 \end_layout
758
759 \end_inset
686 760
687 761 option (or
688 762 \begin_inset ERT
689 status Collapsed
763 status collapsed
690 764
691 \layout Standard
765 \begin_layout Standard
692 766
693 \backslash
767
768 \backslash
694 769 verb|--prefix|
695 \end_inset
770 \end_layout
771
772 \end_inset
696 773
697 774 ).
698 775 For example:
699 \newline
776 \newline
700 777
701 778 \begin_inset ERT
702 status Collapsed
779 status collapsed
703 780
704 \layout Standard
781 \begin_layout Standard
705 782
706 \backslash
783
784 \backslash
707 785 verb|$ python setup.py install --home $HOME/local|
708 \end_inset
786 \end_layout
787
788 \end_inset
709 789
710 790
711 \newline
791 \newline
712 792 will install IPython into
713 \family typewriter
793 \family typewriter
714 794 $HOME/local
715 \family default
795 \family default
716 796 and its subdirectories (creating them if necessary).
717 \newline
797 \newline
718 798 You can type
719 \newline
799 \newline
720 800
721 801 \begin_inset ERT
722 status Collapsed
802 status collapsed
723 803
724 \layout Standard
804 \begin_layout Standard
725 805
726 \backslash
806
807 \backslash
727 808 verb|$ python setup.py --help|
728 \end_inset
809 \end_layout
810
811 \end_inset
729 812
730 813
731 \newline
814 \newline
732 815 for more details.
733 \newline
816 \newline
734 817 Note that if you change the default location for
735 818 \begin_inset ERT
736 status Collapsed
819 status collapsed
820
821 \begin_layout Standard
737 822
738 \layout Standard
739 823
740 \backslash
824 \backslash
741 825 verb|--home|
742 \end_inset
826 \end_layout
827
828 \end_inset
743 829
744 830 at installation, IPython may end up installed at a location which is not
745 831 part of your
746 \family typewriter
832 \family typewriter
747 833 $PYTHONPATH
748 \family default
834 \family default
749 835 environment variable.
750 836 In this case, you'll need to configure this variable to include the actual
751 837 directory where the
752 \family typewriter
838 \family typewriter
753 839 IPython/
754 \family default
840 \family default
755 841 directory ended (typically the value you give to
756 842 \begin_inset ERT
757 status Collapsed
843 status collapsed
844
845 \begin_layout Standard
758 846
759 \layout Standard
760 847
761 \backslash
848 \backslash
762 849 verb|--home|
763 \end_inset
850 \end_layout
851
852 \end_inset
764 853
765 854 plus
766 \family typewriter
855 \family typewriter
767 856 /lib/python
768 \family default
857 \family default
769 858 ).
770 \layout Subsubsection
859 \end_layout
771 860
861 \begin_layout Subsubsection
772 862 Mac OSX information
773 \layout Standard
863 \end_layout
774 864
865 \begin_layout Standard
775 866 Under OSX, there is a choice you need to make.
776 867 Apple ships its own build of Python, which lives in the core OSX filesystem
777 868 hierarchy.
778 869 You can also manually install a separate Python, either purely by hand
779 870 (typically in
780 \family typewriter
871 \family typewriter
781 872 /usr/local
782 \family default
873 \family default
783 874 ) or by using Fink, which puts everything under
784 \family typewriter
875 \family typewriter
785 876 /sw
786 \family default
877 \family default
787 878 .
788 879 Which route to follow is a matter of personal preference, as I've seen
789 880 users who favor each of the approaches.
790 881 Here I will simply list the known installation issues under OSX, along
791 882 with their solutions.
792 \layout Standard
883 \end_layout
793 884
885 \begin_layout Standard
794 886 This page:
795 887 \begin_inset LatexCommand \htmlurl{http://geosci.uchicago.edu/~tobis/pylab.html}
796 888
797 \end_inset
889 \end_inset
798 890
799 891 contains information on this topic, with additional details on how to make
800 892 IPython and matplotlib play nicely under OSX.
801 \layout Subsubsection*
893 \end_layout
802 894
895 \begin_layout Subsubsection*
803 896 GUI problems
804 \layout Standard
897 \end_layout
805 898
899 \begin_layout Standard
806 900 The following instructions apply to an install of IPython under OSX from
807 901 unpacking the
808 \family typewriter
902 \family typewriter
809 903 .tar.gz
810 \family default
904 \family default
811 905 distribution and installing it for the default Python interpreter shipped
812 906 by Apple.
813 907 If you are using a fink install, fink will take care of these details for
814 908 you, by installing IPython against fink's Python.
815 \layout Standard
909 \end_layout
816 910
911 \begin_layout Standard
817 912 IPython offers various forms of support for interacting with graphical applicati
818 913 ons from the command line, from simple Tk apps (which are in principle always
819 914 supported by Python) to interactive control of WX, Qt and GTK apps.
820 915 Under OSX, however, this requires that ipython is installed by calling
821 916 the special
822 \family typewriter
917 \family typewriter
823 918 pythonw
824 \family default
919 \family default
825 920 script at installation time, which takes care of coordinating things with
826 921 Apple's graphical environment.
827 \layout Standard
922 \end_layout
828 923
924 \begin_layout Standard
829 925 So when installing under OSX, it is best to use the following command:
830 \family typewriter
926 \family typewriter
831 927
832 \newline
928 \newline
833 929
834 \family default
930 \family default
835 931
836 932 \begin_inset ERT
837 status Collapsed
933 status collapsed
838 934
839 \layout Standard
935 \begin_layout Standard
840 936
841 \backslash
937
938 \backslash
842 939 verb| $ sudo pythonw setup.py install --install-scripts=/usr/local/bin|
843 \end_inset
940 \end_layout
941
942 \end_inset
844 943
845 944
846 \newline
945 \newline
847 946 or
848 \newline
947 \newline
849 948
850 949 \begin_inset ERT
851 status Collapsed
950 status collapsed
951
952 \begin_layout Standard
852 953
853 \layout Standard
854 954
855 \backslash
955 \backslash
856 956 verb| $ sudo pythonw setup.py install --install-scripts=/usr/bin|
857 \end_inset
957 \end_layout
858 958
959 \end_inset
859 960
860 \newline
961
962 \newline
861 963 depending on where you like to keep hand-installed executables.
862 \layout Standard
964 \end_layout
863 965
966 \begin_layout Standard
864 967 The resulting script will have an appropriate shebang line (the first line
865 968 in the script whic begins with
866 \family typewriter
969 \family typewriter
867 970 #!...
868 \family default
971 \family default
869 972 ) such that the ipython interpreter can interact with the OS X GUI.
870 973 If the installed version does not work and has a shebang line that points
871 974 to, for example, just
872 \family typewriter
975 \family typewriter
873 976 /usr/bin/python
874 \family default
977 \family default
875 978 , then you might have a stale, cached version in your
876 \family typewriter
979 \family typewriter
877 980 build/scripts-<python-version>
878 \family default
981 \family default
879 982 directory.
880 983 Delete that directory and rerun the
881 \family typewriter
984 \family typewriter
882 985 setup.py
883 \family default
986 \family default
884 987 .
885 988
886 \layout Standard
989 \end_layout
887 990
991 \begin_layout Standard
888 992 It is also a good idea to use the special flag
889 993 \begin_inset ERT
890 status Collapsed
994 status collapsed
995
996 \begin_layout Standard
891 997
892 \layout Standard
893 998
894 \backslash
999 \backslash
895 1000 verb|--install-scripts|
896 \end_inset
1001 \end_layout
1002
1003 \end_inset
897 1004
898 1005 as indicated above, to ensure that the ipython scripts end up in a location
899 1006 which is part of your
900 \family typewriter
1007 \family typewriter
901 1008 $PATH
902 \family default
1009 \family default
903 1010 .
904 1011 Otherwise Apple's Python will put the scripts in an internal directory
905 1012 not available by default at the command line (if you use
906 \family typewriter
1013 \family typewriter
907 1014 /usr/local/bin
908 \family default
1015 \family default
909 1016 , you need to make sure this is in your
910 \family typewriter
1017 \family typewriter
911 1018 $PATH
912 \family default
1019 \family default
913 1020 , which may not be true by default).
914 \layout Subsubsection*
1021 \end_layout
915 1022
1023 \begin_layout Subsubsection*
916 1024 Readline problems
917 \layout Standard
1025 \end_layout
918 1026
1027 \begin_layout Standard
919 1028 By default, the Python version shipped by Apple does
920 \emph on
1029 \emph on
921 1030 not
922 \emph default
1031 \emph default
923 1032 include the readline library, so central to IPython's behavior.
924 1033 If you install IPython against Apple's Python, you will not have arrow
925 1034 keys, tab completion, etc.
926 1035 For Mac OSX 10.3 (Panther), you can find a prebuilt readline library here:
927 \newline
1036 \newline
928 1037
929 1038 \begin_inset LatexCommand \htmlurl{http://pythonmac.org/packages/readline-5.0-py2.3-macosx10.3.zip}
930 1039
931 \end_inset
1040 \end_inset
932 1041
933 1042
934 \layout Standard
1043 \end_layout
935 1044
1045 \begin_layout Standard
936 1046 If you are using OSX 10.4 (Tiger), after installing this package you need
937 1047 to either:
938 \layout Enumerate
1048 \end_layout
939 1049
1050 \begin_layout Enumerate
940 1051 move
941 \family typewriter
1052 \family typewriter
942 1053 readline.so
943 \family default
1054 \family default
944 1055 from
945 \family typewriter
1056 \family typewriter
946 1057 /Library/Python/2.3
947 \family default
1058 \family default
948 1059 to
949 \family typewriter
1060 \family typewriter
950 1061 /Library/Python/2.3/site-packages
951 \family default
1062 \family default
952 1063 , or
953 \layout Enumerate
1064 \end_layout
954 1065
1066 \begin_layout Enumerate
955 1067 install
956 1068 \begin_inset LatexCommand \htmlurl{http://pythonmac.org/packages/TigerPython23Compat.pkg.zip}
957 1069
958 \end_inset
1070 \end_inset
959 1071
960 1072
961 \layout Standard
1073 \end_layout
962 1074
1075 \begin_layout Standard
963 1076 Users installing against Fink's Python or a properly hand-built one should
964 1077 not have this problem.
965 \layout Subsubsection*
1078 \end_layout
966 1079
1080 \begin_layout Subsubsection*
967 1081 DarwinPorts
968 \layout Standard
1082 \end_layout
969 1083
1084 \begin_layout Standard
970 1085 I report here a message from an OSX user, who suggests an alternative means
971 1086 of using IPython under this operating system with good results.
972 1087 Please let me know of any updates that may be useful for this section.
973 1088 His message is reproduced verbatim below:
974 \layout Quote
1089 \end_layout
975 1090
1091 \begin_layout Quote
976 1092 From: Markus Banfi
977 \family typewriter
1093 \family typewriter
978 1094 <markus.banfi-AT-mospheira.net>
979 \layout Quote
1095 \end_layout
980 1096
1097 \begin_layout Quote
981 1098 As a MacOS X (10.4.2) user I prefer to install software using DawinPorts instead
982 1099 of Fink.
983 1100 I had no problems installing ipython with DarwinPorts.
984 1101 It's just:
985 \layout Quote
1102 \end_layout
986 1103
1104 \begin_layout Quote
987 1105
988 \family typewriter
1106 \family typewriter
989 1107 sudo port install py-ipython
990 \layout Quote
1108 \end_layout
991 1109
1110 \begin_layout Quote
992 1111 It automatically resolved all dependencies (python24, readline, py-readline).
993 1112 So far I did not encounter any problems with the DarwinPorts port of ipython.
994 1113
995 \layout Subsection
996
1114 \end_layout
997 1115
1116 \begin_layout Subsection
998 1117 \begin_inset LatexCommand \label{sub:Under-Windows}
999 1118
1000 \end_inset
1119 \end_inset
1001 1120
1002 1121 Windows instructions
1003 \layout Standard
1122 \end_layout
1004 1123
1124 \begin_layout Standard
1005 1125 Some of IPython's very useful features are:
1006 \layout Itemize
1126 \end_layout
1007 1127
1128 \begin_layout Itemize
1008 1129 Integrated readline support (Tab-based file, object and attribute completion,
1009 1130 input history across sessions, editable command line, etc.)
1010 \layout Itemize
1131 \end_layout
1011 1132
1133 \begin_layout Itemize
1012 1134 Coloring of prompts, code and tracebacks.
1013 \layout Standard
1135 \end_layout
1014 1136
1137 \begin_layout Standard
1015 1138 These, by default, are only available under Unix-like operating systems.
1016 1139 However, thanks to Gary Bishop's work, Windows XP/2k users can also benefit
1017 1140 from them.
1018 1141 His readline library originally implemented both GNU readline functionality
1019 1142 and color support, so that IPython under Windows XP/2k can be as friendly
1020 1143 and powerful as under Unix-like environments.
1021 1144
1022 \layout Standard
1145 \end_layout
1023 1146
1147 \begin_layout Standard
1024 1148 This library, now named
1025 \family typewriter
1149 \family typewriter
1026 1150 PyReadline
1027 \family default
1151 \family default
1028 1152 , has been absorbed by the IPython team (JοΏ½rgen Stenarson, in particular),
1029 1153 and it continues to be developed with new features, as well as being distribute
1030 1154 d directly from the IPython site.
1031 \layout Standard
1155 \end_layout
1032 1156
1157 \begin_layout Standard
1033 1158 The
1034 \family typewriter
1159 \family typewriter
1035 1160 PyReadline
1036 \family default
1161 \family default
1037 1162 extension requires
1038 \family typewriter
1163 \family typewriter
1039 1164 CTypes
1040 \family default
1165 \family default
1041 1166 and the windows IPython installer needs
1042 \family typewriter
1167 \family typewriter
1043 1168 PyWin32
1044 \family default
1169 \family default
1045 1170 , so in all you need:
1046 \layout Enumerate
1171 \end_layout
1047 1172
1173 \begin_layout Enumerate
1048 1174
1049 \family typewriter
1175 \family typewriter
1050 1176 PyWin32
1051 \family default
1177 \family default
1052 1178 from
1053 1179 \begin_inset LatexCommand \htmlurl{http://starship.python.net/crew/mhammond}
1054 1180
1055 \end_inset
1181 \end_inset
1056 1182
1057 1183 .
1058 \layout Enumerate
1184 \end_layout
1059 1185
1186 \begin_layout Enumerate
1060 1187
1061 \family typewriter
1188 \family typewriter
1062 1189 CTypes
1063 \family default
1190 \family default
1064 1191 from
1065 1192 \begin_inset LatexCommand \htmlurl{http://starship.python.net/crew/theller/ctypes}
1066 1193
1067 \end_inset
1194 \end_inset
1068 1195
1069 1196 (you
1070 \emph on
1197 \emph on
1071 1198 must
1072 \emph default
1199 \emph default
1073 1200 use version 0.9.1 or newer).
1074 \layout Enumerate
1201 \end_layout
1075 1202
1203 \begin_layout Enumerate
1076 1204
1077 \family typewriter
1205 \family typewriter
1078 1206 PyReadline
1079 \family default
1207 \family default
1080 1208 for Windows from
1081 1209 \begin_inset LatexCommand \htmlurl{http://projects.scipy.org/ipython/ipython/wiki/PyReadline/Intro}
1082 1210
1083 \end_inset
1211 \end_inset
1084 1212
1085 1213 .
1086 1214 That page contains further details on using and configuring the system
1087 1215 to your liking.
1088 \layout Standard
1216 \end_layout
1089 1217
1218 \begin_layout Standard
1090 1219
1091 \series bold
1220 \series bold
1092 1221 Warning about a broken readline-like library:
1093 \series default
1222 \series default
1094 1223 several users have reported problems stemming from using the pseudo-readline
1095 1224 library at
1096 1225 \begin_inset LatexCommand \htmlurl{http://newcenturycomputers.net/projects/readline.html}
1097 1226
1098 \end_inset
1227 \end_inset
1099 1228
1100 1229 .
1101 1230 This is a broken library which, while called readline, only implements
1102 1231 an incomplete subset of the readline API.
1103 1232 Since it is still called readline, it fools IPython's detection mechanisms
1104 1233 and causes unpredictable crashes later.
1105 1234 If you wish to use IPython under Windows, you must NOT use this library,
1106 1235 which for all purposes is (at least as of version 1.6) terminally broken.
1107 \layout Subsubsection
1236 \end_layout
1108 1237
1238 \begin_layout Subsubsection
1109 1239 Installation procedure
1110 \layout Standard
1240 \end_layout
1111 1241
1242 \begin_layout Standard
1112 1243 Once you have the above installed, from the IPython download directory grab
1113 1244 the
1114 \family typewriter
1245 \family typewriter
1115 1246 ipython-XXX.win32.exe
1116 \family default
1247 \family default
1117 1248 file, where
1118 \family typewriter
1249 \family typewriter
1119 1250 XXX
1120 \family default
1251 \family default
1121 1252 represents the version number.
1122 1253 This is a regular windows executable installer, which you can simply double-cli
1123 1254 ck to install.
1124 1255 It will add an entry for IPython to your Start Menu, as well as registering
1125 1256 IPython in the Windows list of applications, so you can later uninstall
1126 1257 it from the Control Panel.
1127 1258
1128 \layout Standard
1259 \end_layout
1129 1260
1261 \begin_layout Standard
1130 1262 IPython tries to install the configuration information in a directory named
1131 1263
1132 \family typewriter
1264 \family typewriter
1133 1265 .ipython
1134 \family default
1266 \family default
1135 1267 (
1136 \family typewriter
1268 \family typewriter
1137 1269 _ipython
1138 \family default
1270 \family default
1139 1271 under Windows) located in your `home' directory.
1140 1272 IPython sets this directory by looking for a
1141 \family typewriter
1273 \family typewriter
1142 1274 HOME
1143 \family default
1275 \family default
1144 1276 environment variable; if such a variable does not exist, it uses
1145 \family typewriter
1277 \family typewriter
1146 1278 HOMEDRIVE
1147 \backslash
1279 \backslash
1148 1280 HOMEPATH
1149 \family default
1281 \family default
1150 1282 (these are always defined by Windows).
1151 1283 This typically gives something like
1152 \family typewriter
1284 \family typewriter
1153 1285 C:
1154 \backslash
1286 \backslash
1155 1287 Documents and Settings
1156 \backslash
1288 \backslash
1157 1289 YourUserName
1158 \family default
1290 \family default
1159 1291 , but your local details may vary.
1160 1292 In this directory you will find all the files that configure IPython's
1161 1293 defaults, and you can put there your profiles and extensions.
1162 1294 This directory is automatically added by IPython to
1163 \family typewriter
1295 \family typewriter
1164 1296 sys.path
1165 \family default
1297 \family default
1166 1298 , so anything you place there can be found by
1167 \family typewriter
1299 \family typewriter
1168 1300 import
1169 \family default
1301 \family default
1170 1302 statements.
1171 \layout Paragraph
1303 \end_layout
1172 1304
1305 \begin_layout Paragraph
1173 1306 Upgrading
1174 \layout Standard
1307 \end_layout
1175 1308
1309 \begin_layout Standard
1176 1310 For an IPython upgrade, you should first uninstall the previous version.
1177 1311 This will ensure that all files and directories (such as the documentation)
1178 1312 which carry embedded version strings in their names are properly removed.
1179 \layout Paragraph
1313 \end_layout
1180 1314
1315 \begin_layout Paragraph
1181 1316 Manual installation under Win32
1182 \layout Standard
1317 \end_layout
1183 1318
1319 \begin_layout Standard
1184 1320 In case the automatic installer does not work for some reason, you can download
1185 1321 the
1186 \family typewriter
1322 \family typewriter
1187 1323 ipython-XXX.tar.gz
1188 \family default
1324 \family default
1189 1325 file, which contains the full IPython source distribution (the popular
1190 1326 WinZip can read
1191 \family typewriter
1327 \family typewriter
1192 1328 .tar.gz
1193 \family default
1329 \family default
1194 1330 files).
1195 1331 After uncompressing the archive, you can install it at a command terminal
1196 1332 just like any other Python module, by using
1197 \family typewriter
1333 \family typewriter
1198 1334 `python setup.py install'
1199 \family default
1335 \family default
1200 1336 .
1201 1337
1202 \layout Standard
1338 \end_layout
1203 1339
1340 \begin_layout Standard
1204 1341 After the installation, run the supplied
1205 \family typewriter
1342 \family typewriter
1206 1343 win32_manual_post_install.py
1207 \family default
1344 \family default
1208 1345 script, which creates the necessary Start Menu shortcuts for you.
1209 \layout Subsection
1210
1346 \end_layout
1211 1347
1348 \begin_layout Subsection
1212 1349 \begin_inset LatexCommand \label{sec:upgrade}
1213 1350
1214 \end_inset
1351 \end_inset
1215 1352
1216 1353 Upgrading from a previous version
1217 \layout Standard
1354 \end_layout
1218 1355
1356 \begin_layout Standard
1219 1357 If you are upgrading from a previous version of IPython, after doing the
1220 1358 routine installation described above, you should call IPython with the
1221 1359
1222 \family typewriter
1360 \family typewriter
1223 1361 -upgrade
1224 \family default
1362 \family default
1225 1363 option the first time you run your new copy.
1226 1364 This will automatically update your configuration directory while preserving
1227 1365 copies of your old files.
1228 1366 You can then later merge back any personal customizations you may have
1229 1367 made into the new files.
1230 1368 It is a good idea to do this as there may be new options available in the
1231 1369 new configuration files which you will not have.
1232 \layout Standard
1370 \end_layout
1233 1371
1372 \begin_layout Standard
1234 1373 Under Windows, if you don't know how to call python scripts with arguments
1235 1374 from a command line, simply delete the old config directory and IPython
1236 1375 will make a new one.
1237 1376 Win2k and WinXP users will find it in
1238 \family typewriter
1377 \family typewriter
1239 1378 C:
1240 \backslash
1379 \backslash
1241 1380 Documents and Settings
1242 \backslash
1381 \backslash
1243 1382 YourUserName
1244 \backslash
1383 \backslash
1245 1384 _ipython
1246 \family default
1385 \family default
1247 1386 , and Win 9x users under
1248 \family typewriter
1387 \family typewriter
1249 1388 C:
1250 \backslash
1389 \backslash
1251 1390 Program Files
1252 \backslash
1391 \backslash
1253 1392 IPython
1254 \backslash
1393 \backslash
1255 1394 _ipython.
1256 \layout Section
1257
1395 \end_layout
1258 1396
1397 \begin_layout Section
1259 1398 \begin_inset LatexCommand \label{sec:good_config}
1260 1399
1261 \end_inset
1400 \end_inset
1262 1401
1263 1402
1264 1403 \begin_inset OptArg
1265 collapsed true
1266
1267 \layout Standard
1404 status collapsed
1268 1405
1406 \begin_layout Standard
1269 1407 Initial configuration
1270 1408 \begin_inset ERT
1271 status Collapsed
1409 status collapsed
1272 1410
1273 \layout Standard
1411 \begin_layout Standard
1274 1412
1275 \backslash
1413
1414 \backslash
1276 1415 ldots
1277 \end_inset
1416 \end_layout
1417
1418 \end_inset
1419
1278 1420
1421 \end_layout
1279 1422
1280 \end_inset
1423 \end_inset
1281 1424
1282 1425 Initial configuration of your environment
1283 \layout Standard
1426 \end_layout
1284 1427
1428 \begin_layout Standard
1285 1429 This section will help you set various things in your environment for your
1286 1430 IPython sessions to be as efficient as possible.
1287 1431 All of IPython's configuration information, along with several example
1288 1432 files, is stored in a directory named by default
1289 \family typewriter
1433 \family typewriter
1290 1434 $HOME/.ipython
1291 \family default
1435 \family default
1292 1436 .
1293 1437 You can change this by defining the environment variable
1294 \family typewriter
1438 \family typewriter
1295 1439 IPYTHONDIR
1296 \family default
1440 \family default
1297 1441 , or at runtime with the command line option
1298 \family typewriter
1442 \family typewriter
1299 1443 -ipythondir
1300 \family default
1444 \family default
1301 1445 .
1302 \layout Standard
1446 \end_layout
1303 1447
1448 \begin_layout Standard
1304 1449 If all goes well, the first time you run IPython it should automatically
1305 1450 create a user copy of the config directory for you, based on its builtin
1306 1451 defaults.
1307 1452 You can look at the files it creates to learn more about configuring the
1308 1453 system.
1309 1454 The main file you will modify to configure IPython's behavior is called
1310 1455
1311 \family typewriter
1456 \family typewriter
1312 1457 ipythonrc
1313 \family default
1458 \family default
1314 1459 (with a
1315 \family typewriter
1460 \family typewriter
1316 1461 .ini
1317 \family default
1462 \family default
1318 1463 extension under Windows), included for reference in Sec.
1319 1464
1320 1465 \begin_inset LatexCommand \ref{sec:ipytonrc-sample}
1321 1466
1322 \end_inset
1467 \end_inset
1323 1468
1324 1469 .
1325 1470 This file is very commented and has many variables you can change to suit
1326 1471 your taste, you can find more details in Sec.
1327 1472
1328 1473 \begin_inset LatexCommand \ref{sec:customization}
1329 1474
1330 \end_inset
1475 \end_inset
1331 1476
1332 1477 .
1333 1478 Here we discuss the basic things you will want to make sure things are
1334 1479 working properly from the beginning.
1335 \layout Subsection
1336
1480 \end_layout
1337 1481
1482 \begin_layout Subsection
1338 1483 \begin_inset LatexCommand \label{sec:help-access}
1339 1484
1340 \end_inset
1485 \end_inset
1341 1486
1342 1487 Access to the Python help system
1343 \layout Standard
1488 \end_layout
1344 1489
1490 \begin_layout Standard
1345 1491 This is true for Python in general (not just for IPython): you should have
1346 1492 an environment variable called
1347 \family typewriter
1493 \family typewriter
1348 1494 PYTHONDOCS
1349 \family default
1495 \family default
1350 1496 pointing to the directory where your HTML Python documentation lives.
1351 1497 In my system it's
1352 \family typewriter
1498 \family typewriter
1353 1499 /usr/share/doc/python-docs-2.3.4/html
1354 \family default
1500 \family default
1355 1501 , check your local details or ask your systems administrator.
1356 1502
1357 \layout Standard
1503 \end_layout
1358 1504
1505 \begin_layout Standard
1359 1506 This is the directory which holds the HTML version of the Python manuals.
1360 1507 Unfortunately it seems that different Linux distributions package these
1361 1508 files differently, so you may have to look around a bit.
1362 1509 Below I show the contents of this directory on my system for reference:
1363 \layout Standard
1510 \end_layout
1364 1511
1512 \begin_layout Standard
1365 1513
1366 \family typewriter
1514 \family typewriter
1367 1515 [html]> ls
1368 \newline
1369 about.dat acks.html dist/ ext/ index.html lib/ modindex.html stdabout.dat tut/
1370 about.html api/ doc/ icons/ inst/ mac/ ref/ style.css
1371 \layout Standard
1516 \newline
1517 about.dat acks.html dist/ ext/ index.html lib/ modindex.html stdabout.dat
1518 tut/ about.html api/ doc/ icons/ inst/ mac/ ref/ style.css
1519 \end_layout
1372 1520
1521 \begin_layout Standard
1373 1522 You should really make sure this variable is correctly set so that Python's
1374 1523 pydoc-based help system works.
1375 1524 It is a powerful and convenient system with full access to the Python manuals
1376 1525 and all modules accessible to you.
1377 \layout Standard
1526 \end_layout
1378 1527
1528 \begin_layout Standard
1379 1529 Under Windows it seems that pydoc finds the documentation automatically,
1380 1530 so no extra setup appears necessary.
1381 \layout Subsection
1531 \end_layout
1382 1532
1533 \begin_layout Subsection
1383 1534 Editor
1384 \layout Standard
1535 \end_layout
1385 1536
1537 \begin_layout Standard
1386 1538 The
1387 \family typewriter
1539 \family typewriter
1388 1540 %edit
1389 \family default
1541 \family default
1390 1542 command (and its alias
1391 \family typewriter
1543 \family typewriter
1392 1544 %ed
1393 \family default
1545 \family default
1394 1546 ) will invoke the editor set in your environment as
1395 \family typewriter
1547 \family typewriter
1396 1548 EDITOR
1397 \family default
1549 \family default
1398 1550 .
1399 1551 If this variable is not set, it will default to
1400 \family typewriter
1552 \family typewriter
1401 1553 vi
1402 \family default
1554 \family default
1403 1555 under Linux/Unix and to
1404 \family typewriter
1556 \family typewriter
1405 1557 notepad
1406 \family default
1558 \family default
1407 1559 under Windows.
1408 1560 You may want to set this variable properly and to a lightweight editor
1409 1561 which doesn't take too long to start (that is, something other than a new
1410 1562 instance of
1411 \family typewriter
1563 \family typewriter
1412 1564 Emacs
1413 \family default
1565 \family default
1414 1566 ).
1415 1567 This way you can edit multi-line code quickly and with the power of a real
1416 1568 editor right inside IPython.
1417 1569
1418 \layout Standard
1570 \end_layout
1419 1571
1572 \begin_layout Standard
1420 1573 If you are a dedicated
1421 \family typewriter
1574 \family typewriter
1422 1575 Emacs
1423 \family default
1576 \family default
1424 1577 user, you should set up the
1425 \family typewriter
1578 \family typewriter
1426 1579 Emacs
1427 \family default
1580 \family default
1428 1581 server so that new requests are handled by the original process.
1429 1582 This means that almost no time is spent in handling the request (assuming
1430 1583 an
1431 \family typewriter
1584 \family typewriter
1432 1585 Emacs
1433 \family default
1586 \family default
1434 1587 process is already running).
1435 1588 For this to work, you need to set your
1436 \family typewriter
1589 \family typewriter
1437 1590 EDITOR
1438 \family default
1591 \family default
1439 1592 environment variable to
1440 \family typewriter
1593 \family typewriter
1441 1594 'emacsclient'
1442 \family default
1595 \family default
1443 1596 .
1444 1597
1445 \family typewriter
1598 \family typewriter
1446 1599
1447 \family default
1600 \family default
1448 1601 The code below, supplied by Francois Pinard, can then be used in your
1449 \family typewriter
1602 \family typewriter
1450 1603 .emacs
1451 \family default
1604 \family default
1452 1605 file to enable the server:
1453 \layout Standard
1606 \end_layout
1454 1607
1608 \begin_layout Standard
1455 1609
1456 \family typewriter
1610 \family typewriter
1457 1611 (defvar server-buffer-clients)
1458 \newline
1459 (when (and (fboundp 'server-start) (string-equal (getenv "TERM") 'xterm))
1460 \newline
1612 \newline
1613 (when (and (fboundp 'server-start) (string-equal
1614 (getenv "TERM") 'xterm))
1615 \newline
1461 1616
1462 1617 \begin_inset ERT
1463 status Collapsed
1618 status collapsed
1619
1620 \begin_layout Standard
1464 1621
1465 \layout Standard
1466 1622
1467 \backslash
1623 \backslash
1468 1624 hspace*{0mm}
1469 \end_inset
1625 \end_layout
1626
1627 \end_inset
1470 1628
1471 \SpecialChar ~
1472 \SpecialChar ~
1629 \InsetSpace ~
1630 \InsetSpace ~
1473 1631 (server-start)
1474 \newline
1632 \newline
1475 1633
1476 1634 \begin_inset ERT
1477 status Collapsed
1635 status collapsed
1478 1636
1479 \layout Standard
1637 \begin_layout Standard
1480 1638
1481 \backslash
1639
1640 \backslash
1482 1641 hspace*{0mm}
1483 \end_inset
1642 \end_layout
1643
1644 \end_inset
1484 1645
1485 \SpecialChar ~
1486 \SpecialChar ~
1646 \InsetSpace ~
1647 \InsetSpace ~
1487 1648 (defun fp-kill-server-with-buffer-routine ()
1488 \newline
1649 \newline
1489 1650
1490 1651 \begin_inset ERT
1491 status Collapsed
1652 status collapsed
1492 1653
1493 \layout Standard
1654 \begin_layout Standard
1494 1655
1495 \backslash
1656
1657 \backslash
1496 1658 hspace*{0mm}
1497 \end_inset
1659 \end_layout
1660
1661 \end_inset
1498 1662
1499 \SpecialChar ~
1500 \SpecialChar ~
1501 \SpecialChar ~
1502 \SpecialChar ~
1663 \InsetSpace ~
1664 \InsetSpace ~
1665 \InsetSpace ~
1666 \InsetSpace ~
1503 1667 (and server-buffer-clients (server-done)))
1504 \newline
1668 \newline
1505 1669
1506 1670 \begin_inset ERT
1507 status Collapsed
1671 status collapsed
1508 1672
1509 \layout Standard
1673 \begin_layout Standard
1510 1674
1511 \backslash
1675
1676 \backslash
1512 1677 hspace*{0mm}
1513 \end_inset
1678 \end_layout
1679
1680 \end_inset
1514 1681
1515 \SpecialChar ~
1516 \SpecialChar ~
1682 \InsetSpace ~
1683 \InsetSpace ~
1517 1684 (add-hook 'kill-buffer-hook 'fp-kill-server-with-buffer-routine))
1518 \layout Standard
1685 \end_layout
1519 1686
1687 \begin_layout Standard
1520 1688 You can also set the value of this editor via the commmand-line option '-
1521 \family typewriter
1689 \family typewriter
1522 1690 editor'
1523 \family default
1691 \family default
1524 1692 or in your
1525 \family typewriter
1693 \family typewriter
1526 1694 ipythonrc
1527 \family default
1695 \family default
1528 1696 file.
1529 1697 This is useful if you wish to use specifically for IPython an editor different
1530 1698 from your typical default (and for Windows users who tend to use fewer
1531 1699 environment variables).
1532 \layout Subsection
1700 \end_layout
1533 1701
1702 \begin_layout Subsection
1534 1703 Color
1535 \layout Standard
1704 \end_layout
1536 1705
1706 \begin_layout Standard
1537 1707 The default IPython configuration has most bells and whistles turned on
1538 1708 (they're pretty safe).
1539 1709 But there's one that
1540 \emph on
1710 \emph on
1541 1711 may
1542 \emph default
1712 \emph default
1543 1713 cause problems on some systems: the use of color on screen for displaying
1544 1714 information.
1545 1715 This is very useful, since IPython can show prompts and exception tracebacks
1546 1716 with various colors, display syntax-highlighted source code, and in general
1547 1717 make it easier to visually parse information.
1548 \layout Standard
1718 \end_layout
1549 1719
1720 \begin_layout Standard
1550 1721 The following terminals seem to handle the color sequences fine:
1551 \layout Itemize
1722 \end_layout
1552 1723
1724 \begin_layout Itemize
1553 1725 Linux main text console, KDE Konsole, Gnome Terminal, E-term, rxvt, xterm.
1554 \layout Itemize
1726 \end_layout
1555 1727
1728 \begin_layout Itemize
1556 1729 CDE terminal (tested under Solaris).
1557 1730 This one boldfaces light colors.
1558 \layout Itemize
1731 \end_layout
1559 1732
1733 \begin_layout Itemize
1560 1734 (X)Emacs buffers.
1561 1735 See sec.
1562 1736 \begin_inset LatexCommand \ref{sec:emacs}
1563 1737
1564 \end_inset
1738 \end_inset
1565 1739
1566 1740 for more details on using IPython with (X)Emacs.
1567 \layout Itemize
1741 \end_layout
1568 1742
1743 \begin_layout Itemize
1569 1744 A Windows (XP/2k) command prompt
1570 \emph on
1745 \emph on
1571 1746 with Gary Bishop's support extensions
1572 \emph default
1747 \emph default
1573 1748 .
1574 Gary's extensions are discussed in Sec.\SpecialChar ~
1749 Gary's extensions are discussed in Sec.\InsetSpace ~
1575 1750
1576 1751 \begin_inset LatexCommand \ref{sub:Under-Windows}
1577 1752
1578 \end_inset
1753 \end_inset
1579 1754
1580 1755 .
1581 \layout Itemize
1756 \end_layout
1582 1757
1758 \begin_layout Itemize
1583 1759 A Windows (XP/2k) CygWin shell.
1584 1760 Although some users have reported problems; it is not clear whether there
1585 1761 is an issue for everyone or only under specific configurations.
1586 1762 If you have full color support under cygwin, please post to the IPython
1587 1763 mailing list so this issue can be resolved for all users.
1588 \layout Standard
1764 \end_layout
1589 1765
1766 \begin_layout Standard
1590 1767 These have shown problems:
1591 \layout Itemize
1768 \end_layout
1592 1769
1770 \begin_layout Itemize
1593 1771 Windows command prompt in WinXP/2k logged into a Linux machine via telnet
1594 1772 or ssh.
1595 \layout Itemize
1773 \end_layout
1596 1774
1775 \begin_layout Itemize
1597 1776 Windows native command prompt in WinXP/2k,
1598 \emph on
1777 \emph on
1599 1778 without
1600 \emph default
1779 \emph default
1601 1780 Gary Bishop's extensions.
1602 1781 Once Gary's readline library is installed, the normal WinXP/2k command
1603 1782 prompt works perfectly.
1604 \layout Standard
1783 \end_layout
1605 1784
1785 \begin_layout Standard
1606 1786 Currently the following color schemes are available:
1607 \layout Itemize
1787 \end_layout
1608 1788
1789 \begin_layout Itemize
1609 1790
1610 \family typewriter
1791 \family typewriter
1611 1792 NoColor
1612 \family default
1793 \family default
1613 1794 : uses no color escapes at all (all escapes are empty
1614 1795 \begin_inset Quotes eld
1615 \end_inset
1796 \end_inset
1616 1797
1617 1798
1618 1799 \begin_inset Quotes eld
1619 \end_inset
1800 \end_inset
1620 1801
1621 1802 strings).
1622 1803 This 'scheme' is thus fully safe to use in any terminal.
1623 \layout Itemize
1804 \end_layout
1624 1805
1806 \begin_layout Itemize
1625 1807
1626 \family typewriter
1808 \family typewriter
1627 1809 Linux
1628 \family default
1810 \family default
1629 1811 : works well in Linux console type environments: dark background with light
1630 1812 fonts.
1631 1813 It uses bright colors for information, so it is difficult to read if you
1632 1814 have a light colored background.
1633 \layout Itemize
1815 \end_layout
1634 1816
1817 \begin_layout Itemize
1635 1818
1636 \family typewriter
1819 \family typewriter
1637 1820 LightBG
1638 \family default
1821 \family default
1639 1822 : the basic colors are similar to those in the
1640 \family typewriter
1823 \family typewriter
1641 1824 Linux
1642 \family default
1825 \family default
1643 1826 scheme but darker.
1644 1827 It is easy to read in terminals with light backgrounds.
1645 \layout Standard
1828 \end_layout
1646 1829
1830 \begin_layout Standard
1647 1831 IPython uses colors for two main groups of things: prompts and tracebacks
1648 1832 which are directly printed to the terminal, and the object introspection
1649 1833 system which passes large sets of data through a pager.
1650 \layout Subsubsection
1834 \end_layout
1651 1835
1836 \begin_layout Subsubsection
1652 1837 Input/Output prompts and exception tracebacks
1653 \layout Standard
1838 \end_layout
1654 1839
1840 \begin_layout Standard
1655 1841 You can test whether the colored prompts and tracebacks work on your system
1656 1842 interactively by typing
1657 \family typewriter
1843 \family typewriter
1658 1844 '%colors Linux'
1659 \family default
1845 \family default
1660 1846 at the prompt (use '
1661 \family typewriter
1847 \family typewriter
1662 1848 %colors LightBG'
1663 \family default
1849 \family default
1664 1850 if your terminal has a light background).
1665 1851 If the input prompt shows garbage like:
1666 \newline
1852 \newline
1667 1853
1668 \family typewriter
1854 \family typewriter
1669 1855 [0;32mIn [[1;32m1[0;32m]: [0;00m
1670 \family default
1856 \family default
1671 1857
1672 \newline
1858 \newline
1673 1859 instead of (in color) something like:
1674 \newline
1860 \newline
1675 1861
1676 \family typewriter
1862 \family typewriter
1677 1863 In [1]:
1678 \family default
1864 \family default
1679 1865
1680 \newline
1866 \newline
1681 1867 this means that your terminal doesn't properly handle color escape sequences.
1682 1868 You can go to a 'no color' mode by typing '
1683 \family typewriter
1869 \family typewriter
1684 1870 %colors NoColor
1685 \family default
1871 \family default
1686 1872 '.
1687 1873
1688 \layout Standard
1874 \end_layout
1689 1875
1876 \begin_layout Standard
1690 1877 You can try using a different terminal emulator program (Emacs users, see
1691 1878 below).
1692 1879 To permanently set your color preferences, edit the file
1693 \family typewriter
1880 \family typewriter
1694 1881 $HOME/.ipython/ipythonrc
1695 \family default
1882 \family default
1696 1883 and set the
1697 \family typewriter
1884 \family typewriter
1698 1885 colors
1699 \family default
1886 \family default
1700 1887 option to the desired value.
1701 \layout Subsubsection
1888 \end_layout
1702 1889
1890 \begin_layout Subsubsection
1703 1891 Object details (types, docstrings, source code, etc.)
1704 \layout Standard
1892 \end_layout
1705 1893
1894 \begin_layout Standard
1706 1895 IPython has a set of special functions for studying the objects you are
1707 1896 working with, discussed in detail in Sec.
1708 1897
1709 1898 \begin_inset LatexCommand \ref{sec:dyn-object-info}
1710 1899
1711 \end_inset
1900 \end_inset
1712 1901
1713 1902 .
1714 1903 But this system relies on passing information which is longer than your
1715 1904 screen through a data pager, such as the common Unix
1716 \family typewriter
1905 \family typewriter
1717 1906 less
1718 \family default
1907 \family default
1719 1908 and
1720 \family typewriter
1909 \family typewriter
1721 1910 more
1722 \family default
1911 \family default
1723 1912 programs.
1724 1913 In order to be able to see this information in color, your pager needs
1725 1914 to be properly configured.
1726 1915 I strongly recommend using
1727 \family typewriter
1916 \family typewriter
1728 1917 less
1729 \family default
1918 \family default
1730 1919 instead of
1731 \family typewriter
1920 \family typewriter
1732 1921 more
1733 \family default
1922 \family default
1734 1923 , as it seems that
1735 \family typewriter
1924 \family typewriter
1736 1925 more
1737 \family default
1926 \family default
1738 1927 simply can not understand colored text correctly.
1739 \layout Standard
1928 \end_layout
1740 1929
1930 \begin_layout Standard
1741 1931 In order to configure
1742 \family typewriter
1932 \family typewriter
1743 1933 less
1744 \family default
1934 \family default
1745 1935 as your default pager, do the following:
1746 \layout Enumerate
1936 \end_layout
1747 1937
1938 \begin_layout Enumerate
1748 1939 Set the environment
1749 \family typewriter
1940 \family typewriter
1750 1941 PAGER
1751 \family default
1942 \family default
1752 1943 variable to
1753 \family typewriter
1944 \family typewriter
1754 1945 less
1755 \family default
1946 \family default
1756 1947 .
1757 \layout Enumerate
1948 \end_layout
1758 1949
1950 \begin_layout Enumerate
1759 1951 Set the environment
1760 \family typewriter
1952 \family typewriter
1761 1953 LESS
1762 \family default
1954 \family default
1763 1955 variable to
1764 \family typewriter
1956 \family typewriter
1765 1957 -r
1766 \family default
1958 \family default
1767 1959 (plus any other options you always want to pass to
1768 \family typewriter
1960 \family typewriter
1769 1961 less
1770 \family default
1962 \family default
1771 1963 by default).
1772 1964 This tells
1773 \family typewriter
1965 \family typewriter
1774 1966 less
1775 \family default
1967 \family default
1776 1968 to properly interpret control sequences, which is how color information
1777 1969 is given to your terminal.
1778 \layout Standard
1970 \end_layout
1779 1971
1972 \begin_layout Standard
1780 1973 For the
1781 \family typewriter
1974 \family typewriter
1782 1975 csh
1783 \family default
1976 \family default
1784 1977 or
1785 \family typewriter
1978 \family typewriter
1786 1979 tcsh
1787 \family default
1980 \family default
1788 1981 shells, add to your
1789 \family typewriter
1982 \family typewriter
1790 1983 ~/.cshrc
1791 \family default
1984 \family default
1792 1985 file the lines:
1793 \layout Standard
1986 \end_layout
1794 1987
1988 \begin_layout Standard
1795 1989
1796 \family typewriter
1990 \family typewriter
1797 1991 setenv PAGER less
1798 \newline
1992 \newline
1799 1993 setenv LESS -r
1800 \layout Standard
1994 \end_layout
1801 1995
1996 \begin_layout Standard
1802 1997 There is similar syntax for other Unix shells, look at your system documentation
1803 1998 for details.
1804 \layout Standard
1999 \end_layout
1805 2000
2001 \begin_layout Standard
1806 2002 If you are on a system which lacks proper data pagers (such as Windows),
1807 2003 IPython will use a very limited builtin pager.
1808 \layout Subsection
1809
2004 \end_layout
1810 2005
2006 \begin_layout Subsection
1811 2007 \begin_inset LatexCommand \label{sec:emacs}
1812 2008
1813 \end_inset
2009 \end_inset
1814 2010
1815 2011 (X)Emacs configuration
1816 \layout Standard
2012 \end_layout
1817 2013
2014 \begin_layout Standard
1818 2015 Thanks to the work of Alexander Schmolck and Prabhu Ramachandran, currently
1819 2016 (X)Emacs and IPython get along very well.
1820 2017
1821 \layout Standard
2018 \end_layout
1822 2019
2020 \begin_layout Standard
1823 2021
1824 \series bold
2022 \series bold
1825 2023 Important note:
1826 \series default
2024 \series default
1827 2025 You will need to use a recent enough version of
1828 \family typewriter
2026 \family typewriter
1829 2027 python-mode.el
1830 \family default
2028 \family default
1831 2029 , along with the file
1832 \family typewriter
2030 \family typewriter
1833 2031 ipython.el
1834 \family default
2032 \family default
1835 2033 .
1836 2034 You can check that the version you have of
1837 \family typewriter
2035 \family typewriter
1838 2036 python-mode.el
1839 \family default
2037 \family default
1840 2038 is new enough by either looking at the revision number in the file itself,
1841 2039 or asking for it in (X)Emacs via
1842 \family typewriter
2040 \family typewriter
1843 2041 M-x py-version
1844 \family default
2042 \family default
1845 2043 .
1846 2044 Versions 4.68 and newer contain the necessary fixes for proper IPython support.
1847 \layout Standard
2045 \end_layout
1848 2046
2047 \begin_layout Standard
1849 2048 The file
1850 \family typewriter
2049 \family typewriter
1851 2050 ipython.el
1852 \family default
2051 \family default
1853 2052 is included with the IPython distribution, in the documentation directory
1854 2053 (where this manual resides in PDF and HTML formats).
1855 \layout Standard
2054 \end_layout
1856 2055
2056 \begin_layout Standard
1857 2057 Once you put these files in your Emacs path, all you need in your
1858 \family typewriter
2058 \family typewriter
1859 2059 .emacs
1860 \family default
2060 \family default
1861 2061 file is:
1862 \layout LyX-Code
2062 \end_layout
1863 2063
2064 \begin_layout LyX-Code
1864 2065 (require 'ipython)
1865 \layout Standard
2066 \end_layout
1866 2067
2068 \begin_layout Standard
1867 2069 This should give you full support for executing code snippets via IPython,
1868 2070 opening IPython as your Python shell via
1869 \family typewriter
1870 C-c\SpecialChar ~
2071 \family typewriter
2072 C-c\InsetSpace ~
1871 2073 !
1872 \family default
2074 \family default
1873 2075 , etc.
1874 2076
1875 \layout Standard
2077 \end_layout
1876 2078
2079 \begin_layout Standard
1877 2080 If you happen to get garbage instead of colored prompts as described in
1878 2081 the previous section, you may need to set also in your
1879 \family typewriter
2082 \family typewriter
1880 2083 .emacs
1881 \family default
2084 \family default
1882 2085 file:
1883 \layout LyX-Code
2086 \end_layout
1884 2087
2088 \begin_layout LyX-Code
1885 2089 (setq ansi-color-for-comint-mode t)
1886 \layout Subsubsection*
2090 \end_layout
1887 2091
2092 \begin_layout Subsubsection*
1888 2093 Notes
1889 \layout Itemize
2094 \end_layout
1890 2095
2096 \begin_layout Itemize
1891 2097 There is one caveat you should be aware of: you must start the IPython shell
1892 2098
1893 \emph on
2099 \emph on
1894 2100 before
1895 \emph default
2101 \emph default
1896 2102 attempting to execute any code regions via
1897 \family typewriter
1898 C-c\SpecialChar ~
2103 \family typewriter
2104 C-c\InsetSpace ~
1899 2105 |
1900 \family default
2106 \family default
1901 2107 .
1902 2108 Simply type
1903 \family typewriter
1904 C-c\SpecialChar ~
2109 \family typewriter
2110 C-c\InsetSpace ~
1905 2111 !
1906 \family default
2112 \family default
1907 2113 to start IPython before passing any code regions to the interpreter, and
1908 2114 you shouldn't experience any problems.
1909 \newline
1910 This is due to a bug in Python itself, which has been fixed for Python 2.3,
1911 but exists as of Python 2.2.2 (reported as SF bug [ 737947 ]).
1912 \layout Itemize
2115 \newline
2116 This is due to a bug in Python itself,
2117 which has been fixed for Python 2.3, but exists as of Python 2.2.2 (reported
2118 as SF bug [ 737947 ]).
2119 \end_layout
1913 2120
2121 \begin_layout Itemize
1914 2122 The (X)Emacs support is maintained by Alexander Schmolck, so all comments/reques
1915 2123 ts should be directed to him through the IPython mailing lists.
1916 2124
1917 \layout Itemize
2125 \end_layout
1918 2126
2127 \begin_layout Itemize
1919 2128 This code is still somewhat experimental so it's a bit rough around the
1920 2129 edges (although in practice, it works quite well).
1921 \layout Itemize
2130 \end_layout
1922 2131
2132 \begin_layout Itemize
1923 2133 Be aware that if you customize
1924 \family typewriter
2134 \family typewriter
1925 2135 py-python-command
1926 \family default
2136 \family default
1927 2137 previously, this value will override what
1928 \family typewriter
2138 \family typewriter
1929 2139 ipython.el
1930 \family default
2140 \family default
1931 2141 does (because loading the customization variables comes later).
1932 \layout Section
1933
2142 \end_layout
1934 2143
2144 \begin_layout Section
1935 2145 \begin_inset LatexCommand \label{sec:quick_tips}
1936 2146
1937 \end_inset
2147 \end_inset
1938 2148
1939 2149 Quick tips
1940 \layout Standard
2150 \end_layout
1941 2151
2152 \begin_layout Standard
1942 2153 IPython can be used as an improved replacement for the Python prompt, and
1943 2154 for that you don't really need to read any more of this manual.
1944 2155 But in this section we'll try to summarize a few tips on how to make the
1945 2156 most effective use of it for everyday Python development, highlighting
1946 2157 things you might miss in the rest of the manual (which is getting long).
1947 2158 We'll give references to parts in the manual which provide more detail
1948 2159 when appropriate.
1949 \layout Standard
2160 \end_layout
1950 2161
2162 \begin_layout Standard
1951 2163 The following article by Jeremy Jones provides an introductory tutorial
1952 2164 about IPython:
1953 \newline
2165 \newline
1954 2166
1955 2167 \begin_inset LatexCommand \htmlurl{http://www.onlamp.com/pub/a/python/2005/01/27/ipython.html}
1956 2168
1957 \end_inset
2169 \end_inset
1958 2170
1959 2171
1960 \layout Itemize
2172 \end_layout
1961 2173
2174 \begin_layout Itemize
1962 2175 The TAB key.
1963 2176 TAB-completion, especially for attributes, is a convenient way to explore
1964 2177 the structure of any object you're dealing with.
1965 2178 Simply type
1966 \family typewriter
2179 \family typewriter
1967 2180 object_name.<TAB>
1968 \family default
2181 \family default
1969 2182 and a list of the object's attributes will be printed (see sec.
1970 2183
1971 2184 \begin_inset LatexCommand \ref{sec:readline}
1972 2185
1973 \end_inset
2186 \end_inset
1974 2187
1975 2188 for more).
1976 2189 Tab completion also works on file and directory names, which combined with
1977 2190 IPython's alias system allows you to do from within IPython many of the
1978 2191 things you normally would need the system shell for.
1979 2192
1980 \layout Itemize
2193 \end_layout
1981 2194
2195 \begin_layout Itemize
1982 2196 Explore your objects.
1983 2197 Typing
1984 \family typewriter
2198 \family typewriter
1985 2199 object_name?
1986 \family default
2200 \family default
1987 2201 will print all sorts of details about any object, including docstrings,
1988 2202 function definition lines (for call arguments) and constructor details
1989 2203 for classes.
1990 2204 The magic commands
1991 \family typewriter
2205 \family typewriter
1992 2206 %pdoc
1993 \family default
2207 \family default
1994 2208 ,
1995 \family typewriter
2209 \family typewriter
1996 2210 %pdef
1997 \family default
2211 \family default
1998 2212 ,
1999 \family typewriter
2213 \family typewriter
2000 2214 %psource
2001 \family default
2215 \family default
2002 2216 and
2003 \family typewriter
2217 \family typewriter
2004 2218 %pfile
2005 \family default
2219 \family default
2006 2220 will respectively print the docstring, function definition line, full source
2007 2221 code and the complete file for any object (when they can be found).
2008 2222 If automagic is on (it is by default), you don't need to type the '
2009 \family typewriter
2223 \family typewriter
2010 2224 %
2011 \family default
2225 \family default
2012 2226 ' explicitly.
2013 2227 See sec.
2014 2228
2015 2229 \begin_inset LatexCommand \ref{sec:dyn-object-info}
2016 2230
2017 \end_inset
2231 \end_inset
2018 2232
2019 2233 for more.
2020 \layout Itemize
2234 \end_layout
2021 2235
2236 \begin_layout Itemize
2022 2237 The
2023 \family typewriter
2238 \family typewriter
2024 2239 %run
2025 \family default
2240 \family default
2026 2241 magic command allows you to run any python script and load all of its data
2027 2242 directly into the interactive namespace.
2028 2243 Since the file is re-read from disk each time, changes you make to it are
2029 2244 reflected immediately (in contrast to the behavior of
2030 \family typewriter
2245 \family typewriter
2031 2246 import
2032 \family default
2247 \family default
2033 2248 ).
2034 2249 I rarely use
2035 \family typewriter
2250 \family typewriter
2036 2251 import
2037 \family default
2252 \family default
2038 2253 for code I am testing, relying on
2039 \family typewriter
2254 \family typewriter
2040 2255 %run
2041 \family default
2256 \family default
2042 2257 instead.
2043 2258 See sec.
2044 2259
2045 2260 \begin_inset LatexCommand \ref{sec:magic}
2046 2261
2047 \end_inset
2262 \end_inset
2048 2263
2049 2264 for more on this and other magic commands, or type the name of any magic
2050 2265 command and ? to get details on it.
2051 2266 See also sec.
2052 2267
2053 2268 \begin_inset LatexCommand \ref{sec:dreload}
2054 2269
2055 \end_inset
2270 \end_inset
2056 2271
2057 2272 for a recursive reload command.
2058 \newline
2273 \newline
2059 2274
2060 \family typewriter
2275 \family typewriter
2061 2276 %run
2062 \family default
2277 \family default
2063 2278 also has special flags for timing the execution of your scripts (
2064 \family typewriter
2279 \family typewriter
2065 2280 -t
2066 \family default
2281 \family default
2067 2282 ) and for executing them under the control of either Python's
2068 \family typewriter
2283 \family typewriter
2069 2284 pdb
2070 \family default
2285 \family default
2071 2286 debugger (
2072 \family typewriter
2287 \family typewriter
2073 2288 -d
2074 \family default
2289 \family default
2075 2290 ) or profiler (
2076 \family typewriter
2291 \family typewriter
2077 2292 -p
2078 \family default
2293 \family default
2079 2294 ).
2080 2295 With all of these,
2081 \family typewriter
2296 \family typewriter
2082 2297 %run
2083 \family default
2298 \family default
2084 2299 can be used as the main tool for efficient interactive development of code
2085 2300 which you write in your editor of choice.
2086 \layout Itemize
2301 \end_layout
2087 2302
2303 \begin_layout Itemize
2088 2304 Use the Python debugger,
2089 \family typewriter
2305 \family typewriter
2090 2306 pdb
2091 \family default
2307 \family default
2092 2308
2093 2309 \begin_inset Foot
2094 collapsed true
2095
2096 \layout Standard
2310 status collapsed
2097 2311
2312 \begin_layout Standard
2098 2313 Thanks to Christian Hart and Matthew Arnison for the suggestions leading
2099 2314 to IPython's improved debugger and profiler support.
2100 \end_inset
2315 \end_layout
2316
2317 \end_inset
2101 2318
2102 2319 .
2103 2320 The
2104 \family typewriter
2321 \family typewriter
2105 2322 %pdb
2106 \family default
2323 \family default
2107 2324 command allows you to toggle on and off the automatic invocation of an
2108 2325 IPython-enhanced
2109 \family typewriter
2326 \family typewriter
2110 2327 pdb
2111 \family default
2328 \family default
2112 2329 debugger (with coloring, tab completion and more) at any uncaught exception.
2113 2330 The advantage of this is that
2114 \family typewriter
2331 \family typewriter
2115 2332 pdb
2116 \family default
2333 \family default
2117 2334 starts
2118 \emph on
2335 \emph on
2119 2336 inside
2120 \emph default
2337 \emph default
2121 2338 the function where the exception occurred, with all data still available.
2122 2339 You can print variables, see code, execute statements and even walk up
2123 2340 and down the call stack to track down the true source of the problem (which
2124 2341 often is many layers in the stack above where the exception gets triggered).
2125 \newline
2126 Running programs with
2127 \family typewriter
2342 \newline
2343 Runn
2344 ing programs with
2345 \family typewriter
2128 2346 %run
2129 \family default
2347 \family default
2130 2348 and pdb active can be an efficient to develop and debug code, in many cases
2131 2349 eliminating the need for
2132 \family typewriter
2350 \family typewriter
2133 2351 print
2134 \family default
2352 \family default
2135 2353 statements or external debugging tools.
2136 2354 I often simply put a
2137 \family typewriter
2355 \family typewriter
2138 2356 1/0
2139 \family default
2357 \family default
2140 2358 in a place where I want to take a look so that pdb gets called, quickly
2141 2359 view whatever variables I need to or test various pieces of code and then
2142 2360 remove the
2143 \family typewriter
2361 \family typewriter
2144 2362 1/0
2145 \family default
2363 \family default
2146 2364 .
2147 \newline
2365 \newline
2148 2366 Note also that `
2149 \family typewriter
2367 \family typewriter
2150 2368 %run -d
2151 \family default
2369 \family default
2152 2370 ' activates
2153 \family typewriter
2371 \family typewriter
2154 2372 pdb
2155 \family default
2373 \family default
2156 2374 and automatically sets initial breakpoints for you to step through your
2157 2375 code, watch variables, etc.
2158 See Sec.\SpecialChar ~
2376 See Sec.\InsetSpace ~
2159 2377
2160 2378 \begin_inset LatexCommand \ref{sec:cache_output}
2161 2379
2162 \end_inset
2380 \end_inset
2163 2381
2164 2382 for details.
2165 \layout Itemize
2383 \end_layout
2166 2384
2385 \begin_layout Itemize
2167 2386 Use the output cache.
2168 2387 All output results are automatically stored in a global dictionary named
2169 2388
2170 \family typewriter
2389 \family typewriter
2171 2390 Out
2172 \family default
2391 \family default
2173 2392 and variables named
2174 \family typewriter
2393 \family typewriter
2175 2394 _1
2176 \family default
2395 \family default
2177 2396 ,
2178 \family typewriter
2397 \family typewriter
2179 2398 _2
2180 \family default
2399 \family default
2181 2400 , etc.
2182 2401 alias them.
2183 2402 For example, the result of input line 4 is available either as
2184 \family typewriter
2403 \family typewriter
2185 2404 Out[4]
2186 \family default
2405 \family default
2187 2406 or as
2188 \family typewriter
2407 \family typewriter
2189 2408 _4
2190 \family default
2409 \family default
2191 2410 .
2192 2411 Additionally, three variables named
2193 \family typewriter
2412 \family typewriter
2194 2413 _
2195 \family default
2414 \family default
2196 2415 ,
2197 \family typewriter
2416 \family typewriter
2198 2417 __
2199 \family default
2418 \family default
2200 2419 and
2201 \family typewriter
2420 \family typewriter
2202 2421 ___
2203 \family default
2422 \family default
2204 2423 are always kept updated with the for the last three results.
2205 2424 This allows you to recall any previous result and further use it for new
2206 2425 calculations.
2207 See Sec.\SpecialChar ~
2426 See Sec.\InsetSpace ~
2208 2427
2209 2428 \begin_inset LatexCommand \ref{sec:cache_output}
2210 2429
2211 \end_inset
2430 \end_inset
2212 2431
2213 2432 for more.
2214 \layout Itemize
2433 \end_layout
2215 2434
2435 \begin_layout Itemize
2216 2436 Put a '
2217 \family typewriter
2437 \family typewriter
2218 2438 ;
2219 \family default
2439 \family default
2220 2440 ' at the end of a line to supress the printing of output.
2221 2441 This is useful when doing calculations which generate long output you are
2222 2442 not interested in seeing.
2223 2443 The
2224 \family typewriter
2444 \family typewriter
2225 2445 _*
2226 \family default
2446 \family default
2227 2447 variables and the
2228 \family typewriter
2448 \family typewriter
2229 2449 Out[]
2230 \family default
2450 \family default
2231 2451 list do get updated with the contents of the output, even if it is not
2232 2452 printed.
2233 2453 You can thus still access the generated results this way for further processing.
2234 \layout Itemize
2454 \end_layout
2235 2455
2456 \begin_layout Itemize
2236 2457 A similar system exists for caching input.
2237 2458 All input is stored in a global list called
2238 \family typewriter
2459 \family typewriter
2239 2460 In
2240 \family default
2461 \family default
2241 2462 , so you can re-execute lines 22 through 28 plus line 34 by typing
2242 \family typewriter
2463 \family typewriter
2243 2464 'exec In[22:29]+In[34]'
2244 \family default
2465 \family default
2245 2466 (using Python slicing notation).
2246 2467 If you need to execute the same set of lines often, you can assign them
2247 2468 to a macro with the
2248 \family typewriter
2469 \family typewriter
2249 2470 %macro
2250 \family default
2471 \family default
2251 2472
2252 \family typewriter
2473 \family typewriter
2253 2474 function.
2254 2475
2255 \family default
2476 \family default
2256 2477 See sec.
2257 2478
2258 2479 \begin_inset LatexCommand \ref{sec:cache_input}
2259 2480
2260 \end_inset
2481 \end_inset
2261 2482
2262 2483 for more.
2263 \layout Itemize
2484 \end_layout
2264 2485
2486 \begin_layout Itemize
2265 2487 Use your input history.
2266 2488 The
2267 \family typewriter
2489 \family typewriter
2268 2490 %hist
2269 \family default
2491 \family default
2270 2492 command can show you all previous input, without line numbers if desired
2271 2493 (option
2272 \family typewriter
2494 \family typewriter
2273 2495 -n
2274 \family default
2496 \family default
2275 2497 ) so you can directly copy and paste code either back in IPython or in a
2276 2498 text editor.
2277 2499 You can also save all your history by turning on logging via
2278 \family typewriter
2500 \family typewriter
2279 2501 %logstart
2280 \family default
2502 \family default
2281 2503 ; these logs can later be either reloaded as IPython sessions or used as
2282 2504 code for your programs.
2283 \layout Itemize
2505 \end_layout
2284 2506
2507 \begin_layout Itemize
2285 2508 Define your own system aliases.
2286 2509 Even though IPython gives you access to your system shell via the
2287 \family typewriter
2510 \family typewriter
2288 2511 !
2289 \family default
2512 \family default
2290 2513 prefix, it is convenient to have aliases to the system commands you use
2291 2514 most often.
2292 2515 This allows you to work seamlessly from inside IPython with the same commands
2293 2516 you are used to in your system shell.
2294 \newline
2295 IPython comes with some pre-defined aliases and a complete system for changing
2296 directories, both via a stack (see
2297 \family typewriter
2517 \newline
2518 IPython comes with some pre-defined
2519 aliases and a complete system for changing directories, both via a stack
2520 (see
2521 \family typewriter
2298 2522 %pushd
2299 \family default
2523 \family default
2300 2524 ,
2301 \family typewriter
2525 \family typewriter
2302 2526 %popd
2303 \family default
2527 \family default
2304 2528 and
2305 \family typewriter
2529 \family typewriter
2306 2530 %dhist
2307 \family default
2531 \family default
2308 2532 ) and via direct
2309 \family typewriter
2533 \family typewriter
2310 2534 %cd
2311 \family default
2535 \family default
2312 2536 .
2313 2537 The latter keeps a history of visited directories and allows you to go
2314 2538 to any previously visited one.
2315 \layout Itemize
2539 \end_layout
2316 2540
2541 \begin_layout Itemize
2317 2542 Use Python to manipulate the results of system commands.
2318 2543 The `
2319 \family typewriter
2544 \family typewriter
2320 2545 !!
2321 \family default
2546 \family default
2322 2547 ' special syntax, and the
2323 \family typewriter
2548 \family typewriter
2324 2549 %sc
2325 \family default
2550 \family default
2326 2551 and
2327 \family typewriter
2552 \family typewriter
2328 2553 %sx
2329 \family default
2554 \family default
2330 2555 magic commands allow you to capture system output into Python variables.
2331 \layout Itemize
2556 \end_layout
2332 2557
2558 \begin_layout Itemize
2333 2559 Expand python variables when calling the shell (either via
2334 \family typewriter
2560 \family typewriter
2335 2561 `!'
2336 \family default
2562 \family default
2337 2563 and
2338 \family typewriter
2564 \family typewriter
2339 2565 `!!'
2340 \family default
2566 \family default
2341 2567 or via aliases) by prepending a
2342 \family typewriter
2568 \family typewriter
2343 2569 $
2344 \family default
2570 \family default
2345 2571 in front of them.
2346 2572 You can also expand complete python expressions.
2347 See sec.\SpecialChar ~
2573 See sec.\InsetSpace ~
2348 2574
2349 2575 \begin_inset LatexCommand \ref{sub:System-shell-access}
2350 2576
2351 \end_inset
2577 \end_inset
2352 2578
2353 2579 for more.
2354 \layout Itemize
2580 \end_layout
2355 2581
2582 \begin_layout Itemize
2356 2583 Use profiles to maintain different configurations (modules to load, function
2357 2584 definitions, option settings) for particular tasks.
2358 2585 You can then have customized versions of IPython for specific purposes.
2359 See sec.\SpecialChar ~
2586 See sec.\InsetSpace ~
2360 2587
2361 2588 \begin_inset LatexCommand \ref{sec:profiles}
2362 2589
2363 \end_inset
2590 \end_inset
2364 2591
2365 2592 for more.
2366 \layout Itemize
2593 \end_layout
2367 2594
2595 \begin_layout Itemize
2368 2596 Embed IPython in your programs.
2369 2597 A few lines of code are enough to load a complete IPython inside your own
2370 2598 programs, giving you the ability to work with your data interactively after
2371 2599 automatic processing has been completed.
2372 See sec.\SpecialChar ~
2600 See sec.\InsetSpace ~
2373 2601
2374 2602 \begin_inset LatexCommand \ref{sec:embed}
2375 2603
2376 \end_inset
2604 \end_inset
2377 2605
2378 2606 for more.
2379 \layout Itemize
2607 \end_layout
2380 2608
2609 \begin_layout Itemize
2381 2610 Use the Python profiler.
2382 2611 When dealing with performance issues, the
2383 \family typewriter
2612 \family typewriter
2384 2613 %run
2385 \family default
2614 \family default
2386 2615 command with a
2387 \family typewriter
2616 \family typewriter
2388 2617 -p
2389 \family default
2618 \family default
2390 2619 option allows you to run complete programs under the control of the Python
2391 2620 profiler.
2392 2621 The
2393 \family typewriter
2622 \family typewriter
2394 2623 %prun
2395 \family default
2624 \family default
2396 2625 command does a similar job for single Python expressions (like function
2397 2626 calls).
2398 \layout Itemize
2627 \end_layout
2399 2628
2629 \begin_layout Itemize
2400 2630 Use the IPython.demo.Demo class to load any Python script as an interactive
2401 2631 demo.
2402 2632 With a minimal amount of simple markup, you can control the execution of
2403 2633 the script, stopping as needed.
2404 See sec.\SpecialChar ~
2634 See sec.\InsetSpace ~
2405 2635
2406 2636 \begin_inset LatexCommand \ref{sec:interactive-demos}
2407 2637
2408 \end_inset
2638 \end_inset
2409 2639
2410 2640 for more.
2411 \layout Subsection
2641 \end_layout
2412 2642
2643 \begin_layout Subsection
2413 2644 Source code handling tips
2414 \layout Standard
2645 \end_layout
2415 2646
2647 \begin_layout Standard
2416 2648 IPython is a line-oriented program, without full control of the terminal.
2417 2649 Therefore, it doesn't support true multiline editing.
2418 2650 However, it has a number of useful tools to help you in dealing effectively
2419 2651 with more complex editing.
2420 \layout Standard
2652 \end_layout
2421 2653
2654 \begin_layout Standard
2422 2655 The
2423 \family typewriter
2656 \family typewriter
2424 2657 %edit
2425 \family default
2658 \family default
2426 2659 command gives a reasonable approximation of multiline editing, by invoking
2427 2660 your favorite editor on the spot.
2428 2661 IPython will execute the code you type in there as if it were typed interactive
2429 2662 ly.
2430 2663 Type
2431 \family typewriter
2664 \family typewriter
2432 2665 %edit?
2433 \family default
2666 \family default
2434 2667 for the full details on the edit command.
2435 \layout Standard
2668 \end_layout
2436 2669
2670 \begin_layout Standard
2437 2671 If you have typed various commands during a session, which you'd like to
2438 2672 reuse, IPython provides you with a number of tools.
2439 2673 Start by using
2440 \family typewriter
2674 \family typewriter
2441 2675 %hist
2442 \family default
2676 \family default
2443 2677 to see your input history, so you can see the line numbers of all input.
2444 2678 Let us say that you'd like to reuse lines 10 through 20, plus lines 24
2445 2679 and 28.
2446 2680 All the commands below can operate on these with the syntax
2447 \layout LyX-Code
2681 \end_layout
2448 2682
2683 \begin_layout LyX-Code
2449 2684 %command 10-20 24 28
2450 \layout Standard
2685 \end_layout
2451 2686
2687 \begin_layout Standard
2452 2688 where the command given can be:
2453 \layout Itemize
2689 \end_layout
2454 2690
2691 \begin_layout Itemize
2455 2692
2456 \family typewriter
2693 \family typewriter
2457 2694 %macro <macroname>
2458 \family default
2695 \family default
2459 2696 : this stores the lines into a variable which, when called at the prompt,
2460 2697 re-executes the input.
2461 2698 Macros can be edited later using
2462 \family typewriter
2699 \family typewriter
2463 2700 `%edit macroname
2464 \family default
2701 \family default
2465 2702 ', and they can be stored persistently across sessions with `
2466 \family typewriter
2703 \family typewriter
2467 2704 %store macroname
2468 \family default
2705 \family default
2469 2706 ' (the storage system is per-profile).
2470 2707 The combination of quick macros, persistent storage and editing, allows
2471 2708 you to easily refine quick-and-dirty interactive input into permanent utilities
2472 2709 , always available both in IPython and as files for general reuse.
2473 \layout Itemize
2710 \end_layout
2474 2711
2712 \begin_layout Itemize
2475 2713
2476 \family typewriter
2714 \family typewriter
2477 2715 %edit
2478 \family default
2716 \family default
2479 2717 : this will open a text editor with those lines pre-loaded for further modificat
2480 2718 ion.
2481 2719 It will then execute the resulting file's contents as if you had typed
2482 2720 it at the prompt.
2483 \layout Itemize
2721 \end_layout
2484 2722
2723 \begin_layout Itemize
2485 2724
2486 \family typewriter
2725 \family typewriter
2487 2726 %save <filename>
2488 \family default
2727 \family default
2489 2728 : this saves the lines directly to a named file on disk.
2490 \layout Standard
2729 \end_layout
2491 2730
2731 \begin_layout Standard
2492 2732 While
2493 \family typewriter
2733 \family typewriter
2494 2734 %macro
2495 \family default
2735 \family default
2496 2736 saves input lines into memory for interactive re-execution, sometimes you'd
2497 2737 like to save your input directly to a file.
2498 2738 The
2499 \family typewriter
2739 \family typewriter
2500 2740 %save
2501 \family default
2741 \family default
2502 2742 magic does this: its input sytnax is the same as
2503 \family typewriter
2743 \family typewriter
2504 2744 %macro
2505 \family default
2745 \family default
2506 2746 , but it saves your input directly to a Python file.
2507 2747 Note that the
2508 \family typewriter
2748 \family typewriter
2509 2749 %logstart
2510 \family default
2750 \family default
2511 2751 command also saves input, but it logs
2512 \emph on
2752 \emph on
2513 2753 all
2514 \emph default
2754 \emph default
2515 2755 input to disk (though you can temporarily suspend it and reactivate it
2516 2756 with
2517 \family typewriter
2757 \family typewriter
2518 2758 %logoff/%logon
2519 \family default
2759 \family default
2520 2760 );
2521 \family typewriter
2761 \family typewriter
2522 2762 %save
2523 \family default
2763 \family default
2524 2764 allows you to select which lines of input you need to save.
2525 \layout Subsubsection*
2765 \end_layout
2526 2766
2767 \begin_layout Subsubsection*
2527 2768 Lightweight 'version control'
2528 \layout Standard
2769 \end_layout
2529 2770
2771 \begin_layout Standard
2530 2772 When you call
2531 \family typewriter
2773 \family typewriter
2532 2774 %edit
2533 \family default
2775 \family default
2534 2776 with no arguments, IPython opens an empty editor with a temporary file,
2535 2777 and it returns the contents of your editing session as a string variable.
2536 2778 Thanks to IPython's output caching mechanism, this is automatically stored:
2537 \layout LyX-Code
2779 \end_layout
2538 2780
2781 \begin_layout LyX-Code
2539 2782 In [1]: %edit
2540 \layout LyX-Code
2783 \end_layout
2541 2784
2785 \begin_layout LyX-Code
2542 2786 IPython will make a temporary file named: /tmp/ipython_edit_yR-HCN.py
2543 \layout LyX-Code
2787 \end_layout
2544 2788
2789 \begin_layout LyX-Code
2545 2790 Editing...
2546 2791 done.
2547 2792 Executing edited code...
2548 \layout LyX-Code
2793 \end_layout
2549 2794
2795 \begin_layout LyX-Code
2550 2796 hello - this is a temporary file
2551 \layout LyX-Code
2797 \end_layout
2552 2798
2799 \begin_layout LyX-Code
2553 2800 Out[1]: "print 'hello - this is a temporary file'
2554 \backslash
2801 \backslash
2555 2802 n"
2556 \layout Standard
2803 \end_layout
2557 2804
2805 \begin_layout Standard
2558 2806 Now, if you call
2559 \family typewriter
2807 \family typewriter
2560 2808 `%edit -p'
2561 \family default
2809 \family default
2562 2810 , IPython tries to open an editor with the same data as the last time you
2563 2811 used
2564 \family typewriter
2812 \family typewriter
2565 2813 %edit
2566 \family default
2814 \family default
2567 2815 .
2568 2816 So if you haven't used
2569 \family typewriter
2817 \family typewriter
2570 2818 %edit
2571 \family default
2819 \family default
2572 2820 in the meantime, this same contents will reopen; however, it will be done
2573 2821 in a
2574 \emph on
2822 \emph on
2575 2823 new file
2576 \emph default
2824 \emph default
2577 2825 .
2578 2826 This means that if you make changes and you later want to find an old version,
2579 2827 you can always retrieve it by using its output number, via
2580 \family typewriter
2828 \family typewriter
2581 2829 `%edit _NN'
2582 \family default
2830 \family default
2583 2831 , where
2584 \family typewriter
2832 \family typewriter
2585 2833 NN
2586 \family default
2834 \family default
2587 2835 is the number of the output prompt.
2588 \layout Standard
2836 \end_layout
2589 2837
2838 \begin_layout Standard
2590 2839 Continuing with the example above, this should illustrate this idea:
2591 \layout LyX-Code
2840 \end_layout
2592 2841
2842 \begin_layout LyX-Code
2593 2843 In [2]: edit -p
2594 \layout LyX-Code
2844 \end_layout
2595 2845
2846 \begin_layout LyX-Code
2596 2847 IPython will make a temporary file named: /tmp/ipython_edit_nA09Qk.py
2597 \layout LyX-Code
2848 \end_layout
2598 2849
2850 \begin_layout LyX-Code
2599 2851 Editing...
2600 2852 done.
2601 2853 Executing edited code...
2602 \layout LyX-Code
2854 \end_layout
2603 2855
2856 \begin_layout LyX-Code
2604 2857 hello - now I made some changes
2605 \layout LyX-Code
2858 \end_layout
2606 2859
2860 \begin_layout LyX-Code
2607 2861 Out[2]: "print 'hello - now I made some changes'
2608 \backslash
2862 \backslash
2609 2863 n"
2610 \layout LyX-Code
2864 \end_layout
2611 2865
2866 \begin_layout LyX-Code
2612 2867 In [3]: edit _1
2613 \layout LyX-Code
2868 \end_layout
2614 2869
2870 \begin_layout LyX-Code
2615 2871 IPython will make a temporary file named: /tmp/ipython_edit_gy6-zD.py
2616 \layout LyX-Code
2872 \end_layout
2617 2873
2874 \begin_layout LyX-Code
2618 2875 Editing...
2619 2876 done.
2620 2877 Executing edited code...
2621 \layout LyX-Code
2878 \end_layout
2622 2879
2880 \begin_layout LyX-Code
2623 2881 hello - this is a temporary file
2624 \layout LyX-Code
2882 \end_layout
2625 2883
2884 \begin_layout LyX-Code
2626 2885 IPython version control at work :)
2627 \layout LyX-Code
2886 \end_layout
2628 2887
2888 \begin_layout LyX-Code
2629 2889 Out[3]: "print 'hello - this is a temporary file'
2630 \backslash
2890 \backslash
2631 2891 nprint 'IPython version control at work :)'
2632 \backslash
2892 \backslash
2633 2893 n"
2634 \layout Standard
2894 \end_layout
2635 2895
2896 \begin_layout Standard
2636 2897 This section was written after a contribution by Alexander Belchenko on
2637 2898 the IPython user list.
2638 \layout LyX-Code
2899 \end_layout
2639 2900
2640 \layout Subsection
2901 \begin_layout LyX-Code
2641 2902
2903 \end_layout
2904
2905 \begin_layout Subsection
2642 2906 Effective logging
2643 \layout Standard
2907 \end_layout
2644 2908
2909 \begin_layout Standard
2645 2910 A very useful suggestion sent in by Robert Kern follows:
2646 \layout Standard
2911 \end_layout
2647 2912
2913 \begin_layout Standard
2648 2914 I recently happened on a nifty way to keep tidy per-project log files.
2649 2915 I made a profile for my project (which is called "parkfield").
2650 \layout LyX-Code
2916 \end_layout
2651 2917
2918 \begin_layout LyX-Code
2652 2919 include ipythonrc
2653 \layout LyX-Code
2920 \end_layout
2654 2921
2922 \begin_layout LyX-Code
2655 2923 # cancel earlier logfile invocation:
2656 \layout LyX-Code
2924 \end_layout
2657 2925
2926 \begin_layout LyX-Code
2658 2927 logfile ''
2659 \layout LyX-Code
2928 \end_layout
2660 2929
2930 \begin_layout LyX-Code
2661 2931 execute import time
2662 \layout LyX-Code
2932 \end_layout
2663 2933
2934 \begin_layout LyX-Code
2664 2935 execute __cmd = '/Users/kern/research/logfiles/parkfield-%s.log rotate'
2665 \layout LyX-Code
2936 \end_layout
2666 2937
2938 \begin_layout LyX-Code
2667 2939 execute __IP.magic_logstart(__cmd % time.strftime('%Y-%m-%d'))
2668 \layout Standard
2940 \end_layout
2669 2941
2942 \begin_layout Standard
2670 2943 I also added a shell alias for convenience:
2671 \layout LyX-Code
2944 \end_layout
2672 2945
2946 \begin_layout LyX-Code
2673 2947 alias parkfield="ipython -pylab -profile parkfield"
2674 \layout Standard
2948 \end_layout
2675 2949
2950 \begin_layout Standard
2676 2951 Now I have a nice little directory with everything I ever type in, organized
2677 2952 by project and date.
2678 \layout Standard
2953 \end_layout
2679 2954
2955 \begin_layout Standard
2680 2956
2681 \series bold
2957 \series bold
2682 2958 Contribute your own:
2683 \series default
2959 \series default
2684 2960 If you have your own favorite tip on using IPython efficiently for a certain
2685 2961 task (especially things which can't be done in the normal Python interpreter),
2686 2962 don't hesitate to send it!
2687 \layout Section
2963 \end_layout
2688 2964
2965 \begin_layout Section
2689 2966 Command-line use
2690 \layout Standard
2967 \end_layout
2691 2968
2969 \begin_layout Standard
2692 2970 You start IPython with the command:
2693 \layout Standard
2971 \end_layout
2694 2972
2973 \begin_layout Standard
2695 2974
2696 \family typewriter
2975 \family typewriter
2697 2976 $ ipython [options] files
2698 \layout Standard
2977 \end_layout
2699 2978
2979 \begin_layout Standard
2700 2980 If invoked with no options, it executes all the files listed in sequence
2701 2981 and drops you into the interpreter while still acknowledging any options
2702 2982 you may have set in your ipythonrc file.
2703 2983 This behavior is different from standard Python, which when called as
2704 \family typewriter
2984 \family typewriter
2705 2985 python -i
2706 \family default
2986 \family default
2707 2987 will only execute one file and ignore your configuration setup.
2708 \layout Standard
2988 \end_layout
2709 2989
2990 \begin_layout Standard
2710 2991 Please note that some of the configuration options are not available at
2711 2992 the command line, simply because they are not practical here.
2712 2993 Look into your ipythonrc configuration file for details on those.
2713 2994 This file typically installed in the
2714 \family typewriter
2995 \family typewriter
2715 2996 $HOME/.ipython
2716 \family default
2997 \family default
2717 2998 directory.
2718 2999 For Windows users,
2719 \family typewriter
3000 \family typewriter
2720 3001 $HOME
2721 \family default
3002 \family default
2722 3003 resolves to
2723 \family typewriter
3004 \family typewriter
2724 3005 C:
2725 \backslash
3006 \backslash
2726 3007
2727 \backslash
3008 \backslash
2728 3009 Documents and Settings
2729 \backslash
3010 \backslash
2730 3011
2731 \backslash
3012 \backslash
2732 3013 YourUserName
2733 \family default
3014 \family default
2734 3015 in most instances.
2735 3016 In the rest of this text, we will refer to this directory as
2736 \family typewriter
3017 \family typewriter
2737 3018 IPYTHONDIR
2738 \family default
3019 \family default
2739 3020 .
2740 \layout Subsection
2741
3021 \end_layout
2742 3022
3023 \begin_layout Subsection
2743 3024 \begin_inset LatexCommand \label{sec:threading-opts}
2744 3025
2745 \end_inset
3026 \end_inset
2746 3027
2747 3028 Special Threading Options
2748 \layout Standard
3029 \end_layout
2749 3030
3031 \begin_layout Standard
2750 3032 The following special options are ONLY valid at the beginning of the command
2751 3033 line, and not later.
2752 3034 This is because they control the initial- ization of ipython itself, before
2753 3035 the normal option-handling mechanism is active.
2754 \layout List
2755 \labelwidthstring 00.00.0000
3036 \end_layout
2756 3037
3038 \begin_layout List
3039 \labelwidthstring 00.00.0000
2757 3040
2758 \family typewriter
2759 \series bold
2760 -gthread,\SpecialChar ~
2761 -qthread,\SpecialChar ~
2762 -wthread,\SpecialChar ~
3041 \family typewriter
3042 \series bold
3043 -gthread,\InsetSpace ~
3044 -qthread,\InsetSpace ~
3045 -q4thread,\InsetSpace ~
3046 -wthread,\InsetSpace ~
2763 3047 -pylab:
2764 \family default
2765 \series default
3048 \family default
3049 \series default
2766 3050 Only
2767 \emph on
3051 \emph on
2768 3052 one
2769 \emph default
3053 \emph default
2770 3054 of these can be given, and it can only be given as the first option passed
2771 3055 to IPython (it will have no effect in any other position).
2772 They provide threading support for the GTK Qt and WXPython toolkits, and
2773 for the matplotlib library.
2774 \layout List
2775 \labelwidthstring 00.00.0000
3056 They provide threading support for the GTK, Qt (versions 3 and 4) and WXPython
3057 toolkits, and for the matplotlib library.
3058 \end_layout
2776 3059
2777 \SpecialChar ~
2778 With any of the first three options, IPython starts running a separate
2779 thread for the graphical toolkit's operation, so that you can open and
2780 control graphical elements from within an IPython command line, without
2781 blocking.
2782 All three provide essentially the same functionality, respectively for
2783 GTK, QT and WXWidgets (via their Python interfaces).
2784 \layout List
3060 \begin_layout List
2785 3061 \labelwidthstring 00.00.0000
3062 \InsetSpace ~
3063 With any of the first four options, IPython starts running a separate thread
3064 for the graphical toolkit's operation, so that you can open and control
3065 graphical elements from within an IPython command line, without blocking.
3066 All four provide essentially the same functionality, respectively for GTK,
3067 Qt3, Qt4 and WXWidgets (via their Python interfaces).
3068 \end_layout
2786 3069
2787 \SpecialChar ~
3070 \begin_layout List
3071 \labelwidthstring 00.00.0000
3072 \InsetSpace ~
2788 3073 Note that with
2789 \family typewriter
3074 \family typewriter
2790 3075 -wthread
2791 \family default
3076 \family default
2792 3077 , you can additionally use the -wxversion option to request a specific version
2793 3078 of wx to be used.
2794 3079 This requires that you have the
2795 \family typewriter
3080 \family typewriter
2796 3081 wxversion
2797 \family default
3082 \family default
2798 3083 Python module installed, which is part of recent wxPython distributions.
2799 \layout List
2800 \labelwidthstring 00.00.0000
3084 \end_layout
2801 3085
2802 \SpecialChar ~
3086 \begin_layout List
3087 \labelwidthstring 00.00.0000
3088 \InsetSpace ~
2803 3089 If
2804 \family typewriter
3090 \family typewriter
2805 3091 -pylab
2806 \family default
3092 \family default
2807 3093 is given, IPython loads special support for the mat plotlib library (
2808 3094 \begin_inset LatexCommand \htmlurl{http://matplotlib.sourceforge.net}
2809 3095
2810 \end_inset
3096 \end_inset
2811 3097
2812 3098 ), allowing interactive usage of any of its backends as defined in the user's
2813 3099
2814 \family typewriter
3100 \family typewriter
2815 3101 ~/.matplotlib/matplotlibrc
2816 \family default
3102 \family default
2817 3103 file.
2818 3104 It automatically activates GTK, Qt or WX threading for IPyhton if the choice
2819 3105 of matplotlib backend requires it.
2820 3106 It also modifies the
2821 \family typewriter
3107 \family typewriter
2822 3108 %run
2823 \family default
3109 \family default
2824 3110 command to correctly execute (without blocking) any matplotlib-based script
2825 3111 which calls
2826 \family typewriter
3112 \family typewriter
2827 3113 show()
2828 \family default
3114 \family default
2829 3115 at the end.
2830 3116
2831 \layout List
2832 \labelwidthstring 00.00.0000
3117 \end_layout
2833 3118
3119 \begin_layout List
3120 \labelwidthstring 00.00.0000
2834 3121
2835 \family typewriter
2836 \series bold
3122 \family typewriter
3123 \series bold
2837 3124 -tk
2838 \family default
2839 \series default
3125 \family default
3126 \series default
2840 3127 The
2841 \family typewriter
2842 -g/q/wthread
2843 \family default
3128 \family typewriter
3129 -g/q/q4/wthread
3130 \family default
2844 3131 options, and
2845 \family typewriter
3132 \family typewriter
2846 3133 -pylab
2847 \family default
2848 (if matplotlib is configured to use GTK, Qt or WX), will normally block
2849 Tk graphical interfaces.
3134 \family default
3135 (if matplotlib is configured to use GTK, Qt3, Qt4 or WX), will normally
3136 block Tk graphical interfaces.
2850 3137 This means that when either GTK, Qt or WX threading is active, any attempt
2851 3138 to open a Tk GUI will result in a dead window, and possibly cause the Python
2852 3139 interpreter to crash.
2853 3140 An extra option,
2854 \family typewriter
3141 \family typewriter
2855 3142 -tk
2856 \family default
3143 \family default
2857 3144 , is available to address this issue.
2858 3145 It can
2859 \emph on
3146 \emph on
2860 3147 only
2861 \emph default
3148 \emph default
2862 3149 be given as a
2863 \emph on
3150 \emph on
2864 3151 second
2865 \emph default
3152 \emph default
2866 3153 option after any of the above (
2867 \family typewriter
3154 \family typewriter
2868 3155 -gthread
2869 \family default
3156 \family default
2870 3157 ,
2871 \family typewriter
3158 \family typewriter
2872 3159 -wthread
2873 \family default
3160 \family default
2874 3161 or
2875 \family typewriter
3162 \family typewriter
2876 3163 -pylab
2877 \family default
3164 \family default
2878 3165 ).
2879 \layout List
2880 \labelwidthstring 00.00.0000
3166 \end_layout
2881 3167
2882 \SpecialChar ~
3168 \begin_layout List
3169 \labelwidthstring 00.00.0000
3170 \InsetSpace ~
2883 3171 If
2884 \family typewriter
3172 \family typewriter
2885 3173 -tk
2886 \family default
3174 \family default
2887 3175 is given, IPython will try to coordinate Tk threading with GTK, Qt or WX.
2888 3176 This is however potentially unreliable, and you will have to test on your
2889 3177 platform and Python configuration to determine whether it works for you.
2890 3178 Debian users have reported success, apparently due to the fact that Debian
2891 3179 builds all of Tcl, Tk, Tkinter and Python with pthreads support.
2892 3180 Under other Linux environments (such as Fedora Core 2/3), this option has
2893 3181 caused random crashes and lockups of the Python interpreter.
2894 3182 Under other operating systems (Mac OSX and Windows), you'll need to try
2895 3183 it to find out, since currently no user reports are available.
2896 \layout List
2897 \labelwidthstring 00.00.0000
3184 \end_layout
2898 3185
2899 \SpecialChar ~
3186 \begin_layout List
3187 \labelwidthstring 00.00.0000
3188 \InsetSpace ~
2900 3189 There is unfortunately no way for IPython to determine at run time whether
2901 3190
2902 \family typewriter
3191 \family typewriter
2903 3192 -tk
2904 \family default
3193 \family default
2905 3194 will work reliably or not, so you will need to do some experiments before
2906 3195 relying on it for regular work.
2907 3196
2908 \layout Subsection
2909
3197 \end_layout
2910 3198
3199 \begin_layout Subsection
2911 3200 \begin_inset LatexCommand \label{sec:cmd-line-opts}
2912 3201
2913 \end_inset
3202 \end_inset
2914 3203
2915 3204 Regular Options
2916 \layout Standard
3205 \end_layout
2917 3206
3207 \begin_layout Standard
2918 3208 After the above threading options have been given, regular options can follow
2919 3209 in any order.
2920 3210 All options can be abbreviated to their shortest non-ambiguous form and
2921 3211 are case-sensitive.
2922 3212 One or two dashes can be used.
2923 3213 Some options have an alternate short form, indicated after a
2924 \family typewriter
3214 \family typewriter
2925 3215 |
2926 \family default
3216 \family default
2927 3217 .
2928 \layout Standard
3218 \end_layout
2929 3219
3220 \begin_layout Standard
2930 3221 Most options can also be set from your ipythonrc configuration file.
2931 3222 See the provided example for more details on what the options do.
2932 3223 Options given at the command line override the values set in the ipythonrc
2933 3224 file.
2934 \layout Standard
3225 \end_layout
2935 3226
3227 \begin_layout Standard
2936 3228 All options with a
2937 \family typewriter
3229 \family typewriter
2938 3230 [no]
2939 \family default
3231 \family default
2940 3232 prepended can be specified in negated form (
2941 \family typewriter
3233 \family typewriter
2942 3234 -nooption
2943 \family default
3235 \family default
2944 3236 instead of
2945 \family typewriter
3237 \family typewriter
2946 3238 -option
2947 \family default
3239 \family default
2948 3240 ) to turn the feature off.
2949 \layout List
2950 \labelwidthstring 00.00.0000
3241 \end_layout
2951 3242
3243 \begin_layout List
3244 \labelwidthstring 00.00.0000
2952 3245
2953 \family typewriter
2954 \series bold
3246 \family typewriter
3247 \series bold
2955 3248 -help
2956 \family default
2957 \series default
3249 \family default
3250 \series default
2958 3251 : print a help message and exit.
2959 \layout List
2960 \labelwidthstring 00.00.0000
3252 \end_layout
2961 3253
3254 \begin_layout List
3255 \labelwidthstring 00.00.0000
2962 3256
2963 \family typewriter
2964 \series bold
3257 \family typewriter
3258 \series bold
2965 3259 -pylab:
2966 \family default
2967 \series default
3260 \family default
3261 \series default
2968 3262 this can
2969 \emph on
3263 \emph on
2970 3264 only
2971 \emph default
3265 \emph default
2972 3266 be given as the
2973 \emph on
3267 \emph on
2974 3268 first
2975 \emph default
3269 \emph default
2976 3270 option passed to IPython (it will have no effect in any other position).
2977 3271 It adds special support for the matplotlib library (
2978 3272 \begin_inset LatexCommand \htmlurl[http://matplotlib.sourceforge.net]{http://matplotlib.sourceforge.net}
2979 3273
2980 \end_inset
3274 \end_inset
2981 3275
2982 3276 ), allowing interactive usage of any of its backends as defined in the user's
2983 3277
2984 \family typewriter
3278 \family typewriter
2985 3279 .matplotlibrc
2986 \family default
3280 \family default
2987 3281 file.
2988 3282 It automatically activates GTK or WX threading for IPyhton if the choice
2989 3283 of matplotlib backend requires it.
2990 3284 It also modifies the
2991 \family typewriter
3285 \family typewriter
2992 3286 %run
2993 \family default
3287 \family default
2994 3288 command to correctly execute (without blocking) any matplotlib-based script
2995 3289 which calls
2996 \family typewriter
3290 \family typewriter
2997 3291 show()
2998 \family default
3292 \family default
2999 3293 at the end.
3000 See Sec.\SpecialChar ~
3294 See Sec.\InsetSpace ~
3001 3295
3002 3296 \begin_inset LatexCommand \ref{sec:matplotlib-support}
3003 3297
3004 \end_inset
3298 \end_inset
3005 3299
3006 3300 for more details.
3007 \layout List
3008 \labelwidthstring 00.00.0000
3301 \end_layout
3009 3302
3303 \begin_layout List
3304 \labelwidthstring 00.00.0000
3010 3305
3011 \family typewriter
3012 \series bold
3306 \family typewriter
3307 \series bold
3013 3308 -autocall <val>:
3014 \family default
3015 \series default
3309 \family default
3310 \series default
3016 3311 Make IPython automatically call any callable object even if you didn't
3017 3312 type explicit parentheses.
3018 3313 For example, `str 43' becomes `str(43)' automatically.
3019 3314 The value can be `0' to disable the feature, `1' for
3020 \emph on
3315 \emph on
3021 3316 smart
3022 \emph default
3317 \emph default
3023 3318 autocall, where it is not applied if there are no more arguments on the
3024 3319 line, and `2' for
3025 \emph on
3320 \emph on
3026 3321 full
3027 \emph default
3322 \emph default
3028 3323 autocall, where all callable objects are automatically called (even if
3029 3324 no arguments are present).
3030 3325 The default is `1'.
3031 \layout List
3032 \labelwidthstring 00.00.0000
3326 \end_layout
3033 3327
3328 \begin_layout List
3329 \labelwidthstring 00.00.0000
3034 3330
3035 \family typewriter
3036 \series bold
3331 \family typewriter
3332 \series bold
3037 3333 -[no]autoindent:
3038 \family default
3039 \series default
3334 \family default
3335 \series default
3040 3336 Turn automatic indentation on/off.
3041 \layout List
3042 \labelwidthstring 00.00.0000
3337 \end_layout
3043 3338
3339 \begin_layout List
3340 \labelwidthstring 00.00.0000
3044 3341
3045 \family typewriter
3046 \series bold
3342 \family typewriter
3343 \series bold
3047 3344 -[no]automagic
3048 \series default
3345 \series default
3049 3346 :
3050 \family default
3347 \family default
3051 3348 make magic commands automatic (without needing their first character to
3052 3349 be
3053 \family typewriter
3350 \family typewriter
3054 3351 %
3055 \family default
3352 \family default
3056 3353 ).
3057 3354 Type
3058 \family typewriter
3355 \family typewriter
3059 3356 %magic
3060 \family default
3357 \family default
3061 3358 at the IPython prompt for more information.
3062 \layout List
3063 \labelwidthstring 00.00.0000
3359 \end_layout
3064 3360
3361 \begin_layout List
3362 \labelwidthstring 00.00.0000
3065 3363
3066 \family typewriter
3067 \series bold
3364 \family typewriter
3365 \series bold
3068 3366 -[no]autoedit_syntax:
3069 \family default
3070 \series default
3367 \family default
3368 \series default
3071 3369 When a syntax error occurs after editing a file, automatically open the
3072 3370 file to the trouble causing line for convenient fixing.
3073 3371
3074 \layout List
3075 \labelwidthstring 00.00.0000
3372 \end_layout
3076 3373
3374 \begin_layout List
3375 \labelwidthstring 00.00.0000
3077 3376
3078 \family typewriter
3079 \series bold
3377 \family typewriter
3378 \series bold
3080 3379 -[no]banner
3081 \series default
3380 \series default
3082 3381 :
3083 \family default
3382 \family default
3084 3383 Print the initial information banner (default on).
3085 \layout List
3086 \labelwidthstring 00.00.0000
3384 \end_layout
3087 3385
3386 \begin_layout List
3387 \labelwidthstring 00.00.0000
3088 3388
3089 \family typewriter
3090 \series bold
3091 -c\SpecialChar ~
3389 \family typewriter
3390 \series bold
3391 -c\InsetSpace ~
3092 3392 <command>:
3093 \family default
3094 \series default
3393 \family default
3394 \series default
3095 3395 execute the given command string, and set sys.argv to
3096 \family typewriter
3396 \family typewriter
3097 3397 ['c']
3098 \family default
3398 \family default
3099 3399 .
3100 3400 This is similar to the
3101 \family typewriter
3401 \family typewriter
3102 3402 -c
3103 \family default
3403 \family default
3104 3404 option in the normal Python interpreter.
3105 3405
3106 \layout List
3107 \labelwidthstring 00.00.0000
3406 \end_layout
3108 3407
3408 \begin_layout List
3409 \labelwidthstring 00.00.0000
3109 3410
3110 \family typewriter
3111 \series bold
3112 -cache_size|cs\SpecialChar ~
3411 \family typewriter
3412 \series bold
3413 -cache_size|cs\InsetSpace ~
3113 3414 <n>
3114 \series default
3415 \series default
3115 3416 :
3116 \family default
3417 \family default
3117 3418 size of the output cache (maximum number of entries to hold in memory).
3118 3419 The default is 1000, you can change it permanently in your config file.
3119 3420 Setting it to 0 completely disables the caching system, and the minimum
3120 3421 value accepted is 20 (if you provide a value less than 20, it is reset
3121 3422 to 0 and a warning is issued) This limit is defined because otherwise you'll
3122 3423 spend more time re-flushing a too small cache than working.
3123 \layout List
3124 \labelwidthstring 00.00.0000
3424 \end_layout
3125 3425
3426 \begin_layout List
3427 \labelwidthstring 00.00.0000
3126 3428
3127 \family typewriter
3128 \series bold
3429 \family typewriter
3430 \series bold
3129 3431 -classic|cl
3130 \series default
3432 \series default
3131 3433 :
3132 \family default
3434 \family default
3133 3435 Gives IPython a similar feel to the classic Python prompt.
3134 \layout List
3135 \labelwidthstring 00.00.0000
3436 \end_layout
3136 3437
3438 \begin_layout List
3439 \labelwidthstring 00.00.0000
3137 3440
3138 \family typewriter
3139 \series bold
3140 -colors\SpecialChar ~
3441 \family typewriter
3442 \series bold
3443 -colors\InsetSpace ~
3141 3444 <scheme>:
3142 \family default
3143 \series default
3445 \family default
3446 \series default
3144 3447 Color scheme for prompts and exception reporting.
3145 3448 Currently implemented: NoColor, Linux and LightBG.
3146 \layout List
3147 \labelwidthstring 00.00.0000
3449 \end_layout
3148 3450
3451 \begin_layout List
3452 \labelwidthstring 00.00.0000
3149 3453
3150 \family typewriter
3151 \series bold
3454 \family typewriter
3455 \series bold
3152 3456 -[no]color_info:
3153 \family default
3154 \series default
3457 \family default
3458 \series default
3155 3459 IPython can display information about objects via a set of functions, and
3156 3460 optionally can use colors for this, syntax highlighting source code and
3157 3461 various other elements.
3158 3462 However, because this information is passed through a pager (like 'less')
3159 3463 and many pagers get confused with color codes, this option is off by default.
3160 3464 You can test it and turn it on permanently in your ipythonrc file if it
3161 3465 works for you.
3162 3466 As a reference, the 'less' pager supplied with Mandrake 8.2 works ok, but
3163 3467 that in RedHat 7.2 doesn't.
3164 \layout List
3165 \labelwidthstring 00.00.0000
3468 \end_layout
3166 3469
3167 \SpecialChar ~
3470 \begin_layout List
3471 \labelwidthstring 00.00.0000
3472 \InsetSpace ~
3168 3473 Test it and turn it on permanently if it works with your system.
3169 3474 The magic function
3170 \family typewriter
3475 \family typewriter
3171 3476 %color_info
3172 \family default
3477 \family default
3173 3478 allows you to toggle this interactively for testing.
3174 \layout List
3175 \labelwidthstring 00.00.0000
3479 \end_layout
3176 3480
3481 \begin_layout List
3482 \labelwidthstring 00.00.0000
3177 3483
3178 \family typewriter
3179 \series bold
3484 \family typewriter
3485 \series bold
3180 3486 -[no]debug
3181 \family default
3182 \series default
3487 \family default
3488 \series default
3183 3489 : Show information about the loading process.
3184 3490 Very useful to pin down problems with your configuration files or to get
3185 3491 details about session restores.
3186 \layout List
3187 \labelwidthstring 00.00.0000
3492 \end_layout
3188 3493
3494 \begin_layout List
3495 \labelwidthstring 00.00.0000
3189 3496
3190 \family typewriter
3191 \series bold
3497 \family typewriter
3498 \series bold
3192 3499 -[no]deep_reload
3193 \series default
3500 \series default
3194 3501 :
3195 \family default
3502 \family default
3196 3503 IPython can use the
3197 \family typewriter
3504 \family typewriter
3198 3505 deep_reload
3199 \family default
3506 \family default
3200 3507 module which reloads changes in modules recursively (it replaces the
3201 \family typewriter
3508 \family typewriter
3202 3509 reload()
3203 \family default
3510 \family default
3204 3511 function, so you don't need to change anything to use it).
3205 3512
3206 \family typewriter
3513 \family typewriter
3207 3514 deep_reload()
3208 \family default
3515 \family default
3209 3516 forces a full reload of modules whose code may have changed, which the
3210 3517 default
3211 \family typewriter
3518 \family typewriter
3212 3519 reload()
3213 \family default
3520 \family default
3214 3521 function does not.
3215 \layout List
3216 \labelwidthstring 00.00.0000
3522 \end_layout
3217 3523
3218 \SpecialChar ~
3524 \begin_layout List
3525 \labelwidthstring 00.00.0000
3526 \InsetSpace ~
3219 3527 When deep_reload is off, IPython will use the normal
3220 \family typewriter
3528 \family typewriter
3221 3529 reload()
3222 \family default
3530 \family default
3223 3531 , but deep_reload will still be available as
3224 \family typewriter
3532 \family typewriter
3225 3533 dreload()
3226 \family default
3534 \family default
3227 3535 .
3228 3536 This feature is off by default [which means that you have both normal
3229 \family typewriter
3537 \family typewriter
3230 3538 reload()
3231 \family default
3539 \family default
3232 3540 and
3233 \family typewriter
3541 \family typewriter
3234 3542 dreload()
3235 \family default
3543 \family default
3236 3544 ].
3237 \layout List
3238 \labelwidthstring 00.00.0000
3545 \end_layout
3239 3546
3547 \begin_layout List
3548 \labelwidthstring 00.00.0000
3240 3549
3241 \family typewriter
3242 \series bold
3243 -editor\SpecialChar ~
3550 \family typewriter
3551 \series bold
3552 -editor\InsetSpace ~
3244 3553 <name>
3245 \family default
3246 \series default
3554 \family default
3555 \series default
3247 3556 : Which editor to use with the
3248 \family typewriter
3557 \family typewriter
3249 3558 %edit
3250 \family default
3559 \family default
3251 3560 command.
3252 3561 By default, IPython will honor your
3253 \family typewriter
3562 \family typewriter
3254 3563 EDITOR
3255 \family default
3564 \family default
3256 3565 environment variable (if not set, vi is the Unix default and notepad the
3257 3566 Windows one).
3258 3567 Since this editor is invoked on the fly by IPython and is meant for editing
3259 3568 small code snippets, you may want to use a small, lightweight editor here
3260 3569 (in case your default
3261 \family typewriter
3570 \family typewriter
3262 3571 EDITOR
3263 \family default
3572 \family default
3264 3573 is something like Emacs).
3265 \layout List
3266 \labelwidthstring 00.00.0000
3574 \end_layout
3267 3575
3576 \begin_layout List
3577 \labelwidthstring 00.00.0000
3268 3578
3269 \family typewriter
3270 \series bold
3271 -ipythondir\SpecialChar ~
3579 \family typewriter
3580 \series bold
3581 -ipythondir\InsetSpace ~
3272 3582 <name>
3273 \series default
3583 \series default
3274 3584 :
3275 \family default
3585 \family default
3276 3586 name of your IPython configuration directory
3277 \family typewriter
3587 \family typewriter
3278 3588 IPYTHONDIR
3279 \family default
3589 \family default
3280 3590 .
3281 3591 This can also be specified through the environment variable
3282 \family typewriter
3592 \family typewriter
3283 3593 IPYTHONDIR
3284 \family default
3594 \family default
3285 3595 .
3286 \layout List
3287 \labelwidthstring 00.00.0000
3596 \end_layout
3288 3597
3598 \begin_layout List
3599 \labelwidthstring 00.00.0000
3289 3600
3290 \family typewriter
3291 \series bold
3601 \family typewriter
3602 \series bold
3292 3603 -log|l
3293 \family default
3294 \series default
3604 \family default
3605 \series default
3295 3606 : generate a log file of all input.
3296 3607 The file is named
3297 \family typewriter
3608 \family typewriter
3298 3609 ipython_log.py
3299 \family default
3610 \family default
3300 3611 in your current directory (which prevents logs from multiple IPython sessions
3301 3612 from trampling each other).
3302 3613 You can use this to later restore a session by loading your logfile as
3303 3614 a file to be executed with option
3304 \family typewriter
3615 \family typewriter
3305 3616 -logplay
3306 \family default
3617 \family default
3307 3618 (see below).
3308 \layout List
3309 \labelwidthstring 00.00.0000
3619 \end_layout
3310 3620
3621 \begin_layout List
3622 \labelwidthstring 00.00.0000
3311 3623
3312 \family typewriter
3313 \series bold
3314 -logfile|lf\SpecialChar ~
3624 \family typewriter
3625 \series bold
3626 -logfile|lf\InsetSpace ~
3315 3627 <name>
3316 \series default
3628 \series default
3317 3629 :
3318 \family default
3630 \family default
3319 3631 specify the name of your logfile.
3320 \layout List
3321 \labelwidthstring 00.00.0000
3632 \end_layout
3322 3633
3634 \begin_layout List
3635 \labelwidthstring 00.00.0000
3323 3636
3324 \family typewriter
3325 \series bold
3326 -logplay|lp\SpecialChar ~
3637 \family typewriter
3638 \series bold
3639 -logplay|lp\InsetSpace ~
3327 3640 <name>
3328 \series default
3641 \series default
3329 3642 :
3330 \family default
3643 \family default
3331 3644 you can replay a previous log.
3332 3645 For restoring a session as close as possible to the state you left it in,
3333 3646 use this option (don't just run the logfile).
3334 3647 With
3335 \family typewriter
3648 \family typewriter
3336 3649 -logplay
3337 \family default
3650 \family default
3338 3651 , IPython will try to reconstruct the previous working environment in full,
3339 3652 not just execute the commands in the logfile.
3340 \layout List
3341 \labelwidthstring 00.00.0000
3653 \end_layout
3342 3654
3343 \SpecialChar ~
3655 \begin_layout List
3656 \labelwidthstring 00.00.0000
3657 \InsetSpace ~
3344 3658 When a session is restored, logging is automatically turned on again with
3345 3659 the name of the logfile it was invoked with (it is read from the log header).
3346 3660 So once you've turned logging on for a session, you can quit IPython and
3347 3661 reload it as many times as you want and it will continue to log its history
3348 3662 and restore from the beginning every time.
3349 \layout List
3350 \labelwidthstring 00.00.0000
3663 \end_layout
3351 3664
3352 \SpecialChar ~
3665 \begin_layout List
3666 \labelwidthstring 00.00.0000
3667 \InsetSpace ~
3353 3668 Caveats: there are limitations in this option.
3354 3669 The history variables
3355 \family typewriter
3670 \family typewriter
3356 3671 _i*
3357 \family default
3672 \family default
3358 3673 ,
3359 \family typewriter
3674 \family typewriter
3360 3675 _*
3361 \family default
3676 \family default
3362 3677 and
3363 \family typewriter
3678 \family typewriter
3364 3679 _dh
3365 \family default
3680 \family default
3366 3681 don't get restored properly.
3367 3682 In the future we will try to implement full session saving by writing and
3368 3683 retrieving a 'snapshot' of the memory state of IPython.
3369 3684 But our first attempts failed because of inherent limitations of Python's
3370 3685 Pickle module, so this may have to wait.
3371 \layout List
3372 \labelwidthstring 00.00.0000
3686 \end_layout
3373 3687
3688 \begin_layout List
3689 \labelwidthstring 00.00.0000
3374 3690
3375 \family typewriter
3376 \series bold
3691 \family typewriter
3692 \series bold
3377 3693 -[no]messages
3378 \series default
3694 \series default
3379 3695 :
3380 \family default
3696 \family default
3381 3697 Print messages which IPython collects about its startup process (default
3382 3698 on).
3383 \layout List
3384 \labelwidthstring 00.00.0000
3699 \end_layout
3385 3700
3701 \begin_layout List
3702 \labelwidthstring 00.00.0000
3386 3703
3387 \family typewriter
3388 \series bold
3704 \family typewriter
3705 \series bold
3389 3706 -[no]pdb
3390 \family default
3391 \series default
3707 \family default
3708 \series default
3392 3709 : Automatically call the pdb debugger after every uncaught exception.
3393 3710 If you are used to debugging using pdb, this puts you automatically inside
3394 3711 of it after any call (either in IPython or in code called by it) which
3395 3712 triggers an exception which goes uncaught.
3396 \layout List
3397 \labelwidthstring 00.00.0000
3713 \end_layout
3398 3714
3715 \begin_layout List
3716 \labelwidthstring 00.00.0000
3399 3717
3400 \family typewriter
3401 \series bold
3718 \family typewriter
3719 \series bold
3402 3720 -[no]pprint
3403 \series default
3721 \series default
3404 3722 :
3405 \family default
3723 \family default
3406 3724 ipython can optionally use the pprint (pretty printer) module for displaying
3407 3725 results.
3408 3726 pprint tends to give a nicer display of nested data structures.
3409 3727 If you like it, you can turn it on permanently in your config file (default
3410 3728 off).
3411 \layout List
3412 \labelwidthstring 00.00.0000
3729 \end_layout
3413 3730
3731 \begin_layout List
3732 \labelwidthstring 00.00.0000
3414 3733
3415 \family typewriter
3416 \series bold
3734 \family typewriter
3735 \series bold
3417 3736 -profile|p <name>
3418 \series default
3737 \series default
3419 3738 :
3420 \family default
3739 \family default
3421 3740 assume that your config file is
3422 \family typewriter
3741 \family typewriter
3423 3742 ipythonrc-<name>
3424 \family default
3743 \family default
3425 3744 (looks in current dir first, then in
3426 \family typewriter
3745 \family typewriter
3427 3746 IPYTHONDIR
3428 \family default
3747 \family default
3429 3748 ).
3430 3749 This is a quick way to keep and load multiple config files for different
3431 3750 tasks, especially if you use the include option of config files.
3432 3751 You can keep a basic
3433 \family typewriter
3752 \family typewriter
3434 3753 IPYTHONDIR/ipythonrc
3435 \family default
3754 \family default
3436 3755 file and then have other 'profiles' which include this one and load extra
3437 3756 things for particular tasks.
3438 3757 For example:
3439 \layout List
3440 \labelwidthstring 00.00.0000
3758 \end_layout
3441 3759
3760 \begin_layout List
3761 \labelwidthstring 00.00.0000
3442 3762
3443 \family typewriter
3444 \SpecialChar ~
3763 \family typewriter
3764 \InsetSpace ~
3445 3765
3446 \family default
3766 \family default
3447 3767 1.
3448 3768
3449 \family typewriter
3769 \family typewriter
3450 3770 $HOME/.ipython/ipythonrc
3451 \family default
3771 \family default
3452 3772 : load basic things you always want.
3453 \layout List
3454 \labelwidthstring 00.00.0000
3773 \end_layout
3455 3774
3775 \begin_layout List
3776 \labelwidthstring 00.00.0000
3456 3777
3457 \family typewriter
3458 \SpecialChar ~
3778 \family typewriter
3779 \InsetSpace ~
3459 3780
3460 \family default
3781 \family default
3461 3782 2.
3462 3783
3463 \family typewriter
3784 \family typewriter
3464 3785 $HOME/.ipython/ipythonrc-math
3465 \family default
3786 \family default
3466 3787 : load (1) and basic math-related modules.
3467 3788
3468 \layout List
3469 \labelwidthstring 00.00.0000
3789 \end_layout
3470 3790
3791 \begin_layout List
3792 \labelwidthstring 00.00.0000
3471 3793
3472 \family typewriter
3473 \SpecialChar ~
3794 \family typewriter
3795 \InsetSpace ~
3474 3796
3475 \family default
3797 \family default
3476 3798 3.
3477 3799
3478 \family typewriter
3800 \family typewriter
3479 3801 $HOME/.ipython/ipythonrc-numeric
3480 \family default
3802 \family default
3481 3803 : load (1) and Numeric and plotting modules.
3482 \layout List
3483 \labelwidthstring 00.00.0000
3804 \end_layout
3484 3805
3485 \SpecialChar ~
3806 \begin_layout List
3807 \labelwidthstring 00.00.0000
3808 \InsetSpace ~
3486 3809 Since it is possible to create an endless loop by having circular file
3487 3810 inclusions, IPython will stop if it reaches 15 recursive inclusions.
3488 \layout List
3489 \labelwidthstring 00.00.0000
3811 \end_layout
3490 3812
3813 \begin_layout List
3814 \labelwidthstring 00.00.0000
3491 3815
3492 \family typewriter
3493 \series bold
3494 -prompt_in1|pi1\SpecialChar ~
3816 \family typewriter
3817 \series bold
3818 -prompt_in1|pi1\InsetSpace ~
3495 3819 <string>:
3496 \family default
3497 \series default
3820 \family default
3821 \series default
3498 3822 Specify the string used for input prompts.
3499 3823 Note that if you are using numbered prompts, the number is represented
3500 3824 with a '
3501 \backslash
3825 \backslash
3502 3826 #' in the string.
3503 3827 Don't forget to quote strings with spaces embedded in them.
3504 3828 Default: '
3505 \family typewriter
3506 In\SpecialChar ~
3829 \family typewriter
3830 In\InsetSpace ~
3507 3831 [
3508 \backslash
3832 \backslash
3509 3833 #]:
3510 \family default
3834 \family default
3511 3835 '.
3512 Sec.\SpecialChar ~
3836 Sec.\InsetSpace ~
3513 3837
3514 3838 \begin_inset LatexCommand \ref{sec:prompts}
3515 3839
3516 \end_inset
3840 \end_inset
3517 3841
3518 3842 discusses in detail all the available escapes to customize your prompts.
3519 \layout List
3520 \labelwidthstring 00.00.0000
3843 \end_layout
3521 3844
3845 \begin_layout List
3846 \labelwidthstring 00.00.0000
3522 3847
3523 \family typewriter
3524 \series bold
3525 -prompt_in2|pi2\SpecialChar ~
3848 \family typewriter
3849 \series bold
3850 -prompt_in2|pi2\InsetSpace ~
3526 3851 <string>:
3527 \family default
3528 \series default
3852 \family default
3853 \series default
3529 3854 Similar to the previous option, but used for the continuation prompts.
3530 3855 The special sequence '
3531 \family typewriter
3856 \family typewriter
3532 3857
3533 \backslash
3858 \backslash
3534 3859 D
3535 \family default
3860 \family default
3536 3861 ' is similar to '
3537 \family typewriter
3862 \family typewriter
3538 3863
3539 \backslash
3864 \backslash
3540 3865 #
3541 \family default
3866 \family default
3542 3867 ', but with all digits replaced dots (so you can have your continuation
3543 3868 prompt aligned with your input prompt).
3544 3869 Default: '
3545 \family typewriter
3546 \SpecialChar ~
3547 \SpecialChar ~
3548 \SpecialChar ~
3870 \family typewriter
3871 \InsetSpace ~
3872 \InsetSpace ~
3873 \InsetSpace ~
3549 3874 .
3550 \backslash
3875 \backslash
3551 3876 D.:
3552 \family default
3877 \family default
3553 3878 ' (note three spaces at the start for alignment with '
3554 \family typewriter
3555 In\SpecialChar ~
3879 \family typewriter
3880 In\InsetSpace ~
3556 3881 [
3557 \backslash
3882 \backslash
3558 3883 #]
3559 \family default
3884 \family default
3560 3885 ').
3561 \layout List
3562 \labelwidthstring 00.00.0000
3886 \end_layout
3563 3887
3888 \begin_layout List
3889 \labelwidthstring 00.00.0000
3564 3890
3565 \family typewriter
3566 \series bold
3567 -prompt_out|po\SpecialChar ~
3891 \family typewriter
3892 \series bold
3893 -prompt_out|po\InsetSpace ~
3568 3894 <string>:
3569 \family default
3570 \series default
3895 \family default
3896 \series default
3571 3897 String used for output prompts, also uses numbers like
3572 \family typewriter
3898 \family typewriter
3573 3899 prompt_in1
3574 \family default
3900 \family default
3575 3901 .
3576 3902 Default: '
3577 \family typewriter
3903 \family typewriter
3578 3904 Out[
3579 \backslash
3905 \backslash
3580 3906 #]:
3581 \family default
3907 \family default
3582 3908 '
3583 \layout List
3584 \labelwidthstring 00.00.0000
3909 \end_layout
3585 3910
3911 \begin_layout List
3912 \labelwidthstring 00.00.0000
3586 3913
3587 \family typewriter
3588 \series bold
3914 \family typewriter
3915 \series bold
3589 3916 -quick
3590 \family default
3591 \series default
3917 \family default
3918 \series default
3592 3919 : start in bare bones mode (no config file loaded).
3593 \layout List
3594 \labelwidthstring 00.00.0000
3920 \end_layout
3595 3921
3922 \begin_layout List
3923 \labelwidthstring 00.00.0000
3596 3924
3597 \family typewriter
3598 \series bold
3599 -rcfile\SpecialChar ~
3925 \family typewriter
3926 \series bold
3927 -rcfile\InsetSpace ~
3600 3928 <name>
3601 \series default
3929 \series default
3602 3930 :
3603 \family default
3931 \family default
3604 3932 name of your IPython resource configuration file.
3605 3933 Normally IPython loads ipythonrc (from current directory) or
3606 \family typewriter
3934 \family typewriter
3607 3935 IPYTHONDIR/ipythonrc
3608 \family default
3936 \family default
3609 3937 .
3610 \layout List
3611 \labelwidthstring 00.00.0000
3938 \end_layout
3612 3939
3613 \SpecialChar ~
3940 \begin_layout List
3941 \labelwidthstring 00.00.0000
3942 \InsetSpace ~
3614 3943 If the loading of your config file fails, IPython starts with a bare bones
3615 3944 configuration (no modules loaded at all).
3616 \layout List
3617 \labelwidthstring 00.00.0000
3945 \end_layout
3618 3946
3947 \begin_layout List
3948 \labelwidthstring 00.00.0000
3619 3949
3620 \family typewriter
3621 \series bold
3950 \family typewriter
3951 \series bold
3622 3952 -[no]readline
3623 \family default
3624 \series default
3953 \family default
3954 \series default
3625 3955 : use the readline library, which is needed to support name completion and
3626 3956 command history, among other things.
3627 3957 It is enabled by default, but may cause problems for users of X/Emacs in
3628 3958 Python comint or shell buffers.
3629 \layout List
3630 \labelwidthstring 00.00.0000
3959 \end_layout
3631 3960
3632 \SpecialChar ~
3961 \begin_layout List
3962 \labelwidthstring 00.00.0000
3963 \InsetSpace ~
3633 3964 Note that X/Emacs 'eterm' buffers (opened with
3634 \family typewriter
3635 M-x\SpecialChar ~
3965 \family typewriter
3966 M-x\InsetSpace ~
3636 3967 term
3637 \family default
3968 \family default
3638 3969 ) support IPython's readline and syntax coloring fine, only 'emacs' (
3639 \family typewriter
3640 M-x\SpecialChar ~
3970 \family typewriter
3971 M-x\InsetSpace ~
3641 3972 shell
3642 \family default
3973 \family default
3643 3974 and
3644 \family typewriter
3645 C-c\SpecialChar ~
3975 \family typewriter
3976 C-c\InsetSpace ~
3646 3977 !
3647 \family default
3978 \family default
3648 3979 ) buffers do not.
3649 \layout List
3650 \labelwidthstring 00.00.0000
3980 \end_layout
3651 3981
3982 \begin_layout List
3983 \labelwidthstring 00.00.0000
3652 3984
3653 \family typewriter
3654 \series bold
3655 -screen_length|sl\SpecialChar ~
3985 \family typewriter
3986 \series bold
3987 -screen_length|sl\InsetSpace ~
3656 3988 <n>
3657 \series default
3989 \series default
3658 3990 :
3659 \family default
3991 \family default
3660 3992 number of lines of your screen.
3661 3993 This is used to control printing of very long strings.
3662 3994 Strings longer than this number of lines will be sent through a pager instead
3663 3995 of directly printed.
3664 \layout List
3665 \labelwidthstring 00.00.0000
3996 \end_layout
3666 3997
3667 \SpecialChar ~
3998 \begin_layout List
3999 \labelwidthstring 00.00.0000
4000 \InsetSpace ~
3668 4001 The default value for this is 0, which means IPython will auto-detect your
3669 4002 screen size every time it needs to print certain potentially long strings
3670 4003 (this doesn't change the behavior of the 'print' keyword, it's only triggered
3671 4004 internally).
3672 4005 If for some reason this isn't working well (it needs curses support), specify
3673 4006 it yourself.
3674 4007 Otherwise don't change the default.
3675 \layout List
3676 \labelwidthstring 00.00.0000
4008 \end_layout
3677 4009
4010 \begin_layout List
4011 \labelwidthstring 00.00.0000
3678 4012
3679 \family typewriter
3680 \series bold
3681 -separate_in|si\SpecialChar ~
4013 \family typewriter
4014 \series bold
4015 -separate_in|si\InsetSpace ~
3682 4016 <string>
3683 \series default
4017 \series default
3684 4018 :
3685 \family default
4019 \family default
3686 4020 separator before input prompts.
3687 4021 Default: '
3688 \family typewriter
4022 \family typewriter
3689 4023
3690 \backslash
4024 \backslash
3691 4025 n
3692 \family default
4026 \family default
3693 4027 '
3694 \layout List
3695 \labelwidthstring 00.00.0000
4028 \end_layout
3696 4029
4030 \begin_layout List
4031 \labelwidthstring 00.00.0000
3697 4032
3698 \family typewriter
3699 \series bold
3700 -separate_out|so\SpecialChar ~
4033 \family typewriter
4034 \series bold
4035 -separate_out|so\InsetSpace ~
3701 4036 <string>
3702 \family default
3703 \series default
4037 \family default
4038 \series default
3704 4039 : separator before output prompts.
3705 4040 Default: nothing.
3706 \layout List
3707 \labelwidthstring 00.00.0000
4041 \end_layout
3708 4042
4043 \begin_layout List
4044 \labelwidthstring 00.00.0000
3709 4045
3710 \family typewriter
3711 \series bold
3712 -separate_out2|so2\SpecialChar ~
4046 \family typewriter
4047 \series bold
4048 -separate_out2|so2\InsetSpace ~
3713 4049 <string>
3714 \series default
4050 \series default
3715 4051 :
3716 \family default
4052 \family default
3717 4053 separator after output prompts.
3718 4054 Default: nothing.
3719 \layout List
3720 \labelwidthstring 00.00.0000
4055 \end_layout
3721 4056
3722 \SpecialChar ~
3723 For these three options, use the value 0 to specify no separator.
3724 \layout List
4057 \begin_layout List
3725 4058 \labelwidthstring 00.00.0000
4059 \InsetSpace ~
4060 For these three options, use the value 0 to specify no separator.
4061 \end_layout
3726 4062
4063 \begin_layout List
4064 \labelwidthstring 00.00.0000
3727 4065
3728 \family typewriter
3729 \series bold
4066 \family typewriter
4067 \series bold
3730 4068 -nosep
3731 \series default
4069 \series default
3732 4070 :
3733 \family default
4071 \family default
3734 4072 shorthand for
3735 \family typewriter
4073 \family typewriter
3736 4074 '-SeparateIn 0 -SeparateOut 0 -SeparateOut2 0'
3737 \family default
4075 \family default
3738 4076 .
3739 4077 Simply removes all input/output separators.
3740 \layout List
3741 \labelwidthstring 00.00.0000
4078 \end_layout
3742 4079
4080 \begin_layout List
4081 \labelwidthstring 00.00.0000
3743 4082
3744 \family typewriter
3745 \series bold
4083 \family typewriter
4084 \series bold
3746 4085 -upgrade
3747 \family default
3748 \series default
4086 \family default
4087 \series default
3749 4088 : allows you to upgrade your
3750 \family typewriter
4089 \family typewriter
3751 4090 IPYTHONDIR
3752 \family default
4091 \family default
3753 4092 configuration when you install a new version of IPython.
3754 4093 Since new versions may include new command line options or example files,
3755 4094 this copies updated ipythonrc-type files.
3756 4095 However, it backs up (with a
3757 \family typewriter
4096 \family typewriter
3758 4097 .old
3759 \family default
4098 \family default
3760 4099 extension) all files which it overwrites so that you can merge back any
3761 4100 customizations you might have in your personal files.
3762 \layout List
3763 \labelwidthstring 00.00.0000
4101 \end_layout
3764 4102
4103 \begin_layout List
4104 \labelwidthstring 00.00.0000
3765 4105
3766 \family typewriter
3767 \series bold
4106 \family typewriter
4107 \series bold
3768 4108 -Version
3769 \series default
4109 \series default
3770 4110 :
3771 \family default
4111 \family default
3772 4112 print version information and exit.
3773 \layout List
3774 \labelwidthstring 00.00.0000
4113 \end_layout
3775 4114
4115 \begin_layout List
4116 \labelwidthstring 00.00.0000
3776 4117
3777 \family typewriter
3778 \series bold
3779 -wxversion\SpecialChar ~
4118 \family typewriter
4119 \series bold
4120 -wxversion\InsetSpace ~
3780 4121 <string>:
3781 \family default
3782 \series default
4122 \family default
4123 \series default
3783 4124 Select a specific version of wxPython (used in conjunction with
3784 \family typewriter
4125 \family typewriter
3785 4126 -wthread
3786 \family default
4127 \family default
3787 4128 ).
3788 4129 Requires the wxversion module, part of recent wxPython distributions
3789 \layout List
3790 \labelwidthstring 00.00.0000
4130 \end_layout
3791 4131
4132 \begin_layout List
4133 \labelwidthstring 00.00.0000
3792 4134
3793 \family typewriter
3794 \series bold
3795 -xmode\SpecialChar ~
4135 \family typewriter
4136 \series bold
4137 -xmode\InsetSpace ~
3796 4138 <modename>
3797 \series default
4139 \series default
3798 4140 :
3799 \family default
4141 \family default
3800 4142 Mode for exception reporting.
3801 \layout List
3802 \labelwidthstring 00.00.0000
4143 \end_layout
3803 4144
3804 \SpecialChar ~
3805 Valid modes: Plain, Context and Verbose.
3806 \layout List
4145 \begin_layout List
3807 4146 \labelwidthstring 00.00.0000
4147 \InsetSpace ~
4148 Valid modes: Plain, Context and Verbose.
4149 \end_layout
3808 4150
3809 \SpecialChar ~
3810 Plain: similar to python's normal traceback printing.
3811 \layout List
4151 \begin_layout List
3812 4152 \labelwidthstring 00.00.0000
4153 \InsetSpace ~
4154 Plain: similar to python's normal traceback printing.
4155 \end_layout
3813 4156
3814 \SpecialChar ~
4157 \begin_layout List
4158 \labelwidthstring 00.00.0000
4159 \InsetSpace ~
3815 4160 Context: prints 5 lines of context source code around each line in the
3816 4161 traceback.
3817 \layout List
3818 \labelwidthstring 00.00.0000
4162 \end_layout
3819 4163
3820 \SpecialChar ~
4164 \begin_layout List
4165 \labelwidthstring 00.00.0000
4166 \InsetSpace ~
3821 4167 Verbose: similar to Context, but additionally prints the variables currently
3822 4168 visible where the exception happened (shortening their strings if too long).
3823 4169 This can potentially be very slow, if you happen to have a huge data structure
3824 4170 whose string representation is complex to compute.
3825 4171 Your computer may appear to freeze for a while with cpu usage at 100%.
3826 4172 If this occurs, you can cancel the traceback with Ctrl-C (maybe hitting
3827 4173 it more than once).
3828 \layout Section
4174 \end_layout
3829 4175
4176 \begin_layout Section
3830 4177 Interactive use
3831 \layout Standard
4178 \end_layout
3832 4179
4180 \begin_layout Standard
3833 4181
3834 \series bold
4182 \series bold
3835 4183 Warning
3836 \series default
4184 \series default
3837 4185 : IPython relies on the existence of a global variable called
3838 \family typewriter
4186 \family typewriter
3839 4187 __IP
3840 \family default
4188 \family default
3841 4189 which controls the shell itself.
3842 4190 If you redefine
3843 \family typewriter
4191 \family typewriter
3844 4192 __IP
3845 \family default
4193 \family default
3846 4194 to anything, bizarre behavior will quickly occur.
3847 \layout Standard
4195 \end_layout
3848 4196
4197 \begin_layout Standard
3849 4198 Other than the above warning, IPython is meant to work as a drop-in replacement
3850 4199 for the standard interactive interpreter.
3851 4200 As such, any code which is valid python should execute normally under IPython
3852 4201 (cases where this is not true should be reported as bugs).
3853 4202 It does, however, offer many features which are not available at a standard
3854 4203 python prompt.
3855 4204 What follows is a list of these.
3856 \layout Subsection
4205 \end_layout
3857 4206
4207 \begin_layout Subsection
3858 4208 Caution for Windows users
3859 \layout Standard
4209 \end_layout
3860 4210
4211 \begin_layout Standard
3861 4212 Windows, unfortunately, uses the `
3862 \family typewriter
4213 \family typewriter
3863 4214
3864 \backslash
4215 \backslash
3865 4216
3866 \family default
4217 \family default
3867 4218 ' character as a path separator.
3868 4219 This is a terrible choice, because `
3869 \family typewriter
4220 \family typewriter
3870 4221
3871 \backslash
4222 \backslash
3872 4223
3873 \family default
4224 \family default
3874 4225 ' also represents the escape character in most modern programming languages,
3875 4226 including Python.
3876 4227 For this reason, issuing many of the commands discussed below (especially
3877 4228 magics which affect the filesystem) with `
3878 \family typewriter
4229 \family typewriter
3879 4230
3880 \backslash
4231 \backslash
3881 4232
3882 \family default
4233 \family default
3883 4234 ' in them will cause strange errors.
3884 \layout Standard
4235 \end_layout
3885 4236
4237 \begin_layout Standard
3886 4238 A partial solution is to use instead the `
3887 \family typewriter
4239 \family typewriter
3888 4240 /
3889 \family default
4241 \family default
3890 4242 ' character as a path separator, which Windows recognizes in
3891 \emph on
4243 \emph on
3892 4244 most
3893 \emph default
4245 \emph default
3894 4246 situations.
3895 4247 However, in Windows commands `
3896 \family typewriter
4248 \family typewriter
3897 4249 /
3898 \family default
4250 \family default
3899 4251 ' flags options, so you can not use it for the root directory.
3900 4252 This means that paths beginning at the root must be typed in a contrived
3901 4253 manner like:
3902 \newline
4254 \newline
3903 4255
3904 \family typewriter
4256 \family typewriter
3905 4257 %copy
3906 \backslash
4258 \backslash
3907 4259 opt/foo/bar.txt
3908 \backslash
4260 \backslash
3909 4261 tmp
3910 \layout Standard
4262 \end_layout
3911 4263
4264 \begin_layout Standard
3912 4265 There is no sensible thing IPython can do to truly work around this flaw
3913 4266 in Windows
3914 4267 \begin_inset Foot
3915 collapsed true
3916
3917 \layout Standard
4268 status collapsed
3918 4269
4270 \begin_layout Standard
3919 4271 If anyone comes up with a
3920 \emph on
4272 \emph on
3921 4273 clean
3922 \emph default
4274 \emph default
3923 4275 solution which works consistently and does not negatively impact other
3924 4276 platforms at all, I'll gladly accept a patch.
3925 \end_inset
4277 \end_layout
3926 4278
3927 .
3928 \layout Subsection
4279 \end_inset
3929 4280
4281 .
4282 \end_layout
3930 4283
4284 \begin_layout Subsection
3931 4285 \begin_inset LatexCommand \label{sec:magic}
3932 4286
3933 \end_inset
4287 \end_inset
3934 4288
3935 4289 Magic command system
3936 \layout Standard
4290 \end_layout
3937 4291
4292 \begin_layout Standard
3938 4293 IPython will treat any line whose first character is a
3939 \family typewriter
4294 \family typewriter
3940 4295 %
3941 \family default
4296 \family default
3942 4297 as a special call to a 'magic' function.
3943 4298 These allow you to control the behavior of IPython itself, plus a lot of
3944 4299 system-type features.
3945 4300 They are all prefixed with a
3946 \family typewriter
4301 \family typewriter
3947 4302 %
3948 \family default
4303 \family default
3949 4304 character, but parameters are given without parentheses or quotes.
3950 \layout Standard
4305 \end_layout
3951 4306
4307 \begin_layout Standard
3952 4308 Example: typing
3953 \family typewriter
4309 \family typewriter
3954 4310 '%cd mydir'
3955 \family default
4311 \family default
3956 4312 (without the quotes) changes you working directory to
3957 \family typewriter
4313 \family typewriter
3958 4314 'mydir'
3959 \family default
4315 \family default
3960 4316 , if it exists.
3961 \layout Standard
4317 \end_layout
3962 4318
4319 \begin_layout Standard
3963 4320 If you have 'automagic' enabled (in your
3964 \family typewriter
4321 \family typewriter
3965 4322 ipythonrc
3966 \family default
4323 \family default
3967 4324 file, via the command line option
3968 \family typewriter
4325 \family typewriter
3969 4326 -automagic
3970 \family default
4327 \family default
3971 4328 or with the
3972 \family typewriter
4329 \family typewriter
3973 4330 %automagic
3974 \family default
4331 \family default
3975 4332 function), you don't need to type in the
3976 \family typewriter
4333 \family typewriter
3977 4334 %
3978 \family default
4335 \family default
3979 4336 explicitly.
3980 4337 IPython will scan its internal list of magic functions and call one if
3981 4338 it exists.
3982 4339 With automagic on you can then just type '
3983 \family typewriter
4340 \family typewriter
3984 4341 cd mydir
3985 \family default
4342 \family default
3986 4343 ' to go to directory '
3987 \family typewriter
4344 \family typewriter
3988 4345 mydir
3989 \family default
4346 \family default
3990 4347 '.
3991 4348 The automagic system has the lowest possible precedence in name searches,
3992 4349 so defining an identifier with the same name as an existing magic function
3993 4350 will shadow it for automagic use.
3994 4351 You can still access the shadowed magic function by explicitly using the
3995 4352
3996 \family typewriter
4353 \family typewriter
3997 4354 %
3998 \family default
4355 \family default
3999 4356 character at the beginning of the line.
4000 \layout Standard
4357 \end_layout
4001 4358
4359 \begin_layout Standard
4002 4360 An example (with automagic on) should clarify all this:
4003 \layout LyX-Code
4361 \end_layout
4004 4362
4363 \begin_layout LyX-Code
4005 4364 In [1]: cd ipython # %cd is called by automagic
4006 \layout LyX-Code
4365 \end_layout
4007 4366
4367 \begin_layout LyX-Code
4008 4368 /home/fperez/ipython
4009 \layout LyX-Code
4369 \end_layout
4010 4370
4371 \begin_layout LyX-Code
4011 4372 In [2]: cd=1 # now cd is just a variable
4012 \layout LyX-Code
4373 \end_layout
4013 4374
4375 \begin_layout LyX-Code
4014 4376 In [3]: cd ..
4015 4377 # and doesn't work as a function anymore
4016 \layout LyX-Code
4378 \end_layout
4017 4379
4380 \begin_layout LyX-Code
4018 4381 ------------------------------------------------------------
4019 \layout LyX-Code
4382 \end_layout
4020 4383
4384 \begin_layout LyX-Code
4021 4385 File "<console>", line 1
4022 \layout LyX-Code
4386 \end_layout
4023 4387
4388 \begin_layout LyX-Code
4024 4389 cd ..
4025 \layout LyX-Code
4390 \end_layout
4026 4391
4392 \begin_layout LyX-Code
4027 4393 ^
4028 \layout LyX-Code
4394 \end_layout
4029 4395
4396 \begin_layout LyX-Code
4030 4397 SyntaxError: invalid syntax
4031 \layout LyX-Code
4398 \end_layout
4399
4400 \begin_layout LyX-Code
4032 4401
4033 \layout LyX-Code
4402 \end_layout
4034 4403
4404 \begin_layout LyX-Code
4035 4405 In [4]: %cd ..
4036 4406 # but %cd always works
4037 \layout LyX-Code
4407 \end_layout
4038 4408
4409 \begin_layout LyX-Code
4039 4410 /home/fperez
4040 \layout LyX-Code
4411 \end_layout
4041 4412
4413 \begin_layout LyX-Code
4042 4414 In [5]: del cd # if you remove the cd variable
4043 \layout LyX-Code
4415 \end_layout
4044 4416
4417 \begin_layout LyX-Code
4045 4418 In [6]: cd ipython # automagic can work again
4046 \layout LyX-Code
4419 \end_layout
4047 4420
4421 \begin_layout LyX-Code
4048 4422 /home/fperez/ipython
4049 \layout Standard
4423 \end_layout
4050 4424
4425 \begin_layout Standard
4051 4426 You can define your own magic functions to extend the system.
4052 4427 The following is a snippet of code which shows how to do it.
4053 4428 It is provided as file
4054 \family typewriter
4429 \family typewriter
4055 4430 example-magic.py
4056 \family default
4431 \family default
4057 4432 in the examples directory:
4058 \layout Standard
4059
4433 \end_layout
4060 4434
4435 \begin_layout Standard
4061 4436 \begin_inset ERT
4062 status Open
4437 status open
4438
4439 \begin_layout Standard
4063 4440
4064 \layout Standard
4065 4441
4066 \backslash
4442 \backslash
4067 4443 codelist{examples/example-magic.py}
4068 \end_inset
4444 \end_layout
4445
4446 \end_inset
4069 4447
4070 4448
4071 \layout Standard
4449 \end_layout
4072 4450
4451 \begin_layout Standard
4073 4452 You can also define your own aliased names for magic functions.
4074 4453 In your
4075 \family typewriter
4454 \family typewriter
4076 4455 ipythonrc
4077 \family default
4456 \family default
4078 4457 file, placing a line like:
4079 \layout Standard
4458 \end_layout
4080 4459
4460 \begin_layout Standard
4081 4461
4082 \family typewriter
4462 \family typewriter
4083 4463 execute __IP.magic_cl = __IP.magic_clear
4084 \layout Standard
4464 \end_layout
4085 4465
4466 \begin_layout Standard
4086 4467 will define
4087 \family typewriter
4468 \family typewriter
4088 4469 %cl
4089 \family default
4470 \family default
4090 4471 as a new name for
4091 \family typewriter
4472 \family typewriter
4092 4473 %clear
4093 \family default
4474 \family default
4094 4475 .
4095 \layout Standard
4476 \end_layout
4096 4477
4478 \begin_layout Standard
4097 4479 Type
4098 \family typewriter
4480 \family typewriter
4099 4481 %magic
4100 \family default
4482 \family default
4101 4483 for more information, including a list of all available magic functions
4102 4484 at any time and their docstrings.
4103 4485 You can also type
4104 \family typewriter
4486 \family typewriter
4105 4487 %magic_function_name?
4106 \family default
4488 \family default
4107 4489 (see sec.
4108 4490
4109 4491 \begin_inset LatexCommand \ref{sec:dyn-object-info}
4110 4492
4111 \end_inset
4493 \end_inset
4112 4494
4113 4495 for information on the
4114 \family typewriter
4496 \family typewriter
4115 4497 '?'
4116 \family default
4498 \family default
4117 4499 system) to get information about any particular magic function you are
4118 4500 interested in.
4119 \layout Subsubsection
4501 \end_layout
4120 4502
4503 \begin_layout Subsubsection
4121 4504 Magic commands
4122 \layout Standard
4505 \end_layout
4123 4506
4507 \begin_layout Standard
4124 4508 The rest of this section is automatically generated for each release from
4125 4509 the docstrings in the IPython code.
4126 4510 Therefore the formatting is somewhat minimal, but this method has the advantage
4127 4511 of having information always in sync with the code.
4128 \layout Standard
4512 \end_layout
4129 4513
4514 \begin_layout Standard
4130 4515 A list of all the magic commands available in IPython's
4131 \emph on
4516 \emph on
4132 4517 default
4133 \emph default
4518 \emph default
4134 4519 installation follows.
4135 4520 This is similar to what you'll see by simply typing
4136 \family typewriter
4521 \family typewriter
4137 4522 %magic
4138 \family default
4523 \family default
4139 4524 at the prompt, but that will also give you information about magic commands
4140 4525 you may have added as part of your personal customizations.
4141 \layout Standard
4142
4526 \end_layout
4143 4527
4528 \begin_layout Standard
4144 4529 \begin_inset Include \input{magic.tex}
4145 4530 preview false
4146 4531
4147 \end_inset
4532 \end_inset
4148 4533
4149 4534
4150 \layout Subsection
4535 \end_layout
4151 4536
4537 \begin_layout Subsection
4152 4538 Access to the standard Python help
4153 \layout Standard
4539 \end_layout
4154 4540
4541 \begin_layout Standard
4155 4542 As of Python 2.1, a help system is available with access to object docstrings
4156 4543 and the Python manuals.
4157 4544 Simply type
4158 \family typewriter
4545 \family typewriter
4159 4546 'help'
4160 \family default
4547 \family default
4161 4548 (no quotes) to access it.
4162 4549 You can also type
4163 \family typewriter
4550 \family typewriter
4164 4551 help(object)
4165 \family default
4552 \family default
4166 4553 to obtain information about a given object, and
4167 \family typewriter
4554 \family typewriter
4168 4555 help('keyword')
4169 \family default
4556 \family default
4170 4557 for information on a keyword.
4171 4558 As noted in sec.
4172 4559
4173 4560 \begin_inset LatexCommand \ref{sec:help-access}
4174 4561
4175 \end_inset
4562 \end_inset
4176 4563
4177 4564 , you need to properly configure your environment variable
4178 \family typewriter
4565 \family typewriter
4179 4566 PYTHONDOCS
4180 \family default
4567 \family default
4181 4568 for this feature to work correctly.
4182 \layout Subsection
4183
4569 \end_layout
4184 4570
4571 \begin_layout Subsection
4185 4572 \begin_inset LatexCommand \label{sec:dyn-object-info}
4186 4573
4187 \end_inset
4574 \end_inset
4188 4575
4189 4576 Dynamic object information
4190 \layout Standard
4577 \end_layout
4191 4578
4579 \begin_layout Standard
4192 4580 Typing
4193 \family typewriter
4581 \family typewriter
4194 4582 ?word
4195 \family default
4583 \family default
4196 4584 or
4197 \family typewriter
4585 \family typewriter
4198 4586 word?
4199 \family default
4587 \family default
4200 4588 prints detailed information about an object.
4201 4589 If certain strings in the object are too long (docstrings, code, etc.) they
4202 4590 get snipped in the center for brevity.
4203 4591 This system gives access variable types and values, full source code for
4204 4592 any object (if available), function prototypes and other useful information.
4205 \layout Standard
4593 \end_layout
4206 4594
4595 \begin_layout Standard
4207 4596 Typing
4208 \family typewriter
4597 \family typewriter
4209 4598 ??word
4210 \family default
4599 \family default
4211 4600 or
4212 \family typewriter
4601 \family typewriter
4213 4602 word??
4214 \family default
4603 \family default
4215 4604 gives access to the full information without snipping long strings.
4216 4605 Long strings are sent to the screen through the
4217 \family typewriter
4606 \family typewriter
4218 4607 less
4219 \family default
4608 \family default
4220 4609 pager if longer than the screen and printed otherwise.
4221 4610 On systems lacking the
4222 \family typewriter
4611 \family typewriter
4223 4612 less
4224 \family default
4613 \family default
4225 4614 command, IPython uses a very basic internal pager.
4226 \layout Standard
4615 \end_layout
4227 4616
4617 \begin_layout Standard
4228 4618 The following magic functions are particularly useful for gathering information
4229 4619 about your working environment.
4230 4620 You can get more details by typing
4231 \family typewriter
4621 \family typewriter
4232 4622 %magic
4233 \family default
4623 \family default
4234 4624 or querying them individually (use
4235 \family typewriter
4625 \family typewriter
4236 4626 %function_name?
4237 \family default
4627 \family default
4238 4628 with or without the
4239 \family typewriter
4629 \family typewriter
4240 4630 %
4241 \family default
4631 \family default
4242 4632 ), this is just a summary:
4243 \layout List
4244 \labelwidthstring 00.00.0000
4633 \end_layout
4245 4634
4635 \begin_layout List
4636 \labelwidthstring 00.00.0000
4246 4637
4247 \family typewriter
4248 \series bold
4249 %pdoc\SpecialChar ~
4638 \family typewriter
4639 \series bold
4640 %pdoc\InsetSpace ~
4250 4641 <object>
4251 \family default
4252 \series default
4642 \family default
4643 \series default
4253 4644 : Print (or run through a pager if too long) the docstring for an object.
4254 4645 If the given object is a class, it will print both the class and the constructo
4255 4646 r docstrings.
4256 \layout List
4257 \labelwidthstring 00.00.0000
4647 \end_layout
4258 4648
4649 \begin_layout List
4650 \labelwidthstring 00.00.0000
4259 4651
4260 \family typewriter
4261 \series bold
4262 %pdef\SpecialChar ~
4652 \family typewriter
4653 \series bold
4654 %pdef\InsetSpace ~
4263 4655 <object>
4264 \family default
4265 \series default
4656 \family default
4657 \series default
4266 4658 : Print the definition header for any callable object.
4267 4659 If the object is a class, print the constructor information.
4268 \layout List
4269 \labelwidthstring 00.00.0000
4660 \end_layout
4270 4661
4662 \begin_layout List
4663 \labelwidthstring 00.00.0000
4271 4664
4272 \family typewriter
4273 \series bold
4274 %psource\SpecialChar ~
4665 \family typewriter
4666 \series bold
4667 %psource\InsetSpace ~
4275 4668 <object>
4276 \family default
4277 \series default
4669 \family default
4670 \series default
4278 4671 : Print (or run through a pager if too long) the source code for an object.
4279 \layout List
4280 \labelwidthstring 00.00.0000
4672 \end_layout
4281 4673
4674 \begin_layout List
4675 \labelwidthstring 00.00.0000
4282 4676
4283 \family typewriter
4284 \series bold
4285 %pfile\SpecialChar ~
4677 \family typewriter
4678 \series bold
4679 %pfile\InsetSpace ~
4286 4680 <object>
4287 \family default
4288 \series default
4681 \family default
4682 \series default
4289 4683 : Show the entire source file where an object was defined via a pager, opening
4290 4684 it at the line where the object definition begins.
4291 \layout List
4292 \labelwidthstring 00.00.0000
4685 \end_layout
4293 4686
4687 \begin_layout List
4688 \labelwidthstring 00.00.0000
4294 4689
4295 \family typewriter
4296 \series bold
4690 \family typewriter
4691 \series bold
4297 4692 %who/%whos
4298 \family default
4299 \series default
4693 \family default
4694 \series default
4300 4695 : These functions give information about identifiers you have defined interactiv
4301 4696 ely (not things you loaded or defined in your configuration files).
4302 4697
4303 \family typewriter
4698 \family typewriter
4304 4699 %who
4305 \family default
4700 \family default
4306 4701 just prints a list of identifiers and
4307 \family typewriter
4702 \family typewriter
4308 4703 %whos
4309 \family default
4704 \family default
4310 4705 prints a table with some basic details about each identifier.
4311 \layout Standard
4706 \end_layout
4312 4707
4708 \begin_layout Standard
4313 4709 Note that the dynamic object information functions (
4314 \family typewriter
4710 \family typewriter
4315 4711 ?/??, %pdoc, %pfile, %pdef, %psource
4316 \family default
4712 \family default
4317 4713 ) give you access to documentation even on things which are not really defined
4318 4714 as separate identifiers.
4319 4715 Try for example typing
4320 \family typewriter
4716 \family typewriter
4321 4717 {}.get?
4322 \family default
4718 \family default
4323 4719 or after doing
4324 \family typewriter
4720 \family typewriter
4325 4721 import os
4326 \family default
4722 \family default
4327 4723 , type
4328 \family typewriter
4724 \family typewriter
4329 4725 os.path.abspath??
4330 \family default
4726 \family default
4331 4727 .
4332 \layout Subsection
4333
4728 \end_layout
4334 4729
4730 \begin_layout Subsection
4335 4731 \begin_inset LatexCommand \label{sec:readline}
4336 4732
4337 \end_inset
4733 \end_inset
4338 4734
4339 4735 Readline-based features
4340 \layout Standard
4736 \end_layout
4341 4737
4738 \begin_layout Standard
4342 4739 These features require the GNU readline library, so they won't work if your
4343 4740 Python installation lacks readline support.
4344 4741 We will first describe the default behavior IPython uses, and then how
4345 4742 to change it to suit your preferences.
4346 \layout Subsubsection
4743 \end_layout
4347 4744
4745 \begin_layout Subsubsection
4348 4746 Command line completion
4349 \layout Standard
4747 \end_layout
4350 4748
4749 \begin_layout Standard
4351 4750 At any time, hitting TAB will complete any available python commands or
4352 4751 variable names, and show you a list of the possible completions if there's
4353 4752 no unambiguous one.
4354 4753 It will also complete filenames in the current directory if no python names
4355 4754 match what you've typed so far.
4356 \layout Subsubsection
4755 \end_layout
4357 4756
4757 \begin_layout Subsubsection
4358 4758 Search command history
4359 \layout Standard
4759 \end_layout
4360 4760
4761 \begin_layout Standard
4361 4762 IPython provides two ways for searching through previous input and thus
4362 4763 reduce the need for repetitive typing:
4363 \layout Enumerate
4764 \end_layout
4364 4765
4766 \begin_layout Enumerate
4365 4767 Start typing, and then use
4366 \family typewriter
4768 \family typewriter
4367 4769 Ctrl-p
4368 \family default
4770 \family default
4369 4771 (previous,up) and
4370 \family typewriter
4772 \family typewriter
4371 4773 Ctrl-n
4372 \family default
4774 \family default
4373 4775 (next,down) to search through only the history items that match what you've
4374 4776 typed so far.
4375 4777 If you use
4376 \family typewriter
4778 \family typewriter
4377 4779 Ctrl-p/Ctrl-n
4378 \family default
4780 \family default
4379 4781 at a blank prompt, they just behave like normal arrow keys.
4380 \layout Enumerate
4782 \end_layout
4381 4783
4784 \begin_layout Enumerate
4382 4785 Hit
4383 \family typewriter
4786 \family typewriter
4384 4787 Ctrl-r
4385 \family default
4788 \family default
4386 4789 : opens a search prompt.
4387 4790 Begin typing and the system searches your history for lines that contain
4388 4791 what you've typed so far, completing as much as it can.
4389 \layout Subsubsection
4792 \end_layout
4390 4793
4794 \begin_layout Subsubsection
4391 4795 Persistent command history across sessions
4392 \layout Standard
4796 \end_layout
4393 4797
4798 \begin_layout Standard
4394 4799 IPython will save your input history when it leaves and reload it next time
4395 4800 you restart it.
4396 4801 By default, the history file is named
4397 \family typewriter
4802 \family typewriter
4398 4803 $IPYTHONDIR/history
4399 \family default
4804 \family default
4400 4805 , but if you've loaded a named profile, '
4401 \family typewriter
4806 \family typewriter
4402 4807 -PROFILE_NAME
4403 \family default
4808 \family default
4404 4809 ' is appended to the name.
4405 4810 This allows you to keep separate histories related to various tasks: commands
4406 4811 related to numerical work will not be clobbered by a system shell history,
4407 4812 for example.
4408 \layout Subsubsection
4813 \end_layout
4409 4814
4815 \begin_layout Subsubsection
4410 4816 Autoindent
4411 \layout Standard
4817 \end_layout
4412 4818
4819 \begin_layout Standard
4413 4820 IPython can recognize lines ending in ':' and indent the next line, while
4414 4821 also un-indenting automatically after 'raise' or 'return'.
4415 4822
4416 \layout Standard
4823 \end_layout
4417 4824
4825 \begin_layout Standard
4418 4826 This feature uses the readline library, so it will honor your
4419 \family typewriter
4827 \family typewriter
4420 4828 ~/.inputrc
4421 \family default
4829 \family default
4422 4830 configuration (or whatever file your
4423 \family typewriter
4831 \family typewriter
4424 4832 INPUTRC
4425 \family default
4833 \family default
4426 4834 variable points to).
4427 4835 Adding the following lines to your
4428 \family typewriter
4836 \family typewriter
4429 4837 .inputrc
4430 \family default
4838 \family default
4431 4839 file can make indenting/unindenting more convenient (
4432 \family typewriter
4840 \family typewriter
4433 4841 M-i
4434 \family default
4842 \family default
4435 4843 indents,
4436 \family typewriter
4844 \family typewriter
4437 4845 M-u
4438 \family default
4846 \family default
4439 4847 unindents):
4440 \layout Standard
4848 \end_layout
4441 4849
4850 \begin_layout Standard
4442 4851
4443 \family typewriter
4852 \family typewriter
4444 4853 $if Python
4445 \newline
4854 \newline
4446 4855 "
4447 \backslash
4448 M-i": "\SpecialChar ~
4449 \SpecialChar ~
4450 \SpecialChar ~
4451 \SpecialChar ~
4856 \backslash
4857 M-i": "\InsetSpace ~
4858 \InsetSpace ~
4859 \InsetSpace ~
4860 \InsetSpace ~
4452 4861 "
4453 \newline
4862 \newline
4454 4863 "
4455 \backslash
4864 \backslash
4456 4865 M-u": "
4457 \backslash
4866 \backslash
4458 4867 d
4459 \backslash
4868 \backslash
4460 4869 d
4461 \backslash
4870 \backslash
4462 4871 d
4463 \backslash
4872 \backslash
4464 4873 d"
4465 \newline
4874 \newline
4466 4875 $endif
4467 \layout Standard
4876 \end_layout
4468 4877
4878 \begin_layout Standard
4469 4879 Note that there are 4 spaces between the quote marks after
4470 \family typewriter
4880 \family typewriter
4471 4881 "M-i"
4472 \family default
4882 \family default
4473 4883 above.
4474 \layout Standard
4884 \end_layout
4475 4885
4886 \begin_layout Standard
4476 4887
4477 \series bold
4888 \series bold
4478 4889 Warning:
4479 \series default
4890 \series default
4480 4891 this feature is ON by default, but it can cause problems with the pasting
4481 4892 of multi-line indented code (the pasted code gets re-indented on each line).
4482 4893 A magic function
4483 \family typewriter
4894 \family typewriter
4484 4895 %autoindent
4485 \family default
4896 \family default
4486 4897 allows you to toggle it on/off at runtime.
4487 4898 You can also disable it permanently on in your
4488 \family typewriter
4899 \family typewriter
4489 4900 ipythonrc
4490 \family default
4901 \family default
4491 4902 file (set
4492 \family typewriter
4903 \family typewriter
4493 4904 autoindent 0
4494 \family default
4905 \family default
4495 4906 ).
4496 \layout Subsubsection
4907 \end_layout
4497 4908
4909 \begin_layout Subsubsection
4498 4910 Customizing readline behavior
4499 \layout Standard
4911 \end_layout
4500 4912
4913 \begin_layout Standard
4501 4914 All these features are based on the GNU readline library, which has an extremely
4502 4915 customizable interface.
4503 4916 Normally, readline is configured via a file which defines the behavior
4504 4917 of the library; the details of the syntax for this can be found in the
4505 4918 readline documentation available with your system or on the Internet.
4506 4919 IPython doesn't read this file (if it exists) directly, but it does support
4507 4920 passing to readline valid options via a simple interface.
4508 4921 In brief, you can customize readline by setting the following options in
4509 4922 your
4510 \family typewriter
4923 \family typewriter
4511 4924 ipythonrc
4512 \family default
4925 \family default
4513 4926 configuration file (note that these options can
4514 \emph on
4927 \emph on
4515 4928 not
4516 \emph default
4929 \emph default
4517 4930 be specified at the command line):
4518 \layout List
4519 \labelwidthstring 00.00.0000
4931 \end_layout
4520 4932
4933 \begin_layout List
4934 \labelwidthstring 00.00.0000
4521 4935
4522 \family typewriter
4523 \series bold
4936 \family typewriter
4937 \series bold
4524 4938 readline_parse_and_bind:
4525 \family default
4526 \series default
4939 \family default
4940 \series default
4527 4941 this option can appear as many times as you want, each time defining a
4528 4942 string to be executed via a
4529 \family typewriter
4943 \family typewriter
4530 4944 readline.parse_and_bind()
4531 \family default
4945 \family default
4532 4946 command.
4533 4947 The syntax for valid commands of this kind can be found by reading the
4534 4948 documentation for the GNU readline library, as these commands are of the
4535 4949 kind which readline accepts in its configuration file.
4536 \layout List
4537 \labelwidthstring 00.00.0000
4950 \end_layout
4538 4951
4952 \begin_layout List
4953 \labelwidthstring 00.00.0000
4539 4954
4540 \family typewriter
4541 \series bold
4955 \family typewriter
4956 \series bold
4542 4957 readline_remove_delims:
4543 \family default
4544 \series default
4958 \family default
4959 \series default
4545 4960 a string of characters to be removed from the default word-delimiters list
4546 4961 used by readline, so that completions may be performed on strings which
4547 4962 contain them.
4548 4963 Do not change the default value unless you know what you're doing.
4549 \layout List
4550 \labelwidthstring 00.00.0000
4964 \end_layout
4551 4965
4966 \begin_layout List
4967 \labelwidthstring 00.00.0000
4552 4968
4553 \family typewriter
4554 \series bold
4969 \family typewriter
4970 \series bold
4555 4971 readline_omit__names
4556 \family default
4557 \series default
4972 \family default
4973 \series default
4558 4974 : when tab-completion is enabled, hitting
4559 \family typewriter
4975 \family typewriter
4560 4976 <tab>
4561 \family default
4977 \family default
4562 4978 after a '
4563 \family typewriter
4979 \family typewriter
4564 4980 .
4565 \family default
4981 \family default
4566 4982 ' in a name will complete all attributes of an object, including all the
4567 4983 special methods whose names include double underscores (like
4568 \family typewriter
4984 \family typewriter
4569 4985 __getitem__
4570 \family default
4986 \family default
4571 4987 or
4572 \family typewriter
4988 \family typewriter
4573 4989 __class__
4574 \family default
4990 \family default
4575 4991 ).
4576 4992 If you'd rather not see these names by default, you can set this option
4577 4993 to 1.
4578 4994 Note that even when this option is set, you can still see those names by
4579 4995 explicitly typing a
4580 \family typewriter
4996 \family typewriter
4581 4997 _
4582 \family default
4998 \family default
4583 4999 after the period and hitting
4584 \family typewriter
5000 \family typewriter
4585 5001 <tab>
4586 \family default
5002 \family default
4587 5003 : '
4588 \family typewriter
5004 \family typewriter
4589 5005 name._<tab>
4590 \family default
5006 \family default
4591 5007 ' will always complete attribute names starting with '
4592 \family typewriter
5008 \family typewriter
4593 5009 _
4594 \family default
5010 \family default
4595 5011 '.
4596 \layout List
4597 \labelwidthstring 00.00.0000
5012 \end_layout
4598 5013
4599 \SpecialChar ~
5014 \begin_layout List
5015 \labelwidthstring 00.00.0000
5016 \InsetSpace ~
4600 5017 This option is off by default so that new users see all attributes of any
4601 5018 objects they are dealing with.
4602 \layout Standard
5019 \end_layout
4603 5020
5021 \begin_layout Standard
4604 5022 You will find the default values along with a corresponding detailed explanation
4605 5023 in your
4606 \family typewriter
5024 \family typewriter
4607 5025 ipythonrc
4608 \family default
5026 \family default
4609 5027 file.
4610 \layout Subsection
5028 \end_layout
4611 5029
5030 \begin_layout Subsection
4612 5031 Session logging and restoring
4613 \layout Standard
5032 \end_layout
4614 5033
5034 \begin_layout Standard
4615 5035 You can log all input from a session either by starting IPython with the
4616 5036 command line switches
4617 \family typewriter
5037 \family typewriter
4618 5038 -log
4619 \family default
5039 \family default
4620 5040 or
4621 \family typewriter
5041 \family typewriter
4622 5042 -logfile
4623 \family default
5043 \family default
4624 5044 (see sec.
4625 5045
4626 5046 \begin_inset LatexCommand \ref{sec:cmd-line-opts}
4627 5047
4628 \end_inset
5048 \end_inset
4629 5049
4630 5050 )or by activating the logging at any moment with the magic function
4631 \family typewriter
5051 \family typewriter
4632 5052 %logstart
4633 \family default
5053 \family default
4634 5054 .
4635 5055
4636 \layout Standard
5056 \end_layout
4637 5057
5058 \begin_layout Standard
4638 5059 Log files can later be reloaded with the
4639 \family typewriter
5060 \family typewriter
4640 5061 -logplay
4641 \family default
5062 \family default
4642 5063 option and IPython will attempt to 'replay' the log by executing all the
4643 5064 lines in it, thus restoring the state of a previous session.
4644 5065 This feature is not quite perfect, but can still be useful in many cases.
4645 \layout Standard
5066 \end_layout
4646 5067
5068 \begin_layout Standard
4647 5069 The log files can also be used as a way to have a permanent record of any
4648 5070 code you wrote while experimenting.
4649 5071 Log files are regular text files which you can later open in your favorite
4650 5072 text editor to extract code or to 'clean them up' before using them to
4651 5073 replay a session.
4652 \layout Standard
5074 \end_layout
4653 5075
5076 \begin_layout Standard
4654 5077 The
4655 \family typewriter
5078 \family typewriter
4656 5079 %logstart
4657 \family default
5080 \family default
4658 5081 function for activating logging in mid-session is used as follows:
4659 \layout Standard
5082 \end_layout
4660 5083
5084 \begin_layout Standard
4661 5085
4662 \family typewriter
5086 \family typewriter
4663 5087 %logstart [log_name [log_mode]]
4664 \layout Standard
5088 \end_layout
4665 5089
5090 \begin_layout Standard
4666 5091 If no name is given, it defaults to a file named
4667 \family typewriter
5092 \family typewriter
4668 5093 'log'
4669 \family default
5094 \family default
4670 5095 in your IPYTHONDIR directory, in
4671 \family typewriter
5096 \family typewriter
4672 5097 'rotate'
4673 \family default
5098 \family default
4674 5099 mode (see below).
4675 \layout Standard
5100 \end_layout
4676 5101
5102 \begin_layout Standard
4677 5103 '
4678 \family typewriter
5104 \family typewriter
4679 5105 %logstart name
4680 \family default
5106 \family default
4681 5107 ' saves to file
4682 \family typewriter
5108 \family typewriter
4683 5109 'name'
4684 \family default
5110 \family default
4685 5111 in
4686 \family typewriter
5112 \family typewriter
4687 5113 'backup'
4688 \family default
5114 \family default
4689 5115 mode.
4690 5116 It saves your history up to that point and then continues logging.
4691 \layout Standard
5117 \end_layout
4692 5118
5119 \begin_layout Standard
4693 5120
4694 \family typewriter
5121 \family typewriter
4695 5122 %logstart
4696 \family default
5123 \family default
4697 5124 takes a second optional parameter: logging mode.
4698 5125 This can be one of (note that the modes are given unquoted):
4699 \layout List
4700 \labelwidthstring 00.00.0000
5126 \end_layout
4701 5127
5128 \begin_layout List
5129 \labelwidthstring 00.00.0000
4702 5130
4703 \family typewriter
5131 \family typewriter
4704 5132 over
4705 \family default
5133 \family default
4706 5134 : overwrite existing
4707 \family typewriter
5135 \family typewriter
4708 5136 log_name
4709 \family default
5137 \family default
4710 5138 .
4711 \layout List
4712 \labelwidthstring 00.00.0000
5139 \end_layout
4713 5140
5141 \begin_layout List
5142 \labelwidthstring 00.00.0000
4714 5143
4715 \family typewriter
5144 \family typewriter
4716 5145 backup
4717 \family default
5146 \family default
4718 5147 : rename (if exists) to
4719 \family typewriter
5148 \family typewriter
4720 5149 log_name~
4721 \family default
5150 \family default
4722 5151 and start
4723 \family typewriter
5152 \family typewriter
4724 5153 log_name
4725 \family default
5154 \family default
4726 5155 .
4727 \layout List
4728 \labelwidthstring 00.00.0000
5156 \end_layout
4729 5157
5158 \begin_layout List
5159 \labelwidthstring 00.00.0000
4730 5160
4731 \family typewriter
5161 \family typewriter
4732 5162 append
4733 \family default
5163 \family default
4734 5164 : well, that says it.
4735 \layout List
4736 \labelwidthstring 00.00.0000
5165 \end_layout
4737 5166
5167 \begin_layout List
5168 \labelwidthstring 00.00.0000
4738 5169
4739 \family typewriter
5170 \family typewriter
4740 5171 rotate
4741 \family default
5172 \family default
4742 5173 : create rotating logs
4743 \family typewriter
5174 \family typewriter
4744 5175 log_name
4745 \family default
5176 \family default
4746 5177 .
4747 \family typewriter
5178 \family typewriter
4748 5179 1~
4749 \family default
5180 \family default
4750 5181 ,
4751 \family typewriter
5182 \family typewriter
4752 5183 log_name.2~
4753 \family default
5184 \family default
4754 5185 , etc.
4755 \layout Standard
5186 \end_layout
4756 5187
5188 \begin_layout Standard
4757 5189 The
4758 \family typewriter
5190 \family typewriter
4759 5191 %logoff
4760 \family default
5192 \family default
4761 5193 and
4762 \family typewriter
5194 \family typewriter
4763 5195 %logon
4764 \family default
5196 \family default
4765 5197 functions allow you to temporarily stop and resume logging to a file which
4766 5198 had previously been started with
4767 \family typewriter
5199 \family typewriter
4768 5200 %logstart
4769 \family default
5201 \family default
4770 5202 .
4771 5203 They will fail (with an explanation) if you try to use them before logging
4772 5204 has been started.
4773 \layout Subsection
4774
5205 \end_layout
4775 5206
5207 \begin_layout Subsection
4776 5208 \begin_inset LatexCommand \label{sub:System-shell-access}
4777 5209
4778 \end_inset
5210 \end_inset
4779 5211
4780 5212 System shell access
4781 \layout Standard
5213 \end_layout
4782 5214
5215 \begin_layout Standard
4783 5216 Any input line beginning with a
4784 \family typewriter
5217 \family typewriter
4785 5218 !
4786 \family default
5219 \family default
4787 5220 character is passed verbatim (minus the
4788 \family typewriter
5221 \family typewriter
4789 5222 !
4790 \family default
5223 \family default
4791 5224 , of course) to the underlying operating system.
4792 5225 For example, typing
4793 \family typewriter
5226 \family typewriter
4794 5227 !ls
4795 \family default
5228 \family default
4796 5229 will run
4797 \family typewriter
5230 \family typewriter
4798 5231 'ls'
4799 \family default
5232 \family default
4800 5233 in the current directory.
4801 \layout Subsubsection
5234 \end_layout
4802 5235
5236 \begin_layout Subsubsection
4803 5237 Manual capture of command output
4804 \layout Standard
5238 \end_layout
4805 5239
5240 \begin_layout Standard
4806 5241 If the input line begins with
4807 \emph on
5242 \emph on
4808 5243 two
4809 \emph default
5244 \emph default
4810 5245 exclamation marks,
4811 \family typewriter
5246 \family typewriter
4812 5247 !!
4813 \family default
5248 \family default
4814 5249 , the command is executed but its output is captured and returned as a python
4815 5250 list, split on newlines.
4816 5251 Any output sent by the subprocess to standard error is printed separately,
4817 5252 so that the resulting list only captures standard output.
4818 5253 The
4819 \family typewriter
5254 \family typewriter
4820 5255 !!
4821 \family default
5256 \family default
4822 5257 syntax is a shorthand for the
4823 \family typewriter
5258 \family typewriter
4824 5259 %sx
4825 \family default
5260 \family default
4826 5261 magic command.
4827 \layout Standard
5262 \end_layout
4828 5263
5264 \begin_layout Standard
4829 5265 Finally, the
4830 \family typewriter
5266 \family typewriter
4831 5267 %sc
4832 \family default
5268 \family default
4833 5269 magic (short for `shell capture') is similar to
4834 \family typewriter
5270 \family typewriter
4835 5271 %sx
4836 \family default
5272 \family default
4837 5273 , but allowing more fine-grained control of the capture details, and storing
4838 5274 the result directly into a named variable.
4839 \layout Standard
5275 \end_layout
4840 5276
4841 See Sec.\SpecialChar ~
5277 \begin_layout Standard
5278 See Sec.\InsetSpace ~
4842 5279
4843 5280 \begin_inset LatexCommand \ref{sec:magic}
4844 5281
4845 \end_inset
5282 \end_inset
4846 5283
4847 5284 for details on the magics
4848 \family typewriter
5285 \family typewriter
4849 5286 %sc
4850 \family default
5287 \family default
4851 5288 and
4852 \family typewriter
5289 \family typewriter
4853 5290 %sx
4854 \family default
5291 \family default
4855 5292 , or use IPython's own help (
4856 \family typewriter
5293 \family typewriter
4857 5294 sc?
4858 \family default
5295 \family default
4859 5296 and
4860 \family typewriter
5297 \family typewriter
4861 5298 sx?
4862 \family default
5299 \family default
4863 5300 ) for further details.
4864 \layout Standard
5301 \end_layout
4865 5302
5303 \begin_layout Standard
4866 5304 IPython also allows you to expand the value of python variables when making
4867 5305 system calls.
4868 5306 Any python variable or expression which you prepend with
4869 \family typewriter
5307 \family typewriter
4870 5308 $
4871 \family default
5309 \family default
4872 5310 will get expanded before the system call is made.
4873 5311
4874 \layout Standard
5312 \end_layout
4875 5313
5314 \begin_layout Standard
4876 5315
4877 \family typewriter
5316 \family typewriter
4878 5317 In [1]: pyvar='Hello world'
4879 \newline
5318 \newline
4880 5319 In [2]: !echo "A python variable: $pyvar"
4881 \newline
4882 A python variable: Hello world
4883 \layout Standard
5320 \newline
5321 A python
5322 variable: Hello world
5323 \end_layout
4884 5324
5325 \begin_layout Standard
4885 5326 If you want the shell to actually see a literal
4886 \family typewriter
5327 \family typewriter
4887 5328 $
4888 \family default
5329 \family default
4889 5330 , you need to type it twice:
4890 \layout Standard
5331 \end_layout
4891 5332
5333 \begin_layout Standard
4892 5334
4893 \family typewriter
5335 \family typewriter
4894 5336 In [3]: !echo "A system variable: $$HOME"
4895 \newline
5337 \newline
4896 5338 A system variable: /home/fperez
4897 \layout Standard
5339 \end_layout
4898 5340
5341 \begin_layout Standard
4899 5342 You can pass arbitrary expressions, though you'll need to delimit them with
4900 5343
4901 \family typewriter
5344 \family typewriter
4902 5345 {}
4903 \family default
5346 \family default
4904 5347 if there is ambiguity as to the extent of the expression:
4905 \layout Standard
5348 \end_layout
4906 5349
5350 \begin_layout Standard
4907 5351
4908 \family typewriter
5352 \family typewriter
4909 5353 In [5]: x=10
4910 \newline
5354 \newline
4911 5355 In [6]: y=20
4912 \newline
5356 \newline
4913 5357 In [13]: !echo $x+y
4914 \newline
5358 \newline
4915 5359 10+y
4916 \newline
5360 \newline
4917 5361 In [7]: !echo ${x+y}
4918 \newline
4919 30
4920 \layout Standard
5362 \newline
5363 30
5364
5365 \end_layout
4921 5366
5367 \begin_layout Standard
4922 5368 Even object attributes can be expanded:
4923 \layout Standard
5369 \end_layout
4924 5370
5371 \begin_layout Standard
4925 5372
4926 \family typewriter
5373 \family typewriter
4927 5374 In [12]: !echo $sys.argv
4928 \newline
5375 \newline
4929 5376 [/home/fperez/usr/bin/ipython]
4930 \layout Subsection
5377 \end_layout
4931 5378
5379 \begin_layout Subsection
4932 5380 System command aliases
4933 \layout Standard
5381 \end_layout
4934 5382
5383 \begin_layout Standard
4935 5384 The
4936 \family typewriter
5385 \family typewriter
4937 5386 %alias
4938 \family default
5387 \family default
4939 5388 magic function and the
4940 \family typewriter
5389 \family typewriter
4941 5390 alias
4942 \family default
5391 \family default
4943 5392 option in the
4944 \family typewriter
5393 \family typewriter
4945 5394 ipythonrc
4946 \family default
5395 \family default
4947 5396 configuration file allow you to define magic functions which are in fact
4948 5397 system shell commands.
4949 5398 These aliases can have parameters.
4950 5399
4951 \layout Standard
5400 \end_layout
4952 5401
5402 \begin_layout Standard
4953 5403 '
4954 \family typewriter
5404 \family typewriter
4955 5405 %alias alias_name cmd
4956 \family default
5406 \family default
4957 5407 ' defines '
4958 \family typewriter
5408 \family typewriter
4959 5409 alias_name
4960 \family default
5410 \family default
4961 5411 ' as an alias for '
4962 \family typewriter
5412 \family typewriter
4963 5413 cmd
4964 \family default
5414 \family default
4965 5415 '
4966 \layout Standard
5416 \end_layout
4967 5417
5418 \begin_layout Standard
4968 5419 Then, typing '
4969 \family typewriter
5420 \family typewriter
4970 5421 %alias_name params
4971 \family default
5422 \family default
4972 5423 ' will execute the system command '
4973 \family typewriter
5424 \family typewriter
4974 5425 cmd params
4975 \family default
5426 \family default
4976 5427 ' (from your underlying operating system).
4977 5428
4978 \layout Standard
5429 \end_layout
4979 5430
5431 \begin_layout Standard
4980 5432 You can also define aliases with parameters using
4981 \family typewriter
5433 \family typewriter
4982 5434 %s
4983 \family default
5435 \family default
4984 5436 specifiers (one per parameter).
4985 5437 The following example defines the
4986 \family typewriter
5438 \family typewriter
4987 5439 %parts
4988 \family default
5440 \family default
4989 5441 function as an alias to the command '
4990 \family typewriter
5442 \family typewriter
4991 5443 echo first %s second %s
4992 \family default
5444 \family default
4993 5445 ' where each
4994 \family typewriter
5446 \family typewriter
4995 5447 %s
4996 \family default
5448 \family default
4997 5449 will be replaced by a positional parameter to the call to
4998 \family typewriter
5450 \family typewriter
4999 5451 %parts:
5000 \layout Standard
5452 \end_layout
5001 5453
5454 \begin_layout Standard
5002 5455
5003 \family typewriter
5456 \family typewriter
5004 5457 In [1]: alias parts echo first %s second %s
5005 \newline
5458 \newline
5006 5459 In [2]: %parts A B
5007 \newline
5008 first A second B
5009 \newline
5460 \newline
5461 first A second
5462 B
5463 \newline
5010 5464 In [3]: %parts A
5011 \newline
5465 \newline
5012 5466 Incorrect number of arguments: 2 expected.
5013 5467
5014 \newline
5468 \newline
5015 5469 parts is an alias to: 'echo first %s second %s'
5016 \layout Standard
5470 \end_layout
5017 5471
5472 \begin_layout Standard
5018 5473 If called with no parameters,
5019 \family typewriter
5474 \family typewriter
5020 5475 %alias
5021 \family default
5476 \family default
5022 5477 prints the table of currently defined aliases.
5023 \layout Standard
5478 \end_layout
5024 5479
5480 \begin_layout Standard
5025 5481 The
5026 \family typewriter
5482 \family typewriter
5027 5483 %rehash/rehashx
5028 \family default
5484 \family default
5029 5485 magics allow you to load your entire
5030 \family typewriter
5486 \family typewriter
5031 5487 $PATH
5032 \family default
5488 \family default
5033 5489 as ipython aliases.
5034 See their respective docstrings (or sec.\SpecialChar ~
5490 See their respective docstrings (or sec.\InsetSpace ~
5035 5491
5036 5492 \begin_inset LatexCommand \ref{sec:magic}
5037 5493
5038 \end_inset
5494 \end_inset
5039 5495
5040 5496 for further details).
5041 \layout Subsection
5042
5497 \end_layout
5043 5498
5499 \begin_layout Subsection
5044 5500 \begin_inset LatexCommand \label{sec:dreload}
5045 5501
5046 \end_inset
5502 \end_inset
5047 5503
5048 5504 Recursive reload
5049 \layout Standard
5505 \end_layout
5050 5506
5507 \begin_layout Standard
5051 5508 The
5052 \family typewriter
5509 \family typewriter
5053 5510 dreload
5054 \family default
5511 \family default
5055 5512 function does a recursive reload of a module: changes made to the module
5056 5513 since you imported will actually be available without having to exit.
5057 \layout Subsection
5514 \end_layout
5058 5515
5516 \begin_layout Subsection
5059 5517 Verbose and colored exception traceback printouts
5060 \layout Standard
5518 \end_layout
5061 5519
5520 \begin_layout Standard
5062 5521 IPython provides the option to see very detailed exception tracebacks, which
5063 5522 can be especially useful when debugging large programs.
5064 5523 You can run any Python file with the
5065 \family typewriter
5524 \family typewriter
5066 5525 %run
5067 \family default
5526 \family default
5068 5527 function to benefit from these detailed tracebacks.
5069 5528 Furthermore, both normal and verbose tracebacks can be colored (if your
5070 5529 terminal supports it) which makes them much easier to parse visually.
5071 \layout Standard
5530 \end_layout
5072 5531
5532 \begin_layout Standard
5073 5533 See the magic
5074 \family typewriter
5534 \family typewriter
5075 5535 xmode
5076 \family default
5536 \family default
5077 5537 and
5078 \family typewriter
5538 \family typewriter
5079 5539 colors
5080 \family default
5540 \family default
5081 5541 functions for details (just type
5082 \family typewriter
5542 \family typewriter
5083 5543 %magic
5084 \family default
5544 \family default
5085 5545 ).
5086 \layout Standard
5546 \end_layout
5087 5547
5548 \begin_layout Standard
5088 5549 These features are basically a terminal version of Ka-Ping Yee's
5089 \family typewriter
5550 \family typewriter
5090 5551 cgitb
5091 \family default
5552 \family default
5092 5553 module, now part of the standard Python library.
5093 \layout Subsection
5094
5554 \end_layout
5095 5555
5556 \begin_layout Subsection
5096 5557 \begin_inset LatexCommand \label{sec:cache_input}
5097 5558
5098 \end_inset
5559 \end_inset
5099 5560
5100 5561 Input caching system
5101 \layout Standard
5562 \end_layout
5102 5563
5564 \begin_layout Standard
5103 5565 IPython offers numbered prompts (In/Out) with input and output caching.
5104 5566 All input is saved and can be retrieved as variables (besides the usual
5105 5567 arrow key recall).
5106 \layout Standard
5568 \end_layout
5107 5569
5570 \begin_layout Standard
5108 5571 The following GLOBAL variables always exist (so don't overwrite them!):
5109 5572
5110 \family typewriter
5573 \family typewriter
5111 5574 _i
5112 \family default
5575 \family default
5113 5576 : stores previous input.
5114 5577
5115 \family typewriter
5578 \family typewriter
5116 5579 _ii
5117 \family default
5580 \family default
5118 5581 : next previous.
5119 5582
5120 \family typewriter
5583 \family typewriter
5121 5584 _iii
5122 \family default
5585 \family default
5123 5586 : next-next previous.
5124 5587
5125 \family typewriter
5588 \family typewriter
5126 5589 _ih
5127 \family default
5590 \family default
5128 5591 : a list of all input
5129 \family typewriter
5592 \family typewriter
5130 5593 _ih[n]
5131 \family default
5594 \family default
5132 5595 is the input from line
5133 \family typewriter
5596 \family typewriter
5134 5597 n
5135 \family default
5598 \family default
5136 5599 and this list is aliased to the global variable
5137 \family typewriter
5600 \family typewriter
5138 5601 In
5139 \family default
5602 \family default
5140 5603 .
5141 5604 If you overwrite
5142 \family typewriter
5605 \family typewriter
5143 5606 In
5144 \family default
5607 \family default
5145 5608 with a variable of your own, you can remake the assignment to the internal
5146 5609 list with a simple
5147 \family typewriter
5610 \family typewriter
5148 5611 'In=_ih'
5149 \family default
5612 \family default
5150 5613 .
5151 \layout Standard
5614 \end_layout
5152 5615
5616 \begin_layout Standard
5153 5617 Additionally, global variables named
5154 \family typewriter
5618 \family typewriter
5155 5619 _i<n>
5156 \family default
5620 \family default
5157 5621 are dynamically created (
5158 \family typewriter
5622 \family typewriter
5159 5623 <n>
5160 \family default
5624 \family default
5161 5625 being the prompt counter), such that
5162 \newline
5626 \newline
5163 5627
5164 \family typewriter
5628 \family typewriter
5165 5629 _i<n> == _ih[<n>] == In[<n>].
5166 \layout Standard
5630 \end_layout
5167 5631
5632 \begin_layout Standard
5168 5633 For example, what you typed at prompt 14 is available as
5169 \family typewriter
5634 \family typewriter
5170 5635 _i14,
5171 \family default
5636 \family default
5172 5637
5173 \family typewriter
5638 \family typewriter
5174 5639 _ih[14]
5175 \family default
5640 \family default
5176 5641 and
5177 \family typewriter
5642 \family typewriter
5178 5643 In[14]
5179 \family default
5644 \family default
5180 5645 .
5181 \layout Standard
5646 \end_layout
5182 5647
5648 \begin_layout Standard
5183 5649 This allows you to easily cut and paste multi line interactive prompts by
5184 5650 printing them out: they print like a clean string, without prompt characters.
5185 5651 You can also manipulate them like regular variables (they are strings),
5186 5652 modify or exec them (typing
5187 \family typewriter
5653 \family typewriter
5188 5654 'exec _i9'
5189 \family default
5655 \family default
5190 5656 will re-execute the contents of input prompt 9, '
5191 \family typewriter
5657 \family typewriter
5192 5658 exec In[9:14]+In[18]
5193 \family default
5659 \family default
5194 5660 ' will re-execute lines 9 through 13 and line 18).
5195 \layout Standard
5661 \end_layout
5196 5662
5663 \begin_layout Standard
5197 5664 You can also re-execute multiple lines of input easily by using the magic
5198 5665
5199 \family typewriter
5666 \family typewriter
5200 5667 %macro
5201 \family default
5668 \family default
5202 5669 function (which automates the process and allows re-execution without having
5203 5670 to type '
5204 \family typewriter
5671 \family typewriter
5205 5672 exec
5206 \family default
5673 \family default
5207 5674 ' every time).
5208 5675 The macro system also allows you to re-execute previous lines which include
5209 5676 magic function calls (which require special processing).
5210 5677 Type
5211 \family typewriter
5678 \family typewriter
5212 5679 %macro?
5213 \family default
5680 \family default
5214 5681 or see sec.
5215 5682
5216 5683 \begin_inset LatexCommand \ref{sec:magic}
5217 5684
5218 \end_inset
5685 \end_inset
5219 5686
5220 5687 for more details on the macro system.
5221 \layout Standard
5688 \end_layout
5222 5689
5690 \begin_layout Standard
5223 5691 A history function
5224 \family typewriter
5692 \family typewriter
5225 5693 %hist
5226 \family default
5694 \family default
5227 5695 allows you to see any part of your input history by printing a range of
5228 5696 the
5229 \family typewriter
5697 \family typewriter
5230 5698 _i
5231 \family default
5699 \family default
5232 5700 variables.
5233 \layout Subsection
5234
5701 \end_layout
5235 5702
5703 \begin_layout Subsection
5236 5704 \begin_inset LatexCommand \label{sec:cache_output}
5237 5705
5238 \end_inset
5706 \end_inset
5239 5707
5240 5708 Output caching system
5241 \layout Standard
5709 \end_layout
5242 5710
5711 \begin_layout Standard
5243 5712 For output that is returned from actions, a system similar to the input
5244 5713 cache exists but using
5245 \family typewriter
5714 \family typewriter
5246 5715 _
5247 \family default
5716 \family default
5248 5717 instead of
5249 \family typewriter
5718 \family typewriter
5250 5719 _i
5251 \family default
5720 \family default
5252 5721 .
5253 5722 Only actions that produce a result (NOT assignments, for example) are cached.
5254 5723 If you are familiar with Mathematica, IPython's
5255 \family typewriter
5724 \family typewriter
5256 5725 _
5257 \family default
5726 \family default
5258 5727 variables behave exactly like Mathematica's
5259 \family typewriter
5728 \family typewriter
5260 5729 %
5261 \family default
5730 \family default
5262 5731 variables.
5263 \layout Standard
5732 \end_layout
5264 5733
5734 \begin_layout Standard
5265 5735 The following GLOBAL variables always exist (so don't overwrite them!):
5266 5736
5267 \layout List
5268 \labelwidthstring 00.00.0000
5737 \end_layout
5269 5738
5739 \begin_layout List
5740 \labelwidthstring 00.00.0000
5270 5741
5271 \family typewriter
5272 \series bold
5742 \family typewriter
5743 \series bold
5273 5744 _
5274 \family default
5275 \series default
5745 \family default
5746 \series default
5276 5747 (a
5277 \emph on
5748 \emph on
5278 5749 single
5279 \emph default
5750 \emph default
5280 5751 underscore) : stores previous output, like Python's default interpreter.
5281 \layout List
5282 \labelwidthstring 00.00.0000
5752 \end_layout
5283 5753
5754 \begin_layout List
5755 \labelwidthstring 00.00.0000
5284 5756
5285 \family typewriter
5286 \series bold
5757 \family typewriter
5758 \series bold
5287 5759 __
5288 \family default
5289 \series default
5760 \family default
5761 \series default
5290 5762 (two underscores): next previous.
5291 \layout List
5292 \labelwidthstring 00.00.0000
5763 \end_layout
5293 5764
5765 \begin_layout List
5766 \labelwidthstring 00.00.0000
5294 5767
5295 \family typewriter
5296 \series bold
5768 \family typewriter
5769 \series bold
5297 5770 ___
5298 \family default
5299 \series default
5771 \family default
5772 \series default
5300 5773 (three underscores): next-next previous.
5301 \layout Standard
5774 \end_layout
5302 5775
5776 \begin_layout Standard
5303 5777 Additionally, global variables named
5304 \family typewriter
5778 \family typewriter
5305 5779 _<n>
5306 \family default
5780 \family default
5307 5781 are dynamically created (
5308 \family typewriter
5782 \family typewriter
5309 5783 <n>
5310 \family default
5784 \family default
5311 5785 being the prompt counter), such that the result of output
5312 \family typewriter
5786 \family typewriter
5313 5787 <n>
5314 \family default
5788 \family default
5315 5789 is always available as
5316 \family typewriter
5790 \family typewriter
5317 5791 _<n>
5318 \family default
5792 \family default
5319 5793 (don't use the angle brackets, just the number, e.g.
5320 5794
5321 \family typewriter
5795 \family typewriter
5322 5796 _21
5323 \family default
5797 \family default
5324 5798 ).
5325 \layout Standard
5799 \end_layout
5326 5800
5801 \begin_layout Standard
5327 5802 These global variables are all stored in a global dictionary (not a list,
5328 5803 since it only has entries for lines which returned a result) available
5329 5804 under the names
5330 \family typewriter
5805 \family typewriter
5331 5806 _oh
5332 \family default
5807 \family default
5333 5808 and
5334 \family typewriter
5809 \family typewriter
5335 5810 Out
5336 \family default
5811 \family default
5337 5812 (similar to
5338 \family typewriter
5813 \family typewriter
5339 5814 _ih
5340 \family default
5815 \family default
5341 5816 and
5342 \family typewriter
5817 \family typewriter
5343 5818 In
5344 \family default
5819 \family default
5345 5820 ).
5346 5821 So the output from line 12 can be obtained as
5347 \family typewriter
5822 \family typewriter
5348 5823 _12
5349 \family default
5824 \family default
5350 5825 ,
5351 \family typewriter
5826 \family typewriter
5352 5827 Out[12]
5353 \family default
5828 \family default
5354 5829 or
5355 \family typewriter
5830 \family typewriter
5356 5831 _oh[12]
5357 \family default
5832 \family default
5358 5833 .
5359 5834 If you accidentally overwrite the
5360 \family typewriter
5835 \family typewriter
5361 5836 Out
5362 \family default
5837 \family default
5363 5838 variable you can recover it by typing
5364 \family typewriter
5839 \family typewriter
5365 5840 'Out=_oh
5366 \family default
5841 \family default
5367 5842 ' at the prompt.
5368 \layout Standard
5843 \end_layout
5369 5844
5845 \begin_layout Standard
5370 5846 This system obviously can potentially put heavy memory demands on your system,
5371 5847 since it prevents Python's garbage collector from removing any previously
5372 5848 computed results.
5373 5849 You can control how many results are kept in memory with the option (at
5374 5850 the command line or in your
5375 \family typewriter
5851 \family typewriter
5376 5852 ipythonrc
5377 \family default
5853 \family default
5378 5854 file)
5379 \family typewriter
5855 \family typewriter
5380 5856 cache_size
5381 \family default
5857 \family default
5382 5858 .
5383 5859 If you set it to 0, the whole system is completely disabled and the prompts
5384 5860 revert to the classic
5385 \family typewriter
5861 \family typewriter
5386 5862 '>>>'
5387 \family default
5863 \family default
5388 5864 of normal Python.
5389 \layout Subsection
5865 \end_layout
5390 5866
5867 \begin_layout Subsection
5391 5868 Directory history
5392 \layout Standard
5869 \end_layout
5393 5870
5871 \begin_layout Standard
5394 5872 Your history of visited directories is kept in the global list
5395 \family typewriter
5873 \family typewriter
5396 5874 _dh
5397 \family default
5875 \family default
5398 5876 , and the magic
5399 \family typewriter
5877 \family typewriter
5400 5878 %cd
5401 \family default
5879 \family default
5402 5880 command can be used to go to any entry in that list.
5403 5881 The
5404 \family typewriter
5882 \family typewriter
5405 5883 %dhist
5406 \family default
5884 \family default
5407 5885 command allows you to view this history.
5408 \layout Subsection
5886 \end_layout
5409 5887
5888 \begin_layout Subsection
5410 5889 Automatic parentheses and quotes
5411 \layout Standard
5890 \end_layout
5412 5891
5892 \begin_layout Standard
5413 5893 These features were adapted from Nathan Gray's LazyPython.
5414 5894 They are meant to allow less typing for common situations.
5415 \layout Subsubsection
5895 \end_layout
5416 5896
5897 \begin_layout Subsubsection
5417 5898 Automatic parentheses
5418 \layout Standard
5899 \end_layout
5419 5900
5901 \begin_layout Standard
5420 5902 Callable objects (i.e.
5421 5903 functions, methods, etc) can be invoked like this (notice the commas between
5422 5904 the arguments):
5423 \layout Standard
5905 \end_layout
5424 5906
5907 \begin_layout Standard
5425 5908
5426 \family typewriter
5909 \family typewriter
5427 5910 >>> callable_ob arg1, arg2, arg3
5428 \layout Standard
5911 \end_layout
5429 5912
5913 \begin_layout Standard
5430 5914 and the input will be translated to this:
5431 \layout Standard
5915 \end_layout
5432 5916
5917 \begin_layout Standard
5433 5918
5434 \family typewriter
5919 \family typewriter
5435 5920 --> callable_ob(arg1, arg2, arg3)
5436 \layout Standard
5921 \end_layout
5437 5922
5923 \begin_layout Standard
5438 5924 You can force automatic parentheses by using '/' as the first character
5439 5925 of a line.
5440 5926 For example:
5441 \layout Standard
5927 \end_layout
5442 5928
5929 \begin_layout Standard
5443 5930
5444 \family typewriter
5931 \family typewriter
5445 5932 >>> /globals # becomes 'globals()'
5446 \layout Standard
5933 \end_layout
5447 5934
5935 \begin_layout Standard
5448 5936 Note that the '/' MUST be the first character on the line! This won't work:
5449 5937
5450 \layout Standard
5938 \end_layout
5451 5939
5940 \begin_layout Standard
5452 5941
5453 \family typewriter
5942 \family typewriter
5454 5943 >>> print /globals # syntax error
5455 \layout Standard
5944 \end_layout
5456 5945
5946 \begin_layout Standard
5457 5947 In most cases the automatic algorithm should work, so you should rarely
5458 5948 need to explicitly invoke /.
5459 5949 One notable exception is if you are trying to call a function with a list
5460 5950 of tuples as arguments (the parenthesis will confuse IPython):
5461 \layout Standard
5951 \end_layout
5462 5952
5953 \begin_layout Standard
5463 5954
5464 \family typewriter
5955 \family typewriter
5465 5956 In [1]: zip (1,2,3),(4,5,6) # won't work
5466 \layout Standard
5957 \end_layout
5467 5958
5959 \begin_layout Standard
5468 5960 but this will work:
5469 \layout Standard
5961 \end_layout
5470 5962
5963 \begin_layout Standard
5471 5964
5472 \family typewriter
5965 \family typewriter
5473 5966 In [2]: /zip (1,2,3),(4,5,6)
5474 \newline
5967 \newline
5475 5968 ------> zip ((1,2,3),(4,5,6))
5476 \newline
5477 Out[2]= [(1, 4), (2, 5), (3, 6)]
5478 \layout Standard
5969 \newline
5970 Out[2]= [(1, 4),
5971 (2, 5), (3, 6)]
5972 \end_layout
5479 5973
5974 \begin_layout Standard
5480 5975 IPython tells you that it has altered your command line by displaying the
5481 5976 new command line preceded by
5482 \family typewriter
5977 \family typewriter
5483 5978 -->
5484 \family default
5979 \family default
5485 5980 .
5486 5981 e.g.:
5487 \layout Standard
5982 \end_layout
5488 5983
5984 \begin_layout Standard
5489 5985
5490 \family typewriter
5986 \family typewriter
5491 5987 In [18]: callable list
5492 \newline
5988 \newline
5493 5989 -------> callable (list)
5494 \layout Subsubsection
5990 \end_layout
5495 5991
5992 \begin_layout Subsubsection
5496 5993 Automatic quoting
5497 \layout Standard
5994 \end_layout
5498 5995
5996 \begin_layout Standard
5499 5997 You can force automatic quoting of a function's arguments by using
5500 \family typewriter
5998 \family typewriter
5501 5999 `,'
5502 \family default
6000 \family default
5503 6001 or
5504 \family typewriter
6002 \family typewriter
5505 6003 `;'
5506 \family default
6004 \family default
5507 6005 as the first character of a line.
5508 6006 For example:
5509 \layout Standard
6007 \end_layout
5510 6008
6009 \begin_layout Standard
5511 6010
5512 \family typewriter
6011 \family typewriter
5513 6012 >>> ,my_function /home/me # becomes my_function("/home/me")
5514 \layout Standard
6013 \end_layout
5515 6014
6015 \begin_layout Standard
5516 6016 If you use
5517 \family typewriter
6017 \family typewriter
5518 6018 `;'
5519 \family default
6019 \family default
5520 6020 instead, the whole argument is quoted as a single string (while
5521 \family typewriter
6021 \family typewriter
5522 6022 `,'
5523 \family default
6023 \family default
5524 6024 splits on whitespace):
5525 \layout Standard
6025 \end_layout
5526 6026
6027 \begin_layout Standard
5527 6028
5528 \family typewriter
6029 \family typewriter
5529 6030 >>> ,my_function a b c # becomes my_function("a","b","c")
5530 \layout Standard
6031 \end_layout
5531 6032
6033 \begin_layout Standard
5532 6034
5533 \family typewriter
6035 \family typewriter
5534 6036 >>> ;my_function a b c # becomes my_function("a b c")
5535 \layout Standard
6037 \end_layout
5536 6038
6039 \begin_layout Standard
5537 6040 Note that the `
5538 \family typewriter
6041 \family typewriter
5539 6042 ,
5540 \family default
6043 \family default
5541 6044 ' or `
5542 \family typewriter
6045 \family typewriter
5543 6046 ;
5544 \family default
6047 \family default
5545 6048 ' MUST be the first character on the line! This won't work:
5546 \layout Standard
6049 \end_layout
5547 6050
6051 \begin_layout Standard
5548 6052
5549 \family typewriter
6053 \family typewriter
5550 6054 >>> x = ,my_function /home/me # syntax error
5551 \layout Section
5552
6055 \end_layout
5553 6056
6057 \begin_layout Section
5554 6058 \begin_inset LatexCommand \label{sec:customization}
5555 6059
5556 \end_inset
6060 \end_inset
5557 6061
5558 6062 Customization
5559 \layout Standard
6063 \end_layout
5560 6064
6065 \begin_layout Standard
5561 6066 As we've already mentioned, IPython reads a configuration file which can
5562 6067 be specified at the command line (
5563 \family typewriter
6068 \family typewriter
5564 6069 -rcfile
5565 \family default
6070 \family default
5566 6071 ) or which by default is assumed to be called
5567 \family typewriter
6072 \family typewriter
5568 6073 ipythonrc
5569 \family default
6074 \family default
5570 6075 .
5571 6076 Such a file is looked for in the current directory where IPython is started
5572 6077 and then in your
5573 \family typewriter
6078 \family typewriter
5574 6079 IPYTHONDIR
5575 \family default
6080 \family default
5576 6081 , which allows you to have local configuration files for specific projects.
5577 6082 In this section we will call these types of configuration files simply
5578 6083 rcfiles (short for resource configuration file).
5579 \layout Standard
6084 \end_layout
5580 6085
6086 \begin_layout Standard
5581 6087 The syntax of an rcfile is one of key-value pairs separated by whitespace,
5582 6088 one per line.
5583 6089 Lines beginning with a
5584 \family typewriter
6090 \family typewriter
5585 6091 #
5586 \family default
6092 \family default
5587 6093 are ignored as comments, but comments can
5588 \series bold
6094 \series bold
5589 6095 not
5590 \series default
6096 \series default
5591 6097 be put on lines with data (the parser is fairly primitive).
5592 6098 Note that these are not python files, and this is deliberate, because it
5593 6099 allows us to do some things which would be quite tricky to implement if
5594 6100 they were normal python files.
5595 \layout Standard
6101 \end_layout
5596 6102
6103 \begin_layout Standard
5597 6104 First, an rcfile can contain permanent default values for almost all command
5598 6105 line options (except things like
5599 \family typewriter
6106 \family typewriter
5600 6107 -help
5601 \family default
6108 \family default
5602 6109 or
5603 \family typewriter
6110 \family typewriter
5604 6111 -Version
5605 \family default
6112 \family default
5606 6113 ).
5607 Sec\SpecialChar ~
6114 Sec\InsetSpace ~
5608 6115
5609 6116 \begin_inset LatexCommand \ref{sec:cmd-line-opts}
5610 6117
5611 \end_inset
6118 \end_inset
5612 6119
5613 6120 contains a description of all command-line options.
5614 6121 However, values you explicitly specify at the command line override the
5615 6122 values defined in the rcfile.
5616 \layout Standard
6123 \end_layout
5617 6124
6125 \begin_layout Standard
5618 6126 Besides command line option values, the rcfile can specify values for certain
5619 6127 extra special options which are not available at the command line.
5620 6128 These options are briefly described below.
5621 6129
5622 \layout Standard
6130 \end_layout
5623 6131
6132 \begin_layout Standard
5624 6133 Each of these options may appear as many times as you need it in the file.
5625 \layout List
5626 \labelwidthstring 00.00.0000
6134 \end_layout
5627 6135
6136 \begin_layout List
6137 \labelwidthstring 00.00.0000
5628 6138
5629 \family typewriter
5630 \series bold
5631 include\SpecialChar ~
5632 <file1>\SpecialChar ~
5633 <file2>\SpecialChar ~
6139 \family typewriter
6140 \series bold
6141 include\InsetSpace ~
6142 <file1>\InsetSpace ~
6143 <file2>\InsetSpace ~
5634 6144 ...
5635 \family default
5636 \series default
6145 \family default
6146 \series default
5637 6147 : you can name
5638 \emph on
6148 \emph on
5639 6149 other
5640 \emph default
6150 \emph default
5641 6151 rcfiles you want to recursively load up to 15 levels (don't use the
5642 \family typewriter
6152 \family typewriter
5643 6153 <>
5644 \family default
6154 \family default
5645 6155 brackets in your names!).
5646 6156 This feature allows you to define a 'base' rcfile with general options
5647 6157 and special-purpose files which can be loaded only when needed with particular
5648 6158 configuration options.
5649 6159 To make this more convenient, IPython accepts the
5650 \family typewriter
6160 \family typewriter
5651 6161 -profile <name>
5652 \family default
6162 \family default
5653 6163 option (abbreviates to
5654 \family typewriter
6164 \family typewriter
5655 6165 -p <name
5656 \family default
6166 \family default
5657 6167 >)
5658 \family typewriter
6168 \family typewriter
5659 6169 which
5660 \family default
6170 \family default
5661 6171 tells it to look for an rcfile named
5662 \family typewriter
6172 \family typewriter
5663 6173 ipythonrc-<name>
5664 \family default
6174 \family default
5665 6175 .
5666 6176
5667 \layout List
5668 \labelwidthstring 00.00.0000
6177 \end_layout
5669 6178
6179 \begin_layout List
6180 \labelwidthstring 00.00.0000
5670 6181
5671 \family typewriter
5672 \series bold
5673 import_mod\SpecialChar ~
5674 <mod1>\SpecialChar ~
5675 <mod2>\SpecialChar ~
6182 \family typewriter
6183 \series bold
6184 import_mod\InsetSpace ~
6185 <mod1>\InsetSpace ~
6186 <mod2>\InsetSpace ~
5676 6187 ...
5677 \family default
5678 \series default
6188 \family default
6189 \series default
5679 6190 : import modules with '
5680 \family typewriter
6191 \family typewriter
5681 6192 import
5682 \family default
6193 \family default
5683 6194
5684 \family typewriter
6195 \family typewriter
5685 6196 <mod1>,<mod2>,...
5686 \family default
6197 \family default
5687 6198 '
5688 \layout List
5689 \labelwidthstring 00.00.0000
6199 \end_layout
5690 6200
6201 \begin_layout List
6202 \labelwidthstring 00.00.0000
5691 6203
5692 \family typewriter
5693 \series bold
5694 import_some\SpecialChar ~
5695 <mod>\SpecialChar ~
5696 <f1>\SpecialChar ~
5697 <f2>\SpecialChar ~
6204 \family typewriter
6205 \series bold
6206 import_some\InsetSpace ~
6207 <mod>\InsetSpace ~
6208 <f1>\InsetSpace ~
6209 <f2>\InsetSpace ~
5698 6210 ...
5699 \family default
5700 \series default
6211 \family default
6212 \series default
5701 6213 : import functions with '
5702 \family typewriter
6214 \family typewriter
5703 6215 from <mod> import
5704 \family default
6216 \family default
5705 6217
5706 \family typewriter
6218 \family typewriter
5707 6219 <f1>,<f2>,...
5708 \family default
6220 \family default
5709 6221 '
5710 \layout List
5711 \labelwidthstring 00.00.0000
6222 \end_layout
5712 6223
6224 \begin_layout List
6225 \labelwidthstring 00.00.0000
5713 6226
5714 \family typewriter
5715 \series bold
5716 import_all\SpecialChar ~
5717 <mod1>\SpecialChar ~
5718 <mod2>\SpecialChar ~
6227 \family typewriter
6228 \series bold
6229 import_all\InsetSpace ~
6230 <mod1>\InsetSpace ~
6231 <mod2>\InsetSpace ~
5719 6232 ...
5720 \family default
5721 \series default
6233 \family default
6234 \series default
5722 6235 : for each module listed import functions with '
5723 \family typewriter
6236 \family typewriter
5724 6237 from <mod> import *
5725 \family default
6238 \family default
5726 6239 '
5727 \layout List
5728 \labelwidthstring 00.00.0000
6240 \end_layout
5729 6241
6242 \begin_layout List
6243 \labelwidthstring 00.00.0000
5730 6244
5731 \family typewriter
5732 \series bold
5733 execute\SpecialChar ~
5734 <python\SpecialChar ~
6245 \family typewriter
6246 \series bold
6247 execute\InsetSpace ~
6248 <python\InsetSpace ~
5735 6249 code>
5736 \family default
5737 \series default
6250 \family default
6251 \series default
5738 6252 : give any single-line python code to be executed.
5739 \layout List
5740 \labelwidthstring 00.00.0000
6253 \end_layout
5741 6254
6255 \begin_layout List
6256 \labelwidthstring 00.00.0000
5742 6257
5743 \family typewriter
5744 \series bold
5745 execfile\SpecialChar ~
6258 \family typewriter
6259 \series bold
6260 execfile\InsetSpace ~
5746 6261 <filename>
5747 \family default
5748 \series default
6262 \family default
6263 \series default
5749 6264 : execute the python file given with an '
5750 \family typewriter
6265 \family typewriter
5751 6266 execfile(filename)
5752 \family default
6267 \family default
5753 6268 ' command.
5754 6269 Username expansion is performed on the given names.
5755 6270 So if you need any amount of extra fancy customization that won't fit in
5756 6271 any of the above 'canned' options, you can just put it in a separate python
5757 6272 file and execute it.
5758 \layout List
5759 \labelwidthstring 00.00.0000
6273 \end_layout
5760 6274
6275 \begin_layout List
6276 \labelwidthstring 00.00.0000
5761 6277
5762 \family typewriter
5763 \series bold
5764 alias\SpecialChar ~
6278 \family typewriter
6279 \series bold
6280 alias\InsetSpace ~
5765 6281 <alias_def>
5766 \family default
5767 \series default
6282 \family default
6283 \series default
5768 6284 : this is equivalent to calling '
5769 \family typewriter
5770 %alias\SpecialChar ~
6285 \family typewriter
6286 %alias\InsetSpace ~
5771 6287 <alias_def>
5772 \family default
6288 \family default
5773 6289 ' at the IPython command line.
5774 6290 This way, from within IPython you can do common system tasks without having
5775 6291 to exit it or use the
5776 \family typewriter
6292 \family typewriter
5777 6293 !
5778 \family default
6294 \family default
5779 6295 escape.
5780 6296 IPython isn't meant to be a shell replacement, but it is often very useful
5781 6297 to be able to do things with files while testing code.
5782 6298 This gives you the flexibility to have within IPython any aliases you may
5783 6299 be used to under your normal system shell.
5784 \layout Subsection
5785
6300 \end_layout
5786 6301
6302 \begin_layout Subsection
5787 6303 \begin_inset LatexCommand \label{sec:ipytonrc-sample}
5788 6304
5789 \end_inset
6305 \end_inset
5790 6306
5791 6307 Sample
5792 \family typewriter
6308 \family typewriter
5793 6309 ipythonrc
5794 \family default
6310 \family default
5795 6311 file
5796 \layout Standard
6312 \end_layout
5797 6313
6314 \begin_layout Standard
5798 6315 The default rcfile, called
5799 \family typewriter
6316 \family typewriter
5800 6317 ipythonrc
5801 \family default
6318 \family default
5802 6319 and supplied in your
5803 \family typewriter
6320 \family typewriter
5804 6321 IPYTHONDIR
5805 \family default
6322 \family default
5806 6323 directory contains lots of comments on all of these options.
5807 6324 We reproduce it here for reference:
5808 \layout Standard
5809
6325 \end_layout
5810 6326
6327 \begin_layout Standard
5811 6328 \begin_inset ERT
5812 status Open
6329 status open
5813 6330
5814 \layout Standard
6331 \begin_layout Standard
5815 6332
5816 \backslash
6333
6334 \backslash
5817 6335 codelist{../IPython/UserConfig/ipythonrc}
5818 \end_inset
6336 \end_layout
5819 6337
6338 \end_inset
5820 6339
5821 \layout Subsection
5822 6340
6341 \end_layout
5823 6342
6343 \begin_layout Subsection
5824 6344 \begin_inset LatexCommand \label{sec:prompts}
5825 6345
5826 \end_inset
6346 \end_inset
5827 6347
5828 6348 Fine-tuning your prompt
5829 \layout Standard
6349 \end_layout
5830 6350
6351 \begin_layout Standard
5831 6352 IPython's prompts can be customized using a syntax similar to that of the
5832 6353
5833 \family typewriter
6354 \family typewriter
5834 6355 bash
5835 \family default
6356 \family default
5836 6357 shell.
5837 6358 Many of
5838 \family typewriter
6359 \family typewriter
5839 6360 bash
5840 \family default
6361 \family default
5841 6362 's escapes are supported, as well as a few additional ones.
5842 6363 We list them below:
5843 \layout Description
6364 \end_layout
5844 6365
6366 \begin_layout Description
5845 6367
5846 \backslash
6368 \backslash
5847 6369 # the prompt/history count number
5848 \layout Description
6370 \end_layout
5849 6371
6372 \begin_layout Description
5850 6373
5851 \backslash
6374 \backslash
5852 6375 D the prompt/history count, with the actual digits replaced by dots.
5853 6376 Used mainly in continuation prompts (prompt_in2)
5854 \layout Description
6377 \end_layout
5855 6378
6379 \begin_layout Description
5856 6380
5857 \backslash
6381 \backslash
5858 6382 w the current working directory
5859 \layout Description
6383 \end_layout
5860 6384
6385 \begin_layout Description
5861 6386
5862 \backslash
6387 \backslash
5863 6388 W the basename of current working directory
5864 \layout Description
6389 \end_layout
5865 6390
6391 \begin_layout Description
5866 6392
5867 \backslash
6393 \backslash
5868 6394 X
5869 \emph on
6395 \emph on
5870 6396 n
5871 \emph default
6397 \emph default
5872 6398 where
5873 6399 \begin_inset Formula $n=0\ldots5.$
5874 \end_inset
6400 \end_inset
5875 6401
5876 6402 The current working directory, with
5877 \family typewriter
6403 \family typewriter
5878 6404 $HOME
5879 \family default
6405 \family default
5880 6406 replaced by
5881 \family typewriter
6407 \family typewriter
5882 6408 ~
5883 \family default
6409 \family default
5884 6410 , and filtered out to contain only
5885 6411 \begin_inset Formula $n$
5886 \end_inset
6412 \end_inset
5887 6413
5888 6414 path elements
5889 \layout Description
6415 \end_layout
5890 6416
6417 \begin_layout Description
5891 6418
5892 \backslash
6419 \backslash
5893 6420 Y
5894 \emph on
6421 \emph on
5895 6422 n
5896 \emph default
6423 \emph default
5897 6424 Similar to
5898 \backslash
6425 \backslash
5899 6426 X
5900 \emph on
6427 \emph on
5901 6428 n
5902 \emph default
6429 \emph default
5903 6430 , but with the
5904 6431 \begin_inset Formula $n+1$
5905 \end_inset
6432 \end_inset
5906 6433
5907 6434 element included if it is
5908 \family typewriter
6435 \family typewriter
5909 6436 ~
5910 \family default
6437 \family default
5911 6438 (this is similar to the behavior of the %c
5912 \emph on
6439 \emph on
5913 6440 n
5914 \emph default
6441 \emph default
5915 6442 escapes in
5916 \family typewriter
6443 \family typewriter
5917 6444 tcsh
5918 \family default
6445 \family default
5919 6446 )
5920 \layout Description
6447 \end_layout
5921 6448
6449 \begin_layout Description
5922 6450
5923 \backslash
6451 \backslash
5924 6452 u the username of the current user
5925 \layout Description
6453 \end_layout
5926 6454
6455 \begin_layout Description
5927 6456
5928 \backslash
6457 \backslash
5929 6458 $ if the effective UID is 0, a #, otherwise a $
5930 \layout Description
6459 \end_layout
5931 6460
6461 \begin_layout Description
5932 6462
5933 \backslash
6463 \backslash
5934 6464 h the hostname up to the first `.'
5935 \layout Description
6465 \end_layout
5936 6466
6467 \begin_layout Description
5937 6468
5938 \backslash
6469 \backslash
5939 6470 H the hostname
5940 \layout Description
6471 \end_layout
5941 6472
6473 \begin_layout Description
5942 6474
5943 \backslash
6475 \backslash
5944 6476 n a newline
5945 \layout Description
6477 \end_layout
5946 6478
6479 \begin_layout Description
5947 6480
5948 \backslash
6481 \backslash
5949 6482 r a carriage return
5950 \layout Description
6483 \end_layout
5951 6484
6485 \begin_layout Description
5952 6486
5953 \backslash
6487 \backslash
5954 6488 v IPython version string
5955 \layout Standard
6489 \end_layout
5956 6490
6491 \begin_layout Standard
5957 6492 In addition to these, ANSI color escapes can be insterted into the prompts,
5958 6493 as
5959 \family typewriter
6494 \family typewriter
5960 6495
5961 \backslash
6496 \backslash
5962 6497 C_
5963 \emph on
6498 \emph on
5964 6499 ColorName
5965 \family default
5966 \emph default
6500 \family default
6501 \emph default
5967 6502 .
5968 6503 The list of valid color names is: Black, Blue, Brown, Cyan, DarkGray, Green,
5969 6504 LightBlue, LightCyan, LightGray, LightGreen, LightPurple, LightRed, NoColor,
5970 6505 Normal, Purple, Red, White, Yellow.
5971 \layout Standard
6506 \end_layout
5972 6507
6508 \begin_layout Standard
5973 6509 Finally, IPython supports the evaluation of arbitrary expressions in your
5974 6510 prompt string.
5975 6511 The prompt strings are evaluated through the syntax of PEP 215, but basically
5976 6512 you can use
5977 \family typewriter
6513 \family typewriter
5978 6514 $x.y
5979 \family default
6515 \family default
5980 6516 to expand the value of
5981 \family typewriter
6517 \family typewriter
5982 6518 x.y
5983 \family default
6519 \family default
5984 6520 , and for more complicated expressions you can use braces:
5985 \family typewriter
6521 \family typewriter
5986 6522 ${foo()+x}
5987 \family default
6523 \family default
5988 6524 will call function
5989 \family typewriter
6525 \family typewriter
5990 6526 foo
5991 \family default
6527 \family default
5992 6528 and add to it the value of
5993 \family typewriter
6529 \family typewriter
5994 6530 x
5995 \family default
6531 \family default
5996 6532 , before putting the result into your prompt.
5997 6533 For example, using
5998 \newline
6534 \newline
5999 6535
6000 \family typewriter
6536 \family typewriter
6001 6537 prompt_in1 '${commands.getoutput("uptime")}
6002 \backslash
6538 \backslash
6003 6539 nIn [
6004 \backslash
6540 \backslash
6005 6541 #]: '
6006 \newline
6542 \newline
6007 6543
6008 \family default
6544 \family default
6009 6545 will print the result of the uptime command on each prompt (assuming the
6010 6546
6011 \family typewriter
6547 \family typewriter
6012 6548 commands
6013 \family default
6549 \family default
6014 6550 module has been imported in your
6015 \family typewriter
6551 \family typewriter
6016 6552 ipythonrc
6017 \family default
6553 \family default
6018 6554 file).
6019 \layout Subsubsection
6555 \end_layout
6020 6556
6557 \begin_layout Subsubsection
6021 6558 Prompt examples
6022 \layout Standard
6559 \end_layout
6023 6560
6561 \begin_layout Standard
6024 6562 The following options in an ipythonrc file will give you IPython's default
6025 6563 prompts:
6026 \layout Standard
6564 \end_layout
6027 6565
6566 \begin_layout Standard
6028 6567
6029 \family typewriter
6568 \family typewriter
6030 6569 prompt_in1 'In [
6031 \backslash
6570 \backslash
6032 6571 #]:'
6033 \newline
6034 prompt_in2 '\SpecialChar ~
6035 \SpecialChar ~
6036 \SpecialChar ~
6572 \newline
6573 prompt_in2 '\InsetSpace ~
6574 \InsetSpace ~
6575 \InsetSpace ~
6037 6576 .
6038 \backslash
6577 \backslash
6039 6578 D.:'
6040 \newline
6579 \newline
6041 6580 prompt_out 'Out[
6042 \backslash
6581 \backslash
6043 6582 #]:'
6044 \layout Standard
6583 \end_layout
6045 6584
6585 \begin_layout Standard
6046 6586 which look like this:
6047 \layout Standard
6587 \end_layout
6048 6588
6589 \begin_layout Standard
6049 6590
6050 \family typewriter
6591 \family typewriter
6051 6592 In [1]: 1+2
6052 \newline
6593 \newline
6053 6594 Out[1]: 3
6054 \layout Standard
6595 \end_layout
6055 6596
6597 \begin_layout Standard
6056 6598
6057 \family typewriter
6599 \family typewriter
6058 6600 In [2]: for i in (1,2,3):
6059 \newline
6601 \newline
6060 6602
6061 6603 \begin_inset ERT
6062 status Collapsed
6604 status collapsed
6605
6606 \begin_layout Standard
6063 6607
6064 \layout Standard
6065 6608
6066 \backslash
6609 \backslash
6067 6610 hspace*{0mm}
6068 \end_inset
6069
6070 \SpecialChar ~
6071 \SpecialChar ~
6072 \SpecialChar ~
6073 ...: \SpecialChar ~
6074 \SpecialChar ~
6075 \SpecialChar ~
6076 \SpecialChar ~
6611 \end_layout
6612
6613 \end_inset
6614
6615 \InsetSpace ~
6616 \InsetSpace ~
6617 \InsetSpace ~
6618 ...: \InsetSpace ~
6619 \InsetSpace ~
6620 \InsetSpace ~
6621 \InsetSpace ~
6077 6622 print i,
6078 \newline
6623 \newline
6079 6624
6080 6625 \begin_inset ERT
6081 status Collapsed
6626 status collapsed
6627
6628 \begin_layout Standard
6082 6629
6083 \layout Standard
6084 6630
6085 \backslash
6631 \backslash
6086 6632 hspace*{0mm}
6087 \end_inset
6633 \end_layout
6088 6634
6089 \SpecialChar ~
6090 \SpecialChar ~
6091 \SpecialChar ~
6635 \end_inset
6636
6637 \InsetSpace ~
6638 \InsetSpace ~
6639 \InsetSpace ~
6092 6640 ...:
6093 \newline
6641 \newline
6094 6642 1 2 3
6095 \layout Standard
6643 \end_layout
6096 6644
6645 \begin_layout Standard
6097 6646 These will give you a very colorful prompt with path information:
6098 \layout Standard
6647 \end_layout
6099 6648
6649 \begin_layout Standard
6100 6650
6101 \family typewriter
6651 \family typewriter
6102 6652 #prompt_in1 '
6103 \backslash
6653 \backslash
6104 6654 C_Red
6105 \backslash
6655 \backslash
6106 6656 u
6107 \backslash
6657 \backslash
6108 6658 C_Blue[
6109 \backslash
6659 \backslash
6110 6660 C_Cyan
6111 \backslash
6661 \backslash
6112 6662 Y1
6113 \backslash
6663 \backslash
6114 6664 C_Blue]
6115 \backslash
6665 \backslash
6116 6666 C_LightGreen
6117 \backslash
6667 \backslash
6118 6668 #>'
6119 \newline
6669 \newline
6120 6670 prompt_in2 ' ..
6121 \backslash
6671 \backslash
6122 6672 D>'
6123 \newline
6673 \newline
6124 6674 prompt_out '<
6125 \backslash
6675 \backslash
6126 6676 #>'
6127 \layout Standard
6677 \end_layout
6128 6678
6679 \begin_layout Standard
6129 6680 which look like this:
6130 \layout Standard
6681 \end_layout
6131 6682
6683 \begin_layout Standard
6132 6684
6133 \family typewriter
6685 \family typewriter
6134 6686 \color red
6135 6687 fperez
6136 6688 \color blue
6137 6689 [
6138 6690 \color cyan
6139 6691 ~/ipython
6140 6692 \color blue
6141 6693 ]
6142 6694 \color green
6143 6695 1>
6144 6696 \color default
6145 6697 1+2
6146 \newline
6698 \newline
6147 6699
6148 6700 \begin_inset ERT
6149 status Collapsed
6701 status collapsed
6702
6703 \begin_layout Standard
6150 6704
6151 \layout Standard
6152 6705
6153 \backslash
6706 \backslash
6154 6707 hspace*{0mm}
6155 \end_inset
6156
6157 \SpecialChar ~
6158 \SpecialChar ~
6159 \SpecialChar ~
6160 \SpecialChar ~
6161 \SpecialChar ~
6162 \SpecialChar ~
6163 \SpecialChar ~
6164 \SpecialChar ~
6165 \SpecialChar ~
6166 \SpecialChar ~
6167 \SpecialChar ~
6168 \SpecialChar ~
6169 \SpecialChar ~
6170 \SpecialChar ~
6171 \SpecialChar ~
6172 \SpecialChar ~
6708 \end_layout
6709
6710 \end_inset
6711
6712 \InsetSpace ~
6713 \InsetSpace ~
6714 \InsetSpace ~
6715 \InsetSpace ~
6716 \InsetSpace ~
6717 \InsetSpace ~
6718 \InsetSpace ~
6719 \InsetSpace ~
6720 \InsetSpace ~
6721 \InsetSpace ~
6722 \InsetSpace ~
6723 \InsetSpace ~
6724 \InsetSpace ~
6725 \InsetSpace ~
6726 \InsetSpace ~
6727 \InsetSpace ~
6173 6728
6174 6729 \color red
6175 6730 <1>
6176 6731 \color default
6177 6732 3
6178 \newline
6733 \newline
6179 6734
6180 6735 \color red
6181 6736 fperez
6182 6737 \color blue
6183 6738 [
6184 6739 \color cyan
6185 6740 ~/ipython
6186 6741 \color blue
6187 6742 ]
6188 6743 \color green
6189 6744 2>
6190 6745 \color default
6191 6746 for i in (1,2,3):
6192 \newline
6747 \newline
6193 6748
6194 6749 \begin_inset ERT
6195 status Collapsed
6750 status collapsed
6751
6752 \begin_layout Standard
6196 6753
6197 \layout Standard
6198 6754
6199 \backslash
6755 \backslash
6200 6756 hspace*{0mm}
6201 \end_inset
6202
6203 \SpecialChar ~
6204 \SpecialChar ~
6205 \SpecialChar ~
6206 \SpecialChar ~
6207 \SpecialChar ~
6208 \SpecialChar ~
6209 \SpecialChar ~
6210 \SpecialChar ~
6211 \SpecialChar ~
6212 \SpecialChar ~
6213 \SpecialChar ~
6214 \SpecialChar ~
6215 \SpecialChar ~
6216 \SpecialChar ~
6217 \SpecialChar ~
6757 \end_layout
6758
6759 \end_inset
6760
6761 \InsetSpace ~
6762 \InsetSpace ~
6763 \InsetSpace ~
6764 \InsetSpace ~
6765 \InsetSpace ~
6766 \InsetSpace ~
6767 \InsetSpace ~
6768 \InsetSpace ~
6769 \InsetSpace ~
6770 \InsetSpace ~
6771 \InsetSpace ~
6772 \InsetSpace ~
6773 \InsetSpace ~
6774 \InsetSpace ~
6775 \InsetSpace ~
6218 6776
6219 6777 \color green
6220 6778 ...>
6221 6779 \color default
6222 \SpecialChar ~
6223 \SpecialChar ~
6224 \SpecialChar ~
6225 \SpecialChar ~
6780 \InsetSpace ~
6781 \InsetSpace ~
6782 \InsetSpace ~
6783 \InsetSpace ~
6226 6784 print i,
6227 \newline
6785 \newline
6228 6786
6229 6787 \begin_inset ERT
6230 status Collapsed
6788 status collapsed
6231 6789
6232 \layout Standard
6790 \begin_layout Standard
6233 6791
6234 \backslash
6792
6793 \backslash
6235 6794 hspace*{0mm}
6236 \end_inset
6237
6238 \SpecialChar ~
6239 \SpecialChar ~
6240 \SpecialChar ~
6241 \SpecialChar ~
6242 \SpecialChar ~
6243 \SpecialChar ~
6244 \SpecialChar ~
6245 \SpecialChar ~
6246 \SpecialChar ~
6247 \SpecialChar ~
6248 \SpecialChar ~
6249 \SpecialChar ~
6250 \SpecialChar ~
6251 \SpecialChar ~
6252 \SpecialChar ~
6795 \end_layout
6796
6797 \end_inset
6798
6799 \InsetSpace ~
6800 \InsetSpace ~
6801 \InsetSpace ~
6802 \InsetSpace ~
6803 \InsetSpace ~
6804 \InsetSpace ~
6805 \InsetSpace ~
6806 \InsetSpace ~
6807 \InsetSpace ~
6808 \InsetSpace ~
6809 \InsetSpace ~
6810 \InsetSpace ~
6811 \InsetSpace ~
6812 \InsetSpace ~
6813 \InsetSpace ~
6253 6814
6254 6815 \color green
6255 6816 ...>
6256 6817 \color default
6257 6818
6258 \newline
6819 \newline
6259 6820 1 2 3
6260 \layout Standard
6821 \end_layout
6261 6822
6823 \begin_layout Standard
6262 6824 The following shows the usage of dynamic expression evaluation:
6263 \layout Subsection
6264
6825 \end_layout
6265 6826
6827 \begin_layout Subsection
6266 6828 \begin_inset LatexCommand \label{sec:profiles}
6267 6829
6268 \end_inset
6830 \end_inset
6269 6831
6270 6832 IPython profiles
6271 \layout Standard
6833 \end_layout
6272 6834
6835 \begin_layout Standard
6273 6836 As we already mentioned, IPython supports the
6274 \family typewriter
6837 \family typewriter
6275 6838 -profile
6276 \family default
6839 \family default
6277 6840 command-line option (see sec.
6278 6841
6279 6842 \begin_inset LatexCommand \ref{sec:cmd-line-opts}
6280 6843
6281 \end_inset
6844 \end_inset
6282 6845
6283 6846 ).
6284 6847 A profile is nothing more than a particular configuration file like your
6285 6848 basic
6286 \family typewriter
6849 \family typewriter
6287 6850 ipythonrc
6288 \family default
6851 \family default
6289 6852 one, but with particular customizations for a specific purpose.
6290 6853 When you start IPython with '
6291 \family typewriter
6854 \family typewriter
6292 6855 ipython -profile <name>
6293 \family default
6856 \family default
6294 6857 ', it assumes that in your
6295 \family typewriter
6858 \family typewriter
6296 6859 IPYTHONDIR
6297 \family default
6860 \family default
6298 6861 there is a file called
6299 \family typewriter
6862 \family typewriter
6300 6863 ipythonrc-<name>
6301 \family default
6864 \family default
6302 6865 , and loads it instead of the normal
6303 \family typewriter
6866 \family typewriter
6304 6867 ipythonrc
6305 \family default
6868 \family default
6306 6869 .
6307 \layout Standard
6870 \end_layout
6308 6871
6872 \begin_layout Standard
6309 6873 This system allows you to maintain multiple configurations which load modules,
6310 6874 set options, define functions, etc.
6311 6875 suitable for different tasks and activate them in a very simple manner.
6312 6876 In order to avoid having to repeat all of your basic options (common things
6313 6877 that don't change such as your color preferences, for example), any profile
6314 6878 can include another configuration file.
6315 6879 The most common way to use profiles is then to have each one include your
6316 6880 basic
6317 \family typewriter
6881 \family typewriter
6318 6882 ipythonrc
6319 \family default
6883 \family default
6320 6884 file as a starting point, and then add further customizations.
6321 \layout Standard
6885 \end_layout
6322 6886
6887 \begin_layout Standard
6323 6888 In sections
6324 6889 \begin_inset LatexCommand \ref{sec:syntax-extensions}
6325 6890
6326 \end_inset
6891 \end_inset
6327 6892
6328 6893 and
6329 6894 \begin_inset LatexCommand \ref{sec:Gnuplot}
6330 6895
6331 \end_inset
6896 \end_inset
6332 6897
6333 6898 we discuss some particular profiles which come as part of the standard
6334 6899 IPython distribution.
6335 6900 You may also look in your
6336 \family typewriter
6901 \family typewriter
6337 6902 IPYTHONDIR
6338 \family default
6903 \family default
6339 6904 directory, any file whose name begins with
6340 \family typewriter
6905 \family typewriter
6341 6906 ipythonrc-
6342 \family default
6907 \family default
6343 6908 is a profile.
6344 6909 You can use those as examples for further customizations to suit your own
6345 6910 needs.
6346 \layout Section
6347
6911 \end_layout
6348 6912
6913 \begin_layout Section
6349 6914 \begin_inset OptArg
6350 collapsed false
6351
6352 \layout Standard
6915 status open
6353 6916
6917 \begin_layout Standard
6354 6918 IPython as default...
6355 \end_inset
6919 \end_layout
6920
6921 \end_inset
6356 6922
6357 6923 IPython as your default Python environment
6358 \layout Standard
6924 \end_layout
6359 6925
6926 \begin_layout Standard
6360 6927 Python honors the environment variable
6361 \family typewriter
6928 \family typewriter
6362 6929 PYTHONSTARTUP
6363 \family default
6930 \family default
6364 6931 and will execute at startup the file referenced by this variable.
6365 6932 If you put at the end of this file the following two lines of code:
6366 \layout Standard
6933 \end_layout
6367 6934
6935 \begin_layout Standard
6368 6936
6369 \family typewriter
6937 \family typewriter
6370 6938 import IPython
6371 \newline
6939 \newline
6372 6940 IPython.Shell.IPShell().mainloop(sys_exit=1)
6373 \layout Standard
6941 \end_layout
6374 6942
6943 \begin_layout Standard
6375 6944 then IPython will be your working environment anytime you start Python.
6376 6945 The
6377 \family typewriter
6946 \family typewriter
6378 6947 sys_exit=1
6379 \family default
6948 \family default
6380 6949 is needed to have IPython issue a call to
6381 \family typewriter
6950 \family typewriter
6382 6951 sys.exit()
6383 \family default
6952 \family default
6384 6953 when it finishes, otherwise you'll be back at the normal Python '
6385 \family typewriter
6954 \family typewriter
6386 6955 >>>
6387 \family default
6956 \family default
6388 6957 ' prompt
6389 6958 \begin_inset Foot
6390 collapsed true
6391
6392 \layout Standard
6959 status collapsed
6393 6960
6961 \begin_layout Standard
6394 6962 Based on an idea by Holger Krekel.
6395 \end_inset
6963 \end_layout
6964
6965 \end_inset
6396 6966
6397 6967 .
6398 \layout Standard
6968 \end_layout
6399 6969
6970 \begin_layout Standard
6400 6971 This is probably useful to developers who manage multiple Python versions
6401 6972 and don't want to have correspondingly multiple IPython versions.
6402 6973 Note that in this mode, there is no way to pass IPython any command-line
6403 6974 options, as those are trapped first by Python itself.
6404 \layout Section
6405
6975 \end_layout
6406 6976
6977 \begin_layout Section
6407 6978 \begin_inset LatexCommand \label{sec:embed}
6408 6979
6409 \end_inset
6980 \end_inset
6410 6981
6411 6982 Embedding IPython
6412 \layout Standard
6983 \end_layout
6413 6984
6985 \begin_layout Standard
6414 6986 It is possible to start an IPython instance
6415 \emph on
6987 \emph on
6416 6988 inside
6417 \emph default
6989 \emph default
6418 6990 your own Python programs.
6419 6991 This allows you to evaluate dynamically the state of your code, operate
6420 6992 with your variables, analyze them, etc.
6421 6993 Note however that any changes you make to values while in the shell do
6422 6994
6423 \emph on
6995 \emph on
6424 6996 not
6425 \emph default
6997 \emph default
6426 6998 propagate back to the running code, so it is safe to modify your values
6427 6999 because you won't break your code in bizarre ways by doing so.
6428 \layout Standard
7000 \end_layout
6429 7001
7002 \begin_layout Standard
6430 7003 This feature allows you to easily have a fully functional python environment
6431 7004 for doing object introspection anywhere in your code with a simple function
6432 7005 call.
6433 7006 In some cases a simple print statement is enough, but if you need to do
6434 7007 more detailed analysis of a code fragment this feature can be very valuable.
6435 \layout Standard
7008 \end_layout
6436 7009
7010 \begin_layout Standard
6437 7011 It can also be useful in scientific computing situations where it is common
6438 7012 to need to do some automatic, computationally intensive part and then stop
6439 7013 to look at data, plots, etc
6440 7014 \begin_inset Foot
6441 collapsed true
6442
6443 \layout Standard
7015 status collapsed
6444 7016
7017 \begin_layout Standard
6445 7018 This functionality was inspired by IDL's combination of the
6446 \family typewriter
7019 \family typewriter
6447 7020 stop
6448 \family default
7021 \family default
6449 7022 keyword and the
6450 \family typewriter
7023 \family typewriter
6451 7024 .continue
6452 \family default
7025 \family default
6453 7026 executive command, which I have found very useful in the past, and by a
6454 7027 posting on comp.lang.python by cmkl <cmkleffner-AT-gmx.de> on Dec.
6455 7028 06/01 concerning similar uses of pyrepl.
6456 \end_inset
7029 \end_layout
7030
7031 \end_inset
6457 7032
6458 7033 .
6459 7034 Opening an IPython instance will give you full access to your data and
6460 7035 functions, and you can resume program execution once you are done with
6461 7036 the interactive part (perhaps to stop again later, as many times as needed).
6462 \layout Standard
7037 \end_layout
6463 7038
7039 \begin_layout Standard
6464 7040 The following code snippet is the bare minimum you need to include in your
6465 7041 Python programs for this to work (detailed examples follow later):
6466 \layout LyX-Code
7042 \end_layout
6467 7043
7044 \begin_layout LyX-Code
6468 7045 from IPython.Shell import IPShellEmbed
6469 \layout LyX-Code
7046 \end_layout
6470 7047
7048 \begin_layout LyX-Code
6471 7049 ipshell = IPShellEmbed()
6472 \layout LyX-Code
7050 \end_layout
6473 7051
7052 \begin_layout LyX-Code
6474 7053 ipshell() # this call anywhere in your program will start IPython
6475 \layout Standard
7054 \end_layout
6476 7055
7056 \begin_layout Standard
6477 7057 You can run embedded instances even in code which is itself being run at
6478 7058 the IPython interactive prompt with '
6479 \family typewriter
6480 %run\SpecialChar ~
7059 \family typewriter
7060 %run\InsetSpace ~
6481 7061 <filename>
6482 \family default
7062 \family default
6483 7063 '.
6484 7064 Since it's easy to get lost as to where you are (in your top-level IPython
6485 7065 or in your embedded one), it's a good idea in such cases to set the in/out
6486 7066 prompts to something different for the embedded instances.
6487 7067 The code examples below illustrate this.
6488 \layout Standard
7068 \end_layout
6489 7069
7070 \begin_layout Standard
6490 7071 You can also have multiple IPython instances in your program and open them
6491 7072 separately, for example with different options for data presentation.
6492 7073 If you close and open the same instance multiple times, its prompt counters
6493 7074 simply continue from each execution to the next.
6494 \layout Standard
7075 \end_layout
6495 7076
7077 \begin_layout Standard
6496 7078 Please look at the docstrings in the
6497 \family typewriter
7079 \family typewriter
6498 7080 Shell.py
6499 \family default
7081 \family default
6500 7082 module for more details on the use of this system.
6501 \layout Standard
7083 \end_layout
6502 7084
7085 \begin_layout Standard
6503 7086 The following sample file illustrating how to use the embedding functionality
6504 7087 is provided in the examples directory as
6505 \family typewriter
7088 \family typewriter
6506 7089 example-embed.py
6507 \family default
7090 \family default
6508 7091 .
6509 7092 It should be fairly self-explanatory:
6510 \layout Standard
6511
7093 \end_layout
6512 7094
7095 \begin_layout Standard
6513 7096 \begin_inset ERT
6514 status Open
7097 status open
7098
7099 \begin_layout Standard
6515 7100
6516 \layout Standard
6517 7101
6518 \backslash
7102 \backslash
6519 7103 codelist{examples/example-embed.py}
6520 \end_inset
7104 \end_layout
7105
7106 \end_inset
6521 7107
6522 7108
6523 \layout Standard
7109 \end_layout
6524 7110
7111 \begin_layout Standard
6525 7112 Once you understand how the system functions, you can use the following
6526 7113 code fragments in your programs which are ready for cut and paste:
6527 \layout Standard
6528
7114 \end_layout
6529 7115
7116 \begin_layout Standard
6530 7117 \begin_inset ERT
6531 status Open
7118 status open
7119
7120 \begin_layout Standard
6532 7121
6533 \layout Standard
6534 7122
6535 \backslash
7123 \backslash
6536 7124 codelist{examples/example-embed-short.py}
6537 \end_inset
7125 \end_layout
6538 7126
7127 \end_inset
6539 7128
6540 \layout Section
6541 7129
7130 \end_layout
6542 7131
7132 \begin_layout Section
6543 7133 \begin_inset LatexCommand \label{sec:using-pdb}
6544 7134
6545 \end_inset
7135 \end_inset
6546 7136
6547 7137 Using the Python debugger (
6548 \family typewriter
7138 \family typewriter
6549 7139 pdb
6550 \family default
7140 \family default
6551 7141 )
6552 \layout Subsection
7142 \end_layout
6553 7143
7144 \begin_layout Subsection
6554 7145 Running entire programs via
6555 \family typewriter
7146 \family typewriter
6556 7147 pdb
6557 \layout Standard
7148 \end_layout
6558 7149
7150 \begin_layout Standard
6559 7151
6560 \family typewriter
7152 \family typewriter
6561 7153 pdb
6562 \family default
7154 \family default
6563 7155 , the Python debugger, is a powerful interactive debugger which allows you
6564 7156 to step through code, set breakpoints, watch variables, etc.
6565 7157 IPython makes it very easy to start any script under the control of
6566 \family typewriter
7158 \family typewriter
6567 7159 pdb
6568 \family default
7160 \family default
6569 7161 , regardless of whether you have wrapped it into a
6570 \family typewriter
7162 \family typewriter
6571 7163 `main()'
6572 \family default
7164 \family default
6573 7165 function or not.
6574 7166 For this, simply type
6575 \family typewriter
7167 \family typewriter
6576 7168 `%run -d myscript'
6577 \family default
7169 \family default
6578 7170 at an IPython prompt.
6579 7171 See the
6580 \family typewriter
7172 \family typewriter
6581 7173 %run
6582 \family default
7174 \family default
6583 7175 command's documentation (via
6584 \family typewriter
7176 \family typewriter
6585 7177 `%run?'
6586 \family default
6587 or in Sec.\SpecialChar ~
7178 \family default
7179 or in Sec.\InsetSpace ~
6588 7180
6589 7181 \begin_inset LatexCommand \ref{sec:magic}
6590 7182
6591 \end_inset
7183 \end_inset
6592 7184
6593 7185 ) for more details, including how to control where
6594 \family typewriter
7186 \family typewriter
6595 7187 pdb
6596 \family default
7188 \family default
6597 7189 will stop execution first.
6598 \layout Standard
7190 \end_layout
6599 7191
7192 \begin_layout Standard
6600 7193 For more information on the use of the
6601 \family typewriter
7194 \family typewriter
6602 7195 pdb
6603 \family default
7196 \family default
6604 7197 debugger, read the included
6605 \family typewriter
7198 \family typewriter
6606 7199 pdb.doc
6607 \family default
7200 \family default
6608 7201 file (part of the standard Python distribution).
6609 7202 On a stock Linux system it is located at
6610 \family typewriter
7203 \family typewriter
6611 7204 /usr/lib/python2.3/pdb.doc
6612 \family default
7205 \family default
6613 7206 , but the easiest way to read it is by using the
6614 \family typewriter
7207 \family typewriter
6615 7208 help()
6616 \family default
7209 \family default
6617 7210 function of the
6618 \family typewriter
7211 \family typewriter
6619 7212 pdb
6620 \family default
7213 \family default
6621 7214 module as follows (in an IPython prompt):
6622 \layout Standard
7215 \end_layout
6623 7216
7217 \begin_layout Standard
6624 7218
6625 \family typewriter
7219 \family typewriter
6626 7220 In [1]: import pdb
6627 \newline
7221 \newline
6628 7222 In [2]: pdb.help()
6629 \layout Standard
7223 \end_layout
6630 7224
7225 \begin_layout Standard
6631 7226 This will load the
6632 \family typewriter
7227 \family typewriter
6633 7228 pdb.doc
6634 \family default
7229 \family default
6635 7230 document in a file viewer for you automatically.
6636 \layout Subsection
7231 \end_layout
6637 7232
7233 \begin_layout Subsection
6638 7234 Automatic invocation of
6639 \family typewriter
7235 \family typewriter
6640 7236 pdb
6641 \family default
7237 \family default
6642 7238 on exceptions
6643 \layout Standard
7239 \end_layout
6644 7240
7241 \begin_layout Standard
6645 7242 IPython, if started with the
6646 \family typewriter
7243 \family typewriter
6647 7244 -pdb
6648 \family default
7245 \family default
6649 7246 option (or if the option is set in your rc file) can call the Python
6650 \family typewriter
7247 \family typewriter
6651 7248 pdb
6652 \family default
7249 \family default
6653 7250 debugger every time your code triggers an uncaught exception
6654 7251 \begin_inset Foot
6655 collapsed true
6656
6657 \layout Standard
7252 status collapsed
6658 7253
7254 \begin_layout Standard
6659 7255 Many thanks to Christopher Hart for the request which prompted adding this
6660 7256 feature to IPython.
6661 \end_inset
7257 \end_layout
7258
7259 \end_inset
6662 7260
6663 7261 .
6664 7262 This feature can also be toggled at any time with the
6665 \family typewriter
7263 \family typewriter
6666 7264 %pdb
6667 \family default
7265 \family default
6668 7266 magic command.
6669 7267 This can be extremely useful in order to find the origin of subtle bugs,
6670 7268 because
6671 \family typewriter
7269 \family typewriter
6672 7270 pdb
6673 \family default
7271 \family default
6674 7272 opens up at the point in your code which triggered the exception, and while
6675 7273 your program is at this point `dead', all the data is still available and
6676 7274 you can walk up and down the stack frame and understand the origin of the
6677 7275 problem.
6678 \layout Standard
7276 \end_layout
6679 7277
7278 \begin_layout Standard
6680 7279 Furthermore, you can use these debugging facilities both with the embedded
6681 7280 IPython mode and without IPython at all.
6682 7281 For an embedded shell (see sec.
6683 7282
6684 7283 \begin_inset LatexCommand \ref{sec:embed}
6685 7284
6686 \end_inset
7285 \end_inset
6687 7286
6688 7287 ), simply call the constructor with
6689 \family typewriter
7288 \family typewriter
6690 7289 `-pdb'
6691 \family default
7290 \family default
6692 7291 in the argument string and automatically
6693 \family typewriter
7292 \family typewriter
6694 7293 pdb
6695 \family default
7294 \family default
6696 7295 will be called if an uncaught exception is triggered by your code.
6697 7296
6698 \layout Standard
7297 \end_layout
6699 7298
7299 \begin_layout Standard
6700 7300 For stand-alone use of the feature in your programs which do not use IPython
6701 7301 at all, put the following lines toward the top of your `main' routine:
6702 \layout Standard
6703 \align left
7302 \end_layout
7303
7304 \begin_layout Standard
7305 \align left
6704 7306
6705 \family typewriter
7307 \family typewriter
6706 7308 import sys,IPython.ultraTB
6707 \newline
6708 sys.excepthook = IPython.ultraTB.FormattedTB(mode=`Verbose', color_scheme=`Linux',
6709 call_pdb=1)
6710 \layout Standard
7309 \newline
7310 sys.excepthook = IPython.ultraTB.FormattedTB(mode=`Verbos
7311 e', color_scheme=`Linux', call_pdb=1)
7312 \end_layout
6711 7313
7314 \begin_layout Standard
6712 7315 The
6713 \family typewriter
7316 \family typewriter
6714 7317 mode
6715 \family default
7318 \family default
6716 7319 keyword can be either
6717 \family typewriter
7320 \family typewriter
6718 7321 `Verbose'
6719 \family default
7322 \family default
6720 7323 or
6721 \family typewriter
7324 \family typewriter
6722 7325 `Plain'
6723 \family default
7326 \family default
6724 7327 , giving either very detailed or normal tracebacks respectively.
6725 7328 The
6726 \family typewriter
7329 \family typewriter
6727 7330 color_scheme
6728 \family default
7331 \family default
6729 7332 keyword can be one of
6730 \family typewriter
7333 \family typewriter
6731 7334 `NoColor'
6732 \family default
7335 \family default
6733 7336 ,
6734 \family typewriter
7337 \family typewriter
6735 7338 `Linux'
6736 \family default
7339 \family default
6737 7340 (default) or
6738 \family typewriter
7341 \family typewriter
6739 7342 `LightBG'
6740 \family default
7343 \family default
6741 7344 .
6742 7345 These are the same options which can be set in IPython with
6743 \family typewriter
7346 \family typewriter
6744 7347 -colors
6745 \family default
7348 \family default
6746 7349 and
6747 \family typewriter
7350 \family typewriter
6748 7351 -xmode
6749 \family default
7352 \family default
6750 7353 .
6751 \layout Standard
7354 \end_layout
6752 7355
7356 \begin_layout Standard
6753 7357 This will give any of your programs detailed, colored tracebacks with automatic
6754 7358 invocation of
6755 \family typewriter
7359 \family typewriter
6756 7360 pdb
6757 \family default
7361 \family default
6758 7362 .
6759 \layout Section
6760
7363 \end_layout
6761 7364
7365 \begin_layout Section
6762 7366 \begin_inset LatexCommand \label{sec:syntax-extensions}
6763 7367
6764 \end_inset
7368 \end_inset
6765 7369
6766 7370 Extensions for syntax processing
6767 \layout Standard
7371 \end_layout
6768 7372
7373 \begin_layout Standard
6769 7374 This isn't for the faint of heart, because the potential for breaking things
6770 7375 is quite high.
6771 7376 But it can be a very powerful and useful feature.
6772 7377 In a nutshell, you can redefine the way IPython processes the user input
6773 7378 line to accept new, special extensions to the syntax without needing to
6774 7379 change any of IPython's own code.
6775 \layout Standard
7380 \end_layout
6776 7381
7382 \begin_layout Standard
6777 7383 In the
6778 \family typewriter
7384 \family typewriter
6779 7385 IPython/Extensions
6780 \family default
7386 \family default
6781 7387 directory you will find some examples supplied, which we will briefly describe
6782 7388 now.
6783 7389 These can be used `as is' (and both provide very useful functionality),
6784 7390 or you can use them as a starting point for writing your own extensions.
6785 \layout Subsection
7391 \end_layout
6786 7392
7393 \begin_layout Subsection
6787 7394 Pasting of code starting with
6788 \family typewriter
7395 \family typewriter
6789 7396 `>>>
6790 \family default
7397 \family default
6791 7398 ' or
6792 \family typewriter
7399 \family typewriter
6793 7400 `...
6794 7401
6795 \family default
7402 \family default
6796 7403 '
6797 \layout Standard
7404 \end_layout
6798 7405
7406 \begin_layout Standard
6799 7407 In the python tutorial it is common to find code examples which have been
6800 7408 taken from real python sessions.
6801 7409 The problem with those is that all the lines begin with either
6802 \family typewriter
7410 \family typewriter
6803 7411 `>>>
6804 \family default
7412 \family default
6805 7413 ' or
6806 \family typewriter
7414 \family typewriter
6807 7415 `...
6808 7416
6809 \family default
7417 \family default
6810 7418 ', which makes it impossible to paste them all at once.
6811 7419 One must instead do a line by line manual copying, carefully removing the
6812 7420 leading extraneous characters.
6813 \layout Standard
7421 \end_layout
6814 7422
7423 \begin_layout Standard
6815 7424 This extension identifies those starting characters and removes them from
6816 7425 the input automatically, so that one can paste multi-line examples directly
6817 7426 into IPython, saving a lot of time.
6818 7427 Please look at the file
6819 \family typewriter
7428 \family typewriter
6820 7429 InterpreterPasteInput.py
6821 \family default
7430 \family default
6822 7431 in the
6823 \family typewriter
7432 \family typewriter
6824 7433 IPython/Extensions
6825 \family default
7434 \family default
6826 7435 directory for details on how this is done.
6827 \layout Standard
7436 \end_layout
6828 7437
7438 \begin_layout Standard
6829 7439 IPython comes with a special profile enabling this feature, called
6830 \family typewriter
7440 \family typewriter
6831 7441 tutorial
6832 \family default
6833 \emph on
7442 \family default
7443 \emph on
6834 7444 .
6835 7445
6836 \emph default
7446 \emph default
6837 7447 Simply start IPython via
6838 \family typewriter
6839 `ipython\SpecialChar ~
6840 -p\SpecialChar ~
7448 \family typewriter
7449 `ipython\InsetSpace ~
7450 -p\InsetSpace ~
6841 7451 tutorial'
6842 \family default
7452 \family default
6843 7453 and the feature will be available.
6844 7454 In a normal IPython session you can activate the feature by importing the
6845 7455 corresponding module with:
6846 \newline
7456 \newline
6847 7457
6848 \family typewriter
7458 \family typewriter
6849 7459 In [1]: import IPython.Extensions.InterpreterPasteInput
6850 \layout Standard
7460 \end_layout
6851 7461
7462 \begin_layout Standard
6852 7463 The following is a 'screenshot' of how things work when this extension is
6853 7464 on, copying an example from the standard tutorial:
6854 \layout Standard
7465 \end_layout
6855 7466
7467 \begin_layout Standard
6856 7468
6857 \family typewriter
7469 \family typewriter
6858 7470 IPython profile: tutorial
6859 \newline
6860 \SpecialChar ~
7471 \newline
7472 \InsetSpace ~
6861 7473
6862 \newline
7474 \newline
6863 7475 *** Pasting of code with ">>>" or "..." has been enabled.
6864 \newline
6865 \SpecialChar ~
7476 \newline
7477 \InsetSpace ~
6866 7478
6867 \newline
6868 In [1]: >>> def fib2(n): # return Fibonacci series up to n
6869 \newline
7479 \newline
7480 In
7481 [1]: >>> def fib2(n): # return Fibonacci series up to n
7482 \newline
6870 7483
6871 7484 \begin_inset ERT
6872 status Collapsed
7485 status collapsed
6873 7486
6874 \layout Standard
7487 \begin_layout Standard
6875 7488
6876 \backslash
7489
7490 \backslash
6877 7491 hspace*{0mm}
6878 \end_inset
6879
6880 \SpecialChar ~
6881 \SpecialChar ~
6882 ...: ...\SpecialChar ~
6883 \SpecialChar ~
6884 \SpecialChar ~
6885 \SpecialChar ~
7492 \end_layout
7493
7494 \end_inset
7495
7496 \InsetSpace ~
7497 \InsetSpace ~
7498 ...: ...\InsetSpace ~
7499 \InsetSpace ~
7500 \InsetSpace ~
7501 \InsetSpace ~
6886 7502 """Return a list containing the Fibonacci series up to n."""
6887 \newline
7503 \newline
6888 7504
6889 7505 \begin_inset ERT
6890 status Collapsed
7506 status collapsed
6891 7507
6892 \layout Standard
7508 \begin_layout Standard
6893 7509
6894 \backslash
7510
7511 \backslash
6895 7512 hspace*{0mm}
6896 \end_inset
6897
6898 \SpecialChar ~
6899 \SpecialChar ~
6900 ...: ...\SpecialChar ~
6901 \SpecialChar ~
6902 \SpecialChar ~
6903 \SpecialChar ~
7513 \end_layout
7514
7515 \end_inset
7516
7517 \InsetSpace ~
7518 \InsetSpace ~
7519 ...: ...\InsetSpace ~
7520 \InsetSpace ~
7521 \InsetSpace ~
7522 \InsetSpace ~
6904 7523 result = []
6905 \newline
7524 \newline
6906 7525
6907 7526 \begin_inset ERT
6908 status Collapsed
7527 status collapsed
6909 7528
6910 \layout Standard
7529 \begin_layout Standard
6911 7530
6912 \backslash
7531
7532 \backslash
6913 7533 hspace*{0mm}
6914 \end_inset
6915
6916 \SpecialChar ~
6917 \SpecialChar ~
6918 ...: ...\SpecialChar ~
6919 \SpecialChar ~
6920 \SpecialChar ~
6921 \SpecialChar ~
7534 \end_layout
7535
7536 \end_inset
7537
7538 \InsetSpace ~
7539 \InsetSpace ~
7540 ...: ...\InsetSpace ~
7541 \InsetSpace ~
7542 \InsetSpace ~
7543 \InsetSpace ~
6922 7544 a, b = 0, 1
6923 \newline
7545 \newline
6924 7546
6925 7547 \begin_inset ERT
6926 status Collapsed
7548 status collapsed
6927 7549
6928 \layout Standard
7550 \begin_layout Standard
6929 7551
6930 \backslash
7552
7553 \backslash
6931 7554 hspace*{0mm}
6932 \end_inset
6933
6934 \SpecialChar ~
6935 \SpecialChar ~
6936 ...: ...\SpecialChar ~
6937 \SpecialChar ~
6938 \SpecialChar ~
6939 \SpecialChar ~
7555 \end_layout
7556
7557 \end_inset
7558
7559 \InsetSpace ~
7560 \InsetSpace ~
7561 ...: ...\InsetSpace ~
7562 \InsetSpace ~
7563 \InsetSpace ~
7564 \InsetSpace ~
6940 7565 while b < n:
6941 \newline
7566 \newline
6942 7567
6943 7568 \begin_inset ERT
6944 status Collapsed
7569 status collapsed
7570
7571 \begin_layout Standard
6945 7572
6946 \layout Standard
6947 7573
6948 \backslash
7574 \backslash
6949 7575 hspace*{0mm}
6950 \end_inset
6951
6952 \SpecialChar ~
6953 \SpecialChar ~
6954 ...: ...\SpecialChar ~
6955 \SpecialChar ~
6956 \SpecialChar ~
6957 \SpecialChar ~
6958 \SpecialChar ~
6959 \SpecialChar ~
6960 \SpecialChar ~
6961 \SpecialChar ~
6962 result.append(b)\SpecialChar ~
6963 \SpecialChar ~
6964 \SpecialChar ~
7576 \end_layout
7577
7578 \end_inset
7579
7580 \InsetSpace ~
7581 \InsetSpace ~
7582 ...: ...\InsetSpace ~
7583 \InsetSpace ~
7584 \InsetSpace ~
7585 \InsetSpace ~
7586 \InsetSpace ~
7587 \InsetSpace ~
7588 \InsetSpace ~
7589 \InsetSpace ~
7590 result.append(b)\InsetSpace ~
7591 \InsetSpace ~
7592 \InsetSpace ~
6965 7593 # see below
6966 \newline
7594 \newline
6967 7595
6968 7596 \begin_inset ERT
6969 status Collapsed
7597 status collapsed
6970 7598
6971 \layout Standard
7599 \begin_layout Standard
6972 7600
6973 \backslash
7601
7602 \backslash
6974 7603 hspace*{0mm}
6975 \end_inset
6976
6977 \SpecialChar ~
6978 \SpecialChar ~
6979 ...: ...\SpecialChar ~
6980 \SpecialChar ~
6981 \SpecialChar ~
6982 \SpecialChar ~
6983 \SpecialChar ~
6984 \SpecialChar ~
6985 \SpecialChar ~
6986 \SpecialChar ~
7604 \end_layout
7605
7606 \end_inset
7607
7608 \InsetSpace ~
7609 \InsetSpace ~
7610 ...: ...\InsetSpace ~
7611 \InsetSpace ~
7612 \InsetSpace ~
7613 \InsetSpace ~
7614 \InsetSpace ~
7615 \InsetSpace ~
7616 \InsetSpace ~
7617 \InsetSpace ~
6987 7618 a, b = b, a+b
6988 \newline
7619 \newline
6989 7620
6990 7621 \begin_inset ERT
6991 status Collapsed
7622 status collapsed
7623
7624 \begin_layout Standard
6992 7625
6993 \layout Standard
6994 7626
6995 \backslash
7627 \backslash
6996 7628 hspace*{0mm}
6997 \end_inset
6998
6999 \SpecialChar ~
7000 \SpecialChar ~
7001 ...: ...\SpecialChar ~
7002 \SpecialChar ~
7003 \SpecialChar ~
7004 \SpecialChar ~
7629 \end_layout
7630
7631 \end_inset
7632
7633 \InsetSpace ~
7634 \InsetSpace ~
7635 ...: ...\InsetSpace ~
7636 \InsetSpace ~
7637 \InsetSpace ~
7638 \InsetSpace ~
7005 7639 return result
7006 \newline
7640 \newline
7007 7641
7008 7642 \begin_inset ERT
7009 status Collapsed
7643 status collapsed
7644
7645 \begin_layout Standard
7010 7646
7011 \layout Standard
7012 7647
7013 \backslash
7648 \backslash
7014 7649 hspace*{0mm}
7015 \end_inset
7650 \end_layout
7651
7652 \end_inset
7016 7653
7017 \SpecialChar ~
7018 \SpecialChar ~
7654 \InsetSpace ~
7655 \InsetSpace ~
7019 7656 ...:
7020 \newline
7021 \SpecialChar ~
7657 \newline
7658 \InsetSpace ~
7022 7659
7023 \newline
7660 \newline
7024 7661 In [2]: fib2(10)
7025 \newline
7662 \newline
7026 7663 Out[2]: [1, 1, 2, 3, 5, 8]
7027 \layout Standard
7664 \end_layout
7028 7665
7666 \begin_layout Standard
7029 7667 Note that as currently written, this extension does
7030 \emph on
7668 \emph on
7031 7669 not
7032 \emph default
7670 \emph default
7033 7671 recognize IPython's prompts for pasting.
7034 7672 Those are more complicated, since the user can change them very easily,
7035 7673 they involve numbers and can vary in length.
7036 7674 One could however extract all the relevant information from the IPython
7037 7675 instance and build an appropriate regular expression.
7038 7676 This is left as an exercise for the reader.
7039 \layout Subsection
7677 \end_layout
7040 7678
7679 \begin_layout Subsection
7041 7680 Input of physical quantities with units
7042 \layout Standard
7681 \end_layout
7043 7682
7683 \begin_layout Standard
7044 7684 The module
7045 \family typewriter
7685 \family typewriter
7046 7686 PhysicalQInput
7047 \family default
7687 \family default
7048 7688 allows a simplified form of input for physical quantities with units.
7049 7689 This file is meant to be used in conjunction with the
7050 \family typewriter
7690 \family typewriter
7051 7691 PhysicalQInteractive
7052 \family default
7692 \family default
7053 7693 module (in the same directory) and
7054 \family typewriter
7694 \family typewriter
7055 7695 Physics.PhysicalQuantities
7056 \family default
7696 \family default
7057 7697 from Konrad Hinsen's ScientificPython (
7058 7698 \begin_inset LatexCommand \htmlurl{http://dirac.cnrs-orleans.fr/ScientificPython/}
7059 7699
7060 \end_inset
7700 \end_inset
7061 7701
7062 7702 ).
7063 \layout Standard
7703 \end_layout
7064 7704
7705 \begin_layout Standard
7065 7706 The
7066 \family typewriter
7707 \family typewriter
7067 7708 Physics.PhysicalQuantities
7068 \family default
7709 \family default
7069 7710 module defines
7070 \family typewriter
7711 \family typewriter
7071 7712 PhysicalQuantity
7072 \family default
7713 \family default
7073 7714 objects, but these must be declared as instances of a class.
7074 7715 For example, to define
7075 \family typewriter
7716 \family typewriter
7076 7717 v
7077 \family default
7078 as a velocity of 3\SpecialChar ~
7718 \family default
7719 as a velocity of 3\InsetSpace ~
7079 7720 m/s, normally you would write:
7080 \family typewriter
7721 \family typewriter
7081 7722
7082 \newline
7723 \newline
7083 7724 In [1]: v = PhysicalQuantity(3,'m/s')
7084 \layout Standard
7725 \end_layout
7085 7726
7727 \begin_layout Standard
7086 7728 Using the
7087 \family typewriter
7729 \family typewriter
7088 7730 PhysicalQ_Input
7089 \family default
7731 \family default
7090 7732 extension this can be input instead as:
7091 \family typewriter
7733 \family typewriter
7092 7734
7093 \newline
7735 \newline
7094 7736 In [1]: v = 3 m/s
7095 \family default
7737 \family default
7096 7738
7097 \newline
7739 \newline
7098 7740 which is much more convenient for interactive use (even though it is blatantly
7099 7741 invalid Python syntax).
7100 \layout Standard
7742 \end_layout
7101 7743
7744 \begin_layout Standard
7102 7745 The
7103 \family typewriter
7746 \family typewriter
7104 7747 physics
7105 \family default
7748 \family default
7106 7749 profile supplied with IPython (enabled via
7107 \family typewriter
7750 \family typewriter
7108 7751 'ipython -p physics'
7109 \family default
7752 \family default
7110 7753 ) uses these extensions, which you can also activate with:
7111 \layout Standard
7754 \end_layout
7112 7755
7756 \begin_layout Standard
7113 7757
7114 \family typewriter
7758 \family typewriter
7115 7759 from math import * # math MUST be imported BEFORE PhysicalQInteractive
7116 \newline
7117 from IPython.Extensions.PhysicalQInteractive import *
7118 \newline
7119 import IPython.Extensions.PhysicalQInput
7120 \layout Section
7121
7122
7760 \newline
7761 from
7762 IPython.Extensions.PhysicalQInteractive import *
7763 \newline
7764 import IPython.Extensions.PhysicalQ
7765 Input
7766 \end_layout
7767
7768 \begin_layout Section
7123 7769 \begin_inset LatexCommand \label{sec:IPython-as-shell}
7124 7770
7125 \end_inset
7771 \end_inset
7126 7772
7127 7773 IPython as a system shell
7128 \layout Standard
7774 \end_layout
7129 7775
7776 \begin_layout Standard
7130 7777 IPython ships with a special profile called
7131 \family typewriter
7778 \family typewriter
7132 7779 pysh
7133 \family default
7780 \family default
7134 7781 , which you can activate at the command line as
7135 \family typewriter
7782 \family typewriter
7136 7783 `ipython -p pysh'
7137 \family default
7784 \family default
7138 7785 .
7139 7786 This loads
7140 \family typewriter
7787 \family typewriter
7141 7788 InterpreterExec
7142 \family default
7789 \family default
7143 7790 , along with some additional facilities and a prompt customized for filesystem
7144 7791 navigation.
7145 \layout Standard
7792 \end_layout
7146 7793
7794 \begin_layout Standard
7147 7795 Note that this does
7148 \emph on
7796 \emph on
7149 7797 not
7150 \emph default
7798 \emph default
7151 7799 make IPython a full-fledged system shell.
7152 7800 In particular, it has no job control, so if you type Ctrl-Z (under Unix),
7153 7801 you'll suspend pysh itself, not the process you just started.
7154 7802
7155 \layout Standard
7803 \end_layout
7156 7804
7805 \begin_layout Standard
7157 7806 What the shell profile allows you to do is to use the convenient and powerful
7158 7807 syntax of Python to do quick scripting at the command line.
7159 7808 Below we describe some of its features.
7160 \layout Subsection
7809 \end_layout
7161 7810
7811 \begin_layout Subsection
7162 7812 Aliases
7163 \layout Standard
7813 \end_layout
7164 7814
7815 \begin_layout Standard
7165 7816 All of your
7166 \family typewriter
7817 \family typewriter
7167 7818 $PATH
7168 \family default
7819 \family default
7169 7820 has been loaded as IPython aliases, so you should be able to type any normal
7170 7821 system command and have it executed.
7171 7822 See
7172 \family typewriter
7823 \family typewriter
7173 7824 %alias?
7174 \family default
7825 \family default
7175 7826 and
7176 \family typewriter
7827 \family typewriter
7177 7828 %unalias?
7178 \family default
7829 \family default
7179 7830 for details on the alias facilities.
7180 7831 See also
7181 \family typewriter
7832 \family typewriter
7182 7833 %rehash?
7183 \family default
7834 \family default
7184 7835 and
7185 \family typewriter
7836 \family typewriter
7186 7837 %rehashx?
7187 \family default
7838 \family default
7188 7839 for details on the mechanism used to load
7189 \family typewriter
7840 \family typewriter
7190 7841 $PATH
7191 \family default
7842 \family default
7192 7843 .
7193 \layout Subsection
7844 \end_layout
7194 7845
7846 \begin_layout Subsection
7195 7847 Special syntax
7196 \layout Standard
7848 \end_layout
7197 7849
7850 \begin_layout Standard
7198 7851 Any lines which begin with
7199 \family typewriter
7852 \family typewriter
7200 7853 `~'
7201 \family default
7854 \family default
7202 7855 ,
7203 \family typewriter
7856 \family typewriter
7204 7857 `/'
7205 \family default
7858 \family default
7206 7859 and
7207 \family typewriter
7860 \family typewriter
7208 7861 `.'
7209 \family default
7862 \family default
7210 7863 will be executed as shell commands instead of as Python code.
7211 7864 The special escapes below are also recognized.
7212 7865
7213 \family typewriter
7866 \family typewriter
7214 7867 !cmd
7215 \family default
7868 \family default
7216 7869 is valid in single or multi-line input, all others are only valid in single-lin
7217 7870 e input:
7218 \layout Description
7871 \end_layout
7219 7872
7873 \begin_layout Description
7220 7874
7221 \family typewriter
7875 \family typewriter
7222 7876 !cmd
7223 \family default
7877 \family default
7224 7878 pass `cmd' directly to the shell
7225 \layout Description
7879 \end_layout
7226 7880
7881 \begin_layout Description
7227 7882
7228 \family typewriter
7883 \family typewriter
7229 7884 !!cmd
7230 \family default
7885 \family default
7231 7886 execute `cmd' and return output as a list (split on `
7232 \backslash
7887 \backslash
7233 7888 n')
7234 \layout Description
7889 \end_layout
7235 7890
7891 \begin_layout Description
7236 7892
7237 \family typewriter
7893 \family typewriter
7238 7894 $var=cmd
7239 \family default
7895 \family default
7240 7896 capture output of cmd into var, as a string
7241 \layout Description
7897 \end_layout
7242 7898
7899 \begin_layout Description
7243 7900
7244 \family typewriter
7901 \family typewriter
7245 7902 $$var=cmd
7246 \family default
7903 \family default
7247 7904 capture output of cmd into var, as a list (split on `
7248 \backslash
7905 \backslash
7249 7906 n')
7250 \layout Standard
7907 \end_layout
7251 7908
7909 \begin_layout Standard
7252 7910 The
7253 \family typewriter
7911 \family typewriter
7254 7912 $
7255 \family default
7913 \family default
7256 7914 /
7257 \family typewriter
7915 \family typewriter
7258 7916 $$
7259 \family default
7917 \family default
7260 7918 syntaxes make Python variables from system output, which you can later
7261 7919 use for further scripting.
7262 7920 The converse is also possible: when executing an alias or calling to the
7263 7921 system via
7264 \family typewriter
7922 \family typewriter
7265 7923 !
7266 \family default
7924 \family default
7267 7925 /
7268 \family typewriter
7926 \family typewriter
7269 7927 !!
7270 \family default
7928 \family default
7271 7929 , you can expand any python variable or expression by prepending it with
7272 7930
7273 \family typewriter
7931 \family typewriter
7274 7932 $
7275 \family default
7933 \family default
7276 7934 .
7277 7935 Full details of the allowed syntax can be found in Python's PEP 215.
7278 \layout Standard
7936 \end_layout
7279 7937
7938 \begin_layout Standard
7280 7939 A few brief examples will illustrate these (note that the indentation below
7281 7940 may be incorrectly displayed):
7282 \layout Standard
7941 \end_layout
7283 7942
7943 \begin_layout Standard
7284 7944
7285 \family typewriter
7945 \family typewriter
7286 7946 fperez[~/test]|3> !ls *s.py
7287 \newline
7947 \newline
7288 7948 scopes.py strings.py
7289 \layout Standard
7949 \end_layout
7290 7950
7951 \begin_layout Standard
7291 7952 ls is an internal alias, so there's no need to use
7292 \family typewriter
7953 \family typewriter
7293 7954 !
7294 \family default
7955 \family default
7295 7956 :
7296 \layout Standard
7957 \end_layout
7297 7958
7959 \begin_layout Standard
7298 7960
7299 \family typewriter
7961 \family typewriter
7300 7962 fperez[~/test]|4> ls *s.py
7301 \newline
7963 \newline
7302 7964 scopes.py* strings.py
7303 \layout Standard
7965 \end_layout
7304 7966
7967 \begin_layout Standard
7305 7968 !!ls will return the output into a Python variable:
7306 \layout Standard
7969 \end_layout
7307 7970
7971 \begin_layout Standard
7308 7972
7309 \family typewriter
7973 \family typewriter
7310 7974 fperez[~/test]|5> !!ls *s.py
7311 \newline
7975 \newline
7312 7976
7313 7977 \begin_inset ERT
7314 status Collapsed
7978 status collapsed
7979
7980 \begin_layout Standard
7315 7981
7316 \layout Standard
7317 7982
7318 \backslash
7983 \backslash
7319 7984 hspace*{0mm}
7320 \end_inset
7321
7322 \SpecialChar ~
7323 \SpecialChar ~
7324 \SpecialChar ~
7325 \SpecialChar ~
7326 \SpecialChar ~
7327 \SpecialChar ~
7328 \SpecialChar ~
7329 \SpecialChar ~
7330 \SpecialChar ~
7331 \SpecialChar ~
7332 \SpecialChar ~
7333 \SpecialChar ~
7334 \SpecialChar ~
7335 \SpecialChar ~
7985 \end_layout
7986
7987 \end_inset
7988
7989 \InsetSpace ~
7990 \InsetSpace ~
7991 \InsetSpace ~
7992 \InsetSpace ~
7993 \InsetSpace ~
7994 \InsetSpace ~
7995 \InsetSpace ~
7996 \InsetSpace ~
7997 \InsetSpace ~
7998 \InsetSpace ~
7999 \InsetSpace ~
8000 \InsetSpace ~
8001 \InsetSpace ~
8002 \InsetSpace ~
7336 8003 <5> ['scopes.py', 'strings.py']
7337 \newline
8004 \newline
7338 8005 fperez[~/test]|6> print _5
7339 \newline
7340 ['scopes.py', 'strings.py']
7341 \layout Standard
8006 \newline
8007 ['scopes.py', 'strings.py
8008 ']
8009 \end_layout
7342 8010
8011 \begin_layout Standard
7343 8012
7344 \family typewriter
8013 \family typewriter
7345 8014 $
7346 \family default
8015 \family default
7347 8016 and
7348 \family typewriter
8017 \family typewriter
7349 8018 $$
7350 \family default
8019 \family default
7351 8020 allow direct capture to named variables:
7352 \layout Standard
8021 \end_layout
7353 8022
8023 \begin_layout Standard
7354 8024
7355 \family typewriter
8025 \family typewriter
7356 8026 fperez[~/test]|7> $astr = ls *s.py
7357 \newline
8027 \newline
7358 8028 fperez[~/test]|8> astr
7359 \newline
8029 \newline
7360 8030
7361 8031 \begin_inset ERT
7362 status Collapsed
8032 status collapsed
7363 8033
7364 \layout Standard
8034 \begin_layout Standard
7365 8035
7366 \backslash
8036
8037 \backslash
7367 8038 hspace*{0mm}
7368 \end_inset
7369
7370 \SpecialChar ~
7371 \SpecialChar ~
7372 \SpecialChar ~
7373 \SpecialChar ~
7374 \SpecialChar ~
7375 \SpecialChar ~
7376 \SpecialChar ~
7377 \SpecialChar ~
7378 \SpecialChar ~
7379 \SpecialChar ~
7380 \SpecialChar ~
7381 \SpecialChar ~
7382 \SpecialChar ~
7383 \SpecialChar ~
8039 \end_layout
8040
8041 \end_inset
8042
8043 \InsetSpace ~
8044 \InsetSpace ~
8045 \InsetSpace ~
8046 \InsetSpace ~
8047 \InsetSpace ~
8048 \InsetSpace ~
8049 \InsetSpace ~
8050 \InsetSpace ~
8051 \InsetSpace ~
8052 \InsetSpace ~
8053 \InsetSpace ~
8054 \InsetSpace ~
8055 \InsetSpace ~
8056 \InsetSpace ~
7384 8057 <8> 'scopes.py
7385 \backslash
8058 \backslash
7386 8059 nstrings.py'
7387 \layout Standard
8060 \end_layout
7388 8061
8062 \begin_layout Standard
7389 8063
7390 \family typewriter
8064 \family typewriter
7391 8065 fperez[~/test]|9> $$alist = ls *s.py
7392 \newline
8066 \newline
7393 8067 fperez[~/test]|10> alist
7394 \newline
8068 \newline
7395 8069
7396 8070 \begin_inset ERT
7397 status Collapsed
8071 status collapsed
8072
8073 \begin_layout Standard
7398 8074
7399 \layout Standard
7400 8075
7401 \backslash
8076 \backslash
7402 8077 hspace*{0mm}
7403 \end_inset
7404
7405 \SpecialChar ~
7406 \SpecialChar ~
7407 \SpecialChar ~
7408 \SpecialChar ~
7409 \SpecialChar ~
7410 \SpecialChar ~
7411 \SpecialChar ~
7412 \SpecialChar ~
7413 \SpecialChar ~
7414 \SpecialChar ~
7415 \SpecialChar ~
7416 \SpecialChar ~
7417 \SpecialChar ~
7418 \SpecialChar ~
8078 \end_layout
8079
8080 \end_inset
8081
8082 \InsetSpace ~
8083 \InsetSpace ~
8084 \InsetSpace ~
8085 \InsetSpace ~
8086 \InsetSpace ~
8087 \InsetSpace ~
8088 \InsetSpace ~
8089 \InsetSpace ~
8090 \InsetSpace ~
8091 \InsetSpace ~
8092 \InsetSpace ~
8093 \InsetSpace ~
8094 \InsetSpace ~
8095 \InsetSpace ~
7419 8096 <10> ['scopes.py', 'strings.py']
7420 \layout Standard
8097 \end_layout
7421 8098
8099 \begin_layout Standard
7422 8100 alist is now a normal python list you can loop over.
7423 8101 Using
7424 \family typewriter
8102 \family typewriter
7425 8103 $
7426 \family default
8104 \family default
7427 8105 will expand back the python values when alias calls are made:
7428 \layout Standard
8106 \end_layout
7429 8107
8108 \begin_layout Standard
7430 8109
7431 \family typewriter
8110 \family typewriter
7432 8111 fperez[~/test]|11> for f in alist:
7433 \newline
8112 \newline
7434 8113
7435 8114 \begin_inset ERT
7436 status Collapsed
8115 status collapsed
7437 8116
7438 \layout Standard
8117 \begin_layout Standard
7439 8118
7440 \backslash
8119
8120 \backslash
7441 8121 hspace*{0mm}
7442 \end_inset
7443
7444 \SpecialChar ~
7445 \SpecialChar ~
7446 \SpecialChar ~
7447 \SpecialChar ~
7448 \SpecialChar ~
7449 \SpecialChar ~
7450 \SpecialChar ~
7451 \SpecialChar ~
7452 \SpecialChar ~
7453 \SpecialChar ~
7454 \SpecialChar ~
7455 \SpecialChar ~
7456 \SpecialChar ~
7457 \SpecialChar ~
7458 |..> \SpecialChar ~
7459 \SpecialChar ~
7460 \SpecialChar ~
7461 \SpecialChar ~
8122 \end_layout
8123
8124 \end_inset
8125
8126 \InsetSpace ~
8127 \InsetSpace ~
8128 \InsetSpace ~
8129 \InsetSpace ~
8130 \InsetSpace ~
8131 \InsetSpace ~
8132 \InsetSpace ~
8133 \InsetSpace ~
8134 \InsetSpace ~
8135 \InsetSpace ~
8136 \InsetSpace ~
8137 \InsetSpace ~
8138 \InsetSpace ~
8139 \InsetSpace ~
8140 |..> \InsetSpace ~
8141 \InsetSpace ~
8142 \InsetSpace ~
8143 \InsetSpace ~
7462 8144 print 'file',f,
7463 \newline
8145 \newline
7464 8146
7465 8147 \begin_inset ERT
7466 status Collapsed
8148 status collapsed
8149
8150 \begin_layout Standard
7467 8151
7468 \layout Standard
7469 8152
7470 \backslash
8153 \backslash
7471 8154 hspace*{0mm}
7472 \end_inset
7473
7474 \SpecialChar ~
7475 \SpecialChar ~
7476 \SpecialChar ~
7477 \SpecialChar ~
7478 \SpecialChar ~
7479 \SpecialChar ~
7480 \SpecialChar ~
7481 \SpecialChar ~
7482 \SpecialChar ~
7483 \SpecialChar ~
7484 \SpecialChar ~
7485 \SpecialChar ~
7486 \SpecialChar ~
7487 \SpecialChar ~
7488 |..> \SpecialChar ~
7489 \SpecialChar ~
7490 \SpecialChar ~
7491 \SpecialChar ~
8155 \end_layout
8156
8157 \end_inset
8158
8159 \InsetSpace ~
8160 \InsetSpace ~
8161 \InsetSpace ~
8162 \InsetSpace ~
8163 \InsetSpace ~
8164 \InsetSpace ~
8165 \InsetSpace ~
8166 \InsetSpace ~
8167 \InsetSpace ~
8168 \InsetSpace ~
8169 \InsetSpace ~
8170 \InsetSpace ~
8171 \InsetSpace ~
8172 \InsetSpace ~
8173 |..> \InsetSpace ~
8174 \InsetSpace ~
8175 \InsetSpace ~
8176 \InsetSpace ~
7492 8177 wc -l $f
7493 \newline
8178 \newline
7494 8179
7495 8180 \begin_inset ERT
7496 status Collapsed
8181 status collapsed
7497 8182
7498 \layout Standard
8183 \begin_layout Standard
7499 8184
7500 \backslash
8185
8186 \backslash
7501 8187 hspace*{0mm}
7502 \end_inset
7503
7504 \SpecialChar ~
7505 \SpecialChar ~
7506 \SpecialChar ~
7507 \SpecialChar ~
7508 \SpecialChar ~
7509 \SpecialChar ~
7510 \SpecialChar ~
7511 \SpecialChar ~
7512 \SpecialChar ~
7513 \SpecialChar ~
7514 \SpecialChar ~
7515 \SpecialChar ~
7516 \SpecialChar ~
7517 \SpecialChar ~
8188 \end_layout
8189
8190 \end_inset
8191
8192 \InsetSpace ~
8193 \InsetSpace ~
8194 \InsetSpace ~
8195 \InsetSpace ~
8196 \InsetSpace ~
8197 \InsetSpace ~
8198 \InsetSpace ~
8199 \InsetSpace ~
8200 \InsetSpace ~
8201 \InsetSpace ~
8202 \InsetSpace ~
8203 \InsetSpace ~
8204 \InsetSpace ~
8205 \InsetSpace ~
7518 8206 |..>
7519 \newline
8207 \newline
7520 8208 file scopes.py 13 scopes.py
7521 \newline
8209 \newline
7522 8210 file strings.py 4 strings.py
7523 \layout Standard
8211 \end_layout
7524 8212
8213 \begin_layout Standard
7525 8214 Note that you may need to protect your variables with braces if you want
7526 8215 to append strings to their names.
7527 8216 To copy all files in alist to
7528 \family typewriter
8217 \family typewriter
7529 8218 .bak
7530 \family default
8219 \family default
7531 8220 extensions, you must use:
7532 \layout Standard
8221 \end_layout
7533 8222
8223 \begin_layout Standard
7534 8224
7535 \family typewriter
8225 \family typewriter
7536 8226 fperez[~/test]|12> for f in alist:
7537 \newline
8227 \newline
7538 8228
7539 8229 \begin_inset ERT
7540 status Collapsed
8230 status collapsed
8231
8232 \begin_layout Standard
7541 8233
7542 \layout Standard
7543 8234
7544 \backslash
8235 \backslash
7545 8236 hspace*{0mm}
7546 \end_inset
7547
7548 \SpecialChar ~
7549 \SpecialChar ~
7550 \SpecialChar ~
7551 \SpecialChar ~
7552 \SpecialChar ~
7553 \SpecialChar ~
7554 \SpecialChar ~
7555 \SpecialChar ~
7556 \SpecialChar ~
7557 \SpecialChar ~
7558 \SpecialChar ~
7559 \SpecialChar ~
7560 \SpecialChar ~
7561 \SpecialChar ~
7562 |..> \SpecialChar ~
7563 \SpecialChar ~
7564 \SpecialChar ~
7565 \SpecialChar ~
8237 \end_layout
8238
8239 \end_inset
8240
8241 \InsetSpace ~
8242 \InsetSpace ~
8243 \InsetSpace ~
8244 \InsetSpace ~
8245 \InsetSpace ~
8246 \InsetSpace ~
8247 \InsetSpace ~
8248 \InsetSpace ~
8249 \InsetSpace ~
8250 \InsetSpace ~
8251 \InsetSpace ~
8252 \InsetSpace ~
8253 \InsetSpace ~
8254 \InsetSpace ~
8255 |..> \InsetSpace ~
8256 \InsetSpace ~
8257 \InsetSpace ~
8258 \InsetSpace ~
7566 8259 cp $f ${f}.bak
7567 \layout Standard
8260 \end_layout
7568 8261
8262 \begin_layout Standard
7569 8263 If you try using
7570 \family typewriter
8264 \family typewriter
7571 8265 $f.bak
7572 \family default
8266 \family default
7573 8267 , you'll get an AttributeError exception saying that your string object
7574 8268 doesn't have a
7575 \family typewriter
8269 \family typewriter
7576 8270 .bak
7577 \family default
8271 \family default
7578 8272 attribute.
7579 8273 This is because the
7580 \family typewriter
8274 \family typewriter
7581 8275 $
7582 \family default
8276 \family default
7583 8277 expansion mechanism allows you to expand full Python expressions:
7584 \layout Standard
8278 \end_layout
7585 8279
8280 \begin_layout Standard
7586 8281
7587 \family typewriter
8282 \family typewriter
7588 8283 fperez[~/test]|13> echo "sys.platform is: $sys.platform"
7589 \newline
8284 \newline
7590 8285 sys.platform is: linux2
7591 \layout Standard
8286 \end_layout
7592 8287
8288 \begin_layout Standard
7593 8289 IPython's input history handling is still active, which allows you to rerun
7594 8290 a single block of multi-line input by simply using exec:
7595 \newline
8291 \newline
7596 8292
7597 \family typewriter
8293 \family typewriter
7598 8294 fperez[~/test]|14> $$alist = ls *.eps
7599 \newline
8295 \newline
7600 8296 fperez[~/test]|15> exec _i11
7601 \newline
7602 file image2.eps 921 image2.eps
7603 \newline
8297 \newline
8298 file image2.eps
8299 921 image2.eps
8300 \newline
7604 8301 file image.eps 921 image.eps
7605 \layout Standard
8302 \end_layout
7606 8303
8304 \begin_layout Standard
7607 8305 While these are new special-case syntaxes, they are designed to allow very
7608 8306 efficient use of the shell with minimal typing.
7609 8307 At an interactive shell prompt, conciseness of expression wins over readability.
7610 \layout Subsection
8308 \end_layout
7611 8309
8310 \begin_layout Subsection
7612 8311 Useful functions and modules
7613 \layout Standard
8312 \end_layout
7614 8313
8314 \begin_layout Standard
7615 8315 The os, sys and shutil modules from the Python standard library are automaticall
7616 8316 y loaded.
7617 8317 Some additional functions, useful for shell usage, are listed below.
7618 8318 You can request more help about them with `
7619 \family typewriter
8319 \family typewriter
7620 8320 ?
7621 \family default
8321 \family default
7622 8322 '.
7623 \layout Description
8323 \end_layout
7624 8324
8325 \begin_layout Description
7625 8326
7626 \family typewriter
8327 \family typewriter
7627 8328 shell
7628 \family default
8329 \family default
7629 8330 - execute a command in the underlying system shell
7630 \layout Description
8331 \end_layout
7631 8332
8333 \begin_layout Description
7632 8334
7633 \family typewriter
8335 \family typewriter
7634 8336 system
7635 \family default
8337 \family default
7636 8338 - like
7637 \family typewriter
8339 \family typewriter
7638 8340 shell()
7639 \family default
8341 \family default
7640 8342 , but return the exit status of the command
7641 \layout Description
8343 \end_layout
7642 8344
8345 \begin_layout Description
7643 8346
7644 \family typewriter
8347 \family typewriter
7645 8348 sout
7646 \family default
8349 \family default
7647 8350 - capture the output of a command as a string
7648 \layout Description
8351 \end_layout
7649 8352
8353 \begin_layout Description
7650 8354
7651 \family typewriter
8355 \family typewriter
7652 8356 lout
7653 \family default
8357 \family default
7654 8358 - capture the output of a command as a list (split on `
7655 \backslash
8359 \backslash
7656 8360 n')
7657 \layout Description
8361 \end_layout
7658 8362
8363 \begin_layout Description
7659 8364
7660 \family typewriter
8365 \family typewriter
7661 8366 getoutputerror
7662 \family default
8367 \family default
7663 8368 - capture (output,error) of a shell commandss
7664 \layout Standard
8369 \end_layout
7665 8370
8371 \begin_layout Standard
7666 8372
7667 \family typewriter
8373 \family typewriter
7668 8374 sout
7669 \family default
8375 \family default
7670 8376 /
7671 \family typewriter
8377 \family typewriter
7672 8378 lout
7673 \family default
8379 \family default
7674 8380 are the functional equivalents of
7675 \family typewriter
8381 \family typewriter
7676 8382 $
7677 \family default
8383 \family default
7678 8384 /
7679 \family typewriter
8385 \family typewriter
7680 8386 $$
7681 \family default
8387 \family default
7682 8388 .
7683 8389 They are provided to allow you to capture system output in the middle of
7684 8390 true python code, function definitions, etc (where
7685 \family typewriter
8391 \family typewriter
7686 8392 $
7687 \family default
8393 \family default
7688 8394 and
7689 \family typewriter
8395 \family typewriter
7690 8396 $$
7691 \family default
8397 \family default
7692 8398 are invalid).
7693 \layout Subsection
8399 \end_layout
7694 8400
8401 \begin_layout Subsection
7695 8402 Directory management
7696 \layout Standard
8403 \end_layout
7697 8404
8405 \begin_layout Standard
7698 8406 Since each command passed by pysh to the underlying system is executed in
7699 8407 a subshell which exits immediately, you can NOT use !cd to navigate the
7700 8408 filesystem.
7701 \layout Standard
8409 \end_layout
7702 8410
8411 \begin_layout Standard
7703 8412 Pysh provides its own builtin
7704 \family typewriter
8413 \family typewriter
7705 8414 `%cd
7706 \family default
8415 \family default
7707 8416 ' magic command to move in the filesystem (the
7708 \family typewriter
8417 \family typewriter
7709 8418 %
7710 \family default
8419 \family default
7711 8420 is not required with automagic on).
7712 8421 It also maintains a list of visited directories (use
7713 \family typewriter
8422 \family typewriter
7714 8423 %dhist
7715 \family default
8424 \family default
7716 8425 to see it) and allows direct switching to any of them.
7717 8426 Type
7718 \family typewriter
8427 \family typewriter
7719 8428 `cd?
7720 \family default
8429 \family default
7721 8430 ' for more details.
7722 \layout Standard
8431 \end_layout
7723 8432
8433 \begin_layout Standard
7724 8434
7725 \family typewriter
8435 \family typewriter
7726 8436 %pushd
7727 \family default
8437 \family default
7728 8438 ,
7729 \family typewriter
8439 \family typewriter
7730 8440 %popd
7731 \family default
8441 \family default
7732 8442 and
7733 \family typewriter
8443 \family typewriter
7734 8444 %dirs
7735 \family default
8445 \family default
7736 8446 are provided for directory stack handling.
7737 \layout Subsection
8447 \end_layout
7738 8448
8449 \begin_layout Subsection
7739 8450 Prompt customization
7740 \layout Standard
8451 \end_layout
7741 8452
8453 \begin_layout Standard
7742 8454 The supplied
7743 \family typewriter
8455 \family typewriter
7744 8456 ipythonrc-pysh
7745 \family default
8457 \family default
7746 8458 profile comes with an example of a very colored and detailed prompt, mainly
7747 8459 to serve as an illustration.
7748 8460 The valid escape sequences, besides color names, are:
7749 \layout Description
8461 \end_layout
7750 8462
8463 \begin_layout Description
7751 8464
7752 \backslash
8465 \backslash
7753 8466 # - Prompt number.
7754 \layout Description
8467 \end_layout
7755 8468
8469 \begin_layout Description
7756 8470
7757 \backslash
8471 \backslash
7758 8472 D - Dots, as many as there are digits in
7759 \backslash
8473 \backslash
7760 8474 # (so they align).
7761 \layout Description
8475 \end_layout
7762 8476
8477 \begin_layout Description
7763 8478
7764 \backslash
8479 \backslash
7765 8480 w - Current working directory (cwd).
7766 \layout Description
8481 \end_layout
7767 8482
8483 \begin_layout Description
7768 8484
7769 \backslash
8485 \backslash
7770 8486 W - Basename of current working directory.
7771 \layout Description
8487 \end_layout
7772 8488
8489 \begin_layout Description
7773 8490
7774 \backslash
8491 \backslash
7775 8492 X
7776 \emph on
8493 \emph on
7777 8494 N
7778 \emph default
8495 \emph default
7779 8496 - Where
7780 \emph on
8497 \emph on
7781 8498 N
7782 \emph default
8499 \emph default
7783 8500 =0..5.
7784 8501 N terms of the cwd, with $HOME written as ~.
7785 \layout Description
8502 \end_layout
7786 8503
8504 \begin_layout Description
7787 8505
7788 \backslash
8506 \backslash
7789 8507 Y
7790 \emph on
8508 \emph on
7791 8509 N
7792 \emph default
8510 \emph default
7793 8511 - Where
7794 \emph on
8512 \emph on
7795 8513 N
7796 \emph default
8514 \emph default
7797 8515 =0..5.
7798 8516 Like X
7799 \emph on
8517 \emph on
7800 8518 N
7801 \emph default
8519 \emph default
7802 8520 , but if ~ is term
7803 \emph on
8521 \emph on
7804 8522 N
7805 \emph default
8523 \emph default
7806 8524 +1 it's also shown.
7807 \layout Description
8525 \end_layout
7808 8526
8527 \begin_layout Description
7809 8528
7810 \backslash
8529 \backslash
7811 8530 u - Username.
7812 \layout Description
8531 \end_layout
7813 8532
8533 \begin_layout Description
7814 8534
7815 \backslash
8535 \backslash
7816 8536 H - Full hostname.
7817 \layout Description
8537 \end_layout
7818 8538
8539 \begin_layout Description
7819 8540
7820 \backslash
8541 \backslash
7821 8542 h - Hostname up to first '.'
7822 \layout Description
8543 \end_layout
7823 8544
8545 \begin_layout Description
7824 8546
7825 \backslash
8547 \backslash
7826 8548 $ - Root symbol ($ or #).
7827 8549
7828 \layout Description
8550 \end_layout
7829 8551
8552 \begin_layout Description
7830 8553
7831 \backslash
8554 \backslash
7832 8555 t - Current time, in H:M:S format.
7833 \layout Description
8556 \end_layout
7834 8557
8558 \begin_layout Description
7835 8559
7836 \backslash
8560 \backslash
7837 8561 v - IPython release version.
7838 8562
7839 \layout Description
8563 \end_layout
7840 8564
8565 \begin_layout Description
7841 8566
7842 \backslash
8567 \backslash
7843 8568 n - Newline.
7844 8569
7845 \layout Description
8570 \end_layout
7846 8571
8572 \begin_layout Description
7847 8573
7848 \backslash
8574 \backslash
7849 8575 r - Carriage return.
7850 8576
7851 \layout Description
8577 \end_layout
7852 8578
8579 \begin_layout Description
7853 8580
7854 \backslash
8581 \backslash
7855 8582
7856 \backslash
8583 \backslash
7857 8584 - An explicitly escaped '
7858 \backslash
8585 \backslash
7859 8586 '.
7860 \layout Standard
8587 \end_layout
7861 8588
8589 \begin_layout Standard
7862 8590 You can configure your prompt colors using any ANSI color escape.
7863 8591 Each color escape sets the color for any subsequent text, until another
7864 8592 escape comes in and changes things.
7865 8593 The valid color escapes are:
7866 \layout Description
8594 \end_layout
7867 8595
8596 \begin_layout Description
7868 8597
7869 \backslash
8598 \backslash
7870 8599 C_Black
7871 \layout Description
8600 \end_layout
7872 8601
8602 \begin_layout Description
7873 8603
7874 \backslash
8604 \backslash
7875 8605 C_Blue
7876 \layout Description
8606 \end_layout
7877 8607
8608 \begin_layout Description
7878 8609
7879 \backslash
8610 \backslash
7880 8611 C_Brown
7881 \layout Description
8612 \end_layout
7882 8613
8614 \begin_layout Description
7883 8615
7884 \backslash
8616 \backslash
7885 8617 C_Cyan
7886 \layout Description
8618 \end_layout
7887 8619
8620 \begin_layout Description
7888 8621
7889 \backslash
8622 \backslash
7890 8623 C_DarkGray
7891 \layout Description
8624 \end_layout
7892 8625
8626 \begin_layout Description
7893 8627
7894 \backslash
8628 \backslash
7895 8629 C_Green
7896 \layout Description
8630 \end_layout
7897 8631
8632 \begin_layout Description
7898 8633
7899 \backslash
8634 \backslash
7900 8635 C_LightBlue
7901 \layout Description
8636 \end_layout
7902 8637
8638 \begin_layout Description
7903 8639
7904 \backslash
8640 \backslash
7905 8641 C_LightCyan
7906 \layout Description
8642 \end_layout
7907 8643
8644 \begin_layout Description
7908 8645
7909 \backslash
8646 \backslash
7910 8647 C_LightGray
7911 \layout Description
8648 \end_layout
7912 8649
8650 \begin_layout Description
7913 8651
7914 \backslash
8652 \backslash
7915 8653 C_LightGreen
7916 \layout Description
8654 \end_layout
7917 8655
8656 \begin_layout Description
7918 8657
7919 \backslash
8658 \backslash
7920 8659 C_LightPurple
7921 \layout Description
8660 \end_layout
7922 8661
8662 \begin_layout Description
7923 8663
7924 \backslash
8664 \backslash
7925 8665 C_LightRed
7926 \layout Description
8666 \end_layout
7927 8667
8668 \begin_layout Description
7928 8669
7929 \backslash
8670 \backslash
7930 8671 C_Purple
7931 \layout Description
8672 \end_layout
7932 8673
8674 \begin_layout Description
7933 8675
7934 \backslash
8676 \backslash
7935 8677 C_Red
7936 \layout Description
8678 \end_layout
7937 8679
8680 \begin_layout Description
7938 8681
7939 \backslash
8682 \backslash
7940 8683 C_White
7941 \layout Description
8684 \end_layout
7942 8685
8686 \begin_layout Description
7943 8687
7944 \backslash
8688 \backslash
7945 8689 C_Yellow
7946 \layout Description
8690 \end_layout
7947 8691
8692 \begin_layout Description
7948 8693
7949 \backslash
8694 \backslash
7950 8695 C_Normal Stop coloring, defaults to your terminal settings.
7951 \layout Section
7952
8696 \end_layout
7953 8697
8698 \begin_layout Section
7954 8699 \begin_inset LatexCommand \label{sec:Threading-support}
7955 8700
7956 \end_inset
8701 \end_inset
7957 8702
7958 8703 Threading support
7959 \layout Standard
8704 \end_layout
7960 8705
8706 \begin_layout Standard
7961 8707
7962 \series bold
8708 \series bold
7963 8709 WARNING:
7964 \series default
8710 \series default
7965 8711 The threading support is still somewhat experimental, and it has only seen
7966 8712 reasonable testing under Linux.
7967 8713 Threaded code is particularly tricky to debug, and it tends to show extremely
7968 8714 platform-dependent behavior.
7969 8715 Since I only have access to Linux machines, I will have to rely on user's
7970 8716 experiences and assistance for this area of IPython to improve under other
7971 8717 platforms.
7972 \layout Standard
8718 \end_layout
7973 8719
8720 \begin_layout Standard
7974 8721 IPython, via the
7975 \family typewriter
8722 \family typewriter
7976 8723 -gthread
7977 \family default
8724 \family default
7978 8725 ,
7979 \family typewriter
8726 \family typewriter
7980 8727 -qthread
7981 \family default
8728 \family default
7982 8729 and
7983 \family typewriter
8730 \family typewriter
7984 8731 -wthread
7985 \family default
7986 options (described in Sec.\SpecialChar ~
8732 \family default
8733 options (described in Sec.\InsetSpace ~
7987 8734
7988 8735 \begin_inset LatexCommand \ref{sec:threading-opts}
7989 8736
7990 \end_inset
8737 \end_inset
7991 8738
7992 8739 ), can run in multithreaded mode to support pyGTK, Qt and WXPython applications
7993 8740 respectively.
7994 8741 These GUI toolkits need to control the python main loop of execution, so
7995 8742 under a normal Python interpreter, starting a pyGTK, Qt or WXPython application
7996 8743 will immediately freeze the shell.
7997 8744
7998 \layout Standard
8745 \end_layout
7999 8746
8747 \begin_layout Standard
8000 8748 IPython, with one of these options (you can only use one at a time), separates
8001 8749 the graphical loop and IPython's code execution run into different threads.
8002 8750 This allows you to test interactively (with
8003 \family typewriter
8751 \family typewriter
8004 8752 %run
8005 \family default
8753 \family default
8006 8754 , for example) your GUI code without blocking.
8007 \layout Standard
8755 \end_layout
8008 8756
8757 \begin_layout Standard
8009 8758 A nice mini-tutorial on using IPython along with the Qt Designer application
8010 8759 is available at the SciPy wiki:
8011 8760 \begin_inset LatexCommand \htmlurl{http://www.scipy.org/Cookbook/Matplotlib/Qt_with_IPython_and_Designer}
8012 8761
8013 \end_inset
8762 \end_inset
8014 8763
8015 8764 .
8016 \layout Subsection
8765 \end_layout
8017 8766
8767 \begin_layout Subsection
8018 8768 Tk issues
8019 \layout Standard
8769 \end_layout
8020 8770
8021 As indicated in Sec.\SpecialChar ~
8771 \begin_layout Standard
8772 As indicated in Sec.\InsetSpace ~
8022 8773
8023 8774 \begin_inset LatexCommand \ref{sec:threading-opts}
8024 8775
8025 \end_inset
8776 \end_inset
8026 8777
8027 8778 , a special
8028 \family typewriter
8779 \family typewriter
8029 8780 -tk
8030 \family default
8781 \family default
8031 8782 option is provided to try and allow Tk graphical applications to coexist
8032 8783 interactively with WX, Qt or GTK ones.
8033 8784 Whether this works at all, however, is very platform and configuration
8034 8785 dependent.
8035 8786 Please experiment with simple test cases before committing to using this
8036 8787 combination of Tk and GTK/Qt/WX threading in a production environment.
8037 \layout Subsection
8788 \end_layout
8038 8789
8790 \begin_layout Subsection
8039 8791 Signals and Threads
8040 \layout Standard
8792 \end_layout
8041 8793
8794 \begin_layout Standard
8042 8795 When any of the thread systems (GTK, Qt or WX) are active, either directly
8043 8796 or via
8044 \family typewriter
8797 \family typewriter
8045 8798 -pylab
8046 \family default
8799 \family default
8047 8800 with a threaded backend, it is impossible to interrupt long-running Python
8048 8801 code via
8049 \family typewriter
8802 \family typewriter
8050 8803 Ctrl-C
8051 \family default
8804 \family default
8052 8805 .
8053 8806 IPython can not pass the KeyboardInterrupt exception (or the underlying
8054 8807
8055 \family typewriter
8808 \family typewriter
8056 8809 SIGINT
8057 \family default
8810 \family default
8058 8811 ) across threads, so any long-running process started from IPython will
8059 8812 run to completion, or will have to be killed via an external (OS-based)
8060 8813 mechanism.
8061 \layout Standard
8814 \end_layout
8062 8815
8816 \begin_layout Standard
8063 8817 To the best of my knowledge, this limitation is imposed by the Python interprete
8064 8818 r itself, and it comes from the difficulty of writing portable signal/threaded
8065 8819 code.
8066 8820 If any user is an expert on this topic and can suggest a better solution,
8067 8821 I would love to hear about it.
8068 8822 In the IPython sources, look at the
8069 \family typewriter
8823 \family typewriter
8070 8824 Shell.py
8071 \family default
8825 \family default
8072 8826 module, and in particular at the
8073 \family typewriter
8827 \family typewriter
8074 8828 runcode()
8075 \family default
8829 \family default
8076 8830 method.
8077 8831
8078 \layout Subsection
8832 \end_layout
8079 8833
8834 \begin_layout Subsection
8080 8835 I/O pitfalls
8081 \layout Standard
8836 \end_layout
8082 8837
8838 \begin_layout Standard
8083 8839 Be mindful that the Python interpreter switches between threads every
8084 8840 \begin_inset Formula $N$
8085 \end_inset
8841 \end_inset
8086 8842
8087 bytecodes, where the default value as of Python\SpecialChar ~
8843 bytecodes, where the default value as of Python\InsetSpace ~
8088 8844 2.3 is
8089 8845 \begin_inset Formula $N=100.$
8090 \end_inset
8846 \end_inset
8091 8847
8092 8848 This value can be read by using the
8093 \family typewriter
8849 \family typewriter
8094 8850 sys.getcheckinterval()
8095 \family default
8851 \family default
8096 8852 function, and it can be reset via
8097 \family typewriter
8853 \family typewriter
8098 8854 sys.setcheckinterval(
8099 \emph on
8855 \emph on
8100 8856 N
8101 \emph default
8857 \emph default
8102 8858 )
8103 \family default
8859 \family default
8104 8860 .
8105 8861 This switching of threads can cause subtly confusing effects if one of
8106 8862 your threads is doing file I/O.
8107 8863 In text mode, most systems only flush file buffers when they encounter
8108 8864 a
8109 \family typewriter
8865 \family typewriter
8110 8866 `
8111 \backslash
8867 \backslash
8112 8868 n'
8113 \family default
8869 \family default
8114 8870 .
8115 8871 An instruction as simple as
8116 \family typewriter
8872 \family typewriter
8117 8873
8118 \newline
8119 \SpecialChar ~
8120 \SpecialChar ~
8874 \newline
8875 \InsetSpace ~
8876 \InsetSpace ~
8121 8877 print >> filehandle,
8122 8878 \begin_inset Quotes eld
8123 \end_inset
8879 \end_inset
8124 8880
8125 8881 hello world
8126 8882 \begin_inset Quotes erd
8127 \end_inset
8883 \end_inset
8128 8884
8129 8885
8130 \family default
8886 \family default
8131 8887
8132 \newline
8888 \newline
8133 8889 actually consists of several bytecodes, so it is possible that the newline
8134 8890 does not reach your file before the next thread switch.
8135 8891 Similarly, if you are writing to a file in binary mode, the file won't
8136 8892 be flushed until the buffer fills, and your other thread may see apparently
8137 8893 truncated files.
8138 8894
8139 \layout Standard
8895 \end_layout
8140 8896
8897 \begin_layout Standard
8141 8898 For this reason, if you are using IPython's thread support and have (for
8142 8899 example) a GUI application which will read data generated by files written
8143 8900 to from the IPython thread, the safest approach is to open all of your
8144 8901 files in unbuffered mode (the third argument to the
8145 \family typewriter
8902 \family typewriter
8146 8903 file/open
8147 \family default
8904 \family default
8148 8905 function is the buffering value):
8149 \newline
8906 \newline
8150 8907
8151 \family typewriter
8152 \SpecialChar ~
8153 \SpecialChar ~
8908 \family typewriter
8909 \InsetSpace ~
8910 \InsetSpace ~
8154 8911 filehandle = open(filename,mode,0)
8155 \layout Standard
8912 \end_layout
8156 8913
8914 \begin_layout Standard
8157 8915 This is obviously a brute force way of avoiding race conditions with the
8158 8916 file buffering.
8159 8917 If you want to do it cleanly, and you have a resource which is being shared
8160 8918 by the interactive IPython loop and your GUI thread, you should really
8161 8919 handle it with thread locking and syncrhonization properties.
8162 8920 The Python documentation discusses these.
8163 \layout Section
8164
8921 \end_layout
8165 8922
8923 \begin_layout Section
8166 8924 \begin_inset LatexCommand \label{sec:interactive-demos}
8167 8925
8168 \end_inset
8926 \end_inset
8169 8927
8170 8928 Interactive demos with IPython
8171 \layout Standard
8929 \end_layout
8172 8930
8931 \begin_layout Standard
8173 8932 IPython ships with a basic system for running scripts interactively in sections,
8174 8933 useful when presenting code to audiences.
8175 8934 A few tags embedded in comments (so that the script remains valid Python
8176 8935 code) divide a file into separate blocks, and the demo can be run one block
8177 8936 at a time, with IPython printing (with syntax highlighting) the block before
8178 8937 executing it, and returning to the interactive prompt after each block.
8179 8938 The interactive namespace is updated after each block is run with the contents
8180 8939 of the demo's namespace.
8181 \layout Standard
8940 \end_layout
8182 8941
8942 \begin_layout Standard
8183 8943 This allows you to show a piece of code, run it and then execute interactively
8184 8944 commands based on the variables just created.
8185 8945 Once you want to continue, you simply execute the next block of the demo.
8186 8946 The following listing shows the markup necessary for dividing a script
8187 8947 into sections for execution as a demo.
8188 \layout Standard
8189
8948 \end_layout
8190 8949
8950 \begin_layout Standard
8191 8951 \begin_inset ERT
8192 status Open
8952 status open
8953
8954 \begin_layout Standard
8193 8955
8194 \layout Standard
8195 8956
8196 \backslash
8957 \backslash
8197 8958 codelist{examples/example-demo.py}
8198 \end_inset
8959 \end_layout
8199 8960
8961 \end_inset
8200 8962
8201 \layout Standard
8202 8963
8964 \end_layout
8965
8966 \begin_layout Standard
8203 8967 In order to run a file as a demo, you must first make a
8204 \family typewriter
8968 \family typewriter
8205 8969 Demo
8206 \family default
8970 \family default
8207 8971 object out of it.
8208 8972 If the file is named
8209 \family typewriter
8973 \family typewriter
8210 8974 myscript.py
8211 \family default
8975 \family default
8212 8976 , the following code will make a demo:
8213 \layout LyX-Code
8977 \end_layout
8214 8978
8979 \begin_layout LyX-Code
8215 8980 from IPython.demo import Demo
8216 \layout LyX-Code
8981 \end_layout
8217 8982
8983 \begin_layout LyX-Code
8218 8984 mydemo = Demo('myscript.py')
8219 \layout Standard
8985 \end_layout
8220 8986
8987 \begin_layout Standard
8221 8988 This creates the
8222 \family typewriter
8989 \family typewriter
8223 8990 mydemo
8224 \family default
8991 \family default
8225 8992 object, whose blocks you run one at a time by simply calling the object
8226 8993 with no arguments.
8227 8994 If you have autocall active in IPython (the default), all you need to do
8228 8995 is type
8229 \layout LyX-Code
8996 \end_layout
8230 8997
8998 \begin_layout LyX-Code
8231 8999 mydemo
8232 \layout Standard
9000 \end_layout
8233 9001
9002 \begin_layout Standard
8234 9003 and IPython will call it, executing each block.
8235 9004 Demo objects can be restarted, you can move forward or back skipping blocks,
8236 9005 re-execute the last block, etc.
8237 9006 Simply use the Tab key on a demo object to see its methods, and call
8238 \family typewriter
9007 \family typewriter
8239 9008 `?'
8240 \family default
9009 \family default
8241 9010 on them to see their docstrings for more usage details.
8242 9011 In addition, the
8243 \family typewriter
9012 \family typewriter
8244 9013 demo
8245 \family default
9014 \family default
8246 9015 module itself contains a comprehensive docstring, which you can access
8247 9016 via
8248 \layout LyX-Code
9017 \end_layout
8249 9018
9019 \begin_layout LyX-Code
8250 9020 from IPython import demo
8251 \layout LyX-Code
9021 \end_layout
8252 9022
9023 \begin_layout LyX-Code
8253 9024 demo?
8254 \layout Standard
9025 \end_layout
8255 9026
9027 \begin_layout Standard
8256 9028
8257 \series bold
9029 \series bold
8258 9030 Limitations:
8259 \series default
9031 \series default
8260 9032 It is important to note that these demos are limited to fairly simple uses.
8261 9033 In particular, you can
8262 \emph on
9034 \emph on
8263 9035 not
8264 \emph default
9036 \emph default
8265 9037 put division marks in indented code (loops, if statements, function definitions
8266 9038 , etc.) Supporting something like this would basically require tracking the
8267 9039 internal execution state of the Python interpreter, so only top-level divisions
8268 9040 are allowed.
8269 9041 If you want to be able to open an IPython instance at an arbitrary point
8270 9042 in a program, you can use IPython's embedding facilities, described in
8271 9043 detail in Sec\SpecialChar \@.
8272 \SpecialChar ~
9044 \InsetSpace ~
8273 9045
8274 9046 \begin_inset LatexCommand \ref{sec:embed}
8275 9047
8276 \end_inset
9048 \end_inset
8277 9049
8278 9050 .
8279 \layout Section
8280
9051 \end_layout
8281 9052
9053 \begin_layout Section
8282 9054 \begin_inset LatexCommand \label{sec:matplotlib-support}
8283 9055
8284 \end_inset
9056 \end_inset
8285 9057
8286 9058 Plotting with
8287 \family typewriter
9059 \family typewriter
8288 9060 matplotlib
8289 \family default
9061 \family default
8290 9062
8291 \layout Standard
9063 \end_layout
8292 9064
9065 \begin_layout Standard
8293 9066 The matplotlib library (
8294 9067 \begin_inset LatexCommand \htmlurl[http://matplotlib.sourceforge.net]{http://matplotlib.sourceforge.net}
8295 9068
8296 \end_inset
9069 \end_inset
8297 9070
8298 9071 ) provides high quality 2D plotting for Python.
8299 9072 Matplotlib can produce plots on screen using a variety of GUI toolkits,
8300 9073 including Tk, GTK and WXPython.
8301 9074 It also provides a number of commands useful for scientific computing,
8302 9075 all with a syntax compatible with that of the popular Matlab program.
8303 \layout Standard
9076 \end_layout
8304 9077
9078 \begin_layout Standard
8305 9079 IPython accepts the special option
8306 \family typewriter
9080 \family typewriter
8307 9081 -pylab
8308 \family default
8309 (Sec.\SpecialChar ~
9082 \family default
9083 (Sec.\InsetSpace ~
8310 9084
8311 9085 \begin_inset LatexCommand \ref{sec:cmd-line-opts}
8312 9086
8313 \end_inset
9087 \end_inset
8314 9088
8315 9089 ).
8316 9090 This configures it to support matplotlib, honoring the settings in the
8317 9091
8318 \family typewriter
9092 \family typewriter
8319 9093 .matplotlibrc
8320 \family default
9094 \family default
8321 9095 file.
8322 9096 IPython will detect the user's choice of matplotlib GUI backend, and automatica
8323 9097 lly select the proper threading model to prevent blocking.
8324 9098 It also sets matplotlib in interactive mode and modifies
8325 \family typewriter
9099 \family typewriter
8326 9100 %run
8327 \family default
9101 \family default
8328 9102 slightly, so that any matplotlib-based script can be executed using
8329 \family typewriter
9103 \family typewriter
8330 9104 %run
8331 \family default
9105 \family default
8332 9106 and the final
8333 \family typewriter
9107 \family typewriter
8334 9108 show()
8335 \family default
9109 \family default
8336 9110 command does not block the interactive shell.
8337 \layout Standard
9111 \end_layout
8338 9112
9113 \begin_layout Standard
8339 9114 The
8340 \family typewriter
9115 \family typewriter
8341 9116 -pylab
8342 \family default
9117 \family default
8343 9118 option must be given first in order for IPython to configure its threading
8344 9119 mode.
8345 9120 However, you can still issue other options afterwards.
8346 9121 This allows you to have a matplotlib-based environment customized with
8347 additional modules using the standard IPython profile mechanism (Sec.\SpecialChar ~
9122 additional modules using the standard IPython profile mechanism (Sec.\InsetSpace ~
8348 9123
8349 9124 \begin_inset LatexCommand \ref{sec:profiles}
8350 9125
8351 \end_inset
9126 \end_inset
8352 9127
8353 9128 ): ``
8354 \family typewriter
9129 \family typewriter
8355 9130 ipython -pylab -p myprofile
8356 \family default
9131 \family default
8357 9132 '' will load the profile defined in
8358 \family typewriter
9133 \family typewriter
8359 9134 ipythonrc-myprofile
8360 \family default
9135 \family default
8361 9136 after configuring matplotlib.
8362 \layout Section
8363
9137 \end_layout
8364 9138
9139 \begin_layout Section
8365 9140 \begin_inset LatexCommand \label{sec:Gnuplot}
8366 9141
8367 \end_inset
9142 \end_inset
8368 9143
8369 9144 Plotting with
8370 \family typewriter
9145 \family typewriter
8371 9146 Gnuplot
8372 \layout Standard
9147 \end_layout
8373 9148
9149 \begin_layout Standard
8374 9150 Through the magic extension system described in sec.
8375 9151
8376 9152 \begin_inset LatexCommand \ref{sec:magic}
8377 9153
8378 \end_inset
9154 \end_inset
8379 9155
8380 9156 , IPython incorporates a mechanism for conveniently interfacing with the
8381 9157 Gnuplot system (
8382 9158 \begin_inset LatexCommand \htmlurl{http://www.gnuplot.info}
8383 9159
8384 \end_inset
9160 \end_inset
8385 9161
8386 9162 ).
8387 9163 Gnuplot is a very complete 2D and 3D plotting package available for many
8388 9164 operating systems and commonly included in modern Linux distributions.
8389 9165
8390 \layout Standard
9166 \end_layout
8391 9167
9168 \begin_layout Standard
8392 9169 Besides having Gnuplot installed, this functionality requires the
8393 \family typewriter
9170 \family typewriter
8394 9171 Gnuplot.py
8395 \family default
9172 \family default
8396 9173 module for interfacing python with Gnuplot.
8397 9174 It can be downloaded from:
8398 9175 \begin_inset LatexCommand \htmlurl{http://gnuplot-py.sourceforge.net}
8399 9176
8400 \end_inset
9177 \end_inset
8401 9178
8402 9179 .
8403 \layout Subsection
9180 \end_layout
8404 9181
9182 \begin_layout Subsection
8405 9183 Proper Gnuplot configuration
8406 \layout Standard
9184 \end_layout
8407 9185
9186 \begin_layout Standard
8408 9187 As of version 4.0, Gnuplot has excellent mouse and interactive keyboard support.
8409 9188 However, as of
8410 \family typewriter
9189 \family typewriter
8411 9190 Gnuplot.py
8412 \family default
9191 \family default
8413 9192 version 1.7, a new option was added to communicate between Python and Gnuplot
8414 9193 via FIFOs (pipes).
8415 9194 This mechanism, while fast, also breaks the mouse system.
8416 9195 You must therefore set the variable
8417 \family typewriter
9196 \family typewriter
8418 9197 prefer_fifo_data
8419 \family default
9198 \family default
8420 9199 to
8421 \family typewriter
9200 \family typewriter
8422 9201 0
8423 \family default
9202 \family default
8424 9203 in file
8425 \family typewriter
9204 \family typewriter
8426 9205 gp_unix.py
8427 \family default
9206 \family default
8428 9207 if you wish to keep the interactive mouse and keyboard features working
8429 9208 properly (
8430 \family typewriter
9209 \family typewriter
8431 9210 prefer_inline_data
8432 \family default
9211 \family default
8433 9212 also must be
8434 \family typewriter
9213 \family typewriter
8435 9214 0
8436 \family default
9215 \family default
8437 9216 , but this is the default so unless you've changed it manually you should
8438 9217 be fine).
8439 \layout Standard
9218 \end_layout
8440 9219
9220 \begin_layout Standard
8441 9221 'Out of the box', Gnuplot is configured with a rather poor set of size,
8442 9222 color and linewidth choices which make the graphs fairly hard to read on
8443 9223 modern high-resolution displays (although they work fine on old 640x480
8444 9224 ones).
8445 9225 Below is a section of my
8446 \family typewriter
9226 \family typewriter
8447 9227 .Xdefaults
8448 \family default
9228 \family default
8449 9229 file which I use for having a more convenient Gnuplot setup.
8450 9230 Remember to load it by running
8451 \family typewriter
9231 \family typewriter
8452 9232 `xrdb .Xdefaults`
8453 \family default
9233 \family default
8454 9234 :
8455 \layout Standard
9235 \end_layout
8456 9236
9237 \begin_layout Standard
8457 9238
8458 \family typewriter
9239 \family typewriter
8459 9240 !******************************************************************
8460 \newline
8461 ! gnuplot options
8462 \newline
9241 \newline
9242 ! gnuplot
9243 options
9244 \newline
8463 9245 ! modify this for a convenient window size
8464 \newline
9246 \newline
8465 9247 gnuplot*geometry: 780x580
8466 \layout Standard
9248 \end_layout
8467 9249
9250 \begin_layout Standard
8468 9251
8469 \family typewriter
9252 \family typewriter
8470 9253 ! on-screen font (not for PostScript)
8471 \newline
8472 gnuplot*font: -misc-fixed-bold-r-normal--15-120-100-100-c-90-iso8859-1
8473 \layout Standard
9254 \newline
9255 gnuplot*font: -misc-fixed-bold-r-normal--15
9256 -120-100-100-c-90-iso8859-1
9257 \end_layout
8474 9258
9259 \begin_layout Standard
8475 9260
8476 \family typewriter
9261 \family typewriter
8477 9262 ! color options
8478 \newline
9263 \newline
8479 9264 gnuplot*background: black
8480 \newline
9265 \newline
8481 9266 gnuplot*textColor: white
8482 \newline
8483 gnuplot*borderColor: white
8484 \newline
9267 \newline
9268 gnuplot*borderCo
9269 lor: white
9270 \newline
8485 9271 gnuplot*axisColor: white
8486 \newline
9272 \newline
8487 9273 gnuplot*line1Color: red
8488 \newline
8489 gnuplot*line2Color: green
8490 \newline
9274 \newline
9275 gnuplot*line2Color:
9276 green
9277 \newline
8491 9278 gnuplot*line3Color: blue
8492 \newline
9279 \newline
8493 9280 gnuplot*line4Color: magenta
8494 \newline
8495 gnuplot*line5Color: cyan
8496 \newline
9281 \newline
9282 gnuplot*line5Color:
9283 cyan
9284 \newline
8497 9285 gnuplot*line6Color: sienna
8498 \newline
9286 \newline
8499 9287 gnuplot*line7Color: orange
8500 \newline
8501 gnuplot*line8Color: coral
8502 \layout Standard
9288 \newline
9289 gnuplot*line8Color:
9290 coral
9291 \end_layout
8503 9292
9293 \begin_layout Standard
8504 9294
8505 \family typewriter
9295 \family typewriter
8506 9296 ! multiplicative factor for point styles
8507 \newline
9297 \newline
8508 9298 gnuplot*pointsize: 2
8509 \layout Standard
9299 \end_layout
8510 9300
9301 \begin_layout Standard
8511 9302
8512 \family typewriter
9303 \family typewriter
8513 9304 ! line width options (in pixels)
8514 \newline
9305 \newline
8515 9306 gnuplot*borderWidth: 2
8516 \newline
8517 gnuplot*axisWidth: 2
8518 \newline
9307 \newline
9308 gnuplot*axisWidth:
9309 2
9310 \newline
8519 9311 gnuplot*line1Width: 2
8520 \newline
9312 \newline
8521 9313 gnuplot*line2Width: 2
8522 \newline
9314 \newline
8523 9315 gnuplot*line3Width: 2
8524 \newline
8525 gnuplot*line4Width: 2
8526 \newline
9316 \newline
9317 gnuplot*line4Wi
9318 dth: 2
9319 \newline
8527 9320 gnuplot*line5Width: 2
8528 \newline
9321 \newline
8529 9322 gnuplot*line6Width: 2
8530 \newline
9323 \newline
8531 9324 gnuplot*line7Width: 2
8532 \newline
8533 gnuplot*line8Width: 2
8534 \layout Subsection
9325 \newline
9326 gnuplot*lin
9327 e8Width: 2
9328 \end_layout
8535 9329
9330 \begin_layout Subsection
8536 9331 The
8537 \family typewriter
9332 \family typewriter
8538 9333 IPython.GnuplotRuntime
8539 \family default
9334 \family default
8540 9335 module
8541 \layout Standard
9336 \end_layout
8542 9337
9338 \begin_layout Standard
8543 9339 IPython includes a module called
8544 \family typewriter
9340 \family typewriter
8545 9341 Gnuplot2.py
8546 \family default
9342 \family default
8547 9343 which extends and improves the default
8548 \family typewriter
9344 \family typewriter
8549 9345 Gnuplot
8550 \family default
9346 \family default
8551 9347 .
8552 \family typewriter
9348 \family typewriter
8553 9349 py
8554 \family default
9350 \family default
8555 9351 (which it still relies upon).
8556 9352 For example, the new
8557 \family typewriter
9353 \family typewriter
8558 9354 plot
8559 \family default
9355 \family default
8560 9356 function adds several improvements to the original making it more convenient
8561 9357 for interactive use, and
8562 \family typewriter
9358 \family typewriter
8563 9359 hardcopy
8564 \family default
9360 \family default
8565 9361 fixes a bug in the original which under some circumstances blocks the creation
8566 9362 of PostScript output.
8567 \layout Standard
9363 \end_layout
8568 9364
9365 \begin_layout Standard
8569 9366 For scripting use,
8570 \family typewriter
9367 \family typewriter
8571 9368 GnuplotRuntime.py
8572 \family default
9369 \family default
8573 9370 is provided, which wraps
8574 \family typewriter
9371 \family typewriter
8575 9372 Gnuplot2.py
8576 \family default
9373 \family default
8577 9374 and creates a series of global aliases.
8578 9375 These make it easy to control Gnuplot plotting jobs through the Python
8579 9376 language.
8580 \layout Standard
9377 \end_layout
8581 9378
9379 \begin_layout Standard
8582 9380 Below is some example code which illustrates how to configure Gnuplot inside
8583 9381 your own programs but have it available for further interactive use through
8584 9382 an embedded IPython instance.
8585 9383 Simply run this file at a system prompt.
8586 9384 This file is provided as
8587 \family typewriter
9385 \family typewriter
8588 9386 example-gnuplot.py
8589 \family default
9387 \family default
8590 9388 in the examples directory:
8591 \layout Standard
8592
9389 \end_layout
8593 9390
9391 \begin_layout Standard
8594 9392 \begin_inset ERT
8595 status Open
9393 status open
9394
9395 \begin_layout Standard
8596 9396
8597 \layout Standard
8598 9397
8599 \backslash
9398 \backslash
8600 9399 codelist{examples/example-gnuplot.py}
8601 \end_inset
9400 \end_layout
8602 9401
9402 \end_inset
8603 9403
8604 \layout Subsection
8605 9404
9405 \end_layout
9406
9407 \begin_layout Subsection
8606 9408 The
8607 \family typewriter
9409 \family typewriter
8608 9410 numeric
8609 \family default
9411 \family default
8610 9412 profile: a scientific computing environment
8611 \layout Standard
9413 \end_layout
8612 9414
9415 \begin_layout Standard
8613 9416 The
8614 \family typewriter
9417 \family typewriter
8615 9418 numeric
8616 \family default
9419 \family default
8617 9420 IPython profile, which you can activate with
8618 \family typewriter
9421 \family typewriter
8619 9422 `ipython -p numeric
8620 \family default
9423 \family default
8621 9424 ' will automatically load the IPython Gnuplot extensions (plus Numeric and
8622 9425 other useful things for numerical computing), contained in the
8623 \family typewriter
9426 \family typewriter
8624 9427 IPython.GnuplotInteractive
8625 \family default
9428 \family default
8626 9429 module.
8627 9430 This will create the globals
8628 \family typewriter
9431 \family typewriter
8629 9432 Gnuplot
8630 \family default
9433 \family default
8631 9434 (an alias to the improved Gnuplot2 module),
8632 \family typewriter
9435 \family typewriter
8633 9436 gp
8634 \family default
9437 \family default
8635 9438 (a Gnuplot active instance), the new magic commands
8636 \family typewriter
9439 \family typewriter
8637 9440 %gpc
8638 \family default
9441 \family default
8639 9442 and
8640 \family typewriter
9443 \family typewriter
8641 9444 %gp_set_instance
8642 \family default
9445 \family default
8643 9446 and several other convenient globals.
8644 9447 Type
8645 \family typewriter
9448 \family typewriter
8646 9449 gphelp()
8647 \family default
9450 \family default
8648 9451 for further details.
8649 \layout Standard
9452 \end_layout
8650 9453
9454 \begin_layout Standard
8651 9455 This should turn IPython into a convenient environment for numerical computing,
8652 9456 with all the functions in the NumPy library and the Gnuplot facilities
8653 9457 for plotting.
8654 9458 Further improvements can be obtained by loading the SciPy libraries for
8655 9459 scientific computing, available at
8656 9460 \begin_inset LatexCommand \htmlurl{http://scipy.org}
8657 9461
8658 \end_inset
9462 \end_inset
8659 9463
8660 9464 .
8661 \layout Standard
9465 \end_layout
8662 9466
9467 \begin_layout Standard
8663 9468 If you are in the middle of a working session with numerical objects and
8664 9469 need to plot them but you didn't start the
8665 \family typewriter
9470 \family typewriter
8666 9471 numeric
8667 \family default
9472 \family default
8668 9473 profile, you can load these extensions at any time by typing
8669 \newline
9474 \newline
8670 9475
8671 \family typewriter
9476 \family typewriter
8672 9477 from IPython.GnuplotInteractive import *
8673 \newline
9478 \newline
8674 9479
8675 \family default
9480 \family default
8676 9481 at the IPython prompt.
8677 9482 This will allow you to keep your objects intact and start using Gnuplot
8678 9483 to view them.
8679 \layout Section
9484 \end_layout
8680 9485
9486 \begin_layout Section
8681 9487 Reporting bugs
8682 \layout Subsection*
9488 \end_layout
8683 9489
9490 \begin_layout Subsection*
8684 9491 Automatic crash reports
8685 \layout Standard
9492 \end_layout
8686 9493
9494 \begin_layout Standard
8687 9495 Ideally, IPython itself shouldn't crash.
8688 9496 It will catch exceptions produced by you, but bugs in its internals will
8689 9497 still crash it.
8690 \layout Standard
9498 \end_layout
8691 9499
9500 \begin_layout Standard
8692 9501 In such a situation, IPython will leave a file named
8693 \family typewriter
9502 \family typewriter
8694 9503 IPython_crash_report.txt
8695 \family default
9504 \family default
8696 9505 in your IPYTHONDIR directory (that way if crashes happen several times
8697 9506 it won't litter many directories, the post-mortem file is always located
8698 9507 in the same place and new occurrences just overwrite the previous one).
8699 9508 If you can mail this file to the developers (see sec.
8700 9509
8701 9510 \begin_inset LatexCommand \ref{sec:credits}
8702 9511
8703 \end_inset
9512 \end_inset
8704 9513
8705 9514 for names and addresses), it will help us
8706 \emph on
9515 \emph on
8707 9516 a lot
8708 \emph default
9517 \emph default
8709 9518 in understanding the cause of the problem and fixing it sooner.
8710 \layout Subsection*
9519 \end_layout
8711 9520
9521 \begin_layout Subsection*
8712 9522 The bug tracker
8713 \layout Standard
9523 \end_layout
8714 9524
9525 \begin_layout Standard
8715 9526 IPython also has an online bug-tracker, located at
8716 9527 \begin_inset LatexCommand \htmlurl{http://projects.scipy.org/ipython/ipython/report/1}
8717 9528
8718 \end_inset
9529 \end_inset
8719 9530
8720 9531 .
8721 9532 In addition to mailing the developers, it would be a good idea to file
8722 9533 a bug report here.
8723 9534 This will ensure that the issue is properly followed to conclusion.
8724 9535 To report new bugs you will have to register first.
8725 \layout Standard
9536 \end_layout
8726 9537
9538 \begin_layout Standard
8727 9539 You can also use this bug tracker to file feature requests.
8728 \layout Section
9540 \end_layout
8729 9541
9542 \begin_layout Section
8730 9543 Brief history
8731 \layout Subsection
9544 \end_layout
8732 9545
9546 \begin_layout Subsection
8733 9547 Origins
8734 \layout Standard
9548 \end_layout
8735 9549
9550 \begin_layout Standard
8736 9551 The current IPython system grew out of the following three projects:
8737 \layout List
8738 \labelwidthstring 00.00.0000
9552 \end_layout
8739 9553
9554 \begin_layout List
9555 \labelwidthstring 00.00.0000
8740 9556 ipython by Fernando P
8741 9557 \begin_inset ERT
8742 status Collapsed
9558 status collapsed
9559
9560 \begin_layout Standard
8743 9561
8744 \layout Standard
8745 9562
8746 \backslash
9563 \backslash
8747 9564 '{e}
8748 \end_inset
9565 \end_layout
9566
9567 \end_inset
8749 9568
8750 9569 rez.
8751 9570 I was working on adding Mathematica-type prompts and a flexible configuration
8752 9571 system (something better than
8753 \family typewriter
9572 \family typewriter
8754 9573 $PYTHONSTARTUP
8755 \family default
9574 \family default
8756 9575 ) to the standard Python interactive interpreter.
8757 \layout List
8758 \labelwidthstring 00.00.0000
9576 \end_layout
8759 9577
9578 \begin_layout List
9579 \labelwidthstring 00.00.0000
8760 9580 IPP by Janko Hauser.
8761 9581 Very well organized, great usability.
8762 9582 Had an old help system.
8763 9583 IPP was used as the `container' code into which I added the functionality
8764 9584 from ipython and LazyPython.
8765 \layout List
8766 \labelwidthstring 00.00.0000
9585 \end_layout
8767 9586
9587 \begin_layout List
9588 \labelwidthstring 00.00.0000
8768 9589 LazyPython by Nathan Gray.
8769 9590 Simple but
8770 \emph on
9591 \emph on
8771 9592 very
8772 \emph default
9593 \emph default
8773 9594 powerful.
8774 9595 The quick syntax (auto parens, auto quotes) and verbose/colored tracebacks
8775 9596 were all taken from here.
8776 \layout Standard
9597 \end_layout
8777 9598
9599 \begin_layout Standard
8778 9600 When I found out (see sec.
8779 9601
8780 9602 \begin_inset LatexCommand \ref{figgins}
8781 9603
8782 \end_inset
9604 \end_inset
8783 9605
8784 9606 ) about IPP and LazyPython I tried to join all three into a unified system.
8785 9607 I thought this could provide a very nice working environment, both for
8786 9608 regular programming and scientific computing: shell-like features, IDL/Matlab
8787 9609 numerics, Mathematica-type prompt history and great object introspection
8788 9610 and help facilities.
8789 9611 I think it worked reasonably well, though it was a lot more work than I
8790 9612 had initially planned.
8791 \layout Subsection
9613 \end_layout
8792 9614
9615 \begin_layout Subsection
8793 9616 Current status
8794 \layout Standard
9617 \end_layout
8795 9618
9619 \begin_layout Standard
8796 9620 The above listed features work, and quite well for the most part.
8797 9621 But until a major internal restructuring is done (see below), only bug
8798 9622 fixing will be done, no other features will be added (unless very minor
8799 9623 and well localized in the cleaner parts of the code).
8800 \layout Standard
9624 \end_layout
8801 9625
9626 \begin_layout Standard
8802 9627 IPython consists of some 18000 lines of pure python code, of which roughly
8803 9628 two thirds is reasonably clean.
8804 9629 The rest is, messy code which needs a massive restructuring before any
8805 9630 further major work is done.
8806 9631 Even the messy code is fairly well documented though, and most of the problems
8807 9632 in the (non-existent) class design are well pointed to by a PyChecker run.
8808 9633 So the rewriting work isn't that bad, it will just be time-consuming.
8809 \layout Subsection
9634 \end_layout
8810 9635
9636 \begin_layout Subsection
8811 9637 Future
8812 \layout Standard
9638 \end_layout
8813 9639
9640 \begin_layout Standard
8814 9641 See the separate
8815 \family typewriter
9642 \family typewriter
8816 9643 new_design
8817 \family default
9644 \family default
8818 9645 document for details.
8819 9646 Ultimately, I would like to see IPython become part of the standard Python
8820 9647 distribution as a `big brother with batteries' to the standard Python interacti
8821 9648 ve interpreter.
8822 9649 But that will never happen with the current state of the code, so all contribut
8823 9650 ions are welcome.
8824 \layout Section
9651 \end_layout
8825 9652
9653 \begin_layout Section
8826 9654 License
8827 \layout Standard
9655 \end_layout
8828 9656
9657 \begin_layout Standard
8829 9658 IPython is released under the terms of the BSD license, whose general form
8830 9659 can be found at:
8831 9660 \begin_inset LatexCommand \htmlurl{http://www.opensource.org/licenses/bsd-license.php}
8832 9661
8833 \end_inset
9662 \end_inset
8834 9663
8835 9664 .
8836 9665 The full text of the IPython license is reproduced below:
8837 \layout Quote
9666 \end_layout
8838 9667
9668 \begin_layout Quote
8839 9669
8840 \family typewriter
8841 \size small
9670 \family typewriter
9671 \size small
8842 9672 IPython is released under a BSD-type license.
8843 \layout Quote
9673 \end_layout
8844 9674
9675 \begin_layout Quote
8845 9676
8846 \family typewriter
8847 \size small
9677 \family typewriter
9678 \size small
8848 9679 Copyright (c) 2001, 2002, 2003, 2004 Fernando Perez <fperez@colorado.edu>.
8849 \layout Quote
9680 \end_layout
8850 9681
9682 \begin_layout Quote
8851 9683
8852 \family typewriter
8853 \size small
9684 \family typewriter
9685 \size small
8854 9686 Copyright (c) 2001 Janko Hauser <jhauser@zscout.de> and
8855 \newline
8856 Nathaniel Gray <n8gray@caltech.edu>.
8857 \layout Quote
9687 \newline
9688 Nathaniel Gray <n8gray@ca
9689 ltech.edu>.
9690 \end_layout
8858 9691
9692 \begin_layout Quote
8859 9693
8860 \family typewriter
8861 \size small
9694 \family typewriter
9695 \size small
8862 9696 All rights reserved.
8863 \layout Quote
9697 \end_layout
8864 9698
9699 \begin_layout Quote
8865 9700
8866 \family typewriter
8867 \size small
9701 \family typewriter
9702 \size small
8868 9703 Redistribution and use in source and binary forms, with or without modification,
8869 9704 are permitted provided that the following conditions are met:
8870 \layout Quote
9705 \end_layout
8871 9706
9707 \begin_layout Quote
8872 9708
8873 \family typewriter
8874 \size small
9709 \family typewriter
9710 \size small
8875 9711 a.
8876 9712 Redistributions of source code must retain the above copyright notice,
8877 9713 this list of conditions and the following disclaimer.
8878 \layout Quote
9714 \end_layout
8879 9715
9716 \begin_layout Quote
8880 9717
8881 \family typewriter
8882 \size small
9718 \family typewriter
9719 \size small
8883 9720 b.
8884 9721 Redistributions in binary form must reproduce the above copyright notice,
8885 9722 this list of conditions and the following disclaimer in the documentation
8886 9723 and/or other materials provided with the distribution.
8887 \layout Quote
9724 \end_layout
8888 9725
9726 \begin_layout Quote
8889 9727
8890 \family typewriter
8891 \size small
9728 \family typewriter
9729 \size small
8892 9730 c.
8893 9731 Neither the name of the copyright holders nor the names of any contributors
8894 9732 to this software may be used to endorse or promote products derived from
8895 9733 this software without specific prior written permission.
8896 \layout Quote
9734 \end_layout
8897 9735
9736 \begin_layout Quote
8898 9737
8899 \family typewriter
8900 \size small
9738 \family typewriter
9739 \size small
8901 9740 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
8902 9741 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
8903 9742 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
8904 9743 PURPOSE ARE DISCLAIMED.
8905 9744 IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
8906 9745 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
8907 9746 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
8908 9747 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
8909 9748 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
8910 9749 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
8911 9750 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
8912 9751
8913 \layout Standard
9752 \end_layout
8914 9753
9754 \begin_layout Standard
8915 9755 Individual authors are the holders of the copyright for their code and are
8916 9756 listed in each file.
8917 \layout Standard
9757 \end_layout
8918 9758
9759 \begin_layout Standard
8919 9760 Some files (
8920 \family typewriter
9761 \family typewriter
8921 9762 DPyGetOpt.py
8922 \family default
9763 \family default
8923 9764 , for example) may be licensed under different conditions.
8924 9765 Ultimately each file indicates clearly the conditions under which its author/au
8925 9766 thors have decided to publish the code.
8926 \layout Standard
9767 \end_layout
8927 9768
9769 \begin_layout Standard
8928 9770 Versions of IPython up to and including 0.6.3 were released under the GNU
8929 9771 Lesser General Public License (LGPL), available at
8930 9772 \begin_inset LatexCommand \htmlurl{http://www.gnu.org/copyleft/lesser.html}
8931 9773
8932 \end_inset
9774 \end_inset
8933 9775
8934 9776 .
8935 \layout Section
8936
9777 \end_layout
8937 9778
9779 \begin_layout Section
8938 9780 \begin_inset LatexCommand \label{sec:credits}
8939 9781
8940 \end_inset
9782 \end_inset
8941 9783
8942 9784 Credits
8943 \layout Standard
9785 \end_layout
8944 9786
9787 \begin_layout Standard
8945 9788 IPython is mainly developed by Fernando P
8946 9789 \begin_inset ERT
8947 status Collapsed
9790 status collapsed
9791
9792 \begin_layout Standard
8948 9793
8949 \layout Standard
8950 9794
8951 \backslash
9795 \backslash
8952 9796 '{e}
8953 \end_inset
9797 \end_layout
9798
9799 \end_inset
8954 9800
8955 9801 rez
8956 \family typewriter
9802 \family typewriter
8957 9803 <Fernando.Perez@colorado.edu>
8958 \family default
9804 \family default
8959 9805 , but the project was born from mixing in Fernando's code with the IPP project
8960 9806 by Janko Hauser
8961 \family typewriter
9807 \family typewriter
8962 9808 <jhauser-AT-zscout.de>
8963 \family default
9809 \family default
8964 9810 and LazyPython by Nathan Gray
8965 \family typewriter
9811 \family typewriter
8966 9812 <n8gray-AT-caltech.edu>
8967 \family default
9813 \family default
8968 9814 .
8969 9815 For all IPython-related requests, please contact Fernando.
8970 9816
8971 \layout Standard
9817 \end_layout
8972 9818
9819 \begin_layout Standard
8973 9820 As of early 2006, the following developers have joined the core team:
8974 \layout List
8975 \labelwidthstring 00.00.0000
9821 \end_layout
8976 9822
8977 Robert\SpecialChar ~
9823 \begin_layout List
9824 \labelwidthstring 00.00.0000
9825 Robert\InsetSpace ~
8978 9826 Kern
8979 \family typewriter
9827 \family typewriter
8980 9828 <rkern-AT-enthought.com>
8981 \family default
9829 \family default
8982 9830 : co-mentored the 2005 Google Summer of Code project to develop python interacti
8983 9831 ve notebooks (XML documents) and graphical interface.
8984 9832 This project was awarded to the students Tzanko Matev
8985 \family typewriter
9833 \family typewriter
8986 9834 <tsanko-AT-gmail.com>
8987 \family default
9835 \family default
8988 9836 and Toni Alatalo
8989 \family typewriter
9837 \family typewriter
8990 9838 <antont-AT-an.org>
8991 \layout List
8992 \labelwidthstring 00.00.0000
9839 \end_layout
8993 9840
8994 Brian\SpecialChar ~
9841 \begin_layout List
9842 \labelwidthstring 00.00.0000
9843 Brian\InsetSpace ~
8995 9844 Granger
8996 \family typewriter
9845 \family typewriter
8997 9846 <bgranger-AT-scu.edu>
8998 \family default
9847 \family default
8999 9848 : extending IPython to allow support for interactive parallel computing.
9000 \layout List
9001 \labelwidthstring 00.00.0000
9849 \end_layout
9002 9850
9003 Ville\SpecialChar ~
9851 \begin_layout List
9852 \labelwidthstring 00.00.0000
9853 Ville\InsetSpace ~
9004 9854 Vainio
9005 \family typewriter
9855 \family typewriter
9006 9856 <vivainio-AT-gmail.com>
9007 \family default
9857 \family default
9008 9858 : Ville is the new maintainer for the main trunk of IPython after version
9009 9859 0.7.1.
9010 \layout Standard
9860 \end_layout
9011 9861
9862 \begin_layout Standard
9012 9863 User or development help should be requested via the IPython mailing lists:
9013 \layout Description
9864 \end_layout
9014 9865
9015 User\SpecialChar ~
9866 \begin_layout Description
9867 User\InsetSpace ~
9016 9868 list:
9017 9869 \begin_inset LatexCommand \htmlurl{http://scipy.net/mailman/listinfo/ipython-user}
9018 9870
9019 \end_inset
9871 \end_inset
9020 9872
9021 9873
9022 \layout Description
9874 \end_layout
9023 9875
9024 Developer's\SpecialChar ~
9876 \begin_layout Description
9877 Developer's\InsetSpace ~
9025 9878 list:
9026 9879 \begin_inset LatexCommand \htmlurl{http://scipy.net/mailman/listinfo/ipython-dev}
9027 9880
9028 \end_inset
9881 \end_inset
9029 9882
9030 9883
9031 \layout Standard
9884 \end_layout
9032 9885
9886 \begin_layout Standard
9033 9887 The IPython project is also very grateful to
9034 9888 \begin_inset Foot
9035 collapsed true
9036
9037 \layout Standard
9889 status collapsed
9038 9890
9891 \begin_layout Standard
9039 9892 I've mangled email addresses to reduce spam, since the IPython manuals can
9040 9893 be accessed online.
9041 \end_inset
9894 \end_layout
9895
9896 \end_inset
9042 9897
9043 9898 :
9044 \layout Standard
9899 \end_layout
9045 9900
9901 \begin_layout Standard
9046 9902 Bill Bumgarner
9047 \family typewriter
9903 \family typewriter
9048 9904 <bbum-AT-friday.com>
9049 \family default
9905 \family default
9050 9906 : for providing the DPyGetOpt module which gives very powerful and convenient
9051 9907 handling of command-line options (light years ahead of what Python 2.1.1's
9052 9908 getopt module does).
9053 \layout Standard
9909 \end_layout
9054 9910
9911 \begin_layout Standard
9055 9912 Ka-Ping Yee
9056 \family typewriter
9913 \family typewriter
9057 9914 <ping-AT-lfw.org>
9058 \family default
9915 \family default
9059 9916 : for providing the Itpl module for convenient and powerful string interpolation
9060 9917 with a much nicer syntax than formatting through the '%' operator.
9061 \layout Standard
9918 \end_layout
9062 9919
9920 \begin_layout Standard
9063 9921 Arnd Baecker
9064 \family typewriter
9922 \family typewriter
9065 9923 <baecker-AT-physik.tu-dresden.de>
9066 \family default
9924 \family default
9067 9925 : for his many very useful suggestions and comments, and lots of help with
9068 9926 testing and documentation checking.
9069 9927 Many of IPython's newer features are a result of discussions with him (bugs
9070 9928 are still my fault, not his).
9071 \layout Standard
9929 \end_layout
9072 9930
9073 Obviously Guido van\SpecialChar ~
9931 \begin_layout Standard
9932 Obviously Guido van\InsetSpace ~
9074 9933 Rossum and the whole Python development team, that goes
9075 9934 without saying.
9076 \layout Standard
9935 \end_layout
9077 9936
9937 \begin_layout Standard
9078 9938 IPython's website is generously hosted at
9079 9939 \begin_inset LatexCommand \htmlurl{http://ipython.scipy.org}
9080 9940
9081 \end_inset
9941 \end_inset
9082 9942
9083 9943 by Enthought (
9084 9944 \begin_inset LatexCommand \htmlurl{http://www.enthought.com}
9085 9945
9086 \end_inset
9946 \end_inset
9087 9947
9088 9948 ).
9089 9949 I am very grateful to them and all of the SciPy team for their contribution.
9090 \layout Standard
9091
9950 \end_layout
9092 9951
9952 \begin_layout Standard
9093 9953 \begin_inset LatexCommand \label{figgins}
9094 9954
9095 \end_inset
9955 \end_inset
9096 9956
9097 9957 Fernando would also like to thank Stephen Figgins
9098 \family typewriter
9958 \family typewriter
9099 9959 <fig-AT-monitor.net>
9100 \family default
9960 \family default
9101 9961 , an O'Reilly Python editor.
9102 9962 His Oct/11/2001 article about IPP and LazyPython, was what got this project
9103 9963 started.
9104 9964 You can read it at:
9105 9965 \begin_inset LatexCommand \htmlurl{http://www.onlamp.com/pub/a/python/2001/10/11/pythonnews.html}
9106 9966
9107 \end_inset
9967 \end_inset
9108 9968
9109 9969 .
9110 \layout Standard
9970 \end_layout
9111 9971
9972 \begin_layout Standard
9112 9973 And last but not least, all the kind IPython users who have emailed new
9113 9974 code, bug reports, fixes, comments and ideas.
9114 9975 A brief list follows, please let me know if I have ommitted your name by
9115 9976 accident:
9116 \layout List
9117 \labelwidthstring 00.00.0000
9977 \end_layout
9118 9978
9119 Jack\SpecialChar ~
9979 \begin_layout List
9980 \labelwidthstring 00.00.0000
9981 Jack\InsetSpace ~
9120 9982 Moffit
9121 \family typewriter
9983 \family typewriter
9122 9984 <jack-AT-xiph.org>
9123 \family default
9985 \family default
9124 9986 Bug fixes, including the infamous color problem.
9125 9987 This bug alone caused many lost hours and frustration, many thanks to him
9126 9988 for the fix.
9127 9989 I've always been a fan of Ogg & friends, now I have one more reason to
9128 9990 like these folks.
9129 \newline
9130 Jack is also contributing with Debian packaging and many other things.
9131 \layout List
9132 \labelwidthstring 00.00.0000
9991 \newline
9992 Jack is also contributing with Debian packaging and many
9993 other things.
9994 \end_layout
9133 9995
9134 Alexander\SpecialChar ~
9996 \begin_layout List
9997 \labelwidthstring 00.00.0000
9998 Alexander\InsetSpace ~
9135 9999 Schmolck
9136 \family typewriter
10000 \family typewriter
9137 10001 <a.schmolck-AT-gmx.net>
9138 \family default
10002 \family default
9139 10003 Emacs work, bug reports, bug fixes, ideas, lots more.
9140 10004 The ipython.el mode for (X)Emacs is Alex's code, providing full support
9141 10005 for IPython under (X)Emacs.
9142 \layout List
9143 \labelwidthstring 00.00.0000
10006 \end_layout
9144 10007
9145 Andrea\SpecialChar ~
10008 \begin_layout List
10009 \labelwidthstring 00.00.0000
10010 Andrea\InsetSpace ~
9146 10011 Riciputi
9147 \family typewriter
10012 \family typewriter
9148 10013 <andrea.riciputi-AT-libero.it>
9149 \family default
10014 \family default
9150 10015 Mac OSX information, Fink package management.
9151 \layout List
9152 \labelwidthstring 00.00.0000
10016 \end_layout
9153 10017
9154 Gary\SpecialChar ~
10018 \begin_layout List
10019 \labelwidthstring 00.00.0000
10020 Gary\InsetSpace ~
9155 10021 Bishop
9156 \family typewriter
10022 \family typewriter
9157 10023 <gb-AT-cs.unc.edu>
9158 \family default
10024 \family default
9159 10025 Bug reports, and patches to work around the exception handling idiosyncracies
9160 10026 of WxPython.
9161 10027 Readline and color support for Windows.
9162 \layout List
9163 \labelwidthstring 00.00.0000
10028 \end_layout
9164 10029
9165 Jeffrey\SpecialChar ~
10030 \begin_layout List
10031 \labelwidthstring 00.00.0000
10032 Jeffrey\InsetSpace ~
9166 10033 Collins
9167 \family typewriter
10034 \family typewriter
9168 10035 <Jeff.Collins-AT-vexcel.com>
9169 \family default
10036 \family default
9170 10037 Bug reports.
9171 10038 Much improved readline support, including fixes for Python 2.3.
9172 \layout List
9173 \labelwidthstring 00.00.0000
10039 \end_layout
9174 10040
9175 Dryice\SpecialChar ~
10041 \begin_layout List
10042 \labelwidthstring 00.00.0000
10043 Dryice\InsetSpace ~
9176 10044 Liu
9177 \family typewriter
10045 \family typewriter
9178 10046 <dryice-AT-liu.com.cn>
9179 \family default
10047 \family default
9180 10048 FreeBSD port.
9181 \layout List
9182 \labelwidthstring 00.00.0000
10049 \end_layout
9183 10050
9184 Mike\SpecialChar ~
10051 \begin_layout List
10052 \labelwidthstring 00.00.0000
10053 Mike\InsetSpace ~
9185 10054 Heeter
9186 \family typewriter
10055 \family typewriter
9187 10056 <korora-AT-SDF.LONESTAR.ORG>
9188 \layout List
9189 \labelwidthstring 00.00.0000
10057 \end_layout
9190 10058
9191 Christopher\SpecialChar ~
10059 \begin_layout List
10060 \labelwidthstring 00.00.0000
10061 Christopher\InsetSpace ~
9192 10062 Hart
9193 \family typewriter
10063 \family typewriter
9194 10064 <hart-AT-caltech.edu>
9195 \family default
10065 \family default
9196 10066 PDB integration.
9197 \layout List
9198 \labelwidthstring 00.00.0000
10067 \end_layout
9199 10068
9200 Milan\SpecialChar ~
10069 \begin_layout List
10070 \labelwidthstring 00.00.0000
10071 Milan\InsetSpace ~
9201 10072 Zamazal
9202 \family typewriter
10073 \family typewriter
9203 10074 <pdm-AT-zamazal.org>
9204 \family default
10075 \family default
9205 10076 Emacs info.
9206 \layout List
9207 \labelwidthstring 00.00.0000
10077 \end_layout
9208 10078
9209 Philip\SpecialChar ~
10079 \begin_layout List
10080 \labelwidthstring 00.00.0000
10081 Philip\InsetSpace ~
9210 10082 Hisley
9211 \family typewriter
10083 \family typewriter
9212 10084 <compsys-AT-starpower.net>
9213 \layout List
9214 \labelwidthstring 00.00.0000
10085 \end_layout
9215 10086
9216 Holger\SpecialChar ~
10087 \begin_layout List
10088 \labelwidthstring 00.00.0000
10089 Holger\InsetSpace ~
9217 10090 Krekel
9218 \family typewriter
10091 \family typewriter
9219 10092 <pyth-AT-devel.trillke.net>
9220 \family default
10093 \family default
9221 10094 Tab completion, lots more.
9222 \layout List
9223 \labelwidthstring 00.00.0000
10095 \end_layout
9224 10096
9225 Robin\SpecialChar ~
10097 \begin_layout List
10098 \labelwidthstring 00.00.0000
10099 Robin\InsetSpace ~
9226 10100 Siebler
9227 \family typewriter
10101 \family typewriter
9228 10102 <robinsiebler-AT-starband.net>
9229 \layout List
9230 \labelwidthstring 00.00.0000
10103 \end_layout
9231 10104
9232 Ralf\SpecialChar ~
10105 \begin_layout List
10106 \labelwidthstring 00.00.0000
10107 Ralf\InsetSpace ~
9233 10108 Ahlbrink
9234 \family typewriter
10109 \family typewriter
9235 10110 <ralf_ahlbrink-AT-web.de>
9236 \layout List
9237 \labelwidthstring 00.00.0000
10111 \end_layout
9238 10112
9239 Thorsten\SpecialChar ~
10113 \begin_layout List
10114 \labelwidthstring 00.00.0000
10115 Thorsten\InsetSpace ~
9240 10116 Kampe
9241 \family typewriter
10117 \family typewriter
9242 10118 <thorsten-AT-thorstenkampe.de>
9243 \layout List
9244 \labelwidthstring 00.00.0000
10119 \end_layout
9245 10120
9246 Fredrik\SpecialChar ~
10121 \begin_layout List
10122 \labelwidthstring 00.00.0000
10123 Fredrik\InsetSpace ~
9247 10124 Kant
9248 \family typewriter
10125 \family typewriter
9249 10126 <fredrik.kant-AT-front.com>
9250 \family default
10127 \family default
9251 10128 Windows setup.
9252 \layout List
9253 \labelwidthstring 00.00.0000
10129 \end_layout
9254 10130
9255 Syver\SpecialChar ~
10131 \begin_layout List
10132 \labelwidthstring 00.00.0000
10133 Syver\InsetSpace ~
9256 10134 Enstad
9257 \family typewriter
10135 \family typewriter
9258 10136 <syver-en-AT-online.no>
9259 \family default
10137 \family default
9260 10138 Windows setup.
9261 \layout List
9262 \labelwidthstring 00.00.0000
10139 \end_layout
9263 10140
10141 \begin_layout List
10142 \labelwidthstring 00.00.0000
9264 10143 Richard
9265 \family typewriter
10144 \family typewriter
9266 10145 <rxe-AT-renre-europe.com>
9267 \family default
10146 \family default
9268 10147 Global embedding.
9269 \layout List
9270 \labelwidthstring 00.00.0000
10148 \end_layout
9271 10149
9272 Hayden\SpecialChar ~
10150 \begin_layout List
10151 \labelwidthstring 00.00.0000
10152 Hayden\InsetSpace ~
9273 10153 Callow
9274 \family typewriter
10154 \family typewriter
9275 10155 <h.callow-AT-elec.canterbury.ac.nz>
9276 \family default
10156 \family default
9277 10157 Gnuplot.py 1.6 compatibility.
9278 \layout List
9279 \labelwidthstring 00.00.0000
10158 \end_layout
9280 10159
9281 Leonardo\SpecialChar ~
10160 \begin_layout List
10161 \labelwidthstring 00.00.0000
10162 Leonardo\InsetSpace ~
9282 10163 Santagada
9283 \family typewriter
10164 \family typewriter
9284 10165 <retype-AT-terra.com.br>
9285 \family default
10166 \family default
9286 10167 Fixes for Windows installation.
9287 \layout List
9288 \labelwidthstring 00.00.0000
10168 \end_layout
9289 10169
9290 Christopher\SpecialChar ~
10170 \begin_layout List
10171 \labelwidthstring 00.00.0000
10172 Christopher\InsetSpace ~
9291 10173 Armstrong
9292 \family typewriter
10174 \family typewriter
9293 10175 <radix-AT-twistedmatrix.com>
9294 \family default
10176 \family default
9295 10177 Bugfixes.
9296 \layout List
9297 \labelwidthstring 00.00.0000
10178 \end_layout
9298 10179
9299 Francois\SpecialChar ~
10180 \begin_layout List
10181 \labelwidthstring 00.00.0000
10182 Francois\InsetSpace ~
9300 10183 Pinard
9301 \family typewriter
10184 \family typewriter
9302 10185 <pinard-AT-iro.umontreal.ca>
9303 \family default
10186 \family default
9304 10187 Code and documentation fixes.
9305 \layout List
9306 \labelwidthstring 00.00.0000
10188 \end_layout
9307 10189
9308 Cory\SpecialChar ~
10190 \begin_layout List
10191 \labelwidthstring 00.00.0000
10192 Cory\InsetSpace ~
9309 10193 Dodt
9310 \family typewriter
10194 \family typewriter
9311 10195 <cdodt-AT-fcoe.k12.ca.us>
9312 \family default
10196 \family default
9313 10197 Bug reports and Windows ideas.
9314 10198 Patches for Windows installer.
9315 \layout List
9316 \labelwidthstring 00.00.0000
10199 \end_layout
9317 10200
9318 Olivier\SpecialChar ~
10201 \begin_layout List
10202 \labelwidthstring 00.00.0000
10203 Olivier\InsetSpace ~
9319 10204 Aubert
9320 \family typewriter
10205 \family typewriter
9321 10206 <oaubert-AT-bat710.univ-lyon1.fr>
9322 \family default
10207 \family default
9323 10208 New magics.
9324 \layout List
9325 \labelwidthstring 00.00.0000
10209 \end_layout
9326 10210
9327 King\SpecialChar ~
9328 C.\SpecialChar ~
10211 \begin_layout List
10212 \labelwidthstring 00.00.0000
10213 King\InsetSpace ~
10214 C.\InsetSpace ~
9329 10215 Shu
9330 \family typewriter
10216 \family typewriter
9331 10217 <kingshu-AT-myrealbox.com>
9332 \family default
10218 \family default
9333 10219 Autoindent patch.
9334 \layout List
9335 \labelwidthstring 00.00.0000
10220 \end_layout
9336 10221
9337 Chris\SpecialChar ~
10222 \begin_layout List
10223 \labelwidthstring 00.00.0000
10224 Chris\InsetSpace ~
9338 10225 Drexler
9339 \family typewriter
10226 \family typewriter
9340 10227 <chris-AT-ac-drexler.de>
9341 \family default
10228 \family default
9342 10229 Readline packages for Win32/CygWin.
9343 \layout List
9344 \labelwidthstring 00.00.0000
10230 \end_layout
9345 10231
9346 Gustavo\SpecialChar ~
9347 Cordova\SpecialChar ~
10232 \begin_layout List
10233 \labelwidthstring 00.00.0000
10234 Gustavo\InsetSpace ~
10235 Cordova\InsetSpace ~
9348 10236 Avila
9349 \family typewriter
10237 \family typewriter
9350 10238 <gcordova-AT-sismex.com>
9351 \family default
10239 \family default
9352 10240 EvalDict code for nice, lightweight string interpolation.
9353 \layout List
9354 \labelwidthstring 00.00.0000
10241 \end_layout
9355 10242
9356 Kasper\SpecialChar ~
10243 \begin_layout List
10244 \labelwidthstring 00.00.0000
10245 Kasper\InsetSpace ~
9357 10246 Souren
9358 \family typewriter
10247 \family typewriter
9359 10248 <Kasper.Souren-AT-ircam.fr>
9360 \family default
10249 \family default
9361 10250 Bug reports, ideas.
9362 \layout List
9363 \labelwidthstring 00.00.0000
10251 \end_layout
9364 10252
9365 Gever\SpecialChar ~
10253 \begin_layout List
10254 \labelwidthstring 00.00.0000
10255 Gever\InsetSpace ~
9366 10256 Tulley
9367 \family typewriter
10257 \family typewriter
9368 10258 <gever-AT-helium.com>
9369 \family default
10259 \family default
9370 10260 Code contributions.
9371 \layout List
9372 \labelwidthstring 00.00.0000
10261 \end_layout
9373 10262
9374 Ralf\SpecialChar ~
10263 \begin_layout List
10264 \labelwidthstring 00.00.0000
10265 Ralf\InsetSpace ~
9375 10266 Schmitt
9376 \family typewriter
10267 \family typewriter
9377 10268 <ralf-AT-brainbot.com>
9378 \family default
10269 \family default
9379 10270 Bug reports & fixes.
9380 \layout List
9381 \labelwidthstring 00.00.0000
10271 \end_layout
9382 10272
9383 Oliver\SpecialChar ~
10273 \begin_layout List
10274 \labelwidthstring 00.00.0000
10275 Oliver\InsetSpace ~
9384 10276 Sander
9385 \family typewriter
10277 \family typewriter
9386 10278 <osander-AT-gmx.de>
9387 \family default
10279 \family default
9388 10280 Bug reports.
9389 \layout List
9390 \labelwidthstring 00.00.0000
10281 \end_layout
9391 10282
9392 Rod\SpecialChar ~
10283 \begin_layout List
10284 \labelwidthstring 00.00.0000
10285 Rod\InsetSpace ~
9393 10286 Holland
9394 \family typewriter
10287 \family typewriter
9395 10288 <rhh-AT-structurelabs.com>
9396 \family default
10289 \family default
9397 10290 Bug reports and fixes to logging module.
9398 \layout List
9399 \labelwidthstring 00.00.0000
10291 \end_layout
9400 10292
9401 Daniel\SpecialChar ~
9402 'Dang'\SpecialChar ~
10293 \begin_layout List
10294 \labelwidthstring 00.00.0000
10295 Daniel\InsetSpace ~
10296 'Dang'\InsetSpace ~
9403 10297 Griffith
9404 \family typewriter
10298 \family typewriter
9405 10299 <pythondev-dang-AT-lazytwinacres.net>
9406 \family default
10300 \family default
9407 10301 Fixes, enhancement suggestions for system shell use.
9408 \layout List
9409 \labelwidthstring 00.00.0000
10302 \end_layout
9410 10303
9411 Viktor\SpecialChar ~
10304 \begin_layout List
10305 \labelwidthstring 00.00.0000
10306 Viktor\InsetSpace ~
9412 10307 Ransmayr
9413 \family typewriter
10308 \family typewriter
9414 10309 <viktor.ransmayr-AT-t-online.de>
9415 \family default
10310 \family default
9416 10311 Tests and reports on Windows installation issues.
9417 10312 Contributed a true Windows binary installer.
9418 \layout List
9419 \labelwidthstring 00.00.0000
10313 \end_layout
9420 10314
9421 Mike\SpecialChar ~
10315 \begin_layout List
10316 \labelwidthstring 00.00.0000
10317 Mike\InsetSpace ~
9422 10318 Salib
9423 \family typewriter
10319 \family typewriter
9424 10320 <msalib-AT-mit.edu>
9425 \family default
10321 \family default
9426 10322 Help fixing a subtle bug related to traceback printing.
9427 \layout List
9428 \labelwidthstring 00.00.0000
10323 \end_layout
9429 10324
9430 W.J.\SpecialChar ~
9431 van\SpecialChar ~
9432 der\SpecialChar ~
10325 \begin_layout List
10326 \labelwidthstring 00.00.0000
10327 W.J.\InsetSpace ~
10328 van\InsetSpace ~
10329 der\InsetSpace ~
9433 10330 Laan
9434 \family typewriter
10331 \family typewriter
9435 10332 <gnufnork-AT-hetdigitalegat.nl>
9436 \family default
10333 \family default
9437 10334 Bash-like prompt specials.
9438 \layout List
9439 \labelwidthstring 00.00.0000
10335 \end_layout
9440 10336
9441 Antoon\SpecialChar ~
10337 \begin_layout List
10338 \labelwidthstring 00.00.0000
10339 Antoon\InsetSpace ~
9442 10340 Pardon
9443 \family typewriter
10341 \family typewriter
9444 10342 <Antoon.Pardon-AT-rece.vub.ac.be>
9445 \family default
10343 \family default
9446 10344 Critical fix for the multithreaded IPython.
9447 \layout List
9448 \labelwidthstring 00.00.0000
10345 \end_layout
9449 10346
9450 John\SpecialChar ~
10347 \begin_layout List
10348 \labelwidthstring 00.00.0000
10349 John\InsetSpace ~
9451 10350 Hunter
9452 \family typewriter
10351 \family typewriter
9453 10352 <jdhunter-AT-nitace.bsd.uchicago.edu>
9454 \family default
10353 \family default
9455 10354 Matplotlib author, helped with all the development of support for matplotlib
9456 10355 in IPyhton, including making necessary changes to matplotlib itself.
9457 \layout List
9458 \labelwidthstring 00.00.0000
10356 \end_layout
9459 10357
9460 Matthew\SpecialChar ~
10358 \begin_layout List
10359 \labelwidthstring 00.00.0000
10360 Matthew\InsetSpace ~
9461 10361 Arnison
9462 \family typewriter
10362 \family typewriter
9463 10363 <maffew-AT-cat.org.au>
9464 \family default
10364 \family default
9465 10365 Bug reports, `
9466 \family typewriter
10366 \family typewriter
9467 10367 %run -d
9468 \family default
10368 \family default
9469 10369 ' idea.
9470 \layout List
9471 \labelwidthstring 00.00.0000
10370 \end_layout
9472 10371
9473 Prabhu\SpecialChar ~
10372 \begin_layout List
10373 \labelwidthstring 00.00.0000
10374 Prabhu\InsetSpace ~
9474 10375 Ramachandran
9475 \family typewriter
10376 \family typewriter
9476 10377 <prabhu_r-AT-users.sourceforge.net>
9477 \family default
10378 \family default
9478 10379 Help with (X)Emacs support, threading patches, ideas...
9479 \layout List
9480 \labelwidthstring 00.00.0000
10380 \end_layout
9481 10381
9482 Norbert\SpecialChar ~
10382 \begin_layout List
10383 \labelwidthstring 00.00.0000
10384 Norbert\InsetSpace ~
9483 10385 Tretkowski
9484 \family typewriter
10386 \family typewriter
9485 10387 <tretkowski-AT-inittab.de>
9486 \family default
10388 \family default
9487 10389 help with Debian packaging and distribution.
9488 \layout List
9489 \labelwidthstring 00.00.0000
10390 \end_layout
9490 10391
9491 George\SpecialChar ~
10392 \begin_layout List
10393 \labelwidthstring 00.00.0000
10394 George\InsetSpace ~
9492 10395 Sakkis <
9493 \family typewriter
10396 \family typewriter
9494 10397 gsakkis-AT-eden.rutgers.edu>
9495 \family default
10398 \family default
9496 10399 New matcher for tab-completing named arguments of user-defined functions.
9497 \layout List
9498 \labelwidthstring 00.00.0000
10400 \end_layout
9499 10401
9500 JοΏ½rgen\SpecialChar ~
10402 \begin_layout List
10403 \labelwidthstring 00.00.0000
10404 JοΏ½rgen\InsetSpace ~
9501 10405 Stenarson
9502 \family typewriter
10406 \family typewriter
9503 10407 <jorgen.stenarson-AT-bostream.nu>
9504 \family default
10408 \family default
9505 10409 Wildcard support implementation for searching namespaces.
9506 \layout List
9507 \labelwidthstring 00.00.0000
10410 \end_layout
9508 10411
9509 Vivian\SpecialChar ~
9510 De\SpecialChar ~
10412 \begin_layout List
10413 \labelwidthstring 00.00.0000
10414 Vivian\InsetSpace ~
10415 De\InsetSpace ~
9511 10416 Smedt
9512 \family typewriter
10417 \family typewriter
9513 10418 <vivian-AT-vdesmedt.com>
9514 \family default
10419 \family default
9515 10420 Debugger enhancements, so that when pdb is activated from within IPython,
9516 10421 coloring, tab completion and other features continue to work seamlessly.
9517 \layout List
9518 \labelwidthstring 00.00.0000
10422 \end_layout
9519 10423
9520 Scott\SpecialChar ~
10424 \begin_layout List
10425 \labelwidthstring 00.00.0000
10426 Scott\InsetSpace ~
9521 10427 Tsai
9522 \family typewriter
10428 \family typewriter
9523 10429 <scottt958-AT-yahoo.com.tw>
9524 \family default
10430 \family default
9525 10431 Support for automatic editor invocation on syntax errors (see
9526 10432 \begin_inset LatexCommand \htmlurl{http://www.scipy.net/roundup/ipython/issue36}
9527 10433
9528 \end_inset
10434 \end_inset
9529 10435
9530 10436 ).
9531 \layout List
9532 \labelwidthstring 00.00.0000
10437 \end_layout
9533 10438
9534 Alexander\SpecialChar ~
10439 \begin_layout List
10440 \labelwidthstring 00.00.0000
10441 Alexander\InsetSpace ~
9535 10442 Belchenko
9536 \family typewriter
10443 \family typewriter
9537 10444 <bialix-AT-ukr.net>
9538 \family default
10445 \family default
9539 10446 Improvements for win32 paging system.
9540 \layout List
9541 \labelwidthstring 00.00.0000
10447 \end_layout
9542 10448
9543 Will\SpecialChar ~
10449 \begin_layout List
10450 \labelwidthstring 00.00.0000
10451 Will\InsetSpace ~
9544 10452 Maier
9545 \family typewriter
10453 \family typewriter
9546 10454 <willmaier-AT-ml1.net>
9547 \family default
10455 \family default
9548 10456 Official OpenBSD port.
9549 \the_end
10457 \end_layout
10458
10459 \end_body
10460 \end_document
@@ -1,130 +1,135 b''
1 1 #!python
2 2 """Windows-specific part of the installation"""
3 3
4 4 import os, sys
5 5
6 6 try:
7 7 import shutil,pythoncom
8 8 from win32com.shell import shell
9 9 import _winreg as wreg
10 10 except ImportError:
11 11 print """
12 12 You seem to be missing the PythonWin extensions necessary for automatic
13 13 installation. You can get them (free) from
14 14 http://starship.python.net/crew/mhammond/
15 15
16 16 Please see the manual for details if you want to finish the installation by
17 17 hand, or get PythonWin and repeat the procedure.
18 18
19 19 Press <Enter> to exit this installer."""
20 20 raw_input()
21 21 sys.exit()
22 22
23 23
24 24 def make_shortcut(fname,target,args='',start_in='',comment='',icon=None):
25 25 """Make a Windows shortcut (.lnk) file.
26 26
27 27 make_shortcut(fname,target,args='',start_in='',comment='',icon=None)
28 28
29 29 Arguments:
30 30 fname - name of the final shortcut file (include the .lnk)
31 31 target - what the shortcut will point to
32 32 args - additional arguments to pass to the target program
33 33 start_in - directory where the target command will be called
34 34 comment - for the popup tooltips
35 35 icon - optional icon file. This must be a tuple of the type
36 36 (icon_file,index), where index is the index of the icon you want
37 37 in the file. For single .ico files, index=0, but for icon libraries
38 38 contained in a single file it can be >0.
39 39 """
40 40
41 41 shortcut = pythoncom.CoCreateInstance(
42 42 shell.CLSID_ShellLink, None,
43 43 pythoncom.CLSCTX_INPROC_SERVER, shell.IID_IShellLink
44 44 )
45 45 shortcut.SetPath(target)
46 46 shortcut.SetArguments(args)
47 47 shortcut.SetWorkingDirectory(start_in)
48 48 shortcut.SetDescription(comment)
49 49 if icon:
50 50 shortcut.SetIconLocation(*icon)
51 51 shortcut.QueryInterface(pythoncom.IID_IPersistFile).Save(fname,0)
52 52
53 53
54 54 def run(wait=0):
55 55 # Find where the Start Menu and My Documents are on the filesystem
56 56 key = wreg.OpenKey(wreg.HKEY_CURRENT_USER,
57 57 r'Software\Microsoft\Windows\CurrentVersion'
58 58 r'\Explorer\Shell Folders')
59 59
60 60 programs_dir = wreg.QueryValueEx(key,'Programs')[0]
61 61 my_documents_dir = wreg.QueryValueEx(key,'Personal')[0]
62 62 key.Close()
63 63
64 64 # Find where the 'program files' directory is
65 65 key = wreg.OpenKey(wreg.HKEY_LOCAL_MACHINE,
66 66 r'SOFTWARE\Microsoft\Windows\CurrentVersion')
67 67
68 68 program_files_dir = wreg.QueryValueEx(key,'ProgramFilesDir')[0]
69 69 key.Close()
70 70
71 71
72 72 # File and directory names
73 73 ip_dir = program_files_dir + '\\IPython'
74 74 ip_prog_dir = programs_dir + '\\IPython'
75 75 doc_dir = ip_dir+'\\doc'
76 76 ip_filename = ip_dir+'\\IPython_shell.py'
77 77 pycon_icon = doc_dir+'\\pycon.ico'
78 78
79 79 if not os.path.isdir(ip_dir):
80 80 os.mkdir(ip_dir)
81 81
82 82 # Copy startup script and documentation
83 83 shutil.copy(sys.prefix+'\\Scripts\\ipython',ip_filename)
84 84 if os.path.isdir(doc_dir):
85 85 shutil.rmtree(doc_dir)
86 86 shutil.copytree('doc',doc_dir)
87 87
88 88 # make shortcuts for IPython, html and pdf docs.
89 89 print 'Making entries for IPython in Start Menu...',
90 90
91 # Create .bat file in \\Scripts
92 fic = open(sys.prefix + '\\Scripts\\ipython.bat','w')
93 fic.write('"' + sys.prefix + '\\python.exe' + '" -i ' + '"' + sys.prefix + '\\Scripts\ipython" %*')
94 fic.close()
95
91 96 # Create shortcuts in Programs\IPython:
92 97 if not os.path.isdir(ip_prog_dir):
93 98 os.mkdir(ip_prog_dir)
94 99 os.chdir(ip_prog_dir)
95 100
96 101 man_pdf = doc_dir + '\\manual.pdf'
97 102 man_htm = doc_dir + '\\manual\\manual.html'
98 103
99 104 make_shortcut('IPython.lnk',sys.executable, '"%s"' % ip_filename,
100 105 my_documents_dir,
101 106 'IPython - Enhanced python command line interpreter',
102 107 (pycon_icon,0))
103 108 make_shortcut('pysh.lnk',sys.executable, '"%s" -p pysh' % ip_filename,
104 109 my_documents_dir,
105 110 'pysh - a system shell with Python syntax (IPython based)',
106 111 (pycon_icon,0))
107 112 make_shortcut('Manual in HTML format.lnk',man_htm,'','',
108 113 'IPython Manual - HTML format')
109 114 make_shortcut('Manual in PDF format.lnk',man_pdf,'','',
110 115 'IPython Manual - PDF format')
111 116
112 117 print """Done.
113 118
114 119 I created the directory %s. There you will find the
115 120 IPython startup script and manuals.
116 121
117 122 An IPython menu was also created in your Start Menu, with entries for
118 123 IPython itself and the manual in HTML and PDF formats.
119 124
120 125 For reading PDF documents you need the freely available Adobe Acrobat
121 126 Reader. If you don't have it, you can download it from:
122 127 http://www.adobe.com/products/acrobat/readstep2.html
123 128 """ % ip_dir
124 129
125 130 if wait:
126 131 print "Finished with IPython installation. Press Enter to exit this installer.",
127 132 raw_input()
128 133
129 134 if __name__ == '__main__':
130 135 run()
General Comments 0
You need to be logged in to leave comments. Login now