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