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