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