##// END OF EJS Templates
Also catch SyntaxErrors from InputTransformers in run_cell()...
Volker Braun -
Show More
@@ -0,0 +1,58 b''
1 # coding: utf-8
2 """Tests for the IPython terminal"""
3
4 import os
5 import tempfile
6 import shutil
7
8 import nose.tools as nt
9
10 from IPython.testing.tools import make_tempfile, ipexec
11
12
13 TEST_SYNTAX_ERROR_CMDS = """
14 from IPython.core.inputtransformer import InputTransformer
15
16 %cpaste
17 class SyntaxErrorTransformer(InputTransformer):
18
19 def push(self, line):
20 pos = line.find('syntaxerror')
21 if pos >= 0:
22 e = SyntaxError('input contains "syntaxerror"')
23 e.text = line
24 e.offset = pos + 1
25 raise e
26 return line
27
28 def reset(self):
29 pass
30 --
31
32 ip = get_ipython()
33 transformer = SyntaxErrorTransformer()
34 ip.input_splitter.python_line_transforms.append(transformer)
35 ip.input_transformer_manager.python_line_transforms.append(transformer)
36
37 # now the actual commands
38 1234
39 2345 # syntaxerror <- triggered here
40 3456
41 """
42
43 def test_syntax_error():
44 """Check that the IPython terminal does not abort if a SyntaxError is raised in an InputTransformer"""
45 try:
46 tmp = tempfile.mkdtemp()
47 filename = os.path.join(tmp, 'test_syntax_error.py')
48 with open(filename, 'w') as f:
49 f.write(TEST_SYNTAX_ERROR_CMDS)
50 out, err = ipexec(filename, pipe=True)
51 nt.assert_equal(err, '')
52 nt.assert_in('1234', out)
53 nt.assert_in(' 2345 # syntaxerror <- triggered here', out)
54 nt.assert_in(' ^', out)
55 nt.assert_in('SyntaxError: input contains "syntaxerror"', out)
56 nt.assert_in('3456', out)
57 finally:
58 shutil.rmtree(tmp)
@@ -1,535 +1,538 b''
1 1 import abc
2 2 import functools
3 3 import re
4 4
5 5 from IPython.core.splitinput import LineInfo
6 6 from IPython.utils import tokenize2
7 7 from IPython.utils.openpy import cookie_comment_re
8 8 from IPython.utils.py3compat import with_metaclass, PY3
9 9 from IPython.utils.tokenize2 import generate_tokens, untokenize, TokenError
10 10
11 11 if PY3:
12 12 from io import StringIO
13 13 else:
14 14 from StringIO import StringIO
15 15
16 16 #-----------------------------------------------------------------------------
17 17 # Globals
18 18 #-----------------------------------------------------------------------------
19 19
20 20 # The escape sequences that define the syntax transformations IPython will
21 21 # apply to user input. These can NOT be just changed here: many regular
22 22 # expressions and other parts of the code may use their hardcoded values, and
23 23 # for all intents and purposes they constitute the 'IPython syntax', so they
24 24 # should be considered fixed.
25 25
26 26 ESC_SHELL = '!' # Send line to underlying system shell
27 27 ESC_SH_CAP = '!!' # Send line to system shell and capture output
28 28 ESC_HELP = '?' # Find information about object
29 29 ESC_HELP2 = '??' # Find extra-detailed information about object
30 30 ESC_MAGIC = '%' # Call magic function
31 31 ESC_MAGIC2 = '%%' # Call cell-magic function
32 32 ESC_QUOTE = ',' # Split args on whitespace, quote each as string and call
33 33 ESC_QUOTE2 = ';' # Quote all args as a single string, call
34 34 ESC_PAREN = '/' # Call first argument with rest of line as arguments
35 35
36 36 ESC_SEQUENCES = [ESC_SHELL, ESC_SH_CAP, ESC_HELP ,\
37 37 ESC_HELP2, ESC_MAGIC, ESC_MAGIC2,\
38 38 ESC_QUOTE, ESC_QUOTE2, ESC_PAREN ]
39 39
40 40
41 41 class InputTransformer(with_metaclass(abc.ABCMeta, object)):
42 42 """Abstract base class for line-based input transformers."""
43 43
44 44 @abc.abstractmethod
45 45 def push(self, line):
46 46 """Send a line of input to the transformer, returning the transformed
47 47 input or None if the transformer is waiting for more input.
48 48
49 49 Must be overridden by subclasses.
50
51 Implementations may raise ``SyntaxError`` if the input is invalid. No
52 other exceptions may be raised.
50 53 """
51 54 pass
52 55
53 56 @abc.abstractmethod
54 57 def reset(self):
55 58 """Return, transformed any lines that the transformer has accumulated,
56 59 and reset its internal state.
57 60
58 61 Must be overridden by subclasses.
59 62 """
60 63 pass
61 64
62 65 @classmethod
63 66 def wrap(cls, func):
64 67 """Can be used by subclasses as a decorator, to return a factory that
65 68 will allow instantiation with the decorated object.
66 69 """
67 70 @functools.wraps(func)
68 71 def transformer_factory(**kwargs):
69 72 return cls(func, **kwargs)
70 73
71 74 return transformer_factory
72 75
73 76 class StatelessInputTransformer(InputTransformer):
74 77 """Wrapper for a stateless input transformer implemented as a function."""
75 78 def __init__(self, func):
76 79 self.func = func
77 80
78 81 def __repr__(self):
79 82 return "StatelessInputTransformer(func={0!r})".format(self.func)
80 83
81 84 def push(self, line):
82 85 """Send a line of input to the transformer, returning the
83 86 transformed input."""
84 87 return self.func(line)
85 88
86 89 def reset(self):
87 90 """No-op - exists for compatibility."""
88 91 pass
89 92
90 93 class CoroutineInputTransformer(InputTransformer):
91 94 """Wrapper for an input transformer implemented as a coroutine."""
92 95 def __init__(self, coro, **kwargs):
93 96 # Prime it
94 97 self.coro = coro(**kwargs)
95 98 next(self.coro)
96 99
97 100 def __repr__(self):
98 101 return "CoroutineInputTransformer(coro={0!r})".format(self.coro)
99 102
100 103 def push(self, line):
101 104 """Send a line of input to the transformer, returning the
102 105 transformed input or None if the transformer is waiting for more
103 106 input.
104 107 """
105 108 return self.coro.send(line)
106 109
107 110 def reset(self):
108 111 """Return, transformed any lines that the transformer has
109 112 accumulated, and reset its internal state.
110 113 """
111 114 return self.coro.send(None)
112 115
113 116 class TokenInputTransformer(InputTransformer):
114 117 """Wrapper for a token-based input transformer.
115 118
116 119 func should accept a list of tokens (5-tuples, see tokenize docs), and
117 120 return an iterable which can be passed to tokenize.untokenize().
118 121 """
119 122 def __init__(self, func):
120 123 self.func = func
121 124 self.current_line = ""
122 125 self.line_used = False
123 126 self.reset_tokenizer()
124 127
125 128 def reset_tokenizer(self):
126 129 self.tokenizer = generate_tokens(self.get_line)
127 130
128 131 def get_line(self):
129 132 if self.line_used:
130 133 raise TokenError
131 134 self.line_used = True
132 135 return self.current_line
133 136
134 137 def push(self, line):
135 138 self.current_line += line + "\n"
136 139 if self.current_line.isspace():
137 140 return self.reset()
138 141
139 142 self.line_used = False
140 143 tokens = []
141 144 stop_at_NL = False
142 145 try:
143 146 for intok in self.tokenizer:
144 147 tokens.append(intok)
145 148 t = intok[0]
146 149 if t == tokenize2.NEWLINE or (stop_at_NL and t == tokenize2.NL):
147 150 # Stop before we try to pull a line we don't have yet
148 151 break
149 152 elif t == tokenize2.ERRORTOKEN:
150 153 stop_at_NL = True
151 154 except TokenError:
152 155 # Multi-line statement - stop and try again with the next line
153 156 self.reset_tokenizer()
154 157 return None
155 158
156 159 return self.output(tokens)
157 160
158 161 def output(self, tokens):
159 162 self.current_line = ""
160 163 self.reset_tokenizer()
161 164 return untokenize(self.func(tokens)).rstrip('\n')
162 165
163 166 def reset(self):
164 167 l = self.current_line
165 168 self.current_line = ""
166 169 self.reset_tokenizer()
167 170 if l:
168 171 return l.rstrip('\n')
169 172
170 173 class assemble_python_lines(TokenInputTransformer):
171 174 def __init__(self):
172 175 super(assemble_python_lines, self).__init__(None)
173 176
174 177 def output(self, tokens):
175 178 return self.reset()
176 179
177 180 @CoroutineInputTransformer.wrap
178 181 def assemble_logical_lines():
179 182 """Join lines following explicit line continuations (\)"""
180 183 line = ''
181 184 while True:
182 185 line = (yield line)
183 186 if not line or line.isspace():
184 187 continue
185 188
186 189 parts = []
187 190 while line is not None:
188 191 if line.endswith('\\') and (not has_comment(line)):
189 192 parts.append(line[:-1])
190 193 line = (yield None) # Get another line
191 194 else:
192 195 parts.append(line)
193 196 break
194 197
195 198 # Output
196 199 line = ''.join(parts)
197 200
198 201 # Utilities
199 202 def _make_help_call(target, esc, lspace, next_input=None):
200 203 """Prepares a pinfo(2)/psearch call from a target name and the escape
201 204 (i.e. ? or ??)"""
202 205 method = 'pinfo2' if esc == '??' \
203 206 else 'psearch' if '*' in target \
204 207 else 'pinfo'
205 208 arg = " ".join([method, target])
206 209 if next_input is None:
207 210 return '%sget_ipython().magic(%r)' % (lspace, arg)
208 211 else:
209 212 return '%sget_ipython().set_next_input(%r);get_ipython().magic(%r)' % \
210 213 (lspace, next_input, arg)
211 214
212 215 # These define the transformations for the different escape characters.
213 216 def _tr_system(line_info):
214 217 "Translate lines escaped with: !"
215 218 cmd = line_info.line.lstrip().lstrip(ESC_SHELL)
216 219 return '%sget_ipython().system(%r)' % (line_info.pre, cmd)
217 220
218 221 def _tr_system2(line_info):
219 222 "Translate lines escaped with: !!"
220 223 cmd = line_info.line.lstrip()[2:]
221 224 return '%sget_ipython().getoutput(%r)' % (line_info.pre, cmd)
222 225
223 226 def _tr_help(line_info):
224 227 "Translate lines escaped with: ?/??"
225 228 # A naked help line should just fire the intro help screen
226 229 if not line_info.line[1:]:
227 230 return 'get_ipython().show_usage()'
228 231
229 232 return _make_help_call(line_info.ifun, line_info.esc, line_info.pre)
230 233
231 234 def _tr_magic(line_info):
232 235 "Translate lines escaped with: %"
233 236 tpl = '%sget_ipython().magic(%r)'
234 237 if line_info.line.startswith(ESC_MAGIC2):
235 238 return line_info.line
236 239 cmd = ' '.join([line_info.ifun, line_info.the_rest]).strip()
237 240 return tpl % (line_info.pre, cmd)
238 241
239 242 def _tr_quote(line_info):
240 243 "Translate lines escaped with: ,"
241 244 return '%s%s("%s")' % (line_info.pre, line_info.ifun,
242 245 '", "'.join(line_info.the_rest.split()) )
243 246
244 247 def _tr_quote2(line_info):
245 248 "Translate lines escaped with: ;"
246 249 return '%s%s("%s")' % (line_info.pre, line_info.ifun,
247 250 line_info.the_rest)
248 251
249 252 def _tr_paren(line_info):
250 253 "Translate lines escaped with: /"
251 254 return '%s%s(%s)' % (line_info.pre, line_info.ifun,
252 255 ", ".join(line_info.the_rest.split()))
253 256
254 257 tr = { ESC_SHELL : _tr_system,
255 258 ESC_SH_CAP : _tr_system2,
256 259 ESC_HELP : _tr_help,
257 260 ESC_HELP2 : _tr_help,
258 261 ESC_MAGIC : _tr_magic,
259 262 ESC_QUOTE : _tr_quote,
260 263 ESC_QUOTE2 : _tr_quote2,
261 264 ESC_PAREN : _tr_paren }
262 265
263 266 @StatelessInputTransformer.wrap
264 267 def escaped_commands(line):
265 268 """Transform escaped commands - %magic, !system, ?help + various autocalls.
266 269 """
267 270 if not line or line.isspace():
268 271 return line
269 272 lineinf = LineInfo(line)
270 273 if lineinf.esc not in tr:
271 274 return line
272 275
273 276 return tr[lineinf.esc](lineinf)
274 277
275 278 _initial_space_re = re.compile(r'\s*')
276 279
277 280 _help_end_re = re.compile(r"""(%{0,2}
278 281 [a-zA-Z_*][\w*]* # Variable name
279 282 (\.[a-zA-Z_*][\w*]*)* # .etc.etc
280 283 )
281 284 (\?\??)$ # ? or ??
282 285 """,
283 286 re.VERBOSE)
284 287
285 288 # Extra pseudotokens for multiline strings and data structures
286 289 _MULTILINE_STRING = object()
287 290 _MULTILINE_STRUCTURE = object()
288 291
289 292 def _line_tokens(line):
290 293 """Helper for has_comment and ends_in_comment_or_string."""
291 294 readline = StringIO(line).readline
292 295 toktypes = set()
293 296 try:
294 297 for t in generate_tokens(readline):
295 298 toktypes.add(t[0])
296 299 except TokenError as e:
297 300 # There are only two cases where a TokenError is raised.
298 301 if 'multi-line string' in e.args[0]:
299 302 toktypes.add(_MULTILINE_STRING)
300 303 else:
301 304 toktypes.add(_MULTILINE_STRUCTURE)
302 305 return toktypes
303 306
304 307 def has_comment(src):
305 308 """Indicate whether an input line has (i.e. ends in, or is) a comment.
306 309
307 310 This uses tokenize, so it can distinguish comments from # inside strings.
308 311
309 312 Parameters
310 313 ----------
311 314 src : string
312 315 A single line input string.
313 316
314 317 Returns
315 318 -------
316 319 comment : bool
317 320 True if source has a comment.
318 321 """
319 322 return (tokenize2.COMMENT in _line_tokens(src))
320 323
321 324 def ends_in_comment_or_string(src):
322 325 """Indicates whether or not an input line ends in a comment or within
323 326 a multiline string.
324 327
325 328 Parameters
326 329 ----------
327 330 src : string
328 331 A single line input string.
329 332
330 333 Returns
331 334 -------
332 335 comment : bool
333 336 True if source ends in a comment or multiline string.
334 337 """
335 338 toktypes = _line_tokens(src)
336 339 return (tokenize2.COMMENT in toktypes) or (_MULTILINE_STRING in toktypes)
337 340
338 341
339 342 @StatelessInputTransformer.wrap
340 343 def help_end(line):
341 344 """Translate lines with ?/?? at the end"""
342 345 m = _help_end_re.search(line)
343 346 if m is None or ends_in_comment_or_string(line):
344 347 return line
345 348 target = m.group(1)
346 349 esc = m.group(3)
347 350 lspace = _initial_space_re.match(line).group(0)
348 351
349 352 # If we're mid-command, put it back on the next prompt for the user.
350 353 next_input = line.rstrip('?') if line.strip() != m.group(0) else None
351 354
352 355 return _make_help_call(target, esc, lspace, next_input)
353 356
354 357
355 358 @CoroutineInputTransformer.wrap
356 359 def cellmagic(end_on_blank_line=False):
357 360 """Captures & transforms cell magics.
358 361
359 362 After a cell magic is started, this stores up any lines it gets until it is
360 363 reset (sent None).
361 364 """
362 365 tpl = 'get_ipython().run_cell_magic(%r, %r, %r)'
363 366 cellmagic_help_re = re.compile('%%\w+\?')
364 367 line = ''
365 368 while True:
366 369 line = (yield line)
367 370 # consume leading empty lines
368 371 while not line:
369 372 line = (yield line)
370 373
371 374 if not line.startswith(ESC_MAGIC2):
372 375 # This isn't a cell magic, idle waiting for reset then start over
373 376 while line is not None:
374 377 line = (yield line)
375 378 continue
376 379
377 380 if cellmagic_help_re.match(line):
378 381 # This case will be handled by help_end
379 382 continue
380 383
381 384 first = line
382 385 body = []
383 386 line = (yield None)
384 387 while (line is not None) and \
385 388 ((line.strip() != '') or not end_on_blank_line):
386 389 body.append(line)
387 390 line = (yield None)
388 391
389 392 # Output
390 393 magic_name, _, first = first.partition(' ')
391 394 magic_name = magic_name.lstrip(ESC_MAGIC2)
392 395 line = tpl % (magic_name, first, u'\n'.join(body))
393 396
394 397
395 398 def _strip_prompts(prompt_re, initial_re=None):
396 399 """Remove matching input prompts from a block of input.
397 400
398 401 Parameters
399 402 ----------
400 403 prompt_re : regular expression
401 404 A regular expression matching any input prompt (including continuation)
402 405 initial_re : regular expression, optional
403 406 A regular expression matching only the initial prompt, but not continuation.
404 407 If no initial expression is given, prompt_re will be used everywhere.
405 408 Used mainly for plain Python prompts, where the continuation prompt
406 409 ``...`` is a valid Python expression in Python 3, so shouldn't be stripped.
407 410
408 411 If initial_re and prompt_re differ,
409 412 only initial_re will be tested against the first line.
410 413 If any prompt is found on the first two lines,
411 414 prompts will be stripped from the rest of the block.
412 415 """
413 416 if initial_re is None:
414 417 initial_re = prompt_re
415 418 line = ''
416 419 while True:
417 420 line = (yield line)
418 421
419 422 # First line of cell
420 423 if line is None:
421 424 continue
422 425 out, n1 = initial_re.subn('', line, count=1)
423 426 line = (yield out)
424 427
425 428 if line is None:
426 429 continue
427 430 # check for any prompt on the second line of the cell,
428 431 # because people often copy from just after the first prompt,
429 432 # so we might not see it in the first line.
430 433 out, n2 = prompt_re.subn('', line, count=1)
431 434 line = (yield out)
432 435
433 436 if n1 or n2:
434 437 # Found a prompt in the first two lines - check for it in
435 438 # the rest of the cell as well.
436 439 while line is not None:
437 440 line = (yield prompt_re.sub('', line, count=1))
438 441
439 442 else:
440 443 # Prompts not in input - wait for reset
441 444 while line is not None:
442 445 line = (yield line)
443 446
444 447 @CoroutineInputTransformer.wrap
445 448 def classic_prompt():
446 449 """Strip the >>>/... prompts of the Python interactive shell."""
447 450 # FIXME: non-capturing version (?:...) usable?
448 451 prompt_re = re.compile(r'^(>>> ?|\.\.\. ?)')
449 452 initial_re = re.compile(r'^(>>> ?)')
450 453 return _strip_prompts(prompt_re, initial_re)
451 454
452 455 @CoroutineInputTransformer.wrap
453 456 def ipy_prompt():
454 457 """Strip IPython's In [1]:/...: prompts."""
455 458 # FIXME: non-capturing version (?:...) usable?
456 459 # FIXME: r'^(In \[\d+\]: | {3}\.{3,}: )' clearer?
457 460 prompt_re = re.compile(r'^(In \[\d+\]: |\ \ \ \.\.\.+: )')
458 461 return _strip_prompts(prompt_re)
459 462
460 463
461 464 @CoroutineInputTransformer.wrap
462 465 def leading_indent():
463 466 """Remove leading indentation.
464 467
465 468 If the first line starts with a spaces or tabs, the same whitespace will be
466 469 removed from each following line until it is reset.
467 470 """
468 471 space_re = re.compile(r'^[ \t]+')
469 472 line = ''
470 473 while True:
471 474 line = (yield line)
472 475
473 476 if line is None:
474 477 continue
475 478
476 479 m = space_re.match(line)
477 480 if m:
478 481 space = m.group(0)
479 482 while line is not None:
480 483 if line.startswith(space):
481 484 line = line[len(space):]
482 485 line = (yield line)
483 486 else:
484 487 # No leading spaces - wait for reset
485 488 while line is not None:
486 489 line = (yield line)
487 490
488 491
489 492 @CoroutineInputTransformer.wrap
490 493 def strip_encoding_cookie():
491 494 """Remove encoding comment if found in first two lines
492 495
493 496 If the first or second line has the `# coding: utf-8` comment,
494 497 it will be removed.
495 498 """
496 499 line = ''
497 500 while True:
498 501 line = (yield line)
499 502 # check comment on first two lines
500 503 for i in range(2):
501 504 if line is None:
502 505 break
503 506 if cookie_comment_re.match(line):
504 507 line = (yield "")
505 508 else:
506 509 line = (yield line)
507 510
508 511 # no-op on the rest of the cell
509 512 while line is not None:
510 513 line = (yield line)
511 514
512 515
513 516 assign_system_re = re.compile(r'(?P<lhs>(\s*)([\w\.]+)((\s*,\s*[\w\.]+)*))'
514 517 r'\s*=\s*!\s*(?P<cmd>.*)')
515 518 assign_system_template = '%s = get_ipython().getoutput(%r)'
516 519 @StatelessInputTransformer.wrap
517 520 def assign_from_system(line):
518 521 """Transform assignment from system commands (e.g. files = !ls)"""
519 522 m = assign_system_re.match(line)
520 523 if m is None:
521 524 return line
522 525
523 526 return assign_system_template % m.group('lhs', 'cmd')
524 527
525 528 assign_magic_re = re.compile(r'(?P<lhs>(\s*)([\w\.]+)((\s*,\s*[\w\.]+)*))'
526 529 r'\s*=\s*%\s*(?P<cmd>.*)')
527 530 assign_magic_template = '%s = get_ipython().magic(%r)'
528 531 @StatelessInputTransformer.wrap
529 532 def assign_from_magic(line):
530 533 """Transform assignment from magic commands (e.g. a = %who_ls)"""
531 534 m = assign_magic_re.match(line)
532 535 if m is None:
533 536 return line
534 537
535 538 return assign_magic_template % m.group('lhs', 'cmd')
@@ -1,3166 +1,3170 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Main IPython class."""
3 3
4 4 #-----------------------------------------------------------------------------
5 5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
6 6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
7 7 # Copyright (C) 2008-2011 The IPython Development Team
8 8 #
9 9 # Distributed under the terms of the BSD License. The full license is in
10 10 # the file COPYING, distributed as part of this software.
11 11 #-----------------------------------------------------------------------------
12 12
13 13 #-----------------------------------------------------------------------------
14 14 # Imports
15 15 #-----------------------------------------------------------------------------
16 16
17 17 from __future__ import absolute_import
18 18 from __future__ import print_function
19 19
20 20 import __future__
21 21 import abc
22 22 import ast
23 23 import atexit
24 24 import functools
25 25 import os
26 26 import re
27 27 import runpy
28 28 import sys
29 29 import tempfile
30 30 import types
31 31 import subprocess
32 32 from io import open as io_open
33 33
34 34 from IPython.config.configurable import SingletonConfigurable
35 35 from IPython.core import debugger, oinspect
36 36 from IPython.core import magic
37 37 from IPython.core import page
38 38 from IPython.core import prefilter
39 39 from IPython.core import shadowns
40 40 from IPython.core import ultratb
41 41 from IPython.core.alias import AliasManager, AliasError
42 42 from IPython.core.autocall import ExitAutocall
43 43 from IPython.core.builtin_trap import BuiltinTrap
44 44 from IPython.core.compilerop import CachingCompiler, check_linecache_ipython
45 45 from IPython.core.display_trap import DisplayTrap
46 46 from IPython.core.displayhook import DisplayHook
47 47 from IPython.core.displaypub import DisplayPublisher
48 48 from IPython.core.error import UsageError
49 49 from IPython.core.extensions import ExtensionManager
50 50 from IPython.core.formatters import DisplayFormatter
51 51 from IPython.core.history import HistoryManager
52 52 from IPython.core.inputsplitter import IPythonInputSplitter, ESC_MAGIC, ESC_MAGIC2
53 53 from IPython.core.logger import Logger
54 54 from IPython.core.macro import Macro
55 55 from IPython.core.payload import PayloadManager
56 56 from IPython.core.prefilter import PrefilterManager
57 57 from IPython.core.profiledir import ProfileDir
58 58 from IPython.core.prompts import PromptManager
59 59 from IPython.lib.latextools import LaTeXTool
60 60 from IPython.testing.skipdoctest import skip_doctest
61 61 from IPython.utils import PyColorize
62 62 from IPython.utils import io
63 63 from IPython.utils import py3compat
64 64 from IPython.utils import openpy
65 65 from IPython.utils.decorators import undoc
66 66 from IPython.utils.io import ask_yes_no
67 67 from IPython.utils.ipstruct import Struct
68 68 from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename
69 69 from IPython.utils.pickleshare import PickleShareDB
70 70 from IPython.utils.process import system, getoutput
71 71 from IPython.utils.py3compat import (builtin_mod, unicode_type, string_types,
72 72 with_metaclass, iteritems)
73 73 from IPython.utils.strdispatch import StrDispatch
74 74 from IPython.utils.syspathcontext import prepended_to_syspath
75 75 from IPython.utils.text import (format_screen, LSString, SList,
76 76 DollarFormatter)
77 77 from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum,
78 78 List, Unicode, Instance, Type)
79 79 from IPython.utils.warn import warn, error
80 80 import IPython.core.hooks
81 81
82 82 #-----------------------------------------------------------------------------
83 83 # Globals
84 84 #-----------------------------------------------------------------------------
85 85
86 86 # compiled regexps for autoindent management
87 87 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
88 88
89 89 #-----------------------------------------------------------------------------
90 90 # Utilities
91 91 #-----------------------------------------------------------------------------
92 92
93 93 @undoc
94 94 def softspace(file, newvalue):
95 95 """Copied from code.py, to remove the dependency"""
96 96
97 97 oldvalue = 0
98 98 try:
99 99 oldvalue = file.softspace
100 100 except AttributeError:
101 101 pass
102 102 try:
103 103 file.softspace = newvalue
104 104 except (AttributeError, TypeError):
105 105 # "attribute-less object" or "read-only attributes"
106 106 pass
107 107 return oldvalue
108 108
109 109 @undoc
110 110 def no_op(*a, **kw): pass
111 111
112 112 @undoc
113 113 class NoOpContext(object):
114 114 def __enter__(self): pass
115 115 def __exit__(self, type, value, traceback): pass
116 116 no_op_context = NoOpContext()
117 117
118 118 class SpaceInInput(Exception): pass
119 119
120 120 @undoc
121 121 class Bunch: pass
122 122
123 123
124 124 def get_default_colors():
125 125 if sys.platform=='darwin':
126 126 return "LightBG"
127 127 elif os.name=='nt':
128 128 return 'Linux'
129 129 else:
130 130 return 'Linux'
131 131
132 132
133 133 class SeparateUnicode(Unicode):
134 134 """A Unicode subclass to validate separate_in, separate_out, etc.
135 135
136 136 This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'.
137 137 """
138 138
139 139 def validate(self, obj, value):
140 140 if value == '0': value = ''
141 141 value = value.replace('\\n','\n')
142 142 return super(SeparateUnicode, self).validate(obj, value)
143 143
144 144
145 145 class ReadlineNoRecord(object):
146 146 """Context manager to execute some code, then reload readline history
147 147 so that interactive input to the code doesn't appear when pressing up."""
148 148 def __init__(self, shell):
149 149 self.shell = shell
150 150 self._nested_level = 0
151 151
152 152 def __enter__(self):
153 153 if self._nested_level == 0:
154 154 try:
155 155 self.orig_length = self.current_length()
156 156 self.readline_tail = self.get_readline_tail()
157 157 except (AttributeError, IndexError): # Can fail with pyreadline
158 158 self.orig_length, self.readline_tail = 999999, []
159 159 self._nested_level += 1
160 160
161 161 def __exit__(self, type, value, traceback):
162 162 self._nested_level -= 1
163 163 if self._nested_level == 0:
164 164 # Try clipping the end if it's got longer
165 165 try:
166 166 e = self.current_length() - self.orig_length
167 167 if e > 0:
168 168 for _ in range(e):
169 169 self.shell.readline.remove_history_item(self.orig_length)
170 170
171 171 # If it still doesn't match, just reload readline history.
172 172 if self.current_length() != self.orig_length \
173 173 or self.get_readline_tail() != self.readline_tail:
174 174 self.shell.refill_readline_hist()
175 175 except (AttributeError, IndexError):
176 176 pass
177 177 # Returning False will cause exceptions to propagate
178 178 return False
179 179
180 180 def current_length(self):
181 181 return self.shell.readline.get_current_history_length()
182 182
183 183 def get_readline_tail(self, n=10):
184 184 """Get the last n items in readline history."""
185 185 end = self.shell.readline.get_current_history_length() + 1
186 186 start = max(end-n, 1)
187 187 ghi = self.shell.readline.get_history_item
188 188 return [ghi(x) for x in range(start, end)]
189 189
190 190
191 191 @undoc
192 192 class DummyMod(object):
193 193 """A dummy module used for IPython's interactive module when
194 194 a namespace must be assigned to the module's __dict__."""
195 195 pass
196 196
197 197 #-----------------------------------------------------------------------------
198 198 # Main IPython class
199 199 #-----------------------------------------------------------------------------
200 200
201 201 class InteractiveShell(SingletonConfigurable):
202 202 """An enhanced, interactive shell for Python."""
203 203
204 204 _instance = None
205 205
206 206 ast_transformers = List([], config=True, help=
207 207 """
208 208 A list of ast.NodeTransformer subclass instances, which will be applied
209 209 to user input before code is run.
210 210 """
211 211 )
212 212
213 213 autocall = Enum((0,1,2), default_value=0, config=True, help=
214 214 """
215 215 Make IPython automatically call any callable object even if you didn't
216 216 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
217 217 automatically. The value can be '0' to disable the feature, '1' for
218 218 'smart' autocall, where it is not applied if there are no more
219 219 arguments on the line, and '2' for 'full' autocall, where all callable
220 220 objects are automatically called (even if no arguments are present).
221 221 """
222 222 )
223 223 # TODO: remove all autoindent logic and put into frontends.
224 224 # We can't do this yet because even runlines uses the autoindent.
225 225 autoindent = CBool(True, config=True, help=
226 226 """
227 227 Autoindent IPython code entered interactively.
228 228 """
229 229 )
230 230 automagic = CBool(True, config=True, help=
231 231 """
232 232 Enable magic commands to be called without the leading %.
233 233 """
234 234 )
235 235 cache_size = Integer(1000, config=True, help=
236 236 """
237 237 Set the size of the output cache. The default is 1000, you can
238 238 change it permanently in your config file. Setting it to 0 completely
239 239 disables the caching system, and the minimum value accepted is 20 (if
240 240 you provide a value less than 20, it is reset to 0 and a warning is
241 241 issued). This limit is defined because otherwise you'll spend more
242 242 time re-flushing a too small cache than working
243 243 """
244 244 )
245 245 color_info = CBool(True, config=True, help=
246 246 """
247 247 Use colors for displaying information about objects. Because this
248 248 information is passed through a pager (like 'less'), and some pagers
249 249 get confused with color codes, this capability can be turned off.
250 250 """
251 251 )
252 252 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
253 253 default_value=get_default_colors(), config=True,
254 254 help="Set the color scheme (NoColor, Linux, or LightBG)."
255 255 )
256 256 colors_force = CBool(False, help=
257 257 """
258 258 Force use of ANSI color codes, regardless of OS and readline
259 259 availability.
260 260 """
261 261 # FIXME: This is essentially a hack to allow ZMQShell to show colors
262 262 # without readline on Win32. When the ZMQ formatting system is
263 263 # refactored, this should be removed.
264 264 )
265 265 debug = CBool(False, config=True)
266 266 deep_reload = CBool(False, config=True, help=
267 267 """
268 268 Enable deep (recursive) reloading by default. IPython can use the
269 269 deep_reload module which reloads changes in modules recursively (it
270 270 replaces the reload() function, so you don't need to change anything to
271 271 use it). deep_reload() forces a full reload of modules whose code may
272 272 have changed, which the default reload() function does not. When
273 273 deep_reload is off, IPython will use the normal reload(), but
274 274 deep_reload will still be available as dreload().
275 275 """
276 276 )
277 277 disable_failing_post_execute = CBool(False, config=True,
278 278 help="Don't call post-execute functions that have failed in the past."
279 279 )
280 280 display_formatter = Instance(DisplayFormatter)
281 281 displayhook_class = Type(DisplayHook)
282 282 display_pub_class = Type(DisplayPublisher)
283 283 data_pub_class = None
284 284
285 285 exit_now = CBool(False)
286 286 exiter = Instance(ExitAutocall)
287 287 def _exiter_default(self):
288 288 return ExitAutocall(self)
289 289 # Monotonically increasing execution counter
290 290 execution_count = Integer(1)
291 291 filename = Unicode("<ipython console>")
292 292 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
293 293
294 294 # Input splitter, to transform input line by line and detect when a block
295 295 # is ready to be executed.
296 296 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
297 297 (), {'line_input_checker': True})
298 298
299 299 # This InputSplitter instance is used to transform completed cells before
300 300 # running them. It allows cell magics to contain blank lines.
301 301 input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
302 302 (), {'line_input_checker': False})
303 303
304 304 logstart = CBool(False, config=True, help=
305 305 """
306 306 Start logging to the default log file.
307 307 """
308 308 )
309 309 logfile = Unicode('', config=True, help=
310 310 """
311 311 The name of the logfile to use.
312 312 """
313 313 )
314 314 logappend = Unicode('', config=True, help=
315 315 """
316 316 Start logging to the given file in append mode.
317 317 """
318 318 )
319 319 object_info_string_level = Enum((0,1,2), default_value=0,
320 320 config=True)
321 321 pdb = CBool(False, config=True, help=
322 322 """
323 323 Automatically call the pdb debugger after every exception.
324 324 """
325 325 )
326 326 multiline_history = CBool(sys.platform != 'win32', config=True,
327 327 help="Save multi-line entries as one entry in readline history"
328 328 )
329 329
330 330 # deprecated prompt traits:
331 331
332 332 prompt_in1 = Unicode('In [\\#]: ', config=True,
333 333 help="Deprecated, use PromptManager.in_template")
334 334 prompt_in2 = Unicode(' .\\D.: ', config=True,
335 335 help="Deprecated, use PromptManager.in2_template")
336 336 prompt_out = Unicode('Out[\\#]: ', config=True,
337 337 help="Deprecated, use PromptManager.out_template")
338 338 prompts_pad_left = CBool(True, config=True,
339 339 help="Deprecated, use PromptManager.justify")
340 340
341 341 def _prompt_trait_changed(self, name, old, new):
342 342 table = {
343 343 'prompt_in1' : 'in_template',
344 344 'prompt_in2' : 'in2_template',
345 345 'prompt_out' : 'out_template',
346 346 'prompts_pad_left' : 'justify',
347 347 }
348 348 warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}".format(
349 349 name=name, newname=table[name])
350 350 )
351 351 # protect against weird cases where self.config may not exist:
352 352 if self.config is not None:
353 353 # propagate to corresponding PromptManager trait
354 354 setattr(self.config.PromptManager, table[name], new)
355 355
356 356 _prompt_in1_changed = _prompt_trait_changed
357 357 _prompt_in2_changed = _prompt_trait_changed
358 358 _prompt_out_changed = _prompt_trait_changed
359 359 _prompt_pad_left_changed = _prompt_trait_changed
360 360
361 361 show_rewritten_input = CBool(True, config=True,
362 362 help="Show rewritten input, e.g. for autocall."
363 363 )
364 364
365 365 quiet = CBool(False, config=True)
366 366
367 367 history_length = Integer(10000, config=True)
368 368
369 369 # The readline stuff will eventually be moved to the terminal subclass
370 370 # but for now, we can't do that as readline is welded in everywhere.
371 371 readline_use = CBool(True, config=True)
372 372 readline_remove_delims = Unicode('-/~', config=True)
373 373 readline_delims = Unicode() # set by init_readline()
374 374 # don't use \M- bindings by default, because they
375 375 # conflict with 8-bit encodings. See gh-58,gh-88
376 376 readline_parse_and_bind = List([
377 377 'tab: complete',
378 378 '"\C-l": clear-screen',
379 379 'set show-all-if-ambiguous on',
380 380 '"\C-o": tab-insert',
381 381 '"\C-r": reverse-search-history',
382 382 '"\C-s": forward-search-history',
383 383 '"\C-p": history-search-backward',
384 384 '"\C-n": history-search-forward',
385 385 '"\e[A": history-search-backward',
386 386 '"\e[B": history-search-forward',
387 387 '"\C-k": kill-line',
388 388 '"\C-u": unix-line-discard',
389 389 ], allow_none=False, config=True)
390 390
391 391 ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none'],
392 392 default_value='last_expr', config=True,
393 393 help="""
394 394 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
395 395 run interactively (displaying output from expressions).""")
396 396
397 397 # TODO: this part of prompt management should be moved to the frontends.
398 398 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
399 399 separate_in = SeparateUnicode('\n', config=True)
400 400 separate_out = SeparateUnicode('', config=True)
401 401 separate_out2 = SeparateUnicode('', config=True)
402 402 wildcards_case_sensitive = CBool(True, config=True)
403 403 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
404 404 default_value='Context', config=True)
405 405
406 406 # Subcomponents of InteractiveShell
407 407 alias_manager = Instance('IPython.core.alias.AliasManager')
408 408 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
409 409 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
410 410 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
411 411 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
412 412 payload_manager = Instance('IPython.core.payload.PayloadManager')
413 413 history_manager = Instance('IPython.core.history.HistoryManager')
414 414 magics_manager = Instance('IPython.core.magic.MagicsManager')
415 415
416 416 profile_dir = Instance('IPython.core.application.ProfileDir')
417 417 @property
418 418 def profile(self):
419 419 if self.profile_dir is not None:
420 420 name = os.path.basename(self.profile_dir.location)
421 421 return name.replace('profile_','')
422 422
423 423
424 424 # Private interface
425 425 _post_execute = Instance(dict)
426 426
427 427 # Tracks any GUI loop loaded for pylab
428 428 pylab_gui_select = None
429 429
430 430 def __init__(self, ipython_dir=None, profile_dir=None,
431 431 user_module=None, user_ns=None,
432 432 custom_exceptions=((), None), **kwargs):
433 433
434 434 # This is where traits with a config_key argument are updated
435 435 # from the values on config.
436 436 super(InteractiveShell, self).__init__(**kwargs)
437 437 self.configurables = [self]
438 438
439 439 # These are relatively independent and stateless
440 440 self.init_ipython_dir(ipython_dir)
441 441 self.init_profile_dir(profile_dir)
442 442 self.init_instance_attrs()
443 443 self.init_environment()
444 444
445 445 # Check if we're in a virtualenv, and set up sys.path.
446 446 self.init_virtualenv()
447 447
448 448 # Create namespaces (user_ns, user_global_ns, etc.)
449 449 self.init_create_namespaces(user_module, user_ns)
450 450 # This has to be done after init_create_namespaces because it uses
451 451 # something in self.user_ns, but before init_sys_modules, which
452 452 # is the first thing to modify sys.
453 453 # TODO: When we override sys.stdout and sys.stderr before this class
454 454 # is created, we are saving the overridden ones here. Not sure if this
455 455 # is what we want to do.
456 456 self.save_sys_module_state()
457 457 self.init_sys_modules()
458 458
459 459 # While we're trying to have each part of the code directly access what
460 460 # it needs without keeping redundant references to objects, we have too
461 461 # much legacy code that expects ip.db to exist.
462 462 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
463 463
464 464 self.init_history()
465 465 self.init_encoding()
466 466 self.init_prefilter()
467 467
468 468 self.init_syntax_highlighting()
469 469 self.init_hooks()
470 470 self.init_pushd_popd_magic()
471 471 # self.init_traceback_handlers use to be here, but we moved it below
472 472 # because it and init_io have to come after init_readline.
473 473 self.init_user_ns()
474 474 self.init_logger()
475 475 self.init_builtins()
476 476
477 477 # The following was in post_config_initialization
478 478 self.init_inspector()
479 479 # init_readline() must come before init_io(), because init_io uses
480 480 # readline related things.
481 481 self.init_readline()
482 482 # We save this here in case user code replaces raw_input, but it needs
483 483 # to be after init_readline(), because PyPy's readline works by replacing
484 484 # raw_input.
485 485 if py3compat.PY3:
486 486 self.raw_input_original = input
487 487 else:
488 488 self.raw_input_original = raw_input
489 489 # init_completer must come after init_readline, because it needs to
490 490 # know whether readline is present or not system-wide to configure the
491 491 # completers, since the completion machinery can now operate
492 492 # independently of readline (e.g. over the network)
493 493 self.init_completer()
494 494 # TODO: init_io() needs to happen before init_traceback handlers
495 495 # because the traceback handlers hardcode the stdout/stderr streams.
496 496 # This logic in in debugger.Pdb and should eventually be changed.
497 497 self.init_io()
498 498 self.init_traceback_handlers(custom_exceptions)
499 499 self.init_prompts()
500 500 self.init_display_formatter()
501 501 self.init_display_pub()
502 502 self.init_data_pub()
503 503 self.init_displayhook()
504 504 self.init_latextool()
505 505 self.init_magics()
506 506 self.init_alias()
507 507 self.init_logstart()
508 508 self.init_pdb()
509 509 self.init_extension_manager()
510 510 self.init_payload()
511 511 self.init_comms()
512 512 self.hooks.late_startup_hook()
513 513 atexit.register(self.atexit_operations)
514 514
515 515 def get_ipython(self):
516 516 """Return the currently running IPython instance."""
517 517 return self
518 518
519 519 #-------------------------------------------------------------------------
520 520 # Trait changed handlers
521 521 #-------------------------------------------------------------------------
522 522
523 523 def _ipython_dir_changed(self, name, new):
524 524 if not os.path.isdir(new):
525 525 os.makedirs(new, mode = 0o777)
526 526
527 527 def set_autoindent(self,value=None):
528 528 """Set the autoindent flag, checking for readline support.
529 529
530 530 If called with no arguments, it acts as a toggle."""
531 531
532 532 if value != 0 and not self.has_readline:
533 533 if os.name == 'posix':
534 534 warn("The auto-indent feature requires the readline library")
535 535 self.autoindent = 0
536 536 return
537 537 if value is None:
538 538 self.autoindent = not self.autoindent
539 539 else:
540 540 self.autoindent = value
541 541
542 542 #-------------------------------------------------------------------------
543 543 # init_* methods called by __init__
544 544 #-------------------------------------------------------------------------
545 545
546 546 def init_ipython_dir(self, ipython_dir):
547 547 if ipython_dir is not None:
548 548 self.ipython_dir = ipython_dir
549 549 return
550 550
551 551 self.ipython_dir = get_ipython_dir()
552 552
553 553 def init_profile_dir(self, profile_dir):
554 554 if profile_dir is not None:
555 555 self.profile_dir = profile_dir
556 556 return
557 557 self.profile_dir =\
558 558 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
559 559
560 560 def init_instance_attrs(self):
561 561 self.more = False
562 562
563 563 # command compiler
564 564 self.compile = CachingCompiler()
565 565
566 566 # Make an empty namespace, which extension writers can rely on both
567 567 # existing and NEVER being used by ipython itself. This gives them a
568 568 # convenient location for storing additional information and state
569 569 # their extensions may require, without fear of collisions with other
570 570 # ipython names that may develop later.
571 571 self.meta = Struct()
572 572
573 573 # Temporary files used for various purposes. Deleted at exit.
574 574 self.tempfiles = []
575 575
576 576 # Keep track of readline usage (later set by init_readline)
577 577 self.has_readline = False
578 578
579 579 # keep track of where we started running (mainly for crash post-mortem)
580 580 # This is not being used anywhere currently.
581 581 self.starting_dir = py3compat.getcwd()
582 582
583 583 # Indentation management
584 584 self.indent_current_nsp = 0
585 585
586 586 # Dict to track post-execution functions that have been registered
587 587 self._post_execute = {}
588 588
589 589 def init_environment(self):
590 590 """Any changes we need to make to the user's environment."""
591 591 pass
592 592
593 593 def init_encoding(self):
594 594 # Get system encoding at startup time. Certain terminals (like Emacs
595 595 # under Win32 have it set to None, and we need to have a known valid
596 596 # encoding to use in the raw_input() method
597 597 try:
598 598 self.stdin_encoding = sys.stdin.encoding or 'ascii'
599 599 except AttributeError:
600 600 self.stdin_encoding = 'ascii'
601 601
602 602 def init_syntax_highlighting(self):
603 603 # Python source parser/formatter for syntax highlighting
604 604 pyformat = PyColorize.Parser().format
605 605 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
606 606
607 607 def init_pushd_popd_magic(self):
608 608 # for pushd/popd management
609 609 self.home_dir = get_home_dir()
610 610
611 611 self.dir_stack = []
612 612
613 613 def init_logger(self):
614 614 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
615 615 logmode='rotate')
616 616
617 617 def init_logstart(self):
618 618 """Initialize logging in case it was requested at the command line.
619 619 """
620 620 if self.logappend:
621 621 self.magic('logstart %s append' % self.logappend)
622 622 elif self.logfile:
623 623 self.magic('logstart %s' % self.logfile)
624 624 elif self.logstart:
625 625 self.magic('logstart')
626 626
627 627 def init_builtins(self):
628 628 # A single, static flag that we set to True. Its presence indicates
629 629 # that an IPython shell has been created, and we make no attempts at
630 630 # removing on exit or representing the existence of more than one
631 631 # IPython at a time.
632 632 builtin_mod.__dict__['__IPYTHON__'] = True
633 633
634 634 # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to
635 635 # manage on enter/exit, but with all our shells it's virtually
636 636 # impossible to get all the cases right. We're leaving the name in for
637 637 # those who adapted their codes to check for this flag, but will
638 638 # eventually remove it after a few more releases.
639 639 builtin_mod.__dict__['__IPYTHON__active'] = \
640 640 'Deprecated, check for __IPYTHON__'
641 641
642 642 self.builtin_trap = BuiltinTrap(shell=self)
643 643
644 644 def init_inspector(self):
645 645 # Object inspector
646 646 self.inspector = oinspect.Inspector(oinspect.InspectColors,
647 647 PyColorize.ANSICodeColors,
648 648 'NoColor',
649 649 self.object_info_string_level)
650 650
651 651 def init_io(self):
652 652 # This will just use sys.stdout and sys.stderr. If you want to
653 653 # override sys.stdout and sys.stderr themselves, you need to do that
654 654 # *before* instantiating this class, because io holds onto
655 655 # references to the underlying streams.
656 656 if (sys.platform == 'win32' or sys.platform == 'cli') and self.has_readline:
657 657 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
658 658 else:
659 659 io.stdout = io.IOStream(sys.stdout)
660 660 io.stderr = io.IOStream(sys.stderr)
661 661
662 662 def init_prompts(self):
663 663 self.prompt_manager = PromptManager(shell=self, parent=self)
664 664 self.configurables.append(self.prompt_manager)
665 665 # Set system prompts, so that scripts can decide if they are running
666 666 # interactively.
667 667 sys.ps1 = 'In : '
668 668 sys.ps2 = '...: '
669 669 sys.ps3 = 'Out: '
670 670
671 671 def init_display_formatter(self):
672 672 self.display_formatter = DisplayFormatter(parent=self)
673 673 self.configurables.append(self.display_formatter)
674 674
675 675 def init_display_pub(self):
676 676 self.display_pub = self.display_pub_class(parent=self)
677 677 self.configurables.append(self.display_pub)
678 678
679 679 def init_data_pub(self):
680 680 if not self.data_pub_class:
681 681 self.data_pub = None
682 682 return
683 683 self.data_pub = self.data_pub_class(parent=self)
684 684 self.configurables.append(self.data_pub)
685 685
686 686 def init_displayhook(self):
687 687 # Initialize displayhook, set in/out prompts and printing system
688 688 self.displayhook = self.displayhook_class(
689 689 parent=self,
690 690 shell=self,
691 691 cache_size=self.cache_size,
692 692 )
693 693 self.configurables.append(self.displayhook)
694 694 # This is a context manager that installs/revmoes the displayhook at
695 695 # the appropriate time.
696 696 self.display_trap = DisplayTrap(hook=self.displayhook)
697 697
698 698 def init_latextool(self):
699 699 """Configure LaTeXTool."""
700 700 cfg = LaTeXTool.instance(parent=self)
701 701 if cfg not in self.configurables:
702 702 self.configurables.append(cfg)
703 703
704 704 def init_virtualenv(self):
705 705 """Add a virtualenv to sys.path so the user can import modules from it.
706 706 This isn't perfect: it doesn't use the Python interpreter with which the
707 707 virtualenv was built, and it ignores the --no-site-packages option. A
708 708 warning will appear suggesting the user installs IPython in the
709 709 virtualenv, but for many cases, it probably works well enough.
710 710
711 711 Adapted from code snippets online.
712 712
713 713 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
714 714 """
715 715 if 'VIRTUAL_ENV' not in os.environ:
716 716 # Not in a virtualenv
717 717 return
718 718
719 719 if os.path.realpath(sys.executable).startswith(
720 720 os.path.realpath(os.environ['VIRTUAL_ENV'])
721 721 ):
722 722 # Running properly in the virtualenv, don't need to do anything
723 723 return
724 724
725 725 warn("Attempting to work in a virtualenv. If you encounter problems, please "
726 726 "install IPython inside the virtualenv.")
727 727 if sys.platform == "win32":
728 728 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')
729 729 else:
730 730 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',
731 731 'python%d.%d' % sys.version_info[:2], 'site-packages')
732 732
733 733 import site
734 734 sys.path.insert(0, virtual_env)
735 735 site.addsitedir(virtual_env)
736 736
737 737 #-------------------------------------------------------------------------
738 738 # Things related to injections into the sys module
739 739 #-------------------------------------------------------------------------
740 740
741 741 def save_sys_module_state(self):
742 742 """Save the state of hooks in the sys module.
743 743
744 744 This has to be called after self.user_module is created.
745 745 """
746 746 self._orig_sys_module_state = {}
747 747 self._orig_sys_module_state['stdin'] = sys.stdin
748 748 self._orig_sys_module_state['stdout'] = sys.stdout
749 749 self._orig_sys_module_state['stderr'] = sys.stderr
750 750 self._orig_sys_module_state['excepthook'] = sys.excepthook
751 751 self._orig_sys_modules_main_name = self.user_module.__name__
752 752 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
753 753
754 754 def restore_sys_module_state(self):
755 755 """Restore the state of the sys module."""
756 756 try:
757 757 for k, v in iteritems(self._orig_sys_module_state):
758 758 setattr(sys, k, v)
759 759 except AttributeError:
760 760 pass
761 761 # Reset what what done in self.init_sys_modules
762 762 if self._orig_sys_modules_main_mod is not None:
763 763 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
764 764
765 765 #-------------------------------------------------------------------------
766 766 # Things related to hooks
767 767 #-------------------------------------------------------------------------
768 768
769 769 def init_hooks(self):
770 770 # hooks holds pointers used for user-side customizations
771 771 self.hooks = Struct()
772 772
773 773 self.strdispatchers = {}
774 774
775 775 # Set all default hooks, defined in the IPython.hooks module.
776 776 hooks = IPython.core.hooks
777 777 for hook_name in hooks.__all__:
778 778 # default hooks have priority 100, i.e. low; user hooks should have
779 779 # 0-100 priority
780 780 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
781 781
782 782 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
783 783 """set_hook(name,hook) -> sets an internal IPython hook.
784 784
785 785 IPython exposes some of its internal API as user-modifiable hooks. By
786 786 adding your function to one of these hooks, you can modify IPython's
787 787 behavior to call at runtime your own routines."""
788 788
789 789 # At some point in the future, this should validate the hook before it
790 790 # accepts it. Probably at least check that the hook takes the number
791 791 # of args it's supposed to.
792 792
793 793 f = types.MethodType(hook,self)
794 794
795 795 # check if the hook is for strdispatcher first
796 796 if str_key is not None:
797 797 sdp = self.strdispatchers.get(name, StrDispatch())
798 798 sdp.add_s(str_key, f, priority )
799 799 self.strdispatchers[name] = sdp
800 800 return
801 801 if re_key is not None:
802 802 sdp = self.strdispatchers.get(name, StrDispatch())
803 803 sdp.add_re(re.compile(re_key), f, priority )
804 804 self.strdispatchers[name] = sdp
805 805 return
806 806
807 807 dp = getattr(self.hooks, name, None)
808 808 if name not in IPython.core.hooks.__all__:
809 809 print("Warning! Hook '%s' is not one of %s" % \
810 810 (name, IPython.core.hooks.__all__ ))
811 811 if not dp:
812 812 dp = IPython.core.hooks.CommandChainDispatcher()
813 813
814 814 try:
815 815 dp.add(f,priority)
816 816 except AttributeError:
817 817 # it was not commandchain, plain old func - replace
818 818 dp = f
819 819
820 820 setattr(self.hooks,name, dp)
821 821
822 822 def register_post_execute(self, func):
823 823 """Register a function for calling after code execution.
824 824 """
825 825 if not callable(func):
826 826 raise ValueError('argument %s must be callable' % func)
827 827 self._post_execute[func] = True
828 828
829 829 #-------------------------------------------------------------------------
830 830 # Things related to the "main" module
831 831 #-------------------------------------------------------------------------
832 832
833 833 def new_main_mod(self, filename, modname):
834 834 """Return a new 'main' module object for user code execution.
835 835
836 836 ``filename`` should be the path of the script which will be run in the
837 837 module. Requests with the same filename will get the same module, with
838 838 its namespace cleared.
839 839
840 840 ``modname`` should be the module name - normally either '__main__' or
841 841 the basename of the file without the extension.
842 842
843 843 When scripts are executed via %run, we must keep a reference to their
844 844 __main__ module around so that Python doesn't
845 845 clear it, rendering references to module globals useless.
846 846
847 847 This method keeps said reference in a private dict, keyed by the
848 848 absolute path of the script. This way, for multiple executions of the
849 849 same script we only keep one copy of the namespace (the last one),
850 850 thus preventing memory leaks from old references while allowing the
851 851 objects from the last execution to be accessible.
852 852 """
853 853 filename = os.path.abspath(filename)
854 854 try:
855 855 main_mod = self._main_mod_cache[filename]
856 856 except KeyError:
857 857 main_mod = self._main_mod_cache[filename] = types.ModuleType(modname,
858 858 doc="Module created for script run in IPython")
859 859 else:
860 860 main_mod.__dict__.clear()
861 861 main_mod.__name__ = modname
862 862
863 863 main_mod.__file__ = filename
864 864 # It seems pydoc (and perhaps others) needs any module instance to
865 865 # implement a __nonzero__ method
866 866 main_mod.__nonzero__ = lambda : True
867 867
868 868 return main_mod
869 869
870 870 def clear_main_mod_cache(self):
871 871 """Clear the cache of main modules.
872 872
873 873 Mainly for use by utilities like %reset.
874 874
875 875 Examples
876 876 --------
877 877
878 878 In [15]: import IPython
879 879
880 880 In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython')
881 881
882 882 In [17]: len(_ip._main_mod_cache) > 0
883 883 Out[17]: True
884 884
885 885 In [18]: _ip.clear_main_mod_cache()
886 886
887 887 In [19]: len(_ip._main_mod_cache) == 0
888 888 Out[19]: True
889 889 """
890 890 self._main_mod_cache.clear()
891 891
892 892 #-------------------------------------------------------------------------
893 893 # Things related to debugging
894 894 #-------------------------------------------------------------------------
895 895
896 896 def init_pdb(self):
897 897 # Set calling of pdb on exceptions
898 898 # self.call_pdb is a property
899 899 self.call_pdb = self.pdb
900 900
901 901 def _get_call_pdb(self):
902 902 return self._call_pdb
903 903
904 904 def _set_call_pdb(self,val):
905 905
906 906 if val not in (0,1,False,True):
907 907 raise ValueError('new call_pdb value must be boolean')
908 908
909 909 # store value in instance
910 910 self._call_pdb = val
911 911
912 912 # notify the actual exception handlers
913 913 self.InteractiveTB.call_pdb = val
914 914
915 915 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
916 916 'Control auto-activation of pdb at exceptions')
917 917
918 918 def debugger(self,force=False):
919 919 """Call the pydb/pdb debugger.
920 920
921 921 Keywords:
922 922
923 923 - force(False): by default, this routine checks the instance call_pdb
924 924 flag and does not actually invoke the debugger if the flag is false.
925 925 The 'force' option forces the debugger to activate even if the flag
926 926 is false.
927 927 """
928 928
929 929 if not (force or self.call_pdb):
930 930 return
931 931
932 932 if not hasattr(sys,'last_traceback'):
933 933 error('No traceback has been produced, nothing to debug.')
934 934 return
935 935
936 936 # use pydb if available
937 937 if debugger.has_pydb:
938 938 from pydb import pm
939 939 else:
940 940 # fallback to our internal debugger
941 941 pm = lambda : self.InteractiveTB.debugger(force=True)
942 942
943 943 with self.readline_no_record:
944 944 pm()
945 945
946 946 #-------------------------------------------------------------------------
947 947 # Things related to IPython's various namespaces
948 948 #-------------------------------------------------------------------------
949 949 default_user_namespaces = True
950 950
951 951 def init_create_namespaces(self, user_module=None, user_ns=None):
952 952 # Create the namespace where the user will operate. user_ns is
953 953 # normally the only one used, and it is passed to the exec calls as
954 954 # the locals argument. But we do carry a user_global_ns namespace
955 955 # given as the exec 'globals' argument, This is useful in embedding
956 956 # situations where the ipython shell opens in a context where the
957 957 # distinction between locals and globals is meaningful. For
958 958 # non-embedded contexts, it is just the same object as the user_ns dict.
959 959
960 960 # FIXME. For some strange reason, __builtins__ is showing up at user
961 961 # level as a dict instead of a module. This is a manual fix, but I
962 962 # should really track down where the problem is coming from. Alex
963 963 # Schmolck reported this problem first.
964 964
965 965 # A useful post by Alex Martelli on this topic:
966 966 # Re: inconsistent value from __builtins__
967 967 # Von: Alex Martelli <aleaxit@yahoo.com>
968 968 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
969 969 # Gruppen: comp.lang.python
970 970
971 971 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
972 972 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
973 973 # > <type 'dict'>
974 974 # > >>> print type(__builtins__)
975 975 # > <type 'module'>
976 976 # > Is this difference in return value intentional?
977 977
978 978 # Well, it's documented that '__builtins__' can be either a dictionary
979 979 # or a module, and it's been that way for a long time. Whether it's
980 980 # intentional (or sensible), I don't know. In any case, the idea is
981 981 # that if you need to access the built-in namespace directly, you
982 982 # should start with "import __builtin__" (note, no 's') which will
983 983 # definitely give you a module. Yeah, it's somewhat confusing:-(.
984 984
985 985 # These routines return a properly built module and dict as needed by
986 986 # the rest of the code, and can also be used by extension writers to
987 987 # generate properly initialized namespaces.
988 988 if (user_ns is not None) or (user_module is not None):
989 989 self.default_user_namespaces = False
990 990 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
991 991
992 992 # A record of hidden variables we have added to the user namespace, so
993 993 # we can list later only variables defined in actual interactive use.
994 994 self.user_ns_hidden = {}
995 995
996 996 # Now that FakeModule produces a real module, we've run into a nasty
997 997 # problem: after script execution (via %run), the module where the user
998 998 # code ran is deleted. Now that this object is a true module (needed
999 999 # so docetst and other tools work correctly), the Python module
1000 1000 # teardown mechanism runs over it, and sets to None every variable
1001 1001 # present in that module. Top-level references to objects from the
1002 1002 # script survive, because the user_ns is updated with them. However,
1003 1003 # calling functions defined in the script that use other things from
1004 1004 # the script will fail, because the function's closure had references
1005 1005 # to the original objects, which are now all None. So we must protect
1006 1006 # these modules from deletion by keeping a cache.
1007 1007 #
1008 1008 # To avoid keeping stale modules around (we only need the one from the
1009 1009 # last run), we use a dict keyed with the full path to the script, so
1010 1010 # only the last version of the module is held in the cache. Note,
1011 1011 # however, that we must cache the module *namespace contents* (their
1012 1012 # __dict__). Because if we try to cache the actual modules, old ones
1013 1013 # (uncached) could be destroyed while still holding references (such as
1014 1014 # those held by GUI objects that tend to be long-lived)>
1015 1015 #
1016 1016 # The %reset command will flush this cache. See the cache_main_mod()
1017 1017 # and clear_main_mod_cache() methods for details on use.
1018 1018
1019 1019 # This is the cache used for 'main' namespaces
1020 1020 self._main_mod_cache = {}
1021 1021
1022 1022 # A table holding all the namespaces IPython deals with, so that
1023 1023 # introspection facilities can search easily.
1024 1024 self.ns_table = {'user_global':self.user_module.__dict__,
1025 1025 'user_local':self.user_ns,
1026 1026 'builtin':builtin_mod.__dict__
1027 1027 }
1028 1028
1029 1029 @property
1030 1030 def user_global_ns(self):
1031 1031 return self.user_module.__dict__
1032 1032
1033 1033 def prepare_user_module(self, user_module=None, user_ns=None):
1034 1034 """Prepare the module and namespace in which user code will be run.
1035 1035
1036 1036 When IPython is started normally, both parameters are None: a new module
1037 1037 is created automatically, and its __dict__ used as the namespace.
1038 1038
1039 1039 If only user_module is provided, its __dict__ is used as the namespace.
1040 1040 If only user_ns is provided, a dummy module is created, and user_ns
1041 1041 becomes the global namespace. If both are provided (as they may be
1042 1042 when embedding), user_ns is the local namespace, and user_module
1043 1043 provides the global namespace.
1044 1044
1045 1045 Parameters
1046 1046 ----------
1047 1047 user_module : module, optional
1048 1048 The current user module in which IPython is being run. If None,
1049 1049 a clean module will be created.
1050 1050 user_ns : dict, optional
1051 1051 A namespace in which to run interactive commands.
1052 1052
1053 1053 Returns
1054 1054 -------
1055 1055 A tuple of user_module and user_ns, each properly initialised.
1056 1056 """
1057 1057 if user_module is None and user_ns is not None:
1058 1058 user_ns.setdefault("__name__", "__main__")
1059 1059 user_module = DummyMod()
1060 1060 user_module.__dict__ = user_ns
1061 1061
1062 1062 if user_module is None:
1063 1063 user_module = types.ModuleType("__main__",
1064 1064 doc="Automatically created module for IPython interactive environment")
1065 1065
1066 1066 # We must ensure that __builtin__ (without the final 's') is always
1067 1067 # available and pointing to the __builtin__ *module*. For more details:
1068 1068 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1069 1069 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1070 1070 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1071 1071
1072 1072 if user_ns is None:
1073 1073 user_ns = user_module.__dict__
1074 1074
1075 1075 return user_module, user_ns
1076 1076
1077 1077 def init_sys_modules(self):
1078 1078 # We need to insert into sys.modules something that looks like a
1079 1079 # module but which accesses the IPython namespace, for shelve and
1080 1080 # pickle to work interactively. Normally they rely on getting
1081 1081 # everything out of __main__, but for embedding purposes each IPython
1082 1082 # instance has its own private namespace, so we can't go shoving
1083 1083 # everything into __main__.
1084 1084
1085 1085 # note, however, that we should only do this for non-embedded
1086 1086 # ipythons, which really mimic the __main__.__dict__ with their own
1087 1087 # namespace. Embedded instances, on the other hand, should not do
1088 1088 # this because they need to manage the user local/global namespaces
1089 1089 # only, but they live within a 'normal' __main__ (meaning, they
1090 1090 # shouldn't overtake the execution environment of the script they're
1091 1091 # embedded in).
1092 1092
1093 1093 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1094 1094 main_name = self.user_module.__name__
1095 1095 sys.modules[main_name] = self.user_module
1096 1096
1097 1097 def init_user_ns(self):
1098 1098 """Initialize all user-visible namespaces to their minimum defaults.
1099 1099
1100 1100 Certain history lists are also initialized here, as they effectively
1101 1101 act as user namespaces.
1102 1102
1103 1103 Notes
1104 1104 -----
1105 1105 All data structures here are only filled in, they are NOT reset by this
1106 1106 method. If they were not empty before, data will simply be added to
1107 1107 therm.
1108 1108 """
1109 1109 # This function works in two parts: first we put a few things in
1110 1110 # user_ns, and we sync that contents into user_ns_hidden so that these
1111 1111 # initial variables aren't shown by %who. After the sync, we add the
1112 1112 # rest of what we *do* want the user to see with %who even on a new
1113 1113 # session (probably nothing, so theye really only see their own stuff)
1114 1114
1115 1115 # The user dict must *always* have a __builtin__ reference to the
1116 1116 # Python standard __builtin__ namespace, which must be imported.
1117 1117 # This is so that certain operations in prompt evaluation can be
1118 1118 # reliably executed with builtins. Note that we can NOT use
1119 1119 # __builtins__ (note the 's'), because that can either be a dict or a
1120 1120 # module, and can even mutate at runtime, depending on the context
1121 1121 # (Python makes no guarantees on it). In contrast, __builtin__ is
1122 1122 # always a module object, though it must be explicitly imported.
1123 1123
1124 1124 # For more details:
1125 1125 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1126 1126 ns = dict()
1127 1127
1128 1128 # Put 'help' in the user namespace
1129 1129 try:
1130 1130 from site import _Helper
1131 1131 ns['help'] = _Helper()
1132 1132 except ImportError:
1133 1133 warn('help() not available - check site.py')
1134 1134
1135 1135 # make global variables for user access to the histories
1136 1136 ns['_ih'] = self.history_manager.input_hist_parsed
1137 1137 ns['_oh'] = self.history_manager.output_hist
1138 1138 ns['_dh'] = self.history_manager.dir_hist
1139 1139
1140 1140 ns['_sh'] = shadowns
1141 1141
1142 1142 # user aliases to input and output histories. These shouldn't show up
1143 1143 # in %who, as they can have very large reprs.
1144 1144 ns['In'] = self.history_manager.input_hist_parsed
1145 1145 ns['Out'] = self.history_manager.output_hist
1146 1146
1147 1147 # Store myself as the public api!!!
1148 1148 ns['get_ipython'] = self.get_ipython
1149 1149
1150 1150 ns['exit'] = self.exiter
1151 1151 ns['quit'] = self.exiter
1152 1152
1153 1153 # Sync what we've added so far to user_ns_hidden so these aren't seen
1154 1154 # by %who
1155 1155 self.user_ns_hidden.update(ns)
1156 1156
1157 1157 # Anything put into ns now would show up in %who. Think twice before
1158 1158 # putting anything here, as we really want %who to show the user their
1159 1159 # stuff, not our variables.
1160 1160
1161 1161 # Finally, update the real user's namespace
1162 1162 self.user_ns.update(ns)
1163 1163
1164 1164 @property
1165 1165 def all_ns_refs(self):
1166 1166 """Get a list of references to all the namespace dictionaries in which
1167 1167 IPython might store a user-created object.
1168 1168
1169 1169 Note that this does not include the displayhook, which also caches
1170 1170 objects from the output."""
1171 1171 return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \
1172 1172 [m.__dict__ for m in self._main_mod_cache.values()]
1173 1173
1174 1174 def reset(self, new_session=True):
1175 1175 """Clear all internal namespaces, and attempt to release references to
1176 1176 user objects.
1177 1177
1178 1178 If new_session is True, a new history session will be opened.
1179 1179 """
1180 1180 # Clear histories
1181 1181 self.history_manager.reset(new_session)
1182 1182 # Reset counter used to index all histories
1183 1183 if new_session:
1184 1184 self.execution_count = 1
1185 1185
1186 1186 # Flush cached output items
1187 1187 if self.displayhook.do_full_cache:
1188 1188 self.displayhook.flush()
1189 1189
1190 1190 # The main execution namespaces must be cleared very carefully,
1191 1191 # skipping the deletion of the builtin-related keys, because doing so
1192 1192 # would cause errors in many object's __del__ methods.
1193 1193 if self.user_ns is not self.user_global_ns:
1194 1194 self.user_ns.clear()
1195 1195 ns = self.user_global_ns
1196 1196 drop_keys = set(ns.keys())
1197 1197 drop_keys.discard('__builtin__')
1198 1198 drop_keys.discard('__builtins__')
1199 1199 drop_keys.discard('__name__')
1200 1200 for k in drop_keys:
1201 1201 del ns[k]
1202 1202
1203 1203 self.user_ns_hidden.clear()
1204 1204
1205 1205 # Restore the user namespaces to minimal usability
1206 1206 self.init_user_ns()
1207 1207
1208 1208 # Restore the default and user aliases
1209 1209 self.alias_manager.clear_aliases()
1210 1210 self.alias_manager.init_aliases()
1211 1211
1212 1212 # Flush the private list of module references kept for script
1213 1213 # execution protection
1214 1214 self.clear_main_mod_cache()
1215 1215
1216 1216 def del_var(self, varname, by_name=False):
1217 1217 """Delete a variable from the various namespaces, so that, as
1218 1218 far as possible, we're not keeping any hidden references to it.
1219 1219
1220 1220 Parameters
1221 1221 ----------
1222 1222 varname : str
1223 1223 The name of the variable to delete.
1224 1224 by_name : bool
1225 1225 If True, delete variables with the given name in each
1226 1226 namespace. If False (default), find the variable in the user
1227 1227 namespace, and delete references to it.
1228 1228 """
1229 1229 if varname in ('__builtin__', '__builtins__'):
1230 1230 raise ValueError("Refusing to delete %s" % varname)
1231 1231
1232 1232 ns_refs = self.all_ns_refs
1233 1233
1234 1234 if by_name: # Delete by name
1235 1235 for ns in ns_refs:
1236 1236 try:
1237 1237 del ns[varname]
1238 1238 except KeyError:
1239 1239 pass
1240 1240 else: # Delete by object
1241 1241 try:
1242 1242 obj = self.user_ns[varname]
1243 1243 except KeyError:
1244 1244 raise NameError("name '%s' is not defined" % varname)
1245 1245 # Also check in output history
1246 1246 ns_refs.append(self.history_manager.output_hist)
1247 1247 for ns in ns_refs:
1248 1248 to_delete = [n for n, o in iteritems(ns) if o is obj]
1249 1249 for name in to_delete:
1250 1250 del ns[name]
1251 1251
1252 1252 # displayhook keeps extra references, but not in a dictionary
1253 1253 for name in ('_', '__', '___'):
1254 1254 if getattr(self.displayhook, name) is obj:
1255 1255 setattr(self.displayhook, name, None)
1256 1256
1257 1257 def reset_selective(self, regex=None):
1258 1258 """Clear selective variables from internal namespaces based on a
1259 1259 specified regular expression.
1260 1260
1261 1261 Parameters
1262 1262 ----------
1263 1263 regex : string or compiled pattern, optional
1264 1264 A regular expression pattern that will be used in searching
1265 1265 variable names in the users namespaces.
1266 1266 """
1267 1267 if regex is not None:
1268 1268 try:
1269 1269 m = re.compile(regex)
1270 1270 except TypeError:
1271 1271 raise TypeError('regex must be a string or compiled pattern')
1272 1272 # Search for keys in each namespace that match the given regex
1273 1273 # If a match is found, delete the key/value pair.
1274 1274 for ns in self.all_ns_refs:
1275 1275 for var in ns:
1276 1276 if m.search(var):
1277 1277 del ns[var]
1278 1278
1279 1279 def push(self, variables, interactive=True):
1280 1280 """Inject a group of variables into the IPython user namespace.
1281 1281
1282 1282 Parameters
1283 1283 ----------
1284 1284 variables : dict, str or list/tuple of str
1285 1285 The variables to inject into the user's namespace. If a dict, a
1286 1286 simple update is done. If a str, the string is assumed to have
1287 1287 variable names separated by spaces. A list/tuple of str can also
1288 1288 be used to give the variable names. If just the variable names are
1289 1289 give (list/tuple/str) then the variable values looked up in the
1290 1290 callers frame.
1291 1291 interactive : bool
1292 1292 If True (default), the variables will be listed with the ``who``
1293 1293 magic.
1294 1294 """
1295 1295 vdict = None
1296 1296
1297 1297 # We need a dict of name/value pairs to do namespace updates.
1298 1298 if isinstance(variables, dict):
1299 1299 vdict = variables
1300 1300 elif isinstance(variables, string_types+(list, tuple)):
1301 1301 if isinstance(variables, string_types):
1302 1302 vlist = variables.split()
1303 1303 else:
1304 1304 vlist = variables
1305 1305 vdict = {}
1306 1306 cf = sys._getframe(1)
1307 1307 for name in vlist:
1308 1308 try:
1309 1309 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1310 1310 except:
1311 1311 print('Could not get variable %s from %s' %
1312 1312 (name,cf.f_code.co_name))
1313 1313 else:
1314 1314 raise ValueError('variables must be a dict/str/list/tuple')
1315 1315
1316 1316 # Propagate variables to user namespace
1317 1317 self.user_ns.update(vdict)
1318 1318
1319 1319 # And configure interactive visibility
1320 1320 user_ns_hidden = self.user_ns_hidden
1321 1321 if interactive:
1322 1322 for name in vdict:
1323 1323 user_ns_hidden.pop(name, None)
1324 1324 else:
1325 1325 user_ns_hidden.update(vdict)
1326 1326
1327 1327 def drop_by_id(self, variables):
1328 1328 """Remove a dict of variables from the user namespace, if they are the
1329 1329 same as the values in the dictionary.
1330 1330
1331 1331 This is intended for use by extensions: variables that they've added can
1332 1332 be taken back out if they are unloaded, without removing any that the
1333 1333 user has overwritten.
1334 1334
1335 1335 Parameters
1336 1336 ----------
1337 1337 variables : dict
1338 1338 A dictionary mapping object names (as strings) to the objects.
1339 1339 """
1340 1340 for name, obj in iteritems(variables):
1341 1341 if name in self.user_ns and self.user_ns[name] is obj:
1342 1342 del self.user_ns[name]
1343 1343 self.user_ns_hidden.pop(name, None)
1344 1344
1345 1345 #-------------------------------------------------------------------------
1346 1346 # Things related to object introspection
1347 1347 #-------------------------------------------------------------------------
1348 1348
1349 1349 def _ofind(self, oname, namespaces=None):
1350 1350 """Find an object in the available namespaces.
1351 1351
1352 1352 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1353 1353
1354 1354 Has special code to detect magic functions.
1355 1355 """
1356 1356 oname = oname.strip()
1357 1357 #print '1- oname: <%r>' % oname # dbg
1358 1358 if not oname.startswith(ESC_MAGIC) and \
1359 1359 not oname.startswith(ESC_MAGIC2) and \
1360 1360 not py3compat.isidentifier(oname, dotted=True):
1361 1361 return dict(found=False)
1362 1362
1363 1363 alias_ns = None
1364 1364 if namespaces is None:
1365 1365 # Namespaces to search in:
1366 1366 # Put them in a list. The order is important so that we
1367 1367 # find things in the same order that Python finds them.
1368 1368 namespaces = [ ('Interactive', self.user_ns),
1369 1369 ('Interactive (global)', self.user_global_ns),
1370 1370 ('Python builtin', builtin_mod.__dict__),
1371 1371 ]
1372 1372
1373 1373 # initialize results to 'null'
1374 1374 found = False; obj = None; ospace = None; ds = None;
1375 1375 ismagic = False; isalias = False; parent = None
1376 1376
1377 1377 # We need to special-case 'print', which as of python2.6 registers as a
1378 1378 # function but should only be treated as one if print_function was
1379 1379 # loaded with a future import. In this case, just bail.
1380 1380 if (oname == 'print' and not py3compat.PY3 and not \
1381 1381 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1382 1382 return {'found':found, 'obj':obj, 'namespace':ospace,
1383 1383 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1384 1384
1385 1385 # Look for the given name by splitting it in parts. If the head is
1386 1386 # found, then we look for all the remaining parts as members, and only
1387 1387 # declare success if we can find them all.
1388 1388 oname_parts = oname.split('.')
1389 1389 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1390 1390 for nsname,ns in namespaces:
1391 1391 try:
1392 1392 obj = ns[oname_head]
1393 1393 except KeyError:
1394 1394 continue
1395 1395 else:
1396 1396 #print 'oname_rest:', oname_rest # dbg
1397 1397 for part in oname_rest:
1398 1398 try:
1399 1399 parent = obj
1400 1400 obj = getattr(obj,part)
1401 1401 except:
1402 1402 # Blanket except b/c some badly implemented objects
1403 1403 # allow __getattr__ to raise exceptions other than
1404 1404 # AttributeError, which then crashes IPython.
1405 1405 break
1406 1406 else:
1407 1407 # If we finish the for loop (no break), we got all members
1408 1408 found = True
1409 1409 ospace = nsname
1410 1410 break # namespace loop
1411 1411
1412 1412 # Try to see if it's magic
1413 1413 if not found:
1414 1414 obj = None
1415 1415 if oname.startswith(ESC_MAGIC2):
1416 1416 oname = oname.lstrip(ESC_MAGIC2)
1417 1417 obj = self.find_cell_magic(oname)
1418 1418 elif oname.startswith(ESC_MAGIC):
1419 1419 oname = oname.lstrip(ESC_MAGIC)
1420 1420 obj = self.find_line_magic(oname)
1421 1421 else:
1422 1422 # search without prefix, so run? will find %run?
1423 1423 obj = self.find_line_magic(oname)
1424 1424 if obj is None:
1425 1425 obj = self.find_cell_magic(oname)
1426 1426 if obj is not None:
1427 1427 found = True
1428 1428 ospace = 'IPython internal'
1429 1429 ismagic = True
1430 1430
1431 1431 # Last try: special-case some literals like '', [], {}, etc:
1432 1432 if not found and oname_head in ["''",'""','[]','{}','()']:
1433 1433 obj = eval(oname_head)
1434 1434 found = True
1435 1435 ospace = 'Interactive'
1436 1436
1437 1437 return {'found':found, 'obj':obj, 'namespace':ospace,
1438 1438 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1439 1439
1440 1440 def _ofind_property(self, oname, info):
1441 1441 """Second part of object finding, to look for property details."""
1442 1442 if info.found:
1443 1443 # Get the docstring of the class property if it exists.
1444 1444 path = oname.split('.')
1445 1445 root = '.'.join(path[:-1])
1446 1446 if info.parent is not None:
1447 1447 try:
1448 1448 target = getattr(info.parent, '__class__')
1449 1449 # The object belongs to a class instance.
1450 1450 try:
1451 1451 target = getattr(target, path[-1])
1452 1452 # The class defines the object.
1453 1453 if isinstance(target, property):
1454 1454 oname = root + '.__class__.' + path[-1]
1455 1455 info = Struct(self._ofind(oname))
1456 1456 except AttributeError: pass
1457 1457 except AttributeError: pass
1458 1458
1459 1459 # We return either the new info or the unmodified input if the object
1460 1460 # hadn't been found
1461 1461 return info
1462 1462
1463 1463 def _object_find(self, oname, namespaces=None):
1464 1464 """Find an object and return a struct with info about it."""
1465 1465 inf = Struct(self._ofind(oname, namespaces))
1466 1466 return Struct(self._ofind_property(oname, inf))
1467 1467
1468 1468 def _inspect(self, meth, oname, namespaces=None, **kw):
1469 1469 """Generic interface to the inspector system.
1470 1470
1471 1471 This function is meant to be called by pdef, pdoc & friends."""
1472 1472 info = self._object_find(oname, namespaces)
1473 1473 if info.found:
1474 1474 pmethod = getattr(self.inspector, meth)
1475 1475 formatter = format_screen if info.ismagic else None
1476 1476 if meth == 'pdoc':
1477 1477 pmethod(info.obj, oname, formatter)
1478 1478 elif meth == 'pinfo':
1479 1479 pmethod(info.obj, oname, formatter, info, **kw)
1480 1480 else:
1481 1481 pmethod(info.obj, oname)
1482 1482 else:
1483 1483 print('Object `%s` not found.' % oname)
1484 1484 return 'not found' # so callers can take other action
1485 1485
1486 1486 def object_inspect(self, oname, detail_level=0):
1487 1487 with self.builtin_trap:
1488 1488 info = self._object_find(oname)
1489 1489 if info.found:
1490 1490 return self.inspector.info(info.obj, oname, info=info,
1491 1491 detail_level=detail_level
1492 1492 )
1493 1493 else:
1494 1494 return oinspect.object_info(name=oname, found=False)
1495 1495
1496 1496 #-------------------------------------------------------------------------
1497 1497 # Things related to history management
1498 1498 #-------------------------------------------------------------------------
1499 1499
1500 1500 def init_history(self):
1501 1501 """Sets up the command history, and starts regular autosaves."""
1502 1502 self.history_manager = HistoryManager(shell=self, parent=self)
1503 1503 self.configurables.append(self.history_manager)
1504 1504
1505 1505 #-------------------------------------------------------------------------
1506 1506 # Things related to exception handling and tracebacks (not debugging)
1507 1507 #-------------------------------------------------------------------------
1508 1508
1509 1509 def init_traceback_handlers(self, custom_exceptions):
1510 1510 # Syntax error handler.
1511 1511 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1512 1512
1513 1513 # The interactive one is initialized with an offset, meaning we always
1514 1514 # want to remove the topmost item in the traceback, which is our own
1515 1515 # internal code. Valid modes: ['Plain','Context','Verbose']
1516 1516 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1517 1517 color_scheme='NoColor',
1518 1518 tb_offset = 1,
1519 1519 check_cache=check_linecache_ipython)
1520 1520
1521 1521 # The instance will store a pointer to the system-wide exception hook,
1522 1522 # so that runtime code (such as magics) can access it. This is because
1523 1523 # during the read-eval loop, it may get temporarily overwritten.
1524 1524 self.sys_excepthook = sys.excepthook
1525 1525
1526 1526 # and add any custom exception handlers the user may have specified
1527 1527 self.set_custom_exc(*custom_exceptions)
1528 1528
1529 1529 # Set the exception mode
1530 1530 self.InteractiveTB.set_mode(mode=self.xmode)
1531 1531
1532 1532 def set_custom_exc(self, exc_tuple, handler):
1533 1533 """set_custom_exc(exc_tuple,handler)
1534 1534
1535 1535 Set a custom exception handler, which will be called if any of the
1536 1536 exceptions in exc_tuple occur in the mainloop (specifically, in the
1537 1537 run_code() method).
1538 1538
1539 1539 Parameters
1540 1540 ----------
1541 1541
1542 1542 exc_tuple : tuple of exception classes
1543 1543 A *tuple* of exception classes, for which to call the defined
1544 1544 handler. It is very important that you use a tuple, and NOT A
1545 1545 LIST here, because of the way Python's except statement works. If
1546 1546 you only want to trap a single exception, use a singleton tuple::
1547 1547
1548 1548 exc_tuple == (MyCustomException,)
1549 1549
1550 1550 handler : callable
1551 1551 handler must have the following signature::
1552 1552
1553 1553 def my_handler(self, etype, value, tb, tb_offset=None):
1554 1554 ...
1555 1555 return structured_traceback
1556 1556
1557 1557 Your handler must return a structured traceback (a list of strings),
1558 1558 or None.
1559 1559
1560 1560 This will be made into an instance method (via types.MethodType)
1561 1561 of IPython itself, and it will be called if any of the exceptions
1562 1562 listed in the exc_tuple are caught. If the handler is None, an
1563 1563 internal basic one is used, which just prints basic info.
1564 1564
1565 1565 To protect IPython from crashes, if your handler ever raises an
1566 1566 exception or returns an invalid result, it will be immediately
1567 1567 disabled.
1568 1568
1569 1569 WARNING: by putting in your own exception handler into IPython's main
1570 1570 execution loop, you run a very good chance of nasty crashes. This
1571 1571 facility should only be used if you really know what you are doing."""
1572 1572
1573 1573 assert type(exc_tuple)==type(()) , \
1574 1574 "The custom exceptions must be given AS A TUPLE."
1575 1575
1576 1576 def dummy_handler(self,etype,value,tb,tb_offset=None):
1577 1577 print('*** Simple custom exception handler ***')
1578 1578 print('Exception type :',etype)
1579 1579 print('Exception value:',value)
1580 1580 print('Traceback :',tb)
1581 1581 #print 'Source code :','\n'.join(self.buffer)
1582 1582
1583 1583 def validate_stb(stb):
1584 1584 """validate structured traceback return type
1585 1585
1586 1586 return type of CustomTB *should* be a list of strings, but allow
1587 1587 single strings or None, which are harmless.
1588 1588
1589 1589 This function will *always* return a list of strings,
1590 1590 and will raise a TypeError if stb is inappropriate.
1591 1591 """
1592 1592 msg = "CustomTB must return list of strings, not %r" % stb
1593 1593 if stb is None:
1594 1594 return []
1595 1595 elif isinstance(stb, string_types):
1596 1596 return [stb]
1597 1597 elif not isinstance(stb, list):
1598 1598 raise TypeError(msg)
1599 1599 # it's a list
1600 1600 for line in stb:
1601 1601 # check every element
1602 1602 if not isinstance(line, string_types):
1603 1603 raise TypeError(msg)
1604 1604 return stb
1605 1605
1606 1606 if handler is None:
1607 1607 wrapped = dummy_handler
1608 1608 else:
1609 1609 def wrapped(self,etype,value,tb,tb_offset=None):
1610 1610 """wrap CustomTB handler, to protect IPython from user code
1611 1611
1612 1612 This makes it harder (but not impossible) for custom exception
1613 1613 handlers to crash IPython.
1614 1614 """
1615 1615 try:
1616 1616 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1617 1617 return validate_stb(stb)
1618 1618 except:
1619 1619 # clear custom handler immediately
1620 1620 self.set_custom_exc((), None)
1621 1621 print("Custom TB Handler failed, unregistering", file=io.stderr)
1622 1622 # show the exception in handler first
1623 1623 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1624 1624 print(self.InteractiveTB.stb2text(stb), file=io.stdout)
1625 1625 print("The original exception:", file=io.stdout)
1626 1626 stb = self.InteractiveTB.structured_traceback(
1627 1627 (etype,value,tb), tb_offset=tb_offset
1628 1628 )
1629 1629 return stb
1630 1630
1631 1631 self.CustomTB = types.MethodType(wrapped,self)
1632 1632 self.custom_exceptions = exc_tuple
1633 1633
1634 1634 def excepthook(self, etype, value, tb):
1635 1635 """One more defense for GUI apps that call sys.excepthook.
1636 1636
1637 1637 GUI frameworks like wxPython trap exceptions and call
1638 1638 sys.excepthook themselves. I guess this is a feature that
1639 1639 enables them to keep running after exceptions that would
1640 1640 otherwise kill their mainloop. This is a bother for IPython
1641 1641 which excepts to catch all of the program exceptions with a try:
1642 1642 except: statement.
1643 1643
1644 1644 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1645 1645 any app directly invokes sys.excepthook, it will look to the user like
1646 1646 IPython crashed. In order to work around this, we can disable the
1647 1647 CrashHandler and replace it with this excepthook instead, which prints a
1648 1648 regular traceback using our InteractiveTB. In this fashion, apps which
1649 1649 call sys.excepthook will generate a regular-looking exception from
1650 1650 IPython, and the CrashHandler will only be triggered by real IPython
1651 1651 crashes.
1652 1652
1653 1653 This hook should be used sparingly, only in places which are not likely
1654 1654 to be true IPython errors.
1655 1655 """
1656 1656 self.showtraceback((etype,value,tb),tb_offset=0)
1657 1657
1658 1658 def _get_exc_info(self, exc_tuple=None):
1659 1659 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1660 1660
1661 1661 Ensures sys.last_type,value,traceback hold the exc_info we found,
1662 1662 from whichever source.
1663 1663
1664 1664 raises ValueError if none of these contain any information
1665 1665 """
1666 1666 if exc_tuple is None:
1667 1667 etype, value, tb = sys.exc_info()
1668 1668 else:
1669 1669 etype, value, tb = exc_tuple
1670 1670
1671 1671 if etype is None:
1672 1672 if hasattr(sys, 'last_type'):
1673 1673 etype, value, tb = sys.last_type, sys.last_value, \
1674 1674 sys.last_traceback
1675 1675
1676 1676 if etype is None:
1677 1677 raise ValueError("No exception to find")
1678 1678
1679 1679 # Now store the exception info in sys.last_type etc.
1680 1680 # WARNING: these variables are somewhat deprecated and not
1681 1681 # necessarily safe to use in a threaded environment, but tools
1682 1682 # like pdb depend on their existence, so let's set them. If we
1683 1683 # find problems in the field, we'll need to revisit their use.
1684 1684 sys.last_type = etype
1685 1685 sys.last_value = value
1686 1686 sys.last_traceback = tb
1687 1687
1688 1688 return etype, value, tb
1689 1689
1690 1690 def show_usage_error(self, exc):
1691 1691 """Show a short message for UsageErrors
1692 1692
1693 1693 These are special exceptions that shouldn't show a traceback.
1694 1694 """
1695 1695 self.write_err("UsageError: %s" % exc)
1696 1696
1697 1697 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1698 1698 exception_only=False):
1699 1699 """Display the exception that just occurred.
1700 1700
1701 1701 If nothing is known about the exception, this is the method which
1702 1702 should be used throughout the code for presenting user tracebacks,
1703 1703 rather than directly invoking the InteractiveTB object.
1704 1704
1705 1705 A specific showsyntaxerror() also exists, but this method can take
1706 1706 care of calling it if needed, so unless you are explicitly catching a
1707 1707 SyntaxError exception, don't try to analyze the stack manually and
1708 1708 simply call this method."""
1709 1709
1710 1710 try:
1711 1711 try:
1712 1712 etype, value, tb = self._get_exc_info(exc_tuple)
1713 1713 except ValueError:
1714 1714 self.write_err('No traceback available to show.\n')
1715 1715 return
1716 1716
1717 1717 if issubclass(etype, SyntaxError):
1718 1718 # Though this won't be called by syntax errors in the input
1719 1719 # line, there may be SyntaxError cases with imported code.
1720 1720 self.showsyntaxerror(filename)
1721 1721 elif etype is UsageError:
1722 1722 self.show_usage_error(value)
1723 1723 else:
1724 1724 if exception_only:
1725 1725 stb = ['An exception has occurred, use %tb to see '
1726 1726 'the full traceback.\n']
1727 1727 stb.extend(self.InteractiveTB.get_exception_only(etype,
1728 1728 value))
1729 1729 else:
1730 1730 try:
1731 1731 # Exception classes can customise their traceback - we
1732 1732 # use this in IPython.parallel for exceptions occurring
1733 1733 # in the engines. This should return a list of strings.
1734 1734 stb = value._render_traceback_()
1735 1735 except Exception:
1736 1736 stb = self.InteractiveTB.structured_traceback(etype,
1737 1737 value, tb, tb_offset=tb_offset)
1738 1738
1739 1739 self._showtraceback(etype, value, stb)
1740 1740 if self.call_pdb:
1741 1741 # drop into debugger
1742 1742 self.debugger(force=True)
1743 1743 return
1744 1744
1745 1745 # Actually show the traceback
1746 1746 self._showtraceback(etype, value, stb)
1747 1747
1748 1748 except KeyboardInterrupt:
1749 1749 self.write_err("\nKeyboardInterrupt\n")
1750 1750
1751 1751 def _showtraceback(self, etype, evalue, stb):
1752 1752 """Actually show a traceback.
1753 1753
1754 1754 Subclasses may override this method to put the traceback on a different
1755 1755 place, like a side channel.
1756 1756 """
1757 1757 print(self.InteractiveTB.stb2text(stb), file=io.stdout)
1758 1758
1759 1759 def showsyntaxerror(self, filename=None):
1760 1760 """Display the syntax error that just occurred.
1761 1761
1762 1762 This doesn't display a stack trace because there isn't one.
1763 1763
1764 1764 If a filename is given, it is stuffed in the exception instead
1765 1765 of what was there before (because Python's parser always uses
1766 1766 "<string>" when reading from a string).
1767 1767 """
1768 1768 etype, value, last_traceback = self._get_exc_info()
1769 1769
1770 1770 if filename and issubclass(etype, SyntaxError):
1771 1771 try:
1772 1772 value.filename = filename
1773 1773 except:
1774 1774 # Not the format we expect; leave it alone
1775 1775 pass
1776 1776
1777 1777 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1778 1778 self._showtraceback(etype, value, stb)
1779 1779
1780 1780 # This is overridden in TerminalInteractiveShell to show a message about
1781 1781 # the %paste magic.
1782 1782 def showindentationerror(self):
1783 1783 """Called by run_cell when there's an IndentationError in code entered
1784 1784 at the prompt.
1785 1785
1786 1786 This is overridden in TerminalInteractiveShell to show a message about
1787 1787 the %paste magic."""
1788 1788 self.showsyntaxerror()
1789 1789
1790 1790 #-------------------------------------------------------------------------
1791 1791 # Things related to readline
1792 1792 #-------------------------------------------------------------------------
1793 1793
1794 1794 def init_readline(self):
1795 1795 """Command history completion/saving/reloading."""
1796 1796
1797 1797 if self.readline_use:
1798 1798 import IPython.utils.rlineimpl as readline
1799 1799
1800 1800 self.rl_next_input = None
1801 1801 self.rl_do_indent = False
1802 1802
1803 1803 if not self.readline_use or not readline.have_readline:
1804 1804 self.has_readline = False
1805 1805 self.readline = None
1806 1806 # Set a number of methods that depend on readline to be no-op
1807 1807 self.readline_no_record = no_op_context
1808 1808 self.set_readline_completer = no_op
1809 1809 self.set_custom_completer = no_op
1810 1810 if self.readline_use:
1811 1811 warn('Readline services not available or not loaded.')
1812 1812 else:
1813 1813 self.has_readline = True
1814 1814 self.readline = readline
1815 1815 sys.modules['readline'] = readline
1816 1816
1817 1817 # Platform-specific configuration
1818 1818 if os.name == 'nt':
1819 1819 # FIXME - check with Frederick to see if we can harmonize
1820 1820 # naming conventions with pyreadline to avoid this
1821 1821 # platform-dependent check
1822 1822 self.readline_startup_hook = readline.set_pre_input_hook
1823 1823 else:
1824 1824 self.readline_startup_hook = readline.set_startup_hook
1825 1825
1826 1826 # Load user's initrc file (readline config)
1827 1827 # Or if libedit is used, load editrc.
1828 1828 inputrc_name = os.environ.get('INPUTRC')
1829 1829 if inputrc_name is None:
1830 1830 inputrc_name = '.inputrc'
1831 1831 if readline.uses_libedit:
1832 1832 inputrc_name = '.editrc'
1833 1833 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1834 1834 if os.path.isfile(inputrc_name):
1835 1835 try:
1836 1836 readline.read_init_file(inputrc_name)
1837 1837 except:
1838 1838 warn('Problems reading readline initialization file <%s>'
1839 1839 % inputrc_name)
1840 1840
1841 1841 # Configure readline according to user's prefs
1842 1842 # This is only done if GNU readline is being used. If libedit
1843 1843 # is being used (as on Leopard) the readline config is
1844 1844 # not run as the syntax for libedit is different.
1845 1845 if not readline.uses_libedit:
1846 1846 for rlcommand in self.readline_parse_and_bind:
1847 1847 #print "loading rl:",rlcommand # dbg
1848 1848 readline.parse_and_bind(rlcommand)
1849 1849
1850 1850 # Remove some chars from the delimiters list. If we encounter
1851 1851 # unicode chars, discard them.
1852 1852 delims = readline.get_completer_delims()
1853 1853 if not py3compat.PY3:
1854 1854 delims = delims.encode("ascii", "ignore")
1855 1855 for d in self.readline_remove_delims:
1856 1856 delims = delims.replace(d, "")
1857 1857 delims = delims.replace(ESC_MAGIC, '')
1858 1858 readline.set_completer_delims(delims)
1859 1859 # Store these so we can restore them if something like rpy2 modifies
1860 1860 # them.
1861 1861 self.readline_delims = delims
1862 1862 # otherwise we end up with a monster history after a while:
1863 1863 readline.set_history_length(self.history_length)
1864 1864
1865 1865 self.refill_readline_hist()
1866 1866 self.readline_no_record = ReadlineNoRecord(self)
1867 1867
1868 1868 # Configure auto-indent for all platforms
1869 1869 self.set_autoindent(self.autoindent)
1870 1870
1871 1871 def refill_readline_hist(self):
1872 1872 # Load the last 1000 lines from history
1873 1873 self.readline.clear_history()
1874 1874 stdin_encoding = sys.stdin.encoding or "utf-8"
1875 1875 last_cell = u""
1876 1876 for _, _, cell in self.history_manager.get_tail(1000,
1877 1877 include_latest=True):
1878 1878 # Ignore blank lines and consecutive duplicates
1879 1879 cell = cell.rstrip()
1880 1880 if cell and (cell != last_cell):
1881 1881 try:
1882 1882 if self.multiline_history:
1883 1883 self.readline.add_history(py3compat.unicode_to_str(cell,
1884 1884 stdin_encoding))
1885 1885 else:
1886 1886 for line in cell.splitlines():
1887 1887 self.readline.add_history(py3compat.unicode_to_str(line,
1888 1888 stdin_encoding))
1889 1889 last_cell = cell
1890 1890
1891 1891 except TypeError:
1892 1892 # The history DB can get corrupted so it returns strings
1893 1893 # containing null bytes, which readline objects to.
1894 1894 continue
1895 1895
1896 1896 @skip_doctest
1897 1897 def set_next_input(self, s):
1898 1898 """ Sets the 'default' input string for the next command line.
1899 1899
1900 1900 Requires readline.
1901 1901
1902 1902 Example::
1903 1903
1904 1904 In [1]: _ip.set_next_input("Hello Word")
1905 1905 In [2]: Hello Word_ # cursor is here
1906 1906 """
1907 1907 self.rl_next_input = py3compat.cast_bytes_py2(s)
1908 1908
1909 1909 # Maybe move this to the terminal subclass?
1910 1910 def pre_readline(self):
1911 1911 """readline hook to be used at the start of each line.
1912 1912
1913 1913 Currently it handles auto-indent only."""
1914 1914
1915 1915 if self.rl_do_indent:
1916 1916 self.readline.insert_text(self._indent_current_str())
1917 1917 if self.rl_next_input is not None:
1918 1918 self.readline.insert_text(self.rl_next_input)
1919 1919 self.rl_next_input = None
1920 1920
1921 1921 def _indent_current_str(self):
1922 1922 """return the current level of indentation as a string"""
1923 1923 return self.input_splitter.indent_spaces * ' '
1924 1924
1925 1925 #-------------------------------------------------------------------------
1926 1926 # Things related to text completion
1927 1927 #-------------------------------------------------------------------------
1928 1928
1929 1929 def init_completer(self):
1930 1930 """Initialize the completion machinery.
1931 1931
1932 1932 This creates completion machinery that can be used by client code,
1933 1933 either interactively in-process (typically triggered by the readline
1934 1934 library), programatically (such as in test suites) or out-of-prcess
1935 1935 (typically over the network by remote frontends).
1936 1936 """
1937 1937 from IPython.core.completer import IPCompleter
1938 1938 from IPython.core.completerlib import (module_completer,
1939 1939 magic_run_completer, cd_completer, reset_completer)
1940 1940
1941 1941 self.Completer = IPCompleter(shell=self,
1942 1942 namespace=self.user_ns,
1943 1943 global_namespace=self.user_global_ns,
1944 1944 use_readline=self.has_readline,
1945 1945 parent=self,
1946 1946 )
1947 1947 self.configurables.append(self.Completer)
1948 1948
1949 1949 # Add custom completers to the basic ones built into IPCompleter
1950 1950 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1951 1951 self.strdispatchers['complete_command'] = sdisp
1952 1952 self.Completer.custom_completers = sdisp
1953 1953
1954 1954 self.set_hook('complete_command', module_completer, str_key = 'import')
1955 1955 self.set_hook('complete_command', module_completer, str_key = 'from')
1956 1956 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1957 1957 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1958 1958 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1959 1959
1960 1960 # Only configure readline if we truly are using readline. IPython can
1961 1961 # do tab-completion over the network, in GUIs, etc, where readline
1962 1962 # itself may be absent
1963 1963 if self.has_readline:
1964 1964 self.set_readline_completer()
1965 1965
1966 1966 def complete(self, text, line=None, cursor_pos=None):
1967 1967 """Return the completed text and a list of completions.
1968 1968
1969 1969 Parameters
1970 1970 ----------
1971 1971
1972 1972 text : string
1973 1973 A string of text to be completed on. It can be given as empty and
1974 1974 instead a line/position pair are given. In this case, the
1975 1975 completer itself will split the line like readline does.
1976 1976
1977 1977 line : string, optional
1978 1978 The complete line that text is part of.
1979 1979
1980 1980 cursor_pos : int, optional
1981 1981 The position of the cursor on the input line.
1982 1982
1983 1983 Returns
1984 1984 -------
1985 1985 text : string
1986 1986 The actual text that was completed.
1987 1987
1988 1988 matches : list
1989 1989 A sorted list with all possible completions.
1990 1990
1991 1991 The optional arguments allow the completion to take more context into
1992 1992 account, and are part of the low-level completion API.
1993 1993
1994 1994 This is a wrapper around the completion mechanism, similar to what
1995 1995 readline does at the command line when the TAB key is hit. By
1996 1996 exposing it as a method, it can be used by other non-readline
1997 1997 environments (such as GUIs) for text completion.
1998 1998
1999 1999 Simple usage example:
2000 2000
2001 2001 In [1]: x = 'hello'
2002 2002
2003 2003 In [2]: _ip.complete('x.l')
2004 2004 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
2005 2005 """
2006 2006
2007 2007 # Inject names into __builtin__ so we can complete on the added names.
2008 2008 with self.builtin_trap:
2009 2009 return self.Completer.complete(text, line, cursor_pos)
2010 2010
2011 2011 def set_custom_completer(self, completer, pos=0):
2012 2012 """Adds a new custom completer function.
2013 2013
2014 2014 The position argument (defaults to 0) is the index in the completers
2015 2015 list where you want the completer to be inserted."""
2016 2016
2017 2017 newcomp = types.MethodType(completer,self.Completer)
2018 2018 self.Completer.matchers.insert(pos,newcomp)
2019 2019
2020 2020 def set_readline_completer(self):
2021 2021 """Reset readline's completer to be our own."""
2022 2022 self.readline.set_completer(self.Completer.rlcomplete)
2023 2023
2024 2024 def set_completer_frame(self, frame=None):
2025 2025 """Set the frame of the completer."""
2026 2026 if frame:
2027 2027 self.Completer.namespace = frame.f_locals
2028 2028 self.Completer.global_namespace = frame.f_globals
2029 2029 else:
2030 2030 self.Completer.namespace = self.user_ns
2031 2031 self.Completer.global_namespace = self.user_global_ns
2032 2032
2033 2033 #-------------------------------------------------------------------------
2034 2034 # Things related to magics
2035 2035 #-------------------------------------------------------------------------
2036 2036
2037 2037 def init_magics(self):
2038 2038 from IPython.core import magics as m
2039 2039 self.magics_manager = magic.MagicsManager(shell=self,
2040 2040 parent=self,
2041 2041 user_magics=m.UserMagics(self))
2042 2042 self.configurables.append(self.magics_manager)
2043 2043
2044 2044 # Expose as public API from the magics manager
2045 2045 self.register_magics = self.magics_manager.register
2046 2046 self.define_magic = self.magics_manager.define_magic
2047 2047
2048 2048 self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics,
2049 2049 m.ConfigMagics, m.DeprecatedMagics, m.DisplayMagics, m.ExecutionMagics,
2050 2050 m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics,
2051 2051 m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics,
2052 2052 )
2053 2053
2054 2054 # Register Magic Aliases
2055 2055 mman = self.magics_manager
2056 2056 # FIXME: magic aliases should be defined by the Magics classes
2057 2057 # or in MagicsManager, not here
2058 2058 mman.register_alias('ed', 'edit')
2059 2059 mman.register_alias('hist', 'history')
2060 2060 mman.register_alias('rep', 'recall')
2061 2061 mman.register_alias('SVG', 'svg', 'cell')
2062 2062 mman.register_alias('HTML', 'html', 'cell')
2063 2063 mman.register_alias('file', 'writefile', 'cell')
2064 2064
2065 2065 # FIXME: Move the color initialization to the DisplayHook, which
2066 2066 # should be split into a prompt manager and displayhook. We probably
2067 2067 # even need a centralize colors management object.
2068 2068 self.magic('colors %s' % self.colors)
2069 2069
2070 2070 # Defined here so that it's included in the documentation
2071 2071 @functools.wraps(magic.MagicsManager.register_function)
2072 2072 def register_magic_function(self, func, magic_kind='line', magic_name=None):
2073 2073 self.magics_manager.register_function(func,
2074 2074 magic_kind=magic_kind, magic_name=magic_name)
2075 2075
2076 2076 def run_line_magic(self, magic_name, line):
2077 2077 """Execute the given line magic.
2078 2078
2079 2079 Parameters
2080 2080 ----------
2081 2081 magic_name : str
2082 2082 Name of the desired magic function, without '%' prefix.
2083 2083
2084 2084 line : str
2085 2085 The rest of the input line as a single string.
2086 2086 """
2087 2087 fn = self.find_line_magic(magic_name)
2088 2088 if fn is None:
2089 2089 cm = self.find_cell_magic(magic_name)
2090 2090 etpl = "Line magic function `%%%s` not found%s."
2091 2091 extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, '
2092 2092 'did you mean that instead?)' % magic_name )
2093 2093 error(etpl % (magic_name, extra))
2094 2094 else:
2095 2095 # Note: this is the distance in the stack to the user's frame.
2096 2096 # This will need to be updated if the internal calling logic gets
2097 2097 # refactored, or else we'll be expanding the wrong variables.
2098 2098 stack_depth = 2
2099 2099 magic_arg_s = self.var_expand(line, stack_depth)
2100 2100 # Put magic args in a list so we can call with f(*a) syntax
2101 2101 args = [magic_arg_s]
2102 2102 kwargs = {}
2103 2103 # Grab local namespace if we need it:
2104 2104 if getattr(fn, "needs_local_scope", False):
2105 2105 kwargs['local_ns'] = sys._getframe(stack_depth).f_locals
2106 2106 with self.builtin_trap:
2107 2107 result = fn(*args,**kwargs)
2108 2108 return result
2109 2109
2110 2110 def run_cell_magic(self, magic_name, line, cell):
2111 2111 """Execute the given cell magic.
2112 2112
2113 2113 Parameters
2114 2114 ----------
2115 2115 magic_name : str
2116 2116 Name of the desired magic function, without '%' prefix.
2117 2117
2118 2118 line : str
2119 2119 The rest of the first input line as a single string.
2120 2120
2121 2121 cell : str
2122 2122 The body of the cell as a (possibly multiline) string.
2123 2123 """
2124 2124 fn = self.find_cell_magic(magic_name)
2125 2125 if fn is None:
2126 2126 lm = self.find_line_magic(magic_name)
2127 2127 etpl = "Cell magic `%%{0}` not found{1}."
2128 2128 extra = '' if lm is None else (' (But line magic `%{0}` exists, '
2129 2129 'did you mean that instead?)'.format(magic_name))
2130 2130 error(etpl.format(magic_name, extra))
2131 2131 elif cell == '':
2132 2132 message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name)
2133 2133 if self.find_line_magic(magic_name) is not None:
2134 2134 message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name)
2135 2135 raise UsageError(message)
2136 2136 else:
2137 2137 # Note: this is the distance in the stack to the user's frame.
2138 2138 # This will need to be updated if the internal calling logic gets
2139 2139 # refactored, or else we'll be expanding the wrong variables.
2140 2140 stack_depth = 2
2141 2141 magic_arg_s = self.var_expand(line, stack_depth)
2142 2142 with self.builtin_trap:
2143 2143 result = fn(magic_arg_s, cell)
2144 2144 return result
2145 2145
2146 2146 def find_line_magic(self, magic_name):
2147 2147 """Find and return a line magic by name.
2148 2148
2149 2149 Returns None if the magic isn't found."""
2150 2150 return self.magics_manager.magics['line'].get(magic_name)
2151 2151
2152 2152 def find_cell_magic(self, magic_name):
2153 2153 """Find and return a cell magic by name.
2154 2154
2155 2155 Returns None if the magic isn't found."""
2156 2156 return self.magics_manager.magics['cell'].get(magic_name)
2157 2157
2158 2158 def find_magic(self, magic_name, magic_kind='line'):
2159 2159 """Find and return a magic of the given type by name.
2160 2160
2161 2161 Returns None if the magic isn't found."""
2162 2162 return self.magics_manager.magics[magic_kind].get(magic_name)
2163 2163
2164 2164 def magic(self, arg_s):
2165 2165 """DEPRECATED. Use run_line_magic() instead.
2166 2166
2167 2167 Call a magic function by name.
2168 2168
2169 2169 Input: a string containing the name of the magic function to call and
2170 2170 any additional arguments to be passed to the magic.
2171 2171
2172 2172 magic('name -opt foo bar') is equivalent to typing at the ipython
2173 2173 prompt:
2174 2174
2175 2175 In[1]: %name -opt foo bar
2176 2176
2177 2177 To call a magic without arguments, simply use magic('name').
2178 2178
2179 2179 This provides a proper Python function to call IPython's magics in any
2180 2180 valid Python code you can type at the interpreter, including loops and
2181 2181 compound statements.
2182 2182 """
2183 2183 # TODO: should we issue a loud deprecation warning here?
2184 2184 magic_name, _, magic_arg_s = arg_s.partition(' ')
2185 2185 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2186 2186 return self.run_line_magic(magic_name, magic_arg_s)
2187 2187
2188 2188 #-------------------------------------------------------------------------
2189 2189 # Things related to macros
2190 2190 #-------------------------------------------------------------------------
2191 2191
2192 2192 def define_macro(self, name, themacro):
2193 2193 """Define a new macro
2194 2194
2195 2195 Parameters
2196 2196 ----------
2197 2197 name : str
2198 2198 The name of the macro.
2199 2199 themacro : str or Macro
2200 2200 The action to do upon invoking the macro. If a string, a new
2201 2201 Macro object is created by passing the string to it.
2202 2202 """
2203 2203
2204 2204 from IPython.core import macro
2205 2205
2206 2206 if isinstance(themacro, string_types):
2207 2207 themacro = macro.Macro(themacro)
2208 2208 if not isinstance(themacro, macro.Macro):
2209 2209 raise ValueError('A macro must be a string or a Macro instance.')
2210 2210 self.user_ns[name] = themacro
2211 2211
2212 2212 #-------------------------------------------------------------------------
2213 2213 # Things related to the running of system commands
2214 2214 #-------------------------------------------------------------------------
2215 2215
2216 2216 def system_piped(self, cmd):
2217 2217 """Call the given cmd in a subprocess, piping stdout/err
2218 2218
2219 2219 Parameters
2220 2220 ----------
2221 2221 cmd : str
2222 2222 Command to execute (can not end in '&', as background processes are
2223 2223 not supported. Should not be a command that expects input
2224 2224 other than simple text.
2225 2225 """
2226 2226 if cmd.rstrip().endswith('&'):
2227 2227 # this is *far* from a rigorous test
2228 2228 # We do not support backgrounding processes because we either use
2229 2229 # pexpect or pipes to read from. Users can always just call
2230 2230 # os.system() or use ip.system=ip.system_raw
2231 2231 # if they really want a background process.
2232 2232 raise OSError("Background processes not supported.")
2233 2233
2234 2234 # we explicitly do NOT return the subprocess status code, because
2235 2235 # a non-None value would trigger :func:`sys.displayhook` calls.
2236 2236 # Instead, we store the exit_code in user_ns.
2237 2237 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1))
2238 2238
2239 2239 def system_raw(self, cmd):
2240 2240 """Call the given cmd in a subprocess using os.system on Windows or
2241 2241 subprocess.call using the system shell on other platforms.
2242 2242
2243 2243 Parameters
2244 2244 ----------
2245 2245 cmd : str
2246 2246 Command to execute.
2247 2247 """
2248 2248 cmd = self.var_expand(cmd, depth=1)
2249 2249 # protect os.system from UNC paths on Windows, which it can't handle:
2250 2250 if sys.platform == 'win32':
2251 2251 from IPython.utils._process_win32 import AvoidUNCPath
2252 2252 with AvoidUNCPath() as path:
2253 2253 if path is not None:
2254 2254 cmd = '"pushd %s &&"%s' % (path, cmd)
2255 2255 cmd = py3compat.unicode_to_str(cmd)
2256 2256 ec = os.system(cmd)
2257 2257 else:
2258 2258 cmd = py3compat.unicode_to_str(cmd)
2259 2259 # Call the cmd using the OS shell, instead of the default /bin/sh, if set.
2260 2260 ec = subprocess.call(cmd, shell=True, executable=os.environ.get('SHELL', None))
2261 2261 # exit code is positive for program failure, or negative for
2262 2262 # terminating signal number.
2263 2263
2264 2264 # We explicitly do NOT return the subprocess status code, because
2265 2265 # a non-None value would trigger :func:`sys.displayhook` calls.
2266 2266 # Instead, we store the exit_code in user_ns.
2267 2267 self.user_ns['_exit_code'] = ec
2268 2268
2269 2269 # use piped system by default, because it is better behaved
2270 2270 system = system_piped
2271 2271
2272 2272 def getoutput(self, cmd, split=True, depth=0):
2273 2273 """Get output (possibly including stderr) from a subprocess.
2274 2274
2275 2275 Parameters
2276 2276 ----------
2277 2277 cmd : str
2278 2278 Command to execute (can not end in '&', as background processes are
2279 2279 not supported.
2280 2280 split : bool, optional
2281 2281 If True, split the output into an IPython SList. Otherwise, an
2282 2282 IPython LSString is returned. These are objects similar to normal
2283 2283 lists and strings, with a few convenience attributes for easier
2284 2284 manipulation of line-based output. You can use '?' on them for
2285 2285 details.
2286 2286 depth : int, optional
2287 2287 How many frames above the caller are the local variables which should
2288 2288 be expanded in the command string? The default (0) assumes that the
2289 2289 expansion variables are in the stack frame calling this function.
2290 2290 """
2291 2291 if cmd.rstrip().endswith('&'):
2292 2292 # this is *far* from a rigorous test
2293 2293 raise OSError("Background processes not supported.")
2294 2294 out = getoutput(self.var_expand(cmd, depth=depth+1))
2295 2295 if split:
2296 2296 out = SList(out.splitlines())
2297 2297 else:
2298 2298 out = LSString(out)
2299 2299 return out
2300 2300
2301 2301 #-------------------------------------------------------------------------
2302 2302 # Things related to aliases
2303 2303 #-------------------------------------------------------------------------
2304 2304
2305 2305 def init_alias(self):
2306 2306 self.alias_manager = AliasManager(shell=self, parent=self)
2307 2307 self.configurables.append(self.alias_manager)
2308 2308
2309 2309 #-------------------------------------------------------------------------
2310 2310 # Things related to extensions
2311 2311 #-------------------------------------------------------------------------
2312 2312
2313 2313 def init_extension_manager(self):
2314 2314 self.extension_manager = ExtensionManager(shell=self, parent=self)
2315 2315 self.configurables.append(self.extension_manager)
2316 2316
2317 2317 #-------------------------------------------------------------------------
2318 2318 # Things related to payloads
2319 2319 #-------------------------------------------------------------------------
2320 2320
2321 2321 def init_payload(self):
2322 2322 self.payload_manager = PayloadManager(parent=self)
2323 2323 self.configurables.append(self.payload_manager)
2324 2324
2325 2325 #-------------------------------------------------------------------------
2326 2326 # Things related to widgets
2327 2327 #-------------------------------------------------------------------------
2328 2328
2329 2329 def init_comms(self):
2330 2330 # not implemented in the base class
2331 2331 pass
2332 2332
2333 2333 #-------------------------------------------------------------------------
2334 2334 # Things related to the prefilter
2335 2335 #-------------------------------------------------------------------------
2336 2336
2337 2337 def init_prefilter(self):
2338 2338 self.prefilter_manager = PrefilterManager(shell=self, parent=self)
2339 2339 self.configurables.append(self.prefilter_manager)
2340 2340 # Ultimately this will be refactored in the new interpreter code, but
2341 2341 # for now, we should expose the main prefilter method (there's legacy
2342 2342 # code out there that may rely on this).
2343 2343 self.prefilter = self.prefilter_manager.prefilter_lines
2344 2344
2345 2345 def auto_rewrite_input(self, cmd):
2346 2346 """Print to the screen the rewritten form of the user's command.
2347 2347
2348 2348 This shows visual feedback by rewriting input lines that cause
2349 2349 automatic calling to kick in, like::
2350 2350
2351 2351 /f x
2352 2352
2353 2353 into::
2354 2354
2355 2355 ------> f(x)
2356 2356
2357 2357 after the user's input prompt. This helps the user understand that the
2358 2358 input line was transformed automatically by IPython.
2359 2359 """
2360 2360 if not self.show_rewritten_input:
2361 2361 return
2362 2362
2363 2363 rw = self.prompt_manager.render('rewrite') + cmd
2364 2364
2365 2365 try:
2366 2366 # plain ascii works better w/ pyreadline, on some machines, so
2367 2367 # we use it and only print uncolored rewrite if we have unicode
2368 2368 rw = str(rw)
2369 2369 print(rw, file=io.stdout)
2370 2370 except UnicodeEncodeError:
2371 2371 print("------> " + cmd)
2372 2372
2373 2373 #-------------------------------------------------------------------------
2374 2374 # Things related to extracting values/expressions from kernel and user_ns
2375 2375 #-------------------------------------------------------------------------
2376 2376
2377 2377 def _user_obj_error(self):
2378 2378 """return simple exception dict
2379 2379
2380 2380 for use in user_variables / expressions
2381 2381 """
2382 2382
2383 2383 etype, evalue, tb = self._get_exc_info()
2384 2384 stb = self.InteractiveTB.get_exception_only(etype, evalue)
2385 2385
2386 2386 exc_info = {
2387 2387 u'status' : 'error',
2388 2388 u'traceback' : stb,
2389 2389 u'ename' : unicode_type(etype.__name__),
2390 2390 u'evalue' : py3compat.safe_unicode(evalue),
2391 2391 }
2392 2392
2393 2393 return exc_info
2394 2394
2395 2395 def _format_user_obj(self, obj):
2396 2396 """format a user object to display dict
2397 2397
2398 2398 for use in user_expressions / variables
2399 2399 """
2400 2400
2401 2401 data, md = self.display_formatter.format(obj)
2402 2402 value = {
2403 2403 'status' : 'ok',
2404 2404 'data' : data,
2405 2405 'metadata' : md,
2406 2406 }
2407 2407 return value
2408 2408
2409 2409 def user_variables(self, names):
2410 2410 """Get a list of variable names from the user's namespace.
2411 2411
2412 2412 Parameters
2413 2413 ----------
2414 2414 names : list of strings
2415 2415 A list of names of variables to be read from the user namespace.
2416 2416
2417 2417 Returns
2418 2418 -------
2419 2419 A dict, keyed by the input names and with the rich mime-type repr(s) of each value.
2420 2420 Each element will be a sub-dict of the same form as a display_data message.
2421 2421 """
2422 2422 out = {}
2423 2423 user_ns = self.user_ns
2424 2424
2425 2425 for varname in names:
2426 2426 try:
2427 2427 value = self._format_user_obj(user_ns[varname])
2428 2428 except:
2429 2429 value = self._user_obj_error()
2430 2430 out[varname] = value
2431 2431 return out
2432 2432
2433 2433 def user_expressions(self, expressions):
2434 2434 """Evaluate a dict of expressions in the user's namespace.
2435 2435
2436 2436 Parameters
2437 2437 ----------
2438 2438 expressions : dict
2439 2439 A dict with string keys and string values. The expression values
2440 2440 should be valid Python expressions, each of which will be evaluated
2441 2441 in the user namespace.
2442 2442
2443 2443 Returns
2444 2444 -------
2445 2445 A dict, keyed like the input expressions dict, with the rich mime-typed
2446 2446 display_data of each value.
2447 2447 """
2448 2448 out = {}
2449 2449 user_ns = self.user_ns
2450 2450 global_ns = self.user_global_ns
2451 2451
2452 2452 for key, expr in iteritems(expressions):
2453 2453 try:
2454 2454 value = self._format_user_obj(eval(expr, global_ns, user_ns))
2455 2455 except:
2456 2456 value = self._user_obj_error()
2457 2457 out[key] = value
2458 2458 return out
2459 2459
2460 2460 #-------------------------------------------------------------------------
2461 2461 # Things related to the running of code
2462 2462 #-------------------------------------------------------------------------
2463 2463
2464 2464 def ex(self, cmd):
2465 2465 """Execute a normal python statement in user namespace."""
2466 2466 with self.builtin_trap:
2467 2467 exec(cmd, self.user_global_ns, self.user_ns)
2468 2468
2469 2469 def ev(self, expr):
2470 2470 """Evaluate python expression expr in user namespace.
2471 2471
2472 2472 Returns the result of evaluation
2473 2473 """
2474 2474 with self.builtin_trap:
2475 2475 return eval(expr, self.user_global_ns, self.user_ns)
2476 2476
2477 2477 def safe_execfile(self, fname, *where, **kw):
2478 2478 """A safe version of the builtin execfile().
2479 2479
2480 2480 This version will never throw an exception, but instead print
2481 2481 helpful error messages to the screen. This only works on pure
2482 2482 Python files with the .py extension.
2483 2483
2484 2484 Parameters
2485 2485 ----------
2486 2486 fname : string
2487 2487 The name of the file to be executed.
2488 2488 where : tuple
2489 2489 One or two namespaces, passed to execfile() as (globals,locals).
2490 2490 If only one is given, it is passed as both.
2491 2491 exit_ignore : bool (False)
2492 2492 If True, then silence SystemExit for non-zero status (it is always
2493 2493 silenced for zero status, as it is so common).
2494 2494 raise_exceptions : bool (False)
2495 2495 If True raise exceptions everywhere. Meant for testing.
2496 2496
2497 2497 """
2498 2498 kw.setdefault('exit_ignore', False)
2499 2499 kw.setdefault('raise_exceptions', False)
2500 2500
2501 2501 fname = os.path.abspath(os.path.expanduser(fname))
2502 2502
2503 2503 # Make sure we can open the file
2504 2504 try:
2505 2505 with open(fname) as thefile:
2506 2506 pass
2507 2507 except:
2508 2508 warn('Could not open file <%s> for safe execution.' % fname)
2509 2509 return
2510 2510
2511 2511 # Find things also in current directory. This is needed to mimic the
2512 2512 # behavior of running a script from the system command line, where
2513 2513 # Python inserts the script's directory into sys.path
2514 2514 dname = os.path.dirname(fname)
2515 2515
2516 2516 with prepended_to_syspath(dname):
2517 2517 try:
2518 2518 py3compat.execfile(fname,*where)
2519 2519 except SystemExit as status:
2520 2520 # If the call was made with 0 or None exit status (sys.exit(0)
2521 2521 # or sys.exit() ), don't bother showing a traceback, as both of
2522 2522 # these are considered normal by the OS:
2523 2523 # > python -c'import sys;sys.exit(0)'; echo $?
2524 2524 # 0
2525 2525 # > python -c'import sys;sys.exit()'; echo $?
2526 2526 # 0
2527 2527 # For other exit status, we show the exception unless
2528 2528 # explicitly silenced, but only in short form.
2529 2529 if kw['raise_exceptions']:
2530 2530 raise
2531 2531 if status.code and not kw['exit_ignore']:
2532 2532 self.showtraceback(exception_only=True)
2533 2533 except:
2534 2534 if kw['raise_exceptions']:
2535 2535 raise
2536 2536 self.showtraceback()
2537 2537
2538 2538 def safe_execfile_ipy(self, fname):
2539 2539 """Like safe_execfile, but for .ipy files with IPython syntax.
2540 2540
2541 2541 Parameters
2542 2542 ----------
2543 2543 fname : str
2544 2544 The name of the file to execute. The filename must have a
2545 2545 .ipy extension.
2546 2546 """
2547 2547 fname = os.path.abspath(os.path.expanduser(fname))
2548 2548
2549 2549 # Make sure we can open the file
2550 2550 try:
2551 2551 with open(fname) as thefile:
2552 2552 pass
2553 2553 except:
2554 2554 warn('Could not open file <%s> for safe execution.' % fname)
2555 2555 return
2556 2556
2557 2557 # Find things also in current directory. This is needed to mimic the
2558 2558 # behavior of running a script from the system command line, where
2559 2559 # Python inserts the script's directory into sys.path
2560 2560 dname = os.path.dirname(fname)
2561 2561
2562 2562 with prepended_to_syspath(dname):
2563 2563 try:
2564 2564 with open(fname) as thefile:
2565 2565 # self.run_cell currently captures all exceptions
2566 2566 # raised in user code. It would be nice if there were
2567 2567 # versions of runlines, execfile that did raise, so
2568 2568 # we could catch the errors.
2569 2569 self.run_cell(thefile.read(), store_history=False, shell_futures=False)
2570 2570 except:
2571 2571 self.showtraceback()
2572 2572 warn('Unknown failure executing file: <%s>' % fname)
2573 2573
2574 2574 def safe_run_module(self, mod_name, where):
2575 2575 """A safe version of runpy.run_module().
2576 2576
2577 2577 This version will never throw an exception, but instead print
2578 2578 helpful error messages to the screen.
2579 2579
2580 2580 `SystemExit` exceptions with status code 0 or None are ignored.
2581 2581
2582 2582 Parameters
2583 2583 ----------
2584 2584 mod_name : string
2585 2585 The name of the module to be executed.
2586 2586 where : dict
2587 2587 The globals namespace.
2588 2588 """
2589 2589 try:
2590 2590 try:
2591 2591 where.update(
2592 2592 runpy.run_module(str(mod_name), run_name="__main__",
2593 2593 alter_sys=True)
2594 2594 )
2595 2595 except SystemExit as status:
2596 2596 if status.code:
2597 2597 raise
2598 2598 except:
2599 2599 self.showtraceback()
2600 2600 warn('Unknown failure executing module: <%s>' % mod_name)
2601 2601
2602 2602 def _run_cached_cell_magic(self, magic_name, line):
2603 2603 """Special method to call a cell magic with the data stored in self.
2604 2604 """
2605 2605 cell = self._current_cell_magic_body
2606 2606 self._current_cell_magic_body = None
2607 2607 return self.run_cell_magic(magic_name, line, cell)
2608 2608
2609 2609 def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True):
2610 2610 """Run a complete IPython cell.
2611 2611
2612 2612 Parameters
2613 2613 ----------
2614 2614 raw_cell : str
2615 2615 The code (including IPython code such as %magic functions) to run.
2616 2616 store_history : bool
2617 2617 If True, the raw and translated cell will be stored in IPython's
2618 2618 history. For user code calling back into IPython's machinery, this
2619 2619 should be set to False.
2620 2620 silent : bool
2621 2621 If True, avoid side-effects, such as implicit displayhooks and
2622 2622 and logging. silent=True forces store_history=False.
2623 2623 shell_futures : bool
2624 2624 If True, the code will share future statements with the interactive
2625 2625 shell. It will both be affected by previous __future__ imports, and
2626 2626 any __future__ imports in the code will affect the shell. If False,
2627 2627 __future__ imports are not shared in either direction.
2628 2628 """
2629 2629 if (not raw_cell) or raw_cell.isspace():
2630 2630 return
2631 2631
2632 2632 if silent:
2633 2633 store_history = False
2634 2634
2635 self.input_transformer_manager.push(raw_cell)
2635 prefilter_failed = False
2636 try:
2637 self.input_transformer_manager.push(raw_cell)
2638 except SyntaxError:
2639 self.showtraceback()
2640 prefilter_failed = True
2636 2641 cell = self.input_transformer_manager.source_reset()
2637 2642
2638 2643 # Our own compiler remembers the __future__ environment. If we want to
2639 2644 # run code with a separate __future__ environment, use the default
2640 2645 # compiler
2641 2646 compiler = self.compile if shell_futures else CachingCompiler()
2642 2647
2643 2648 with self.builtin_trap:
2644 prefilter_failed = False
2645 if len(cell.splitlines()) == 1:
2649 if not prefilter_failed and len(cell.splitlines()) == 1:
2646 2650 try:
2647 2651 # use prefilter_lines to handle trailing newlines
2648 2652 # restore trailing newline for ast.parse
2649 2653 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2650 2654 except AliasError as e:
2651 2655 error(e)
2652 2656 prefilter_failed = True
2653 2657 except Exception:
2654 2658 # don't allow prefilter errors to crash IPython
2655 2659 self.showtraceback()
2656 2660 prefilter_failed = True
2657 2661
2658 2662 # Store raw and processed history
2659 2663 if store_history:
2660 2664 self.history_manager.store_inputs(self.execution_count,
2661 2665 cell, raw_cell)
2662 2666 if not silent:
2663 2667 self.logger.log(cell, raw_cell)
2664 2668
2665 2669 if not prefilter_failed:
2666 2670 # don't run if prefilter failed
2667 2671 cell_name = self.compile.cache(cell, self.execution_count)
2668 2672
2669 2673 with self.display_trap:
2670 2674 try:
2671 2675 code_ast = compiler.ast_parse(cell, filename=cell_name)
2672 2676 except IndentationError:
2673 2677 self.showindentationerror()
2674 2678 if store_history:
2675 2679 self.execution_count += 1
2676 2680 return None
2677 2681 except (OverflowError, SyntaxError, ValueError, TypeError,
2678 2682 MemoryError):
2679 2683 self.showsyntaxerror()
2680 2684 if store_history:
2681 2685 self.execution_count += 1
2682 2686 return None
2683 2687
2684 2688 code_ast = self.transform_ast(code_ast)
2685 2689
2686 2690 interactivity = "none" if silent else self.ast_node_interactivity
2687 2691 self.run_ast_nodes(code_ast.body, cell_name,
2688 2692 interactivity=interactivity, compiler=compiler)
2689 2693
2690 2694 # Execute any registered post-execution functions.
2691 2695 # unless we are silent
2692 2696 post_exec = [] if silent else iteritems(self._post_execute)
2693 2697
2694 2698 for func, status in post_exec:
2695 2699 if self.disable_failing_post_execute and not status:
2696 2700 continue
2697 2701 try:
2698 2702 func()
2699 2703 except KeyboardInterrupt:
2700 2704 print("\nKeyboardInterrupt", file=io.stderr)
2701 2705 except Exception:
2702 2706 # register as failing:
2703 2707 self._post_execute[func] = False
2704 2708 self.showtraceback()
2705 2709 print('\n'.join([
2706 2710 "post-execution function %r produced an error." % func,
2707 2711 "If this problem persists, you can disable failing post-exec functions with:",
2708 2712 "",
2709 2713 " get_ipython().disable_failing_post_execute = True"
2710 2714 ]), file=io.stderr)
2711 2715
2712 2716 if store_history:
2713 2717 # Write output to the database. Does nothing unless
2714 2718 # history output logging is enabled.
2715 2719 self.history_manager.store_output(self.execution_count)
2716 2720 # Each cell is a *single* input, regardless of how many lines it has
2717 2721 self.execution_count += 1
2718 2722
2719 2723 def transform_ast(self, node):
2720 2724 """Apply the AST transformations from self.ast_transformers
2721 2725
2722 2726 Parameters
2723 2727 ----------
2724 2728 node : ast.Node
2725 2729 The root node to be transformed. Typically called with the ast.Module
2726 2730 produced by parsing user input.
2727 2731
2728 2732 Returns
2729 2733 -------
2730 2734 An ast.Node corresponding to the node it was called with. Note that it
2731 2735 may also modify the passed object, so don't rely on references to the
2732 2736 original AST.
2733 2737 """
2734 2738 for transformer in self.ast_transformers:
2735 2739 try:
2736 2740 node = transformer.visit(node)
2737 2741 except Exception:
2738 2742 warn("AST transformer %r threw an error. It will be unregistered." % transformer)
2739 2743 self.ast_transformers.remove(transformer)
2740 2744
2741 2745 if self.ast_transformers:
2742 2746 ast.fix_missing_locations(node)
2743 2747 return node
2744 2748
2745 2749
2746 2750 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr',
2747 2751 compiler=compile):
2748 2752 """Run a sequence of AST nodes. The execution mode depends on the
2749 2753 interactivity parameter.
2750 2754
2751 2755 Parameters
2752 2756 ----------
2753 2757 nodelist : list
2754 2758 A sequence of AST nodes to run.
2755 2759 cell_name : str
2756 2760 Will be passed to the compiler as the filename of the cell. Typically
2757 2761 the value returned by ip.compile.cache(cell).
2758 2762 interactivity : str
2759 2763 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2760 2764 run interactively (displaying output from expressions). 'last_expr'
2761 2765 will run the last node interactively only if it is an expression (i.e.
2762 2766 expressions in loops or other blocks are not displayed. Other values
2763 2767 for this parameter will raise a ValueError.
2764 2768 compiler : callable
2765 2769 A function with the same interface as the built-in compile(), to turn
2766 2770 the AST nodes into code objects. Default is the built-in compile().
2767 2771 """
2768 2772 if not nodelist:
2769 2773 return
2770 2774
2771 2775 if interactivity == 'last_expr':
2772 2776 if isinstance(nodelist[-1], ast.Expr):
2773 2777 interactivity = "last"
2774 2778 else:
2775 2779 interactivity = "none"
2776 2780
2777 2781 if interactivity == 'none':
2778 2782 to_run_exec, to_run_interactive = nodelist, []
2779 2783 elif interactivity == 'last':
2780 2784 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2781 2785 elif interactivity == 'all':
2782 2786 to_run_exec, to_run_interactive = [], nodelist
2783 2787 else:
2784 2788 raise ValueError("Interactivity was %r" % interactivity)
2785 2789
2786 2790 exec_count = self.execution_count
2787 2791
2788 2792 try:
2789 2793 for i, node in enumerate(to_run_exec):
2790 2794 mod = ast.Module([node])
2791 2795 code = compiler(mod, cell_name, "exec")
2792 2796 if self.run_code(code):
2793 2797 return True
2794 2798
2795 2799 for i, node in enumerate(to_run_interactive):
2796 2800 mod = ast.Interactive([node])
2797 2801 code = compiler(mod, cell_name, "single")
2798 2802 if self.run_code(code):
2799 2803 return True
2800 2804
2801 2805 # Flush softspace
2802 2806 if softspace(sys.stdout, 0):
2803 2807 print()
2804 2808
2805 2809 except:
2806 2810 # It's possible to have exceptions raised here, typically by
2807 2811 # compilation of odd code (such as a naked 'return' outside a
2808 2812 # function) that did parse but isn't valid. Typically the exception
2809 2813 # is a SyntaxError, but it's safest just to catch anything and show
2810 2814 # the user a traceback.
2811 2815
2812 2816 # We do only one try/except outside the loop to minimize the impact
2813 2817 # on runtime, and also because if any node in the node list is
2814 2818 # broken, we should stop execution completely.
2815 2819 self.showtraceback()
2816 2820
2817 2821 return False
2818 2822
2819 2823 def run_code(self, code_obj):
2820 2824 """Execute a code object.
2821 2825
2822 2826 When an exception occurs, self.showtraceback() is called to display a
2823 2827 traceback.
2824 2828
2825 2829 Parameters
2826 2830 ----------
2827 2831 code_obj : code object
2828 2832 A compiled code object, to be executed
2829 2833
2830 2834 Returns
2831 2835 -------
2832 2836 False : successful execution.
2833 2837 True : an error occurred.
2834 2838 """
2835 2839
2836 2840 # Set our own excepthook in case the user code tries to call it
2837 2841 # directly, so that the IPython crash handler doesn't get triggered
2838 2842 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2839 2843
2840 2844 # we save the original sys.excepthook in the instance, in case config
2841 2845 # code (such as magics) needs access to it.
2842 2846 self.sys_excepthook = old_excepthook
2843 2847 outflag = 1 # happens in more places, so it's easier as default
2844 2848 try:
2845 2849 try:
2846 2850 self.hooks.pre_run_code_hook()
2847 2851 #rprint('Running code', repr(code_obj)) # dbg
2848 2852 exec(code_obj, self.user_global_ns, self.user_ns)
2849 2853 finally:
2850 2854 # Reset our crash handler in place
2851 2855 sys.excepthook = old_excepthook
2852 2856 except SystemExit:
2853 2857 self.showtraceback(exception_only=True)
2854 2858 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2855 2859 except self.custom_exceptions:
2856 2860 etype,value,tb = sys.exc_info()
2857 2861 self.CustomTB(etype,value,tb)
2858 2862 except:
2859 2863 self.showtraceback()
2860 2864 else:
2861 2865 outflag = 0
2862 2866 return outflag
2863 2867
2864 2868 # For backwards compatibility
2865 2869 runcode = run_code
2866 2870
2867 2871 #-------------------------------------------------------------------------
2868 2872 # Things related to GUI support and pylab
2869 2873 #-------------------------------------------------------------------------
2870 2874
2871 2875 def enable_gui(self, gui=None):
2872 2876 raise NotImplementedError('Implement enable_gui in a subclass')
2873 2877
2874 2878 def enable_matplotlib(self, gui=None):
2875 2879 """Enable interactive matplotlib and inline figure support.
2876 2880
2877 2881 This takes the following steps:
2878 2882
2879 2883 1. select the appropriate eventloop and matplotlib backend
2880 2884 2. set up matplotlib for interactive use with that backend
2881 2885 3. configure formatters for inline figure display
2882 2886 4. enable the selected gui eventloop
2883 2887
2884 2888 Parameters
2885 2889 ----------
2886 2890 gui : optional, string
2887 2891 If given, dictates the choice of matplotlib GUI backend to use
2888 2892 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2889 2893 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2890 2894 matplotlib (as dictated by the matplotlib build-time options plus the
2891 2895 user's matplotlibrc configuration file). Note that not all backends
2892 2896 make sense in all contexts, for example a terminal ipython can't
2893 2897 display figures inline.
2894 2898 """
2895 2899 from IPython.core import pylabtools as pt
2896 2900 gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select)
2897 2901
2898 2902 if gui != 'inline':
2899 2903 # If we have our first gui selection, store it
2900 2904 if self.pylab_gui_select is None:
2901 2905 self.pylab_gui_select = gui
2902 2906 # Otherwise if they are different
2903 2907 elif gui != self.pylab_gui_select:
2904 2908 print ('Warning: Cannot change to a different GUI toolkit: %s.'
2905 2909 ' Using %s instead.' % (gui, self.pylab_gui_select))
2906 2910 gui, backend = pt.find_gui_and_backend(self.pylab_gui_select)
2907 2911
2908 2912 pt.activate_matplotlib(backend)
2909 2913 pt.configure_inline_support(self, backend)
2910 2914
2911 2915 # Now we must activate the gui pylab wants to use, and fix %run to take
2912 2916 # plot updates into account
2913 2917 self.enable_gui(gui)
2914 2918 self.magics_manager.registry['ExecutionMagics'].default_runner = \
2915 2919 pt.mpl_runner(self.safe_execfile)
2916 2920
2917 2921 return gui, backend
2918 2922
2919 2923 def enable_pylab(self, gui=None, import_all=True, welcome_message=False):
2920 2924 """Activate pylab support at runtime.
2921 2925
2922 2926 This turns on support for matplotlib, preloads into the interactive
2923 2927 namespace all of numpy and pylab, and configures IPython to correctly
2924 2928 interact with the GUI event loop. The GUI backend to be used can be
2925 2929 optionally selected with the optional ``gui`` argument.
2926 2930
2927 2931 This method only adds preloading the namespace to InteractiveShell.enable_matplotlib.
2928 2932
2929 2933 Parameters
2930 2934 ----------
2931 2935 gui : optional, string
2932 2936 If given, dictates the choice of matplotlib GUI backend to use
2933 2937 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2934 2938 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2935 2939 matplotlib (as dictated by the matplotlib build-time options plus the
2936 2940 user's matplotlibrc configuration file). Note that not all backends
2937 2941 make sense in all contexts, for example a terminal ipython can't
2938 2942 display figures inline.
2939 2943 import_all : optional, bool, default: True
2940 2944 Whether to do `from numpy import *` and `from pylab import *`
2941 2945 in addition to module imports.
2942 2946 welcome_message : deprecated
2943 2947 This argument is ignored, no welcome message will be displayed.
2944 2948 """
2945 2949 from IPython.core.pylabtools import import_pylab
2946 2950
2947 2951 gui, backend = self.enable_matplotlib(gui)
2948 2952
2949 2953 # We want to prevent the loading of pylab to pollute the user's
2950 2954 # namespace as shown by the %who* magics, so we execute the activation
2951 2955 # code in an empty namespace, and we update *both* user_ns and
2952 2956 # user_ns_hidden with this information.
2953 2957 ns = {}
2954 2958 import_pylab(ns, import_all)
2955 2959 # warn about clobbered names
2956 2960 ignored = set(["__builtins__"])
2957 2961 both = set(ns).intersection(self.user_ns).difference(ignored)
2958 2962 clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ]
2959 2963 self.user_ns.update(ns)
2960 2964 self.user_ns_hidden.update(ns)
2961 2965 return gui, backend, clobbered
2962 2966
2963 2967 #-------------------------------------------------------------------------
2964 2968 # Utilities
2965 2969 #-------------------------------------------------------------------------
2966 2970
2967 2971 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2968 2972 """Expand python variables in a string.
2969 2973
2970 2974 The depth argument indicates how many frames above the caller should
2971 2975 be walked to look for the local namespace where to expand variables.
2972 2976
2973 2977 The global namespace for expansion is always the user's interactive
2974 2978 namespace.
2975 2979 """
2976 2980 ns = self.user_ns.copy()
2977 2981 ns.update(sys._getframe(depth+1).f_locals)
2978 2982 try:
2979 2983 # We have to use .vformat() here, because 'self' is a valid and common
2980 2984 # name, and expanding **ns for .format() would make it collide with
2981 2985 # the 'self' argument of the method.
2982 2986 cmd = formatter.vformat(cmd, args=[], kwargs=ns)
2983 2987 except Exception:
2984 2988 # if formatter couldn't format, just let it go untransformed
2985 2989 pass
2986 2990 return cmd
2987 2991
2988 2992 def mktempfile(self, data=None, prefix='ipython_edit_'):
2989 2993 """Make a new tempfile and return its filename.
2990 2994
2991 2995 This makes a call to tempfile.mktemp, but it registers the created
2992 2996 filename internally so ipython cleans it up at exit time.
2993 2997
2994 2998 Optional inputs:
2995 2999
2996 3000 - data(None): if data is given, it gets written out to the temp file
2997 3001 immediately, and the file is closed again."""
2998 3002
2999 3003 filename = tempfile.mktemp('.py', prefix)
3000 3004 self.tempfiles.append(filename)
3001 3005
3002 3006 if data:
3003 3007 tmp_file = open(filename,'w')
3004 3008 tmp_file.write(data)
3005 3009 tmp_file.close()
3006 3010 return filename
3007 3011
3008 3012 # TODO: This should be removed when Term is refactored.
3009 3013 def write(self,data):
3010 3014 """Write a string to the default output"""
3011 3015 io.stdout.write(data)
3012 3016
3013 3017 # TODO: This should be removed when Term is refactored.
3014 3018 def write_err(self,data):
3015 3019 """Write a string to the default error output"""
3016 3020 io.stderr.write(data)
3017 3021
3018 3022 def ask_yes_no(self, prompt, default=None):
3019 3023 if self.quiet:
3020 3024 return True
3021 3025 return ask_yes_no(prompt,default)
3022 3026
3023 3027 def show_usage(self):
3024 3028 """Show a usage message"""
3025 3029 page.page(IPython.core.usage.interactive_usage)
3026 3030
3027 3031 def extract_input_lines(self, range_str, raw=False):
3028 3032 """Return as a string a set of input history slices.
3029 3033
3030 3034 Parameters
3031 3035 ----------
3032 3036 range_str : string
3033 3037 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
3034 3038 since this function is for use by magic functions which get their
3035 3039 arguments as strings. The number before the / is the session
3036 3040 number: ~n goes n back from the current session.
3037 3041
3038 3042 Optional Parameters:
3039 3043 - raw(False): by default, the processed input is used. If this is
3040 3044 true, the raw input history is used instead.
3041 3045
3042 3046 Note that slices can be called with two notations:
3043 3047
3044 3048 N:M -> standard python form, means including items N...(M-1).
3045 3049
3046 3050 N-M -> include items N..M (closed endpoint).
3047 3051 """
3048 3052 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
3049 3053 return "\n".join(x for _, _, x in lines)
3050 3054
3051 3055 def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True):
3052 3056 """Get a code string from history, file, url, or a string or macro.
3053 3057
3054 3058 This is mainly used by magic functions.
3055 3059
3056 3060 Parameters
3057 3061 ----------
3058 3062
3059 3063 target : str
3060 3064
3061 3065 A string specifying code to retrieve. This will be tried respectively
3062 3066 as: ranges of input history (see %history for syntax), url,
3063 3067 correspnding .py file, filename, or an expression evaluating to a
3064 3068 string or Macro in the user namespace.
3065 3069
3066 3070 raw : bool
3067 3071 If true (default), retrieve raw history. Has no effect on the other
3068 3072 retrieval mechanisms.
3069 3073
3070 3074 py_only : bool (default False)
3071 3075 Only try to fetch python code, do not try alternative methods to decode file
3072 3076 if unicode fails.
3073 3077
3074 3078 Returns
3075 3079 -------
3076 3080 A string of code.
3077 3081
3078 3082 ValueError is raised if nothing is found, and TypeError if it evaluates
3079 3083 to an object of another type. In each case, .args[0] is a printable
3080 3084 message.
3081 3085 """
3082 3086 code = self.extract_input_lines(target, raw=raw) # Grab history
3083 3087 if code:
3084 3088 return code
3085 3089 utarget = unquote_filename(target)
3086 3090 try:
3087 3091 if utarget.startswith(('http://', 'https://')):
3088 3092 return openpy.read_py_url(utarget, skip_encoding_cookie=skip_encoding_cookie)
3089 3093 except UnicodeDecodeError:
3090 3094 if not py_only :
3091 3095 from urllib import urlopen # Deferred import
3092 3096 response = urlopen(target)
3093 3097 return response.read().decode('latin1')
3094 3098 raise ValueError(("'%s' seem to be unreadable.") % utarget)
3095 3099
3096 3100 potential_target = [target]
3097 3101 try :
3098 3102 potential_target.insert(0,get_py_filename(target))
3099 3103 except IOError:
3100 3104 pass
3101 3105
3102 3106 for tgt in potential_target :
3103 3107 if os.path.isfile(tgt): # Read file
3104 3108 try :
3105 3109 return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie)
3106 3110 except UnicodeDecodeError :
3107 3111 if not py_only :
3108 3112 with io_open(tgt,'r', encoding='latin1') as f :
3109 3113 return f.read()
3110 3114 raise ValueError(("'%s' seem to be unreadable.") % target)
3111 3115 elif os.path.isdir(os.path.expanduser(tgt)):
3112 3116 raise ValueError("'%s' is a directory, not a regular file." % target)
3113 3117
3114 3118 try: # User namespace
3115 3119 codeobj = eval(target, self.user_ns)
3116 3120 except Exception:
3117 3121 raise ValueError(("'%s' was not found in history, as a file, url, "
3118 3122 "nor in the user namespace.") % target)
3119 3123 if isinstance(codeobj, string_types):
3120 3124 return codeobj
3121 3125 elif isinstance(codeobj, Macro):
3122 3126 return codeobj.value
3123 3127
3124 3128 raise TypeError("%s is neither a string nor a macro." % target,
3125 3129 codeobj)
3126 3130
3127 3131 #-------------------------------------------------------------------------
3128 3132 # Things related to IPython exiting
3129 3133 #-------------------------------------------------------------------------
3130 3134 def atexit_operations(self):
3131 3135 """This will be executed at the time of exit.
3132 3136
3133 3137 Cleanup operations and saving of persistent data that is done
3134 3138 unconditionally by IPython should be performed here.
3135 3139
3136 3140 For things that may depend on startup flags or platform specifics (such
3137 3141 as having readline or not), register a separate atexit function in the
3138 3142 code that has the appropriate information, rather than trying to
3139 3143 clutter
3140 3144 """
3141 3145 # Close the history session (this stores the end time and line count)
3142 3146 # this must be *before* the tempfile cleanup, in case of temporary
3143 3147 # history db
3144 3148 self.history_manager.end_session()
3145 3149
3146 3150 # Cleanup all tempfiles left around
3147 3151 for tfile in self.tempfiles:
3148 3152 try:
3149 3153 os.unlink(tfile)
3150 3154 except OSError:
3151 3155 pass
3152 3156
3153 3157 # Clear all user namespaces to release all references cleanly.
3154 3158 self.reset(new_session=False)
3155 3159
3156 3160 # Run user hooks
3157 3161 self.hooks.shutdown_hook()
3158 3162
3159 3163 def cleanup(self):
3160 3164 self.restore_sys_module_state()
3161 3165
3162 3166
3163 3167 class InteractiveShellABC(with_metaclass(abc.ABCMeta, object)):
3164 3168 """An abstract base class for InteractiveShell."""
3165 3169
3166 3170 InteractiveShellABC.register(InteractiveShell)
@@ -1,97 +1,50 b''
1 1 # coding: utf-8
2 2 """Tests for IPython.core.application"""
3 3
4 4 import os
5 5 import tempfile
6 import shutil
7
8 import nose.tools as nt
9 6
10 7 from IPython.core.application import BaseIPythonApplication
11 8 from IPython.testing import decorators as dec
12 from IPython.testing.tools import make_tempfile, ipexec
13 9 from IPython.utils import py3compat
14 10
15 11 @dec.onlyif_unicode_paths
16 12 def test_unicode_cwd():
17 13 """Check that IPython starts with non-ascii characters in the path."""
18 14 wd = tempfile.mkdtemp(suffix=u"€")
19 15
20 16 old_wd = py3compat.getcwd()
21 17 os.chdir(wd)
22 18 #raise Exception(repr(py3compat.getcwd()))
23 19 try:
24 20 app = BaseIPythonApplication()
25 21 # The lines below are copied from Application.initialize()
26 22 app.init_profile_dir()
27 23 app.init_config_files()
28 24 app.load_config_file(suppress_errors=False)
29 25 finally:
30 26 os.chdir(old_wd)
31 27
32 28 @dec.onlyif_unicode_paths
33 29 def test_unicode_ipdir():
34 30 """Check that IPython starts with non-ascii characters in the IP dir."""
35 31 ipdir = tempfile.mkdtemp(suffix=u"€")
36 32
37 33 # Create the config file, so it tries to load it.
38 34 with open(os.path.join(ipdir, 'ipython_config.py'), "w") as f:
39 35 pass
40 36
41 37 old_ipdir1 = os.environ.pop("IPYTHONDIR", None)
42 38 old_ipdir2 = os.environ.pop("IPYTHON_DIR", None)
43 39 os.environ["IPYTHONDIR"] = py3compat.unicode_to_str(ipdir, "utf-8")
44 40 try:
45 41 app = BaseIPythonApplication()
46 42 # The lines below are copied from Application.initialize()
47 43 app.init_profile_dir()
48 44 app.init_config_files()
49 45 app.load_config_file(suppress_errors=False)
50 46 finally:
51 47 if old_ipdir1:
52 48 os.environ["IPYTHONDIR"] = old_ipdir1
53 49 if old_ipdir2:
54 50 os.environ["IPYTHONDIR"] = old_ipdir2
55
56
57
58 TEST_SYNTAX_ERROR_CMDS = """
59 from IPython.core.inputtransformer import InputTransformer
60
61 %cpaste
62 class SyntaxErrorTransformer(InputTransformer):
63
64 def push(self, line):
65 if 'syntaxerror' in line:
66 raise SyntaxError('in input '+line)
67 return line
68
69 def reset(self):
70 pass
71 --
72
73 ip = get_ipython()
74 transformer = SyntaxErrorTransformer()
75 ip.input_splitter.python_line_transforms.append(transformer)
76 ip.input_transformer_manager.python_line_transforms.append(transformer)
77
78 # now the actual commands
79 1234
80 2345 # syntaxerror <- triggered here
81 3456
82 """
83
84 def test_syntax_error():
85 """Check that IPython does not abort if a SyntaxError is raised in an InputTransformer"""
86 try:
87 tmp = tempfile.mkdtemp()
88 filename = os.path.join(tmp, 'test_syntax_error.py')
89 with open(filename, 'w') as f:
90 f.write(TEST_SYNTAX_ERROR_CMDS)
91 out, err = ipexec(filename, pipe=True)
92 nt.assert_equal(err, '')
93 nt.assert_in('1234', out)
94 nt.assert_in('SyntaxError: in input 2345 # syntaxerror <- triggered here', out)
95 nt.assert_in('3456', out)
96 finally:
97 shutil.rmtree(tmp)
@@ -1,677 +1,715 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Tests for the key interactiveshell module.
3 3
4 4 Historically the main classes in interactiveshell have been under-tested. This
5 5 module should grow as many single-method tests as possible to trap many of the
6 6 recurring bugs we seem to encounter with high-level interaction.
7 7
8 8 Authors
9 9 -------
10 10 * Fernando Perez
11 11 """
12 12 #-----------------------------------------------------------------------------
13 13 # Copyright (C) 2011 The IPython Development Team
14 14 #
15 15 # Distributed under the terms of the BSD License. The full license is in
16 16 # the file COPYING, distributed as part of this software.
17 17 #-----------------------------------------------------------------------------
18 18
19 19 #-----------------------------------------------------------------------------
20 20 # Imports
21 21 #-----------------------------------------------------------------------------
22 22 # stdlib
23 23 import ast
24 24 import os
25 25 import signal
26 26 import shutil
27 27 import sys
28 28 import tempfile
29 29 import unittest
30 30 from os.path import join
31 31
32 32 # third-party
33 33 import nose.tools as nt
34 34
35 35 # Our own
36 from IPython.core.inputtransformer import InputTransformer
36 37 from IPython.testing.decorators import skipif, skip_win32, onlyif_unicode_paths
37 38 from IPython.testing import tools as tt
38 39 from IPython.utils import io
39 40 from IPython.utils import py3compat
40 41 from IPython.utils.py3compat import unicode_type, PY3
41 42
42 43 if PY3:
43 44 from io import StringIO
44 45 else:
45 46 from StringIO import StringIO
46 47
47 48 #-----------------------------------------------------------------------------
48 49 # Globals
49 50 #-----------------------------------------------------------------------------
50 51 # This is used by every single test, no point repeating it ad nauseam
51 52 ip = get_ipython()
52 53
53 54 #-----------------------------------------------------------------------------
54 55 # Tests
55 56 #-----------------------------------------------------------------------------
56 57
57 58 class InteractiveShellTestCase(unittest.TestCase):
58 59 def test_naked_string_cells(self):
59 60 """Test that cells with only naked strings are fully executed"""
60 61 # First, single-line inputs
61 62 ip.run_cell('"a"\n')
62 63 self.assertEqual(ip.user_ns['_'], 'a')
63 64 # And also multi-line cells
64 65 ip.run_cell('"""a\nb"""\n')
65 66 self.assertEqual(ip.user_ns['_'], 'a\nb')
66 67
67 68 def test_run_empty_cell(self):
68 69 """Just make sure we don't get a horrible error with a blank
69 70 cell of input. Yes, I did overlook that."""
70 71 old_xc = ip.execution_count
71 72 ip.run_cell('')
72 73 self.assertEqual(ip.execution_count, old_xc)
73 74
74 75 def test_run_cell_multiline(self):
75 76 """Multi-block, multi-line cells must execute correctly.
76 77 """
77 78 src = '\n'.join(["x=1",
78 79 "y=2",
79 80 "if 1:",
80 81 " x += 1",
81 82 " y += 1",])
82 83 ip.run_cell(src)
83 84 self.assertEqual(ip.user_ns['x'], 2)
84 85 self.assertEqual(ip.user_ns['y'], 3)
85 86
86 87 def test_multiline_string_cells(self):
87 88 "Code sprinkled with multiline strings should execute (GH-306)"
88 89 ip.run_cell('tmp=0')
89 90 self.assertEqual(ip.user_ns['tmp'], 0)
90 91 ip.run_cell('tmp=1;"""a\nb"""\n')
91 92 self.assertEqual(ip.user_ns['tmp'], 1)
92 93
93 94 def test_dont_cache_with_semicolon(self):
94 95 "Ending a line with semicolon should not cache the returned object (GH-307)"
95 96 oldlen = len(ip.user_ns['Out'])
96 97 a = ip.run_cell('1;', store_history=True)
97 98 newlen = len(ip.user_ns['Out'])
98 99 self.assertEqual(oldlen, newlen)
99 100 #also test the default caching behavior
100 101 ip.run_cell('1', store_history=True)
101 102 newlen = len(ip.user_ns['Out'])
102 103 self.assertEqual(oldlen+1, newlen)
103 104
104 105 def test_In_variable(self):
105 106 "Verify that In variable grows with user input (GH-284)"
106 107 oldlen = len(ip.user_ns['In'])
107 108 ip.run_cell('1;', store_history=True)
108 109 newlen = len(ip.user_ns['In'])
109 110 self.assertEqual(oldlen+1, newlen)
110 111 self.assertEqual(ip.user_ns['In'][-1],'1;')
111 112
112 113 def test_magic_names_in_string(self):
113 114 ip.run_cell('a = """\n%exit\n"""')
114 115 self.assertEqual(ip.user_ns['a'], '\n%exit\n')
115 116
116 117 def test_trailing_newline(self):
117 118 """test that running !(command) does not raise a SyntaxError"""
118 119 ip.run_cell('!(true)\n', False)
119 120 ip.run_cell('!(true)\n\n\n', False)
120 121
121 122 def test_gh_597(self):
122 123 """Pretty-printing lists of objects with non-ascii reprs may cause
123 124 problems."""
124 125 class Spam(object):
125 126 def __repr__(self):
126 127 return "\xe9"*50
127 128 import IPython.core.formatters
128 129 f = IPython.core.formatters.PlainTextFormatter()
129 130 f([Spam(),Spam()])
130 131
131 132
132 133 def test_future_flags(self):
133 134 """Check that future flags are used for parsing code (gh-777)"""
134 135 ip.run_cell('from __future__ import print_function')
135 136 try:
136 137 ip.run_cell('prfunc_return_val = print(1,2, sep=" ")')
137 138 assert 'prfunc_return_val' in ip.user_ns
138 139 finally:
139 140 # Reset compiler flags so we don't mess up other tests.
140 141 ip.compile.reset_compiler_flags()
141 142
142 143 def test_future_unicode(self):
143 144 """Check that unicode_literals is imported from __future__ (gh #786)"""
144 145 try:
145 146 ip.run_cell(u'byte_str = "a"')
146 147 assert isinstance(ip.user_ns['byte_str'], str) # string literals are byte strings by default
147 148 ip.run_cell('from __future__ import unicode_literals')
148 149 ip.run_cell(u'unicode_str = "a"')
149 150 assert isinstance(ip.user_ns['unicode_str'], unicode_type) # strings literals are now unicode
150 151 finally:
151 152 # Reset compiler flags so we don't mess up other tests.
152 153 ip.compile.reset_compiler_flags()
153 154
154 155 def test_can_pickle(self):
155 156 "Can we pickle objects defined interactively (GH-29)"
156 157 ip = get_ipython()
157 158 ip.reset()
158 159 ip.run_cell(("class Mylist(list):\n"
159 160 " def __init__(self,x=[]):\n"
160 161 " list.__init__(self,x)"))
161 162 ip.run_cell("w=Mylist([1,2,3])")
162 163
163 164 from pickle import dumps
164 165
165 166 # We need to swap in our main module - this is only necessary
166 167 # inside the test framework, because IPython puts the interactive module
167 168 # in place (but the test framework undoes this).
168 169 _main = sys.modules['__main__']
169 170 sys.modules['__main__'] = ip.user_module
170 171 try:
171 172 res = dumps(ip.user_ns["w"])
172 173 finally:
173 174 sys.modules['__main__'] = _main
174 175 self.assertTrue(isinstance(res, bytes))
175 176
176 177 def test_global_ns(self):
177 178 "Code in functions must be able to access variables outside them."
178 179 ip = get_ipython()
179 180 ip.run_cell("a = 10")
180 181 ip.run_cell(("def f(x):\n"
181 182 " return x + a"))
182 183 ip.run_cell("b = f(12)")
183 184 self.assertEqual(ip.user_ns["b"], 22)
184 185
185 186 def test_bad_custom_tb(self):
186 187 """Check that InteractiveShell is protected from bad custom exception handlers"""
187 188 from IPython.utils import io
188 189 save_stderr = io.stderr
189 190 try:
190 191 # capture stderr
191 192 io.stderr = StringIO()
192 193 ip.set_custom_exc((IOError,), lambda etype,value,tb: 1/0)
193 194 self.assertEqual(ip.custom_exceptions, (IOError,))
194 195 ip.run_cell(u'raise IOError("foo")')
195 196 self.assertEqual(ip.custom_exceptions, ())
196 197 self.assertTrue("Custom TB Handler failed" in io.stderr.getvalue())
197 198 finally:
198 199 io.stderr = save_stderr
199 200
200 201 def test_bad_custom_tb_return(self):
201 202 """Check that InteractiveShell is protected from bad return types in custom exception handlers"""
202 203 from IPython.utils import io
203 204 save_stderr = io.stderr
204 205 try:
205 206 # capture stderr
206 207 io.stderr = StringIO()
207 208 ip.set_custom_exc((NameError,),lambda etype,value,tb, tb_offset=None: 1)
208 209 self.assertEqual(ip.custom_exceptions, (NameError,))
209 210 ip.run_cell(u'a=abracadabra')
210 211 self.assertEqual(ip.custom_exceptions, ())
211 212 self.assertTrue("Custom TB Handler failed" in io.stderr.getvalue())
212 213 finally:
213 214 io.stderr = save_stderr
214 215
215 216 def test_drop_by_id(self):
216 217 myvars = {"a":object(), "b":object(), "c": object()}
217 218 ip.push(myvars, interactive=False)
218 219 for name in myvars:
219 220 assert name in ip.user_ns, name
220 221 assert name in ip.user_ns_hidden, name
221 222 ip.user_ns['b'] = 12
222 223 ip.drop_by_id(myvars)
223 224 for name in ["a", "c"]:
224 225 assert name not in ip.user_ns, name
225 226 assert name not in ip.user_ns_hidden, name
226 227 assert ip.user_ns['b'] == 12
227 228 ip.reset()
228 229
229 230 def test_var_expand(self):
230 231 ip.user_ns['f'] = u'Ca\xf1o'
231 232 self.assertEqual(ip.var_expand(u'echo $f'), u'echo Ca\xf1o')
232 233 self.assertEqual(ip.var_expand(u'echo {f}'), u'echo Ca\xf1o')
233 234 self.assertEqual(ip.var_expand(u'echo {f[:-1]}'), u'echo Ca\xf1')
234 235 self.assertEqual(ip.var_expand(u'echo {1*2}'), u'echo 2')
235 236
236 237 ip.user_ns['f'] = b'Ca\xc3\xb1o'
237 238 # This should not raise any exception:
238 239 ip.var_expand(u'echo $f')
239 240
240 241 def test_var_expand_local(self):
241 242 """Test local variable expansion in !system and %magic calls"""
242 243 # !system
243 244 ip.run_cell('def test():\n'
244 245 ' lvar = "ttt"\n'
245 246 ' ret = !echo {lvar}\n'
246 247 ' return ret[0]\n')
247 248 res = ip.user_ns['test']()
248 249 nt.assert_in('ttt', res)
249 250
250 251 # %magic
251 252 ip.run_cell('def makemacro():\n'
252 253 ' macroname = "macro_var_expand_locals"\n'
253 254 ' %macro {macroname} codestr\n')
254 255 ip.user_ns['codestr'] = "str(12)"
255 256 ip.run_cell('makemacro()')
256 257 nt.assert_in('macro_var_expand_locals', ip.user_ns)
257 258
258 259 def test_var_expand_self(self):
259 260 """Test variable expansion with the name 'self', which was failing.
260 261
261 262 See https://github.com/ipython/ipython/issues/1878#issuecomment-7698218
262 263 """
263 264 ip.run_cell('class cTest:\n'
264 265 ' classvar="see me"\n'
265 266 ' def test(self):\n'
266 267 ' res = !echo Variable: {self.classvar}\n'
267 268 ' return res[0]\n')
268 269 nt.assert_in('see me', ip.user_ns['cTest']().test())
269 270
270 271 def test_bad_var_expand(self):
271 272 """var_expand on invalid formats shouldn't raise"""
272 273 # SyntaxError
273 274 self.assertEqual(ip.var_expand(u"{'a':5}"), u"{'a':5}")
274 275 # NameError
275 276 self.assertEqual(ip.var_expand(u"{asdf}"), u"{asdf}")
276 277 # ZeroDivisionError
277 278 self.assertEqual(ip.var_expand(u"{1/0}"), u"{1/0}")
278 279
279 280 def test_silent_nopostexec(self):
280 281 """run_cell(silent=True) doesn't invoke post-exec funcs"""
281 282 d = dict(called=False)
282 283 def set_called():
283 284 d['called'] = True
284 285
285 286 ip.register_post_execute(set_called)
286 287 ip.run_cell("1", silent=True)
287 288 self.assertFalse(d['called'])
288 289 # double-check that non-silent exec did what we expected
289 290 # silent to avoid
290 291 ip.run_cell("1")
291 292 self.assertTrue(d['called'])
292 293 # remove post-exec
293 294 ip._post_execute.pop(set_called)
294 295
295 296 def test_silent_noadvance(self):
296 297 """run_cell(silent=True) doesn't advance execution_count"""
297 298 ec = ip.execution_count
298 299 # silent should force store_history=False
299 300 ip.run_cell("1", store_history=True, silent=True)
300 301
301 302 self.assertEqual(ec, ip.execution_count)
302 303 # double-check that non-silent exec did what we expected
303 304 # silent to avoid
304 305 ip.run_cell("1", store_history=True)
305 306 self.assertEqual(ec+1, ip.execution_count)
306 307
307 308 def test_silent_nodisplayhook(self):
308 309 """run_cell(silent=True) doesn't trigger displayhook"""
309 310 d = dict(called=False)
310 311
311 312 trap = ip.display_trap
312 313 save_hook = trap.hook
313 314
314 315 def failing_hook(*args, **kwargs):
315 316 d['called'] = True
316 317
317 318 try:
318 319 trap.hook = failing_hook
319 320 ip.run_cell("1", silent=True)
320 321 self.assertFalse(d['called'])
321 322 # double-check that non-silent exec did what we expected
322 323 # silent to avoid
323 324 ip.run_cell("1")
324 325 self.assertTrue(d['called'])
325 326 finally:
326 327 trap.hook = save_hook
327 328
328 329 @skipif(sys.version_info[0] >= 3, "softspace removed in py3")
329 330 def test_print_softspace(self):
330 331 """Verify that softspace is handled correctly when executing multiple
331 332 statements.
332 333
333 334 In [1]: print 1; print 2
334 335 1
335 336 2
336 337
337 338 In [2]: print 1,; print 2
338 339 1 2
339 340 """
340 341
341 342 def test_ofind_line_magic(self):
342 343 from IPython.core.magic import register_line_magic
343 344
344 345 @register_line_magic
345 346 def lmagic(line):
346 347 "A line magic"
347 348
348 349 # Get info on line magic
349 350 lfind = ip._ofind('lmagic')
350 351 info = dict(found=True, isalias=False, ismagic=True,
351 352 namespace = 'IPython internal', obj= lmagic.__wrapped__,
352 353 parent = None)
353 354 nt.assert_equal(lfind, info)
354 355
355 356 def test_ofind_cell_magic(self):
356 357 from IPython.core.magic import register_cell_magic
357 358
358 359 @register_cell_magic
359 360 def cmagic(line, cell):
360 361 "A cell magic"
361 362
362 363 # Get info on cell magic
363 364 find = ip._ofind('cmagic')
364 365 info = dict(found=True, isalias=False, ismagic=True,
365 366 namespace = 'IPython internal', obj= cmagic.__wrapped__,
366 367 parent = None)
367 368 nt.assert_equal(find, info)
368 369
369 370 def test_custom_exception(self):
370 371 called = []
371 372 def my_handler(shell, etype, value, tb, tb_offset=None):
372 373 called.append(etype)
373 374 shell.showtraceback((etype, value, tb), tb_offset=tb_offset)
374 375
375 376 ip.set_custom_exc((ValueError,), my_handler)
376 377 try:
377 378 ip.run_cell("raise ValueError('test')")
378 379 # Check that this was called, and only once.
379 380 self.assertEqual(called, [ValueError])
380 381 finally:
381 382 # Reset the custom exception hook
382 383 ip.set_custom_exc((), None)
383 384
384 385 @skipif(sys.version_info[0] >= 3, "no differences with __future__ in py3")
385 386 def test_future_environment(self):
386 387 "Can we run code with & without the shell's __future__ imports?"
387 388 ip.run_cell("from __future__ import division")
388 389 ip.run_cell("a = 1/2", shell_futures=True)
389 390 self.assertEqual(ip.user_ns['a'], 0.5)
390 391 ip.run_cell("b = 1/2", shell_futures=False)
391 392 self.assertEqual(ip.user_ns['b'], 0)
392 393
393 394 ip.compile.reset_compiler_flags()
394 395 # This shouldn't leak to the shell's compiler
395 396 ip.run_cell("from __future__ import division \nc=1/2", shell_futures=False)
396 397 self.assertEqual(ip.user_ns['c'], 0.5)
397 398 ip.run_cell("d = 1/2", shell_futures=True)
398 399 self.assertEqual(ip.user_ns['d'], 0)
399 400
400 401
401 402 class TestSafeExecfileNonAsciiPath(unittest.TestCase):
402 403
403 404 @onlyif_unicode_paths
404 405 def setUp(self):
405 406 self.BASETESTDIR = tempfile.mkdtemp()
406 407 self.TESTDIR = join(self.BASETESTDIR, u"Γ₯Àâ")
407 408 os.mkdir(self.TESTDIR)
408 409 with open(join(self.TESTDIR, u"Γ₯Àâtestscript.py"), "w") as sfile:
409 410 sfile.write("pass\n")
410 411 self.oldpath = py3compat.getcwd()
411 412 os.chdir(self.TESTDIR)
412 413 self.fname = u"Γ₯Àâtestscript.py"
413 414
414 415 def tearDown(self):
415 416 os.chdir(self.oldpath)
416 417 shutil.rmtree(self.BASETESTDIR)
417 418
418 419 @onlyif_unicode_paths
419 420 def test_1(self):
420 421 """Test safe_execfile with non-ascii path
421 422 """
422 423 ip.safe_execfile(self.fname, {}, raise_exceptions=True)
423 424
424 425 class ExitCodeChecks(tt.TempFileMixin):
425 426 def test_exit_code_ok(self):
426 427 self.system('exit 0')
427 428 self.assertEqual(ip.user_ns['_exit_code'], 0)
428 429
429 430 def test_exit_code_error(self):
430 431 self.system('exit 1')
431 432 self.assertEqual(ip.user_ns['_exit_code'], 1)
432 433
433 434 @skipif(not hasattr(signal, 'SIGALRM'))
434 435 def test_exit_code_signal(self):
435 436 self.mktmp("import signal, time\n"
436 437 "signal.setitimer(signal.ITIMER_REAL, 0.1)\n"
437 438 "time.sleep(1)\n")
438 439 self.system("%s %s" % (sys.executable, self.fname))
439 440 self.assertEqual(ip.user_ns['_exit_code'], -signal.SIGALRM)
440 441
441 442 class TestSystemRaw(unittest.TestCase, ExitCodeChecks):
442 443 system = ip.system_raw
443 444
444 445 @onlyif_unicode_paths
445 446 def test_1(self):
446 447 """Test system_raw with non-ascii cmd
447 448 """
448 449 cmd = u'''python -c "'Γ₯Àâ'" '''
449 450 ip.system_raw(cmd)
450 451
451 452 # TODO: Exit codes are currently ignored on Windows.
452 453 class TestSystemPipedExitCode(unittest.TestCase, ExitCodeChecks):
453 454 system = ip.system_piped
454 455
455 456 @skip_win32
456 457 def test_exit_code_ok(self):
457 458 ExitCodeChecks.test_exit_code_ok(self)
458 459
459 460 @skip_win32
460 461 def test_exit_code_error(self):
461 462 ExitCodeChecks.test_exit_code_error(self)
462 463
463 464 @skip_win32
464 465 def test_exit_code_signal(self):
465 466 ExitCodeChecks.test_exit_code_signal(self)
466 467
467 468 class TestModules(unittest.TestCase, tt.TempFileMixin):
468 469 def test_extraneous_loads(self):
469 470 """Test we're not loading modules on startup that we shouldn't.
470 471 """
471 472 self.mktmp("import sys\n"
472 473 "print('numpy' in sys.modules)\n"
473 474 "print('IPython.parallel' in sys.modules)\n"
474 475 "print('IPython.kernel.zmq' in sys.modules)\n"
475 476 )
476 477 out = "False\nFalse\nFalse\n"
477 478 tt.ipexec_validate(self.fname, out)
478 479
479 480 class Negator(ast.NodeTransformer):
480 481 """Negates all number literals in an AST."""
481 482 def visit_Num(self, node):
482 483 node.n = -node.n
483 484 return node
484 485
485 486 class TestAstTransform(unittest.TestCase):
486 487 def setUp(self):
487 488 self.negator = Negator()
488 489 ip.ast_transformers.append(self.negator)
489 490
490 491 def tearDown(self):
491 492 ip.ast_transformers.remove(self.negator)
492 493
493 494 def test_run_cell(self):
494 495 with tt.AssertPrints('-34'):
495 496 ip.run_cell('print (12 + 22)')
496 497
497 498 # A named reference to a number shouldn't be transformed.
498 499 ip.user_ns['n'] = 55
499 500 with tt.AssertNotPrints('-55'):
500 501 ip.run_cell('print (n)')
501 502
502 503 def test_timeit(self):
503 504 called = set()
504 505 def f(x):
505 506 called.add(x)
506 507 ip.push({'f':f})
507 508
508 509 with tt.AssertPrints("best of "):
509 510 ip.run_line_magic("timeit", "-n1 f(1)")
510 511 self.assertEqual(called, set([-1]))
511 512 called.clear()
512 513
513 514 with tt.AssertPrints("best of "):
514 515 ip.run_cell_magic("timeit", "-n1 f(2)", "f(3)")
515 516 self.assertEqual(called, set([-2, -3]))
516 517
517 518 def test_time(self):
518 519 called = []
519 520 def f(x):
520 521 called.append(x)
521 522 ip.push({'f':f})
522 523
523 524 # Test with an expression
524 525 with tt.AssertPrints("Wall time: "):
525 526 ip.run_line_magic("time", "f(5+9)")
526 527 self.assertEqual(called, [-14])
527 528 called[:] = []
528 529
529 530 # Test with a statement (different code path)
530 531 with tt.AssertPrints("Wall time: "):
531 532 ip.run_line_magic("time", "a = f(-3 + -2)")
532 533 self.assertEqual(called, [5])
533 534
534 535 def test_macro(self):
535 536 ip.push({'a':10})
536 537 # The AST transformation makes this do a+=-1
537 538 ip.define_macro("amacro", "a+=1\nprint(a)")
538 539
539 540 with tt.AssertPrints("9"):
540 541 ip.run_cell("amacro")
541 542 with tt.AssertPrints("8"):
542 543 ip.run_cell("amacro")
543 544
544 545 class IntegerWrapper(ast.NodeTransformer):
545 546 """Wraps all integers in a call to Integer()"""
546 547 def visit_Num(self, node):
547 548 if isinstance(node.n, int):
548 549 return ast.Call(func=ast.Name(id='Integer', ctx=ast.Load()),
549 550 args=[node], keywords=[])
550 551 return node
551 552
552 553 class TestAstTransform2(unittest.TestCase):
553 554 def setUp(self):
554 555 self.intwrapper = IntegerWrapper()
555 556 ip.ast_transformers.append(self.intwrapper)
556 557
557 558 self.calls = []
558 559 def Integer(*args):
559 560 self.calls.append(args)
560 561 return args
561 562 ip.push({"Integer": Integer})
562 563
563 564 def tearDown(self):
564 565 ip.ast_transformers.remove(self.intwrapper)
565 566 del ip.user_ns['Integer']
566 567
567 568 def test_run_cell(self):
568 569 ip.run_cell("n = 2")
569 570 self.assertEqual(self.calls, [(2,)])
570 571
571 572 # This shouldn't throw an error
572 573 ip.run_cell("o = 2.0")
573 574 self.assertEqual(ip.user_ns['o'], 2.0)
574 575
575 576 def test_timeit(self):
576 577 called = set()
577 578 def f(x):
578 579 called.add(x)
579 580 ip.push({'f':f})
580 581
581 582 with tt.AssertPrints("best of "):
582 583 ip.run_line_magic("timeit", "-n1 f(1)")
583 584 self.assertEqual(called, set([(1,)]))
584 585 called.clear()
585 586
586 587 with tt.AssertPrints("best of "):
587 588 ip.run_cell_magic("timeit", "-n1 f(2)", "f(3)")
588 589 self.assertEqual(called, set([(2,), (3,)]))
589 590
590 591 class ErrorTransformer(ast.NodeTransformer):
591 592 """Throws an error when it sees a number."""
592 593 def visit_Num(self):
593 594 raise ValueError("test")
594 595
595 596 class TestAstTransformError(unittest.TestCase):
596 597 def test_unregistering(self):
597 598 err_transformer = ErrorTransformer()
598 599 ip.ast_transformers.append(err_transformer)
599 600
600 601 with tt.AssertPrints("unregister", channel='stderr'):
601 602 ip.run_cell("1 + 2")
602 603
603 604 # This should have been removed.
604 605 nt.assert_not_in(err_transformer, ip.ast_transformers)
605 606
606 607 def test__IPYTHON__():
607 608 # This shouldn't raise a NameError, that's all
608 609 __IPYTHON__
609 610
610 611
611 612 class DummyRepr(object):
612 613 def __repr__(self):
613 614 return "DummyRepr"
614 615
615 616 def _repr_html_(self):
616 617 return "<b>dummy</b>"
617 618
618 619 def _repr_javascript_(self):
619 620 return "console.log('hi');", {'key': 'value'}
620 621
621 622
622 623 def test_user_variables():
623 624 # enable all formatters
624 625 ip.display_formatter.active_types = ip.display_formatter.format_types
625 626
626 627 ip.user_ns['dummy'] = d = DummyRepr()
627 628 keys = set(['dummy', 'doesnotexist'])
628 629 r = ip.user_variables(keys)
629 630
630 631 nt.assert_equal(keys, set(r.keys()))
631 632 dummy = r['dummy']
632 633 nt.assert_equal(set(['status', 'data', 'metadata']), set(dummy.keys()))
633 634 nt.assert_equal(dummy['status'], 'ok')
634 635 data = dummy['data']
635 636 metadata = dummy['metadata']
636 637 nt.assert_equal(data.get('text/html'), d._repr_html_())
637 638 js, jsmd = d._repr_javascript_()
638 639 nt.assert_equal(data.get('application/javascript'), js)
639 640 nt.assert_equal(metadata.get('application/javascript'), jsmd)
640 641
641 642 dne = r['doesnotexist']
642 643 nt.assert_equal(dne['status'], 'error')
643 644 nt.assert_equal(dne['ename'], 'KeyError')
644 645
645 646 # back to text only
646 647 ip.display_formatter.active_types = ['text/plain']
647 648
648 649 def test_user_expression():
649 650 # enable all formatters
650 651 ip.display_formatter.active_types = ip.display_formatter.format_types
651 652 query = {
652 653 'a' : '1 + 2',
653 654 'b' : '1/0',
654 655 }
655 656 r = ip.user_expressions(query)
656 657 import pprint
657 658 pprint.pprint(r)
658 659 nt.assert_equal(r.keys(), query.keys())
659 660 a = r['a']
660 661 nt.assert_equal(set(['status', 'data', 'metadata']), set(a.keys()))
661 662 nt.assert_equal(a['status'], 'ok')
662 663 data = a['data']
663 664 metadata = a['metadata']
664 665 nt.assert_equal(data.get('text/plain'), '3')
665 666
666 667 b = r['b']
667 668 nt.assert_equal(b['status'], 'error')
668 669 nt.assert_equal(b['ename'], 'ZeroDivisionError')
669 670
670 671 # back to text only
671 672 ip.display_formatter.active_types = ['text/plain']
672 673
673 674
674 675
675 676
676 677
678 class TestSyntaxErrorTransformer(unittest.TestCase):
679 """Check that SyntaxError raised by an input transformer is handled by run_cell()"""
680
681 class SyntaxErrorTransformer(InputTransformer):
682
683 def push(self, line):
684 pos = line.find('syntaxerror')
685 if pos >= 0:
686 e = SyntaxError('input contains "syntaxerror"')
687 e.text = line
688 e.offset = pos + 1
689 raise e
690 return line
691
692 def reset(self):
693 pass
694
695 def setUp(self):
696 self.transformer = TestSyntaxErrorTransformer.SyntaxErrorTransformer()
697 ip.input_splitter.python_line_transforms.append(self.transformer)
698 ip.input_transformer_manager.python_line_transforms.append(self.transformer)
699
700 def tearDown(self):
701 ip.input_splitter.python_line_transforms.remove(self.transformer)
702 ip.input_transformer_manager.python_line_transforms.remove(self.transformer)
703
704 def test_syntaxerror_input_transformer(self):
705 with tt.AssertPrints('1234'):
706 ip.run_cell('1234')
707 with tt.AssertPrints('SyntaxError: invalid syntax'):
708 ip.run_cell('1 2 3') # plain python syntax error
709 with tt.AssertPrints('SyntaxError: input contains "syntaxerror"'):
710 ip.run_cell('2345 # syntaxerror') # input transformer syntax error
711 with tt.AssertPrints('3456'):
712 ip.run_cell('3456')
713
714
677 715
General Comments 0
You need to be logged in to leave comments. Login now