Show More
@@ -1,661 +1,661 b'' | |||
|
1 | 1 | """Analysis of text input into executable blocks. |
|
2 | 2 | |
|
3 | 3 | The main class in this module, :class:`InputSplitter`, is designed to break |
|
4 | 4 | input from either interactive, line-by-line environments or block-based ones, |
|
5 | 5 | into standalone blocks that can be executed by Python as 'single' statements |
|
6 | 6 | (thus triggering sys.displayhook). |
|
7 | 7 | |
|
8 | 8 | A companion, :class:`IPythonInputSplitter`, provides the same functionality but |
|
9 | 9 | with full support for the extended IPython syntax (magics, system calls, etc). |
|
10 | 10 | |
|
11 | 11 | For more details, see the class docstring below. |
|
12 | 12 | |
|
13 | 13 | Syntax Transformations |
|
14 | 14 | ---------------------- |
|
15 | 15 | |
|
16 | 16 | One of the main jobs of the code in this file is to apply all syntax |
|
17 | 17 | transformations that make up 'the IPython language', i.e. magics, shell |
|
18 | 18 | escapes, etc. All transformations should be implemented as *fully stateless* |
|
19 | 19 | entities, that simply take one line as their input and return a line. |
|
20 | 20 | Internally for implementation purposes they may be a normal function or a |
|
21 | 21 | callable object, but the only input they receive will be a single line and they |
|
22 | 22 | should only return a line, without holding any data-dependent state between |
|
23 | 23 | calls. |
|
24 | 24 | |
|
25 | 25 | As an example, the EscapedTransformer is a class so we can more clearly group |
|
26 | 26 | together the functionality of dispatching to individual functions based on the |
|
27 | 27 | starting escape character, but the only method for public use is its call |
|
28 | 28 | method. |
|
29 | 29 | |
|
30 | 30 | |
|
31 | 31 | ToDo |
|
32 | 32 | ---- |
|
33 | 33 | |
|
34 | 34 | - Should we make push() actually raise an exception once push_accepts_more() |
|
35 | 35 | returns False? |
|
36 | 36 | |
|
37 | 37 | - Naming cleanups. The tr_* names aren't the most elegant, though now they are |
|
38 | 38 | at least just attributes of a class so not really very exposed. |
|
39 | 39 | |
|
40 | 40 | - Think about the best way to support dynamic things: automagic, autocall, |
|
41 | 41 | macros, etc. |
|
42 | 42 | |
|
43 | 43 | - Think of a better heuristic for the application of the transforms in |
|
44 | 44 | IPythonInputSplitter.push() than looking at the buffer ending in ':'. Idea: |
|
45 | 45 | track indentation change events (indent, dedent, nothing) and apply them only |
|
46 | 46 | if the indentation went up, but not otherwise. |
|
47 | 47 | |
|
48 | 48 | - Think of the cleanest way for supporting user-specified transformations (the |
|
49 | 49 | user prefilters we had before). |
|
50 | 50 | |
|
51 | 51 | Authors |
|
52 | 52 | ------- |
|
53 | 53 | |
|
54 | 54 | * Fernando Perez |
|
55 | 55 | * Brian Granger |
|
56 | 56 | """ |
|
57 | 57 | #----------------------------------------------------------------------------- |
|
58 | 58 | # Copyright (C) 2010 The IPython Development Team |
|
59 | 59 | # |
|
60 | 60 | # Distributed under the terms of the BSD License. The full license is in |
|
61 | 61 | # the file COPYING, distributed as part of this software. |
|
62 | 62 | #----------------------------------------------------------------------------- |
|
63 | 63 | |
|
64 | 64 | #----------------------------------------------------------------------------- |
|
65 | 65 | # Imports |
|
66 | 66 | #----------------------------------------------------------------------------- |
|
67 | 67 | # stdlib |
|
68 | 68 | import ast |
|
69 | 69 | import codeop |
|
70 | 70 | import re |
|
71 | 71 | import sys |
|
72 | 72 | |
|
73 | 73 | # IPython modules |
|
74 | 74 | from IPython.utils.py3compat import cast_unicode |
|
75 | 75 | from IPython.core.inputtransformer import (leading_indent, |
|
76 | 76 | classic_prompt, |
|
77 | 77 | ipy_prompt, |
|
78 | 78 | strip_encoding_cookie, |
|
79 | 79 | cellmagic, |
|
80 | 80 | assemble_logical_lines, |
|
81 | 81 | help_end, |
|
82 | 82 | escaped_commands, |
|
83 | 83 | assign_from_magic, |
|
84 | 84 | assign_from_system, |
|
85 | 85 | assemble_python_lines, |
|
86 | 86 | ) |
|
87 | 87 | |
|
88 | 88 | # These are available in this module for backwards compatibility. |
|
89 | 89 | from IPython.core.inputtransformer import (ESC_SHELL, ESC_SH_CAP, ESC_HELP, |
|
90 | 90 | ESC_HELP2, ESC_MAGIC, ESC_MAGIC2, |
|
91 | 91 | ESC_QUOTE, ESC_QUOTE2, ESC_PAREN, ESC_SEQUENCES) |
|
92 | 92 | |
|
93 | 93 | #----------------------------------------------------------------------------- |
|
94 | 94 | # Utilities |
|
95 | 95 | #----------------------------------------------------------------------------- |
|
96 | 96 | |
|
97 | 97 | # FIXME: These are general-purpose utilities that later can be moved to the |
|
98 | 98 | # general ward. Kept here for now because we're being very strict about test |
|
99 | 99 | # coverage with this code, and this lets us ensure that we keep 100% coverage |
|
100 | 100 | # while developing. |
|
101 | 101 | |
|
102 | 102 | # compiled regexps for autoindent management |
|
103 | 103 | dedent_re = re.compile('|'.join([ |
|
104 | 104 | r'^\s+raise(\s.*)?$', # raise statement (+ space + other stuff, maybe) |
|
105 | 105 | r'^\s+raise\([^\)]*\).*$', # wacky raise with immediate open paren |
|
106 | 106 | r'^\s+return(\s.*)?$', # normal return (+ space + other stuff, maybe) |
|
107 | 107 | r'^\s+return\([^\)]*\).*$', # wacky return with immediate open paren |
|
108 | 108 | r'^\s+pass\s*$', # pass (optionally followed by trailing spaces) |
|
109 | 109 | r'^\s+break\s*$', # break (optionally followed by trailing spaces) |
|
110 | 110 | r'^\s+continue\s*$', # continue (optionally followed by trailing spaces) |
|
111 | 111 | ])) |
|
112 | 112 | ini_spaces_re = re.compile(r'^([ \t\r\f\v]+)') |
|
113 | 113 | |
|
114 | 114 | # regexp to match pure comment lines so we don't accidentally insert 'if 1:' |
|
115 | 115 | # before pure comments |
|
116 | 116 | comment_line_re = re.compile('^\s*\#') |
|
117 | 117 | |
|
118 | 118 | |
|
119 | 119 | def num_ini_spaces(s): |
|
120 | 120 | """Return the number of initial spaces in a string. |
|
121 | 121 | |
|
122 | 122 | Note that tabs are counted as a single space. For now, we do *not* support |
|
123 | 123 | mixing of tabs and spaces in the user's input. |
|
124 | 124 | |
|
125 | 125 | Parameters |
|
126 | 126 | ---------- |
|
127 | 127 | s : string |
|
128 | 128 | |
|
129 | 129 | Returns |
|
130 | 130 | ------- |
|
131 | 131 | n : int |
|
132 | 132 | """ |
|
133 | 133 | |
|
134 | 134 | ini_spaces = ini_spaces_re.match(s) |
|
135 | 135 | if ini_spaces: |
|
136 | 136 | return ini_spaces.end() |
|
137 | 137 | else: |
|
138 | 138 | return 0 |
|
139 | 139 | |
|
140 | 140 | def last_blank(src): |
|
141 | 141 | """Determine if the input source ends in a blank. |
|
142 | 142 | |
|
143 | 143 | A blank is either a newline or a line consisting of whitespace. |
|
144 | 144 | |
|
145 | 145 | Parameters |
|
146 | 146 | ---------- |
|
147 | 147 | src : string |
|
148 | 148 | A single or multiline string. |
|
149 | 149 | """ |
|
150 | 150 | if not src: return False |
|
151 | 151 | ll = src.splitlines()[-1] |
|
152 | 152 | return (ll == '') or ll.isspace() |
|
153 | 153 | |
|
154 | 154 | |
|
155 | 155 | last_two_blanks_re = re.compile(r'\n\s*\n\s*$', re.MULTILINE) |
|
156 | 156 | last_two_blanks_re2 = re.compile(r'.+\n\s*\n\s+$', re.MULTILINE) |
|
157 | 157 | |
|
158 | 158 | def last_two_blanks(src): |
|
159 | 159 | """Determine if the input source ends in two blanks. |
|
160 | 160 | |
|
161 | 161 | A blank is either a newline or a line consisting of whitespace. |
|
162 | 162 | |
|
163 | 163 | Parameters |
|
164 | 164 | ---------- |
|
165 | 165 | src : string |
|
166 | 166 | A single or multiline string. |
|
167 | 167 | """ |
|
168 | 168 | if not src: return False |
|
169 | 169 | # The logic here is tricky: I couldn't get a regexp to work and pass all |
|
170 | 170 | # the tests, so I took a different approach: split the source by lines, |
|
171 | 171 | # grab the last two and prepend '###\n' as a stand-in for whatever was in |
|
172 | 172 | # the body before the last two lines. Then, with that structure, it's |
|
173 | 173 | # possible to analyze with two regexps. Not the most elegant solution, but |
|
174 | 174 | # it works. If anyone tries to change this logic, make sure to validate |
|
175 | 175 | # the whole test suite first! |
|
176 | 176 | new_src = '\n'.join(['###\n'] + src.splitlines()[-2:]) |
|
177 | 177 | return (bool(last_two_blanks_re.match(new_src)) or |
|
178 | 178 | bool(last_two_blanks_re2.match(new_src)) ) |
|
179 | 179 | |
|
180 | 180 | |
|
181 | 181 | def remove_comments(src): |
|
182 | 182 | """Remove all comments from input source. |
|
183 | 183 | |
|
184 | 184 | Note: comments are NOT recognized inside of strings! |
|
185 | 185 | |
|
186 | 186 | Parameters |
|
187 | 187 | ---------- |
|
188 | 188 | src : string |
|
189 | 189 | A single or multiline input string. |
|
190 | 190 | |
|
191 | 191 | Returns |
|
192 | 192 | ------- |
|
193 | 193 | String with all Python comments removed. |
|
194 | 194 | """ |
|
195 | 195 | |
|
196 | 196 | return re.sub('#.*', '', src) |
|
197 | 197 | |
|
198 | 198 | |
|
199 | 199 | def get_input_encoding(): |
|
200 | 200 | """Return the default standard input encoding. |
|
201 | 201 | |
|
202 | 202 | If sys.stdin has no encoding, 'ascii' is returned.""" |
|
203 | 203 | # There are strange environments for which sys.stdin.encoding is None. We |
|
204 | 204 | # ensure that a valid encoding is returned. |
|
205 | 205 | encoding = getattr(sys.stdin, 'encoding', None) |
|
206 | 206 | if encoding is None: |
|
207 | 207 | encoding = 'ascii' |
|
208 | 208 | return encoding |
|
209 | 209 | |
|
210 | 210 | #----------------------------------------------------------------------------- |
|
211 | 211 | # Classes and functions for normal Python syntax handling |
|
212 | 212 | #----------------------------------------------------------------------------- |
|
213 | 213 | |
|
214 | 214 | class InputSplitter(object): |
|
215 | """An object that can accumulate lines of Python source before execution. | |
|
215 | r"""An object that can accumulate lines of Python source before execution. | |
|
216 | 216 | |
|
217 | 217 | This object is designed to be fed python source line-by-line, using |
|
218 |
|
|
|
219 |
|
|
|
220 |
|
|
|
221 |
|
|
|
218 | :meth:`push`. It will return on each push whether the currently pushed | |
|
219 | code could be executed already. In addition, it provides a method called | |
|
220 | :meth:`push_accepts_more` that can be used to query whether more input | |
|
221 | can be pushed into a single interactive block. | |
|
222 | 222 | |
|
223 | 223 | This is a simple example of how an interactive terminal-based client can use |
|
224 | 224 | this tool:: |
|
225 | 225 | |
|
226 | 226 | isp = InputSplitter() |
|
227 | 227 | while isp.push_accepts_more(): |
|
228 | 228 | indent = ' '*isp.indent_spaces |
|
229 | 229 | prompt = '>>> ' + indent |
|
230 | 230 | line = indent + raw_input(prompt) |
|
231 | 231 | isp.push(line) |
|
232 | 232 | print 'Input source was:\n', isp.source_reset(), |
|
233 | 233 | """ |
|
234 | 234 | # Number of spaces of indentation computed from input that has been pushed |
|
235 | 235 | # so far. This is the attributes callers should query to get the current |
|
236 | 236 | # indentation level, in order to provide auto-indent facilities. |
|
237 | 237 | indent_spaces = 0 |
|
238 | 238 | # String, indicating the default input encoding. It is computed by default |
|
239 | 239 | # at initialization time via get_input_encoding(), but it can be reset by a |
|
240 | 240 | # client with specific knowledge of the encoding. |
|
241 | 241 | encoding = '' |
|
242 | 242 | # String where the current full source input is stored, properly encoded. |
|
243 | 243 | # Reading this attribute is the normal way of querying the currently pushed |
|
244 | 244 | # source code, that has been properly encoded. |
|
245 | 245 | source = '' |
|
246 | 246 | # Code object corresponding to the current source. It is automatically |
|
247 | 247 | # synced to the source, so it can be queried at any time to obtain the code |
|
248 | 248 | # object; it will be None if the source doesn't compile to valid Python. |
|
249 | 249 | code = None |
|
250 | 250 | |
|
251 | 251 | # Private attributes |
|
252 | 252 | |
|
253 | 253 | # List with lines of input accumulated so far |
|
254 | 254 | _buffer = None |
|
255 | 255 | # Command compiler |
|
256 | 256 | _compile = None |
|
257 | 257 | # Mark when input has changed indentation all the way back to flush-left |
|
258 | 258 | _full_dedent = False |
|
259 | 259 | # Boolean indicating whether the current block is complete |
|
260 | 260 | _is_complete = None |
|
261 | 261 | |
|
262 | 262 | def __init__(self): |
|
263 | 263 | """Create a new InputSplitter instance. |
|
264 | 264 | """ |
|
265 | 265 | self._buffer = [] |
|
266 | 266 | self._compile = codeop.CommandCompiler() |
|
267 | 267 | self.encoding = get_input_encoding() |
|
268 | 268 | |
|
269 | 269 | def reset(self): |
|
270 | 270 | """Reset the input buffer and associated state.""" |
|
271 | 271 | self.indent_spaces = 0 |
|
272 | 272 | self._buffer[:] = [] |
|
273 | 273 | self.source = '' |
|
274 | 274 | self.code = None |
|
275 | 275 | self._is_complete = False |
|
276 | 276 | self._full_dedent = False |
|
277 | 277 | |
|
278 | 278 | def source_reset(self): |
|
279 | 279 | """Return the input source and perform a full reset. |
|
280 | 280 | """ |
|
281 | 281 | out = self.source |
|
282 | 282 | self.reset() |
|
283 | 283 | return out |
|
284 | 284 | |
|
285 | 285 | def push(self, lines): |
|
286 | 286 | """Push one or more lines of input. |
|
287 | 287 | |
|
288 | 288 | This stores the given lines and returns a status code indicating |
|
289 | 289 | whether the code forms a complete Python block or not. |
|
290 | 290 | |
|
291 | 291 | Any exceptions generated in compilation are swallowed, but if an |
|
292 | 292 | exception was produced, the method returns True. |
|
293 | 293 | |
|
294 | 294 | Parameters |
|
295 | 295 | ---------- |
|
296 | 296 | lines : string |
|
297 | 297 | One or more lines of Python input. |
|
298 | 298 | |
|
299 | 299 | Returns |
|
300 | 300 | ------- |
|
301 | 301 | is_complete : boolean |
|
302 | 302 | True if the current input source (the result of the current input |
|
303 | 303 | plus prior inputs) forms a complete Python execution block. Note that |
|
304 | 304 | this value is also stored as a private attribute (``_is_complete``), so it |
|
305 | 305 | can be queried at any time. |
|
306 | 306 | """ |
|
307 | 307 | self._store(lines) |
|
308 | 308 | source = self.source |
|
309 | 309 | |
|
310 | 310 | # Before calling _compile(), reset the code object to None so that if an |
|
311 | 311 | # exception is raised in compilation, we don't mislead by having |
|
312 | 312 | # inconsistent code/source attributes. |
|
313 | 313 | self.code, self._is_complete = None, None |
|
314 | 314 | |
|
315 | 315 | # Honor termination lines properly |
|
316 | 316 | if source.endswith('\\\n'): |
|
317 | 317 | return False |
|
318 | 318 | |
|
319 | 319 | self._update_indent(lines) |
|
320 | 320 | try: |
|
321 | 321 | self.code = self._compile(source, symbol="exec") |
|
322 | 322 | # Invalid syntax can produce any of a number of different errors from |
|
323 | 323 | # inside the compiler, so we have to catch them all. Syntax errors |
|
324 | 324 | # immediately produce a 'ready' block, so the invalid Python can be |
|
325 | 325 | # sent to the kernel for evaluation with possible ipython |
|
326 | 326 | # special-syntax conversion. |
|
327 | 327 | except (SyntaxError, OverflowError, ValueError, TypeError, |
|
328 | 328 | MemoryError): |
|
329 | 329 | self._is_complete = True |
|
330 | 330 | else: |
|
331 | 331 | # Compilation didn't produce any exceptions (though it may not have |
|
332 | 332 | # given a complete code object) |
|
333 | 333 | self._is_complete = self.code is not None |
|
334 | 334 | |
|
335 | 335 | return self._is_complete |
|
336 | 336 | |
|
337 | 337 | def push_accepts_more(self): |
|
338 | 338 | """Return whether a block of interactive input can accept more input. |
|
339 | 339 | |
|
340 | 340 | This method is meant to be used by line-oriented frontends, who need to |
|
341 | 341 | guess whether a block is complete or not based solely on prior and |
|
342 | 342 | current input lines. The InputSplitter considers it has a complete |
|
343 | 343 | interactive block and will not accept more input when either: |
|
344 | 344 | |
|
345 | 345 | * A SyntaxError is raised |
|
346 | 346 | |
|
347 | 347 | * The code is complete and consists of a single line or a single |
|
348 | 348 | non-compound statement |
|
349 | 349 | |
|
350 | 350 | * The code is complete and has a blank line at the end |
|
351 | 351 | |
|
352 | 352 | If the current input produces a syntax error, this method immediately |
|
353 | 353 | returns False but does *not* raise the syntax error exception, as |
|
354 | 354 | typically clients will want to send invalid syntax to an execution |
|
355 | 355 | backend which might convert the invalid syntax into valid Python via |
|
356 | 356 | one of the dynamic IPython mechanisms. |
|
357 | 357 | """ |
|
358 | 358 | |
|
359 | 359 | # With incomplete input, unconditionally accept more |
|
360 | 360 | # A syntax error also sets _is_complete to True - see push() |
|
361 | 361 | if not self._is_complete: |
|
362 | 362 | #print("Not complete") # debug |
|
363 | 363 | return True |
|
364 | 364 | |
|
365 | 365 | # The user can make any (complete) input execute by leaving a blank line |
|
366 | 366 | last_line = self.source.splitlines()[-1] |
|
367 | 367 | if (not last_line) or last_line.isspace(): |
|
368 | 368 | #print("Blank line") # debug |
|
369 | 369 | return False |
|
370 | 370 | |
|
371 | 371 | # If there's just a single line or AST node, and we're flush left, as is |
|
372 | 372 | # the case after a simple statement such as 'a=1', we want to execute it |
|
373 | 373 | # straight away. |
|
374 | 374 | if self.indent_spaces==0: |
|
375 | 375 | if len(self.source.splitlines()) <= 1: |
|
376 | 376 | return False |
|
377 | 377 | |
|
378 | 378 | try: |
|
379 | 379 | code_ast = ast.parse(u''.join(self._buffer)) |
|
380 | 380 | except Exception: |
|
381 | 381 | #print("Can't parse AST") # debug |
|
382 | 382 | return False |
|
383 | 383 | else: |
|
384 | 384 | if len(code_ast.body) == 1 and \ |
|
385 | 385 | not hasattr(code_ast.body[0], 'body'): |
|
386 | 386 | #print("Simple statement") # debug |
|
387 | 387 | return False |
|
388 | 388 | |
|
389 | 389 | # General fallback - accept more code |
|
390 | 390 | return True |
|
391 | 391 | |
|
392 | 392 | #------------------------------------------------------------------------ |
|
393 | 393 | # Private interface |
|
394 | 394 | #------------------------------------------------------------------------ |
|
395 | 395 | |
|
396 | 396 | def _find_indent(self, line): |
|
397 | 397 | """Compute the new indentation level for a single line. |
|
398 | 398 | |
|
399 | 399 | Parameters |
|
400 | 400 | ---------- |
|
401 | 401 | line : str |
|
402 | 402 | A single new line of non-whitespace, non-comment Python input. |
|
403 | 403 | |
|
404 | 404 | Returns |
|
405 | 405 | ------- |
|
406 | 406 | indent_spaces : int |
|
407 | 407 | New value for the indent level (it may be equal to self.indent_spaces |
|
408 | 408 | if indentation doesn't change. |
|
409 | 409 | |
|
410 | 410 | full_dedent : boolean |
|
411 | 411 | Whether the new line causes a full flush-left dedent. |
|
412 | 412 | """ |
|
413 | 413 | indent_spaces = self.indent_spaces |
|
414 | 414 | full_dedent = self._full_dedent |
|
415 | 415 | |
|
416 | 416 | inisp = num_ini_spaces(line) |
|
417 | 417 | if inisp < indent_spaces: |
|
418 | 418 | indent_spaces = inisp |
|
419 | 419 | if indent_spaces <= 0: |
|
420 | 420 | #print 'Full dedent in text',self.source # dbg |
|
421 | 421 | full_dedent = True |
|
422 | 422 | |
|
423 | 423 | if line.rstrip()[-1] == ':': |
|
424 | 424 | indent_spaces += 4 |
|
425 | 425 | elif dedent_re.match(line): |
|
426 | 426 | indent_spaces -= 4 |
|
427 | 427 | if indent_spaces <= 0: |
|
428 | 428 | full_dedent = True |
|
429 | 429 | |
|
430 | 430 | # Safety |
|
431 | 431 | if indent_spaces < 0: |
|
432 | 432 | indent_spaces = 0 |
|
433 | 433 | #print 'safety' # dbg |
|
434 | 434 | |
|
435 | 435 | return indent_spaces, full_dedent |
|
436 | 436 | |
|
437 | 437 | def _update_indent(self, lines): |
|
438 | 438 | for line in remove_comments(lines).splitlines(): |
|
439 | 439 | if line and not line.isspace(): |
|
440 | 440 | self.indent_spaces, self._full_dedent = self._find_indent(line) |
|
441 | 441 | |
|
442 | 442 | def _store(self, lines, buffer=None, store='source'): |
|
443 | 443 | """Store one or more lines of input. |
|
444 | 444 | |
|
445 | 445 | If input lines are not newline-terminated, a newline is automatically |
|
446 | 446 | appended.""" |
|
447 | 447 | |
|
448 | 448 | if buffer is None: |
|
449 | 449 | buffer = self._buffer |
|
450 | 450 | |
|
451 | 451 | if lines.endswith('\n'): |
|
452 | 452 | buffer.append(lines) |
|
453 | 453 | else: |
|
454 | 454 | buffer.append(lines+'\n') |
|
455 | 455 | setattr(self, store, self._set_source(buffer)) |
|
456 | 456 | |
|
457 | 457 | def _set_source(self, buffer): |
|
458 | 458 | return u''.join(buffer) |
|
459 | 459 | |
|
460 | 460 | |
|
461 | 461 | class IPythonInputSplitter(InputSplitter): |
|
462 | 462 | """An input splitter that recognizes all of IPython's special syntax.""" |
|
463 | 463 | |
|
464 | 464 | # String with raw, untransformed input. |
|
465 | 465 | source_raw = '' |
|
466 | 466 | |
|
467 | 467 | # Flag to track when a transformer has stored input that it hasn't given |
|
468 | 468 | # back yet. |
|
469 | 469 | transformer_accumulating = False |
|
470 | 470 | |
|
471 | 471 | # Flag to track when assemble_python_lines has stored input that it hasn't |
|
472 | 472 | # given back yet. |
|
473 | 473 | within_python_line = False |
|
474 | 474 | |
|
475 | 475 | # Private attributes |
|
476 | 476 | |
|
477 | 477 | # List with lines of raw input accumulated so far. |
|
478 | 478 | _buffer_raw = None |
|
479 | 479 | |
|
480 | 480 | def __init__(self, line_input_checker=True, physical_line_transforms=None, |
|
481 | 481 | logical_line_transforms=None, python_line_transforms=None): |
|
482 | 482 | super(IPythonInputSplitter, self).__init__() |
|
483 | 483 | self._buffer_raw = [] |
|
484 | 484 | self._validate = True |
|
485 | 485 | |
|
486 | 486 | if physical_line_transforms is not None: |
|
487 | 487 | self.physical_line_transforms = physical_line_transforms |
|
488 | 488 | else: |
|
489 | 489 | self.physical_line_transforms = [ |
|
490 | 490 | leading_indent(), |
|
491 | 491 | classic_prompt(), |
|
492 | 492 | ipy_prompt(), |
|
493 | 493 | strip_encoding_cookie(), |
|
494 | 494 | cellmagic(end_on_blank_line=line_input_checker), |
|
495 | 495 | ] |
|
496 | 496 | |
|
497 | 497 | self.assemble_logical_lines = assemble_logical_lines() |
|
498 | 498 | if logical_line_transforms is not None: |
|
499 | 499 | self.logical_line_transforms = logical_line_transforms |
|
500 | 500 | else: |
|
501 | 501 | self.logical_line_transforms = [ |
|
502 | 502 | help_end(), |
|
503 | 503 | escaped_commands(), |
|
504 | 504 | assign_from_magic(), |
|
505 | 505 | assign_from_system(), |
|
506 | 506 | ] |
|
507 | 507 | |
|
508 | 508 | self.assemble_python_lines = assemble_python_lines() |
|
509 | 509 | if python_line_transforms is not None: |
|
510 | 510 | self.python_line_transforms = python_line_transforms |
|
511 | 511 | else: |
|
512 | 512 | # We don't use any of these at present |
|
513 | 513 | self.python_line_transforms = [] |
|
514 | 514 | |
|
515 | 515 | @property |
|
516 | 516 | def transforms(self): |
|
517 | 517 | "Quick access to all transformers." |
|
518 | 518 | return self.physical_line_transforms + \ |
|
519 | 519 | [self.assemble_logical_lines] + self.logical_line_transforms + \ |
|
520 | 520 | [self.assemble_python_lines] + self.python_line_transforms |
|
521 | 521 | |
|
522 | 522 | @property |
|
523 | 523 | def transforms_in_use(self): |
|
524 | 524 | """Transformers, excluding logical line transformers if we're in a |
|
525 | 525 | Python line.""" |
|
526 | 526 | t = self.physical_line_transforms[:] |
|
527 | 527 | if not self.within_python_line: |
|
528 | 528 | t += [self.assemble_logical_lines] + self.logical_line_transforms |
|
529 | 529 | return t + [self.assemble_python_lines] + self.python_line_transforms |
|
530 | 530 | |
|
531 | 531 | def reset(self): |
|
532 | 532 | """Reset the input buffer and associated state.""" |
|
533 | 533 | super(IPythonInputSplitter, self).reset() |
|
534 | 534 | self._buffer_raw[:] = [] |
|
535 | 535 | self.source_raw = '' |
|
536 | 536 | self.transformer_accumulating = False |
|
537 | 537 | self.within_python_line = False |
|
538 | 538 | for t in self.transforms: |
|
539 | 539 | t.reset() |
|
540 | 540 | |
|
541 | 541 | def flush_transformers(self): |
|
542 | 542 | def _flush(transform, out): |
|
543 | 543 | if out is not None: |
|
544 | 544 | tmp = transform.push(out) |
|
545 | 545 | return tmp or transform.reset() or None |
|
546 | 546 | else: |
|
547 | 547 | return transform.reset() or None |
|
548 | 548 | |
|
549 | 549 | out = None |
|
550 | 550 | for t in self.transforms_in_use: |
|
551 | 551 | out = _flush(t, out) |
|
552 | 552 | |
|
553 | 553 | if out is not None: |
|
554 | 554 | self._store(out) |
|
555 | 555 | |
|
556 | 556 | def source_raw_reset(self): |
|
557 | 557 | """Return input and raw source and perform a full reset. |
|
558 | 558 | """ |
|
559 | 559 | self.flush_transformers() |
|
560 | 560 | out = self.source |
|
561 | 561 | out_r = self.source_raw |
|
562 | 562 | self.reset() |
|
563 | 563 | return out, out_r |
|
564 | 564 | |
|
565 | 565 | def source_reset(self): |
|
566 | 566 | self.flush_transformers() |
|
567 | 567 | return super(IPythonInputSplitter, self).source_reset() |
|
568 | 568 | |
|
569 | 569 | def push_accepts_more(self): |
|
570 | 570 | if self.transformer_accumulating: |
|
571 | 571 | return True |
|
572 | 572 | else: |
|
573 | 573 | return super(IPythonInputSplitter, self).push_accepts_more() |
|
574 | 574 | |
|
575 | 575 | def transform_cell(self, cell): |
|
576 | 576 | """Process and translate a cell of input. |
|
577 | 577 | """ |
|
578 | 578 | self.reset() |
|
579 | 579 | self.push(cell) |
|
580 | 580 | return self.source_reset() |
|
581 | 581 | |
|
582 | 582 | def push(self, lines): |
|
583 | 583 | """Push one or more lines of IPython input. |
|
584 | 584 | |
|
585 | 585 | This stores the given lines and returns a status code indicating |
|
586 | 586 | whether the code forms a complete Python block or not, after processing |
|
587 | 587 | all input lines for special IPython syntax. |
|
588 | 588 | |
|
589 | 589 | Any exceptions generated in compilation are swallowed, but if an |
|
590 | 590 | exception was produced, the method returns True. |
|
591 | 591 | |
|
592 | 592 | Parameters |
|
593 | 593 | ---------- |
|
594 | 594 | lines : string |
|
595 | 595 | One or more lines of Python input. |
|
596 | 596 | |
|
597 | 597 | Returns |
|
598 | 598 | ------- |
|
599 | 599 | is_complete : boolean |
|
600 | 600 | True if the current input source (the result of the current input |
|
601 | 601 | plus prior inputs) forms a complete Python execution block. Note that |
|
602 | 602 | this value is also stored as a private attribute (_is_complete), so it |
|
603 | 603 | can be queried at any time. |
|
604 | 604 | """ |
|
605 | 605 | |
|
606 | 606 | # We must ensure all input is pure unicode |
|
607 | 607 | lines = cast_unicode(lines, self.encoding) |
|
608 | 608 | |
|
609 | 609 | # ''.splitlines() --> [], but we need to push the empty line to transformers |
|
610 | 610 | lines_list = lines.splitlines() |
|
611 | 611 | if not lines_list: |
|
612 | 612 | lines_list = [''] |
|
613 | 613 | |
|
614 | 614 | # Store raw source before applying any transformations to it. Note |
|
615 | 615 | # that this must be done *after* the reset() call that would otherwise |
|
616 | 616 | # flush the buffer. |
|
617 | 617 | self._store(lines, self._buffer_raw, 'source_raw') |
|
618 | 618 | |
|
619 | 619 | for line in lines_list: |
|
620 | 620 | out = self.push_line(line) |
|
621 | 621 | |
|
622 | 622 | return out |
|
623 | 623 | |
|
624 | 624 | def push_line(self, line): |
|
625 | 625 | buf = self._buffer |
|
626 | 626 | |
|
627 | 627 | def _accumulating(dbg): |
|
628 | 628 | #print(dbg) |
|
629 | 629 | self.transformer_accumulating = True |
|
630 | 630 | return False |
|
631 | 631 | |
|
632 | 632 | for transformer in self.physical_line_transforms: |
|
633 | 633 | line = transformer.push(line) |
|
634 | 634 | if line is None: |
|
635 | 635 | return _accumulating(transformer) |
|
636 | 636 | |
|
637 | 637 | if not self.within_python_line: |
|
638 | 638 | line = self.assemble_logical_lines.push(line) |
|
639 | 639 | if line is None: |
|
640 | 640 | return _accumulating('acc logical line') |
|
641 | 641 | |
|
642 | 642 | for transformer in self.logical_line_transforms: |
|
643 | 643 | line = transformer.push(line) |
|
644 | 644 | if line is None: |
|
645 | 645 | return _accumulating(transformer) |
|
646 | 646 | |
|
647 | 647 | line = self.assemble_python_lines.push(line) |
|
648 | 648 | if line is None: |
|
649 | 649 | self.within_python_line = True |
|
650 | 650 | return _accumulating('acc python line') |
|
651 | 651 | else: |
|
652 | 652 | self.within_python_line = False |
|
653 | 653 | |
|
654 | 654 | for transformer in self.python_line_transforms: |
|
655 | 655 | line = transformer.push(line) |
|
656 | 656 | if line is None: |
|
657 | 657 | return _accumulating(transformer) |
|
658 | 658 | |
|
659 | 659 | #print("transformers clear") #debug |
|
660 | 660 | self.transformer_accumulating = False |
|
661 | 661 | return super(IPythonInputSplitter, self).push(line) |
@@ -1,3168 +1,3168 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 absolute_import |
|
18 | 18 | from __future__ import print_function |
|
19 | 19 | |
|
20 | 20 | import __future__ |
|
21 | 21 | import abc |
|
22 | 22 | import ast |
|
23 | 23 | import atexit |
|
24 | 24 | import functools |
|
25 | 25 | import os |
|
26 | 26 | import re |
|
27 | 27 | import runpy |
|
28 | 28 | import sys |
|
29 | 29 | import tempfile |
|
30 | 30 | import types |
|
31 | 31 | import subprocess |
|
32 | 32 | from io import open as io_open |
|
33 | 33 | |
|
34 | 34 | from IPython.config.configurable import SingletonConfigurable |
|
35 | 35 | from IPython.core import debugger, oinspect |
|
36 | 36 | from IPython.core import magic |
|
37 | 37 | from IPython.core import page |
|
38 | 38 | from IPython.core import prefilter |
|
39 | 39 | from IPython.core import shadowns |
|
40 | 40 | from IPython.core import ultratb |
|
41 | 41 | from IPython.core.alias import AliasManager, AliasError |
|
42 | 42 | from IPython.core.autocall import ExitAutocall |
|
43 | 43 | from IPython.core.builtin_trap import BuiltinTrap |
|
44 | 44 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython |
|
45 | 45 | from IPython.core.display_trap import DisplayTrap |
|
46 | 46 | from IPython.core.displayhook import DisplayHook |
|
47 | 47 | from IPython.core.displaypub import DisplayPublisher |
|
48 | 48 | from IPython.core.error import UsageError |
|
49 | 49 | from IPython.core.extensions import ExtensionManager |
|
50 | 50 | from IPython.core.formatters import DisplayFormatter |
|
51 | 51 | from IPython.core.history import HistoryManager |
|
52 | 52 | from IPython.core.inputsplitter import IPythonInputSplitter, ESC_MAGIC, ESC_MAGIC2 |
|
53 | 53 | from IPython.core.logger import Logger |
|
54 | 54 | from IPython.core.macro import Macro |
|
55 | 55 | from IPython.core.payload import PayloadManager |
|
56 | 56 | from IPython.core.prefilter import PrefilterManager |
|
57 | 57 | from IPython.core.profiledir import ProfileDir |
|
58 | 58 | from IPython.core.prompts import PromptManager |
|
59 | 59 | from IPython.lib.latextools import LaTeXTool |
|
60 | 60 | from IPython.testing.skipdoctest import skip_doctest |
|
61 | 61 | from IPython.utils import PyColorize |
|
62 | 62 | from IPython.utils import io |
|
63 | 63 | from IPython.utils import py3compat |
|
64 | 64 | from IPython.utils import openpy |
|
65 | 65 | from IPython.utils.decorators import undoc |
|
66 | 66 | from IPython.utils.io import ask_yes_no |
|
67 | 67 | from IPython.utils.ipstruct import Struct |
|
68 | 68 | from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename |
|
69 | 69 | from IPython.utils.pickleshare import PickleShareDB |
|
70 | 70 | from IPython.utils.process import system, getoutput |
|
71 | 71 | from IPython.utils.py3compat import (builtin_mod, unicode_type, string_types, |
|
72 | 72 | with_metaclass, iteritems) |
|
73 | 73 | from IPython.utils.strdispatch import StrDispatch |
|
74 | 74 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
75 | 75 | from IPython.utils.text import (format_screen, LSString, SList, |
|
76 | 76 | DollarFormatter) |
|
77 | 77 | from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum, |
|
78 | 78 | List, Unicode, Instance, Type) |
|
79 | 79 | from IPython.utils.warn import warn, error |
|
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 | @undoc |
|
94 | 94 | def softspace(file, newvalue): |
|
95 | 95 | """Copied from code.py, to remove the dependency""" |
|
96 | 96 | |
|
97 | 97 | oldvalue = 0 |
|
98 | 98 | try: |
|
99 | 99 | oldvalue = file.softspace |
|
100 | 100 | except AttributeError: |
|
101 | 101 | pass |
|
102 | 102 | try: |
|
103 | 103 | file.softspace = newvalue |
|
104 | 104 | except (AttributeError, TypeError): |
|
105 | 105 | # "attribute-less object" or "read-only attributes" |
|
106 | 106 | pass |
|
107 | 107 | return oldvalue |
|
108 | 108 | |
|
109 | 109 | @undoc |
|
110 | 110 | def no_op(*a, **kw): pass |
|
111 | 111 | |
|
112 | 112 | @undoc |
|
113 | 113 | class NoOpContext(object): |
|
114 | 114 | def __enter__(self): pass |
|
115 | 115 | def __exit__(self, type, value, traceback): pass |
|
116 | 116 | no_op_context = NoOpContext() |
|
117 | 117 | |
|
118 | 118 | class SpaceInInput(Exception): pass |
|
119 | 119 | |
|
120 | 120 | @undoc |
|
121 | 121 | class Bunch: pass |
|
122 | 122 | |
|
123 | 123 | |
|
124 | 124 | def get_default_colors(): |
|
125 | 125 | if sys.platform=='darwin': |
|
126 | 126 | return "LightBG" |
|
127 | 127 | elif os.name=='nt': |
|
128 | 128 | return 'Linux' |
|
129 | 129 | else: |
|
130 | 130 | return 'Linux' |
|
131 | 131 | |
|
132 | 132 | |
|
133 | 133 | class SeparateUnicode(Unicode): |
|
134 | """A Unicode subclass to validate separate_in, separate_out, etc. | |
|
134 | r"""A Unicode subclass to validate separate_in, separate_out, etc. | |
|
135 | 135 | |
|
136 | This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'. | |
|
136 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. | |
|
137 | 137 | """ |
|
138 | 138 | |
|
139 | 139 | def validate(self, obj, value): |
|
140 | 140 | if value == '0': value = '' |
|
141 | 141 | value = value.replace('\\n','\n') |
|
142 | 142 | return super(SeparateUnicode, self).validate(obj, value) |
|
143 | 143 | |
|
144 | 144 | |
|
145 | 145 | class ReadlineNoRecord(object): |
|
146 | 146 | """Context manager to execute some code, then reload readline history |
|
147 | 147 | so that interactive input to the code doesn't appear when pressing up.""" |
|
148 | 148 | def __init__(self, shell): |
|
149 | 149 | self.shell = shell |
|
150 | 150 | self._nested_level = 0 |
|
151 | 151 | |
|
152 | 152 | def __enter__(self): |
|
153 | 153 | if self._nested_level == 0: |
|
154 | 154 | try: |
|
155 | 155 | self.orig_length = self.current_length() |
|
156 | 156 | self.readline_tail = self.get_readline_tail() |
|
157 | 157 | except (AttributeError, IndexError): # Can fail with pyreadline |
|
158 | 158 | self.orig_length, self.readline_tail = 999999, [] |
|
159 | 159 | self._nested_level += 1 |
|
160 | 160 | |
|
161 | 161 | def __exit__(self, type, value, traceback): |
|
162 | 162 | self._nested_level -= 1 |
|
163 | 163 | if self._nested_level == 0: |
|
164 | 164 | # Try clipping the end if it's got longer |
|
165 | 165 | try: |
|
166 | 166 | e = self.current_length() - self.orig_length |
|
167 | 167 | if e > 0: |
|
168 | 168 | for _ in range(e): |
|
169 | 169 | self.shell.readline.remove_history_item(self.orig_length) |
|
170 | 170 | |
|
171 | 171 | # If it still doesn't match, just reload readline history. |
|
172 | 172 | if self.current_length() != self.orig_length \ |
|
173 | 173 | or self.get_readline_tail() != self.readline_tail: |
|
174 | 174 | self.shell.refill_readline_hist() |
|
175 | 175 | except (AttributeError, IndexError): |
|
176 | 176 | pass |
|
177 | 177 | # Returning False will cause exceptions to propagate |
|
178 | 178 | return False |
|
179 | 179 | |
|
180 | 180 | def current_length(self): |
|
181 | 181 | return self.shell.readline.get_current_history_length() |
|
182 | 182 | |
|
183 | 183 | def get_readline_tail(self, n=10): |
|
184 | 184 | """Get the last n items in readline history.""" |
|
185 | 185 | end = self.shell.readline.get_current_history_length() + 1 |
|
186 | 186 | start = max(end-n, 1) |
|
187 | 187 | ghi = self.shell.readline.get_history_item |
|
188 | 188 | return [ghi(x) for x in range(start, end)] |
|
189 | 189 | |
|
190 | 190 | |
|
191 | 191 | @undoc |
|
192 | 192 | class DummyMod(object): |
|
193 | 193 | """A dummy module used for IPython's interactive module when |
|
194 | 194 | a namespace must be assigned to the module's __dict__.""" |
|
195 | 195 | pass |
|
196 | 196 | |
|
197 | 197 | #----------------------------------------------------------------------------- |
|
198 | 198 | # Main IPython class |
|
199 | 199 | #----------------------------------------------------------------------------- |
|
200 | 200 | |
|
201 | 201 | class InteractiveShell(SingletonConfigurable): |
|
202 | 202 | """An enhanced, interactive shell for Python.""" |
|
203 | 203 | |
|
204 | 204 | _instance = None |
|
205 | 205 | |
|
206 | 206 | ast_transformers = List([], config=True, help= |
|
207 | 207 | """ |
|
208 | 208 | A list of ast.NodeTransformer subclass instances, which will be applied |
|
209 | 209 | to user input before code is run. |
|
210 | 210 | """ |
|
211 | 211 | ) |
|
212 | 212 | |
|
213 | 213 | autocall = Enum((0,1,2), default_value=0, config=True, help= |
|
214 | 214 | """ |
|
215 | 215 | Make IPython automatically call any callable object even if you didn't |
|
216 | 216 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
217 | 217 | automatically. The value can be '0' to disable the feature, '1' for |
|
218 | 218 | 'smart' autocall, where it is not applied if there are no more |
|
219 | 219 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
220 | 220 | objects are automatically called (even if no arguments are present). |
|
221 | 221 | """ |
|
222 | 222 | ) |
|
223 | 223 | # TODO: remove all autoindent logic and put into frontends. |
|
224 | 224 | # We can't do this yet because even runlines uses the autoindent. |
|
225 | 225 | autoindent = CBool(True, config=True, help= |
|
226 | 226 | """ |
|
227 | 227 | Autoindent IPython code entered interactively. |
|
228 | 228 | """ |
|
229 | 229 | ) |
|
230 | 230 | automagic = CBool(True, config=True, help= |
|
231 | 231 | """ |
|
232 | 232 | Enable magic commands to be called without the leading %. |
|
233 | 233 | """ |
|
234 | 234 | ) |
|
235 | 235 | cache_size = Integer(1000, config=True, help= |
|
236 | 236 | """ |
|
237 | 237 | Set the size of the output cache. The default is 1000, you can |
|
238 | 238 | change it permanently in your config file. Setting it to 0 completely |
|
239 | 239 | disables the caching system, and the minimum value accepted is 20 (if |
|
240 | 240 | you provide a value less than 20, it is reset to 0 and a warning is |
|
241 | 241 | issued). This limit is defined because otherwise you'll spend more |
|
242 | 242 | time re-flushing a too small cache than working |
|
243 | 243 | """ |
|
244 | 244 | ) |
|
245 | 245 | color_info = CBool(True, config=True, help= |
|
246 | 246 | """ |
|
247 | 247 | Use colors for displaying information about objects. Because this |
|
248 | 248 | information is passed through a pager (like 'less'), and some pagers |
|
249 | 249 | get confused with color codes, this capability can be turned off. |
|
250 | 250 | """ |
|
251 | 251 | ) |
|
252 | 252 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), |
|
253 | 253 | default_value=get_default_colors(), config=True, |
|
254 | 254 | help="Set the color scheme (NoColor, Linux, or LightBG)." |
|
255 | 255 | ) |
|
256 | 256 | colors_force = CBool(False, help= |
|
257 | 257 | """ |
|
258 | 258 | Force use of ANSI color codes, regardless of OS and readline |
|
259 | 259 | availability. |
|
260 | 260 | """ |
|
261 | 261 | # FIXME: This is essentially a hack to allow ZMQShell to show colors |
|
262 | 262 | # without readline on Win32. When the ZMQ formatting system is |
|
263 | 263 | # refactored, this should be removed. |
|
264 | 264 | ) |
|
265 | 265 | debug = CBool(False, config=True) |
|
266 | 266 | deep_reload = CBool(False, config=True, help= |
|
267 | 267 | """ |
|
268 | 268 | Enable deep (recursive) reloading by default. IPython can use the |
|
269 | 269 | deep_reload module which reloads changes in modules recursively (it |
|
270 | 270 | replaces the reload() function, so you don't need to change anything to |
|
271 | 271 | use it). deep_reload() forces a full reload of modules whose code may |
|
272 | 272 | have changed, which the default reload() function does not. When |
|
273 | 273 | deep_reload is off, IPython will use the normal reload(), but |
|
274 | 274 | deep_reload will still be available as dreload(). |
|
275 | 275 | """ |
|
276 | 276 | ) |
|
277 | 277 | disable_failing_post_execute = CBool(False, config=True, |
|
278 | 278 | help="Don't call post-execute functions that have failed in the past." |
|
279 | 279 | ) |
|
280 | 280 | display_formatter = Instance(DisplayFormatter) |
|
281 | 281 | displayhook_class = Type(DisplayHook) |
|
282 | 282 | display_pub_class = Type(DisplayPublisher) |
|
283 | 283 | data_pub_class = None |
|
284 | 284 | |
|
285 | 285 | exit_now = CBool(False) |
|
286 | 286 | exiter = Instance(ExitAutocall) |
|
287 | 287 | def _exiter_default(self): |
|
288 | 288 | return ExitAutocall(self) |
|
289 | 289 | # Monotonically increasing execution counter |
|
290 | 290 | execution_count = Integer(1) |
|
291 | 291 | filename = Unicode("<ipython console>") |
|
292 | 292 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ |
|
293 | 293 | |
|
294 | 294 | # Input splitter, to transform input line by line and detect when a block |
|
295 | 295 | # is ready to be executed. |
|
296 | 296 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
297 | 297 | (), {'line_input_checker': True}) |
|
298 | 298 | |
|
299 | 299 | # This InputSplitter instance is used to transform completed cells before |
|
300 | 300 | # running them. It allows cell magics to contain blank lines. |
|
301 | 301 | input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
302 | 302 | (), {'line_input_checker': False}) |
|
303 | 303 | |
|
304 | 304 | logstart = CBool(False, config=True, help= |
|
305 | 305 | """ |
|
306 | 306 | Start logging to the default log file. |
|
307 | 307 | """ |
|
308 | 308 | ) |
|
309 | 309 | logfile = Unicode('', config=True, help= |
|
310 | 310 | """ |
|
311 | 311 | The name of the logfile to use. |
|
312 | 312 | """ |
|
313 | 313 | ) |
|
314 | 314 | logappend = Unicode('', config=True, help= |
|
315 | 315 | """ |
|
316 | 316 | Start logging to the given file in append mode. |
|
317 | 317 | """ |
|
318 | 318 | ) |
|
319 | 319 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
320 | 320 | config=True) |
|
321 | 321 | pdb = CBool(False, config=True, help= |
|
322 | 322 | """ |
|
323 | 323 | Automatically call the pdb debugger after every exception. |
|
324 | 324 | """ |
|
325 | 325 | ) |
|
326 | 326 | multiline_history = CBool(sys.platform != 'win32', config=True, |
|
327 | 327 | help="Save multi-line entries as one entry in readline history" |
|
328 | 328 | ) |
|
329 | 329 | |
|
330 | 330 | # deprecated prompt traits: |
|
331 | 331 | |
|
332 | 332 | prompt_in1 = Unicode('In [\\#]: ', config=True, |
|
333 | 333 | help="Deprecated, use PromptManager.in_template") |
|
334 | 334 | prompt_in2 = Unicode(' .\\D.: ', config=True, |
|
335 | 335 | help="Deprecated, use PromptManager.in2_template") |
|
336 | 336 | prompt_out = Unicode('Out[\\#]: ', config=True, |
|
337 | 337 | help="Deprecated, use PromptManager.out_template") |
|
338 | 338 | prompts_pad_left = CBool(True, config=True, |
|
339 | 339 | help="Deprecated, use PromptManager.justify") |
|
340 | 340 | |
|
341 | 341 | def _prompt_trait_changed(self, name, old, new): |
|
342 | 342 | table = { |
|
343 | 343 | 'prompt_in1' : 'in_template', |
|
344 | 344 | 'prompt_in2' : 'in2_template', |
|
345 | 345 | 'prompt_out' : 'out_template', |
|
346 | 346 | 'prompts_pad_left' : 'justify', |
|
347 | 347 | } |
|
348 | 348 | warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}".format( |
|
349 | 349 | name=name, newname=table[name]) |
|
350 | 350 | ) |
|
351 | 351 | # protect against weird cases where self.config may not exist: |
|
352 | 352 | if self.config is not None: |
|
353 | 353 | # propagate to corresponding PromptManager trait |
|
354 | 354 | setattr(self.config.PromptManager, table[name], new) |
|
355 | 355 | |
|
356 | 356 | _prompt_in1_changed = _prompt_trait_changed |
|
357 | 357 | _prompt_in2_changed = _prompt_trait_changed |
|
358 | 358 | _prompt_out_changed = _prompt_trait_changed |
|
359 | 359 | _prompt_pad_left_changed = _prompt_trait_changed |
|
360 | 360 | |
|
361 | 361 | show_rewritten_input = CBool(True, config=True, |
|
362 | 362 | help="Show rewritten input, e.g. for autocall." |
|
363 | 363 | ) |
|
364 | 364 | |
|
365 | 365 | quiet = CBool(False, config=True) |
|
366 | 366 | |
|
367 | 367 | history_length = Integer(10000, config=True) |
|
368 | 368 | |
|
369 | 369 | # The readline stuff will eventually be moved to the terminal subclass |
|
370 | 370 | # but for now, we can't do that as readline is welded in everywhere. |
|
371 | 371 | readline_use = CBool(True, config=True) |
|
372 | 372 | readline_remove_delims = Unicode('-/~', config=True) |
|
373 | 373 | readline_delims = Unicode() # set by init_readline() |
|
374 | 374 | # don't use \M- bindings by default, because they |
|
375 | 375 | # conflict with 8-bit encodings. See gh-58,gh-88 |
|
376 | 376 | readline_parse_and_bind = List([ |
|
377 | 377 | 'tab: complete', |
|
378 | 378 | '"\C-l": clear-screen', |
|
379 | 379 | 'set show-all-if-ambiguous on', |
|
380 | 380 | '"\C-o": tab-insert', |
|
381 | 381 | '"\C-r": reverse-search-history', |
|
382 | 382 | '"\C-s": forward-search-history', |
|
383 | 383 | '"\C-p": history-search-backward', |
|
384 | 384 | '"\C-n": history-search-forward', |
|
385 | 385 | '"\e[A": history-search-backward', |
|
386 | 386 | '"\e[B": history-search-forward', |
|
387 | 387 | '"\C-k": kill-line', |
|
388 | 388 | '"\C-u": unix-line-discard', |
|
389 | 389 | ], allow_none=False, config=True) |
|
390 | 390 | |
|
391 | 391 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none'], |
|
392 | 392 | default_value='last_expr', config=True, |
|
393 | 393 | help=""" |
|
394 | 394 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be |
|
395 | 395 | run interactively (displaying output from expressions).""") |
|
396 | 396 | |
|
397 | 397 | # TODO: this part of prompt management should be moved to the frontends. |
|
398 | 398 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
399 | 399 | separate_in = SeparateUnicode('\n', config=True) |
|
400 | 400 | separate_out = SeparateUnicode('', config=True) |
|
401 | 401 | separate_out2 = SeparateUnicode('', config=True) |
|
402 | 402 | wildcards_case_sensitive = CBool(True, config=True) |
|
403 | 403 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
404 | 404 | default_value='Context', config=True) |
|
405 | 405 | |
|
406 | 406 | # Subcomponents of InteractiveShell |
|
407 | 407 | alias_manager = Instance('IPython.core.alias.AliasManager') |
|
408 | 408 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
409 | 409 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') |
|
410 | 410 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') |
|
411 | 411 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') |
|
412 | 412 | payload_manager = Instance('IPython.core.payload.PayloadManager') |
|
413 | 413 | history_manager = Instance('IPython.core.history.HistoryManager') |
|
414 | 414 | magics_manager = Instance('IPython.core.magic.MagicsManager') |
|
415 | 415 | |
|
416 | 416 | profile_dir = Instance('IPython.core.application.ProfileDir') |
|
417 | 417 | @property |
|
418 | 418 | def profile(self): |
|
419 | 419 | if self.profile_dir is not None: |
|
420 | 420 | name = os.path.basename(self.profile_dir.location) |
|
421 | 421 | return name.replace('profile_','') |
|
422 | 422 | |
|
423 | 423 | |
|
424 | 424 | # Private interface |
|
425 | 425 | _post_execute = Instance(dict) |
|
426 | 426 | |
|
427 | 427 | # Tracks any GUI loop loaded for pylab |
|
428 | 428 | pylab_gui_select = None |
|
429 | 429 | |
|
430 | 430 | def __init__(self, ipython_dir=None, profile_dir=None, |
|
431 | 431 | user_module=None, user_ns=None, |
|
432 | 432 | custom_exceptions=((), None), **kwargs): |
|
433 | 433 | |
|
434 | 434 | # This is where traits with a config_key argument are updated |
|
435 | 435 | # from the values on config. |
|
436 | 436 | super(InteractiveShell, self).__init__(**kwargs) |
|
437 | 437 | self.configurables = [self] |
|
438 | 438 | |
|
439 | 439 | # These are relatively independent and stateless |
|
440 | 440 | self.init_ipython_dir(ipython_dir) |
|
441 | 441 | self.init_profile_dir(profile_dir) |
|
442 | 442 | self.init_instance_attrs() |
|
443 | 443 | self.init_environment() |
|
444 | 444 | |
|
445 | 445 | # Check if we're in a virtualenv, and set up sys.path. |
|
446 | 446 | self.init_virtualenv() |
|
447 | 447 | |
|
448 | 448 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
449 | 449 | self.init_create_namespaces(user_module, user_ns) |
|
450 | 450 | # This has to be done after init_create_namespaces because it uses |
|
451 | 451 | # something in self.user_ns, but before init_sys_modules, which |
|
452 | 452 | # is the first thing to modify sys. |
|
453 | 453 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
454 | 454 | # is created, we are saving the overridden ones here. Not sure if this |
|
455 | 455 | # is what we want to do. |
|
456 | 456 | self.save_sys_module_state() |
|
457 | 457 | self.init_sys_modules() |
|
458 | 458 | |
|
459 | 459 | # While we're trying to have each part of the code directly access what |
|
460 | 460 | # it needs without keeping redundant references to objects, we have too |
|
461 | 461 | # much legacy code that expects ip.db to exist. |
|
462 | 462 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
463 | 463 | |
|
464 | 464 | self.init_history() |
|
465 | 465 | self.init_encoding() |
|
466 | 466 | self.init_prefilter() |
|
467 | 467 | |
|
468 | 468 | self.init_syntax_highlighting() |
|
469 | 469 | self.init_hooks() |
|
470 | 470 | self.init_pushd_popd_magic() |
|
471 | 471 | # self.init_traceback_handlers use to be here, but we moved it below |
|
472 | 472 | # because it and init_io have to come after init_readline. |
|
473 | 473 | self.init_user_ns() |
|
474 | 474 | self.init_logger() |
|
475 | 475 | self.init_builtins() |
|
476 | 476 | |
|
477 | 477 | # The following was in post_config_initialization |
|
478 | 478 | self.init_inspector() |
|
479 | 479 | # init_readline() must come before init_io(), because init_io uses |
|
480 | 480 | # readline related things. |
|
481 | 481 | self.init_readline() |
|
482 | 482 | # We save this here in case user code replaces raw_input, but it needs |
|
483 | 483 | # to be after init_readline(), because PyPy's readline works by replacing |
|
484 | 484 | # raw_input. |
|
485 | 485 | if py3compat.PY3: |
|
486 | 486 | self.raw_input_original = input |
|
487 | 487 | else: |
|
488 | 488 | self.raw_input_original = raw_input |
|
489 | 489 | # init_completer must come after init_readline, because it needs to |
|
490 | 490 | # know whether readline is present or not system-wide to configure the |
|
491 | 491 | # completers, since the completion machinery can now operate |
|
492 | 492 | # independently of readline (e.g. over the network) |
|
493 | 493 | self.init_completer() |
|
494 | 494 | # TODO: init_io() needs to happen before init_traceback handlers |
|
495 | 495 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
496 | 496 | # This logic in in debugger.Pdb and should eventually be changed. |
|
497 | 497 | self.init_io() |
|
498 | 498 | self.init_traceback_handlers(custom_exceptions) |
|
499 | 499 | self.init_prompts() |
|
500 | 500 | self.init_display_formatter() |
|
501 | 501 | self.init_display_pub() |
|
502 | 502 | self.init_data_pub() |
|
503 | 503 | self.init_displayhook() |
|
504 | 504 | self.init_latextool() |
|
505 | 505 | self.init_magics() |
|
506 | 506 | self.init_alias() |
|
507 | 507 | self.init_logstart() |
|
508 | 508 | self.init_pdb() |
|
509 | 509 | self.init_extension_manager() |
|
510 | 510 | self.init_payload() |
|
511 | 511 | self.init_comms() |
|
512 | 512 | self.hooks.late_startup_hook() |
|
513 | 513 | atexit.register(self.atexit_operations) |
|
514 | 514 | |
|
515 | 515 | def get_ipython(self): |
|
516 | 516 | """Return the currently running IPython instance.""" |
|
517 | 517 | return self |
|
518 | 518 | |
|
519 | 519 | #------------------------------------------------------------------------- |
|
520 | 520 | # Trait changed handlers |
|
521 | 521 | #------------------------------------------------------------------------- |
|
522 | 522 | |
|
523 | 523 | def _ipython_dir_changed(self, name, new): |
|
524 | 524 | if not os.path.isdir(new): |
|
525 | 525 | os.makedirs(new, mode = 0o777) |
|
526 | 526 | |
|
527 | 527 | def set_autoindent(self,value=None): |
|
528 | 528 | """Set the autoindent flag, checking for readline support. |
|
529 | 529 | |
|
530 | 530 | If called with no arguments, it acts as a toggle.""" |
|
531 | 531 | |
|
532 | 532 | if value != 0 and not self.has_readline: |
|
533 | 533 | if os.name == 'posix': |
|
534 | 534 | warn("The auto-indent feature requires the readline library") |
|
535 | 535 | self.autoindent = 0 |
|
536 | 536 | return |
|
537 | 537 | if value is None: |
|
538 | 538 | self.autoindent = not self.autoindent |
|
539 | 539 | else: |
|
540 | 540 | self.autoindent = value |
|
541 | 541 | |
|
542 | 542 | #------------------------------------------------------------------------- |
|
543 | 543 | # init_* methods called by __init__ |
|
544 | 544 | #------------------------------------------------------------------------- |
|
545 | 545 | |
|
546 | 546 | def init_ipython_dir(self, ipython_dir): |
|
547 | 547 | if ipython_dir is not None: |
|
548 | 548 | self.ipython_dir = ipython_dir |
|
549 | 549 | return |
|
550 | 550 | |
|
551 | 551 | self.ipython_dir = get_ipython_dir() |
|
552 | 552 | |
|
553 | 553 | def init_profile_dir(self, profile_dir): |
|
554 | 554 | if profile_dir is not None: |
|
555 | 555 | self.profile_dir = profile_dir |
|
556 | 556 | return |
|
557 | 557 | self.profile_dir =\ |
|
558 | 558 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
559 | 559 | |
|
560 | 560 | def init_instance_attrs(self): |
|
561 | 561 | self.more = False |
|
562 | 562 | |
|
563 | 563 | # command compiler |
|
564 | 564 | self.compile = CachingCompiler() |
|
565 | 565 | |
|
566 | 566 | # Make an empty namespace, which extension writers can rely on both |
|
567 | 567 | # existing and NEVER being used by ipython itself. This gives them a |
|
568 | 568 | # convenient location for storing additional information and state |
|
569 | 569 | # their extensions may require, without fear of collisions with other |
|
570 | 570 | # ipython names that may develop later. |
|
571 | 571 | self.meta = Struct() |
|
572 | 572 | |
|
573 | 573 | # Temporary files used for various purposes. Deleted at exit. |
|
574 | 574 | self.tempfiles = [] |
|
575 | 575 | |
|
576 | 576 | # Keep track of readline usage (later set by init_readline) |
|
577 | 577 | self.has_readline = False |
|
578 | 578 | |
|
579 | 579 | # keep track of where we started running (mainly for crash post-mortem) |
|
580 | 580 | # This is not being used anywhere currently. |
|
581 | 581 | self.starting_dir = py3compat.getcwd() |
|
582 | 582 | |
|
583 | 583 | # Indentation management |
|
584 | 584 | self.indent_current_nsp = 0 |
|
585 | 585 | |
|
586 | 586 | # Dict to track post-execution functions that have been registered |
|
587 | 587 | self._post_execute = {} |
|
588 | 588 | |
|
589 | 589 | def init_environment(self): |
|
590 | 590 | """Any changes we need to make to the user's environment.""" |
|
591 | 591 | pass |
|
592 | 592 | |
|
593 | 593 | def init_encoding(self): |
|
594 | 594 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
595 | 595 | # under Win32 have it set to None, and we need to have a known valid |
|
596 | 596 | # encoding to use in the raw_input() method |
|
597 | 597 | try: |
|
598 | 598 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
599 | 599 | except AttributeError: |
|
600 | 600 | self.stdin_encoding = 'ascii' |
|
601 | 601 | |
|
602 | 602 | def init_syntax_highlighting(self): |
|
603 | 603 | # Python source parser/formatter for syntax highlighting |
|
604 | 604 | pyformat = PyColorize.Parser().format |
|
605 | 605 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) |
|
606 | 606 | |
|
607 | 607 | def init_pushd_popd_magic(self): |
|
608 | 608 | # for pushd/popd management |
|
609 | 609 | self.home_dir = get_home_dir() |
|
610 | 610 | |
|
611 | 611 | self.dir_stack = [] |
|
612 | 612 | |
|
613 | 613 | def init_logger(self): |
|
614 | 614 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
615 | 615 | logmode='rotate') |
|
616 | 616 | |
|
617 | 617 | def init_logstart(self): |
|
618 | 618 | """Initialize logging in case it was requested at the command line. |
|
619 | 619 | """ |
|
620 | 620 | if self.logappend: |
|
621 | 621 | self.magic('logstart %s append' % self.logappend) |
|
622 | 622 | elif self.logfile: |
|
623 | 623 | self.magic('logstart %s' % self.logfile) |
|
624 | 624 | elif self.logstart: |
|
625 | 625 | self.magic('logstart') |
|
626 | 626 | |
|
627 | 627 | def init_builtins(self): |
|
628 | 628 | # A single, static flag that we set to True. Its presence indicates |
|
629 | 629 | # that an IPython shell has been created, and we make no attempts at |
|
630 | 630 | # removing on exit or representing the existence of more than one |
|
631 | 631 | # IPython at a time. |
|
632 | 632 | builtin_mod.__dict__['__IPYTHON__'] = True |
|
633 | 633 | |
|
634 | 634 | # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to |
|
635 | 635 | # manage on enter/exit, but with all our shells it's virtually |
|
636 | 636 | # impossible to get all the cases right. We're leaving the name in for |
|
637 | 637 | # those who adapted their codes to check for this flag, but will |
|
638 | 638 | # eventually remove it after a few more releases. |
|
639 | 639 | builtin_mod.__dict__['__IPYTHON__active'] = \ |
|
640 | 640 | 'Deprecated, check for __IPYTHON__' |
|
641 | 641 | |
|
642 | 642 | self.builtin_trap = BuiltinTrap(shell=self) |
|
643 | 643 | |
|
644 | 644 | def init_inspector(self): |
|
645 | 645 | # Object inspector |
|
646 | 646 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
647 | 647 | PyColorize.ANSICodeColors, |
|
648 | 648 | 'NoColor', |
|
649 | 649 | self.object_info_string_level) |
|
650 | 650 | |
|
651 | 651 | def init_io(self): |
|
652 | 652 | # This will just use sys.stdout and sys.stderr. If you want to |
|
653 | 653 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
654 | 654 | # *before* instantiating this class, because io holds onto |
|
655 | 655 | # references to the underlying streams. |
|
656 | 656 | if (sys.platform == 'win32' or sys.platform == 'cli') and self.has_readline: |
|
657 | 657 | io.stdout = io.stderr = io.IOStream(self.readline._outputfile) |
|
658 | 658 | else: |
|
659 | 659 | io.stdout = io.IOStream(sys.stdout) |
|
660 | 660 | io.stderr = io.IOStream(sys.stderr) |
|
661 | 661 | |
|
662 | 662 | def init_prompts(self): |
|
663 | 663 | self.prompt_manager = PromptManager(shell=self, parent=self) |
|
664 | 664 | self.configurables.append(self.prompt_manager) |
|
665 | 665 | # Set system prompts, so that scripts can decide if they are running |
|
666 | 666 | # interactively. |
|
667 | 667 | sys.ps1 = 'In : ' |
|
668 | 668 | sys.ps2 = '...: ' |
|
669 | 669 | sys.ps3 = 'Out: ' |
|
670 | 670 | |
|
671 | 671 | def init_display_formatter(self): |
|
672 | 672 | self.display_formatter = DisplayFormatter(parent=self) |
|
673 | 673 | self.configurables.append(self.display_formatter) |
|
674 | 674 | |
|
675 | 675 | def init_display_pub(self): |
|
676 | 676 | self.display_pub = self.display_pub_class(parent=self) |
|
677 | 677 | self.configurables.append(self.display_pub) |
|
678 | 678 | |
|
679 | 679 | def init_data_pub(self): |
|
680 | 680 | if not self.data_pub_class: |
|
681 | 681 | self.data_pub = None |
|
682 | 682 | return |
|
683 | 683 | self.data_pub = self.data_pub_class(parent=self) |
|
684 | 684 | self.configurables.append(self.data_pub) |
|
685 | 685 | |
|
686 | 686 | def init_displayhook(self): |
|
687 | 687 | # Initialize displayhook, set in/out prompts and printing system |
|
688 | 688 | self.displayhook = self.displayhook_class( |
|
689 | 689 | parent=self, |
|
690 | 690 | shell=self, |
|
691 | 691 | cache_size=self.cache_size, |
|
692 | 692 | ) |
|
693 | 693 | self.configurables.append(self.displayhook) |
|
694 | 694 | # This is a context manager that installs/revmoes the displayhook at |
|
695 | 695 | # the appropriate time. |
|
696 | 696 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
697 | 697 | |
|
698 | 698 | def init_latextool(self): |
|
699 | 699 | """Configure LaTeXTool.""" |
|
700 | 700 | cfg = LaTeXTool.instance(parent=self) |
|
701 | 701 | if cfg not in self.configurables: |
|
702 | 702 | self.configurables.append(cfg) |
|
703 | 703 | |
|
704 | 704 | def init_virtualenv(self): |
|
705 | 705 | """Add a virtualenv to sys.path so the user can import modules from it. |
|
706 | 706 | This isn't perfect: it doesn't use the Python interpreter with which the |
|
707 | 707 | virtualenv was built, and it ignores the --no-site-packages option. A |
|
708 | 708 | warning will appear suggesting the user installs IPython in the |
|
709 | 709 | virtualenv, but for many cases, it probably works well enough. |
|
710 | 710 | |
|
711 | 711 | Adapted from code snippets online. |
|
712 | 712 | |
|
713 | 713 | http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv |
|
714 | 714 | """ |
|
715 | 715 | if 'VIRTUAL_ENV' not in os.environ: |
|
716 | 716 | # Not in a virtualenv |
|
717 | 717 | return |
|
718 | 718 | |
|
719 | 719 | if os.path.realpath(sys.executable).startswith( |
|
720 | 720 | os.path.realpath(os.environ['VIRTUAL_ENV']) |
|
721 | 721 | ): |
|
722 | 722 | # Running properly in the virtualenv, don't need to do anything |
|
723 | 723 | return |
|
724 | 724 | |
|
725 | 725 | warn("Attempting to work in a virtualenv. If you encounter problems, please " |
|
726 | 726 | "install IPython inside the virtualenv.") |
|
727 | 727 | if sys.platform == "win32": |
|
728 | 728 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages') |
|
729 | 729 | else: |
|
730 | 730 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib', |
|
731 | 731 | 'python%d.%d' % sys.version_info[:2], 'site-packages') |
|
732 | 732 | |
|
733 | 733 | import site |
|
734 | 734 | sys.path.insert(0, virtual_env) |
|
735 | 735 | site.addsitedir(virtual_env) |
|
736 | 736 | |
|
737 | 737 | #------------------------------------------------------------------------- |
|
738 | 738 | # Things related to injections into the sys module |
|
739 | 739 | #------------------------------------------------------------------------- |
|
740 | 740 | |
|
741 | 741 | def save_sys_module_state(self): |
|
742 | 742 | """Save the state of hooks in the sys module. |
|
743 | 743 | |
|
744 | 744 | This has to be called after self.user_module is created. |
|
745 | 745 | """ |
|
746 | 746 | self._orig_sys_module_state = {} |
|
747 | 747 | self._orig_sys_module_state['stdin'] = sys.stdin |
|
748 | 748 | self._orig_sys_module_state['stdout'] = sys.stdout |
|
749 | 749 | self._orig_sys_module_state['stderr'] = sys.stderr |
|
750 | 750 | self._orig_sys_module_state['excepthook'] = sys.excepthook |
|
751 | 751 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
752 | 752 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) |
|
753 | 753 | |
|
754 | 754 | def restore_sys_module_state(self): |
|
755 | 755 | """Restore the state of the sys module.""" |
|
756 | 756 | try: |
|
757 | 757 | for k, v in iteritems(self._orig_sys_module_state): |
|
758 | 758 | setattr(sys, k, v) |
|
759 | 759 | except AttributeError: |
|
760 | 760 | pass |
|
761 | 761 | # Reset what what done in self.init_sys_modules |
|
762 | 762 | if self._orig_sys_modules_main_mod is not None: |
|
763 | 763 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod |
|
764 | 764 | |
|
765 | 765 | #------------------------------------------------------------------------- |
|
766 | 766 | # Things related to hooks |
|
767 | 767 | #------------------------------------------------------------------------- |
|
768 | 768 | |
|
769 | 769 | def init_hooks(self): |
|
770 | 770 | # hooks holds pointers used for user-side customizations |
|
771 | 771 | self.hooks = Struct() |
|
772 | 772 | |
|
773 | 773 | self.strdispatchers = {} |
|
774 | 774 | |
|
775 | 775 | # Set all default hooks, defined in the IPython.hooks module. |
|
776 | 776 | hooks = IPython.core.hooks |
|
777 | 777 | for hook_name in hooks.__all__: |
|
778 | 778 | # default hooks have priority 100, i.e. low; user hooks should have |
|
779 | 779 | # 0-100 priority |
|
780 | 780 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
781 | 781 | |
|
782 | 782 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
783 | 783 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
784 | 784 | |
|
785 | 785 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
786 | 786 | adding your function to one of these hooks, you can modify IPython's |
|
787 | 787 | behavior to call at runtime your own routines.""" |
|
788 | 788 | |
|
789 | 789 | # At some point in the future, this should validate the hook before it |
|
790 | 790 | # accepts it. Probably at least check that the hook takes the number |
|
791 | 791 | # of args it's supposed to. |
|
792 | 792 | |
|
793 | 793 | f = types.MethodType(hook,self) |
|
794 | 794 | |
|
795 | 795 | # check if the hook is for strdispatcher first |
|
796 | 796 | if str_key is not None: |
|
797 | 797 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
798 | 798 | sdp.add_s(str_key, f, priority ) |
|
799 | 799 | self.strdispatchers[name] = sdp |
|
800 | 800 | return |
|
801 | 801 | if re_key is not None: |
|
802 | 802 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
803 | 803 | sdp.add_re(re.compile(re_key), f, priority ) |
|
804 | 804 | self.strdispatchers[name] = sdp |
|
805 | 805 | return |
|
806 | 806 | |
|
807 | 807 | dp = getattr(self.hooks, name, None) |
|
808 | 808 | if name not in IPython.core.hooks.__all__: |
|
809 | 809 | print("Warning! Hook '%s' is not one of %s" % \ |
|
810 | 810 | (name, IPython.core.hooks.__all__ )) |
|
811 | 811 | if not dp: |
|
812 | 812 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
813 | 813 | |
|
814 | 814 | try: |
|
815 | 815 | dp.add(f,priority) |
|
816 | 816 | except AttributeError: |
|
817 | 817 | # it was not commandchain, plain old func - replace |
|
818 | 818 | dp = f |
|
819 | 819 | |
|
820 | 820 | setattr(self.hooks,name, dp) |
|
821 | 821 | |
|
822 | 822 | def register_post_execute(self, func): |
|
823 | 823 | """Register a function for calling after code execution. |
|
824 | 824 | """ |
|
825 | 825 | if not callable(func): |
|
826 | 826 | raise ValueError('argument %s must be callable' % func) |
|
827 | 827 | self._post_execute[func] = True |
|
828 | 828 | |
|
829 | 829 | #------------------------------------------------------------------------- |
|
830 | 830 | # Things related to the "main" module |
|
831 | 831 | #------------------------------------------------------------------------- |
|
832 | 832 | |
|
833 | 833 | def new_main_mod(self, filename, modname): |
|
834 | 834 | """Return a new 'main' module object for user code execution. |
|
835 | 835 | |
|
836 | 836 | ``filename`` should be the path of the script which will be run in the |
|
837 | 837 | module. Requests with the same filename will get the same module, with |
|
838 | 838 | its namespace cleared. |
|
839 | 839 | |
|
840 | 840 | ``modname`` should be the module name - normally either '__main__' or |
|
841 | 841 | the basename of the file without the extension. |
|
842 | 842 | |
|
843 | 843 | When scripts are executed via %run, we must keep a reference to their |
|
844 | 844 | __main__ module around so that Python doesn't |
|
845 | 845 | clear it, rendering references to module globals useless. |
|
846 | 846 | |
|
847 | 847 | This method keeps said reference in a private dict, keyed by the |
|
848 | 848 | absolute path of the script. This way, for multiple executions of the |
|
849 | 849 | same script we only keep one copy of the namespace (the last one), |
|
850 | 850 | thus preventing memory leaks from old references while allowing the |
|
851 | 851 | objects from the last execution to be accessible. |
|
852 | 852 | """ |
|
853 | 853 | filename = os.path.abspath(filename) |
|
854 | 854 | try: |
|
855 | 855 | main_mod = self._main_mod_cache[filename] |
|
856 | 856 | except KeyError: |
|
857 | 857 | main_mod = self._main_mod_cache[filename] = types.ModuleType(modname, |
|
858 | 858 | doc="Module created for script run in IPython") |
|
859 | 859 | else: |
|
860 | 860 | main_mod.__dict__.clear() |
|
861 | 861 | main_mod.__name__ = modname |
|
862 | 862 | |
|
863 | 863 | main_mod.__file__ = filename |
|
864 | 864 | # It seems pydoc (and perhaps others) needs any module instance to |
|
865 | 865 | # implement a __nonzero__ method |
|
866 | 866 | main_mod.__nonzero__ = lambda : True |
|
867 | 867 | |
|
868 | 868 | return main_mod |
|
869 | 869 | |
|
870 | 870 | def clear_main_mod_cache(self): |
|
871 | 871 | """Clear the cache of main modules. |
|
872 | 872 | |
|
873 | 873 | Mainly for use by utilities like %reset. |
|
874 | 874 | |
|
875 | 875 | Examples |
|
876 | 876 | -------- |
|
877 | 877 | |
|
878 | 878 | In [15]: import IPython |
|
879 | 879 | |
|
880 | 880 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') |
|
881 | 881 | |
|
882 | 882 | In [17]: len(_ip._main_mod_cache) > 0 |
|
883 | 883 | Out[17]: True |
|
884 | 884 | |
|
885 | 885 | In [18]: _ip.clear_main_mod_cache() |
|
886 | 886 | |
|
887 | 887 | In [19]: len(_ip._main_mod_cache) == 0 |
|
888 | 888 | Out[19]: True |
|
889 | 889 | """ |
|
890 | 890 | self._main_mod_cache.clear() |
|
891 | 891 | |
|
892 | 892 | #------------------------------------------------------------------------- |
|
893 | 893 | # Things related to debugging |
|
894 | 894 | #------------------------------------------------------------------------- |
|
895 | 895 | |
|
896 | 896 | def init_pdb(self): |
|
897 | 897 | # Set calling of pdb on exceptions |
|
898 | 898 | # self.call_pdb is a property |
|
899 | 899 | self.call_pdb = self.pdb |
|
900 | 900 | |
|
901 | 901 | def _get_call_pdb(self): |
|
902 | 902 | return self._call_pdb |
|
903 | 903 | |
|
904 | 904 | def _set_call_pdb(self,val): |
|
905 | 905 | |
|
906 | 906 | if val not in (0,1,False,True): |
|
907 | 907 | raise ValueError('new call_pdb value must be boolean') |
|
908 | 908 | |
|
909 | 909 | # store value in instance |
|
910 | 910 | self._call_pdb = val |
|
911 | 911 | |
|
912 | 912 | # notify the actual exception handlers |
|
913 | 913 | self.InteractiveTB.call_pdb = val |
|
914 | 914 | |
|
915 | 915 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
916 | 916 | 'Control auto-activation of pdb at exceptions') |
|
917 | 917 | |
|
918 | 918 | def debugger(self,force=False): |
|
919 | 919 | """Call the pydb/pdb debugger. |
|
920 | 920 | |
|
921 | 921 | Keywords: |
|
922 | 922 | |
|
923 | 923 | - force(False): by default, this routine checks the instance call_pdb |
|
924 | 924 | flag and does not actually invoke the debugger if the flag is false. |
|
925 | 925 | The 'force' option forces the debugger to activate even if the flag |
|
926 | 926 | is false. |
|
927 | 927 | """ |
|
928 | 928 | |
|
929 | 929 | if not (force or self.call_pdb): |
|
930 | 930 | return |
|
931 | 931 | |
|
932 | 932 | if not hasattr(sys,'last_traceback'): |
|
933 | 933 | error('No traceback has been produced, nothing to debug.') |
|
934 | 934 | return |
|
935 | 935 | |
|
936 | 936 | # use pydb if available |
|
937 | 937 | if debugger.has_pydb: |
|
938 | 938 | from pydb import pm |
|
939 | 939 | else: |
|
940 | 940 | # fallback to our internal debugger |
|
941 | 941 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
942 | 942 | |
|
943 | 943 | with self.readline_no_record: |
|
944 | 944 | pm() |
|
945 | 945 | |
|
946 | 946 | #------------------------------------------------------------------------- |
|
947 | 947 | # Things related to IPython's various namespaces |
|
948 | 948 | #------------------------------------------------------------------------- |
|
949 | 949 | default_user_namespaces = True |
|
950 | 950 | |
|
951 | 951 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
952 | 952 | # Create the namespace where the user will operate. user_ns is |
|
953 | 953 | # normally the only one used, and it is passed to the exec calls as |
|
954 | 954 | # the locals argument. But we do carry a user_global_ns namespace |
|
955 | 955 | # given as the exec 'globals' argument, This is useful in embedding |
|
956 | 956 | # situations where the ipython shell opens in a context where the |
|
957 | 957 | # distinction between locals and globals is meaningful. For |
|
958 | 958 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
959 | 959 | |
|
960 | 960 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
961 | 961 | # level as a dict instead of a module. This is a manual fix, but I |
|
962 | 962 | # should really track down where the problem is coming from. Alex |
|
963 | 963 | # Schmolck reported this problem first. |
|
964 | 964 | |
|
965 | 965 | # A useful post by Alex Martelli on this topic: |
|
966 | 966 | # Re: inconsistent value from __builtins__ |
|
967 | 967 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
968 | 968 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
969 | 969 | # Gruppen: comp.lang.python |
|
970 | 970 | |
|
971 | 971 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
972 | 972 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
973 | 973 | # > <type 'dict'> |
|
974 | 974 | # > >>> print type(__builtins__) |
|
975 | 975 | # > <type 'module'> |
|
976 | 976 | # > Is this difference in return value intentional? |
|
977 | 977 | |
|
978 | 978 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
979 | 979 | # or a module, and it's been that way for a long time. Whether it's |
|
980 | 980 | # intentional (or sensible), I don't know. In any case, the idea is |
|
981 | 981 | # that if you need to access the built-in namespace directly, you |
|
982 | 982 | # should start with "import __builtin__" (note, no 's') which will |
|
983 | 983 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
984 | 984 | |
|
985 | 985 | # These routines return a properly built module and dict as needed by |
|
986 | 986 | # the rest of the code, and can also be used by extension writers to |
|
987 | 987 | # generate properly initialized namespaces. |
|
988 | 988 | if (user_ns is not None) or (user_module is not None): |
|
989 | 989 | self.default_user_namespaces = False |
|
990 | 990 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
991 | 991 | |
|
992 | 992 | # A record of hidden variables we have added to the user namespace, so |
|
993 | 993 | # we can list later only variables defined in actual interactive use. |
|
994 | 994 | self.user_ns_hidden = {} |
|
995 | 995 | |
|
996 | 996 | # Now that FakeModule produces a real module, we've run into a nasty |
|
997 | 997 | # problem: after script execution (via %run), the module where the user |
|
998 | 998 | # code ran is deleted. Now that this object is a true module (needed |
|
999 | 999 | # so docetst and other tools work correctly), the Python module |
|
1000 | 1000 | # teardown mechanism runs over it, and sets to None every variable |
|
1001 | 1001 | # present in that module. Top-level references to objects from the |
|
1002 | 1002 | # script survive, because the user_ns is updated with them. However, |
|
1003 | 1003 | # calling functions defined in the script that use other things from |
|
1004 | 1004 | # the script will fail, because the function's closure had references |
|
1005 | 1005 | # to the original objects, which are now all None. So we must protect |
|
1006 | 1006 | # these modules from deletion by keeping a cache. |
|
1007 | 1007 | # |
|
1008 | 1008 | # To avoid keeping stale modules around (we only need the one from the |
|
1009 | 1009 | # last run), we use a dict keyed with the full path to the script, so |
|
1010 | 1010 | # only the last version of the module is held in the cache. Note, |
|
1011 | 1011 | # however, that we must cache the module *namespace contents* (their |
|
1012 | 1012 | # __dict__). Because if we try to cache the actual modules, old ones |
|
1013 | 1013 | # (uncached) could be destroyed while still holding references (such as |
|
1014 | 1014 | # those held by GUI objects that tend to be long-lived)> |
|
1015 | 1015 | # |
|
1016 | 1016 | # The %reset command will flush this cache. See the cache_main_mod() |
|
1017 | 1017 | # and clear_main_mod_cache() methods for details on use. |
|
1018 | 1018 | |
|
1019 | 1019 | # This is the cache used for 'main' namespaces |
|
1020 | 1020 | self._main_mod_cache = {} |
|
1021 | 1021 | |
|
1022 | 1022 | # A table holding all the namespaces IPython deals with, so that |
|
1023 | 1023 | # introspection facilities can search easily. |
|
1024 | 1024 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
1025 | 1025 | 'user_local':self.user_ns, |
|
1026 | 1026 | 'builtin':builtin_mod.__dict__ |
|
1027 | 1027 | } |
|
1028 | 1028 | |
|
1029 | 1029 | @property |
|
1030 | 1030 | def user_global_ns(self): |
|
1031 | 1031 | return self.user_module.__dict__ |
|
1032 | 1032 | |
|
1033 | 1033 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
1034 | 1034 | """Prepare the module and namespace in which user code will be run. |
|
1035 | 1035 | |
|
1036 | 1036 | When IPython is started normally, both parameters are None: a new module |
|
1037 | 1037 | is created automatically, and its __dict__ used as the namespace. |
|
1038 | 1038 | |
|
1039 | 1039 | If only user_module is provided, its __dict__ is used as the namespace. |
|
1040 | 1040 | If only user_ns is provided, a dummy module is created, and user_ns |
|
1041 | 1041 | becomes the global namespace. If both are provided (as they may be |
|
1042 | 1042 | when embedding), user_ns is the local namespace, and user_module |
|
1043 | 1043 | provides the global namespace. |
|
1044 | 1044 | |
|
1045 | 1045 | Parameters |
|
1046 | 1046 | ---------- |
|
1047 | 1047 | user_module : module, optional |
|
1048 | 1048 | The current user module in which IPython is being run. If None, |
|
1049 | 1049 | a clean module will be created. |
|
1050 | 1050 | user_ns : dict, optional |
|
1051 | 1051 | A namespace in which to run interactive commands. |
|
1052 | 1052 | |
|
1053 | 1053 | Returns |
|
1054 | 1054 | ------- |
|
1055 | 1055 | A tuple of user_module and user_ns, each properly initialised. |
|
1056 | 1056 | """ |
|
1057 | 1057 | if user_module is None and user_ns is not None: |
|
1058 | 1058 | user_ns.setdefault("__name__", "__main__") |
|
1059 | 1059 | user_module = DummyMod() |
|
1060 | 1060 | user_module.__dict__ = user_ns |
|
1061 | 1061 | |
|
1062 | 1062 | if user_module is None: |
|
1063 | 1063 | user_module = types.ModuleType("__main__", |
|
1064 | 1064 | doc="Automatically created module for IPython interactive environment") |
|
1065 | 1065 | |
|
1066 | 1066 | # We must ensure that __builtin__ (without the final 's') is always |
|
1067 | 1067 | # available and pointing to the __builtin__ *module*. For more details: |
|
1068 | 1068 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1069 | 1069 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
1070 | 1070 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
1071 | 1071 | |
|
1072 | 1072 | if user_ns is None: |
|
1073 | 1073 | user_ns = user_module.__dict__ |
|
1074 | 1074 | |
|
1075 | 1075 | return user_module, user_ns |
|
1076 | 1076 | |
|
1077 | 1077 | def init_sys_modules(self): |
|
1078 | 1078 | # We need to insert into sys.modules something that looks like a |
|
1079 | 1079 | # module but which accesses the IPython namespace, for shelve and |
|
1080 | 1080 | # pickle to work interactively. Normally they rely on getting |
|
1081 | 1081 | # everything out of __main__, but for embedding purposes each IPython |
|
1082 | 1082 | # instance has its own private namespace, so we can't go shoving |
|
1083 | 1083 | # everything into __main__. |
|
1084 | 1084 | |
|
1085 | 1085 | # note, however, that we should only do this for non-embedded |
|
1086 | 1086 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1087 | 1087 | # namespace. Embedded instances, on the other hand, should not do |
|
1088 | 1088 | # this because they need to manage the user local/global namespaces |
|
1089 | 1089 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1090 | 1090 | # shouldn't overtake the execution environment of the script they're |
|
1091 | 1091 | # embedded in). |
|
1092 | 1092 | |
|
1093 | 1093 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1094 | 1094 | main_name = self.user_module.__name__ |
|
1095 | 1095 | sys.modules[main_name] = self.user_module |
|
1096 | 1096 | |
|
1097 | 1097 | def init_user_ns(self): |
|
1098 | 1098 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1099 | 1099 | |
|
1100 | 1100 | Certain history lists are also initialized here, as they effectively |
|
1101 | 1101 | act as user namespaces. |
|
1102 | 1102 | |
|
1103 | 1103 | Notes |
|
1104 | 1104 | ----- |
|
1105 | 1105 | All data structures here are only filled in, they are NOT reset by this |
|
1106 | 1106 | method. If they were not empty before, data will simply be added to |
|
1107 | 1107 | therm. |
|
1108 | 1108 | """ |
|
1109 | 1109 | # This function works in two parts: first we put a few things in |
|
1110 | 1110 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1111 | 1111 | # initial variables aren't shown by %who. After the sync, we add the |
|
1112 | 1112 | # rest of what we *do* want the user to see with %who even on a new |
|
1113 | 1113 | # session (probably nothing, so theye really only see their own stuff) |
|
1114 | 1114 | |
|
1115 | 1115 | # The user dict must *always* have a __builtin__ reference to the |
|
1116 | 1116 | # Python standard __builtin__ namespace, which must be imported. |
|
1117 | 1117 | # This is so that certain operations in prompt evaluation can be |
|
1118 | 1118 | # reliably executed with builtins. Note that we can NOT use |
|
1119 | 1119 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1120 | 1120 | # module, and can even mutate at runtime, depending on the context |
|
1121 | 1121 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1122 | 1122 | # always a module object, though it must be explicitly imported. |
|
1123 | 1123 | |
|
1124 | 1124 | # For more details: |
|
1125 | 1125 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1126 | 1126 | ns = dict() |
|
1127 | 1127 | |
|
1128 | 1128 | # Put 'help' in the user namespace |
|
1129 | 1129 | try: |
|
1130 | 1130 | from site import _Helper |
|
1131 | 1131 | ns['help'] = _Helper() |
|
1132 | 1132 | except ImportError: |
|
1133 | 1133 | warn('help() not available - check site.py') |
|
1134 | 1134 | |
|
1135 | 1135 | # make global variables for user access to the histories |
|
1136 | 1136 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1137 | 1137 | ns['_oh'] = self.history_manager.output_hist |
|
1138 | 1138 | ns['_dh'] = self.history_manager.dir_hist |
|
1139 | 1139 | |
|
1140 | 1140 | ns['_sh'] = shadowns |
|
1141 | 1141 | |
|
1142 | 1142 | # user aliases to input and output histories. These shouldn't show up |
|
1143 | 1143 | # in %who, as they can have very large reprs. |
|
1144 | 1144 | ns['In'] = self.history_manager.input_hist_parsed |
|
1145 | 1145 | ns['Out'] = self.history_manager.output_hist |
|
1146 | 1146 | |
|
1147 | 1147 | # Store myself as the public api!!! |
|
1148 | 1148 | ns['get_ipython'] = self.get_ipython |
|
1149 | 1149 | |
|
1150 | 1150 | ns['exit'] = self.exiter |
|
1151 | 1151 | ns['quit'] = self.exiter |
|
1152 | 1152 | |
|
1153 | 1153 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1154 | 1154 | # by %who |
|
1155 | 1155 | self.user_ns_hidden.update(ns) |
|
1156 | 1156 | |
|
1157 | 1157 | # Anything put into ns now would show up in %who. Think twice before |
|
1158 | 1158 | # putting anything here, as we really want %who to show the user their |
|
1159 | 1159 | # stuff, not our variables. |
|
1160 | 1160 | |
|
1161 | 1161 | # Finally, update the real user's namespace |
|
1162 | 1162 | self.user_ns.update(ns) |
|
1163 | 1163 | |
|
1164 | 1164 | @property |
|
1165 | 1165 | def all_ns_refs(self): |
|
1166 | 1166 | """Get a list of references to all the namespace dictionaries in which |
|
1167 | 1167 | IPython might store a user-created object. |
|
1168 | 1168 | |
|
1169 | 1169 | Note that this does not include the displayhook, which also caches |
|
1170 | 1170 | objects from the output.""" |
|
1171 | 1171 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ |
|
1172 | 1172 | [m.__dict__ for m in self._main_mod_cache.values()] |
|
1173 | 1173 | |
|
1174 | 1174 | def reset(self, new_session=True): |
|
1175 | 1175 | """Clear all internal namespaces, and attempt to release references to |
|
1176 | 1176 | user objects. |
|
1177 | 1177 | |
|
1178 | 1178 | If new_session is True, a new history session will be opened. |
|
1179 | 1179 | """ |
|
1180 | 1180 | # Clear histories |
|
1181 | 1181 | self.history_manager.reset(new_session) |
|
1182 | 1182 | # Reset counter used to index all histories |
|
1183 | 1183 | if new_session: |
|
1184 | 1184 | self.execution_count = 1 |
|
1185 | 1185 | |
|
1186 | 1186 | # Flush cached output items |
|
1187 | 1187 | if self.displayhook.do_full_cache: |
|
1188 | 1188 | self.displayhook.flush() |
|
1189 | 1189 | |
|
1190 | 1190 | # The main execution namespaces must be cleared very carefully, |
|
1191 | 1191 | # skipping the deletion of the builtin-related keys, because doing so |
|
1192 | 1192 | # would cause errors in many object's __del__ methods. |
|
1193 | 1193 | if self.user_ns is not self.user_global_ns: |
|
1194 | 1194 | self.user_ns.clear() |
|
1195 | 1195 | ns = self.user_global_ns |
|
1196 | 1196 | drop_keys = set(ns.keys()) |
|
1197 | 1197 | drop_keys.discard('__builtin__') |
|
1198 | 1198 | drop_keys.discard('__builtins__') |
|
1199 | 1199 | drop_keys.discard('__name__') |
|
1200 | 1200 | for k in drop_keys: |
|
1201 | 1201 | del ns[k] |
|
1202 | 1202 | |
|
1203 | 1203 | self.user_ns_hidden.clear() |
|
1204 | 1204 | |
|
1205 | 1205 | # Restore the user namespaces to minimal usability |
|
1206 | 1206 | self.init_user_ns() |
|
1207 | 1207 | |
|
1208 | 1208 | # Restore the default and user aliases |
|
1209 | 1209 | self.alias_manager.clear_aliases() |
|
1210 | 1210 | self.alias_manager.init_aliases() |
|
1211 | 1211 | |
|
1212 | 1212 | # Flush the private list of module references kept for script |
|
1213 | 1213 | # execution protection |
|
1214 | 1214 | self.clear_main_mod_cache() |
|
1215 | 1215 | |
|
1216 | 1216 | def del_var(self, varname, by_name=False): |
|
1217 | 1217 | """Delete a variable from the various namespaces, so that, as |
|
1218 | 1218 | far as possible, we're not keeping any hidden references to it. |
|
1219 | 1219 | |
|
1220 | 1220 | Parameters |
|
1221 | 1221 | ---------- |
|
1222 | 1222 | varname : str |
|
1223 | 1223 | The name of the variable to delete. |
|
1224 | 1224 | by_name : bool |
|
1225 | 1225 | If True, delete variables with the given name in each |
|
1226 | 1226 | namespace. If False (default), find the variable in the user |
|
1227 | 1227 | namespace, and delete references to it. |
|
1228 | 1228 | """ |
|
1229 | 1229 | if varname in ('__builtin__', '__builtins__'): |
|
1230 | 1230 | raise ValueError("Refusing to delete %s" % varname) |
|
1231 | 1231 | |
|
1232 | 1232 | ns_refs = self.all_ns_refs |
|
1233 | 1233 | |
|
1234 | 1234 | if by_name: # Delete by name |
|
1235 | 1235 | for ns in ns_refs: |
|
1236 | 1236 | try: |
|
1237 | 1237 | del ns[varname] |
|
1238 | 1238 | except KeyError: |
|
1239 | 1239 | pass |
|
1240 | 1240 | else: # Delete by object |
|
1241 | 1241 | try: |
|
1242 | 1242 | obj = self.user_ns[varname] |
|
1243 | 1243 | except KeyError: |
|
1244 | 1244 | raise NameError("name '%s' is not defined" % varname) |
|
1245 | 1245 | # Also check in output history |
|
1246 | 1246 | ns_refs.append(self.history_manager.output_hist) |
|
1247 | 1247 | for ns in ns_refs: |
|
1248 | 1248 | to_delete = [n for n, o in iteritems(ns) if o is obj] |
|
1249 | 1249 | for name in to_delete: |
|
1250 | 1250 | del ns[name] |
|
1251 | 1251 | |
|
1252 | 1252 | # displayhook keeps extra references, but not in a dictionary |
|
1253 | 1253 | for name in ('_', '__', '___'): |
|
1254 | 1254 | if getattr(self.displayhook, name) is obj: |
|
1255 | 1255 | setattr(self.displayhook, name, None) |
|
1256 | 1256 | |
|
1257 | 1257 | def reset_selective(self, regex=None): |
|
1258 | 1258 | """Clear selective variables from internal namespaces based on a |
|
1259 | 1259 | specified regular expression. |
|
1260 | 1260 | |
|
1261 | 1261 | Parameters |
|
1262 | 1262 | ---------- |
|
1263 | 1263 | regex : string or compiled pattern, optional |
|
1264 | 1264 | A regular expression pattern that will be used in searching |
|
1265 | 1265 | variable names in the users namespaces. |
|
1266 | 1266 | """ |
|
1267 | 1267 | if regex is not None: |
|
1268 | 1268 | try: |
|
1269 | 1269 | m = re.compile(regex) |
|
1270 | 1270 | except TypeError: |
|
1271 | 1271 | raise TypeError('regex must be a string or compiled pattern') |
|
1272 | 1272 | # Search for keys in each namespace that match the given regex |
|
1273 | 1273 | # If a match is found, delete the key/value pair. |
|
1274 | 1274 | for ns in self.all_ns_refs: |
|
1275 | 1275 | for var in ns: |
|
1276 | 1276 | if m.search(var): |
|
1277 | 1277 | del ns[var] |
|
1278 | 1278 | |
|
1279 | 1279 | def push(self, variables, interactive=True): |
|
1280 | 1280 | """Inject a group of variables into the IPython user namespace. |
|
1281 | 1281 | |
|
1282 | 1282 | Parameters |
|
1283 | 1283 | ---------- |
|
1284 | 1284 | variables : dict, str or list/tuple of str |
|
1285 | 1285 | The variables to inject into the user's namespace. If a dict, a |
|
1286 | 1286 | simple update is done. If a str, the string is assumed to have |
|
1287 | 1287 | variable names separated by spaces. A list/tuple of str can also |
|
1288 | 1288 | be used to give the variable names. If just the variable names are |
|
1289 | 1289 | give (list/tuple/str) then the variable values looked up in the |
|
1290 | 1290 | callers frame. |
|
1291 | 1291 | interactive : bool |
|
1292 | 1292 | If True (default), the variables will be listed with the ``who`` |
|
1293 | 1293 | magic. |
|
1294 | 1294 | """ |
|
1295 | 1295 | vdict = None |
|
1296 | 1296 | |
|
1297 | 1297 | # We need a dict of name/value pairs to do namespace updates. |
|
1298 | 1298 | if isinstance(variables, dict): |
|
1299 | 1299 | vdict = variables |
|
1300 | 1300 | elif isinstance(variables, string_types+(list, tuple)): |
|
1301 | 1301 | if isinstance(variables, string_types): |
|
1302 | 1302 | vlist = variables.split() |
|
1303 | 1303 | else: |
|
1304 | 1304 | vlist = variables |
|
1305 | 1305 | vdict = {} |
|
1306 | 1306 | cf = sys._getframe(1) |
|
1307 | 1307 | for name in vlist: |
|
1308 | 1308 | try: |
|
1309 | 1309 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1310 | 1310 | except: |
|
1311 | 1311 | print('Could not get variable %s from %s' % |
|
1312 | 1312 | (name,cf.f_code.co_name)) |
|
1313 | 1313 | else: |
|
1314 | 1314 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1315 | 1315 | |
|
1316 | 1316 | # Propagate variables to user namespace |
|
1317 | 1317 | self.user_ns.update(vdict) |
|
1318 | 1318 | |
|
1319 | 1319 | # And configure interactive visibility |
|
1320 | 1320 | user_ns_hidden = self.user_ns_hidden |
|
1321 | 1321 | if interactive: |
|
1322 | 1322 | for name in vdict: |
|
1323 | 1323 | user_ns_hidden.pop(name, None) |
|
1324 | 1324 | else: |
|
1325 | 1325 | user_ns_hidden.update(vdict) |
|
1326 | 1326 | |
|
1327 | 1327 | def drop_by_id(self, variables): |
|
1328 | 1328 | """Remove a dict of variables from the user namespace, if they are the |
|
1329 | 1329 | same as the values in the dictionary. |
|
1330 | 1330 | |
|
1331 | 1331 | This is intended for use by extensions: variables that they've added can |
|
1332 | 1332 | be taken back out if they are unloaded, without removing any that the |
|
1333 | 1333 | user has overwritten. |
|
1334 | 1334 | |
|
1335 | 1335 | Parameters |
|
1336 | 1336 | ---------- |
|
1337 | 1337 | variables : dict |
|
1338 | 1338 | A dictionary mapping object names (as strings) to the objects. |
|
1339 | 1339 | """ |
|
1340 | 1340 | for name, obj in iteritems(variables): |
|
1341 | 1341 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1342 | 1342 | del self.user_ns[name] |
|
1343 | 1343 | self.user_ns_hidden.pop(name, None) |
|
1344 | 1344 | |
|
1345 | 1345 | #------------------------------------------------------------------------- |
|
1346 | 1346 | # Things related to object introspection |
|
1347 | 1347 | #------------------------------------------------------------------------- |
|
1348 | 1348 | |
|
1349 | 1349 | def _ofind(self, oname, namespaces=None): |
|
1350 | 1350 | """Find an object in the available namespaces. |
|
1351 | 1351 | |
|
1352 | 1352 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1353 | 1353 | |
|
1354 | 1354 | Has special code to detect magic functions. |
|
1355 | 1355 | """ |
|
1356 | 1356 | oname = oname.strip() |
|
1357 | 1357 | #print '1- oname: <%r>' % oname # dbg |
|
1358 | 1358 | if not oname.startswith(ESC_MAGIC) and \ |
|
1359 | 1359 | not oname.startswith(ESC_MAGIC2) and \ |
|
1360 | 1360 | not py3compat.isidentifier(oname, dotted=True): |
|
1361 | 1361 | return dict(found=False) |
|
1362 | 1362 | |
|
1363 | 1363 | alias_ns = None |
|
1364 | 1364 | if namespaces is None: |
|
1365 | 1365 | # Namespaces to search in: |
|
1366 | 1366 | # Put them in a list. The order is important so that we |
|
1367 | 1367 | # find things in the same order that Python finds them. |
|
1368 | 1368 | namespaces = [ ('Interactive', self.user_ns), |
|
1369 | 1369 | ('Interactive (global)', self.user_global_ns), |
|
1370 | 1370 | ('Python builtin', builtin_mod.__dict__), |
|
1371 | 1371 | ] |
|
1372 | 1372 | |
|
1373 | 1373 | # initialize results to 'null' |
|
1374 | 1374 | found = False; obj = None; ospace = None; ds = None; |
|
1375 | 1375 | ismagic = False; isalias = False; parent = None |
|
1376 | 1376 | |
|
1377 | 1377 | # We need to special-case 'print', which as of python2.6 registers as a |
|
1378 | 1378 | # function but should only be treated as one if print_function was |
|
1379 | 1379 | # loaded with a future import. In this case, just bail. |
|
1380 | 1380 | if (oname == 'print' and not py3compat.PY3 and not \ |
|
1381 | 1381 | (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)): |
|
1382 | 1382 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1383 | 1383 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1384 | 1384 | |
|
1385 | 1385 | # Look for the given name by splitting it in parts. If the head is |
|
1386 | 1386 | # found, then we look for all the remaining parts as members, and only |
|
1387 | 1387 | # declare success if we can find them all. |
|
1388 | 1388 | oname_parts = oname.split('.') |
|
1389 | 1389 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1390 | 1390 | for nsname,ns in namespaces: |
|
1391 | 1391 | try: |
|
1392 | 1392 | obj = ns[oname_head] |
|
1393 | 1393 | except KeyError: |
|
1394 | 1394 | continue |
|
1395 | 1395 | else: |
|
1396 | 1396 | #print 'oname_rest:', oname_rest # dbg |
|
1397 | 1397 | for part in oname_rest: |
|
1398 | 1398 | try: |
|
1399 | 1399 | parent = obj |
|
1400 | 1400 | obj = getattr(obj,part) |
|
1401 | 1401 | except: |
|
1402 | 1402 | # Blanket except b/c some badly implemented objects |
|
1403 | 1403 | # allow __getattr__ to raise exceptions other than |
|
1404 | 1404 | # AttributeError, which then crashes IPython. |
|
1405 | 1405 | break |
|
1406 | 1406 | else: |
|
1407 | 1407 | # If we finish the for loop (no break), we got all members |
|
1408 | 1408 | found = True |
|
1409 | 1409 | ospace = nsname |
|
1410 | 1410 | break # namespace loop |
|
1411 | 1411 | |
|
1412 | 1412 | # Try to see if it's magic |
|
1413 | 1413 | if not found: |
|
1414 | 1414 | obj = None |
|
1415 | 1415 | if oname.startswith(ESC_MAGIC2): |
|
1416 | 1416 | oname = oname.lstrip(ESC_MAGIC2) |
|
1417 | 1417 | obj = self.find_cell_magic(oname) |
|
1418 | 1418 | elif oname.startswith(ESC_MAGIC): |
|
1419 | 1419 | oname = oname.lstrip(ESC_MAGIC) |
|
1420 | 1420 | obj = self.find_line_magic(oname) |
|
1421 | 1421 | else: |
|
1422 | 1422 | # search without prefix, so run? will find %run? |
|
1423 | 1423 | obj = self.find_line_magic(oname) |
|
1424 | 1424 | if obj is None: |
|
1425 | 1425 | obj = self.find_cell_magic(oname) |
|
1426 | 1426 | if obj is not None: |
|
1427 | 1427 | found = True |
|
1428 | 1428 | ospace = 'IPython internal' |
|
1429 | 1429 | ismagic = True |
|
1430 | 1430 | |
|
1431 | 1431 | # Last try: special-case some literals like '', [], {}, etc: |
|
1432 | 1432 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1433 | 1433 | obj = eval(oname_head) |
|
1434 | 1434 | found = True |
|
1435 | 1435 | ospace = 'Interactive' |
|
1436 | 1436 | |
|
1437 | 1437 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1438 | 1438 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1439 | 1439 | |
|
1440 | 1440 | def _ofind_property(self, oname, info): |
|
1441 | 1441 | """Second part of object finding, to look for property details.""" |
|
1442 | 1442 | if info.found: |
|
1443 | 1443 | # Get the docstring of the class property if it exists. |
|
1444 | 1444 | path = oname.split('.') |
|
1445 | 1445 | root = '.'.join(path[:-1]) |
|
1446 | 1446 | if info.parent is not None: |
|
1447 | 1447 | try: |
|
1448 | 1448 | target = getattr(info.parent, '__class__') |
|
1449 | 1449 | # The object belongs to a class instance. |
|
1450 | 1450 | try: |
|
1451 | 1451 | target = getattr(target, path[-1]) |
|
1452 | 1452 | # The class defines the object. |
|
1453 | 1453 | if isinstance(target, property): |
|
1454 | 1454 | oname = root + '.__class__.' + path[-1] |
|
1455 | 1455 | info = Struct(self._ofind(oname)) |
|
1456 | 1456 | except AttributeError: pass |
|
1457 | 1457 | except AttributeError: pass |
|
1458 | 1458 | |
|
1459 | 1459 | # We return either the new info or the unmodified input if the object |
|
1460 | 1460 | # hadn't been found |
|
1461 | 1461 | return info |
|
1462 | 1462 | |
|
1463 | 1463 | def _object_find(self, oname, namespaces=None): |
|
1464 | 1464 | """Find an object and return a struct with info about it.""" |
|
1465 | 1465 | inf = Struct(self._ofind(oname, namespaces)) |
|
1466 | 1466 | return Struct(self._ofind_property(oname, inf)) |
|
1467 | 1467 | |
|
1468 | 1468 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1469 | 1469 | """Generic interface to the inspector system. |
|
1470 | 1470 | |
|
1471 | 1471 | This function is meant to be called by pdef, pdoc & friends.""" |
|
1472 | 1472 | info = self._object_find(oname, namespaces) |
|
1473 | 1473 | if info.found: |
|
1474 | 1474 | pmethod = getattr(self.inspector, meth) |
|
1475 | 1475 | formatter = format_screen if info.ismagic else None |
|
1476 | 1476 | if meth == 'pdoc': |
|
1477 | 1477 | pmethod(info.obj, oname, formatter) |
|
1478 | 1478 | elif meth == 'pinfo': |
|
1479 | 1479 | pmethod(info.obj, oname, formatter, info, **kw) |
|
1480 | 1480 | else: |
|
1481 | 1481 | pmethod(info.obj, oname) |
|
1482 | 1482 | else: |
|
1483 | 1483 | print('Object `%s` not found.' % oname) |
|
1484 | 1484 | return 'not found' # so callers can take other action |
|
1485 | 1485 | |
|
1486 | 1486 | def object_inspect(self, oname, detail_level=0): |
|
1487 | 1487 | with self.builtin_trap: |
|
1488 | 1488 | info = self._object_find(oname) |
|
1489 | 1489 | if info.found: |
|
1490 | 1490 | return self.inspector.info(info.obj, oname, info=info, |
|
1491 | 1491 | detail_level=detail_level |
|
1492 | 1492 | ) |
|
1493 | 1493 | else: |
|
1494 | 1494 | return oinspect.object_info(name=oname, found=False) |
|
1495 | 1495 | |
|
1496 | 1496 | #------------------------------------------------------------------------- |
|
1497 | 1497 | # Things related to history management |
|
1498 | 1498 | #------------------------------------------------------------------------- |
|
1499 | 1499 | |
|
1500 | 1500 | def init_history(self): |
|
1501 | 1501 | """Sets up the command history, and starts regular autosaves.""" |
|
1502 | 1502 | self.history_manager = HistoryManager(shell=self, parent=self) |
|
1503 | 1503 | self.configurables.append(self.history_manager) |
|
1504 | 1504 | |
|
1505 | 1505 | #------------------------------------------------------------------------- |
|
1506 | 1506 | # Things related to exception handling and tracebacks (not debugging) |
|
1507 | 1507 | #------------------------------------------------------------------------- |
|
1508 | 1508 | |
|
1509 | 1509 | def init_traceback_handlers(self, custom_exceptions): |
|
1510 | 1510 | # Syntax error handler. |
|
1511 | 1511 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') |
|
1512 | 1512 | |
|
1513 | 1513 | # The interactive one is initialized with an offset, meaning we always |
|
1514 | 1514 | # want to remove the topmost item in the traceback, which is our own |
|
1515 | 1515 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1516 | 1516 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1517 | 1517 | color_scheme='NoColor', |
|
1518 | 1518 | tb_offset = 1, |
|
1519 | 1519 | check_cache=check_linecache_ipython) |
|
1520 | 1520 | |
|
1521 | 1521 | # The instance will store a pointer to the system-wide exception hook, |
|
1522 | 1522 | # so that runtime code (such as magics) can access it. This is because |
|
1523 | 1523 | # during the read-eval loop, it may get temporarily overwritten. |
|
1524 | 1524 | self.sys_excepthook = sys.excepthook |
|
1525 | 1525 | |
|
1526 | 1526 | # and add any custom exception handlers the user may have specified |
|
1527 | 1527 | self.set_custom_exc(*custom_exceptions) |
|
1528 | 1528 | |
|
1529 | 1529 | # Set the exception mode |
|
1530 | 1530 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1531 | 1531 | |
|
1532 | 1532 | def set_custom_exc(self, exc_tuple, handler): |
|
1533 | 1533 | """set_custom_exc(exc_tuple,handler) |
|
1534 | 1534 | |
|
1535 | 1535 | Set a custom exception handler, which will be called if any of the |
|
1536 | 1536 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1537 | 1537 | run_code() method). |
|
1538 | 1538 | |
|
1539 | 1539 | Parameters |
|
1540 | 1540 | ---------- |
|
1541 | 1541 | |
|
1542 | 1542 | exc_tuple : tuple of exception classes |
|
1543 | 1543 | A *tuple* of exception classes, for which to call the defined |
|
1544 | 1544 | handler. It is very important that you use a tuple, and NOT A |
|
1545 | 1545 | LIST here, because of the way Python's except statement works. If |
|
1546 | 1546 | you only want to trap a single exception, use a singleton tuple:: |
|
1547 | 1547 | |
|
1548 | 1548 | exc_tuple == (MyCustomException,) |
|
1549 | 1549 | |
|
1550 | 1550 | handler : callable |
|
1551 | 1551 | handler must have the following signature:: |
|
1552 | 1552 | |
|
1553 | 1553 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1554 | 1554 | ... |
|
1555 | 1555 | return structured_traceback |
|
1556 | 1556 | |
|
1557 | 1557 | Your handler must return a structured traceback (a list of strings), |
|
1558 | 1558 | or None. |
|
1559 | 1559 | |
|
1560 | 1560 | This will be made into an instance method (via types.MethodType) |
|
1561 | 1561 | of IPython itself, and it will be called if any of the exceptions |
|
1562 | 1562 | listed in the exc_tuple are caught. If the handler is None, an |
|
1563 | 1563 | internal basic one is used, which just prints basic info. |
|
1564 | 1564 | |
|
1565 | 1565 | To protect IPython from crashes, if your handler ever raises an |
|
1566 | 1566 | exception or returns an invalid result, it will be immediately |
|
1567 | 1567 | disabled. |
|
1568 | 1568 | |
|
1569 | 1569 | WARNING: by putting in your own exception handler into IPython's main |
|
1570 | 1570 | execution loop, you run a very good chance of nasty crashes. This |
|
1571 | 1571 | facility should only be used if you really know what you are doing.""" |
|
1572 | 1572 | |
|
1573 | 1573 | assert type(exc_tuple)==type(()) , \ |
|
1574 | 1574 | "The custom exceptions must be given AS A TUPLE." |
|
1575 | 1575 | |
|
1576 | 1576 | def dummy_handler(self,etype,value,tb,tb_offset=None): |
|
1577 | 1577 | print('*** Simple custom exception handler ***') |
|
1578 | 1578 | print('Exception type :',etype) |
|
1579 | 1579 | print('Exception value:',value) |
|
1580 | 1580 | print('Traceback :',tb) |
|
1581 | 1581 | #print 'Source code :','\n'.join(self.buffer) |
|
1582 | 1582 | |
|
1583 | 1583 | def validate_stb(stb): |
|
1584 | 1584 | """validate structured traceback return type |
|
1585 | 1585 | |
|
1586 | 1586 | return type of CustomTB *should* be a list of strings, but allow |
|
1587 | 1587 | single strings or None, which are harmless. |
|
1588 | 1588 | |
|
1589 | 1589 | This function will *always* return a list of strings, |
|
1590 | 1590 | and will raise a TypeError if stb is inappropriate. |
|
1591 | 1591 | """ |
|
1592 | 1592 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1593 | 1593 | if stb is None: |
|
1594 | 1594 | return [] |
|
1595 | 1595 | elif isinstance(stb, string_types): |
|
1596 | 1596 | return [stb] |
|
1597 | 1597 | elif not isinstance(stb, list): |
|
1598 | 1598 | raise TypeError(msg) |
|
1599 | 1599 | # it's a list |
|
1600 | 1600 | for line in stb: |
|
1601 | 1601 | # check every element |
|
1602 | 1602 | if not isinstance(line, string_types): |
|
1603 | 1603 | raise TypeError(msg) |
|
1604 | 1604 | return stb |
|
1605 | 1605 | |
|
1606 | 1606 | if handler is None: |
|
1607 | 1607 | wrapped = dummy_handler |
|
1608 | 1608 | else: |
|
1609 | 1609 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1610 | 1610 | """wrap CustomTB handler, to protect IPython from user code |
|
1611 | 1611 | |
|
1612 | 1612 | This makes it harder (but not impossible) for custom exception |
|
1613 | 1613 | handlers to crash IPython. |
|
1614 | 1614 | """ |
|
1615 | 1615 | try: |
|
1616 | 1616 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1617 | 1617 | return validate_stb(stb) |
|
1618 | 1618 | except: |
|
1619 | 1619 | # clear custom handler immediately |
|
1620 | 1620 | self.set_custom_exc((), None) |
|
1621 | 1621 | print("Custom TB Handler failed, unregistering", file=io.stderr) |
|
1622 | 1622 | # show the exception in handler first |
|
1623 | 1623 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1624 | 1624 | print(self.InteractiveTB.stb2text(stb), file=io.stdout) |
|
1625 | 1625 | print("The original exception:", file=io.stdout) |
|
1626 | 1626 | stb = self.InteractiveTB.structured_traceback( |
|
1627 | 1627 | (etype,value,tb), tb_offset=tb_offset |
|
1628 | 1628 | ) |
|
1629 | 1629 | return stb |
|
1630 | 1630 | |
|
1631 | 1631 | self.CustomTB = types.MethodType(wrapped,self) |
|
1632 | 1632 | self.custom_exceptions = exc_tuple |
|
1633 | 1633 | |
|
1634 | 1634 | def excepthook(self, etype, value, tb): |
|
1635 | 1635 | """One more defense for GUI apps that call sys.excepthook. |
|
1636 | 1636 | |
|
1637 | 1637 | GUI frameworks like wxPython trap exceptions and call |
|
1638 | 1638 | sys.excepthook themselves. I guess this is a feature that |
|
1639 | 1639 | enables them to keep running after exceptions that would |
|
1640 | 1640 | otherwise kill their mainloop. This is a bother for IPython |
|
1641 | 1641 | which excepts to catch all of the program exceptions with a try: |
|
1642 | 1642 | except: statement. |
|
1643 | 1643 | |
|
1644 | 1644 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1645 | 1645 | any app directly invokes sys.excepthook, it will look to the user like |
|
1646 | 1646 | IPython crashed. In order to work around this, we can disable the |
|
1647 | 1647 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1648 | 1648 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1649 | 1649 | call sys.excepthook will generate a regular-looking exception from |
|
1650 | 1650 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1651 | 1651 | crashes. |
|
1652 | 1652 | |
|
1653 | 1653 | This hook should be used sparingly, only in places which are not likely |
|
1654 | 1654 | to be true IPython errors. |
|
1655 | 1655 | """ |
|
1656 | 1656 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1657 | 1657 | |
|
1658 | 1658 | def _get_exc_info(self, exc_tuple=None): |
|
1659 | 1659 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. |
|
1660 | 1660 | |
|
1661 | 1661 | Ensures sys.last_type,value,traceback hold the exc_info we found, |
|
1662 | 1662 | from whichever source. |
|
1663 | 1663 | |
|
1664 | 1664 | raises ValueError if none of these contain any information |
|
1665 | 1665 | """ |
|
1666 | 1666 | if exc_tuple is None: |
|
1667 | 1667 | etype, value, tb = sys.exc_info() |
|
1668 | 1668 | else: |
|
1669 | 1669 | etype, value, tb = exc_tuple |
|
1670 | 1670 | |
|
1671 | 1671 | if etype is None: |
|
1672 | 1672 | if hasattr(sys, 'last_type'): |
|
1673 | 1673 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1674 | 1674 | sys.last_traceback |
|
1675 | 1675 | |
|
1676 | 1676 | if etype is None: |
|
1677 | 1677 | raise ValueError("No exception to find") |
|
1678 | 1678 | |
|
1679 | 1679 | # Now store the exception info in sys.last_type etc. |
|
1680 | 1680 | # WARNING: these variables are somewhat deprecated and not |
|
1681 | 1681 | # necessarily safe to use in a threaded environment, but tools |
|
1682 | 1682 | # like pdb depend on their existence, so let's set them. If we |
|
1683 | 1683 | # find problems in the field, we'll need to revisit their use. |
|
1684 | 1684 | sys.last_type = etype |
|
1685 | 1685 | sys.last_value = value |
|
1686 | 1686 | sys.last_traceback = tb |
|
1687 | 1687 | |
|
1688 | 1688 | return etype, value, tb |
|
1689 | 1689 | |
|
1690 | 1690 | def show_usage_error(self, exc): |
|
1691 | 1691 | """Show a short message for UsageErrors |
|
1692 | 1692 | |
|
1693 | 1693 | These are special exceptions that shouldn't show a traceback. |
|
1694 | 1694 | """ |
|
1695 | 1695 | self.write_err("UsageError: %s" % exc) |
|
1696 | 1696 | |
|
1697 | 1697 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, |
|
1698 | 1698 | exception_only=False): |
|
1699 | 1699 | """Display the exception that just occurred. |
|
1700 | 1700 | |
|
1701 | 1701 | If nothing is known about the exception, this is the method which |
|
1702 | 1702 | should be used throughout the code for presenting user tracebacks, |
|
1703 | 1703 | rather than directly invoking the InteractiveTB object. |
|
1704 | 1704 | |
|
1705 | 1705 | A specific showsyntaxerror() also exists, but this method can take |
|
1706 | 1706 | care of calling it if needed, so unless you are explicitly catching a |
|
1707 | 1707 | SyntaxError exception, don't try to analyze the stack manually and |
|
1708 | 1708 | simply call this method.""" |
|
1709 | 1709 | |
|
1710 | 1710 | try: |
|
1711 | 1711 | try: |
|
1712 | 1712 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
1713 | 1713 | except ValueError: |
|
1714 | 1714 | self.write_err('No traceback available to show.\n') |
|
1715 | 1715 | return |
|
1716 | 1716 | |
|
1717 | 1717 | if issubclass(etype, SyntaxError): |
|
1718 | 1718 | # Though this won't be called by syntax errors in the input |
|
1719 | 1719 | # line, there may be SyntaxError cases with imported code. |
|
1720 | 1720 | self.showsyntaxerror(filename) |
|
1721 | 1721 | elif etype is UsageError: |
|
1722 | 1722 | self.show_usage_error(value) |
|
1723 | 1723 | else: |
|
1724 | 1724 | if exception_only: |
|
1725 | 1725 | stb = ['An exception has occurred, use %tb to see ' |
|
1726 | 1726 | 'the full traceback.\n'] |
|
1727 | 1727 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
1728 | 1728 | value)) |
|
1729 | 1729 | else: |
|
1730 | 1730 | try: |
|
1731 | 1731 | # Exception classes can customise their traceback - we |
|
1732 | 1732 | # use this in IPython.parallel for exceptions occurring |
|
1733 | 1733 | # in the engines. This should return a list of strings. |
|
1734 | 1734 | stb = value._render_traceback_() |
|
1735 | 1735 | except Exception: |
|
1736 | 1736 | stb = self.InteractiveTB.structured_traceback(etype, |
|
1737 | 1737 | value, tb, tb_offset=tb_offset) |
|
1738 | 1738 | |
|
1739 | 1739 | self._showtraceback(etype, value, stb) |
|
1740 | 1740 | if self.call_pdb: |
|
1741 | 1741 | # drop into debugger |
|
1742 | 1742 | self.debugger(force=True) |
|
1743 | 1743 | return |
|
1744 | 1744 | |
|
1745 | 1745 | # Actually show the traceback |
|
1746 | 1746 | self._showtraceback(etype, value, stb) |
|
1747 | 1747 | |
|
1748 | 1748 | except KeyboardInterrupt: |
|
1749 | 1749 | self.write_err("\nKeyboardInterrupt\n") |
|
1750 | 1750 | |
|
1751 | 1751 | def _showtraceback(self, etype, evalue, stb): |
|
1752 | 1752 | """Actually show a traceback. |
|
1753 | 1753 | |
|
1754 | 1754 | Subclasses may override this method to put the traceback on a different |
|
1755 | 1755 | place, like a side channel. |
|
1756 | 1756 | """ |
|
1757 | 1757 | print(self.InteractiveTB.stb2text(stb), file=io.stdout) |
|
1758 | 1758 | |
|
1759 | 1759 | def showsyntaxerror(self, filename=None): |
|
1760 | 1760 | """Display the syntax error that just occurred. |
|
1761 | 1761 | |
|
1762 | 1762 | This doesn't display a stack trace because there isn't one. |
|
1763 | 1763 | |
|
1764 | 1764 | If a filename is given, it is stuffed in the exception instead |
|
1765 | 1765 | of what was there before (because Python's parser always uses |
|
1766 | 1766 | "<string>" when reading from a string). |
|
1767 | 1767 | """ |
|
1768 | 1768 | etype, value, last_traceback = self._get_exc_info() |
|
1769 | 1769 | |
|
1770 | 1770 | if filename and issubclass(etype, SyntaxError): |
|
1771 | 1771 | try: |
|
1772 | 1772 | value.filename = filename |
|
1773 | 1773 | except: |
|
1774 | 1774 | # Not the format we expect; leave it alone |
|
1775 | 1775 | pass |
|
1776 | 1776 | |
|
1777 | 1777 | stb = self.SyntaxTB.structured_traceback(etype, value, []) |
|
1778 | 1778 | self._showtraceback(etype, value, stb) |
|
1779 | 1779 | |
|
1780 | 1780 | # This is overridden in TerminalInteractiveShell to show a message about |
|
1781 | 1781 | # the %paste magic. |
|
1782 | 1782 | def showindentationerror(self): |
|
1783 | 1783 | """Called by run_cell when there's an IndentationError in code entered |
|
1784 | 1784 | at the prompt. |
|
1785 | 1785 | |
|
1786 | 1786 | This is overridden in TerminalInteractiveShell to show a message about |
|
1787 | 1787 | the %paste magic.""" |
|
1788 | 1788 | self.showsyntaxerror() |
|
1789 | 1789 | |
|
1790 | 1790 | #------------------------------------------------------------------------- |
|
1791 | 1791 | # Things related to readline |
|
1792 | 1792 | #------------------------------------------------------------------------- |
|
1793 | 1793 | |
|
1794 | 1794 | def init_readline(self): |
|
1795 | 1795 | """Command history completion/saving/reloading.""" |
|
1796 | 1796 | |
|
1797 | 1797 | if self.readline_use: |
|
1798 | 1798 | import IPython.utils.rlineimpl as readline |
|
1799 | 1799 | |
|
1800 | 1800 | self.rl_next_input = None |
|
1801 | 1801 | self.rl_do_indent = False |
|
1802 | 1802 | |
|
1803 | 1803 | if not self.readline_use or not readline.have_readline: |
|
1804 | 1804 | self.has_readline = False |
|
1805 | 1805 | self.readline = None |
|
1806 | 1806 | # Set a number of methods that depend on readline to be no-op |
|
1807 | 1807 | self.readline_no_record = no_op_context |
|
1808 | 1808 | self.set_readline_completer = no_op |
|
1809 | 1809 | self.set_custom_completer = no_op |
|
1810 | 1810 | if self.readline_use: |
|
1811 | 1811 | warn('Readline services not available or not loaded.') |
|
1812 | 1812 | else: |
|
1813 | 1813 | self.has_readline = True |
|
1814 | 1814 | self.readline = readline |
|
1815 | 1815 | sys.modules['readline'] = readline |
|
1816 | 1816 | |
|
1817 | 1817 | # Platform-specific configuration |
|
1818 | 1818 | if os.name == 'nt': |
|
1819 | 1819 | # FIXME - check with Frederick to see if we can harmonize |
|
1820 | 1820 | # naming conventions with pyreadline to avoid this |
|
1821 | 1821 | # platform-dependent check |
|
1822 | 1822 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1823 | 1823 | else: |
|
1824 | 1824 | self.readline_startup_hook = readline.set_startup_hook |
|
1825 | 1825 | |
|
1826 | 1826 | # Load user's initrc file (readline config) |
|
1827 | 1827 | # Or if libedit is used, load editrc. |
|
1828 | 1828 | inputrc_name = os.environ.get('INPUTRC') |
|
1829 | 1829 | if inputrc_name is None: |
|
1830 | 1830 | inputrc_name = '.inputrc' |
|
1831 | 1831 | if readline.uses_libedit: |
|
1832 | 1832 | inputrc_name = '.editrc' |
|
1833 | 1833 | inputrc_name = os.path.join(self.home_dir, inputrc_name) |
|
1834 | 1834 | if os.path.isfile(inputrc_name): |
|
1835 | 1835 | try: |
|
1836 | 1836 | readline.read_init_file(inputrc_name) |
|
1837 | 1837 | except: |
|
1838 | 1838 | warn('Problems reading readline initialization file <%s>' |
|
1839 | 1839 | % inputrc_name) |
|
1840 | 1840 | |
|
1841 | 1841 | # Configure readline according to user's prefs |
|
1842 | 1842 | # This is only done if GNU readline is being used. If libedit |
|
1843 | 1843 | # is being used (as on Leopard) the readline config is |
|
1844 | 1844 | # not run as the syntax for libedit is different. |
|
1845 | 1845 | if not readline.uses_libedit: |
|
1846 | 1846 | for rlcommand in self.readline_parse_and_bind: |
|
1847 | 1847 | #print "loading rl:",rlcommand # dbg |
|
1848 | 1848 | readline.parse_and_bind(rlcommand) |
|
1849 | 1849 | |
|
1850 | 1850 | # Remove some chars from the delimiters list. If we encounter |
|
1851 | 1851 | # unicode chars, discard them. |
|
1852 | 1852 | delims = readline.get_completer_delims() |
|
1853 | 1853 | if not py3compat.PY3: |
|
1854 | 1854 | delims = delims.encode("ascii", "ignore") |
|
1855 | 1855 | for d in self.readline_remove_delims: |
|
1856 | 1856 | delims = delims.replace(d, "") |
|
1857 | 1857 | delims = delims.replace(ESC_MAGIC, '') |
|
1858 | 1858 | readline.set_completer_delims(delims) |
|
1859 | 1859 | # Store these so we can restore them if something like rpy2 modifies |
|
1860 | 1860 | # them. |
|
1861 | 1861 | self.readline_delims = delims |
|
1862 | 1862 | # otherwise we end up with a monster history after a while: |
|
1863 | 1863 | readline.set_history_length(self.history_length) |
|
1864 | 1864 | |
|
1865 | 1865 | self.refill_readline_hist() |
|
1866 | 1866 | self.readline_no_record = ReadlineNoRecord(self) |
|
1867 | 1867 | |
|
1868 | 1868 | # Configure auto-indent for all platforms |
|
1869 | 1869 | self.set_autoindent(self.autoindent) |
|
1870 | 1870 | |
|
1871 | 1871 | def refill_readline_hist(self): |
|
1872 | 1872 | # Load the last 1000 lines from history |
|
1873 | 1873 | self.readline.clear_history() |
|
1874 | 1874 | stdin_encoding = sys.stdin.encoding or "utf-8" |
|
1875 | 1875 | last_cell = u"" |
|
1876 | 1876 | for _, _, cell in self.history_manager.get_tail(1000, |
|
1877 | 1877 | include_latest=True): |
|
1878 | 1878 | # Ignore blank lines and consecutive duplicates |
|
1879 | 1879 | cell = cell.rstrip() |
|
1880 | 1880 | if cell and (cell != last_cell): |
|
1881 | 1881 | try: |
|
1882 | 1882 | if self.multiline_history: |
|
1883 | 1883 | self.readline.add_history(py3compat.unicode_to_str(cell, |
|
1884 | 1884 | stdin_encoding)) |
|
1885 | 1885 | else: |
|
1886 | 1886 | for line in cell.splitlines(): |
|
1887 | 1887 | self.readline.add_history(py3compat.unicode_to_str(line, |
|
1888 | 1888 | stdin_encoding)) |
|
1889 | 1889 | last_cell = cell |
|
1890 | 1890 | |
|
1891 | 1891 | except TypeError: |
|
1892 | 1892 | # The history DB can get corrupted so it returns strings |
|
1893 | 1893 | # containing null bytes, which readline objects to. |
|
1894 | 1894 | continue |
|
1895 | 1895 | |
|
1896 | 1896 | @skip_doctest |
|
1897 | 1897 | def set_next_input(self, s): |
|
1898 | 1898 | """ Sets the 'default' input string for the next command line. |
|
1899 | 1899 | |
|
1900 | 1900 | Requires readline. |
|
1901 | 1901 | |
|
1902 | 1902 | Example:: |
|
1903 | 1903 | |
|
1904 | 1904 | In [1]: _ip.set_next_input("Hello Word") |
|
1905 | 1905 | In [2]: Hello Word_ # cursor is here |
|
1906 | 1906 | """ |
|
1907 | 1907 | self.rl_next_input = py3compat.cast_bytes_py2(s) |
|
1908 | 1908 | |
|
1909 | 1909 | # Maybe move this to the terminal subclass? |
|
1910 | 1910 | def pre_readline(self): |
|
1911 | 1911 | """readline hook to be used at the start of each line. |
|
1912 | 1912 | |
|
1913 | 1913 | Currently it handles auto-indent only.""" |
|
1914 | 1914 | |
|
1915 | 1915 | if self.rl_do_indent: |
|
1916 | 1916 | self.readline.insert_text(self._indent_current_str()) |
|
1917 | 1917 | if self.rl_next_input is not None: |
|
1918 | 1918 | self.readline.insert_text(self.rl_next_input) |
|
1919 | 1919 | self.rl_next_input = None |
|
1920 | 1920 | |
|
1921 | 1921 | def _indent_current_str(self): |
|
1922 | 1922 | """return the current level of indentation as a string""" |
|
1923 | 1923 | return self.input_splitter.indent_spaces * ' ' |
|
1924 | 1924 | |
|
1925 | 1925 | #------------------------------------------------------------------------- |
|
1926 | 1926 | # Things related to text completion |
|
1927 | 1927 | #------------------------------------------------------------------------- |
|
1928 | 1928 | |
|
1929 | 1929 | def init_completer(self): |
|
1930 | 1930 | """Initialize the completion machinery. |
|
1931 | 1931 | |
|
1932 | 1932 | This creates completion machinery that can be used by client code, |
|
1933 | 1933 | either interactively in-process (typically triggered by the readline |
|
1934 | 1934 | library), programatically (such as in test suites) or out-of-prcess |
|
1935 | 1935 | (typically over the network by remote frontends). |
|
1936 | 1936 | """ |
|
1937 | 1937 | from IPython.core.completer import IPCompleter |
|
1938 | 1938 | from IPython.core.completerlib import (module_completer, |
|
1939 | 1939 | magic_run_completer, cd_completer, reset_completer) |
|
1940 | 1940 | |
|
1941 | 1941 | self.Completer = IPCompleter(shell=self, |
|
1942 | 1942 | namespace=self.user_ns, |
|
1943 | 1943 | global_namespace=self.user_global_ns, |
|
1944 | 1944 | use_readline=self.has_readline, |
|
1945 | 1945 | parent=self, |
|
1946 | 1946 | ) |
|
1947 | 1947 | self.configurables.append(self.Completer) |
|
1948 | 1948 | |
|
1949 | 1949 | # Add custom completers to the basic ones built into IPCompleter |
|
1950 | 1950 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1951 | 1951 | self.strdispatchers['complete_command'] = sdisp |
|
1952 | 1952 | self.Completer.custom_completers = sdisp |
|
1953 | 1953 | |
|
1954 | 1954 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
1955 | 1955 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
1956 | 1956 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
1957 | 1957 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
1958 | 1958 | self.set_hook('complete_command', reset_completer, str_key = '%reset') |
|
1959 | 1959 | |
|
1960 | 1960 | # Only configure readline if we truly are using readline. IPython can |
|
1961 | 1961 | # do tab-completion over the network, in GUIs, etc, where readline |
|
1962 | 1962 | # itself may be absent |
|
1963 | 1963 | if self.has_readline: |
|
1964 | 1964 | self.set_readline_completer() |
|
1965 | 1965 | |
|
1966 | 1966 | def complete(self, text, line=None, cursor_pos=None): |
|
1967 | 1967 | """Return the completed text and a list of completions. |
|
1968 | 1968 | |
|
1969 | 1969 | Parameters |
|
1970 | 1970 | ---------- |
|
1971 | 1971 | |
|
1972 | 1972 | text : string |
|
1973 | 1973 | A string of text to be completed on. It can be given as empty and |
|
1974 | 1974 | instead a line/position pair are given. In this case, the |
|
1975 | 1975 | completer itself will split the line like readline does. |
|
1976 | 1976 | |
|
1977 | 1977 | line : string, optional |
|
1978 | 1978 | The complete line that text is part of. |
|
1979 | 1979 | |
|
1980 | 1980 | cursor_pos : int, optional |
|
1981 | 1981 | The position of the cursor on the input line. |
|
1982 | 1982 | |
|
1983 | 1983 | Returns |
|
1984 | 1984 | ------- |
|
1985 | 1985 | text : string |
|
1986 | 1986 | The actual text that was completed. |
|
1987 | 1987 | |
|
1988 | 1988 | matches : list |
|
1989 | 1989 | A sorted list with all possible completions. |
|
1990 | 1990 | |
|
1991 | 1991 | The optional arguments allow the completion to take more context into |
|
1992 | 1992 | account, and are part of the low-level completion API. |
|
1993 | 1993 | |
|
1994 | 1994 | This is a wrapper around the completion mechanism, similar to what |
|
1995 | 1995 | readline does at the command line when the TAB key is hit. By |
|
1996 | 1996 | exposing it as a method, it can be used by other non-readline |
|
1997 | 1997 | environments (such as GUIs) for text completion. |
|
1998 | 1998 | |
|
1999 | 1999 | Simple usage example: |
|
2000 | 2000 | |
|
2001 | 2001 | In [1]: x = 'hello' |
|
2002 | 2002 | |
|
2003 | 2003 | In [2]: _ip.complete('x.l') |
|
2004 | 2004 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
2005 | 2005 | """ |
|
2006 | 2006 | |
|
2007 | 2007 | # Inject names into __builtin__ so we can complete on the added names. |
|
2008 | 2008 | with self.builtin_trap: |
|
2009 | 2009 | return self.Completer.complete(text, line, cursor_pos) |
|
2010 | 2010 | |
|
2011 | 2011 | def set_custom_completer(self, completer, pos=0): |
|
2012 | 2012 | """Adds a new custom completer function. |
|
2013 | 2013 | |
|
2014 | 2014 | The position argument (defaults to 0) is the index in the completers |
|
2015 | 2015 | list where you want the completer to be inserted.""" |
|
2016 | 2016 | |
|
2017 | 2017 | newcomp = types.MethodType(completer,self.Completer) |
|
2018 | 2018 | self.Completer.matchers.insert(pos,newcomp) |
|
2019 | 2019 | |
|
2020 | 2020 | def set_readline_completer(self): |
|
2021 | 2021 | """Reset readline's completer to be our own.""" |
|
2022 | 2022 | self.readline.set_completer(self.Completer.rlcomplete) |
|
2023 | 2023 | |
|
2024 | 2024 | def set_completer_frame(self, frame=None): |
|
2025 | 2025 | """Set the frame of the completer.""" |
|
2026 | 2026 | if frame: |
|
2027 | 2027 | self.Completer.namespace = frame.f_locals |
|
2028 | 2028 | self.Completer.global_namespace = frame.f_globals |
|
2029 | 2029 | else: |
|
2030 | 2030 | self.Completer.namespace = self.user_ns |
|
2031 | 2031 | self.Completer.global_namespace = self.user_global_ns |
|
2032 | 2032 | |
|
2033 | 2033 | #------------------------------------------------------------------------- |
|
2034 | 2034 | # Things related to magics |
|
2035 | 2035 | #------------------------------------------------------------------------- |
|
2036 | 2036 | |
|
2037 | 2037 | def init_magics(self): |
|
2038 | 2038 | from IPython.core import magics as m |
|
2039 | 2039 | self.magics_manager = magic.MagicsManager(shell=self, |
|
2040 | 2040 | parent=self, |
|
2041 | 2041 | user_magics=m.UserMagics(self)) |
|
2042 | 2042 | self.configurables.append(self.magics_manager) |
|
2043 | 2043 | |
|
2044 | 2044 | # Expose as public API from the magics manager |
|
2045 | 2045 | self.register_magics = self.magics_manager.register |
|
2046 | 2046 | self.define_magic = self.magics_manager.define_magic |
|
2047 | 2047 | |
|
2048 | 2048 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, |
|
2049 | 2049 | m.ConfigMagics, m.DeprecatedMagics, m.DisplayMagics, m.ExecutionMagics, |
|
2050 | 2050 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, |
|
2051 | 2051 | m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics, |
|
2052 | 2052 | ) |
|
2053 | 2053 | |
|
2054 | 2054 | # Register Magic Aliases |
|
2055 | 2055 | mman = self.magics_manager |
|
2056 | 2056 | # FIXME: magic aliases should be defined by the Magics classes |
|
2057 | 2057 | # or in MagicsManager, not here |
|
2058 | 2058 | mman.register_alias('ed', 'edit') |
|
2059 | 2059 | mman.register_alias('hist', 'history') |
|
2060 | 2060 | mman.register_alias('rep', 'recall') |
|
2061 | 2061 | mman.register_alias('SVG', 'svg', 'cell') |
|
2062 | 2062 | mman.register_alias('HTML', 'html', 'cell') |
|
2063 | 2063 | mman.register_alias('file', 'writefile', 'cell') |
|
2064 | 2064 | |
|
2065 | 2065 | # FIXME: Move the color initialization to the DisplayHook, which |
|
2066 | 2066 | # should be split into a prompt manager and displayhook. We probably |
|
2067 | 2067 | # even need a centralize colors management object. |
|
2068 | 2068 | self.magic('colors %s' % self.colors) |
|
2069 | 2069 | |
|
2070 | 2070 | # Defined here so that it's included in the documentation |
|
2071 | 2071 | @functools.wraps(magic.MagicsManager.register_function) |
|
2072 | 2072 | def register_magic_function(self, func, magic_kind='line', magic_name=None): |
|
2073 | 2073 | self.magics_manager.register_function(func, |
|
2074 | 2074 | magic_kind=magic_kind, magic_name=magic_name) |
|
2075 | 2075 | |
|
2076 | 2076 | def run_line_magic(self, magic_name, line): |
|
2077 | 2077 | """Execute the given line magic. |
|
2078 | 2078 | |
|
2079 | 2079 | Parameters |
|
2080 | 2080 | ---------- |
|
2081 | 2081 | magic_name : str |
|
2082 | 2082 | Name of the desired magic function, without '%' prefix. |
|
2083 | 2083 | |
|
2084 | 2084 | line : str |
|
2085 | 2085 | The rest of the input line as a single string. |
|
2086 | 2086 | """ |
|
2087 | 2087 | fn = self.find_line_magic(magic_name) |
|
2088 | 2088 | if fn is None: |
|
2089 | 2089 | cm = self.find_cell_magic(magic_name) |
|
2090 | 2090 | etpl = "Line magic function `%%%s` not found%s." |
|
2091 | 2091 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' |
|
2092 | 2092 | 'did you mean that instead?)' % magic_name ) |
|
2093 | 2093 | error(etpl % (magic_name, extra)) |
|
2094 | 2094 | else: |
|
2095 | 2095 | # Note: this is the distance in the stack to the user's frame. |
|
2096 | 2096 | # This will need to be updated if the internal calling logic gets |
|
2097 | 2097 | # refactored, or else we'll be expanding the wrong variables. |
|
2098 | 2098 | stack_depth = 2 |
|
2099 | 2099 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2100 | 2100 | # Put magic args in a list so we can call with f(*a) syntax |
|
2101 | 2101 | args = [magic_arg_s] |
|
2102 | 2102 | kwargs = {} |
|
2103 | 2103 | # Grab local namespace if we need it: |
|
2104 | 2104 | if getattr(fn, "needs_local_scope", False): |
|
2105 | 2105 | kwargs['local_ns'] = sys._getframe(stack_depth).f_locals |
|
2106 | 2106 | with self.builtin_trap: |
|
2107 | 2107 | result = fn(*args,**kwargs) |
|
2108 | 2108 | return result |
|
2109 | 2109 | |
|
2110 | 2110 | def run_cell_magic(self, magic_name, line, cell): |
|
2111 | 2111 | """Execute the given cell magic. |
|
2112 | 2112 | |
|
2113 | 2113 | Parameters |
|
2114 | 2114 | ---------- |
|
2115 | 2115 | magic_name : str |
|
2116 | 2116 | Name of the desired magic function, without '%' prefix. |
|
2117 | 2117 | |
|
2118 | 2118 | line : str |
|
2119 | 2119 | The rest of the first input line as a single string. |
|
2120 | 2120 | |
|
2121 | 2121 | cell : str |
|
2122 | 2122 | The body of the cell as a (possibly multiline) string. |
|
2123 | 2123 | """ |
|
2124 | 2124 | fn = self.find_cell_magic(magic_name) |
|
2125 | 2125 | if fn is None: |
|
2126 | 2126 | lm = self.find_line_magic(magic_name) |
|
2127 | 2127 | etpl = "Cell magic `%%{0}` not found{1}." |
|
2128 | 2128 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' |
|
2129 | 2129 | 'did you mean that instead?)'.format(magic_name)) |
|
2130 | 2130 | error(etpl.format(magic_name, extra)) |
|
2131 | 2131 | elif cell == '': |
|
2132 | 2132 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) |
|
2133 | 2133 | if self.find_line_magic(magic_name) is not None: |
|
2134 | 2134 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) |
|
2135 | 2135 | raise UsageError(message) |
|
2136 | 2136 | else: |
|
2137 | 2137 | # Note: this is the distance in the stack to the user's frame. |
|
2138 | 2138 | # This will need to be updated if the internal calling logic gets |
|
2139 | 2139 | # refactored, or else we'll be expanding the wrong variables. |
|
2140 | 2140 | stack_depth = 2 |
|
2141 | 2141 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2142 | 2142 | with self.builtin_trap: |
|
2143 | 2143 | result = fn(magic_arg_s, cell) |
|
2144 | 2144 | return result |
|
2145 | 2145 | |
|
2146 | 2146 | def find_line_magic(self, magic_name): |
|
2147 | 2147 | """Find and return a line magic by name. |
|
2148 | 2148 | |
|
2149 | 2149 | Returns None if the magic isn't found.""" |
|
2150 | 2150 | return self.magics_manager.magics['line'].get(magic_name) |
|
2151 | 2151 | |
|
2152 | 2152 | def find_cell_magic(self, magic_name): |
|
2153 | 2153 | """Find and return a cell magic by name. |
|
2154 | 2154 | |
|
2155 | 2155 | Returns None if the magic isn't found.""" |
|
2156 | 2156 | return self.magics_manager.magics['cell'].get(magic_name) |
|
2157 | 2157 | |
|
2158 | 2158 | def find_magic(self, magic_name, magic_kind='line'): |
|
2159 | 2159 | """Find and return a magic of the given type by name. |
|
2160 | 2160 | |
|
2161 | 2161 | Returns None if the magic isn't found.""" |
|
2162 | 2162 | return self.magics_manager.magics[magic_kind].get(magic_name) |
|
2163 | 2163 | |
|
2164 | 2164 | def magic(self, arg_s): |
|
2165 | 2165 | """DEPRECATED. Use run_line_magic() instead. |
|
2166 | 2166 | |
|
2167 | 2167 | Call a magic function by name. |
|
2168 | 2168 | |
|
2169 | 2169 | Input: a string containing the name of the magic function to call and |
|
2170 | 2170 | any additional arguments to be passed to the magic. |
|
2171 | 2171 | |
|
2172 | 2172 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
2173 | 2173 | prompt: |
|
2174 | 2174 | |
|
2175 | 2175 | In[1]: %name -opt foo bar |
|
2176 | 2176 | |
|
2177 | 2177 | To call a magic without arguments, simply use magic('name'). |
|
2178 | 2178 | |
|
2179 | 2179 | This provides a proper Python function to call IPython's magics in any |
|
2180 | 2180 | valid Python code you can type at the interpreter, including loops and |
|
2181 | 2181 | compound statements. |
|
2182 | 2182 | """ |
|
2183 | 2183 | # TODO: should we issue a loud deprecation warning here? |
|
2184 | 2184 | magic_name, _, magic_arg_s = arg_s.partition(' ') |
|
2185 | 2185 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
2186 | 2186 | return self.run_line_magic(magic_name, magic_arg_s) |
|
2187 | 2187 | |
|
2188 | 2188 | #------------------------------------------------------------------------- |
|
2189 | 2189 | # Things related to macros |
|
2190 | 2190 | #------------------------------------------------------------------------- |
|
2191 | 2191 | |
|
2192 | 2192 | def define_macro(self, name, themacro): |
|
2193 | 2193 | """Define a new macro |
|
2194 | 2194 | |
|
2195 | 2195 | Parameters |
|
2196 | 2196 | ---------- |
|
2197 | 2197 | name : str |
|
2198 | 2198 | The name of the macro. |
|
2199 | 2199 | themacro : str or Macro |
|
2200 | 2200 | The action to do upon invoking the macro. If a string, a new |
|
2201 | 2201 | Macro object is created by passing the string to it. |
|
2202 | 2202 | """ |
|
2203 | 2203 | |
|
2204 | 2204 | from IPython.core import macro |
|
2205 | 2205 | |
|
2206 | 2206 | if isinstance(themacro, string_types): |
|
2207 | 2207 | themacro = macro.Macro(themacro) |
|
2208 | 2208 | if not isinstance(themacro, macro.Macro): |
|
2209 | 2209 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2210 | 2210 | self.user_ns[name] = themacro |
|
2211 | 2211 | |
|
2212 | 2212 | #------------------------------------------------------------------------- |
|
2213 | 2213 | # Things related to the running of system commands |
|
2214 | 2214 | #------------------------------------------------------------------------- |
|
2215 | 2215 | |
|
2216 | 2216 | def system_piped(self, cmd): |
|
2217 | 2217 | """Call the given cmd in a subprocess, piping stdout/err |
|
2218 | 2218 | |
|
2219 | 2219 | Parameters |
|
2220 | 2220 | ---------- |
|
2221 | 2221 | cmd : str |
|
2222 | 2222 | Command to execute (can not end in '&', as background processes are |
|
2223 | 2223 | not supported. Should not be a command that expects input |
|
2224 | 2224 | other than simple text. |
|
2225 | 2225 | """ |
|
2226 | 2226 | if cmd.rstrip().endswith('&'): |
|
2227 | 2227 | # this is *far* from a rigorous test |
|
2228 | 2228 | # We do not support backgrounding processes because we either use |
|
2229 | 2229 | # pexpect or pipes to read from. Users can always just call |
|
2230 | 2230 | # os.system() or use ip.system=ip.system_raw |
|
2231 | 2231 | # if they really want a background process. |
|
2232 | 2232 | raise OSError("Background processes not supported.") |
|
2233 | 2233 | |
|
2234 | 2234 | # we explicitly do NOT return the subprocess status code, because |
|
2235 | 2235 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2236 | 2236 | # Instead, we store the exit_code in user_ns. |
|
2237 | 2237 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) |
|
2238 | 2238 | |
|
2239 | 2239 | def system_raw(self, cmd): |
|
2240 | 2240 | """Call the given cmd in a subprocess using os.system on Windows or |
|
2241 | 2241 | subprocess.call using the system shell on other platforms. |
|
2242 | 2242 | |
|
2243 | 2243 | Parameters |
|
2244 | 2244 | ---------- |
|
2245 | 2245 | cmd : str |
|
2246 | 2246 | Command to execute. |
|
2247 | 2247 | """ |
|
2248 | 2248 | cmd = self.var_expand(cmd, depth=1) |
|
2249 | 2249 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2250 | 2250 | if sys.platform == 'win32': |
|
2251 | 2251 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2252 | 2252 | with AvoidUNCPath() as path: |
|
2253 | 2253 | if path is not None: |
|
2254 | 2254 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2255 | 2255 | cmd = py3compat.unicode_to_str(cmd) |
|
2256 | 2256 | ec = os.system(cmd) |
|
2257 | 2257 | else: |
|
2258 | 2258 | cmd = py3compat.unicode_to_str(cmd) |
|
2259 | 2259 | # Call the cmd using the OS shell, instead of the default /bin/sh, if set. |
|
2260 | 2260 | ec = subprocess.call(cmd, shell=True, executable=os.environ.get('SHELL', None)) |
|
2261 | 2261 | # exit code is positive for program failure, or negative for |
|
2262 | 2262 | # terminating signal number. |
|
2263 | 2263 | |
|
2264 | 2264 | # We explicitly do NOT return the subprocess status code, because |
|
2265 | 2265 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2266 | 2266 | # Instead, we store the exit_code in user_ns. |
|
2267 | 2267 | self.user_ns['_exit_code'] = ec |
|
2268 | 2268 | |
|
2269 | 2269 | # use piped system by default, because it is better behaved |
|
2270 | 2270 | system = system_piped |
|
2271 | 2271 | |
|
2272 | 2272 | def getoutput(self, cmd, split=True, depth=0): |
|
2273 | 2273 | """Get output (possibly including stderr) from a subprocess. |
|
2274 | 2274 | |
|
2275 | 2275 | Parameters |
|
2276 | 2276 | ---------- |
|
2277 | 2277 | cmd : str |
|
2278 | 2278 | Command to execute (can not end in '&', as background processes are |
|
2279 | 2279 | not supported. |
|
2280 | 2280 | split : bool, optional |
|
2281 | 2281 | If True, split the output into an IPython SList. Otherwise, an |
|
2282 | 2282 | IPython LSString is returned. These are objects similar to normal |
|
2283 | 2283 | lists and strings, with a few convenience attributes for easier |
|
2284 | 2284 | manipulation of line-based output. You can use '?' on them for |
|
2285 | 2285 | details. |
|
2286 | 2286 | depth : int, optional |
|
2287 | 2287 | How many frames above the caller are the local variables which should |
|
2288 | 2288 | be expanded in the command string? The default (0) assumes that the |
|
2289 | 2289 | expansion variables are in the stack frame calling this function. |
|
2290 | 2290 | """ |
|
2291 | 2291 | if cmd.rstrip().endswith('&'): |
|
2292 | 2292 | # this is *far* from a rigorous test |
|
2293 | 2293 | raise OSError("Background processes not supported.") |
|
2294 | 2294 | out = getoutput(self.var_expand(cmd, depth=depth+1)) |
|
2295 | 2295 | if split: |
|
2296 | 2296 | out = SList(out.splitlines()) |
|
2297 | 2297 | else: |
|
2298 | 2298 | out = LSString(out) |
|
2299 | 2299 | return out |
|
2300 | 2300 | |
|
2301 | 2301 | #------------------------------------------------------------------------- |
|
2302 | 2302 | # Things related to aliases |
|
2303 | 2303 | #------------------------------------------------------------------------- |
|
2304 | 2304 | |
|
2305 | 2305 | def init_alias(self): |
|
2306 | 2306 | self.alias_manager = AliasManager(shell=self, parent=self) |
|
2307 | 2307 | self.configurables.append(self.alias_manager) |
|
2308 | 2308 | |
|
2309 | 2309 | #------------------------------------------------------------------------- |
|
2310 | 2310 | # Things related to extensions |
|
2311 | 2311 | #------------------------------------------------------------------------- |
|
2312 | 2312 | |
|
2313 | 2313 | def init_extension_manager(self): |
|
2314 | 2314 | self.extension_manager = ExtensionManager(shell=self, parent=self) |
|
2315 | 2315 | self.configurables.append(self.extension_manager) |
|
2316 | 2316 | |
|
2317 | 2317 | #------------------------------------------------------------------------- |
|
2318 | 2318 | # Things related to payloads |
|
2319 | 2319 | #------------------------------------------------------------------------- |
|
2320 | 2320 | |
|
2321 | 2321 | def init_payload(self): |
|
2322 | 2322 | self.payload_manager = PayloadManager(parent=self) |
|
2323 | 2323 | self.configurables.append(self.payload_manager) |
|
2324 | 2324 | |
|
2325 | 2325 | #------------------------------------------------------------------------- |
|
2326 | 2326 | # Things related to widgets |
|
2327 | 2327 | #------------------------------------------------------------------------- |
|
2328 | 2328 | |
|
2329 | 2329 | def init_comms(self): |
|
2330 | 2330 | # not implemented in the base class |
|
2331 | 2331 | pass |
|
2332 | 2332 | |
|
2333 | 2333 | #------------------------------------------------------------------------- |
|
2334 | 2334 | # Things related to the prefilter |
|
2335 | 2335 | #------------------------------------------------------------------------- |
|
2336 | 2336 | |
|
2337 | 2337 | def init_prefilter(self): |
|
2338 | 2338 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) |
|
2339 | 2339 | self.configurables.append(self.prefilter_manager) |
|
2340 | 2340 | # Ultimately this will be refactored in the new interpreter code, but |
|
2341 | 2341 | # for now, we should expose the main prefilter method (there's legacy |
|
2342 | 2342 | # code out there that may rely on this). |
|
2343 | 2343 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2344 | 2344 | |
|
2345 | 2345 | def auto_rewrite_input(self, cmd): |
|
2346 | 2346 | """Print to the screen the rewritten form of the user's command. |
|
2347 | 2347 | |
|
2348 | 2348 | This shows visual feedback by rewriting input lines that cause |
|
2349 | 2349 | automatic calling to kick in, like:: |
|
2350 | 2350 | |
|
2351 | 2351 | /f x |
|
2352 | 2352 | |
|
2353 | 2353 | into:: |
|
2354 | 2354 | |
|
2355 | 2355 | ------> f(x) |
|
2356 | 2356 | |
|
2357 | 2357 | after the user's input prompt. This helps the user understand that the |
|
2358 | 2358 | input line was transformed automatically by IPython. |
|
2359 | 2359 | """ |
|
2360 | 2360 | if not self.show_rewritten_input: |
|
2361 | 2361 | return |
|
2362 | 2362 | |
|
2363 | 2363 | rw = self.prompt_manager.render('rewrite') + cmd |
|
2364 | 2364 | |
|
2365 | 2365 | try: |
|
2366 | 2366 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2367 | 2367 | # we use it and only print uncolored rewrite if we have unicode |
|
2368 | 2368 | rw = str(rw) |
|
2369 | 2369 | print(rw, file=io.stdout) |
|
2370 | 2370 | except UnicodeEncodeError: |
|
2371 | 2371 | print("------> " + cmd) |
|
2372 | 2372 | |
|
2373 | 2373 | #------------------------------------------------------------------------- |
|
2374 | 2374 | # Things related to extracting values/expressions from kernel and user_ns |
|
2375 | 2375 | #------------------------------------------------------------------------- |
|
2376 | 2376 | |
|
2377 | 2377 | def _user_obj_error(self): |
|
2378 | 2378 | """return simple exception dict |
|
2379 | 2379 | |
|
2380 | 2380 | for use in user_variables / expressions |
|
2381 | 2381 | """ |
|
2382 | 2382 | |
|
2383 | 2383 | etype, evalue, tb = self._get_exc_info() |
|
2384 | 2384 | stb = self.InteractiveTB.get_exception_only(etype, evalue) |
|
2385 | 2385 | |
|
2386 | 2386 | exc_info = { |
|
2387 | 2387 | u'status' : 'error', |
|
2388 | 2388 | u'traceback' : stb, |
|
2389 | 2389 | u'ename' : unicode_type(etype.__name__), |
|
2390 | 2390 | u'evalue' : py3compat.safe_unicode(evalue), |
|
2391 | 2391 | } |
|
2392 | 2392 | |
|
2393 | 2393 | return exc_info |
|
2394 | 2394 | |
|
2395 | 2395 | def _format_user_obj(self, obj): |
|
2396 | 2396 | """format a user object to display dict |
|
2397 | 2397 | |
|
2398 | 2398 | for use in user_expressions / variables |
|
2399 | 2399 | """ |
|
2400 | 2400 | |
|
2401 | 2401 | data, md = self.display_formatter.format(obj) |
|
2402 | 2402 | value = { |
|
2403 | 2403 | 'status' : 'ok', |
|
2404 | 2404 | 'data' : data, |
|
2405 | 2405 | 'metadata' : md, |
|
2406 | 2406 | } |
|
2407 | 2407 | return value |
|
2408 | 2408 | |
|
2409 | 2409 | def user_variables(self, names): |
|
2410 | 2410 | """Get a list of variable names from the user's namespace. |
|
2411 | 2411 | |
|
2412 | 2412 | Parameters |
|
2413 | 2413 | ---------- |
|
2414 | 2414 | names : list of strings |
|
2415 | 2415 | A list of names of variables to be read from the user namespace. |
|
2416 | 2416 | |
|
2417 | 2417 | Returns |
|
2418 | 2418 | ------- |
|
2419 | 2419 | A dict, keyed by the input names and with the rich mime-type repr(s) of each value. |
|
2420 | 2420 | Each element will be a sub-dict of the same form as a display_data message. |
|
2421 | 2421 | """ |
|
2422 | 2422 | out = {} |
|
2423 | 2423 | user_ns = self.user_ns |
|
2424 | 2424 | |
|
2425 | 2425 | for varname in names: |
|
2426 | 2426 | try: |
|
2427 | 2427 | value = self._format_user_obj(user_ns[varname]) |
|
2428 | 2428 | except: |
|
2429 | 2429 | value = self._user_obj_error() |
|
2430 | 2430 | out[varname] = value |
|
2431 | 2431 | return out |
|
2432 | 2432 | |
|
2433 | 2433 | def user_expressions(self, expressions): |
|
2434 | 2434 | """Evaluate a dict of expressions in the user's namespace. |
|
2435 | 2435 | |
|
2436 | 2436 | Parameters |
|
2437 | 2437 | ---------- |
|
2438 | 2438 | expressions : dict |
|
2439 | 2439 | A dict with string keys and string values. The expression values |
|
2440 | 2440 | should be valid Python expressions, each of which will be evaluated |
|
2441 | 2441 | in the user namespace. |
|
2442 | 2442 | |
|
2443 | 2443 | Returns |
|
2444 | 2444 | ------- |
|
2445 | 2445 | A dict, keyed like the input expressions dict, with the rich mime-typed |
|
2446 | 2446 | display_data of each value. |
|
2447 | 2447 | """ |
|
2448 | 2448 | out = {} |
|
2449 | 2449 | user_ns = self.user_ns |
|
2450 | 2450 | global_ns = self.user_global_ns |
|
2451 | 2451 | |
|
2452 | 2452 | for key, expr in iteritems(expressions): |
|
2453 | 2453 | try: |
|
2454 | 2454 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) |
|
2455 | 2455 | except: |
|
2456 | 2456 | value = self._user_obj_error() |
|
2457 | 2457 | out[key] = value |
|
2458 | 2458 | return out |
|
2459 | 2459 | |
|
2460 | 2460 | #------------------------------------------------------------------------- |
|
2461 | 2461 | # Things related to the running of code |
|
2462 | 2462 | #------------------------------------------------------------------------- |
|
2463 | 2463 | |
|
2464 | 2464 | def ex(self, cmd): |
|
2465 | 2465 | """Execute a normal python statement in user namespace.""" |
|
2466 | 2466 | with self.builtin_trap: |
|
2467 | 2467 | exec(cmd, self.user_global_ns, self.user_ns) |
|
2468 | 2468 | |
|
2469 | 2469 | def ev(self, expr): |
|
2470 | 2470 | """Evaluate python expression expr in user namespace. |
|
2471 | 2471 | |
|
2472 | 2472 | Returns the result of evaluation |
|
2473 | 2473 | """ |
|
2474 | 2474 | with self.builtin_trap: |
|
2475 | 2475 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2476 | 2476 | |
|
2477 | 2477 | def safe_execfile(self, fname, *where, **kw): |
|
2478 | 2478 | """A safe version of the builtin execfile(). |
|
2479 | 2479 | |
|
2480 | 2480 | This version will never throw an exception, but instead print |
|
2481 | 2481 | helpful error messages to the screen. This only works on pure |
|
2482 | 2482 | Python files with the .py extension. |
|
2483 | 2483 | |
|
2484 | 2484 | Parameters |
|
2485 | 2485 | ---------- |
|
2486 | 2486 | fname : string |
|
2487 | 2487 | The name of the file to be executed. |
|
2488 | 2488 | where : tuple |
|
2489 | 2489 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2490 | 2490 | If only one is given, it is passed as both. |
|
2491 | 2491 | exit_ignore : bool (False) |
|
2492 | 2492 | If True, then silence SystemExit for non-zero status (it is always |
|
2493 | 2493 | silenced for zero status, as it is so common). |
|
2494 | 2494 | raise_exceptions : bool (False) |
|
2495 | 2495 | If True raise exceptions everywhere. Meant for testing. |
|
2496 | 2496 | |
|
2497 | 2497 | """ |
|
2498 | 2498 | kw.setdefault('exit_ignore', False) |
|
2499 | 2499 | kw.setdefault('raise_exceptions', False) |
|
2500 | 2500 | |
|
2501 | 2501 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2502 | 2502 | |
|
2503 | 2503 | # Make sure we can open the file |
|
2504 | 2504 | try: |
|
2505 | 2505 | with open(fname) as thefile: |
|
2506 | 2506 | pass |
|
2507 | 2507 | except: |
|
2508 | 2508 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2509 | 2509 | return |
|
2510 | 2510 | |
|
2511 | 2511 | # Find things also in current directory. This is needed to mimic the |
|
2512 | 2512 | # behavior of running a script from the system command line, where |
|
2513 | 2513 | # Python inserts the script's directory into sys.path |
|
2514 | 2514 | dname = os.path.dirname(fname) |
|
2515 | 2515 | |
|
2516 | 2516 | with prepended_to_syspath(dname): |
|
2517 | 2517 | try: |
|
2518 | 2518 | py3compat.execfile(fname,*where) |
|
2519 | 2519 | except SystemExit as status: |
|
2520 | 2520 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2521 | 2521 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2522 | 2522 | # these are considered normal by the OS: |
|
2523 | 2523 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2524 | 2524 | # 0 |
|
2525 | 2525 | # > python -c'import sys;sys.exit()'; echo $? |
|
2526 | 2526 | # 0 |
|
2527 | 2527 | # For other exit status, we show the exception unless |
|
2528 | 2528 | # explicitly silenced, but only in short form. |
|
2529 | 2529 | if kw['raise_exceptions']: |
|
2530 | 2530 | raise |
|
2531 | 2531 | if status.code and not kw['exit_ignore']: |
|
2532 | 2532 | self.showtraceback(exception_only=True) |
|
2533 | 2533 | except: |
|
2534 | 2534 | if kw['raise_exceptions']: |
|
2535 | 2535 | raise |
|
2536 | 2536 | self.showtraceback() |
|
2537 | 2537 | |
|
2538 | 2538 | def safe_execfile_ipy(self, fname): |
|
2539 | 2539 | """Like safe_execfile, but for .ipy files with IPython syntax. |
|
2540 | 2540 | |
|
2541 | 2541 | Parameters |
|
2542 | 2542 | ---------- |
|
2543 | 2543 | fname : str |
|
2544 | 2544 | The name of the file to execute. The filename must have a |
|
2545 | 2545 | .ipy extension. |
|
2546 | 2546 | """ |
|
2547 | 2547 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2548 | 2548 | |
|
2549 | 2549 | # Make sure we can open the file |
|
2550 | 2550 | try: |
|
2551 | 2551 | with open(fname) as thefile: |
|
2552 | 2552 | pass |
|
2553 | 2553 | except: |
|
2554 | 2554 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2555 | 2555 | return |
|
2556 | 2556 | |
|
2557 | 2557 | # Find things also in current directory. This is needed to mimic the |
|
2558 | 2558 | # behavior of running a script from the system command line, where |
|
2559 | 2559 | # Python inserts the script's directory into sys.path |
|
2560 | 2560 | dname = os.path.dirname(fname) |
|
2561 | 2561 | |
|
2562 | 2562 | with prepended_to_syspath(dname): |
|
2563 | 2563 | try: |
|
2564 | 2564 | with open(fname) as thefile: |
|
2565 | 2565 | # self.run_cell currently captures all exceptions |
|
2566 | 2566 | # raised in user code. It would be nice if there were |
|
2567 | 2567 | # versions of runlines, execfile that did raise, so |
|
2568 | 2568 | # we could catch the errors. |
|
2569 | 2569 | self.run_cell(thefile.read(), store_history=False, shell_futures=False) |
|
2570 | 2570 | except: |
|
2571 | 2571 | self.showtraceback() |
|
2572 | 2572 | warn('Unknown failure executing file: <%s>' % fname) |
|
2573 | 2573 | |
|
2574 | 2574 | def safe_run_module(self, mod_name, where): |
|
2575 | 2575 | """A safe version of runpy.run_module(). |
|
2576 | 2576 | |
|
2577 | 2577 | This version will never throw an exception, but instead print |
|
2578 | 2578 | helpful error messages to the screen. |
|
2579 | 2579 | |
|
2580 | 2580 | `SystemExit` exceptions with status code 0 or None are ignored. |
|
2581 | 2581 | |
|
2582 | 2582 | Parameters |
|
2583 | 2583 | ---------- |
|
2584 | 2584 | mod_name : string |
|
2585 | 2585 | The name of the module to be executed. |
|
2586 | 2586 | where : dict |
|
2587 | 2587 | The globals namespace. |
|
2588 | 2588 | """ |
|
2589 | 2589 | try: |
|
2590 | 2590 | try: |
|
2591 | 2591 | where.update( |
|
2592 | 2592 | runpy.run_module(str(mod_name), run_name="__main__", |
|
2593 | 2593 | alter_sys=True) |
|
2594 | 2594 | ) |
|
2595 | 2595 | except SystemExit as status: |
|
2596 | 2596 | if status.code: |
|
2597 | 2597 | raise |
|
2598 | 2598 | except: |
|
2599 | 2599 | self.showtraceback() |
|
2600 | 2600 | warn('Unknown failure executing module: <%s>' % mod_name) |
|
2601 | 2601 | |
|
2602 | 2602 | def _run_cached_cell_magic(self, magic_name, line): |
|
2603 | 2603 | """Special method to call a cell magic with the data stored in self. |
|
2604 | 2604 | """ |
|
2605 | 2605 | cell = self._current_cell_magic_body |
|
2606 | 2606 | self._current_cell_magic_body = None |
|
2607 | 2607 | return self.run_cell_magic(magic_name, line, cell) |
|
2608 | 2608 | |
|
2609 | 2609 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): |
|
2610 | 2610 | """Run a complete IPython cell. |
|
2611 | 2611 | |
|
2612 | 2612 | Parameters |
|
2613 | 2613 | ---------- |
|
2614 | 2614 | raw_cell : str |
|
2615 | 2615 | The code (including IPython code such as %magic functions) to run. |
|
2616 | 2616 | store_history : bool |
|
2617 | 2617 | If True, the raw and translated cell will be stored in IPython's |
|
2618 | 2618 | history. For user code calling back into IPython's machinery, this |
|
2619 | 2619 | should be set to False. |
|
2620 | 2620 | silent : bool |
|
2621 | 2621 | If True, avoid side-effects, such as implicit displayhooks and |
|
2622 | 2622 | and logging. silent=True forces store_history=False. |
|
2623 | 2623 | shell_futures : bool |
|
2624 | 2624 | If True, the code will share future statements with the interactive |
|
2625 | 2625 | shell. It will both be affected by previous __future__ imports, and |
|
2626 | 2626 | any __future__ imports in the code will affect the shell. If False, |
|
2627 | 2627 | __future__ imports are not shared in either direction. |
|
2628 | 2628 | """ |
|
2629 | 2629 | if (not raw_cell) or raw_cell.isspace(): |
|
2630 | 2630 | return |
|
2631 | 2631 | |
|
2632 | 2632 | if silent: |
|
2633 | 2633 | store_history = False |
|
2634 | 2634 | |
|
2635 | 2635 | self.input_transformer_manager.push(raw_cell) |
|
2636 | 2636 | cell = self.input_transformer_manager.source_reset() |
|
2637 | 2637 | |
|
2638 | 2638 | # Our own compiler remembers the __future__ environment. If we want to |
|
2639 | 2639 | # run code with a separate __future__ environment, use the default |
|
2640 | 2640 | # compiler |
|
2641 | 2641 | compiler = self.compile if shell_futures else CachingCompiler() |
|
2642 | 2642 | |
|
2643 | 2643 | with self.builtin_trap: |
|
2644 | 2644 | prefilter_failed = False |
|
2645 | 2645 | if len(cell.splitlines()) == 1: |
|
2646 | 2646 | try: |
|
2647 | 2647 | # use prefilter_lines to handle trailing newlines |
|
2648 | 2648 | # restore trailing newline for ast.parse |
|
2649 | 2649 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
2650 | 2650 | except AliasError as e: |
|
2651 | 2651 | error(e) |
|
2652 | 2652 | prefilter_failed = True |
|
2653 | 2653 | except Exception: |
|
2654 | 2654 | # don't allow prefilter errors to crash IPython |
|
2655 | 2655 | self.showtraceback() |
|
2656 | 2656 | prefilter_failed = True |
|
2657 | 2657 | |
|
2658 | 2658 | # Store raw and processed history |
|
2659 | 2659 | if store_history: |
|
2660 | 2660 | self.history_manager.store_inputs(self.execution_count, |
|
2661 | 2661 | cell, raw_cell) |
|
2662 | 2662 | if not silent: |
|
2663 | 2663 | self.logger.log(cell, raw_cell) |
|
2664 | 2664 | |
|
2665 | 2665 | if not prefilter_failed: |
|
2666 | 2666 | # don't run if prefilter failed |
|
2667 | 2667 | cell_name = self.compile.cache(cell, self.execution_count) |
|
2668 | 2668 | |
|
2669 | 2669 | with self.display_trap: |
|
2670 | 2670 | try: |
|
2671 | 2671 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
2672 | 2672 | except IndentationError: |
|
2673 | 2673 | self.showindentationerror() |
|
2674 | 2674 | if store_history: |
|
2675 | 2675 | self.execution_count += 1 |
|
2676 | 2676 | return None |
|
2677 | 2677 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
2678 | 2678 | MemoryError): |
|
2679 | 2679 | self.showsyntaxerror() |
|
2680 | 2680 | if store_history: |
|
2681 | 2681 | self.execution_count += 1 |
|
2682 | 2682 | return None |
|
2683 | 2683 | |
|
2684 | 2684 | code_ast = self.transform_ast(code_ast) |
|
2685 | 2685 | |
|
2686 | 2686 | interactivity = "none" if silent else self.ast_node_interactivity |
|
2687 | 2687 | self.run_ast_nodes(code_ast.body, cell_name, |
|
2688 | 2688 | interactivity=interactivity, compiler=compiler) |
|
2689 | 2689 | |
|
2690 | 2690 | # Execute any registered post-execution functions. |
|
2691 | 2691 | # unless we are silent |
|
2692 | 2692 | post_exec = [] if silent else iteritems(self._post_execute) |
|
2693 | 2693 | |
|
2694 | 2694 | for func, status in post_exec: |
|
2695 | 2695 | if self.disable_failing_post_execute and not status: |
|
2696 | 2696 | continue |
|
2697 | 2697 | try: |
|
2698 | 2698 | func() |
|
2699 | 2699 | except KeyboardInterrupt: |
|
2700 | 2700 | print("\nKeyboardInterrupt", file=io.stderr) |
|
2701 | 2701 | except Exception: |
|
2702 | 2702 | # register as failing: |
|
2703 | 2703 | self._post_execute[func] = False |
|
2704 | 2704 | self.showtraceback() |
|
2705 | 2705 | print('\n'.join([ |
|
2706 | 2706 | "post-execution function %r produced an error." % func, |
|
2707 | 2707 | "If this problem persists, you can disable failing post-exec functions with:", |
|
2708 | 2708 | "", |
|
2709 | 2709 | " get_ipython().disable_failing_post_execute = True" |
|
2710 | 2710 | ]), file=io.stderr) |
|
2711 | 2711 | |
|
2712 | 2712 | if store_history: |
|
2713 | 2713 | # Write output to the database. Does nothing unless |
|
2714 | 2714 | # history output logging is enabled. |
|
2715 | 2715 | self.history_manager.store_output(self.execution_count) |
|
2716 | 2716 | # Each cell is a *single* input, regardless of how many lines it has |
|
2717 | 2717 | self.execution_count += 1 |
|
2718 | 2718 | |
|
2719 | 2719 | def transform_ast(self, node): |
|
2720 | 2720 | """Apply the AST transformations from self.ast_transformers |
|
2721 | 2721 | |
|
2722 | 2722 | Parameters |
|
2723 | 2723 | ---------- |
|
2724 | 2724 | node : ast.Node |
|
2725 | 2725 | The root node to be transformed. Typically called with the ast.Module |
|
2726 | 2726 | produced by parsing user input. |
|
2727 | 2727 | |
|
2728 | 2728 | Returns |
|
2729 | 2729 | ------- |
|
2730 | 2730 | An ast.Node corresponding to the node it was called with. Note that it |
|
2731 | 2731 | may also modify the passed object, so don't rely on references to the |
|
2732 | 2732 | original AST. |
|
2733 | 2733 | """ |
|
2734 | 2734 | for transformer in self.ast_transformers: |
|
2735 | 2735 | try: |
|
2736 | 2736 | node = transformer.visit(node) |
|
2737 | 2737 | except Exception: |
|
2738 | 2738 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) |
|
2739 | 2739 | self.ast_transformers.remove(transformer) |
|
2740 | 2740 | |
|
2741 | 2741 | if self.ast_transformers: |
|
2742 | 2742 | ast.fix_missing_locations(node) |
|
2743 | 2743 | return node |
|
2744 | 2744 | |
|
2745 | 2745 | |
|
2746 | 2746 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr', |
|
2747 | 2747 | compiler=compile): |
|
2748 | 2748 | """Run a sequence of AST nodes. The execution mode depends on the |
|
2749 | 2749 | interactivity parameter. |
|
2750 | 2750 | |
|
2751 | 2751 | Parameters |
|
2752 | 2752 | ---------- |
|
2753 | 2753 | nodelist : list |
|
2754 | 2754 | A sequence of AST nodes to run. |
|
2755 | 2755 | cell_name : str |
|
2756 | 2756 | Will be passed to the compiler as the filename of the cell. Typically |
|
2757 | 2757 | the value returned by ip.compile.cache(cell). |
|
2758 | 2758 | interactivity : str |
|
2759 | 2759 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be |
|
2760 | 2760 | run interactively (displaying output from expressions). 'last_expr' |
|
2761 | 2761 | will run the last node interactively only if it is an expression (i.e. |
|
2762 | 2762 | expressions in loops or other blocks are not displayed. Other values |
|
2763 | 2763 | for this parameter will raise a ValueError. |
|
2764 | 2764 | compiler : callable |
|
2765 | 2765 | A function with the same interface as the built-in compile(), to turn |
|
2766 | 2766 | the AST nodes into code objects. Default is the built-in compile(). |
|
2767 | 2767 | """ |
|
2768 | 2768 | if not nodelist: |
|
2769 | 2769 | return |
|
2770 | 2770 | |
|
2771 | 2771 | if interactivity == 'last_expr': |
|
2772 | 2772 | if isinstance(nodelist[-1], ast.Expr): |
|
2773 | 2773 | interactivity = "last" |
|
2774 | 2774 | else: |
|
2775 | 2775 | interactivity = "none" |
|
2776 | 2776 | |
|
2777 | 2777 | if interactivity == 'none': |
|
2778 | 2778 | to_run_exec, to_run_interactive = nodelist, [] |
|
2779 | 2779 | elif interactivity == 'last': |
|
2780 | 2780 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
2781 | 2781 | elif interactivity == 'all': |
|
2782 | 2782 | to_run_exec, to_run_interactive = [], nodelist |
|
2783 | 2783 | else: |
|
2784 | 2784 | raise ValueError("Interactivity was %r" % interactivity) |
|
2785 | 2785 | |
|
2786 | 2786 | exec_count = self.execution_count |
|
2787 | 2787 | |
|
2788 | 2788 | try: |
|
2789 | 2789 | for i, node in enumerate(to_run_exec): |
|
2790 | 2790 | mod = ast.Module([node]) |
|
2791 | 2791 | code = compiler(mod, cell_name, "exec") |
|
2792 | 2792 | if self.run_code(code): |
|
2793 | 2793 | return True |
|
2794 | 2794 | |
|
2795 | 2795 | for i, node in enumerate(to_run_interactive): |
|
2796 | 2796 | mod = ast.Interactive([node]) |
|
2797 | 2797 | code = compiler(mod, cell_name, "single") |
|
2798 | 2798 | if self.run_code(code): |
|
2799 | 2799 | return True |
|
2800 | 2800 | |
|
2801 | 2801 | # Flush softspace |
|
2802 | 2802 | if softspace(sys.stdout, 0): |
|
2803 | 2803 | print() |
|
2804 | 2804 | |
|
2805 | 2805 | except: |
|
2806 | 2806 | # It's possible to have exceptions raised here, typically by |
|
2807 | 2807 | # compilation of odd code (such as a naked 'return' outside a |
|
2808 | 2808 | # function) that did parse but isn't valid. Typically the exception |
|
2809 | 2809 | # is a SyntaxError, but it's safest just to catch anything and show |
|
2810 | 2810 | # the user a traceback. |
|
2811 | 2811 | |
|
2812 | 2812 | # We do only one try/except outside the loop to minimize the impact |
|
2813 | 2813 | # on runtime, and also because if any node in the node list is |
|
2814 | 2814 | # broken, we should stop execution completely. |
|
2815 | 2815 | self.showtraceback() |
|
2816 | 2816 | |
|
2817 | 2817 | return False |
|
2818 | 2818 | |
|
2819 | 2819 | def run_code(self, code_obj): |
|
2820 | 2820 | """Execute a code object. |
|
2821 | 2821 | |
|
2822 | 2822 | When an exception occurs, self.showtraceback() is called to display a |
|
2823 | 2823 | traceback. |
|
2824 | 2824 | |
|
2825 | 2825 | Parameters |
|
2826 | 2826 | ---------- |
|
2827 | 2827 | code_obj : code object |
|
2828 | 2828 | A compiled code object, to be executed |
|
2829 | 2829 | |
|
2830 | 2830 | Returns |
|
2831 | 2831 | ------- |
|
2832 | 2832 | False : successful execution. |
|
2833 | 2833 | True : an error occurred. |
|
2834 | 2834 | """ |
|
2835 | 2835 | |
|
2836 | 2836 | # Set our own excepthook in case the user code tries to call it |
|
2837 | 2837 | # directly, so that the IPython crash handler doesn't get triggered |
|
2838 | 2838 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2839 | 2839 | |
|
2840 | 2840 | # we save the original sys.excepthook in the instance, in case config |
|
2841 | 2841 | # code (such as magics) needs access to it. |
|
2842 | 2842 | self.sys_excepthook = old_excepthook |
|
2843 | 2843 | outflag = 1 # happens in more places, so it's easier as default |
|
2844 | 2844 | try: |
|
2845 | 2845 | try: |
|
2846 | 2846 | self.hooks.pre_run_code_hook() |
|
2847 | 2847 | #rprint('Running code', repr(code_obj)) # dbg |
|
2848 | 2848 | exec(code_obj, self.user_global_ns, self.user_ns) |
|
2849 | 2849 | finally: |
|
2850 | 2850 | # Reset our crash handler in place |
|
2851 | 2851 | sys.excepthook = old_excepthook |
|
2852 | 2852 | except SystemExit: |
|
2853 | 2853 | self.showtraceback(exception_only=True) |
|
2854 | 2854 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1) |
|
2855 | 2855 | except self.custom_exceptions: |
|
2856 | 2856 | etype,value,tb = sys.exc_info() |
|
2857 | 2857 | self.CustomTB(etype,value,tb) |
|
2858 | 2858 | except: |
|
2859 | 2859 | self.showtraceback() |
|
2860 | 2860 | else: |
|
2861 | 2861 | outflag = 0 |
|
2862 | 2862 | return outflag |
|
2863 | 2863 | |
|
2864 | 2864 | # For backwards compatibility |
|
2865 | 2865 | runcode = run_code |
|
2866 | 2866 | |
|
2867 | 2867 | #------------------------------------------------------------------------- |
|
2868 | 2868 | # Things related to GUI support and pylab |
|
2869 | 2869 | #------------------------------------------------------------------------- |
|
2870 | 2870 | |
|
2871 | 2871 | def enable_gui(self, gui=None): |
|
2872 | 2872 | raise NotImplementedError('Implement enable_gui in a subclass') |
|
2873 | 2873 | |
|
2874 | 2874 | def enable_matplotlib(self, gui=None): |
|
2875 | 2875 | """Enable interactive matplotlib and inline figure support. |
|
2876 | 2876 | |
|
2877 | 2877 | This takes the following steps: |
|
2878 | 2878 | |
|
2879 | 2879 | 1. select the appropriate eventloop and matplotlib backend |
|
2880 | 2880 | 2. set up matplotlib for interactive use with that backend |
|
2881 | 2881 | 3. configure formatters for inline figure display |
|
2882 | 2882 | 4. enable the selected gui eventloop |
|
2883 | 2883 | |
|
2884 | 2884 | Parameters |
|
2885 | 2885 | ---------- |
|
2886 | 2886 | gui : optional, string |
|
2887 | 2887 | If given, dictates the choice of matplotlib GUI backend to use |
|
2888 | 2888 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
2889 | 2889 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
2890 | 2890 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
2891 | 2891 | user's matplotlibrc configuration file). Note that not all backends |
|
2892 | 2892 | make sense in all contexts, for example a terminal ipython can't |
|
2893 | 2893 | display figures inline. |
|
2894 | 2894 | """ |
|
2895 | 2895 | from IPython.core import pylabtools as pt |
|
2896 | 2896 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) |
|
2897 | 2897 | |
|
2898 | 2898 | if gui != 'inline': |
|
2899 | 2899 | # If we have our first gui selection, store it |
|
2900 | 2900 | if self.pylab_gui_select is None: |
|
2901 | 2901 | self.pylab_gui_select = gui |
|
2902 | 2902 | # Otherwise if they are different |
|
2903 | 2903 | elif gui != self.pylab_gui_select: |
|
2904 | 2904 | print ('Warning: Cannot change to a different GUI toolkit: %s.' |
|
2905 | 2905 | ' Using %s instead.' % (gui, self.pylab_gui_select)) |
|
2906 | 2906 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) |
|
2907 | 2907 | |
|
2908 | 2908 | pt.activate_matplotlib(backend) |
|
2909 | 2909 | pt.configure_inline_support(self, backend) |
|
2910 | 2910 | |
|
2911 | 2911 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
2912 | 2912 | # plot updates into account |
|
2913 | 2913 | self.enable_gui(gui) |
|
2914 | 2914 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ |
|
2915 | 2915 | pt.mpl_runner(self.safe_execfile) |
|
2916 | 2916 | |
|
2917 | 2917 | return gui, backend |
|
2918 | 2918 | |
|
2919 | 2919 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): |
|
2920 | 2920 | """Activate pylab support at runtime. |
|
2921 | 2921 | |
|
2922 | 2922 | This turns on support for matplotlib, preloads into the interactive |
|
2923 | 2923 | namespace all of numpy and pylab, and configures IPython to correctly |
|
2924 | 2924 | interact with the GUI event loop. The GUI backend to be used can be |
|
2925 | 2925 | optionally selected with the optional ``gui`` argument. |
|
2926 | 2926 | |
|
2927 | 2927 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. |
|
2928 | 2928 | |
|
2929 | 2929 | Parameters |
|
2930 | 2930 | ---------- |
|
2931 | 2931 | gui : optional, string |
|
2932 | 2932 | If given, dictates the choice of matplotlib GUI backend to use |
|
2933 | 2933 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
2934 | 2934 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
2935 | 2935 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
2936 | 2936 | user's matplotlibrc configuration file). Note that not all backends |
|
2937 | 2937 | make sense in all contexts, for example a terminal ipython can't |
|
2938 | 2938 | display figures inline. |
|
2939 | 2939 | import_all : optional, bool, default: True |
|
2940 | 2940 | Whether to do `from numpy import *` and `from pylab import *` |
|
2941 | 2941 | in addition to module imports. |
|
2942 | 2942 | welcome_message : deprecated |
|
2943 | 2943 | This argument is ignored, no welcome message will be displayed. |
|
2944 | 2944 | """ |
|
2945 | 2945 | from IPython.core.pylabtools import import_pylab |
|
2946 | 2946 | |
|
2947 | 2947 | gui, backend = self.enable_matplotlib(gui) |
|
2948 | 2948 | |
|
2949 | 2949 | # We want to prevent the loading of pylab to pollute the user's |
|
2950 | 2950 | # namespace as shown by the %who* magics, so we execute the activation |
|
2951 | 2951 | # code in an empty namespace, and we update *both* user_ns and |
|
2952 | 2952 | # user_ns_hidden with this information. |
|
2953 | 2953 | ns = {} |
|
2954 | 2954 | import_pylab(ns, import_all) |
|
2955 | 2955 | # warn about clobbered names |
|
2956 | 2956 | ignored = set(["__builtins__"]) |
|
2957 | 2957 | both = set(ns).intersection(self.user_ns).difference(ignored) |
|
2958 | 2958 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] |
|
2959 | 2959 | self.user_ns.update(ns) |
|
2960 | 2960 | self.user_ns_hidden.update(ns) |
|
2961 | 2961 | return gui, backend, clobbered |
|
2962 | 2962 | |
|
2963 | 2963 | #------------------------------------------------------------------------- |
|
2964 | 2964 | # Utilities |
|
2965 | 2965 | #------------------------------------------------------------------------- |
|
2966 | 2966 | |
|
2967 | 2967 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
2968 | 2968 | """Expand python variables in a string. |
|
2969 | 2969 | |
|
2970 | 2970 | The depth argument indicates how many frames above the caller should |
|
2971 | 2971 | be walked to look for the local namespace where to expand variables. |
|
2972 | 2972 | |
|
2973 | 2973 | The global namespace for expansion is always the user's interactive |
|
2974 | 2974 | namespace. |
|
2975 | 2975 | """ |
|
2976 | 2976 | ns = self.user_ns.copy() |
|
2977 | 2977 | ns.update(sys._getframe(depth+1).f_locals) |
|
2978 | 2978 | try: |
|
2979 | 2979 | # We have to use .vformat() here, because 'self' is a valid and common |
|
2980 | 2980 | # name, and expanding **ns for .format() would make it collide with |
|
2981 | 2981 | # the 'self' argument of the method. |
|
2982 | 2982 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) |
|
2983 | 2983 | except Exception: |
|
2984 | 2984 | # if formatter couldn't format, just let it go untransformed |
|
2985 | 2985 | pass |
|
2986 | 2986 | return cmd |
|
2987 | 2987 | |
|
2988 | 2988 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
2989 | 2989 | """Make a new tempfile and return its filename. |
|
2990 | 2990 | |
|
2991 | 2991 | This makes a call to tempfile.mktemp, but it registers the created |
|
2992 | 2992 | filename internally so ipython cleans it up at exit time. |
|
2993 | 2993 | |
|
2994 | 2994 | Optional inputs: |
|
2995 | 2995 | |
|
2996 | 2996 | - data(None): if data is given, it gets written out to the temp file |
|
2997 | 2997 | immediately, and the file is closed again.""" |
|
2998 | 2998 | |
|
2999 | 2999 | filename = tempfile.mktemp('.py', prefix) |
|
3000 | 3000 | self.tempfiles.append(filename) |
|
3001 | 3001 | |
|
3002 | 3002 | if data: |
|
3003 | 3003 | tmp_file = open(filename,'w') |
|
3004 | 3004 | tmp_file.write(data) |
|
3005 | 3005 | tmp_file.close() |
|
3006 | 3006 | return filename |
|
3007 | 3007 | |
|
3008 | 3008 | # TODO: This should be removed when Term is refactored. |
|
3009 | 3009 | def write(self,data): |
|
3010 | 3010 | """Write a string to the default output""" |
|
3011 | 3011 | io.stdout.write(data) |
|
3012 | 3012 | |
|
3013 | 3013 | # TODO: This should be removed when Term is refactored. |
|
3014 | 3014 | def write_err(self,data): |
|
3015 | 3015 | """Write a string to the default error output""" |
|
3016 | 3016 | io.stderr.write(data) |
|
3017 | 3017 | |
|
3018 | 3018 | def ask_yes_no(self, prompt, default=None): |
|
3019 | 3019 | if self.quiet: |
|
3020 | 3020 | return True |
|
3021 | 3021 | return ask_yes_no(prompt,default) |
|
3022 | 3022 | |
|
3023 | 3023 | def show_usage(self): |
|
3024 | 3024 | """Show a usage message""" |
|
3025 | 3025 | page.page(IPython.core.usage.interactive_usage) |
|
3026 | 3026 | |
|
3027 | 3027 | def extract_input_lines(self, range_str, raw=False): |
|
3028 | 3028 | """Return as a string a set of input history slices. |
|
3029 | 3029 | |
|
3030 | 3030 | Parameters |
|
3031 | 3031 | ---------- |
|
3032 | 3032 | range_str : string |
|
3033 | 3033 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", |
|
3034 | 3034 | since this function is for use by magic functions which get their |
|
3035 | 3035 | arguments as strings. The number before the / is the session |
|
3036 | 3036 | number: ~n goes n back from the current session. |
|
3037 | 3037 | |
|
3038 | 3038 | raw : bool, optional |
|
3039 | 3039 | By default, the processed input is used. If this is true, the raw |
|
3040 | 3040 | input history is used instead. |
|
3041 | 3041 | |
|
3042 | 3042 | Notes |
|
3043 | 3043 | ----- |
|
3044 | 3044 | |
|
3045 | 3045 | Slices can be described with two notations: |
|
3046 | 3046 | |
|
3047 | 3047 | * ``N:M`` -> standard python form, means including items N...(M-1). |
|
3048 | 3048 | * ``N-M`` -> include items N..M (closed endpoint). |
|
3049 | 3049 | """ |
|
3050 | 3050 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) |
|
3051 | 3051 | return "\n".join(x for _, _, x in lines) |
|
3052 | 3052 | |
|
3053 | 3053 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True): |
|
3054 | 3054 | """Get a code string from history, file, url, or a string or macro. |
|
3055 | 3055 | |
|
3056 | 3056 | This is mainly used by magic functions. |
|
3057 | 3057 | |
|
3058 | 3058 | Parameters |
|
3059 | 3059 | ---------- |
|
3060 | 3060 | |
|
3061 | 3061 | target : str |
|
3062 | 3062 | |
|
3063 | 3063 | A string specifying code to retrieve. This will be tried respectively |
|
3064 | 3064 | as: ranges of input history (see %history for syntax), url, |
|
3065 | 3065 | correspnding .py file, filename, or an expression evaluating to a |
|
3066 | 3066 | string or Macro in the user namespace. |
|
3067 | 3067 | |
|
3068 | 3068 | raw : bool |
|
3069 | 3069 | If true (default), retrieve raw history. Has no effect on the other |
|
3070 | 3070 | retrieval mechanisms. |
|
3071 | 3071 | |
|
3072 | 3072 | py_only : bool (default False) |
|
3073 | 3073 | Only try to fetch python code, do not try alternative methods to decode file |
|
3074 | 3074 | if unicode fails. |
|
3075 | 3075 | |
|
3076 | 3076 | Returns |
|
3077 | 3077 | ------- |
|
3078 | 3078 | A string of code. |
|
3079 | 3079 | |
|
3080 | 3080 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
3081 | 3081 | to an object of another type. In each case, .args[0] is a printable |
|
3082 | 3082 | message. |
|
3083 | 3083 | """ |
|
3084 | 3084 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
3085 | 3085 | if code: |
|
3086 | 3086 | return code |
|
3087 | 3087 | utarget = unquote_filename(target) |
|
3088 | 3088 | try: |
|
3089 | 3089 | if utarget.startswith(('http://', 'https://')): |
|
3090 | 3090 | return openpy.read_py_url(utarget, skip_encoding_cookie=skip_encoding_cookie) |
|
3091 | 3091 | except UnicodeDecodeError: |
|
3092 | 3092 | if not py_only : |
|
3093 | 3093 | from urllib import urlopen # Deferred import |
|
3094 | 3094 | response = urlopen(target) |
|
3095 | 3095 | return response.read().decode('latin1') |
|
3096 | 3096 | raise ValueError(("'%s' seem to be unreadable.") % utarget) |
|
3097 | 3097 | |
|
3098 | 3098 | potential_target = [target] |
|
3099 | 3099 | try : |
|
3100 | 3100 | potential_target.insert(0,get_py_filename(target)) |
|
3101 | 3101 | except IOError: |
|
3102 | 3102 | pass |
|
3103 | 3103 | |
|
3104 | 3104 | for tgt in potential_target : |
|
3105 | 3105 | if os.path.isfile(tgt): # Read file |
|
3106 | 3106 | try : |
|
3107 | 3107 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) |
|
3108 | 3108 | except UnicodeDecodeError : |
|
3109 | 3109 | if not py_only : |
|
3110 | 3110 | with io_open(tgt,'r', encoding='latin1') as f : |
|
3111 | 3111 | return f.read() |
|
3112 | 3112 | raise ValueError(("'%s' seem to be unreadable.") % target) |
|
3113 | 3113 | elif os.path.isdir(os.path.expanduser(tgt)): |
|
3114 | 3114 | raise ValueError("'%s' is a directory, not a regular file." % target) |
|
3115 | 3115 | |
|
3116 | 3116 | try: # User namespace |
|
3117 | 3117 | codeobj = eval(target, self.user_ns) |
|
3118 | 3118 | except Exception: |
|
3119 | 3119 | raise ValueError(("'%s' was not found in history, as a file, url, " |
|
3120 | 3120 | "nor in the user namespace.") % target) |
|
3121 | 3121 | if isinstance(codeobj, string_types): |
|
3122 | 3122 | return codeobj |
|
3123 | 3123 | elif isinstance(codeobj, Macro): |
|
3124 | 3124 | return codeobj.value |
|
3125 | 3125 | |
|
3126 | 3126 | raise TypeError("%s is neither a string nor a macro." % target, |
|
3127 | 3127 | codeobj) |
|
3128 | 3128 | |
|
3129 | 3129 | #------------------------------------------------------------------------- |
|
3130 | 3130 | # Things related to IPython exiting |
|
3131 | 3131 | #------------------------------------------------------------------------- |
|
3132 | 3132 | def atexit_operations(self): |
|
3133 | 3133 | """This will be executed at the time of exit. |
|
3134 | 3134 | |
|
3135 | 3135 | Cleanup operations and saving of persistent data that is done |
|
3136 | 3136 | unconditionally by IPython should be performed here. |
|
3137 | 3137 | |
|
3138 | 3138 | For things that may depend on startup flags or platform specifics (such |
|
3139 | 3139 | as having readline or not), register a separate atexit function in the |
|
3140 | 3140 | code that has the appropriate information, rather than trying to |
|
3141 | 3141 | clutter |
|
3142 | 3142 | """ |
|
3143 | 3143 | # Close the history session (this stores the end time and line count) |
|
3144 | 3144 | # this must be *before* the tempfile cleanup, in case of temporary |
|
3145 | 3145 | # history db |
|
3146 | 3146 | self.history_manager.end_session() |
|
3147 | 3147 | |
|
3148 | 3148 | # Cleanup all tempfiles left around |
|
3149 | 3149 | for tfile in self.tempfiles: |
|
3150 | 3150 | try: |
|
3151 | 3151 | os.unlink(tfile) |
|
3152 | 3152 | except OSError: |
|
3153 | 3153 | pass |
|
3154 | 3154 | |
|
3155 | 3155 | # Clear all user namespaces to release all references cleanly. |
|
3156 | 3156 | self.reset(new_session=False) |
|
3157 | 3157 | |
|
3158 | 3158 | # Run user hooks |
|
3159 | 3159 | self.hooks.shutdown_hook() |
|
3160 | 3160 | |
|
3161 | 3161 | def cleanup(self): |
|
3162 | 3162 | self.restore_sys_module_state() |
|
3163 | 3163 | |
|
3164 | 3164 | |
|
3165 | 3165 | class InteractiveShellABC(with_metaclass(abc.ABCMeta, object)): |
|
3166 | 3166 | """An abstract base class for InteractiveShell.""" |
|
3167 | 3167 | |
|
3168 | 3168 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,1267 +1,1269 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | ultratb.py -- Spice up your tracebacks! |
|
4 | 4 | |
|
5 |
* |
|
|
5 | **ColorTB** | |
|
6 | ||
|
6 | 7 | I've always found it a bit hard to visually parse tracebacks in Python. The |
|
7 | 8 | ColorTB class is a solution to that problem. It colors the different parts of a |
|
8 | 9 | traceback in a manner similar to what you would expect from a syntax-highlighting |
|
9 | 10 | text editor. |
|
10 | 11 | |
|
11 | 12 | Installation instructions for ColorTB:: |
|
12 | 13 | |
|
13 | 14 | import sys,ultratb |
|
14 | 15 | sys.excepthook = ultratb.ColorTB() |
|
15 | 16 | |
|
16 |
* |
|
|
17 | **VerboseTB** | |
|
18 | ||
|
17 | 19 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds |
|
18 | 20 | of useful info when a traceback occurs. Ping originally had it spit out HTML |
|
19 | 21 | and intended it for CGI programmers, but why should they have all the fun? I |
|
20 | 22 | altered it to spit out colored text to the terminal. It's a bit overwhelming, |
|
21 | 23 | but kind of neat, and maybe useful for long-running programs that you believe |
|
22 | 24 | are bug-free. If a crash *does* occur in that type of program you want details. |
|
23 | 25 | Give it a shot--you'll love it or you'll hate it. |
|
24 | 26 | |
|
25 | 27 | .. note:: |
|
26 | 28 | |
|
27 | 29 | The Verbose mode prints the variables currently visible where the exception |
|
28 | 30 | happened (shortening their strings if too long). This can potentially be |
|
29 | 31 | very slow, if you happen to have a huge data structure whose string |
|
30 | 32 | representation is complex to compute. Your computer may appear to freeze for |
|
31 | 33 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback |
|
32 | 34 | with Ctrl-C (maybe hitting it more than once). |
|
33 | 35 | |
|
34 | 36 | If you encounter this kind of situation often, you may want to use the |
|
35 | 37 | Verbose_novars mode instead of the regular Verbose, which avoids formatting |
|
36 | 38 | variables (but otherwise includes the information and context given by |
|
37 | 39 | Verbose). |
|
38 | 40 | |
|
39 | 41 | |
|
40 | 42 | Installation instructions for ColorTB:: |
|
41 | 43 | |
|
42 | 44 | import sys,ultratb |
|
43 | 45 | sys.excepthook = ultratb.VerboseTB() |
|
44 | 46 | |
|
45 | 47 | Note: Much of the code in this module was lifted verbatim from the standard |
|
46 | 48 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. |
|
47 | 49 | |
|
48 | 50 | Color schemes |
|
49 | 51 | ------------- |
|
50 | 52 | |
|
51 | 53 | The colors are defined in the class TBTools through the use of the |
|
52 | 54 | ColorSchemeTable class. Currently the following exist: |
|
53 | 55 | |
|
54 | 56 | - NoColor: allows all of this module to be used in any terminal (the color |
|
55 | 57 | escapes are just dummy blank strings). |
|
56 | 58 | |
|
57 | 59 | - Linux: is meant to look good in a terminal like the Linux console (black |
|
58 | 60 | or very dark background). |
|
59 | 61 | |
|
60 | 62 | - LightBG: similar to Linux but swaps dark/light colors to be more readable |
|
61 | 63 | in light background terminals. |
|
62 | 64 | |
|
63 | 65 | You can implement other color schemes easily, the syntax is fairly |
|
64 | 66 | self-explanatory. Please send back new schemes you develop to the author for |
|
65 | 67 | possible inclusion in future releases. |
|
66 | 68 | |
|
67 | 69 | Inheritance diagram: |
|
68 | 70 | |
|
69 | 71 | .. inheritance-diagram:: IPython.core.ultratb |
|
70 | 72 | :parts: 3 |
|
71 | 73 | """ |
|
72 | 74 | |
|
73 | 75 | #***************************************************************************** |
|
74 | 76 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> |
|
75 | 77 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> |
|
76 | 78 | # |
|
77 | 79 | # Distributed under the terms of the BSD License. The full license is in |
|
78 | 80 | # the file COPYING, distributed as part of this software. |
|
79 | 81 | #***************************************************************************** |
|
80 | 82 | |
|
81 | 83 | from __future__ import unicode_literals |
|
82 | 84 | from __future__ import print_function |
|
83 | 85 | |
|
84 | 86 | import inspect |
|
85 | 87 | import keyword |
|
86 | 88 | import linecache |
|
87 | 89 | import os |
|
88 | 90 | import pydoc |
|
89 | 91 | import re |
|
90 | 92 | import sys |
|
91 | 93 | import time |
|
92 | 94 | import tokenize |
|
93 | 95 | import traceback |
|
94 | 96 | import types |
|
95 | 97 | |
|
96 | 98 | try: # Python 2 |
|
97 | 99 | generate_tokens = tokenize.generate_tokens |
|
98 | 100 | except AttributeError: # Python 3 |
|
99 | 101 | generate_tokens = tokenize.tokenize |
|
100 | 102 | |
|
101 | 103 | # For purposes of monkeypatching inspect to fix a bug in it. |
|
102 | 104 | from inspect import getsourcefile, getfile, getmodule,\ |
|
103 | 105 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode |
|
104 | 106 | |
|
105 | 107 | # IPython's own modules |
|
106 | 108 | # Modified pdb which doesn't damage IPython's readline handling |
|
107 | 109 | from IPython import get_ipython |
|
108 | 110 | from IPython.core import debugger |
|
109 | 111 | from IPython.core.display_trap import DisplayTrap |
|
110 | 112 | from IPython.core.excolors import exception_colors |
|
111 | 113 | from IPython.utils import PyColorize |
|
112 | 114 | from IPython.utils import io |
|
113 | 115 | from IPython.utils import openpy |
|
114 | 116 | from IPython.utils import path as util_path |
|
115 | 117 | from IPython.utils import py3compat |
|
116 | 118 | from IPython.utils import ulinecache |
|
117 | 119 | from IPython.utils.data import uniq_stable |
|
118 | 120 | from IPython.utils.warn import info, error |
|
119 | 121 | |
|
120 | 122 | # Globals |
|
121 | 123 | # amount of space to put line numbers before verbose tracebacks |
|
122 | 124 | INDENT_SIZE = 8 |
|
123 | 125 | |
|
124 | 126 | # Default color scheme. This is used, for example, by the traceback |
|
125 | 127 | # formatter. When running in an actual IPython instance, the user's rc.colors |
|
126 | 128 | # value is used, but havinga module global makes this functionality available |
|
127 | 129 | # to users of ultratb who are NOT running inside ipython. |
|
128 | 130 | DEFAULT_SCHEME = 'NoColor' |
|
129 | 131 | |
|
130 | 132 | #--------------------------------------------------------------------------- |
|
131 | 133 | # Code begins |
|
132 | 134 | |
|
133 | 135 | # Utility functions |
|
134 | 136 | def inspect_error(): |
|
135 | 137 | """Print a message about internal inspect errors. |
|
136 | 138 | |
|
137 | 139 | These are unfortunately quite common.""" |
|
138 | 140 | |
|
139 | 141 | error('Internal Python error in the inspect module.\n' |
|
140 | 142 | 'Below is the traceback from this internal error.\n') |
|
141 | 143 | |
|
142 | 144 | # This function is a monkeypatch we apply to the Python inspect module. We have |
|
143 | 145 | # now found when it's needed (see discussion on issue gh-1456), and we have a |
|
144 | 146 | # test case (IPython.core.tests.test_ultratb.ChangedPyFileTest) that fails if |
|
145 | 147 | # the monkeypatch is not applied. TK, Aug 2012. |
|
146 | 148 | def findsource(object): |
|
147 | 149 | """Return the entire source file and starting line number for an object. |
|
148 | 150 | |
|
149 | 151 | The argument may be a module, class, method, function, traceback, frame, |
|
150 | 152 | or code object. The source code is returned as a list of all the lines |
|
151 | 153 | in the file and the line number indexes a line in that list. An IOError |
|
152 | 154 | is raised if the source code cannot be retrieved. |
|
153 | 155 | |
|
154 | 156 | FIXED version with which we monkeypatch the stdlib to work around a bug.""" |
|
155 | 157 | |
|
156 | 158 | file = getsourcefile(object) or getfile(object) |
|
157 | 159 | # If the object is a frame, then trying to get the globals dict from its |
|
158 | 160 | # module won't work. Instead, the frame object itself has the globals |
|
159 | 161 | # dictionary. |
|
160 | 162 | globals_dict = None |
|
161 | 163 | if inspect.isframe(object): |
|
162 | 164 | # XXX: can this ever be false? |
|
163 | 165 | globals_dict = object.f_globals |
|
164 | 166 | else: |
|
165 | 167 | module = getmodule(object, file) |
|
166 | 168 | if module: |
|
167 | 169 | globals_dict = module.__dict__ |
|
168 | 170 | lines = linecache.getlines(file, globals_dict) |
|
169 | 171 | if not lines: |
|
170 | 172 | raise IOError('could not get source code') |
|
171 | 173 | |
|
172 | 174 | if ismodule(object): |
|
173 | 175 | return lines, 0 |
|
174 | 176 | |
|
175 | 177 | if isclass(object): |
|
176 | 178 | name = object.__name__ |
|
177 | 179 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') |
|
178 | 180 | # make some effort to find the best matching class definition: |
|
179 | 181 | # use the one with the least indentation, which is the one |
|
180 | 182 | # that's most probably not inside a function definition. |
|
181 | 183 | candidates = [] |
|
182 | 184 | for i in range(len(lines)): |
|
183 | 185 | match = pat.match(lines[i]) |
|
184 | 186 | if match: |
|
185 | 187 | # if it's at toplevel, it's already the best one |
|
186 | 188 | if lines[i][0] == 'c': |
|
187 | 189 | return lines, i |
|
188 | 190 | # else add whitespace to candidate list |
|
189 | 191 | candidates.append((match.group(1), i)) |
|
190 | 192 | if candidates: |
|
191 | 193 | # this will sort by whitespace, and by line number, |
|
192 | 194 | # less whitespace first |
|
193 | 195 | candidates.sort() |
|
194 | 196 | return lines, candidates[0][1] |
|
195 | 197 | else: |
|
196 | 198 | raise IOError('could not find class definition') |
|
197 | 199 | |
|
198 | 200 | if ismethod(object): |
|
199 | 201 | object = object.__func__ |
|
200 | 202 | if isfunction(object): |
|
201 | 203 | object = object.__code__ |
|
202 | 204 | if istraceback(object): |
|
203 | 205 | object = object.tb_frame |
|
204 | 206 | if isframe(object): |
|
205 | 207 | object = object.f_code |
|
206 | 208 | if iscode(object): |
|
207 | 209 | if not hasattr(object, 'co_firstlineno'): |
|
208 | 210 | raise IOError('could not find function definition') |
|
209 | 211 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') |
|
210 | 212 | pmatch = pat.match |
|
211 | 213 | # fperez - fix: sometimes, co_firstlineno can give a number larger than |
|
212 | 214 | # the length of lines, which causes an error. Safeguard against that. |
|
213 | 215 | lnum = min(object.co_firstlineno,len(lines))-1 |
|
214 | 216 | while lnum > 0: |
|
215 | 217 | if pmatch(lines[lnum]): break |
|
216 | 218 | lnum -= 1 |
|
217 | 219 | |
|
218 | 220 | return lines, lnum |
|
219 | 221 | raise IOError('could not find code object') |
|
220 | 222 | |
|
221 | 223 | # Monkeypatch inspect to apply our bugfix. This code only works with Python >= 2.5 |
|
222 | 224 | inspect.findsource = findsource |
|
223 | 225 | |
|
224 | 226 | def fix_frame_records_filenames(records): |
|
225 | 227 | """Try to fix the filenames in each record from inspect.getinnerframes(). |
|
226 | 228 | |
|
227 | 229 | Particularly, modules loaded from within zip files have useless filenames |
|
228 | 230 | attached to their code object, and inspect.getinnerframes() just uses it. |
|
229 | 231 | """ |
|
230 | 232 | fixed_records = [] |
|
231 | 233 | for frame, filename, line_no, func_name, lines, index in records: |
|
232 | 234 | # Look inside the frame's globals dictionary for __file__, which should |
|
233 | 235 | # be better. |
|
234 | 236 | better_fn = frame.f_globals.get('__file__', None) |
|
235 | 237 | if isinstance(better_fn, str): |
|
236 | 238 | # Check the type just in case someone did something weird with |
|
237 | 239 | # __file__. It might also be None if the error occurred during |
|
238 | 240 | # import. |
|
239 | 241 | filename = better_fn |
|
240 | 242 | fixed_records.append((frame, filename, line_no, func_name, lines, index)) |
|
241 | 243 | return fixed_records |
|
242 | 244 | |
|
243 | 245 | |
|
244 | 246 | def _fixed_getinnerframes(etb, context=1,tb_offset=0): |
|
245 | 247 | LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5 |
|
246 | 248 | |
|
247 | 249 | records = fix_frame_records_filenames(inspect.getinnerframes(etb, context)) |
|
248 | 250 | |
|
249 | 251 | # If the error is at the console, don't build any context, since it would |
|
250 | 252 | # otherwise produce 5 blank lines printed out (there is no file at the |
|
251 | 253 | # console) |
|
252 | 254 | rec_check = records[tb_offset:] |
|
253 | 255 | try: |
|
254 | 256 | rname = rec_check[0][1] |
|
255 | 257 | if rname == '<ipython console>' or rname.endswith('<string>'): |
|
256 | 258 | return rec_check |
|
257 | 259 | except IndexError: |
|
258 | 260 | pass |
|
259 | 261 | |
|
260 | 262 | aux = traceback.extract_tb(etb) |
|
261 | 263 | assert len(records) == len(aux) |
|
262 | 264 | for i, (file, lnum, _, _) in zip(range(len(records)), aux): |
|
263 | 265 | maybeStart = lnum-1 - context//2 |
|
264 | 266 | start = max(maybeStart, 0) |
|
265 | 267 | end = start + context |
|
266 | 268 | lines = ulinecache.getlines(file)[start:end] |
|
267 | 269 | buf = list(records[i]) |
|
268 | 270 | buf[LNUM_POS] = lnum |
|
269 | 271 | buf[INDEX_POS] = lnum - 1 - start |
|
270 | 272 | buf[LINES_POS] = lines |
|
271 | 273 | records[i] = tuple(buf) |
|
272 | 274 | return records[tb_offset:] |
|
273 | 275 | |
|
274 | 276 | # Helper function -- largely belongs to VerboseTB, but we need the same |
|
275 | 277 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they |
|
276 | 278 | # can be recognized properly by ipython.el's py-traceback-line-re |
|
277 | 279 | # (SyntaxErrors have to be treated specially because they have no traceback) |
|
278 | 280 | |
|
279 | 281 | _parser = PyColorize.Parser() |
|
280 | 282 | |
|
281 | 283 | def _format_traceback_lines(lnum, index, lines, Colors, lvals=None,scheme=None): |
|
282 | 284 | numbers_width = INDENT_SIZE - 1 |
|
283 | 285 | res = [] |
|
284 | 286 | i = lnum - index |
|
285 | 287 | |
|
286 | 288 | # This lets us get fully syntax-highlighted tracebacks. |
|
287 | 289 | if scheme is None: |
|
288 | 290 | ipinst = get_ipython() |
|
289 | 291 | if ipinst is not None: |
|
290 | 292 | scheme = ipinst.colors |
|
291 | 293 | else: |
|
292 | 294 | scheme = DEFAULT_SCHEME |
|
293 | 295 | |
|
294 | 296 | _line_format = _parser.format2 |
|
295 | 297 | |
|
296 | 298 | for line in lines: |
|
297 | 299 | line = py3compat.cast_unicode(line) |
|
298 | 300 | |
|
299 | 301 | new_line, err = _line_format(line, 'str', scheme) |
|
300 | 302 | if not err: line = new_line |
|
301 | 303 | |
|
302 | 304 | if i == lnum: |
|
303 | 305 | # This is the line with the error |
|
304 | 306 | pad = numbers_width - len(str(i)) |
|
305 | 307 | if pad >= 3: |
|
306 | 308 | marker = '-'*(pad-3) + '-> ' |
|
307 | 309 | elif pad == 2: |
|
308 | 310 | marker = '> ' |
|
309 | 311 | elif pad == 1: |
|
310 | 312 | marker = '>' |
|
311 | 313 | else: |
|
312 | 314 | marker = '' |
|
313 | 315 | num = marker + str(i) |
|
314 | 316 | line = '%s%s%s %s%s' %(Colors.linenoEm, num, |
|
315 | 317 | Colors.line, line, Colors.Normal) |
|
316 | 318 | else: |
|
317 | 319 | num = '%*s' % (numbers_width,i) |
|
318 | 320 | line = '%s%s%s %s' %(Colors.lineno, num, |
|
319 | 321 | Colors.Normal, line) |
|
320 | 322 | |
|
321 | 323 | res.append(line) |
|
322 | 324 | if lvals and i == lnum: |
|
323 | 325 | res.append(lvals + '\n') |
|
324 | 326 | i = i + 1 |
|
325 | 327 | return res |
|
326 | 328 | |
|
327 | 329 | |
|
328 | 330 | #--------------------------------------------------------------------------- |
|
329 | 331 | # Module classes |
|
330 | 332 | class TBTools(object): |
|
331 | 333 | """Basic tools used by all traceback printer classes.""" |
|
332 | 334 | |
|
333 | 335 | # Number of frames to skip when reporting tracebacks |
|
334 | 336 | tb_offset = 0 |
|
335 | 337 | |
|
336 | 338 | def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None): |
|
337 | 339 | # Whether to call the interactive pdb debugger after printing |
|
338 | 340 | # tracebacks or not |
|
339 | 341 | self.call_pdb = call_pdb |
|
340 | 342 | |
|
341 | 343 | # Output stream to write to. Note that we store the original value in |
|
342 | 344 | # a private attribute and then make the public ostream a property, so |
|
343 | 345 | # that we can delay accessing io.stdout until runtime. The way |
|
344 | 346 | # things are written now, the io.stdout object is dynamically managed |
|
345 | 347 | # so a reference to it should NEVER be stored statically. This |
|
346 | 348 | # property approach confines this detail to a single location, and all |
|
347 | 349 | # subclasses can simply access self.ostream for writing. |
|
348 | 350 | self._ostream = ostream |
|
349 | 351 | |
|
350 | 352 | # Create color table |
|
351 | 353 | self.color_scheme_table = exception_colors() |
|
352 | 354 | |
|
353 | 355 | self.set_colors(color_scheme) |
|
354 | 356 | self.old_scheme = color_scheme # save initial value for toggles |
|
355 | 357 | |
|
356 | 358 | if call_pdb: |
|
357 | 359 | self.pdb = debugger.Pdb(self.color_scheme_table.active_scheme_name) |
|
358 | 360 | else: |
|
359 | 361 | self.pdb = None |
|
360 | 362 | |
|
361 | 363 | def _get_ostream(self): |
|
362 | 364 | """Output stream that exceptions are written to. |
|
363 | 365 | |
|
364 | 366 | Valid values are: |
|
365 | 367 | |
|
366 | 368 | - None: the default, which means that IPython will dynamically resolve |
|
367 | 369 | to io.stdout. This ensures compatibility with most tools, including |
|
368 | 370 | Windows (where plain stdout doesn't recognize ANSI escapes). |
|
369 | 371 | |
|
370 | 372 | - Any object with 'write' and 'flush' attributes. |
|
371 | 373 | """ |
|
372 | 374 | return io.stdout if self._ostream is None else self._ostream |
|
373 | 375 | |
|
374 | 376 | def _set_ostream(self, val): |
|
375 | 377 | assert val is None or (hasattr(val, 'write') and hasattr(val, 'flush')) |
|
376 | 378 | self._ostream = val |
|
377 | 379 | |
|
378 | 380 | ostream = property(_get_ostream, _set_ostream) |
|
379 | 381 | |
|
380 | 382 | def set_colors(self,*args,**kw): |
|
381 | 383 | """Shorthand access to the color table scheme selector method.""" |
|
382 | 384 | |
|
383 | 385 | # Set own color table |
|
384 | 386 | self.color_scheme_table.set_active_scheme(*args,**kw) |
|
385 | 387 | # for convenience, set Colors to the active scheme |
|
386 | 388 | self.Colors = self.color_scheme_table.active_colors |
|
387 | 389 | # Also set colors of debugger |
|
388 | 390 | if hasattr(self,'pdb') and self.pdb is not None: |
|
389 | 391 | self.pdb.set_colors(*args,**kw) |
|
390 | 392 | |
|
391 | 393 | def color_toggle(self): |
|
392 | 394 | """Toggle between the currently active color scheme and NoColor.""" |
|
393 | 395 | |
|
394 | 396 | if self.color_scheme_table.active_scheme_name == 'NoColor': |
|
395 | 397 | self.color_scheme_table.set_active_scheme(self.old_scheme) |
|
396 | 398 | self.Colors = self.color_scheme_table.active_colors |
|
397 | 399 | else: |
|
398 | 400 | self.old_scheme = self.color_scheme_table.active_scheme_name |
|
399 | 401 | self.color_scheme_table.set_active_scheme('NoColor') |
|
400 | 402 | self.Colors = self.color_scheme_table.active_colors |
|
401 | 403 | |
|
402 | 404 | def stb2text(self, stb): |
|
403 | 405 | """Convert a structured traceback (a list) to a string.""" |
|
404 | 406 | return '\n'.join(stb) |
|
405 | 407 | |
|
406 | 408 | def text(self, etype, value, tb, tb_offset=None, context=5): |
|
407 | 409 | """Return formatted traceback. |
|
408 | 410 | |
|
409 | 411 | Subclasses may override this if they add extra arguments. |
|
410 | 412 | """ |
|
411 | 413 | tb_list = self.structured_traceback(etype, value, tb, |
|
412 | 414 | tb_offset, context) |
|
413 | 415 | return self.stb2text(tb_list) |
|
414 | 416 | |
|
415 | 417 | def structured_traceback(self, etype, evalue, tb, tb_offset=None, |
|
416 | 418 | context=5, mode=None): |
|
417 | 419 | """Return a list of traceback frames. |
|
418 | 420 | |
|
419 | 421 | Must be implemented by each class. |
|
420 | 422 | """ |
|
421 | 423 | raise NotImplementedError() |
|
422 | 424 | |
|
423 | 425 | |
|
424 | 426 | #--------------------------------------------------------------------------- |
|
425 | 427 | class ListTB(TBTools): |
|
426 | 428 | """Print traceback information from a traceback list, with optional color. |
|
427 | 429 | |
|
428 | 430 | Calling requires 3 arguments: (etype, evalue, elist) |
|
429 | 431 | as would be obtained by:: |
|
430 | 432 | |
|
431 | 433 | etype, evalue, tb = sys.exc_info() |
|
432 | 434 | if tb: |
|
433 | 435 | elist = traceback.extract_tb(tb) |
|
434 | 436 | else: |
|
435 | 437 | elist = None |
|
436 | 438 | |
|
437 | 439 | It can thus be used by programs which need to process the traceback before |
|
438 | 440 | printing (such as console replacements based on the code module from the |
|
439 | 441 | standard library). |
|
440 | 442 | |
|
441 | 443 | Because they are meant to be called without a full traceback (only a |
|
442 | 444 | list), instances of this class can't call the interactive pdb debugger.""" |
|
443 | 445 | |
|
444 | 446 | def __init__(self,color_scheme = 'NoColor', call_pdb=False, ostream=None): |
|
445 | 447 | TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
446 | 448 | ostream=ostream) |
|
447 | 449 | |
|
448 | 450 | def __call__(self, etype, value, elist): |
|
449 | 451 | self.ostream.flush() |
|
450 | 452 | self.ostream.write(self.text(etype, value, elist)) |
|
451 | 453 | self.ostream.write('\n') |
|
452 | 454 | |
|
453 | 455 | def structured_traceback(self, etype, value, elist, tb_offset=None, |
|
454 | 456 | context=5): |
|
455 | 457 | """Return a color formatted string with the traceback info. |
|
456 | 458 | |
|
457 | 459 | Parameters |
|
458 | 460 | ---------- |
|
459 | 461 | etype : exception type |
|
460 | 462 | Type of the exception raised. |
|
461 | 463 | |
|
462 | 464 | value : object |
|
463 | 465 | Data stored in the exception |
|
464 | 466 | |
|
465 | 467 | elist : list |
|
466 | 468 | List of frames, see class docstring for details. |
|
467 | 469 | |
|
468 | 470 | tb_offset : int, optional |
|
469 | 471 | Number of frames in the traceback to skip. If not given, the |
|
470 | 472 | instance value is used (set in constructor). |
|
471 | 473 | |
|
472 | 474 | context : int, optional |
|
473 | 475 | Number of lines of context information to print. |
|
474 | 476 | |
|
475 | 477 | Returns |
|
476 | 478 | ------- |
|
477 | 479 | String with formatted exception. |
|
478 | 480 | """ |
|
479 | 481 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
480 | 482 | Colors = self.Colors |
|
481 | 483 | out_list = [] |
|
482 | 484 | if elist: |
|
483 | 485 | |
|
484 | 486 | if tb_offset and len(elist) > tb_offset: |
|
485 | 487 | elist = elist[tb_offset:] |
|
486 | 488 | |
|
487 | 489 | out_list.append('Traceback %s(most recent call last)%s:' % |
|
488 | 490 | (Colors.normalEm, Colors.Normal) + '\n') |
|
489 | 491 | out_list.extend(self._format_list(elist)) |
|
490 | 492 | # The exception info should be a single entry in the list. |
|
491 | 493 | lines = ''.join(self._format_exception_only(etype, value)) |
|
492 | 494 | out_list.append(lines) |
|
493 | 495 | |
|
494 | 496 | # Note: this code originally read: |
|
495 | 497 | |
|
496 | 498 | ## for line in lines[:-1]: |
|
497 | 499 | ## out_list.append(" "+line) |
|
498 | 500 | ## out_list.append(lines[-1]) |
|
499 | 501 | |
|
500 | 502 | # This means it was indenting everything but the last line by a little |
|
501 | 503 | # bit. I've disabled this for now, but if we see ugliness somewhre we |
|
502 | 504 | # can restore it. |
|
503 | 505 | |
|
504 | 506 | return out_list |
|
505 | 507 | |
|
506 | 508 | def _format_list(self, extracted_list): |
|
507 | 509 | """Format a list of traceback entry tuples for printing. |
|
508 | 510 | |
|
509 | 511 | Given a list of tuples as returned by extract_tb() or |
|
510 | 512 | extract_stack(), return a list of strings ready for printing. |
|
511 | 513 | Each string in the resulting list corresponds to the item with the |
|
512 | 514 | same index in the argument list. Each string ends in a newline; |
|
513 | 515 | the strings may contain internal newlines as well, for those items |
|
514 | 516 | whose source text line is not None. |
|
515 | 517 | |
|
516 | 518 | Lifted almost verbatim from traceback.py |
|
517 | 519 | """ |
|
518 | 520 | |
|
519 | 521 | Colors = self.Colors |
|
520 | 522 | list = [] |
|
521 | 523 | for filename, lineno, name, line in extracted_list[:-1]: |
|
522 | 524 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ |
|
523 | 525 | (Colors.filename, filename, Colors.Normal, |
|
524 | 526 | Colors.lineno, lineno, Colors.Normal, |
|
525 | 527 | Colors.name, name, Colors.Normal) |
|
526 | 528 | if line: |
|
527 | 529 | item += ' %s\n' % line.strip() |
|
528 | 530 | list.append(item) |
|
529 | 531 | # Emphasize the last entry |
|
530 | 532 | filename, lineno, name, line = extracted_list[-1] |
|
531 | 533 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ |
|
532 | 534 | (Colors.normalEm, |
|
533 | 535 | Colors.filenameEm, filename, Colors.normalEm, |
|
534 | 536 | Colors.linenoEm, lineno, Colors.normalEm, |
|
535 | 537 | Colors.nameEm, name, Colors.normalEm, |
|
536 | 538 | Colors.Normal) |
|
537 | 539 | if line: |
|
538 | 540 | item += '%s %s%s\n' % (Colors.line, line.strip(), |
|
539 | 541 | Colors.Normal) |
|
540 | 542 | list.append(item) |
|
541 | 543 | #from pprint import pformat; print 'LISTTB', pformat(list) # dbg |
|
542 | 544 | return list |
|
543 | 545 | |
|
544 | 546 | def _format_exception_only(self, etype, value): |
|
545 | 547 | """Format the exception part of a traceback. |
|
546 | 548 | |
|
547 | 549 | The arguments are the exception type and value such as given by |
|
548 | 550 | sys.exc_info()[:2]. The return value is a list of strings, each ending |
|
549 | 551 | in a newline. Normally, the list contains a single string; however, |
|
550 | 552 | for SyntaxError exceptions, it contains several lines that (when |
|
551 | 553 | printed) display detailed information about where the syntax error |
|
552 | 554 | occurred. The message indicating which exception occurred is the |
|
553 | 555 | always last string in the list. |
|
554 | 556 | |
|
555 | 557 | Also lifted nearly verbatim from traceback.py |
|
556 | 558 | """ |
|
557 | 559 | have_filedata = False |
|
558 | 560 | Colors = self.Colors |
|
559 | 561 | list = [] |
|
560 | 562 | stype = Colors.excName + etype.__name__ + Colors.Normal |
|
561 | 563 | if value is None: |
|
562 | 564 | # Not sure if this can still happen in Python 2.6 and above |
|
563 | 565 | list.append( py3compat.cast_unicode(stype) + '\n') |
|
564 | 566 | else: |
|
565 | 567 | if issubclass(etype, SyntaxError): |
|
566 | 568 | have_filedata = True |
|
567 | 569 | #print 'filename is',filename # dbg |
|
568 | 570 | if not value.filename: value.filename = "<string>" |
|
569 | 571 | if value.lineno: |
|
570 | 572 | lineno = value.lineno |
|
571 | 573 | textline = ulinecache.getline(value.filename, value.lineno) |
|
572 | 574 | else: |
|
573 | 575 | lineno = 'unknown' |
|
574 | 576 | textline = '' |
|
575 | 577 | list.append('%s File %s"%s"%s, line %s%s%s\n' % \ |
|
576 | 578 | (Colors.normalEm, |
|
577 | 579 | Colors.filenameEm, py3compat.cast_unicode(value.filename), Colors.normalEm, |
|
578 | 580 | Colors.linenoEm, lineno, Colors.Normal )) |
|
579 | 581 | if textline == '': |
|
580 | 582 | textline = py3compat.cast_unicode(value.text, "utf-8") |
|
581 | 583 | |
|
582 | 584 | if textline is not None: |
|
583 | 585 | i = 0 |
|
584 | 586 | while i < len(textline) and textline[i].isspace(): |
|
585 | 587 | i += 1 |
|
586 | 588 | list.append('%s %s%s\n' % (Colors.line, |
|
587 | 589 | textline.strip(), |
|
588 | 590 | Colors.Normal)) |
|
589 | 591 | if value.offset is not None: |
|
590 | 592 | s = ' ' |
|
591 | 593 | for c in textline[i:value.offset-1]: |
|
592 | 594 | if c.isspace(): |
|
593 | 595 | s += c |
|
594 | 596 | else: |
|
595 | 597 | s += ' ' |
|
596 | 598 | list.append('%s%s^%s\n' % (Colors.caret, s, |
|
597 | 599 | Colors.Normal) ) |
|
598 | 600 | |
|
599 | 601 | try: |
|
600 | 602 | s = value.msg |
|
601 | 603 | except Exception: |
|
602 | 604 | s = self._some_str(value) |
|
603 | 605 | if s: |
|
604 | 606 | list.append('%s%s:%s %s\n' % (str(stype), Colors.excName, |
|
605 | 607 | Colors.Normal, s)) |
|
606 | 608 | else: |
|
607 | 609 | list.append('%s\n' % str(stype)) |
|
608 | 610 | |
|
609 | 611 | # sync with user hooks |
|
610 | 612 | if have_filedata: |
|
611 | 613 | ipinst = get_ipython() |
|
612 | 614 | if ipinst is not None: |
|
613 | 615 | ipinst.hooks.synchronize_with_editor(value.filename, value.lineno, 0) |
|
614 | 616 | |
|
615 | 617 | return list |
|
616 | 618 | |
|
617 | 619 | def get_exception_only(self, etype, value): |
|
618 | 620 | """Only print the exception type and message, without a traceback. |
|
619 | 621 | |
|
620 | 622 | Parameters |
|
621 | 623 | ---------- |
|
622 | 624 | etype : exception type |
|
623 | 625 | value : exception value |
|
624 | 626 | """ |
|
625 | 627 | return ListTB.structured_traceback(self, etype, value, []) |
|
626 | 628 | |
|
627 | 629 | |
|
628 | 630 | def show_exception_only(self, etype, evalue): |
|
629 | 631 | """Only print the exception type and message, without a traceback. |
|
630 | 632 | |
|
631 | 633 | Parameters |
|
632 | 634 | ---------- |
|
633 | 635 | etype : exception type |
|
634 | 636 | value : exception value |
|
635 | 637 | """ |
|
636 | 638 | # This method needs to use __call__ from *this* class, not the one from |
|
637 | 639 | # a subclass whose signature or behavior may be different |
|
638 | 640 | ostream = self.ostream |
|
639 | 641 | ostream.flush() |
|
640 | 642 | ostream.write('\n'.join(self.get_exception_only(etype, evalue))) |
|
641 | 643 | ostream.flush() |
|
642 | 644 | |
|
643 | 645 | def _some_str(self, value): |
|
644 | 646 | # Lifted from traceback.py |
|
645 | 647 | try: |
|
646 | 648 | return str(value) |
|
647 | 649 | except: |
|
648 | 650 | return '<unprintable %s object>' % type(value).__name__ |
|
649 | 651 | |
|
650 | 652 | #---------------------------------------------------------------------------- |
|
651 | 653 | class VerboseTB(TBTools): |
|
652 | 654 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead |
|
653 | 655 | of HTML. Requires inspect and pydoc. Crazy, man. |
|
654 | 656 | |
|
655 | 657 | Modified version which optionally strips the topmost entries from the |
|
656 | 658 | traceback, to be used with alternate interpreters (because their own code |
|
657 | 659 | would appear in the traceback).""" |
|
658 | 660 | |
|
659 | 661 | def __init__(self,color_scheme = 'Linux', call_pdb=False, ostream=None, |
|
660 | 662 | tb_offset=0, long_header=False, include_vars=True, |
|
661 | 663 | check_cache=None): |
|
662 | 664 | """Specify traceback offset, headers and color scheme. |
|
663 | 665 | |
|
664 | 666 | Define how many frames to drop from the tracebacks. Calling it with |
|
665 | 667 | tb_offset=1 allows use of this handler in interpreters which will have |
|
666 | 668 | their own code at the top of the traceback (VerboseTB will first |
|
667 | 669 | remove that frame before printing the traceback info).""" |
|
668 | 670 | TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
669 | 671 | ostream=ostream) |
|
670 | 672 | self.tb_offset = tb_offset |
|
671 | 673 | self.long_header = long_header |
|
672 | 674 | self.include_vars = include_vars |
|
673 | 675 | # By default we use linecache.checkcache, but the user can provide a |
|
674 | 676 | # different check_cache implementation. This is used by the IPython |
|
675 | 677 | # kernel to provide tracebacks for interactive code that is cached, |
|
676 | 678 | # by a compiler instance that flushes the linecache but preserves its |
|
677 | 679 | # own code cache. |
|
678 | 680 | if check_cache is None: |
|
679 | 681 | check_cache = linecache.checkcache |
|
680 | 682 | self.check_cache = check_cache |
|
681 | 683 | |
|
682 | 684 | def structured_traceback(self, etype, evalue, etb, tb_offset=None, |
|
683 | 685 | context=5): |
|
684 | 686 | """Return a nice text document describing the traceback.""" |
|
685 | 687 | |
|
686 | 688 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
687 | 689 | |
|
688 | 690 | # some locals |
|
689 | 691 | try: |
|
690 | 692 | etype = etype.__name__ |
|
691 | 693 | except AttributeError: |
|
692 | 694 | pass |
|
693 | 695 | Colors = self.Colors # just a shorthand + quicker name lookup |
|
694 | 696 | ColorsNormal = Colors.Normal # used a lot |
|
695 | 697 | col_scheme = self.color_scheme_table.active_scheme_name |
|
696 | 698 | indent = ' '*INDENT_SIZE |
|
697 | 699 | em_normal = '%s\n%s%s' % (Colors.valEm, indent,ColorsNormal) |
|
698 | 700 | undefined = '%sundefined%s' % (Colors.em, ColorsNormal) |
|
699 | 701 | exc = '%s%s%s' % (Colors.excName,etype,ColorsNormal) |
|
700 | 702 | |
|
701 | 703 | # some internal-use functions |
|
702 | 704 | def text_repr(value): |
|
703 | 705 | """Hopefully pretty robust repr equivalent.""" |
|
704 | 706 | # this is pretty horrible but should always return *something* |
|
705 | 707 | try: |
|
706 | 708 | return pydoc.text.repr(value) |
|
707 | 709 | except KeyboardInterrupt: |
|
708 | 710 | raise |
|
709 | 711 | except: |
|
710 | 712 | try: |
|
711 | 713 | return repr(value) |
|
712 | 714 | except KeyboardInterrupt: |
|
713 | 715 | raise |
|
714 | 716 | except: |
|
715 | 717 | try: |
|
716 | 718 | # all still in an except block so we catch |
|
717 | 719 | # getattr raising |
|
718 | 720 | name = getattr(value, '__name__', None) |
|
719 | 721 | if name: |
|
720 | 722 | # ick, recursion |
|
721 | 723 | return text_repr(name) |
|
722 | 724 | klass = getattr(value, '__class__', None) |
|
723 | 725 | if klass: |
|
724 | 726 | return '%s instance' % text_repr(klass) |
|
725 | 727 | except KeyboardInterrupt: |
|
726 | 728 | raise |
|
727 | 729 | except: |
|
728 | 730 | return 'UNRECOVERABLE REPR FAILURE' |
|
729 | 731 | def eqrepr(value, repr=text_repr): return '=%s' % repr(value) |
|
730 | 732 | def nullrepr(value, repr=text_repr): return '' |
|
731 | 733 | |
|
732 | 734 | # meat of the code begins |
|
733 | 735 | try: |
|
734 | 736 | etype = etype.__name__ |
|
735 | 737 | except AttributeError: |
|
736 | 738 | pass |
|
737 | 739 | |
|
738 | 740 | if self.long_header: |
|
739 | 741 | # Header with the exception type, python version, and date |
|
740 | 742 | pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable |
|
741 | 743 | date = time.ctime(time.time()) |
|
742 | 744 | |
|
743 | 745 | head = '%s%s%s\n%s%s%s\n%s' % (Colors.topline, '-'*75, ColorsNormal, |
|
744 | 746 | exc, ' '*(75-len(str(etype))-len(pyver)), |
|
745 | 747 | pyver, date.rjust(75) ) |
|
746 | 748 | head += "\nA problem occured executing Python code. Here is the sequence of function"\ |
|
747 | 749 | "\ncalls leading up to the error, with the most recent (innermost) call last." |
|
748 | 750 | else: |
|
749 | 751 | # Simplified header |
|
750 | 752 | head = '%s%s%s\n%s%s' % (Colors.topline, '-'*75, ColorsNormal,exc, |
|
751 | 753 | 'Traceback (most recent call last)'.\ |
|
752 | 754 | rjust(75 - len(str(etype)) ) ) |
|
753 | 755 | frames = [] |
|
754 | 756 | # Flush cache before calling inspect. This helps alleviate some of the |
|
755 | 757 | # problems with python 2.3's inspect.py. |
|
756 | 758 | ##self.check_cache() |
|
757 | 759 | # Drop topmost frames if requested |
|
758 | 760 | try: |
|
759 | 761 | # Try the default getinnerframes and Alex's: Alex's fixes some |
|
760 | 762 | # problems, but it generates empty tracebacks for console errors |
|
761 | 763 | # (5 blanks lines) where none should be returned. |
|
762 | 764 | #records = inspect.getinnerframes(etb, context)[tb_offset:] |
|
763 | 765 | #print 'python records:', records # dbg |
|
764 | 766 | records = _fixed_getinnerframes(etb, context, tb_offset) |
|
765 | 767 | #print 'alex records:', records # dbg |
|
766 | 768 | except: |
|
767 | 769 | |
|
768 | 770 | # FIXME: I've been getting many crash reports from python 2.3 |
|
769 | 771 | # users, traceable to inspect.py. If I can find a small test-case |
|
770 | 772 | # to reproduce this, I should either write a better workaround or |
|
771 | 773 | # file a bug report against inspect (if that's the real problem). |
|
772 | 774 | # So far, I haven't been able to find an isolated example to |
|
773 | 775 | # reproduce the problem. |
|
774 | 776 | inspect_error() |
|
775 | 777 | traceback.print_exc(file=self.ostream) |
|
776 | 778 | info('\nUnfortunately, your original traceback can not be constructed.\n') |
|
777 | 779 | return '' |
|
778 | 780 | |
|
779 | 781 | # build some color string templates outside these nested loops |
|
780 | 782 | tpl_link = '%s%%s%s' % (Colors.filenameEm,ColorsNormal) |
|
781 | 783 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, |
|
782 | 784 | ColorsNormal) |
|
783 | 785 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ |
|
784 | 786 | (Colors.vName, Colors.valEm, ColorsNormal) |
|
785 | 787 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) |
|
786 | 788 | tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal, |
|
787 | 789 | Colors.vName, ColorsNormal) |
|
788 | 790 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) |
|
789 | 791 | tpl_line = '%s%%s%s %%s' % (Colors.lineno, ColorsNormal) |
|
790 | 792 | tpl_line_em = '%s%%s%s %%s%s' % (Colors.linenoEm,Colors.line, |
|
791 | 793 | ColorsNormal) |
|
792 | 794 | |
|
793 | 795 | # now, loop over all records printing context and info |
|
794 | 796 | abspath = os.path.abspath |
|
795 | 797 | for frame, file, lnum, func, lines, index in records: |
|
796 | 798 | #print '*** record:',file,lnum,func,lines,index # dbg |
|
797 | 799 | if not file: |
|
798 | 800 | file = '?' |
|
799 | 801 | elif not(file.startswith(str("<")) and file.endswith(str(">"))): |
|
800 | 802 | # Guess that filenames like <string> aren't real filenames, so |
|
801 | 803 | # don't call abspath on them. |
|
802 | 804 | try: |
|
803 | 805 | file = abspath(file) |
|
804 | 806 | except OSError: |
|
805 | 807 | # Not sure if this can still happen: abspath now works with |
|
806 | 808 | # file names like <string> |
|
807 | 809 | pass |
|
808 | 810 | file = py3compat.cast_unicode(file, util_path.fs_encoding) |
|
809 | 811 | link = tpl_link % file |
|
810 | 812 | args, varargs, varkw, locals = inspect.getargvalues(frame) |
|
811 | 813 | |
|
812 | 814 | if func == '?': |
|
813 | 815 | call = '' |
|
814 | 816 | else: |
|
815 | 817 | # Decide whether to include variable details or not |
|
816 | 818 | var_repr = self.include_vars and eqrepr or nullrepr |
|
817 | 819 | try: |
|
818 | 820 | call = tpl_call % (func,inspect.formatargvalues(args, |
|
819 | 821 | varargs, varkw, |
|
820 | 822 | locals,formatvalue=var_repr)) |
|
821 | 823 | except KeyError: |
|
822 | 824 | # This happens in situations like errors inside generator |
|
823 | 825 | # expressions, where local variables are listed in the |
|
824 | 826 | # line, but can't be extracted from the frame. I'm not |
|
825 | 827 | # 100% sure this isn't actually a bug in inspect itself, |
|
826 | 828 | # but since there's no info for us to compute with, the |
|
827 | 829 | # best we can do is report the failure and move on. Here |
|
828 | 830 | # we must *not* call any traceback construction again, |
|
829 | 831 | # because that would mess up use of %debug later on. So we |
|
830 | 832 | # simply report the failure and move on. The only |
|
831 | 833 | # limitation will be that this frame won't have locals |
|
832 | 834 | # listed in the call signature. Quite subtle problem... |
|
833 | 835 | # I can't think of a good way to validate this in a unit |
|
834 | 836 | # test, but running a script consisting of: |
|
835 | 837 | # dict( (k,v.strip()) for (k,v) in range(10) ) |
|
836 | 838 | # will illustrate the error, if this exception catch is |
|
837 | 839 | # disabled. |
|
838 | 840 | call = tpl_call_fail % func |
|
839 | 841 | |
|
840 | 842 | # Don't attempt to tokenize binary files. |
|
841 | 843 | if file.endswith(('.so', '.pyd', '.dll')): |
|
842 | 844 | frames.append('%s %s\n' % (link,call)) |
|
843 | 845 | continue |
|
844 | 846 | elif file.endswith(('.pyc','.pyo')): |
|
845 | 847 | # Look up the corresponding source file. |
|
846 | 848 | file = openpy.source_from_cache(file) |
|
847 | 849 | |
|
848 | 850 | def linereader(file=file, lnum=[lnum], getline=ulinecache.getline): |
|
849 | 851 | line = getline(file, lnum[0]) |
|
850 | 852 | lnum[0] += 1 |
|
851 | 853 | return line |
|
852 | 854 | |
|
853 | 855 | # Build the list of names on this line of code where the exception |
|
854 | 856 | # occurred. |
|
855 | 857 | try: |
|
856 | 858 | names = [] |
|
857 | 859 | name_cont = False |
|
858 | 860 | |
|
859 | 861 | for token_type, token, start, end, line in generate_tokens(linereader): |
|
860 | 862 | # build composite names |
|
861 | 863 | if token_type == tokenize.NAME and token not in keyword.kwlist: |
|
862 | 864 | if name_cont: |
|
863 | 865 | # Continuation of a dotted name |
|
864 | 866 | try: |
|
865 | 867 | names[-1].append(token) |
|
866 | 868 | except IndexError: |
|
867 | 869 | names.append([token]) |
|
868 | 870 | name_cont = False |
|
869 | 871 | else: |
|
870 | 872 | # Regular new names. We append everything, the caller |
|
871 | 873 | # will be responsible for pruning the list later. It's |
|
872 | 874 | # very tricky to try to prune as we go, b/c composite |
|
873 | 875 | # names can fool us. The pruning at the end is easy |
|
874 | 876 | # to do (or the caller can print a list with repeated |
|
875 | 877 | # names if so desired. |
|
876 | 878 | names.append([token]) |
|
877 | 879 | elif token == '.': |
|
878 | 880 | name_cont = True |
|
879 | 881 | elif token_type == tokenize.NEWLINE: |
|
880 | 882 | break |
|
881 | 883 | |
|
882 | 884 | except (IndexError, UnicodeDecodeError): |
|
883 | 885 | # signals exit of tokenizer |
|
884 | 886 | pass |
|
885 | 887 | except tokenize.TokenError as msg: |
|
886 | 888 | _m = ("An unexpected error occurred while tokenizing input\n" |
|
887 | 889 | "The following traceback may be corrupted or invalid\n" |
|
888 | 890 | "The error message is: %s\n" % msg) |
|
889 | 891 | error(_m) |
|
890 | 892 | |
|
891 | 893 | # Join composite names (e.g. "dict.fromkeys") |
|
892 | 894 | names = ['.'.join(n) for n in names] |
|
893 | 895 | # prune names list of duplicates, but keep the right order |
|
894 | 896 | unique_names = uniq_stable(names) |
|
895 | 897 | |
|
896 | 898 | # Start loop over vars |
|
897 | 899 | lvals = [] |
|
898 | 900 | if self.include_vars: |
|
899 | 901 | for name_full in unique_names: |
|
900 | 902 | name_base = name_full.split('.',1)[0] |
|
901 | 903 | if name_base in frame.f_code.co_varnames: |
|
902 | 904 | if name_base in locals: |
|
903 | 905 | try: |
|
904 | 906 | value = repr(eval(name_full,locals)) |
|
905 | 907 | except: |
|
906 | 908 | value = undefined |
|
907 | 909 | else: |
|
908 | 910 | value = undefined |
|
909 | 911 | name = tpl_local_var % name_full |
|
910 | 912 | else: |
|
911 | 913 | if name_base in frame.f_globals: |
|
912 | 914 | try: |
|
913 | 915 | value = repr(eval(name_full,frame.f_globals)) |
|
914 | 916 | except: |
|
915 | 917 | value = undefined |
|
916 | 918 | else: |
|
917 | 919 | value = undefined |
|
918 | 920 | name = tpl_global_var % name_full |
|
919 | 921 | lvals.append(tpl_name_val % (name,value)) |
|
920 | 922 | if lvals: |
|
921 | 923 | lvals = '%s%s' % (indent,em_normal.join(lvals)) |
|
922 | 924 | else: |
|
923 | 925 | lvals = '' |
|
924 | 926 | |
|
925 | 927 | level = '%s %s\n' % (link,call) |
|
926 | 928 | |
|
927 | 929 | if index is None: |
|
928 | 930 | frames.append(level) |
|
929 | 931 | else: |
|
930 | 932 | frames.append('%s%s' % (level,''.join( |
|
931 | 933 | _format_traceback_lines(lnum,index,lines,Colors,lvals, |
|
932 | 934 | col_scheme)))) |
|
933 | 935 | |
|
934 | 936 | # Get (safely) a string form of the exception info |
|
935 | 937 | try: |
|
936 | 938 | etype_str,evalue_str = map(str,(etype,evalue)) |
|
937 | 939 | except: |
|
938 | 940 | # User exception is improperly defined. |
|
939 | 941 | etype,evalue = str,sys.exc_info()[:2] |
|
940 | 942 | etype_str,evalue_str = map(str,(etype,evalue)) |
|
941 | 943 | # ... and format it |
|
942 | 944 | exception = ['%s%s%s: %s' % (Colors.excName, etype_str, |
|
943 | 945 | ColorsNormal, py3compat.cast_unicode(evalue_str))] |
|
944 | 946 | if (not py3compat.PY3) and type(evalue) is types.InstanceType: |
|
945 | 947 | try: |
|
946 | 948 | names = [w for w in dir(evalue) if isinstance(w, py3compat.string_types)] |
|
947 | 949 | except: |
|
948 | 950 | # Every now and then, an object with funny inernals blows up |
|
949 | 951 | # when dir() is called on it. We do the best we can to report |
|
950 | 952 | # the problem and continue |
|
951 | 953 | _m = '%sException reporting error (object with broken dir())%s:' |
|
952 | 954 | exception.append(_m % (Colors.excName,ColorsNormal)) |
|
953 | 955 | etype_str,evalue_str = map(str,sys.exc_info()[:2]) |
|
954 | 956 | exception.append('%s%s%s: %s' % (Colors.excName,etype_str, |
|
955 | 957 | ColorsNormal, py3compat.cast_unicode(evalue_str))) |
|
956 | 958 | names = [] |
|
957 | 959 | for name in names: |
|
958 | 960 | value = text_repr(getattr(evalue, name)) |
|
959 | 961 | exception.append('\n%s%s = %s' % (indent, name, value)) |
|
960 | 962 | |
|
961 | 963 | # vds: >> |
|
962 | 964 | if records: |
|
963 | 965 | filepath, lnum = records[-1][1:3] |
|
964 | 966 | #print "file:", str(file), "linenb", str(lnum) # dbg |
|
965 | 967 | filepath = os.path.abspath(filepath) |
|
966 | 968 | ipinst = get_ipython() |
|
967 | 969 | if ipinst is not None: |
|
968 | 970 | ipinst.hooks.synchronize_with_editor(filepath, lnum, 0) |
|
969 | 971 | # vds: << |
|
970 | 972 | |
|
971 | 973 | # return all our info assembled as a single string |
|
972 | 974 | # return '%s\n\n%s\n%s' % (head,'\n'.join(frames),''.join(exception[0]) ) |
|
973 | 975 | return [head] + frames + [''.join(exception[0])] |
|
974 | 976 | |
|
975 | 977 | def debugger(self,force=False): |
|
976 | 978 | """Call up the pdb debugger if desired, always clean up the tb |
|
977 | 979 | reference. |
|
978 | 980 | |
|
979 | 981 | Keywords: |
|
980 | 982 | |
|
981 | 983 | - force(False): by default, this routine checks the instance call_pdb |
|
982 | 984 | flag and does not actually invoke the debugger if the flag is false. |
|
983 | 985 | The 'force' option forces the debugger to activate even if the flag |
|
984 | 986 | is false. |
|
985 | 987 | |
|
986 | 988 | If the call_pdb flag is set, the pdb interactive debugger is |
|
987 | 989 | invoked. In all cases, the self.tb reference to the current traceback |
|
988 | 990 | is deleted to prevent lingering references which hamper memory |
|
989 | 991 | management. |
|
990 | 992 | |
|
991 | 993 | Note that each call to pdb() does an 'import readline', so if your app |
|
992 | 994 | requires a special setup for the readline completers, you'll have to |
|
993 | 995 | fix that by hand after invoking the exception handler.""" |
|
994 | 996 | |
|
995 | 997 | if force or self.call_pdb: |
|
996 | 998 | if self.pdb is None: |
|
997 | 999 | self.pdb = debugger.Pdb( |
|
998 | 1000 | self.color_scheme_table.active_scheme_name) |
|
999 | 1001 | # the system displayhook may have changed, restore the original |
|
1000 | 1002 | # for pdb |
|
1001 | 1003 | display_trap = DisplayTrap(hook=sys.__displayhook__) |
|
1002 | 1004 | with display_trap: |
|
1003 | 1005 | self.pdb.reset() |
|
1004 | 1006 | # Find the right frame so we don't pop up inside ipython itself |
|
1005 | 1007 | if hasattr(self,'tb') and self.tb is not None: |
|
1006 | 1008 | etb = self.tb |
|
1007 | 1009 | else: |
|
1008 | 1010 | etb = self.tb = sys.last_traceback |
|
1009 | 1011 | while self.tb is not None and self.tb.tb_next is not None: |
|
1010 | 1012 | self.tb = self.tb.tb_next |
|
1011 | 1013 | if etb and etb.tb_next: |
|
1012 | 1014 | etb = etb.tb_next |
|
1013 | 1015 | self.pdb.botframe = etb.tb_frame |
|
1014 | 1016 | self.pdb.interaction(self.tb.tb_frame, self.tb) |
|
1015 | 1017 | |
|
1016 | 1018 | if hasattr(self,'tb'): |
|
1017 | 1019 | del self.tb |
|
1018 | 1020 | |
|
1019 | 1021 | def handler(self, info=None): |
|
1020 | 1022 | (etype, evalue, etb) = info or sys.exc_info() |
|
1021 | 1023 | self.tb = etb |
|
1022 | 1024 | ostream = self.ostream |
|
1023 | 1025 | ostream.flush() |
|
1024 | 1026 | ostream.write(self.text(etype, evalue, etb)) |
|
1025 | 1027 | ostream.write('\n') |
|
1026 | 1028 | ostream.flush() |
|
1027 | 1029 | |
|
1028 | 1030 | # Changed so an instance can just be called as VerboseTB_inst() and print |
|
1029 | 1031 | # out the right info on its own. |
|
1030 | 1032 | def __call__(self, etype=None, evalue=None, etb=None): |
|
1031 | 1033 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" |
|
1032 | 1034 | if etb is None: |
|
1033 | 1035 | self.handler() |
|
1034 | 1036 | else: |
|
1035 | 1037 | self.handler((etype, evalue, etb)) |
|
1036 | 1038 | try: |
|
1037 | 1039 | self.debugger() |
|
1038 | 1040 | except KeyboardInterrupt: |
|
1039 | 1041 | print("\nKeyboardInterrupt") |
|
1040 | 1042 | |
|
1041 | 1043 | #---------------------------------------------------------------------------- |
|
1042 | 1044 | class FormattedTB(VerboseTB, ListTB): |
|
1043 | 1045 | """Subclass ListTB but allow calling with a traceback. |
|
1044 | 1046 | |
|
1045 | 1047 | It can thus be used as a sys.excepthook for Python > 2.1. |
|
1046 | 1048 | |
|
1047 | 1049 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. |
|
1048 | 1050 | |
|
1049 | 1051 | Allows a tb_offset to be specified. This is useful for situations where |
|
1050 | 1052 | one needs to remove a number of topmost frames from the traceback (such as |
|
1051 | 1053 | occurs with python programs that themselves execute other python code, |
|
1052 | 1054 | like Python shells). """ |
|
1053 | 1055 | |
|
1054 | 1056 | def __init__(self, mode='Plain', color_scheme='Linux', call_pdb=False, |
|
1055 | 1057 | ostream=None, |
|
1056 | 1058 | tb_offset=0, long_header=False, include_vars=False, |
|
1057 | 1059 | check_cache=None): |
|
1058 | 1060 | |
|
1059 | 1061 | # NEVER change the order of this list. Put new modes at the end: |
|
1060 | 1062 | self.valid_modes = ['Plain','Context','Verbose'] |
|
1061 | 1063 | self.verbose_modes = self.valid_modes[1:3] |
|
1062 | 1064 | |
|
1063 | 1065 | VerboseTB.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
1064 | 1066 | ostream=ostream, tb_offset=tb_offset, |
|
1065 | 1067 | long_header=long_header, include_vars=include_vars, |
|
1066 | 1068 | check_cache=check_cache) |
|
1067 | 1069 | |
|
1068 | 1070 | # Different types of tracebacks are joined with different separators to |
|
1069 | 1071 | # form a single string. They are taken from this dict |
|
1070 | 1072 | self._join_chars = dict(Plain='', Context='\n', Verbose='\n') |
|
1071 | 1073 | # set_mode also sets the tb_join_char attribute |
|
1072 | 1074 | self.set_mode(mode) |
|
1073 | 1075 | |
|
1074 | 1076 | def _extract_tb(self,tb): |
|
1075 | 1077 | if tb: |
|
1076 | 1078 | return traceback.extract_tb(tb) |
|
1077 | 1079 | else: |
|
1078 | 1080 | return None |
|
1079 | 1081 | |
|
1080 | 1082 | def structured_traceback(self, etype, value, tb, tb_offset=None, context=5): |
|
1081 | 1083 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
1082 | 1084 | mode = self.mode |
|
1083 | 1085 | if mode in self.verbose_modes: |
|
1084 | 1086 | # Verbose modes need a full traceback |
|
1085 | 1087 | return VerboseTB.structured_traceback( |
|
1086 | 1088 | self, etype, value, tb, tb_offset, context |
|
1087 | 1089 | ) |
|
1088 | 1090 | else: |
|
1089 | 1091 | # We must check the source cache because otherwise we can print |
|
1090 | 1092 | # out-of-date source code. |
|
1091 | 1093 | self.check_cache() |
|
1092 | 1094 | # Now we can extract and format the exception |
|
1093 | 1095 | elist = self._extract_tb(tb) |
|
1094 | 1096 | return ListTB.structured_traceback( |
|
1095 | 1097 | self, etype, value, elist, tb_offset, context |
|
1096 | 1098 | ) |
|
1097 | 1099 | |
|
1098 | 1100 | def stb2text(self, stb): |
|
1099 | 1101 | """Convert a structured traceback (a list) to a string.""" |
|
1100 | 1102 | return self.tb_join_char.join(stb) |
|
1101 | 1103 | |
|
1102 | 1104 | |
|
1103 | 1105 | def set_mode(self,mode=None): |
|
1104 | 1106 | """Switch to the desired mode. |
|
1105 | 1107 | |
|
1106 | 1108 | If mode is not specified, cycles through the available modes.""" |
|
1107 | 1109 | |
|
1108 | 1110 | if not mode: |
|
1109 | 1111 | new_idx = ( self.valid_modes.index(self.mode) + 1 ) % \ |
|
1110 | 1112 | len(self.valid_modes) |
|
1111 | 1113 | self.mode = self.valid_modes[new_idx] |
|
1112 | 1114 | elif mode not in self.valid_modes: |
|
1113 | 1115 | raise ValueError('Unrecognized mode in FormattedTB: <'+mode+'>\n' |
|
1114 | 1116 | 'Valid modes: '+str(self.valid_modes)) |
|
1115 | 1117 | else: |
|
1116 | 1118 | self.mode = mode |
|
1117 | 1119 | # include variable details only in 'Verbose' mode |
|
1118 | 1120 | self.include_vars = (self.mode == self.valid_modes[2]) |
|
1119 | 1121 | # Set the join character for generating text tracebacks |
|
1120 | 1122 | self.tb_join_char = self._join_chars[self.mode] |
|
1121 | 1123 | |
|
1122 | 1124 | # some convenient shorcuts |
|
1123 | 1125 | def plain(self): |
|
1124 | 1126 | self.set_mode(self.valid_modes[0]) |
|
1125 | 1127 | |
|
1126 | 1128 | def context(self): |
|
1127 | 1129 | self.set_mode(self.valid_modes[1]) |
|
1128 | 1130 | |
|
1129 | 1131 | def verbose(self): |
|
1130 | 1132 | self.set_mode(self.valid_modes[2]) |
|
1131 | 1133 | |
|
1132 | 1134 | #---------------------------------------------------------------------------- |
|
1133 | 1135 | class AutoFormattedTB(FormattedTB): |
|
1134 | 1136 | """A traceback printer which can be called on the fly. |
|
1135 | 1137 | |
|
1136 | 1138 | It will find out about exceptions by itself. |
|
1137 | 1139 | |
|
1138 | 1140 | A brief example:: |
|
1139 | 1141 | |
|
1140 | 1142 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') |
|
1141 | 1143 | try: |
|
1142 | 1144 | ... |
|
1143 | 1145 | except: |
|
1144 | 1146 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object |
|
1145 | 1147 | """ |
|
1146 | 1148 | |
|
1147 | 1149 | def __call__(self,etype=None,evalue=None,etb=None, |
|
1148 | 1150 | out=None,tb_offset=None): |
|
1149 | 1151 | """Print out a formatted exception traceback. |
|
1150 | 1152 | |
|
1151 | 1153 | Optional arguments: |
|
1152 | 1154 | - out: an open file-like object to direct output to. |
|
1153 | 1155 | |
|
1154 | 1156 | - tb_offset: the number of frames to skip over in the stack, on a |
|
1155 | 1157 | per-call basis (this overrides temporarily the instance's tb_offset |
|
1156 | 1158 | given at initialization time. """ |
|
1157 | 1159 | |
|
1158 | 1160 | |
|
1159 | 1161 | if out is None: |
|
1160 | 1162 | out = self.ostream |
|
1161 | 1163 | out.flush() |
|
1162 | 1164 | out.write(self.text(etype, evalue, etb, tb_offset)) |
|
1163 | 1165 | out.write('\n') |
|
1164 | 1166 | out.flush() |
|
1165 | 1167 | # FIXME: we should remove the auto pdb behavior from here and leave |
|
1166 | 1168 | # that to the clients. |
|
1167 | 1169 | try: |
|
1168 | 1170 | self.debugger() |
|
1169 | 1171 | except KeyboardInterrupt: |
|
1170 | 1172 | print("\nKeyboardInterrupt") |
|
1171 | 1173 | |
|
1172 | 1174 | def structured_traceback(self, etype=None, value=None, tb=None, |
|
1173 | 1175 | tb_offset=None, context=5): |
|
1174 | 1176 | if etype is None: |
|
1175 | 1177 | etype,value,tb = sys.exc_info() |
|
1176 | 1178 | self.tb = tb |
|
1177 | 1179 | return FormattedTB.structured_traceback( |
|
1178 | 1180 | self, etype, value, tb, tb_offset, context) |
|
1179 | 1181 | |
|
1180 | 1182 | #--------------------------------------------------------------------------- |
|
1181 | 1183 | |
|
1182 | 1184 | # A simple class to preserve Nathan's original functionality. |
|
1183 | 1185 | class ColorTB(FormattedTB): |
|
1184 | 1186 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" |
|
1185 | 1187 | def __init__(self,color_scheme='Linux',call_pdb=0): |
|
1186 | 1188 | FormattedTB.__init__(self,color_scheme=color_scheme, |
|
1187 | 1189 | call_pdb=call_pdb) |
|
1188 | 1190 | |
|
1189 | 1191 | |
|
1190 | 1192 | class SyntaxTB(ListTB): |
|
1191 | 1193 | """Extension which holds some state: the last exception value""" |
|
1192 | 1194 | |
|
1193 | 1195 | def __init__(self,color_scheme = 'NoColor'): |
|
1194 | 1196 | ListTB.__init__(self,color_scheme) |
|
1195 | 1197 | self.last_syntax_error = None |
|
1196 | 1198 | |
|
1197 | 1199 | def __call__(self, etype, value, elist): |
|
1198 | 1200 | self.last_syntax_error = value |
|
1199 | 1201 | ListTB.__call__(self,etype,value,elist) |
|
1200 | 1202 | |
|
1201 | 1203 | def structured_traceback(self, etype, value, elist, tb_offset=None, |
|
1202 | 1204 | context=5): |
|
1203 | 1205 | # If the source file has been edited, the line in the syntax error can |
|
1204 | 1206 | # be wrong (retrieved from an outdated cache). This replaces it with |
|
1205 | 1207 | # the current value. |
|
1206 | 1208 | if isinstance(value, SyntaxError) \ |
|
1207 | 1209 | and isinstance(value.filename, py3compat.string_types) \ |
|
1208 | 1210 | and isinstance(value.lineno, int): |
|
1209 | 1211 | linecache.checkcache(value.filename) |
|
1210 | 1212 | newtext = ulinecache.getline(value.filename, value.lineno) |
|
1211 | 1213 | if newtext: |
|
1212 | 1214 | value.text = newtext |
|
1213 | 1215 | return super(SyntaxTB, self).structured_traceback(etype, value, elist, |
|
1214 | 1216 | tb_offset=tb_offset, context=context) |
|
1215 | 1217 | |
|
1216 | 1218 | def clear_err_state(self): |
|
1217 | 1219 | """Return the current error state and clear it""" |
|
1218 | 1220 | e = self.last_syntax_error |
|
1219 | 1221 | self.last_syntax_error = None |
|
1220 | 1222 | return e |
|
1221 | 1223 | |
|
1222 | 1224 | def stb2text(self, stb): |
|
1223 | 1225 | """Convert a structured traceback (a list) to a string.""" |
|
1224 | 1226 | return ''.join(stb) |
|
1225 | 1227 | |
|
1226 | 1228 | |
|
1227 | 1229 | #---------------------------------------------------------------------------- |
|
1228 | 1230 | # module testing (minimal) |
|
1229 | 1231 | if __name__ == "__main__": |
|
1230 | 1232 | def spam(c, d_e): |
|
1231 | 1233 | (d, e) = d_e |
|
1232 | 1234 | x = c + d |
|
1233 | 1235 | y = c * d |
|
1234 | 1236 | foo(x, y) |
|
1235 | 1237 | |
|
1236 | 1238 | def foo(a, b, bar=1): |
|
1237 | 1239 | eggs(a, b + bar) |
|
1238 | 1240 | |
|
1239 | 1241 | def eggs(f, g, z=globals()): |
|
1240 | 1242 | h = f + g |
|
1241 | 1243 | i = f - g |
|
1242 | 1244 | return h / i |
|
1243 | 1245 | |
|
1244 | 1246 | print('') |
|
1245 | 1247 | print('*** Before ***') |
|
1246 | 1248 | try: |
|
1247 | 1249 | print(spam(1, (2, 3))) |
|
1248 | 1250 | except: |
|
1249 | 1251 | traceback.print_exc() |
|
1250 | 1252 | print('') |
|
1251 | 1253 | |
|
1252 | 1254 | handler = ColorTB() |
|
1253 | 1255 | print('*** ColorTB ***') |
|
1254 | 1256 | try: |
|
1255 | 1257 | print(spam(1, (2, 3))) |
|
1256 | 1258 | except: |
|
1257 | 1259 | handler(*sys.exc_info()) |
|
1258 | 1260 | print('') |
|
1259 | 1261 | |
|
1260 | 1262 | handler = VerboseTB() |
|
1261 | 1263 | print('*** VerboseTB ***') |
|
1262 | 1264 | try: |
|
1263 | 1265 | print(spam(1, (2, 3))) |
|
1264 | 1266 | except: |
|
1265 | 1267 | handler(*sys.exc_info()) |
|
1266 | 1268 | print('') |
|
1267 | 1269 |
@@ -1,278 +1,281 b'' | |||
|
1 | 1 | """Tornado handlers for the notebooks web service. |
|
2 | 2 | |
|
3 | 3 | Authors: |
|
4 | 4 | |
|
5 | 5 | * Brian Granger |
|
6 | 6 | """ |
|
7 | 7 | |
|
8 | 8 | #----------------------------------------------------------------------------- |
|
9 | 9 | # Copyright (C) 2011 The IPython Development Team |
|
10 | 10 | # |
|
11 | 11 | # Distributed under the terms of the BSD License. The full license is in |
|
12 | 12 | # the file COPYING, distributed as part of this software. |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | # Imports |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | |
|
19 | 19 | import json |
|
20 | 20 | |
|
21 | 21 | from tornado import web |
|
22 | 22 | |
|
23 | 23 | from IPython.html.utils import url_path_join, url_escape |
|
24 | 24 | from IPython.utils.jsonutil import date_default |
|
25 | 25 | |
|
26 | 26 | from IPython.html.base.handlers import IPythonHandler, json_errors |
|
27 | 27 | |
|
28 | 28 | #----------------------------------------------------------------------------- |
|
29 | 29 | # Notebook web service handlers |
|
30 | 30 | #----------------------------------------------------------------------------- |
|
31 | 31 | |
|
32 | 32 | |
|
33 | 33 | class NotebookHandler(IPythonHandler): |
|
34 | 34 | |
|
35 | 35 | SUPPORTED_METHODS = (u'GET', u'PUT', u'PATCH', u'POST', u'DELETE') |
|
36 | 36 | |
|
37 | 37 | def notebook_location(self, name, path=''): |
|
38 | 38 | """Return the full URL location of a notebook based. |
|
39 | 39 | |
|
40 | 40 | Parameters |
|
41 | 41 | ---------- |
|
42 | 42 | name : unicode |
|
43 | 43 | The base name of the notebook, such as "foo.ipynb". |
|
44 | 44 | path : unicode |
|
45 | 45 | The URL path of the notebook. |
|
46 | 46 | """ |
|
47 | 47 | return url_escape(url_path_join( |
|
48 | 48 | self.base_project_url, 'api', 'notebooks', path, name |
|
49 | 49 | )) |
|
50 | 50 | |
|
51 | 51 | def _finish_model(self, model, location=True): |
|
52 | 52 | """Finish a JSON request with a model, setting relevant headers, etc.""" |
|
53 | 53 | if location: |
|
54 | 54 | location = self.notebook_location(model['name'], model['path']) |
|
55 | 55 | self.set_header('Location', location) |
|
56 | 56 | self.set_header('Last-Modified', model['last_modified']) |
|
57 | 57 | self.finish(json.dumps(model, default=date_default)) |
|
58 | 58 | |
|
59 | 59 | @web.authenticated |
|
60 | 60 | @json_errors |
|
61 | 61 | def get(self, path='', name=None): |
|
62 | 62 | """Return a Notebook or list of notebooks. |
|
63 | 63 | |
|
64 | 64 | * GET with path and no notebook name lists notebooks in a directory |
|
65 | 65 | * GET with path and notebook name returns notebook JSON |
|
66 | 66 | """ |
|
67 | 67 | nbm = self.notebook_manager |
|
68 | 68 | # Check to see if a notebook name was given |
|
69 | 69 | if name is None: |
|
70 | 70 | # List notebooks in 'path' |
|
71 | 71 | notebooks = nbm.list_notebooks(path) |
|
72 | 72 | self.finish(json.dumps(notebooks, default=date_default)) |
|
73 | 73 | return |
|
74 | 74 | # get and return notebook representation |
|
75 | 75 | model = nbm.get_notebook_model(name, path) |
|
76 | 76 | self._finish_model(model, location=False) |
|
77 | 77 | |
|
78 | 78 | @web.authenticated |
|
79 | 79 | @json_errors |
|
80 | 80 | def patch(self, path='', name=None): |
|
81 | 81 | """PATCH renames a notebook without re-uploading content.""" |
|
82 | 82 | nbm = self.notebook_manager |
|
83 | 83 | if name is None: |
|
84 | 84 | raise web.HTTPError(400, u'Notebook name missing') |
|
85 | 85 | model = self.get_json_body() |
|
86 | 86 | if model is None: |
|
87 | 87 | raise web.HTTPError(400, u'JSON body missing') |
|
88 | 88 | model = nbm.update_notebook_model(model, name, path) |
|
89 | 89 | self._finish_model(model) |
|
90 | 90 | |
|
91 | 91 | def _copy_notebook(self, copy_from, path, copy_to=None): |
|
92 | 92 | """Copy a notebook in path, optionally specifying the new name. |
|
93 | 93 | |
|
94 | 94 | Only support copying within the same directory. |
|
95 | 95 | """ |
|
96 | 96 | self.log.info(u"Copying notebook from %s/%s to %s/%s", |
|
97 | 97 | path, copy_from, |
|
98 | 98 | path, copy_to or '', |
|
99 | 99 | ) |
|
100 | 100 | model = self.notebook_manager.copy_notebook(copy_from, copy_to, path) |
|
101 | 101 | self.set_status(201) |
|
102 | 102 | self._finish_model(model) |
|
103 | 103 | |
|
104 | 104 | def _upload_notebook(self, model, path, name=None): |
|
105 | 105 | """Upload a notebook |
|
106 | 106 | |
|
107 | 107 | If name specified, create it in path/name. |
|
108 | 108 | """ |
|
109 | 109 | self.log.info(u"Uploading notebook to %s/%s", path, name or '') |
|
110 | 110 | if name: |
|
111 | 111 | model['name'] = name |
|
112 | 112 | |
|
113 | 113 | model = self.notebook_manager.create_notebook_model(model, path) |
|
114 | 114 | self.set_status(201) |
|
115 | 115 | self._finish_model(model) |
|
116 | 116 | |
|
117 | 117 | def _create_empty_notebook(self, path, name=None): |
|
118 | 118 | """Create an empty notebook in path |
|
119 | 119 | |
|
120 | 120 | If name specified, create it in path/name. |
|
121 | 121 | """ |
|
122 | 122 | self.log.info(u"Creating new notebook in %s/%s", path, name or '') |
|
123 | 123 | model = {} |
|
124 | 124 | if name: |
|
125 | 125 | model['name'] = name |
|
126 | 126 | model = self.notebook_manager.create_notebook_model(model, path=path) |
|
127 | 127 | self.set_status(201) |
|
128 | 128 | self._finish_model(model) |
|
129 | 129 | |
|
130 | 130 | def _save_notebook(self, model, path, name): |
|
131 | 131 | """Save an existing notebook.""" |
|
132 | 132 | self.log.info(u"Saving notebook at %s/%s", path, name) |
|
133 | 133 | model = self.notebook_manager.save_notebook_model(model, name, path) |
|
134 | 134 | if model['path'] != path.strip('/') or model['name'] != name: |
|
135 | 135 | # a rename happened, set Location header |
|
136 | 136 | location = True |
|
137 | 137 | else: |
|
138 | 138 | location = False |
|
139 | 139 | self._finish_model(model, location) |
|
140 | 140 | |
|
141 | 141 | @web.authenticated |
|
142 | 142 | @json_errors |
|
143 | 143 | def post(self, path='', name=None): |
|
144 | 144 | """Create a new notebook in the specified path. |
|
145 | 145 | |
|
146 | 146 | POST creates new notebooks. The server always decides on the notebook name. |
|
147 | 147 | |
|
148 |
POST /api/notebooks/path |
|
|
149 | If content specified, upload a notebook, otherwise start empty. | |
|
150 | POST /api/notebooks/path?copy=OtherNotebook.ipynb : new copy of OtherNotebook in path | |
|
148 | POST /api/notebooks/path | |
|
149 | New untitled notebook in path. If content specified, upload a | |
|
150 | notebook, otherwise start empty. | |
|
151 | POST /api/notebooks/path?copy=OtherNotebook.ipynb | |
|
152 | New copy of OtherNotebook in path | |
|
151 | 153 | """ |
|
152 | 154 | |
|
153 | 155 | if name is not None: |
|
154 | 156 | raise web.HTTPError(400, "Only POST to directories. Use PUT for full names.") |
|
155 | 157 | |
|
156 | 158 | model = self.get_json_body() |
|
157 | 159 | |
|
158 | 160 | if model is not None: |
|
159 | 161 | copy_from = model.get('copy_from') |
|
160 | 162 | if copy_from: |
|
161 | 163 | if model.get('content'): |
|
162 | 164 | raise web.HTTPError(400, "Can't upload and copy at the same time.") |
|
163 | 165 | self._copy_notebook(copy_from, path) |
|
164 | 166 | else: |
|
165 | 167 | self._upload_notebook(model, path) |
|
166 | 168 | else: |
|
167 | 169 | self._create_empty_notebook(path) |
|
168 | 170 | |
|
169 | 171 | @web.authenticated |
|
170 | 172 | @json_errors |
|
171 | 173 | def put(self, path='', name=None): |
|
172 | 174 | """Saves the notebook in the location specified by name and path. |
|
173 | 175 | |
|
174 | PUT /api/notebooks/path/Name.ipynb : Save notebook at path/Name.ipynb | |
|
175 | Notebook structure is specified in `content` key of JSON request body. | |
|
176 | If content is not specified, create a new empty notebook. | |
|
177 | PUT /api/notebooks/path/Name.ipynb?copy=OtherNotebook.ipynb : copy OtherNotebook to Name | |
|
176 | PUT is very similar to POST, but the requester specifies the name, | |
|
177 | whereas with POST, the server picks the name. | |
|
178 | 178 | |
|
179 | POST and PUT are basically the same. The only difference: | |
|
180 | ||
|
181 | - with POST, server always picks the name, with PUT the requester does | |
|
179 | PUT /api/notebooks/path/Name.ipynb | |
|
180 | Save notebook at ``path/Name.ipynb``. Notebook structure is specified | |
|
181 | in `content` key of JSON request body. If content is not specified, | |
|
182 | create a new empty notebook. | |
|
183 | PUT /api/notebooks/path/Name.ipynb?copy=OtherNotebook.ipynb | |
|
184 | Copy OtherNotebook to Name | |
|
182 | 185 | """ |
|
183 | 186 | if name is None: |
|
184 | 187 | raise web.HTTPError(400, "Only PUT to full names. Use POST for directories.") |
|
185 | 188 | |
|
186 | 189 | model = self.get_json_body() |
|
187 | 190 | if model: |
|
188 | 191 | copy_from = model.get('copy_from') |
|
189 | 192 | if copy_from: |
|
190 | 193 | if model.get('content'): |
|
191 | 194 | raise web.HTTPError(400, "Can't upload and copy at the same time.") |
|
192 | 195 | self._copy_notebook(copy_from, path, name) |
|
193 | 196 | elif self.notebook_manager.notebook_exists(name, path): |
|
194 | 197 | self._save_notebook(model, path, name) |
|
195 | 198 | else: |
|
196 | 199 | self._upload_notebook(model, path, name) |
|
197 | 200 | else: |
|
198 | 201 | self._create_empty_notebook(path, name) |
|
199 | 202 | |
|
200 | 203 | @web.authenticated |
|
201 | 204 | @json_errors |
|
202 | 205 | def delete(self, path='', name=None): |
|
203 | 206 | """delete the notebook in the given notebook path""" |
|
204 | 207 | nbm = self.notebook_manager |
|
205 | 208 | nbm.delete_notebook_model(name, path) |
|
206 | 209 | self.set_status(204) |
|
207 | 210 | self.finish() |
|
208 | 211 | |
|
209 | 212 | |
|
210 | 213 | class NotebookCheckpointsHandler(IPythonHandler): |
|
211 | 214 | |
|
212 | 215 | SUPPORTED_METHODS = ('GET', 'POST') |
|
213 | 216 | |
|
214 | 217 | @web.authenticated |
|
215 | 218 | @json_errors |
|
216 | 219 | def get(self, path='', name=None): |
|
217 | 220 | """get lists checkpoints for a notebook""" |
|
218 | 221 | nbm = self.notebook_manager |
|
219 | 222 | checkpoints = nbm.list_checkpoints(name, path) |
|
220 | 223 | data = json.dumps(checkpoints, default=date_default) |
|
221 | 224 | self.finish(data) |
|
222 | 225 | |
|
223 | 226 | @web.authenticated |
|
224 | 227 | @json_errors |
|
225 | 228 | def post(self, path='', name=None): |
|
226 | 229 | """post creates a new checkpoint""" |
|
227 | 230 | nbm = self.notebook_manager |
|
228 | 231 | checkpoint = nbm.create_checkpoint(name, path) |
|
229 | 232 | data = json.dumps(checkpoint, default=date_default) |
|
230 | 233 | location = url_path_join(self.base_project_url, 'api/notebooks', |
|
231 | 234 | path, name, 'checkpoints', checkpoint['id']) |
|
232 | 235 | self.set_header('Location', url_escape(location)) |
|
233 | 236 | self.set_status(201) |
|
234 | 237 | self.finish(data) |
|
235 | 238 | |
|
236 | 239 | |
|
237 | 240 | class ModifyNotebookCheckpointsHandler(IPythonHandler): |
|
238 | 241 | |
|
239 | 242 | SUPPORTED_METHODS = ('POST', 'DELETE') |
|
240 | 243 | |
|
241 | 244 | @web.authenticated |
|
242 | 245 | @json_errors |
|
243 | 246 | def post(self, path, name, checkpoint_id): |
|
244 | 247 | """post restores a notebook from a checkpoint""" |
|
245 | 248 | nbm = self.notebook_manager |
|
246 | 249 | nbm.restore_checkpoint(checkpoint_id, name, path) |
|
247 | 250 | self.set_status(204) |
|
248 | 251 | self.finish() |
|
249 | 252 | |
|
250 | 253 | @web.authenticated |
|
251 | 254 | @json_errors |
|
252 | 255 | def delete(self, path, name, checkpoint_id): |
|
253 | 256 | """delete clears a checkpoint for a given notebook""" |
|
254 | 257 | nbm = self.notebook_manager |
|
255 | 258 | nbm.delete_checkpoint(checkpoint_id, name, path) |
|
256 | 259 | self.set_status(204) |
|
257 | 260 | self.finish() |
|
258 | 261 | |
|
259 | 262 | #----------------------------------------------------------------------------- |
|
260 | 263 | # URL to handler mappings |
|
261 | 264 | #----------------------------------------------------------------------------- |
|
262 | 265 | |
|
263 | 266 | |
|
264 | 267 | _path_regex = r"(?P<path>(?:/.*)*)" |
|
265 | 268 | _checkpoint_id_regex = r"(?P<checkpoint_id>[\w-]+)" |
|
266 | 269 | _notebook_name_regex = r"(?P<name>[^/]+\.ipynb)" |
|
267 | 270 | _notebook_path_regex = "%s/%s" % (_path_regex, _notebook_name_regex) |
|
268 | 271 | |
|
269 | 272 | default_handlers = [ |
|
270 | 273 | (r"/api/notebooks%s/checkpoints" % _notebook_path_regex, NotebookCheckpointsHandler), |
|
271 | 274 | (r"/api/notebooks%s/checkpoints/%s" % (_notebook_path_regex, _checkpoint_id_regex), |
|
272 | 275 | ModifyNotebookCheckpointsHandler), |
|
273 | 276 | (r"/api/notebooks%s" % _notebook_path_regex, NotebookHandler), |
|
274 | 277 | (r"/api/notebooks%s" % _path_regex, NotebookHandler), |
|
275 | 278 | ] |
|
276 | 279 | |
|
277 | 280 | |
|
278 | 281 |
@@ -1,649 +1,649 b'' | |||
|
1 | 1 | """Base classes to manage a Client's interaction with a running kernel |
|
2 | 2 | """ |
|
3 | 3 | |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (C) 2013 The IPython Development Team |
|
6 | 6 | # |
|
7 | 7 | # Distributed under the terms of the BSD License. The full license is in |
|
8 | 8 | # the file COPYING, distributed as part of this software. |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | # Imports |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | from __future__ import absolute_import |
|
16 | 16 | |
|
17 | 17 | # Standard library imports |
|
18 | 18 | import atexit |
|
19 | 19 | import errno |
|
20 | 20 | from threading import Thread |
|
21 | 21 | import time |
|
22 | 22 | |
|
23 | 23 | import zmq |
|
24 | 24 | # import ZMQError in top-level namespace, to avoid ugly attribute-error messages |
|
25 | 25 | # during garbage collection of threads at exit: |
|
26 | 26 | from zmq import ZMQError |
|
27 | 27 | from zmq.eventloop import ioloop, zmqstream |
|
28 | 28 | |
|
29 | 29 | # Local imports |
|
30 | 30 | from .channelsabc import ( |
|
31 | 31 | ShellChannelABC, IOPubChannelABC, |
|
32 | 32 | HBChannelABC, StdInChannelABC, |
|
33 | 33 | ) |
|
34 | 34 | from IPython.utils.py3compat import string_types, iteritems |
|
35 | 35 | |
|
36 | 36 | #----------------------------------------------------------------------------- |
|
37 | 37 | # Constants and exceptions |
|
38 | 38 | #----------------------------------------------------------------------------- |
|
39 | 39 | |
|
40 | 40 | class InvalidPortNumber(Exception): |
|
41 | 41 | pass |
|
42 | 42 | |
|
43 | 43 | #----------------------------------------------------------------------------- |
|
44 | 44 | # Utility functions |
|
45 | 45 | #----------------------------------------------------------------------------- |
|
46 | 46 | |
|
47 | 47 | # some utilities to validate message structure, these might get moved elsewhere |
|
48 | 48 | # if they prove to have more generic utility |
|
49 | 49 | |
|
50 | 50 | def validate_string_list(lst): |
|
51 | 51 | """Validate that the input is a list of strings. |
|
52 | 52 | |
|
53 | 53 | Raises ValueError if not.""" |
|
54 | 54 | if not isinstance(lst, list): |
|
55 | 55 | raise ValueError('input %r must be a list' % lst) |
|
56 | 56 | for x in lst: |
|
57 | 57 | if not isinstance(x, string_types): |
|
58 | 58 | raise ValueError('element %r in list must be a string' % x) |
|
59 | 59 | |
|
60 | 60 | |
|
61 | 61 | def validate_string_dict(dct): |
|
62 | 62 | """Validate that the input is a dict with string keys and values. |
|
63 | 63 | |
|
64 | 64 | Raises ValueError if not.""" |
|
65 | 65 | for k,v in iteritems(dct): |
|
66 | 66 | if not isinstance(k, string_types): |
|
67 | 67 | raise ValueError('key %r in dict must be a string' % k) |
|
68 | 68 | if not isinstance(v, string_types): |
|
69 | 69 | raise ValueError('value %r in dict must be a string' % v) |
|
70 | 70 | |
|
71 | 71 | |
|
72 | 72 | #----------------------------------------------------------------------------- |
|
73 | 73 | # ZMQ Socket Channel classes |
|
74 | 74 | #----------------------------------------------------------------------------- |
|
75 | 75 | |
|
76 | 76 | class ZMQSocketChannel(Thread): |
|
77 | 77 | """The base class for the channels that use ZMQ sockets.""" |
|
78 | 78 | context = None |
|
79 | 79 | session = None |
|
80 | 80 | socket = None |
|
81 | 81 | ioloop = None |
|
82 | 82 | stream = None |
|
83 | 83 | _address = None |
|
84 | 84 | _exiting = False |
|
85 | 85 | proxy_methods = [] |
|
86 | 86 | |
|
87 | 87 | def __init__(self, context, session, address): |
|
88 | 88 | """Create a channel. |
|
89 | 89 | |
|
90 | 90 | Parameters |
|
91 | 91 | ---------- |
|
92 | 92 | context : :class:`zmq.Context` |
|
93 | 93 | The ZMQ context to use. |
|
94 | 94 | session : :class:`session.Session` |
|
95 | 95 | The session to use. |
|
96 | 96 | address : zmq url |
|
97 | 97 | Standard (ip, port) tuple that the kernel is listening on. |
|
98 | 98 | """ |
|
99 | 99 | super(ZMQSocketChannel, self).__init__() |
|
100 | 100 | self.daemon = True |
|
101 | 101 | |
|
102 | 102 | self.context = context |
|
103 | 103 | self.session = session |
|
104 | 104 | if isinstance(address, tuple): |
|
105 | 105 | if address[1] == 0: |
|
106 | 106 | message = 'The port number for a channel cannot be 0.' |
|
107 | 107 | raise InvalidPortNumber(message) |
|
108 | 108 | address = "tcp://%s:%i" % address |
|
109 | 109 | self._address = address |
|
110 | 110 | atexit.register(self._notice_exit) |
|
111 | 111 | |
|
112 | 112 | def _notice_exit(self): |
|
113 | 113 | self._exiting = True |
|
114 | 114 | |
|
115 | 115 | def _run_loop(self): |
|
116 | 116 | """Run my loop, ignoring EINTR events in the poller""" |
|
117 | 117 | while True: |
|
118 | 118 | try: |
|
119 | 119 | self.ioloop.start() |
|
120 | 120 | except ZMQError as e: |
|
121 | 121 | if e.errno == errno.EINTR: |
|
122 | 122 | continue |
|
123 | 123 | else: |
|
124 | 124 | raise |
|
125 | 125 | except Exception: |
|
126 | 126 | if self._exiting: |
|
127 | 127 | break |
|
128 | 128 | else: |
|
129 | 129 | raise |
|
130 | 130 | else: |
|
131 | 131 | break |
|
132 | 132 | |
|
133 | 133 | def stop(self): |
|
134 | 134 | """Stop the channel's event loop and join its thread. |
|
135 | 135 | |
|
136 |
This calls :meth |
|
|
136 | This calls :meth:`~threading.Thread.join` and returns when the thread | |
|
137 | 137 | terminates. :class:`RuntimeError` will be raised if |
|
138 |
:meth |
|
|
138 | :meth:`~threading.Thread.start` is called again. | |
|
139 | 139 | """ |
|
140 | 140 | self.join() |
|
141 | 141 | |
|
142 | 142 | @property |
|
143 | 143 | def address(self): |
|
144 | 144 | """Get the channel's address as a zmq url string. |
|
145 | 145 | |
|
146 | 146 | These URLS have the form: 'tcp://127.0.0.1:5555'. |
|
147 | 147 | """ |
|
148 | 148 | return self._address |
|
149 | 149 | |
|
150 | 150 | def _queue_send(self, msg): |
|
151 | 151 | """Queue a message to be sent from the IOLoop's thread. |
|
152 | 152 | |
|
153 | 153 | Parameters |
|
154 | 154 | ---------- |
|
155 | 155 | msg : message to send |
|
156 | 156 | |
|
157 | 157 | This is threadsafe, as it uses IOLoop.add_callback to give the loop's |
|
158 | 158 | thread control of the action. |
|
159 | 159 | """ |
|
160 | 160 | def thread_send(): |
|
161 | 161 | self.session.send(self.stream, msg) |
|
162 | 162 | self.ioloop.add_callback(thread_send) |
|
163 | 163 | |
|
164 | 164 | def _handle_recv(self, msg): |
|
165 | 165 | """Callback for stream.on_recv. |
|
166 | 166 | |
|
167 | 167 | Unpacks message, and calls handlers with it. |
|
168 | 168 | """ |
|
169 | 169 | ident,smsg = self.session.feed_identities(msg) |
|
170 | 170 | self.call_handlers(self.session.unserialize(smsg)) |
|
171 | 171 | |
|
172 | 172 | |
|
173 | 173 | |
|
174 | 174 | class ShellChannel(ZMQSocketChannel): |
|
175 | 175 | """The shell channel for issuing request/replies to the kernel.""" |
|
176 | 176 | |
|
177 | 177 | command_queue = None |
|
178 | 178 | # flag for whether execute requests should be allowed to call raw_input: |
|
179 | 179 | allow_stdin = True |
|
180 | 180 | proxy_methods = [ |
|
181 | 181 | 'execute', |
|
182 | 182 | 'complete', |
|
183 | 183 | 'object_info', |
|
184 | 184 | 'history', |
|
185 | 185 | 'kernel_info', |
|
186 | 186 | 'shutdown', |
|
187 | 187 | ] |
|
188 | 188 | |
|
189 | 189 | def __init__(self, context, session, address): |
|
190 | 190 | super(ShellChannel, self).__init__(context, session, address) |
|
191 | 191 | self.ioloop = ioloop.IOLoop() |
|
192 | 192 | |
|
193 | 193 | def run(self): |
|
194 | 194 | """The thread's main activity. Call start() instead.""" |
|
195 | 195 | self.socket = self.context.socket(zmq.DEALER) |
|
196 | 196 | self.socket.setsockopt(zmq.IDENTITY, self.session.bsession) |
|
197 | 197 | self.socket.connect(self.address) |
|
198 | 198 | self.stream = zmqstream.ZMQStream(self.socket, self.ioloop) |
|
199 | 199 | self.stream.on_recv(self._handle_recv) |
|
200 | 200 | self._run_loop() |
|
201 | 201 | try: |
|
202 | 202 | self.socket.close() |
|
203 | 203 | except: |
|
204 | 204 | pass |
|
205 | 205 | |
|
206 | 206 | def stop(self): |
|
207 | 207 | """Stop the channel's event loop and join its thread.""" |
|
208 | 208 | self.ioloop.stop() |
|
209 | 209 | super(ShellChannel, self).stop() |
|
210 | 210 | |
|
211 | 211 | def call_handlers(self, msg): |
|
212 | 212 | """This method is called in the ioloop thread when a message arrives. |
|
213 | 213 | |
|
214 | 214 | Subclasses should override this method to handle incoming messages. |
|
215 | 215 | It is important to remember that this method is called in the thread |
|
216 | 216 | so that some logic must be done to ensure that the application level |
|
217 | 217 | handlers are called in the application thread. |
|
218 | 218 | """ |
|
219 | 219 | raise NotImplementedError('call_handlers must be defined in a subclass.') |
|
220 | 220 | |
|
221 | 221 | def execute(self, code, silent=False, store_history=True, |
|
222 | 222 | user_variables=None, user_expressions=None, allow_stdin=None): |
|
223 | 223 | """Execute code in the kernel. |
|
224 | 224 | |
|
225 | 225 | Parameters |
|
226 | 226 | ---------- |
|
227 | 227 | code : str |
|
228 | 228 | A string of Python code. |
|
229 | 229 | |
|
230 | 230 | silent : bool, optional (default False) |
|
231 | 231 | If set, the kernel will execute the code as quietly possible, and |
|
232 | 232 | will force store_history to be False. |
|
233 | 233 | |
|
234 | 234 | store_history : bool, optional (default True) |
|
235 | 235 | If set, the kernel will store command history. This is forced |
|
236 | 236 | to be False if silent is True. |
|
237 | 237 | |
|
238 | 238 | user_variables : list, optional |
|
239 | 239 | A list of variable names to pull from the user's namespace. They |
|
240 | 240 | will come back as a dict with these names as keys and their |
|
241 | 241 | :func:`repr` as values. |
|
242 | 242 | |
|
243 | 243 | user_expressions : dict, optional |
|
244 | 244 | A dict mapping names to expressions to be evaluated in the user's |
|
245 | 245 | dict. The expression values are returned as strings formatted using |
|
246 | 246 | :func:`repr`. |
|
247 | 247 | |
|
248 | 248 | allow_stdin : bool, optional (default self.allow_stdin) |
|
249 | 249 | Flag for whether the kernel can send stdin requests to frontends. |
|
250 | 250 | |
|
251 | 251 | Some frontends (e.g. the Notebook) do not support stdin requests. |
|
252 | 252 | If raw_input is called from code executed from such a frontend, a |
|
253 | 253 | StdinNotImplementedError will be raised. |
|
254 | 254 | |
|
255 | 255 | Returns |
|
256 | 256 | ------- |
|
257 | 257 | The msg_id of the message sent. |
|
258 | 258 | """ |
|
259 | 259 | if user_variables is None: |
|
260 | 260 | user_variables = [] |
|
261 | 261 | if user_expressions is None: |
|
262 | 262 | user_expressions = {} |
|
263 | 263 | if allow_stdin is None: |
|
264 | 264 | allow_stdin = self.allow_stdin |
|
265 | 265 | |
|
266 | 266 | |
|
267 | 267 | # Don't waste network traffic if inputs are invalid |
|
268 | 268 | if not isinstance(code, string_types): |
|
269 | 269 | raise ValueError('code %r must be a string' % code) |
|
270 | 270 | validate_string_list(user_variables) |
|
271 | 271 | validate_string_dict(user_expressions) |
|
272 | 272 | |
|
273 | 273 | # Create class for content/msg creation. Related to, but possibly |
|
274 | 274 | # not in Session. |
|
275 | 275 | content = dict(code=code, silent=silent, store_history=store_history, |
|
276 | 276 | user_variables=user_variables, |
|
277 | 277 | user_expressions=user_expressions, |
|
278 | 278 | allow_stdin=allow_stdin, |
|
279 | 279 | ) |
|
280 | 280 | msg = self.session.msg('execute_request', content) |
|
281 | 281 | self._queue_send(msg) |
|
282 | 282 | return msg['header']['msg_id'] |
|
283 | 283 | |
|
284 | 284 | def complete(self, text, line, cursor_pos, block=None): |
|
285 | 285 | """Tab complete text in the kernel's namespace. |
|
286 | 286 | |
|
287 | 287 | Parameters |
|
288 | 288 | ---------- |
|
289 | 289 | text : str |
|
290 | 290 | The text to complete. |
|
291 | 291 | line : str |
|
292 | 292 | The full line of text that is the surrounding context for the |
|
293 | 293 | text to complete. |
|
294 | 294 | cursor_pos : int |
|
295 | 295 | The position of the cursor in the line where the completion was |
|
296 | 296 | requested. |
|
297 | 297 | block : str, optional |
|
298 | 298 | The full block of code in which the completion is being requested. |
|
299 | 299 | |
|
300 | 300 | Returns |
|
301 | 301 | ------- |
|
302 | 302 | The msg_id of the message sent. |
|
303 | 303 | """ |
|
304 | 304 | content = dict(text=text, line=line, block=block, cursor_pos=cursor_pos) |
|
305 | 305 | msg = self.session.msg('complete_request', content) |
|
306 | 306 | self._queue_send(msg) |
|
307 | 307 | return msg['header']['msg_id'] |
|
308 | 308 | |
|
309 | 309 | def object_info(self, oname, detail_level=0): |
|
310 | 310 | """Get metadata information about an object in the kernel's namespace. |
|
311 | 311 | |
|
312 | 312 | Parameters |
|
313 | 313 | ---------- |
|
314 | 314 | oname : str |
|
315 | 315 | A string specifying the object name. |
|
316 | 316 | detail_level : int, optional |
|
317 | 317 | The level of detail for the introspection (0-2) |
|
318 | 318 | |
|
319 | 319 | Returns |
|
320 | 320 | ------- |
|
321 | 321 | The msg_id of the message sent. |
|
322 | 322 | """ |
|
323 | 323 | content = dict(oname=oname, detail_level=detail_level) |
|
324 | 324 | msg = self.session.msg('object_info_request', content) |
|
325 | 325 | self._queue_send(msg) |
|
326 | 326 | return msg['header']['msg_id'] |
|
327 | 327 | |
|
328 | 328 | def history(self, raw=True, output=False, hist_access_type='range', **kwargs): |
|
329 | 329 | """Get entries from the kernel's history list. |
|
330 | 330 | |
|
331 | 331 | Parameters |
|
332 | 332 | ---------- |
|
333 | 333 | raw : bool |
|
334 | 334 | If True, return the raw input. |
|
335 | 335 | output : bool |
|
336 | 336 | If True, then return the output as well. |
|
337 | 337 | hist_access_type : str |
|
338 | 338 | 'range' (fill in session, start and stop params), 'tail' (fill in n) |
|
339 | 339 | or 'search' (fill in pattern param). |
|
340 | 340 | |
|
341 | 341 | session : int |
|
342 | 342 | For a range request, the session from which to get lines. Session |
|
343 | 343 | numbers are positive integers; negative ones count back from the |
|
344 | 344 | current session. |
|
345 | 345 | start : int |
|
346 | 346 | The first line number of a history range. |
|
347 | 347 | stop : int |
|
348 | 348 | The final (excluded) line number of a history range. |
|
349 | 349 | |
|
350 | 350 | n : int |
|
351 | 351 | The number of lines of history to get for a tail request. |
|
352 | 352 | |
|
353 | 353 | pattern : str |
|
354 | 354 | The glob-syntax pattern for a search request. |
|
355 | 355 | |
|
356 | 356 | Returns |
|
357 | 357 | ------- |
|
358 | 358 | The msg_id of the message sent. |
|
359 | 359 | """ |
|
360 | 360 | content = dict(raw=raw, output=output, hist_access_type=hist_access_type, |
|
361 | 361 | **kwargs) |
|
362 | 362 | msg = self.session.msg('history_request', content) |
|
363 | 363 | self._queue_send(msg) |
|
364 | 364 | return msg['header']['msg_id'] |
|
365 | 365 | |
|
366 | 366 | def kernel_info(self): |
|
367 | 367 | """Request kernel info.""" |
|
368 | 368 | msg = self.session.msg('kernel_info_request') |
|
369 | 369 | self._queue_send(msg) |
|
370 | 370 | return msg['header']['msg_id'] |
|
371 | 371 | |
|
372 | 372 | def shutdown(self, restart=False): |
|
373 | 373 | """Request an immediate kernel shutdown. |
|
374 | 374 | |
|
375 | 375 | Upon receipt of the (empty) reply, client code can safely assume that |
|
376 | 376 | the kernel has shut down and it's safe to forcefully terminate it if |
|
377 | 377 | it's still alive. |
|
378 | 378 | |
|
379 | 379 | The kernel will send the reply via a function registered with Python's |
|
380 | 380 | atexit module, ensuring it's truly done as the kernel is done with all |
|
381 | 381 | normal operation. |
|
382 | 382 | """ |
|
383 | 383 | # Send quit message to kernel. Once we implement kernel-side setattr, |
|
384 | 384 | # this should probably be done that way, but for now this will do. |
|
385 | 385 | msg = self.session.msg('shutdown_request', {'restart':restart}) |
|
386 | 386 | self._queue_send(msg) |
|
387 | 387 | return msg['header']['msg_id'] |
|
388 | 388 | |
|
389 | 389 | |
|
390 | 390 | |
|
391 | 391 | class IOPubChannel(ZMQSocketChannel): |
|
392 | 392 | """The iopub channel which listens for messages that the kernel publishes. |
|
393 | 393 | |
|
394 | 394 | This channel is where all output is published to frontends. |
|
395 | 395 | """ |
|
396 | 396 | |
|
397 | 397 | def __init__(self, context, session, address): |
|
398 | 398 | super(IOPubChannel, self).__init__(context, session, address) |
|
399 | 399 | self.ioloop = ioloop.IOLoop() |
|
400 | 400 | |
|
401 | 401 | def run(self): |
|
402 | 402 | """The thread's main activity. Call start() instead.""" |
|
403 | 403 | self.socket = self.context.socket(zmq.SUB) |
|
404 | 404 | self.socket.setsockopt(zmq.SUBSCRIBE,b'') |
|
405 | 405 | self.socket.setsockopt(zmq.IDENTITY, self.session.bsession) |
|
406 | 406 | self.socket.connect(self.address) |
|
407 | 407 | self.stream = zmqstream.ZMQStream(self.socket, self.ioloop) |
|
408 | 408 | self.stream.on_recv(self._handle_recv) |
|
409 | 409 | self._run_loop() |
|
410 | 410 | try: |
|
411 | 411 | self.socket.close() |
|
412 | 412 | except: |
|
413 | 413 | pass |
|
414 | 414 | |
|
415 | 415 | def stop(self): |
|
416 | 416 | """Stop the channel's event loop and join its thread.""" |
|
417 | 417 | self.ioloop.stop() |
|
418 | 418 | super(IOPubChannel, self).stop() |
|
419 | 419 | |
|
420 | 420 | def call_handlers(self, msg): |
|
421 | 421 | """This method is called in the ioloop thread when a message arrives. |
|
422 | 422 | |
|
423 | 423 | Subclasses should override this method to handle incoming messages. |
|
424 | 424 | It is important to remember that this method is called in the thread |
|
425 | 425 | so that some logic must be done to ensure that the application leve |
|
426 | 426 | handlers are called in the application thread. |
|
427 | 427 | """ |
|
428 | 428 | raise NotImplementedError('call_handlers must be defined in a subclass.') |
|
429 | 429 | |
|
430 | 430 | def flush(self, timeout=1.0): |
|
431 | 431 | """Immediately processes all pending messages on the iopub channel. |
|
432 | 432 | |
|
433 |
Callers should use this method to ensure that :meth |
|
|
433 | Callers should use this method to ensure that :meth:`call_handlers` | |
|
434 | 434 | has been called for all messages that have been received on the |
|
435 | 435 | 0MQ SUB socket of this channel. |
|
436 | 436 | |
|
437 | 437 | This method is thread safe. |
|
438 | 438 | |
|
439 | 439 | Parameters |
|
440 | 440 | ---------- |
|
441 | 441 | timeout : float, optional |
|
442 | 442 | The maximum amount of time to spend flushing, in seconds. The |
|
443 | 443 | default is one second. |
|
444 | 444 | """ |
|
445 | 445 | # We do the IOLoop callback process twice to ensure that the IOLoop |
|
446 | 446 | # gets to perform at least one full poll. |
|
447 | 447 | stop_time = time.time() + timeout |
|
448 | 448 | for i in range(2): |
|
449 | 449 | self._flushed = False |
|
450 | 450 | self.ioloop.add_callback(self._flush) |
|
451 | 451 | while not self._flushed and time.time() < stop_time: |
|
452 | 452 | time.sleep(0.01) |
|
453 | 453 | |
|
454 | 454 | def _flush(self): |
|
455 | 455 | """Callback for :method:`self.flush`.""" |
|
456 | 456 | self.stream.flush() |
|
457 | 457 | self._flushed = True |
|
458 | 458 | |
|
459 | 459 | |
|
460 | 460 | class StdInChannel(ZMQSocketChannel): |
|
461 | 461 | """The stdin channel to handle raw_input requests that the kernel makes.""" |
|
462 | 462 | |
|
463 | 463 | msg_queue = None |
|
464 | 464 | proxy_methods = ['input'] |
|
465 | 465 | |
|
466 | 466 | def __init__(self, context, session, address): |
|
467 | 467 | super(StdInChannel, self).__init__(context, session, address) |
|
468 | 468 | self.ioloop = ioloop.IOLoop() |
|
469 | 469 | |
|
470 | 470 | def run(self): |
|
471 | 471 | """The thread's main activity. Call start() instead.""" |
|
472 | 472 | self.socket = self.context.socket(zmq.DEALER) |
|
473 | 473 | self.socket.setsockopt(zmq.IDENTITY, self.session.bsession) |
|
474 | 474 | self.socket.connect(self.address) |
|
475 | 475 | self.stream = zmqstream.ZMQStream(self.socket, self.ioloop) |
|
476 | 476 | self.stream.on_recv(self._handle_recv) |
|
477 | 477 | self._run_loop() |
|
478 | 478 | try: |
|
479 | 479 | self.socket.close() |
|
480 | 480 | except: |
|
481 | 481 | pass |
|
482 | 482 | |
|
483 | 483 | def stop(self): |
|
484 | 484 | """Stop the channel's event loop and join its thread.""" |
|
485 | 485 | self.ioloop.stop() |
|
486 | 486 | super(StdInChannel, self).stop() |
|
487 | 487 | |
|
488 | 488 | def call_handlers(self, msg): |
|
489 | 489 | """This method is called in the ioloop thread when a message arrives. |
|
490 | 490 | |
|
491 | 491 | Subclasses should override this method to handle incoming messages. |
|
492 | 492 | It is important to remember that this method is called in the thread |
|
493 | 493 | so that some logic must be done to ensure that the application leve |
|
494 | 494 | handlers are called in the application thread. |
|
495 | 495 | """ |
|
496 | 496 | raise NotImplementedError('call_handlers must be defined in a subclass.') |
|
497 | 497 | |
|
498 | 498 | def input(self, string): |
|
499 | 499 | """Send a string of raw input to the kernel.""" |
|
500 | 500 | content = dict(value=string) |
|
501 | 501 | msg = self.session.msg('input_reply', content) |
|
502 | 502 | self._queue_send(msg) |
|
503 | 503 | |
|
504 | 504 | |
|
505 | 505 | class HBChannel(ZMQSocketChannel): |
|
506 | 506 | """The heartbeat channel which monitors the kernel heartbeat. |
|
507 | 507 | |
|
508 | 508 | Note that the heartbeat channel is paused by default. As long as you start |
|
509 | 509 | this channel, the kernel manager will ensure that it is paused and un-paused |
|
510 | 510 | as appropriate. |
|
511 | 511 | """ |
|
512 | 512 | |
|
513 | 513 | time_to_dead = 3.0 |
|
514 | 514 | socket = None |
|
515 | 515 | poller = None |
|
516 | 516 | _running = None |
|
517 | 517 | _pause = None |
|
518 | 518 | _beating = None |
|
519 | 519 | |
|
520 | 520 | def __init__(self, context, session, address): |
|
521 | 521 | super(HBChannel, self).__init__(context, session, address) |
|
522 | 522 | self._running = False |
|
523 | 523 | self._pause =True |
|
524 | 524 | self.poller = zmq.Poller() |
|
525 | 525 | |
|
526 | 526 | def _create_socket(self): |
|
527 | 527 | if self.socket is not None: |
|
528 | 528 | # close previous socket, before opening a new one |
|
529 | 529 | self.poller.unregister(self.socket) |
|
530 | 530 | self.socket.close() |
|
531 | 531 | self.socket = self.context.socket(zmq.REQ) |
|
532 | 532 | self.socket.setsockopt(zmq.LINGER, 0) |
|
533 | 533 | self.socket.connect(self.address) |
|
534 | 534 | |
|
535 | 535 | self.poller.register(self.socket, zmq.POLLIN) |
|
536 | 536 | |
|
537 | 537 | def _poll(self, start_time): |
|
538 | 538 | """poll for heartbeat replies until we reach self.time_to_dead. |
|
539 | 539 | |
|
540 | 540 | Ignores interrupts, and returns the result of poll(), which |
|
541 | 541 | will be an empty list if no messages arrived before the timeout, |
|
542 | 542 | or the event tuple if there is a message to receive. |
|
543 | 543 | """ |
|
544 | 544 | |
|
545 | 545 | until_dead = self.time_to_dead - (time.time() - start_time) |
|
546 | 546 | # ensure poll at least once |
|
547 | 547 | until_dead = max(until_dead, 1e-3) |
|
548 | 548 | events = [] |
|
549 | 549 | while True: |
|
550 | 550 | try: |
|
551 | 551 | events = self.poller.poll(1000 * until_dead) |
|
552 | 552 | except ZMQError as e: |
|
553 | 553 | if e.errno == errno.EINTR: |
|
554 | 554 | # ignore interrupts during heartbeat |
|
555 | 555 | # this may never actually happen |
|
556 | 556 | until_dead = self.time_to_dead - (time.time() - start_time) |
|
557 | 557 | until_dead = max(until_dead, 1e-3) |
|
558 | 558 | pass |
|
559 | 559 | else: |
|
560 | 560 | raise |
|
561 | 561 | except Exception: |
|
562 | 562 | if self._exiting: |
|
563 | 563 | break |
|
564 | 564 | else: |
|
565 | 565 | raise |
|
566 | 566 | else: |
|
567 | 567 | break |
|
568 | 568 | return events |
|
569 | 569 | |
|
570 | 570 | def run(self): |
|
571 | 571 | """The thread's main activity. Call start() instead.""" |
|
572 | 572 | self._create_socket() |
|
573 | 573 | self._running = True |
|
574 | 574 | self._beating = True |
|
575 | 575 | |
|
576 | 576 | while self._running: |
|
577 | 577 | if self._pause: |
|
578 | 578 | # just sleep, and skip the rest of the loop |
|
579 | 579 | time.sleep(self.time_to_dead) |
|
580 | 580 | continue |
|
581 | 581 | |
|
582 | 582 | since_last_heartbeat = 0.0 |
|
583 | 583 | # io.rprint('Ping from HB channel') # dbg |
|
584 | 584 | # no need to catch EFSM here, because the previous event was |
|
585 | 585 | # either a recv or connect, which cannot be followed by EFSM |
|
586 | 586 | self.socket.send(b'ping') |
|
587 | 587 | request_time = time.time() |
|
588 | 588 | ready = self._poll(request_time) |
|
589 | 589 | if ready: |
|
590 | 590 | self._beating = True |
|
591 | 591 | # the poll above guarantees we have something to recv |
|
592 | 592 | self.socket.recv() |
|
593 | 593 | # sleep the remainder of the cycle |
|
594 | 594 | remainder = self.time_to_dead - (time.time() - request_time) |
|
595 | 595 | if remainder > 0: |
|
596 | 596 | time.sleep(remainder) |
|
597 | 597 | continue |
|
598 | 598 | else: |
|
599 | 599 | # nothing was received within the time limit, signal heart failure |
|
600 | 600 | self._beating = False |
|
601 | 601 | since_last_heartbeat = time.time() - request_time |
|
602 | 602 | self.call_handlers(since_last_heartbeat) |
|
603 | 603 | # and close/reopen the socket, because the REQ/REP cycle has been broken |
|
604 | 604 | self._create_socket() |
|
605 | 605 | continue |
|
606 | 606 | try: |
|
607 | 607 | self.socket.close() |
|
608 | 608 | except: |
|
609 | 609 | pass |
|
610 | 610 | |
|
611 | 611 | def pause(self): |
|
612 | 612 | """Pause the heartbeat.""" |
|
613 | 613 | self._pause = True |
|
614 | 614 | |
|
615 | 615 | def unpause(self): |
|
616 | 616 | """Unpause the heartbeat.""" |
|
617 | 617 | self._pause = False |
|
618 | 618 | |
|
619 | 619 | def is_beating(self): |
|
620 | 620 | """Is the heartbeat running and responsive (and not paused).""" |
|
621 | 621 | if self.is_alive() and not self._pause and self._beating: |
|
622 | 622 | return True |
|
623 | 623 | else: |
|
624 | 624 | return False |
|
625 | 625 | |
|
626 | 626 | def stop(self): |
|
627 | 627 | """Stop the channel's event loop and join its thread.""" |
|
628 | 628 | self._running = False |
|
629 | 629 | super(HBChannel, self).stop() |
|
630 | 630 | |
|
631 | 631 | def call_handlers(self, since_last_heartbeat): |
|
632 | 632 | """This method is called in the ioloop thread when a message arrives. |
|
633 | 633 | |
|
634 | 634 | Subclasses should override this method to handle incoming messages. |
|
635 | 635 | It is important to remember that this method is called in the thread |
|
636 | 636 | so that some logic must be done to ensure that the application level |
|
637 | 637 | handlers are called in the application thread. |
|
638 | 638 | """ |
|
639 | 639 | raise NotImplementedError('call_handlers must be defined in a subclass.') |
|
640 | 640 | |
|
641 | 641 | |
|
642 | 642 | #---------------------------------------------------------------------#----------------------------------------------------------------------------- |
|
643 | 643 | # ABC Registration |
|
644 | 644 | #----------------------------------------------------------------------------- |
|
645 | 645 | |
|
646 | 646 | ShellChannelABC.register(ShellChannel) |
|
647 | 647 | IOPubChannelABC.register(IOPubChannel) |
|
648 | 648 | HBChannelABC.register(HBChannel) |
|
649 | 649 | StdInChannelABC.register(StdInChannel) |
@@ -1,118 +1,116 b'' | |||
|
1 | 1 | """ |
|
2 | 2 | Password generation for the IPython notebook. |
|
3 | 3 | """ |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Imports |
|
6 | 6 | #----------------------------------------------------------------------------- |
|
7 | 7 | # Stdlib |
|
8 | 8 | import getpass |
|
9 | 9 | import hashlib |
|
10 | 10 | import random |
|
11 | 11 | |
|
12 | 12 | # Our own |
|
13 | 13 | from IPython.core.error import UsageError |
|
14 | 14 | from IPython.testing.skipdoctest import skip_doctest |
|
15 | 15 | from IPython.utils.py3compat import cast_bytes, str_to_bytes |
|
16 | 16 | |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | # Globals |
|
19 | 19 | #----------------------------------------------------------------------------- |
|
20 | 20 | |
|
21 | 21 | # Length of the salt in nr of hex chars, which implies salt_len * 4 |
|
22 | 22 | # bits of randomness. |
|
23 | 23 | salt_len = 12 |
|
24 | 24 | |
|
25 | 25 | #----------------------------------------------------------------------------- |
|
26 | 26 | # Functions |
|
27 | 27 | #----------------------------------------------------------------------------- |
|
28 | 28 | |
|
29 | 29 | @skip_doctest |
|
30 | 30 | def passwd(passphrase=None, algorithm='sha1'): |
|
31 | 31 | """Generate hashed password and salt for use in notebook configuration. |
|
32 | 32 | |
|
33 | 33 | In the notebook configuration, set `c.NotebookApp.password` to |
|
34 | 34 | the generated string. |
|
35 | 35 | |
|
36 | 36 | Parameters |
|
37 | 37 | ---------- |
|
38 | 38 | passphrase : str |
|
39 | 39 | Password to hash. If unspecified, the user is asked to input |
|
40 | 40 | and verify a password. |
|
41 | 41 | algorithm : str |
|
42 | 42 | Hashing algorithm to use (e.g, 'sha1' or any argument supported |
|
43 | 43 | by :func:`hashlib.new`). |
|
44 | 44 | |
|
45 | 45 | Returns |
|
46 | 46 | ------- |
|
47 | 47 | hashed_passphrase : str |
|
48 | 48 | Hashed password, in the format 'hash_algorithm:salt:passphrase_hash'. |
|
49 | 49 | |
|
50 | 50 | Examples |
|
51 | 51 | -------- |
|
52 |
|
|
|
53 |
|
|
|
52 | >>> passwd('mypassword') | |
|
53 | 'sha1:7cf3:b7d6da294ea9592a9480c8f52e63cd42cfb9dd12' | |
|
54 | 54 | |
|
55 | 55 | """ |
|
56 | 56 | if passphrase is None: |
|
57 | 57 | for i in range(3): |
|
58 | 58 | p0 = getpass.getpass('Enter password: ') |
|
59 | 59 | p1 = getpass.getpass('Verify password: ') |
|
60 | 60 | if p0 == p1: |
|
61 | 61 | passphrase = p0 |
|
62 | 62 | break |
|
63 | 63 | else: |
|
64 | 64 | print('Passwords do not match.') |
|
65 | 65 | else: |
|
66 | 66 | raise UsageError('No matching passwords found. Giving up.') |
|
67 | 67 | |
|
68 | 68 | h = hashlib.new(algorithm) |
|
69 | 69 | salt = ('%0' + str(salt_len) + 'x') % random.getrandbits(4 * salt_len) |
|
70 | 70 | h.update(cast_bytes(passphrase, 'utf-8') + str_to_bytes(salt, 'ascii')) |
|
71 | 71 | |
|
72 | 72 | return ':'.join((algorithm, salt, h.hexdigest())) |
|
73 | 73 | |
|
74 | 74 | |
|
75 | 75 | def passwd_check(hashed_passphrase, passphrase): |
|
76 | 76 | """Verify that a given passphrase matches its hashed version. |
|
77 | 77 | |
|
78 | 78 | Parameters |
|
79 | 79 | ---------- |
|
80 | 80 | hashed_passphrase : str |
|
81 | 81 | Hashed password, in the format returned by `passwd`. |
|
82 | 82 | passphrase : str |
|
83 | 83 | Passphrase to validate. |
|
84 | 84 | |
|
85 | 85 | Returns |
|
86 | 86 | ------- |
|
87 | 87 | valid : bool |
|
88 | 88 | True if the passphrase matches the hash. |
|
89 | 89 | |
|
90 | 90 | Examples |
|
91 | 91 | -------- |
|
92 |
|
|
|
93 | ||
|
94 | In [2]: passwd_check('sha1:0e112c3ddfce:a68df677475c2b47b6e86d0467eec97ac5f4b85a', | |
|
95 | ...: 'mypassword') | |
|
96 | Out[2]: True | |
|
97 | ||
|
98 | In [3]: passwd_check('sha1:0e112c3ddfce:a68df677475c2b47b6e86d0467eec97ac5f4b85a', | |
|
99 | ...: 'anotherpassword') | |
|
100 | Out[3]: False | |
|
101 | ||
|
92 | >>> from IPython.lib.security import passwd_check | |
|
93 | >>> passwd_check('sha1:0e112c3ddfce:a68df677475c2b47b6e86d0467eec97ac5f4b85a', | |
|
94 | ... 'mypassword') | |
|
95 | True | |
|
96 | ||
|
97 | >>> passwd_check('sha1:0e112c3ddfce:a68df677475c2b47b6e86d0467eec97ac5f4b85a', | |
|
98 | ... 'anotherpassword') | |
|
99 | False | |
|
102 | 100 | """ |
|
103 | 101 | try: |
|
104 | 102 | algorithm, salt, pw_digest = hashed_passphrase.split(':', 2) |
|
105 | 103 | except (ValueError, TypeError): |
|
106 | 104 | return False |
|
107 | 105 | |
|
108 | 106 | try: |
|
109 | 107 | h = hashlib.new(algorithm) |
|
110 | 108 | except ValueError: |
|
111 | 109 | return False |
|
112 | 110 | |
|
113 | 111 | if len(pw_digest) == 0: |
|
114 | 112 | return False |
|
115 | 113 | |
|
116 | 114 | h.update(cast_bytes(passphrase, 'utf-8') + cast_bytes(salt, 'ascii')) |
|
117 | 115 | |
|
118 | 116 | return h.hexdigest() == pw_digest |
@@ -1,171 +1,179 b'' | |||
|
1 | 1 | """ |
|
2 | 2 | Module containing single call export functions. |
|
3 | 3 | """ |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (c) 2013, the IPython Development Team. |
|
6 | 6 | # |
|
7 | 7 | # Distributed under the terms of the Modified BSD License. |
|
8 | 8 | # |
|
9 | 9 | # The full license is in the file COPYING.txt, distributed with this software. |
|
10 | 10 | #----------------------------------------------------------------------------- |
|
11 | 11 | |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | # Imports |
|
14 | 14 | #----------------------------------------------------------------------------- |
|
15 | 15 | |
|
16 | 16 | from functools import wraps |
|
17 | 17 | |
|
18 | 18 | from IPython.nbformat.v3.nbbase import NotebookNode |
|
19 |
from IPython. |
|
|
19 | from IPython.utils.decorators import undoc | |
|
20 | 20 | from IPython.utils.py3compat import string_types |
|
21 | 21 | |
|
22 | 22 | from .exporter import Exporter |
|
23 | 23 | from .templateexporter import TemplateExporter |
|
24 | 24 | from .html import HTMLExporter |
|
25 | 25 | from .slides import SlidesExporter |
|
26 | 26 | from .latex import LatexExporter |
|
27 | 27 | from .markdown import MarkdownExporter |
|
28 | 28 | from .python import PythonExporter |
|
29 | 29 | from .rst import RSTExporter |
|
30 | 30 | |
|
31 | 31 | #----------------------------------------------------------------------------- |
|
32 | 32 | # Classes |
|
33 | 33 | #----------------------------------------------------------------------------- |
|
34 | 34 | |
|
35 | @undoc | |
|
35 | 36 | def DocDecorator(f): |
|
36 | 37 | |
|
37 | 38 | #Set docstring of function |
|
38 | 39 | f.__doc__ = f.__doc__ + """ |
|
39 | nb : Notebook node | |
|
40 | nb : :class:`~IPython.nbformat.v3.nbbase.NotebookNode` | |
|
41 | The notebook to export. | |
|
40 | 42 | config : config (optional, keyword arg) |
|
41 | 43 | User configuration instance. |
|
42 | 44 | resources : dict (optional, keyword arg) |
|
43 | 45 | Resources used in the conversion process. |
|
44 | 46 | |
|
45 | 47 | Returns |
|
46 |
------- |
|
|
48 | ------- | |
|
47 | 49 | tuple- output, resources, exporter_instance |
|
48 | 50 | output : str |
|
49 | 51 | Jinja 2 output. This is the resulting converted notebook. |
|
50 | 52 | resources : dictionary |
|
51 | 53 | Dictionary of resources used prior to and during the conversion |
|
52 | 54 | process. |
|
53 | 55 | exporter_instance : Exporter |
|
54 | 56 | Instance of the Exporter class used to export the document. Useful |
|
55 | 57 | to caller because it provides a 'file_extension' property which |
|
56 | 58 | specifies what extension the output should be saved as. |
|
57 | 59 | |
|
60 | Notes | |
|
61 | ----- | |
|
58 | 62 | WARNING: API WILL CHANGE IN FUTURE RELEASES OF NBCONVERT |
|
59 | 63 | """ |
|
60 | 64 | |
|
61 | 65 | @wraps(f) |
|
62 | 66 | def decorator(*args, **kwargs): |
|
63 | 67 | return f(*args, **kwargs) |
|
64 | 68 | |
|
65 | 69 | return decorator |
|
66 | 70 | |
|
67 | 71 | |
|
68 | 72 | #----------------------------------------------------------------------------- |
|
69 | 73 | # Functions |
|
70 | 74 | #----------------------------------------------------------------------------- |
|
71 | 75 | |
|
72 | 76 | __all__ = [ |
|
73 | 77 | 'export', |
|
74 | 78 | 'export_html', |
|
75 | 79 | 'export_custom', |
|
76 | 80 | 'export_slides', |
|
77 | 81 | 'export_latex', |
|
78 | 82 | 'export_markdown', |
|
79 | 83 | 'export_python', |
|
80 | 84 | 'export_rst', |
|
81 | 85 | 'export_by_name', |
|
82 | 86 | 'get_export_names', |
|
83 | 87 | 'ExporterNameError' |
|
84 | 88 | ] |
|
85 | 89 | |
|
86 | 90 | |
|
87 | 91 | class ExporterNameError(NameError): |
|
88 | 92 | pass |
|
89 | 93 | |
|
90 | 94 | @DocDecorator |
|
91 | 95 | def export(exporter, nb, **kw): |
|
92 | 96 | """ |
|
93 | 97 | Export a notebook object using specific exporter class. |
|
94 | 98 | |
|
95 | exporter : Exporter class type or instance | |
|
96 | Class type or instance of the exporter that should be used. If the | |
|
97 | method initializes it's own instance of the class, it is ASSUMED that | |
|
98 | the class type provided exposes a constructor (__init__) with the same | |
|
99 | signature as the base Exporter class. | |
|
99 | Parameters | |
|
100 | ---------- | |
|
101 | exporter : class:`~IPython.nbconvert.exporters.exporter.Exporter` class or instance | |
|
102 | Class type or instance of the exporter that should be used. If the | |
|
103 | method initializes it's own instance of the class, it is ASSUMED that | |
|
104 | the class type provided exposes a constructor (``__init__``) with the same | |
|
105 | signature as the base Exporter class. | |
|
100 | 106 | """ |
|
101 | 107 | |
|
102 | 108 | #Check arguments |
|
103 | 109 | if exporter is None: |
|
104 | 110 | raise TypeError("Exporter is None") |
|
105 | 111 | elif not isinstance(exporter, Exporter) and not issubclass(exporter, Exporter): |
|
106 | 112 | raise TypeError("exporter does not inherit from Exporter (base)") |
|
107 | 113 | if nb is None: |
|
108 | 114 | raise TypeError("nb is None") |
|
109 | 115 | |
|
110 | 116 | #Create the exporter |
|
111 | 117 | resources = kw.pop('resources', None) |
|
112 | 118 | if isinstance(exporter, Exporter): |
|
113 | 119 | exporter_instance = exporter |
|
114 | 120 | else: |
|
115 | 121 | exporter_instance = exporter(**kw) |
|
116 | 122 | |
|
117 | 123 | #Try to convert the notebook using the appropriate conversion function. |
|
118 | 124 | if isinstance(nb, NotebookNode): |
|
119 | 125 | output, resources = exporter_instance.from_notebook_node(nb, resources) |
|
120 | 126 | elif isinstance(nb, string_types): |
|
121 | 127 | output, resources = exporter_instance.from_filename(nb, resources) |
|
122 | 128 | else: |
|
123 | 129 | output, resources = exporter_instance.from_file(nb, resources) |
|
124 | 130 | return output, resources |
|
125 | 131 | |
|
126 | 132 | exporter_map = dict( |
|
127 | 133 | custom=TemplateExporter, |
|
128 | 134 | html=HTMLExporter, |
|
129 | 135 | slides=SlidesExporter, |
|
130 | 136 | latex=LatexExporter, |
|
131 | 137 | markdown=MarkdownExporter, |
|
132 | 138 | python=PythonExporter, |
|
133 | 139 | rst=RSTExporter, |
|
134 | 140 | ) |
|
135 | 141 | |
|
136 | 142 | def _make_exporter(name, E): |
|
137 | 143 | """make an export_foo function from a short key and Exporter class E""" |
|
138 | 144 | def _export(nb, **kw): |
|
139 | 145 | return export(E, nb, **kw) |
|
140 | 146 | _export.__doc__ = """Export a notebook object to {0} format""".format(name) |
|
141 | 147 | return _export |
|
142 | 148 | |
|
143 | 149 | g = globals() |
|
144 | 150 | |
|
145 | 151 | for name, E in exporter_map.items(): |
|
146 | 152 | g['export_%s' % name] = DocDecorator(_make_exporter(name, E)) |
|
147 | 153 | |
|
148 | 154 | @DocDecorator |
|
149 | 155 | def export_by_name(format_name, nb, **kw): |
|
150 | 156 | """ |
|
151 | 157 | Export a notebook object to a template type by its name. Reflection |
|
152 | 158 | (Inspect) is used to find the template's corresponding explicit export |
|
153 | 159 | method defined in this module. That method is then called directly. |
|
154 | 160 | |
|
161 | Parameters | |
|
162 | ---------- | |
|
155 | 163 | format_name : str |
|
156 | 164 | Name of the template style to export to. |
|
157 | 165 | """ |
|
158 | 166 | |
|
159 | 167 | function_name = "export_" + format_name.lower() |
|
160 | 168 | |
|
161 | 169 | if function_name in globals(): |
|
162 | 170 | return globals()[function_name](nb, **kw) |
|
163 | 171 | else: |
|
164 | 172 | raise ExporterNameError("template for `%s` not found" % function_name) |
|
165 | 173 | |
|
166 | 174 | |
|
167 | 175 | def get_export_names(): |
|
168 | 176 | """Return a list of the currently supported export targets |
|
169 | 177 | |
|
170 | 178 | WARNING: API WILL CHANGE IN FUTURE RELEASES OF NBCONVERT""" |
|
171 | 179 | return sorted(exporter_map.keys()) |
@@ -1,323 +1,323 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | """NBConvert is a utility for conversion of .ipynb files. |
|
3 | 3 | |
|
4 | 4 | Command-line interface for the NbConvert conversion utility. |
|
5 | 5 | """ |
|
6 | 6 | #----------------------------------------------------------------------------- |
|
7 | 7 | #Copyright (c) 2013, the IPython Development Team. |
|
8 | 8 | # |
|
9 | 9 | #Distributed under the terms of the Modified BSD License. |
|
10 | 10 | # |
|
11 | 11 | #The full license is in the file COPYING.txt, distributed with this software. |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | |
|
14 | 14 | #----------------------------------------------------------------------------- |
|
15 | 15 | #Imports |
|
16 | 16 | #----------------------------------------------------------------------------- |
|
17 | 17 | |
|
18 | 18 | # Stdlib imports |
|
19 | 19 | from __future__ import print_function |
|
20 | 20 | |
|
21 | 21 | import logging |
|
22 | 22 | import sys |
|
23 | 23 | import os |
|
24 | 24 | import glob |
|
25 | 25 | |
|
26 | 26 | # From IPython |
|
27 | 27 | from IPython.core.application import BaseIPythonApplication, base_aliases, base_flags |
|
28 | 28 | from IPython.core.profiledir import ProfileDir |
|
29 | 29 | from IPython.config import catch_config_error, Configurable |
|
30 | 30 | from IPython.utils.traitlets import ( |
|
31 | 31 | Unicode, List, Instance, DottedObjectName, Type, CaselessStrEnum, |
|
32 | 32 | ) |
|
33 | 33 | from IPython.utils.importstring import import_item |
|
34 | 34 | from IPython.utils.text import dedent |
|
35 | 35 | |
|
36 | 36 | from .exporters.export import get_export_names, exporter_map |
|
37 | 37 | from IPython.nbconvert import exporters, preprocessors, writers, postprocessors |
|
38 | 38 | from .utils.base import NbConvertBase |
|
39 | 39 | from .utils.exceptions import ConversionException |
|
40 | 40 | |
|
41 | 41 | #----------------------------------------------------------------------------- |
|
42 | 42 | #Classes and functions |
|
43 | 43 | #----------------------------------------------------------------------------- |
|
44 | 44 | |
|
45 | 45 | class DottedOrNone(DottedObjectName): |
|
46 | 46 | """ |
|
47 | 47 | A string holding a valid dotted object name in Python, such as A.b3._c |
|
48 | 48 | Also allows for None type.""" |
|
49 | 49 | |
|
50 | 50 | default_value = u'' |
|
51 | 51 | |
|
52 | 52 | def validate(self, obj, value): |
|
53 | 53 | if value is not None and len(value) > 0: |
|
54 | 54 | return super(DottedOrNone, self).validate(obj, value) |
|
55 | 55 | else: |
|
56 | 56 | return value |
|
57 | 57 | |
|
58 | 58 | nbconvert_aliases = {} |
|
59 | 59 | nbconvert_aliases.update(base_aliases) |
|
60 | 60 | nbconvert_aliases.update({ |
|
61 | 61 | 'to' : 'NbConvertApp.export_format', |
|
62 | 62 | 'template' : 'TemplateExporter.template_file', |
|
63 | 63 | 'writer' : 'NbConvertApp.writer_class', |
|
64 | 64 | 'post': 'NbConvertApp.postprocessor_class', |
|
65 | 65 | 'output': 'NbConvertApp.output_base', |
|
66 | 66 | 'reveal-prefix': 'RevealHelpPreprocessor.url_prefix', |
|
67 | 67 | }) |
|
68 | 68 | |
|
69 | 69 | nbconvert_flags = {} |
|
70 | 70 | nbconvert_flags.update(base_flags) |
|
71 | 71 | nbconvert_flags.update({ |
|
72 | 72 | 'stdout' : ( |
|
73 | 73 | {'NbConvertApp' : {'writer_class' : "StdoutWriter"}}, |
|
74 | 74 | "Write notebook output to stdout instead of files." |
|
75 | 75 | ) |
|
76 | 76 | }) |
|
77 | 77 | |
|
78 | 78 | |
|
79 | 79 | class NbConvertApp(BaseIPythonApplication): |
|
80 |
"""Application used to convert |
|
|
80 | """Application used to convert from notebook file type (``*.ipynb``)""" | |
|
81 | 81 | |
|
82 | 82 | name = 'ipython-nbconvert' |
|
83 | 83 | aliases = nbconvert_aliases |
|
84 | 84 | flags = nbconvert_flags |
|
85 | 85 | |
|
86 | 86 | def _log_level_default(self): |
|
87 | 87 | return logging.INFO |
|
88 | 88 | |
|
89 | 89 | def _classes_default(self): |
|
90 | 90 | classes = [NbConvertBase, ProfileDir] |
|
91 | 91 | for pkg in (exporters, preprocessors, writers, postprocessors): |
|
92 | 92 | for name in dir(pkg): |
|
93 | 93 | cls = getattr(pkg, name) |
|
94 | 94 | if isinstance(cls, type) and issubclass(cls, Configurable): |
|
95 | 95 | classes.append(cls) |
|
96 | 96 | |
|
97 | 97 | return classes |
|
98 | 98 | |
|
99 | 99 | description = Unicode( |
|
100 | 100 | u"""This application is used to convert notebook files (*.ipynb) |
|
101 | 101 | to various other formats. |
|
102 | 102 | |
|
103 | 103 | WARNING: THE COMMANDLINE INTERFACE MAY CHANGE IN FUTURE RELEASES.""") |
|
104 | 104 | |
|
105 | 105 | output_base = Unicode('', config=True, help='''overwrite base name use for output files. |
|
106 | 106 | can only be use when converting one notebook at a time. |
|
107 | 107 | ''') |
|
108 | 108 | |
|
109 | 109 | examples = Unicode(u""" |
|
110 | 110 | The simplest way to use nbconvert is |
|
111 | 111 | |
|
112 | 112 | > ipython nbconvert mynotebook.ipynb |
|
113 | 113 | |
|
114 | 114 | which will convert mynotebook.ipynb to the default format (probably HTML). |
|
115 | 115 | |
|
116 | 116 | You can specify the export format with `--to`. |
|
117 | 117 | Options include {0} |
|
118 | 118 | |
|
119 | 119 | > ipython nbconvert --to latex mynotebook.ipnynb |
|
120 | 120 | |
|
121 | 121 | Both HTML and LaTeX support multiple output templates. LaTeX includes |
|
122 | 122 | 'basic', 'book', and 'article'. HTML includes 'basic' and 'full'. You |
|
123 | 123 | can specify the flavor of the format used. |
|
124 | 124 | |
|
125 | 125 | > ipython nbconvert --to html --template basic mynotebook.ipynb |
|
126 | 126 | |
|
127 | 127 | You can also pipe the output to stdout, rather than a file |
|
128 | 128 | |
|
129 | 129 | > ipython nbconvert mynotebook.ipynb --stdout |
|
130 | 130 | |
|
131 | 131 | A post-processor can be used to compile a PDF |
|
132 | 132 | |
|
133 | 133 | > ipython nbconvert mynotebook.ipynb --to latex --post PDF |
|
134 | 134 | |
|
135 | 135 | You can get (and serve) a Reveal.js-powered slideshow |
|
136 | 136 | |
|
137 | 137 | > ipython nbconvert myslides.ipynb --to slides --post serve |
|
138 | 138 | |
|
139 | 139 | Multiple notebooks can be given at the command line in a couple of |
|
140 | 140 | different ways: |
|
141 | 141 | |
|
142 | 142 | > ipython nbconvert notebook*.ipynb |
|
143 | 143 | > ipython nbconvert notebook1.ipynb notebook2.ipynb |
|
144 | 144 | |
|
145 | 145 | or you can specify the notebooks list in a config file, containing:: |
|
146 | 146 | |
|
147 | 147 | c.NbConvertApp.notebooks = ["my_notebook.ipynb"] |
|
148 | 148 | |
|
149 | 149 | > ipython nbconvert --config mycfg.py |
|
150 | 150 | """.format(get_export_names())) |
|
151 | 151 | |
|
152 | 152 | # Writer specific variables |
|
153 | 153 | writer = Instance('IPython.nbconvert.writers.base.WriterBase', |
|
154 | 154 | help="""Instance of the writer class used to write the |
|
155 | 155 | results of the conversion.""") |
|
156 | 156 | writer_class = DottedObjectName('FilesWriter', config=True, |
|
157 | 157 | help="""Writer class used to write the |
|
158 | 158 | results of the conversion""") |
|
159 | 159 | writer_aliases = {'fileswriter': 'IPython.nbconvert.writers.files.FilesWriter', |
|
160 | 160 | 'debugwriter': 'IPython.nbconvert.writers.debug.DebugWriter', |
|
161 | 161 | 'stdoutwriter': 'IPython.nbconvert.writers.stdout.StdoutWriter'} |
|
162 | 162 | writer_factory = Type() |
|
163 | 163 | |
|
164 | 164 | def _writer_class_changed(self, name, old, new): |
|
165 | 165 | if new.lower() in self.writer_aliases: |
|
166 | 166 | new = self.writer_aliases[new.lower()] |
|
167 | 167 | self.writer_factory = import_item(new) |
|
168 | 168 | |
|
169 | 169 | # Post-processor specific variables |
|
170 | 170 | postprocessor = Instance('IPython.nbconvert.postprocessors.base.PostProcessorBase', |
|
171 | 171 | help="""Instance of the PostProcessor class used to write the |
|
172 | 172 | results of the conversion.""") |
|
173 | 173 | |
|
174 | 174 | postprocessor_class = DottedOrNone(config=True, |
|
175 | 175 | help="""PostProcessor class used to write the |
|
176 | 176 | results of the conversion""") |
|
177 | 177 | postprocessor_aliases = {'pdf': 'IPython.nbconvert.postprocessors.pdf.PDFPostProcessor', |
|
178 | 178 | 'serve': 'IPython.nbconvert.postprocessors.serve.ServePostProcessor'} |
|
179 | 179 | postprocessor_factory = Type() |
|
180 | 180 | |
|
181 | 181 | def _postprocessor_class_changed(self, name, old, new): |
|
182 | 182 | if new.lower() in self.postprocessor_aliases: |
|
183 | 183 | new = self.postprocessor_aliases[new.lower()] |
|
184 | 184 | if new: |
|
185 | 185 | self.postprocessor_factory = import_item(new) |
|
186 | 186 | |
|
187 | 187 | |
|
188 | 188 | # Other configurable variables |
|
189 | 189 | export_format = CaselessStrEnum(get_export_names(), |
|
190 | 190 | default_value="html", |
|
191 | 191 | config=True, |
|
192 | 192 | help="""The export format to be used.""" |
|
193 | 193 | ) |
|
194 | 194 | |
|
195 | 195 | notebooks = List([], config=True, help="""List of notebooks to convert. |
|
196 | 196 | Wildcards are supported. |
|
197 | 197 | Filenames passed positionally will be added to the list. |
|
198 | 198 | """) |
|
199 | 199 | |
|
200 | 200 | @catch_config_error |
|
201 | 201 | def initialize(self, argv=None): |
|
202 | 202 | super(NbConvertApp, self).initialize(argv) |
|
203 | 203 | self.init_syspath() |
|
204 | 204 | self.init_notebooks() |
|
205 | 205 | self.init_writer() |
|
206 | 206 | self.init_postprocessor() |
|
207 | 207 | |
|
208 | 208 | |
|
209 | 209 | |
|
210 | 210 | def init_syspath(self): |
|
211 | 211 | """ |
|
212 | 212 | Add the cwd to the sys.path ($PYTHONPATH) |
|
213 | 213 | """ |
|
214 | 214 | sys.path.insert(0, os.getcwd()) |
|
215 | 215 | |
|
216 | 216 | |
|
217 | 217 | def init_notebooks(self): |
|
218 | 218 | """Construct the list of notebooks. |
|
219 | 219 | If notebooks are passed on the command-line, |
|
220 | 220 | they override notebooks specified in config files. |
|
221 | 221 | Glob each notebook to replace notebook patterns with filenames. |
|
222 | 222 | """ |
|
223 | 223 | |
|
224 | 224 | # Specifying notebooks on the command-line overrides (rather than adds) |
|
225 | 225 | # the notebook list |
|
226 | 226 | if self.extra_args: |
|
227 | 227 | patterns = self.extra_args |
|
228 | 228 | else: |
|
229 | 229 | patterns = self.notebooks |
|
230 | 230 | |
|
231 | 231 | # Use glob to replace all the notebook patterns with filenames. |
|
232 | 232 | filenames = [] |
|
233 | 233 | for pattern in patterns: |
|
234 | 234 | |
|
235 | 235 | # Use glob to find matching filenames. Allow the user to convert |
|
236 | 236 | # notebooks without having to type the extension. |
|
237 | 237 | globbed_files = glob.glob(pattern) |
|
238 | 238 | globbed_files.extend(glob.glob(pattern + '.ipynb')) |
|
239 | 239 | if not globbed_files: |
|
240 | 240 | self.log.warn("pattern %r matched no files", pattern) |
|
241 | 241 | |
|
242 | 242 | for filename in globbed_files: |
|
243 | 243 | if not filename in filenames: |
|
244 | 244 | filenames.append(filename) |
|
245 | 245 | self.notebooks = filenames |
|
246 | 246 | |
|
247 | 247 | def init_writer(self): |
|
248 | 248 | """ |
|
249 | 249 | Initialize the writer (which is stateless) |
|
250 | 250 | """ |
|
251 | 251 | self._writer_class_changed(None, self.writer_class, self.writer_class) |
|
252 | 252 | self.writer = self.writer_factory(parent=self) |
|
253 | 253 | |
|
254 | 254 | def init_postprocessor(self): |
|
255 | 255 | """ |
|
256 | 256 | Initialize the postprocessor (which is stateless) |
|
257 | 257 | """ |
|
258 | 258 | self._postprocessor_class_changed(None, self.postprocessor_class, |
|
259 | 259 | self.postprocessor_class) |
|
260 | 260 | if self.postprocessor_factory: |
|
261 | 261 | self.postprocessor = self.postprocessor_factory(parent=self) |
|
262 | 262 | |
|
263 | 263 | def start(self): |
|
264 | 264 | """ |
|
265 | 265 | Ran after initialization completed |
|
266 | 266 | """ |
|
267 | 267 | super(NbConvertApp, self).start() |
|
268 | 268 | self.convert_notebooks() |
|
269 | 269 | |
|
270 | 270 | def convert_notebooks(self): |
|
271 | 271 | """ |
|
272 | 272 | Convert the notebooks in the self.notebook traitlet |
|
273 | 273 | """ |
|
274 | 274 | # Export each notebook |
|
275 | 275 | conversion_success = 0 |
|
276 | 276 | |
|
277 | 277 | if self.output_base != '' and len(self.notebooks) > 1: |
|
278 | 278 | self.log.error( |
|
279 | 279 | """UsageError: --output flag or `NbConvertApp.output_base` config option |
|
280 | 280 | cannot be used when converting multiple notebooks. |
|
281 | 281 | """) |
|
282 | 282 | self.exit(1) |
|
283 | 283 | |
|
284 | 284 | exporter = exporter_map[self.export_format](config=self.config) |
|
285 | 285 | |
|
286 | 286 | for notebook_filename in self.notebooks: |
|
287 | 287 | self.log.info("Converting notebook %s to %s", notebook_filename, self.export_format) |
|
288 | 288 | |
|
289 | 289 | # Get a unique key for the notebook and set it in the resources object. |
|
290 | 290 | basename = os.path.basename(notebook_filename) |
|
291 | 291 | notebook_name = basename[:basename.rfind('.')] |
|
292 | 292 | if self.output_base: |
|
293 | 293 | notebook_name = self.output_base |
|
294 | 294 | resources = {} |
|
295 | 295 | resources['unique_key'] = notebook_name |
|
296 | 296 | resources['output_files_dir'] = '%s_files' % notebook_name |
|
297 | 297 | self.log.info("Support files will be in %s", os.path.join(resources['output_files_dir'], '')) |
|
298 | 298 | |
|
299 | 299 | # Try to export |
|
300 | 300 | try: |
|
301 | 301 | output, resources = exporter.from_filename(notebook_filename, resources=resources) |
|
302 | 302 | except ConversionException as e: |
|
303 | 303 | self.log.error("Error while converting '%s'", notebook_filename, |
|
304 | 304 | exc_info=True) |
|
305 | 305 | self.exit(1) |
|
306 | 306 | else: |
|
307 | 307 | write_resultes = self.writer.write(output, resources, notebook_name=notebook_name) |
|
308 | 308 | |
|
309 | 309 | #Post-process if post processor has been defined. |
|
310 | 310 | if hasattr(self, 'postprocessor') and self.postprocessor: |
|
311 | 311 | self.postprocessor(write_resultes) |
|
312 | 312 | conversion_success += 1 |
|
313 | 313 | |
|
314 | 314 | # If nothing was converted successfully, help the user. |
|
315 | 315 | if conversion_success == 0: |
|
316 | 316 | self.print_help() |
|
317 | 317 | sys.exit(-1) |
|
318 | 318 | |
|
319 | 319 | #----------------------------------------------------------------------------- |
|
320 | 320 | # Main entry point |
|
321 | 321 | #----------------------------------------------------------------------------- |
|
322 | 322 | |
|
323 | 323 | launch_new_instance = NbConvertApp.launch_instance |
General Comments 0
You need to be logged in to leave comments.
Login now