Show More
@@ -1,2757 +1,2756 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.core.pylabtools import pylab_activate | |
66 | from IPython.core.prompts import PromptManager |
|
66 | from IPython.core.prompts import PromptManager | |
67 | from IPython.external.Itpl import ItplNS |
|
|||
68 | from IPython.utils import PyColorize |
|
67 | from IPython.utils import PyColorize | |
69 | from IPython.utils import io |
|
68 | from IPython.utils import io | |
70 | from IPython.utils import py3compat |
|
69 | from IPython.utils import py3compat | |
71 | from IPython.utils.doctestreload import doctest_reload |
|
70 | from IPython.utils.doctestreload import doctest_reload | |
72 | from IPython.utils.io import ask_yes_no, rprint |
|
71 | from IPython.utils.io import ask_yes_no, rprint | |
73 | from IPython.utils.ipstruct import Struct |
|
72 | from IPython.utils.ipstruct import Struct | |
74 | 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 | |
75 | from IPython.utils.pickleshare import PickleShareDB |
|
74 | from IPython.utils.pickleshare import PickleShareDB | |
76 | from IPython.utils.process import system, getoutput |
|
75 | from IPython.utils.process import system, getoutput | |
77 | from IPython.utils.strdispatch import StrDispatch |
|
76 | from IPython.utils.strdispatch import StrDispatch | |
78 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
77 | from IPython.utils.syspathcontext import prepended_to_syspath | |
79 | 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, | |
80 | DollarFormatter) |
|
79 | DollarFormatter) | |
81 | from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum, |
|
80 | from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum, | |
82 | List, Unicode, Instance, Type) |
|
81 | List, Unicode, Instance, Type) | |
83 | from IPython.utils.warn import warn, error, fatal |
|
82 | from IPython.utils.warn import warn, error, fatal | |
84 | import IPython.core.hooks |
|
83 | import IPython.core.hooks | |
85 |
|
84 | |||
86 | #----------------------------------------------------------------------------- |
|
85 | #----------------------------------------------------------------------------- | |
87 | # Globals |
|
86 | # Globals | |
88 | #----------------------------------------------------------------------------- |
|
87 | #----------------------------------------------------------------------------- | |
89 |
|
88 | |||
90 | # compiled regexps for autoindent management |
|
89 | # compiled regexps for autoindent management | |
91 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
90 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
92 |
|
91 | |||
93 | #----------------------------------------------------------------------------- |
|
92 | #----------------------------------------------------------------------------- | |
94 | # Utilities |
|
93 | # Utilities | |
95 | #----------------------------------------------------------------------------- |
|
94 | #----------------------------------------------------------------------------- | |
96 |
|
95 | |||
97 | def softspace(file, newvalue): |
|
96 | def softspace(file, newvalue): | |
98 | """Copied from code.py, to remove the dependency""" |
|
97 | """Copied from code.py, to remove the dependency""" | |
99 |
|
98 | |||
100 | oldvalue = 0 |
|
99 | oldvalue = 0 | |
101 | try: |
|
100 | try: | |
102 | oldvalue = file.softspace |
|
101 | oldvalue = file.softspace | |
103 | except AttributeError: |
|
102 | except AttributeError: | |
104 | pass |
|
103 | pass | |
105 | try: |
|
104 | try: | |
106 | file.softspace = newvalue |
|
105 | file.softspace = newvalue | |
107 | except (AttributeError, TypeError): |
|
106 | except (AttributeError, TypeError): | |
108 | # "attribute-less object" or "read-only attributes" |
|
107 | # "attribute-less object" or "read-only attributes" | |
109 | pass |
|
108 | pass | |
110 | return oldvalue |
|
109 | return oldvalue | |
111 |
|
110 | |||
112 |
|
111 | |||
113 | def no_op(*a, **kw): pass |
|
112 | def no_op(*a, **kw): pass | |
114 |
|
113 | |||
115 | class NoOpContext(object): |
|
114 | class NoOpContext(object): | |
116 | def __enter__(self): pass |
|
115 | def __enter__(self): pass | |
117 | def __exit__(self, type, value, traceback): pass |
|
116 | def __exit__(self, type, value, traceback): pass | |
118 | no_op_context = NoOpContext() |
|
117 | no_op_context = NoOpContext() | |
119 |
|
118 | |||
120 | class SpaceInInput(Exception): pass |
|
119 | class SpaceInInput(Exception): pass | |
121 |
|
120 | |||
122 | class Bunch: pass |
|
121 | class Bunch: pass | |
123 |
|
122 | |||
124 |
|
123 | |||
125 | def get_default_colors(): |
|
124 | def get_default_colors(): | |
126 | if sys.platform=='darwin': |
|
125 | if sys.platform=='darwin': | |
127 | return "LightBG" |
|
126 | return "LightBG" | |
128 | elif os.name=='nt': |
|
127 | elif os.name=='nt': | |
129 | return 'Linux' |
|
128 | return 'Linux' | |
130 | else: |
|
129 | else: | |
131 | return 'Linux' |
|
130 | return 'Linux' | |
132 |
|
131 | |||
133 |
|
132 | |||
134 | class SeparateUnicode(Unicode): |
|
133 | class SeparateUnicode(Unicode): | |
135 | """A Unicode subclass to validate separate_in, separate_out, etc. |
|
134 | """A Unicode subclass to validate separate_in, separate_out, etc. | |
136 |
|
135 | |||
137 | 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'. | |
138 | """ |
|
137 | """ | |
139 |
|
138 | |||
140 | def validate(self, obj, value): |
|
139 | def validate(self, obj, value): | |
141 | if value == '0': value = '' |
|
140 | if value == '0': value = '' | |
142 | value = value.replace('\\n','\n') |
|
141 | value = value.replace('\\n','\n') | |
143 | return super(SeparateUnicode, self).validate(obj, value) |
|
142 | return super(SeparateUnicode, self).validate(obj, value) | |
144 |
|
143 | |||
145 |
|
144 | |||
146 | class ReadlineNoRecord(object): |
|
145 | class ReadlineNoRecord(object): | |
147 | """Context manager to execute some code, then reload readline history |
|
146 | """Context manager to execute some code, then reload readline history | |
148 | 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.""" | |
149 | def __init__(self, shell): |
|
148 | def __init__(self, shell): | |
150 | self.shell = shell |
|
149 | self.shell = shell | |
151 | self._nested_level = 0 |
|
150 | self._nested_level = 0 | |
152 |
|
151 | |||
153 | def __enter__(self): |
|
152 | def __enter__(self): | |
154 | if self._nested_level == 0: |
|
153 | if self._nested_level == 0: | |
155 | try: |
|
154 | try: | |
156 | self.orig_length = self.current_length() |
|
155 | self.orig_length = self.current_length() | |
157 | self.readline_tail = self.get_readline_tail() |
|
156 | self.readline_tail = self.get_readline_tail() | |
158 | except (AttributeError, IndexError): # Can fail with pyreadline |
|
157 | except (AttributeError, IndexError): # Can fail with pyreadline | |
159 | self.orig_length, self.readline_tail = 999999, [] |
|
158 | self.orig_length, self.readline_tail = 999999, [] | |
160 | self._nested_level += 1 |
|
159 | self._nested_level += 1 | |
161 |
|
160 | |||
162 | def __exit__(self, type, value, traceback): |
|
161 | def __exit__(self, type, value, traceback): | |
163 | self._nested_level -= 1 |
|
162 | self._nested_level -= 1 | |
164 | if self._nested_level == 0: |
|
163 | if self._nested_level == 0: | |
165 | # Try clipping the end if it's got longer |
|
164 | # Try clipping the end if it's got longer | |
166 | try: |
|
165 | try: | |
167 | e = self.current_length() - self.orig_length |
|
166 | e = self.current_length() - self.orig_length | |
168 | if e > 0: |
|
167 | if e > 0: | |
169 | for _ in range(e): |
|
168 | for _ in range(e): | |
170 | self.shell.readline.remove_history_item(self.orig_length) |
|
169 | self.shell.readline.remove_history_item(self.orig_length) | |
171 |
|
170 | |||
172 | # If it still doesn't match, just reload readline history. |
|
171 | # If it still doesn't match, just reload readline history. | |
173 | if self.current_length() != self.orig_length \ |
|
172 | if self.current_length() != self.orig_length \ | |
174 | or self.get_readline_tail() != self.readline_tail: |
|
173 | or self.get_readline_tail() != self.readline_tail: | |
175 | self.shell.refill_readline_hist() |
|
174 | self.shell.refill_readline_hist() | |
176 | except (AttributeError, IndexError): |
|
175 | except (AttributeError, IndexError): | |
177 | pass |
|
176 | pass | |
178 | # Returning False will cause exceptions to propagate |
|
177 | # Returning False will cause exceptions to propagate | |
179 | return False |
|
178 | return False | |
180 |
|
179 | |||
181 | def current_length(self): |
|
180 | def current_length(self): | |
182 | return self.shell.readline.get_current_history_length() |
|
181 | return self.shell.readline.get_current_history_length() | |
183 |
|
182 | |||
184 | def get_readline_tail(self, n=10): |
|
183 | def get_readline_tail(self, n=10): | |
185 | """Get the last n items in readline history.""" |
|
184 | """Get the last n items in readline history.""" | |
186 | end = self.shell.readline.get_current_history_length() + 1 |
|
185 | end = self.shell.readline.get_current_history_length() + 1 | |
187 | start = max(end-n, 1) |
|
186 | start = max(end-n, 1) | |
188 | ghi = self.shell.readline.get_history_item |
|
187 | ghi = self.shell.readline.get_history_item | |
189 | return [ghi(x) for x in range(start, end)] |
|
188 | return [ghi(x) for x in range(start, end)] | |
190 |
|
189 | |||
191 | #----------------------------------------------------------------------------- |
|
190 | #----------------------------------------------------------------------------- | |
192 | # Main IPython class |
|
191 | # Main IPython class | |
193 | #----------------------------------------------------------------------------- |
|
192 | #----------------------------------------------------------------------------- | |
194 |
|
193 | |||
195 | class InteractiveShell(SingletonConfigurable, Magic): |
|
194 | class InteractiveShell(SingletonConfigurable, Magic): | |
196 | """An enhanced, interactive shell for Python.""" |
|
195 | """An enhanced, interactive shell for Python.""" | |
197 |
|
196 | |||
198 | _instance = None |
|
197 | _instance = None | |
199 |
|
198 | |||
200 | autocall = Enum((0,1,2), default_value=0, config=True, help= |
|
199 | autocall = Enum((0,1,2), default_value=0, config=True, help= | |
201 | """ |
|
200 | """ | |
202 | Make IPython automatically call any callable object even if you didn't |
|
201 | Make IPython automatically call any callable object even if you didn't | |
203 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
202 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' | |
204 | automatically. The value can be '0' to disable the feature, '1' for |
|
203 | automatically. The value can be '0' to disable the feature, '1' for | |
205 | 'smart' autocall, where it is not applied if there are no more |
|
204 | 'smart' autocall, where it is not applied if there are no more | |
206 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
205 | arguments on the line, and '2' for 'full' autocall, where all callable | |
207 | objects are automatically called (even if no arguments are present). |
|
206 | objects are automatically called (even if no arguments are present). | |
208 | """ |
|
207 | """ | |
209 | ) |
|
208 | ) | |
210 | # TODO: remove all autoindent logic and put into frontends. |
|
209 | # TODO: remove all autoindent logic and put into frontends. | |
211 | # We can't do this yet because even runlines uses the autoindent. |
|
210 | # We can't do this yet because even runlines uses the autoindent. | |
212 | autoindent = CBool(True, config=True, help= |
|
211 | autoindent = CBool(True, config=True, help= | |
213 | """ |
|
212 | """ | |
214 | Autoindent IPython code entered interactively. |
|
213 | Autoindent IPython code entered interactively. | |
215 | """ |
|
214 | """ | |
216 | ) |
|
215 | ) | |
217 | automagic = CBool(True, config=True, help= |
|
216 | automagic = CBool(True, config=True, help= | |
218 | """ |
|
217 | """ | |
219 | Enable magic commands to be called without the leading %. |
|
218 | Enable magic commands to be called without the leading %. | |
220 | """ |
|
219 | """ | |
221 | ) |
|
220 | ) | |
222 | cache_size = Integer(1000, config=True, help= |
|
221 | cache_size = Integer(1000, config=True, help= | |
223 | """ |
|
222 | """ | |
224 | Set the size of the output cache. The default is 1000, you can |
|
223 | Set the size of the output cache. The default is 1000, you can | |
225 | change it permanently in your config file. Setting it to 0 completely |
|
224 | change it permanently in your config file. Setting it to 0 completely | |
226 | disables the caching system, and the minimum value accepted is 20 (if |
|
225 | disables the caching system, and the minimum value accepted is 20 (if | |
227 | you provide a value less than 20, it is reset to 0 and a warning is |
|
226 | you provide a value less than 20, it is reset to 0 and a warning is | |
228 | issued). This limit is defined because otherwise you'll spend more |
|
227 | issued). This limit is defined because otherwise you'll spend more | |
229 | time re-flushing a too small cache than working |
|
228 | time re-flushing a too small cache than working | |
230 | """ |
|
229 | """ | |
231 | ) |
|
230 | ) | |
232 | color_info = CBool(True, config=True, help= |
|
231 | color_info = CBool(True, config=True, help= | |
233 | """ |
|
232 | """ | |
234 | Use colors for displaying information about objects. Because this |
|
233 | Use colors for displaying information about objects. Because this | |
235 | information is passed through a pager (like 'less'), and some pagers |
|
234 | information is passed through a pager (like 'less'), and some pagers | |
236 | get confused with color codes, this capability can be turned off. |
|
235 | get confused with color codes, this capability can be turned off. | |
237 | """ |
|
236 | """ | |
238 | ) |
|
237 | ) | |
239 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), |
|
238 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), | |
240 | default_value=get_default_colors(), config=True, |
|
239 | default_value=get_default_colors(), config=True, | |
241 | help="Set the color scheme (NoColor, Linux, or LightBG)." |
|
240 | help="Set the color scheme (NoColor, Linux, or LightBG)." | |
242 | ) |
|
241 | ) | |
243 | colors_force = CBool(False, help= |
|
242 | colors_force = CBool(False, help= | |
244 | """ |
|
243 | """ | |
245 | Force use of ANSI color codes, regardless of OS and readline |
|
244 | Force use of ANSI color codes, regardless of OS and readline | |
246 | availability. |
|
245 | availability. | |
247 | """ |
|
246 | """ | |
248 | # FIXME: This is essentially a hack to allow ZMQShell to show colors |
|
247 | # FIXME: This is essentially a hack to allow ZMQShell to show colors | |
249 | # without readline on Win32. When the ZMQ formatting system is |
|
248 | # without readline on Win32. When the ZMQ formatting system is | |
250 | # refactored, this should be removed. |
|
249 | # refactored, this should be removed. | |
251 | ) |
|
250 | ) | |
252 | debug = CBool(False, config=True) |
|
251 | debug = CBool(False, config=True) | |
253 | deep_reload = CBool(False, config=True, help= |
|
252 | deep_reload = CBool(False, config=True, help= | |
254 | """ |
|
253 | """ | |
255 | Enable deep (recursive) reloading by default. IPython can use the |
|
254 | Enable deep (recursive) reloading by default. IPython can use the | |
256 | deep_reload module which reloads changes in modules recursively (it |
|
255 | deep_reload module which reloads changes in modules recursively (it | |
257 | replaces the reload() function, so you don't need to change anything to |
|
256 | replaces the reload() function, so you don't need to change anything to | |
258 | use it). deep_reload() forces a full reload of modules whose code may |
|
257 | use it). deep_reload() forces a full reload of modules whose code may | |
259 | have changed, which the default reload() function does not. When |
|
258 | have changed, which the default reload() function does not. When | |
260 | deep_reload is off, IPython will use the normal reload(), but |
|
259 | deep_reload is off, IPython will use the normal reload(), but | |
261 | deep_reload will still be available as dreload(). |
|
260 | deep_reload will still be available as dreload(). | |
262 | """ |
|
261 | """ | |
263 | ) |
|
262 | ) | |
264 | disable_failing_post_execute = CBool(False, config=True, |
|
263 | disable_failing_post_execute = CBool(False, config=True, | |
265 | help="Don't call post-execute functions that have failed in the past.""" |
|
264 | help="Don't call post-execute functions that have failed in the past.""" | |
266 | ) |
|
265 | ) | |
267 | display_formatter = Instance(DisplayFormatter) |
|
266 | display_formatter = Instance(DisplayFormatter) | |
268 | displayhook_class = Type(DisplayHook) |
|
267 | displayhook_class = Type(DisplayHook) | |
269 | display_pub_class = Type(DisplayPublisher) |
|
268 | display_pub_class = Type(DisplayPublisher) | |
270 |
|
269 | |||
271 | exit_now = CBool(False) |
|
270 | exit_now = CBool(False) | |
272 | exiter = Instance(ExitAutocall) |
|
271 | exiter = Instance(ExitAutocall) | |
273 | def _exiter_default(self): |
|
272 | def _exiter_default(self): | |
274 | return ExitAutocall(self) |
|
273 | return ExitAutocall(self) | |
275 | # Monotonically increasing execution counter |
|
274 | # Monotonically increasing execution counter | |
276 | execution_count = Integer(1) |
|
275 | execution_count = Integer(1) | |
277 | filename = Unicode("<ipython console>") |
|
276 | filename = Unicode("<ipython console>") | |
278 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ |
|
277 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ | |
279 |
|
278 | |||
280 | # Input splitter, to split entire cells of input into either individual |
|
279 | # Input splitter, to split entire cells of input into either individual | |
281 | # interactive statements or whole blocks. |
|
280 | # interactive statements or whole blocks. | |
282 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
281 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', | |
283 | (), {}) |
|
282 | (), {}) | |
284 | logstart = CBool(False, config=True, help= |
|
283 | logstart = CBool(False, config=True, help= | |
285 | """ |
|
284 | """ | |
286 | Start logging to the default log file. |
|
285 | Start logging to the default log file. | |
287 | """ |
|
286 | """ | |
288 | ) |
|
287 | ) | |
289 | logfile = Unicode('', config=True, help= |
|
288 | logfile = Unicode('', config=True, help= | |
290 | """ |
|
289 | """ | |
291 | The name of the logfile to use. |
|
290 | The name of the logfile to use. | |
292 | """ |
|
291 | """ | |
293 | ) |
|
292 | ) | |
294 | logappend = Unicode('', config=True, help= |
|
293 | logappend = Unicode('', config=True, help= | |
295 | """ |
|
294 | """ | |
296 | Start logging to the given file in append mode. |
|
295 | Start logging to the given file in append mode. | |
297 | """ |
|
296 | """ | |
298 | ) |
|
297 | ) | |
299 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
298 | object_info_string_level = Enum((0,1,2), default_value=0, | |
300 | config=True) |
|
299 | config=True) | |
301 | pdb = CBool(False, config=True, help= |
|
300 | pdb = CBool(False, config=True, help= | |
302 | """ |
|
301 | """ | |
303 | Automatically call the pdb debugger after every exception. |
|
302 | Automatically call the pdb debugger after every exception. | |
304 | """ |
|
303 | """ | |
305 | ) |
|
304 | ) | |
306 | multiline_history = CBool(sys.platform != 'win32', config=True, |
|
305 | multiline_history = CBool(sys.platform != 'win32', config=True, | |
307 | help="Save multi-line entries as one entry in readline history" |
|
306 | help="Save multi-line entries as one entry in readline history" | |
308 | ) |
|
307 | ) | |
309 |
|
308 | |||
310 | # deprecated prompt traits: |
|
309 | # deprecated prompt traits: | |
311 |
|
310 | |||
312 | prompt_in1 = Unicode('In [\\#]: ', config=True, |
|
311 | prompt_in1 = Unicode('In [\\#]: ', config=True, | |
313 | help="Deprecated, use PromptManager.in_template") |
|
312 | help="Deprecated, use PromptManager.in_template") | |
314 | prompt_in2 = Unicode(' .\\D.: ', config=True, |
|
313 | prompt_in2 = Unicode(' .\\D.: ', config=True, | |
315 | help="Deprecated, use PromptManager.in2_template") |
|
314 | help="Deprecated, use PromptManager.in2_template") | |
316 | prompt_out = Unicode('Out[\\#]: ', config=True, |
|
315 | prompt_out = Unicode('Out[\\#]: ', config=True, | |
317 | help="Deprecated, use PromptManager.out_template") |
|
316 | help="Deprecated, use PromptManager.out_template") | |
318 | prompts_pad_left = CBool(True, config=True, |
|
317 | prompts_pad_left = CBool(True, config=True, | |
319 | help="Deprecated, use PromptManager.justify") |
|
318 | help="Deprecated, use PromptManager.justify") | |
320 |
|
319 | |||
321 | def _prompt_trait_changed(self, name, old, new): |
|
320 | def _prompt_trait_changed(self, name, old, new): | |
322 | table = { |
|
321 | table = { | |
323 | 'prompt_in1' : 'in_template', |
|
322 | 'prompt_in1' : 'in_template', | |
324 | 'prompt_in2' : 'in2_template', |
|
323 | 'prompt_in2' : 'in2_template', | |
325 | 'prompt_out' : 'out_template', |
|
324 | 'prompt_out' : 'out_template', | |
326 | 'prompts_pad_left' : 'justify', |
|
325 | 'prompts_pad_left' : 'justify', | |
327 | } |
|
326 | } | |
328 | warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}\n".format( |
|
327 | warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}\n".format( | |
329 | name=name, newname=table[name]) |
|
328 | name=name, newname=table[name]) | |
330 | ) |
|
329 | ) | |
331 | # protect against weird cases where self.config may not exist: |
|
330 | # protect against weird cases where self.config may not exist: | |
332 | if self.config is not None: |
|
331 | if self.config is not None: | |
333 | # propagate to corresponding PromptManager trait |
|
332 | # propagate to corresponding PromptManager trait | |
334 | setattr(self.config.PromptManager, table[name], new) |
|
333 | setattr(self.config.PromptManager, table[name], new) | |
335 |
|
334 | |||
336 | _prompt_in1_changed = _prompt_trait_changed |
|
335 | _prompt_in1_changed = _prompt_trait_changed | |
337 | _prompt_in2_changed = _prompt_trait_changed |
|
336 | _prompt_in2_changed = _prompt_trait_changed | |
338 | _prompt_out_changed = _prompt_trait_changed |
|
337 | _prompt_out_changed = _prompt_trait_changed | |
339 | _prompt_pad_left_changed = _prompt_trait_changed |
|
338 | _prompt_pad_left_changed = _prompt_trait_changed | |
340 |
|
339 | |||
341 | show_rewritten_input = CBool(True, config=True, |
|
340 | show_rewritten_input = CBool(True, config=True, | |
342 | help="Show rewritten input, e.g. for autocall." |
|
341 | help="Show rewritten input, e.g. for autocall." | |
343 | ) |
|
342 | ) | |
344 |
|
343 | |||
345 | quiet = CBool(False, config=True) |
|
344 | quiet = CBool(False, config=True) | |
346 |
|
345 | |||
347 | history_length = Integer(10000, config=True) |
|
346 | history_length = Integer(10000, config=True) | |
348 |
|
347 | |||
349 | # The readline stuff will eventually be moved to the terminal subclass |
|
348 | # The readline stuff will eventually be moved to the terminal subclass | |
350 | # but for now, we can't do that as readline is welded in everywhere. |
|
349 | # but for now, we can't do that as readline is welded in everywhere. | |
351 | readline_use = CBool(True, config=True) |
|
350 | readline_use = CBool(True, config=True) | |
352 | readline_remove_delims = Unicode('-/~', config=True) |
|
351 | readline_remove_delims = Unicode('-/~', config=True) | |
353 | # don't use \M- bindings by default, because they |
|
352 | # don't use \M- bindings by default, because they | |
354 | # conflict with 8-bit encodings. See gh-58,gh-88 |
|
353 | # conflict with 8-bit encodings. See gh-58,gh-88 | |
355 | readline_parse_and_bind = List([ |
|
354 | readline_parse_and_bind = List([ | |
356 | 'tab: complete', |
|
355 | 'tab: complete', | |
357 | '"\C-l": clear-screen', |
|
356 | '"\C-l": clear-screen', | |
358 | 'set show-all-if-ambiguous on', |
|
357 | 'set show-all-if-ambiguous on', | |
359 | '"\C-o": tab-insert', |
|
358 | '"\C-o": tab-insert', | |
360 | '"\C-r": reverse-search-history', |
|
359 | '"\C-r": reverse-search-history', | |
361 | '"\C-s": forward-search-history', |
|
360 | '"\C-s": forward-search-history', | |
362 | '"\C-p": history-search-backward', |
|
361 | '"\C-p": history-search-backward', | |
363 | '"\C-n": history-search-forward', |
|
362 | '"\C-n": history-search-forward', | |
364 | '"\e[A": history-search-backward', |
|
363 | '"\e[A": history-search-backward', | |
365 | '"\e[B": history-search-forward', |
|
364 | '"\e[B": history-search-forward', | |
366 | '"\C-k": kill-line', |
|
365 | '"\C-k": kill-line', | |
367 | '"\C-u": unix-line-discard', |
|
366 | '"\C-u": unix-line-discard', | |
368 | ], allow_none=False, config=True) |
|
367 | ], allow_none=False, config=True) | |
369 |
|
368 | |||
370 | # TODO: this part of prompt management should be moved to the frontends. |
|
369 | # TODO: this part of prompt management should be moved to the frontends. | |
371 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
370 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' | |
372 | separate_in = SeparateUnicode('\n', config=True) |
|
371 | separate_in = SeparateUnicode('\n', config=True) | |
373 | separate_out = SeparateUnicode('', config=True) |
|
372 | separate_out = SeparateUnicode('', config=True) | |
374 | separate_out2 = SeparateUnicode('', config=True) |
|
373 | separate_out2 = SeparateUnicode('', config=True) | |
375 | wildcards_case_sensitive = CBool(True, config=True) |
|
374 | wildcards_case_sensitive = CBool(True, config=True) | |
376 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
375 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), | |
377 | default_value='Context', config=True) |
|
376 | default_value='Context', config=True) | |
378 |
|
377 | |||
379 | # Subcomponents of InteractiveShell |
|
378 | # Subcomponents of InteractiveShell | |
380 | alias_manager = Instance('IPython.core.alias.AliasManager') |
|
379 | alias_manager = Instance('IPython.core.alias.AliasManager') | |
381 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
380 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') | |
382 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') |
|
381 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') | |
383 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') |
|
382 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') | |
384 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') |
|
383 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') | |
385 | plugin_manager = Instance('IPython.core.plugin.PluginManager') |
|
384 | plugin_manager = Instance('IPython.core.plugin.PluginManager') | |
386 | payload_manager = Instance('IPython.core.payload.PayloadManager') |
|
385 | payload_manager = Instance('IPython.core.payload.PayloadManager') | |
387 | history_manager = Instance('IPython.core.history.HistoryManager') |
|
386 | history_manager = Instance('IPython.core.history.HistoryManager') | |
388 |
|
387 | |||
389 | profile_dir = Instance('IPython.core.application.ProfileDir') |
|
388 | profile_dir = Instance('IPython.core.application.ProfileDir') | |
390 | @property |
|
389 | @property | |
391 | def profile(self): |
|
390 | def profile(self): | |
392 | if self.profile_dir is not None: |
|
391 | if self.profile_dir is not None: | |
393 | name = os.path.basename(self.profile_dir.location) |
|
392 | name = os.path.basename(self.profile_dir.location) | |
394 | return name.replace('profile_','') |
|
393 | return name.replace('profile_','') | |
395 |
|
394 | |||
396 |
|
395 | |||
397 | # Private interface |
|
396 | # Private interface | |
398 | _post_execute = Instance(dict) |
|
397 | _post_execute = Instance(dict) | |
399 |
|
398 | |||
400 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, |
|
399 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, | |
401 | user_module=None, user_ns=None, |
|
400 | user_module=None, user_ns=None, | |
402 | custom_exceptions=((), None)): |
|
401 | custom_exceptions=((), None)): | |
403 |
|
402 | |||
404 | # This is where traits with a config_key argument are updated |
|
403 | # This is where traits with a config_key argument are updated | |
405 | # from the values on config. |
|
404 | # from the values on config. | |
406 | super(InteractiveShell, self).__init__(config=config) |
|
405 | super(InteractiveShell, self).__init__(config=config) | |
407 | self.configurables = [self] |
|
406 | self.configurables = [self] | |
408 |
|
407 | |||
409 | # These are relatively independent and stateless |
|
408 | # These are relatively independent and stateless | |
410 | self.init_ipython_dir(ipython_dir) |
|
409 | self.init_ipython_dir(ipython_dir) | |
411 | self.init_profile_dir(profile_dir) |
|
410 | self.init_profile_dir(profile_dir) | |
412 | self.init_instance_attrs() |
|
411 | self.init_instance_attrs() | |
413 | self.init_environment() |
|
412 | self.init_environment() | |
414 |
|
413 | |||
415 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
414 | # Create namespaces (user_ns, user_global_ns, etc.) | |
416 | self.init_create_namespaces(user_module, user_ns) |
|
415 | self.init_create_namespaces(user_module, user_ns) | |
417 | # This has to be done after init_create_namespaces because it uses |
|
416 | # This has to be done after init_create_namespaces because it uses | |
418 | # something in self.user_ns, but before init_sys_modules, which |
|
417 | # something in self.user_ns, but before init_sys_modules, which | |
419 | # is the first thing to modify sys. |
|
418 | # is the first thing to modify sys. | |
420 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
419 | # TODO: When we override sys.stdout and sys.stderr before this class | |
421 | # is created, we are saving the overridden ones here. Not sure if this |
|
420 | # is created, we are saving the overridden ones here. Not sure if this | |
422 | # is what we want to do. |
|
421 | # is what we want to do. | |
423 | self.save_sys_module_state() |
|
422 | self.save_sys_module_state() | |
424 | self.init_sys_modules() |
|
423 | self.init_sys_modules() | |
425 |
|
424 | |||
426 | # While we're trying to have each part of the code directly access what |
|
425 | # While we're trying to have each part of the code directly access what | |
427 | # it needs without keeping redundant references to objects, we have too |
|
426 | # it needs without keeping redundant references to objects, we have too | |
428 | # much legacy code that expects ip.db to exist. |
|
427 | # much legacy code that expects ip.db to exist. | |
429 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
428 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) | |
430 |
|
429 | |||
431 | self.init_history() |
|
430 | self.init_history() | |
432 | self.init_encoding() |
|
431 | self.init_encoding() | |
433 | self.init_prefilter() |
|
432 | self.init_prefilter() | |
434 |
|
433 | |||
435 | Magic.__init__(self, self) |
|
434 | Magic.__init__(self, self) | |
436 |
|
435 | |||
437 | self.init_syntax_highlighting() |
|
436 | self.init_syntax_highlighting() | |
438 | self.init_hooks() |
|
437 | self.init_hooks() | |
439 | self.init_pushd_popd_magic() |
|
438 | self.init_pushd_popd_magic() | |
440 | # self.init_traceback_handlers use to be here, but we moved it below |
|
439 | # self.init_traceback_handlers use to be here, but we moved it below | |
441 | # because it and init_io have to come after init_readline. |
|
440 | # because it and init_io have to come after init_readline. | |
442 | self.init_user_ns() |
|
441 | self.init_user_ns() | |
443 | self.init_logger() |
|
442 | self.init_logger() | |
444 | self.init_alias() |
|
443 | self.init_alias() | |
445 | self.init_builtins() |
|
444 | self.init_builtins() | |
446 |
|
445 | |||
447 | # pre_config_initialization |
|
446 | # pre_config_initialization | |
448 |
|
447 | |||
449 | # The next section should contain everything that was in ipmaker. |
|
448 | # The next section should contain everything that was in ipmaker. | |
450 | self.init_logstart() |
|
449 | self.init_logstart() | |
451 |
|
450 | |||
452 | # The following was in post_config_initialization |
|
451 | # The following was in post_config_initialization | |
453 | self.init_inspector() |
|
452 | self.init_inspector() | |
454 | # init_readline() must come before init_io(), because init_io uses |
|
453 | # init_readline() must come before init_io(), because init_io uses | |
455 | # readline related things. |
|
454 | # readline related things. | |
456 | self.init_readline() |
|
455 | self.init_readline() | |
457 | # We save this here in case user code replaces raw_input, but it needs |
|
456 | # We save this here in case user code replaces raw_input, but it needs | |
458 | # to be after init_readline(), because PyPy's readline works by replacing |
|
457 | # to be after init_readline(), because PyPy's readline works by replacing | |
459 | # raw_input. |
|
458 | # raw_input. | |
460 | if py3compat.PY3: |
|
459 | if py3compat.PY3: | |
461 | self.raw_input_original = input |
|
460 | self.raw_input_original = input | |
462 | else: |
|
461 | else: | |
463 | self.raw_input_original = raw_input |
|
462 | self.raw_input_original = raw_input | |
464 | # init_completer must come after init_readline, because it needs to |
|
463 | # init_completer must come after init_readline, because it needs to | |
465 | # know whether readline is present or not system-wide to configure the |
|
464 | # know whether readline is present or not system-wide to configure the | |
466 | # completers, since the completion machinery can now operate |
|
465 | # completers, since the completion machinery can now operate | |
467 | # independently of readline (e.g. over the network) |
|
466 | # independently of readline (e.g. over the network) | |
468 | self.init_completer() |
|
467 | self.init_completer() | |
469 | # TODO: init_io() needs to happen before init_traceback handlers |
|
468 | # TODO: init_io() needs to happen before init_traceback handlers | |
470 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
469 | # because the traceback handlers hardcode the stdout/stderr streams. | |
471 | # This logic in in debugger.Pdb and should eventually be changed. |
|
470 | # This logic in in debugger.Pdb and should eventually be changed. | |
472 | self.init_io() |
|
471 | self.init_io() | |
473 | self.init_traceback_handlers(custom_exceptions) |
|
472 | self.init_traceback_handlers(custom_exceptions) | |
474 | self.init_prompts() |
|
473 | self.init_prompts() | |
475 | self.init_display_formatter() |
|
474 | self.init_display_formatter() | |
476 | self.init_display_pub() |
|
475 | self.init_display_pub() | |
477 | self.init_displayhook() |
|
476 | self.init_displayhook() | |
478 | self.init_reload_doctest() |
|
477 | self.init_reload_doctest() | |
479 | self.init_magics() |
|
478 | self.init_magics() | |
480 | self.init_pdb() |
|
479 | self.init_pdb() | |
481 | self.init_extension_manager() |
|
480 | self.init_extension_manager() | |
482 | self.init_plugin_manager() |
|
481 | self.init_plugin_manager() | |
483 | self.init_payload() |
|
482 | self.init_payload() | |
484 | self.hooks.late_startup_hook() |
|
483 | self.hooks.late_startup_hook() | |
485 | atexit.register(self.atexit_operations) |
|
484 | atexit.register(self.atexit_operations) | |
486 |
|
485 | |||
487 | def get_ipython(self): |
|
486 | def get_ipython(self): | |
488 | """Return the currently running IPython instance.""" |
|
487 | """Return the currently running IPython instance.""" | |
489 | return self |
|
488 | return self | |
490 |
|
489 | |||
491 | #------------------------------------------------------------------------- |
|
490 | #------------------------------------------------------------------------- | |
492 | # Trait changed handlers |
|
491 | # Trait changed handlers | |
493 | #------------------------------------------------------------------------- |
|
492 | #------------------------------------------------------------------------- | |
494 |
|
493 | |||
495 | def _ipython_dir_changed(self, name, new): |
|
494 | def _ipython_dir_changed(self, name, new): | |
496 | if not os.path.isdir(new): |
|
495 | if not os.path.isdir(new): | |
497 | os.makedirs(new, mode = 0777) |
|
496 | os.makedirs(new, mode = 0777) | |
498 |
|
497 | |||
499 | def set_autoindent(self,value=None): |
|
498 | def set_autoindent(self,value=None): | |
500 | """Set the autoindent flag, checking for readline support. |
|
499 | """Set the autoindent flag, checking for readline support. | |
501 |
|
500 | |||
502 | If called with no arguments, it acts as a toggle.""" |
|
501 | If called with no arguments, it acts as a toggle.""" | |
503 |
|
502 | |||
504 | if value != 0 and not self.has_readline: |
|
503 | if value != 0 and not self.has_readline: | |
505 | if os.name == 'posix': |
|
504 | if os.name == 'posix': | |
506 | warn("The auto-indent feature requires the readline library") |
|
505 | warn("The auto-indent feature requires the readline library") | |
507 | self.autoindent = 0 |
|
506 | self.autoindent = 0 | |
508 | return |
|
507 | return | |
509 | if value is None: |
|
508 | if value is None: | |
510 | self.autoindent = not self.autoindent |
|
509 | self.autoindent = not self.autoindent | |
511 | else: |
|
510 | else: | |
512 | self.autoindent = value |
|
511 | self.autoindent = value | |
513 |
|
512 | |||
514 | #------------------------------------------------------------------------- |
|
513 | #------------------------------------------------------------------------- | |
515 | # init_* methods called by __init__ |
|
514 | # init_* methods called by __init__ | |
516 | #------------------------------------------------------------------------- |
|
515 | #------------------------------------------------------------------------- | |
517 |
|
516 | |||
518 | def init_ipython_dir(self, ipython_dir): |
|
517 | def init_ipython_dir(self, ipython_dir): | |
519 | if ipython_dir is not None: |
|
518 | if ipython_dir is not None: | |
520 | self.ipython_dir = ipython_dir |
|
519 | self.ipython_dir = ipython_dir | |
521 | return |
|
520 | return | |
522 |
|
521 | |||
523 | self.ipython_dir = get_ipython_dir() |
|
522 | self.ipython_dir = get_ipython_dir() | |
524 |
|
523 | |||
525 | def init_profile_dir(self, profile_dir): |
|
524 | def init_profile_dir(self, profile_dir): | |
526 | if profile_dir is not None: |
|
525 | if profile_dir is not None: | |
527 | self.profile_dir = profile_dir |
|
526 | self.profile_dir = profile_dir | |
528 | return |
|
527 | return | |
529 | self.profile_dir =\ |
|
528 | self.profile_dir =\ | |
530 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
529 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') | |
531 |
|
530 | |||
532 | def init_instance_attrs(self): |
|
531 | def init_instance_attrs(self): | |
533 | self.more = False |
|
532 | self.more = False | |
534 |
|
533 | |||
535 | # command compiler |
|
534 | # command compiler | |
536 | self.compile = CachingCompiler() |
|
535 | self.compile = CachingCompiler() | |
537 |
|
536 | |||
538 | # Make an empty namespace, which extension writers can rely on both |
|
537 | # Make an empty namespace, which extension writers can rely on both | |
539 | # existing and NEVER being used by ipython itself. This gives them a |
|
538 | # existing and NEVER being used by ipython itself. This gives them a | |
540 | # convenient location for storing additional information and state |
|
539 | # convenient location for storing additional information and state | |
541 | # their extensions may require, without fear of collisions with other |
|
540 | # their extensions may require, without fear of collisions with other | |
542 | # ipython names that may develop later. |
|
541 | # ipython names that may develop later. | |
543 | self.meta = Struct() |
|
542 | self.meta = Struct() | |
544 |
|
543 | |||
545 | # Temporary files used for various purposes. Deleted at exit. |
|
544 | # Temporary files used for various purposes. Deleted at exit. | |
546 | self.tempfiles = [] |
|
545 | self.tempfiles = [] | |
547 |
|
546 | |||
548 | # Keep track of readline usage (later set by init_readline) |
|
547 | # Keep track of readline usage (later set by init_readline) | |
549 | self.has_readline = False |
|
548 | self.has_readline = False | |
550 |
|
549 | |||
551 | # keep track of where we started running (mainly for crash post-mortem) |
|
550 | # keep track of where we started running (mainly for crash post-mortem) | |
552 | # This is not being used anywhere currently. |
|
551 | # This is not being used anywhere currently. | |
553 | self.starting_dir = os.getcwdu() |
|
552 | self.starting_dir = os.getcwdu() | |
554 |
|
553 | |||
555 | # Indentation management |
|
554 | # Indentation management | |
556 | self.indent_current_nsp = 0 |
|
555 | self.indent_current_nsp = 0 | |
557 |
|
556 | |||
558 | # Dict to track post-execution functions that have been registered |
|
557 | # Dict to track post-execution functions that have been registered | |
559 | self._post_execute = {} |
|
558 | self._post_execute = {} | |
560 |
|
559 | |||
561 | def init_environment(self): |
|
560 | def init_environment(self): | |
562 | """Any changes we need to make to the user's environment.""" |
|
561 | """Any changes we need to make to the user's environment.""" | |
563 | pass |
|
562 | pass | |
564 |
|
563 | |||
565 | def init_encoding(self): |
|
564 | def init_encoding(self): | |
566 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
565 | # Get system encoding at startup time. Certain terminals (like Emacs | |
567 | # under Win32 have it set to None, and we need to have a known valid |
|
566 | # under Win32 have it set to None, and we need to have a known valid | |
568 | # encoding to use in the raw_input() method |
|
567 | # encoding to use in the raw_input() method | |
569 | try: |
|
568 | try: | |
570 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
569 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
571 | except AttributeError: |
|
570 | except AttributeError: | |
572 | self.stdin_encoding = 'ascii' |
|
571 | self.stdin_encoding = 'ascii' | |
573 |
|
572 | |||
574 | def init_syntax_highlighting(self): |
|
573 | def init_syntax_highlighting(self): | |
575 | # Python source parser/formatter for syntax highlighting |
|
574 | # Python source parser/formatter for syntax highlighting | |
576 | pyformat = PyColorize.Parser().format |
|
575 | pyformat = PyColorize.Parser().format | |
577 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) |
|
576 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) | |
578 |
|
577 | |||
579 | def init_pushd_popd_magic(self): |
|
578 | def init_pushd_popd_magic(self): | |
580 | # for pushd/popd management |
|
579 | # for pushd/popd management | |
581 | self.home_dir = get_home_dir() |
|
580 | self.home_dir = get_home_dir() | |
582 |
|
581 | |||
583 | self.dir_stack = [] |
|
582 | self.dir_stack = [] | |
584 |
|
583 | |||
585 | def init_logger(self): |
|
584 | def init_logger(self): | |
586 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
585 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', | |
587 | logmode='rotate') |
|
586 | logmode='rotate') | |
588 |
|
587 | |||
589 | def init_logstart(self): |
|
588 | def init_logstart(self): | |
590 | """Initialize logging in case it was requested at the command line. |
|
589 | """Initialize logging in case it was requested at the command line. | |
591 | """ |
|
590 | """ | |
592 | if self.logappend: |
|
591 | if self.logappend: | |
593 | self.magic_logstart(self.logappend + ' append') |
|
592 | self.magic_logstart(self.logappend + ' append') | |
594 | elif self.logfile: |
|
593 | elif self.logfile: | |
595 | self.magic_logstart(self.logfile) |
|
594 | self.magic_logstart(self.logfile) | |
596 | elif self.logstart: |
|
595 | elif self.logstart: | |
597 | self.magic_logstart() |
|
596 | self.magic_logstart() | |
598 |
|
597 | |||
599 | def init_builtins(self): |
|
598 | def init_builtins(self): | |
600 | # A single, static flag that we set to True. Its presence indicates |
|
599 | # A single, static flag that we set to True. Its presence indicates | |
601 | # that an IPython shell has been created, and we make no attempts at |
|
600 | # that an IPython shell has been created, and we make no attempts at | |
602 | # removing on exit or representing the existence of more than one |
|
601 | # removing on exit or representing the existence of more than one | |
603 | # IPython at a time. |
|
602 | # IPython at a time. | |
604 | builtin_mod.__dict__['__IPYTHON__'] = True |
|
603 | builtin_mod.__dict__['__IPYTHON__'] = True | |
605 |
|
604 | |||
606 | # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to |
|
605 | # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to | |
607 | # manage on enter/exit, but with all our shells it's virtually |
|
606 | # manage on enter/exit, but with all our shells it's virtually | |
608 | # impossible to get all the cases right. We're leaving the name in for |
|
607 | # impossible to get all the cases right. We're leaving the name in for | |
609 | # those who adapted their codes to check for this flag, but will |
|
608 | # those who adapted their codes to check for this flag, but will | |
610 | # eventually remove it after a few more releases. |
|
609 | # eventually remove it after a few more releases. | |
611 | builtin_mod.__dict__['__IPYTHON__active'] = \ |
|
610 | builtin_mod.__dict__['__IPYTHON__active'] = \ | |
612 | 'Deprecated, check for __IPYTHON__' |
|
611 | 'Deprecated, check for __IPYTHON__' | |
613 |
|
612 | |||
614 | self.builtin_trap = BuiltinTrap(shell=self) |
|
613 | self.builtin_trap = BuiltinTrap(shell=self) | |
615 |
|
614 | |||
616 | def init_inspector(self): |
|
615 | def init_inspector(self): | |
617 | # Object inspector |
|
616 | # Object inspector | |
618 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
617 | self.inspector = oinspect.Inspector(oinspect.InspectColors, | |
619 | PyColorize.ANSICodeColors, |
|
618 | PyColorize.ANSICodeColors, | |
620 | 'NoColor', |
|
619 | 'NoColor', | |
621 | self.object_info_string_level) |
|
620 | self.object_info_string_level) | |
622 |
|
621 | |||
623 | def init_io(self): |
|
622 | def init_io(self): | |
624 | # This will just use sys.stdout and sys.stderr. If you want to |
|
623 | # This will just use sys.stdout and sys.stderr. If you want to | |
625 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
624 | # override sys.stdout and sys.stderr themselves, you need to do that | |
626 | # *before* instantiating this class, because io holds onto |
|
625 | # *before* instantiating this class, because io holds onto | |
627 | # references to the underlying streams. |
|
626 | # references to the underlying streams. | |
628 | if sys.platform == 'win32' and self.has_readline: |
|
627 | if sys.platform == 'win32' and self.has_readline: | |
629 | io.stdout = io.stderr = io.IOStream(self.readline._outputfile) |
|
628 | io.stdout = io.stderr = io.IOStream(self.readline._outputfile) | |
630 | else: |
|
629 | else: | |
631 | io.stdout = io.IOStream(sys.stdout) |
|
630 | io.stdout = io.IOStream(sys.stdout) | |
632 | io.stderr = io.IOStream(sys.stderr) |
|
631 | io.stderr = io.IOStream(sys.stderr) | |
633 |
|
632 | |||
634 | def init_prompts(self): |
|
633 | def init_prompts(self): | |
635 | self.prompt_manager = PromptManager(shell=self, config=self.config) |
|
634 | self.prompt_manager = PromptManager(shell=self, config=self.config) | |
636 | self.configurables.append(self.prompt_manager) |
|
635 | self.configurables.append(self.prompt_manager) | |
637 |
|
636 | |||
638 | def init_display_formatter(self): |
|
637 | def init_display_formatter(self): | |
639 | self.display_formatter = DisplayFormatter(config=self.config) |
|
638 | self.display_formatter = DisplayFormatter(config=self.config) | |
640 | self.configurables.append(self.display_formatter) |
|
639 | self.configurables.append(self.display_formatter) | |
641 |
|
640 | |||
642 | def init_display_pub(self): |
|
641 | def init_display_pub(self): | |
643 | self.display_pub = self.display_pub_class(config=self.config) |
|
642 | self.display_pub = self.display_pub_class(config=self.config) | |
644 | self.configurables.append(self.display_pub) |
|
643 | self.configurables.append(self.display_pub) | |
645 |
|
644 | |||
646 | def init_displayhook(self): |
|
645 | def init_displayhook(self): | |
647 | # Initialize displayhook, set in/out prompts and printing system |
|
646 | # Initialize displayhook, set in/out prompts and printing system | |
648 | self.displayhook = self.displayhook_class( |
|
647 | self.displayhook = self.displayhook_class( | |
649 | config=self.config, |
|
648 | config=self.config, | |
650 | shell=self, |
|
649 | shell=self, | |
651 | cache_size=self.cache_size, |
|
650 | cache_size=self.cache_size, | |
652 | ) |
|
651 | ) | |
653 | self.configurables.append(self.displayhook) |
|
652 | self.configurables.append(self.displayhook) | |
654 | # This is a context manager that installs/revmoes the displayhook at |
|
653 | # This is a context manager that installs/revmoes the displayhook at | |
655 | # the appropriate time. |
|
654 | # the appropriate time. | |
656 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
655 | self.display_trap = DisplayTrap(hook=self.displayhook) | |
657 |
|
656 | |||
658 | def init_reload_doctest(self): |
|
657 | def init_reload_doctest(self): | |
659 | # Do a proper resetting of doctest, including the necessary displayhook |
|
658 | # Do a proper resetting of doctest, including the necessary displayhook | |
660 | # monkeypatching |
|
659 | # monkeypatching | |
661 | try: |
|
660 | try: | |
662 | doctest_reload() |
|
661 | doctest_reload() | |
663 | except ImportError: |
|
662 | except ImportError: | |
664 | warn("doctest module does not exist.") |
|
663 | warn("doctest module does not exist.") | |
665 |
|
664 | |||
666 | #------------------------------------------------------------------------- |
|
665 | #------------------------------------------------------------------------- | |
667 | # Things related to injections into the sys module |
|
666 | # Things related to injections into the sys module | |
668 | #------------------------------------------------------------------------- |
|
667 | #------------------------------------------------------------------------- | |
669 |
|
668 | |||
670 | def save_sys_module_state(self): |
|
669 | def save_sys_module_state(self): | |
671 | """Save the state of hooks in the sys module. |
|
670 | """Save the state of hooks in the sys module. | |
672 |
|
671 | |||
673 | This has to be called after self.user_module is created. |
|
672 | This has to be called after self.user_module is created. | |
674 | """ |
|
673 | """ | |
675 | self._orig_sys_module_state = {} |
|
674 | self._orig_sys_module_state = {} | |
676 | self._orig_sys_module_state['stdin'] = sys.stdin |
|
675 | self._orig_sys_module_state['stdin'] = sys.stdin | |
677 | self._orig_sys_module_state['stdout'] = sys.stdout |
|
676 | self._orig_sys_module_state['stdout'] = sys.stdout | |
678 | self._orig_sys_module_state['stderr'] = sys.stderr |
|
677 | self._orig_sys_module_state['stderr'] = sys.stderr | |
679 | self._orig_sys_module_state['excepthook'] = sys.excepthook |
|
678 | self._orig_sys_module_state['excepthook'] = sys.excepthook | |
680 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
679 | self._orig_sys_modules_main_name = self.user_module.__name__ | |
681 |
|
680 | |||
682 | def restore_sys_module_state(self): |
|
681 | def restore_sys_module_state(self): | |
683 | """Restore the state of the sys module.""" |
|
682 | """Restore the state of the sys module.""" | |
684 | try: |
|
683 | try: | |
685 | for k, v in self._orig_sys_module_state.iteritems(): |
|
684 | for k, v in self._orig_sys_module_state.iteritems(): | |
686 | setattr(sys, k, v) |
|
685 | setattr(sys, k, v) | |
687 | except AttributeError: |
|
686 | except AttributeError: | |
688 | pass |
|
687 | pass | |
689 | # Reset what what done in self.init_sys_modules |
|
688 | # Reset what what done in self.init_sys_modules | |
690 | sys.modules[self.user_module.__name__] = self._orig_sys_modules_main_name |
|
689 | sys.modules[self.user_module.__name__] = self._orig_sys_modules_main_name | |
691 |
|
690 | |||
692 | #------------------------------------------------------------------------- |
|
691 | #------------------------------------------------------------------------- | |
693 | # Things related to hooks |
|
692 | # Things related to hooks | |
694 | #------------------------------------------------------------------------- |
|
693 | #------------------------------------------------------------------------- | |
695 |
|
694 | |||
696 | def init_hooks(self): |
|
695 | def init_hooks(self): | |
697 | # hooks holds pointers used for user-side customizations |
|
696 | # hooks holds pointers used for user-side customizations | |
698 | self.hooks = Struct() |
|
697 | self.hooks = Struct() | |
699 |
|
698 | |||
700 | self.strdispatchers = {} |
|
699 | self.strdispatchers = {} | |
701 |
|
700 | |||
702 | # Set all default hooks, defined in the IPython.hooks module. |
|
701 | # Set all default hooks, defined in the IPython.hooks module. | |
703 | hooks = IPython.core.hooks |
|
702 | hooks = IPython.core.hooks | |
704 | for hook_name in hooks.__all__: |
|
703 | for hook_name in hooks.__all__: | |
705 | # default hooks have priority 100, i.e. low; user hooks should have |
|
704 | # default hooks have priority 100, i.e. low; user hooks should have | |
706 | # 0-100 priority |
|
705 | # 0-100 priority | |
707 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
706 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) | |
708 |
|
707 | |||
709 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
708 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): | |
710 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
709 | """set_hook(name,hook) -> sets an internal IPython hook. | |
711 |
|
710 | |||
712 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
711 | IPython exposes some of its internal API as user-modifiable hooks. By | |
713 | adding your function to one of these hooks, you can modify IPython's |
|
712 | adding your function to one of these hooks, you can modify IPython's | |
714 | behavior to call at runtime your own routines.""" |
|
713 | behavior to call at runtime your own routines.""" | |
715 |
|
714 | |||
716 | # At some point in the future, this should validate the hook before it |
|
715 | # At some point in the future, this should validate the hook before it | |
717 | # accepts it. Probably at least check that the hook takes the number |
|
716 | # accepts it. Probably at least check that the hook takes the number | |
718 | # of args it's supposed to. |
|
717 | # of args it's supposed to. | |
719 |
|
718 | |||
720 | f = types.MethodType(hook,self) |
|
719 | f = types.MethodType(hook,self) | |
721 |
|
720 | |||
722 | # check if the hook is for strdispatcher first |
|
721 | # check if the hook is for strdispatcher first | |
723 | if str_key is not None: |
|
722 | if str_key is not None: | |
724 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
723 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
725 | sdp.add_s(str_key, f, priority ) |
|
724 | sdp.add_s(str_key, f, priority ) | |
726 | self.strdispatchers[name] = sdp |
|
725 | self.strdispatchers[name] = sdp | |
727 | return |
|
726 | return | |
728 | if re_key is not None: |
|
727 | if re_key is not None: | |
729 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
728 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
730 | sdp.add_re(re.compile(re_key), f, priority ) |
|
729 | sdp.add_re(re.compile(re_key), f, priority ) | |
731 | self.strdispatchers[name] = sdp |
|
730 | self.strdispatchers[name] = sdp | |
732 | return |
|
731 | return | |
733 |
|
732 | |||
734 | dp = getattr(self.hooks, name, None) |
|
733 | dp = getattr(self.hooks, name, None) | |
735 | if name not in IPython.core.hooks.__all__: |
|
734 | if name not in IPython.core.hooks.__all__: | |
736 | print "Warning! Hook '%s' is not one of %s" % \ |
|
735 | print "Warning! Hook '%s' is not one of %s" % \ | |
737 | (name, IPython.core.hooks.__all__ ) |
|
736 | (name, IPython.core.hooks.__all__ ) | |
738 | if not dp: |
|
737 | if not dp: | |
739 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
738 | dp = IPython.core.hooks.CommandChainDispatcher() | |
740 |
|
739 | |||
741 | try: |
|
740 | try: | |
742 | dp.add(f,priority) |
|
741 | dp.add(f,priority) | |
743 | except AttributeError: |
|
742 | except AttributeError: | |
744 | # it was not commandchain, plain old func - replace |
|
743 | # it was not commandchain, plain old func - replace | |
745 | dp = f |
|
744 | dp = f | |
746 |
|
745 | |||
747 | setattr(self.hooks,name, dp) |
|
746 | setattr(self.hooks,name, dp) | |
748 |
|
747 | |||
749 | def register_post_execute(self, func): |
|
748 | def register_post_execute(self, func): | |
750 | """Register a function for calling after code execution. |
|
749 | """Register a function for calling after code execution. | |
751 | """ |
|
750 | """ | |
752 | if not callable(func): |
|
751 | if not callable(func): | |
753 | raise ValueError('argument %s must be callable' % func) |
|
752 | raise ValueError('argument %s must be callable' % func) | |
754 | self._post_execute[func] = True |
|
753 | self._post_execute[func] = True | |
755 |
|
754 | |||
756 | #------------------------------------------------------------------------- |
|
755 | #------------------------------------------------------------------------- | |
757 | # Things related to the "main" module |
|
756 | # Things related to the "main" module | |
758 | #------------------------------------------------------------------------- |
|
757 | #------------------------------------------------------------------------- | |
759 |
|
758 | |||
760 | def new_main_mod(self,ns=None): |
|
759 | def new_main_mod(self,ns=None): | |
761 | """Return a new 'main' module object for user code execution. |
|
760 | """Return a new 'main' module object for user code execution. | |
762 | """ |
|
761 | """ | |
763 | main_mod = self._user_main_module |
|
762 | main_mod = self._user_main_module | |
764 | init_fakemod_dict(main_mod,ns) |
|
763 | init_fakemod_dict(main_mod,ns) | |
765 | return main_mod |
|
764 | return main_mod | |
766 |
|
765 | |||
767 | def cache_main_mod(self,ns,fname): |
|
766 | def cache_main_mod(self,ns,fname): | |
768 | """Cache a main module's namespace. |
|
767 | """Cache a main module's namespace. | |
769 |
|
768 | |||
770 | When scripts are executed via %run, we must keep a reference to the |
|
769 | When scripts are executed via %run, we must keep a reference to the | |
771 | namespace of their __main__ module (a FakeModule instance) around so |
|
770 | namespace of their __main__ module (a FakeModule instance) around so | |
772 | that Python doesn't clear it, rendering objects defined therein |
|
771 | that Python doesn't clear it, rendering objects defined therein | |
773 | useless. |
|
772 | useless. | |
774 |
|
773 | |||
775 | This method keeps said reference in a private dict, keyed by the |
|
774 | This method keeps said reference in a private dict, keyed by the | |
776 | absolute path of the module object (which corresponds to the script |
|
775 | absolute path of the module object (which corresponds to the script | |
777 | path). This way, for multiple executions of the same script we only |
|
776 | path). This way, for multiple executions of the same script we only | |
778 | keep one copy of the namespace (the last one), thus preventing memory |
|
777 | keep one copy of the namespace (the last one), thus preventing memory | |
779 | leaks from old references while allowing the objects from the last |
|
778 | leaks from old references while allowing the objects from the last | |
780 | execution to be accessible. |
|
779 | execution to be accessible. | |
781 |
|
780 | |||
782 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
781 | Note: we can not allow the actual FakeModule instances to be deleted, | |
783 | because of how Python tears down modules (it hard-sets all their |
|
782 | because of how Python tears down modules (it hard-sets all their | |
784 | references to None without regard for reference counts). This method |
|
783 | references to None without regard for reference counts). This method | |
785 | must therefore make a *copy* of the given namespace, to allow the |
|
784 | must therefore make a *copy* of the given namespace, to allow the | |
786 | original module's __dict__ to be cleared and reused. |
|
785 | original module's __dict__ to be cleared and reused. | |
787 |
|
786 | |||
788 |
|
787 | |||
789 | Parameters |
|
788 | Parameters | |
790 | ---------- |
|
789 | ---------- | |
791 | ns : a namespace (a dict, typically) |
|
790 | ns : a namespace (a dict, typically) | |
792 |
|
791 | |||
793 | fname : str |
|
792 | fname : str | |
794 | Filename associated with the namespace. |
|
793 | Filename associated with the namespace. | |
795 |
|
794 | |||
796 | Examples |
|
795 | Examples | |
797 | -------- |
|
796 | -------- | |
798 |
|
797 | |||
799 | In [10]: import IPython |
|
798 | In [10]: import IPython | |
800 |
|
799 | |||
801 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
800 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
802 |
|
801 | |||
803 | In [12]: IPython.__file__ in _ip._main_ns_cache |
|
802 | In [12]: IPython.__file__ in _ip._main_ns_cache | |
804 | Out[12]: True |
|
803 | Out[12]: True | |
805 | """ |
|
804 | """ | |
806 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
805 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() | |
807 |
|
806 | |||
808 | def clear_main_mod_cache(self): |
|
807 | def clear_main_mod_cache(self): | |
809 | """Clear the cache of main modules. |
|
808 | """Clear the cache of main modules. | |
810 |
|
809 | |||
811 | Mainly for use by utilities like %reset. |
|
810 | Mainly for use by utilities like %reset. | |
812 |
|
811 | |||
813 | Examples |
|
812 | Examples | |
814 | -------- |
|
813 | -------- | |
815 |
|
814 | |||
816 | In [15]: import IPython |
|
815 | In [15]: import IPython | |
817 |
|
816 | |||
818 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
817 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
819 |
|
818 | |||
820 | In [17]: len(_ip._main_ns_cache) > 0 |
|
819 | In [17]: len(_ip._main_ns_cache) > 0 | |
821 | Out[17]: True |
|
820 | Out[17]: True | |
822 |
|
821 | |||
823 | In [18]: _ip.clear_main_mod_cache() |
|
822 | In [18]: _ip.clear_main_mod_cache() | |
824 |
|
823 | |||
825 | In [19]: len(_ip._main_ns_cache) == 0 |
|
824 | In [19]: len(_ip._main_ns_cache) == 0 | |
826 | Out[19]: True |
|
825 | Out[19]: True | |
827 | """ |
|
826 | """ | |
828 | self._main_ns_cache.clear() |
|
827 | self._main_ns_cache.clear() | |
829 |
|
828 | |||
830 | #------------------------------------------------------------------------- |
|
829 | #------------------------------------------------------------------------- | |
831 | # Things related to debugging |
|
830 | # Things related to debugging | |
832 | #------------------------------------------------------------------------- |
|
831 | #------------------------------------------------------------------------- | |
833 |
|
832 | |||
834 | def init_pdb(self): |
|
833 | def init_pdb(self): | |
835 | # Set calling of pdb on exceptions |
|
834 | # Set calling of pdb on exceptions | |
836 | # self.call_pdb is a property |
|
835 | # self.call_pdb is a property | |
837 | self.call_pdb = self.pdb |
|
836 | self.call_pdb = self.pdb | |
838 |
|
837 | |||
839 | def _get_call_pdb(self): |
|
838 | def _get_call_pdb(self): | |
840 | return self._call_pdb |
|
839 | return self._call_pdb | |
841 |
|
840 | |||
842 | def _set_call_pdb(self,val): |
|
841 | def _set_call_pdb(self,val): | |
843 |
|
842 | |||
844 | if val not in (0,1,False,True): |
|
843 | if val not in (0,1,False,True): | |
845 | raise ValueError,'new call_pdb value must be boolean' |
|
844 | raise ValueError,'new call_pdb value must be boolean' | |
846 |
|
845 | |||
847 | # store value in instance |
|
846 | # store value in instance | |
848 | self._call_pdb = val |
|
847 | self._call_pdb = val | |
849 |
|
848 | |||
850 | # notify the actual exception handlers |
|
849 | # notify the actual exception handlers | |
851 | self.InteractiveTB.call_pdb = val |
|
850 | self.InteractiveTB.call_pdb = val | |
852 |
|
851 | |||
853 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
852 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
854 | 'Control auto-activation of pdb at exceptions') |
|
853 | 'Control auto-activation of pdb at exceptions') | |
855 |
|
854 | |||
856 | def debugger(self,force=False): |
|
855 | def debugger(self,force=False): | |
857 | """Call the pydb/pdb debugger. |
|
856 | """Call the pydb/pdb debugger. | |
858 |
|
857 | |||
859 | Keywords: |
|
858 | Keywords: | |
860 |
|
859 | |||
861 | - force(False): by default, this routine checks the instance call_pdb |
|
860 | - force(False): by default, this routine checks the instance call_pdb | |
862 | flag and does not actually invoke the debugger if the flag is false. |
|
861 | flag and does not actually invoke the debugger if the flag is false. | |
863 | The 'force' option forces the debugger to activate even if the flag |
|
862 | The 'force' option forces the debugger to activate even if the flag | |
864 | is false. |
|
863 | is false. | |
865 | """ |
|
864 | """ | |
866 |
|
865 | |||
867 | if not (force or self.call_pdb): |
|
866 | if not (force or self.call_pdb): | |
868 | return |
|
867 | return | |
869 |
|
868 | |||
870 | if not hasattr(sys,'last_traceback'): |
|
869 | if not hasattr(sys,'last_traceback'): | |
871 | error('No traceback has been produced, nothing to debug.') |
|
870 | error('No traceback has been produced, nothing to debug.') | |
872 | return |
|
871 | return | |
873 |
|
872 | |||
874 | # use pydb if available |
|
873 | # use pydb if available | |
875 | if debugger.has_pydb: |
|
874 | if debugger.has_pydb: | |
876 | from pydb import pm |
|
875 | from pydb import pm | |
877 | else: |
|
876 | else: | |
878 | # fallback to our internal debugger |
|
877 | # fallback to our internal debugger | |
879 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
878 | pm = lambda : self.InteractiveTB.debugger(force=True) | |
880 |
|
879 | |||
881 | with self.readline_no_record: |
|
880 | with self.readline_no_record: | |
882 | pm() |
|
881 | pm() | |
883 |
|
882 | |||
884 | #------------------------------------------------------------------------- |
|
883 | #------------------------------------------------------------------------- | |
885 | # Things related to IPython's various namespaces |
|
884 | # Things related to IPython's various namespaces | |
886 | #------------------------------------------------------------------------- |
|
885 | #------------------------------------------------------------------------- | |
887 | default_user_namespaces = True |
|
886 | default_user_namespaces = True | |
888 |
|
887 | |||
889 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
888 | def init_create_namespaces(self, user_module=None, user_ns=None): | |
890 | # Create the namespace where the user will operate. user_ns is |
|
889 | # Create the namespace where the user will operate. user_ns is | |
891 | # normally the only one used, and it is passed to the exec calls as |
|
890 | # normally the only one used, and it is passed to the exec calls as | |
892 | # the locals argument. But we do carry a user_global_ns namespace |
|
891 | # the locals argument. But we do carry a user_global_ns namespace | |
893 | # given as the exec 'globals' argument, This is useful in embedding |
|
892 | # given as the exec 'globals' argument, This is useful in embedding | |
894 | # situations where the ipython shell opens in a context where the |
|
893 | # situations where the ipython shell opens in a context where the | |
895 | # distinction between locals and globals is meaningful. For |
|
894 | # distinction between locals and globals is meaningful. For | |
896 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
895 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
897 |
|
896 | |||
898 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
897 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
899 | # level as a dict instead of a module. This is a manual fix, but I |
|
898 | # level as a dict instead of a module. This is a manual fix, but I | |
900 | # should really track down where the problem is coming from. Alex |
|
899 | # should really track down where the problem is coming from. Alex | |
901 | # Schmolck reported this problem first. |
|
900 | # Schmolck reported this problem first. | |
902 |
|
901 | |||
903 | # A useful post by Alex Martelli on this topic: |
|
902 | # A useful post by Alex Martelli on this topic: | |
904 | # Re: inconsistent value from __builtins__ |
|
903 | # Re: inconsistent value from __builtins__ | |
905 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
904 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
906 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
905 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
907 | # Gruppen: comp.lang.python |
|
906 | # Gruppen: comp.lang.python | |
908 |
|
907 | |||
909 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
908 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
910 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
909 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
911 | # > <type 'dict'> |
|
910 | # > <type 'dict'> | |
912 | # > >>> print type(__builtins__) |
|
911 | # > >>> print type(__builtins__) | |
913 | # > <type 'module'> |
|
912 | # > <type 'module'> | |
914 | # > Is this difference in return value intentional? |
|
913 | # > Is this difference in return value intentional? | |
915 |
|
914 | |||
916 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
915 | # Well, it's documented that '__builtins__' can be either a dictionary | |
917 | # or a module, and it's been that way for a long time. Whether it's |
|
916 | # or a module, and it's been that way for a long time. Whether it's | |
918 | # intentional (or sensible), I don't know. In any case, the idea is |
|
917 | # intentional (or sensible), I don't know. In any case, the idea is | |
919 | # that if you need to access the built-in namespace directly, you |
|
918 | # that if you need to access the built-in namespace directly, you | |
920 | # should start with "import __builtin__" (note, no 's') which will |
|
919 | # should start with "import __builtin__" (note, no 's') which will | |
921 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
920 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
922 |
|
921 | |||
923 | # These routines return a properly built module and dict as needed by |
|
922 | # These routines return a properly built module and dict as needed by | |
924 | # the rest of the code, and can also be used by extension writers to |
|
923 | # the rest of the code, and can also be used by extension writers to | |
925 | # generate properly initialized namespaces. |
|
924 | # generate properly initialized namespaces. | |
926 | if (user_ns is not None) or (user_module is not None): |
|
925 | if (user_ns is not None) or (user_module is not None): | |
927 | self.default_user_namespaces = False |
|
926 | self.default_user_namespaces = False | |
928 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
927 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) | |
929 |
|
928 | |||
930 | # A record of hidden variables we have added to the user namespace, so |
|
929 | # A record of hidden variables we have added to the user namespace, so | |
931 | # we can list later only variables defined in actual interactive use. |
|
930 | # we can list later only variables defined in actual interactive use. | |
932 | self.user_ns_hidden = set() |
|
931 | self.user_ns_hidden = set() | |
933 |
|
932 | |||
934 | # Now that FakeModule produces a real module, we've run into a nasty |
|
933 | # Now that FakeModule produces a real module, we've run into a nasty | |
935 | # problem: after script execution (via %run), the module where the user |
|
934 | # problem: after script execution (via %run), the module where the user | |
936 | # code ran is deleted. Now that this object is a true module (needed |
|
935 | # code ran is deleted. Now that this object is a true module (needed | |
937 | # so docetst and other tools work correctly), the Python module |
|
936 | # so docetst and other tools work correctly), the Python module | |
938 | # teardown mechanism runs over it, and sets to None every variable |
|
937 | # teardown mechanism runs over it, and sets to None every variable | |
939 | # present in that module. Top-level references to objects from the |
|
938 | # present in that module. Top-level references to objects from the | |
940 | # script survive, because the user_ns is updated with them. However, |
|
939 | # script survive, because the user_ns is updated with them. However, | |
941 | # calling functions defined in the script that use other things from |
|
940 | # calling functions defined in the script that use other things from | |
942 | # the script will fail, because the function's closure had references |
|
941 | # the script will fail, because the function's closure had references | |
943 | # to the original objects, which are now all None. So we must protect |
|
942 | # to the original objects, which are now all None. So we must protect | |
944 | # these modules from deletion by keeping a cache. |
|
943 | # these modules from deletion by keeping a cache. | |
945 | # |
|
944 | # | |
946 | # To avoid keeping stale modules around (we only need the one from the |
|
945 | # To avoid keeping stale modules around (we only need the one from the | |
947 | # last run), we use a dict keyed with the full path to the script, so |
|
946 | # last run), we use a dict keyed with the full path to the script, so | |
948 | # only the last version of the module is held in the cache. Note, |
|
947 | # only the last version of the module is held in the cache. Note, | |
949 | # however, that we must cache the module *namespace contents* (their |
|
948 | # however, that we must cache the module *namespace contents* (their | |
950 | # __dict__). Because if we try to cache the actual modules, old ones |
|
949 | # __dict__). Because if we try to cache the actual modules, old ones | |
951 | # (uncached) could be destroyed while still holding references (such as |
|
950 | # (uncached) could be destroyed while still holding references (such as | |
952 | # those held by GUI objects that tend to be long-lived)> |
|
951 | # those held by GUI objects that tend to be long-lived)> | |
953 | # |
|
952 | # | |
954 | # The %reset command will flush this cache. See the cache_main_mod() |
|
953 | # The %reset command will flush this cache. See the cache_main_mod() | |
955 | # and clear_main_mod_cache() methods for details on use. |
|
954 | # and clear_main_mod_cache() methods for details on use. | |
956 |
|
955 | |||
957 | # This is the cache used for 'main' namespaces |
|
956 | # This is the cache used for 'main' namespaces | |
958 | self._main_ns_cache = {} |
|
957 | self._main_ns_cache = {} | |
959 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
958 | # And this is the single instance of FakeModule whose __dict__ we keep | |
960 | # copying and clearing for reuse on each %run |
|
959 | # copying and clearing for reuse on each %run | |
961 | self._user_main_module = FakeModule() |
|
960 | self._user_main_module = FakeModule() | |
962 |
|
961 | |||
963 | # A table holding all the namespaces IPython deals with, so that |
|
962 | # A table holding all the namespaces IPython deals with, so that | |
964 | # introspection facilities can search easily. |
|
963 | # introspection facilities can search easily. | |
965 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
964 | self.ns_table = {'user_global':self.user_module.__dict__, | |
966 | 'user_local':self.user_ns, |
|
965 | 'user_local':self.user_ns, | |
967 | 'builtin':builtin_mod.__dict__ |
|
966 | 'builtin':builtin_mod.__dict__ | |
968 | } |
|
967 | } | |
969 |
|
968 | |||
970 | @property |
|
969 | @property | |
971 | def user_global_ns(self): |
|
970 | def user_global_ns(self): | |
972 | return self.user_module.__dict__ |
|
971 | return self.user_module.__dict__ | |
973 |
|
972 | |||
974 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
973 | def prepare_user_module(self, user_module=None, user_ns=None): | |
975 | """Prepare the module and namespace in which user code will be run. |
|
974 | """Prepare the module and namespace in which user code will be run. | |
976 |
|
975 | |||
977 | When IPython is started normally, both parameters are None: a new module |
|
976 | When IPython is started normally, both parameters are None: a new module | |
978 | is created automatically, and its __dict__ used as the namespace. |
|
977 | is created automatically, and its __dict__ used as the namespace. | |
979 |
|
978 | |||
980 | If only user_module is provided, its __dict__ is used as the namespace. |
|
979 | If only user_module is provided, its __dict__ is used as the namespace. | |
981 | If only user_ns is provided, a dummy module is created, and user_ns |
|
980 | If only user_ns is provided, a dummy module is created, and user_ns | |
982 | becomes the global namespace. If both are provided (as they may be |
|
981 | becomes the global namespace. If both are provided (as they may be | |
983 | when embedding), user_ns is the local namespace, and user_module |
|
982 | when embedding), user_ns is the local namespace, and user_module | |
984 | provides the global namespace. |
|
983 | provides the global namespace. | |
985 |
|
984 | |||
986 | Parameters |
|
985 | Parameters | |
987 | ---------- |
|
986 | ---------- | |
988 | user_module : module, optional |
|
987 | user_module : module, optional | |
989 | The current user module in which IPython is being run. If None, |
|
988 | The current user module in which IPython is being run. If None, | |
990 | a clean module will be created. |
|
989 | a clean module will be created. | |
991 | user_ns : dict, optional |
|
990 | user_ns : dict, optional | |
992 | A namespace in which to run interactive commands. |
|
991 | A namespace in which to run interactive commands. | |
993 |
|
992 | |||
994 | Returns |
|
993 | Returns | |
995 | ------- |
|
994 | ------- | |
996 | A tuple of user_module and user_ns, each properly initialised. |
|
995 | A tuple of user_module and user_ns, each properly initialised. | |
997 | """ |
|
996 | """ | |
998 | if user_module is None and user_ns is not None: |
|
997 | if user_module is None and user_ns is not None: | |
999 | user_ns.setdefault("__name__", "__main__") |
|
998 | user_ns.setdefault("__name__", "__main__") | |
1000 | class DummyMod(object): |
|
999 | class DummyMod(object): | |
1001 | "A dummy module used for IPython's interactive namespace." |
|
1000 | "A dummy module used for IPython's interactive namespace." | |
1002 | pass |
|
1001 | pass | |
1003 | user_module = DummyMod() |
|
1002 | user_module = DummyMod() | |
1004 | user_module.__dict__ = user_ns |
|
1003 | user_module.__dict__ = user_ns | |
1005 |
|
1004 | |||
1006 | if user_module is None: |
|
1005 | if user_module is None: | |
1007 | user_module = types.ModuleType("__main__", |
|
1006 | user_module = types.ModuleType("__main__", | |
1008 | doc="Automatically created module for IPython interactive environment") |
|
1007 | doc="Automatically created module for IPython interactive environment") | |
1009 |
|
1008 | |||
1010 | # We must ensure that __builtin__ (without the final 's') is always |
|
1009 | # We must ensure that __builtin__ (without the final 's') is always | |
1011 | # available and pointing to the __builtin__ *module*. For more details: |
|
1010 | # available and pointing to the __builtin__ *module*. For more details: | |
1012 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1011 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1013 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
1012 | user_module.__dict__.setdefault('__builtin__', builtin_mod) | |
1014 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
1013 | user_module.__dict__.setdefault('__builtins__', builtin_mod) | |
1015 |
|
1014 | |||
1016 | if user_ns is None: |
|
1015 | if user_ns is None: | |
1017 | user_ns = user_module.__dict__ |
|
1016 | user_ns = user_module.__dict__ | |
1018 |
|
1017 | |||
1019 | return user_module, user_ns |
|
1018 | return user_module, user_ns | |
1020 |
|
1019 | |||
1021 | def init_sys_modules(self): |
|
1020 | def init_sys_modules(self): | |
1022 | # We need to insert into sys.modules something that looks like a |
|
1021 | # We need to insert into sys.modules something that looks like a | |
1023 | # module but which accesses the IPython namespace, for shelve and |
|
1022 | # module but which accesses the IPython namespace, for shelve and | |
1024 | # pickle to work interactively. Normally they rely on getting |
|
1023 | # pickle to work interactively. Normally they rely on getting | |
1025 | # everything out of __main__, but for embedding purposes each IPython |
|
1024 | # everything out of __main__, but for embedding purposes each IPython | |
1026 | # instance has its own private namespace, so we can't go shoving |
|
1025 | # instance has its own private namespace, so we can't go shoving | |
1027 | # everything into __main__. |
|
1026 | # everything into __main__. | |
1028 |
|
1027 | |||
1029 | # note, however, that we should only do this for non-embedded |
|
1028 | # note, however, that we should only do this for non-embedded | |
1030 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1029 | # ipythons, which really mimic the __main__.__dict__ with their own | |
1031 | # namespace. Embedded instances, on the other hand, should not do |
|
1030 | # namespace. Embedded instances, on the other hand, should not do | |
1032 | # this because they need to manage the user local/global namespaces |
|
1031 | # this because they need to manage the user local/global namespaces | |
1033 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1032 | # only, but they live within a 'normal' __main__ (meaning, they | |
1034 | # shouldn't overtake the execution environment of the script they're |
|
1033 | # shouldn't overtake the execution environment of the script they're | |
1035 | # embedded in). |
|
1034 | # embedded in). | |
1036 |
|
1035 | |||
1037 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1036 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
1038 | main_name = self.user_module.__name__ |
|
1037 | main_name = self.user_module.__name__ | |
1039 | sys.modules[main_name] = self.user_module |
|
1038 | sys.modules[main_name] = self.user_module | |
1040 |
|
1039 | |||
1041 | def init_user_ns(self): |
|
1040 | def init_user_ns(self): | |
1042 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1041 | """Initialize all user-visible namespaces to their minimum defaults. | |
1043 |
|
1042 | |||
1044 | Certain history lists are also initialized here, as they effectively |
|
1043 | Certain history lists are also initialized here, as they effectively | |
1045 | act as user namespaces. |
|
1044 | act as user namespaces. | |
1046 |
|
1045 | |||
1047 | Notes |
|
1046 | Notes | |
1048 | ----- |
|
1047 | ----- | |
1049 | All data structures here are only filled in, they are NOT reset by this |
|
1048 | All data structures here are only filled in, they are NOT reset by this | |
1050 | method. If they were not empty before, data will simply be added to |
|
1049 | method. If they were not empty before, data will simply be added to | |
1051 | therm. |
|
1050 | therm. | |
1052 | """ |
|
1051 | """ | |
1053 | # This function works in two parts: first we put a few things in |
|
1052 | # This function works in two parts: first we put a few things in | |
1054 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1053 | # user_ns, and we sync that contents into user_ns_hidden so that these | |
1055 | # initial variables aren't shown by %who. After the sync, we add the |
|
1054 | # initial variables aren't shown by %who. After the sync, we add the | |
1056 | # rest of what we *do* want the user to see with %who even on a new |
|
1055 | # rest of what we *do* want the user to see with %who even on a new | |
1057 | # session (probably nothing, so theye really only see their own stuff) |
|
1056 | # session (probably nothing, so theye really only see their own stuff) | |
1058 |
|
1057 | |||
1059 | # The user dict must *always* have a __builtin__ reference to the |
|
1058 | # The user dict must *always* have a __builtin__ reference to the | |
1060 | # Python standard __builtin__ namespace, which must be imported. |
|
1059 | # Python standard __builtin__ namespace, which must be imported. | |
1061 | # This is so that certain operations in prompt evaluation can be |
|
1060 | # This is so that certain operations in prompt evaluation can be | |
1062 | # reliably executed with builtins. Note that we can NOT use |
|
1061 | # reliably executed with builtins. Note that we can NOT use | |
1063 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1062 | # __builtins__ (note the 's'), because that can either be a dict or a | |
1064 | # module, and can even mutate at runtime, depending on the context |
|
1063 | # module, and can even mutate at runtime, depending on the context | |
1065 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1064 | # (Python makes no guarantees on it). In contrast, __builtin__ is | |
1066 | # always a module object, though it must be explicitly imported. |
|
1065 | # always a module object, though it must be explicitly imported. | |
1067 |
|
1066 | |||
1068 | # For more details: |
|
1067 | # For more details: | |
1069 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1068 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1070 | ns = dict() |
|
1069 | ns = dict() | |
1071 |
|
1070 | |||
1072 | # Put 'help' in the user namespace |
|
1071 | # Put 'help' in the user namespace | |
1073 | try: |
|
1072 | try: | |
1074 | from site import _Helper |
|
1073 | from site import _Helper | |
1075 | ns['help'] = _Helper() |
|
1074 | ns['help'] = _Helper() | |
1076 | except ImportError: |
|
1075 | except ImportError: | |
1077 | warn('help() not available - check site.py') |
|
1076 | warn('help() not available - check site.py') | |
1078 |
|
1077 | |||
1079 | # make global variables for user access to the histories |
|
1078 | # make global variables for user access to the histories | |
1080 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1079 | ns['_ih'] = self.history_manager.input_hist_parsed | |
1081 | ns['_oh'] = self.history_manager.output_hist |
|
1080 | ns['_oh'] = self.history_manager.output_hist | |
1082 | ns['_dh'] = self.history_manager.dir_hist |
|
1081 | ns['_dh'] = self.history_manager.dir_hist | |
1083 |
|
1082 | |||
1084 | ns['_sh'] = shadowns |
|
1083 | ns['_sh'] = shadowns | |
1085 |
|
1084 | |||
1086 | # user aliases to input and output histories. These shouldn't show up |
|
1085 | # user aliases to input and output histories. These shouldn't show up | |
1087 | # in %who, as they can have very large reprs. |
|
1086 | # in %who, as they can have very large reprs. | |
1088 | ns['In'] = self.history_manager.input_hist_parsed |
|
1087 | ns['In'] = self.history_manager.input_hist_parsed | |
1089 | ns['Out'] = self.history_manager.output_hist |
|
1088 | ns['Out'] = self.history_manager.output_hist | |
1090 |
|
1089 | |||
1091 | # Store myself as the public api!!! |
|
1090 | # Store myself as the public api!!! | |
1092 | ns['get_ipython'] = self.get_ipython |
|
1091 | ns['get_ipython'] = self.get_ipython | |
1093 |
|
1092 | |||
1094 | ns['exit'] = self.exiter |
|
1093 | ns['exit'] = self.exiter | |
1095 | ns['quit'] = self.exiter |
|
1094 | ns['quit'] = self.exiter | |
1096 |
|
1095 | |||
1097 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1096 | # Sync what we've added so far to user_ns_hidden so these aren't seen | |
1098 | # by %who |
|
1097 | # by %who | |
1099 | self.user_ns_hidden.update(ns) |
|
1098 | self.user_ns_hidden.update(ns) | |
1100 |
|
1099 | |||
1101 | # Anything put into ns now would show up in %who. Think twice before |
|
1100 | # Anything put into ns now would show up in %who. Think twice before | |
1102 | # putting anything here, as we really want %who to show the user their |
|
1101 | # putting anything here, as we really want %who to show the user their | |
1103 | # stuff, not our variables. |
|
1102 | # stuff, not our variables. | |
1104 |
|
1103 | |||
1105 | # Finally, update the real user's namespace |
|
1104 | # Finally, update the real user's namespace | |
1106 | self.user_ns.update(ns) |
|
1105 | self.user_ns.update(ns) | |
1107 |
|
1106 | |||
1108 | @property |
|
1107 | @property | |
1109 | def all_ns_refs(self): |
|
1108 | def all_ns_refs(self): | |
1110 | """Get a list of references to all the namespace dictionaries in which |
|
1109 | """Get a list of references to all the namespace dictionaries in which | |
1111 | IPython might store a user-created object. |
|
1110 | IPython might store a user-created object. | |
1112 |
|
1111 | |||
1113 | Note that this does not include the displayhook, which also caches |
|
1112 | Note that this does not include the displayhook, which also caches | |
1114 | objects from the output.""" |
|
1113 | objects from the output.""" | |
1115 | return [self.user_ns, self.user_global_ns, |
|
1114 | return [self.user_ns, self.user_global_ns, | |
1116 | self._user_main_module.__dict__] + self._main_ns_cache.values() |
|
1115 | self._user_main_module.__dict__] + self._main_ns_cache.values() | |
1117 |
|
1116 | |||
1118 | def reset(self, new_session=True): |
|
1117 | def reset(self, new_session=True): | |
1119 | """Clear all internal namespaces, and attempt to release references to |
|
1118 | """Clear all internal namespaces, and attempt to release references to | |
1120 | user objects. |
|
1119 | user objects. | |
1121 |
|
1120 | |||
1122 | If new_session is True, a new history session will be opened. |
|
1121 | If new_session is True, a new history session will be opened. | |
1123 | """ |
|
1122 | """ | |
1124 | # Clear histories |
|
1123 | # Clear histories | |
1125 | self.history_manager.reset(new_session) |
|
1124 | self.history_manager.reset(new_session) | |
1126 | # Reset counter used to index all histories |
|
1125 | # Reset counter used to index all histories | |
1127 | if new_session: |
|
1126 | if new_session: | |
1128 | self.execution_count = 1 |
|
1127 | self.execution_count = 1 | |
1129 |
|
1128 | |||
1130 | # Flush cached output items |
|
1129 | # Flush cached output items | |
1131 | if self.displayhook.do_full_cache: |
|
1130 | if self.displayhook.do_full_cache: | |
1132 | self.displayhook.flush() |
|
1131 | self.displayhook.flush() | |
1133 |
|
1132 | |||
1134 | # The main execution namespaces must be cleared very carefully, |
|
1133 | # The main execution namespaces must be cleared very carefully, | |
1135 | # skipping the deletion of the builtin-related keys, because doing so |
|
1134 | # skipping the deletion of the builtin-related keys, because doing so | |
1136 | # would cause errors in many object's __del__ methods. |
|
1135 | # would cause errors in many object's __del__ methods. | |
1137 | if self.user_ns is not self.user_global_ns: |
|
1136 | if self.user_ns is not self.user_global_ns: | |
1138 | self.user_ns.clear() |
|
1137 | self.user_ns.clear() | |
1139 | ns = self.user_global_ns |
|
1138 | ns = self.user_global_ns | |
1140 | drop_keys = set(ns.keys()) |
|
1139 | drop_keys = set(ns.keys()) | |
1141 | drop_keys.discard('__builtin__') |
|
1140 | drop_keys.discard('__builtin__') | |
1142 | drop_keys.discard('__builtins__') |
|
1141 | drop_keys.discard('__builtins__') | |
1143 | drop_keys.discard('__name__') |
|
1142 | drop_keys.discard('__name__') | |
1144 | for k in drop_keys: |
|
1143 | for k in drop_keys: | |
1145 | del ns[k] |
|
1144 | del ns[k] | |
1146 |
|
1145 | |||
1147 | self.user_ns_hidden.clear() |
|
1146 | self.user_ns_hidden.clear() | |
1148 |
|
1147 | |||
1149 | # Restore the user namespaces to minimal usability |
|
1148 | # Restore the user namespaces to minimal usability | |
1150 | self.init_user_ns() |
|
1149 | self.init_user_ns() | |
1151 |
|
1150 | |||
1152 | # Restore the default and user aliases |
|
1151 | # Restore the default and user aliases | |
1153 | self.alias_manager.clear_aliases() |
|
1152 | self.alias_manager.clear_aliases() | |
1154 | self.alias_manager.init_aliases() |
|
1153 | self.alias_manager.init_aliases() | |
1155 |
|
1154 | |||
1156 | # Flush the private list of module references kept for script |
|
1155 | # Flush the private list of module references kept for script | |
1157 | # execution protection |
|
1156 | # execution protection | |
1158 | self.clear_main_mod_cache() |
|
1157 | self.clear_main_mod_cache() | |
1159 |
|
1158 | |||
1160 | # Clear out the namespace from the last %run |
|
1159 | # Clear out the namespace from the last %run | |
1161 | self.new_main_mod() |
|
1160 | self.new_main_mod() | |
1162 |
|
1161 | |||
1163 | def del_var(self, varname, by_name=False): |
|
1162 | def del_var(self, varname, by_name=False): | |
1164 | """Delete a variable from the various namespaces, so that, as |
|
1163 | """Delete a variable from the various namespaces, so that, as | |
1165 | far as possible, we're not keeping any hidden references to it. |
|
1164 | far as possible, we're not keeping any hidden references to it. | |
1166 |
|
1165 | |||
1167 | Parameters |
|
1166 | Parameters | |
1168 | ---------- |
|
1167 | ---------- | |
1169 | varname : str |
|
1168 | varname : str | |
1170 | The name of the variable to delete. |
|
1169 | The name of the variable to delete. | |
1171 | by_name : bool |
|
1170 | by_name : bool | |
1172 | If True, delete variables with the given name in each |
|
1171 | If True, delete variables with the given name in each | |
1173 | namespace. If False (default), find the variable in the user |
|
1172 | namespace. If False (default), find the variable in the user | |
1174 | namespace, and delete references to it. |
|
1173 | namespace, and delete references to it. | |
1175 | """ |
|
1174 | """ | |
1176 | if varname in ('__builtin__', '__builtins__'): |
|
1175 | if varname in ('__builtin__', '__builtins__'): | |
1177 | raise ValueError("Refusing to delete %s" % varname) |
|
1176 | raise ValueError("Refusing to delete %s" % varname) | |
1178 |
|
1177 | |||
1179 | ns_refs = self.all_ns_refs |
|
1178 | ns_refs = self.all_ns_refs | |
1180 |
|
1179 | |||
1181 | if by_name: # Delete by name |
|
1180 | if by_name: # Delete by name | |
1182 | for ns in ns_refs: |
|
1181 | for ns in ns_refs: | |
1183 | try: |
|
1182 | try: | |
1184 | del ns[varname] |
|
1183 | del ns[varname] | |
1185 | except KeyError: |
|
1184 | except KeyError: | |
1186 | pass |
|
1185 | pass | |
1187 | else: # Delete by object |
|
1186 | else: # Delete by object | |
1188 | try: |
|
1187 | try: | |
1189 | obj = self.user_ns[varname] |
|
1188 | obj = self.user_ns[varname] | |
1190 | except KeyError: |
|
1189 | except KeyError: | |
1191 | raise NameError("name '%s' is not defined" % varname) |
|
1190 | raise NameError("name '%s' is not defined" % varname) | |
1192 | # Also check in output history |
|
1191 | # Also check in output history | |
1193 | ns_refs.append(self.history_manager.output_hist) |
|
1192 | ns_refs.append(self.history_manager.output_hist) | |
1194 | for ns in ns_refs: |
|
1193 | for ns in ns_refs: | |
1195 | to_delete = [n for n, o in ns.iteritems() if o is obj] |
|
1194 | to_delete = [n for n, o in ns.iteritems() if o is obj] | |
1196 | for name in to_delete: |
|
1195 | for name in to_delete: | |
1197 | del ns[name] |
|
1196 | del ns[name] | |
1198 |
|
1197 | |||
1199 | # displayhook keeps extra references, but not in a dictionary |
|
1198 | # displayhook keeps extra references, but not in a dictionary | |
1200 | for name in ('_', '__', '___'): |
|
1199 | for name in ('_', '__', '___'): | |
1201 | if getattr(self.displayhook, name) is obj: |
|
1200 | if getattr(self.displayhook, name) is obj: | |
1202 | setattr(self.displayhook, name, None) |
|
1201 | setattr(self.displayhook, name, None) | |
1203 |
|
1202 | |||
1204 | def reset_selective(self, regex=None): |
|
1203 | def reset_selective(self, regex=None): | |
1205 | """Clear selective variables from internal namespaces based on a |
|
1204 | """Clear selective variables from internal namespaces based on a | |
1206 | specified regular expression. |
|
1205 | specified regular expression. | |
1207 |
|
1206 | |||
1208 | Parameters |
|
1207 | Parameters | |
1209 | ---------- |
|
1208 | ---------- | |
1210 | regex : string or compiled pattern, optional |
|
1209 | regex : string or compiled pattern, optional | |
1211 | A regular expression pattern that will be used in searching |
|
1210 | A regular expression pattern that will be used in searching | |
1212 | variable names in the users namespaces. |
|
1211 | variable names in the users namespaces. | |
1213 | """ |
|
1212 | """ | |
1214 | if regex is not None: |
|
1213 | if regex is not None: | |
1215 | try: |
|
1214 | try: | |
1216 | m = re.compile(regex) |
|
1215 | m = re.compile(regex) | |
1217 | except TypeError: |
|
1216 | except TypeError: | |
1218 | raise TypeError('regex must be a string or compiled pattern') |
|
1217 | raise TypeError('regex must be a string or compiled pattern') | |
1219 | # Search for keys in each namespace that match the given regex |
|
1218 | # Search for keys in each namespace that match the given regex | |
1220 | # If a match is found, delete the key/value pair. |
|
1219 | # If a match is found, delete the key/value pair. | |
1221 | for ns in self.all_ns_refs: |
|
1220 | for ns in self.all_ns_refs: | |
1222 | for var in ns: |
|
1221 | for var in ns: | |
1223 | if m.search(var): |
|
1222 | if m.search(var): | |
1224 | del ns[var] |
|
1223 | del ns[var] | |
1225 |
|
1224 | |||
1226 | def push(self, variables, interactive=True): |
|
1225 | def push(self, variables, interactive=True): | |
1227 | """Inject a group of variables into the IPython user namespace. |
|
1226 | """Inject a group of variables into the IPython user namespace. | |
1228 |
|
1227 | |||
1229 | Parameters |
|
1228 | Parameters | |
1230 | ---------- |
|
1229 | ---------- | |
1231 | variables : dict, str or list/tuple of str |
|
1230 | variables : dict, str or list/tuple of str | |
1232 | The variables to inject into the user's namespace. If a dict, a |
|
1231 | The variables to inject into the user's namespace. If a dict, a | |
1233 | simple update is done. If a str, the string is assumed to have |
|
1232 | simple update is done. If a str, the string is assumed to have | |
1234 | variable names separated by spaces. A list/tuple of str can also |
|
1233 | variable names separated by spaces. A list/tuple of str can also | |
1235 | be used to give the variable names. If just the variable names are |
|
1234 | be used to give the variable names. If just the variable names are | |
1236 | give (list/tuple/str) then the variable values looked up in the |
|
1235 | give (list/tuple/str) then the variable values looked up in the | |
1237 | callers frame. |
|
1236 | callers frame. | |
1238 | interactive : bool |
|
1237 | interactive : bool | |
1239 | If True (default), the variables will be listed with the ``who`` |
|
1238 | If True (default), the variables will be listed with the ``who`` | |
1240 | magic. |
|
1239 | magic. | |
1241 | """ |
|
1240 | """ | |
1242 | vdict = None |
|
1241 | vdict = None | |
1243 |
|
1242 | |||
1244 | # We need a dict of name/value pairs to do namespace updates. |
|
1243 | # We need a dict of name/value pairs to do namespace updates. | |
1245 | if isinstance(variables, dict): |
|
1244 | if isinstance(variables, dict): | |
1246 | vdict = variables |
|
1245 | vdict = variables | |
1247 | elif isinstance(variables, (basestring, list, tuple)): |
|
1246 | elif isinstance(variables, (basestring, list, tuple)): | |
1248 | if isinstance(variables, basestring): |
|
1247 | if isinstance(variables, basestring): | |
1249 | vlist = variables.split() |
|
1248 | vlist = variables.split() | |
1250 | else: |
|
1249 | else: | |
1251 | vlist = variables |
|
1250 | vlist = variables | |
1252 | vdict = {} |
|
1251 | vdict = {} | |
1253 | cf = sys._getframe(1) |
|
1252 | cf = sys._getframe(1) | |
1254 | for name in vlist: |
|
1253 | for name in vlist: | |
1255 | try: |
|
1254 | try: | |
1256 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1255 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) | |
1257 | except: |
|
1256 | except: | |
1258 | print ('Could not get variable %s from %s' % |
|
1257 | print ('Could not get variable %s from %s' % | |
1259 | (name,cf.f_code.co_name)) |
|
1258 | (name,cf.f_code.co_name)) | |
1260 | else: |
|
1259 | else: | |
1261 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1260 | raise ValueError('variables must be a dict/str/list/tuple') | |
1262 |
|
1261 | |||
1263 | # Propagate variables to user namespace |
|
1262 | # Propagate variables to user namespace | |
1264 | self.user_ns.update(vdict) |
|
1263 | self.user_ns.update(vdict) | |
1265 |
|
1264 | |||
1266 | # And configure interactive visibility |
|
1265 | # And configure interactive visibility | |
1267 | user_ns_hidden = self.user_ns_hidden |
|
1266 | user_ns_hidden = self.user_ns_hidden | |
1268 | if interactive: |
|
1267 | if interactive: | |
1269 | user_ns_hidden.difference_update(vdict) |
|
1268 | user_ns_hidden.difference_update(vdict) | |
1270 | else: |
|
1269 | else: | |
1271 | user_ns_hidden.update(vdict) |
|
1270 | user_ns_hidden.update(vdict) | |
1272 |
|
1271 | |||
1273 | def drop_by_id(self, variables): |
|
1272 | def drop_by_id(self, variables): | |
1274 | """Remove a dict of variables from the user namespace, if they are the |
|
1273 | """Remove a dict of variables from the user namespace, if they are the | |
1275 | same as the values in the dictionary. |
|
1274 | same as the values in the dictionary. | |
1276 |
|
1275 | |||
1277 | This is intended for use by extensions: variables that they've added can |
|
1276 | This is intended for use by extensions: variables that they've added can | |
1278 | be taken back out if they are unloaded, without removing any that the |
|
1277 | be taken back out if they are unloaded, without removing any that the | |
1279 | user has overwritten. |
|
1278 | user has overwritten. | |
1280 |
|
1279 | |||
1281 | Parameters |
|
1280 | Parameters | |
1282 | ---------- |
|
1281 | ---------- | |
1283 | variables : dict |
|
1282 | variables : dict | |
1284 | A dictionary mapping object names (as strings) to the objects. |
|
1283 | A dictionary mapping object names (as strings) to the objects. | |
1285 | """ |
|
1284 | """ | |
1286 | for name, obj in variables.iteritems(): |
|
1285 | for name, obj in variables.iteritems(): | |
1287 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1286 | if name in self.user_ns and self.user_ns[name] is obj: | |
1288 | del self.user_ns[name] |
|
1287 | del self.user_ns[name] | |
1289 | self.user_ns_hidden.discard(name) |
|
1288 | self.user_ns_hidden.discard(name) | |
1290 |
|
1289 | |||
1291 | #------------------------------------------------------------------------- |
|
1290 | #------------------------------------------------------------------------- | |
1292 | # Things related to object introspection |
|
1291 | # Things related to object introspection | |
1293 | #------------------------------------------------------------------------- |
|
1292 | #------------------------------------------------------------------------- | |
1294 |
|
1293 | |||
1295 | def _ofind(self, oname, namespaces=None): |
|
1294 | def _ofind(self, oname, namespaces=None): | |
1296 | """Find an object in the available namespaces. |
|
1295 | """Find an object in the available namespaces. | |
1297 |
|
1296 | |||
1298 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1297 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic | |
1299 |
|
1298 | |||
1300 | Has special code to detect magic functions. |
|
1299 | Has special code to detect magic functions. | |
1301 | """ |
|
1300 | """ | |
1302 | oname = oname.strip() |
|
1301 | oname = oname.strip() | |
1303 | #print '1- oname: <%r>' % oname # dbg |
|
1302 | #print '1- oname: <%r>' % oname # dbg | |
1304 | if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True): |
|
1303 | if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True): | |
1305 | return dict(found=False) |
|
1304 | return dict(found=False) | |
1306 |
|
1305 | |||
1307 | alias_ns = None |
|
1306 | alias_ns = None | |
1308 | if namespaces is None: |
|
1307 | if namespaces is None: | |
1309 | # Namespaces to search in: |
|
1308 | # Namespaces to search in: | |
1310 | # Put them in a list. The order is important so that we |
|
1309 | # Put them in a list. The order is important so that we | |
1311 | # find things in the same order that Python finds them. |
|
1310 | # find things in the same order that Python finds them. | |
1312 | namespaces = [ ('Interactive', self.user_ns), |
|
1311 | namespaces = [ ('Interactive', self.user_ns), | |
1313 | ('Interactive (global)', self.user_global_ns), |
|
1312 | ('Interactive (global)', self.user_global_ns), | |
1314 | ('Python builtin', builtin_mod.__dict__), |
|
1313 | ('Python builtin', builtin_mod.__dict__), | |
1315 | ('Alias', self.alias_manager.alias_table), |
|
1314 | ('Alias', self.alias_manager.alias_table), | |
1316 | ] |
|
1315 | ] | |
1317 | alias_ns = self.alias_manager.alias_table |
|
1316 | alias_ns = self.alias_manager.alias_table | |
1318 |
|
1317 | |||
1319 | # initialize results to 'null' |
|
1318 | # initialize results to 'null' | |
1320 | found = False; obj = None; ospace = None; ds = None; |
|
1319 | found = False; obj = None; ospace = None; ds = None; | |
1321 | ismagic = False; isalias = False; parent = None |
|
1320 | ismagic = False; isalias = False; parent = None | |
1322 |
|
1321 | |||
1323 | # We need to special-case 'print', which as of python2.6 registers as a |
|
1322 | # We need to special-case 'print', which as of python2.6 registers as a | |
1324 | # function but should only be treated as one if print_function was |
|
1323 | # function but should only be treated as one if print_function was | |
1325 | # loaded with a future import. In this case, just bail. |
|
1324 | # loaded with a future import. In this case, just bail. | |
1326 | if (oname == 'print' and not py3compat.PY3 and not \ |
|
1325 | if (oname == 'print' and not py3compat.PY3 and not \ | |
1327 | (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)): |
|
1326 | (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)): | |
1328 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1327 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1329 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1328 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1330 |
|
1329 | |||
1331 | # Look for the given name by splitting it in parts. If the head is |
|
1330 | # Look for the given name by splitting it in parts. If the head is | |
1332 | # found, then we look for all the remaining parts as members, and only |
|
1331 | # found, then we look for all the remaining parts as members, and only | |
1333 | # declare success if we can find them all. |
|
1332 | # declare success if we can find them all. | |
1334 | oname_parts = oname.split('.') |
|
1333 | oname_parts = oname.split('.') | |
1335 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1334 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] | |
1336 | for nsname,ns in namespaces: |
|
1335 | for nsname,ns in namespaces: | |
1337 | try: |
|
1336 | try: | |
1338 | obj = ns[oname_head] |
|
1337 | obj = ns[oname_head] | |
1339 | except KeyError: |
|
1338 | except KeyError: | |
1340 | continue |
|
1339 | continue | |
1341 | else: |
|
1340 | else: | |
1342 | #print 'oname_rest:', oname_rest # dbg |
|
1341 | #print 'oname_rest:', oname_rest # dbg | |
1343 | for part in oname_rest: |
|
1342 | for part in oname_rest: | |
1344 | try: |
|
1343 | try: | |
1345 | parent = obj |
|
1344 | parent = obj | |
1346 | obj = getattr(obj,part) |
|
1345 | obj = getattr(obj,part) | |
1347 | except: |
|
1346 | except: | |
1348 | # Blanket except b/c some badly implemented objects |
|
1347 | # Blanket except b/c some badly implemented objects | |
1349 | # allow __getattr__ to raise exceptions other than |
|
1348 | # allow __getattr__ to raise exceptions other than | |
1350 | # AttributeError, which then crashes IPython. |
|
1349 | # AttributeError, which then crashes IPython. | |
1351 | break |
|
1350 | break | |
1352 | else: |
|
1351 | else: | |
1353 | # If we finish the for loop (no break), we got all members |
|
1352 | # If we finish the for loop (no break), we got all members | |
1354 | found = True |
|
1353 | found = True | |
1355 | ospace = nsname |
|
1354 | ospace = nsname | |
1356 | if ns == alias_ns: |
|
1355 | if ns == alias_ns: | |
1357 | isalias = True |
|
1356 | isalias = True | |
1358 | break # namespace loop |
|
1357 | break # namespace loop | |
1359 |
|
1358 | |||
1360 | # Try to see if it's magic |
|
1359 | # Try to see if it's magic | |
1361 | if not found: |
|
1360 | if not found: | |
1362 | if oname.startswith(ESC_MAGIC): |
|
1361 | if oname.startswith(ESC_MAGIC): | |
1363 | oname = oname[1:] |
|
1362 | oname = oname[1:] | |
1364 | obj = getattr(self,'magic_'+oname,None) |
|
1363 | obj = getattr(self,'magic_'+oname,None) | |
1365 | if obj is not None: |
|
1364 | if obj is not None: | |
1366 | found = True |
|
1365 | found = True | |
1367 | ospace = 'IPython internal' |
|
1366 | ospace = 'IPython internal' | |
1368 | ismagic = True |
|
1367 | ismagic = True | |
1369 |
|
1368 | |||
1370 | # Last try: special-case some literals like '', [], {}, etc: |
|
1369 | # Last try: special-case some literals like '', [], {}, etc: | |
1371 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1370 | if not found and oname_head in ["''",'""','[]','{}','()']: | |
1372 | obj = eval(oname_head) |
|
1371 | obj = eval(oname_head) | |
1373 | found = True |
|
1372 | found = True | |
1374 | ospace = 'Interactive' |
|
1373 | ospace = 'Interactive' | |
1375 |
|
1374 | |||
1376 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1375 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1377 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1376 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1378 |
|
1377 | |||
1379 | def _ofind_property(self, oname, info): |
|
1378 | def _ofind_property(self, oname, info): | |
1380 | """Second part of object finding, to look for property details.""" |
|
1379 | """Second part of object finding, to look for property details.""" | |
1381 | if info.found: |
|
1380 | if info.found: | |
1382 | # Get the docstring of the class property if it exists. |
|
1381 | # Get the docstring of the class property if it exists. | |
1383 | path = oname.split('.') |
|
1382 | path = oname.split('.') | |
1384 | root = '.'.join(path[:-1]) |
|
1383 | root = '.'.join(path[:-1]) | |
1385 | if info.parent is not None: |
|
1384 | if info.parent is not None: | |
1386 | try: |
|
1385 | try: | |
1387 | target = getattr(info.parent, '__class__') |
|
1386 | target = getattr(info.parent, '__class__') | |
1388 | # The object belongs to a class instance. |
|
1387 | # The object belongs to a class instance. | |
1389 | try: |
|
1388 | try: | |
1390 | target = getattr(target, path[-1]) |
|
1389 | target = getattr(target, path[-1]) | |
1391 | # The class defines the object. |
|
1390 | # The class defines the object. | |
1392 | if isinstance(target, property): |
|
1391 | if isinstance(target, property): | |
1393 | oname = root + '.__class__.' + path[-1] |
|
1392 | oname = root + '.__class__.' + path[-1] | |
1394 | info = Struct(self._ofind(oname)) |
|
1393 | info = Struct(self._ofind(oname)) | |
1395 | except AttributeError: pass |
|
1394 | except AttributeError: pass | |
1396 | except AttributeError: pass |
|
1395 | except AttributeError: pass | |
1397 |
|
1396 | |||
1398 | # We return either the new info or the unmodified input if the object |
|
1397 | # We return either the new info or the unmodified input if the object | |
1399 | # hadn't been found |
|
1398 | # hadn't been found | |
1400 | return info |
|
1399 | return info | |
1401 |
|
1400 | |||
1402 | def _object_find(self, oname, namespaces=None): |
|
1401 | def _object_find(self, oname, namespaces=None): | |
1403 | """Find an object and return a struct with info about it.""" |
|
1402 | """Find an object and return a struct with info about it.""" | |
1404 | inf = Struct(self._ofind(oname, namespaces)) |
|
1403 | inf = Struct(self._ofind(oname, namespaces)) | |
1405 | return Struct(self._ofind_property(oname, inf)) |
|
1404 | return Struct(self._ofind_property(oname, inf)) | |
1406 |
|
1405 | |||
1407 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1406 | def _inspect(self, meth, oname, namespaces=None, **kw): | |
1408 | """Generic interface to the inspector system. |
|
1407 | """Generic interface to the inspector system. | |
1409 |
|
1408 | |||
1410 | This function is meant to be called by pdef, pdoc & friends.""" |
|
1409 | This function is meant to be called by pdef, pdoc & friends.""" | |
1411 | info = self._object_find(oname) |
|
1410 | info = self._object_find(oname) | |
1412 | if info.found: |
|
1411 | if info.found: | |
1413 | pmethod = getattr(self.inspector, meth) |
|
1412 | pmethod = getattr(self.inspector, meth) | |
1414 | formatter = format_screen if info.ismagic else None |
|
1413 | formatter = format_screen if info.ismagic else None | |
1415 | if meth == 'pdoc': |
|
1414 | if meth == 'pdoc': | |
1416 | pmethod(info.obj, oname, formatter) |
|
1415 | pmethod(info.obj, oname, formatter) | |
1417 | elif meth == 'pinfo': |
|
1416 | elif meth == 'pinfo': | |
1418 | pmethod(info.obj, oname, formatter, info, **kw) |
|
1417 | pmethod(info.obj, oname, formatter, info, **kw) | |
1419 | else: |
|
1418 | else: | |
1420 | pmethod(info.obj, oname) |
|
1419 | pmethod(info.obj, oname) | |
1421 | else: |
|
1420 | else: | |
1422 | print 'Object `%s` not found.' % oname |
|
1421 | print 'Object `%s` not found.' % oname | |
1423 | return 'not found' # so callers can take other action |
|
1422 | return 'not found' # so callers can take other action | |
1424 |
|
1423 | |||
1425 | def object_inspect(self, oname): |
|
1424 | def object_inspect(self, oname): | |
1426 | with self.builtin_trap: |
|
1425 | with self.builtin_trap: | |
1427 | info = self._object_find(oname) |
|
1426 | info = self._object_find(oname) | |
1428 | if info.found: |
|
1427 | if info.found: | |
1429 | return self.inspector.info(info.obj, oname, info=info) |
|
1428 | return self.inspector.info(info.obj, oname, info=info) | |
1430 | else: |
|
1429 | else: | |
1431 | return oinspect.object_info(name=oname, found=False) |
|
1430 | return oinspect.object_info(name=oname, found=False) | |
1432 |
|
1431 | |||
1433 | #------------------------------------------------------------------------- |
|
1432 | #------------------------------------------------------------------------- | |
1434 | # Things related to history management |
|
1433 | # Things related to history management | |
1435 | #------------------------------------------------------------------------- |
|
1434 | #------------------------------------------------------------------------- | |
1436 |
|
1435 | |||
1437 | def init_history(self): |
|
1436 | def init_history(self): | |
1438 | """Sets up the command history, and starts regular autosaves.""" |
|
1437 | """Sets up the command history, and starts regular autosaves.""" | |
1439 | self.history_manager = HistoryManager(shell=self, config=self.config) |
|
1438 | self.history_manager = HistoryManager(shell=self, config=self.config) | |
1440 | self.configurables.append(self.history_manager) |
|
1439 | self.configurables.append(self.history_manager) | |
1441 |
|
1440 | |||
1442 | #------------------------------------------------------------------------- |
|
1441 | #------------------------------------------------------------------------- | |
1443 | # Things related to exception handling and tracebacks (not debugging) |
|
1442 | # Things related to exception handling and tracebacks (not debugging) | |
1444 | #------------------------------------------------------------------------- |
|
1443 | #------------------------------------------------------------------------- | |
1445 |
|
1444 | |||
1446 | def init_traceback_handlers(self, custom_exceptions): |
|
1445 | def init_traceback_handlers(self, custom_exceptions): | |
1447 | # Syntax error handler. |
|
1446 | # Syntax error handler. | |
1448 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') |
|
1447 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') | |
1449 |
|
1448 | |||
1450 | # The interactive one is initialized with an offset, meaning we always |
|
1449 | # The interactive one is initialized with an offset, meaning we always | |
1451 | # want to remove the topmost item in the traceback, which is our own |
|
1450 | # want to remove the topmost item in the traceback, which is our own | |
1452 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1451 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
1453 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1452 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', | |
1454 | color_scheme='NoColor', |
|
1453 | color_scheme='NoColor', | |
1455 | tb_offset = 1, |
|
1454 | tb_offset = 1, | |
1456 | check_cache=self.compile.check_cache) |
|
1455 | check_cache=self.compile.check_cache) | |
1457 |
|
1456 | |||
1458 | # The instance will store a pointer to the system-wide exception hook, |
|
1457 | # The instance will store a pointer to the system-wide exception hook, | |
1459 | # so that runtime code (such as magics) can access it. This is because |
|
1458 | # so that runtime code (such as magics) can access it. This is because | |
1460 | # during the read-eval loop, it may get temporarily overwritten. |
|
1459 | # during the read-eval loop, it may get temporarily overwritten. | |
1461 | self.sys_excepthook = sys.excepthook |
|
1460 | self.sys_excepthook = sys.excepthook | |
1462 |
|
1461 | |||
1463 | # and add any custom exception handlers the user may have specified |
|
1462 | # and add any custom exception handlers the user may have specified | |
1464 | self.set_custom_exc(*custom_exceptions) |
|
1463 | self.set_custom_exc(*custom_exceptions) | |
1465 |
|
1464 | |||
1466 | # Set the exception mode |
|
1465 | # Set the exception mode | |
1467 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1466 | self.InteractiveTB.set_mode(mode=self.xmode) | |
1468 |
|
1467 | |||
1469 | def set_custom_exc(self, exc_tuple, handler): |
|
1468 | def set_custom_exc(self, exc_tuple, handler): | |
1470 | """set_custom_exc(exc_tuple,handler) |
|
1469 | """set_custom_exc(exc_tuple,handler) | |
1471 |
|
1470 | |||
1472 | Set a custom exception handler, which will be called if any of the |
|
1471 | Set a custom exception handler, which will be called if any of the | |
1473 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1472 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1474 | run_code() method). |
|
1473 | run_code() method). | |
1475 |
|
1474 | |||
1476 | Parameters |
|
1475 | Parameters | |
1477 | ---------- |
|
1476 | ---------- | |
1478 |
|
1477 | |||
1479 | exc_tuple : tuple of exception classes |
|
1478 | exc_tuple : tuple of exception classes | |
1480 | A *tuple* of exception classes, for which to call the defined |
|
1479 | A *tuple* of exception classes, for which to call the defined | |
1481 | handler. It is very important that you use a tuple, and NOT A |
|
1480 | handler. It is very important that you use a tuple, and NOT A | |
1482 | LIST here, because of the way Python's except statement works. If |
|
1481 | LIST here, because of the way Python's except statement works. If | |
1483 | you only want to trap a single exception, use a singleton tuple:: |
|
1482 | you only want to trap a single exception, use a singleton tuple:: | |
1484 |
|
1483 | |||
1485 | exc_tuple == (MyCustomException,) |
|
1484 | exc_tuple == (MyCustomException,) | |
1486 |
|
1485 | |||
1487 | handler : callable |
|
1486 | handler : callable | |
1488 | handler must have the following signature:: |
|
1487 | handler must have the following signature:: | |
1489 |
|
1488 | |||
1490 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1489 | def my_handler(self, etype, value, tb, tb_offset=None): | |
1491 | ... |
|
1490 | ... | |
1492 | return structured_traceback |
|
1491 | return structured_traceback | |
1493 |
|
1492 | |||
1494 | Your handler must return a structured traceback (a list of strings), |
|
1493 | Your handler must return a structured traceback (a list of strings), | |
1495 | or None. |
|
1494 | or None. | |
1496 |
|
1495 | |||
1497 | This will be made into an instance method (via types.MethodType) |
|
1496 | This will be made into an instance method (via types.MethodType) | |
1498 | of IPython itself, and it will be called if any of the exceptions |
|
1497 | of IPython itself, and it will be called if any of the exceptions | |
1499 | listed in the exc_tuple are caught. If the handler is None, an |
|
1498 | listed in the exc_tuple are caught. If the handler is None, an | |
1500 | internal basic one is used, which just prints basic info. |
|
1499 | internal basic one is used, which just prints basic info. | |
1501 |
|
1500 | |||
1502 | To protect IPython from crashes, if your handler ever raises an |
|
1501 | To protect IPython from crashes, if your handler ever raises an | |
1503 | exception or returns an invalid result, it will be immediately |
|
1502 | exception or returns an invalid result, it will be immediately | |
1504 | disabled. |
|
1503 | disabled. | |
1505 |
|
1504 | |||
1506 | WARNING: by putting in your own exception handler into IPython's main |
|
1505 | WARNING: by putting in your own exception handler into IPython's main | |
1507 | execution loop, you run a very good chance of nasty crashes. This |
|
1506 | execution loop, you run a very good chance of nasty crashes. This | |
1508 | facility should only be used if you really know what you are doing.""" |
|
1507 | facility should only be used if you really know what you are doing.""" | |
1509 |
|
1508 | |||
1510 | assert type(exc_tuple)==type(()) , \ |
|
1509 | assert type(exc_tuple)==type(()) , \ | |
1511 | "The custom exceptions must be given AS A TUPLE." |
|
1510 | "The custom exceptions must be given AS A TUPLE." | |
1512 |
|
1511 | |||
1513 | def dummy_handler(self,etype,value,tb,tb_offset=None): |
|
1512 | def dummy_handler(self,etype,value,tb,tb_offset=None): | |
1514 | print '*** Simple custom exception handler ***' |
|
1513 | print '*** Simple custom exception handler ***' | |
1515 | print 'Exception type :',etype |
|
1514 | print 'Exception type :',etype | |
1516 | print 'Exception value:',value |
|
1515 | print 'Exception value:',value | |
1517 | print 'Traceback :',tb |
|
1516 | print 'Traceback :',tb | |
1518 | #print 'Source code :','\n'.join(self.buffer) |
|
1517 | #print 'Source code :','\n'.join(self.buffer) | |
1519 |
|
1518 | |||
1520 | def validate_stb(stb): |
|
1519 | def validate_stb(stb): | |
1521 | """validate structured traceback return type |
|
1520 | """validate structured traceback return type | |
1522 |
|
1521 | |||
1523 | return type of CustomTB *should* be a list of strings, but allow |
|
1522 | return type of CustomTB *should* be a list of strings, but allow | |
1524 | single strings or None, which are harmless. |
|
1523 | single strings or None, which are harmless. | |
1525 |
|
1524 | |||
1526 | This function will *always* return a list of strings, |
|
1525 | This function will *always* return a list of strings, | |
1527 | and will raise a TypeError if stb is inappropriate. |
|
1526 | and will raise a TypeError if stb is inappropriate. | |
1528 | """ |
|
1527 | """ | |
1529 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1528 | msg = "CustomTB must return list of strings, not %r" % stb | |
1530 | if stb is None: |
|
1529 | if stb is None: | |
1531 | return [] |
|
1530 | return [] | |
1532 | elif isinstance(stb, basestring): |
|
1531 | elif isinstance(stb, basestring): | |
1533 | return [stb] |
|
1532 | return [stb] | |
1534 | elif not isinstance(stb, list): |
|
1533 | elif not isinstance(stb, list): | |
1535 | raise TypeError(msg) |
|
1534 | raise TypeError(msg) | |
1536 | # it's a list |
|
1535 | # it's a list | |
1537 | for line in stb: |
|
1536 | for line in stb: | |
1538 | # check every element |
|
1537 | # check every element | |
1539 | if not isinstance(line, basestring): |
|
1538 | if not isinstance(line, basestring): | |
1540 | raise TypeError(msg) |
|
1539 | raise TypeError(msg) | |
1541 | return stb |
|
1540 | return stb | |
1542 |
|
1541 | |||
1543 | if handler is None: |
|
1542 | if handler is None: | |
1544 | wrapped = dummy_handler |
|
1543 | wrapped = dummy_handler | |
1545 | else: |
|
1544 | else: | |
1546 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1545 | def wrapped(self,etype,value,tb,tb_offset=None): | |
1547 | """wrap CustomTB handler, to protect IPython from user code |
|
1546 | """wrap CustomTB handler, to protect IPython from user code | |
1548 |
|
1547 | |||
1549 | This makes it harder (but not impossible) for custom exception |
|
1548 | This makes it harder (but not impossible) for custom exception | |
1550 | handlers to crash IPython. |
|
1549 | handlers to crash IPython. | |
1551 | """ |
|
1550 | """ | |
1552 | try: |
|
1551 | try: | |
1553 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1552 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) | |
1554 | return validate_stb(stb) |
|
1553 | return validate_stb(stb) | |
1555 | except: |
|
1554 | except: | |
1556 | # clear custom handler immediately |
|
1555 | # clear custom handler immediately | |
1557 | self.set_custom_exc((), None) |
|
1556 | self.set_custom_exc((), None) | |
1558 | print >> io.stderr, "Custom TB Handler failed, unregistering" |
|
1557 | print >> io.stderr, "Custom TB Handler failed, unregistering" | |
1559 | # show the exception in handler first |
|
1558 | # show the exception in handler first | |
1560 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1559 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) | |
1561 | print >> io.stdout, self.InteractiveTB.stb2text(stb) |
|
1560 | print >> io.stdout, self.InteractiveTB.stb2text(stb) | |
1562 | print >> io.stdout, "The original exception:" |
|
1561 | print >> io.stdout, "The original exception:" | |
1563 | stb = self.InteractiveTB.structured_traceback( |
|
1562 | stb = self.InteractiveTB.structured_traceback( | |
1564 | (etype,value,tb), tb_offset=tb_offset |
|
1563 | (etype,value,tb), tb_offset=tb_offset | |
1565 | ) |
|
1564 | ) | |
1566 | return stb |
|
1565 | return stb | |
1567 |
|
1566 | |||
1568 | self.CustomTB = types.MethodType(wrapped,self) |
|
1567 | self.CustomTB = types.MethodType(wrapped,self) | |
1569 | self.custom_exceptions = exc_tuple |
|
1568 | self.custom_exceptions = exc_tuple | |
1570 |
|
1569 | |||
1571 | def excepthook(self, etype, value, tb): |
|
1570 | def excepthook(self, etype, value, tb): | |
1572 | """One more defense for GUI apps that call sys.excepthook. |
|
1571 | """One more defense for GUI apps that call sys.excepthook. | |
1573 |
|
1572 | |||
1574 | GUI frameworks like wxPython trap exceptions and call |
|
1573 | GUI frameworks like wxPython trap exceptions and call | |
1575 | sys.excepthook themselves. I guess this is a feature that |
|
1574 | sys.excepthook themselves. I guess this is a feature that | |
1576 | enables them to keep running after exceptions that would |
|
1575 | enables them to keep running after exceptions that would | |
1577 | otherwise kill their mainloop. This is a bother for IPython |
|
1576 | otherwise kill their mainloop. This is a bother for IPython | |
1578 | which excepts to catch all of the program exceptions with a try: |
|
1577 | which excepts to catch all of the program exceptions with a try: | |
1579 | except: statement. |
|
1578 | except: statement. | |
1580 |
|
1579 | |||
1581 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1580 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
1582 | any app directly invokes sys.excepthook, it will look to the user like |
|
1581 | any app directly invokes sys.excepthook, it will look to the user like | |
1583 | IPython crashed. In order to work around this, we can disable the |
|
1582 | IPython crashed. In order to work around this, we can disable the | |
1584 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1583 | CrashHandler and replace it with this excepthook instead, which prints a | |
1585 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1584 | regular traceback using our InteractiveTB. In this fashion, apps which | |
1586 | call sys.excepthook will generate a regular-looking exception from |
|
1585 | call sys.excepthook will generate a regular-looking exception from | |
1587 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1586 | IPython, and the CrashHandler will only be triggered by real IPython | |
1588 | crashes. |
|
1587 | crashes. | |
1589 |
|
1588 | |||
1590 | This hook should be used sparingly, only in places which are not likely |
|
1589 | This hook should be used sparingly, only in places which are not likely | |
1591 | to be true IPython errors. |
|
1590 | to be true IPython errors. | |
1592 | """ |
|
1591 | """ | |
1593 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1592 | self.showtraceback((etype,value,tb),tb_offset=0) | |
1594 |
|
1593 | |||
1595 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, |
|
1594 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, | |
1596 | exception_only=False): |
|
1595 | exception_only=False): | |
1597 | """Display the exception that just occurred. |
|
1596 | """Display the exception that just occurred. | |
1598 |
|
1597 | |||
1599 | If nothing is known about the exception, this is the method which |
|
1598 | If nothing is known about the exception, this is the method which | |
1600 | should be used throughout the code for presenting user tracebacks, |
|
1599 | should be used throughout the code for presenting user tracebacks, | |
1601 | rather than directly invoking the InteractiveTB object. |
|
1600 | rather than directly invoking the InteractiveTB object. | |
1602 |
|
1601 | |||
1603 | A specific showsyntaxerror() also exists, but this method can take |
|
1602 | A specific showsyntaxerror() also exists, but this method can take | |
1604 | care of calling it if needed, so unless you are explicitly catching a |
|
1603 | care of calling it if needed, so unless you are explicitly catching a | |
1605 | SyntaxError exception, don't try to analyze the stack manually and |
|
1604 | SyntaxError exception, don't try to analyze the stack manually and | |
1606 | simply call this method.""" |
|
1605 | simply call this method.""" | |
1607 |
|
1606 | |||
1608 | try: |
|
1607 | try: | |
1609 | if exc_tuple is None: |
|
1608 | if exc_tuple is None: | |
1610 | etype, value, tb = sys.exc_info() |
|
1609 | etype, value, tb = sys.exc_info() | |
1611 | else: |
|
1610 | else: | |
1612 | etype, value, tb = exc_tuple |
|
1611 | etype, value, tb = exc_tuple | |
1613 |
|
1612 | |||
1614 | if etype is None: |
|
1613 | if etype is None: | |
1615 | if hasattr(sys, 'last_type'): |
|
1614 | if hasattr(sys, 'last_type'): | |
1616 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1615 | etype, value, tb = sys.last_type, sys.last_value, \ | |
1617 | sys.last_traceback |
|
1616 | sys.last_traceback | |
1618 | else: |
|
1617 | else: | |
1619 | self.write_err('No traceback available to show.\n') |
|
1618 | self.write_err('No traceback available to show.\n') | |
1620 | return |
|
1619 | return | |
1621 |
|
1620 | |||
1622 | if etype is SyntaxError: |
|
1621 | if etype is SyntaxError: | |
1623 | # Though this won't be called by syntax errors in the input |
|
1622 | # Though this won't be called by syntax errors in the input | |
1624 | # line, there may be SyntaxError cases with imported code. |
|
1623 | # line, there may be SyntaxError cases with imported code. | |
1625 | self.showsyntaxerror(filename) |
|
1624 | self.showsyntaxerror(filename) | |
1626 | elif etype is UsageError: |
|
1625 | elif etype is UsageError: | |
1627 | self.write_err("UsageError: %s" % value) |
|
1626 | self.write_err("UsageError: %s" % value) | |
1628 | else: |
|
1627 | else: | |
1629 | # WARNING: these variables are somewhat deprecated and not |
|
1628 | # WARNING: these variables are somewhat deprecated and not | |
1630 | # necessarily safe to use in a threaded environment, but tools |
|
1629 | # necessarily safe to use in a threaded environment, but tools | |
1631 | # like pdb depend on their existence, so let's set them. If we |
|
1630 | # like pdb depend on their existence, so let's set them. If we | |
1632 | # find problems in the field, we'll need to revisit their use. |
|
1631 | # find problems in the field, we'll need to revisit their use. | |
1633 | sys.last_type = etype |
|
1632 | sys.last_type = etype | |
1634 | sys.last_value = value |
|
1633 | sys.last_value = value | |
1635 | sys.last_traceback = tb |
|
1634 | sys.last_traceback = tb | |
1636 | if etype in self.custom_exceptions: |
|
1635 | if etype in self.custom_exceptions: | |
1637 | stb = self.CustomTB(etype, value, tb, tb_offset) |
|
1636 | stb = self.CustomTB(etype, value, tb, tb_offset) | |
1638 | else: |
|
1637 | else: | |
1639 | if exception_only: |
|
1638 | if exception_only: | |
1640 | stb = ['An exception has occurred, use %tb to see ' |
|
1639 | stb = ['An exception has occurred, use %tb to see ' | |
1641 | 'the full traceback.\n'] |
|
1640 | 'the full traceback.\n'] | |
1642 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
1641 | stb.extend(self.InteractiveTB.get_exception_only(etype, | |
1643 | value)) |
|
1642 | value)) | |
1644 | else: |
|
1643 | else: | |
1645 | stb = self.InteractiveTB.structured_traceback(etype, |
|
1644 | stb = self.InteractiveTB.structured_traceback(etype, | |
1646 | value, tb, tb_offset=tb_offset) |
|
1645 | value, tb, tb_offset=tb_offset) | |
1647 |
|
1646 | |||
1648 | self._showtraceback(etype, value, stb) |
|
1647 | self._showtraceback(etype, value, stb) | |
1649 | if self.call_pdb: |
|
1648 | if self.call_pdb: | |
1650 | # drop into debugger |
|
1649 | # drop into debugger | |
1651 | self.debugger(force=True) |
|
1650 | self.debugger(force=True) | |
1652 | return |
|
1651 | return | |
1653 |
|
1652 | |||
1654 | # Actually show the traceback |
|
1653 | # Actually show the traceback | |
1655 | self._showtraceback(etype, value, stb) |
|
1654 | self._showtraceback(etype, value, stb) | |
1656 |
|
1655 | |||
1657 | except KeyboardInterrupt: |
|
1656 | except KeyboardInterrupt: | |
1658 | self.write_err("\nKeyboardInterrupt\n") |
|
1657 | self.write_err("\nKeyboardInterrupt\n") | |
1659 |
|
1658 | |||
1660 | def _showtraceback(self, etype, evalue, stb): |
|
1659 | def _showtraceback(self, etype, evalue, stb): | |
1661 | """Actually show a traceback. |
|
1660 | """Actually show a traceback. | |
1662 |
|
1661 | |||
1663 | Subclasses may override this method to put the traceback on a different |
|
1662 | Subclasses may override this method to put the traceback on a different | |
1664 | place, like a side channel. |
|
1663 | place, like a side channel. | |
1665 | """ |
|
1664 | """ | |
1666 | print >> io.stdout, self.InteractiveTB.stb2text(stb) |
|
1665 | print >> io.stdout, self.InteractiveTB.stb2text(stb) | |
1667 |
|
1666 | |||
1668 | def showsyntaxerror(self, filename=None): |
|
1667 | def showsyntaxerror(self, filename=None): | |
1669 | """Display the syntax error that just occurred. |
|
1668 | """Display the syntax error that just occurred. | |
1670 |
|
1669 | |||
1671 | This doesn't display a stack trace because there isn't one. |
|
1670 | This doesn't display a stack trace because there isn't one. | |
1672 |
|
1671 | |||
1673 | If a filename is given, it is stuffed in the exception instead |
|
1672 | If a filename is given, it is stuffed in the exception instead | |
1674 | of what was there before (because Python's parser always uses |
|
1673 | of what was there before (because Python's parser always uses | |
1675 | "<string>" when reading from a string). |
|
1674 | "<string>" when reading from a string). | |
1676 | """ |
|
1675 | """ | |
1677 | etype, value, last_traceback = sys.exc_info() |
|
1676 | etype, value, last_traceback = sys.exc_info() | |
1678 |
|
1677 | |||
1679 | # See note about these variables in showtraceback() above |
|
1678 | # See note about these variables in showtraceback() above | |
1680 | sys.last_type = etype |
|
1679 | sys.last_type = etype | |
1681 | sys.last_value = value |
|
1680 | sys.last_value = value | |
1682 | sys.last_traceback = last_traceback |
|
1681 | sys.last_traceback = last_traceback | |
1683 |
|
1682 | |||
1684 | if filename and etype is SyntaxError: |
|
1683 | if filename and etype is SyntaxError: | |
1685 | # Work hard to stuff the correct filename in the exception |
|
1684 | # Work hard to stuff the correct filename in the exception | |
1686 | try: |
|
1685 | try: | |
1687 | msg, (dummy_filename, lineno, offset, line) = value |
|
1686 | msg, (dummy_filename, lineno, offset, line) = value | |
1688 | except: |
|
1687 | except: | |
1689 | # Not the format we expect; leave it alone |
|
1688 | # Not the format we expect; leave it alone | |
1690 | pass |
|
1689 | pass | |
1691 | else: |
|
1690 | else: | |
1692 | # Stuff in the right filename |
|
1691 | # Stuff in the right filename | |
1693 | try: |
|
1692 | try: | |
1694 | # Assume SyntaxError is a class exception |
|
1693 | # Assume SyntaxError is a class exception | |
1695 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1694 | value = SyntaxError(msg, (filename, lineno, offset, line)) | |
1696 | except: |
|
1695 | except: | |
1697 | # If that failed, assume SyntaxError is a string |
|
1696 | # If that failed, assume SyntaxError is a string | |
1698 | value = msg, (filename, lineno, offset, line) |
|
1697 | value = msg, (filename, lineno, offset, line) | |
1699 | stb = self.SyntaxTB.structured_traceback(etype, value, []) |
|
1698 | stb = self.SyntaxTB.structured_traceback(etype, value, []) | |
1700 | self._showtraceback(etype, value, stb) |
|
1699 | self._showtraceback(etype, value, stb) | |
1701 |
|
1700 | |||
1702 | # This is overridden in TerminalInteractiveShell to show a message about |
|
1701 | # This is overridden in TerminalInteractiveShell to show a message about | |
1703 | # the %paste magic. |
|
1702 | # the %paste magic. | |
1704 | def showindentationerror(self): |
|
1703 | def showindentationerror(self): | |
1705 | """Called by run_cell when there's an IndentationError in code entered |
|
1704 | """Called by run_cell when there's an IndentationError in code entered | |
1706 | at the prompt. |
|
1705 | at the prompt. | |
1707 |
|
1706 | |||
1708 | This is overridden in TerminalInteractiveShell to show a message about |
|
1707 | This is overridden in TerminalInteractiveShell to show a message about | |
1709 | the %paste magic.""" |
|
1708 | the %paste magic.""" | |
1710 | self.showsyntaxerror() |
|
1709 | self.showsyntaxerror() | |
1711 |
|
1710 | |||
1712 | #------------------------------------------------------------------------- |
|
1711 | #------------------------------------------------------------------------- | |
1713 | # Things related to readline |
|
1712 | # Things related to readline | |
1714 | #------------------------------------------------------------------------- |
|
1713 | #------------------------------------------------------------------------- | |
1715 |
|
1714 | |||
1716 | def init_readline(self): |
|
1715 | def init_readline(self): | |
1717 | """Command history completion/saving/reloading.""" |
|
1716 | """Command history completion/saving/reloading.""" | |
1718 |
|
1717 | |||
1719 | if self.readline_use: |
|
1718 | if self.readline_use: | |
1720 | import IPython.utils.rlineimpl as readline |
|
1719 | import IPython.utils.rlineimpl as readline | |
1721 |
|
1720 | |||
1722 | self.rl_next_input = None |
|
1721 | self.rl_next_input = None | |
1723 | self.rl_do_indent = False |
|
1722 | self.rl_do_indent = False | |
1724 |
|
1723 | |||
1725 | if not self.readline_use or not readline.have_readline: |
|
1724 | if not self.readline_use or not readline.have_readline: | |
1726 | self.has_readline = False |
|
1725 | self.has_readline = False | |
1727 | self.readline = None |
|
1726 | self.readline = None | |
1728 | # Set a number of methods that depend on readline to be no-op |
|
1727 | # Set a number of methods that depend on readline to be no-op | |
1729 | self.readline_no_record = no_op_context |
|
1728 | self.readline_no_record = no_op_context | |
1730 | self.set_readline_completer = no_op |
|
1729 | self.set_readline_completer = no_op | |
1731 | self.set_custom_completer = no_op |
|
1730 | self.set_custom_completer = no_op | |
1732 | self.set_completer_frame = no_op |
|
1731 | self.set_completer_frame = no_op | |
1733 | if self.readline_use: |
|
1732 | if self.readline_use: | |
1734 | warn('Readline services not available or not loaded.') |
|
1733 | warn('Readline services not available or not loaded.') | |
1735 | else: |
|
1734 | else: | |
1736 | self.has_readline = True |
|
1735 | self.has_readline = True | |
1737 | self.readline = readline |
|
1736 | self.readline = readline | |
1738 | sys.modules['readline'] = readline |
|
1737 | sys.modules['readline'] = readline | |
1739 |
|
1738 | |||
1740 | # Platform-specific configuration |
|
1739 | # Platform-specific configuration | |
1741 | if os.name == 'nt': |
|
1740 | if os.name == 'nt': | |
1742 | # FIXME - check with Frederick to see if we can harmonize |
|
1741 | # FIXME - check with Frederick to see if we can harmonize | |
1743 | # naming conventions with pyreadline to avoid this |
|
1742 | # naming conventions with pyreadline to avoid this | |
1744 | # platform-dependent check |
|
1743 | # platform-dependent check | |
1745 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1744 | self.readline_startup_hook = readline.set_pre_input_hook | |
1746 | else: |
|
1745 | else: | |
1747 | self.readline_startup_hook = readline.set_startup_hook |
|
1746 | self.readline_startup_hook = readline.set_startup_hook | |
1748 |
|
1747 | |||
1749 | # Load user's initrc file (readline config) |
|
1748 | # Load user's initrc file (readline config) | |
1750 | # Or if libedit is used, load editrc. |
|
1749 | # Or if libedit is used, load editrc. | |
1751 | inputrc_name = os.environ.get('INPUTRC') |
|
1750 | inputrc_name = os.environ.get('INPUTRC') | |
1752 | if inputrc_name is None: |
|
1751 | if inputrc_name is None: | |
1753 | inputrc_name = '.inputrc' |
|
1752 | inputrc_name = '.inputrc' | |
1754 | if readline.uses_libedit: |
|
1753 | if readline.uses_libedit: | |
1755 | inputrc_name = '.editrc' |
|
1754 | inputrc_name = '.editrc' | |
1756 | inputrc_name = os.path.join(self.home_dir, inputrc_name) |
|
1755 | inputrc_name = os.path.join(self.home_dir, inputrc_name) | |
1757 | if os.path.isfile(inputrc_name): |
|
1756 | if os.path.isfile(inputrc_name): | |
1758 | try: |
|
1757 | try: | |
1759 | readline.read_init_file(inputrc_name) |
|
1758 | readline.read_init_file(inputrc_name) | |
1760 | except: |
|
1759 | except: | |
1761 | warn('Problems reading readline initialization file <%s>' |
|
1760 | warn('Problems reading readline initialization file <%s>' | |
1762 | % inputrc_name) |
|
1761 | % inputrc_name) | |
1763 |
|
1762 | |||
1764 | # Configure readline according to user's prefs |
|
1763 | # Configure readline according to user's prefs | |
1765 | # This is only done if GNU readline is being used. If libedit |
|
1764 | # This is only done if GNU readline is being used. If libedit | |
1766 | # is being used (as on Leopard) the readline config is |
|
1765 | # is being used (as on Leopard) the readline config is | |
1767 | # not run as the syntax for libedit is different. |
|
1766 | # not run as the syntax for libedit is different. | |
1768 | if not readline.uses_libedit: |
|
1767 | if not readline.uses_libedit: | |
1769 | for rlcommand in self.readline_parse_and_bind: |
|
1768 | for rlcommand in self.readline_parse_and_bind: | |
1770 | #print "loading rl:",rlcommand # dbg |
|
1769 | #print "loading rl:",rlcommand # dbg | |
1771 | readline.parse_and_bind(rlcommand) |
|
1770 | readline.parse_and_bind(rlcommand) | |
1772 |
|
1771 | |||
1773 | # Remove some chars from the delimiters list. If we encounter |
|
1772 | # Remove some chars from the delimiters list. If we encounter | |
1774 | # unicode chars, discard them. |
|
1773 | # unicode chars, discard them. | |
1775 | delims = readline.get_completer_delims() |
|
1774 | delims = readline.get_completer_delims() | |
1776 | if not py3compat.PY3: |
|
1775 | if not py3compat.PY3: | |
1777 | delims = delims.encode("ascii", "ignore") |
|
1776 | delims = delims.encode("ascii", "ignore") | |
1778 | for d in self.readline_remove_delims: |
|
1777 | for d in self.readline_remove_delims: | |
1779 | delims = delims.replace(d, "") |
|
1778 | delims = delims.replace(d, "") | |
1780 | delims = delims.replace(ESC_MAGIC, '') |
|
1779 | delims = delims.replace(ESC_MAGIC, '') | |
1781 | readline.set_completer_delims(delims) |
|
1780 | readline.set_completer_delims(delims) | |
1782 | # otherwise we end up with a monster history after a while: |
|
1781 | # otherwise we end up with a monster history after a while: | |
1783 | readline.set_history_length(self.history_length) |
|
1782 | readline.set_history_length(self.history_length) | |
1784 |
|
1783 | |||
1785 | self.refill_readline_hist() |
|
1784 | self.refill_readline_hist() | |
1786 | self.readline_no_record = ReadlineNoRecord(self) |
|
1785 | self.readline_no_record = ReadlineNoRecord(self) | |
1787 |
|
1786 | |||
1788 | # Configure auto-indent for all platforms |
|
1787 | # Configure auto-indent for all platforms | |
1789 | self.set_autoindent(self.autoindent) |
|
1788 | self.set_autoindent(self.autoindent) | |
1790 |
|
1789 | |||
1791 | def refill_readline_hist(self): |
|
1790 | def refill_readline_hist(self): | |
1792 | # Load the last 1000 lines from history |
|
1791 | # Load the last 1000 lines from history | |
1793 | self.readline.clear_history() |
|
1792 | self.readline.clear_history() | |
1794 | stdin_encoding = sys.stdin.encoding or "utf-8" |
|
1793 | stdin_encoding = sys.stdin.encoding or "utf-8" | |
1795 | last_cell = u"" |
|
1794 | last_cell = u"" | |
1796 | for _, _, cell in self.history_manager.get_tail(1000, |
|
1795 | for _, _, cell in self.history_manager.get_tail(1000, | |
1797 | include_latest=True): |
|
1796 | include_latest=True): | |
1798 | # Ignore blank lines and consecutive duplicates |
|
1797 | # Ignore blank lines and consecutive duplicates | |
1799 | cell = cell.rstrip() |
|
1798 | cell = cell.rstrip() | |
1800 | if cell and (cell != last_cell): |
|
1799 | if cell and (cell != last_cell): | |
1801 | if self.multiline_history: |
|
1800 | if self.multiline_history: | |
1802 | self.readline.add_history(py3compat.unicode_to_str(cell, |
|
1801 | self.readline.add_history(py3compat.unicode_to_str(cell, | |
1803 | stdin_encoding)) |
|
1802 | stdin_encoding)) | |
1804 | else: |
|
1803 | else: | |
1805 | for line in cell.splitlines(): |
|
1804 | for line in cell.splitlines(): | |
1806 | self.readline.add_history(py3compat.unicode_to_str(line, |
|
1805 | self.readline.add_history(py3compat.unicode_to_str(line, | |
1807 | stdin_encoding)) |
|
1806 | stdin_encoding)) | |
1808 | last_cell = cell |
|
1807 | last_cell = cell | |
1809 |
|
1808 | |||
1810 | def set_next_input(self, s): |
|
1809 | def set_next_input(self, s): | |
1811 | """ Sets the 'default' input string for the next command line. |
|
1810 | """ Sets the 'default' input string for the next command line. | |
1812 |
|
1811 | |||
1813 | Requires readline. |
|
1812 | Requires readline. | |
1814 |
|
1813 | |||
1815 | Example: |
|
1814 | Example: | |
1816 |
|
1815 | |||
1817 | [D:\ipython]|1> _ip.set_next_input("Hello Word") |
|
1816 | [D:\ipython]|1> _ip.set_next_input("Hello Word") | |
1818 | [D:\ipython]|2> Hello Word_ # cursor is here |
|
1817 | [D:\ipython]|2> Hello Word_ # cursor is here | |
1819 | """ |
|
1818 | """ | |
1820 | self.rl_next_input = py3compat.cast_bytes_py2(s) |
|
1819 | self.rl_next_input = py3compat.cast_bytes_py2(s) | |
1821 |
|
1820 | |||
1822 | # Maybe move this to the terminal subclass? |
|
1821 | # Maybe move this to the terminal subclass? | |
1823 | def pre_readline(self): |
|
1822 | def pre_readline(self): | |
1824 | """readline hook to be used at the start of each line. |
|
1823 | """readline hook to be used at the start of each line. | |
1825 |
|
1824 | |||
1826 | Currently it handles auto-indent only.""" |
|
1825 | Currently it handles auto-indent only.""" | |
1827 |
|
1826 | |||
1828 | if self.rl_do_indent: |
|
1827 | if self.rl_do_indent: | |
1829 | self.readline.insert_text(self._indent_current_str()) |
|
1828 | self.readline.insert_text(self._indent_current_str()) | |
1830 | if self.rl_next_input is not None: |
|
1829 | if self.rl_next_input is not None: | |
1831 | self.readline.insert_text(self.rl_next_input) |
|
1830 | self.readline.insert_text(self.rl_next_input) | |
1832 | self.rl_next_input = None |
|
1831 | self.rl_next_input = None | |
1833 |
|
1832 | |||
1834 | def _indent_current_str(self): |
|
1833 | def _indent_current_str(self): | |
1835 | """return the current level of indentation as a string""" |
|
1834 | """return the current level of indentation as a string""" | |
1836 | return self.input_splitter.indent_spaces * ' ' |
|
1835 | return self.input_splitter.indent_spaces * ' ' | |
1837 |
|
1836 | |||
1838 | #------------------------------------------------------------------------- |
|
1837 | #------------------------------------------------------------------------- | |
1839 | # Things related to text completion |
|
1838 | # Things related to text completion | |
1840 | #------------------------------------------------------------------------- |
|
1839 | #------------------------------------------------------------------------- | |
1841 |
|
1840 | |||
1842 | def init_completer(self): |
|
1841 | def init_completer(self): | |
1843 | """Initialize the completion machinery. |
|
1842 | """Initialize the completion machinery. | |
1844 |
|
1843 | |||
1845 | This creates completion machinery that can be used by client code, |
|
1844 | This creates completion machinery that can be used by client code, | |
1846 | either interactively in-process (typically triggered by the readline |
|
1845 | either interactively in-process (typically triggered by the readline | |
1847 | library), programatically (such as in test suites) or out-of-prcess |
|
1846 | library), programatically (such as in test suites) or out-of-prcess | |
1848 | (typically over the network by remote frontends). |
|
1847 | (typically over the network by remote frontends). | |
1849 | """ |
|
1848 | """ | |
1850 | from IPython.core.completer import IPCompleter |
|
1849 | from IPython.core.completer import IPCompleter | |
1851 | from IPython.core.completerlib import (module_completer, |
|
1850 | from IPython.core.completerlib import (module_completer, | |
1852 | magic_run_completer, cd_completer) |
|
1851 | magic_run_completer, cd_completer) | |
1853 |
|
1852 | |||
1854 | self.Completer = IPCompleter(shell=self, |
|
1853 | self.Completer = IPCompleter(shell=self, | |
1855 | namespace=self.user_ns, |
|
1854 | namespace=self.user_ns, | |
1856 | global_namespace=self.user_global_ns, |
|
1855 | global_namespace=self.user_global_ns, | |
1857 | alias_table=self.alias_manager.alias_table, |
|
1856 | alias_table=self.alias_manager.alias_table, | |
1858 | use_readline=self.has_readline, |
|
1857 | use_readline=self.has_readline, | |
1859 | config=self.config, |
|
1858 | config=self.config, | |
1860 | ) |
|
1859 | ) | |
1861 | self.configurables.append(self.Completer) |
|
1860 | self.configurables.append(self.Completer) | |
1862 |
|
1861 | |||
1863 | # Add custom completers to the basic ones built into IPCompleter |
|
1862 | # Add custom completers to the basic ones built into IPCompleter | |
1864 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1863 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
1865 | self.strdispatchers['complete_command'] = sdisp |
|
1864 | self.strdispatchers['complete_command'] = sdisp | |
1866 | self.Completer.custom_completers = sdisp |
|
1865 | self.Completer.custom_completers = sdisp | |
1867 |
|
1866 | |||
1868 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
1867 | self.set_hook('complete_command', module_completer, str_key = 'import') | |
1869 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
1868 | self.set_hook('complete_command', module_completer, str_key = 'from') | |
1870 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
1869 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') | |
1871 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
1870 | self.set_hook('complete_command', cd_completer, str_key = '%cd') | |
1872 |
|
1871 | |||
1873 | # Only configure readline if we truly are using readline. IPython can |
|
1872 | # Only configure readline if we truly are using readline. IPython can | |
1874 | # do tab-completion over the network, in GUIs, etc, where readline |
|
1873 | # do tab-completion over the network, in GUIs, etc, where readline | |
1875 | # itself may be absent |
|
1874 | # itself may be absent | |
1876 | if self.has_readline: |
|
1875 | if self.has_readline: | |
1877 | self.set_readline_completer() |
|
1876 | self.set_readline_completer() | |
1878 |
|
1877 | |||
1879 | def complete(self, text, line=None, cursor_pos=None): |
|
1878 | def complete(self, text, line=None, cursor_pos=None): | |
1880 | """Return the completed text and a list of completions. |
|
1879 | """Return the completed text and a list of completions. | |
1881 |
|
1880 | |||
1882 | Parameters |
|
1881 | Parameters | |
1883 | ---------- |
|
1882 | ---------- | |
1884 |
|
1883 | |||
1885 | text : string |
|
1884 | text : string | |
1886 | A string of text to be completed on. It can be given as empty and |
|
1885 | A string of text to be completed on. It can be given as empty and | |
1887 | instead a line/position pair are given. In this case, the |
|
1886 | instead a line/position pair are given. In this case, the | |
1888 | completer itself will split the line like readline does. |
|
1887 | completer itself will split the line like readline does. | |
1889 |
|
1888 | |||
1890 | line : string, optional |
|
1889 | line : string, optional | |
1891 | The complete line that text is part of. |
|
1890 | The complete line that text is part of. | |
1892 |
|
1891 | |||
1893 | cursor_pos : int, optional |
|
1892 | cursor_pos : int, optional | |
1894 | The position of the cursor on the input line. |
|
1893 | The position of the cursor on the input line. | |
1895 |
|
1894 | |||
1896 | Returns |
|
1895 | Returns | |
1897 | ------- |
|
1896 | ------- | |
1898 | text : string |
|
1897 | text : string | |
1899 | The actual text that was completed. |
|
1898 | The actual text that was completed. | |
1900 |
|
1899 | |||
1901 | matches : list |
|
1900 | matches : list | |
1902 | A sorted list with all possible completions. |
|
1901 | A sorted list with all possible completions. | |
1903 |
|
1902 | |||
1904 | The optional arguments allow the completion to take more context into |
|
1903 | The optional arguments allow the completion to take more context into | |
1905 | account, and are part of the low-level completion API. |
|
1904 | account, and are part of the low-level completion API. | |
1906 |
|
1905 | |||
1907 | This is a wrapper around the completion mechanism, similar to what |
|
1906 | This is a wrapper around the completion mechanism, similar to what | |
1908 | readline does at the command line when the TAB key is hit. By |
|
1907 | readline does at the command line when the TAB key is hit. By | |
1909 | exposing it as a method, it can be used by other non-readline |
|
1908 | exposing it as a method, it can be used by other non-readline | |
1910 | environments (such as GUIs) for text completion. |
|
1909 | environments (such as GUIs) for text completion. | |
1911 |
|
1910 | |||
1912 | Simple usage example: |
|
1911 | Simple usage example: | |
1913 |
|
1912 | |||
1914 | In [1]: x = 'hello' |
|
1913 | In [1]: x = 'hello' | |
1915 |
|
1914 | |||
1916 | In [2]: _ip.complete('x.l') |
|
1915 | In [2]: _ip.complete('x.l') | |
1917 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
1916 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) | |
1918 | """ |
|
1917 | """ | |
1919 |
|
1918 | |||
1920 | # Inject names into __builtin__ so we can complete on the added names. |
|
1919 | # Inject names into __builtin__ so we can complete on the added names. | |
1921 | with self.builtin_trap: |
|
1920 | with self.builtin_trap: | |
1922 | return self.Completer.complete(text, line, cursor_pos) |
|
1921 | return self.Completer.complete(text, line, cursor_pos) | |
1923 |
|
1922 | |||
1924 | def set_custom_completer(self, completer, pos=0): |
|
1923 | def set_custom_completer(self, completer, pos=0): | |
1925 | """Adds a new custom completer function. |
|
1924 | """Adds a new custom completer function. | |
1926 |
|
1925 | |||
1927 | The position argument (defaults to 0) is the index in the completers |
|
1926 | The position argument (defaults to 0) is the index in the completers | |
1928 | list where you want the completer to be inserted.""" |
|
1927 | list where you want the completer to be inserted.""" | |
1929 |
|
1928 | |||
1930 | newcomp = types.MethodType(completer,self.Completer) |
|
1929 | newcomp = types.MethodType(completer,self.Completer) | |
1931 | self.Completer.matchers.insert(pos,newcomp) |
|
1930 | self.Completer.matchers.insert(pos,newcomp) | |
1932 |
|
1931 | |||
1933 | def set_readline_completer(self): |
|
1932 | def set_readline_completer(self): | |
1934 | """Reset readline's completer to be our own.""" |
|
1933 | """Reset readline's completer to be our own.""" | |
1935 | self.readline.set_completer(self.Completer.rlcomplete) |
|
1934 | self.readline.set_completer(self.Completer.rlcomplete) | |
1936 |
|
1935 | |||
1937 | def set_completer_frame(self, frame=None): |
|
1936 | def set_completer_frame(self, frame=None): | |
1938 | """Set the frame of the completer.""" |
|
1937 | """Set the frame of the completer.""" | |
1939 | if frame: |
|
1938 | if frame: | |
1940 | self.Completer.namespace = frame.f_locals |
|
1939 | self.Completer.namespace = frame.f_locals | |
1941 | self.Completer.global_namespace = frame.f_globals |
|
1940 | self.Completer.global_namespace = frame.f_globals | |
1942 | else: |
|
1941 | else: | |
1943 | self.Completer.namespace = self.user_ns |
|
1942 | self.Completer.namespace = self.user_ns | |
1944 | self.Completer.global_namespace = self.user_global_ns |
|
1943 | self.Completer.global_namespace = self.user_global_ns | |
1945 |
|
1944 | |||
1946 | #------------------------------------------------------------------------- |
|
1945 | #------------------------------------------------------------------------- | |
1947 | # Things related to magics |
|
1946 | # Things related to magics | |
1948 | #------------------------------------------------------------------------- |
|
1947 | #------------------------------------------------------------------------- | |
1949 |
|
1948 | |||
1950 | def init_magics(self): |
|
1949 | def init_magics(self): | |
1951 | # FIXME: Move the color initialization to the DisplayHook, which |
|
1950 | # FIXME: Move the color initialization to the DisplayHook, which | |
1952 | # should be split into a prompt manager and displayhook. We probably |
|
1951 | # should be split into a prompt manager and displayhook. We probably | |
1953 | # even need a centralize colors management object. |
|
1952 | # even need a centralize colors management object. | |
1954 | self.magic_colors(self.colors) |
|
1953 | self.magic_colors(self.colors) | |
1955 | # History was moved to a separate module |
|
1954 | # History was moved to a separate module | |
1956 | from IPython.core import history |
|
1955 | from IPython.core import history | |
1957 | history.init_ipython(self) |
|
1956 | history.init_ipython(self) | |
1958 |
|
1957 | |||
1959 | def magic(self, arg_s, next_input=None): |
|
1958 | def magic(self, arg_s, next_input=None): | |
1960 | """Call a magic function by name. |
|
1959 | """Call a magic function by name. | |
1961 |
|
1960 | |||
1962 | Input: a string containing the name of the magic function to call and |
|
1961 | Input: a string containing the name of the magic function to call and | |
1963 | any additional arguments to be passed to the magic. |
|
1962 | any additional arguments to be passed to the magic. | |
1964 |
|
1963 | |||
1965 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
1964 | magic('name -opt foo bar') is equivalent to typing at the ipython | |
1966 | prompt: |
|
1965 | prompt: | |
1967 |
|
1966 | |||
1968 | In[1]: %name -opt foo bar |
|
1967 | In[1]: %name -opt foo bar | |
1969 |
|
1968 | |||
1970 | To call a magic without arguments, simply use magic('name'). |
|
1969 | To call a magic without arguments, simply use magic('name'). | |
1971 |
|
1970 | |||
1972 | This provides a proper Python function to call IPython's magics in any |
|
1971 | This provides a proper Python function to call IPython's magics in any | |
1973 | valid Python code you can type at the interpreter, including loops and |
|
1972 | valid Python code you can type at the interpreter, including loops and | |
1974 | compound statements. |
|
1973 | compound statements. | |
1975 | """ |
|
1974 | """ | |
1976 | # Allow setting the next input - this is used if the user does `a=abs?`. |
|
1975 | # Allow setting the next input - this is used if the user does `a=abs?`. | |
1977 | # We do this first so that magic functions can override it. |
|
1976 | # We do this first so that magic functions can override it. | |
1978 | if next_input: |
|
1977 | if next_input: | |
1979 | self.set_next_input(next_input) |
|
1978 | self.set_next_input(next_input) | |
1980 |
|
1979 | |||
1981 | args = arg_s.split(' ',1) |
|
1980 | args = arg_s.split(' ',1) | |
1982 | magic_name = args[0] |
|
1981 | magic_name = args[0] | |
1983 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
1982 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) | |
1984 |
|
1983 | |||
1985 | try: |
|
1984 | try: | |
1986 | magic_args = args[1] |
|
1985 | magic_args = args[1] | |
1987 | except IndexError: |
|
1986 | except IndexError: | |
1988 | magic_args = '' |
|
1987 | magic_args = '' | |
1989 | fn = getattr(self,'magic_'+magic_name,None) |
|
1988 | fn = getattr(self,'magic_'+magic_name,None) | |
1990 | if fn is None: |
|
1989 | if fn is None: | |
1991 | error("Magic function `%s` not found." % magic_name) |
|
1990 | error("Magic function `%s` not found." % magic_name) | |
1992 | else: |
|
1991 | else: | |
1993 | magic_args = self.var_expand(magic_args,1) |
|
1992 | magic_args = self.var_expand(magic_args,1) | |
1994 | # Grab local namespace if we need it: |
|
1993 | # Grab local namespace if we need it: | |
1995 | if getattr(fn, "needs_local_scope", False): |
|
1994 | if getattr(fn, "needs_local_scope", False): | |
1996 | self._magic_locals = sys._getframe(1).f_locals |
|
1995 | self._magic_locals = sys._getframe(1).f_locals | |
1997 | with self.builtin_trap: |
|
1996 | with self.builtin_trap: | |
1998 | result = fn(magic_args) |
|
1997 | result = fn(magic_args) | |
1999 | # Ensure we're not keeping object references around: |
|
1998 | # Ensure we're not keeping object references around: | |
2000 | self._magic_locals = {} |
|
1999 | self._magic_locals = {} | |
2001 | return result |
|
2000 | return result | |
2002 |
|
2001 | |||
2003 | def define_magic(self, magicname, func): |
|
2002 | def define_magic(self, magicname, func): | |
2004 | """Expose own function as magic function for ipython |
|
2003 | """Expose own function as magic function for ipython | |
2005 |
|
2004 | |||
2006 | Example:: |
|
2005 | Example:: | |
2007 |
|
2006 | |||
2008 | def foo_impl(self,parameter_s=''): |
|
2007 | def foo_impl(self,parameter_s=''): | |
2009 | 'My very own magic!. (Use docstrings, IPython reads them).' |
|
2008 | 'My very own magic!. (Use docstrings, IPython reads them).' | |
2010 | print 'Magic function. Passed parameter is between < >:' |
|
2009 | print 'Magic function. Passed parameter is between < >:' | |
2011 | print '<%s>' % parameter_s |
|
2010 | print '<%s>' % parameter_s | |
2012 | print 'The self object is:', self |
|
2011 | print 'The self object is:', self | |
2013 |
|
2012 | |||
2014 | ip.define_magic('foo',foo_impl) |
|
2013 | ip.define_magic('foo',foo_impl) | |
2015 | """ |
|
2014 | """ | |
2016 | im = types.MethodType(func,self) |
|
2015 | im = types.MethodType(func,self) | |
2017 | old = getattr(self, "magic_" + magicname, None) |
|
2016 | old = getattr(self, "magic_" + magicname, None) | |
2018 | setattr(self, "magic_" + magicname, im) |
|
2017 | setattr(self, "magic_" + magicname, im) | |
2019 | return old |
|
2018 | return old | |
2020 |
|
2019 | |||
2021 | #------------------------------------------------------------------------- |
|
2020 | #------------------------------------------------------------------------- | |
2022 | # Things related to macros |
|
2021 | # Things related to macros | |
2023 | #------------------------------------------------------------------------- |
|
2022 | #------------------------------------------------------------------------- | |
2024 |
|
2023 | |||
2025 | def define_macro(self, name, themacro): |
|
2024 | def define_macro(self, name, themacro): | |
2026 | """Define a new macro |
|
2025 | """Define a new macro | |
2027 |
|
2026 | |||
2028 | Parameters |
|
2027 | Parameters | |
2029 | ---------- |
|
2028 | ---------- | |
2030 | name : str |
|
2029 | name : str | |
2031 | The name of the macro. |
|
2030 | The name of the macro. | |
2032 | themacro : str or Macro |
|
2031 | themacro : str or Macro | |
2033 | The action to do upon invoking the macro. If a string, a new |
|
2032 | The action to do upon invoking the macro. If a string, a new | |
2034 | Macro object is created by passing the string to it. |
|
2033 | Macro object is created by passing the string to it. | |
2035 | """ |
|
2034 | """ | |
2036 |
|
2035 | |||
2037 | from IPython.core import macro |
|
2036 | from IPython.core import macro | |
2038 |
|
2037 | |||
2039 | if isinstance(themacro, basestring): |
|
2038 | if isinstance(themacro, basestring): | |
2040 | themacro = macro.Macro(themacro) |
|
2039 | themacro = macro.Macro(themacro) | |
2041 | if not isinstance(themacro, macro.Macro): |
|
2040 | if not isinstance(themacro, macro.Macro): | |
2042 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2041 | raise ValueError('A macro must be a string or a Macro instance.') | |
2043 | self.user_ns[name] = themacro |
|
2042 | self.user_ns[name] = themacro | |
2044 |
|
2043 | |||
2045 | #------------------------------------------------------------------------- |
|
2044 | #------------------------------------------------------------------------- | |
2046 | # Things related to the running of system commands |
|
2045 | # Things related to the running of system commands | |
2047 | #------------------------------------------------------------------------- |
|
2046 | #------------------------------------------------------------------------- | |
2048 |
|
2047 | |||
2049 | def system_piped(self, cmd): |
|
2048 | def system_piped(self, cmd): | |
2050 | """Call the given cmd in a subprocess, piping stdout/err |
|
2049 | """Call the given cmd in a subprocess, piping stdout/err | |
2051 |
|
2050 | |||
2052 | Parameters |
|
2051 | Parameters | |
2053 | ---------- |
|
2052 | ---------- | |
2054 | cmd : str |
|
2053 | cmd : str | |
2055 | Command to execute (can not end in '&', as background processes are |
|
2054 | Command to execute (can not end in '&', as background processes are | |
2056 | not supported. Should not be a command that expects input |
|
2055 | not supported. Should not be a command that expects input | |
2057 | other than simple text. |
|
2056 | other than simple text. | |
2058 | """ |
|
2057 | """ | |
2059 | if cmd.rstrip().endswith('&'): |
|
2058 | if cmd.rstrip().endswith('&'): | |
2060 | # this is *far* from a rigorous test |
|
2059 | # this is *far* from a rigorous test | |
2061 | # We do not support backgrounding processes because we either use |
|
2060 | # We do not support backgrounding processes because we either use | |
2062 | # pexpect or pipes to read from. Users can always just call |
|
2061 | # pexpect or pipes to read from. Users can always just call | |
2063 | # os.system() or use ip.system=ip.system_raw |
|
2062 | # os.system() or use ip.system=ip.system_raw | |
2064 | # if they really want a background process. |
|
2063 | # if they really want a background process. | |
2065 | raise OSError("Background processes not supported.") |
|
2064 | raise OSError("Background processes not supported.") | |
2066 |
|
2065 | |||
2067 | # we explicitly do NOT return the subprocess status code, because |
|
2066 | # we explicitly do NOT return the subprocess status code, because | |
2068 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2067 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2069 | # Instead, we store the exit_code in user_ns. |
|
2068 | # Instead, we store the exit_code in user_ns. | |
2070 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2)) |
|
2069 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2)) | |
2071 |
|
2070 | |||
2072 | def system_raw(self, cmd): |
|
2071 | def system_raw(self, cmd): | |
2073 | """Call the given cmd in a subprocess using os.system |
|
2072 | """Call the given cmd in a subprocess using os.system | |
2074 |
|
2073 | |||
2075 | Parameters |
|
2074 | Parameters | |
2076 | ---------- |
|
2075 | ---------- | |
2077 | cmd : str |
|
2076 | cmd : str | |
2078 | Command to execute. |
|
2077 | Command to execute. | |
2079 | """ |
|
2078 | """ | |
2080 | cmd = self.var_expand(cmd, depth=2) |
|
2079 | cmd = self.var_expand(cmd, depth=2) | |
2081 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2080 | # protect os.system from UNC paths on Windows, which it can't handle: | |
2082 | if sys.platform == 'win32': |
|
2081 | if sys.platform == 'win32': | |
2083 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2082 | from IPython.utils._process_win32 import AvoidUNCPath | |
2084 | with AvoidUNCPath() as path: |
|
2083 | with AvoidUNCPath() as path: | |
2085 | if path is not None: |
|
2084 | if path is not None: | |
2086 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2085 | cmd = '"pushd %s &&"%s' % (path, cmd) | |
2087 | cmd = py3compat.unicode_to_str(cmd) |
|
2086 | cmd = py3compat.unicode_to_str(cmd) | |
2088 | ec = os.system(cmd) |
|
2087 | ec = os.system(cmd) | |
2089 | else: |
|
2088 | else: | |
2090 | cmd = py3compat.unicode_to_str(cmd) |
|
2089 | cmd = py3compat.unicode_to_str(cmd) | |
2091 | ec = os.system(cmd) |
|
2090 | ec = os.system(cmd) | |
2092 |
|
2091 | |||
2093 | # We explicitly do NOT return the subprocess status code, because |
|
2092 | # We explicitly do NOT return the subprocess status code, because | |
2094 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2093 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2095 | # Instead, we store the exit_code in user_ns. |
|
2094 | # Instead, we store the exit_code in user_ns. | |
2096 | self.user_ns['_exit_code'] = ec |
|
2095 | self.user_ns['_exit_code'] = ec | |
2097 |
|
2096 | |||
2098 | # use piped system by default, because it is better behaved |
|
2097 | # use piped system by default, because it is better behaved | |
2099 | system = system_piped |
|
2098 | system = system_piped | |
2100 |
|
2099 | |||
2101 | def getoutput(self, cmd, split=True): |
|
2100 | def getoutput(self, cmd, split=True): | |
2102 | """Get output (possibly including stderr) from a subprocess. |
|
2101 | """Get output (possibly including stderr) from a subprocess. | |
2103 |
|
2102 | |||
2104 | Parameters |
|
2103 | Parameters | |
2105 | ---------- |
|
2104 | ---------- | |
2106 | cmd : str |
|
2105 | cmd : str | |
2107 | Command to execute (can not end in '&', as background processes are |
|
2106 | Command to execute (can not end in '&', as background processes are | |
2108 | not supported. |
|
2107 | not supported. | |
2109 | split : bool, optional |
|
2108 | split : bool, optional | |
2110 |
|
2109 | |||
2111 | If True, split the output into an IPython SList. Otherwise, an |
|
2110 | If True, split the output into an IPython SList. Otherwise, an | |
2112 | IPython LSString is returned. These are objects similar to normal |
|
2111 | IPython LSString is returned. These are objects similar to normal | |
2113 | lists and strings, with a few convenience attributes for easier |
|
2112 | lists and strings, with a few convenience attributes for easier | |
2114 | manipulation of line-based output. You can use '?' on them for |
|
2113 | manipulation of line-based output. You can use '?' on them for | |
2115 | details. |
|
2114 | details. | |
2116 | """ |
|
2115 | """ | |
2117 | if cmd.rstrip().endswith('&'): |
|
2116 | if cmd.rstrip().endswith('&'): | |
2118 | # this is *far* from a rigorous test |
|
2117 | # this is *far* from a rigorous test | |
2119 | raise OSError("Background processes not supported.") |
|
2118 | raise OSError("Background processes not supported.") | |
2120 | out = getoutput(self.var_expand(cmd, depth=2)) |
|
2119 | out = getoutput(self.var_expand(cmd, depth=2)) | |
2121 | if split: |
|
2120 | if split: | |
2122 | out = SList(out.splitlines()) |
|
2121 | out = SList(out.splitlines()) | |
2123 | else: |
|
2122 | else: | |
2124 | out = LSString(out) |
|
2123 | out = LSString(out) | |
2125 | return out |
|
2124 | return out | |
2126 |
|
2125 | |||
2127 | #------------------------------------------------------------------------- |
|
2126 | #------------------------------------------------------------------------- | |
2128 | # Things related to aliases |
|
2127 | # Things related to aliases | |
2129 | #------------------------------------------------------------------------- |
|
2128 | #------------------------------------------------------------------------- | |
2130 |
|
2129 | |||
2131 | def init_alias(self): |
|
2130 | def init_alias(self): | |
2132 | self.alias_manager = AliasManager(shell=self, config=self.config) |
|
2131 | self.alias_manager = AliasManager(shell=self, config=self.config) | |
2133 | self.configurables.append(self.alias_manager) |
|
2132 | self.configurables.append(self.alias_manager) | |
2134 | self.ns_table['alias'] = self.alias_manager.alias_table, |
|
2133 | self.ns_table['alias'] = self.alias_manager.alias_table, | |
2135 |
|
2134 | |||
2136 | #------------------------------------------------------------------------- |
|
2135 | #------------------------------------------------------------------------- | |
2137 | # Things related to extensions and plugins |
|
2136 | # Things related to extensions and plugins | |
2138 | #------------------------------------------------------------------------- |
|
2137 | #------------------------------------------------------------------------- | |
2139 |
|
2138 | |||
2140 | def init_extension_manager(self): |
|
2139 | def init_extension_manager(self): | |
2141 | self.extension_manager = ExtensionManager(shell=self, config=self.config) |
|
2140 | self.extension_manager = ExtensionManager(shell=self, config=self.config) | |
2142 | self.configurables.append(self.extension_manager) |
|
2141 | self.configurables.append(self.extension_manager) | |
2143 |
|
2142 | |||
2144 | def init_plugin_manager(self): |
|
2143 | def init_plugin_manager(self): | |
2145 | self.plugin_manager = PluginManager(config=self.config) |
|
2144 | self.plugin_manager = PluginManager(config=self.config) | |
2146 | self.configurables.append(self.plugin_manager) |
|
2145 | self.configurables.append(self.plugin_manager) | |
2147 |
|
2146 | |||
2148 |
|
2147 | |||
2149 | #------------------------------------------------------------------------- |
|
2148 | #------------------------------------------------------------------------- | |
2150 | # Things related to payloads |
|
2149 | # Things related to payloads | |
2151 | #------------------------------------------------------------------------- |
|
2150 | #------------------------------------------------------------------------- | |
2152 |
|
2151 | |||
2153 | def init_payload(self): |
|
2152 | def init_payload(self): | |
2154 | self.payload_manager = PayloadManager(config=self.config) |
|
2153 | self.payload_manager = PayloadManager(config=self.config) | |
2155 | self.configurables.append(self.payload_manager) |
|
2154 | self.configurables.append(self.payload_manager) | |
2156 |
|
2155 | |||
2157 | #------------------------------------------------------------------------- |
|
2156 | #------------------------------------------------------------------------- | |
2158 | # Things related to the prefilter |
|
2157 | # Things related to the prefilter | |
2159 | #------------------------------------------------------------------------- |
|
2158 | #------------------------------------------------------------------------- | |
2160 |
|
2159 | |||
2161 | def init_prefilter(self): |
|
2160 | def init_prefilter(self): | |
2162 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) |
|
2161 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) | |
2163 | self.configurables.append(self.prefilter_manager) |
|
2162 | self.configurables.append(self.prefilter_manager) | |
2164 | # Ultimately this will be refactored in the new interpreter code, but |
|
2163 | # Ultimately this will be refactored in the new interpreter code, but | |
2165 | # for now, we should expose the main prefilter method (there's legacy |
|
2164 | # for now, we should expose the main prefilter method (there's legacy | |
2166 | # code out there that may rely on this). |
|
2165 | # code out there that may rely on this). | |
2167 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2166 | self.prefilter = self.prefilter_manager.prefilter_lines | |
2168 |
|
2167 | |||
2169 | def auto_rewrite_input(self, cmd): |
|
2168 | def auto_rewrite_input(self, cmd): | |
2170 | """Print to the screen the rewritten form of the user's command. |
|
2169 | """Print to the screen the rewritten form of the user's command. | |
2171 |
|
2170 | |||
2172 | This shows visual feedback by rewriting input lines that cause |
|
2171 | This shows visual feedback by rewriting input lines that cause | |
2173 | automatic calling to kick in, like:: |
|
2172 | automatic calling to kick in, like:: | |
2174 |
|
2173 | |||
2175 | /f x |
|
2174 | /f x | |
2176 |
|
2175 | |||
2177 | into:: |
|
2176 | into:: | |
2178 |
|
2177 | |||
2179 | ------> f(x) |
|
2178 | ------> f(x) | |
2180 |
|
2179 | |||
2181 | after the user's input prompt. This helps the user understand that the |
|
2180 | after the user's input prompt. This helps the user understand that the | |
2182 | input line was transformed automatically by IPython. |
|
2181 | input line was transformed automatically by IPython. | |
2183 | """ |
|
2182 | """ | |
2184 | if not self.show_rewritten_input: |
|
2183 | if not self.show_rewritten_input: | |
2185 | return |
|
2184 | return | |
2186 |
|
2185 | |||
2187 | rw = self.prompt_manager.render('rewrite') + cmd |
|
2186 | rw = self.prompt_manager.render('rewrite') + cmd | |
2188 |
|
2187 | |||
2189 | try: |
|
2188 | try: | |
2190 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2189 | # plain ascii works better w/ pyreadline, on some machines, so | |
2191 | # we use it and only print uncolored rewrite if we have unicode |
|
2190 | # we use it and only print uncolored rewrite if we have unicode | |
2192 | rw = str(rw) |
|
2191 | rw = str(rw) | |
2193 | print >> io.stdout, rw |
|
2192 | print >> io.stdout, rw | |
2194 | except UnicodeEncodeError: |
|
2193 | except UnicodeEncodeError: | |
2195 | print "------> " + cmd |
|
2194 | print "------> " + cmd | |
2196 |
|
2195 | |||
2197 | #------------------------------------------------------------------------- |
|
2196 | #------------------------------------------------------------------------- | |
2198 | # Things related to extracting values/expressions from kernel and user_ns |
|
2197 | # Things related to extracting values/expressions from kernel and user_ns | |
2199 | #------------------------------------------------------------------------- |
|
2198 | #------------------------------------------------------------------------- | |
2200 |
|
2199 | |||
2201 | def _simple_error(self): |
|
2200 | def _simple_error(self): | |
2202 | etype, value = sys.exc_info()[:2] |
|
2201 | etype, value = sys.exc_info()[:2] | |
2203 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) |
|
2202 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) | |
2204 |
|
2203 | |||
2205 | def user_variables(self, names): |
|
2204 | def user_variables(self, names): | |
2206 | """Get a list of variable names from the user's namespace. |
|
2205 | """Get a list of variable names from the user's namespace. | |
2207 |
|
2206 | |||
2208 | Parameters |
|
2207 | Parameters | |
2209 | ---------- |
|
2208 | ---------- | |
2210 | names : list of strings |
|
2209 | names : list of strings | |
2211 | A list of names of variables to be read from the user namespace. |
|
2210 | A list of names of variables to be read from the user namespace. | |
2212 |
|
2211 | |||
2213 | Returns |
|
2212 | Returns | |
2214 | ------- |
|
2213 | ------- | |
2215 | A dict, keyed by the input names and with the repr() of each value. |
|
2214 | A dict, keyed by the input names and with the repr() of each value. | |
2216 | """ |
|
2215 | """ | |
2217 | out = {} |
|
2216 | out = {} | |
2218 | user_ns = self.user_ns |
|
2217 | user_ns = self.user_ns | |
2219 | for varname in names: |
|
2218 | for varname in names: | |
2220 | try: |
|
2219 | try: | |
2221 | value = repr(user_ns[varname]) |
|
2220 | value = repr(user_ns[varname]) | |
2222 | except: |
|
2221 | except: | |
2223 | value = self._simple_error() |
|
2222 | value = self._simple_error() | |
2224 | out[varname] = value |
|
2223 | out[varname] = value | |
2225 | return out |
|
2224 | return out | |
2226 |
|
2225 | |||
2227 | def user_expressions(self, expressions): |
|
2226 | def user_expressions(self, expressions): | |
2228 | """Evaluate a dict of expressions in the user's namespace. |
|
2227 | """Evaluate a dict of expressions in the user's namespace. | |
2229 |
|
2228 | |||
2230 | Parameters |
|
2229 | Parameters | |
2231 | ---------- |
|
2230 | ---------- | |
2232 | expressions : dict |
|
2231 | expressions : dict | |
2233 | A dict with string keys and string values. The expression values |
|
2232 | A dict with string keys and string values. The expression values | |
2234 | should be valid Python expressions, each of which will be evaluated |
|
2233 | should be valid Python expressions, each of which will be evaluated | |
2235 | in the user namespace. |
|
2234 | in the user namespace. | |
2236 |
|
2235 | |||
2237 | Returns |
|
2236 | Returns | |
2238 | ------- |
|
2237 | ------- | |
2239 | A dict, keyed like the input expressions dict, with the repr() of each |
|
2238 | A dict, keyed like the input expressions dict, with the repr() of each | |
2240 | value. |
|
2239 | value. | |
2241 | """ |
|
2240 | """ | |
2242 | out = {} |
|
2241 | out = {} | |
2243 | user_ns = self.user_ns |
|
2242 | user_ns = self.user_ns | |
2244 | global_ns = self.user_global_ns |
|
2243 | global_ns = self.user_global_ns | |
2245 | for key, expr in expressions.iteritems(): |
|
2244 | for key, expr in expressions.iteritems(): | |
2246 | try: |
|
2245 | try: | |
2247 | value = repr(eval(expr, global_ns, user_ns)) |
|
2246 | value = repr(eval(expr, global_ns, user_ns)) | |
2248 | except: |
|
2247 | except: | |
2249 | value = self._simple_error() |
|
2248 | value = self._simple_error() | |
2250 | out[key] = value |
|
2249 | out[key] = value | |
2251 | return out |
|
2250 | return out | |
2252 |
|
2251 | |||
2253 | #------------------------------------------------------------------------- |
|
2252 | #------------------------------------------------------------------------- | |
2254 | # Things related to the running of code |
|
2253 | # Things related to the running of code | |
2255 | #------------------------------------------------------------------------- |
|
2254 | #------------------------------------------------------------------------- | |
2256 |
|
2255 | |||
2257 | def ex(self, cmd): |
|
2256 | def ex(self, cmd): | |
2258 | """Execute a normal python statement in user namespace.""" |
|
2257 | """Execute a normal python statement in user namespace.""" | |
2259 | with self.builtin_trap: |
|
2258 | with self.builtin_trap: | |
2260 | exec cmd in self.user_global_ns, self.user_ns |
|
2259 | exec cmd in self.user_global_ns, self.user_ns | |
2261 |
|
2260 | |||
2262 | def ev(self, expr): |
|
2261 | def ev(self, expr): | |
2263 | """Evaluate python expression expr in user namespace. |
|
2262 | """Evaluate python expression expr in user namespace. | |
2264 |
|
2263 | |||
2265 | Returns the result of evaluation |
|
2264 | Returns the result of evaluation | |
2266 | """ |
|
2265 | """ | |
2267 | with self.builtin_trap: |
|
2266 | with self.builtin_trap: | |
2268 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2267 | return eval(expr, self.user_global_ns, self.user_ns) | |
2269 |
|
2268 | |||
2270 | def safe_execfile(self, fname, *where, **kw): |
|
2269 | def safe_execfile(self, fname, *where, **kw): | |
2271 | """A safe version of the builtin execfile(). |
|
2270 | """A safe version of the builtin execfile(). | |
2272 |
|
2271 | |||
2273 | This version will never throw an exception, but instead print |
|
2272 | This version will never throw an exception, but instead print | |
2274 | helpful error messages to the screen. This only works on pure |
|
2273 | helpful error messages to the screen. This only works on pure | |
2275 | Python files with the .py extension. |
|
2274 | Python files with the .py extension. | |
2276 |
|
2275 | |||
2277 | Parameters |
|
2276 | Parameters | |
2278 | ---------- |
|
2277 | ---------- | |
2279 | fname : string |
|
2278 | fname : string | |
2280 | The name of the file to be executed. |
|
2279 | The name of the file to be executed. | |
2281 | where : tuple |
|
2280 | where : tuple | |
2282 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2281 | One or two namespaces, passed to execfile() as (globals,locals). | |
2283 | If only one is given, it is passed as both. |
|
2282 | If only one is given, it is passed as both. | |
2284 | exit_ignore : bool (False) |
|
2283 | exit_ignore : bool (False) | |
2285 | If True, then silence SystemExit for non-zero status (it is always |
|
2284 | If True, then silence SystemExit for non-zero status (it is always | |
2286 | silenced for zero status, as it is so common). |
|
2285 | silenced for zero status, as it is so common). | |
2287 | raise_exceptions : bool (False) |
|
2286 | raise_exceptions : bool (False) | |
2288 | If True raise exceptions everywhere. Meant for testing. |
|
2287 | If True raise exceptions everywhere. Meant for testing. | |
2289 |
|
2288 | |||
2290 | """ |
|
2289 | """ | |
2291 | kw.setdefault('exit_ignore', False) |
|
2290 | kw.setdefault('exit_ignore', False) | |
2292 | kw.setdefault('raise_exceptions', False) |
|
2291 | kw.setdefault('raise_exceptions', False) | |
2293 |
|
2292 | |||
2294 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2293 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2295 |
|
2294 | |||
2296 | # Make sure we can open the file |
|
2295 | # Make sure we can open the file | |
2297 | try: |
|
2296 | try: | |
2298 | with open(fname) as thefile: |
|
2297 | with open(fname) as thefile: | |
2299 | pass |
|
2298 | pass | |
2300 | except: |
|
2299 | except: | |
2301 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2300 | warn('Could not open file <%s> for safe execution.' % fname) | |
2302 | return |
|
2301 | return | |
2303 |
|
2302 | |||
2304 | # Find things also in current directory. This is needed to mimic the |
|
2303 | # Find things also in current directory. This is needed to mimic the | |
2305 | # behavior of running a script from the system command line, where |
|
2304 | # behavior of running a script from the system command line, where | |
2306 | # Python inserts the script's directory into sys.path |
|
2305 | # Python inserts the script's directory into sys.path | |
2307 | dname = os.path.dirname(fname) |
|
2306 | dname = os.path.dirname(fname) | |
2308 |
|
2307 | |||
2309 | with prepended_to_syspath(dname): |
|
2308 | with prepended_to_syspath(dname): | |
2310 | try: |
|
2309 | try: | |
2311 | py3compat.execfile(fname,*where) |
|
2310 | py3compat.execfile(fname,*where) | |
2312 | except SystemExit, status: |
|
2311 | except SystemExit, status: | |
2313 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2312 | # If the call was made with 0 or None exit status (sys.exit(0) | |
2314 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2313 | # or sys.exit() ), don't bother showing a traceback, as both of | |
2315 | # these are considered normal by the OS: |
|
2314 | # these are considered normal by the OS: | |
2316 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2315 | # > python -c'import sys;sys.exit(0)'; echo $? | |
2317 | # 0 |
|
2316 | # 0 | |
2318 | # > python -c'import sys;sys.exit()'; echo $? |
|
2317 | # > python -c'import sys;sys.exit()'; echo $? | |
2319 | # 0 |
|
2318 | # 0 | |
2320 | # For other exit status, we show the exception unless |
|
2319 | # For other exit status, we show the exception unless | |
2321 | # explicitly silenced, but only in short form. |
|
2320 | # explicitly silenced, but only in short form. | |
2322 | if kw['raise_exceptions']: |
|
2321 | if kw['raise_exceptions']: | |
2323 | raise |
|
2322 | raise | |
2324 | if status.code not in (0, None) and not kw['exit_ignore']: |
|
2323 | if status.code not in (0, None) and not kw['exit_ignore']: | |
2325 | self.showtraceback(exception_only=True) |
|
2324 | self.showtraceback(exception_only=True) | |
2326 | except: |
|
2325 | except: | |
2327 | if kw['raise_exceptions']: |
|
2326 | if kw['raise_exceptions']: | |
2328 | raise |
|
2327 | raise | |
2329 | self.showtraceback() |
|
2328 | self.showtraceback() | |
2330 |
|
2329 | |||
2331 | def safe_execfile_ipy(self, fname): |
|
2330 | def safe_execfile_ipy(self, fname): | |
2332 | """Like safe_execfile, but for .ipy files with IPython syntax. |
|
2331 | """Like safe_execfile, but for .ipy files with IPython syntax. | |
2333 |
|
2332 | |||
2334 | Parameters |
|
2333 | Parameters | |
2335 | ---------- |
|
2334 | ---------- | |
2336 | fname : str |
|
2335 | fname : str | |
2337 | The name of the file to execute. The filename must have a |
|
2336 | The name of the file to execute. The filename must have a | |
2338 | .ipy extension. |
|
2337 | .ipy extension. | |
2339 | """ |
|
2338 | """ | |
2340 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2339 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2341 |
|
2340 | |||
2342 | # Make sure we can open the file |
|
2341 | # Make sure we can open the file | |
2343 | try: |
|
2342 | try: | |
2344 | with open(fname) as thefile: |
|
2343 | with open(fname) as thefile: | |
2345 | pass |
|
2344 | pass | |
2346 | except: |
|
2345 | except: | |
2347 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2346 | warn('Could not open file <%s> for safe execution.' % fname) | |
2348 | return |
|
2347 | return | |
2349 |
|
2348 | |||
2350 | # Find things also in current directory. This is needed to mimic the |
|
2349 | # Find things also in current directory. This is needed to mimic the | |
2351 | # behavior of running a script from the system command line, where |
|
2350 | # behavior of running a script from the system command line, where | |
2352 | # Python inserts the script's directory into sys.path |
|
2351 | # Python inserts the script's directory into sys.path | |
2353 | dname = os.path.dirname(fname) |
|
2352 | dname = os.path.dirname(fname) | |
2354 |
|
2353 | |||
2355 | with prepended_to_syspath(dname): |
|
2354 | with prepended_to_syspath(dname): | |
2356 | try: |
|
2355 | try: | |
2357 | with open(fname) as thefile: |
|
2356 | with open(fname) as thefile: | |
2358 | # self.run_cell currently captures all exceptions |
|
2357 | # self.run_cell currently captures all exceptions | |
2359 | # raised in user code. It would be nice if there were |
|
2358 | # raised in user code. It would be nice if there were | |
2360 | # versions of runlines, execfile that did raise, so |
|
2359 | # versions of runlines, execfile that did raise, so | |
2361 | # we could catch the errors. |
|
2360 | # we could catch the errors. | |
2362 | self.run_cell(thefile.read(), store_history=False) |
|
2361 | self.run_cell(thefile.read(), store_history=False) | |
2363 | except: |
|
2362 | except: | |
2364 | self.showtraceback() |
|
2363 | self.showtraceback() | |
2365 | warn('Unknown failure executing file: <%s>' % fname) |
|
2364 | warn('Unknown failure executing file: <%s>' % fname) | |
2366 |
|
2365 | |||
2367 | def run_cell(self, raw_cell, store_history=False): |
|
2366 | def run_cell(self, raw_cell, store_history=False): | |
2368 | """Run a complete IPython cell. |
|
2367 | """Run a complete IPython cell. | |
2369 |
|
2368 | |||
2370 | Parameters |
|
2369 | Parameters | |
2371 | ---------- |
|
2370 | ---------- | |
2372 | raw_cell : str |
|
2371 | raw_cell : str | |
2373 | The code (including IPython code such as %magic functions) to run. |
|
2372 | The code (including IPython code such as %magic functions) to run. | |
2374 | store_history : bool |
|
2373 | store_history : bool | |
2375 | If True, the raw and translated cell will be stored in IPython's |
|
2374 | If True, the raw and translated cell will be stored in IPython's | |
2376 | history. For user code calling back into IPython's machinery, this |
|
2375 | history. For user code calling back into IPython's machinery, this | |
2377 | should be set to False. |
|
2376 | should be set to False. | |
2378 | """ |
|
2377 | """ | |
2379 | if (not raw_cell) or raw_cell.isspace(): |
|
2378 | if (not raw_cell) or raw_cell.isspace(): | |
2380 | return |
|
2379 | return | |
2381 |
|
2380 | |||
2382 | for line in raw_cell.splitlines(): |
|
2381 | for line in raw_cell.splitlines(): | |
2383 | self.input_splitter.push(line) |
|
2382 | self.input_splitter.push(line) | |
2384 | cell = self.input_splitter.source_reset() |
|
2383 | cell = self.input_splitter.source_reset() | |
2385 |
|
2384 | |||
2386 | with self.builtin_trap: |
|
2385 | with self.builtin_trap: | |
2387 | prefilter_failed = False |
|
2386 | prefilter_failed = False | |
2388 | if len(cell.splitlines()) == 1: |
|
2387 | if len(cell.splitlines()) == 1: | |
2389 | try: |
|
2388 | try: | |
2390 | # use prefilter_lines to handle trailing newlines |
|
2389 | # use prefilter_lines to handle trailing newlines | |
2391 | # restore trailing newline for ast.parse |
|
2390 | # restore trailing newline for ast.parse | |
2392 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
2391 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' | |
2393 | except AliasError as e: |
|
2392 | except AliasError as e: | |
2394 | error(e) |
|
2393 | error(e) | |
2395 | prefilter_failed = True |
|
2394 | prefilter_failed = True | |
2396 | except Exception: |
|
2395 | except Exception: | |
2397 | # don't allow prefilter errors to crash IPython |
|
2396 | # don't allow prefilter errors to crash IPython | |
2398 | self.showtraceback() |
|
2397 | self.showtraceback() | |
2399 | prefilter_failed = True |
|
2398 | prefilter_failed = True | |
2400 |
|
2399 | |||
2401 | # Store raw and processed history |
|
2400 | # Store raw and processed history | |
2402 | if store_history: |
|
2401 | if store_history: | |
2403 | self.history_manager.store_inputs(self.execution_count, |
|
2402 | self.history_manager.store_inputs(self.execution_count, | |
2404 | cell, raw_cell) |
|
2403 | cell, raw_cell) | |
2405 |
|
2404 | |||
2406 | self.logger.log(cell, raw_cell) |
|
2405 | self.logger.log(cell, raw_cell) | |
2407 |
|
2406 | |||
2408 | if not prefilter_failed: |
|
2407 | if not prefilter_failed: | |
2409 | # don't run if prefilter failed |
|
2408 | # don't run if prefilter failed | |
2410 | cell_name = self.compile.cache(cell, self.execution_count) |
|
2409 | cell_name = self.compile.cache(cell, self.execution_count) | |
2411 |
|
2410 | |||
2412 | with self.display_trap: |
|
2411 | with self.display_trap: | |
2413 | try: |
|
2412 | try: | |
2414 | code_ast = self.compile.ast_parse(cell, filename=cell_name) |
|
2413 | code_ast = self.compile.ast_parse(cell, filename=cell_name) | |
2415 | except IndentationError: |
|
2414 | except IndentationError: | |
2416 | self.showindentationerror() |
|
2415 | self.showindentationerror() | |
2417 | if store_history: |
|
2416 | if store_history: | |
2418 | self.execution_count += 1 |
|
2417 | self.execution_count += 1 | |
2419 | return None |
|
2418 | return None | |
2420 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
2419 | except (OverflowError, SyntaxError, ValueError, TypeError, | |
2421 | MemoryError): |
|
2420 | MemoryError): | |
2422 | self.showsyntaxerror() |
|
2421 | self.showsyntaxerror() | |
2423 | if store_history: |
|
2422 | if store_history: | |
2424 | self.execution_count += 1 |
|
2423 | self.execution_count += 1 | |
2425 | return None |
|
2424 | return None | |
2426 |
|
2425 | |||
2427 | self.run_ast_nodes(code_ast.body, cell_name, |
|
2426 | self.run_ast_nodes(code_ast.body, cell_name, | |
2428 | interactivity="last_expr") |
|
2427 | interactivity="last_expr") | |
2429 |
|
2428 | |||
2430 | # Execute any registered post-execution functions. |
|
2429 | # Execute any registered post-execution functions. | |
2431 | for func, status in self._post_execute.iteritems(): |
|
2430 | for func, status in self._post_execute.iteritems(): | |
2432 | if self.disable_failing_post_execute and not status: |
|
2431 | if self.disable_failing_post_execute and not status: | |
2433 | continue |
|
2432 | continue | |
2434 | try: |
|
2433 | try: | |
2435 | func() |
|
2434 | func() | |
2436 | except KeyboardInterrupt: |
|
2435 | except KeyboardInterrupt: | |
2437 | print >> io.stderr, "\nKeyboardInterrupt" |
|
2436 | print >> io.stderr, "\nKeyboardInterrupt" | |
2438 | except Exception: |
|
2437 | except Exception: | |
2439 | # register as failing: |
|
2438 | # register as failing: | |
2440 | self._post_execute[func] = False |
|
2439 | self._post_execute[func] = False | |
2441 | self.showtraceback() |
|
2440 | self.showtraceback() | |
2442 | print >> io.stderr, '\n'.join([ |
|
2441 | print >> io.stderr, '\n'.join([ | |
2443 | "post-execution function %r produced an error." % func, |
|
2442 | "post-execution function %r produced an error." % func, | |
2444 | "If this problem persists, you can disable failing post-exec functions with:", |
|
2443 | "If this problem persists, you can disable failing post-exec functions with:", | |
2445 | "", |
|
2444 | "", | |
2446 | " get_ipython().disable_failing_post_execute = True" |
|
2445 | " get_ipython().disable_failing_post_execute = True" | |
2447 | ]) |
|
2446 | ]) | |
2448 |
|
2447 | |||
2449 | if store_history: |
|
2448 | if store_history: | |
2450 | # Write output to the database. Does nothing unless |
|
2449 | # Write output to the database. Does nothing unless | |
2451 | # history output logging is enabled. |
|
2450 | # history output logging is enabled. | |
2452 | self.history_manager.store_output(self.execution_count) |
|
2451 | self.history_manager.store_output(self.execution_count) | |
2453 | # Each cell is a *single* input, regardless of how many lines it has |
|
2452 | # Each cell is a *single* input, regardless of how many lines it has | |
2454 | self.execution_count += 1 |
|
2453 | self.execution_count += 1 | |
2455 |
|
2454 | |||
2456 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'): |
|
2455 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'): | |
2457 | """Run a sequence of AST nodes. The execution mode depends on the |
|
2456 | """Run a sequence of AST nodes. The execution mode depends on the | |
2458 | interactivity parameter. |
|
2457 | interactivity parameter. | |
2459 |
|
2458 | |||
2460 | Parameters |
|
2459 | Parameters | |
2461 | ---------- |
|
2460 | ---------- | |
2462 | nodelist : list |
|
2461 | nodelist : list | |
2463 | A sequence of AST nodes to run. |
|
2462 | A sequence of AST nodes to run. | |
2464 | cell_name : str |
|
2463 | cell_name : str | |
2465 | Will be passed to the compiler as the filename of the cell. Typically |
|
2464 | Will be passed to the compiler as the filename of the cell. Typically | |
2466 | the value returned by ip.compile.cache(cell). |
|
2465 | the value returned by ip.compile.cache(cell). | |
2467 | interactivity : str |
|
2466 | interactivity : str | |
2468 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be |
|
2467 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be | |
2469 | run interactively (displaying output from expressions). 'last_expr' |
|
2468 | run interactively (displaying output from expressions). 'last_expr' | |
2470 | will run the last node interactively only if it is an expression (i.e. |
|
2469 | will run the last node interactively only if it is an expression (i.e. | |
2471 | expressions in loops or other blocks are not displayed. Other values |
|
2470 | expressions in loops or other blocks are not displayed. Other values | |
2472 | for this parameter will raise a ValueError. |
|
2471 | for this parameter will raise a ValueError. | |
2473 | """ |
|
2472 | """ | |
2474 | if not nodelist: |
|
2473 | if not nodelist: | |
2475 | return |
|
2474 | return | |
2476 |
|
2475 | |||
2477 | if interactivity == 'last_expr': |
|
2476 | if interactivity == 'last_expr': | |
2478 | if isinstance(nodelist[-1], ast.Expr): |
|
2477 | if isinstance(nodelist[-1], ast.Expr): | |
2479 | interactivity = "last" |
|
2478 | interactivity = "last" | |
2480 | else: |
|
2479 | else: | |
2481 | interactivity = "none" |
|
2480 | interactivity = "none" | |
2482 |
|
2481 | |||
2483 | if interactivity == 'none': |
|
2482 | if interactivity == 'none': | |
2484 | to_run_exec, to_run_interactive = nodelist, [] |
|
2483 | to_run_exec, to_run_interactive = nodelist, [] | |
2485 | elif interactivity == 'last': |
|
2484 | elif interactivity == 'last': | |
2486 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
2485 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] | |
2487 | elif interactivity == 'all': |
|
2486 | elif interactivity == 'all': | |
2488 | to_run_exec, to_run_interactive = [], nodelist |
|
2487 | to_run_exec, to_run_interactive = [], nodelist | |
2489 | else: |
|
2488 | else: | |
2490 | raise ValueError("Interactivity was %r" % interactivity) |
|
2489 | raise ValueError("Interactivity was %r" % interactivity) | |
2491 |
|
2490 | |||
2492 | exec_count = self.execution_count |
|
2491 | exec_count = self.execution_count | |
2493 |
|
2492 | |||
2494 | try: |
|
2493 | try: | |
2495 | for i, node in enumerate(to_run_exec): |
|
2494 | for i, node in enumerate(to_run_exec): | |
2496 | mod = ast.Module([node]) |
|
2495 | mod = ast.Module([node]) | |
2497 | code = self.compile(mod, cell_name, "exec") |
|
2496 | code = self.compile(mod, cell_name, "exec") | |
2498 | if self.run_code(code): |
|
2497 | if self.run_code(code): | |
2499 | return True |
|
2498 | return True | |
2500 |
|
2499 | |||
2501 | for i, node in enumerate(to_run_interactive): |
|
2500 | for i, node in enumerate(to_run_interactive): | |
2502 | mod = ast.Interactive([node]) |
|
2501 | mod = ast.Interactive([node]) | |
2503 | code = self.compile(mod, cell_name, "single") |
|
2502 | code = self.compile(mod, cell_name, "single") | |
2504 | if self.run_code(code): |
|
2503 | if self.run_code(code): | |
2505 | return True |
|
2504 | return True | |
2506 | except: |
|
2505 | except: | |
2507 | # It's possible to have exceptions raised here, typically by |
|
2506 | # It's possible to have exceptions raised here, typically by | |
2508 | # compilation of odd code (such as a naked 'return' outside a |
|
2507 | # compilation of odd code (such as a naked 'return' outside a | |
2509 | # function) that did parse but isn't valid. Typically the exception |
|
2508 | # function) that did parse but isn't valid. Typically the exception | |
2510 | # is a SyntaxError, but it's safest just to catch anything and show |
|
2509 | # is a SyntaxError, but it's safest just to catch anything and show | |
2511 | # the user a traceback. |
|
2510 | # the user a traceback. | |
2512 |
|
2511 | |||
2513 | # We do only one try/except outside the loop to minimize the impact |
|
2512 | # We do only one try/except outside the loop to minimize the impact | |
2514 | # on runtime, and also because if any node in the node list is |
|
2513 | # on runtime, and also because if any node in the node list is | |
2515 | # broken, we should stop execution completely. |
|
2514 | # broken, we should stop execution completely. | |
2516 | self.showtraceback() |
|
2515 | self.showtraceback() | |
2517 |
|
2516 | |||
2518 | return False |
|
2517 | return False | |
2519 |
|
2518 | |||
2520 | def run_code(self, code_obj): |
|
2519 | def run_code(self, code_obj): | |
2521 | """Execute a code object. |
|
2520 | """Execute a code object. | |
2522 |
|
2521 | |||
2523 | When an exception occurs, self.showtraceback() is called to display a |
|
2522 | When an exception occurs, self.showtraceback() is called to display a | |
2524 | traceback. |
|
2523 | traceback. | |
2525 |
|
2524 | |||
2526 | Parameters |
|
2525 | Parameters | |
2527 | ---------- |
|
2526 | ---------- | |
2528 | code_obj : code object |
|
2527 | code_obj : code object | |
2529 | A compiled code object, to be executed |
|
2528 | A compiled code object, to be executed | |
2530 | post_execute : bool [default: True] |
|
2529 | post_execute : bool [default: True] | |
2531 | whether to call post_execute hooks after this particular execution. |
|
2530 | whether to call post_execute hooks after this particular execution. | |
2532 |
|
2531 | |||
2533 | Returns |
|
2532 | Returns | |
2534 | ------- |
|
2533 | ------- | |
2535 | False : successful execution. |
|
2534 | False : successful execution. | |
2536 | True : an error occurred. |
|
2535 | True : an error occurred. | |
2537 | """ |
|
2536 | """ | |
2538 |
|
2537 | |||
2539 | # Set our own excepthook in case the user code tries to call it |
|
2538 | # Set our own excepthook in case the user code tries to call it | |
2540 | # directly, so that the IPython crash handler doesn't get triggered |
|
2539 | # directly, so that the IPython crash handler doesn't get triggered | |
2541 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2540 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook | |
2542 |
|
2541 | |||
2543 | # we save the original sys.excepthook in the instance, in case config |
|
2542 | # we save the original sys.excepthook in the instance, in case config | |
2544 | # code (such as magics) needs access to it. |
|
2543 | # code (such as magics) needs access to it. | |
2545 | self.sys_excepthook = old_excepthook |
|
2544 | self.sys_excepthook = old_excepthook | |
2546 | outflag = 1 # happens in more places, so it's easier as default |
|
2545 | outflag = 1 # happens in more places, so it's easier as default | |
2547 | try: |
|
2546 | try: | |
2548 | try: |
|
2547 | try: | |
2549 | self.hooks.pre_run_code_hook() |
|
2548 | self.hooks.pre_run_code_hook() | |
2550 | #rprint('Running code', repr(code_obj)) # dbg |
|
2549 | #rprint('Running code', repr(code_obj)) # dbg | |
2551 | exec code_obj in self.user_global_ns, self.user_ns |
|
2550 | exec code_obj in self.user_global_ns, self.user_ns | |
2552 | finally: |
|
2551 | finally: | |
2553 | # Reset our crash handler in place |
|
2552 | # Reset our crash handler in place | |
2554 | sys.excepthook = old_excepthook |
|
2553 | sys.excepthook = old_excepthook | |
2555 | except SystemExit: |
|
2554 | except SystemExit: | |
2556 | self.showtraceback(exception_only=True) |
|
2555 | self.showtraceback(exception_only=True) | |
2557 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1) |
|
2556 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1) | |
2558 | except self.custom_exceptions: |
|
2557 | except self.custom_exceptions: | |
2559 | etype,value,tb = sys.exc_info() |
|
2558 | etype,value,tb = sys.exc_info() | |
2560 | self.CustomTB(etype,value,tb) |
|
2559 | self.CustomTB(etype,value,tb) | |
2561 | except: |
|
2560 | except: | |
2562 | self.showtraceback() |
|
2561 | self.showtraceback() | |
2563 | else: |
|
2562 | else: | |
2564 | outflag = 0 |
|
2563 | outflag = 0 | |
2565 | if softspace(sys.stdout, 0): |
|
2564 | if softspace(sys.stdout, 0): | |
2566 |
|
2565 | |||
2567 |
|
2566 | |||
2568 | return outflag |
|
2567 | return outflag | |
2569 |
|
2568 | |||
2570 | # For backwards compatibility |
|
2569 | # For backwards compatibility | |
2571 | runcode = run_code |
|
2570 | runcode = run_code | |
2572 |
|
2571 | |||
2573 | #------------------------------------------------------------------------- |
|
2572 | #------------------------------------------------------------------------- | |
2574 | # Things related to GUI support and pylab |
|
2573 | # Things related to GUI support and pylab | |
2575 | #------------------------------------------------------------------------- |
|
2574 | #------------------------------------------------------------------------- | |
2576 |
|
2575 | |||
2577 | def enable_gui(self, gui=None): |
|
2576 | def enable_gui(self, gui=None): | |
2578 | raise NotImplementedError('Implement enable_gui in a subclass') |
|
2577 | raise NotImplementedError('Implement enable_gui in a subclass') | |
2579 |
|
2578 | |||
2580 | def enable_pylab(self, gui=None, import_all=True): |
|
2579 | def enable_pylab(self, gui=None, import_all=True): | |
2581 | """Activate pylab support at runtime. |
|
2580 | """Activate pylab support at runtime. | |
2582 |
|
2581 | |||
2583 | This turns on support for matplotlib, preloads into the interactive |
|
2582 | This turns on support for matplotlib, preloads into the interactive | |
2584 | namespace all of numpy and pylab, and configures IPython to correctly |
|
2583 | namespace all of numpy and pylab, and configures IPython to correctly | |
2585 | interact with the GUI event loop. The GUI backend to be used can be |
|
2584 | interact with the GUI event loop. The GUI backend to be used can be | |
2586 | optionally selected with the optional :param:`gui` argument. |
|
2585 | optionally selected with the optional :param:`gui` argument. | |
2587 |
|
2586 | |||
2588 | Parameters |
|
2587 | Parameters | |
2589 | ---------- |
|
2588 | ---------- | |
2590 | gui : optional, string |
|
2589 | gui : optional, string | |
2591 |
|
2590 | |||
2592 | If given, dictates the choice of matplotlib GUI backend to use |
|
2591 | If given, dictates the choice of matplotlib GUI backend to use | |
2593 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
2592 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', | |
2594 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
2593 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by | |
2595 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
2594 | matplotlib (as dictated by the matplotlib build-time options plus the | |
2596 | user's matplotlibrc configuration file). Note that not all backends |
|
2595 | user's matplotlibrc configuration file). Note that not all backends | |
2597 | make sense in all contexts, for example a terminal ipython can't |
|
2596 | make sense in all contexts, for example a terminal ipython can't | |
2598 | display figures inline. |
|
2597 | display figures inline. | |
2599 | """ |
|
2598 | """ | |
2600 |
|
2599 | |||
2601 | # We want to prevent the loading of pylab to pollute the user's |
|
2600 | # We want to prevent the loading of pylab to pollute the user's | |
2602 | # namespace as shown by the %who* magics, so we execute the activation |
|
2601 | # namespace as shown by the %who* magics, so we execute the activation | |
2603 | # code in an empty namespace, and we update *both* user_ns and |
|
2602 | # code in an empty namespace, and we update *both* user_ns and | |
2604 | # user_ns_hidden with this information. |
|
2603 | # user_ns_hidden with this information. | |
2605 | ns = {} |
|
2604 | ns = {} | |
2606 | try: |
|
2605 | try: | |
2607 | gui = pylab_activate(ns, gui, import_all, self) |
|
2606 | gui = pylab_activate(ns, gui, import_all, self) | |
2608 | except KeyError: |
|
2607 | except KeyError: | |
2609 | error("Backend %r not supported" % gui) |
|
2608 | error("Backend %r not supported" % gui) | |
2610 | return |
|
2609 | return | |
2611 | self.user_ns.update(ns) |
|
2610 | self.user_ns.update(ns) | |
2612 | self.user_ns_hidden.update(ns) |
|
2611 | self.user_ns_hidden.update(ns) | |
2613 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
2612 | # Now we must activate the gui pylab wants to use, and fix %run to take | |
2614 | # plot updates into account |
|
2613 | # plot updates into account | |
2615 | self.enable_gui(gui) |
|
2614 | self.enable_gui(gui) | |
2616 | self.magic_run = self._pylab_magic_run |
|
2615 | self.magic_run = self._pylab_magic_run | |
2617 |
|
2616 | |||
2618 | #------------------------------------------------------------------------- |
|
2617 | #------------------------------------------------------------------------- | |
2619 | # Utilities |
|
2618 | # Utilities | |
2620 | #------------------------------------------------------------------------- |
|
2619 | #------------------------------------------------------------------------- | |
2621 |
|
2620 | |||
2622 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
2621 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): | |
2623 | """Expand python variables in a string. |
|
2622 | """Expand python variables in a string. | |
2624 |
|
2623 | |||
2625 | The depth argument indicates how many frames above the caller should |
|
2624 | The depth argument indicates how many frames above the caller should | |
2626 | be walked to look for the local namespace where to expand variables. |
|
2625 | be walked to look for the local namespace where to expand variables. | |
2627 |
|
2626 | |||
2628 | The global namespace for expansion is always the user's interactive |
|
2627 | The global namespace for expansion is always the user's interactive | |
2629 | namespace. |
|
2628 | namespace. | |
2630 | """ |
|
2629 | """ | |
2631 | ns = self.user_ns.copy() |
|
2630 | ns = self.user_ns.copy() | |
2632 | ns.update(sys._getframe(depth+1).f_locals) |
|
2631 | ns.update(sys._getframe(depth+1).f_locals) | |
2633 | ns.pop('self', None) |
|
2632 | ns.pop('self', None) | |
2634 | return formatter.format(cmd, **ns) |
|
2633 | return formatter.format(cmd, **ns) | |
2635 |
|
2634 | |||
2636 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
2635 | def mktempfile(self, data=None, prefix='ipython_edit_'): | |
2637 | """Make a new tempfile and return its filename. |
|
2636 | """Make a new tempfile and return its filename. | |
2638 |
|
2637 | |||
2639 | This makes a call to tempfile.mktemp, but it registers the created |
|
2638 | This makes a call to tempfile.mktemp, but it registers the created | |
2640 | filename internally so ipython cleans it up at exit time. |
|
2639 | filename internally so ipython cleans it up at exit time. | |
2641 |
|
2640 | |||
2642 | Optional inputs: |
|
2641 | Optional inputs: | |
2643 |
|
2642 | |||
2644 | - data(None): if data is given, it gets written out to the temp file |
|
2643 | - data(None): if data is given, it gets written out to the temp file | |
2645 | immediately, and the file is closed again.""" |
|
2644 | immediately, and the file is closed again.""" | |
2646 |
|
2645 | |||
2647 | filename = tempfile.mktemp('.py', prefix) |
|
2646 | filename = tempfile.mktemp('.py', prefix) | |
2648 | self.tempfiles.append(filename) |
|
2647 | self.tempfiles.append(filename) | |
2649 |
|
2648 | |||
2650 | if data: |
|
2649 | if data: | |
2651 | tmp_file = open(filename,'w') |
|
2650 | tmp_file = open(filename,'w') | |
2652 | tmp_file.write(data) |
|
2651 | tmp_file.write(data) | |
2653 | tmp_file.close() |
|
2652 | tmp_file.close() | |
2654 | return filename |
|
2653 | return filename | |
2655 |
|
2654 | |||
2656 | # TODO: This should be removed when Term is refactored. |
|
2655 | # TODO: This should be removed when Term is refactored. | |
2657 | def write(self,data): |
|
2656 | def write(self,data): | |
2658 | """Write a string to the default output""" |
|
2657 | """Write a string to the default output""" | |
2659 | io.stdout.write(data) |
|
2658 | io.stdout.write(data) | |
2660 |
|
2659 | |||
2661 | # TODO: This should be removed when Term is refactored. |
|
2660 | # TODO: This should be removed when Term is refactored. | |
2662 | def write_err(self,data): |
|
2661 | def write_err(self,data): | |
2663 | """Write a string to the default error output""" |
|
2662 | """Write a string to the default error output""" | |
2664 | io.stderr.write(data) |
|
2663 | io.stderr.write(data) | |
2665 |
|
2664 | |||
2666 | def ask_yes_no(self, prompt, default=None): |
|
2665 | def ask_yes_no(self, prompt, default=None): | |
2667 | if self.quiet: |
|
2666 | if self.quiet: | |
2668 | return True |
|
2667 | return True | |
2669 | return ask_yes_no(prompt,default) |
|
2668 | return ask_yes_no(prompt,default) | |
2670 |
|
2669 | |||
2671 | def show_usage(self): |
|
2670 | def show_usage(self): | |
2672 | """Show a usage message""" |
|
2671 | """Show a usage message""" | |
2673 | page.page(IPython.core.usage.interactive_usage) |
|
2672 | page.page(IPython.core.usage.interactive_usage) | |
2674 |
|
2673 | |||
2675 | def find_user_code(self, target, raw=True): |
|
2674 | def find_user_code(self, target, raw=True): | |
2676 | """Get a code string from history, file, or a string or macro. |
|
2675 | """Get a code string from history, file, or a string or macro. | |
2677 |
|
2676 | |||
2678 | This is mainly used by magic functions. |
|
2677 | This is mainly used by magic functions. | |
2679 |
|
2678 | |||
2680 | Parameters |
|
2679 | Parameters | |
2681 | ---------- |
|
2680 | ---------- | |
2682 | target : str |
|
2681 | target : str | |
2683 | A string specifying code to retrieve. This will be tried respectively |
|
2682 | A string specifying code to retrieve. This will be tried respectively | |
2684 | as: ranges of input history (see %history for syntax), a filename, or |
|
2683 | as: ranges of input history (see %history for syntax), a filename, or | |
2685 | an expression evaluating to a string or Macro in the user namespace. |
|
2684 | an expression evaluating to a string or Macro in the user namespace. | |
2686 | raw : bool |
|
2685 | raw : bool | |
2687 | If true (default), retrieve raw history. Has no effect on the other |
|
2686 | If true (default), retrieve raw history. Has no effect on the other | |
2688 | retrieval mechanisms. |
|
2687 | retrieval mechanisms. | |
2689 |
|
2688 | |||
2690 | Returns |
|
2689 | Returns | |
2691 | ------- |
|
2690 | ------- | |
2692 | A string of code. |
|
2691 | A string of code. | |
2693 |
|
2692 | |||
2694 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
2693 | ValueError is raised if nothing is found, and TypeError if it evaluates | |
2695 | to an object of another type. In each case, .args[0] is a printable |
|
2694 | to an object of another type. In each case, .args[0] is a printable | |
2696 | message. |
|
2695 | message. | |
2697 | """ |
|
2696 | """ | |
2698 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
2697 | code = self.extract_input_lines(target, raw=raw) # Grab history | |
2699 | if code: |
|
2698 | if code: | |
2700 | return code |
|
2699 | return code | |
2701 | if os.path.isfile(target): # Read file |
|
2700 | if os.path.isfile(target): # Read file | |
2702 | return open(target, "r").read() |
|
2701 | return open(target, "r").read() | |
2703 |
|
2702 | |||
2704 | try: # User namespace |
|
2703 | try: # User namespace | |
2705 | codeobj = eval(target, self.user_ns) |
|
2704 | codeobj = eval(target, self.user_ns) | |
2706 | except Exception: |
|
2705 | except Exception: | |
2707 | raise ValueError(("'%s' was not found in history, as a file, nor in" |
|
2706 | raise ValueError(("'%s' was not found in history, as a file, nor in" | |
2708 | " the user namespace.") % target) |
|
2707 | " the user namespace.") % target) | |
2709 | if isinstance(codeobj, basestring): |
|
2708 | if isinstance(codeobj, basestring): | |
2710 | return codeobj |
|
2709 | return codeobj | |
2711 | elif isinstance(codeobj, Macro): |
|
2710 | elif isinstance(codeobj, Macro): | |
2712 | return codeobj.value |
|
2711 | return codeobj.value | |
2713 |
|
2712 | |||
2714 | raise TypeError("%s is neither a string nor a macro." % target, |
|
2713 | raise TypeError("%s is neither a string nor a macro." % target, | |
2715 | codeobj) |
|
2714 | codeobj) | |
2716 |
|
2715 | |||
2717 | #------------------------------------------------------------------------- |
|
2716 | #------------------------------------------------------------------------- | |
2718 | # Things related to IPython exiting |
|
2717 | # Things related to IPython exiting | |
2719 | #------------------------------------------------------------------------- |
|
2718 | #------------------------------------------------------------------------- | |
2720 | def atexit_operations(self): |
|
2719 | def atexit_operations(self): | |
2721 | """This will be executed at the time of exit. |
|
2720 | """This will be executed at the time of exit. | |
2722 |
|
2721 | |||
2723 | Cleanup operations and saving of persistent data that is done |
|
2722 | Cleanup operations and saving of persistent data that is done | |
2724 | unconditionally by IPython should be performed here. |
|
2723 | unconditionally by IPython should be performed here. | |
2725 |
|
2724 | |||
2726 | For things that may depend on startup flags or platform specifics (such |
|
2725 | For things that may depend on startup flags or platform specifics (such | |
2727 | as having readline or not), register a separate atexit function in the |
|
2726 | as having readline or not), register a separate atexit function in the | |
2728 | code that has the appropriate information, rather than trying to |
|
2727 | code that has the appropriate information, rather than trying to | |
2729 | clutter |
|
2728 | clutter | |
2730 | """ |
|
2729 | """ | |
2731 | # Close the history session (this stores the end time and line count) |
|
2730 | # Close the history session (this stores the end time and line count) | |
2732 | # this must be *before* the tempfile cleanup, in case of temporary |
|
2731 | # this must be *before* the tempfile cleanup, in case of temporary | |
2733 | # history db |
|
2732 | # history db | |
2734 | self.history_manager.end_session() |
|
2733 | self.history_manager.end_session() | |
2735 |
|
2734 | |||
2736 | # Cleanup all tempfiles left around |
|
2735 | # Cleanup all tempfiles left around | |
2737 | for tfile in self.tempfiles: |
|
2736 | for tfile in self.tempfiles: | |
2738 | try: |
|
2737 | try: | |
2739 | os.unlink(tfile) |
|
2738 | os.unlink(tfile) | |
2740 | except OSError: |
|
2739 | except OSError: | |
2741 | pass |
|
2740 | pass | |
2742 |
|
2741 | |||
2743 | # Clear all user namespaces to release all references cleanly. |
|
2742 | # Clear all user namespaces to release all references cleanly. | |
2744 | self.reset(new_session=False) |
|
2743 | self.reset(new_session=False) | |
2745 |
|
2744 | |||
2746 | # Run user hooks |
|
2745 | # Run user hooks | |
2747 | self.hooks.shutdown_hook() |
|
2746 | self.hooks.shutdown_hook() | |
2748 |
|
2747 | |||
2749 | def cleanup(self): |
|
2748 | def cleanup(self): | |
2750 | self.restore_sys_module_state() |
|
2749 | self.restore_sys_module_state() | |
2751 |
|
2750 | |||
2752 |
|
2751 | |||
2753 | class InteractiveShellABC(object): |
|
2752 | class InteractiveShellABC(object): | |
2754 | """An abstract base class for InteractiveShell.""" |
|
2753 | """An abstract base class for InteractiveShell.""" | |
2755 | __metaclass__ = abc.ABCMeta |
|
2754 | __metaclass__ = abc.ABCMeta | |
2756 |
|
2755 | |||
2757 | InteractiveShellABC.register(InteractiveShell) |
|
2756 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,50 +1,50 b'' | |||||
1 | # coding: utf-8 |
|
1 | # coding: utf-8 | |
2 | """Tests for IPython.core.application""" |
|
2 | """Tests for IPython.core.application""" | |
3 |
|
3 | |||
4 | import os |
|
4 | import os | |
5 | import tempfile |
|
5 | import tempfile | |
6 |
|
6 | |||
7 | from IPython.core.application import BaseIPythonApplication |
|
7 | from IPython.core.application import BaseIPythonApplication | |
8 |
from IPython.testing import decorators as |
|
8 | from IPython.testing import decorators as dec | |
9 | from IPython.utils import py3compat |
|
9 | from IPython.utils import py3compat | |
10 |
|
10 | |||
11 |
@ |
|
11 | @dec.onlyif_unicode_paths | |
12 | def test_unicode_cwd(): |
|
12 | def test_unicode_cwd(): | |
13 | """Check that IPython starts with non-ascii characters in the path.""" |
|
13 | """Check that IPython starts with non-ascii characters in the path.""" | |
14 | wd = tempfile.mkdtemp(suffix=u"€") |
|
14 | wd = tempfile.mkdtemp(suffix=u"€") | |
15 |
|
15 | |||
16 | old_wd = os.getcwdu() |
|
16 | old_wd = os.getcwdu() | |
17 | os.chdir(wd) |
|
17 | os.chdir(wd) | |
18 | #raise Exception(repr(os.getcwdu())) |
|
18 | #raise Exception(repr(os.getcwdu())) | |
19 | try: |
|
19 | try: | |
20 | app = BaseIPythonApplication() |
|
20 | app = BaseIPythonApplication() | |
21 | # The lines below are copied from Application.initialize() |
|
21 | # The lines below are copied from Application.initialize() | |
22 | app.init_profile_dir() |
|
22 | app.init_profile_dir() | |
23 | app.init_config_files() |
|
23 | app.init_config_files() | |
24 | app.load_config_file(suppress_errors=False) |
|
24 | app.load_config_file(suppress_errors=False) | |
25 | finally: |
|
25 | finally: | |
26 | os.chdir(old_wd) |
|
26 | os.chdir(old_wd) | |
27 |
|
27 | |||
28 |
@ |
|
28 | @dec.onlyif_unicode_paths | |
29 | def test_unicode_ipdir(): |
|
29 | def test_unicode_ipdir(): | |
30 | """Check that IPython starts with non-ascii characters in the IP dir.""" |
|
30 | """Check that IPython starts with non-ascii characters in the IP dir.""" | |
31 | ipdir = tempfile.mkdtemp(suffix=u"€") |
|
31 | ipdir = tempfile.mkdtemp(suffix=u"€") | |
32 |
|
32 | |||
33 | # Create the config file, so it tries to load it. |
|
33 | # Create the config file, so it tries to load it. | |
34 | with open(os.path.join(ipdir, 'ipython_config.py'), "w") as f: |
|
34 | with open(os.path.join(ipdir, 'ipython_config.py'), "w") as f: | |
35 | pass |
|
35 | pass | |
36 |
|
36 | |||
37 | old_ipdir1 = os.environ.pop("IPYTHONDIR", None) |
|
37 | old_ipdir1 = os.environ.pop("IPYTHONDIR", None) | |
38 | old_ipdir2 = os.environ.pop("IPYTHON_DIR", None) |
|
38 | old_ipdir2 = os.environ.pop("IPYTHON_DIR", None) | |
39 | os.environ["IPYTHONDIR"] = py3compat.unicode_to_str(ipdir, "utf-8") |
|
39 | os.environ["IPYTHONDIR"] = py3compat.unicode_to_str(ipdir, "utf-8") | |
40 | try: |
|
40 | try: | |
41 | app = BaseIPythonApplication() |
|
41 | app = BaseIPythonApplication() | |
42 | # The lines below are copied from Application.initialize() |
|
42 | # The lines below are copied from Application.initialize() | |
43 | app.init_profile_dir() |
|
43 | app.init_profile_dir() | |
44 | app.init_config_files() |
|
44 | app.init_config_files() | |
45 | app.load_config_file(suppress_errors=False) |
|
45 | app.load_config_file(suppress_errors=False) | |
46 | finally: |
|
46 | finally: | |
47 | if old_ipdir1: |
|
47 | if old_ipdir1: | |
48 | os.environ["IPYTHONDIR"] = old_ipdir1 |
|
48 | os.environ["IPYTHONDIR"] = old_ipdir1 | |
49 | if old_ipdir2: |
|
49 | if old_ipdir2: | |
50 | os.environ["IPYTHONDIR"] = old_ipdir2 |
|
50 | os.environ["IPYTHONDIR"] = old_ipdir2 |
@@ -1,69 +1,67 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Tests for completerlib. |
|
2 | """Tests for completerlib. | |
3 |
|
3 | |||
4 | """ |
|
4 | """ | |
5 | from __future__ import absolute_import |
|
5 | from __future__ import absolute_import | |
6 |
|
6 | |||
7 | #----------------------------------------------------------------------------- |
|
7 | #----------------------------------------------------------------------------- | |
8 | # Imports |
|
8 | # Imports | |
9 | #----------------------------------------------------------------------------- |
|
9 | #----------------------------------------------------------------------------- | |
10 |
|
10 | |||
11 | import os |
|
11 | import os | |
12 | import shutil |
|
12 | import shutil | |
13 | import sys |
|
13 | import sys | |
14 | import tempfile |
|
14 | import tempfile | |
15 | import unittest |
|
15 | import unittest | |
16 | from os.path import join |
|
16 | from os.path import join | |
17 |
|
17 | |||
18 | import nose.tools as nt |
|
18 | import nose.tools as nt | |
19 | from nose import SkipTest |
|
19 | from nose import SkipTest | |
20 |
|
20 | |||
21 | from IPython.core.completerlib import magic_run_completer |
|
21 | from IPython.core.completerlib import magic_run_completer | |
22 | from IPython.testing import decorators as dec |
|
|||
23 | from IPython.testing import tools as tt |
|
|||
24 | from IPython.utils import py3compat |
|
22 | from IPython.utils import py3compat | |
25 |
|
23 | |||
26 |
|
24 | |||
27 | class MockEvent(object): |
|
25 | class MockEvent(object): | |
28 | def __init__(self, line): |
|
26 | def __init__(self, line): | |
29 | self.line = line |
|
27 | self.line = line | |
30 |
|
28 | |||
31 | #----------------------------------------------------------------------------- |
|
29 | #----------------------------------------------------------------------------- | |
32 | # Test functions begin |
|
30 | # Test functions begin | |
33 | #----------------------------------------------------------------------------- |
|
31 | #----------------------------------------------------------------------------- | |
34 | class Test_magic_run_completer(unittest.TestCase): |
|
32 | class Test_magic_run_completer(unittest.TestCase): | |
35 | def setUp(self): |
|
33 | def setUp(self): | |
36 | self.BASETESTDIR = tempfile.mkdtemp() |
|
34 | self.BASETESTDIR = tempfile.mkdtemp() | |
37 | for fil in [u"aaø.py", u"a.py", u"b.py"]: |
|
35 | for fil in [u"aaø.py", u"a.py", u"b.py"]: | |
38 | with open(join(self.BASETESTDIR, fil), "w") as sfile: |
|
36 | with open(join(self.BASETESTDIR, fil), "w") as sfile: | |
39 | sfile.write("pass\n") |
|
37 | sfile.write("pass\n") | |
40 | self.oldpath = os.getcwdu() |
|
38 | self.oldpath = os.getcwdu() | |
41 | os.chdir(self.BASETESTDIR) |
|
39 | os.chdir(self.BASETESTDIR) | |
42 |
|
40 | |||
43 | def tearDown(self): |
|
41 | def tearDown(self): | |
44 | os.chdir(self.oldpath) |
|
42 | os.chdir(self.oldpath) | |
45 | shutil.rmtree(self.BASETESTDIR) |
|
43 | shutil.rmtree(self.BASETESTDIR) | |
46 |
|
44 | |||
47 | def test_1(self): |
|
45 | def test_1(self): | |
48 | """Test magic_run_completer, should match two alterntives |
|
46 | """Test magic_run_completer, should match two alterntives | |
49 | """ |
|
47 | """ | |
50 | event = MockEvent(u"%run a") |
|
48 | event = MockEvent(u"%run a") | |
51 | mockself = None |
|
49 | mockself = None | |
52 | match = set(magic_run_completer(mockself, event)) |
|
50 | match = set(magic_run_completer(mockself, event)) | |
53 | self.assertEqual(match, set([u"a.py", u"aaø.py"])) |
|
51 | self.assertEqual(match, set([u"a.py", u"aaø.py"])) | |
54 |
|
52 | |||
55 | def test_2(self): |
|
53 | def test_2(self): | |
56 | """Test magic_run_completer, should match one alterntive |
|
54 | """Test magic_run_completer, should match one alterntive | |
57 | """ |
|
55 | """ | |
58 | event = MockEvent(u"%run aa") |
|
56 | event = MockEvent(u"%run aa") | |
59 | mockself = None |
|
57 | mockself = None | |
60 | match = set(magic_run_completer(mockself, event)) |
|
58 | match = set(magic_run_completer(mockself, event)) | |
61 | self.assertEqual(match, set([u"aaø.py"])) |
|
59 | self.assertEqual(match, set([u"aaø.py"])) | |
62 |
|
60 | |||
63 | def test_3(self): |
|
61 | def test_3(self): | |
64 | """Test magic_run_completer with unterminated " """ |
|
62 | """Test magic_run_completer with unterminated " """ | |
65 | event = MockEvent(u'%run "a') |
|
63 | event = MockEvent(u'%run "a') | |
66 | mockself = None |
|
64 | mockself = None | |
67 | match = set(magic_run_completer(mockself, event)) |
|
65 | match = set(magic_run_completer(mockself, event)) | |
68 | self.assertEqual(match, set([u"a.py", u"aaø.py"])) |
|
66 | self.assertEqual(match, set([u"a.py", u"aaø.py"])) | |
69 |
|
67 |
@@ -1,170 +1,169 b'' | |||||
1 | """Tests for input handlers. |
|
1 | """Tests for input handlers. | |
2 | """ |
|
2 | """ | |
3 | #----------------------------------------------------------------------------- |
|
3 | #----------------------------------------------------------------------------- | |
4 | # Module imports |
|
4 | # Module imports | |
5 | #----------------------------------------------------------------------------- |
|
5 | #----------------------------------------------------------------------------- | |
6 |
|
6 | |||
7 | # third party |
|
7 | # third party | |
8 | import nose.tools as nt |
|
8 | import nose.tools as nt | |
9 |
|
9 | |||
10 | # our own packages |
|
10 | # our own packages | |
11 | from IPython.core import autocall |
|
11 | from IPython.core import autocall | |
12 | from IPython.testing import decorators as dec |
|
|||
13 | from IPython.testing import tools as tt |
|
12 | from IPython.testing import tools as tt | |
14 | from IPython.testing.globalipapp import get_ipython |
|
13 | from IPython.testing.globalipapp import get_ipython | |
15 | from IPython.utils import py3compat |
|
14 | from IPython.utils import py3compat | |
16 |
|
15 | |||
17 | #----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
18 | # Globals |
|
17 | # Globals | |
19 | #----------------------------------------------------------------------------- |
|
18 | #----------------------------------------------------------------------------- | |
20 |
|
19 | |||
21 | # Get the public instance of IPython |
|
20 | # Get the public instance of IPython | |
22 | ip = get_ipython() |
|
21 | ip = get_ipython() | |
23 |
|
22 | |||
24 | failures = [] |
|
23 | failures = [] | |
25 | num_tests = 0 |
|
24 | num_tests = 0 | |
26 |
|
25 | |||
27 | #----------------------------------------------------------------------------- |
|
26 | #----------------------------------------------------------------------------- | |
28 | # Test functions |
|
27 | # Test functions | |
29 | #----------------------------------------------------------------------------- |
|
28 | #----------------------------------------------------------------------------- | |
30 |
|
29 | |||
31 | class CallableIndexable(object): |
|
30 | class CallableIndexable(object): | |
32 | def __getitem__(self, idx): return True |
|
31 | def __getitem__(self, idx): return True | |
33 | def __call__(self, *args, **kws): return True |
|
32 | def __call__(self, *args, **kws): return True | |
34 |
|
33 | |||
35 |
|
34 | |||
36 | class Autocallable(autocall.IPyAutocall): |
|
35 | class Autocallable(autocall.IPyAutocall): | |
37 | def __call__(self): |
|
36 | def __call__(self): | |
38 | return "called" |
|
37 | return "called" | |
39 |
|
38 | |||
40 |
|
39 | |||
41 | def run(tests): |
|
40 | def run(tests): | |
42 | """Loop through a list of (pre, post) inputs, where pre is the string |
|
41 | """Loop through a list of (pre, post) inputs, where pre is the string | |
43 | handed to ipython, and post is how that string looks after it's been |
|
42 | handed to ipython, and post is how that string looks after it's been | |
44 | transformed (i.e. ipython's notion of _i)""" |
|
43 | transformed (i.e. ipython's notion of _i)""" | |
45 | tt.check_pairs(ip.prefilter_manager.prefilter_lines, tests) |
|
44 | tt.check_pairs(ip.prefilter_manager.prefilter_lines, tests) | |
46 |
|
45 | |||
47 |
|
46 | |||
48 | def test_handlers(): |
|
47 | def test_handlers(): | |
49 | # alias expansion |
|
48 | # alias expansion | |
50 |
|
49 | |||
51 | # We're using 'true' as our syscall of choice because it doesn't |
|
50 | # We're using 'true' as our syscall of choice because it doesn't | |
52 | # write anything to stdout. |
|
51 | # write anything to stdout. | |
53 |
|
52 | |||
54 | # Turn off actual execution of aliases, because it's noisy |
|
53 | # Turn off actual execution of aliases, because it's noisy | |
55 | old_system_cmd = ip.system |
|
54 | old_system_cmd = ip.system | |
56 | ip.system = lambda cmd: None |
|
55 | ip.system = lambda cmd: None | |
57 |
|
56 | |||
58 |
|
57 | |||
59 | ip.alias_manager.alias_table['an_alias'] = (0, 'true') |
|
58 | ip.alias_manager.alias_table['an_alias'] = (0, 'true') | |
60 | # These are useful for checking a particular recursive alias issue |
|
59 | # These are useful for checking a particular recursive alias issue | |
61 | ip.alias_manager.alias_table['top'] = (0, 'd:/cygwin/top') |
|
60 | ip.alias_manager.alias_table['top'] = (0, 'd:/cygwin/top') | |
62 | ip.alias_manager.alias_table['d'] = (0, 'true') |
|
61 | ip.alias_manager.alias_table['d'] = (0, 'true') | |
63 | run([(i,py3compat.u_format(o)) for i,o in \ |
|
62 | run([(i,py3compat.u_format(o)) for i,o in \ | |
64 | [("an_alias", "get_ipython().system({u}'true ')"), # alias |
|
63 | [("an_alias", "get_ipython().system({u}'true ')"), # alias | |
65 | # Below: recursive aliases should expand whitespace-surrounded |
|
64 | # Below: recursive aliases should expand whitespace-surrounded | |
66 | # chars, *not* initial chars which happen to be aliases: |
|
65 | # chars, *not* initial chars which happen to be aliases: | |
67 | ("top", "get_ipython().system({u}'d:/cygwin/top ')"), |
|
66 | ("top", "get_ipython().system({u}'d:/cygwin/top ')"), | |
68 | ]]) |
|
67 | ]]) | |
69 | ip.system = old_system_cmd |
|
68 | ip.system = old_system_cmd | |
70 |
|
69 | |||
71 | call_idx = CallableIndexable() |
|
70 | call_idx = CallableIndexable() | |
72 | ip.user_ns['call_idx'] = call_idx |
|
71 | ip.user_ns['call_idx'] = call_idx | |
73 |
|
72 | |||
74 | # For many of the below, we're also checking that leading whitespace |
|
73 | # For many of the below, we're also checking that leading whitespace | |
75 | # turns off the esc char, which it should unless there is a continuation |
|
74 | # turns off the esc char, which it should unless there is a continuation | |
76 | # line. |
|
75 | # line. | |
77 | run([(i,py3compat.u_format(o)) for i,o in \ |
|
76 | run([(i,py3compat.u_format(o)) for i,o in \ | |
78 | [('"no change"', '"no change"'), # normal |
|
77 | [('"no change"', '"no change"'), # normal | |
79 | (u"!true", "get_ipython().system({u}'true')"), # shell_escapes |
|
78 | (u"!true", "get_ipython().system({u}'true')"), # shell_escapes | |
80 | (u"!! true", "get_ipython().magic({u}'sx true')"), # shell_escapes + magic |
|
79 | (u"!! true", "get_ipython().magic({u}'sx true')"), # shell_escapes + magic | |
81 | (u"!!true", "get_ipython().magic({u}'sx true')"), # shell_escapes + magic |
|
80 | (u"!!true", "get_ipython().magic({u}'sx true')"), # shell_escapes + magic | |
82 | (u"%lsmagic", "get_ipython().magic({u}'lsmagic ')"), # magic |
|
81 | (u"%lsmagic", "get_ipython().magic({u}'lsmagic ')"), # magic | |
83 | (u"lsmagic", "get_ipython().magic({u}'lsmagic ')"), # magic |
|
82 | (u"lsmagic", "get_ipython().magic({u}'lsmagic ')"), # magic | |
84 | #("a = b # PYTHON-MODE", '_i'), # emacs -- avoids _in cache |
|
83 | #("a = b # PYTHON-MODE", '_i'), # emacs -- avoids _in cache | |
85 |
|
84 | |||
86 | # post-esc-char whitespace goes inside |
|
85 | # post-esc-char whitespace goes inside | |
87 | (u"! true", "get_ipython().system({u}' true')"), |
|
86 | (u"! true", "get_ipython().system({u}' true')"), | |
88 |
|
87 | |||
89 | # handle_help |
|
88 | # handle_help | |
90 |
|
89 | |||
91 | # These are weak tests -- just looking at what the help handlers |
|
90 | # These are weak tests -- just looking at what the help handlers | |
92 | # logs, which is not how it really does its work. But it still |
|
91 | # logs, which is not how it really does its work. But it still | |
93 | # lets us check the key paths through the handler. |
|
92 | # lets us check the key paths through the handler. | |
94 |
|
93 | |||
95 | ("x=1 # what?", "x=1 # what?"), # no help if valid python |
|
94 | ("x=1 # what?", "x=1 # what?"), # no help if valid python | |
96 | ]]) |
|
95 | ]]) | |
97 |
|
96 | |||
98 | # multi_line_specials |
|
97 | # multi_line_specials | |
99 | ip.prefilter_manager.multi_line_specials = False |
|
98 | ip.prefilter_manager.multi_line_specials = False | |
100 | # W/ multi_line_specials off, leading ws kills esc chars/autoexpansion |
|
99 | # W/ multi_line_specials off, leading ws kills esc chars/autoexpansion | |
101 | run([ |
|
100 | run([ | |
102 | (u'if 1:\n !true', u'if 1:\n !true'), |
|
101 | (u'if 1:\n !true', u'if 1:\n !true'), | |
103 | (u'if 1:\n lsmagic', u'if 1:\n lsmagic'), |
|
102 | (u'if 1:\n lsmagic', u'if 1:\n lsmagic'), | |
104 | (u'if 1:\n an_alias', u'if 1:\n an_alias'), |
|
103 | (u'if 1:\n an_alias', u'if 1:\n an_alias'), | |
105 | ]) |
|
104 | ]) | |
106 |
|
105 | |||
107 | ip.prefilter_manager.multi_line_specials = True |
|
106 | ip.prefilter_manager.multi_line_specials = True | |
108 | # initial indents must be preserved. |
|
107 | # initial indents must be preserved. | |
109 | run([(i,py3compat.u_format(o)) for i,o in \ |
|
108 | run([(i,py3compat.u_format(o)) for i,o in \ | |
110 | [(u'if 1:\n !true', "if 1:\n get_ipython().system({u}'true')"), |
|
109 | [(u'if 1:\n !true', "if 1:\n get_ipython().system({u}'true')"), | |
111 | (u'if 2:\n lsmagic', "if 2:\n get_ipython().magic({u}'lsmagic ')"), |
|
110 | (u'if 2:\n lsmagic', "if 2:\n get_ipython().magic({u}'lsmagic ')"), | |
112 | (u'if 1:\n an_alias', "if 1:\n get_ipython().system({u}'true ')"), |
|
111 | (u'if 1:\n an_alias', "if 1:\n get_ipython().system({u}'true ')"), | |
113 | # Weird one |
|
112 | # Weird one | |
114 | (u'if 1:\n !!true', "if 1:\n get_ipython().magic({u}'sx true')"), |
|
113 | (u'if 1:\n !!true', "if 1:\n get_ipython().magic({u}'sx true')"), | |
115 |
|
114 | |||
116 | # Even with m_l_s on, autocall is off even with special chars |
|
115 | # Even with m_l_s on, autocall is off even with special chars | |
117 | ('if 1:\n /fun 1 2', 'if 1:\n /fun 1 2'), |
|
116 | ('if 1:\n /fun 1 2', 'if 1:\n /fun 1 2'), | |
118 | ('if 1:\n ;fun 1 2', 'if 1:\n ;fun 1 2'), |
|
117 | ('if 1:\n ;fun 1 2', 'if 1:\n ;fun 1 2'), | |
119 | ('if 1:\n ,fun 1 2', 'if 1:\n ,fun 1 2'), |
|
118 | ('if 1:\n ,fun 1 2', 'if 1:\n ,fun 1 2'), | |
120 | ('if 1:\n ?fun 1 2', 'if 1:\n ?fun 1 2'), |
|
119 | ('if 1:\n ?fun 1 2', 'if 1:\n ?fun 1 2'), | |
121 | # What about !! |
|
120 | # What about !! | |
122 | ]]) |
|
121 | ]]) | |
123 |
|
122 | |||
124 | # Objects which are instances of IPyAutocall are *always* autocalled |
|
123 | # Objects which are instances of IPyAutocall are *always* autocalled | |
125 | autocallable = Autocallable() |
|
124 | autocallable = Autocallable() | |
126 | ip.user_ns['autocallable'] = autocallable |
|
125 | ip.user_ns['autocallable'] = autocallable | |
127 |
|
126 | |||
128 | # auto |
|
127 | # auto | |
129 | ip.magic('autocall 0') |
|
128 | ip.magic('autocall 0') | |
130 | # Only explicit escapes or instances of IPyAutocallable should get |
|
129 | # Only explicit escapes or instances of IPyAutocallable should get | |
131 | # expanded |
|
130 | # expanded | |
132 | run([ |
|
131 | run([ | |
133 | ('len "abc"', 'len "abc"'), |
|
132 | ('len "abc"', 'len "abc"'), | |
134 | ('autocallable', 'autocallable()'), |
|
133 | ('autocallable', 'autocallable()'), | |
135 | # Don't add extra brackets (gh-1117) |
|
134 | # Don't add extra brackets (gh-1117) | |
136 | ('autocallable()', 'autocallable()'), |
|
135 | ('autocallable()', 'autocallable()'), | |
137 | (",list 1 2 3", 'list("1", "2", "3")'), |
|
136 | (",list 1 2 3", 'list("1", "2", "3")'), | |
138 | (";list 1 2 3", 'list("1 2 3")'), |
|
137 | (";list 1 2 3", 'list("1 2 3")'), | |
139 | ("/len range(1,4)", 'len(range(1,4))'), |
|
138 | ("/len range(1,4)", 'len(range(1,4))'), | |
140 | ]) |
|
139 | ]) | |
141 | ip.magic('autocall 1') |
|
140 | ip.magic('autocall 1') | |
142 | run([ |
|
141 | run([ | |
143 | (",list 1 2 3", 'list("1", "2", "3")'), |
|
142 | (",list 1 2 3", 'list("1", "2", "3")'), | |
144 | (";list 1 2 3", 'list("1 2 3")'), |
|
143 | (";list 1 2 3", 'list("1 2 3")'), | |
145 | ("/len range(1,4)", 'len(range(1,4))'), |
|
144 | ("/len range(1,4)", 'len(range(1,4))'), | |
146 | ('len "abc"', 'len("abc")'), |
|
145 | ('len "abc"', 'len("abc")'), | |
147 | ('len "abc";', 'len("abc");'), # ; is special -- moves out of parens |
|
146 | ('len "abc";', 'len("abc");'), # ; is special -- moves out of parens | |
148 | # Autocall is turned off if first arg is [] and the object |
|
147 | # Autocall is turned off if first arg is [] and the object | |
149 | # is both callable and indexable. Like so: |
|
148 | # is both callable and indexable. Like so: | |
150 | ('len [1,2]', 'len([1,2])'), # len doesn't support __getitem__... |
|
149 | ('len [1,2]', 'len([1,2])'), # len doesn't support __getitem__... | |
151 | ('call_idx [1]', 'call_idx [1]'), # call_idx *does*.. |
|
150 | ('call_idx [1]', 'call_idx [1]'), # call_idx *does*.. | |
152 | ('call_idx 1', 'call_idx(1)'), |
|
151 | ('call_idx 1', 'call_idx(1)'), | |
153 | ('len', 'len'), # only at 2 does it auto-call on single args |
|
152 | ('len', 'len'), # only at 2 does it auto-call on single args | |
154 | ]) |
|
153 | ]) | |
155 | ip.magic('autocall 2') |
|
154 | ip.magic('autocall 2') | |
156 | run([ |
|
155 | run([ | |
157 | (",list 1 2 3", 'list("1", "2", "3")'), |
|
156 | (",list 1 2 3", 'list("1", "2", "3")'), | |
158 | (";list 1 2 3", 'list("1 2 3")'), |
|
157 | (";list 1 2 3", 'list("1 2 3")'), | |
159 | ("/len range(1,4)", 'len(range(1,4))'), |
|
158 | ("/len range(1,4)", 'len(range(1,4))'), | |
160 | ('len "abc"', 'len("abc")'), |
|
159 | ('len "abc"', 'len("abc")'), | |
161 | ('len "abc";', 'len("abc");'), |
|
160 | ('len "abc";', 'len("abc");'), | |
162 | ('len [1,2]', 'len([1,2])'), |
|
161 | ('len [1,2]', 'len([1,2])'), | |
163 | ('call_idx [1]', 'call_idx [1]'), |
|
162 | ('call_idx [1]', 'call_idx [1]'), | |
164 | ('call_idx 1', 'call_idx(1)'), |
|
163 | ('call_idx 1', 'call_idx(1)'), | |
165 | # This is what's different: |
|
164 | # This is what's different: | |
166 | ('len', 'len()'), # only at 2 does it auto-call on single args |
|
165 | ('len', 'len()'), # only at 2 does it auto-call on single args | |
167 | ]) |
|
166 | ]) | |
168 | ip.magic('autocall 1') |
|
167 | ip.magic('autocall 1') | |
169 |
|
168 | |||
170 | nt.assert_equals(failures, []) |
|
169 | nt.assert_equals(failures, []) |
@@ -1,278 +1,277 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Tests for the key interactiveshell module. |
|
2 | """Tests for the key interactiveshell module. | |
3 |
|
3 | |||
4 | Historically the main classes in interactiveshell have been under-tested. This |
|
4 | Historically the main classes in interactiveshell have been under-tested. This | |
5 | module should grow as many single-method tests as possible to trap many of the |
|
5 | module should grow as many single-method tests as possible to trap many of the | |
6 | recurring bugs we seem to encounter with high-level interaction. |
|
6 | recurring bugs we seem to encounter with high-level interaction. | |
7 |
|
7 | |||
8 | Authors |
|
8 | Authors | |
9 | ------- |
|
9 | ------- | |
10 | * Fernando Perez |
|
10 | * Fernando Perez | |
11 | """ |
|
11 | """ | |
12 | #----------------------------------------------------------------------------- |
|
12 | #----------------------------------------------------------------------------- | |
13 | # Copyright (C) 2011 The IPython Development Team |
|
13 | # Copyright (C) 2011 The IPython Development Team | |
14 | # |
|
14 | # | |
15 | # Distributed under the terms of the BSD License. The full license is in |
|
15 | # Distributed under the terms of the BSD License. The full license is in | |
16 | # the file COPYING, distributed as part of this software. |
|
16 | # the file COPYING, distributed as part of this software. | |
17 | #----------------------------------------------------------------------------- |
|
17 | #----------------------------------------------------------------------------- | |
18 |
|
18 | |||
19 | #----------------------------------------------------------------------------- |
|
19 | #----------------------------------------------------------------------------- | |
20 | # Imports |
|
20 | # Imports | |
21 | #----------------------------------------------------------------------------- |
|
21 | #----------------------------------------------------------------------------- | |
22 | # stdlib |
|
22 | # stdlib | |
23 | import os |
|
23 | import os | |
24 | import shutil |
|
24 | import shutil | |
25 | import tempfile |
|
25 | import tempfile | |
26 | import unittest |
|
26 | import unittest | |
27 | from os.path import join |
|
27 | from os.path import join | |
28 | import sys |
|
28 | import sys | |
29 | from StringIO import StringIO |
|
29 | from StringIO import StringIO | |
30 |
|
30 | |||
31 | from IPython.testing import decorators as dec |
|
|||
32 | from IPython.utils import io |
|
31 | from IPython.utils import io | |
33 |
|
32 | |||
34 | #----------------------------------------------------------------------------- |
|
33 | #----------------------------------------------------------------------------- | |
35 | # Tests |
|
34 | # Tests | |
36 | #----------------------------------------------------------------------------- |
|
35 | #----------------------------------------------------------------------------- | |
37 |
|
36 | |||
38 | class InteractiveShellTestCase(unittest.TestCase): |
|
37 | class InteractiveShellTestCase(unittest.TestCase): | |
39 | def test_naked_string_cells(self): |
|
38 | def test_naked_string_cells(self): | |
40 | """Test that cells with only naked strings are fully executed""" |
|
39 | """Test that cells with only naked strings are fully executed""" | |
41 | ip = get_ipython() |
|
40 | ip = get_ipython() | |
42 | # First, single-line inputs |
|
41 | # First, single-line inputs | |
43 | ip.run_cell('"a"\n') |
|
42 | ip.run_cell('"a"\n') | |
44 | self.assertEquals(ip.user_ns['_'], 'a') |
|
43 | self.assertEquals(ip.user_ns['_'], 'a') | |
45 | # And also multi-line cells |
|
44 | # And also multi-line cells | |
46 | ip.run_cell('"""a\nb"""\n') |
|
45 | ip.run_cell('"""a\nb"""\n') | |
47 | self.assertEquals(ip.user_ns['_'], 'a\nb') |
|
46 | self.assertEquals(ip.user_ns['_'], 'a\nb') | |
48 |
|
47 | |||
49 | def test_run_empty_cell(self): |
|
48 | def test_run_empty_cell(self): | |
50 | """Just make sure we don't get a horrible error with a blank |
|
49 | """Just make sure we don't get a horrible error with a blank | |
51 | cell of input. Yes, I did overlook that.""" |
|
50 | cell of input. Yes, I did overlook that.""" | |
52 | ip = get_ipython() |
|
51 | ip = get_ipython() | |
53 | old_xc = ip.execution_count |
|
52 | old_xc = ip.execution_count | |
54 | ip.run_cell('') |
|
53 | ip.run_cell('') | |
55 | self.assertEquals(ip.execution_count, old_xc) |
|
54 | self.assertEquals(ip.execution_count, old_xc) | |
56 |
|
55 | |||
57 | def test_run_cell_multiline(self): |
|
56 | def test_run_cell_multiline(self): | |
58 | """Multi-block, multi-line cells must execute correctly. |
|
57 | """Multi-block, multi-line cells must execute correctly. | |
59 | """ |
|
58 | """ | |
60 | ip = get_ipython() |
|
59 | ip = get_ipython() | |
61 | src = '\n'.join(["x=1", |
|
60 | src = '\n'.join(["x=1", | |
62 | "y=2", |
|
61 | "y=2", | |
63 | "if 1:", |
|
62 | "if 1:", | |
64 | " x += 1", |
|
63 | " x += 1", | |
65 | " y += 1",]) |
|
64 | " y += 1",]) | |
66 | ip.run_cell(src) |
|
65 | ip.run_cell(src) | |
67 | self.assertEquals(ip.user_ns['x'], 2) |
|
66 | self.assertEquals(ip.user_ns['x'], 2) | |
68 | self.assertEquals(ip.user_ns['y'], 3) |
|
67 | self.assertEquals(ip.user_ns['y'], 3) | |
69 |
|
68 | |||
70 | def test_multiline_string_cells(self): |
|
69 | def test_multiline_string_cells(self): | |
71 | "Code sprinkled with multiline strings should execute (GH-306)" |
|
70 | "Code sprinkled with multiline strings should execute (GH-306)" | |
72 | ip = get_ipython() |
|
71 | ip = get_ipython() | |
73 | ip.run_cell('tmp=0') |
|
72 | ip.run_cell('tmp=0') | |
74 | self.assertEquals(ip.user_ns['tmp'], 0) |
|
73 | self.assertEquals(ip.user_ns['tmp'], 0) | |
75 | ip.run_cell('tmp=1;"""a\nb"""\n') |
|
74 | ip.run_cell('tmp=1;"""a\nb"""\n') | |
76 | self.assertEquals(ip.user_ns['tmp'], 1) |
|
75 | self.assertEquals(ip.user_ns['tmp'], 1) | |
77 |
|
76 | |||
78 | def test_dont_cache_with_semicolon(self): |
|
77 | def test_dont_cache_with_semicolon(self): | |
79 | "Ending a line with semicolon should not cache the returned object (GH-307)" |
|
78 | "Ending a line with semicolon should not cache the returned object (GH-307)" | |
80 | ip = get_ipython() |
|
79 | ip = get_ipython() | |
81 | oldlen = len(ip.user_ns['Out']) |
|
80 | oldlen = len(ip.user_ns['Out']) | |
82 | a = ip.run_cell('1;', store_history=True) |
|
81 | a = ip.run_cell('1;', store_history=True) | |
83 | newlen = len(ip.user_ns['Out']) |
|
82 | newlen = len(ip.user_ns['Out']) | |
84 | self.assertEquals(oldlen, newlen) |
|
83 | self.assertEquals(oldlen, newlen) | |
85 | #also test the default caching behavior |
|
84 | #also test the default caching behavior | |
86 | ip.run_cell('1', store_history=True) |
|
85 | ip.run_cell('1', store_history=True) | |
87 | newlen = len(ip.user_ns['Out']) |
|
86 | newlen = len(ip.user_ns['Out']) | |
88 | self.assertEquals(oldlen+1, newlen) |
|
87 | self.assertEquals(oldlen+1, newlen) | |
89 |
|
88 | |||
90 | def test_In_variable(self): |
|
89 | def test_In_variable(self): | |
91 | "Verify that In variable grows with user input (GH-284)" |
|
90 | "Verify that In variable grows with user input (GH-284)" | |
92 | ip = get_ipython() |
|
91 | ip = get_ipython() | |
93 | oldlen = len(ip.user_ns['In']) |
|
92 | oldlen = len(ip.user_ns['In']) | |
94 | ip.run_cell('1;', store_history=True) |
|
93 | ip.run_cell('1;', store_history=True) | |
95 | newlen = len(ip.user_ns['In']) |
|
94 | newlen = len(ip.user_ns['In']) | |
96 | self.assertEquals(oldlen+1, newlen) |
|
95 | self.assertEquals(oldlen+1, newlen) | |
97 | self.assertEquals(ip.user_ns['In'][-1],'1;') |
|
96 | self.assertEquals(ip.user_ns['In'][-1],'1;') | |
98 |
|
97 | |||
99 | def test_magic_names_in_string(self): |
|
98 | def test_magic_names_in_string(self): | |
100 | ip = get_ipython() |
|
99 | ip = get_ipython() | |
101 | ip.run_cell('a = """\n%exit\n"""') |
|
100 | ip.run_cell('a = """\n%exit\n"""') | |
102 | self.assertEquals(ip.user_ns['a'], '\n%exit\n') |
|
101 | self.assertEquals(ip.user_ns['a'], '\n%exit\n') | |
103 |
|
102 | |||
104 | def test_alias_crash(self): |
|
103 | def test_alias_crash(self): | |
105 | """Errors in prefilter can't crash IPython""" |
|
104 | """Errors in prefilter can't crash IPython""" | |
106 | ip = get_ipython() |
|
105 | ip = get_ipython() | |
107 | ip.run_cell('%alias parts echo first %s second %s') |
|
106 | ip.run_cell('%alias parts echo first %s second %s') | |
108 | # capture stderr: |
|
107 | # capture stderr: | |
109 | save_err = io.stderr |
|
108 | save_err = io.stderr | |
110 | io.stderr = StringIO() |
|
109 | io.stderr = StringIO() | |
111 | ip.run_cell('parts 1') |
|
110 | ip.run_cell('parts 1') | |
112 | err = io.stderr.getvalue() |
|
111 | err = io.stderr.getvalue() | |
113 | io.stderr = save_err |
|
112 | io.stderr = save_err | |
114 | self.assertEquals(err.split(':')[0], 'ERROR') |
|
113 | self.assertEquals(err.split(':')[0], 'ERROR') | |
115 |
|
114 | |||
116 | def test_trailing_newline(self): |
|
115 | def test_trailing_newline(self): | |
117 | """test that running !(command) does not raise a SyntaxError""" |
|
116 | """test that running !(command) does not raise a SyntaxError""" | |
118 | ip = get_ipython() |
|
117 | ip = get_ipython() | |
119 | ip.run_cell('!(true)\n', False) |
|
118 | ip.run_cell('!(true)\n', False) | |
120 | ip.run_cell('!(true)\n\n\n', False) |
|
119 | ip.run_cell('!(true)\n\n\n', False) | |
121 |
|
120 | |||
122 | def test_gh_597(self): |
|
121 | def test_gh_597(self): | |
123 | """Pretty-printing lists of objects with non-ascii reprs may cause |
|
122 | """Pretty-printing lists of objects with non-ascii reprs may cause | |
124 | problems.""" |
|
123 | problems.""" | |
125 | class Spam(object): |
|
124 | class Spam(object): | |
126 | def __repr__(self): |
|
125 | def __repr__(self): | |
127 | return "\xe9"*50 |
|
126 | return "\xe9"*50 | |
128 | import IPython.core.formatters |
|
127 | import IPython.core.formatters | |
129 | f = IPython.core.formatters.PlainTextFormatter() |
|
128 | f = IPython.core.formatters.PlainTextFormatter() | |
130 | f([Spam(),Spam()]) |
|
129 | f([Spam(),Spam()]) | |
131 |
|
130 | |||
132 |
|
131 | |||
133 | def test_future_flags(self): |
|
132 | def test_future_flags(self): | |
134 | """Check that future flags are used for parsing code (gh-777)""" |
|
133 | """Check that future flags are used for parsing code (gh-777)""" | |
135 | ip = get_ipython() |
|
134 | ip = get_ipython() | |
136 | ip.run_cell('from __future__ import print_function') |
|
135 | ip.run_cell('from __future__ import print_function') | |
137 | try: |
|
136 | try: | |
138 | ip.run_cell('prfunc_return_val = print(1,2, sep=" ")') |
|
137 | ip.run_cell('prfunc_return_val = print(1,2, sep=" ")') | |
139 | assert 'prfunc_return_val' in ip.user_ns |
|
138 | assert 'prfunc_return_val' in ip.user_ns | |
140 | finally: |
|
139 | finally: | |
141 | # Reset compiler flags so we don't mess up other tests. |
|
140 | # Reset compiler flags so we don't mess up other tests. | |
142 | ip.compile.reset_compiler_flags() |
|
141 | ip.compile.reset_compiler_flags() | |
143 |
|
142 | |||
144 | def test_future_unicode(self): |
|
143 | def test_future_unicode(self): | |
145 | """Check that unicode_literals is imported from __future__ (gh #786)""" |
|
144 | """Check that unicode_literals is imported from __future__ (gh #786)""" | |
146 | ip = get_ipython() |
|
145 | ip = get_ipython() | |
147 | try: |
|
146 | try: | |
148 | ip.run_cell(u'byte_str = "a"') |
|
147 | ip.run_cell(u'byte_str = "a"') | |
149 | assert isinstance(ip.user_ns['byte_str'], str) # string literals are byte strings by default |
|
148 | assert isinstance(ip.user_ns['byte_str'], str) # string literals are byte strings by default | |
150 | ip.run_cell('from __future__ import unicode_literals') |
|
149 | ip.run_cell('from __future__ import unicode_literals') | |
151 | ip.run_cell(u'unicode_str = "a"') |
|
150 | ip.run_cell(u'unicode_str = "a"') | |
152 | assert isinstance(ip.user_ns['unicode_str'], unicode) # strings literals are now unicode |
|
151 | assert isinstance(ip.user_ns['unicode_str'], unicode) # strings literals are now unicode | |
153 | finally: |
|
152 | finally: | |
154 | # Reset compiler flags so we don't mess up other tests. |
|
153 | # Reset compiler flags so we don't mess up other tests. | |
155 | ip.compile.reset_compiler_flags() |
|
154 | ip.compile.reset_compiler_flags() | |
156 |
|
155 | |||
157 | def test_can_pickle(self): |
|
156 | def test_can_pickle(self): | |
158 | "Can we pickle objects defined interactively (GH-29)" |
|
157 | "Can we pickle objects defined interactively (GH-29)" | |
159 | ip = get_ipython() |
|
158 | ip = get_ipython() | |
160 | ip.reset() |
|
159 | ip.reset() | |
161 | ip.run_cell(("class Mylist(list):\n" |
|
160 | ip.run_cell(("class Mylist(list):\n" | |
162 | " def __init__(self,x=[]):\n" |
|
161 | " def __init__(self,x=[]):\n" | |
163 | " list.__init__(self,x)")) |
|
162 | " list.__init__(self,x)")) | |
164 | ip.run_cell("w=Mylist([1,2,3])") |
|
163 | ip.run_cell("w=Mylist([1,2,3])") | |
165 |
|
164 | |||
166 | from cPickle import dumps |
|
165 | from cPickle import dumps | |
167 |
|
166 | |||
168 | # We need to swap in our main module - this is only necessary |
|
167 | # We need to swap in our main module - this is only necessary | |
169 | # inside the test framework, because IPython puts the interactive module |
|
168 | # inside the test framework, because IPython puts the interactive module | |
170 | # in place (but the test framework undoes this). |
|
169 | # in place (but the test framework undoes this). | |
171 | _main = sys.modules['__main__'] |
|
170 | _main = sys.modules['__main__'] | |
172 | sys.modules['__main__'] = ip.user_module |
|
171 | sys.modules['__main__'] = ip.user_module | |
173 | try: |
|
172 | try: | |
174 | res = dumps(ip.user_ns["w"]) |
|
173 | res = dumps(ip.user_ns["w"]) | |
175 | finally: |
|
174 | finally: | |
176 | sys.modules['__main__'] = _main |
|
175 | sys.modules['__main__'] = _main | |
177 | self.assertTrue(isinstance(res, bytes)) |
|
176 | self.assertTrue(isinstance(res, bytes)) | |
178 |
|
177 | |||
179 | def test_global_ns(self): |
|
178 | def test_global_ns(self): | |
180 | "Code in functions must be able to access variables outside them." |
|
179 | "Code in functions must be able to access variables outside them." | |
181 | ip = get_ipython() |
|
180 | ip = get_ipython() | |
182 | ip.run_cell("a = 10") |
|
181 | ip.run_cell("a = 10") | |
183 | ip.run_cell(("def f(x):\n" |
|
182 | ip.run_cell(("def f(x):\n" | |
184 | " return x + a")) |
|
183 | " return x + a")) | |
185 | ip.run_cell("b = f(12)") |
|
184 | ip.run_cell("b = f(12)") | |
186 | self.assertEqual(ip.user_ns["b"], 22) |
|
185 | self.assertEqual(ip.user_ns["b"], 22) | |
187 |
|
186 | |||
188 | def test_bad_custom_tb(self): |
|
187 | def test_bad_custom_tb(self): | |
189 | """Check that InteractiveShell is protected from bad custom exception handlers""" |
|
188 | """Check that InteractiveShell is protected from bad custom exception handlers""" | |
190 | ip = get_ipython() |
|
189 | ip = get_ipython() | |
191 | from IPython.utils import io |
|
190 | from IPython.utils import io | |
192 | save_stderr = io.stderr |
|
191 | save_stderr = io.stderr | |
193 | try: |
|
192 | try: | |
194 | # capture stderr |
|
193 | # capture stderr | |
195 | io.stderr = StringIO() |
|
194 | io.stderr = StringIO() | |
196 | ip.set_custom_exc((IOError,), lambda etype,value,tb: 1/0) |
|
195 | ip.set_custom_exc((IOError,), lambda etype,value,tb: 1/0) | |
197 | self.assertEquals(ip.custom_exceptions, (IOError,)) |
|
196 | self.assertEquals(ip.custom_exceptions, (IOError,)) | |
198 | ip.run_cell(u'raise IOError("foo")') |
|
197 | ip.run_cell(u'raise IOError("foo")') | |
199 | self.assertEquals(ip.custom_exceptions, ()) |
|
198 | self.assertEquals(ip.custom_exceptions, ()) | |
200 | self.assertTrue("Custom TB Handler failed" in io.stderr.getvalue()) |
|
199 | self.assertTrue("Custom TB Handler failed" in io.stderr.getvalue()) | |
201 | finally: |
|
200 | finally: | |
202 | io.stderr = save_stderr |
|
201 | io.stderr = save_stderr | |
203 |
|
202 | |||
204 | def test_bad_custom_tb_return(self): |
|
203 | def test_bad_custom_tb_return(self): | |
205 | """Check that InteractiveShell is protected from bad return types in custom exception handlers""" |
|
204 | """Check that InteractiveShell is protected from bad return types in custom exception handlers""" | |
206 | ip = get_ipython() |
|
205 | ip = get_ipython() | |
207 | from IPython.utils import io |
|
206 | from IPython.utils import io | |
208 | save_stderr = io.stderr |
|
207 | save_stderr = io.stderr | |
209 | try: |
|
208 | try: | |
210 | # capture stderr |
|
209 | # capture stderr | |
211 | io.stderr = StringIO() |
|
210 | io.stderr = StringIO() | |
212 | ip.set_custom_exc((NameError,),lambda etype,value,tb, tb_offset=None: 1) |
|
211 | ip.set_custom_exc((NameError,),lambda etype,value,tb, tb_offset=None: 1) | |
213 | self.assertEquals(ip.custom_exceptions, (NameError,)) |
|
212 | self.assertEquals(ip.custom_exceptions, (NameError,)) | |
214 | ip.run_cell(u'a=abracadabra') |
|
213 | ip.run_cell(u'a=abracadabra') | |
215 | self.assertEquals(ip.custom_exceptions, ()) |
|
214 | self.assertEquals(ip.custom_exceptions, ()) | |
216 | self.assertTrue("Custom TB Handler failed" in io.stderr.getvalue()) |
|
215 | self.assertTrue("Custom TB Handler failed" in io.stderr.getvalue()) | |
217 | finally: |
|
216 | finally: | |
218 | io.stderr = save_stderr |
|
217 | io.stderr = save_stderr | |
219 |
|
218 | |||
220 | def test_drop_by_id(self): |
|
219 | def test_drop_by_id(self): | |
221 | ip = get_ipython() |
|
220 | ip = get_ipython() | |
222 | myvars = {"a":object(), "b":object(), "c": object()} |
|
221 | myvars = {"a":object(), "b":object(), "c": object()} | |
223 | ip.push(myvars, interactive=False) |
|
222 | ip.push(myvars, interactive=False) | |
224 | for name in myvars: |
|
223 | for name in myvars: | |
225 | assert name in ip.user_ns, name |
|
224 | assert name in ip.user_ns, name | |
226 | assert name in ip.user_ns_hidden, name |
|
225 | assert name in ip.user_ns_hidden, name | |
227 | ip.user_ns['b'] = 12 |
|
226 | ip.user_ns['b'] = 12 | |
228 | ip.drop_by_id(myvars) |
|
227 | ip.drop_by_id(myvars) | |
229 | for name in ["a", "c"]: |
|
228 | for name in ["a", "c"]: | |
230 | assert name not in ip.user_ns, name |
|
229 | assert name not in ip.user_ns, name | |
231 | assert name not in ip.user_ns_hidden, name |
|
230 | assert name not in ip.user_ns_hidden, name | |
232 | assert ip.user_ns['b'] == 12 |
|
231 | assert ip.user_ns['b'] == 12 | |
233 | ip.reset() |
|
232 | ip.reset() | |
234 |
|
233 | |||
235 | def test_var_expand(self): |
|
234 | def test_var_expand(self): | |
236 | ip = get_ipython() |
|
235 | ip = get_ipython() | |
237 | ip.user_ns['f'] = u'Ca\xf1o' |
|
236 | ip.user_ns['f'] = u'Ca\xf1o' | |
238 | self.assertEqual(ip.var_expand(u'echo $f'), u'echo Ca\xf1o') |
|
237 | self.assertEqual(ip.var_expand(u'echo $f'), u'echo Ca\xf1o') | |
239 |
|
238 | |||
240 | ip.user_ns['f'] = b'Ca\xc3\xb1o' |
|
239 | ip.user_ns['f'] = b'Ca\xc3\xb1o' | |
241 | # This should not raise any exception: |
|
240 | # This should not raise any exception: | |
242 | ip.var_expand(u'echo $f') |
|
241 | ip.var_expand(u'echo $f') | |
243 |
|
242 | |||
244 |
|
243 | |||
245 | class TestSafeExecfileNonAsciiPath(unittest.TestCase): |
|
244 | class TestSafeExecfileNonAsciiPath(unittest.TestCase): | |
246 |
|
245 | |||
247 | def setUp(self): |
|
246 | def setUp(self): | |
248 | self.BASETESTDIR = tempfile.mkdtemp() |
|
247 | self.BASETESTDIR = tempfile.mkdtemp() | |
249 | self.TESTDIR = join(self.BASETESTDIR, u"åäö") |
|
248 | self.TESTDIR = join(self.BASETESTDIR, u"åäö") | |
250 | os.mkdir(self.TESTDIR) |
|
249 | os.mkdir(self.TESTDIR) | |
251 | with open(join(self.TESTDIR, u"åäötestscript.py"), "w") as sfile: |
|
250 | with open(join(self.TESTDIR, u"åäötestscript.py"), "w") as sfile: | |
252 | sfile.write("pass\n") |
|
251 | sfile.write("pass\n") | |
253 | self.oldpath = os.getcwdu() |
|
252 | self.oldpath = os.getcwdu() | |
254 | os.chdir(self.TESTDIR) |
|
253 | os.chdir(self.TESTDIR) | |
255 | self.fname = u"åäötestscript.py" |
|
254 | self.fname = u"åäötestscript.py" | |
256 |
|
255 | |||
257 |
|
256 | |||
258 | def tearDown(self): |
|
257 | def tearDown(self): | |
259 | os.chdir(self.oldpath) |
|
258 | os.chdir(self.oldpath) | |
260 | shutil.rmtree(self.BASETESTDIR) |
|
259 | shutil.rmtree(self.BASETESTDIR) | |
261 |
|
260 | |||
262 | def test_1(self): |
|
261 | def test_1(self): | |
263 | """Test safe_execfile with non-ascii path |
|
262 | """Test safe_execfile with non-ascii path | |
264 | """ |
|
263 | """ | |
265 | _ip.shell.safe_execfile(self.fname, {}, raise_exceptions=True) |
|
264 | _ip.shell.safe_execfile(self.fname, {}, raise_exceptions=True) | |
266 |
|
265 | |||
267 |
|
266 | |||
268 | class TestSystemRaw(unittest.TestCase): |
|
267 | class TestSystemRaw(unittest.TestCase): | |
269 | def test_1(self): |
|
268 | def test_1(self): | |
270 | """Test system_raw with non-ascii cmd |
|
269 | """Test system_raw with non-ascii cmd | |
271 | """ |
|
270 | """ | |
272 | cmd = ur'''python -c "'åäö'" ''' |
|
271 | cmd = ur'''python -c "'åäö'" ''' | |
273 | _ip.shell.system_raw(cmd) |
|
272 | _ip.shell.system_raw(cmd) | |
274 |
|
273 | |||
275 |
|
274 | |||
276 | def test__IPYTHON__(): |
|
275 | def test__IPYTHON__(): | |
277 | # This shouldn't raise a NameError, that's all |
|
276 | # This shouldn't raise a NameError, that's all | |
278 | __IPYTHON__ |
|
277 | __IPYTHON__ |
@@ -1,261 +1,260 b'' | |||||
1 | """Tests for the key interactiveshell module, where the main ipython class is defined. |
|
1 | """Tests for the key interactiveshell module, where the main ipython class is defined. | |
2 | """ |
|
2 | """ | |
3 | #----------------------------------------------------------------------------- |
|
3 | #----------------------------------------------------------------------------- | |
4 | # Module imports |
|
4 | # Module imports | |
5 | #----------------------------------------------------------------------------- |
|
5 | #----------------------------------------------------------------------------- | |
6 |
|
6 | |||
7 | # stdlib |
|
7 | # stdlib | |
8 | import os |
|
8 | import os | |
9 | import shutil |
|
9 | import shutil | |
10 | import tempfile |
|
10 | import tempfile | |
11 |
|
11 | |||
12 | # third party |
|
12 | # third party | |
13 | import nose.tools as nt |
|
13 | import nose.tools as nt | |
14 |
|
14 | |||
15 | # our own packages |
|
15 | # our own packages | |
16 | from IPython.testing import decorators as dec |
|
|||
17 | from IPython.testing.globalipapp import get_ipython |
|
16 | from IPython.testing.globalipapp import get_ipython | |
18 | from IPython.utils import py3compat |
|
17 | from IPython.utils import py3compat | |
19 |
|
18 | |||
20 | #----------------------------------------------------------------------------- |
|
19 | #----------------------------------------------------------------------------- | |
21 | # Globals |
|
20 | # Globals | |
22 | #----------------------------------------------------------------------------- |
|
21 | #----------------------------------------------------------------------------- | |
23 |
|
22 | |||
24 | # Get the public instance of IPython |
|
23 | # Get the public instance of IPython | |
25 | ip = get_ipython() |
|
24 | ip = get_ipython() | |
26 |
|
25 | |||
27 | #----------------------------------------------------------------------------- |
|
26 | #----------------------------------------------------------------------------- | |
28 | # Test functions |
|
27 | # Test functions | |
29 | #----------------------------------------------------------------------------- |
|
28 | #----------------------------------------------------------------------------- | |
30 |
|
29 | |||
31 | def test_reset(): |
|
30 | def test_reset(): | |
32 | """reset must clear most namespaces.""" |
|
31 | """reset must clear most namespaces.""" | |
33 |
|
32 | |||
34 | # Check that reset runs without error |
|
33 | # Check that reset runs without error | |
35 | ip.reset() |
|
34 | ip.reset() | |
36 |
|
35 | |||
37 | # Once we've reset it (to clear of any junk that might have been there from |
|
36 | # Once we've reset it (to clear of any junk that might have been there from | |
38 | # other tests, we can count how many variables are in the user's namespace |
|
37 | # other tests, we can count how many variables are in the user's namespace | |
39 | nvars_user_ns = len(ip.user_ns) |
|
38 | nvars_user_ns = len(ip.user_ns) | |
40 | nvars_hidden = len(ip.user_ns_hidden) |
|
39 | nvars_hidden = len(ip.user_ns_hidden) | |
41 |
|
40 | |||
42 | # Now add a few variables to user_ns, and check that reset clears them |
|
41 | # Now add a few variables to user_ns, and check that reset clears them | |
43 | ip.user_ns['x'] = 1 |
|
42 | ip.user_ns['x'] = 1 | |
44 | ip.user_ns['y'] = 1 |
|
43 | ip.user_ns['y'] = 1 | |
45 | ip.reset() |
|
44 | ip.reset() | |
46 |
|
45 | |||
47 | # Finally, check that all namespaces have only as many variables as we |
|
46 | # Finally, check that all namespaces have only as many variables as we | |
48 | # expect to find in them: |
|
47 | # expect to find in them: | |
49 | nt.assert_equals(len(ip.user_ns), nvars_user_ns) |
|
48 | nt.assert_equals(len(ip.user_ns), nvars_user_ns) | |
50 | nt.assert_equals(len(ip.user_ns_hidden), nvars_hidden) |
|
49 | nt.assert_equals(len(ip.user_ns_hidden), nvars_hidden) | |
51 |
|
50 | |||
52 |
|
51 | |||
53 | # Tests for reporting of exceptions in various modes, handling of SystemExit, |
|
52 | # Tests for reporting of exceptions in various modes, handling of SystemExit, | |
54 | # and %tb functionality. This is really a mix of testing ultraTB and interactiveshell. |
|
53 | # and %tb functionality. This is really a mix of testing ultraTB and interactiveshell. | |
55 |
|
54 | |||
56 | def doctest_tb_plain(): |
|
55 | def doctest_tb_plain(): | |
57 | """ |
|
56 | """ | |
58 | In [18]: xmode plain |
|
57 | In [18]: xmode plain | |
59 | Exception reporting mode: Plain |
|
58 | Exception reporting mode: Plain | |
60 |
|
59 | |||
61 | In [19]: run simpleerr.py |
|
60 | In [19]: run simpleerr.py | |
62 | Traceback (most recent call last): |
|
61 | Traceback (most recent call last): | |
63 | ...line 32, in <module> |
|
62 | ...line 32, in <module> | |
64 | bar(mode) |
|
63 | bar(mode) | |
65 | ...line 16, in bar |
|
64 | ...line 16, in bar | |
66 | div0() |
|
65 | div0() | |
67 | ...line 8, in div0 |
|
66 | ...line 8, in div0 | |
68 | x/y |
|
67 | x/y | |
69 | ZeroDivisionError: ... |
|
68 | ZeroDivisionError: ... | |
70 | """ |
|
69 | """ | |
71 |
|
70 | |||
72 |
|
71 | |||
73 | def doctest_tb_context(): |
|
72 | def doctest_tb_context(): | |
74 | """ |
|
73 | """ | |
75 | In [3]: xmode context |
|
74 | In [3]: xmode context | |
76 | Exception reporting mode: Context |
|
75 | Exception reporting mode: Context | |
77 |
|
76 | |||
78 | In [4]: run simpleerr.py |
|
77 | In [4]: run simpleerr.py | |
79 | --------------------------------------------------------------------------- |
|
78 | --------------------------------------------------------------------------- | |
80 | ZeroDivisionError Traceback (most recent call last) |
|
79 | ZeroDivisionError Traceback (most recent call last) | |
81 | <BLANKLINE> |
|
80 | <BLANKLINE> | |
82 | ... in <module>() |
|
81 | ... in <module>() | |
83 | 30 mode = 'div' |
|
82 | 30 mode = 'div' | |
84 | 31 |
|
83 | 31 | |
85 | ---> 32 bar(mode) |
|
84 | ---> 32 bar(mode) | |
86 | <BLANKLINE> |
|
85 | <BLANKLINE> | |
87 | ... in bar(mode) |
|
86 | ... in bar(mode) | |
88 | 14 "bar" |
|
87 | 14 "bar" | |
89 | 15 if mode=='div': |
|
88 | 15 if mode=='div': | |
90 | ---> 16 div0() |
|
89 | ---> 16 div0() | |
91 | 17 elif mode=='exit': |
|
90 | 17 elif mode=='exit': | |
92 | 18 try: |
|
91 | 18 try: | |
93 | <BLANKLINE> |
|
92 | <BLANKLINE> | |
94 | ... in div0() |
|
93 | ... in div0() | |
95 | 6 x = 1 |
|
94 | 6 x = 1 | |
96 | 7 y = 0 |
|
95 | 7 y = 0 | |
97 | ----> 8 x/y |
|
96 | ----> 8 x/y | |
98 | 9 |
|
97 | 9 | |
99 | 10 def sysexit(stat, mode): |
|
98 | 10 def sysexit(stat, mode): | |
100 | <BLANKLINE> |
|
99 | <BLANKLINE> | |
101 | ZeroDivisionError: ... |
|
100 | ZeroDivisionError: ... | |
102 | """ |
|
101 | """ | |
103 |
|
102 | |||
104 |
|
103 | |||
105 | def doctest_tb_verbose(): |
|
104 | def doctest_tb_verbose(): | |
106 | """ |
|
105 | """ | |
107 | In [5]: xmode verbose |
|
106 | In [5]: xmode verbose | |
108 | Exception reporting mode: Verbose |
|
107 | Exception reporting mode: Verbose | |
109 |
|
108 | |||
110 | In [6]: run simpleerr.py |
|
109 | In [6]: run simpleerr.py | |
111 | --------------------------------------------------------------------------- |
|
110 | --------------------------------------------------------------------------- | |
112 | ZeroDivisionError Traceback (most recent call last) |
|
111 | ZeroDivisionError Traceback (most recent call last) | |
113 | <BLANKLINE> |
|
112 | <BLANKLINE> | |
114 | ... in <module>() |
|
113 | ... in <module>() | |
115 | 30 mode = 'div' |
|
114 | 30 mode = 'div' | |
116 | 31 |
|
115 | 31 | |
117 | ---> 32 bar(mode) |
|
116 | ---> 32 bar(mode) | |
118 | global bar = <function bar at ...> |
|
117 | global bar = <function bar at ...> | |
119 | global mode = 'div' |
|
118 | global mode = 'div' | |
120 | <BLANKLINE> |
|
119 | <BLANKLINE> | |
121 | ... in bar(mode='div') |
|
120 | ... in bar(mode='div') | |
122 | 14 "bar" |
|
121 | 14 "bar" | |
123 | 15 if mode=='div': |
|
122 | 15 if mode=='div': | |
124 | ---> 16 div0() |
|
123 | ---> 16 div0() | |
125 | global div0 = <function div0 at ...> |
|
124 | global div0 = <function div0 at ...> | |
126 | 17 elif mode=='exit': |
|
125 | 17 elif mode=='exit': | |
127 | 18 try: |
|
126 | 18 try: | |
128 | <BLANKLINE> |
|
127 | <BLANKLINE> | |
129 | ... in div0() |
|
128 | ... in div0() | |
130 | 6 x = 1 |
|
129 | 6 x = 1 | |
131 | 7 y = 0 |
|
130 | 7 y = 0 | |
132 | ----> 8 x/y |
|
131 | ----> 8 x/y | |
133 | x = 1 |
|
132 | x = 1 | |
134 | y = 0 |
|
133 | y = 0 | |
135 | 9 |
|
134 | 9 | |
136 | 10 def sysexit(stat, mode): |
|
135 | 10 def sysexit(stat, mode): | |
137 | <BLANKLINE> |
|
136 | <BLANKLINE> | |
138 | ZeroDivisionError: ... |
|
137 | ZeroDivisionError: ... | |
139 | """ |
|
138 | """ | |
140 |
|
139 | |||
141 | def doctest_tb_sysexit(): |
|
140 | def doctest_tb_sysexit(): | |
142 | """ |
|
141 | """ | |
143 | In [17]: %xmode plain |
|
142 | In [17]: %xmode plain | |
144 | Exception reporting mode: Plain |
|
143 | Exception reporting mode: Plain | |
145 |
|
144 | |||
146 | In [18]: %run simpleerr.py exit |
|
145 | In [18]: %run simpleerr.py exit | |
147 | An exception has occurred, use %tb to see the full traceback. |
|
146 | An exception has occurred, use %tb to see the full traceback. | |
148 | SystemExit: (1, 'Mode = exit') |
|
147 | SystemExit: (1, 'Mode = exit') | |
149 |
|
148 | |||
150 | In [19]: %run simpleerr.py exit 2 |
|
149 | In [19]: %run simpleerr.py exit 2 | |
151 | An exception has occurred, use %tb to see the full traceback. |
|
150 | An exception has occurred, use %tb to see the full traceback. | |
152 | SystemExit: (2, 'Mode = exit') |
|
151 | SystemExit: (2, 'Mode = exit') | |
153 |
|
152 | |||
154 | In [20]: %tb |
|
153 | In [20]: %tb | |
155 | Traceback (most recent call last): |
|
154 | Traceback (most recent call last): | |
156 | File ... in <module> |
|
155 | File ... in <module> | |
157 | bar(mode) |
|
156 | bar(mode) | |
158 | File ... line 22, in bar |
|
157 | File ... line 22, in bar | |
159 | sysexit(stat, mode) |
|
158 | sysexit(stat, mode) | |
160 | File ... line 11, in sysexit |
|
159 | File ... line 11, in sysexit | |
161 | raise SystemExit(stat, 'Mode = %s' % mode) |
|
160 | raise SystemExit(stat, 'Mode = %s' % mode) | |
162 | SystemExit: (2, 'Mode = exit') |
|
161 | SystemExit: (2, 'Mode = exit') | |
163 |
|
162 | |||
164 | In [21]: %xmode context |
|
163 | In [21]: %xmode context | |
165 | Exception reporting mode: Context |
|
164 | Exception reporting mode: Context | |
166 |
|
165 | |||
167 | In [22]: %tb |
|
166 | In [22]: %tb | |
168 | --------------------------------------------------------------------------- |
|
167 | --------------------------------------------------------------------------- | |
169 | SystemExit Traceback (most recent call last) |
|
168 | SystemExit Traceback (most recent call last) | |
170 | <BLANKLINE> |
|
169 | <BLANKLINE> | |
171 | ...<module>() |
|
170 | ...<module>() | |
172 | 30 mode = 'div' |
|
171 | 30 mode = 'div' | |
173 | 31 |
|
172 | 31 | |
174 | ---> 32 bar(mode) |
|
173 | ---> 32 bar(mode) | |
175 | <BLANKLINE> |
|
174 | <BLANKLINE> | |
176 | ...bar(mode) |
|
175 | ...bar(mode) | |
177 | 20 except: |
|
176 | 20 except: | |
178 | 21 stat = 1 |
|
177 | 21 stat = 1 | |
179 | ---> 22 sysexit(stat, mode) |
|
178 | ---> 22 sysexit(stat, mode) | |
180 | 23 else: |
|
179 | 23 else: | |
181 | 24 raise ValueError('Unknown mode') |
|
180 | 24 raise ValueError('Unknown mode') | |
182 | <BLANKLINE> |
|
181 | <BLANKLINE> | |
183 | ...sysexit(stat, mode) |
|
182 | ...sysexit(stat, mode) | |
184 | 9 |
|
183 | 9 | |
185 | 10 def sysexit(stat, mode): |
|
184 | 10 def sysexit(stat, mode): | |
186 | ---> 11 raise SystemExit(stat, 'Mode = %s' % mode) |
|
185 | ---> 11 raise SystemExit(stat, 'Mode = %s' % mode) | |
187 | 12 |
|
186 | 12 | |
188 | 13 def bar(mode): |
|
187 | 13 def bar(mode): | |
189 | <BLANKLINE> |
|
188 | <BLANKLINE> | |
190 | SystemExit: (2, 'Mode = exit') |
|
189 | SystemExit: (2, 'Mode = exit') | |
191 |
|
190 | |||
192 | In [23]: %xmode verbose |
|
191 | In [23]: %xmode verbose | |
193 | Exception reporting mode: Verbose |
|
192 | Exception reporting mode: Verbose | |
194 |
|
193 | |||
195 | In [24]: %tb |
|
194 | In [24]: %tb | |
196 | --------------------------------------------------------------------------- |
|
195 | --------------------------------------------------------------------------- | |
197 | SystemExit Traceback (most recent call last) |
|
196 | SystemExit Traceback (most recent call last) | |
198 | <BLANKLINE> |
|
197 | <BLANKLINE> | |
199 | ... in <module>() |
|
198 | ... in <module>() | |
200 | 30 mode = 'div' |
|
199 | 30 mode = 'div' | |
201 | 31 |
|
200 | 31 | |
202 | ---> 32 bar(mode) |
|
201 | ---> 32 bar(mode) | |
203 | global bar = <function bar at ...> |
|
202 | global bar = <function bar at ...> | |
204 | global mode = 'exit' |
|
203 | global mode = 'exit' | |
205 | <BLANKLINE> |
|
204 | <BLANKLINE> | |
206 | ... in bar(mode='exit') |
|
205 | ... in bar(mode='exit') | |
207 | 20 except: |
|
206 | 20 except: | |
208 | 21 stat = 1 |
|
207 | 21 stat = 1 | |
209 | ---> 22 sysexit(stat, mode) |
|
208 | ---> 22 sysexit(stat, mode) | |
210 | global sysexit = <function sysexit at ...> |
|
209 | global sysexit = <function sysexit at ...> | |
211 | stat = 2 |
|
210 | stat = 2 | |
212 | mode = 'exit' |
|
211 | mode = 'exit' | |
213 | 23 else: |
|
212 | 23 else: | |
214 | 24 raise ValueError('Unknown mode') |
|
213 | 24 raise ValueError('Unknown mode') | |
215 | <BLANKLINE> |
|
214 | <BLANKLINE> | |
216 | ... in sysexit(stat=2, mode='exit') |
|
215 | ... in sysexit(stat=2, mode='exit') | |
217 | 9 |
|
216 | 9 | |
218 | 10 def sysexit(stat, mode): |
|
217 | 10 def sysexit(stat, mode): | |
219 | ---> 11 raise SystemExit(stat, 'Mode = %s' % mode) |
|
218 | ---> 11 raise SystemExit(stat, 'Mode = %s' % mode) | |
220 | global SystemExit = undefined |
|
219 | global SystemExit = undefined | |
221 | stat = 2 |
|
220 | stat = 2 | |
222 | mode = 'exit' |
|
221 | mode = 'exit' | |
223 | 12 |
|
222 | 12 | |
224 | 13 def bar(mode): |
|
223 | 13 def bar(mode): | |
225 | <BLANKLINE> |
|
224 | <BLANKLINE> | |
226 | SystemExit: (2, 'Mode = exit') |
|
225 | SystemExit: (2, 'Mode = exit') | |
227 | """ |
|
226 | """ | |
228 |
|
227 | |||
229 |
|
228 | |||
230 | def test_run_cell(): |
|
229 | def test_run_cell(): | |
231 | import textwrap |
|
230 | import textwrap | |
232 | ip.run_cell('a = 10\na+=1') |
|
231 | ip.run_cell('a = 10\na+=1') | |
233 | ip.run_cell('assert a == 11\nassert 1') |
|
232 | ip.run_cell('assert a == 11\nassert 1') | |
234 |
|
233 | |||
235 | nt.assert_equals(ip.user_ns['a'], 11) |
|
234 | nt.assert_equals(ip.user_ns['a'], 11) | |
236 | complex = textwrap.dedent(""" |
|
235 | complex = textwrap.dedent(""" | |
237 | if 1: |
|
236 | if 1: | |
238 | print "hello" |
|
237 | print "hello" | |
239 | if 1: |
|
238 | if 1: | |
240 | print "world" |
|
239 | print "world" | |
241 |
|
240 | |||
242 | if 2: |
|
241 | if 2: | |
243 | print "foo" |
|
242 | print "foo" | |
244 |
|
243 | |||
245 | if 3: |
|
244 | if 3: | |
246 | print "bar" |
|
245 | print "bar" | |
247 |
|
246 | |||
248 | if 4: |
|
247 | if 4: | |
249 | print "bar" |
|
248 | print "bar" | |
250 |
|
249 | |||
251 | """) |
|
250 | """) | |
252 | # Simply verifies that this kind of input is run |
|
251 | # Simply verifies that this kind of input is run | |
253 | ip.run_cell(complex) |
|
252 | ip.run_cell(complex) | |
254 |
|
253 | |||
255 |
|
254 | |||
256 | def test_db(): |
|
255 | def test_db(): | |
257 | """Test the internal database used for variable persistence.""" |
|
256 | """Test the internal database used for variable persistence.""" | |
258 | ip.db['__unittest_'] = 12 |
|
257 | ip.db['__unittest_'] = 12 | |
259 | nt.assert_equals(ip.db['__unittest_'], 12) |
|
258 | nt.assert_equals(ip.db['__unittest_'], 12) | |
260 | del ip.db['__unittest_'] |
|
259 | del ip.db['__unittest_'] | |
261 | assert '__unittest_' not in ip.db |
|
260 | assert '__unittest_' not in ip.db |
@@ -1,164 +1,163 b'' | |||||
1 | """Tests for various magic functions specific to the terminal frontend. |
|
1 | """Tests for various magic functions specific to the terminal frontend. | |
2 |
|
2 | |||
3 | Needs to be run by nose (to make ipython session available). |
|
3 | Needs to be run by nose (to make ipython session available). | |
4 | """ |
|
4 | """ | |
5 | from __future__ import absolute_import |
|
5 | from __future__ import absolute_import | |
6 |
|
6 | |||
7 | #----------------------------------------------------------------------------- |
|
7 | #----------------------------------------------------------------------------- | |
8 | # Imports |
|
8 | # Imports | |
9 | #----------------------------------------------------------------------------- |
|
9 | #----------------------------------------------------------------------------- | |
10 |
|
10 | |||
11 | import sys |
|
11 | import sys | |
12 | from StringIO import StringIO |
|
12 | from StringIO import StringIO | |
13 |
|
13 | |||
14 | import nose.tools as nt |
|
14 | import nose.tools as nt | |
15 |
|
15 | |||
16 | from IPython.testing import decorators as dec |
|
|||
17 | from IPython.testing import tools as tt |
|
16 | from IPython.testing import tools as tt | |
18 |
|
17 | |||
19 | #----------------------------------------------------------------------------- |
|
18 | #----------------------------------------------------------------------------- | |
20 | # Test functions begin |
|
19 | # Test functions begin | |
21 | #----------------------------------------------------------------------------- |
|
20 | #----------------------------------------------------------------------------- | |
22 |
|
21 | |||
23 | def check_cpaste(code, should_fail=False): |
|
22 | def check_cpaste(code, should_fail=False): | |
24 | """Execute code via 'cpaste' and ensure it was executed, unless |
|
23 | """Execute code via 'cpaste' and ensure it was executed, unless | |
25 | should_fail is set. |
|
24 | should_fail is set. | |
26 | """ |
|
25 | """ | |
27 | _ip.user_ns['code_ran'] = False |
|
26 | _ip.user_ns['code_ran'] = False | |
28 |
|
27 | |||
29 | src = StringIO() |
|
28 | src = StringIO() | |
30 | if not hasattr(src, 'encoding'): |
|
29 | if not hasattr(src, 'encoding'): | |
31 | # IPython expects stdin to have an encoding attribute |
|
30 | # IPython expects stdin to have an encoding attribute | |
32 | src.encoding = None |
|
31 | src.encoding = None | |
33 | src.write('\n') |
|
32 | src.write('\n') | |
34 | src.write(code) |
|
33 | src.write(code) | |
35 | src.write('\n--\n') |
|
34 | src.write('\n--\n') | |
36 | src.seek(0) |
|
35 | src.seek(0) | |
37 |
|
36 | |||
38 | stdin_save = sys.stdin |
|
37 | stdin_save = sys.stdin | |
39 | sys.stdin = src |
|
38 | sys.stdin = src | |
40 |
|
39 | |||
41 | try: |
|
40 | try: | |
42 | context = tt.AssertPrints if should_fail else tt.AssertNotPrints |
|
41 | context = tt.AssertPrints if should_fail else tt.AssertNotPrints | |
43 | with context("Traceback (most recent call last)"): |
|
42 | with context("Traceback (most recent call last)"): | |
44 | _ip.magic('cpaste') |
|
43 | _ip.magic('cpaste') | |
45 |
|
44 | |||
46 | if not should_fail: |
|
45 | if not should_fail: | |
47 | assert _ip.user_ns['code_ran'] |
|
46 | assert _ip.user_ns['code_ran'] | |
48 | finally: |
|
47 | finally: | |
49 | sys.stdin = stdin_save |
|
48 | sys.stdin = stdin_save | |
50 |
|
49 | |||
51 |
|
50 | |||
52 | def test_cpaste(): |
|
51 | def test_cpaste(): | |
53 | """Test cpaste magic""" |
|
52 | """Test cpaste magic""" | |
54 |
|
53 | |||
55 | def run(): |
|
54 | def run(): | |
56 | """Marker function: sets a flag when executed. |
|
55 | """Marker function: sets a flag when executed. | |
57 | """ |
|
56 | """ | |
58 | _ip.user_ns['code_ran'] = True |
|
57 | _ip.user_ns['code_ran'] = True | |
59 | return 'run' # return string so '+ run()' doesn't result in success |
|
58 | return 'run' # return string so '+ run()' doesn't result in success | |
60 |
|
59 | |||
61 | tests = {'pass': ["run()", |
|
60 | tests = {'pass': ["run()", | |
62 | "In [1]: run()", |
|
61 | "In [1]: run()", | |
63 | "In [1]: if 1:\n ...: run()", |
|
62 | "In [1]: if 1:\n ...: run()", | |
64 | "> > > run()", |
|
63 | "> > > run()", | |
65 | ">>> run()", |
|
64 | ">>> run()", | |
66 | " >>> run()", |
|
65 | " >>> run()", | |
67 | ], |
|
66 | ], | |
68 |
|
67 | |||
69 | 'fail': ["1 + run()", |
|
68 | 'fail': ["1 + run()", | |
70 | "++ run()"]} |
|
69 | "++ run()"]} | |
71 |
|
70 | |||
72 | _ip.user_ns['run'] = run |
|
71 | _ip.user_ns['run'] = run | |
73 |
|
72 | |||
74 | for code in tests['pass']: |
|
73 | for code in tests['pass']: | |
75 | check_cpaste(code) |
|
74 | check_cpaste(code) | |
76 |
|
75 | |||
77 | for code in tests['fail']: |
|
76 | for code in tests['fail']: | |
78 | check_cpaste(code, should_fail=True) |
|
77 | check_cpaste(code, should_fail=True) | |
79 |
|
78 | |||
80 |
|
79 | |||
81 | # Multiple tests for clipboard pasting |
|
80 | # Multiple tests for clipboard pasting | |
82 | def test_paste(): |
|
81 | def test_paste(): | |
83 | _ip = get_ipython() |
|
82 | _ip = get_ipython() | |
84 |
|
83 | |||
85 | def paste(txt, flags='-q'): |
|
84 | def paste(txt, flags='-q'): | |
86 | """Paste input text, by default in quiet mode""" |
|
85 | """Paste input text, by default in quiet mode""" | |
87 | hooks.clipboard_get = lambda : txt |
|
86 | hooks.clipboard_get = lambda : txt | |
88 | _ip.magic('paste '+flags) |
|
87 | _ip.magic('paste '+flags) | |
89 |
|
88 | |||
90 | # Inject fake clipboard hook but save original so we can restore it later |
|
89 | # Inject fake clipboard hook but save original so we can restore it later | |
91 | hooks = _ip.hooks |
|
90 | hooks = _ip.hooks | |
92 | user_ns = _ip.user_ns |
|
91 | user_ns = _ip.user_ns | |
93 | original_clip = hooks.clipboard_get |
|
92 | original_clip = hooks.clipboard_get | |
94 |
|
93 | |||
95 | try: |
|
94 | try: | |
96 | # Run tests with fake clipboard function |
|
95 | # Run tests with fake clipboard function | |
97 | user_ns.pop('x', None) |
|
96 | user_ns.pop('x', None) | |
98 | paste('x=1') |
|
97 | paste('x=1') | |
99 | nt.assert_equal(user_ns['x'], 1) |
|
98 | nt.assert_equal(user_ns['x'], 1) | |
100 |
|
99 | |||
101 | user_ns.pop('x', None) |
|
100 | user_ns.pop('x', None) | |
102 | paste('>>> x=2') |
|
101 | paste('>>> x=2') | |
103 | nt.assert_equal(user_ns['x'], 2) |
|
102 | nt.assert_equal(user_ns['x'], 2) | |
104 |
|
103 | |||
105 | paste(""" |
|
104 | paste(""" | |
106 | >>> x = [1,2,3] |
|
105 | >>> x = [1,2,3] | |
107 | >>> y = [] |
|
106 | >>> y = [] | |
108 | >>> for i in x: |
|
107 | >>> for i in x: | |
109 | ... y.append(i**2) |
|
108 | ... y.append(i**2) | |
110 | ... |
|
109 | ... | |
111 | """) |
|
110 | """) | |
112 | nt.assert_equal(user_ns['x'], [1,2,3]) |
|
111 | nt.assert_equal(user_ns['x'], [1,2,3]) | |
113 | nt.assert_equal(user_ns['y'], [1,4,9]) |
|
112 | nt.assert_equal(user_ns['y'], [1,4,9]) | |
114 |
|
113 | |||
115 | # Now, test that paste -r works |
|
114 | # Now, test that paste -r works | |
116 | user_ns.pop('x', None) |
|
115 | user_ns.pop('x', None) | |
117 | nt.assert_false('x' in user_ns) |
|
116 | nt.assert_false('x' in user_ns) | |
118 | _ip.magic('paste -r') |
|
117 | _ip.magic('paste -r') | |
119 | nt.assert_equal(user_ns['x'], [1,2,3]) |
|
118 | nt.assert_equal(user_ns['x'], [1,2,3]) | |
120 |
|
119 | |||
121 | # Test pasting of email-quoted contents |
|
120 | # Test pasting of email-quoted contents | |
122 | paste(""" |
|
121 | paste(""" | |
123 | >> def foo(x): |
|
122 | >> def foo(x): | |
124 | >> return x + 1 |
|
123 | >> return x + 1 | |
125 | >> x = foo(1.1) |
|
124 | >> x = foo(1.1) | |
126 | """) |
|
125 | """) | |
127 | nt.assert_equal(user_ns['x'], 2.1) |
|
126 | nt.assert_equal(user_ns['x'], 2.1) | |
128 |
|
127 | |||
129 | # Email again; some programs add a space also at each quoting level |
|
128 | # Email again; some programs add a space also at each quoting level | |
130 | paste(""" |
|
129 | paste(""" | |
131 | > > def foo(x): |
|
130 | > > def foo(x): | |
132 | > > return x + 1 |
|
131 | > > return x + 1 | |
133 | > > x = foo(2.1) |
|
132 | > > x = foo(2.1) | |
134 | """) |
|
133 | """) | |
135 | nt.assert_equal(user_ns['x'], 3.1) |
|
134 | nt.assert_equal(user_ns['x'], 3.1) | |
136 |
|
135 | |||
137 | # Email quoting of interactive input |
|
136 | # Email quoting of interactive input | |
138 | paste(""" |
|
137 | paste(""" | |
139 | >> >>> def f(x): |
|
138 | >> >>> def f(x): | |
140 | >> ... return x+1 |
|
139 | >> ... return x+1 | |
141 | >> ... |
|
140 | >> ... | |
142 | >> >>> x = f(2.5) |
|
141 | >> >>> x = f(2.5) | |
143 | """) |
|
142 | """) | |
144 | nt.assert_equal(user_ns['x'], 3.5) |
|
143 | nt.assert_equal(user_ns['x'], 3.5) | |
145 |
|
144 | |||
146 | # Also test paste echoing, by temporarily faking the writer |
|
145 | # Also test paste echoing, by temporarily faking the writer | |
147 | w = StringIO() |
|
146 | w = StringIO() | |
148 | writer = _ip.write |
|
147 | writer = _ip.write | |
149 | _ip.write = w.write |
|
148 | _ip.write = w.write | |
150 | code = """ |
|
149 | code = """ | |
151 | a = 100 |
|
150 | a = 100 | |
152 | b = 200""" |
|
151 | b = 200""" | |
153 | try: |
|
152 | try: | |
154 | paste(code,'') |
|
153 | paste(code,'') | |
155 | out = w.getvalue() |
|
154 | out = w.getvalue() | |
156 | finally: |
|
155 | finally: | |
157 | _ip.write = writer |
|
156 | _ip.write = writer | |
158 | nt.assert_equal(user_ns['a'], 100) |
|
157 | nt.assert_equal(user_ns['a'], 100) | |
159 | nt.assert_equal(user_ns['b'], 200) |
|
158 | nt.assert_equal(user_ns['b'], 200) | |
160 | nt.assert_equal(out, code+"\n## -- End pasted text --\n") |
|
159 | nt.assert_equal(out, code+"\n## -- End pasted text --\n") | |
161 |
|
160 | |||
162 | finally: |
|
161 | finally: | |
163 | # Restore original hook |
|
162 | # Restore original hook | |
164 | hooks.clipboard_get = original_clip |
|
163 | hooks.clipboard_get = original_clip |
@@ -1,82 +1,82 b'' | |||||
1 | """ |
|
1 | """ | |
2 | Base front end class for all async frontends. |
|
2 | Base front end class for all async frontends. | |
3 | """ |
|
3 | """ | |
4 | __docformat__ = "restructuredtext en" |
|
4 | __docformat__ = "restructuredtext en" | |
5 |
|
5 | |||
6 | # Tell nose to skip this module |
|
6 | # Tell nose to skip this module | |
7 | __test__ = {} |
|
7 | __test__ = {} | |
8 |
|
8 | |||
9 | #------------------------------------------------------------------------------- |
|
9 | #------------------------------------------------------------------------------- | |
10 | # Copyright (C) 2008-2011 The IPython Development Team |
|
10 | # Copyright (C) 2008-2011 The IPython Development Team | |
11 | # |
|
11 | # | |
12 | # Distributed under the terms of the BSD License. The full license is in |
|
12 | # Distributed under the terms of the BSD License. The full license is in | |
13 | # the file COPYING, distributed as part of this software. |
|
13 | # the file COPYING, distributed as part of this software. | |
14 | #------------------------------------------------------------------------------- |
|
14 | #------------------------------------------------------------------------------- | |
15 |
|
15 | |||
16 | #------------------------------------------------------------------------------- |
|
16 | #------------------------------------------------------------------------------- | |
17 | # Imports |
|
17 | # Imports | |
18 | #------------------------------------------------------------------------------- |
|
18 | #------------------------------------------------------------------------------- | |
19 |
|
19 | |||
20 | # Third-party |
|
20 | # Third-party | |
21 | from twisted.python.failure import Failure |
|
21 | from twisted.python.failure import Failure | |
22 | from zope.interface import implements, classProvides |
|
22 | from zope.interface import implements, classProvides | |
23 |
|
23 | |||
24 | # From IPython |
|
24 | # From IPython | |
25 | from IPython.external import guid |
|
|||
26 |
|
||||
27 | from IPython.frontend.frontendbase import (FrontEndBase, IFrontEnd, |
|
25 | from IPython.frontend.frontendbase import (FrontEndBase, IFrontEnd, | |
28 | IFrontEndFactory) |
|
26 | IFrontEndFactory) | |
29 | from IPython.kernel.core.history import FrontEndHistory |
|
27 | from IPython.kernel.core.history import FrontEndHistory | |
30 | from IPython.kernel.engineservice import IEngineCore |
|
28 | from IPython.kernel.engineservice import IEngineCore | |
31 |
|
29 | |||
|
30 | import uuid | |||
|
31 | ||||
32 | #----------------------------------------------------------------------------- |
|
32 | #----------------------------------------------------------------------------- | |
33 | # Classes and functions |
|
33 | # Classes and functions | |
34 | #----------------------------------------------------------------------------- |
|
34 | #----------------------------------------------------------------------------- | |
35 |
|
35 | |||
36 | class AsyncFrontEndBase(FrontEndBase): |
|
36 | class AsyncFrontEndBase(FrontEndBase): | |
37 | """ |
|
37 | """ | |
38 | Overrides FrontEndBase to wrap execute in a deferred result. |
|
38 | Overrides FrontEndBase to wrap execute in a deferred result. | |
39 | All callbacks are made as callbacks on the deferred result. |
|
39 | All callbacks are made as callbacks on the deferred result. | |
40 | """ |
|
40 | """ | |
41 |
|
41 | |||
42 | implements(IFrontEnd) |
|
42 | implements(IFrontEnd) | |
43 | classProvides(IFrontEndFactory) |
|
43 | classProvides(IFrontEndFactory) | |
44 |
|
44 | |||
45 | def __init__(self, engine=None, history=None): |
|
45 | def __init__(self, engine=None, history=None): | |
46 | assert(engine==None or IEngineCore.providedBy(engine)) |
|
46 | assert(engine==None or IEngineCore.providedBy(engine)) | |
47 | self.engine = IEngineCore(engine) |
|
47 | self.engine = IEngineCore(engine) | |
48 | if history is None: |
|
48 | if history is None: | |
49 | self.history = FrontEndHistory(input_cache=['']) |
|
49 | self.history = FrontEndHistory(input_cache=['']) | |
50 | else: |
|
50 | else: | |
51 | self.history = history |
|
51 | self.history = history | |
52 |
|
52 | |||
53 | def execute(self, block, blockID=None): |
|
53 | def execute(self, block, blockID=None): | |
54 | """Execute the block and return the deferred result. |
|
54 | """Execute the block and return the deferred result. | |
55 |
|
55 | |||
56 | Parameters: |
|
56 | Parameters: | |
57 | block : {str, AST} |
|
57 | block : {str, AST} | |
58 | blockID : any |
|
58 | blockID : any | |
59 | Caller may provide an ID to identify this block. |
|
59 | Caller may provide an ID to identify this block. | |
60 | result['blockID'] := blockID |
|
60 | result['blockID'] := blockID | |
61 |
|
61 | |||
62 | Result: |
|
62 | Result: | |
63 | Deferred result of self.interpreter.execute |
|
63 | Deferred result of self.interpreter.execute | |
64 | """ |
|
64 | """ | |
65 |
|
65 | |||
66 | if(not self.is_complete(block)): |
|
66 | if(not self.is_complete(block)): | |
67 | return Failure(Exception("Block is not compilable")) |
|
67 | return Failure(Exception("Block is not compilable")) | |
68 |
|
68 | |||
69 | if(blockID == None): |
|
69 | if(blockID == None): | |
70 |
blockID = |
|
70 | blockID = uuid.uuid4() | |
71 |
|
71 | |||
72 | d = self.engine.execute(block) |
|
72 | d = self.engine.execute(block) | |
73 | d.addCallback(self._add_history, block=block) |
|
73 | d.addCallback(self._add_history, block=block) | |
74 | d.addCallbacks(self._add_block_id_for_result, |
|
74 | d.addCallbacks(self._add_block_id_for_result, | |
75 | errback=self._add_block_id_for_failure, |
|
75 | errback=self._add_block_id_for_failure, | |
76 | callbackArgs=(blockID,), |
|
76 | callbackArgs=(blockID,), | |
77 | errbackArgs=(blockID,)) |
|
77 | errbackArgs=(blockID,)) | |
78 | d.addBoth(self.update_cell_prompt, blockID=blockID) |
|
78 | d.addBoth(self.update_cell_prompt, blockID=blockID) | |
79 | d.addCallbacks(self.render_result, |
|
79 | d.addCallbacks(self.render_result, | |
80 | errback=self.render_error) |
|
80 | errback=self.render_error) | |
81 |
|
81 | |||
82 | return d |
|
82 | return d |
@@ -1,560 +1,560 b'' | |||||
1 | # encoding: utf-8 |
|
1 | # encoding: utf-8 | |
2 | # -*- test-case-name: IPython.frontend.cocoa.tests.test_cocoa_frontend -*- |
|
2 | # -*- test-case-name: IPython.frontend.cocoa.tests.test_cocoa_frontend -*- | |
3 |
|
3 | |||
4 | """PyObjC classes to provide a Cocoa frontend to the |
|
4 | """PyObjC classes to provide a Cocoa frontend to the | |
5 | IPython.kernel.engineservice.IEngineBase. |
|
5 | IPython.kernel.engineservice.IEngineBase. | |
6 |
|
6 | |||
7 | To add an IPython interpreter to a cocoa app, instantiate an |
|
7 | To add an IPython interpreter to a cocoa app, instantiate an | |
8 | IPythonCocoaController in a XIB and connect its textView outlet to an |
|
8 | IPythonCocoaController in a XIB and connect its textView outlet to an | |
9 | NSTextView instance in your UI. That's it. |
|
9 | NSTextView instance in your UI. That's it. | |
10 |
|
10 | |||
11 | Author: Barry Wark |
|
11 | Author: Barry Wark | |
12 | """ |
|
12 | """ | |
13 |
|
13 | |||
14 | __docformat__ = "restructuredtext en" |
|
14 | __docformat__ = "restructuredtext en" | |
15 |
|
15 | |||
16 | #----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
17 | # Copyright (C) 2008-2011 The IPython Development Team |
|
17 | # Copyright (C) 2008-2011 The IPython Development Team | |
18 | # |
|
18 | # | |
19 | # Distributed under the terms of the BSD License. The full license is in |
|
19 | # Distributed under the terms of the BSD License. The full license is in | |
20 | # the file COPYING, distributed as part of this software. |
|
20 | # the file COPYING, distributed as part of this software. | |
21 | #----------------------------------------------------------------------------- |
|
21 | #----------------------------------------------------------------------------- | |
22 |
|
22 | |||
23 | #----------------------------------------------------------------------------- |
|
23 | #----------------------------------------------------------------------------- | |
24 | # Imports |
|
24 | # Imports | |
25 | #----------------------------------------------------------------------------- |
|
25 | #----------------------------------------------------------------------------- | |
26 |
|
26 | |||
27 | import sys |
|
27 | import sys | |
28 | import objc |
|
28 | import objc | |
29 | from IPython.external import guid |
|
29 | import uuid | |
30 |
|
30 | |||
31 | from Foundation import NSObject, NSMutableArray, NSMutableDictionary,\ |
|
31 | from Foundation import NSObject, NSMutableArray, NSMutableDictionary,\ | |
32 | NSLog, NSNotificationCenter, NSMakeRange,\ |
|
32 | NSLog, NSNotificationCenter, NSMakeRange,\ | |
33 | NSLocalizedString, NSIntersectionRange,\ |
|
33 | NSLocalizedString, NSIntersectionRange,\ | |
34 | NSString, NSAutoreleasePool |
|
34 | NSString, NSAutoreleasePool | |
35 |
|
35 | |||
36 | from AppKit import NSApplicationWillTerminateNotification, NSBeep,\ |
|
36 | from AppKit import NSApplicationWillTerminateNotification, NSBeep,\ | |
37 | NSTextView, NSRulerView, NSVerticalRuler |
|
37 | NSTextView, NSRulerView, NSVerticalRuler | |
38 |
|
38 | |||
39 | from pprint import saferepr |
|
39 | from pprint import saferepr | |
40 |
|
40 | |||
41 | import IPython |
|
41 | import IPython | |
42 | from IPython.kernel.engineservice import ThreadedEngineService |
|
42 | from IPython.kernel.engineservice import ThreadedEngineService | |
43 | from IPython.frontend.asyncfrontendbase import AsyncFrontEndBase |
|
43 | from IPython.frontend.asyncfrontendbase import AsyncFrontEndBase | |
44 |
|
44 | |||
45 | from twisted.internet.threads import blockingCallFromThread |
|
45 | from twisted.internet.threads import blockingCallFromThread | |
46 | from twisted.python.failure import Failure |
|
46 | from twisted.python.failure import Failure | |
47 |
|
47 | |||
48 | #----------------------------------------------------------------------------- |
|
48 | #----------------------------------------------------------------------------- | |
49 | # Classes to implement the Cocoa frontend |
|
49 | # Classes to implement the Cocoa frontend | |
50 | #----------------------------------------------------------------------------- |
|
50 | #----------------------------------------------------------------------------- | |
51 |
|
51 | |||
52 | # TODO: |
|
52 | # TODO: | |
53 | # 1. use MultiEngineClient and out-of-process engine rather than |
|
53 | # 1. use MultiEngineClient and out-of-process engine rather than | |
54 | # ThreadedEngineService? |
|
54 | # ThreadedEngineService? | |
55 | # 2. integrate Xgrid launching of engines |
|
55 | # 2. integrate Xgrid launching of engines | |
56 |
|
56 | |||
57 | class AutoreleasePoolWrappedThreadedEngineService(ThreadedEngineService): |
|
57 | class AutoreleasePoolWrappedThreadedEngineService(ThreadedEngineService): | |
58 | """Wrap all blocks in an NSAutoreleasePool""" |
|
58 | """Wrap all blocks in an NSAutoreleasePool""" | |
59 |
|
59 | |||
60 | def wrapped_execute(self, msg, lines): |
|
60 | def wrapped_execute(self, msg, lines): | |
61 | """wrapped_execute""" |
|
61 | """wrapped_execute""" | |
62 | try: |
|
62 | try: | |
63 | p = NSAutoreleasePool.alloc().init() |
|
63 | p = NSAutoreleasePool.alloc().init() | |
64 | result = super(AutoreleasePoolWrappedThreadedEngineService, |
|
64 | result = super(AutoreleasePoolWrappedThreadedEngineService, | |
65 | self).wrapped_execute(msg, lines) |
|
65 | self).wrapped_execute(msg, lines) | |
66 | finally: |
|
66 | finally: | |
67 | p.drain() |
|
67 | p.drain() | |
68 |
|
68 | |||
69 | return result |
|
69 | return result | |
70 |
|
70 | |||
71 |
|
71 | |||
72 |
|
72 | |||
73 | class Cell(NSObject): |
|
73 | class Cell(NSObject): | |
74 | """ |
|
74 | """ | |
75 | Representation of the prompts, input and output of a cell in the |
|
75 | Representation of the prompts, input and output of a cell in the | |
76 | frontend |
|
76 | frontend | |
77 | """ |
|
77 | """ | |
78 |
|
78 | |||
79 | blockNumber = objc.ivar().unsigned_long() |
|
79 | blockNumber = objc.ivar().unsigned_long() | |
80 | blockID = objc.ivar() |
|
80 | blockID = objc.ivar() | |
81 | inputBlock = objc.ivar() |
|
81 | inputBlock = objc.ivar() | |
82 | output = objc.ivar() |
|
82 | output = objc.ivar() | |
83 |
|
83 | |||
84 |
|
84 | |||
85 |
|
85 | |||
86 | class CellBlock(object): |
|
86 | class CellBlock(object): | |
87 | """ |
|
87 | """ | |
88 | Storage for information about text ranges relating to a single cell |
|
88 | Storage for information about text ranges relating to a single cell | |
89 | """ |
|
89 | """ | |
90 |
|
90 | |||
91 |
|
91 | |||
92 | def __init__(self, inputPromptRange, inputRange=None, outputPromptRange=None, |
|
92 | def __init__(self, inputPromptRange, inputRange=None, outputPromptRange=None, | |
93 | outputRange=None): |
|
93 | outputRange=None): | |
94 | super(CellBlock, self).__init__() |
|
94 | super(CellBlock, self).__init__() | |
95 | self.inputPromptRange = inputPromptRange |
|
95 | self.inputPromptRange = inputPromptRange | |
96 | self.inputRange = inputRange |
|
96 | self.inputRange = inputRange | |
97 | self.outputPromptRange = outputPromptRange |
|
97 | self.outputPromptRange = outputPromptRange | |
98 | self.outputRange = outputRange |
|
98 | self.outputRange = outputRange | |
99 |
|
99 | |||
100 | def update_ranges_for_insertion(self, text, textRange): |
|
100 | def update_ranges_for_insertion(self, text, textRange): | |
101 | """Update ranges for text insertion at textRange""" |
|
101 | """Update ranges for text insertion at textRange""" | |
102 |
|
102 | |||
103 | for r in [self.inputPromptRange,self.inputRange, |
|
103 | for r in [self.inputPromptRange,self.inputRange, | |
104 | self.outputPromptRange, self.outputRange]: |
|
104 | self.outputPromptRange, self.outputRange]: | |
105 | if(r == None): |
|
105 | if(r == None): | |
106 | continue |
|
106 | continue | |
107 | intersection = NSIntersectionRange(r,textRange) |
|
107 | intersection = NSIntersectionRange(r,textRange) | |
108 | if(intersection.length == 0): #ranges don't intersect |
|
108 | if(intersection.length == 0): #ranges don't intersect | |
109 | if r.location >= textRange.location: |
|
109 | if r.location >= textRange.location: | |
110 | r.location += len(text) |
|
110 | r.location += len(text) | |
111 | else: #ranges intersect |
|
111 | else: #ranges intersect | |
112 | if(r.location > textRange.location): |
|
112 | if(r.location > textRange.location): | |
113 | offset = len(text) - intersection.length |
|
113 | offset = len(text) - intersection.length | |
114 | r.length -= offset |
|
114 | r.length -= offset | |
115 | r.location += offset |
|
115 | r.location += offset | |
116 | elif(r.location == textRange.location): |
|
116 | elif(r.location == textRange.location): | |
117 | r.length += len(text) - intersection.length |
|
117 | r.length += len(text) - intersection.length | |
118 | else: |
|
118 | else: | |
119 | r.length -= intersection.length |
|
119 | r.length -= intersection.length | |
120 |
|
120 | |||
121 |
|
121 | |||
122 | def update_ranges_for_deletion(self, textRange): |
|
122 | def update_ranges_for_deletion(self, textRange): | |
123 | """Update ranges for text deletion at textRange""" |
|
123 | """Update ranges for text deletion at textRange""" | |
124 |
|
124 | |||
125 | for r in [self.inputPromptRange,self.inputRange, |
|
125 | for r in [self.inputPromptRange,self.inputRange, | |
126 | self.outputPromptRange, self.outputRange]: |
|
126 | self.outputPromptRange, self.outputRange]: | |
127 | if(r==None): |
|
127 | if(r==None): | |
128 | continue |
|
128 | continue | |
129 | intersection = NSIntersectionRange(r, textRange) |
|
129 | intersection = NSIntersectionRange(r, textRange) | |
130 | if(intersection.length == 0): #ranges don't intersect |
|
130 | if(intersection.length == 0): #ranges don't intersect | |
131 | if r.location >= textRange.location: |
|
131 | if r.location >= textRange.location: | |
132 | r.location -= textRange.length |
|
132 | r.location -= textRange.length | |
133 | else: #ranges intersect |
|
133 | else: #ranges intersect | |
134 | if(r.location > textRange.location): |
|
134 | if(r.location > textRange.location): | |
135 | offset = intersection.length |
|
135 | offset = intersection.length | |
136 | r.length -= offset |
|
136 | r.length -= offset | |
137 | r.location += offset |
|
137 | r.location += offset | |
138 | elif(r.location == textRange.location): |
|
138 | elif(r.location == textRange.location): | |
139 | r.length += intersection.length |
|
139 | r.length += intersection.length | |
140 | else: |
|
140 | else: | |
141 | r.length -= intersection.length |
|
141 | r.length -= intersection.length | |
142 |
|
142 | |||
143 | def __repr__(self): |
|
143 | def __repr__(self): | |
144 | return 'CellBlock('+ str((self.inputPromptRange, |
|
144 | return 'CellBlock('+ str((self.inputPromptRange, | |
145 | self.inputRange, |
|
145 | self.inputRange, | |
146 | self.outputPromptRange, |
|
146 | self.outputPromptRange, | |
147 | self.outputRange)) + ')' |
|
147 | self.outputRange)) + ')' | |
148 |
|
148 | |||
149 |
|
149 | |||
150 |
|
150 | |||
151 |
|
151 | |||
152 | class IPythonCocoaController(NSObject, AsyncFrontEndBase): |
|
152 | class IPythonCocoaController(NSObject, AsyncFrontEndBase): | |
153 | userNS = objc.ivar() #mirror of engine.user_ns (key=>str(value)) |
|
153 | userNS = objc.ivar() #mirror of engine.user_ns (key=>str(value)) | |
154 | waitingForEngine = objc.ivar().bool() |
|
154 | waitingForEngine = objc.ivar().bool() | |
155 | textView = objc.IBOutlet() |
|
155 | textView = objc.IBOutlet() | |
156 |
|
156 | |||
157 | def init(self): |
|
157 | def init(self): | |
158 | self = super(IPythonCocoaController, self).init() |
|
158 | self = super(IPythonCocoaController, self).init() | |
159 | AsyncFrontEndBase.__init__(self, |
|
159 | AsyncFrontEndBase.__init__(self, | |
160 | engine=AutoreleasePoolWrappedThreadedEngineService()) |
|
160 | engine=AutoreleasePoolWrappedThreadedEngineService()) | |
161 | if(self != None): |
|
161 | if(self != None): | |
162 | self._common_init() |
|
162 | self._common_init() | |
163 |
|
163 | |||
164 | return self |
|
164 | return self | |
165 |
|
165 | |||
166 | def _common_init(self): |
|
166 | def _common_init(self): | |
167 | """_common_init""" |
|
167 | """_common_init""" | |
168 |
|
168 | |||
169 | self.userNS = NSMutableDictionary.dictionary() |
|
169 | self.userNS = NSMutableDictionary.dictionary() | |
170 | self.waitingForEngine = False |
|
170 | self.waitingForEngine = False | |
171 |
|
171 | |||
172 | self.lines = {} |
|
172 | self.lines = {} | |
173 | self.tabSpaces = 4 |
|
173 | self.tabSpaces = 4 | |
174 | self.tabUsesSpaces = True |
|
174 | self.tabUsesSpaces = True | |
175 | self.currentBlockID = self.next_block_ID() |
|
175 | self.currentBlockID = self.next_block_ID() | |
176 | self.blockRanges = {} # blockID=>CellBlock |
|
176 | self.blockRanges = {} # blockID=>CellBlock | |
177 |
|
177 | |||
178 |
|
178 | |||
179 | def awakeFromNib(self): |
|
179 | def awakeFromNib(self): | |
180 | """awakeFromNib""" |
|
180 | """awakeFromNib""" | |
181 |
|
181 | |||
182 | self._common_init() |
|
182 | self._common_init() | |
183 |
|
183 | |||
184 | # Start the IPython engine |
|
184 | # Start the IPython engine | |
185 | self.engine.startService() |
|
185 | self.engine.startService() | |
186 | NSLog('IPython engine started') |
|
186 | NSLog('IPython engine started') | |
187 |
|
187 | |||
188 | # Register for app termination |
|
188 | # Register for app termination | |
189 | nc = NSNotificationCenter.defaultCenter() |
|
189 | nc = NSNotificationCenter.defaultCenter() | |
190 | nc.addObserver_selector_name_object_( |
|
190 | nc.addObserver_selector_name_object_( | |
191 | self, |
|
191 | self, | |
192 | 'appWillTerminate:', |
|
192 | 'appWillTerminate:', | |
193 | NSApplicationWillTerminateNotification, |
|
193 | NSApplicationWillTerminateNotification, | |
194 | None) |
|
194 | None) | |
195 |
|
195 | |||
196 | self.textView.setDelegate_(self) |
|
196 | self.textView.setDelegate_(self) | |
197 | self.textView.enclosingScrollView().setHasVerticalRuler_(True) |
|
197 | self.textView.enclosingScrollView().setHasVerticalRuler_(True) | |
198 | r = NSRulerView.alloc().initWithScrollView_orientation_( |
|
198 | r = NSRulerView.alloc().initWithScrollView_orientation_( | |
199 | self.textView.enclosingScrollView(), |
|
199 | self.textView.enclosingScrollView(), | |
200 | NSVerticalRuler) |
|
200 | NSVerticalRuler) | |
201 | self.verticalRulerView = r |
|
201 | self.verticalRulerView = r | |
202 | self.verticalRulerView.setClientView_(self.textView) |
|
202 | self.verticalRulerView.setClientView_(self.textView) | |
203 | self._start_cli_banner() |
|
203 | self._start_cli_banner() | |
204 | self.start_new_block() |
|
204 | self.start_new_block() | |
205 |
|
205 | |||
206 |
|
206 | |||
207 | def appWillTerminate_(self, notification): |
|
207 | def appWillTerminate_(self, notification): | |
208 | """appWillTerminate""" |
|
208 | """appWillTerminate""" | |
209 |
|
209 | |||
210 | self.engine.stopService() |
|
210 | self.engine.stopService() | |
211 |
|
211 | |||
212 |
|
212 | |||
213 | def complete(self, token): |
|
213 | def complete(self, token): | |
214 | """Complete token in engine's user_ns |
|
214 | """Complete token in engine's user_ns | |
215 |
|
215 | |||
216 | Parameters |
|
216 | Parameters | |
217 | ---------- |
|
217 | ---------- | |
218 | token : string |
|
218 | token : string | |
219 |
|
219 | |||
220 | Result |
|
220 | Result | |
221 | ------ |
|
221 | ------ | |
222 | Deferred result of |
|
222 | Deferred result of | |
223 | IPython.kernel.engineservice.IEngineBase.complete |
|
223 | IPython.kernel.engineservice.IEngineBase.complete | |
224 | """ |
|
224 | """ | |
225 |
|
225 | |||
226 | return self.engine.complete(token) |
|
226 | return self.engine.complete(token) | |
227 |
|
227 | |||
228 |
|
228 | |||
229 | def execute(self, block, blockID=None): |
|
229 | def execute(self, block, blockID=None): | |
230 | self.waitingForEngine = True |
|
230 | self.waitingForEngine = True | |
231 | self.willChangeValueForKey_('commandHistory') |
|
231 | self.willChangeValueForKey_('commandHistory') | |
232 | d = super(IPythonCocoaController, self).execute(block, |
|
232 | d = super(IPythonCocoaController, self).execute(block, | |
233 | blockID) |
|
233 | blockID) | |
234 | d.addBoth(self._engine_done) |
|
234 | d.addBoth(self._engine_done) | |
235 | d.addCallback(self._update_user_ns) |
|
235 | d.addCallback(self._update_user_ns) | |
236 |
|
236 | |||
237 | return d |
|
237 | return d | |
238 |
|
238 | |||
239 |
|
239 | |||
240 | def push_(self, namespace): |
|
240 | def push_(self, namespace): | |
241 | """Push dictionary of key=>values to python namespace""" |
|
241 | """Push dictionary of key=>values to python namespace""" | |
242 |
|
242 | |||
243 | self.waitingForEngine = True |
|
243 | self.waitingForEngine = True | |
244 | self.willChangeValueForKey_('commandHistory') |
|
244 | self.willChangeValueForKey_('commandHistory') | |
245 | d = self.engine.push(namespace) |
|
245 | d = self.engine.push(namespace) | |
246 | d.addBoth(self._engine_done) |
|
246 | d.addBoth(self._engine_done) | |
247 | d.addCallback(self._update_user_ns) |
|
247 | d.addCallback(self._update_user_ns) | |
248 |
|
248 | |||
249 |
|
249 | |||
250 | def pull_(self, keys): |
|
250 | def pull_(self, keys): | |
251 | """Pull keys from python namespace""" |
|
251 | """Pull keys from python namespace""" | |
252 |
|
252 | |||
253 | self.waitingForEngine = True |
|
253 | self.waitingForEngine = True | |
254 | result = blockingCallFromThread(self.engine.pull, keys) |
|
254 | result = blockingCallFromThread(self.engine.pull, keys) | |
255 | self.waitingForEngine = False |
|
255 | self.waitingForEngine = False | |
256 |
|
256 | |||
257 | @objc.signature('v@:@I') |
|
257 | @objc.signature('v@:@I') | |
258 | def executeFileAtPath_encoding_(self, path, encoding): |
|
258 | def executeFileAtPath_encoding_(self, path, encoding): | |
259 | """Execute file at path in an empty namespace. Update the engine |
|
259 | """Execute file at path in an empty namespace. Update the engine | |
260 | user_ns with the resulting locals.""" |
|
260 | user_ns with the resulting locals.""" | |
261 |
|
261 | |||
262 | lines,err = NSString.stringWithContentsOfFile_encoding_error_( |
|
262 | lines,err = NSString.stringWithContentsOfFile_encoding_error_( | |
263 | path, |
|
263 | path, | |
264 | encoding, |
|
264 | encoding, | |
265 | None) |
|
265 | None) | |
266 | self.engine.execute(lines) |
|
266 | self.engine.execute(lines) | |
267 |
|
267 | |||
268 |
|
268 | |||
269 | def _engine_done(self, x): |
|
269 | def _engine_done(self, x): | |
270 | self.waitingForEngine = False |
|
270 | self.waitingForEngine = False | |
271 | self.didChangeValueForKey_('commandHistory') |
|
271 | self.didChangeValueForKey_('commandHistory') | |
272 | return x |
|
272 | return x | |
273 |
|
273 | |||
274 | def _update_user_ns(self, result): |
|
274 | def _update_user_ns(self, result): | |
275 | """Update self.userNS from self.engine's namespace""" |
|
275 | """Update self.userNS from self.engine's namespace""" | |
276 | d = self.engine.keys() |
|
276 | d = self.engine.keys() | |
277 | d.addCallback(self._get_engine_namespace_values_for_keys) |
|
277 | d.addCallback(self._get_engine_namespace_values_for_keys) | |
278 |
|
278 | |||
279 | return result |
|
279 | return result | |
280 |
|
280 | |||
281 |
|
281 | |||
282 | def _get_engine_namespace_values_for_keys(self, keys): |
|
282 | def _get_engine_namespace_values_for_keys(self, keys): | |
283 | d = self.engine.pull(keys) |
|
283 | d = self.engine.pull(keys) | |
284 | d.addCallback(self._store_engine_namespace_values, keys=keys) |
|
284 | d.addCallback(self._store_engine_namespace_values, keys=keys) | |
285 |
|
285 | |||
286 |
|
286 | |||
287 | def _store_engine_namespace_values(self, values, keys=[]): |
|
287 | def _store_engine_namespace_values(self, values, keys=[]): | |
288 | assert(len(values) == len(keys)) |
|
288 | assert(len(values) == len(keys)) | |
289 | self.willChangeValueForKey_('userNS') |
|
289 | self.willChangeValueForKey_('userNS') | |
290 | for (k,v) in zip(keys,values): |
|
290 | for (k,v) in zip(keys,values): | |
291 | self.userNS[k] = saferepr(v) |
|
291 | self.userNS[k] = saferepr(v) | |
292 | self.didChangeValueForKey_('userNS') |
|
292 | self.didChangeValueForKey_('userNS') | |
293 |
|
293 | |||
294 |
|
294 | |||
295 | def update_cell_prompt(self, result, blockID=None): |
|
295 | def update_cell_prompt(self, result, blockID=None): | |
296 | print self.blockRanges |
|
296 | print self.blockRanges | |
297 | if(isinstance(result, Failure)): |
|
297 | if(isinstance(result, Failure)): | |
298 | prompt = self.input_prompt() |
|
298 | prompt = self.input_prompt() | |
299 |
|
299 | |||
300 | else: |
|
300 | else: | |
301 | prompt = self.input_prompt(number=result['number']) |
|
301 | prompt = self.input_prompt(number=result['number']) | |
302 |
|
302 | |||
303 | r = self.blockRanges[blockID].inputPromptRange |
|
303 | r = self.blockRanges[blockID].inputPromptRange | |
304 | self.insert_text(prompt, |
|
304 | self.insert_text(prompt, | |
305 | textRange=r, |
|
305 | textRange=r, | |
306 | scrollToVisible=False |
|
306 | scrollToVisible=False | |
307 | ) |
|
307 | ) | |
308 |
|
308 | |||
309 | return result |
|
309 | return result | |
310 |
|
310 | |||
311 |
|
311 | |||
312 | def render_result(self, result): |
|
312 | def render_result(self, result): | |
313 | blockID = result['blockID'] |
|
313 | blockID = result['blockID'] | |
314 | inputRange = self.blockRanges[blockID].inputRange |
|
314 | inputRange = self.blockRanges[blockID].inputRange | |
315 | del self.blockRanges[blockID] |
|
315 | del self.blockRanges[blockID] | |
316 |
|
316 | |||
317 | #print inputRange,self.current_block_range() |
|
317 | #print inputRange,self.current_block_range() | |
318 | self.insert_text('\n' + |
|
318 | self.insert_text('\n' + | |
319 | self.output_prompt(number=result['number']) + |
|
319 | self.output_prompt(number=result['number']) + | |
320 | result.get('display',{}).get('pprint','') + |
|
320 | result.get('display',{}).get('pprint','') + | |
321 | '\n\n', |
|
321 | '\n\n', | |
322 | textRange=NSMakeRange(inputRange.location+inputRange.length, |
|
322 | textRange=NSMakeRange(inputRange.location+inputRange.length, | |
323 | 0)) |
|
323 | 0)) | |
324 | return result |
|
324 | return result | |
325 |
|
325 | |||
326 |
|
326 | |||
327 | def render_error(self, failure): |
|
327 | def render_error(self, failure): | |
328 | print failure |
|
328 | print failure | |
329 | blockID = failure.blockID |
|
329 | blockID = failure.blockID | |
330 | inputRange = self.blockRanges[blockID].inputRange |
|
330 | inputRange = self.blockRanges[blockID].inputRange | |
331 | self.insert_text('\n' + |
|
331 | self.insert_text('\n' + | |
332 | self.output_prompt() + |
|
332 | self.output_prompt() + | |
333 | '\n' + |
|
333 | '\n' + | |
334 | failure.getErrorMessage() + |
|
334 | failure.getErrorMessage() + | |
335 | '\n\n', |
|
335 | '\n\n', | |
336 | textRange=NSMakeRange(inputRange.location + |
|
336 | textRange=NSMakeRange(inputRange.location + | |
337 | inputRange.length, |
|
337 | inputRange.length, | |
338 | 0)) |
|
338 | 0)) | |
339 | self.start_new_block() |
|
339 | self.start_new_block() | |
340 | return failure |
|
340 | return failure | |
341 |
|
341 | |||
342 |
|
342 | |||
343 | def _start_cli_banner(self): |
|
343 | def _start_cli_banner(self): | |
344 | """Print banner""" |
|
344 | """Print banner""" | |
345 |
|
345 | |||
346 | banner = """IPython1 %s -- An enhanced Interactive Python.""" % \ |
|
346 | banner = """IPython1 %s -- An enhanced Interactive Python.""" % \ | |
347 | IPython.__version__ |
|
347 | IPython.__version__ | |
348 |
|
348 | |||
349 | self.insert_text(banner + '\n\n') |
|
349 | self.insert_text(banner + '\n\n') | |
350 |
|
350 | |||
351 |
|
351 | |||
352 | def start_new_block(self): |
|
352 | def start_new_block(self): | |
353 | """""" |
|
353 | """""" | |
354 |
|
354 | |||
355 | self.currentBlockID = self.next_block_ID() |
|
355 | self.currentBlockID = self.next_block_ID() | |
356 | self.blockRanges[self.currentBlockID] = self.new_cell_block() |
|
356 | self.blockRanges[self.currentBlockID] = self.new_cell_block() | |
357 | self.insert_text(self.input_prompt(), |
|
357 | self.insert_text(self.input_prompt(), | |
358 | textRange=self.current_block_range().inputPromptRange) |
|
358 | textRange=self.current_block_range().inputPromptRange) | |
359 |
|
359 | |||
360 |
|
360 | |||
361 |
|
361 | |||
362 | def next_block_ID(self): |
|
362 | def next_block_ID(self): | |
363 |
|
363 | |||
364 |
return |
|
364 | return uuid.uuid4() | |
365 |
|
365 | |||
366 | def new_cell_block(self): |
|
366 | def new_cell_block(self): | |
367 | """A new CellBlock at the end of self.textView.textStorage()""" |
|
367 | """A new CellBlock at the end of self.textView.textStorage()""" | |
368 |
|
368 | |||
369 | return CellBlock(NSMakeRange(self.textView.textStorage().length(), |
|
369 | return CellBlock(NSMakeRange(self.textView.textStorage().length(), | |
370 | 0), #len(self.input_prompt())), |
|
370 | 0), #len(self.input_prompt())), | |
371 | NSMakeRange(self.textView.textStorage().length(),# + len(self.input_prompt()), |
|
371 | NSMakeRange(self.textView.textStorage().length(),# + len(self.input_prompt()), | |
372 | 0)) |
|
372 | 0)) | |
373 |
|
373 | |||
374 |
|
374 | |||
375 | def current_block_range(self): |
|
375 | def current_block_range(self): | |
376 | return self.blockRanges.get(self.currentBlockID, |
|
376 | return self.blockRanges.get(self.currentBlockID, | |
377 | self.new_cell_block()) |
|
377 | self.new_cell_block()) | |
378 |
|
378 | |||
379 | def current_block(self): |
|
379 | def current_block(self): | |
380 | """The current block's text""" |
|
380 | """The current block's text""" | |
381 |
|
381 | |||
382 | return self.text_for_range(self.current_block_range().inputRange) |
|
382 | return self.text_for_range(self.current_block_range().inputRange) | |
383 |
|
383 | |||
384 | def text_for_range(self, textRange): |
|
384 | def text_for_range(self, textRange): | |
385 | """text_for_range""" |
|
385 | """text_for_range""" | |
386 |
|
386 | |||
387 | ts = self.textView.textStorage() |
|
387 | ts = self.textView.textStorage() | |
388 | return ts.string().substringWithRange_(textRange) |
|
388 | return ts.string().substringWithRange_(textRange) | |
389 |
|
389 | |||
390 | def current_line(self): |
|
390 | def current_line(self): | |
391 | block = self.text_for_range(self.current_block_range().inputRange) |
|
391 | block = self.text_for_range(self.current_block_range().inputRange) | |
392 | block = block.split('\n') |
|
392 | block = block.split('\n') | |
393 | return block[-1] |
|
393 | return block[-1] | |
394 |
|
394 | |||
395 |
|
395 | |||
396 | def insert_text(self, string=None, textRange=None, scrollToVisible=True): |
|
396 | def insert_text(self, string=None, textRange=None, scrollToVisible=True): | |
397 | """Insert text into textView at textRange, updating blockRanges |
|
397 | """Insert text into textView at textRange, updating blockRanges | |
398 | as necessary |
|
398 | as necessary | |
399 | """ |
|
399 | """ | |
400 | if(textRange == None): |
|
400 | if(textRange == None): | |
401 | #range for end of text |
|
401 | #range for end of text | |
402 | textRange = NSMakeRange(self.textView.textStorage().length(), 0) |
|
402 | textRange = NSMakeRange(self.textView.textStorage().length(), 0) | |
403 |
|
403 | |||
404 |
|
404 | |||
405 | self.textView.replaceCharactersInRange_withString_( |
|
405 | self.textView.replaceCharactersInRange_withString_( | |
406 | textRange, string) |
|
406 | textRange, string) | |
407 |
|
407 | |||
408 | for r in self.blockRanges.itervalues(): |
|
408 | for r in self.blockRanges.itervalues(): | |
409 | r.update_ranges_for_insertion(string, textRange) |
|
409 | r.update_ranges_for_insertion(string, textRange) | |
410 |
|
410 | |||
411 | self.textView.setSelectedRange_(textRange) |
|
411 | self.textView.setSelectedRange_(textRange) | |
412 | if(scrollToVisible): |
|
412 | if(scrollToVisible): | |
413 | self.textView.scrollRangeToVisible_(textRange) |
|
413 | self.textView.scrollRangeToVisible_(textRange) | |
414 |
|
414 | |||
415 |
|
415 | |||
416 |
|
416 | |||
417 | def replace_current_block_with_string(self, textView, string): |
|
417 | def replace_current_block_with_string(self, textView, string): | |
418 | textView.replaceCharactersInRange_withString_( |
|
418 | textView.replaceCharactersInRange_withString_( | |
419 | self.current_block_range().inputRange, |
|
419 | self.current_block_range().inputRange, | |
420 | string) |
|
420 | string) | |
421 | self.current_block_range().inputRange.length = len(string) |
|
421 | self.current_block_range().inputRange.length = len(string) | |
422 | r = NSMakeRange(textView.textStorage().length(), 0) |
|
422 | r = NSMakeRange(textView.textStorage().length(), 0) | |
423 | textView.scrollRangeToVisible_(r) |
|
423 | textView.scrollRangeToVisible_(r) | |
424 | textView.setSelectedRange_(r) |
|
424 | textView.setSelectedRange_(r) | |
425 |
|
425 | |||
426 |
|
426 | |||
427 | def current_indent_string(self): |
|
427 | def current_indent_string(self): | |
428 | """returns string for indent or None if no indent""" |
|
428 | """returns string for indent or None if no indent""" | |
429 |
|
429 | |||
430 | return self._indent_for_block(self.current_block()) |
|
430 | return self._indent_for_block(self.current_block()) | |
431 |
|
431 | |||
432 |
|
432 | |||
433 | def _indent_for_block(self, block): |
|
433 | def _indent_for_block(self, block): | |
434 | lines = block.split('\n') |
|
434 | lines = block.split('\n') | |
435 | if(len(lines) > 1): |
|
435 | if(len(lines) > 1): | |
436 | currentIndent = len(lines[-1]) - len(lines[-1].lstrip()) |
|
436 | currentIndent = len(lines[-1]) - len(lines[-1].lstrip()) | |
437 | if(currentIndent == 0): |
|
437 | if(currentIndent == 0): | |
438 | currentIndent = self.tabSpaces |
|
438 | currentIndent = self.tabSpaces | |
439 |
|
439 | |||
440 | if(self.tabUsesSpaces): |
|
440 | if(self.tabUsesSpaces): | |
441 | result = ' ' * currentIndent |
|
441 | result = ' ' * currentIndent | |
442 | else: |
|
442 | else: | |
443 | result = '\t' * (currentIndent/self.tabSpaces) |
|
443 | result = '\t' * (currentIndent/self.tabSpaces) | |
444 | else: |
|
444 | else: | |
445 | result = None |
|
445 | result = None | |
446 |
|
446 | |||
447 | return result |
|
447 | return result | |
448 |
|
448 | |||
449 |
|
449 | |||
450 | # NSTextView delegate methods... |
|
450 | # NSTextView delegate methods... | |
451 | def textView_doCommandBySelector_(self, textView, selector): |
|
451 | def textView_doCommandBySelector_(self, textView, selector): | |
452 | assert(textView == self.textView) |
|
452 | assert(textView == self.textView) | |
453 | NSLog("textView_doCommandBySelector_: "+selector) |
|
453 | NSLog("textView_doCommandBySelector_: "+selector) | |
454 |
|
454 | |||
455 |
|
455 | |||
456 | if(selector == 'insertNewline:'): |
|
456 | if(selector == 'insertNewline:'): | |
457 | indent = self.current_indent_string() |
|
457 | indent = self.current_indent_string() | |
458 | if(indent): |
|
458 | if(indent): | |
459 | line = indent + self.current_line() |
|
459 | line = indent + self.current_line() | |
460 | else: |
|
460 | else: | |
461 | line = self.current_line() |
|
461 | line = self.current_line() | |
462 |
|
462 | |||
463 | if(self.is_complete(self.current_block())): |
|
463 | if(self.is_complete(self.current_block())): | |
464 | self.execute(self.current_block(), |
|
464 | self.execute(self.current_block(), | |
465 | blockID=self.currentBlockID) |
|
465 | blockID=self.currentBlockID) | |
466 | self.start_new_block() |
|
466 | self.start_new_block() | |
467 |
|
467 | |||
468 | return True |
|
468 | return True | |
469 |
|
469 | |||
470 | return False |
|
470 | return False | |
471 |
|
471 | |||
472 | elif(selector == 'moveUp:'): |
|
472 | elif(selector == 'moveUp:'): | |
473 | prevBlock = self.get_history_previous(self.current_block()) |
|
473 | prevBlock = self.get_history_previous(self.current_block()) | |
474 | if(prevBlock != None): |
|
474 | if(prevBlock != None): | |
475 | self.replace_current_block_with_string(textView, prevBlock) |
|
475 | self.replace_current_block_with_string(textView, prevBlock) | |
476 | else: |
|
476 | else: | |
477 | NSBeep() |
|
477 | NSBeep() | |
478 | return True |
|
478 | return True | |
479 |
|
479 | |||
480 | elif(selector == 'moveDown:'): |
|
480 | elif(selector == 'moveDown:'): | |
481 | nextBlock = self.get_history_next() |
|
481 | nextBlock = self.get_history_next() | |
482 | if(nextBlock != None): |
|
482 | if(nextBlock != None): | |
483 | self.replace_current_block_with_string(textView, nextBlock) |
|
483 | self.replace_current_block_with_string(textView, nextBlock) | |
484 | else: |
|
484 | else: | |
485 | NSBeep() |
|
485 | NSBeep() | |
486 | return True |
|
486 | return True | |
487 |
|
487 | |||
488 | elif(selector == 'moveToBeginningOfParagraph:'): |
|
488 | elif(selector == 'moveToBeginningOfParagraph:'): | |
489 | textView.setSelectedRange_(NSMakeRange( |
|
489 | textView.setSelectedRange_(NSMakeRange( | |
490 | self.current_block_range().inputRange.location, |
|
490 | self.current_block_range().inputRange.location, | |
491 | 0)) |
|
491 | 0)) | |
492 | return True |
|
492 | return True | |
493 | elif(selector == 'moveToEndOfParagraph:'): |
|
493 | elif(selector == 'moveToEndOfParagraph:'): | |
494 | textView.setSelectedRange_(NSMakeRange( |
|
494 | textView.setSelectedRange_(NSMakeRange( | |
495 | self.current_block_range().inputRange.location + \ |
|
495 | self.current_block_range().inputRange.location + \ | |
496 | self.current_block_range().inputRange.length, 0)) |
|
496 | self.current_block_range().inputRange.length, 0)) | |
497 | return True |
|
497 | return True | |
498 | elif(selector == 'deleteToEndOfParagraph:'): |
|
498 | elif(selector == 'deleteToEndOfParagraph:'): | |
499 | if(textView.selectedRange().location <= \ |
|
499 | if(textView.selectedRange().location <= \ | |
500 | self.current_block_range().location): |
|
500 | self.current_block_range().location): | |
501 | raise NotImplemented() |
|
501 | raise NotImplemented() | |
502 |
|
502 | |||
503 | return False # don't actually handle the delete |
|
503 | return False # don't actually handle the delete | |
504 |
|
504 | |||
505 | elif(selector == 'insertTab:'): |
|
505 | elif(selector == 'insertTab:'): | |
506 | if(len(self.current_line().strip()) == 0): #only white space |
|
506 | if(len(self.current_line().strip()) == 0): #only white space | |
507 | return False |
|
507 | return False | |
508 | else: |
|
508 | else: | |
509 | self.textView.complete_(self) |
|
509 | self.textView.complete_(self) | |
510 | return True |
|
510 | return True | |
511 |
|
511 | |||
512 | elif(selector == 'deleteBackward:'): |
|
512 | elif(selector == 'deleteBackward:'): | |
513 | #if we're at the beginning of the current block, ignore |
|
513 | #if we're at the beginning of the current block, ignore | |
514 | if(textView.selectedRange().location == \ |
|
514 | if(textView.selectedRange().location == \ | |
515 | self.current_block_range().inputRange.location): |
|
515 | self.current_block_range().inputRange.location): | |
516 | return True |
|
516 | return True | |
517 | else: |
|
517 | else: | |
518 | for r in self.blockRanges.itervalues(): |
|
518 | for r in self.blockRanges.itervalues(): | |
519 | deleteRange = textView.selectedRange |
|
519 | deleteRange = textView.selectedRange | |
520 | if(deleteRange.length == 0): |
|
520 | if(deleteRange.length == 0): | |
521 | deleteRange.location -= 1 |
|
521 | deleteRange.location -= 1 | |
522 | deleteRange.length = 1 |
|
522 | deleteRange.length = 1 | |
523 | r.update_ranges_for_deletion(deleteRange) |
|
523 | r.update_ranges_for_deletion(deleteRange) | |
524 | return False |
|
524 | return False | |
525 | return False |
|
525 | return False | |
526 |
|
526 | |||
527 |
|
527 | |||
528 | def textView_shouldChangeTextInRanges_replacementStrings_(self, |
|
528 | def textView_shouldChangeTextInRanges_replacementStrings_(self, | |
529 | textView, ranges, replacementStrings): |
|
529 | textView, ranges, replacementStrings): | |
530 | """ |
|
530 | """ | |
531 | Delegate method for NSTextView. |
|
531 | Delegate method for NSTextView. | |
532 |
|
532 | |||
533 | Refuse change text in ranges not at end, but make those changes at |
|
533 | Refuse change text in ranges not at end, but make those changes at | |
534 | end. |
|
534 | end. | |
535 | """ |
|
535 | """ | |
536 |
|
536 | |||
537 | assert(len(ranges) == len(replacementStrings)) |
|
537 | assert(len(ranges) == len(replacementStrings)) | |
538 | allow = True |
|
538 | allow = True | |
539 | for r,s in zip(ranges, replacementStrings): |
|
539 | for r,s in zip(ranges, replacementStrings): | |
540 | r = r.rangeValue() |
|
540 | r = r.rangeValue() | |
541 | if(textView.textStorage().length() > 0 and |
|
541 | if(textView.textStorage().length() > 0 and | |
542 | r.location < self.current_block_range().inputRange.location): |
|
542 | r.location < self.current_block_range().inputRange.location): | |
543 | self.insert_text(s) |
|
543 | self.insert_text(s) | |
544 | allow = False |
|
544 | allow = False | |
545 |
|
545 | |||
546 | return allow |
|
546 | return allow | |
547 |
|
547 | |||
548 | def textView_completions_forPartialWordRange_indexOfSelectedItem_(self, |
|
548 | def textView_completions_forPartialWordRange_indexOfSelectedItem_(self, | |
549 | textView, words, charRange, index): |
|
549 | textView, words, charRange, index): | |
550 | try: |
|
550 | try: | |
551 | ts = textView.textStorage() |
|
551 | ts = textView.textStorage() | |
552 | token = ts.string().substringWithRange_(charRange) |
|
552 | token = ts.string().substringWithRange_(charRange) | |
553 | completions = blockingCallFromThread(self.complete, token) |
|
553 | completions = blockingCallFromThread(self.complete, token) | |
554 | except: |
|
554 | except: | |
555 | completions = objc.nil |
|
555 | completions = objc.nil | |
556 | NSBeep() |
|
556 | NSBeep() | |
557 |
|
557 | |||
558 | return (completions,0) |
|
558 | return (completions,0) | |
559 |
|
559 | |||
560 |
|
560 |
@@ -1,343 +1,343 b'' | |||||
1 | # encoding: utf-8 |
|
1 | # encoding: utf-8 | |
2 | # -*- test-case-name: IPython.frontend.tests.test_frontendbase -*- |
|
2 | # -*- test-case-name: IPython.frontend.tests.test_frontendbase -*- | |
3 | """ |
|
3 | """ | |
4 | frontendbase provides an interface and base class for GUI frontends for |
|
4 | frontendbase provides an interface and base class for GUI frontends for | |
5 | IPython.kernel/IPython.kernel.core. |
|
5 | IPython.kernel/IPython.kernel.core. | |
6 |
|
6 | |||
7 | Frontend implementations will likely want to subclass FrontEndBase. |
|
7 | Frontend implementations will likely want to subclass FrontEndBase. | |
8 |
|
8 | |||
9 | Author: Barry Wark |
|
9 | Author: Barry Wark | |
10 | """ |
|
10 | """ | |
11 | __docformat__ = "restructuredtext en" |
|
11 | __docformat__ = "restructuredtext en" | |
12 |
|
12 | |||
13 | #------------------------------------------------------------------------------- |
|
13 | #------------------------------------------------------------------------------- | |
14 | # Copyright (C) 2008-2011 The IPython Development Team |
|
14 | # Copyright (C) 2008-2011 The IPython Development Team | |
15 | # |
|
15 | # | |
16 | # Distributed under the terms of the BSD License. The full license is in |
|
16 | # Distributed under the terms of the BSD License. The full license is in | |
17 | # the file COPYING, distributed as part of this software. |
|
17 | # the file COPYING, distributed as part of this software. | |
18 | #------------------------------------------------------------------------------- |
|
18 | #------------------------------------------------------------------------------- | |
19 |
|
19 | |||
20 | #------------------------------------------------------------------------------- |
|
20 | #------------------------------------------------------------------------------- | |
21 | # Imports |
|
21 | # Imports | |
22 | #------------------------------------------------------------------------------- |
|
22 | #------------------------------------------------------------------------------- | |
23 | import string |
|
23 | import string | |
24 | import codeop |
|
24 | import codeop | |
25 | from IPython.external import guid |
|
25 | import uuid | |
26 |
|
26 | |||
27 |
|
27 | |||
28 | from IPython.frontend.zopeinterface import ( |
|
28 | from IPython.frontend.zopeinterface import ( | |
29 | Interface, |
|
29 | Interface, | |
30 | Attribute, |
|
30 | Attribute, | |
31 | ) |
|
31 | ) | |
32 | from IPython.kernel.core.history import FrontEndHistory |
|
32 | from IPython.kernel.core.history import FrontEndHistory | |
33 | from IPython.kernel.core.util import Bunch |
|
33 | from IPython.kernel.core.util import Bunch | |
34 |
|
34 | |||
35 | ############################################################################## |
|
35 | ############################################################################## | |
36 | # TEMPORARY!!! fake configuration, while we decide whether to use tconfig or |
|
36 | # TEMPORARY!!! fake configuration, while we decide whether to use tconfig or | |
37 | # not |
|
37 | # not | |
38 |
|
38 | |||
39 | rc = Bunch() |
|
39 | rc = Bunch() | |
40 | rc.prompt_in1 = r'In [$number]: ' |
|
40 | rc.prompt_in1 = r'In [$number]: ' | |
41 | rc.prompt_in2 = r'...' |
|
41 | rc.prompt_in2 = r'...' | |
42 | rc.prompt_out = r'Out [$number]: ' |
|
42 | rc.prompt_out = r'Out [$number]: ' | |
43 |
|
43 | |||
44 | ############################################################################## |
|
44 | ############################################################################## | |
45 | # Interface definitions |
|
45 | # Interface definitions | |
46 | ############################################################################## |
|
46 | ############################################################################## | |
47 |
|
47 | |||
48 | class IFrontEndFactory(Interface): |
|
48 | class IFrontEndFactory(Interface): | |
49 | """Factory interface for frontends.""" |
|
49 | """Factory interface for frontends.""" | |
50 |
|
50 | |||
51 | def __call__(engine=None, history=None): |
|
51 | def __call__(engine=None, history=None): | |
52 | """ |
|
52 | """ | |
53 | Parameters: |
|
53 | Parameters: | |
54 | interpreter : IPython.kernel.engineservice.IEngineCore |
|
54 | interpreter : IPython.kernel.engineservice.IEngineCore | |
55 | """ |
|
55 | """ | |
56 |
|
56 | |||
57 | pass |
|
57 | pass | |
58 |
|
58 | |||
59 |
|
59 | |||
60 | class IFrontEnd(Interface): |
|
60 | class IFrontEnd(Interface): | |
61 | """Interface for frontends. All methods return t.i.d.Deferred""" |
|
61 | """Interface for frontends. All methods return t.i.d.Deferred""" | |
62 |
|
62 | |||
63 | Attribute("input_prompt_template", "string.Template instance\ |
|
63 | Attribute("input_prompt_template", "string.Template instance\ | |
64 | substituteable with execute result.") |
|
64 | substituteable with execute result.") | |
65 | Attribute("output_prompt_template", "string.Template instance\ |
|
65 | Attribute("output_prompt_template", "string.Template instance\ | |
66 | substituteable with execute result.") |
|
66 | substituteable with execute result.") | |
67 | Attribute("continuation_prompt_template", "string.Template instance\ |
|
67 | Attribute("continuation_prompt_template", "string.Template instance\ | |
68 | substituteable with execute result.") |
|
68 | substituteable with execute result.") | |
69 |
|
69 | |||
70 | def update_cell_prompt(result, blockID=None): |
|
70 | def update_cell_prompt(result, blockID=None): | |
71 | """Subclass may override to update the input prompt for a block. |
|
71 | """Subclass may override to update the input prompt for a block. | |
72 |
|
72 | |||
73 | In asynchronous frontends, this method will be called as a |
|
73 | In asynchronous frontends, this method will be called as a | |
74 | twisted.internet.defer.Deferred's callback/errback. |
|
74 | twisted.internet.defer.Deferred's callback/errback. | |
75 | Implementations should thus return result when finished. |
|
75 | Implementations should thus return result when finished. | |
76 |
|
76 | |||
77 | Result is a result dict in case of success, and a |
|
77 | Result is a result dict in case of success, and a | |
78 | twisted.python.util.failure.Failure in case of an error |
|
78 | twisted.python.util.failure.Failure in case of an error | |
79 | """ |
|
79 | """ | |
80 |
|
80 | |||
81 | pass |
|
81 | pass | |
82 |
|
82 | |||
83 | def render_result(result): |
|
83 | def render_result(result): | |
84 | """Render the result of an execute call. Implementors may choose the |
|
84 | """Render the result of an execute call. Implementors may choose the | |
85 | method of rendering. |
|
85 | method of rendering. | |
86 | For example, a notebook-style frontend might render a Chaco plot |
|
86 | For example, a notebook-style frontend might render a Chaco plot | |
87 | inline. |
|
87 | inline. | |
88 |
|
88 | |||
89 | Parameters: |
|
89 | Parameters: | |
90 | result : dict (result of IEngineBase.execute ) |
|
90 | result : dict (result of IEngineBase.execute ) | |
91 | blockID = result['blockID'] |
|
91 | blockID = result['blockID'] | |
92 |
|
92 | |||
93 | Result: |
|
93 | Result: | |
94 | Output of frontend rendering |
|
94 | Output of frontend rendering | |
95 | """ |
|
95 | """ | |
96 |
|
96 | |||
97 | pass |
|
97 | pass | |
98 |
|
98 | |||
99 | def render_error(failure): |
|
99 | def render_error(failure): | |
100 | """Subclasses must override to render the failure. |
|
100 | """Subclasses must override to render the failure. | |
101 |
|
101 | |||
102 | In asynchronous frontend, since this method will be called as a |
|
102 | In asynchronous frontend, since this method will be called as a | |
103 | twisted.internet.defer.Deferred's callback. Implementations |
|
103 | twisted.internet.defer.Deferred's callback. Implementations | |
104 | should thus return result when finished. |
|
104 | should thus return result when finished. | |
105 |
|
105 | |||
106 | blockID = failure.blockID |
|
106 | blockID = failure.blockID | |
107 | """ |
|
107 | """ | |
108 |
|
108 | |||
109 | pass |
|
109 | pass | |
110 |
|
110 | |||
111 | def input_prompt(number=''): |
|
111 | def input_prompt(number=''): | |
112 | """Returns the input prompt by subsituting into |
|
112 | """Returns the input prompt by subsituting into | |
113 | self.input_prompt_template |
|
113 | self.input_prompt_template | |
114 | """ |
|
114 | """ | |
115 | pass |
|
115 | pass | |
116 |
|
116 | |||
117 | def output_prompt(number=''): |
|
117 | def output_prompt(number=''): | |
118 | """Returns the output prompt by subsituting into |
|
118 | """Returns the output prompt by subsituting into | |
119 | self.output_prompt_template |
|
119 | self.output_prompt_template | |
120 | """ |
|
120 | """ | |
121 |
|
121 | |||
122 | pass |
|
122 | pass | |
123 |
|
123 | |||
124 | def continuation_prompt(): |
|
124 | def continuation_prompt(): | |
125 | """Returns the continuation prompt by subsituting into |
|
125 | """Returns the continuation prompt by subsituting into | |
126 | self.continuation_prompt_template |
|
126 | self.continuation_prompt_template | |
127 | """ |
|
127 | """ | |
128 |
|
128 | |||
129 | pass |
|
129 | pass | |
130 |
|
130 | |||
131 | def is_complete(block): |
|
131 | def is_complete(block): | |
132 | """Returns True if block is complete, False otherwise.""" |
|
132 | """Returns True if block is complete, False otherwise.""" | |
133 |
|
133 | |||
134 | pass |
|
134 | pass | |
135 |
|
135 | |||
136 |
|
136 | |||
137 | def get_history_previous(current_block): |
|
137 | def get_history_previous(current_block): | |
138 | """Returns the block previous in the history. Saves currentBlock if |
|
138 | """Returns the block previous in the history. Saves currentBlock if | |
139 | the history_cursor is currently at the end of the input history""" |
|
139 | the history_cursor is currently at the end of the input history""" | |
140 | pass |
|
140 | pass | |
141 |
|
141 | |||
142 | def get_history_next(): |
|
142 | def get_history_next(): | |
143 | """Returns the next block in the history.""" |
|
143 | """Returns the next block in the history.""" | |
144 |
|
144 | |||
145 | pass |
|
145 | pass | |
146 |
|
146 | |||
147 | def complete(self, line): |
|
147 | def complete(self, line): | |
148 | """Returns the list of possible completions, and the completed |
|
148 | """Returns the list of possible completions, and the completed | |
149 | line. |
|
149 | line. | |
150 |
|
150 | |||
151 | The input argument is the full line to be completed. This method |
|
151 | The input argument is the full line to be completed. This method | |
152 | returns both the line completed as much as possible, and the list |
|
152 | returns both the line completed as much as possible, and the list | |
153 | of further possible completions (full words). |
|
153 | of further possible completions (full words). | |
154 | """ |
|
154 | """ | |
155 | pass |
|
155 | pass | |
156 |
|
156 | |||
157 |
|
157 | |||
158 | ############################################################################## |
|
158 | ############################################################################## | |
159 | # Base class for all the frontends. |
|
159 | # Base class for all the frontends. | |
160 | ############################################################################## |
|
160 | ############################################################################## | |
161 |
|
161 | |||
162 | class FrontEndBase(object): |
|
162 | class FrontEndBase(object): | |
163 | """ |
|
163 | """ | |
164 | FrontEndBase manages the state tasks for a CLI frontend: |
|
164 | FrontEndBase manages the state tasks for a CLI frontend: | |
165 | - Input and output history management |
|
165 | - Input and output history management | |
166 | - Input/continuation and output prompt generation |
|
166 | - Input/continuation and output prompt generation | |
167 |
|
167 | |||
168 | Some issues (due to possibly unavailable engine): |
|
168 | Some issues (due to possibly unavailable engine): | |
169 | - How do we get the current cell number for the engine? |
|
169 | - How do we get the current cell number for the engine? | |
170 | - How do we handle completions? |
|
170 | - How do we handle completions? | |
171 | """ |
|
171 | """ | |
172 |
|
172 | |||
173 | history_cursor = 0 |
|
173 | history_cursor = 0 | |
174 |
|
174 | |||
175 | input_prompt_template = string.Template(rc.prompt_in1) |
|
175 | input_prompt_template = string.Template(rc.prompt_in1) | |
176 | output_prompt_template = string.Template(rc.prompt_out) |
|
176 | output_prompt_template = string.Template(rc.prompt_out) | |
177 | continuation_prompt_template = string.Template(rc.prompt_in2) |
|
177 | continuation_prompt_template = string.Template(rc.prompt_in2) | |
178 |
|
178 | |||
179 | def __init__(self, shell=None, history=None): |
|
179 | def __init__(self, shell=None, history=None): | |
180 | self.shell = shell |
|
180 | self.shell = shell | |
181 | if history is None: |
|
181 | if history is None: | |
182 | self.history = FrontEndHistory(input_cache=['']) |
|
182 | self.history = FrontEndHistory(input_cache=['']) | |
183 | else: |
|
183 | else: | |
184 | self.history = history |
|
184 | self.history = history | |
185 |
|
185 | |||
186 |
|
186 | |||
187 | def input_prompt(self, number=''): |
|
187 | def input_prompt(self, number=''): | |
188 | """Returns the current input prompt |
|
188 | """Returns the current input prompt | |
189 |
|
189 | |||
190 | It would be great to use ipython1.core.prompts.Prompt1 here |
|
190 | It would be great to use ipython1.core.prompts.Prompt1 here | |
191 | """ |
|
191 | """ | |
192 | return self.input_prompt_template.safe_substitute({'number':number}) |
|
192 | return self.input_prompt_template.safe_substitute({'number':number}) | |
193 |
|
193 | |||
194 |
|
194 | |||
195 | def continuation_prompt(self): |
|
195 | def continuation_prompt(self): | |
196 | """Returns the current continuation prompt""" |
|
196 | """Returns the current continuation prompt""" | |
197 |
|
197 | |||
198 | return self.continuation_prompt_template.safe_substitute() |
|
198 | return self.continuation_prompt_template.safe_substitute() | |
199 |
|
199 | |||
200 | def output_prompt(self, number=''): |
|
200 | def output_prompt(self, number=''): | |
201 | """Returns the output prompt for result""" |
|
201 | """Returns the output prompt for result""" | |
202 |
|
202 | |||
203 | return self.output_prompt_template.safe_substitute({'number':number}) |
|
203 | return self.output_prompt_template.safe_substitute({'number':number}) | |
204 |
|
204 | |||
205 |
|
205 | |||
206 | def is_complete(self, block): |
|
206 | def is_complete(self, block): | |
207 | """Determine if block is complete. |
|
207 | """Determine if block is complete. | |
208 |
|
208 | |||
209 | Parameters |
|
209 | Parameters | |
210 | block : string |
|
210 | block : string | |
211 |
|
211 | |||
212 | Result |
|
212 | Result | |
213 | True if block can be sent to the engine without compile errors. |
|
213 | True if block can be sent to the engine without compile errors. | |
214 | False otherwise. |
|
214 | False otherwise. | |
215 | """ |
|
215 | """ | |
216 |
|
216 | |||
217 | try: |
|
217 | try: | |
218 | is_complete = codeop.compile_command(block.rstrip() + '\n\n', |
|
218 | is_complete = codeop.compile_command(block.rstrip() + '\n\n', | |
219 | "<string>", "exec") |
|
219 | "<string>", "exec") | |
220 | except: |
|
220 | except: | |
221 | return False |
|
221 | return False | |
222 |
|
222 | |||
223 | lines = block.split('\n') |
|
223 | lines = block.split('\n') | |
224 | return ((is_complete is not None) |
|
224 | return ((is_complete is not None) | |
225 | and (len(lines)==1 or str(lines[-1])=='')) |
|
225 | and (len(lines)==1 or str(lines[-1])=='')) | |
226 |
|
226 | |||
227 |
|
227 | |||
228 | def execute(self, block, blockID=None): |
|
228 | def execute(self, block, blockID=None): | |
229 | """Execute the block and return the result. |
|
229 | """Execute the block and return the result. | |
230 |
|
230 | |||
231 | Parameters: |
|
231 | Parameters: | |
232 | block : {str, AST} |
|
232 | block : {str, AST} | |
233 | blockID : any |
|
233 | blockID : any | |
234 | Caller may provide an ID to identify this block. |
|
234 | Caller may provide an ID to identify this block. | |
235 | result['blockID'] := blockID |
|
235 | result['blockID'] := blockID | |
236 |
|
236 | |||
237 | Result: |
|
237 | Result: | |
238 | Deferred result of self.interpreter.execute |
|
238 | Deferred result of self.interpreter.execute | |
239 | """ |
|
239 | """ | |
240 |
|
240 | |||
241 | if(not self.is_complete(block)): |
|
241 | if(not self.is_complete(block)): | |
242 | raise Exception("Block is not compilable") |
|
242 | raise Exception("Block is not compilable") | |
243 |
|
243 | |||
244 | if(blockID == None): |
|
244 | if(blockID == None): | |
245 |
blockID = |
|
245 | blockID = uuid.uuid4() | |
246 |
|
246 | |||
247 | try: |
|
247 | try: | |
248 | result = self.shell.execute(block) |
|
248 | result = self.shell.execute(block) | |
249 | except Exception,e: |
|
249 | except Exception,e: | |
250 | e = self._add_block_id_for_failure(e, blockID=blockID) |
|
250 | e = self._add_block_id_for_failure(e, blockID=blockID) | |
251 | e = self.update_cell_prompt(e, blockID=blockID) |
|
251 | e = self.update_cell_prompt(e, blockID=blockID) | |
252 | e = self.render_error(e) |
|
252 | e = self.render_error(e) | |
253 | else: |
|
253 | else: | |
254 | result = self._add_block_id_for_result(result, blockID=blockID) |
|
254 | result = self._add_block_id_for_result(result, blockID=blockID) | |
255 | result = self.update_cell_prompt(result, blockID=blockID) |
|
255 | result = self.update_cell_prompt(result, blockID=blockID) | |
256 | result = self.render_result(result) |
|
256 | result = self.render_result(result) | |
257 |
|
257 | |||
258 | return result |
|
258 | return result | |
259 |
|
259 | |||
260 |
|
260 | |||
261 | def _add_block_id_for_result(self, result, blockID): |
|
261 | def _add_block_id_for_result(self, result, blockID): | |
262 | """Add the blockID to result or failure. Unfortunatley, we have to |
|
262 | """Add the blockID to result or failure. Unfortunatley, we have to | |
263 | treat failures differently than result dicts. |
|
263 | treat failures differently than result dicts. | |
264 | """ |
|
264 | """ | |
265 |
|
265 | |||
266 | result['blockID'] = blockID |
|
266 | result['blockID'] = blockID | |
267 |
|
267 | |||
268 | return result |
|
268 | return result | |
269 |
|
269 | |||
270 | def _add_block_id_for_failure(self, failure, blockID): |
|
270 | def _add_block_id_for_failure(self, failure, blockID): | |
271 | """_add_block_id_for_failure""" |
|
271 | """_add_block_id_for_failure""" | |
272 | failure.blockID = blockID |
|
272 | failure.blockID = blockID | |
273 | return failure |
|
273 | return failure | |
274 |
|
274 | |||
275 |
|
275 | |||
276 | def _add_history(self, result, block=None): |
|
276 | def _add_history(self, result, block=None): | |
277 | """Add block to the history""" |
|
277 | """Add block to the history""" | |
278 |
|
278 | |||
279 | assert(block != None) |
|
279 | assert(block != None) | |
280 | self.history.add_items([block]) |
|
280 | self.history.add_items([block]) | |
281 | self.history_cursor += 1 |
|
281 | self.history_cursor += 1 | |
282 |
|
282 | |||
283 | return result |
|
283 | return result | |
284 |
|
284 | |||
285 |
|
285 | |||
286 | def get_history_previous(self, current_block): |
|
286 | def get_history_previous(self, current_block): | |
287 | """ Returns previous history string and decrement history cursor. |
|
287 | """ Returns previous history string and decrement history cursor. | |
288 | """ |
|
288 | """ | |
289 | command = self.history.get_history_item(self.history_cursor - 1) |
|
289 | command = self.history.get_history_item(self.history_cursor - 1) | |
290 |
|
290 | |||
291 | if command is not None: |
|
291 | if command is not None: | |
292 | if(self.history_cursor+1 == len(self.history.input_cache)): |
|
292 | if(self.history_cursor+1 == len(self.history.input_cache)): | |
293 | self.history.input_cache[self.history_cursor] = current_block |
|
293 | self.history.input_cache[self.history_cursor] = current_block | |
294 | self.history_cursor -= 1 |
|
294 | self.history_cursor -= 1 | |
295 | return command |
|
295 | return command | |
296 |
|
296 | |||
297 |
|
297 | |||
298 | def get_history_next(self): |
|
298 | def get_history_next(self): | |
299 | """ Returns next history string and increment history cursor. |
|
299 | """ Returns next history string and increment history cursor. | |
300 | """ |
|
300 | """ | |
301 | command = self.history.get_history_item(self.history_cursor+1) |
|
301 | command = self.history.get_history_item(self.history_cursor+1) | |
302 |
|
302 | |||
303 | if command is not None: |
|
303 | if command is not None: | |
304 | self.history_cursor += 1 |
|
304 | self.history_cursor += 1 | |
305 | return command |
|
305 | return command | |
306 |
|
306 | |||
307 | ### |
|
307 | ### | |
308 | # Subclasses probably want to override these methods... |
|
308 | # Subclasses probably want to override these methods... | |
309 | ### |
|
309 | ### | |
310 |
|
310 | |||
311 | def update_cell_prompt(self, result, blockID=None): |
|
311 | def update_cell_prompt(self, result, blockID=None): | |
312 | """Subclass may override to update the input prompt for a block. |
|
312 | """Subclass may override to update the input prompt for a block. | |
313 |
|
313 | |||
314 | This method only really makes sens in asyncrhonous frontend. |
|
314 | This method only really makes sens in asyncrhonous frontend. | |
315 | Since this method will be called as a |
|
315 | Since this method will be called as a | |
316 | twisted.internet.defer.Deferred's callback, implementations should |
|
316 | twisted.internet.defer.Deferred's callback, implementations should | |
317 | return result when finished. |
|
317 | return result when finished. | |
318 | """ |
|
318 | """ | |
319 |
|
319 | |||
320 | raise NotImplementedError |
|
320 | raise NotImplementedError | |
321 |
|
321 | |||
322 |
|
322 | |||
323 | def render_result(self, result): |
|
323 | def render_result(self, result): | |
324 | """Subclasses must override to render result. |
|
324 | """Subclasses must override to render result. | |
325 |
|
325 | |||
326 | In asynchronous frontends, this method will be called as a |
|
326 | In asynchronous frontends, this method will be called as a | |
327 | twisted.internet.defer.Deferred's callback. Implementations |
|
327 | twisted.internet.defer.Deferred's callback. Implementations | |
328 | should thus return result when finished. |
|
328 | should thus return result when finished. | |
329 | """ |
|
329 | """ | |
330 |
|
330 | |||
331 | raise NotImplementedError |
|
331 | raise NotImplementedError | |
332 |
|
332 | |||
333 |
|
333 | |||
334 | def render_error(self, failure): |
|
334 | def render_error(self, failure): | |
335 | """Subclasses must override to render the failure. |
|
335 | """Subclasses must override to render the failure. | |
336 |
|
336 | |||
337 | In asynchronous frontends, this method will be called as a |
|
337 | In asynchronous frontends, this method will be called as a | |
338 | twisted.internet.defer.Deferred's callback. Implementations |
|
338 | twisted.internet.defer.Deferred's callback. Implementations | |
339 | should thus return result when finished. |
|
339 | should thus return result when finished. | |
340 | """ |
|
340 | """ | |
341 |
|
341 | |||
342 | raise NotImplementedError |
|
342 | raise NotImplementedError | |
343 |
|
343 |
@@ -1,68 +1,68 b'' | |||||
1 | # encoding: utf-8 |
|
1 | # encoding: utf-8 | |
2 | """ |
|
2 | """ | |
3 | Test process execution and IO redirection. |
|
3 | Test process execution and IO redirection. | |
4 | """ |
|
4 | """ | |
5 |
|
5 | |||
6 | __docformat__ = "restructuredtext en" |
|
6 | __docformat__ = "restructuredtext en" | |
7 |
|
7 | |||
8 | #----------------------------------------------------------------------------- |
|
8 | #----------------------------------------------------------------------------- | |
9 | # Copyright (C) 2008-2011 The IPython Development Team |
|
9 | # Copyright (C) 2008-2011 The IPython Development Team | |
10 | # |
|
10 | # | |
11 | # Distributed under the terms of the BSD License. The full license is |
|
11 | # Distributed under the terms of the BSD License. The full license is | |
12 | # in the file COPYING, distributed as part of this software. |
|
12 | # in the file COPYING, distributed as part of this software. | |
13 | #----------------------------------------------------------------------------- |
|
13 | #----------------------------------------------------------------------------- | |
14 |
|
14 | |||
15 | from cStringIO import StringIO |
|
15 | from cStringIO import StringIO | |
16 | from time import sleep |
|
16 | from time import sleep | |
17 | import sys |
|
17 | import sys | |
18 |
|
18 | |||
19 | from IPython.frontend.process import PipedProcess |
|
19 | from IPython.frontend.process import PipedProcess | |
20 |
from IPython.testing import decorators as |
|
20 | from IPython.testing import decorators as dec | |
21 |
|
21 | |||
22 |
|
22 | |||
23 | def test_capture_out(): |
|
23 | def test_capture_out(): | |
24 | """ A simple test to see if we can execute a process and get the output. |
|
24 | """ A simple test to see if we can execute a process and get the output. | |
25 | """ |
|
25 | """ | |
26 | s = StringIO() |
|
26 | s = StringIO() | |
27 | p = PipedProcess('echo 1', out_callback=s.write, ) |
|
27 | p = PipedProcess('echo 1', out_callback=s.write, ) | |
28 | p.start() |
|
28 | p.start() | |
29 | p.join() |
|
29 | p.join() | |
30 | result = s.getvalue().rstrip() |
|
30 | result = s.getvalue().rstrip() | |
31 | assert result == '1' |
|
31 | assert result == '1' | |
32 |
|
32 | |||
33 |
|
33 | |||
34 | def test_io(): |
|
34 | def test_io(): | |
35 | """ Checks that we can send characters on stdin to the process. |
|
35 | """ Checks that we can send characters on stdin to the process. | |
36 | """ |
|
36 | """ | |
37 | s = StringIO() |
|
37 | s = StringIO() | |
38 | p = PipedProcess(sys.executable + ' -c "a = raw_input(); print a"', |
|
38 | p = PipedProcess(sys.executable + ' -c "a = raw_input(); print a"', | |
39 | out_callback=s.write, ) |
|
39 | out_callback=s.write, ) | |
40 | p.start() |
|
40 | p.start() | |
41 | test_string = '12345\n' |
|
41 | test_string = '12345\n' | |
42 | while not hasattr(p, 'process'): |
|
42 | while not hasattr(p, 'process'): | |
43 | sleep(0.1) |
|
43 | sleep(0.1) | |
44 | p.process.stdin.write(test_string) |
|
44 | p.process.stdin.write(test_string) | |
45 | p.join() |
|
45 | p.join() | |
46 | result = s.getvalue() |
|
46 | result = s.getvalue() | |
47 | assert result == test_string |
|
47 | assert result == test_string | |
48 |
|
48 | |||
49 |
|
49 | |||
50 |
@ |
|
50 | @dec.skip_win32 | |
51 | def test_kill(): |
|
51 | def test_kill(): | |
52 | """ Check that we can kill a process, and its subprocess. |
|
52 | """ Check that we can kill a process, and its subprocess. | |
53 | """ |
|
53 | """ | |
54 | s = StringIO() |
|
54 | s = StringIO() | |
55 | p = PipedProcess(sys.executable + ' -c "a = raw_input();"', |
|
55 | p = PipedProcess(sys.executable + ' -c "a = raw_input();"', | |
56 | out_callback=s.write, ) |
|
56 | out_callback=s.write, ) | |
57 | p.start() |
|
57 | p.start() | |
58 | while not hasattr(p, 'process'): |
|
58 | while not hasattr(p, 'process'): | |
59 | sleep(0.1) |
|
59 | sleep(0.1) | |
60 | p.process.kill() |
|
60 | p.process.kill() | |
61 | assert p.process.poll() is not None |
|
61 | assert p.process.poll() is not None | |
62 |
|
62 | |||
63 |
|
63 | |||
64 | if __name__ == '__main__': |
|
64 | if __name__ == '__main__': | |
65 | test_capture_out() |
|
65 | test_capture_out() | |
66 | test_io() |
|
66 | test_io() | |
67 | test_kill() |
|
67 | test_kill() | |
68 |
|
68 |
1 | NO CONTENT: file was removed |
|
NO CONTENT: file was removed |
1 | NO CONTENT: file was removed |
|
NO CONTENT: file was removed |
General Comments 0
You need to be logged in to leave comments.
Login now