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