##// END OF EJS Templates
Initial conversion of history to SQLite database.
Thomas Kluyver -
Show More
@@ -1,601 +1,511 b''
1 """ History related magics and functionality """
1 """ History related magics and functionality """
2 #-----------------------------------------------------------------------------
2 #-----------------------------------------------------------------------------
3 # Copyright (C) 2010 The IPython Development Team.
3 # Copyright (C) 2010 The IPython Development Team.
4 #
4 #
5 # Distributed under the terms of the BSD License.
5 # Distributed under the terms of the BSD License.
6 #
6 #
7 # The full license is in the file COPYING.txt, distributed with this software.
7 # The full license is in the file COPYING.txt, distributed with this software.
8 #-----------------------------------------------------------------------------
8 #-----------------------------------------------------------------------------
9
9
10 #-----------------------------------------------------------------------------
10 #-----------------------------------------------------------------------------
11 # Imports
11 # Imports
12 #-----------------------------------------------------------------------------
12 #-----------------------------------------------------------------------------
13 from __future__ import print_function
13 from __future__ import print_function
14
14
15 # Stdlib imports
15 # Stdlib imports
16 import atexit
17 import fnmatch
18 import json
19 import os
16 import os
20 import sys
17 import sqlite3
21 import threading
22 import time
23
18
24 # Our own packages
19 # Our own packages
25 import IPython.utils.io
20 import IPython.utils.io
26
21
27 from IPython.testing import decorators as testdec
22 from IPython.testing import decorators as testdec
28 from IPython.utils.pickleshare import PickleShareDB
23 from IPython.utils.pickleshare import PickleShareDB
29 from IPython.utils.io import ask_yes_no
24 from IPython.utils.io import ask_yes_no
30 from IPython.utils.warn import warn
25 from IPython.utils.warn import warn
31
26
32 #-----------------------------------------------------------------------------
27 #-----------------------------------------------------------------------------
33 # Classes and functions
28 # Classes and functions
34 #-----------------------------------------------------------------------------
29 #-----------------------------------------------------------------------------
35
30
36 class HistoryManager(object):
31 class HistoryManager(object):
37 """A class to organize all history-related functionality in one place.
32 """A class to organize all history-related functionality in one place.
38 """
33 """
39 # Public interface
34 # Public interface
40
35
41 # An instance of the IPython shell we are attached to
36 # An instance of the IPython shell we are attached to
42 shell = None
37 shell = None
43 # A list to hold processed history
38 # A list to hold processed history
44 input_hist_parsed = None
39 input_hist_parsed = None
45 # A list to hold raw history (as typed by user)
40 # A list to hold raw history (as typed by user)
46 input_hist_raw = None
41 input_hist_raw = None
47 # A list of directories visited during session
42 # A list of directories visited during session
48 dir_hist = None
43 dir_hist = None
49 # A dict of output history, keyed with ints from the shell's execution count
44 # A dict of output history, keyed with ints from the shell's execution count
50 output_hist = None
45 output_hist = None
51 # String with path to the history file
46 # String with path to the history file
52 hist_file = None
47 hist_file = None
53 # PickleShareDB instance holding the raw data for the shadow history
48 # The SQLite database
54 shadow_db = None
49 db = None
55 # ShadowHist instance with the actual shadow history
50 # The number of the current session in the history database
56 shadow_hist = None
51 session_number = None
57
58 # Offset so the first line of the current session is #1. Can be
59 # updated after loading history from file.
60 session_offset = -1
61
52
62 # Private interface
53 # Private interface
63 # Variables used to store the three last inputs from the user. On each new
54 # Variables used to store the three last inputs from the user. On each new
64 # history update, we populate the user's namespace with these, shifted as
55 # history update, we populate the user's namespace with these, shifted as
65 # necessary.
56 # necessary.
66 _i00, _i, _ii, _iii = '','','',''
57 _i00, _i, _ii, _iii = '','','',''
67
58
68 # A set with all forms of the exit command, so that we don't store them in
59 # A set with all forms of the exit command, so that we don't store them in
69 # the history (it's annoying to rewind the first entry and land on an exit
60 # the history (it's annoying to rewind the first entry and land on an exit
70 # call).
61 # call).
71 _exit_commands = None
62 _exit_commands = None
72
63
73 def __init__(self, shell, load_history=False):
64 def __init__(self, shell, load_history=False):
74 """Create a new history manager associated with a shell instance.
65 """Create a new history manager associated with a shell instance.
75
66
76 Parameters
67 Parameters
77 ----------
68 ----------
78 load_history: bool, optional
69 load_history: bool, optional
79 If True, history will be loaded from file, and the session
70 If True, history will be loaded from file, and the session
80 offset set, so that the next line entered can be retrieved
71 offset set, so that the next line entered can be retrieved
81 as #1.
72 as #1.
82 """
73 """
83 # We need a pointer back to the shell for various tasks.
74 # We need a pointer back to the shell for various tasks.
84 self.shell = shell
75 self.shell = shell
85
76
86 # List of input with multi-line handling.
77 # List of input with multi-line handling. One blank entry so indexing
87 self.input_hist_parsed = []
78 # starts from 1.
79 self.input_hist_parsed = [""]
88 # This one will hold the 'raw' input history, without any
80 # This one will hold the 'raw' input history, without any
89 # pre-processing. This will allow users to retrieve the input just as
81 # pre-processing. This will allow users to retrieve the input just as
90 # it was exactly typed in by the user, with %hist -r.
82 # it was exactly typed in by the user, with %hist -r.
91 self.input_hist_raw = []
83 self.input_hist_raw = [""]
92
84
93 # list of visited directories
85 # list of visited directories
94 try:
86 try:
95 self.dir_hist = [os.getcwd()]
87 self.dir_hist = [os.getcwd()]
96 except OSError:
88 except OSError:
97 self.dir_hist = []
89 self.dir_hist = []
98
90
99 # dict of output history
91 # dict of output history
100 self.output_hist = {}
92 self.output_hist = {}
101
93
102 # Now the history file
94 # Now the history file
103 if shell.profile:
95 if shell.profile:
104 histfname = 'history-%s' % shell.profile
96 histfname = 'history-%s' % shell.profile
105 else:
97 else:
106 histfname = 'history'
98 histfname = 'history'
107 self.hist_file = os.path.join(shell.ipython_dir, histfname + '.json')
99 self.hist_file = os.path.join(shell.ipython_dir, histfname + '.sqlite')
108
109 # Objects related to shadow history management
110 self._init_shadow_hist()
111
100
112 self._i00, self._i, self._ii, self._iii = '','','',''
101 self._i00, self._i, self._ii, self._iii = '','','',''
113
102
114 self._exit_commands = set(['Quit', 'quit', 'Exit', 'exit', '%Quit',
103 self._exit_commands = set(['Quit', 'quit', 'Exit', 'exit', '%Quit',
115 '%quit', '%Exit', '%exit'])
104 '%quit', '%Exit', '%exit'])
116
105
117 # Object is fully initialized, we can now call methods on it.
106 self.init_db()
118
107
119 if load_history:
108 def init_db(self):
120 self.reload_history()
109 self.db = sqlite3.connect(self.hist_file)
121 self.session_offset = len(self.input_hist_raw) -1
110 self.db.execute("""CREATE TABLE IF NOT EXISTS history (session integer,
111 line integer, source text, source_raw text,
112 PRIMARY KEY (session, line))""")
113 cur = self.db.execute("""SELECT name FROM sqlite_master WHERE
114 type='table' AND name='singletons'""")
115 if not cur.fetchone():
116 self.db.execute("""CREATE TABLE singletons
117 (name text PRIMARY KEY, value)""")
118 self.db.execute("""INSERT INTO singletons VALUES
119 ('session_number', 1)""")
120 self.db.commit()
121 cur = self.db.execute("""SELECT value FROM singletons WHERE
122 name='session_number'""")
123 self.session_number = cur.fetchone()[0]
122
124
123 # Create and start the autosaver.
125 #Increment by one for next session.
124 self.autosave_flag = threading.Event()
126 self.db.execute("""UPDATE singletons SET value=? WHERE
125 self.autosave_timer = HistorySaveThread(self.autosave_flag, 60)
127 name='session_number'""", (self.session_number+1,))
126 self.autosave_timer.start()
128 self.db.commit()
127 # Register the autosave handler to be triggered as a post execute
129
128 # callback.
130 def get_db_history(self, session, start=1, stop=None, raw=True):
129 self.shell.register_post_execute(self.autosave_if_due)
131 """Retrieve input history from the database by session.
130
132
131
133 Parameters
132 def _init_shadow_hist(self):
134 ----------
133 try:
135 session : int
134 self.shadow_db = PickleShareDB(os.path.join(
136 Session number to retrieve. If negative, counts back from current
135 self.shell.ipython_dir, 'db'))
137 session (so -1 is previous session).
136 except UnicodeDecodeError:
138 start : int
137 print("Your ipython_dir can't be decoded to unicode!")
139 First line to retrieve.
138 print("Please set HOME environment variable to something that")
140 stop : int
139 print(r"only has ASCII characters, e.g. c:\home")
141 Last line to retrieve. If None, retrieve to the end of the session.
140 print("Now it is", self.ipython_dir)
142 raw : bool
141 sys.exit()
143 If True, return raw input
142 self.shadow_hist = ShadowHist(self.shadow_db, self.shell)
144
145 Returns
146 -------
147 An iterator over the desired lines.
148 """
149 toget = 'source_raw' if raw else 'source'
150 if session < 0:
151 session += self.session_number
143
152
144 def populate_readline_history(self):
153 if stop:
145 """Populate the readline history from the raw history.
154 cur = self.db.execute("SELECT " + toget + """ FROM history WHERE
146
155 session==? AND line BETWEEN ? and ?""",
147 We only store one copy of the raw history, which is persisted to a json
156 (session, start, stop))
148 file on disk. The readline history is repopulated from the contents of
149 this file."""
150
151 try:
152 self.shell.readline.clear_history()
153 except AttributeError:
154 pass
155 else:
157 else:
156 for h in self.input_hist_raw:
158 cur = self.db.execute("SELECT " + toget + """ FROM history WHERE
157 if not h.isspace():
159 session==? AND line>=?""", (session, start))
158 for line in h.splitlines():
160 return (x[0] for x in cur)
159 self.shell.readline.add_history(line)
161
160
162 def tail_db_history(self, n=10, raw=True):
161 def save_history(self):
163 """Get the last n lines from the history database."""
162 """Save input history to a file (via readline library)."""
164 toget = 'source_raw' if raw else 'source'
163 hist = dict(raw=self.input_hist_raw, #[-self.shell.history_length:],
165 cur = self.db.execute("SELECT " + toget + """ FROM history ORDER BY
164 parsed=self.input_hist_parsed) #[-self.shell.history_length:])
166 session DESC, line DESC LIMIT ?""", (n,))
165 with open(self.hist_file,'wt') as hfile:
167 return (x[0] for x in reversed(cur.fetchall()))
166 json.dump(hist, hfile,
167 sort_keys=True, indent=4)
168
169 def autosave_if_due(self):
170 """Check if the autosave event is set; if so, save history. We do it
171 this way so that the save takes place in the main thread."""
172 if self.autosave_flag.is_set():
173 self.save_history()
174 self.autosave_flag.clear()
175
168
176 def reload_history(self):
169 def globsearch_db(self, pattern="*"):
177 """Reload the input history from disk file."""
170 """Search the database using unix glob-style matching (wildcards * and
178
171 ?, escape using \).
179 with open(self.hist_file,'rt') as hfile:
172
180 try:
173 Returns
181 hist = json.load(hfile)
174 -------
182 except ValueError: # Ignore it if JSON is corrupt.
175 An iterator over tuples: (session, line_number, command)
183 return
176 """
184 self.input_hist_parsed = hist['parsed']
177 return self.db.execute("""SELECT session, line, source_raw FROM history
185 self.input_hist_raw = hist['raw']
178 WHERE source_raw GLOB ?""", (pattern,))
186 if self.shell.has_readline:
187 self.populate_readline_history()
188
179
189 def get_history(self, index=None, raw=False, output=True,this_session=True):
180 def get_history(self, start=1, stop=None, raw=False, output=True):
190 """Get the history list.
181 """Get the history list.
191
182
192 Get the input and output history.
183 Get the input and output history.
193
184
194 Parameters
185 Parameters
195 ----------
186 ----------
196 index : n or (n1, n2) or None
187 start : int
197 If n, then the last n entries. If a tuple, then all in
188 From (prompt number in the current session). Negative numbers count
198 range(n1, n2). If None, then all entries. Raises IndexError if
189 back from the end.
199 the format of index is incorrect.
190 stop : int
191 To (prompt number in the current session, exclusive). Negative
192 numbers count back from the end, and None goes to the end.
200 raw : bool
193 raw : bool
201 If True, return the raw input.
194 If True, return the raw input.
202 output : bool
195 output : bool
203 If True, then return the output as well.
196 If True, then return the output as well.
204 this_session : bool
197 this_session : bool
205 If True, indexing is from 1 at the start of this session.
198 If True, indexing is from 1 at the start of this session.
206 If False, indexing is from 1 at the start of the whole history.
199 If False, indexing is from 1 at the start of the whole history.
207
200
208 Returns
201 Returns
209 -------
202 -------
210 If output is True, then return a dict of tuples, keyed by the prompt
203 If output is True, then return a dict of tuples, keyed by the prompt
211 numbers and with values of (input, output). If output is False, then
204 numbers and with values of (input, output). If output is False, then
212 a dict, keyed by the prompt number with the values of input.
205 a dict, keyed by the prompt number with the values of input.
213 """
206 """
214 if raw:
207 if raw:
215 input_hist = self.input_hist_raw
208 input_hist = self.input_hist_raw
216 else:
209 else:
217 input_hist = self.input_hist_parsed
210 input_hist = self.input_hist_parsed
218 if output:
211 if output:
219 output_hist = self.output_hist
212 output_hist = self.output_hist
220
221 if this_session:
222 offset = self.session_offset
223 else:
224 offset = -1
225
213
226 n = len(input_hist)
214 n = len(input_hist)
227 if index is None:
215 if start < 0:
228 start=offset+1; stop=n
216 start += n
229 elif isinstance(index, int):
217 if not stop:
230 start=n-index; stop=n
218 stop = n
231 elif len(index) == 2:
219 elif stop < 0:
232 start = index[0] + offset
220 stop += n
233 stop = index[1] + offset
221
234 else:
235 raise IndexError('Not a valid index for the input history: %r'
236 % index)
237 hist = {}
222 hist = {}
238 for i in range(start, stop):
223 for i in range(start, stop):
239 if output:
224 if output:
240 hist[i-offset] = (input_hist[i], output_hist.get(i-offset))
225 hist[i] = (input_hist[i], output_hist.get(i))
241 else:
226 else:
242 hist[i-offset] = input_hist[i]
227 hist[i] = input_hist[i]
243 return hist
228 return hist
244
229
245 def store_inputs(self, source, source_raw=None):
230 def store_inputs(self, source, source_raw=None):
246 """Store source and raw input in history and create input cache
231 """Store source and raw input in history and create input cache
247 variables _i*.
232 variables _i*.
248
233
249 Parameters
234 Parameters
250 ----------
235 ----------
251 source : str
236 source : str
252 Python input.
237 Python input.
253
238
254 source_raw : str, optional
239 source_raw : str, optional
255 If given, this is the raw input without any IPython transformations
240 If given, this is the raw input without any IPython transformations
256 applied to it. If not given, ``source`` is used.
241 applied to it. If not given, ``source`` is used.
257 """
242 """
258 if source_raw is None:
243 if source_raw is None:
259 source_raw = source
244 source_raw = source
260
245
261 # do not store exit/quit commands
246 # do not store exit/quit commands
262 if source_raw.strip() in self._exit_commands:
247 if source_raw.strip() in self._exit_commands:
263 return
248 return
264
249
265 self.input_hist_parsed.append(source.rstrip())
250 self.input_hist_parsed.append(source.rstrip())
266 self.input_hist_raw.append(source_raw.rstrip())
251 self.input_hist_raw.append(source_raw.rstrip())
267 self.shadow_hist.add(source)
252 with self.db:
253 self.db.execute("INSERT INTO history VALUES (?, ?, ?, ?)",
254 (self.session_number, self.shell.execution_count,
255 source, source_raw))
268
256
269 # update the auto _i variables
257 # update the auto _i variables
270 self._iii = self._ii
258 self._iii = self._ii
271 self._ii = self._i
259 self._ii = self._i
272 self._i = self._i00
260 self._i = self._i00
273 self._i00 = source_raw
261 self._i00 = source_raw
274
262
275 # hackish access to user namespace to create _i1,_i2... dynamically
263 # hackish access to user namespace to create _i1,_i2... dynamically
276 new_i = '_i%s' % self.shell.execution_count
264 new_i = '_i%s' % self.shell.execution_count
277 to_main = {'_i': self._i,
265 to_main = {'_i': self._i,
278 '_ii': self._ii,
266 '_ii': self._ii,
279 '_iii': self._iii,
267 '_iii': self._iii,
280 new_i : self._i00 }
268 new_i : self._i00 }
281 self.shell.user_ns.update(to_main)
269 self.shell.user_ns.update(to_main)
282
270
283 def sync_inputs(self):
271 def sync_inputs(self):
284 """Ensure raw and translated histories have same length."""
272 """Ensure raw and translated histories have same length."""
285 if len(self.input_hist_parsed) != len (self.input_hist_raw):
273 lr = len(self.input_hist_raw)
286 self.input_hist_raw[:] = self.input_hist_parsed
274 lp = len(self.input_hist_parsed)
275 if lp < lr:
276 self.input_hist_raw[:lr-lp] = []
277 elif lr < lp:
278 self.input_hist_parsed[:lp-lr] = []
287
279
288 def reset(self):
280 def reset(self):
289 """Clear all histories managed by this object."""
281 """Clear all histories managed by this object."""
290 self.input_hist_parsed[:] = []
282 self.input_hist_parsed[:] = []
291 self.input_hist_raw[:] = []
283 self.input_hist_raw[:] = []
292 self.output_hist.clear()
284 self.output_hist.clear()
293 # The directory history can't be completely empty
285 # The directory history can't be completely empty
294 self.dir_hist[:] = [os.getcwd()]
286 self.dir_hist[:] = [os.getcwd()]
295 # Reset session offset to -1, so next command counts as #1
296 self.session_offset = -1
297
298 class HistorySaveThread(threading.Thread):
299 """This thread makes IPython save history periodically.
300
301 Without this class, IPython would only save the history on a clean exit.
302 This saves the history periodically (the current default is once per
303 minute), so that it is not lost in the event of a crash.
304
305 The implementation sets an event to indicate that history should be saved.
306 The actual save is carried out after executing a user command, to avoid
307 thread issues.
308 """
309 daemon = True
310
311 def __init__(self, autosave_flag, time_interval=60):
312 threading.Thread.__init__(self)
313 self.time_interval = time_interval
314 self.autosave_flag = autosave_flag
315 self.exit_now = threading.Event()
316 # Ensure the thread is stopped tidily when exiting normally
317 atexit.register(self.stop)
318
319 def run(self):
320 while True:
321 self.exit_now.wait(self.time_interval)
322 if self.exit_now.is_set():
323 break
324 self.autosave_flag.set()
325
326 def stop(self):
327 """Safely and quickly stop the autosave timer thread."""
328 self.exit_now.set()
329 self.join()
330
287
331 @testdec.skip_doctest
288 @testdec.skip_doctest
332 def magic_history(self, parameter_s = ''):
289 def magic_history(self, parameter_s = ''):
333 """Print input history (_i<n> variables), with most recent last.
290 """Print input history (_i<n> variables), with most recent last.
334
291
335 %history -> print at most 40 inputs (some may be multi-line)\\
292 %history -> print at most 40 inputs (some may be multi-line)\\
336 %history n -> print at most n inputs\\
293 %history n -> print at most n inputs\\
337 %history n1 n2 -> print inputs between n1 and n2 (n2 not included)\\
294 %history n1 n2 -> print inputs between n1 and n2 (n2 not included)\\
338
295
339 By default, input history is printed without line numbers so it can be
296 By default, input history is printed without line numbers so it can be
340 directly pasted into an editor.
297 directly pasted into an editor.
341
298
342 With -n, each input's number <n> is shown, and is accessible as the
299 With -n, each input's number <n> is shown, and is accessible as the
343 automatically generated variable _i<n> as well as In[<n>]. Multi-line
300 automatically generated variable _i<n> as well as In[<n>]. Multi-line
344 statements are printed starting at a new line for easy copy/paste.
301 statements are printed starting at a new line for easy copy/paste.
345
302
346 Options:
303 Options:
347
304
348 -n: print line numbers for each input.
305 -n: print line numbers for each input.
349 This feature is only available if numbered prompts are in use.
306 This feature is only available if numbered prompts are in use.
350
307
351 -o: also print outputs for each input.
308 -o: also print outputs for each input.
352
309
353 -p: print classic '>>>' python prompts before each input. This is useful
310 -p: print classic '>>>' python prompts before each input. This is useful
354 for making documentation, and in conjunction with -o, for producing
311 for making documentation, and in conjunction with -o, for producing
355 doctest-ready output.
312 doctest-ready output.
356
313
357 -r: (default) print the 'raw' history, i.e. the actual commands you typed.
314 -r: (default) print the 'raw' history, i.e. the actual commands you typed.
358
315
359 -t: print the 'translated' history, as IPython understands it. IPython
316 -t: print the 'translated' history, as IPython understands it. IPython
360 filters your input and converts it all into valid Python source before
317 filters your input and converts it all into valid Python source before
361 executing it (things like magics or aliases are turned into function
318 executing it (things like magics or aliases are turned into function
362 calls, for example). With this option, you'll see the native history
319 calls, for example). With this option, you'll see the native history
363 instead of the user-entered version: '%cd /' will be seen as
320 instead of the user-entered version: '%cd /' will be seen as
364 'get_ipython().magic("%cd /")' instead of '%cd /'.
321 'get_ipython().magic("%cd /")' instead of '%cd /'.
365
322
366 -g: treat the arg as a pattern to grep for in (full) history.
323 -g: treat the arg as a pattern to grep for in (full) history.
367 This includes the "shadow history" (almost all commands ever written).
324 This includes the saved history (almost all commands ever written).
368 Use '%hist -g' to show full shadow history (may be very long).
325 Use '%hist -g' to show full saved history (may be very long).
369 In shadow history, every index nuwber starts with 0.
370
326
371 -f FILENAME: instead of printing the output to the screen, redirect it to
327 -f FILENAME: instead of printing the output to the screen, redirect it to
372 the given file. The file is always overwritten, though IPython asks for
328 the given file. The file is always overwritten, though IPython asks for
373 confirmation first if it already exists.
329 confirmation first if it already exists.
374
330
375 Examples
331 Examples
376 --------
332 --------
377 ::
333 ::
378
334
379 In [6]: %hist -n 4 6
335 In [6]: %hist -n 4 6
380 4:a = 12
336 4:a = 12
381 5:print a**2
337 5:print a**2
382
338
383 """
339 """
384
340
385 if not self.shell.displayhook.do_full_cache:
341 if not self.shell.displayhook.do_full_cache:
386 print('This feature is only available if numbered prompts are in use.')
342 print('This feature is only available if numbered prompts are in use.')
387 return
343 return
388 opts,args = self.parse_options(parameter_s,'gnoptsrf:',mode='list')
344 opts,args = self.parse_options(parameter_s,'gnoptsrf:',mode='list')
389
345
390 # For brevity
346 # For brevity
391 history_manager = self.shell.history_manager
347 history_manager = self.shell.history_manager
392
348
393 # Check if output to specific file was requested.
349 # Check if output to specific file was requested.
394 try:
350 try:
395 outfname = opts['f']
351 outfname = opts['f']
396 except KeyError:
352 except KeyError:
397 outfile = IPython.utils.io.Term.cout # default
353 outfile = IPython.utils.io.Term.cout # default
398 # We don't want to close stdout at the end!
354 # We don't want to close stdout at the end!
399 close_at_end = False
355 close_at_end = False
400 else:
356 else:
401 if os.path.exists(outfname):
357 if os.path.exists(outfname):
402 if not ask_yes_no("File %r exists. Overwrite?" % outfname):
358 if not ask_yes_no("File %r exists. Overwrite?" % outfname):
403 print('Aborting.')
359 print('Aborting.')
404 return
360 return
405
361
406 outfile = open(outfname,'w')
362 outfile = open(outfname,'w')
407 close_at_end = True
363 close_at_end = True
408
364
409 print_nums = 'n' in opts
365 print_nums = 'n' in opts
410 print_outputs = 'o' in opts
366 print_outputs = 'o' in opts
411 pyprompts = 'p' in opts
367 pyprompts = 'p' in opts
412 # Raw history is the default
368 # Raw history is the default
413 raw = not('t' in opts)
369 raw = not('t' in opts)
414
370
415 default_length = 40
371 default_length = 40
416 pattern = None
372 pattern = None
417 if 'g' in opts:
373 if 'g' in opts:
418 index = None
374 start = 1; stop = None
419 parts = parameter_s.split(None, 1)
375 parts = parameter_s.split(None, 1)
420 if len(parts) == 1:
376 if len(parts) == 1:
421 parts += '*'
377 parts += '*'
422 head, pattern = parts
378 head, pattern = parts
423 pattern = "*" + pattern + "*"
379 pattern = "*" + pattern + "*"
424 elif len(args) == 0:
380 elif len(args) == 0:
425 index = None
381 start = 1; stop = None
426 elif len(args) == 1:
382 elif len(args) == 1:
427 index = int(args[0])
383 start = -int(args[0]); stop=None
428 elif len(args) == 2:
384 elif len(args) == 2:
429 index = map(int, args)
385 start = int(args[0]); stop = int(args[1])
430 else:
386 else:
431 warn('%hist takes 0, 1 or 2 arguments separated by spaces.')
387 warn('%hist takes 0, 1 or 2 arguments separated by spaces.')
432 print(self.magic_hist.__doc__, file=IPython.utils.io.Term.cout)
388 print(self.magic_hist.__doc__, file=IPython.utils.io.Term.cout)
433 return
389 return
434
390
435 hist = history_manager.get_history(index, raw, print_outputs)
391 hist = history_manager.get_history(start, stop, raw, print_outputs)
436
392
437 width = len(str(max(hist.iterkeys())))
393 width = len(str(max(hist.iterkeys())))
438 line_sep = ['','\n']
394 line_sep = ['','\n']
439
395
440 found = False
396 found = False
441 if pattern is not None:
397 if pattern is not None:
442 sh = history_manager.shadow_hist.all()
398 for session, line, s in history_manager.globsearch_db(pattern):
443 for idx, s in sh:
399 print("%d#%d: %s" %(session, line, s.expandtabs(4)), file=outfile)
444 if fnmatch.fnmatch(s, pattern):
400 found = True
445 print("0%d: %s" %(idx, s.expandtabs(4)), file=outfile)
446 found = True
447
401
448 if found:
402 if found:
449 print("===", file=outfile)
403 print("===", file=outfile)
450 print("shadow history ends, fetch by %rep <number> (must start with 0)",
404 print("shadow history ends, fetch by %rep session#line",
451 file=outfile)
405 file=outfile)
452 print("=== start of normal history ===", file=outfile)
406 print("=== start of normal history ===", file=outfile)
453
407
454 for in_num, inline in sorted(hist.iteritems()):
408 for in_num, inline in sorted(hist.iteritems()):
455 # Print user history with tabs expanded to 4 spaces. The GUI clients
409 # Print user history with tabs expanded to 4 spaces. The GUI clients
456 # use hard tabs for easier usability in auto-indented code, but we want
410 # use hard tabs for easier usability in auto-indented code, but we want
457 # to produce PEP-8 compliant history for safe pasting into an editor.
411 # to produce PEP-8 compliant history for safe pasting into an editor.
458 if print_outputs:
412 if print_outputs:
459 inline, output = inline
413 inline, output = inline
460 inline = inline.expandtabs(4).rstrip()
414 inline = inline.expandtabs(4).rstrip()
461
415
462 if pattern is not None and not fnmatch.fnmatch(inline, pattern):
416 if pattern is not None and not fnmatch.fnmatch(inline, pattern):
463 continue
417 continue
464
418
465 multiline = "\n" in inline
419 multiline = "\n" in inline
466 if print_nums:
420 if print_nums:
467 print('%s:%s' % (str(in_num).ljust(width), line_sep[multiline]),
421 print('%s:%s' % (str(in_num).ljust(width), line_sep[multiline]),
468 file=outfile, end='')
422 file=outfile, end='')
469 if pyprompts:
423 if pyprompts:
470 print(">>> ", end="", file=outfile)
424 print(">>> ", end="", file=outfile)
471 if multiline:
425 if multiline:
472 inline = "\n... ".join(inline.splitlines()) + "\n..."
426 inline = "\n... ".join(inline.splitlines()) + "\n..."
473 print(inline, file=outfile)
427 print(inline, file=outfile)
474 if print_outputs and output:
428 if print_outputs and output:
475 print(repr(output), file=outfile)
429 print(repr(output), file=outfile)
476
430
477 if close_at_end:
431 if close_at_end:
478 outfile.close()
432 outfile.close()
479
433
480 # %hist is an alternative name
434 # %hist is an alternative name
481 magic_hist = magic_history
435 magic_hist = magic_history
482
436
483
437
484 def rep_f(self, arg):
438 def rep_f(self, arg):
485 r""" Repeat a command, or get command to input line for editing
439 r""" Repeat a command, or get command to input line for editing
486
440
487 - %rep (no arguments):
441 - %rep (no arguments):
488
442
489 Place a string version of last computation result (stored in the special '_'
443 Place a string version of last computation result (stored in the special '_'
490 variable) to the next input prompt. Allows you to create elaborate command
444 variable) to the next input prompt. Allows you to create elaborate command
491 lines without using copy-paste::
445 lines without using copy-paste::
492
446
493 $ l = ["hei", "vaan"]
447 $ l = ["hei", "vaan"]
494 $ "".join(l)
448 $ "".join(l)
495 ==> heivaan
449 ==> heivaan
496 $ %rep
450 $ %rep
497 $ heivaan_ <== cursor blinking
451 $ heivaan_ <== cursor blinking
498
452
499 %rep 45
453 %rep 45
500
454
501 Place history line 45 to next input prompt. Use %hist to find out the
455 Place history line 45 to next input prompt. Use %hist to find out the
502 number.
456 number.
503
457
504 %rep 1-4 6-7 3
458 %rep 1-4 6-7 3
505
459
506 Repeat the specified lines immediately. Input slice syntax is the same as
460 Repeat the specified lines immediately. Input slice syntax is the same as
507 in %macro and %save.
461 in %macro and %save.
508
462
509 %rep foo
463 %rep foo
510
464
511 Place the most recent line that has the substring "foo" to next input.
465 Place the most recent line that has the substring "foo" to next input.
512 (e.g. 'svn ci -m foobar').
466 (e.g. 'svn ci -m foobar').
513 """
467 """
514
468
515 opts,args = self.parse_options(arg,'',mode='list')
469 opts,args = self.parse_options(arg,'',mode='list')
516 if not args:
470 if not args:
517 self.set_next_input(str(self.shell.user_ns["_"]))
471 self.set_next_input(str(self.shell.user_ns["_"]))
518 return
472 return
519
473
520 if len(args) == 1 and not '-' in args[0]:
474 if len(args) == 1 and not '-' in args[0]:
521 arg = args[0]
475 arg = args[0]
522 if len(arg) > 1 and arg.startswith('0'):
476 if len(arg) > 1 and arg.startswith('0'):
523 # get from shadow hist
477 # get from shadow hist
524 num = int(arg[1:])
478 num = int(arg[1:])
525 line = self.shell.shadowhist.get(num)
479 line = self.shell.shadowhist.get(num)
526 self.set_next_input(str(line))
480 self.set_next_input(str(line))
527 return
481 return
528 try:
482 try:
529 num = int(args[0])
483 num = int(args[0])
530 self.set_next_input(str(self.shell.input_hist_raw[num]).rstrip())
484 self.set_next_input(str(self.shell.input_hist_raw[num]).rstrip())
531 return
485 return
532 except ValueError:
486 except ValueError:
533 pass
487 pass
534
488
535 for h in reversed(self.shell.input_hist_raw):
489 for h in reversed(self.shell.input_hist_raw):
536 if 'rep' in h:
490 if 'rep' in h:
537 continue
491 continue
538 if fnmatch.fnmatch(h,'*' + arg + '*'):
492 if fnmatch.fnmatch(h,'*' + arg + '*'):
539 self.set_next_input(str(h).rstrip())
493 self.set_next_input(str(h).rstrip())
540 return
494 return
541
495
542 try:
496 try:
543 lines = self.extract_input_slices(args, True)
497 lines = self.extract_input_slices(args, True)
544 print("lines", lines)
498 print("lines", lines)
545 self.run_cell(lines)
499 self.run_cell(lines)
546 except ValueError:
500 except ValueError:
547 print("Not found in recent history:", args)
501 print("Not found in recent history:", args)
548
549
550 _sentinel = object()
551
552 class ShadowHist(object):
553 def __init__(self, db, shell):
554 # cmd => idx mapping
555 self.curidx = 0
556 self.db = db
557 self.disabled = False
558 self.shell = shell
559
560 def inc_idx(self):
561 idx = self.db.get('shadowhist_idx', 1)
562 self.db['shadowhist_idx'] = idx + 1
563 return idx
564
565 def add(self, ent):
566 if self.disabled:
567 return
568 try:
569 old = self.db.hget('shadowhist', ent, _sentinel)
570 if old is not _sentinel:
571 return
572 newidx = self.inc_idx()
573 #print("new", newidx) # dbg
574 self.db.hset('shadowhist',ent, newidx)
575 except:
576 self.shell.showtraceback()
577 print("WARNING: disabling shadow history")
578 self.disabled = True
579
580 def all(self):
581 d = self.db.hdict('shadowhist')
582 items = [(i,s) for (s,i) in d.iteritems()]
583 items.sort()
584 return items
585
586 def get(self, idx):
587 all = self.all()
588
589 for k, v in all:
590 if k == idx:
591 return v
592
502
593
503
594 def init_ipython(ip):
504 def init_ipython(ip):
595 ip.define_magic("rep",rep_f)
505 ip.define_magic("rep",rep_f)
596 ip.define_magic("hist",magic_hist)
506 ip.define_magic("hist",magic_hist)
597 ip.define_magic("history",magic_history)
507 ip.define_magic("history",magic_history)
598
508
599 # XXX - ipy_completers are in quarantine, need to be updated to new apis
509 # XXX - ipy_completers are in quarantine, need to be updated to new apis
600 #import ipy_completers
510 #import ipy_completers
601 #ipy_completers.quick_completer('%hist' ,'-g -t -r -n')
511 #ipy_completers.quick_completer('%hist' ,'-g -t -r -n')
@@ -1,2555 +1,2546 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """Main IPython class."""
2 """Main IPython class."""
3
3
4 #-----------------------------------------------------------------------------
4 #-----------------------------------------------------------------------------
5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
7 # Copyright (C) 2008-2011 The IPython Development Team
7 # Copyright (C) 2008-2011 The IPython Development Team
8 #
8 #
9 # Distributed under the terms of the BSD License. The full license is in
9 # Distributed under the terms of the BSD License. The full license is in
10 # the file COPYING, distributed as part of this software.
10 # the file COPYING, distributed as part of this software.
11 #-----------------------------------------------------------------------------
11 #-----------------------------------------------------------------------------
12
12
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14 # Imports
14 # Imports
15 #-----------------------------------------------------------------------------
15 #-----------------------------------------------------------------------------
16
16
17 from __future__ import with_statement
17 from __future__ import with_statement
18 from __future__ import absolute_import
18 from __future__ import absolute_import
19
19
20 import __builtin__
20 import __builtin__
21 import __future__
21 import __future__
22 import abc
22 import abc
23 import atexit
23 import atexit
24 import codeop
24 import codeop
25 import os
25 import os
26 import re
26 import re
27 import sys
27 import sys
28 import tempfile
28 import tempfile
29 import types
29 import types
30 from contextlib import nested
30 from contextlib import nested
31
31
32 from IPython.config.configurable import Configurable
32 from IPython.config.configurable import Configurable
33 from IPython.core import debugger, oinspect
33 from IPython.core import debugger, oinspect
34 from IPython.core import history as ipcorehist
34 from IPython.core import history as ipcorehist
35 from IPython.core import page
35 from IPython.core import page
36 from IPython.core import prefilter
36 from IPython.core import prefilter
37 from IPython.core import shadowns
37 from IPython.core import shadowns
38 from IPython.core import ultratb
38 from IPython.core import ultratb
39 from IPython.core.alias import AliasManager
39 from IPython.core.alias import AliasManager
40 from IPython.core.builtin_trap import BuiltinTrap
40 from IPython.core.builtin_trap import BuiltinTrap
41 from IPython.core.compilerop import CachingCompiler
41 from IPython.core.compilerop import CachingCompiler
42 from IPython.core.display_trap import DisplayTrap
42 from IPython.core.display_trap import DisplayTrap
43 from IPython.core.displayhook import DisplayHook
43 from IPython.core.displayhook import DisplayHook
44 from IPython.core.displaypub import DisplayPublisher
44 from IPython.core.displaypub import DisplayPublisher
45 from IPython.core.error import TryNext, UsageError
45 from IPython.core.error import TryNext, UsageError
46 from IPython.core.extensions import ExtensionManager
46 from IPython.core.extensions import ExtensionManager
47 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
47 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
48 from IPython.core.formatters import DisplayFormatter
48 from IPython.core.formatters import DisplayFormatter
49 from IPython.core.history import HistoryManager
49 from IPython.core.history import HistoryManager
50 from IPython.core.inputsplitter import IPythonInputSplitter
50 from IPython.core.inputsplitter import IPythonInputSplitter
51 from IPython.core.logger import Logger
51 from IPython.core.logger import Logger
52 from IPython.core.magic import Magic
52 from IPython.core.magic import Magic
53 from IPython.core.payload import PayloadManager
53 from IPython.core.payload import PayloadManager
54 from IPython.core.plugin import PluginManager
54 from IPython.core.plugin import PluginManager
55 from IPython.core.prefilter import PrefilterManager, ESC_MAGIC
55 from IPython.core.prefilter import PrefilterManager, ESC_MAGIC
56 from IPython.external.Itpl import ItplNS
56 from IPython.external.Itpl import ItplNS
57 from IPython.utils import PyColorize
57 from IPython.utils import PyColorize
58 from IPython.utils import io
58 from IPython.utils import io
59 from IPython.utils import pickleshare
60 from IPython.utils.doctestreload import doctest_reload
59 from IPython.utils.doctestreload import doctest_reload
61 from IPython.utils.io import ask_yes_no, rprint
60 from IPython.utils.io import ask_yes_no, rprint
62 from IPython.utils.ipstruct import Struct
61 from IPython.utils.ipstruct import Struct
63 from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError
62 from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError
63 from IPython.utils.pickleshare import PickleShareDB
64 from IPython.utils.process import system, getoutput
64 from IPython.utils.process import system, getoutput
65 from IPython.utils.strdispatch import StrDispatch
65 from IPython.utils.strdispatch import StrDispatch
66 from IPython.utils.syspathcontext import prepended_to_syspath
66 from IPython.utils.syspathcontext import prepended_to_syspath
67 from IPython.utils.text import num_ini_spaces, format_screen, LSString, SList
67 from IPython.utils.text import num_ini_spaces, format_screen, LSString, SList
68 from IPython.utils.traitlets import (Int, Str, CBool, CaselessStrEnum, Enum,
68 from IPython.utils.traitlets import (Int, Str, CBool, CaselessStrEnum, Enum,
69 List, Unicode, Instance, Type)
69 List, Unicode, Instance, Type)
70 from IPython.utils.warn import warn, error, fatal
70 from IPython.utils.warn import warn, error, fatal
71 import IPython.core.hooks
71 import IPython.core.hooks
72
72
73 #-----------------------------------------------------------------------------
73 #-----------------------------------------------------------------------------
74 # Globals
74 # Globals
75 #-----------------------------------------------------------------------------
75 #-----------------------------------------------------------------------------
76
76
77 # compiled regexps for autoindent management
77 # compiled regexps for autoindent management
78 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
78 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
79
79
80 #-----------------------------------------------------------------------------
80 #-----------------------------------------------------------------------------
81 # Utilities
81 # Utilities
82 #-----------------------------------------------------------------------------
82 #-----------------------------------------------------------------------------
83
83
84 # store the builtin raw_input globally, and use this always, in case user code
84 # store the builtin raw_input globally, and use this always, in case user code
85 # overwrites it (like wx.py.PyShell does)
85 # overwrites it (like wx.py.PyShell does)
86 raw_input_original = raw_input
86 raw_input_original = raw_input
87
87
88 def softspace(file, newvalue):
88 def softspace(file, newvalue):
89 """Copied from code.py, to remove the dependency"""
89 """Copied from code.py, to remove the dependency"""
90
90
91 oldvalue = 0
91 oldvalue = 0
92 try:
92 try:
93 oldvalue = file.softspace
93 oldvalue = file.softspace
94 except AttributeError:
94 except AttributeError:
95 pass
95 pass
96 try:
96 try:
97 file.softspace = newvalue
97 file.softspace = newvalue
98 except (AttributeError, TypeError):
98 except (AttributeError, TypeError):
99 # "attribute-less object" or "read-only attributes"
99 # "attribute-less object" or "read-only attributes"
100 pass
100 pass
101 return oldvalue
101 return oldvalue
102
102
103
103
104 def no_op(*a, **kw): pass
104 def no_op(*a, **kw): pass
105
105
106 class SpaceInInput(Exception): pass
106 class SpaceInInput(Exception): pass
107
107
108 class Bunch: pass
108 class Bunch: pass
109
109
110
110
111 def get_default_colors():
111 def get_default_colors():
112 if sys.platform=='darwin':
112 if sys.platform=='darwin':
113 return "LightBG"
113 return "LightBG"
114 elif os.name=='nt':
114 elif os.name=='nt':
115 return 'Linux'
115 return 'Linux'
116 else:
116 else:
117 return 'Linux'
117 return 'Linux'
118
118
119
119
120 class SeparateStr(Str):
120 class SeparateStr(Str):
121 """A Str subclass to validate separate_in, separate_out, etc.
121 """A Str subclass to validate separate_in, separate_out, etc.
122
122
123 This is a Str based trait that converts '0'->'' and '\\n'->'\n'.
123 This is a Str based trait that converts '0'->'' and '\\n'->'\n'.
124 """
124 """
125
125
126 def validate(self, obj, value):
126 def validate(self, obj, value):
127 if value == '0': value = ''
127 if value == '0': value = ''
128 value = value.replace('\\n','\n')
128 value = value.replace('\\n','\n')
129 return super(SeparateStr, self).validate(obj, value)
129 return super(SeparateStr, self).validate(obj, value)
130
130
131 class MultipleInstanceError(Exception):
131 class MultipleInstanceError(Exception):
132 pass
132 pass
133
133
134
134
135 #-----------------------------------------------------------------------------
135 #-----------------------------------------------------------------------------
136 # Main IPython class
136 # Main IPython class
137 #-----------------------------------------------------------------------------
137 #-----------------------------------------------------------------------------
138
138
139 class InteractiveShell(Configurable, Magic):
139 class InteractiveShell(Configurable, Magic):
140 """An enhanced, interactive shell for Python."""
140 """An enhanced, interactive shell for Python."""
141
141
142 _instance = None
142 _instance = None
143 autocall = Enum((0,1,2), default_value=1, config=True)
143 autocall = Enum((0,1,2), default_value=1, config=True)
144 # TODO: remove all autoindent logic and put into frontends.
144 # TODO: remove all autoindent logic and put into frontends.
145 # We can't do this yet because even runlines uses the autoindent.
145 # We can't do this yet because even runlines uses the autoindent.
146 autoindent = CBool(True, config=True)
146 autoindent = CBool(True, config=True)
147 automagic = CBool(True, config=True)
147 automagic = CBool(True, config=True)
148 cache_size = Int(1000, config=True)
148 cache_size = Int(1000, config=True)
149 color_info = CBool(True, config=True)
149 color_info = CBool(True, config=True)
150 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
150 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
151 default_value=get_default_colors(), config=True)
151 default_value=get_default_colors(), config=True)
152 debug = CBool(False, config=True)
152 debug = CBool(False, config=True)
153 deep_reload = CBool(False, config=True)
153 deep_reload = CBool(False, config=True)
154 display_formatter = Instance(DisplayFormatter)
154 display_formatter = Instance(DisplayFormatter)
155 displayhook_class = Type(DisplayHook)
155 displayhook_class = Type(DisplayHook)
156 display_pub_class = Type(DisplayPublisher)
156 display_pub_class = Type(DisplayPublisher)
157
157
158 exit_now = CBool(False)
158 exit_now = CBool(False)
159 # Monotonically increasing execution counter
159 # Monotonically increasing execution counter
160 execution_count = Int(1)
160 execution_count = Int(1)
161 filename = Str("<ipython console>")
161 filename = Str("<ipython console>")
162 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
162 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
163
163
164 # Input splitter, to split entire cells of input into either individual
164 # Input splitter, to split entire cells of input into either individual
165 # interactive statements or whole blocks.
165 # interactive statements or whole blocks.
166 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
166 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
167 (), {})
167 (), {})
168 logstart = CBool(False, config=True)
168 logstart = CBool(False, config=True)
169 logfile = Str('', config=True)
169 logfile = Str('', config=True)
170 logappend = Str('', config=True)
170 logappend = Str('', config=True)
171 object_info_string_level = Enum((0,1,2), default_value=0,
171 object_info_string_level = Enum((0,1,2), default_value=0,
172 config=True)
172 config=True)
173 pdb = CBool(False, config=True)
173 pdb = CBool(False, config=True)
174
174
175 profile = Str('', config=True)
175 profile = Str('', config=True)
176 prompt_in1 = Str('In [\\#]: ', config=True)
176 prompt_in1 = Str('In [\\#]: ', config=True)
177 prompt_in2 = Str(' .\\D.: ', config=True)
177 prompt_in2 = Str(' .\\D.: ', config=True)
178 prompt_out = Str('Out[\\#]: ', config=True)
178 prompt_out = Str('Out[\\#]: ', config=True)
179 prompts_pad_left = CBool(True, config=True)
179 prompts_pad_left = CBool(True, config=True)
180 quiet = CBool(False, config=True)
180 quiet = CBool(False, config=True)
181
181
182 history_length = Int(10000, config=True)
182 history_length = Int(10000, config=True)
183
183
184 # The readline stuff will eventually be moved to the terminal subclass
184 # The readline stuff will eventually be moved to the terminal subclass
185 # but for now, we can't do that as readline is welded in everywhere.
185 # but for now, we can't do that as readline is welded in everywhere.
186 readline_use = CBool(True, config=True)
186 readline_use = CBool(True, config=True)
187 readline_merge_completions = CBool(True, config=True)
187 readline_merge_completions = CBool(True, config=True)
188 readline_omit__names = Enum((0,1,2), default_value=2, config=True)
188 readline_omit__names = Enum((0,1,2), default_value=2, config=True)
189 readline_remove_delims = Str('-/~', config=True)
189 readline_remove_delims = Str('-/~', config=True)
190 readline_parse_and_bind = List([
190 readline_parse_and_bind = List([
191 'tab: complete',
191 'tab: complete',
192 '"\C-l": clear-screen',
192 '"\C-l": clear-screen',
193 'set show-all-if-ambiguous on',
193 'set show-all-if-ambiguous on',
194 '"\C-o": tab-insert',
194 '"\C-o": tab-insert',
195 '"\M-i": " "',
195 '"\M-i": " "',
196 '"\M-o": "\d\d\d\d"',
196 '"\M-o": "\d\d\d\d"',
197 '"\M-I": "\d\d\d\d"',
197 '"\M-I": "\d\d\d\d"',
198 '"\C-r": reverse-search-history',
198 '"\C-r": reverse-search-history',
199 '"\C-s": forward-search-history',
199 '"\C-s": forward-search-history',
200 '"\C-p": history-search-backward',
200 '"\C-p": history-search-backward',
201 '"\C-n": history-search-forward',
201 '"\C-n": history-search-forward',
202 '"\e[A": history-search-backward',
202 '"\e[A": history-search-backward',
203 '"\e[B": history-search-forward',
203 '"\e[B": history-search-forward',
204 '"\C-k": kill-line',
204 '"\C-k": kill-line',
205 '"\C-u": unix-line-discard',
205 '"\C-u": unix-line-discard',
206 ], allow_none=False, config=True)
206 ], allow_none=False, config=True)
207
207
208 # TODO: this part of prompt management should be moved to the frontends.
208 # TODO: this part of prompt management should be moved to the frontends.
209 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
209 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
210 separate_in = SeparateStr('\n', config=True)
210 separate_in = SeparateStr('\n', config=True)
211 separate_out = SeparateStr('', config=True)
211 separate_out = SeparateStr('', config=True)
212 separate_out2 = SeparateStr('', config=True)
212 separate_out2 = SeparateStr('', config=True)
213 wildcards_case_sensitive = CBool(True, config=True)
213 wildcards_case_sensitive = CBool(True, config=True)
214 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
214 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
215 default_value='Context', config=True)
215 default_value='Context', config=True)
216
216
217 # Subcomponents of InteractiveShell
217 # Subcomponents of InteractiveShell
218 alias_manager = Instance('IPython.core.alias.AliasManager')
218 alias_manager = Instance('IPython.core.alias.AliasManager')
219 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
219 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
220 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
220 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
221 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
221 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
222 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
222 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
223 plugin_manager = Instance('IPython.core.plugin.PluginManager')
223 plugin_manager = Instance('IPython.core.plugin.PluginManager')
224 payload_manager = Instance('IPython.core.payload.PayloadManager')
224 payload_manager = Instance('IPython.core.payload.PayloadManager')
225 history_manager = Instance('IPython.core.history.HistoryManager')
225 history_manager = Instance('IPython.core.history.HistoryManager')
226
226
227 # Private interface
227 # Private interface
228 _post_execute = set()
228 _post_execute = set()
229
229
230 def __init__(self, config=None, ipython_dir=None,
230 def __init__(self, config=None, ipython_dir=None,
231 user_ns=None, user_global_ns=None,
231 user_ns=None, user_global_ns=None,
232 custom_exceptions=((), None)):
232 custom_exceptions=((), None)):
233
233
234 # This is where traits with a config_key argument are updated
234 # This is where traits with a config_key argument are updated
235 # from the values on config.
235 # from the values on config.
236 super(InteractiveShell, self).__init__(config=config)
236 super(InteractiveShell, self).__init__(config=config)
237
237
238 # These are relatively independent and stateless
238 # These are relatively independent and stateless
239 self.init_ipython_dir(ipython_dir)
239 self.init_ipython_dir(ipython_dir)
240 self.init_instance_attrs()
240 self.init_instance_attrs()
241 self.init_environment()
241 self.init_environment()
242
242
243 # Create namespaces (user_ns, user_global_ns, etc.)
243 # Create namespaces (user_ns, user_global_ns, etc.)
244 self.init_create_namespaces(user_ns, user_global_ns)
244 self.init_create_namespaces(user_ns, user_global_ns)
245 # This has to be done after init_create_namespaces because it uses
245 # This has to be done after init_create_namespaces because it uses
246 # something in self.user_ns, but before init_sys_modules, which
246 # something in self.user_ns, but before init_sys_modules, which
247 # is the first thing to modify sys.
247 # is the first thing to modify sys.
248 # TODO: When we override sys.stdout and sys.stderr before this class
248 # TODO: When we override sys.stdout and sys.stderr before this class
249 # is created, we are saving the overridden ones here. Not sure if this
249 # is created, we are saving the overridden ones here. Not sure if this
250 # is what we want to do.
250 # is what we want to do.
251 self.save_sys_module_state()
251 self.save_sys_module_state()
252 self.init_sys_modules()
252 self.init_sys_modules()
253
254 # While we're trying to have each part of the code directly access what
255 # it needs without keeping redundant references to objects, we have too
256 # much legacy code that expects ip.db to exist.
257 self.db = PickleShareDB(os.path.join(self.ipython_dir, 'db'))
253
258
254 self.init_history()
259 self.init_history()
255 self.init_encoding()
260 self.init_encoding()
256 self.init_prefilter()
261 self.init_prefilter()
257
262
258 Magic.__init__(self, self)
263 Magic.__init__(self, self)
259
264
260 self.init_syntax_highlighting()
265 self.init_syntax_highlighting()
261 self.init_hooks()
266 self.init_hooks()
262 self.init_pushd_popd_magic()
267 self.init_pushd_popd_magic()
263 # self.init_traceback_handlers use to be here, but we moved it below
268 # self.init_traceback_handlers use to be here, but we moved it below
264 # because it and init_io have to come after init_readline.
269 # because it and init_io have to come after init_readline.
265 self.init_user_ns()
270 self.init_user_ns()
266 self.init_logger()
271 self.init_logger()
267 self.init_alias()
272 self.init_alias()
268 self.init_builtins()
273 self.init_builtins()
269
274
270 # pre_config_initialization
275 # pre_config_initialization
271
276
272 # The next section should contain everything that was in ipmaker.
277 # The next section should contain everything that was in ipmaker.
273 self.init_logstart()
278 self.init_logstart()
274
279
275 # The following was in post_config_initialization
280 # The following was in post_config_initialization
276 self.init_inspector()
281 self.init_inspector()
277 # init_readline() must come before init_io(), because init_io uses
282 # init_readline() must come before init_io(), because init_io uses
278 # readline related things.
283 # readline related things.
279 self.init_readline()
284 self.init_readline()
280 # init_completer must come after init_readline, because it needs to
285 # init_completer must come after init_readline, because it needs to
281 # know whether readline is present or not system-wide to configure the
286 # know whether readline is present or not system-wide to configure the
282 # completers, since the completion machinery can now operate
287 # completers, since the completion machinery can now operate
283 # independently of readline (e.g. over the network)
288 # independently of readline (e.g. over the network)
284 self.init_completer()
289 self.init_completer()
285 # TODO: init_io() needs to happen before init_traceback handlers
290 # TODO: init_io() needs to happen before init_traceback handlers
286 # because the traceback handlers hardcode the stdout/stderr streams.
291 # because the traceback handlers hardcode the stdout/stderr streams.
287 # This logic in in debugger.Pdb and should eventually be changed.
292 # This logic in in debugger.Pdb and should eventually be changed.
288 self.init_io()
293 self.init_io()
289 self.init_traceback_handlers(custom_exceptions)
294 self.init_traceback_handlers(custom_exceptions)
290 self.init_prompts()
295 self.init_prompts()
291 self.init_display_formatter()
296 self.init_display_formatter()
292 self.init_display_pub()
297 self.init_display_pub()
293 self.init_displayhook()
298 self.init_displayhook()
294 self.init_reload_doctest()
299 self.init_reload_doctest()
295 self.init_magics()
300 self.init_magics()
296 self.init_pdb()
301 self.init_pdb()
297 self.init_extension_manager()
302 self.init_extension_manager()
298 self.init_plugin_manager()
303 self.init_plugin_manager()
299 self.init_payload()
304 self.init_payload()
300 self.hooks.late_startup_hook()
305 self.hooks.late_startup_hook()
301 atexit.register(self.atexit_operations)
306 atexit.register(self.atexit_operations)
302
307
303 # While we're trying to have each part of the code directly access what it
304 # needs without keeping redundant references to objects, we have too much
305 # legacy code that expects ip.db to exist, so let's make it a property that
306 # retrieves the underlying object from our new history manager.
307 @property
308 def db(self):
309 return self.history_manager.shadow_db
310
311 @classmethod
308 @classmethod
312 def instance(cls, *args, **kwargs):
309 def instance(cls, *args, **kwargs):
313 """Returns a global InteractiveShell instance."""
310 """Returns a global InteractiveShell instance."""
314 if cls._instance is None:
311 if cls._instance is None:
315 inst = cls(*args, **kwargs)
312 inst = cls(*args, **kwargs)
316 # Now make sure that the instance will also be returned by
313 # Now make sure that the instance will also be returned by
317 # the subclasses instance attribute.
314 # the subclasses instance attribute.
318 for subclass in cls.mro():
315 for subclass in cls.mro():
319 if issubclass(cls, subclass) and \
316 if issubclass(cls, subclass) and \
320 issubclass(subclass, InteractiveShell):
317 issubclass(subclass, InteractiveShell):
321 subclass._instance = inst
318 subclass._instance = inst
322 else:
319 else:
323 break
320 break
324 if isinstance(cls._instance, cls):
321 if isinstance(cls._instance, cls):
325 return cls._instance
322 return cls._instance
326 else:
323 else:
327 raise MultipleInstanceError(
324 raise MultipleInstanceError(
328 'Multiple incompatible subclass instances of '
325 'Multiple incompatible subclass instances of '
329 'InteractiveShell are being created.'
326 'InteractiveShell are being created.'
330 )
327 )
331
328
332 @classmethod
329 @classmethod
333 def initialized(cls):
330 def initialized(cls):
334 return hasattr(cls, "_instance")
331 return hasattr(cls, "_instance")
335
332
336 def get_ipython(self):
333 def get_ipython(self):
337 """Return the currently running IPython instance."""
334 """Return the currently running IPython instance."""
338 return self
335 return self
339
336
340 #-------------------------------------------------------------------------
337 #-------------------------------------------------------------------------
341 # Trait changed handlers
338 # Trait changed handlers
342 #-------------------------------------------------------------------------
339 #-------------------------------------------------------------------------
343
340
344 def _ipython_dir_changed(self, name, new):
341 def _ipython_dir_changed(self, name, new):
345 if not os.path.isdir(new):
342 if not os.path.isdir(new):
346 os.makedirs(new, mode = 0777)
343 os.makedirs(new, mode = 0777)
347
344
348 def set_autoindent(self,value=None):
345 def set_autoindent(self,value=None):
349 """Set the autoindent flag, checking for readline support.
346 """Set the autoindent flag, checking for readline support.
350
347
351 If called with no arguments, it acts as a toggle."""
348 If called with no arguments, it acts as a toggle."""
352
349
353 if not self.has_readline:
350 if not self.has_readline:
354 if os.name == 'posix':
351 if os.name == 'posix':
355 warn("The auto-indent feature requires the readline library")
352 warn("The auto-indent feature requires the readline library")
356 self.autoindent = 0
353 self.autoindent = 0
357 return
354 return
358 if value is None:
355 if value is None:
359 self.autoindent = not self.autoindent
356 self.autoindent = not self.autoindent
360 else:
357 else:
361 self.autoindent = value
358 self.autoindent = value
362
359
363 #-------------------------------------------------------------------------
360 #-------------------------------------------------------------------------
364 # init_* methods called by __init__
361 # init_* methods called by __init__
365 #-------------------------------------------------------------------------
362 #-------------------------------------------------------------------------
366
363
367 def init_ipython_dir(self, ipython_dir):
364 def init_ipython_dir(self, ipython_dir):
368 if ipython_dir is not None:
365 if ipython_dir is not None:
369 self.ipython_dir = ipython_dir
366 self.ipython_dir = ipython_dir
370 self.config.Global.ipython_dir = self.ipython_dir
367 self.config.Global.ipython_dir = self.ipython_dir
371 return
368 return
372
369
373 if hasattr(self.config.Global, 'ipython_dir'):
370 if hasattr(self.config.Global, 'ipython_dir'):
374 self.ipython_dir = self.config.Global.ipython_dir
371 self.ipython_dir = self.config.Global.ipython_dir
375 else:
372 else:
376 self.ipython_dir = get_ipython_dir()
373 self.ipython_dir = get_ipython_dir()
377
374
378 # All children can just read this
375 # All children can just read this
379 self.config.Global.ipython_dir = self.ipython_dir
376 self.config.Global.ipython_dir = self.ipython_dir
380
377
381 def init_instance_attrs(self):
378 def init_instance_attrs(self):
382 self.more = False
379 self.more = False
383
380
384 # command compiler
381 # command compiler
385 self.compile = CachingCompiler()
382 self.compile = CachingCompiler()
386
383
387 # User input buffers
384 # User input buffers
388 # NOTE: these variables are slated for full removal, once we are 100%
385 # NOTE: these variables are slated for full removal, once we are 100%
389 # sure that the new execution logic is solid. We will delte runlines,
386 # sure that the new execution logic is solid. We will delte runlines,
390 # push_line and these buffers, as all input will be managed by the
387 # push_line and these buffers, as all input will be managed by the
391 # frontends via an inputsplitter instance.
388 # frontends via an inputsplitter instance.
392 self.buffer = []
389 self.buffer = []
393 self.buffer_raw = []
390 self.buffer_raw = []
394
391
395 # Make an empty namespace, which extension writers can rely on both
392 # Make an empty namespace, which extension writers can rely on both
396 # existing and NEVER being used by ipython itself. This gives them a
393 # existing and NEVER being used by ipython itself. This gives them a
397 # convenient location for storing additional information and state
394 # convenient location for storing additional information and state
398 # their extensions may require, without fear of collisions with other
395 # their extensions may require, without fear of collisions with other
399 # ipython names that may develop later.
396 # ipython names that may develop later.
400 self.meta = Struct()
397 self.meta = Struct()
401
398
402 # Object variable to store code object waiting execution. This is
399 # Object variable to store code object waiting execution. This is
403 # used mainly by the multithreaded shells, but it can come in handy in
400 # used mainly by the multithreaded shells, but it can come in handy in
404 # other situations. No need to use a Queue here, since it's a single
401 # other situations. No need to use a Queue here, since it's a single
405 # item which gets cleared once run.
402 # item which gets cleared once run.
406 self.code_to_run = None
403 self.code_to_run = None
407
404
408 # Temporary files used for various purposes. Deleted at exit.
405 # Temporary files used for various purposes. Deleted at exit.
409 self.tempfiles = []
406 self.tempfiles = []
410
407
411 # Keep track of readline usage (later set by init_readline)
408 # Keep track of readline usage (later set by init_readline)
412 self.has_readline = False
409 self.has_readline = False
413
410
414 # keep track of where we started running (mainly for crash post-mortem)
411 # keep track of where we started running (mainly for crash post-mortem)
415 # This is not being used anywhere currently.
412 # This is not being used anywhere currently.
416 self.starting_dir = os.getcwd()
413 self.starting_dir = os.getcwd()
417
414
418 # Indentation management
415 # Indentation management
419 self.indent_current_nsp = 0
416 self.indent_current_nsp = 0
420
417
421 def init_environment(self):
418 def init_environment(self):
422 """Any changes we need to make to the user's environment."""
419 """Any changes we need to make to the user's environment."""
423 pass
420 pass
424
421
425 def init_encoding(self):
422 def init_encoding(self):
426 # Get system encoding at startup time. Certain terminals (like Emacs
423 # Get system encoding at startup time. Certain terminals (like Emacs
427 # under Win32 have it set to None, and we need to have a known valid
424 # under Win32 have it set to None, and we need to have a known valid
428 # encoding to use in the raw_input() method
425 # encoding to use in the raw_input() method
429 try:
426 try:
430 self.stdin_encoding = sys.stdin.encoding or 'ascii'
427 self.stdin_encoding = sys.stdin.encoding or 'ascii'
431 except AttributeError:
428 except AttributeError:
432 self.stdin_encoding = 'ascii'
429 self.stdin_encoding = 'ascii'
433
430
434 def init_syntax_highlighting(self):
431 def init_syntax_highlighting(self):
435 # Python source parser/formatter for syntax highlighting
432 # Python source parser/formatter for syntax highlighting
436 pyformat = PyColorize.Parser().format
433 pyformat = PyColorize.Parser().format
437 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
434 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
438
435
439 def init_pushd_popd_magic(self):
436 def init_pushd_popd_magic(self):
440 # for pushd/popd management
437 # for pushd/popd management
441 try:
438 try:
442 self.home_dir = get_home_dir()
439 self.home_dir = get_home_dir()
443 except HomeDirError, msg:
440 except HomeDirError, msg:
444 fatal(msg)
441 fatal(msg)
445
442
446 self.dir_stack = []
443 self.dir_stack = []
447
444
448 def init_logger(self):
445 def init_logger(self):
449 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
446 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
450 logmode='rotate')
447 logmode='rotate')
451
448
452 def init_logstart(self):
449 def init_logstart(self):
453 """Initialize logging in case it was requested at the command line.
450 """Initialize logging in case it was requested at the command line.
454 """
451 """
455 if self.logappend:
452 if self.logappend:
456 self.magic_logstart(self.logappend + ' append')
453 self.magic_logstart(self.logappend + ' append')
457 elif self.logfile:
454 elif self.logfile:
458 self.magic_logstart(self.logfile)
455 self.magic_logstart(self.logfile)
459 elif self.logstart:
456 elif self.logstart:
460 self.magic_logstart()
457 self.magic_logstart()
461
458
462 def init_builtins(self):
459 def init_builtins(self):
463 self.builtin_trap = BuiltinTrap(shell=self)
460 self.builtin_trap = BuiltinTrap(shell=self)
464
461
465 def init_inspector(self):
462 def init_inspector(self):
466 # Object inspector
463 # Object inspector
467 self.inspector = oinspect.Inspector(oinspect.InspectColors,
464 self.inspector = oinspect.Inspector(oinspect.InspectColors,
468 PyColorize.ANSICodeColors,
465 PyColorize.ANSICodeColors,
469 'NoColor',
466 'NoColor',
470 self.object_info_string_level)
467 self.object_info_string_level)
471
468
472 def init_io(self):
469 def init_io(self):
473 # This will just use sys.stdout and sys.stderr. If you want to
470 # This will just use sys.stdout and sys.stderr. If you want to
474 # override sys.stdout and sys.stderr themselves, you need to do that
471 # override sys.stdout and sys.stderr themselves, you need to do that
475 # *before* instantiating this class, because Term holds onto
472 # *before* instantiating this class, because Term holds onto
476 # references to the underlying streams.
473 # references to the underlying streams.
477 if sys.platform == 'win32' and self.has_readline:
474 if sys.platform == 'win32' and self.has_readline:
478 Term = io.IOTerm(cout=self.readline._outputfile,
475 Term = io.IOTerm(cout=self.readline._outputfile,
479 cerr=self.readline._outputfile)
476 cerr=self.readline._outputfile)
480 else:
477 else:
481 Term = io.IOTerm()
478 Term = io.IOTerm()
482 io.Term = Term
479 io.Term = Term
483
480
484 def init_prompts(self):
481 def init_prompts(self):
485 # TODO: This is a pass for now because the prompts are managed inside
482 # TODO: This is a pass for now because the prompts are managed inside
486 # the DisplayHook. Once there is a separate prompt manager, this
483 # the DisplayHook. Once there is a separate prompt manager, this
487 # will initialize that object and all prompt related information.
484 # will initialize that object and all prompt related information.
488 pass
485 pass
489
486
490 def init_display_formatter(self):
487 def init_display_formatter(self):
491 self.display_formatter = DisplayFormatter(config=self.config)
488 self.display_formatter = DisplayFormatter(config=self.config)
492
489
493 def init_display_pub(self):
490 def init_display_pub(self):
494 self.display_pub = self.display_pub_class(config=self.config)
491 self.display_pub = self.display_pub_class(config=self.config)
495
492
496 def init_displayhook(self):
493 def init_displayhook(self):
497 # Initialize displayhook, set in/out prompts and printing system
494 # Initialize displayhook, set in/out prompts and printing system
498 self.displayhook = self.displayhook_class(
495 self.displayhook = self.displayhook_class(
499 config=self.config,
496 config=self.config,
500 shell=self,
497 shell=self,
501 cache_size=self.cache_size,
498 cache_size=self.cache_size,
502 input_sep = self.separate_in,
499 input_sep = self.separate_in,
503 output_sep = self.separate_out,
500 output_sep = self.separate_out,
504 output_sep2 = self.separate_out2,
501 output_sep2 = self.separate_out2,
505 ps1 = self.prompt_in1,
502 ps1 = self.prompt_in1,
506 ps2 = self.prompt_in2,
503 ps2 = self.prompt_in2,
507 ps_out = self.prompt_out,
504 ps_out = self.prompt_out,
508 pad_left = self.prompts_pad_left
505 pad_left = self.prompts_pad_left
509 )
506 )
510 # This is a context manager that installs/revmoes the displayhook at
507 # This is a context manager that installs/revmoes the displayhook at
511 # the appropriate time.
508 # the appropriate time.
512 self.display_trap = DisplayTrap(hook=self.displayhook)
509 self.display_trap = DisplayTrap(hook=self.displayhook)
513
510
514 def init_reload_doctest(self):
511 def init_reload_doctest(self):
515 # Do a proper resetting of doctest, including the necessary displayhook
512 # Do a proper resetting of doctest, including the necessary displayhook
516 # monkeypatching
513 # monkeypatching
517 try:
514 try:
518 doctest_reload()
515 doctest_reload()
519 except ImportError:
516 except ImportError:
520 warn("doctest module does not exist.")
517 warn("doctest module does not exist.")
521
518
522 #-------------------------------------------------------------------------
519 #-------------------------------------------------------------------------
523 # Things related to injections into the sys module
520 # Things related to injections into the sys module
524 #-------------------------------------------------------------------------
521 #-------------------------------------------------------------------------
525
522
526 def save_sys_module_state(self):
523 def save_sys_module_state(self):
527 """Save the state of hooks in the sys module.
524 """Save the state of hooks in the sys module.
528
525
529 This has to be called after self.user_ns is created.
526 This has to be called after self.user_ns is created.
530 """
527 """
531 self._orig_sys_module_state = {}
528 self._orig_sys_module_state = {}
532 self._orig_sys_module_state['stdin'] = sys.stdin
529 self._orig_sys_module_state['stdin'] = sys.stdin
533 self._orig_sys_module_state['stdout'] = sys.stdout
530 self._orig_sys_module_state['stdout'] = sys.stdout
534 self._orig_sys_module_state['stderr'] = sys.stderr
531 self._orig_sys_module_state['stderr'] = sys.stderr
535 self._orig_sys_module_state['excepthook'] = sys.excepthook
532 self._orig_sys_module_state['excepthook'] = sys.excepthook
536 try:
533 try:
537 self._orig_sys_modules_main_name = self.user_ns['__name__']
534 self._orig_sys_modules_main_name = self.user_ns['__name__']
538 except KeyError:
535 except KeyError:
539 pass
536 pass
540
537
541 def restore_sys_module_state(self):
538 def restore_sys_module_state(self):
542 """Restore the state of the sys module."""
539 """Restore the state of the sys module."""
543 try:
540 try:
544 for k, v in self._orig_sys_module_state.iteritems():
541 for k, v in self._orig_sys_module_state.iteritems():
545 setattr(sys, k, v)
542 setattr(sys, k, v)
546 except AttributeError:
543 except AttributeError:
547 pass
544 pass
548 # Reset what what done in self.init_sys_modules
545 # Reset what what done in self.init_sys_modules
549 try:
546 try:
550 sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name
547 sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name
551 except (AttributeError, KeyError):
548 except (AttributeError, KeyError):
552 pass
549 pass
553
550
554 #-------------------------------------------------------------------------
551 #-------------------------------------------------------------------------
555 # Things related to hooks
552 # Things related to hooks
556 #-------------------------------------------------------------------------
553 #-------------------------------------------------------------------------
557
554
558 def init_hooks(self):
555 def init_hooks(self):
559 # hooks holds pointers used for user-side customizations
556 # hooks holds pointers used for user-side customizations
560 self.hooks = Struct()
557 self.hooks = Struct()
561
558
562 self.strdispatchers = {}
559 self.strdispatchers = {}
563
560
564 # Set all default hooks, defined in the IPython.hooks module.
561 # Set all default hooks, defined in the IPython.hooks module.
565 hooks = IPython.core.hooks
562 hooks = IPython.core.hooks
566 for hook_name in hooks.__all__:
563 for hook_name in hooks.__all__:
567 # default hooks have priority 100, i.e. low; user hooks should have
564 # default hooks have priority 100, i.e. low; user hooks should have
568 # 0-100 priority
565 # 0-100 priority
569 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
566 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
570
567
571 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
568 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
572 """set_hook(name,hook) -> sets an internal IPython hook.
569 """set_hook(name,hook) -> sets an internal IPython hook.
573
570
574 IPython exposes some of its internal API as user-modifiable hooks. By
571 IPython exposes some of its internal API as user-modifiable hooks. By
575 adding your function to one of these hooks, you can modify IPython's
572 adding your function to one of these hooks, you can modify IPython's
576 behavior to call at runtime your own routines."""
573 behavior to call at runtime your own routines."""
577
574
578 # At some point in the future, this should validate the hook before it
575 # At some point in the future, this should validate the hook before it
579 # accepts it. Probably at least check that the hook takes the number
576 # accepts it. Probably at least check that the hook takes the number
580 # of args it's supposed to.
577 # of args it's supposed to.
581
578
582 f = types.MethodType(hook,self)
579 f = types.MethodType(hook,self)
583
580
584 # check if the hook is for strdispatcher first
581 # check if the hook is for strdispatcher first
585 if str_key is not None:
582 if str_key is not None:
586 sdp = self.strdispatchers.get(name, StrDispatch())
583 sdp = self.strdispatchers.get(name, StrDispatch())
587 sdp.add_s(str_key, f, priority )
584 sdp.add_s(str_key, f, priority )
588 self.strdispatchers[name] = sdp
585 self.strdispatchers[name] = sdp
589 return
586 return
590 if re_key is not None:
587 if re_key is not None:
591 sdp = self.strdispatchers.get(name, StrDispatch())
588 sdp = self.strdispatchers.get(name, StrDispatch())
592 sdp.add_re(re.compile(re_key), f, priority )
589 sdp.add_re(re.compile(re_key), f, priority )
593 self.strdispatchers[name] = sdp
590 self.strdispatchers[name] = sdp
594 return
591 return
595
592
596 dp = getattr(self.hooks, name, None)
593 dp = getattr(self.hooks, name, None)
597 if name not in IPython.core.hooks.__all__:
594 if name not in IPython.core.hooks.__all__:
598 print "Warning! Hook '%s' is not one of %s" % \
595 print "Warning! Hook '%s' is not one of %s" % \
599 (name, IPython.core.hooks.__all__ )
596 (name, IPython.core.hooks.__all__ )
600 if not dp:
597 if not dp:
601 dp = IPython.core.hooks.CommandChainDispatcher()
598 dp = IPython.core.hooks.CommandChainDispatcher()
602
599
603 try:
600 try:
604 dp.add(f,priority)
601 dp.add(f,priority)
605 except AttributeError:
602 except AttributeError:
606 # it was not commandchain, plain old func - replace
603 # it was not commandchain, plain old func - replace
607 dp = f
604 dp = f
608
605
609 setattr(self.hooks,name, dp)
606 setattr(self.hooks,name, dp)
610
607
611 def register_post_execute(self, func):
608 def register_post_execute(self, func):
612 """Register a function for calling after code execution.
609 """Register a function for calling after code execution.
613 """
610 """
614 if not callable(func):
611 if not callable(func):
615 raise ValueError('argument %s must be callable' % func)
612 raise ValueError('argument %s must be callable' % func)
616 self._post_execute.add(func)
613 self._post_execute.add(func)
617
614
618 #-------------------------------------------------------------------------
615 #-------------------------------------------------------------------------
619 # Things related to the "main" module
616 # Things related to the "main" module
620 #-------------------------------------------------------------------------
617 #-------------------------------------------------------------------------
621
618
622 def new_main_mod(self,ns=None):
619 def new_main_mod(self,ns=None):
623 """Return a new 'main' module object for user code execution.
620 """Return a new 'main' module object for user code execution.
624 """
621 """
625 main_mod = self._user_main_module
622 main_mod = self._user_main_module
626 init_fakemod_dict(main_mod,ns)
623 init_fakemod_dict(main_mod,ns)
627 return main_mod
624 return main_mod
628
625
629 def cache_main_mod(self,ns,fname):
626 def cache_main_mod(self,ns,fname):
630 """Cache a main module's namespace.
627 """Cache a main module's namespace.
631
628
632 When scripts are executed via %run, we must keep a reference to the
629 When scripts are executed via %run, we must keep a reference to the
633 namespace of their __main__ module (a FakeModule instance) around so
630 namespace of their __main__ module (a FakeModule instance) around so
634 that Python doesn't clear it, rendering objects defined therein
631 that Python doesn't clear it, rendering objects defined therein
635 useless.
632 useless.
636
633
637 This method keeps said reference in a private dict, keyed by the
634 This method keeps said reference in a private dict, keyed by the
638 absolute path of the module object (which corresponds to the script
635 absolute path of the module object (which corresponds to the script
639 path). This way, for multiple executions of the same script we only
636 path). This way, for multiple executions of the same script we only
640 keep one copy of the namespace (the last one), thus preventing memory
637 keep one copy of the namespace (the last one), thus preventing memory
641 leaks from old references while allowing the objects from the last
638 leaks from old references while allowing the objects from the last
642 execution to be accessible.
639 execution to be accessible.
643
640
644 Note: we can not allow the actual FakeModule instances to be deleted,
641 Note: we can not allow the actual FakeModule instances to be deleted,
645 because of how Python tears down modules (it hard-sets all their
642 because of how Python tears down modules (it hard-sets all their
646 references to None without regard for reference counts). This method
643 references to None without regard for reference counts). This method
647 must therefore make a *copy* of the given namespace, to allow the
644 must therefore make a *copy* of the given namespace, to allow the
648 original module's __dict__ to be cleared and reused.
645 original module's __dict__ to be cleared and reused.
649
646
650
647
651 Parameters
648 Parameters
652 ----------
649 ----------
653 ns : a namespace (a dict, typically)
650 ns : a namespace (a dict, typically)
654
651
655 fname : str
652 fname : str
656 Filename associated with the namespace.
653 Filename associated with the namespace.
657
654
658 Examples
655 Examples
659 --------
656 --------
660
657
661 In [10]: import IPython
658 In [10]: import IPython
662
659
663 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
660 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
664
661
665 In [12]: IPython.__file__ in _ip._main_ns_cache
662 In [12]: IPython.__file__ in _ip._main_ns_cache
666 Out[12]: True
663 Out[12]: True
667 """
664 """
668 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
665 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
669
666
670 def clear_main_mod_cache(self):
667 def clear_main_mod_cache(self):
671 """Clear the cache of main modules.
668 """Clear the cache of main modules.
672
669
673 Mainly for use by utilities like %reset.
670 Mainly for use by utilities like %reset.
674
671
675 Examples
672 Examples
676 --------
673 --------
677
674
678 In [15]: import IPython
675 In [15]: import IPython
679
676
680 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
677 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
681
678
682 In [17]: len(_ip._main_ns_cache) > 0
679 In [17]: len(_ip._main_ns_cache) > 0
683 Out[17]: True
680 Out[17]: True
684
681
685 In [18]: _ip.clear_main_mod_cache()
682 In [18]: _ip.clear_main_mod_cache()
686
683
687 In [19]: len(_ip._main_ns_cache) == 0
684 In [19]: len(_ip._main_ns_cache) == 0
688 Out[19]: True
685 Out[19]: True
689 """
686 """
690 self._main_ns_cache.clear()
687 self._main_ns_cache.clear()
691
688
692 #-------------------------------------------------------------------------
689 #-------------------------------------------------------------------------
693 # Things related to debugging
690 # Things related to debugging
694 #-------------------------------------------------------------------------
691 #-------------------------------------------------------------------------
695
692
696 def init_pdb(self):
693 def init_pdb(self):
697 # Set calling of pdb on exceptions
694 # Set calling of pdb on exceptions
698 # self.call_pdb is a property
695 # self.call_pdb is a property
699 self.call_pdb = self.pdb
696 self.call_pdb = self.pdb
700
697
701 def _get_call_pdb(self):
698 def _get_call_pdb(self):
702 return self._call_pdb
699 return self._call_pdb
703
700
704 def _set_call_pdb(self,val):
701 def _set_call_pdb(self,val):
705
702
706 if val not in (0,1,False,True):
703 if val not in (0,1,False,True):
707 raise ValueError,'new call_pdb value must be boolean'
704 raise ValueError,'new call_pdb value must be boolean'
708
705
709 # store value in instance
706 # store value in instance
710 self._call_pdb = val
707 self._call_pdb = val
711
708
712 # notify the actual exception handlers
709 # notify the actual exception handlers
713 self.InteractiveTB.call_pdb = val
710 self.InteractiveTB.call_pdb = val
714
711
715 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
712 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
716 'Control auto-activation of pdb at exceptions')
713 'Control auto-activation of pdb at exceptions')
717
714
718 def debugger(self,force=False):
715 def debugger(self,force=False):
719 """Call the pydb/pdb debugger.
716 """Call the pydb/pdb debugger.
720
717
721 Keywords:
718 Keywords:
722
719
723 - force(False): by default, this routine checks the instance call_pdb
720 - force(False): by default, this routine checks the instance call_pdb
724 flag and does not actually invoke the debugger if the flag is false.
721 flag and does not actually invoke the debugger if the flag is false.
725 The 'force' option forces the debugger to activate even if the flag
722 The 'force' option forces the debugger to activate even if the flag
726 is false.
723 is false.
727 """
724 """
728
725
729 if not (force or self.call_pdb):
726 if not (force or self.call_pdb):
730 return
727 return
731
728
732 if not hasattr(sys,'last_traceback'):
729 if not hasattr(sys,'last_traceback'):
733 error('No traceback has been produced, nothing to debug.')
730 error('No traceback has been produced, nothing to debug.')
734 return
731 return
735
732
736 # use pydb if available
733 # use pydb if available
737 if debugger.has_pydb:
734 if debugger.has_pydb:
738 from pydb import pm
735 from pydb import pm
739 else:
736 else:
740 # fallback to our internal debugger
737 # fallback to our internal debugger
741 pm = lambda : self.InteractiveTB.debugger(force=True)
738 pm = lambda : self.InteractiveTB.debugger(force=True)
742 self.history_saving_wrapper(pm)()
739 self.history_saving_wrapper(pm)()
743
740
744 #-------------------------------------------------------------------------
741 #-------------------------------------------------------------------------
745 # Things related to IPython's various namespaces
742 # Things related to IPython's various namespaces
746 #-------------------------------------------------------------------------
743 #-------------------------------------------------------------------------
747
744
748 def init_create_namespaces(self, user_ns=None, user_global_ns=None):
745 def init_create_namespaces(self, user_ns=None, user_global_ns=None):
749 # Create the namespace where the user will operate. user_ns is
746 # Create the namespace where the user will operate. user_ns is
750 # normally the only one used, and it is passed to the exec calls as
747 # normally the only one used, and it is passed to the exec calls as
751 # the locals argument. But we do carry a user_global_ns namespace
748 # the locals argument. But we do carry a user_global_ns namespace
752 # given as the exec 'globals' argument, This is useful in embedding
749 # given as the exec 'globals' argument, This is useful in embedding
753 # situations where the ipython shell opens in a context where the
750 # situations where the ipython shell opens in a context where the
754 # distinction between locals and globals is meaningful. For
751 # distinction between locals and globals is meaningful. For
755 # non-embedded contexts, it is just the same object as the user_ns dict.
752 # non-embedded contexts, it is just the same object as the user_ns dict.
756
753
757 # FIXME. For some strange reason, __builtins__ is showing up at user
754 # FIXME. For some strange reason, __builtins__ is showing up at user
758 # level as a dict instead of a module. This is a manual fix, but I
755 # level as a dict instead of a module. This is a manual fix, but I
759 # should really track down where the problem is coming from. Alex
756 # should really track down where the problem is coming from. Alex
760 # Schmolck reported this problem first.
757 # Schmolck reported this problem first.
761
758
762 # A useful post by Alex Martelli on this topic:
759 # A useful post by Alex Martelli on this topic:
763 # Re: inconsistent value from __builtins__
760 # Re: inconsistent value from __builtins__
764 # Von: Alex Martelli <aleaxit@yahoo.com>
761 # Von: Alex Martelli <aleaxit@yahoo.com>
765 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
762 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
766 # Gruppen: comp.lang.python
763 # Gruppen: comp.lang.python
767
764
768 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
765 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
769 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
766 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
770 # > <type 'dict'>
767 # > <type 'dict'>
771 # > >>> print type(__builtins__)
768 # > >>> print type(__builtins__)
772 # > <type 'module'>
769 # > <type 'module'>
773 # > Is this difference in return value intentional?
770 # > Is this difference in return value intentional?
774
771
775 # Well, it's documented that '__builtins__' can be either a dictionary
772 # Well, it's documented that '__builtins__' can be either a dictionary
776 # or a module, and it's been that way for a long time. Whether it's
773 # or a module, and it's been that way for a long time. Whether it's
777 # intentional (or sensible), I don't know. In any case, the idea is
774 # intentional (or sensible), I don't know. In any case, the idea is
778 # that if you need to access the built-in namespace directly, you
775 # that if you need to access the built-in namespace directly, you
779 # should start with "import __builtin__" (note, no 's') which will
776 # should start with "import __builtin__" (note, no 's') which will
780 # definitely give you a module. Yeah, it's somewhat confusing:-(.
777 # definitely give you a module. Yeah, it's somewhat confusing:-(.
781
778
782 # These routines return properly built dicts as needed by the rest of
779 # These routines return properly built dicts as needed by the rest of
783 # the code, and can also be used by extension writers to generate
780 # the code, and can also be used by extension writers to generate
784 # properly initialized namespaces.
781 # properly initialized namespaces.
785 user_ns, user_global_ns = self.make_user_namespaces(user_ns,
782 user_ns, user_global_ns = self.make_user_namespaces(user_ns,
786 user_global_ns)
783 user_global_ns)
787
784
788 # Assign namespaces
785 # Assign namespaces
789 # This is the namespace where all normal user variables live
786 # This is the namespace where all normal user variables live
790 self.user_ns = user_ns
787 self.user_ns = user_ns
791 self.user_global_ns = user_global_ns
788 self.user_global_ns = user_global_ns
792
789
793 # An auxiliary namespace that checks what parts of the user_ns were
790 # An auxiliary namespace that checks what parts of the user_ns were
794 # loaded at startup, so we can list later only variables defined in
791 # loaded at startup, so we can list later only variables defined in
795 # actual interactive use. Since it is always a subset of user_ns, it
792 # actual interactive use. Since it is always a subset of user_ns, it
796 # doesn't need to be separately tracked in the ns_table.
793 # doesn't need to be separately tracked in the ns_table.
797 self.user_ns_hidden = {}
794 self.user_ns_hidden = {}
798
795
799 # A namespace to keep track of internal data structures to prevent
796 # A namespace to keep track of internal data structures to prevent
800 # them from cluttering user-visible stuff. Will be updated later
797 # them from cluttering user-visible stuff. Will be updated later
801 self.internal_ns = {}
798 self.internal_ns = {}
802
799
803 # Now that FakeModule produces a real module, we've run into a nasty
800 # Now that FakeModule produces a real module, we've run into a nasty
804 # problem: after script execution (via %run), the module where the user
801 # problem: after script execution (via %run), the module where the user
805 # code ran is deleted. Now that this object is a true module (needed
802 # code ran is deleted. Now that this object is a true module (needed
806 # so docetst and other tools work correctly), the Python module
803 # so docetst and other tools work correctly), the Python module
807 # teardown mechanism runs over it, and sets to None every variable
804 # teardown mechanism runs over it, and sets to None every variable
808 # present in that module. Top-level references to objects from the
805 # present in that module. Top-level references to objects from the
809 # script survive, because the user_ns is updated with them. However,
806 # script survive, because the user_ns is updated with them. However,
810 # calling functions defined in the script that use other things from
807 # calling functions defined in the script that use other things from
811 # the script will fail, because the function's closure had references
808 # the script will fail, because the function's closure had references
812 # to the original objects, which are now all None. So we must protect
809 # to the original objects, which are now all None. So we must protect
813 # these modules from deletion by keeping a cache.
810 # these modules from deletion by keeping a cache.
814 #
811 #
815 # To avoid keeping stale modules around (we only need the one from the
812 # To avoid keeping stale modules around (we only need the one from the
816 # last run), we use a dict keyed with the full path to the script, so
813 # last run), we use a dict keyed with the full path to the script, so
817 # only the last version of the module is held in the cache. Note,
814 # only the last version of the module is held in the cache. Note,
818 # however, that we must cache the module *namespace contents* (their
815 # however, that we must cache the module *namespace contents* (their
819 # __dict__). Because if we try to cache the actual modules, old ones
816 # __dict__). Because if we try to cache the actual modules, old ones
820 # (uncached) could be destroyed while still holding references (such as
817 # (uncached) could be destroyed while still holding references (such as
821 # those held by GUI objects that tend to be long-lived)>
818 # those held by GUI objects that tend to be long-lived)>
822 #
819 #
823 # The %reset command will flush this cache. See the cache_main_mod()
820 # The %reset command will flush this cache. See the cache_main_mod()
824 # and clear_main_mod_cache() methods for details on use.
821 # and clear_main_mod_cache() methods for details on use.
825
822
826 # This is the cache used for 'main' namespaces
823 # This is the cache used for 'main' namespaces
827 self._main_ns_cache = {}
824 self._main_ns_cache = {}
828 # And this is the single instance of FakeModule whose __dict__ we keep
825 # And this is the single instance of FakeModule whose __dict__ we keep
829 # copying and clearing for reuse on each %run
826 # copying and clearing for reuse on each %run
830 self._user_main_module = FakeModule()
827 self._user_main_module = FakeModule()
831
828
832 # A table holding all the namespaces IPython deals with, so that
829 # A table holding all the namespaces IPython deals with, so that
833 # introspection facilities can search easily.
830 # introspection facilities can search easily.
834 self.ns_table = {'user':user_ns,
831 self.ns_table = {'user':user_ns,
835 'user_global':user_global_ns,
832 'user_global':user_global_ns,
836 'internal':self.internal_ns,
833 'internal':self.internal_ns,
837 'builtin':__builtin__.__dict__
834 'builtin':__builtin__.__dict__
838 }
835 }
839
836
840 # Similarly, track all namespaces where references can be held and that
837 # Similarly, track all namespaces where references can be held and that
841 # we can safely clear (so it can NOT include builtin). This one can be
838 # we can safely clear (so it can NOT include builtin). This one can be
842 # a simple list. Note that the main execution namespaces, user_ns and
839 # a simple list. Note that the main execution namespaces, user_ns and
843 # user_global_ns, can NOT be listed here, as clearing them blindly
840 # user_global_ns, can NOT be listed here, as clearing them blindly
844 # causes errors in object __del__ methods. Instead, the reset() method
841 # causes errors in object __del__ methods. Instead, the reset() method
845 # clears them manually and carefully.
842 # clears them manually and carefully.
846 self.ns_refs_table = [ self.user_ns_hidden,
843 self.ns_refs_table = [ self.user_ns_hidden,
847 self.internal_ns, self._main_ns_cache ]
844 self.internal_ns, self._main_ns_cache ]
848
845
849 def make_user_namespaces(self, user_ns=None, user_global_ns=None):
846 def make_user_namespaces(self, user_ns=None, user_global_ns=None):
850 """Return a valid local and global user interactive namespaces.
847 """Return a valid local and global user interactive namespaces.
851
848
852 This builds a dict with the minimal information needed to operate as a
849 This builds a dict with the minimal information needed to operate as a
853 valid IPython user namespace, which you can pass to the various
850 valid IPython user namespace, which you can pass to the various
854 embedding classes in ipython. The default implementation returns the
851 embedding classes in ipython. The default implementation returns the
855 same dict for both the locals and the globals to allow functions to
852 same dict for both the locals and the globals to allow functions to
856 refer to variables in the namespace. Customized implementations can
853 refer to variables in the namespace. Customized implementations can
857 return different dicts. The locals dictionary can actually be anything
854 return different dicts. The locals dictionary can actually be anything
858 following the basic mapping protocol of a dict, but the globals dict
855 following the basic mapping protocol of a dict, but the globals dict
859 must be a true dict, not even a subclass. It is recommended that any
856 must be a true dict, not even a subclass. It is recommended that any
860 custom object for the locals namespace synchronize with the globals
857 custom object for the locals namespace synchronize with the globals
861 dict somehow.
858 dict somehow.
862
859
863 Raises TypeError if the provided globals namespace is not a true dict.
860 Raises TypeError if the provided globals namespace is not a true dict.
864
861
865 Parameters
862 Parameters
866 ----------
863 ----------
867 user_ns : dict-like, optional
864 user_ns : dict-like, optional
868 The current user namespace. The items in this namespace should
865 The current user namespace. The items in this namespace should
869 be included in the output. If None, an appropriate blank
866 be included in the output. If None, an appropriate blank
870 namespace should be created.
867 namespace should be created.
871 user_global_ns : dict, optional
868 user_global_ns : dict, optional
872 The current user global namespace. The items in this namespace
869 The current user global namespace. The items in this namespace
873 should be included in the output. If None, an appropriate
870 should be included in the output. If None, an appropriate
874 blank namespace should be created.
871 blank namespace should be created.
875
872
876 Returns
873 Returns
877 -------
874 -------
878 A pair of dictionary-like object to be used as the local namespace
875 A pair of dictionary-like object to be used as the local namespace
879 of the interpreter and a dict to be used as the global namespace.
876 of the interpreter and a dict to be used as the global namespace.
880 """
877 """
881
878
882
879
883 # We must ensure that __builtin__ (without the final 's') is always
880 # We must ensure that __builtin__ (without the final 's') is always
884 # available and pointing to the __builtin__ *module*. For more details:
881 # available and pointing to the __builtin__ *module*. For more details:
885 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
882 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
886
883
887 if user_ns is None:
884 if user_ns is None:
888 # Set __name__ to __main__ to better match the behavior of the
885 # Set __name__ to __main__ to better match the behavior of the
889 # normal interpreter.
886 # normal interpreter.
890 user_ns = {'__name__' :'__main__',
887 user_ns = {'__name__' :'__main__',
891 '__builtin__' : __builtin__,
888 '__builtin__' : __builtin__,
892 '__builtins__' : __builtin__,
889 '__builtins__' : __builtin__,
893 }
890 }
894 else:
891 else:
895 user_ns.setdefault('__name__','__main__')
892 user_ns.setdefault('__name__','__main__')
896 user_ns.setdefault('__builtin__',__builtin__)
893 user_ns.setdefault('__builtin__',__builtin__)
897 user_ns.setdefault('__builtins__',__builtin__)
894 user_ns.setdefault('__builtins__',__builtin__)
898
895
899 if user_global_ns is None:
896 if user_global_ns is None:
900 user_global_ns = user_ns
897 user_global_ns = user_ns
901 if type(user_global_ns) is not dict:
898 if type(user_global_ns) is not dict:
902 raise TypeError("user_global_ns must be a true dict; got %r"
899 raise TypeError("user_global_ns must be a true dict; got %r"
903 % type(user_global_ns))
900 % type(user_global_ns))
904
901
905 return user_ns, user_global_ns
902 return user_ns, user_global_ns
906
903
907 def init_sys_modules(self):
904 def init_sys_modules(self):
908 # We need to insert into sys.modules something that looks like a
905 # We need to insert into sys.modules something that looks like a
909 # module but which accesses the IPython namespace, for shelve and
906 # module but which accesses the IPython namespace, for shelve and
910 # pickle to work interactively. Normally they rely on getting
907 # pickle to work interactively. Normally they rely on getting
911 # everything out of __main__, but for embedding purposes each IPython
908 # everything out of __main__, but for embedding purposes each IPython
912 # instance has its own private namespace, so we can't go shoving
909 # instance has its own private namespace, so we can't go shoving
913 # everything into __main__.
910 # everything into __main__.
914
911
915 # note, however, that we should only do this for non-embedded
912 # note, however, that we should only do this for non-embedded
916 # ipythons, which really mimic the __main__.__dict__ with their own
913 # ipythons, which really mimic the __main__.__dict__ with their own
917 # namespace. Embedded instances, on the other hand, should not do
914 # namespace. Embedded instances, on the other hand, should not do
918 # this because they need to manage the user local/global namespaces
915 # this because they need to manage the user local/global namespaces
919 # only, but they live within a 'normal' __main__ (meaning, they
916 # only, but they live within a 'normal' __main__ (meaning, they
920 # shouldn't overtake the execution environment of the script they're
917 # shouldn't overtake the execution environment of the script they're
921 # embedded in).
918 # embedded in).
922
919
923 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
920 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
924
921
925 try:
922 try:
926 main_name = self.user_ns['__name__']
923 main_name = self.user_ns['__name__']
927 except KeyError:
924 except KeyError:
928 raise KeyError('user_ns dictionary MUST have a "__name__" key')
925 raise KeyError('user_ns dictionary MUST have a "__name__" key')
929 else:
926 else:
930 sys.modules[main_name] = FakeModule(self.user_ns)
927 sys.modules[main_name] = FakeModule(self.user_ns)
931
928
932 def init_user_ns(self):
929 def init_user_ns(self):
933 """Initialize all user-visible namespaces to their minimum defaults.
930 """Initialize all user-visible namespaces to their minimum defaults.
934
931
935 Certain history lists are also initialized here, as they effectively
932 Certain history lists are also initialized here, as they effectively
936 act as user namespaces.
933 act as user namespaces.
937
934
938 Notes
935 Notes
939 -----
936 -----
940 All data structures here are only filled in, they are NOT reset by this
937 All data structures here are only filled in, they are NOT reset by this
941 method. If they were not empty before, data will simply be added to
938 method. If they were not empty before, data will simply be added to
942 therm.
939 therm.
943 """
940 """
944 # This function works in two parts: first we put a few things in
941 # This function works in two parts: first we put a few things in
945 # user_ns, and we sync that contents into user_ns_hidden so that these
942 # user_ns, and we sync that contents into user_ns_hidden so that these
946 # initial variables aren't shown by %who. After the sync, we add the
943 # initial variables aren't shown by %who. After the sync, we add the
947 # rest of what we *do* want the user to see with %who even on a new
944 # rest of what we *do* want the user to see with %who even on a new
948 # session (probably nothing, so theye really only see their own stuff)
945 # session (probably nothing, so theye really only see their own stuff)
949
946
950 # The user dict must *always* have a __builtin__ reference to the
947 # The user dict must *always* have a __builtin__ reference to the
951 # Python standard __builtin__ namespace, which must be imported.
948 # Python standard __builtin__ namespace, which must be imported.
952 # This is so that certain operations in prompt evaluation can be
949 # This is so that certain operations in prompt evaluation can be
953 # reliably executed with builtins. Note that we can NOT use
950 # reliably executed with builtins. Note that we can NOT use
954 # __builtins__ (note the 's'), because that can either be a dict or a
951 # __builtins__ (note the 's'), because that can either be a dict or a
955 # module, and can even mutate at runtime, depending on the context
952 # module, and can even mutate at runtime, depending on the context
956 # (Python makes no guarantees on it). In contrast, __builtin__ is
953 # (Python makes no guarantees on it). In contrast, __builtin__ is
957 # always a module object, though it must be explicitly imported.
954 # always a module object, though it must be explicitly imported.
958
955
959 # For more details:
956 # For more details:
960 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
957 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
961 ns = dict(__builtin__ = __builtin__)
958 ns = dict(__builtin__ = __builtin__)
962
959
963 # Put 'help' in the user namespace
960 # Put 'help' in the user namespace
964 try:
961 try:
965 from site import _Helper
962 from site import _Helper
966 ns['help'] = _Helper()
963 ns['help'] = _Helper()
967 except ImportError:
964 except ImportError:
968 warn('help() not available - check site.py')
965 warn('help() not available - check site.py')
969
966
970 # make global variables for user access to the histories
967 # make global variables for user access to the histories
971 ns['_ih'] = self.history_manager.input_hist_parsed
968 ns['_ih'] = self.history_manager.input_hist_parsed
972 ns['_oh'] = self.history_manager.output_hist
969 ns['_oh'] = self.history_manager.output_hist
973 ns['_dh'] = self.history_manager.dir_hist
970 ns['_dh'] = self.history_manager.dir_hist
974
971
975 ns['_sh'] = shadowns
972 ns['_sh'] = shadowns
976
973
977 # user aliases to input and output histories. These shouldn't show up
974 # user aliases to input and output histories. These shouldn't show up
978 # in %who, as they can have very large reprs.
975 # in %who, as they can have very large reprs.
979 ns['In'] = self.history_manager.input_hist_parsed
976 ns['In'] = self.history_manager.input_hist_parsed
980 ns['Out'] = self.history_manager.output_hist
977 ns['Out'] = self.history_manager.output_hist
981
978
982 # Store myself as the public api!!!
979 # Store myself as the public api!!!
983 ns['get_ipython'] = self.get_ipython
980 ns['get_ipython'] = self.get_ipython
984
981
985 # Sync what we've added so far to user_ns_hidden so these aren't seen
982 # Sync what we've added so far to user_ns_hidden so these aren't seen
986 # by %who
983 # by %who
987 self.user_ns_hidden.update(ns)
984 self.user_ns_hidden.update(ns)
988
985
989 # Anything put into ns now would show up in %who. Think twice before
986 # Anything put into ns now would show up in %who. Think twice before
990 # putting anything here, as we really want %who to show the user their
987 # putting anything here, as we really want %who to show the user their
991 # stuff, not our variables.
988 # stuff, not our variables.
992
989
993 # Finally, update the real user's namespace
990 # Finally, update the real user's namespace
994 self.user_ns.update(ns)
991 self.user_ns.update(ns)
995
992
996 def reset(self):
993 def reset(self):
997 """Clear all internal namespaces.
994 """Clear all internal namespaces.
998
995
999 Note that this is much more aggressive than %reset, since it clears
996 Note that this is much more aggressive than %reset, since it clears
1000 fully all namespaces, as well as all input/output lists.
997 fully all namespaces, as well as all input/output lists.
1001 """
998 """
1002 # Clear histories
999 # Clear histories
1003 self.history_manager.reset()
1000 self.history_manager.reset()
1004
1001
1005 # Reset counter used to index all histories
1002 # Reset counter used to index all histories
1006 self.execution_count = 0
1003 self.execution_count = 0
1007
1004
1008 # Restore the user namespaces to minimal usability
1005 # Restore the user namespaces to minimal usability
1009 for ns in self.ns_refs_table:
1006 for ns in self.ns_refs_table:
1010 ns.clear()
1007 ns.clear()
1011
1008
1012 # The main execution namespaces must be cleared very carefully,
1009 # The main execution namespaces must be cleared very carefully,
1013 # skipping the deletion of the builtin-related keys, because doing so
1010 # skipping the deletion of the builtin-related keys, because doing so
1014 # would cause errors in many object's __del__ methods.
1011 # would cause errors in many object's __del__ methods.
1015 for ns in [self.user_ns, self.user_global_ns]:
1012 for ns in [self.user_ns, self.user_global_ns]:
1016 drop_keys = set(ns.keys())
1013 drop_keys = set(ns.keys())
1017 drop_keys.discard('__builtin__')
1014 drop_keys.discard('__builtin__')
1018 drop_keys.discard('__builtins__')
1015 drop_keys.discard('__builtins__')
1019 for k in drop_keys:
1016 for k in drop_keys:
1020 del ns[k]
1017 del ns[k]
1021
1018
1022 # Restore the user namespaces to minimal usability
1019 # Restore the user namespaces to minimal usability
1023 self.init_user_ns()
1020 self.init_user_ns()
1024
1021
1025 # Restore the default and user aliases
1022 # Restore the default and user aliases
1026 self.alias_manager.clear_aliases()
1023 self.alias_manager.clear_aliases()
1027 self.alias_manager.init_aliases()
1024 self.alias_manager.init_aliases()
1028
1025
1029 def reset_selective(self, regex=None):
1026 def reset_selective(self, regex=None):
1030 """Clear selective variables from internal namespaces based on a
1027 """Clear selective variables from internal namespaces based on a
1031 specified regular expression.
1028 specified regular expression.
1032
1029
1033 Parameters
1030 Parameters
1034 ----------
1031 ----------
1035 regex : string or compiled pattern, optional
1032 regex : string or compiled pattern, optional
1036 A regular expression pattern that will be used in searching
1033 A regular expression pattern that will be used in searching
1037 variable names in the users namespaces.
1034 variable names in the users namespaces.
1038 """
1035 """
1039 if regex is not None:
1036 if regex is not None:
1040 try:
1037 try:
1041 m = re.compile(regex)
1038 m = re.compile(regex)
1042 except TypeError:
1039 except TypeError:
1043 raise TypeError('regex must be a string or compiled pattern')
1040 raise TypeError('regex must be a string or compiled pattern')
1044 # Search for keys in each namespace that match the given regex
1041 # Search for keys in each namespace that match the given regex
1045 # If a match is found, delete the key/value pair.
1042 # If a match is found, delete the key/value pair.
1046 for ns in self.ns_refs_table:
1043 for ns in self.ns_refs_table:
1047 for var in ns:
1044 for var in ns:
1048 if m.search(var):
1045 if m.search(var):
1049 del ns[var]
1046 del ns[var]
1050
1047
1051 def push(self, variables, interactive=True):
1048 def push(self, variables, interactive=True):
1052 """Inject a group of variables into the IPython user namespace.
1049 """Inject a group of variables into the IPython user namespace.
1053
1050
1054 Parameters
1051 Parameters
1055 ----------
1052 ----------
1056 variables : dict, str or list/tuple of str
1053 variables : dict, str or list/tuple of str
1057 The variables to inject into the user's namespace. If a dict, a
1054 The variables to inject into the user's namespace. If a dict, a
1058 simple update is done. If a str, the string is assumed to have
1055 simple update is done. If a str, the string is assumed to have
1059 variable names separated by spaces. A list/tuple of str can also
1056 variable names separated by spaces. A list/tuple of str can also
1060 be used to give the variable names. If just the variable names are
1057 be used to give the variable names. If just the variable names are
1061 give (list/tuple/str) then the variable values looked up in the
1058 give (list/tuple/str) then the variable values looked up in the
1062 callers frame.
1059 callers frame.
1063 interactive : bool
1060 interactive : bool
1064 If True (default), the variables will be listed with the ``who``
1061 If True (default), the variables will be listed with the ``who``
1065 magic.
1062 magic.
1066 """
1063 """
1067 vdict = None
1064 vdict = None
1068
1065
1069 # We need a dict of name/value pairs to do namespace updates.
1066 # We need a dict of name/value pairs to do namespace updates.
1070 if isinstance(variables, dict):
1067 if isinstance(variables, dict):
1071 vdict = variables
1068 vdict = variables
1072 elif isinstance(variables, (basestring, list, tuple)):
1069 elif isinstance(variables, (basestring, list, tuple)):
1073 if isinstance(variables, basestring):
1070 if isinstance(variables, basestring):
1074 vlist = variables.split()
1071 vlist = variables.split()
1075 else:
1072 else:
1076 vlist = variables
1073 vlist = variables
1077 vdict = {}
1074 vdict = {}
1078 cf = sys._getframe(1)
1075 cf = sys._getframe(1)
1079 for name in vlist:
1076 for name in vlist:
1080 try:
1077 try:
1081 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1078 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1082 except:
1079 except:
1083 print ('Could not get variable %s from %s' %
1080 print ('Could not get variable %s from %s' %
1084 (name,cf.f_code.co_name))
1081 (name,cf.f_code.co_name))
1085 else:
1082 else:
1086 raise ValueError('variables must be a dict/str/list/tuple')
1083 raise ValueError('variables must be a dict/str/list/tuple')
1087
1084
1088 # Propagate variables to user namespace
1085 # Propagate variables to user namespace
1089 self.user_ns.update(vdict)
1086 self.user_ns.update(vdict)
1090
1087
1091 # And configure interactive visibility
1088 # And configure interactive visibility
1092 config_ns = self.user_ns_hidden
1089 config_ns = self.user_ns_hidden
1093 if interactive:
1090 if interactive:
1094 for name, val in vdict.iteritems():
1091 for name, val in vdict.iteritems():
1095 config_ns.pop(name, None)
1092 config_ns.pop(name, None)
1096 else:
1093 else:
1097 for name,val in vdict.iteritems():
1094 for name,val in vdict.iteritems():
1098 config_ns[name] = val
1095 config_ns[name] = val
1099
1096
1100 #-------------------------------------------------------------------------
1097 #-------------------------------------------------------------------------
1101 # Things related to object introspection
1098 # Things related to object introspection
1102 #-------------------------------------------------------------------------
1099 #-------------------------------------------------------------------------
1103
1100
1104 def _ofind(self, oname, namespaces=None):
1101 def _ofind(self, oname, namespaces=None):
1105 """Find an object in the available namespaces.
1102 """Find an object in the available namespaces.
1106
1103
1107 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1104 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1108
1105
1109 Has special code to detect magic functions.
1106 Has special code to detect magic functions.
1110 """
1107 """
1111 #oname = oname.strip()
1108 #oname = oname.strip()
1112 #print '1- oname: <%r>' % oname # dbg
1109 #print '1- oname: <%r>' % oname # dbg
1113 try:
1110 try:
1114 oname = oname.strip().encode('ascii')
1111 oname = oname.strip().encode('ascii')
1115 #print '2- oname: <%r>' % oname # dbg
1112 #print '2- oname: <%r>' % oname # dbg
1116 except UnicodeEncodeError:
1113 except UnicodeEncodeError:
1117 print 'Python identifiers can only contain ascii characters.'
1114 print 'Python identifiers can only contain ascii characters.'
1118 return dict(found=False)
1115 return dict(found=False)
1119
1116
1120 alias_ns = None
1117 alias_ns = None
1121 if namespaces is None:
1118 if namespaces is None:
1122 # Namespaces to search in:
1119 # Namespaces to search in:
1123 # Put them in a list. The order is important so that we
1120 # Put them in a list. The order is important so that we
1124 # find things in the same order that Python finds them.
1121 # find things in the same order that Python finds them.
1125 namespaces = [ ('Interactive', self.user_ns),
1122 namespaces = [ ('Interactive', self.user_ns),
1126 ('IPython internal', self.internal_ns),
1123 ('IPython internal', self.internal_ns),
1127 ('Python builtin', __builtin__.__dict__),
1124 ('Python builtin', __builtin__.__dict__),
1128 ('Alias', self.alias_manager.alias_table),
1125 ('Alias', self.alias_manager.alias_table),
1129 ]
1126 ]
1130 alias_ns = self.alias_manager.alias_table
1127 alias_ns = self.alias_manager.alias_table
1131
1128
1132 # initialize results to 'null'
1129 # initialize results to 'null'
1133 found = False; obj = None; ospace = None; ds = None;
1130 found = False; obj = None; ospace = None; ds = None;
1134 ismagic = False; isalias = False; parent = None
1131 ismagic = False; isalias = False; parent = None
1135
1132
1136 # We need to special-case 'print', which as of python2.6 registers as a
1133 # We need to special-case 'print', which as of python2.6 registers as a
1137 # function but should only be treated as one if print_function was
1134 # function but should only be treated as one if print_function was
1138 # loaded with a future import. In this case, just bail.
1135 # loaded with a future import. In this case, just bail.
1139 if (oname == 'print' and not (self.compile.compiler_flags &
1136 if (oname == 'print' and not (self.compile.compiler_flags &
1140 __future__.CO_FUTURE_PRINT_FUNCTION)):
1137 __future__.CO_FUTURE_PRINT_FUNCTION)):
1141 return {'found':found, 'obj':obj, 'namespace':ospace,
1138 return {'found':found, 'obj':obj, 'namespace':ospace,
1142 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1139 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1143
1140
1144 # Look for the given name by splitting it in parts. If the head is
1141 # Look for the given name by splitting it in parts. If the head is
1145 # found, then we look for all the remaining parts as members, and only
1142 # found, then we look for all the remaining parts as members, and only
1146 # declare success if we can find them all.
1143 # declare success if we can find them all.
1147 oname_parts = oname.split('.')
1144 oname_parts = oname.split('.')
1148 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1145 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1149 for nsname,ns in namespaces:
1146 for nsname,ns in namespaces:
1150 try:
1147 try:
1151 obj = ns[oname_head]
1148 obj = ns[oname_head]
1152 except KeyError:
1149 except KeyError:
1153 continue
1150 continue
1154 else:
1151 else:
1155 #print 'oname_rest:', oname_rest # dbg
1152 #print 'oname_rest:', oname_rest # dbg
1156 for part in oname_rest:
1153 for part in oname_rest:
1157 try:
1154 try:
1158 parent = obj
1155 parent = obj
1159 obj = getattr(obj,part)
1156 obj = getattr(obj,part)
1160 except:
1157 except:
1161 # Blanket except b/c some badly implemented objects
1158 # Blanket except b/c some badly implemented objects
1162 # allow __getattr__ to raise exceptions other than
1159 # allow __getattr__ to raise exceptions other than
1163 # AttributeError, which then crashes IPython.
1160 # AttributeError, which then crashes IPython.
1164 break
1161 break
1165 else:
1162 else:
1166 # If we finish the for loop (no break), we got all members
1163 # If we finish the for loop (no break), we got all members
1167 found = True
1164 found = True
1168 ospace = nsname
1165 ospace = nsname
1169 if ns == alias_ns:
1166 if ns == alias_ns:
1170 isalias = True
1167 isalias = True
1171 break # namespace loop
1168 break # namespace loop
1172
1169
1173 # Try to see if it's magic
1170 # Try to see if it's magic
1174 if not found:
1171 if not found:
1175 if oname.startswith(ESC_MAGIC):
1172 if oname.startswith(ESC_MAGIC):
1176 oname = oname[1:]
1173 oname = oname[1:]
1177 obj = getattr(self,'magic_'+oname,None)
1174 obj = getattr(self,'magic_'+oname,None)
1178 if obj is not None:
1175 if obj is not None:
1179 found = True
1176 found = True
1180 ospace = 'IPython internal'
1177 ospace = 'IPython internal'
1181 ismagic = True
1178 ismagic = True
1182
1179
1183 # Last try: special-case some literals like '', [], {}, etc:
1180 # Last try: special-case some literals like '', [], {}, etc:
1184 if not found and oname_head in ["''",'""','[]','{}','()']:
1181 if not found and oname_head in ["''",'""','[]','{}','()']:
1185 obj = eval(oname_head)
1182 obj = eval(oname_head)
1186 found = True
1183 found = True
1187 ospace = 'Interactive'
1184 ospace = 'Interactive'
1188
1185
1189 return {'found':found, 'obj':obj, 'namespace':ospace,
1186 return {'found':found, 'obj':obj, 'namespace':ospace,
1190 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1187 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1191
1188
1192 def _ofind_property(self, oname, info):
1189 def _ofind_property(self, oname, info):
1193 """Second part of object finding, to look for property details."""
1190 """Second part of object finding, to look for property details."""
1194 if info.found:
1191 if info.found:
1195 # Get the docstring of the class property if it exists.
1192 # Get the docstring of the class property if it exists.
1196 path = oname.split('.')
1193 path = oname.split('.')
1197 root = '.'.join(path[:-1])
1194 root = '.'.join(path[:-1])
1198 if info.parent is not None:
1195 if info.parent is not None:
1199 try:
1196 try:
1200 target = getattr(info.parent, '__class__')
1197 target = getattr(info.parent, '__class__')
1201 # The object belongs to a class instance.
1198 # The object belongs to a class instance.
1202 try:
1199 try:
1203 target = getattr(target, path[-1])
1200 target = getattr(target, path[-1])
1204 # The class defines the object.
1201 # The class defines the object.
1205 if isinstance(target, property):
1202 if isinstance(target, property):
1206 oname = root + '.__class__.' + path[-1]
1203 oname = root + '.__class__.' + path[-1]
1207 info = Struct(self._ofind(oname))
1204 info = Struct(self._ofind(oname))
1208 except AttributeError: pass
1205 except AttributeError: pass
1209 except AttributeError: pass
1206 except AttributeError: pass
1210
1207
1211 # We return either the new info or the unmodified input if the object
1208 # We return either the new info or the unmodified input if the object
1212 # hadn't been found
1209 # hadn't been found
1213 return info
1210 return info
1214
1211
1215 def _object_find(self, oname, namespaces=None):
1212 def _object_find(self, oname, namespaces=None):
1216 """Find an object and return a struct with info about it."""
1213 """Find an object and return a struct with info about it."""
1217 inf = Struct(self._ofind(oname, namespaces))
1214 inf = Struct(self._ofind(oname, namespaces))
1218 return Struct(self._ofind_property(oname, inf))
1215 return Struct(self._ofind_property(oname, inf))
1219
1216
1220 def _inspect(self, meth, oname, namespaces=None, **kw):
1217 def _inspect(self, meth, oname, namespaces=None, **kw):
1221 """Generic interface to the inspector system.
1218 """Generic interface to the inspector system.
1222
1219
1223 This function is meant to be called by pdef, pdoc & friends."""
1220 This function is meant to be called by pdef, pdoc & friends."""
1224 info = self._object_find(oname)
1221 info = self._object_find(oname)
1225 if info.found:
1222 if info.found:
1226 pmethod = getattr(self.inspector, meth)
1223 pmethod = getattr(self.inspector, meth)
1227 formatter = format_screen if info.ismagic else None
1224 formatter = format_screen if info.ismagic else None
1228 if meth == 'pdoc':
1225 if meth == 'pdoc':
1229 pmethod(info.obj, oname, formatter)
1226 pmethod(info.obj, oname, formatter)
1230 elif meth == 'pinfo':
1227 elif meth == 'pinfo':
1231 pmethod(info.obj, oname, formatter, info, **kw)
1228 pmethod(info.obj, oname, formatter, info, **kw)
1232 else:
1229 else:
1233 pmethod(info.obj, oname)
1230 pmethod(info.obj, oname)
1234 else:
1231 else:
1235 print 'Object `%s` not found.' % oname
1232 print 'Object `%s` not found.' % oname
1236 return 'not found' # so callers can take other action
1233 return 'not found' # so callers can take other action
1237
1234
1238 def object_inspect(self, oname):
1235 def object_inspect(self, oname):
1239 info = self._object_find(oname)
1236 info = self._object_find(oname)
1240 if info.found:
1237 if info.found:
1241 return self.inspector.info(info.obj, oname, info=info)
1238 return self.inspector.info(info.obj, oname, info=info)
1242 else:
1239 else:
1243 return oinspect.object_info(name=oname, found=False)
1240 return oinspect.object_info(name=oname, found=False)
1244
1241
1245 #-------------------------------------------------------------------------
1242 #-------------------------------------------------------------------------
1246 # Things related to history management
1243 # Things related to history management
1247 #-------------------------------------------------------------------------
1244 #-------------------------------------------------------------------------
1248
1245
1249 def init_history(self):
1246 def init_history(self):
1250 """Sets up the command history, and starts regular autosaves."""
1247 """Sets up the command history, and starts regular autosaves."""
1251 self.history_manager = HistoryManager(shell=self, load_history=True)
1248 self.history_manager = HistoryManager(shell=self)
1252
1253 def save_history(self):
1254 """Save input history to a file (via readline library)."""
1255 self.history_manager.save_history()
1256
1257 def reload_history(self):
1258 """Reload the input history from disk file."""
1259 self.history_manager.reload_history()
1260
1249
1261 def history_saving_wrapper(self, func):
1250 def history_saving_wrapper(self, func):
1262 """ Wrap func for readline history saving
1251 """ Wrap func for readline history saving
1263
1252
1264 Convert func into callable that saves & restores
1253 Convert func into callable that saves & restores
1265 history around the call """
1254 history around the call """
1266
1255
1267 if self.has_readline:
1256 if self.has_readline:
1268 from IPython.utils import rlineimpl as readline
1257 from IPython.utils import rlineimpl as readline
1269 else:
1258 else:
1270 return func
1259 return func
1271
1260
1272 def wrapper():
1261 def wrapper():
1273 self.save_history()
1262 self.save_history()
1274 try:
1263 try:
1275 func()
1264 func()
1276 finally:
1265 finally:
1277 self.reload_history()
1266 self.reload_history()
1278 return wrapper
1267 return wrapper
1279
1268
1280 def get_history(self, index=None, raw=False, output=True,this_session=True):
1269 def get_history(self, start=1, stop=None, raw=False, output=True):
1281 return self.history_manager.get_history(index, raw, output,this_session)
1270 return self.history_manager.get_history(start, stop, raw, output)
1282
1271
1283
1272
1284 #-------------------------------------------------------------------------
1273 #-------------------------------------------------------------------------
1285 # Things related to exception handling and tracebacks (not debugging)
1274 # Things related to exception handling and tracebacks (not debugging)
1286 #-------------------------------------------------------------------------
1275 #-------------------------------------------------------------------------
1287
1276
1288 def init_traceback_handlers(self, custom_exceptions):
1277 def init_traceback_handlers(self, custom_exceptions):
1289 # Syntax error handler.
1278 # Syntax error handler.
1290 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1279 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1291
1280
1292 # The interactive one is initialized with an offset, meaning we always
1281 # The interactive one is initialized with an offset, meaning we always
1293 # want to remove the topmost item in the traceback, which is our own
1282 # want to remove the topmost item in the traceback, which is our own
1294 # internal code. Valid modes: ['Plain','Context','Verbose']
1283 # internal code. Valid modes: ['Plain','Context','Verbose']
1295 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1284 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1296 color_scheme='NoColor',
1285 color_scheme='NoColor',
1297 tb_offset = 1,
1286 tb_offset = 1,
1298 check_cache=self.compile.check_cache)
1287 check_cache=self.compile.check_cache)
1299
1288
1300 # The instance will store a pointer to the system-wide exception hook,
1289 # The instance will store a pointer to the system-wide exception hook,
1301 # so that runtime code (such as magics) can access it. This is because
1290 # so that runtime code (such as magics) can access it. This is because
1302 # during the read-eval loop, it may get temporarily overwritten.
1291 # during the read-eval loop, it may get temporarily overwritten.
1303 self.sys_excepthook = sys.excepthook
1292 self.sys_excepthook = sys.excepthook
1304
1293
1305 # and add any custom exception handlers the user may have specified
1294 # and add any custom exception handlers the user may have specified
1306 self.set_custom_exc(*custom_exceptions)
1295 self.set_custom_exc(*custom_exceptions)
1307
1296
1308 # Set the exception mode
1297 # Set the exception mode
1309 self.InteractiveTB.set_mode(mode=self.xmode)
1298 self.InteractiveTB.set_mode(mode=self.xmode)
1310
1299
1311 def set_custom_exc(self, exc_tuple, handler):
1300 def set_custom_exc(self, exc_tuple, handler):
1312 """set_custom_exc(exc_tuple,handler)
1301 """set_custom_exc(exc_tuple,handler)
1313
1302
1314 Set a custom exception handler, which will be called if any of the
1303 Set a custom exception handler, which will be called if any of the
1315 exceptions in exc_tuple occur in the mainloop (specifically, in the
1304 exceptions in exc_tuple occur in the mainloop (specifically, in the
1316 run_code() method.
1305 run_code() method.
1317
1306
1318 Inputs:
1307 Inputs:
1319
1308
1320 - exc_tuple: a *tuple* of valid exceptions to call the defined
1309 - exc_tuple: a *tuple* of valid exceptions to call the defined
1321 handler for. It is very important that you use a tuple, and NOT A
1310 handler for. It is very important that you use a tuple, and NOT A
1322 LIST here, because of the way Python's except statement works. If
1311 LIST here, because of the way Python's except statement works. If
1323 you only want to trap a single exception, use a singleton tuple:
1312 you only want to trap a single exception, use a singleton tuple:
1324
1313
1325 exc_tuple == (MyCustomException,)
1314 exc_tuple == (MyCustomException,)
1326
1315
1327 - handler: this must be defined as a function with the following
1316 - handler: this must be defined as a function with the following
1328 basic interface::
1317 basic interface::
1329
1318
1330 def my_handler(self, etype, value, tb, tb_offset=None)
1319 def my_handler(self, etype, value, tb, tb_offset=None)
1331 ...
1320 ...
1332 # The return value must be
1321 # The return value must be
1333 return structured_traceback
1322 return structured_traceback
1334
1323
1335 This will be made into an instance method (via types.MethodType)
1324 This will be made into an instance method (via types.MethodType)
1336 of IPython itself, and it will be called if any of the exceptions
1325 of IPython itself, and it will be called if any of the exceptions
1337 listed in the exc_tuple are caught. If the handler is None, an
1326 listed in the exc_tuple are caught. If the handler is None, an
1338 internal basic one is used, which just prints basic info.
1327 internal basic one is used, which just prints basic info.
1339
1328
1340 WARNING: by putting in your own exception handler into IPython's main
1329 WARNING: by putting in your own exception handler into IPython's main
1341 execution loop, you run a very good chance of nasty crashes. This
1330 execution loop, you run a very good chance of nasty crashes. This
1342 facility should only be used if you really know what you are doing."""
1331 facility should only be used if you really know what you are doing."""
1343
1332
1344 assert type(exc_tuple)==type(()) , \
1333 assert type(exc_tuple)==type(()) , \
1345 "The custom exceptions must be given AS A TUPLE."
1334 "The custom exceptions must be given AS A TUPLE."
1346
1335
1347 def dummy_handler(self,etype,value,tb):
1336 def dummy_handler(self,etype,value,tb):
1348 print '*** Simple custom exception handler ***'
1337 print '*** Simple custom exception handler ***'
1349 print 'Exception type :',etype
1338 print 'Exception type :',etype
1350 print 'Exception value:',value
1339 print 'Exception value:',value
1351 print 'Traceback :',tb
1340 print 'Traceback :',tb
1352 print 'Source code :','\n'.join(self.buffer)
1341 print 'Source code :','\n'.join(self.buffer)
1353
1342
1354 if handler is None: handler = dummy_handler
1343 if handler is None: handler = dummy_handler
1355
1344
1356 self.CustomTB = types.MethodType(handler,self)
1345 self.CustomTB = types.MethodType(handler,self)
1357 self.custom_exceptions = exc_tuple
1346 self.custom_exceptions = exc_tuple
1358
1347
1359 def excepthook(self, etype, value, tb):
1348 def excepthook(self, etype, value, tb):
1360 """One more defense for GUI apps that call sys.excepthook.
1349 """One more defense for GUI apps that call sys.excepthook.
1361
1350
1362 GUI frameworks like wxPython trap exceptions and call
1351 GUI frameworks like wxPython trap exceptions and call
1363 sys.excepthook themselves. I guess this is a feature that
1352 sys.excepthook themselves. I guess this is a feature that
1364 enables them to keep running after exceptions that would
1353 enables them to keep running after exceptions that would
1365 otherwise kill their mainloop. This is a bother for IPython
1354 otherwise kill their mainloop. This is a bother for IPython
1366 which excepts to catch all of the program exceptions with a try:
1355 which excepts to catch all of the program exceptions with a try:
1367 except: statement.
1356 except: statement.
1368
1357
1369 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1358 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1370 any app directly invokes sys.excepthook, it will look to the user like
1359 any app directly invokes sys.excepthook, it will look to the user like
1371 IPython crashed. In order to work around this, we can disable the
1360 IPython crashed. In order to work around this, we can disable the
1372 CrashHandler and replace it with this excepthook instead, which prints a
1361 CrashHandler and replace it with this excepthook instead, which prints a
1373 regular traceback using our InteractiveTB. In this fashion, apps which
1362 regular traceback using our InteractiveTB. In this fashion, apps which
1374 call sys.excepthook will generate a regular-looking exception from
1363 call sys.excepthook will generate a regular-looking exception from
1375 IPython, and the CrashHandler will only be triggered by real IPython
1364 IPython, and the CrashHandler will only be triggered by real IPython
1376 crashes.
1365 crashes.
1377
1366
1378 This hook should be used sparingly, only in places which are not likely
1367 This hook should be used sparingly, only in places which are not likely
1379 to be true IPython errors.
1368 to be true IPython errors.
1380 """
1369 """
1381 self.showtraceback((etype,value,tb),tb_offset=0)
1370 self.showtraceback((etype,value,tb),tb_offset=0)
1382
1371
1383 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1372 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1384 exception_only=False):
1373 exception_only=False):
1385 """Display the exception that just occurred.
1374 """Display the exception that just occurred.
1386
1375
1387 If nothing is known about the exception, this is the method which
1376 If nothing is known about the exception, this is the method which
1388 should be used throughout the code for presenting user tracebacks,
1377 should be used throughout the code for presenting user tracebacks,
1389 rather than directly invoking the InteractiveTB object.
1378 rather than directly invoking the InteractiveTB object.
1390
1379
1391 A specific showsyntaxerror() also exists, but this method can take
1380 A specific showsyntaxerror() also exists, but this method can take
1392 care of calling it if needed, so unless you are explicitly catching a
1381 care of calling it if needed, so unless you are explicitly catching a
1393 SyntaxError exception, don't try to analyze the stack manually and
1382 SyntaxError exception, don't try to analyze the stack manually and
1394 simply call this method."""
1383 simply call this method."""
1395
1384
1396 try:
1385 try:
1397 if exc_tuple is None:
1386 if exc_tuple is None:
1398 etype, value, tb = sys.exc_info()
1387 etype, value, tb = sys.exc_info()
1399 else:
1388 else:
1400 etype, value, tb = exc_tuple
1389 etype, value, tb = exc_tuple
1401
1390
1402 if etype is None:
1391 if etype is None:
1403 if hasattr(sys, 'last_type'):
1392 if hasattr(sys, 'last_type'):
1404 etype, value, tb = sys.last_type, sys.last_value, \
1393 etype, value, tb = sys.last_type, sys.last_value, \
1405 sys.last_traceback
1394 sys.last_traceback
1406 else:
1395 else:
1407 self.write_err('No traceback available to show.\n')
1396 self.write_err('No traceback available to show.\n')
1408 return
1397 return
1409
1398
1410 if etype is SyntaxError:
1399 if etype is SyntaxError:
1411 # Though this won't be called by syntax errors in the input
1400 # Though this won't be called by syntax errors in the input
1412 # line, there may be SyntaxError cases whith imported code.
1401 # line, there may be SyntaxError cases whith imported code.
1413 self.showsyntaxerror(filename)
1402 self.showsyntaxerror(filename)
1414 elif etype is UsageError:
1403 elif etype is UsageError:
1415 print "UsageError:", value
1404 print "UsageError:", value
1416 else:
1405 else:
1417 # WARNING: these variables are somewhat deprecated and not
1406 # WARNING: these variables are somewhat deprecated and not
1418 # necessarily safe to use in a threaded environment, but tools
1407 # necessarily safe to use in a threaded environment, but tools
1419 # like pdb depend on their existence, so let's set them. If we
1408 # like pdb depend on their existence, so let's set them. If we
1420 # find problems in the field, we'll need to revisit their use.
1409 # find problems in the field, we'll need to revisit their use.
1421 sys.last_type = etype
1410 sys.last_type = etype
1422 sys.last_value = value
1411 sys.last_value = value
1423 sys.last_traceback = tb
1412 sys.last_traceback = tb
1424
1413
1425 if etype in self.custom_exceptions:
1414 if etype in self.custom_exceptions:
1426 # FIXME: Old custom traceback objects may just return a
1415 # FIXME: Old custom traceback objects may just return a
1427 # string, in that case we just put it into a list
1416 # string, in that case we just put it into a list
1428 stb = self.CustomTB(etype, value, tb, tb_offset)
1417 stb = self.CustomTB(etype, value, tb, tb_offset)
1429 if isinstance(ctb, basestring):
1418 if isinstance(ctb, basestring):
1430 stb = [stb]
1419 stb = [stb]
1431 else:
1420 else:
1432 if exception_only:
1421 if exception_only:
1433 stb = ['An exception has occurred, use %tb to see '
1422 stb = ['An exception has occurred, use %tb to see '
1434 'the full traceback.\n']
1423 'the full traceback.\n']
1435 stb.extend(self.InteractiveTB.get_exception_only(etype,
1424 stb.extend(self.InteractiveTB.get_exception_only(etype,
1436 value))
1425 value))
1437 else:
1426 else:
1438 stb = self.InteractiveTB.structured_traceback(etype,
1427 stb = self.InteractiveTB.structured_traceback(etype,
1439 value, tb, tb_offset=tb_offset)
1428 value, tb, tb_offset=tb_offset)
1440 # FIXME: the pdb calling should be done by us, not by
1429 # FIXME: the pdb calling should be done by us, not by
1441 # the code computing the traceback.
1430 # the code computing the traceback.
1442 if self.InteractiveTB.call_pdb:
1431 if self.InteractiveTB.call_pdb:
1443 # pdb mucks up readline, fix it back
1432 # pdb mucks up readline, fix it back
1444 self.set_readline_completer()
1433 self.set_readline_completer()
1445
1434
1446 # Actually show the traceback
1435 # Actually show the traceback
1447 self._showtraceback(etype, value, stb)
1436 self._showtraceback(etype, value, stb)
1448
1437
1449 except KeyboardInterrupt:
1438 except KeyboardInterrupt:
1450 self.write_err("\nKeyboardInterrupt\n")
1439 self.write_err("\nKeyboardInterrupt\n")
1451
1440
1452 def _showtraceback(self, etype, evalue, stb):
1441 def _showtraceback(self, etype, evalue, stb):
1453 """Actually show a traceback.
1442 """Actually show a traceback.
1454
1443
1455 Subclasses may override this method to put the traceback on a different
1444 Subclasses may override this method to put the traceback on a different
1456 place, like a side channel.
1445 place, like a side channel.
1457 """
1446 """
1458 print >> io.Term.cout, self.InteractiveTB.stb2text(stb)
1447 print >> io.Term.cout, self.InteractiveTB.stb2text(stb)
1459
1448
1460 def showsyntaxerror(self, filename=None):
1449 def showsyntaxerror(self, filename=None):
1461 """Display the syntax error that just occurred.
1450 """Display the syntax error that just occurred.
1462
1451
1463 This doesn't display a stack trace because there isn't one.
1452 This doesn't display a stack trace because there isn't one.
1464
1453
1465 If a filename is given, it is stuffed in the exception instead
1454 If a filename is given, it is stuffed in the exception instead
1466 of what was there before (because Python's parser always uses
1455 of what was there before (because Python's parser always uses
1467 "<string>" when reading from a string).
1456 "<string>" when reading from a string).
1468 """
1457 """
1469 etype, value, last_traceback = sys.exc_info()
1458 etype, value, last_traceback = sys.exc_info()
1470
1459
1471 # See note about these variables in showtraceback() above
1460 # See note about these variables in showtraceback() above
1472 sys.last_type = etype
1461 sys.last_type = etype
1473 sys.last_value = value
1462 sys.last_value = value
1474 sys.last_traceback = last_traceback
1463 sys.last_traceback = last_traceback
1475
1464
1476 if filename and etype is SyntaxError:
1465 if filename and etype is SyntaxError:
1477 # Work hard to stuff the correct filename in the exception
1466 # Work hard to stuff the correct filename in the exception
1478 try:
1467 try:
1479 msg, (dummy_filename, lineno, offset, line) = value
1468 msg, (dummy_filename, lineno, offset, line) = value
1480 except:
1469 except:
1481 # Not the format we expect; leave it alone
1470 # Not the format we expect; leave it alone
1482 pass
1471 pass
1483 else:
1472 else:
1484 # Stuff in the right filename
1473 # Stuff in the right filename
1485 try:
1474 try:
1486 # Assume SyntaxError is a class exception
1475 # Assume SyntaxError is a class exception
1487 value = SyntaxError(msg, (filename, lineno, offset, line))
1476 value = SyntaxError(msg, (filename, lineno, offset, line))
1488 except:
1477 except:
1489 # If that failed, assume SyntaxError is a string
1478 # If that failed, assume SyntaxError is a string
1490 value = msg, (filename, lineno, offset, line)
1479 value = msg, (filename, lineno, offset, line)
1491 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1480 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1492 self._showtraceback(etype, value, stb)
1481 self._showtraceback(etype, value, stb)
1493
1482
1494 #-------------------------------------------------------------------------
1483 #-------------------------------------------------------------------------
1495 # Things related to readline
1484 # Things related to readline
1496 #-------------------------------------------------------------------------
1485 #-------------------------------------------------------------------------
1497
1486
1498 def init_readline(self):
1487 def init_readline(self):
1499 """Command history completion/saving/reloading."""
1488 """Command history completion/saving/reloading."""
1500
1489
1501 if self.readline_use:
1490 if self.readline_use:
1502 import IPython.utils.rlineimpl as readline
1491 import IPython.utils.rlineimpl as readline
1503
1492
1504 self.rl_next_input = None
1493 self.rl_next_input = None
1505 self.rl_do_indent = False
1494 self.rl_do_indent = False
1506
1495
1507 if not self.readline_use or not readline.have_readline:
1496 if not self.readline_use or not readline.have_readline:
1508 self.has_readline = False
1497 self.has_readline = False
1509 self.readline = None
1498 self.readline = None
1510 # Set a number of methods that depend on readline to be no-op
1499 # Set a number of methods that depend on readline to be no-op
1511 self.set_readline_completer = no_op
1500 self.set_readline_completer = no_op
1512 self.set_custom_completer = no_op
1501 self.set_custom_completer = no_op
1513 self.set_completer_frame = no_op
1502 self.set_completer_frame = no_op
1514 warn('Readline services not available or not loaded.')
1503 warn('Readline services not available or not loaded.')
1515 else:
1504 else:
1516 self.has_readline = True
1505 self.has_readline = True
1517 self.readline = readline
1506 self.readline = readline
1518 sys.modules['readline'] = readline
1507 sys.modules['readline'] = readline
1519
1508
1520 # Platform-specific configuration
1509 # Platform-specific configuration
1521 if os.name == 'nt':
1510 if os.name == 'nt':
1522 # FIXME - check with Frederick to see if we can harmonize
1511 # FIXME - check with Frederick to see if we can harmonize
1523 # naming conventions with pyreadline to avoid this
1512 # naming conventions with pyreadline to avoid this
1524 # platform-dependent check
1513 # platform-dependent check
1525 self.readline_startup_hook = readline.set_pre_input_hook
1514 self.readline_startup_hook = readline.set_pre_input_hook
1526 else:
1515 else:
1527 self.readline_startup_hook = readline.set_startup_hook
1516 self.readline_startup_hook = readline.set_startup_hook
1528
1517
1529 # Load user's initrc file (readline config)
1518 # Load user's initrc file (readline config)
1530 # Or if libedit is used, load editrc.
1519 # Or if libedit is used, load editrc.
1531 inputrc_name = os.environ.get('INPUTRC')
1520 inputrc_name = os.environ.get('INPUTRC')
1532 if inputrc_name is None:
1521 if inputrc_name is None:
1533 home_dir = get_home_dir()
1522 home_dir = get_home_dir()
1534 if home_dir is not None:
1523 if home_dir is not None:
1535 inputrc_name = '.inputrc'
1524 inputrc_name = '.inputrc'
1536 if readline.uses_libedit:
1525 if readline.uses_libedit:
1537 inputrc_name = '.editrc'
1526 inputrc_name = '.editrc'
1538 inputrc_name = os.path.join(home_dir, inputrc_name)
1527 inputrc_name = os.path.join(home_dir, inputrc_name)
1539 if os.path.isfile(inputrc_name):
1528 if os.path.isfile(inputrc_name):
1540 try:
1529 try:
1541 readline.read_init_file(inputrc_name)
1530 readline.read_init_file(inputrc_name)
1542 except:
1531 except:
1543 warn('Problems reading readline initialization file <%s>'
1532 warn('Problems reading readline initialization file <%s>'
1544 % inputrc_name)
1533 % inputrc_name)
1545
1534
1546 # Configure readline according to user's prefs
1535 # Configure readline according to user's prefs
1547 # This is only done if GNU readline is being used. If libedit
1536 # This is only done if GNU readline is being used. If libedit
1548 # is being used (as on Leopard) the readline config is
1537 # is being used (as on Leopard) the readline config is
1549 # not run as the syntax for libedit is different.
1538 # not run as the syntax for libedit is different.
1550 if not readline.uses_libedit:
1539 if not readline.uses_libedit:
1551 for rlcommand in self.readline_parse_and_bind:
1540 for rlcommand in self.readline_parse_and_bind:
1552 #print "loading rl:",rlcommand # dbg
1541 #print "loading rl:",rlcommand # dbg
1553 readline.parse_and_bind(rlcommand)
1542 readline.parse_and_bind(rlcommand)
1554
1543
1555 # Remove some chars from the delimiters list. If we encounter
1544 # Remove some chars from the delimiters list. If we encounter
1556 # unicode chars, discard them.
1545 # unicode chars, discard them.
1557 delims = readline.get_completer_delims().encode("ascii", "ignore")
1546 delims = readline.get_completer_delims().encode("ascii", "ignore")
1558 delims = delims.translate(None, self.readline_remove_delims)
1547 delims = delims.translate(None, self.readline_remove_delims)
1559 delims = delims.replace(ESC_MAGIC, '')
1548 delims = delims.replace(ESC_MAGIC, '')
1560 readline.set_completer_delims(delims)
1549 readline.set_completer_delims(delims)
1561 # otherwise we end up with a monster history after a while:
1550 # otherwise we end up with a monster history after a while:
1562 readline.set_history_length(self.history_length)
1551 readline.set_history_length(self.history_length)
1563
1552
1564 self.history_manager.populate_readline_history()
1553 # Load the last 1000 lines from history
1554 for cell in self.history_manager.tail_db_history(1000):
1555 if cell.strip(): # Ignore blank lines
1556 for line in cell.splitlines():
1557 readline.add_history(line)
1565
1558
1566 # Configure auto-indent for all platforms
1559 # Configure auto-indent for all platforms
1567 self.set_autoindent(self.autoindent)
1560 self.set_autoindent(self.autoindent)
1568
1561
1569 def set_next_input(self, s):
1562 def set_next_input(self, s):
1570 """ Sets the 'default' input string for the next command line.
1563 """ Sets the 'default' input string for the next command line.
1571
1564
1572 Requires readline.
1565 Requires readline.
1573
1566
1574 Example:
1567 Example:
1575
1568
1576 [D:\ipython]|1> _ip.set_next_input("Hello Word")
1569 [D:\ipython]|1> _ip.set_next_input("Hello Word")
1577 [D:\ipython]|2> Hello Word_ # cursor is here
1570 [D:\ipython]|2> Hello Word_ # cursor is here
1578 """
1571 """
1579
1572
1580 self.rl_next_input = s
1573 self.rl_next_input = s
1581
1574
1582 # Maybe move this to the terminal subclass?
1575 # Maybe move this to the terminal subclass?
1583 def pre_readline(self):
1576 def pre_readline(self):
1584 """readline hook to be used at the start of each line.
1577 """readline hook to be used at the start of each line.
1585
1578
1586 Currently it handles auto-indent only."""
1579 Currently it handles auto-indent only."""
1587
1580
1588 if self.rl_do_indent:
1581 if self.rl_do_indent:
1589 self.readline.insert_text(self._indent_current_str())
1582 self.readline.insert_text(self._indent_current_str())
1590 if self.rl_next_input is not None:
1583 if self.rl_next_input is not None:
1591 self.readline.insert_text(self.rl_next_input)
1584 self.readline.insert_text(self.rl_next_input)
1592 self.rl_next_input = None
1585 self.rl_next_input = None
1593
1586
1594 def _indent_current_str(self):
1587 def _indent_current_str(self):
1595 """return the current level of indentation as a string"""
1588 """return the current level of indentation as a string"""
1596 return self.input_splitter.indent_spaces * ' '
1589 return self.input_splitter.indent_spaces * ' '
1597
1590
1598 #-------------------------------------------------------------------------
1591 #-------------------------------------------------------------------------
1599 # Things related to text completion
1592 # Things related to text completion
1600 #-------------------------------------------------------------------------
1593 #-------------------------------------------------------------------------
1601
1594
1602 def init_completer(self):
1595 def init_completer(self):
1603 """Initialize the completion machinery.
1596 """Initialize the completion machinery.
1604
1597
1605 This creates completion machinery that can be used by client code,
1598 This creates completion machinery that can be used by client code,
1606 either interactively in-process (typically triggered by the readline
1599 either interactively in-process (typically triggered by the readline
1607 library), programatically (such as in test suites) or out-of-prcess
1600 library), programatically (such as in test suites) or out-of-prcess
1608 (typically over the network by remote frontends).
1601 (typically over the network by remote frontends).
1609 """
1602 """
1610 from IPython.core.completer import IPCompleter
1603 from IPython.core.completer import IPCompleter
1611 from IPython.core.completerlib import (module_completer,
1604 from IPython.core.completerlib import (module_completer,
1612 magic_run_completer, cd_completer)
1605 magic_run_completer, cd_completer)
1613
1606
1614 self.Completer = IPCompleter(self,
1607 self.Completer = IPCompleter(self,
1615 self.user_ns,
1608 self.user_ns,
1616 self.user_global_ns,
1609 self.user_global_ns,
1617 self.readline_omit__names,
1610 self.readline_omit__names,
1618 self.alias_manager.alias_table,
1611 self.alias_manager.alias_table,
1619 self.has_readline)
1612 self.has_readline)
1620
1613
1621 # Add custom completers to the basic ones built into IPCompleter
1614 # Add custom completers to the basic ones built into IPCompleter
1622 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1615 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1623 self.strdispatchers['complete_command'] = sdisp
1616 self.strdispatchers['complete_command'] = sdisp
1624 self.Completer.custom_completers = sdisp
1617 self.Completer.custom_completers = sdisp
1625
1618
1626 self.set_hook('complete_command', module_completer, str_key = 'import')
1619 self.set_hook('complete_command', module_completer, str_key = 'import')
1627 self.set_hook('complete_command', module_completer, str_key = 'from')
1620 self.set_hook('complete_command', module_completer, str_key = 'from')
1628 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1621 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1629 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1622 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1630
1623
1631 # Only configure readline if we truly are using readline. IPython can
1624 # Only configure readline if we truly are using readline. IPython can
1632 # do tab-completion over the network, in GUIs, etc, where readline
1625 # do tab-completion over the network, in GUIs, etc, where readline
1633 # itself may be absent
1626 # itself may be absent
1634 if self.has_readline:
1627 if self.has_readline:
1635 self.set_readline_completer()
1628 self.set_readline_completer()
1636
1629
1637 def complete(self, text, line=None, cursor_pos=None):
1630 def complete(self, text, line=None, cursor_pos=None):
1638 """Return the completed text and a list of completions.
1631 """Return the completed text and a list of completions.
1639
1632
1640 Parameters
1633 Parameters
1641 ----------
1634 ----------
1642
1635
1643 text : string
1636 text : string
1644 A string of text to be completed on. It can be given as empty and
1637 A string of text to be completed on. It can be given as empty and
1645 instead a line/position pair are given. In this case, the
1638 instead a line/position pair are given. In this case, the
1646 completer itself will split the line like readline does.
1639 completer itself will split the line like readline does.
1647
1640
1648 line : string, optional
1641 line : string, optional
1649 The complete line that text is part of.
1642 The complete line that text is part of.
1650
1643
1651 cursor_pos : int, optional
1644 cursor_pos : int, optional
1652 The position of the cursor on the input line.
1645 The position of the cursor on the input line.
1653
1646
1654 Returns
1647 Returns
1655 -------
1648 -------
1656 text : string
1649 text : string
1657 The actual text that was completed.
1650 The actual text that was completed.
1658
1651
1659 matches : list
1652 matches : list
1660 A sorted list with all possible completions.
1653 A sorted list with all possible completions.
1661
1654
1662 The optional arguments allow the completion to take more context into
1655 The optional arguments allow the completion to take more context into
1663 account, and are part of the low-level completion API.
1656 account, and are part of the low-level completion API.
1664
1657
1665 This is a wrapper around the completion mechanism, similar to what
1658 This is a wrapper around the completion mechanism, similar to what
1666 readline does at the command line when the TAB key is hit. By
1659 readline does at the command line when the TAB key is hit. By
1667 exposing it as a method, it can be used by other non-readline
1660 exposing it as a method, it can be used by other non-readline
1668 environments (such as GUIs) for text completion.
1661 environments (such as GUIs) for text completion.
1669
1662
1670 Simple usage example:
1663 Simple usage example:
1671
1664
1672 In [1]: x = 'hello'
1665 In [1]: x = 'hello'
1673
1666
1674 In [2]: _ip.complete('x.l')
1667 In [2]: _ip.complete('x.l')
1675 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1668 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1676 """
1669 """
1677
1670
1678 # Inject names into __builtin__ so we can complete on the added names.
1671 # Inject names into __builtin__ so we can complete on the added names.
1679 with self.builtin_trap:
1672 with self.builtin_trap:
1680 return self.Completer.complete(text, line, cursor_pos)
1673 return self.Completer.complete(text, line, cursor_pos)
1681
1674
1682 def set_custom_completer(self, completer, pos=0):
1675 def set_custom_completer(self, completer, pos=0):
1683 """Adds a new custom completer function.
1676 """Adds a new custom completer function.
1684
1677
1685 The position argument (defaults to 0) is the index in the completers
1678 The position argument (defaults to 0) is the index in the completers
1686 list where you want the completer to be inserted."""
1679 list where you want the completer to be inserted."""
1687
1680
1688 newcomp = types.MethodType(completer,self.Completer)
1681 newcomp = types.MethodType(completer,self.Completer)
1689 self.Completer.matchers.insert(pos,newcomp)
1682 self.Completer.matchers.insert(pos,newcomp)
1690
1683
1691 def set_readline_completer(self):
1684 def set_readline_completer(self):
1692 """Reset readline's completer to be our own."""
1685 """Reset readline's completer to be our own."""
1693 self.readline.set_completer(self.Completer.rlcomplete)
1686 self.readline.set_completer(self.Completer.rlcomplete)
1694
1687
1695 def set_completer_frame(self, frame=None):
1688 def set_completer_frame(self, frame=None):
1696 """Set the frame of the completer."""
1689 """Set the frame of the completer."""
1697 if frame:
1690 if frame:
1698 self.Completer.namespace = frame.f_locals
1691 self.Completer.namespace = frame.f_locals
1699 self.Completer.global_namespace = frame.f_globals
1692 self.Completer.global_namespace = frame.f_globals
1700 else:
1693 else:
1701 self.Completer.namespace = self.user_ns
1694 self.Completer.namespace = self.user_ns
1702 self.Completer.global_namespace = self.user_global_ns
1695 self.Completer.global_namespace = self.user_global_ns
1703
1696
1704 #-------------------------------------------------------------------------
1697 #-------------------------------------------------------------------------
1705 # Things related to magics
1698 # Things related to magics
1706 #-------------------------------------------------------------------------
1699 #-------------------------------------------------------------------------
1707
1700
1708 def init_magics(self):
1701 def init_magics(self):
1709 # FIXME: Move the color initialization to the DisplayHook, which
1702 # FIXME: Move the color initialization to the DisplayHook, which
1710 # should be split into a prompt manager and displayhook. We probably
1703 # should be split into a prompt manager and displayhook. We probably
1711 # even need a centralize colors management object.
1704 # even need a centralize colors management object.
1712 self.magic_colors(self.colors)
1705 self.magic_colors(self.colors)
1713 # History was moved to a separate module
1706 # History was moved to a separate module
1714 from . import history
1707 from . import history
1715 history.init_ipython(self)
1708 history.init_ipython(self)
1716
1709
1717 def magic(self,arg_s):
1710 def magic(self,arg_s):
1718 """Call a magic function by name.
1711 """Call a magic function by name.
1719
1712
1720 Input: a string containing the name of the magic function to call and
1713 Input: a string containing the name of the magic function to call and
1721 any additional arguments to be passed to the magic.
1714 any additional arguments to be passed to the magic.
1722
1715
1723 magic('name -opt foo bar') is equivalent to typing at the ipython
1716 magic('name -opt foo bar') is equivalent to typing at the ipython
1724 prompt:
1717 prompt:
1725
1718
1726 In[1]: %name -opt foo bar
1719 In[1]: %name -opt foo bar
1727
1720
1728 To call a magic without arguments, simply use magic('name').
1721 To call a magic without arguments, simply use magic('name').
1729
1722
1730 This provides a proper Python function to call IPython's magics in any
1723 This provides a proper Python function to call IPython's magics in any
1731 valid Python code you can type at the interpreter, including loops and
1724 valid Python code you can type at the interpreter, including loops and
1732 compound statements.
1725 compound statements.
1733 """
1726 """
1734 args = arg_s.split(' ',1)
1727 args = arg_s.split(' ',1)
1735 magic_name = args[0]
1728 magic_name = args[0]
1736 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
1729 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
1737
1730
1738 try:
1731 try:
1739 magic_args = args[1]
1732 magic_args = args[1]
1740 except IndexError:
1733 except IndexError:
1741 magic_args = ''
1734 magic_args = ''
1742 fn = getattr(self,'magic_'+magic_name,None)
1735 fn = getattr(self,'magic_'+magic_name,None)
1743 if fn is None:
1736 if fn is None:
1744 error("Magic function `%s` not found." % magic_name)
1737 error("Magic function `%s` not found." % magic_name)
1745 else:
1738 else:
1746 magic_args = self.var_expand(magic_args,1)
1739 magic_args = self.var_expand(magic_args,1)
1747 with nested(self.builtin_trap,):
1740 with nested(self.builtin_trap,):
1748 result = fn(magic_args)
1741 result = fn(magic_args)
1749 return result
1742 return result
1750
1743
1751 def define_magic(self, magicname, func):
1744 def define_magic(self, magicname, func):
1752 """Expose own function as magic function for ipython
1745 """Expose own function as magic function for ipython
1753
1746
1754 def foo_impl(self,parameter_s=''):
1747 def foo_impl(self,parameter_s=''):
1755 'My very own magic!. (Use docstrings, IPython reads them).'
1748 'My very own magic!. (Use docstrings, IPython reads them).'
1756 print 'Magic function. Passed parameter is between < >:'
1749 print 'Magic function. Passed parameter is between < >:'
1757 print '<%s>' % parameter_s
1750 print '<%s>' % parameter_s
1758 print 'The self object is:',self
1751 print 'The self object is:',self
1759
1752
1760 self.define_magic('foo',foo_impl)
1753 self.define_magic('foo',foo_impl)
1761 """
1754 """
1762
1755
1763 import new
1756 import new
1764 im = types.MethodType(func,self)
1757 im = types.MethodType(func,self)
1765 old = getattr(self, "magic_" + magicname, None)
1758 old = getattr(self, "magic_" + magicname, None)
1766 setattr(self, "magic_" + magicname, im)
1759 setattr(self, "magic_" + magicname, im)
1767 return old
1760 return old
1768
1761
1769 #-------------------------------------------------------------------------
1762 #-------------------------------------------------------------------------
1770 # Things related to macros
1763 # Things related to macros
1771 #-------------------------------------------------------------------------
1764 #-------------------------------------------------------------------------
1772
1765
1773 def define_macro(self, name, themacro):
1766 def define_macro(self, name, themacro):
1774 """Define a new macro
1767 """Define a new macro
1775
1768
1776 Parameters
1769 Parameters
1777 ----------
1770 ----------
1778 name : str
1771 name : str
1779 The name of the macro.
1772 The name of the macro.
1780 themacro : str or Macro
1773 themacro : str or Macro
1781 The action to do upon invoking the macro. If a string, a new
1774 The action to do upon invoking the macro. If a string, a new
1782 Macro object is created by passing the string to it.
1775 Macro object is created by passing the string to it.
1783 """
1776 """
1784
1777
1785 from IPython.core import macro
1778 from IPython.core import macro
1786
1779
1787 if isinstance(themacro, basestring):
1780 if isinstance(themacro, basestring):
1788 themacro = macro.Macro(themacro)
1781 themacro = macro.Macro(themacro)
1789 if not isinstance(themacro, macro.Macro):
1782 if not isinstance(themacro, macro.Macro):
1790 raise ValueError('A macro must be a string or a Macro instance.')
1783 raise ValueError('A macro must be a string or a Macro instance.')
1791 self.user_ns[name] = themacro
1784 self.user_ns[name] = themacro
1792
1785
1793 #-------------------------------------------------------------------------
1786 #-------------------------------------------------------------------------
1794 # Things related to the running of system commands
1787 # Things related to the running of system commands
1795 #-------------------------------------------------------------------------
1788 #-------------------------------------------------------------------------
1796
1789
1797 def system(self, cmd):
1790 def system(self, cmd):
1798 """Call the given cmd in a subprocess.
1791 """Call the given cmd in a subprocess.
1799
1792
1800 Parameters
1793 Parameters
1801 ----------
1794 ----------
1802 cmd : str
1795 cmd : str
1803 Command to execute (can not end in '&', as bacground processes are
1796 Command to execute (can not end in '&', as bacground processes are
1804 not supported.
1797 not supported.
1805 """
1798 """
1806 # We do not support backgrounding processes because we either use
1799 # We do not support backgrounding processes because we either use
1807 # pexpect or pipes to read from. Users can always just call
1800 # pexpect or pipes to read from. Users can always just call
1808 # os.system() if they really want a background process.
1801 # os.system() if they really want a background process.
1809 if cmd.endswith('&'):
1802 if cmd.endswith('&'):
1810 raise OSError("Background processes not supported.")
1803 raise OSError("Background processes not supported.")
1811
1804
1812 return system(self.var_expand(cmd, depth=2))
1805 return system(self.var_expand(cmd, depth=2))
1813
1806
1814 def getoutput(self, cmd, split=True):
1807 def getoutput(self, cmd, split=True):
1815 """Get output (possibly including stderr) from a subprocess.
1808 """Get output (possibly including stderr) from a subprocess.
1816
1809
1817 Parameters
1810 Parameters
1818 ----------
1811 ----------
1819 cmd : str
1812 cmd : str
1820 Command to execute (can not end in '&', as background processes are
1813 Command to execute (can not end in '&', as background processes are
1821 not supported.
1814 not supported.
1822 split : bool, optional
1815 split : bool, optional
1823
1816
1824 If True, split the output into an IPython SList. Otherwise, an
1817 If True, split the output into an IPython SList. Otherwise, an
1825 IPython LSString is returned. These are objects similar to normal
1818 IPython LSString is returned. These are objects similar to normal
1826 lists and strings, with a few convenience attributes for easier
1819 lists and strings, with a few convenience attributes for easier
1827 manipulation of line-based output. You can use '?' on them for
1820 manipulation of line-based output. You can use '?' on them for
1828 details.
1821 details.
1829 """
1822 """
1830 if cmd.endswith('&'):
1823 if cmd.endswith('&'):
1831 raise OSError("Background processes not supported.")
1824 raise OSError("Background processes not supported.")
1832 out = getoutput(self.var_expand(cmd, depth=2))
1825 out = getoutput(self.var_expand(cmd, depth=2))
1833 if split:
1826 if split:
1834 out = SList(out.splitlines())
1827 out = SList(out.splitlines())
1835 else:
1828 else:
1836 out = LSString(out)
1829 out = LSString(out)
1837 return out
1830 return out
1838
1831
1839 #-------------------------------------------------------------------------
1832 #-------------------------------------------------------------------------
1840 # Things related to aliases
1833 # Things related to aliases
1841 #-------------------------------------------------------------------------
1834 #-------------------------------------------------------------------------
1842
1835
1843 def init_alias(self):
1836 def init_alias(self):
1844 self.alias_manager = AliasManager(shell=self, config=self.config)
1837 self.alias_manager = AliasManager(shell=self, config=self.config)
1845 self.ns_table['alias'] = self.alias_manager.alias_table,
1838 self.ns_table['alias'] = self.alias_manager.alias_table,
1846
1839
1847 #-------------------------------------------------------------------------
1840 #-------------------------------------------------------------------------
1848 # Things related to extensions and plugins
1841 # Things related to extensions and plugins
1849 #-------------------------------------------------------------------------
1842 #-------------------------------------------------------------------------
1850
1843
1851 def init_extension_manager(self):
1844 def init_extension_manager(self):
1852 self.extension_manager = ExtensionManager(shell=self, config=self.config)
1845 self.extension_manager = ExtensionManager(shell=self, config=self.config)
1853
1846
1854 def init_plugin_manager(self):
1847 def init_plugin_manager(self):
1855 self.plugin_manager = PluginManager(config=self.config)
1848 self.plugin_manager = PluginManager(config=self.config)
1856
1849
1857 #-------------------------------------------------------------------------
1850 #-------------------------------------------------------------------------
1858 # Things related to payloads
1851 # Things related to payloads
1859 #-------------------------------------------------------------------------
1852 #-------------------------------------------------------------------------
1860
1853
1861 def init_payload(self):
1854 def init_payload(self):
1862 self.payload_manager = PayloadManager(config=self.config)
1855 self.payload_manager = PayloadManager(config=self.config)
1863
1856
1864 #-------------------------------------------------------------------------
1857 #-------------------------------------------------------------------------
1865 # Things related to the prefilter
1858 # Things related to the prefilter
1866 #-------------------------------------------------------------------------
1859 #-------------------------------------------------------------------------
1867
1860
1868 def init_prefilter(self):
1861 def init_prefilter(self):
1869 self.prefilter_manager = PrefilterManager(shell=self, config=self.config)
1862 self.prefilter_manager = PrefilterManager(shell=self, config=self.config)
1870 # Ultimately this will be refactored in the new interpreter code, but
1863 # Ultimately this will be refactored in the new interpreter code, but
1871 # for now, we should expose the main prefilter method (there's legacy
1864 # for now, we should expose the main prefilter method (there's legacy
1872 # code out there that may rely on this).
1865 # code out there that may rely on this).
1873 self.prefilter = self.prefilter_manager.prefilter_lines
1866 self.prefilter = self.prefilter_manager.prefilter_lines
1874
1867
1875 def auto_rewrite_input(self, cmd):
1868 def auto_rewrite_input(self, cmd):
1876 """Print to the screen the rewritten form of the user's command.
1869 """Print to the screen the rewritten form of the user's command.
1877
1870
1878 This shows visual feedback by rewriting input lines that cause
1871 This shows visual feedback by rewriting input lines that cause
1879 automatic calling to kick in, like::
1872 automatic calling to kick in, like::
1880
1873
1881 /f x
1874 /f x
1882
1875
1883 into::
1876 into::
1884
1877
1885 ------> f(x)
1878 ------> f(x)
1886
1879
1887 after the user's input prompt. This helps the user understand that the
1880 after the user's input prompt. This helps the user understand that the
1888 input line was transformed automatically by IPython.
1881 input line was transformed automatically by IPython.
1889 """
1882 """
1890 rw = self.displayhook.prompt1.auto_rewrite() + cmd
1883 rw = self.displayhook.prompt1.auto_rewrite() + cmd
1891
1884
1892 try:
1885 try:
1893 # plain ascii works better w/ pyreadline, on some machines, so
1886 # plain ascii works better w/ pyreadline, on some machines, so
1894 # we use it and only print uncolored rewrite if we have unicode
1887 # we use it and only print uncolored rewrite if we have unicode
1895 rw = str(rw)
1888 rw = str(rw)
1896 print >> IPython.utils.io.Term.cout, rw
1889 print >> IPython.utils.io.Term.cout, rw
1897 except UnicodeEncodeError:
1890 except UnicodeEncodeError:
1898 print "------> " + cmd
1891 print "------> " + cmd
1899
1892
1900 #-------------------------------------------------------------------------
1893 #-------------------------------------------------------------------------
1901 # Things related to extracting values/expressions from kernel and user_ns
1894 # Things related to extracting values/expressions from kernel and user_ns
1902 #-------------------------------------------------------------------------
1895 #-------------------------------------------------------------------------
1903
1896
1904 def _simple_error(self):
1897 def _simple_error(self):
1905 etype, value = sys.exc_info()[:2]
1898 etype, value = sys.exc_info()[:2]
1906 return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value)
1899 return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value)
1907
1900
1908 def user_variables(self, names):
1901 def user_variables(self, names):
1909 """Get a list of variable names from the user's namespace.
1902 """Get a list of variable names from the user's namespace.
1910
1903
1911 Parameters
1904 Parameters
1912 ----------
1905 ----------
1913 names : list of strings
1906 names : list of strings
1914 A list of names of variables to be read from the user namespace.
1907 A list of names of variables to be read from the user namespace.
1915
1908
1916 Returns
1909 Returns
1917 -------
1910 -------
1918 A dict, keyed by the input names and with the repr() of each value.
1911 A dict, keyed by the input names and with the repr() of each value.
1919 """
1912 """
1920 out = {}
1913 out = {}
1921 user_ns = self.user_ns
1914 user_ns = self.user_ns
1922 for varname in names:
1915 for varname in names:
1923 try:
1916 try:
1924 value = repr(user_ns[varname])
1917 value = repr(user_ns[varname])
1925 except:
1918 except:
1926 value = self._simple_error()
1919 value = self._simple_error()
1927 out[varname] = value
1920 out[varname] = value
1928 return out
1921 return out
1929
1922
1930 def user_expressions(self, expressions):
1923 def user_expressions(self, expressions):
1931 """Evaluate a dict of expressions in the user's namespace.
1924 """Evaluate a dict of expressions in the user's namespace.
1932
1925
1933 Parameters
1926 Parameters
1934 ----------
1927 ----------
1935 expressions : dict
1928 expressions : dict
1936 A dict with string keys and string values. The expression values
1929 A dict with string keys and string values. The expression values
1937 should be valid Python expressions, each of which will be evaluated
1930 should be valid Python expressions, each of which will be evaluated
1938 in the user namespace.
1931 in the user namespace.
1939
1932
1940 Returns
1933 Returns
1941 -------
1934 -------
1942 A dict, keyed like the input expressions dict, with the repr() of each
1935 A dict, keyed like the input expressions dict, with the repr() of each
1943 value.
1936 value.
1944 """
1937 """
1945 out = {}
1938 out = {}
1946 user_ns = self.user_ns
1939 user_ns = self.user_ns
1947 global_ns = self.user_global_ns
1940 global_ns = self.user_global_ns
1948 for key, expr in expressions.iteritems():
1941 for key, expr in expressions.iteritems():
1949 try:
1942 try:
1950 value = repr(eval(expr, global_ns, user_ns))
1943 value = repr(eval(expr, global_ns, user_ns))
1951 except:
1944 except:
1952 value = self._simple_error()
1945 value = self._simple_error()
1953 out[key] = value
1946 out[key] = value
1954 return out
1947 return out
1955
1948
1956 #-------------------------------------------------------------------------
1949 #-------------------------------------------------------------------------
1957 # Things related to the running of code
1950 # Things related to the running of code
1958 #-------------------------------------------------------------------------
1951 #-------------------------------------------------------------------------
1959
1952
1960 def ex(self, cmd):
1953 def ex(self, cmd):
1961 """Execute a normal python statement in user namespace."""
1954 """Execute a normal python statement in user namespace."""
1962 with nested(self.builtin_trap,):
1955 with nested(self.builtin_trap,):
1963 exec cmd in self.user_global_ns, self.user_ns
1956 exec cmd in self.user_global_ns, self.user_ns
1964
1957
1965 def ev(self, expr):
1958 def ev(self, expr):
1966 """Evaluate python expression expr in user namespace.
1959 """Evaluate python expression expr in user namespace.
1967
1960
1968 Returns the result of evaluation
1961 Returns the result of evaluation
1969 """
1962 """
1970 with nested(self.builtin_trap,):
1963 with nested(self.builtin_trap,):
1971 return eval(expr, self.user_global_ns, self.user_ns)
1964 return eval(expr, self.user_global_ns, self.user_ns)
1972
1965
1973 def safe_execfile(self, fname, *where, **kw):
1966 def safe_execfile(self, fname, *where, **kw):
1974 """A safe version of the builtin execfile().
1967 """A safe version of the builtin execfile().
1975
1968
1976 This version will never throw an exception, but instead print
1969 This version will never throw an exception, but instead print
1977 helpful error messages to the screen. This only works on pure
1970 helpful error messages to the screen. This only works on pure
1978 Python files with the .py extension.
1971 Python files with the .py extension.
1979
1972
1980 Parameters
1973 Parameters
1981 ----------
1974 ----------
1982 fname : string
1975 fname : string
1983 The name of the file to be executed.
1976 The name of the file to be executed.
1984 where : tuple
1977 where : tuple
1985 One or two namespaces, passed to execfile() as (globals,locals).
1978 One or two namespaces, passed to execfile() as (globals,locals).
1986 If only one is given, it is passed as both.
1979 If only one is given, it is passed as both.
1987 exit_ignore : bool (False)
1980 exit_ignore : bool (False)
1988 If True, then silence SystemExit for non-zero status (it is always
1981 If True, then silence SystemExit for non-zero status (it is always
1989 silenced for zero status, as it is so common).
1982 silenced for zero status, as it is so common).
1990 """
1983 """
1991 kw.setdefault('exit_ignore', False)
1984 kw.setdefault('exit_ignore', False)
1992
1985
1993 fname = os.path.abspath(os.path.expanduser(fname))
1986 fname = os.path.abspath(os.path.expanduser(fname))
1994
1987
1995 # Make sure we have a .py file
1988 # Make sure we have a .py file
1996 if not fname.endswith('.py'):
1989 if not fname.endswith('.py'):
1997 warn('File must end with .py to be run using execfile: <%s>' % fname)
1990 warn('File must end with .py to be run using execfile: <%s>' % fname)
1998
1991
1999 # Make sure we can open the file
1992 # Make sure we can open the file
2000 try:
1993 try:
2001 with open(fname) as thefile:
1994 with open(fname) as thefile:
2002 pass
1995 pass
2003 except:
1996 except:
2004 warn('Could not open file <%s> for safe execution.' % fname)
1997 warn('Could not open file <%s> for safe execution.' % fname)
2005 return
1998 return
2006
1999
2007 # Find things also in current directory. This is needed to mimic the
2000 # Find things also in current directory. This is needed to mimic the
2008 # behavior of running a script from the system command line, where
2001 # behavior of running a script from the system command line, where
2009 # Python inserts the script's directory into sys.path
2002 # Python inserts the script's directory into sys.path
2010 dname = os.path.dirname(fname)
2003 dname = os.path.dirname(fname)
2011
2004
2012 with prepended_to_syspath(dname):
2005 with prepended_to_syspath(dname):
2013 try:
2006 try:
2014 execfile(fname,*where)
2007 execfile(fname,*where)
2015 except SystemExit, status:
2008 except SystemExit, status:
2016 # If the call was made with 0 or None exit status (sys.exit(0)
2009 # If the call was made with 0 or None exit status (sys.exit(0)
2017 # or sys.exit() ), don't bother showing a traceback, as both of
2010 # or sys.exit() ), don't bother showing a traceback, as both of
2018 # these are considered normal by the OS:
2011 # these are considered normal by the OS:
2019 # > python -c'import sys;sys.exit(0)'; echo $?
2012 # > python -c'import sys;sys.exit(0)'; echo $?
2020 # 0
2013 # 0
2021 # > python -c'import sys;sys.exit()'; echo $?
2014 # > python -c'import sys;sys.exit()'; echo $?
2022 # 0
2015 # 0
2023 # For other exit status, we show the exception unless
2016 # For other exit status, we show the exception unless
2024 # explicitly silenced, but only in short form.
2017 # explicitly silenced, but only in short form.
2025 if status.code not in (0, None) and not kw['exit_ignore']:
2018 if status.code not in (0, None) and not kw['exit_ignore']:
2026 self.showtraceback(exception_only=True)
2019 self.showtraceback(exception_only=True)
2027 except:
2020 except:
2028 self.showtraceback()
2021 self.showtraceback()
2029
2022
2030 def safe_execfile_ipy(self, fname):
2023 def safe_execfile_ipy(self, fname):
2031 """Like safe_execfile, but for .ipy files with IPython syntax.
2024 """Like safe_execfile, but for .ipy files with IPython syntax.
2032
2025
2033 Parameters
2026 Parameters
2034 ----------
2027 ----------
2035 fname : str
2028 fname : str
2036 The name of the file to execute. The filename must have a
2029 The name of the file to execute. The filename must have a
2037 .ipy extension.
2030 .ipy extension.
2038 """
2031 """
2039 fname = os.path.abspath(os.path.expanduser(fname))
2032 fname = os.path.abspath(os.path.expanduser(fname))
2040
2033
2041 # Make sure we have a .py file
2034 # Make sure we have a .py file
2042 if not fname.endswith('.ipy'):
2035 if not fname.endswith('.ipy'):
2043 warn('File must end with .py to be run using execfile: <%s>' % fname)
2036 warn('File must end with .py to be run using execfile: <%s>' % fname)
2044
2037
2045 # Make sure we can open the file
2038 # Make sure we can open the file
2046 try:
2039 try:
2047 with open(fname) as thefile:
2040 with open(fname) as thefile:
2048 pass
2041 pass
2049 except:
2042 except:
2050 warn('Could not open file <%s> for safe execution.' % fname)
2043 warn('Could not open file <%s> for safe execution.' % fname)
2051 return
2044 return
2052
2045
2053 # Find things also in current directory. This is needed to mimic the
2046 # Find things also in current directory. This is needed to mimic the
2054 # behavior of running a script from the system command line, where
2047 # behavior of running a script from the system command line, where
2055 # Python inserts the script's directory into sys.path
2048 # Python inserts the script's directory into sys.path
2056 dname = os.path.dirname(fname)
2049 dname = os.path.dirname(fname)
2057
2050
2058 with prepended_to_syspath(dname):
2051 with prepended_to_syspath(dname):
2059 try:
2052 try:
2060 with open(fname) as thefile:
2053 with open(fname) as thefile:
2061 # self.run_cell currently captures all exceptions
2054 # self.run_cell currently captures all exceptions
2062 # raised in user code. It would be nice if there were
2055 # raised in user code. It would be nice if there were
2063 # versions of runlines, execfile that did raise, so
2056 # versions of runlines, execfile that did raise, so
2064 # we could catch the errors.
2057 # we could catch the errors.
2065 self.run_cell(thefile.read())
2058 self.run_cell(thefile.read())
2066 except:
2059 except:
2067 self.showtraceback()
2060 self.showtraceback()
2068 warn('Unknown failure executing file: <%s>' % fname)
2061 warn('Unknown failure executing file: <%s>' % fname)
2069
2062
2070 def run_cell(self, cell):
2063 def run_cell(self, cell):
2071 """Run the contents of an entire multiline 'cell' of code.
2064 """Run the contents of an entire multiline 'cell' of code.
2072
2065
2073 The cell is split into separate blocks which can be executed
2066 The cell is split into separate blocks which can be executed
2074 individually. Then, based on how many blocks there are, they are
2067 individually. Then, based on how many blocks there are, they are
2075 executed as follows:
2068 executed as follows:
2076
2069
2077 - A single block: 'single' mode.
2070 - A single block: 'single' mode.
2078
2071
2079 If there's more than one block, it depends:
2072 If there's more than one block, it depends:
2080
2073
2081 - if the last one is no more than two lines long, run all but the last
2074 - if the last one is no more than two lines long, run all but the last
2082 in 'exec' mode and the very last one in 'single' mode. This makes it
2075 in 'exec' mode and the very last one in 'single' mode. This makes it
2083 easy to type simple expressions at the end to see computed values. -
2076 easy to type simple expressions at the end to see computed values. -
2084 otherwise (last one is also multiline), run all in 'exec' mode
2077 otherwise (last one is also multiline), run all in 'exec' mode
2085
2078
2086 When code is executed in 'single' mode, :func:`sys.displayhook` fires,
2079 When code is executed in 'single' mode, :func:`sys.displayhook` fires,
2087 results are displayed and output prompts are computed. In 'exec' mode,
2080 results are displayed and output prompts are computed. In 'exec' mode,
2088 no results are displayed unless :func:`print` is called explicitly;
2081 no results are displayed unless :func:`print` is called explicitly;
2089 this mode is more akin to running a script.
2082 this mode is more akin to running a script.
2090
2083
2091 Parameters
2084 Parameters
2092 ----------
2085 ----------
2093 cell : str
2086 cell : str
2094 A single or multiline string.
2087 A single or multiline string.
2095 """
2088 """
2096
2089
2097 # We need to break up the input into executable blocks that can be run
2090 # We need to break up the input into executable blocks that can be run
2098 # in 'single' mode, to provide comfortable user behavior.
2091 # in 'single' mode, to provide comfortable user behavior.
2099 blocks = self.input_splitter.split_blocks(cell)
2092 blocks = self.input_splitter.split_blocks(cell)
2100
2093
2101 if not blocks:
2094 if not blocks:
2102 return
2095 return
2103
2096
2104 # Store the 'ipython' version of the cell as well, since that's what
2097 # Store the 'ipython' version of the cell as well, since that's what
2105 # needs to go into the translated history and get executed (the
2098 # needs to go into the translated history and get executed (the
2106 # original cell may contain non-python syntax).
2099 # original cell may contain non-python syntax).
2107 ipy_cell = ''.join(blocks)
2100 ipy_cell = ''.join(blocks)
2108
2101
2109 # Store raw and processed history
2102 # Store raw and processed history
2110 self.history_manager.store_inputs(ipy_cell, cell)
2103 self.history_manager.store_inputs(ipy_cell, cell)
2111
2104
2112 self.logger.log(ipy_cell, cell)
2105 self.logger.log(ipy_cell, cell)
2113
2106
2114 # All user code execution must happen with our context managers active
2107 # All user code execution must happen with our context managers active
2115 with nested(self.builtin_trap, self.display_trap):
2108 with nested(self.builtin_trap, self.display_trap):
2116
2109
2117 # Single-block input should behave like an interactive prompt
2110 # Single-block input should behave like an interactive prompt
2118 if len(blocks) == 1:
2111 if len(blocks) == 1:
2119 # since we return here, we need to update the execution count
2112 # since we return here, we need to update the execution count
2120 out = self.run_one_block(blocks[0])
2113 out = self.run_one_block(blocks[0])
2121 self.execution_count += 1
2114 self.execution_count += 1
2122 return out
2115 return out
2123
2116
2124 # In multi-block input, if the last block is a simple (one-two
2117 # In multi-block input, if the last block is a simple (one-two
2125 # lines) expression, run it in single mode so it produces output.
2118 # lines) expression, run it in single mode so it produces output.
2126 # Otherwise just feed the whole thing to run_code. This seems like
2119 # Otherwise just feed the whole thing to run_code. This seems like
2127 # a reasonable usability design.
2120 # a reasonable usability design.
2128 last = blocks[-1]
2121 last = blocks[-1]
2129 last_nlines = len(last.splitlines())
2122 last_nlines = len(last.splitlines())
2130
2123
2131 # Note: below, whenever we call run_code, we must sync history
2124 # Note: below, whenever we call run_code, we must sync history
2132 # ourselves, because run_code is NOT meant to manage history at all.
2125 # ourselves, because run_code is NOT meant to manage history at all.
2133 if last_nlines < 2:
2126 if last_nlines < 2:
2134 # Here we consider the cell split between 'body' and 'last',
2127 # Here we consider the cell split between 'body' and 'last',
2135 # store all history and execute 'body', and if successful, then
2128 # store all history and execute 'body', and if successful, then
2136 # proceed to execute 'last'.
2129 # proceed to execute 'last'.
2137
2130
2138 # Get the main body to run as a cell
2131 # Get the main body to run as a cell
2139 ipy_body = ''.join(blocks[:-1])
2132 ipy_body = ''.join(blocks[:-1])
2140 retcode = self.run_source(ipy_body, symbol='exec',
2133 retcode = self.run_source(ipy_body, symbol='exec',
2141 post_execute=False)
2134 post_execute=False)
2142 if retcode==0:
2135 if retcode==0:
2143 # And the last expression via runlines so it produces output
2136 # And the last expression via runlines so it produces output
2144 self.run_one_block(last)
2137 self.run_one_block(last)
2145 else:
2138 else:
2146 # Run the whole cell as one entity, storing both raw and
2139 # Run the whole cell as one entity, storing both raw and
2147 # processed input in history
2140 # processed input in history
2148 self.run_source(ipy_cell, symbol='exec')
2141 self.run_source(ipy_cell, symbol='exec')
2149
2142
2150 # Each cell is a *single* input, regardless of how many lines it has
2143 # Each cell is a *single* input, regardless of how many lines it has
2151 self.execution_count += 1
2144 self.execution_count += 1
2152
2145
2153 def run_one_block(self, block):
2146 def run_one_block(self, block):
2154 """Run a single interactive block of source code.
2147 """Run a single interactive block of source code.
2155
2148
2156 If the block is single-line, dynamic transformations are applied to it
2149 If the block is single-line, dynamic transformations are applied to it
2157 (like automagics, autocall and alias recognition).
2150 (like automagics, autocall and alias recognition).
2158
2151
2159 If the block is multi-line, it must consist of valid Python code only.
2152 If the block is multi-line, it must consist of valid Python code only.
2160
2153
2161 Parameters
2154 Parameters
2162 ----------
2155 ----------
2163 block : string
2156 block : string
2164 A (possibly multiline) string of code to be executed.
2157 A (possibly multiline) string of code to be executed.
2165
2158
2166 Returns
2159 Returns
2167 -------
2160 -------
2168 The output of the underlying execution method used, be it
2161 The output of the underlying execution method used, be it
2169 :meth:`run_source` or :meth:`run_single_line`.
2162 :meth:`run_source` or :meth:`run_single_line`.
2170 """
2163 """
2171 if len(block.splitlines()) <= 1:
2164 if len(block.splitlines()) <= 1:
2172 out = self.run_single_line(block)
2165 out = self.run_single_line(block)
2173 else:
2166 else:
2174 # Call run_source, which correctly compiles the input cell.
2167 # Call run_source, which correctly compiles the input cell.
2175 # run_code must only be called when we know we have a code object,
2168 # run_code must only be called when we know we have a code object,
2176 # as it does a naked exec and the compilation mode may not be what
2169 # as it does a naked exec and the compilation mode may not be what
2177 # we wanted.
2170 # we wanted.
2178 out = self.run_source(block)
2171 out = self.run_source(block)
2179 return out
2172 return out
2180
2173
2181 def run_single_line(self, line):
2174 def run_single_line(self, line):
2182 """Run a single-line interactive statement.
2175 """Run a single-line interactive statement.
2183
2176
2184 This assumes the input has been transformed to IPython syntax by
2177 This assumes the input has been transformed to IPython syntax by
2185 applying all static transformations (those with an explicit prefix like
2178 applying all static transformations (those with an explicit prefix like
2186 % or !), but it will further try to apply the dynamic ones.
2179 % or !), but it will further try to apply the dynamic ones.
2187
2180
2188 It does not update history.
2181 It does not update history.
2189 """
2182 """
2190 tline = self.prefilter_manager.prefilter_line(line)
2183 tline = self.prefilter_manager.prefilter_line(line)
2191 return self.run_source(tline)
2184 return self.run_source(tline)
2192
2185
2193 # PENDING REMOVAL: this method is slated for deletion, once our new
2186 # PENDING REMOVAL: this method is slated for deletion, once our new
2194 # input logic has been 100% moved to frontends and is stable.
2187 # input logic has been 100% moved to frontends and is stable.
2195 def runlines(self, lines, clean=False):
2188 def runlines(self, lines, clean=False):
2196 """Run a string of one or more lines of source.
2189 """Run a string of one or more lines of source.
2197
2190
2198 This method is capable of running a string containing multiple source
2191 This method is capable of running a string containing multiple source
2199 lines, as if they had been entered at the IPython prompt. Since it
2192 lines, as if they had been entered at the IPython prompt. Since it
2200 exposes IPython's processing machinery, the given strings can contain
2193 exposes IPython's processing machinery, the given strings can contain
2201 magic calls (%magic), special shell access (!cmd), etc.
2194 magic calls (%magic), special shell access (!cmd), etc.
2202 """
2195 """
2203
2196
2204 if isinstance(lines, (list, tuple)):
2197 if isinstance(lines, (list, tuple)):
2205 lines = '\n'.join(lines)
2198 lines = '\n'.join(lines)
2206
2199
2207 if clean:
2200 if clean:
2208 lines = self._cleanup_ipy_script(lines)
2201 lines = self._cleanup_ipy_script(lines)
2209
2202
2210 # We must start with a clean buffer, in case this is run from an
2203 # We must start with a clean buffer, in case this is run from an
2211 # interactive IPython session (via a magic, for example).
2204 # interactive IPython session (via a magic, for example).
2212 self.reset_buffer()
2205 self.reset_buffer()
2213 lines = lines.splitlines()
2206 lines = lines.splitlines()
2214
2207
2215 # Since we will prefilter all lines, store the user's raw input too
2208 # Since we will prefilter all lines, store the user's raw input too
2216 # before we apply any transformations
2209 # before we apply any transformations
2217 self.buffer_raw[:] = [ l+'\n' for l in lines]
2210 self.buffer_raw[:] = [ l+'\n' for l in lines]
2218
2211
2219 more = False
2212 more = False
2220 prefilter_lines = self.prefilter_manager.prefilter_lines
2213 prefilter_lines = self.prefilter_manager.prefilter_lines
2221 with nested(self.builtin_trap, self.display_trap):
2214 with nested(self.builtin_trap, self.display_trap):
2222 for line in lines:
2215 for line in lines:
2223 # skip blank lines so we don't mess up the prompt counter, but
2216 # skip blank lines so we don't mess up the prompt counter, but
2224 # do NOT skip even a blank line if we are in a code block (more
2217 # do NOT skip even a blank line if we are in a code block (more
2225 # is true)
2218 # is true)
2226
2219
2227 if line or more:
2220 if line or more:
2228 more = self.push_line(prefilter_lines(line, more))
2221 more = self.push_line(prefilter_lines(line, more))
2229 # IPython's run_source returns None if there was an error
2222 # IPython's run_source returns None if there was an error
2230 # compiling the code. This allows us to stop processing
2223 # compiling the code. This allows us to stop processing
2231 # right away, so the user gets the error message at the
2224 # right away, so the user gets the error message at the
2232 # right place.
2225 # right place.
2233 if more is None:
2226 if more is None:
2234 break
2227 break
2235 # final newline in case the input didn't have it, so that the code
2228 # final newline in case the input didn't have it, so that the code
2236 # actually does get executed
2229 # actually does get executed
2237 if more:
2230 if more:
2238 self.push_line('\n')
2231 self.push_line('\n')
2239
2232
2240 def run_source(self, source, filename=None,
2233 def run_source(self, source, filename=None,
2241 symbol='single', post_execute=True):
2234 symbol='single', post_execute=True):
2242 """Compile and run some source in the interpreter.
2235 """Compile and run some source in the interpreter.
2243
2236
2244 Arguments are as for compile_command().
2237 Arguments are as for compile_command().
2245
2238
2246 One several things can happen:
2239 One several things can happen:
2247
2240
2248 1) The input is incorrect; compile_command() raised an
2241 1) The input is incorrect; compile_command() raised an
2249 exception (SyntaxError or OverflowError). A syntax traceback
2242 exception (SyntaxError or OverflowError). A syntax traceback
2250 will be printed by calling the showsyntaxerror() method.
2243 will be printed by calling the showsyntaxerror() method.
2251
2244
2252 2) The input is incomplete, and more input is required;
2245 2) The input is incomplete, and more input is required;
2253 compile_command() returned None. Nothing happens.
2246 compile_command() returned None. Nothing happens.
2254
2247
2255 3) The input is complete; compile_command() returned a code
2248 3) The input is complete; compile_command() returned a code
2256 object. The code is executed by calling self.run_code() (which
2249 object. The code is executed by calling self.run_code() (which
2257 also handles run-time exceptions, except for SystemExit).
2250 also handles run-time exceptions, except for SystemExit).
2258
2251
2259 The return value is:
2252 The return value is:
2260
2253
2261 - True in case 2
2254 - True in case 2
2262
2255
2263 - False in the other cases, unless an exception is raised, where
2256 - False in the other cases, unless an exception is raised, where
2264 None is returned instead. This can be used by external callers to
2257 None is returned instead. This can be used by external callers to
2265 know whether to continue feeding input or not.
2258 know whether to continue feeding input or not.
2266
2259
2267 The return value can be used to decide whether to use sys.ps1 or
2260 The return value can be used to decide whether to use sys.ps1 or
2268 sys.ps2 to prompt the next line."""
2261 sys.ps2 to prompt the next line."""
2269
2262
2270 # We need to ensure that the source is unicode from here on.
2263 # We need to ensure that the source is unicode from here on.
2271 if type(source)==str:
2264 if type(source)==str:
2272 usource = source.decode(self.stdin_encoding)
2265 usource = source.decode(self.stdin_encoding)
2273 else:
2266 else:
2274 usource = source
2267 usource = source
2275
2268
2276 if 0: # dbg
2269 if 0: # dbg
2277 print 'Source:', repr(source) # dbg
2270 print 'Source:', repr(source) # dbg
2278 print 'USource:', repr(usource) # dbg
2271 print 'USource:', repr(usource) # dbg
2279 print 'type:', type(source) # dbg
2272 print 'type:', type(source) # dbg
2280 print 'encoding', self.stdin_encoding # dbg
2273 print 'encoding', self.stdin_encoding # dbg
2281
2274
2282 try:
2275 try:
2283 code = self.compile(usource, symbol, self.execution_count)
2276 code = self.compile(usource, symbol, self.execution_count)
2284 except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError):
2277 except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError):
2285 # Case 1
2278 # Case 1
2286 self.showsyntaxerror(filename)
2279 self.showsyntaxerror(filename)
2287 return None
2280 return None
2288
2281
2289 if code is None:
2282 if code is None:
2290 # Case 2
2283 # Case 2
2291 return True
2284 return True
2292
2285
2293 # Case 3
2286 # Case 3
2294 # We store the code object so that threaded shells and
2287 # We store the code object so that threaded shells and
2295 # custom exception handlers can access all this info if needed.
2288 # custom exception handlers can access all this info if needed.
2296 # The source corresponding to this can be obtained from the
2289 # The source corresponding to this can be obtained from the
2297 # buffer attribute as '\n'.join(self.buffer).
2290 # buffer attribute as '\n'.join(self.buffer).
2298 self.code_to_run = code
2291 self.code_to_run = code
2299 # now actually execute the code object
2292 # now actually execute the code object
2300 if self.run_code(code, post_execute) == 0:
2293 if self.run_code(code, post_execute) == 0:
2301 return False
2294 return False
2302 else:
2295 else:
2303 return None
2296 return None
2304
2297
2305 # For backwards compatibility
2298 # For backwards compatibility
2306 runsource = run_source
2299 runsource = run_source
2307
2300
2308 def run_code(self, code_obj, post_execute=True):
2301 def run_code(self, code_obj, post_execute=True):
2309 """Execute a code object.
2302 """Execute a code object.
2310
2303
2311 When an exception occurs, self.showtraceback() is called to display a
2304 When an exception occurs, self.showtraceback() is called to display a
2312 traceback.
2305 traceback.
2313
2306
2314 Return value: a flag indicating whether the code to be run completed
2307 Return value: a flag indicating whether the code to be run completed
2315 successfully:
2308 successfully:
2316
2309
2317 - 0: successful execution.
2310 - 0: successful execution.
2318 - 1: an error occurred.
2311 - 1: an error occurred.
2319 """
2312 """
2320
2313
2321 # Set our own excepthook in case the user code tries to call it
2314 # Set our own excepthook in case the user code tries to call it
2322 # directly, so that the IPython crash handler doesn't get triggered
2315 # directly, so that the IPython crash handler doesn't get triggered
2323 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2316 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2324
2317
2325 # we save the original sys.excepthook in the instance, in case config
2318 # we save the original sys.excepthook in the instance, in case config
2326 # code (such as magics) needs access to it.
2319 # code (such as magics) needs access to it.
2327 self.sys_excepthook = old_excepthook
2320 self.sys_excepthook = old_excepthook
2328 outflag = 1 # happens in more places, so it's easier as default
2321 outflag = 1 # happens in more places, so it's easier as default
2329 try:
2322 try:
2330 try:
2323 try:
2331 self.hooks.pre_run_code_hook()
2324 self.hooks.pre_run_code_hook()
2332 #rprint('Running code', repr(code_obj)) # dbg
2325 #rprint('Running code', repr(code_obj)) # dbg
2333 exec code_obj in self.user_global_ns, self.user_ns
2326 exec code_obj in self.user_global_ns, self.user_ns
2334 finally:
2327 finally:
2335 # Reset our crash handler in place
2328 # Reset our crash handler in place
2336 sys.excepthook = old_excepthook
2329 sys.excepthook = old_excepthook
2337 except SystemExit:
2330 except SystemExit:
2338 self.reset_buffer()
2331 self.reset_buffer()
2339 self.showtraceback(exception_only=True)
2332 self.showtraceback(exception_only=True)
2340 warn("To exit: use any of 'exit', 'quit', %Exit or Ctrl-D.", level=1)
2333 warn("To exit: use any of 'exit', 'quit', %Exit or Ctrl-D.", level=1)
2341 except self.custom_exceptions:
2334 except self.custom_exceptions:
2342 etype,value,tb = sys.exc_info()
2335 etype,value,tb = sys.exc_info()
2343 self.CustomTB(etype,value,tb)
2336 self.CustomTB(etype,value,tb)
2344 except:
2337 except:
2345 self.showtraceback()
2338 self.showtraceback()
2346 else:
2339 else:
2347 outflag = 0
2340 outflag = 0
2348 if softspace(sys.stdout, 0):
2341 if softspace(sys.stdout, 0):
2349 print
2342 print
2350
2343
2351 # Execute any registered post-execution functions. Here, any errors
2344 # Execute any registered post-execution functions. Here, any errors
2352 # are reported only minimally and just on the terminal, because the
2345 # are reported only minimally and just on the terminal, because the
2353 # main exception channel may be occupied with a user traceback.
2346 # main exception channel may be occupied with a user traceback.
2354 # FIXME: we need to think this mechanism a little more carefully.
2347 # FIXME: we need to think this mechanism a little more carefully.
2355 if post_execute:
2348 if post_execute:
2356 for func in self._post_execute:
2349 for func in self._post_execute:
2357 try:
2350 try:
2358 func()
2351 func()
2359 except:
2352 except:
2360 head = '[ ERROR ] Evaluating post_execute function: %s' % \
2353 head = '[ ERROR ] Evaluating post_execute function: %s' % \
2361 func
2354 func
2362 print >> io.Term.cout, head
2355 print >> io.Term.cout, head
2363 print >> io.Term.cout, self._simple_error()
2356 print >> io.Term.cout, self._simple_error()
2364 print >> io.Term.cout, 'Removing from post_execute'
2357 print >> io.Term.cout, 'Removing from post_execute'
2365 self._post_execute.remove(func)
2358 self._post_execute.remove(func)
2366
2359
2367 # Flush out code object which has been run (and source)
2360 # Flush out code object which has been run (and source)
2368 self.code_to_run = None
2361 self.code_to_run = None
2369 return outflag
2362 return outflag
2370
2363
2371 # For backwards compatibility
2364 # For backwards compatibility
2372 runcode = run_code
2365 runcode = run_code
2373
2366
2374 # PENDING REMOVAL: this method is slated for deletion, once our new
2367 # PENDING REMOVAL: this method is slated for deletion, once our new
2375 # input logic has been 100% moved to frontends and is stable.
2368 # input logic has been 100% moved to frontends and is stable.
2376 def push_line(self, line):
2369 def push_line(self, line):
2377 """Push a line to the interpreter.
2370 """Push a line to the interpreter.
2378
2371
2379 The line should not have a trailing newline; it may have
2372 The line should not have a trailing newline; it may have
2380 internal newlines. The line is appended to a buffer and the
2373 internal newlines. The line is appended to a buffer and the
2381 interpreter's run_source() method is called with the
2374 interpreter's run_source() method is called with the
2382 concatenated contents of the buffer as source. If this
2375 concatenated contents of the buffer as source. If this
2383 indicates that the command was executed or invalid, the buffer
2376 indicates that the command was executed or invalid, the buffer
2384 is reset; otherwise, the command is incomplete, and the buffer
2377 is reset; otherwise, the command is incomplete, and the buffer
2385 is left as it was after the line was appended. The return
2378 is left as it was after the line was appended. The return
2386 value is 1 if more input is required, 0 if the line was dealt
2379 value is 1 if more input is required, 0 if the line was dealt
2387 with in some way (this is the same as run_source()).
2380 with in some way (this is the same as run_source()).
2388 """
2381 """
2389
2382
2390 # autoindent management should be done here, and not in the
2383 # autoindent management should be done here, and not in the
2391 # interactive loop, since that one is only seen by keyboard input. We
2384 # interactive loop, since that one is only seen by keyboard input. We
2392 # need this done correctly even for code run via runlines (which uses
2385 # need this done correctly even for code run via runlines (which uses
2393 # push).
2386 # push).
2394
2387
2395 #print 'push line: <%s>' % line # dbg
2388 #print 'push line: <%s>' % line # dbg
2396 self.buffer.append(line)
2389 self.buffer.append(line)
2397 full_source = '\n'.join(self.buffer)
2390 full_source = '\n'.join(self.buffer)
2398 more = self.run_source(full_source, self.filename)
2391 more = self.run_source(full_source, self.filename)
2399 if not more:
2392 if not more:
2400 self.history_manager.store_inputs('\n'.join(self.buffer_raw),
2393 self.history_manager.store_inputs('\n'.join(self.buffer_raw),
2401 full_source)
2394 full_source)
2402 self.reset_buffer()
2395 self.reset_buffer()
2403 self.execution_count += 1
2396 self.execution_count += 1
2404 return more
2397 return more
2405
2398
2406 def reset_buffer(self):
2399 def reset_buffer(self):
2407 """Reset the input buffer."""
2400 """Reset the input buffer."""
2408 self.buffer[:] = []
2401 self.buffer[:] = []
2409 self.buffer_raw[:] = []
2402 self.buffer_raw[:] = []
2410 self.input_splitter.reset()
2403 self.input_splitter.reset()
2411
2404
2412 # For backwards compatibility
2405 # For backwards compatibility
2413 resetbuffer = reset_buffer
2406 resetbuffer = reset_buffer
2414
2407
2415 def _is_secondary_block_start(self, s):
2408 def _is_secondary_block_start(self, s):
2416 if not s.endswith(':'):
2409 if not s.endswith(':'):
2417 return False
2410 return False
2418 if (s.startswith('elif') or
2411 if (s.startswith('elif') or
2419 s.startswith('else') or
2412 s.startswith('else') or
2420 s.startswith('except') or
2413 s.startswith('except') or
2421 s.startswith('finally')):
2414 s.startswith('finally')):
2422 return True
2415 return True
2423
2416
2424 def _cleanup_ipy_script(self, script):
2417 def _cleanup_ipy_script(self, script):
2425 """Make a script safe for self.runlines()
2418 """Make a script safe for self.runlines()
2426
2419
2427 Currently, IPython is lines based, with blocks being detected by
2420 Currently, IPython is lines based, with blocks being detected by
2428 empty lines. This is a problem for block based scripts that may
2421 empty lines. This is a problem for block based scripts that may
2429 not have empty lines after blocks. This script adds those empty
2422 not have empty lines after blocks. This script adds those empty
2430 lines to make scripts safe for running in the current line based
2423 lines to make scripts safe for running in the current line based
2431 IPython.
2424 IPython.
2432 """
2425 """
2433 res = []
2426 res = []
2434 lines = script.splitlines()
2427 lines = script.splitlines()
2435 level = 0
2428 level = 0
2436
2429
2437 for l in lines:
2430 for l in lines:
2438 lstripped = l.lstrip()
2431 lstripped = l.lstrip()
2439 stripped = l.strip()
2432 stripped = l.strip()
2440 if not stripped:
2433 if not stripped:
2441 continue
2434 continue
2442 newlevel = len(l) - len(lstripped)
2435 newlevel = len(l) - len(lstripped)
2443 if level > 0 and newlevel == 0 and \
2436 if level > 0 and newlevel == 0 and \
2444 not self._is_secondary_block_start(stripped):
2437 not self._is_secondary_block_start(stripped):
2445 # add empty line
2438 # add empty line
2446 res.append('')
2439 res.append('')
2447 res.append(l)
2440 res.append(l)
2448 level = newlevel
2441 level = newlevel
2449
2442
2450 return '\n'.join(res) + '\n'
2443 return '\n'.join(res) + '\n'
2451
2444
2452 #-------------------------------------------------------------------------
2445 #-------------------------------------------------------------------------
2453 # Things related to GUI support and pylab
2446 # Things related to GUI support and pylab
2454 #-------------------------------------------------------------------------
2447 #-------------------------------------------------------------------------
2455
2448
2456 def enable_pylab(self, gui=None):
2449 def enable_pylab(self, gui=None):
2457 raise NotImplementedError('Implement enable_pylab in a subclass')
2450 raise NotImplementedError('Implement enable_pylab in a subclass')
2458
2451
2459 #-------------------------------------------------------------------------
2452 #-------------------------------------------------------------------------
2460 # Utilities
2453 # Utilities
2461 #-------------------------------------------------------------------------
2454 #-------------------------------------------------------------------------
2462
2455
2463 def var_expand(self,cmd,depth=0):
2456 def var_expand(self,cmd,depth=0):
2464 """Expand python variables in a string.
2457 """Expand python variables in a string.
2465
2458
2466 The depth argument indicates how many frames above the caller should
2459 The depth argument indicates how many frames above the caller should
2467 be walked to look for the local namespace where to expand variables.
2460 be walked to look for the local namespace where to expand variables.
2468
2461
2469 The global namespace for expansion is always the user's interactive
2462 The global namespace for expansion is always the user's interactive
2470 namespace.
2463 namespace.
2471 """
2464 """
2472
2465
2473 return str(ItplNS(cmd,
2466 return str(ItplNS(cmd,
2474 self.user_ns, # globals
2467 self.user_ns, # globals
2475 # Skip our own frame in searching for locals:
2468 # Skip our own frame in searching for locals:
2476 sys._getframe(depth+1).f_locals # locals
2469 sys._getframe(depth+1).f_locals # locals
2477 ))
2470 ))
2478
2471
2479 def mktempfile(self, data=None, prefix='ipython_edit_'):
2472 def mktempfile(self, data=None, prefix='ipython_edit_'):
2480 """Make a new tempfile and return its filename.
2473 """Make a new tempfile and return its filename.
2481
2474
2482 This makes a call to tempfile.mktemp, but it registers the created
2475 This makes a call to tempfile.mktemp, but it registers the created
2483 filename internally so ipython cleans it up at exit time.
2476 filename internally so ipython cleans it up at exit time.
2484
2477
2485 Optional inputs:
2478 Optional inputs:
2486
2479
2487 - data(None): if data is given, it gets written out to the temp file
2480 - data(None): if data is given, it gets written out to the temp file
2488 immediately, and the file is closed again."""
2481 immediately, and the file is closed again."""
2489
2482
2490 filename = tempfile.mktemp('.py', prefix)
2483 filename = tempfile.mktemp('.py', prefix)
2491 self.tempfiles.append(filename)
2484 self.tempfiles.append(filename)
2492
2485
2493 if data:
2486 if data:
2494 tmp_file = open(filename,'w')
2487 tmp_file = open(filename,'w')
2495 tmp_file.write(data)
2488 tmp_file.write(data)
2496 tmp_file.close()
2489 tmp_file.close()
2497 return filename
2490 return filename
2498
2491
2499 # TODO: This should be removed when Term is refactored.
2492 # TODO: This should be removed when Term is refactored.
2500 def write(self,data):
2493 def write(self,data):
2501 """Write a string to the default output"""
2494 """Write a string to the default output"""
2502 io.Term.cout.write(data)
2495 io.Term.cout.write(data)
2503
2496
2504 # TODO: This should be removed when Term is refactored.
2497 # TODO: This should be removed when Term is refactored.
2505 def write_err(self,data):
2498 def write_err(self,data):
2506 """Write a string to the default error output"""
2499 """Write a string to the default error output"""
2507 io.Term.cerr.write(data)
2500 io.Term.cerr.write(data)
2508
2501
2509 def ask_yes_no(self,prompt,default=True):
2502 def ask_yes_no(self,prompt,default=True):
2510 if self.quiet:
2503 if self.quiet:
2511 return True
2504 return True
2512 return ask_yes_no(prompt,default)
2505 return ask_yes_no(prompt,default)
2513
2506
2514 def show_usage(self):
2507 def show_usage(self):
2515 """Show a usage message"""
2508 """Show a usage message"""
2516 page.page(IPython.core.usage.interactive_usage)
2509 page.page(IPython.core.usage.interactive_usage)
2517
2510
2518 #-------------------------------------------------------------------------
2511 #-------------------------------------------------------------------------
2519 # Things related to IPython exiting
2512 # Things related to IPython exiting
2520 #-------------------------------------------------------------------------
2513 #-------------------------------------------------------------------------
2521 def atexit_operations(self):
2514 def atexit_operations(self):
2522 """This will be executed at the time of exit.
2515 """This will be executed at the time of exit.
2523
2516
2524 Cleanup operations and saving of persistent data that is done
2517 Cleanup operations and saving of persistent data that is done
2525 unconditionally by IPython should be performed here.
2518 unconditionally by IPython should be performed here.
2526
2519
2527 For things that may depend on startup flags or platform specifics (such
2520 For things that may depend on startup flags or platform specifics (such
2528 as having readline or not), register a separate atexit function in the
2521 as having readline or not), register a separate atexit function in the
2529 code that has the appropriate information, rather than trying to
2522 code that has the appropriate information, rather than trying to
2530 clutter
2523 clutter
2531 """
2524 """
2532 # Cleanup all tempfiles left around
2525 # Cleanup all tempfiles left around
2533 for tfile in self.tempfiles:
2526 for tfile in self.tempfiles:
2534 try:
2527 try:
2535 os.unlink(tfile)
2528 os.unlink(tfile)
2536 except OSError:
2529 except OSError:
2537 pass
2530 pass
2538
2531
2539 self.save_history()
2540
2541 # Clear all user namespaces to release all references cleanly.
2532 # Clear all user namespaces to release all references cleanly.
2542 self.reset()
2533 self.reset()
2543
2534
2544 # Run user hooks
2535 # Run user hooks
2545 self.hooks.shutdown_hook()
2536 self.hooks.shutdown_hook()
2546
2537
2547 def cleanup(self):
2538 def cleanup(self):
2548 self.restore_sys_module_state()
2539 self.restore_sys_module_state()
2549
2540
2550
2541
2551 class InteractiveShellABC(object):
2542 class InteractiveShellABC(object):
2552 """An abstract base class for InteractiveShell."""
2543 """An abstract base class for InteractiveShell."""
2553 __metaclass__ = abc.ABCMeta
2544 __metaclass__ = abc.ABCMeta
2554
2545
2555 InteractiveShellABC.register(InteractiveShell)
2546 InteractiveShellABC.register(InteractiveShell)
General Comments 0
You need to be logged in to leave comments. Login now