Show More
@@ -1,3650 +1,3650 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Main IPython class.""" |
|
2 | """Main IPython class.""" | |
3 |
|
3 | |||
4 | #----------------------------------------------------------------------------- |
|
4 | #----------------------------------------------------------------------------- | |
5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> | |
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
7 | # Copyright (C) 2008-2011 The IPython Development Team | |
8 | # |
|
8 | # | |
9 | # Distributed under the terms of the BSD License. The full license is in |
|
9 | # Distributed under the terms of the BSD License. The full license is in | |
10 | # the file COPYING, distributed as part of this software. |
|
10 | # the file COPYING, distributed as part of this software. | |
11 | #----------------------------------------------------------------------------- |
|
11 | #----------------------------------------------------------------------------- | |
12 |
|
12 | |||
13 |
|
13 | |||
14 | import abc |
|
14 | import abc | |
15 | import ast |
|
15 | import ast | |
16 | import asyncio |
|
16 | import asyncio | |
17 | import atexit |
|
17 | import atexit | |
18 | import builtins as builtin_mod |
|
18 | import builtins as builtin_mod | |
19 | import functools |
|
19 | import functools | |
20 | import os |
|
20 | import os | |
21 | import re |
|
21 | import re | |
22 | import runpy |
|
22 | import runpy | |
23 | import sys |
|
23 | import sys | |
24 | import tempfile |
|
24 | import tempfile | |
25 | import traceback |
|
25 | import traceback | |
26 | import types |
|
26 | import types | |
27 | import subprocess |
|
27 | import subprocess | |
28 | import warnings |
|
28 | import warnings | |
29 | from io import open as io_open |
|
29 | from io import open as io_open | |
30 |
|
30 | |||
31 | from pickleshare import PickleShareDB |
|
31 | from pickleshare import PickleShareDB | |
32 |
|
32 | |||
33 | from traitlets.config.configurable import SingletonConfigurable |
|
33 | from traitlets.config.configurable import SingletonConfigurable | |
34 | from traitlets.utils.importstring import import_item |
|
34 | from traitlets.utils.importstring import import_item | |
35 | from IPython.core import oinspect |
|
35 | from IPython.core import oinspect | |
36 | from IPython.core import magic |
|
36 | from IPython.core import magic | |
37 | from IPython.core import page |
|
37 | from IPython.core import page | |
38 | from IPython.core import prefilter |
|
38 | from IPython.core import prefilter | |
39 | from IPython.core import ultratb |
|
39 | from IPython.core import ultratb | |
40 | from IPython.core.alias import Alias, AliasManager |
|
40 | from IPython.core.alias import Alias, AliasManager | |
41 | from IPython.core.autocall import ExitAutocall |
|
41 | from IPython.core.autocall import ExitAutocall | |
42 | from IPython.core.builtin_trap import BuiltinTrap |
|
42 | from IPython.core.builtin_trap import BuiltinTrap | |
43 | from IPython.core.events import EventManager, available_events |
|
43 | from IPython.core.events import EventManager, available_events | |
44 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython |
|
44 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython | |
45 | from IPython.core.debugger import Pdb |
|
45 | from IPython.core.debugger import Pdb | |
46 | from IPython.core.display_trap import DisplayTrap |
|
46 | from IPython.core.display_trap import DisplayTrap | |
47 | from IPython.core.displayhook import DisplayHook |
|
47 | from IPython.core.displayhook import DisplayHook | |
48 | from IPython.core.displaypub import DisplayPublisher |
|
48 | from IPython.core.displaypub import DisplayPublisher | |
49 | from IPython.core.error import InputRejected, UsageError |
|
49 | from IPython.core.error import InputRejected, UsageError | |
50 | from IPython.core.extensions import ExtensionManager |
|
50 | from IPython.core.extensions import ExtensionManager | |
51 | from IPython.core.formatters import DisplayFormatter |
|
51 | from IPython.core.formatters import DisplayFormatter | |
52 | from IPython.core.history import HistoryManager |
|
52 | from IPython.core.history import HistoryManager | |
53 | from IPython.core.inputtransformer2 import ESC_MAGIC, ESC_MAGIC2 |
|
53 | from IPython.core.inputtransformer2 import ESC_MAGIC, ESC_MAGIC2 | |
54 | from IPython.core.logger import Logger |
|
54 | from IPython.core.logger import Logger | |
55 | from IPython.core.macro import Macro |
|
55 | from IPython.core.macro import Macro | |
56 | from IPython.core.payload import PayloadManager |
|
56 | from IPython.core.payload import PayloadManager | |
57 | from IPython.core.prefilter import PrefilterManager |
|
57 | from IPython.core.prefilter import PrefilterManager | |
58 | from IPython.core.profiledir import ProfileDir |
|
58 | from IPython.core.profiledir import ProfileDir | |
59 | from IPython.core.usage import default_banner |
|
59 | from IPython.core.usage import default_banner | |
60 | from IPython.display import display |
|
60 | from IPython.display import display | |
61 | from IPython.testing.skipdoctest import skip_doctest |
|
61 | from IPython.testing.skipdoctest import skip_doctest | |
62 | from IPython.utils import PyColorize |
|
62 | from IPython.utils import PyColorize | |
63 | from IPython.utils import io |
|
63 | from IPython.utils import io | |
64 | from IPython.utils import py3compat |
|
64 | from IPython.utils import py3compat | |
65 | from IPython.utils import openpy |
|
65 | from IPython.utils import openpy | |
66 | from IPython.utils.decorators import undoc |
|
66 | from IPython.utils.decorators import undoc | |
67 | from IPython.utils.io import ask_yes_no |
|
67 | from IPython.utils.io import ask_yes_no | |
68 | from IPython.utils.ipstruct import Struct |
|
68 | from IPython.utils.ipstruct import Struct | |
69 | from IPython.paths import get_ipython_dir |
|
69 | from IPython.paths import get_ipython_dir | |
70 | from IPython.utils.path import get_home_dir, get_py_filename, ensure_dir_exists |
|
70 | from IPython.utils.path import get_home_dir, get_py_filename, ensure_dir_exists | |
71 | from IPython.utils.process import system, getoutput |
|
71 | from IPython.utils.process import system, getoutput | |
72 | from IPython.utils.strdispatch import StrDispatch |
|
72 | from IPython.utils.strdispatch import StrDispatch | |
73 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
73 | from IPython.utils.syspathcontext import prepended_to_syspath | |
74 | from IPython.utils.text import format_screen, LSString, SList, DollarFormatter |
|
74 | from IPython.utils.text import format_screen, LSString, SList, DollarFormatter | |
75 | from IPython.utils.tempdir import TemporaryDirectory |
|
75 | from IPython.utils.tempdir import TemporaryDirectory | |
76 | from traitlets import ( |
|
76 | from traitlets import ( | |
77 | Integer, Bool, CaselessStrEnum, Enum, List, Dict, Unicode, Instance, Type, |
|
77 | Integer, Bool, CaselessStrEnum, Enum, List, Dict, Unicode, Instance, Type, | |
78 | observe, default, validate, Any |
|
78 | observe, default, validate, Any | |
79 | ) |
|
79 | ) | |
80 | from warnings import warn |
|
80 | from warnings import warn | |
81 | from logging import error |
|
81 | from logging import error | |
82 | import IPython.core.hooks |
|
82 | import IPython.core.hooks | |
83 |
|
83 | |||
84 | from typing import List as ListType, Tuple |
|
84 | from typing import List as ListType, Tuple | |
85 | from ast import AST |
|
85 | from ast import AST | |
86 |
|
86 | |||
87 | # NoOpContext is deprecated, but ipykernel imports it from here. |
|
87 | # NoOpContext is deprecated, but ipykernel imports it from here. | |
88 | # See https://github.com/ipython/ipykernel/issues/157 |
|
88 | # See https://github.com/ipython/ipykernel/issues/157 | |
89 | from IPython.utils.contexts import NoOpContext |
|
89 | from IPython.utils.contexts import NoOpContext | |
90 |
|
90 | |||
91 | try: |
|
91 | try: | |
92 | import docrepr.sphinxify as sphx |
|
92 | import docrepr.sphinxify as sphx | |
93 |
|
93 | |||
94 | def sphinxify(doc): |
|
94 | def sphinxify(doc): | |
95 | with TemporaryDirectory() as dirname: |
|
95 | with TemporaryDirectory() as dirname: | |
96 | return { |
|
96 | return { | |
97 | 'text/html': sphx.sphinxify(doc, dirname), |
|
97 | 'text/html': sphx.sphinxify(doc, dirname), | |
98 | 'text/plain': doc |
|
98 | 'text/plain': doc | |
99 | } |
|
99 | } | |
100 | except ImportError: |
|
100 | except ImportError: | |
101 | sphinxify = None |
|
101 | sphinxify = None | |
102 |
|
102 | |||
103 |
|
103 | |||
104 | class ProvisionalWarning(DeprecationWarning): |
|
104 | class ProvisionalWarning(DeprecationWarning): | |
105 | """ |
|
105 | """ | |
106 | Warning class for unstable features |
|
106 | Warning class for unstable features | |
107 | """ |
|
107 | """ | |
108 | pass |
|
108 | pass | |
109 |
|
109 | |||
110 | if sys.version_info > (3,6): |
|
110 | if sys.version_info > (3,6): | |
111 | _assign_nodes = (ast.AugAssign, ast.AnnAssign, ast.Assign) |
|
111 | _assign_nodes = (ast.AugAssign, ast.AnnAssign, ast.Assign) | |
112 | _single_targets_nodes = (ast.AugAssign, ast.AnnAssign) |
|
112 | _single_targets_nodes = (ast.AugAssign, ast.AnnAssign) | |
113 | else: |
|
113 | else: | |
114 | _assign_nodes = (ast.AugAssign, ast.Assign ) |
|
114 | _assign_nodes = (ast.AugAssign, ast.Assign ) | |
115 | _single_targets_nodes = (ast.AugAssign, ) |
|
115 | _single_targets_nodes = (ast.AugAssign, ) | |
116 |
|
116 | |||
117 | #----------------------------------------------------------------------------- |
|
117 | #----------------------------------------------------------------------------- | |
118 | # Await Helpers |
|
118 | # Await Helpers | |
119 | #----------------------------------------------------------------------------- |
|
119 | #----------------------------------------------------------------------------- | |
120 |
|
120 | |||
121 | def removed_co_newlocals(function:types.FunctionType) -> types.FunctionType: |
|
121 | def removed_co_newlocals(function:types.FunctionType) -> types.FunctionType: | |
122 | """Return a function that do not create a new local scope. |
|
122 | """Return a function that do not create a new local scope. | |
123 |
|
123 | |||
124 | Given a function, create a clone of this function where the co_newlocal flag |
|
124 | Given a function, create a clone of this function where the co_newlocal flag | |
125 | has been removed, making this function code actually run in the sourounding |
|
125 | has been removed, making this function code actually run in the sourounding | |
126 | scope. |
|
126 | scope. | |
127 |
|
127 | |||
128 | We need this in order to run asynchronous code in user level namespace. |
|
128 | We need this in order to run asynchronous code in user level namespace. | |
129 | """ |
|
129 | """ | |
130 | from types import CodeType, FunctionType |
|
130 | from types import CodeType, FunctionType | |
131 | CO_NEWLOCALS = 0x0002 |
|
131 | CO_NEWLOCALS = 0x0002 | |
132 | code = function.__code__ |
|
132 | code = function.__code__ | |
133 | new_code = CodeType( |
|
133 | new_code = CodeType( | |
134 | code.co_argcount, |
|
134 | code.co_argcount, | |
135 | code.co_kwonlyargcount, |
|
135 | code.co_kwonlyargcount, | |
136 | code.co_nlocals, |
|
136 | code.co_nlocals, | |
137 | code.co_stacksize, |
|
137 | code.co_stacksize, | |
138 | code.co_flags & ~CO_NEWLOCALS, |
|
138 | code.co_flags & ~CO_NEWLOCALS, | |
139 | code.co_code, |
|
139 | code.co_code, | |
140 | code.co_consts, |
|
140 | code.co_consts, | |
141 | code.co_names, |
|
141 | code.co_names, | |
142 | code.co_varnames, |
|
142 | code.co_varnames, | |
143 | code.co_filename, |
|
143 | code.co_filename, | |
144 | code.co_name, |
|
144 | code.co_name, | |
145 | code.co_firstlineno, |
|
145 | code.co_firstlineno, | |
146 | code.co_lnotab, |
|
146 | code.co_lnotab, | |
147 | code.co_freevars, |
|
147 | code.co_freevars, | |
148 | code.co_cellvars |
|
148 | code.co_cellvars | |
149 | ) |
|
149 | ) | |
150 | return FunctionType(new_code, globals(), function.__name__, function.__defaults__) |
|
150 | return FunctionType(new_code, globals(), function.__name__, function.__defaults__) | |
151 |
|
151 | |||
152 |
|
152 | |||
153 | # we still need to run things using the asyncio eventloop, but there is no |
|
153 | # we still need to run things using the asyncio eventloop, but there is no | |
154 | # async integration |
|
154 | # async integration | |
155 | from .async_helpers import (_asyncio_runner, _asyncify, _pseudo_sync_runner) |
|
155 | from .async_helpers import (_asyncio_runner, _asyncify, _pseudo_sync_runner) | |
156 |
|
156 | |||
157 | if sys.version_info > (3, 5): |
|
157 | if sys.version_info > (3, 5): | |
158 | from .async_helpers import _curio_runner, _trio_runner, _should_be_async |
|
158 | from .async_helpers import _curio_runner, _trio_runner, _should_be_async | |
159 | else : |
|
159 | else : | |
160 | _curio_runner = _trio_runner = None |
|
160 | _curio_runner = _trio_runner = None | |
161 |
|
161 | |||
162 | def _should_be_async(cell:str)->bool: |
|
162 | def _should_be_async(cell:str)->bool: | |
163 | return False |
|
163 | return False | |
164 |
|
164 | |||
165 |
|
165 | |||
166 | def _ast_asyncify(cell:str, wrapper_name:str) -> ast.Module: |
|
166 | def _ast_asyncify(cell:str, wrapper_name:str) -> ast.Module: | |
167 | """ |
|
167 | """ | |
168 | Parse a cell with top-level await and modify the AST to be able to run it later. |
|
168 | Parse a cell with top-level await and modify the AST to be able to run it later. | |
169 |
|
169 | |||
170 | Parameter |
|
170 | Parameter | |
171 | --------- |
|
171 | --------- | |
172 |
|
172 | |||
173 | cell: str |
|
173 | cell: str | |
174 | The code cell to asyncronify |
|
174 | The code cell to asyncronify | |
175 | wrapper_name: str |
|
175 | wrapper_name: str | |
176 | The name of the function to be used to wrap the passed `cell`. It is |
|
176 | The name of the function to be used to wrap the passed `cell`. It is | |
177 | advised to **not** use a python identifier in order to not pollute the |
|
177 | advised to **not** use a python identifier in order to not pollute the | |
178 | global namespace in which the function will be ran. |
|
178 | global namespace in which the function will be ran. | |
179 |
|
179 | |||
180 | Return |
|
180 | Return | |
181 | ------ |
|
181 | ------ | |
182 |
|
182 | |||
183 | A module object AST containing **one** function named `wrapper_name`. |
|
183 | A module object AST containing **one** function named `wrapper_name`. | |
184 |
|
184 | |||
185 | The given code is wrapped in a async-def function, parsed into an AST, and |
|
185 | The given code is wrapped in a async-def function, parsed into an AST, and | |
186 | the resulting function definition AST is modified to return the last |
|
186 | the resulting function definition AST is modified to return the last | |
187 | expression. |
|
187 | expression. | |
188 |
|
188 | |||
189 | The last expression or await node is moved into a return statement at the |
|
189 | The last expression or await node is moved into a return statement at the | |
190 | end of the function, and removed from its original location. If the last |
|
190 | end of the function, and removed from its original location. If the last | |
191 | node is not Expr or Await nothing is done. |
|
191 | node is not Expr or Await nothing is done. | |
192 |
|
192 | |||
193 | The function `__code__` will need to be later modified (by |
|
193 | The function `__code__` will need to be later modified (by | |
194 | ``removed_co_newlocals``) in a subsequent step to not create new `locals()` |
|
194 | ``removed_co_newlocals``) in a subsequent step to not create new `locals()` | |
195 | meaning that the local and global scope are the same, ie as if the body of |
|
195 | meaning that the local and global scope are the same, ie as if the body of | |
196 | the function was at module level. |
|
196 | the function was at module level. | |
197 |
|
197 | |||
198 | Lastly a call to `locals()` is made just before the last expression of the |
|
198 | Lastly a call to `locals()` is made just before the last expression of the | |
199 | function, or just after the last assignment or statement to make sure the |
|
199 | function, or just after the last assignment or statement to make sure the | |
200 | global dict is updated as python function work with a local fast cache which |
|
200 | global dict is updated as python function work with a local fast cache which | |
201 | is updated only on `local()` calls. |
|
201 | is updated only on `local()` calls. | |
202 | """ |
|
202 | """ | |
203 |
|
203 | |||
204 | from ast import Expr, Await, Return |
|
204 | from ast import Expr, Await, Return | |
205 | tree = ast.parse(_asyncify(cell)) |
|
205 | tree = ast.parse(_asyncify(cell)) | |
206 |
|
206 | |||
207 | function_def = tree.body[0] |
|
207 | function_def = tree.body[0] | |
208 | function_def.name = wrapper_name |
|
208 | function_def.name = wrapper_name | |
209 | try_block = function_def.body[0] |
|
209 | try_block = function_def.body[0] | |
210 | lastexpr = try_block.body[-1] |
|
210 | lastexpr = try_block.body[-1] | |
211 | if isinstance(lastexpr, (Expr, Await)): |
|
211 | if isinstance(lastexpr, (Expr, Await)): | |
212 | try_block.body[-1] = Return(lastexpr.value) |
|
212 | try_block.body[-1] = Return(lastexpr.value) | |
213 | ast.fix_missing_locations(tree) |
|
213 | ast.fix_missing_locations(tree) | |
214 | return tree |
|
214 | return tree | |
215 | #----------------------------------------------------------------------------- |
|
215 | #----------------------------------------------------------------------------- | |
216 | # Globals |
|
216 | # Globals | |
217 | #----------------------------------------------------------------------------- |
|
217 | #----------------------------------------------------------------------------- | |
218 |
|
218 | |||
219 | # compiled regexps for autoindent management |
|
219 | # compiled regexps for autoindent management | |
220 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
220 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
221 |
|
221 | |||
222 | #----------------------------------------------------------------------------- |
|
222 | #----------------------------------------------------------------------------- | |
223 | # Utilities |
|
223 | # Utilities | |
224 | #----------------------------------------------------------------------------- |
|
224 | #----------------------------------------------------------------------------- | |
225 |
|
225 | |||
226 | @undoc |
|
226 | @undoc | |
227 | def softspace(file, newvalue): |
|
227 | def softspace(file, newvalue): | |
228 | """Copied from code.py, to remove the dependency""" |
|
228 | """Copied from code.py, to remove the dependency""" | |
229 |
|
229 | |||
230 | oldvalue = 0 |
|
230 | oldvalue = 0 | |
231 | try: |
|
231 | try: | |
232 | oldvalue = file.softspace |
|
232 | oldvalue = file.softspace | |
233 | except AttributeError: |
|
233 | except AttributeError: | |
234 | pass |
|
234 | pass | |
235 | try: |
|
235 | try: | |
236 | file.softspace = newvalue |
|
236 | file.softspace = newvalue | |
237 | except (AttributeError, TypeError): |
|
237 | except (AttributeError, TypeError): | |
238 | # "attribute-less object" or "read-only attributes" |
|
238 | # "attribute-less object" or "read-only attributes" | |
239 | pass |
|
239 | pass | |
240 | return oldvalue |
|
240 | return oldvalue | |
241 |
|
241 | |||
242 | @undoc |
|
242 | @undoc | |
243 | def no_op(*a, **kw): |
|
243 | def no_op(*a, **kw): | |
244 | pass |
|
244 | pass | |
245 |
|
245 | |||
246 |
|
246 | |||
247 | class SpaceInInput(Exception): pass |
|
247 | class SpaceInInput(Exception): pass | |
248 |
|
248 | |||
249 |
|
249 | |||
250 | def get_default_colors(): |
|
250 | def get_default_colors(): | |
251 | "DEPRECATED" |
|
251 | "DEPRECATED" | |
252 | warn('get_default_color is deprecated since IPython 5.0, and returns `Neutral` on all platforms.', |
|
252 | warn('get_default_color is deprecated since IPython 5.0, and returns `Neutral` on all platforms.', | |
253 | DeprecationWarning, stacklevel=2) |
|
253 | DeprecationWarning, stacklevel=2) | |
254 | return 'Neutral' |
|
254 | return 'Neutral' | |
255 |
|
255 | |||
256 |
|
256 | |||
257 | class SeparateUnicode(Unicode): |
|
257 | class SeparateUnicode(Unicode): | |
258 | r"""A Unicode subclass to validate separate_in, separate_out, etc. |
|
258 | r"""A Unicode subclass to validate separate_in, separate_out, etc. | |
259 |
|
259 | |||
260 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. |
|
260 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. | |
261 | """ |
|
261 | """ | |
262 |
|
262 | |||
263 | def validate(self, obj, value): |
|
263 | def validate(self, obj, value): | |
264 | if value == '0': value = '' |
|
264 | if value == '0': value = '' | |
265 | value = value.replace('\\n','\n') |
|
265 | value = value.replace('\\n','\n') | |
266 | return super(SeparateUnicode, self).validate(obj, value) |
|
266 | return super(SeparateUnicode, self).validate(obj, value) | |
267 |
|
267 | |||
268 |
|
268 | |||
269 | @undoc |
|
269 | @undoc | |
270 | class DummyMod(object): |
|
270 | class DummyMod(object): | |
271 | """A dummy module used for IPython's interactive module when |
|
271 | """A dummy module used for IPython's interactive module when | |
272 | a namespace must be assigned to the module's __dict__.""" |
|
272 | a namespace must be assigned to the module's __dict__.""" | |
273 | __spec__ = None |
|
273 | __spec__ = None | |
274 |
|
274 | |||
275 |
|
275 | |||
276 | class ExecutionInfo(object): |
|
276 | class ExecutionInfo(object): | |
277 | """The arguments used for a call to :meth:`InteractiveShell.run_cell` |
|
277 | """The arguments used for a call to :meth:`InteractiveShell.run_cell` | |
278 |
|
278 | |||
279 | Stores information about what is going to happen. |
|
279 | Stores information about what is going to happen. | |
280 | """ |
|
280 | """ | |
281 | raw_cell = None |
|
281 | raw_cell = None | |
282 | store_history = False |
|
282 | store_history = False | |
283 | silent = False |
|
283 | silent = False | |
284 | shell_futures = True |
|
284 | shell_futures = True | |
285 |
|
285 | |||
286 | def __init__(self, raw_cell, store_history, silent, shell_futures): |
|
286 | def __init__(self, raw_cell, store_history, silent, shell_futures): | |
287 | self.raw_cell = raw_cell |
|
287 | self.raw_cell = raw_cell | |
288 | self.store_history = store_history |
|
288 | self.store_history = store_history | |
289 | self.silent = silent |
|
289 | self.silent = silent | |
290 | self.shell_futures = shell_futures |
|
290 | self.shell_futures = shell_futures | |
291 |
|
291 | |||
292 | def __repr__(self): |
|
292 | def __repr__(self): | |
293 | name = self.__class__.__qualname__ |
|
293 | name = self.__class__.__qualname__ | |
294 | raw_cell = ((self.raw_cell[:50] + '..') |
|
294 | raw_cell = ((self.raw_cell[:50] + '..') | |
295 | if len(self.raw_cell) > 50 else self.raw_cell) |
|
295 | if len(self.raw_cell) > 50 else self.raw_cell) | |
296 | return '<%s object at %x, raw_cell="%s" store_history=%s silent=%s shell_futures=%s>' %\ |
|
296 | return '<%s object at %x, raw_cell="%s" store_history=%s silent=%s shell_futures=%s>' %\ | |
297 | (name, id(self), raw_cell, self.store_history, self.silent, self.shell_futures) |
|
297 | (name, id(self), raw_cell, self.store_history, self.silent, self.shell_futures) | |
298 |
|
298 | |||
299 |
|
299 | |||
300 | class ExecutionResult(object): |
|
300 | class ExecutionResult(object): | |
301 | """The result of a call to :meth:`InteractiveShell.run_cell` |
|
301 | """The result of a call to :meth:`InteractiveShell.run_cell` | |
302 |
|
302 | |||
303 | Stores information about what took place. |
|
303 | Stores information about what took place. | |
304 | """ |
|
304 | """ | |
305 | execution_count = None |
|
305 | execution_count = None | |
306 | error_before_exec = None |
|
306 | error_before_exec = None | |
307 | error_in_exec = None |
|
307 | error_in_exec = None | |
308 | info = None |
|
308 | info = None | |
309 | result = None |
|
309 | result = None | |
310 |
|
310 | |||
311 | def __init__(self, info): |
|
311 | def __init__(self, info): | |
312 | self.info = info |
|
312 | self.info = info | |
313 |
|
313 | |||
314 | @property |
|
314 | @property | |
315 | def success(self): |
|
315 | def success(self): | |
316 | return (self.error_before_exec is None) and (self.error_in_exec is None) |
|
316 | return (self.error_before_exec is None) and (self.error_in_exec is None) | |
317 |
|
317 | |||
318 | def raise_error(self): |
|
318 | def raise_error(self): | |
319 | """Reraises error if `success` is `False`, otherwise does nothing""" |
|
319 | """Reraises error if `success` is `False`, otherwise does nothing""" | |
320 | if self.error_before_exec is not None: |
|
320 | if self.error_before_exec is not None: | |
321 | raise self.error_before_exec |
|
321 | raise self.error_before_exec | |
322 | if self.error_in_exec is not None: |
|
322 | if self.error_in_exec is not None: | |
323 | raise self.error_in_exec |
|
323 | raise self.error_in_exec | |
324 |
|
324 | |||
325 | def __repr__(self): |
|
325 | def __repr__(self): | |
326 | name = self.__class__.__qualname__ |
|
326 | name = self.__class__.__qualname__ | |
327 | return '<%s object at %x, execution_count=%s error_before_exec=%s error_in_exec=%s info=%s result=%s>' %\ |
|
327 | return '<%s object at %x, execution_count=%s error_before_exec=%s error_in_exec=%s info=%s result=%s>' %\ | |
328 | (name, id(self), self.execution_count, self.error_before_exec, self.error_in_exec, repr(self.info), repr(self.result)) |
|
328 | (name, id(self), self.execution_count, self.error_before_exec, self.error_in_exec, repr(self.info), repr(self.result)) | |
329 |
|
329 | |||
330 |
|
330 | |||
331 | class InteractiveShell(SingletonConfigurable): |
|
331 | class InteractiveShell(SingletonConfigurable): | |
332 | """An enhanced, interactive shell for Python.""" |
|
332 | """An enhanced, interactive shell for Python.""" | |
333 |
|
333 | |||
334 | _instance = None |
|
334 | _instance = None | |
335 |
|
335 | |||
336 | ast_transformers = List([], help= |
|
336 | ast_transformers = List([], help= | |
337 | """ |
|
337 | """ | |
338 | A list of ast.NodeTransformer subclass instances, which will be applied |
|
338 | A list of ast.NodeTransformer subclass instances, which will be applied | |
339 | to user input before code is run. |
|
339 | to user input before code is run. | |
340 | """ |
|
340 | """ | |
341 | ).tag(config=True) |
|
341 | ).tag(config=True) | |
342 |
|
342 | |||
343 | autocall = Enum((0,1,2), default_value=0, help= |
|
343 | autocall = Enum((0,1,2), default_value=0, help= | |
344 | """ |
|
344 | """ | |
345 | Make IPython automatically call any callable object even if you didn't |
|
345 | Make IPython automatically call any callable object even if you didn't | |
346 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
346 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' | |
347 | automatically. The value can be '0' to disable the feature, '1' for |
|
347 | automatically. The value can be '0' to disable the feature, '1' for | |
348 | 'smart' autocall, where it is not applied if there are no more |
|
348 | 'smart' autocall, where it is not applied if there are no more | |
349 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
349 | arguments on the line, and '2' for 'full' autocall, where all callable | |
350 | objects are automatically called (even if no arguments are present). |
|
350 | objects are automatically called (even if no arguments are present). | |
351 | """ |
|
351 | """ | |
352 | ).tag(config=True) |
|
352 | ).tag(config=True) | |
353 |
|
353 | |||
354 | autoindent = Bool(True, help= |
|
354 | autoindent = Bool(True, help= | |
355 | """ |
|
355 | """ | |
356 | Autoindent IPython code entered interactively. |
|
356 | Autoindent IPython code entered interactively. | |
357 | """ |
|
357 | """ | |
358 | ).tag(config=True) |
|
358 | ).tag(config=True) | |
359 |
|
359 | |||
360 | autoawait = Bool(True, help= |
|
360 | autoawait = Bool(True, help= | |
361 | """ |
|
361 | """ | |
362 | Automatically run await statement in the top level repl. |
|
362 | Automatically run await statement in the top level repl. | |
363 | """ |
|
363 | """ | |
364 | ).tag(config=True) |
|
364 | ).tag(config=True) | |
365 |
|
365 | |||
366 | loop_runner_map ={ |
|
366 | loop_runner_map ={ | |
367 | 'asyncio':(_asyncio_runner, True), |
|
367 | 'asyncio':(_asyncio_runner, True), | |
368 | 'curio':(_curio_runner, True), |
|
368 | 'curio':(_curio_runner, True), | |
369 | 'trio':(_trio_runner, True), |
|
369 | 'trio':(_trio_runner, True), | |
370 | 'sync': (_pseudo_sync_runner, False) |
|
370 | 'sync': (_pseudo_sync_runner, False) | |
371 | } |
|
371 | } | |
372 |
|
372 | |||
373 | loop_runner = Any(default_value="IPython.core.interactiveshell._asyncio_runner", |
|
373 | loop_runner = Any(default_value="IPython.core.interactiveshell._asyncio_runner", | |
374 | allow_none=True, |
|
374 | allow_none=True, | |
375 | help="""Select the loop runner that will be used to execute top-level asynchronous code""" |
|
375 | help="""Select the loop runner that will be used to execute top-level asynchronous code""" | |
376 | ).tag(config=True) |
|
376 | ).tag(config=True) | |
377 |
|
377 | |||
378 | @default('loop_runner') |
|
378 | @default('loop_runner') | |
379 | def _default_loop_runner(self): |
|
379 | def _default_loop_runner(self): | |
380 | return import_item("IPython.core.interactiveshell._asyncio_runner") |
|
380 | return import_item("IPython.core.interactiveshell._asyncio_runner") | |
381 |
|
381 | |||
382 | @validate('loop_runner') |
|
382 | @validate('loop_runner') | |
383 | def _import_runner(self, proposal): |
|
383 | def _import_runner(self, proposal): | |
384 | if isinstance(proposal.value, str): |
|
384 | if isinstance(proposal.value, str): | |
385 | if proposal.value in self.loop_runner_map: |
|
385 | if proposal.value in self.loop_runner_map: | |
386 | runner, autoawait = self.loop_runner_map[proposal.value] |
|
386 | runner, autoawait = self.loop_runner_map[proposal.value] | |
387 | self.autoawait = autoawait |
|
387 | self.autoawait = autoawait | |
388 | return runner |
|
388 | return runner | |
389 | runner = import_item(proposal.value) |
|
389 | runner = import_item(proposal.value) | |
390 | if not callable(runner): |
|
390 | if not callable(runner): | |
391 | raise ValueError('loop_runner must be callable') |
|
391 | raise ValueError('loop_runner must be callable') | |
392 | return runner |
|
392 | return runner | |
393 | if not callable(proposal.value): |
|
393 | if not callable(proposal.value): | |
394 | raise ValueError('loop_runner must be callable') |
|
394 | raise ValueError('loop_runner must be callable') | |
395 | return proposal.value |
|
395 | return proposal.value | |
396 |
|
396 | |||
397 | automagic = Bool(True, help= |
|
397 | automagic = Bool(True, help= | |
398 | """ |
|
398 | """ | |
399 | Enable magic commands to be called without the leading %. |
|
399 | Enable magic commands to be called without the leading %. | |
400 | """ |
|
400 | """ | |
401 | ).tag(config=True) |
|
401 | ).tag(config=True) | |
402 |
|
402 | |||
403 | banner1 = Unicode(default_banner, |
|
403 | banner1 = Unicode(default_banner, | |
404 | help="""The part of the banner to be printed before the profile""" |
|
404 | help="""The part of the banner to be printed before the profile""" | |
405 | ).tag(config=True) |
|
405 | ).tag(config=True) | |
406 | banner2 = Unicode('', |
|
406 | banner2 = Unicode('', | |
407 | help="""The part of the banner to be printed after the profile""" |
|
407 | help="""The part of the banner to be printed after the profile""" | |
408 | ).tag(config=True) |
|
408 | ).tag(config=True) | |
409 |
|
409 | |||
410 | cache_size = Integer(1000, help= |
|
410 | cache_size = Integer(1000, help= | |
411 | """ |
|
411 | """ | |
412 | Set the size of the output cache. The default is 1000, you can |
|
412 | Set the size of the output cache. The default is 1000, you can | |
413 | change it permanently in your config file. Setting it to 0 completely |
|
413 | change it permanently in your config file. Setting it to 0 completely | |
414 | disables the caching system, and the minimum value accepted is 3 (if |
|
414 | disables the caching system, and the minimum value accepted is 3 (if | |
415 | you provide a value less than 3, it is reset to 0 and a warning is |
|
415 | you provide a value less than 3, it is reset to 0 and a warning is | |
416 | issued). This limit is defined because otherwise you'll spend more |
|
416 | issued). This limit is defined because otherwise you'll spend more | |
417 | time re-flushing a too small cache than working |
|
417 | time re-flushing a too small cache than working | |
418 | """ |
|
418 | """ | |
419 | ).tag(config=True) |
|
419 | ).tag(config=True) | |
420 | color_info = Bool(True, help= |
|
420 | color_info = Bool(True, help= | |
421 | """ |
|
421 | """ | |
422 | Use colors for displaying information about objects. Because this |
|
422 | Use colors for displaying information about objects. Because this | |
423 | information is passed through a pager (like 'less'), and some pagers |
|
423 | information is passed through a pager (like 'less'), and some pagers | |
424 | get confused with color codes, this capability can be turned off. |
|
424 | get confused with color codes, this capability can be turned off. | |
425 | """ |
|
425 | """ | |
426 | ).tag(config=True) |
|
426 | ).tag(config=True) | |
427 | colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'), |
|
427 | colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'), | |
428 | default_value='Neutral', |
|
428 | default_value='Neutral', | |
429 | help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)." |
|
429 | help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)." | |
430 | ).tag(config=True) |
|
430 | ).tag(config=True) | |
431 | debug = Bool(False).tag(config=True) |
|
431 | debug = Bool(False).tag(config=True) | |
432 | disable_failing_post_execute = Bool(False, |
|
432 | disable_failing_post_execute = Bool(False, | |
433 | help="Don't call post-execute functions that have failed in the past." |
|
433 | help="Don't call post-execute functions that have failed in the past." | |
434 | ).tag(config=True) |
|
434 | ).tag(config=True) | |
435 | display_formatter = Instance(DisplayFormatter, allow_none=True) |
|
435 | display_formatter = Instance(DisplayFormatter, allow_none=True) | |
436 | displayhook_class = Type(DisplayHook) |
|
436 | displayhook_class = Type(DisplayHook) | |
437 | display_pub_class = Type(DisplayPublisher) |
|
437 | display_pub_class = Type(DisplayPublisher) | |
438 |
|
438 | |||
439 | sphinxify_docstring = Bool(False, help= |
|
439 | sphinxify_docstring = Bool(False, help= | |
440 | """ |
|
440 | """ | |
441 | Enables rich html representation of docstrings. (This requires the |
|
441 | Enables rich html representation of docstrings. (This requires the | |
442 | docrepr module). |
|
442 | docrepr module). | |
443 | """).tag(config=True) |
|
443 | """).tag(config=True) | |
444 |
|
444 | |||
445 | @observe("sphinxify_docstring") |
|
445 | @observe("sphinxify_docstring") | |
446 | def _sphinxify_docstring_changed(self, change): |
|
446 | def _sphinxify_docstring_changed(self, change): | |
447 | if change['new']: |
|
447 | if change['new']: | |
448 | warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning) |
|
448 | warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning) | |
449 |
|
449 | |||
450 | enable_html_pager = Bool(False, help= |
|
450 | enable_html_pager = Bool(False, help= | |
451 | """ |
|
451 | """ | |
452 | (Provisional API) enables html representation in mime bundles sent |
|
452 | (Provisional API) enables html representation in mime bundles sent | |
453 | to pagers. |
|
453 | to pagers. | |
454 | """).tag(config=True) |
|
454 | """).tag(config=True) | |
455 |
|
455 | |||
456 | @observe("enable_html_pager") |
|
456 | @observe("enable_html_pager") | |
457 | def _enable_html_pager_changed(self, change): |
|
457 | def _enable_html_pager_changed(self, change): | |
458 | if change['new']: |
|
458 | if change['new']: | |
459 | warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning) |
|
459 | warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning) | |
460 |
|
460 | |||
461 | data_pub_class = None |
|
461 | data_pub_class = None | |
462 |
|
462 | |||
463 | exit_now = Bool(False) |
|
463 | exit_now = Bool(False) | |
464 | exiter = Instance(ExitAutocall) |
|
464 | exiter = Instance(ExitAutocall) | |
465 | @default('exiter') |
|
465 | @default('exiter') | |
466 | def _exiter_default(self): |
|
466 | def _exiter_default(self): | |
467 | return ExitAutocall(self) |
|
467 | return ExitAutocall(self) | |
468 | # Monotonically increasing execution counter |
|
468 | # Monotonically increasing execution counter | |
469 | execution_count = Integer(1) |
|
469 | execution_count = Integer(1) | |
470 | filename = Unicode("<ipython console>") |
|
470 | filename = Unicode("<ipython console>") | |
471 | ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__ |
|
471 | ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__ | |
472 |
|
472 | |||
473 | # Used to transform cells before running them, and check whether code is complete |
|
473 | # Used to transform cells before running them, and check whether code is complete | |
474 | input_transformer_manager = Instance('IPython.core.inputtransformer2.TransformerManager', |
|
474 | input_transformer_manager = Instance('IPython.core.inputtransformer2.TransformerManager', | |
475 | ()) |
|
475 | ()) | |
476 |
|
476 | |||
477 | @property |
|
477 | @property | |
478 | def input_transformers_cleanup(self): |
|
478 | def input_transformers_cleanup(self): | |
479 | return self.input_transformer_manager.cleanup_transforms |
|
479 | return self.input_transformer_manager.cleanup_transforms | |
480 |
|
480 | |||
481 | input_transformers_post = List([], |
|
481 | input_transformers_post = List([], | |
482 | help="A list of string input transformers, to be applied after IPython's " |
|
482 | help="A list of string input transformers, to be applied after IPython's " | |
483 | "own input transformations." |
|
483 | "own input transformations." | |
484 | ) |
|
484 | ) | |
485 |
|
485 | |||
486 | @property |
|
486 | @property | |
487 | def input_splitter(self): |
|
487 | def input_splitter(self): | |
488 | """Make this available for backward compatibility (pre-7.0 release) with existing code. |
|
488 | """Make this available for backward compatibility (pre-7.0 release) with existing code. | |
489 |
|
489 | |||
490 | For example, ipykernel ipykernel currently uses |
|
490 | For example, ipykernel ipykernel currently uses | |
491 | `shell.input_splitter.check_complete` |
|
491 | `shell.input_splitter.check_complete` | |
492 | """ |
|
492 | """ | |
493 | from warnings import warn |
|
493 | from warnings import warn | |
494 | warn("`input_splitter` is deprecated since IPython 7.0, prefer `input_transformer_manager`.", |
|
494 | warn("`input_splitter` is deprecated since IPython 7.0, prefer `input_transformer_manager`.", | |
495 | DeprecationWarning, stacklevel=2 |
|
495 | DeprecationWarning, stacklevel=2 | |
496 | ) |
|
496 | ) | |
497 | return self.input_transformer_manager |
|
497 | return self.input_transformer_manager | |
498 |
|
498 | |||
499 | logstart = Bool(False, help= |
|
499 | logstart = Bool(False, help= | |
500 | """ |
|
500 | """ | |
501 | Start logging to the default log file in overwrite mode. |
|
501 | Start logging to the default log file in overwrite mode. | |
502 | Use `logappend` to specify a log file to **append** logs to. |
|
502 | Use `logappend` to specify a log file to **append** logs to. | |
503 | """ |
|
503 | """ | |
504 | ).tag(config=True) |
|
504 | ).tag(config=True) | |
505 | logfile = Unicode('', help= |
|
505 | logfile = Unicode('', help= | |
506 | """ |
|
506 | """ | |
507 | The name of the logfile to use. |
|
507 | The name of the logfile to use. | |
508 | """ |
|
508 | """ | |
509 | ).tag(config=True) |
|
509 | ).tag(config=True) | |
510 | logappend = Unicode('', help= |
|
510 | logappend = Unicode('', help= | |
511 | """ |
|
511 | """ | |
512 | Start logging to the given file in append mode. |
|
512 | Start logging to the given file in append mode. | |
513 | Use `logfile` to specify a log file to **overwrite** logs to. |
|
513 | Use `logfile` to specify a log file to **overwrite** logs to. | |
514 | """ |
|
514 | """ | |
515 | ).tag(config=True) |
|
515 | ).tag(config=True) | |
516 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
516 | object_info_string_level = Enum((0,1,2), default_value=0, | |
517 | ).tag(config=True) |
|
517 | ).tag(config=True) | |
518 | pdb = Bool(False, help= |
|
518 | pdb = Bool(False, help= | |
519 | """ |
|
519 | """ | |
520 | Automatically call the pdb debugger after every exception. |
|
520 | Automatically call the pdb debugger after every exception. | |
521 | """ |
|
521 | """ | |
522 | ).tag(config=True) |
|
522 | ).tag(config=True) | |
523 | display_page = Bool(False, |
|
523 | display_page = Bool(False, | |
524 | help="""If True, anything that would be passed to the pager |
|
524 | help="""If True, anything that would be passed to the pager | |
525 | will be displayed as regular output instead.""" |
|
525 | will be displayed as regular output instead.""" | |
526 | ).tag(config=True) |
|
526 | ).tag(config=True) | |
527 |
|
527 | |||
528 | # deprecated prompt traits: |
|
528 | # deprecated prompt traits: | |
529 |
|
529 | |||
530 | prompt_in1 = Unicode('In [\\#]: ', |
|
530 | prompt_in1 = Unicode('In [\\#]: ', | |
531 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
531 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." | |
532 | ).tag(config=True) |
|
532 | ).tag(config=True) | |
533 | prompt_in2 = Unicode(' .\\D.: ', |
|
533 | prompt_in2 = Unicode(' .\\D.: ', | |
534 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
534 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." | |
535 | ).tag(config=True) |
|
535 | ).tag(config=True) | |
536 | prompt_out = Unicode('Out[\\#]: ', |
|
536 | prompt_out = Unicode('Out[\\#]: ', | |
537 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
537 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." | |
538 | ).tag(config=True) |
|
538 | ).tag(config=True) | |
539 | prompts_pad_left = Bool(True, |
|
539 | prompts_pad_left = Bool(True, | |
540 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
540 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." | |
541 | ).tag(config=True) |
|
541 | ).tag(config=True) | |
542 |
|
542 | |||
543 | @observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left') |
|
543 | @observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left') | |
544 | def _prompt_trait_changed(self, change): |
|
544 | def _prompt_trait_changed(self, change): | |
545 | name = change['name'] |
|
545 | name = change['name'] | |
546 | warn("InteractiveShell.{name} is deprecated since IPython 4.0" |
|
546 | warn("InteractiveShell.{name} is deprecated since IPython 4.0" | |
547 | " and ignored since 5.0, set TerminalInteractiveShell.prompts" |
|
547 | " and ignored since 5.0, set TerminalInteractiveShell.prompts" | |
548 | " object directly.".format(name=name)) |
|
548 | " object directly.".format(name=name)) | |
549 |
|
549 | |||
550 | # protect against weird cases where self.config may not exist: |
|
550 | # protect against weird cases where self.config may not exist: | |
551 |
|
551 | |||
552 | show_rewritten_input = Bool(True, |
|
552 | show_rewritten_input = Bool(True, | |
553 | help="Show rewritten input, e.g. for autocall." |
|
553 | help="Show rewritten input, e.g. for autocall." | |
554 | ).tag(config=True) |
|
554 | ).tag(config=True) | |
555 |
|
555 | |||
556 | quiet = Bool(False).tag(config=True) |
|
556 | quiet = Bool(False).tag(config=True) | |
557 |
|
557 | |||
558 | history_length = Integer(10000, |
|
558 | history_length = Integer(10000, | |
559 | help='Total length of command history' |
|
559 | help='Total length of command history' | |
560 | ).tag(config=True) |
|
560 | ).tag(config=True) | |
561 |
|
561 | |||
562 | history_load_length = Integer(1000, help= |
|
562 | history_load_length = Integer(1000, help= | |
563 | """ |
|
563 | """ | |
564 | The number of saved history entries to be loaded |
|
564 | The number of saved history entries to be loaded | |
565 | into the history buffer at startup. |
|
565 | into the history buffer at startup. | |
566 | """ |
|
566 | """ | |
567 | ).tag(config=True) |
|
567 | ).tag(config=True) | |
568 |
|
568 | |||
569 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'], |
|
569 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'], | |
570 | default_value='last_expr', |
|
570 | default_value='last_expr', | |
571 | help=""" |
|
571 | help=""" | |
572 | 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying |
|
572 | 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying | |
573 | which nodes should be run interactively (displaying output from expressions). |
|
573 | which nodes should be run interactively (displaying output from expressions). | |
574 | """ |
|
574 | """ | |
575 | ).tag(config=True) |
|
575 | ).tag(config=True) | |
576 |
|
576 | |||
577 | # TODO: this part of prompt management should be moved to the frontends. |
|
577 | # TODO: this part of prompt management should be moved to the frontends. | |
578 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
578 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' | |
579 | separate_in = SeparateUnicode('\n').tag(config=True) |
|
579 | separate_in = SeparateUnicode('\n').tag(config=True) | |
580 | separate_out = SeparateUnicode('').tag(config=True) |
|
580 | separate_out = SeparateUnicode('').tag(config=True) | |
581 | separate_out2 = SeparateUnicode('').tag(config=True) |
|
581 | separate_out2 = SeparateUnicode('').tag(config=True) | |
582 | wildcards_case_sensitive = Bool(True).tag(config=True) |
|
582 | wildcards_case_sensitive = Bool(True).tag(config=True) | |
583 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
583 | xmode = CaselessStrEnum(('Context', 'Plain', 'Verbose', 'Minimal'), | |
584 | default_value='Context', |
|
584 | default_value='Context', | |
585 | help="Switch modes for the IPython exception handlers." |
|
585 | help="Switch modes for the IPython exception handlers." | |
586 | ).tag(config=True) |
|
586 | ).tag(config=True) | |
587 |
|
587 | |||
588 | # Subcomponents of InteractiveShell |
|
588 | # Subcomponents of InteractiveShell | |
589 | alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True) |
|
589 | alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True) | |
590 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True) |
|
590 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True) | |
591 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True) |
|
591 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True) | |
592 | display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True) |
|
592 | display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True) | |
593 | extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True) |
|
593 | extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True) | |
594 | payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True) |
|
594 | payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True) | |
595 | history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True) |
|
595 | history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True) | |
596 | magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True) |
|
596 | magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True) | |
597 |
|
597 | |||
598 | profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True) |
|
598 | profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True) | |
599 | @property |
|
599 | @property | |
600 | def profile(self): |
|
600 | def profile(self): | |
601 | if self.profile_dir is not None: |
|
601 | if self.profile_dir is not None: | |
602 | name = os.path.basename(self.profile_dir.location) |
|
602 | name = os.path.basename(self.profile_dir.location) | |
603 | return name.replace('profile_','') |
|
603 | return name.replace('profile_','') | |
604 |
|
604 | |||
605 |
|
605 | |||
606 | # Private interface |
|
606 | # Private interface | |
607 | _post_execute = Dict() |
|
607 | _post_execute = Dict() | |
608 |
|
608 | |||
609 | # Tracks any GUI loop loaded for pylab |
|
609 | # Tracks any GUI loop loaded for pylab | |
610 | pylab_gui_select = None |
|
610 | pylab_gui_select = None | |
611 |
|
611 | |||
612 | last_execution_succeeded = Bool(True, help='Did last executed command succeeded') |
|
612 | last_execution_succeeded = Bool(True, help='Did last executed command succeeded') | |
613 |
|
613 | |||
614 | last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True) |
|
614 | last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True) | |
615 |
|
615 | |||
616 | def __init__(self, ipython_dir=None, profile_dir=None, |
|
616 | def __init__(self, ipython_dir=None, profile_dir=None, | |
617 | user_module=None, user_ns=None, |
|
617 | user_module=None, user_ns=None, | |
618 | custom_exceptions=((), None), **kwargs): |
|
618 | custom_exceptions=((), None), **kwargs): | |
619 |
|
619 | |||
620 | # This is where traits with a config_key argument are updated |
|
620 | # This is where traits with a config_key argument are updated | |
621 | # from the values on config. |
|
621 | # from the values on config. | |
622 | super(InteractiveShell, self).__init__(**kwargs) |
|
622 | super(InteractiveShell, self).__init__(**kwargs) | |
623 | if 'PromptManager' in self.config: |
|
623 | if 'PromptManager' in self.config: | |
624 | warn('As of IPython 5.0 `PromptManager` config will have no effect' |
|
624 | warn('As of IPython 5.0 `PromptManager` config will have no effect' | |
625 | ' and has been replaced by TerminalInteractiveShell.prompts_class') |
|
625 | ' and has been replaced by TerminalInteractiveShell.prompts_class') | |
626 | self.configurables = [self] |
|
626 | self.configurables = [self] | |
627 |
|
627 | |||
628 | # These are relatively independent and stateless |
|
628 | # These are relatively independent and stateless | |
629 | self.init_ipython_dir(ipython_dir) |
|
629 | self.init_ipython_dir(ipython_dir) | |
630 | self.init_profile_dir(profile_dir) |
|
630 | self.init_profile_dir(profile_dir) | |
631 | self.init_instance_attrs() |
|
631 | self.init_instance_attrs() | |
632 | self.init_environment() |
|
632 | self.init_environment() | |
633 |
|
633 | |||
634 | # Check if we're in a virtualenv, and set up sys.path. |
|
634 | # Check if we're in a virtualenv, and set up sys.path. | |
635 | self.init_virtualenv() |
|
635 | self.init_virtualenv() | |
636 |
|
636 | |||
637 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
637 | # Create namespaces (user_ns, user_global_ns, etc.) | |
638 | self.init_create_namespaces(user_module, user_ns) |
|
638 | self.init_create_namespaces(user_module, user_ns) | |
639 | # This has to be done after init_create_namespaces because it uses |
|
639 | # This has to be done after init_create_namespaces because it uses | |
640 | # something in self.user_ns, but before init_sys_modules, which |
|
640 | # something in self.user_ns, but before init_sys_modules, which | |
641 | # is the first thing to modify sys. |
|
641 | # is the first thing to modify sys. | |
642 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
642 | # TODO: When we override sys.stdout and sys.stderr before this class | |
643 | # is created, we are saving the overridden ones here. Not sure if this |
|
643 | # is created, we are saving the overridden ones here. Not sure if this | |
644 | # is what we want to do. |
|
644 | # is what we want to do. | |
645 | self.save_sys_module_state() |
|
645 | self.save_sys_module_state() | |
646 | self.init_sys_modules() |
|
646 | self.init_sys_modules() | |
647 |
|
647 | |||
648 | # While we're trying to have each part of the code directly access what |
|
648 | # While we're trying to have each part of the code directly access what | |
649 | # it needs without keeping redundant references to objects, we have too |
|
649 | # it needs without keeping redundant references to objects, we have too | |
650 | # much legacy code that expects ip.db to exist. |
|
650 | # much legacy code that expects ip.db to exist. | |
651 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
651 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) | |
652 |
|
652 | |||
653 | self.init_history() |
|
653 | self.init_history() | |
654 | self.init_encoding() |
|
654 | self.init_encoding() | |
655 | self.init_prefilter() |
|
655 | self.init_prefilter() | |
656 |
|
656 | |||
657 | self.init_syntax_highlighting() |
|
657 | self.init_syntax_highlighting() | |
658 | self.init_hooks() |
|
658 | self.init_hooks() | |
659 | self.init_events() |
|
659 | self.init_events() | |
660 | self.init_pushd_popd_magic() |
|
660 | self.init_pushd_popd_magic() | |
661 | self.init_user_ns() |
|
661 | self.init_user_ns() | |
662 | self.init_logger() |
|
662 | self.init_logger() | |
663 | self.init_builtins() |
|
663 | self.init_builtins() | |
664 |
|
664 | |||
665 | # The following was in post_config_initialization |
|
665 | # The following was in post_config_initialization | |
666 | self.init_inspector() |
|
666 | self.init_inspector() | |
667 | self.raw_input_original = input |
|
667 | self.raw_input_original = input | |
668 | self.init_completer() |
|
668 | self.init_completer() | |
669 | # TODO: init_io() needs to happen before init_traceback handlers |
|
669 | # TODO: init_io() needs to happen before init_traceback handlers | |
670 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
670 | # because the traceback handlers hardcode the stdout/stderr streams. | |
671 | # This logic in in debugger.Pdb and should eventually be changed. |
|
671 | # This logic in in debugger.Pdb and should eventually be changed. | |
672 | self.init_io() |
|
672 | self.init_io() | |
673 | self.init_traceback_handlers(custom_exceptions) |
|
673 | self.init_traceback_handlers(custom_exceptions) | |
674 | self.init_prompts() |
|
674 | self.init_prompts() | |
675 | self.init_display_formatter() |
|
675 | self.init_display_formatter() | |
676 | self.init_display_pub() |
|
676 | self.init_display_pub() | |
677 | self.init_data_pub() |
|
677 | self.init_data_pub() | |
678 | self.init_displayhook() |
|
678 | self.init_displayhook() | |
679 | self.init_magics() |
|
679 | self.init_magics() | |
680 | self.init_alias() |
|
680 | self.init_alias() | |
681 | self.init_logstart() |
|
681 | self.init_logstart() | |
682 | self.init_pdb() |
|
682 | self.init_pdb() | |
683 | self.init_extension_manager() |
|
683 | self.init_extension_manager() | |
684 | self.init_payload() |
|
684 | self.init_payload() | |
685 | self.init_deprecation_warnings() |
|
685 | self.init_deprecation_warnings() | |
686 | self.hooks.late_startup_hook() |
|
686 | self.hooks.late_startup_hook() | |
687 | self.events.trigger('shell_initialized', self) |
|
687 | self.events.trigger('shell_initialized', self) | |
688 | atexit.register(self.atexit_operations) |
|
688 | atexit.register(self.atexit_operations) | |
689 |
|
689 | |||
690 | def get_ipython(self): |
|
690 | def get_ipython(self): | |
691 | """Return the currently running IPython instance.""" |
|
691 | """Return the currently running IPython instance.""" | |
692 | return self |
|
692 | return self | |
693 |
|
693 | |||
694 | #------------------------------------------------------------------------- |
|
694 | #------------------------------------------------------------------------- | |
695 | # Trait changed handlers |
|
695 | # Trait changed handlers | |
696 | #------------------------------------------------------------------------- |
|
696 | #------------------------------------------------------------------------- | |
697 | @observe('ipython_dir') |
|
697 | @observe('ipython_dir') | |
698 | def _ipython_dir_changed(self, change): |
|
698 | def _ipython_dir_changed(self, change): | |
699 | ensure_dir_exists(change['new']) |
|
699 | ensure_dir_exists(change['new']) | |
700 |
|
700 | |||
701 | def set_autoindent(self,value=None): |
|
701 | def set_autoindent(self,value=None): | |
702 | """Set the autoindent flag. |
|
702 | """Set the autoindent flag. | |
703 |
|
703 | |||
704 | If called with no arguments, it acts as a toggle.""" |
|
704 | If called with no arguments, it acts as a toggle.""" | |
705 | if value is None: |
|
705 | if value is None: | |
706 | self.autoindent = not self.autoindent |
|
706 | self.autoindent = not self.autoindent | |
707 | else: |
|
707 | else: | |
708 | self.autoindent = value |
|
708 | self.autoindent = value | |
709 |
|
709 | |||
710 | #------------------------------------------------------------------------- |
|
710 | #------------------------------------------------------------------------- | |
711 | # init_* methods called by __init__ |
|
711 | # init_* methods called by __init__ | |
712 | #------------------------------------------------------------------------- |
|
712 | #------------------------------------------------------------------------- | |
713 |
|
713 | |||
714 | def init_ipython_dir(self, ipython_dir): |
|
714 | def init_ipython_dir(self, ipython_dir): | |
715 | if ipython_dir is not None: |
|
715 | if ipython_dir is not None: | |
716 | self.ipython_dir = ipython_dir |
|
716 | self.ipython_dir = ipython_dir | |
717 | return |
|
717 | return | |
718 |
|
718 | |||
719 | self.ipython_dir = get_ipython_dir() |
|
719 | self.ipython_dir = get_ipython_dir() | |
720 |
|
720 | |||
721 | def init_profile_dir(self, profile_dir): |
|
721 | def init_profile_dir(self, profile_dir): | |
722 | if profile_dir is not None: |
|
722 | if profile_dir is not None: | |
723 | self.profile_dir = profile_dir |
|
723 | self.profile_dir = profile_dir | |
724 | return |
|
724 | return | |
725 | self.profile_dir =\ |
|
725 | self.profile_dir =\ | |
726 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
726 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') | |
727 |
|
727 | |||
728 | def init_instance_attrs(self): |
|
728 | def init_instance_attrs(self): | |
729 | self.more = False |
|
729 | self.more = False | |
730 |
|
730 | |||
731 | # command compiler |
|
731 | # command compiler | |
732 | self.compile = CachingCompiler() |
|
732 | self.compile = CachingCompiler() | |
733 |
|
733 | |||
734 | # Make an empty namespace, which extension writers can rely on both |
|
734 | # Make an empty namespace, which extension writers can rely on both | |
735 | # existing and NEVER being used by ipython itself. This gives them a |
|
735 | # existing and NEVER being used by ipython itself. This gives them a | |
736 | # convenient location for storing additional information and state |
|
736 | # convenient location for storing additional information and state | |
737 | # their extensions may require, without fear of collisions with other |
|
737 | # their extensions may require, without fear of collisions with other | |
738 | # ipython names that may develop later. |
|
738 | # ipython names that may develop later. | |
739 | self.meta = Struct() |
|
739 | self.meta = Struct() | |
740 |
|
740 | |||
741 | # Temporary files used for various purposes. Deleted at exit. |
|
741 | # Temporary files used for various purposes. Deleted at exit. | |
742 | self.tempfiles = [] |
|
742 | self.tempfiles = [] | |
743 | self.tempdirs = [] |
|
743 | self.tempdirs = [] | |
744 |
|
744 | |||
745 | # keep track of where we started running (mainly for crash post-mortem) |
|
745 | # keep track of where we started running (mainly for crash post-mortem) | |
746 | # This is not being used anywhere currently. |
|
746 | # This is not being used anywhere currently. | |
747 | self.starting_dir = os.getcwd() |
|
747 | self.starting_dir = os.getcwd() | |
748 |
|
748 | |||
749 | # Indentation management |
|
749 | # Indentation management | |
750 | self.indent_current_nsp = 0 |
|
750 | self.indent_current_nsp = 0 | |
751 |
|
751 | |||
752 | # Dict to track post-execution functions that have been registered |
|
752 | # Dict to track post-execution functions that have been registered | |
753 | self._post_execute = {} |
|
753 | self._post_execute = {} | |
754 |
|
754 | |||
755 | def init_environment(self): |
|
755 | def init_environment(self): | |
756 | """Any changes we need to make to the user's environment.""" |
|
756 | """Any changes we need to make to the user's environment.""" | |
757 | pass |
|
757 | pass | |
758 |
|
758 | |||
759 | def init_encoding(self): |
|
759 | def init_encoding(self): | |
760 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
760 | # Get system encoding at startup time. Certain terminals (like Emacs | |
761 | # under Win32 have it set to None, and we need to have a known valid |
|
761 | # under Win32 have it set to None, and we need to have a known valid | |
762 | # encoding to use in the raw_input() method |
|
762 | # encoding to use in the raw_input() method | |
763 | try: |
|
763 | try: | |
764 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
764 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
765 | except AttributeError: |
|
765 | except AttributeError: | |
766 | self.stdin_encoding = 'ascii' |
|
766 | self.stdin_encoding = 'ascii' | |
767 |
|
767 | |||
768 |
|
768 | |||
769 | @observe('colors') |
|
769 | @observe('colors') | |
770 | def init_syntax_highlighting(self, changes=None): |
|
770 | def init_syntax_highlighting(self, changes=None): | |
771 | # Python source parser/formatter for syntax highlighting |
|
771 | # Python source parser/formatter for syntax highlighting | |
772 | pyformat = PyColorize.Parser(style=self.colors, parent=self).format |
|
772 | pyformat = PyColorize.Parser(style=self.colors, parent=self).format | |
773 | self.pycolorize = lambda src: pyformat(src,'str') |
|
773 | self.pycolorize = lambda src: pyformat(src,'str') | |
774 |
|
774 | |||
775 | def refresh_style(self): |
|
775 | def refresh_style(self): | |
776 | # No-op here, used in subclass |
|
776 | # No-op here, used in subclass | |
777 | pass |
|
777 | pass | |
778 |
|
778 | |||
779 | def init_pushd_popd_magic(self): |
|
779 | def init_pushd_popd_magic(self): | |
780 | # for pushd/popd management |
|
780 | # for pushd/popd management | |
781 | self.home_dir = get_home_dir() |
|
781 | self.home_dir = get_home_dir() | |
782 |
|
782 | |||
783 | self.dir_stack = [] |
|
783 | self.dir_stack = [] | |
784 |
|
784 | |||
785 | def init_logger(self): |
|
785 | def init_logger(self): | |
786 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
786 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', | |
787 | logmode='rotate') |
|
787 | logmode='rotate') | |
788 |
|
788 | |||
789 | def init_logstart(self): |
|
789 | def init_logstart(self): | |
790 | """Initialize logging in case it was requested at the command line. |
|
790 | """Initialize logging in case it was requested at the command line. | |
791 | """ |
|
791 | """ | |
792 | if self.logappend: |
|
792 | if self.logappend: | |
793 | self.magic('logstart %s append' % self.logappend) |
|
793 | self.magic('logstart %s append' % self.logappend) | |
794 | elif self.logfile: |
|
794 | elif self.logfile: | |
795 | self.magic('logstart %s' % self.logfile) |
|
795 | self.magic('logstart %s' % self.logfile) | |
796 | elif self.logstart: |
|
796 | elif self.logstart: | |
797 | self.magic('logstart') |
|
797 | self.magic('logstart') | |
798 |
|
798 | |||
799 | def init_deprecation_warnings(self): |
|
799 | def init_deprecation_warnings(self): | |
800 | """ |
|
800 | """ | |
801 | register default filter for deprecation warning. |
|
801 | register default filter for deprecation warning. | |
802 |
|
802 | |||
803 | This will allow deprecation warning of function used interactively to show |
|
803 | This will allow deprecation warning of function used interactively to show | |
804 | warning to users, and still hide deprecation warning from libraries import. |
|
804 | warning to users, and still hide deprecation warning from libraries import. | |
805 | """ |
|
805 | """ | |
806 | if sys.version_info < (3,7): |
|
806 | if sys.version_info < (3,7): | |
807 | warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__")) |
|
807 | warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__")) | |
808 |
|
808 | |||
809 |
|
809 | |||
810 | def init_builtins(self): |
|
810 | def init_builtins(self): | |
811 | # A single, static flag that we set to True. Its presence indicates |
|
811 | # A single, static flag that we set to True. Its presence indicates | |
812 | # that an IPython shell has been created, and we make no attempts at |
|
812 | # that an IPython shell has been created, and we make no attempts at | |
813 | # removing on exit or representing the existence of more than one |
|
813 | # removing on exit or representing the existence of more than one | |
814 | # IPython at a time. |
|
814 | # IPython at a time. | |
815 | builtin_mod.__dict__['__IPYTHON__'] = True |
|
815 | builtin_mod.__dict__['__IPYTHON__'] = True | |
816 | builtin_mod.__dict__['display'] = display |
|
816 | builtin_mod.__dict__['display'] = display | |
817 |
|
817 | |||
818 | self.builtin_trap = BuiltinTrap(shell=self) |
|
818 | self.builtin_trap = BuiltinTrap(shell=self) | |
819 |
|
819 | |||
820 | @observe('colors') |
|
820 | @observe('colors') | |
821 | def init_inspector(self, changes=None): |
|
821 | def init_inspector(self, changes=None): | |
822 | # Object inspector |
|
822 | # Object inspector | |
823 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
823 | self.inspector = oinspect.Inspector(oinspect.InspectColors, | |
824 | PyColorize.ANSICodeColors, |
|
824 | PyColorize.ANSICodeColors, | |
825 | self.colors, |
|
825 | self.colors, | |
826 | self.object_info_string_level) |
|
826 | self.object_info_string_level) | |
827 |
|
827 | |||
828 | def init_io(self): |
|
828 | def init_io(self): | |
829 | # This will just use sys.stdout and sys.stderr. If you want to |
|
829 | # This will just use sys.stdout and sys.stderr. If you want to | |
830 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
830 | # override sys.stdout and sys.stderr themselves, you need to do that | |
831 | # *before* instantiating this class, because io holds onto |
|
831 | # *before* instantiating this class, because io holds onto | |
832 | # references to the underlying streams. |
|
832 | # references to the underlying streams. | |
833 | # io.std* are deprecated, but don't show our own deprecation warnings |
|
833 | # io.std* are deprecated, but don't show our own deprecation warnings | |
834 | # during initialization of the deprecated API. |
|
834 | # during initialization of the deprecated API. | |
835 | with warnings.catch_warnings(): |
|
835 | with warnings.catch_warnings(): | |
836 | warnings.simplefilter('ignore', DeprecationWarning) |
|
836 | warnings.simplefilter('ignore', DeprecationWarning) | |
837 | io.stdout = io.IOStream(sys.stdout) |
|
837 | io.stdout = io.IOStream(sys.stdout) | |
838 | io.stderr = io.IOStream(sys.stderr) |
|
838 | io.stderr = io.IOStream(sys.stderr) | |
839 |
|
839 | |||
840 | def init_prompts(self): |
|
840 | def init_prompts(self): | |
841 | # Set system prompts, so that scripts can decide if they are running |
|
841 | # Set system prompts, so that scripts can decide if they are running | |
842 | # interactively. |
|
842 | # interactively. | |
843 | sys.ps1 = 'In : ' |
|
843 | sys.ps1 = 'In : ' | |
844 | sys.ps2 = '...: ' |
|
844 | sys.ps2 = '...: ' | |
845 | sys.ps3 = 'Out: ' |
|
845 | sys.ps3 = 'Out: ' | |
846 |
|
846 | |||
847 | def init_display_formatter(self): |
|
847 | def init_display_formatter(self): | |
848 | self.display_formatter = DisplayFormatter(parent=self) |
|
848 | self.display_formatter = DisplayFormatter(parent=self) | |
849 | self.configurables.append(self.display_formatter) |
|
849 | self.configurables.append(self.display_formatter) | |
850 |
|
850 | |||
851 | def init_display_pub(self): |
|
851 | def init_display_pub(self): | |
852 | self.display_pub = self.display_pub_class(parent=self) |
|
852 | self.display_pub = self.display_pub_class(parent=self) | |
853 | self.configurables.append(self.display_pub) |
|
853 | self.configurables.append(self.display_pub) | |
854 |
|
854 | |||
855 | def init_data_pub(self): |
|
855 | def init_data_pub(self): | |
856 | if not self.data_pub_class: |
|
856 | if not self.data_pub_class: | |
857 | self.data_pub = None |
|
857 | self.data_pub = None | |
858 | return |
|
858 | return | |
859 | self.data_pub = self.data_pub_class(parent=self) |
|
859 | self.data_pub = self.data_pub_class(parent=self) | |
860 | self.configurables.append(self.data_pub) |
|
860 | self.configurables.append(self.data_pub) | |
861 |
|
861 | |||
862 | def init_displayhook(self): |
|
862 | def init_displayhook(self): | |
863 | # Initialize displayhook, set in/out prompts and printing system |
|
863 | # Initialize displayhook, set in/out prompts and printing system | |
864 | self.displayhook = self.displayhook_class( |
|
864 | self.displayhook = self.displayhook_class( | |
865 | parent=self, |
|
865 | parent=self, | |
866 | shell=self, |
|
866 | shell=self, | |
867 | cache_size=self.cache_size, |
|
867 | cache_size=self.cache_size, | |
868 | ) |
|
868 | ) | |
869 | self.configurables.append(self.displayhook) |
|
869 | self.configurables.append(self.displayhook) | |
870 | # This is a context manager that installs/revmoes the displayhook at |
|
870 | # This is a context manager that installs/revmoes the displayhook at | |
871 | # the appropriate time. |
|
871 | # the appropriate time. | |
872 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
872 | self.display_trap = DisplayTrap(hook=self.displayhook) | |
873 |
|
873 | |||
874 | def init_virtualenv(self): |
|
874 | def init_virtualenv(self): | |
875 | """Add a virtualenv to sys.path so the user can import modules from it. |
|
875 | """Add a virtualenv to sys.path so the user can import modules from it. | |
876 | This isn't perfect: it doesn't use the Python interpreter with which the |
|
876 | This isn't perfect: it doesn't use the Python interpreter with which the | |
877 | virtualenv was built, and it ignores the --no-site-packages option. A |
|
877 | virtualenv was built, and it ignores the --no-site-packages option. A | |
878 | warning will appear suggesting the user installs IPython in the |
|
878 | warning will appear suggesting the user installs IPython in the | |
879 | virtualenv, but for many cases, it probably works well enough. |
|
879 | virtualenv, but for many cases, it probably works well enough. | |
880 |
|
880 | |||
881 | Adapted from code snippets online. |
|
881 | Adapted from code snippets online. | |
882 |
|
882 | |||
883 | http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv |
|
883 | http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv | |
884 | """ |
|
884 | """ | |
885 | if 'VIRTUAL_ENV' not in os.environ: |
|
885 | if 'VIRTUAL_ENV' not in os.environ: | |
886 | # Not in a virtualenv |
|
886 | # Not in a virtualenv | |
887 | return |
|
887 | return | |
888 |
|
888 | |||
889 | p = os.path.normcase(sys.executable) |
|
889 | p = os.path.normcase(sys.executable) | |
890 | p_venv = os.path.normcase(os.environ['VIRTUAL_ENV']) |
|
890 | p_venv = os.path.normcase(os.environ['VIRTUAL_ENV']) | |
891 |
|
891 | |||
892 | # executable path should end like /bin/python or \\scripts\\python.exe |
|
892 | # executable path should end like /bin/python or \\scripts\\python.exe | |
893 | p_exe_up2 = os.path.dirname(os.path.dirname(p)) |
|
893 | p_exe_up2 = os.path.dirname(os.path.dirname(p)) | |
894 | if p_exe_up2 and os.path.exists(p_venv) and os.path.samefile(p_exe_up2, p_venv): |
|
894 | if p_exe_up2 and os.path.exists(p_venv) and os.path.samefile(p_exe_up2, p_venv): | |
895 | # Our exe is inside the virtualenv, don't need to do anything. |
|
895 | # Our exe is inside the virtualenv, don't need to do anything. | |
896 | return |
|
896 | return | |
897 |
|
897 | |||
898 | # fallback venv detection: |
|
898 | # fallback venv detection: | |
899 | # stdlib venv may symlink sys.executable, so we can't use realpath. |
|
899 | # stdlib venv may symlink sys.executable, so we can't use realpath. | |
900 | # but others can symlink *to* the venv Python, so we can't just use sys.executable. |
|
900 | # but others can symlink *to* the venv Python, so we can't just use sys.executable. | |
901 | # So we just check every item in the symlink tree (generally <= 3) |
|
901 | # So we just check every item in the symlink tree (generally <= 3) | |
902 | paths = [p] |
|
902 | paths = [p] | |
903 | while os.path.islink(p): |
|
903 | while os.path.islink(p): | |
904 | p = os.path.normcase(os.path.join(os.path.dirname(p), os.readlink(p))) |
|
904 | p = os.path.normcase(os.path.join(os.path.dirname(p), os.readlink(p))) | |
905 | paths.append(p) |
|
905 | paths.append(p) | |
906 |
|
906 | |||
907 | # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible |
|
907 | # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible | |
908 | if p_venv.startswith('\\cygdrive'): |
|
908 | if p_venv.startswith('\\cygdrive'): | |
909 | p_venv = p_venv[11:] |
|
909 | p_venv = p_venv[11:] | |
910 | elif len(p_venv) >= 2 and p_venv[1] == ':': |
|
910 | elif len(p_venv) >= 2 and p_venv[1] == ':': | |
911 | p_venv = p_venv[2:] |
|
911 | p_venv = p_venv[2:] | |
912 |
|
912 | |||
913 | if any(p_venv in p for p in paths): |
|
913 | if any(p_venv in p for p in paths): | |
914 | # Running properly in the virtualenv, don't need to do anything |
|
914 | # Running properly in the virtualenv, don't need to do anything | |
915 | return |
|
915 | return | |
916 |
|
916 | |||
917 | warn("Attempting to work in a virtualenv. If you encounter problems, please " |
|
917 | warn("Attempting to work in a virtualenv. If you encounter problems, please " | |
918 | "install IPython inside the virtualenv.") |
|
918 | "install IPython inside the virtualenv.") | |
919 | if sys.platform == "win32": |
|
919 | if sys.platform == "win32": | |
920 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages') |
|
920 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages') | |
921 | else: |
|
921 | else: | |
922 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib', |
|
922 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib', | |
923 | 'python%d.%d' % sys.version_info[:2], 'site-packages') |
|
923 | 'python%d.%d' % sys.version_info[:2], 'site-packages') | |
924 |
|
924 | |||
925 | import site |
|
925 | import site | |
926 | sys.path.insert(0, virtual_env) |
|
926 | sys.path.insert(0, virtual_env) | |
927 | site.addsitedir(virtual_env) |
|
927 | site.addsitedir(virtual_env) | |
928 |
|
928 | |||
929 | #------------------------------------------------------------------------- |
|
929 | #------------------------------------------------------------------------- | |
930 | # Things related to injections into the sys module |
|
930 | # Things related to injections into the sys module | |
931 | #------------------------------------------------------------------------- |
|
931 | #------------------------------------------------------------------------- | |
932 |
|
932 | |||
933 | def save_sys_module_state(self): |
|
933 | def save_sys_module_state(self): | |
934 | """Save the state of hooks in the sys module. |
|
934 | """Save the state of hooks in the sys module. | |
935 |
|
935 | |||
936 | This has to be called after self.user_module is created. |
|
936 | This has to be called after self.user_module is created. | |
937 | """ |
|
937 | """ | |
938 | self._orig_sys_module_state = {'stdin': sys.stdin, |
|
938 | self._orig_sys_module_state = {'stdin': sys.stdin, | |
939 | 'stdout': sys.stdout, |
|
939 | 'stdout': sys.stdout, | |
940 | 'stderr': sys.stderr, |
|
940 | 'stderr': sys.stderr, | |
941 | 'excepthook': sys.excepthook} |
|
941 | 'excepthook': sys.excepthook} | |
942 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
942 | self._orig_sys_modules_main_name = self.user_module.__name__ | |
943 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) |
|
943 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) | |
944 |
|
944 | |||
945 | def restore_sys_module_state(self): |
|
945 | def restore_sys_module_state(self): | |
946 | """Restore the state of the sys module.""" |
|
946 | """Restore the state of the sys module.""" | |
947 | try: |
|
947 | try: | |
948 | for k, v in self._orig_sys_module_state.items(): |
|
948 | for k, v in self._orig_sys_module_state.items(): | |
949 | setattr(sys, k, v) |
|
949 | setattr(sys, k, v) | |
950 | except AttributeError: |
|
950 | except AttributeError: | |
951 | pass |
|
951 | pass | |
952 | # Reset what what done in self.init_sys_modules |
|
952 | # Reset what what done in self.init_sys_modules | |
953 | if self._orig_sys_modules_main_mod is not None: |
|
953 | if self._orig_sys_modules_main_mod is not None: | |
954 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod |
|
954 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod | |
955 |
|
955 | |||
956 | #------------------------------------------------------------------------- |
|
956 | #------------------------------------------------------------------------- | |
957 | # Things related to the banner |
|
957 | # Things related to the banner | |
958 | #------------------------------------------------------------------------- |
|
958 | #------------------------------------------------------------------------- | |
959 |
|
959 | |||
960 | @property |
|
960 | @property | |
961 | def banner(self): |
|
961 | def banner(self): | |
962 | banner = self.banner1 |
|
962 | banner = self.banner1 | |
963 | if self.profile and self.profile != 'default': |
|
963 | if self.profile and self.profile != 'default': | |
964 | banner += '\nIPython profile: %s\n' % self.profile |
|
964 | banner += '\nIPython profile: %s\n' % self.profile | |
965 | if self.banner2: |
|
965 | if self.banner2: | |
966 | banner += '\n' + self.banner2 |
|
966 | banner += '\n' + self.banner2 | |
967 | return banner |
|
967 | return banner | |
968 |
|
968 | |||
969 | def show_banner(self, banner=None): |
|
969 | def show_banner(self, banner=None): | |
970 | if banner is None: |
|
970 | if banner is None: | |
971 | banner = self.banner |
|
971 | banner = self.banner | |
972 | sys.stdout.write(banner) |
|
972 | sys.stdout.write(banner) | |
973 |
|
973 | |||
974 | #------------------------------------------------------------------------- |
|
974 | #------------------------------------------------------------------------- | |
975 | # Things related to hooks |
|
975 | # Things related to hooks | |
976 | #------------------------------------------------------------------------- |
|
976 | #------------------------------------------------------------------------- | |
977 |
|
977 | |||
978 | def init_hooks(self): |
|
978 | def init_hooks(self): | |
979 | # hooks holds pointers used for user-side customizations |
|
979 | # hooks holds pointers used for user-side customizations | |
980 | self.hooks = Struct() |
|
980 | self.hooks = Struct() | |
981 |
|
981 | |||
982 | self.strdispatchers = {} |
|
982 | self.strdispatchers = {} | |
983 |
|
983 | |||
984 | # Set all default hooks, defined in the IPython.hooks module. |
|
984 | # Set all default hooks, defined in the IPython.hooks module. | |
985 | hooks = IPython.core.hooks |
|
985 | hooks = IPython.core.hooks | |
986 | for hook_name in hooks.__all__: |
|
986 | for hook_name in hooks.__all__: | |
987 | # default hooks have priority 100, i.e. low; user hooks should have |
|
987 | # default hooks have priority 100, i.e. low; user hooks should have | |
988 | # 0-100 priority |
|
988 | # 0-100 priority | |
989 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) |
|
989 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) | |
990 |
|
990 | |||
991 | if self.display_page: |
|
991 | if self.display_page: | |
992 | self.set_hook('show_in_pager', page.as_hook(page.display_page), 90) |
|
992 | self.set_hook('show_in_pager', page.as_hook(page.display_page), 90) | |
993 |
|
993 | |||
994 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, |
|
994 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, | |
995 | _warn_deprecated=True): |
|
995 | _warn_deprecated=True): | |
996 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
996 | """set_hook(name,hook) -> sets an internal IPython hook. | |
997 |
|
997 | |||
998 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
998 | IPython exposes some of its internal API as user-modifiable hooks. By | |
999 | adding your function to one of these hooks, you can modify IPython's |
|
999 | adding your function to one of these hooks, you can modify IPython's | |
1000 | behavior to call at runtime your own routines.""" |
|
1000 | behavior to call at runtime your own routines.""" | |
1001 |
|
1001 | |||
1002 | # At some point in the future, this should validate the hook before it |
|
1002 | # At some point in the future, this should validate the hook before it | |
1003 | # accepts it. Probably at least check that the hook takes the number |
|
1003 | # accepts it. Probably at least check that the hook takes the number | |
1004 | # of args it's supposed to. |
|
1004 | # of args it's supposed to. | |
1005 |
|
1005 | |||
1006 | f = types.MethodType(hook,self) |
|
1006 | f = types.MethodType(hook,self) | |
1007 |
|
1007 | |||
1008 | # check if the hook is for strdispatcher first |
|
1008 | # check if the hook is for strdispatcher first | |
1009 | if str_key is not None: |
|
1009 | if str_key is not None: | |
1010 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1010 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
1011 | sdp.add_s(str_key, f, priority ) |
|
1011 | sdp.add_s(str_key, f, priority ) | |
1012 | self.strdispatchers[name] = sdp |
|
1012 | self.strdispatchers[name] = sdp | |
1013 | return |
|
1013 | return | |
1014 | if re_key is not None: |
|
1014 | if re_key is not None: | |
1015 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1015 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
1016 | sdp.add_re(re.compile(re_key), f, priority ) |
|
1016 | sdp.add_re(re.compile(re_key), f, priority ) | |
1017 | self.strdispatchers[name] = sdp |
|
1017 | self.strdispatchers[name] = sdp | |
1018 | return |
|
1018 | return | |
1019 |
|
1019 | |||
1020 | dp = getattr(self.hooks, name, None) |
|
1020 | dp = getattr(self.hooks, name, None) | |
1021 | if name not in IPython.core.hooks.__all__: |
|
1021 | if name not in IPython.core.hooks.__all__: | |
1022 | print("Warning! Hook '%s' is not one of %s" % \ |
|
1022 | print("Warning! Hook '%s' is not one of %s" % \ | |
1023 | (name, IPython.core.hooks.__all__ )) |
|
1023 | (name, IPython.core.hooks.__all__ )) | |
1024 |
|
1024 | |||
1025 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): |
|
1025 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): | |
1026 | alternative = IPython.core.hooks.deprecated[name] |
|
1026 | alternative = IPython.core.hooks.deprecated[name] | |
1027 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2) |
|
1027 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2) | |
1028 |
|
1028 | |||
1029 | if not dp: |
|
1029 | if not dp: | |
1030 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
1030 | dp = IPython.core.hooks.CommandChainDispatcher() | |
1031 |
|
1031 | |||
1032 | try: |
|
1032 | try: | |
1033 | dp.add(f,priority) |
|
1033 | dp.add(f,priority) | |
1034 | except AttributeError: |
|
1034 | except AttributeError: | |
1035 | # it was not commandchain, plain old func - replace |
|
1035 | # it was not commandchain, plain old func - replace | |
1036 | dp = f |
|
1036 | dp = f | |
1037 |
|
1037 | |||
1038 | setattr(self.hooks,name, dp) |
|
1038 | setattr(self.hooks,name, dp) | |
1039 |
|
1039 | |||
1040 | #------------------------------------------------------------------------- |
|
1040 | #------------------------------------------------------------------------- | |
1041 | # Things related to events |
|
1041 | # Things related to events | |
1042 | #------------------------------------------------------------------------- |
|
1042 | #------------------------------------------------------------------------- | |
1043 |
|
1043 | |||
1044 | def init_events(self): |
|
1044 | def init_events(self): | |
1045 | self.events = EventManager(self, available_events) |
|
1045 | self.events = EventManager(self, available_events) | |
1046 |
|
1046 | |||
1047 | self.events.register("pre_execute", self._clear_warning_registry) |
|
1047 | self.events.register("pre_execute", self._clear_warning_registry) | |
1048 |
|
1048 | |||
1049 | def register_post_execute(self, func): |
|
1049 | def register_post_execute(self, func): | |
1050 | """DEPRECATED: Use ip.events.register('post_run_cell', func) |
|
1050 | """DEPRECATED: Use ip.events.register('post_run_cell', func) | |
1051 |
|
1051 | |||
1052 | Register a function for calling after code execution. |
|
1052 | Register a function for calling after code execution. | |
1053 | """ |
|
1053 | """ | |
1054 | warn("ip.register_post_execute is deprecated, use " |
|
1054 | warn("ip.register_post_execute is deprecated, use " | |
1055 | "ip.events.register('post_run_cell', func) instead.", stacklevel=2) |
|
1055 | "ip.events.register('post_run_cell', func) instead.", stacklevel=2) | |
1056 | self.events.register('post_run_cell', func) |
|
1056 | self.events.register('post_run_cell', func) | |
1057 |
|
1057 | |||
1058 | def _clear_warning_registry(self): |
|
1058 | def _clear_warning_registry(self): | |
1059 | # clear the warning registry, so that different code blocks with |
|
1059 | # clear the warning registry, so that different code blocks with | |
1060 | # overlapping line number ranges don't cause spurious suppression of |
|
1060 | # overlapping line number ranges don't cause spurious suppression of | |
1061 | # warnings (see gh-6611 for details) |
|
1061 | # warnings (see gh-6611 for details) | |
1062 | if "__warningregistry__" in self.user_global_ns: |
|
1062 | if "__warningregistry__" in self.user_global_ns: | |
1063 | del self.user_global_ns["__warningregistry__"] |
|
1063 | del self.user_global_ns["__warningregistry__"] | |
1064 |
|
1064 | |||
1065 | #------------------------------------------------------------------------- |
|
1065 | #------------------------------------------------------------------------- | |
1066 | # Things related to the "main" module |
|
1066 | # Things related to the "main" module | |
1067 | #------------------------------------------------------------------------- |
|
1067 | #------------------------------------------------------------------------- | |
1068 |
|
1068 | |||
1069 | def new_main_mod(self, filename, modname): |
|
1069 | def new_main_mod(self, filename, modname): | |
1070 | """Return a new 'main' module object for user code execution. |
|
1070 | """Return a new 'main' module object for user code execution. | |
1071 |
|
1071 | |||
1072 | ``filename`` should be the path of the script which will be run in the |
|
1072 | ``filename`` should be the path of the script which will be run in the | |
1073 | module. Requests with the same filename will get the same module, with |
|
1073 | module. Requests with the same filename will get the same module, with | |
1074 | its namespace cleared. |
|
1074 | its namespace cleared. | |
1075 |
|
1075 | |||
1076 | ``modname`` should be the module name - normally either '__main__' or |
|
1076 | ``modname`` should be the module name - normally either '__main__' or | |
1077 | the basename of the file without the extension. |
|
1077 | the basename of the file without the extension. | |
1078 |
|
1078 | |||
1079 | When scripts are executed via %run, we must keep a reference to their |
|
1079 | When scripts are executed via %run, we must keep a reference to their | |
1080 | __main__ module around so that Python doesn't |
|
1080 | __main__ module around so that Python doesn't | |
1081 | clear it, rendering references to module globals useless. |
|
1081 | clear it, rendering references to module globals useless. | |
1082 |
|
1082 | |||
1083 | This method keeps said reference in a private dict, keyed by the |
|
1083 | This method keeps said reference in a private dict, keyed by the | |
1084 | absolute path of the script. This way, for multiple executions of the |
|
1084 | absolute path of the script. This way, for multiple executions of the | |
1085 | same script we only keep one copy of the namespace (the last one), |
|
1085 | same script we only keep one copy of the namespace (the last one), | |
1086 | thus preventing memory leaks from old references while allowing the |
|
1086 | thus preventing memory leaks from old references while allowing the | |
1087 | objects from the last execution to be accessible. |
|
1087 | objects from the last execution to be accessible. | |
1088 | """ |
|
1088 | """ | |
1089 | filename = os.path.abspath(filename) |
|
1089 | filename = os.path.abspath(filename) | |
1090 | try: |
|
1090 | try: | |
1091 | main_mod = self._main_mod_cache[filename] |
|
1091 | main_mod = self._main_mod_cache[filename] | |
1092 | except KeyError: |
|
1092 | except KeyError: | |
1093 | main_mod = self._main_mod_cache[filename] = types.ModuleType( |
|
1093 | main_mod = self._main_mod_cache[filename] = types.ModuleType( | |
1094 | modname, |
|
1094 | modname, | |
1095 | doc="Module created for script run in IPython") |
|
1095 | doc="Module created for script run in IPython") | |
1096 | else: |
|
1096 | else: | |
1097 | main_mod.__dict__.clear() |
|
1097 | main_mod.__dict__.clear() | |
1098 | main_mod.__name__ = modname |
|
1098 | main_mod.__name__ = modname | |
1099 |
|
1099 | |||
1100 | main_mod.__file__ = filename |
|
1100 | main_mod.__file__ = filename | |
1101 | # It seems pydoc (and perhaps others) needs any module instance to |
|
1101 | # It seems pydoc (and perhaps others) needs any module instance to | |
1102 | # implement a __nonzero__ method |
|
1102 | # implement a __nonzero__ method | |
1103 | main_mod.__nonzero__ = lambda : True |
|
1103 | main_mod.__nonzero__ = lambda : True | |
1104 |
|
1104 | |||
1105 | return main_mod |
|
1105 | return main_mod | |
1106 |
|
1106 | |||
1107 | def clear_main_mod_cache(self): |
|
1107 | def clear_main_mod_cache(self): | |
1108 | """Clear the cache of main modules. |
|
1108 | """Clear the cache of main modules. | |
1109 |
|
1109 | |||
1110 | Mainly for use by utilities like %reset. |
|
1110 | Mainly for use by utilities like %reset. | |
1111 |
|
1111 | |||
1112 | Examples |
|
1112 | Examples | |
1113 | -------- |
|
1113 | -------- | |
1114 |
|
1114 | |||
1115 | In [15]: import IPython |
|
1115 | In [15]: import IPython | |
1116 |
|
1116 | |||
1117 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') |
|
1117 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') | |
1118 |
|
1118 | |||
1119 | In [17]: len(_ip._main_mod_cache) > 0 |
|
1119 | In [17]: len(_ip._main_mod_cache) > 0 | |
1120 | Out[17]: True |
|
1120 | Out[17]: True | |
1121 |
|
1121 | |||
1122 | In [18]: _ip.clear_main_mod_cache() |
|
1122 | In [18]: _ip.clear_main_mod_cache() | |
1123 |
|
1123 | |||
1124 | In [19]: len(_ip._main_mod_cache) == 0 |
|
1124 | In [19]: len(_ip._main_mod_cache) == 0 | |
1125 | Out[19]: True |
|
1125 | Out[19]: True | |
1126 | """ |
|
1126 | """ | |
1127 | self._main_mod_cache.clear() |
|
1127 | self._main_mod_cache.clear() | |
1128 |
|
1128 | |||
1129 | #------------------------------------------------------------------------- |
|
1129 | #------------------------------------------------------------------------- | |
1130 | # Things related to debugging |
|
1130 | # Things related to debugging | |
1131 | #------------------------------------------------------------------------- |
|
1131 | #------------------------------------------------------------------------- | |
1132 |
|
1132 | |||
1133 | def init_pdb(self): |
|
1133 | def init_pdb(self): | |
1134 | # Set calling of pdb on exceptions |
|
1134 | # Set calling of pdb on exceptions | |
1135 | # self.call_pdb is a property |
|
1135 | # self.call_pdb is a property | |
1136 | self.call_pdb = self.pdb |
|
1136 | self.call_pdb = self.pdb | |
1137 |
|
1137 | |||
1138 | def _get_call_pdb(self): |
|
1138 | def _get_call_pdb(self): | |
1139 | return self._call_pdb |
|
1139 | return self._call_pdb | |
1140 |
|
1140 | |||
1141 | def _set_call_pdb(self,val): |
|
1141 | def _set_call_pdb(self,val): | |
1142 |
|
1142 | |||
1143 | if val not in (0,1,False,True): |
|
1143 | if val not in (0,1,False,True): | |
1144 | raise ValueError('new call_pdb value must be boolean') |
|
1144 | raise ValueError('new call_pdb value must be boolean') | |
1145 |
|
1145 | |||
1146 | # store value in instance |
|
1146 | # store value in instance | |
1147 | self._call_pdb = val |
|
1147 | self._call_pdb = val | |
1148 |
|
1148 | |||
1149 | # notify the actual exception handlers |
|
1149 | # notify the actual exception handlers | |
1150 | self.InteractiveTB.call_pdb = val |
|
1150 | self.InteractiveTB.call_pdb = val | |
1151 |
|
1151 | |||
1152 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
1152 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
1153 | 'Control auto-activation of pdb at exceptions') |
|
1153 | 'Control auto-activation of pdb at exceptions') | |
1154 |
|
1154 | |||
1155 | def debugger(self,force=False): |
|
1155 | def debugger(self,force=False): | |
1156 | """Call the pdb debugger. |
|
1156 | """Call the pdb debugger. | |
1157 |
|
1157 | |||
1158 | Keywords: |
|
1158 | Keywords: | |
1159 |
|
1159 | |||
1160 | - force(False): by default, this routine checks the instance call_pdb |
|
1160 | - force(False): by default, this routine checks the instance call_pdb | |
1161 | flag and does not actually invoke the debugger if the flag is false. |
|
1161 | flag and does not actually invoke the debugger if the flag is false. | |
1162 | The 'force' option forces the debugger to activate even if the flag |
|
1162 | The 'force' option forces the debugger to activate even if the flag | |
1163 | is false. |
|
1163 | is false. | |
1164 | """ |
|
1164 | """ | |
1165 |
|
1165 | |||
1166 | if not (force or self.call_pdb): |
|
1166 | if not (force or self.call_pdb): | |
1167 | return |
|
1167 | return | |
1168 |
|
1168 | |||
1169 | if not hasattr(sys,'last_traceback'): |
|
1169 | if not hasattr(sys,'last_traceback'): | |
1170 | error('No traceback has been produced, nothing to debug.') |
|
1170 | error('No traceback has been produced, nothing to debug.') | |
1171 | return |
|
1171 | return | |
1172 |
|
1172 | |||
1173 | self.InteractiveTB.debugger(force=True) |
|
1173 | self.InteractiveTB.debugger(force=True) | |
1174 |
|
1174 | |||
1175 | #------------------------------------------------------------------------- |
|
1175 | #------------------------------------------------------------------------- | |
1176 | # Things related to IPython's various namespaces |
|
1176 | # Things related to IPython's various namespaces | |
1177 | #------------------------------------------------------------------------- |
|
1177 | #------------------------------------------------------------------------- | |
1178 | default_user_namespaces = True |
|
1178 | default_user_namespaces = True | |
1179 |
|
1179 | |||
1180 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
1180 | def init_create_namespaces(self, user_module=None, user_ns=None): | |
1181 | # Create the namespace where the user will operate. user_ns is |
|
1181 | # Create the namespace where the user will operate. user_ns is | |
1182 | # normally the only one used, and it is passed to the exec calls as |
|
1182 | # normally the only one used, and it is passed to the exec calls as | |
1183 | # the locals argument. But we do carry a user_global_ns namespace |
|
1183 | # the locals argument. But we do carry a user_global_ns namespace | |
1184 | # given as the exec 'globals' argument, This is useful in embedding |
|
1184 | # given as the exec 'globals' argument, This is useful in embedding | |
1185 | # situations where the ipython shell opens in a context where the |
|
1185 | # situations where the ipython shell opens in a context where the | |
1186 | # distinction between locals and globals is meaningful. For |
|
1186 | # distinction between locals and globals is meaningful. For | |
1187 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
1187 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
1188 |
|
1188 | |||
1189 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
1189 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
1190 | # level as a dict instead of a module. This is a manual fix, but I |
|
1190 | # level as a dict instead of a module. This is a manual fix, but I | |
1191 | # should really track down where the problem is coming from. Alex |
|
1191 | # should really track down where the problem is coming from. Alex | |
1192 | # Schmolck reported this problem first. |
|
1192 | # Schmolck reported this problem first. | |
1193 |
|
1193 | |||
1194 | # A useful post by Alex Martelli on this topic: |
|
1194 | # A useful post by Alex Martelli on this topic: | |
1195 | # Re: inconsistent value from __builtins__ |
|
1195 | # Re: inconsistent value from __builtins__ | |
1196 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
1196 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
1197 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
1197 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
1198 | # Gruppen: comp.lang.python |
|
1198 | # Gruppen: comp.lang.python | |
1199 |
|
1199 | |||
1200 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
1200 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
1201 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
1201 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
1202 | # > <type 'dict'> |
|
1202 | # > <type 'dict'> | |
1203 | # > >>> print type(__builtins__) |
|
1203 | # > >>> print type(__builtins__) | |
1204 | # > <type 'module'> |
|
1204 | # > <type 'module'> | |
1205 | # > Is this difference in return value intentional? |
|
1205 | # > Is this difference in return value intentional? | |
1206 |
|
1206 | |||
1207 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
1207 | # Well, it's documented that '__builtins__' can be either a dictionary | |
1208 | # or a module, and it's been that way for a long time. Whether it's |
|
1208 | # or a module, and it's been that way for a long time. Whether it's | |
1209 | # intentional (or sensible), I don't know. In any case, the idea is |
|
1209 | # intentional (or sensible), I don't know. In any case, the idea is | |
1210 | # that if you need to access the built-in namespace directly, you |
|
1210 | # that if you need to access the built-in namespace directly, you | |
1211 | # should start with "import __builtin__" (note, no 's') which will |
|
1211 | # should start with "import __builtin__" (note, no 's') which will | |
1212 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
1212 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
1213 |
|
1213 | |||
1214 | # These routines return a properly built module and dict as needed by |
|
1214 | # These routines return a properly built module and dict as needed by | |
1215 | # the rest of the code, and can also be used by extension writers to |
|
1215 | # the rest of the code, and can also be used by extension writers to | |
1216 | # generate properly initialized namespaces. |
|
1216 | # generate properly initialized namespaces. | |
1217 | if (user_ns is not None) or (user_module is not None): |
|
1217 | if (user_ns is not None) or (user_module is not None): | |
1218 | self.default_user_namespaces = False |
|
1218 | self.default_user_namespaces = False | |
1219 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
1219 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) | |
1220 |
|
1220 | |||
1221 | # A record of hidden variables we have added to the user namespace, so |
|
1221 | # A record of hidden variables we have added to the user namespace, so | |
1222 | # we can list later only variables defined in actual interactive use. |
|
1222 | # we can list later only variables defined in actual interactive use. | |
1223 | self.user_ns_hidden = {} |
|
1223 | self.user_ns_hidden = {} | |
1224 |
|
1224 | |||
1225 | # Now that FakeModule produces a real module, we've run into a nasty |
|
1225 | # Now that FakeModule produces a real module, we've run into a nasty | |
1226 | # problem: after script execution (via %run), the module where the user |
|
1226 | # problem: after script execution (via %run), the module where the user | |
1227 | # code ran is deleted. Now that this object is a true module (needed |
|
1227 | # code ran is deleted. Now that this object is a true module (needed | |
1228 | # so doctest and other tools work correctly), the Python module |
|
1228 | # so doctest and other tools work correctly), the Python module | |
1229 | # teardown mechanism runs over it, and sets to None every variable |
|
1229 | # teardown mechanism runs over it, and sets to None every variable | |
1230 | # present in that module. Top-level references to objects from the |
|
1230 | # present in that module. Top-level references to objects from the | |
1231 | # script survive, because the user_ns is updated with them. However, |
|
1231 | # script survive, because the user_ns is updated with them. However, | |
1232 | # calling functions defined in the script that use other things from |
|
1232 | # calling functions defined in the script that use other things from | |
1233 | # the script will fail, because the function's closure had references |
|
1233 | # the script will fail, because the function's closure had references | |
1234 | # to the original objects, which are now all None. So we must protect |
|
1234 | # to the original objects, which are now all None. So we must protect | |
1235 | # these modules from deletion by keeping a cache. |
|
1235 | # these modules from deletion by keeping a cache. | |
1236 | # |
|
1236 | # | |
1237 | # To avoid keeping stale modules around (we only need the one from the |
|
1237 | # To avoid keeping stale modules around (we only need the one from the | |
1238 | # last run), we use a dict keyed with the full path to the script, so |
|
1238 | # last run), we use a dict keyed with the full path to the script, so | |
1239 | # only the last version of the module is held in the cache. Note, |
|
1239 | # only the last version of the module is held in the cache. Note, | |
1240 | # however, that we must cache the module *namespace contents* (their |
|
1240 | # however, that we must cache the module *namespace contents* (their | |
1241 | # __dict__). Because if we try to cache the actual modules, old ones |
|
1241 | # __dict__). Because if we try to cache the actual modules, old ones | |
1242 | # (uncached) could be destroyed while still holding references (such as |
|
1242 | # (uncached) could be destroyed while still holding references (such as | |
1243 | # those held by GUI objects that tend to be long-lived)> |
|
1243 | # those held by GUI objects that tend to be long-lived)> | |
1244 | # |
|
1244 | # | |
1245 | # The %reset command will flush this cache. See the cache_main_mod() |
|
1245 | # The %reset command will flush this cache. See the cache_main_mod() | |
1246 | # and clear_main_mod_cache() methods for details on use. |
|
1246 | # and clear_main_mod_cache() methods for details on use. | |
1247 |
|
1247 | |||
1248 | # This is the cache used for 'main' namespaces |
|
1248 | # This is the cache used for 'main' namespaces | |
1249 | self._main_mod_cache = {} |
|
1249 | self._main_mod_cache = {} | |
1250 |
|
1250 | |||
1251 | # A table holding all the namespaces IPython deals with, so that |
|
1251 | # A table holding all the namespaces IPython deals with, so that | |
1252 | # introspection facilities can search easily. |
|
1252 | # introspection facilities can search easily. | |
1253 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
1253 | self.ns_table = {'user_global':self.user_module.__dict__, | |
1254 | 'user_local':self.user_ns, |
|
1254 | 'user_local':self.user_ns, | |
1255 | 'builtin':builtin_mod.__dict__ |
|
1255 | 'builtin':builtin_mod.__dict__ | |
1256 | } |
|
1256 | } | |
1257 |
|
1257 | |||
1258 | @property |
|
1258 | @property | |
1259 | def user_global_ns(self): |
|
1259 | def user_global_ns(self): | |
1260 | return self.user_module.__dict__ |
|
1260 | return self.user_module.__dict__ | |
1261 |
|
1261 | |||
1262 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
1262 | def prepare_user_module(self, user_module=None, user_ns=None): | |
1263 | """Prepare the module and namespace in which user code will be run. |
|
1263 | """Prepare the module and namespace in which user code will be run. | |
1264 |
|
1264 | |||
1265 | When IPython is started normally, both parameters are None: a new module |
|
1265 | When IPython is started normally, both parameters are None: a new module | |
1266 | is created automatically, and its __dict__ used as the namespace. |
|
1266 | is created automatically, and its __dict__ used as the namespace. | |
1267 |
|
1267 | |||
1268 | If only user_module is provided, its __dict__ is used as the namespace. |
|
1268 | If only user_module is provided, its __dict__ is used as the namespace. | |
1269 | If only user_ns is provided, a dummy module is created, and user_ns |
|
1269 | If only user_ns is provided, a dummy module is created, and user_ns | |
1270 | becomes the global namespace. If both are provided (as they may be |
|
1270 | becomes the global namespace. If both are provided (as they may be | |
1271 | when embedding), user_ns is the local namespace, and user_module |
|
1271 | when embedding), user_ns is the local namespace, and user_module | |
1272 | provides the global namespace. |
|
1272 | provides the global namespace. | |
1273 |
|
1273 | |||
1274 | Parameters |
|
1274 | Parameters | |
1275 | ---------- |
|
1275 | ---------- | |
1276 | user_module : module, optional |
|
1276 | user_module : module, optional | |
1277 | The current user module in which IPython is being run. If None, |
|
1277 | The current user module in which IPython is being run. If None, | |
1278 | a clean module will be created. |
|
1278 | a clean module will be created. | |
1279 | user_ns : dict, optional |
|
1279 | user_ns : dict, optional | |
1280 | A namespace in which to run interactive commands. |
|
1280 | A namespace in which to run interactive commands. | |
1281 |
|
1281 | |||
1282 | Returns |
|
1282 | Returns | |
1283 | ------- |
|
1283 | ------- | |
1284 | A tuple of user_module and user_ns, each properly initialised. |
|
1284 | A tuple of user_module and user_ns, each properly initialised. | |
1285 | """ |
|
1285 | """ | |
1286 | if user_module is None and user_ns is not None: |
|
1286 | if user_module is None and user_ns is not None: | |
1287 | user_ns.setdefault("__name__", "__main__") |
|
1287 | user_ns.setdefault("__name__", "__main__") | |
1288 | user_module = DummyMod() |
|
1288 | user_module = DummyMod() | |
1289 | user_module.__dict__ = user_ns |
|
1289 | user_module.__dict__ = user_ns | |
1290 |
|
1290 | |||
1291 | if user_module is None: |
|
1291 | if user_module is None: | |
1292 | user_module = types.ModuleType("__main__", |
|
1292 | user_module = types.ModuleType("__main__", | |
1293 | doc="Automatically created module for IPython interactive environment") |
|
1293 | doc="Automatically created module for IPython interactive environment") | |
1294 |
|
1294 | |||
1295 | # We must ensure that __builtin__ (without the final 's') is always |
|
1295 | # We must ensure that __builtin__ (without the final 's') is always | |
1296 | # available and pointing to the __builtin__ *module*. For more details: |
|
1296 | # available and pointing to the __builtin__ *module*. For more details: | |
1297 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1297 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1298 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
1298 | user_module.__dict__.setdefault('__builtin__', builtin_mod) | |
1299 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
1299 | user_module.__dict__.setdefault('__builtins__', builtin_mod) | |
1300 |
|
1300 | |||
1301 | if user_ns is None: |
|
1301 | if user_ns is None: | |
1302 | user_ns = user_module.__dict__ |
|
1302 | user_ns = user_module.__dict__ | |
1303 |
|
1303 | |||
1304 | return user_module, user_ns |
|
1304 | return user_module, user_ns | |
1305 |
|
1305 | |||
1306 | def init_sys_modules(self): |
|
1306 | def init_sys_modules(self): | |
1307 | # We need to insert into sys.modules something that looks like a |
|
1307 | # We need to insert into sys.modules something that looks like a | |
1308 | # module but which accesses the IPython namespace, for shelve and |
|
1308 | # module but which accesses the IPython namespace, for shelve and | |
1309 | # pickle to work interactively. Normally they rely on getting |
|
1309 | # pickle to work interactively. Normally they rely on getting | |
1310 | # everything out of __main__, but for embedding purposes each IPython |
|
1310 | # everything out of __main__, but for embedding purposes each IPython | |
1311 | # instance has its own private namespace, so we can't go shoving |
|
1311 | # instance has its own private namespace, so we can't go shoving | |
1312 | # everything into __main__. |
|
1312 | # everything into __main__. | |
1313 |
|
1313 | |||
1314 | # note, however, that we should only do this for non-embedded |
|
1314 | # note, however, that we should only do this for non-embedded | |
1315 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1315 | # ipythons, which really mimic the __main__.__dict__ with their own | |
1316 | # namespace. Embedded instances, on the other hand, should not do |
|
1316 | # namespace. Embedded instances, on the other hand, should not do | |
1317 | # this because they need to manage the user local/global namespaces |
|
1317 | # this because they need to manage the user local/global namespaces | |
1318 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1318 | # only, but they live within a 'normal' __main__ (meaning, they | |
1319 | # shouldn't overtake the execution environment of the script they're |
|
1319 | # shouldn't overtake the execution environment of the script they're | |
1320 | # embedded in). |
|
1320 | # embedded in). | |
1321 |
|
1321 | |||
1322 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1322 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
1323 | main_name = self.user_module.__name__ |
|
1323 | main_name = self.user_module.__name__ | |
1324 | sys.modules[main_name] = self.user_module |
|
1324 | sys.modules[main_name] = self.user_module | |
1325 |
|
1325 | |||
1326 | def init_user_ns(self): |
|
1326 | def init_user_ns(self): | |
1327 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1327 | """Initialize all user-visible namespaces to their minimum defaults. | |
1328 |
|
1328 | |||
1329 | Certain history lists are also initialized here, as they effectively |
|
1329 | Certain history lists are also initialized here, as they effectively | |
1330 | act as user namespaces. |
|
1330 | act as user namespaces. | |
1331 |
|
1331 | |||
1332 | Notes |
|
1332 | Notes | |
1333 | ----- |
|
1333 | ----- | |
1334 | All data structures here are only filled in, they are NOT reset by this |
|
1334 | All data structures here are only filled in, they are NOT reset by this | |
1335 | method. If they were not empty before, data will simply be added to |
|
1335 | method. If they were not empty before, data will simply be added to | |
1336 | them. |
|
1336 | them. | |
1337 | """ |
|
1337 | """ | |
1338 | # This function works in two parts: first we put a few things in |
|
1338 | # This function works in two parts: first we put a few things in | |
1339 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1339 | # user_ns, and we sync that contents into user_ns_hidden so that these | |
1340 | # initial variables aren't shown by %who. After the sync, we add the |
|
1340 | # initial variables aren't shown by %who. After the sync, we add the | |
1341 | # rest of what we *do* want the user to see with %who even on a new |
|
1341 | # rest of what we *do* want the user to see with %who even on a new | |
1342 | # session (probably nothing, so they really only see their own stuff) |
|
1342 | # session (probably nothing, so they really only see their own stuff) | |
1343 |
|
1343 | |||
1344 | # The user dict must *always* have a __builtin__ reference to the |
|
1344 | # The user dict must *always* have a __builtin__ reference to the | |
1345 | # Python standard __builtin__ namespace, which must be imported. |
|
1345 | # Python standard __builtin__ namespace, which must be imported. | |
1346 | # This is so that certain operations in prompt evaluation can be |
|
1346 | # This is so that certain operations in prompt evaluation can be | |
1347 | # reliably executed with builtins. Note that we can NOT use |
|
1347 | # reliably executed with builtins. Note that we can NOT use | |
1348 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1348 | # __builtins__ (note the 's'), because that can either be a dict or a | |
1349 | # module, and can even mutate at runtime, depending on the context |
|
1349 | # module, and can even mutate at runtime, depending on the context | |
1350 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1350 | # (Python makes no guarantees on it). In contrast, __builtin__ is | |
1351 | # always a module object, though it must be explicitly imported. |
|
1351 | # always a module object, though it must be explicitly imported. | |
1352 |
|
1352 | |||
1353 | # For more details: |
|
1353 | # For more details: | |
1354 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1354 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1355 | ns = {} |
|
1355 | ns = {} | |
1356 |
|
1356 | |||
1357 | # make global variables for user access to the histories |
|
1357 | # make global variables for user access to the histories | |
1358 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1358 | ns['_ih'] = self.history_manager.input_hist_parsed | |
1359 | ns['_oh'] = self.history_manager.output_hist |
|
1359 | ns['_oh'] = self.history_manager.output_hist | |
1360 | ns['_dh'] = self.history_manager.dir_hist |
|
1360 | ns['_dh'] = self.history_manager.dir_hist | |
1361 |
|
1361 | |||
1362 | # user aliases to input and output histories. These shouldn't show up |
|
1362 | # user aliases to input and output histories. These shouldn't show up | |
1363 | # in %who, as they can have very large reprs. |
|
1363 | # in %who, as they can have very large reprs. | |
1364 | ns['In'] = self.history_manager.input_hist_parsed |
|
1364 | ns['In'] = self.history_manager.input_hist_parsed | |
1365 | ns['Out'] = self.history_manager.output_hist |
|
1365 | ns['Out'] = self.history_manager.output_hist | |
1366 |
|
1366 | |||
1367 | # Store myself as the public api!!! |
|
1367 | # Store myself as the public api!!! | |
1368 | ns['get_ipython'] = self.get_ipython |
|
1368 | ns['get_ipython'] = self.get_ipython | |
1369 |
|
1369 | |||
1370 | ns['exit'] = self.exiter |
|
1370 | ns['exit'] = self.exiter | |
1371 | ns['quit'] = self.exiter |
|
1371 | ns['quit'] = self.exiter | |
1372 |
|
1372 | |||
1373 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1373 | # Sync what we've added so far to user_ns_hidden so these aren't seen | |
1374 | # by %who |
|
1374 | # by %who | |
1375 | self.user_ns_hidden.update(ns) |
|
1375 | self.user_ns_hidden.update(ns) | |
1376 |
|
1376 | |||
1377 | # Anything put into ns now would show up in %who. Think twice before |
|
1377 | # Anything put into ns now would show up in %who. Think twice before | |
1378 | # putting anything here, as we really want %who to show the user their |
|
1378 | # putting anything here, as we really want %who to show the user their | |
1379 | # stuff, not our variables. |
|
1379 | # stuff, not our variables. | |
1380 |
|
1380 | |||
1381 | # Finally, update the real user's namespace |
|
1381 | # Finally, update the real user's namespace | |
1382 | self.user_ns.update(ns) |
|
1382 | self.user_ns.update(ns) | |
1383 |
|
1383 | |||
1384 | @property |
|
1384 | @property | |
1385 | def all_ns_refs(self): |
|
1385 | def all_ns_refs(self): | |
1386 | """Get a list of references to all the namespace dictionaries in which |
|
1386 | """Get a list of references to all the namespace dictionaries in which | |
1387 | IPython might store a user-created object. |
|
1387 | IPython might store a user-created object. | |
1388 |
|
1388 | |||
1389 | Note that this does not include the displayhook, which also caches |
|
1389 | Note that this does not include the displayhook, which also caches | |
1390 | objects from the output.""" |
|
1390 | objects from the output.""" | |
1391 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ |
|
1391 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ | |
1392 | [m.__dict__ for m in self._main_mod_cache.values()] |
|
1392 | [m.__dict__ for m in self._main_mod_cache.values()] | |
1393 |
|
1393 | |||
1394 | def reset(self, new_session=True): |
|
1394 | def reset(self, new_session=True): | |
1395 | """Clear all internal namespaces, and attempt to release references to |
|
1395 | """Clear all internal namespaces, and attempt to release references to | |
1396 | user objects. |
|
1396 | user objects. | |
1397 |
|
1397 | |||
1398 | If new_session is True, a new history session will be opened. |
|
1398 | If new_session is True, a new history session will be opened. | |
1399 | """ |
|
1399 | """ | |
1400 | # Clear histories |
|
1400 | # Clear histories | |
1401 | self.history_manager.reset(new_session) |
|
1401 | self.history_manager.reset(new_session) | |
1402 | # Reset counter used to index all histories |
|
1402 | # Reset counter used to index all histories | |
1403 | if new_session: |
|
1403 | if new_session: | |
1404 | self.execution_count = 1 |
|
1404 | self.execution_count = 1 | |
1405 |
|
1405 | |||
1406 | # Reset last execution result |
|
1406 | # Reset last execution result | |
1407 | self.last_execution_succeeded = True |
|
1407 | self.last_execution_succeeded = True | |
1408 | self.last_execution_result = None |
|
1408 | self.last_execution_result = None | |
1409 |
|
1409 | |||
1410 | # Flush cached output items |
|
1410 | # Flush cached output items | |
1411 | if self.displayhook.do_full_cache: |
|
1411 | if self.displayhook.do_full_cache: | |
1412 | self.displayhook.flush() |
|
1412 | self.displayhook.flush() | |
1413 |
|
1413 | |||
1414 | # The main execution namespaces must be cleared very carefully, |
|
1414 | # The main execution namespaces must be cleared very carefully, | |
1415 | # skipping the deletion of the builtin-related keys, because doing so |
|
1415 | # skipping the deletion of the builtin-related keys, because doing so | |
1416 | # would cause errors in many object's __del__ methods. |
|
1416 | # would cause errors in many object's __del__ methods. | |
1417 | if self.user_ns is not self.user_global_ns: |
|
1417 | if self.user_ns is not self.user_global_ns: | |
1418 | self.user_ns.clear() |
|
1418 | self.user_ns.clear() | |
1419 | ns = self.user_global_ns |
|
1419 | ns = self.user_global_ns | |
1420 | drop_keys = set(ns.keys()) |
|
1420 | drop_keys = set(ns.keys()) | |
1421 | drop_keys.discard('__builtin__') |
|
1421 | drop_keys.discard('__builtin__') | |
1422 | drop_keys.discard('__builtins__') |
|
1422 | drop_keys.discard('__builtins__') | |
1423 | drop_keys.discard('__name__') |
|
1423 | drop_keys.discard('__name__') | |
1424 | for k in drop_keys: |
|
1424 | for k in drop_keys: | |
1425 | del ns[k] |
|
1425 | del ns[k] | |
1426 |
|
1426 | |||
1427 | self.user_ns_hidden.clear() |
|
1427 | self.user_ns_hidden.clear() | |
1428 |
|
1428 | |||
1429 | # Restore the user namespaces to minimal usability |
|
1429 | # Restore the user namespaces to minimal usability | |
1430 | self.init_user_ns() |
|
1430 | self.init_user_ns() | |
1431 |
|
1431 | |||
1432 | # Restore the default and user aliases |
|
1432 | # Restore the default and user aliases | |
1433 | self.alias_manager.clear_aliases() |
|
1433 | self.alias_manager.clear_aliases() | |
1434 | self.alias_manager.init_aliases() |
|
1434 | self.alias_manager.init_aliases() | |
1435 |
|
1435 | |||
1436 | # Flush the private list of module references kept for script |
|
1436 | # Flush the private list of module references kept for script | |
1437 | # execution protection |
|
1437 | # execution protection | |
1438 | self.clear_main_mod_cache() |
|
1438 | self.clear_main_mod_cache() | |
1439 |
|
1439 | |||
1440 | def del_var(self, varname, by_name=False): |
|
1440 | def del_var(self, varname, by_name=False): | |
1441 | """Delete a variable from the various namespaces, so that, as |
|
1441 | """Delete a variable from the various namespaces, so that, as | |
1442 | far as possible, we're not keeping any hidden references to it. |
|
1442 | far as possible, we're not keeping any hidden references to it. | |
1443 |
|
1443 | |||
1444 | Parameters |
|
1444 | Parameters | |
1445 | ---------- |
|
1445 | ---------- | |
1446 | varname : str |
|
1446 | varname : str | |
1447 | The name of the variable to delete. |
|
1447 | The name of the variable to delete. | |
1448 | by_name : bool |
|
1448 | by_name : bool | |
1449 | If True, delete variables with the given name in each |
|
1449 | If True, delete variables with the given name in each | |
1450 | namespace. If False (default), find the variable in the user |
|
1450 | namespace. If False (default), find the variable in the user | |
1451 | namespace, and delete references to it. |
|
1451 | namespace, and delete references to it. | |
1452 | """ |
|
1452 | """ | |
1453 | if varname in ('__builtin__', '__builtins__'): |
|
1453 | if varname in ('__builtin__', '__builtins__'): | |
1454 | raise ValueError("Refusing to delete %s" % varname) |
|
1454 | raise ValueError("Refusing to delete %s" % varname) | |
1455 |
|
1455 | |||
1456 | ns_refs = self.all_ns_refs |
|
1456 | ns_refs = self.all_ns_refs | |
1457 |
|
1457 | |||
1458 | if by_name: # Delete by name |
|
1458 | if by_name: # Delete by name | |
1459 | for ns in ns_refs: |
|
1459 | for ns in ns_refs: | |
1460 | try: |
|
1460 | try: | |
1461 | del ns[varname] |
|
1461 | del ns[varname] | |
1462 | except KeyError: |
|
1462 | except KeyError: | |
1463 | pass |
|
1463 | pass | |
1464 | else: # Delete by object |
|
1464 | else: # Delete by object | |
1465 | try: |
|
1465 | try: | |
1466 | obj = self.user_ns[varname] |
|
1466 | obj = self.user_ns[varname] | |
1467 | except KeyError: |
|
1467 | except KeyError: | |
1468 | raise NameError("name '%s' is not defined" % varname) |
|
1468 | raise NameError("name '%s' is not defined" % varname) | |
1469 | # Also check in output history |
|
1469 | # Also check in output history | |
1470 | ns_refs.append(self.history_manager.output_hist) |
|
1470 | ns_refs.append(self.history_manager.output_hist) | |
1471 | for ns in ns_refs: |
|
1471 | for ns in ns_refs: | |
1472 | to_delete = [n for n, o in ns.items() if o is obj] |
|
1472 | to_delete = [n for n, o in ns.items() if o is obj] | |
1473 | for name in to_delete: |
|
1473 | for name in to_delete: | |
1474 | del ns[name] |
|
1474 | del ns[name] | |
1475 |
|
1475 | |||
1476 | # Ensure it is removed from the last execution result |
|
1476 | # Ensure it is removed from the last execution result | |
1477 | if self.last_execution_result.result is obj: |
|
1477 | if self.last_execution_result.result is obj: | |
1478 | self.last_execution_result = None |
|
1478 | self.last_execution_result = None | |
1479 |
|
1479 | |||
1480 | # displayhook keeps extra references, but not in a dictionary |
|
1480 | # displayhook keeps extra references, but not in a dictionary | |
1481 | for name in ('_', '__', '___'): |
|
1481 | for name in ('_', '__', '___'): | |
1482 | if getattr(self.displayhook, name) is obj: |
|
1482 | if getattr(self.displayhook, name) is obj: | |
1483 | setattr(self.displayhook, name, None) |
|
1483 | setattr(self.displayhook, name, None) | |
1484 |
|
1484 | |||
1485 | def reset_selective(self, regex=None): |
|
1485 | def reset_selective(self, regex=None): | |
1486 | """Clear selective variables from internal namespaces based on a |
|
1486 | """Clear selective variables from internal namespaces based on a | |
1487 | specified regular expression. |
|
1487 | specified regular expression. | |
1488 |
|
1488 | |||
1489 | Parameters |
|
1489 | Parameters | |
1490 | ---------- |
|
1490 | ---------- | |
1491 | regex : string or compiled pattern, optional |
|
1491 | regex : string or compiled pattern, optional | |
1492 | A regular expression pattern that will be used in searching |
|
1492 | A regular expression pattern that will be used in searching | |
1493 | variable names in the users namespaces. |
|
1493 | variable names in the users namespaces. | |
1494 | """ |
|
1494 | """ | |
1495 | if regex is not None: |
|
1495 | if regex is not None: | |
1496 | try: |
|
1496 | try: | |
1497 | m = re.compile(regex) |
|
1497 | m = re.compile(regex) | |
1498 | except TypeError: |
|
1498 | except TypeError: | |
1499 | raise TypeError('regex must be a string or compiled pattern') |
|
1499 | raise TypeError('regex must be a string or compiled pattern') | |
1500 | # Search for keys in each namespace that match the given regex |
|
1500 | # Search for keys in each namespace that match the given regex | |
1501 | # If a match is found, delete the key/value pair. |
|
1501 | # If a match is found, delete the key/value pair. | |
1502 | for ns in self.all_ns_refs: |
|
1502 | for ns in self.all_ns_refs: | |
1503 | for var in ns: |
|
1503 | for var in ns: | |
1504 | if m.search(var): |
|
1504 | if m.search(var): | |
1505 | del ns[var] |
|
1505 | del ns[var] | |
1506 |
|
1506 | |||
1507 | def push(self, variables, interactive=True): |
|
1507 | def push(self, variables, interactive=True): | |
1508 | """Inject a group of variables into the IPython user namespace. |
|
1508 | """Inject a group of variables into the IPython user namespace. | |
1509 |
|
1509 | |||
1510 | Parameters |
|
1510 | Parameters | |
1511 | ---------- |
|
1511 | ---------- | |
1512 | variables : dict, str or list/tuple of str |
|
1512 | variables : dict, str or list/tuple of str | |
1513 | The variables to inject into the user's namespace. If a dict, a |
|
1513 | The variables to inject into the user's namespace. If a dict, a | |
1514 | simple update is done. If a str, the string is assumed to have |
|
1514 | simple update is done. If a str, the string is assumed to have | |
1515 | variable names separated by spaces. A list/tuple of str can also |
|
1515 | variable names separated by spaces. A list/tuple of str can also | |
1516 | be used to give the variable names. If just the variable names are |
|
1516 | be used to give the variable names. If just the variable names are | |
1517 | give (list/tuple/str) then the variable values looked up in the |
|
1517 | give (list/tuple/str) then the variable values looked up in the | |
1518 | callers frame. |
|
1518 | callers frame. | |
1519 | interactive : bool |
|
1519 | interactive : bool | |
1520 | If True (default), the variables will be listed with the ``who`` |
|
1520 | If True (default), the variables will be listed with the ``who`` | |
1521 | magic. |
|
1521 | magic. | |
1522 | """ |
|
1522 | """ | |
1523 | vdict = None |
|
1523 | vdict = None | |
1524 |
|
1524 | |||
1525 | # We need a dict of name/value pairs to do namespace updates. |
|
1525 | # We need a dict of name/value pairs to do namespace updates. | |
1526 | if isinstance(variables, dict): |
|
1526 | if isinstance(variables, dict): | |
1527 | vdict = variables |
|
1527 | vdict = variables | |
1528 | elif isinstance(variables, (str, list, tuple)): |
|
1528 | elif isinstance(variables, (str, list, tuple)): | |
1529 | if isinstance(variables, str): |
|
1529 | if isinstance(variables, str): | |
1530 | vlist = variables.split() |
|
1530 | vlist = variables.split() | |
1531 | else: |
|
1531 | else: | |
1532 | vlist = variables |
|
1532 | vlist = variables | |
1533 | vdict = {} |
|
1533 | vdict = {} | |
1534 | cf = sys._getframe(1) |
|
1534 | cf = sys._getframe(1) | |
1535 | for name in vlist: |
|
1535 | for name in vlist: | |
1536 | try: |
|
1536 | try: | |
1537 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1537 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) | |
1538 | except: |
|
1538 | except: | |
1539 | print('Could not get variable %s from %s' % |
|
1539 | print('Could not get variable %s from %s' % | |
1540 | (name,cf.f_code.co_name)) |
|
1540 | (name,cf.f_code.co_name)) | |
1541 | else: |
|
1541 | else: | |
1542 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1542 | raise ValueError('variables must be a dict/str/list/tuple') | |
1543 |
|
1543 | |||
1544 | # Propagate variables to user namespace |
|
1544 | # Propagate variables to user namespace | |
1545 | self.user_ns.update(vdict) |
|
1545 | self.user_ns.update(vdict) | |
1546 |
|
1546 | |||
1547 | # And configure interactive visibility |
|
1547 | # And configure interactive visibility | |
1548 | user_ns_hidden = self.user_ns_hidden |
|
1548 | user_ns_hidden = self.user_ns_hidden | |
1549 | if interactive: |
|
1549 | if interactive: | |
1550 | for name in vdict: |
|
1550 | for name in vdict: | |
1551 | user_ns_hidden.pop(name, None) |
|
1551 | user_ns_hidden.pop(name, None) | |
1552 | else: |
|
1552 | else: | |
1553 | user_ns_hidden.update(vdict) |
|
1553 | user_ns_hidden.update(vdict) | |
1554 |
|
1554 | |||
1555 | def drop_by_id(self, variables): |
|
1555 | def drop_by_id(self, variables): | |
1556 | """Remove a dict of variables from the user namespace, if they are the |
|
1556 | """Remove a dict of variables from the user namespace, if they are the | |
1557 | same as the values in the dictionary. |
|
1557 | same as the values in the dictionary. | |
1558 |
|
1558 | |||
1559 | This is intended for use by extensions: variables that they've added can |
|
1559 | This is intended for use by extensions: variables that they've added can | |
1560 | be taken back out if they are unloaded, without removing any that the |
|
1560 | be taken back out if they are unloaded, without removing any that the | |
1561 | user has overwritten. |
|
1561 | user has overwritten. | |
1562 |
|
1562 | |||
1563 | Parameters |
|
1563 | Parameters | |
1564 | ---------- |
|
1564 | ---------- | |
1565 | variables : dict |
|
1565 | variables : dict | |
1566 | A dictionary mapping object names (as strings) to the objects. |
|
1566 | A dictionary mapping object names (as strings) to the objects. | |
1567 | """ |
|
1567 | """ | |
1568 | for name, obj in variables.items(): |
|
1568 | for name, obj in variables.items(): | |
1569 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1569 | if name in self.user_ns and self.user_ns[name] is obj: | |
1570 | del self.user_ns[name] |
|
1570 | del self.user_ns[name] | |
1571 | self.user_ns_hidden.pop(name, None) |
|
1571 | self.user_ns_hidden.pop(name, None) | |
1572 |
|
1572 | |||
1573 | #------------------------------------------------------------------------- |
|
1573 | #------------------------------------------------------------------------- | |
1574 | # Things related to object introspection |
|
1574 | # Things related to object introspection | |
1575 | #------------------------------------------------------------------------- |
|
1575 | #------------------------------------------------------------------------- | |
1576 |
|
1576 | |||
1577 | def _ofind(self, oname, namespaces=None): |
|
1577 | def _ofind(self, oname, namespaces=None): | |
1578 | """Find an object in the available namespaces. |
|
1578 | """Find an object in the available namespaces. | |
1579 |
|
1579 | |||
1580 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1580 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic | |
1581 |
|
1581 | |||
1582 | Has special code to detect magic functions. |
|
1582 | Has special code to detect magic functions. | |
1583 | """ |
|
1583 | """ | |
1584 | oname = oname.strip() |
|
1584 | oname = oname.strip() | |
1585 | if not oname.startswith(ESC_MAGIC) and \ |
|
1585 | if not oname.startswith(ESC_MAGIC) and \ | |
1586 | not oname.startswith(ESC_MAGIC2) and \ |
|
1586 | not oname.startswith(ESC_MAGIC2) and \ | |
1587 | not all(a.isidentifier() for a in oname.split(".")): |
|
1587 | not all(a.isidentifier() for a in oname.split(".")): | |
1588 | return {'found': False} |
|
1588 | return {'found': False} | |
1589 |
|
1589 | |||
1590 | if namespaces is None: |
|
1590 | if namespaces is None: | |
1591 | # Namespaces to search in: |
|
1591 | # Namespaces to search in: | |
1592 | # Put them in a list. The order is important so that we |
|
1592 | # Put them in a list. The order is important so that we | |
1593 | # find things in the same order that Python finds them. |
|
1593 | # find things in the same order that Python finds them. | |
1594 | namespaces = [ ('Interactive', self.user_ns), |
|
1594 | namespaces = [ ('Interactive', self.user_ns), | |
1595 | ('Interactive (global)', self.user_global_ns), |
|
1595 | ('Interactive (global)', self.user_global_ns), | |
1596 | ('Python builtin', builtin_mod.__dict__), |
|
1596 | ('Python builtin', builtin_mod.__dict__), | |
1597 | ] |
|
1597 | ] | |
1598 |
|
1598 | |||
1599 | ismagic = False |
|
1599 | ismagic = False | |
1600 | isalias = False |
|
1600 | isalias = False | |
1601 | found = False |
|
1601 | found = False | |
1602 | ospace = None |
|
1602 | ospace = None | |
1603 | parent = None |
|
1603 | parent = None | |
1604 | obj = None |
|
1604 | obj = None | |
1605 |
|
1605 | |||
1606 |
|
1606 | |||
1607 | # Look for the given name by splitting it in parts. If the head is |
|
1607 | # Look for the given name by splitting it in parts. If the head is | |
1608 | # found, then we look for all the remaining parts as members, and only |
|
1608 | # found, then we look for all the remaining parts as members, and only | |
1609 | # declare success if we can find them all. |
|
1609 | # declare success if we can find them all. | |
1610 | oname_parts = oname.split('.') |
|
1610 | oname_parts = oname.split('.') | |
1611 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1611 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] | |
1612 | for nsname,ns in namespaces: |
|
1612 | for nsname,ns in namespaces: | |
1613 | try: |
|
1613 | try: | |
1614 | obj = ns[oname_head] |
|
1614 | obj = ns[oname_head] | |
1615 | except KeyError: |
|
1615 | except KeyError: | |
1616 | continue |
|
1616 | continue | |
1617 | else: |
|
1617 | else: | |
1618 | for idx, part in enumerate(oname_rest): |
|
1618 | for idx, part in enumerate(oname_rest): | |
1619 | try: |
|
1619 | try: | |
1620 | parent = obj |
|
1620 | parent = obj | |
1621 | # The last part is looked up in a special way to avoid |
|
1621 | # The last part is looked up in a special way to avoid | |
1622 | # descriptor invocation as it may raise or have side |
|
1622 | # descriptor invocation as it may raise or have side | |
1623 | # effects. |
|
1623 | # effects. | |
1624 | if idx == len(oname_rest) - 1: |
|
1624 | if idx == len(oname_rest) - 1: | |
1625 | obj = self._getattr_property(obj, part) |
|
1625 | obj = self._getattr_property(obj, part) | |
1626 | else: |
|
1626 | else: | |
1627 | obj = getattr(obj, part) |
|
1627 | obj = getattr(obj, part) | |
1628 | except: |
|
1628 | except: | |
1629 | # Blanket except b/c some badly implemented objects |
|
1629 | # Blanket except b/c some badly implemented objects | |
1630 | # allow __getattr__ to raise exceptions other than |
|
1630 | # allow __getattr__ to raise exceptions other than | |
1631 | # AttributeError, which then crashes IPython. |
|
1631 | # AttributeError, which then crashes IPython. | |
1632 | break |
|
1632 | break | |
1633 | else: |
|
1633 | else: | |
1634 | # If we finish the for loop (no break), we got all members |
|
1634 | # If we finish the for loop (no break), we got all members | |
1635 | found = True |
|
1635 | found = True | |
1636 | ospace = nsname |
|
1636 | ospace = nsname | |
1637 | break # namespace loop |
|
1637 | break # namespace loop | |
1638 |
|
1638 | |||
1639 | # Try to see if it's magic |
|
1639 | # Try to see if it's magic | |
1640 | if not found: |
|
1640 | if not found: | |
1641 | obj = None |
|
1641 | obj = None | |
1642 | if oname.startswith(ESC_MAGIC2): |
|
1642 | if oname.startswith(ESC_MAGIC2): | |
1643 | oname = oname.lstrip(ESC_MAGIC2) |
|
1643 | oname = oname.lstrip(ESC_MAGIC2) | |
1644 | obj = self.find_cell_magic(oname) |
|
1644 | obj = self.find_cell_magic(oname) | |
1645 | elif oname.startswith(ESC_MAGIC): |
|
1645 | elif oname.startswith(ESC_MAGIC): | |
1646 | oname = oname.lstrip(ESC_MAGIC) |
|
1646 | oname = oname.lstrip(ESC_MAGIC) | |
1647 | obj = self.find_line_magic(oname) |
|
1647 | obj = self.find_line_magic(oname) | |
1648 | else: |
|
1648 | else: | |
1649 | # search without prefix, so run? will find %run? |
|
1649 | # search without prefix, so run? will find %run? | |
1650 | obj = self.find_line_magic(oname) |
|
1650 | obj = self.find_line_magic(oname) | |
1651 | if obj is None: |
|
1651 | if obj is None: | |
1652 | obj = self.find_cell_magic(oname) |
|
1652 | obj = self.find_cell_magic(oname) | |
1653 | if obj is not None: |
|
1653 | if obj is not None: | |
1654 | found = True |
|
1654 | found = True | |
1655 | ospace = 'IPython internal' |
|
1655 | ospace = 'IPython internal' | |
1656 | ismagic = True |
|
1656 | ismagic = True | |
1657 | isalias = isinstance(obj, Alias) |
|
1657 | isalias = isinstance(obj, Alias) | |
1658 |
|
1658 | |||
1659 | # Last try: special-case some literals like '', [], {}, etc: |
|
1659 | # Last try: special-case some literals like '', [], {}, etc: | |
1660 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1660 | if not found and oname_head in ["''",'""','[]','{}','()']: | |
1661 | obj = eval(oname_head) |
|
1661 | obj = eval(oname_head) | |
1662 | found = True |
|
1662 | found = True | |
1663 | ospace = 'Interactive' |
|
1663 | ospace = 'Interactive' | |
1664 |
|
1664 | |||
1665 | return { |
|
1665 | return { | |
1666 | 'obj':obj, |
|
1666 | 'obj':obj, | |
1667 | 'found':found, |
|
1667 | 'found':found, | |
1668 | 'parent':parent, |
|
1668 | 'parent':parent, | |
1669 | 'ismagic':ismagic, |
|
1669 | 'ismagic':ismagic, | |
1670 | 'isalias':isalias, |
|
1670 | 'isalias':isalias, | |
1671 | 'namespace':ospace |
|
1671 | 'namespace':ospace | |
1672 | } |
|
1672 | } | |
1673 |
|
1673 | |||
1674 | @staticmethod |
|
1674 | @staticmethod | |
1675 | def _getattr_property(obj, attrname): |
|
1675 | def _getattr_property(obj, attrname): | |
1676 | """Property-aware getattr to use in object finding. |
|
1676 | """Property-aware getattr to use in object finding. | |
1677 |
|
1677 | |||
1678 | If attrname represents a property, return it unevaluated (in case it has |
|
1678 | If attrname represents a property, return it unevaluated (in case it has | |
1679 | side effects or raises an error. |
|
1679 | side effects or raises an error. | |
1680 |
|
1680 | |||
1681 | """ |
|
1681 | """ | |
1682 | if not isinstance(obj, type): |
|
1682 | if not isinstance(obj, type): | |
1683 | try: |
|
1683 | try: | |
1684 | # `getattr(type(obj), attrname)` is not guaranteed to return |
|
1684 | # `getattr(type(obj), attrname)` is not guaranteed to return | |
1685 | # `obj`, but does so for property: |
|
1685 | # `obj`, but does so for property: | |
1686 | # |
|
1686 | # | |
1687 | # property.__get__(self, None, cls) -> self |
|
1687 | # property.__get__(self, None, cls) -> self | |
1688 | # |
|
1688 | # | |
1689 | # The universal alternative is to traverse the mro manually |
|
1689 | # The universal alternative is to traverse the mro manually | |
1690 | # searching for attrname in class dicts. |
|
1690 | # searching for attrname in class dicts. | |
1691 | attr = getattr(type(obj), attrname) |
|
1691 | attr = getattr(type(obj), attrname) | |
1692 | except AttributeError: |
|
1692 | except AttributeError: | |
1693 | pass |
|
1693 | pass | |
1694 | else: |
|
1694 | else: | |
1695 | # This relies on the fact that data descriptors (with both |
|
1695 | # This relies on the fact that data descriptors (with both | |
1696 | # __get__ & __set__ magic methods) take precedence over |
|
1696 | # __get__ & __set__ magic methods) take precedence over | |
1697 | # instance-level attributes: |
|
1697 | # instance-level attributes: | |
1698 | # |
|
1698 | # | |
1699 | # class A(object): |
|
1699 | # class A(object): | |
1700 | # @property |
|
1700 | # @property | |
1701 | # def foobar(self): return 123 |
|
1701 | # def foobar(self): return 123 | |
1702 | # a = A() |
|
1702 | # a = A() | |
1703 | # a.__dict__['foobar'] = 345 |
|
1703 | # a.__dict__['foobar'] = 345 | |
1704 | # a.foobar # == 123 |
|
1704 | # a.foobar # == 123 | |
1705 | # |
|
1705 | # | |
1706 | # So, a property may be returned right away. |
|
1706 | # So, a property may be returned right away. | |
1707 | if isinstance(attr, property): |
|
1707 | if isinstance(attr, property): | |
1708 | return attr |
|
1708 | return attr | |
1709 |
|
1709 | |||
1710 | # Nothing helped, fall back. |
|
1710 | # Nothing helped, fall back. | |
1711 | return getattr(obj, attrname) |
|
1711 | return getattr(obj, attrname) | |
1712 |
|
1712 | |||
1713 | def _object_find(self, oname, namespaces=None): |
|
1713 | def _object_find(self, oname, namespaces=None): | |
1714 | """Find an object and return a struct with info about it.""" |
|
1714 | """Find an object and return a struct with info about it.""" | |
1715 | return Struct(self._ofind(oname, namespaces)) |
|
1715 | return Struct(self._ofind(oname, namespaces)) | |
1716 |
|
1716 | |||
1717 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1717 | def _inspect(self, meth, oname, namespaces=None, **kw): | |
1718 | """Generic interface to the inspector system. |
|
1718 | """Generic interface to the inspector system. | |
1719 |
|
1719 | |||
1720 | This function is meant to be called by pdef, pdoc & friends. |
|
1720 | This function is meant to be called by pdef, pdoc & friends. | |
1721 | """ |
|
1721 | """ | |
1722 | info = self._object_find(oname, namespaces) |
|
1722 | info = self._object_find(oname, namespaces) | |
1723 | docformat = sphinxify if self.sphinxify_docstring else None |
|
1723 | docformat = sphinxify if self.sphinxify_docstring else None | |
1724 | if info.found: |
|
1724 | if info.found: | |
1725 | pmethod = getattr(self.inspector, meth) |
|
1725 | pmethod = getattr(self.inspector, meth) | |
1726 | # TODO: only apply format_screen to the plain/text repr of the mime |
|
1726 | # TODO: only apply format_screen to the plain/text repr of the mime | |
1727 | # bundle. |
|
1727 | # bundle. | |
1728 | formatter = format_screen if info.ismagic else docformat |
|
1728 | formatter = format_screen if info.ismagic else docformat | |
1729 | if meth == 'pdoc': |
|
1729 | if meth == 'pdoc': | |
1730 | pmethod(info.obj, oname, formatter) |
|
1730 | pmethod(info.obj, oname, formatter) | |
1731 | elif meth == 'pinfo': |
|
1731 | elif meth == 'pinfo': | |
1732 | pmethod(info.obj, oname, formatter, info, |
|
1732 | pmethod(info.obj, oname, formatter, info, | |
1733 | enable_html_pager=self.enable_html_pager, **kw) |
|
1733 | enable_html_pager=self.enable_html_pager, **kw) | |
1734 | else: |
|
1734 | else: | |
1735 | pmethod(info.obj, oname) |
|
1735 | pmethod(info.obj, oname) | |
1736 | else: |
|
1736 | else: | |
1737 | print('Object `%s` not found.' % oname) |
|
1737 | print('Object `%s` not found.' % oname) | |
1738 | return 'not found' # so callers can take other action |
|
1738 | return 'not found' # so callers can take other action | |
1739 |
|
1739 | |||
1740 | def object_inspect(self, oname, detail_level=0): |
|
1740 | def object_inspect(self, oname, detail_level=0): | |
1741 | """Get object info about oname""" |
|
1741 | """Get object info about oname""" | |
1742 | with self.builtin_trap: |
|
1742 | with self.builtin_trap: | |
1743 | info = self._object_find(oname) |
|
1743 | info = self._object_find(oname) | |
1744 | if info.found: |
|
1744 | if info.found: | |
1745 | return self.inspector.info(info.obj, oname, info=info, |
|
1745 | return self.inspector.info(info.obj, oname, info=info, | |
1746 | detail_level=detail_level |
|
1746 | detail_level=detail_level | |
1747 | ) |
|
1747 | ) | |
1748 | else: |
|
1748 | else: | |
1749 | return oinspect.object_info(name=oname, found=False) |
|
1749 | return oinspect.object_info(name=oname, found=False) | |
1750 |
|
1750 | |||
1751 | def object_inspect_text(self, oname, detail_level=0): |
|
1751 | def object_inspect_text(self, oname, detail_level=0): | |
1752 | """Get object info as formatted text""" |
|
1752 | """Get object info as formatted text""" | |
1753 | return self.object_inspect_mime(oname, detail_level)['text/plain'] |
|
1753 | return self.object_inspect_mime(oname, detail_level)['text/plain'] | |
1754 |
|
1754 | |||
1755 | def object_inspect_mime(self, oname, detail_level=0): |
|
1755 | def object_inspect_mime(self, oname, detail_level=0): | |
1756 | """Get object info as a mimebundle of formatted representations. |
|
1756 | """Get object info as a mimebundle of formatted representations. | |
1757 |
|
1757 | |||
1758 | A mimebundle is a dictionary, keyed by mime-type. |
|
1758 | A mimebundle is a dictionary, keyed by mime-type. | |
1759 | It must always have the key `'text/plain'`. |
|
1759 | It must always have the key `'text/plain'`. | |
1760 | """ |
|
1760 | """ | |
1761 | with self.builtin_trap: |
|
1761 | with self.builtin_trap: | |
1762 | info = self._object_find(oname) |
|
1762 | info = self._object_find(oname) | |
1763 | if info.found: |
|
1763 | if info.found: | |
1764 | return self.inspector._get_info(info.obj, oname, info=info, |
|
1764 | return self.inspector._get_info(info.obj, oname, info=info, | |
1765 | detail_level=detail_level |
|
1765 | detail_level=detail_level | |
1766 | ) |
|
1766 | ) | |
1767 | else: |
|
1767 | else: | |
1768 | raise KeyError(oname) |
|
1768 | raise KeyError(oname) | |
1769 |
|
1769 | |||
1770 | #------------------------------------------------------------------------- |
|
1770 | #------------------------------------------------------------------------- | |
1771 | # Things related to history management |
|
1771 | # Things related to history management | |
1772 | #------------------------------------------------------------------------- |
|
1772 | #------------------------------------------------------------------------- | |
1773 |
|
1773 | |||
1774 | def init_history(self): |
|
1774 | def init_history(self): | |
1775 | """Sets up the command history, and starts regular autosaves.""" |
|
1775 | """Sets up the command history, and starts regular autosaves.""" | |
1776 | self.history_manager = HistoryManager(shell=self, parent=self) |
|
1776 | self.history_manager = HistoryManager(shell=self, parent=self) | |
1777 | self.configurables.append(self.history_manager) |
|
1777 | self.configurables.append(self.history_manager) | |
1778 |
|
1778 | |||
1779 | #------------------------------------------------------------------------- |
|
1779 | #------------------------------------------------------------------------- | |
1780 | # Things related to exception handling and tracebacks (not debugging) |
|
1780 | # Things related to exception handling and tracebacks (not debugging) | |
1781 | #------------------------------------------------------------------------- |
|
1781 | #------------------------------------------------------------------------- | |
1782 |
|
1782 | |||
1783 | debugger_cls = Pdb |
|
1783 | debugger_cls = Pdb | |
1784 |
|
1784 | |||
1785 | def init_traceback_handlers(self, custom_exceptions): |
|
1785 | def init_traceback_handlers(self, custom_exceptions): | |
1786 | # Syntax error handler. |
|
1786 | # Syntax error handler. | |
1787 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self) |
|
1787 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self) | |
1788 |
|
1788 | |||
1789 | # The interactive one is initialized with an offset, meaning we always |
|
1789 | # The interactive one is initialized with an offset, meaning we always | |
1790 | # want to remove the topmost item in the traceback, which is our own |
|
1790 | # want to remove the topmost item in the traceback, which is our own | |
1791 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1791 | # internal code. Valid modes: ['Plain','Context','Verbose','Minimal'] | |
1792 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1792 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', | |
1793 | color_scheme='NoColor', |
|
1793 | color_scheme='NoColor', | |
1794 | tb_offset = 1, |
|
1794 | tb_offset = 1, | |
1795 | check_cache=check_linecache_ipython, |
|
1795 | check_cache=check_linecache_ipython, | |
1796 | debugger_cls=self.debugger_cls, parent=self) |
|
1796 | debugger_cls=self.debugger_cls, parent=self) | |
1797 |
|
1797 | |||
1798 | # The instance will store a pointer to the system-wide exception hook, |
|
1798 | # The instance will store a pointer to the system-wide exception hook, | |
1799 | # so that runtime code (such as magics) can access it. This is because |
|
1799 | # so that runtime code (such as magics) can access it. This is because | |
1800 | # during the read-eval loop, it may get temporarily overwritten. |
|
1800 | # during the read-eval loop, it may get temporarily overwritten. | |
1801 | self.sys_excepthook = sys.excepthook |
|
1801 | self.sys_excepthook = sys.excepthook | |
1802 |
|
1802 | |||
1803 | # and add any custom exception handlers the user may have specified |
|
1803 | # and add any custom exception handlers the user may have specified | |
1804 | self.set_custom_exc(*custom_exceptions) |
|
1804 | self.set_custom_exc(*custom_exceptions) | |
1805 |
|
1805 | |||
1806 | # Set the exception mode |
|
1806 | # Set the exception mode | |
1807 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1807 | self.InteractiveTB.set_mode(mode=self.xmode) | |
1808 |
|
1808 | |||
1809 | def set_custom_exc(self, exc_tuple, handler): |
|
1809 | def set_custom_exc(self, exc_tuple, handler): | |
1810 | """set_custom_exc(exc_tuple, handler) |
|
1810 | """set_custom_exc(exc_tuple, handler) | |
1811 |
|
1811 | |||
1812 | Set a custom exception handler, which will be called if any of the |
|
1812 | Set a custom exception handler, which will be called if any of the | |
1813 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1813 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1814 | run_code() method). |
|
1814 | run_code() method). | |
1815 |
|
1815 | |||
1816 | Parameters |
|
1816 | Parameters | |
1817 | ---------- |
|
1817 | ---------- | |
1818 |
|
1818 | |||
1819 | exc_tuple : tuple of exception classes |
|
1819 | exc_tuple : tuple of exception classes | |
1820 | A *tuple* of exception classes, for which to call the defined |
|
1820 | A *tuple* of exception classes, for which to call the defined | |
1821 | handler. It is very important that you use a tuple, and NOT A |
|
1821 | handler. It is very important that you use a tuple, and NOT A | |
1822 | LIST here, because of the way Python's except statement works. If |
|
1822 | LIST here, because of the way Python's except statement works. If | |
1823 | you only want to trap a single exception, use a singleton tuple:: |
|
1823 | you only want to trap a single exception, use a singleton tuple:: | |
1824 |
|
1824 | |||
1825 | exc_tuple == (MyCustomException,) |
|
1825 | exc_tuple == (MyCustomException,) | |
1826 |
|
1826 | |||
1827 | handler : callable |
|
1827 | handler : callable | |
1828 | handler must have the following signature:: |
|
1828 | handler must have the following signature:: | |
1829 |
|
1829 | |||
1830 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1830 | def my_handler(self, etype, value, tb, tb_offset=None): | |
1831 | ... |
|
1831 | ... | |
1832 | return structured_traceback |
|
1832 | return structured_traceback | |
1833 |
|
1833 | |||
1834 | Your handler must return a structured traceback (a list of strings), |
|
1834 | Your handler must return a structured traceback (a list of strings), | |
1835 | or None. |
|
1835 | or None. | |
1836 |
|
1836 | |||
1837 | This will be made into an instance method (via types.MethodType) |
|
1837 | This will be made into an instance method (via types.MethodType) | |
1838 | of IPython itself, and it will be called if any of the exceptions |
|
1838 | of IPython itself, and it will be called if any of the exceptions | |
1839 | listed in the exc_tuple are caught. If the handler is None, an |
|
1839 | listed in the exc_tuple are caught. If the handler is None, an | |
1840 | internal basic one is used, which just prints basic info. |
|
1840 | internal basic one is used, which just prints basic info. | |
1841 |
|
1841 | |||
1842 | To protect IPython from crashes, if your handler ever raises an |
|
1842 | To protect IPython from crashes, if your handler ever raises an | |
1843 | exception or returns an invalid result, it will be immediately |
|
1843 | exception or returns an invalid result, it will be immediately | |
1844 | disabled. |
|
1844 | disabled. | |
1845 |
|
1845 | |||
1846 | WARNING: by putting in your own exception handler into IPython's main |
|
1846 | WARNING: by putting in your own exception handler into IPython's main | |
1847 | execution loop, you run a very good chance of nasty crashes. This |
|
1847 | execution loop, you run a very good chance of nasty crashes. This | |
1848 | facility should only be used if you really know what you are doing.""" |
|
1848 | facility should only be used if you really know what you are doing.""" | |
1849 | if not isinstance(exc_tuple, tuple): |
|
1849 | if not isinstance(exc_tuple, tuple): | |
1850 | raise TypeError("The custom exceptions must be given as a tuple.") |
|
1850 | raise TypeError("The custom exceptions must be given as a tuple.") | |
1851 |
|
1851 | |||
1852 | def dummy_handler(self, etype, value, tb, tb_offset=None): |
|
1852 | def dummy_handler(self, etype, value, tb, tb_offset=None): | |
1853 | print('*** Simple custom exception handler ***') |
|
1853 | print('*** Simple custom exception handler ***') | |
1854 | print('Exception type :', etype) |
|
1854 | print('Exception type :', etype) | |
1855 | print('Exception value:', value) |
|
1855 | print('Exception value:', value) | |
1856 | print('Traceback :', tb) |
|
1856 | print('Traceback :', tb) | |
1857 |
|
1857 | |||
1858 | def validate_stb(stb): |
|
1858 | def validate_stb(stb): | |
1859 | """validate structured traceback return type |
|
1859 | """validate structured traceback return type | |
1860 |
|
1860 | |||
1861 | return type of CustomTB *should* be a list of strings, but allow |
|
1861 | return type of CustomTB *should* be a list of strings, but allow | |
1862 | single strings or None, which are harmless. |
|
1862 | single strings or None, which are harmless. | |
1863 |
|
1863 | |||
1864 | This function will *always* return a list of strings, |
|
1864 | This function will *always* return a list of strings, | |
1865 | and will raise a TypeError if stb is inappropriate. |
|
1865 | and will raise a TypeError if stb is inappropriate. | |
1866 | """ |
|
1866 | """ | |
1867 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1867 | msg = "CustomTB must return list of strings, not %r" % stb | |
1868 | if stb is None: |
|
1868 | if stb is None: | |
1869 | return [] |
|
1869 | return [] | |
1870 | elif isinstance(stb, str): |
|
1870 | elif isinstance(stb, str): | |
1871 | return [stb] |
|
1871 | return [stb] | |
1872 | elif not isinstance(stb, list): |
|
1872 | elif not isinstance(stb, list): | |
1873 | raise TypeError(msg) |
|
1873 | raise TypeError(msg) | |
1874 | # it's a list |
|
1874 | # it's a list | |
1875 | for line in stb: |
|
1875 | for line in stb: | |
1876 | # check every element |
|
1876 | # check every element | |
1877 | if not isinstance(line, str): |
|
1877 | if not isinstance(line, str): | |
1878 | raise TypeError(msg) |
|
1878 | raise TypeError(msg) | |
1879 | return stb |
|
1879 | return stb | |
1880 |
|
1880 | |||
1881 | if handler is None: |
|
1881 | if handler is None: | |
1882 | wrapped = dummy_handler |
|
1882 | wrapped = dummy_handler | |
1883 | else: |
|
1883 | else: | |
1884 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1884 | def wrapped(self,etype,value,tb,tb_offset=None): | |
1885 | """wrap CustomTB handler, to protect IPython from user code |
|
1885 | """wrap CustomTB handler, to protect IPython from user code | |
1886 |
|
1886 | |||
1887 | This makes it harder (but not impossible) for custom exception |
|
1887 | This makes it harder (but not impossible) for custom exception | |
1888 | handlers to crash IPython. |
|
1888 | handlers to crash IPython. | |
1889 | """ |
|
1889 | """ | |
1890 | try: |
|
1890 | try: | |
1891 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1891 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) | |
1892 | return validate_stb(stb) |
|
1892 | return validate_stb(stb) | |
1893 | except: |
|
1893 | except: | |
1894 | # clear custom handler immediately |
|
1894 | # clear custom handler immediately | |
1895 | self.set_custom_exc((), None) |
|
1895 | self.set_custom_exc((), None) | |
1896 | print("Custom TB Handler failed, unregistering", file=sys.stderr) |
|
1896 | print("Custom TB Handler failed, unregistering", file=sys.stderr) | |
1897 | # show the exception in handler first |
|
1897 | # show the exception in handler first | |
1898 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1898 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) | |
1899 | print(self.InteractiveTB.stb2text(stb)) |
|
1899 | print(self.InteractiveTB.stb2text(stb)) | |
1900 | print("The original exception:") |
|
1900 | print("The original exception:") | |
1901 | stb = self.InteractiveTB.structured_traceback( |
|
1901 | stb = self.InteractiveTB.structured_traceback( | |
1902 | (etype,value,tb), tb_offset=tb_offset |
|
1902 | (etype,value,tb), tb_offset=tb_offset | |
1903 | ) |
|
1903 | ) | |
1904 | return stb |
|
1904 | return stb | |
1905 |
|
1905 | |||
1906 | self.CustomTB = types.MethodType(wrapped,self) |
|
1906 | self.CustomTB = types.MethodType(wrapped,self) | |
1907 | self.custom_exceptions = exc_tuple |
|
1907 | self.custom_exceptions = exc_tuple | |
1908 |
|
1908 | |||
1909 | def excepthook(self, etype, value, tb): |
|
1909 | def excepthook(self, etype, value, tb): | |
1910 | """One more defense for GUI apps that call sys.excepthook. |
|
1910 | """One more defense for GUI apps that call sys.excepthook. | |
1911 |
|
1911 | |||
1912 | GUI frameworks like wxPython trap exceptions and call |
|
1912 | GUI frameworks like wxPython trap exceptions and call | |
1913 | sys.excepthook themselves. I guess this is a feature that |
|
1913 | sys.excepthook themselves. I guess this is a feature that | |
1914 | enables them to keep running after exceptions that would |
|
1914 | enables them to keep running after exceptions that would | |
1915 | otherwise kill their mainloop. This is a bother for IPython |
|
1915 | otherwise kill their mainloop. This is a bother for IPython | |
1916 | which excepts to catch all of the program exceptions with a try: |
|
1916 | which excepts to catch all of the program exceptions with a try: | |
1917 | except: statement. |
|
1917 | except: statement. | |
1918 |
|
1918 | |||
1919 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1919 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
1920 | any app directly invokes sys.excepthook, it will look to the user like |
|
1920 | any app directly invokes sys.excepthook, it will look to the user like | |
1921 | IPython crashed. In order to work around this, we can disable the |
|
1921 | IPython crashed. In order to work around this, we can disable the | |
1922 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1922 | CrashHandler and replace it with this excepthook instead, which prints a | |
1923 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1923 | regular traceback using our InteractiveTB. In this fashion, apps which | |
1924 | call sys.excepthook will generate a regular-looking exception from |
|
1924 | call sys.excepthook will generate a regular-looking exception from | |
1925 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1925 | IPython, and the CrashHandler will only be triggered by real IPython | |
1926 | crashes. |
|
1926 | crashes. | |
1927 |
|
1927 | |||
1928 | This hook should be used sparingly, only in places which are not likely |
|
1928 | This hook should be used sparingly, only in places which are not likely | |
1929 | to be true IPython errors. |
|
1929 | to be true IPython errors. | |
1930 | """ |
|
1930 | """ | |
1931 | self.showtraceback((etype, value, tb), tb_offset=0) |
|
1931 | self.showtraceback((etype, value, tb), tb_offset=0) | |
1932 |
|
1932 | |||
1933 | def _get_exc_info(self, exc_tuple=None): |
|
1933 | def _get_exc_info(self, exc_tuple=None): | |
1934 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. |
|
1934 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. | |
1935 |
|
1935 | |||
1936 | Ensures sys.last_type,value,traceback hold the exc_info we found, |
|
1936 | Ensures sys.last_type,value,traceback hold the exc_info we found, | |
1937 | from whichever source. |
|
1937 | from whichever source. | |
1938 |
|
1938 | |||
1939 | raises ValueError if none of these contain any information |
|
1939 | raises ValueError if none of these contain any information | |
1940 | """ |
|
1940 | """ | |
1941 | if exc_tuple is None: |
|
1941 | if exc_tuple is None: | |
1942 | etype, value, tb = sys.exc_info() |
|
1942 | etype, value, tb = sys.exc_info() | |
1943 | else: |
|
1943 | else: | |
1944 | etype, value, tb = exc_tuple |
|
1944 | etype, value, tb = exc_tuple | |
1945 |
|
1945 | |||
1946 | if etype is None: |
|
1946 | if etype is None: | |
1947 | if hasattr(sys, 'last_type'): |
|
1947 | if hasattr(sys, 'last_type'): | |
1948 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1948 | etype, value, tb = sys.last_type, sys.last_value, \ | |
1949 | sys.last_traceback |
|
1949 | sys.last_traceback | |
1950 |
|
1950 | |||
1951 | if etype is None: |
|
1951 | if etype is None: | |
1952 | raise ValueError("No exception to find") |
|
1952 | raise ValueError("No exception to find") | |
1953 |
|
1953 | |||
1954 | # Now store the exception info in sys.last_type etc. |
|
1954 | # Now store the exception info in sys.last_type etc. | |
1955 | # WARNING: these variables are somewhat deprecated and not |
|
1955 | # WARNING: these variables are somewhat deprecated and not | |
1956 | # necessarily safe to use in a threaded environment, but tools |
|
1956 | # necessarily safe to use in a threaded environment, but tools | |
1957 | # like pdb depend on their existence, so let's set them. If we |
|
1957 | # like pdb depend on their existence, so let's set them. If we | |
1958 | # find problems in the field, we'll need to revisit their use. |
|
1958 | # find problems in the field, we'll need to revisit their use. | |
1959 | sys.last_type = etype |
|
1959 | sys.last_type = etype | |
1960 | sys.last_value = value |
|
1960 | sys.last_value = value | |
1961 | sys.last_traceback = tb |
|
1961 | sys.last_traceback = tb | |
1962 |
|
1962 | |||
1963 | return etype, value, tb |
|
1963 | return etype, value, tb | |
1964 |
|
1964 | |||
1965 | def show_usage_error(self, exc): |
|
1965 | def show_usage_error(self, exc): | |
1966 | """Show a short message for UsageErrors |
|
1966 | """Show a short message for UsageErrors | |
1967 |
|
1967 | |||
1968 | These are special exceptions that shouldn't show a traceback. |
|
1968 | These are special exceptions that shouldn't show a traceback. | |
1969 | """ |
|
1969 | """ | |
1970 | print("UsageError: %s" % exc, file=sys.stderr) |
|
1970 | print("UsageError: %s" % exc, file=sys.stderr) | |
1971 |
|
1971 | |||
1972 | def get_exception_only(self, exc_tuple=None): |
|
1972 | def get_exception_only(self, exc_tuple=None): | |
1973 | """ |
|
1973 | """ | |
1974 | Return as a string (ending with a newline) the exception that |
|
1974 | Return as a string (ending with a newline) the exception that | |
1975 | just occurred, without any traceback. |
|
1975 | just occurred, without any traceback. | |
1976 | """ |
|
1976 | """ | |
1977 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
1977 | etype, value, tb = self._get_exc_info(exc_tuple) | |
1978 | msg = traceback.format_exception_only(etype, value) |
|
1978 | msg = traceback.format_exception_only(etype, value) | |
1979 | return ''.join(msg) |
|
1979 | return ''.join(msg) | |
1980 |
|
1980 | |||
1981 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, |
|
1981 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, | |
1982 | exception_only=False, running_compiled_code=False): |
|
1982 | exception_only=False, running_compiled_code=False): | |
1983 | """Display the exception that just occurred. |
|
1983 | """Display the exception that just occurred. | |
1984 |
|
1984 | |||
1985 | If nothing is known about the exception, this is the method which |
|
1985 | If nothing is known about the exception, this is the method which | |
1986 | should be used throughout the code for presenting user tracebacks, |
|
1986 | should be used throughout the code for presenting user tracebacks, | |
1987 | rather than directly invoking the InteractiveTB object. |
|
1987 | rather than directly invoking the InteractiveTB object. | |
1988 |
|
1988 | |||
1989 | A specific showsyntaxerror() also exists, but this method can take |
|
1989 | A specific showsyntaxerror() also exists, but this method can take | |
1990 | care of calling it if needed, so unless you are explicitly catching a |
|
1990 | care of calling it if needed, so unless you are explicitly catching a | |
1991 | SyntaxError exception, don't try to analyze the stack manually and |
|
1991 | SyntaxError exception, don't try to analyze the stack manually and | |
1992 | simply call this method.""" |
|
1992 | simply call this method.""" | |
1993 |
|
1993 | |||
1994 | try: |
|
1994 | try: | |
1995 | try: |
|
1995 | try: | |
1996 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
1996 | etype, value, tb = self._get_exc_info(exc_tuple) | |
1997 | except ValueError: |
|
1997 | except ValueError: | |
1998 | print('No traceback available to show.', file=sys.stderr) |
|
1998 | print('No traceback available to show.', file=sys.stderr) | |
1999 | return |
|
1999 | return | |
2000 |
|
2000 | |||
2001 | if issubclass(etype, SyntaxError): |
|
2001 | if issubclass(etype, SyntaxError): | |
2002 | # Though this won't be called by syntax errors in the input |
|
2002 | # Though this won't be called by syntax errors in the input | |
2003 | # line, there may be SyntaxError cases with imported code. |
|
2003 | # line, there may be SyntaxError cases with imported code. | |
2004 | self.showsyntaxerror(filename, running_compiled_code) |
|
2004 | self.showsyntaxerror(filename, running_compiled_code) | |
2005 | elif etype is UsageError: |
|
2005 | elif etype is UsageError: | |
2006 | self.show_usage_error(value) |
|
2006 | self.show_usage_error(value) | |
2007 | else: |
|
2007 | else: | |
2008 | if exception_only: |
|
2008 | if exception_only: | |
2009 | stb = ['An exception has occurred, use %tb to see ' |
|
2009 | stb = ['An exception has occurred, use %tb to see ' | |
2010 | 'the full traceback.\n'] |
|
2010 | 'the full traceback.\n'] | |
2011 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
2011 | stb.extend(self.InteractiveTB.get_exception_only(etype, | |
2012 | value)) |
|
2012 | value)) | |
2013 | else: |
|
2013 | else: | |
2014 | try: |
|
2014 | try: | |
2015 | # Exception classes can customise their traceback - we |
|
2015 | # Exception classes can customise their traceback - we | |
2016 | # use this in IPython.parallel for exceptions occurring |
|
2016 | # use this in IPython.parallel for exceptions occurring | |
2017 | # in the engines. This should return a list of strings. |
|
2017 | # in the engines. This should return a list of strings. | |
2018 | stb = value._render_traceback_() |
|
2018 | stb = value._render_traceback_() | |
2019 | except Exception: |
|
2019 | except Exception: | |
2020 | stb = self.InteractiveTB.structured_traceback(etype, |
|
2020 | stb = self.InteractiveTB.structured_traceback(etype, | |
2021 | value, tb, tb_offset=tb_offset) |
|
2021 | value, tb, tb_offset=tb_offset) | |
2022 |
|
2022 | |||
2023 | self._showtraceback(etype, value, stb) |
|
2023 | self._showtraceback(etype, value, stb) | |
2024 | if self.call_pdb: |
|
2024 | if self.call_pdb: | |
2025 | # drop into debugger |
|
2025 | # drop into debugger | |
2026 | self.debugger(force=True) |
|
2026 | self.debugger(force=True) | |
2027 | return |
|
2027 | return | |
2028 |
|
2028 | |||
2029 | # Actually show the traceback |
|
2029 | # Actually show the traceback | |
2030 | self._showtraceback(etype, value, stb) |
|
2030 | self._showtraceback(etype, value, stb) | |
2031 |
|
2031 | |||
2032 | except KeyboardInterrupt: |
|
2032 | except KeyboardInterrupt: | |
2033 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2033 | print('\n' + self.get_exception_only(), file=sys.stderr) | |
2034 |
|
2034 | |||
2035 | def _showtraceback(self, etype, evalue, stb): |
|
2035 | def _showtraceback(self, etype, evalue, stb): | |
2036 | """Actually show a traceback. |
|
2036 | """Actually show a traceback. | |
2037 |
|
2037 | |||
2038 | Subclasses may override this method to put the traceback on a different |
|
2038 | Subclasses may override this method to put the traceback on a different | |
2039 | place, like a side channel. |
|
2039 | place, like a side channel. | |
2040 | """ |
|
2040 | """ | |
2041 | print(self.InteractiveTB.stb2text(stb)) |
|
2041 | print(self.InteractiveTB.stb2text(stb)) | |
2042 |
|
2042 | |||
2043 | def showsyntaxerror(self, filename=None, running_compiled_code=False): |
|
2043 | def showsyntaxerror(self, filename=None, running_compiled_code=False): | |
2044 | """Display the syntax error that just occurred. |
|
2044 | """Display the syntax error that just occurred. | |
2045 |
|
2045 | |||
2046 | This doesn't display a stack trace because there isn't one. |
|
2046 | This doesn't display a stack trace because there isn't one. | |
2047 |
|
2047 | |||
2048 | If a filename is given, it is stuffed in the exception instead |
|
2048 | If a filename is given, it is stuffed in the exception instead | |
2049 | of what was there before (because Python's parser always uses |
|
2049 | of what was there before (because Python's parser always uses | |
2050 | "<string>" when reading from a string). |
|
2050 | "<string>" when reading from a string). | |
2051 |
|
2051 | |||
2052 | If the syntax error occurred when running a compiled code (i.e. running_compile_code=True), |
|
2052 | If the syntax error occurred when running a compiled code (i.e. running_compile_code=True), | |
2053 | longer stack trace will be displayed. |
|
2053 | longer stack trace will be displayed. | |
2054 | """ |
|
2054 | """ | |
2055 | etype, value, last_traceback = self._get_exc_info() |
|
2055 | etype, value, last_traceback = self._get_exc_info() | |
2056 |
|
2056 | |||
2057 | if filename and issubclass(etype, SyntaxError): |
|
2057 | if filename and issubclass(etype, SyntaxError): | |
2058 | try: |
|
2058 | try: | |
2059 | value.filename = filename |
|
2059 | value.filename = filename | |
2060 | except: |
|
2060 | except: | |
2061 | # Not the format we expect; leave it alone |
|
2061 | # Not the format we expect; leave it alone | |
2062 | pass |
|
2062 | pass | |
2063 |
|
2063 | |||
2064 | # If the error occurred when executing compiled code, we should provide full stacktrace. |
|
2064 | # If the error occurred when executing compiled code, we should provide full stacktrace. | |
2065 | elist = traceback.extract_tb(last_traceback) if running_compiled_code else [] |
|
2065 | elist = traceback.extract_tb(last_traceback) if running_compiled_code else [] | |
2066 | stb = self.SyntaxTB.structured_traceback(etype, value, elist) |
|
2066 | stb = self.SyntaxTB.structured_traceback(etype, value, elist) | |
2067 | self._showtraceback(etype, value, stb) |
|
2067 | self._showtraceback(etype, value, stb) | |
2068 |
|
2068 | |||
2069 | # This is overridden in TerminalInteractiveShell to show a message about |
|
2069 | # This is overridden in TerminalInteractiveShell to show a message about | |
2070 | # the %paste magic. |
|
2070 | # the %paste magic. | |
2071 | def showindentationerror(self): |
|
2071 | def showindentationerror(self): | |
2072 | """Called by _run_cell when there's an IndentationError in code entered |
|
2072 | """Called by _run_cell when there's an IndentationError in code entered | |
2073 | at the prompt. |
|
2073 | at the prompt. | |
2074 |
|
2074 | |||
2075 | This is overridden in TerminalInteractiveShell to show a message about |
|
2075 | This is overridden in TerminalInteractiveShell to show a message about | |
2076 | the %paste magic.""" |
|
2076 | the %paste magic.""" | |
2077 | self.showsyntaxerror() |
|
2077 | self.showsyntaxerror() | |
2078 |
|
2078 | |||
2079 | #------------------------------------------------------------------------- |
|
2079 | #------------------------------------------------------------------------- | |
2080 | # Things related to readline |
|
2080 | # Things related to readline | |
2081 | #------------------------------------------------------------------------- |
|
2081 | #------------------------------------------------------------------------- | |
2082 |
|
2082 | |||
2083 | def init_readline(self): |
|
2083 | def init_readline(self): | |
2084 | """DEPRECATED |
|
2084 | """DEPRECATED | |
2085 |
|
2085 | |||
2086 | Moved to terminal subclass, here only to simplify the init logic.""" |
|
2086 | Moved to terminal subclass, here only to simplify the init logic.""" | |
2087 | # Set a number of methods that depend on readline to be no-op |
|
2087 | # Set a number of methods that depend on readline to be no-op | |
2088 | warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated', |
|
2088 | warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated', | |
2089 | DeprecationWarning, stacklevel=2) |
|
2089 | DeprecationWarning, stacklevel=2) | |
2090 | self.set_custom_completer = no_op |
|
2090 | self.set_custom_completer = no_op | |
2091 |
|
2091 | |||
2092 | @skip_doctest |
|
2092 | @skip_doctest | |
2093 | def set_next_input(self, s, replace=False): |
|
2093 | def set_next_input(self, s, replace=False): | |
2094 | """ Sets the 'default' input string for the next command line. |
|
2094 | """ Sets the 'default' input string for the next command line. | |
2095 |
|
2095 | |||
2096 | Example:: |
|
2096 | Example:: | |
2097 |
|
2097 | |||
2098 | In [1]: _ip.set_next_input("Hello Word") |
|
2098 | In [1]: _ip.set_next_input("Hello Word") | |
2099 | In [2]: Hello Word_ # cursor is here |
|
2099 | In [2]: Hello Word_ # cursor is here | |
2100 | """ |
|
2100 | """ | |
2101 | self.rl_next_input = s |
|
2101 | self.rl_next_input = s | |
2102 |
|
2102 | |||
2103 | def _indent_current_str(self): |
|
2103 | def _indent_current_str(self): | |
2104 | """return the current level of indentation as a string""" |
|
2104 | """return the current level of indentation as a string""" | |
2105 | return self.input_splitter.get_indent_spaces() * ' ' |
|
2105 | return self.input_splitter.get_indent_spaces() * ' ' | |
2106 |
|
2106 | |||
2107 | #------------------------------------------------------------------------- |
|
2107 | #------------------------------------------------------------------------- | |
2108 | # Things related to text completion |
|
2108 | # Things related to text completion | |
2109 | #------------------------------------------------------------------------- |
|
2109 | #------------------------------------------------------------------------- | |
2110 |
|
2110 | |||
2111 | def init_completer(self): |
|
2111 | def init_completer(self): | |
2112 | """Initialize the completion machinery. |
|
2112 | """Initialize the completion machinery. | |
2113 |
|
2113 | |||
2114 | This creates completion machinery that can be used by client code, |
|
2114 | This creates completion machinery that can be used by client code, | |
2115 | either interactively in-process (typically triggered by the readline |
|
2115 | either interactively in-process (typically triggered by the readline | |
2116 | library), programmatically (such as in test suites) or out-of-process |
|
2116 | library), programmatically (such as in test suites) or out-of-process | |
2117 | (typically over the network by remote frontends). |
|
2117 | (typically over the network by remote frontends). | |
2118 | """ |
|
2118 | """ | |
2119 | from IPython.core.completer import IPCompleter |
|
2119 | from IPython.core.completer import IPCompleter | |
2120 | from IPython.core.completerlib import (module_completer, |
|
2120 | from IPython.core.completerlib import (module_completer, | |
2121 | magic_run_completer, cd_completer, reset_completer) |
|
2121 | magic_run_completer, cd_completer, reset_completer) | |
2122 |
|
2122 | |||
2123 | self.Completer = IPCompleter(shell=self, |
|
2123 | self.Completer = IPCompleter(shell=self, | |
2124 | namespace=self.user_ns, |
|
2124 | namespace=self.user_ns, | |
2125 | global_namespace=self.user_global_ns, |
|
2125 | global_namespace=self.user_global_ns, | |
2126 | parent=self, |
|
2126 | parent=self, | |
2127 | ) |
|
2127 | ) | |
2128 | self.configurables.append(self.Completer) |
|
2128 | self.configurables.append(self.Completer) | |
2129 |
|
2129 | |||
2130 | # Add custom completers to the basic ones built into IPCompleter |
|
2130 | # Add custom completers to the basic ones built into IPCompleter | |
2131 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
2131 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
2132 | self.strdispatchers['complete_command'] = sdisp |
|
2132 | self.strdispatchers['complete_command'] = sdisp | |
2133 | self.Completer.custom_completers = sdisp |
|
2133 | self.Completer.custom_completers = sdisp | |
2134 |
|
2134 | |||
2135 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
2135 | self.set_hook('complete_command', module_completer, str_key = 'import') | |
2136 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
2136 | self.set_hook('complete_command', module_completer, str_key = 'from') | |
2137 | self.set_hook('complete_command', module_completer, str_key = '%aimport') |
|
2137 | self.set_hook('complete_command', module_completer, str_key = '%aimport') | |
2138 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
2138 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') | |
2139 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
2139 | self.set_hook('complete_command', cd_completer, str_key = '%cd') | |
2140 | self.set_hook('complete_command', reset_completer, str_key = '%reset') |
|
2140 | self.set_hook('complete_command', reset_completer, str_key = '%reset') | |
2141 |
|
2141 | |||
2142 | @skip_doctest |
|
2142 | @skip_doctest | |
2143 | def complete(self, text, line=None, cursor_pos=None): |
|
2143 | def complete(self, text, line=None, cursor_pos=None): | |
2144 | """Return the completed text and a list of completions. |
|
2144 | """Return the completed text and a list of completions. | |
2145 |
|
2145 | |||
2146 | Parameters |
|
2146 | Parameters | |
2147 | ---------- |
|
2147 | ---------- | |
2148 |
|
2148 | |||
2149 | text : string |
|
2149 | text : string | |
2150 | A string of text to be completed on. It can be given as empty and |
|
2150 | A string of text to be completed on. It can be given as empty and | |
2151 | instead a line/position pair are given. In this case, the |
|
2151 | instead a line/position pair are given. In this case, the | |
2152 | completer itself will split the line like readline does. |
|
2152 | completer itself will split the line like readline does. | |
2153 |
|
2153 | |||
2154 | line : string, optional |
|
2154 | line : string, optional | |
2155 | The complete line that text is part of. |
|
2155 | The complete line that text is part of. | |
2156 |
|
2156 | |||
2157 | cursor_pos : int, optional |
|
2157 | cursor_pos : int, optional | |
2158 | The position of the cursor on the input line. |
|
2158 | The position of the cursor on the input line. | |
2159 |
|
2159 | |||
2160 | Returns |
|
2160 | Returns | |
2161 | ------- |
|
2161 | ------- | |
2162 | text : string |
|
2162 | text : string | |
2163 | The actual text that was completed. |
|
2163 | The actual text that was completed. | |
2164 |
|
2164 | |||
2165 | matches : list |
|
2165 | matches : list | |
2166 | A sorted list with all possible completions. |
|
2166 | A sorted list with all possible completions. | |
2167 |
|
2167 | |||
2168 | The optional arguments allow the completion to take more context into |
|
2168 | The optional arguments allow the completion to take more context into | |
2169 | account, and are part of the low-level completion API. |
|
2169 | account, and are part of the low-level completion API. | |
2170 |
|
2170 | |||
2171 | This is a wrapper around the completion mechanism, similar to what |
|
2171 | This is a wrapper around the completion mechanism, similar to what | |
2172 | readline does at the command line when the TAB key is hit. By |
|
2172 | readline does at the command line when the TAB key is hit. By | |
2173 | exposing it as a method, it can be used by other non-readline |
|
2173 | exposing it as a method, it can be used by other non-readline | |
2174 | environments (such as GUIs) for text completion. |
|
2174 | environments (such as GUIs) for text completion. | |
2175 |
|
2175 | |||
2176 | Simple usage example: |
|
2176 | Simple usage example: | |
2177 |
|
2177 | |||
2178 | In [1]: x = 'hello' |
|
2178 | In [1]: x = 'hello' | |
2179 |
|
2179 | |||
2180 | In [2]: _ip.complete('x.l') |
|
2180 | In [2]: _ip.complete('x.l') | |
2181 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
2181 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) | |
2182 | """ |
|
2182 | """ | |
2183 |
|
2183 | |||
2184 | # Inject names into __builtin__ so we can complete on the added names. |
|
2184 | # Inject names into __builtin__ so we can complete on the added names. | |
2185 | with self.builtin_trap: |
|
2185 | with self.builtin_trap: | |
2186 | return self.Completer.complete(text, line, cursor_pos) |
|
2186 | return self.Completer.complete(text, line, cursor_pos) | |
2187 |
|
2187 | |||
2188 | def set_custom_completer(self, completer, pos=0): |
|
2188 | def set_custom_completer(self, completer, pos=0): | |
2189 | """Adds a new custom completer function. |
|
2189 | """Adds a new custom completer function. | |
2190 |
|
2190 | |||
2191 | The position argument (defaults to 0) is the index in the completers |
|
2191 | The position argument (defaults to 0) is the index in the completers | |
2192 | list where you want the completer to be inserted.""" |
|
2192 | list where you want the completer to be inserted.""" | |
2193 |
|
2193 | |||
2194 | newcomp = types.MethodType(completer,self.Completer) |
|
2194 | newcomp = types.MethodType(completer,self.Completer) | |
2195 | self.Completer.matchers.insert(pos,newcomp) |
|
2195 | self.Completer.matchers.insert(pos,newcomp) | |
2196 |
|
2196 | |||
2197 | def set_completer_frame(self, frame=None): |
|
2197 | def set_completer_frame(self, frame=None): | |
2198 | """Set the frame of the completer.""" |
|
2198 | """Set the frame of the completer.""" | |
2199 | if frame: |
|
2199 | if frame: | |
2200 | self.Completer.namespace = frame.f_locals |
|
2200 | self.Completer.namespace = frame.f_locals | |
2201 | self.Completer.global_namespace = frame.f_globals |
|
2201 | self.Completer.global_namespace = frame.f_globals | |
2202 | else: |
|
2202 | else: | |
2203 | self.Completer.namespace = self.user_ns |
|
2203 | self.Completer.namespace = self.user_ns | |
2204 | self.Completer.global_namespace = self.user_global_ns |
|
2204 | self.Completer.global_namespace = self.user_global_ns | |
2205 |
|
2205 | |||
2206 | #------------------------------------------------------------------------- |
|
2206 | #------------------------------------------------------------------------- | |
2207 | # Things related to magics |
|
2207 | # Things related to magics | |
2208 | #------------------------------------------------------------------------- |
|
2208 | #------------------------------------------------------------------------- | |
2209 |
|
2209 | |||
2210 | def init_magics(self): |
|
2210 | def init_magics(self): | |
2211 | from IPython.core import magics as m |
|
2211 | from IPython.core import magics as m | |
2212 | self.magics_manager = magic.MagicsManager(shell=self, |
|
2212 | self.magics_manager = magic.MagicsManager(shell=self, | |
2213 | parent=self, |
|
2213 | parent=self, | |
2214 | user_magics=m.UserMagics(self)) |
|
2214 | user_magics=m.UserMagics(self)) | |
2215 | self.configurables.append(self.magics_manager) |
|
2215 | self.configurables.append(self.magics_manager) | |
2216 |
|
2216 | |||
2217 | # Expose as public API from the magics manager |
|
2217 | # Expose as public API from the magics manager | |
2218 | self.register_magics = self.magics_manager.register |
|
2218 | self.register_magics = self.magics_manager.register | |
2219 |
|
2219 | |||
2220 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, |
|
2220 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, | |
2221 | m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics, |
|
2221 | m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics, | |
2222 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, |
|
2222 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, | |
2223 | m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics, |
|
2223 | m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics, | |
2224 | ) |
|
2224 | ) | |
2225 | if sys.version_info >(3,5): |
|
2225 | if sys.version_info >(3,5): | |
2226 | self.register_magics(m.AsyncMagics) |
|
2226 | self.register_magics(m.AsyncMagics) | |
2227 |
|
2227 | |||
2228 | # Register Magic Aliases |
|
2228 | # Register Magic Aliases | |
2229 | mman = self.magics_manager |
|
2229 | mman = self.magics_manager | |
2230 | # FIXME: magic aliases should be defined by the Magics classes |
|
2230 | # FIXME: magic aliases should be defined by the Magics classes | |
2231 | # or in MagicsManager, not here |
|
2231 | # or in MagicsManager, not here | |
2232 | mman.register_alias('ed', 'edit') |
|
2232 | mman.register_alias('ed', 'edit') | |
2233 | mman.register_alias('hist', 'history') |
|
2233 | mman.register_alias('hist', 'history') | |
2234 | mman.register_alias('rep', 'recall') |
|
2234 | mman.register_alias('rep', 'recall') | |
2235 | mman.register_alias('SVG', 'svg', 'cell') |
|
2235 | mman.register_alias('SVG', 'svg', 'cell') | |
2236 | mman.register_alias('HTML', 'html', 'cell') |
|
2236 | mman.register_alias('HTML', 'html', 'cell') | |
2237 | mman.register_alias('file', 'writefile', 'cell') |
|
2237 | mman.register_alias('file', 'writefile', 'cell') | |
2238 |
|
2238 | |||
2239 | # FIXME: Move the color initialization to the DisplayHook, which |
|
2239 | # FIXME: Move the color initialization to the DisplayHook, which | |
2240 | # should be split into a prompt manager and displayhook. We probably |
|
2240 | # should be split into a prompt manager and displayhook. We probably | |
2241 | # even need a centralize colors management object. |
|
2241 | # even need a centralize colors management object. | |
2242 | self.run_line_magic('colors', self.colors) |
|
2242 | self.run_line_magic('colors', self.colors) | |
2243 |
|
2243 | |||
2244 | # Defined here so that it's included in the documentation |
|
2244 | # Defined here so that it's included in the documentation | |
2245 | @functools.wraps(magic.MagicsManager.register_function) |
|
2245 | @functools.wraps(magic.MagicsManager.register_function) | |
2246 | def register_magic_function(self, func, magic_kind='line', magic_name=None): |
|
2246 | def register_magic_function(self, func, magic_kind='line', magic_name=None): | |
2247 | self.magics_manager.register_function(func, |
|
2247 | self.magics_manager.register_function(func, | |
2248 | magic_kind=magic_kind, magic_name=magic_name) |
|
2248 | magic_kind=magic_kind, magic_name=magic_name) | |
2249 |
|
2249 | |||
2250 | def run_line_magic(self, magic_name, line, _stack_depth=1): |
|
2250 | def run_line_magic(self, magic_name, line, _stack_depth=1): | |
2251 | """Execute the given line magic. |
|
2251 | """Execute the given line magic. | |
2252 |
|
2252 | |||
2253 | Parameters |
|
2253 | Parameters | |
2254 | ---------- |
|
2254 | ---------- | |
2255 | magic_name : str |
|
2255 | magic_name : str | |
2256 | Name of the desired magic function, without '%' prefix. |
|
2256 | Name of the desired magic function, without '%' prefix. | |
2257 |
|
2257 | |||
2258 | line : str |
|
2258 | line : str | |
2259 | The rest of the input line as a single string. |
|
2259 | The rest of the input line as a single string. | |
2260 |
|
2260 | |||
2261 | _stack_depth : int |
|
2261 | _stack_depth : int | |
2262 | If run_line_magic() is called from magic() then _stack_depth=2. |
|
2262 | If run_line_magic() is called from magic() then _stack_depth=2. | |
2263 | This is added to ensure backward compatibility for use of 'get_ipython().magic()' |
|
2263 | This is added to ensure backward compatibility for use of 'get_ipython().magic()' | |
2264 | """ |
|
2264 | """ | |
2265 | fn = self.find_line_magic(magic_name) |
|
2265 | fn = self.find_line_magic(magic_name) | |
2266 | if fn is None: |
|
2266 | if fn is None: | |
2267 | cm = self.find_cell_magic(magic_name) |
|
2267 | cm = self.find_cell_magic(magic_name) | |
2268 | etpl = "Line magic function `%%%s` not found%s." |
|
2268 | etpl = "Line magic function `%%%s` not found%s." | |
2269 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' |
|
2269 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' | |
2270 | 'did you mean that instead?)' % magic_name ) |
|
2270 | 'did you mean that instead?)' % magic_name ) | |
2271 | raise UsageError(etpl % (magic_name, extra)) |
|
2271 | raise UsageError(etpl % (magic_name, extra)) | |
2272 | else: |
|
2272 | else: | |
2273 | # Note: this is the distance in the stack to the user's frame. |
|
2273 | # Note: this is the distance in the stack to the user's frame. | |
2274 | # This will need to be updated if the internal calling logic gets |
|
2274 | # This will need to be updated if the internal calling logic gets | |
2275 | # refactored, or else we'll be expanding the wrong variables. |
|
2275 | # refactored, or else we'll be expanding the wrong variables. | |
2276 |
|
2276 | |||
2277 | # Determine stack_depth depending on where run_line_magic() has been called |
|
2277 | # Determine stack_depth depending on where run_line_magic() has been called | |
2278 | stack_depth = _stack_depth |
|
2278 | stack_depth = _stack_depth | |
2279 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2279 | magic_arg_s = self.var_expand(line, stack_depth) | |
2280 | # Put magic args in a list so we can call with f(*a) syntax |
|
2280 | # Put magic args in a list so we can call with f(*a) syntax | |
2281 | args = [magic_arg_s] |
|
2281 | args = [magic_arg_s] | |
2282 | kwargs = {} |
|
2282 | kwargs = {} | |
2283 | # Grab local namespace if we need it: |
|
2283 | # Grab local namespace if we need it: | |
2284 | if getattr(fn, "needs_local_scope", False): |
|
2284 | if getattr(fn, "needs_local_scope", False): | |
2285 | kwargs['local_ns'] = sys._getframe(stack_depth).f_locals |
|
2285 | kwargs['local_ns'] = sys._getframe(stack_depth).f_locals | |
2286 | with self.builtin_trap: |
|
2286 | with self.builtin_trap: | |
2287 | result = fn(*args,**kwargs) |
|
2287 | result = fn(*args,**kwargs) | |
2288 | return result |
|
2288 | return result | |
2289 |
|
2289 | |||
2290 | def run_cell_magic(self, magic_name, line, cell): |
|
2290 | def run_cell_magic(self, magic_name, line, cell): | |
2291 | """Execute the given cell magic. |
|
2291 | """Execute the given cell magic. | |
2292 |
|
2292 | |||
2293 | Parameters |
|
2293 | Parameters | |
2294 | ---------- |
|
2294 | ---------- | |
2295 | magic_name : str |
|
2295 | magic_name : str | |
2296 | Name of the desired magic function, without '%' prefix. |
|
2296 | Name of the desired magic function, without '%' prefix. | |
2297 |
|
2297 | |||
2298 | line : str |
|
2298 | line : str | |
2299 | The rest of the first input line as a single string. |
|
2299 | The rest of the first input line as a single string. | |
2300 |
|
2300 | |||
2301 | cell : str |
|
2301 | cell : str | |
2302 | The body of the cell as a (possibly multiline) string. |
|
2302 | The body of the cell as a (possibly multiline) string. | |
2303 | """ |
|
2303 | """ | |
2304 | fn = self.find_cell_magic(magic_name) |
|
2304 | fn = self.find_cell_magic(magic_name) | |
2305 | if fn is None: |
|
2305 | if fn is None: | |
2306 | lm = self.find_line_magic(magic_name) |
|
2306 | lm = self.find_line_magic(magic_name) | |
2307 | etpl = "Cell magic `%%{0}` not found{1}." |
|
2307 | etpl = "Cell magic `%%{0}` not found{1}." | |
2308 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' |
|
2308 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' | |
2309 | 'did you mean that instead?)'.format(magic_name)) |
|
2309 | 'did you mean that instead?)'.format(magic_name)) | |
2310 | raise UsageError(etpl.format(magic_name, extra)) |
|
2310 | raise UsageError(etpl.format(magic_name, extra)) | |
2311 | elif cell == '': |
|
2311 | elif cell == '': | |
2312 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) |
|
2312 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) | |
2313 | if self.find_line_magic(magic_name) is not None: |
|
2313 | if self.find_line_magic(magic_name) is not None: | |
2314 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) |
|
2314 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) | |
2315 | raise UsageError(message) |
|
2315 | raise UsageError(message) | |
2316 | else: |
|
2316 | else: | |
2317 | # Note: this is the distance in the stack to the user's frame. |
|
2317 | # Note: this is the distance in the stack to the user's frame. | |
2318 | # This will need to be updated if the internal calling logic gets |
|
2318 | # This will need to be updated if the internal calling logic gets | |
2319 | # refactored, or else we'll be expanding the wrong variables. |
|
2319 | # refactored, or else we'll be expanding the wrong variables. | |
2320 | stack_depth = 2 |
|
2320 | stack_depth = 2 | |
2321 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2321 | magic_arg_s = self.var_expand(line, stack_depth) | |
2322 | with self.builtin_trap: |
|
2322 | with self.builtin_trap: | |
2323 | result = fn(magic_arg_s, cell) |
|
2323 | result = fn(magic_arg_s, cell) | |
2324 | return result |
|
2324 | return result | |
2325 |
|
2325 | |||
2326 | def find_line_magic(self, magic_name): |
|
2326 | def find_line_magic(self, magic_name): | |
2327 | """Find and return a line magic by name. |
|
2327 | """Find and return a line magic by name. | |
2328 |
|
2328 | |||
2329 | Returns None if the magic isn't found.""" |
|
2329 | Returns None if the magic isn't found.""" | |
2330 | return self.magics_manager.magics['line'].get(magic_name) |
|
2330 | return self.magics_manager.magics['line'].get(magic_name) | |
2331 |
|
2331 | |||
2332 | def find_cell_magic(self, magic_name): |
|
2332 | def find_cell_magic(self, magic_name): | |
2333 | """Find and return a cell magic by name. |
|
2333 | """Find and return a cell magic by name. | |
2334 |
|
2334 | |||
2335 | Returns None if the magic isn't found.""" |
|
2335 | Returns None if the magic isn't found.""" | |
2336 | return self.magics_manager.magics['cell'].get(magic_name) |
|
2336 | return self.magics_manager.magics['cell'].get(magic_name) | |
2337 |
|
2337 | |||
2338 | def find_magic(self, magic_name, magic_kind='line'): |
|
2338 | def find_magic(self, magic_name, magic_kind='line'): | |
2339 | """Find and return a magic of the given type by name. |
|
2339 | """Find and return a magic of the given type by name. | |
2340 |
|
2340 | |||
2341 | Returns None if the magic isn't found.""" |
|
2341 | Returns None if the magic isn't found.""" | |
2342 | return self.magics_manager.magics[magic_kind].get(magic_name) |
|
2342 | return self.magics_manager.magics[magic_kind].get(magic_name) | |
2343 |
|
2343 | |||
2344 | def magic(self, arg_s): |
|
2344 | def magic(self, arg_s): | |
2345 | """DEPRECATED. Use run_line_magic() instead. |
|
2345 | """DEPRECATED. Use run_line_magic() instead. | |
2346 |
|
2346 | |||
2347 | Call a magic function by name. |
|
2347 | Call a magic function by name. | |
2348 |
|
2348 | |||
2349 | Input: a string containing the name of the magic function to call and |
|
2349 | Input: a string containing the name of the magic function to call and | |
2350 | any additional arguments to be passed to the magic. |
|
2350 | any additional arguments to be passed to the magic. | |
2351 |
|
2351 | |||
2352 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
2352 | magic('name -opt foo bar') is equivalent to typing at the ipython | |
2353 | prompt: |
|
2353 | prompt: | |
2354 |
|
2354 | |||
2355 | In[1]: %name -opt foo bar |
|
2355 | In[1]: %name -opt foo bar | |
2356 |
|
2356 | |||
2357 | To call a magic without arguments, simply use magic('name'). |
|
2357 | To call a magic without arguments, simply use magic('name'). | |
2358 |
|
2358 | |||
2359 | This provides a proper Python function to call IPython's magics in any |
|
2359 | This provides a proper Python function to call IPython's magics in any | |
2360 | valid Python code you can type at the interpreter, including loops and |
|
2360 | valid Python code you can type at the interpreter, including loops and | |
2361 | compound statements. |
|
2361 | compound statements. | |
2362 | """ |
|
2362 | """ | |
2363 | # TODO: should we issue a loud deprecation warning here? |
|
2363 | # TODO: should we issue a loud deprecation warning here? | |
2364 | magic_name, _, magic_arg_s = arg_s.partition(' ') |
|
2364 | magic_name, _, magic_arg_s = arg_s.partition(' ') | |
2365 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
2365 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) | |
2366 | return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2) |
|
2366 | return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2) | |
2367 |
|
2367 | |||
2368 | #------------------------------------------------------------------------- |
|
2368 | #------------------------------------------------------------------------- | |
2369 | # Things related to macros |
|
2369 | # Things related to macros | |
2370 | #------------------------------------------------------------------------- |
|
2370 | #------------------------------------------------------------------------- | |
2371 |
|
2371 | |||
2372 | def define_macro(self, name, themacro): |
|
2372 | def define_macro(self, name, themacro): | |
2373 | """Define a new macro |
|
2373 | """Define a new macro | |
2374 |
|
2374 | |||
2375 | Parameters |
|
2375 | Parameters | |
2376 | ---------- |
|
2376 | ---------- | |
2377 | name : str |
|
2377 | name : str | |
2378 | The name of the macro. |
|
2378 | The name of the macro. | |
2379 | themacro : str or Macro |
|
2379 | themacro : str or Macro | |
2380 | The action to do upon invoking the macro. If a string, a new |
|
2380 | The action to do upon invoking the macro. If a string, a new | |
2381 | Macro object is created by passing the string to it. |
|
2381 | Macro object is created by passing the string to it. | |
2382 | """ |
|
2382 | """ | |
2383 |
|
2383 | |||
2384 | from IPython.core import macro |
|
2384 | from IPython.core import macro | |
2385 |
|
2385 | |||
2386 | if isinstance(themacro, str): |
|
2386 | if isinstance(themacro, str): | |
2387 | themacro = macro.Macro(themacro) |
|
2387 | themacro = macro.Macro(themacro) | |
2388 | if not isinstance(themacro, macro.Macro): |
|
2388 | if not isinstance(themacro, macro.Macro): | |
2389 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2389 | raise ValueError('A macro must be a string or a Macro instance.') | |
2390 | self.user_ns[name] = themacro |
|
2390 | self.user_ns[name] = themacro | |
2391 |
|
2391 | |||
2392 | #------------------------------------------------------------------------- |
|
2392 | #------------------------------------------------------------------------- | |
2393 | # Things related to the running of system commands |
|
2393 | # Things related to the running of system commands | |
2394 | #------------------------------------------------------------------------- |
|
2394 | #------------------------------------------------------------------------- | |
2395 |
|
2395 | |||
2396 | def system_piped(self, cmd): |
|
2396 | def system_piped(self, cmd): | |
2397 | """Call the given cmd in a subprocess, piping stdout/err |
|
2397 | """Call the given cmd in a subprocess, piping stdout/err | |
2398 |
|
2398 | |||
2399 | Parameters |
|
2399 | Parameters | |
2400 | ---------- |
|
2400 | ---------- | |
2401 | cmd : str |
|
2401 | cmd : str | |
2402 | Command to execute (can not end in '&', as background processes are |
|
2402 | Command to execute (can not end in '&', as background processes are | |
2403 | not supported. Should not be a command that expects input |
|
2403 | not supported. Should not be a command that expects input | |
2404 | other than simple text. |
|
2404 | other than simple text. | |
2405 | """ |
|
2405 | """ | |
2406 | if cmd.rstrip().endswith('&'): |
|
2406 | if cmd.rstrip().endswith('&'): | |
2407 | # this is *far* from a rigorous test |
|
2407 | # this is *far* from a rigorous test | |
2408 | # We do not support backgrounding processes because we either use |
|
2408 | # We do not support backgrounding processes because we either use | |
2409 | # pexpect or pipes to read from. Users can always just call |
|
2409 | # pexpect or pipes to read from. Users can always just call | |
2410 | # os.system() or use ip.system=ip.system_raw |
|
2410 | # os.system() or use ip.system=ip.system_raw | |
2411 | # if they really want a background process. |
|
2411 | # if they really want a background process. | |
2412 | raise OSError("Background processes not supported.") |
|
2412 | raise OSError("Background processes not supported.") | |
2413 |
|
2413 | |||
2414 | # we explicitly do NOT return the subprocess status code, because |
|
2414 | # we explicitly do NOT return the subprocess status code, because | |
2415 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2415 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2416 | # Instead, we store the exit_code in user_ns. |
|
2416 | # Instead, we store the exit_code in user_ns. | |
2417 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) |
|
2417 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) | |
2418 |
|
2418 | |||
2419 | def system_raw(self, cmd): |
|
2419 | def system_raw(self, cmd): | |
2420 | """Call the given cmd in a subprocess using os.system on Windows or |
|
2420 | """Call the given cmd in a subprocess using os.system on Windows or | |
2421 | subprocess.call using the system shell on other platforms. |
|
2421 | subprocess.call using the system shell on other platforms. | |
2422 |
|
2422 | |||
2423 | Parameters |
|
2423 | Parameters | |
2424 | ---------- |
|
2424 | ---------- | |
2425 | cmd : str |
|
2425 | cmd : str | |
2426 | Command to execute. |
|
2426 | Command to execute. | |
2427 | """ |
|
2427 | """ | |
2428 | cmd = self.var_expand(cmd, depth=1) |
|
2428 | cmd = self.var_expand(cmd, depth=1) | |
2429 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2429 | # protect os.system from UNC paths on Windows, which it can't handle: | |
2430 | if sys.platform == 'win32': |
|
2430 | if sys.platform == 'win32': | |
2431 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2431 | from IPython.utils._process_win32 import AvoidUNCPath | |
2432 | with AvoidUNCPath() as path: |
|
2432 | with AvoidUNCPath() as path: | |
2433 | if path is not None: |
|
2433 | if path is not None: | |
2434 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2434 | cmd = '"pushd %s &&"%s' % (path, cmd) | |
2435 | try: |
|
2435 | try: | |
2436 | ec = os.system(cmd) |
|
2436 | ec = os.system(cmd) | |
2437 | except KeyboardInterrupt: |
|
2437 | except KeyboardInterrupt: | |
2438 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2438 | print('\n' + self.get_exception_only(), file=sys.stderr) | |
2439 | ec = -2 |
|
2439 | ec = -2 | |
2440 | else: |
|
2440 | else: | |
2441 | # For posix the result of the subprocess.call() below is an exit |
|
2441 | # For posix the result of the subprocess.call() below is an exit | |
2442 | # code, which by convention is zero for success, positive for |
|
2442 | # code, which by convention is zero for success, positive for | |
2443 | # program failure. Exit codes above 128 are reserved for signals, |
|
2443 | # program failure. Exit codes above 128 are reserved for signals, | |
2444 | # and the formula for converting a signal to an exit code is usually |
|
2444 | # and the formula for converting a signal to an exit code is usually | |
2445 | # signal_number+128. To more easily differentiate between exit |
|
2445 | # signal_number+128. To more easily differentiate between exit | |
2446 | # codes and signals, ipython uses negative numbers. For instance |
|
2446 | # codes and signals, ipython uses negative numbers. For instance | |
2447 | # since control-c is signal 2 but exit code 130, ipython's |
|
2447 | # since control-c is signal 2 but exit code 130, ipython's | |
2448 | # _exit_code variable will read -2. Note that some shells like |
|
2448 | # _exit_code variable will read -2. Note that some shells like | |
2449 | # csh and fish don't follow sh/bash conventions for exit codes. |
|
2449 | # csh and fish don't follow sh/bash conventions for exit codes. | |
2450 | executable = os.environ.get('SHELL', None) |
|
2450 | executable = os.environ.get('SHELL', None) | |
2451 | try: |
|
2451 | try: | |
2452 | # Use env shell instead of default /bin/sh |
|
2452 | # Use env shell instead of default /bin/sh | |
2453 | ec = subprocess.call(cmd, shell=True, executable=executable) |
|
2453 | ec = subprocess.call(cmd, shell=True, executable=executable) | |
2454 | except KeyboardInterrupt: |
|
2454 | except KeyboardInterrupt: | |
2455 | # intercept control-C; a long traceback is not useful here |
|
2455 | # intercept control-C; a long traceback is not useful here | |
2456 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2456 | print('\n' + self.get_exception_only(), file=sys.stderr) | |
2457 | ec = 130 |
|
2457 | ec = 130 | |
2458 | if ec > 128: |
|
2458 | if ec > 128: | |
2459 | ec = -(ec - 128) |
|
2459 | ec = -(ec - 128) | |
2460 |
|
2460 | |||
2461 | # We explicitly do NOT return the subprocess status code, because |
|
2461 | # We explicitly do NOT return the subprocess status code, because | |
2462 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2462 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2463 | # Instead, we store the exit_code in user_ns. Note the semantics |
|
2463 | # Instead, we store the exit_code in user_ns. Note the semantics | |
2464 | # of _exit_code: for control-c, _exit_code == -signal.SIGNIT, |
|
2464 | # of _exit_code: for control-c, _exit_code == -signal.SIGNIT, | |
2465 | # but raising SystemExit(_exit_code) will give status 254! |
|
2465 | # but raising SystemExit(_exit_code) will give status 254! | |
2466 | self.user_ns['_exit_code'] = ec |
|
2466 | self.user_ns['_exit_code'] = ec | |
2467 |
|
2467 | |||
2468 | # use piped system by default, because it is better behaved |
|
2468 | # use piped system by default, because it is better behaved | |
2469 | system = system_piped |
|
2469 | system = system_piped | |
2470 |
|
2470 | |||
2471 | def getoutput(self, cmd, split=True, depth=0): |
|
2471 | def getoutput(self, cmd, split=True, depth=0): | |
2472 | """Get output (possibly including stderr) from a subprocess. |
|
2472 | """Get output (possibly including stderr) from a subprocess. | |
2473 |
|
2473 | |||
2474 | Parameters |
|
2474 | Parameters | |
2475 | ---------- |
|
2475 | ---------- | |
2476 | cmd : str |
|
2476 | cmd : str | |
2477 | Command to execute (can not end in '&', as background processes are |
|
2477 | Command to execute (can not end in '&', as background processes are | |
2478 | not supported. |
|
2478 | not supported. | |
2479 | split : bool, optional |
|
2479 | split : bool, optional | |
2480 | If True, split the output into an IPython SList. Otherwise, an |
|
2480 | If True, split the output into an IPython SList. Otherwise, an | |
2481 | IPython LSString is returned. These are objects similar to normal |
|
2481 | IPython LSString is returned. These are objects similar to normal | |
2482 | lists and strings, with a few convenience attributes for easier |
|
2482 | lists and strings, with a few convenience attributes for easier | |
2483 | manipulation of line-based output. You can use '?' on them for |
|
2483 | manipulation of line-based output. You can use '?' on them for | |
2484 | details. |
|
2484 | details. | |
2485 | depth : int, optional |
|
2485 | depth : int, optional | |
2486 | How many frames above the caller are the local variables which should |
|
2486 | How many frames above the caller are the local variables which should | |
2487 | be expanded in the command string? The default (0) assumes that the |
|
2487 | be expanded in the command string? The default (0) assumes that the | |
2488 | expansion variables are in the stack frame calling this function. |
|
2488 | expansion variables are in the stack frame calling this function. | |
2489 | """ |
|
2489 | """ | |
2490 | if cmd.rstrip().endswith('&'): |
|
2490 | if cmd.rstrip().endswith('&'): | |
2491 | # this is *far* from a rigorous test |
|
2491 | # this is *far* from a rigorous test | |
2492 | raise OSError("Background processes not supported.") |
|
2492 | raise OSError("Background processes not supported.") | |
2493 | out = getoutput(self.var_expand(cmd, depth=depth+1)) |
|
2493 | out = getoutput(self.var_expand(cmd, depth=depth+1)) | |
2494 | if split: |
|
2494 | if split: | |
2495 | out = SList(out.splitlines()) |
|
2495 | out = SList(out.splitlines()) | |
2496 | else: |
|
2496 | else: | |
2497 | out = LSString(out) |
|
2497 | out = LSString(out) | |
2498 | return out |
|
2498 | return out | |
2499 |
|
2499 | |||
2500 | #------------------------------------------------------------------------- |
|
2500 | #------------------------------------------------------------------------- | |
2501 | # Things related to aliases |
|
2501 | # Things related to aliases | |
2502 | #------------------------------------------------------------------------- |
|
2502 | #------------------------------------------------------------------------- | |
2503 |
|
2503 | |||
2504 | def init_alias(self): |
|
2504 | def init_alias(self): | |
2505 | self.alias_manager = AliasManager(shell=self, parent=self) |
|
2505 | self.alias_manager = AliasManager(shell=self, parent=self) | |
2506 | self.configurables.append(self.alias_manager) |
|
2506 | self.configurables.append(self.alias_manager) | |
2507 |
|
2507 | |||
2508 | #------------------------------------------------------------------------- |
|
2508 | #------------------------------------------------------------------------- | |
2509 | # Things related to extensions |
|
2509 | # Things related to extensions | |
2510 | #------------------------------------------------------------------------- |
|
2510 | #------------------------------------------------------------------------- | |
2511 |
|
2511 | |||
2512 | def init_extension_manager(self): |
|
2512 | def init_extension_manager(self): | |
2513 | self.extension_manager = ExtensionManager(shell=self, parent=self) |
|
2513 | self.extension_manager = ExtensionManager(shell=self, parent=self) | |
2514 | self.configurables.append(self.extension_manager) |
|
2514 | self.configurables.append(self.extension_manager) | |
2515 |
|
2515 | |||
2516 | #------------------------------------------------------------------------- |
|
2516 | #------------------------------------------------------------------------- | |
2517 | # Things related to payloads |
|
2517 | # Things related to payloads | |
2518 | #------------------------------------------------------------------------- |
|
2518 | #------------------------------------------------------------------------- | |
2519 |
|
2519 | |||
2520 | def init_payload(self): |
|
2520 | def init_payload(self): | |
2521 | self.payload_manager = PayloadManager(parent=self) |
|
2521 | self.payload_manager = PayloadManager(parent=self) | |
2522 | self.configurables.append(self.payload_manager) |
|
2522 | self.configurables.append(self.payload_manager) | |
2523 |
|
2523 | |||
2524 | #------------------------------------------------------------------------- |
|
2524 | #------------------------------------------------------------------------- | |
2525 | # Things related to the prefilter |
|
2525 | # Things related to the prefilter | |
2526 | #------------------------------------------------------------------------- |
|
2526 | #------------------------------------------------------------------------- | |
2527 |
|
2527 | |||
2528 | def init_prefilter(self): |
|
2528 | def init_prefilter(self): | |
2529 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) |
|
2529 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) | |
2530 | self.configurables.append(self.prefilter_manager) |
|
2530 | self.configurables.append(self.prefilter_manager) | |
2531 | # Ultimately this will be refactored in the new interpreter code, but |
|
2531 | # Ultimately this will be refactored in the new interpreter code, but | |
2532 | # for now, we should expose the main prefilter method (there's legacy |
|
2532 | # for now, we should expose the main prefilter method (there's legacy | |
2533 | # code out there that may rely on this). |
|
2533 | # code out there that may rely on this). | |
2534 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2534 | self.prefilter = self.prefilter_manager.prefilter_lines | |
2535 |
|
2535 | |||
2536 | def auto_rewrite_input(self, cmd): |
|
2536 | def auto_rewrite_input(self, cmd): | |
2537 | """Print to the screen the rewritten form of the user's command. |
|
2537 | """Print to the screen the rewritten form of the user's command. | |
2538 |
|
2538 | |||
2539 | This shows visual feedback by rewriting input lines that cause |
|
2539 | This shows visual feedback by rewriting input lines that cause | |
2540 | automatic calling to kick in, like:: |
|
2540 | automatic calling to kick in, like:: | |
2541 |
|
2541 | |||
2542 | /f x |
|
2542 | /f x | |
2543 |
|
2543 | |||
2544 | into:: |
|
2544 | into:: | |
2545 |
|
2545 | |||
2546 | ------> f(x) |
|
2546 | ------> f(x) | |
2547 |
|
2547 | |||
2548 | after the user's input prompt. This helps the user understand that the |
|
2548 | after the user's input prompt. This helps the user understand that the | |
2549 | input line was transformed automatically by IPython. |
|
2549 | input line was transformed automatically by IPython. | |
2550 | """ |
|
2550 | """ | |
2551 | if not self.show_rewritten_input: |
|
2551 | if not self.show_rewritten_input: | |
2552 | return |
|
2552 | return | |
2553 |
|
2553 | |||
2554 | # This is overridden in TerminalInteractiveShell to use fancy prompts |
|
2554 | # This is overridden in TerminalInteractiveShell to use fancy prompts | |
2555 | print("------> " + cmd) |
|
2555 | print("------> " + cmd) | |
2556 |
|
2556 | |||
2557 | #------------------------------------------------------------------------- |
|
2557 | #------------------------------------------------------------------------- | |
2558 | # Things related to extracting values/expressions from kernel and user_ns |
|
2558 | # Things related to extracting values/expressions from kernel and user_ns | |
2559 | #------------------------------------------------------------------------- |
|
2559 | #------------------------------------------------------------------------- | |
2560 |
|
2560 | |||
2561 | def _user_obj_error(self): |
|
2561 | def _user_obj_error(self): | |
2562 | """return simple exception dict |
|
2562 | """return simple exception dict | |
2563 |
|
2563 | |||
2564 | for use in user_expressions |
|
2564 | for use in user_expressions | |
2565 | """ |
|
2565 | """ | |
2566 |
|
2566 | |||
2567 | etype, evalue, tb = self._get_exc_info() |
|
2567 | etype, evalue, tb = self._get_exc_info() | |
2568 | stb = self.InteractiveTB.get_exception_only(etype, evalue) |
|
2568 | stb = self.InteractiveTB.get_exception_only(etype, evalue) | |
2569 |
|
2569 | |||
2570 | exc_info = { |
|
2570 | exc_info = { | |
2571 | u'status' : 'error', |
|
2571 | u'status' : 'error', | |
2572 | u'traceback' : stb, |
|
2572 | u'traceback' : stb, | |
2573 | u'ename' : etype.__name__, |
|
2573 | u'ename' : etype.__name__, | |
2574 | u'evalue' : py3compat.safe_unicode(evalue), |
|
2574 | u'evalue' : py3compat.safe_unicode(evalue), | |
2575 | } |
|
2575 | } | |
2576 |
|
2576 | |||
2577 | return exc_info |
|
2577 | return exc_info | |
2578 |
|
2578 | |||
2579 | def _format_user_obj(self, obj): |
|
2579 | def _format_user_obj(self, obj): | |
2580 | """format a user object to display dict |
|
2580 | """format a user object to display dict | |
2581 |
|
2581 | |||
2582 | for use in user_expressions |
|
2582 | for use in user_expressions | |
2583 | """ |
|
2583 | """ | |
2584 |
|
2584 | |||
2585 | data, md = self.display_formatter.format(obj) |
|
2585 | data, md = self.display_formatter.format(obj) | |
2586 | value = { |
|
2586 | value = { | |
2587 | 'status' : 'ok', |
|
2587 | 'status' : 'ok', | |
2588 | 'data' : data, |
|
2588 | 'data' : data, | |
2589 | 'metadata' : md, |
|
2589 | 'metadata' : md, | |
2590 | } |
|
2590 | } | |
2591 | return value |
|
2591 | return value | |
2592 |
|
2592 | |||
2593 | def user_expressions(self, expressions): |
|
2593 | def user_expressions(self, expressions): | |
2594 | """Evaluate a dict of expressions in the user's namespace. |
|
2594 | """Evaluate a dict of expressions in the user's namespace. | |
2595 |
|
2595 | |||
2596 | Parameters |
|
2596 | Parameters | |
2597 | ---------- |
|
2597 | ---------- | |
2598 | expressions : dict |
|
2598 | expressions : dict | |
2599 | A dict with string keys and string values. The expression values |
|
2599 | A dict with string keys and string values. The expression values | |
2600 | should be valid Python expressions, each of which will be evaluated |
|
2600 | should be valid Python expressions, each of which will be evaluated | |
2601 | in the user namespace. |
|
2601 | in the user namespace. | |
2602 |
|
2602 | |||
2603 | Returns |
|
2603 | Returns | |
2604 | ------- |
|
2604 | ------- | |
2605 | A dict, keyed like the input expressions dict, with the rich mime-typed |
|
2605 | A dict, keyed like the input expressions dict, with the rich mime-typed | |
2606 | display_data of each value. |
|
2606 | display_data of each value. | |
2607 | """ |
|
2607 | """ | |
2608 | out = {} |
|
2608 | out = {} | |
2609 | user_ns = self.user_ns |
|
2609 | user_ns = self.user_ns | |
2610 | global_ns = self.user_global_ns |
|
2610 | global_ns = self.user_global_ns | |
2611 |
|
2611 | |||
2612 | for key, expr in expressions.items(): |
|
2612 | for key, expr in expressions.items(): | |
2613 | try: |
|
2613 | try: | |
2614 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) |
|
2614 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) | |
2615 | except: |
|
2615 | except: | |
2616 | value = self._user_obj_error() |
|
2616 | value = self._user_obj_error() | |
2617 | out[key] = value |
|
2617 | out[key] = value | |
2618 | return out |
|
2618 | return out | |
2619 |
|
2619 | |||
2620 | #------------------------------------------------------------------------- |
|
2620 | #------------------------------------------------------------------------- | |
2621 | # Things related to the running of code |
|
2621 | # Things related to the running of code | |
2622 | #------------------------------------------------------------------------- |
|
2622 | #------------------------------------------------------------------------- | |
2623 |
|
2623 | |||
2624 | def ex(self, cmd): |
|
2624 | def ex(self, cmd): | |
2625 | """Execute a normal python statement in user namespace.""" |
|
2625 | """Execute a normal python statement in user namespace.""" | |
2626 | with self.builtin_trap: |
|
2626 | with self.builtin_trap: | |
2627 | exec(cmd, self.user_global_ns, self.user_ns) |
|
2627 | exec(cmd, self.user_global_ns, self.user_ns) | |
2628 |
|
2628 | |||
2629 | def ev(self, expr): |
|
2629 | def ev(self, expr): | |
2630 | """Evaluate python expression expr in user namespace. |
|
2630 | """Evaluate python expression expr in user namespace. | |
2631 |
|
2631 | |||
2632 | Returns the result of evaluation |
|
2632 | Returns the result of evaluation | |
2633 | """ |
|
2633 | """ | |
2634 | with self.builtin_trap: |
|
2634 | with self.builtin_trap: | |
2635 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2635 | return eval(expr, self.user_global_ns, self.user_ns) | |
2636 |
|
2636 | |||
2637 | def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False): |
|
2637 | def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False): | |
2638 | """A safe version of the builtin execfile(). |
|
2638 | """A safe version of the builtin execfile(). | |
2639 |
|
2639 | |||
2640 | This version will never throw an exception, but instead print |
|
2640 | This version will never throw an exception, but instead print | |
2641 | helpful error messages to the screen. This only works on pure |
|
2641 | helpful error messages to the screen. This only works on pure | |
2642 | Python files with the .py extension. |
|
2642 | Python files with the .py extension. | |
2643 |
|
2643 | |||
2644 | Parameters |
|
2644 | Parameters | |
2645 | ---------- |
|
2645 | ---------- | |
2646 | fname : string |
|
2646 | fname : string | |
2647 | The name of the file to be executed. |
|
2647 | The name of the file to be executed. | |
2648 | where : tuple |
|
2648 | where : tuple | |
2649 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2649 | One or two namespaces, passed to execfile() as (globals,locals). | |
2650 | If only one is given, it is passed as both. |
|
2650 | If only one is given, it is passed as both. | |
2651 | exit_ignore : bool (False) |
|
2651 | exit_ignore : bool (False) | |
2652 | If True, then silence SystemExit for non-zero status (it is always |
|
2652 | If True, then silence SystemExit for non-zero status (it is always | |
2653 | silenced for zero status, as it is so common). |
|
2653 | silenced for zero status, as it is so common). | |
2654 | raise_exceptions : bool (False) |
|
2654 | raise_exceptions : bool (False) | |
2655 | If True raise exceptions everywhere. Meant for testing. |
|
2655 | If True raise exceptions everywhere. Meant for testing. | |
2656 | shell_futures : bool (False) |
|
2656 | shell_futures : bool (False) | |
2657 | If True, the code will share future statements with the interactive |
|
2657 | If True, the code will share future statements with the interactive | |
2658 | shell. It will both be affected by previous __future__ imports, and |
|
2658 | shell. It will both be affected by previous __future__ imports, and | |
2659 | any __future__ imports in the code will affect the shell. If False, |
|
2659 | any __future__ imports in the code will affect the shell. If False, | |
2660 | __future__ imports are not shared in either direction. |
|
2660 | __future__ imports are not shared in either direction. | |
2661 |
|
2661 | |||
2662 | """ |
|
2662 | """ | |
2663 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2663 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2664 |
|
2664 | |||
2665 | # Make sure we can open the file |
|
2665 | # Make sure we can open the file | |
2666 | try: |
|
2666 | try: | |
2667 | with open(fname): |
|
2667 | with open(fname): | |
2668 | pass |
|
2668 | pass | |
2669 | except: |
|
2669 | except: | |
2670 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2670 | warn('Could not open file <%s> for safe execution.' % fname) | |
2671 | return |
|
2671 | return | |
2672 |
|
2672 | |||
2673 | # Find things also in current directory. This is needed to mimic the |
|
2673 | # Find things also in current directory. This is needed to mimic the | |
2674 | # behavior of running a script from the system command line, where |
|
2674 | # behavior of running a script from the system command line, where | |
2675 | # Python inserts the script's directory into sys.path |
|
2675 | # Python inserts the script's directory into sys.path | |
2676 | dname = os.path.dirname(fname) |
|
2676 | dname = os.path.dirname(fname) | |
2677 |
|
2677 | |||
2678 | with prepended_to_syspath(dname), self.builtin_trap: |
|
2678 | with prepended_to_syspath(dname), self.builtin_trap: | |
2679 | try: |
|
2679 | try: | |
2680 | glob, loc = (where + (None, ))[:2] |
|
2680 | glob, loc = (where + (None, ))[:2] | |
2681 | py3compat.execfile( |
|
2681 | py3compat.execfile( | |
2682 | fname, glob, loc, |
|
2682 | fname, glob, loc, | |
2683 | self.compile if shell_futures else None) |
|
2683 | self.compile if shell_futures else None) | |
2684 | except SystemExit as status: |
|
2684 | except SystemExit as status: | |
2685 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2685 | # If the call was made with 0 or None exit status (sys.exit(0) | |
2686 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2686 | # or sys.exit() ), don't bother showing a traceback, as both of | |
2687 | # these are considered normal by the OS: |
|
2687 | # these are considered normal by the OS: | |
2688 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2688 | # > python -c'import sys;sys.exit(0)'; echo $? | |
2689 | # 0 |
|
2689 | # 0 | |
2690 | # > python -c'import sys;sys.exit()'; echo $? |
|
2690 | # > python -c'import sys;sys.exit()'; echo $? | |
2691 | # 0 |
|
2691 | # 0 | |
2692 | # For other exit status, we show the exception unless |
|
2692 | # For other exit status, we show the exception unless | |
2693 | # explicitly silenced, but only in short form. |
|
2693 | # explicitly silenced, but only in short form. | |
2694 | if status.code: |
|
2694 | if status.code: | |
2695 | if raise_exceptions: |
|
2695 | if raise_exceptions: | |
2696 | raise |
|
2696 | raise | |
2697 | if not exit_ignore: |
|
2697 | if not exit_ignore: | |
2698 | self.showtraceback(exception_only=True) |
|
2698 | self.showtraceback(exception_only=True) | |
2699 | except: |
|
2699 | except: | |
2700 | if raise_exceptions: |
|
2700 | if raise_exceptions: | |
2701 | raise |
|
2701 | raise | |
2702 | # tb offset is 2 because we wrap execfile |
|
2702 | # tb offset is 2 because we wrap execfile | |
2703 | self.showtraceback(tb_offset=2) |
|
2703 | self.showtraceback(tb_offset=2) | |
2704 |
|
2704 | |||
2705 | def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False): |
|
2705 | def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False): | |
2706 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. |
|
2706 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. | |
2707 |
|
2707 | |||
2708 | Parameters |
|
2708 | Parameters | |
2709 | ---------- |
|
2709 | ---------- | |
2710 | fname : str |
|
2710 | fname : str | |
2711 | The name of the file to execute. The filename must have a |
|
2711 | The name of the file to execute. The filename must have a | |
2712 | .ipy or .ipynb extension. |
|
2712 | .ipy or .ipynb extension. | |
2713 | shell_futures : bool (False) |
|
2713 | shell_futures : bool (False) | |
2714 | If True, the code will share future statements with the interactive |
|
2714 | If True, the code will share future statements with the interactive | |
2715 | shell. It will both be affected by previous __future__ imports, and |
|
2715 | shell. It will both be affected by previous __future__ imports, and | |
2716 | any __future__ imports in the code will affect the shell. If False, |
|
2716 | any __future__ imports in the code will affect the shell. If False, | |
2717 | __future__ imports are not shared in either direction. |
|
2717 | __future__ imports are not shared in either direction. | |
2718 | raise_exceptions : bool (False) |
|
2718 | raise_exceptions : bool (False) | |
2719 | If True raise exceptions everywhere. Meant for testing. |
|
2719 | If True raise exceptions everywhere. Meant for testing. | |
2720 | """ |
|
2720 | """ | |
2721 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2721 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2722 |
|
2722 | |||
2723 | # Make sure we can open the file |
|
2723 | # Make sure we can open the file | |
2724 | try: |
|
2724 | try: | |
2725 | with open(fname): |
|
2725 | with open(fname): | |
2726 | pass |
|
2726 | pass | |
2727 | except: |
|
2727 | except: | |
2728 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2728 | warn('Could not open file <%s> for safe execution.' % fname) | |
2729 | return |
|
2729 | return | |
2730 |
|
2730 | |||
2731 | # Find things also in current directory. This is needed to mimic the |
|
2731 | # Find things also in current directory. This is needed to mimic the | |
2732 | # behavior of running a script from the system command line, where |
|
2732 | # behavior of running a script from the system command line, where | |
2733 | # Python inserts the script's directory into sys.path |
|
2733 | # Python inserts the script's directory into sys.path | |
2734 | dname = os.path.dirname(fname) |
|
2734 | dname = os.path.dirname(fname) | |
2735 |
|
2735 | |||
2736 | def get_cells(): |
|
2736 | def get_cells(): | |
2737 | """generator for sequence of code blocks to run""" |
|
2737 | """generator for sequence of code blocks to run""" | |
2738 | if fname.endswith('.ipynb'): |
|
2738 | if fname.endswith('.ipynb'): | |
2739 | from nbformat import read |
|
2739 | from nbformat import read | |
2740 | nb = read(fname, as_version=4) |
|
2740 | nb = read(fname, as_version=4) | |
2741 | if not nb.cells: |
|
2741 | if not nb.cells: | |
2742 | return |
|
2742 | return | |
2743 | for cell in nb.cells: |
|
2743 | for cell in nb.cells: | |
2744 | if cell.cell_type == 'code': |
|
2744 | if cell.cell_type == 'code': | |
2745 | yield cell.source |
|
2745 | yield cell.source | |
2746 | else: |
|
2746 | else: | |
2747 | with open(fname) as f: |
|
2747 | with open(fname) as f: | |
2748 | yield f.read() |
|
2748 | yield f.read() | |
2749 |
|
2749 | |||
2750 | with prepended_to_syspath(dname): |
|
2750 | with prepended_to_syspath(dname): | |
2751 | try: |
|
2751 | try: | |
2752 | for cell in get_cells(): |
|
2752 | for cell in get_cells(): | |
2753 | result = self.run_cell(cell, silent=True, shell_futures=shell_futures) |
|
2753 | result = self.run_cell(cell, silent=True, shell_futures=shell_futures) | |
2754 | if raise_exceptions: |
|
2754 | if raise_exceptions: | |
2755 | result.raise_error() |
|
2755 | result.raise_error() | |
2756 | elif not result.success: |
|
2756 | elif not result.success: | |
2757 | break |
|
2757 | break | |
2758 | except: |
|
2758 | except: | |
2759 | if raise_exceptions: |
|
2759 | if raise_exceptions: | |
2760 | raise |
|
2760 | raise | |
2761 | self.showtraceback() |
|
2761 | self.showtraceback() | |
2762 | warn('Unknown failure executing file: <%s>' % fname) |
|
2762 | warn('Unknown failure executing file: <%s>' % fname) | |
2763 |
|
2763 | |||
2764 | def safe_run_module(self, mod_name, where): |
|
2764 | def safe_run_module(self, mod_name, where): | |
2765 | """A safe version of runpy.run_module(). |
|
2765 | """A safe version of runpy.run_module(). | |
2766 |
|
2766 | |||
2767 | This version will never throw an exception, but instead print |
|
2767 | This version will never throw an exception, but instead print | |
2768 | helpful error messages to the screen. |
|
2768 | helpful error messages to the screen. | |
2769 |
|
2769 | |||
2770 | `SystemExit` exceptions with status code 0 or None are ignored. |
|
2770 | `SystemExit` exceptions with status code 0 or None are ignored. | |
2771 |
|
2771 | |||
2772 | Parameters |
|
2772 | Parameters | |
2773 | ---------- |
|
2773 | ---------- | |
2774 | mod_name : string |
|
2774 | mod_name : string | |
2775 | The name of the module to be executed. |
|
2775 | The name of the module to be executed. | |
2776 | where : dict |
|
2776 | where : dict | |
2777 | The globals namespace. |
|
2777 | The globals namespace. | |
2778 | """ |
|
2778 | """ | |
2779 | try: |
|
2779 | try: | |
2780 | try: |
|
2780 | try: | |
2781 | where.update( |
|
2781 | where.update( | |
2782 | runpy.run_module(str(mod_name), run_name="__main__", |
|
2782 | runpy.run_module(str(mod_name), run_name="__main__", | |
2783 | alter_sys=True) |
|
2783 | alter_sys=True) | |
2784 | ) |
|
2784 | ) | |
2785 | except SystemExit as status: |
|
2785 | except SystemExit as status: | |
2786 | if status.code: |
|
2786 | if status.code: | |
2787 | raise |
|
2787 | raise | |
2788 | except: |
|
2788 | except: | |
2789 | self.showtraceback() |
|
2789 | self.showtraceback() | |
2790 | warn('Unknown failure executing module: <%s>' % mod_name) |
|
2790 | warn('Unknown failure executing module: <%s>' % mod_name) | |
2791 |
|
2791 | |||
2792 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): |
|
2792 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): | |
2793 | """Run a complete IPython cell. |
|
2793 | """Run a complete IPython cell. | |
2794 |
|
2794 | |||
2795 | Parameters |
|
2795 | Parameters | |
2796 | ---------- |
|
2796 | ---------- | |
2797 | raw_cell : str |
|
2797 | raw_cell : str | |
2798 | The code (including IPython code such as %magic functions) to run. |
|
2798 | The code (including IPython code such as %magic functions) to run. | |
2799 | store_history : bool |
|
2799 | store_history : bool | |
2800 | If True, the raw and translated cell will be stored in IPython's |
|
2800 | If True, the raw and translated cell will be stored in IPython's | |
2801 | history. For user code calling back into IPython's machinery, this |
|
2801 | history. For user code calling back into IPython's machinery, this | |
2802 | should be set to False. |
|
2802 | should be set to False. | |
2803 | silent : bool |
|
2803 | silent : bool | |
2804 | If True, avoid side-effects, such as implicit displayhooks and |
|
2804 | If True, avoid side-effects, such as implicit displayhooks and | |
2805 | and logging. silent=True forces store_history=False. |
|
2805 | and logging. silent=True forces store_history=False. | |
2806 | shell_futures : bool |
|
2806 | shell_futures : bool | |
2807 | If True, the code will share future statements with the interactive |
|
2807 | If True, the code will share future statements with the interactive | |
2808 | shell. It will both be affected by previous __future__ imports, and |
|
2808 | shell. It will both be affected by previous __future__ imports, and | |
2809 | any __future__ imports in the code will affect the shell. If False, |
|
2809 | any __future__ imports in the code will affect the shell. If False, | |
2810 | __future__ imports are not shared in either direction. |
|
2810 | __future__ imports are not shared in either direction. | |
2811 |
|
2811 | |||
2812 | Returns |
|
2812 | Returns | |
2813 | ------- |
|
2813 | ------- | |
2814 | result : :class:`ExecutionResult` |
|
2814 | result : :class:`ExecutionResult` | |
2815 | """ |
|
2815 | """ | |
2816 | result = None |
|
2816 | result = None | |
2817 | try: |
|
2817 | try: | |
2818 | result = self._run_cell( |
|
2818 | result = self._run_cell( | |
2819 | raw_cell, store_history, silent, shell_futures) |
|
2819 | raw_cell, store_history, silent, shell_futures) | |
2820 | finally: |
|
2820 | finally: | |
2821 | self.events.trigger('post_execute') |
|
2821 | self.events.trigger('post_execute') | |
2822 | if not silent: |
|
2822 | if not silent: | |
2823 | self.events.trigger('post_run_cell', result) |
|
2823 | self.events.trigger('post_run_cell', result) | |
2824 | return result |
|
2824 | return result | |
2825 |
|
2825 | |||
2826 | def _run_cell(self, raw_cell:str, store_history:bool, silent:bool, shell_futures:bool): |
|
2826 | def _run_cell(self, raw_cell:str, store_history:bool, silent:bool, shell_futures:bool): | |
2827 | """Internal method to run a complete IPython cell.""" |
|
2827 | """Internal method to run a complete IPython cell.""" | |
2828 | coro = self.run_cell_async( |
|
2828 | coro = self.run_cell_async( | |
2829 | raw_cell, |
|
2829 | raw_cell, | |
2830 | store_history=store_history, |
|
2830 | store_history=store_history, | |
2831 | silent=silent, |
|
2831 | silent=silent, | |
2832 | shell_futures=shell_futures, |
|
2832 | shell_futures=shell_futures, | |
2833 | ) |
|
2833 | ) | |
2834 |
|
2834 | |||
2835 | # run_cell_async is async, but may not actually need an eventloop. |
|
2835 | # run_cell_async is async, but may not actually need an eventloop. | |
2836 | # when this is the case, we want to run it using the pseudo_sync_runner |
|
2836 | # when this is the case, we want to run it using the pseudo_sync_runner | |
2837 | # so that code can invoke eventloops (for example via the %run , and |
|
2837 | # so that code can invoke eventloops (for example via the %run , and | |
2838 | # `%paste` magic. |
|
2838 | # `%paste` magic. | |
2839 | if self.should_run_async(raw_cell): |
|
2839 | if self.should_run_async(raw_cell): | |
2840 | runner = self.loop_runner |
|
2840 | runner = self.loop_runner | |
2841 | else: |
|
2841 | else: | |
2842 | runner = _pseudo_sync_runner |
|
2842 | runner = _pseudo_sync_runner | |
2843 |
|
2843 | |||
2844 | try: |
|
2844 | try: | |
2845 | return runner(coro) |
|
2845 | return runner(coro) | |
2846 | except BaseException as e: |
|
2846 | except BaseException as e: | |
2847 | info = ExecutionInfo(raw_cell, store_history, silent, shell_futures) |
|
2847 | info = ExecutionInfo(raw_cell, store_history, silent, shell_futures) | |
2848 | result = ExecutionResult(info) |
|
2848 | result = ExecutionResult(info) | |
2849 | result.error_in_exec = e |
|
2849 | result.error_in_exec = e | |
2850 | self.showtraceback(running_compiled_code=True) |
|
2850 | self.showtraceback(running_compiled_code=True) | |
2851 | return result |
|
2851 | return result | |
2852 | return |
|
2852 | return | |
2853 |
|
2853 | |||
2854 | def should_run_async(self, raw_cell: str) -> bool: |
|
2854 | def should_run_async(self, raw_cell: str) -> bool: | |
2855 | """Return whether a cell should be run asynchronously via a coroutine runner |
|
2855 | """Return whether a cell should be run asynchronously via a coroutine runner | |
2856 |
|
2856 | |||
2857 | Parameters |
|
2857 | Parameters | |
2858 | ---------- |
|
2858 | ---------- | |
2859 | raw_cell: str |
|
2859 | raw_cell: str | |
2860 | The code to be executed |
|
2860 | The code to be executed | |
2861 |
|
2861 | |||
2862 | Returns |
|
2862 | Returns | |
2863 | ------- |
|
2863 | ------- | |
2864 | result: bool |
|
2864 | result: bool | |
2865 | Whether the code needs to be run with a coroutine runner or not |
|
2865 | Whether the code needs to be run with a coroutine runner or not | |
2866 |
|
2866 | |||
2867 | .. versionadded: 7.0 |
|
2867 | .. versionadded: 7.0 | |
2868 | """ |
|
2868 | """ | |
2869 | if not self.autoawait: |
|
2869 | if not self.autoawait: | |
2870 | return False |
|
2870 | return False | |
2871 | try: |
|
2871 | try: | |
2872 | cell = self.transform_cell(raw_cell) |
|
2872 | cell = self.transform_cell(raw_cell) | |
2873 | except Exception: |
|
2873 | except Exception: | |
2874 | # any exception during transform will be raised |
|
2874 | # any exception during transform will be raised | |
2875 | # prior to execution |
|
2875 | # prior to execution | |
2876 | return False |
|
2876 | return False | |
2877 | return _should_be_async(cell) |
|
2877 | return _should_be_async(cell) | |
2878 |
|
2878 | |||
2879 | @asyncio.coroutine |
|
2879 | @asyncio.coroutine | |
2880 | def run_cell_async(self, raw_cell: str, store_history=False, silent=False, shell_futures=True) -> ExecutionResult: |
|
2880 | def run_cell_async(self, raw_cell: str, store_history=False, silent=False, shell_futures=True) -> ExecutionResult: | |
2881 | """Run a complete IPython cell asynchronously. |
|
2881 | """Run a complete IPython cell asynchronously. | |
2882 |
|
2882 | |||
2883 | Parameters |
|
2883 | Parameters | |
2884 | ---------- |
|
2884 | ---------- | |
2885 | raw_cell : str |
|
2885 | raw_cell : str | |
2886 | The code (including IPython code such as %magic functions) to run. |
|
2886 | The code (including IPython code such as %magic functions) to run. | |
2887 | store_history : bool |
|
2887 | store_history : bool | |
2888 | If True, the raw and translated cell will be stored in IPython's |
|
2888 | If True, the raw and translated cell will be stored in IPython's | |
2889 | history. For user code calling back into IPython's machinery, this |
|
2889 | history. For user code calling back into IPython's machinery, this | |
2890 | should be set to False. |
|
2890 | should be set to False. | |
2891 | silent : bool |
|
2891 | silent : bool | |
2892 | If True, avoid side-effects, such as implicit displayhooks and |
|
2892 | If True, avoid side-effects, such as implicit displayhooks and | |
2893 | and logging. silent=True forces store_history=False. |
|
2893 | and logging. silent=True forces store_history=False. | |
2894 | shell_futures : bool |
|
2894 | shell_futures : bool | |
2895 | If True, the code will share future statements with the interactive |
|
2895 | If True, the code will share future statements with the interactive | |
2896 | shell. It will both be affected by previous __future__ imports, and |
|
2896 | shell. It will both be affected by previous __future__ imports, and | |
2897 | any __future__ imports in the code will affect the shell. If False, |
|
2897 | any __future__ imports in the code will affect the shell. If False, | |
2898 | __future__ imports are not shared in either direction. |
|
2898 | __future__ imports are not shared in either direction. | |
2899 |
|
2899 | |||
2900 | Returns |
|
2900 | Returns | |
2901 | ------- |
|
2901 | ------- | |
2902 | result : :class:`ExecutionResult` |
|
2902 | result : :class:`ExecutionResult` | |
2903 |
|
2903 | |||
2904 | .. versionadded: 7.0 |
|
2904 | .. versionadded: 7.0 | |
2905 | """ |
|
2905 | """ | |
2906 | info = ExecutionInfo( |
|
2906 | info = ExecutionInfo( | |
2907 | raw_cell, store_history, silent, shell_futures) |
|
2907 | raw_cell, store_history, silent, shell_futures) | |
2908 | result = ExecutionResult(info) |
|
2908 | result = ExecutionResult(info) | |
2909 |
|
2909 | |||
2910 | if (not raw_cell) or raw_cell.isspace(): |
|
2910 | if (not raw_cell) or raw_cell.isspace(): | |
2911 | self.last_execution_succeeded = True |
|
2911 | self.last_execution_succeeded = True | |
2912 | self.last_execution_result = result |
|
2912 | self.last_execution_result = result | |
2913 | return result |
|
2913 | return result | |
2914 |
|
2914 | |||
2915 | if silent: |
|
2915 | if silent: | |
2916 | store_history = False |
|
2916 | store_history = False | |
2917 |
|
2917 | |||
2918 | if store_history: |
|
2918 | if store_history: | |
2919 | result.execution_count = self.execution_count |
|
2919 | result.execution_count = self.execution_count | |
2920 |
|
2920 | |||
2921 | def error_before_exec(value): |
|
2921 | def error_before_exec(value): | |
2922 | if store_history: |
|
2922 | if store_history: | |
2923 | self.execution_count += 1 |
|
2923 | self.execution_count += 1 | |
2924 | result.error_before_exec = value |
|
2924 | result.error_before_exec = value | |
2925 | self.last_execution_succeeded = False |
|
2925 | self.last_execution_succeeded = False | |
2926 | self.last_execution_result = result |
|
2926 | self.last_execution_result = result | |
2927 | return result |
|
2927 | return result | |
2928 |
|
2928 | |||
2929 | self.events.trigger('pre_execute') |
|
2929 | self.events.trigger('pre_execute') | |
2930 | if not silent: |
|
2930 | if not silent: | |
2931 | self.events.trigger('pre_run_cell', info) |
|
2931 | self.events.trigger('pre_run_cell', info) | |
2932 |
|
2932 | |||
2933 | # If any of our input transformation (input_transformer_manager or |
|
2933 | # If any of our input transformation (input_transformer_manager or | |
2934 | # prefilter_manager) raises an exception, we store it in this variable |
|
2934 | # prefilter_manager) raises an exception, we store it in this variable | |
2935 | # so that we can display the error after logging the input and storing |
|
2935 | # so that we can display the error after logging the input and storing | |
2936 | # it in the history. |
|
2936 | # it in the history. | |
2937 | try: |
|
2937 | try: | |
2938 | cell = self.transform_cell(raw_cell) |
|
2938 | cell = self.transform_cell(raw_cell) | |
2939 | except Exception: |
|
2939 | except Exception: | |
2940 | preprocessing_exc_tuple = sys.exc_info() |
|
2940 | preprocessing_exc_tuple = sys.exc_info() | |
2941 | cell = raw_cell # cell has to exist so it can be stored/logged |
|
2941 | cell = raw_cell # cell has to exist so it can be stored/logged | |
2942 | else: |
|
2942 | else: | |
2943 | preprocessing_exc_tuple = None |
|
2943 | preprocessing_exc_tuple = None | |
2944 |
|
2944 | |||
2945 | # Store raw and processed history |
|
2945 | # Store raw and processed history | |
2946 | if store_history: |
|
2946 | if store_history: | |
2947 | self.history_manager.store_inputs(self.execution_count, |
|
2947 | self.history_manager.store_inputs(self.execution_count, | |
2948 | cell, raw_cell) |
|
2948 | cell, raw_cell) | |
2949 | if not silent: |
|
2949 | if not silent: | |
2950 | self.logger.log(cell, raw_cell) |
|
2950 | self.logger.log(cell, raw_cell) | |
2951 |
|
2951 | |||
2952 | # Display the exception if input processing failed. |
|
2952 | # Display the exception if input processing failed. | |
2953 | if preprocessing_exc_tuple is not None: |
|
2953 | if preprocessing_exc_tuple is not None: | |
2954 | self.showtraceback(preprocessing_exc_tuple) |
|
2954 | self.showtraceback(preprocessing_exc_tuple) | |
2955 | if store_history: |
|
2955 | if store_history: | |
2956 | self.execution_count += 1 |
|
2956 | self.execution_count += 1 | |
2957 | return error_before_exec(preprocessing_exc_tuple[2]) |
|
2957 | return error_before_exec(preprocessing_exc_tuple[2]) | |
2958 |
|
2958 | |||
2959 | # Our own compiler remembers the __future__ environment. If we want to |
|
2959 | # Our own compiler remembers the __future__ environment. If we want to | |
2960 | # run code with a separate __future__ environment, use the default |
|
2960 | # run code with a separate __future__ environment, use the default | |
2961 | # compiler |
|
2961 | # compiler | |
2962 | compiler = self.compile if shell_futures else CachingCompiler() |
|
2962 | compiler = self.compile if shell_futures else CachingCompiler() | |
2963 |
|
2963 | |||
2964 | _run_async = False |
|
2964 | _run_async = False | |
2965 |
|
2965 | |||
2966 | with self.builtin_trap: |
|
2966 | with self.builtin_trap: | |
2967 | cell_name = self.compile.cache(cell, self.execution_count) |
|
2967 | cell_name = self.compile.cache(cell, self.execution_count) | |
2968 |
|
2968 | |||
2969 | with self.display_trap: |
|
2969 | with self.display_trap: | |
2970 | # Compile to bytecode |
|
2970 | # Compile to bytecode | |
2971 | try: |
|
2971 | try: | |
2972 | if self.autoawait and _should_be_async(cell): |
|
2972 | if self.autoawait and _should_be_async(cell): | |
2973 | # the code AST below will not be user code: we wrap it |
|
2973 | # the code AST below will not be user code: we wrap it | |
2974 | # in an `async def`. This will likely make some AST |
|
2974 | # in an `async def`. This will likely make some AST | |
2975 | # transformer below miss some transform opportunity and |
|
2975 | # transformer below miss some transform opportunity and | |
2976 | # introduce a small coupling to run_code (in which we |
|
2976 | # introduce a small coupling to run_code (in which we | |
2977 | # bake some assumptions of what _ast_asyncify returns. |
|
2977 | # bake some assumptions of what _ast_asyncify returns. | |
2978 | # they are ways around (like grafting part of the ast |
|
2978 | # they are ways around (like grafting part of the ast | |
2979 | # later: |
|
2979 | # later: | |
2980 | # - Here, return code_ast.body[0].body[1:-1], as well |
|
2980 | # - Here, return code_ast.body[0].body[1:-1], as well | |
2981 | # as last expression in return statement which is |
|
2981 | # as last expression in return statement which is | |
2982 | # the user code part. |
|
2982 | # the user code part. | |
2983 | # - Let it go through the AST transformers, and graft |
|
2983 | # - Let it go through the AST transformers, and graft | |
2984 | # - it back after the AST transform |
|
2984 | # - it back after the AST transform | |
2985 | # But that seem unreasonable, at least while we |
|
2985 | # But that seem unreasonable, at least while we | |
2986 | # do not need it. |
|
2986 | # do not need it. | |
2987 | code_ast = _ast_asyncify(cell, 'async-def-wrapper') |
|
2987 | code_ast = _ast_asyncify(cell, 'async-def-wrapper') | |
2988 | _run_async = True |
|
2988 | _run_async = True | |
2989 | else: |
|
2989 | else: | |
2990 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
2990 | code_ast = compiler.ast_parse(cell, filename=cell_name) | |
2991 | except self.custom_exceptions as e: |
|
2991 | except self.custom_exceptions as e: | |
2992 | etype, value, tb = sys.exc_info() |
|
2992 | etype, value, tb = sys.exc_info() | |
2993 | self.CustomTB(etype, value, tb) |
|
2993 | self.CustomTB(etype, value, tb) | |
2994 | return error_before_exec(e) |
|
2994 | return error_before_exec(e) | |
2995 | except IndentationError as e: |
|
2995 | except IndentationError as e: | |
2996 | self.showindentationerror() |
|
2996 | self.showindentationerror() | |
2997 | return error_before_exec(e) |
|
2997 | return error_before_exec(e) | |
2998 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
2998 | except (OverflowError, SyntaxError, ValueError, TypeError, | |
2999 | MemoryError) as e: |
|
2999 | MemoryError) as e: | |
3000 | self.showsyntaxerror() |
|
3000 | self.showsyntaxerror() | |
3001 | return error_before_exec(e) |
|
3001 | return error_before_exec(e) | |
3002 |
|
3002 | |||
3003 | # Apply AST transformations |
|
3003 | # Apply AST transformations | |
3004 | try: |
|
3004 | try: | |
3005 | code_ast = self.transform_ast(code_ast) |
|
3005 | code_ast = self.transform_ast(code_ast) | |
3006 | except InputRejected as e: |
|
3006 | except InputRejected as e: | |
3007 | self.showtraceback() |
|
3007 | self.showtraceback() | |
3008 | return error_before_exec(e) |
|
3008 | return error_before_exec(e) | |
3009 |
|
3009 | |||
3010 | # Give the displayhook a reference to our ExecutionResult so it |
|
3010 | # Give the displayhook a reference to our ExecutionResult so it | |
3011 | # can fill in the output value. |
|
3011 | # can fill in the output value. | |
3012 | self.displayhook.exec_result = result |
|
3012 | self.displayhook.exec_result = result | |
3013 |
|
3013 | |||
3014 | # Execute the user code |
|
3014 | # Execute the user code | |
3015 | interactivity = "none" if silent else self.ast_node_interactivity |
|
3015 | interactivity = "none" if silent else self.ast_node_interactivity | |
3016 | if _run_async: |
|
3016 | if _run_async: | |
3017 | interactivity = 'async' |
|
3017 | interactivity = 'async' | |
3018 |
|
3018 | |||
3019 | has_raised = yield from self.run_ast_nodes(code_ast.body, cell_name, |
|
3019 | has_raised = yield from self.run_ast_nodes(code_ast.body, cell_name, | |
3020 | interactivity=interactivity, compiler=compiler, result=result) |
|
3020 | interactivity=interactivity, compiler=compiler, result=result) | |
3021 |
|
3021 | |||
3022 | self.last_execution_succeeded = not has_raised |
|
3022 | self.last_execution_succeeded = not has_raised | |
3023 | self.last_execution_result = result |
|
3023 | self.last_execution_result = result | |
3024 |
|
3024 | |||
3025 | # Reset this so later displayed values do not modify the |
|
3025 | # Reset this so later displayed values do not modify the | |
3026 | # ExecutionResult |
|
3026 | # ExecutionResult | |
3027 | self.displayhook.exec_result = None |
|
3027 | self.displayhook.exec_result = None | |
3028 |
|
3028 | |||
3029 | if store_history: |
|
3029 | if store_history: | |
3030 | # Write output to the database. Does nothing unless |
|
3030 | # Write output to the database. Does nothing unless | |
3031 | # history output logging is enabled. |
|
3031 | # history output logging is enabled. | |
3032 | self.history_manager.store_output(self.execution_count) |
|
3032 | self.history_manager.store_output(self.execution_count) | |
3033 | # Each cell is a *single* input, regardless of how many lines it has |
|
3033 | # Each cell is a *single* input, regardless of how many lines it has | |
3034 | self.execution_count += 1 |
|
3034 | self.execution_count += 1 | |
3035 |
|
3035 | |||
3036 | return result |
|
3036 | return result | |
3037 |
|
3037 | |||
3038 | def transform_cell(self, raw_cell): |
|
3038 | def transform_cell(self, raw_cell): | |
3039 | """Transform an input cell before parsing it. |
|
3039 | """Transform an input cell before parsing it. | |
3040 |
|
3040 | |||
3041 | Static transformations, implemented in IPython.core.inputtransformer2, |
|
3041 | Static transformations, implemented in IPython.core.inputtransformer2, | |
3042 | deal with things like ``%magic`` and ``!system`` commands. |
|
3042 | deal with things like ``%magic`` and ``!system`` commands. | |
3043 | These run on all input. |
|
3043 | These run on all input. | |
3044 | Dynamic transformations, for things like unescaped magics and the exit |
|
3044 | Dynamic transformations, for things like unescaped magics and the exit | |
3045 | autocall, depend on the state of the interpreter. |
|
3045 | autocall, depend on the state of the interpreter. | |
3046 | These only apply to single line inputs. |
|
3046 | These only apply to single line inputs. | |
3047 |
|
3047 | |||
3048 | These string-based transformations are followed by AST transformations; |
|
3048 | These string-based transformations are followed by AST transformations; | |
3049 | see :meth:`transform_ast`. |
|
3049 | see :meth:`transform_ast`. | |
3050 | """ |
|
3050 | """ | |
3051 | # Static input transformations |
|
3051 | # Static input transformations | |
3052 | cell = self.input_transformer_manager.transform_cell(raw_cell) |
|
3052 | cell = self.input_transformer_manager.transform_cell(raw_cell) | |
3053 |
|
3053 | |||
3054 | if len(cell.splitlines()) == 1: |
|
3054 | if len(cell.splitlines()) == 1: | |
3055 | # Dynamic transformations - only applied for single line commands |
|
3055 | # Dynamic transformations - only applied for single line commands | |
3056 | with self.builtin_trap: |
|
3056 | with self.builtin_trap: | |
3057 | # use prefilter_lines to handle trailing newlines |
|
3057 | # use prefilter_lines to handle trailing newlines | |
3058 | # restore trailing newline for ast.parse |
|
3058 | # restore trailing newline for ast.parse | |
3059 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
3059 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' | |
3060 |
|
3060 | |||
3061 | lines = cell.splitlines(keepends=True) |
|
3061 | lines = cell.splitlines(keepends=True) | |
3062 | for transform in self.input_transformers_post: |
|
3062 | for transform in self.input_transformers_post: | |
3063 | lines = transform(lines) |
|
3063 | lines = transform(lines) | |
3064 | cell = ''.join(lines) |
|
3064 | cell = ''.join(lines) | |
3065 |
|
3065 | |||
3066 | return cell |
|
3066 | return cell | |
3067 |
|
3067 | |||
3068 | def transform_ast(self, node): |
|
3068 | def transform_ast(self, node): | |
3069 | """Apply the AST transformations from self.ast_transformers |
|
3069 | """Apply the AST transformations from self.ast_transformers | |
3070 |
|
3070 | |||
3071 | Parameters |
|
3071 | Parameters | |
3072 | ---------- |
|
3072 | ---------- | |
3073 | node : ast.Node |
|
3073 | node : ast.Node | |
3074 | The root node to be transformed. Typically called with the ast.Module |
|
3074 | The root node to be transformed. Typically called with the ast.Module | |
3075 | produced by parsing user input. |
|
3075 | produced by parsing user input. | |
3076 |
|
3076 | |||
3077 | Returns |
|
3077 | Returns | |
3078 | ------- |
|
3078 | ------- | |
3079 | An ast.Node corresponding to the node it was called with. Note that it |
|
3079 | An ast.Node corresponding to the node it was called with. Note that it | |
3080 | may also modify the passed object, so don't rely on references to the |
|
3080 | may also modify the passed object, so don't rely on references to the | |
3081 | original AST. |
|
3081 | original AST. | |
3082 | """ |
|
3082 | """ | |
3083 | for transformer in self.ast_transformers: |
|
3083 | for transformer in self.ast_transformers: | |
3084 | try: |
|
3084 | try: | |
3085 | node = transformer.visit(node) |
|
3085 | node = transformer.visit(node) | |
3086 | except InputRejected: |
|
3086 | except InputRejected: | |
3087 | # User-supplied AST transformers can reject an input by raising |
|
3087 | # User-supplied AST transformers can reject an input by raising | |
3088 | # an InputRejected. Short-circuit in this case so that we |
|
3088 | # an InputRejected. Short-circuit in this case so that we | |
3089 | # don't unregister the transform. |
|
3089 | # don't unregister the transform. | |
3090 | raise |
|
3090 | raise | |
3091 | except Exception: |
|
3091 | except Exception: | |
3092 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) |
|
3092 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) | |
3093 | self.ast_transformers.remove(transformer) |
|
3093 | self.ast_transformers.remove(transformer) | |
3094 |
|
3094 | |||
3095 | if self.ast_transformers: |
|
3095 | if self.ast_transformers: | |
3096 | ast.fix_missing_locations(node) |
|
3096 | ast.fix_missing_locations(node) | |
3097 | return node |
|
3097 | return node | |
3098 |
|
3098 | |||
3099 | @asyncio.coroutine |
|
3099 | @asyncio.coroutine | |
3100 | def run_ast_nodes(self, nodelist:ListType[AST], cell_name:str, interactivity='last_expr', |
|
3100 | def run_ast_nodes(self, nodelist:ListType[AST], cell_name:str, interactivity='last_expr', | |
3101 | compiler=compile, result=None): |
|
3101 | compiler=compile, result=None): | |
3102 | """Run a sequence of AST nodes. The execution mode depends on the |
|
3102 | """Run a sequence of AST nodes. The execution mode depends on the | |
3103 | interactivity parameter. |
|
3103 | interactivity parameter. | |
3104 |
|
3104 | |||
3105 | Parameters |
|
3105 | Parameters | |
3106 | ---------- |
|
3106 | ---------- | |
3107 | nodelist : list |
|
3107 | nodelist : list | |
3108 | A sequence of AST nodes to run. |
|
3108 | A sequence of AST nodes to run. | |
3109 | cell_name : str |
|
3109 | cell_name : str | |
3110 | Will be passed to the compiler as the filename of the cell. Typically |
|
3110 | Will be passed to the compiler as the filename of the cell. Typically | |
3111 | the value returned by ip.compile.cache(cell). |
|
3111 | the value returned by ip.compile.cache(cell). | |
3112 | interactivity : str |
|
3112 | interactivity : str | |
3113 | 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none', |
|
3113 | 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none', | |
3114 | specifying which nodes should be run interactively (displaying output |
|
3114 | specifying which nodes should be run interactively (displaying output | |
3115 | from expressions). 'last_expr' will run the last node interactively |
|
3115 | from expressions). 'last_expr' will run the last node interactively | |
3116 | only if it is an expression (i.e. expressions in loops or other blocks |
|
3116 | only if it is an expression (i.e. expressions in loops or other blocks | |
3117 | are not displayed) 'last_expr_or_assign' will run the last expression |
|
3117 | are not displayed) 'last_expr_or_assign' will run the last expression | |
3118 | or the last assignment. Other values for this parameter will raise a |
|
3118 | or the last assignment. Other values for this parameter will raise a | |
3119 | ValueError. |
|
3119 | ValueError. | |
3120 |
|
3120 | |||
3121 | Experimental value: 'async' Will try to run top level interactive |
|
3121 | Experimental value: 'async' Will try to run top level interactive | |
3122 | async/await code in default runner, this will not respect the |
|
3122 | async/await code in default runner, this will not respect the | |
3123 | interactivty setting and will only run the last node if it is an |
|
3123 | interactivty setting and will only run the last node if it is an | |
3124 | expression. |
|
3124 | expression. | |
3125 |
|
3125 | |||
3126 | compiler : callable |
|
3126 | compiler : callable | |
3127 | A function with the same interface as the built-in compile(), to turn |
|
3127 | A function with the same interface as the built-in compile(), to turn | |
3128 | the AST nodes into code objects. Default is the built-in compile(). |
|
3128 | the AST nodes into code objects. Default is the built-in compile(). | |
3129 | result : ExecutionResult, optional |
|
3129 | result : ExecutionResult, optional | |
3130 | An object to store exceptions that occur during execution. |
|
3130 | An object to store exceptions that occur during execution. | |
3131 |
|
3131 | |||
3132 | Returns |
|
3132 | Returns | |
3133 | ------- |
|
3133 | ------- | |
3134 | True if an exception occurred while running code, False if it finished |
|
3134 | True if an exception occurred while running code, False if it finished | |
3135 | running. |
|
3135 | running. | |
3136 | """ |
|
3136 | """ | |
3137 | if not nodelist: |
|
3137 | if not nodelist: | |
3138 | return |
|
3138 | return | |
3139 | if interactivity == 'last_expr_or_assign': |
|
3139 | if interactivity == 'last_expr_or_assign': | |
3140 | if isinstance(nodelist[-1], _assign_nodes): |
|
3140 | if isinstance(nodelist[-1], _assign_nodes): | |
3141 | asg = nodelist[-1] |
|
3141 | asg = nodelist[-1] | |
3142 | if isinstance(asg, ast.Assign) and len(asg.targets) == 1: |
|
3142 | if isinstance(asg, ast.Assign) and len(asg.targets) == 1: | |
3143 | target = asg.targets[0] |
|
3143 | target = asg.targets[0] | |
3144 | elif isinstance(asg, _single_targets_nodes): |
|
3144 | elif isinstance(asg, _single_targets_nodes): | |
3145 | target = asg.target |
|
3145 | target = asg.target | |
3146 | else: |
|
3146 | else: | |
3147 | target = None |
|
3147 | target = None | |
3148 | if isinstance(target, ast.Name): |
|
3148 | if isinstance(target, ast.Name): | |
3149 | nnode = ast.Expr(ast.Name(target.id, ast.Load())) |
|
3149 | nnode = ast.Expr(ast.Name(target.id, ast.Load())) | |
3150 | ast.fix_missing_locations(nnode) |
|
3150 | ast.fix_missing_locations(nnode) | |
3151 | nodelist.append(nnode) |
|
3151 | nodelist.append(nnode) | |
3152 | interactivity = 'last_expr' |
|
3152 | interactivity = 'last_expr' | |
3153 |
|
3153 | |||
3154 | _async = False |
|
3154 | _async = False | |
3155 | if interactivity == 'last_expr': |
|
3155 | if interactivity == 'last_expr': | |
3156 | if isinstance(nodelist[-1], ast.Expr): |
|
3156 | if isinstance(nodelist[-1], ast.Expr): | |
3157 | interactivity = "last" |
|
3157 | interactivity = "last" | |
3158 | else: |
|
3158 | else: | |
3159 | interactivity = "none" |
|
3159 | interactivity = "none" | |
3160 |
|
3160 | |||
3161 | if interactivity == 'none': |
|
3161 | if interactivity == 'none': | |
3162 | to_run_exec, to_run_interactive = nodelist, [] |
|
3162 | to_run_exec, to_run_interactive = nodelist, [] | |
3163 | elif interactivity == 'last': |
|
3163 | elif interactivity == 'last': | |
3164 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
3164 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] | |
3165 | elif interactivity == 'all': |
|
3165 | elif interactivity == 'all': | |
3166 | to_run_exec, to_run_interactive = [], nodelist |
|
3166 | to_run_exec, to_run_interactive = [], nodelist | |
3167 | elif interactivity == 'async': |
|
3167 | elif interactivity == 'async': | |
3168 | _async = True |
|
3168 | _async = True | |
3169 | else: |
|
3169 | else: | |
3170 | raise ValueError("Interactivity was %r" % interactivity) |
|
3170 | raise ValueError("Interactivity was %r" % interactivity) | |
3171 | try: |
|
3171 | try: | |
3172 | if _async: |
|
3172 | if _async: | |
3173 | # If interactivity is async the semantics of run_code are |
|
3173 | # If interactivity is async the semantics of run_code are | |
3174 | # completely different Skip usual machinery. |
|
3174 | # completely different Skip usual machinery. | |
3175 | mod = ast.Module(nodelist) |
|
3175 | mod = ast.Module(nodelist) | |
3176 | async_wrapper_code = compiler(mod, 'cell_name', 'exec') |
|
3176 | async_wrapper_code = compiler(mod, 'cell_name', 'exec') | |
3177 | exec(async_wrapper_code, self.user_global_ns, self.user_ns) |
|
3177 | exec(async_wrapper_code, self.user_global_ns, self.user_ns) | |
3178 | async_code = removed_co_newlocals(self.user_ns.pop('async-def-wrapper')).__code__ |
|
3178 | async_code = removed_co_newlocals(self.user_ns.pop('async-def-wrapper')).__code__ | |
3179 | if (yield from self.run_code(async_code, result, async_=True)): |
|
3179 | if (yield from self.run_code(async_code, result, async_=True)): | |
3180 | return True |
|
3180 | return True | |
3181 | else: |
|
3181 | else: | |
3182 | for i, node in enumerate(to_run_exec): |
|
3182 | for i, node in enumerate(to_run_exec): | |
3183 | mod = ast.Module([node]) |
|
3183 | mod = ast.Module([node]) | |
3184 | code = compiler(mod, cell_name, "exec") |
|
3184 | code = compiler(mod, cell_name, "exec") | |
3185 | if (yield from self.run_code(code, result)): |
|
3185 | if (yield from self.run_code(code, result)): | |
3186 | return True |
|
3186 | return True | |
3187 |
|
3187 | |||
3188 | for i, node in enumerate(to_run_interactive): |
|
3188 | for i, node in enumerate(to_run_interactive): | |
3189 | mod = ast.Interactive([node]) |
|
3189 | mod = ast.Interactive([node]) | |
3190 | code = compiler(mod, cell_name, "single") |
|
3190 | code = compiler(mod, cell_name, "single") | |
3191 | if (yield from self.run_code(code, result)): |
|
3191 | if (yield from self.run_code(code, result)): | |
3192 | return True |
|
3192 | return True | |
3193 |
|
3193 | |||
3194 | # Flush softspace |
|
3194 | # Flush softspace | |
3195 | if softspace(sys.stdout, 0): |
|
3195 | if softspace(sys.stdout, 0): | |
3196 | print() |
|
3196 | print() | |
3197 |
|
3197 | |||
3198 | except: |
|
3198 | except: | |
3199 | # It's possible to have exceptions raised here, typically by |
|
3199 | # It's possible to have exceptions raised here, typically by | |
3200 | # compilation of odd code (such as a naked 'return' outside a |
|
3200 | # compilation of odd code (such as a naked 'return' outside a | |
3201 | # function) that did parse but isn't valid. Typically the exception |
|
3201 | # function) that did parse but isn't valid. Typically the exception | |
3202 | # is a SyntaxError, but it's safest just to catch anything and show |
|
3202 | # is a SyntaxError, but it's safest just to catch anything and show | |
3203 | # the user a traceback. |
|
3203 | # the user a traceback. | |
3204 |
|
3204 | |||
3205 | # We do only one try/except outside the loop to minimize the impact |
|
3205 | # We do only one try/except outside the loop to minimize the impact | |
3206 | # on runtime, and also because if any node in the node list is |
|
3206 | # on runtime, and also because if any node in the node list is | |
3207 | # broken, we should stop execution completely. |
|
3207 | # broken, we should stop execution completely. | |
3208 | if result: |
|
3208 | if result: | |
3209 | result.error_before_exec = sys.exc_info()[1] |
|
3209 | result.error_before_exec = sys.exc_info()[1] | |
3210 | self.showtraceback() |
|
3210 | self.showtraceback() | |
3211 | return True |
|
3211 | return True | |
3212 |
|
3212 | |||
3213 | return False |
|
3213 | return False | |
3214 |
|
3214 | |||
3215 | def _async_exec(self, code_obj: types.CodeType, user_ns: dict): |
|
3215 | def _async_exec(self, code_obj: types.CodeType, user_ns: dict): | |
3216 | """ |
|
3216 | """ | |
3217 | Evaluate an asynchronous code object using a code runner |
|
3217 | Evaluate an asynchronous code object using a code runner | |
3218 |
|
3218 | |||
3219 | Fake asynchronous execution of code_object in a namespace via a proxy namespace. |
|
3219 | Fake asynchronous execution of code_object in a namespace via a proxy namespace. | |
3220 |
|
3220 | |||
3221 | Returns coroutine object, which can be executed via async loop runner |
|
3221 | Returns coroutine object, which can be executed via async loop runner | |
3222 |
|
3222 | |||
3223 | WARNING: The semantics of `async_exec` are quite different from `exec`, |
|
3223 | WARNING: The semantics of `async_exec` are quite different from `exec`, | |
3224 | in particular you can only pass a single namespace. It also return a |
|
3224 | in particular you can only pass a single namespace. It also return a | |
3225 | handle to the value of the last things returned by code_object. |
|
3225 | handle to the value of the last things returned by code_object. | |
3226 | """ |
|
3226 | """ | |
3227 |
|
3227 | |||
3228 | return eval(code_obj, user_ns) |
|
3228 | return eval(code_obj, user_ns) | |
3229 |
|
3229 | |||
3230 | @asyncio.coroutine |
|
3230 | @asyncio.coroutine | |
3231 | def run_code(self, code_obj, result=None, *, async_=False): |
|
3231 | def run_code(self, code_obj, result=None, *, async_=False): | |
3232 | """Execute a code object. |
|
3232 | """Execute a code object. | |
3233 |
|
3233 | |||
3234 | When an exception occurs, self.showtraceback() is called to display a |
|
3234 | When an exception occurs, self.showtraceback() is called to display a | |
3235 | traceback. |
|
3235 | traceback. | |
3236 |
|
3236 | |||
3237 | Parameters |
|
3237 | Parameters | |
3238 | ---------- |
|
3238 | ---------- | |
3239 | code_obj : code object |
|
3239 | code_obj : code object | |
3240 | A compiled code object, to be executed |
|
3240 | A compiled code object, to be executed | |
3241 | result : ExecutionResult, optional |
|
3241 | result : ExecutionResult, optional | |
3242 | An object to store exceptions that occur during execution. |
|
3242 | An object to store exceptions that occur during execution. | |
3243 | async_ : Bool (Experimental) |
|
3243 | async_ : Bool (Experimental) | |
3244 | Attempt to run top-level asynchronous code in a default loop. |
|
3244 | Attempt to run top-level asynchronous code in a default loop. | |
3245 |
|
3245 | |||
3246 | Returns |
|
3246 | Returns | |
3247 | ------- |
|
3247 | ------- | |
3248 | False : successful execution. |
|
3248 | False : successful execution. | |
3249 | True : an error occurred. |
|
3249 | True : an error occurred. | |
3250 | """ |
|
3250 | """ | |
3251 | # Set our own excepthook in case the user code tries to call it |
|
3251 | # Set our own excepthook in case the user code tries to call it | |
3252 | # directly, so that the IPython crash handler doesn't get triggered |
|
3252 | # directly, so that the IPython crash handler doesn't get triggered | |
3253 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook |
|
3253 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook | |
3254 |
|
3254 | |||
3255 | # we save the original sys.excepthook in the instance, in case config |
|
3255 | # we save the original sys.excepthook in the instance, in case config | |
3256 | # code (such as magics) needs access to it. |
|
3256 | # code (such as magics) needs access to it. | |
3257 | self.sys_excepthook = old_excepthook |
|
3257 | self.sys_excepthook = old_excepthook | |
3258 | outflag = True # happens in more places, so it's easier as default |
|
3258 | outflag = True # happens in more places, so it's easier as default | |
3259 | try: |
|
3259 | try: | |
3260 | try: |
|
3260 | try: | |
3261 | self.hooks.pre_run_code_hook() |
|
3261 | self.hooks.pre_run_code_hook() | |
3262 | if async_: |
|
3262 | if async_: | |
3263 | last_expr = (yield from self._async_exec(code_obj, self.user_ns)) |
|
3263 | last_expr = (yield from self._async_exec(code_obj, self.user_ns)) | |
3264 | code = compile('last_expr', 'fake', "single") |
|
3264 | code = compile('last_expr', 'fake', "single") | |
3265 | exec(code, {'last_expr': last_expr}) |
|
3265 | exec(code, {'last_expr': last_expr}) | |
3266 | else: |
|
3266 | else: | |
3267 | exec(code_obj, self.user_global_ns, self.user_ns) |
|
3267 | exec(code_obj, self.user_global_ns, self.user_ns) | |
3268 | finally: |
|
3268 | finally: | |
3269 | # Reset our crash handler in place |
|
3269 | # Reset our crash handler in place | |
3270 | sys.excepthook = old_excepthook |
|
3270 | sys.excepthook = old_excepthook | |
3271 | except SystemExit as e: |
|
3271 | except SystemExit as e: | |
3272 | if result is not None: |
|
3272 | if result is not None: | |
3273 | result.error_in_exec = e |
|
3273 | result.error_in_exec = e | |
3274 | self.showtraceback(exception_only=True) |
|
3274 | self.showtraceback(exception_only=True) | |
3275 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1) |
|
3275 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1) | |
3276 | except self.custom_exceptions: |
|
3276 | except self.custom_exceptions: | |
3277 | etype, value, tb = sys.exc_info() |
|
3277 | etype, value, tb = sys.exc_info() | |
3278 | if result is not None: |
|
3278 | if result is not None: | |
3279 | result.error_in_exec = value |
|
3279 | result.error_in_exec = value | |
3280 | self.CustomTB(etype, value, tb) |
|
3280 | self.CustomTB(etype, value, tb) | |
3281 | except: |
|
3281 | except: | |
3282 | if result is not None: |
|
3282 | if result is not None: | |
3283 | result.error_in_exec = sys.exc_info()[1] |
|
3283 | result.error_in_exec = sys.exc_info()[1] | |
3284 | self.showtraceback(running_compiled_code=True) |
|
3284 | self.showtraceback(running_compiled_code=True) | |
3285 | else: |
|
3285 | else: | |
3286 | outflag = False |
|
3286 | outflag = False | |
3287 | return outflag |
|
3287 | return outflag | |
3288 |
|
3288 | |||
3289 | # For backwards compatibility |
|
3289 | # For backwards compatibility | |
3290 | runcode = run_code |
|
3290 | runcode = run_code | |
3291 |
|
3291 | |||
3292 | def check_complete(self, code: str) -> Tuple[str, str]: |
|
3292 | def check_complete(self, code: str) -> Tuple[str, str]: | |
3293 | """Return whether a block of code is ready to execute, or should be continued |
|
3293 | """Return whether a block of code is ready to execute, or should be continued | |
3294 |
|
3294 | |||
3295 | Parameters |
|
3295 | Parameters | |
3296 | ---------- |
|
3296 | ---------- | |
3297 | source : string |
|
3297 | source : string | |
3298 | Python input code, which can be multiline. |
|
3298 | Python input code, which can be multiline. | |
3299 |
|
3299 | |||
3300 | Returns |
|
3300 | Returns | |
3301 | ------- |
|
3301 | ------- | |
3302 | status : str |
|
3302 | status : str | |
3303 | One of 'complete', 'incomplete', or 'invalid' if source is not a |
|
3303 | One of 'complete', 'incomplete', or 'invalid' if source is not a | |
3304 | prefix of valid code. |
|
3304 | prefix of valid code. | |
3305 | indent : str |
|
3305 | indent : str | |
3306 | When status is 'incomplete', this is some whitespace to insert on |
|
3306 | When status is 'incomplete', this is some whitespace to insert on | |
3307 | the next line of the prompt. |
|
3307 | the next line of the prompt. | |
3308 | """ |
|
3308 | """ | |
3309 | status, nspaces = self.input_transformer_manager.check_complete(code) |
|
3309 | status, nspaces = self.input_transformer_manager.check_complete(code) | |
3310 | return status, ' ' * (nspaces or 0) |
|
3310 | return status, ' ' * (nspaces or 0) | |
3311 |
|
3311 | |||
3312 | #------------------------------------------------------------------------- |
|
3312 | #------------------------------------------------------------------------- | |
3313 | # Things related to GUI support and pylab |
|
3313 | # Things related to GUI support and pylab | |
3314 | #------------------------------------------------------------------------- |
|
3314 | #------------------------------------------------------------------------- | |
3315 |
|
3315 | |||
3316 | active_eventloop = None |
|
3316 | active_eventloop = None | |
3317 |
|
3317 | |||
3318 | def enable_gui(self, gui=None): |
|
3318 | def enable_gui(self, gui=None): | |
3319 | raise NotImplementedError('Implement enable_gui in a subclass') |
|
3319 | raise NotImplementedError('Implement enable_gui in a subclass') | |
3320 |
|
3320 | |||
3321 | def enable_matplotlib(self, gui=None): |
|
3321 | def enable_matplotlib(self, gui=None): | |
3322 | """Enable interactive matplotlib and inline figure support. |
|
3322 | """Enable interactive matplotlib and inline figure support. | |
3323 |
|
3323 | |||
3324 | This takes the following steps: |
|
3324 | This takes the following steps: | |
3325 |
|
3325 | |||
3326 | 1. select the appropriate eventloop and matplotlib backend |
|
3326 | 1. select the appropriate eventloop and matplotlib backend | |
3327 | 2. set up matplotlib for interactive use with that backend |
|
3327 | 2. set up matplotlib for interactive use with that backend | |
3328 | 3. configure formatters for inline figure display |
|
3328 | 3. configure formatters for inline figure display | |
3329 | 4. enable the selected gui eventloop |
|
3329 | 4. enable the selected gui eventloop | |
3330 |
|
3330 | |||
3331 | Parameters |
|
3331 | Parameters | |
3332 | ---------- |
|
3332 | ---------- | |
3333 | gui : optional, string |
|
3333 | gui : optional, string | |
3334 | If given, dictates the choice of matplotlib GUI backend to use |
|
3334 | If given, dictates the choice of matplotlib GUI backend to use | |
3335 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3335 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', | |
3336 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3336 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by | |
3337 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3337 | matplotlib (as dictated by the matplotlib build-time options plus the | |
3338 | user's matplotlibrc configuration file). Note that not all backends |
|
3338 | user's matplotlibrc configuration file). Note that not all backends | |
3339 | make sense in all contexts, for example a terminal ipython can't |
|
3339 | make sense in all contexts, for example a terminal ipython can't | |
3340 | display figures inline. |
|
3340 | display figures inline. | |
3341 | """ |
|
3341 | """ | |
3342 | from IPython.core import pylabtools as pt |
|
3342 | from IPython.core import pylabtools as pt | |
3343 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) |
|
3343 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) | |
3344 |
|
3344 | |||
3345 | if gui != 'inline': |
|
3345 | if gui != 'inline': | |
3346 | # If we have our first gui selection, store it |
|
3346 | # If we have our first gui selection, store it | |
3347 | if self.pylab_gui_select is None: |
|
3347 | if self.pylab_gui_select is None: | |
3348 | self.pylab_gui_select = gui |
|
3348 | self.pylab_gui_select = gui | |
3349 | # Otherwise if they are different |
|
3349 | # Otherwise if they are different | |
3350 | elif gui != self.pylab_gui_select: |
|
3350 | elif gui != self.pylab_gui_select: | |
3351 | print('Warning: Cannot change to a different GUI toolkit: %s.' |
|
3351 | print('Warning: Cannot change to a different GUI toolkit: %s.' | |
3352 | ' Using %s instead.' % (gui, self.pylab_gui_select)) |
|
3352 | ' Using %s instead.' % (gui, self.pylab_gui_select)) | |
3353 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) |
|
3353 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) | |
3354 |
|
3354 | |||
3355 | pt.activate_matplotlib(backend) |
|
3355 | pt.activate_matplotlib(backend) | |
3356 | pt.configure_inline_support(self, backend) |
|
3356 | pt.configure_inline_support(self, backend) | |
3357 |
|
3357 | |||
3358 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
3358 | # Now we must activate the gui pylab wants to use, and fix %run to take | |
3359 | # plot updates into account |
|
3359 | # plot updates into account | |
3360 | self.enable_gui(gui) |
|
3360 | self.enable_gui(gui) | |
3361 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ |
|
3361 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ | |
3362 | pt.mpl_runner(self.safe_execfile) |
|
3362 | pt.mpl_runner(self.safe_execfile) | |
3363 |
|
3363 | |||
3364 | return gui, backend |
|
3364 | return gui, backend | |
3365 |
|
3365 | |||
3366 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): |
|
3366 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): | |
3367 | """Activate pylab support at runtime. |
|
3367 | """Activate pylab support at runtime. | |
3368 |
|
3368 | |||
3369 | This turns on support for matplotlib, preloads into the interactive |
|
3369 | This turns on support for matplotlib, preloads into the interactive | |
3370 | namespace all of numpy and pylab, and configures IPython to correctly |
|
3370 | namespace all of numpy and pylab, and configures IPython to correctly | |
3371 | interact with the GUI event loop. The GUI backend to be used can be |
|
3371 | interact with the GUI event loop. The GUI backend to be used can be | |
3372 | optionally selected with the optional ``gui`` argument. |
|
3372 | optionally selected with the optional ``gui`` argument. | |
3373 |
|
3373 | |||
3374 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. |
|
3374 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. | |
3375 |
|
3375 | |||
3376 | Parameters |
|
3376 | Parameters | |
3377 | ---------- |
|
3377 | ---------- | |
3378 | gui : optional, string |
|
3378 | gui : optional, string | |
3379 | If given, dictates the choice of matplotlib GUI backend to use |
|
3379 | If given, dictates the choice of matplotlib GUI backend to use | |
3380 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3380 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', | |
3381 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3381 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by | |
3382 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3382 | matplotlib (as dictated by the matplotlib build-time options plus the | |
3383 | user's matplotlibrc configuration file). Note that not all backends |
|
3383 | user's matplotlibrc configuration file). Note that not all backends | |
3384 | make sense in all contexts, for example a terminal ipython can't |
|
3384 | make sense in all contexts, for example a terminal ipython can't | |
3385 | display figures inline. |
|
3385 | display figures inline. | |
3386 | import_all : optional, bool, default: True |
|
3386 | import_all : optional, bool, default: True | |
3387 | Whether to do `from numpy import *` and `from pylab import *` |
|
3387 | Whether to do `from numpy import *` and `from pylab import *` | |
3388 | in addition to module imports. |
|
3388 | in addition to module imports. | |
3389 | welcome_message : deprecated |
|
3389 | welcome_message : deprecated | |
3390 | This argument is ignored, no welcome message will be displayed. |
|
3390 | This argument is ignored, no welcome message will be displayed. | |
3391 | """ |
|
3391 | """ | |
3392 | from IPython.core.pylabtools import import_pylab |
|
3392 | from IPython.core.pylabtools import import_pylab | |
3393 |
|
3393 | |||
3394 | gui, backend = self.enable_matplotlib(gui) |
|
3394 | gui, backend = self.enable_matplotlib(gui) | |
3395 |
|
3395 | |||
3396 | # We want to prevent the loading of pylab to pollute the user's |
|
3396 | # We want to prevent the loading of pylab to pollute the user's | |
3397 | # namespace as shown by the %who* magics, so we execute the activation |
|
3397 | # namespace as shown by the %who* magics, so we execute the activation | |
3398 | # code in an empty namespace, and we update *both* user_ns and |
|
3398 | # code in an empty namespace, and we update *both* user_ns and | |
3399 | # user_ns_hidden with this information. |
|
3399 | # user_ns_hidden with this information. | |
3400 | ns = {} |
|
3400 | ns = {} | |
3401 | import_pylab(ns, import_all) |
|
3401 | import_pylab(ns, import_all) | |
3402 | # warn about clobbered names |
|
3402 | # warn about clobbered names | |
3403 | ignored = {"__builtins__"} |
|
3403 | ignored = {"__builtins__"} | |
3404 | both = set(ns).intersection(self.user_ns).difference(ignored) |
|
3404 | both = set(ns).intersection(self.user_ns).difference(ignored) | |
3405 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] |
|
3405 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] | |
3406 | self.user_ns.update(ns) |
|
3406 | self.user_ns.update(ns) | |
3407 | self.user_ns_hidden.update(ns) |
|
3407 | self.user_ns_hidden.update(ns) | |
3408 | return gui, backend, clobbered |
|
3408 | return gui, backend, clobbered | |
3409 |
|
3409 | |||
3410 | #------------------------------------------------------------------------- |
|
3410 | #------------------------------------------------------------------------- | |
3411 | # Utilities |
|
3411 | # Utilities | |
3412 | #------------------------------------------------------------------------- |
|
3412 | #------------------------------------------------------------------------- | |
3413 |
|
3413 | |||
3414 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
3414 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): | |
3415 | """Expand python variables in a string. |
|
3415 | """Expand python variables in a string. | |
3416 |
|
3416 | |||
3417 | The depth argument indicates how many frames above the caller should |
|
3417 | The depth argument indicates how many frames above the caller should | |
3418 | be walked to look for the local namespace where to expand variables. |
|
3418 | be walked to look for the local namespace where to expand variables. | |
3419 |
|
3419 | |||
3420 | The global namespace for expansion is always the user's interactive |
|
3420 | The global namespace for expansion is always the user's interactive | |
3421 | namespace. |
|
3421 | namespace. | |
3422 | """ |
|
3422 | """ | |
3423 | ns = self.user_ns.copy() |
|
3423 | ns = self.user_ns.copy() | |
3424 | try: |
|
3424 | try: | |
3425 | frame = sys._getframe(depth+1) |
|
3425 | frame = sys._getframe(depth+1) | |
3426 | except ValueError: |
|
3426 | except ValueError: | |
3427 | # This is thrown if there aren't that many frames on the stack, |
|
3427 | # This is thrown if there aren't that many frames on the stack, | |
3428 | # e.g. if a script called run_line_magic() directly. |
|
3428 | # e.g. if a script called run_line_magic() directly. | |
3429 | pass |
|
3429 | pass | |
3430 | else: |
|
3430 | else: | |
3431 | ns.update(frame.f_locals) |
|
3431 | ns.update(frame.f_locals) | |
3432 |
|
3432 | |||
3433 | try: |
|
3433 | try: | |
3434 | # We have to use .vformat() here, because 'self' is a valid and common |
|
3434 | # We have to use .vformat() here, because 'self' is a valid and common | |
3435 | # name, and expanding **ns for .format() would make it collide with |
|
3435 | # name, and expanding **ns for .format() would make it collide with | |
3436 | # the 'self' argument of the method. |
|
3436 | # the 'self' argument of the method. | |
3437 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) |
|
3437 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) | |
3438 | except Exception: |
|
3438 | except Exception: | |
3439 | # if formatter couldn't format, just let it go untransformed |
|
3439 | # if formatter couldn't format, just let it go untransformed | |
3440 | pass |
|
3440 | pass | |
3441 | return cmd |
|
3441 | return cmd | |
3442 |
|
3442 | |||
3443 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
3443 | def mktempfile(self, data=None, prefix='ipython_edit_'): | |
3444 | """Make a new tempfile and return its filename. |
|
3444 | """Make a new tempfile and return its filename. | |
3445 |
|
3445 | |||
3446 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), |
|
3446 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), | |
3447 | but it registers the created filename internally so ipython cleans it up |
|
3447 | but it registers the created filename internally so ipython cleans it up | |
3448 | at exit time. |
|
3448 | at exit time. | |
3449 |
|
3449 | |||
3450 | Optional inputs: |
|
3450 | Optional inputs: | |
3451 |
|
3451 | |||
3452 | - data(None): if data is given, it gets written out to the temp file |
|
3452 | - data(None): if data is given, it gets written out to the temp file | |
3453 | immediately, and the file is closed again.""" |
|
3453 | immediately, and the file is closed again.""" | |
3454 |
|
3454 | |||
3455 | dirname = tempfile.mkdtemp(prefix=prefix) |
|
3455 | dirname = tempfile.mkdtemp(prefix=prefix) | |
3456 | self.tempdirs.append(dirname) |
|
3456 | self.tempdirs.append(dirname) | |
3457 |
|
3457 | |||
3458 | handle, filename = tempfile.mkstemp('.py', prefix, dir=dirname) |
|
3458 | handle, filename = tempfile.mkstemp('.py', prefix, dir=dirname) | |
3459 | os.close(handle) # On Windows, there can only be one open handle on a file |
|
3459 | os.close(handle) # On Windows, there can only be one open handle on a file | |
3460 | self.tempfiles.append(filename) |
|
3460 | self.tempfiles.append(filename) | |
3461 |
|
3461 | |||
3462 | if data: |
|
3462 | if data: | |
3463 | tmp_file = open(filename,'w') |
|
3463 | tmp_file = open(filename,'w') | |
3464 | tmp_file.write(data) |
|
3464 | tmp_file.write(data) | |
3465 | tmp_file.close() |
|
3465 | tmp_file.close() | |
3466 | return filename |
|
3466 | return filename | |
3467 |
|
3467 | |||
3468 | @undoc |
|
3468 | @undoc | |
3469 | def write(self,data): |
|
3469 | def write(self,data): | |
3470 | """DEPRECATED: Write a string to the default output""" |
|
3470 | """DEPRECATED: Write a string to the default output""" | |
3471 | warn('InteractiveShell.write() is deprecated, use sys.stdout instead', |
|
3471 | warn('InteractiveShell.write() is deprecated, use sys.stdout instead', | |
3472 | DeprecationWarning, stacklevel=2) |
|
3472 | DeprecationWarning, stacklevel=2) | |
3473 | sys.stdout.write(data) |
|
3473 | sys.stdout.write(data) | |
3474 |
|
3474 | |||
3475 | @undoc |
|
3475 | @undoc | |
3476 | def write_err(self,data): |
|
3476 | def write_err(self,data): | |
3477 | """DEPRECATED: Write a string to the default error output""" |
|
3477 | """DEPRECATED: Write a string to the default error output""" | |
3478 | warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead', |
|
3478 | warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead', | |
3479 | DeprecationWarning, stacklevel=2) |
|
3479 | DeprecationWarning, stacklevel=2) | |
3480 | sys.stderr.write(data) |
|
3480 | sys.stderr.write(data) | |
3481 |
|
3481 | |||
3482 | def ask_yes_no(self, prompt, default=None, interrupt=None): |
|
3482 | def ask_yes_no(self, prompt, default=None, interrupt=None): | |
3483 | if self.quiet: |
|
3483 | if self.quiet: | |
3484 | return True |
|
3484 | return True | |
3485 | return ask_yes_no(prompt,default,interrupt) |
|
3485 | return ask_yes_no(prompt,default,interrupt) | |
3486 |
|
3486 | |||
3487 | def show_usage(self): |
|
3487 | def show_usage(self): | |
3488 | """Show a usage message""" |
|
3488 | """Show a usage message""" | |
3489 | page.page(IPython.core.usage.interactive_usage) |
|
3489 | page.page(IPython.core.usage.interactive_usage) | |
3490 |
|
3490 | |||
3491 | def extract_input_lines(self, range_str, raw=False): |
|
3491 | def extract_input_lines(self, range_str, raw=False): | |
3492 | """Return as a string a set of input history slices. |
|
3492 | """Return as a string a set of input history slices. | |
3493 |
|
3493 | |||
3494 | Parameters |
|
3494 | Parameters | |
3495 | ---------- |
|
3495 | ---------- | |
3496 | range_str : string |
|
3496 | range_str : string | |
3497 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", |
|
3497 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", | |
3498 | since this function is for use by magic functions which get their |
|
3498 | since this function is for use by magic functions which get their | |
3499 | arguments as strings. The number before the / is the session |
|
3499 | arguments as strings. The number before the / is the session | |
3500 | number: ~n goes n back from the current session. |
|
3500 | number: ~n goes n back from the current session. | |
3501 |
|
3501 | |||
3502 | raw : bool, optional |
|
3502 | raw : bool, optional | |
3503 | By default, the processed input is used. If this is true, the raw |
|
3503 | By default, the processed input is used. If this is true, the raw | |
3504 | input history is used instead. |
|
3504 | input history is used instead. | |
3505 |
|
3505 | |||
3506 | Notes |
|
3506 | Notes | |
3507 | ----- |
|
3507 | ----- | |
3508 |
|
3508 | |||
3509 | Slices can be described with two notations: |
|
3509 | Slices can be described with two notations: | |
3510 |
|
3510 | |||
3511 | * ``N:M`` -> standard python form, means including items N...(M-1). |
|
3511 | * ``N:M`` -> standard python form, means including items N...(M-1). | |
3512 | * ``N-M`` -> include items N..M (closed endpoint). |
|
3512 | * ``N-M`` -> include items N..M (closed endpoint). | |
3513 | """ |
|
3513 | """ | |
3514 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) |
|
3514 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) | |
3515 | return "\n".join(x for _, _, x in lines) |
|
3515 | return "\n".join(x for _, _, x in lines) | |
3516 |
|
3516 | |||
3517 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): |
|
3517 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): | |
3518 | """Get a code string from history, file, url, or a string or macro. |
|
3518 | """Get a code string from history, file, url, or a string or macro. | |
3519 |
|
3519 | |||
3520 | This is mainly used by magic functions. |
|
3520 | This is mainly used by magic functions. | |
3521 |
|
3521 | |||
3522 | Parameters |
|
3522 | Parameters | |
3523 | ---------- |
|
3523 | ---------- | |
3524 |
|
3524 | |||
3525 | target : str |
|
3525 | target : str | |
3526 |
|
3526 | |||
3527 | A string specifying code to retrieve. This will be tried respectively |
|
3527 | A string specifying code to retrieve. This will be tried respectively | |
3528 | as: ranges of input history (see %history for syntax), url, |
|
3528 | as: ranges of input history (see %history for syntax), url, | |
3529 | corresponding .py file, filename, or an expression evaluating to a |
|
3529 | corresponding .py file, filename, or an expression evaluating to a | |
3530 | string or Macro in the user namespace. |
|
3530 | string or Macro in the user namespace. | |
3531 |
|
3531 | |||
3532 | raw : bool |
|
3532 | raw : bool | |
3533 | If true (default), retrieve raw history. Has no effect on the other |
|
3533 | If true (default), retrieve raw history. Has no effect on the other | |
3534 | retrieval mechanisms. |
|
3534 | retrieval mechanisms. | |
3535 |
|
3535 | |||
3536 | py_only : bool (default False) |
|
3536 | py_only : bool (default False) | |
3537 | Only try to fetch python code, do not try alternative methods to decode file |
|
3537 | Only try to fetch python code, do not try alternative methods to decode file | |
3538 | if unicode fails. |
|
3538 | if unicode fails. | |
3539 |
|
3539 | |||
3540 | Returns |
|
3540 | Returns | |
3541 | ------- |
|
3541 | ------- | |
3542 | A string of code. |
|
3542 | A string of code. | |
3543 |
|
3543 | |||
3544 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
3544 | ValueError is raised if nothing is found, and TypeError if it evaluates | |
3545 | to an object of another type. In each case, .args[0] is a printable |
|
3545 | to an object of another type. In each case, .args[0] is a printable | |
3546 | message. |
|
3546 | message. | |
3547 | """ |
|
3547 | """ | |
3548 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
3548 | code = self.extract_input_lines(target, raw=raw) # Grab history | |
3549 | if code: |
|
3549 | if code: | |
3550 | return code |
|
3550 | return code | |
3551 | try: |
|
3551 | try: | |
3552 | if target.startswith(('http://', 'https://')): |
|
3552 | if target.startswith(('http://', 'https://')): | |
3553 | return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie) |
|
3553 | return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie) | |
3554 | except UnicodeDecodeError: |
|
3554 | except UnicodeDecodeError: | |
3555 | if not py_only : |
|
3555 | if not py_only : | |
3556 | # Deferred import |
|
3556 | # Deferred import | |
3557 | from urllib.request import urlopen |
|
3557 | from urllib.request import urlopen | |
3558 | response = urlopen(target) |
|
3558 | response = urlopen(target) | |
3559 | return response.read().decode('latin1') |
|
3559 | return response.read().decode('latin1') | |
3560 | raise ValueError(("'%s' seem to be unreadable.") % target) |
|
3560 | raise ValueError(("'%s' seem to be unreadable.") % target) | |
3561 |
|
3561 | |||
3562 | potential_target = [target] |
|
3562 | potential_target = [target] | |
3563 | try : |
|
3563 | try : | |
3564 | potential_target.insert(0,get_py_filename(target)) |
|
3564 | potential_target.insert(0,get_py_filename(target)) | |
3565 | except IOError: |
|
3565 | except IOError: | |
3566 | pass |
|
3566 | pass | |
3567 |
|
3567 | |||
3568 | for tgt in potential_target : |
|
3568 | for tgt in potential_target : | |
3569 | if os.path.isfile(tgt): # Read file |
|
3569 | if os.path.isfile(tgt): # Read file | |
3570 | try : |
|
3570 | try : | |
3571 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) |
|
3571 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) | |
3572 | except UnicodeDecodeError : |
|
3572 | except UnicodeDecodeError : | |
3573 | if not py_only : |
|
3573 | if not py_only : | |
3574 | with io_open(tgt,'r', encoding='latin1') as f : |
|
3574 | with io_open(tgt,'r', encoding='latin1') as f : | |
3575 | return f.read() |
|
3575 | return f.read() | |
3576 | raise ValueError(("'%s' seem to be unreadable.") % target) |
|
3576 | raise ValueError(("'%s' seem to be unreadable.") % target) | |
3577 | elif os.path.isdir(os.path.expanduser(tgt)): |
|
3577 | elif os.path.isdir(os.path.expanduser(tgt)): | |
3578 | raise ValueError("'%s' is a directory, not a regular file." % target) |
|
3578 | raise ValueError("'%s' is a directory, not a regular file." % target) | |
3579 |
|
3579 | |||
3580 | if search_ns: |
|
3580 | if search_ns: | |
3581 | # Inspect namespace to load object source |
|
3581 | # Inspect namespace to load object source | |
3582 | object_info = self.object_inspect(target, detail_level=1) |
|
3582 | object_info = self.object_inspect(target, detail_level=1) | |
3583 | if object_info['found'] and object_info['source']: |
|
3583 | if object_info['found'] and object_info['source']: | |
3584 | return object_info['source'] |
|
3584 | return object_info['source'] | |
3585 |
|
3585 | |||
3586 | try: # User namespace |
|
3586 | try: # User namespace | |
3587 | codeobj = eval(target, self.user_ns) |
|
3587 | codeobj = eval(target, self.user_ns) | |
3588 | except Exception: |
|
3588 | except Exception: | |
3589 | raise ValueError(("'%s' was not found in history, as a file, url, " |
|
3589 | raise ValueError(("'%s' was not found in history, as a file, url, " | |
3590 | "nor in the user namespace.") % target) |
|
3590 | "nor in the user namespace.") % target) | |
3591 |
|
3591 | |||
3592 | if isinstance(codeobj, str): |
|
3592 | if isinstance(codeobj, str): | |
3593 | return codeobj |
|
3593 | return codeobj | |
3594 | elif isinstance(codeobj, Macro): |
|
3594 | elif isinstance(codeobj, Macro): | |
3595 | return codeobj.value |
|
3595 | return codeobj.value | |
3596 |
|
3596 | |||
3597 | raise TypeError("%s is neither a string nor a macro." % target, |
|
3597 | raise TypeError("%s is neither a string nor a macro." % target, | |
3598 | codeobj) |
|
3598 | codeobj) | |
3599 |
|
3599 | |||
3600 | #------------------------------------------------------------------------- |
|
3600 | #------------------------------------------------------------------------- | |
3601 | # Things related to IPython exiting |
|
3601 | # Things related to IPython exiting | |
3602 | #------------------------------------------------------------------------- |
|
3602 | #------------------------------------------------------------------------- | |
3603 | def atexit_operations(self): |
|
3603 | def atexit_operations(self): | |
3604 | """This will be executed at the time of exit. |
|
3604 | """This will be executed at the time of exit. | |
3605 |
|
3605 | |||
3606 | Cleanup operations and saving of persistent data that is done |
|
3606 | Cleanup operations and saving of persistent data that is done | |
3607 | unconditionally by IPython should be performed here. |
|
3607 | unconditionally by IPython should be performed here. | |
3608 |
|
3608 | |||
3609 | For things that may depend on startup flags or platform specifics (such |
|
3609 | For things that may depend on startup flags or platform specifics (such | |
3610 | as having readline or not), register a separate atexit function in the |
|
3610 | as having readline or not), register a separate atexit function in the | |
3611 | code that has the appropriate information, rather than trying to |
|
3611 | code that has the appropriate information, rather than trying to | |
3612 | clutter |
|
3612 | clutter | |
3613 | """ |
|
3613 | """ | |
3614 | # Close the history session (this stores the end time and line count) |
|
3614 | # Close the history session (this stores the end time and line count) | |
3615 | # this must be *before* the tempfile cleanup, in case of temporary |
|
3615 | # this must be *before* the tempfile cleanup, in case of temporary | |
3616 | # history db |
|
3616 | # history db | |
3617 | self.history_manager.end_session() |
|
3617 | self.history_manager.end_session() | |
3618 |
|
3618 | |||
3619 | # Cleanup all tempfiles and folders left around |
|
3619 | # Cleanup all tempfiles and folders left around | |
3620 | for tfile in self.tempfiles: |
|
3620 | for tfile in self.tempfiles: | |
3621 | try: |
|
3621 | try: | |
3622 | os.unlink(tfile) |
|
3622 | os.unlink(tfile) | |
3623 | except OSError: |
|
3623 | except OSError: | |
3624 | pass |
|
3624 | pass | |
3625 |
|
3625 | |||
3626 | for tdir in self.tempdirs: |
|
3626 | for tdir in self.tempdirs: | |
3627 | try: |
|
3627 | try: | |
3628 | os.rmdir(tdir) |
|
3628 | os.rmdir(tdir) | |
3629 | except OSError: |
|
3629 | except OSError: | |
3630 | pass |
|
3630 | pass | |
3631 |
|
3631 | |||
3632 | # Clear all user namespaces to release all references cleanly. |
|
3632 | # Clear all user namespaces to release all references cleanly. | |
3633 | self.reset(new_session=False) |
|
3633 | self.reset(new_session=False) | |
3634 |
|
3634 | |||
3635 | # Run user hooks |
|
3635 | # Run user hooks | |
3636 | self.hooks.shutdown_hook() |
|
3636 | self.hooks.shutdown_hook() | |
3637 |
|
3637 | |||
3638 | def cleanup(self): |
|
3638 | def cleanup(self): | |
3639 | self.restore_sys_module_state() |
|
3639 | self.restore_sys_module_state() | |
3640 |
|
3640 | |||
3641 |
|
3641 | |||
3642 | # Overridden in terminal subclass to change prompts |
|
3642 | # Overridden in terminal subclass to change prompts | |
3643 | def switch_doctest_mode(self, mode): |
|
3643 | def switch_doctest_mode(self, mode): | |
3644 | pass |
|
3644 | pass | |
3645 |
|
3645 | |||
3646 |
|
3646 | |||
3647 | class InteractiveShellABC(metaclass=abc.ABCMeta): |
|
3647 | class InteractiveShellABC(metaclass=abc.ABCMeta): | |
3648 | """An abstract base class for InteractiveShell.""" |
|
3648 | """An abstract base class for InteractiveShell.""" | |
3649 |
|
3649 | |||
3650 | InteractiveShellABC.register(InteractiveShell) |
|
3650 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,671 +1,671 b'' | |||||
1 | """Implementation of basic magic functions.""" |
|
1 | """Implementation of basic magic functions.""" | |
2 |
|
2 | |||
3 |
|
3 | |||
4 | import argparse |
|
4 | import argparse | |
5 | from logging import error |
|
5 | from logging import error | |
6 | import io |
|
6 | import io | |
7 | from pprint import pformat |
|
7 | from pprint import pformat | |
8 | import textwrap |
|
8 | import textwrap | |
9 | import sys |
|
9 | import sys | |
10 | from warnings import warn |
|
10 | from warnings import warn | |
11 |
|
11 | |||
12 | from traitlets.utils.importstring import import_item |
|
12 | from traitlets.utils.importstring import import_item | |
13 | from IPython.core import magic_arguments, page |
|
13 | from IPython.core import magic_arguments, page | |
14 | from IPython.core.error import UsageError |
|
14 | from IPython.core.error import UsageError | |
15 | from IPython.core.magic import Magics, magics_class, line_magic, magic_escapes |
|
15 | from IPython.core.magic import Magics, magics_class, line_magic, magic_escapes | |
16 | from IPython.utils.text import format_screen, dedent, indent |
|
16 | from IPython.utils.text import format_screen, dedent, indent | |
17 | from IPython.testing.skipdoctest import skip_doctest |
|
17 | from IPython.testing.skipdoctest import skip_doctest | |
18 | from IPython.utils.ipstruct import Struct |
|
18 | from IPython.utils.ipstruct import Struct | |
19 |
|
19 | |||
20 |
|
20 | |||
21 | class MagicsDisplay(object): |
|
21 | class MagicsDisplay(object): | |
22 | def __init__(self, magics_manager, ignore=None): |
|
22 | def __init__(self, magics_manager, ignore=None): | |
23 | self.ignore = ignore if ignore else [] |
|
23 | self.ignore = ignore if ignore else [] | |
24 | self.magics_manager = magics_manager |
|
24 | self.magics_manager = magics_manager | |
25 |
|
25 | |||
26 | def _lsmagic(self): |
|
26 | def _lsmagic(self): | |
27 | """The main implementation of the %lsmagic""" |
|
27 | """The main implementation of the %lsmagic""" | |
28 | mesc = magic_escapes['line'] |
|
28 | mesc = magic_escapes['line'] | |
29 | cesc = magic_escapes['cell'] |
|
29 | cesc = magic_escapes['cell'] | |
30 | mman = self.magics_manager |
|
30 | mman = self.magics_manager | |
31 | magics = mman.lsmagic() |
|
31 | magics = mman.lsmagic() | |
32 | out = ['Available line magics:', |
|
32 | out = ['Available line magics:', | |
33 | mesc + (' '+mesc).join(sorted([m for m,v in magics['line'].items() if (v not in self.ignore)])), |
|
33 | mesc + (' '+mesc).join(sorted([m for m,v in magics['line'].items() if (v not in self.ignore)])), | |
34 | '', |
|
34 | '', | |
35 | 'Available cell magics:', |
|
35 | 'Available cell magics:', | |
36 | cesc + (' '+cesc).join(sorted([m for m,v in magics['cell'].items() if (v not in self.ignore)])), |
|
36 | cesc + (' '+cesc).join(sorted([m for m,v in magics['cell'].items() if (v not in self.ignore)])), | |
37 | '', |
|
37 | '', | |
38 | mman.auto_status()] |
|
38 | mman.auto_status()] | |
39 | return '\n'.join(out) |
|
39 | return '\n'.join(out) | |
40 |
|
40 | |||
41 | def _repr_pretty_(self, p, cycle): |
|
41 | def _repr_pretty_(self, p, cycle): | |
42 | p.text(self._lsmagic()) |
|
42 | p.text(self._lsmagic()) | |
43 |
|
43 | |||
44 | def __str__(self): |
|
44 | def __str__(self): | |
45 | return self._lsmagic() |
|
45 | return self._lsmagic() | |
46 |
|
46 | |||
47 | def _jsonable(self): |
|
47 | def _jsonable(self): | |
48 | """turn magics dict into jsonable dict of the same structure |
|
48 | """turn magics dict into jsonable dict of the same structure | |
49 |
|
49 | |||
50 | replaces object instances with their class names as strings |
|
50 | replaces object instances with their class names as strings | |
51 | """ |
|
51 | """ | |
52 | magic_dict = {} |
|
52 | magic_dict = {} | |
53 | mman = self.magics_manager |
|
53 | mman = self.magics_manager | |
54 | magics = mman.lsmagic() |
|
54 | magics = mman.lsmagic() | |
55 | for key, subdict in magics.items(): |
|
55 | for key, subdict in magics.items(): | |
56 | d = {} |
|
56 | d = {} | |
57 | magic_dict[key] = d |
|
57 | magic_dict[key] = d | |
58 | for name, obj in subdict.items(): |
|
58 | for name, obj in subdict.items(): | |
59 | try: |
|
59 | try: | |
60 | classname = obj.__self__.__class__.__name__ |
|
60 | classname = obj.__self__.__class__.__name__ | |
61 | except AttributeError: |
|
61 | except AttributeError: | |
62 | classname = 'Other' |
|
62 | classname = 'Other' | |
63 |
|
63 | |||
64 | d[name] = classname |
|
64 | d[name] = classname | |
65 | return magic_dict |
|
65 | return magic_dict | |
66 |
|
66 | |||
67 | def _repr_json_(self): |
|
67 | def _repr_json_(self): | |
68 | return self._jsonable() |
|
68 | return self._jsonable() | |
69 |
|
69 | |||
70 |
|
70 | |||
71 | @magics_class |
|
71 | @magics_class | |
72 | class BasicMagics(Magics): |
|
72 | class BasicMagics(Magics): | |
73 | """Magics that provide central IPython functionality. |
|
73 | """Magics that provide central IPython functionality. | |
74 |
|
74 | |||
75 | These are various magics that don't fit into specific categories but that |
|
75 | These are various magics that don't fit into specific categories but that | |
76 | are all part of the base 'IPython experience'.""" |
|
76 | are all part of the base 'IPython experience'.""" | |
77 |
|
77 | |||
78 | @magic_arguments.magic_arguments() |
|
78 | @magic_arguments.magic_arguments() | |
79 | @magic_arguments.argument( |
|
79 | @magic_arguments.argument( | |
80 | '-l', '--line', action='store_true', |
|
80 | '-l', '--line', action='store_true', | |
81 | help="""Create a line magic alias.""" |
|
81 | help="""Create a line magic alias.""" | |
82 | ) |
|
82 | ) | |
83 | @magic_arguments.argument( |
|
83 | @magic_arguments.argument( | |
84 | '-c', '--cell', action='store_true', |
|
84 | '-c', '--cell', action='store_true', | |
85 | help="""Create a cell magic alias.""" |
|
85 | help="""Create a cell magic alias.""" | |
86 | ) |
|
86 | ) | |
87 | @magic_arguments.argument( |
|
87 | @magic_arguments.argument( | |
88 | 'name', |
|
88 | 'name', | |
89 | help="""Name of the magic to be created.""" |
|
89 | help="""Name of the magic to be created.""" | |
90 | ) |
|
90 | ) | |
91 | @magic_arguments.argument( |
|
91 | @magic_arguments.argument( | |
92 | 'target', |
|
92 | 'target', | |
93 | help="""Name of the existing line or cell magic.""" |
|
93 | help="""Name of the existing line or cell magic.""" | |
94 | ) |
|
94 | ) | |
95 | @magic_arguments.argument( |
|
95 | @magic_arguments.argument( | |
96 | '-p', '--params', default=None, |
|
96 | '-p', '--params', default=None, | |
97 | help="""Parameters passed to the magic function.""" |
|
97 | help="""Parameters passed to the magic function.""" | |
98 | ) |
|
98 | ) | |
99 | @line_magic |
|
99 | @line_magic | |
100 | def alias_magic(self, line=''): |
|
100 | def alias_magic(self, line=''): | |
101 | """Create an alias for an existing line or cell magic. |
|
101 | """Create an alias for an existing line or cell magic. | |
102 |
|
102 | |||
103 | Examples |
|
103 | Examples | |
104 | -------- |
|
104 | -------- | |
105 | :: |
|
105 | :: | |
106 |
|
106 | |||
107 | In [1]: %alias_magic t timeit |
|
107 | In [1]: %alias_magic t timeit | |
108 | Created `%t` as an alias for `%timeit`. |
|
108 | Created `%t` as an alias for `%timeit`. | |
109 | Created `%%t` as an alias for `%%timeit`. |
|
109 | Created `%%t` as an alias for `%%timeit`. | |
110 |
|
110 | |||
111 | In [2]: %t -n1 pass |
|
111 | In [2]: %t -n1 pass | |
112 | 1 loops, best of 3: 954 ns per loop |
|
112 | 1 loops, best of 3: 954 ns per loop | |
113 |
|
113 | |||
114 | In [3]: %%t -n1 |
|
114 | In [3]: %%t -n1 | |
115 | ...: pass |
|
115 | ...: pass | |
116 | ...: |
|
116 | ...: | |
117 | 1 loops, best of 3: 954 ns per loop |
|
117 | 1 loops, best of 3: 954 ns per loop | |
118 |
|
118 | |||
119 | In [4]: %alias_magic --cell whereami pwd |
|
119 | In [4]: %alias_magic --cell whereami pwd | |
120 | UsageError: Cell magic function `%%pwd` not found. |
|
120 | UsageError: Cell magic function `%%pwd` not found. | |
121 | In [5]: %alias_magic --line whereami pwd |
|
121 | In [5]: %alias_magic --line whereami pwd | |
122 | Created `%whereami` as an alias for `%pwd`. |
|
122 | Created `%whereami` as an alias for `%pwd`. | |
123 |
|
123 | |||
124 | In [6]: %whereami |
|
124 | In [6]: %whereami | |
125 | Out[6]: u'/home/testuser' |
|
125 | Out[6]: u'/home/testuser' | |
126 |
|
126 | |||
127 | In [7]: %alias_magic h history -p "-l 30" --line |
|
127 | In [7]: %alias_magic h history -p "-l 30" --line | |
128 | Created `%h` as an alias for `%history -l 30`. |
|
128 | Created `%h` as an alias for `%history -l 30`. | |
129 | """ |
|
129 | """ | |
130 |
|
130 | |||
131 | args = magic_arguments.parse_argstring(self.alias_magic, line) |
|
131 | args = magic_arguments.parse_argstring(self.alias_magic, line) | |
132 | shell = self.shell |
|
132 | shell = self.shell | |
133 | mman = self.shell.magics_manager |
|
133 | mman = self.shell.magics_manager | |
134 | escs = ''.join(magic_escapes.values()) |
|
134 | escs = ''.join(magic_escapes.values()) | |
135 |
|
135 | |||
136 | target = args.target.lstrip(escs) |
|
136 | target = args.target.lstrip(escs) | |
137 | name = args.name.lstrip(escs) |
|
137 | name = args.name.lstrip(escs) | |
138 |
|
138 | |||
139 | params = args.params |
|
139 | params = args.params | |
140 | if (params and |
|
140 | if (params and | |
141 | ((params.startswith('"') and params.endswith('"')) |
|
141 | ((params.startswith('"') and params.endswith('"')) | |
142 | or (params.startswith("'") and params.endswith("'")))): |
|
142 | or (params.startswith("'") and params.endswith("'")))): | |
143 | params = params[1:-1] |
|
143 | params = params[1:-1] | |
144 |
|
144 | |||
145 | # Find the requested magics. |
|
145 | # Find the requested magics. | |
146 | m_line = shell.find_magic(target, 'line') |
|
146 | m_line = shell.find_magic(target, 'line') | |
147 | m_cell = shell.find_magic(target, 'cell') |
|
147 | m_cell = shell.find_magic(target, 'cell') | |
148 | if args.line and m_line is None: |
|
148 | if args.line and m_line is None: | |
149 | raise UsageError('Line magic function `%s%s` not found.' % |
|
149 | raise UsageError('Line magic function `%s%s` not found.' % | |
150 | (magic_escapes['line'], target)) |
|
150 | (magic_escapes['line'], target)) | |
151 | if args.cell and m_cell is None: |
|
151 | if args.cell and m_cell is None: | |
152 | raise UsageError('Cell magic function `%s%s` not found.' % |
|
152 | raise UsageError('Cell magic function `%s%s` not found.' % | |
153 | (magic_escapes['cell'], target)) |
|
153 | (magic_escapes['cell'], target)) | |
154 |
|
154 | |||
155 | # If --line and --cell are not specified, default to the ones |
|
155 | # If --line and --cell are not specified, default to the ones | |
156 | # that are available. |
|
156 | # that are available. | |
157 | if not args.line and not args.cell: |
|
157 | if not args.line and not args.cell: | |
158 | if not m_line and not m_cell: |
|
158 | if not m_line and not m_cell: | |
159 | raise UsageError( |
|
159 | raise UsageError( | |
160 | 'No line or cell magic with name `%s` found.' % target |
|
160 | 'No line or cell magic with name `%s` found.' % target | |
161 | ) |
|
161 | ) | |
162 | args.line = bool(m_line) |
|
162 | args.line = bool(m_line) | |
163 | args.cell = bool(m_cell) |
|
163 | args.cell = bool(m_cell) | |
164 |
|
164 | |||
165 | params_str = "" if params is None else " " + params |
|
165 | params_str = "" if params is None else " " + params | |
166 |
|
166 | |||
167 | if args.line: |
|
167 | if args.line: | |
168 | mman.register_alias(name, target, 'line', params) |
|
168 | mman.register_alias(name, target, 'line', params) | |
169 | print('Created `%s%s` as an alias for `%s%s%s`.' % ( |
|
169 | print('Created `%s%s` as an alias for `%s%s%s`.' % ( | |
170 | magic_escapes['line'], name, |
|
170 | magic_escapes['line'], name, | |
171 | magic_escapes['line'], target, params_str)) |
|
171 | magic_escapes['line'], target, params_str)) | |
172 |
|
172 | |||
173 | if args.cell: |
|
173 | if args.cell: | |
174 | mman.register_alias(name, target, 'cell', params) |
|
174 | mman.register_alias(name, target, 'cell', params) | |
175 | print('Created `%s%s` as an alias for `%s%s%s`.' % ( |
|
175 | print('Created `%s%s` as an alias for `%s%s%s`.' % ( | |
176 | magic_escapes['cell'], name, |
|
176 | magic_escapes['cell'], name, | |
177 | magic_escapes['cell'], target, params_str)) |
|
177 | magic_escapes['cell'], target, params_str)) | |
178 |
|
178 | |||
179 | @line_magic |
|
179 | @line_magic | |
180 | def lsmagic(self, parameter_s=''): |
|
180 | def lsmagic(self, parameter_s=''): | |
181 | """List currently available magic functions.""" |
|
181 | """List currently available magic functions.""" | |
182 | return MagicsDisplay(self.shell.magics_manager, ignore=[self.pip]) |
|
182 | return MagicsDisplay(self.shell.magics_manager, ignore=[self.pip]) | |
183 |
|
183 | |||
184 | def _magic_docs(self, brief=False, rest=False): |
|
184 | def _magic_docs(self, brief=False, rest=False): | |
185 | """Return docstrings from magic functions.""" |
|
185 | """Return docstrings from magic functions.""" | |
186 | mman = self.shell.magics_manager |
|
186 | mman = self.shell.magics_manager | |
187 | docs = mman.lsmagic_docs(brief, missing='No documentation') |
|
187 | docs = mman.lsmagic_docs(brief, missing='No documentation') | |
188 |
|
188 | |||
189 | if rest: |
|
189 | if rest: | |
190 | format_string = '**%s%s**::\n\n%s\n\n' |
|
190 | format_string = '**%s%s**::\n\n%s\n\n' | |
191 | else: |
|
191 | else: | |
192 | format_string = '%s%s:\n%s\n' |
|
192 | format_string = '%s%s:\n%s\n' | |
193 |
|
193 | |||
194 | return ''.join( |
|
194 | return ''.join( | |
195 | [format_string % (magic_escapes['line'], fname, |
|
195 | [format_string % (magic_escapes['line'], fname, | |
196 | indent(dedent(fndoc))) |
|
196 | indent(dedent(fndoc))) | |
197 | for fname, fndoc in sorted(docs['line'].items())] |
|
197 | for fname, fndoc in sorted(docs['line'].items())] | |
198 | + |
|
198 | + | |
199 | [format_string % (magic_escapes['cell'], fname, |
|
199 | [format_string % (magic_escapes['cell'], fname, | |
200 | indent(dedent(fndoc))) |
|
200 | indent(dedent(fndoc))) | |
201 | for fname, fndoc in sorted(docs['cell'].items())] |
|
201 | for fname, fndoc in sorted(docs['cell'].items())] | |
202 | ) |
|
202 | ) | |
203 |
|
203 | |||
204 | @line_magic |
|
204 | @line_magic | |
205 | def magic(self, parameter_s=''): |
|
205 | def magic(self, parameter_s=''): | |
206 | """Print information about the magic function system. |
|
206 | """Print information about the magic function system. | |
207 |
|
207 | |||
208 | Supported formats: -latex, -brief, -rest |
|
208 | Supported formats: -latex, -brief, -rest | |
209 | """ |
|
209 | """ | |
210 |
|
210 | |||
211 | mode = '' |
|
211 | mode = '' | |
212 | try: |
|
212 | try: | |
213 | mode = parameter_s.split()[0][1:] |
|
213 | mode = parameter_s.split()[0][1:] | |
214 | except IndexError: |
|
214 | except IndexError: | |
215 | pass |
|
215 | pass | |
216 |
|
216 | |||
217 | brief = (mode == 'brief') |
|
217 | brief = (mode == 'brief') | |
218 | rest = (mode == 'rest') |
|
218 | rest = (mode == 'rest') | |
219 | magic_docs = self._magic_docs(brief, rest) |
|
219 | magic_docs = self._magic_docs(brief, rest) | |
220 |
|
220 | |||
221 | if mode == 'latex': |
|
221 | if mode == 'latex': | |
222 | print(self.format_latex(magic_docs)) |
|
222 | print(self.format_latex(magic_docs)) | |
223 | return |
|
223 | return | |
224 | else: |
|
224 | else: | |
225 | magic_docs = format_screen(magic_docs) |
|
225 | magic_docs = format_screen(magic_docs) | |
226 |
|
226 | |||
227 | out = [""" |
|
227 | out = [""" | |
228 | IPython's 'magic' functions |
|
228 | IPython's 'magic' functions | |
229 | =========================== |
|
229 | =========================== | |
230 |
|
230 | |||
231 | The magic function system provides a series of functions which allow you to |
|
231 | The magic function system provides a series of functions which allow you to | |
232 | control the behavior of IPython itself, plus a lot of system-type |
|
232 | control the behavior of IPython itself, plus a lot of system-type | |
233 | features. There are two kinds of magics, line-oriented and cell-oriented. |
|
233 | features. There are two kinds of magics, line-oriented and cell-oriented. | |
234 |
|
234 | |||
235 | Line magics are prefixed with the % character and work much like OS |
|
235 | Line magics are prefixed with the % character and work much like OS | |
236 | command-line calls: they get as an argument the rest of the line, where |
|
236 | command-line calls: they get as an argument the rest of the line, where | |
237 | arguments are passed without parentheses or quotes. For example, this will |
|
237 | arguments are passed without parentheses or quotes. For example, this will | |
238 | time the given statement:: |
|
238 | time the given statement:: | |
239 |
|
239 | |||
240 | %timeit range(1000) |
|
240 | %timeit range(1000) | |
241 |
|
241 | |||
242 | Cell magics are prefixed with a double %%, and they are functions that get as |
|
242 | Cell magics are prefixed with a double %%, and they are functions that get as | |
243 | an argument not only the rest of the line, but also the lines below it in a |
|
243 | an argument not only the rest of the line, but also the lines below it in a | |
244 | separate argument. These magics are called with two arguments: the rest of the |
|
244 | separate argument. These magics are called with two arguments: the rest of the | |
245 | call line and the body of the cell, consisting of the lines below the first. |
|
245 | call line and the body of the cell, consisting of the lines below the first. | |
246 | For example:: |
|
246 | For example:: | |
247 |
|
247 | |||
248 | %%timeit x = numpy.random.randn((100, 100)) |
|
248 | %%timeit x = numpy.random.randn((100, 100)) | |
249 | numpy.linalg.svd(x) |
|
249 | numpy.linalg.svd(x) | |
250 |
|
250 | |||
251 | will time the execution of the numpy svd routine, running the assignment of x |
|
251 | will time the execution of the numpy svd routine, running the assignment of x | |
252 | as part of the setup phase, which is not timed. |
|
252 | as part of the setup phase, which is not timed. | |
253 |
|
253 | |||
254 | In a line-oriented client (the terminal or Qt console IPython), starting a new |
|
254 | In a line-oriented client (the terminal or Qt console IPython), starting a new | |
255 | input with %% will automatically enter cell mode, and IPython will continue |
|
255 | input with %% will automatically enter cell mode, and IPython will continue | |
256 | reading input until a blank line is given. In the notebook, simply type the |
|
256 | reading input until a blank line is given. In the notebook, simply type the | |
257 | whole cell as one entity, but keep in mind that the %% escape can only be at |
|
257 | whole cell as one entity, but keep in mind that the %% escape can only be at | |
258 | the very start of the cell. |
|
258 | the very start of the cell. | |
259 |
|
259 | |||
260 | NOTE: If you have 'automagic' enabled (via the command line option or with the |
|
260 | NOTE: If you have 'automagic' enabled (via the command line option or with the | |
261 | %automagic function), you don't need to type in the % explicitly for line |
|
261 | %automagic function), you don't need to type in the % explicitly for line | |
262 | magics; cell magics always require an explicit '%%' escape. By default, |
|
262 | magics; cell magics always require an explicit '%%' escape. By default, | |
263 | IPython ships with automagic on, so you should only rarely need the % escape. |
|
263 | IPython ships with automagic on, so you should only rarely need the % escape. | |
264 |
|
264 | |||
265 | Example: typing '%cd mydir' (without the quotes) changes your working directory |
|
265 | Example: typing '%cd mydir' (without the quotes) changes your working directory | |
266 | to 'mydir', if it exists. |
|
266 | to 'mydir', if it exists. | |
267 |
|
267 | |||
268 | For a list of the available magic functions, use %lsmagic. For a description |
|
268 | For a list of the available magic functions, use %lsmagic. For a description | |
269 | of any of them, type %magic_name?, e.g. '%cd?'. |
|
269 | of any of them, type %magic_name?, e.g. '%cd?'. | |
270 |
|
270 | |||
271 | Currently the magic system has the following functions:""", |
|
271 | Currently the magic system has the following functions:""", | |
272 | magic_docs, |
|
272 | magic_docs, | |
273 | "Summary of magic functions (from %slsmagic):" % magic_escapes['line'], |
|
273 | "Summary of magic functions (from %slsmagic):" % magic_escapes['line'], | |
274 | str(self.lsmagic()), |
|
274 | str(self.lsmagic()), | |
275 | ] |
|
275 | ] | |
276 | page.page('\n'.join(out)) |
|
276 | page.page('\n'.join(out)) | |
277 |
|
277 | |||
278 |
|
278 | |||
279 | @line_magic |
|
279 | @line_magic | |
280 | def page(self, parameter_s=''): |
|
280 | def page(self, parameter_s=''): | |
281 | """Pretty print the object and display it through a pager. |
|
281 | """Pretty print the object and display it through a pager. | |
282 |
|
282 | |||
283 | %page [options] OBJECT |
|
283 | %page [options] OBJECT | |
284 |
|
284 | |||
285 | If no object is given, use _ (last output). |
|
285 | If no object is given, use _ (last output). | |
286 |
|
286 | |||
287 | Options: |
|
287 | Options: | |
288 |
|
288 | |||
289 | -r: page str(object), don't pretty-print it.""" |
|
289 | -r: page str(object), don't pretty-print it.""" | |
290 |
|
290 | |||
291 | # After a function contributed by Olivier Aubert, slightly modified. |
|
291 | # After a function contributed by Olivier Aubert, slightly modified. | |
292 |
|
292 | |||
293 | # Process options/args |
|
293 | # Process options/args | |
294 | opts, args = self.parse_options(parameter_s, 'r') |
|
294 | opts, args = self.parse_options(parameter_s, 'r') | |
295 | raw = 'r' in opts |
|
295 | raw = 'r' in opts | |
296 |
|
296 | |||
297 | oname = args and args or '_' |
|
297 | oname = args and args or '_' | |
298 | info = self.shell._ofind(oname) |
|
298 | info = self.shell._ofind(oname) | |
299 | if info['found']: |
|
299 | if info['found']: | |
300 | txt = (raw and str or pformat)( info['obj'] ) |
|
300 | txt = (raw and str or pformat)( info['obj'] ) | |
301 | page.page(txt) |
|
301 | page.page(txt) | |
302 | else: |
|
302 | else: | |
303 | print('Object `%s` not found' % oname) |
|
303 | print('Object `%s` not found' % oname) | |
304 |
|
304 | |||
305 | @line_magic |
|
305 | @line_magic | |
306 | def pprint(self, parameter_s=''): |
|
306 | def pprint(self, parameter_s=''): | |
307 | """Toggle pretty printing on/off.""" |
|
307 | """Toggle pretty printing on/off.""" | |
308 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
308 | ptformatter = self.shell.display_formatter.formatters['text/plain'] | |
309 | ptformatter.pprint = bool(1 - ptformatter.pprint) |
|
309 | ptformatter.pprint = bool(1 - ptformatter.pprint) | |
310 | print('Pretty printing has been turned', |
|
310 | print('Pretty printing has been turned', | |
311 | ['OFF','ON'][ptformatter.pprint]) |
|
311 | ['OFF','ON'][ptformatter.pprint]) | |
312 |
|
312 | |||
313 | @line_magic |
|
313 | @line_magic | |
314 | def colors(self, parameter_s=''): |
|
314 | def colors(self, parameter_s=''): | |
315 | """Switch color scheme for prompts, info system and exception handlers. |
|
315 | """Switch color scheme for prompts, info system and exception handlers. | |
316 |
|
316 | |||
317 | Currently implemented schemes: NoColor, Linux, LightBG. |
|
317 | Currently implemented schemes: NoColor, Linux, LightBG. | |
318 |
|
318 | |||
319 | Color scheme names are not case-sensitive. |
|
319 | Color scheme names are not case-sensitive. | |
320 |
|
320 | |||
321 | Examples |
|
321 | Examples | |
322 | -------- |
|
322 | -------- | |
323 | To get a plain black and white terminal:: |
|
323 | To get a plain black and white terminal:: | |
324 |
|
324 | |||
325 | %colors nocolor |
|
325 | %colors nocolor | |
326 | """ |
|
326 | """ | |
327 | def color_switch_err(name): |
|
327 | def color_switch_err(name): | |
328 | warn('Error changing %s color schemes.\n%s' % |
|
328 | warn('Error changing %s color schemes.\n%s' % | |
329 | (name, sys.exc_info()[1]), stacklevel=2) |
|
329 | (name, sys.exc_info()[1]), stacklevel=2) | |
330 |
|
330 | |||
331 |
|
331 | |||
332 | new_scheme = parameter_s.strip() |
|
332 | new_scheme = parameter_s.strip() | |
333 | if not new_scheme: |
|
333 | if not new_scheme: | |
334 | raise UsageError( |
|
334 | raise UsageError( | |
335 | "%colors: you must specify a color scheme. See '%colors?'") |
|
335 | "%colors: you must specify a color scheme. See '%colors?'") | |
336 | # local shortcut |
|
336 | # local shortcut | |
337 | shell = self.shell |
|
337 | shell = self.shell | |
338 |
|
338 | |||
339 | # Set shell colour scheme |
|
339 | # Set shell colour scheme | |
340 | try: |
|
340 | try: | |
341 | shell.colors = new_scheme |
|
341 | shell.colors = new_scheme | |
342 | shell.refresh_style() |
|
342 | shell.refresh_style() | |
343 | except: |
|
343 | except: | |
344 | color_switch_err('shell') |
|
344 | color_switch_err('shell') | |
345 |
|
345 | |||
346 | # Set exception colors |
|
346 | # Set exception colors | |
347 | try: |
|
347 | try: | |
348 | shell.InteractiveTB.set_colors(scheme = new_scheme) |
|
348 | shell.InteractiveTB.set_colors(scheme = new_scheme) | |
349 | shell.SyntaxTB.set_colors(scheme = new_scheme) |
|
349 | shell.SyntaxTB.set_colors(scheme = new_scheme) | |
350 | except: |
|
350 | except: | |
351 | color_switch_err('exception') |
|
351 | color_switch_err('exception') | |
352 |
|
352 | |||
353 | # Set info (for 'object?') colors |
|
353 | # Set info (for 'object?') colors | |
354 | if shell.color_info: |
|
354 | if shell.color_info: | |
355 | try: |
|
355 | try: | |
356 | shell.inspector.set_active_scheme(new_scheme) |
|
356 | shell.inspector.set_active_scheme(new_scheme) | |
357 | except: |
|
357 | except: | |
358 | color_switch_err('object inspector') |
|
358 | color_switch_err('object inspector') | |
359 | else: |
|
359 | else: | |
360 | shell.inspector.set_active_scheme('NoColor') |
|
360 | shell.inspector.set_active_scheme('NoColor') | |
361 |
|
361 | |||
362 | @line_magic |
|
362 | @line_magic | |
363 | def xmode(self, parameter_s=''): |
|
363 | def xmode(self, parameter_s=''): | |
364 | """Switch modes for the exception handlers. |
|
364 | """Switch modes for the exception handlers. | |
365 |
|
365 | |||
366 |
Valid modes: Plain, Context |
|
366 | Valid modes: Plain, Context, Verbose, and Minimal. | |
367 |
|
367 | |||
368 | If called without arguments, acts as a toggle.""" |
|
368 | If called without arguments, acts as a toggle.""" | |
369 |
|
369 | |||
370 | def xmode_switch_err(name): |
|
370 | def xmode_switch_err(name): | |
371 | warn('Error changing %s exception modes.\n%s' % |
|
371 | warn('Error changing %s exception modes.\n%s' % | |
372 | (name,sys.exc_info()[1])) |
|
372 | (name,sys.exc_info()[1])) | |
373 |
|
373 | |||
374 | shell = self.shell |
|
374 | shell = self.shell | |
375 | new_mode = parameter_s.strip().capitalize() |
|
375 | new_mode = parameter_s.strip().capitalize() | |
376 | try: |
|
376 | try: | |
377 | shell.InteractiveTB.set_mode(mode=new_mode) |
|
377 | shell.InteractiveTB.set_mode(mode=new_mode) | |
378 | print('Exception reporting mode:',shell.InteractiveTB.mode) |
|
378 | print('Exception reporting mode:',shell.InteractiveTB.mode) | |
379 | except: |
|
379 | except: | |
380 | xmode_switch_err('user') |
|
380 | xmode_switch_err('user') | |
381 |
|
381 | |||
382 |
|
382 | |||
383 |
|
383 | |||
384 | @line_magic |
|
384 | @line_magic | |
385 | def pip(self, args=''): |
|
385 | def pip(self, args=''): | |
386 | """ |
|
386 | """ | |
387 | Intercept usage of ``pip`` in IPython and direct user to run command outside of IPython. |
|
387 | Intercept usage of ``pip`` in IPython and direct user to run command outside of IPython. | |
388 | """ |
|
388 | """ | |
389 | print(textwrap.dedent(''' |
|
389 | print(textwrap.dedent(''' | |
390 | The following command must be run outside of the IPython shell: |
|
390 | The following command must be run outside of the IPython shell: | |
391 |
|
391 | |||
392 | $ pip {args} |
|
392 | $ pip {args} | |
393 |
|
393 | |||
394 | The Python package manager (pip) can only be used from outside of IPython. |
|
394 | The Python package manager (pip) can only be used from outside of IPython. | |
395 | Please reissue the `pip` command in a separate terminal or command prompt. |
|
395 | Please reissue the `pip` command in a separate terminal or command prompt. | |
396 |
|
396 | |||
397 | See the Python documentation for more information on how to install packages: |
|
397 | See the Python documentation for more information on how to install packages: | |
398 |
|
398 | |||
399 | https://docs.python.org/3/installing/'''.format(args=args))) |
|
399 | https://docs.python.org/3/installing/'''.format(args=args))) | |
400 |
|
400 | |||
401 | @line_magic |
|
401 | @line_magic | |
402 | def quickref(self, arg): |
|
402 | def quickref(self, arg): | |
403 | """ Show a quick reference sheet """ |
|
403 | """ Show a quick reference sheet """ | |
404 | from IPython.core.usage import quick_reference |
|
404 | from IPython.core.usage import quick_reference | |
405 | qr = quick_reference + self._magic_docs(brief=True) |
|
405 | qr = quick_reference + self._magic_docs(brief=True) | |
406 | page.page(qr) |
|
406 | page.page(qr) | |
407 |
|
407 | |||
408 | @line_magic |
|
408 | @line_magic | |
409 | def doctest_mode(self, parameter_s=''): |
|
409 | def doctest_mode(self, parameter_s=''): | |
410 | """Toggle doctest mode on and off. |
|
410 | """Toggle doctest mode on and off. | |
411 |
|
411 | |||
412 | This mode is intended to make IPython behave as much as possible like a |
|
412 | This mode is intended to make IPython behave as much as possible like a | |
413 | plain Python shell, from the perspective of how its prompts, exceptions |
|
413 | plain Python shell, from the perspective of how its prompts, exceptions | |
414 | and output look. This makes it easy to copy and paste parts of a |
|
414 | and output look. This makes it easy to copy and paste parts of a | |
415 | session into doctests. It does so by: |
|
415 | session into doctests. It does so by: | |
416 |
|
416 | |||
417 | - Changing the prompts to the classic ``>>>`` ones. |
|
417 | - Changing the prompts to the classic ``>>>`` ones. | |
418 | - Changing the exception reporting mode to 'Plain'. |
|
418 | - Changing the exception reporting mode to 'Plain'. | |
419 | - Disabling pretty-printing of output. |
|
419 | - Disabling pretty-printing of output. | |
420 |
|
420 | |||
421 | Note that IPython also supports the pasting of code snippets that have |
|
421 | Note that IPython also supports the pasting of code snippets that have | |
422 | leading '>>>' and '...' prompts in them. This means that you can paste |
|
422 | leading '>>>' and '...' prompts in them. This means that you can paste | |
423 | doctests from files or docstrings (even if they have leading |
|
423 | doctests from files or docstrings (even if they have leading | |
424 | whitespace), and the code will execute correctly. You can then use |
|
424 | whitespace), and the code will execute correctly. You can then use | |
425 | '%history -t' to see the translated history; this will give you the |
|
425 | '%history -t' to see the translated history; this will give you the | |
426 | input after removal of all the leading prompts and whitespace, which |
|
426 | input after removal of all the leading prompts and whitespace, which | |
427 | can be pasted back into an editor. |
|
427 | can be pasted back into an editor. | |
428 |
|
428 | |||
429 | With these features, you can switch into this mode easily whenever you |
|
429 | With these features, you can switch into this mode easily whenever you | |
430 | need to do testing and changes to doctests, without having to leave |
|
430 | need to do testing and changes to doctests, without having to leave | |
431 | your existing IPython session. |
|
431 | your existing IPython session. | |
432 | """ |
|
432 | """ | |
433 |
|
433 | |||
434 | # Shorthands |
|
434 | # Shorthands | |
435 | shell = self.shell |
|
435 | shell = self.shell | |
436 | meta = shell.meta |
|
436 | meta = shell.meta | |
437 | disp_formatter = self.shell.display_formatter |
|
437 | disp_formatter = self.shell.display_formatter | |
438 | ptformatter = disp_formatter.formatters['text/plain'] |
|
438 | ptformatter = disp_formatter.formatters['text/plain'] | |
439 | # dstore is a data store kept in the instance metadata bag to track any |
|
439 | # dstore is a data store kept in the instance metadata bag to track any | |
440 | # changes we make, so we can undo them later. |
|
440 | # changes we make, so we can undo them later. | |
441 | dstore = meta.setdefault('doctest_mode',Struct()) |
|
441 | dstore = meta.setdefault('doctest_mode',Struct()) | |
442 | save_dstore = dstore.setdefault |
|
442 | save_dstore = dstore.setdefault | |
443 |
|
443 | |||
444 | # save a few values we'll need to recover later |
|
444 | # save a few values we'll need to recover later | |
445 | mode = save_dstore('mode',False) |
|
445 | mode = save_dstore('mode',False) | |
446 | save_dstore('rc_pprint',ptformatter.pprint) |
|
446 | save_dstore('rc_pprint',ptformatter.pprint) | |
447 | save_dstore('xmode',shell.InteractiveTB.mode) |
|
447 | save_dstore('xmode',shell.InteractiveTB.mode) | |
448 | save_dstore('rc_separate_out',shell.separate_out) |
|
448 | save_dstore('rc_separate_out',shell.separate_out) | |
449 | save_dstore('rc_separate_out2',shell.separate_out2) |
|
449 | save_dstore('rc_separate_out2',shell.separate_out2) | |
450 | save_dstore('rc_separate_in',shell.separate_in) |
|
450 | save_dstore('rc_separate_in',shell.separate_in) | |
451 | save_dstore('rc_active_types',disp_formatter.active_types) |
|
451 | save_dstore('rc_active_types',disp_formatter.active_types) | |
452 |
|
452 | |||
453 | if not mode: |
|
453 | if not mode: | |
454 | # turn on |
|
454 | # turn on | |
455 |
|
455 | |||
456 | # Prompt separators like plain python |
|
456 | # Prompt separators like plain python | |
457 | shell.separate_in = '' |
|
457 | shell.separate_in = '' | |
458 | shell.separate_out = '' |
|
458 | shell.separate_out = '' | |
459 | shell.separate_out2 = '' |
|
459 | shell.separate_out2 = '' | |
460 |
|
460 | |||
461 |
|
461 | |||
462 | ptformatter.pprint = False |
|
462 | ptformatter.pprint = False | |
463 | disp_formatter.active_types = ['text/plain'] |
|
463 | disp_formatter.active_types = ['text/plain'] | |
464 |
|
464 | |||
465 | shell.magic('xmode Plain') |
|
465 | shell.magic('xmode Plain') | |
466 | else: |
|
466 | else: | |
467 | # turn off |
|
467 | # turn off | |
468 | shell.separate_in = dstore.rc_separate_in |
|
468 | shell.separate_in = dstore.rc_separate_in | |
469 |
|
469 | |||
470 | shell.separate_out = dstore.rc_separate_out |
|
470 | shell.separate_out = dstore.rc_separate_out | |
471 | shell.separate_out2 = dstore.rc_separate_out2 |
|
471 | shell.separate_out2 = dstore.rc_separate_out2 | |
472 |
|
472 | |||
473 | ptformatter.pprint = dstore.rc_pprint |
|
473 | ptformatter.pprint = dstore.rc_pprint | |
474 | disp_formatter.active_types = dstore.rc_active_types |
|
474 | disp_formatter.active_types = dstore.rc_active_types | |
475 |
|
475 | |||
476 | shell.magic('xmode ' + dstore.xmode) |
|
476 | shell.magic('xmode ' + dstore.xmode) | |
477 |
|
477 | |||
478 | # mode here is the state before we switch; switch_doctest_mode takes |
|
478 | # mode here is the state before we switch; switch_doctest_mode takes | |
479 | # the mode we're switching to. |
|
479 | # the mode we're switching to. | |
480 | shell.switch_doctest_mode(not mode) |
|
480 | shell.switch_doctest_mode(not mode) | |
481 |
|
481 | |||
482 | # Store new mode and inform |
|
482 | # Store new mode and inform | |
483 | dstore.mode = bool(not mode) |
|
483 | dstore.mode = bool(not mode) | |
484 | mode_label = ['OFF','ON'][dstore.mode] |
|
484 | mode_label = ['OFF','ON'][dstore.mode] | |
485 | print('Doctest mode is:', mode_label) |
|
485 | print('Doctest mode is:', mode_label) | |
486 |
|
486 | |||
487 | @line_magic |
|
487 | @line_magic | |
488 | def gui(self, parameter_s=''): |
|
488 | def gui(self, parameter_s=''): | |
489 | """Enable or disable IPython GUI event loop integration. |
|
489 | """Enable or disable IPython GUI event loop integration. | |
490 |
|
490 | |||
491 | %gui [GUINAME] |
|
491 | %gui [GUINAME] | |
492 |
|
492 | |||
493 | This magic replaces IPython's threaded shells that were activated |
|
493 | This magic replaces IPython's threaded shells that were activated | |
494 | using the (pylab/wthread/etc.) command line flags. GUI toolkits |
|
494 | using the (pylab/wthread/etc.) command line flags. GUI toolkits | |
495 | can now be enabled at runtime and keyboard |
|
495 | can now be enabled at runtime and keyboard | |
496 | interrupts should work without any problems. The following toolkits |
|
496 | interrupts should work without any problems. The following toolkits | |
497 | are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX):: |
|
497 | are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX):: | |
498 |
|
498 | |||
499 | %gui wx # enable wxPython event loop integration |
|
499 | %gui wx # enable wxPython event loop integration | |
500 | %gui qt4|qt # enable PyQt4 event loop integration |
|
500 | %gui qt4|qt # enable PyQt4 event loop integration | |
501 | %gui qt5 # enable PyQt5 event loop integration |
|
501 | %gui qt5 # enable PyQt5 event loop integration | |
502 | %gui gtk # enable PyGTK event loop integration |
|
502 | %gui gtk # enable PyGTK event loop integration | |
503 | %gui gtk3 # enable Gtk3 event loop integration |
|
503 | %gui gtk3 # enable Gtk3 event loop integration | |
504 | %gui tk # enable Tk event loop integration |
|
504 | %gui tk # enable Tk event loop integration | |
505 | %gui osx # enable Cocoa event loop integration |
|
505 | %gui osx # enable Cocoa event loop integration | |
506 | # (requires %matplotlib 1.1) |
|
506 | # (requires %matplotlib 1.1) | |
507 | %gui # disable all event loop integration |
|
507 | %gui # disable all event loop integration | |
508 |
|
508 | |||
509 | WARNING: after any of these has been called you can simply create |
|
509 | WARNING: after any of these has been called you can simply create | |
510 | an application object, but DO NOT start the event loop yourself, as |
|
510 | an application object, but DO NOT start the event loop yourself, as | |
511 | we have already handled that. |
|
511 | we have already handled that. | |
512 | """ |
|
512 | """ | |
513 | opts, arg = self.parse_options(parameter_s, '') |
|
513 | opts, arg = self.parse_options(parameter_s, '') | |
514 | if arg=='': arg = None |
|
514 | if arg=='': arg = None | |
515 | try: |
|
515 | try: | |
516 | return self.shell.enable_gui(arg) |
|
516 | return self.shell.enable_gui(arg) | |
517 | except Exception as e: |
|
517 | except Exception as e: | |
518 | # print simple error message, rather than traceback if we can't |
|
518 | # print simple error message, rather than traceback if we can't | |
519 | # hook up the GUI |
|
519 | # hook up the GUI | |
520 | error(str(e)) |
|
520 | error(str(e)) | |
521 |
|
521 | |||
522 | @skip_doctest |
|
522 | @skip_doctest | |
523 | @line_magic |
|
523 | @line_magic | |
524 | def precision(self, s=''): |
|
524 | def precision(self, s=''): | |
525 | """Set floating point precision for pretty printing. |
|
525 | """Set floating point precision for pretty printing. | |
526 |
|
526 | |||
527 | Can set either integer precision or a format string. |
|
527 | Can set either integer precision or a format string. | |
528 |
|
528 | |||
529 | If numpy has been imported and precision is an int, |
|
529 | If numpy has been imported and precision is an int, | |
530 | numpy display precision will also be set, via ``numpy.set_printoptions``. |
|
530 | numpy display precision will also be set, via ``numpy.set_printoptions``. | |
531 |
|
531 | |||
532 | If no argument is given, defaults will be restored. |
|
532 | If no argument is given, defaults will be restored. | |
533 |
|
533 | |||
534 | Examples |
|
534 | Examples | |
535 | -------- |
|
535 | -------- | |
536 | :: |
|
536 | :: | |
537 |
|
537 | |||
538 | In [1]: from math import pi |
|
538 | In [1]: from math import pi | |
539 |
|
539 | |||
540 | In [2]: %precision 3 |
|
540 | In [2]: %precision 3 | |
541 | Out[2]: u'%.3f' |
|
541 | Out[2]: u'%.3f' | |
542 |
|
542 | |||
543 | In [3]: pi |
|
543 | In [3]: pi | |
544 | Out[3]: 3.142 |
|
544 | Out[3]: 3.142 | |
545 |
|
545 | |||
546 | In [4]: %precision %i |
|
546 | In [4]: %precision %i | |
547 | Out[4]: u'%i' |
|
547 | Out[4]: u'%i' | |
548 |
|
548 | |||
549 | In [5]: pi |
|
549 | In [5]: pi | |
550 | Out[5]: 3 |
|
550 | Out[5]: 3 | |
551 |
|
551 | |||
552 | In [6]: %precision %e |
|
552 | In [6]: %precision %e | |
553 | Out[6]: u'%e' |
|
553 | Out[6]: u'%e' | |
554 |
|
554 | |||
555 | In [7]: pi**10 |
|
555 | In [7]: pi**10 | |
556 | Out[7]: 9.364805e+04 |
|
556 | Out[7]: 9.364805e+04 | |
557 |
|
557 | |||
558 | In [8]: %precision |
|
558 | In [8]: %precision | |
559 | Out[8]: u'%r' |
|
559 | Out[8]: u'%r' | |
560 |
|
560 | |||
561 | In [9]: pi**10 |
|
561 | In [9]: pi**10 | |
562 | Out[9]: 93648.047476082982 |
|
562 | Out[9]: 93648.047476082982 | |
563 | """ |
|
563 | """ | |
564 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
564 | ptformatter = self.shell.display_formatter.formatters['text/plain'] | |
565 | ptformatter.float_precision = s |
|
565 | ptformatter.float_precision = s | |
566 | return ptformatter.float_format |
|
566 | return ptformatter.float_format | |
567 |
|
567 | |||
568 | @magic_arguments.magic_arguments() |
|
568 | @magic_arguments.magic_arguments() | |
569 | @magic_arguments.argument( |
|
569 | @magic_arguments.argument( | |
570 | '-e', '--export', action='store_true', default=False, |
|
570 | '-e', '--export', action='store_true', default=False, | |
571 | help=argparse.SUPPRESS |
|
571 | help=argparse.SUPPRESS | |
572 | ) |
|
572 | ) | |
573 | @magic_arguments.argument( |
|
573 | @magic_arguments.argument( | |
574 | 'filename', type=str, |
|
574 | 'filename', type=str, | |
575 | help='Notebook name or filename' |
|
575 | help='Notebook name or filename' | |
576 | ) |
|
576 | ) | |
577 | @line_magic |
|
577 | @line_magic | |
578 | def notebook(self, s): |
|
578 | def notebook(self, s): | |
579 | """Export and convert IPython notebooks. |
|
579 | """Export and convert IPython notebooks. | |
580 |
|
580 | |||
581 | This function can export the current IPython history to a notebook file. |
|
581 | This function can export the current IPython history to a notebook file. | |
582 | For example, to export the history to "foo.ipynb" do "%notebook foo.ipynb". |
|
582 | For example, to export the history to "foo.ipynb" do "%notebook foo.ipynb". | |
583 |
|
583 | |||
584 | The -e or --export flag is deprecated in IPython 5.2, and will be |
|
584 | The -e or --export flag is deprecated in IPython 5.2, and will be | |
585 | removed in the future. |
|
585 | removed in the future. | |
586 | """ |
|
586 | """ | |
587 | args = magic_arguments.parse_argstring(self.notebook, s) |
|
587 | args = magic_arguments.parse_argstring(self.notebook, s) | |
588 |
|
588 | |||
589 | from nbformat import write, v4 |
|
589 | from nbformat import write, v4 | |
590 |
|
590 | |||
591 | cells = [] |
|
591 | cells = [] | |
592 | hist = list(self.shell.history_manager.get_range()) |
|
592 | hist = list(self.shell.history_manager.get_range()) | |
593 | if(len(hist)<=1): |
|
593 | if(len(hist)<=1): | |
594 | raise ValueError('History is empty, cannot export') |
|
594 | raise ValueError('History is empty, cannot export') | |
595 | for session, execution_count, source in hist[:-1]: |
|
595 | for session, execution_count, source in hist[:-1]: | |
596 | cells.append(v4.new_code_cell( |
|
596 | cells.append(v4.new_code_cell( | |
597 | execution_count=execution_count, |
|
597 | execution_count=execution_count, | |
598 | source=source |
|
598 | source=source | |
599 | )) |
|
599 | )) | |
600 | nb = v4.new_notebook(cells=cells) |
|
600 | nb = v4.new_notebook(cells=cells) | |
601 | with io.open(args.filename, 'w', encoding='utf-8') as f: |
|
601 | with io.open(args.filename, 'w', encoding='utf-8') as f: | |
602 | write(nb, f, version=4) |
|
602 | write(nb, f, version=4) | |
603 |
|
603 | |||
604 | @magics_class |
|
604 | @magics_class | |
605 | class AsyncMagics(BasicMagics): |
|
605 | class AsyncMagics(BasicMagics): | |
606 |
|
606 | |||
607 | @line_magic |
|
607 | @line_magic | |
608 | def autoawait(self, parameter_s): |
|
608 | def autoawait(self, parameter_s): | |
609 | """ |
|
609 | """ | |
610 | Allow to change the status of the autoawait option. |
|
610 | Allow to change the status of the autoawait option. | |
611 |
|
611 | |||
612 | This allow you to set a specific asynchronous code runner. |
|
612 | This allow you to set a specific asynchronous code runner. | |
613 |
|
613 | |||
614 | If no value is passed, print the currently used asynchronous integration |
|
614 | If no value is passed, print the currently used asynchronous integration | |
615 | and whether it is activated. |
|
615 | and whether it is activated. | |
616 |
|
616 | |||
617 | It can take a number of value evaluated in the following order: |
|
617 | It can take a number of value evaluated in the following order: | |
618 |
|
618 | |||
619 | - False/false/off deactivate autoawait integration |
|
619 | - False/false/off deactivate autoawait integration | |
620 | - True/true/on activate autoawait integration using configured default |
|
620 | - True/true/on activate autoawait integration using configured default | |
621 | loop |
|
621 | loop | |
622 | - asyncio/curio/trio activate autoawait integration and use integration |
|
622 | - asyncio/curio/trio activate autoawait integration and use integration | |
623 | with said library. |
|
623 | with said library. | |
624 |
|
624 | |||
625 | - `sync` turn on the pseudo-sync integration (mostly used for |
|
625 | - `sync` turn on the pseudo-sync integration (mostly used for | |
626 | `IPython.embed()` which does not run IPython with a real eventloop and |
|
626 | `IPython.embed()` which does not run IPython with a real eventloop and | |
627 | deactivate running asynchronous code. Turning on Asynchronous code with |
|
627 | deactivate running asynchronous code. Turning on Asynchronous code with | |
628 | the pseudo sync loop is undefined behavior and may lead IPython to crash. |
|
628 | the pseudo sync loop is undefined behavior and may lead IPython to crash. | |
629 |
|
629 | |||
630 | If the passed parameter does not match any of the above and is a python |
|
630 | If the passed parameter does not match any of the above and is a python | |
631 | identifier, get said object from user namespace and set it as the |
|
631 | identifier, get said object from user namespace and set it as the | |
632 | runner, and activate autoawait. |
|
632 | runner, and activate autoawait. | |
633 |
|
633 | |||
634 | If the object is a fully qualified object name, attempt to import it and |
|
634 | If the object is a fully qualified object name, attempt to import it and | |
635 | set it as the runner, and activate autoawait. |
|
635 | set it as the runner, and activate autoawait. | |
636 |
|
636 | |||
637 |
|
637 | |||
638 | The exact behavior of autoawait is experimental and subject to change |
|
638 | The exact behavior of autoawait is experimental and subject to change | |
639 | across version of IPython and Python. |
|
639 | across version of IPython and Python. | |
640 | """ |
|
640 | """ | |
641 |
|
641 | |||
642 | param = parameter_s.strip() |
|
642 | param = parameter_s.strip() | |
643 | d = {True: "on", False: "off"} |
|
643 | d = {True: "on", False: "off"} | |
644 |
|
644 | |||
645 | if not param: |
|
645 | if not param: | |
646 | print("IPython autoawait is `{}`, and set to use `{}`".format( |
|
646 | print("IPython autoawait is `{}`, and set to use `{}`".format( | |
647 | d[self.shell.autoawait], |
|
647 | d[self.shell.autoawait], | |
648 | self.shell.loop_runner |
|
648 | self.shell.loop_runner | |
649 | )) |
|
649 | )) | |
650 | return None |
|
650 | return None | |
651 |
|
651 | |||
652 | if param.lower() in ('false', 'off'): |
|
652 | if param.lower() in ('false', 'off'): | |
653 | self.shell.autoawait = False |
|
653 | self.shell.autoawait = False | |
654 | return None |
|
654 | return None | |
655 | if param.lower() in ('true', 'on'): |
|
655 | if param.lower() in ('true', 'on'): | |
656 | self.shell.autoawait = True |
|
656 | self.shell.autoawait = True | |
657 | return None |
|
657 | return None | |
658 |
|
658 | |||
659 | if param in self.shell.loop_runner_map: |
|
659 | if param in self.shell.loop_runner_map: | |
660 | self.shell.loop_runner, self.shell.autoawait = self.shell.loop_runner_map[param] |
|
660 | self.shell.loop_runner, self.shell.autoawait = self.shell.loop_runner_map[param] | |
661 | return None |
|
661 | return None | |
662 |
|
662 | |||
663 | if param in self.shell.user_ns : |
|
663 | if param in self.shell.user_ns : | |
664 | self.shell.loop_runner = self.shell.user_ns[param] |
|
664 | self.shell.loop_runner = self.shell.user_ns[param] | |
665 | self.shell.autoawait = True |
|
665 | self.shell.autoawait = True | |
666 | return None |
|
666 | return None | |
667 |
|
667 | |||
668 | runner = import_item(param) |
|
668 | runner = import_item(param) | |
669 |
|
669 | |||
670 | self.shell.loop_runner = runner |
|
670 | self.shell.loop_runner = runner | |
671 | self.shell.autoawait = True |
|
671 | self.shell.autoawait = True |
@@ -1,400 +1,403 b'' | |||||
1 | # encoding: utf-8 |
|
1 | # encoding: utf-8 | |
2 | """Tests for IPython.core.ultratb |
|
2 | """Tests for IPython.core.ultratb | |
3 | """ |
|
3 | """ | |
4 | import io |
|
4 | import io | |
5 | import logging |
|
5 | import logging | |
6 | import sys |
|
6 | import sys | |
7 | import os.path |
|
7 | import os.path | |
8 | from textwrap import dedent |
|
8 | from textwrap import dedent | |
9 | import traceback |
|
9 | import traceback | |
10 | import unittest |
|
10 | import unittest | |
11 | from unittest import mock |
|
11 | from unittest import mock | |
12 |
|
12 | |||
13 | from ..ultratb import ColorTB, VerboseTB, find_recursion |
|
13 | from ..ultratb import ColorTB, VerboseTB, find_recursion | |
14 |
|
14 | |||
15 |
|
15 | |||
16 | from IPython.testing import tools as tt |
|
16 | from IPython.testing import tools as tt | |
17 | from IPython.testing.decorators import onlyif_unicode_paths |
|
17 | from IPython.testing.decorators import onlyif_unicode_paths | |
18 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
18 | from IPython.utils.syspathcontext import prepended_to_syspath | |
19 | from IPython.utils.tempdir import TemporaryDirectory |
|
19 | from IPython.utils.tempdir import TemporaryDirectory | |
20 |
|
20 | |||
21 | ip = get_ipython() |
|
21 | ip = get_ipython() | |
22 |
|
22 | |||
23 | file_1 = """1 |
|
23 | file_1 = """1 | |
24 | 2 |
|
24 | 2 | |
25 | 3 |
|
25 | 3 | |
26 | def f(): |
|
26 | def f(): | |
27 | 1/0 |
|
27 | 1/0 | |
28 | """ |
|
28 | """ | |
29 |
|
29 | |||
30 | file_2 = """def f(): |
|
30 | file_2 = """def f(): | |
31 | 1/0 |
|
31 | 1/0 | |
32 | """ |
|
32 | """ | |
33 |
|
33 | |||
34 | class ChangedPyFileTest(unittest.TestCase): |
|
34 | class ChangedPyFileTest(unittest.TestCase): | |
35 | def test_changing_py_file(self): |
|
35 | def test_changing_py_file(self): | |
36 | """Traceback produced if the line where the error occurred is missing? |
|
36 | """Traceback produced if the line where the error occurred is missing? | |
37 |
|
37 | |||
38 | https://github.com/ipython/ipython/issues/1456 |
|
38 | https://github.com/ipython/ipython/issues/1456 | |
39 | """ |
|
39 | """ | |
40 | with TemporaryDirectory() as td: |
|
40 | with TemporaryDirectory() as td: | |
41 | fname = os.path.join(td, "foo.py") |
|
41 | fname = os.path.join(td, "foo.py") | |
42 | with open(fname, "w") as f: |
|
42 | with open(fname, "w") as f: | |
43 | f.write(file_1) |
|
43 | f.write(file_1) | |
44 |
|
44 | |||
45 | with prepended_to_syspath(td): |
|
45 | with prepended_to_syspath(td): | |
46 | ip.run_cell("import foo") |
|
46 | ip.run_cell("import foo") | |
47 |
|
47 | |||
48 | with tt.AssertPrints("ZeroDivisionError"): |
|
48 | with tt.AssertPrints("ZeroDivisionError"): | |
49 | ip.run_cell("foo.f()") |
|
49 | ip.run_cell("foo.f()") | |
50 |
|
50 | |||
51 | # Make the file shorter, so the line of the error is missing. |
|
51 | # Make the file shorter, so the line of the error is missing. | |
52 | with open(fname, "w") as f: |
|
52 | with open(fname, "w") as f: | |
53 | f.write(file_2) |
|
53 | f.write(file_2) | |
54 |
|
54 | |||
55 | # For some reason, this was failing on the *second* call after |
|
55 | # For some reason, this was failing on the *second* call after | |
56 | # changing the file, so we call f() twice. |
|
56 | # changing the file, so we call f() twice. | |
57 | with tt.AssertNotPrints("Internal Python error", channel='stderr'): |
|
57 | with tt.AssertNotPrints("Internal Python error", channel='stderr'): | |
58 | with tt.AssertPrints("ZeroDivisionError"): |
|
58 | with tt.AssertPrints("ZeroDivisionError"): | |
59 | ip.run_cell("foo.f()") |
|
59 | ip.run_cell("foo.f()") | |
60 | with tt.AssertPrints("ZeroDivisionError"): |
|
60 | with tt.AssertPrints("ZeroDivisionError"): | |
61 | ip.run_cell("foo.f()") |
|
61 | ip.run_cell("foo.f()") | |
62 |
|
62 | |||
63 | iso_8859_5_file = u'''# coding: iso-8859-5 |
|
63 | iso_8859_5_file = u'''# coding: iso-8859-5 | |
64 |
|
64 | |||
65 | def fail(): |
|
65 | def fail(): | |
66 | """Π΄Π±ΠΠ""" |
|
66 | """Π΄Π±ΠΠ""" | |
67 | 1/0 # Π΄Π±ΠΠ |
|
67 | 1/0 # Π΄Π±ΠΠ | |
68 | ''' |
|
68 | ''' | |
69 |
|
69 | |||
70 | class NonAsciiTest(unittest.TestCase): |
|
70 | class NonAsciiTest(unittest.TestCase): | |
71 | @onlyif_unicode_paths |
|
71 | @onlyif_unicode_paths | |
72 | def test_nonascii_path(self): |
|
72 | def test_nonascii_path(self): | |
73 | # Non-ascii directory name as well. |
|
73 | # Non-ascii directory name as well. | |
74 | with TemporaryDirectory(suffix=u'Γ©') as td: |
|
74 | with TemporaryDirectory(suffix=u'Γ©') as td: | |
75 | fname = os.path.join(td, u"fooΓ©.py") |
|
75 | fname = os.path.join(td, u"fooΓ©.py") | |
76 | with open(fname, "w") as f: |
|
76 | with open(fname, "w") as f: | |
77 | f.write(file_1) |
|
77 | f.write(file_1) | |
78 |
|
78 | |||
79 | with prepended_to_syspath(td): |
|
79 | with prepended_to_syspath(td): | |
80 | ip.run_cell("import foo") |
|
80 | ip.run_cell("import foo") | |
81 |
|
81 | |||
82 | with tt.AssertPrints("ZeroDivisionError"): |
|
82 | with tt.AssertPrints("ZeroDivisionError"): | |
83 | ip.run_cell("foo.f()") |
|
83 | ip.run_cell("foo.f()") | |
84 |
|
84 | |||
85 | def test_iso8859_5(self): |
|
85 | def test_iso8859_5(self): | |
86 | with TemporaryDirectory() as td: |
|
86 | with TemporaryDirectory() as td: | |
87 | fname = os.path.join(td, 'dfghjkl.py') |
|
87 | fname = os.path.join(td, 'dfghjkl.py') | |
88 |
|
88 | |||
89 | with io.open(fname, 'w', encoding='iso-8859-5') as f: |
|
89 | with io.open(fname, 'w', encoding='iso-8859-5') as f: | |
90 | f.write(iso_8859_5_file) |
|
90 | f.write(iso_8859_5_file) | |
91 |
|
91 | |||
92 | with prepended_to_syspath(td): |
|
92 | with prepended_to_syspath(td): | |
93 | ip.run_cell("from dfghjkl import fail") |
|
93 | ip.run_cell("from dfghjkl import fail") | |
94 |
|
94 | |||
95 | with tt.AssertPrints("ZeroDivisionError"): |
|
95 | with tt.AssertPrints("ZeroDivisionError"): | |
96 | with tt.AssertPrints(u'Π΄Π±ΠΠ', suppress=False): |
|
96 | with tt.AssertPrints(u'Π΄Π±ΠΠ', suppress=False): | |
97 | ip.run_cell('fail()') |
|
97 | ip.run_cell('fail()') | |
98 |
|
98 | |||
99 | def test_nonascii_msg(self): |
|
99 | def test_nonascii_msg(self): | |
100 | cell = u"raise Exception('Γ©')" |
|
100 | cell = u"raise Exception('Γ©')" | |
101 | expected = u"Exception('Γ©')" |
|
101 | expected = u"Exception('Γ©')" | |
102 | ip.run_cell("%xmode plain") |
|
102 | ip.run_cell("%xmode plain") | |
103 | with tt.AssertPrints(expected): |
|
103 | with tt.AssertPrints(expected): | |
104 | ip.run_cell(cell) |
|
104 | ip.run_cell(cell) | |
105 |
|
105 | |||
106 | ip.run_cell("%xmode verbose") |
|
106 | ip.run_cell("%xmode verbose") | |
107 | with tt.AssertPrints(expected): |
|
107 | with tt.AssertPrints(expected): | |
108 | ip.run_cell(cell) |
|
108 | ip.run_cell(cell) | |
109 |
|
109 | |||
110 | ip.run_cell("%xmode context") |
|
110 | ip.run_cell("%xmode context") | |
111 | with tt.AssertPrints(expected): |
|
111 | with tt.AssertPrints(expected): | |
112 | ip.run_cell(cell) |
|
112 | ip.run_cell(cell) | |
113 |
|
113 | |||
|
114 | ip.run_cell("%xmode minimal") | |||
|
115 | with tt.AssertPrints(u"Exception: Γ©"): | |||
|
116 | ip.run_cell(cell) | |||
114 |
|
117 | |||
115 | class NestedGenExprTestCase(unittest.TestCase): |
|
118 | class NestedGenExprTestCase(unittest.TestCase): | |
116 | """ |
|
119 | """ | |
117 | Regression test for the following issues: |
|
120 | Regression test for the following issues: | |
118 | https://github.com/ipython/ipython/issues/8293 |
|
121 | https://github.com/ipython/ipython/issues/8293 | |
119 | https://github.com/ipython/ipython/issues/8205 |
|
122 | https://github.com/ipython/ipython/issues/8205 | |
120 | """ |
|
123 | """ | |
121 | def test_nested_genexpr(self): |
|
124 | def test_nested_genexpr(self): | |
122 | code = dedent( |
|
125 | code = dedent( | |
123 | """\ |
|
126 | """\ | |
124 | class SpecificException(Exception): |
|
127 | class SpecificException(Exception): | |
125 | pass |
|
128 | pass | |
126 |
|
129 | |||
127 | def foo(x): |
|
130 | def foo(x): | |
128 | raise SpecificException("Success!") |
|
131 | raise SpecificException("Success!") | |
129 |
|
132 | |||
130 | sum(sum(foo(x) for _ in [0]) for x in [0]) |
|
133 | sum(sum(foo(x) for _ in [0]) for x in [0]) | |
131 | """ |
|
134 | """ | |
132 | ) |
|
135 | ) | |
133 | with tt.AssertPrints('SpecificException: Success!', suppress=False): |
|
136 | with tt.AssertPrints('SpecificException: Success!', suppress=False): | |
134 | ip.run_cell(code) |
|
137 | ip.run_cell(code) | |
135 |
|
138 | |||
136 |
|
139 | |||
137 | indentationerror_file = """if True: |
|
140 | indentationerror_file = """if True: | |
138 | zoon() |
|
141 | zoon() | |
139 | """ |
|
142 | """ | |
140 |
|
143 | |||
141 | class IndentationErrorTest(unittest.TestCase): |
|
144 | class IndentationErrorTest(unittest.TestCase): | |
142 | def test_indentationerror_shows_line(self): |
|
145 | def test_indentationerror_shows_line(self): | |
143 | # See issue gh-2398 |
|
146 | # See issue gh-2398 | |
144 | with tt.AssertPrints("IndentationError"): |
|
147 | with tt.AssertPrints("IndentationError"): | |
145 | with tt.AssertPrints("zoon()", suppress=False): |
|
148 | with tt.AssertPrints("zoon()", suppress=False): | |
146 | ip.run_cell(indentationerror_file) |
|
149 | ip.run_cell(indentationerror_file) | |
147 |
|
150 | |||
148 | with TemporaryDirectory() as td: |
|
151 | with TemporaryDirectory() as td: | |
149 | fname = os.path.join(td, "foo.py") |
|
152 | fname = os.path.join(td, "foo.py") | |
150 | with open(fname, "w") as f: |
|
153 | with open(fname, "w") as f: | |
151 | f.write(indentationerror_file) |
|
154 | f.write(indentationerror_file) | |
152 |
|
155 | |||
153 | with tt.AssertPrints("IndentationError"): |
|
156 | with tt.AssertPrints("IndentationError"): | |
154 | with tt.AssertPrints("zoon()", suppress=False): |
|
157 | with tt.AssertPrints("zoon()", suppress=False): | |
155 | ip.magic('run %s' % fname) |
|
158 | ip.magic('run %s' % fname) | |
156 |
|
159 | |||
157 | se_file_1 = """1 |
|
160 | se_file_1 = """1 | |
158 | 2 |
|
161 | 2 | |
159 | 7/ |
|
162 | 7/ | |
160 | """ |
|
163 | """ | |
161 |
|
164 | |||
162 | se_file_2 = """7/ |
|
165 | se_file_2 = """7/ | |
163 | """ |
|
166 | """ | |
164 |
|
167 | |||
165 | class SyntaxErrorTest(unittest.TestCase): |
|
168 | class SyntaxErrorTest(unittest.TestCase): | |
166 | def test_syntaxerror_without_lineno(self): |
|
169 | def test_syntaxerror_without_lineno(self): | |
167 | with tt.AssertNotPrints("TypeError"): |
|
170 | with tt.AssertNotPrints("TypeError"): | |
168 | with tt.AssertPrints("line unknown"): |
|
171 | with tt.AssertPrints("line unknown"): | |
169 | ip.run_cell("raise SyntaxError()") |
|
172 | ip.run_cell("raise SyntaxError()") | |
170 |
|
173 | |||
171 | def test_syntaxerror_no_stacktrace_at_compile_time(self): |
|
174 | def test_syntaxerror_no_stacktrace_at_compile_time(self): | |
172 | syntax_error_at_compile_time = """ |
|
175 | syntax_error_at_compile_time = """ | |
173 | def foo(): |
|
176 | def foo(): | |
174 | .. |
|
177 | .. | |
175 | """ |
|
178 | """ | |
176 | with tt.AssertPrints("SyntaxError"): |
|
179 | with tt.AssertPrints("SyntaxError"): | |
177 | ip.run_cell(syntax_error_at_compile_time) |
|
180 | ip.run_cell(syntax_error_at_compile_time) | |
178 |
|
181 | |||
179 | with tt.AssertNotPrints("foo()"): |
|
182 | with tt.AssertNotPrints("foo()"): | |
180 | ip.run_cell(syntax_error_at_compile_time) |
|
183 | ip.run_cell(syntax_error_at_compile_time) | |
181 |
|
184 | |||
182 | def test_syntaxerror_stacktrace_when_running_compiled_code(self): |
|
185 | def test_syntaxerror_stacktrace_when_running_compiled_code(self): | |
183 | syntax_error_at_runtime = """ |
|
186 | syntax_error_at_runtime = """ | |
184 | def foo(): |
|
187 | def foo(): | |
185 | eval("..") |
|
188 | eval("..") | |
186 |
|
189 | |||
187 | def bar(): |
|
190 | def bar(): | |
188 | foo() |
|
191 | foo() | |
189 |
|
192 | |||
190 | bar() |
|
193 | bar() | |
191 | """ |
|
194 | """ | |
192 | with tt.AssertPrints("SyntaxError"): |
|
195 | with tt.AssertPrints("SyntaxError"): | |
193 | ip.run_cell(syntax_error_at_runtime) |
|
196 | ip.run_cell(syntax_error_at_runtime) | |
194 | # Assert syntax error during runtime generate stacktrace |
|
197 | # Assert syntax error during runtime generate stacktrace | |
195 | with tt.AssertPrints(["foo()", "bar()"]): |
|
198 | with tt.AssertPrints(["foo()", "bar()"]): | |
196 | ip.run_cell(syntax_error_at_runtime) |
|
199 | ip.run_cell(syntax_error_at_runtime) | |
197 |
|
200 | |||
198 | def test_changing_py_file(self): |
|
201 | def test_changing_py_file(self): | |
199 | with TemporaryDirectory() as td: |
|
202 | with TemporaryDirectory() as td: | |
200 | fname = os.path.join(td, "foo.py") |
|
203 | fname = os.path.join(td, "foo.py") | |
201 | with open(fname, 'w') as f: |
|
204 | with open(fname, 'w') as f: | |
202 | f.write(se_file_1) |
|
205 | f.write(se_file_1) | |
203 |
|
206 | |||
204 | with tt.AssertPrints(["7/", "SyntaxError"]): |
|
207 | with tt.AssertPrints(["7/", "SyntaxError"]): | |
205 | ip.magic("run " + fname) |
|
208 | ip.magic("run " + fname) | |
206 |
|
209 | |||
207 | # Modify the file |
|
210 | # Modify the file | |
208 | with open(fname, 'w') as f: |
|
211 | with open(fname, 'w') as f: | |
209 | f.write(se_file_2) |
|
212 | f.write(se_file_2) | |
210 |
|
213 | |||
211 | # The SyntaxError should point to the correct line |
|
214 | # The SyntaxError should point to the correct line | |
212 | with tt.AssertPrints(["7/", "SyntaxError"]): |
|
215 | with tt.AssertPrints(["7/", "SyntaxError"]): | |
213 | ip.magic("run " + fname) |
|
216 | ip.magic("run " + fname) | |
214 |
|
217 | |||
215 | def test_non_syntaxerror(self): |
|
218 | def test_non_syntaxerror(self): | |
216 | # SyntaxTB may be called with an error other than a SyntaxError |
|
219 | # SyntaxTB may be called with an error other than a SyntaxError | |
217 | # See e.g. gh-4361 |
|
220 | # See e.g. gh-4361 | |
218 | try: |
|
221 | try: | |
219 | raise ValueError('QWERTY') |
|
222 | raise ValueError('QWERTY') | |
220 | except ValueError: |
|
223 | except ValueError: | |
221 | with tt.AssertPrints('QWERTY'): |
|
224 | with tt.AssertPrints('QWERTY'): | |
222 | ip.showsyntaxerror() |
|
225 | ip.showsyntaxerror() | |
223 |
|
226 | |||
224 |
|
227 | |||
225 | class Python3ChainedExceptionsTest(unittest.TestCase): |
|
228 | class Python3ChainedExceptionsTest(unittest.TestCase): | |
226 | DIRECT_CAUSE_ERROR_CODE = """ |
|
229 | DIRECT_CAUSE_ERROR_CODE = """ | |
227 | try: |
|
230 | try: | |
228 | x = 1 + 2 |
|
231 | x = 1 + 2 | |
229 | print(not_defined_here) |
|
232 | print(not_defined_here) | |
230 | except Exception as e: |
|
233 | except Exception as e: | |
231 | x += 55 |
|
234 | x += 55 | |
232 | x - 1 |
|
235 | x - 1 | |
233 | y = {} |
|
236 | y = {} | |
234 | raise KeyError('uh') from e |
|
237 | raise KeyError('uh') from e | |
235 | """ |
|
238 | """ | |
236 |
|
239 | |||
237 | EXCEPTION_DURING_HANDLING_CODE = """ |
|
240 | EXCEPTION_DURING_HANDLING_CODE = """ | |
238 | try: |
|
241 | try: | |
239 | x = 1 + 2 |
|
242 | x = 1 + 2 | |
240 | print(not_defined_here) |
|
243 | print(not_defined_here) | |
241 | except Exception as e: |
|
244 | except Exception as e: | |
242 | x += 55 |
|
245 | x += 55 | |
243 | x - 1 |
|
246 | x - 1 | |
244 | y = {} |
|
247 | y = {} | |
245 | raise KeyError('uh') |
|
248 | raise KeyError('uh') | |
246 | """ |
|
249 | """ | |
247 |
|
250 | |||
248 | SUPPRESS_CHAINING_CODE = """ |
|
251 | SUPPRESS_CHAINING_CODE = """ | |
249 | try: |
|
252 | try: | |
250 | 1/0 |
|
253 | 1/0 | |
251 | except Exception: |
|
254 | except Exception: | |
252 | raise ValueError("Yikes") from None |
|
255 | raise ValueError("Yikes") from None | |
253 | """ |
|
256 | """ | |
254 |
|
257 | |||
255 | def test_direct_cause_error(self): |
|
258 | def test_direct_cause_error(self): | |
256 | with tt.AssertPrints(["KeyError", "NameError", "direct cause"]): |
|
259 | with tt.AssertPrints(["KeyError", "NameError", "direct cause"]): | |
257 | ip.run_cell(self.DIRECT_CAUSE_ERROR_CODE) |
|
260 | ip.run_cell(self.DIRECT_CAUSE_ERROR_CODE) | |
258 |
|
261 | |||
259 | def test_exception_during_handling_error(self): |
|
262 | def test_exception_during_handling_error(self): | |
260 | with tt.AssertPrints(["KeyError", "NameError", "During handling"]): |
|
263 | with tt.AssertPrints(["KeyError", "NameError", "During handling"]): | |
261 | ip.run_cell(self.EXCEPTION_DURING_HANDLING_CODE) |
|
264 | ip.run_cell(self.EXCEPTION_DURING_HANDLING_CODE) | |
262 |
|
265 | |||
263 | def test_suppress_exception_chaining(self): |
|
266 | def test_suppress_exception_chaining(self): | |
264 | with tt.AssertNotPrints("ZeroDivisionError"), \ |
|
267 | with tt.AssertNotPrints("ZeroDivisionError"), \ | |
265 | tt.AssertPrints("ValueError", suppress=False): |
|
268 | tt.AssertPrints("ValueError", suppress=False): | |
266 | ip.run_cell(self.SUPPRESS_CHAINING_CODE) |
|
269 | ip.run_cell(self.SUPPRESS_CHAINING_CODE) | |
267 |
|
270 | |||
268 |
|
271 | |||
269 | class RecursionTest(unittest.TestCase): |
|
272 | class RecursionTest(unittest.TestCase): | |
270 | DEFINITIONS = """ |
|
273 | DEFINITIONS = """ | |
271 | def non_recurs(): |
|
274 | def non_recurs(): | |
272 | 1/0 |
|
275 | 1/0 | |
273 |
|
276 | |||
274 | def r1(): |
|
277 | def r1(): | |
275 | r1() |
|
278 | r1() | |
276 |
|
279 | |||
277 | def r3a(): |
|
280 | def r3a(): | |
278 | r3b() |
|
281 | r3b() | |
279 |
|
282 | |||
280 | def r3b(): |
|
283 | def r3b(): | |
281 | r3c() |
|
284 | r3c() | |
282 |
|
285 | |||
283 | def r3c(): |
|
286 | def r3c(): | |
284 | r3a() |
|
287 | r3a() | |
285 |
|
288 | |||
286 | def r3o1(): |
|
289 | def r3o1(): | |
287 | r3a() |
|
290 | r3a() | |
288 |
|
291 | |||
289 | def r3o2(): |
|
292 | def r3o2(): | |
290 | r3o1() |
|
293 | r3o1() | |
291 | """ |
|
294 | """ | |
292 | def setUp(self): |
|
295 | def setUp(self): | |
293 | ip.run_cell(self.DEFINITIONS) |
|
296 | ip.run_cell(self.DEFINITIONS) | |
294 |
|
297 | |||
295 | def test_no_recursion(self): |
|
298 | def test_no_recursion(self): | |
296 | with tt.AssertNotPrints("frames repeated"): |
|
299 | with tt.AssertNotPrints("frames repeated"): | |
297 | ip.run_cell("non_recurs()") |
|
300 | ip.run_cell("non_recurs()") | |
298 |
|
301 | |||
299 | def test_recursion_one_frame(self): |
|
302 | def test_recursion_one_frame(self): | |
300 | with tt.AssertPrints("1 frames repeated"): |
|
303 | with tt.AssertPrints("1 frames repeated"): | |
301 | ip.run_cell("r1()") |
|
304 | ip.run_cell("r1()") | |
302 |
|
305 | |||
303 | def test_recursion_three_frames(self): |
|
306 | def test_recursion_three_frames(self): | |
304 | with tt.AssertPrints("3 frames repeated"): |
|
307 | with tt.AssertPrints("3 frames repeated"): | |
305 | ip.run_cell("r3o2()") |
|
308 | ip.run_cell("r3o2()") | |
306 |
|
309 | |||
307 | def test_find_recursion(self): |
|
310 | def test_find_recursion(self): | |
308 | captured = [] |
|
311 | captured = [] | |
309 | def capture_exc(*args, **kwargs): |
|
312 | def capture_exc(*args, **kwargs): | |
310 | captured.append(sys.exc_info()) |
|
313 | captured.append(sys.exc_info()) | |
311 | with mock.patch.object(ip, 'showtraceback', capture_exc): |
|
314 | with mock.patch.object(ip, 'showtraceback', capture_exc): | |
312 | ip.run_cell("r3o2()") |
|
315 | ip.run_cell("r3o2()") | |
313 |
|
316 | |||
314 | self.assertEqual(len(captured), 1) |
|
317 | self.assertEqual(len(captured), 1) | |
315 | etype, evalue, tb = captured[0] |
|
318 | etype, evalue, tb = captured[0] | |
316 | self.assertIn("recursion", str(evalue)) |
|
319 | self.assertIn("recursion", str(evalue)) | |
317 |
|
320 | |||
318 | records = ip.InteractiveTB.get_records(tb, 3, ip.InteractiveTB.tb_offset) |
|
321 | records = ip.InteractiveTB.get_records(tb, 3, ip.InteractiveTB.tb_offset) | |
319 | for r in records[:10]: |
|
322 | for r in records[:10]: | |
320 | print(r[1:4]) |
|
323 | print(r[1:4]) | |
321 |
|
324 | |||
322 | # The outermost frames should be: |
|
325 | # The outermost frames should be: | |
323 | # 0: the 'cell' that was running when the exception came up |
|
326 | # 0: the 'cell' that was running when the exception came up | |
324 | # 1: r3o2() |
|
327 | # 1: r3o2() | |
325 | # 2: r3o1() |
|
328 | # 2: r3o1() | |
326 | # 3: r3a() |
|
329 | # 3: r3a() | |
327 | # Then repeating r3b, r3c, r3a |
|
330 | # Then repeating r3b, r3c, r3a | |
328 | last_unique, repeat_length = find_recursion(etype, evalue, records) |
|
331 | last_unique, repeat_length = find_recursion(etype, evalue, records) | |
329 | self.assertEqual(last_unique, 2) |
|
332 | self.assertEqual(last_unique, 2) | |
330 | self.assertEqual(repeat_length, 3) |
|
333 | self.assertEqual(repeat_length, 3) | |
331 |
|
334 | |||
332 |
|
335 | |||
333 | #---------------------------------------------------------------------------- |
|
336 | #---------------------------------------------------------------------------- | |
334 |
|
337 | |||
335 | # module testing (minimal) |
|
338 | # module testing (minimal) | |
336 | def test_handlers(): |
|
339 | def test_handlers(): | |
337 | def spam(c, d_e): |
|
340 | def spam(c, d_e): | |
338 | (d, e) = d_e |
|
341 | (d, e) = d_e | |
339 | x = c + d |
|
342 | x = c + d | |
340 | y = c * d |
|
343 | y = c * d | |
341 | foo(x, y) |
|
344 | foo(x, y) | |
342 |
|
345 | |||
343 | def foo(a, b, bar=1): |
|
346 | def foo(a, b, bar=1): | |
344 | eggs(a, b + bar) |
|
347 | eggs(a, b + bar) | |
345 |
|
348 | |||
346 | def eggs(f, g, z=globals()): |
|
349 | def eggs(f, g, z=globals()): | |
347 | h = f + g |
|
350 | h = f + g | |
348 | i = f - g |
|
351 | i = f - g | |
349 | return h / i |
|
352 | return h / i | |
350 |
|
353 | |||
351 | buff = io.StringIO() |
|
354 | buff = io.StringIO() | |
352 |
|
355 | |||
353 | buff.write('') |
|
356 | buff.write('') | |
354 | buff.write('*** Before ***') |
|
357 | buff.write('*** Before ***') | |
355 | try: |
|
358 | try: | |
356 | buff.write(spam(1, (2, 3))) |
|
359 | buff.write(spam(1, (2, 3))) | |
357 | except: |
|
360 | except: | |
358 | traceback.print_exc(file=buff) |
|
361 | traceback.print_exc(file=buff) | |
359 |
|
362 | |||
360 | handler = ColorTB(ostream=buff) |
|
363 | handler = ColorTB(ostream=buff) | |
361 | buff.write('*** ColorTB ***') |
|
364 | buff.write('*** ColorTB ***') | |
362 | try: |
|
365 | try: | |
363 | buff.write(spam(1, (2, 3))) |
|
366 | buff.write(spam(1, (2, 3))) | |
364 | except: |
|
367 | except: | |
365 | handler(*sys.exc_info()) |
|
368 | handler(*sys.exc_info()) | |
366 | buff.write('') |
|
369 | buff.write('') | |
367 |
|
370 | |||
368 | handler = VerboseTB(ostream=buff) |
|
371 | handler = VerboseTB(ostream=buff) | |
369 | buff.write('*** VerboseTB ***') |
|
372 | buff.write('*** VerboseTB ***') | |
370 | try: |
|
373 | try: | |
371 | buff.write(spam(1, (2, 3))) |
|
374 | buff.write(spam(1, (2, 3))) | |
372 | except: |
|
375 | except: | |
373 | handler(*sys.exc_info()) |
|
376 | handler(*sys.exc_info()) | |
374 | buff.write('') |
|
377 | buff.write('') | |
375 |
|
378 | |||
376 |
|
379 | |||
377 | class TokenizeFailureTest(unittest.TestCase): |
|
380 | class TokenizeFailureTest(unittest.TestCase): | |
378 | """Tests related to https://github.com/ipython/ipython/issues/6864.""" |
|
381 | """Tests related to https://github.com/ipython/ipython/issues/6864.""" | |
379 |
|
382 | |||
380 | def testLogging(self): |
|
383 | def testLogging(self): | |
381 | message = "An unexpected error occurred while tokenizing input" |
|
384 | message = "An unexpected error occurred while tokenizing input" | |
382 | cell = 'raise ValueError("""a\nb""")' |
|
385 | cell = 'raise ValueError("""a\nb""")' | |
383 |
|
386 | |||
384 | stream = io.StringIO() |
|
387 | stream = io.StringIO() | |
385 | handler = logging.StreamHandler(stream) |
|
388 | handler = logging.StreamHandler(stream) | |
386 | logger = logging.getLogger() |
|
389 | logger = logging.getLogger() | |
387 | loglevel = logger.level |
|
390 | loglevel = logger.level | |
388 | logger.addHandler(handler) |
|
391 | logger.addHandler(handler) | |
389 | self.addCleanup(lambda: logger.removeHandler(handler)) |
|
392 | self.addCleanup(lambda: logger.removeHandler(handler)) | |
390 | self.addCleanup(lambda: logger.setLevel(loglevel)) |
|
393 | self.addCleanup(lambda: logger.setLevel(loglevel)) | |
391 |
|
394 | |||
392 | logger.setLevel(logging.INFO) |
|
395 | logger.setLevel(logging.INFO) | |
393 | with tt.AssertNotPrints(message): |
|
396 | with tt.AssertNotPrints(message): | |
394 | ip.run_cell(cell) |
|
397 | ip.run_cell(cell) | |
395 | self.assertNotIn(message, stream.getvalue()) |
|
398 | self.assertNotIn(message, stream.getvalue()) | |
396 |
|
399 | |||
397 | logger.setLevel(logging.DEBUG) |
|
400 | logger.setLevel(logging.DEBUG) | |
398 | with tt.AssertNotPrints(message): |
|
401 | with tt.AssertNotPrints(message): | |
399 | ip.run_cell(cell) |
|
402 | ip.run_cell(cell) | |
400 | self.assertIn(message, stream.getvalue()) |
|
403 | self.assertIn(message, stream.getvalue()) |
@@ -1,1461 +1,1467 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | Verbose and colourful traceback formatting. |
|
3 | Verbose and colourful traceback formatting. | |
4 |
|
4 | |||
5 | **ColorTB** |
|
5 | **ColorTB** | |
6 |
|
6 | |||
7 | I've always found it a bit hard to visually parse tracebacks in Python. The |
|
7 | I've always found it a bit hard to visually parse tracebacks in Python. The | |
8 | ColorTB class is a solution to that problem. It colors the different parts of a |
|
8 | ColorTB class is a solution to that problem. It colors the different parts of a | |
9 | traceback in a manner similar to what you would expect from a syntax-highlighting |
|
9 | traceback in a manner similar to what you would expect from a syntax-highlighting | |
10 | text editor. |
|
10 | text editor. | |
11 |
|
11 | |||
12 | Installation instructions for ColorTB:: |
|
12 | Installation instructions for ColorTB:: | |
13 |
|
13 | |||
14 | import sys,ultratb |
|
14 | import sys,ultratb | |
15 | sys.excepthook = ultratb.ColorTB() |
|
15 | sys.excepthook = ultratb.ColorTB() | |
16 |
|
16 | |||
17 | **VerboseTB** |
|
17 | **VerboseTB** | |
18 |
|
18 | |||
19 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds |
|
19 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds | |
20 | of useful info when a traceback occurs. Ping originally had it spit out HTML |
|
20 | of useful info when a traceback occurs. Ping originally had it spit out HTML | |
21 | and intended it for CGI programmers, but why should they have all the fun? I |
|
21 | and intended it for CGI programmers, but why should they have all the fun? I | |
22 | altered it to spit out colored text to the terminal. It's a bit overwhelming, |
|
22 | altered it to spit out colored text to the terminal. It's a bit overwhelming, | |
23 | but kind of neat, and maybe useful for long-running programs that you believe |
|
23 | but kind of neat, and maybe useful for long-running programs that you believe | |
24 | are bug-free. If a crash *does* occur in that type of program you want details. |
|
24 | are bug-free. If a crash *does* occur in that type of program you want details. | |
25 | Give it a shot--you'll love it or you'll hate it. |
|
25 | Give it a shot--you'll love it or you'll hate it. | |
26 |
|
26 | |||
27 | .. note:: |
|
27 | .. note:: | |
28 |
|
28 | |||
29 | The Verbose mode prints the variables currently visible where the exception |
|
29 | The Verbose mode prints the variables currently visible where the exception | |
30 | happened (shortening their strings if too long). This can potentially be |
|
30 | happened (shortening their strings if too long). This can potentially be | |
31 | very slow, if you happen to have a huge data structure whose string |
|
31 | very slow, if you happen to have a huge data structure whose string | |
32 | representation is complex to compute. Your computer may appear to freeze for |
|
32 | representation is complex to compute. Your computer may appear to freeze for | |
33 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback |
|
33 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback | |
34 | with Ctrl-C (maybe hitting it more than once). |
|
34 | with Ctrl-C (maybe hitting it more than once). | |
35 |
|
35 | |||
36 | If you encounter this kind of situation often, you may want to use the |
|
36 | If you encounter this kind of situation often, you may want to use the | |
37 | Verbose_novars mode instead of the regular Verbose, which avoids formatting |
|
37 | Verbose_novars mode instead of the regular Verbose, which avoids formatting | |
38 | variables (but otherwise includes the information and context given by |
|
38 | variables (but otherwise includes the information and context given by | |
39 | Verbose). |
|
39 | Verbose). | |
40 |
|
40 | |||
41 | .. note:: |
|
41 | .. note:: | |
42 |
|
42 | |||
43 | The verbose mode print all variables in the stack, which means it can |
|
43 | The verbose mode print all variables in the stack, which means it can | |
44 | potentially leak sensitive information like access keys, or unencryted |
|
44 | potentially leak sensitive information like access keys, or unencryted | |
45 | password. |
|
45 | password. | |
46 |
|
46 | |||
47 | Installation instructions for VerboseTB:: |
|
47 | Installation instructions for VerboseTB:: | |
48 |
|
48 | |||
49 | import sys,ultratb |
|
49 | import sys,ultratb | |
50 | sys.excepthook = ultratb.VerboseTB() |
|
50 | sys.excepthook = ultratb.VerboseTB() | |
51 |
|
51 | |||
52 | Note: Much of the code in this module was lifted verbatim from the standard |
|
52 | Note: Much of the code in this module was lifted verbatim from the standard | |
53 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. |
|
53 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. | |
54 |
|
54 | |||
55 | Color schemes |
|
55 | Color schemes | |
56 | ------------- |
|
56 | ------------- | |
57 |
|
57 | |||
58 | The colors are defined in the class TBTools through the use of the |
|
58 | The colors are defined in the class TBTools through the use of the | |
59 | ColorSchemeTable class. Currently the following exist: |
|
59 | ColorSchemeTable class. Currently the following exist: | |
60 |
|
60 | |||
61 | - NoColor: allows all of this module to be used in any terminal (the color |
|
61 | - NoColor: allows all of this module to be used in any terminal (the color | |
62 | escapes are just dummy blank strings). |
|
62 | escapes are just dummy blank strings). | |
63 |
|
63 | |||
64 | - Linux: is meant to look good in a terminal like the Linux console (black |
|
64 | - Linux: is meant to look good in a terminal like the Linux console (black | |
65 | or very dark background). |
|
65 | or very dark background). | |
66 |
|
66 | |||
67 | - LightBG: similar to Linux but swaps dark/light colors to be more readable |
|
67 | - LightBG: similar to Linux but swaps dark/light colors to be more readable | |
68 | in light background terminals. |
|
68 | in light background terminals. | |
69 |
|
69 | |||
70 | - Neutral: a neutral color scheme that should be readable on both light and |
|
70 | - Neutral: a neutral color scheme that should be readable on both light and | |
71 | dark background |
|
71 | dark background | |
72 |
|
72 | |||
73 | You can implement other color schemes easily, the syntax is fairly |
|
73 | You can implement other color schemes easily, the syntax is fairly | |
74 | self-explanatory. Please send back new schemes you develop to the author for |
|
74 | self-explanatory. Please send back new schemes you develop to the author for | |
75 | possible inclusion in future releases. |
|
75 | possible inclusion in future releases. | |
76 |
|
76 | |||
77 | Inheritance diagram: |
|
77 | Inheritance diagram: | |
78 |
|
78 | |||
79 | .. inheritance-diagram:: IPython.core.ultratb |
|
79 | .. inheritance-diagram:: IPython.core.ultratb | |
80 | :parts: 3 |
|
80 | :parts: 3 | |
81 | """ |
|
81 | """ | |
82 |
|
82 | |||
83 | #***************************************************************************** |
|
83 | #***************************************************************************** | |
84 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> |
|
84 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> | |
85 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> |
|
85 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> | |
86 | # |
|
86 | # | |
87 | # Distributed under the terms of the BSD License. The full license is in |
|
87 | # Distributed under the terms of the BSD License. The full license is in | |
88 | # the file COPYING, distributed as part of this software. |
|
88 | # the file COPYING, distributed as part of this software. | |
89 | #***************************************************************************** |
|
89 | #***************************************************************************** | |
90 |
|
90 | |||
91 |
|
91 | |||
92 | import dis |
|
92 | import dis | |
93 | import inspect |
|
93 | import inspect | |
94 | import keyword |
|
94 | import keyword | |
95 | import linecache |
|
95 | import linecache | |
96 | import os |
|
96 | import os | |
97 | import pydoc |
|
97 | import pydoc | |
98 | import re |
|
98 | import re | |
99 | import sys |
|
99 | import sys | |
100 | import time |
|
100 | import time | |
101 | import tokenize |
|
101 | import tokenize | |
102 | import traceback |
|
102 | import traceback | |
103 |
|
103 | |||
104 | try: # Python 2 |
|
104 | try: # Python 2 | |
105 | generate_tokens = tokenize.generate_tokens |
|
105 | generate_tokens = tokenize.generate_tokens | |
106 | except AttributeError: # Python 3 |
|
106 | except AttributeError: # Python 3 | |
107 | generate_tokens = tokenize.tokenize |
|
107 | generate_tokens = tokenize.tokenize | |
108 |
|
108 | |||
109 | # For purposes of monkeypatching inspect to fix a bug in it. |
|
109 | # For purposes of monkeypatching inspect to fix a bug in it. | |
110 | from inspect import getsourcefile, getfile, getmodule, \ |
|
110 | from inspect import getsourcefile, getfile, getmodule, \ | |
111 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode |
|
111 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode | |
112 |
|
112 | |||
113 | # IPython's own modules |
|
113 | # IPython's own modules | |
114 | from IPython import get_ipython |
|
114 | from IPython import get_ipython | |
115 | from IPython.core import debugger |
|
115 | from IPython.core import debugger | |
116 | from IPython.core.display_trap import DisplayTrap |
|
116 | from IPython.core.display_trap import DisplayTrap | |
117 | from IPython.core.excolors import exception_colors |
|
117 | from IPython.core.excolors import exception_colors | |
118 | from IPython.utils import PyColorize |
|
118 | from IPython.utils import PyColorize | |
119 | from IPython.utils import path as util_path |
|
119 | from IPython.utils import path as util_path | |
120 | from IPython.utils import py3compat |
|
120 | from IPython.utils import py3compat | |
121 | from IPython.utils.data import uniq_stable |
|
121 | from IPython.utils.data import uniq_stable | |
122 | from IPython.utils.terminal import get_terminal_size |
|
122 | from IPython.utils.terminal import get_terminal_size | |
123 |
|
123 | |||
124 | from logging import info, error, debug |
|
124 | from logging import info, error, debug | |
125 |
|
125 | |||
126 | from importlib.util import source_from_cache |
|
126 | from importlib.util import source_from_cache | |
127 |
|
127 | |||
128 | import IPython.utils.colorable as colorable |
|
128 | import IPython.utils.colorable as colorable | |
129 |
|
129 | |||
130 | # Globals |
|
130 | # Globals | |
131 | # amount of space to put line numbers before verbose tracebacks |
|
131 | # amount of space to put line numbers before verbose tracebacks | |
132 | INDENT_SIZE = 8 |
|
132 | INDENT_SIZE = 8 | |
133 |
|
133 | |||
134 | # Default color scheme. This is used, for example, by the traceback |
|
134 | # Default color scheme. This is used, for example, by the traceback | |
135 | # formatter. When running in an actual IPython instance, the user's rc.colors |
|
135 | # formatter. When running in an actual IPython instance, the user's rc.colors | |
136 | # value is used, but having a module global makes this functionality available |
|
136 | # value is used, but having a module global makes this functionality available | |
137 | # to users of ultratb who are NOT running inside ipython. |
|
137 | # to users of ultratb who are NOT running inside ipython. | |
138 | DEFAULT_SCHEME = 'NoColor' |
|
138 | DEFAULT_SCHEME = 'NoColor' | |
139 |
|
139 | |||
140 | # --------------------------------------------------------------------------- |
|
140 | # --------------------------------------------------------------------------- | |
141 | # Code begins |
|
141 | # Code begins | |
142 |
|
142 | |||
143 | # Utility functions |
|
143 | # Utility functions | |
144 | def inspect_error(): |
|
144 | def inspect_error(): | |
145 | """Print a message about internal inspect errors. |
|
145 | """Print a message about internal inspect errors. | |
146 |
|
146 | |||
147 | These are unfortunately quite common.""" |
|
147 | These are unfortunately quite common.""" | |
148 |
|
148 | |||
149 | error('Internal Python error in the inspect module.\n' |
|
149 | error('Internal Python error in the inspect module.\n' | |
150 | 'Below is the traceback from this internal error.\n') |
|
150 | 'Below is the traceback from this internal error.\n') | |
151 |
|
151 | |||
152 |
|
152 | |||
153 | # This function is a monkeypatch we apply to the Python inspect module. We have |
|
153 | # This function is a monkeypatch we apply to the Python inspect module. We have | |
154 | # now found when it's needed (see discussion on issue gh-1456), and we have a |
|
154 | # now found when it's needed (see discussion on issue gh-1456), and we have a | |
155 | # test case (IPython.core.tests.test_ultratb.ChangedPyFileTest) that fails if |
|
155 | # test case (IPython.core.tests.test_ultratb.ChangedPyFileTest) that fails if | |
156 | # the monkeypatch is not applied. TK, Aug 2012. |
|
156 | # the monkeypatch is not applied. TK, Aug 2012. | |
157 | def findsource(object): |
|
157 | def findsource(object): | |
158 | """Return the entire source file and starting line number for an object. |
|
158 | """Return the entire source file and starting line number for an object. | |
159 |
|
159 | |||
160 | The argument may be a module, class, method, function, traceback, frame, |
|
160 | The argument may be a module, class, method, function, traceback, frame, | |
161 | or code object. The source code is returned as a list of all the lines |
|
161 | or code object. The source code is returned as a list of all the lines | |
162 | in the file and the line number indexes a line in that list. An IOError |
|
162 | in the file and the line number indexes a line in that list. An IOError | |
163 | is raised if the source code cannot be retrieved. |
|
163 | is raised if the source code cannot be retrieved. | |
164 |
|
164 | |||
165 | FIXED version with which we monkeypatch the stdlib to work around a bug.""" |
|
165 | FIXED version with which we monkeypatch the stdlib to work around a bug.""" | |
166 |
|
166 | |||
167 | file = getsourcefile(object) or getfile(object) |
|
167 | file = getsourcefile(object) or getfile(object) | |
168 | # If the object is a frame, then trying to get the globals dict from its |
|
168 | # If the object is a frame, then trying to get the globals dict from its | |
169 | # module won't work. Instead, the frame object itself has the globals |
|
169 | # module won't work. Instead, the frame object itself has the globals | |
170 | # dictionary. |
|
170 | # dictionary. | |
171 | globals_dict = None |
|
171 | globals_dict = None | |
172 | if inspect.isframe(object): |
|
172 | if inspect.isframe(object): | |
173 | # XXX: can this ever be false? |
|
173 | # XXX: can this ever be false? | |
174 | globals_dict = object.f_globals |
|
174 | globals_dict = object.f_globals | |
175 | else: |
|
175 | else: | |
176 | module = getmodule(object, file) |
|
176 | module = getmodule(object, file) | |
177 | if module: |
|
177 | if module: | |
178 | globals_dict = module.__dict__ |
|
178 | globals_dict = module.__dict__ | |
179 | lines = linecache.getlines(file, globals_dict) |
|
179 | lines = linecache.getlines(file, globals_dict) | |
180 | if not lines: |
|
180 | if not lines: | |
181 | raise IOError('could not get source code') |
|
181 | raise IOError('could not get source code') | |
182 |
|
182 | |||
183 | if ismodule(object): |
|
183 | if ismodule(object): | |
184 | return lines, 0 |
|
184 | return lines, 0 | |
185 |
|
185 | |||
186 | if isclass(object): |
|
186 | if isclass(object): | |
187 | name = object.__name__ |
|
187 | name = object.__name__ | |
188 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') |
|
188 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') | |
189 | # make some effort to find the best matching class definition: |
|
189 | # make some effort to find the best matching class definition: | |
190 | # use the one with the least indentation, which is the one |
|
190 | # use the one with the least indentation, which is the one | |
191 | # that's most probably not inside a function definition. |
|
191 | # that's most probably not inside a function definition. | |
192 | candidates = [] |
|
192 | candidates = [] | |
193 | for i, line in enumerate(lines): |
|
193 | for i, line in enumerate(lines): | |
194 | match = pat.match(line) |
|
194 | match = pat.match(line) | |
195 | if match: |
|
195 | if match: | |
196 | # if it's at toplevel, it's already the best one |
|
196 | # if it's at toplevel, it's already the best one | |
197 | if line[0] == 'c': |
|
197 | if line[0] == 'c': | |
198 | return lines, i |
|
198 | return lines, i | |
199 | # else add whitespace to candidate list |
|
199 | # else add whitespace to candidate list | |
200 | candidates.append((match.group(1), i)) |
|
200 | candidates.append((match.group(1), i)) | |
201 | if candidates: |
|
201 | if candidates: | |
202 | # this will sort by whitespace, and by line number, |
|
202 | # this will sort by whitespace, and by line number, | |
203 | # less whitespace first |
|
203 | # less whitespace first | |
204 | candidates.sort() |
|
204 | candidates.sort() | |
205 | return lines, candidates[0][1] |
|
205 | return lines, candidates[0][1] | |
206 | else: |
|
206 | else: | |
207 | raise IOError('could not find class definition') |
|
207 | raise IOError('could not find class definition') | |
208 |
|
208 | |||
209 | if ismethod(object): |
|
209 | if ismethod(object): | |
210 | object = object.__func__ |
|
210 | object = object.__func__ | |
211 | if isfunction(object): |
|
211 | if isfunction(object): | |
212 | object = object.__code__ |
|
212 | object = object.__code__ | |
213 | if istraceback(object): |
|
213 | if istraceback(object): | |
214 | object = object.tb_frame |
|
214 | object = object.tb_frame | |
215 | if isframe(object): |
|
215 | if isframe(object): | |
216 | object = object.f_code |
|
216 | object = object.f_code | |
217 | if iscode(object): |
|
217 | if iscode(object): | |
218 | if not hasattr(object, 'co_firstlineno'): |
|
218 | if not hasattr(object, 'co_firstlineno'): | |
219 | raise IOError('could not find function definition') |
|
219 | raise IOError('could not find function definition') | |
220 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') |
|
220 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') | |
221 | pmatch = pat.match |
|
221 | pmatch = pat.match | |
222 | # fperez - fix: sometimes, co_firstlineno can give a number larger than |
|
222 | # fperez - fix: sometimes, co_firstlineno can give a number larger than | |
223 | # the length of lines, which causes an error. Safeguard against that. |
|
223 | # the length of lines, which causes an error. Safeguard against that. | |
224 | lnum = min(object.co_firstlineno, len(lines)) - 1 |
|
224 | lnum = min(object.co_firstlineno, len(lines)) - 1 | |
225 | while lnum > 0: |
|
225 | while lnum > 0: | |
226 | if pmatch(lines[lnum]): |
|
226 | if pmatch(lines[lnum]): | |
227 | break |
|
227 | break | |
228 | lnum -= 1 |
|
228 | lnum -= 1 | |
229 |
|
229 | |||
230 | return lines, lnum |
|
230 | return lines, lnum | |
231 | raise IOError('could not find code object') |
|
231 | raise IOError('could not find code object') | |
232 |
|
232 | |||
233 |
|
233 | |||
234 | # This is a patched version of inspect.getargs that applies the (unmerged) |
|
234 | # This is a patched version of inspect.getargs that applies the (unmerged) | |
235 | # patch for http://bugs.python.org/issue14611 by Stefano Taschini. This fixes |
|
235 | # patch for http://bugs.python.org/issue14611 by Stefano Taschini. This fixes | |
236 | # https://github.com/ipython/ipython/issues/8205 and |
|
236 | # https://github.com/ipython/ipython/issues/8205 and | |
237 | # https://github.com/ipython/ipython/issues/8293 |
|
237 | # https://github.com/ipython/ipython/issues/8293 | |
238 | def getargs(co): |
|
238 | def getargs(co): | |
239 | """Get information about the arguments accepted by a code object. |
|
239 | """Get information about the arguments accepted by a code object. | |
240 |
|
240 | |||
241 | Three things are returned: (args, varargs, varkw), where 'args' is |
|
241 | Three things are returned: (args, varargs, varkw), where 'args' is | |
242 | a list of argument names (possibly containing nested lists), and |
|
242 | a list of argument names (possibly containing nested lists), and | |
243 | 'varargs' and 'varkw' are the names of the * and ** arguments or None.""" |
|
243 | 'varargs' and 'varkw' are the names of the * and ** arguments or None.""" | |
244 | if not iscode(co): |
|
244 | if not iscode(co): | |
245 | raise TypeError('{!r} is not a code object'.format(co)) |
|
245 | raise TypeError('{!r} is not a code object'.format(co)) | |
246 |
|
246 | |||
247 | nargs = co.co_argcount |
|
247 | nargs = co.co_argcount | |
248 | names = co.co_varnames |
|
248 | names = co.co_varnames | |
249 | args = list(names[:nargs]) |
|
249 | args = list(names[:nargs]) | |
250 | step = 0 |
|
250 | step = 0 | |
251 |
|
251 | |||
252 | # The following acrobatics are for anonymous (tuple) arguments. |
|
252 | # The following acrobatics are for anonymous (tuple) arguments. | |
253 | for i in range(nargs): |
|
253 | for i in range(nargs): | |
254 | if args[i][:1] in ('', '.'): |
|
254 | if args[i][:1] in ('', '.'): | |
255 | stack, remain, count = [], [], [] |
|
255 | stack, remain, count = [], [], [] | |
256 | while step < len(co.co_code): |
|
256 | while step < len(co.co_code): | |
257 | op = ord(co.co_code[step]) |
|
257 | op = ord(co.co_code[step]) | |
258 | step = step + 1 |
|
258 | step = step + 1 | |
259 | if op >= dis.HAVE_ARGUMENT: |
|
259 | if op >= dis.HAVE_ARGUMENT: | |
260 | opname = dis.opname[op] |
|
260 | opname = dis.opname[op] | |
261 | value = ord(co.co_code[step]) + ord(co.co_code[step+1])*256 |
|
261 | value = ord(co.co_code[step]) + ord(co.co_code[step+1])*256 | |
262 | step = step + 2 |
|
262 | step = step + 2 | |
263 | if opname in ('UNPACK_TUPLE', 'UNPACK_SEQUENCE'): |
|
263 | if opname in ('UNPACK_TUPLE', 'UNPACK_SEQUENCE'): | |
264 | remain.append(value) |
|
264 | remain.append(value) | |
265 | count.append(value) |
|
265 | count.append(value) | |
266 | elif opname in ('STORE_FAST', 'STORE_DEREF'): |
|
266 | elif opname in ('STORE_FAST', 'STORE_DEREF'): | |
267 | if op in dis.haslocal: |
|
267 | if op in dis.haslocal: | |
268 | stack.append(co.co_varnames[value]) |
|
268 | stack.append(co.co_varnames[value]) | |
269 | elif op in dis.hasfree: |
|
269 | elif op in dis.hasfree: | |
270 | stack.append((co.co_cellvars + co.co_freevars)[value]) |
|
270 | stack.append((co.co_cellvars + co.co_freevars)[value]) | |
271 | # Special case for sublists of length 1: def foo((bar)) |
|
271 | # Special case for sublists of length 1: def foo((bar)) | |
272 | # doesn't generate the UNPACK_TUPLE bytecode, so if |
|
272 | # doesn't generate the UNPACK_TUPLE bytecode, so if | |
273 | # `remain` is empty here, we have such a sublist. |
|
273 | # `remain` is empty here, we have such a sublist. | |
274 | if not remain: |
|
274 | if not remain: | |
275 | stack[0] = [stack[0]] |
|
275 | stack[0] = [stack[0]] | |
276 | break |
|
276 | break | |
277 | else: |
|
277 | else: | |
278 | remain[-1] = remain[-1] - 1 |
|
278 | remain[-1] = remain[-1] - 1 | |
279 | while remain[-1] == 0: |
|
279 | while remain[-1] == 0: | |
280 | remain.pop() |
|
280 | remain.pop() | |
281 | size = count.pop() |
|
281 | size = count.pop() | |
282 | stack[-size:] = [stack[-size:]] |
|
282 | stack[-size:] = [stack[-size:]] | |
283 | if not remain: |
|
283 | if not remain: | |
284 | break |
|
284 | break | |
285 | remain[-1] = remain[-1] - 1 |
|
285 | remain[-1] = remain[-1] - 1 | |
286 | if not remain: |
|
286 | if not remain: | |
287 | break |
|
287 | break | |
288 | args[i] = stack[0] |
|
288 | args[i] = stack[0] | |
289 |
|
289 | |||
290 | varargs = None |
|
290 | varargs = None | |
291 | if co.co_flags & inspect.CO_VARARGS: |
|
291 | if co.co_flags & inspect.CO_VARARGS: | |
292 | varargs = co.co_varnames[nargs] |
|
292 | varargs = co.co_varnames[nargs] | |
293 | nargs = nargs + 1 |
|
293 | nargs = nargs + 1 | |
294 | varkw = None |
|
294 | varkw = None | |
295 | if co.co_flags & inspect.CO_VARKEYWORDS: |
|
295 | if co.co_flags & inspect.CO_VARKEYWORDS: | |
296 | varkw = co.co_varnames[nargs] |
|
296 | varkw = co.co_varnames[nargs] | |
297 | return inspect.Arguments(args, varargs, varkw) |
|
297 | return inspect.Arguments(args, varargs, varkw) | |
298 |
|
298 | |||
299 |
|
299 | |||
300 | # Monkeypatch inspect to apply our bugfix. |
|
300 | # Monkeypatch inspect to apply our bugfix. | |
301 | def with_patch_inspect(f): |
|
301 | def with_patch_inspect(f): | |
302 | """ |
|
302 | """ | |
303 | Deprecated since IPython 6.0 |
|
303 | Deprecated since IPython 6.0 | |
304 | decorator for monkeypatching inspect.findsource |
|
304 | decorator for monkeypatching inspect.findsource | |
305 | """ |
|
305 | """ | |
306 |
|
306 | |||
307 | def wrapped(*args, **kwargs): |
|
307 | def wrapped(*args, **kwargs): | |
308 | save_findsource = inspect.findsource |
|
308 | save_findsource = inspect.findsource | |
309 | save_getargs = inspect.getargs |
|
309 | save_getargs = inspect.getargs | |
310 | inspect.findsource = findsource |
|
310 | inspect.findsource = findsource | |
311 | inspect.getargs = getargs |
|
311 | inspect.getargs = getargs | |
312 | try: |
|
312 | try: | |
313 | return f(*args, **kwargs) |
|
313 | return f(*args, **kwargs) | |
314 | finally: |
|
314 | finally: | |
315 | inspect.findsource = save_findsource |
|
315 | inspect.findsource = save_findsource | |
316 | inspect.getargs = save_getargs |
|
316 | inspect.getargs = save_getargs | |
317 |
|
317 | |||
318 | return wrapped |
|
318 | return wrapped | |
319 |
|
319 | |||
320 |
|
320 | |||
321 | def fix_frame_records_filenames(records): |
|
321 | def fix_frame_records_filenames(records): | |
322 | """Try to fix the filenames in each record from inspect.getinnerframes(). |
|
322 | """Try to fix the filenames in each record from inspect.getinnerframes(). | |
323 |
|
323 | |||
324 | Particularly, modules loaded from within zip files have useless filenames |
|
324 | Particularly, modules loaded from within zip files have useless filenames | |
325 | attached to their code object, and inspect.getinnerframes() just uses it. |
|
325 | attached to their code object, and inspect.getinnerframes() just uses it. | |
326 | """ |
|
326 | """ | |
327 | fixed_records = [] |
|
327 | fixed_records = [] | |
328 | for frame, filename, line_no, func_name, lines, index in records: |
|
328 | for frame, filename, line_no, func_name, lines, index in records: | |
329 | # Look inside the frame's globals dictionary for __file__, |
|
329 | # Look inside the frame's globals dictionary for __file__, | |
330 | # which should be better. However, keep Cython filenames since |
|
330 | # which should be better. However, keep Cython filenames since | |
331 | # we prefer the source filenames over the compiled .so file. |
|
331 | # we prefer the source filenames over the compiled .so file. | |
332 | if not filename.endswith(('.pyx', '.pxd', '.pxi')): |
|
332 | if not filename.endswith(('.pyx', '.pxd', '.pxi')): | |
333 | better_fn = frame.f_globals.get('__file__', None) |
|
333 | better_fn = frame.f_globals.get('__file__', None) | |
334 | if isinstance(better_fn, str): |
|
334 | if isinstance(better_fn, str): | |
335 | # Check the type just in case someone did something weird with |
|
335 | # Check the type just in case someone did something weird with | |
336 | # __file__. It might also be None if the error occurred during |
|
336 | # __file__. It might also be None if the error occurred during | |
337 | # import. |
|
337 | # import. | |
338 | filename = better_fn |
|
338 | filename = better_fn | |
339 | fixed_records.append((frame, filename, line_no, func_name, lines, index)) |
|
339 | fixed_records.append((frame, filename, line_no, func_name, lines, index)) | |
340 | return fixed_records |
|
340 | return fixed_records | |
341 |
|
341 | |||
342 |
|
342 | |||
343 | @with_patch_inspect |
|
343 | @with_patch_inspect | |
344 | def _fixed_getinnerframes(etb, context=1, tb_offset=0): |
|
344 | def _fixed_getinnerframes(etb, context=1, tb_offset=0): | |
345 | LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5 |
|
345 | LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5 | |
346 |
|
346 | |||
347 | records = fix_frame_records_filenames(inspect.getinnerframes(etb, context)) |
|
347 | records = fix_frame_records_filenames(inspect.getinnerframes(etb, context)) | |
348 | # If the error is at the console, don't build any context, since it would |
|
348 | # If the error is at the console, don't build any context, since it would | |
349 | # otherwise produce 5 blank lines printed out (there is no file at the |
|
349 | # otherwise produce 5 blank lines printed out (there is no file at the | |
350 | # console) |
|
350 | # console) | |
351 | rec_check = records[tb_offset:] |
|
351 | rec_check = records[tb_offset:] | |
352 | try: |
|
352 | try: | |
353 | rname = rec_check[0][1] |
|
353 | rname = rec_check[0][1] | |
354 | if rname == '<ipython console>' or rname.endswith('<string>'): |
|
354 | if rname == '<ipython console>' or rname.endswith('<string>'): | |
355 | return rec_check |
|
355 | return rec_check | |
356 | except IndexError: |
|
356 | except IndexError: | |
357 | pass |
|
357 | pass | |
358 |
|
358 | |||
359 | aux = traceback.extract_tb(etb) |
|
359 | aux = traceback.extract_tb(etb) | |
360 | assert len(records) == len(aux) |
|
360 | assert len(records) == len(aux) | |
361 | for i, (file, lnum, _, _) in enumerate(aux): |
|
361 | for i, (file, lnum, _, _) in enumerate(aux): | |
362 | maybeStart = lnum - 1 - context // 2 |
|
362 | maybeStart = lnum - 1 - context // 2 | |
363 | start = max(maybeStart, 0) |
|
363 | start = max(maybeStart, 0) | |
364 | end = start + context |
|
364 | end = start + context | |
365 | lines = linecache.getlines(file)[start:end] |
|
365 | lines = linecache.getlines(file)[start:end] | |
366 | buf = list(records[i]) |
|
366 | buf = list(records[i]) | |
367 | buf[LNUM_POS] = lnum |
|
367 | buf[LNUM_POS] = lnum | |
368 | buf[INDEX_POS] = lnum - 1 - start |
|
368 | buf[INDEX_POS] = lnum - 1 - start | |
369 | buf[LINES_POS] = lines |
|
369 | buf[LINES_POS] = lines | |
370 | records[i] = tuple(buf) |
|
370 | records[i] = tuple(buf) | |
371 | return records[tb_offset:] |
|
371 | return records[tb_offset:] | |
372 |
|
372 | |||
373 | # Helper function -- largely belongs to VerboseTB, but we need the same |
|
373 | # Helper function -- largely belongs to VerboseTB, but we need the same | |
374 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they |
|
374 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they | |
375 | # can be recognized properly by ipython.el's py-traceback-line-re |
|
375 | # can be recognized properly by ipython.el's py-traceback-line-re | |
376 | # (SyntaxErrors have to be treated specially because they have no traceback) |
|
376 | # (SyntaxErrors have to be treated specially because they have no traceback) | |
377 |
|
377 | |||
378 |
|
378 | |||
379 | def _format_traceback_lines(lnum, index, lines, Colors, lvals, _line_format): |
|
379 | def _format_traceback_lines(lnum, index, lines, Colors, lvals, _line_format): | |
380 | """ |
|
380 | """ | |
381 | Format tracebacks lines with pointing arrow, leading numbers... |
|
381 | Format tracebacks lines with pointing arrow, leading numbers... | |
382 |
|
382 | |||
383 | Parameters |
|
383 | Parameters | |
384 | ========== |
|
384 | ========== | |
385 |
|
385 | |||
386 | lnum: int |
|
386 | lnum: int | |
387 | index: int |
|
387 | index: int | |
388 | lines: list[string] |
|
388 | lines: list[string] | |
389 | Colors: |
|
389 | Colors: | |
390 | ColorScheme used. |
|
390 | ColorScheme used. | |
391 | lvals: bytes |
|
391 | lvals: bytes | |
392 | Values of local variables, already colored, to inject just after the error line. |
|
392 | Values of local variables, already colored, to inject just after the error line. | |
393 | _line_format: f (str) -> (str, bool) |
|
393 | _line_format: f (str) -> (str, bool) | |
394 | return (colorized version of str, failure to do so) |
|
394 | return (colorized version of str, failure to do so) | |
395 | """ |
|
395 | """ | |
396 | numbers_width = INDENT_SIZE - 1 |
|
396 | numbers_width = INDENT_SIZE - 1 | |
397 | res = [] |
|
397 | res = [] | |
398 |
|
398 | |||
399 | for i,line in enumerate(lines, lnum-index): |
|
399 | for i,line in enumerate(lines, lnum-index): | |
400 | line = py3compat.cast_unicode(line) |
|
400 | line = py3compat.cast_unicode(line) | |
401 |
|
401 | |||
402 | new_line, err = _line_format(line, 'str') |
|
402 | new_line, err = _line_format(line, 'str') | |
403 | if not err: |
|
403 | if not err: | |
404 | line = new_line |
|
404 | line = new_line | |
405 |
|
405 | |||
406 | if i == lnum: |
|
406 | if i == lnum: | |
407 | # This is the line with the error |
|
407 | # This is the line with the error | |
408 | pad = numbers_width - len(str(i)) |
|
408 | pad = numbers_width - len(str(i)) | |
409 | num = '%s%s' % (debugger.make_arrow(pad), str(lnum)) |
|
409 | num = '%s%s' % (debugger.make_arrow(pad), str(lnum)) | |
410 | line = '%s%s%s %s%s' % (Colors.linenoEm, num, |
|
410 | line = '%s%s%s %s%s' % (Colors.linenoEm, num, | |
411 | Colors.line, line, Colors.Normal) |
|
411 | Colors.line, line, Colors.Normal) | |
412 | else: |
|
412 | else: | |
413 | num = '%*s' % (numbers_width, i) |
|
413 | num = '%*s' % (numbers_width, i) | |
414 | line = '%s%s%s %s' % (Colors.lineno, num, |
|
414 | line = '%s%s%s %s' % (Colors.lineno, num, | |
415 | Colors.Normal, line) |
|
415 | Colors.Normal, line) | |
416 |
|
416 | |||
417 | res.append(line) |
|
417 | res.append(line) | |
418 | if lvals and i == lnum: |
|
418 | if lvals and i == lnum: | |
419 | res.append(lvals + '\n') |
|
419 | res.append(lvals + '\n') | |
420 | return res |
|
420 | return res | |
421 |
|
421 | |||
422 | def is_recursion_error(etype, value, records): |
|
422 | def is_recursion_error(etype, value, records): | |
423 | try: |
|
423 | try: | |
424 | # RecursionError is new in Python 3.5 |
|
424 | # RecursionError is new in Python 3.5 | |
425 | recursion_error_type = RecursionError |
|
425 | recursion_error_type = RecursionError | |
426 | except NameError: |
|
426 | except NameError: | |
427 | recursion_error_type = RuntimeError |
|
427 | recursion_error_type = RuntimeError | |
428 |
|
428 | |||
429 | # The default recursion limit is 1000, but some of that will be taken up |
|
429 | # The default recursion limit is 1000, but some of that will be taken up | |
430 | # by stack frames in IPython itself. >500 frames probably indicates |
|
430 | # by stack frames in IPython itself. >500 frames probably indicates | |
431 | # a recursion error. |
|
431 | # a recursion error. | |
432 | return (etype is recursion_error_type) \ |
|
432 | return (etype is recursion_error_type) \ | |
433 | and "recursion" in str(value).lower() \ |
|
433 | and "recursion" in str(value).lower() \ | |
434 | and len(records) > 500 |
|
434 | and len(records) > 500 | |
435 |
|
435 | |||
436 | def find_recursion(etype, value, records): |
|
436 | def find_recursion(etype, value, records): | |
437 | """Identify the repeating stack frames from a RecursionError traceback |
|
437 | """Identify the repeating stack frames from a RecursionError traceback | |
438 |
|
438 | |||
439 | 'records' is a list as returned by VerboseTB.get_records() |
|
439 | 'records' is a list as returned by VerboseTB.get_records() | |
440 |
|
440 | |||
441 | Returns (last_unique, repeat_length) |
|
441 | Returns (last_unique, repeat_length) | |
442 | """ |
|
442 | """ | |
443 | # This involves a bit of guesswork - we want to show enough of the traceback |
|
443 | # This involves a bit of guesswork - we want to show enough of the traceback | |
444 | # to indicate where the recursion is occurring. We guess that the innermost |
|
444 | # to indicate where the recursion is occurring. We guess that the innermost | |
445 | # quarter of the traceback (250 frames by default) is repeats, and find the |
|
445 | # quarter of the traceback (250 frames by default) is repeats, and find the | |
446 | # first frame (from in to out) that looks different. |
|
446 | # first frame (from in to out) that looks different. | |
447 | if not is_recursion_error(etype, value, records): |
|
447 | if not is_recursion_error(etype, value, records): | |
448 | return len(records), 0 |
|
448 | return len(records), 0 | |
449 |
|
449 | |||
450 | # Select filename, lineno, func_name to track frames with |
|
450 | # Select filename, lineno, func_name to track frames with | |
451 | records = [r[1:4] for r in records] |
|
451 | records = [r[1:4] for r in records] | |
452 | inner_frames = records[-(len(records)//4):] |
|
452 | inner_frames = records[-(len(records)//4):] | |
453 | frames_repeated = set(inner_frames) |
|
453 | frames_repeated = set(inner_frames) | |
454 |
|
454 | |||
455 | last_seen_at = {} |
|
455 | last_seen_at = {} | |
456 | longest_repeat = 0 |
|
456 | longest_repeat = 0 | |
457 | i = len(records) |
|
457 | i = len(records) | |
458 | for frame in reversed(records): |
|
458 | for frame in reversed(records): | |
459 | i -= 1 |
|
459 | i -= 1 | |
460 | if frame not in frames_repeated: |
|
460 | if frame not in frames_repeated: | |
461 | last_unique = i |
|
461 | last_unique = i | |
462 | break |
|
462 | break | |
463 |
|
463 | |||
464 | if frame in last_seen_at: |
|
464 | if frame in last_seen_at: | |
465 | distance = last_seen_at[frame] - i |
|
465 | distance = last_seen_at[frame] - i | |
466 | longest_repeat = max(longest_repeat, distance) |
|
466 | longest_repeat = max(longest_repeat, distance) | |
467 |
|
467 | |||
468 | last_seen_at[frame] = i |
|
468 | last_seen_at[frame] = i | |
469 | else: |
|
469 | else: | |
470 | last_unique = 0 # The whole traceback was recursion |
|
470 | last_unique = 0 # The whole traceback was recursion | |
471 |
|
471 | |||
472 | return last_unique, longest_repeat |
|
472 | return last_unique, longest_repeat | |
473 |
|
473 | |||
474 | #--------------------------------------------------------------------------- |
|
474 | #--------------------------------------------------------------------------- | |
475 | # Module classes |
|
475 | # Module classes | |
476 | class TBTools(colorable.Colorable): |
|
476 | class TBTools(colorable.Colorable): | |
477 | """Basic tools used by all traceback printer classes.""" |
|
477 | """Basic tools used by all traceback printer classes.""" | |
478 |
|
478 | |||
479 | # Number of frames to skip when reporting tracebacks |
|
479 | # Number of frames to skip when reporting tracebacks | |
480 | tb_offset = 0 |
|
480 | tb_offset = 0 | |
481 |
|
481 | |||
482 | def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None, parent=None, config=None): |
|
482 | def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None, parent=None, config=None): | |
483 | # Whether to call the interactive pdb debugger after printing |
|
483 | # Whether to call the interactive pdb debugger after printing | |
484 | # tracebacks or not |
|
484 | # tracebacks or not | |
485 | super(TBTools, self).__init__(parent=parent, config=config) |
|
485 | super(TBTools, self).__init__(parent=parent, config=config) | |
486 | self.call_pdb = call_pdb |
|
486 | self.call_pdb = call_pdb | |
487 |
|
487 | |||
488 | # Output stream to write to. Note that we store the original value in |
|
488 | # Output stream to write to. Note that we store the original value in | |
489 | # a private attribute and then make the public ostream a property, so |
|
489 | # a private attribute and then make the public ostream a property, so | |
490 | # that we can delay accessing sys.stdout until runtime. The way |
|
490 | # that we can delay accessing sys.stdout until runtime. The way | |
491 | # things are written now, the sys.stdout object is dynamically managed |
|
491 | # things are written now, the sys.stdout object is dynamically managed | |
492 | # so a reference to it should NEVER be stored statically. This |
|
492 | # so a reference to it should NEVER be stored statically. This | |
493 | # property approach confines this detail to a single location, and all |
|
493 | # property approach confines this detail to a single location, and all | |
494 | # subclasses can simply access self.ostream for writing. |
|
494 | # subclasses can simply access self.ostream for writing. | |
495 | self._ostream = ostream |
|
495 | self._ostream = ostream | |
496 |
|
496 | |||
497 | # Create color table |
|
497 | # Create color table | |
498 | self.color_scheme_table = exception_colors() |
|
498 | self.color_scheme_table = exception_colors() | |
499 |
|
499 | |||
500 | self.set_colors(color_scheme) |
|
500 | self.set_colors(color_scheme) | |
501 | self.old_scheme = color_scheme # save initial value for toggles |
|
501 | self.old_scheme = color_scheme # save initial value for toggles | |
502 |
|
502 | |||
503 | if call_pdb: |
|
503 | if call_pdb: | |
504 | self.pdb = debugger.Pdb() |
|
504 | self.pdb = debugger.Pdb() | |
505 | else: |
|
505 | else: | |
506 | self.pdb = None |
|
506 | self.pdb = None | |
507 |
|
507 | |||
508 | def _get_ostream(self): |
|
508 | def _get_ostream(self): | |
509 | """Output stream that exceptions are written to. |
|
509 | """Output stream that exceptions are written to. | |
510 |
|
510 | |||
511 | Valid values are: |
|
511 | Valid values are: | |
512 |
|
512 | |||
513 | - None: the default, which means that IPython will dynamically resolve |
|
513 | - None: the default, which means that IPython will dynamically resolve | |
514 | to sys.stdout. This ensures compatibility with most tools, including |
|
514 | to sys.stdout. This ensures compatibility with most tools, including | |
515 | Windows (where plain stdout doesn't recognize ANSI escapes). |
|
515 | Windows (where plain stdout doesn't recognize ANSI escapes). | |
516 |
|
516 | |||
517 | - Any object with 'write' and 'flush' attributes. |
|
517 | - Any object with 'write' and 'flush' attributes. | |
518 | """ |
|
518 | """ | |
519 | return sys.stdout if self._ostream is None else self._ostream |
|
519 | return sys.stdout if self._ostream is None else self._ostream | |
520 |
|
520 | |||
521 | def _set_ostream(self, val): |
|
521 | def _set_ostream(self, val): | |
522 | assert val is None or (hasattr(val, 'write') and hasattr(val, 'flush')) |
|
522 | assert val is None or (hasattr(val, 'write') and hasattr(val, 'flush')) | |
523 | self._ostream = val |
|
523 | self._ostream = val | |
524 |
|
524 | |||
525 | ostream = property(_get_ostream, _set_ostream) |
|
525 | ostream = property(_get_ostream, _set_ostream) | |
526 |
|
526 | |||
527 | def set_colors(self, *args, **kw): |
|
527 | def set_colors(self, *args, **kw): | |
528 | """Shorthand access to the color table scheme selector method.""" |
|
528 | """Shorthand access to the color table scheme selector method.""" | |
529 |
|
529 | |||
530 | # Set own color table |
|
530 | # Set own color table | |
531 | self.color_scheme_table.set_active_scheme(*args, **kw) |
|
531 | self.color_scheme_table.set_active_scheme(*args, **kw) | |
532 | # for convenience, set Colors to the active scheme |
|
532 | # for convenience, set Colors to the active scheme | |
533 | self.Colors = self.color_scheme_table.active_colors |
|
533 | self.Colors = self.color_scheme_table.active_colors | |
534 | # Also set colors of debugger |
|
534 | # Also set colors of debugger | |
535 | if hasattr(self, 'pdb') and self.pdb is not None: |
|
535 | if hasattr(self, 'pdb') and self.pdb is not None: | |
536 | self.pdb.set_colors(*args, **kw) |
|
536 | self.pdb.set_colors(*args, **kw) | |
537 |
|
537 | |||
538 | def color_toggle(self): |
|
538 | def color_toggle(self): | |
539 | """Toggle between the currently active color scheme and NoColor.""" |
|
539 | """Toggle between the currently active color scheme and NoColor.""" | |
540 |
|
540 | |||
541 | if self.color_scheme_table.active_scheme_name == 'NoColor': |
|
541 | if self.color_scheme_table.active_scheme_name == 'NoColor': | |
542 | self.color_scheme_table.set_active_scheme(self.old_scheme) |
|
542 | self.color_scheme_table.set_active_scheme(self.old_scheme) | |
543 | self.Colors = self.color_scheme_table.active_colors |
|
543 | self.Colors = self.color_scheme_table.active_colors | |
544 | else: |
|
544 | else: | |
545 | self.old_scheme = self.color_scheme_table.active_scheme_name |
|
545 | self.old_scheme = self.color_scheme_table.active_scheme_name | |
546 | self.color_scheme_table.set_active_scheme('NoColor') |
|
546 | self.color_scheme_table.set_active_scheme('NoColor') | |
547 | self.Colors = self.color_scheme_table.active_colors |
|
547 | self.Colors = self.color_scheme_table.active_colors | |
548 |
|
548 | |||
549 | def stb2text(self, stb): |
|
549 | def stb2text(self, stb): | |
550 | """Convert a structured traceback (a list) to a string.""" |
|
550 | """Convert a structured traceback (a list) to a string.""" | |
551 | return '\n'.join(stb) |
|
551 | return '\n'.join(stb) | |
552 |
|
552 | |||
553 | def text(self, etype, value, tb, tb_offset=None, context=5): |
|
553 | def text(self, etype, value, tb, tb_offset=None, context=5): | |
554 | """Return formatted traceback. |
|
554 | """Return formatted traceback. | |
555 |
|
555 | |||
556 | Subclasses may override this if they add extra arguments. |
|
556 | Subclasses may override this if they add extra arguments. | |
557 | """ |
|
557 | """ | |
558 | tb_list = self.structured_traceback(etype, value, tb, |
|
558 | tb_list = self.structured_traceback(etype, value, tb, | |
559 | tb_offset, context) |
|
559 | tb_offset, context) | |
560 | return self.stb2text(tb_list) |
|
560 | return self.stb2text(tb_list) | |
561 |
|
561 | |||
562 | def structured_traceback(self, etype, evalue, tb, tb_offset=None, |
|
562 | def structured_traceback(self, etype, evalue, tb, tb_offset=None, | |
563 | context=5, mode=None): |
|
563 | context=5, mode=None): | |
564 | """Return a list of traceback frames. |
|
564 | """Return a list of traceback frames. | |
565 |
|
565 | |||
566 | Must be implemented by each class. |
|
566 | Must be implemented by each class. | |
567 | """ |
|
567 | """ | |
568 | raise NotImplementedError() |
|
568 | raise NotImplementedError() | |
569 |
|
569 | |||
570 |
|
570 | |||
571 | #--------------------------------------------------------------------------- |
|
571 | #--------------------------------------------------------------------------- | |
572 | class ListTB(TBTools): |
|
572 | class ListTB(TBTools): | |
573 | """Print traceback information from a traceback list, with optional color. |
|
573 | """Print traceback information from a traceback list, with optional color. | |
574 |
|
574 | |||
575 | Calling requires 3 arguments: (etype, evalue, elist) |
|
575 | Calling requires 3 arguments: (etype, evalue, elist) | |
576 | as would be obtained by:: |
|
576 | as would be obtained by:: | |
577 |
|
577 | |||
578 | etype, evalue, tb = sys.exc_info() |
|
578 | etype, evalue, tb = sys.exc_info() | |
579 | if tb: |
|
579 | if tb: | |
580 | elist = traceback.extract_tb(tb) |
|
580 | elist = traceback.extract_tb(tb) | |
581 | else: |
|
581 | else: | |
582 | elist = None |
|
582 | elist = None | |
583 |
|
583 | |||
584 | It can thus be used by programs which need to process the traceback before |
|
584 | It can thus be used by programs which need to process the traceback before | |
585 | printing (such as console replacements based on the code module from the |
|
585 | printing (such as console replacements based on the code module from the | |
586 | standard library). |
|
586 | standard library). | |
587 |
|
587 | |||
588 | Because they are meant to be called without a full traceback (only a |
|
588 | Because they are meant to be called without a full traceback (only a | |
589 | list), instances of this class can't call the interactive pdb debugger.""" |
|
589 | list), instances of this class can't call the interactive pdb debugger.""" | |
590 |
|
590 | |||
591 | def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None, parent=None, config=None): |
|
591 | def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None, parent=None, config=None): | |
592 | TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
592 | TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, | |
593 | ostream=ostream, parent=parent,config=config) |
|
593 | ostream=ostream, parent=parent,config=config) | |
594 |
|
594 | |||
595 | def __call__(self, etype, value, elist): |
|
595 | def __call__(self, etype, value, elist): | |
596 | self.ostream.flush() |
|
596 | self.ostream.flush() | |
597 | self.ostream.write(self.text(etype, value, elist)) |
|
597 | self.ostream.write(self.text(etype, value, elist)) | |
598 | self.ostream.write('\n') |
|
598 | self.ostream.write('\n') | |
599 |
|
599 | |||
600 | def structured_traceback(self, etype, value, elist, tb_offset=None, |
|
600 | def structured_traceback(self, etype, value, elist, tb_offset=None, | |
601 | context=5): |
|
601 | context=5): | |
602 | """Return a color formatted string with the traceback info. |
|
602 | """Return a color formatted string with the traceback info. | |
603 |
|
603 | |||
604 | Parameters |
|
604 | Parameters | |
605 | ---------- |
|
605 | ---------- | |
606 | etype : exception type |
|
606 | etype : exception type | |
607 | Type of the exception raised. |
|
607 | Type of the exception raised. | |
608 |
|
608 | |||
609 | value : object |
|
609 | value : object | |
610 | Data stored in the exception |
|
610 | Data stored in the exception | |
611 |
|
611 | |||
612 | elist : list |
|
612 | elist : list | |
613 | List of frames, see class docstring for details. |
|
613 | List of frames, see class docstring for details. | |
614 |
|
614 | |||
615 | tb_offset : int, optional |
|
615 | tb_offset : int, optional | |
616 | Number of frames in the traceback to skip. If not given, the |
|
616 | Number of frames in the traceback to skip. If not given, the | |
617 | instance value is used (set in constructor). |
|
617 | instance value is used (set in constructor). | |
618 |
|
618 | |||
619 | context : int, optional |
|
619 | context : int, optional | |
620 | Number of lines of context information to print. |
|
620 | Number of lines of context information to print. | |
621 |
|
621 | |||
622 | Returns |
|
622 | Returns | |
623 | ------- |
|
623 | ------- | |
624 | String with formatted exception. |
|
624 | String with formatted exception. | |
625 | """ |
|
625 | """ | |
626 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
626 | tb_offset = self.tb_offset if tb_offset is None else tb_offset | |
627 | Colors = self.Colors |
|
627 | Colors = self.Colors | |
628 | out_list = [] |
|
628 | out_list = [] | |
629 | if elist: |
|
629 | if elist: | |
630 |
|
630 | |||
631 | if tb_offset and len(elist) > tb_offset: |
|
631 | if tb_offset and len(elist) > tb_offset: | |
632 | elist = elist[tb_offset:] |
|
632 | elist = elist[tb_offset:] | |
633 |
|
633 | |||
634 | out_list.append('Traceback %s(most recent call last)%s:' % |
|
634 | out_list.append('Traceback %s(most recent call last)%s:' % | |
635 | (Colors.normalEm, Colors.Normal) + '\n') |
|
635 | (Colors.normalEm, Colors.Normal) + '\n') | |
636 | out_list.extend(self._format_list(elist)) |
|
636 | out_list.extend(self._format_list(elist)) | |
637 | # The exception info should be a single entry in the list. |
|
637 | # The exception info should be a single entry in the list. | |
638 | lines = ''.join(self._format_exception_only(etype, value)) |
|
638 | lines = ''.join(self._format_exception_only(etype, value)) | |
639 | out_list.append(lines) |
|
639 | out_list.append(lines) | |
640 |
|
640 | |||
641 | return out_list |
|
641 | return out_list | |
642 |
|
642 | |||
643 | def _format_list(self, extracted_list): |
|
643 | def _format_list(self, extracted_list): | |
644 | """Format a list of traceback entry tuples for printing. |
|
644 | """Format a list of traceback entry tuples for printing. | |
645 |
|
645 | |||
646 | Given a list of tuples as returned by extract_tb() or |
|
646 | Given a list of tuples as returned by extract_tb() or | |
647 | extract_stack(), return a list of strings ready for printing. |
|
647 | extract_stack(), return a list of strings ready for printing. | |
648 | Each string in the resulting list corresponds to the item with the |
|
648 | Each string in the resulting list corresponds to the item with the | |
649 | same index in the argument list. Each string ends in a newline; |
|
649 | same index in the argument list. Each string ends in a newline; | |
650 | the strings may contain internal newlines as well, for those items |
|
650 | the strings may contain internal newlines as well, for those items | |
651 | whose source text line is not None. |
|
651 | whose source text line is not None. | |
652 |
|
652 | |||
653 | Lifted almost verbatim from traceback.py |
|
653 | Lifted almost verbatim from traceback.py | |
654 | """ |
|
654 | """ | |
655 |
|
655 | |||
656 | Colors = self.Colors |
|
656 | Colors = self.Colors | |
657 | list = [] |
|
657 | list = [] | |
658 | for filename, lineno, name, line in extracted_list[:-1]: |
|
658 | for filename, lineno, name, line in extracted_list[:-1]: | |
659 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ |
|
659 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ | |
660 | (Colors.filename, filename, Colors.Normal, |
|
660 | (Colors.filename, filename, Colors.Normal, | |
661 | Colors.lineno, lineno, Colors.Normal, |
|
661 | Colors.lineno, lineno, Colors.Normal, | |
662 | Colors.name, name, Colors.Normal) |
|
662 | Colors.name, name, Colors.Normal) | |
663 | if line: |
|
663 | if line: | |
664 | item += ' %s\n' % line.strip() |
|
664 | item += ' %s\n' % line.strip() | |
665 | list.append(item) |
|
665 | list.append(item) | |
666 | # Emphasize the last entry |
|
666 | # Emphasize the last entry | |
667 | filename, lineno, name, line = extracted_list[-1] |
|
667 | filename, lineno, name, line = extracted_list[-1] | |
668 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ |
|
668 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ | |
669 | (Colors.normalEm, |
|
669 | (Colors.normalEm, | |
670 | Colors.filenameEm, filename, Colors.normalEm, |
|
670 | Colors.filenameEm, filename, Colors.normalEm, | |
671 | Colors.linenoEm, lineno, Colors.normalEm, |
|
671 | Colors.linenoEm, lineno, Colors.normalEm, | |
672 | Colors.nameEm, name, Colors.normalEm, |
|
672 | Colors.nameEm, name, Colors.normalEm, | |
673 | Colors.Normal) |
|
673 | Colors.Normal) | |
674 | if line: |
|
674 | if line: | |
675 | item += '%s %s%s\n' % (Colors.line, line.strip(), |
|
675 | item += '%s %s%s\n' % (Colors.line, line.strip(), | |
676 | Colors.Normal) |
|
676 | Colors.Normal) | |
677 | list.append(item) |
|
677 | list.append(item) | |
678 | return list |
|
678 | return list | |
679 |
|
679 | |||
680 | def _format_exception_only(self, etype, value): |
|
680 | def _format_exception_only(self, etype, value): | |
681 | """Format the exception part of a traceback. |
|
681 | """Format the exception part of a traceback. | |
682 |
|
682 | |||
683 | The arguments are the exception type and value such as given by |
|
683 | The arguments are the exception type and value such as given by | |
684 | sys.exc_info()[:2]. The return value is a list of strings, each ending |
|
684 | sys.exc_info()[:2]. The return value is a list of strings, each ending | |
685 | in a newline. Normally, the list contains a single string; however, |
|
685 | in a newline. Normally, the list contains a single string; however, | |
686 | for SyntaxError exceptions, it contains several lines that (when |
|
686 | for SyntaxError exceptions, it contains several lines that (when | |
687 | printed) display detailed information about where the syntax error |
|
687 | printed) display detailed information about where the syntax error | |
688 | occurred. The message indicating which exception occurred is the |
|
688 | occurred. The message indicating which exception occurred is the | |
689 | always last string in the list. |
|
689 | always last string in the list. | |
690 |
|
690 | |||
691 | Also lifted nearly verbatim from traceback.py |
|
691 | Also lifted nearly verbatim from traceback.py | |
692 | """ |
|
692 | """ | |
693 | have_filedata = False |
|
693 | have_filedata = False | |
694 | Colors = self.Colors |
|
694 | Colors = self.Colors | |
695 | list = [] |
|
695 | list = [] | |
696 | stype = py3compat.cast_unicode(Colors.excName + etype.__name__ + Colors.Normal) |
|
696 | stype = py3compat.cast_unicode(Colors.excName + etype.__name__ + Colors.Normal) | |
697 | if value is None: |
|
697 | if value is None: | |
698 | # Not sure if this can still happen in Python 2.6 and above |
|
698 | # Not sure if this can still happen in Python 2.6 and above | |
699 | list.append(stype + '\n') |
|
699 | list.append(stype + '\n') | |
700 | else: |
|
700 | else: | |
701 | if issubclass(etype, SyntaxError): |
|
701 | if issubclass(etype, SyntaxError): | |
702 | have_filedata = True |
|
702 | have_filedata = True | |
703 | if not value.filename: value.filename = "<string>" |
|
703 | if not value.filename: value.filename = "<string>" | |
704 | if value.lineno: |
|
704 | if value.lineno: | |
705 | lineno = value.lineno |
|
705 | lineno = value.lineno | |
706 | textline = linecache.getline(value.filename, value.lineno) |
|
706 | textline = linecache.getline(value.filename, value.lineno) | |
707 | else: |
|
707 | else: | |
708 | lineno = 'unknown' |
|
708 | lineno = 'unknown' | |
709 | textline = '' |
|
709 | textline = '' | |
710 | list.append('%s File %s"%s"%s, line %s%s%s\n' % \ |
|
710 | list.append('%s File %s"%s"%s, line %s%s%s\n' % \ | |
711 | (Colors.normalEm, |
|
711 | (Colors.normalEm, | |
712 | Colors.filenameEm, py3compat.cast_unicode(value.filename), Colors.normalEm, |
|
712 | Colors.filenameEm, py3compat.cast_unicode(value.filename), Colors.normalEm, | |
713 | Colors.linenoEm, lineno, Colors.Normal )) |
|
713 | Colors.linenoEm, lineno, Colors.Normal )) | |
714 | if textline == '': |
|
714 | if textline == '': | |
715 | textline = py3compat.cast_unicode(value.text, "utf-8") |
|
715 | textline = py3compat.cast_unicode(value.text, "utf-8") | |
716 |
|
716 | |||
717 | if textline is not None: |
|
717 | if textline is not None: | |
718 | i = 0 |
|
718 | i = 0 | |
719 | while i < len(textline) and textline[i].isspace(): |
|
719 | while i < len(textline) and textline[i].isspace(): | |
720 | i += 1 |
|
720 | i += 1 | |
721 | list.append('%s %s%s\n' % (Colors.line, |
|
721 | list.append('%s %s%s\n' % (Colors.line, | |
722 | textline.strip(), |
|
722 | textline.strip(), | |
723 | Colors.Normal)) |
|
723 | Colors.Normal)) | |
724 | if value.offset is not None: |
|
724 | if value.offset is not None: | |
725 | s = ' ' |
|
725 | s = ' ' | |
726 | for c in textline[i:value.offset - 1]: |
|
726 | for c in textline[i:value.offset - 1]: | |
727 | if c.isspace(): |
|
727 | if c.isspace(): | |
728 | s += c |
|
728 | s += c | |
729 | else: |
|
729 | else: | |
730 | s += ' ' |
|
730 | s += ' ' | |
731 | list.append('%s%s^%s\n' % (Colors.caret, s, |
|
731 | list.append('%s%s^%s\n' % (Colors.caret, s, | |
732 | Colors.Normal)) |
|
732 | Colors.Normal)) | |
733 |
|
733 | |||
734 | try: |
|
734 | try: | |
735 | s = value.msg |
|
735 | s = value.msg | |
736 | except Exception: |
|
736 | except Exception: | |
737 | s = self._some_str(value) |
|
737 | s = self._some_str(value) | |
738 | if s: |
|
738 | if s: | |
739 | list.append('%s%s:%s %s\n' % (stype, Colors.excName, |
|
739 | list.append('%s%s:%s %s\n' % (stype, Colors.excName, | |
740 | Colors.Normal, s)) |
|
740 | Colors.Normal, s)) | |
741 | else: |
|
741 | else: | |
742 | list.append('%s\n' % stype) |
|
742 | list.append('%s\n' % stype) | |
743 |
|
743 | |||
744 | # sync with user hooks |
|
744 | # sync with user hooks | |
745 | if have_filedata: |
|
745 | if have_filedata: | |
746 | ipinst = get_ipython() |
|
746 | ipinst = get_ipython() | |
747 | if ipinst is not None: |
|
747 | if ipinst is not None: | |
748 | ipinst.hooks.synchronize_with_editor(value.filename, value.lineno, 0) |
|
748 | ipinst.hooks.synchronize_with_editor(value.filename, value.lineno, 0) | |
749 |
|
749 | |||
750 | return list |
|
750 | return list | |
751 |
|
751 | |||
752 | def get_exception_only(self, etype, value): |
|
752 | def get_exception_only(self, etype, value): | |
753 | """Only print the exception type and message, without a traceback. |
|
753 | """Only print the exception type and message, without a traceback. | |
754 |
|
754 | |||
755 | Parameters |
|
755 | Parameters | |
756 | ---------- |
|
756 | ---------- | |
757 | etype : exception type |
|
757 | etype : exception type | |
758 | value : exception value |
|
758 | value : exception value | |
759 | """ |
|
759 | """ | |
760 | return ListTB.structured_traceback(self, etype, value, []) |
|
760 | return ListTB.structured_traceback(self, etype, value, []) | |
761 |
|
761 | |||
762 | def show_exception_only(self, etype, evalue): |
|
762 | def show_exception_only(self, etype, evalue): | |
763 | """Only print the exception type and message, without a traceback. |
|
763 | """Only print the exception type and message, without a traceback. | |
764 |
|
764 | |||
765 | Parameters |
|
765 | Parameters | |
766 | ---------- |
|
766 | ---------- | |
767 | etype : exception type |
|
767 | etype : exception type | |
768 | value : exception value |
|
768 | value : exception value | |
769 | """ |
|
769 | """ | |
770 | # This method needs to use __call__ from *this* class, not the one from |
|
770 | # This method needs to use __call__ from *this* class, not the one from | |
771 | # a subclass whose signature or behavior may be different |
|
771 | # a subclass whose signature or behavior may be different | |
772 | ostream = self.ostream |
|
772 | ostream = self.ostream | |
773 | ostream.flush() |
|
773 | ostream.flush() | |
774 | ostream.write('\n'.join(self.get_exception_only(etype, evalue))) |
|
774 | ostream.write('\n'.join(self.get_exception_only(etype, evalue))) | |
775 | ostream.flush() |
|
775 | ostream.flush() | |
776 |
|
776 | |||
777 | def _some_str(self, value): |
|
777 | def _some_str(self, value): | |
778 | # Lifted from traceback.py |
|
778 | # Lifted from traceback.py | |
779 | try: |
|
779 | try: | |
780 | return py3compat.cast_unicode(str(value)) |
|
780 | return py3compat.cast_unicode(str(value)) | |
781 | except: |
|
781 | except: | |
782 | return u'<unprintable %s object>' % type(value).__name__ |
|
782 | return u'<unprintable %s object>' % type(value).__name__ | |
783 |
|
783 | |||
784 |
|
784 | |||
785 | #---------------------------------------------------------------------------- |
|
785 | #---------------------------------------------------------------------------- | |
786 | class VerboseTB(TBTools): |
|
786 | class VerboseTB(TBTools): | |
787 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead |
|
787 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead | |
788 | of HTML. Requires inspect and pydoc. Crazy, man. |
|
788 | of HTML. Requires inspect and pydoc. Crazy, man. | |
789 |
|
789 | |||
790 | Modified version which optionally strips the topmost entries from the |
|
790 | Modified version which optionally strips the topmost entries from the | |
791 | traceback, to be used with alternate interpreters (because their own code |
|
791 | traceback, to be used with alternate interpreters (because their own code | |
792 | would appear in the traceback).""" |
|
792 | would appear in the traceback).""" | |
793 |
|
793 | |||
794 | def __init__(self, color_scheme='Linux', call_pdb=False, ostream=None, |
|
794 | def __init__(self, color_scheme='Linux', call_pdb=False, ostream=None, | |
795 | tb_offset=0, long_header=False, include_vars=True, |
|
795 | tb_offset=0, long_header=False, include_vars=True, | |
796 | check_cache=None, debugger_cls = None, |
|
796 | check_cache=None, debugger_cls = None, | |
797 | parent=None, config=None): |
|
797 | parent=None, config=None): | |
798 | """Specify traceback offset, headers and color scheme. |
|
798 | """Specify traceback offset, headers and color scheme. | |
799 |
|
799 | |||
800 | Define how many frames to drop from the tracebacks. Calling it with |
|
800 | Define how many frames to drop from the tracebacks. Calling it with | |
801 | tb_offset=1 allows use of this handler in interpreters which will have |
|
801 | tb_offset=1 allows use of this handler in interpreters which will have | |
802 | their own code at the top of the traceback (VerboseTB will first |
|
802 | their own code at the top of the traceback (VerboseTB will first | |
803 | remove that frame before printing the traceback info).""" |
|
803 | remove that frame before printing the traceback info).""" | |
804 | TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
804 | TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, | |
805 | ostream=ostream, parent=parent, config=config) |
|
805 | ostream=ostream, parent=parent, config=config) | |
806 | self.tb_offset = tb_offset |
|
806 | self.tb_offset = tb_offset | |
807 | self.long_header = long_header |
|
807 | self.long_header = long_header | |
808 | self.include_vars = include_vars |
|
808 | self.include_vars = include_vars | |
809 | # By default we use linecache.checkcache, but the user can provide a |
|
809 | # By default we use linecache.checkcache, but the user can provide a | |
810 | # different check_cache implementation. This is used by the IPython |
|
810 | # different check_cache implementation. This is used by the IPython | |
811 | # kernel to provide tracebacks for interactive code that is cached, |
|
811 | # kernel to provide tracebacks for interactive code that is cached, | |
812 | # by a compiler instance that flushes the linecache but preserves its |
|
812 | # by a compiler instance that flushes the linecache but preserves its | |
813 | # own code cache. |
|
813 | # own code cache. | |
814 | if check_cache is None: |
|
814 | if check_cache is None: | |
815 | check_cache = linecache.checkcache |
|
815 | check_cache = linecache.checkcache | |
816 | self.check_cache = check_cache |
|
816 | self.check_cache = check_cache | |
817 |
|
817 | |||
818 | self.debugger_cls = debugger_cls or debugger.Pdb |
|
818 | self.debugger_cls = debugger_cls or debugger.Pdb | |
819 |
|
819 | |||
820 | def format_records(self, records, last_unique, recursion_repeat): |
|
820 | def format_records(self, records, last_unique, recursion_repeat): | |
821 | """Format the stack frames of the traceback""" |
|
821 | """Format the stack frames of the traceback""" | |
822 | frames = [] |
|
822 | frames = [] | |
823 | for r in records[:last_unique+recursion_repeat+1]: |
|
823 | for r in records[:last_unique+recursion_repeat+1]: | |
824 | #print '*** record:',file,lnum,func,lines,index # dbg |
|
824 | #print '*** record:',file,lnum,func,lines,index # dbg | |
825 | frames.append(self.format_record(*r)) |
|
825 | frames.append(self.format_record(*r)) | |
826 |
|
826 | |||
827 | if recursion_repeat: |
|
827 | if recursion_repeat: | |
828 | frames.append('... last %d frames repeated, from the frame below ...\n' % recursion_repeat) |
|
828 | frames.append('... last %d frames repeated, from the frame below ...\n' % recursion_repeat) | |
829 | frames.append(self.format_record(*records[last_unique+recursion_repeat+1])) |
|
829 | frames.append(self.format_record(*records[last_unique+recursion_repeat+1])) | |
830 |
|
830 | |||
831 | return frames |
|
831 | return frames | |
832 |
|
832 | |||
833 | def format_record(self, frame, file, lnum, func, lines, index): |
|
833 | def format_record(self, frame, file, lnum, func, lines, index): | |
834 | """Format a single stack frame""" |
|
834 | """Format a single stack frame""" | |
835 | Colors = self.Colors # just a shorthand + quicker name lookup |
|
835 | Colors = self.Colors # just a shorthand + quicker name lookup | |
836 | ColorsNormal = Colors.Normal # used a lot |
|
836 | ColorsNormal = Colors.Normal # used a lot | |
837 | col_scheme = self.color_scheme_table.active_scheme_name |
|
837 | col_scheme = self.color_scheme_table.active_scheme_name | |
838 | indent = ' ' * INDENT_SIZE |
|
838 | indent = ' ' * INDENT_SIZE | |
839 | em_normal = '%s\n%s%s' % (Colors.valEm, indent, ColorsNormal) |
|
839 | em_normal = '%s\n%s%s' % (Colors.valEm, indent, ColorsNormal) | |
840 | undefined = '%sundefined%s' % (Colors.em, ColorsNormal) |
|
840 | undefined = '%sundefined%s' % (Colors.em, ColorsNormal) | |
841 | tpl_link = '%s%%s%s' % (Colors.filenameEm, ColorsNormal) |
|
841 | tpl_link = '%s%%s%s' % (Colors.filenameEm, ColorsNormal) | |
842 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, |
|
842 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, | |
843 | ColorsNormal) |
|
843 | ColorsNormal) | |
844 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ |
|
844 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ | |
845 | (Colors.vName, Colors.valEm, ColorsNormal) |
|
845 | (Colors.vName, Colors.valEm, ColorsNormal) | |
846 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) |
|
846 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) | |
847 | tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal, |
|
847 | tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal, | |
848 | Colors.vName, ColorsNormal) |
|
848 | Colors.vName, ColorsNormal) | |
849 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) |
|
849 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) | |
850 |
|
850 | |||
851 | if not file: |
|
851 | if not file: | |
852 | file = '?' |
|
852 | file = '?' | |
853 | elif file.startswith(str("<")) and file.endswith(str(">")): |
|
853 | elif file.startswith(str("<")) and file.endswith(str(">")): | |
854 | # Not a real filename, no problem... |
|
854 | # Not a real filename, no problem... | |
855 | pass |
|
855 | pass | |
856 | elif not os.path.isabs(file): |
|
856 | elif not os.path.isabs(file): | |
857 | # Try to make the filename absolute by trying all |
|
857 | # Try to make the filename absolute by trying all | |
858 | # sys.path entries (which is also what linecache does) |
|
858 | # sys.path entries (which is also what linecache does) | |
859 | for dirname in sys.path: |
|
859 | for dirname in sys.path: | |
860 | try: |
|
860 | try: | |
861 | fullname = os.path.join(dirname, file) |
|
861 | fullname = os.path.join(dirname, file) | |
862 | if os.path.isfile(fullname): |
|
862 | if os.path.isfile(fullname): | |
863 | file = os.path.abspath(fullname) |
|
863 | file = os.path.abspath(fullname) | |
864 | break |
|
864 | break | |
865 | except Exception: |
|
865 | except Exception: | |
866 | # Just in case that sys.path contains very |
|
866 | # Just in case that sys.path contains very | |
867 | # strange entries... |
|
867 | # strange entries... | |
868 | pass |
|
868 | pass | |
869 |
|
869 | |||
870 | file = py3compat.cast_unicode(file, util_path.fs_encoding) |
|
870 | file = py3compat.cast_unicode(file, util_path.fs_encoding) | |
871 | link = tpl_link % util_path.compress_user(file) |
|
871 | link = tpl_link % util_path.compress_user(file) | |
872 | args, varargs, varkw, locals_ = inspect.getargvalues(frame) |
|
872 | args, varargs, varkw, locals_ = inspect.getargvalues(frame) | |
873 |
|
873 | |||
874 | if func == '?': |
|
874 | if func == '?': | |
875 | call = '' |
|
875 | call = '' | |
876 | elif func == '<module>': |
|
876 | elif func == '<module>': | |
877 | call = tpl_call % (func, '') |
|
877 | call = tpl_call % (func, '') | |
878 | else: |
|
878 | else: | |
879 | # Decide whether to include variable details or not |
|
879 | # Decide whether to include variable details or not | |
880 | var_repr = eqrepr if self.include_vars else nullrepr |
|
880 | var_repr = eqrepr if self.include_vars else nullrepr | |
881 | try: |
|
881 | try: | |
882 | call = tpl_call % (func, inspect.formatargvalues(args, |
|
882 | call = tpl_call % (func, inspect.formatargvalues(args, | |
883 | varargs, varkw, |
|
883 | varargs, varkw, | |
884 | locals_, formatvalue=var_repr)) |
|
884 | locals_, formatvalue=var_repr)) | |
885 | except KeyError: |
|
885 | except KeyError: | |
886 | # This happens in situations like errors inside generator |
|
886 | # This happens in situations like errors inside generator | |
887 | # expressions, where local variables are listed in the |
|
887 | # expressions, where local variables are listed in the | |
888 | # line, but can't be extracted from the frame. I'm not |
|
888 | # line, but can't be extracted from the frame. I'm not | |
889 | # 100% sure this isn't actually a bug in inspect itself, |
|
889 | # 100% sure this isn't actually a bug in inspect itself, | |
890 | # but since there's no info for us to compute with, the |
|
890 | # but since there's no info for us to compute with, the | |
891 | # best we can do is report the failure and move on. Here |
|
891 | # best we can do is report the failure and move on. Here | |
892 | # we must *not* call any traceback construction again, |
|
892 | # we must *not* call any traceback construction again, | |
893 | # because that would mess up use of %debug later on. So we |
|
893 | # because that would mess up use of %debug later on. So we | |
894 | # simply report the failure and move on. The only |
|
894 | # simply report the failure and move on. The only | |
895 | # limitation will be that this frame won't have locals |
|
895 | # limitation will be that this frame won't have locals | |
896 | # listed in the call signature. Quite subtle problem... |
|
896 | # listed in the call signature. Quite subtle problem... | |
897 | # I can't think of a good way to validate this in a unit |
|
897 | # I can't think of a good way to validate this in a unit | |
898 | # test, but running a script consisting of: |
|
898 | # test, but running a script consisting of: | |
899 | # dict( (k,v.strip()) for (k,v) in range(10) ) |
|
899 | # dict( (k,v.strip()) for (k,v) in range(10) ) | |
900 | # will illustrate the error, if this exception catch is |
|
900 | # will illustrate the error, if this exception catch is | |
901 | # disabled. |
|
901 | # disabled. | |
902 | call = tpl_call_fail % func |
|
902 | call = tpl_call_fail % func | |
903 |
|
903 | |||
904 | # Don't attempt to tokenize binary files. |
|
904 | # Don't attempt to tokenize binary files. | |
905 | if file.endswith(('.so', '.pyd', '.dll')): |
|
905 | if file.endswith(('.so', '.pyd', '.dll')): | |
906 | return '%s %s\n' % (link, call) |
|
906 | return '%s %s\n' % (link, call) | |
907 |
|
907 | |||
908 | elif file.endswith(('.pyc', '.pyo')): |
|
908 | elif file.endswith(('.pyc', '.pyo')): | |
909 | # Look up the corresponding source file. |
|
909 | # Look up the corresponding source file. | |
910 | try: |
|
910 | try: | |
911 | file = source_from_cache(file) |
|
911 | file = source_from_cache(file) | |
912 | except ValueError: |
|
912 | except ValueError: | |
913 | # Failed to get the source file for some reason |
|
913 | # Failed to get the source file for some reason | |
914 | # E.g. https://github.com/ipython/ipython/issues/9486 |
|
914 | # E.g. https://github.com/ipython/ipython/issues/9486 | |
915 | return '%s %s\n' % (link, call) |
|
915 | return '%s %s\n' % (link, call) | |
916 |
|
916 | |||
917 | def linereader(file=file, lnum=[lnum], getline=linecache.getline): |
|
917 | def linereader(file=file, lnum=[lnum], getline=linecache.getline): | |
918 | line = getline(file, lnum[0]) |
|
918 | line = getline(file, lnum[0]) | |
919 | lnum[0] += 1 |
|
919 | lnum[0] += 1 | |
920 | return line |
|
920 | return line | |
921 |
|
921 | |||
922 | # Build the list of names on this line of code where the exception |
|
922 | # Build the list of names on this line of code where the exception | |
923 | # occurred. |
|
923 | # occurred. | |
924 | try: |
|
924 | try: | |
925 | names = [] |
|
925 | names = [] | |
926 | name_cont = False |
|
926 | name_cont = False | |
927 |
|
927 | |||
928 | for token_type, token, start, end, line in generate_tokens(linereader): |
|
928 | for token_type, token, start, end, line in generate_tokens(linereader): | |
929 | # build composite names |
|
929 | # build composite names | |
930 | if token_type == tokenize.NAME and token not in keyword.kwlist: |
|
930 | if token_type == tokenize.NAME and token not in keyword.kwlist: | |
931 | if name_cont: |
|
931 | if name_cont: | |
932 | # Continuation of a dotted name |
|
932 | # Continuation of a dotted name | |
933 | try: |
|
933 | try: | |
934 | names[-1].append(token) |
|
934 | names[-1].append(token) | |
935 | except IndexError: |
|
935 | except IndexError: | |
936 | names.append([token]) |
|
936 | names.append([token]) | |
937 | name_cont = False |
|
937 | name_cont = False | |
938 | else: |
|
938 | else: | |
939 | # Regular new names. We append everything, the caller |
|
939 | # Regular new names. We append everything, the caller | |
940 | # will be responsible for pruning the list later. It's |
|
940 | # will be responsible for pruning the list later. It's | |
941 | # very tricky to try to prune as we go, b/c composite |
|
941 | # very tricky to try to prune as we go, b/c composite | |
942 | # names can fool us. The pruning at the end is easy |
|
942 | # names can fool us. The pruning at the end is easy | |
943 | # to do (or the caller can print a list with repeated |
|
943 | # to do (or the caller can print a list with repeated | |
944 | # names if so desired. |
|
944 | # names if so desired. | |
945 | names.append([token]) |
|
945 | names.append([token]) | |
946 | elif token == '.': |
|
946 | elif token == '.': | |
947 | name_cont = True |
|
947 | name_cont = True | |
948 | elif token_type == tokenize.NEWLINE: |
|
948 | elif token_type == tokenize.NEWLINE: | |
949 | break |
|
949 | break | |
950 |
|
950 | |||
951 | except (IndexError, UnicodeDecodeError, SyntaxError): |
|
951 | except (IndexError, UnicodeDecodeError, SyntaxError): | |
952 | # signals exit of tokenizer |
|
952 | # signals exit of tokenizer | |
953 | # SyntaxError can occur if the file is not actually Python |
|
953 | # SyntaxError can occur if the file is not actually Python | |
954 | # - see gh-6300 |
|
954 | # - see gh-6300 | |
955 | pass |
|
955 | pass | |
956 | except tokenize.TokenError as msg: |
|
956 | except tokenize.TokenError as msg: | |
957 | # Tokenizing may fail for various reasons, many of which are |
|
957 | # Tokenizing may fail for various reasons, many of which are | |
958 | # harmless. (A good example is when the line in question is the |
|
958 | # harmless. (A good example is when the line in question is the | |
959 | # close of a triple-quoted string, cf gh-6864). We don't want to |
|
959 | # close of a triple-quoted string, cf gh-6864). We don't want to | |
960 | # show this to users, but want make it available for debugging |
|
960 | # show this to users, but want make it available for debugging | |
961 | # purposes. |
|
961 | # purposes. | |
962 | _m = ("An unexpected error occurred while tokenizing input\n" |
|
962 | _m = ("An unexpected error occurred while tokenizing input\n" | |
963 | "The following traceback may be corrupted or invalid\n" |
|
963 | "The following traceback may be corrupted or invalid\n" | |
964 | "The error message is: %s\n" % msg) |
|
964 | "The error message is: %s\n" % msg) | |
965 | debug(_m) |
|
965 | debug(_m) | |
966 |
|
966 | |||
967 | # Join composite names (e.g. "dict.fromkeys") |
|
967 | # Join composite names (e.g. "dict.fromkeys") | |
968 | names = ['.'.join(n) for n in names] |
|
968 | names = ['.'.join(n) for n in names] | |
969 | # prune names list of duplicates, but keep the right order |
|
969 | # prune names list of duplicates, but keep the right order | |
970 | unique_names = uniq_stable(names) |
|
970 | unique_names = uniq_stable(names) | |
971 |
|
971 | |||
972 | # Start loop over vars |
|
972 | # Start loop over vars | |
973 | lvals = '' |
|
973 | lvals = '' | |
974 | lvals_list = [] |
|
974 | lvals_list = [] | |
975 | if self.include_vars: |
|
975 | if self.include_vars: | |
976 | for name_full in unique_names: |
|
976 | for name_full in unique_names: | |
977 | name_base = name_full.split('.', 1)[0] |
|
977 | name_base = name_full.split('.', 1)[0] | |
978 | if name_base in frame.f_code.co_varnames: |
|
978 | if name_base in frame.f_code.co_varnames: | |
979 | if name_base in locals_: |
|
979 | if name_base in locals_: | |
980 | try: |
|
980 | try: | |
981 | value = repr(eval(name_full, locals_)) |
|
981 | value = repr(eval(name_full, locals_)) | |
982 | except: |
|
982 | except: | |
983 | value = undefined |
|
983 | value = undefined | |
984 | else: |
|
984 | else: | |
985 | value = undefined |
|
985 | value = undefined | |
986 | name = tpl_local_var % name_full |
|
986 | name = tpl_local_var % name_full | |
987 | else: |
|
987 | else: | |
988 | if name_base in frame.f_globals: |
|
988 | if name_base in frame.f_globals: | |
989 | try: |
|
989 | try: | |
990 | value = repr(eval(name_full, frame.f_globals)) |
|
990 | value = repr(eval(name_full, frame.f_globals)) | |
991 | except: |
|
991 | except: | |
992 | value = undefined |
|
992 | value = undefined | |
993 | else: |
|
993 | else: | |
994 | value = undefined |
|
994 | value = undefined | |
995 | name = tpl_global_var % name_full |
|
995 | name = tpl_global_var % name_full | |
996 | lvals_list.append(tpl_name_val % (name, value)) |
|
996 | lvals_list.append(tpl_name_val % (name, value)) | |
997 | if lvals_list: |
|
997 | if lvals_list: | |
998 | lvals = '%s%s' % (indent, em_normal.join(lvals_list)) |
|
998 | lvals = '%s%s' % (indent, em_normal.join(lvals_list)) | |
999 |
|
999 | |||
1000 | level = '%s %s\n' % (link, call) |
|
1000 | level = '%s %s\n' % (link, call) | |
1001 |
|
1001 | |||
1002 | if index is None: |
|
1002 | if index is None: | |
1003 | return level |
|
1003 | return level | |
1004 | else: |
|
1004 | else: | |
1005 | _line_format = PyColorize.Parser(style=col_scheme, parent=self).format2 |
|
1005 | _line_format = PyColorize.Parser(style=col_scheme, parent=self).format2 | |
1006 | return '%s%s' % (level, ''.join( |
|
1006 | return '%s%s' % (level, ''.join( | |
1007 | _format_traceback_lines(lnum, index, lines, Colors, lvals, |
|
1007 | _format_traceback_lines(lnum, index, lines, Colors, lvals, | |
1008 | _line_format))) |
|
1008 | _line_format))) | |
1009 |
|
1009 | |||
1010 | def prepare_chained_exception_message(self, cause): |
|
1010 | def prepare_chained_exception_message(self, cause): | |
1011 | direct_cause = "\nThe above exception was the direct cause of the following exception:\n" |
|
1011 | direct_cause = "\nThe above exception was the direct cause of the following exception:\n" | |
1012 | exception_during_handling = "\nDuring handling of the above exception, another exception occurred:\n" |
|
1012 | exception_during_handling = "\nDuring handling of the above exception, another exception occurred:\n" | |
1013 |
|
1013 | |||
1014 | if cause: |
|
1014 | if cause: | |
1015 | message = [[direct_cause]] |
|
1015 | message = [[direct_cause]] | |
1016 | else: |
|
1016 | else: | |
1017 | message = [[exception_during_handling]] |
|
1017 | message = [[exception_during_handling]] | |
1018 | return message |
|
1018 | return message | |
1019 |
|
1019 | |||
1020 | def prepare_header(self, etype, long_version=False): |
|
1020 | def prepare_header(self, etype, long_version=False): | |
1021 | colors = self.Colors # just a shorthand + quicker name lookup |
|
1021 | colors = self.Colors # just a shorthand + quicker name lookup | |
1022 | colorsnormal = colors.Normal # used a lot |
|
1022 | colorsnormal = colors.Normal # used a lot | |
1023 | exc = '%s%s%s' % (colors.excName, etype, colorsnormal) |
|
1023 | exc = '%s%s%s' % (colors.excName, etype, colorsnormal) | |
1024 | width = min(75, get_terminal_size()[0]) |
|
1024 | width = min(75, get_terminal_size()[0]) | |
1025 | if long_version: |
|
1025 | if long_version: | |
1026 | # Header with the exception type, python version, and date |
|
1026 | # Header with the exception type, python version, and date | |
1027 | pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable |
|
1027 | pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable | |
1028 | date = time.ctime(time.time()) |
|
1028 | date = time.ctime(time.time()) | |
1029 |
|
1029 | |||
1030 | head = '%s%s%s\n%s%s%s\n%s' % (colors.topline, '-' * width, colorsnormal, |
|
1030 | head = '%s%s%s\n%s%s%s\n%s' % (colors.topline, '-' * width, colorsnormal, | |
1031 | exc, ' ' * (width - len(str(etype)) - len(pyver)), |
|
1031 | exc, ' ' * (width - len(str(etype)) - len(pyver)), | |
1032 | pyver, date.rjust(width) ) |
|
1032 | pyver, date.rjust(width) ) | |
1033 | head += "\nA problem occurred executing Python code. Here is the sequence of function" \ |
|
1033 | head += "\nA problem occurred executing Python code. Here is the sequence of function" \ | |
1034 | "\ncalls leading up to the error, with the most recent (innermost) call last." |
|
1034 | "\ncalls leading up to the error, with the most recent (innermost) call last." | |
1035 | else: |
|
1035 | else: | |
1036 | # Simplified header |
|
1036 | # Simplified header | |
1037 | head = '%s%s' % (exc, 'Traceback (most recent call last)'. \ |
|
1037 | head = '%s%s' % (exc, 'Traceback (most recent call last)'. \ | |
1038 | rjust(width - len(str(etype))) ) |
|
1038 | rjust(width - len(str(etype))) ) | |
1039 |
|
1039 | |||
1040 | return head |
|
1040 | return head | |
1041 |
|
1041 | |||
1042 | def format_exception(self, etype, evalue): |
|
1042 | def format_exception(self, etype, evalue): | |
1043 | colors = self.Colors # just a shorthand + quicker name lookup |
|
1043 | colors = self.Colors # just a shorthand + quicker name lookup | |
1044 | colorsnormal = colors.Normal # used a lot |
|
1044 | colorsnormal = colors.Normal # used a lot | |
1045 | # Get (safely) a string form of the exception info |
|
1045 | # Get (safely) a string form of the exception info | |
1046 | try: |
|
1046 | try: | |
1047 | etype_str, evalue_str = map(str, (etype, evalue)) |
|
1047 | etype_str, evalue_str = map(str, (etype, evalue)) | |
1048 | except: |
|
1048 | except: | |
1049 | # User exception is improperly defined. |
|
1049 | # User exception is improperly defined. | |
1050 | etype, evalue = str, sys.exc_info()[:2] |
|
1050 | etype, evalue = str, sys.exc_info()[:2] | |
1051 | etype_str, evalue_str = map(str, (etype, evalue)) |
|
1051 | etype_str, evalue_str = map(str, (etype, evalue)) | |
1052 | # ... and format it |
|
1052 | # ... and format it | |
1053 | return ['%s%s%s: %s' % (colors.excName, etype_str, |
|
1053 | return ['%s%s%s: %s' % (colors.excName, etype_str, | |
1054 | colorsnormal, py3compat.cast_unicode(evalue_str))] |
|
1054 | colorsnormal, py3compat.cast_unicode(evalue_str))] | |
1055 |
|
1055 | |||
1056 | def format_exception_as_a_whole(self, etype, evalue, etb, number_of_lines_of_context, tb_offset): |
|
1056 | def format_exception_as_a_whole(self, etype, evalue, etb, number_of_lines_of_context, tb_offset): | |
1057 | """Formats the header, traceback and exception message for a single exception. |
|
1057 | """Formats the header, traceback and exception message for a single exception. | |
1058 |
|
1058 | |||
1059 | This may be called multiple times by Python 3 exception chaining |
|
1059 | This may be called multiple times by Python 3 exception chaining | |
1060 | (PEP 3134). |
|
1060 | (PEP 3134). | |
1061 | """ |
|
1061 | """ | |
1062 | # some locals |
|
1062 | # some locals | |
1063 | orig_etype = etype |
|
1063 | orig_etype = etype | |
1064 | try: |
|
1064 | try: | |
1065 | etype = etype.__name__ |
|
1065 | etype = etype.__name__ | |
1066 | except AttributeError: |
|
1066 | except AttributeError: | |
1067 | pass |
|
1067 | pass | |
1068 |
|
1068 | |||
1069 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
1069 | tb_offset = self.tb_offset if tb_offset is None else tb_offset | |
1070 | head = self.prepare_header(etype, self.long_header) |
|
1070 | head = self.prepare_header(etype, self.long_header) | |
1071 | records = self.get_records(etb, number_of_lines_of_context, tb_offset) |
|
1071 | records = self.get_records(etb, number_of_lines_of_context, tb_offset) | |
1072 |
|
1072 | |||
1073 | if records is None: |
|
1073 | if records is None: | |
1074 | return "" |
|
1074 | return "" | |
1075 |
|
1075 | |||
1076 | last_unique, recursion_repeat = find_recursion(orig_etype, evalue, records) |
|
1076 | last_unique, recursion_repeat = find_recursion(orig_etype, evalue, records) | |
1077 |
|
1077 | |||
1078 | frames = self.format_records(records, last_unique, recursion_repeat) |
|
1078 | frames = self.format_records(records, last_unique, recursion_repeat) | |
1079 |
|
1079 | |||
1080 | formatted_exception = self.format_exception(etype, evalue) |
|
1080 | formatted_exception = self.format_exception(etype, evalue) | |
1081 | if records: |
|
1081 | if records: | |
1082 | filepath, lnum = records[-1][1:3] |
|
1082 | filepath, lnum = records[-1][1:3] | |
1083 | filepath = os.path.abspath(filepath) |
|
1083 | filepath = os.path.abspath(filepath) | |
1084 | ipinst = get_ipython() |
|
1084 | ipinst = get_ipython() | |
1085 | if ipinst is not None: |
|
1085 | if ipinst is not None: | |
1086 | ipinst.hooks.synchronize_with_editor(filepath, lnum, 0) |
|
1086 | ipinst.hooks.synchronize_with_editor(filepath, lnum, 0) | |
1087 |
|
1087 | |||
1088 | return [[head] + frames + [''.join(formatted_exception[0])]] |
|
1088 | return [[head] + frames + [''.join(formatted_exception[0])]] | |
1089 |
|
1089 | |||
1090 | def get_records(self, etb, number_of_lines_of_context, tb_offset): |
|
1090 | def get_records(self, etb, number_of_lines_of_context, tb_offset): | |
1091 | try: |
|
1091 | try: | |
1092 | # Try the default getinnerframes and Alex's: Alex's fixes some |
|
1092 | # Try the default getinnerframes and Alex's: Alex's fixes some | |
1093 | # problems, but it generates empty tracebacks for console errors |
|
1093 | # problems, but it generates empty tracebacks for console errors | |
1094 | # (5 blanks lines) where none should be returned. |
|
1094 | # (5 blanks lines) where none should be returned. | |
1095 | return _fixed_getinnerframes(etb, number_of_lines_of_context, tb_offset) |
|
1095 | return _fixed_getinnerframes(etb, number_of_lines_of_context, tb_offset) | |
1096 | except UnicodeDecodeError: |
|
1096 | except UnicodeDecodeError: | |
1097 | # This can occur if a file's encoding magic comment is wrong. |
|
1097 | # This can occur if a file's encoding magic comment is wrong. | |
1098 | # I can't see a way to recover without duplicating a bunch of code |
|
1098 | # I can't see a way to recover without duplicating a bunch of code | |
1099 | # from the stdlib traceback module. --TK |
|
1099 | # from the stdlib traceback module. --TK | |
1100 | error('\nUnicodeDecodeError while processing traceback.\n') |
|
1100 | error('\nUnicodeDecodeError while processing traceback.\n') | |
1101 | return None |
|
1101 | return None | |
1102 | except: |
|
1102 | except: | |
1103 | # FIXME: I've been getting many crash reports from python 2.3 |
|
1103 | # FIXME: I've been getting many crash reports from python 2.3 | |
1104 | # users, traceable to inspect.py. If I can find a small test-case |
|
1104 | # users, traceable to inspect.py. If I can find a small test-case | |
1105 | # to reproduce this, I should either write a better workaround or |
|
1105 | # to reproduce this, I should either write a better workaround or | |
1106 | # file a bug report against inspect (if that's the real problem). |
|
1106 | # file a bug report against inspect (if that's the real problem). | |
1107 | # So far, I haven't been able to find an isolated example to |
|
1107 | # So far, I haven't been able to find an isolated example to | |
1108 | # reproduce the problem. |
|
1108 | # reproduce the problem. | |
1109 | inspect_error() |
|
1109 | inspect_error() | |
1110 | traceback.print_exc(file=self.ostream) |
|
1110 | traceback.print_exc(file=self.ostream) | |
1111 | info('\nUnfortunately, your original traceback can not be constructed.\n') |
|
1111 | info('\nUnfortunately, your original traceback can not be constructed.\n') | |
1112 | return None |
|
1112 | return None | |
1113 |
|
1113 | |||
1114 | def get_parts_of_chained_exception(self, evalue): |
|
1114 | def get_parts_of_chained_exception(self, evalue): | |
1115 | def get_chained_exception(exception_value): |
|
1115 | def get_chained_exception(exception_value): | |
1116 | cause = getattr(exception_value, '__cause__', None) |
|
1116 | cause = getattr(exception_value, '__cause__', None) | |
1117 | if cause: |
|
1117 | if cause: | |
1118 | return cause |
|
1118 | return cause | |
1119 | if getattr(exception_value, '__suppress_context__', False): |
|
1119 | if getattr(exception_value, '__suppress_context__', False): | |
1120 | return None |
|
1120 | return None | |
1121 | return getattr(exception_value, '__context__', None) |
|
1121 | return getattr(exception_value, '__context__', None) | |
1122 |
|
1122 | |||
1123 | chained_evalue = get_chained_exception(evalue) |
|
1123 | chained_evalue = get_chained_exception(evalue) | |
1124 |
|
1124 | |||
1125 | if chained_evalue: |
|
1125 | if chained_evalue: | |
1126 | return chained_evalue.__class__, chained_evalue, chained_evalue.__traceback__ |
|
1126 | return chained_evalue.__class__, chained_evalue, chained_evalue.__traceback__ | |
1127 |
|
1127 | |||
1128 | def structured_traceback(self, etype, evalue, etb, tb_offset=None, |
|
1128 | def structured_traceback(self, etype, evalue, etb, tb_offset=None, | |
1129 | number_of_lines_of_context=5): |
|
1129 | number_of_lines_of_context=5): | |
1130 | """Return a nice text document describing the traceback.""" |
|
1130 | """Return a nice text document describing the traceback.""" | |
1131 |
|
1131 | |||
1132 | formatted_exception = self.format_exception_as_a_whole(etype, evalue, etb, number_of_lines_of_context, |
|
1132 | formatted_exception = self.format_exception_as_a_whole(etype, evalue, etb, number_of_lines_of_context, | |
1133 | tb_offset) |
|
1133 | tb_offset) | |
1134 |
|
1134 | |||
1135 | colors = self.Colors # just a shorthand + quicker name lookup |
|
1135 | colors = self.Colors # just a shorthand + quicker name lookup | |
1136 | colorsnormal = colors.Normal # used a lot |
|
1136 | colorsnormal = colors.Normal # used a lot | |
1137 | head = '%s%s%s' % (colors.topline, '-' * min(75, get_terminal_size()[0]), colorsnormal) |
|
1137 | head = '%s%s%s' % (colors.topline, '-' * min(75, get_terminal_size()[0]), colorsnormal) | |
1138 | structured_traceback_parts = [head] |
|
1138 | structured_traceback_parts = [head] | |
1139 | chained_exceptions_tb_offset = 0 |
|
1139 | chained_exceptions_tb_offset = 0 | |
1140 | lines_of_context = 3 |
|
1140 | lines_of_context = 3 | |
1141 | formatted_exceptions = formatted_exception |
|
1141 | formatted_exceptions = formatted_exception | |
1142 | exception = self.get_parts_of_chained_exception(evalue) |
|
1142 | exception = self.get_parts_of_chained_exception(evalue) | |
1143 | if exception: |
|
1143 | if exception: | |
1144 | formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__) |
|
1144 | formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__) | |
1145 | etype, evalue, etb = exception |
|
1145 | etype, evalue, etb = exception | |
1146 | else: |
|
1146 | else: | |
1147 | evalue = None |
|
1147 | evalue = None | |
1148 | chained_exc_ids = set() |
|
1148 | chained_exc_ids = set() | |
1149 | while evalue: |
|
1149 | while evalue: | |
1150 | formatted_exceptions += self.format_exception_as_a_whole(etype, evalue, etb, lines_of_context, |
|
1150 | formatted_exceptions += self.format_exception_as_a_whole(etype, evalue, etb, lines_of_context, | |
1151 | chained_exceptions_tb_offset) |
|
1151 | chained_exceptions_tb_offset) | |
1152 | exception = self.get_parts_of_chained_exception(evalue) |
|
1152 | exception = self.get_parts_of_chained_exception(evalue) | |
1153 |
|
1153 | |||
1154 | if exception and not id(exception[1]) in chained_exc_ids: |
|
1154 | if exception and not id(exception[1]) in chained_exc_ids: | |
1155 | chained_exc_ids.add(id(exception[1])) # trace exception to avoid infinite 'cause' loop |
|
1155 | chained_exc_ids.add(id(exception[1])) # trace exception to avoid infinite 'cause' loop | |
1156 | formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__) |
|
1156 | formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__) | |
1157 | etype, evalue, etb = exception |
|
1157 | etype, evalue, etb = exception | |
1158 | else: |
|
1158 | else: | |
1159 | evalue = None |
|
1159 | evalue = None | |
1160 |
|
1160 | |||
1161 | # we want to see exceptions in a reversed order: |
|
1161 | # we want to see exceptions in a reversed order: | |
1162 | # the first exception should be on top |
|
1162 | # the first exception should be on top | |
1163 | for formatted_exception in reversed(formatted_exceptions): |
|
1163 | for formatted_exception in reversed(formatted_exceptions): | |
1164 | structured_traceback_parts += formatted_exception |
|
1164 | structured_traceback_parts += formatted_exception | |
1165 |
|
1165 | |||
1166 | return structured_traceback_parts |
|
1166 | return structured_traceback_parts | |
1167 |
|
1167 | |||
1168 | def debugger(self, force=False): |
|
1168 | def debugger(self, force=False): | |
1169 | """Call up the pdb debugger if desired, always clean up the tb |
|
1169 | """Call up the pdb debugger if desired, always clean up the tb | |
1170 | reference. |
|
1170 | reference. | |
1171 |
|
1171 | |||
1172 | Keywords: |
|
1172 | Keywords: | |
1173 |
|
1173 | |||
1174 | - force(False): by default, this routine checks the instance call_pdb |
|
1174 | - force(False): by default, this routine checks the instance call_pdb | |
1175 | flag and does not actually invoke the debugger if the flag is false. |
|
1175 | flag and does not actually invoke the debugger if the flag is false. | |
1176 | The 'force' option forces the debugger to activate even if the flag |
|
1176 | The 'force' option forces the debugger to activate even if the flag | |
1177 | is false. |
|
1177 | is false. | |
1178 |
|
1178 | |||
1179 | If the call_pdb flag is set, the pdb interactive debugger is |
|
1179 | If the call_pdb flag is set, the pdb interactive debugger is | |
1180 | invoked. In all cases, the self.tb reference to the current traceback |
|
1180 | invoked. In all cases, the self.tb reference to the current traceback | |
1181 | is deleted to prevent lingering references which hamper memory |
|
1181 | is deleted to prevent lingering references which hamper memory | |
1182 | management. |
|
1182 | management. | |
1183 |
|
1183 | |||
1184 | Note that each call to pdb() does an 'import readline', so if your app |
|
1184 | Note that each call to pdb() does an 'import readline', so if your app | |
1185 | requires a special setup for the readline completers, you'll have to |
|
1185 | requires a special setup for the readline completers, you'll have to | |
1186 | fix that by hand after invoking the exception handler.""" |
|
1186 | fix that by hand after invoking the exception handler.""" | |
1187 |
|
1187 | |||
1188 | if force or self.call_pdb: |
|
1188 | if force or self.call_pdb: | |
1189 | if self.pdb is None: |
|
1189 | if self.pdb is None: | |
1190 | self.pdb = self.debugger_cls() |
|
1190 | self.pdb = self.debugger_cls() | |
1191 | # the system displayhook may have changed, restore the original |
|
1191 | # the system displayhook may have changed, restore the original | |
1192 | # for pdb |
|
1192 | # for pdb | |
1193 | display_trap = DisplayTrap(hook=sys.__displayhook__) |
|
1193 | display_trap = DisplayTrap(hook=sys.__displayhook__) | |
1194 | with display_trap: |
|
1194 | with display_trap: | |
1195 | self.pdb.reset() |
|
1195 | self.pdb.reset() | |
1196 | # Find the right frame so we don't pop up inside ipython itself |
|
1196 | # Find the right frame so we don't pop up inside ipython itself | |
1197 | if hasattr(self, 'tb') and self.tb is not None: |
|
1197 | if hasattr(self, 'tb') and self.tb is not None: | |
1198 | etb = self.tb |
|
1198 | etb = self.tb | |
1199 | else: |
|
1199 | else: | |
1200 | etb = self.tb = sys.last_traceback |
|
1200 | etb = self.tb = sys.last_traceback | |
1201 | while self.tb is not None and self.tb.tb_next is not None: |
|
1201 | while self.tb is not None and self.tb.tb_next is not None: | |
1202 | self.tb = self.tb.tb_next |
|
1202 | self.tb = self.tb.tb_next | |
1203 | if etb and etb.tb_next: |
|
1203 | if etb and etb.tb_next: | |
1204 | etb = etb.tb_next |
|
1204 | etb = etb.tb_next | |
1205 | self.pdb.botframe = etb.tb_frame |
|
1205 | self.pdb.botframe = etb.tb_frame | |
1206 | self.pdb.interaction(None, etb) |
|
1206 | self.pdb.interaction(None, etb) | |
1207 |
|
1207 | |||
1208 | if hasattr(self, 'tb'): |
|
1208 | if hasattr(self, 'tb'): | |
1209 | del self.tb |
|
1209 | del self.tb | |
1210 |
|
1210 | |||
1211 | def handler(self, info=None): |
|
1211 | def handler(self, info=None): | |
1212 | (etype, evalue, etb) = info or sys.exc_info() |
|
1212 | (etype, evalue, etb) = info or sys.exc_info() | |
1213 | self.tb = etb |
|
1213 | self.tb = etb | |
1214 | ostream = self.ostream |
|
1214 | ostream = self.ostream | |
1215 | ostream.flush() |
|
1215 | ostream.flush() | |
1216 | ostream.write(self.text(etype, evalue, etb)) |
|
1216 | ostream.write(self.text(etype, evalue, etb)) | |
1217 | ostream.write('\n') |
|
1217 | ostream.write('\n') | |
1218 | ostream.flush() |
|
1218 | ostream.flush() | |
1219 |
|
1219 | |||
1220 | # Changed so an instance can just be called as VerboseTB_inst() and print |
|
1220 | # Changed so an instance can just be called as VerboseTB_inst() and print | |
1221 | # out the right info on its own. |
|
1221 | # out the right info on its own. | |
1222 | def __call__(self, etype=None, evalue=None, etb=None): |
|
1222 | def __call__(self, etype=None, evalue=None, etb=None): | |
1223 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" |
|
1223 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" | |
1224 | if etb is None: |
|
1224 | if etb is None: | |
1225 | self.handler() |
|
1225 | self.handler() | |
1226 | else: |
|
1226 | else: | |
1227 | self.handler((etype, evalue, etb)) |
|
1227 | self.handler((etype, evalue, etb)) | |
1228 | try: |
|
1228 | try: | |
1229 | self.debugger() |
|
1229 | self.debugger() | |
1230 | except KeyboardInterrupt: |
|
1230 | except KeyboardInterrupt: | |
1231 | print("\nKeyboardInterrupt") |
|
1231 | print("\nKeyboardInterrupt") | |
1232 |
|
1232 | |||
1233 |
|
1233 | |||
1234 | #---------------------------------------------------------------------------- |
|
1234 | #---------------------------------------------------------------------------- | |
1235 | class FormattedTB(VerboseTB, ListTB): |
|
1235 | class FormattedTB(VerboseTB, ListTB): | |
1236 | """Subclass ListTB but allow calling with a traceback. |
|
1236 | """Subclass ListTB but allow calling with a traceback. | |
1237 |
|
1237 | |||
1238 | It can thus be used as a sys.excepthook for Python > 2.1. |
|
1238 | It can thus be used as a sys.excepthook for Python > 2.1. | |
1239 |
|
1239 | |||
1240 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. |
|
1240 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. | |
1241 |
|
1241 | |||
1242 | Allows a tb_offset to be specified. This is useful for situations where |
|
1242 | Allows a tb_offset to be specified. This is useful for situations where | |
1243 | one needs to remove a number of topmost frames from the traceback (such as |
|
1243 | one needs to remove a number of topmost frames from the traceback (such as | |
1244 | occurs with python programs that themselves execute other python code, |
|
1244 | occurs with python programs that themselves execute other python code, | |
1245 | like Python shells). """ |
|
1245 | like Python shells). """ | |
1246 |
|
1246 | |||
1247 | def __init__(self, mode='Plain', color_scheme='Linux', call_pdb=False, |
|
1247 | def __init__(self, mode='Plain', color_scheme='Linux', call_pdb=False, | |
1248 | ostream=None, |
|
1248 | ostream=None, | |
1249 | tb_offset=0, long_header=False, include_vars=False, |
|
1249 | tb_offset=0, long_header=False, include_vars=False, | |
1250 | check_cache=None, debugger_cls=None, |
|
1250 | check_cache=None, debugger_cls=None, | |
1251 | parent=None, config=None): |
|
1251 | parent=None, config=None): | |
1252 |
|
1252 | |||
1253 | # NEVER change the order of this list. Put new modes at the end: |
|
1253 | # NEVER change the order of this list. Put new modes at the end: | |
1254 | self.valid_modes = ['Plain', 'Context', 'Verbose'] |
|
1254 | self.valid_modes = ['Plain', 'Context', 'Verbose', 'Minimal'] | |
1255 | self.verbose_modes = self.valid_modes[1:3] |
|
1255 | self.verbose_modes = self.valid_modes[1:3] | |
1256 |
|
1256 | |||
1257 | VerboseTB.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
1257 | VerboseTB.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, | |
1258 | ostream=ostream, tb_offset=tb_offset, |
|
1258 | ostream=ostream, tb_offset=tb_offset, | |
1259 | long_header=long_header, include_vars=include_vars, |
|
1259 | long_header=long_header, include_vars=include_vars, | |
1260 | check_cache=check_cache, debugger_cls=debugger_cls, |
|
1260 | check_cache=check_cache, debugger_cls=debugger_cls, | |
1261 | parent=parent, config=config) |
|
1261 | parent=parent, config=config) | |
1262 |
|
1262 | |||
1263 | # Different types of tracebacks are joined with different separators to |
|
1263 | # Different types of tracebacks are joined with different separators to | |
1264 | # form a single string. They are taken from this dict |
|
1264 | # form a single string. They are taken from this dict | |
1265 |
self._join_chars = dict(Plain='', Context='\n', Verbose='\n' |
|
1265 | self._join_chars = dict(Plain='', Context='\n', Verbose='\n', | |
|
1266 | Minimal='') | |||
1266 | # set_mode also sets the tb_join_char attribute |
|
1267 | # set_mode also sets the tb_join_char attribute | |
1267 | self.set_mode(mode) |
|
1268 | self.set_mode(mode) | |
1268 |
|
1269 | |||
1269 | def _extract_tb(self, tb): |
|
1270 | def _extract_tb(self, tb): | |
1270 | if tb: |
|
1271 | if tb: | |
1271 | return traceback.extract_tb(tb) |
|
1272 | return traceback.extract_tb(tb) | |
1272 | else: |
|
1273 | else: | |
1273 | return None |
|
1274 | return None | |
1274 |
|
1275 | |||
1275 | def structured_traceback(self, etype, value, tb, tb_offset=None, number_of_lines_of_context=5): |
|
1276 | def structured_traceback(self, etype, value, tb, tb_offset=None, number_of_lines_of_context=5): | |
1276 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
1277 | tb_offset = self.tb_offset if tb_offset is None else tb_offset | |
1277 | mode = self.mode |
|
1278 | mode = self.mode | |
1278 | if mode in self.verbose_modes: |
|
1279 | if mode in self.verbose_modes: | |
1279 | # Verbose modes need a full traceback |
|
1280 | # Verbose modes need a full traceback | |
1280 | return VerboseTB.structured_traceback( |
|
1281 | return VerboseTB.structured_traceback( | |
1281 | self, etype, value, tb, tb_offset, number_of_lines_of_context |
|
1282 | self, etype, value, tb, tb_offset, number_of_lines_of_context | |
1282 | ) |
|
1283 | ) | |
|
1284 | elif mode == 'Minimal': | |||
|
1285 | return ListTB.get_exception_only(self, etype, value) | |||
1283 | else: |
|
1286 | else: | |
1284 | # We must check the source cache because otherwise we can print |
|
1287 | # We must check the source cache because otherwise we can print | |
1285 | # out-of-date source code. |
|
1288 | # out-of-date source code. | |
1286 | self.check_cache() |
|
1289 | self.check_cache() | |
1287 | # Now we can extract and format the exception |
|
1290 | # Now we can extract and format the exception | |
1288 | elist = self._extract_tb(tb) |
|
1291 | elist = self._extract_tb(tb) | |
1289 | return ListTB.structured_traceback( |
|
1292 | return ListTB.structured_traceback( | |
1290 | self, etype, value, elist, tb_offset, number_of_lines_of_context |
|
1293 | self, etype, value, elist, tb_offset, number_of_lines_of_context | |
1291 | ) |
|
1294 | ) | |
1292 |
|
1295 | |||
1293 | def stb2text(self, stb): |
|
1296 | def stb2text(self, stb): | |
1294 | """Convert a structured traceback (a list) to a string.""" |
|
1297 | """Convert a structured traceback (a list) to a string.""" | |
1295 | return self.tb_join_char.join(stb) |
|
1298 | return self.tb_join_char.join(stb) | |
1296 |
|
1299 | |||
1297 |
|
1300 | |||
1298 | def set_mode(self, mode=None): |
|
1301 | def set_mode(self, mode=None): | |
1299 | """Switch to the desired mode. |
|
1302 | """Switch to the desired mode. | |
1300 |
|
1303 | |||
1301 | If mode is not specified, cycles through the available modes.""" |
|
1304 | If mode is not specified, cycles through the available modes.""" | |
1302 |
|
1305 | |||
1303 | if not mode: |
|
1306 | if not mode: | |
1304 | new_idx = (self.valid_modes.index(self.mode) + 1 ) % \ |
|
1307 | new_idx = (self.valid_modes.index(self.mode) + 1 ) % \ | |
1305 | len(self.valid_modes) |
|
1308 | len(self.valid_modes) | |
1306 | self.mode = self.valid_modes[new_idx] |
|
1309 | self.mode = self.valid_modes[new_idx] | |
1307 | elif mode not in self.valid_modes: |
|
1310 | elif mode not in self.valid_modes: | |
1308 | raise ValueError('Unrecognized mode in FormattedTB: <' + mode + '>\n' |
|
1311 | raise ValueError('Unrecognized mode in FormattedTB: <' + mode + '>\n' | |
1309 | 'Valid modes: ' + str(self.valid_modes)) |
|
1312 | 'Valid modes: ' + str(self.valid_modes)) | |
1310 | else: |
|
1313 | else: | |
1311 | self.mode = mode |
|
1314 | self.mode = mode | |
1312 | # include variable details only in 'Verbose' mode |
|
1315 | # include variable details only in 'Verbose' mode | |
1313 | self.include_vars = (self.mode == self.valid_modes[2]) |
|
1316 | self.include_vars = (self.mode == self.valid_modes[2]) | |
1314 | # Set the join character for generating text tracebacks |
|
1317 | # Set the join character for generating text tracebacks | |
1315 | self.tb_join_char = self._join_chars[self.mode] |
|
1318 | self.tb_join_char = self._join_chars[self.mode] | |
1316 |
|
1319 | |||
1317 | # some convenient shortcuts |
|
1320 | # some convenient shortcuts | |
1318 | def plain(self): |
|
1321 | def plain(self): | |
1319 | self.set_mode(self.valid_modes[0]) |
|
1322 | self.set_mode(self.valid_modes[0]) | |
1320 |
|
1323 | |||
1321 | def context(self): |
|
1324 | def context(self): | |
1322 | self.set_mode(self.valid_modes[1]) |
|
1325 | self.set_mode(self.valid_modes[1]) | |
1323 |
|
1326 | |||
1324 | def verbose(self): |
|
1327 | def verbose(self): | |
1325 | self.set_mode(self.valid_modes[2]) |
|
1328 | self.set_mode(self.valid_modes[2]) | |
1326 |
|
1329 | |||
|
1330 | def minimal(self): | |||
|
1331 | self.set_mode(self.valid_modes[3]) | |||
|
1332 | ||||
1327 |
|
1333 | |||
1328 | #---------------------------------------------------------------------------- |
|
1334 | #---------------------------------------------------------------------------- | |
1329 | class AutoFormattedTB(FormattedTB): |
|
1335 | class AutoFormattedTB(FormattedTB): | |
1330 | """A traceback printer which can be called on the fly. |
|
1336 | """A traceback printer which can be called on the fly. | |
1331 |
|
1337 | |||
1332 | It will find out about exceptions by itself. |
|
1338 | It will find out about exceptions by itself. | |
1333 |
|
1339 | |||
1334 | A brief example:: |
|
1340 | A brief example:: | |
1335 |
|
1341 | |||
1336 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') |
|
1342 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') | |
1337 | try: |
|
1343 | try: | |
1338 | ... |
|
1344 | ... | |
1339 | except: |
|
1345 | except: | |
1340 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object |
|
1346 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object | |
1341 | """ |
|
1347 | """ | |
1342 |
|
1348 | |||
1343 | def __call__(self, etype=None, evalue=None, etb=None, |
|
1349 | def __call__(self, etype=None, evalue=None, etb=None, | |
1344 | out=None, tb_offset=None): |
|
1350 | out=None, tb_offset=None): | |
1345 | """Print out a formatted exception traceback. |
|
1351 | """Print out a formatted exception traceback. | |
1346 |
|
1352 | |||
1347 | Optional arguments: |
|
1353 | Optional arguments: | |
1348 | - out: an open file-like object to direct output to. |
|
1354 | - out: an open file-like object to direct output to. | |
1349 |
|
1355 | |||
1350 | - tb_offset: the number of frames to skip over in the stack, on a |
|
1356 | - tb_offset: the number of frames to skip over in the stack, on a | |
1351 | per-call basis (this overrides temporarily the instance's tb_offset |
|
1357 | per-call basis (this overrides temporarily the instance's tb_offset | |
1352 | given at initialization time. """ |
|
1358 | given at initialization time. """ | |
1353 |
|
1359 | |||
1354 | if out is None: |
|
1360 | if out is None: | |
1355 | out = self.ostream |
|
1361 | out = self.ostream | |
1356 | out.flush() |
|
1362 | out.flush() | |
1357 | out.write(self.text(etype, evalue, etb, tb_offset)) |
|
1363 | out.write(self.text(etype, evalue, etb, tb_offset)) | |
1358 | out.write('\n') |
|
1364 | out.write('\n') | |
1359 | out.flush() |
|
1365 | out.flush() | |
1360 | # FIXME: we should remove the auto pdb behavior from here and leave |
|
1366 | # FIXME: we should remove the auto pdb behavior from here and leave | |
1361 | # that to the clients. |
|
1367 | # that to the clients. | |
1362 | try: |
|
1368 | try: | |
1363 | self.debugger() |
|
1369 | self.debugger() | |
1364 | except KeyboardInterrupt: |
|
1370 | except KeyboardInterrupt: | |
1365 | print("\nKeyboardInterrupt") |
|
1371 | print("\nKeyboardInterrupt") | |
1366 |
|
1372 | |||
1367 | def structured_traceback(self, etype=None, value=None, tb=None, |
|
1373 | def structured_traceback(self, etype=None, value=None, tb=None, | |
1368 | tb_offset=None, number_of_lines_of_context=5): |
|
1374 | tb_offset=None, number_of_lines_of_context=5): | |
1369 | if etype is None: |
|
1375 | if etype is None: | |
1370 | etype, value, tb = sys.exc_info() |
|
1376 | etype, value, tb = sys.exc_info() | |
1371 | self.tb = tb |
|
1377 | self.tb = tb | |
1372 | return FormattedTB.structured_traceback( |
|
1378 | return FormattedTB.structured_traceback( | |
1373 | self, etype, value, tb, tb_offset, number_of_lines_of_context) |
|
1379 | self, etype, value, tb, tb_offset, number_of_lines_of_context) | |
1374 |
|
1380 | |||
1375 |
|
1381 | |||
1376 | #--------------------------------------------------------------------------- |
|
1382 | #--------------------------------------------------------------------------- | |
1377 |
|
1383 | |||
1378 | # A simple class to preserve Nathan's original functionality. |
|
1384 | # A simple class to preserve Nathan's original functionality. | |
1379 | class ColorTB(FormattedTB): |
|
1385 | class ColorTB(FormattedTB): | |
1380 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" |
|
1386 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" | |
1381 |
|
1387 | |||
1382 | def __init__(self, color_scheme='Linux', call_pdb=0, **kwargs): |
|
1388 | def __init__(self, color_scheme='Linux', call_pdb=0, **kwargs): | |
1383 | FormattedTB.__init__(self, color_scheme=color_scheme, |
|
1389 | FormattedTB.__init__(self, color_scheme=color_scheme, | |
1384 | call_pdb=call_pdb, **kwargs) |
|
1390 | call_pdb=call_pdb, **kwargs) | |
1385 |
|
1391 | |||
1386 |
|
1392 | |||
1387 | class SyntaxTB(ListTB): |
|
1393 | class SyntaxTB(ListTB): | |
1388 | """Extension which holds some state: the last exception value""" |
|
1394 | """Extension which holds some state: the last exception value""" | |
1389 |
|
1395 | |||
1390 | def __init__(self, color_scheme='NoColor', parent=None, config=None): |
|
1396 | def __init__(self, color_scheme='NoColor', parent=None, config=None): | |
1391 | ListTB.__init__(self, color_scheme, parent=parent, config=config) |
|
1397 | ListTB.__init__(self, color_scheme, parent=parent, config=config) | |
1392 | self.last_syntax_error = None |
|
1398 | self.last_syntax_error = None | |
1393 |
|
1399 | |||
1394 | def __call__(self, etype, value, elist): |
|
1400 | def __call__(self, etype, value, elist): | |
1395 | self.last_syntax_error = value |
|
1401 | self.last_syntax_error = value | |
1396 |
|
1402 | |||
1397 | ListTB.__call__(self, etype, value, elist) |
|
1403 | ListTB.__call__(self, etype, value, elist) | |
1398 |
|
1404 | |||
1399 | def structured_traceback(self, etype, value, elist, tb_offset=None, |
|
1405 | def structured_traceback(self, etype, value, elist, tb_offset=None, | |
1400 | context=5): |
|
1406 | context=5): | |
1401 | # If the source file has been edited, the line in the syntax error can |
|
1407 | # If the source file has been edited, the line in the syntax error can | |
1402 | # be wrong (retrieved from an outdated cache). This replaces it with |
|
1408 | # be wrong (retrieved from an outdated cache). This replaces it with | |
1403 | # the current value. |
|
1409 | # the current value. | |
1404 | if isinstance(value, SyntaxError) \ |
|
1410 | if isinstance(value, SyntaxError) \ | |
1405 | and isinstance(value.filename, str) \ |
|
1411 | and isinstance(value.filename, str) \ | |
1406 | and isinstance(value.lineno, int): |
|
1412 | and isinstance(value.lineno, int): | |
1407 | linecache.checkcache(value.filename) |
|
1413 | linecache.checkcache(value.filename) | |
1408 | newtext = linecache.getline(value.filename, value.lineno) |
|
1414 | newtext = linecache.getline(value.filename, value.lineno) | |
1409 | if newtext: |
|
1415 | if newtext: | |
1410 | value.text = newtext |
|
1416 | value.text = newtext | |
1411 | self.last_syntax_error = value |
|
1417 | self.last_syntax_error = value | |
1412 | return super(SyntaxTB, self).structured_traceback(etype, value, elist, |
|
1418 | return super(SyntaxTB, self).structured_traceback(etype, value, elist, | |
1413 | tb_offset=tb_offset, context=context) |
|
1419 | tb_offset=tb_offset, context=context) | |
1414 |
|
1420 | |||
1415 | def clear_err_state(self): |
|
1421 | def clear_err_state(self): | |
1416 | """Return the current error state and clear it""" |
|
1422 | """Return the current error state and clear it""" | |
1417 | e = self.last_syntax_error |
|
1423 | e = self.last_syntax_error | |
1418 | self.last_syntax_error = None |
|
1424 | self.last_syntax_error = None | |
1419 | return e |
|
1425 | return e | |
1420 |
|
1426 | |||
1421 | def stb2text(self, stb): |
|
1427 | def stb2text(self, stb): | |
1422 | """Convert a structured traceback (a list) to a string.""" |
|
1428 | """Convert a structured traceback (a list) to a string.""" | |
1423 | return ''.join(stb) |
|
1429 | return ''.join(stb) | |
1424 |
|
1430 | |||
1425 |
|
1431 | |||
1426 | # some internal-use functions |
|
1432 | # some internal-use functions | |
1427 | def text_repr(value): |
|
1433 | def text_repr(value): | |
1428 | """Hopefully pretty robust repr equivalent.""" |
|
1434 | """Hopefully pretty robust repr equivalent.""" | |
1429 | # this is pretty horrible but should always return *something* |
|
1435 | # this is pretty horrible but should always return *something* | |
1430 | try: |
|
1436 | try: | |
1431 | return pydoc.text.repr(value) |
|
1437 | return pydoc.text.repr(value) | |
1432 | except KeyboardInterrupt: |
|
1438 | except KeyboardInterrupt: | |
1433 | raise |
|
1439 | raise | |
1434 | except: |
|
1440 | except: | |
1435 | try: |
|
1441 | try: | |
1436 | return repr(value) |
|
1442 | return repr(value) | |
1437 | except KeyboardInterrupt: |
|
1443 | except KeyboardInterrupt: | |
1438 | raise |
|
1444 | raise | |
1439 | except: |
|
1445 | except: | |
1440 | try: |
|
1446 | try: | |
1441 | # all still in an except block so we catch |
|
1447 | # all still in an except block so we catch | |
1442 | # getattr raising |
|
1448 | # getattr raising | |
1443 | name = getattr(value, '__name__', None) |
|
1449 | name = getattr(value, '__name__', None) | |
1444 | if name: |
|
1450 | if name: | |
1445 | # ick, recursion |
|
1451 | # ick, recursion | |
1446 | return text_repr(name) |
|
1452 | return text_repr(name) | |
1447 | klass = getattr(value, '__class__', None) |
|
1453 | klass = getattr(value, '__class__', None) | |
1448 | if klass: |
|
1454 | if klass: | |
1449 | return '%s instance' % text_repr(klass) |
|
1455 | return '%s instance' % text_repr(klass) | |
1450 | except KeyboardInterrupt: |
|
1456 | except KeyboardInterrupt: | |
1451 | raise |
|
1457 | raise | |
1452 | except: |
|
1458 | except: | |
1453 | return 'UNRECOVERABLE REPR FAILURE' |
|
1459 | return 'UNRECOVERABLE REPR FAILURE' | |
1454 |
|
1460 | |||
1455 |
|
1461 | |||
1456 | def eqrepr(value, repr=text_repr): |
|
1462 | def eqrepr(value, repr=text_repr): | |
1457 | return '=%s' % repr(value) |
|
1463 | return '=%s' % repr(value) | |
1458 |
|
1464 | |||
1459 |
|
1465 | |||
1460 | def nullrepr(value, repr=text_repr): |
|
1466 | def nullrepr(value, repr=text_repr): | |
1461 | return '' |
|
1467 | return '' |
General Comments 0
You need to be logged in to leave comments.
Login now