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