##// END OF EJS Templates
Backport PR #13349: get_running_loop is only valid in coroutines...
Min RK -
Show More
@@ -1,173 +1,183 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 asyncio
16 import inspect
17 import inspect
17 from textwrap import dedent, indent
18 from textwrap import dedent, indent
18
19
19
20
20 class _AsyncIORunner:
21 class _AsyncIORunner:
22 def __init__(self):
23 self._loop = None
24
25 @property
26 def loop(self):
27 """Always returns a non-closed event loop"""
28 if self._loop is None or self._loop.is_closed():
29 policy = asyncio.get_event_loop_policy()
30 self._loop = policy.new_event_loop()
31 policy.set_event_loop(self._loop)
32 return self._loop
21
33
22 def __call__(self, coro):
34 def __call__(self, coro):
23 """
35 """
24 Handler for asyncio autoawait
36 Handler for asyncio autoawait
25 """
37 """
26 import asyncio
38 return self.loop.run_until_complete(coro)
27
28 return asyncio.get_event_loop().run_until_complete(coro)
29
39
30 def __str__(self):
40 def __str__(self):
31 return 'asyncio'
41 return 'asyncio'
32
42
33 _asyncio_runner = _AsyncIORunner()
43 _asyncio_runner = _AsyncIORunner()
34
44
35
45
36 def _curio_runner(coroutine):
46 def _curio_runner(coroutine):
37 """
47 """
38 handler for curio autoawait
48 handler for curio autoawait
39 """
49 """
40 import curio
50 import curio
41
51
42 return curio.run(coroutine)
52 return curio.run(coroutine)
43
53
44
54
45 def _trio_runner(async_fn):
55 def _trio_runner(async_fn):
46 import trio
56 import trio
47
57
48 async def loc(coro):
58 async def loc(coro):
49 """
59 """
50 We need the dummy no-op async def to protect from
60 We need the dummy no-op async def to protect from
51 trio's internal. See https://github.com/python-trio/trio/issues/89
61 trio's internal. See https://github.com/python-trio/trio/issues/89
52 """
62 """
53 return await coro
63 return await coro
54
64
55 return trio.run(loc, async_fn)
65 return trio.run(loc, async_fn)
56
66
57
67
58 def _pseudo_sync_runner(coro):
68 def _pseudo_sync_runner(coro):
59 """
69 """
60 A runner that does not really allow async execution, and just advance the coroutine.
70 A runner that does not really allow async execution, and just advance the coroutine.
61
71
62 See discussion in https://github.com/python-trio/trio/issues/608,
72 See discussion in https://github.com/python-trio/trio/issues/608,
63
73
64 Credit to Nathaniel Smith
74 Credit to Nathaniel Smith
65
75
66 """
76 """
67 try:
77 try:
68 coro.send(None)
78 coro.send(None)
69 except StopIteration as exc:
79 except StopIteration as exc:
70 return exc.value
80 return exc.value
71 else:
81 else:
72 # TODO: do not raise but return an execution result with the right info.
82 # TODO: do not raise but return an execution result with the right info.
73 raise RuntimeError(
83 raise RuntimeError(
74 "{coro_name!r} needs a real async loop".format(coro_name=coro.__name__)
84 "{coro_name!r} needs a real async loop".format(coro_name=coro.__name__)
75 )
85 )
76
86
77
87
78 def _asyncify(code: str) -> str:
88 def _asyncify(code: str) -> str:
79 """wrap code in async def definition.
89 """wrap code in async def definition.
80
90
81 And setup a bit of context to run it later.
91 And setup a bit of context to run it later.
82 """
92 """
83 res = dedent(
93 res = dedent(
84 """
94 """
85 async def __wrapper__():
95 async def __wrapper__():
86 try:
96 try:
87 {usercode}
97 {usercode}
88 finally:
98 finally:
89 locals()
99 locals()
90 """
100 """
91 ).format(usercode=indent(code, " " * 8))
101 ).format(usercode=indent(code, " " * 8))
92 return res
102 return res
93
103
94
104
95 class _AsyncSyntaxErrorVisitor(ast.NodeVisitor):
105 class _AsyncSyntaxErrorVisitor(ast.NodeVisitor):
96 """
106 """
97 Find syntax errors that would be an error in an async repl, but because
107 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
108 the implementation involves wrapping the repl in an async function, it
99 is erroneously allowed (e.g. yield or return at the top level)
109 is erroneously allowed (e.g. yield or return at the top level)
100 """
110 """
101 def __init__(self):
111 def __init__(self):
102 if sys.version_info >= (3,8):
112 if sys.version_info >= (3,8):
103 raise ValueError('DEPRECATED in Python 3.8+')
113 raise ValueError('DEPRECATED in Python 3.8+')
104 self.depth = 0
114 self.depth = 0
105 super().__init__()
115 super().__init__()
106
116
107 def generic_visit(self, node):
117 def generic_visit(self, node):
108 func_types = (ast.FunctionDef, ast.AsyncFunctionDef)
118 func_types = (ast.FunctionDef, ast.AsyncFunctionDef)
109 invalid_types_by_depth = {
119 invalid_types_by_depth = {
110 0: (ast.Return, ast.Yield, ast.YieldFrom),
120 0: (ast.Return, ast.Yield, ast.YieldFrom),
111 1: (ast.Nonlocal,)
121 1: (ast.Nonlocal,)
112 }
122 }
113
123
114 should_traverse = self.depth < max(invalid_types_by_depth.keys())
124 should_traverse = self.depth < max(invalid_types_by_depth.keys())
115 if isinstance(node, func_types) and should_traverse:
125 if isinstance(node, func_types) and should_traverse:
116 self.depth += 1
126 self.depth += 1
117 super().generic_visit(node)
127 super().generic_visit(node)
118 self.depth -= 1
128 self.depth -= 1
119 elif isinstance(node, invalid_types_by_depth[self.depth]):
129 elif isinstance(node, invalid_types_by_depth[self.depth]):
120 raise SyntaxError()
130 raise SyntaxError()
121 else:
131 else:
122 super().generic_visit(node)
132 super().generic_visit(node)
123
133
124
134
125 def _async_parse_cell(cell: str) -> ast.AST:
135 def _async_parse_cell(cell: str) -> ast.AST:
126 """
136 """
127 This is a compatibility shim for pre-3.7 when async outside of a function
137 This is a compatibility shim for pre-3.7 when async outside of a function
128 is a syntax error at the parse stage.
138 is a syntax error at the parse stage.
129
139
130 It will return an abstract syntax tree parsed as if async and await outside
140 It will return an abstract syntax tree parsed as if async and await outside
131 of a function were not a syntax error.
141 of a function were not a syntax error.
132 """
142 """
133 if sys.version_info < (3, 7):
143 if sys.version_info < (3, 7):
134 # Prior to 3.7 you need to asyncify before parse
144 # Prior to 3.7 you need to asyncify before parse
135 wrapped_parse_tree = ast.parse(_asyncify(cell))
145 wrapped_parse_tree = ast.parse(_asyncify(cell))
136 return wrapped_parse_tree.body[0].body[0]
146 return wrapped_parse_tree.body[0].body[0]
137 else:
147 else:
138 return ast.parse(cell)
148 return ast.parse(cell)
139
149
140
150
141 def _should_be_async(cell: str) -> bool:
151 def _should_be_async(cell: str) -> bool:
142 """Detect if a block of code need to be wrapped in an `async def`
152 """Detect if a block of code need to be wrapped in an `async def`
143
153
144 Attempt to parse the block of code, it it compile we're fine.
154 Attempt to parse the block of code, it it compile we're fine.
145 Otherwise we wrap if and try to compile.
155 Otherwise we wrap if and try to compile.
146
156
147 If it works, assume it should be async. Otherwise Return False.
157 If it works, assume it should be async. Otherwise Return False.
148
158
149 Not handled yet: If the block of code has a return statement as the top
159 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.
160 level, it will be seen as async. This is a know limitation.
151 """
161 """
152 if sys.version_info > (3, 8):
162 if sys.version_info > (3, 8):
153 try:
163 try:
154 code = compile(cell, "<>", "exec", flags=getattr(ast,'PyCF_ALLOW_TOP_LEVEL_AWAIT', 0x0))
164 code = compile(cell, "<>", "exec", flags=getattr(ast,'PyCF_ALLOW_TOP_LEVEL_AWAIT', 0x0))
155 return inspect.CO_COROUTINE & code.co_flags == inspect.CO_COROUTINE
165 return inspect.CO_COROUTINE & code.co_flags == inspect.CO_COROUTINE
156 except (SyntaxError, MemoryError):
166 except (SyntaxError, MemoryError):
157 return False
167 return False
158 try:
168 try:
159 # we can't limit ourself to ast.parse, as it __accepts__ to parse on
169 # we can't limit ourself to ast.parse, as it __accepts__ to parse on
160 # 3.7+, but just does not _compile_
170 # 3.7+, but just does not _compile_
161 code = compile(cell, "<>", "exec")
171 code = compile(cell, "<>", "exec")
162 except (SyntaxError, MemoryError):
172 except (SyntaxError, MemoryError):
163 try:
173 try:
164 parse_tree = _async_parse_cell(cell)
174 parse_tree = _async_parse_cell(cell)
165
175
166 # Raise a SyntaxError if there are top-level return or yields
176 # Raise a SyntaxError if there are top-level return or yields
167 v = _AsyncSyntaxErrorVisitor()
177 v = _AsyncSyntaxErrorVisitor()
168 v.visit(parse_tree)
178 v.visit(parse_tree)
169
179
170 except (SyntaxError, MemoryError):
180 except (SyntaxError, MemoryError):
171 return False
181 return False
172 return True
182 return True
173 return False
183 return False
@@ -1,1061 +1,1077 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """Tests for the key interactiveshell module.
2 """Tests for the key interactiveshell module.
3
3
4 Historically the main classes in interactiveshell have been under-tested. This
4 Historically the main classes in interactiveshell have been under-tested. This
5 module should grow as many single-method tests as possible to trap many of the
5 module should grow as many single-method tests as possible to trap many of the
6 recurring bugs we seem to encounter with high-level interaction.
6 recurring bugs we seem to encounter with high-level interaction.
7 """
7 """
8
8
9 # Copyright (c) IPython Development Team.
9 # Copyright (c) IPython Development Team.
10 # Distributed under the terms of the Modified BSD License.
10 # Distributed under the terms of the Modified BSD License.
11
11
12 import asyncio
12 import asyncio
13 import ast
13 import ast
14 import os
14 import os
15 import signal
15 import signal
16 import shutil
16 import shutil
17 import sys
17 import sys
18 import tempfile
18 import tempfile
19 import unittest
19 import unittest
20 from unittest import mock
20 from unittest import mock
21
21
22 from os.path import join
22 from os.path import join
23
23
24 import nose.tools as nt
24 import nose.tools as nt
25
25
26 from IPython.core.error import InputRejected
26 from IPython.core.error import InputRejected
27 from IPython.core.inputtransformer import InputTransformer
27 from IPython.core.inputtransformer import InputTransformer
28 from IPython.core import interactiveshell
28 from IPython.core import interactiveshell
29 from IPython.testing.decorators import (
29 from IPython.testing.decorators import (
30 skipif, skip_win32, onlyif_unicode_paths, onlyif_cmds_exist,
30 skipif, skip_win32, onlyif_unicode_paths, onlyif_cmds_exist,
31 )
31 )
32 from IPython.testing import tools as tt
32 from IPython.testing import tools as tt
33 from IPython.utils.process import find_cmd
33 from IPython.utils.process import find_cmd
34
34
35 #-----------------------------------------------------------------------------
35 #-----------------------------------------------------------------------------
36 # Globals
36 # Globals
37 #-----------------------------------------------------------------------------
37 #-----------------------------------------------------------------------------
38 # This is used by every single test, no point repeating it ad nauseam
38 # This is used by every single test, no point repeating it ad nauseam
39
39
40 #-----------------------------------------------------------------------------
40 #-----------------------------------------------------------------------------
41 # Tests
41 # Tests
42 #-----------------------------------------------------------------------------
42 #-----------------------------------------------------------------------------
43
43
44 class DerivedInterrupt(KeyboardInterrupt):
44 class DerivedInterrupt(KeyboardInterrupt):
45 pass
45 pass
46
46
47 class InteractiveShellTestCase(unittest.TestCase):
47 class InteractiveShellTestCase(unittest.TestCase):
48 def test_naked_string_cells(self):
48 def test_naked_string_cells(self):
49 """Test that cells with only naked strings are fully executed"""
49 """Test that cells with only naked strings are fully executed"""
50 # First, single-line inputs
50 # First, single-line inputs
51 ip.run_cell('"a"\n')
51 ip.run_cell('"a"\n')
52 self.assertEqual(ip.user_ns['_'], 'a')
52 self.assertEqual(ip.user_ns['_'], 'a')
53 # And also multi-line cells
53 # And also multi-line cells
54 ip.run_cell('"""a\nb"""\n')
54 ip.run_cell('"""a\nb"""\n')
55 self.assertEqual(ip.user_ns['_'], 'a\nb')
55 self.assertEqual(ip.user_ns['_'], 'a\nb')
56
56
57 def test_run_empty_cell(self):
57 def test_run_empty_cell(self):
58 """Just make sure we don't get a horrible error with a blank
58 """Just make sure we don't get a horrible error with a blank
59 cell of input. Yes, I did overlook that."""
59 cell of input. Yes, I did overlook that."""
60 old_xc = ip.execution_count
60 old_xc = ip.execution_count
61 res = ip.run_cell('')
61 res = ip.run_cell('')
62 self.assertEqual(ip.execution_count, old_xc)
62 self.assertEqual(ip.execution_count, old_xc)
63 self.assertEqual(res.execution_count, None)
63 self.assertEqual(res.execution_count, None)
64
64
65 def test_run_cell_multiline(self):
65 def test_run_cell_multiline(self):
66 """Multi-block, multi-line cells must execute correctly.
66 """Multi-block, multi-line cells must execute correctly.
67 """
67 """
68 src = '\n'.join(["x=1",
68 src = '\n'.join(["x=1",
69 "y=2",
69 "y=2",
70 "if 1:",
70 "if 1:",
71 " x += 1",
71 " x += 1",
72 " y += 1",])
72 " y += 1",])
73 res = ip.run_cell(src)
73 res = ip.run_cell(src)
74 self.assertEqual(ip.user_ns['x'], 2)
74 self.assertEqual(ip.user_ns['x'], 2)
75 self.assertEqual(ip.user_ns['y'], 3)
75 self.assertEqual(ip.user_ns['y'], 3)
76 self.assertEqual(res.success, True)
76 self.assertEqual(res.success, True)
77 self.assertEqual(res.result, None)
77 self.assertEqual(res.result, None)
78
78
79 def test_multiline_string_cells(self):
79 def test_multiline_string_cells(self):
80 "Code sprinkled with multiline strings should execute (GH-306)"
80 "Code sprinkled with multiline strings should execute (GH-306)"
81 ip.run_cell('tmp=0')
81 ip.run_cell('tmp=0')
82 self.assertEqual(ip.user_ns['tmp'], 0)
82 self.assertEqual(ip.user_ns['tmp'], 0)
83 res = ip.run_cell('tmp=1;"""a\nb"""\n')
83 res = ip.run_cell('tmp=1;"""a\nb"""\n')
84 self.assertEqual(ip.user_ns['tmp'], 1)
84 self.assertEqual(ip.user_ns['tmp'], 1)
85 self.assertEqual(res.success, True)
85 self.assertEqual(res.success, True)
86 self.assertEqual(res.result, "a\nb")
86 self.assertEqual(res.result, "a\nb")
87
87
88 def test_dont_cache_with_semicolon(self):
88 def test_dont_cache_with_semicolon(self):
89 "Ending a line with semicolon should not cache the returned object (GH-307)"
89 "Ending a line with semicolon should not cache the returned object (GH-307)"
90 oldlen = len(ip.user_ns['Out'])
90 oldlen = len(ip.user_ns['Out'])
91 for cell in ['1;', '1;1;']:
91 for cell in ['1;', '1;1;']:
92 res = ip.run_cell(cell, store_history=True)
92 res = ip.run_cell(cell, store_history=True)
93 newlen = len(ip.user_ns['Out'])
93 newlen = len(ip.user_ns['Out'])
94 self.assertEqual(oldlen, newlen)
94 self.assertEqual(oldlen, newlen)
95 self.assertIsNone(res.result)
95 self.assertIsNone(res.result)
96 i = 0
96 i = 0
97 #also test the default caching behavior
97 #also test the default caching behavior
98 for cell in ['1', '1;1']:
98 for cell in ['1', '1;1']:
99 ip.run_cell(cell, store_history=True)
99 ip.run_cell(cell, store_history=True)
100 newlen = len(ip.user_ns['Out'])
100 newlen = len(ip.user_ns['Out'])
101 i += 1
101 i += 1
102 self.assertEqual(oldlen+i, newlen)
102 self.assertEqual(oldlen+i, newlen)
103
103
104 def test_syntax_error(self):
104 def test_syntax_error(self):
105 res = ip.run_cell("raise = 3")
105 res = ip.run_cell("raise = 3")
106 self.assertIsInstance(res.error_before_exec, SyntaxError)
106 self.assertIsInstance(res.error_before_exec, SyntaxError)
107
107
108 def test_In_variable(self):
108 def test_In_variable(self):
109 "Verify that In variable grows with user input (GH-284)"
109 "Verify that In variable grows with user input (GH-284)"
110 oldlen = len(ip.user_ns['In'])
110 oldlen = len(ip.user_ns['In'])
111 ip.run_cell('1;', store_history=True)
111 ip.run_cell('1;', store_history=True)
112 newlen = len(ip.user_ns['In'])
112 newlen = len(ip.user_ns['In'])
113 self.assertEqual(oldlen+1, newlen)
113 self.assertEqual(oldlen+1, newlen)
114 self.assertEqual(ip.user_ns['In'][-1],'1;')
114 self.assertEqual(ip.user_ns['In'][-1],'1;')
115
115
116 def test_magic_names_in_string(self):
116 def test_magic_names_in_string(self):
117 ip.run_cell('a = """\n%exit\n"""')
117 ip.run_cell('a = """\n%exit\n"""')
118 self.assertEqual(ip.user_ns['a'], '\n%exit\n')
118 self.assertEqual(ip.user_ns['a'], '\n%exit\n')
119
119
120 def test_trailing_newline(self):
120 def test_trailing_newline(self):
121 """test that running !(command) does not raise a SyntaxError"""
121 """test that running !(command) does not raise a SyntaxError"""
122 ip.run_cell('!(true)\n', False)
122 ip.run_cell('!(true)\n', False)
123 ip.run_cell('!(true)\n\n\n', False)
123 ip.run_cell('!(true)\n\n\n', False)
124
124
125 def test_gh_597(self):
125 def test_gh_597(self):
126 """Pretty-printing lists of objects with non-ascii reprs may cause
126 """Pretty-printing lists of objects with non-ascii reprs may cause
127 problems."""
127 problems."""
128 class Spam(object):
128 class Spam(object):
129 def __repr__(self):
129 def __repr__(self):
130 return "\xe9"*50
130 return "\xe9"*50
131 import IPython.core.formatters
131 import IPython.core.formatters
132 f = IPython.core.formatters.PlainTextFormatter()
132 f = IPython.core.formatters.PlainTextFormatter()
133 f([Spam(),Spam()])
133 f([Spam(),Spam()])
134
134
135
135
136 def test_future_flags(self):
136 def test_future_flags(self):
137 """Check that future flags are used for parsing code (gh-777)"""
137 """Check that future flags are used for parsing code (gh-777)"""
138 ip.run_cell('from __future__ import barry_as_FLUFL')
138 ip.run_cell('from __future__ import barry_as_FLUFL')
139 try:
139 try:
140 ip.run_cell('prfunc_return_val = 1 <> 2')
140 ip.run_cell('prfunc_return_val = 1 <> 2')
141 assert 'prfunc_return_val' in ip.user_ns
141 assert 'prfunc_return_val' in ip.user_ns
142 finally:
142 finally:
143 # Reset compiler flags so we don't mess up other tests.
143 # Reset compiler flags so we don't mess up other tests.
144 ip.compile.reset_compiler_flags()
144 ip.compile.reset_compiler_flags()
145
145
146 def test_can_pickle(self):
146 def test_can_pickle(self):
147 "Can we pickle objects defined interactively (GH-29)"
147 "Can we pickle objects defined interactively (GH-29)"
148 ip = get_ipython()
148 ip = get_ipython()
149 ip.reset()
149 ip.reset()
150 ip.run_cell(("class Mylist(list):\n"
150 ip.run_cell(("class Mylist(list):\n"
151 " def __init__(self,x=[]):\n"
151 " def __init__(self,x=[]):\n"
152 " list.__init__(self,x)"))
152 " list.__init__(self,x)"))
153 ip.run_cell("w=Mylist([1,2,3])")
153 ip.run_cell("w=Mylist([1,2,3])")
154
154
155 from pickle import dumps
155 from pickle import dumps
156
156
157 # We need to swap in our main module - this is only necessary
157 # We need to swap in our main module - this is only necessary
158 # inside the test framework, because IPython puts the interactive module
158 # inside the test framework, because IPython puts the interactive module
159 # in place (but the test framework undoes this).
159 # in place (but the test framework undoes this).
160 _main = sys.modules['__main__']
160 _main = sys.modules['__main__']
161 sys.modules['__main__'] = ip.user_module
161 sys.modules['__main__'] = ip.user_module
162 try:
162 try:
163 res = dumps(ip.user_ns["w"])
163 res = dumps(ip.user_ns["w"])
164 finally:
164 finally:
165 sys.modules['__main__'] = _main
165 sys.modules['__main__'] = _main
166 self.assertTrue(isinstance(res, bytes))
166 self.assertTrue(isinstance(res, bytes))
167
167
168 def test_global_ns(self):
168 def test_global_ns(self):
169 "Code in functions must be able to access variables outside them."
169 "Code in functions must be able to access variables outside them."
170 ip = get_ipython()
170 ip = get_ipython()
171 ip.run_cell("a = 10")
171 ip.run_cell("a = 10")
172 ip.run_cell(("def f(x):\n"
172 ip.run_cell(("def f(x):\n"
173 " return x + a"))
173 " return x + a"))
174 ip.run_cell("b = f(12)")
174 ip.run_cell("b = f(12)")
175 self.assertEqual(ip.user_ns["b"], 22)
175 self.assertEqual(ip.user_ns["b"], 22)
176
176
177 def test_bad_custom_tb(self):
177 def test_bad_custom_tb(self):
178 """Check that InteractiveShell is protected from bad custom exception handlers"""
178 """Check that InteractiveShell is protected from bad custom exception handlers"""
179 ip.set_custom_exc((IOError,), lambda etype,value,tb: 1/0)
179 ip.set_custom_exc((IOError,), lambda etype,value,tb: 1/0)
180 self.assertEqual(ip.custom_exceptions, (IOError,))
180 self.assertEqual(ip.custom_exceptions, (IOError,))
181 with tt.AssertPrints("Custom TB Handler failed", channel='stderr'):
181 with tt.AssertPrints("Custom TB Handler failed", channel='stderr'):
182 ip.run_cell(u'raise IOError("foo")')
182 ip.run_cell(u'raise IOError("foo")')
183 self.assertEqual(ip.custom_exceptions, ())
183 self.assertEqual(ip.custom_exceptions, ())
184
184
185 def test_bad_custom_tb_return(self):
185 def test_bad_custom_tb_return(self):
186 """Check that InteractiveShell is protected from bad return types in custom exception handlers"""
186 """Check that InteractiveShell is protected from bad return types in custom exception handlers"""
187 ip.set_custom_exc((NameError,),lambda etype,value,tb, tb_offset=None: 1)
187 ip.set_custom_exc((NameError,),lambda etype,value,tb, tb_offset=None: 1)
188 self.assertEqual(ip.custom_exceptions, (NameError,))
188 self.assertEqual(ip.custom_exceptions, (NameError,))
189 with tt.AssertPrints("Custom TB Handler failed", channel='stderr'):
189 with tt.AssertPrints("Custom TB Handler failed", channel='stderr'):
190 ip.run_cell(u'a=abracadabra')
190 ip.run_cell(u'a=abracadabra')
191 self.assertEqual(ip.custom_exceptions, ())
191 self.assertEqual(ip.custom_exceptions, ())
192
192
193 def test_drop_by_id(self):
193 def test_drop_by_id(self):
194 myvars = {"a":object(), "b":object(), "c": object()}
194 myvars = {"a":object(), "b":object(), "c": object()}
195 ip.push(myvars, interactive=False)
195 ip.push(myvars, interactive=False)
196 for name in myvars:
196 for name in myvars:
197 assert name in ip.user_ns, name
197 assert name in ip.user_ns, name
198 assert name in ip.user_ns_hidden, name
198 assert name in ip.user_ns_hidden, name
199 ip.user_ns['b'] = 12
199 ip.user_ns['b'] = 12
200 ip.drop_by_id(myvars)
200 ip.drop_by_id(myvars)
201 for name in ["a", "c"]:
201 for name in ["a", "c"]:
202 assert name not in ip.user_ns, name
202 assert name not in ip.user_ns, name
203 assert name not in ip.user_ns_hidden, name
203 assert name not in ip.user_ns_hidden, name
204 assert ip.user_ns['b'] == 12
204 assert ip.user_ns['b'] == 12
205 ip.reset()
205 ip.reset()
206
206
207 def test_var_expand(self):
207 def test_var_expand(self):
208 ip.user_ns['f'] = u'Ca\xf1o'
208 ip.user_ns['f'] = u'Ca\xf1o'
209 self.assertEqual(ip.var_expand(u'echo $f'), u'echo Ca\xf1o')
209 self.assertEqual(ip.var_expand(u'echo $f'), u'echo Ca\xf1o')
210 self.assertEqual(ip.var_expand(u'echo {f}'), u'echo Ca\xf1o')
210 self.assertEqual(ip.var_expand(u'echo {f}'), u'echo Ca\xf1o')
211 self.assertEqual(ip.var_expand(u'echo {f[:-1]}'), u'echo Ca\xf1')
211 self.assertEqual(ip.var_expand(u'echo {f[:-1]}'), u'echo Ca\xf1')
212 self.assertEqual(ip.var_expand(u'echo {1*2}'), u'echo 2')
212 self.assertEqual(ip.var_expand(u'echo {1*2}'), u'echo 2')
213
213
214 self.assertEqual(ip.var_expand(u"grep x | awk '{print $1}'"), u"grep x | awk '{print $1}'")
214 self.assertEqual(ip.var_expand(u"grep x | awk '{print $1}'"), u"grep x | awk '{print $1}'")
215
215
216 ip.user_ns['f'] = b'Ca\xc3\xb1o'
216 ip.user_ns['f'] = b'Ca\xc3\xb1o'
217 # This should not raise any exception:
217 # This should not raise any exception:
218 ip.var_expand(u'echo $f')
218 ip.var_expand(u'echo $f')
219
219
220 def test_var_expand_local(self):
220 def test_var_expand_local(self):
221 """Test local variable expansion in !system and %magic calls"""
221 """Test local variable expansion in !system and %magic calls"""
222 # !system
222 # !system
223 ip.run_cell('def test():\n'
223 ip.run_cell('def test():\n'
224 ' lvar = "ttt"\n'
224 ' lvar = "ttt"\n'
225 ' ret = !echo {lvar}\n'
225 ' ret = !echo {lvar}\n'
226 ' return ret[0]\n')
226 ' return ret[0]\n')
227 res = ip.user_ns['test']()
227 res = ip.user_ns['test']()
228 nt.assert_in('ttt', res)
228 nt.assert_in('ttt', res)
229
229
230 # %magic
230 # %magic
231 ip.run_cell('def makemacro():\n'
231 ip.run_cell('def makemacro():\n'
232 ' macroname = "macro_var_expand_locals"\n'
232 ' macroname = "macro_var_expand_locals"\n'
233 ' %macro {macroname} codestr\n')
233 ' %macro {macroname} codestr\n')
234 ip.user_ns['codestr'] = "str(12)"
234 ip.user_ns['codestr'] = "str(12)"
235 ip.run_cell('makemacro()')
235 ip.run_cell('makemacro()')
236 nt.assert_in('macro_var_expand_locals', ip.user_ns)
236 nt.assert_in('macro_var_expand_locals', ip.user_ns)
237
237
238 def test_var_expand_self(self):
238 def test_var_expand_self(self):
239 """Test variable expansion with the name 'self', which was failing.
239 """Test variable expansion with the name 'self', which was failing.
240
240
241 See https://github.com/ipython/ipython/issues/1878#issuecomment-7698218
241 See https://github.com/ipython/ipython/issues/1878#issuecomment-7698218
242 """
242 """
243 ip.run_cell('class cTest:\n'
243 ip.run_cell('class cTest:\n'
244 ' classvar="see me"\n'
244 ' classvar="see me"\n'
245 ' def test(self):\n'
245 ' def test(self):\n'
246 ' res = !echo Variable: {self.classvar}\n'
246 ' res = !echo Variable: {self.classvar}\n'
247 ' return res[0]\n')
247 ' return res[0]\n')
248 nt.assert_in('see me', ip.user_ns['cTest']().test())
248 nt.assert_in('see me', ip.user_ns['cTest']().test())
249
249
250 def test_bad_var_expand(self):
250 def test_bad_var_expand(self):
251 """var_expand on invalid formats shouldn't raise"""
251 """var_expand on invalid formats shouldn't raise"""
252 # SyntaxError
252 # SyntaxError
253 self.assertEqual(ip.var_expand(u"{'a':5}"), u"{'a':5}")
253 self.assertEqual(ip.var_expand(u"{'a':5}"), u"{'a':5}")
254 # NameError
254 # NameError
255 self.assertEqual(ip.var_expand(u"{asdf}"), u"{asdf}")
255 self.assertEqual(ip.var_expand(u"{asdf}"), u"{asdf}")
256 # ZeroDivisionError
256 # ZeroDivisionError
257 self.assertEqual(ip.var_expand(u"{1/0}"), u"{1/0}")
257 self.assertEqual(ip.var_expand(u"{1/0}"), u"{1/0}")
258
258
259 def test_silent_postexec(self):
259 def test_silent_postexec(self):
260 """run_cell(silent=True) doesn't invoke pre/post_run_cell callbacks"""
260 """run_cell(silent=True) doesn't invoke pre/post_run_cell callbacks"""
261 pre_explicit = mock.Mock()
261 pre_explicit = mock.Mock()
262 pre_always = mock.Mock()
262 pre_always = mock.Mock()
263 post_explicit = mock.Mock()
263 post_explicit = mock.Mock()
264 post_always = mock.Mock()
264 post_always = mock.Mock()
265 all_mocks = [pre_explicit, pre_always, post_explicit, post_always]
265 all_mocks = [pre_explicit, pre_always, post_explicit, post_always]
266
266
267 ip.events.register('pre_run_cell', pre_explicit)
267 ip.events.register('pre_run_cell', pre_explicit)
268 ip.events.register('pre_execute', pre_always)
268 ip.events.register('pre_execute', pre_always)
269 ip.events.register('post_run_cell', post_explicit)
269 ip.events.register('post_run_cell', post_explicit)
270 ip.events.register('post_execute', post_always)
270 ip.events.register('post_execute', post_always)
271
271
272 try:
272 try:
273 ip.run_cell("1", silent=True)
273 ip.run_cell("1", silent=True)
274 assert pre_always.called
274 assert pre_always.called
275 assert not pre_explicit.called
275 assert not pre_explicit.called
276 assert post_always.called
276 assert post_always.called
277 assert not post_explicit.called
277 assert not post_explicit.called
278 # double-check that non-silent exec did what we expected
278 # double-check that non-silent exec did what we expected
279 # silent to avoid
279 # silent to avoid
280 ip.run_cell("1")
280 ip.run_cell("1")
281 assert pre_explicit.called
281 assert pre_explicit.called
282 assert post_explicit.called
282 assert post_explicit.called
283 info, = pre_explicit.call_args[0]
283 info, = pre_explicit.call_args[0]
284 result, = post_explicit.call_args[0]
284 result, = post_explicit.call_args[0]
285 self.assertEqual(info, result.info)
285 self.assertEqual(info, result.info)
286 # check that post hooks are always called
286 # check that post hooks are always called
287 [m.reset_mock() for m in all_mocks]
287 [m.reset_mock() for m in all_mocks]
288 ip.run_cell("syntax error")
288 ip.run_cell("syntax error")
289 assert pre_always.called
289 assert pre_always.called
290 assert pre_explicit.called
290 assert pre_explicit.called
291 assert post_always.called
291 assert post_always.called
292 assert post_explicit.called
292 assert post_explicit.called
293 info, = pre_explicit.call_args[0]
293 info, = pre_explicit.call_args[0]
294 result, = post_explicit.call_args[0]
294 result, = post_explicit.call_args[0]
295 self.assertEqual(info, result.info)
295 self.assertEqual(info, result.info)
296 finally:
296 finally:
297 # remove post-exec
297 # remove post-exec
298 ip.events.unregister('pre_run_cell', pre_explicit)
298 ip.events.unregister('pre_run_cell', pre_explicit)
299 ip.events.unregister('pre_execute', pre_always)
299 ip.events.unregister('pre_execute', pre_always)
300 ip.events.unregister('post_run_cell', post_explicit)
300 ip.events.unregister('post_run_cell', post_explicit)
301 ip.events.unregister('post_execute', post_always)
301 ip.events.unregister('post_execute', post_always)
302
302
303 def test_silent_noadvance(self):
303 def test_silent_noadvance(self):
304 """run_cell(silent=True) doesn't advance execution_count"""
304 """run_cell(silent=True) doesn't advance execution_count"""
305 ec = ip.execution_count
305 ec = ip.execution_count
306 # silent should force store_history=False
306 # silent should force store_history=False
307 ip.run_cell("1", store_history=True, silent=True)
307 ip.run_cell("1", store_history=True, silent=True)
308
308
309 self.assertEqual(ec, ip.execution_count)
309 self.assertEqual(ec, ip.execution_count)
310 # double-check that non-silent exec did what we expected
310 # double-check that non-silent exec did what we expected
311 # silent to avoid
311 # silent to avoid
312 ip.run_cell("1", store_history=True)
312 ip.run_cell("1", store_history=True)
313 self.assertEqual(ec+1, ip.execution_count)
313 self.assertEqual(ec+1, ip.execution_count)
314
314
315 def test_silent_nodisplayhook(self):
315 def test_silent_nodisplayhook(self):
316 """run_cell(silent=True) doesn't trigger displayhook"""
316 """run_cell(silent=True) doesn't trigger displayhook"""
317 d = dict(called=False)
317 d = dict(called=False)
318
318
319 trap = ip.display_trap
319 trap = ip.display_trap
320 save_hook = trap.hook
320 save_hook = trap.hook
321
321
322 def failing_hook(*args, **kwargs):
322 def failing_hook(*args, **kwargs):
323 d['called'] = True
323 d['called'] = True
324
324
325 try:
325 try:
326 trap.hook = failing_hook
326 trap.hook = failing_hook
327 res = ip.run_cell("1", silent=True)
327 res = ip.run_cell("1", silent=True)
328 self.assertFalse(d['called'])
328 self.assertFalse(d['called'])
329 self.assertIsNone(res.result)
329 self.assertIsNone(res.result)
330 # double-check that non-silent exec did what we expected
330 # double-check that non-silent exec did what we expected
331 # silent to avoid
331 # silent to avoid
332 ip.run_cell("1")
332 ip.run_cell("1")
333 self.assertTrue(d['called'])
333 self.assertTrue(d['called'])
334 finally:
334 finally:
335 trap.hook = save_hook
335 trap.hook = save_hook
336
336
337 def test_ofind_line_magic(self):
337 def test_ofind_line_magic(self):
338 from IPython.core.magic import register_line_magic
338 from IPython.core.magic import register_line_magic
339
339
340 @register_line_magic
340 @register_line_magic
341 def lmagic(line):
341 def lmagic(line):
342 "A line magic"
342 "A line magic"
343
343
344 # Get info on line magic
344 # Get info on line magic
345 lfind = ip._ofind('lmagic')
345 lfind = ip._ofind('lmagic')
346 info = dict(found=True, isalias=False, ismagic=True,
346 info = dict(found=True, isalias=False, ismagic=True,
347 namespace = 'IPython internal', obj= lmagic.__wrapped__,
347 namespace = 'IPython internal', obj= lmagic.__wrapped__,
348 parent = None)
348 parent = None)
349 nt.assert_equal(lfind, info)
349 nt.assert_equal(lfind, info)
350
350
351 def test_ofind_cell_magic(self):
351 def test_ofind_cell_magic(self):
352 from IPython.core.magic import register_cell_magic
352 from IPython.core.magic import register_cell_magic
353
353
354 @register_cell_magic
354 @register_cell_magic
355 def cmagic(line, cell):
355 def cmagic(line, cell):
356 "A cell magic"
356 "A cell magic"
357
357
358 # Get info on cell magic
358 # Get info on cell magic
359 find = ip._ofind('cmagic')
359 find = ip._ofind('cmagic')
360 info = dict(found=True, isalias=False, ismagic=True,
360 info = dict(found=True, isalias=False, ismagic=True,
361 namespace = 'IPython internal', obj= cmagic.__wrapped__,
361 namespace = 'IPython internal', obj= cmagic.__wrapped__,
362 parent = None)
362 parent = None)
363 nt.assert_equal(find, info)
363 nt.assert_equal(find, info)
364
364
365 def test_ofind_property_with_error(self):
365 def test_ofind_property_with_error(self):
366 class A(object):
366 class A(object):
367 @property
367 @property
368 def foo(self):
368 def foo(self):
369 raise NotImplementedError()
369 raise NotImplementedError()
370 a = A()
370 a = A()
371
371
372 found = ip._ofind('a.foo', [('locals', locals())])
372 found = ip._ofind('a.foo', [('locals', locals())])
373 info = dict(found=True, isalias=False, ismagic=False,
373 info = dict(found=True, isalias=False, ismagic=False,
374 namespace='locals', obj=A.foo, parent=a)
374 namespace='locals', obj=A.foo, parent=a)
375 nt.assert_equal(found, info)
375 nt.assert_equal(found, info)
376
376
377 def test_ofind_multiple_attribute_lookups(self):
377 def test_ofind_multiple_attribute_lookups(self):
378 class A(object):
378 class A(object):
379 @property
379 @property
380 def foo(self):
380 def foo(self):
381 raise NotImplementedError()
381 raise NotImplementedError()
382
382
383 a = A()
383 a = A()
384 a.a = A()
384 a.a = A()
385 a.a.a = A()
385 a.a.a = A()
386
386
387 found = ip._ofind('a.a.a.foo', [('locals', locals())])
387 found = ip._ofind('a.a.a.foo', [('locals', locals())])
388 info = dict(found=True, isalias=False, ismagic=False,
388 info = dict(found=True, isalias=False, ismagic=False,
389 namespace='locals', obj=A.foo, parent=a.a.a)
389 namespace='locals', obj=A.foo, parent=a.a.a)
390 nt.assert_equal(found, info)
390 nt.assert_equal(found, info)
391
391
392 def test_ofind_slotted_attributes(self):
392 def test_ofind_slotted_attributes(self):
393 class A(object):
393 class A(object):
394 __slots__ = ['foo']
394 __slots__ = ['foo']
395 def __init__(self):
395 def __init__(self):
396 self.foo = 'bar'
396 self.foo = 'bar'
397
397
398 a = A()
398 a = A()
399 found = ip._ofind('a.foo', [('locals', locals())])
399 found = ip._ofind('a.foo', [('locals', locals())])
400 info = dict(found=True, isalias=False, ismagic=False,
400 info = dict(found=True, isalias=False, ismagic=False,
401 namespace='locals', obj=a.foo, parent=a)
401 namespace='locals', obj=a.foo, parent=a)
402 nt.assert_equal(found, info)
402 nt.assert_equal(found, info)
403
403
404 found = ip._ofind('a.bar', [('locals', locals())])
404 found = ip._ofind('a.bar', [('locals', locals())])
405 info = dict(found=False, isalias=False, ismagic=False,
405 info = dict(found=False, isalias=False, ismagic=False,
406 namespace=None, obj=None, parent=a)
406 namespace=None, obj=None, parent=a)
407 nt.assert_equal(found, info)
407 nt.assert_equal(found, info)
408
408
409 def test_ofind_prefers_property_to_instance_level_attribute(self):
409 def test_ofind_prefers_property_to_instance_level_attribute(self):
410 class A(object):
410 class A(object):
411 @property
411 @property
412 def foo(self):
412 def foo(self):
413 return 'bar'
413 return 'bar'
414 a = A()
414 a = A()
415 a.__dict__['foo'] = 'baz'
415 a.__dict__['foo'] = 'baz'
416 nt.assert_equal(a.foo, 'bar')
416 nt.assert_equal(a.foo, 'bar')
417 found = ip._ofind('a.foo', [('locals', locals())])
417 found = ip._ofind('a.foo', [('locals', locals())])
418 nt.assert_is(found['obj'], A.foo)
418 nt.assert_is(found['obj'], A.foo)
419
419
420 def test_custom_syntaxerror_exception(self):
420 def test_custom_syntaxerror_exception(self):
421 called = []
421 called = []
422 def my_handler(shell, etype, value, tb, tb_offset=None):
422 def my_handler(shell, etype, value, tb, tb_offset=None):
423 called.append(etype)
423 called.append(etype)
424 shell.showtraceback((etype, value, tb), tb_offset=tb_offset)
424 shell.showtraceback((etype, value, tb), tb_offset=tb_offset)
425
425
426 ip.set_custom_exc((SyntaxError,), my_handler)
426 ip.set_custom_exc((SyntaxError,), my_handler)
427 try:
427 try:
428 ip.run_cell("1f")
428 ip.run_cell("1f")
429 # Check that this was called, and only once.
429 # Check that this was called, and only once.
430 self.assertEqual(called, [SyntaxError])
430 self.assertEqual(called, [SyntaxError])
431 finally:
431 finally:
432 # Reset the custom exception hook
432 # Reset the custom exception hook
433 ip.set_custom_exc((), None)
433 ip.set_custom_exc((), None)
434
434
435 def test_custom_exception(self):
435 def test_custom_exception(self):
436 called = []
436 called = []
437 def my_handler(shell, etype, value, tb, tb_offset=None):
437 def my_handler(shell, etype, value, tb, tb_offset=None):
438 called.append(etype)
438 called.append(etype)
439 shell.showtraceback((etype, value, tb), tb_offset=tb_offset)
439 shell.showtraceback((etype, value, tb), tb_offset=tb_offset)
440
440
441 ip.set_custom_exc((ValueError,), my_handler)
441 ip.set_custom_exc((ValueError,), my_handler)
442 try:
442 try:
443 res = ip.run_cell("raise ValueError('test')")
443 res = ip.run_cell("raise ValueError('test')")
444 # Check that this was called, and only once.
444 # Check that this was called, and only once.
445 self.assertEqual(called, [ValueError])
445 self.assertEqual(called, [ValueError])
446 # Check that the error is on the result object
446 # Check that the error is on the result object
447 self.assertIsInstance(res.error_in_exec, ValueError)
447 self.assertIsInstance(res.error_in_exec, ValueError)
448 finally:
448 finally:
449 # Reset the custom exception hook
449 # Reset the custom exception hook
450 ip.set_custom_exc((), None)
450 ip.set_custom_exc((), None)
451
451
452 @mock.patch("builtins.print")
452 @mock.patch("builtins.print")
453 def test_showtraceback_with_surrogates(self, mocked_print):
453 def test_showtraceback_with_surrogates(self, mocked_print):
454 values = []
454 values = []
455
455
456 def mock_print_func(value, sep=" ", end="\n", file=sys.stdout, flush=False):
456 def mock_print_func(value, sep=" ", end="\n", file=sys.stdout, flush=False):
457 values.append(value)
457 values.append(value)
458 if value == chr(0xD8FF):
458 if value == chr(0xD8FF):
459 raise UnicodeEncodeError("utf-8", chr(0xD8FF), 0, 1, "")
459 raise UnicodeEncodeError("utf-8", chr(0xD8FF), 0, 1, "")
460
460
461 # mock builtins.print
461 # mock builtins.print
462 mocked_print.side_effect = mock_print_func
462 mocked_print.side_effect = mock_print_func
463
463
464 # ip._showtraceback() is replaced in globalipapp.py.
464 # ip._showtraceback() is replaced in globalipapp.py.
465 # Call original method to test.
465 # Call original method to test.
466 interactiveshell.InteractiveShell._showtraceback(ip, None, None, chr(0xD8FF))
466 interactiveshell.InteractiveShell._showtraceback(ip, None, None, chr(0xD8FF))
467
467
468 self.assertEqual(mocked_print.call_count, 2)
468 self.assertEqual(mocked_print.call_count, 2)
469 self.assertEqual(values, [chr(0xD8FF), "\\ud8ff"])
469 self.assertEqual(values, [chr(0xD8FF), "\\ud8ff"])
470
470
471 def test_mktempfile(self):
471 def test_mktempfile(self):
472 filename = ip.mktempfile()
472 filename = ip.mktempfile()
473 # Check that we can open the file again on Windows
473 # Check that we can open the file again on Windows
474 with open(filename, 'w') as f:
474 with open(filename, 'w') as f:
475 f.write('abc')
475 f.write('abc')
476
476
477 filename = ip.mktempfile(data='blah')
477 filename = ip.mktempfile(data='blah')
478 with open(filename, 'r') as f:
478 with open(filename, 'r') as f:
479 self.assertEqual(f.read(), 'blah')
479 self.assertEqual(f.read(), 'blah')
480
480
481 def test_new_main_mod(self):
481 def test_new_main_mod(self):
482 # Smoketest to check that this accepts a unicode module name
482 # Smoketest to check that this accepts a unicode module name
483 name = u'jiefmw'
483 name = u'jiefmw'
484 mod = ip.new_main_mod(u'%s.py' % name, name)
484 mod = ip.new_main_mod(u'%s.py' % name, name)
485 self.assertEqual(mod.__name__, name)
485 self.assertEqual(mod.__name__, name)
486
486
487 def test_get_exception_only(self):
487 def test_get_exception_only(self):
488 try:
488 try:
489 raise KeyboardInterrupt
489 raise KeyboardInterrupt
490 except KeyboardInterrupt:
490 except KeyboardInterrupt:
491 msg = ip.get_exception_only()
491 msg = ip.get_exception_only()
492 self.assertEqual(msg, 'KeyboardInterrupt\n')
492 self.assertEqual(msg, 'KeyboardInterrupt\n')
493
493
494 try:
494 try:
495 raise DerivedInterrupt("foo")
495 raise DerivedInterrupt("foo")
496 except KeyboardInterrupt:
496 except KeyboardInterrupt:
497 msg = ip.get_exception_only()
497 msg = ip.get_exception_only()
498 self.assertEqual(msg, 'IPython.core.tests.test_interactiveshell.DerivedInterrupt: foo\n')
498 self.assertEqual(msg, 'IPython.core.tests.test_interactiveshell.DerivedInterrupt: foo\n')
499
499
500 def test_inspect_text(self):
500 def test_inspect_text(self):
501 ip.run_cell('a = 5')
501 ip.run_cell('a = 5')
502 text = ip.object_inspect_text('a')
502 text = ip.object_inspect_text('a')
503 self.assertIsInstance(text, str)
503 self.assertIsInstance(text, str)
504
504
505 def test_last_execution_result(self):
505 def test_last_execution_result(self):
506 """ Check that last execution result gets set correctly (GH-10702) """
506 """ Check that last execution result gets set correctly (GH-10702) """
507 result = ip.run_cell('a = 5; a')
507 result = ip.run_cell('a = 5; a')
508 self.assertTrue(ip.last_execution_succeeded)
508 self.assertTrue(ip.last_execution_succeeded)
509 self.assertEqual(ip.last_execution_result.result, 5)
509 self.assertEqual(ip.last_execution_result.result, 5)
510
510
511 result = ip.run_cell('a = x_invalid_id_x')
511 result = ip.run_cell('a = x_invalid_id_x')
512 self.assertFalse(ip.last_execution_succeeded)
512 self.assertFalse(ip.last_execution_succeeded)
513 self.assertFalse(ip.last_execution_result.success)
513 self.assertFalse(ip.last_execution_result.success)
514 self.assertIsInstance(ip.last_execution_result.error_in_exec, NameError)
514 self.assertIsInstance(ip.last_execution_result.error_in_exec, NameError)
515
515
516 def test_reset_aliasing(self):
516 def test_reset_aliasing(self):
517 """ Check that standard posix aliases work after %reset. """
517 """ Check that standard posix aliases work after %reset. """
518 if os.name != 'posix':
518 if os.name != 'posix':
519 return
519 return
520
520
521 ip.reset()
521 ip.reset()
522 for cmd in ('clear', 'more', 'less', 'man'):
522 for cmd in ('clear', 'more', 'less', 'man'):
523 res = ip.run_cell('%' + cmd)
523 res = ip.run_cell('%' + cmd)
524 self.assertEqual(res.success, True)
524 self.assertEqual(res.success, True)
525
525
526
526
527 class TestSafeExecfileNonAsciiPath(unittest.TestCase):
527 class TestSafeExecfileNonAsciiPath(unittest.TestCase):
528
528
529 @onlyif_unicode_paths
529 @onlyif_unicode_paths
530 def setUp(self):
530 def setUp(self):
531 self.BASETESTDIR = tempfile.mkdtemp()
531 self.BASETESTDIR = tempfile.mkdtemp()
532 self.TESTDIR = join(self.BASETESTDIR, u"Γ₯Àâ")
532 self.TESTDIR = join(self.BASETESTDIR, u"Γ₯Àâ")
533 os.mkdir(self.TESTDIR)
533 os.mkdir(self.TESTDIR)
534 with open(join(self.TESTDIR, u"Γ₯Àâtestscript.py"), "w") as sfile:
534 with open(join(self.TESTDIR, u"Γ₯Àâtestscript.py"), "w") as sfile:
535 sfile.write("pass\n")
535 sfile.write("pass\n")
536 self.oldpath = os.getcwd()
536 self.oldpath = os.getcwd()
537 os.chdir(self.TESTDIR)
537 os.chdir(self.TESTDIR)
538 self.fname = u"Γ₯Àâtestscript.py"
538 self.fname = u"Γ₯Àâtestscript.py"
539
539
540 def tearDown(self):
540 def tearDown(self):
541 os.chdir(self.oldpath)
541 os.chdir(self.oldpath)
542 shutil.rmtree(self.BASETESTDIR)
542 shutil.rmtree(self.BASETESTDIR)
543
543
544 @onlyif_unicode_paths
544 @onlyif_unicode_paths
545 def test_1(self):
545 def test_1(self):
546 """Test safe_execfile with non-ascii path
546 """Test safe_execfile with non-ascii path
547 """
547 """
548 ip.safe_execfile(self.fname, {}, raise_exceptions=True)
548 ip.safe_execfile(self.fname, {}, raise_exceptions=True)
549
549
550 class ExitCodeChecks(tt.TempFileMixin):
550 class ExitCodeChecks(tt.TempFileMixin):
551
551
552 def setUp(self):
552 def setUp(self):
553 self.system = ip.system_raw
553 self.system = ip.system_raw
554
554
555 def test_exit_code_ok(self):
555 def test_exit_code_ok(self):
556 self.system('exit 0')
556 self.system('exit 0')
557 self.assertEqual(ip.user_ns['_exit_code'], 0)
557 self.assertEqual(ip.user_ns['_exit_code'], 0)
558
558
559 def test_exit_code_error(self):
559 def test_exit_code_error(self):
560 self.system('exit 1')
560 self.system('exit 1')
561 self.assertEqual(ip.user_ns['_exit_code'], 1)
561 self.assertEqual(ip.user_ns['_exit_code'], 1)
562
562
563 @skipif(not hasattr(signal, 'SIGALRM'))
563 @skipif(not hasattr(signal, 'SIGALRM'))
564 def test_exit_code_signal(self):
564 def test_exit_code_signal(self):
565 self.mktmp("import signal, time\n"
565 self.mktmp("import signal, time\n"
566 "signal.setitimer(signal.ITIMER_REAL, 0.1)\n"
566 "signal.setitimer(signal.ITIMER_REAL, 0.1)\n"
567 "time.sleep(1)\n")
567 "time.sleep(1)\n")
568 self.system("%s %s" % (sys.executable, self.fname))
568 self.system("%s %s" % (sys.executable, self.fname))
569 self.assertEqual(ip.user_ns['_exit_code'], -signal.SIGALRM)
569 self.assertEqual(ip.user_ns['_exit_code'], -signal.SIGALRM)
570
570
571 @onlyif_cmds_exist("csh")
571 @onlyif_cmds_exist("csh")
572 def test_exit_code_signal_csh(self):
572 def test_exit_code_signal_csh(self):
573 SHELL = os.environ.get('SHELL', None)
573 SHELL = os.environ.get('SHELL', None)
574 os.environ['SHELL'] = find_cmd("csh")
574 os.environ['SHELL'] = find_cmd("csh")
575 try:
575 try:
576 self.test_exit_code_signal()
576 self.test_exit_code_signal()
577 finally:
577 finally:
578 if SHELL is not None:
578 if SHELL is not None:
579 os.environ['SHELL'] = SHELL
579 os.environ['SHELL'] = SHELL
580 else:
580 else:
581 del os.environ['SHELL']
581 del os.environ['SHELL']
582
582
583
583
584 class TestSystemRaw(ExitCodeChecks):
584 class TestSystemRaw(ExitCodeChecks):
585
585
586 def setUp(self):
586 def setUp(self):
587 super().setUp()
587 super().setUp()
588 self.system = ip.system_raw
588 self.system = ip.system_raw
589
589
590 @onlyif_unicode_paths
590 @onlyif_unicode_paths
591 def test_1(self):
591 def test_1(self):
592 """Test system_raw with non-ascii cmd
592 """Test system_raw with non-ascii cmd
593 """
593 """
594 cmd = u'''python -c "'Γ₯Àâ'" '''
594 cmd = u'''python -c "'Γ₯Àâ'" '''
595 ip.system_raw(cmd)
595 ip.system_raw(cmd)
596
596
597 @mock.patch('subprocess.call', side_effect=KeyboardInterrupt)
597 @mock.patch('subprocess.call', side_effect=KeyboardInterrupt)
598 @mock.patch('os.system', side_effect=KeyboardInterrupt)
598 @mock.patch('os.system', side_effect=KeyboardInterrupt)
599 def test_control_c(self, *mocks):
599 def test_control_c(self, *mocks):
600 try:
600 try:
601 self.system("sleep 1 # wont happen")
601 self.system("sleep 1 # wont happen")
602 except KeyboardInterrupt:
602 except KeyboardInterrupt:
603 self.fail("system call should intercept "
603 self.fail("system call should intercept "
604 "keyboard interrupt from subprocess.call")
604 "keyboard interrupt from subprocess.call")
605 self.assertEqual(ip.user_ns['_exit_code'], -signal.SIGINT)
605 self.assertEqual(ip.user_ns['_exit_code'], -signal.SIGINT)
606
606
607 # TODO: Exit codes are currently ignored on Windows.
607 # TODO: Exit codes are currently ignored on Windows.
608 class TestSystemPipedExitCode(ExitCodeChecks):
608 class TestSystemPipedExitCode(ExitCodeChecks):
609
609
610 def setUp(self):
610 def setUp(self):
611 super().setUp()
611 super().setUp()
612 self.system = ip.system_piped
612 self.system = ip.system_piped
613
613
614 @skip_win32
614 @skip_win32
615 def test_exit_code_ok(self):
615 def test_exit_code_ok(self):
616 ExitCodeChecks.test_exit_code_ok(self)
616 ExitCodeChecks.test_exit_code_ok(self)
617
617
618 @skip_win32
618 @skip_win32
619 def test_exit_code_error(self):
619 def test_exit_code_error(self):
620 ExitCodeChecks.test_exit_code_error(self)
620 ExitCodeChecks.test_exit_code_error(self)
621
621
622 @skip_win32
622 @skip_win32
623 def test_exit_code_signal(self):
623 def test_exit_code_signal(self):
624 ExitCodeChecks.test_exit_code_signal(self)
624 ExitCodeChecks.test_exit_code_signal(self)
625
625
626 class TestModules(tt.TempFileMixin):
626 class TestModules(tt.TempFileMixin):
627 def test_extraneous_loads(self):
627 def test_extraneous_loads(self):
628 """Test we're not loading modules on startup that we shouldn't.
628 """Test we're not loading modules on startup that we shouldn't.
629 """
629 """
630 self.mktmp("import sys\n"
630 self.mktmp("import sys\n"
631 "print('numpy' in sys.modules)\n"
631 "print('numpy' in sys.modules)\n"
632 "print('ipyparallel' in sys.modules)\n"
632 "print('ipyparallel' in sys.modules)\n"
633 "print('ipykernel' in sys.modules)\n"
633 "print('ipykernel' in sys.modules)\n"
634 )
634 )
635 out = "False\nFalse\nFalse\n"
635 out = "False\nFalse\nFalse\n"
636 tt.ipexec_validate(self.fname, out)
636 tt.ipexec_validate(self.fname, out)
637
637
638 class Negator(ast.NodeTransformer):
638 class Negator(ast.NodeTransformer):
639 """Negates all number literals in an AST."""
639 """Negates all number literals in an AST."""
640
640
641 # for python 3.7 and earlier
641 # for python 3.7 and earlier
642 def visit_Num(self, node):
642 def visit_Num(self, node):
643 node.n = -node.n
643 node.n = -node.n
644 return node
644 return node
645
645
646 # for python 3.8+
646 # for python 3.8+
647 def visit_Constant(self, node):
647 def visit_Constant(self, node):
648 if isinstance(node.value, int):
648 if isinstance(node.value, int):
649 return self.visit_Num(node)
649 return self.visit_Num(node)
650 return node
650 return node
651
651
652 class TestAstTransform(unittest.TestCase):
652 class TestAstTransform(unittest.TestCase):
653 def setUp(self):
653 def setUp(self):
654 self.negator = Negator()
654 self.negator = Negator()
655 ip.ast_transformers.append(self.negator)
655 ip.ast_transformers.append(self.negator)
656
656
657 def tearDown(self):
657 def tearDown(self):
658 ip.ast_transformers.remove(self.negator)
658 ip.ast_transformers.remove(self.negator)
659
659
660 def test_run_cell(self):
660 def test_run_cell(self):
661 with tt.AssertPrints('-34'):
661 with tt.AssertPrints('-34'):
662 ip.run_cell('print (12 + 22)')
662 ip.run_cell('print (12 + 22)')
663
663
664 # A named reference to a number shouldn't be transformed.
664 # A named reference to a number shouldn't be transformed.
665 ip.user_ns['n'] = 55
665 ip.user_ns['n'] = 55
666 with tt.AssertNotPrints('-55'):
666 with tt.AssertNotPrints('-55'):
667 ip.run_cell('print (n)')
667 ip.run_cell('print (n)')
668
668
669 def test_timeit(self):
669 def test_timeit(self):
670 called = set()
670 called = set()
671 def f(x):
671 def f(x):
672 called.add(x)
672 called.add(x)
673 ip.push({'f':f})
673 ip.push({'f':f})
674
674
675 with tt.AssertPrints("std. dev. of"):
675 with tt.AssertPrints("std. dev. of"):
676 ip.run_line_magic("timeit", "-n1 f(1)")
676 ip.run_line_magic("timeit", "-n1 f(1)")
677 self.assertEqual(called, {-1})
677 self.assertEqual(called, {-1})
678 called.clear()
678 called.clear()
679
679
680 with tt.AssertPrints("std. dev. of"):
680 with tt.AssertPrints("std. dev. of"):
681 ip.run_cell_magic("timeit", "-n1 f(2)", "f(3)")
681 ip.run_cell_magic("timeit", "-n1 f(2)", "f(3)")
682 self.assertEqual(called, {-2, -3})
682 self.assertEqual(called, {-2, -3})
683
683
684 def test_time(self):
684 def test_time(self):
685 called = []
685 called = []
686 def f(x):
686 def f(x):
687 called.append(x)
687 called.append(x)
688 ip.push({'f':f})
688 ip.push({'f':f})
689
689
690 # Test with an expression
690 # Test with an expression
691 with tt.AssertPrints("Wall time: "):
691 with tt.AssertPrints("Wall time: "):
692 ip.run_line_magic("time", "f(5+9)")
692 ip.run_line_magic("time", "f(5+9)")
693 self.assertEqual(called, [-14])
693 self.assertEqual(called, [-14])
694 called[:] = []
694 called[:] = []
695
695
696 # Test with a statement (different code path)
696 # Test with a statement (different code path)
697 with tt.AssertPrints("Wall time: "):
697 with tt.AssertPrints("Wall time: "):
698 ip.run_line_magic("time", "a = f(-3 + -2)")
698 ip.run_line_magic("time", "a = f(-3 + -2)")
699 self.assertEqual(called, [5])
699 self.assertEqual(called, [5])
700
700
701 def test_macro(self):
701 def test_macro(self):
702 ip.push({'a':10})
702 ip.push({'a':10})
703 # The AST transformation makes this do a+=-1
703 # The AST transformation makes this do a+=-1
704 ip.define_macro("amacro", "a+=1\nprint(a)")
704 ip.define_macro("amacro", "a+=1\nprint(a)")
705
705
706 with tt.AssertPrints("9"):
706 with tt.AssertPrints("9"):
707 ip.run_cell("amacro")
707 ip.run_cell("amacro")
708 with tt.AssertPrints("8"):
708 with tt.AssertPrints("8"):
709 ip.run_cell("amacro")
709 ip.run_cell("amacro")
710
710
711 class TestMiscTransform(unittest.TestCase):
711 class TestMiscTransform(unittest.TestCase):
712
712
713
713
714 def test_transform_only_once(self):
714 def test_transform_only_once(self):
715 cleanup = 0
715 cleanup = 0
716 line_t = 0
716 line_t = 0
717 def count_cleanup(lines):
717 def count_cleanup(lines):
718 nonlocal cleanup
718 nonlocal cleanup
719 cleanup += 1
719 cleanup += 1
720 return lines
720 return lines
721
721
722 def count_line_t(lines):
722 def count_line_t(lines):
723 nonlocal line_t
723 nonlocal line_t
724 line_t += 1
724 line_t += 1
725 return lines
725 return lines
726
726
727 ip.input_transformer_manager.cleanup_transforms.append(count_cleanup)
727 ip.input_transformer_manager.cleanup_transforms.append(count_cleanup)
728 ip.input_transformer_manager.line_transforms.append(count_line_t)
728 ip.input_transformer_manager.line_transforms.append(count_line_t)
729
729
730 ip.run_cell('1')
730 ip.run_cell('1')
731
731
732 assert cleanup == 1
732 assert cleanup == 1
733 assert line_t == 1
733 assert line_t == 1
734
734
735 class IntegerWrapper(ast.NodeTransformer):
735 class IntegerWrapper(ast.NodeTransformer):
736 """Wraps all integers in a call to Integer()"""
736 """Wraps all integers in a call to Integer()"""
737
737
738 # for Python 3.7 and earlier
738 # for Python 3.7 and earlier
739
739
740 # for Python 3.7 and earlier
740 # for Python 3.7 and earlier
741 def visit_Num(self, node):
741 def visit_Num(self, node):
742 if isinstance(node.n, int):
742 if isinstance(node.n, int):
743 return ast.Call(func=ast.Name(id='Integer', ctx=ast.Load()),
743 return ast.Call(func=ast.Name(id='Integer', ctx=ast.Load()),
744 args=[node], keywords=[])
744 args=[node], keywords=[])
745 return node
745 return node
746
746
747 # For Python 3.8+
747 # For Python 3.8+
748 def visit_Constant(self, node):
748 def visit_Constant(self, node):
749 if isinstance(node.value, int):
749 if isinstance(node.value, int):
750 return self.visit_Num(node)
750 return self.visit_Num(node)
751 return node
751 return node
752
752
753
753
754 class TestAstTransform2(unittest.TestCase):
754 class TestAstTransform2(unittest.TestCase):
755 def setUp(self):
755 def setUp(self):
756 self.intwrapper = IntegerWrapper()
756 self.intwrapper = IntegerWrapper()
757 ip.ast_transformers.append(self.intwrapper)
757 ip.ast_transformers.append(self.intwrapper)
758
758
759 self.calls = []
759 self.calls = []
760 def Integer(*args):
760 def Integer(*args):
761 self.calls.append(args)
761 self.calls.append(args)
762 return args
762 return args
763 ip.push({"Integer": Integer})
763 ip.push({"Integer": Integer})
764
764
765 def tearDown(self):
765 def tearDown(self):
766 ip.ast_transformers.remove(self.intwrapper)
766 ip.ast_transformers.remove(self.intwrapper)
767 del ip.user_ns['Integer']
767 del ip.user_ns['Integer']
768
768
769 def test_run_cell(self):
769 def test_run_cell(self):
770 ip.run_cell("n = 2")
770 ip.run_cell("n = 2")
771 self.assertEqual(self.calls, [(2,)])
771 self.assertEqual(self.calls, [(2,)])
772
772
773 # This shouldn't throw an error
773 # This shouldn't throw an error
774 ip.run_cell("o = 2.0")
774 ip.run_cell("o = 2.0")
775 self.assertEqual(ip.user_ns['o'], 2.0)
775 self.assertEqual(ip.user_ns['o'], 2.0)
776
776
777 def test_timeit(self):
777 def test_timeit(self):
778 called = set()
778 called = set()
779 def f(x):
779 def f(x):
780 called.add(x)
780 called.add(x)
781 ip.push({'f':f})
781 ip.push({'f':f})
782
782
783 with tt.AssertPrints("std. dev. of"):
783 with tt.AssertPrints("std. dev. of"):
784 ip.run_line_magic("timeit", "-n1 f(1)")
784 ip.run_line_magic("timeit", "-n1 f(1)")
785 self.assertEqual(called, {(1,)})
785 self.assertEqual(called, {(1,)})
786 called.clear()
786 called.clear()
787
787
788 with tt.AssertPrints("std. dev. of"):
788 with tt.AssertPrints("std. dev. of"):
789 ip.run_cell_magic("timeit", "-n1 f(2)", "f(3)")
789 ip.run_cell_magic("timeit", "-n1 f(2)", "f(3)")
790 self.assertEqual(called, {(2,), (3,)})
790 self.assertEqual(called, {(2,), (3,)})
791
791
792 class ErrorTransformer(ast.NodeTransformer):
792 class ErrorTransformer(ast.NodeTransformer):
793 """Throws an error when it sees a number."""
793 """Throws an error when it sees a number."""
794
794
795 # for Python 3.7 and earlier
795 # for Python 3.7 and earlier
796 def visit_Num(self, node):
796 def visit_Num(self, node):
797 raise ValueError("test")
797 raise ValueError("test")
798
798
799 # for Python 3.8+
799 # for Python 3.8+
800 def visit_Constant(self, node):
800 def visit_Constant(self, node):
801 if isinstance(node.value, int):
801 if isinstance(node.value, int):
802 return self.visit_Num(node)
802 return self.visit_Num(node)
803 return node
803 return node
804
804
805
805
806 class TestAstTransformError(unittest.TestCase):
806 class TestAstTransformError(unittest.TestCase):
807 def test_unregistering(self):
807 def test_unregistering(self):
808 err_transformer = ErrorTransformer()
808 err_transformer = ErrorTransformer()
809 ip.ast_transformers.append(err_transformer)
809 ip.ast_transformers.append(err_transformer)
810
810
811 with self.assertWarnsRegex(UserWarning, "It will be unregistered"):
811 with self.assertWarnsRegex(UserWarning, "It will be unregistered"):
812 ip.run_cell("1 + 2")
812 ip.run_cell("1 + 2")
813
813
814 # This should have been removed.
814 # This should have been removed.
815 nt.assert_not_in(err_transformer, ip.ast_transformers)
815 nt.assert_not_in(err_transformer, ip.ast_transformers)
816
816
817
817
818 class StringRejector(ast.NodeTransformer):
818 class StringRejector(ast.NodeTransformer):
819 """Throws an InputRejected when it sees a string literal.
819 """Throws an InputRejected when it sees a string literal.
820
820
821 Used to verify that NodeTransformers can signal that a piece of code should
821 Used to verify that NodeTransformers can signal that a piece of code should
822 not be executed by throwing an InputRejected.
822 not be executed by throwing an InputRejected.
823 """
823 """
824
824
825 #for python 3.7 and earlier
825 #for python 3.7 and earlier
826 def visit_Str(self, node):
826 def visit_Str(self, node):
827 raise InputRejected("test")
827 raise InputRejected("test")
828
828
829 # 3.8 only
829 # 3.8 only
830 def visit_Constant(self, node):
830 def visit_Constant(self, node):
831 if isinstance(node.value, str):
831 if isinstance(node.value, str):
832 raise InputRejected("test")
832 raise InputRejected("test")
833 return node
833 return node
834
834
835
835
836 class TestAstTransformInputRejection(unittest.TestCase):
836 class TestAstTransformInputRejection(unittest.TestCase):
837
837
838 def setUp(self):
838 def setUp(self):
839 self.transformer = StringRejector()
839 self.transformer = StringRejector()
840 ip.ast_transformers.append(self.transformer)
840 ip.ast_transformers.append(self.transformer)
841
841
842 def tearDown(self):
842 def tearDown(self):
843 ip.ast_transformers.remove(self.transformer)
843 ip.ast_transformers.remove(self.transformer)
844
844
845 def test_input_rejection(self):
845 def test_input_rejection(self):
846 """Check that NodeTransformers can reject input."""
846 """Check that NodeTransformers can reject input."""
847
847
848 expect_exception_tb = tt.AssertPrints("InputRejected: test")
848 expect_exception_tb = tt.AssertPrints("InputRejected: test")
849 expect_no_cell_output = tt.AssertNotPrints("'unsafe'", suppress=False)
849 expect_no_cell_output = tt.AssertNotPrints("'unsafe'", suppress=False)
850
850
851 # Run the same check twice to verify that the transformer is not
851 # Run the same check twice to verify that the transformer is not
852 # disabled after raising.
852 # disabled after raising.
853 with expect_exception_tb, expect_no_cell_output:
853 with expect_exception_tb, expect_no_cell_output:
854 ip.run_cell("'unsafe'")
854 ip.run_cell("'unsafe'")
855
855
856 with expect_exception_tb, expect_no_cell_output:
856 with expect_exception_tb, expect_no_cell_output:
857 res = ip.run_cell("'unsafe'")
857 res = ip.run_cell("'unsafe'")
858
858
859 self.assertIsInstance(res.error_before_exec, InputRejected)
859 self.assertIsInstance(res.error_before_exec, InputRejected)
860
860
861 def test__IPYTHON__():
861 def test__IPYTHON__():
862 # This shouldn't raise a NameError, that's all
862 # This shouldn't raise a NameError, that's all
863 __IPYTHON__
863 __IPYTHON__
864
864
865
865
866 class DummyRepr(object):
866 class DummyRepr(object):
867 def __repr__(self):
867 def __repr__(self):
868 return "DummyRepr"
868 return "DummyRepr"
869
869
870 def _repr_html_(self):
870 def _repr_html_(self):
871 return "<b>dummy</b>"
871 return "<b>dummy</b>"
872
872
873 def _repr_javascript_(self):
873 def _repr_javascript_(self):
874 return "console.log('hi');", {'key': 'value'}
874 return "console.log('hi');", {'key': 'value'}
875
875
876
876
877 def test_user_variables():
877 def test_user_variables():
878 # enable all formatters
878 # enable all formatters
879 ip.display_formatter.active_types = ip.display_formatter.format_types
879 ip.display_formatter.active_types = ip.display_formatter.format_types
880
880
881 ip.user_ns['dummy'] = d = DummyRepr()
881 ip.user_ns['dummy'] = d = DummyRepr()
882 keys = {'dummy', 'doesnotexist'}
882 keys = {'dummy', 'doesnotexist'}
883 r = ip.user_expressions({ key:key for key in keys})
883 r = ip.user_expressions({ key:key for key in keys})
884
884
885 nt.assert_equal(keys, set(r.keys()))
885 nt.assert_equal(keys, set(r.keys()))
886 dummy = r['dummy']
886 dummy = r['dummy']
887 nt.assert_equal({'status', 'data', 'metadata'}, set(dummy.keys()))
887 nt.assert_equal({'status', 'data', 'metadata'}, set(dummy.keys()))
888 nt.assert_equal(dummy['status'], 'ok')
888 nt.assert_equal(dummy['status'], 'ok')
889 data = dummy['data']
889 data = dummy['data']
890 metadata = dummy['metadata']
890 metadata = dummy['metadata']
891 nt.assert_equal(data.get('text/html'), d._repr_html_())
891 nt.assert_equal(data.get('text/html'), d._repr_html_())
892 js, jsmd = d._repr_javascript_()
892 js, jsmd = d._repr_javascript_()
893 nt.assert_equal(data.get('application/javascript'), js)
893 nt.assert_equal(data.get('application/javascript'), js)
894 nt.assert_equal(metadata.get('application/javascript'), jsmd)
894 nt.assert_equal(metadata.get('application/javascript'), jsmd)
895
895
896 dne = r['doesnotexist']
896 dne = r['doesnotexist']
897 nt.assert_equal(dne['status'], 'error')
897 nt.assert_equal(dne['status'], 'error')
898 nt.assert_equal(dne['ename'], 'NameError')
898 nt.assert_equal(dne['ename'], 'NameError')
899
899
900 # back to text only
900 # back to text only
901 ip.display_formatter.active_types = ['text/plain']
901 ip.display_formatter.active_types = ['text/plain']
902
902
903 def test_user_expression():
903 def test_user_expression():
904 # enable all formatters
904 # enable all formatters
905 ip.display_formatter.active_types = ip.display_formatter.format_types
905 ip.display_formatter.active_types = ip.display_formatter.format_types
906 query = {
906 query = {
907 'a' : '1 + 2',
907 'a' : '1 + 2',
908 'b' : '1/0',
908 'b' : '1/0',
909 }
909 }
910 r = ip.user_expressions(query)
910 r = ip.user_expressions(query)
911 import pprint
911 import pprint
912 pprint.pprint(r)
912 pprint.pprint(r)
913 nt.assert_equal(set(r.keys()), set(query.keys()))
913 nt.assert_equal(set(r.keys()), set(query.keys()))
914 a = r['a']
914 a = r['a']
915 nt.assert_equal({'status', 'data', 'metadata'}, set(a.keys()))
915 nt.assert_equal({'status', 'data', 'metadata'}, set(a.keys()))
916 nt.assert_equal(a['status'], 'ok')
916 nt.assert_equal(a['status'], 'ok')
917 data = a['data']
917 data = a['data']
918 metadata = a['metadata']
918 metadata = a['metadata']
919 nt.assert_equal(data.get('text/plain'), '3')
919 nt.assert_equal(data.get('text/plain'), '3')
920
920
921 b = r['b']
921 b = r['b']
922 nt.assert_equal(b['status'], 'error')
922 nt.assert_equal(b['status'], 'error')
923 nt.assert_equal(b['ename'], 'ZeroDivisionError')
923 nt.assert_equal(b['ename'], 'ZeroDivisionError')
924
924
925 # back to text only
925 # back to text only
926 ip.display_formatter.active_types = ['text/plain']
926 ip.display_formatter.active_types = ['text/plain']
927
927
928
928
929 class TestSyntaxErrorTransformer(unittest.TestCase):
929 class TestSyntaxErrorTransformer(unittest.TestCase):
930 """Check that SyntaxError raised by an input transformer is handled by run_cell()"""
930 """Check that SyntaxError raised by an input transformer is handled by run_cell()"""
931
931
932 @staticmethod
932 @staticmethod
933 def transformer(lines):
933 def transformer(lines):
934 for line in lines:
934 for line in lines:
935 pos = line.find('syntaxerror')
935 pos = line.find('syntaxerror')
936 if pos >= 0:
936 if pos >= 0:
937 e = SyntaxError('input contains "syntaxerror"')
937 e = SyntaxError('input contains "syntaxerror"')
938 e.text = line
938 e.text = line
939 e.offset = pos + 1
939 e.offset = pos + 1
940 raise e
940 raise e
941 return lines
941 return lines
942
942
943 def setUp(self):
943 def setUp(self):
944 ip.input_transformers_post.append(self.transformer)
944 ip.input_transformers_post.append(self.transformer)
945
945
946 def tearDown(self):
946 def tearDown(self):
947 ip.input_transformers_post.remove(self.transformer)
947 ip.input_transformers_post.remove(self.transformer)
948
948
949 def test_syntaxerror_input_transformer(self):
949 def test_syntaxerror_input_transformer(self):
950 with tt.AssertPrints('1234'):
950 with tt.AssertPrints('1234'):
951 ip.run_cell('1234')
951 ip.run_cell('1234')
952 with tt.AssertPrints('SyntaxError: invalid syntax'):
952 with tt.AssertPrints('SyntaxError: invalid syntax'):
953 ip.run_cell('1 2 3') # plain python syntax error
953 ip.run_cell('1 2 3') # plain python syntax error
954 with tt.AssertPrints('SyntaxError: input contains "syntaxerror"'):
954 with tt.AssertPrints('SyntaxError: input contains "syntaxerror"'):
955 ip.run_cell('2345 # syntaxerror') # input transformer syntax error
955 ip.run_cell('2345 # syntaxerror') # input transformer syntax error
956 with tt.AssertPrints('3456'):
956 with tt.AssertPrints('3456'):
957 ip.run_cell('3456')
957 ip.run_cell('3456')
958
958
959
959
960 class TestWarningSuppression(unittest.TestCase):
960 class TestWarningSuppression(unittest.TestCase):
961 def test_warning_suppression(self):
961 def test_warning_suppression(self):
962 ip.run_cell("import warnings")
962 ip.run_cell("import warnings")
963 try:
963 try:
964 with self.assertWarnsRegex(UserWarning, "asdf"):
964 with self.assertWarnsRegex(UserWarning, "asdf"):
965 ip.run_cell("warnings.warn('asdf')")
965 ip.run_cell("warnings.warn('asdf')")
966 # Here's the real test -- if we run that again, we should get the
966 # Here's the real test -- if we run that again, we should get the
967 # warning again. Traditionally, each warning was only issued once per
967 # warning again. Traditionally, each warning was only issued once per
968 # IPython session (approximately), even if the user typed in new and
968 # IPython session (approximately), even if the user typed in new and
969 # different code that should have also triggered the warning, leading
969 # different code that should have also triggered the warning, leading
970 # to much confusion.
970 # to much confusion.
971 with self.assertWarnsRegex(UserWarning, "asdf"):
971 with self.assertWarnsRegex(UserWarning, "asdf"):
972 ip.run_cell("warnings.warn('asdf')")
972 ip.run_cell("warnings.warn('asdf')")
973 finally:
973 finally:
974 ip.run_cell("del warnings")
974 ip.run_cell("del warnings")
975
975
976
976
977 def test_deprecation_warning(self):
977 def test_deprecation_warning(self):
978 ip.run_cell("""
978 ip.run_cell("""
979 import warnings
979 import warnings
980 def wrn():
980 def wrn():
981 warnings.warn(
981 warnings.warn(
982 "I AM A WARNING",
982 "I AM A WARNING",
983 DeprecationWarning
983 DeprecationWarning
984 )
984 )
985 """)
985 """)
986 try:
986 try:
987 with self.assertWarnsRegex(DeprecationWarning, "I AM A WARNING"):
987 with self.assertWarnsRegex(DeprecationWarning, "I AM A WARNING"):
988 ip.run_cell("wrn()")
988 ip.run_cell("wrn()")
989 finally:
989 finally:
990 ip.run_cell("del warnings")
990 ip.run_cell("del warnings")
991 ip.run_cell("del wrn")
991 ip.run_cell("del wrn")
992
992
993
993
994 class TestImportNoDeprecate(tt.TempFileMixin):
994 class TestImportNoDeprecate(tt.TempFileMixin):
995
995
996 def setUp(self):
996 def setUp(self):
997 """Make a valid python temp file."""
997 """Make a valid python temp file."""
998 self.mktmp("""
998 self.mktmp("""
999 import warnings
999 import warnings
1000 def wrn():
1000 def wrn():
1001 warnings.warn(
1001 warnings.warn(
1002 "I AM A WARNING",
1002 "I AM A WARNING",
1003 DeprecationWarning
1003 DeprecationWarning
1004 )
1004 )
1005 """)
1005 """)
1006 super().setUp()
1006 super().setUp()
1007
1007
1008 def test_no_dep(self):
1008 def test_no_dep(self):
1009 """
1009 """
1010 No deprecation warning should be raised from imported functions
1010 No deprecation warning should be raised from imported functions
1011 """
1011 """
1012 ip.run_cell("from {} import wrn".format(self.fname))
1012 ip.run_cell("from {} import wrn".format(self.fname))
1013
1013
1014 with tt.AssertNotPrints("I AM A WARNING"):
1014 with tt.AssertNotPrints("I AM A WARNING"):
1015 ip.run_cell("wrn()")
1015 ip.run_cell("wrn()")
1016 ip.run_cell("del wrn")
1016 ip.run_cell("del wrn")
1017
1017
1018
1018
1019 def test_custom_exc_count():
1019 def test_custom_exc_count():
1020 hook = mock.Mock(return_value=None)
1020 hook = mock.Mock(return_value=None)
1021 ip.set_custom_exc((SyntaxError,), hook)
1021 ip.set_custom_exc((SyntaxError,), hook)
1022 before = ip.execution_count
1022 before = ip.execution_count
1023 ip.run_cell("def foo()", store_history=True)
1023 ip.run_cell("def foo()", store_history=True)
1024 # restore default excepthook
1024 # restore default excepthook
1025 ip.set_custom_exc((), None)
1025 ip.set_custom_exc((), None)
1026 nt.assert_equal(hook.call_count, 1)
1026 nt.assert_equal(hook.call_count, 1)
1027 nt.assert_equal(ip.execution_count, before + 1)
1027 nt.assert_equal(ip.execution_count, before + 1)
1028
1028
1029
1029
1030 def test_run_cell_async():
1030 def test_run_cell_async():
1031 loop = asyncio.get_event_loop()
1031 loop = asyncio.get_event_loop()
1032 ip.run_cell("import asyncio")
1032 ip.run_cell("import asyncio")
1033 coro = ip.run_cell_async("await asyncio.sleep(0.01)\n5")
1033 coro = ip.run_cell_async("await asyncio.sleep(0.01)\n5")
1034 assert asyncio.iscoroutine(coro)
1034 assert asyncio.iscoroutine(coro)
1035 result = loop.run_until_complete(coro)
1035 result = loop.run_until_complete(coro)
1036 assert isinstance(result, interactiveshell.ExecutionResult)
1036 assert isinstance(result, interactiveshell.ExecutionResult)
1037 assert result.result == 5
1037 assert result.result == 5
1038
1038
1039
1039
1040 def test_run_cell_await():
1041 ip.run_cell("import asyncio")
1042 result = ip.run_cell("await asyncio.sleep(0.01); 10")
1043 assert ip.user_ns["_"] == 10
1044
1045
1046 def test_run_cell_asyncio_run():
1047 ip.run_cell("import asyncio")
1048 result = ip.run_cell("await asyncio.sleep(0.01); 1")
1049 assert ip.user_ns["_"] == 1
1050 result = ip.run_cell("asyncio.run(asyncio.sleep(0.01)); 2")
1051 assert ip.user_ns["_"] == 2
1052 result = ip.run_cell("await asyncio.sleep(0.01); 3")
1053 assert ip.user_ns["_"] == 3
1054
1055
1040 def test_should_run_async():
1056 def test_should_run_async():
1041 assert not ip.should_run_async("a = 5")
1057 assert not ip.should_run_async("a = 5")
1042 assert ip.should_run_async("await x")
1058 assert ip.should_run_async("await x")
1043 assert ip.should_run_async("import asyncio; await asyncio.sleep(1)")
1059 assert ip.should_run_async("import asyncio; await asyncio.sleep(1)")
1044
1060
1045
1061
1046 def test_set_custom_completer():
1062 def test_set_custom_completer():
1047 num_completers = len(ip.Completer.matchers)
1063 num_completers = len(ip.Completer.matchers)
1048
1064
1049 def foo(*args, **kwargs):
1065 def foo(*args, **kwargs):
1050 return "I'm a completer!"
1066 return "I'm a completer!"
1051
1067
1052 ip.set_custom_completer(foo, 0)
1068 ip.set_custom_completer(foo, 0)
1053
1069
1054 # check that we've really added a new completer
1070 # check that we've really added a new completer
1055 assert len(ip.Completer.matchers) == num_completers + 1
1071 assert len(ip.Completer.matchers) == num_completers + 1
1056
1072
1057 # check that the first completer is the function we defined
1073 # check that the first completer is the function we defined
1058 assert ip.Completer.matchers[0]() == "I'm a completer!"
1074 assert ip.Completer.matchers[0]() == "I'm a completer!"
1059
1075
1060 # clean up
1076 # clean up
1061 ip.Completer.custom_matchers.pop()
1077 ip.Completer.custom_matchers.pop()
@@ -1,645 +1,648 b''
1 """IPython terminal interface using prompt_toolkit"""
1 """IPython terminal interface using prompt_toolkit"""
2
2
3 import asyncio
3 import asyncio
4 import os
4 import os
5 import sys
5 import sys
6 import warnings
6 import warnings
7 from warnings import warn
7 from warnings import warn
8
8
9 from IPython.core.interactiveshell import InteractiveShell, InteractiveShellABC
9 from IPython.core.interactiveshell import InteractiveShell, InteractiveShellABC
10 from IPython.utils import io
10 from IPython.utils import io
11 from IPython.utils.py3compat import input
11 from IPython.utils.py3compat import input
12 from IPython.utils.terminal import toggle_set_term_title, set_term_title, restore_term_title
12 from IPython.utils.terminal import toggle_set_term_title, set_term_title, restore_term_title
13 from IPython.utils.process import abbrev_cwd
13 from IPython.utils.process import abbrev_cwd
14 from traitlets import (
14 from traitlets import (
15 Bool, Unicode, Dict, Integer, observe, Instance, Type, default, Enum, Union,
15 Bool, Unicode, Dict, Integer, observe, Instance, Type, default, Enum, Union,
16 Any, validate
16 Any, validate
17 )
17 )
18
18
19 from prompt_toolkit.enums import DEFAULT_BUFFER, EditingMode
19 from prompt_toolkit.enums import DEFAULT_BUFFER, EditingMode
20 from prompt_toolkit.filters import (HasFocus, Condition, IsDone)
20 from prompt_toolkit.filters import (HasFocus, Condition, IsDone)
21 from prompt_toolkit.formatted_text import PygmentsTokens
21 from prompt_toolkit.formatted_text import PygmentsTokens
22 from prompt_toolkit.history import InMemoryHistory
22 from prompt_toolkit.history import InMemoryHistory
23 from prompt_toolkit.layout.processors import ConditionalProcessor, HighlightMatchingBracketProcessor
23 from prompt_toolkit.layout.processors import ConditionalProcessor, HighlightMatchingBracketProcessor
24 from prompt_toolkit.output import ColorDepth
24 from prompt_toolkit.output import ColorDepth
25 from prompt_toolkit.patch_stdout import patch_stdout
25 from prompt_toolkit.patch_stdout import patch_stdout
26 from prompt_toolkit.shortcuts import PromptSession, CompleteStyle, print_formatted_text
26 from prompt_toolkit.shortcuts import PromptSession, CompleteStyle, print_formatted_text
27 from prompt_toolkit.styles import DynamicStyle, merge_styles
27 from prompt_toolkit.styles import DynamicStyle, merge_styles
28 from prompt_toolkit.styles.pygments import style_from_pygments_cls, style_from_pygments_dict
28 from prompt_toolkit.styles.pygments import style_from_pygments_cls, style_from_pygments_dict
29 from prompt_toolkit import __version__ as ptk_version
29 from prompt_toolkit import __version__ as ptk_version
30
30
31 from pygments.styles import get_style_by_name
31 from pygments.styles import get_style_by_name
32 from pygments.style import Style
32 from pygments.style import Style
33 from pygments.token import Token
33 from pygments.token import Token
34
34
35 from .debugger import TerminalPdb, Pdb
35 from .debugger import TerminalPdb, Pdb
36 from .magics import TerminalMagics
36 from .magics import TerminalMagics
37 from .pt_inputhooks import get_inputhook_name_and_func
37 from .pt_inputhooks import get_inputhook_name_and_func
38 from .prompts import Prompts, ClassicPrompts, RichPromptDisplayHook
38 from .prompts import Prompts, ClassicPrompts, RichPromptDisplayHook
39 from .ptutils import IPythonPTCompleter, IPythonPTLexer
39 from .ptutils import IPythonPTCompleter, IPythonPTLexer
40 from .shortcuts import create_ipython_shortcuts
40 from .shortcuts import create_ipython_shortcuts
41
41
42 DISPLAY_BANNER_DEPRECATED = object()
42 DISPLAY_BANNER_DEPRECATED = object()
43 PTK3 = ptk_version.startswith('3.')
43 PTK3 = ptk_version.startswith('3.')
44
44
45
45
46 class _NoStyle(Style): pass
46 class _NoStyle(Style): pass
47
47
48
48
49
49
50 _style_overrides_light_bg = {
50 _style_overrides_light_bg = {
51 Token.Prompt: '#0000ff',
51 Token.Prompt: '#0000ff',
52 Token.PromptNum: '#0000ee bold',
52 Token.PromptNum: '#0000ee bold',
53 Token.OutPrompt: '#cc0000',
53 Token.OutPrompt: '#cc0000',
54 Token.OutPromptNum: '#bb0000 bold',
54 Token.OutPromptNum: '#bb0000 bold',
55 }
55 }
56
56
57 _style_overrides_linux = {
57 _style_overrides_linux = {
58 Token.Prompt: '#00cc00',
58 Token.Prompt: '#00cc00',
59 Token.PromptNum: '#00bb00 bold',
59 Token.PromptNum: '#00bb00 bold',
60 Token.OutPrompt: '#cc0000',
60 Token.OutPrompt: '#cc0000',
61 Token.OutPromptNum: '#bb0000 bold',
61 Token.OutPromptNum: '#bb0000 bold',
62 }
62 }
63
63
64 def get_default_editor():
64 def get_default_editor():
65 try:
65 try:
66 return os.environ['EDITOR']
66 return os.environ['EDITOR']
67 except KeyError:
67 except KeyError:
68 pass
68 pass
69 except UnicodeError:
69 except UnicodeError:
70 warn("$EDITOR environment variable is not pure ASCII. Using platform "
70 warn("$EDITOR environment variable is not pure ASCII. Using platform "
71 "default editor.")
71 "default editor.")
72
72
73 if os.name == 'posix':
73 if os.name == 'posix':
74 return 'vi' # the only one guaranteed to be there!
74 return 'vi' # the only one guaranteed to be there!
75 else:
75 else:
76 return 'notepad' # same in Windows!
76 return 'notepad' # same in Windows!
77
77
78 # conservatively check for tty
78 # conservatively check for tty
79 # overridden streams can result in things like:
79 # overridden streams can result in things like:
80 # - sys.stdin = None
80 # - sys.stdin = None
81 # - no isatty method
81 # - no isatty method
82 for _name in ('stdin', 'stdout', 'stderr'):
82 for _name in ('stdin', 'stdout', 'stderr'):
83 _stream = getattr(sys, _name)
83 _stream = getattr(sys, _name)
84 if not _stream or not hasattr(_stream, 'isatty') or not _stream.isatty():
84 if not _stream or not hasattr(_stream, 'isatty') or not _stream.isatty():
85 _is_tty = False
85 _is_tty = False
86 break
86 break
87 else:
87 else:
88 _is_tty = True
88 _is_tty = True
89
89
90
90
91 _use_simple_prompt = ('IPY_TEST_SIMPLE_PROMPT' in os.environ) or (not _is_tty)
91 _use_simple_prompt = ('IPY_TEST_SIMPLE_PROMPT' in os.environ) or (not _is_tty)
92
92
93 def black_reformat_handler(text_before_cursor):
93 def black_reformat_handler(text_before_cursor):
94 import black
94 import black
95 formatted_text = black.format_str(text_before_cursor, mode=black.FileMode())
95 formatted_text = black.format_str(text_before_cursor, mode=black.FileMode())
96 if not text_before_cursor.endswith('\n') and formatted_text.endswith('\n'):
96 if not text_before_cursor.endswith('\n') and formatted_text.endswith('\n'):
97 formatted_text = formatted_text[:-1]
97 formatted_text = formatted_text[:-1]
98 return formatted_text
98 return formatted_text
99
99
100
100
101 class TerminalInteractiveShell(InteractiveShell):
101 class TerminalInteractiveShell(InteractiveShell):
102 mime_renderers = Dict().tag(config=True)
102 mime_renderers = Dict().tag(config=True)
103
103
104 space_for_menu = Integer(6, help='Number of line at the bottom of the screen '
104 space_for_menu = Integer(6, help='Number of line at the bottom of the screen '
105 'to reserve for the tab completion menu, '
105 'to reserve for the tab completion menu, '
106 'search history, ...etc, the height of '
106 'search history, ...etc, the height of '
107 'these menus will at most this value. '
107 'these menus will at most this value. '
108 'Increase it is you prefer long and skinny '
108 'Increase it is you prefer long and skinny '
109 'menus, decrease for short and wide.'
109 'menus, decrease for short and wide.'
110 ).tag(config=True)
110 ).tag(config=True)
111
111
112 pt_app = None
112 pt_app = None
113 debugger_history = None
113 debugger_history = None
114
114
115 simple_prompt = Bool(_use_simple_prompt,
115 simple_prompt = Bool(_use_simple_prompt,
116 help="""Use `raw_input` for the REPL, without completion and prompt colors.
116 help="""Use `raw_input` for the REPL, without completion and prompt colors.
117
117
118 Useful when controlling IPython as a subprocess, and piping STDIN/OUT/ERR. Known usage are:
118 Useful when controlling IPython as a subprocess, and piping STDIN/OUT/ERR. Known usage are:
119 IPython own testing machinery, and emacs inferior-shell integration through elpy.
119 IPython own testing machinery, and emacs inferior-shell integration through elpy.
120
120
121 This mode default to `True` if the `IPY_TEST_SIMPLE_PROMPT`
121 This mode default to `True` if the `IPY_TEST_SIMPLE_PROMPT`
122 environment variable is set, or the current terminal is not a tty."""
122 environment variable is set, or the current terminal is not a tty."""
123 ).tag(config=True)
123 ).tag(config=True)
124
124
125 @property
125 @property
126 def debugger_cls(self):
126 def debugger_cls(self):
127 return Pdb if self.simple_prompt else TerminalPdb
127 return Pdb if self.simple_prompt else TerminalPdb
128
128
129 confirm_exit = Bool(True,
129 confirm_exit = Bool(True,
130 help="""
130 help="""
131 Set to confirm when you try to exit IPython with an EOF (Control-D
131 Set to confirm when you try to exit IPython with an EOF (Control-D
132 in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit',
132 in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit',
133 you can force a direct exit without any confirmation.""",
133 you can force a direct exit without any confirmation.""",
134 ).tag(config=True)
134 ).tag(config=True)
135
135
136 editing_mode = Unicode('emacs',
136 editing_mode = Unicode('emacs',
137 help="Shortcut style to use at the prompt. 'vi' or 'emacs'.",
137 help="Shortcut style to use at the prompt. 'vi' or 'emacs'.",
138 ).tag(config=True)
138 ).tag(config=True)
139
139
140 autoformatter = Unicode(None,
140 autoformatter = Unicode(None,
141 help="Autoformatter to reformat Terminal code. Can be `'black'` or `None`",
141 help="Autoformatter to reformat Terminal code. Can be `'black'` or `None`",
142 allow_none=True
142 allow_none=True
143 ).tag(config=True)
143 ).tag(config=True)
144
144
145 mouse_support = Bool(False,
145 mouse_support = Bool(False,
146 help="Enable mouse support in the prompt\n(Note: prevents selecting text with the mouse)"
146 help="Enable mouse support in the prompt\n(Note: prevents selecting text with the mouse)"
147 ).tag(config=True)
147 ).tag(config=True)
148
148
149 # We don't load the list of styles for the help string, because loading
149 # We don't load the list of styles for the help string, because loading
150 # Pygments plugins takes time and can cause unexpected errors.
150 # Pygments plugins takes time and can cause unexpected errors.
151 highlighting_style = Union([Unicode('legacy'), Type(klass=Style)],
151 highlighting_style = Union([Unicode('legacy'), Type(klass=Style)],
152 help="""The name or class of a Pygments style to use for syntax
152 help="""The name or class of a Pygments style to use for syntax
153 highlighting. To see available styles, run `pygmentize -L styles`."""
153 highlighting. To see available styles, run `pygmentize -L styles`."""
154 ).tag(config=True)
154 ).tag(config=True)
155
155
156 @validate('editing_mode')
156 @validate('editing_mode')
157 def _validate_editing_mode(self, proposal):
157 def _validate_editing_mode(self, proposal):
158 if proposal['value'].lower() == 'vim':
158 if proposal['value'].lower() == 'vim':
159 proposal['value']= 'vi'
159 proposal['value']= 'vi'
160 elif proposal['value'].lower() == 'default':
160 elif proposal['value'].lower() == 'default':
161 proposal['value']= 'emacs'
161 proposal['value']= 'emacs'
162
162
163 if hasattr(EditingMode, proposal['value'].upper()):
163 if hasattr(EditingMode, proposal['value'].upper()):
164 return proposal['value'].lower()
164 return proposal['value'].lower()
165
165
166 return self.editing_mode
166 return self.editing_mode
167
167
168
168
169 @observe('editing_mode')
169 @observe('editing_mode')
170 def _editing_mode(self, change):
170 def _editing_mode(self, change):
171 if self.pt_app:
171 if self.pt_app:
172 self.pt_app.editing_mode = getattr(EditingMode, change.new.upper())
172 self.pt_app.editing_mode = getattr(EditingMode, change.new.upper())
173
173
174 @observe('autoformatter')
174 @observe('autoformatter')
175 def _autoformatter_changed(self, change):
175 def _autoformatter_changed(self, change):
176 formatter = change.new
176 formatter = change.new
177 if formatter is None:
177 if formatter is None:
178 self.reformat_handler = lambda x:x
178 self.reformat_handler = lambda x:x
179 elif formatter == 'black':
179 elif formatter == 'black':
180 self.reformat_handler = black_reformat_handler
180 self.reformat_handler = black_reformat_handler
181 else:
181 else:
182 raise ValueError
182 raise ValueError
183
183
184 @observe('highlighting_style')
184 @observe('highlighting_style')
185 @observe('colors')
185 @observe('colors')
186 def _highlighting_style_changed(self, change):
186 def _highlighting_style_changed(self, change):
187 self.refresh_style()
187 self.refresh_style()
188
188
189 def refresh_style(self):
189 def refresh_style(self):
190 self._style = self._make_style_from_name_or_cls(self.highlighting_style)
190 self._style = self._make_style_from_name_or_cls(self.highlighting_style)
191
191
192
192
193 highlighting_style_overrides = Dict(
193 highlighting_style_overrides = Dict(
194 help="Override highlighting format for specific tokens"
194 help="Override highlighting format for specific tokens"
195 ).tag(config=True)
195 ).tag(config=True)
196
196
197 true_color = Bool(False,
197 true_color = Bool(False,
198 help=("Use 24bit colors instead of 256 colors in prompt highlighting. "
198 help=("Use 24bit colors instead of 256 colors in prompt highlighting. "
199 "If your terminal supports true color, the following command "
199 "If your terminal supports true color, the following command "
200 "should print 'TRUECOLOR' in orange: "
200 "should print 'TRUECOLOR' in orange: "
201 "printf \"\\x1b[38;2;255;100;0mTRUECOLOR\\x1b[0m\\n\"")
201 "printf \"\\x1b[38;2;255;100;0mTRUECOLOR\\x1b[0m\\n\"")
202 ).tag(config=True)
202 ).tag(config=True)
203
203
204 editor = Unicode(get_default_editor(),
204 editor = Unicode(get_default_editor(),
205 help="Set the editor used by IPython (default to $EDITOR/vi/notepad)."
205 help="Set the editor used by IPython (default to $EDITOR/vi/notepad)."
206 ).tag(config=True)
206 ).tag(config=True)
207
207
208 prompts_class = Type(Prompts, help='Class used to generate Prompt token for prompt_toolkit').tag(config=True)
208 prompts_class = Type(Prompts, help='Class used to generate Prompt token for prompt_toolkit').tag(config=True)
209
209
210 prompts = Instance(Prompts)
210 prompts = Instance(Prompts)
211
211
212 @default('prompts')
212 @default('prompts')
213 def _prompts_default(self):
213 def _prompts_default(self):
214 return self.prompts_class(self)
214 return self.prompts_class(self)
215
215
216 # @observe('prompts')
216 # @observe('prompts')
217 # def _(self, change):
217 # def _(self, change):
218 # self._update_layout()
218 # self._update_layout()
219
219
220 @default('displayhook_class')
220 @default('displayhook_class')
221 def _displayhook_class_default(self):
221 def _displayhook_class_default(self):
222 return RichPromptDisplayHook
222 return RichPromptDisplayHook
223
223
224 term_title = Bool(True,
224 term_title = Bool(True,
225 help="Automatically set the terminal title"
225 help="Automatically set the terminal title"
226 ).tag(config=True)
226 ).tag(config=True)
227
227
228 term_title_format = Unicode("IPython: {cwd}",
228 term_title_format = Unicode("IPython: {cwd}",
229 help="Customize the terminal title format. This is a python format string. " +
229 help="Customize the terminal title format. This is a python format string. " +
230 "Available substitutions are: {cwd}."
230 "Available substitutions are: {cwd}."
231 ).tag(config=True)
231 ).tag(config=True)
232
232
233 display_completions = Enum(('column', 'multicolumn','readlinelike'),
233 display_completions = Enum(('column', 'multicolumn','readlinelike'),
234 help= ( "Options for displaying tab completions, 'column', 'multicolumn', and "
234 help= ( "Options for displaying tab completions, 'column', 'multicolumn', and "
235 "'readlinelike'. These options are for `prompt_toolkit`, see "
235 "'readlinelike'. These options are for `prompt_toolkit`, see "
236 "`prompt_toolkit` documentation for more information."
236 "`prompt_toolkit` documentation for more information."
237 ),
237 ),
238 default_value='multicolumn').tag(config=True)
238 default_value='multicolumn').tag(config=True)
239
239
240 highlight_matching_brackets = Bool(True,
240 highlight_matching_brackets = Bool(True,
241 help="Highlight matching brackets.",
241 help="Highlight matching brackets.",
242 ).tag(config=True)
242 ).tag(config=True)
243
243
244 extra_open_editor_shortcuts = Bool(False,
244 extra_open_editor_shortcuts = Bool(False,
245 help="Enable vi (v) or Emacs (C-X C-E) shortcuts to open an external editor. "
245 help="Enable vi (v) or Emacs (C-X C-E) shortcuts to open an external editor. "
246 "This is in addition to the F2 binding, which is always enabled."
246 "This is in addition to the F2 binding, which is always enabled."
247 ).tag(config=True)
247 ).tag(config=True)
248
248
249 handle_return = Any(None,
249 handle_return = Any(None,
250 help="Provide an alternative handler to be called when the user presses "
250 help="Provide an alternative handler to be called when the user presses "
251 "Return. This is an advanced option intended for debugging, which "
251 "Return. This is an advanced option intended for debugging, which "
252 "may be changed or removed in later releases."
252 "may be changed or removed in later releases."
253 ).tag(config=True)
253 ).tag(config=True)
254
254
255 enable_history_search = Bool(True,
255 enable_history_search = Bool(True,
256 help="Allows to enable/disable the prompt toolkit history search"
256 help="Allows to enable/disable the prompt toolkit history search"
257 ).tag(config=True)
257 ).tag(config=True)
258
258
259 prompt_includes_vi_mode = Bool(True,
259 prompt_includes_vi_mode = Bool(True,
260 help="Display the current vi mode (when using vi editing mode)."
260 help="Display the current vi mode (when using vi editing mode)."
261 ).tag(config=True)
261 ).tag(config=True)
262
262
263 @observe('term_title')
263 @observe('term_title')
264 def init_term_title(self, change=None):
264 def init_term_title(self, change=None):
265 # Enable or disable the terminal title.
265 # Enable or disable the terminal title.
266 if self.term_title:
266 if self.term_title:
267 toggle_set_term_title(True)
267 toggle_set_term_title(True)
268 set_term_title(self.term_title_format.format(cwd=abbrev_cwd()))
268 set_term_title(self.term_title_format.format(cwd=abbrev_cwd()))
269 else:
269 else:
270 toggle_set_term_title(False)
270 toggle_set_term_title(False)
271
271
272 def restore_term_title(self):
272 def restore_term_title(self):
273 if self.term_title:
273 if self.term_title:
274 restore_term_title()
274 restore_term_title()
275
275
276 def init_display_formatter(self):
276 def init_display_formatter(self):
277 super(TerminalInteractiveShell, self).init_display_formatter()
277 super(TerminalInteractiveShell, self).init_display_formatter()
278 # terminal only supports plain text
278 # terminal only supports plain text
279 self.display_formatter.active_types = ['text/plain']
279 self.display_formatter.active_types = ['text/plain']
280 # disable `_ipython_display_`
280 # disable `_ipython_display_`
281 self.display_formatter.ipython_display_formatter.enabled = False
281 self.display_formatter.ipython_display_formatter.enabled = False
282
282
283 def init_prompt_toolkit_cli(self):
283 def init_prompt_toolkit_cli(self):
284 if self.simple_prompt:
284 if self.simple_prompt:
285 # Fall back to plain non-interactive output for tests.
285 # Fall back to plain non-interactive output for tests.
286 # This is very limited.
286 # This is very limited.
287 def prompt():
287 def prompt():
288 prompt_text = "".join(x[1] for x in self.prompts.in_prompt_tokens())
288 prompt_text = "".join(x[1] for x in self.prompts.in_prompt_tokens())
289 lines = [input(prompt_text)]
289 lines = [input(prompt_text)]
290 prompt_continuation = "".join(x[1] for x in self.prompts.continuation_prompt_tokens())
290 prompt_continuation = "".join(x[1] for x in self.prompts.continuation_prompt_tokens())
291 while self.check_complete('\n'.join(lines))[0] == 'incomplete':
291 while self.check_complete('\n'.join(lines))[0] == 'incomplete':
292 lines.append( input(prompt_continuation) )
292 lines.append( input(prompt_continuation) )
293 return '\n'.join(lines)
293 return '\n'.join(lines)
294 self.prompt_for_code = prompt
294 self.prompt_for_code = prompt
295 return
295 return
296
296
297 # Set up keyboard shortcuts
297 # Set up keyboard shortcuts
298 key_bindings = create_ipython_shortcuts(self)
298 key_bindings = create_ipython_shortcuts(self)
299
299
300 # Pre-populate history from IPython's history database
300 # Pre-populate history from IPython's history database
301 history = InMemoryHistory()
301 history = InMemoryHistory()
302 last_cell = u""
302 last_cell = u""
303 for __, ___, cell in self.history_manager.get_tail(self.history_load_length,
303 for __, ___, cell in self.history_manager.get_tail(self.history_load_length,
304 include_latest=True):
304 include_latest=True):
305 # Ignore blank lines and consecutive duplicates
305 # Ignore blank lines and consecutive duplicates
306 cell = cell.rstrip()
306 cell = cell.rstrip()
307 if cell and (cell != last_cell):
307 if cell and (cell != last_cell):
308 history.append_string(cell)
308 history.append_string(cell)
309 last_cell = cell
309 last_cell = cell
310
310
311 self._style = self._make_style_from_name_or_cls(self.highlighting_style)
311 self._style = self._make_style_from_name_or_cls(self.highlighting_style)
312 self.style = DynamicStyle(lambda: self._style)
312 self.style = DynamicStyle(lambda: self._style)
313
313
314 editing_mode = getattr(EditingMode, self.editing_mode.upper())
314 editing_mode = getattr(EditingMode, self.editing_mode.upper())
315
315
316 self.pt_loop = asyncio.new_event_loop()
316 self.pt_loop = asyncio.new_event_loop()
317 self.pt_app = PromptSession(
317 self.pt_app = PromptSession(
318 editing_mode=editing_mode,
318 editing_mode=editing_mode,
319 key_bindings=key_bindings,
319 key_bindings=key_bindings,
320 history=history,
320 history=history,
321 completer=IPythonPTCompleter(shell=self),
321 completer=IPythonPTCompleter(shell=self),
322 enable_history_search = self.enable_history_search,
322 enable_history_search = self.enable_history_search,
323 style=self.style,
323 style=self.style,
324 include_default_pygments_style=False,
324 include_default_pygments_style=False,
325 mouse_support=self.mouse_support,
325 mouse_support=self.mouse_support,
326 enable_open_in_editor=self.extra_open_editor_shortcuts,
326 enable_open_in_editor=self.extra_open_editor_shortcuts,
327 color_depth=self.color_depth,
327 color_depth=self.color_depth,
328 tempfile_suffix=".py",
328 tempfile_suffix=".py",
329 **self._extra_prompt_options())
329 **self._extra_prompt_options())
330
330
331 def _make_style_from_name_or_cls(self, name_or_cls):
331 def _make_style_from_name_or_cls(self, name_or_cls):
332 """
332 """
333 Small wrapper that make an IPython compatible style from a style name
333 Small wrapper that make an IPython compatible style from a style name
334
334
335 We need that to add style for prompt ... etc.
335 We need that to add style for prompt ... etc.
336 """
336 """
337 style_overrides = {}
337 style_overrides = {}
338 if name_or_cls == 'legacy':
338 if name_or_cls == 'legacy':
339 legacy = self.colors.lower()
339 legacy = self.colors.lower()
340 if legacy == 'linux':
340 if legacy == 'linux':
341 style_cls = get_style_by_name('monokai')
341 style_cls = get_style_by_name('monokai')
342 style_overrides = _style_overrides_linux
342 style_overrides = _style_overrides_linux
343 elif legacy == 'lightbg':
343 elif legacy == 'lightbg':
344 style_overrides = _style_overrides_light_bg
344 style_overrides = _style_overrides_light_bg
345 style_cls = get_style_by_name('pastie')
345 style_cls = get_style_by_name('pastie')
346 elif legacy == 'neutral':
346 elif legacy == 'neutral':
347 # The default theme needs to be visible on both a dark background
347 # The default theme needs to be visible on both a dark background
348 # and a light background, because we can't tell what the terminal
348 # and a light background, because we can't tell what the terminal
349 # looks like. These tweaks to the default theme help with that.
349 # looks like. These tweaks to the default theme help with that.
350 style_cls = get_style_by_name('default')
350 style_cls = get_style_by_name('default')
351 style_overrides.update({
351 style_overrides.update({
352 Token.Number: '#007700',
352 Token.Number: '#007700',
353 Token.Operator: 'noinherit',
353 Token.Operator: 'noinherit',
354 Token.String: '#BB6622',
354 Token.String: '#BB6622',
355 Token.Name.Function: '#2080D0',
355 Token.Name.Function: '#2080D0',
356 Token.Name.Class: 'bold #2080D0',
356 Token.Name.Class: 'bold #2080D0',
357 Token.Name.Namespace: 'bold #2080D0',
357 Token.Name.Namespace: 'bold #2080D0',
358 Token.Name.Variable.Magic: '#ansiblue',
358 Token.Name.Variable.Magic: '#ansiblue',
359 Token.Prompt: '#009900',
359 Token.Prompt: '#009900',
360 Token.PromptNum: '#ansibrightgreen bold',
360 Token.PromptNum: '#ansibrightgreen bold',
361 Token.OutPrompt: '#990000',
361 Token.OutPrompt: '#990000',
362 Token.OutPromptNum: '#ansibrightred bold',
362 Token.OutPromptNum: '#ansibrightred bold',
363 })
363 })
364
364
365 # Hack: Due to limited color support on the Windows console
365 # Hack: Due to limited color support on the Windows console
366 # the prompt colors will be wrong without this
366 # the prompt colors will be wrong without this
367 if os.name == 'nt':
367 if os.name == 'nt':
368 style_overrides.update({
368 style_overrides.update({
369 Token.Prompt: '#ansidarkgreen',
369 Token.Prompt: '#ansidarkgreen',
370 Token.PromptNum: '#ansigreen bold',
370 Token.PromptNum: '#ansigreen bold',
371 Token.OutPrompt: '#ansidarkred',
371 Token.OutPrompt: '#ansidarkred',
372 Token.OutPromptNum: '#ansired bold',
372 Token.OutPromptNum: '#ansired bold',
373 })
373 })
374 elif legacy =='nocolor':
374 elif legacy =='nocolor':
375 style_cls=_NoStyle
375 style_cls=_NoStyle
376 style_overrides = {}
376 style_overrides = {}
377 else :
377 else :
378 raise ValueError('Got unknown colors: ', legacy)
378 raise ValueError('Got unknown colors: ', legacy)
379 else :
379 else :
380 if isinstance(name_or_cls, str):
380 if isinstance(name_or_cls, str):
381 style_cls = get_style_by_name(name_or_cls)
381 style_cls = get_style_by_name(name_or_cls)
382 else:
382 else:
383 style_cls = name_or_cls
383 style_cls = name_or_cls
384 style_overrides = {
384 style_overrides = {
385 Token.Prompt: '#009900',
385 Token.Prompt: '#009900',
386 Token.PromptNum: '#ansibrightgreen bold',
386 Token.PromptNum: '#ansibrightgreen bold',
387 Token.OutPrompt: '#990000',
387 Token.OutPrompt: '#990000',
388 Token.OutPromptNum: '#ansibrightred bold',
388 Token.OutPromptNum: '#ansibrightred bold',
389 }
389 }
390 style_overrides.update(self.highlighting_style_overrides)
390 style_overrides.update(self.highlighting_style_overrides)
391 style = merge_styles([
391 style = merge_styles([
392 style_from_pygments_cls(style_cls),
392 style_from_pygments_cls(style_cls),
393 style_from_pygments_dict(style_overrides),
393 style_from_pygments_dict(style_overrides),
394 ])
394 ])
395
395
396 return style
396 return style
397
397
398 @property
398 @property
399 def pt_complete_style(self):
399 def pt_complete_style(self):
400 return {
400 return {
401 'multicolumn': CompleteStyle.MULTI_COLUMN,
401 'multicolumn': CompleteStyle.MULTI_COLUMN,
402 'column': CompleteStyle.COLUMN,
402 'column': CompleteStyle.COLUMN,
403 'readlinelike': CompleteStyle.READLINE_LIKE,
403 'readlinelike': CompleteStyle.READLINE_LIKE,
404 }[self.display_completions]
404 }[self.display_completions]
405
405
406 @property
406 @property
407 def color_depth(self):
407 def color_depth(self):
408 return (ColorDepth.TRUE_COLOR if self.true_color else None)
408 return (ColorDepth.TRUE_COLOR if self.true_color else None)
409
409
410 def _extra_prompt_options(self):
410 def _extra_prompt_options(self):
411 """
411 """
412 Return the current layout option for the current Terminal InteractiveShell
412 Return the current layout option for the current Terminal InteractiveShell
413 """
413 """
414 def get_message():
414 def get_message():
415 return PygmentsTokens(self.prompts.in_prompt_tokens())
415 return PygmentsTokens(self.prompts.in_prompt_tokens())
416
416
417 if self.editing_mode == 'emacs':
417 if self.editing_mode == 'emacs':
418 # with emacs mode the prompt is (usually) static, so we call only
418 # with emacs mode the prompt is (usually) static, so we call only
419 # the function once. With VI mode it can toggle between [ins] and
419 # the function once. With VI mode it can toggle between [ins] and
420 # [nor] so we can't precompute.
420 # [nor] so we can't precompute.
421 # here I'm going to favor the default keybinding which almost
421 # here I'm going to favor the default keybinding which almost
422 # everybody uses to decrease CPU usage.
422 # everybody uses to decrease CPU usage.
423 # if we have issues with users with custom Prompts we can see how to
423 # if we have issues with users with custom Prompts we can see how to
424 # work around this.
424 # work around this.
425 get_message = get_message()
425 get_message = get_message()
426
426
427 options = {
427 options = {
428 'complete_in_thread': False,
428 'complete_in_thread': False,
429 'lexer':IPythonPTLexer(),
429 'lexer':IPythonPTLexer(),
430 'reserve_space_for_menu':self.space_for_menu,
430 'reserve_space_for_menu':self.space_for_menu,
431 'message': get_message,
431 'message': get_message,
432 'prompt_continuation': (
432 'prompt_continuation': (
433 lambda width, lineno, is_soft_wrap:
433 lambda width, lineno, is_soft_wrap:
434 PygmentsTokens(self.prompts.continuation_prompt_tokens(width))),
434 PygmentsTokens(self.prompts.continuation_prompt_tokens(width))),
435 'multiline': True,
435 'multiline': True,
436 'complete_style': self.pt_complete_style,
436 'complete_style': self.pt_complete_style,
437
437
438 # Highlight matching brackets, but only when this setting is
438 # Highlight matching brackets, but only when this setting is
439 # enabled, and only when the DEFAULT_BUFFER has the focus.
439 # enabled, and only when the DEFAULT_BUFFER has the focus.
440 'input_processors': [ConditionalProcessor(
440 'input_processors': [ConditionalProcessor(
441 processor=HighlightMatchingBracketProcessor(chars='[](){}'),
441 processor=HighlightMatchingBracketProcessor(chars='[](){}'),
442 filter=HasFocus(DEFAULT_BUFFER) & ~IsDone() &
442 filter=HasFocus(DEFAULT_BUFFER) & ~IsDone() &
443 Condition(lambda: self.highlight_matching_brackets))],
443 Condition(lambda: self.highlight_matching_brackets))],
444 }
444 }
445 if not PTK3:
445 if not PTK3:
446 options['inputhook'] = self.inputhook
446 options['inputhook'] = self.inputhook
447
447
448 return options
448 return options
449
449
450 def prompt_for_code(self):
450 def prompt_for_code(self):
451 if self.rl_next_input:
451 if self.rl_next_input:
452 default = self.rl_next_input
452 default = self.rl_next_input
453 self.rl_next_input = None
453 self.rl_next_input = None
454 else:
454 else:
455 default = ''
455 default = ''
456
456
457 # In order to make sure that asyncio code written in the
457 # In order to make sure that asyncio code written in the
458 # interactive shell doesn't interfere with the prompt, we run the
458 # interactive shell doesn't interfere with the prompt, we run the
459 # prompt in a different event loop.
459 # prompt in a different event loop.
460 # If we don't do this, people could spawn coroutine with a
460 # If we don't do this, people could spawn coroutine with a
461 # while/true inside which will freeze the prompt.
461 # while/true inside which will freeze the prompt.
462
462
463 policy = asyncio.get_event_loop_policy()
463 try:
464 try:
464 old_loop = asyncio.get_running_loop()
465 old_loop = policy.get_event_loop()
465 except RuntimeError:
466 except RuntimeError:
466 # This happens when the user used `asyncio.run()`.
467 # This happens when the the event loop is closed,
468 # e.g. by calling `asyncio.run()`.
467 old_loop = None
469 old_loop = None
468
470
469 asyncio.set_event_loop(self.pt_loop)
471 policy.set_event_loop(self.pt_loop)
470 try:
472 try:
471 with patch_stdout(raw=True):
473 with patch_stdout(raw=True):
472 text = self.pt_app.prompt(
474 text = self.pt_app.prompt(
473 default=default,
475 default=default,
474 **self._extra_prompt_options())
476 **self._extra_prompt_options())
475 finally:
477 finally:
476 # Restore the original event loop.
478 # Restore the original event loop.
477 asyncio.set_event_loop(old_loop)
479 if old_loop is not None:
480 policy.set_event_loop(old_loop)
478
481
479 return text
482 return text
480
483
481 def enable_win_unicode_console(self):
484 def enable_win_unicode_console(self):
482 # Since IPython 7.10 doesn't support python < 3.6 and PEP 528, Python uses the unicode APIs for the Windows
485 # Since IPython 7.10 doesn't support python < 3.6 and PEP 528, Python uses the unicode APIs for the Windows
483 # console by default, so WUC shouldn't be needed.
486 # console by default, so WUC shouldn't be needed.
484 from warnings import warn
487 from warnings import warn
485 warn("`enable_win_unicode_console` is deprecated since IPython 7.10, does not do anything and will be removed in the future",
488 warn("`enable_win_unicode_console` is deprecated since IPython 7.10, does not do anything and will be removed in the future",
486 DeprecationWarning,
489 DeprecationWarning,
487 stacklevel=2)
490 stacklevel=2)
488
491
489 def init_io(self):
492 def init_io(self):
490 if sys.platform not in {'win32', 'cli'}:
493 if sys.platform not in {'win32', 'cli'}:
491 return
494 return
492
495
493 import colorama
496 import colorama
494 colorama.init()
497 colorama.init()
495
498
496 # For some reason we make these wrappers around stdout/stderr.
499 # For some reason we make these wrappers around stdout/stderr.
497 # For now, we need to reset them so all output gets coloured.
500 # For now, we need to reset them so all output gets coloured.
498 # https://github.com/ipython/ipython/issues/8669
501 # https://github.com/ipython/ipython/issues/8669
499 # io.std* are deprecated, but don't show our own deprecation warnings
502 # io.std* are deprecated, but don't show our own deprecation warnings
500 # during initialization of the deprecated API.
503 # during initialization of the deprecated API.
501 with warnings.catch_warnings():
504 with warnings.catch_warnings():
502 warnings.simplefilter('ignore', DeprecationWarning)
505 warnings.simplefilter('ignore', DeprecationWarning)
503 io.stdout = io.IOStream(sys.stdout)
506 io.stdout = io.IOStream(sys.stdout)
504 io.stderr = io.IOStream(sys.stderr)
507 io.stderr = io.IOStream(sys.stderr)
505
508
506 def init_magics(self):
509 def init_magics(self):
507 super(TerminalInteractiveShell, self).init_magics()
510 super(TerminalInteractiveShell, self).init_magics()
508 self.register_magics(TerminalMagics)
511 self.register_magics(TerminalMagics)
509
512
510 def init_alias(self):
513 def init_alias(self):
511 # The parent class defines aliases that can be safely used with any
514 # The parent class defines aliases that can be safely used with any
512 # frontend.
515 # frontend.
513 super(TerminalInteractiveShell, self).init_alias()
516 super(TerminalInteractiveShell, self).init_alias()
514
517
515 # Now define aliases that only make sense on the terminal, because they
518 # Now define aliases that only make sense on the terminal, because they
516 # need direct access to the console in a way that we can't emulate in
519 # need direct access to the console in a way that we can't emulate in
517 # GUI or web frontend
520 # GUI or web frontend
518 if os.name == 'posix':
521 if os.name == 'posix':
519 for cmd in ('clear', 'more', 'less', 'man'):
522 for cmd in ('clear', 'more', 'less', 'man'):
520 self.alias_manager.soft_define_alias(cmd, cmd)
523 self.alias_manager.soft_define_alias(cmd, cmd)
521
524
522
525
523 def __init__(self, *args, **kwargs):
526 def __init__(self, *args, **kwargs):
524 super(TerminalInteractiveShell, self).__init__(*args, **kwargs)
527 super(TerminalInteractiveShell, self).__init__(*args, **kwargs)
525 self.init_prompt_toolkit_cli()
528 self.init_prompt_toolkit_cli()
526 self.init_term_title()
529 self.init_term_title()
527 self.keep_running = True
530 self.keep_running = True
528
531
529 self.debugger_history = InMemoryHistory()
532 self.debugger_history = InMemoryHistory()
530
533
531 def ask_exit(self):
534 def ask_exit(self):
532 self.keep_running = False
535 self.keep_running = False
533
536
534 rl_next_input = None
537 rl_next_input = None
535
538
536 def interact(self, display_banner=DISPLAY_BANNER_DEPRECATED):
539 def interact(self, display_banner=DISPLAY_BANNER_DEPRECATED):
537
540
538 if display_banner is not DISPLAY_BANNER_DEPRECATED:
541 if display_banner is not DISPLAY_BANNER_DEPRECATED:
539 warn('interact `display_banner` argument is deprecated since IPython 5.0. Call `show_banner()` if needed.', DeprecationWarning, stacklevel=2)
542 warn('interact `display_banner` argument is deprecated since IPython 5.0. Call `show_banner()` if needed.', DeprecationWarning, stacklevel=2)
540
543
541 self.keep_running = True
544 self.keep_running = True
542 while self.keep_running:
545 while self.keep_running:
543 print(self.separate_in, end='')
546 print(self.separate_in, end='')
544
547
545 try:
548 try:
546 code = self.prompt_for_code()
549 code = self.prompt_for_code()
547 except EOFError:
550 except EOFError:
548 if (not self.confirm_exit) \
551 if (not self.confirm_exit) \
549 or self.ask_yes_no('Do you really want to exit ([y]/n)?','y','n'):
552 or self.ask_yes_no('Do you really want to exit ([y]/n)?','y','n'):
550 self.ask_exit()
553 self.ask_exit()
551
554
552 else:
555 else:
553 if code:
556 if code:
554 self.run_cell(code, store_history=True)
557 self.run_cell(code, store_history=True)
555
558
556 def mainloop(self, display_banner=DISPLAY_BANNER_DEPRECATED):
559 def mainloop(self, display_banner=DISPLAY_BANNER_DEPRECATED):
557 # An extra layer of protection in case someone mashing Ctrl-C breaks
560 # An extra layer of protection in case someone mashing Ctrl-C breaks
558 # out of our internal code.
561 # out of our internal code.
559 if display_banner is not DISPLAY_BANNER_DEPRECATED:
562 if display_banner is not DISPLAY_BANNER_DEPRECATED:
560 warn('mainloop `display_banner` argument is deprecated since IPython 5.0. Call `show_banner()` if needed.', DeprecationWarning, stacklevel=2)
563 warn('mainloop `display_banner` argument is deprecated since IPython 5.0. Call `show_banner()` if needed.', DeprecationWarning, stacklevel=2)
561 while True:
564 while True:
562 try:
565 try:
563 self.interact()
566 self.interact()
564 break
567 break
565 except KeyboardInterrupt as e:
568 except KeyboardInterrupt as e:
566 print("\n%s escaped interact()\n" % type(e).__name__)
569 print("\n%s escaped interact()\n" % type(e).__name__)
567 finally:
570 finally:
568 # An interrupt during the eventloop will mess up the
571 # An interrupt during the eventloop will mess up the
569 # internal state of the prompt_toolkit library.
572 # internal state of the prompt_toolkit library.
570 # Stopping the eventloop fixes this, see
573 # Stopping the eventloop fixes this, see
571 # https://github.com/ipython/ipython/pull/9867
574 # https://github.com/ipython/ipython/pull/9867
572 if hasattr(self, '_eventloop'):
575 if hasattr(self, '_eventloop'):
573 self._eventloop.stop()
576 self._eventloop.stop()
574
577
575 self.restore_term_title()
578 self.restore_term_title()
576
579
577
580
578 _inputhook = None
581 _inputhook = None
579 def inputhook(self, context):
582 def inputhook(self, context):
580 if self._inputhook is not None:
583 if self._inputhook is not None:
581 self._inputhook(context)
584 self._inputhook(context)
582
585
583 active_eventloop = None
586 active_eventloop = None
584 def enable_gui(self, gui=None):
587 def enable_gui(self, gui=None):
585 if gui and (gui != 'inline') :
588 if gui and (gui != 'inline') :
586 self.active_eventloop, self._inputhook =\
589 self.active_eventloop, self._inputhook =\
587 get_inputhook_name_and_func(gui)
590 get_inputhook_name_and_func(gui)
588 else:
591 else:
589 self.active_eventloop = self._inputhook = None
592 self.active_eventloop = self._inputhook = None
590
593
591 # For prompt_toolkit 3.0. We have to create an asyncio event loop with
594 # For prompt_toolkit 3.0. We have to create an asyncio event loop with
592 # this inputhook.
595 # this inputhook.
593 if PTK3:
596 if PTK3:
594 import asyncio
597 import asyncio
595 from prompt_toolkit.eventloop import new_eventloop_with_inputhook
598 from prompt_toolkit.eventloop import new_eventloop_with_inputhook
596
599
597 if gui == 'asyncio':
600 if gui == 'asyncio':
598 # When we integrate the asyncio event loop, run the UI in the
601 # When we integrate the asyncio event loop, run the UI in the
599 # same event loop as the rest of the code. don't use an actual
602 # same event loop as the rest of the code. don't use an actual
600 # input hook. (Asyncio is not made for nesting event loops.)
603 # input hook. (Asyncio is not made for nesting event loops.)
601 self.pt_loop = asyncio.get_event_loop()
604 self.pt_loop = asyncio.get_event_loop()
602
605
603 elif self._inputhook:
606 elif self._inputhook:
604 # If an inputhook was set, create a new asyncio event loop with
607 # If an inputhook was set, create a new asyncio event loop with
605 # this inputhook for the prompt.
608 # this inputhook for the prompt.
606 self.pt_loop = new_eventloop_with_inputhook(self._inputhook)
609 self.pt_loop = new_eventloop_with_inputhook(self._inputhook)
607 else:
610 else:
608 # When there's no inputhook, run the prompt in a separate
611 # When there's no inputhook, run the prompt in a separate
609 # asyncio event loop.
612 # asyncio event loop.
610 self.pt_loop = asyncio.new_event_loop()
613 self.pt_loop = asyncio.new_event_loop()
611
614
612 # Run !system commands directly, not through pipes, so terminal programs
615 # Run !system commands directly, not through pipes, so terminal programs
613 # work correctly.
616 # work correctly.
614 system = InteractiveShell.system_raw
617 system = InteractiveShell.system_raw
615
618
616 def auto_rewrite_input(self, cmd):
619 def auto_rewrite_input(self, cmd):
617 """Overridden from the parent class to use fancy rewriting prompt"""
620 """Overridden from the parent class to use fancy rewriting prompt"""
618 if not self.show_rewritten_input:
621 if not self.show_rewritten_input:
619 return
622 return
620
623
621 tokens = self.prompts.rewrite_prompt_tokens()
624 tokens = self.prompts.rewrite_prompt_tokens()
622 if self.pt_app:
625 if self.pt_app:
623 print_formatted_text(PygmentsTokens(tokens), end='',
626 print_formatted_text(PygmentsTokens(tokens), end='',
624 style=self.pt_app.app.style)
627 style=self.pt_app.app.style)
625 print(cmd)
628 print(cmd)
626 else:
629 else:
627 prompt = ''.join(s for t, s in tokens)
630 prompt = ''.join(s for t, s in tokens)
628 print(prompt, cmd, sep='')
631 print(prompt, cmd, sep='')
629
632
630 _prompts_before = None
633 _prompts_before = None
631 def switch_doctest_mode(self, mode):
634 def switch_doctest_mode(self, mode):
632 """Switch prompts to classic for %doctest_mode"""
635 """Switch prompts to classic for %doctest_mode"""
633 if mode:
636 if mode:
634 self._prompts_before = self.prompts
637 self._prompts_before = self.prompts
635 self.prompts = ClassicPrompts(self)
638 self.prompts = ClassicPrompts(self)
636 elif self._prompts_before:
639 elif self._prompts_before:
637 self.prompts = self._prompts_before
640 self.prompts = self._prompts_before
638 self._prompts_before = None
641 self._prompts_before = None
639 # self._update_layout()
642 # self._update_layout()
640
643
641
644
642 InteractiveShellABC.register(TerminalInteractiveShell)
645 InteractiveShellABC.register(TerminalInteractiveShell)
643
646
644 if __name__ == '__main__':
647 if __name__ == '__main__':
645 TerminalInteractiveShell.instance().interact()
648 TerminalInteractiveShell.instance().interact()
General Comments 0
You need to be logged in to leave comments. Login now