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