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