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