##// END OF EJS Templates
Add exec flag so inputsplitter handles multiline cells better.
Thomas Kluyver -
Show More
@@ -1,865 +1,865 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 from __future__ import print_function
64 64
65 65 #-----------------------------------------------------------------------------
66 66 # Imports
67 67 #-----------------------------------------------------------------------------
68 68 # stdlib
69 69 import ast
70 70 import codeop
71 71 import re
72 72 import sys
73 73
74 74 # IPython modules
75 75 from IPython.utils.text import make_quoted_expr
76 76
77 77 #-----------------------------------------------------------------------------
78 78 # Globals
79 79 #-----------------------------------------------------------------------------
80 80
81 81 # The escape sequences that define the syntax transformations IPython will
82 82 # apply to user input. These can NOT be just changed here: many regular
83 83 # expressions and other parts of the code may use their hardcoded values, and
84 84 # for all intents and purposes they constitute the 'IPython syntax', so they
85 85 # should be considered fixed.
86 86
87 87 ESC_SHELL = '!' # Send line to underlying system shell
88 88 ESC_SH_CAP = '!!' # Send line to system shell and capture output
89 89 ESC_HELP = '?' # Find information about object
90 90 ESC_HELP2 = '??' # Find extra-detailed information about object
91 91 ESC_MAGIC = '%' # Call magic function
92 92 ESC_QUOTE = ',' # Split args on whitespace, quote each as string and call
93 93 ESC_QUOTE2 = ';' # Quote all args as a single string, call
94 94 ESC_PAREN = '/' # Call first argument with rest of line as arguments
95 95
96 96 #-----------------------------------------------------------------------------
97 97 # Utilities
98 98 #-----------------------------------------------------------------------------
99 99
100 100 # FIXME: These are general-purpose utilities that later can be moved to the
101 101 # general ward. Kept here for now because we're being very strict about test
102 102 # coverage with this code, and this lets us ensure that we keep 100% coverage
103 103 # while developing.
104 104
105 105 # compiled regexps for autoindent management
106 106 dedent_re = re.compile('|'.join([
107 107 r'^\s+raise(\s.*)?$', # raise statement (+ space + other stuff, maybe)
108 108 r'^\s+raise\([^\)]*\).*$', # wacky raise with immediate open paren
109 109 r'^\s+return(\s.*)?$', # normal return (+ space + other stuff, maybe)
110 110 r'^\s+return\([^\)]*\).*$', # wacky return with immediate open paren
111 111 r'^\s+pass\s*$' # pass (optionally followed by trailing spaces)
112 112 ]))
113 113 ini_spaces_re = re.compile(r'^([ \t\r\f\v]+)')
114 114
115 115 # regexp to match pure comment lines so we don't accidentally insert 'if 1:'
116 116 # before pure comments
117 117 comment_line_re = re.compile('^\s*\#')
118 118
119 119
120 120 def num_ini_spaces(s):
121 121 """Return the number of initial spaces in a string.
122 122
123 123 Note that tabs are counted as a single space. For now, we do *not* support
124 124 mixing of tabs and spaces in the user's input.
125 125
126 126 Parameters
127 127 ----------
128 128 s : string
129 129
130 130 Returns
131 131 -------
132 132 n : int
133 133 """
134 134
135 135 ini_spaces = ini_spaces_re.match(s)
136 136 if ini_spaces:
137 137 return ini_spaces.end()
138 138 else:
139 139 return 0
140 140
141 141
142 142 def remove_comments(src):
143 143 """Remove all comments from input source.
144 144
145 145 Note: comments are NOT recognized inside of strings!
146 146
147 147 Parameters
148 148 ----------
149 149 src : string
150 150 A single or multiline input string.
151 151
152 152 Returns
153 153 -------
154 154 String with all Python comments removed.
155 155 """
156 156
157 157 return re.sub('#.*', '', src)
158 158
159 159
160 160 def get_input_encoding():
161 161 """Return the default standard input encoding.
162 162
163 163 If sys.stdin has no encoding, 'ascii' is returned."""
164 164 # There are strange environments for which sys.stdin.encoding is None. We
165 165 # ensure that a valid encoding is returned.
166 166 encoding = getattr(sys.stdin, 'encoding', None)
167 167 if encoding is None:
168 168 encoding = 'ascii'
169 169 return encoding
170 170
171 171 #-----------------------------------------------------------------------------
172 172 # Classes and functions for normal Python syntax handling
173 173 #-----------------------------------------------------------------------------
174 174
175 175 class InputSplitter(object):
176 176 """An object that can split Python source input in executable blocks.
177 177
178 178 This object is designed to be used in one of two basic modes:
179 179
180 180 1. By feeding it python source line-by-line, using :meth:`push`. In this
181 181 mode, it will return on each push whether the currently pushed code
182 182 could be executed already. In addition, it provides a method called
183 183 :meth:`push_accepts_more` that can be used to query whether more input
184 184 can be pushed into a single interactive block.
185 185
186 186 2. By calling :meth:`split_blocks` with a single, multiline Python string,
187 187 that is then split into blocks each of which can be executed
188 188 interactively as a single statement.
189 189
190 190 This is a simple example of how an interactive terminal-based client can use
191 191 this tool::
192 192
193 193 isp = InputSplitter()
194 194 while isp.push_accepts_more():
195 195 indent = ' '*isp.indent_spaces
196 196 prompt = '>>> ' + indent
197 197 line = indent + raw_input(prompt)
198 198 isp.push(line)
199 199 print 'Input source was:\n', isp.source_reset(),
200 200 """
201 201 # Number of spaces of indentation computed from input that has been pushed
202 202 # so far. This is the attributes callers should query to get the current
203 203 # indentation level, in order to provide auto-indent facilities.
204 204 indent_spaces = 0
205 205 # String, indicating the default input encoding. It is computed by default
206 206 # at initialization time via get_input_encoding(), but it can be reset by a
207 207 # client with specific knowledge of the encoding.
208 208 encoding = ''
209 209 # String where the current full source input is stored, properly encoded.
210 210 # Reading this attribute is the normal way of querying the currently pushed
211 211 # source code, that has been properly encoded.
212 212 source = ''
213 213 # Code object corresponding to the current source. It is automatically
214 214 # synced to the source, so it can be queried at any time to obtain the code
215 215 # object; it will be None if the source doesn't compile to valid Python.
216 216 code = None
217 217 # Input mode
218 218 input_mode = 'line'
219 219
220 220 # Private attributes
221 221
222 222 # List with lines of input accumulated so far
223 223 _buffer = None
224 224 # Command compiler
225 225 _compile = None
226 226 # Mark when input has changed indentation all the way back to flush-left
227 227 _full_dedent = False
228 228 # Boolean indicating whether the current block is complete
229 229 _is_complete = None
230 230
231 231 def __init__(self, input_mode=None):
232 232 """Create a new InputSplitter instance.
233 233
234 234 Parameters
235 235 ----------
236 236 input_mode : str
237 237
238 238 One of ['line', 'cell']; default is 'line'.
239 239
240 240 The input_mode parameter controls how new inputs are used when fed via
241 241 the :meth:`push` method:
242 242
243 243 - 'line': meant for line-oriented clients, inputs are appended one at a
244 244 time to the internal buffer and the whole buffer is compiled.
245 245
246 246 - 'cell': meant for clients that can edit multi-line 'cells' of text at
247 247 a time. A cell can contain one or more blocks that can be compile in
248 248 'single' mode by Python. In this mode, each new input new input
249 249 completely replaces all prior inputs. Cell mode is thus equivalent
250 250 to prepending a full reset() to every push() call.
251 251 """
252 252 self._buffer = []
253 253 self._compile = codeop.CommandCompiler()
254 254 self.encoding = get_input_encoding()
255 255 self.input_mode = InputSplitter.input_mode if input_mode is None \
256 256 else input_mode
257 257
258 258 def reset(self):
259 259 """Reset the input buffer and associated state."""
260 260 self.indent_spaces = 0
261 261 self._buffer[:] = []
262 262 self.source = ''
263 263 self.code = None
264 264 self._is_complete = False
265 265 self._full_dedent = False
266 266
267 267 def source_reset(self):
268 268 """Return the input source and perform a full reset.
269 269 """
270 270 out = self.source
271 271 self.reset()
272 272 return out
273 273
274 274 def push(self, lines):
275 275 """Push one or more lines of input.
276 276
277 277 This stores the given lines and returns a status code indicating
278 278 whether the code forms a complete Python block or not.
279 279
280 280 Any exceptions generated in compilation are swallowed, but if an
281 281 exception was produced, the method returns True.
282 282
283 283 Parameters
284 284 ----------
285 285 lines : string
286 286 One or more lines of Python input.
287 287
288 288 Returns
289 289 -------
290 290 is_complete : boolean
291 291 True if the current input source (the result of the current input
292 292 plus prior inputs) forms a complete Python execution block. Note that
293 293 this value is also stored as a private attribute (_is_complete), so it
294 294 can be queried at any time.
295 295 """
296 296 if self.input_mode == 'cell':
297 297 self.reset()
298 298
299 299 self._store(lines)
300 300 source = self.source
301 301
302 302 # Before calling _compile(), reset the code object to None so that if an
303 303 # exception is raised in compilation, we don't mislead by having
304 304 # inconsistent code/source attributes.
305 305 self.code, self._is_complete = None, None
306 306
307 307 # Honor termination lines properly
308 308 if source.rstrip().endswith('\\'):
309 309 return False
310 310
311 311 self._update_indent(lines)
312 312 try:
313 self.code = self._compile(source)
313 self.code = self._compile(source, symbol="exec")
314 314 # Invalid syntax can produce any of a number of different errors from
315 315 # inside the compiler, so we have to catch them all. Syntax errors
316 316 # immediately produce a 'ready' block, so the invalid Python can be
317 317 # sent to the kernel for evaluation with possible ipython
318 318 # special-syntax conversion.
319 319 except (SyntaxError, OverflowError, ValueError, TypeError,
320 320 MemoryError):
321 321 self._is_complete = True
322 322 else:
323 323 # Compilation didn't produce any exceptions (though it may not have
324 324 # given a complete code object)
325 325 self._is_complete = self.code is not None
326 326
327 327 return self._is_complete
328 328
329 329 def push_accepts_more(self):
330 330 """Return whether a block of interactive input can accept more input.
331 331
332 332 This method is meant to be used by line-oriented frontends, who need to
333 333 guess whether a block is complete or not based solely on prior and
334 334 current input lines. The InputSplitter considers it has a complete
335 335 interactive block and will not accept more input only when either a
336 336 SyntaxError is raised, or *all* of the following are true:
337 337
338 338 1. The input compiles to a complete statement.
339 339
340 340 2. The indentation level is flush-left (because if we are indented,
341 341 like inside a function definition or for loop, we need to keep
342 342 reading new input).
343 343
344 344 3. There is one extra line consisting only of whitespace.
345 345
346 346 Because of condition #3, this method should be used only by
347 347 *line-oriented* frontends, since it means that intermediate blank lines
348 348 are not allowed in function definitions (or any other indented block).
349 349
350 350 Block-oriented frontends that have a separate keyboard event to
351 351 indicate execution should use the :meth:`split_blocks` method instead.
352 352
353 353 If the current input produces a syntax error, this method immediately
354 354 returns False but does *not* raise the syntax error exception, as
355 355 typically clients will want to send invalid syntax to an execution
356 356 backend which might convert the invalid syntax into valid Python via
357 357 one of the dynamic IPython mechanisms.
358 358 """
359 359
360 360 # With incomplete input, unconditionally accept more
361 361 if not self._is_complete:
362 362 return True
363 363
364 364 # If we already have complete input and we're flush left, the answer
365 365 # depends. In line mode, if there hasn't been any indentation,
366 366 # that's it. If we've come back from some indentation, we need
367 367 # the blank final line to finish.
368 368 # In cell mode, we need to check how many blocks the input so far
369 369 # compiles into, because if there's already more than one full
370 370 # independent block of input, then the client has entered full
371 371 # 'cell' mode and is feeding lines that each is complete. In this
372 372 # case we should then keep accepting. The Qt terminal-like console
373 373 # does precisely this, to provide the convenience of terminal-like
374 374 # input of single expressions, but allowing the user (with a
375 375 # separate keystroke) to switch to 'cell' mode and type multiple
376 376 # expressions in one shot.
377 377 if self.indent_spaces==0:
378 378 if self.input_mode=='line':
379 379 if not self._full_dedent:
380 380 return False
381 381 else:
382 382 try:
383 383 code_ast = ast.parse(u''.join(self._buffer))
384 384 except Exception:
385 385 return False
386 386 else:
387 387 if len(code_ast.body) == 1:
388 388 return False
389 389
390 390 # When input is complete, then termination is marked by an extra blank
391 391 # line at the end.
392 392 last_line = self.source.splitlines()[-1]
393 393 return bool(last_line and not last_line.isspace())
394 394
395 395 #------------------------------------------------------------------------
396 396 # Private interface
397 397 #------------------------------------------------------------------------
398 398
399 399 def _find_indent(self, line):
400 400 """Compute the new indentation level for a single line.
401 401
402 402 Parameters
403 403 ----------
404 404 line : str
405 405 A single new line of non-whitespace, non-comment Python input.
406 406
407 407 Returns
408 408 -------
409 409 indent_spaces : int
410 410 New value for the indent level (it may be equal to self.indent_spaces
411 411 if indentation doesn't change.
412 412
413 413 full_dedent : boolean
414 414 Whether the new line causes a full flush-left dedent.
415 415 """
416 416 indent_spaces = self.indent_spaces
417 417 full_dedent = self._full_dedent
418 418
419 419 inisp = num_ini_spaces(line)
420 420 if inisp < indent_spaces:
421 421 indent_spaces = inisp
422 422 if indent_spaces <= 0:
423 423 #print 'Full dedent in text',self.source # dbg
424 424 full_dedent = True
425 425
426 426 if line[-1] == ':':
427 427 indent_spaces += 4
428 428 elif dedent_re.match(line):
429 429 indent_spaces -= 4
430 430 if indent_spaces <= 0:
431 431 full_dedent = True
432 432
433 433 # Safety
434 434 if indent_spaces < 0:
435 435 indent_spaces = 0
436 436 #print 'safety' # dbg
437 437
438 438 return indent_spaces, full_dedent
439 439
440 440 def _update_indent(self, lines):
441 441 for line in remove_comments(lines).splitlines():
442 442 if line and not line.isspace():
443 443 self.indent_spaces, self._full_dedent = self._find_indent(line)
444 444
445 445 def _store(self, lines, buffer=None, store='source'):
446 446 """Store one or more lines of input.
447 447
448 448 If input lines are not newline-terminated, a newline is automatically
449 449 appended."""
450 450
451 451 if buffer is None:
452 452 buffer = self._buffer
453 453
454 454 if lines.endswith('\n'):
455 455 buffer.append(lines)
456 456 else:
457 457 buffer.append(lines+'\n')
458 458 setattr(self, store, self._set_source(buffer))
459 459
460 460 def _set_source(self, buffer):
461 461 return u''.join(buffer)
462 462
463 463
464 464 #-----------------------------------------------------------------------------
465 465 # Functions and classes for IPython-specific syntactic support
466 466 #-----------------------------------------------------------------------------
467 467
468 468 # RegExp for splitting line contents into pre-char//first word-method//rest.
469 469 # For clarity, each group in on one line.
470 470
471 471 line_split = re.compile("""
472 472 ^(\s*) # any leading space
473 473 ([,;/%]|!!?|\?\??) # escape character or characters
474 474 \s*(%?[\w\.\*]*) # function/method, possibly with leading %
475 475 # to correctly treat things like '?%magic'
476 476 (\s+.*$|$) # rest of line
477 477 """, re.VERBOSE)
478 478
479 479
480 480 def split_user_input(line):
481 481 """Split user input into early whitespace, esc-char, function part and rest.
482 482
483 483 This is currently handles lines with '=' in them in a very inconsistent
484 484 manner.
485 485
486 486 Examples
487 487 ========
488 488 >>> split_user_input('x=1')
489 489 ('', '', 'x=1', '')
490 490 >>> split_user_input('?')
491 491 ('', '?', '', '')
492 492 >>> split_user_input('??')
493 493 ('', '??', '', '')
494 494 >>> split_user_input(' ?')
495 495 (' ', '?', '', '')
496 496 >>> split_user_input(' ??')
497 497 (' ', '??', '', '')
498 498 >>> split_user_input('??x')
499 499 ('', '??', 'x', '')
500 500 >>> split_user_input('?x=1')
501 501 ('', '', '?x=1', '')
502 502 >>> split_user_input('!ls')
503 503 ('', '!', 'ls', '')
504 504 >>> split_user_input(' !ls')
505 505 (' ', '!', 'ls', '')
506 506 >>> split_user_input('!!ls')
507 507 ('', '!!', 'ls', '')
508 508 >>> split_user_input(' !!ls')
509 509 (' ', '!!', 'ls', '')
510 510 >>> split_user_input(',ls')
511 511 ('', ',', 'ls', '')
512 512 >>> split_user_input(';ls')
513 513 ('', ';', 'ls', '')
514 514 >>> split_user_input(' ;ls')
515 515 (' ', ';', 'ls', '')
516 516 >>> split_user_input('f.g(x)')
517 517 ('', '', 'f.g(x)', '')
518 518 >>> split_user_input('f.g (x)')
519 519 ('', '', 'f.g', '(x)')
520 520 >>> split_user_input('?%hist')
521 521 ('', '?', '%hist', '')
522 522 >>> split_user_input('?x*')
523 523 ('', '?', 'x*', '')
524 524 """
525 525 match = line_split.match(line)
526 526 if match:
527 527 lspace, esc, fpart, rest = match.groups()
528 528 else:
529 529 # print "match failed for line '%s'" % line
530 530 try:
531 531 fpart, rest = line.split(None, 1)
532 532 except ValueError:
533 533 # print "split failed for line '%s'" % line
534 534 fpart, rest = line,''
535 535 lspace = re.match('^(\s*)(.*)', line).groups()[0]
536 536 esc = ''
537 537
538 538 # fpart has to be a valid python identifier, so it better be only pure
539 539 # ascii, no unicode:
540 540 try:
541 541 fpart = fpart.encode('ascii')
542 542 except UnicodeEncodeError:
543 543 lspace = unicode(lspace)
544 544 rest = fpart + u' ' + rest
545 545 fpart = u''
546 546
547 547 #print 'line:<%s>' % line # dbg
548 548 #print 'esc <%s> fpart <%s> rest <%s>' % (esc,fpart.strip(),rest) # dbg
549 549 return lspace, esc, fpart.strip(), rest.lstrip()
550 550
551 551
552 552 # The escaped translators ALL receive a line where their own escape has been
553 553 # stripped. Only '?' is valid at the end of the line, all others can only be
554 554 # placed at the start.
555 555
556 556 class LineInfo(object):
557 557 """A single line of input and associated info.
558 558
559 559 This is a utility class that mostly wraps the output of
560 560 :func:`split_user_input` into a convenient object to be passed around
561 561 during input transformations.
562 562
563 563 Includes the following as properties:
564 564
565 565 line
566 566 The original, raw line
567 567
568 568 lspace
569 569 Any early whitespace before actual text starts.
570 570
571 571 esc
572 572 The initial esc character (or characters, for double-char escapes like
573 573 '??' or '!!').
574 574
575 575 fpart
576 576 The 'function part', which is basically the maximal initial sequence
577 577 of valid python identifiers and the '.' character. This is what is
578 578 checked for alias and magic transformations, used for auto-calling,
579 579 etc.
580 580
581 581 rest
582 582 Everything else on the line.
583 583 """
584 584 def __init__(self, line):
585 585 self.line = line
586 586 self.lspace, self.esc, self.fpart, self.rest = \
587 587 split_user_input(line)
588 588
589 589 def __str__(self):
590 590 return "LineInfo [%s|%s|%s|%s]" % (self.lspace, self.esc,
591 591 self.fpart, self.rest)
592 592
593 593
594 594 # Transformations of the special syntaxes that don't rely on an explicit escape
595 595 # character but instead on patterns on the input line
596 596
597 597 # The core transformations are implemented as standalone functions that can be
598 598 # tested and validated in isolation. Each of these uses a regexp, we
599 599 # pre-compile these and keep them close to each function definition for clarity
600 600
601 601 _assign_system_re = re.compile(r'(?P<lhs>(\s*)([\w\.]+)((\s*,\s*[\w\.]+)*))'
602 602 r'\s*=\s*!\s*(?P<cmd>.*)')
603 603
604 604 def transform_assign_system(line):
605 605 """Handle the `files = !ls` syntax."""
606 606 m = _assign_system_re.match(line)
607 607 if m is not None:
608 608 cmd = m.group('cmd')
609 609 lhs = m.group('lhs')
610 610 expr = make_quoted_expr(cmd)
611 611 new_line = '%s = get_ipython().getoutput(%s)' % (lhs, expr)
612 612 return new_line
613 613 return line
614 614
615 615
616 616 _assign_magic_re = re.compile(r'(?P<lhs>(\s*)([\w\.]+)((\s*,\s*[\w\.]+)*))'
617 617 r'\s*=\s*%\s*(?P<cmd>.*)')
618 618
619 619 def transform_assign_magic(line):
620 620 """Handle the `a = %who` syntax."""
621 621 m = _assign_magic_re.match(line)
622 622 if m is not None:
623 623 cmd = m.group('cmd')
624 624 lhs = m.group('lhs')
625 625 expr = make_quoted_expr(cmd)
626 626 new_line = '%s = get_ipython().magic(%s)' % (lhs, expr)
627 627 return new_line
628 628 return line
629 629
630 630
631 631 _classic_prompt_re = re.compile(r'^([ \t]*>>> |^[ \t]*\.\.\. )')
632 632
633 633 def transform_classic_prompt(line):
634 634 """Handle inputs that start with '>>> ' syntax."""
635 635
636 636 if not line or line.isspace():
637 637 return line
638 638 m = _classic_prompt_re.match(line)
639 639 if m:
640 640 return line[len(m.group(0)):]
641 641 else:
642 642 return line
643 643
644 644
645 645 _ipy_prompt_re = re.compile(r'^([ \t]*In \[\d+\]: |^[ \t]*\ \ \ \.\.\.+: )')
646 646
647 647 def transform_ipy_prompt(line):
648 648 """Handle inputs that start classic IPython prompt syntax."""
649 649
650 650 if not line or line.isspace():
651 651 return line
652 652 #print 'LINE: %r' % line # dbg
653 653 m = _ipy_prompt_re.match(line)
654 654 if m:
655 655 #print 'MATCH! %r -> %r' % (line, line[len(m.group(0)):]) # dbg
656 656 return line[len(m.group(0)):]
657 657 else:
658 658 return line
659 659
660 660
661 661 class EscapedTransformer(object):
662 662 """Class to transform lines that are explicitly escaped out."""
663 663
664 664 def __init__(self):
665 665 tr = { ESC_SHELL : self._tr_system,
666 666 ESC_SH_CAP : self._tr_system2,
667 667 ESC_HELP : self._tr_help,
668 668 ESC_HELP2 : self._tr_help,
669 669 ESC_MAGIC : self._tr_magic,
670 670 ESC_QUOTE : self._tr_quote,
671 671 ESC_QUOTE2 : self._tr_quote2,
672 672 ESC_PAREN : self._tr_paren }
673 673 self.tr = tr
674 674
675 675 # Support for syntax transformations that use explicit escapes typed by the
676 676 # user at the beginning of a line
677 677 @staticmethod
678 678 def _tr_system(line_info):
679 679 "Translate lines escaped with: !"
680 680 cmd = line_info.line.lstrip().lstrip(ESC_SHELL)
681 681 return '%sget_ipython().system(%s)' % (line_info.lspace,
682 682 make_quoted_expr(cmd))
683 683
684 684 @staticmethod
685 685 def _tr_system2(line_info):
686 686 "Translate lines escaped with: !!"
687 687 cmd = line_info.line.lstrip()[2:]
688 688 return '%sget_ipython().getoutput(%s)' % (line_info.lspace,
689 689 make_quoted_expr(cmd))
690 690
691 691 @staticmethod
692 692 def _tr_help(line_info):
693 693 "Translate lines escaped with: ?/??"
694 694 # A naked help line should just fire the intro help screen
695 695 if not line_info.line[1:]:
696 696 return 'get_ipython().show_usage()'
697 697
698 698 # There may be one or two '?' at the end, move them to the front so that
699 699 # the rest of the logic can assume escapes are at the start
700 700 l_ori = line_info
701 701 line = line_info.line
702 702 if line.endswith('?'):
703 703 line = line[-1] + line[:-1]
704 704 if line.endswith('?'):
705 705 line = line[-1] + line[:-1]
706 706 line_info = LineInfo(line)
707 707
708 708 # From here on, simply choose which level of detail to get, and
709 709 # special-case the psearch syntax
710 710 pinfo = 'pinfo' # default
711 711 if '*' in line_info.line:
712 712 pinfo = 'psearch'
713 713 elif line_info.esc == '??':
714 714 pinfo = 'pinfo2'
715 715
716 716 tpl = '%sget_ipython().magic(u"%s %s")'
717 717 return tpl % (line_info.lspace, pinfo,
718 718 ' '.join([line_info.fpart, line_info.rest]).strip())
719 719
720 720 @staticmethod
721 721 def _tr_magic(line_info):
722 722 "Translate lines escaped with: %"
723 723 tpl = '%sget_ipython().magic(%s)'
724 724 cmd = make_quoted_expr(' '.join([line_info.fpart,
725 725 line_info.rest]).strip())
726 726 return tpl % (line_info.lspace, cmd)
727 727
728 728 @staticmethod
729 729 def _tr_quote(line_info):
730 730 "Translate lines escaped with: ,"
731 731 return '%s%s("%s")' % (line_info.lspace, line_info.fpart,
732 732 '", "'.join(line_info.rest.split()) )
733 733
734 734 @staticmethod
735 735 def _tr_quote2(line_info):
736 736 "Translate lines escaped with: ;"
737 737 return '%s%s("%s")' % (line_info.lspace, line_info.fpart,
738 738 line_info.rest)
739 739
740 740 @staticmethod
741 741 def _tr_paren(line_info):
742 742 "Translate lines escaped with: /"
743 743 return '%s%s(%s)' % (line_info.lspace, line_info.fpart,
744 744 ", ".join(line_info.rest.split()))
745 745
746 746 def __call__(self, line):
747 747 """Class to transform lines that are explicitly escaped out.
748 748
749 749 This calls the above _tr_* static methods for the actual line
750 750 translations."""
751 751
752 752 # Empty lines just get returned unmodified
753 753 if not line or line.isspace():
754 754 return line
755 755
756 756 # Get line endpoints, where the escapes can be
757 757 line_info = LineInfo(line)
758 758
759 759 # If the escape is not at the start, only '?' needs to be special-cased.
760 760 # All other escapes are only valid at the start
761 761 if not line_info.esc in self.tr:
762 762 if line.endswith(ESC_HELP):
763 763 return self._tr_help(line_info)
764 764 else:
765 765 # If we don't recognize the escape, don't modify the line
766 766 return line
767 767
768 768 return self.tr[line_info.esc](line_info)
769 769
770 770
771 771 # A function-looking object to be used by the rest of the code. The purpose of
772 772 # the class in this case is to organize related functionality, more than to
773 773 # manage state.
774 774 transform_escaped = EscapedTransformer()
775 775
776 776
777 777 class IPythonInputSplitter(InputSplitter):
778 778 """An input splitter that recognizes all of IPython's special syntax."""
779 779
780 780 # String with raw, untransformed input.
781 781 source_raw = ''
782 782
783 783 # Private attributes
784 784
785 785 # List with lines of raw input accumulated so far.
786 786 _buffer_raw = None
787 787
788 788 def __init__(self, input_mode=None):
789 789 InputSplitter.__init__(self, input_mode)
790 790 self._buffer_raw = []
791 791
792 792 def reset(self):
793 793 """Reset the input buffer and associated state."""
794 794 InputSplitter.reset(self)
795 795 self._buffer_raw[:] = []
796 796 self.source_raw = ''
797 797
798 798 def source_raw_reset(self):
799 799 """Return input and raw source and perform a full reset.
800 800 """
801 801 out = self.source
802 802 out_r = self.source_raw
803 803 self.reset()
804 804 return out, out_r
805 805
806 806 def push(self, lines):
807 807 """Push one or more lines of IPython input.
808 808 """
809 809 if not lines:
810 810 return super(IPythonInputSplitter, self).push(lines)
811 811
812 812 # We must ensure all input is pure unicode
813 813 if type(lines)==str:
814 814 lines = lines.decode(self.encoding)
815 815
816 816 lines_list = lines.splitlines()
817 817
818 818 transforms = [transform_escaped, transform_assign_system,
819 819 transform_assign_magic, transform_ipy_prompt,
820 820 transform_classic_prompt]
821 821
822 822 # Transform logic
823 823 #
824 824 # We only apply the line transformers to the input if we have either no
825 825 # input yet, or complete input, or if the last line of the buffer ends
826 826 # with ':' (opening an indented block). This prevents the accidental
827 827 # transformation of escapes inside multiline expressions like
828 828 # triple-quoted strings or parenthesized expressions.
829 829 #
830 830 # The last heuristic, while ugly, ensures that the first line of an
831 831 # indented block is correctly transformed.
832 832 #
833 833 # FIXME: try to find a cleaner approach for this last bit.
834 834
835 835 # If we were in 'block' mode, since we're going to pump the parent
836 836 # class by hand line by line, we need to temporarily switch out to
837 837 # 'line' mode, do a single manual reset and then feed the lines one
838 838 # by one. Note that this only matters if the input has more than one
839 839 # line.
840 840 changed_input_mode = False
841 841
842 842 if self.input_mode == 'cell':
843 843 self.reset()
844 844 changed_input_mode = True
845 845 saved_input_mode = 'cell'
846 846 self.input_mode = 'line'
847 847
848 848 # Store raw source before applying any transformations to it. Note
849 849 # that this must be done *after* the reset() call that would otherwise
850 850 # flush the buffer.
851 851 self._store(lines, self._buffer_raw, 'source_raw')
852 852
853 853 try:
854 854 push = super(IPythonInputSplitter, self).push
855 855 for line in lines_list:
856 856 if self._is_complete or not self._buffer or \
857 857 (self._buffer and self._buffer[-1].rstrip().endswith(':')):
858 858 for f in transforms:
859 859 line = f(line)
860 860
861 861 out = push(line)
862 862 finally:
863 863 if changed_input_mode:
864 864 self.input_mode = saved_input_mode
865 865 return out
General Comments 0
You need to be logged in to leave comments. Login now