Show More
The requested changes are too big and content was truncated. Show full diff
@@ -1,2676 +1,2715 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 | # Imports |
|
14 | # Imports | |
15 | #----------------------------------------------------------------------------- |
|
15 | #----------------------------------------------------------------------------- | |
16 |
|
16 | |||
17 | from __future__ import with_statement |
|
17 | from __future__ import with_statement | |
18 | from __future__ import absolute_import |
|
18 | from __future__ import absolute_import | |
19 |
|
19 | |||
20 | import __builtin__ as builtin_mod |
|
20 | import __builtin__ as builtin_mod | |
21 | import __future__ |
|
21 | import __future__ | |
22 | import abc |
|
22 | import abc | |
23 | import ast |
|
23 | import ast | |
24 | import atexit |
|
24 | import atexit | |
25 | import codeop |
|
25 | import codeop | |
26 | import inspect |
|
26 | import inspect | |
27 | import os |
|
27 | import os | |
28 | import re |
|
28 | import re | |
29 | import sys |
|
29 | import sys | |
30 | import tempfile |
|
30 | import tempfile | |
31 | import types |
|
31 | import types | |
32 |
|
32 | |||
33 | try: |
|
33 | try: | |
34 | from contextlib import nested |
|
34 | from contextlib import nested | |
35 | except: |
|
35 | except: | |
36 | from IPython.utils.nested_context import nested |
|
36 | from IPython.utils.nested_context import nested | |
37 |
|
37 | |||
38 | from IPython.config.configurable import SingletonConfigurable |
|
38 | from IPython.config.configurable import SingletonConfigurable | |
39 | from IPython.core import debugger, oinspect |
|
39 | from IPython.core import debugger, oinspect | |
40 | from IPython.core import history as ipcorehist |
|
40 | from IPython.core import history as ipcorehist | |
41 | from IPython.core import page |
|
41 | from IPython.core import page | |
42 | from IPython.core import prefilter |
|
42 | from IPython.core import prefilter | |
43 | from IPython.core import shadowns |
|
43 | from IPython.core import shadowns | |
44 | from IPython.core import ultratb |
|
44 | from IPython.core import ultratb | |
45 | from IPython.core.alias import AliasManager, AliasError |
|
45 | from IPython.core.alias import AliasManager, AliasError | |
46 | from IPython.core.autocall import ExitAutocall |
|
46 | from IPython.core.autocall import ExitAutocall | |
47 | from IPython.core.builtin_trap import BuiltinTrap |
|
47 | from IPython.core.builtin_trap import BuiltinTrap | |
48 | from IPython.core.compilerop import CachingCompiler |
|
48 | from IPython.core.compilerop import CachingCompiler | |
49 | from IPython.core.display_trap import DisplayTrap |
|
49 | from IPython.core.display_trap import DisplayTrap | |
50 | from IPython.core.displayhook import DisplayHook |
|
50 | from IPython.core.displayhook import DisplayHook | |
51 | from IPython.core.displaypub import DisplayPublisher |
|
51 | from IPython.core.displaypub import DisplayPublisher | |
52 | from IPython.core.error import TryNext, UsageError |
|
52 | from IPython.core.error import TryNext, UsageError | |
53 | from IPython.core.extensions import ExtensionManager |
|
53 | from IPython.core.extensions import ExtensionManager | |
54 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict |
|
54 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict | |
55 | from IPython.core.formatters import DisplayFormatter |
|
55 | from IPython.core.formatters import DisplayFormatter | |
56 | from IPython.core.history import HistoryManager |
|
56 | from IPython.core.history import HistoryManager | |
57 | from IPython.core.inputsplitter import IPythonInputSplitter |
|
57 | from IPython.core.inputsplitter import IPythonInputSplitter | |
58 | from IPython.core.logger import Logger |
|
58 | from IPython.core.logger import Logger | |
59 | from IPython.core.macro import Macro |
|
59 | from IPython.core.macro import Macro | |
60 | from IPython.core.magic import Magic |
|
60 | from IPython.core.magic import Magic | |
61 | from IPython.core.payload import PayloadManager |
|
61 | from IPython.core.payload import PayloadManager | |
62 | from IPython.core.plugin import PluginManager |
|
62 | from IPython.core.plugin import PluginManager | |
63 | from IPython.core.prefilter import PrefilterManager, ESC_MAGIC |
|
63 | from IPython.core.prefilter import PrefilterManager, ESC_MAGIC | |
64 | from IPython.core.profiledir import ProfileDir |
|
64 | from IPython.core.profiledir import ProfileDir | |
|
65 | from IPython.core.pylabtools import pylab_activate | |||
65 | from IPython.external.Itpl import ItplNS |
|
66 | from IPython.external.Itpl import ItplNS | |
66 | from IPython.utils import PyColorize |
|
67 | from IPython.utils import PyColorize | |
67 | from IPython.utils import io |
|
68 | from IPython.utils import io | |
68 | from IPython.utils import py3compat |
|
69 | from IPython.utils import py3compat | |
69 | from IPython.utils.doctestreload import doctest_reload |
|
70 | from IPython.utils.doctestreload import doctest_reload | |
70 | from IPython.utils.io import ask_yes_no, rprint |
|
71 | from IPython.utils.io import ask_yes_no, rprint | |
71 | from IPython.utils.ipstruct import Struct |
|
72 | from IPython.utils.ipstruct import Struct | |
72 | from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError |
|
73 | from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError | |
73 | from IPython.utils.pickleshare import PickleShareDB |
|
74 | from IPython.utils.pickleshare import PickleShareDB | |
74 | from IPython.utils.process import system, getoutput |
|
75 | from IPython.utils.process import system, getoutput | |
75 | from IPython.utils.strdispatch import StrDispatch |
|
76 | from IPython.utils.strdispatch import StrDispatch | |
76 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
77 | from IPython.utils.syspathcontext import prepended_to_syspath | |
77 | from IPython.utils.text import (num_ini_spaces, format_screen, LSString, SList, |
|
78 | from IPython.utils.text import (num_ini_spaces, format_screen, LSString, SList, | |
78 | DollarFormatter) |
|
79 | DollarFormatter) | |
79 | from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum, |
|
80 | from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum, | |
80 | List, Unicode, Instance, Type) |
|
81 | List, Unicode, Instance, Type) | |
81 | from IPython.utils.warn import warn, error, fatal |
|
82 | from IPython.utils.warn import warn, error, fatal | |
82 | import IPython.core.hooks |
|
83 | import IPython.core.hooks | |
83 |
|
84 | |||
84 | #----------------------------------------------------------------------------- |
|
85 | #----------------------------------------------------------------------------- | |
85 | # Globals |
|
86 | # Globals | |
86 | #----------------------------------------------------------------------------- |
|
87 | #----------------------------------------------------------------------------- | |
87 |
|
88 | |||
88 | # compiled regexps for autoindent management |
|
89 | # compiled regexps for autoindent management | |
89 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
90 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
90 |
|
91 | |||
91 | #----------------------------------------------------------------------------- |
|
92 | #----------------------------------------------------------------------------- | |
92 | # Utilities |
|
93 | # Utilities | |
93 | #----------------------------------------------------------------------------- |
|
94 | #----------------------------------------------------------------------------- | |
94 |
|
95 | |||
95 | def softspace(file, newvalue): |
|
96 | def softspace(file, newvalue): | |
96 | """Copied from code.py, to remove the dependency""" |
|
97 | """Copied from code.py, to remove the dependency""" | |
97 |
|
98 | |||
98 | oldvalue = 0 |
|
99 | oldvalue = 0 | |
99 | try: |
|
100 | try: | |
100 | oldvalue = file.softspace |
|
101 | oldvalue = file.softspace | |
101 | except AttributeError: |
|
102 | except AttributeError: | |
102 | pass |
|
103 | pass | |
103 | try: |
|
104 | try: | |
104 | file.softspace = newvalue |
|
105 | file.softspace = newvalue | |
105 | except (AttributeError, TypeError): |
|
106 | except (AttributeError, TypeError): | |
106 | # "attribute-less object" or "read-only attributes" |
|
107 | # "attribute-less object" or "read-only attributes" | |
107 | pass |
|
108 | pass | |
108 | return oldvalue |
|
109 | return oldvalue | |
109 |
|
110 | |||
110 |
|
111 | |||
111 | def no_op(*a, **kw): pass |
|
112 | def no_op(*a, **kw): pass | |
112 |
|
113 | |||
113 | class NoOpContext(object): |
|
114 | class NoOpContext(object): | |
114 | def __enter__(self): pass |
|
115 | def __enter__(self): pass | |
115 | def __exit__(self, type, value, traceback): pass |
|
116 | def __exit__(self, type, value, traceback): pass | |
116 | no_op_context = NoOpContext() |
|
117 | no_op_context = NoOpContext() | |
117 |
|
118 | |||
118 | class SpaceInInput(Exception): pass |
|
119 | class SpaceInInput(Exception): pass | |
119 |
|
120 | |||
120 | class Bunch: pass |
|
121 | class Bunch: pass | |
121 |
|
122 | |||
122 |
|
123 | |||
123 | def get_default_colors(): |
|
124 | def get_default_colors(): | |
124 | if sys.platform=='darwin': |
|
125 | if sys.platform=='darwin': | |
125 | return "LightBG" |
|
126 | return "LightBG" | |
126 | elif os.name=='nt': |
|
127 | elif os.name=='nt': | |
127 | return 'Linux' |
|
128 | return 'Linux' | |
128 | else: |
|
129 | else: | |
129 | return 'Linux' |
|
130 | return 'Linux' | |
130 |
|
131 | |||
131 |
|
132 | |||
132 | class SeparateUnicode(Unicode): |
|
133 | class SeparateUnicode(Unicode): | |
133 | """A Unicode subclass to validate separate_in, separate_out, etc. |
|
134 | """A Unicode subclass to validate separate_in, separate_out, etc. | |
134 |
|
135 | |||
135 | This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'. |
|
136 | This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'. | |
136 | """ |
|
137 | """ | |
137 |
|
138 | |||
138 | def validate(self, obj, value): |
|
139 | def validate(self, obj, value): | |
139 | if value == '0': value = '' |
|
140 | if value == '0': value = '' | |
140 | value = value.replace('\\n','\n') |
|
141 | value = value.replace('\\n','\n') | |
141 | return super(SeparateUnicode, self).validate(obj, value) |
|
142 | return super(SeparateUnicode, self).validate(obj, value) | |
142 |
|
143 | |||
143 |
|
144 | |||
144 | class ReadlineNoRecord(object): |
|
145 | class ReadlineNoRecord(object): | |
145 | """Context manager to execute some code, then reload readline history |
|
146 | """Context manager to execute some code, then reload readline history | |
146 | so that interactive input to the code doesn't appear when pressing up.""" |
|
147 | so that interactive input to the code doesn't appear when pressing up.""" | |
147 | def __init__(self, shell): |
|
148 | def __init__(self, shell): | |
148 | self.shell = shell |
|
149 | self.shell = shell | |
149 | self._nested_level = 0 |
|
150 | self._nested_level = 0 | |
150 |
|
151 | |||
151 | def __enter__(self): |
|
152 | def __enter__(self): | |
152 | if self._nested_level == 0: |
|
153 | if self._nested_level == 0: | |
153 | try: |
|
154 | try: | |
154 | self.orig_length = self.current_length() |
|
155 | self.orig_length = self.current_length() | |
155 | self.readline_tail = self.get_readline_tail() |
|
156 | self.readline_tail = self.get_readline_tail() | |
156 | except (AttributeError, IndexError): # Can fail with pyreadline |
|
157 | except (AttributeError, IndexError): # Can fail with pyreadline | |
157 | self.orig_length, self.readline_tail = 999999, [] |
|
158 | self.orig_length, self.readline_tail = 999999, [] | |
158 | self._nested_level += 1 |
|
159 | self._nested_level += 1 | |
159 |
|
160 | |||
160 | def __exit__(self, type, value, traceback): |
|
161 | def __exit__(self, type, value, traceback): | |
161 | self._nested_level -= 1 |
|
162 | self._nested_level -= 1 | |
162 | if self._nested_level == 0: |
|
163 | if self._nested_level == 0: | |
163 | # Try clipping the end if it's got longer |
|
164 | # Try clipping the end if it's got longer | |
164 | try: |
|
165 | try: | |
165 | e = self.current_length() - self.orig_length |
|
166 | e = self.current_length() - self.orig_length | |
166 | if e > 0: |
|
167 | if e > 0: | |
167 | for _ in range(e): |
|
168 | for _ in range(e): | |
168 | self.shell.readline.remove_history_item(self.orig_length) |
|
169 | self.shell.readline.remove_history_item(self.orig_length) | |
169 |
|
170 | |||
170 | # If it still doesn't match, just reload readline history. |
|
171 | # If it still doesn't match, just reload readline history. | |
171 | if self.current_length() != self.orig_length \ |
|
172 | if self.current_length() != self.orig_length \ | |
172 | or self.get_readline_tail() != self.readline_tail: |
|
173 | or self.get_readline_tail() != self.readline_tail: | |
173 | self.shell.refill_readline_hist() |
|
174 | self.shell.refill_readline_hist() | |
174 | except (AttributeError, IndexError): |
|
175 | except (AttributeError, IndexError): | |
175 | pass |
|
176 | pass | |
176 | # Returning False will cause exceptions to propagate |
|
177 | # Returning False will cause exceptions to propagate | |
177 | return False |
|
178 | return False | |
178 |
|
179 | |||
179 | def current_length(self): |
|
180 | def current_length(self): | |
180 | return self.shell.readline.get_current_history_length() |
|
181 | return self.shell.readline.get_current_history_length() | |
181 |
|
182 | |||
182 | def get_readline_tail(self, n=10): |
|
183 | def get_readline_tail(self, n=10): | |
183 | """Get the last n items in readline history.""" |
|
184 | """Get the last n items in readline history.""" | |
184 | end = self.shell.readline.get_current_history_length() + 1 |
|
185 | end = self.shell.readline.get_current_history_length() + 1 | |
185 | start = max(end-n, 1) |
|
186 | start = max(end-n, 1) | |
186 | ghi = self.shell.readline.get_history_item |
|
187 | ghi = self.shell.readline.get_history_item | |
187 | return [ghi(x) for x in range(start, end)] |
|
188 | return [ghi(x) for x in range(start, end)] | |
188 |
|
189 | |||
189 |
|
190 | |||
190 | _autocall_help = """ |
|
191 | _autocall_help = """ | |
191 | Make IPython automatically call any callable object even if |
|
192 | Make IPython automatically call any callable object even if | |
192 | you didn't type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
193 | you didn't type explicit parentheses. For example, 'str 43' becomes 'str(43)' | |
193 | automatically. The value can be '0' to disable the feature, '1' for 'smart' |
|
194 | automatically. The value can be '0' to disable the feature, '1' for 'smart' | |
194 | autocall, where it is not applied if there are no more arguments on the line, |
|
195 | autocall, where it is not applied if there are no more arguments on the line, | |
195 | and '2' for 'full' autocall, where all callable objects are automatically |
|
196 | and '2' for 'full' autocall, where all callable objects are automatically | |
196 | called (even if no arguments are present). The default is '1'. |
|
197 | called (even if no arguments are present). The default is '1'. | |
197 | """ |
|
198 | """ | |
198 |
|
199 | |||
199 | #----------------------------------------------------------------------------- |
|
200 | #----------------------------------------------------------------------------- | |
200 | # Main IPython class |
|
201 | # Main IPython class | |
201 | #----------------------------------------------------------------------------- |
|
202 | #----------------------------------------------------------------------------- | |
202 |
|
203 | |||
203 | class InteractiveShell(SingletonConfigurable, Magic): |
|
204 | class InteractiveShell(SingletonConfigurable, Magic): | |
204 | """An enhanced, interactive shell for Python.""" |
|
205 | """An enhanced, interactive shell for Python.""" | |
205 |
|
206 | |||
206 | _instance = None |
|
207 | _instance = None | |
207 |
|
208 | |||
208 | autocall = Enum((0,1,2), default_value=1, config=True, help= |
|
209 | autocall = Enum((0,1,2), default_value=1, config=True, help= | |
209 | """ |
|
210 | """ | |
210 | Make IPython automatically call any callable object even if you didn't |
|
211 | Make IPython automatically call any callable object even if you didn't | |
211 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
212 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' | |
212 | automatically. The value can be '0' to disable the feature, '1' for |
|
213 | automatically. The value can be '0' to disable the feature, '1' for | |
213 | 'smart' autocall, where it is not applied if there are no more |
|
214 | 'smart' autocall, where it is not applied if there are no more | |
214 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
215 | arguments on the line, and '2' for 'full' autocall, where all callable | |
215 | objects are automatically called (even if no arguments are present). |
|
216 | objects are automatically called (even if no arguments are present). | |
216 | The default is '1'. |
|
217 | The default is '1'. | |
217 | """ |
|
218 | """ | |
218 | ) |
|
219 | ) | |
219 | # TODO: remove all autoindent logic and put into frontends. |
|
220 | # TODO: remove all autoindent logic and put into frontends. | |
220 | # We can't do this yet because even runlines uses the autoindent. |
|
221 | # We can't do this yet because even runlines uses the autoindent. | |
221 | autoindent = CBool(True, config=True, help= |
|
222 | autoindent = CBool(True, config=True, help= | |
222 | """ |
|
223 | """ | |
223 | Autoindent IPython code entered interactively. |
|
224 | Autoindent IPython code entered interactively. | |
224 | """ |
|
225 | """ | |
225 | ) |
|
226 | ) | |
226 | automagic = CBool(True, config=True, help= |
|
227 | automagic = CBool(True, config=True, help= | |
227 | """ |
|
228 | """ | |
228 | Enable magic commands to be called without the leading %. |
|
229 | Enable magic commands to be called without the leading %. | |
229 | """ |
|
230 | """ | |
230 | ) |
|
231 | ) | |
231 | cache_size = Integer(1000, config=True, help= |
|
232 | cache_size = Integer(1000, config=True, help= | |
232 | """ |
|
233 | """ | |
233 | Set the size of the output cache. The default is 1000, you can |
|
234 | Set the size of the output cache. The default is 1000, you can | |
234 | change it permanently in your config file. Setting it to 0 completely |
|
235 | change it permanently in your config file. Setting it to 0 completely | |
235 | disables the caching system, and the minimum value accepted is 20 (if |
|
236 | disables the caching system, and the minimum value accepted is 20 (if | |
236 | you provide a value less than 20, it is reset to 0 and a warning is |
|
237 | you provide a value less than 20, it is reset to 0 and a warning is | |
237 | issued). This limit is defined because otherwise you'll spend more |
|
238 | issued). This limit is defined because otherwise you'll spend more | |
238 | time re-flushing a too small cache than working |
|
239 | time re-flushing a too small cache than working | |
239 | """ |
|
240 | """ | |
240 | ) |
|
241 | ) | |
241 | color_info = CBool(True, config=True, help= |
|
242 | color_info = CBool(True, config=True, help= | |
242 | """ |
|
243 | """ | |
243 | Use colors for displaying information about objects. Because this |
|
244 | Use colors for displaying information about objects. Because this | |
244 | information is passed through a pager (like 'less'), and some pagers |
|
245 | information is passed through a pager (like 'less'), and some pagers | |
245 | get confused with color codes, this capability can be turned off. |
|
246 | get confused with color codes, this capability can be turned off. | |
246 | """ |
|
247 | """ | |
247 | ) |
|
248 | ) | |
248 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), |
|
249 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), | |
249 | default_value=get_default_colors(), config=True, |
|
250 | default_value=get_default_colors(), config=True, | |
250 | help="Set the color scheme (NoColor, Linux, or LightBG)." |
|
251 | help="Set the color scheme (NoColor, Linux, or LightBG)." | |
251 | ) |
|
252 | ) | |
252 | colors_force = CBool(False, help= |
|
253 | colors_force = CBool(False, help= | |
253 | """ |
|
254 | """ | |
254 | Force use of ANSI color codes, regardless of OS and readline |
|
255 | Force use of ANSI color codes, regardless of OS and readline | |
255 | availability. |
|
256 | availability. | |
256 | """ |
|
257 | """ | |
257 | # FIXME: This is essentially a hack to allow ZMQShell to show colors |
|
258 | # FIXME: This is essentially a hack to allow ZMQShell to show colors | |
258 | # without readline on Win32. When the ZMQ formatting system is |
|
259 | # without readline on Win32. When the ZMQ formatting system is | |
259 | # refactored, this should be removed. |
|
260 | # refactored, this should be removed. | |
260 | ) |
|
261 | ) | |
261 | debug = CBool(False, config=True) |
|
262 | debug = CBool(False, config=True) | |
262 | deep_reload = CBool(False, config=True, help= |
|
263 | deep_reload = CBool(False, config=True, help= | |
263 | """ |
|
264 | """ | |
264 | Enable deep (recursive) reloading by default. IPython can use the |
|
265 | Enable deep (recursive) reloading by default. IPython can use the | |
265 | deep_reload module which reloads changes in modules recursively (it |
|
266 | deep_reload module which reloads changes in modules recursively (it | |
266 | replaces the reload() function, so you don't need to change anything to |
|
267 | replaces the reload() function, so you don't need to change anything to | |
267 | use it). deep_reload() forces a full reload of modules whose code may |
|
268 | use it). deep_reload() forces a full reload of modules whose code may | |
268 | have changed, which the default reload() function does not. When |
|
269 | have changed, which the default reload() function does not. When | |
269 | deep_reload is off, IPython will use the normal reload(), but |
|
270 | deep_reload is off, IPython will use the normal reload(), but | |
270 | deep_reload will still be available as dreload(). |
|
271 | deep_reload will still be available as dreload(). | |
271 | """ |
|
272 | """ | |
272 | ) |
|
273 | ) | |
273 | display_formatter = Instance(DisplayFormatter) |
|
274 | display_formatter = Instance(DisplayFormatter) | |
274 | displayhook_class = Type(DisplayHook) |
|
275 | displayhook_class = Type(DisplayHook) | |
275 | display_pub_class = Type(DisplayPublisher) |
|
276 | display_pub_class = Type(DisplayPublisher) | |
276 |
|
277 | |||
277 | exit_now = CBool(False) |
|
278 | exit_now = CBool(False) | |
278 | exiter = Instance(ExitAutocall) |
|
279 | exiter = Instance(ExitAutocall) | |
279 | def _exiter_default(self): |
|
280 | def _exiter_default(self): | |
280 | return ExitAutocall(self) |
|
281 | return ExitAutocall(self) | |
281 | # Monotonically increasing execution counter |
|
282 | # Monotonically increasing execution counter | |
282 | execution_count = Integer(1) |
|
283 | execution_count = Integer(1) | |
283 | filename = Unicode("<ipython console>") |
|
284 | filename = Unicode("<ipython console>") | |
284 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ |
|
285 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ | |
285 |
|
286 | |||
286 | # Input splitter, to split entire cells of input into either individual |
|
287 | # Input splitter, to split entire cells of input into either individual | |
287 | # interactive statements or whole blocks. |
|
288 | # interactive statements or whole blocks. | |
288 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
289 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', | |
289 | (), {}) |
|
290 | (), {}) | |
290 | logstart = CBool(False, config=True, help= |
|
291 | logstart = CBool(False, config=True, help= | |
291 | """ |
|
292 | """ | |
292 | Start logging to the default log file. |
|
293 | Start logging to the default log file. | |
293 | """ |
|
294 | """ | |
294 | ) |
|
295 | ) | |
295 | logfile = Unicode('', config=True, help= |
|
296 | logfile = Unicode('', config=True, help= | |
296 | """ |
|
297 | """ | |
297 | The name of the logfile to use. |
|
298 | The name of the logfile to use. | |
298 | """ |
|
299 | """ | |
299 | ) |
|
300 | ) | |
300 | logappend = Unicode('', config=True, help= |
|
301 | logappend = Unicode('', config=True, help= | |
301 | """ |
|
302 | """ | |
302 | Start logging to the given file in append mode. |
|
303 | Start logging to the given file in append mode. | |
303 | """ |
|
304 | """ | |
304 | ) |
|
305 | ) | |
305 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
306 | object_info_string_level = Enum((0,1,2), default_value=0, | |
306 | config=True) |
|
307 | config=True) | |
307 | pdb = CBool(False, config=True, help= |
|
308 | pdb = CBool(False, config=True, help= | |
308 | """ |
|
309 | """ | |
309 | Automatically call the pdb debugger after every exception. |
|
310 | Automatically call the pdb debugger after every exception. | |
310 | """ |
|
311 | """ | |
311 | ) |
|
312 | ) | |
312 | multiline_history = CBool(sys.platform != 'win32', config=True, |
|
313 | multiline_history = CBool(sys.platform != 'win32', config=True, | |
313 | help="Save multi-line entries as one entry in readline history" |
|
314 | help="Save multi-line entries as one entry in readline history" | |
314 | ) |
|
315 | ) | |
315 |
|
316 | |||
316 | prompt_in1 = Unicode('In [\\#]: ', config=True) |
|
317 | prompt_in1 = Unicode('In [\\#]: ', config=True) | |
317 | prompt_in2 = Unicode(' .\\D.: ', config=True) |
|
318 | prompt_in2 = Unicode(' .\\D.: ', config=True) | |
318 | prompt_out = Unicode('Out[\\#]: ', config=True) |
|
319 | prompt_out = Unicode('Out[\\#]: ', config=True) | |
319 | prompts_pad_left = CBool(True, config=True) |
|
320 | prompts_pad_left = CBool(True, config=True) | |
320 | quiet = CBool(False, config=True) |
|
321 | quiet = CBool(False, config=True) | |
321 |
|
322 | |||
322 | history_length = Integer(10000, config=True) |
|
323 | history_length = Integer(10000, config=True) | |
323 |
|
324 | |||
324 | # The readline stuff will eventually be moved to the terminal subclass |
|
325 | # The readline stuff will eventually be moved to the terminal subclass | |
325 | # but for now, we can't do that as readline is welded in everywhere. |
|
326 | # but for now, we can't do that as readline is welded in everywhere. | |
326 | readline_use = CBool(True, config=True) |
|
327 | readline_use = CBool(True, config=True) | |
327 | readline_remove_delims = Unicode('-/~', config=True) |
|
328 | readline_remove_delims = Unicode('-/~', config=True) | |
328 | # don't use \M- bindings by default, because they |
|
329 | # don't use \M- bindings by default, because they | |
329 | # conflict with 8-bit encodings. See gh-58,gh-88 |
|
330 | # conflict with 8-bit encodings. See gh-58,gh-88 | |
330 | readline_parse_and_bind = List([ |
|
331 | readline_parse_and_bind = List([ | |
331 | 'tab: complete', |
|
332 | 'tab: complete', | |
332 | '"\C-l": clear-screen', |
|
333 | '"\C-l": clear-screen', | |
333 | 'set show-all-if-ambiguous on', |
|
334 | 'set show-all-if-ambiguous on', | |
334 | '"\C-o": tab-insert', |
|
335 | '"\C-o": tab-insert', | |
335 | '"\C-r": reverse-search-history', |
|
336 | '"\C-r": reverse-search-history', | |
336 | '"\C-s": forward-search-history', |
|
337 | '"\C-s": forward-search-history', | |
337 | '"\C-p": history-search-backward', |
|
338 | '"\C-p": history-search-backward', | |
338 | '"\C-n": history-search-forward', |
|
339 | '"\C-n": history-search-forward', | |
339 | '"\e[A": history-search-backward', |
|
340 | '"\e[A": history-search-backward', | |
340 | '"\e[B": history-search-forward', |
|
341 | '"\e[B": history-search-forward', | |
341 | '"\C-k": kill-line', |
|
342 | '"\C-k": kill-line', | |
342 | '"\C-u": unix-line-discard', |
|
343 | '"\C-u": unix-line-discard', | |
343 | ], allow_none=False, config=True) |
|
344 | ], allow_none=False, config=True) | |
344 |
|
345 | |||
345 | # TODO: this part of prompt management should be moved to the frontends. |
|
346 | # TODO: this part of prompt management should be moved to the frontends. | |
346 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
347 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' | |
347 | separate_in = SeparateUnicode('\n', config=True) |
|
348 | separate_in = SeparateUnicode('\n', config=True) | |
348 | separate_out = SeparateUnicode('', config=True) |
|
349 | separate_out = SeparateUnicode('', config=True) | |
349 | separate_out2 = SeparateUnicode('', config=True) |
|
350 | separate_out2 = SeparateUnicode('', config=True) | |
350 | wildcards_case_sensitive = CBool(True, config=True) |
|
351 | wildcards_case_sensitive = CBool(True, config=True) | |
351 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
352 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), | |
352 | default_value='Context', config=True) |
|
353 | default_value='Context', config=True) | |
353 |
|
354 | |||
354 | # Subcomponents of InteractiveShell |
|
355 | # Subcomponents of InteractiveShell | |
355 | alias_manager = Instance('IPython.core.alias.AliasManager') |
|
356 | alias_manager = Instance('IPython.core.alias.AliasManager') | |
356 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
357 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') | |
357 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') |
|
358 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') | |
358 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') |
|
359 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') | |
359 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') |
|
360 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') | |
360 | plugin_manager = Instance('IPython.core.plugin.PluginManager') |
|
361 | plugin_manager = Instance('IPython.core.plugin.PluginManager') | |
361 | payload_manager = Instance('IPython.core.payload.PayloadManager') |
|
362 | payload_manager = Instance('IPython.core.payload.PayloadManager') | |
362 | history_manager = Instance('IPython.core.history.HistoryManager') |
|
363 | history_manager = Instance('IPython.core.history.HistoryManager') | |
363 |
|
364 | |||
364 | profile_dir = Instance('IPython.core.application.ProfileDir') |
|
365 | profile_dir = Instance('IPython.core.application.ProfileDir') | |
365 | @property |
|
366 | @property | |
366 | def profile(self): |
|
367 | def profile(self): | |
367 | if self.profile_dir is not None: |
|
368 | if self.profile_dir is not None: | |
368 | name = os.path.basename(self.profile_dir.location) |
|
369 | name = os.path.basename(self.profile_dir.location) | |
369 | return name.replace('profile_','') |
|
370 | return name.replace('profile_','') | |
370 |
|
371 | |||
371 |
|
372 | |||
372 | # Private interface |
|
373 | # Private interface | |
373 | _post_execute = Instance(dict) |
|
374 | _post_execute = Instance(dict) | |
374 |
|
375 | |||
375 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, |
|
376 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, | |
376 | user_module=None, user_ns=None, |
|
377 | user_module=None, user_ns=None, | |
377 | custom_exceptions=((), None)): |
|
378 | custom_exceptions=((), None)): | |
378 |
|
379 | |||
379 | # This is where traits with a config_key argument are updated |
|
380 | # This is where traits with a config_key argument are updated | |
380 | # from the values on config. |
|
381 | # from the values on config. | |
381 | super(InteractiveShell, self).__init__(config=config) |
|
382 | super(InteractiveShell, self).__init__(config=config) | |
382 | self.configurables = [self] |
|
383 | self.configurables = [self] | |
383 |
|
384 | |||
384 | # These are relatively independent and stateless |
|
385 | # These are relatively independent and stateless | |
385 | self.init_ipython_dir(ipython_dir) |
|
386 | self.init_ipython_dir(ipython_dir) | |
386 | self.init_profile_dir(profile_dir) |
|
387 | self.init_profile_dir(profile_dir) | |
387 | self.init_instance_attrs() |
|
388 | self.init_instance_attrs() | |
388 | self.init_environment() |
|
389 | self.init_environment() | |
389 |
|
390 | |||
390 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
391 | # Create namespaces (user_ns, user_global_ns, etc.) | |
391 | self.init_create_namespaces(user_module, user_ns) |
|
392 | self.init_create_namespaces(user_module, user_ns) | |
392 | # This has to be done after init_create_namespaces because it uses |
|
393 | # This has to be done after init_create_namespaces because it uses | |
393 | # something in self.user_ns, but before init_sys_modules, which |
|
394 | # something in self.user_ns, but before init_sys_modules, which | |
394 | # is the first thing to modify sys. |
|
395 | # is the first thing to modify sys. | |
395 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
396 | # TODO: When we override sys.stdout and sys.stderr before this class | |
396 | # is created, we are saving the overridden ones here. Not sure if this |
|
397 | # is created, we are saving the overridden ones here. Not sure if this | |
397 | # is what we want to do. |
|
398 | # is what we want to do. | |
398 | self.save_sys_module_state() |
|
399 | self.save_sys_module_state() | |
399 | self.init_sys_modules() |
|
400 | self.init_sys_modules() | |
400 |
|
401 | |||
401 | # While we're trying to have each part of the code directly access what |
|
402 | # While we're trying to have each part of the code directly access what | |
402 | # it needs without keeping redundant references to objects, we have too |
|
403 | # it needs without keeping redundant references to objects, we have too | |
403 | # much legacy code that expects ip.db to exist. |
|
404 | # much legacy code that expects ip.db to exist. | |
404 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
405 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) | |
405 |
|
406 | |||
406 | self.init_history() |
|
407 | self.init_history() | |
407 | self.init_encoding() |
|
408 | self.init_encoding() | |
408 | self.init_prefilter() |
|
409 | self.init_prefilter() | |
409 |
|
410 | |||
410 | Magic.__init__(self, self) |
|
411 | Magic.__init__(self, self) | |
411 |
|
412 | |||
412 | self.init_syntax_highlighting() |
|
413 | self.init_syntax_highlighting() | |
413 | self.init_hooks() |
|
414 | self.init_hooks() | |
414 | self.init_pushd_popd_magic() |
|
415 | self.init_pushd_popd_magic() | |
415 | # self.init_traceback_handlers use to be here, but we moved it below |
|
416 | # self.init_traceback_handlers use to be here, but we moved it below | |
416 | # because it and init_io have to come after init_readline. |
|
417 | # because it and init_io have to come after init_readline. | |
417 | self.init_user_ns() |
|
418 | self.init_user_ns() | |
418 | self.init_logger() |
|
419 | self.init_logger() | |
419 | self.init_alias() |
|
420 | self.init_alias() | |
420 | self.init_builtins() |
|
421 | self.init_builtins() | |
421 |
|
422 | |||
422 | # pre_config_initialization |
|
423 | # pre_config_initialization | |
423 |
|
424 | |||
424 | # The next section should contain everything that was in ipmaker. |
|
425 | # The next section should contain everything that was in ipmaker. | |
425 | self.init_logstart() |
|
426 | self.init_logstart() | |
426 |
|
427 | |||
427 | # The following was in post_config_initialization |
|
428 | # The following was in post_config_initialization | |
428 | self.init_inspector() |
|
429 | self.init_inspector() | |
429 | # init_readline() must come before init_io(), because init_io uses |
|
430 | # init_readline() must come before init_io(), because init_io uses | |
430 | # readline related things. |
|
431 | # readline related things. | |
431 | self.init_readline() |
|
432 | self.init_readline() | |
432 | # We save this here in case user code replaces raw_input, but it needs |
|
433 | # We save this here in case user code replaces raw_input, but it needs | |
433 | # to be after init_readline(), because PyPy's readline works by replacing |
|
434 | # to be after init_readline(), because PyPy's readline works by replacing | |
434 | # raw_input. |
|
435 | # raw_input. | |
435 | if py3compat.PY3: |
|
436 | if py3compat.PY3: | |
436 | self.raw_input_original = input |
|
437 | self.raw_input_original = input | |
437 | else: |
|
438 | else: | |
438 | self.raw_input_original = raw_input |
|
439 | self.raw_input_original = raw_input | |
439 | # init_completer must come after init_readline, because it needs to |
|
440 | # init_completer must come after init_readline, because it needs to | |
440 | # know whether readline is present or not system-wide to configure the |
|
441 | # know whether readline is present or not system-wide to configure the | |
441 | # completers, since the completion machinery can now operate |
|
442 | # completers, since the completion machinery can now operate | |
442 | # independently of readline (e.g. over the network) |
|
443 | # independently of readline (e.g. over the network) | |
443 | self.init_completer() |
|
444 | self.init_completer() | |
444 | # TODO: init_io() needs to happen before init_traceback handlers |
|
445 | # TODO: init_io() needs to happen before init_traceback handlers | |
445 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
446 | # because the traceback handlers hardcode the stdout/stderr streams. | |
446 | # This logic in in debugger.Pdb and should eventually be changed. |
|
447 | # This logic in in debugger.Pdb and should eventually be changed. | |
447 | self.init_io() |
|
448 | self.init_io() | |
448 | self.init_traceback_handlers(custom_exceptions) |
|
449 | self.init_traceback_handlers(custom_exceptions) | |
449 | self.init_prompts() |
|
450 | self.init_prompts() | |
450 | self.init_display_formatter() |
|
451 | self.init_display_formatter() | |
451 | self.init_display_pub() |
|
452 | self.init_display_pub() | |
452 | self.init_displayhook() |
|
453 | self.init_displayhook() | |
453 | self.init_reload_doctest() |
|
454 | self.init_reload_doctest() | |
454 | self.init_magics() |
|
455 | self.init_magics() | |
455 | self.init_pdb() |
|
456 | self.init_pdb() | |
456 | self.init_extension_manager() |
|
457 | self.init_extension_manager() | |
457 | self.init_plugin_manager() |
|
458 | self.init_plugin_manager() | |
458 | self.init_payload() |
|
459 | self.init_payload() | |
459 | self.hooks.late_startup_hook() |
|
460 | self.hooks.late_startup_hook() | |
460 | atexit.register(self.atexit_operations) |
|
461 | atexit.register(self.atexit_operations) | |
461 |
|
462 | |||
462 | def get_ipython(self): |
|
463 | def get_ipython(self): | |
463 | """Return the currently running IPython instance.""" |
|
464 | """Return the currently running IPython instance.""" | |
464 | return self |
|
465 | return self | |
465 |
|
466 | |||
466 | #------------------------------------------------------------------------- |
|
467 | #------------------------------------------------------------------------- | |
467 | # Trait changed handlers |
|
468 | # Trait changed handlers | |
468 | #------------------------------------------------------------------------- |
|
469 | #------------------------------------------------------------------------- | |
469 |
|
470 | |||
470 | def _ipython_dir_changed(self, name, new): |
|
471 | def _ipython_dir_changed(self, name, new): | |
471 | if not os.path.isdir(new): |
|
472 | if not os.path.isdir(new): | |
472 | os.makedirs(new, mode = 0777) |
|
473 | os.makedirs(new, mode = 0777) | |
473 |
|
474 | |||
474 | def set_autoindent(self,value=None): |
|
475 | def set_autoindent(self,value=None): | |
475 | """Set the autoindent flag, checking for readline support. |
|
476 | """Set the autoindent flag, checking for readline support. | |
476 |
|
477 | |||
477 | If called with no arguments, it acts as a toggle.""" |
|
478 | If called with no arguments, it acts as a toggle.""" | |
478 |
|
479 | |||
479 | if value != 0 and not self.has_readline: |
|
480 | if value != 0 and not self.has_readline: | |
480 | if os.name == 'posix': |
|
481 | if os.name == 'posix': | |
481 | warn("The auto-indent feature requires the readline library") |
|
482 | warn("The auto-indent feature requires the readline library") | |
482 | self.autoindent = 0 |
|
483 | self.autoindent = 0 | |
483 | return |
|
484 | return | |
484 | if value is None: |
|
485 | if value is None: | |
485 | self.autoindent = not self.autoindent |
|
486 | self.autoindent = not self.autoindent | |
486 | else: |
|
487 | else: | |
487 | self.autoindent = value |
|
488 | self.autoindent = value | |
488 |
|
489 | |||
489 | #------------------------------------------------------------------------- |
|
490 | #------------------------------------------------------------------------- | |
490 | # init_* methods called by __init__ |
|
491 | # init_* methods called by __init__ | |
491 | #------------------------------------------------------------------------- |
|
492 | #------------------------------------------------------------------------- | |
492 |
|
493 | |||
493 | def init_ipython_dir(self, ipython_dir): |
|
494 | def init_ipython_dir(self, ipython_dir): | |
494 | if ipython_dir is not None: |
|
495 | if ipython_dir is not None: | |
495 | self.ipython_dir = ipython_dir |
|
496 | self.ipython_dir = ipython_dir | |
496 | return |
|
497 | return | |
497 |
|
498 | |||
498 | self.ipython_dir = get_ipython_dir() |
|
499 | self.ipython_dir = get_ipython_dir() | |
499 |
|
500 | |||
500 | def init_profile_dir(self, profile_dir): |
|
501 | def init_profile_dir(self, profile_dir): | |
501 | if profile_dir is not None: |
|
502 | if profile_dir is not None: | |
502 | self.profile_dir = profile_dir |
|
503 | self.profile_dir = profile_dir | |
503 | return |
|
504 | return | |
504 | self.profile_dir =\ |
|
505 | self.profile_dir =\ | |
505 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
506 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') | |
506 |
|
507 | |||
507 | def init_instance_attrs(self): |
|
508 | def init_instance_attrs(self): | |
508 | self.more = False |
|
509 | self.more = False | |
509 |
|
510 | |||
510 | # command compiler |
|
511 | # command compiler | |
511 | self.compile = CachingCompiler() |
|
512 | self.compile = CachingCompiler() | |
512 |
|
513 | |||
513 | # Make an empty namespace, which extension writers can rely on both |
|
514 | # Make an empty namespace, which extension writers can rely on both | |
514 | # existing and NEVER being used by ipython itself. This gives them a |
|
515 | # existing and NEVER being used by ipython itself. This gives them a | |
515 | # convenient location for storing additional information and state |
|
516 | # convenient location for storing additional information and state | |
516 | # their extensions may require, without fear of collisions with other |
|
517 | # their extensions may require, without fear of collisions with other | |
517 | # ipython names that may develop later. |
|
518 | # ipython names that may develop later. | |
518 | self.meta = Struct() |
|
519 | self.meta = Struct() | |
519 |
|
520 | |||
520 | # Temporary files used for various purposes. Deleted at exit. |
|
521 | # Temporary files used for various purposes. Deleted at exit. | |
521 | self.tempfiles = [] |
|
522 | self.tempfiles = [] | |
522 |
|
523 | |||
523 | # Keep track of readline usage (later set by init_readline) |
|
524 | # Keep track of readline usage (later set by init_readline) | |
524 | self.has_readline = False |
|
525 | self.has_readline = False | |
525 |
|
526 | |||
526 | # keep track of where we started running (mainly for crash post-mortem) |
|
527 | # keep track of where we started running (mainly for crash post-mortem) | |
527 | # This is not being used anywhere currently. |
|
528 | # This is not being used anywhere currently. | |
528 | self.starting_dir = os.getcwdu() |
|
529 | self.starting_dir = os.getcwdu() | |
529 |
|
530 | |||
530 | # Indentation management |
|
531 | # Indentation management | |
531 | self.indent_current_nsp = 0 |
|
532 | self.indent_current_nsp = 0 | |
532 |
|
533 | |||
533 | # Dict to track post-execution functions that have been registered |
|
534 | # Dict to track post-execution functions that have been registered | |
534 | self._post_execute = {} |
|
535 | self._post_execute = {} | |
535 |
|
536 | |||
536 | def init_environment(self): |
|
537 | def init_environment(self): | |
537 | """Any changes we need to make to the user's environment.""" |
|
538 | """Any changes we need to make to the user's environment.""" | |
538 | pass |
|
539 | pass | |
539 |
|
540 | |||
540 | def init_encoding(self): |
|
541 | def init_encoding(self): | |
541 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
542 | # Get system encoding at startup time. Certain terminals (like Emacs | |
542 | # under Win32 have it set to None, and we need to have a known valid |
|
543 | # under Win32 have it set to None, and we need to have a known valid | |
543 | # encoding to use in the raw_input() method |
|
544 | # encoding to use in the raw_input() method | |
544 | try: |
|
545 | try: | |
545 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
546 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
546 | except AttributeError: |
|
547 | except AttributeError: | |
547 | self.stdin_encoding = 'ascii' |
|
548 | self.stdin_encoding = 'ascii' | |
548 |
|
549 | |||
549 | def init_syntax_highlighting(self): |
|
550 | def init_syntax_highlighting(self): | |
550 | # Python source parser/formatter for syntax highlighting |
|
551 | # Python source parser/formatter for syntax highlighting | |
551 | pyformat = PyColorize.Parser().format |
|
552 | pyformat = PyColorize.Parser().format | |
552 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) |
|
553 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) | |
553 |
|
554 | |||
554 | def init_pushd_popd_magic(self): |
|
555 | def init_pushd_popd_magic(self): | |
555 | # for pushd/popd management |
|
556 | # for pushd/popd management | |
556 | self.home_dir = get_home_dir() |
|
557 | self.home_dir = get_home_dir() | |
557 |
|
558 | |||
558 | self.dir_stack = [] |
|
559 | self.dir_stack = [] | |
559 |
|
560 | |||
560 | def init_logger(self): |
|
561 | def init_logger(self): | |
561 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
562 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', | |
562 | logmode='rotate') |
|
563 | logmode='rotate') | |
563 |
|
564 | |||
564 | def init_logstart(self): |
|
565 | def init_logstart(self): | |
565 | """Initialize logging in case it was requested at the command line. |
|
566 | """Initialize logging in case it was requested at the command line. | |
566 | """ |
|
567 | """ | |
567 | if self.logappend: |
|
568 | if self.logappend: | |
568 | self.magic_logstart(self.logappend + ' append') |
|
569 | self.magic_logstart(self.logappend + ' append') | |
569 | elif self.logfile: |
|
570 | elif self.logfile: | |
570 | self.magic_logstart(self.logfile) |
|
571 | self.magic_logstart(self.logfile) | |
571 | elif self.logstart: |
|
572 | elif self.logstart: | |
572 | self.magic_logstart() |
|
573 | self.magic_logstart() | |
573 |
|
574 | |||
574 | def init_builtins(self): |
|
575 | def init_builtins(self): | |
575 | self.builtin_trap = BuiltinTrap(shell=self) |
|
576 | self.builtin_trap = BuiltinTrap(shell=self) | |
576 |
|
577 | |||
577 | def init_inspector(self): |
|
578 | def init_inspector(self): | |
578 | # Object inspector |
|
579 | # Object inspector | |
579 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
580 | self.inspector = oinspect.Inspector(oinspect.InspectColors, | |
580 | PyColorize.ANSICodeColors, |
|
581 | PyColorize.ANSICodeColors, | |
581 | 'NoColor', |
|
582 | 'NoColor', | |
582 | self.object_info_string_level) |
|
583 | self.object_info_string_level) | |
583 |
|
584 | |||
584 | def init_io(self): |
|
585 | def init_io(self): | |
585 | # This will just use sys.stdout and sys.stderr. If you want to |
|
586 | # This will just use sys.stdout and sys.stderr. If you want to | |
586 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
587 | # override sys.stdout and sys.stderr themselves, you need to do that | |
587 | # *before* instantiating this class, because io holds onto |
|
588 | # *before* instantiating this class, because io holds onto | |
588 | # references to the underlying streams. |
|
589 | # references to the underlying streams. | |
589 | if sys.platform == 'win32' and self.has_readline: |
|
590 | if sys.platform == 'win32' and self.has_readline: | |
590 | io.stdout = io.stderr = io.IOStream(self.readline._outputfile) |
|
591 | io.stdout = io.stderr = io.IOStream(self.readline._outputfile) | |
591 | else: |
|
592 | else: | |
592 | io.stdout = io.IOStream(sys.stdout) |
|
593 | io.stdout = io.IOStream(sys.stdout) | |
593 | io.stderr = io.IOStream(sys.stderr) |
|
594 | io.stderr = io.IOStream(sys.stderr) | |
594 |
|
595 | |||
595 | def init_prompts(self): |
|
596 | def init_prompts(self): | |
596 | # TODO: This is a pass for now because the prompts are managed inside |
|
597 | # TODO: This is a pass for now because the prompts are managed inside | |
597 | # the DisplayHook. Once there is a separate prompt manager, this |
|
598 | # the DisplayHook. Once there is a separate prompt manager, this | |
598 | # will initialize that object and all prompt related information. |
|
599 | # will initialize that object and all prompt related information. | |
599 | pass |
|
600 | pass | |
600 |
|
601 | |||
601 | def init_display_formatter(self): |
|
602 | def init_display_formatter(self): | |
602 | self.display_formatter = DisplayFormatter(config=self.config) |
|
603 | self.display_formatter = DisplayFormatter(config=self.config) | |
603 | self.configurables.append(self.display_formatter) |
|
604 | self.configurables.append(self.display_formatter) | |
604 |
|
605 | |||
605 | def init_display_pub(self): |
|
606 | def init_display_pub(self): | |
606 | self.display_pub = self.display_pub_class(config=self.config) |
|
607 | self.display_pub = self.display_pub_class(config=self.config) | |
607 | self.configurables.append(self.display_pub) |
|
608 | self.configurables.append(self.display_pub) | |
608 |
|
609 | |||
609 | def init_displayhook(self): |
|
610 | def init_displayhook(self): | |
610 | # Initialize displayhook, set in/out prompts and printing system |
|
611 | # Initialize displayhook, set in/out prompts and printing system | |
611 | self.displayhook = self.displayhook_class( |
|
612 | self.displayhook = self.displayhook_class( | |
612 | config=self.config, |
|
613 | config=self.config, | |
613 | shell=self, |
|
614 | shell=self, | |
614 | cache_size=self.cache_size, |
|
615 | cache_size=self.cache_size, | |
615 | input_sep = self.separate_in, |
|
616 | input_sep = self.separate_in, | |
616 | output_sep = self.separate_out, |
|
617 | output_sep = self.separate_out, | |
617 | output_sep2 = self.separate_out2, |
|
618 | output_sep2 = self.separate_out2, | |
618 | ps1 = self.prompt_in1, |
|
619 | ps1 = self.prompt_in1, | |
619 | ps2 = self.prompt_in2, |
|
620 | ps2 = self.prompt_in2, | |
620 | ps_out = self.prompt_out, |
|
621 | ps_out = self.prompt_out, | |
621 | pad_left = self.prompts_pad_left |
|
622 | pad_left = self.prompts_pad_left | |
622 | ) |
|
623 | ) | |
623 | self.configurables.append(self.displayhook) |
|
624 | self.configurables.append(self.displayhook) | |
624 | # This is a context manager that installs/revmoes the displayhook at |
|
625 | # This is a context manager that installs/revmoes the displayhook at | |
625 | # the appropriate time. |
|
626 | # the appropriate time. | |
626 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
627 | self.display_trap = DisplayTrap(hook=self.displayhook) | |
627 |
|
628 | |||
628 | def init_reload_doctest(self): |
|
629 | def init_reload_doctest(self): | |
629 | # Do a proper resetting of doctest, including the necessary displayhook |
|
630 | # Do a proper resetting of doctest, including the necessary displayhook | |
630 | # monkeypatching |
|
631 | # monkeypatching | |
631 | try: |
|
632 | try: | |
632 | doctest_reload() |
|
633 | doctest_reload() | |
633 | except ImportError: |
|
634 | except ImportError: | |
634 | warn("doctest module does not exist.") |
|
635 | warn("doctest module does not exist.") | |
635 |
|
636 | |||
636 | #------------------------------------------------------------------------- |
|
637 | #------------------------------------------------------------------------- | |
637 | # Things related to injections into the sys module |
|
638 | # Things related to injections into the sys module | |
638 | #------------------------------------------------------------------------- |
|
639 | #------------------------------------------------------------------------- | |
639 |
|
640 | |||
640 | def save_sys_module_state(self): |
|
641 | def save_sys_module_state(self): | |
641 | """Save the state of hooks in the sys module. |
|
642 | """Save the state of hooks in the sys module. | |
642 |
|
643 | |||
643 | This has to be called after self.user_module is created. |
|
644 | This has to be called after self.user_module is created. | |
644 | """ |
|
645 | """ | |
645 | self._orig_sys_module_state = {} |
|
646 | self._orig_sys_module_state = {} | |
646 | self._orig_sys_module_state['stdin'] = sys.stdin |
|
647 | self._orig_sys_module_state['stdin'] = sys.stdin | |
647 | self._orig_sys_module_state['stdout'] = sys.stdout |
|
648 | self._orig_sys_module_state['stdout'] = sys.stdout | |
648 | self._orig_sys_module_state['stderr'] = sys.stderr |
|
649 | self._orig_sys_module_state['stderr'] = sys.stderr | |
649 | self._orig_sys_module_state['excepthook'] = sys.excepthook |
|
650 | self._orig_sys_module_state['excepthook'] = sys.excepthook | |
650 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
651 | self._orig_sys_modules_main_name = self.user_module.__name__ | |
651 |
|
652 | |||
652 | def restore_sys_module_state(self): |
|
653 | def restore_sys_module_state(self): | |
653 | """Restore the state of the sys module.""" |
|
654 | """Restore the state of the sys module.""" | |
654 | try: |
|
655 | try: | |
655 | for k, v in self._orig_sys_module_state.iteritems(): |
|
656 | for k, v in self._orig_sys_module_state.iteritems(): | |
656 | setattr(sys, k, v) |
|
657 | setattr(sys, k, v) | |
657 | except AttributeError: |
|
658 | except AttributeError: | |
658 | pass |
|
659 | pass | |
659 | # Reset what what done in self.init_sys_modules |
|
660 | # Reset what what done in self.init_sys_modules | |
660 | sys.modules[self.user_module.__name__] = self._orig_sys_modules_main_name |
|
661 | sys.modules[self.user_module.__name__] = self._orig_sys_modules_main_name | |
661 |
|
662 | |||
662 | #------------------------------------------------------------------------- |
|
663 | #------------------------------------------------------------------------- | |
663 | # Things related to hooks |
|
664 | # Things related to hooks | |
664 | #------------------------------------------------------------------------- |
|
665 | #------------------------------------------------------------------------- | |
665 |
|
666 | |||
666 | def init_hooks(self): |
|
667 | def init_hooks(self): | |
667 | # hooks holds pointers used for user-side customizations |
|
668 | # hooks holds pointers used for user-side customizations | |
668 | self.hooks = Struct() |
|
669 | self.hooks = Struct() | |
669 |
|
670 | |||
670 | self.strdispatchers = {} |
|
671 | self.strdispatchers = {} | |
671 |
|
672 | |||
672 | # Set all default hooks, defined in the IPython.hooks module. |
|
673 | # Set all default hooks, defined in the IPython.hooks module. | |
673 | hooks = IPython.core.hooks |
|
674 | hooks = IPython.core.hooks | |
674 | for hook_name in hooks.__all__: |
|
675 | for hook_name in hooks.__all__: | |
675 | # default hooks have priority 100, i.e. low; user hooks should have |
|
676 | # default hooks have priority 100, i.e. low; user hooks should have | |
676 | # 0-100 priority |
|
677 | # 0-100 priority | |
677 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
678 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) | |
678 |
|
679 | |||
679 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
680 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): | |
680 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
681 | """set_hook(name,hook) -> sets an internal IPython hook. | |
681 |
|
682 | |||
682 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
683 | IPython exposes some of its internal API as user-modifiable hooks. By | |
683 | adding your function to one of these hooks, you can modify IPython's |
|
684 | adding your function to one of these hooks, you can modify IPython's | |
684 | behavior to call at runtime your own routines.""" |
|
685 | behavior to call at runtime your own routines.""" | |
685 |
|
686 | |||
686 | # At some point in the future, this should validate the hook before it |
|
687 | # At some point in the future, this should validate the hook before it | |
687 | # accepts it. Probably at least check that the hook takes the number |
|
688 | # accepts it. Probably at least check that the hook takes the number | |
688 | # of args it's supposed to. |
|
689 | # of args it's supposed to. | |
689 |
|
690 | |||
690 | f = types.MethodType(hook,self) |
|
691 | f = types.MethodType(hook,self) | |
691 |
|
692 | |||
692 | # check if the hook is for strdispatcher first |
|
693 | # check if the hook is for strdispatcher first | |
693 | if str_key is not None: |
|
694 | if str_key is not None: | |
694 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
695 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
695 | sdp.add_s(str_key, f, priority ) |
|
696 | sdp.add_s(str_key, f, priority ) | |
696 | self.strdispatchers[name] = sdp |
|
697 | self.strdispatchers[name] = sdp | |
697 | return |
|
698 | return | |
698 | if re_key is not None: |
|
699 | if re_key is not None: | |
699 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
700 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
700 | sdp.add_re(re.compile(re_key), f, priority ) |
|
701 | sdp.add_re(re.compile(re_key), f, priority ) | |
701 | self.strdispatchers[name] = sdp |
|
702 | self.strdispatchers[name] = sdp | |
702 | return |
|
703 | return | |
703 |
|
704 | |||
704 | dp = getattr(self.hooks, name, None) |
|
705 | dp = getattr(self.hooks, name, None) | |
705 | if name not in IPython.core.hooks.__all__: |
|
706 | if name not in IPython.core.hooks.__all__: | |
706 | print "Warning! Hook '%s' is not one of %s" % \ |
|
707 | print "Warning! Hook '%s' is not one of %s" % \ | |
707 | (name, IPython.core.hooks.__all__ ) |
|
708 | (name, IPython.core.hooks.__all__ ) | |
708 | if not dp: |
|
709 | if not dp: | |
709 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
710 | dp = IPython.core.hooks.CommandChainDispatcher() | |
710 |
|
711 | |||
711 | try: |
|
712 | try: | |
712 | dp.add(f,priority) |
|
713 | dp.add(f,priority) | |
713 | except AttributeError: |
|
714 | except AttributeError: | |
714 | # it was not commandchain, plain old func - replace |
|
715 | # it was not commandchain, plain old func - replace | |
715 | dp = f |
|
716 | dp = f | |
716 |
|
717 | |||
717 | setattr(self.hooks,name, dp) |
|
718 | setattr(self.hooks,name, dp) | |
718 |
|
719 | |||
719 | def register_post_execute(self, func): |
|
720 | def register_post_execute(self, func): | |
720 | """Register a function for calling after code execution. |
|
721 | """Register a function for calling after code execution. | |
721 | """ |
|
722 | """ | |
722 | if not callable(func): |
|
723 | if not callable(func): | |
723 | raise ValueError('argument %s must be callable' % func) |
|
724 | raise ValueError('argument %s must be callable' % func) | |
724 | self._post_execute[func] = True |
|
725 | self._post_execute[func] = True | |
725 |
|
726 | |||
726 | #------------------------------------------------------------------------- |
|
727 | #------------------------------------------------------------------------- | |
727 | # Things related to the "main" module |
|
728 | # Things related to the "main" module | |
728 | #------------------------------------------------------------------------- |
|
729 | #------------------------------------------------------------------------- | |
729 |
|
730 | |||
730 | def new_main_mod(self,ns=None): |
|
731 | def new_main_mod(self,ns=None): | |
731 | """Return a new 'main' module object for user code execution. |
|
732 | """Return a new 'main' module object for user code execution. | |
732 | """ |
|
733 | """ | |
733 | main_mod = self._user_main_module |
|
734 | main_mod = self._user_main_module | |
734 | init_fakemod_dict(main_mod,ns) |
|
735 | init_fakemod_dict(main_mod,ns) | |
735 | return main_mod |
|
736 | return main_mod | |
736 |
|
737 | |||
737 | def cache_main_mod(self,ns,fname): |
|
738 | def cache_main_mod(self,ns,fname): | |
738 | """Cache a main module's namespace. |
|
739 | """Cache a main module's namespace. | |
739 |
|
740 | |||
740 | When scripts are executed via %run, we must keep a reference to the |
|
741 | When scripts are executed via %run, we must keep a reference to the | |
741 | namespace of their __main__ module (a FakeModule instance) around so |
|
742 | namespace of their __main__ module (a FakeModule instance) around so | |
742 | that Python doesn't clear it, rendering objects defined therein |
|
743 | that Python doesn't clear it, rendering objects defined therein | |
743 | useless. |
|
744 | useless. | |
744 |
|
745 | |||
745 | This method keeps said reference in a private dict, keyed by the |
|
746 | This method keeps said reference in a private dict, keyed by the | |
746 | absolute path of the module object (which corresponds to the script |
|
747 | absolute path of the module object (which corresponds to the script | |
747 | path). This way, for multiple executions of the same script we only |
|
748 | path). This way, for multiple executions of the same script we only | |
748 | keep one copy of the namespace (the last one), thus preventing memory |
|
749 | keep one copy of the namespace (the last one), thus preventing memory | |
749 | leaks from old references while allowing the objects from the last |
|
750 | leaks from old references while allowing the objects from the last | |
750 | execution to be accessible. |
|
751 | execution to be accessible. | |
751 |
|
752 | |||
752 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
753 | Note: we can not allow the actual FakeModule instances to be deleted, | |
753 | because of how Python tears down modules (it hard-sets all their |
|
754 | because of how Python tears down modules (it hard-sets all their | |
754 | references to None without regard for reference counts). This method |
|
755 | references to None without regard for reference counts). This method | |
755 | must therefore make a *copy* of the given namespace, to allow the |
|
756 | must therefore make a *copy* of the given namespace, to allow the | |
756 | original module's __dict__ to be cleared and reused. |
|
757 | original module's __dict__ to be cleared and reused. | |
757 |
|
758 | |||
758 |
|
759 | |||
759 | Parameters |
|
760 | Parameters | |
760 | ---------- |
|
761 | ---------- | |
761 | ns : a namespace (a dict, typically) |
|
762 | ns : a namespace (a dict, typically) | |
762 |
|
763 | |||
763 | fname : str |
|
764 | fname : str | |
764 | Filename associated with the namespace. |
|
765 | Filename associated with the namespace. | |
765 |
|
766 | |||
766 | Examples |
|
767 | Examples | |
767 | -------- |
|
768 | -------- | |
768 |
|
769 | |||
769 | In [10]: import IPython |
|
770 | In [10]: import IPython | |
770 |
|
771 | |||
771 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
772 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
772 |
|
773 | |||
773 | In [12]: IPython.__file__ in _ip._main_ns_cache |
|
774 | In [12]: IPython.__file__ in _ip._main_ns_cache | |
774 | Out[12]: True |
|
775 | Out[12]: True | |
775 | """ |
|
776 | """ | |
776 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
777 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() | |
777 |
|
778 | |||
778 | def clear_main_mod_cache(self): |
|
779 | def clear_main_mod_cache(self): | |
779 | """Clear the cache of main modules. |
|
780 | """Clear the cache of main modules. | |
780 |
|
781 | |||
781 | Mainly for use by utilities like %reset. |
|
782 | Mainly for use by utilities like %reset. | |
782 |
|
783 | |||
783 | Examples |
|
784 | Examples | |
784 | -------- |
|
785 | -------- | |
785 |
|
786 | |||
786 | In [15]: import IPython |
|
787 | In [15]: import IPython | |
787 |
|
788 | |||
788 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
789 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
789 |
|
790 | |||
790 | In [17]: len(_ip._main_ns_cache) > 0 |
|
791 | In [17]: len(_ip._main_ns_cache) > 0 | |
791 | Out[17]: True |
|
792 | Out[17]: True | |
792 |
|
793 | |||
793 | In [18]: _ip.clear_main_mod_cache() |
|
794 | In [18]: _ip.clear_main_mod_cache() | |
794 |
|
795 | |||
795 | In [19]: len(_ip._main_ns_cache) == 0 |
|
796 | In [19]: len(_ip._main_ns_cache) == 0 | |
796 | Out[19]: True |
|
797 | Out[19]: True | |
797 | """ |
|
798 | """ | |
798 | self._main_ns_cache.clear() |
|
799 | self._main_ns_cache.clear() | |
799 |
|
800 | |||
800 | #------------------------------------------------------------------------- |
|
801 | #------------------------------------------------------------------------- | |
801 | # Things related to debugging |
|
802 | # Things related to debugging | |
802 | #------------------------------------------------------------------------- |
|
803 | #------------------------------------------------------------------------- | |
803 |
|
804 | |||
804 | def init_pdb(self): |
|
805 | def init_pdb(self): | |
805 | # Set calling of pdb on exceptions |
|
806 | # Set calling of pdb on exceptions | |
806 | # self.call_pdb is a property |
|
807 | # self.call_pdb is a property | |
807 | self.call_pdb = self.pdb |
|
808 | self.call_pdb = self.pdb | |
808 |
|
809 | |||
809 | def _get_call_pdb(self): |
|
810 | def _get_call_pdb(self): | |
810 | return self._call_pdb |
|
811 | return self._call_pdb | |
811 |
|
812 | |||
812 | def _set_call_pdb(self,val): |
|
813 | def _set_call_pdb(self,val): | |
813 |
|
814 | |||
814 | if val not in (0,1,False,True): |
|
815 | if val not in (0,1,False,True): | |
815 | raise ValueError,'new call_pdb value must be boolean' |
|
816 | raise ValueError,'new call_pdb value must be boolean' | |
816 |
|
817 | |||
817 | # store value in instance |
|
818 | # store value in instance | |
818 | self._call_pdb = val |
|
819 | self._call_pdb = val | |
819 |
|
820 | |||
820 | # notify the actual exception handlers |
|
821 | # notify the actual exception handlers | |
821 | self.InteractiveTB.call_pdb = val |
|
822 | self.InteractiveTB.call_pdb = val | |
822 |
|
823 | |||
823 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
824 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
824 | 'Control auto-activation of pdb at exceptions') |
|
825 | 'Control auto-activation of pdb at exceptions') | |
825 |
|
826 | |||
826 | def debugger(self,force=False): |
|
827 | def debugger(self,force=False): | |
827 | """Call the pydb/pdb debugger. |
|
828 | """Call the pydb/pdb debugger. | |
828 |
|
829 | |||
829 | Keywords: |
|
830 | Keywords: | |
830 |
|
831 | |||
831 | - force(False): by default, this routine checks the instance call_pdb |
|
832 | - force(False): by default, this routine checks the instance call_pdb | |
832 | flag and does not actually invoke the debugger if the flag is false. |
|
833 | flag and does not actually invoke the debugger if the flag is false. | |
833 | The 'force' option forces the debugger to activate even if the flag |
|
834 | The 'force' option forces the debugger to activate even if the flag | |
834 | is false. |
|
835 | is false. | |
835 | """ |
|
836 | """ | |
836 |
|
837 | |||
837 | if not (force or self.call_pdb): |
|
838 | if not (force or self.call_pdb): | |
838 | return |
|
839 | return | |
839 |
|
840 | |||
840 | if not hasattr(sys,'last_traceback'): |
|
841 | if not hasattr(sys,'last_traceback'): | |
841 | error('No traceback has been produced, nothing to debug.') |
|
842 | error('No traceback has been produced, nothing to debug.') | |
842 | return |
|
843 | return | |
843 |
|
844 | |||
844 | # use pydb if available |
|
845 | # use pydb if available | |
845 | if debugger.has_pydb: |
|
846 | if debugger.has_pydb: | |
846 | from pydb import pm |
|
847 | from pydb import pm | |
847 | else: |
|
848 | else: | |
848 | # fallback to our internal debugger |
|
849 | # fallback to our internal debugger | |
849 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
850 | pm = lambda : self.InteractiveTB.debugger(force=True) | |
850 |
|
851 | |||
851 | with self.readline_no_record: |
|
852 | with self.readline_no_record: | |
852 | pm() |
|
853 | pm() | |
853 |
|
854 | |||
854 | #------------------------------------------------------------------------- |
|
855 | #------------------------------------------------------------------------- | |
855 | # Things related to IPython's various namespaces |
|
856 | # Things related to IPython's various namespaces | |
856 | #------------------------------------------------------------------------- |
|
857 | #------------------------------------------------------------------------- | |
857 |
|
858 | |||
858 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
859 | def init_create_namespaces(self, user_module=None, user_ns=None): | |
859 | # Create the namespace where the user will operate. user_ns is |
|
860 | # Create the namespace where the user will operate. user_ns is | |
860 | # normally the only one used, and it is passed to the exec calls as |
|
861 | # normally the only one used, and it is passed to the exec calls as | |
861 | # the locals argument. But we do carry a user_global_ns namespace |
|
862 | # the locals argument. But we do carry a user_global_ns namespace | |
862 | # given as the exec 'globals' argument, This is useful in embedding |
|
863 | # given as the exec 'globals' argument, This is useful in embedding | |
863 | # situations where the ipython shell opens in a context where the |
|
864 | # situations where the ipython shell opens in a context where the | |
864 | # distinction between locals and globals is meaningful. For |
|
865 | # distinction between locals and globals is meaningful. For | |
865 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
866 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
866 |
|
867 | |||
867 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
868 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
868 | # level as a dict instead of a module. This is a manual fix, but I |
|
869 | # level as a dict instead of a module. This is a manual fix, but I | |
869 | # should really track down where the problem is coming from. Alex |
|
870 | # should really track down where the problem is coming from. Alex | |
870 | # Schmolck reported this problem first. |
|
871 | # Schmolck reported this problem first. | |
871 |
|
872 | |||
872 | # A useful post by Alex Martelli on this topic: |
|
873 | # A useful post by Alex Martelli on this topic: | |
873 | # Re: inconsistent value from __builtins__ |
|
874 | # Re: inconsistent value from __builtins__ | |
874 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
875 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
875 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
876 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
876 | # Gruppen: comp.lang.python |
|
877 | # Gruppen: comp.lang.python | |
877 |
|
878 | |||
878 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
879 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
879 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
880 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
880 | # > <type 'dict'> |
|
881 | # > <type 'dict'> | |
881 | # > >>> print type(__builtins__) |
|
882 | # > >>> print type(__builtins__) | |
882 | # > <type 'module'> |
|
883 | # > <type 'module'> | |
883 | # > Is this difference in return value intentional? |
|
884 | # > Is this difference in return value intentional? | |
884 |
|
885 | |||
885 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
886 | # Well, it's documented that '__builtins__' can be either a dictionary | |
886 | # or a module, and it's been that way for a long time. Whether it's |
|
887 | # or a module, and it's been that way for a long time. Whether it's | |
887 | # intentional (or sensible), I don't know. In any case, the idea is |
|
888 | # intentional (or sensible), I don't know. In any case, the idea is | |
888 | # that if you need to access the built-in namespace directly, you |
|
889 | # that if you need to access the built-in namespace directly, you | |
889 | # should start with "import __builtin__" (note, no 's') which will |
|
890 | # should start with "import __builtin__" (note, no 's') which will | |
890 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
891 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
891 |
|
892 | |||
892 | # These routines return a properly built module and dict as needed by |
|
893 | # These routines return a properly built module and dict as needed by | |
893 | # the rest of the code, and can also be used by extension writers to |
|
894 | # the rest of the code, and can also be used by extension writers to | |
894 | # generate properly initialized namespaces. |
|
895 | # generate properly initialized namespaces. | |
895 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
896 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) | |
896 |
|
897 | |||
897 | # A record of hidden variables we have added to the user namespace, so |
|
898 | # A record of hidden variables we have added to the user namespace, so | |
898 | # we can list later only variables defined in actual interactive use. |
|
899 | # we can list later only variables defined in actual interactive use. | |
899 | self.user_ns_hidden = set() |
|
900 | self.user_ns_hidden = set() | |
900 |
|
901 | |||
901 | # Now that FakeModule produces a real module, we've run into a nasty |
|
902 | # Now that FakeModule produces a real module, we've run into a nasty | |
902 | # problem: after script execution (via %run), the module where the user |
|
903 | # problem: after script execution (via %run), the module where the user | |
903 | # code ran is deleted. Now that this object is a true module (needed |
|
904 | # code ran is deleted. Now that this object is a true module (needed | |
904 | # so docetst and other tools work correctly), the Python module |
|
905 | # so docetst and other tools work correctly), the Python module | |
905 | # teardown mechanism runs over it, and sets to None every variable |
|
906 | # teardown mechanism runs over it, and sets to None every variable | |
906 | # present in that module. Top-level references to objects from the |
|
907 | # present in that module. Top-level references to objects from the | |
907 | # script survive, because the user_ns is updated with them. However, |
|
908 | # script survive, because the user_ns is updated with them. However, | |
908 | # calling functions defined in the script that use other things from |
|
909 | # calling functions defined in the script that use other things from | |
909 | # the script will fail, because the function's closure had references |
|
910 | # the script will fail, because the function's closure had references | |
910 | # to the original objects, which are now all None. So we must protect |
|
911 | # to the original objects, which are now all None. So we must protect | |
911 | # these modules from deletion by keeping a cache. |
|
912 | # these modules from deletion by keeping a cache. | |
912 | # |
|
913 | # | |
913 | # To avoid keeping stale modules around (we only need the one from the |
|
914 | # To avoid keeping stale modules around (we only need the one from the | |
914 | # last run), we use a dict keyed with the full path to the script, so |
|
915 | # last run), we use a dict keyed with the full path to the script, so | |
915 | # only the last version of the module is held in the cache. Note, |
|
916 | # only the last version of the module is held in the cache. Note, | |
916 | # however, that we must cache the module *namespace contents* (their |
|
917 | # however, that we must cache the module *namespace contents* (their | |
917 | # __dict__). Because if we try to cache the actual modules, old ones |
|
918 | # __dict__). Because if we try to cache the actual modules, old ones | |
918 | # (uncached) could be destroyed while still holding references (such as |
|
919 | # (uncached) could be destroyed while still holding references (such as | |
919 | # those held by GUI objects that tend to be long-lived)> |
|
920 | # those held by GUI objects that tend to be long-lived)> | |
920 | # |
|
921 | # | |
921 | # The %reset command will flush this cache. See the cache_main_mod() |
|
922 | # The %reset command will flush this cache. See the cache_main_mod() | |
922 | # and clear_main_mod_cache() methods for details on use. |
|
923 | # and clear_main_mod_cache() methods for details on use. | |
923 |
|
924 | |||
924 | # This is the cache used for 'main' namespaces |
|
925 | # This is the cache used for 'main' namespaces | |
925 | self._main_ns_cache = {} |
|
926 | self._main_ns_cache = {} | |
926 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
927 | # And this is the single instance of FakeModule whose __dict__ we keep | |
927 | # copying and clearing for reuse on each %run |
|
928 | # copying and clearing for reuse on each %run | |
928 | self._user_main_module = FakeModule() |
|
929 | self._user_main_module = FakeModule() | |
929 |
|
930 | |||
930 | # A table holding all the namespaces IPython deals with, so that |
|
931 | # A table holding all the namespaces IPython deals with, so that | |
931 | # introspection facilities can search easily. |
|
932 | # introspection facilities can search easily. | |
932 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
933 | self.ns_table = {'user_global':self.user_module.__dict__, | |
933 | 'user_local':user_ns, |
|
934 | 'user_local':user_ns, | |
934 | 'builtin':builtin_mod.__dict__ |
|
935 | 'builtin':builtin_mod.__dict__ | |
935 | } |
|
936 | } | |
936 |
|
937 | |||
937 | @property |
|
938 | @property | |
938 | def user_global_ns(self): |
|
939 | def user_global_ns(self): | |
939 | return self.user_module.__dict__ |
|
940 | return self.user_module.__dict__ | |
940 |
|
941 | |||
941 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
942 | def prepare_user_module(self, user_module=None, user_ns=None): | |
942 | """Prepare the module and namespace in which user code will be run. |
|
943 | """Prepare the module and namespace in which user code will be run. | |
943 |
|
944 | |||
944 | When IPython is started normally, both parameters are None: a new module |
|
945 | When IPython is started normally, both parameters are None: a new module | |
945 | is created automatically, and its __dict__ used as the namespace. |
|
946 | is created automatically, and its __dict__ used as the namespace. | |
946 |
|
947 | |||
947 | If only user_module is provided, its __dict__ is used as the namespace. |
|
948 | If only user_module is provided, its __dict__ is used as the namespace. | |
948 | If only user_ns is provided, a dummy module is created, and user_ns |
|
949 | If only user_ns is provided, a dummy module is created, and user_ns | |
949 | becomes the global namespace. If both are provided (as they may be |
|
950 | becomes the global namespace. If both are provided (as they may be | |
950 | when embedding), user_ns is the local namespace, and user_module |
|
951 | when embedding), user_ns is the local namespace, and user_module | |
951 | provides the global namespace. |
|
952 | provides the global namespace. | |
952 |
|
953 | |||
953 | Parameters |
|
954 | Parameters | |
954 | ---------- |
|
955 | ---------- | |
955 | user_module : module, optional |
|
956 | user_module : module, optional | |
956 | The current user module in which IPython is being run. If None, |
|
957 | The current user module in which IPython is being run. If None, | |
957 | a clean module will be created. |
|
958 | a clean module will be created. | |
958 | user_ns : dict, optional |
|
959 | user_ns : dict, optional | |
959 | A namespace in which to run interactive commands. |
|
960 | A namespace in which to run interactive commands. | |
960 |
|
961 | |||
961 | Returns |
|
962 | Returns | |
962 | ------- |
|
963 | ------- | |
963 | A tuple of user_module and user_ns, each properly initialised. |
|
964 | A tuple of user_module and user_ns, each properly initialised. | |
964 | """ |
|
965 | """ | |
965 | if user_module is None and user_ns is not None: |
|
966 | if user_module is None and user_ns is not None: | |
966 | user_ns.setdefault("__name__", "__main__") |
|
967 | user_ns.setdefault("__name__", "__main__") | |
967 | class DummyMod(object): |
|
968 | class DummyMod(object): | |
968 | "A dummy module used for IPython's interactive namespace." |
|
969 | "A dummy module used for IPython's interactive namespace." | |
969 | pass |
|
970 | pass | |
970 | user_module = DummyMod() |
|
971 | user_module = DummyMod() | |
971 | user_module.__dict__ = user_ns |
|
972 | user_module.__dict__ = user_ns | |
972 |
|
973 | |||
973 | if user_module is None: |
|
974 | if user_module is None: | |
974 | user_module = types.ModuleType("__main__", |
|
975 | user_module = types.ModuleType("__main__", | |
975 | doc="Automatically created module for IPython interactive environment") |
|
976 | doc="Automatically created module for IPython interactive environment") | |
976 |
|
977 | |||
977 | # We must ensure that __builtin__ (without the final 's') is always |
|
978 | # We must ensure that __builtin__ (without the final 's') is always | |
978 | # available and pointing to the __builtin__ *module*. For more details: |
|
979 | # available and pointing to the __builtin__ *module*. For more details: | |
979 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
980 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
980 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
981 | user_module.__dict__.setdefault('__builtin__', builtin_mod) | |
981 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
982 | user_module.__dict__.setdefault('__builtins__', builtin_mod) | |
982 |
|
983 | |||
983 | if user_ns is None: |
|
984 | if user_ns is None: | |
984 | user_ns = user_module.__dict__ |
|
985 | user_ns = user_module.__dict__ | |
985 |
|
986 | |||
986 | return user_module, user_ns |
|
987 | return user_module, user_ns | |
987 |
|
988 | |||
988 | def init_sys_modules(self): |
|
989 | def init_sys_modules(self): | |
989 | # We need to insert into sys.modules something that looks like a |
|
990 | # We need to insert into sys.modules something that looks like a | |
990 | # module but which accesses the IPython namespace, for shelve and |
|
991 | # module but which accesses the IPython namespace, for shelve and | |
991 | # pickle to work interactively. Normally they rely on getting |
|
992 | # pickle to work interactively. Normally they rely on getting | |
992 | # everything out of __main__, but for embedding purposes each IPython |
|
993 | # everything out of __main__, but for embedding purposes each IPython | |
993 | # instance has its own private namespace, so we can't go shoving |
|
994 | # instance has its own private namespace, so we can't go shoving | |
994 | # everything into __main__. |
|
995 | # everything into __main__. | |
995 |
|
996 | |||
996 | # note, however, that we should only do this for non-embedded |
|
997 | # note, however, that we should only do this for non-embedded | |
997 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
998 | # ipythons, which really mimic the __main__.__dict__ with their own | |
998 | # namespace. Embedded instances, on the other hand, should not do |
|
999 | # namespace. Embedded instances, on the other hand, should not do | |
999 | # this because they need to manage the user local/global namespaces |
|
1000 | # this because they need to manage the user local/global namespaces | |
1000 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1001 | # only, but they live within a 'normal' __main__ (meaning, they | |
1001 | # shouldn't overtake the execution environment of the script they're |
|
1002 | # shouldn't overtake the execution environment of the script they're | |
1002 | # embedded in). |
|
1003 | # embedded in). | |
1003 |
|
1004 | |||
1004 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1005 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
1005 | main_name = self.user_module.__name__ |
|
1006 | main_name = self.user_module.__name__ | |
1006 | sys.modules[main_name] = self.user_module |
|
1007 | sys.modules[main_name] = self.user_module | |
1007 |
|
1008 | |||
1008 | def init_user_ns(self): |
|
1009 | def init_user_ns(self): | |
1009 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1010 | """Initialize all user-visible namespaces to their minimum defaults. | |
1010 |
|
1011 | |||
1011 | Certain history lists are also initialized here, as they effectively |
|
1012 | Certain history lists are also initialized here, as they effectively | |
1012 | act as user namespaces. |
|
1013 | act as user namespaces. | |
1013 |
|
1014 | |||
1014 | Notes |
|
1015 | Notes | |
1015 | ----- |
|
1016 | ----- | |
1016 | All data structures here are only filled in, they are NOT reset by this |
|
1017 | All data structures here are only filled in, they are NOT reset by this | |
1017 | method. If they were not empty before, data will simply be added to |
|
1018 | method. If they were not empty before, data will simply be added to | |
1018 | therm. |
|
1019 | therm. | |
1019 | """ |
|
1020 | """ | |
1020 | # This function works in two parts: first we put a few things in |
|
1021 | # This function works in two parts: first we put a few things in | |
1021 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1022 | # user_ns, and we sync that contents into user_ns_hidden so that these | |
1022 | # initial variables aren't shown by %who. After the sync, we add the |
|
1023 | # initial variables aren't shown by %who. After the sync, we add the | |
1023 | # rest of what we *do* want the user to see with %who even on a new |
|
1024 | # rest of what we *do* want the user to see with %who even on a new | |
1024 | # session (probably nothing, so theye really only see their own stuff) |
|
1025 | # session (probably nothing, so theye really only see their own stuff) | |
1025 |
|
1026 | |||
1026 | # The user dict must *always* have a __builtin__ reference to the |
|
1027 | # The user dict must *always* have a __builtin__ reference to the | |
1027 | # Python standard __builtin__ namespace, which must be imported. |
|
1028 | # Python standard __builtin__ namespace, which must be imported. | |
1028 | # This is so that certain operations in prompt evaluation can be |
|
1029 | # This is so that certain operations in prompt evaluation can be | |
1029 | # reliably executed with builtins. Note that we can NOT use |
|
1030 | # reliably executed with builtins. Note that we can NOT use | |
1030 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1031 | # __builtins__ (note the 's'), because that can either be a dict or a | |
1031 | # module, and can even mutate at runtime, depending on the context |
|
1032 | # module, and can even mutate at runtime, depending on the context | |
1032 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1033 | # (Python makes no guarantees on it). In contrast, __builtin__ is | |
1033 | # always a module object, though it must be explicitly imported. |
|
1034 | # always a module object, though it must be explicitly imported. | |
1034 |
|
1035 | |||
1035 | # For more details: |
|
1036 | # For more details: | |
1036 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1037 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1037 | ns = dict() |
|
1038 | ns = dict() | |
1038 |
|
1039 | |||
1039 | # Put 'help' in the user namespace |
|
1040 | # Put 'help' in the user namespace | |
1040 | try: |
|
1041 | try: | |
1041 | from site import _Helper |
|
1042 | from site import _Helper | |
1042 | ns['help'] = _Helper() |
|
1043 | ns['help'] = _Helper() | |
1043 | except ImportError: |
|
1044 | except ImportError: | |
1044 | warn('help() not available - check site.py') |
|
1045 | warn('help() not available - check site.py') | |
1045 |
|
1046 | |||
1046 | # make global variables for user access to the histories |
|
1047 | # make global variables for user access to the histories | |
1047 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1048 | ns['_ih'] = self.history_manager.input_hist_parsed | |
1048 | ns['_oh'] = self.history_manager.output_hist |
|
1049 | ns['_oh'] = self.history_manager.output_hist | |
1049 | ns['_dh'] = self.history_manager.dir_hist |
|
1050 | ns['_dh'] = self.history_manager.dir_hist | |
1050 |
|
1051 | |||
1051 | ns['_sh'] = shadowns |
|
1052 | ns['_sh'] = shadowns | |
1052 |
|
1053 | |||
1053 | # user aliases to input and output histories. These shouldn't show up |
|
1054 | # user aliases to input and output histories. These shouldn't show up | |
1054 | # in %who, as they can have very large reprs. |
|
1055 | # in %who, as they can have very large reprs. | |
1055 | ns['In'] = self.history_manager.input_hist_parsed |
|
1056 | ns['In'] = self.history_manager.input_hist_parsed | |
1056 | ns['Out'] = self.history_manager.output_hist |
|
1057 | ns['Out'] = self.history_manager.output_hist | |
1057 |
|
1058 | |||
1058 | # Store myself as the public api!!! |
|
1059 | # Store myself as the public api!!! | |
1059 | ns['get_ipython'] = self.get_ipython |
|
1060 | ns['get_ipython'] = self.get_ipython | |
1060 |
|
1061 | |||
1061 | ns['exit'] = self.exiter |
|
1062 | ns['exit'] = self.exiter | |
1062 | ns['quit'] = self.exiter |
|
1063 | ns['quit'] = self.exiter | |
1063 |
|
1064 | |||
1064 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1065 | # Sync what we've added so far to user_ns_hidden so these aren't seen | |
1065 | # by %who |
|
1066 | # by %who | |
1066 | self.user_ns_hidden.update(ns) |
|
1067 | self.user_ns_hidden.update(ns) | |
1067 |
|
1068 | |||
1068 | # Anything put into ns now would show up in %who. Think twice before |
|
1069 | # Anything put into ns now would show up in %who. Think twice before | |
1069 | # putting anything here, as we really want %who to show the user their |
|
1070 | # putting anything here, as we really want %who to show the user their | |
1070 | # stuff, not our variables. |
|
1071 | # stuff, not our variables. | |
1071 |
|
1072 | |||
1072 | # Finally, update the real user's namespace |
|
1073 | # Finally, update the real user's namespace | |
1073 | self.user_ns.update(ns) |
|
1074 | self.user_ns.update(ns) | |
1074 |
|
1075 | |||
1075 | @property |
|
1076 | @property | |
1076 | def all_ns_refs(self): |
|
1077 | def all_ns_refs(self): | |
1077 | """Get a list of references to all the namespace dictionaries in which |
|
1078 | """Get a list of references to all the namespace dictionaries in which | |
1078 | IPython might store a user-created object. |
|
1079 | IPython might store a user-created object. | |
1079 |
|
1080 | |||
1080 | Note that this does not include the displayhook, which also caches |
|
1081 | Note that this does not include the displayhook, which also caches | |
1081 | objects from the output.""" |
|
1082 | objects from the output.""" | |
1082 | return [self.user_ns, self.user_global_ns, |
|
1083 | return [self.user_ns, self.user_global_ns, | |
1083 | self._user_main_module.__dict__] + self._main_ns_cache.values() |
|
1084 | self._user_main_module.__dict__] + self._main_ns_cache.values() | |
1084 |
|
1085 | |||
1085 | def reset(self, new_session=True): |
|
1086 | def reset(self, new_session=True): | |
1086 | """Clear all internal namespaces, and attempt to release references to |
|
1087 | """Clear all internal namespaces, and attempt to release references to | |
1087 | user objects. |
|
1088 | user objects. | |
1088 |
|
1089 | |||
1089 | If new_session is True, a new history session will be opened. |
|
1090 | If new_session is True, a new history session will be opened. | |
1090 | """ |
|
1091 | """ | |
1091 | # Clear histories |
|
1092 | # Clear histories | |
1092 | self.history_manager.reset(new_session) |
|
1093 | self.history_manager.reset(new_session) | |
1093 | # Reset counter used to index all histories |
|
1094 | # Reset counter used to index all histories | |
1094 | if new_session: |
|
1095 | if new_session: | |
1095 | self.execution_count = 1 |
|
1096 | self.execution_count = 1 | |
1096 |
|
1097 | |||
1097 | # Flush cached output items |
|
1098 | # Flush cached output items | |
1098 | if self.displayhook.do_full_cache: |
|
1099 | if self.displayhook.do_full_cache: | |
1099 | self.displayhook.flush() |
|
1100 | self.displayhook.flush() | |
1100 |
|
1101 | |||
1101 | # The main execution namespaces must be cleared very carefully, |
|
1102 | # The main execution namespaces must be cleared very carefully, | |
1102 | # skipping the deletion of the builtin-related keys, because doing so |
|
1103 | # skipping the deletion of the builtin-related keys, because doing so | |
1103 | # would cause errors in many object's __del__ methods. |
|
1104 | # would cause errors in many object's __del__ methods. | |
1104 | if self.user_ns is not self.user_global_ns: |
|
1105 | if self.user_ns is not self.user_global_ns: | |
1105 | self.user_ns.clear() |
|
1106 | self.user_ns.clear() | |
1106 | ns = self.user_global_ns |
|
1107 | ns = self.user_global_ns | |
1107 | drop_keys = set(ns.keys()) |
|
1108 | drop_keys = set(ns.keys()) | |
1108 | drop_keys.discard('__builtin__') |
|
1109 | drop_keys.discard('__builtin__') | |
1109 | drop_keys.discard('__builtins__') |
|
1110 | drop_keys.discard('__builtins__') | |
1110 | drop_keys.discard('__name__') |
|
1111 | drop_keys.discard('__name__') | |
1111 | for k in drop_keys: |
|
1112 | for k in drop_keys: | |
1112 | del ns[k] |
|
1113 | del ns[k] | |
1113 |
|
1114 | |||
1114 | self.user_ns_hidden.clear() |
|
1115 | self.user_ns_hidden.clear() | |
1115 |
|
1116 | |||
1116 | # Restore the user namespaces to minimal usability |
|
1117 | # Restore the user namespaces to minimal usability | |
1117 | self.init_user_ns() |
|
1118 | self.init_user_ns() | |
1118 |
|
1119 | |||
1119 | # Restore the default and user aliases |
|
1120 | # Restore the default and user aliases | |
1120 | self.alias_manager.clear_aliases() |
|
1121 | self.alias_manager.clear_aliases() | |
1121 | self.alias_manager.init_aliases() |
|
1122 | self.alias_manager.init_aliases() | |
1122 |
|
1123 | |||
1123 | # Flush the private list of module references kept for script |
|
1124 | # Flush the private list of module references kept for script | |
1124 | # execution protection |
|
1125 | # execution protection | |
1125 | self.clear_main_mod_cache() |
|
1126 | self.clear_main_mod_cache() | |
1126 |
|
1127 | |||
1127 | # Clear out the namespace from the last %run |
|
1128 | # Clear out the namespace from the last %run | |
1128 | self.new_main_mod() |
|
1129 | self.new_main_mod() | |
1129 |
|
1130 | |||
1130 | def del_var(self, varname, by_name=False): |
|
1131 | def del_var(self, varname, by_name=False): | |
1131 | """Delete a variable from the various namespaces, so that, as |
|
1132 | """Delete a variable from the various namespaces, so that, as | |
1132 | far as possible, we're not keeping any hidden references to it. |
|
1133 | far as possible, we're not keeping any hidden references to it. | |
1133 |
|
1134 | |||
1134 | Parameters |
|
1135 | Parameters | |
1135 | ---------- |
|
1136 | ---------- | |
1136 | varname : str |
|
1137 | varname : str | |
1137 | The name of the variable to delete. |
|
1138 | The name of the variable to delete. | |
1138 | by_name : bool |
|
1139 | by_name : bool | |
1139 | If True, delete variables with the given name in each |
|
1140 | If True, delete variables with the given name in each | |
1140 | namespace. If False (default), find the variable in the user |
|
1141 | namespace. If False (default), find the variable in the user | |
1141 | namespace, and delete references to it. |
|
1142 | namespace, and delete references to it. | |
1142 | """ |
|
1143 | """ | |
1143 | if varname in ('__builtin__', '__builtins__'): |
|
1144 | if varname in ('__builtin__', '__builtins__'): | |
1144 | raise ValueError("Refusing to delete %s" % varname) |
|
1145 | raise ValueError("Refusing to delete %s" % varname) | |
1145 |
|
1146 | |||
1146 | ns_refs = self.all_ns_refs |
|
1147 | ns_refs = self.all_ns_refs | |
1147 |
|
1148 | |||
1148 | if by_name: # Delete by name |
|
1149 | if by_name: # Delete by name | |
1149 | for ns in ns_refs: |
|
1150 | for ns in ns_refs: | |
1150 | try: |
|
1151 | try: | |
1151 | del ns[varname] |
|
1152 | del ns[varname] | |
1152 | except KeyError: |
|
1153 | except KeyError: | |
1153 | pass |
|
1154 | pass | |
1154 | else: # Delete by object |
|
1155 | else: # Delete by object | |
1155 | try: |
|
1156 | try: | |
1156 | obj = self.user_ns[varname] |
|
1157 | obj = self.user_ns[varname] | |
1157 | except KeyError: |
|
1158 | except KeyError: | |
1158 | raise NameError("name '%s' is not defined" % varname) |
|
1159 | raise NameError("name '%s' is not defined" % varname) | |
1159 | # Also check in output history |
|
1160 | # Also check in output history | |
1160 | ns_refs.append(self.history_manager.output_hist) |
|
1161 | ns_refs.append(self.history_manager.output_hist) | |
1161 | for ns in ns_refs: |
|
1162 | for ns in ns_refs: | |
1162 | to_delete = [n for n, o in ns.iteritems() if o is obj] |
|
1163 | to_delete = [n for n, o in ns.iteritems() if o is obj] | |
1163 | for name in to_delete: |
|
1164 | for name in to_delete: | |
1164 | del ns[name] |
|
1165 | del ns[name] | |
1165 |
|
1166 | |||
1166 | # displayhook keeps extra references, but not in a dictionary |
|
1167 | # displayhook keeps extra references, but not in a dictionary | |
1167 | for name in ('_', '__', '___'): |
|
1168 | for name in ('_', '__', '___'): | |
1168 | if getattr(self.displayhook, name) is obj: |
|
1169 | if getattr(self.displayhook, name) is obj: | |
1169 | setattr(self.displayhook, name, None) |
|
1170 | setattr(self.displayhook, name, None) | |
1170 |
|
1171 | |||
1171 | def reset_selective(self, regex=None): |
|
1172 | def reset_selective(self, regex=None): | |
1172 | """Clear selective variables from internal namespaces based on a |
|
1173 | """Clear selective variables from internal namespaces based on a | |
1173 | specified regular expression. |
|
1174 | specified regular expression. | |
1174 |
|
1175 | |||
1175 | Parameters |
|
1176 | Parameters | |
1176 | ---------- |
|
1177 | ---------- | |
1177 | regex : string or compiled pattern, optional |
|
1178 | regex : string or compiled pattern, optional | |
1178 | A regular expression pattern that will be used in searching |
|
1179 | A regular expression pattern that will be used in searching | |
1179 | variable names in the users namespaces. |
|
1180 | variable names in the users namespaces. | |
1180 | """ |
|
1181 | """ | |
1181 | if regex is not None: |
|
1182 | if regex is not None: | |
1182 | try: |
|
1183 | try: | |
1183 | m = re.compile(regex) |
|
1184 | m = re.compile(regex) | |
1184 | except TypeError: |
|
1185 | except TypeError: | |
1185 | raise TypeError('regex must be a string or compiled pattern') |
|
1186 | raise TypeError('regex must be a string or compiled pattern') | |
1186 | # Search for keys in each namespace that match the given regex |
|
1187 | # Search for keys in each namespace that match the given regex | |
1187 | # If a match is found, delete the key/value pair. |
|
1188 | # If a match is found, delete the key/value pair. | |
1188 | for ns in self.all_ns_refs: |
|
1189 | for ns in self.all_ns_refs: | |
1189 | for var in ns: |
|
1190 | for var in ns: | |
1190 | if m.search(var): |
|
1191 | if m.search(var): | |
1191 | del ns[var] |
|
1192 | del ns[var] | |
1192 |
|
1193 | |||
1193 | def push(self, variables, interactive=True): |
|
1194 | def push(self, variables, interactive=True): | |
1194 | """Inject a group of variables into the IPython user namespace. |
|
1195 | """Inject a group of variables into the IPython user namespace. | |
1195 |
|
1196 | |||
1196 | Parameters |
|
1197 | Parameters | |
1197 | ---------- |
|
1198 | ---------- | |
1198 | variables : dict, str or list/tuple of str |
|
1199 | variables : dict, str or list/tuple of str | |
1199 | The variables to inject into the user's namespace. If a dict, a |
|
1200 | The variables to inject into the user's namespace. If a dict, a | |
1200 | simple update is done. If a str, the string is assumed to have |
|
1201 | simple update is done. If a str, the string is assumed to have | |
1201 | variable names separated by spaces. A list/tuple of str can also |
|
1202 | variable names separated by spaces. A list/tuple of str can also | |
1202 | be used to give the variable names. If just the variable names are |
|
1203 | be used to give the variable names. If just the variable names are | |
1203 | give (list/tuple/str) then the variable values looked up in the |
|
1204 | give (list/tuple/str) then the variable values looked up in the | |
1204 | callers frame. |
|
1205 | callers frame. | |
1205 | interactive : bool |
|
1206 | interactive : bool | |
1206 | If True (default), the variables will be listed with the ``who`` |
|
1207 | If True (default), the variables will be listed with the ``who`` | |
1207 | magic. |
|
1208 | magic. | |
1208 | """ |
|
1209 | """ | |
1209 | vdict = None |
|
1210 | vdict = None | |
1210 |
|
1211 | |||
1211 | # We need a dict of name/value pairs to do namespace updates. |
|
1212 | # We need a dict of name/value pairs to do namespace updates. | |
1212 | if isinstance(variables, dict): |
|
1213 | if isinstance(variables, dict): | |
1213 | vdict = variables |
|
1214 | vdict = variables | |
1214 | elif isinstance(variables, (basestring, list, tuple)): |
|
1215 | elif isinstance(variables, (basestring, list, tuple)): | |
1215 | if isinstance(variables, basestring): |
|
1216 | if isinstance(variables, basestring): | |
1216 | vlist = variables.split() |
|
1217 | vlist = variables.split() | |
1217 | else: |
|
1218 | else: | |
1218 | vlist = variables |
|
1219 | vlist = variables | |
1219 | vdict = {} |
|
1220 | vdict = {} | |
1220 | cf = sys._getframe(1) |
|
1221 | cf = sys._getframe(1) | |
1221 | for name in vlist: |
|
1222 | for name in vlist: | |
1222 | try: |
|
1223 | try: | |
1223 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1224 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) | |
1224 | except: |
|
1225 | except: | |
1225 | print ('Could not get variable %s from %s' % |
|
1226 | print ('Could not get variable %s from %s' % | |
1226 | (name,cf.f_code.co_name)) |
|
1227 | (name,cf.f_code.co_name)) | |
1227 | else: |
|
1228 | else: | |
1228 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1229 | raise ValueError('variables must be a dict/str/list/tuple') | |
1229 |
|
1230 | |||
1230 | # Propagate variables to user namespace |
|
1231 | # Propagate variables to user namespace | |
1231 | self.user_ns.update(vdict) |
|
1232 | self.user_ns.update(vdict) | |
1232 |
|
1233 | |||
1233 | # And configure interactive visibility |
|
1234 | # And configure interactive visibility | |
1234 | user_ns_hidden = self.user_ns_hidden |
|
1235 | user_ns_hidden = self.user_ns_hidden | |
1235 | if interactive: |
|
1236 | if interactive: | |
1236 | user_ns_hidden.difference_update(vdict) |
|
1237 | user_ns_hidden.difference_update(vdict) | |
1237 | else: |
|
1238 | else: | |
1238 | user_ns_hidden.update(vdict) |
|
1239 | user_ns_hidden.update(vdict) | |
1239 |
|
1240 | |||
1240 | def drop_by_id(self, variables): |
|
1241 | def drop_by_id(self, variables): | |
1241 | """Remove a dict of variables from the user namespace, if they are the |
|
1242 | """Remove a dict of variables from the user namespace, if they are the | |
1242 | same as the values in the dictionary. |
|
1243 | same as the values in the dictionary. | |
1243 |
|
1244 | |||
1244 | This is intended for use by extensions: variables that they've added can |
|
1245 | This is intended for use by extensions: variables that they've added can | |
1245 | be taken back out if they are unloaded, without removing any that the |
|
1246 | be taken back out if they are unloaded, without removing any that the | |
1246 | user has overwritten. |
|
1247 | user has overwritten. | |
1247 |
|
1248 | |||
1248 | Parameters |
|
1249 | Parameters | |
1249 | ---------- |
|
1250 | ---------- | |
1250 | variables : dict |
|
1251 | variables : dict | |
1251 | A dictionary mapping object names (as strings) to the objects. |
|
1252 | A dictionary mapping object names (as strings) to the objects. | |
1252 | """ |
|
1253 | """ | |
1253 | for name, obj in variables.iteritems(): |
|
1254 | for name, obj in variables.iteritems(): | |
1254 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1255 | if name in self.user_ns and self.user_ns[name] is obj: | |
1255 | del self.user_ns[name] |
|
1256 | del self.user_ns[name] | |
1256 | self.user_ns_hidden.discard(name) |
|
1257 | self.user_ns_hidden.discard(name) | |
1257 |
|
1258 | |||
1258 | #------------------------------------------------------------------------- |
|
1259 | #------------------------------------------------------------------------- | |
1259 | # Things related to object introspection |
|
1260 | # Things related to object introspection | |
1260 | #------------------------------------------------------------------------- |
|
1261 | #------------------------------------------------------------------------- | |
1261 |
|
1262 | |||
1262 | def _ofind(self, oname, namespaces=None): |
|
1263 | def _ofind(self, oname, namespaces=None): | |
1263 | """Find an object in the available namespaces. |
|
1264 | """Find an object in the available namespaces. | |
1264 |
|
1265 | |||
1265 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1266 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic | |
1266 |
|
1267 | |||
1267 | Has special code to detect magic functions. |
|
1268 | Has special code to detect magic functions. | |
1268 | """ |
|
1269 | """ | |
1269 | oname = oname.strip() |
|
1270 | oname = oname.strip() | |
1270 | #print '1- oname: <%r>' % oname # dbg |
|
1271 | #print '1- oname: <%r>' % oname # dbg | |
1271 | if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True): |
|
1272 | if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True): | |
1272 | return dict(found=False) |
|
1273 | return dict(found=False) | |
1273 |
|
1274 | |||
1274 | alias_ns = None |
|
1275 | alias_ns = None | |
1275 | if namespaces is None: |
|
1276 | if namespaces is None: | |
1276 | # Namespaces to search in: |
|
1277 | # Namespaces to search in: | |
1277 | # Put them in a list. The order is important so that we |
|
1278 | # Put them in a list. The order is important so that we | |
1278 | # find things in the same order that Python finds them. |
|
1279 | # find things in the same order that Python finds them. | |
1279 | namespaces = [ ('Interactive', self.user_ns), |
|
1280 | namespaces = [ ('Interactive', self.user_ns), | |
1280 | ('Interactive (global)', self.user_global_ns), |
|
1281 | ('Interactive (global)', self.user_global_ns), | |
1281 | ('Python builtin', builtin_mod.__dict__), |
|
1282 | ('Python builtin', builtin_mod.__dict__), | |
1282 | ('Alias', self.alias_manager.alias_table), |
|
1283 | ('Alias', self.alias_manager.alias_table), | |
1283 | ] |
|
1284 | ] | |
1284 | alias_ns = self.alias_manager.alias_table |
|
1285 | alias_ns = self.alias_manager.alias_table | |
1285 |
|
1286 | |||
1286 | # initialize results to 'null' |
|
1287 | # initialize results to 'null' | |
1287 | found = False; obj = None; ospace = None; ds = None; |
|
1288 | found = False; obj = None; ospace = None; ds = None; | |
1288 | ismagic = False; isalias = False; parent = None |
|
1289 | ismagic = False; isalias = False; parent = None | |
1289 |
|
1290 | |||
1290 | # We need to special-case 'print', which as of python2.6 registers as a |
|
1291 | # We need to special-case 'print', which as of python2.6 registers as a | |
1291 | # function but should only be treated as one if print_function was |
|
1292 | # function but should only be treated as one if print_function was | |
1292 | # loaded with a future import. In this case, just bail. |
|
1293 | # loaded with a future import. In this case, just bail. | |
1293 | if (oname == 'print' and not py3compat.PY3 and not \ |
|
1294 | if (oname == 'print' and not py3compat.PY3 and not \ | |
1294 | (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)): |
|
1295 | (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)): | |
1295 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1296 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1296 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1297 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1297 |
|
1298 | |||
1298 | # Look for the given name by splitting it in parts. If the head is |
|
1299 | # Look for the given name by splitting it in parts. If the head is | |
1299 | # found, then we look for all the remaining parts as members, and only |
|
1300 | # found, then we look for all the remaining parts as members, and only | |
1300 | # declare success if we can find them all. |
|
1301 | # declare success if we can find them all. | |
1301 | oname_parts = oname.split('.') |
|
1302 | oname_parts = oname.split('.') | |
1302 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1303 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] | |
1303 | for nsname,ns in namespaces: |
|
1304 | for nsname,ns in namespaces: | |
1304 | try: |
|
1305 | try: | |
1305 | obj = ns[oname_head] |
|
1306 | obj = ns[oname_head] | |
1306 | except KeyError: |
|
1307 | except KeyError: | |
1307 | continue |
|
1308 | continue | |
1308 | else: |
|
1309 | else: | |
1309 | #print 'oname_rest:', oname_rest # dbg |
|
1310 | #print 'oname_rest:', oname_rest # dbg | |
1310 | for part in oname_rest: |
|
1311 | for part in oname_rest: | |
1311 | try: |
|
1312 | try: | |
1312 | parent = obj |
|
1313 | parent = obj | |
1313 | obj = getattr(obj,part) |
|
1314 | obj = getattr(obj,part) | |
1314 | except: |
|
1315 | except: | |
1315 | # Blanket except b/c some badly implemented objects |
|
1316 | # Blanket except b/c some badly implemented objects | |
1316 | # allow __getattr__ to raise exceptions other than |
|
1317 | # allow __getattr__ to raise exceptions other than | |
1317 | # AttributeError, which then crashes IPython. |
|
1318 | # AttributeError, which then crashes IPython. | |
1318 | break |
|
1319 | break | |
1319 | else: |
|
1320 | else: | |
1320 | # If we finish the for loop (no break), we got all members |
|
1321 | # If we finish the for loop (no break), we got all members | |
1321 | found = True |
|
1322 | found = True | |
1322 | ospace = nsname |
|
1323 | ospace = nsname | |
1323 | if ns == alias_ns: |
|
1324 | if ns == alias_ns: | |
1324 | isalias = True |
|
1325 | isalias = True | |
1325 | break # namespace loop |
|
1326 | break # namespace loop | |
1326 |
|
1327 | |||
1327 | # Try to see if it's magic |
|
1328 | # Try to see if it's magic | |
1328 | if not found: |
|
1329 | if not found: | |
1329 | if oname.startswith(ESC_MAGIC): |
|
1330 | if oname.startswith(ESC_MAGIC): | |
1330 | oname = oname[1:] |
|
1331 | oname = oname[1:] | |
1331 | obj = getattr(self,'magic_'+oname,None) |
|
1332 | obj = getattr(self,'magic_'+oname,None) | |
1332 | if obj is not None: |
|
1333 | if obj is not None: | |
1333 | found = True |
|
1334 | found = True | |
1334 | ospace = 'IPython internal' |
|
1335 | ospace = 'IPython internal' | |
1335 | ismagic = True |
|
1336 | ismagic = True | |
1336 |
|
1337 | |||
1337 | # Last try: special-case some literals like '', [], {}, etc: |
|
1338 | # Last try: special-case some literals like '', [], {}, etc: | |
1338 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1339 | if not found and oname_head in ["''",'""','[]','{}','()']: | |
1339 | obj = eval(oname_head) |
|
1340 | obj = eval(oname_head) | |
1340 | found = True |
|
1341 | found = True | |
1341 | ospace = 'Interactive' |
|
1342 | ospace = 'Interactive' | |
1342 |
|
1343 | |||
1343 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1344 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1344 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1345 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1345 |
|
1346 | |||
1346 | def _ofind_property(self, oname, info): |
|
1347 | def _ofind_property(self, oname, info): | |
1347 | """Second part of object finding, to look for property details.""" |
|
1348 | """Second part of object finding, to look for property details.""" | |
1348 | if info.found: |
|
1349 | if info.found: | |
1349 | # Get the docstring of the class property if it exists. |
|
1350 | # Get the docstring of the class property if it exists. | |
1350 | path = oname.split('.') |
|
1351 | path = oname.split('.') | |
1351 | root = '.'.join(path[:-1]) |
|
1352 | root = '.'.join(path[:-1]) | |
1352 | if info.parent is not None: |
|
1353 | if info.parent is not None: | |
1353 | try: |
|
1354 | try: | |
1354 | target = getattr(info.parent, '__class__') |
|
1355 | target = getattr(info.parent, '__class__') | |
1355 | # The object belongs to a class instance. |
|
1356 | # The object belongs to a class instance. | |
1356 | try: |
|
1357 | try: | |
1357 | target = getattr(target, path[-1]) |
|
1358 | target = getattr(target, path[-1]) | |
1358 | # The class defines the object. |
|
1359 | # The class defines the object. | |
1359 | if isinstance(target, property): |
|
1360 | if isinstance(target, property): | |
1360 | oname = root + '.__class__.' + path[-1] |
|
1361 | oname = root + '.__class__.' + path[-1] | |
1361 | info = Struct(self._ofind(oname)) |
|
1362 | info = Struct(self._ofind(oname)) | |
1362 | except AttributeError: pass |
|
1363 | except AttributeError: pass | |
1363 | except AttributeError: pass |
|
1364 | except AttributeError: pass | |
1364 |
|
1365 | |||
1365 | # We return either the new info or the unmodified input if the object |
|
1366 | # We return either the new info or the unmodified input if the object | |
1366 | # hadn't been found |
|
1367 | # hadn't been found | |
1367 | return info |
|
1368 | return info | |
1368 |
|
1369 | |||
1369 | def _object_find(self, oname, namespaces=None): |
|
1370 | def _object_find(self, oname, namespaces=None): | |
1370 | """Find an object and return a struct with info about it.""" |
|
1371 | """Find an object and return a struct with info about it.""" | |
1371 | inf = Struct(self._ofind(oname, namespaces)) |
|
1372 | inf = Struct(self._ofind(oname, namespaces)) | |
1372 | return Struct(self._ofind_property(oname, inf)) |
|
1373 | return Struct(self._ofind_property(oname, inf)) | |
1373 |
|
1374 | |||
1374 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1375 | def _inspect(self, meth, oname, namespaces=None, **kw): | |
1375 | """Generic interface to the inspector system. |
|
1376 | """Generic interface to the inspector system. | |
1376 |
|
1377 | |||
1377 | This function is meant to be called by pdef, pdoc & friends.""" |
|
1378 | This function is meant to be called by pdef, pdoc & friends.""" | |
1378 | info = self._object_find(oname) |
|
1379 | info = self._object_find(oname) | |
1379 | if info.found: |
|
1380 | if info.found: | |
1380 | pmethod = getattr(self.inspector, meth) |
|
1381 | pmethod = getattr(self.inspector, meth) | |
1381 | formatter = format_screen if info.ismagic else None |
|
1382 | formatter = format_screen if info.ismagic else None | |
1382 | if meth == 'pdoc': |
|
1383 | if meth == 'pdoc': | |
1383 | pmethod(info.obj, oname, formatter) |
|
1384 | pmethod(info.obj, oname, formatter) | |
1384 | elif meth == 'pinfo': |
|
1385 | elif meth == 'pinfo': | |
1385 | pmethod(info.obj, oname, formatter, info, **kw) |
|
1386 | pmethod(info.obj, oname, formatter, info, **kw) | |
1386 | else: |
|
1387 | else: | |
1387 | pmethod(info.obj, oname) |
|
1388 | pmethod(info.obj, oname) | |
1388 | else: |
|
1389 | else: | |
1389 | print 'Object `%s` not found.' % oname |
|
1390 | print 'Object `%s` not found.' % oname | |
1390 | return 'not found' # so callers can take other action |
|
1391 | return 'not found' # so callers can take other action | |
1391 |
|
1392 | |||
1392 | def object_inspect(self, oname): |
|
1393 | def object_inspect(self, oname): | |
1393 | with self.builtin_trap: |
|
1394 | with self.builtin_trap: | |
1394 | info = self._object_find(oname) |
|
1395 | info = self._object_find(oname) | |
1395 | if info.found: |
|
1396 | if info.found: | |
1396 | return self.inspector.info(info.obj, oname, info=info) |
|
1397 | return self.inspector.info(info.obj, oname, info=info) | |
1397 | else: |
|
1398 | else: | |
1398 | return oinspect.object_info(name=oname, found=False) |
|
1399 | return oinspect.object_info(name=oname, found=False) | |
1399 |
|
1400 | |||
1400 | #------------------------------------------------------------------------- |
|
1401 | #------------------------------------------------------------------------- | |
1401 | # Things related to history management |
|
1402 | # Things related to history management | |
1402 | #------------------------------------------------------------------------- |
|
1403 | #------------------------------------------------------------------------- | |
1403 |
|
1404 | |||
1404 | def init_history(self): |
|
1405 | def init_history(self): | |
1405 | """Sets up the command history, and starts regular autosaves.""" |
|
1406 | """Sets up the command history, and starts regular autosaves.""" | |
1406 | self.history_manager = HistoryManager(shell=self, config=self.config) |
|
1407 | self.history_manager = HistoryManager(shell=self, config=self.config) | |
1407 | self.configurables.append(self.history_manager) |
|
1408 | self.configurables.append(self.history_manager) | |
1408 |
|
1409 | |||
1409 | #------------------------------------------------------------------------- |
|
1410 | #------------------------------------------------------------------------- | |
1410 | # Things related to exception handling and tracebacks (not debugging) |
|
1411 | # Things related to exception handling and tracebacks (not debugging) | |
1411 | #------------------------------------------------------------------------- |
|
1412 | #------------------------------------------------------------------------- | |
1412 |
|
1413 | |||
1413 | def init_traceback_handlers(self, custom_exceptions): |
|
1414 | def init_traceback_handlers(self, custom_exceptions): | |
1414 | # Syntax error handler. |
|
1415 | # Syntax error handler. | |
1415 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') |
|
1416 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') | |
1416 |
|
1417 | |||
1417 | # The interactive one is initialized with an offset, meaning we always |
|
1418 | # The interactive one is initialized with an offset, meaning we always | |
1418 | # want to remove the topmost item in the traceback, which is our own |
|
1419 | # want to remove the topmost item in the traceback, which is our own | |
1419 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1420 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
1420 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1421 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', | |
1421 | color_scheme='NoColor', |
|
1422 | color_scheme='NoColor', | |
1422 | tb_offset = 1, |
|
1423 | tb_offset = 1, | |
1423 | check_cache=self.compile.check_cache) |
|
1424 | check_cache=self.compile.check_cache) | |
1424 |
|
1425 | |||
1425 | # The instance will store a pointer to the system-wide exception hook, |
|
1426 | # The instance will store a pointer to the system-wide exception hook, | |
1426 | # so that runtime code (such as magics) can access it. This is because |
|
1427 | # so that runtime code (such as magics) can access it. This is because | |
1427 | # during the read-eval loop, it may get temporarily overwritten. |
|
1428 | # during the read-eval loop, it may get temporarily overwritten. | |
1428 | self.sys_excepthook = sys.excepthook |
|
1429 | self.sys_excepthook = sys.excepthook | |
1429 |
|
1430 | |||
1430 | # and add any custom exception handlers the user may have specified |
|
1431 | # and add any custom exception handlers the user may have specified | |
1431 | self.set_custom_exc(*custom_exceptions) |
|
1432 | self.set_custom_exc(*custom_exceptions) | |
1432 |
|
1433 | |||
1433 | # Set the exception mode |
|
1434 | # Set the exception mode | |
1434 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1435 | self.InteractiveTB.set_mode(mode=self.xmode) | |
1435 |
|
1436 | |||
1436 | def set_custom_exc(self, exc_tuple, handler): |
|
1437 | def set_custom_exc(self, exc_tuple, handler): | |
1437 | """set_custom_exc(exc_tuple,handler) |
|
1438 | """set_custom_exc(exc_tuple,handler) | |
1438 |
|
1439 | |||
1439 | Set a custom exception handler, which will be called if any of the |
|
1440 | Set a custom exception handler, which will be called if any of the | |
1440 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1441 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1441 | run_code() method). |
|
1442 | run_code() method). | |
1442 |
|
1443 | |||
1443 | Parameters |
|
1444 | Parameters | |
1444 | ---------- |
|
1445 | ---------- | |
1445 |
|
1446 | |||
1446 | exc_tuple : tuple of exception classes |
|
1447 | exc_tuple : tuple of exception classes | |
1447 | A *tuple* of exception classes, for which to call the defined |
|
1448 | A *tuple* of exception classes, for which to call the defined | |
1448 | handler. It is very important that you use a tuple, and NOT A |
|
1449 | handler. It is very important that you use a tuple, and NOT A | |
1449 | LIST here, because of the way Python's except statement works. If |
|
1450 | LIST here, because of the way Python's except statement works. If | |
1450 | you only want to trap a single exception, use a singleton tuple:: |
|
1451 | you only want to trap a single exception, use a singleton tuple:: | |
1451 |
|
1452 | |||
1452 | exc_tuple == (MyCustomException,) |
|
1453 | exc_tuple == (MyCustomException,) | |
1453 |
|
1454 | |||
1454 | handler : callable |
|
1455 | handler : callable | |
1455 | handler must have the following signature:: |
|
1456 | handler must have the following signature:: | |
1456 |
|
1457 | |||
1457 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1458 | def my_handler(self, etype, value, tb, tb_offset=None): | |
1458 | ... |
|
1459 | ... | |
1459 | return structured_traceback |
|
1460 | return structured_traceback | |
1460 |
|
1461 | |||
1461 | Your handler must return a structured traceback (a list of strings), |
|
1462 | Your handler must return a structured traceback (a list of strings), | |
1462 | or None. |
|
1463 | or None. | |
1463 |
|
1464 | |||
1464 | This will be made into an instance method (via types.MethodType) |
|
1465 | This will be made into an instance method (via types.MethodType) | |
1465 | of IPython itself, and it will be called if any of the exceptions |
|
1466 | of IPython itself, and it will be called if any of the exceptions | |
1466 | listed in the exc_tuple are caught. If the handler is None, an |
|
1467 | listed in the exc_tuple are caught. If the handler is None, an | |
1467 | internal basic one is used, which just prints basic info. |
|
1468 | internal basic one is used, which just prints basic info. | |
1468 |
|
1469 | |||
1469 | To protect IPython from crashes, if your handler ever raises an |
|
1470 | To protect IPython from crashes, if your handler ever raises an | |
1470 | exception or returns an invalid result, it will be immediately |
|
1471 | exception or returns an invalid result, it will be immediately | |
1471 | disabled. |
|
1472 | disabled. | |
1472 |
|
1473 | |||
1473 | WARNING: by putting in your own exception handler into IPython's main |
|
1474 | WARNING: by putting in your own exception handler into IPython's main | |
1474 | execution loop, you run a very good chance of nasty crashes. This |
|
1475 | execution loop, you run a very good chance of nasty crashes. This | |
1475 | facility should only be used if you really know what you are doing.""" |
|
1476 | facility should only be used if you really know what you are doing.""" | |
1476 |
|
1477 | |||
1477 | assert type(exc_tuple)==type(()) , \ |
|
1478 | assert type(exc_tuple)==type(()) , \ | |
1478 | "The custom exceptions must be given AS A TUPLE." |
|
1479 | "The custom exceptions must be given AS A TUPLE." | |
1479 |
|
1480 | |||
1480 | def dummy_handler(self,etype,value,tb,tb_offset=None): |
|
1481 | def dummy_handler(self,etype,value,tb,tb_offset=None): | |
1481 | print '*** Simple custom exception handler ***' |
|
1482 | print '*** Simple custom exception handler ***' | |
1482 | print 'Exception type :',etype |
|
1483 | print 'Exception type :',etype | |
1483 | print 'Exception value:',value |
|
1484 | print 'Exception value:',value | |
1484 | print 'Traceback :',tb |
|
1485 | print 'Traceback :',tb | |
1485 | #print 'Source code :','\n'.join(self.buffer) |
|
1486 | #print 'Source code :','\n'.join(self.buffer) | |
1486 |
|
1487 | |||
1487 | def validate_stb(stb): |
|
1488 | def validate_stb(stb): | |
1488 | """validate structured traceback return type |
|
1489 | """validate structured traceback return type | |
1489 |
|
1490 | |||
1490 | return type of CustomTB *should* be a list of strings, but allow |
|
1491 | return type of CustomTB *should* be a list of strings, but allow | |
1491 | single strings or None, which are harmless. |
|
1492 | single strings or None, which are harmless. | |
1492 |
|
1493 | |||
1493 | This function will *always* return a list of strings, |
|
1494 | This function will *always* return a list of strings, | |
1494 | and will raise a TypeError if stb is inappropriate. |
|
1495 | and will raise a TypeError if stb is inappropriate. | |
1495 | """ |
|
1496 | """ | |
1496 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1497 | msg = "CustomTB must return list of strings, not %r" % stb | |
1497 | if stb is None: |
|
1498 | if stb is None: | |
1498 | return [] |
|
1499 | return [] | |
1499 | elif isinstance(stb, basestring): |
|
1500 | elif isinstance(stb, basestring): | |
1500 | return [stb] |
|
1501 | return [stb] | |
1501 | elif not isinstance(stb, list): |
|
1502 | elif not isinstance(stb, list): | |
1502 | raise TypeError(msg) |
|
1503 | raise TypeError(msg) | |
1503 | # it's a list |
|
1504 | # it's a list | |
1504 | for line in stb: |
|
1505 | for line in stb: | |
1505 | # check every element |
|
1506 | # check every element | |
1506 | if not isinstance(line, basestring): |
|
1507 | if not isinstance(line, basestring): | |
1507 | raise TypeError(msg) |
|
1508 | raise TypeError(msg) | |
1508 | return stb |
|
1509 | return stb | |
1509 |
|
1510 | |||
1510 | if handler is None: |
|
1511 | if handler is None: | |
1511 | wrapped = dummy_handler |
|
1512 | wrapped = dummy_handler | |
1512 | else: |
|
1513 | else: | |
1513 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1514 | def wrapped(self,etype,value,tb,tb_offset=None): | |
1514 | """wrap CustomTB handler, to protect IPython from user code |
|
1515 | """wrap CustomTB handler, to protect IPython from user code | |
1515 |
|
1516 | |||
1516 | This makes it harder (but not impossible) for custom exception |
|
1517 | This makes it harder (but not impossible) for custom exception | |
1517 | handlers to crash IPython. |
|
1518 | handlers to crash IPython. | |
1518 | """ |
|
1519 | """ | |
1519 | try: |
|
1520 | try: | |
1520 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1521 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) | |
1521 | return validate_stb(stb) |
|
1522 | return validate_stb(stb) | |
1522 | except: |
|
1523 | except: | |
1523 | # clear custom handler immediately |
|
1524 | # clear custom handler immediately | |
1524 | self.set_custom_exc((), None) |
|
1525 | self.set_custom_exc((), None) | |
1525 | print >> io.stderr, "Custom TB Handler failed, unregistering" |
|
1526 | print >> io.stderr, "Custom TB Handler failed, unregistering" | |
1526 | # show the exception in handler first |
|
1527 | # show the exception in handler first | |
1527 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1528 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) | |
1528 | print >> io.stdout, self.InteractiveTB.stb2text(stb) |
|
1529 | print >> io.stdout, self.InteractiveTB.stb2text(stb) | |
1529 | print >> io.stdout, "The original exception:" |
|
1530 | print >> io.stdout, "The original exception:" | |
1530 | stb = self.InteractiveTB.structured_traceback( |
|
1531 | stb = self.InteractiveTB.structured_traceback( | |
1531 | (etype,value,tb), tb_offset=tb_offset |
|
1532 | (etype,value,tb), tb_offset=tb_offset | |
1532 | ) |
|
1533 | ) | |
1533 | return stb |
|
1534 | return stb | |
1534 |
|
1535 | |||
1535 | self.CustomTB = types.MethodType(wrapped,self) |
|
1536 | self.CustomTB = types.MethodType(wrapped,self) | |
1536 | self.custom_exceptions = exc_tuple |
|
1537 | self.custom_exceptions = exc_tuple | |
1537 |
|
1538 | |||
1538 | def excepthook(self, etype, value, tb): |
|
1539 | def excepthook(self, etype, value, tb): | |
1539 | """One more defense for GUI apps that call sys.excepthook. |
|
1540 | """One more defense for GUI apps that call sys.excepthook. | |
1540 |
|
1541 | |||
1541 | GUI frameworks like wxPython trap exceptions and call |
|
1542 | GUI frameworks like wxPython trap exceptions and call | |
1542 | sys.excepthook themselves. I guess this is a feature that |
|
1543 | sys.excepthook themselves. I guess this is a feature that | |
1543 | enables them to keep running after exceptions that would |
|
1544 | enables them to keep running after exceptions that would | |
1544 | otherwise kill their mainloop. This is a bother for IPython |
|
1545 | otherwise kill their mainloop. This is a bother for IPython | |
1545 | which excepts to catch all of the program exceptions with a try: |
|
1546 | which excepts to catch all of the program exceptions with a try: | |
1546 | except: statement. |
|
1547 | except: statement. | |
1547 |
|
1548 | |||
1548 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1549 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
1549 | any app directly invokes sys.excepthook, it will look to the user like |
|
1550 | any app directly invokes sys.excepthook, it will look to the user like | |
1550 | IPython crashed. In order to work around this, we can disable the |
|
1551 | IPython crashed. In order to work around this, we can disable the | |
1551 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1552 | CrashHandler and replace it with this excepthook instead, which prints a | |
1552 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1553 | regular traceback using our InteractiveTB. In this fashion, apps which | |
1553 | call sys.excepthook will generate a regular-looking exception from |
|
1554 | call sys.excepthook will generate a regular-looking exception from | |
1554 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1555 | IPython, and the CrashHandler will only be triggered by real IPython | |
1555 | crashes. |
|
1556 | crashes. | |
1556 |
|
1557 | |||
1557 | This hook should be used sparingly, only in places which are not likely |
|
1558 | This hook should be used sparingly, only in places which are not likely | |
1558 | to be true IPython errors. |
|
1559 | to be true IPython errors. | |
1559 | """ |
|
1560 | """ | |
1560 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1561 | self.showtraceback((etype,value,tb),tb_offset=0) | |
1561 |
|
1562 | |||
1562 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, |
|
1563 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, | |
1563 | exception_only=False): |
|
1564 | exception_only=False): | |
1564 | """Display the exception that just occurred. |
|
1565 | """Display the exception that just occurred. | |
1565 |
|
1566 | |||
1566 | If nothing is known about the exception, this is the method which |
|
1567 | If nothing is known about the exception, this is the method which | |
1567 | should be used throughout the code for presenting user tracebacks, |
|
1568 | should be used throughout the code for presenting user tracebacks, | |
1568 | rather than directly invoking the InteractiveTB object. |
|
1569 | rather than directly invoking the InteractiveTB object. | |
1569 |
|
1570 | |||
1570 | A specific showsyntaxerror() also exists, but this method can take |
|
1571 | A specific showsyntaxerror() also exists, but this method can take | |
1571 | care of calling it if needed, so unless you are explicitly catching a |
|
1572 | care of calling it if needed, so unless you are explicitly catching a | |
1572 | SyntaxError exception, don't try to analyze the stack manually and |
|
1573 | SyntaxError exception, don't try to analyze the stack manually and | |
1573 | simply call this method.""" |
|
1574 | simply call this method.""" | |
1574 |
|
1575 | |||
1575 | try: |
|
1576 | try: | |
1576 | if exc_tuple is None: |
|
1577 | if exc_tuple is None: | |
1577 | etype, value, tb = sys.exc_info() |
|
1578 | etype, value, tb = sys.exc_info() | |
1578 | else: |
|
1579 | else: | |
1579 | etype, value, tb = exc_tuple |
|
1580 | etype, value, tb = exc_tuple | |
1580 |
|
1581 | |||
1581 | if etype is None: |
|
1582 | if etype is None: | |
1582 | if hasattr(sys, 'last_type'): |
|
1583 | if hasattr(sys, 'last_type'): | |
1583 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1584 | etype, value, tb = sys.last_type, sys.last_value, \ | |
1584 | sys.last_traceback |
|
1585 | sys.last_traceback | |
1585 | else: |
|
1586 | else: | |
1586 | self.write_err('No traceback available to show.\n') |
|
1587 | self.write_err('No traceback available to show.\n') | |
1587 | return |
|
1588 | return | |
1588 |
|
1589 | |||
1589 | if etype is SyntaxError: |
|
1590 | if etype is SyntaxError: | |
1590 | # Though this won't be called by syntax errors in the input |
|
1591 | # Though this won't be called by syntax errors in the input | |
1591 | # line, there may be SyntaxError cases with imported code. |
|
1592 | # line, there may be SyntaxError cases with imported code. | |
1592 | self.showsyntaxerror(filename) |
|
1593 | self.showsyntaxerror(filename) | |
1593 | elif etype is UsageError: |
|
1594 | elif etype is UsageError: | |
1594 | self.write_err("UsageError: %s" % value) |
|
1595 | self.write_err("UsageError: %s" % value) | |
1595 | else: |
|
1596 | else: | |
1596 | # WARNING: these variables are somewhat deprecated and not |
|
1597 | # WARNING: these variables are somewhat deprecated and not | |
1597 | # necessarily safe to use in a threaded environment, but tools |
|
1598 | # necessarily safe to use in a threaded environment, but tools | |
1598 | # like pdb depend on their existence, so let's set them. If we |
|
1599 | # like pdb depend on their existence, so let's set them. If we | |
1599 | # find problems in the field, we'll need to revisit their use. |
|
1600 | # find problems in the field, we'll need to revisit their use. | |
1600 | sys.last_type = etype |
|
1601 | sys.last_type = etype | |
1601 | sys.last_value = value |
|
1602 | sys.last_value = value | |
1602 | sys.last_traceback = tb |
|
1603 | sys.last_traceback = tb | |
1603 | if etype in self.custom_exceptions: |
|
1604 | if etype in self.custom_exceptions: | |
1604 | stb = self.CustomTB(etype, value, tb, tb_offset) |
|
1605 | stb = self.CustomTB(etype, value, tb, tb_offset) | |
1605 | else: |
|
1606 | else: | |
1606 | if exception_only: |
|
1607 | if exception_only: | |
1607 | stb = ['An exception has occurred, use %tb to see ' |
|
1608 | stb = ['An exception has occurred, use %tb to see ' | |
1608 | 'the full traceback.\n'] |
|
1609 | 'the full traceback.\n'] | |
1609 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
1610 | stb.extend(self.InteractiveTB.get_exception_only(etype, | |
1610 | value)) |
|
1611 | value)) | |
1611 | else: |
|
1612 | else: | |
1612 | stb = self.InteractiveTB.structured_traceback(etype, |
|
1613 | stb = self.InteractiveTB.structured_traceback(etype, | |
1613 | value, tb, tb_offset=tb_offset) |
|
1614 | value, tb, tb_offset=tb_offset) | |
1614 |
|
1615 | |||
1615 | self._showtraceback(etype, value, stb) |
|
1616 | self._showtraceback(etype, value, stb) | |
1616 | if self.call_pdb: |
|
1617 | if self.call_pdb: | |
1617 | # drop into debugger |
|
1618 | # drop into debugger | |
1618 | self.debugger(force=True) |
|
1619 | self.debugger(force=True) | |
1619 | return |
|
1620 | return | |
1620 |
|
1621 | |||
1621 | # Actually show the traceback |
|
1622 | # Actually show the traceback | |
1622 | self._showtraceback(etype, value, stb) |
|
1623 | self._showtraceback(etype, value, stb) | |
1623 |
|
1624 | |||
1624 | except KeyboardInterrupt: |
|
1625 | except KeyboardInterrupt: | |
1625 | self.write_err("\nKeyboardInterrupt\n") |
|
1626 | self.write_err("\nKeyboardInterrupt\n") | |
1626 |
|
1627 | |||
1627 | def _showtraceback(self, etype, evalue, stb): |
|
1628 | def _showtraceback(self, etype, evalue, stb): | |
1628 | """Actually show a traceback. |
|
1629 | """Actually show a traceback. | |
1629 |
|
1630 | |||
1630 | Subclasses may override this method to put the traceback on a different |
|
1631 | Subclasses may override this method to put the traceback on a different | |
1631 | place, like a side channel. |
|
1632 | place, like a side channel. | |
1632 | """ |
|
1633 | """ | |
1633 | print >> io.stdout, self.InteractiveTB.stb2text(stb) |
|
1634 | print >> io.stdout, self.InteractiveTB.stb2text(stb) | |
1634 |
|
1635 | |||
1635 | def showsyntaxerror(self, filename=None): |
|
1636 | def showsyntaxerror(self, filename=None): | |
1636 | """Display the syntax error that just occurred. |
|
1637 | """Display the syntax error that just occurred. | |
1637 |
|
1638 | |||
1638 | This doesn't display a stack trace because there isn't one. |
|
1639 | This doesn't display a stack trace because there isn't one. | |
1639 |
|
1640 | |||
1640 | If a filename is given, it is stuffed in the exception instead |
|
1641 | If a filename is given, it is stuffed in the exception instead | |
1641 | of what was there before (because Python's parser always uses |
|
1642 | of what was there before (because Python's parser always uses | |
1642 | "<string>" when reading from a string). |
|
1643 | "<string>" when reading from a string). | |
1643 | """ |
|
1644 | """ | |
1644 | etype, value, last_traceback = sys.exc_info() |
|
1645 | etype, value, last_traceback = sys.exc_info() | |
1645 |
|
1646 | |||
1646 | # See note about these variables in showtraceback() above |
|
1647 | # See note about these variables in showtraceback() above | |
1647 | sys.last_type = etype |
|
1648 | sys.last_type = etype | |
1648 | sys.last_value = value |
|
1649 | sys.last_value = value | |
1649 | sys.last_traceback = last_traceback |
|
1650 | sys.last_traceback = last_traceback | |
1650 |
|
1651 | |||
1651 | if filename and etype is SyntaxError: |
|
1652 | if filename and etype is SyntaxError: | |
1652 | # Work hard to stuff the correct filename in the exception |
|
1653 | # Work hard to stuff the correct filename in the exception | |
1653 | try: |
|
1654 | try: | |
1654 | msg, (dummy_filename, lineno, offset, line) = value |
|
1655 | msg, (dummy_filename, lineno, offset, line) = value | |
1655 | except: |
|
1656 | except: | |
1656 | # Not the format we expect; leave it alone |
|
1657 | # Not the format we expect; leave it alone | |
1657 | pass |
|
1658 | pass | |
1658 | else: |
|
1659 | else: | |
1659 | # Stuff in the right filename |
|
1660 | # Stuff in the right filename | |
1660 | try: |
|
1661 | try: | |
1661 | # Assume SyntaxError is a class exception |
|
1662 | # Assume SyntaxError is a class exception | |
1662 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1663 | value = SyntaxError(msg, (filename, lineno, offset, line)) | |
1663 | except: |
|
1664 | except: | |
1664 | # If that failed, assume SyntaxError is a string |
|
1665 | # If that failed, assume SyntaxError is a string | |
1665 | value = msg, (filename, lineno, offset, line) |
|
1666 | value = msg, (filename, lineno, offset, line) | |
1666 | stb = self.SyntaxTB.structured_traceback(etype, value, []) |
|
1667 | stb = self.SyntaxTB.structured_traceback(etype, value, []) | |
1667 | self._showtraceback(etype, value, stb) |
|
1668 | self._showtraceback(etype, value, stb) | |
1668 |
|
1669 | |||
1669 | # This is overridden in TerminalInteractiveShell to show a message about |
|
1670 | # This is overridden in TerminalInteractiveShell to show a message about | |
1670 | # the %paste magic. |
|
1671 | # the %paste magic. | |
1671 | def showindentationerror(self): |
|
1672 | def showindentationerror(self): | |
1672 | """Called by run_cell when there's an IndentationError in code entered |
|
1673 | """Called by run_cell when there's an IndentationError in code entered | |
1673 | at the prompt. |
|
1674 | at the prompt. | |
1674 |
|
1675 | |||
1675 | This is overridden in TerminalInteractiveShell to show a message about |
|
1676 | This is overridden in TerminalInteractiveShell to show a message about | |
1676 | the %paste magic.""" |
|
1677 | the %paste magic.""" | |
1677 | self.showsyntaxerror() |
|
1678 | self.showsyntaxerror() | |
1678 |
|
1679 | |||
1679 | #------------------------------------------------------------------------- |
|
1680 | #------------------------------------------------------------------------- | |
1680 | # Things related to readline |
|
1681 | # Things related to readline | |
1681 | #------------------------------------------------------------------------- |
|
1682 | #------------------------------------------------------------------------- | |
1682 |
|
1683 | |||
1683 | def init_readline(self): |
|
1684 | def init_readline(self): | |
1684 | """Command history completion/saving/reloading.""" |
|
1685 | """Command history completion/saving/reloading.""" | |
1685 |
|
1686 | |||
1686 | if self.readline_use: |
|
1687 | if self.readline_use: | |
1687 | import IPython.utils.rlineimpl as readline |
|
1688 | import IPython.utils.rlineimpl as readline | |
1688 |
|
1689 | |||
1689 | self.rl_next_input = None |
|
1690 | self.rl_next_input = None | |
1690 | self.rl_do_indent = False |
|
1691 | self.rl_do_indent = False | |
1691 |
|
1692 | |||
1692 | if not self.readline_use or not readline.have_readline: |
|
1693 | if not self.readline_use or not readline.have_readline: | |
1693 | self.has_readline = False |
|
1694 | self.has_readline = False | |
1694 | self.readline = None |
|
1695 | self.readline = None | |
1695 | # Set a number of methods that depend on readline to be no-op |
|
1696 | # Set a number of methods that depend on readline to be no-op | |
1696 | self.readline_no_record = no_op_context |
|
1697 | self.readline_no_record = no_op_context | |
1697 | self.set_readline_completer = no_op |
|
1698 | self.set_readline_completer = no_op | |
1698 | self.set_custom_completer = no_op |
|
1699 | self.set_custom_completer = no_op | |
1699 | self.set_completer_frame = no_op |
|
1700 | self.set_completer_frame = no_op | |
1700 | if self.readline_use: |
|
1701 | if self.readline_use: | |
1701 | warn('Readline services not available or not loaded.') |
|
1702 | warn('Readline services not available or not loaded.') | |
1702 | else: |
|
1703 | else: | |
1703 | self.has_readline = True |
|
1704 | self.has_readline = True | |
1704 | self.readline = readline |
|
1705 | self.readline = readline | |
1705 | sys.modules['readline'] = readline |
|
1706 | sys.modules['readline'] = readline | |
1706 |
|
1707 | |||
1707 | # Platform-specific configuration |
|
1708 | # Platform-specific configuration | |
1708 | if os.name == 'nt': |
|
1709 | if os.name == 'nt': | |
1709 | # FIXME - check with Frederick to see if we can harmonize |
|
1710 | # FIXME - check with Frederick to see if we can harmonize | |
1710 | # naming conventions with pyreadline to avoid this |
|
1711 | # naming conventions with pyreadline to avoid this | |
1711 | # platform-dependent check |
|
1712 | # platform-dependent check | |
1712 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1713 | self.readline_startup_hook = readline.set_pre_input_hook | |
1713 | else: |
|
1714 | else: | |
1714 | self.readline_startup_hook = readline.set_startup_hook |
|
1715 | self.readline_startup_hook = readline.set_startup_hook | |
1715 |
|
1716 | |||
1716 | # Load user's initrc file (readline config) |
|
1717 | # Load user's initrc file (readline config) | |
1717 | # Or if libedit is used, load editrc. |
|
1718 | # Or if libedit is used, load editrc. | |
1718 | inputrc_name = os.environ.get('INPUTRC') |
|
1719 | inputrc_name = os.environ.get('INPUTRC') | |
1719 | if inputrc_name is None: |
|
1720 | if inputrc_name is None: | |
1720 | inputrc_name = '.inputrc' |
|
1721 | inputrc_name = '.inputrc' | |
1721 | if readline.uses_libedit: |
|
1722 | if readline.uses_libedit: | |
1722 | inputrc_name = '.editrc' |
|
1723 | inputrc_name = '.editrc' | |
1723 | inputrc_name = os.path.join(self.home_dir, inputrc_name) |
|
1724 | inputrc_name = os.path.join(self.home_dir, inputrc_name) | |
1724 | if os.path.isfile(inputrc_name): |
|
1725 | if os.path.isfile(inputrc_name): | |
1725 | try: |
|
1726 | try: | |
1726 | readline.read_init_file(inputrc_name) |
|
1727 | readline.read_init_file(inputrc_name) | |
1727 | except: |
|
1728 | except: | |
1728 | warn('Problems reading readline initialization file <%s>' |
|
1729 | warn('Problems reading readline initialization file <%s>' | |
1729 | % inputrc_name) |
|
1730 | % inputrc_name) | |
1730 |
|
1731 | |||
1731 | # Configure readline according to user's prefs |
|
1732 | # Configure readline according to user's prefs | |
1732 | # This is only done if GNU readline is being used. If libedit |
|
1733 | # This is only done if GNU readline is being used. If libedit | |
1733 | # is being used (as on Leopard) the readline config is |
|
1734 | # is being used (as on Leopard) the readline config is | |
1734 | # not run as the syntax for libedit is different. |
|
1735 | # not run as the syntax for libedit is different. | |
1735 | if not readline.uses_libedit: |
|
1736 | if not readline.uses_libedit: | |
1736 | for rlcommand in self.readline_parse_and_bind: |
|
1737 | for rlcommand in self.readline_parse_and_bind: | |
1737 | #print "loading rl:",rlcommand # dbg |
|
1738 | #print "loading rl:",rlcommand # dbg | |
1738 | readline.parse_and_bind(rlcommand) |
|
1739 | readline.parse_and_bind(rlcommand) | |
1739 |
|
1740 | |||
1740 | # Remove some chars from the delimiters list. If we encounter |
|
1741 | # Remove some chars from the delimiters list. If we encounter | |
1741 | # unicode chars, discard them. |
|
1742 | # unicode chars, discard them. | |
1742 | delims = readline.get_completer_delims() |
|
1743 | delims = readline.get_completer_delims() | |
1743 | if not py3compat.PY3: |
|
1744 | if not py3compat.PY3: | |
1744 | delims = delims.encode("ascii", "ignore") |
|
1745 | delims = delims.encode("ascii", "ignore") | |
1745 | for d in self.readline_remove_delims: |
|
1746 | for d in self.readline_remove_delims: | |
1746 | delims = delims.replace(d, "") |
|
1747 | delims = delims.replace(d, "") | |
1747 | delims = delims.replace(ESC_MAGIC, '') |
|
1748 | delims = delims.replace(ESC_MAGIC, '') | |
1748 | readline.set_completer_delims(delims) |
|
1749 | readline.set_completer_delims(delims) | |
1749 | # otherwise we end up with a monster history after a while: |
|
1750 | # otherwise we end up with a monster history after a while: | |
1750 | readline.set_history_length(self.history_length) |
|
1751 | readline.set_history_length(self.history_length) | |
1751 |
|
1752 | |||
1752 | self.refill_readline_hist() |
|
1753 | self.refill_readline_hist() | |
1753 | self.readline_no_record = ReadlineNoRecord(self) |
|
1754 | self.readline_no_record = ReadlineNoRecord(self) | |
1754 |
|
1755 | |||
1755 | # Configure auto-indent for all platforms |
|
1756 | # Configure auto-indent for all platforms | |
1756 | self.set_autoindent(self.autoindent) |
|
1757 | self.set_autoindent(self.autoindent) | |
1757 |
|
1758 | |||
1758 | def refill_readline_hist(self): |
|
1759 | def refill_readline_hist(self): | |
1759 | # Load the last 1000 lines from history |
|
1760 | # Load the last 1000 lines from history | |
1760 | self.readline.clear_history() |
|
1761 | self.readline.clear_history() | |
1761 | stdin_encoding = sys.stdin.encoding or "utf-8" |
|
1762 | stdin_encoding = sys.stdin.encoding or "utf-8" | |
1762 | last_cell = u"" |
|
1763 | last_cell = u"" | |
1763 | for _, _, cell in self.history_manager.get_tail(1000, |
|
1764 | for _, _, cell in self.history_manager.get_tail(1000, | |
1764 | include_latest=True): |
|
1765 | include_latest=True): | |
1765 | # Ignore blank lines and consecutive duplicates |
|
1766 | # Ignore blank lines and consecutive duplicates | |
1766 | cell = cell.rstrip() |
|
1767 | cell = cell.rstrip() | |
1767 | if cell and (cell != last_cell): |
|
1768 | if cell and (cell != last_cell): | |
1768 | if self.multiline_history: |
|
1769 | if self.multiline_history: | |
1769 | self.readline.add_history(py3compat.unicode_to_str(cell, |
|
1770 | self.readline.add_history(py3compat.unicode_to_str(cell, | |
1770 | stdin_encoding)) |
|
1771 | stdin_encoding)) | |
1771 | else: |
|
1772 | else: | |
1772 | for line in cell.splitlines(): |
|
1773 | for line in cell.splitlines(): | |
1773 | self.readline.add_history(py3compat.unicode_to_str(line, |
|
1774 | self.readline.add_history(py3compat.unicode_to_str(line, | |
1774 | stdin_encoding)) |
|
1775 | stdin_encoding)) | |
1775 | last_cell = cell |
|
1776 | last_cell = cell | |
1776 |
|
1777 | |||
1777 | def set_next_input(self, s): |
|
1778 | def set_next_input(self, s): | |
1778 | """ Sets the 'default' input string for the next command line. |
|
1779 | """ Sets the 'default' input string for the next command line. | |
1779 |
|
1780 | |||
1780 | Requires readline. |
|
1781 | Requires readline. | |
1781 |
|
1782 | |||
1782 | Example: |
|
1783 | Example: | |
1783 |
|
1784 | |||
1784 | [D:\ipython]|1> _ip.set_next_input("Hello Word") |
|
1785 | [D:\ipython]|1> _ip.set_next_input("Hello Word") | |
1785 | [D:\ipython]|2> Hello Word_ # cursor is here |
|
1786 | [D:\ipython]|2> Hello Word_ # cursor is here | |
1786 | """ |
|
1787 | """ | |
1787 | self.rl_next_input = py3compat.cast_bytes_py2(s) |
|
1788 | self.rl_next_input = py3compat.cast_bytes_py2(s) | |
1788 |
|
1789 | |||
1789 | # Maybe move this to the terminal subclass? |
|
1790 | # Maybe move this to the terminal subclass? | |
1790 | def pre_readline(self): |
|
1791 | def pre_readline(self): | |
1791 | """readline hook to be used at the start of each line. |
|
1792 | """readline hook to be used at the start of each line. | |
1792 |
|
1793 | |||
1793 | Currently it handles auto-indent only.""" |
|
1794 | Currently it handles auto-indent only.""" | |
1794 |
|
1795 | |||
1795 | if self.rl_do_indent: |
|
1796 | if self.rl_do_indent: | |
1796 | self.readline.insert_text(self._indent_current_str()) |
|
1797 | self.readline.insert_text(self._indent_current_str()) | |
1797 | if self.rl_next_input is not None: |
|
1798 | if self.rl_next_input is not None: | |
1798 | self.readline.insert_text(self.rl_next_input) |
|
1799 | self.readline.insert_text(self.rl_next_input) | |
1799 | self.rl_next_input = None |
|
1800 | self.rl_next_input = None | |
1800 |
|
1801 | |||
1801 | def _indent_current_str(self): |
|
1802 | def _indent_current_str(self): | |
1802 | """return the current level of indentation as a string""" |
|
1803 | """return the current level of indentation as a string""" | |
1803 | return self.input_splitter.indent_spaces * ' ' |
|
1804 | return self.input_splitter.indent_spaces * ' ' | |
1804 |
|
1805 | |||
1805 | #------------------------------------------------------------------------- |
|
1806 | #------------------------------------------------------------------------- | |
1806 | # Things related to text completion |
|
1807 | # Things related to text completion | |
1807 | #------------------------------------------------------------------------- |
|
1808 | #------------------------------------------------------------------------- | |
1808 |
|
1809 | |||
1809 | def init_completer(self): |
|
1810 | def init_completer(self): | |
1810 | """Initialize the completion machinery. |
|
1811 | """Initialize the completion machinery. | |
1811 |
|
1812 | |||
1812 | This creates completion machinery that can be used by client code, |
|
1813 | This creates completion machinery that can be used by client code, | |
1813 | either interactively in-process (typically triggered by the readline |
|
1814 | either interactively in-process (typically triggered by the readline | |
1814 | library), programatically (such as in test suites) or out-of-prcess |
|
1815 | library), programatically (such as in test suites) or out-of-prcess | |
1815 | (typically over the network by remote frontends). |
|
1816 | (typically over the network by remote frontends). | |
1816 | """ |
|
1817 | """ | |
1817 | from IPython.core.completer import IPCompleter |
|
1818 | from IPython.core.completer import IPCompleter | |
1818 | from IPython.core.completerlib import (module_completer, |
|
1819 | from IPython.core.completerlib import (module_completer, | |
1819 | magic_run_completer, cd_completer) |
|
1820 | magic_run_completer, cd_completer) | |
1820 |
|
1821 | |||
1821 | self.Completer = IPCompleter(shell=self, |
|
1822 | self.Completer = IPCompleter(shell=self, | |
1822 | namespace=self.user_ns, |
|
1823 | namespace=self.user_ns, | |
1823 | global_namespace=self.user_global_ns, |
|
1824 | global_namespace=self.user_global_ns, | |
1824 | alias_table=self.alias_manager.alias_table, |
|
1825 | alias_table=self.alias_manager.alias_table, | |
1825 | use_readline=self.has_readline, |
|
1826 | use_readline=self.has_readline, | |
1826 | config=self.config, |
|
1827 | config=self.config, | |
1827 | ) |
|
1828 | ) | |
1828 | self.configurables.append(self.Completer) |
|
1829 | self.configurables.append(self.Completer) | |
1829 |
|
1830 | |||
1830 | # Add custom completers to the basic ones built into IPCompleter |
|
1831 | # Add custom completers to the basic ones built into IPCompleter | |
1831 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1832 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
1832 | self.strdispatchers['complete_command'] = sdisp |
|
1833 | self.strdispatchers['complete_command'] = sdisp | |
1833 | self.Completer.custom_completers = sdisp |
|
1834 | self.Completer.custom_completers = sdisp | |
1834 |
|
1835 | |||
1835 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
1836 | self.set_hook('complete_command', module_completer, str_key = 'import') | |
1836 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
1837 | self.set_hook('complete_command', module_completer, str_key = 'from') | |
1837 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
1838 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') | |
1838 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
1839 | self.set_hook('complete_command', cd_completer, str_key = '%cd') | |
1839 |
|
1840 | |||
1840 | # Only configure readline if we truly are using readline. IPython can |
|
1841 | # Only configure readline if we truly are using readline. IPython can | |
1841 | # do tab-completion over the network, in GUIs, etc, where readline |
|
1842 | # do tab-completion over the network, in GUIs, etc, where readline | |
1842 | # itself may be absent |
|
1843 | # itself may be absent | |
1843 | if self.has_readline: |
|
1844 | if self.has_readline: | |
1844 | self.set_readline_completer() |
|
1845 | self.set_readline_completer() | |
1845 |
|
1846 | |||
1846 | def complete(self, text, line=None, cursor_pos=None): |
|
1847 | def complete(self, text, line=None, cursor_pos=None): | |
1847 | """Return the completed text and a list of completions. |
|
1848 | """Return the completed text and a list of completions. | |
1848 |
|
1849 | |||
1849 | Parameters |
|
1850 | Parameters | |
1850 | ---------- |
|
1851 | ---------- | |
1851 |
|
1852 | |||
1852 | text : string |
|
1853 | text : string | |
1853 | A string of text to be completed on. It can be given as empty and |
|
1854 | A string of text to be completed on. It can be given as empty and | |
1854 | instead a line/position pair are given. In this case, the |
|
1855 | instead a line/position pair are given. In this case, the | |
1855 | completer itself will split the line like readline does. |
|
1856 | completer itself will split the line like readline does. | |
1856 |
|
1857 | |||
1857 | line : string, optional |
|
1858 | line : string, optional | |
1858 | The complete line that text is part of. |
|
1859 | The complete line that text is part of. | |
1859 |
|
1860 | |||
1860 | cursor_pos : int, optional |
|
1861 | cursor_pos : int, optional | |
1861 | The position of the cursor on the input line. |
|
1862 | The position of the cursor on the input line. | |
1862 |
|
1863 | |||
1863 | Returns |
|
1864 | Returns | |
1864 | ------- |
|
1865 | ------- | |
1865 | text : string |
|
1866 | text : string | |
1866 | The actual text that was completed. |
|
1867 | The actual text that was completed. | |
1867 |
|
1868 | |||
1868 | matches : list |
|
1869 | matches : list | |
1869 | A sorted list with all possible completions. |
|
1870 | A sorted list with all possible completions. | |
1870 |
|
1871 | |||
1871 | The optional arguments allow the completion to take more context into |
|
1872 | The optional arguments allow the completion to take more context into | |
1872 | account, and are part of the low-level completion API. |
|
1873 | account, and are part of the low-level completion API. | |
1873 |
|
1874 | |||
1874 | This is a wrapper around the completion mechanism, similar to what |
|
1875 | This is a wrapper around the completion mechanism, similar to what | |
1875 | readline does at the command line when the TAB key is hit. By |
|
1876 | readline does at the command line when the TAB key is hit. By | |
1876 | exposing it as a method, it can be used by other non-readline |
|
1877 | exposing it as a method, it can be used by other non-readline | |
1877 | environments (such as GUIs) for text completion. |
|
1878 | environments (such as GUIs) for text completion. | |
1878 |
|
1879 | |||
1879 | Simple usage example: |
|
1880 | Simple usage example: | |
1880 |
|
1881 | |||
1881 | In [1]: x = 'hello' |
|
1882 | In [1]: x = 'hello' | |
1882 |
|
1883 | |||
1883 | In [2]: _ip.complete('x.l') |
|
1884 | In [2]: _ip.complete('x.l') | |
1884 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
1885 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) | |
1885 | """ |
|
1886 | """ | |
1886 |
|
1887 | |||
1887 | # Inject names into __builtin__ so we can complete on the added names. |
|
1888 | # Inject names into __builtin__ so we can complete on the added names. | |
1888 | with self.builtin_trap: |
|
1889 | with self.builtin_trap: | |
1889 | return self.Completer.complete(text, line, cursor_pos) |
|
1890 | return self.Completer.complete(text, line, cursor_pos) | |
1890 |
|
1891 | |||
1891 | def set_custom_completer(self, completer, pos=0): |
|
1892 | def set_custom_completer(self, completer, pos=0): | |
1892 | """Adds a new custom completer function. |
|
1893 | """Adds a new custom completer function. | |
1893 |
|
1894 | |||
1894 | The position argument (defaults to 0) is the index in the completers |
|
1895 | The position argument (defaults to 0) is the index in the completers | |
1895 | list where you want the completer to be inserted.""" |
|
1896 | list where you want the completer to be inserted.""" | |
1896 |
|
1897 | |||
1897 | newcomp = types.MethodType(completer,self.Completer) |
|
1898 | newcomp = types.MethodType(completer,self.Completer) | |
1898 | self.Completer.matchers.insert(pos,newcomp) |
|
1899 | self.Completer.matchers.insert(pos,newcomp) | |
1899 |
|
1900 | |||
1900 | def set_readline_completer(self): |
|
1901 | def set_readline_completer(self): | |
1901 | """Reset readline's completer to be our own.""" |
|
1902 | """Reset readline's completer to be our own.""" | |
1902 | self.readline.set_completer(self.Completer.rlcomplete) |
|
1903 | self.readline.set_completer(self.Completer.rlcomplete) | |
1903 |
|
1904 | |||
1904 | def set_completer_frame(self, frame=None): |
|
1905 | def set_completer_frame(self, frame=None): | |
1905 | """Set the frame of the completer.""" |
|
1906 | """Set the frame of the completer.""" | |
1906 | if frame: |
|
1907 | if frame: | |
1907 | self.Completer.namespace = frame.f_locals |
|
1908 | self.Completer.namespace = frame.f_locals | |
1908 | self.Completer.global_namespace = frame.f_globals |
|
1909 | self.Completer.global_namespace = frame.f_globals | |
1909 | else: |
|
1910 | else: | |
1910 | self.Completer.namespace = self.user_ns |
|
1911 | self.Completer.namespace = self.user_ns | |
1911 | self.Completer.global_namespace = self.user_global_ns |
|
1912 | self.Completer.global_namespace = self.user_global_ns | |
1912 |
|
1913 | |||
1913 | #------------------------------------------------------------------------- |
|
1914 | #------------------------------------------------------------------------- | |
1914 | # Things related to magics |
|
1915 | # Things related to magics | |
1915 | #------------------------------------------------------------------------- |
|
1916 | #------------------------------------------------------------------------- | |
1916 |
|
1917 | |||
1917 | def init_magics(self): |
|
1918 | def init_magics(self): | |
1918 | # FIXME: Move the color initialization to the DisplayHook, which |
|
1919 | # FIXME: Move the color initialization to the DisplayHook, which | |
1919 | # should be split into a prompt manager and displayhook. We probably |
|
1920 | # should be split into a prompt manager and displayhook. We probably | |
1920 | # even need a centralize colors management object. |
|
1921 | # even need a centralize colors management object. | |
1921 | self.magic_colors(self.colors) |
|
1922 | self.magic_colors(self.colors) | |
1922 | # History was moved to a separate module |
|
1923 | # History was moved to a separate module | |
1923 | from . import history |
|
1924 | from . import history | |
1924 | history.init_ipython(self) |
|
1925 | history.init_ipython(self) | |
1925 |
|
1926 | |||
1926 | def magic(self, arg_s, next_input=None): |
|
1927 | def magic(self, arg_s, next_input=None): | |
1927 | """Call a magic function by name. |
|
1928 | """Call a magic function by name. | |
1928 |
|
1929 | |||
1929 | Input: a string containing the name of the magic function to call and |
|
1930 | Input: a string containing the name of the magic function to call and | |
1930 | any additional arguments to be passed to the magic. |
|
1931 | any additional arguments to be passed to the magic. | |
1931 |
|
1932 | |||
1932 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
1933 | magic('name -opt foo bar') is equivalent to typing at the ipython | |
1933 | prompt: |
|
1934 | prompt: | |
1934 |
|
1935 | |||
1935 | In[1]: %name -opt foo bar |
|
1936 | In[1]: %name -opt foo bar | |
1936 |
|
1937 | |||
1937 | To call a magic without arguments, simply use magic('name'). |
|
1938 | To call a magic without arguments, simply use magic('name'). | |
1938 |
|
1939 | |||
1939 | This provides a proper Python function to call IPython's magics in any |
|
1940 | This provides a proper Python function to call IPython's magics in any | |
1940 | valid Python code you can type at the interpreter, including loops and |
|
1941 | valid Python code you can type at the interpreter, including loops and | |
1941 | compound statements. |
|
1942 | compound statements. | |
1942 | """ |
|
1943 | """ | |
1943 | # Allow setting the next input - this is used if the user does `a=abs?`. |
|
1944 | # Allow setting the next input - this is used if the user does `a=abs?`. | |
1944 | # We do this first so that magic functions can override it. |
|
1945 | # We do this first so that magic functions can override it. | |
1945 | if next_input: |
|
1946 | if next_input: | |
1946 | self.set_next_input(next_input) |
|
1947 | self.set_next_input(next_input) | |
1947 |
|
1948 | |||
1948 | args = arg_s.split(' ',1) |
|
1949 | args = arg_s.split(' ',1) | |
1949 | magic_name = args[0] |
|
1950 | magic_name = args[0] | |
1950 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
1951 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) | |
1951 |
|
1952 | |||
1952 | try: |
|
1953 | try: | |
1953 | magic_args = args[1] |
|
1954 | magic_args = args[1] | |
1954 | except IndexError: |
|
1955 | except IndexError: | |
1955 | magic_args = '' |
|
1956 | magic_args = '' | |
1956 | fn = getattr(self,'magic_'+magic_name,None) |
|
1957 | fn = getattr(self,'magic_'+magic_name,None) | |
1957 | if fn is None: |
|
1958 | if fn is None: | |
1958 | error("Magic function `%s` not found." % magic_name) |
|
1959 | error("Magic function `%s` not found." % magic_name) | |
1959 | else: |
|
1960 | else: | |
1960 | magic_args = self.var_expand(magic_args,1) |
|
1961 | magic_args = self.var_expand(magic_args,1) | |
1961 | # Grab local namespace if we need it: |
|
1962 | # Grab local namespace if we need it: | |
1962 | if getattr(fn, "needs_local_scope", False): |
|
1963 | if getattr(fn, "needs_local_scope", False): | |
1963 | self._magic_locals = sys._getframe(1).f_locals |
|
1964 | self._magic_locals = sys._getframe(1).f_locals | |
1964 | with self.builtin_trap: |
|
1965 | with self.builtin_trap: | |
1965 | result = fn(magic_args) |
|
1966 | result = fn(magic_args) | |
1966 | # Ensure we're not keeping object references around: |
|
1967 | # Ensure we're not keeping object references around: | |
1967 | self._magic_locals = {} |
|
1968 | self._magic_locals = {} | |
1968 | return result |
|
1969 | return result | |
1969 |
|
1970 | |||
1970 | def define_magic(self, magicname, func): |
|
1971 | def define_magic(self, magicname, func): | |
1971 | """Expose own function as magic function for ipython |
|
1972 | """Expose own function as magic function for ipython | |
1972 |
|
1973 | |||
1973 | Example:: |
|
1974 | Example:: | |
1974 |
|
1975 | |||
1975 | def foo_impl(self,parameter_s=''): |
|
1976 | def foo_impl(self,parameter_s=''): | |
1976 | 'My very own magic!. (Use docstrings, IPython reads them).' |
|
1977 | 'My very own magic!. (Use docstrings, IPython reads them).' | |
1977 | print 'Magic function. Passed parameter is between < >:' |
|
1978 | print 'Magic function. Passed parameter is between < >:' | |
1978 | print '<%s>' % parameter_s |
|
1979 | print '<%s>' % parameter_s | |
1979 | print 'The self object is:', self |
|
1980 | print 'The self object is:', self | |
1980 |
|
1981 | |||
1981 | ip.define_magic('foo',foo_impl) |
|
1982 | ip.define_magic('foo',foo_impl) | |
1982 | """ |
|
1983 | """ | |
1983 | im = types.MethodType(func,self) |
|
1984 | im = types.MethodType(func,self) | |
1984 | old = getattr(self, "magic_" + magicname, None) |
|
1985 | old = getattr(self, "magic_" + magicname, None) | |
1985 | setattr(self, "magic_" + magicname, im) |
|
1986 | setattr(self, "magic_" + magicname, im) | |
1986 | return old |
|
1987 | return old | |
1987 |
|
1988 | |||
1988 | #------------------------------------------------------------------------- |
|
1989 | #------------------------------------------------------------------------- | |
1989 | # Things related to macros |
|
1990 | # Things related to macros | |
1990 | #------------------------------------------------------------------------- |
|
1991 | #------------------------------------------------------------------------- | |
1991 |
|
1992 | |||
1992 | def define_macro(self, name, themacro): |
|
1993 | def define_macro(self, name, themacro): | |
1993 | """Define a new macro |
|
1994 | """Define a new macro | |
1994 |
|
1995 | |||
1995 | Parameters |
|
1996 | Parameters | |
1996 | ---------- |
|
1997 | ---------- | |
1997 | name : str |
|
1998 | name : str | |
1998 | The name of the macro. |
|
1999 | The name of the macro. | |
1999 | themacro : str or Macro |
|
2000 | themacro : str or Macro | |
2000 | The action to do upon invoking the macro. If a string, a new |
|
2001 | The action to do upon invoking the macro. If a string, a new | |
2001 | Macro object is created by passing the string to it. |
|
2002 | Macro object is created by passing the string to it. | |
2002 | """ |
|
2003 | """ | |
2003 |
|
2004 | |||
2004 | from IPython.core import macro |
|
2005 | from IPython.core import macro | |
2005 |
|
2006 | |||
2006 | if isinstance(themacro, basestring): |
|
2007 | if isinstance(themacro, basestring): | |
2007 | themacro = macro.Macro(themacro) |
|
2008 | themacro = macro.Macro(themacro) | |
2008 | if not isinstance(themacro, macro.Macro): |
|
2009 | if not isinstance(themacro, macro.Macro): | |
2009 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2010 | raise ValueError('A macro must be a string or a Macro instance.') | |
2010 | self.user_ns[name] = themacro |
|
2011 | self.user_ns[name] = themacro | |
2011 |
|
2012 | |||
2012 | #------------------------------------------------------------------------- |
|
2013 | #------------------------------------------------------------------------- | |
2013 | # Things related to the running of system commands |
|
2014 | # Things related to the running of system commands | |
2014 | #------------------------------------------------------------------------- |
|
2015 | #------------------------------------------------------------------------- | |
2015 |
|
2016 | |||
2016 | def system_piped(self, cmd): |
|
2017 | def system_piped(self, cmd): | |
2017 | """Call the given cmd in a subprocess, piping stdout/err |
|
2018 | """Call the given cmd in a subprocess, piping stdout/err | |
2018 |
|
2019 | |||
2019 | Parameters |
|
2020 | Parameters | |
2020 | ---------- |
|
2021 | ---------- | |
2021 | cmd : str |
|
2022 | cmd : str | |
2022 | Command to execute (can not end in '&', as background processes are |
|
2023 | Command to execute (can not end in '&', as background processes are | |
2023 | not supported. Should not be a command that expects input |
|
2024 | not supported. Should not be a command that expects input | |
2024 | other than simple text. |
|
2025 | other than simple text. | |
2025 | """ |
|
2026 | """ | |
2026 | if cmd.rstrip().endswith('&'): |
|
2027 | if cmd.rstrip().endswith('&'): | |
2027 | # this is *far* from a rigorous test |
|
2028 | # this is *far* from a rigorous test | |
2028 | # We do not support backgrounding processes because we either use |
|
2029 | # We do not support backgrounding processes because we either use | |
2029 | # pexpect or pipes to read from. Users can always just call |
|
2030 | # pexpect or pipes to read from. Users can always just call | |
2030 | # os.system() or use ip.system=ip.system_raw |
|
2031 | # os.system() or use ip.system=ip.system_raw | |
2031 | # if they really want a background process. |
|
2032 | # if they really want a background process. | |
2032 | raise OSError("Background processes not supported.") |
|
2033 | raise OSError("Background processes not supported.") | |
2033 |
|
2034 | |||
2034 | # we explicitly do NOT return the subprocess status code, because |
|
2035 | # we explicitly do NOT return the subprocess status code, because | |
2035 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2036 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2036 | # Instead, we store the exit_code in user_ns. |
|
2037 | # Instead, we store the exit_code in user_ns. | |
2037 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2)) |
|
2038 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2)) | |
2038 |
|
2039 | |||
2039 | def system_raw(self, cmd): |
|
2040 | def system_raw(self, cmd): | |
2040 | """Call the given cmd in a subprocess using os.system |
|
2041 | """Call the given cmd in a subprocess using os.system | |
2041 |
|
2042 | |||
2042 | Parameters |
|
2043 | Parameters | |
2043 | ---------- |
|
2044 | ---------- | |
2044 | cmd : str |
|
2045 | cmd : str | |
2045 | Command to execute. |
|
2046 | Command to execute. | |
2046 | """ |
|
2047 | """ | |
2047 | cmd = self.var_expand(cmd, depth=2) |
|
2048 | cmd = self.var_expand(cmd, depth=2) | |
2048 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2049 | # protect os.system from UNC paths on Windows, which it can't handle: | |
2049 | if sys.platform == 'win32': |
|
2050 | if sys.platform == 'win32': | |
2050 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2051 | from IPython.utils._process_win32 import AvoidUNCPath | |
2051 | with AvoidUNCPath() as path: |
|
2052 | with AvoidUNCPath() as path: | |
2052 | if path is not None: |
|
2053 | if path is not None: | |
2053 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2054 | cmd = '"pushd %s &&"%s' % (path, cmd) | |
2054 | cmd = py3compat.unicode_to_str(cmd) |
|
2055 | cmd = py3compat.unicode_to_str(cmd) | |
2055 | ec = os.system(cmd) |
|
2056 | ec = os.system(cmd) | |
2056 | else: |
|
2057 | else: | |
2057 | cmd = py3compat.unicode_to_str(cmd) |
|
2058 | cmd = py3compat.unicode_to_str(cmd) | |
2058 | ec = os.system(cmd) |
|
2059 | ec = os.system(cmd) | |
2059 |
|
2060 | |||
2060 | # We explicitly do NOT return the subprocess status code, because |
|
2061 | # We explicitly do NOT return the subprocess status code, because | |
2061 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2062 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2062 | # Instead, we store the exit_code in user_ns. |
|
2063 | # Instead, we store the exit_code in user_ns. | |
2063 | self.user_ns['_exit_code'] = ec |
|
2064 | self.user_ns['_exit_code'] = ec | |
2064 |
|
2065 | |||
2065 | # use piped system by default, because it is better behaved |
|
2066 | # use piped system by default, because it is better behaved | |
2066 | system = system_piped |
|
2067 | system = system_piped | |
2067 |
|
2068 | |||
2068 | def getoutput(self, cmd, split=True): |
|
2069 | def getoutput(self, cmd, split=True): | |
2069 | """Get output (possibly including stderr) from a subprocess. |
|
2070 | """Get output (possibly including stderr) from a subprocess. | |
2070 |
|
2071 | |||
2071 | Parameters |
|
2072 | Parameters | |
2072 | ---------- |
|
2073 | ---------- | |
2073 | cmd : str |
|
2074 | cmd : str | |
2074 | Command to execute (can not end in '&', as background processes are |
|
2075 | Command to execute (can not end in '&', as background processes are | |
2075 | not supported. |
|
2076 | not supported. | |
2076 | split : bool, optional |
|
2077 | split : bool, optional | |
2077 |
|
2078 | |||
2078 | If True, split the output into an IPython SList. Otherwise, an |
|
2079 | If True, split the output into an IPython SList. Otherwise, an | |
2079 | IPython LSString is returned. These are objects similar to normal |
|
2080 | IPython LSString is returned. These are objects similar to normal | |
2080 | lists and strings, with a few convenience attributes for easier |
|
2081 | lists and strings, with a few convenience attributes for easier | |
2081 | manipulation of line-based output. You can use '?' on them for |
|
2082 | manipulation of line-based output. You can use '?' on them for | |
2082 | details. |
|
2083 | details. | |
2083 | """ |
|
2084 | """ | |
2084 | if cmd.rstrip().endswith('&'): |
|
2085 | if cmd.rstrip().endswith('&'): | |
2085 | # this is *far* from a rigorous test |
|
2086 | # this is *far* from a rigorous test | |
2086 | raise OSError("Background processes not supported.") |
|
2087 | raise OSError("Background processes not supported.") | |
2087 | out = getoutput(self.var_expand(cmd, depth=2)) |
|
2088 | out = getoutput(self.var_expand(cmd, depth=2)) | |
2088 | if split: |
|
2089 | if split: | |
2089 | out = SList(out.splitlines()) |
|
2090 | out = SList(out.splitlines()) | |
2090 | else: |
|
2091 | else: | |
2091 | out = LSString(out) |
|
2092 | out = LSString(out) | |
2092 | return out |
|
2093 | return out | |
2093 |
|
2094 | |||
2094 | #------------------------------------------------------------------------- |
|
2095 | #------------------------------------------------------------------------- | |
2095 | # Things related to aliases |
|
2096 | # Things related to aliases | |
2096 | #------------------------------------------------------------------------- |
|
2097 | #------------------------------------------------------------------------- | |
2097 |
|
2098 | |||
2098 | def init_alias(self): |
|
2099 | def init_alias(self): | |
2099 | self.alias_manager = AliasManager(shell=self, config=self.config) |
|
2100 | self.alias_manager = AliasManager(shell=self, config=self.config) | |
2100 | self.configurables.append(self.alias_manager) |
|
2101 | self.configurables.append(self.alias_manager) | |
2101 | self.ns_table['alias'] = self.alias_manager.alias_table, |
|
2102 | self.ns_table['alias'] = self.alias_manager.alias_table, | |
2102 |
|
2103 | |||
2103 | #------------------------------------------------------------------------- |
|
2104 | #------------------------------------------------------------------------- | |
2104 | # Things related to extensions and plugins |
|
2105 | # Things related to extensions and plugins | |
2105 | #------------------------------------------------------------------------- |
|
2106 | #------------------------------------------------------------------------- | |
2106 |
|
2107 | |||
2107 | def init_extension_manager(self): |
|
2108 | def init_extension_manager(self): | |
2108 | self.extension_manager = ExtensionManager(shell=self, config=self.config) |
|
2109 | self.extension_manager = ExtensionManager(shell=self, config=self.config) | |
2109 | self.configurables.append(self.extension_manager) |
|
2110 | self.configurables.append(self.extension_manager) | |
2110 |
|
2111 | |||
2111 | def init_plugin_manager(self): |
|
2112 | def init_plugin_manager(self): | |
2112 | self.plugin_manager = PluginManager(config=self.config) |
|
2113 | self.plugin_manager = PluginManager(config=self.config) | |
2113 | self.configurables.append(self.plugin_manager) |
|
2114 | self.configurables.append(self.plugin_manager) | |
2114 |
|
2115 | |||
2115 |
|
2116 | |||
2116 | #------------------------------------------------------------------------- |
|
2117 | #------------------------------------------------------------------------- | |
2117 | # Things related to payloads |
|
2118 | # Things related to payloads | |
2118 | #------------------------------------------------------------------------- |
|
2119 | #------------------------------------------------------------------------- | |
2119 |
|
2120 | |||
2120 | def init_payload(self): |
|
2121 | def init_payload(self): | |
2121 | self.payload_manager = PayloadManager(config=self.config) |
|
2122 | self.payload_manager = PayloadManager(config=self.config) | |
2122 | self.configurables.append(self.payload_manager) |
|
2123 | self.configurables.append(self.payload_manager) | |
2123 |
|
2124 | |||
2124 | #------------------------------------------------------------------------- |
|
2125 | #------------------------------------------------------------------------- | |
2125 | # Things related to the prefilter |
|
2126 | # Things related to the prefilter | |
2126 | #------------------------------------------------------------------------- |
|
2127 | #------------------------------------------------------------------------- | |
2127 |
|
2128 | |||
2128 | def init_prefilter(self): |
|
2129 | def init_prefilter(self): | |
2129 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) |
|
2130 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) | |
2130 | self.configurables.append(self.prefilter_manager) |
|
2131 | self.configurables.append(self.prefilter_manager) | |
2131 | # Ultimately this will be refactored in the new interpreter code, but |
|
2132 | # Ultimately this will be refactored in the new interpreter code, but | |
2132 | # for now, we should expose the main prefilter method (there's legacy |
|
2133 | # for now, we should expose the main prefilter method (there's legacy | |
2133 | # code out there that may rely on this). |
|
2134 | # code out there that may rely on this). | |
2134 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2135 | self.prefilter = self.prefilter_manager.prefilter_lines | |
2135 |
|
2136 | |||
2136 | def auto_rewrite_input(self, cmd): |
|
2137 | def auto_rewrite_input(self, cmd): | |
2137 | """Print to the screen the rewritten form of the user's command. |
|
2138 | """Print to the screen the rewritten form of the user's command. | |
2138 |
|
2139 | |||
2139 | This shows visual feedback by rewriting input lines that cause |
|
2140 | This shows visual feedback by rewriting input lines that cause | |
2140 | automatic calling to kick in, like:: |
|
2141 | automatic calling to kick in, like:: | |
2141 |
|
2142 | |||
2142 | /f x |
|
2143 | /f x | |
2143 |
|
2144 | |||
2144 | into:: |
|
2145 | into:: | |
2145 |
|
2146 | |||
2146 | ------> f(x) |
|
2147 | ------> f(x) | |
2147 |
|
2148 | |||
2148 | after the user's input prompt. This helps the user understand that the |
|
2149 | after the user's input prompt. This helps the user understand that the | |
2149 | input line was transformed automatically by IPython. |
|
2150 | input line was transformed automatically by IPython. | |
2150 | """ |
|
2151 | """ | |
2151 | rw = self.displayhook.prompt1.auto_rewrite() + cmd |
|
2152 | rw = self.displayhook.prompt1.auto_rewrite() + cmd | |
2152 |
|
2153 | |||
2153 | try: |
|
2154 | try: | |
2154 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2155 | # plain ascii works better w/ pyreadline, on some machines, so | |
2155 | # we use it and only print uncolored rewrite if we have unicode |
|
2156 | # we use it and only print uncolored rewrite if we have unicode | |
2156 | rw = str(rw) |
|
2157 | rw = str(rw) | |
2157 | print >> io.stdout, rw |
|
2158 | print >> io.stdout, rw | |
2158 | except UnicodeEncodeError: |
|
2159 | except UnicodeEncodeError: | |
2159 | print "------> " + cmd |
|
2160 | print "------> " + cmd | |
2160 |
|
2161 | |||
2161 | #------------------------------------------------------------------------- |
|
2162 | #------------------------------------------------------------------------- | |
2162 | # Things related to extracting values/expressions from kernel and user_ns |
|
2163 | # Things related to extracting values/expressions from kernel and user_ns | |
2163 | #------------------------------------------------------------------------- |
|
2164 | #------------------------------------------------------------------------- | |
2164 |
|
2165 | |||
2165 | def _simple_error(self): |
|
2166 | def _simple_error(self): | |
2166 | etype, value = sys.exc_info()[:2] |
|
2167 | etype, value = sys.exc_info()[:2] | |
2167 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) |
|
2168 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) | |
2168 |
|
2169 | |||
2169 | def user_variables(self, names): |
|
2170 | def user_variables(self, names): | |
2170 | """Get a list of variable names from the user's namespace. |
|
2171 | """Get a list of variable names from the user's namespace. | |
2171 |
|
2172 | |||
2172 | Parameters |
|
2173 | Parameters | |
2173 | ---------- |
|
2174 | ---------- | |
2174 | names : list of strings |
|
2175 | names : list of strings | |
2175 | A list of names of variables to be read from the user namespace. |
|
2176 | A list of names of variables to be read from the user namespace. | |
2176 |
|
2177 | |||
2177 | Returns |
|
2178 | Returns | |
2178 | ------- |
|
2179 | ------- | |
2179 | A dict, keyed by the input names and with the repr() of each value. |
|
2180 | A dict, keyed by the input names and with the repr() of each value. | |
2180 | """ |
|
2181 | """ | |
2181 | out = {} |
|
2182 | out = {} | |
2182 | user_ns = self.user_ns |
|
2183 | user_ns = self.user_ns | |
2183 | for varname in names: |
|
2184 | for varname in names: | |
2184 | try: |
|
2185 | try: | |
2185 | value = repr(user_ns[varname]) |
|
2186 | value = repr(user_ns[varname]) | |
2186 | except: |
|
2187 | except: | |
2187 | value = self._simple_error() |
|
2188 | value = self._simple_error() | |
2188 | out[varname] = value |
|
2189 | out[varname] = value | |
2189 | return out |
|
2190 | return out | |
2190 |
|
2191 | |||
2191 | def user_expressions(self, expressions): |
|
2192 | def user_expressions(self, expressions): | |
2192 | """Evaluate a dict of expressions in the user's namespace. |
|
2193 | """Evaluate a dict of expressions in the user's namespace. | |
2193 |
|
2194 | |||
2194 | Parameters |
|
2195 | Parameters | |
2195 | ---------- |
|
2196 | ---------- | |
2196 | expressions : dict |
|
2197 | expressions : dict | |
2197 | A dict with string keys and string values. The expression values |
|
2198 | A dict with string keys and string values. The expression values | |
2198 | should be valid Python expressions, each of which will be evaluated |
|
2199 | should be valid Python expressions, each of which will be evaluated | |
2199 | in the user namespace. |
|
2200 | in the user namespace. | |
2200 |
|
2201 | |||
2201 | Returns |
|
2202 | Returns | |
2202 | ------- |
|
2203 | ------- | |
2203 | A dict, keyed like the input expressions dict, with the repr() of each |
|
2204 | A dict, keyed like the input expressions dict, with the repr() of each | |
2204 | value. |
|
2205 | value. | |
2205 | """ |
|
2206 | """ | |
2206 | out = {} |
|
2207 | out = {} | |
2207 | user_ns = self.user_ns |
|
2208 | user_ns = self.user_ns | |
2208 | global_ns = self.user_global_ns |
|
2209 | global_ns = self.user_global_ns | |
2209 | for key, expr in expressions.iteritems(): |
|
2210 | for key, expr in expressions.iteritems(): | |
2210 | try: |
|
2211 | try: | |
2211 | value = repr(eval(expr, global_ns, user_ns)) |
|
2212 | value = repr(eval(expr, global_ns, user_ns)) | |
2212 | except: |
|
2213 | except: | |
2213 | value = self._simple_error() |
|
2214 | value = self._simple_error() | |
2214 | out[key] = value |
|
2215 | out[key] = value | |
2215 | return out |
|
2216 | return out | |
2216 |
|
2217 | |||
2217 | #------------------------------------------------------------------------- |
|
2218 | #------------------------------------------------------------------------- | |
2218 | # Things related to the running of code |
|
2219 | # Things related to the running of code | |
2219 | #------------------------------------------------------------------------- |
|
2220 | #------------------------------------------------------------------------- | |
2220 |
|
2221 | |||
2221 | def ex(self, cmd): |
|
2222 | def ex(self, cmd): | |
2222 | """Execute a normal python statement in user namespace.""" |
|
2223 | """Execute a normal python statement in user namespace.""" | |
2223 | with self.builtin_trap: |
|
2224 | with self.builtin_trap: | |
2224 | exec cmd in self.user_global_ns, self.user_ns |
|
2225 | exec cmd in self.user_global_ns, self.user_ns | |
2225 |
|
2226 | |||
2226 | def ev(self, expr): |
|
2227 | def ev(self, expr): | |
2227 | """Evaluate python expression expr in user namespace. |
|
2228 | """Evaluate python expression expr in user namespace. | |
2228 |
|
2229 | |||
2229 | Returns the result of evaluation |
|
2230 | Returns the result of evaluation | |
2230 | """ |
|
2231 | """ | |
2231 | with self.builtin_trap: |
|
2232 | with self.builtin_trap: | |
2232 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2233 | return eval(expr, self.user_global_ns, self.user_ns) | |
2233 |
|
2234 | |||
2234 | def safe_execfile(self, fname, *where, **kw): |
|
2235 | def safe_execfile(self, fname, *where, **kw): | |
2235 | """A safe version of the builtin execfile(). |
|
2236 | """A safe version of the builtin execfile(). | |
2236 |
|
2237 | |||
2237 | This version will never throw an exception, but instead print |
|
2238 | This version will never throw an exception, but instead print | |
2238 | helpful error messages to the screen. This only works on pure |
|
2239 | helpful error messages to the screen. This only works on pure | |
2239 | Python files with the .py extension. |
|
2240 | Python files with the .py extension. | |
2240 |
|
2241 | |||
2241 | Parameters |
|
2242 | Parameters | |
2242 | ---------- |
|
2243 | ---------- | |
2243 | fname : string |
|
2244 | fname : string | |
2244 | The name of the file to be executed. |
|
2245 | The name of the file to be executed. | |
2245 | where : tuple |
|
2246 | where : tuple | |
2246 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2247 | One or two namespaces, passed to execfile() as (globals,locals). | |
2247 | If only one is given, it is passed as both. |
|
2248 | If only one is given, it is passed as both. | |
2248 | exit_ignore : bool (False) |
|
2249 | exit_ignore : bool (False) | |
2249 | If True, then silence SystemExit for non-zero status (it is always |
|
2250 | If True, then silence SystemExit for non-zero status (it is always | |
2250 | silenced for zero status, as it is so common). |
|
2251 | silenced for zero status, as it is so common). | |
2251 | raise_exceptions : bool (False) |
|
2252 | raise_exceptions : bool (False) | |
2252 | If True raise exceptions everywhere. Meant for testing. |
|
2253 | If True raise exceptions everywhere. Meant for testing. | |
2253 |
|
2254 | |||
2254 | """ |
|
2255 | """ | |
2255 | kw.setdefault('exit_ignore', False) |
|
2256 | kw.setdefault('exit_ignore', False) | |
2256 | kw.setdefault('raise_exceptions', False) |
|
2257 | kw.setdefault('raise_exceptions', False) | |
2257 |
|
2258 | |||
2258 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2259 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2259 |
|
2260 | |||
2260 | # Make sure we can open the file |
|
2261 | # Make sure we can open the file | |
2261 | try: |
|
2262 | try: | |
2262 | with open(fname) as thefile: |
|
2263 | with open(fname) as thefile: | |
2263 | pass |
|
2264 | pass | |
2264 | except: |
|
2265 | except: | |
2265 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2266 | warn('Could not open file <%s> for safe execution.' % fname) | |
2266 | return |
|
2267 | return | |
2267 |
|
2268 | |||
2268 | # Find things also in current directory. This is needed to mimic the |
|
2269 | # Find things also in current directory. This is needed to mimic the | |
2269 | # behavior of running a script from the system command line, where |
|
2270 | # behavior of running a script from the system command line, where | |
2270 | # Python inserts the script's directory into sys.path |
|
2271 | # Python inserts the script's directory into sys.path | |
2271 | dname = os.path.dirname(fname) |
|
2272 | dname = os.path.dirname(fname) | |
2272 |
|
2273 | |||
2273 | with prepended_to_syspath(dname): |
|
2274 | with prepended_to_syspath(dname): | |
2274 | try: |
|
2275 | try: | |
2275 | py3compat.execfile(fname,*where) |
|
2276 | py3compat.execfile(fname,*where) | |
2276 | except SystemExit, status: |
|
2277 | except SystemExit, status: | |
2277 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2278 | # If the call was made with 0 or None exit status (sys.exit(0) | |
2278 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2279 | # or sys.exit() ), don't bother showing a traceback, as both of | |
2279 | # these are considered normal by the OS: |
|
2280 | # these are considered normal by the OS: | |
2280 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2281 | # > python -c'import sys;sys.exit(0)'; echo $? | |
2281 | # 0 |
|
2282 | # 0 | |
2282 | # > python -c'import sys;sys.exit()'; echo $? |
|
2283 | # > python -c'import sys;sys.exit()'; echo $? | |
2283 | # 0 |
|
2284 | # 0 | |
2284 | # For other exit status, we show the exception unless |
|
2285 | # For other exit status, we show the exception unless | |
2285 | # explicitly silenced, but only in short form. |
|
2286 | # explicitly silenced, but only in short form. | |
2286 | if kw['raise_exceptions']: |
|
2287 | if kw['raise_exceptions']: | |
2287 | raise |
|
2288 | raise | |
2288 | if status.code not in (0, None) and not kw['exit_ignore']: |
|
2289 | if status.code not in (0, None) and not kw['exit_ignore']: | |
2289 | self.showtraceback(exception_only=True) |
|
2290 | self.showtraceback(exception_only=True) | |
2290 | except: |
|
2291 | except: | |
2291 | if kw['raise_exceptions']: |
|
2292 | if kw['raise_exceptions']: | |
2292 | raise |
|
2293 | raise | |
2293 | self.showtraceback() |
|
2294 | self.showtraceback() | |
2294 |
|
2295 | |||
2295 | def safe_execfile_ipy(self, fname): |
|
2296 | def safe_execfile_ipy(self, fname): | |
2296 | """Like safe_execfile, but for .ipy files with IPython syntax. |
|
2297 | """Like safe_execfile, but for .ipy files with IPython syntax. | |
2297 |
|
2298 | |||
2298 | Parameters |
|
2299 | Parameters | |
2299 | ---------- |
|
2300 | ---------- | |
2300 | fname : str |
|
2301 | fname : str | |
2301 | The name of the file to execute. The filename must have a |
|
2302 | The name of the file to execute. The filename must have a | |
2302 | .ipy extension. |
|
2303 | .ipy extension. | |
2303 | """ |
|
2304 | """ | |
2304 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2305 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2305 |
|
2306 | |||
2306 | # Make sure we can open the file |
|
2307 | # Make sure we can open the file | |
2307 | try: |
|
2308 | try: | |
2308 | with open(fname) as thefile: |
|
2309 | with open(fname) as thefile: | |
2309 | pass |
|
2310 | pass | |
2310 | except: |
|
2311 | except: | |
2311 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2312 | warn('Could not open file <%s> for safe execution.' % fname) | |
2312 | return |
|
2313 | return | |
2313 |
|
2314 | |||
2314 | # Find things also in current directory. This is needed to mimic the |
|
2315 | # Find things also in current directory. This is needed to mimic the | |
2315 | # behavior of running a script from the system command line, where |
|
2316 | # behavior of running a script from the system command line, where | |
2316 | # Python inserts the script's directory into sys.path |
|
2317 | # Python inserts the script's directory into sys.path | |
2317 | dname = os.path.dirname(fname) |
|
2318 | dname = os.path.dirname(fname) | |
2318 |
|
2319 | |||
2319 | with prepended_to_syspath(dname): |
|
2320 | with prepended_to_syspath(dname): | |
2320 | try: |
|
2321 | try: | |
2321 | with open(fname) as thefile: |
|
2322 | with open(fname) as thefile: | |
2322 | # self.run_cell currently captures all exceptions |
|
2323 | # self.run_cell currently captures all exceptions | |
2323 | # raised in user code. It would be nice if there were |
|
2324 | # raised in user code. It would be nice if there were | |
2324 | # versions of runlines, execfile that did raise, so |
|
2325 | # versions of runlines, execfile that did raise, so | |
2325 | # we could catch the errors. |
|
2326 | # we could catch the errors. | |
2326 | self.run_cell(thefile.read(), store_history=False) |
|
2327 | self.run_cell(thefile.read(), store_history=False) | |
2327 | except: |
|
2328 | except: | |
2328 | self.showtraceback() |
|
2329 | self.showtraceback() | |
2329 | warn('Unknown failure executing file: <%s>' % fname) |
|
2330 | warn('Unknown failure executing file: <%s>' % fname) | |
2330 |
|
2331 | |||
2331 | def run_cell(self, raw_cell, store_history=False): |
|
2332 | def run_cell(self, raw_cell, store_history=False): | |
2332 | """Run a complete IPython cell. |
|
2333 | """Run a complete IPython cell. | |
2333 |
|
2334 | |||
2334 | Parameters |
|
2335 | Parameters | |
2335 | ---------- |
|
2336 | ---------- | |
2336 | raw_cell : str |
|
2337 | raw_cell : str | |
2337 | The code (including IPython code such as %magic functions) to run. |
|
2338 | The code (including IPython code such as %magic functions) to run. | |
2338 | store_history : bool |
|
2339 | store_history : bool | |
2339 | If True, the raw and translated cell will be stored in IPython's |
|
2340 | If True, the raw and translated cell will be stored in IPython's | |
2340 | history. For user code calling back into IPython's machinery, this |
|
2341 | history. For user code calling back into IPython's machinery, this | |
2341 | should be set to False. |
|
2342 | should be set to False. | |
2342 | """ |
|
2343 | """ | |
2343 | if (not raw_cell) or raw_cell.isspace(): |
|
2344 | if (not raw_cell) or raw_cell.isspace(): | |
2344 | return |
|
2345 | return | |
2345 |
|
2346 | |||
2346 | for line in raw_cell.splitlines(): |
|
2347 | for line in raw_cell.splitlines(): | |
2347 | self.input_splitter.push(line) |
|
2348 | self.input_splitter.push(line) | |
2348 | cell = self.input_splitter.source_reset() |
|
2349 | cell = self.input_splitter.source_reset() | |
2349 |
|
2350 | |||
2350 | with self.builtin_trap: |
|
2351 | with self.builtin_trap: | |
2351 | prefilter_failed = False |
|
2352 | prefilter_failed = False | |
2352 | if len(cell.splitlines()) == 1: |
|
2353 | if len(cell.splitlines()) == 1: | |
2353 | try: |
|
2354 | try: | |
2354 | # use prefilter_lines to handle trailing newlines |
|
2355 | # use prefilter_lines to handle trailing newlines | |
2355 | # restore trailing newline for ast.parse |
|
2356 | # restore trailing newline for ast.parse | |
2356 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
2357 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' | |
2357 | except AliasError as e: |
|
2358 | except AliasError as e: | |
2358 | error(e) |
|
2359 | error(e) | |
2359 | prefilter_failed = True |
|
2360 | prefilter_failed = True | |
2360 | except Exception: |
|
2361 | except Exception: | |
2361 | # don't allow prefilter errors to crash IPython |
|
2362 | # don't allow prefilter errors to crash IPython | |
2362 | self.showtraceback() |
|
2363 | self.showtraceback() | |
2363 | prefilter_failed = True |
|
2364 | prefilter_failed = True | |
2364 |
|
2365 | |||
2365 | # Store raw and processed history |
|
2366 | # Store raw and processed history | |
2366 | if store_history: |
|
2367 | if store_history: | |
2367 | self.history_manager.store_inputs(self.execution_count, |
|
2368 | self.history_manager.store_inputs(self.execution_count, | |
2368 | cell, raw_cell) |
|
2369 | cell, raw_cell) | |
2369 |
|
2370 | |||
2370 | self.logger.log(cell, raw_cell) |
|
2371 | self.logger.log(cell, raw_cell) | |
2371 |
|
2372 | |||
2372 | if not prefilter_failed: |
|
2373 | if not prefilter_failed: | |
2373 | # don't run if prefilter failed |
|
2374 | # don't run if prefilter failed | |
2374 | cell_name = self.compile.cache(cell, self.execution_count) |
|
2375 | cell_name = self.compile.cache(cell, self.execution_count) | |
2375 |
|
2376 | |||
2376 | with self.display_trap: |
|
2377 | with self.display_trap: | |
2377 | try: |
|
2378 | try: | |
2378 | code_ast = self.compile.ast_parse(cell, filename=cell_name) |
|
2379 | code_ast = self.compile.ast_parse(cell, filename=cell_name) | |
2379 | except IndentationError: |
|
2380 | except IndentationError: | |
2380 | self.showindentationerror() |
|
2381 | self.showindentationerror() | |
2381 | self.execution_count += 1 |
|
2382 | self.execution_count += 1 | |
2382 | return None |
|
2383 | return None | |
2383 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
2384 | except (OverflowError, SyntaxError, ValueError, TypeError, | |
2384 | MemoryError): |
|
2385 | MemoryError): | |
2385 | self.showsyntaxerror() |
|
2386 | self.showsyntaxerror() | |
2386 | self.execution_count += 1 |
|
2387 | self.execution_count += 1 | |
2387 | return None |
|
2388 | return None | |
2388 |
|
2389 | |||
2389 | self.run_ast_nodes(code_ast.body, cell_name, |
|
2390 | self.run_ast_nodes(code_ast.body, cell_name, | |
2390 | interactivity="last_expr") |
|
2391 | interactivity="last_expr") | |
2391 |
|
2392 | |||
2392 | # Execute any registered post-execution functions. |
|
2393 | # Execute any registered post-execution functions. | |
2393 | for func, status in self._post_execute.iteritems(): |
|
2394 | for func, status in self._post_execute.iteritems(): | |
2394 | if not status: |
|
2395 | if not status: | |
2395 | continue |
|
2396 | continue | |
2396 | try: |
|
2397 | try: | |
2397 | func() |
|
2398 | func() | |
2398 | except KeyboardInterrupt: |
|
2399 | except KeyboardInterrupt: | |
2399 | print >> io.stderr, "\nKeyboardInterrupt" |
|
2400 | print >> io.stderr, "\nKeyboardInterrupt" | |
2400 | except Exception: |
|
2401 | except Exception: | |
2401 | print >> io.stderr, "Disabling failed post-execution function: %s" % func |
|
2402 | print >> io.stderr, "Disabling failed post-execution function: %s" % func | |
2402 | self.showtraceback() |
|
2403 | self.showtraceback() | |
2403 | # Deactivate failing function |
|
2404 | # Deactivate failing function | |
2404 | self._post_execute[func] = False |
|
2405 | self._post_execute[func] = False | |
2405 |
|
2406 | |||
2406 | if store_history: |
|
2407 | if store_history: | |
2407 | # Write output to the database. Does nothing unless |
|
2408 | # Write output to the database. Does nothing unless | |
2408 | # history output logging is enabled. |
|
2409 | # history output logging is enabled. | |
2409 | self.history_manager.store_output(self.execution_count) |
|
2410 | self.history_manager.store_output(self.execution_count) | |
2410 | # Each cell is a *single* input, regardless of how many lines it has |
|
2411 | # Each cell is a *single* input, regardless of how many lines it has | |
2411 | self.execution_count += 1 |
|
2412 | self.execution_count += 1 | |
2412 |
|
2413 | |||
2413 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'): |
|
2414 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'): | |
2414 | """Run a sequence of AST nodes. The execution mode depends on the |
|
2415 | """Run a sequence of AST nodes. The execution mode depends on the | |
2415 | interactivity parameter. |
|
2416 | interactivity parameter. | |
2416 |
|
2417 | |||
2417 | Parameters |
|
2418 | Parameters | |
2418 | ---------- |
|
2419 | ---------- | |
2419 | nodelist : list |
|
2420 | nodelist : list | |
2420 | A sequence of AST nodes to run. |
|
2421 | A sequence of AST nodes to run. | |
2421 | cell_name : str |
|
2422 | cell_name : str | |
2422 | Will be passed to the compiler as the filename of the cell. Typically |
|
2423 | Will be passed to the compiler as the filename of the cell. Typically | |
2423 | the value returned by ip.compile.cache(cell). |
|
2424 | the value returned by ip.compile.cache(cell). | |
2424 | interactivity : str |
|
2425 | interactivity : str | |
2425 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be |
|
2426 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be | |
2426 | run interactively (displaying output from expressions). 'last_expr' |
|
2427 | run interactively (displaying output from expressions). 'last_expr' | |
2427 | will run the last node interactively only if it is an expression (i.e. |
|
2428 | will run the last node interactively only if it is an expression (i.e. | |
2428 | expressions in loops or other blocks are not displayed. Other values |
|
2429 | expressions in loops or other blocks are not displayed. Other values | |
2429 | for this parameter will raise a ValueError. |
|
2430 | for this parameter will raise a ValueError. | |
2430 | """ |
|
2431 | """ | |
2431 | if not nodelist: |
|
2432 | if not nodelist: | |
2432 | return |
|
2433 | return | |
2433 |
|
2434 | |||
2434 | if interactivity == 'last_expr': |
|
2435 | if interactivity == 'last_expr': | |
2435 | if isinstance(nodelist[-1], ast.Expr): |
|
2436 | if isinstance(nodelist[-1], ast.Expr): | |
2436 | interactivity = "last" |
|
2437 | interactivity = "last" | |
2437 | else: |
|
2438 | else: | |
2438 | interactivity = "none" |
|
2439 | interactivity = "none" | |
2439 |
|
2440 | |||
2440 | if interactivity == 'none': |
|
2441 | if interactivity == 'none': | |
2441 | to_run_exec, to_run_interactive = nodelist, [] |
|
2442 | to_run_exec, to_run_interactive = nodelist, [] | |
2442 | elif interactivity == 'last': |
|
2443 | elif interactivity == 'last': | |
2443 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
2444 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] | |
2444 | elif interactivity == 'all': |
|
2445 | elif interactivity == 'all': | |
2445 | to_run_exec, to_run_interactive = [], nodelist |
|
2446 | to_run_exec, to_run_interactive = [], nodelist | |
2446 | else: |
|
2447 | else: | |
2447 | raise ValueError("Interactivity was %r" % interactivity) |
|
2448 | raise ValueError("Interactivity was %r" % interactivity) | |
2448 |
|
2449 | |||
2449 | exec_count = self.execution_count |
|
2450 | exec_count = self.execution_count | |
2450 |
|
2451 | |||
2451 | try: |
|
2452 | try: | |
2452 | for i, node in enumerate(to_run_exec): |
|
2453 | for i, node in enumerate(to_run_exec): | |
2453 | mod = ast.Module([node]) |
|
2454 | mod = ast.Module([node]) | |
2454 | code = self.compile(mod, cell_name, "exec") |
|
2455 | code = self.compile(mod, cell_name, "exec") | |
2455 | if self.run_code(code): |
|
2456 | if self.run_code(code): | |
2456 | return True |
|
2457 | return True | |
2457 |
|
2458 | |||
2458 | for i, node in enumerate(to_run_interactive): |
|
2459 | for i, node in enumerate(to_run_interactive): | |
2459 | mod = ast.Interactive([node]) |
|
2460 | mod = ast.Interactive([node]) | |
2460 | code = self.compile(mod, cell_name, "single") |
|
2461 | code = self.compile(mod, cell_name, "single") | |
2461 | if self.run_code(code): |
|
2462 | if self.run_code(code): | |
2462 | return True |
|
2463 | return True | |
2463 | except: |
|
2464 | except: | |
2464 | # It's possible to have exceptions raised here, typically by |
|
2465 | # It's possible to have exceptions raised here, typically by | |
2465 | # compilation of odd code (such as a naked 'return' outside a |
|
2466 | # compilation of odd code (such as a naked 'return' outside a | |
2466 | # function) that did parse but isn't valid. Typically the exception |
|
2467 | # function) that did parse but isn't valid. Typically the exception | |
2467 | # is a SyntaxError, but it's safest just to catch anything and show |
|
2468 | # is a SyntaxError, but it's safest just to catch anything and show | |
2468 | # the user a traceback. |
|
2469 | # the user a traceback. | |
2469 |
|
2470 | |||
2470 | # We do only one try/except outside the loop to minimize the impact |
|
2471 | # We do only one try/except outside the loop to minimize the impact | |
2471 | # on runtime, and also because if any node in the node list is |
|
2472 | # on runtime, and also because if any node in the node list is | |
2472 | # broken, we should stop execution completely. |
|
2473 | # broken, we should stop execution completely. | |
2473 | self.showtraceback() |
|
2474 | self.showtraceback() | |
2474 |
|
2475 | |||
2475 | return False |
|
2476 | return False | |
2476 |
|
2477 | |||
2477 | def run_code(self, code_obj): |
|
2478 | def run_code(self, code_obj): | |
2478 | """Execute a code object. |
|
2479 | """Execute a code object. | |
2479 |
|
2480 | |||
2480 | When an exception occurs, self.showtraceback() is called to display a |
|
2481 | When an exception occurs, self.showtraceback() is called to display a | |
2481 | traceback. |
|
2482 | traceback. | |
2482 |
|
2483 | |||
2483 | Parameters |
|
2484 | Parameters | |
2484 | ---------- |
|
2485 | ---------- | |
2485 | code_obj : code object |
|
2486 | code_obj : code object | |
2486 | A compiled code object, to be executed |
|
2487 | A compiled code object, to be executed | |
2487 | post_execute : bool [default: True] |
|
2488 | post_execute : bool [default: True] | |
2488 | whether to call post_execute hooks after this particular execution. |
|
2489 | whether to call post_execute hooks after this particular execution. | |
2489 |
|
2490 | |||
2490 | Returns |
|
2491 | Returns | |
2491 | ------- |
|
2492 | ------- | |
2492 | False : successful execution. |
|
2493 | False : successful execution. | |
2493 | True : an error occurred. |
|
2494 | True : an error occurred. | |
2494 | """ |
|
2495 | """ | |
2495 |
|
2496 | |||
2496 | # Set our own excepthook in case the user code tries to call it |
|
2497 | # Set our own excepthook in case the user code tries to call it | |
2497 | # directly, so that the IPython crash handler doesn't get triggered |
|
2498 | # directly, so that the IPython crash handler doesn't get triggered | |
2498 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2499 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook | |
2499 |
|
2500 | |||
2500 | # we save the original sys.excepthook in the instance, in case config |
|
2501 | # we save the original sys.excepthook in the instance, in case config | |
2501 | # code (such as magics) needs access to it. |
|
2502 | # code (such as magics) needs access to it. | |
2502 | self.sys_excepthook = old_excepthook |
|
2503 | self.sys_excepthook = old_excepthook | |
2503 | outflag = 1 # happens in more places, so it's easier as default |
|
2504 | outflag = 1 # happens in more places, so it's easier as default | |
2504 | try: |
|
2505 | try: | |
2505 | try: |
|
2506 | try: | |
2506 | self.hooks.pre_run_code_hook() |
|
2507 | self.hooks.pre_run_code_hook() | |
2507 | #rprint('Running code', repr(code_obj)) # dbg |
|
2508 | #rprint('Running code', repr(code_obj)) # dbg | |
2508 | exec code_obj in self.user_global_ns, self.user_ns |
|
2509 | exec code_obj in self.user_global_ns, self.user_ns | |
2509 | finally: |
|
2510 | finally: | |
2510 | # Reset our crash handler in place |
|
2511 | # Reset our crash handler in place | |
2511 | sys.excepthook = old_excepthook |
|
2512 | sys.excepthook = old_excepthook | |
2512 | except SystemExit: |
|
2513 | except SystemExit: | |
2513 | self.showtraceback(exception_only=True) |
|
2514 | self.showtraceback(exception_only=True) | |
2514 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1) |
|
2515 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1) | |
2515 | except self.custom_exceptions: |
|
2516 | except self.custom_exceptions: | |
2516 | etype,value,tb = sys.exc_info() |
|
2517 | etype,value,tb = sys.exc_info() | |
2517 | self.CustomTB(etype,value,tb) |
|
2518 | self.CustomTB(etype,value,tb) | |
2518 | except: |
|
2519 | except: | |
2519 | self.showtraceback() |
|
2520 | self.showtraceback() | |
2520 | else: |
|
2521 | else: | |
2521 | outflag = 0 |
|
2522 | outflag = 0 | |
2522 | if softspace(sys.stdout, 0): |
|
2523 | if softspace(sys.stdout, 0): | |
2523 |
|
2524 | |||
2524 |
|
2525 | |||
2525 | return outflag |
|
2526 | return outflag | |
2526 |
|
2527 | |||
2527 | # For backwards compatibility |
|
2528 | # For backwards compatibility | |
2528 | runcode = run_code |
|
2529 | runcode = run_code | |
2529 |
|
2530 | |||
2530 | #------------------------------------------------------------------------- |
|
2531 | #------------------------------------------------------------------------- | |
2531 | # Things related to GUI support and pylab |
|
2532 | # Things related to GUI support and pylab | |
2532 | #------------------------------------------------------------------------- |
|
2533 | #------------------------------------------------------------------------- | |
2533 |
|
2534 | |||
|
2535 | def enable_gui(self, gui=None): | |||
|
2536 | raise NotImplementedError('Implement enable_gui in a subclass') | |||
|
2537 | ||||
2534 | def enable_pylab(self, gui=None, import_all=True): |
|
2538 | def enable_pylab(self, gui=None, import_all=True): | |
2535 | raise NotImplementedError('Implement enable_pylab in a subclass') |
|
2539 | """Activate pylab support at runtime. | |
|
2540 | ||||
|
2541 | This turns on support for matplotlib, preloads into the interactive | |||
|
2542 | namespace all of numpy and pylab, and configures IPython to correctly | |||
|
2543 | interact with the GUI event loop. The GUI backend to be used can be | |||
|
2544 | optionally selected with the optional :param:`gui` argument. | |||
|
2545 | ||||
|
2546 | Parameters | |||
|
2547 | ---------- | |||
|
2548 | gui : optional, string | |||
|
2549 | ||||
|
2550 | If given, dictates the choice of matplotlib GUI backend to use | |||
|
2551 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', | |||
|
2552 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by | |||
|
2553 | matplotlib (as dictated by the matplotlib build-time options plus the | |||
|
2554 | user's matplotlibrc configuration file). Note that not all backends | |||
|
2555 | make sense in all contexts, for example a terminal ipython can't | |||
|
2556 | display figures inline. | |||
|
2557 | """ | |||
|
2558 | ||||
|
2559 | # We want to prevent the loading of pylab to pollute the user's | |||
|
2560 | # namespace as shown by the %who* magics, so we execute the activation | |||
|
2561 | # code in an empty namespace, and we update *both* user_ns and | |||
|
2562 | # user_ns_hidden with this information. | |||
|
2563 | ns = {} | |||
|
2564 | try: | |||
|
2565 | gui = pylab_activate(ns, gui, import_all, self) | |||
|
2566 | except KeyError: | |||
|
2567 | error("Backend %r not supported" % gui) | |||
|
2568 | return | |||
|
2569 | self.user_ns.update(ns) | |||
|
2570 | self.user_ns_hidden.update(ns) | |||
|
2571 | # Now we must activate the gui pylab wants to use, and fix %run to take | |||
|
2572 | # plot updates into account | |||
|
2573 | self.enable_gui(gui) | |||
|
2574 | self.magic_run = self._pylab_magic_run | |||
2536 |
|
2575 | |||
2537 | #------------------------------------------------------------------------- |
|
2576 | #------------------------------------------------------------------------- | |
2538 | # Utilities |
|
2577 | # Utilities | |
2539 | #------------------------------------------------------------------------- |
|
2578 | #------------------------------------------------------------------------- | |
2540 |
|
2579 | |||
2541 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
2580 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): | |
2542 | """Expand python variables in a string. |
|
2581 | """Expand python variables in a string. | |
2543 |
|
2582 | |||
2544 | The depth argument indicates how many frames above the caller should |
|
2583 | The depth argument indicates how many frames above the caller should | |
2545 | be walked to look for the local namespace where to expand variables. |
|
2584 | be walked to look for the local namespace where to expand variables. | |
2546 |
|
2585 | |||
2547 | The global namespace for expansion is always the user's interactive |
|
2586 | The global namespace for expansion is always the user's interactive | |
2548 | namespace. |
|
2587 | namespace. | |
2549 | """ |
|
2588 | """ | |
2550 | ns = self.user_ns.copy() |
|
2589 | ns = self.user_ns.copy() | |
2551 | ns.update(sys._getframe(depth+1).f_locals) |
|
2590 | ns.update(sys._getframe(depth+1).f_locals) | |
2552 | ns.pop('self', None) |
|
2591 | ns.pop('self', None) | |
2553 | return formatter.format(cmd, **ns) |
|
2592 | return formatter.format(cmd, **ns) | |
2554 |
|
2593 | |||
2555 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
2594 | def mktempfile(self, data=None, prefix='ipython_edit_'): | |
2556 | """Make a new tempfile and return its filename. |
|
2595 | """Make a new tempfile and return its filename. | |
2557 |
|
2596 | |||
2558 | This makes a call to tempfile.mktemp, but it registers the created |
|
2597 | This makes a call to tempfile.mktemp, but it registers the created | |
2559 | filename internally so ipython cleans it up at exit time. |
|
2598 | filename internally so ipython cleans it up at exit time. | |
2560 |
|
2599 | |||
2561 | Optional inputs: |
|
2600 | Optional inputs: | |
2562 |
|
2601 | |||
2563 | - data(None): if data is given, it gets written out to the temp file |
|
2602 | - data(None): if data is given, it gets written out to the temp file | |
2564 | immediately, and the file is closed again.""" |
|
2603 | immediately, and the file is closed again.""" | |
2565 |
|
2604 | |||
2566 | filename = tempfile.mktemp('.py', prefix) |
|
2605 | filename = tempfile.mktemp('.py', prefix) | |
2567 | self.tempfiles.append(filename) |
|
2606 | self.tempfiles.append(filename) | |
2568 |
|
2607 | |||
2569 | if data: |
|
2608 | if data: | |
2570 | tmp_file = open(filename,'w') |
|
2609 | tmp_file = open(filename,'w') | |
2571 | tmp_file.write(data) |
|
2610 | tmp_file.write(data) | |
2572 | tmp_file.close() |
|
2611 | tmp_file.close() | |
2573 | return filename |
|
2612 | return filename | |
2574 |
|
2613 | |||
2575 | # TODO: This should be removed when Term is refactored. |
|
2614 | # TODO: This should be removed when Term is refactored. | |
2576 | def write(self,data): |
|
2615 | def write(self,data): | |
2577 | """Write a string to the default output""" |
|
2616 | """Write a string to the default output""" | |
2578 | io.stdout.write(data) |
|
2617 | io.stdout.write(data) | |
2579 |
|
2618 | |||
2580 | # TODO: This should be removed when Term is refactored. |
|
2619 | # TODO: This should be removed when Term is refactored. | |
2581 | def write_err(self,data): |
|
2620 | def write_err(self,data): | |
2582 | """Write a string to the default error output""" |
|
2621 | """Write a string to the default error output""" | |
2583 | io.stderr.write(data) |
|
2622 | io.stderr.write(data) | |
2584 |
|
2623 | |||
2585 | def ask_yes_no(self, prompt, default=None): |
|
2624 | def ask_yes_no(self, prompt, default=None): | |
2586 | if self.quiet: |
|
2625 | if self.quiet: | |
2587 | return True |
|
2626 | return True | |
2588 | return ask_yes_no(prompt,default) |
|
2627 | return ask_yes_no(prompt,default) | |
2589 |
|
2628 | |||
2590 | def show_usage(self): |
|
2629 | def show_usage(self): | |
2591 | """Show a usage message""" |
|
2630 | """Show a usage message""" | |
2592 | page.page(IPython.core.usage.interactive_usage) |
|
2631 | page.page(IPython.core.usage.interactive_usage) | |
2593 |
|
2632 | |||
2594 | def find_user_code(self, target, raw=True): |
|
2633 | def find_user_code(self, target, raw=True): | |
2595 | """Get a code string from history, file, or a string or macro. |
|
2634 | """Get a code string from history, file, or a string or macro. | |
2596 |
|
2635 | |||
2597 | This is mainly used by magic functions. |
|
2636 | This is mainly used by magic functions. | |
2598 |
|
2637 | |||
2599 | Parameters |
|
2638 | Parameters | |
2600 | ---------- |
|
2639 | ---------- | |
2601 | target : str |
|
2640 | target : str | |
2602 | A string specifying code to retrieve. This will be tried respectively |
|
2641 | A string specifying code to retrieve. This will be tried respectively | |
2603 | as: ranges of input history (see %history for syntax), a filename, or |
|
2642 | as: ranges of input history (see %history for syntax), a filename, or | |
2604 | an expression evaluating to a string or Macro in the user namespace. |
|
2643 | an expression evaluating to a string or Macro in the user namespace. | |
2605 | raw : bool |
|
2644 | raw : bool | |
2606 | If true (default), retrieve raw history. Has no effect on the other |
|
2645 | If true (default), retrieve raw history. Has no effect on the other | |
2607 | retrieval mechanisms. |
|
2646 | retrieval mechanisms. | |
2608 |
|
2647 | |||
2609 | Returns |
|
2648 | Returns | |
2610 | ------- |
|
2649 | ------- | |
2611 | A string of code. |
|
2650 | A string of code. | |
2612 |
|
2651 | |||
2613 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
2652 | ValueError is raised if nothing is found, and TypeError if it evaluates | |
2614 | to an object of another type. In each case, .args[0] is a printable |
|
2653 | to an object of another type. In each case, .args[0] is a printable | |
2615 | message. |
|
2654 | message. | |
2616 | """ |
|
2655 | """ | |
2617 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
2656 | code = self.extract_input_lines(target, raw=raw) # Grab history | |
2618 | if code: |
|
2657 | if code: | |
2619 | return code |
|
2658 | return code | |
2620 | if os.path.isfile(target): # Read file |
|
2659 | if os.path.isfile(target): # Read file | |
2621 | return open(target, "r").read() |
|
2660 | return open(target, "r").read() | |
2622 |
|
2661 | |||
2623 | try: # User namespace |
|
2662 | try: # User namespace | |
2624 | codeobj = eval(target, self.user_ns) |
|
2663 | codeobj = eval(target, self.user_ns) | |
2625 | except Exception: |
|
2664 | except Exception: | |
2626 | raise ValueError(("'%s' was not found in history, as a file, nor in" |
|
2665 | raise ValueError(("'%s' was not found in history, as a file, nor in" | |
2627 | " the user namespace.") % target) |
|
2666 | " the user namespace.") % target) | |
2628 | if isinstance(codeobj, basestring): |
|
2667 | if isinstance(codeobj, basestring): | |
2629 | return codeobj |
|
2668 | return codeobj | |
2630 | elif isinstance(codeobj, Macro): |
|
2669 | elif isinstance(codeobj, Macro): | |
2631 | return codeobj.value |
|
2670 | return codeobj.value | |
2632 |
|
2671 | |||
2633 | raise TypeError("%s is neither a string nor a macro." % target, |
|
2672 | raise TypeError("%s is neither a string nor a macro." % target, | |
2634 | codeobj) |
|
2673 | codeobj) | |
2635 |
|
2674 | |||
2636 | #------------------------------------------------------------------------- |
|
2675 | #------------------------------------------------------------------------- | |
2637 | # Things related to IPython exiting |
|
2676 | # Things related to IPython exiting | |
2638 | #------------------------------------------------------------------------- |
|
2677 | #------------------------------------------------------------------------- | |
2639 | def atexit_operations(self): |
|
2678 | def atexit_operations(self): | |
2640 | """This will be executed at the time of exit. |
|
2679 | """This will be executed at the time of exit. | |
2641 |
|
2680 | |||
2642 | Cleanup operations and saving of persistent data that is done |
|
2681 | Cleanup operations and saving of persistent data that is done | |
2643 | unconditionally by IPython should be performed here. |
|
2682 | unconditionally by IPython should be performed here. | |
2644 |
|
2683 | |||
2645 | For things that may depend on startup flags or platform specifics (such |
|
2684 | For things that may depend on startup flags or platform specifics (such | |
2646 | as having readline or not), register a separate atexit function in the |
|
2685 | as having readline or not), register a separate atexit function in the | |
2647 | code that has the appropriate information, rather than trying to |
|
2686 | code that has the appropriate information, rather than trying to | |
2648 | clutter |
|
2687 | clutter | |
2649 | """ |
|
2688 | """ | |
2650 | # Close the history session (this stores the end time and line count) |
|
2689 | # Close the history session (this stores the end time and line count) | |
2651 | # this must be *before* the tempfile cleanup, in case of temporary |
|
2690 | # this must be *before* the tempfile cleanup, in case of temporary | |
2652 | # history db |
|
2691 | # history db | |
2653 | self.history_manager.end_session() |
|
2692 | self.history_manager.end_session() | |
2654 |
|
2693 | |||
2655 | # Cleanup all tempfiles left around |
|
2694 | # Cleanup all tempfiles left around | |
2656 | for tfile in self.tempfiles: |
|
2695 | for tfile in self.tempfiles: | |
2657 | try: |
|
2696 | try: | |
2658 | os.unlink(tfile) |
|
2697 | os.unlink(tfile) | |
2659 | except OSError: |
|
2698 | except OSError: | |
2660 | pass |
|
2699 | pass | |
2661 |
|
2700 | |||
2662 | # Clear all user namespaces to release all references cleanly. |
|
2701 | # Clear all user namespaces to release all references cleanly. | |
2663 | self.reset(new_session=False) |
|
2702 | self.reset(new_session=False) | |
2664 |
|
2703 | |||
2665 | # Run user hooks |
|
2704 | # Run user hooks | |
2666 | self.hooks.shutdown_hook() |
|
2705 | self.hooks.shutdown_hook() | |
2667 |
|
2706 | |||
2668 | def cleanup(self): |
|
2707 | def cleanup(self): | |
2669 | self.restore_sys_module_state() |
|
2708 | self.restore_sys_module_state() | |
2670 |
|
2709 | |||
2671 |
|
2710 | |||
2672 | class InteractiveShellABC(object): |
|
2711 | class InteractiveShellABC(object): | |
2673 | """An abstract base class for InteractiveShell.""" |
|
2712 | """An abstract base class for InteractiveShell.""" | |
2674 | __metaclass__ = abc.ABCMeta |
|
2713 | __metaclass__ = abc.ABCMeta | |
2675 |
|
2714 | |||
2676 | InteractiveShellABC.register(InteractiveShell) |
|
2715 | InteractiveShellABC.register(InteractiveShell) |
1 | NO CONTENT: modified file |
|
NO CONTENT: modified file | ||
The requested commit or file is too big and content was truncated. Show full diff |
@@ -1,330 +1,335 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Pylab (matplotlib) support utilities. |
|
2 | """Pylab (matplotlib) support utilities. | |
3 |
|
3 | |||
4 | Authors |
|
4 | Authors | |
5 | ------- |
|
5 | ------- | |
6 |
|
6 | |||
7 | * Fernando Perez. |
|
7 | * Fernando Perez. | |
8 | * Brian Granger |
|
8 | * Brian Granger | |
9 | """ |
|
9 | """ | |
10 |
|
10 | |||
11 | #----------------------------------------------------------------------------- |
|
11 | #----------------------------------------------------------------------------- | |
12 | # Copyright (C) 2009-2011 The IPython Development Team |
|
12 | # Copyright (C) 2009-2011 The IPython Development Team | |
13 | # |
|
13 | # | |
14 | # Distributed under the terms of the BSD License. The full license is in |
|
14 | # Distributed under the terms of the BSD License. The full license is in | |
15 | # the file COPYING, distributed as part of this software. |
|
15 | # the file COPYING, distributed as part of this software. | |
16 | #----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
17 |
|
17 | |||
18 | #----------------------------------------------------------------------------- |
|
18 | #----------------------------------------------------------------------------- | |
19 | # Imports |
|
19 | # Imports | |
20 | #----------------------------------------------------------------------------- |
|
20 | #----------------------------------------------------------------------------- | |
21 |
|
21 | |||
22 | import sys |
|
22 | import sys | |
23 | from io import BytesIO |
|
23 | from io import BytesIO | |
24 |
|
24 | |||
25 | from IPython.utils.decorators import flag_calls |
|
25 | from IPython.utils.decorators import flag_calls | |
26 |
|
26 | |||
27 | # If user specifies a GUI, that dictates the backend, otherwise we read the |
|
27 | # If user specifies a GUI, that dictates the backend, otherwise we read the | |
28 | # user's mpl default from the mpl rc structure |
|
28 | # user's mpl default from the mpl rc structure | |
29 | backends = {'tk': 'TkAgg', |
|
29 | backends = {'tk': 'TkAgg', | |
30 | 'gtk': 'GTKAgg', |
|
30 | 'gtk': 'GTKAgg', | |
31 | 'wx': 'WXAgg', |
|
31 | 'wx': 'WXAgg', | |
32 | 'qt': 'Qt4Agg', # qt3 not supported |
|
32 | 'qt': 'Qt4Agg', # qt3 not supported | |
33 | 'qt4': 'Qt4Agg', |
|
33 | 'qt4': 'Qt4Agg', | |
34 | 'osx': 'MacOSX', |
|
34 | 'osx': 'MacOSX', | |
35 | 'inline' : 'module://IPython.zmq.pylab.backend_inline'} |
|
35 | 'inline' : 'module://IPython.zmq.pylab.backend_inline'} | |
36 |
|
36 | |||
37 | # We also need a reverse backends2guis mapping that will properly choose which |
|
37 | # We also need a reverse backends2guis mapping that will properly choose which | |
38 | # GUI support to activate based on the desired matplotlib backend. For the |
|
38 | # GUI support to activate based on the desired matplotlib backend. For the | |
39 | # most part it's just a reverse of the above dict, but we also need to add a |
|
39 | # most part it's just a reverse of the above dict, but we also need to add a | |
40 | # few others that map to the same GUI manually: |
|
40 | # few others that map to the same GUI manually: | |
41 | backend2gui = dict(zip(backends.values(), backends.keys())) |
|
41 | backend2gui = dict(zip(backends.values(), backends.keys())) | |
42 | # In the reverse mapping, there are a few extra valid matplotlib backends that |
|
42 | # In the reverse mapping, there are a few extra valid matplotlib backends that | |
43 | # map to the same GUI support |
|
43 | # map to the same GUI support | |
44 | backend2gui['GTK'] = backend2gui['GTKCairo'] = 'gtk' |
|
44 | backend2gui['GTK'] = backend2gui['GTKCairo'] = 'gtk' | |
45 | backend2gui['WX'] = 'wx' |
|
45 | backend2gui['WX'] = 'wx' | |
46 | backend2gui['CocoaAgg'] = 'osx' |
|
46 | backend2gui['CocoaAgg'] = 'osx' | |
47 |
|
47 | |||
48 | #----------------------------------------------------------------------------- |
|
48 | #----------------------------------------------------------------------------- | |
49 | # Matplotlib utilities |
|
49 | # Matplotlib utilities | |
50 | #----------------------------------------------------------------------------- |
|
50 | #----------------------------------------------------------------------------- | |
51 |
|
51 | |||
52 |
|
52 | |||
53 | def getfigs(*fig_nums): |
|
53 | def getfigs(*fig_nums): | |
54 | """Get a list of matplotlib figures by figure numbers. |
|
54 | """Get a list of matplotlib figures by figure numbers. | |
55 |
|
55 | |||
56 | If no arguments are given, all available figures are returned. If the |
|
56 | If no arguments are given, all available figures are returned. If the | |
57 | argument list contains references to invalid figures, a warning is printed |
|
57 | argument list contains references to invalid figures, a warning is printed | |
58 | but the function continues pasting further figures. |
|
58 | but the function continues pasting further figures. | |
59 |
|
59 | |||
60 | Parameters |
|
60 | Parameters | |
61 | ---------- |
|
61 | ---------- | |
62 | figs : tuple |
|
62 | figs : tuple | |
63 | A tuple of ints giving the figure numbers of the figures to return. |
|
63 | A tuple of ints giving the figure numbers of the figures to return. | |
64 | """ |
|
64 | """ | |
65 | from matplotlib._pylab_helpers import Gcf |
|
65 | from matplotlib._pylab_helpers import Gcf | |
66 | if not fig_nums: |
|
66 | if not fig_nums: | |
67 | fig_managers = Gcf.get_all_fig_managers() |
|
67 | fig_managers = Gcf.get_all_fig_managers() | |
68 | return [fm.canvas.figure for fm in fig_managers] |
|
68 | return [fm.canvas.figure for fm in fig_managers] | |
69 | else: |
|
69 | else: | |
70 | figs = [] |
|
70 | figs = [] | |
71 | for num in fig_nums: |
|
71 | for num in fig_nums: | |
72 | f = Gcf.figs.get(num) |
|
72 | f = Gcf.figs.get(num) | |
73 | if f is None: |
|
73 | if f is None: | |
74 | print('Warning: figure %s not available.' % num) |
|
74 | print('Warning: figure %s not available.' % num) | |
75 | else: |
|
75 | else: | |
76 | figs.append(f.canvas.figure) |
|
76 | figs.append(f.canvas.figure) | |
77 | return figs |
|
77 | return figs | |
78 |
|
78 | |||
79 |
|
79 | |||
80 | def figsize(sizex, sizey): |
|
80 | def figsize(sizex, sizey): | |
81 | """Set the default figure size to be [sizex, sizey]. |
|
81 | """Set the default figure size to be [sizex, sizey]. | |
82 |
|
82 | |||
83 | This is just an easy to remember, convenience wrapper that sets:: |
|
83 | This is just an easy to remember, convenience wrapper that sets:: | |
84 |
|
84 | |||
85 | matplotlib.rcParams['figure.figsize'] = [sizex, sizey] |
|
85 | matplotlib.rcParams['figure.figsize'] = [sizex, sizey] | |
86 | """ |
|
86 | """ | |
87 | import matplotlib |
|
87 | import matplotlib | |
88 | matplotlib.rcParams['figure.figsize'] = [sizex, sizey] |
|
88 | matplotlib.rcParams['figure.figsize'] = [sizex, sizey] | |
89 |
|
89 | |||
90 |
|
90 | |||
91 | def print_figure(fig, fmt='png'): |
|
91 | def print_figure(fig, fmt='png'): | |
92 | """Convert a figure to svg or png for inline display.""" |
|
92 | """Convert a figure to svg or png for inline display.""" | |
93 | # When there's an empty figure, we shouldn't return anything, otherwise we |
|
93 | # When there's an empty figure, we shouldn't return anything, otherwise we | |
94 | # get big blank areas in the qt console. |
|
94 | # get big blank areas in the qt console. | |
95 | if not fig.axes: |
|
95 | if not fig.axes: | |
96 | return |
|
96 | return | |
97 |
|
97 | |||
98 | fc = fig.get_facecolor() |
|
98 | fc = fig.get_facecolor() | |
99 | ec = fig.get_edgecolor() |
|
99 | ec = fig.get_edgecolor() | |
100 | fig.set_facecolor('white') |
|
100 | fig.set_facecolor('white') | |
101 | fig.set_edgecolor('white') |
|
101 | fig.set_edgecolor('white') | |
102 | try: |
|
102 | try: | |
103 | bytes_io = BytesIO() |
|
103 | bytes_io = BytesIO() | |
104 | fig.canvas.print_figure(bytes_io, format=fmt, bbox_inches='tight') |
|
104 | fig.canvas.print_figure(bytes_io, format=fmt, bbox_inches='tight') | |
105 | data = bytes_io.getvalue() |
|
105 | data = bytes_io.getvalue() | |
106 | finally: |
|
106 | finally: | |
107 | fig.set_facecolor(fc) |
|
107 | fig.set_facecolor(fc) | |
108 | fig.set_edgecolor(ec) |
|
108 | fig.set_edgecolor(ec) | |
109 | return data |
|
109 | return data | |
110 |
|
110 | |||
111 |
|
111 | |||
112 | # We need a little factory function here to create the closure where |
|
112 | # We need a little factory function here to create the closure where | |
113 | # safe_execfile can live. |
|
113 | # safe_execfile can live. | |
114 | def mpl_runner(safe_execfile): |
|
114 | def mpl_runner(safe_execfile): | |
115 | """Factory to return a matplotlib-enabled runner for %run. |
|
115 | """Factory to return a matplotlib-enabled runner for %run. | |
116 |
|
116 | |||
117 | Parameters |
|
117 | Parameters | |
118 | ---------- |
|
118 | ---------- | |
119 | safe_execfile : function |
|
119 | safe_execfile : function | |
120 | This must be a function with the same interface as the |
|
120 | This must be a function with the same interface as the | |
121 | :meth:`safe_execfile` method of IPython. |
|
121 | :meth:`safe_execfile` method of IPython. | |
122 |
|
122 | |||
123 | Returns |
|
123 | Returns | |
124 | ------- |
|
124 | ------- | |
125 | A function suitable for use as the ``runner`` argument of the %run magic |
|
125 | A function suitable for use as the ``runner`` argument of the %run magic | |
126 | function. |
|
126 | function. | |
127 | """ |
|
127 | """ | |
128 |
|
128 | |||
129 | def mpl_execfile(fname,*where,**kw): |
|
129 | def mpl_execfile(fname,*where,**kw): | |
130 | """matplotlib-aware wrapper around safe_execfile. |
|
130 | """matplotlib-aware wrapper around safe_execfile. | |
131 |
|
131 | |||
132 | Its interface is identical to that of the :func:`execfile` builtin. |
|
132 | Its interface is identical to that of the :func:`execfile` builtin. | |
133 |
|
133 | |||
134 | This is ultimately a call to execfile(), but wrapped in safeties to |
|
134 | This is ultimately a call to execfile(), but wrapped in safeties to | |
135 | properly handle interactive rendering.""" |
|
135 | properly handle interactive rendering.""" | |
136 |
|
136 | |||
137 | import matplotlib |
|
137 | import matplotlib | |
138 | import matplotlib.pylab as pylab |
|
138 | import matplotlib.pylab as pylab | |
139 |
|
139 | |||
140 | #print '*** Matplotlib runner ***' # dbg |
|
140 | #print '*** Matplotlib runner ***' # dbg | |
141 | # turn off rendering until end of script |
|
141 | # turn off rendering until end of script | |
142 | is_interactive = matplotlib.rcParams['interactive'] |
|
142 | is_interactive = matplotlib.rcParams['interactive'] | |
143 | matplotlib.interactive(False) |
|
143 | matplotlib.interactive(False) | |
144 | safe_execfile(fname,*where,**kw) |
|
144 | safe_execfile(fname,*where,**kw) | |
145 | matplotlib.interactive(is_interactive) |
|
145 | matplotlib.interactive(is_interactive) | |
146 | # make rendering call now, if the user tried to do it |
|
146 | # make rendering call now, if the user tried to do it | |
147 | if pylab.draw_if_interactive.called: |
|
147 | if pylab.draw_if_interactive.called: | |
148 | pylab.draw() |
|
148 | pylab.draw() | |
149 | pylab.draw_if_interactive.called = False |
|
149 | pylab.draw_if_interactive.called = False | |
150 |
|
150 | |||
151 | return mpl_execfile |
|
151 | return mpl_execfile | |
152 |
|
152 | |||
153 |
|
153 | |||
154 | def select_figure_format(shell, fmt): |
|
154 | def select_figure_format(shell, fmt): | |
155 | """Select figure format for inline backend, either 'png' or 'svg'. |
|
155 | """Select figure format for inline backend, either 'png' or 'svg'. | |
156 |
|
156 | |||
157 | Using this method ensures only one figure format is active at a time. |
|
157 | Using this method ensures only one figure format is active at a time. | |
158 | """ |
|
158 | """ | |
159 | from matplotlib.figure import Figure |
|
159 | from matplotlib.figure import Figure | |
160 | from IPython.zmq.pylab import backend_inline |
|
160 | from IPython.zmq.pylab import backend_inline | |
161 |
|
161 | |||
162 | svg_formatter = shell.display_formatter.formatters['image/svg+xml'] |
|
162 | svg_formatter = shell.display_formatter.formatters['image/svg+xml'] | |
163 | png_formatter = shell.display_formatter.formatters['image/png'] |
|
163 | png_formatter = shell.display_formatter.formatters['image/png'] | |
164 |
|
164 | |||
165 | if fmt=='png': |
|
165 | if fmt=='png': | |
166 | svg_formatter.type_printers.pop(Figure, None) |
|
166 | svg_formatter.type_printers.pop(Figure, None) | |
167 | png_formatter.for_type(Figure, lambda fig: print_figure(fig, 'png')) |
|
167 | png_formatter.for_type(Figure, lambda fig: print_figure(fig, 'png')) | |
168 | elif fmt=='svg': |
|
168 | elif fmt=='svg': | |
169 | png_formatter.type_printers.pop(Figure, None) |
|
169 | png_formatter.type_printers.pop(Figure, None) | |
170 | svg_formatter.for_type(Figure, lambda fig: print_figure(fig, 'svg')) |
|
170 | svg_formatter.for_type(Figure, lambda fig: print_figure(fig, 'svg')) | |
171 | else: |
|
171 | else: | |
172 | raise ValueError("supported formats are: 'png', 'svg', not %r"%fmt) |
|
172 | raise ValueError("supported formats are: 'png', 'svg', not %r"%fmt) | |
173 |
|
173 | |||
174 | # set the format to be used in the backend() |
|
174 | # set the format to be used in the backend() | |
175 | backend_inline._figure_format = fmt |
|
175 | backend_inline._figure_format = fmt | |
176 |
|
176 | |||
177 | #----------------------------------------------------------------------------- |
|
177 | #----------------------------------------------------------------------------- | |
178 | # Code for initializing matplotlib and importing pylab |
|
178 | # Code for initializing matplotlib and importing pylab | |
179 | #----------------------------------------------------------------------------- |
|
179 | #----------------------------------------------------------------------------- | |
180 |
|
180 | |||
181 |
|
181 | |||
182 | def find_gui_and_backend(gui=None): |
|
182 | def find_gui_and_backend(gui=None): | |
183 | """Given a gui string return the gui and mpl backend. |
|
183 | """Given a gui string return the gui and mpl backend. | |
184 |
|
184 | |||
185 | Parameters |
|
185 | Parameters | |
186 | ---------- |
|
186 | ---------- | |
187 | gui : str |
|
187 | gui : str | |
188 | Can be one of ('tk','gtk','wx','qt','qt4','inline'). |
|
188 | Can be one of ('tk','gtk','wx','qt','qt4','inline'). | |
189 |
|
189 | |||
190 | Returns |
|
190 | Returns | |
191 | ------- |
|
191 | ------- | |
192 | A tuple of (gui, backend) where backend is one of ('TkAgg','GTKAgg', |
|
192 | A tuple of (gui, backend) where backend is one of ('TkAgg','GTKAgg', | |
193 | 'WXAgg','Qt4Agg','module://IPython.zmq.pylab.backend_inline'). |
|
193 | 'WXAgg','Qt4Agg','module://IPython.zmq.pylab.backend_inline'). | |
194 | """ |
|
194 | """ | |
195 |
|
195 | |||
196 | import matplotlib |
|
196 | import matplotlib | |
197 |
|
197 | |||
198 | if gui and gui != 'auto': |
|
198 | if gui and gui != 'auto': | |
199 | # select backend based on requested gui |
|
199 | # select backend based on requested gui | |
200 | backend = backends[gui] |
|
200 | backend = backends[gui] | |
201 | else: |
|
201 | else: | |
202 | backend = matplotlib.rcParams['backend'] |
|
202 | backend = matplotlib.rcParams['backend'] | |
203 | # In this case, we need to find what the appropriate gui selection call |
|
203 | # In this case, we need to find what the appropriate gui selection call | |
204 | # should be for IPython, so we can activate inputhook accordingly |
|
204 | # should be for IPython, so we can activate inputhook accordingly | |
205 | gui = backend2gui.get(backend, None) |
|
205 | gui = backend2gui.get(backend, None) | |
206 | return gui, backend |
|
206 | return gui, backend | |
207 |
|
207 | |||
208 |
|
208 | |||
209 | def activate_matplotlib(backend): |
|
209 | def activate_matplotlib(backend): | |
210 | """Activate the given backend and set interactive to True.""" |
|
210 | """Activate the given backend and set interactive to True.""" | |
211 |
|
211 | |||
212 | import matplotlib |
|
212 | import matplotlib | |
213 | if backend.startswith('module://'): |
|
213 | if backend.startswith('module://'): | |
214 | # Work around bug in matplotlib: matplotlib.use converts the |
|
214 | # Work around bug in matplotlib: matplotlib.use converts the | |
215 | # backend_id to lowercase even if a module name is specified! |
|
215 | # backend_id to lowercase even if a module name is specified! | |
216 | matplotlib.rcParams['backend'] = backend |
|
216 | matplotlib.rcParams['backend'] = backend | |
217 | else: |
|
217 | else: | |
218 | matplotlib.use(backend) |
|
218 | matplotlib.use(backend) | |
219 | matplotlib.interactive(True) |
|
219 | matplotlib.interactive(True) | |
220 |
|
220 | |||
221 | # This must be imported last in the matplotlib series, after |
|
221 | # This must be imported last in the matplotlib series, after | |
222 | # backend/interactivity choices have been made |
|
222 | # backend/interactivity choices have been made | |
223 | import matplotlib.pylab as pylab |
|
223 | import matplotlib.pylab as pylab | |
224 |
|
224 | |||
225 | # XXX For now leave this commented out, but depending on discussions with |
|
225 | # XXX For now leave this commented out, but depending on discussions with | |
226 | # mpl-dev, we may be able to allow interactive switching... |
|
226 | # mpl-dev, we may be able to allow interactive switching... | |
227 | #import matplotlib.pyplot |
|
227 | #import matplotlib.pyplot | |
228 | #matplotlib.pyplot.switch_backend(backend) |
|
228 | #matplotlib.pyplot.switch_backend(backend) | |
229 |
|
229 | |||
230 | pylab.show._needmain = False |
|
230 | pylab.show._needmain = False | |
231 | # We need to detect at runtime whether show() is called by the user. |
|
231 | # We need to detect at runtime whether show() is called by the user. | |
232 | # For this, we wrap it into a decorator which adds a 'called' flag. |
|
232 | # For this, we wrap it into a decorator which adds a 'called' flag. | |
233 | pylab.draw_if_interactive = flag_calls(pylab.draw_if_interactive) |
|
233 | pylab.draw_if_interactive = flag_calls(pylab.draw_if_interactive) | |
234 |
|
234 | |||
235 | def import_pylab(user_ns, backend, import_all=True, shell=None): |
|
235 | ||
|
236 | def import_pylab(user_ns, import_all=True): | |||
236 | """Import the standard pylab symbols into user_ns.""" |
|
237 | """Import the standard pylab symbols into user_ns.""" | |
237 |
|
238 | |||
238 | # Import numpy as np/pyplot as plt are conventions we're trying to |
|
239 | # Import numpy as np/pyplot as plt are conventions we're trying to | |
239 | # somewhat standardize on. Making them available to users by default |
|
240 | # somewhat standardize on. Making them available to users by default | |
240 | # will greatly help this. |
|
241 | # will greatly help this. | |
241 | s = ("import numpy\n" |
|
242 | s = ("import numpy\n" | |
242 | "import matplotlib\n" |
|
243 | "import matplotlib\n" | |
243 | "from matplotlib import pylab, mlab, pyplot\n" |
|
244 | "from matplotlib import pylab, mlab, pyplot\n" | |
244 | "np = numpy\n" |
|
245 | "np = numpy\n" | |
245 | "plt = pyplot\n" |
|
246 | "plt = pyplot\n" | |
246 | ) |
|
247 | ) | |
247 | exec s in user_ns |
|
248 | exec s in user_ns | |
248 |
|
249 | |||
249 | if shell is not None: |
|
|||
250 | # All local executions are done in a fresh namespace and we then update |
|
|||
251 | # the set of 'hidden' keys so these variables don't show up in %who |
|
|||
252 | # (which is meant to show only what the user has manually defined). |
|
|||
253 | ns = {} |
|
|||
254 | exec s in ns |
|
|||
255 | # If using our svg payload backend, register the post-execution |
|
|||
256 | # function that will pick up the results for display. This can only be |
|
|||
257 | # done with access to the real shell object. |
|
|||
258 | # |
|
|||
259 | from IPython.zmq.pylab.backend_inline import InlineBackend |
|
|||
260 |
|
||||
261 | cfg = InlineBackend.instance(config=shell.config) |
|
|||
262 | cfg.shell = shell |
|
|||
263 | if cfg not in shell.configurables: |
|
|||
264 | shell.configurables.append(cfg) |
|
|||
265 |
|
||||
266 | if backend == backends['inline']: |
|
|||
267 | from IPython.zmq.pylab.backend_inline import flush_figures |
|
|||
268 | from matplotlib import pyplot |
|
|||
269 | shell.register_post_execute(flush_figures) |
|
|||
270 | # load inline_rc |
|
|||
271 | pyplot.rcParams.update(cfg.rc) |
|
|||
272 |
|
||||
273 | # Add 'figsize' to pyplot and to the user's namespace |
|
|||
274 | user_ns['figsize'] = pyplot.figsize = figsize |
|
|||
275 | ns['figsize'] = figsize |
|
|||
276 |
|
||||
277 | # Setup the default figure format |
|
|||
278 | fmt = cfg.figure_format |
|
|||
279 | select_figure_format(shell, fmt) |
|
|||
280 |
|
||||
281 | # The old pastefig function has been replaced by display |
|
|||
282 | from IPython.core.display import display |
|
|||
283 | # Add display and display_png to the user's namespace |
|
|||
284 | ns['display'] = user_ns['display'] = display |
|
|||
285 | ns['getfigs'] = user_ns['getfigs'] = getfigs |
|
|||
286 |
|
||||
287 | if import_all: |
|
250 | if import_all: | |
288 | s = ("from matplotlib.pylab import *\n" |
|
251 | s = ("from matplotlib.pylab import *\n" | |
289 | "from numpy import *\n") |
|
252 | "from numpy import *\n") | |
290 | exec s in user_ns |
|
253 | exec s in user_ns | |
291 | if shell is not None: |
|
|||
292 | exec s in ns |
|
|||
293 |
|
254 | |||
294 | # Update the set of hidden variables with anything we've done here. |
|
255 | ||
295 | shell.user_ns_hidden.update(ns) |
|
256 | def configure_shell(shell, backend, user_ns=None): | |
|
257 | """Configure an IPython shell object for matplotlib use. | |||
|
258 | ||||
|
259 | Parameters | |||
|
260 | ---------- | |||
|
261 | shell : InteractiveShell instance | |||
|
262 | If None, this function returns immediately. | |||
|
263 | ||||
|
264 | user_ns : dict | |||
|
265 | A namespace where all configured variables will be placed. If not given, | |||
|
266 | the `user_ns` attribute of the shell object is used. | |||
|
267 | """ | |||
|
268 | if shell is None: | |||
|
269 | return | |||
|
270 | ||||
|
271 | user_ns = shell.user_ns if user_ns is None else user_ns | |||
|
272 | ||||
|
273 | # If using our svg payload backend, register the post-execution | |||
|
274 | # function that will pick up the results for display. This can only be | |||
|
275 | # done with access to the real shell object. | |||
|
276 | from IPython.zmq.pylab.backend_inline import InlineBackend | |||
|
277 | ||||
|
278 | cfg = InlineBackend.instance(config=shell.config) | |||
|
279 | cfg.shell = shell | |||
|
280 | if cfg not in shell.configurables: | |||
|
281 | shell.configurables.append(cfg) | |||
|
282 | ||||
|
283 | if backend == backends['inline']: | |||
|
284 | from IPython.zmq.pylab.backend_inline import flush_figures | |||
|
285 | from matplotlib import pyplot | |||
|
286 | shell.register_post_execute(flush_figures) | |||
|
287 | # load inline_rc | |||
|
288 | pyplot.rcParams.update(cfg.rc) | |||
|
289 | # Add 'figsize' to pyplot and to the user's namespace | |||
|
290 | user_ns['figsize'] = pyplot.figsize = figsize | |||
|
291 | ||||
|
292 | # Setup the default figure format | |||
|
293 | fmt = cfg.figure_format | |||
|
294 | select_figure_format(shell, fmt) | |||
|
295 | ||||
|
296 | # The old pastefig function has been replaced by display | |||
|
297 | from IPython.core.display import display | |||
|
298 | # Add display and getfigs to the user's namespace | |||
|
299 | user_ns['display'] = display | |||
|
300 | user_ns['getfigs'] = getfigs | |||
296 |
|
301 | |||
297 |
|
302 | |||
298 | def pylab_activate(user_ns, gui=None, import_all=True, shell=None): |
|
303 | def pylab_activate(user_ns, gui=None, import_all=True, shell=None): | |
299 | """Activate pylab mode in the user's namespace. |
|
304 | """Activate pylab mode in the user's namespace. | |
300 |
|
305 | |||
301 | Loads and initializes numpy, matplotlib and friends for interactive use. |
|
306 | Loads and initializes numpy, matplotlib and friends for interactive use. | |
302 |
|
307 | |||
303 | Parameters |
|
308 | Parameters | |
304 | ---------- |
|
309 | ---------- | |
305 | user_ns : dict |
|
310 | user_ns : dict | |
306 | Namespace where the imports will occur. |
|
311 | Namespace where the imports will occur. | |
307 |
|
312 | |||
308 | gui : optional, string |
|
313 | gui : optional, string | |
309 | A valid gui name following the conventions of the %gui magic. |
|
314 | A valid gui name following the conventions of the %gui magic. | |
310 |
|
315 | |||
311 | import_all : optional, boolean |
|
316 | import_all : optional, boolean | |
312 | If true, an 'import *' is done from numpy and pylab. |
|
317 | If true, an 'import *' is done from numpy and pylab. | |
313 |
|
318 | |||
314 | Returns |
|
319 | Returns | |
315 | ------- |
|
320 | ------- | |
316 | The actual gui used (if not given as input, it was obtained from matplotlib |
|
321 | The actual gui used (if not given as input, it was obtained from matplotlib | |
317 | itself, and will be needed next to configure IPython's gui integration. |
|
322 | itself, and will be needed next to configure IPython's gui integration. | |
318 | """ |
|
323 | """ | |
319 | gui, backend = find_gui_and_backend(gui) |
|
324 | gui, backend = find_gui_and_backend(gui) | |
320 | activate_matplotlib(backend) |
|
325 | activate_matplotlib(backend) | |
321 |
import_pylab(user_ns, |
|
326 | import_pylab(user_ns, import_all) | |
322 |
|
327 | configure_shell(shell, backend, user_ns) | ||
323 | print """ |
|
328 | print """ | |
324 | Welcome to pylab, a matplotlib-based Python environment [backend: %s]. |
|
329 | Welcome to pylab, a matplotlib-based Python environment [backend: %s]. | |
325 | For more information, type 'help(pylab)'.""" % backend |
|
330 | For more information, type 'help(pylab)'.""" % backend | |
326 | # flush stdout, just to be safe |
|
331 | # flush stdout, just to be safe | |
327 | sys.stdout.flush() |
|
332 | sys.stdout.flush() | |
328 |
|
333 | |||
329 | return gui |
|
334 | return gui | |
330 |
|
335 |
@@ -1,62 +1,63 b'' | |||||
1 | """Tests for pylab tools module. |
|
1 | """Tests for pylab tools module. | |
2 | """ |
|
2 | """ | |
3 | #----------------------------------------------------------------------------- |
|
3 | #----------------------------------------------------------------------------- | |
4 | # Copyright (c) 2011, the IPython Development Team. |
|
4 | # Copyright (c) 2011, the IPython Development Team. | |
5 | # |
|
5 | # | |
6 | # Distributed under the terms of the Modified BSD License. |
|
6 | # Distributed under the terms of the Modified BSD License. | |
7 | # |
|
7 | # | |
8 | # The full license is in the file COPYING.txt, distributed with this software. |
|
8 | # The full license is in the file COPYING.txt, distributed with this software. | |
9 | #----------------------------------------------------------------------------- |
|
9 | #----------------------------------------------------------------------------- | |
10 |
|
10 | |||
11 | #----------------------------------------------------------------------------- |
|
11 | #----------------------------------------------------------------------------- | |
12 | # Imports |
|
12 | # Imports | |
13 | #----------------------------------------------------------------------------- |
|
13 | #----------------------------------------------------------------------------- | |
14 | from __future__ import print_function |
|
14 | from __future__ import print_function | |
15 |
|
15 | |||
16 | # Stdlib imports |
|
16 | # Stdlib imports | |
17 |
|
17 | |||
18 | # Third-party imports |
|
18 | # Third-party imports | |
19 | import matplotlib; matplotlib.use('Agg') |
|
19 | import matplotlib; matplotlib.use('Agg') | |
20 | import nose.tools as nt |
|
20 | import nose.tools as nt | |
21 |
|
21 | |||
22 | from matplotlib import pyplot as plt |
|
22 | from matplotlib import pyplot as plt | |
23 | import numpy as np |
|
23 | import numpy as np | |
24 |
|
24 | |||
25 | # Our own imports |
|
25 | # Our own imports | |
26 | from IPython.testing import decorators as dec |
|
26 | from IPython.testing import decorators as dec | |
27 | from .. import pylabtools as pt |
|
27 | from .. import pylabtools as pt | |
28 |
|
28 | |||
29 | #----------------------------------------------------------------------------- |
|
29 | #----------------------------------------------------------------------------- | |
30 | # Globals and constants |
|
30 | # Globals and constants | |
31 | #----------------------------------------------------------------------------- |
|
31 | #----------------------------------------------------------------------------- | |
32 |
|
32 | |||
33 | #----------------------------------------------------------------------------- |
|
33 | #----------------------------------------------------------------------------- | |
34 | # Local utilities |
|
34 | # Local utilities | |
35 | #----------------------------------------------------------------------------- |
|
35 | #----------------------------------------------------------------------------- | |
36 |
|
36 | |||
37 | #----------------------------------------------------------------------------- |
|
37 | #----------------------------------------------------------------------------- | |
38 | # Classes and functions |
|
38 | # Classes and functions | |
39 | #----------------------------------------------------------------------------- |
|
39 | #----------------------------------------------------------------------------- | |
40 |
|
40 | |||
41 | @dec.parametric |
|
41 | @dec.parametric | |
42 | def test_figure_to_svg(): |
|
42 | def test_figure_to_svg(): | |
43 | # simple empty-figure test |
|
43 | # simple empty-figure test | |
44 | fig = plt.figure() |
|
44 | fig = plt.figure() | |
45 | yield nt.assert_equal(pt.print_figure(fig, 'svg'), None) |
|
45 | yield nt.assert_equal(pt.print_figure(fig, 'svg'), None) | |
46 |
|
46 | |||
47 | plt.close('all') |
|
47 | plt.close('all') | |
48 |
|
48 | |||
49 | # simple check for at least svg-looking output |
|
49 | # simple check for at least svg-looking output | |
50 | fig = plt.figure() |
|
50 | fig = plt.figure() | |
51 | ax = fig.add_subplot(1,1,1) |
|
51 | ax = fig.add_subplot(1,1,1) | |
52 | ax.plot([1,2,3]) |
|
52 | ax.plot([1,2,3]) | |
53 | plt.draw() |
|
53 | plt.draw() | |
54 | svg = pt.print_figure(fig, 'svg')[:100].lower() |
|
54 | svg = pt.print_figure(fig, 'svg')[:100].lower() | |
55 | yield nt.assert_true('doctype svg' in svg) |
|
55 | yield nt.assert_true('doctype svg' in svg) | |
56 |
|
56 | |||
57 |
|
57 | |||
58 | def test_import_pylab(): |
|
58 | def test_import_pylab(): | |
59 | ip = get_ipython() |
|
59 | ip = get_ipython() | |
60 | pt.import_pylab(ip.user_ns, 'inline', import_all=False, shell=ip) |
|
60 | ns = {} | |
61 | nt.assert_true('plt' in ip.user_ns) |
|
61 | pt.import_pylab(ns, import_all=False) | |
62 | nt.assert_equal(ip.user_ns['np'], np) |
|
62 | nt.assert_true('plt' in ns) | |
|
63 | nt.assert_equal(ns['np'], np) |
@@ -1,711 +1,679 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Subclass of InteractiveShell for terminal based frontends.""" |
|
2 | """Subclass of InteractiveShell for terminal based frontends.""" | |
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 | # Imports |
|
14 | # Imports | |
15 | #----------------------------------------------------------------------------- |
|
15 | #----------------------------------------------------------------------------- | |
16 |
|
16 | |||
17 | import __builtin__ |
|
17 | import __builtin__ | |
18 | import bdb |
|
18 | import bdb | |
19 | import os |
|
19 | import os | |
20 | import re |
|
20 | import re | |
21 | import sys |
|
21 | import sys | |
22 | import textwrap |
|
22 | import textwrap | |
23 |
|
23 | |||
24 | try: |
|
24 | try: | |
25 | from contextlib import nested |
|
25 | from contextlib import nested | |
26 | except: |
|
26 | except: | |
27 | from IPython.utils.nested_context import nested |
|
27 | from IPython.utils.nested_context import nested | |
28 |
|
28 | |||
29 | from IPython.core.error import TryNext |
|
29 | from IPython.core.error import TryNext | |
30 | from IPython.core.usage import interactive_usage, default_banner |
|
30 | from IPython.core.usage import interactive_usage, default_banner | |
31 | from IPython.core.interactiveshell import InteractiveShell, InteractiveShellABC |
|
31 | from IPython.core.interactiveshell import InteractiveShell, InteractiveShellABC | |
32 |
from IPython. |
|
32 | from IPython.core.pylabtools import pylab_activate | |
33 | from IPython.lib.pylabtools import pylab_activate |
|
|||
34 | from IPython.testing.skipdoctest import skip_doctest |
|
33 | from IPython.testing.skipdoctest import skip_doctest | |
35 | from IPython.utils import py3compat |
|
34 | from IPython.utils import py3compat | |
36 | from IPython.utils.terminal import toggle_set_term_title, set_term_title |
|
35 | from IPython.utils.terminal import toggle_set_term_title, set_term_title | |
37 | from IPython.utils.process import abbrev_cwd |
|
36 | from IPython.utils.process import abbrev_cwd | |
38 | from IPython.utils.warn import warn, error |
|
37 | from IPython.utils.warn import warn, error | |
39 | from IPython.utils.text import num_ini_spaces, SList |
|
38 | from IPython.utils.text import num_ini_spaces, SList | |
40 | from IPython.utils.traitlets import Integer, CBool, Unicode |
|
39 | from IPython.utils.traitlets import Integer, CBool, Unicode | |
41 |
|
40 | |||
42 | #----------------------------------------------------------------------------- |
|
41 | #----------------------------------------------------------------------------- | |
43 | # Utilities |
|
42 | # Utilities | |
44 | #----------------------------------------------------------------------------- |
|
43 | #----------------------------------------------------------------------------- | |
45 |
|
44 | |||
46 | def get_default_editor(): |
|
45 | def get_default_editor(): | |
47 | try: |
|
46 | try: | |
48 | ed = os.environ['EDITOR'] |
|
47 | ed = os.environ['EDITOR'] | |
49 | except KeyError: |
|
48 | except KeyError: | |
50 | if os.name == 'posix': |
|
49 | if os.name == 'posix': | |
51 | ed = 'vi' # the only one guaranteed to be there! |
|
50 | ed = 'vi' # the only one guaranteed to be there! | |
52 | else: |
|
51 | else: | |
53 | ed = 'notepad' # same in Windows! |
|
52 | ed = 'notepad' # same in Windows! | |
54 | return ed |
|
53 | return ed | |
55 |
|
54 | |||
56 |
|
55 | |||
57 | def get_pasted_lines(sentinel, l_input=py3compat.input): |
|
56 | def get_pasted_lines(sentinel, l_input=py3compat.input): | |
58 | """ Yield pasted lines until the user enters the given sentinel value. |
|
57 | """ Yield pasted lines until the user enters the given sentinel value. | |
59 | """ |
|
58 | """ | |
60 | print "Pasting code; enter '%s' alone on the line to stop or use Ctrl-D." \ |
|
59 | print "Pasting code; enter '%s' alone on the line to stop or use Ctrl-D." \ | |
61 | % sentinel |
|
60 | % sentinel | |
62 | while True: |
|
61 | while True: | |
63 | try: |
|
62 | try: | |
64 | l = l_input(':') |
|
63 | l = l_input(':') | |
65 | if l == sentinel: |
|
64 | if l == sentinel: | |
66 | return |
|
65 | return | |
67 | else: |
|
66 | else: | |
68 | yield l |
|
67 | yield l | |
69 | except EOFError: |
|
68 | except EOFError: | |
70 | print '<EOF>' |
|
69 | print '<EOF>' | |
71 | return |
|
70 | return | |
72 |
|
71 | |||
73 |
|
72 | |||
74 | def strip_email_quotes(raw_lines): |
|
73 | def strip_email_quotes(raw_lines): | |
75 | """ Strip email quotation marks at the beginning of each line. |
|
74 | """ Strip email quotation marks at the beginning of each line. | |
76 |
|
75 | |||
77 | We don't do any more input transofrmations here because the main shell's |
|
76 | We don't do any more input transofrmations here because the main shell's | |
78 | prefiltering handles other cases. |
|
77 | prefiltering handles other cases. | |
79 | """ |
|
78 | """ | |
80 | lines = [re.sub(r'^\s*(\s?>)+', '', l) for l in raw_lines] |
|
79 | lines = [re.sub(r'^\s*(\s?>)+', '', l) for l in raw_lines] | |
81 | return '\n'.join(lines) + '\n' |
|
80 | return '\n'.join(lines) + '\n' | |
82 |
|
81 | |||
83 |
|
82 | |||
84 | # These two functions are needed by the %paste/%cpaste magics. In practice |
|
83 | # These two functions are needed by the %paste/%cpaste magics. In practice | |
85 | # they are basically methods (they take the shell as their first argument), but |
|
84 | # they are basically methods (they take the shell as their first argument), but | |
86 | # we leave them as standalone functions because eventually the magics |
|
85 | # we leave them as standalone functions because eventually the magics | |
87 | # themselves will become separate objects altogether. At that point, the |
|
86 | # themselves will become separate objects altogether. At that point, the | |
88 | # magics will have access to the shell object, and these functions can be made |
|
87 | # magics will have access to the shell object, and these functions can be made | |
89 | # methods of the magic object, but not of the shell. |
|
88 | # methods of the magic object, but not of the shell. | |
90 |
|
89 | |||
91 | def store_or_execute(shell, block, name): |
|
90 | def store_or_execute(shell, block, name): | |
92 | """ Execute a block, or store it in a variable, per the user's request. |
|
91 | """ Execute a block, or store it in a variable, per the user's request. | |
93 | """ |
|
92 | """ | |
94 | # Dedent and prefilter so what we store matches what is executed by |
|
93 | # Dedent and prefilter so what we store matches what is executed by | |
95 | # run_cell. |
|
94 | # run_cell. | |
96 | b = shell.prefilter(textwrap.dedent(block)) |
|
95 | b = shell.prefilter(textwrap.dedent(block)) | |
97 |
|
96 | |||
98 | if name: |
|
97 | if name: | |
99 | # If storing it for further editing, run the prefilter on it |
|
98 | # If storing it for further editing, run the prefilter on it | |
100 | shell.user_ns[name] = SList(b.splitlines()) |
|
99 | shell.user_ns[name] = SList(b.splitlines()) | |
101 | print "Block assigned to '%s'" % name |
|
100 | print "Block assigned to '%s'" % name | |
102 | else: |
|
101 | else: | |
103 | shell.user_ns['pasted_block'] = b |
|
102 | shell.user_ns['pasted_block'] = b | |
104 | shell.run_cell(b) |
|
103 | shell.run_cell(b) | |
105 |
|
104 | |||
106 |
|
105 | |||
107 | def rerun_pasted(shell, name='pasted_block'): |
|
106 | def rerun_pasted(shell, name='pasted_block'): | |
108 | """ Rerun a previously pasted command. |
|
107 | """ Rerun a previously pasted command. | |
109 | """ |
|
108 | """ | |
110 | b = shell.user_ns.get(name) |
|
109 | b = shell.user_ns.get(name) | |
111 |
|
110 | |||
112 | # Sanity checks |
|
111 | # Sanity checks | |
113 | if b is None: |
|
112 | if b is None: | |
114 | raise UsageError('No previous pasted block available') |
|
113 | raise UsageError('No previous pasted block available') | |
115 | if not isinstance(b, basestring): |
|
114 | if not isinstance(b, basestring): | |
116 | raise UsageError( |
|
115 | raise UsageError( | |
117 | "Variable 'pasted_block' is not a string, can't execute") |
|
116 | "Variable 'pasted_block' is not a string, can't execute") | |
118 |
|
117 | |||
119 | print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b)) |
|
118 | print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b)) | |
120 | shell.run_cell(b) |
|
119 | shell.run_cell(b) | |
121 |
|
120 | |||
122 |
|
121 | |||
123 | #----------------------------------------------------------------------------- |
|
122 | #----------------------------------------------------------------------------- | |
124 | # Main class |
|
123 | # Main class | |
125 | #----------------------------------------------------------------------------- |
|
124 | #----------------------------------------------------------------------------- | |
126 |
|
125 | |||
127 | class TerminalInteractiveShell(InteractiveShell): |
|
126 | class TerminalInteractiveShell(InteractiveShell): | |
128 |
|
127 | |||
129 | autoedit_syntax = CBool(False, config=True, |
|
128 | autoedit_syntax = CBool(False, config=True, | |
130 | help="auto editing of files with syntax errors.") |
|
129 | help="auto editing of files with syntax errors.") | |
131 | banner = Unicode('') |
|
130 | banner = Unicode('') | |
132 | banner1 = Unicode(default_banner, config=True, |
|
131 | banner1 = Unicode(default_banner, config=True, | |
133 | help="""The part of the banner to be printed before the profile""" |
|
132 | help="""The part of the banner to be printed before the profile""" | |
134 | ) |
|
133 | ) | |
135 | banner2 = Unicode('', config=True, |
|
134 | banner2 = Unicode('', config=True, | |
136 | help="""The part of the banner to be printed after the profile""" |
|
135 | help="""The part of the banner to be printed after the profile""" | |
137 | ) |
|
136 | ) | |
138 | confirm_exit = CBool(True, config=True, |
|
137 | confirm_exit = CBool(True, config=True, | |
139 | help=""" |
|
138 | help=""" | |
140 | Set to confirm when you try to exit IPython with an EOF (Control-D |
|
139 | Set to confirm when you try to exit IPython with an EOF (Control-D | |
141 | in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit', |
|
140 | in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit', | |
142 | you can force a direct exit without any confirmation.""", |
|
141 | you can force a direct exit without any confirmation.""", | |
143 | ) |
|
142 | ) | |
144 | # This display_banner only controls whether or not self.show_banner() |
|
143 | # This display_banner only controls whether or not self.show_banner() | |
145 | # is called when mainloop/interact are called. The default is False |
|
144 | # is called when mainloop/interact are called. The default is False | |
146 | # because for the terminal based application, the banner behavior |
|
145 | # because for the terminal based application, the banner behavior | |
147 | # is controlled by Global.display_banner, which IPythonApp looks at |
|
146 | # is controlled by Global.display_banner, which IPythonApp looks at | |
148 | # to determine if *it* should call show_banner() by hand or not. |
|
147 | # to determine if *it* should call show_banner() by hand or not. | |
149 | display_banner = CBool(False) # This isn't configurable! |
|
148 | display_banner = CBool(False) # This isn't configurable! | |
150 | embedded = CBool(False) |
|
149 | embedded = CBool(False) | |
151 | embedded_active = CBool(False) |
|
150 | embedded_active = CBool(False) | |
152 | editor = Unicode(get_default_editor(), config=True, |
|
151 | editor = Unicode(get_default_editor(), config=True, | |
153 | help="Set the editor used by IPython (default to $EDITOR/vi/notepad)." |
|
152 | help="Set the editor used by IPython (default to $EDITOR/vi/notepad)." | |
154 | ) |
|
153 | ) | |
155 | pager = Unicode('less', config=True, |
|
154 | pager = Unicode('less', config=True, | |
156 | help="The shell program to be used for paging.") |
|
155 | help="The shell program to be used for paging.") | |
157 |
|
156 | |||
158 | screen_length = Integer(0, config=True, |
|
157 | screen_length = Integer(0, config=True, | |
159 | help= |
|
158 | help= | |
160 | """Number of lines of your screen, used to control printing of very |
|
159 | """Number of lines of your screen, used to control printing of very | |
161 | long strings. Strings longer than this number of lines will be sent |
|
160 | long strings. Strings longer than this number of lines will be sent | |
162 | through a pager instead of directly printed. The default value for |
|
161 | through a pager instead of directly printed. The default value for | |
163 | this is 0, which means IPython will auto-detect your screen size every |
|
162 | this is 0, which means IPython will auto-detect your screen size every | |
164 | time it needs to print certain potentially long strings (this doesn't |
|
163 | time it needs to print certain potentially long strings (this doesn't | |
165 | change the behavior of the 'print' keyword, it's only triggered |
|
164 | change the behavior of the 'print' keyword, it's only triggered | |
166 | internally). If for some reason this isn't working well (it needs |
|
165 | internally). If for some reason this isn't working well (it needs | |
167 | curses support), specify it yourself. Otherwise don't change the |
|
166 | curses support), specify it yourself. Otherwise don't change the | |
168 | default.""", |
|
167 | default.""", | |
169 | ) |
|
168 | ) | |
170 | term_title = CBool(False, config=True, |
|
169 | term_title = CBool(False, config=True, | |
171 | help="Enable auto setting the terminal title." |
|
170 | help="Enable auto setting the terminal title." | |
172 | ) |
|
171 | ) | |
173 |
|
172 | |||
174 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, user_ns=None, |
|
173 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, user_ns=None, | |
175 | user_module=None, custom_exceptions=((),None), |
|
174 | user_module=None, custom_exceptions=((),None), | |
176 | usage=None, banner1=None, banner2=None, |
|
175 | usage=None, banner1=None, banner2=None, | |
177 | display_banner=None): |
|
176 | display_banner=None): | |
178 |
|
177 | |||
179 | super(TerminalInteractiveShell, self).__init__( |
|
178 | super(TerminalInteractiveShell, self).__init__( | |
180 | config=config, profile_dir=profile_dir, user_ns=user_ns, |
|
179 | config=config, profile_dir=profile_dir, user_ns=user_ns, | |
181 | user_module=user_module, custom_exceptions=custom_exceptions |
|
180 | user_module=user_module, custom_exceptions=custom_exceptions | |
182 | ) |
|
181 | ) | |
183 | # use os.system instead of utils.process.system by default, |
|
182 | # use os.system instead of utils.process.system by default, | |
184 | # because piped system doesn't make sense in the Terminal: |
|
183 | # because piped system doesn't make sense in the Terminal: | |
185 | self.system = self.system_raw |
|
184 | self.system = self.system_raw | |
186 |
|
185 | |||
187 | self.init_term_title() |
|
186 | self.init_term_title() | |
188 | self.init_usage(usage) |
|
187 | self.init_usage(usage) | |
189 | self.init_banner(banner1, banner2, display_banner) |
|
188 | self.init_banner(banner1, banner2, display_banner) | |
190 |
|
189 | |||
191 | #------------------------------------------------------------------------- |
|
190 | #------------------------------------------------------------------------- | |
192 | # Things related to the terminal |
|
191 | # Things related to the terminal | |
193 | #------------------------------------------------------------------------- |
|
192 | #------------------------------------------------------------------------- | |
194 |
|
193 | |||
195 | @property |
|
194 | @property | |
196 | def usable_screen_length(self): |
|
195 | def usable_screen_length(self): | |
197 | if self.screen_length == 0: |
|
196 | if self.screen_length == 0: | |
198 | return 0 |
|
197 | return 0 | |
199 | else: |
|
198 | else: | |
200 | num_lines_bot = self.separate_in.count('\n')+1 |
|
199 | num_lines_bot = self.separate_in.count('\n')+1 | |
201 | return self.screen_length - num_lines_bot |
|
200 | return self.screen_length - num_lines_bot | |
202 |
|
201 | |||
203 | def init_term_title(self): |
|
202 | def init_term_title(self): | |
204 | # Enable or disable the terminal title. |
|
203 | # Enable or disable the terminal title. | |
205 | if self.term_title: |
|
204 | if self.term_title: | |
206 | toggle_set_term_title(True) |
|
205 | toggle_set_term_title(True) | |
207 | set_term_title('IPython: ' + abbrev_cwd()) |
|
206 | set_term_title('IPython: ' + abbrev_cwd()) | |
208 | else: |
|
207 | else: | |
209 | toggle_set_term_title(False) |
|
208 | toggle_set_term_title(False) | |
210 |
|
209 | |||
211 | #------------------------------------------------------------------------- |
|
210 | #------------------------------------------------------------------------- | |
212 | # Things related to aliases |
|
211 | # Things related to aliases | |
213 | #------------------------------------------------------------------------- |
|
212 | #------------------------------------------------------------------------- | |
214 |
|
213 | |||
215 | def init_alias(self): |
|
214 | def init_alias(self): | |
216 | # The parent class defines aliases that can be safely used with any |
|
215 | # The parent class defines aliases that can be safely used with any | |
217 | # frontend. |
|
216 | # frontend. | |
218 | super(TerminalInteractiveShell, self).init_alias() |
|
217 | super(TerminalInteractiveShell, self).init_alias() | |
219 |
|
218 | |||
220 | # Now define aliases that only make sense on the terminal, because they |
|
219 | # Now define aliases that only make sense on the terminal, because they | |
221 | # need direct access to the console in a way that we can't emulate in |
|
220 | # need direct access to the console in a way that we can't emulate in | |
222 | # GUI or web frontend |
|
221 | # GUI or web frontend | |
223 | if os.name == 'posix': |
|
222 | if os.name == 'posix': | |
224 | aliases = [('clear', 'clear'), ('more', 'more'), ('less', 'less'), |
|
223 | aliases = [('clear', 'clear'), ('more', 'more'), ('less', 'less'), | |
225 | ('man', 'man')] |
|
224 | ('man', 'man')] | |
226 | elif os.name == 'nt': |
|
225 | elif os.name == 'nt': | |
227 | aliases = [('cls', 'cls')] |
|
226 | aliases = [('cls', 'cls')] | |
228 |
|
227 | |||
229 |
|
228 | |||
230 | for name, cmd in aliases: |
|
229 | for name, cmd in aliases: | |
231 | self.alias_manager.define_alias(name, cmd) |
|
230 | self.alias_manager.define_alias(name, cmd) | |
232 |
|
231 | |||
233 | #------------------------------------------------------------------------- |
|
232 | #------------------------------------------------------------------------- | |
234 | # Things related to the banner and usage |
|
233 | # Things related to the banner and usage | |
235 | #------------------------------------------------------------------------- |
|
234 | #------------------------------------------------------------------------- | |
236 |
|
235 | |||
237 | def _banner1_changed(self): |
|
236 | def _banner1_changed(self): | |
238 | self.compute_banner() |
|
237 | self.compute_banner() | |
239 |
|
238 | |||
240 | def _banner2_changed(self): |
|
239 | def _banner2_changed(self): | |
241 | self.compute_banner() |
|
240 | self.compute_banner() | |
242 |
|
241 | |||
243 | def _term_title_changed(self, name, new_value): |
|
242 | def _term_title_changed(self, name, new_value): | |
244 | self.init_term_title() |
|
243 | self.init_term_title() | |
245 |
|
244 | |||
246 | def init_banner(self, banner1, banner2, display_banner): |
|
245 | def init_banner(self, banner1, banner2, display_banner): | |
247 | if banner1 is not None: |
|
246 | if banner1 is not None: | |
248 | self.banner1 = banner1 |
|
247 | self.banner1 = banner1 | |
249 | if banner2 is not None: |
|
248 | if banner2 is not None: | |
250 | self.banner2 = banner2 |
|
249 | self.banner2 = banner2 | |
251 | if display_banner is not None: |
|
250 | if display_banner is not None: | |
252 | self.display_banner = display_banner |
|
251 | self.display_banner = display_banner | |
253 | self.compute_banner() |
|
252 | self.compute_banner() | |
254 |
|
253 | |||
255 | def show_banner(self, banner=None): |
|
254 | def show_banner(self, banner=None): | |
256 | if banner is None: |
|
255 | if banner is None: | |
257 | banner = self.banner |
|
256 | banner = self.banner | |
258 | self.write(banner) |
|
257 | self.write(banner) | |
259 |
|
258 | |||
260 | def compute_banner(self): |
|
259 | def compute_banner(self): | |
261 | self.banner = self.banner1 |
|
260 | self.banner = self.banner1 | |
262 | if self.profile and self.profile != 'default': |
|
261 | if self.profile and self.profile != 'default': | |
263 | self.banner += '\nIPython profile: %s\n' % self.profile |
|
262 | self.banner += '\nIPython profile: %s\n' % self.profile | |
264 | if self.banner2: |
|
263 | if self.banner2: | |
265 | self.banner += '\n' + self.banner2 |
|
264 | self.banner += '\n' + self.banner2 | |
266 |
|
265 | |||
267 | def init_usage(self, usage=None): |
|
266 | def init_usage(self, usage=None): | |
268 | if usage is None: |
|
267 | if usage is None: | |
269 | self.usage = interactive_usage |
|
268 | self.usage = interactive_usage | |
270 | else: |
|
269 | else: | |
271 | self.usage = usage |
|
270 | self.usage = usage | |
272 |
|
271 | |||
273 | #------------------------------------------------------------------------- |
|
272 | #------------------------------------------------------------------------- | |
274 | # Mainloop and code execution logic |
|
273 | # Mainloop and code execution logic | |
275 | #------------------------------------------------------------------------- |
|
274 | #------------------------------------------------------------------------- | |
276 |
|
275 | |||
277 | def mainloop(self, display_banner=None): |
|
276 | def mainloop(self, display_banner=None): | |
278 | """Start the mainloop. |
|
277 | """Start the mainloop. | |
279 |
|
278 | |||
280 | If an optional banner argument is given, it will override the |
|
279 | If an optional banner argument is given, it will override the | |
281 | internally created default banner. |
|
280 | internally created default banner. | |
282 | """ |
|
281 | """ | |
283 |
|
282 | |||
284 | with nested(self.builtin_trap, self.display_trap): |
|
283 | with nested(self.builtin_trap, self.display_trap): | |
285 |
|
284 | |||
286 | while 1: |
|
285 | while 1: | |
287 | try: |
|
286 | try: | |
288 | self.interact(display_banner=display_banner) |
|
287 | self.interact(display_banner=display_banner) | |
289 | #self.interact_with_readline() |
|
288 | #self.interact_with_readline() | |
290 | # XXX for testing of a readline-decoupled repl loop, call |
|
289 | # XXX for testing of a readline-decoupled repl loop, call | |
291 | # interact_with_readline above |
|
290 | # interact_with_readline above | |
292 | break |
|
291 | break | |
293 | except KeyboardInterrupt: |
|
292 | except KeyboardInterrupt: | |
294 | # this should not be necessary, but KeyboardInterrupt |
|
293 | # this should not be necessary, but KeyboardInterrupt | |
295 | # handling seems rather unpredictable... |
|
294 | # handling seems rather unpredictable... | |
296 | self.write("\nKeyboardInterrupt in interact()\n") |
|
295 | self.write("\nKeyboardInterrupt in interact()\n") | |
297 |
|
296 | |||
298 | def _replace_rlhist_multiline(self, source_raw, hlen_before_cell): |
|
297 | def _replace_rlhist_multiline(self, source_raw, hlen_before_cell): | |
299 | """Store multiple lines as a single entry in history""" |
|
298 | """Store multiple lines as a single entry in history""" | |
300 |
|
299 | |||
301 | # do nothing without readline or disabled multiline |
|
300 | # do nothing without readline or disabled multiline | |
302 | if not self.has_readline or not self.multiline_history: |
|
301 | if not self.has_readline or not self.multiline_history: | |
303 | return hlen_before_cell |
|
302 | return hlen_before_cell | |
304 |
|
303 | |||
305 | # windows rl has no remove_history_item |
|
304 | # windows rl has no remove_history_item | |
306 | if not hasattr(self.readline, "remove_history_item"): |
|
305 | if not hasattr(self.readline, "remove_history_item"): | |
307 | return hlen_before_cell |
|
306 | return hlen_before_cell | |
308 |
|
307 | |||
309 | # skip empty cells |
|
308 | # skip empty cells | |
310 | if not source_raw.rstrip(): |
|
309 | if not source_raw.rstrip(): | |
311 | return hlen_before_cell |
|
310 | return hlen_before_cell | |
312 |
|
311 | |||
313 | # nothing changed do nothing, e.g. when rl removes consecutive dups |
|
312 | # nothing changed do nothing, e.g. when rl removes consecutive dups | |
314 | hlen = self.readline.get_current_history_length() |
|
313 | hlen = self.readline.get_current_history_length() | |
315 | if hlen == hlen_before_cell: |
|
314 | if hlen == hlen_before_cell: | |
316 | return hlen_before_cell |
|
315 | return hlen_before_cell | |
317 |
|
316 | |||
318 | for i in range(hlen - hlen_before_cell): |
|
317 | for i in range(hlen - hlen_before_cell): | |
319 | self.readline.remove_history_item(hlen - i - 1) |
|
318 | self.readline.remove_history_item(hlen - i - 1) | |
320 | stdin_encoding = sys.stdin.encoding or "utf-8" |
|
319 | stdin_encoding = sys.stdin.encoding or "utf-8" | |
321 | self.readline.add_history(py3compat.unicode_to_str(source_raw.rstrip(), |
|
320 | self.readline.add_history(py3compat.unicode_to_str(source_raw.rstrip(), | |
322 | stdin_encoding)) |
|
321 | stdin_encoding)) | |
323 | return self.readline.get_current_history_length() |
|
322 | return self.readline.get_current_history_length() | |
324 |
|
323 | |||
325 | def interact(self, display_banner=None): |
|
324 | def interact(self, display_banner=None): | |
326 | """Closely emulate the interactive Python console.""" |
|
325 | """Closely emulate the interactive Python console.""" | |
327 |
|
326 | |||
328 | # batch run -> do not interact |
|
327 | # batch run -> do not interact | |
329 | if self.exit_now: |
|
328 | if self.exit_now: | |
330 | return |
|
329 | return | |
331 |
|
330 | |||
332 | if display_banner is None: |
|
331 | if display_banner is None: | |
333 | display_banner = self.display_banner |
|
332 | display_banner = self.display_banner | |
334 |
|
333 | |||
335 | if isinstance(display_banner, basestring): |
|
334 | if isinstance(display_banner, basestring): | |
336 | self.show_banner(display_banner) |
|
335 | self.show_banner(display_banner) | |
337 | elif display_banner: |
|
336 | elif display_banner: | |
338 | self.show_banner() |
|
337 | self.show_banner() | |
339 |
|
338 | |||
340 | more = False |
|
339 | more = False | |
341 |
|
340 | |||
342 | # Mark activity in the builtins |
|
341 | # Mark activity in the builtins | |
343 | __builtin__.__dict__['__IPYTHON__active'] += 1 |
|
342 | __builtin__.__dict__['__IPYTHON__active'] += 1 | |
344 |
|
343 | |||
345 | if self.has_readline: |
|
344 | if self.has_readline: | |
346 | self.readline_startup_hook(self.pre_readline) |
|
345 | self.readline_startup_hook(self.pre_readline) | |
347 | hlen_b4_cell = self.readline.get_current_history_length() |
|
346 | hlen_b4_cell = self.readline.get_current_history_length() | |
348 | else: |
|
347 | else: | |
349 | hlen_b4_cell = 0 |
|
348 | hlen_b4_cell = 0 | |
350 | # exit_now is set by a call to %Exit or %Quit, through the |
|
349 | # exit_now is set by a call to %Exit or %Quit, through the | |
351 | # ask_exit callback. |
|
350 | # ask_exit callback. | |
352 |
|
351 | |||
353 | while not self.exit_now: |
|
352 | while not self.exit_now: | |
354 | self.hooks.pre_prompt_hook() |
|
353 | self.hooks.pre_prompt_hook() | |
355 | if more: |
|
354 | if more: | |
356 | try: |
|
355 | try: | |
357 | prompt = self.hooks.generate_prompt(True) |
|
356 | prompt = self.hooks.generate_prompt(True) | |
358 | except: |
|
357 | except: | |
359 | self.showtraceback() |
|
358 | self.showtraceback() | |
360 | if self.autoindent: |
|
359 | if self.autoindent: | |
361 | self.rl_do_indent = True |
|
360 | self.rl_do_indent = True | |
362 |
|
361 | |||
363 | else: |
|
362 | else: | |
364 | try: |
|
363 | try: | |
365 | prompt = self.hooks.generate_prompt(False) |
|
364 | prompt = self.hooks.generate_prompt(False) | |
366 | except: |
|
365 | except: | |
367 | self.showtraceback() |
|
366 | self.showtraceback() | |
368 | try: |
|
367 | try: | |
369 | line = self.raw_input(prompt) |
|
368 | line = self.raw_input(prompt) | |
370 | if self.exit_now: |
|
369 | if self.exit_now: | |
371 | # quick exit on sys.std[in|out] close |
|
370 | # quick exit on sys.std[in|out] close | |
372 | break |
|
371 | break | |
373 | if self.autoindent: |
|
372 | if self.autoindent: | |
374 | self.rl_do_indent = False |
|
373 | self.rl_do_indent = False | |
375 |
|
374 | |||
376 | except KeyboardInterrupt: |
|
375 | except KeyboardInterrupt: | |
377 | #double-guard against keyboardinterrupts during kbdint handling |
|
376 | #double-guard against keyboardinterrupts during kbdint handling | |
378 | try: |
|
377 | try: | |
379 | self.write('\nKeyboardInterrupt\n') |
|
378 | self.write('\nKeyboardInterrupt\n') | |
380 | source_raw = self.input_splitter.source_raw_reset()[1] |
|
379 | source_raw = self.input_splitter.source_raw_reset()[1] | |
381 | hlen_b4_cell = \ |
|
380 | hlen_b4_cell = \ | |
382 | self._replace_rlhist_multiline(source_raw, hlen_b4_cell) |
|
381 | self._replace_rlhist_multiline(source_raw, hlen_b4_cell) | |
383 | more = False |
|
382 | more = False | |
384 | except KeyboardInterrupt: |
|
383 | except KeyboardInterrupt: | |
385 | pass |
|
384 | pass | |
386 | except EOFError: |
|
385 | except EOFError: | |
387 | if self.autoindent: |
|
386 | if self.autoindent: | |
388 | self.rl_do_indent = False |
|
387 | self.rl_do_indent = False | |
389 | if self.has_readline: |
|
388 | if self.has_readline: | |
390 | self.readline_startup_hook(None) |
|
389 | self.readline_startup_hook(None) | |
391 | self.write('\n') |
|
390 | self.write('\n') | |
392 | self.exit() |
|
391 | self.exit() | |
393 | except bdb.BdbQuit: |
|
392 | except bdb.BdbQuit: | |
394 | warn('The Python debugger has exited with a BdbQuit exception.\n' |
|
393 | warn('The Python debugger has exited with a BdbQuit exception.\n' | |
395 | 'Because of how pdb handles the stack, it is impossible\n' |
|
394 | 'Because of how pdb handles the stack, it is impossible\n' | |
396 | 'for IPython to properly format this particular exception.\n' |
|
395 | 'for IPython to properly format this particular exception.\n' | |
397 | 'IPython will resume normal operation.') |
|
396 | 'IPython will resume normal operation.') | |
398 | except: |
|
397 | except: | |
399 | # exceptions here are VERY RARE, but they can be triggered |
|
398 | # exceptions here are VERY RARE, but they can be triggered | |
400 | # asynchronously by signal handlers, for example. |
|
399 | # asynchronously by signal handlers, for example. | |
401 | self.showtraceback() |
|
400 | self.showtraceback() | |
402 | else: |
|
401 | else: | |
403 | self.input_splitter.push(line) |
|
402 | self.input_splitter.push(line) | |
404 | more = self.input_splitter.push_accepts_more() |
|
403 | more = self.input_splitter.push_accepts_more() | |
405 | if (self.SyntaxTB.last_syntax_error and |
|
404 | if (self.SyntaxTB.last_syntax_error and | |
406 | self.autoedit_syntax): |
|
405 | self.autoedit_syntax): | |
407 | self.edit_syntax_error() |
|
406 | self.edit_syntax_error() | |
408 | if not more: |
|
407 | if not more: | |
409 | source_raw = self.input_splitter.source_raw_reset()[1] |
|
408 | source_raw = self.input_splitter.source_raw_reset()[1] | |
410 | self.run_cell(source_raw, store_history=True) |
|
409 | self.run_cell(source_raw, store_history=True) | |
411 | hlen_b4_cell = \ |
|
410 | hlen_b4_cell = \ | |
412 | self._replace_rlhist_multiline(source_raw, hlen_b4_cell) |
|
411 | self._replace_rlhist_multiline(source_raw, hlen_b4_cell) | |
413 |
|
412 | |||
414 | # We are off again... |
|
413 | # We are off again... | |
415 | __builtin__.__dict__['__IPYTHON__active'] -= 1 |
|
414 | __builtin__.__dict__['__IPYTHON__active'] -= 1 | |
416 |
|
415 | |||
417 | # Turn off the exit flag, so the mainloop can be restarted if desired |
|
416 | # Turn off the exit flag, so the mainloop can be restarted if desired | |
418 | self.exit_now = False |
|
417 | self.exit_now = False | |
419 |
|
418 | |||
420 | def raw_input(self, prompt=''): |
|
419 | def raw_input(self, prompt=''): | |
421 | """Write a prompt and read a line. |
|
420 | """Write a prompt and read a line. | |
422 |
|
421 | |||
423 | The returned line does not include the trailing newline. |
|
422 | The returned line does not include the trailing newline. | |
424 | When the user enters the EOF key sequence, EOFError is raised. |
|
423 | When the user enters the EOF key sequence, EOFError is raised. | |
425 |
|
424 | |||
426 | Optional inputs: |
|
425 | Optional inputs: | |
427 |
|
426 | |||
428 | - prompt(''): a string to be printed to prompt the user. |
|
427 | - prompt(''): a string to be printed to prompt the user. | |
429 |
|
428 | |||
430 | - continue_prompt(False): whether this line is the first one or a |
|
429 | - continue_prompt(False): whether this line is the first one or a | |
431 | continuation in a sequence of inputs. |
|
430 | continuation in a sequence of inputs. | |
432 | """ |
|
431 | """ | |
433 | # Code run by the user may have modified the readline completer state. |
|
432 | # Code run by the user may have modified the readline completer state. | |
434 | # We must ensure that our completer is back in place. |
|
433 | # We must ensure that our completer is back in place. | |
435 |
|
434 | |||
436 | if self.has_readline: |
|
435 | if self.has_readline: | |
437 | self.set_readline_completer() |
|
436 | self.set_readline_completer() | |
438 |
|
437 | |||
439 | try: |
|
438 | try: | |
440 | line = py3compat.str_to_unicode(self.raw_input_original(prompt)) |
|
439 | line = py3compat.str_to_unicode(self.raw_input_original(prompt)) | |
441 | except ValueError: |
|
440 | except ValueError: | |
442 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" |
|
441 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" | |
443 | " or sys.stdout.close()!\nExiting IPython!") |
|
442 | " or sys.stdout.close()!\nExiting IPython!") | |
444 | self.ask_exit() |
|
443 | self.ask_exit() | |
445 | return "" |
|
444 | return "" | |
446 |
|
445 | |||
447 | # Try to be reasonably smart about not re-indenting pasted input more |
|
446 | # Try to be reasonably smart about not re-indenting pasted input more | |
448 | # than necessary. We do this by trimming out the auto-indent initial |
|
447 | # than necessary. We do this by trimming out the auto-indent initial | |
449 | # spaces, if the user's actual input started itself with whitespace. |
|
448 | # spaces, if the user's actual input started itself with whitespace. | |
450 | if self.autoindent: |
|
449 | if self.autoindent: | |
451 | if num_ini_spaces(line) > self.indent_current_nsp: |
|
450 | if num_ini_spaces(line) > self.indent_current_nsp: | |
452 | line = line[self.indent_current_nsp:] |
|
451 | line = line[self.indent_current_nsp:] | |
453 | self.indent_current_nsp = 0 |
|
452 | self.indent_current_nsp = 0 | |
454 |
|
453 | |||
455 | return line |
|
454 | return line | |
456 |
|
455 | |||
457 | #------------------------------------------------------------------------- |
|
456 | #------------------------------------------------------------------------- | |
458 | # Methods to support auto-editing of SyntaxErrors. |
|
457 | # Methods to support auto-editing of SyntaxErrors. | |
459 | #------------------------------------------------------------------------- |
|
458 | #------------------------------------------------------------------------- | |
460 |
|
459 | |||
461 | def edit_syntax_error(self): |
|
460 | def edit_syntax_error(self): | |
462 | """The bottom half of the syntax error handler called in the main loop. |
|
461 | """The bottom half of the syntax error handler called in the main loop. | |
463 |
|
462 | |||
464 | Loop until syntax error is fixed or user cancels. |
|
463 | Loop until syntax error is fixed or user cancels. | |
465 | """ |
|
464 | """ | |
466 |
|
465 | |||
467 | while self.SyntaxTB.last_syntax_error: |
|
466 | while self.SyntaxTB.last_syntax_error: | |
468 | # copy and clear last_syntax_error |
|
467 | # copy and clear last_syntax_error | |
469 | err = self.SyntaxTB.clear_err_state() |
|
468 | err = self.SyntaxTB.clear_err_state() | |
470 | if not self._should_recompile(err): |
|
469 | if not self._should_recompile(err): | |
471 | return |
|
470 | return | |
472 | try: |
|
471 | try: | |
473 | # may set last_syntax_error again if a SyntaxError is raised |
|
472 | # may set last_syntax_error again if a SyntaxError is raised | |
474 | self.safe_execfile(err.filename,self.user_ns) |
|
473 | self.safe_execfile(err.filename,self.user_ns) | |
475 | except: |
|
474 | except: | |
476 | self.showtraceback() |
|
475 | self.showtraceback() | |
477 | else: |
|
476 | else: | |
478 | try: |
|
477 | try: | |
479 | f = file(err.filename) |
|
478 | f = file(err.filename) | |
480 | try: |
|
479 | try: | |
481 | # This should be inside a display_trap block and I |
|
480 | # This should be inside a display_trap block and I | |
482 | # think it is. |
|
481 | # think it is. | |
483 | sys.displayhook(f.read()) |
|
482 | sys.displayhook(f.read()) | |
484 | finally: |
|
483 | finally: | |
485 | f.close() |
|
484 | f.close() | |
486 | except: |
|
485 | except: | |
487 | self.showtraceback() |
|
486 | self.showtraceback() | |
488 |
|
487 | |||
489 | def _should_recompile(self,e): |
|
488 | def _should_recompile(self,e): | |
490 | """Utility routine for edit_syntax_error""" |
|
489 | """Utility routine for edit_syntax_error""" | |
491 |
|
490 | |||
492 | if e.filename in ('<ipython console>','<input>','<string>', |
|
491 | if e.filename in ('<ipython console>','<input>','<string>', | |
493 | '<console>','<BackgroundJob compilation>', |
|
492 | '<console>','<BackgroundJob compilation>', | |
494 | None): |
|
493 | None): | |
495 |
|
494 | |||
496 | return False |
|
495 | return False | |
497 | try: |
|
496 | try: | |
498 | if (self.autoedit_syntax and |
|
497 | if (self.autoedit_syntax and | |
499 | not self.ask_yes_no('Return to editor to correct syntax error? ' |
|
498 | not self.ask_yes_no('Return to editor to correct syntax error? ' | |
500 | '[Y/n] ','y')): |
|
499 | '[Y/n] ','y')): | |
501 | return False |
|
500 | return False | |
502 | except EOFError: |
|
501 | except EOFError: | |
503 | return False |
|
502 | return False | |
504 |
|
503 | |||
505 | def int0(x): |
|
504 | def int0(x): | |
506 | try: |
|
505 | try: | |
507 | return int(x) |
|
506 | return int(x) | |
508 | except TypeError: |
|
507 | except TypeError: | |
509 | return 0 |
|
508 | return 0 | |
510 | # always pass integer line and offset values to editor hook |
|
509 | # always pass integer line and offset values to editor hook | |
511 | try: |
|
510 | try: | |
512 | self.hooks.fix_error_editor(e.filename, |
|
511 | self.hooks.fix_error_editor(e.filename, | |
513 | int0(e.lineno),int0(e.offset),e.msg) |
|
512 | int0(e.lineno),int0(e.offset),e.msg) | |
514 | except TryNext: |
|
513 | except TryNext: | |
515 | warn('Could not open editor') |
|
514 | warn('Could not open editor') | |
516 | return False |
|
515 | return False | |
517 | return True |
|
516 | return True | |
518 |
|
517 | |||
519 | #------------------------------------------------------------------------- |
|
518 | #------------------------------------------------------------------------- | |
520 | # Things related to GUI support and pylab |
|
519 | # Things related to GUI support and pylab | |
521 | #------------------------------------------------------------------------- |
|
520 | #------------------------------------------------------------------------- | |
522 |
|
521 | |||
523 |
def enable_ |
|
522 | def enable_gui(self, gui=None): | |
524 | """Activate pylab support at runtime. |
|
523 | from IPython.lib.inputhook import enable_gui | |
525 |
|
||||
526 | This turns on support for matplotlib, preloads into the interactive |
|
|||
527 | namespace all of numpy and pylab, and configures IPython to correcdtly |
|
|||
528 | interact with the GUI event loop. The GUI backend to be used can be |
|
|||
529 | optionally selected with the optional :param:`gui` argument. |
|
|||
530 |
|
||||
531 | Parameters |
|
|||
532 | ---------- |
|
|||
533 | gui : optional, string |
|
|||
534 |
|
||||
535 | If given, dictates the choice of matplotlib GUI backend to use |
|
|||
536 | (should be one of IPython's supported backends, 'tk', 'qt', 'wx' or |
|
|||
537 | 'gtk'), otherwise we use the default chosen by matplotlib (as |
|
|||
538 | dictated by the matplotlib build-time options plus the user's |
|
|||
539 | matplotlibrc configuration file). |
|
|||
540 | """ |
|
|||
541 | # We want to prevent the loading of pylab to pollute the user's |
|
|||
542 | # namespace as shown by the %who* magics, so we execute the activation |
|
|||
543 | # code in an empty namespace, and we update *both* user_ns and |
|
|||
544 | # user_ns_hidden with this information. |
|
|||
545 | ns = {} |
|
|||
546 | try: |
|
|||
547 | gui = pylab_activate(ns, gui, import_all) |
|
|||
548 | except KeyError: |
|
|||
549 | error("Backend %r not supported" % gui) |
|
|||
550 | return |
|
|||
551 | self.user_ns.update(ns) |
|
|||
552 | self.user_ns_hidden.update(ns) |
|
|||
553 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
|||
554 | # plot updates into account |
|
|||
555 | enable_gui(gui) |
|
524 | enable_gui(gui) | |
556 | self.magic_run = self._pylab_magic_run |
|
|||
557 |
|
525 | |||
558 | #------------------------------------------------------------------------- |
|
526 | #------------------------------------------------------------------------- | |
559 | # Things related to exiting |
|
527 | # Things related to exiting | |
560 | #------------------------------------------------------------------------- |
|
528 | #------------------------------------------------------------------------- | |
561 |
|
529 | |||
562 | def ask_exit(self): |
|
530 | def ask_exit(self): | |
563 | """ Ask the shell to exit. Can be overiden and used as a callback. """ |
|
531 | """ Ask the shell to exit. Can be overiden and used as a callback. """ | |
564 | self.exit_now = True |
|
532 | self.exit_now = True | |
565 |
|
533 | |||
566 | def exit(self): |
|
534 | def exit(self): | |
567 | """Handle interactive exit. |
|
535 | """Handle interactive exit. | |
568 |
|
536 | |||
569 | This method calls the ask_exit callback.""" |
|
537 | This method calls the ask_exit callback.""" | |
570 | if self.confirm_exit: |
|
538 | if self.confirm_exit: | |
571 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): |
|
539 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): | |
572 | self.ask_exit() |
|
540 | self.ask_exit() | |
573 | else: |
|
541 | else: | |
574 | self.ask_exit() |
|
542 | self.ask_exit() | |
575 |
|
543 | |||
576 | #------------------------------------------------------------------------ |
|
544 | #------------------------------------------------------------------------ | |
577 | # Magic overrides |
|
545 | # Magic overrides | |
578 | #------------------------------------------------------------------------ |
|
546 | #------------------------------------------------------------------------ | |
579 | # Once the base class stops inheriting from magic, this code needs to be |
|
547 | # Once the base class stops inheriting from magic, this code needs to be | |
580 | # moved into a separate machinery as well. For now, at least isolate here |
|
548 | # moved into a separate machinery as well. For now, at least isolate here | |
581 | # the magics which this class needs to implement differently from the base |
|
549 | # the magics which this class needs to implement differently from the base | |
582 | # class, or that are unique to it. |
|
550 | # class, or that are unique to it. | |
583 |
|
551 | |||
584 | def magic_autoindent(self, parameter_s = ''): |
|
552 | def magic_autoindent(self, parameter_s = ''): | |
585 | """Toggle autoindent on/off (if available).""" |
|
553 | """Toggle autoindent on/off (if available).""" | |
586 |
|
554 | |||
587 | self.shell.set_autoindent() |
|
555 | self.shell.set_autoindent() | |
588 | print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent] |
|
556 | print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent] | |
589 |
|
557 | |||
590 | @skip_doctest |
|
558 | @skip_doctest | |
591 | def magic_cpaste(self, parameter_s=''): |
|
559 | def magic_cpaste(self, parameter_s=''): | |
592 | """Paste & execute a pre-formatted code block from clipboard. |
|
560 | """Paste & execute a pre-formatted code block from clipboard. | |
593 |
|
561 | |||
594 | You must terminate the block with '--' (two minus-signs) or Ctrl-D |
|
562 | You must terminate the block with '--' (two minus-signs) or Ctrl-D | |
595 | alone on the line. You can also provide your own sentinel with '%paste |
|
563 | alone on the line. You can also provide your own sentinel with '%paste | |
596 | -s %%' ('%%' is the new sentinel for this operation) |
|
564 | -s %%' ('%%' is the new sentinel for this operation) | |
597 |
|
565 | |||
598 | The block is dedented prior to execution to enable execution of method |
|
566 | The block is dedented prior to execution to enable execution of method | |
599 | definitions. '>' and '+' characters at the beginning of a line are |
|
567 | definitions. '>' and '+' characters at the beginning of a line are | |
600 | ignored, to allow pasting directly from e-mails, diff files and |
|
568 | ignored, to allow pasting directly from e-mails, diff files and | |
601 | doctests (the '...' continuation prompt is also stripped). The |
|
569 | doctests (the '...' continuation prompt is also stripped). The | |
602 | executed block is also assigned to variable named 'pasted_block' for |
|
570 | executed block is also assigned to variable named 'pasted_block' for | |
603 | later editing with '%edit pasted_block'. |
|
571 | later editing with '%edit pasted_block'. | |
604 |
|
572 | |||
605 | You can also pass a variable name as an argument, e.g. '%cpaste foo'. |
|
573 | You can also pass a variable name as an argument, e.g. '%cpaste foo'. | |
606 | This assigns the pasted block to variable 'foo' as string, without |
|
574 | This assigns the pasted block to variable 'foo' as string, without | |
607 | dedenting or executing it (preceding >>> and + is still stripped) |
|
575 | dedenting or executing it (preceding >>> and + is still stripped) | |
608 |
|
576 | |||
609 | '%cpaste -r' re-executes the block previously entered by cpaste. |
|
577 | '%cpaste -r' re-executes the block previously entered by cpaste. | |
610 |
|
578 | |||
611 | Do not be alarmed by garbled output on Windows (it's a readline bug). |
|
579 | Do not be alarmed by garbled output on Windows (it's a readline bug). | |
612 | Just press enter and type -- (and press enter again) and the block |
|
580 | Just press enter and type -- (and press enter again) and the block | |
613 | will be what was just pasted. |
|
581 | will be what was just pasted. | |
614 |
|
582 | |||
615 | IPython statements (magics, shell escapes) are not supported (yet). |
|
583 | IPython statements (magics, shell escapes) are not supported (yet). | |
616 |
|
584 | |||
617 | See also |
|
585 | See also | |
618 | -------- |
|
586 | -------- | |
619 | paste: automatically pull code from clipboard. |
|
587 | paste: automatically pull code from clipboard. | |
620 |
|
588 | |||
621 | Examples |
|
589 | Examples | |
622 | -------- |
|
590 | -------- | |
623 | :: |
|
591 | :: | |
624 |
|
592 | |||
625 | In [8]: %cpaste |
|
593 | In [8]: %cpaste | |
626 | Pasting code; enter '--' alone on the line to stop. |
|
594 | Pasting code; enter '--' alone on the line to stop. | |
627 | :>>> a = ["world!", "Hello"] |
|
595 | :>>> a = ["world!", "Hello"] | |
628 | :>>> print " ".join(sorted(a)) |
|
596 | :>>> print " ".join(sorted(a)) | |
629 | :-- |
|
597 | :-- | |
630 | Hello world! |
|
598 | Hello world! | |
631 | """ |
|
599 | """ | |
632 |
|
600 | |||
633 | opts, name = self.parse_options(parameter_s, 'rs:', mode='string') |
|
601 | opts, name = self.parse_options(parameter_s, 'rs:', mode='string') | |
634 | if 'r' in opts: |
|
602 | if 'r' in opts: | |
635 | rerun_pasted(self.shell) |
|
603 | rerun_pasted(self.shell) | |
636 | return |
|
604 | return | |
637 |
|
605 | |||
638 | sentinel = opts.get('s', '--') |
|
606 | sentinel = opts.get('s', '--') | |
639 | block = strip_email_quotes(get_pasted_lines(sentinel)) |
|
607 | block = strip_email_quotes(get_pasted_lines(sentinel)) | |
640 | store_or_execute(self.shell, block, name) |
|
608 | store_or_execute(self.shell, block, name) | |
641 |
|
609 | |||
642 | def magic_paste(self, parameter_s=''): |
|
610 | def magic_paste(self, parameter_s=''): | |
643 | """Paste & execute a pre-formatted code block from clipboard. |
|
611 | """Paste & execute a pre-formatted code block from clipboard. | |
644 |
|
612 | |||
645 | The text is pulled directly from the clipboard without user |
|
613 | The text is pulled directly from the clipboard without user | |
646 | intervention and printed back on the screen before execution (unless |
|
614 | intervention and printed back on the screen before execution (unless | |
647 | the -q flag is given to force quiet mode). |
|
615 | the -q flag is given to force quiet mode). | |
648 |
|
616 | |||
649 | The block is dedented prior to execution to enable execution of method |
|
617 | The block is dedented prior to execution to enable execution of method | |
650 | definitions. '>' and '+' characters at the beginning of a line are |
|
618 | definitions. '>' and '+' characters at the beginning of a line are | |
651 | ignored, to allow pasting directly from e-mails, diff files and |
|
619 | ignored, to allow pasting directly from e-mails, diff files and | |
652 | doctests (the '...' continuation prompt is also stripped). The |
|
620 | doctests (the '...' continuation prompt is also stripped). The | |
653 | executed block is also assigned to variable named 'pasted_block' for |
|
621 | executed block is also assigned to variable named 'pasted_block' for | |
654 | later editing with '%edit pasted_block'. |
|
622 | later editing with '%edit pasted_block'. | |
655 |
|
623 | |||
656 | You can also pass a variable name as an argument, e.g. '%paste foo'. |
|
624 | You can also pass a variable name as an argument, e.g. '%paste foo'. | |
657 | This assigns the pasted block to variable 'foo' as string, without |
|
625 | This assigns the pasted block to variable 'foo' as string, without | |
658 | dedenting or executing it (preceding >>> and + is still stripped) |
|
626 | dedenting or executing it (preceding >>> and + is still stripped) | |
659 |
|
627 | |||
660 | Options |
|
628 | Options | |
661 | ------- |
|
629 | ------- | |
662 |
|
630 | |||
663 | -r: re-executes the block previously entered by cpaste. |
|
631 | -r: re-executes the block previously entered by cpaste. | |
664 |
|
632 | |||
665 | -q: quiet mode: do not echo the pasted text back to the terminal. |
|
633 | -q: quiet mode: do not echo the pasted text back to the terminal. | |
666 |
|
634 | |||
667 | IPython statements (magics, shell escapes) are not supported (yet). |
|
635 | IPython statements (magics, shell escapes) are not supported (yet). | |
668 |
|
636 | |||
669 | See also |
|
637 | See also | |
670 | -------- |
|
638 | -------- | |
671 | cpaste: manually paste code into terminal until you mark its end. |
|
639 | cpaste: manually paste code into terminal until you mark its end. | |
672 | """ |
|
640 | """ | |
673 | opts, name = self.parse_options(parameter_s, 'rq', mode='string') |
|
641 | opts, name = self.parse_options(parameter_s, 'rq', mode='string') | |
674 | if 'r' in opts: |
|
642 | if 'r' in opts: | |
675 | rerun_pasted(self.shell) |
|
643 | rerun_pasted(self.shell) | |
676 | return |
|
644 | return | |
677 | try: |
|
645 | try: | |
678 | text = self.shell.hooks.clipboard_get() |
|
646 | text = self.shell.hooks.clipboard_get() | |
679 | block = strip_email_quotes(text.splitlines()) |
|
647 | block = strip_email_quotes(text.splitlines()) | |
680 | except TryNext as clipboard_exc: |
|
648 | except TryNext as clipboard_exc: | |
681 | message = getattr(clipboard_exc, 'args') |
|
649 | message = getattr(clipboard_exc, 'args') | |
682 | if message: |
|
650 | if message: | |
683 | error(message[0]) |
|
651 | error(message[0]) | |
684 | else: |
|
652 | else: | |
685 | error('Could not get text from the clipboard.') |
|
653 | error('Could not get text from the clipboard.') | |
686 | return |
|
654 | return | |
687 |
|
655 | |||
688 | # By default, echo back to terminal unless quiet mode is requested |
|
656 | # By default, echo back to terminal unless quiet mode is requested | |
689 | if 'q' not in opts: |
|
657 | if 'q' not in opts: | |
690 | write = self.shell.write |
|
658 | write = self.shell.write | |
691 | write(self.shell.pycolorize(block)) |
|
659 | write(self.shell.pycolorize(block)) | |
692 | if not block.endswith('\n'): |
|
660 | if not block.endswith('\n'): | |
693 | write('\n') |
|
661 | write('\n') | |
694 | write("## -- End pasted text --\n") |
|
662 | write("## -- End pasted text --\n") | |
695 |
|
663 | |||
696 | store_or_execute(self.shell, block, name) |
|
664 | store_or_execute(self.shell, block, name) | |
697 |
|
665 | |||
698 | # Class-level: add a '%cls' magic only on Windows |
|
666 | # Class-level: add a '%cls' magic only on Windows | |
699 | if sys.platform == 'win32': |
|
667 | if sys.platform == 'win32': | |
700 | def magic_cls(self, s): |
|
668 | def magic_cls(self, s): | |
701 | """Clear screen. |
|
669 | """Clear screen. | |
702 | """ |
|
670 | """ | |
703 | os.system("cls") |
|
671 | os.system("cls") | |
704 |
|
672 | |||
705 | def showindentationerror(self): |
|
673 | def showindentationerror(self): | |
706 | super(TerminalInteractiveShell, self).showindentationerror() |
|
674 | super(TerminalInteractiveShell, self).showindentationerror() | |
707 | print("If you want to paste code into IPython, try the " |
|
675 | print("If you want to paste code into IPython, try the " | |
708 | "%paste and %cpaste magic functions.") |
|
676 | "%paste and %cpaste magic functions.") | |
709 |
|
677 | |||
710 |
|
678 | |||
711 | InteractiveShellABC.register(TerminalInteractiveShell) |
|
679 | InteractiveShellABC.register(TerminalInteractiveShell) |
@@ -1,814 +1,815 b'' | |||||
1 | #!/usr/bin/env python |
|
1 | #!/usr/bin/env python | |
2 | """A simple interactive kernel that talks to a frontend over 0MQ. |
|
2 | """A simple interactive kernel that talks to a frontend over 0MQ. | |
3 |
|
3 | |||
4 | Things to do: |
|
4 | Things to do: | |
5 |
|
5 | |||
6 | * Implement `set_parent` logic. Right before doing exec, the Kernel should |
|
6 | * Implement `set_parent` logic. Right before doing exec, the Kernel should | |
7 | call set_parent on all the PUB objects with the message about to be executed. |
|
7 | call set_parent on all the PUB objects with the message about to be executed. | |
8 | * Implement random port and security key logic. |
|
8 | * Implement random port and security key logic. | |
9 | * Implement control messages. |
|
9 | * Implement control messages. | |
10 | * Implement event loop and poll version. |
|
10 | * Implement event loop and poll version. | |
11 | """ |
|
11 | """ | |
12 |
|
12 | |||
13 | #----------------------------------------------------------------------------- |
|
13 | #----------------------------------------------------------------------------- | |
14 | # Imports |
|
14 | # Imports | |
15 | #----------------------------------------------------------------------------- |
|
15 | #----------------------------------------------------------------------------- | |
16 | from __future__ import print_function |
|
16 | from __future__ import print_function | |
17 |
|
17 | |||
18 | # Standard library imports. |
|
18 | # Standard library imports. | |
19 | import __builtin__ |
|
19 | import __builtin__ | |
20 | import atexit |
|
20 | import atexit | |
21 | import sys |
|
21 | import sys | |
22 | import time |
|
22 | import time | |
23 | import traceback |
|
23 | import traceback | |
24 | import logging |
|
24 | import logging | |
25 |
|
25 | |||
26 | # System library imports. |
|
26 | # System library imports. | |
27 | import zmq |
|
27 | import zmq | |
28 |
|
28 | |||
29 | # Local imports. |
|
29 | # Local imports. | |
30 | from IPython.config.configurable import Configurable |
|
30 | from IPython.config.configurable import Configurable | |
31 | from IPython.config.application import boolean_flag, catch_config_error |
|
31 | from IPython.config.application import boolean_flag, catch_config_error | |
32 | from IPython.core.application import ProfileDir |
|
32 | from IPython.core.application import ProfileDir | |
33 | from IPython.core.error import StdinNotImplementedError |
|
33 | from IPython.core.error import StdinNotImplementedError | |
34 | from IPython.core.shellapp import ( |
|
34 | from IPython.core.shellapp import ( | |
35 | InteractiveShellApp, shell_flags, shell_aliases |
|
35 | InteractiveShellApp, shell_flags, shell_aliases | |
36 | ) |
|
36 | ) | |
37 | from IPython.utils import io |
|
37 | from IPython.utils import io | |
38 | from IPython.utils import py3compat |
|
38 | from IPython.utils import py3compat | |
39 | from IPython.utils.jsonutil import json_clean |
|
39 | from IPython.utils.jsonutil import json_clean | |
40 | from IPython.lib import pylabtools |
|
40 | from IPython.lib import pylabtools | |
41 | from IPython.utils.traitlets import ( |
|
41 | from IPython.utils.traitlets import ( | |
42 | Any, List, Instance, Float, Dict, Bool, Unicode, CaselessStrEnum |
|
42 | Any, List, Instance, Float, Dict, Bool, Unicode, CaselessStrEnum | |
43 | ) |
|
43 | ) | |
44 |
|
44 | |||
45 | from entry_point import base_launch_kernel |
|
45 | from entry_point import base_launch_kernel | |
46 | from kernelapp import KernelApp, kernel_flags, kernel_aliases |
|
46 | from kernelapp import KernelApp, kernel_flags, kernel_aliases | |
47 | from iostream import OutStream |
|
47 | from iostream import OutStream | |
48 | from session import Session, Message |
|
48 | from session import Session, Message | |
49 | from zmqshell import ZMQInteractiveShell |
|
49 | from zmqshell import ZMQInteractiveShell | |
50 |
|
50 | |||
51 |
|
51 | |||
52 | #----------------------------------------------------------------------------- |
|
52 | #----------------------------------------------------------------------------- | |
53 | # Main kernel class |
|
53 | # Main kernel class | |
54 | #----------------------------------------------------------------------------- |
|
54 | #----------------------------------------------------------------------------- | |
55 |
|
55 | |||
56 | class Kernel(Configurable): |
|
56 | class Kernel(Configurable): | |
57 |
|
57 | |||
58 | #--------------------------------------------------------------------------- |
|
58 | #--------------------------------------------------------------------------- | |
59 | # Kernel interface |
|
59 | # Kernel interface | |
60 | #--------------------------------------------------------------------------- |
|
60 | #--------------------------------------------------------------------------- | |
61 |
|
61 | |||
62 | # attribute to override with a GUI |
|
62 | # attribute to override with a GUI | |
63 | eventloop = Any(None) |
|
63 | eventloop = Any(None) | |
64 |
|
64 | |||
65 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') |
|
65 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') | |
66 | session = Instance(Session) |
|
66 | session = Instance(Session) | |
67 | profile_dir = Instance('IPython.core.profiledir.ProfileDir') |
|
67 | profile_dir = Instance('IPython.core.profiledir.ProfileDir') | |
68 | shell_socket = Instance('zmq.Socket') |
|
68 | shell_socket = Instance('zmq.Socket') | |
69 | iopub_socket = Instance('zmq.Socket') |
|
69 | iopub_socket = Instance('zmq.Socket') | |
70 | stdin_socket = Instance('zmq.Socket') |
|
70 | stdin_socket = Instance('zmq.Socket') | |
71 | log = Instance(logging.Logger) |
|
71 | log = Instance(logging.Logger) | |
72 |
|
72 | |||
73 | # Private interface |
|
73 | # Private interface | |
74 |
|
74 | |||
75 | # Time to sleep after flushing the stdout/err buffers in each execute |
|
75 | # Time to sleep after flushing the stdout/err buffers in each execute | |
76 | # cycle. While this introduces a hard limit on the minimal latency of the |
|
76 | # cycle. While this introduces a hard limit on the minimal latency of the | |
77 | # execute cycle, it helps prevent output synchronization problems for |
|
77 | # execute cycle, it helps prevent output synchronization problems for | |
78 | # clients. |
|
78 | # clients. | |
79 | # Units are in seconds. The minimum zmq latency on local host is probably |
|
79 | # Units are in seconds. The minimum zmq latency on local host is probably | |
80 | # ~150 microseconds, set this to 500us for now. We may need to increase it |
|
80 | # ~150 microseconds, set this to 500us for now. We may need to increase it | |
81 | # a little if it's not enough after more interactive testing. |
|
81 | # a little if it's not enough after more interactive testing. | |
82 | _execute_sleep = Float(0.0005, config=True) |
|
82 | _execute_sleep = Float(0.0005, config=True) | |
83 |
|
83 | |||
84 | # Frequency of the kernel's event loop. |
|
84 | # Frequency of the kernel's event loop. | |
85 | # Units are in seconds, kernel subclasses for GUI toolkits may need to |
|
85 | # Units are in seconds, kernel subclasses for GUI toolkits may need to | |
86 | # adapt to milliseconds. |
|
86 | # adapt to milliseconds. | |
87 | _poll_interval = Float(0.05, config=True) |
|
87 | _poll_interval = Float(0.05, config=True) | |
88 |
|
88 | |||
89 | # If the shutdown was requested over the network, we leave here the |
|
89 | # If the shutdown was requested over the network, we leave here the | |
90 | # necessary reply message so it can be sent by our registered atexit |
|
90 | # necessary reply message so it can be sent by our registered atexit | |
91 | # handler. This ensures that the reply is only sent to clients truly at |
|
91 | # handler. This ensures that the reply is only sent to clients truly at | |
92 | # the end of our shutdown process (which happens after the underlying |
|
92 | # the end of our shutdown process (which happens after the underlying | |
93 | # IPython shell's own shutdown). |
|
93 | # IPython shell's own shutdown). | |
94 | _shutdown_message = None |
|
94 | _shutdown_message = None | |
95 |
|
95 | |||
96 | # This is a dict of port number that the kernel is listening on. It is set |
|
96 | # This is a dict of port number that the kernel is listening on. It is set | |
97 | # by record_ports and used by connect_request. |
|
97 | # by record_ports and used by connect_request. | |
98 | _recorded_ports = Dict() |
|
98 | _recorded_ports = Dict() | |
99 |
|
99 | |||
100 |
|
100 | |||
101 |
|
101 | |||
102 | def __init__(self, **kwargs): |
|
102 | def __init__(self, **kwargs): | |
103 | super(Kernel, self).__init__(**kwargs) |
|
103 | super(Kernel, self).__init__(**kwargs) | |
104 |
|
104 | |||
105 | # Before we even start up the shell, register *first* our exit handlers |
|
105 | # Before we even start up the shell, register *first* our exit handlers | |
106 | # so they come before the shell's |
|
106 | # so they come before the shell's | |
107 | atexit.register(self._at_shutdown) |
|
107 | atexit.register(self._at_shutdown) | |
108 |
|
108 | |||
109 | # Initialize the InteractiveShell subclass |
|
109 | # Initialize the InteractiveShell subclass | |
110 | self.shell = ZMQInteractiveShell.instance(config=self.config, |
|
110 | self.shell = ZMQInteractiveShell.instance(config=self.config, | |
111 | profile_dir = self.profile_dir, |
|
111 | profile_dir = self.profile_dir, | |
112 | ) |
|
112 | ) | |
113 | self.shell.displayhook.session = self.session |
|
113 | self.shell.displayhook.session = self.session | |
114 | self.shell.displayhook.pub_socket = self.iopub_socket |
|
114 | self.shell.displayhook.pub_socket = self.iopub_socket | |
115 | self.shell.display_pub.session = self.session |
|
115 | self.shell.display_pub.session = self.session | |
116 | self.shell.display_pub.pub_socket = self.iopub_socket |
|
116 | self.shell.display_pub.pub_socket = self.iopub_socket | |
117 |
|
117 | |||
118 | # TMP - hack while developing |
|
118 | # TMP - hack while developing | |
119 | self.shell._reply_content = None |
|
119 | self.shell._reply_content = None | |
120 |
|
120 | |||
121 | # Build dict of handlers for message types |
|
121 | # Build dict of handlers for message types | |
122 | msg_types = [ 'execute_request', 'complete_request', |
|
122 | msg_types = [ 'execute_request', 'complete_request', | |
123 | 'object_info_request', 'history_request', |
|
123 | 'object_info_request', 'history_request', | |
124 | 'connect_request', 'shutdown_request'] |
|
124 | 'connect_request', 'shutdown_request'] | |
125 | self.handlers = {} |
|
125 | self.handlers = {} | |
126 | for msg_type in msg_types: |
|
126 | for msg_type in msg_types: | |
127 | self.handlers[msg_type] = getattr(self, msg_type) |
|
127 | self.handlers[msg_type] = getattr(self, msg_type) | |
128 |
|
128 | |||
129 | def do_one_iteration(self): |
|
129 | def do_one_iteration(self): | |
130 | """Do one iteration of the kernel's evaluation loop. |
|
130 | """Do one iteration of the kernel's evaluation loop. | |
131 | """ |
|
131 | """ | |
132 | try: |
|
132 | try: | |
133 | ident,msg = self.session.recv(self.shell_socket, zmq.NOBLOCK) |
|
133 | ident,msg = self.session.recv(self.shell_socket, zmq.NOBLOCK) | |
134 | except Exception: |
|
134 | except Exception: | |
135 | self.log.warn("Invalid Message:", exc_info=True) |
|
135 | self.log.warn("Invalid Message:", exc_info=True) | |
136 | return |
|
136 | return | |
137 | if msg is None: |
|
137 | if msg is None: | |
138 | return |
|
138 | return | |
139 |
|
139 | |||
140 | msg_type = msg['header']['msg_type'] |
|
140 | msg_type = msg['header']['msg_type'] | |
141 |
|
141 | |||
142 | # This assert will raise in versions of zeromq 2.0.7 and lesser. |
|
142 | # This assert will raise in versions of zeromq 2.0.7 and lesser. | |
143 | # We now require 2.0.8 or above, so we can uncomment for safety. |
|
143 | # We now require 2.0.8 or above, so we can uncomment for safety. | |
144 | # print(ident,msg, file=sys.__stdout__) |
|
144 | # print(ident,msg, file=sys.__stdout__) | |
145 | assert ident is not None, "Missing message part." |
|
145 | assert ident is not None, "Missing message part." | |
146 |
|
146 | |||
147 | # Print some info about this message and leave a '--->' marker, so it's |
|
147 | # Print some info about this message and leave a '--->' marker, so it's | |
148 | # easier to trace visually the message chain when debugging. Each |
|
148 | # easier to trace visually the message chain when debugging. Each | |
149 | # handler prints its message at the end. |
|
149 | # handler prints its message at the end. | |
150 | self.log.debug('\n*** MESSAGE TYPE:'+str(msg_type)+'***') |
|
150 | self.log.debug('\n*** MESSAGE TYPE:'+str(msg_type)+'***') | |
151 | self.log.debug(' Content: '+str(msg['content'])+'\n --->\n ') |
|
151 | self.log.debug(' Content: '+str(msg['content'])+'\n --->\n ') | |
152 |
|
152 | |||
153 | # Find and call actual handler for message |
|
153 | # Find and call actual handler for message | |
154 | handler = self.handlers.get(msg_type, None) |
|
154 | handler = self.handlers.get(msg_type, None) | |
155 | if handler is None: |
|
155 | if handler is None: | |
156 | self.log.error("UNKNOWN MESSAGE TYPE:" +str(msg)) |
|
156 | self.log.error("UNKNOWN MESSAGE TYPE:" +str(msg)) | |
157 | else: |
|
157 | else: | |
158 | handler(ident, msg) |
|
158 | handler(ident, msg) | |
159 |
|
159 | |||
160 | # Check whether we should exit, in case the incoming message set the |
|
160 | # Check whether we should exit, in case the incoming message set the | |
161 | # exit flag on |
|
161 | # exit flag on | |
162 | if self.shell.exit_now: |
|
162 | if self.shell.exit_now: | |
163 | self.log.debug('\nExiting IPython kernel...') |
|
163 | self.log.debug('\nExiting IPython kernel...') | |
164 | # We do a normal, clean exit, which allows any actions registered |
|
164 | # We do a normal, clean exit, which allows any actions registered | |
165 | # via atexit (such as history saving) to take place. |
|
165 | # via atexit (such as history saving) to take place. | |
166 | sys.exit(0) |
|
166 | sys.exit(0) | |
167 |
|
167 | |||
168 |
|
168 | |||
169 | def start(self): |
|
169 | def start(self): | |
170 | """ Start the kernel main loop. |
|
170 | """ Start the kernel main loop. | |
171 | """ |
|
171 | """ | |
172 | poller = zmq.Poller() |
|
172 | poller = zmq.Poller() | |
173 | poller.register(self.shell_socket, zmq.POLLIN) |
|
173 | poller.register(self.shell_socket, zmq.POLLIN) | |
174 | # loop while self.eventloop has not been overridden |
|
174 | # loop while self.eventloop has not been overridden | |
175 | while self.eventloop is None: |
|
175 | while self.eventloop is None: | |
176 | try: |
|
176 | try: | |
177 | # scale by extra factor of 10, because there is no |
|
177 | # scale by extra factor of 10, because there is no | |
178 | # reason for this to be anything less than ~ 0.1s |
|
178 | # reason for this to be anything less than ~ 0.1s | |
179 | # since it is a real poller and will respond |
|
179 | # since it is a real poller and will respond | |
180 | # to events immediately |
|
180 | # to events immediately | |
181 |
|
181 | |||
182 | # double nested try/except, to properly catch KeyboardInterrupt |
|
182 | # double nested try/except, to properly catch KeyboardInterrupt | |
183 | # due to pyzmq Issue #130 |
|
183 | # due to pyzmq Issue #130 | |
184 | try: |
|
184 | try: | |
185 | poller.poll(10*1000*self._poll_interval) |
|
185 | poller.poll(10*1000*self._poll_interval) | |
186 | self.do_one_iteration() |
|
186 | self.do_one_iteration() | |
187 | except: |
|
187 | except: | |
188 | raise |
|
188 | raise | |
189 | except KeyboardInterrupt: |
|
189 | except KeyboardInterrupt: | |
190 | # Ctrl-C shouldn't crash the kernel |
|
190 | # Ctrl-C shouldn't crash the kernel | |
191 | io.raw_print("KeyboardInterrupt caught in kernel") |
|
191 | io.raw_print("KeyboardInterrupt caught in kernel") | |
192 | if self.eventloop is not None: |
|
192 | if self.eventloop is not None: | |
193 | try: |
|
193 | try: | |
194 | self.eventloop(self) |
|
194 | self.eventloop(self) | |
195 | except KeyboardInterrupt: |
|
195 | except KeyboardInterrupt: | |
196 | # Ctrl-C shouldn't crash the kernel |
|
196 | # Ctrl-C shouldn't crash the kernel | |
197 | io.raw_print("KeyboardInterrupt caught in kernel") |
|
197 | io.raw_print("KeyboardInterrupt caught in kernel") | |
198 |
|
198 | |||
199 |
|
199 | |||
200 | def record_ports(self, ports): |
|
200 | def record_ports(self, ports): | |
201 | """Record the ports that this kernel is using. |
|
201 | """Record the ports that this kernel is using. | |
202 |
|
202 | |||
203 | The creator of the Kernel instance must call this methods if they |
|
203 | The creator of the Kernel instance must call this methods if they | |
204 | want the :meth:`connect_request` method to return the port numbers. |
|
204 | want the :meth:`connect_request` method to return the port numbers. | |
205 | """ |
|
205 | """ | |
206 | self._recorded_ports = ports |
|
206 | self._recorded_ports = ports | |
207 |
|
207 | |||
208 | #--------------------------------------------------------------------------- |
|
208 | #--------------------------------------------------------------------------- | |
209 | # Kernel request handlers |
|
209 | # Kernel request handlers | |
210 | #--------------------------------------------------------------------------- |
|
210 | #--------------------------------------------------------------------------- | |
211 |
|
211 | |||
212 | def _publish_pyin(self, code, parent): |
|
212 | def _publish_pyin(self, code, parent): | |
213 | """Publish the code request on the pyin stream.""" |
|
213 | """Publish the code request on the pyin stream.""" | |
214 |
|
214 | |||
215 | pyin_msg = self.session.send(self.iopub_socket, u'pyin',{u'code':code}, parent=parent) |
|
215 | pyin_msg = self.session.send(self.iopub_socket, u'pyin',{u'code':code}, parent=parent) | |
216 |
|
216 | |||
217 | def execute_request(self, ident, parent): |
|
217 | def execute_request(self, ident, parent): | |
218 |
|
218 | |||
219 | status_msg = self.session.send(self.iopub_socket, |
|
219 | status_msg = self.session.send(self.iopub_socket, | |
220 | u'status', |
|
220 | u'status', | |
221 | {u'execution_state':u'busy'}, |
|
221 | {u'execution_state':u'busy'}, | |
222 | parent=parent |
|
222 | parent=parent | |
223 | ) |
|
223 | ) | |
224 |
|
224 | |||
225 | try: |
|
225 | try: | |
226 | content = parent[u'content'] |
|
226 | content = parent[u'content'] | |
227 | code = content[u'code'] |
|
227 | code = content[u'code'] | |
228 | silent = content[u'silent'] |
|
228 | silent = content[u'silent'] | |
229 | except: |
|
229 | except: | |
230 | self.log.error("Got bad msg: ") |
|
230 | self.log.error("Got bad msg: ") | |
231 | self.log.error(str(Message(parent))) |
|
231 | self.log.error(str(Message(parent))) | |
232 | return |
|
232 | return | |
233 |
|
233 | |||
234 | shell = self.shell # we'll need this a lot here |
|
234 | shell = self.shell # we'll need this a lot here | |
235 |
|
235 | |||
236 | # Replace raw_input. Note that is not sufficient to replace |
|
236 | # Replace raw_input. Note that is not sufficient to replace | |
237 | # raw_input in the user namespace. |
|
237 | # raw_input in the user namespace. | |
238 | if content.get('allow_stdin', False): |
|
238 | if content.get('allow_stdin', False): | |
239 | raw_input = lambda prompt='': self._raw_input(prompt, ident, parent) |
|
239 | raw_input = lambda prompt='': self._raw_input(prompt, ident, parent) | |
240 | else: |
|
240 | else: | |
241 | raw_input = lambda prompt='' : self._no_raw_input() |
|
241 | raw_input = lambda prompt='' : self._no_raw_input() | |
242 |
|
242 | |||
243 | if py3compat.PY3: |
|
243 | if py3compat.PY3: | |
244 | __builtin__.input = raw_input |
|
244 | __builtin__.input = raw_input | |
245 | else: |
|
245 | else: | |
246 | __builtin__.raw_input = raw_input |
|
246 | __builtin__.raw_input = raw_input | |
247 |
|
247 | |||
248 | # Set the parent message of the display hook and out streams. |
|
248 | # Set the parent message of the display hook and out streams. | |
249 | shell.displayhook.set_parent(parent) |
|
249 | shell.displayhook.set_parent(parent) | |
250 | shell.display_pub.set_parent(parent) |
|
250 | shell.display_pub.set_parent(parent) | |
251 | sys.stdout.set_parent(parent) |
|
251 | sys.stdout.set_parent(parent) | |
252 | sys.stderr.set_parent(parent) |
|
252 | sys.stderr.set_parent(parent) | |
253 |
|
253 | |||
254 | # Re-broadcast our input for the benefit of listening clients, and |
|
254 | # Re-broadcast our input for the benefit of listening clients, and | |
255 | # start computing output |
|
255 | # start computing output | |
256 | if not silent: |
|
256 | if not silent: | |
257 | self._publish_pyin(code, parent) |
|
257 | self._publish_pyin(code, parent) | |
258 |
|
258 | |||
259 | reply_content = {} |
|
259 | reply_content = {} | |
260 | try: |
|
260 | try: | |
261 | if silent: |
|
261 | if silent: | |
262 | # run_code uses 'exec' mode, so no displayhook will fire, and it |
|
262 | # run_code uses 'exec' mode, so no displayhook will fire, and it | |
263 | # doesn't call logging or history manipulations. Print |
|
263 | # doesn't call logging or history manipulations. Print | |
264 | # statements in that code will obviously still execute. |
|
264 | # statements in that code will obviously still execute. | |
265 | shell.run_code(code) |
|
265 | shell.run_code(code) | |
266 | else: |
|
266 | else: | |
267 | # FIXME: the shell calls the exception handler itself. |
|
267 | # FIXME: the shell calls the exception handler itself. | |
268 | shell.run_cell(code, store_history=True) |
|
268 | shell.run_cell(code, store_history=True) | |
269 | except: |
|
269 | except: | |
270 | status = u'error' |
|
270 | status = u'error' | |
271 | # FIXME: this code right now isn't being used yet by default, |
|
271 | # FIXME: this code right now isn't being used yet by default, | |
272 | # because the run_cell() call above directly fires off exception |
|
272 | # because the run_cell() call above directly fires off exception | |
273 | # reporting. This code, therefore, is only active in the scenario |
|
273 | # reporting. This code, therefore, is only active in the scenario | |
274 | # where runlines itself has an unhandled exception. We need to |
|
274 | # where runlines itself has an unhandled exception. We need to | |
275 | # uniformize this, for all exception construction to come from a |
|
275 | # uniformize this, for all exception construction to come from a | |
276 | # single location in the codbase. |
|
276 | # single location in the codbase. | |
277 | etype, evalue, tb = sys.exc_info() |
|
277 | etype, evalue, tb = sys.exc_info() | |
278 | tb_list = traceback.format_exception(etype, evalue, tb) |
|
278 | tb_list = traceback.format_exception(etype, evalue, tb) | |
279 | reply_content.update(shell._showtraceback(etype, evalue, tb_list)) |
|
279 | reply_content.update(shell._showtraceback(etype, evalue, tb_list)) | |
280 | else: |
|
280 | else: | |
281 | status = u'ok' |
|
281 | status = u'ok' | |
282 |
|
282 | |||
283 | reply_content[u'status'] = status |
|
283 | reply_content[u'status'] = status | |
284 |
|
284 | |||
285 | # Return the execution counter so clients can display prompts |
|
285 | # Return the execution counter so clients can display prompts | |
286 | reply_content['execution_count'] = shell.execution_count -1 |
|
286 | reply_content['execution_count'] = shell.execution_count -1 | |
287 |
|
287 | |||
288 | # FIXME - fish exception info out of shell, possibly left there by |
|
288 | # FIXME - fish exception info out of shell, possibly left there by | |
289 | # runlines. We'll need to clean up this logic later. |
|
289 | # runlines. We'll need to clean up this logic later. | |
290 | if shell._reply_content is not None: |
|
290 | if shell._reply_content is not None: | |
291 | reply_content.update(shell._reply_content) |
|
291 | reply_content.update(shell._reply_content) | |
292 | # reset after use |
|
292 | # reset after use | |
293 | shell._reply_content = None |
|
293 | shell._reply_content = None | |
294 |
|
294 | |||
295 | # At this point, we can tell whether the main code execution succeeded |
|
295 | # At this point, we can tell whether the main code execution succeeded | |
296 | # or not. If it did, we proceed to evaluate user_variables/expressions |
|
296 | # or not. If it did, we proceed to evaluate user_variables/expressions | |
297 | if reply_content['status'] == 'ok': |
|
297 | if reply_content['status'] == 'ok': | |
298 | reply_content[u'user_variables'] = \ |
|
298 | reply_content[u'user_variables'] = \ | |
299 | shell.user_variables(content[u'user_variables']) |
|
299 | shell.user_variables(content[u'user_variables']) | |
300 | reply_content[u'user_expressions'] = \ |
|
300 | reply_content[u'user_expressions'] = \ | |
301 | shell.user_expressions(content[u'user_expressions']) |
|
301 | shell.user_expressions(content[u'user_expressions']) | |
302 | else: |
|
302 | else: | |
303 | # If there was an error, don't even try to compute variables or |
|
303 | # If there was an error, don't even try to compute variables or | |
304 | # expressions |
|
304 | # expressions | |
305 | reply_content[u'user_variables'] = {} |
|
305 | reply_content[u'user_variables'] = {} | |
306 | reply_content[u'user_expressions'] = {} |
|
306 | reply_content[u'user_expressions'] = {} | |
307 |
|
307 | |||
308 | # Payloads should be retrieved regardless of outcome, so we can both |
|
308 | # Payloads should be retrieved regardless of outcome, so we can both | |
309 | # recover partial output (that could have been generated early in a |
|
309 | # recover partial output (that could have been generated early in a | |
310 | # block, before an error) and clear the payload system always. |
|
310 | # block, before an error) and clear the payload system always. | |
311 | reply_content[u'payload'] = shell.payload_manager.read_payload() |
|
311 | reply_content[u'payload'] = shell.payload_manager.read_payload() | |
312 | # Be agressive about clearing the payload because we don't want |
|
312 | # Be agressive about clearing the payload because we don't want | |
313 | # it to sit in memory until the next execute_request comes in. |
|
313 | # it to sit in memory until the next execute_request comes in. | |
314 | shell.payload_manager.clear_payload() |
|
314 | shell.payload_manager.clear_payload() | |
315 |
|
315 | |||
316 | # Flush output before sending the reply. |
|
316 | # Flush output before sending the reply. | |
317 | sys.stdout.flush() |
|
317 | sys.stdout.flush() | |
318 | sys.stderr.flush() |
|
318 | sys.stderr.flush() | |
319 | # FIXME: on rare occasions, the flush doesn't seem to make it to the |
|
319 | # FIXME: on rare occasions, the flush doesn't seem to make it to the | |
320 | # clients... This seems to mitigate the problem, but we definitely need |
|
320 | # clients... This seems to mitigate the problem, but we definitely need | |
321 | # to better understand what's going on. |
|
321 | # to better understand what's going on. | |
322 | if self._execute_sleep: |
|
322 | if self._execute_sleep: | |
323 | time.sleep(self._execute_sleep) |
|
323 | time.sleep(self._execute_sleep) | |
324 |
|
324 | |||
325 | # Send the reply. |
|
325 | # Send the reply. | |
326 | reply_content = json_clean(reply_content) |
|
326 | reply_content = json_clean(reply_content) | |
327 | reply_msg = self.session.send(self.shell_socket, u'execute_reply', |
|
327 | reply_msg = self.session.send(self.shell_socket, u'execute_reply', | |
328 | reply_content, parent, ident=ident) |
|
328 | reply_content, parent, ident=ident) | |
329 | self.log.debug(str(reply_msg)) |
|
329 | self.log.debug(str(reply_msg)) | |
330 |
|
330 | |||
331 | if reply_msg['content']['status'] == u'error': |
|
331 | if reply_msg['content']['status'] == u'error': | |
332 | self._abort_queue() |
|
332 | self._abort_queue() | |
333 |
|
333 | |||
334 | status_msg = self.session.send(self.iopub_socket, |
|
334 | status_msg = self.session.send(self.iopub_socket, | |
335 | u'status', |
|
335 | u'status', | |
336 | {u'execution_state':u'idle'}, |
|
336 | {u'execution_state':u'idle'}, | |
337 | parent=parent |
|
337 | parent=parent | |
338 | ) |
|
338 | ) | |
339 |
|
339 | |||
340 | def complete_request(self, ident, parent): |
|
340 | def complete_request(self, ident, parent): | |
341 | txt, matches = self._complete(parent) |
|
341 | txt, matches = self._complete(parent) | |
342 | matches = {'matches' : matches, |
|
342 | matches = {'matches' : matches, | |
343 | 'matched_text' : txt, |
|
343 | 'matched_text' : txt, | |
344 | 'status' : 'ok'} |
|
344 | 'status' : 'ok'} | |
345 | matches = json_clean(matches) |
|
345 | matches = json_clean(matches) | |
346 | completion_msg = self.session.send(self.shell_socket, 'complete_reply', |
|
346 | completion_msg = self.session.send(self.shell_socket, 'complete_reply', | |
347 | matches, parent, ident) |
|
347 | matches, parent, ident) | |
348 | self.log.debug(str(completion_msg)) |
|
348 | self.log.debug(str(completion_msg)) | |
349 |
|
349 | |||
350 | def object_info_request(self, ident, parent): |
|
350 | def object_info_request(self, ident, parent): | |
351 | object_info = self.shell.object_inspect(parent['content']['oname']) |
|
351 | object_info = self.shell.object_inspect(parent['content']['oname']) | |
352 | # Before we send this object over, we scrub it for JSON usage |
|
352 | # Before we send this object over, we scrub it for JSON usage | |
353 | oinfo = json_clean(object_info) |
|
353 | oinfo = json_clean(object_info) | |
354 | msg = self.session.send(self.shell_socket, 'object_info_reply', |
|
354 | msg = self.session.send(self.shell_socket, 'object_info_reply', | |
355 | oinfo, parent, ident) |
|
355 | oinfo, parent, ident) | |
356 | self.log.debug(msg) |
|
356 | self.log.debug(msg) | |
357 |
|
357 | |||
358 | def history_request(self, ident, parent): |
|
358 | def history_request(self, ident, parent): | |
359 | # We need to pull these out, as passing **kwargs doesn't work with |
|
359 | # We need to pull these out, as passing **kwargs doesn't work with | |
360 | # unicode keys before Python 2.6.5. |
|
360 | # unicode keys before Python 2.6.5. | |
361 | hist_access_type = parent['content']['hist_access_type'] |
|
361 | hist_access_type = parent['content']['hist_access_type'] | |
362 | raw = parent['content']['raw'] |
|
362 | raw = parent['content']['raw'] | |
363 | output = parent['content']['output'] |
|
363 | output = parent['content']['output'] | |
364 | if hist_access_type == 'tail': |
|
364 | if hist_access_type == 'tail': | |
365 | n = parent['content']['n'] |
|
365 | n = parent['content']['n'] | |
366 | hist = self.shell.history_manager.get_tail(n, raw=raw, output=output, |
|
366 | hist = self.shell.history_manager.get_tail(n, raw=raw, output=output, | |
367 | include_latest=True) |
|
367 | include_latest=True) | |
368 |
|
368 | |||
369 | elif hist_access_type == 'range': |
|
369 | elif hist_access_type == 'range': | |
370 | session = parent['content']['session'] |
|
370 | session = parent['content']['session'] | |
371 | start = parent['content']['start'] |
|
371 | start = parent['content']['start'] | |
372 | stop = parent['content']['stop'] |
|
372 | stop = parent['content']['stop'] | |
373 | hist = self.shell.history_manager.get_range(session, start, stop, |
|
373 | hist = self.shell.history_manager.get_range(session, start, stop, | |
374 | raw=raw, output=output) |
|
374 | raw=raw, output=output) | |
375 |
|
375 | |||
376 | elif hist_access_type == 'search': |
|
376 | elif hist_access_type == 'search': | |
377 | pattern = parent['content']['pattern'] |
|
377 | pattern = parent['content']['pattern'] | |
378 | hist = self.shell.history_manager.search(pattern, raw=raw, output=output) |
|
378 | hist = self.shell.history_manager.search(pattern, raw=raw, output=output) | |
379 |
|
379 | |||
380 | else: |
|
380 | else: | |
381 | hist = [] |
|
381 | hist = [] | |
382 | content = {'history' : list(hist)} |
|
382 | content = {'history' : list(hist)} | |
383 | content = json_clean(content) |
|
383 | content = json_clean(content) | |
384 | msg = self.session.send(self.shell_socket, 'history_reply', |
|
384 | msg = self.session.send(self.shell_socket, 'history_reply', | |
385 | content, parent, ident) |
|
385 | content, parent, ident) | |
386 | self.log.debug(str(msg)) |
|
386 | self.log.debug(str(msg)) | |
387 |
|
387 | |||
388 | def connect_request(self, ident, parent): |
|
388 | def connect_request(self, ident, parent): | |
389 | if self._recorded_ports is not None: |
|
389 | if self._recorded_ports is not None: | |
390 | content = self._recorded_ports.copy() |
|
390 | content = self._recorded_ports.copy() | |
391 | else: |
|
391 | else: | |
392 | content = {} |
|
392 | content = {} | |
393 | msg = self.session.send(self.shell_socket, 'connect_reply', |
|
393 | msg = self.session.send(self.shell_socket, 'connect_reply', | |
394 | content, parent, ident) |
|
394 | content, parent, ident) | |
395 | self.log.debug(msg) |
|
395 | self.log.debug(msg) | |
396 |
|
396 | |||
397 | def shutdown_request(self, ident, parent): |
|
397 | def shutdown_request(self, ident, parent): | |
398 | self.shell.exit_now = True |
|
398 | self.shell.exit_now = True | |
399 | self._shutdown_message = self.session.msg(u'shutdown_reply', parent['content'], parent) |
|
399 | self._shutdown_message = self.session.msg(u'shutdown_reply', parent['content'], parent) | |
400 | sys.exit(0) |
|
400 | sys.exit(0) | |
401 |
|
401 | |||
402 | #--------------------------------------------------------------------------- |
|
402 | #--------------------------------------------------------------------------- | |
403 | # Protected interface |
|
403 | # Protected interface | |
404 | #--------------------------------------------------------------------------- |
|
404 | #--------------------------------------------------------------------------- | |
405 |
|
405 | |||
406 | def _abort_queue(self): |
|
406 | def _abort_queue(self): | |
407 | while True: |
|
407 | while True: | |
408 | try: |
|
408 | try: | |
409 | ident,msg = self.session.recv(self.shell_socket, zmq.NOBLOCK) |
|
409 | ident,msg = self.session.recv(self.shell_socket, zmq.NOBLOCK) | |
410 | except Exception: |
|
410 | except Exception: | |
411 | self.log.warn("Invalid Message:", exc_info=True) |
|
411 | self.log.warn("Invalid Message:", exc_info=True) | |
412 | continue |
|
412 | continue | |
413 | if msg is None: |
|
413 | if msg is None: | |
414 | break |
|
414 | break | |
415 | else: |
|
415 | else: | |
416 | assert ident is not None, \ |
|
416 | assert ident is not None, \ | |
417 | "Unexpected missing message part." |
|
417 | "Unexpected missing message part." | |
418 |
|
418 | |||
419 | self.log.debug("Aborting:\n"+str(Message(msg))) |
|
419 | self.log.debug("Aborting:\n"+str(Message(msg))) | |
420 | msg_type = msg['header']['msg_type'] |
|
420 | msg_type = msg['header']['msg_type'] | |
421 | reply_type = msg_type.split('_')[0] + '_reply' |
|
421 | reply_type = msg_type.split('_')[0] + '_reply' | |
422 | reply_msg = self.session.send(self.shell_socket, reply_type, |
|
422 | reply_msg = self.session.send(self.shell_socket, reply_type, | |
423 | {'status' : 'aborted'}, msg, ident=ident) |
|
423 | {'status' : 'aborted'}, msg, ident=ident) | |
424 | self.log.debug(reply_msg) |
|
424 | self.log.debug(reply_msg) | |
425 | # We need to wait a bit for requests to come in. This can probably |
|
425 | # We need to wait a bit for requests to come in. This can probably | |
426 | # be set shorter for true asynchronous clients. |
|
426 | # be set shorter for true asynchronous clients. | |
427 | time.sleep(0.1) |
|
427 | time.sleep(0.1) | |
428 |
|
428 | |||
429 | def _no_raw_input(self): |
|
429 | def _no_raw_input(self): | |
430 | """Raise StdinNotImplentedError if active frontend doesn't support stdin.""" |
|
430 | """Raise StdinNotImplentedError if active frontend doesn't support stdin.""" | |
431 | raise StdinNotImplementedError("raw_input was called, but this frontend does not support stdin.") |
|
431 | raise StdinNotImplementedError("raw_input was called, but this frontend does not support stdin.") | |
432 |
|
432 | |||
433 | def _raw_input(self, prompt, ident, parent): |
|
433 | def _raw_input(self, prompt, ident, parent): | |
434 | # Flush output before making the request. |
|
434 | # Flush output before making the request. | |
435 | sys.stderr.flush() |
|
435 | sys.stderr.flush() | |
436 | sys.stdout.flush() |
|
436 | sys.stdout.flush() | |
437 |
|
437 | |||
438 | # Send the input request. |
|
438 | # Send the input request. | |
439 | content = json_clean(dict(prompt=prompt)) |
|
439 | content = json_clean(dict(prompt=prompt)) | |
440 | msg = self.session.send(self.stdin_socket, u'input_request', content, parent, ident=ident) |
|
440 | msg = self.session.send(self.stdin_socket, u'input_request', content, parent, ident=ident) | |
441 |
|
441 | |||
442 | # Await a response. |
|
442 | # Await a response. | |
443 | while True: |
|
443 | while True: | |
444 | try: |
|
444 | try: | |
445 | ident, reply = self.session.recv(self.stdin_socket, 0) |
|
445 | ident, reply = self.session.recv(self.stdin_socket, 0) | |
446 | except Exception: |
|
446 | except Exception: | |
447 | self.log.warn("Invalid Message:", exc_info=True) |
|
447 | self.log.warn("Invalid Message:", exc_info=True) | |
448 | else: |
|
448 | else: | |
449 | break |
|
449 | break | |
450 | try: |
|
450 | try: | |
451 | value = reply['content']['value'] |
|
451 | value = reply['content']['value'] | |
452 | except: |
|
452 | except: | |
453 | self.log.error("Got bad raw_input reply: ") |
|
453 | self.log.error("Got bad raw_input reply: ") | |
454 | self.log.error(str(Message(parent))) |
|
454 | self.log.error(str(Message(parent))) | |
455 | value = '' |
|
455 | value = '' | |
456 | return value |
|
456 | return value | |
457 |
|
457 | |||
458 | def _complete(self, msg): |
|
458 | def _complete(self, msg): | |
459 | c = msg['content'] |
|
459 | c = msg['content'] | |
460 | try: |
|
460 | try: | |
461 | cpos = int(c['cursor_pos']) |
|
461 | cpos = int(c['cursor_pos']) | |
462 | except: |
|
462 | except: | |
463 | # If we don't get something that we can convert to an integer, at |
|
463 | # If we don't get something that we can convert to an integer, at | |
464 | # least attempt the completion guessing the cursor is at the end of |
|
464 | # least attempt the completion guessing the cursor is at the end of | |
465 | # the text, if there's any, and otherwise of the line |
|
465 | # the text, if there's any, and otherwise of the line | |
466 | cpos = len(c['text']) |
|
466 | cpos = len(c['text']) | |
467 | if cpos==0: |
|
467 | if cpos==0: | |
468 | cpos = len(c['line']) |
|
468 | cpos = len(c['line']) | |
469 | return self.shell.complete(c['text'], c['line'], cpos) |
|
469 | return self.shell.complete(c['text'], c['line'], cpos) | |
470 |
|
470 | |||
471 | def _object_info(self, context): |
|
471 | def _object_info(self, context): | |
472 | symbol, leftover = self._symbol_from_context(context) |
|
472 | symbol, leftover = self._symbol_from_context(context) | |
473 | if symbol is not None and not leftover: |
|
473 | if symbol is not None and not leftover: | |
474 | doc = getattr(symbol, '__doc__', '') |
|
474 | doc = getattr(symbol, '__doc__', '') | |
475 | else: |
|
475 | else: | |
476 | doc = '' |
|
476 | doc = '' | |
477 | object_info = dict(docstring = doc) |
|
477 | object_info = dict(docstring = doc) | |
478 | return object_info |
|
478 | return object_info | |
479 |
|
479 | |||
480 | def _symbol_from_context(self, context): |
|
480 | def _symbol_from_context(self, context): | |
481 | if not context: |
|
481 | if not context: | |
482 | return None, context |
|
482 | return None, context | |
483 |
|
483 | |||
484 | base_symbol_string = context[0] |
|
484 | base_symbol_string = context[0] | |
485 | symbol = self.shell.user_ns.get(base_symbol_string, None) |
|
485 | symbol = self.shell.user_ns.get(base_symbol_string, None) | |
486 | if symbol is None: |
|
486 | if symbol is None: | |
487 | symbol = __builtin__.__dict__.get(base_symbol_string, None) |
|
487 | symbol = __builtin__.__dict__.get(base_symbol_string, None) | |
488 | if symbol is None: |
|
488 | if symbol is None: | |
489 | return None, context |
|
489 | return None, context | |
490 |
|
490 | |||
491 | context = context[1:] |
|
491 | context = context[1:] | |
492 | for i, name in enumerate(context): |
|
492 | for i, name in enumerate(context): | |
493 | new_symbol = getattr(symbol, name, None) |
|
493 | new_symbol = getattr(symbol, name, None) | |
494 | if new_symbol is None: |
|
494 | if new_symbol is None: | |
495 | return symbol, context[i:] |
|
495 | return symbol, context[i:] | |
496 | else: |
|
496 | else: | |
497 | symbol = new_symbol |
|
497 | symbol = new_symbol | |
498 |
|
498 | |||
499 | return symbol, [] |
|
499 | return symbol, [] | |
500 |
|
500 | |||
501 | def _at_shutdown(self): |
|
501 | def _at_shutdown(self): | |
502 | """Actions taken at shutdown by the kernel, called by python's atexit. |
|
502 | """Actions taken at shutdown by the kernel, called by python's atexit. | |
503 | """ |
|
503 | """ | |
504 | # io.rprint("Kernel at_shutdown") # dbg |
|
504 | # io.rprint("Kernel at_shutdown") # dbg | |
505 | if self._shutdown_message is not None: |
|
505 | if self._shutdown_message is not None: | |
506 | self.session.send(self.shell_socket, self._shutdown_message) |
|
506 | self.session.send(self.shell_socket, self._shutdown_message) | |
507 | self.session.send(self.iopub_socket, self._shutdown_message) |
|
507 | self.session.send(self.iopub_socket, self._shutdown_message) | |
508 | self.log.debug(str(self._shutdown_message)) |
|
508 | self.log.debug(str(self._shutdown_message)) | |
509 | # A very short sleep to give zmq time to flush its message buffers |
|
509 | # A very short sleep to give zmq time to flush its message buffers | |
510 | # before Python truly shuts down. |
|
510 | # before Python truly shuts down. | |
511 | time.sleep(0.01) |
|
511 | time.sleep(0.01) | |
512 |
|
512 | |||
513 |
|
513 | |||
514 | #------------------------------------------------------------------------------ |
|
514 | #------------------------------------------------------------------------------ | |
515 | # Eventloops for integrating the Kernel into different GUIs |
|
515 | # Eventloops for integrating the Kernel into different GUIs | |
516 | #------------------------------------------------------------------------------ |
|
516 | #------------------------------------------------------------------------------ | |
517 |
|
517 | |||
518 |
|
518 | |||
519 | def loop_qt4(kernel): |
|
519 | def loop_qt4(kernel): | |
520 | """Start a kernel with PyQt4 event loop integration.""" |
|
520 | """Start a kernel with PyQt4 event loop integration.""" | |
521 |
|
521 | |||
522 | from IPython.external.qt_for_kernel import QtCore |
|
522 | from IPython.external.qt_for_kernel import QtCore | |
523 | from IPython.lib.guisupport import get_app_qt4, start_event_loop_qt4 |
|
523 | from IPython.lib.guisupport import get_app_qt4, start_event_loop_qt4 | |
524 |
|
524 | |||
525 | kernel.app = get_app_qt4([" "]) |
|
525 | kernel.app = get_app_qt4([" "]) | |
526 | kernel.app.setQuitOnLastWindowClosed(False) |
|
526 | kernel.app.setQuitOnLastWindowClosed(False) | |
527 | kernel.timer = QtCore.QTimer() |
|
527 | kernel.timer = QtCore.QTimer() | |
528 | kernel.timer.timeout.connect(kernel.do_one_iteration) |
|
528 | kernel.timer.timeout.connect(kernel.do_one_iteration) | |
529 | # Units for the timer are in milliseconds |
|
529 | # Units for the timer are in milliseconds | |
530 | kernel.timer.start(1000*kernel._poll_interval) |
|
530 | kernel.timer.start(1000*kernel._poll_interval) | |
531 | start_event_loop_qt4(kernel.app) |
|
531 | start_event_loop_qt4(kernel.app) | |
532 |
|
532 | |||
533 |
|
533 | |||
534 | def loop_wx(kernel): |
|
534 | def loop_wx(kernel): | |
535 | """Start a kernel with wx event loop support.""" |
|
535 | """Start a kernel with wx event loop support.""" | |
536 |
|
536 | |||
537 | import wx |
|
537 | import wx | |
538 | from IPython.lib.guisupport import start_event_loop_wx |
|
538 | from IPython.lib.guisupport import start_event_loop_wx | |
539 |
|
539 | |||
540 | doi = kernel.do_one_iteration |
|
540 | doi = kernel.do_one_iteration | |
541 | # Wx uses milliseconds |
|
541 | # Wx uses milliseconds | |
542 | poll_interval = int(1000*kernel._poll_interval) |
|
542 | poll_interval = int(1000*kernel._poll_interval) | |
543 |
|
543 | |||
544 | # We have to put the wx.Timer in a wx.Frame for it to fire properly. |
|
544 | # We have to put the wx.Timer in a wx.Frame for it to fire properly. | |
545 | # We make the Frame hidden when we create it in the main app below. |
|
545 | # We make the Frame hidden when we create it in the main app below. | |
546 | class TimerFrame(wx.Frame): |
|
546 | class TimerFrame(wx.Frame): | |
547 | def __init__(self, func): |
|
547 | def __init__(self, func): | |
548 | wx.Frame.__init__(self, None, -1) |
|
548 | wx.Frame.__init__(self, None, -1) | |
549 | self.timer = wx.Timer(self) |
|
549 | self.timer = wx.Timer(self) | |
550 | # Units for the timer are in milliseconds |
|
550 | # Units for the timer are in milliseconds | |
551 | self.timer.Start(poll_interval) |
|
551 | self.timer.Start(poll_interval) | |
552 | self.Bind(wx.EVT_TIMER, self.on_timer) |
|
552 | self.Bind(wx.EVT_TIMER, self.on_timer) | |
553 | self.func = func |
|
553 | self.func = func | |
554 |
|
554 | |||
555 | def on_timer(self, event): |
|
555 | def on_timer(self, event): | |
556 | self.func() |
|
556 | self.func() | |
557 |
|
557 | |||
558 | # We need a custom wx.App to create our Frame subclass that has the |
|
558 | # We need a custom wx.App to create our Frame subclass that has the | |
559 | # wx.Timer to drive the ZMQ event loop. |
|
559 | # wx.Timer to drive the ZMQ event loop. | |
560 | class IPWxApp(wx.App): |
|
560 | class IPWxApp(wx.App): | |
561 | def OnInit(self): |
|
561 | def OnInit(self): | |
562 | self.frame = TimerFrame(doi) |
|
562 | self.frame = TimerFrame(doi) | |
563 | self.frame.Show(False) |
|
563 | self.frame.Show(False) | |
564 | return True |
|
564 | return True | |
565 |
|
565 | |||
566 | # The redirect=False here makes sure that wx doesn't replace |
|
566 | # The redirect=False here makes sure that wx doesn't replace | |
567 | # sys.stdout/stderr with its own classes. |
|
567 | # sys.stdout/stderr with its own classes. | |
568 | kernel.app = IPWxApp(redirect=False) |
|
568 | kernel.app = IPWxApp(redirect=False) | |
569 | start_event_loop_wx(kernel.app) |
|
569 | start_event_loop_wx(kernel.app) | |
570 |
|
570 | |||
571 |
|
571 | |||
572 | def loop_tk(kernel): |
|
572 | def loop_tk(kernel): | |
573 | """Start a kernel with the Tk event loop.""" |
|
573 | """Start a kernel with the Tk event loop.""" | |
574 |
|
574 | |||
575 | import Tkinter |
|
575 | import Tkinter | |
576 | doi = kernel.do_one_iteration |
|
576 | doi = kernel.do_one_iteration | |
577 | # Tk uses milliseconds |
|
577 | # Tk uses milliseconds | |
578 | poll_interval = int(1000*kernel._poll_interval) |
|
578 | poll_interval = int(1000*kernel._poll_interval) | |
579 | # For Tkinter, we create a Tk object and call its withdraw method. |
|
579 | # For Tkinter, we create a Tk object and call its withdraw method. | |
580 | class Timer(object): |
|
580 | class Timer(object): | |
581 | def __init__(self, func): |
|
581 | def __init__(self, func): | |
582 | self.app = Tkinter.Tk() |
|
582 | self.app = Tkinter.Tk() | |
583 | self.app.withdraw() |
|
583 | self.app.withdraw() | |
584 | self.func = func |
|
584 | self.func = func | |
585 |
|
585 | |||
586 | def on_timer(self): |
|
586 | def on_timer(self): | |
587 | self.func() |
|
587 | self.func() | |
588 | self.app.after(poll_interval, self.on_timer) |
|
588 | self.app.after(poll_interval, self.on_timer) | |
589 |
|
589 | |||
590 | def start(self): |
|
590 | def start(self): | |
591 | self.on_timer() # Call it once to get things going. |
|
591 | self.on_timer() # Call it once to get things going. | |
592 | self.app.mainloop() |
|
592 | self.app.mainloop() | |
593 |
|
593 | |||
594 | kernel.timer = Timer(doi) |
|
594 | kernel.timer = Timer(doi) | |
595 | kernel.timer.start() |
|
595 | kernel.timer.start() | |
596 |
|
596 | |||
597 |
|
597 | |||
598 | def loop_gtk(kernel): |
|
598 | def loop_gtk(kernel): | |
599 | """Start the kernel, coordinating with the GTK event loop""" |
|
599 | """Start the kernel, coordinating with the GTK event loop""" | |
600 | from .gui.gtkembed import GTKEmbed |
|
600 | from .gui.gtkembed import GTKEmbed | |
601 |
|
601 | |||
602 | gtk_kernel = GTKEmbed(kernel) |
|
602 | gtk_kernel = GTKEmbed(kernel) | |
603 | gtk_kernel.start() |
|
603 | gtk_kernel.start() | |
604 |
|
604 | |||
605 |
|
605 | |||
606 | def loop_cocoa(kernel): |
|
606 | def loop_cocoa(kernel): | |
607 | """Start the kernel, coordinating with the Cocoa CFRunLoop event loop |
|
607 | """Start the kernel, coordinating with the Cocoa CFRunLoop event loop | |
608 | via the matplotlib MacOSX backend. |
|
608 | via the matplotlib MacOSX backend. | |
609 | """ |
|
609 | """ | |
610 | import matplotlib |
|
610 | import matplotlib | |
611 | if matplotlib.__version__ < '1.1.0': |
|
611 | if matplotlib.__version__ < '1.1.0': | |
612 | kernel.log.warn( |
|
612 | kernel.log.warn( | |
613 | "MacOSX backend in matplotlib %s doesn't have a Timer, " |
|
613 | "MacOSX backend in matplotlib %s doesn't have a Timer, " | |
614 | "falling back on Tk for CFRunLoop integration. Note that " |
|
614 | "falling back on Tk for CFRunLoop integration. Note that " | |
615 | "even this won't work if Tk is linked against X11 instead of " |
|
615 | "even this won't work if Tk is linked against X11 instead of " | |
616 | "Cocoa (e.g. EPD). To use the MacOSX backend in the kernel, " |
|
616 | "Cocoa (e.g. EPD). To use the MacOSX backend in the kernel, " | |
617 | "you must use matplotlib >= 1.1.0, or a native libtk." |
|
617 | "you must use matplotlib >= 1.1.0, or a native libtk." | |
618 | ) |
|
618 | ) | |
619 | return loop_tk(kernel) |
|
619 | return loop_tk(kernel) | |
620 |
|
620 | |||
621 | from matplotlib.backends.backend_macosx import TimerMac, show |
|
621 | from matplotlib.backends.backend_macosx import TimerMac, show | |
622 |
|
622 | |||
623 | # scale interval for sec->ms |
|
623 | # scale interval for sec->ms | |
624 | poll_interval = int(1000*kernel._poll_interval) |
|
624 | poll_interval = int(1000*kernel._poll_interval) | |
625 |
|
625 | |||
626 | real_excepthook = sys.excepthook |
|
626 | real_excepthook = sys.excepthook | |
627 | def handle_int(etype, value, tb): |
|
627 | def handle_int(etype, value, tb): | |
628 | """don't let KeyboardInterrupts look like crashes""" |
|
628 | """don't let KeyboardInterrupts look like crashes""" | |
629 | if etype is KeyboardInterrupt: |
|
629 | if etype is KeyboardInterrupt: | |
630 | io.raw_print("KeyboardInterrupt caught in CFRunLoop") |
|
630 | io.raw_print("KeyboardInterrupt caught in CFRunLoop") | |
631 | else: |
|
631 | else: | |
632 | real_excepthook(etype, value, tb) |
|
632 | real_excepthook(etype, value, tb) | |
633 |
|
633 | |||
634 | # add doi() as a Timer to the CFRunLoop |
|
634 | # add doi() as a Timer to the CFRunLoop | |
635 | def doi(): |
|
635 | def doi(): | |
636 | # restore excepthook during IPython code |
|
636 | # restore excepthook during IPython code | |
637 | sys.excepthook = real_excepthook |
|
637 | sys.excepthook = real_excepthook | |
638 | kernel.do_one_iteration() |
|
638 | kernel.do_one_iteration() | |
639 | # and back: |
|
639 | # and back: | |
640 | sys.excepthook = handle_int |
|
640 | sys.excepthook = handle_int | |
641 |
|
641 | |||
642 | t = TimerMac(poll_interval) |
|
642 | t = TimerMac(poll_interval) | |
643 | t.add_callback(doi) |
|
643 | t.add_callback(doi) | |
644 | t.start() |
|
644 | t.start() | |
645 |
|
645 | |||
646 | # but still need a Poller for when there are no active windows, |
|
646 | # but still need a Poller for when there are no active windows, | |
647 | # during which time mainloop() returns immediately |
|
647 | # during which time mainloop() returns immediately | |
648 | poller = zmq.Poller() |
|
648 | poller = zmq.Poller() | |
649 | poller.register(kernel.shell_socket, zmq.POLLIN) |
|
649 | poller.register(kernel.shell_socket, zmq.POLLIN) | |
650 |
|
650 | |||
651 | while True: |
|
651 | while True: | |
652 | try: |
|
652 | try: | |
653 | # double nested try/except, to properly catch KeyboardInterrupt |
|
653 | # double nested try/except, to properly catch KeyboardInterrupt | |
654 | # due to pyzmq Issue #130 |
|
654 | # due to pyzmq Issue #130 | |
655 | try: |
|
655 | try: | |
656 | # don't let interrupts during mainloop invoke crash_handler: |
|
656 | # don't let interrupts during mainloop invoke crash_handler: | |
657 | sys.excepthook = handle_int |
|
657 | sys.excepthook = handle_int | |
658 | show.mainloop() |
|
658 | show.mainloop() | |
659 | sys.excepthook = real_excepthook |
|
659 | sys.excepthook = real_excepthook | |
660 | # use poller if mainloop returned (no windows) |
|
660 | # use poller if mainloop returned (no windows) | |
661 | # scale by extra factor of 10, since it's a real poll |
|
661 | # scale by extra factor of 10, since it's a real poll | |
662 | poller.poll(10*poll_interval) |
|
662 | poller.poll(10*poll_interval) | |
663 | kernel.do_one_iteration() |
|
663 | kernel.do_one_iteration() | |
664 | except: |
|
664 | except: | |
665 | raise |
|
665 | raise | |
666 | except KeyboardInterrupt: |
|
666 | except KeyboardInterrupt: | |
667 | # Ctrl-C shouldn't crash the kernel |
|
667 | # Ctrl-C shouldn't crash the kernel | |
668 | io.raw_print("KeyboardInterrupt caught in kernel") |
|
668 | io.raw_print("KeyboardInterrupt caught in kernel") | |
669 | finally: |
|
669 | finally: | |
670 | # ensure excepthook is restored |
|
670 | # ensure excepthook is restored | |
671 | sys.excepthook = real_excepthook |
|
671 | sys.excepthook = real_excepthook | |
672 |
|
672 | |||
673 | # mapping of keys to loop functions |
|
673 | # mapping of keys to loop functions | |
674 | loop_map = { |
|
674 | loop_map = { | |
675 | 'qt' : loop_qt4, |
|
675 | 'qt' : loop_qt4, | |
676 | 'qt4': loop_qt4, |
|
676 | 'qt4': loop_qt4, | |
677 | 'inline': None, |
|
677 | 'inline': None, | |
678 | 'osx': loop_cocoa, |
|
678 | 'osx': loop_cocoa, | |
679 | 'wx' : loop_wx, |
|
679 | 'wx' : loop_wx, | |
680 | 'tk' : loop_tk, |
|
680 | 'tk' : loop_tk, | |
681 | 'gtk': loop_gtk, |
|
681 | 'gtk': loop_gtk, | |
|
682 | None : None, | |||
682 | } |
|
683 | } | |
683 |
|
684 | |||
684 | def enable_gui(gui, kernel=None): |
|
685 | def enable_gui(gui, kernel=None): | |
685 | """Enable integration with a give GUI""" |
|
686 | """Enable integration with a given GUI""" | |
686 | if kernel is None: |
|
687 | if kernel is None: | |
687 | kernel = IPKernelApp.instance().kernel |
|
688 | kernel = IPKernelApp.instance().kernel | |
688 | if gui not in loop_map: |
|
689 | if gui not in loop_map: | |
689 | raise ValueError("GUI %r not supported" % gui) |
|
690 | raise ValueError("GUI %r not supported" % gui) | |
690 | loop = loop_map[gui] |
|
691 | loop = loop_map[gui] | |
691 | if kernel.eventloop is not None and kernel.eventloop is not loop: |
|
692 | if kernel.eventloop is not None and kernel.eventloop is not loop: | |
692 | raise RuntimeError("Cannot activate multiple GUI eventloops") |
|
693 | raise RuntimeError("Cannot activate multiple GUI eventloops") | |
693 | kernel.eventloop = loop |
|
694 | kernel.eventloop = loop | |
694 |
|
695 | |||
695 |
|
696 | |||
696 | #----------------------------------------------------------------------------- |
|
697 | #----------------------------------------------------------------------------- | |
697 | # Aliases and Flags for the IPKernelApp |
|
698 | # Aliases and Flags for the IPKernelApp | |
698 | #----------------------------------------------------------------------------- |
|
699 | #----------------------------------------------------------------------------- | |
699 |
|
700 | |||
700 | flags = dict(kernel_flags) |
|
701 | flags = dict(kernel_flags) | |
701 | flags.update(shell_flags) |
|
702 | flags.update(shell_flags) | |
702 |
|
703 | |||
703 | addflag = lambda *args: flags.update(boolean_flag(*args)) |
|
704 | addflag = lambda *args: flags.update(boolean_flag(*args)) | |
704 |
|
705 | |||
705 | flags['pylab'] = ( |
|
706 | flags['pylab'] = ( | |
706 | {'IPKernelApp' : {'pylab' : 'auto'}}, |
|
707 | {'IPKernelApp' : {'pylab' : 'auto'}}, | |
707 | """Pre-load matplotlib and numpy for interactive use with |
|
708 | """Pre-load matplotlib and numpy for interactive use with | |
708 | the default matplotlib backend.""" |
|
709 | the default matplotlib backend.""" | |
709 | ) |
|
710 | ) | |
710 |
|
711 | |||
711 | aliases = dict(kernel_aliases) |
|
712 | aliases = dict(kernel_aliases) | |
712 | aliases.update(shell_aliases) |
|
713 | aliases.update(shell_aliases) | |
713 |
|
714 | |||
714 | # it's possible we don't want short aliases for *all* of these: |
|
715 | # it's possible we don't want short aliases for *all* of these: | |
715 | aliases.update(dict( |
|
716 | aliases.update(dict( | |
716 | pylab='IPKernelApp.pylab', |
|
717 | pylab='IPKernelApp.pylab', | |
717 | )) |
|
718 | )) | |
718 |
|
719 | |||
719 | #----------------------------------------------------------------------------- |
|
720 | #----------------------------------------------------------------------------- | |
720 | # The IPKernelApp class |
|
721 | # The IPKernelApp class | |
721 | #----------------------------------------------------------------------------- |
|
722 | #----------------------------------------------------------------------------- | |
722 |
|
723 | |||
723 | class IPKernelApp(KernelApp, InteractiveShellApp): |
|
724 | class IPKernelApp(KernelApp, InteractiveShellApp): | |
724 | name = 'ipkernel' |
|
725 | name = 'ipkernel' | |
725 |
|
726 | |||
726 | aliases = Dict(aliases) |
|
727 | aliases = Dict(aliases) | |
727 | flags = Dict(flags) |
|
728 | flags = Dict(flags) | |
728 | classes = [Kernel, ZMQInteractiveShell, ProfileDir, Session] |
|
729 | classes = [Kernel, ZMQInteractiveShell, ProfileDir, Session] | |
729 | # configurables |
|
730 | # configurables | |
730 | pylab = CaselessStrEnum(['tk', 'qt', 'wx', 'gtk', 'osx', 'inline', 'auto'], |
|
731 | pylab = CaselessStrEnum(['tk', 'qt', 'wx', 'gtk', 'osx', 'inline', 'auto'], | |
731 | config=True, |
|
732 | config=True, | |
732 | help="""Pre-load matplotlib and numpy for interactive use, |
|
733 | help="""Pre-load matplotlib and numpy for interactive use, | |
733 | selecting a particular matplotlib backend and loop integration. |
|
734 | selecting a particular matplotlib backend and loop integration. | |
734 | """ |
|
735 | """ | |
735 | ) |
|
736 | ) | |
736 |
|
737 | |||
737 | @catch_config_error |
|
738 | @catch_config_error | |
738 | def initialize(self, argv=None): |
|
739 | def initialize(self, argv=None): | |
739 | super(IPKernelApp, self).initialize(argv) |
|
740 | super(IPKernelApp, self).initialize(argv) | |
740 | self.init_shell() |
|
741 | self.init_shell() | |
741 | self.init_extensions() |
|
742 | self.init_extensions() | |
742 | self.init_code() |
|
743 | self.init_code() | |
743 |
|
744 | |||
744 | def init_kernel(self): |
|
745 | def init_kernel(self): | |
745 |
|
746 | |||
746 | kernel = Kernel(config=self.config, session=self.session, |
|
747 | kernel = Kernel(config=self.config, session=self.session, | |
747 | shell_socket=self.shell_socket, |
|
748 | shell_socket=self.shell_socket, | |
748 | iopub_socket=self.iopub_socket, |
|
749 | iopub_socket=self.iopub_socket, | |
749 | stdin_socket=self.stdin_socket, |
|
750 | stdin_socket=self.stdin_socket, | |
750 | log=self.log, |
|
751 | log=self.log, | |
751 | profile_dir=self.profile_dir, |
|
752 | profile_dir=self.profile_dir, | |
752 | ) |
|
753 | ) | |
753 | self.kernel = kernel |
|
754 | self.kernel = kernel | |
754 | kernel.record_ports(self.ports) |
|
755 | kernel.record_ports(self.ports) | |
755 | shell = kernel.shell |
|
756 | shell = kernel.shell | |
756 | if self.pylab: |
|
757 | if self.pylab: | |
757 | try: |
|
758 | try: | |
758 | gui, backend = pylabtools.find_gui_and_backend(self.pylab) |
|
759 | gui, backend = pylabtools.find_gui_and_backend(self.pylab) | |
759 | shell.enable_pylab(gui, import_all=self.pylab_import_all) |
|
760 | shell.enable_pylab(gui, import_all=self.pylab_import_all) | |
760 | except Exception: |
|
761 | except Exception: | |
761 | self.log.error("Pylab initialization failed", exc_info=True) |
|
762 | self.log.error("Pylab initialization failed", exc_info=True) | |
762 | # print exception straight to stdout, because normally |
|
763 | # print exception straight to stdout, because normally | |
763 | # _showtraceback associates the reply with an execution, |
|
764 | # _showtraceback associates the reply with an execution, | |
764 | # which means frontends will never draw it, as this exception |
|
765 | # which means frontends will never draw it, as this exception | |
765 | # is not associated with any execute request. |
|
766 | # is not associated with any execute request. | |
766 |
|
767 | |||
767 | # replace pyerr-sending traceback with stdout |
|
768 | # replace pyerr-sending traceback with stdout | |
768 | _showtraceback = shell._showtraceback |
|
769 | _showtraceback = shell._showtraceback | |
769 | def print_tb(etype, evalue, stb): |
|
770 | def print_tb(etype, evalue, stb): | |
770 | print ("Error initializing pylab, pylab mode will not be active", file=io.stderr) |
|
771 | print ("Error initializing pylab, pylab mode will not be active", file=io.stderr) | |
771 | print (shell.InteractiveTB.stb2text(stb), file=io.stdout) |
|
772 | print (shell.InteractiveTB.stb2text(stb), file=io.stdout) | |
772 | shell._showtraceback = print_tb |
|
773 | shell._showtraceback = print_tb | |
773 |
|
774 | |||
774 | # send the traceback over stdout |
|
775 | # send the traceback over stdout | |
775 | shell.showtraceback(tb_offset=0) |
|
776 | shell.showtraceback(tb_offset=0) | |
776 |
|
777 | |||
777 | # restore proper _showtraceback method |
|
778 | # restore proper _showtraceback method | |
778 | shell._showtraceback = _showtraceback |
|
779 | shell._showtraceback = _showtraceback | |
779 |
|
780 | |||
780 |
|
781 | |||
781 | def init_shell(self): |
|
782 | def init_shell(self): | |
782 | self.shell = self.kernel.shell |
|
783 | self.shell = self.kernel.shell | |
783 | self.shell.configurables.append(self) |
|
784 | self.shell.configurables.append(self) | |
784 |
|
785 | |||
785 |
|
786 | |||
786 | #----------------------------------------------------------------------------- |
|
787 | #----------------------------------------------------------------------------- | |
787 | # Kernel main and launch functions |
|
788 | # Kernel main and launch functions | |
788 | #----------------------------------------------------------------------------- |
|
789 | #----------------------------------------------------------------------------- | |
789 |
|
790 | |||
790 | def launch_kernel(*args, **kwargs): |
|
791 | def launch_kernel(*args, **kwargs): | |
791 | """Launches a localhost IPython kernel, binding to the specified ports. |
|
792 | """Launches a localhost IPython kernel, binding to the specified ports. | |
792 |
|
793 | |||
793 | This function simply calls entry_point.base_launch_kernel with the right first |
|
794 | This function simply calls entry_point.base_launch_kernel with the right first | |
794 | command to start an ipkernel. See base_launch_kernel for arguments. |
|
795 | command to start an ipkernel. See base_launch_kernel for arguments. | |
795 |
|
796 | |||
796 | Returns |
|
797 | Returns | |
797 | ------- |
|
798 | ------- | |
798 | A tuple of form: |
|
799 | A tuple of form: | |
799 | (kernel_process, shell_port, iopub_port, stdin_port, hb_port) |
|
800 | (kernel_process, shell_port, iopub_port, stdin_port, hb_port) | |
800 | where kernel_process is a Popen object and the ports are integers. |
|
801 | where kernel_process is a Popen object and the ports are integers. | |
801 | """ |
|
802 | """ | |
802 | return base_launch_kernel('from IPython.zmq.ipkernel import main; main()', |
|
803 | return base_launch_kernel('from IPython.zmq.ipkernel import main; main()', | |
803 | *args, **kwargs) |
|
804 | *args, **kwargs) | |
804 |
|
805 | |||
805 |
|
806 | |||
806 | def main(): |
|
807 | def main(): | |
807 | """Run an IPKernel as an application""" |
|
808 | """Run an IPKernel as an application""" | |
808 | app = IPKernelApp.instance() |
|
809 | app = IPKernelApp.instance() | |
809 | app.initialize() |
|
810 | app.initialize() | |
810 | app.start() |
|
811 | app.start() | |
811 |
|
812 | |||
812 |
|
813 | |||
813 | if __name__ == '__main__': |
|
814 | if __name__ == '__main__': | |
814 | main() |
|
815 | main() |
@@ -1,180 +1,180 b'' | |||||
1 | """Produce SVG versions of active plots for display by the rich Qt frontend. |
|
1 | """Produce SVG versions of active plots for display by the rich Qt frontend. | |
2 | """ |
|
2 | """ | |
3 | #----------------------------------------------------------------------------- |
|
3 | #----------------------------------------------------------------------------- | |
4 | # Imports |
|
4 | # Imports | |
5 | #----------------------------------------------------------------------------- |
|
5 | #----------------------------------------------------------------------------- | |
6 | from __future__ import print_function |
|
6 | from __future__ import print_function | |
7 |
|
7 | |||
8 | # Standard library imports |
|
8 | # Standard library imports | |
9 | import sys |
|
9 | import sys | |
10 |
|
10 | |||
11 | # Third-party imports |
|
11 | # Third-party imports | |
12 | import matplotlib |
|
12 | import matplotlib | |
13 | from matplotlib.backends.backend_agg import new_figure_manager |
|
13 | from matplotlib.backends.backend_agg import new_figure_manager | |
14 | from matplotlib._pylab_helpers import Gcf |
|
14 | from matplotlib._pylab_helpers import Gcf | |
15 |
|
15 | |||
16 | # Local imports. |
|
16 | # Local imports. | |
17 | from IPython.config.configurable import SingletonConfigurable |
|
17 | from IPython.config.configurable import SingletonConfigurable | |
18 | from IPython.core.displaypub import publish_display_data |
|
18 | from IPython.core.displaypub import publish_display_data | |
19 |
from IPython. |
|
19 | from IPython.core.pylabtools import print_figure, select_figure_format | |
20 | from IPython.utils.traitlets import Dict, Instance, CaselessStrEnum, CBool |
|
20 | from IPython.utils.traitlets import Dict, Instance, CaselessStrEnum, CBool | |
21 | from IPython.utils.warn import warn |
|
21 | from IPython.utils.warn import warn | |
22 |
|
22 | |||
23 | #----------------------------------------------------------------------------- |
|
23 | #----------------------------------------------------------------------------- | |
24 | # Configurable for inline backend options |
|
24 | # Configurable for inline backend options | |
25 | #----------------------------------------------------------------------------- |
|
25 | #----------------------------------------------------------------------------- | |
26 | # inherit from InlineBackendConfig for deprecation purposes |
|
26 | # inherit from InlineBackendConfig for deprecation purposes | |
27 | class InlineBackendConfig(SingletonConfigurable): |
|
27 | class InlineBackendConfig(SingletonConfigurable): | |
28 | pass |
|
28 | pass | |
29 |
|
29 | |||
30 | class InlineBackend(InlineBackendConfig): |
|
30 | class InlineBackend(InlineBackendConfig): | |
31 | """An object to store configuration of the inline backend.""" |
|
31 | """An object to store configuration of the inline backend.""" | |
32 |
|
32 | |||
33 | def _config_changed(self, name, old, new): |
|
33 | def _config_changed(self, name, old, new): | |
34 | # warn on change of renamed config section |
|
34 | # warn on change of renamed config section | |
35 | if new.InlineBackendConfig != old.InlineBackendConfig: |
|
35 | if new.InlineBackendConfig != old.InlineBackendConfig: | |
36 | warn("InlineBackendConfig has been renamed to InlineBackend") |
|
36 | warn("InlineBackendConfig has been renamed to InlineBackend") | |
37 | super(InlineBackend, self)._config_changed(name, old, new) |
|
37 | super(InlineBackend, self)._config_changed(name, old, new) | |
38 |
|
38 | |||
39 | # The typical default figure size is too large for inline use, |
|
39 | # The typical default figure size is too large for inline use, | |
40 | # so we shrink the figure size to 6x4, and tweak fonts to |
|
40 | # so we shrink the figure size to 6x4, and tweak fonts to | |
41 | # make that fit. |
|
41 | # make that fit. | |
42 | rc = Dict({'figure.figsize': (6.0,4.0), |
|
42 | rc = Dict({'figure.figsize': (6.0,4.0), | |
43 | # 12pt labels get cutoff on 6x4 logplots, so use 10pt. |
|
43 | # 12pt labels get cutoff on 6x4 logplots, so use 10pt. | |
44 | 'font.size': 10, |
|
44 | 'font.size': 10, | |
45 | # 72 dpi matches SVG/qtconsole |
|
45 | # 72 dpi matches SVG/qtconsole | |
46 | # this only affects PNG export, as SVG has no dpi setting |
|
46 | # this only affects PNG export, as SVG has no dpi setting | |
47 | 'savefig.dpi': 72, |
|
47 | 'savefig.dpi': 72, | |
48 | # 10pt still needs a little more room on the xlabel: |
|
48 | # 10pt still needs a little more room on the xlabel: | |
49 | 'figure.subplot.bottom' : .125 |
|
49 | 'figure.subplot.bottom' : .125 | |
50 | }, config=True, |
|
50 | }, config=True, | |
51 | help="""Subset of matplotlib rcParams that should be different for the |
|
51 | help="""Subset of matplotlib rcParams that should be different for the | |
52 | inline backend.""" |
|
52 | inline backend.""" | |
53 | ) |
|
53 | ) | |
54 |
|
54 | |||
55 | figure_format = CaselessStrEnum(['svg', 'png'], default_value='png', config=True, |
|
55 | figure_format = CaselessStrEnum(['svg', 'png'], default_value='png', config=True, | |
56 | help="The image format for figures with the inline backend.") |
|
56 | help="The image format for figures with the inline backend.") | |
57 |
|
57 | |||
58 | def _figure_format_changed(self, name, old, new): |
|
58 | def _figure_format_changed(self, name, old, new): | |
59 | if self.shell is None: |
|
59 | if self.shell is None: | |
60 | return |
|
60 | return | |
61 | else: |
|
61 | else: | |
62 | select_figure_format(self.shell, new) |
|
62 | select_figure_format(self.shell, new) | |
63 |
|
63 | |||
64 | close_figures = CBool(True, config=True, |
|
64 | close_figures = CBool(True, config=True, | |
65 | help="""Close all figures at the end of each cell. |
|
65 | help="""Close all figures at the end of each cell. | |
66 |
|
66 | |||
67 | When True, ensures that each cell starts with no active figures, but it |
|
67 | When True, ensures that each cell starts with no active figures, but it | |
68 | also means that one must keep track of references in order to edit or |
|
68 | also means that one must keep track of references in order to edit or | |
69 | redraw figures in subsequent cells. This mode is ideal for the notebook, |
|
69 | redraw figures in subsequent cells. This mode is ideal for the notebook, | |
70 | where residual plots from other cells might be surprising. |
|
70 | where residual plots from other cells might be surprising. | |
71 |
|
71 | |||
72 | When False, one must call figure() to create new figures. This means |
|
72 | When False, one must call figure() to create new figures. This means | |
73 | that gcf() and getfigs() can reference figures created in other cells, |
|
73 | that gcf() and getfigs() can reference figures created in other cells, | |
74 | and the active figure can continue to be edited with pylab/pyplot |
|
74 | and the active figure can continue to be edited with pylab/pyplot | |
75 | methods that reference the current active figure. This mode facilitates |
|
75 | methods that reference the current active figure. This mode facilitates | |
76 | iterative editing of figures, and behaves most consistently with |
|
76 | iterative editing of figures, and behaves most consistently with | |
77 | other matplotlib backends, but figure barriers between cells must |
|
77 | other matplotlib backends, but figure barriers between cells must | |
78 | be explicit. |
|
78 | be explicit. | |
79 | """) |
|
79 | """) | |
80 |
|
80 | |||
81 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') |
|
81 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') | |
82 |
|
82 | |||
83 |
|
83 | |||
84 | #----------------------------------------------------------------------------- |
|
84 | #----------------------------------------------------------------------------- | |
85 | # Functions |
|
85 | # Functions | |
86 | #----------------------------------------------------------------------------- |
|
86 | #----------------------------------------------------------------------------- | |
87 |
|
87 | |||
88 | def show(close=None): |
|
88 | def show(close=None): | |
89 | """Show all figures as SVG/PNG payloads sent to the IPython clients. |
|
89 | """Show all figures as SVG/PNG payloads sent to the IPython clients. | |
90 |
|
90 | |||
91 | Parameters |
|
91 | Parameters | |
92 | ---------- |
|
92 | ---------- | |
93 | close : bool, optional |
|
93 | close : bool, optional | |
94 | If true, a ``plt.close('all')`` call is automatically issued after |
|
94 | If true, a ``plt.close('all')`` call is automatically issued after | |
95 | sending all the figures. If this is set, the figures will entirely |
|
95 | sending all the figures. If this is set, the figures will entirely | |
96 | removed from the internal list of figures. |
|
96 | removed from the internal list of figures. | |
97 | """ |
|
97 | """ | |
98 | if close is None: |
|
98 | if close is None: | |
99 | close = InlineBackend.instance().close_figures |
|
99 | close = InlineBackend.instance().close_figures | |
100 | try: |
|
100 | try: | |
101 | for figure_manager in Gcf.get_all_fig_managers(): |
|
101 | for figure_manager in Gcf.get_all_fig_managers(): | |
102 | send_figure(figure_manager.canvas.figure) |
|
102 | send_figure(figure_manager.canvas.figure) | |
103 | finally: |
|
103 | finally: | |
104 | show._to_draw = [] |
|
104 | show._to_draw = [] | |
105 | if close: |
|
105 | if close: | |
106 | matplotlib.pyplot.close('all') |
|
106 | matplotlib.pyplot.close('all') | |
107 |
|
107 | |||
108 |
|
108 | |||
109 |
|
109 | |||
110 | # This flag will be reset by draw_if_interactive when called |
|
110 | # This flag will be reset by draw_if_interactive when called | |
111 | show._draw_called = False |
|
111 | show._draw_called = False | |
112 | # list of figures to draw when flush_figures is called |
|
112 | # list of figures to draw when flush_figures is called | |
113 | show._to_draw = [] |
|
113 | show._to_draw = [] | |
114 |
|
114 | |||
115 |
|
115 | |||
116 | def draw_if_interactive(): |
|
116 | def draw_if_interactive(): | |
117 | """ |
|
117 | """ | |
118 | Is called after every pylab drawing command |
|
118 | Is called after every pylab drawing command | |
119 | """ |
|
119 | """ | |
120 | # signal that the current active figure should be sent at the end of execution. |
|
120 | # signal that the current active figure should be sent at the end of execution. | |
121 | # Also sets the _draw_called flag, signaling that there will be something to send. |
|
121 | # Also sets the _draw_called flag, signaling that there will be something to send. | |
122 | # At the end of the code execution, a separate call to flush_figures() |
|
122 | # At the end of the code execution, a separate call to flush_figures() | |
123 | # will act upon these values |
|
123 | # will act upon these values | |
124 |
|
124 | |||
125 | fig = Gcf.get_active().canvas.figure |
|
125 | fig = Gcf.get_active().canvas.figure | |
126 |
|
126 | |||
127 | # ensure current figure will be drawn, and each subsequent call |
|
127 | # ensure current figure will be drawn, and each subsequent call | |
128 | # of draw_if_interactive() moves the active figure to ensure it is |
|
128 | # of draw_if_interactive() moves the active figure to ensure it is | |
129 | # drawn last |
|
129 | # drawn last | |
130 | try: |
|
130 | try: | |
131 | show._to_draw.remove(fig) |
|
131 | show._to_draw.remove(fig) | |
132 | except ValueError: |
|
132 | except ValueError: | |
133 | # ensure it only appears in the draw list once |
|
133 | # ensure it only appears in the draw list once | |
134 | pass |
|
134 | pass | |
135 | show._to_draw.append(fig) |
|
135 | show._to_draw.append(fig) | |
136 | show._draw_called = True |
|
136 | show._draw_called = True | |
137 |
|
137 | |||
138 | def flush_figures(): |
|
138 | def flush_figures(): | |
139 | """Send all figures that changed |
|
139 | """Send all figures that changed | |
140 |
|
140 | |||
141 | This is meant to be called automatically and will call show() if, during |
|
141 | This is meant to be called automatically and will call show() if, during | |
142 | prior code execution, there had been any calls to draw_if_interactive. |
|
142 | prior code execution, there had been any calls to draw_if_interactive. | |
143 | """ |
|
143 | """ | |
144 | if not show._draw_called: |
|
144 | if not show._draw_called: | |
145 | return |
|
145 | return | |
146 |
|
146 | |||
147 | if InlineBackend.instance().close_figures: |
|
147 | if InlineBackend.instance().close_figures: | |
148 | # ignore the tracking, just draw and close all figures |
|
148 | # ignore the tracking, just draw and close all figures | |
149 | return show(True) |
|
149 | return show(True) | |
150 |
|
150 | |||
151 | try: |
|
151 | try: | |
152 | # exclude any figures that were closed: |
|
152 | # exclude any figures that were closed: | |
153 | active = set([fm.canvas.figure for fm in Gcf.get_all_fig_managers()]) |
|
153 | active = set([fm.canvas.figure for fm in Gcf.get_all_fig_managers()]) | |
154 | for fig in [ fig for fig in show._to_draw if fig in active ]: |
|
154 | for fig in [ fig for fig in show._to_draw if fig in active ]: | |
155 | send_figure(fig) |
|
155 | send_figure(fig) | |
156 | finally: |
|
156 | finally: | |
157 | # clear flags for next round |
|
157 | # clear flags for next round | |
158 | show._to_draw = [] |
|
158 | show._to_draw = [] | |
159 | show._draw_called = False |
|
159 | show._draw_called = False | |
160 |
|
160 | |||
161 |
|
161 | |||
162 | def send_figure(fig): |
|
162 | def send_figure(fig): | |
163 | """Draw the current figure and send it as a PNG payload. |
|
163 | """Draw the current figure and send it as a PNG payload. | |
164 | """ |
|
164 | """ | |
165 | # For an empty figure, don't even bother calling figure_to_svg, to avoid |
|
165 | # For an empty figure, don't even bother calling figure_to_svg, to avoid | |
166 | # big blank spaces in the qt console |
|
166 | # big blank spaces in the qt console | |
167 | if not fig.axes: |
|
167 | if not fig.axes: | |
168 | return |
|
168 | return | |
169 | fmt = InlineBackend.instance().figure_format |
|
169 | fmt = InlineBackend.instance().figure_format | |
170 | data = print_figure(fig, fmt) |
|
170 | data = print_figure(fig, fmt) | |
171 | mimetypes = { 'png' : 'image/png', 'svg' : 'image/svg+xml' } |
|
171 | mimetypes = { 'png' : 'image/png', 'svg' : 'image/svg+xml' } | |
172 | mime = mimetypes[fmt] |
|
172 | mime = mimetypes[fmt] | |
173 | # flush text streams before sending figures, helps a little with output |
|
173 | # flush text streams before sending figures, helps a little with output | |
174 | # synchronization in the console (though it's a bandaid, not a real sln) |
|
174 | # synchronization in the console (though it's a bandaid, not a real sln) | |
175 | sys.stdout.flush(); sys.stderr.flush() |
|
175 | sys.stdout.flush(); sys.stderr.flush() | |
176 | publish_display_data( |
|
176 | publish_display_data( | |
177 | 'IPython.zmq.pylab.backend_inline.send_figure', |
|
177 | 'IPython.zmq.pylab.backend_inline.send_figure', | |
178 | {mime : data} |
|
178 | {mime : data} | |
179 | ) |
|
179 | ) | |
180 |
|
180 |
@@ -1,581 +1,512 b'' | |||||
1 | """A ZMQ-based subclass of InteractiveShell. |
|
1 | """A ZMQ-based subclass of InteractiveShell. | |
2 |
|
2 | |||
3 | This code is meant to ease the refactoring of the base InteractiveShell into |
|
3 | This code is meant to ease the refactoring of the base InteractiveShell into | |
4 | something with a cleaner architecture for 2-process use, without actually |
|
4 | something with a cleaner architecture for 2-process use, without actually | |
5 | breaking InteractiveShell itself. So we're doing something a bit ugly, where |
|
5 | breaking InteractiveShell itself. So we're doing something a bit ugly, where | |
6 | we subclass and override what we want to fix. Once this is working well, we |
|
6 | we subclass and override what we want to fix. Once this is working well, we | |
7 | can go back to the base class and refactor the code for a cleaner inheritance |
|
7 | can go back to the base class and refactor the code for a cleaner inheritance | |
8 | implementation that doesn't rely on so much monkeypatching. |
|
8 | implementation that doesn't rely on so much monkeypatching. | |
9 |
|
9 | |||
10 | But this lets us maintain a fully working IPython as we develop the new |
|
10 | But this lets us maintain a fully working IPython as we develop the new | |
11 | machinery. This should thus be thought of as scaffolding. |
|
11 | machinery. This should thus be thought of as scaffolding. | |
12 | """ |
|
12 | """ | |
13 | #----------------------------------------------------------------------------- |
|
13 | #----------------------------------------------------------------------------- | |
14 | # Imports |
|
14 | # Imports | |
15 | #----------------------------------------------------------------------------- |
|
15 | #----------------------------------------------------------------------------- | |
16 | from __future__ import print_function |
|
16 | from __future__ import print_function | |
17 |
|
17 | |||
18 | # Stdlib |
|
18 | # Stdlib | |
19 | import inspect |
|
19 | import inspect | |
20 | import os |
|
20 | import os | |
21 | import sys |
|
21 | import sys | |
22 | from subprocess import Popen, PIPE |
|
22 | from subprocess import Popen, PIPE | |
23 |
|
23 | |||
24 | # Our own |
|
24 | # Our own | |
25 | from IPython.core.interactiveshell import ( |
|
25 | from IPython.core.interactiveshell import ( | |
26 | InteractiveShell, InteractiveShellABC |
|
26 | InteractiveShell, InteractiveShellABC | |
27 | ) |
|
27 | ) | |
28 | from IPython.core import page |
|
28 | from IPython.core import page | |
29 | from IPython.core.autocall import ZMQExitAutocall |
|
29 | from IPython.core.autocall import ZMQExitAutocall | |
30 | from IPython.core.displaypub import DisplayPublisher |
|
30 | from IPython.core.displaypub import DisplayPublisher | |
31 | from IPython.core.macro import Macro |
|
31 | from IPython.core.macro import Macro | |
32 | from IPython.core.magic import MacroToEdit |
|
32 | from IPython.core.magic import MacroToEdit | |
33 | from IPython.core.payloadpage import install_payload_page |
|
33 | from IPython.core.payloadpage import install_payload_page | |
34 | from IPython.lib import pylabtools |
|
34 | from IPython.lib import pylabtools | |
35 | from IPython.lib.kernel import ( |
|
35 | from IPython.lib.kernel import ( | |
36 | get_connection_file, get_connection_info, connect_qtconsole |
|
36 | get_connection_file, get_connection_info, connect_qtconsole | |
37 | ) |
|
37 | ) | |
38 | from IPython.utils import io |
|
38 | from IPython.utils import io | |
39 | from IPython.utils.jsonutil import json_clean |
|
39 | from IPython.utils.jsonutil import json_clean | |
40 | from IPython.utils.path import get_py_filename |
|
40 | from IPython.utils.path import get_py_filename | |
41 | from IPython.utils.process import arg_split |
|
41 | from IPython.utils.process import arg_split | |
42 | from IPython.utils.traitlets import Instance, Type, Dict, CBool |
|
42 | from IPython.utils.traitlets import Instance, Type, Dict, CBool | |
43 | from IPython.utils.warn import warn, error |
|
43 | from IPython.utils.warn import warn, error | |
44 | from IPython.zmq.displayhook import ZMQShellDisplayHook, _encode_binary |
|
44 | from IPython.zmq.displayhook import ZMQShellDisplayHook, _encode_binary | |
45 | from IPython.zmq.session import extract_header |
|
45 | from IPython.zmq.session import extract_header | |
46 | from session import Session |
|
46 | from session import Session | |
47 |
|
47 | |||
48 | #----------------------------------------------------------------------------- |
|
48 | #----------------------------------------------------------------------------- | |
49 | # Globals and side-effects |
|
49 | # Globals and side-effects | |
50 | #----------------------------------------------------------------------------- |
|
50 | #----------------------------------------------------------------------------- | |
51 |
|
51 | |||
52 | # Install the payload version of page. |
|
52 | # Install the payload version of page. | |
53 | install_payload_page() |
|
53 | install_payload_page() | |
54 |
|
54 | |||
55 | #----------------------------------------------------------------------------- |
|
55 | #----------------------------------------------------------------------------- | |
56 | # Functions and classes |
|
56 | # Functions and classes | |
57 | #----------------------------------------------------------------------------- |
|
57 | #----------------------------------------------------------------------------- | |
58 |
|
58 | |||
59 | class ZMQDisplayPublisher(DisplayPublisher): |
|
59 | class ZMQDisplayPublisher(DisplayPublisher): | |
60 | """A display publisher that publishes data using a ZeroMQ PUB socket.""" |
|
60 | """A display publisher that publishes data using a ZeroMQ PUB socket.""" | |
61 |
|
61 | |||
62 | session = Instance(Session) |
|
62 | session = Instance(Session) | |
63 | pub_socket = Instance('zmq.Socket') |
|
63 | pub_socket = Instance('zmq.Socket') | |
64 | parent_header = Dict({}) |
|
64 | parent_header = Dict({}) | |
65 |
|
65 | |||
66 | def set_parent(self, parent): |
|
66 | def set_parent(self, parent): | |
67 | """Set the parent for outbound messages.""" |
|
67 | """Set the parent for outbound messages.""" | |
68 | self.parent_header = extract_header(parent) |
|
68 | self.parent_header = extract_header(parent) | |
69 |
|
69 | |||
70 | def publish(self, source, data, metadata=None): |
|
70 | def publish(self, source, data, metadata=None): | |
71 | if metadata is None: |
|
71 | if metadata is None: | |
72 | metadata = {} |
|
72 | metadata = {} | |
73 | self._validate_data(source, data, metadata) |
|
73 | self._validate_data(source, data, metadata) | |
74 | content = {} |
|
74 | content = {} | |
75 | content['source'] = source |
|
75 | content['source'] = source | |
76 | _encode_binary(data) |
|
76 | _encode_binary(data) | |
77 | content['data'] = data |
|
77 | content['data'] = data | |
78 | content['metadata'] = metadata |
|
78 | content['metadata'] = metadata | |
79 | self.session.send( |
|
79 | self.session.send( | |
80 | self.pub_socket, u'display_data', json_clean(content), |
|
80 | self.pub_socket, u'display_data', json_clean(content), | |
81 | parent=self.parent_header |
|
81 | parent=self.parent_header | |
82 | ) |
|
82 | ) | |
83 |
|
83 | |||
84 | def clear_output(self, stdout=True, stderr=True, other=True): |
|
84 | def clear_output(self, stdout=True, stderr=True, other=True): | |
85 | content = dict(stdout=stdout, stderr=stderr, other=other) |
|
85 | content = dict(stdout=stdout, stderr=stderr, other=other) | |
86 | self.session.send( |
|
86 | self.session.send( | |
87 | self.pub_socket, u'clear_output', content, |
|
87 | self.pub_socket, u'clear_output', content, | |
88 | parent=self.parent_header |
|
88 | parent=self.parent_header | |
89 | ) |
|
89 | ) | |
90 |
|
90 | |||
91 | class ZMQInteractiveShell(InteractiveShell): |
|
91 | class ZMQInteractiveShell(InteractiveShell): | |
92 | """A subclass of InteractiveShell for ZMQ.""" |
|
92 | """A subclass of InteractiveShell for ZMQ.""" | |
93 |
|
93 | |||
94 | displayhook_class = Type(ZMQShellDisplayHook) |
|
94 | displayhook_class = Type(ZMQShellDisplayHook) | |
95 | display_pub_class = Type(ZMQDisplayPublisher) |
|
95 | display_pub_class = Type(ZMQDisplayPublisher) | |
96 |
|
96 | |||
97 | # Override the traitlet in the parent class, because there's no point using |
|
97 | # Override the traitlet in the parent class, because there's no point using | |
98 | # readline for the kernel. Can be removed when the readline code is moved |
|
98 | # readline for the kernel. Can be removed when the readline code is moved | |
99 | # to the terminal frontend. |
|
99 | # to the terminal frontend. | |
100 | colors_force = CBool(True) |
|
100 | colors_force = CBool(True) | |
101 | readline_use = CBool(False) |
|
101 | readline_use = CBool(False) | |
102 | # autoindent has no meaning in a zmqshell, and attempting to enable it |
|
102 | # autoindent has no meaning in a zmqshell, and attempting to enable it | |
103 | # will print a warning in the absence of readline. |
|
103 | # will print a warning in the absence of readline. | |
104 | autoindent = CBool(False) |
|
104 | autoindent = CBool(False) | |
105 |
|
105 | |||
106 | exiter = Instance(ZMQExitAutocall) |
|
106 | exiter = Instance(ZMQExitAutocall) | |
107 | def _exiter_default(self): |
|
107 | def _exiter_default(self): | |
108 | return ZMQExitAutocall(self) |
|
108 | return ZMQExitAutocall(self) | |
109 |
|
109 | |||
110 | keepkernel_on_exit = None |
|
110 | keepkernel_on_exit = None | |
111 |
|
111 | |||
112 | def init_environment(self): |
|
112 | def init_environment(self): | |
113 | """Configure the user's environment. |
|
113 | """Configure the user's environment. | |
114 |
|
114 | |||
115 | """ |
|
115 | """ | |
116 | env = os.environ |
|
116 | env = os.environ | |
117 | # These two ensure 'ls' produces nice coloring on BSD-derived systems |
|
117 | # These two ensure 'ls' produces nice coloring on BSD-derived systems | |
118 | env['TERM'] = 'xterm-color' |
|
118 | env['TERM'] = 'xterm-color' | |
119 | env['CLICOLOR'] = '1' |
|
119 | env['CLICOLOR'] = '1' | |
120 | # Since normal pagers don't work at all (over pexpect we don't have |
|
120 | # Since normal pagers don't work at all (over pexpect we don't have | |
121 | # single-key control of the subprocess), try to disable paging in |
|
121 | # single-key control of the subprocess), try to disable paging in | |
122 | # subprocesses as much as possible. |
|
122 | # subprocesses as much as possible. | |
123 | env['PAGER'] = 'cat' |
|
123 | env['PAGER'] = 'cat' | |
124 | env['GIT_PAGER'] = 'cat' |
|
124 | env['GIT_PAGER'] = 'cat' | |
125 |
|
125 | |||
126 | def auto_rewrite_input(self, cmd): |
|
126 | def auto_rewrite_input(self, cmd): | |
127 | """Called to show the auto-rewritten input for autocall and friends. |
|
127 | """Called to show the auto-rewritten input for autocall and friends. | |
128 |
|
128 | |||
129 | FIXME: this payload is currently not correctly processed by the |
|
129 | FIXME: this payload is currently not correctly processed by the | |
130 | frontend. |
|
130 | frontend. | |
131 | """ |
|
131 | """ | |
132 | new = self.displayhook.prompt1.auto_rewrite() + cmd |
|
132 | new = self.displayhook.prompt1.auto_rewrite() + cmd | |
133 | payload = dict( |
|
133 | payload = dict( | |
134 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.auto_rewrite_input', |
|
134 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.auto_rewrite_input', | |
135 | transformed_input=new, |
|
135 | transformed_input=new, | |
136 | ) |
|
136 | ) | |
137 | self.payload_manager.write_payload(payload) |
|
137 | self.payload_manager.write_payload(payload) | |
138 |
|
138 | |||
139 | def ask_exit(self): |
|
139 | def ask_exit(self): | |
140 | """Engage the exit actions.""" |
|
140 | """Engage the exit actions.""" | |
141 | payload = dict( |
|
141 | payload = dict( | |
142 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.ask_exit', |
|
142 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.ask_exit', | |
143 | exit=True, |
|
143 | exit=True, | |
144 | keepkernel=self.keepkernel_on_exit, |
|
144 | keepkernel=self.keepkernel_on_exit, | |
145 | ) |
|
145 | ) | |
146 | self.payload_manager.write_payload(payload) |
|
146 | self.payload_manager.write_payload(payload) | |
147 |
|
147 | |||
148 | def _showtraceback(self, etype, evalue, stb): |
|
148 | def _showtraceback(self, etype, evalue, stb): | |
149 |
|
149 | |||
150 | exc_content = { |
|
150 | exc_content = { | |
151 | u'traceback' : stb, |
|
151 | u'traceback' : stb, | |
152 | u'ename' : unicode(etype.__name__), |
|
152 | u'ename' : unicode(etype.__name__), | |
153 | u'evalue' : unicode(evalue) |
|
153 | u'evalue' : unicode(evalue) | |
154 | } |
|
154 | } | |
155 |
|
155 | |||
156 | dh = self.displayhook |
|
156 | dh = self.displayhook | |
157 | # Send exception info over pub socket for other clients than the caller |
|
157 | # Send exception info over pub socket for other clients than the caller | |
158 | # to pick up |
|
158 | # to pick up | |
159 | exc_msg = dh.session.send(dh.pub_socket, u'pyerr', json_clean(exc_content), dh.parent_header) |
|
159 | exc_msg = dh.session.send(dh.pub_socket, u'pyerr', json_clean(exc_content), dh.parent_header) | |
160 |
|
160 | |||
161 | # FIXME - Hack: store exception info in shell object. Right now, the |
|
161 | # FIXME - Hack: store exception info in shell object. Right now, the | |
162 | # caller is reading this info after the fact, we need to fix this logic |
|
162 | # caller is reading this info after the fact, we need to fix this logic | |
163 | # to remove this hack. Even uglier, we need to store the error status |
|
163 | # to remove this hack. Even uglier, we need to store the error status | |
164 | # here, because in the main loop, the logic that sets it is being |
|
164 | # here, because in the main loop, the logic that sets it is being | |
165 | # skipped because runlines swallows the exceptions. |
|
165 | # skipped because runlines swallows the exceptions. | |
166 | exc_content[u'status'] = u'error' |
|
166 | exc_content[u'status'] = u'error' | |
167 | self._reply_content = exc_content |
|
167 | self._reply_content = exc_content | |
168 | # /FIXME |
|
168 | # /FIXME | |
169 |
|
169 | |||
170 | return exc_content |
|
170 | return exc_content | |
171 |
|
171 | |||
172 | #------------------------------------------------------------------------ |
|
172 | #------------------------------------------------------------------------ | |
173 | # Magic overrides |
|
173 | # Magic overrides | |
174 | #------------------------------------------------------------------------ |
|
174 | #------------------------------------------------------------------------ | |
175 | # Once the base class stops inheriting from magic, this code needs to be |
|
175 | # Once the base class stops inheriting from magic, this code needs to be | |
176 | # moved into a separate machinery as well. For now, at least isolate here |
|
176 | # moved into a separate machinery as well. For now, at least isolate here | |
177 | # the magics which this class needs to implement differently from the base |
|
177 | # the magics which this class needs to implement differently from the base | |
178 | # class, or that are unique to it. |
|
178 | # class, or that are unique to it. | |
179 |
|
179 | |||
180 | def magic_doctest_mode(self,parameter_s=''): |
|
180 | def magic_doctest_mode(self,parameter_s=''): | |
181 | """Toggle doctest mode on and off. |
|
181 | """Toggle doctest mode on and off. | |
182 |
|
182 | |||
183 | This mode is intended to make IPython behave as much as possible like a |
|
183 | This mode is intended to make IPython behave as much as possible like a | |
184 | plain Python shell, from the perspective of how its prompts, exceptions |
|
184 | plain Python shell, from the perspective of how its prompts, exceptions | |
185 | and output look. This makes it easy to copy and paste parts of a |
|
185 | and output look. This makes it easy to copy and paste parts of a | |
186 | session into doctests. It does so by: |
|
186 | session into doctests. It does so by: | |
187 |
|
187 | |||
188 | - Changing the prompts to the classic ``>>>`` ones. |
|
188 | - Changing the prompts to the classic ``>>>`` ones. | |
189 | - Changing the exception reporting mode to 'Plain'. |
|
189 | - Changing the exception reporting mode to 'Plain'. | |
190 | - Disabling pretty-printing of output. |
|
190 | - Disabling pretty-printing of output. | |
191 |
|
191 | |||
192 | Note that IPython also supports the pasting of code snippets that have |
|
192 | Note that IPython also supports the pasting of code snippets that have | |
193 | leading '>>>' and '...' prompts in them. This means that you can paste |
|
193 | leading '>>>' and '...' prompts in them. This means that you can paste | |
194 | doctests from files or docstrings (even if they have leading |
|
194 | doctests from files or docstrings (even if they have leading | |
195 | whitespace), and the code will execute correctly. You can then use |
|
195 | whitespace), and the code will execute correctly. You can then use | |
196 | '%history -t' to see the translated history; this will give you the |
|
196 | '%history -t' to see the translated history; this will give you the | |
197 | input after removal of all the leading prompts and whitespace, which |
|
197 | input after removal of all the leading prompts and whitespace, which | |
198 | can be pasted back into an editor. |
|
198 | can be pasted back into an editor. | |
199 |
|
199 | |||
200 | With these features, you can switch into this mode easily whenever you |
|
200 | With these features, you can switch into this mode easily whenever you | |
201 | need to do testing and changes to doctests, without having to leave |
|
201 | need to do testing and changes to doctests, without having to leave | |
202 | your existing IPython session. |
|
202 | your existing IPython session. | |
203 | """ |
|
203 | """ | |
204 |
|
204 | |||
205 | from IPython.utils.ipstruct import Struct |
|
205 | from IPython.utils.ipstruct import Struct | |
206 |
|
206 | |||
207 | # Shorthands |
|
207 | # Shorthands | |
208 | shell = self.shell |
|
208 | shell = self.shell | |
209 | disp_formatter = self.shell.display_formatter |
|
209 | disp_formatter = self.shell.display_formatter | |
210 | ptformatter = disp_formatter.formatters['text/plain'] |
|
210 | ptformatter = disp_formatter.formatters['text/plain'] | |
211 | # dstore is a data store kept in the instance metadata bag to track any |
|
211 | # dstore is a data store kept in the instance metadata bag to track any | |
212 | # changes we make, so we can undo them later. |
|
212 | # changes we make, so we can undo them later. | |
213 | dstore = shell.meta.setdefault('doctest_mode', Struct()) |
|
213 | dstore = shell.meta.setdefault('doctest_mode', Struct()) | |
214 | save_dstore = dstore.setdefault |
|
214 | save_dstore = dstore.setdefault | |
215 |
|
215 | |||
216 | # save a few values we'll need to recover later |
|
216 | # save a few values we'll need to recover later | |
217 | mode = save_dstore('mode', False) |
|
217 | mode = save_dstore('mode', False) | |
218 | save_dstore('rc_pprint', ptformatter.pprint) |
|
218 | save_dstore('rc_pprint', ptformatter.pprint) | |
219 | save_dstore('rc_plain_text_only',disp_formatter.plain_text_only) |
|
219 | save_dstore('rc_plain_text_only',disp_formatter.plain_text_only) | |
220 | save_dstore('xmode', shell.InteractiveTB.mode) |
|
220 | save_dstore('xmode', shell.InteractiveTB.mode) | |
221 |
|
221 | |||
222 | if mode == False: |
|
222 | if mode == False: | |
223 | # turn on |
|
223 | # turn on | |
224 | ptformatter.pprint = False |
|
224 | ptformatter.pprint = False | |
225 | disp_formatter.plain_text_only = True |
|
225 | disp_formatter.plain_text_only = True | |
226 | shell.magic_xmode('Plain') |
|
226 | shell.magic_xmode('Plain') | |
227 | else: |
|
227 | else: | |
228 | # turn off |
|
228 | # turn off | |
229 | ptformatter.pprint = dstore.rc_pprint |
|
229 | ptformatter.pprint = dstore.rc_pprint | |
230 | disp_formatter.plain_text_only = dstore.rc_plain_text_only |
|
230 | disp_formatter.plain_text_only = dstore.rc_plain_text_only | |
231 | shell.magic_xmode(dstore.xmode) |
|
231 | shell.magic_xmode(dstore.xmode) | |
232 |
|
232 | |||
233 | # Store new mode and inform on console |
|
233 | # Store new mode and inform on console | |
234 | dstore.mode = bool(1-int(mode)) |
|
234 | dstore.mode = bool(1-int(mode)) | |
235 | mode_label = ['OFF','ON'][dstore.mode] |
|
235 | mode_label = ['OFF','ON'][dstore.mode] | |
236 | print('Doctest mode is:', mode_label) |
|
236 | print('Doctest mode is:', mode_label) | |
237 |
|
237 | |||
238 | # Send the payload back so that clients can modify their prompt display |
|
238 | # Send the payload back so that clients can modify their prompt display | |
239 | payload = dict( |
|
239 | payload = dict( | |
240 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.magic_doctest_mode', |
|
240 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.magic_doctest_mode', | |
241 | mode=dstore.mode) |
|
241 | mode=dstore.mode) | |
242 | self.payload_manager.write_payload(payload) |
|
242 | self.payload_manager.write_payload(payload) | |
243 |
|
243 | |||
244 | def magic_edit(self,parameter_s='',last_call=['','']): |
|
244 | def magic_edit(self,parameter_s='',last_call=['','']): | |
245 | """Bring up an editor and execute the resulting code. |
|
245 | """Bring up an editor and execute the resulting code. | |
246 |
|
246 | |||
247 | Usage: |
|
247 | Usage: | |
248 | %edit [options] [args] |
|
248 | %edit [options] [args] | |
249 |
|
249 | |||
250 | %edit runs an external text editor. You will need to set the command for |
|
250 | %edit runs an external text editor. You will need to set the command for | |
251 | this editor via the ``TerminalInteractiveShell.editor`` option in your |
|
251 | this editor via the ``TerminalInteractiveShell.editor`` option in your | |
252 | configuration file before it will work. |
|
252 | configuration file before it will work. | |
253 |
|
253 | |||
254 | This command allows you to conveniently edit multi-line code right in |
|
254 | This command allows you to conveniently edit multi-line code right in | |
255 | your IPython session. |
|
255 | your IPython session. | |
256 |
|
256 | |||
257 | If called without arguments, %edit opens up an empty editor with a |
|
257 | If called without arguments, %edit opens up an empty editor with a | |
258 | temporary file and will execute the contents of this file when you |
|
258 | temporary file and will execute the contents of this file when you | |
259 | close it (don't forget to save it!). |
|
259 | close it (don't forget to save it!). | |
260 |
|
260 | |||
261 |
|
261 | |||
262 | Options: |
|
262 | Options: | |
263 |
|
263 | |||
264 | -n <number>: open the editor at a specified line number. By default, |
|
264 | -n <number>: open the editor at a specified line number. By default, | |
265 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
265 | the IPython editor hook uses the unix syntax 'editor +N filename', but | |
266 | you can configure this by providing your own modified hook if your |
|
266 | you can configure this by providing your own modified hook if your | |
267 | favorite editor supports line-number specifications with a different |
|
267 | favorite editor supports line-number specifications with a different | |
268 | syntax. |
|
268 | syntax. | |
269 |
|
269 | |||
270 | -p: this will call the editor with the same data as the previous time |
|
270 | -p: this will call the editor with the same data as the previous time | |
271 | it was used, regardless of how long ago (in your current session) it |
|
271 | it was used, regardless of how long ago (in your current session) it | |
272 | was. |
|
272 | was. | |
273 |
|
273 | |||
274 | -r: use 'raw' input. This option only applies to input taken from the |
|
274 | -r: use 'raw' input. This option only applies to input taken from the | |
275 | user's history. By default, the 'processed' history is used, so that |
|
275 | user's history. By default, the 'processed' history is used, so that | |
276 | magics are loaded in their transformed version to valid Python. If |
|
276 | magics are loaded in their transformed version to valid Python. If | |
277 | this option is given, the raw input as typed as the command line is |
|
277 | this option is given, the raw input as typed as the command line is | |
278 | used instead. When you exit the editor, it will be executed by |
|
278 | used instead. When you exit the editor, it will be executed by | |
279 | IPython's own processor. |
|
279 | IPython's own processor. | |
280 |
|
280 | |||
281 | -x: do not execute the edited code immediately upon exit. This is |
|
281 | -x: do not execute the edited code immediately upon exit. This is | |
282 | mainly useful if you are editing programs which need to be called with |
|
282 | mainly useful if you are editing programs which need to be called with | |
283 | command line arguments, which you can then do using %run. |
|
283 | command line arguments, which you can then do using %run. | |
284 |
|
284 | |||
285 |
|
285 | |||
286 | Arguments: |
|
286 | Arguments: | |
287 |
|
287 | |||
288 | If arguments are given, the following possibilites exist: |
|
288 | If arguments are given, the following possibilites exist: | |
289 |
|
289 | |||
290 | - The arguments are numbers or pairs of colon-separated numbers (like |
|
290 | - The arguments are numbers or pairs of colon-separated numbers (like | |
291 | 1 4:8 9). These are interpreted as lines of previous input to be |
|
291 | 1 4:8 9). These are interpreted as lines of previous input to be | |
292 | loaded into the editor. The syntax is the same of the %macro command. |
|
292 | loaded into the editor. The syntax is the same of the %macro command. | |
293 |
|
293 | |||
294 | - If the argument doesn't start with a number, it is evaluated as a |
|
294 | - If the argument doesn't start with a number, it is evaluated as a | |
295 | variable and its contents loaded into the editor. You can thus edit |
|
295 | variable and its contents loaded into the editor. You can thus edit | |
296 | any string which contains python code (including the result of |
|
296 | any string which contains python code (including the result of | |
297 | previous edits). |
|
297 | previous edits). | |
298 |
|
298 | |||
299 | - If the argument is the name of an object (other than a string), |
|
299 | - If the argument is the name of an object (other than a string), | |
300 | IPython will try to locate the file where it was defined and open the |
|
300 | IPython will try to locate the file where it was defined and open the | |
301 | editor at the point where it is defined. You can use `%edit function` |
|
301 | editor at the point where it is defined. You can use `%edit function` | |
302 | to load an editor exactly at the point where 'function' is defined, |
|
302 | to load an editor exactly at the point where 'function' is defined, | |
303 | edit it and have the file be executed automatically. |
|
303 | edit it and have the file be executed automatically. | |
304 |
|
304 | |||
305 | If the object is a macro (see %macro for details), this opens up your |
|
305 | If the object is a macro (see %macro for details), this opens up your | |
306 | specified editor with a temporary file containing the macro's data. |
|
306 | specified editor with a temporary file containing the macro's data. | |
307 | Upon exit, the macro is reloaded with the contents of the file. |
|
307 | Upon exit, the macro is reloaded with the contents of the file. | |
308 |
|
308 | |||
309 | Note: opening at an exact line is only supported under Unix, and some |
|
309 | Note: opening at an exact line is only supported under Unix, and some | |
310 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
310 | editors (like kedit and gedit up to Gnome 2.8) do not understand the | |
311 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
311 | '+NUMBER' parameter necessary for this feature. Good editors like | |
312 | (X)Emacs, vi, jed, pico and joe all do. |
|
312 | (X)Emacs, vi, jed, pico and joe all do. | |
313 |
|
313 | |||
314 | - If the argument is not found as a variable, IPython will look for a |
|
314 | - If the argument is not found as a variable, IPython will look for a | |
315 | file with that name (adding .py if necessary) and load it into the |
|
315 | file with that name (adding .py if necessary) and load it into the | |
316 | editor. It will execute its contents with execfile() when you exit, |
|
316 | editor. It will execute its contents with execfile() when you exit, | |
317 | loading any code in the file into your interactive namespace. |
|
317 | loading any code in the file into your interactive namespace. | |
318 |
|
318 | |||
319 | After executing your code, %edit will return as output the code you |
|
319 | After executing your code, %edit will return as output the code you | |
320 | typed in the editor (except when it was an existing file). This way |
|
320 | typed in the editor (except when it was an existing file). This way | |
321 | you can reload the code in further invocations of %edit as a variable, |
|
321 | you can reload the code in further invocations of %edit as a variable, | |
322 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
322 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of | |
323 | the output. |
|
323 | the output. | |
324 |
|
324 | |||
325 | Note that %edit is also available through the alias %ed. |
|
325 | Note that %edit is also available through the alias %ed. | |
326 |
|
326 | |||
327 | This is an example of creating a simple function inside the editor and |
|
327 | This is an example of creating a simple function inside the editor and | |
328 | then modifying it. First, start up the editor: |
|
328 | then modifying it. First, start up the editor: | |
329 |
|
329 | |||
330 | In [1]: ed |
|
330 | In [1]: ed | |
331 | Editing... done. Executing edited code... |
|
331 | Editing... done. Executing edited code... | |
332 | Out[1]: 'def foo():n print "foo() was defined in an editing session"n' |
|
332 | Out[1]: 'def foo():n print "foo() was defined in an editing session"n' | |
333 |
|
333 | |||
334 | We can then call the function foo(): |
|
334 | We can then call the function foo(): | |
335 |
|
335 | |||
336 | In [2]: foo() |
|
336 | In [2]: foo() | |
337 | foo() was defined in an editing session |
|
337 | foo() was defined in an editing session | |
338 |
|
338 | |||
339 | Now we edit foo. IPython automatically loads the editor with the |
|
339 | Now we edit foo. IPython automatically loads the editor with the | |
340 | (temporary) file where foo() was previously defined: |
|
340 | (temporary) file where foo() was previously defined: | |
341 |
|
341 | |||
342 | In [3]: ed foo |
|
342 | In [3]: ed foo | |
343 | Editing... done. Executing edited code... |
|
343 | Editing... done. Executing edited code... | |
344 |
|
344 | |||
345 | And if we call foo() again we get the modified version: |
|
345 | And if we call foo() again we get the modified version: | |
346 |
|
346 | |||
347 | In [4]: foo() |
|
347 | In [4]: foo() | |
348 | foo() has now been changed! |
|
348 | foo() has now been changed! | |
349 |
|
349 | |||
350 | Here is an example of how to edit a code snippet successive |
|
350 | Here is an example of how to edit a code snippet successive | |
351 | times. First we call the editor: |
|
351 | times. First we call the editor: | |
352 |
|
352 | |||
353 | In [5]: ed |
|
353 | In [5]: ed | |
354 | Editing... done. Executing edited code... |
|
354 | Editing... done. Executing edited code... | |
355 | hello |
|
355 | hello | |
356 | Out[5]: "print 'hello'n" |
|
356 | Out[5]: "print 'hello'n" | |
357 |
|
357 | |||
358 | Now we call it again with the previous output (stored in _): |
|
358 | Now we call it again with the previous output (stored in _): | |
359 |
|
359 | |||
360 | In [6]: ed _ |
|
360 | In [6]: ed _ | |
361 | Editing... done. Executing edited code... |
|
361 | Editing... done. Executing edited code... | |
362 | hello world |
|
362 | hello world | |
363 | Out[6]: "print 'hello world'n" |
|
363 | Out[6]: "print 'hello world'n" | |
364 |
|
364 | |||
365 | Now we call it with the output #8 (stored in _8, also as Out[8]): |
|
365 | Now we call it with the output #8 (stored in _8, also as Out[8]): | |
366 |
|
366 | |||
367 | In [7]: ed _8 |
|
367 | In [7]: ed _8 | |
368 | Editing... done. Executing edited code... |
|
368 | Editing... done. Executing edited code... | |
369 | hello again |
|
369 | hello again | |
370 | Out[7]: "print 'hello again'n" |
|
370 | Out[7]: "print 'hello again'n" | |
371 | """ |
|
371 | """ | |
372 |
|
372 | |||
373 | opts,args = self.parse_options(parameter_s,'prn:') |
|
373 | opts,args = self.parse_options(parameter_s,'prn:') | |
374 |
|
374 | |||
375 | try: |
|
375 | try: | |
376 | filename, lineno, _ = self._find_edit_target(args, opts, last_call) |
|
376 | filename, lineno, _ = self._find_edit_target(args, opts, last_call) | |
377 | except MacroToEdit as e: |
|
377 | except MacroToEdit as e: | |
378 | # TODO: Implement macro editing over 2 processes. |
|
378 | # TODO: Implement macro editing over 2 processes. | |
379 | print("Macro editing not yet implemented in 2-process model.") |
|
379 | print("Macro editing not yet implemented in 2-process model.") | |
380 | return |
|
380 | return | |
381 |
|
381 | |||
382 | # Make sure we send to the client an absolute path, in case the working |
|
382 | # Make sure we send to the client an absolute path, in case the working | |
383 | # directory of client and kernel don't match |
|
383 | # directory of client and kernel don't match | |
384 | filename = os.path.abspath(filename) |
|
384 | filename = os.path.abspath(filename) | |
385 |
|
385 | |||
386 | payload = { |
|
386 | payload = { | |
387 | 'source' : 'IPython.zmq.zmqshell.ZMQInteractiveShell.edit_magic', |
|
387 | 'source' : 'IPython.zmq.zmqshell.ZMQInteractiveShell.edit_magic', | |
388 | 'filename' : filename, |
|
388 | 'filename' : filename, | |
389 | 'line_number' : lineno |
|
389 | 'line_number' : lineno | |
390 | } |
|
390 | } | |
391 | self.payload_manager.write_payload(payload) |
|
391 | self.payload_manager.write_payload(payload) | |
392 |
|
392 | |||
393 |
def |
|
393 | def enable_gui(self, gui=None): | |
394 | """Enable or disable IPython GUI event loop integration. |
|
|||
395 |
|
||||
396 | %gui [GUINAME] |
|
|||
397 |
|
||||
398 | This magic replaces IPython's threaded shells that were activated |
|
|||
399 | using the (pylab/wthread/etc.) command line flags. GUI toolkits |
|
|||
400 | can now be enabled at runtime and keyboard |
|
|||
401 | interrupts should work without any problems. The following toolkits |
|
|||
402 | are supported: wxPython, PyQt4, PyGTK, Cocoa, and Tk:: |
|
|||
403 |
|
||||
404 | %gui wx # enable wxPython event loop integration |
|
|||
405 | %gui qt4|qt # enable PyQt4 event loop integration |
|
|||
406 | %gui gtk # enable PyGTK event loop integration |
|
|||
407 | %gui OSX # enable Cocoa event loop integration (requires matplotlib 1.1) |
|
|||
408 | %gui tk # enable Tk event loop integration |
|
|||
409 |
|
||||
410 | WARNING: after any of these has been called you can simply create |
|
|||
411 | an application object, but DO NOT start the event loop yourself, as |
|
|||
412 | we have already handled that. |
|
|||
413 | """ |
|
|||
414 | from IPython.zmq.ipkernel import enable_gui |
|
|||
415 | opts, arg = self.parse_options(parameter_s, '') |
|
|||
416 | if arg=='': arg = None |
|
|||
417 | try: |
|
|||
418 | enable_gui(arg) |
|
|||
419 | except Exception as e: |
|
|||
420 | # print simple error message, rather than traceback if we can't |
|
|||
421 | # hook up the GUI |
|
|||
422 | error(str(e)) |
|
|||
423 |
|
||||
424 | def enable_pylab(self, gui=None, import_all=True): |
|
|||
425 | """Activate pylab support at runtime. |
|
|||
426 |
|
||||
427 | This turns on support for matplotlib, preloads into the interactive |
|
|||
428 | namespace all of numpy and pylab, and configures IPython to correcdtly |
|
|||
429 | interact with the GUI event loop. The GUI backend to be used can be |
|
|||
430 | optionally selected with the optional :param:`gui` argument. |
|
|||
431 |
|
||||
432 | Parameters |
|
|||
433 | ---------- |
|
|||
434 | gui : optional, string [default: inline] |
|
|||
435 |
|
||||
436 | If given, dictates the choice of matplotlib GUI backend to use |
|
|||
437 | (should be one of IPython's supported backends, 'inline', 'qt', 'osx', |
|
|||
438 | 'tk', or 'gtk'), otherwise we use the default chosen by matplotlib |
|
|||
439 | (as dictated by the matplotlib build-time options plus the user's |
|
|||
440 | matplotlibrc configuration file). |
|
|||
441 | """ |
|
|||
442 | from IPython.zmq.ipkernel import enable_gui |
|
394 | from IPython.zmq.ipkernel import enable_gui | |
443 | # We want to prevent the loading of pylab to pollute the user's |
|
395 | enable_gui(gui) | |
444 | # namespace as shown by the %who* magics, so we execute the activation |
|
|||
445 | # code in an empty namespace, and we update *both* user_ns and |
|
|||
446 | # user_ns_hidden with this information. |
|
|||
447 | ns = {} |
|
|||
448 | try: |
|
|||
449 | gui = pylabtools.pylab_activate(ns, gui, import_all, self) |
|
|||
450 | except KeyError: |
|
|||
451 | error("Backend %r not supported" % gui) |
|
|||
452 | return |
|
|||
453 | self.user_ns.update(ns) |
|
|||
454 | self.user_ns_hidden.update(ns) |
|
|||
455 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
|||
456 | # plot updates into account |
|
|||
457 | try: |
|
|||
458 | enable_gui(gui) |
|
|||
459 | except Exception as e: |
|
|||
460 | # print simple error message, rather than traceback if we can't |
|
|||
461 | # hook up the GUI |
|
|||
462 | error(str(e)) |
|
|||
463 | self.magic_run = self._pylab_magic_run |
|
|||
464 |
|
||||
465 |
|
396 | |||
466 | # A few magics that are adapted to the specifics of using pexpect and a |
|
397 | # A few magics that are adapted to the specifics of using pexpect and a | |
467 | # remote terminal |
|
398 | # remote terminal | |
468 |
|
399 | |||
469 | def magic_clear(self, arg_s): |
|
400 | def magic_clear(self, arg_s): | |
470 | """Clear the terminal.""" |
|
401 | """Clear the terminal.""" | |
471 | if os.name == 'posix': |
|
402 | if os.name == 'posix': | |
472 | self.shell.system("clear") |
|
403 | self.shell.system("clear") | |
473 | else: |
|
404 | else: | |
474 | self.shell.system("cls") |
|
405 | self.shell.system("cls") | |
475 |
|
406 | |||
476 | if os.name == 'nt': |
|
407 | if os.name == 'nt': | |
477 | # This is the usual name in windows |
|
408 | # This is the usual name in windows | |
478 | magic_cls = magic_clear |
|
409 | magic_cls = magic_clear | |
479 |
|
410 | |||
480 | # Terminal pagers won't work over pexpect, but we do have our own pager |
|
411 | # Terminal pagers won't work over pexpect, but we do have our own pager | |
481 |
|
412 | |||
482 | def magic_less(self, arg_s): |
|
413 | def magic_less(self, arg_s): | |
483 | """Show a file through the pager. |
|
414 | """Show a file through the pager. | |
484 |
|
415 | |||
485 | Files ending in .py are syntax-highlighted.""" |
|
416 | Files ending in .py are syntax-highlighted.""" | |
486 | cont = open(arg_s).read() |
|
417 | cont = open(arg_s).read() | |
487 | if arg_s.endswith('.py'): |
|
418 | if arg_s.endswith('.py'): | |
488 | cont = self.shell.pycolorize(cont) |
|
419 | cont = self.shell.pycolorize(cont) | |
489 | page.page(cont) |
|
420 | page.page(cont) | |
490 |
|
421 | |||
491 | magic_more = magic_less |
|
422 | magic_more = magic_less | |
492 |
|
423 | |||
493 | # Man calls a pager, so we also need to redefine it |
|
424 | # Man calls a pager, so we also need to redefine it | |
494 | if os.name == 'posix': |
|
425 | if os.name == 'posix': | |
495 | def magic_man(self, arg_s): |
|
426 | def magic_man(self, arg_s): | |
496 | """Find the man page for the given command and display in pager.""" |
|
427 | """Find the man page for the given command and display in pager.""" | |
497 | page.page(self.shell.getoutput('man %s | col -b' % arg_s, |
|
428 | page.page(self.shell.getoutput('man %s | col -b' % arg_s, | |
498 | split=False)) |
|
429 | split=False)) | |
499 |
|
430 | |||
500 | # FIXME: this is specific to the GUI, so we should let the gui app load |
|
431 | # FIXME: this is specific to the GUI, so we should let the gui app load | |
501 | # magics at startup that are only for the gui. Once the gui app has proper |
|
432 | # magics at startup that are only for the gui. Once the gui app has proper | |
502 | # profile and configuration management, we can have it initialize a kernel |
|
433 | # profile and configuration management, we can have it initialize a kernel | |
503 | # with a special config file that provides these. |
|
434 | # with a special config file that provides these. | |
504 | def magic_guiref(self, arg_s): |
|
435 | def magic_guiref(self, arg_s): | |
505 | """Show a basic reference about the GUI console.""" |
|
436 | """Show a basic reference about the GUI console.""" | |
506 | from IPython.core.usage import gui_reference |
|
437 | from IPython.core.usage import gui_reference | |
507 | page.page(gui_reference, auto_html=True) |
|
438 | page.page(gui_reference, auto_html=True) | |
508 |
|
439 | |||
509 | def magic_connect_info(self, arg_s): |
|
440 | def magic_connect_info(self, arg_s): | |
510 | """Print information for connecting other clients to this kernel |
|
441 | """Print information for connecting other clients to this kernel | |
511 |
|
442 | |||
512 | It will print the contents of this session's connection file, as well as |
|
443 | It will print the contents of this session's connection file, as well as | |
513 | shortcuts for local clients. |
|
444 | shortcuts for local clients. | |
514 |
|
445 | |||
515 | In the simplest case, when called from the most recently launched kernel, |
|
446 | In the simplest case, when called from the most recently launched kernel, | |
516 | secondary clients can be connected, simply with: |
|
447 | secondary clients can be connected, simply with: | |
517 |
|
448 | |||
518 | $> ipython <app> --existing |
|
449 | $> ipython <app> --existing | |
519 |
|
450 | |||
520 | """ |
|
451 | """ | |
521 |
|
452 | |||
522 | from IPython.core.application import BaseIPythonApplication as BaseIPApp |
|
453 | from IPython.core.application import BaseIPythonApplication as BaseIPApp | |
523 |
|
454 | |||
524 | if BaseIPApp.initialized(): |
|
455 | if BaseIPApp.initialized(): | |
525 | app = BaseIPApp.instance() |
|
456 | app = BaseIPApp.instance() | |
526 | security_dir = app.profile_dir.security_dir |
|
457 | security_dir = app.profile_dir.security_dir | |
527 | profile = app.profile |
|
458 | profile = app.profile | |
528 | else: |
|
459 | else: | |
529 | profile = 'default' |
|
460 | profile = 'default' | |
530 | security_dir = '' |
|
461 | security_dir = '' | |
531 |
|
462 | |||
532 | try: |
|
463 | try: | |
533 | connection_file = get_connection_file() |
|
464 | connection_file = get_connection_file() | |
534 | info = get_connection_info(unpack=False) |
|
465 | info = get_connection_info(unpack=False) | |
535 | except Exception as e: |
|
466 | except Exception as e: | |
536 | error("Could not get connection info: %r" % e) |
|
467 | error("Could not get connection info: %r" % e) | |
537 | return |
|
468 | return | |
538 |
|
469 | |||
539 | # add profile flag for non-default profile |
|
470 | # add profile flag for non-default profile | |
540 | profile_flag = "--profile %s" % profile if profile != 'default' else "" |
|
471 | profile_flag = "--profile %s" % profile if profile != 'default' else "" | |
541 |
|
472 | |||
542 | # if it's in the security dir, truncate to basename |
|
473 | # if it's in the security dir, truncate to basename | |
543 | if security_dir == os.path.dirname(connection_file): |
|
474 | if security_dir == os.path.dirname(connection_file): | |
544 | connection_file = os.path.basename(connection_file) |
|
475 | connection_file = os.path.basename(connection_file) | |
545 |
|
476 | |||
546 |
|
477 | |||
547 | print (info + '\n') |
|
478 | print (info + '\n') | |
548 | print ("Paste the above JSON into a file, and connect with:\n" |
|
479 | print ("Paste the above JSON into a file, and connect with:\n" | |
549 | " $> ipython <app> --existing <file>\n" |
|
480 | " $> ipython <app> --existing <file>\n" | |
550 | "or, if you are local, you can connect with just:\n" |
|
481 | "or, if you are local, you can connect with just:\n" | |
551 | " $> ipython <app> --existing {0} {1}\n" |
|
482 | " $> ipython <app> --existing {0} {1}\n" | |
552 | "or even just:\n" |
|
483 | "or even just:\n" | |
553 | " $> ipython <app> --existing {1}\n" |
|
484 | " $> ipython <app> --existing {1}\n" | |
554 | "if this is the most recent IPython session you have started.".format( |
|
485 | "if this is the most recent IPython session you have started.".format( | |
555 | connection_file, profile_flag |
|
486 | connection_file, profile_flag | |
556 | ) |
|
487 | ) | |
557 | ) |
|
488 | ) | |
558 |
|
489 | |||
559 | def magic_qtconsole(self, arg_s): |
|
490 | def magic_qtconsole(self, arg_s): | |
560 | """Open a qtconsole connected to this kernel. |
|
491 | """Open a qtconsole connected to this kernel. | |
561 |
|
492 | |||
562 | Useful for connecting a qtconsole to running notebooks, for better |
|
493 | Useful for connecting a qtconsole to running notebooks, for better | |
563 | debugging. |
|
494 | debugging. | |
564 | """ |
|
495 | """ | |
565 | try: |
|
496 | try: | |
566 | p = connect_qtconsole(argv=arg_split(arg_s, os.name=='posix')) |
|
497 | p = connect_qtconsole(argv=arg_split(arg_s, os.name=='posix')) | |
567 | except Exception as e: |
|
498 | except Exception as e: | |
568 | error("Could not start qtconsole: %r" % e) |
|
499 | error("Could not start qtconsole: %r" % e) | |
569 | return |
|
500 | return | |
570 |
|
||||
571 |
|
501 | |||
572 | def set_next_input(self, text): |
|
502 | def set_next_input(self, text): | |
573 | """Send the specified text to the frontend to be presented at the next |
|
503 | """Send the specified text to the frontend to be presented at the next | |
574 | input cell.""" |
|
504 | input cell.""" | |
575 | payload = dict( |
|
505 | payload = dict( | |
576 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.set_next_input', |
|
506 | source='IPython.zmq.zmqshell.ZMQInteractiveShell.set_next_input', | |
577 | text=text |
|
507 | text=text | |
578 | ) |
|
508 | ) | |
579 | self.payload_manager.write_payload(payload) |
|
509 | self.payload_manager.write_payload(payload) | |
580 |
|
510 | |||
|
511 | ||||
581 | InteractiveShellABC.register(ZMQInteractiveShell) |
|
512 | InteractiveShellABC.register(ZMQInteractiveShell) |
General Comments 0
You need to be logged in to leave comments.
Login now