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