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