Show More
@@ -1,2703 +1,2704 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 | try: |
|
32 | try: | |
33 | from contextlib import nested |
|
33 | from contextlib import nested | |
34 | except: |
|
34 | except: | |
35 | from IPython.utils.nested_context import nested |
|
35 | from IPython.utils.nested_context import nested | |
36 |
|
36 | |||
37 | from IPython.config.configurable import SingletonConfigurable |
|
37 | from IPython.config.configurable import SingletonConfigurable | |
38 | from IPython.core import debugger, oinspect |
|
38 | from IPython.core import debugger, oinspect | |
39 | from IPython.core import history as ipcorehist |
|
39 | from IPython.core import history as ipcorehist | |
40 | from IPython.core import page |
|
40 | from IPython.core import page | |
41 | from IPython.core import prefilter |
|
41 | from IPython.core import prefilter | |
42 | from IPython.core import shadowns |
|
42 | from IPython.core import shadowns | |
43 | from IPython.core import ultratb |
|
43 | from IPython.core import ultratb | |
44 | from IPython.core.alias import AliasManager, AliasError |
|
44 | from IPython.core.alias import AliasManager, AliasError | |
45 | from IPython.core.autocall import ExitAutocall |
|
45 | from IPython.core.autocall import ExitAutocall | |
46 | from IPython.core.builtin_trap import BuiltinTrap |
|
46 | from IPython.core.builtin_trap import BuiltinTrap | |
47 | from IPython.core.compilerop import CachingCompiler |
|
47 | from IPython.core.compilerop import CachingCompiler | |
48 | from IPython.core.display_trap import DisplayTrap |
|
48 | from IPython.core.display_trap import DisplayTrap | |
49 | from IPython.core.displayhook import DisplayHook |
|
49 | from IPython.core.displayhook import DisplayHook | |
50 | from IPython.core.displaypub import DisplayPublisher |
|
50 | from IPython.core.displaypub import DisplayPublisher | |
51 | from IPython.core.error import TryNext, UsageError |
|
51 | from IPython.core.error import TryNext, UsageError | |
52 | from IPython.core.extensions import ExtensionManager |
|
52 | from IPython.core.extensions import ExtensionManager | |
53 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict |
|
53 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict | |
54 | from IPython.core.formatters import DisplayFormatter |
|
54 | from IPython.core.formatters import DisplayFormatter | |
55 | from IPython.core.history import HistoryManager |
|
55 | from IPython.core.history import HistoryManager | |
56 | from IPython.core.inputsplitter import IPythonInputSplitter |
|
56 | from IPython.core.inputsplitter import IPythonInputSplitter | |
57 | from IPython.core.logger import Logger |
|
57 | from IPython.core.logger import Logger | |
58 | from IPython.core.macro import Macro |
|
58 | from IPython.core.macro import Macro | |
59 | from IPython.core.magic import Magic |
|
59 | from IPython.core.magic import Magic | |
60 | from IPython.core.payload import PayloadManager |
|
60 | from IPython.core.payload import PayloadManager | |
61 | from IPython.core.plugin import PluginManager |
|
61 | from IPython.core.plugin import PluginManager | |
62 | from IPython.core.prefilter import PrefilterManager, ESC_MAGIC |
|
62 | from IPython.core.prefilter import PrefilterManager, ESC_MAGIC | |
63 | from IPython.core.profiledir import ProfileDir |
|
63 | from IPython.core.profiledir import ProfileDir | |
64 | from IPython.external.Itpl import ItplNS |
|
64 | from IPython.external.Itpl import ItplNS | |
65 | from IPython.utils import PyColorize |
|
65 | from IPython.utils import PyColorize | |
66 | from IPython.utils import io |
|
66 | from IPython.utils import io | |
67 | from IPython.utils import py3compat |
|
67 | from IPython.utils import py3compat | |
68 | from IPython.utils.doctestreload import doctest_reload |
|
68 | from IPython.utils.doctestreload import doctest_reload | |
69 | from IPython.utils.io import ask_yes_no, rprint |
|
69 | from IPython.utils.io import ask_yes_no, rprint | |
70 | from IPython.utils.ipstruct import Struct |
|
70 | from IPython.utils.ipstruct import Struct | |
71 | from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError |
|
71 | from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError | |
72 | from IPython.utils.pickleshare import PickleShareDB |
|
72 | from IPython.utils.pickleshare import PickleShareDB | |
73 | from IPython.utils.process import system, getoutput |
|
73 | from IPython.utils.process import system, getoutput | |
74 | from IPython.utils.strdispatch import StrDispatch |
|
74 | from IPython.utils.strdispatch import StrDispatch | |
75 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
75 | from IPython.utils.syspathcontext import prepended_to_syspath | |
76 | from IPython.utils.text import num_ini_spaces, format_screen, LSString, SList |
|
76 | from IPython.utils.text import num_ini_spaces, format_screen, LSString, SList | |
77 | from IPython.utils.traitlets import (Int, CBool, CaselessStrEnum, Enum, |
|
77 | from IPython.utils.traitlets import (Int, CBool, CaselessStrEnum, Enum, | |
78 | List, Unicode, Instance, Type) |
|
78 | List, Unicode, Instance, Type) | |
79 | from IPython.utils.warn import warn, error, fatal |
|
79 | from IPython.utils.warn import warn, error, fatal | |
80 | import IPython.core.hooks |
|
80 | import IPython.core.hooks | |
81 |
|
81 | |||
82 | #----------------------------------------------------------------------------- |
|
82 | #----------------------------------------------------------------------------- | |
83 | # Globals |
|
83 | # Globals | |
84 | #----------------------------------------------------------------------------- |
|
84 | #----------------------------------------------------------------------------- | |
85 |
|
85 | |||
86 | # compiled regexps for autoindent management |
|
86 | # compiled regexps for autoindent management | |
87 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
87 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
88 |
|
88 | |||
89 | #----------------------------------------------------------------------------- |
|
89 | #----------------------------------------------------------------------------- | |
90 | # Utilities |
|
90 | # Utilities | |
91 | #----------------------------------------------------------------------------- |
|
91 | #----------------------------------------------------------------------------- | |
92 |
|
92 | |||
93 | def softspace(file, newvalue): |
|
93 | def softspace(file, newvalue): | |
94 | """Copied from code.py, to remove the dependency""" |
|
94 | """Copied from code.py, to remove the dependency""" | |
95 |
|
95 | |||
96 | oldvalue = 0 |
|
96 | oldvalue = 0 | |
97 | try: |
|
97 | try: | |
98 | oldvalue = file.softspace |
|
98 | oldvalue = file.softspace | |
99 | except AttributeError: |
|
99 | except AttributeError: | |
100 | pass |
|
100 | pass | |
101 | try: |
|
101 | try: | |
102 | file.softspace = newvalue |
|
102 | file.softspace = newvalue | |
103 | except (AttributeError, TypeError): |
|
103 | except (AttributeError, TypeError): | |
104 | # "attribute-less object" or "read-only attributes" |
|
104 | # "attribute-less object" or "read-only attributes" | |
105 | pass |
|
105 | pass | |
106 | return oldvalue |
|
106 | return oldvalue | |
107 |
|
107 | |||
108 |
|
108 | |||
109 | def no_op(*a, **kw): pass |
|
109 | def no_op(*a, **kw): pass | |
110 |
|
110 | |||
111 | class NoOpContext(object): |
|
111 | class NoOpContext(object): | |
112 | def __enter__(self): pass |
|
112 | def __enter__(self): pass | |
113 | def __exit__(self, type, value, traceback): pass |
|
113 | def __exit__(self, type, value, traceback): pass | |
114 | no_op_context = NoOpContext() |
|
114 | no_op_context = NoOpContext() | |
115 |
|
115 | |||
116 | class SpaceInInput(Exception): pass |
|
116 | class SpaceInInput(Exception): pass | |
117 |
|
117 | |||
118 | class Bunch: pass |
|
118 | class Bunch: pass | |
119 |
|
119 | |||
120 |
|
120 | |||
121 | def get_default_colors(): |
|
121 | def get_default_colors(): | |
122 | if sys.platform=='darwin': |
|
122 | if sys.platform=='darwin': | |
123 | return "LightBG" |
|
123 | return "LightBG" | |
124 | elif os.name=='nt': |
|
124 | elif os.name=='nt': | |
125 | return 'Linux' |
|
125 | return 'Linux' | |
126 | else: |
|
126 | else: | |
127 | return 'Linux' |
|
127 | return 'Linux' | |
128 |
|
128 | |||
129 |
|
129 | |||
130 | class SeparateUnicode(Unicode): |
|
130 | class SeparateUnicode(Unicode): | |
131 | """A Unicode subclass to validate separate_in, separate_out, etc. |
|
131 | """A Unicode subclass to validate separate_in, separate_out, etc. | |
132 |
|
132 | |||
133 | This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'. |
|
133 | This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'. | |
134 | """ |
|
134 | """ | |
135 |
|
135 | |||
136 | def validate(self, obj, value): |
|
136 | def validate(self, obj, value): | |
137 | if value == '0': value = '' |
|
137 | if value == '0': value = '' | |
138 | value = value.replace('\\n','\n') |
|
138 | value = value.replace('\\n','\n') | |
139 | return super(SeparateUnicode, self).validate(obj, value) |
|
139 | return super(SeparateUnicode, self).validate(obj, value) | |
140 |
|
140 | |||
141 |
|
141 | |||
142 | class ReadlineNoRecord(object): |
|
142 | class ReadlineNoRecord(object): | |
143 | """Context manager to execute some code, then reload readline history |
|
143 | """Context manager to execute some code, then reload readline history | |
144 | so that interactive input to the code doesn't appear when pressing up.""" |
|
144 | so that interactive input to the code doesn't appear when pressing up.""" | |
145 | def __init__(self, shell): |
|
145 | def __init__(self, shell): | |
146 | self.shell = shell |
|
146 | self.shell = shell | |
147 | self._nested_level = 0 |
|
147 | self._nested_level = 0 | |
148 |
|
148 | |||
149 | def __enter__(self): |
|
149 | def __enter__(self): | |
150 | if self._nested_level == 0: |
|
150 | if self._nested_level == 0: | |
151 | try: |
|
151 | try: | |
152 | self.orig_length = self.current_length() |
|
152 | self.orig_length = self.current_length() | |
153 | self.readline_tail = self.get_readline_tail() |
|
153 | self.readline_tail = self.get_readline_tail() | |
154 | except (AttributeError, IndexError): # Can fail with pyreadline |
|
154 | except (AttributeError, IndexError): # Can fail with pyreadline | |
155 | self.orig_length, self.readline_tail = 999999, [] |
|
155 | self.orig_length, self.readline_tail = 999999, [] | |
156 | self._nested_level += 1 |
|
156 | self._nested_level += 1 | |
157 |
|
157 | |||
158 | def __exit__(self, type, value, traceback): |
|
158 | def __exit__(self, type, value, traceback): | |
159 | self._nested_level -= 1 |
|
159 | self._nested_level -= 1 | |
160 | if self._nested_level == 0: |
|
160 | if self._nested_level == 0: | |
161 | # Try clipping the end if it's got longer |
|
161 | # Try clipping the end if it's got longer | |
162 | try: |
|
162 | try: | |
163 | e = self.current_length() - self.orig_length |
|
163 | e = self.current_length() - self.orig_length | |
164 | if e > 0: |
|
164 | if e > 0: | |
165 | for _ in range(e): |
|
165 | for _ in range(e): | |
166 | self.shell.readline.remove_history_item(self.orig_length) |
|
166 | self.shell.readline.remove_history_item(self.orig_length) | |
167 |
|
167 | |||
168 | # If it still doesn't match, just reload readline history. |
|
168 | # If it still doesn't match, just reload readline history. | |
169 | if self.current_length() != self.orig_length \ |
|
169 | if self.current_length() != self.orig_length \ | |
170 | or self.get_readline_tail() != self.readline_tail: |
|
170 | or self.get_readline_tail() != self.readline_tail: | |
171 | self.shell.refill_readline_hist() |
|
171 | self.shell.refill_readline_hist() | |
172 | except (AttributeError, IndexError): |
|
172 | except (AttributeError, IndexError): | |
173 | pass |
|
173 | pass | |
174 | # Returning False will cause exceptions to propagate |
|
174 | # Returning False will cause exceptions to propagate | |
175 | return False |
|
175 | return False | |
176 |
|
176 | |||
177 | def current_length(self): |
|
177 | def current_length(self): | |
178 | return self.shell.readline.get_current_history_length() |
|
178 | return self.shell.readline.get_current_history_length() | |
179 |
|
179 | |||
180 | def get_readline_tail(self, n=10): |
|
180 | def get_readline_tail(self, n=10): | |
181 | """Get the last n items in readline history.""" |
|
181 | """Get the last n items in readline history.""" | |
182 | end = self.shell.readline.get_current_history_length() + 1 |
|
182 | end = self.shell.readline.get_current_history_length() + 1 | |
183 | start = max(end-n, 1) |
|
183 | start = max(end-n, 1) | |
184 | ghi = self.shell.readline.get_history_item |
|
184 | ghi = self.shell.readline.get_history_item | |
185 | return [ghi(x) for x in range(start, end)] |
|
185 | return [ghi(x) for x in range(start, end)] | |
186 |
|
186 | |||
187 |
|
187 | |||
188 | _autocall_help = """ |
|
188 | _autocall_help = """ | |
189 | Make IPython automatically call any callable object even if |
|
189 | Make IPython automatically call any callable object even if | |
190 | you didn't type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
190 | you didn't type explicit parentheses. For example, 'str 43' becomes 'str(43)' | |
191 | automatically. The value can be '0' to disable the feature, '1' for 'smart' |
|
191 | automatically. The value can be '0' to disable the feature, '1' for 'smart' | |
192 | autocall, where it is not applied if there are no more arguments on the line, |
|
192 | autocall, where it is not applied if there are no more arguments on the line, | |
193 | and '2' for 'full' autocall, where all callable objects are automatically |
|
193 | and '2' for 'full' autocall, where all callable objects are automatically | |
194 | called (even if no arguments are present). The default is '1'. |
|
194 | called (even if no arguments are present). The default is '1'. | |
195 | """ |
|
195 | """ | |
196 |
|
196 | |||
197 | #----------------------------------------------------------------------------- |
|
197 | #----------------------------------------------------------------------------- | |
198 | # Main IPython class |
|
198 | # Main IPython class | |
199 | #----------------------------------------------------------------------------- |
|
199 | #----------------------------------------------------------------------------- | |
200 |
|
200 | |||
201 | class InteractiveShell(SingletonConfigurable, Magic): |
|
201 | class InteractiveShell(SingletonConfigurable, Magic): | |
202 | """An enhanced, interactive shell for Python.""" |
|
202 | """An enhanced, interactive shell for Python.""" | |
203 |
|
203 | |||
204 | _instance = None |
|
204 | _instance = None | |
205 |
|
205 | |||
206 | autocall = Enum((0,1,2), default_value=1, config=True, help= |
|
206 | autocall = Enum((0,1,2), default_value=1, config=True, help= | |
207 | """ |
|
207 | """ | |
208 | Make IPython automatically call any callable object even if you didn't |
|
208 | Make IPython automatically call any callable object even if you didn't | |
209 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
209 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' | |
210 | automatically. The value can be '0' to disable the feature, '1' for |
|
210 | automatically. The value can be '0' to disable the feature, '1' for | |
211 | 'smart' autocall, where it is not applied if there are no more |
|
211 | 'smart' autocall, where it is not applied if there are no more | |
212 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
212 | arguments on the line, and '2' for 'full' autocall, where all callable | |
213 | objects are automatically called (even if no arguments are present). |
|
213 | objects are automatically called (even if no arguments are present). | |
214 | The default is '1'. |
|
214 | The default is '1'. | |
215 | """ |
|
215 | """ | |
216 | ) |
|
216 | ) | |
217 | # TODO: remove all autoindent logic and put into frontends. |
|
217 | # TODO: remove all autoindent logic and put into frontends. | |
218 | # We can't do this yet because even runlines uses the autoindent. |
|
218 | # We can't do this yet because even runlines uses the autoindent. | |
219 | autoindent = CBool(True, config=True, help= |
|
219 | autoindent = CBool(True, config=True, help= | |
220 | """ |
|
220 | """ | |
221 | Autoindent IPython code entered interactively. |
|
221 | Autoindent IPython code entered interactively. | |
222 | """ |
|
222 | """ | |
223 | ) |
|
223 | ) | |
224 | automagic = CBool(True, config=True, help= |
|
224 | automagic = CBool(True, config=True, help= | |
225 | """ |
|
225 | """ | |
226 | Enable magic commands to be called without the leading %. |
|
226 | Enable magic commands to be called without the leading %. | |
227 | """ |
|
227 | """ | |
228 | ) |
|
228 | ) | |
229 | cache_size = Int(1000, config=True, help= |
|
229 | cache_size = Int(1000, config=True, help= | |
230 | """ |
|
230 | """ | |
231 | Set the size of the output cache. The default is 1000, you can |
|
231 | Set the size of the output cache. The default is 1000, you can | |
232 | change it permanently in your config file. Setting it to 0 completely |
|
232 | change it permanently in your config file. Setting it to 0 completely | |
233 | disables the caching system, and the minimum value accepted is 20 (if |
|
233 | disables the caching system, and the minimum value accepted is 20 (if | |
234 | you provide a value less than 20, it is reset to 0 and a warning is |
|
234 | you provide a value less than 20, it is reset to 0 and a warning is | |
235 | issued). This limit is defined because otherwise you'll spend more |
|
235 | issued). This limit is defined because otherwise you'll spend more | |
236 | time re-flushing a too small cache than working |
|
236 | time re-flushing a too small cache than working | |
237 | """ |
|
237 | """ | |
238 | ) |
|
238 | ) | |
239 | color_info = CBool(True, config=True, help= |
|
239 | color_info = CBool(True, config=True, help= | |
240 | """ |
|
240 | """ | |
241 | Use colors for displaying information about objects. Because this |
|
241 | Use colors for displaying information about objects. Because this | |
242 | information is passed through a pager (like 'less'), and some pagers |
|
242 | information is passed through a pager (like 'less'), and some pagers | |
243 | get confused with color codes, this capability can be turned off. |
|
243 | get confused with color codes, this capability can be turned off. | |
244 | """ |
|
244 | """ | |
245 | ) |
|
245 | ) | |
246 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), |
|
246 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), | |
247 | default_value=get_default_colors(), config=True, |
|
247 | default_value=get_default_colors(), config=True, | |
248 | help="Set the color scheme (NoColor, Linux, or LightBG)." |
|
248 | help="Set the color scheme (NoColor, Linux, or LightBG)." | |
249 | ) |
|
249 | ) | |
250 | colors_force = CBool(False, help= |
|
250 | colors_force = CBool(False, help= | |
251 | """ |
|
251 | """ | |
252 | Force use of ANSI color codes, regardless of OS and readline |
|
252 | Force use of ANSI color codes, regardless of OS and readline | |
253 | availability. |
|
253 | availability. | |
254 | """ |
|
254 | """ | |
255 | # FIXME: This is essentially a hack to allow ZMQShell to show colors |
|
255 | # FIXME: This is essentially a hack to allow ZMQShell to show colors | |
256 | # without readline on Win32. When the ZMQ formatting system is |
|
256 | # without readline on Win32. When the ZMQ formatting system is | |
257 | # refactored, this should be removed. |
|
257 | # refactored, this should be removed. | |
258 | ) |
|
258 | ) | |
259 | debug = CBool(False, config=True) |
|
259 | debug = CBool(False, config=True) | |
260 | deep_reload = CBool(False, config=True, help= |
|
260 | deep_reload = CBool(False, config=True, help= | |
261 | """ |
|
261 | """ | |
262 | Enable deep (recursive) reloading by default. IPython can use the |
|
262 | Enable deep (recursive) reloading by default. IPython can use the | |
263 | deep_reload module which reloads changes in modules recursively (it |
|
263 | deep_reload module which reloads changes in modules recursively (it | |
264 | replaces the reload() function, so you don't need to change anything to |
|
264 | replaces the reload() function, so you don't need to change anything to | |
265 | use it). deep_reload() forces a full reload of modules whose code may |
|
265 | use it). deep_reload() forces a full reload of modules whose code may | |
266 | have changed, which the default reload() function does not. When |
|
266 | have changed, which the default reload() function does not. When | |
267 | deep_reload is off, IPython will use the normal reload(), but |
|
267 | deep_reload is off, IPython will use the normal reload(), but | |
268 | deep_reload will still be available as dreload(). |
|
268 | deep_reload will still be available as dreload(). | |
269 | """ |
|
269 | """ | |
270 | ) |
|
270 | ) | |
271 | display_formatter = Instance(DisplayFormatter) |
|
271 | display_formatter = Instance(DisplayFormatter) | |
272 | displayhook_class = Type(DisplayHook) |
|
272 | displayhook_class = Type(DisplayHook) | |
273 | display_pub_class = Type(DisplayPublisher) |
|
273 | display_pub_class = Type(DisplayPublisher) | |
274 |
|
274 | |||
275 | exit_now = CBool(False) |
|
275 | exit_now = CBool(False) | |
276 | exiter = Instance(ExitAutocall) |
|
276 | exiter = Instance(ExitAutocall) | |
277 | def _exiter_default(self): |
|
277 | def _exiter_default(self): | |
278 | return ExitAutocall(self) |
|
278 | return ExitAutocall(self) | |
279 | # Monotonically increasing execution counter |
|
279 | # Monotonically increasing execution counter | |
280 | execution_count = Int(1) |
|
280 | execution_count = Int(1) | |
281 | filename = Unicode("<ipython console>") |
|
281 | filename = Unicode("<ipython console>") | |
282 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ |
|
282 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ | |
283 |
|
283 | |||
284 | # Input splitter, to split entire cells of input into either individual |
|
284 | # Input splitter, to split entire cells of input into either individual | |
285 | # interactive statements or whole blocks. |
|
285 | # interactive statements or whole blocks. | |
286 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
286 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', | |
287 | (), {}) |
|
287 | (), {}) | |
288 | logstart = CBool(False, config=True, help= |
|
288 | logstart = CBool(False, config=True, help= | |
289 | """ |
|
289 | """ | |
290 | Start logging to the default log file. |
|
290 | Start logging to the default log file. | |
291 | """ |
|
291 | """ | |
292 | ) |
|
292 | ) | |
293 | logfile = Unicode('', config=True, help= |
|
293 | logfile = Unicode('', config=True, help= | |
294 | """ |
|
294 | """ | |
295 | The name of the logfile to use. |
|
295 | The name of the logfile to use. | |
296 | """ |
|
296 | """ | |
297 | ) |
|
297 | ) | |
298 | logappend = Unicode('', config=True, help= |
|
298 | logappend = Unicode('', config=True, help= | |
299 | """ |
|
299 | """ | |
300 | Start logging to the given file in append mode. |
|
300 | Start logging to the given file in append mode. | |
301 | """ |
|
301 | """ | |
302 | ) |
|
302 | ) | |
303 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
303 | object_info_string_level = Enum((0,1,2), default_value=0, | |
304 | config=True) |
|
304 | config=True) | |
305 | pdb = CBool(False, config=True, help= |
|
305 | pdb = CBool(False, config=True, help= | |
306 | """ |
|
306 | """ | |
307 | Automatically call the pdb debugger after every exception. |
|
307 | Automatically call the pdb debugger after every exception. | |
308 | """ |
|
308 | """ | |
309 | ) |
|
309 | ) | |
310 | multiline_history = CBool(sys.platform != 'win32', config=True, |
|
310 | multiline_history = CBool(sys.platform != 'win32', config=True, | |
311 | help="Save multi-line entries as one entry in readline history" |
|
311 | help="Save multi-line entries as one entry in readline history" | |
312 | ) |
|
312 | ) | |
313 |
|
313 | |||
314 | prompt_in1 = Unicode('In [\\#]: ', config=True) |
|
314 | prompt_in1 = Unicode('In [\\#]: ', config=True) | |
315 | prompt_in2 = Unicode(' .\\D.: ', config=True) |
|
315 | prompt_in2 = Unicode(' .\\D.: ', config=True) | |
316 | prompt_out = Unicode('Out[\\#]: ', config=True) |
|
316 | prompt_out = Unicode('Out[\\#]: ', config=True) | |
317 | prompts_pad_left = CBool(True, config=True) |
|
317 | prompts_pad_left = CBool(True, config=True) | |
318 | quiet = CBool(False, config=True) |
|
318 | quiet = CBool(False, config=True) | |
319 |
|
319 | |||
320 | history_length = Int(10000, config=True) |
|
320 | history_length = Int(10000, config=True) | |
321 |
|
321 | |||
322 | # The readline stuff will eventually be moved to the terminal subclass |
|
322 | # The readline stuff will eventually be moved to the terminal subclass | |
323 | # but for now, we can't do that as readline is welded in everywhere. |
|
323 | # but for now, we can't do that as readline is welded in everywhere. | |
324 | readline_use = CBool(True, config=True) |
|
324 | readline_use = CBool(True, config=True) | |
325 | readline_remove_delims = Unicode('-/~', config=True) |
|
325 | readline_remove_delims = Unicode('-/~', config=True) | |
326 | # don't use \M- bindings by default, because they |
|
326 | # don't use \M- bindings by default, because they | |
327 | # conflict with 8-bit encodings. See gh-58,gh-88 |
|
327 | # conflict with 8-bit encodings. See gh-58,gh-88 | |
328 | readline_parse_and_bind = List([ |
|
328 | readline_parse_and_bind = List([ | |
329 | 'tab: complete', |
|
329 | 'tab: complete', | |
330 | '"\C-l": clear-screen', |
|
330 | '"\C-l": clear-screen', | |
331 | 'set show-all-if-ambiguous on', |
|
331 | 'set show-all-if-ambiguous on', | |
332 | '"\C-o": tab-insert', |
|
332 | '"\C-o": tab-insert', | |
333 | '"\C-r": reverse-search-history', |
|
333 | '"\C-r": reverse-search-history', | |
334 | '"\C-s": forward-search-history', |
|
334 | '"\C-s": forward-search-history', | |
335 | '"\C-p": history-search-backward', |
|
335 | '"\C-p": history-search-backward', | |
336 | '"\C-n": history-search-forward', |
|
336 | '"\C-n": history-search-forward', | |
337 | '"\e[A": history-search-backward', |
|
337 | '"\e[A": history-search-backward', | |
338 | '"\e[B": history-search-forward', |
|
338 | '"\e[B": history-search-forward', | |
339 | '"\C-k": kill-line', |
|
339 | '"\C-k": kill-line', | |
340 | '"\C-u": unix-line-discard', |
|
340 | '"\C-u": unix-line-discard', | |
341 | ], allow_none=False, config=True) |
|
341 | ], allow_none=False, config=True) | |
342 |
|
342 | |||
343 | # TODO: this part of prompt management should be moved to the frontends. |
|
343 | # TODO: this part of prompt management should be moved to the frontends. | |
344 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
344 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' | |
345 | separate_in = SeparateUnicode('\n', config=True) |
|
345 | separate_in = SeparateUnicode('\n', config=True) | |
346 | separate_out = SeparateUnicode('', config=True) |
|
346 | separate_out = SeparateUnicode('', config=True) | |
347 | separate_out2 = SeparateUnicode('', config=True) |
|
347 | separate_out2 = SeparateUnicode('', config=True) | |
348 | wildcards_case_sensitive = CBool(True, config=True) |
|
348 | wildcards_case_sensitive = CBool(True, config=True) | |
349 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
349 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), | |
350 | default_value='Context', config=True) |
|
350 | default_value='Context', config=True) | |
351 |
|
351 | |||
352 | # Subcomponents of InteractiveShell |
|
352 | # Subcomponents of InteractiveShell | |
353 | alias_manager = Instance('IPython.core.alias.AliasManager') |
|
353 | alias_manager = Instance('IPython.core.alias.AliasManager') | |
354 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
354 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') | |
355 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') |
|
355 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') | |
356 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') |
|
356 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') | |
357 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') |
|
357 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') | |
358 | plugin_manager = Instance('IPython.core.plugin.PluginManager') |
|
358 | plugin_manager = Instance('IPython.core.plugin.PluginManager') | |
359 | payload_manager = Instance('IPython.core.payload.PayloadManager') |
|
359 | payload_manager = Instance('IPython.core.payload.PayloadManager') | |
360 | history_manager = Instance('IPython.core.history.HistoryManager') |
|
360 | history_manager = Instance('IPython.core.history.HistoryManager') | |
361 |
|
361 | |||
362 | profile_dir = Instance('IPython.core.application.ProfileDir') |
|
362 | profile_dir = Instance('IPython.core.application.ProfileDir') | |
363 | @property |
|
363 | @property | |
364 | def profile(self): |
|
364 | def profile(self): | |
365 | if self.profile_dir is not None: |
|
365 | if self.profile_dir is not None: | |
366 | name = os.path.basename(self.profile_dir.location) |
|
366 | name = os.path.basename(self.profile_dir.location) | |
367 | return name.replace('profile_','') |
|
367 | return name.replace('profile_','') | |
368 |
|
368 | |||
369 |
|
369 | |||
370 | # Private interface |
|
370 | # Private interface | |
371 | _post_execute = Instance(dict) |
|
371 | _post_execute = Instance(dict) | |
372 |
|
372 | |||
373 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, |
|
373 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, | |
374 | user_ns=None, user_global_ns=None, |
|
374 | user_ns=None, user_global_ns=None, | |
375 | custom_exceptions=((), None)): |
|
375 | custom_exceptions=((), None)): | |
376 |
|
376 | |||
377 | # This is where traits with a config_key argument are updated |
|
377 | # This is where traits with a config_key argument are updated | |
378 | # from the values on config. |
|
378 | # from the values on config. | |
379 | super(InteractiveShell, self).__init__(config=config) |
|
379 | super(InteractiveShell, self).__init__(config=config) | |
380 | self.configurables = [self] |
|
380 | self.configurables = [self] | |
381 |
|
381 | |||
382 | # These are relatively independent and stateless |
|
382 | # These are relatively independent and stateless | |
383 | self.init_ipython_dir(ipython_dir) |
|
383 | self.init_ipython_dir(ipython_dir) | |
384 | self.init_profile_dir(profile_dir) |
|
384 | self.init_profile_dir(profile_dir) | |
385 | self.init_instance_attrs() |
|
385 | self.init_instance_attrs() | |
386 | self.init_environment() |
|
386 | self.init_environment() | |
387 |
|
387 | |||
388 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
388 | # Create namespaces (user_ns, user_global_ns, etc.) | |
389 | self.init_create_namespaces(user_ns, user_global_ns) |
|
389 | self.init_create_namespaces(user_ns, user_global_ns) | |
390 | # This has to be done after init_create_namespaces because it uses |
|
390 | # This has to be done after init_create_namespaces because it uses | |
391 | # something in self.user_ns, but before init_sys_modules, which |
|
391 | # something in self.user_ns, but before init_sys_modules, which | |
392 | # is the first thing to modify sys. |
|
392 | # is the first thing to modify sys. | |
393 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
393 | # TODO: When we override sys.stdout and sys.stderr before this class | |
394 | # is created, we are saving the overridden ones here. Not sure if this |
|
394 | # is created, we are saving the overridden ones here. Not sure if this | |
395 | # is what we want to do. |
|
395 | # is what we want to do. | |
396 | self.save_sys_module_state() |
|
396 | self.save_sys_module_state() | |
397 | self.init_sys_modules() |
|
397 | self.init_sys_modules() | |
398 |
|
398 | |||
399 | # While we're trying to have each part of the code directly access what |
|
399 | # While we're trying to have each part of the code directly access what | |
400 | # it needs without keeping redundant references to objects, we have too |
|
400 | # it needs without keeping redundant references to objects, we have too | |
401 | # much legacy code that expects ip.db to exist. |
|
401 | # much legacy code that expects ip.db to exist. | |
402 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
402 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) | |
403 |
|
403 | |||
404 | self.init_history() |
|
404 | self.init_history() | |
405 | self.init_encoding() |
|
405 | self.init_encoding() | |
406 | self.init_prefilter() |
|
406 | self.init_prefilter() | |
407 |
|
407 | |||
408 | Magic.__init__(self, self) |
|
408 | Magic.__init__(self, self) | |
409 |
|
409 | |||
410 | self.init_syntax_highlighting() |
|
410 | self.init_syntax_highlighting() | |
411 | self.init_hooks() |
|
411 | self.init_hooks() | |
412 | self.init_pushd_popd_magic() |
|
412 | self.init_pushd_popd_magic() | |
413 | # self.init_traceback_handlers use to be here, but we moved it below |
|
413 | # self.init_traceback_handlers use to be here, but we moved it below | |
414 | # because it and init_io have to come after init_readline. |
|
414 | # because it and init_io have to come after init_readline. | |
415 | self.init_user_ns() |
|
415 | self.init_user_ns() | |
416 | self.init_logger() |
|
416 | self.init_logger() | |
417 | self.init_alias() |
|
417 | self.init_alias() | |
418 | self.init_builtins() |
|
418 | self.init_builtins() | |
419 |
|
419 | |||
420 | # pre_config_initialization |
|
420 | # pre_config_initialization | |
421 |
|
421 | |||
422 | # The next section should contain everything that was in ipmaker. |
|
422 | # The next section should contain everything that was in ipmaker. | |
423 | self.init_logstart() |
|
423 | self.init_logstart() | |
424 |
|
424 | |||
425 | # The following was in post_config_initialization |
|
425 | # The following was in post_config_initialization | |
426 | self.init_inspector() |
|
426 | self.init_inspector() | |
427 | # init_readline() must come before init_io(), because init_io uses |
|
427 | # init_readline() must come before init_io(), because init_io uses | |
428 | # readline related things. |
|
428 | # readline related things. | |
429 | self.init_readline() |
|
429 | self.init_readline() | |
430 | # We save this here in case user code replaces raw_input, but it needs |
|
430 | # We save this here in case user code replaces raw_input, but it needs | |
431 | # to be after init_readline(), because PyPy's readline works by replacing |
|
431 | # to be after init_readline(), because PyPy's readline works by replacing | |
432 | # raw_input. |
|
432 | # raw_input. | |
433 | if py3compat.PY3: |
|
433 | if py3compat.PY3: | |
434 | self.raw_input_original = input |
|
434 | self.raw_input_original = input | |
435 | else: |
|
435 | else: | |
436 | self.raw_input_original = raw_input |
|
436 | self.raw_input_original = raw_input | |
437 | # init_completer must come after init_readline, because it needs to |
|
437 | # init_completer must come after init_readline, because it needs to | |
438 | # know whether readline is present or not system-wide to configure the |
|
438 | # know whether readline is present or not system-wide to configure the | |
439 | # completers, since the completion machinery can now operate |
|
439 | # completers, since the completion machinery can now operate | |
440 | # independently of readline (e.g. over the network) |
|
440 | # independently of readline (e.g. over the network) | |
441 | self.init_completer() |
|
441 | self.init_completer() | |
442 | # TODO: init_io() needs to happen before init_traceback handlers |
|
442 | # TODO: init_io() needs to happen before init_traceback handlers | |
443 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
443 | # because the traceback handlers hardcode the stdout/stderr streams. | |
444 | # This logic in in debugger.Pdb and should eventually be changed. |
|
444 | # This logic in in debugger.Pdb and should eventually be changed. | |
445 | self.init_io() |
|
445 | self.init_io() | |
446 | self.init_traceback_handlers(custom_exceptions) |
|
446 | self.init_traceback_handlers(custom_exceptions) | |
447 | self.init_prompts() |
|
447 | self.init_prompts() | |
448 | self.init_display_formatter() |
|
448 | self.init_display_formatter() | |
449 | self.init_display_pub() |
|
449 | self.init_display_pub() | |
450 | self.init_displayhook() |
|
450 | self.init_displayhook() | |
451 | self.init_reload_doctest() |
|
451 | self.init_reload_doctest() | |
452 | self.init_magics() |
|
452 | self.init_magics() | |
453 | self.init_pdb() |
|
453 | self.init_pdb() | |
454 | self.init_extension_manager() |
|
454 | self.init_extension_manager() | |
455 | self.init_plugin_manager() |
|
455 | self.init_plugin_manager() | |
456 | self.init_payload() |
|
456 | self.init_payload() | |
457 | self.hooks.late_startup_hook() |
|
457 | self.hooks.late_startup_hook() | |
458 | atexit.register(self.atexit_operations) |
|
458 | atexit.register(self.atexit_operations) | |
459 |
|
459 | |||
460 | def get_ipython(self): |
|
460 | def get_ipython(self): | |
461 | """Return the currently running IPython instance.""" |
|
461 | """Return the currently running IPython instance.""" | |
462 | return self |
|
462 | return self | |
463 |
|
463 | |||
464 | #------------------------------------------------------------------------- |
|
464 | #------------------------------------------------------------------------- | |
465 | # Trait changed handlers |
|
465 | # Trait changed handlers | |
466 | #------------------------------------------------------------------------- |
|
466 | #------------------------------------------------------------------------- | |
467 |
|
467 | |||
468 | def _ipython_dir_changed(self, name, new): |
|
468 | def _ipython_dir_changed(self, name, new): | |
469 | if not os.path.isdir(new): |
|
469 | if not os.path.isdir(new): | |
470 | os.makedirs(new, mode = 0777) |
|
470 | os.makedirs(new, mode = 0777) | |
471 |
|
471 | |||
472 | def set_autoindent(self,value=None): |
|
472 | def set_autoindent(self,value=None): | |
473 | """Set the autoindent flag, checking for readline support. |
|
473 | """Set the autoindent flag, checking for readline support. | |
474 |
|
474 | |||
475 | If called with no arguments, it acts as a toggle.""" |
|
475 | If called with no arguments, it acts as a toggle.""" | |
476 |
|
476 | |||
477 | if value != 0 and not self.has_readline: |
|
477 | if value != 0 and not self.has_readline: | |
478 | if os.name == 'posix': |
|
478 | if os.name == 'posix': | |
479 | warn("The auto-indent feature requires the readline library") |
|
479 | warn("The auto-indent feature requires the readline library") | |
480 | self.autoindent = 0 |
|
480 | self.autoindent = 0 | |
481 | return |
|
481 | return | |
482 | if value is None: |
|
482 | if value is None: | |
483 | self.autoindent = not self.autoindent |
|
483 | self.autoindent = not self.autoindent | |
484 | else: |
|
484 | else: | |
485 | self.autoindent = value |
|
485 | self.autoindent = value | |
486 |
|
486 | |||
487 | #------------------------------------------------------------------------- |
|
487 | #------------------------------------------------------------------------- | |
488 | # init_* methods called by __init__ |
|
488 | # init_* methods called by __init__ | |
489 | #------------------------------------------------------------------------- |
|
489 | #------------------------------------------------------------------------- | |
490 |
|
490 | |||
491 | def init_ipython_dir(self, ipython_dir): |
|
491 | def init_ipython_dir(self, ipython_dir): | |
492 | if ipython_dir is not None: |
|
492 | if ipython_dir is not None: | |
493 | self.ipython_dir = ipython_dir |
|
493 | self.ipython_dir = ipython_dir | |
494 | return |
|
494 | return | |
495 |
|
495 | |||
496 | self.ipython_dir = get_ipython_dir() |
|
496 | self.ipython_dir = get_ipython_dir() | |
497 |
|
497 | |||
498 | def init_profile_dir(self, profile_dir): |
|
498 | def init_profile_dir(self, profile_dir): | |
499 | if profile_dir is not None: |
|
499 | if profile_dir is not None: | |
500 | self.profile_dir = profile_dir |
|
500 | self.profile_dir = profile_dir | |
501 | return |
|
501 | return | |
502 | self.profile_dir =\ |
|
502 | self.profile_dir =\ | |
503 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
503 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') | |
504 |
|
504 | |||
505 | def init_instance_attrs(self): |
|
505 | def init_instance_attrs(self): | |
506 | self.more = False |
|
506 | self.more = False | |
507 |
|
507 | |||
508 | # command compiler |
|
508 | # command compiler | |
509 | self.compile = CachingCompiler() |
|
509 | self.compile = CachingCompiler() | |
510 |
|
510 | |||
511 | # Make an empty namespace, which extension writers can rely on both |
|
511 | # Make an empty namespace, which extension writers can rely on both | |
512 | # existing and NEVER being used by ipython itself. This gives them a |
|
512 | # existing and NEVER being used by ipython itself. This gives them a | |
513 | # convenient location for storing additional information and state |
|
513 | # convenient location for storing additional information and state | |
514 | # their extensions may require, without fear of collisions with other |
|
514 | # their extensions may require, without fear of collisions with other | |
515 | # ipython names that may develop later. |
|
515 | # ipython names that may develop later. | |
516 | self.meta = Struct() |
|
516 | self.meta = Struct() | |
517 |
|
517 | |||
518 | # Temporary files used for various purposes. Deleted at exit. |
|
518 | # Temporary files used for various purposes. Deleted at exit. | |
519 | self.tempfiles = [] |
|
519 | self.tempfiles = [] | |
520 |
|
520 | |||
521 | # Keep track of readline usage (later set by init_readline) |
|
521 | # Keep track of readline usage (later set by init_readline) | |
522 | self.has_readline = False |
|
522 | self.has_readline = False | |
523 |
|
523 | |||
524 | # keep track of where we started running (mainly for crash post-mortem) |
|
524 | # keep track of where we started running (mainly for crash post-mortem) | |
525 | # This is not being used anywhere currently. |
|
525 | # This is not being used anywhere currently. | |
526 | self.starting_dir = os.getcwdu() |
|
526 | self.starting_dir = os.getcwdu() | |
527 |
|
527 | |||
528 | # Indentation management |
|
528 | # Indentation management | |
529 | self.indent_current_nsp = 0 |
|
529 | self.indent_current_nsp = 0 | |
530 |
|
530 | |||
531 | # Dict to track post-execution functions that have been registered |
|
531 | # Dict to track post-execution functions that have been registered | |
532 | self._post_execute = {} |
|
532 | self._post_execute = {} | |
533 |
|
533 | |||
534 | def init_environment(self): |
|
534 | def init_environment(self): | |
535 | """Any changes we need to make to the user's environment.""" |
|
535 | """Any changes we need to make to the user's environment.""" | |
536 | pass |
|
536 | pass | |
537 |
|
537 | |||
538 | def init_encoding(self): |
|
538 | def init_encoding(self): | |
539 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
539 | # Get system encoding at startup time. Certain terminals (like Emacs | |
540 | # under Win32 have it set to None, and we need to have a known valid |
|
540 | # under Win32 have it set to None, and we need to have a known valid | |
541 | # encoding to use in the raw_input() method |
|
541 | # encoding to use in the raw_input() method | |
542 | try: |
|
542 | try: | |
543 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
543 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
544 | except AttributeError: |
|
544 | except AttributeError: | |
545 | self.stdin_encoding = 'ascii' |
|
545 | self.stdin_encoding = 'ascii' | |
546 |
|
546 | |||
547 | def init_syntax_highlighting(self): |
|
547 | def init_syntax_highlighting(self): | |
548 | # Python source parser/formatter for syntax highlighting |
|
548 | # Python source parser/formatter for syntax highlighting | |
549 | pyformat = PyColorize.Parser().format |
|
549 | pyformat = PyColorize.Parser().format | |
550 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) |
|
550 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) | |
551 |
|
551 | |||
552 | def init_pushd_popd_magic(self): |
|
552 | def init_pushd_popd_magic(self): | |
553 | # for pushd/popd management |
|
553 | # for pushd/popd management | |
554 | try: |
|
554 | try: | |
555 | self.home_dir = get_home_dir() |
|
555 | self.home_dir = get_home_dir() | |
556 | except HomeDirError, msg: |
|
556 | except HomeDirError, msg: | |
557 | fatal(msg) |
|
557 | fatal(msg) | |
558 |
|
558 | |||
559 | self.dir_stack = [] |
|
559 | self.dir_stack = [] | |
560 |
|
560 | |||
561 | def init_logger(self): |
|
561 | def init_logger(self): | |
562 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
562 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', | |
563 | logmode='rotate') |
|
563 | logmode='rotate') | |
564 |
|
564 | |||
565 | def init_logstart(self): |
|
565 | def init_logstart(self): | |
566 | """Initialize logging in case it was requested at the command line. |
|
566 | """Initialize logging in case it was requested at the command line. | |
567 | """ |
|
567 | """ | |
568 | if self.logappend: |
|
568 | if self.logappend: | |
569 | self.magic_logstart(self.logappend + ' append') |
|
569 | self.magic_logstart(self.logappend + ' append') | |
570 | elif self.logfile: |
|
570 | elif self.logfile: | |
571 | self.magic_logstart(self.logfile) |
|
571 | self.magic_logstart(self.logfile) | |
572 | elif self.logstart: |
|
572 | elif self.logstart: | |
573 | self.magic_logstart() |
|
573 | self.magic_logstart() | |
574 |
|
574 | |||
575 | def init_builtins(self): |
|
575 | def init_builtins(self): | |
576 | self.builtin_trap = BuiltinTrap(shell=self) |
|
576 | self.builtin_trap = BuiltinTrap(shell=self) | |
577 |
|
577 | |||
578 | def init_inspector(self): |
|
578 | def init_inspector(self): | |
579 | # Object inspector |
|
579 | # Object inspector | |
580 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
580 | self.inspector = oinspect.Inspector(oinspect.InspectColors, | |
581 | PyColorize.ANSICodeColors, |
|
581 | PyColorize.ANSICodeColors, | |
582 | 'NoColor', |
|
582 | 'NoColor', | |
583 | self.object_info_string_level) |
|
583 | self.object_info_string_level) | |
584 |
|
584 | |||
585 | def init_io(self): |
|
585 | def init_io(self): | |
586 | # This will just use sys.stdout and sys.stderr. If you want to |
|
586 | # This will just use sys.stdout and sys.stderr. If you want to | |
587 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
587 | # override sys.stdout and sys.stderr themselves, you need to do that | |
588 | # *before* instantiating this class, because io holds onto |
|
588 | # *before* instantiating this class, because io holds onto | |
589 | # references to the underlying streams. |
|
589 | # references to the underlying streams. | |
590 | if sys.platform == 'win32' and self.has_readline: |
|
590 | if sys.platform == 'win32' and self.has_readline: | |
591 | io.stdout = io.stderr = io.IOStream(self.readline._outputfile) |
|
591 | io.stdout = io.stderr = io.IOStream(self.readline._outputfile) | |
592 | else: |
|
592 | else: | |
593 | io.stdout = io.IOStream(sys.stdout) |
|
593 | io.stdout = io.IOStream(sys.stdout) | |
594 | io.stderr = io.IOStream(sys.stderr) |
|
594 | io.stderr = io.IOStream(sys.stderr) | |
595 |
|
595 | |||
596 | def init_prompts(self): |
|
596 | def init_prompts(self): | |
597 | # TODO: This is a pass for now because the prompts are managed inside |
|
597 | # TODO: This is a pass for now because the prompts are managed inside | |
598 | # the DisplayHook. Once there is a separate prompt manager, this |
|
598 | # the DisplayHook. Once there is a separate prompt manager, this | |
599 | # will initialize that object and all prompt related information. |
|
599 | # will initialize that object and all prompt related information. | |
600 | pass |
|
600 | pass | |
601 |
|
601 | |||
602 | def init_display_formatter(self): |
|
602 | def init_display_formatter(self): | |
603 | self.display_formatter = DisplayFormatter(config=self.config) |
|
603 | self.display_formatter = DisplayFormatter(config=self.config) | |
604 | self.configurables.append(self.display_formatter) |
|
604 | self.configurables.append(self.display_formatter) | |
605 |
|
605 | |||
606 | def init_display_pub(self): |
|
606 | def init_display_pub(self): | |
607 | self.display_pub = self.display_pub_class(config=self.config) |
|
607 | self.display_pub = self.display_pub_class(config=self.config) | |
608 | self.configurables.append(self.display_pub) |
|
608 | self.configurables.append(self.display_pub) | |
609 |
|
609 | |||
610 | def init_displayhook(self): |
|
610 | def init_displayhook(self): | |
611 | # Initialize displayhook, set in/out prompts and printing system |
|
611 | # Initialize displayhook, set in/out prompts and printing system | |
612 | self.displayhook = self.displayhook_class( |
|
612 | self.displayhook = self.displayhook_class( | |
613 | config=self.config, |
|
613 | config=self.config, | |
614 | shell=self, |
|
614 | shell=self, | |
615 | cache_size=self.cache_size, |
|
615 | cache_size=self.cache_size, | |
616 | input_sep = self.separate_in, |
|
616 | input_sep = self.separate_in, | |
617 | output_sep = self.separate_out, |
|
617 | output_sep = self.separate_out, | |
618 | output_sep2 = self.separate_out2, |
|
618 | output_sep2 = self.separate_out2, | |
619 | ps1 = self.prompt_in1, |
|
619 | ps1 = self.prompt_in1, | |
620 | ps2 = self.prompt_in2, |
|
620 | ps2 = self.prompt_in2, | |
621 | ps_out = self.prompt_out, |
|
621 | ps_out = self.prompt_out, | |
622 | pad_left = self.prompts_pad_left |
|
622 | pad_left = self.prompts_pad_left | |
623 | ) |
|
623 | ) | |
624 | self.configurables.append(self.displayhook) |
|
624 | self.configurables.append(self.displayhook) | |
625 | # This is a context manager that installs/revmoes the displayhook at |
|
625 | # This is a context manager that installs/revmoes the displayhook at | |
626 | # the appropriate time. |
|
626 | # the appropriate time. | |
627 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
627 | self.display_trap = DisplayTrap(hook=self.displayhook) | |
628 |
|
628 | |||
629 | def init_reload_doctest(self): |
|
629 | def init_reload_doctest(self): | |
630 | # Do a proper resetting of doctest, including the necessary displayhook |
|
630 | # Do a proper resetting of doctest, including the necessary displayhook | |
631 | # monkeypatching |
|
631 | # monkeypatching | |
632 | try: |
|
632 | try: | |
633 | doctest_reload() |
|
633 | doctest_reload() | |
634 | except ImportError: |
|
634 | except ImportError: | |
635 | warn("doctest module does not exist.") |
|
635 | warn("doctest module does not exist.") | |
636 |
|
636 | |||
637 | #------------------------------------------------------------------------- |
|
637 | #------------------------------------------------------------------------- | |
638 | # Things related to injections into the sys module |
|
638 | # Things related to injections into the sys module | |
639 | #------------------------------------------------------------------------- |
|
639 | #------------------------------------------------------------------------- | |
640 |
|
640 | |||
641 | def save_sys_module_state(self): |
|
641 | def save_sys_module_state(self): | |
642 | """Save the state of hooks in the sys module. |
|
642 | """Save the state of hooks in the sys module. | |
643 |
|
643 | |||
644 | This has to be called after self.user_ns is created. |
|
644 | This has to be called after self.user_ns is created. | |
645 | """ |
|
645 | """ | |
646 | self._orig_sys_module_state = {} |
|
646 | self._orig_sys_module_state = {} | |
647 | self._orig_sys_module_state['stdin'] = sys.stdin |
|
647 | self._orig_sys_module_state['stdin'] = sys.stdin | |
648 | self._orig_sys_module_state['stdout'] = sys.stdout |
|
648 | self._orig_sys_module_state['stdout'] = sys.stdout | |
649 | self._orig_sys_module_state['stderr'] = sys.stderr |
|
649 | self._orig_sys_module_state['stderr'] = sys.stderr | |
650 | self._orig_sys_module_state['excepthook'] = sys.excepthook |
|
650 | self._orig_sys_module_state['excepthook'] = sys.excepthook | |
651 | try: |
|
651 | try: | |
652 | self._orig_sys_modules_main_name = self.user_ns['__name__'] |
|
652 | self._orig_sys_modules_main_name = self.user_ns['__name__'] | |
653 | except KeyError: |
|
653 | except KeyError: | |
654 | pass |
|
654 | pass | |
655 |
|
655 | |||
656 | def restore_sys_module_state(self): |
|
656 | def restore_sys_module_state(self): | |
657 | """Restore the state of the sys module.""" |
|
657 | """Restore the state of the sys module.""" | |
658 | try: |
|
658 | try: | |
659 | for k, v in self._orig_sys_module_state.iteritems(): |
|
659 | for k, v in self._orig_sys_module_state.iteritems(): | |
660 | setattr(sys, k, v) |
|
660 | setattr(sys, k, v) | |
661 | except AttributeError: |
|
661 | except AttributeError: | |
662 | pass |
|
662 | pass | |
663 | # Reset what what done in self.init_sys_modules |
|
663 | # Reset what what done in self.init_sys_modules | |
664 | try: |
|
664 | try: | |
665 | sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name |
|
665 | sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name | |
666 | except (AttributeError, KeyError): |
|
666 | except (AttributeError, KeyError): | |
667 | pass |
|
667 | pass | |
668 |
|
668 | |||
669 | #------------------------------------------------------------------------- |
|
669 | #------------------------------------------------------------------------- | |
670 | # Things related to hooks |
|
670 | # Things related to hooks | |
671 | #------------------------------------------------------------------------- |
|
671 | #------------------------------------------------------------------------- | |
672 |
|
672 | |||
673 | def init_hooks(self): |
|
673 | def init_hooks(self): | |
674 | # hooks holds pointers used for user-side customizations |
|
674 | # hooks holds pointers used for user-side customizations | |
675 | self.hooks = Struct() |
|
675 | self.hooks = Struct() | |
676 |
|
676 | |||
677 | self.strdispatchers = {} |
|
677 | self.strdispatchers = {} | |
678 |
|
678 | |||
679 | # Set all default hooks, defined in the IPython.hooks module. |
|
679 | # Set all default hooks, defined in the IPython.hooks module. | |
680 | hooks = IPython.core.hooks |
|
680 | hooks = IPython.core.hooks | |
681 | for hook_name in hooks.__all__: |
|
681 | for hook_name in hooks.__all__: | |
682 | # default hooks have priority 100, i.e. low; user hooks should have |
|
682 | # default hooks have priority 100, i.e. low; user hooks should have | |
683 | # 0-100 priority |
|
683 | # 0-100 priority | |
684 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
684 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) | |
685 |
|
685 | |||
686 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
686 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): | |
687 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
687 | """set_hook(name,hook) -> sets an internal IPython hook. | |
688 |
|
688 | |||
689 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
689 | IPython exposes some of its internal API as user-modifiable hooks. By | |
690 | adding your function to one of these hooks, you can modify IPython's |
|
690 | adding your function to one of these hooks, you can modify IPython's | |
691 | behavior to call at runtime your own routines.""" |
|
691 | behavior to call at runtime your own routines.""" | |
692 |
|
692 | |||
693 | # At some point in the future, this should validate the hook before it |
|
693 | # At some point in the future, this should validate the hook before it | |
694 | # accepts it. Probably at least check that the hook takes the number |
|
694 | # accepts it. Probably at least check that the hook takes the number | |
695 | # of args it's supposed to. |
|
695 | # of args it's supposed to. | |
696 |
|
696 | |||
697 | f = types.MethodType(hook,self) |
|
697 | f = types.MethodType(hook,self) | |
698 |
|
698 | |||
699 | # check if the hook is for strdispatcher first |
|
699 | # check if the hook is for strdispatcher first | |
700 | if str_key is not None: |
|
700 | if str_key is not None: | |
701 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
701 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
702 | sdp.add_s(str_key, f, priority ) |
|
702 | sdp.add_s(str_key, f, priority ) | |
703 | self.strdispatchers[name] = sdp |
|
703 | self.strdispatchers[name] = sdp | |
704 | return |
|
704 | return | |
705 | if re_key is not None: |
|
705 | if re_key is not None: | |
706 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
706 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
707 | sdp.add_re(re.compile(re_key), f, priority ) |
|
707 | sdp.add_re(re.compile(re_key), f, priority ) | |
708 | self.strdispatchers[name] = sdp |
|
708 | self.strdispatchers[name] = sdp | |
709 | return |
|
709 | return | |
710 |
|
710 | |||
711 | dp = getattr(self.hooks, name, None) |
|
711 | dp = getattr(self.hooks, name, None) | |
712 | if name not in IPython.core.hooks.__all__: |
|
712 | if name not in IPython.core.hooks.__all__: | |
713 | print "Warning! Hook '%s' is not one of %s" % \ |
|
713 | print "Warning! Hook '%s' is not one of %s" % \ | |
714 | (name, IPython.core.hooks.__all__ ) |
|
714 | (name, IPython.core.hooks.__all__ ) | |
715 | if not dp: |
|
715 | if not dp: | |
716 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
716 | dp = IPython.core.hooks.CommandChainDispatcher() | |
717 |
|
717 | |||
718 | try: |
|
718 | try: | |
719 | dp.add(f,priority) |
|
719 | dp.add(f,priority) | |
720 | except AttributeError: |
|
720 | except AttributeError: | |
721 | # it was not commandchain, plain old func - replace |
|
721 | # it was not commandchain, plain old func - replace | |
722 | dp = f |
|
722 | dp = f | |
723 |
|
723 | |||
724 | setattr(self.hooks,name, dp) |
|
724 | setattr(self.hooks,name, dp) | |
725 |
|
725 | |||
726 | def register_post_execute(self, func): |
|
726 | def register_post_execute(self, func): | |
727 | """Register a function for calling after code execution. |
|
727 | """Register a function for calling after code execution. | |
728 | """ |
|
728 | """ | |
729 | if not callable(func): |
|
729 | if not callable(func): | |
730 | raise ValueError('argument %s must be callable' % func) |
|
730 | raise ValueError('argument %s must be callable' % func) | |
731 | self._post_execute[func] = True |
|
731 | self._post_execute[func] = True | |
732 |
|
732 | |||
733 | #------------------------------------------------------------------------- |
|
733 | #------------------------------------------------------------------------- | |
734 | # Things related to the "main" module |
|
734 | # Things related to the "main" module | |
735 | #------------------------------------------------------------------------- |
|
735 | #------------------------------------------------------------------------- | |
736 |
|
736 | |||
737 | def new_main_mod(self,ns=None): |
|
737 | def new_main_mod(self,ns=None): | |
738 | """Return a new 'main' module object for user code execution. |
|
738 | """Return a new 'main' module object for user code execution. | |
739 | """ |
|
739 | """ | |
740 | main_mod = self._user_main_module |
|
740 | main_mod = self._user_main_module | |
741 | init_fakemod_dict(main_mod,ns) |
|
741 | init_fakemod_dict(main_mod,ns) | |
742 | return main_mod |
|
742 | return main_mod | |
743 |
|
743 | |||
744 | def cache_main_mod(self,ns,fname): |
|
744 | def cache_main_mod(self,ns,fname): | |
745 | """Cache a main module's namespace. |
|
745 | """Cache a main module's namespace. | |
746 |
|
746 | |||
747 | When scripts are executed via %run, we must keep a reference to the |
|
747 | When scripts are executed via %run, we must keep a reference to the | |
748 | namespace of their __main__ module (a FakeModule instance) around so |
|
748 | namespace of their __main__ module (a FakeModule instance) around so | |
749 | that Python doesn't clear it, rendering objects defined therein |
|
749 | that Python doesn't clear it, rendering objects defined therein | |
750 | useless. |
|
750 | useless. | |
751 |
|
751 | |||
752 | This method keeps said reference in a private dict, keyed by the |
|
752 | This method keeps said reference in a private dict, keyed by the | |
753 | absolute path of the module object (which corresponds to the script |
|
753 | absolute path of the module object (which corresponds to the script | |
754 | path). This way, for multiple executions of the same script we only |
|
754 | path). This way, for multiple executions of the same script we only | |
755 | keep one copy of the namespace (the last one), thus preventing memory |
|
755 | keep one copy of the namespace (the last one), thus preventing memory | |
756 | leaks from old references while allowing the objects from the last |
|
756 | leaks from old references while allowing the objects from the last | |
757 | execution to be accessible. |
|
757 | execution to be accessible. | |
758 |
|
758 | |||
759 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
759 | Note: we can not allow the actual FakeModule instances to be deleted, | |
760 | because of how Python tears down modules (it hard-sets all their |
|
760 | because of how Python tears down modules (it hard-sets all their | |
761 | references to None without regard for reference counts). This method |
|
761 | references to None without regard for reference counts). This method | |
762 | must therefore make a *copy* of the given namespace, to allow the |
|
762 | must therefore make a *copy* of the given namespace, to allow the | |
763 | original module's __dict__ to be cleared and reused. |
|
763 | original module's __dict__ to be cleared and reused. | |
764 |
|
764 | |||
765 |
|
765 | |||
766 | Parameters |
|
766 | Parameters | |
767 | ---------- |
|
767 | ---------- | |
768 | ns : a namespace (a dict, typically) |
|
768 | ns : a namespace (a dict, typically) | |
769 |
|
769 | |||
770 | fname : str |
|
770 | fname : str | |
771 | Filename associated with the namespace. |
|
771 | Filename associated with the namespace. | |
772 |
|
772 | |||
773 | Examples |
|
773 | Examples | |
774 | -------- |
|
774 | -------- | |
775 |
|
775 | |||
776 | In [10]: import IPython |
|
776 | In [10]: import IPython | |
777 |
|
777 | |||
778 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
778 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
779 |
|
779 | |||
780 | In [12]: IPython.__file__ in _ip._main_ns_cache |
|
780 | In [12]: IPython.__file__ in _ip._main_ns_cache | |
781 | Out[12]: True |
|
781 | Out[12]: True | |
782 | """ |
|
782 | """ | |
783 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
783 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() | |
784 |
|
784 | |||
785 | def clear_main_mod_cache(self): |
|
785 | def clear_main_mod_cache(self): | |
786 | """Clear the cache of main modules. |
|
786 | """Clear the cache of main modules. | |
787 |
|
787 | |||
788 | Mainly for use by utilities like %reset. |
|
788 | Mainly for use by utilities like %reset. | |
789 |
|
789 | |||
790 | Examples |
|
790 | Examples | |
791 | -------- |
|
791 | -------- | |
792 |
|
792 | |||
793 | In [15]: import IPython |
|
793 | In [15]: import IPython | |
794 |
|
794 | |||
795 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
795 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
796 |
|
796 | |||
797 | In [17]: len(_ip._main_ns_cache) > 0 |
|
797 | In [17]: len(_ip._main_ns_cache) > 0 | |
798 | Out[17]: True |
|
798 | Out[17]: True | |
799 |
|
799 | |||
800 | In [18]: _ip.clear_main_mod_cache() |
|
800 | In [18]: _ip.clear_main_mod_cache() | |
801 |
|
801 | |||
802 | In [19]: len(_ip._main_ns_cache) == 0 |
|
802 | In [19]: len(_ip._main_ns_cache) == 0 | |
803 | Out[19]: True |
|
803 | Out[19]: True | |
804 | """ |
|
804 | """ | |
805 | self._main_ns_cache.clear() |
|
805 | self._main_ns_cache.clear() | |
806 |
|
806 | |||
807 | #------------------------------------------------------------------------- |
|
807 | #------------------------------------------------------------------------- | |
808 | # Things related to debugging |
|
808 | # Things related to debugging | |
809 | #------------------------------------------------------------------------- |
|
809 | #------------------------------------------------------------------------- | |
810 |
|
810 | |||
811 | def init_pdb(self): |
|
811 | def init_pdb(self): | |
812 | # Set calling of pdb on exceptions |
|
812 | # Set calling of pdb on exceptions | |
813 | # self.call_pdb is a property |
|
813 | # self.call_pdb is a property | |
814 | self.call_pdb = self.pdb |
|
814 | self.call_pdb = self.pdb | |
815 |
|
815 | |||
816 | def _get_call_pdb(self): |
|
816 | def _get_call_pdb(self): | |
817 | return self._call_pdb |
|
817 | return self._call_pdb | |
818 |
|
818 | |||
819 | def _set_call_pdb(self,val): |
|
819 | def _set_call_pdb(self,val): | |
820 |
|
820 | |||
821 | if val not in (0,1,False,True): |
|
821 | if val not in (0,1,False,True): | |
822 | raise ValueError,'new call_pdb value must be boolean' |
|
822 | raise ValueError,'new call_pdb value must be boolean' | |
823 |
|
823 | |||
824 | # store value in instance |
|
824 | # store value in instance | |
825 | self._call_pdb = val |
|
825 | self._call_pdb = val | |
826 |
|
826 | |||
827 | # notify the actual exception handlers |
|
827 | # notify the actual exception handlers | |
828 | self.InteractiveTB.call_pdb = val |
|
828 | self.InteractiveTB.call_pdb = val | |
829 |
|
829 | |||
830 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
830 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
831 | 'Control auto-activation of pdb at exceptions') |
|
831 | 'Control auto-activation of pdb at exceptions') | |
832 |
|
832 | |||
833 | def debugger(self,force=False): |
|
833 | def debugger(self,force=False): | |
834 | """Call the pydb/pdb debugger. |
|
834 | """Call the pydb/pdb debugger. | |
835 |
|
835 | |||
836 | Keywords: |
|
836 | Keywords: | |
837 |
|
837 | |||
838 | - force(False): by default, this routine checks the instance call_pdb |
|
838 | - force(False): by default, this routine checks the instance call_pdb | |
839 | flag and does not actually invoke the debugger if the flag is false. |
|
839 | flag and does not actually invoke the debugger if the flag is false. | |
840 | The 'force' option forces the debugger to activate even if the flag |
|
840 | The 'force' option forces the debugger to activate even if the flag | |
841 | is false. |
|
841 | is false. | |
842 | """ |
|
842 | """ | |
843 |
|
843 | |||
844 | if not (force or self.call_pdb): |
|
844 | if not (force or self.call_pdb): | |
845 | return |
|
845 | return | |
846 |
|
846 | |||
847 | if not hasattr(sys,'last_traceback'): |
|
847 | if not hasattr(sys,'last_traceback'): | |
848 | error('No traceback has been produced, nothing to debug.') |
|
848 | error('No traceback has been produced, nothing to debug.') | |
849 | return |
|
849 | return | |
850 |
|
850 | |||
851 | # use pydb if available |
|
851 | # use pydb if available | |
852 | if debugger.has_pydb: |
|
852 | if debugger.has_pydb: | |
853 | from pydb import pm |
|
853 | from pydb import pm | |
854 | else: |
|
854 | else: | |
855 | # fallback to our internal debugger |
|
855 | # fallback to our internal debugger | |
856 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
856 | pm = lambda : self.InteractiveTB.debugger(force=True) | |
857 |
|
857 | |||
858 | with self.readline_no_record: |
|
858 | with self.readline_no_record: | |
859 | pm() |
|
859 | pm() | |
860 |
|
860 | |||
861 | #------------------------------------------------------------------------- |
|
861 | #------------------------------------------------------------------------- | |
862 | # Things related to IPython's various namespaces |
|
862 | # Things related to IPython's various namespaces | |
863 | #------------------------------------------------------------------------- |
|
863 | #------------------------------------------------------------------------- | |
864 |
|
864 | |||
865 | def init_create_namespaces(self, user_ns=None, user_global_ns=None): |
|
865 | def init_create_namespaces(self, user_ns=None, user_global_ns=None): | |
866 | # Create the namespace where the user will operate. user_ns is |
|
866 | # Create the namespace where the user will operate. user_ns is | |
867 | # normally the only one used, and it is passed to the exec calls as |
|
867 | # normally the only one used, and it is passed to the exec calls as | |
868 | # the locals argument. But we do carry a user_global_ns namespace |
|
868 | # the locals argument. But we do carry a user_global_ns namespace | |
869 | # given as the exec 'globals' argument, This is useful in embedding |
|
869 | # given as the exec 'globals' argument, This is useful in embedding | |
870 | # situations where the ipython shell opens in a context where the |
|
870 | # situations where the ipython shell opens in a context where the | |
871 | # distinction between locals and globals is meaningful. For |
|
871 | # distinction between locals and globals is meaningful. For | |
872 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
872 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
873 |
|
873 | |||
874 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
874 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
875 | # level as a dict instead of a module. This is a manual fix, but I |
|
875 | # level as a dict instead of a module. This is a manual fix, but I | |
876 | # should really track down where the problem is coming from. Alex |
|
876 | # should really track down where the problem is coming from. Alex | |
877 | # Schmolck reported this problem first. |
|
877 | # Schmolck reported this problem first. | |
878 |
|
878 | |||
879 | # A useful post by Alex Martelli on this topic: |
|
879 | # A useful post by Alex Martelli on this topic: | |
880 | # Re: inconsistent value from __builtins__ |
|
880 | # Re: inconsistent value from __builtins__ | |
881 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
881 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
882 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
882 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
883 | # Gruppen: comp.lang.python |
|
883 | # Gruppen: comp.lang.python | |
884 |
|
884 | |||
885 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
885 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
886 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
886 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
887 | # > <type 'dict'> |
|
887 | # > <type 'dict'> | |
888 | # > >>> print type(__builtins__) |
|
888 | # > >>> print type(__builtins__) | |
889 | # > <type 'module'> |
|
889 | # > <type 'module'> | |
890 | # > Is this difference in return value intentional? |
|
890 | # > Is this difference in return value intentional? | |
891 |
|
891 | |||
892 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
892 | # Well, it's documented that '__builtins__' can be either a dictionary | |
893 | # or a module, and it's been that way for a long time. Whether it's |
|
893 | # or a module, and it's been that way for a long time. Whether it's | |
894 | # intentional (or sensible), I don't know. In any case, the idea is |
|
894 | # intentional (or sensible), I don't know. In any case, the idea is | |
895 | # that if you need to access the built-in namespace directly, you |
|
895 | # that if you need to access the built-in namespace directly, you | |
896 | # should start with "import __builtin__" (note, no 's') which will |
|
896 | # should start with "import __builtin__" (note, no 's') which will | |
897 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
897 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
898 |
|
898 | |||
899 | # These routines return properly built dicts as needed by the rest of |
|
899 | # These routines return properly built dicts as needed by the rest of | |
900 | # the code, and can also be used by extension writers to generate |
|
900 | # the code, and can also be used by extension writers to generate | |
901 | # properly initialized namespaces. |
|
901 | # properly initialized namespaces. | |
902 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, |
|
902 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, | |
903 | user_global_ns) |
|
903 | user_global_ns) | |
904 |
|
904 | |||
905 | # Assign namespaces |
|
905 | # Assign namespaces | |
906 | # This is the namespace where all normal user variables live |
|
906 | # This is the namespace where all normal user variables live | |
907 | self.user_ns = user_ns |
|
907 | self.user_ns = user_ns | |
908 | self.user_global_ns = user_global_ns |
|
908 | self.user_global_ns = user_global_ns | |
909 |
|
909 | |||
910 | # An auxiliary namespace that checks what parts of the user_ns were |
|
910 | # An auxiliary namespace that checks what parts of the user_ns were | |
911 | # loaded at startup, so we can list later only variables defined in |
|
911 | # loaded at startup, so we can list later only variables defined in | |
912 | # actual interactive use. Since it is always a subset of user_ns, it |
|
912 | # actual interactive use. Since it is always a subset of user_ns, it | |
913 | # doesn't need to be separately tracked in the ns_table. |
|
913 | # doesn't need to be separately tracked in the ns_table. | |
914 | self.user_ns_hidden = {} |
|
914 | self.user_ns_hidden = {} | |
915 |
|
915 | |||
916 | # A namespace to keep track of internal data structures to prevent |
|
916 | # A namespace to keep track of internal data structures to prevent | |
917 | # them from cluttering user-visible stuff. Will be updated later |
|
917 | # them from cluttering user-visible stuff. Will be updated later | |
918 | self.internal_ns = {} |
|
918 | self.internal_ns = {} | |
919 |
|
919 | |||
920 | # Now that FakeModule produces a real module, we've run into a nasty |
|
920 | # Now that FakeModule produces a real module, we've run into a nasty | |
921 | # problem: after script execution (via %run), the module where the user |
|
921 | # problem: after script execution (via %run), the module where the user | |
922 | # code ran is deleted. Now that this object is a true module (needed |
|
922 | # code ran is deleted. Now that this object is a true module (needed | |
923 | # so docetst and other tools work correctly), the Python module |
|
923 | # so docetst and other tools work correctly), the Python module | |
924 | # teardown mechanism runs over it, and sets to None every variable |
|
924 | # teardown mechanism runs over it, and sets to None every variable | |
925 | # present in that module. Top-level references to objects from the |
|
925 | # present in that module. Top-level references to objects from the | |
926 | # script survive, because the user_ns is updated with them. However, |
|
926 | # script survive, because the user_ns is updated with them. However, | |
927 | # calling functions defined in the script that use other things from |
|
927 | # calling functions defined in the script that use other things from | |
928 | # the script will fail, because the function's closure had references |
|
928 | # the script will fail, because the function's closure had references | |
929 | # to the original objects, which are now all None. So we must protect |
|
929 | # to the original objects, which are now all None. So we must protect | |
930 | # these modules from deletion by keeping a cache. |
|
930 | # these modules from deletion by keeping a cache. | |
931 | # |
|
931 | # | |
932 | # To avoid keeping stale modules around (we only need the one from the |
|
932 | # To avoid keeping stale modules around (we only need the one from the | |
933 | # last run), we use a dict keyed with the full path to the script, so |
|
933 | # last run), we use a dict keyed with the full path to the script, so | |
934 | # only the last version of the module is held in the cache. Note, |
|
934 | # only the last version of the module is held in the cache. Note, | |
935 | # however, that we must cache the module *namespace contents* (their |
|
935 | # however, that we must cache the module *namespace contents* (their | |
936 | # __dict__). Because if we try to cache the actual modules, old ones |
|
936 | # __dict__). Because if we try to cache the actual modules, old ones | |
937 | # (uncached) could be destroyed while still holding references (such as |
|
937 | # (uncached) could be destroyed while still holding references (such as | |
938 | # those held by GUI objects that tend to be long-lived)> |
|
938 | # those held by GUI objects that tend to be long-lived)> | |
939 | # |
|
939 | # | |
940 | # The %reset command will flush this cache. See the cache_main_mod() |
|
940 | # The %reset command will flush this cache. See the cache_main_mod() | |
941 | # and clear_main_mod_cache() methods for details on use. |
|
941 | # and clear_main_mod_cache() methods for details on use. | |
942 |
|
942 | |||
943 | # This is the cache used for 'main' namespaces |
|
943 | # This is the cache used for 'main' namespaces | |
944 | self._main_ns_cache = {} |
|
944 | self._main_ns_cache = {} | |
945 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
945 | # And this is the single instance of FakeModule whose __dict__ we keep | |
946 | # copying and clearing for reuse on each %run |
|
946 | # copying and clearing for reuse on each %run | |
947 | self._user_main_module = FakeModule() |
|
947 | self._user_main_module = FakeModule() | |
948 |
|
948 | |||
949 | # A table holding all the namespaces IPython deals with, so that |
|
949 | # A table holding all the namespaces IPython deals with, so that | |
950 | # introspection facilities can search easily. |
|
950 | # introspection facilities can search easily. | |
951 | self.ns_table = {'user':user_ns, |
|
951 | self.ns_table = {'user':user_ns, | |
952 | 'user_global':user_global_ns, |
|
952 | 'user_global':user_global_ns, | |
953 | 'internal':self.internal_ns, |
|
953 | 'internal':self.internal_ns, | |
954 | 'builtin':builtin_mod.__dict__ |
|
954 | 'builtin':builtin_mod.__dict__ | |
955 | } |
|
955 | } | |
956 |
|
956 | |||
957 | # Similarly, track all namespaces where references can be held and that |
|
957 | # Similarly, track all namespaces where references can be held and that | |
958 | # we can safely clear (so it can NOT include builtin). This one can be |
|
958 | # we can safely clear (so it can NOT include builtin). This one can be | |
959 | # a simple list. Note that the main execution namespaces, user_ns and |
|
959 | # a simple list. Note that the main execution namespaces, user_ns and | |
960 | # user_global_ns, can NOT be listed here, as clearing them blindly |
|
960 | # user_global_ns, can NOT be listed here, as clearing them blindly | |
961 | # causes errors in object __del__ methods. Instead, the reset() method |
|
961 | # causes errors in object __del__ methods. Instead, the reset() method | |
962 | # clears them manually and carefully. |
|
962 | # clears them manually and carefully. | |
963 | self.ns_refs_table = [ self.user_ns_hidden, |
|
963 | self.ns_refs_table = [ self.user_ns_hidden, | |
964 | self.internal_ns, self._main_ns_cache ] |
|
964 | self.internal_ns, self._main_ns_cache ] | |
965 |
|
965 | |||
966 | def make_user_namespaces(self, user_ns=None, user_global_ns=None): |
|
966 | def make_user_namespaces(self, user_ns=None, user_global_ns=None): | |
967 | """Return a valid local and global user interactive namespaces. |
|
967 | """Return a valid local and global user interactive namespaces. | |
968 |
|
968 | |||
969 | This builds a dict with the minimal information needed to operate as a |
|
969 | This builds a dict with the minimal information needed to operate as a | |
970 | valid IPython user namespace, which you can pass to the various |
|
970 | valid IPython user namespace, which you can pass to the various | |
971 | embedding classes in ipython. The default implementation returns the |
|
971 | embedding classes in ipython. The default implementation returns the | |
972 | same dict for both the locals and the globals to allow functions to |
|
972 | same dict for both the locals and the globals to allow functions to | |
973 | refer to variables in the namespace. Customized implementations can |
|
973 | refer to variables in the namespace. Customized implementations can | |
974 | return different dicts. The locals dictionary can actually be anything |
|
974 | return different dicts. The locals dictionary can actually be anything | |
975 | following the basic mapping protocol of a dict, but the globals dict |
|
975 | following the basic mapping protocol of a dict, but the globals dict | |
976 | must be a true dict, not even a subclass. It is recommended that any |
|
976 | must be a true dict, not even a subclass. It is recommended that any | |
977 | custom object for the locals namespace synchronize with the globals |
|
977 | custom object for the locals namespace synchronize with the globals | |
978 | dict somehow. |
|
978 | dict somehow. | |
979 |
|
979 | |||
980 | Raises TypeError if the provided globals namespace is not a true dict. |
|
980 | Raises TypeError if the provided globals namespace is not a true dict. | |
981 |
|
981 | |||
982 | Parameters |
|
982 | Parameters | |
983 | ---------- |
|
983 | ---------- | |
984 | user_ns : dict-like, optional |
|
984 | user_ns : dict-like, optional | |
985 | The current user namespace. The items in this namespace should |
|
985 | The current user namespace. The items in this namespace should | |
986 | be included in the output. If None, an appropriate blank |
|
986 | be included in the output. If None, an appropriate blank | |
987 | namespace should be created. |
|
987 | namespace should be created. | |
988 | user_global_ns : dict, optional |
|
988 | user_global_ns : dict, optional | |
989 | The current user global namespace. The items in this namespace |
|
989 | The current user global namespace. The items in this namespace | |
990 | should be included in the output. If None, an appropriate |
|
990 | should be included in the output. If None, an appropriate | |
991 | blank namespace should be created. |
|
991 | blank namespace should be created. | |
992 |
|
992 | |||
993 | Returns |
|
993 | Returns | |
994 | ------- |
|
994 | ------- | |
995 | A pair of dictionary-like object to be used as the local namespace |
|
995 | A pair of dictionary-like object to be used as the local namespace | |
996 | of the interpreter and a dict to be used as the global namespace. |
|
996 | of the interpreter and a dict to be used as the global namespace. | |
997 | """ |
|
997 | """ | |
998 |
|
998 | |||
999 |
|
999 | |||
1000 | # We must ensure that __builtin__ (without the final 's') is always |
|
1000 | # We must ensure that __builtin__ (without the final 's') is always | |
1001 | # available and pointing to the __builtin__ *module*. For more details: |
|
1001 | # available and pointing to the __builtin__ *module*. For more details: | |
1002 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1002 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1003 |
|
1003 | |||
1004 | if user_ns is None: |
|
1004 | if user_ns is None: | |
1005 | # Set __name__ to __main__ to better match the behavior of the |
|
1005 | # Set __name__ to __main__ to better match the behavior of the | |
1006 | # normal interpreter. |
|
1006 | # normal interpreter. | |
1007 | user_ns = {'__name__' :'__main__', |
|
1007 | user_ns = {'__name__' :'__main__', | |
1008 | py3compat.builtin_mod_name: builtin_mod, |
|
1008 | py3compat.builtin_mod_name: builtin_mod, | |
1009 | '__builtins__' : builtin_mod, |
|
1009 | '__builtins__' : builtin_mod, | |
1010 | } |
|
1010 | } | |
1011 | else: |
|
1011 | else: | |
1012 | user_ns.setdefault('__name__','__main__') |
|
1012 | user_ns.setdefault('__name__','__main__') | |
1013 | user_ns.setdefault(py3compat.builtin_mod_name,builtin_mod) |
|
1013 | user_ns.setdefault(py3compat.builtin_mod_name,builtin_mod) | |
1014 | user_ns.setdefault('__builtins__',builtin_mod) |
|
1014 | user_ns.setdefault('__builtins__',builtin_mod) | |
1015 |
|
1015 | |||
1016 | if user_global_ns is None: |
|
1016 | if user_global_ns is None: | |
1017 | user_global_ns = user_ns |
|
1017 | user_global_ns = user_ns | |
1018 | if type(user_global_ns) is not dict: |
|
1018 | if type(user_global_ns) is not dict: | |
1019 | raise TypeError("user_global_ns must be a true dict; got %r" |
|
1019 | raise TypeError("user_global_ns must be a true dict; got %r" | |
1020 | % type(user_global_ns)) |
|
1020 | % type(user_global_ns)) | |
1021 |
|
1021 | |||
1022 | return user_ns, user_global_ns |
|
1022 | return user_ns, user_global_ns | |
1023 |
|
1023 | |||
1024 | def init_sys_modules(self): |
|
1024 | def init_sys_modules(self): | |
1025 | # We need to insert into sys.modules something that looks like a |
|
1025 | # We need to insert into sys.modules something that looks like a | |
1026 | # module but which accesses the IPython namespace, for shelve and |
|
1026 | # module but which accesses the IPython namespace, for shelve and | |
1027 | # pickle to work interactively. Normally they rely on getting |
|
1027 | # pickle to work interactively. Normally they rely on getting | |
1028 | # everything out of __main__, but for embedding purposes each IPython |
|
1028 | # everything out of __main__, but for embedding purposes each IPython | |
1029 | # instance has its own private namespace, so we can't go shoving |
|
1029 | # instance has its own private namespace, so we can't go shoving | |
1030 | # everything into __main__. |
|
1030 | # everything into __main__. | |
1031 |
|
1031 | |||
1032 | # note, however, that we should only do this for non-embedded |
|
1032 | # note, however, that we should only do this for non-embedded | |
1033 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1033 | # ipythons, which really mimic the __main__.__dict__ with their own | |
1034 | # namespace. Embedded instances, on the other hand, should not do |
|
1034 | # namespace. Embedded instances, on the other hand, should not do | |
1035 | # this because they need to manage the user local/global namespaces |
|
1035 | # this because they need to manage the user local/global namespaces | |
1036 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1036 | # only, but they live within a 'normal' __main__ (meaning, they | |
1037 | # shouldn't overtake the execution environment of the script they're |
|
1037 | # shouldn't overtake the execution environment of the script they're | |
1038 | # embedded in). |
|
1038 | # embedded in). | |
1039 |
|
1039 | |||
1040 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1040 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
1041 |
|
1041 | |||
1042 | try: |
|
1042 | try: | |
1043 | main_name = self.user_ns['__name__'] |
|
1043 | main_name = self.user_ns['__name__'] | |
1044 | except KeyError: |
|
1044 | except KeyError: | |
1045 | raise KeyError('user_ns dictionary MUST have a "__name__" key') |
|
1045 | raise KeyError('user_ns dictionary MUST have a "__name__" key') | |
1046 | else: |
|
1046 | else: | |
1047 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
1047 | sys.modules[main_name] = FakeModule(self.user_ns) | |
1048 |
|
1048 | |||
1049 | def init_user_ns(self): |
|
1049 | def init_user_ns(self): | |
1050 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1050 | """Initialize all user-visible namespaces to their minimum defaults. | |
1051 |
|
1051 | |||
1052 | Certain history lists are also initialized here, as they effectively |
|
1052 | Certain history lists are also initialized here, as they effectively | |
1053 | act as user namespaces. |
|
1053 | act as user namespaces. | |
1054 |
|
1054 | |||
1055 | Notes |
|
1055 | Notes | |
1056 | ----- |
|
1056 | ----- | |
1057 | All data structures here are only filled in, they are NOT reset by this |
|
1057 | All data structures here are only filled in, they are NOT reset by this | |
1058 | method. If they were not empty before, data will simply be added to |
|
1058 | method. If they were not empty before, data will simply be added to | |
1059 | therm. |
|
1059 | therm. | |
1060 | """ |
|
1060 | """ | |
1061 | # This function works in two parts: first we put a few things in |
|
1061 | # This function works in two parts: first we put a few things in | |
1062 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1062 | # user_ns, and we sync that contents into user_ns_hidden so that these | |
1063 | # initial variables aren't shown by %who. After the sync, we add the |
|
1063 | # initial variables aren't shown by %who. After the sync, we add the | |
1064 | # rest of what we *do* want the user to see with %who even on a new |
|
1064 | # rest of what we *do* want the user to see with %who even on a new | |
1065 | # session (probably nothing, so theye really only see their own stuff) |
|
1065 | # session (probably nothing, so theye really only see their own stuff) | |
1066 |
|
1066 | |||
1067 | # The user dict must *always* have a __builtin__ reference to the |
|
1067 | # The user dict must *always* have a __builtin__ reference to the | |
1068 | # Python standard __builtin__ namespace, which must be imported. |
|
1068 | # Python standard __builtin__ namespace, which must be imported. | |
1069 | # This is so that certain operations in prompt evaluation can be |
|
1069 | # This is so that certain operations in prompt evaluation can be | |
1070 | # reliably executed with builtins. Note that we can NOT use |
|
1070 | # reliably executed with builtins. Note that we can NOT use | |
1071 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1071 | # __builtins__ (note the 's'), because that can either be a dict or a | |
1072 | # module, and can even mutate at runtime, depending on the context |
|
1072 | # module, and can even mutate at runtime, depending on the context | |
1073 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1073 | # (Python makes no guarantees on it). In contrast, __builtin__ is | |
1074 | # always a module object, though it must be explicitly imported. |
|
1074 | # always a module object, though it must be explicitly imported. | |
1075 |
|
1075 | |||
1076 | # For more details: |
|
1076 | # For more details: | |
1077 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1077 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1078 | ns = dict(__builtin__ = builtin_mod) |
|
1078 | ns = dict(__builtin__ = builtin_mod) | |
1079 |
|
1079 | |||
1080 | # Put 'help' in the user namespace |
|
1080 | # Put 'help' in the user namespace | |
1081 | try: |
|
1081 | try: | |
1082 | from site import _Helper |
|
1082 | from site import _Helper | |
1083 | ns['help'] = _Helper() |
|
1083 | ns['help'] = _Helper() | |
1084 | except ImportError: |
|
1084 | except ImportError: | |
1085 | warn('help() not available - check site.py') |
|
1085 | warn('help() not available - check site.py') | |
1086 |
|
1086 | |||
1087 | # make global variables for user access to the histories |
|
1087 | # make global variables for user access to the histories | |
1088 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1088 | ns['_ih'] = self.history_manager.input_hist_parsed | |
1089 | ns['_oh'] = self.history_manager.output_hist |
|
1089 | ns['_oh'] = self.history_manager.output_hist | |
1090 | ns['_dh'] = self.history_manager.dir_hist |
|
1090 | ns['_dh'] = self.history_manager.dir_hist | |
1091 |
|
1091 | |||
1092 | ns['_sh'] = shadowns |
|
1092 | ns['_sh'] = shadowns | |
1093 |
|
1093 | |||
1094 | # user aliases to input and output histories. These shouldn't show up |
|
1094 | # user aliases to input and output histories. These shouldn't show up | |
1095 | # in %who, as they can have very large reprs. |
|
1095 | # in %who, as they can have very large reprs. | |
1096 | ns['In'] = self.history_manager.input_hist_parsed |
|
1096 | ns['In'] = self.history_manager.input_hist_parsed | |
1097 | ns['Out'] = self.history_manager.output_hist |
|
1097 | ns['Out'] = self.history_manager.output_hist | |
1098 |
|
1098 | |||
1099 | # Store myself as the public api!!! |
|
1099 | # Store myself as the public api!!! | |
1100 | ns['get_ipython'] = self.get_ipython |
|
1100 | ns['get_ipython'] = self.get_ipython | |
1101 |
|
1101 | |||
1102 | ns['exit'] = self.exiter |
|
1102 | ns['exit'] = self.exiter | |
1103 | ns['quit'] = self.exiter |
|
1103 | ns['quit'] = self.exiter | |
1104 |
|
1104 | |||
1105 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1105 | # Sync what we've added so far to user_ns_hidden so these aren't seen | |
1106 | # by %who |
|
1106 | # by %who | |
1107 | self.user_ns_hidden.update(ns) |
|
1107 | self.user_ns_hidden.update(ns) | |
1108 |
|
1108 | |||
1109 | # Anything put into ns now would show up in %who. Think twice before |
|
1109 | # Anything put into ns now would show up in %who. Think twice before | |
1110 | # putting anything here, as we really want %who to show the user their |
|
1110 | # putting anything here, as we really want %who to show the user their | |
1111 | # stuff, not our variables. |
|
1111 | # stuff, not our variables. | |
1112 |
|
1112 | |||
1113 | # Finally, update the real user's namespace |
|
1113 | # Finally, update the real user's namespace | |
1114 | self.user_ns.update(ns) |
|
1114 | self.user_ns.update(ns) | |
1115 |
|
1115 | |||
1116 | def reset(self, new_session=True): |
|
1116 | def reset(self, new_session=True): | |
1117 | """Clear all internal namespaces, and attempt to release references to |
|
1117 | """Clear all internal namespaces, and attempt to release references to | |
1118 | user objects. |
|
1118 | user objects. | |
1119 |
|
1119 | |||
1120 | If new_session is True, a new history session will be opened. |
|
1120 | If new_session is True, a new history session will be opened. | |
1121 | """ |
|
1121 | """ | |
1122 | # Clear histories |
|
1122 | # Clear histories | |
1123 | self.history_manager.reset(new_session) |
|
1123 | self.history_manager.reset(new_session) | |
1124 | # Reset counter used to index all histories |
|
1124 | # Reset counter used to index all histories | |
1125 | if new_session: |
|
1125 | if new_session: | |
1126 | self.execution_count = 1 |
|
1126 | self.execution_count = 1 | |
1127 |
|
1127 | |||
1128 | # Flush cached output items |
|
1128 | # Flush cached output items | |
1129 | if self.displayhook.do_full_cache: |
|
1129 | if self.displayhook.do_full_cache: | |
1130 | self.displayhook.flush() |
|
1130 | self.displayhook.flush() | |
1131 |
|
1131 | |||
1132 | # Restore the user namespaces to minimal usability |
|
1132 | # Restore the user namespaces to minimal usability | |
1133 | for ns in self.ns_refs_table: |
|
1133 | for ns in self.ns_refs_table: | |
1134 | ns.clear() |
|
1134 | ns.clear() | |
1135 |
|
1135 | |||
1136 | # The main execution namespaces must be cleared very carefully, |
|
1136 | # The main execution namespaces must be cleared very carefully, | |
1137 | # skipping the deletion of the builtin-related keys, because doing so |
|
1137 | # skipping the deletion of the builtin-related keys, because doing so | |
1138 | # would cause errors in many object's __del__ methods. |
|
1138 | # would cause errors in many object's __del__ methods. | |
1139 | for ns in [self.user_ns, self.user_global_ns]: |
|
1139 | for ns in [self.user_ns, self.user_global_ns]: | |
1140 | drop_keys = set(ns.keys()) |
|
1140 | drop_keys = set(ns.keys()) | |
1141 | drop_keys.discard('__builtin__') |
|
1141 | drop_keys.discard('__builtin__') | |
1142 | drop_keys.discard('__builtins__') |
|
1142 | drop_keys.discard('__builtins__') | |
1143 | for k in drop_keys: |
|
1143 | for k in drop_keys: | |
1144 | del ns[k] |
|
1144 | del ns[k] | |
1145 |
|
1145 | |||
1146 | # Restore the user namespaces to minimal usability |
|
1146 | # Restore the user namespaces to minimal usability | |
1147 | self.init_user_ns() |
|
1147 | self.init_user_ns() | |
1148 |
|
1148 | |||
1149 | # Restore the default and user aliases |
|
1149 | # Restore the default and user aliases | |
1150 | self.alias_manager.clear_aliases() |
|
1150 | self.alias_manager.clear_aliases() | |
1151 | self.alias_manager.init_aliases() |
|
1151 | self.alias_manager.init_aliases() | |
1152 |
|
1152 | |||
1153 | # Flush the private list of module references kept for script |
|
1153 | # Flush the private list of module references kept for script | |
1154 | # execution protection |
|
1154 | # execution protection | |
1155 | self.clear_main_mod_cache() |
|
1155 | self.clear_main_mod_cache() | |
1156 |
|
1156 | |||
1157 | # Clear out the namespace from the last %run |
|
1157 | # Clear out the namespace from the last %run | |
1158 | self.new_main_mod() |
|
1158 | self.new_main_mod() | |
1159 |
|
1159 | |||
1160 | def del_var(self, varname, by_name=False): |
|
1160 | def del_var(self, varname, by_name=False): | |
1161 | """Delete a variable from the various namespaces, so that, as |
|
1161 | """Delete a variable from the various namespaces, so that, as | |
1162 | far as possible, we're not keeping any hidden references to it. |
|
1162 | far as possible, we're not keeping any hidden references to it. | |
1163 |
|
1163 | |||
1164 | Parameters |
|
1164 | Parameters | |
1165 | ---------- |
|
1165 | ---------- | |
1166 | varname : str |
|
1166 | varname : str | |
1167 | The name of the variable to delete. |
|
1167 | The name of the variable to delete. | |
1168 | by_name : bool |
|
1168 | by_name : bool | |
1169 | If True, delete variables with the given name in each |
|
1169 | If True, delete variables with the given name in each | |
1170 | namespace. If False (default), find the variable in the user |
|
1170 | namespace. If False (default), find the variable in the user | |
1171 | namespace, and delete references to it. |
|
1171 | namespace, and delete references to it. | |
1172 | """ |
|
1172 | """ | |
1173 | if varname in ('__builtin__', '__builtins__'): |
|
1173 | if varname in ('__builtin__', '__builtins__'): | |
1174 | raise ValueError("Refusing to delete %s" % varname) |
|
1174 | raise ValueError("Refusing to delete %s" % varname) | |
1175 | ns_refs = self.ns_refs_table + [self.user_ns, |
|
1175 | ns_refs = self.ns_refs_table + [self.user_ns, | |
1176 | self.user_global_ns, self._user_main_module.__dict__] +\ |
|
1176 | self.user_global_ns, self._user_main_module.__dict__] +\ | |
1177 | self._main_ns_cache.values() |
|
1177 | self._main_ns_cache.values() | |
1178 |
|
1178 | |||
1179 | if by_name: # Delete by name |
|
1179 | if by_name: # Delete by name | |
1180 | for ns in ns_refs: |
|
1180 | for ns in ns_refs: | |
1181 | try: |
|
1181 | try: | |
1182 | del ns[varname] |
|
1182 | del ns[varname] | |
1183 | except KeyError: |
|
1183 | except KeyError: | |
1184 | pass |
|
1184 | pass | |
1185 | else: # Delete by object |
|
1185 | else: # Delete by object | |
1186 | try: |
|
1186 | try: | |
1187 | obj = self.user_ns[varname] |
|
1187 | obj = self.user_ns[varname] | |
1188 | except KeyError: |
|
1188 | except KeyError: | |
1189 | raise NameError("name '%s' is not defined" % varname) |
|
1189 | raise NameError("name '%s' is not defined" % varname) | |
1190 | # Also check in output history |
|
1190 | # Also check in output history | |
1191 | ns_refs.append(self.history_manager.output_hist) |
|
1191 | ns_refs.append(self.history_manager.output_hist) | |
1192 | for ns in ns_refs: |
|
1192 | for ns in ns_refs: | |
1193 | to_delete = [n for n, o in ns.iteritems() if o is obj] |
|
1193 | to_delete = [n for n, o in ns.iteritems() if o is obj] | |
1194 | for name in to_delete: |
|
1194 | for name in to_delete: | |
1195 | del ns[name] |
|
1195 | del ns[name] | |
1196 |
|
1196 | |||
1197 | # displayhook keeps extra references, but not in a dictionary |
|
1197 | # displayhook keeps extra references, but not in a dictionary | |
1198 | for name in ('_', '__', '___'): |
|
1198 | for name in ('_', '__', '___'): | |
1199 | if getattr(self.displayhook, name) is obj: |
|
1199 | if getattr(self.displayhook, name) is obj: | |
1200 | setattr(self.displayhook, name, None) |
|
1200 | setattr(self.displayhook, name, None) | |
1201 |
|
1201 | |||
1202 | def reset_selective(self, regex=None): |
|
1202 | def reset_selective(self, regex=None): | |
1203 | """Clear selective variables from internal namespaces based on a |
|
1203 | """Clear selective variables from internal namespaces based on a | |
1204 | specified regular expression. |
|
1204 | specified regular expression. | |
1205 |
|
1205 | |||
1206 | Parameters |
|
1206 | Parameters | |
1207 | ---------- |
|
1207 | ---------- | |
1208 | regex : string or compiled pattern, optional |
|
1208 | regex : string or compiled pattern, optional | |
1209 | A regular expression pattern that will be used in searching |
|
1209 | A regular expression pattern that will be used in searching | |
1210 | variable names in the users namespaces. |
|
1210 | variable names in the users namespaces. | |
1211 | """ |
|
1211 | """ | |
1212 | if regex is not None: |
|
1212 | if regex is not None: | |
1213 | try: |
|
1213 | try: | |
1214 | m = re.compile(regex) |
|
1214 | m = re.compile(regex) | |
1215 | except TypeError: |
|
1215 | except TypeError: | |
1216 | raise TypeError('regex must be a string or compiled pattern') |
|
1216 | raise TypeError('regex must be a string or compiled pattern') | |
1217 | # Search for keys in each namespace that match the given regex |
|
1217 | # Search for keys in each namespace that match the given regex | |
1218 | # If a match is found, delete the key/value pair. |
|
1218 | # If a match is found, delete the key/value pair. | |
1219 | for ns in self.ns_refs_table: |
|
1219 | for ns in self.ns_refs_table: | |
1220 | for var in ns: |
|
1220 | for var in ns: | |
1221 | if m.search(var): |
|
1221 | if m.search(var): | |
1222 | del ns[var] |
|
1222 | del ns[var] | |
1223 |
|
1223 | |||
1224 | def push(self, variables, interactive=True): |
|
1224 | def push(self, variables, interactive=True): | |
1225 | """Inject a group of variables into the IPython user namespace. |
|
1225 | """Inject a group of variables into the IPython user namespace. | |
1226 |
|
1226 | |||
1227 | Parameters |
|
1227 | Parameters | |
1228 | ---------- |
|
1228 | ---------- | |
1229 | variables : dict, str or list/tuple of str |
|
1229 | variables : dict, str or list/tuple of str | |
1230 | The variables to inject into the user's namespace. If a dict, a |
|
1230 | The variables to inject into the user's namespace. If a dict, a | |
1231 | simple update is done. If a str, the string is assumed to have |
|
1231 | simple update is done. If a str, the string is assumed to have | |
1232 | variable names separated by spaces. A list/tuple of str can also |
|
1232 | variable names separated by spaces. A list/tuple of str can also | |
1233 | be used to give the variable names. If just the variable names are |
|
1233 | be used to give the variable names. If just the variable names are | |
1234 | give (list/tuple/str) then the variable values looked up in the |
|
1234 | give (list/tuple/str) then the variable values looked up in the | |
1235 | callers frame. |
|
1235 | callers frame. | |
1236 | interactive : bool |
|
1236 | interactive : bool | |
1237 | If True (default), the variables will be listed with the ``who`` |
|
1237 | If True (default), the variables will be listed with the ``who`` | |
1238 | magic. |
|
1238 | magic. | |
1239 | """ |
|
1239 | """ | |
1240 | vdict = None |
|
1240 | vdict = None | |
1241 |
|
1241 | |||
1242 | # We need a dict of name/value pairs to do namespace updates. |
|
1242 | # We need a dict of name/value pairs to do namespace updates. | |
1243 | if isinstance(variables, dict): |
|
1243 | if isinstance(variables, dict): | |
1244 | vdict = variables |
|
1244 | vdict = variables | |
1245 | elif isinstance(variables, (basestring, list, tuple)): |
|
1245 | elif isinstance(variables, (basestring, list, tuple)): | |
1246 | if isinstance(variables, basestring): |
|
1246 | if isinstance(variables, basestring): | |
1247 | vlist = variables.split() |
|
1247 | vlist = variables.split() | |
1248 | else: |
|
1248 | else: | |
1249 | vlist = variables |
|
1249 | vlist = variables | |
1250 | vdict = {} |
|
1250 | vdict = {} | |
1251 | cf = sys._getframe(1) |
|
1251 | cf = sys._getframe(1) | |
1252 | for name in vlist: |
|
1252 | for name in vlist: | |
1253 | try: |
|
1253 | try: | |
1254 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1254 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) | |
1255 | except: |
|
1255 | except: | |
1256 | print ('Could not get variable %s from %s' % |
|
1256 | print ('Could not get variable %s from %s' % | |
1257 | (name,cf.f_code.co_name)) |
|
1257 | (name,cf.f_code.co_name)) | |
1258 | else: |
|
1258 | else: | |
1259 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1259 | raise ValueError('variables must be a dict/str/list/tuple') | |
1260 |
|
1260 | |||
1261 | # Propagate variables to user namespace |
|
1261 | # Propagate variables to user namespace | |
1262 | self.user_ns.update(vdict) |
|
1262 | self.user_ns.update(vdict) | |
1263 |
|
1263 | |||
1264 | # And configure interactive visibility |
|
1264 | # And configure interactive visibility | |
1265 | config_ns = self.user_ns_hidden |
|
1265 | config_ns = self.user_ns_hidden | |
1266 | if interactive: |
|
1266 | if interactive: | |
1267 | for name, val in vdict.iteritems(): |
|
1267 | for name, val in vdict.iteritems(): | |
1268 | config_ns.pop(name, None) |
|
1268 | config_ns.pop(name, None) | |
1269 | else: |
|
1269 | else: | |
1270 | for name,val in vdict.iteritems(): |
|
1270 | for name,val in vdict.iteritems(): | |
1271 | config_ns[name] = val |
|
1271 | config_ns[name] = val | |
1272 |
|
1272 | |||
1273 | def drop_by_id(self, variables): |
|
1273 | def drop_by_id(self, variables): | |
1274 | """Remove a dict of variables from the user namespace, if they are the |
|
1274 | """Remove a dict of variables from the user namespace, if they are the | |
1275 | same as the values in the dictionary. |
|
1275 | same as the values in the dictionary. | |
1276 |
|
1276 | |||
1277 | This is intended for use by extensions: variables that they've added can |
|
1277 | 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 |
|
1278 | be taken back out if they are unloaded, without removing any that the | |
1279 | user has overwritten. |
|
1279 | user has overwritten. | |
1280 |
|
1280 | |||
1281 | Parameters |
|
1281 | Parameters | |
1282 | ---------- |
|
1282 | ---------- | |
1283 | variables : dict |
|
1283 | variables : dict | |
1284 | A dictionary mapping object names (as strings) to the objects. |
|
1284 | A dictionary mapping object names (as strings) to the objects. | |
1285 | """ |
|
1285 | """ | |
1286 | for name, obj in variables.iteritems(): |
|
1286 | for name, obj in variables.iteritems(): | |
1287 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1287 | if name in self.user_ns and self.user_ns[name] is obj: | |
1288 | del self.user_ns[name] |
|
1288 | del self.user_ns[name] | |
1289 | self.user_ns_hidden.pop(name, None) |
|
1289 | self.user_ns_hidden.pop(name, None) | |
1290 |
|
1290 | |||
1291 | #------------------------------------------------------------------------- |
|
1291 | #------------------------------------------------------------------------- | |
1292 | # Things related to object introspection |
|
1292 | # Things related to object introspection | |
1293 | #------------------------------------------------------------------------- |
|
1293 | #------------------------------------------------------------------------- | |
1294 |
|
1294 | |||
1295 | def _ofind(self, oname, namespaces=None): |
|
1295 | def _ofind(self, oname, namespaces=None): | |
1296 | """Find an object in the available namespaces. |
|
1296 | """Find an object in the available namespaces. | |
1297 |
|
1297 | |||
1298 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1298 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic | |
1299 |
|
1299 | |||
1300 | Has special code to detect magic functions. |
|
1300 | Has special code to detect magic functions. | |
1301 | """ |
|
1301 | """ | |
1302 | oname = oname.strip() |
|
1302 | oname = oname.strip() | |
1303 | #print '1- oname: <%r>' % oname # dbg |
|
1303 | #print '1- oname: <%r>' % oname # dbg | |
1304 | if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True): |
|
1304 | if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True): | |
1305 | return dict(found=False) |
|
1305 | return dict(found=False) | |
1306 |
|
1306 | |||
1307 | alias_ns = None |
|
1307 | alias_ns = None | |
1308 | if namespaces is None: |
|
1308 | if namespaces is None: | |
1309 | # Namespaces to search in: |
|
1309 | # Namespaces to search in: | |
1310 | # Put them in a list. The order is important so that we |
|
1310 | # Put them in a list. The order is important so that we | |
1311 | # find things in the same order that Python finds them. |
|
1311 | # find things in the same order that Python finds them. | |
1312 | namespaces = [ ('Interactive', self.user_ns), |
|
1312 | namespaces = [ ('Interactive', self.user_ns), | |
1313 | ('IPython internal', self.internal_ns), |
|
1313 | ('IPython internal', self.internal_ns), | |
1314 | ('Python builtin', builtin_mod.__dict__), |
|
1314 | ('Python builtin', builtin_mod.__dict__), | |
1315 | ('Alias', self.alias_manager.alias_table), |
|
1315 | ('Alias', self.alias_manager.alias_table), | |
1316 | ] |
|
1316 | ] | |
1317 | alias_ns = self.alias_manager.alias_table |
|
1317 | alias_ns = self.alias_manager.alias_table | |
1318 |
|
1318 | |||
1319 | # initialize results to 'null' |
|
1319 | # initialize results to 'null' | |
1320 | found = False; obj = None; ospace = None; ds = None; |
|
1320 | found = False; obj = None; ospace = None; ds = None; | |
1321 | ismagic = False; isalias = False; parent = None |
|
1321 | ismagic = False; isalias = False; parent = None | |
1322 |
|
1322 | |||
1323 | # We need to special-case 'print', which as of python2.6 registers as a |
|
1323 | # 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 |
|
1324 | # function but should only be treated as one if print_function was | |
1325 | # loaded with a future import. In this case, just bail. |
|
1325 | # loaded with a future import. In this case, just bail. | |
1326 | if (oname == 'print' and not py3compat.PY3 and not \ |
|
1326 | if (oname == 'print' and not py3compat.PY3 and not \ | |
1327 | (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)): |
|
1327 | (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)): | |
1328 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1328 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1329 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1329 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1330 |
|
1330 | |||
1331 | # Look for the given name by splitting it in parts. If the head is |
|
1331 | # 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 |
|
1332 | # found, then we look for all the remaining parts as members, and only | |
1333 | # declare success if we can find them all. |
|
1333 | # declare success if we can find them all. | |
1334 | oname_parts = oname.split('.') |
|
1334 | oname_parts = oname.split('.') | |
1335 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1335 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] | |
1336 | for nsname,ns in namespaces: |
|
1336 | for nsname,ns in namespaces: | |
1337 | try: |
|
1337 | try: | |
1338 | obj = ns[oname_head] |
|
1338 | obj = ns[oname_head] | |
1339 | except KeyError: |
|
1339 | except KeyError: | |
1340 | continue |
|
1340 | continue | |
1341 | else: |
|
1341 | else: | |
1342 | #print 'oname_rest:', oname_rest # dbg |
|
1342 | #print 'oname_rest:', oname_rest # dbg | |
1343 | for part in oname_rest: |
|
1343 | for part in oname_rest: | |
1344 | try: |
|
1344 | try: | |
1345 | parent = obj |
|
1345 | parent = obj | |
1346 | obj = getattr(obj,part) |
|
1346 | obj = getattr(obj,part) | |
1347 | except: |
|
1347 | except: | |
1348 | # Blanket except b/c some badly implemented objects |
|
1348 | # Blanket except b/c some badly implemented objects | |
1349 | # allow __getattr__ to raise exceptions other than |
|
1349 | # allow __getattr__ to raise exceptions other than | |
1350 | # AttributeError, which then crashes IPython. |
|
1350 | # AttributeError, which then crashes IPython. | |
1351 | break |
|
1351 | break | |
1352 | else: |
|
1352 | else: | |
1353 | # If we finish the for loop (no break), we got all members |
|
1353 | # If we finish the for loop (no break), we got all members | |
1354 | found = True |
|
1354 | found = True | |
1355 | ospace = nsname |
|
1355 | ospace = nsname | |
1356 | if ns == alias_ns: |
|
1356 | if ns == alias_ns: | |
1357 | isalias = True |
|
1357 | isalias = True | |
1358 | break # namespace loop |
|
1358 | break # namespace loop | |
1359 |
|
1359 | |||
1360 | # Try to see if it's magic |
|
1360 | # Try to see if it's magic | |
1361 | if not found: |
|
1361 | if not found: | |
1362 | if oname.startswith(ESC_MAGIC): |
|
1362 | if oname.startswith(ESC_MAGIC): | |
1363 | oname = oname[1:] |
|
1363 | oname = oname[1:] | |
1364 | obj = getattr(self,'magic_'+oname,None) |
|
1364 | obj = getattr(self,'magic_'+oname,None) | |
1365 | if obj is not None: |
|
1365 | if obj is not None: | |
1366 | found = True |
|
1366 | found = True | |
1367 | ospace = 'IPython internal' |
|
1367 | ospace = 'IPython internal' | |
1368 | ismagic = True |
|
1368 | ismagic = True | |
1369 |
|
1369 | |||
1370 | # Last try: special-case some literals like '', [], {}, etc: |
|
1370 | # Last try: special-case some literals like '', [], {}, etc: | |
1371 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1371 | if not found and oname_head in ["''",'""','[]','{}','()']: | |
1372 | obj = eval(oname_head) |
|
1372 | obj = eval(oname_head) | |
1373 | found = True |
|
1373 | found = True | |
1374 | ospace = 'Interactive' |
|
1374 | ospace = 'Interactive' | |
1375 |
|
1375 | |||
1376 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1376 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1377 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1377 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1378 |
|
1378 | |||
1379 | def _ofind_property(self, oname, info): |
|
1379 | def _ofind_property(self, oname, info): | |
1380 | """Second part of object finding, to look for property details.""" |
|
1380 | """Second part of object finding, to look for property details.""" | |
1381 | if info.found: |
|
1381 | if info.found: | |
1382 | # Get the docstring of the class property if it exists. |
|
1382 | # Get the docstring of the class property if it exists. | |
1383 | path = oname.split('.') |
|
1383 | path = oname.split('.') | |
1384 | root = '.'.join(path[:-1]) |
|
1384 | root = '.'.join(path[:-1]) | |
1385 | if info.parent is not None: |
|
1385 | if info.parent is not None: | |
1386 | try: |
|
1386 | try: | |
1387 | target = getattr(info.parent, '__class__') |
|
1387 | target = getattr(info.parent, '__class__') | |
1388 | # The object belongs to a class instance. |
|
1388 | # The object belongs to a class instance. | |
1389 | try: |
|
1389 | try: | |
1390 | target = getattr(target, path[-1]) |
|
1390 | target = getattr(target, path[-1]) | |
1391 | # The class defines the object. |
|
1391 | # The class defines the object. | |
1392 | if isinstance(target, property): |
|
1392 | if isinstance(target, property): | |
1393 | oname = root + '.__class__.' + path[-1] |
|
1393 | oname = root + '.__class__.' + path[-1] | |
1394 | info = Struct(self._ofind(oname)) |
|
1394 | info = Struct(self._ofind(oname)) | |
1395 | except AttributeError: pass |
|
1395 | except AttributeError: pass | |
1396 | except AttributeError: pass |
|
1396 | except AttributeError: pass | |
1397 |
|
1397 | |||
1398 | # We return either the new info or the unmodified input if the object |
|
1398 | # We return either the new info or the unmodified input if the object | |
1399 | # hadn't been found |
|
1399 | # hadn't been found | |
1400 | return info |
|
1400 | return info | |
1401 |
|
1401 | |||
1402 | def _object_find(self, oname, namespaces=None): |
|
1402 | def _object_find(self, oname, namespaces=None): | |
1403 | """Find an object and return a struct with info about it.""" |
|
1403 | """Find an object and return a struct with info about it.""" | |
1404 | inf = Struct(self._ofind(oname, namespaces)) |
|
1404 | inf = Struct(self._ofind(oname, namespaces)) | |
1405 | return Struct(self._ofind_property(oname, inf)) |
|
1405 | return Struct(self._ofind_property(oname, inf)) | |
1406 |
|
1406 | |||
1407 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1407 | def _inspect(self, meth, oname, namespaces=None, **kw): | |
1408 | """Generic interface to the inspector system. |
|
1408 | """Generic interface to the inspector system. | |
1409 |
|
1409 | |||
1410 | This function is meant to be called by pdef, pdoc & friends.""" |
|
1410 | This function is meant to be called by pdef, pdoc & friends.""" | |
1411 | info = self._object_find(oname) |
|
1411 | info = self._object_find(oname) | |
1412 | if info.found: |
|
1412 | if info.found: | |
1413 | pmethod = getattr(self.inspector, meth) |
|
1413 | pmethod = getattr(self.inspector, meth) | |
1414 | formatter = format_screen if info.ismagic else None |
|
1414 | formatter = format_screen if info.ismagic else None | |
1415 | if meth == 'pdoc': |
|
1415 | if meth == 'pdoc': | |
1416 | pmethod(info.obj, oname, formatter) |
|
1416 | pmethod(info.obj, oname, formatter) | |
1417 | elif meth == 'pinfo': |
|
1417 | elif meth == 'pinfo': | |
1418 | pmethod(info.obj, oname, formatter, info, **kw) |
|
1418 | pmethod(info.obj, oname, formatter, info, **kw) | |
1419 | else: |
|
1419 | else: | |
1420 | pmethod(info.obj, oname) |
|
1420 | pmethod(info.obj, oname) | |
1421 | else: |
|
1421 | else: | |
1422 | print 'Object `%s` not found.' % oname |
|
1422 | print 'Object `%s` not found.' % oname | |
1423 | return 'not found' # so callers can take other action |
|
1423 | return 'not found' # so callers can take other action | |
1424 |
|
1424 | |||
1425 | def object_inspect(self, oname): |
|
1425 | def object_inspect(self, oname): | |
1426 | with self.builtin_trap: |
|
1426 | with self.builtin_trap: | |
1427 | info = self._object_find(oname) |
|
1427 | info = self._object_find(oname) | |
1428 | if info.found: |
|
1428 | if info.found: | |
1429 | return self.inspector.info(info.obj, oname, info=info) |
|
1429 | return self.inspector.info(info.obj, oname, info=info) | |
1430 | else: |
|
1430 | else: | |
1431 | return oinspect.object_info(name=oname, found=False) |
|
1431 | return oinspect.object_info(name=oname, found=False) | |
1432 |
|
1432 | |||
1433 | #------------------------------------------------------------------------- |
|
1433 | #------------------------------------------------------------------------- | |
1434 | # Things related to history management |
|
1434 | # Things related to history management | |
1435 | #------------------------------------------------------------------------- |
|
1435 | #------------------------------------------------------------------------- | |
1436 |
|
1436 | |||
1437 | def init_history(self): |
|
1437 | def init_history(self): | |
1438 | """Sets up the command history, and starts regular autosaves.""" |
|
1438 | """Sets up the command history, and starts regular autosaves.""" | |
1439 | self.history_manager = HistoryManager(shell=self, config=self.config) |
|
1439 | self.history_manager = HistoryManager(shell=self, config=self.config) | |
1440 | self.configurables.append(self.history_manager) |
|
1440 | self.configurables.append(self.history_manager) | |
1441 |
|
1441 | |||
1442 | #------------------------------------------------------------------------- |
|
1442 | #------------------------------------------------------------------------- | |
1443 | # Things related to exception handling and tracebacks (not debugging) |
|
1443 | # Things related to exception handling and tracebacks (not debugging) | |
1444 | #------------------------------------------------------------------------- |
|
1444 | #------------------------------------------------------------------------- | |
1445 |
|
1445 | |||
1446 | def init_traceback_handlers(self, custom_exceptions): |
|
1446 | def init_traceback_handlers(self, custom_exceptions): | |
1447 | # Syntax error handler. |
|
1447 | # Syntax error handler. | |
1448 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') |
|
1448 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') | |
1449 |
|
1449 | |||
1450 | # The interactive one is initialized with an offset, meaning we always |
|
1450 | # 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 |
|
1451 | # want to remove the topmost item in the traceback, which is our own | |
1452 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1452 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
1453 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1453 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', | |
1454 | color_scheme='NoColor', |
|
1454 | color_scheme='NoColor', | |
1455 | tb_offset = 1, |
|
1455 | tb_offset = 1, | |
1456 | check_cache=self.compile.check_cache) |
|
1456 | check_cache=self.compile.check_cache) | |
1457 |
|
1457 | |||
1458 | # The instance will store a pointer to the system-wide exception hook, |
|
1458 | # 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 |
|
1459 | # so that runtime code (such as magics) can access it. This is because | |
1460 | # during the read-eval loop, it may get temporarily overwritten. |
|
1460 | # during the read-eval loop, it may get temporarily overwritten. | |
1461 | self.sys_excepthook = sys.excepthook |
|
1461 | self.sys_excepthook = sys.excepthook | |
1462 |
|
1462 | |||
1463 | # and add any custom exception handlers the user may have specified |
|
1463 | # and add any custom exception handlers the user may have specified | |
1464 | self.set_custom_exc(*custom_exceptions) |
|
1464 | self.set_custom_exc(*custom_exceptions) | |
1465 |
|
1465 | |||
1466 | # Set the exception mode |
|
1466 | # Set the exception mode | |
1467 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1467 | self.InteractiveTB.set_mode(mode=self.xmode) | |
1468 |
|
1468 | |||
1469 | def set_custom_exc(self, exc_tuple, handler): |
|
1469 | def set_custom_exc(self, exc_tuple, handler): | |
1470 | """set_custom_exc(exc_tuple,handler) |
|
1470 | """set_custom_exc(exc_tuple,handler) | |
1471 |
|
1471 | |||
1472 | Set a custom exception handler, which will be called if any of the |
|
1472 | 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 |
|
1473 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1474 | run_code() method). |
|
1474 | run_code() method). | |
1475 |
|
1475 | |||
1476 | Parameters |
|
1476 | Parameters | |
1477 | ---------- |
|
1477 | ---------- | |
1478 |
|
1478 | |||
1479 | exc_tuple : tuple of exception classes |
|
1479 | exc_tuple : tuple of exception classes | |
1480 | A *tuple* of exception classes, for which to call the defined |
|
1480 | 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 |
|
1481 | 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 |
|
1482 | 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:: |
|
1483 | you only want to trap a single exception, use a singleton tuple:: | |
1484 |
|
1484 | |||
1485 | exc_tuple == (MyCustomException,) |
|
1485 | exc_tuple == (MyCustomException,) | |
1486 |
|
1486 | |||
1487 | handler : callable |
|
1487 | handler : callable | |
1488 | handler must have the following signature:: |
|
1488 | handler must have the following signature:: | |
1489 |
|
1489 | |||
1490 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1490 | def my_handler(self, etype, value, tb, tb_offset=None): | |
1491 | ... |
|
1491 | ... | |
1492 | return structured_traceback |
|
1492 | return structured_traceback | |
1493 |
|
1493 | |||
1494 | Your handler must return a structured traceback (a list of strings), |
|
1494 | Your handler must return a structured traceback (a list of strings), | |
1495 | or None. |
|
1495 | or None. | |
1496 |
|
1496 | |||
1497 | This will be made into an instance method (via types.MethodType) |
|
1497 | 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 |
|
1498 | 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 |
|
1499 | listed in the exc_tuple are caught. If the handler is None, an | |
1500 | internal basic one is used, which just prints basic info. |
|
1500 | internal basic one is used, which just prints basic info. | |
1501 |
|
1501 | |||
1502 | To protect IPython from crashes, if your handler ever raises an |
|
1502 | To protect IPython from crashes, if your handler ever raises an | |
1503 | exception or returns an invalid result, it will be immediately |
|
1503 | exception or returns an invalid result, it will be immediately | |
1504 | disabled. |
|
1504 | disabled. | |
1505 |
|
1505 | |||
1506 | WARNING: by putting in your own exception handler into IPython's main |
|
1506 | 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 |
|
1507 | 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.""" |
|
1508 | facility should only be used if you really know what you are doing.""" | |
1509 |
|
1509 | |||
1510 | assert type(exc_tuple)==type(()) , \ |
|
1510 | assert type(exc_tuple)==type(()) , \ | |
1511 | "The custom exceptions must be given AS A TUPLE." |
|
1511 | "The custom exceptions must be given AS A TUPLE." | |
1512 |
|
1512 | |||
1513 | def dummy_handler(self,etype,value,tb,tb_offset=None): |
|
1513 | def dummy_handler(self,etype,value,tb,tb_offset=None): | |
1514 | print '*** Simple custom exception handler ***' |
|
1514 | print '*** Simple custom exception handler ***' | |
1515 | print 'Exception type :',etype |
|
1515 | print 'Exception type :',etype | |
1516 | print 'Exception value:',value |
|
1516 | print 'Exception value:',value | |
1517 | print 'Traceback :',tb |
|
1517 | print 'Traceback :',tb | |
1518 | #print 'Source code :','\n'.join(self.buffer) |
|
1518 | #print 'Source code :','\n'.join(self.buffer) | |
1519 |
|
1519 | |||
1520 | def validate_stb(stb): |
|
1520 | def validate_stb(stb): | |
1521 | """validate structured traceback return type |
|
1521 | """validate structured traceback return type | |
1522 |
|
1522 | |||
1523 | return type of CustomTB *should* be a list of strings, but allow |
|
1523 | return type of CustomTB *should* be a list of strings, but allow | |
1524 | single strings or None, which are harmless. |
|
1524 | single strings or None, which are harmless. | |
1525 |
|
1525 | |||
1526 | This function will *always* return a list of strings, |
|
1526 | This function will *always* return a list of strings, | |
1527 | and will raise a TypeError if stb is inappropriate. |
|
1527 | and will raise a TypeError if stb is inappropriate. | |
1528 | """ |
|
1528 | """ | |
1529 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1529 | msg = "CustomTB must return list of strings, not %r" % stb | |
1530 | if stb is None: |
|
1530 | if stb is None: | |
1531 | return [] |
|
1531 | return [] | |
1532 | elif isinstance(stb, basestring): |
|
1532 | elif isinstance(stb, basestring): | |
1533 | return [stb] |
|
1533 | return [stb] | |
1534 | elif not isinstance(stb, list): |
|
1534 | elif not isinstance(stb, list): | |
1535 | raise TypeError(msg) |
|
1535 | raise TypeError(msg) | |
1536 | # it's a list |
|
1536 | # it's a list | |
1537 | for line in stb: |
|
1537 | for line in stb: | |
1538 | # check every element |
|
1538 | # check every element | |
1539 | if not isinstance(line, basestring): |
|
1539 | if not isinstance(line, basestring): | |
1540 | raise TypeError(msg) |
|
1540 | raise TypeError(msg) | |
1541 | return stb |
|
1541 | return stb | |
1542 |
|
1542 | |||
1543 | if handler is None: |
|
1543 | if handler is None: | |
1544 | wrapped = dummy_handler |
|
1544 | wrapped = dummy_handler | |
1545 | else: |
|
1545 | else: | |
1546 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1546 | def wrapped(self,etype,value,tb,tb_offset=None): | |
1547 | """wrap CustomTB handler, to protect IPython from user code |
|
1547 | """wrap CustomTB handler, to protect IPython from user code | |
1548 |
|
1548 | |||
1549 | This makes it harder (but not impossible) for custom exception |
|
1549 | This makes it harder (but not impossible) for custom exception | |
1550 | handlers to crash IPython. |
|
1550 | handlers to crash IPython. | |
1551 | """ |
|
1551 | """ | |
1552 | try: |
|
1552 | try: | |
1553 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1553 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) | |
1554 | return validate_stb(stb) |
|
1554 | return validate_stb(stb) | |
1555 | except: |
|
1555 | except: | |
1556 | # clear custom handler immediately |
|
1556 | # clear custom handler immediately | |
1557 | self.set_custom_exc((), None) |
|
1557 | self.set_custom_exc((), None) | |
1558 | print >> io.stderr, "Custom TB Handler failed, unregistering" |
|
1558 | print >> io.stderr, "Custom TB Handler failed, unregistering" | |
1559 | # show the exception in handler first |
|
1559 | # show the exception in handler first | |
1560 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1560 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) | |
1561 | print >> io.stdout, self.InteractiveTB.stb2text(stb) |
|
1561 | print >> io.stdout, self.InteractiveTB.stb2text(stb) | |
1562 | print >> io.stdout, "The original exception:" |
|
1562 | print >> io.stdout, "The original exception:" | |
1563 | stb = self.InteractiveTB.structured_traceback( |
|
1563 | stb = self.InteractiveTB.structured_traceback( | |
1564 | (etype,value,tb), tb_offset=tb_offset |
|
1564 | (etype,value,tb), tb_offset=tb_offset | |
1565 | ) |
|
1565 | ) | |
1566 | return stb |
|
1566 | return stb | |
1567 |
|
1567 | |||
1568 | self.CustomTB = types.MethodType(wrapped,self) |
|
1568 | self.CustomTB = types.MethodType(wrapped,self) | |
1569 | self.custom_exceptions = exc_tuple |
|
1569 | self.custom_exceptions = exc_tuple | |
1570 |
|
1570 | |||
1571 | def excepthook(self, etype, value, tb): |
|
1571 | def excepthook(self, etype, value, tb): | |
1572 | """One more defense for GUI apps that call sys.excepthook. |
|
1572 | """One more defense for GUI apps that call sys.excepthook. | |
1573 |
|
1573 | |||
1574 | GUI frameworks like wxPython trap exceptions and call |
|
1574 | GUI frameworks like wxPython trap exceptions and call | |
1575 | sys.excepthook themselves. I guess this is a feature that |
|
1575 | sys.excepthook themselves. I guess this is a feature that | |
1576 | enables them to keep running after exceptions that would |
|
1576 | enables them to keep running after exceptions that would | |
1577 | otherwise kill their mainloop. This is a bother for IPython |
|
1577 | otherwise kill their mainloop. This is a bother for IPython | |
1578 | which excepts to catch all of the program exceptions with a try: |
|
1578 | which excepts to catch all of the program exceptions with a try: | |
1579 | except: statement. |
|
1579 | except: statement. | |
1580 |
|
1580 | |||
1581 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1581 | 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 |
|
1582 | 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 |
|
1583 | IPython crashed. In order to work around this, we can disable the | |
1584 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1584 | CrashHandler and replace it with this excepthook instead, which prints a | |
1585 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1585 | regular traceback using our InteractiveTB. In this fashion, apps which | |
1586 | call sys.excepthook will generate a regular-looking exception from |
|
1586 | call sys.excepthook will generate a regular-looking exception from | |
1587 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1587 | IPython, and the CrashHandler will only be triggered by real IPython | |
1588 | crashes. |
|
1588 | crashes. | |
1589 |
|
1589 | |||
1590 | This hook should be used sparingly, only in places which are not likely |
|
1590 | This hook should be used sparingly, only in places which are not likely | |
1591 | to be true IPython errors. |
|
1591 | to be true IPython errors. | |
1592 | """ |
|
1592 | """ | |
1593 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1593 | self.showtraceback((etype,value,tb),tb_offset=0) | |
1594 |
|
1594 | |||
1595 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, |
|
1595 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, | |
1596 | exception_only=False): |
|
1596 | exception_only=False): | |
1597 | """Display the exception that just occurred. |
|
1597 | """Display the exception that just occurred. | |
1598 |
|
1598 | |||
1599 | If nothing is known about the exception, this is the method which |
|
1599 | If nothing is known about the exception, this is the method which | |
1600 | should be used throughout the code for presenting user tracebacks, |
|
1600 | should be used throughout the code for presenting user tracebacks, | |
1601 | rather than directly invoking the InteractiveTB object. |
|
1601 | rather than directly invoking the InteractiveTB object. | |
1602 |
|
1602 | |||
1603 | A specific showsyntaxerror() also exists, but this method can take |
|
1603 | A specific showsyntaxerror() also exists, but this method can take | |
1604 | care of calling it if needed, so unless you are explicitly catching a |
|
1604 | 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 |
|
1605 | SyntaxError exception, don't try to analyze the stack manually and | |
1606 | simply call this method.""" |
|
1606 | simply call this method.""" | |
1607 |
|
1607 | |||
1608 | try: |
|
1608 | try: | |
1609 | if exc_tuple is None: |
|
1609 | if exc_tuple is None: | |
1610 | etype, value, tb = sys.exc_info() |
|
1610 | etype, value, tb = sys.exc_info() | |
1611 | else: |
|
1611 | else: | |
1612 | etype, value, tb = exc_tuple |
|
1612 | etype, value, tb = exc_tuple | |
1613 |
|
1613 | |||
1614 | if etype is None: |
|
1614 | if etype is None: | |
1615 | if hasattr(sys, 'last_type'): |
|
1615 | if hasattr(sys, 'last_type'): | |
1616 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1616 | etype, value, tb = sys.last_type, sys.last_value, \ | |
1617 | sys.last_traceback |
|
1617 | sys.last_traceback | |
1618 | else: |
|
1618 | else: | |
1619 | self.write_err('No traceback available to show.\n') |
|
1619 | self.write_err('No traceback available to show.\n') | |
1620 | return |
|
1620 | return | |
1621 |
|
1621 | |||
1622 | if etype is SyntaxError: |
|
1622 | if etype is SyntaxError: | |
1623 | # Though this won't be called by syntax errors in the input |
|
1623 | # Though this won't be called by syntax errors in the input | |
1624 | # line, there may be SyntaxError cases with imported code. |
|
1624 | # line, there may be SyntaxError cases with imported code. | |
1625 | self.showsyntaxerror(filename) |
|
1625 | self.showsyntaxerror(filename) | |
1626 | elif etype is UsageError: |
|
1626 | elif etype is UsageError: | |
1627 | self.write_err("UsageError: %s" % value) |
|
1627 | self.write_err("UsageError: %s" % value) | |
1628 | else: |
|
1628 | else: | |
1629 | # WARNING: these variables are somewhat deprecated and not |
|
1629 | # WARNING: these variables are somewhat deprecated and not | |
1630 | # necessarily safe to use in a threaded environment, but tools |
|
1630 | # necessarily safe to use in a threaded environment, but tools | |
1631 | # like pdb depend on their existence, so let's set them. If we |
|
1631 | # 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. |
|
1632 | # find problems in the field, we'll need to revisit their use. | |
1633 | sys.last_type = etype |
|
1633 | sys.last_type = etype | |
1634 | sys.last_value = value |
|
1634 | sys.last_value = value | |
1635 | sys.last_traceback = tb |
|
1635 | sys.last_traceback = tb | |
1636 | if etype in self.custom_exceptions: |
|
1636 | if etype in self.custom_exceptions: | |
1637 | stb = self.CustomTB(etype, value, tb, tb_offset) |
|
1637 | stb = self.CustomTB(etype, value, tb, tb_offset) | |
1638 | else: |
|
1638 | else: | |
1639 | if exception_only: |
|
1639 | if exception_only: | |
1640 | stb = ['An exception has occurred, use %tb to see ' |
|
1640 | stb = ['An exception has occurred, use %tb to see ' | |
1641 | 'the full traceback.\n'] |
|
1641 | 'the full traceback.\n'] | |
1642 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
1642 | stb.extend(self.InteractiveTB.get_exception_only(etype, | |
1643 | value)) |
|
1643 | value)) | |
1644 | else: |
|
1644 | else: | |
1645 | stb = self.InteractiveTB.structured_traceback(etype, |
|
1645 | stb = self.InteractiveTB.structured_traceback(etype, | |
1646 | value, tb, tb_offset=tb_offset) |
|
1646 | value, tb, tb_offset=tb_offset) | |
1647 |
|
1647 | |||
1648 | self._showtraceback(etype, value, stb) |
|
1648 | self._showtraceback(etype, value, stb) | |
1649 | if self.call_pdb: |
|
1649 | if self.call_pdb: | |
1650 | # drop into debugger |
|
1650 | # drop into debugger | |
1651 | self.debugger(force=True) |
|
1651 | self.debugger(force=True) | |
1652 | return |
|
1652 | return | |
1653 |
|
1653 | |||
1654 | # Actually show the traceback |
|
1654 | # Actually show the traceback | |
1655 | self._showtraceback(etype, value, stb) |
|
1655 | self._showtraceback(etype, value, stb) | |
1656 |
|
1656 | |||
1657 | except KeyboardInterrupt: |
|
1657 | except KeyboardInterrupt: | |
1658 | self.write_err("\nKeyboardInterrupt\n") |
|
1658 | self.write_err("\nKeyboardInterrupt\n") | |
1659 |
|
1659 | |||
1660 | def _showtraceback(self, etype, evalue, stb): |
|
1660 | def _showtraceback(self, etype, evalue, stb): | |
1661 | """Actually show a traceback. |
|
1661 | """Actually show a traceback. | |
1662 |
|
1662 | |||
1663 | Subclasses may override this method to put the traceback on a different |
|
1663 | Subclasses may override this method to put the traceback on a different | |
1664 | place, like a side channel. |
|
1664 | place, like a side channel. | |
1665 | """ |
|
1665 | """ | |
1666 | print >> io.stdout, self.InteractiveTB.stb2text(stb) |
|
1666 | print >> io.stdout, self.InteractiveTB.stb2text(stb) | |
1667 |
|
1667 | |||
1668 | def showsyntaxerror(self, filename=None): |
|
1668 | def showsyntaxerror(self, filename=None): | |
1669 | """Display the syntax error that just occurred. |
|
1669 | """Display the syntax error that just occurred. | |
1670 |
|
1670 | |||
1671 | This doesn't display a stack trace because there isn't one. |
|
1671 | This doesn't display a stack trace because there isn't one. | |
1672 |
|
1672 | |||
1673 | If a filename is given, it is stuffed in the exception instead |
|
1673 | If a filename is given, it is stuffed in the exception instead | |
1674 | of what was there before (because Python's parser always uses |
|
1674 | of what was there before (because Python's parser always uses | |
1675 | "<string>" when reading from a string). |
|
1675 | "<string>" when reading from a string). | |
1676 | """ |
|
1676 | """ | |
1677 | etype, value, last_traceback = sys.exc_info() |
|
1677 | etype, value, last_traceback = sys.exc_info() | |
1678 |
|
1678 | |||
1679 | # See note about these variables in showtraceback() above |
|
1679 | # See note about these variables in showtraceback() above | |
1680 | sys.last_type = etype |
|
1680 | sys.last_type = etype | |
1681 | sys.last_value = value |
|
1681 | sys.last_value = value | |
1682 | sys.last_traceback = last_traceback |
|
1682 | sys.last_traceback = last_traceback | |
1683 |
|
1683 | |||
1684 | if filename and etype is SyntaxError: |
|
1684 | if filename and etype is SyntaxError: | |
1685 | # Work hard to stuff the correct filename in the exception |
|
1685 | # Work hard to stuff the correct filename in the exception | |
1686 | try: |
|
1686 | try: | |
1687 | msg, (dummy_filename, lineno, offset, line) = value |
|
1687 | msg, (dummy_filename, lineno, offset, line) = value | |
1688 | except: |
|
1688 | except: | |
1689 | # Not the format we expect; leave it alone |
|
1689 | # Not the format we expect; leave it alone | |
1690 | pass |
|
1690 | pass | |
1691 | else: |
|
1691 | else: | |
1692 | # Stuff in the right filename |
|
1692 | # Stuff in the right filename | |
1693 | try: |
|
1693 | try: | |
1694 | # Assume SyntaxError is a class exception |
|
1694 | # Assume SyntaxError is a class exception | |
1695 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1695 | value = SyntaxError(msg, (filename, lineno, offset, line)) | |
1696 | except: |
|
1696 | except: | |
1697 | # If that failed, assume SyntaxError is a string |
|
1697 | # If that failed, assume SyntaxError is a string | |
1698 | value = msg, (filename, lineno, offset, line) |
|
1698 | value = msg, (filename, lineno, offset, line) | |
1699 | stb = self.SyntaxTB.structured_traceback(etype, value, []) |
|
1699 | stb = self.SyntaxTB.structured_traceback(etype, value, []) | |
1700 | self._showtraceback(etype, value, stb) |
|
1700 | self._showtraceback(etype, value, stb) | |
1701 |
|
1701 | |||
1702 | # This is overridden in TerminalInteractiveShell to show a message about |
|
1702 | # This is overridden in TerminalInteractiveShell to show a message about | |
1703 | # the %paste magic. |
|
1703 | # the %paste magic. | |
1704 | def showindentationerror(self): |
|
1704 | def showindentationerror(self): | |
1705 | """Called by run_cell when there's an IndentationError in code entered |
|
1705 | """Called by run_cell when there's an IndentationError in code entered | |
1706 | at the prompt. |
|
1706 | at the prompt. | |
1707 |
|
1707 | |||
1708 | This is overridden in TerminalInteractiveShell to show a message about |
|
1708 | This is overridden in TerminalInteractiveShell to show a message about | |
1709 | the %paste magic.""" |
|
1709 | the %paste magic.""" | |
1710 | self.showsyntaxerror() |
|
1710 | self.showsyntaxerror() | |
1711 |
|
1711 | |||
1712 | #------------------------------------------------------------------------- |
|
1712 | #------------------------------------------------------------------------- | |
1713 | # Things related to readline |
|
1713 | # Things related to readline | |
1714 | #------------------------------------------------------------------------- |
|
1714 | #------------------------------------------------------------------------- | |
1715 |
|
1715 | |||
1716 | def init_readline(self): |
|
1716 | def init_readline(self): | |
1717 | """Command history completion/saving/reloading.""" |
|
1717 | """Command history completion/saving/reloading.""" | |
1718 |
|
1718 | |||
1719 | if self.readline_use: |
|
1719 | if self.readline_use: | |
1720 | import IPython.utils.rlineimpl as readline |
|
1720 | import IPython.utils.rlineimpl as readline | |
1721 |
|
1721 | |||
1722 | self.rl_next_input = None |
|
1722 | self.rl_next_input = None | |
1723 | self.rl_do_indent = False |
|
1723 | self.rl_do_indent = False | |
1724 |
|
1724 | |||
1725 | if not self.readline_use or not readline.have_readline: |
|
1725 | if not self.readline_use or not readline.have_readline: | |
1726 | self.has_readline = False |
|
1726 | self.has_readline = False | |
1727 | self.readline = None |
|
1727 | self.readline = None | |
1728 | # Set a number of methods that depend on readline to be no-op |
|
1728 | # Set a number of methods that depend on readline to be no-op | |
1729 | self.readline_no_record = no_op_context |
|
1729 | self.readline_no_record = no_op_context | |
1730 | self.set_readline_completer = no_op |
|
1730 | self.set_readline_completer = no_op | |
1731 | self.set_custom_completer = no_op |
|
1731 | self.set_custom_completer = no_op | |
1732 | self.set_completer_frame = no_op |
|
1732 | self.set_completer_frame = no_op | |
1733 | if self.readline_use: |
|
1733 | if self.readline_use: | |
1734 | warn('Readline services not available or not loaded.') |
|
1734 | warn('Readline services not available or not loaded.') | |
1735 | else: |
|
1735 | else: | |
1736 | self.has_readline = True |
|
1736 | self.has_readline = True | |
1737 | self.readline = readline |
|
1737 | self.readline = readline | |
1738 | sys.modules['readline'] = readline |
|
1738 | sys.modules['readline'] = readline | |
1739 |
|
1739 | |||
1740 | # Platform-specific configuration |
|
1740 | # Platform-specific configuration | |
1741 | if os.name == 'nt': |
|
1741 | if os.name == 'nt': | |
1742 | # FIXME - check with Frederick to see if we can harmonize |
|
1742 | # FIXME - check with Frederick to see if we can harmonize | |
1743 | # naming conventions with pyreadline to avoid this |
|
1743 | # naming conventions with pyreadline to avoid this | |
1744 | # platform-dependent check |
|
1744 | # platform-dependent check | |
1745 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1745 | self.readline_startup_hook = readline.set_pre_input_hook | |
1746 | else: |
|
1746 | else: | |
1747 | self.readline_startup_hook = readline.set_startup_hook |
|
1747 | self.readline_startup_hook = readline.set_startup_hook | |
1748 |
|
1748 | |||
1749 | # Load user's initrc file (readline config) |
|
1749 | # Load user's initrc file (readline config) | |
1750 | # Or if libedit is used, load editrc. |
|
1750 | # Or if libedit is used, load editrc. | |
1751 | inputrc_name = os.environ.get('INPUTRC') |
|
1751 | inputrc_name = os.environ.get('INPUTRC') | |
1752 | if inputrc_name is None: |
|
1752 | if inputrc_name is None: | |
1753 | home_dir = get_home_dir() |
|
1753 | home_dir = get_home_dir() | |
1754 | if home_dir is not None: |
|
1754 | if home_dir is not None: | |
1755 | inputrc_name = '.inputrc' |
|
1755 | inputrc_name = '.inputrc' | |
1756 | if readline.uses_libedit: |
|
1756 | if readline.uses_libedit: | |
1757 | inputrc_name = '.editrc' |
|
1757 | inputrc_name = '.editrc' | |
1758 | inputrc_name = os.path.join(home_dir, inputrc_name) |
|
1758 | inputrc_name = os.path.join(home_dir, inputrc_name) | |
1759 | if os.path.isfile(inputrc_name): |
|
1759 | if os.path.isfile(inputrc_name): | |
1760 | try: |
|
1760 | try: | |
1761 | readline.read_init_file(inputrc_name) |
|
1761 | readline.read_init_file(inputrc_name) | |
1762 | except: |
|
1762 | except: | |
1763 | warn('Problems reading readline initialization file <%s>' |
|
1763 | warn('Problems reading readline initialization file <%s>' | |
1764 | % inputrc_name) |
|
1764 | % inputrc_name) | |
1765 |
|
1765 | |||
1766 | # Configure readline according to user's prefs |
|
1766 | # Configure readline according to user's prefs | |
1767 | # This is only done if GNU readline is being used. If libedit |
|
1767 | # This is only done if GNU readline is being used. If libedit | |
1768 | # is being used (as on Leopard) the readline config is |
|
1768 | # is being used (as on Leopard) the readline config is | |
1769 | # not run as the syntax for libedit is different. |
|
1769 | # not run as the syntax for libedit is different. | |
1770 | if not readline.uses_libedit: |
|
1770 | if not readline.uses_libedit: | |
1771 | for rlcommand in self.readline_parse_and_bind: |
|
1771 | for rlcommand in self.readline_parse_and_bind: | |
1772 | #print "loading rl:",rlcommand # dbg |
|
1772 | #print "loading rl:",rlcommand # dbg | |
1773 | readline.parse_and_bind(rlcommand) |
|
1773 | readline.parse_and_bind(rlcommand) | |
1774 |
|
1774 | |||
1775 | # Remove some chars from the delimiters list. If we encounter |
|
1775 | # Remove some chars from the delimiters list. If we encounter | |
1776 | # unicode chars, discard them. |
|
1776 | # unicode chars, discard them. | |
1777 | delims = readline.get_completer_delims() |
|
1777 | delims = readline.get_completer_delims() | |
1778 | if not py3compat.PY3: |
|
1778 | if not py3compat.PY3: | |
1779 | delims = delims.encode("ascii", "ignore") |
|
1779 | delims = delims.encode("ascii", "ignore") | |
1780 | for d in self.readline_remove_delims: |
|
1780 | for d in self.readline_remove_delims: | |
1781 | delims = delims.replace(d, "") |
|
1781 | delims = delims.replace(d, "") | |
1782 | delims = delims.replace(ESC_MAGIC, '') |
|
1782 | delims = delims.replace(ESC_MAGIC, '') | |
1783 | readline.set_completer_delims(delims) |
|
1783 | readline.set_completer_delims(delims) | |
1784 | # otherwise we end up with a monster history after a while: |
|
1784 | # otherwise we end up with a monster history after a while: | |
1785 | readline.set_history_length(self.history_length) |
|
1785 | readline.set_history_length(self.history_length) | |
1786 |
|
1786 | |||
1787 | self.refill_readline_hist() |
|
1787 | self.refill_readline_hist() | |
1788 | self.readline_no_record = ReadlineNoRecord(self) |
|
1788 | self.readline_no_record = ReadlineNoRecord(self) | |
1789 |
|
1789 | |||
1790 | # Configure auto-indent for all platforms |
|
1790 | # Configure auto-indent for all platforms | |
1791 | self.set_autoindent(self.autoindent) |
|
1791 | self.set_autoindent(self.autoindent) | |
1792 |
|
1792 | |||
1793 | def refill_readline_hist(self): |
|
1793 | def refill_readline_hist(self): | |
1794 | # Load the last 1000 lines from history |
|
1794 | # Load the last 1000 lines from history | |
1795 | self.readline.clear_history() |
|
1795 | self.readline.clear_history() | |
1796 | stdin_encoding = sys.stdin.encoding or "utf-8" |
|
1796 | stdin_encoding = sys.stdin.encoding or "utf-8" | |
1797 | for _, _, cell in self.history_manager.get_tail(1000, |
|
1797 | for _, _, cell in self.history_manager.get_tail(1000, | |
1798 | include_latest=True): |
|
1798 | include_latest=True): | |
1799 | if cell.strip(): # Ignore blank lines |
|
1799 | if cell.strip(): # Ignore blank lines | |
1800 | if self.multiline_history: |
|
1800 | if self.multiline_history: | |
1801 | self.readline.add_history(py3compat.unicode_to_str(cell.rstrip(), |
|
1801 | self.readline.add_history(py3compat.unicode_to_str(cell.rstrip(), | |
1802 | stdin_encoding)) |
|
1802 | stdin_encoding)) | |
1803 | else: |
|
1803 | else: | |
1804 | for line in cell.splitlines(): |
|
1804 | for line in cell.splitlines(): | |
1805 | self.readline.add_history(py3compat.unicode_to_str(line, |
|
1805 | self.readline.add_history(py3compat.unicode_to_str(line, | |
1806 | stdin_encoding)) |
|
1806 | stdin_encoding)) | |
1807 |
|
1807 | |||
1808 | def set_next_input(self, s): |
|
1808 | def set_next_input(self, s): | |
1809 | """ Sets the 'default' input string for the next command line. |
|
1809 | """ Sets the 'default' input string for the next command line. | |
1810 |
|
1810 | |||
1811 | Requires readline. |
|
1811 | Requires readline. | |
1812 |
|
1812 | |||
1813 | Example: |
|
1813 | Example: | |
1814 |
|
1814 | |||
1815 | [D:\ipython]|1> _ip.set_next_input("Hello Word") |
|
1815 | [D:\ipython]|1> _ip.set_next_input("Hello Word") | |
1816 | [D:\ipython]|2> Hello Word_ # cursor is here |
|
1816 | [D:\ipython]|2> Hello Word_ # cursor is here | |
1817 | """ |
|
1817 | """ | |
1818 | if isinstance(s, unicode): |
|
1818 | if isinstance(s, unicode): | |
1819 | s = s.encode(self.stdin_encoding, 'replace') |
|
1819 | s = s.encode(self.stdin_encoding, 'replace') | |
1820 | self.rl_next_input = s |
|
1820 | self.rl_next_input = s | |
1821 |
|
1821 | |||
1822 | # Maybe move this to the terminal subclass? |
|
1822 | # Maybe move this to the terminal subclass? | |
1823 | def pre_readline(self): |
|
1823 | def pre_readline(self): | |
1824 | """readline hook to be used at the start of each line. |
|
1824 | """readline hook to be used at the start of each line. | |
1825 |
|
1825 | |||
1826 | Currently it handles auto-indent only.""" |
|
1826 | Currently it handles auto-indent only.""" | |
1827 |
|
1827 | |||
1828 | if self.rl_do_indent: |
|
1828 | if self.rl_do_indent: | |
1829 | self.readline.insert_text(self._indent_current_str()) |
|
1829 | self.readline.insert_text(self._indent_current_str()) | |
1830 | if self.rl_next_input is not None: |
|
1830 | if self.rl_next_input is not None: | |
1831 | self.readline.insert_text(self.rl_next_input) |
|
1831 | self.readline.insert_text(self.rl_next_input) | |
1832 | self.rl_next_input = None |
|
1832 | self.rl_next_input = None | |
1833 |
|
1833 | |||
1834 | def _indent_current_str(self): |
|
1834 | def _indent_current_str(self): | |
1835 | """return the current level of indentation as a string""" |
|
1835 | """return the current level of indentation as a string""" | |
1836 | return self.input_splitter.indent_spaces * ' ' |
|
1836 | return self.input_splitter.indent_spaces * ' ' | |
1837 |
|
1837 | |||
1838 | #------------------------------------------------------------------------- |
|
1838 | #------------------------------------------------------------------------- | |
1839 | # Things related to text completion |
|
1839 | # Things related to text completion | |
1840 | #------------------------------------------------------------------------- |
|
1840 | #------------------------------------------------------------------------- | |
1841 |
|
1841 | |||
1842 | def init_completer(self): |
|
1842 | def init_completer(self): | |
1843 | """Initialize the completion machinery. |
|
1843 | """Initialize the completion machinery. | |
1844 |
|
1844 | |||
1845 | This creates completion machinery that can be used by client code, |
|
1845 | This creates completion machinery that can be used by client code, | |
1846 | either interactively in-process (typically triggered by the readline |
|
1846 | either interactively in-process (typically triggered by the readline | |
1847 | library), programatically (such as in test suites) or out-of-prcess |
|
1847 | library), programatically (such as in test suites) or out-of-prcess | |
1848 | (typically over the network by remote frontends). |
|
1848 | (typically over the network by remote frontends). | |
1849 | """ |
|
1849 | """ | |
1850 | from IPython.core.completer import IPCompleter |
|
1850 | from IPython.core.completer import IPCompleter | |
1851 | from IPython.core.completerlib import (module_completer, |
|
1851 | from IPython.core.completerlib import (module_completer, | |
1852 | magic_run_completer, cd_completer) |
|
1852 | magic_run_completer, cd_completer) | |
1853 |
|
1853 | |||
1854 | self.Completer = IPCompleter(shell=self, |
|
1854 | self.Completer = IPCompleter(shell=self, | |
1855 | namespace=self.user_ns, |
|
1855 | namespace=self.user_ns, | |
1856 | global_namespace=self.user_global_ns, |
|
1856 | global_namespace=self.user_global_ns, | |
1857 | alias_table=self.alias_manager.alias_table, |
|
1857 | alias_table=self.alias_manager.alias_table, | |
1858 | use_readline=self.has_readline, |
|
1858 | use_readline=self.has_readline, | |
1859 | config=self.config, |
|
1859 | config=self.config, | |
1860 | ) |
|
1860 | ) | |
1861 | self.configurables.append(self.Completer) |
|
1861 | self.configurables.append(self.Completer) | |
1862 |
|
1862 | |||
1863 | # Add custom completers to the basic ones built into IPCompleter |
|
1863 | # Add custom completers to the basic ones built into IPCompleter | |
1864 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1864 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
1865 | self.strdispatchers['complete_command'] = sdisp |
|
1865 | self.strdispatchers['complete_command'] = sdisp | |
1866 | self.Completer.custom_completers = sdisp |
|
1866 | self.Completer.custom_completers = sdisp | |
1867 |
|
1867 | |||
1868 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
1868 | self.set_hook('complete_command', module_completer, str_key = 'import') | |
1869 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
1869 | self.set_hook('complete_command', module_completer, str_key = 'from') | |
1870 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
1870 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') | |
1871 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
1871 | self.set_hook('complete_command', cd_completer, str_key = '%cd') | |
1872 |
|
1872 | |||
1873 | # Only configure readline if we truly are using readline. IPython can |
|
1873 | # Only configure readline if we truly are using readline. IPython can | |
1874 | # do tab-completion over the network, in GUIs, etc, where readline |
|
1874 | # do tab-completion over the network, in GUIs, etc, where readline | |
1875 | # itself may be absent |
|
1875 | # itself may be absent | |
1876 | if self.has_readline: |
|
1876 | if self.has_readline: | |
1877 | self.set_readline_completer() |
|
1877 | self.set_readline_completer() | |
1878 |
|
1878 | |||
1879 | def complete(self, text, line=None, cursor_pos=None): |
|
1879 | def complete(self, text, line=None, cursor_pos=None): | |
1880 | """Return the completed text and a list of completions. |
|
1880 | """Return the completed text and a list of completions. | |
1881 |
|
1881 | |||
1882 | Parameters |
|
1882 | Parameters | |
1883 | ---------- |
|
1883 | ---------- | |
1884 |
|
1884 | |||
1885 | text : string |
|
1885 | text : string | |
1886 | A string of text to be completed on. It can be given as empty and |
|
1886 | 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 |
|
1887 | instead a line/position pair are given. In this case, the | |
1888 | completer itself will split the line like readline does. |
|
1888 | completer itself will split the line like readline does. | |
1889 |
|
1889 | |||
1890 | line : string, optional |
|
1890 | line : string, optional | |
1891 | The complete line that text is part of. |
|
1891 | The complete line that text is part of. | |
1892 |
|
1892 | |||
1893 | cursor_pos : int, optional |
|
1893 | cursor_pos : int, optional | |
1894 | The position of the cursor on the input line. |
|
1894 | The position of the cursor on the input line. | |
1895 |
|
1895 | |||
1896 | Returns |
|
1896 | Returns | |
1897 | ------- |
|
1897 | ------- | |
1898 | text : string |
|
1898 | text : string | |
1899 | The actual text that was completed. |
|
1899 | The actual text that was completed. | |
1900 |
|
1900 | |||
1901 | matches : list |
|
1901 | matches : list | |
1902 | A sorted list with all possible completions. |
|
1902 | A sorted list with all possible completions. | |
1903 |
|
1903 | |||
1904 | The optional arguments allow the completion to take more context into |
|
1904 | The optional arguments allow the completion to take more context into | |
1905 | account, and are part of the low-level completion API. |
|
1905 | account, and are part of the low-level completion API. | |
1906 |
|
1906 | |||
1907 | This is a wrapper around the completion mechanism, similar to what |
|
1907 | 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 |
|
1908 | 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 |
|
1909 | exposing it as a method, it can be used by other non-readline | |
1910 | environments (such as GUIs) for text completion. |
|
1910 | environments (such as GUIs) for text completion. | |
1911 |
|
1911 | |||
1912 | Simple usage example: |
|
1912 | Simple usage example: | |
1913 |
|
1913 | |||
1914 | In [1]: x = 'hello' |
|
1914 | In [1]: x = 'hello' | |
1915 |
|
1915 | |||
1916 | In [2]: _ip.complete('x.l') |
|
1916 | In [2]: _ip.complete('x.l') | |
1917 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
1917 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) | |
1918 | """ |
|
1918 | """ | |
1919 |
|
1919 | |||
1920 | # Inject names into __builtin__ so we can complete on the added names. |
|
1920 | # Inject names into __builtin__ so we can complete on the added names. | |
1921 | with self.builtin_trap: |
|
1921 | with self.builtin_trap: | |
1922 | return self.Completer.complete(text, line, cursor_pos) |
|
1922 | return self.Completer.complete(text, line, cursor_pos) | |
1923 |
|
1923 | |||
1924 | def set_custom_completer(self, completer, pos=0): |
|
1924 | def set_custom_completer(self, completer, pos=0): | |
1925 | """Adds a new custom completer function. |
|
1925 | """Adds a new custom completer function. | |
1926 |
|
1926 | |||
1927 | The position argument (defaults to 0) is the index in the completers |
|
1927 | The position argument (defaults to 0) is the index in the completers | |
1928 | list where you want the completer to be inserted.""" |
|
1928 | list where you want the completer to be inserted.""" | |
1929 |
|
1929 | |||
1930 | newcomp = types.MethodType(completer,self.Completer) |
|
1930 | newcomp = types.MethodType(completer,self.Completer) | |
1931 | self.Completer.matchers.insert(pos,newcomp) |
|
1931 | self.Completer.matchers.insert(pos,newcomp) | |
1932 |
|
1932 | |||
1933 | def set_readline_completer(self): |
|
1933 | def set_readline_completer(self): | |
1934 | """Reset readline's completer to be our own.""" |
|
1934 | """Reset readline's completer to be our own.""" | |
1935 | self.readline.set_completer(self.Completer.rlcomplete) |
|
1935 | self.readline.set_completer(self.Completer.rlcomplete) | |
1936 |
|
1936 | |||
1937 | def set_completer_frame(self, frame=None): |
|
1937 | def set_completer_frame(self, frame=None): | |
1938 | """Set the frame of the completer.""" |
|
1938 | """Set the frame of the completer.""" | |
1939 | if frame: |
|
1939 | if frame: | |
1940 | self.Completer.namespace = frame.f_locals |
|
1940 | self.Completer.namespace = frame.f_locals | |
1941 | self.Completer.global_namespace = frame.f_globals |
|
1941 | self.Completer.global_namespace = frame.f_globals | |
1942 | else: |
|
1942 | else: | |
1943 | self.Completer.namespace = self.user_ns |
|
1943 | self.Completer.namespace = self.user_ns | |
1944 | self.Completer.global_namespace = self.user_global_ns |
|
1944 | self.Completer.global_namespace = self.user_global_ns | |
1945 |
|
1945 | |||
1946 | #------------------------------------------------------------------------- |
|
1946 | #------------------------------------------------------------------------- | |
1947 | # Things related to magics |
|
1947 | # Things related to magics | |
1948 | #------------------------------------------------------------------------- |
|
1948 | #------------------------------------------------------------------------- | |
1949 |
|
1949 | |||
1950 | def init_magics(self): |
|
1950 | def init_magics(self): | |
1951 | # FIXME: Move the color initialization to the DisplayHook, which |
|
1951 | # FIXME: Move the color initialization to the DisplayHook, which | |
1952 | # should be split into a prompt manager and displayhook. We probably |
|
1952 | # should be split into a prompt manager and displayhook. We probably | |
1953 | # even need a centralize colors management object. |
|
1953 | # even need a centralize colors management object. | |
1954 | self.magic_colors(self.colors) |
|
1954 | self.magic_colors(self.colors) | |
1955 | # History was moved to a separate module |
|
1955 | # History was moved to a separate module | |
1956 | from . import history |
|
1956 | from . import history | |
1957 | history.init_ipython(self) |
|
1957 | history.init_ipython(self) | |
1958 |
|
1958 | |||
1959 | def magic(self, arg_s, next_input=None): |
|
1959 | def magic(self, arg_s, next_input=None): | |
1960 | """Call a magic function by name. |
|
1960 | """Call a magic function by name. | |
1961 |
|
1961 | |||
1962 | Input: a string containing the name of the magic function to call and |
|
1962 | Input: a string containing the name of the magic function to call and | |
1963 | any additional arguments to be passed to the magic. |
|
1963 | any additional arguments to be passed to the magic. | |
1964 |
|
1964 | |||
1965 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
1965 | magic('name -opt foo bar') is equivalent to typing at the ipython | |
1966 | prompt: |
|
1966 | prompt: | |
1967 |
|
1967 | |||
1968 | In[1]: %name -opt foo bar |
|
1968 | In[1]: %name -opt foo bar | |
1969 |
|
1969 | |||
1970 | To call a magic without arguments, simply use magic('name'). |
|
1970 | To call a magic without arguments, simply use magic('name'). | |
1971 |
|
1971 | |||
1972 | This provides a proper Python function to call IPython's magics in any |
|
1972 | 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 |
|
1973 | valid Python code you can type at the interpreter, including loops and | |
1974 | compound statements. |
|
1974 | compound statements. | |
1975 | """ |
|
1975 | """ | |
1976 | # Allow setting the next input - this is used if the user does `a=abs?`. |
|
1976 | # 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. |
|
1977 | # We do this first so that magic functions can override it. | |
1978 | if next_input: |
|
1978 | if next_input: | |
1979 | self.set_next_input(next_input) |
|
1979 | self.set_next_input(next_input) | |
1980 |
|
1980 | |||
1981 | args = arg_s.split(' ',1) |
|
1981 | args = arg_s.split(' ',1) | |
1982 | magic_name = args[0] |
|
1982 | magic_name = args[0] | |
1983 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
1983 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) | |
1984 |
|
1984 | |||
1985 | try: |
|
1985 | try: | |
1986 | magic_args = args[1] |
|
1986 | magic_args = args[1] | |
1987 | except IndexError: |
|
1987 | except IndexError: | |
1988 | magic_args = '' |
|
1988 | magic_args = '' | |
1989 | fn = getattr(self,'magic_'+magic_name,None) |
|
1989 | fn = getattr(self,'magic_'+magic_name,None) | |
1990 | if fn is None: |
|
1990 | if fn is None: | |
1991 | error("Magic function `%s` not found." % magic_name) |
|
1991 | error("Magic function `%s` not found." % magic_name) | |
1992 | else: |
|
1992 | else: | |
1993 | magic_args = self.var_expand(magic_args,1) |
|
1993 | magic_args = self.var_expand(magic_args,1) | |
1994 | # Grab local namespace if we need it: |
|
1994 | # Grab local namespace if we need it: | |
1995 | if getattr(fn, "needs_local_scope", False): |
|
1995 | if getattr(fn, "needs_local_scope", False): | |
1996 | self._magic_locals = sys._getframe(1).f_locals |
|
1996 | self._magic_locals = sys._getframe(1).f_locals | |
1997 | with self.builtin_trap: |
|
1997 | with self.builtin_trap: | |
1998 | result = fn(magic_args) |
|
1998 | result = fn(magic_args) | |
1999 | # Ensure we're not keeping object references around: |
|
1999 | # Ensure we're not keeping object references around: | |
2000 | self._magic_locals = {} |
|
2000 | self._magic_locals = {} | |
2001 | return result |
|
2001 | return result | |
2002 |
|
2002 | |||
2003 | def define_magic(self, magicname, func): |
|
2003 | def define_magic(self, magicname, func): | |
2004 | """Expose own function as magic function for ipython |
|
2004 | """Expose own function as magic function for ipython | |
2005 |
|
2005 | |||
2006 | def foo_impl(self,parameter_s=''): |
|
2006 | def foo_impl(self,parameter_s=''): | |
2007 | 'My very own magic!. (Use docstrings, IPython reads them).' |
|
2007 | 'My very own magic!. (Use docstrings, IPython reads them).' | |
2008 | print 'Magic function. Passed parameter is between < >:' |
|
2008 | print 'Magic function. Passed parameter is between < >:' | |
2009 | print '<%s>' % parameter_s |
|
2009 | print '<%s>' % parameter_s | |
2010 | print 'The self object is:',self |
|
2010 | print 'The self object is:',self | |
2011 |
|
2011 | |||
2012 | self.define_magic('foo',foo_impl) |
|
2012 | self.define_magic('foo',foo_impl) | |
2013 | """ |
|
2013 | """ | |
2014 | im = types.MethodType(func,self) |
|
2014 | im = types.MethodType(func,self) | |
2015 | old = getattr(self, "magic_" + magicname, None) |
|
2015 | old = getattr(self, "magic_" + magicname, None) | |
2016 | setattr(self, "magic_" + magicname, im) |
|
2016 | setattr(self, "magic_" + magicname, im) | |
2017 | return old |
|
2017 | return old | |
2018 |
|
2018 | |||
2019 | #------------------------------------------------------------------------- |
|
2019 | #------------------------------------------------------------------------- | |
2020 | # Things related to macros |
|
2020 | # Things related to macros | |
2021 | #------------------------------------------------------------------------- |
|
2021 | #------------------------------------------------------------------------- | |
2022 |
|
2022 | |||
2023 | def define_macro(self, name, themacro): |
|
2023 | def define_macro(self, name, themacro): | |
2024 | """Define a new macro |
|
2024 | """Define a new macro | |
2025 |
|
2025 | |||
2026 | Parameters |
|
2026 | Parameters | |
2027 | ---------- |
|
2027 | ---------- | |
2028 | name : str |
|
2028 | name : str | |
2029 | The name of the macro. |
|
2029 | The name of the macro. | |
2030 | themacro : str or Macro |
|
2030 | themacro : str or Macro | |
2031 | The action to do upon invoking the macro. If a string, a new |
|
2031 | The action to do upon invoking the macro. If a string, a new | |
2032 | Macro object is created by passing the string to it. |
|
2032 | Macro object is created by passing the string to it. | |
2033 | """ |
|
2033 | """ | |
2034 |
|
2034 | |||
2035 | from IPython.core import macro |
|
2035 | from IPython.core import macro | |
2036 |
|
2036 | |||
2037 | if isinstance(themacro, basestring): |
|
2037 | if isinstance(themacro, basestring): | |
2038 | themacro = macro.Macro(themacro) |
|
2038 | themacro = macro.Macro(themacro) | |
2039 | if not isinstance(themacro, macro.Macro): |
|
2039 | if not isinstance(themacro, macro.Macro): | |
2040 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2040 | raise ValueError('A macro must be a string or a Macro instance.') | |
2041 | self.user_ns[name] = themacro |
|
2041 | self.user_ns[name] = themacro | |
2042 |
|
2042 | |||
2043 | #------------------------------------------------------------------------- |
|
2043 | #------------------------------------------------------------------------- | |
2044 | # Things related to the running of system commands |
|
2044 | # Things related to the running of system commands | |
2045 | #------------------------------------------------------------------------- |
|
2045 | #------------------------------------------------------------------------- | |
2046 |
|
2046 | |||
2047 | def system_piped(self, cmd): |
|
2047 | def system_piped(self, cmd): | |
2048 | """Call the given cmd in a subprocess, piping stdout/err |
|
2048 | """Call the given cmd in a subprocess, piping stdout/err | |
2049 |
|
2049 | |||
2050 | Parameters |
|
2050 | Parameters | |
2051 | ---------- |
|
2051 | ---------- | |
2052 | cmd : str |
|
2052 | cmd : str | |
2053 | Command to execute (can not end in '&', as background processes are |
|
2053 | Command to execute (can not end in '&', as background processes are | |
2054 | not supported. Should not be a command that expects input |
|
2054 | not supported. Should not be a command that expects input | |
2055 | other than simple text. |
|
2055 | other than simple text. | |
2056 | """ |
|
2056 | """ | |
2057 | if cmd.rstrip().endswith('&'): |
|
2057 | if cmd.rstrip().endswith('&'): | |
2058 | # this is *far* from a rigorous test |
|
2058 | # this is *far* from a rigorous test | |
2059 | # We do not support backgrounding processes because we either use |
|
2059 | # We do not support backgrounding processes because we either use | |
2060 | # pexpect or pipes to read from. Users can always just call |
|
2060 | # pexpect or pipes to read from. Users can always just call | |
2061 | # os.system() or use ip.system=ip.system_raw |
|
2061 | # os.system() or use ip.system=ip.system_raw | |
2062 | # if they really want a background process. |
|
2062 | # if they really want a background process. | |
2063 | raise OSError("Background processes not supported.") |
|
2063 | raise OSError("Background processes not supported.") | |
2064 |
|
2064 | |||
2065 | # we explicitly do NOT return the subprocess status code, because |
|
2065 | # we explicitly do NOT return the subprocess status code, because | |
2066 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2066 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2067 | # Instead, we store the exit_code in user_ns. |
|
2067 | # Instead, we store the exit_code in user_ns. | |
2068 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2)) |
|
2068 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2)) | |
2069 |
|
2069 | |||
2070 | def system_raw(self, cmd): |
|
2070 | def system_raw(self, cmd): | |
2071 | """Call the given cmd in a subprocess using os.system |
|
2071 | """Call the given cmd in a subprocess using os.system | |
2072 |
|
2072 | |||
2073 | Parameters |
|
2073 | Parameters | |
2074 | ---------- |
|
2074 | ---------- | |
2075 | cmd : str |
|
2075 | cmd : str | |
2076 | Command to execute. |
|
2076 | Command to execute. | |
2077 | """ |
|
2077 | """ | |
2078 | cmd = self.var_expand(cmd, depth=2) |
|
2078 | cmd = self.var_expand(cmd, depth=2) | |
2079 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2079 | # protect os.system from UNC paths on Windows, which it can't handle: | |
2080 | if sys.platform == 'win32': |
|
2080 | if sys.platform == 'win32': | |
2081 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2081 | from IPython.utils._process_win32 import AvoidUNCPath | |
2082 | with AvoidUNCPath() as path: |
|
2082 | with AvoidUNCPath() as path: | |
2083 | if path is not None: |
|
2083 | if path is not None: | |
2084 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2084 | cmd = '"pushd %s &&"%s' % (path, cmd) | |
|
2085 | cmd = cmd.encode(sys.stdin.encoding) | |||
2085 | ec = os.system(cmd) |
|
2086 | ec = os.system(cmd) | |
2086 | else: |
|
2087 | else: | |
2087 | ec = os.system(cmd) |
|
2088 | ec = os.system(cmd) | |
2088 |
|
2089 | |||
2089 | # We explicitly do NOT return the subprocess status code, because |
|
2090 | # We explicitly do NOT return the subprocess status code, because | |
2090 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2091 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2091 | # Instead, we store the exit_code in user_ns. |
|
2092 | # Instead, we store the exit_code in user_ns. | |
2092 | self.user_ns['_exit_code'] = ec |
|
2093 | self.user_ns['_exit_code'] = ec | |
2093 |
|
2094 | |||
2094 | # use piped system by default, because it is better behaved |
|
2095 | # use piped system by default, because it is better behaved | |
2095 | system = system_piped |
|
2096 | system = system_piped | |
2096 |
|
2097 | |||
2097 | def getoutput(self, cmd, split=True): |
|
2098 | def getoutput(self, cmd, split=True): | |
2098 | """Get output (possibly including stderr) from a subprocess. |
|
2099 | """Get output (possibly including stderr) from a subprocess. | |
2099 |
|
2100 | |||
2100 | Parameters |
|
2101 | Parameters | |
2101 | ---------- |
|
2102 | ---------- | |
2102 | cmd : str |
|
2103 | cmd : str | |
2103 | Command to execute (can not end in '&', as background processes are |
|
2104 | Command to execute (can not end in '&', as background processes are | |
2104 | not supported. |
|
2105 | not supported. | |
2105 | split : bool, optional |
|
2106 | split : bool, optional | |
2106 |
|
2107 | |||
2107 | If True, split the output into an IPython SList. Otherwise, an |
|
2108 | If True, split the output into an IPython SList. Otherwise, an | |
2108 | IPython LSString is returned. These are objects similar to normal |
|
2109 | IPython LSString is returned. These are objects similar to normal | |
2109 | lists and strings, with a few convenience attributes for easier |
|
2110 | lists and strings, with a few convenience attributes for easier | |
2110 | manipulation of line-based output. You can use '?' on them for |
|
2111 | manipulation of line-based output. You can use '?' on them for | |
2111 | details. |
|
2112 | details. | |
2112 | """ |
|
2113 | """ | |
2113 | if cmd.rstrip().endswith('&'): |
|
2114 | if cmd.rstrip().endswith('&'): | |
2114 | # this is *far* from a rigorous test |
|
2115 | # this is *far* from a rigorous test | |
2115 | raise OSError("Background processes not supported.") |
|
2116 | raise OSError("Background processes not supported.") | |
2116 | out = getoutput(self.var_expand(cmd, depth=2)) |
|
2117 | out = getoutput(self.var_expand(cmd, depth=2)) | |
2117 | if split: |
|
2118 | if split: | |
2118 | out = SList(out.splitlines()) |
|
2119 | out = SList(out.splitlines()) | |
2119 | else: |
|
2120 | else: | |
2120 | out = LSString(out) |
|
2121 | out = LSString(out) | |
2121 | return out |
|
2122 | return out | |
2122 |
|
2123 | |||
2123 | #------------------------------------------------------------------------- |
|
2124 | #------------------------------------------------------------------------- | |
2124 | # Things related to aliases |
|
2125 | # Things related to aliases | |
2125 | #------------------------------------------------------------------------- |
|
2126 | #------------------------------------------------------------------------- | |
2126 |
|
2127 | |||
2127 | def init_alias(self): |
|
2128 | def init_alias(self): | |
2128 | self.alias_manager = AliasManager(shell=self, config=self.config) |
|
2129 | self.alias_manager = AliasManager(shell=self, config=self.config) | |
2129 | self.configurables.append(self.alias_manager) |
|
2130 | self.configurables.append(self.alias_manager) | |
2130 | self.ns_table['alias'] = self.alias_manager.alias_table, |
|
2131 | self.ns_table['alias'] = self.alias_manager.alias_table, | |
2131 |
|
2132 | |||
2132 | #------------------------------------------------------------------------- |
|
2133 | #------------------------------------------------------------------------- | |
2133 | # Things related to extensions and plugins |
|
2134 | # Things related to extensions and plugins | |
2134 | #------------------------------------------------------------------------- |
|
2135 | #------------------------------------------------------------------------- | |
2135 |
|
2136 | |||
2136 | def init_extension_manager(self): |
|
2137 | def init_extension_manager(self): | |
2137 | self.extension_manager = ExtensionManager(shell=self, config=self.config) |
|
2138 | self.extension_manager = ExtensionManager(shell=self, config=self.config) | |
2138 | self.configurables.append(self.extension_manager) |
|
2139 | self.configurables.append(self.extension_manager) | |
2139 |
|
2140 | |||
2140 | def init_plugin_manager(self): |
|
2141 | def init_plugin_manager(self): | |
2141 | self.plugin_manager = PluginManager(config=self.config) |
|
2142 | self.plugin_manager = PluginManager(config=self.config) | |
2142 | self.configurables.append(self.plugin_manager) |
|
2143 | self.configurables.append(self.plugin_manager) | |
2143 |
|
2144 | |||
2144 |
|
2145 | |||
2145 | #------------------------------------------------------------------------- |
|
2146 | #------------------------------------------------------------------------- | |
2146 | # Things related to payloads |
|
2147 | # Things related to payloads | |
2147 | #------------------------------------------------------------------------- |
|
2148 | #------------------------------------------------------------------------- | |
2148 |
|
2149 | |||
2149 | def init_payload(self): |
|
2150 | def init_payload(self): | |
2150 | self.payload_manager = PayloadManager(config=self.config) |
|
2151 | self.payload_manager = PayloadManager(config=self.config) | |
2151 | self.configurables.append(self.payload_manager) |
|
2152 | self.configurables.append(self.payload_manager) | |
2152 |
|
2153 | |||
2153 | #------------------------------------------------------------------------- |
|
2154 | #------------------------------------------------------------------------- | |
2154 | # Things related to the prefilter |
|
2155 | # Things related to the prefilter | |
2155 | #------------------------------------------------------------------------- |
|
2156 | #------------------------------------------------------------------------- | |
2156 |
|
2157 | |||
2157 | def init_prefilter(self): |
|
2158 | def init_prefilter(self): | |
2158 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) |
|
2159 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) | |
2159 | self.configurables.append(self.prefilter_manager) |
|
2160 | self.configurables.append(self.prefilter_manager) | |
2160 | # Ultimately this will be refactored in the new interpreter code, but |
|
2161 | # Ultimately this will be refactored in the new interpreter code, but | |
2161 | # for now, we should expose the main prefilter method (there's legacy |
|
2162 | # for now, we should expose the main prefilter method (there's legacy | |
2162 | # code out there that may rely on this). |
|
2163 | # code out there that may rely on this). | |
2163 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2164 | self.prefilter = self.prefilter_manager.prefilter_lines | |
2164 |
|
2165 | |||
2165 | def auto_rewrite_input(self, cmd): |
|
2166 | def auto_rewrite_input(self, cmd): | |
2166 | """Print to the screen the rewritten form of the user's command. |
|
2167 | """Print to the screen the rewritten form of the user's command. | |
2167 |
|
2168 | |||
2168 | This shows visual feedback by rewriting input lines that cause |
|
2169 | This shows visual feedback by rewriting input lines that cause | |
2169 | automatic calling to kick in, like:: |
|
2170 | automatic calling to kick in, like:: | |
2170 |
|
2171 | |||
2171 | /f x |
|
2172 | /f x | |
2172 |
|
2173 | |||
2173 | into:: |
|
2174 | into:: | |
2174 |
|
2175 | |||
2175 | ------> f(x) |
|
2176 | ------> f(x) | |
2176 |
|
2177 | |||
2177 | after the user's input prompt. This helps the user understand that the |
|
2178 | after the user's input prompt. This helps the user understand that the | |
2178 | input line was transformed automatically by IPython. |
|
2179 | input line was transformed automatically by IPython. | |
2179 | """ |
|
2180 | """ | |
2180 | rw = self.displayhook.prompt1.auto_rewrite() + cmd |
|
2181 | rw = self.displayhook.prompt1.auto_rewrite() + cmd | |
2181 |
|
2182 | |||
2182 | try: |
|
2183 | try: | |
2183 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2184 | # plain ascii works better w/ pyreadline, on some machines, so | |
2184 | # we use it and only print uncolored rewrite if we have unicode |
|
2185 | # we use it and only print uncolored rewrite if we have unicode | |
2185 | rw = str(rw) |
|
2186 | rw = str(rw) | |
2186 | print >> io.stdout, rw |
|
2187 | print >> io.stdout, rw | |
2187 | except UnicodeEncodeError: |
|
2188 | except UnicodeEncodeError: | |
2188 | print "------> " + cmd |
|
2189 | print "------> " + cmd | |
2189 |
|
2190 | |||
2190 | #------------------------------------------------------------------------- |
|
2191 | #------------------------------------------------------------------------- | |
2191 | # Things related to extracting values/expressions from kernel and user_ns |
|
2192 | # Things related to extracting values/expressions from kernel and user_ns | |
2192 | #------------------------------------------------------------------------- |
|
2193 | #------------------------------------------------------------------------- | |
2193 |
|
2194 | |||
2194 | def _simple_error(self): |
|
2195 | def _simple_error(self): | |
2195 | etype, value = sys.exc_info()[:2] |
|
2196 | etype, value = sys.exc_info()[:2] | |
2196 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) |
|
2197 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) | |
2197 |
|
2198 | |||
2198 | def user_variables(self, names): |
|
2199 | def user_variables(self, names): | |
2199 | """Get a list of variable names from the user's namespace. |
|
2200 | """Get a list of variable names from the user's namespace. | |
2200 |
|
2201 | |||
2201 | Parameters |
|
2202 | Parameters | |
2202 | ---------- |
|
2203 | ---------- | |
2203 | names : list of strings |
|
2204 | names : list of strings | |
2204 | A list of names of variables to be read from the user namespace. |
|
2205 | A list of names of variables to be read from the user namespace. | |
2205 |
|
2206 | |||
2206 | Returns |
|
2207 | Returns | |
2207 | ------- |
|
2208 | ------- | |
2208 | A dict, keyed by the input names and with the repr() of each value. |
|
2209 | A dict, keyed by the input names and with the repr() of each value. | |
2209 | """ |
|
2210 | """ | |
2210 | out = {} |
|
2211 | out = {} | |
2211 | user_ns = self.user_ns |
|
2212 | user_ns = self.user_ns | |
2212 | for varname in names: |
|
2213 | for varname in names: | |
2213 | try: |
|
2214 | try: | |
2214 | value = repr(user_ns[varname]) |
|
2215 | value = repr(user_ns[varname]) | |
2215 | except: |
|
2216 | except: | |
2216 | value = self._simple_error() |
|
2217 | value = self._simple_error() | |
2217 | out[varname] = value |
|
2218 | out[varname] = value | |
2218 | return out |
|
2219 | return out | |
2219 |
|
2220 | |||
2220 | def user_expressions(self, expressions): |
|
2221 | def user_expressions(self, expressions): | |
2221 | """Evaluate a dict of expressions in the user's namespace. |
|
2222 | """Evaluate a dict of expressions in the user's namespace. | |
2222 |
|
2223 | |||
2223 | Parameters |
|
2224 | Parameters | |
2224 | ---------- |
|
2225 | ---------- | |
2225 | expressions : dict |
|
2226 | expressions : dict | |
2226 | A dict with string keys and string values. The expression values |
|
2227 | A dict with string keys and string values. The expression values | |
2227 | should be valid Python expressions, each of which will be evaluated |
|
2228 | should be valid Python expressions, each of which will be evaluated | |
2228 | in the user namespace. |
|
2229 | in the user namespace. | |
2229 |
|
2230 | |||
2230 | Returns |
|
2231 | Returns | |
2231 | ------- |
|
2232 | ------- | |
2232 | A dict, keyed like the input expressions dict, with the repr() of each |
|
2233 | A dict, keyed like the input expressions dict, with the repr() of each | |
2233 | value. |
|
2234 | value. | |
2234 | """ |
|
2235 | """ | |
2235 | out = {} |
|
2236 | out = {} | |
2236 | user_ns = self.user_ns |
|
2237 | user_ns = self.user_ns | |
2237 | global_ns = self.user_global_ns |
|
2238 | global_ns = self.user_global_ns | |
2238 | for key, expr in expressions.iteritems(): |
|
2239 | for key, expr in expressions.iteritems(): | |
2239 | try: |
|
2240 | try: | |
2240 | value = repr(eval(expr, global_ns, user_ns)) |
|
2241 | value = repr(eval(expr, global_ns, user_ns)) | |
2241 | except: |
|
2242 | except: | |
2242 | value = self._simple_error() |
|
2243 | value = self._simple_error() | |
2243 | out[key] = value |
|
2244 | out[key] = value | |
2244 | return out |
|
2245 | return out | |
2245 |
|
2246 | |||
2246 | #------------------------------------------------------------------------- |
|
2247 | #------------------------------------------------------------------------- | |
2247 | # Things related to the running of code |
|
2248 | # Things related to the running of code | |
2248 | #------------------------------------------------------------------------- |
|
2249 | #------------------------------------------------------------------------- | |
2249 |
|
2250 | |||
2250 | def ex(self, cmd): |
|
2251 | def ex(self, cmd): | |
2251 | """Execute a normal python statement in user namespace.""" |
|
2252 | """Execute a normal python statement in user namespace.""" | |
2252 | with self.builtin_trap: |
|
2253 | with self.builtin_trap: | |
2253 | exec cmd in self.user_global_ns, self.user_ns |
|
2254 | exec cmd in self.user_global_ns, self.user_ns | |
2254 |
|
2255 | |||
2255 | def ev(self, expr): |
|
2256 | def ev(self, expr): | |
2256 | """Evaluate python expression expr in user namespace. |
|
2257 | """Evaluate python expression expr in user namespace. | |
2257 |
|
2258 | |||
2258 | Returns the result of evaluation |
|
2259 | Returns the result of evaluation | |
2259 | """ |
|
2260 | """ | |
2260 | with self.builtin_trap: |
|
2261 | with self.builtin_trap: | |
2261 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2262 | return eval(expr, self.user_global_ns, self.user_ns) | |
2262 |
|
2263 | |||
2263 | def safe_execfile(self, fname, *where, **kw): |
|
2264 | def safe_execfile(self, fname, *where, **kw): | |
2264 | """A safe version of the builtin execfile(). |
|
2265 | """A safe version of the builtin execfile(). | |
2265 |
|
2266 | |||
2266 | This version will never throw an exception, but instead print |
|
2267 | This version will never throw an exception, but instead print | |
2267 | helpful error messages to the screen. This only works on pure |
|
2268 | helpful error messages to the screen. This only works on pure | |
2268 | Python files with the .py extension. |
|
2269 | Python files with the .py extension. | |
2269 |
|
2270 | |||
2270 | Parameters |
|
2271 | Parameters | |
2271 | ---------- |
|
2272 | ---------- | |
2272 | fname : string |
|
2273 | fname : string | |
2273 | The name of the file to be executed. |
|
2274 | The name of the file to be executed. | |
2274 | where : tuple |
|
2275 | where : tuple | |
2275 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2276 | One or two namespaces, passed to execfile() as (globals,locals). | |
2276 | If only one is given, it is passed as both. |
|
2277 | If only one is given, it is passed as both. | |
2277 | exit_ignore : bool (False) |
|
2278 | exit_ignore : bool (False) | |
2278 | If True, then silence SystemExit for non-zero status (it is always |
|
2279 | If True, then silence SystemExit for non-zero status (it is always | |
2279 | silenced for zero status, as it is so common). |
|
2280 | silenced for zero status, as it is so common). | |
2280 | raise_exceptions : bool (False) |
|
2281 | raise_exceptions : bool (False) | |
2281 | If True raise exceptions everywhere. Meant for testing. |
|
2282 | If True raise exceptions everywhere. Meant for testing. | |
2282 |
|
2283 | |||
2283 | """ |
|
2284 | """ | |
2284 | kw.setdefault('exit_ignore', False) |
|
2285 | kw.setdefault('exit_ignore', False) | |
2285 | kw.setdefault('raise_exceptions', False) |
|
2286 | kw.setdefault('raise_exceptions', False) | |
2286 |
|
2287 | |||
2287 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2288 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2288 |
|
2289 | |||
2289 | # Make sure we can open the file |
|
2290 | # Make sure we can open the file | |
2290 | try: |
|
2291 | try: | |
2291 | with open(fname) as thefile: |
|
2292 | with open(fname) as thefile: | |
2292 | pass |
|
2293 | pass | |
2293 | except: |
|
2294 | except: | |
2294 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2295 | warn('Could not open file <%s> for safe execution.' % fname) | |
2295 | return |
|
2296 | return | |
2296 |
|
2297 | |||
2297 | # Find things also in current directory. This is needed to mimic the |
|
2298 | # Find things also in current directory. This is needed to mimic the | |
2298 | # behavior of running a script from the system command line, where |
|
2299 | # behavior of running a script from the system command line, where | |
2299 | # Python inserts the script's directory into sys.path |
|
2300 | # Python inserts the script's directory into sys.path | |
2300 | dname = os.path.dirname(fname) |
|
2301 | dname = os.path.dirname(fname) | |
2301 |
|
2302 | |||
2302 | with prepended_to_syspath(dname): |
|
2303 | with prepended_to_syspath(dname): | |
2303 | try: |
|
2304 | try: | |
2304 | py3compat.execfile(fname,*where) |
|
2305 | py3compat.execfile(fname,*where) | |
2305 | except SystemExit, status: |
|
2306 | except SystemExit, status: | |
2306 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2307 | # If the call was made with 0 or None exit status (sys.exit(0) | |
2307 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2308 | # or sys.exit() ), don't bother showing a traceback, as both of | |
2308 | # these are considered normal by the OS: |
|
2309 | # these are considered normal by the OS: | |
2309 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2310 | # > python -c'import sys;sys.exit(0)'; echo $? | |
2310 | # 0 |
|
2311 | # 0 | |
2311 | # > python -c'import sys;sys.exit()'; echo $? |
|
2312 | # > python -c'import sys;sys.exit()'; echo $? | |
2312 | # 0 |
|
2313 | # 0 | |
2313 | # For other exit status, we show the exception unless |
|
2314 | # For other exit status, we show the exception unless | |
2314 | # explicitly silenced, but only in short form. |
|
2315 | # explicitly silenced, but only in short form. | |
2315 | if kw['raise_exceptions']: |
|
2316 | if kw['raise_exceptions']: | |
2316 | raise |
|
2317 | raise | |
2317 | if status.code not in (0, None) and not kw['exit_ignore']: |
|
2318 | if status.code not in (0, None) and not kw['exit_ignore']: | |
2318 | self.showtraceback(exception_only=True) |
|
2319 | self.showtraceback(exception_only=True) | |
2319 | except: |
|
2320 | except: | |
2320 | if kw['raise_exceptions']: |
|
2321 | if kw['raise_exceptions']: | |
2321 | raise |
|
2322 | raise | |
2322 | self.showtraceback() |
|
2323 | self.showtraceback() | |
2323 |
|
2324 | |||
2324 | def safe_execfile_ipy(self, fname): |
|
2325 | def safe_execfile_ipy(self, fname): | |
2325 | """Like safe_execfile, but for .ipy files with IPython syntax. |
|
2326 | """Like safe_execfile, but for .ipy files with IPython syntax. | |
2326 |
|
2327 | |||
2327 | Parameters |
|
2328 | Parameters | |
2328 | ---------- |
|
2329 | ---------- | |
2329 | fname : str |
|
2330 | fname : str | |
2330 | The name of the file to execute. The filename must have a |
|
2331 | The name of the file to execute. The filename must have a | |
2331 | .ipy extension. |
|
2332 | .ipy extension. | |
2332 | """ |
|
2333 | """ | |
2333 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2334 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2334 |
|
2335 | |||
2335 | # Make sure we can open the file |
|
2336 | # Make sure we can open the file | |
2336 | try: |
|
2337 | try: | |
2337 | with open(fname) as thefile: |
|
2338 | with open(fname) as thefile: | |
2338 | pass |
|
2339 | pass | |
2339 | except: |
|
2340 | except: | |
2340 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2341 | warn('Could not open file <%s> for safe execution.' % fname) | |
2341 | return |
|
2342 | return | |
2342 |
|
2343 | |||
2343 | # Find things also in current directory. This is needed to mimic the |
|
2344 | # Find things also in current directory. This is needed to mimic the | |
2344 | # behavior of running a script from the system command line, where |
|
2345 | # behavior of running a script from the system command line, where | |
2345 | # Python inserts the script's directory into sys.path |
|
2346 | # Python inserts the script's directory into sys.path | |
2346 | dname = os.path.dirname(fname) |
|
2347 | dname = os.path.dirname(fname) | |
2347 |
|
2348 | |||
2348 | with prepended_to_syspath(dname): |
|
2349 | with prepended_to_syspath(dname): | |
2349 | try: |
|
2350 | try: | |
2350 | with open(fname) as thefile: |
|
2351 | with open(fname) as thefile: | |
2351 | # self.run_cell currently captures all exceptions |
|
2352 | # self.run_cell currently captures all exceptions | |
2352 | # raised in user code. It would be nice if there were |
|
2353 | # raised in user code. It would be nice if there were | |
2353 | # versions of runlines, execfile that did raise, so |
|
2354 | # versions of runlines, execfile that did raise, so | |
2354 | # we could catch the errors. |
|
2355 | # we could catch the errors. | |
2355 | self.run_cell(thefile.read(), store_history=False) |
|
2356 | self.run_cell(thefile.read(), store_history=False) | |
2356 | except: |
|
2357 | except: | |
2357 | self.showtraceback() |
|
2358 | self.showtraceback() | |
2358 | warn('Unknown failure executing file: <%s>' % fname) |
|
2359 | warn('Unknown failure executing file: <%s>' % fname) | |
2359 |
|
2360 | |||
2360 | def run_cell(self, raw_cell, store_history=False): |
|
2361 | def run_cell(self, raw_cell, store_history=False): | |
2361 | """Run a complete IPython cell. |
|
2362 | """Run a complete IPython cell. | |
2362 |
|
2363 | |||
2363 | Parameters |
|
2364 | Parameters | |
2364 | ---------- |
|
2365 | ---------- | |
2365 | raw_cell : str |
|
2366 | raw_cell : str | |
2366 | The code (including IPython code such as %magic functions) to run. |
|
2367 | The code (including IPython code such as %magic functions) to run. | |
2367 | store_history : bool |
|
2368 | store_history : bool | |
2368 | If True, the raw and translated cell will be stored in IPython's |
|
2369 | If True, the raw and translated cell will be stored in IPython's | |
2369 | history. For user code calling back into IPython's machinery, this |
|
2370 | history. For user code calling back into IPython's machinery, this | |
2370 | should be set to False. |
|
2371 | should be set to False. | |
2371 | """ |
|
2372 | """ | |
2372 | if (not raw_cell) or raw_cell.isspace(): |
|
2373 | if (not raw_cell) or raw_cell.isspace(): | |
2373 | return |
|
2374 | return | |
2374 |
|
2375 | |||
2375 | for line in raw_cell.splitlines(): |
|
2376 | for line in raw_cell.splitlines(): | |
2376 | self.input_splitter.push(line) |
|
2377 | self.input_splitter.push(line) | |
2377 | cell = self.input_splitter.source_reset() |
|
2378 | cell = self.input_splitter.source_reset() | |
2378 |
|
2379 | |||
2379 | with self.builtin_trap: |
|
2380 | with self.builtin_trap: | |
2380 | prefilter_failed = False |
|
2381 | prefilter_failed = False | |
2381 | if len(cell.splitlines()) == 1: |
|
2382 | if len(cell.splitlines()) == 1: | |
2382 | try: |
|
2383 | try: | |
2383 | # use prefilter_lines to handle trailing newlines |
|
2384 | # use prefilter_lines to handle trailing newlines | |
2384 | # restore trailing newline for ast.parse |
|
2385 | # restore trailing newline for ast.parse | |
2385 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
2386 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' | |
2386 | except AliasError as e: |
|
2387 | except AliasError as e: | |
2387 | error(e) |
|
2388 | error(e) | |
2388 | prefilter_failed = True |
|
2389 | prefilter_failed = True | |
2389 | except Exception: |
|
2390 | except Exception: | |
2390 | # don't allow prefilter errors to crash IPython |
|
2391 | # don't allow prefilter errors to crash IPython | |
2391 | self.showtraceback() |
|
2392 | self.showtraceback() | |
2392 | prefilter_failed = True |
|
2393 | prefilter_failed = True | |
2393 |
|
2394 | |||
2394 | # Store raw and processed history |
|
2395 | # Store raw and processed history | |
2395 | if store_history: |
|
2396 | if store_history: | |
2396 | self.history_manager.store_inputs(self.execution_count, |
|
2397 | self.history_manager.store_inputs(self.execution_count, | |
2397 | cell, raw_cell) |
|
2398 | cell, raw_cell) | |
2398 |
|
2399 | |||
2399 | self.logger.log(cell, raw_cell) |
|
2400 | self.logger.log(cell, raw_cell) | |
2400 |
|
2401 | |||
2401 | if not prefilter_failed: |
|
2402 | if not prefilter_failed: | |
2402 | # don't run if prefilter failed |
|
2403 | # don't run if prefilter failed | |
2403 | cell_name = self.compile.cache(cell, self.execution_count) |
|
2404 | cell_name = self.compile.cache(cell, self.execution_count) | |
2404 |
|
2405 | |||
2405 | with self.display_trap: |
|
2406 | with self.display_trap: | |
2406 | try: |
|
2407 | try: | |
2407 | code_ast = self.compile.ast_parse(cell, filename=cell_name) |
|
2408 | code_ast = self.compile.ast_parse(cell, filename=cell_name) | |
2408 | except IndentationError: |
|
2409 | except IndentationError: | |
2409 | self.showindentationerror() |
|
2410 | self.showindentationerror() | |
2410 | self.execution_count += 1 |
|
2411 | self.execution_count += 1 | |
2411 | return None |
|
2412 | return None | |
2412 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
2413 | except (OverflowError, SyntaxError, ValueError, TypeError, | |
2413 | MemoryError): |
|
2414 | MemoryError): | |
2414 | self.showsyntaxerror() |
|
2415 | self.showsyntaxerror() | |
2415 | self.execution_count += 1 |
|
2416 | self.execution_count += 1 | |
2416 | return None |
|
2417 | return None | |
2417 |
|
2418 | |||
2418 | self.run_ast_nodes(code_ast.body, cell_name, |
|
2419 | self.run_ast_nodes(code_ast.body, cell_name, | |
2419 | interactivity="last_expr") |
|
2420 | interactivity="last_expr") | |
2420 |
|
2421 | |||
2421 | # Execute any registered post-execution functions. |
|
2422 | # Execute any registered post-execution functions. | |
2422 | for func, status in self._post_execute.iteritems(): |
|
2423 | for func, status in self._post_execute.iteritems(): | |
2423 | if not status: |
|
2424 | if not status: | |
2424 | continue |
|
2425 | continue | |
2425 | try: |
|
2426 | try: | |
2426 | func() |
|
2427 | func() | |
2427 | except: |
|
2428 | except: | |
2428 | self.showtraceback() |
|
2429 | self.showtraceback() | |
2429 | # Deactivate failing function |
|
2430 | # Deactivate failing function | |
2430 | self._post_execute[func] = False |
|
2431 | self._post_execute[func] = False | |
2431 |
|
2432 | |||
2432 | if store_history: |
|
2433 | if store_history: | |
2433 | # Write output to the database. Does nothing unless |
|
2434 | # Write output to the database. Does nothing unless | |
2434 | # history output logging is enabled. |
|
2435 | # history output logging is enabled. | |
2435 | self.history_manager.store_output(self.execution_count) |
|
2436 | self.history_manager.store_output(self.execution_count) | |
2436 | # Each cell is a *single* input, regardless of how many lines it has |
|
2437 | # Each cell is a *single* input, regardless of how many lines it has | |
2437 | self.execution_count += 1 |
|
2438 | self.execution_count += 1 | |
2438 |
|
2439 | |||
2439 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'): |
|
2440 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'): | |
2440 | """Run a sequence of AST nodes. The execution mode depends on the |
|
2441 | """Run a sequence of AST nodes. The execution mode depends on the | |
2441 | interactivity parameter. |
|
2442 | interactivity parameter. | |
2442 |
|
2443 | |||
2443 | Parameters |
|
2444 | Parameters | |
2444 | ---------- |
|
2445 | ---------- | |
2445 | nodelist : list |
|
2446 | nodelist : list | |
2446 | A sequence of AST nodes to run. |
|
2447 | A sequence of AST nodes to run. | |
2447 | cell_name : str |
|
2448 | cell_name : str | |
2448 | Will be passed to the compiler as the filename of the cell. Typically |
|
2449 | Will be passed to the compiler as the filename of the cell. Typically | |
2449 | the value returned by ip.compile.cache(cell). |
|
2450 | the value returned by ip.compile.cache(cell). | |
2450 | interactivity : str |
|
2451 | interactivity : str | |
2451 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be |
|
2452 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be | |
2452 | run interactively (displaying output from expressions). 'last_expr' |
|
2453 | run interactively (displaying output from expressions). 'last_expr' | |
2453 | will run the last node interactively only if it is an expression (i.e. |
|
2454 | will run the last node interactively only if it is an expression (i.e. | |
2454 | expressions in loops or other blocks are not displayed. Other values |
|
2455 | expressions in loops or other blocks are not displayed. Other values | |
2455 | for this parameter will raise a ValueError. |
|
2456 | for this parameter will raise a ValueError. | |
2456 | """ |
|
2457 | """ | |
2457 | if not nodelist: |
|
2458 | if not nodelist: | |
2458 | return |
|
2459 | return | |
2459 |
|
2460 | |||
2460 | if interactivity == 'last_expr': |
|
2461 | if interactivity == 'last_expr': | |
2461 | if isinstance(nodelist[-1], ast.Expr): |
|
2462 | if isinstance(nodelist[-1], ast.Expr): | |
2462 | interactivity = "last" |
|
2463 | interactivity = "last" | |
2463 | else: |
|
2464 | else: | |
2464 | interactivity = "none" |
|
2465 | interactivity = "none" | |
2465 |
|
2466 | |||
2466 | if interactivity == 'none': |
|
2467 | if interactivity == 'none': | |
2467 | to_run_exec, to_run_interactive = nodelist, [] |
|
2468 | to_run_exec, to_run_interactive = nodelist, [] | |
2468 | elif interactivity == 'last': |
|
2469 | elif interactivity == 'last': | |
2469 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
2470 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] | |
2470 | elif interactivity == 'all': |
|
2471 | elif interactivity == 'all': | |
2471 | to_run_exec, to_run_interactive = [], nodelist |
|
2472 | to_run_exec, to_run_interactive = [], nodelist | |
2472 | else: |
|
2473 | else: | |
2473 | raise ValueError("Interactivity was %r" % interactivity) |
|
2474 | raise ValueError("Interactivity was %r" % interactivity) | |
2474 |
|
2475 | |||
2475 | exec_count = self.execution_count |
|
2476 | exec_count = self.execution_count | |
2476 |
|
2477 | |||
2477 | try: |
|
2478 | try: | |
2478 | for i, node in enumerate(to_run_exec): |
|
2479 | for i, node in enumerate(to_run_exec): | |
2479 | mod = ast.Module([node]) |
|
2480 | mod = ast.Module([node]) | |
2480 | code = self.compile(mod, cell_name, "exec") |
|
2481 | code = self.compile(mod, cell_name, "exec") | |
2481 | if self.run_code(code): |
|
2482 | if self.run_code(code): | |
2482 | return True |
|
2483 | return True | |
2483 |
|
2484 | |||
2484 | for i, node in enumerate(to_run_interactive): |
|
2485 | for i, node in enumerate(to_run_interactive): | |
2485 | mod = ast.Interactive([node]) |
|
2486 | mod = ast.Interactive([node]) | |
2486 | code = self.compile(mod, cell_name, "single") |
|
2487 | code = self.compile(mod, cell_name, "single") | |
2487 | if self.run_code(code): |
|
2488 | if self.run_code(code): | |
2488 | return True |
|
2489 | return True | |
2489 | except: |
|
2490 | except: | |
2490 | # It's possible to have exceptions raised here, typically by |
|
2491 | # It's possible to have exceptions raised here, typically by | |
2491 | # compilation of odd code (such as a naked 'return' outside a |
|
2492 | # compilation of odd code (such as a naked 'return' outside a | |
2492 | # function) that did parse but isn't valid. Typically the exception |
|
2493 | # function) that did parse but isn't valid. Typically the exception | |
2493 | # is a SyntaxError, but it's safest just to catch anything and show |
|
2494 | # is a SyntaxError, but it's safest just to catch anything and show | |
2494 | # the user a traceback. |
|
2495 | # the user a traceback. | |
2495 |
|
2496 | |||
2496 | # We do only one try/except outside the loop to minimize the impact |
|
2497 | # We do only one try/except outside the loop to minimize the impact | |
2497 | # on runtime, and also because if any node in the node list is |
|
2498 | # on runtime, and also because if any node in the node list is | |
2498 | # broken, we should stop execution completely. |
|
2499 | # broken, we should stop execution completely. | |
2499 | self.showtraceback() |
|
2500 | self.showtraceback() | |
2500 |
|
2501 | |||
2501 | return False |
|
2502 | return False | |
2502 |
|
2503 | |||
2503 | def run_code(self, code_obj): |
|
2504 | def run_code(self, code_obj): | |
2504 | """Execute a code object. |
|
2505 | """Execute a code object. | |
2505 |
|
2506 | |||
2506 | When an exception occurs, self.showtraceback() is called to display a |
|
2507 | When an exception occurs, self.showtraceback() is called to display a | |
2507 | traceback. |
|
2508 | traceback. | |
2508 |
|
2509 | |||
2509 | Parameters |
|
2510 | Parameters | |
2510 | ---------- |
|
2511 | ---------- | |
2511 | code_obj : code object |
|
2512 | code_obj : code object | |
2512 | A compiled code object, to be executed |
|
2513 | A compiled code object, to be executed | |
2513 | post_execute : bool [default: True] |
|
2514 | post_execute : bool [default: True] | |
2514 | whether to call post_execute hooks after this particular execution. |
|
2515 | whether to call post_execute hooks after this particular execution. | |
2515 |
|
2516 | |||
2516 | Returns |
|
2517 | Returns | |
2517 | ------- |
|
2518 | ------- | |
2518 | False : successful execution. |
|
2519 | False : successful execution. | |
2519 | True : an error occurred. |
|
2520 | True : an error occurred. | |
2520 | """ |
|
2521 | """ | |
2521 |
|
2522 | |||
2522 | # Set our own excepthook in case the user code tries to call it |
|
2523 | # Set our own excepthook in case the user code tries to call it | |
2523 | # directly, so that the IPython crash handler doesn't get triggered |
|
2524 | # directly, so that the IPython crash handler doesn't get triggered | |
2524 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2525 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook | |
2525 |
|
2526 | |||
2526 | # we save the original sys.excepthook in the instance, in case config |
|
2527 | # we save the original sys.excepthook in the instance, in case config | |
2527 | # code (such as magics) needs access to it. |
|
2528 | # code (such as magics) needs access to it. | |
2528 | self.sys_excepthook = old_excepthook |
|
2529 | self.sys_excepthook = old_excepthook | |
2529 | outflag = 1 # happens in more places, so it's easier as default |
|
2530 | outflag = 1 # happens in more places, so it's easier as default | |
2530 | try: |
|
2531 | try: | |
2531 | try: |
|
2532 | try: | |
2532 | self.hooks.pre_run_code_hook() |
|
2533 | self.hooks.pre_run_code_hook() | |
2533 | #rprint('Running code', repr(code_obj)) # dbg |
|
2534 | #rprint('Running code', repr(code_obj)) # dbg | |
2534 | exec code_obj in self.user_global_ns, self.user_ns |
|
2535 | exec code_obj in self.user_global_ns, self.user_ns | |
2535 | finally: |
|
2536 | finally: | |
2536 | # Reset our crash handler in place |
|
2537 | # Reset our crash handler in place | |
2537 | sys.excepthook = old_excepthook |
|
2538 | sys.excepthook = old_excepthook | |
2538 | except SystemExit: |
|
2539 | except SystemExit: | |
2539 | self.showtraceback(exception_only=True) |
|
2540 | self.showtraceback(exception_only=True) | |
2540 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1) |
|
2541 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1) | |
2541 | except self.custom_exceptions: |
|
2542 | except self.custom_exceptions: | |
2542 | etype,value,tb = sys.exc_info() |
|
2543 | etype,value,tb = sys.exc_info() | |
2543 | self.CustomTB(etype,value,tb) |
|
2544 | self.CustomTB(etype,value,tb) | |
2544 | except: |
|
2545 | except: | |
2545 | self.showtraceback() |
|
2546 | self.showtraceback() | |
2546 | else: |
|
2547 | else: | |
2547 | outflag = 0 |
|
2548 | outflag = 0 | |
2548 | if softspace(sys.stdout, 0): |
|
2549 | if softspace(sys.stdout, 0): | |
2549 |
|
2550 | |||
2550 |
|
2551 | |||
2551 | return outflag |
|
2552 | return outflag | |
2552 |
|
2553 | |||
2553 | # For backwards compatibility |
|
2554 | # For backwards compatibility | |
2554 | runcode = run_code |
|
2555 | runcode = run_code | |
2555 |
|
2556 | |||
2556 | #------------------------------------------------------------------------- |
|
2557 | #------------------------------------------------------------------------- | |
2557 | # Things related to GUI support and pylab |
|
2558 | # Things related to GUI support and pylab | |
2558 | #------------------------------------------------------------------------- |
|
2559 | #------------------------------------------------------------------------- | |
2559 |
|
2560 | |||
2560 | def enable_pylab(self, gui=None, import_all=True): |
|
2561 | def enable_pylab(self, gui=None, import_all=True): | |
2561 | raise NotImplementedError('Implement enable_pylab in a subclass') |
|
2562 | raise NotImplementedError('Implement enable_pylab in a subclass') | |
2562 |
|
2563 | |||
2563 | #------------------------------------------------------------------------- |
|
2564 | #------------------------------------------------------------------------- | |
2564 | # Utilities |
|
2565 | # Utilities | |
2565 | #------------------------------------------------------------------------- |
|
2566 | #------------------------------------------------------------------------- | |
2566 |
|
2567 | |||
2567 | def var_expand(self,cmd,depth=0): |
|
2568 | def var_expand(self,cmd,depth=0): | |
2568 | """Expand python variables in a string. |
|
2569 | """Expand python variables in a string. | |
2569 |
|
2570 | |||
2570 | The depth argument indicates how many frames above the caller should |
|
2571 | The depth argument indicates how many frames above the caller should | |
2571 | be walked to look for the local namespace where to expand variables. |
|
2572 | be walked to look for the local namespace where to expand variables. | |
2572 |
|
2573 | |||
2573 | The global namespace for expansion is always the user's interactive |
|
2574 | The global namespace for expansion is always the user's interactive | |
2574 | namespace. |
|
2575 | namespace. | |
2575 | """ |
|
2576 | """ | |
2576 | res = ItplNS(cmd, self.user_ns, # globals |
|
2577 | res = ItplNS(cmd, self.user_ns, # globals | |
2577 | # Skip our own frame in searching for locals: |
|
2578 | # Skip our own frame in searching for locals: | |
2578 | sys._getframe(depth+1).f_locals # locals |
|
2579 | sys._getframe(depth+1).f_locals # locals | |
2579 | ) |
|
2580 | ) | |
2580 | return py3compat.str_to_unicode(str(res), res.codec) |
|
2581 | return py3compat.str_to_unicode(str(res), res.codec) | |
2581 |
|
2582 | |||
2582 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
2583 | def mktempfile(self, data=None, prefix='ipython_edit_'): | |
2583 | """Make a new tempfile and return its filename. |
|
2584 | """Make a new tempfile and return its filename. | |
2584 |
|
2585 | |||
2585 | This makes a call to tempfile.mktemp, but it registers the created |
|
2586 | This makes a call to tempfile.mktemp, but it registers the created | |
2586 | filename internally so ipython cleans it up at exit time. |
|
2587 | filename internally so ipython cleans it up at exit time. | |
2587 |
|
2588 | |||
2588 | Optional inputs: |
|
2589 | Optional inputs: | |
2589 |
|
2590 | |||
2590 | - data(None): if data is given, it gets written out to the temp file |
|
2591 | - data(None): if data is given, it gets written out to the temp file | |
2591 | immediately, and the file is closed again.""" |
|
2592 | immediately, and the file is closed again.""" | |
2592 |
|
2593 | |||
2593 | filename = tempfile.mktemp('.py', prefix) |
|
2594 | filename = tempfile.mktemp('.py', prefix) | |
2594 | self.tempfiles.append(filename) |
|
2595 | self.tempfiles.append(filename) | |
2595 |
|
2596 | |||
2596 | if data: |
|
2597 | if data: | |
2597 | tmp_file = open(filename,'w') |
|
2598 | tmp_file = open(filename,'w') | |
2598 | tmp_file.write(data) |
|
2599 | tmp_file.write(data) | |
2599 | tmp_file.close() |
|
2600 | tmp_file.close() | |
2600 | return filename |
|
2601 | return filename | |
2601 |
|
2602 | |||
2602 | # TODO: This should be removed when Term is refactored. |
|
2603 | # TODO: This should be removed when Term is refactored. | |
2603 | def write(self,data): |
|
2604 | def write(self,data): | |
2604 | """Write a string to the default output""" |
|
2605 | """Write a string to the default output""" | |
2605 | io.stdout.write(data) |
|
2606 | io.stdout.write(data) | |
2606 |
|
2607 | |||
2607 | # TODO: This should be removed when Term is refactored. |
|
2608 | # TODO: This should be removed when Term is refactored. | |
2608 | def write_err(self,data): |
|
2609 | def write_err(self,data): | |
2609 | """Write a string to the default error output""" |
|
2610 | """Write a string to the default error output""" | |
2610 | io.stderr.write(data) |
|
2611 | io.stderr.write(data) | |
2611 |
|
2612 | |||
2612 | def ask_yes_no(self,prompt,default=True): |
|
2613 | def ask_yes_no(self,prompt,default=True): | |
2613 | if self.quiet: |
|
2614 | if self.quiet: | |
2614 | return True |
|
2615 | return True | |
2615 | return ask_yes_no(prompt,default) |
|
2616 | return ask_yes_no(prompt,default) | |
2616 |
|
2617 | |||
2617 | def show_usage(self): |
|
2618 | def show_usage(self): | |
2618 | """Show a usage message""" |
|
2619 | """Show a usage message""" | |
2619 | page.page(IPython.core.usage.interactive_usage) |
|
2620 | page.page(IPython.core.usage.interactive_usage) | |
2620 |
|
2621 | |||
2621 | def find_user_code(self, target, raw=True): |
|
2622 | def find_user_code(self, target, raw=True): | |
2622 | """Get a code string from history, file, or a string or macro. |
|
2623 | """Get a code string from history, file, or a string or macro. | |
2623 |
|
2624 | |||
2624 | This is mainly used by magic functions. |
|
2625 | This is mainly used by magic functions. | |
2625 |
|
2626 | |||
2626 | Parameters |
|
2627 | Parameters | |
2627 | ---------- |
|
2628 | ---------- | |
2628 | target : str |
|
2629 | target : str | |
2629 | A string specifying code to retrieve. This will be tried respectively |
|
2630 | A string specifying code to retrieve. This will be tried respectively | |
2630 | as: ranges of input history (see %history for syntax), a filename, or |
|
2631 | as: ranges of input history (see %history for syntax), a filename, or | |
2631 | an expression evaluating to a string or Macro in the user namespace. |
|
2632 | an expression evaluating to a string or Macro in the user namespace. | |
2632 | raw : bool |
|
2633 | raw : bool | |
2633 | If true (default), retrieve raw history. Has no effect on the other |
|
2634 | If true (default), retrieve raw history. Has no effect on the other | |
2634 | retrieval mechanisms. |
|
2635 | retrieval mechanisms. | |
2635 |
|
2636 | |||
2636 | Returns |
|
2637 | Returns | |
2637 | ------- |
|
2638 | ------- | |
2638 | A string of code. |
|
2639 | A string of code. | |
2639 |
|
2640 | |||
2640 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
2641 | ValueError is raised if nothing is found, and TypeError if it evaluates | |
2641 | to an object of another type. In each case, .args[0] is a printable |
|
2642 | to an object of another type. In each case, .args[0] is a printable | |
2642 | message. |
|
2643 | message. | |
2643 | """ |
|
2644 | """ | |
2644 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
2645 | code = self.extract_input_lines(target, raw=raw) # Grab history | |
2645 | if code: |
|
2646 | if code: | |
2646 | return code |
|
2647 | return code | |
2647 | if os.path.isfile(target): # Read file |
|
2648 | if os.path.isfile(target): # Read file | |
2648 | return open(target, "r").read() |
|
2649 | return open(target, "r").read() | |
2649 |
|
2650 | |||
2650 | try: # User namespace |
|
2651 | try: # User namespace | |
2651 | codeobj = eval(target, self.user_ns) |
|
2652 | codeobj = eval(target, self.user_ns) | |
2652 | except Exception: |
|
2653 | except Exception: | |
2653 | raise ValueError(("'%s' was not found in history, as a file, nor in" |
|
2654 | raise ValueError(("'%s' was not found in history, as a file, nor in" | |
2654 | " the user namespace.") % target) |
|
2655 | " the user namespace.") % target) | |
2655 | if isinstance(codeobj, basestring): |
|
2656 | if isinstance(codeobj, basestring): | |
2656 | return codeobj |
|
2657 | return codeobj | |
2657 | elif isinstance(codeobj, Macro): |
|
2658 | elif isinstance(codeobj, Macro): | |
2658 | return codeobj.value |
|
2659 | return codeobj.value | |
2659 |
|
2660 | |||
2660 | raise TypeError("%s is neither a string nor a macro." % target, |
|
2661 | raise TypeError("%s is neither a string nor a macro." % target, | |
2661 | codeobj) |
|
2662 | codeobj) | |
2662 |
|
2663 | |||
2663 | #------------------------------------------------------------------------- |
|
2664 | #------------------------------------------------------------------------- | |
2664 | # Things related to IPython exiting |
|
2665 | # Things related to IPython exiting | |
2665 | #------------------------------------------------------------------------- |
|
2666 | #------------------------------------------------------------------------- | |
2666 | def atexit_operations(self): |
|
2667 | def atexit_operations(self): | |
2667 | """This will be executed at the time of exit. |
|
2668 | """This will be executed at the time of exit. | |
2668 |
|
2669 | |||
2669 | Cleanup operations and saving of persistent data that is done |
|
2670 | Cleanup operations and saving of persistent data that is done | |
2670 | unconditionally by IPython should be performed here. |
|
2671 | unconditionally by IPython should be performed here. | |
2671 |
|
2672 | |||
2672 | For things that may depend on startup flags or platform specifics (such |
|
2673 | For things that may depend on startup flags or platform specifics (such | |
2673 | as having readline or not), register a separate atexit function in the |
|
2674 | as having readline or not), register a separate atexit function in the | |
2674 | code that has the appropriate information, rather than trying to |
|
2675 | code that has the appropriate information, rather than trying to | |
2675 | clutter |
|
2676 | clutter | |
2676 | """ |
|
2677 | """ | |
2677 | # Close the history session (this stores the end time and line count) |
|
2678 | # Close the history session (this stores the end time and line count) | |
2678 | # this must be *before* the tempfile cleanup, in case of temporary |
|
2679 | # this must be *before* the tempfile cleanup, in case of temporary | |
2679 | # history db |
|
2680 | # history db | |
2680 | self.history_manager.end_session() |
|
2681 | self.history_manager.end_session() | |
2681 |
|
2682 | |||
2682 | # Cleanup all tempfiles left around |
|
2683 | # Cleanup all tempfiles left around | |
2683 | for tfile in self.tempfiles: |
|
2684 | for tfile in self.tempfiles: | |
2684 | try: |
|
2685 | try: | |
2685 | os.unlink(tfile) |
|
2686 | os.unlink(tfile) | |
2686 | except OSError: |
|
2687 | except OSError: | |
2687 | pass |
|
2688 | pass | |
2688 |
|
2689 | |||
2689 | # Clear all user namespaces to release all references cleanly. |
|
2690 | # Clear all user namespaces to release all references cleanly. | |
2690 | self.reset(new_session=False) |
|
2691 | self.reset(new_session=False) | |
2691 |
|
2692 | |||
2692 | # Run user hooks |
|
2693 | # Run user hooks | |
2693 | self.hooks.shutdown_hook() |
|
2694 | self.hooks.shutdown_hook() | |
2694 |
|
2695 | |||
2695 | def cleanup(self): |
|
2696 | def cleanup(self): | |
2696 | self.restore_sys_module_state() |
|
2697 | self.restore_sys_module_state() | |
2697 |
|
2698 | |||
2698 |
|
2699 | |||
2699 | class InteractiveShellABC(object): |
|
2700 | class InteractiveShellABC(object): | |
2700 | """An abstract base class for InteractiveShell.""" |
|
2701 | """An abstract base class for InteractiveShell.""" | |
2701 | __metaclass__ = abc.ABCMeta |
|
2702 | __metaclass__ = abc.ABCMeta | |
2702 |
|
2703 | |||
2703 | InteractiveShellABC.register(InteractiveShell) |
|
2704 | InteractiveShellABC.register(InteractiveShell) |
General Comments 0
You need to be logged in to leave comments.
Login now