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