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