##// END OF EJS Templates
Fix indentation for nested block
Nguyen Duy Hai -
Show More
@@ -1,699 +1,707 b''
1 1 """Input transformer machinery to support IPython special syntax.
2 2
3 3 This includes the machinery to recognise and transform ``%magic`` commands,
4 4 ``!system`` commands, ``help?`` querying, prompt stripping, and so forth.
5 5
6 6 Added: IPython 7.0. Replaces inputsplitter and inputtransformer which were
7 7 deprecated in 7.0.
8 8 """
9 9
10 10 # Copyright (c) IPython Development Team.
11 11 # Distributed under the terms of the Modified BSD License.
12 12
13 13 from codeop import compile_command
14 14 import re
15 15 import tokenize
16 16 from typing import List, Tuple
17 17 import warnings
18 18
19 19 _indent_re = re.compile(r'^[ \t]+')
20 20
21 21 def leading_indent(lines):
22 22 """Remove leading indentation.
23 23
24 24 If the first line starts with a spaces or tabs, the same whitespace will be
25 25 removed from each following line in the cell.
26 26 """
27 27 if not lines:
28 28 return lines
29 29 m = _indent_re.match(lines[0])
30 30 if not m:
31 31 return lines
32 32 space = m.group(0)
33 33 n = len(space)
34 34 return [l[n:] if l.startswith(space) else l
35 35 for l in lines]
36 36
37 37 class PromptStripper:
38 38 """Remove matching input prompts from a block of input.
39 39
40 40 Parameters
41 41 ----------
42 42 prompt_re : regular expression
43 43 A regular expression matching any input prompt (including continuation,
44 44 e.g. ``...``)
45 45 initial_re : regular expression, optional
46 46 A regular expression matching only the initial prompt, but not continuation.
47 47 If no initial expression is given, prompt_re will be used everywhere.
48 48 Used mainly for plain Python prompts (``>>>``), where the continuation prompt
49 49 ``...`` is a valid Python expression in Python 3, so shouldn't be stripped.
50 50
51 51 If initial_re and prompt_re differ,
52 52 only initial_re will be tested against the first line.
53 53 If any prompt is found on the first two lines,
54 54 prompts will be stripped from the rest of the block.
55 55 """
56 56 def __init__(self, prompt_re, initial_re=None):
57 57 self.prompt_re = prompt_re
58 58 self.initial_re = initial_re or prompt_re
59 59
60 60 def _strip(self, lines):
61 61 return [self.prompt_re.sub('', l, count=1) for l in lines]
62 62
63 63 def __call__(self, lines):
64 64 if not lines:
65 65 return lines
66 66 if self.initial_re.match(lines[0]) or \
67 67 (len(lines) > 1 and self.prompt_re.match(lines[1])):
68 68 return self._strip(lines)
69 69 return lines
70 70
71 71 classic_prompt = PromptStripper(
72 72 prompt_re=re.compile(r'^(>>>|\.\.\.)( |$)'),
73 73 initial_re=re.compile(r'^>>>( |$)')
74 74 )
75 75
76 76 ipython_prompt = PromptStripper(re.compile(r'^(In \[\d+\]: |\s*\.{3,}: ?)'))
77 77
78 78 def cell_magic(lines):
79 79 if not lines or not lines[0].startswith('%%'):
80 80 return lines
81 81 if re.match('%%\w+\?', lines[0]):
82 82 # This case will be handled by help_end
83 83 return lines
84 84 magic_name, _, first_line = lines[0][2:-1].partition(' ')
85 85 body = ''.join(lines[1:])
86 86 return ['get_ipython().run_cell_magic(%r, %r, %r)\n'
87 87 % (magic_name, first_line, body)]
88 88
89 89
90 90 def _find_assign_op(token_line):
91 91 """Get the index of the first assignment in the line ('=' not inside brackets)
92 92
93 93 Note: We don't try to support multiple special assignment (a = b = %foo)
94 94 """
95 95 paren_level = 0
96 96 for i, ti in enumerate(token_line):
97 97 s = ti.string
98 98 if s == '=' and paren_level == 0:
99 99 return i
100 100 if s in '([{':
101 101 paren_level += 1
102 102 elif s in ')]}':
103 103 if paren_level > 0:
104 104 paren_level -= 1
105 105
106 106 def find_end_of_continued_line(lines, start_line: int):
107 107 """Find the last line of a line explicitly extended using backslashes.
108 108
109 109 Uses 0-indexed line numbers.
110 110 """
111 111 end_line = start_line
112 112 while lines[end_line].endswith('\\\n'):
113 113 end_line += 1
114 114 if end_line >= len(lines):
115 115 break
116 116 return end_line
117 117
118 118 def assemble_continued_line(lines, start: Tuple[int, int], end_line: int):
119 119 """Assemble a single line from multiple continued line pieces
120 120
121 121 Continued lines are lines ending in ``\``, and the line following the last
122 122 ``\`` in the block.
123 123
124 124 For example, this code continues over multiple lines::
125 125
126 126 if (assign_ix is not None) \
127 127 and (len(line) >= assign_ix + 2) \
128 128 and (line[assign_ix+1].string == '%') \
129 129 and (line[assign_ix+2].type == tokenize.NAME):
130 130
131 131 This statement contains four continued line pieces.
132 132 Assembling these pieces into a single line would give::
133 133
134 134 if (assign_ix is not None) and (len(line) >= assign_ix + 2) and (line[...
135 135
136 136 This uses 0-indexed line numbers. *start* is (lineno, colno).
137 137
138 138 Used to allow ``%magic`` and ``!system`` commands to be continued over
139 139 multiple lines.
140 140 """
141 141 parts = [lines[start[0]][start[1]:]] + lines[start[0]+1:end_line+1]
142 142 return ' '.join([p[:-2] for p in parts[:-1]] # Strip backslash+newline
143 143 + [parts[-1][:-1]]) # Strip newline from last line
144 144
145 145 class TokenTransformBase:
146 146 """Base class for transformations which examine tokens.
147 147
148 148 Special syntax should not be transformed when it occurs inside strings or
149 149 comments. This is hard to reliably avoid with regexes. The solution is to
150 150 tokenise the code as Python, and recognise the special syntax in the tokens.
151 151
152 152 IPython's special syntax is not valid Python syntax, so tokenising may go
153 153 wrong after the special syntax starts. These classes therefore find and
154 154 transform *one* instance of special syntax at a time into regular Python
155 155 syntax. After each transformation, tokens are regenerated to find the next
156 156 piece of special syntax.
157 157
158 158 Subclasses need to implement one class method (find)
159 159 and one regular method (transform).
160 160
161 161 The priority attribute can select which transformation to apply if multiple
162 162 transformers match in the same place. Lower numbers have higher priority.
163 163 This allows "%magic?" to be turned into a help call rather than a magic call.
164 164 """
165 165 # Lower numbers -> higher priority (for matches in the same location)
166 166 priority = 10
167 167
168 168 def sortby(self):
169 169 return self.start_line, self.start_col, self.priority
170 170
171 171 def __init__(self, start):
172 172 self.start_line = start[0] - 1 # Shift from 1-index to 0-index
173 173 self.start_col = start[1]
174 174
175 175 @classmethod
176 176 def find(cls, tokens_by_line):
177 177 """Find one instance of special syntax in the provided tokens.
178 178
179 179 Tokens are grouped into logical lines for convenience,
180 180 so it is easy to e.g. look at the first token of each line.
181 181 *tokens_by_line* is a list of lists of tokenize.TokenInfo objects.
182 182
183 183 This should return an instance of its class, pointing to the start
184 184 position it has found, or None if it found no match.
185 185 """
186 186 raise NotImplementedError
187 187
188 188 def transform(self, lines: List[str]):
189 189 """Transform one instance of special syntax found by ``find()``
190 190
191 191 Takes a list of strings representing physical lines,
192 192 returns a similar list of transformed lines.
193 193 """
194 194 raise NotImplementedError
195 195
196 196 class MagicAssign(TokenTransformBase):
197 197 """Transformer for assignments from magics (a = %foo)"""
198 198 @classmethod
199 199 def find(cls, tokens_by_line):
200 200 """Find the first magic assignment (a = %foo) in the cell.
201 201 """
202 202 for line in tokens_by_line:
203 203 assign_ix = _find_assign_op(line)
204 204 if (assign_ix is not None) \
205 205 and (len(line) >= assign_ix + 2) \
206 206 and (line[assign_ix+1].string == '%') \
207 207 and (line[assign_ix+2].type == tokenize.NAME):
208 208 return cls(line[assign_ix+1].start)
209 209
210 210 def transform(self, lines: List[str]):
211 211 """Transform a magic assignment found by the ``find()`` classmethod.
212 212 """
213 213 start_line, start_col = self.start_line, self.start_col
214 214 lhs = lines[start_line][:start_col]
215 215 end_line = find_end_of_continued_line(lines, start_line)
216 216 rhs = assemble_continued_line(lines, (start_line, start_col), end_line)
217 217 assert rhs.startswith('%'), rhs
218 218 magic_name, _, args = rhs[1:].partition(' ')
219 219
220 220 lines_before = lines[:start_line]
221 221 call = "get_ipython().run_line_magic({!r}, {!r})".format(magic_name, args)
222 222 new_line = lhs + call + '\n'
223 223 lines_after = lines[end_line+1:]
224 224
225 225 return lines_before + [new_line] + lines_after
226 226
227 227
228 228 class SystemAssign(TokenTransformBase):
229 229 """Transformer for assignments from system commands (a = !foo)"""
230 230 @classmethod
231 231 def find(cls, tokens_by_line):
232 232 """Find the first system assignment (a = !foo) in the cell.
233 233 """
234 234 for line in tokens_by_line:
235 235 assign_ix = _find_assign_op(line)
236 236 if (assign_ix is not None) \
237 237 and not line[assign_ix].line.strip().startswith('=') \
238 238 and (len(line) >= assign_ix + 2) \
239 239 and (line[assign_ix + 1].type == tokenize.ERRORTOKEN):
240 240 ix = assign_ix + 1
241 241
242 242 while ix < len(line) and line[ix].type == tokenize.ERRORTOKEN:
243 243 if line[ix].string == '!':
244 244 return cls(line[ix].start)
245 245 elif not line[ix].string.isspace():
246 246 break
247 247 ix += 1
248 248
249 249 def transform(self, lines: List[str]):
250 250 """Transform a system assignment found by the ``find()`` classmethod.
251 251 """
252 252 start_line, start_col = self.start_line, self.start_col
253 253
254 254 lhs = lines[start_line][:start_col]
255 255 end_line = find_end_of_continued_line(lines, start_line)
256 256 rhs = assemble_continued_line(lines, (start_line, start_col), end_line)
257 257 assert rhs.startswith('!'), rhs
258 258 cmd = rhs[1:]
259 259
260 260 lines_before = lines[:start_line]
261 261 call = "get_ipython().getoutput({!r})".format(cmd)
262 262 new_line = lhs + call + '\n'
263 263 lines_after = lines[end_line + 1:]
264 264
265 265 return lines_before + [new_line] + lines_after
266 266
267 267 # The escape sequences that define the syntax transformations IPython will
268 268 # apply to user input. These can NOT be just changed here: many regular
269 269 # expressions and other parts of the code may use their hardcoded values, and
270 270 # for all intents and purposes they constitute the 'IPython syntax', so they
271 271 # should be considered fixed.
272 272
273 273 ESC_SHELL = '!' # Send line to underlying system shell
274 274 ESC_SH_CAP = '!!' # Send line to system shell and capture output
275 275 ESC_HELP = '?' # Find information about object
276 276 ESC_HELP2 = '??' # Find extra-detailed information about object
277 277 ESC_MAGIC = '%' # Call magic function
278 278 ESC_MAGIC2 = '%%' # Call cell-magic function
279 279 ESC_QUOTE = ',' # Split args on whitespace, quote each as string and call
280 280 ESC_QUOTE2 = ';' # Quote all args as a single string, call
281 281 ESC_PAREN = '/' # Call first argument with rest of line as arguments
282 282
283 283 ESCAPE_SINGLES = {'!', '?', '%', ',', ';', '/'}
284 284 ESCAPE_DOUBLES = {'!!', '??'} # %% (cell magic) is handled separately
285 285
286 286 def _make_help_call(target, esc, next_input=None):
287 287 """Prepares a pinfo(2)/psearch call from a target name and the escape
288 288 (i.e. ? or ??)"""
289 289 method = 'pinfo2' if esc == '??' \
290 290 else 'psearch' if '*' in target \
291 291 else 'pinfo'
292 292 arg = " ".join([method, target])
293 293 #Prepare arguments for get_ipython().run_line_magic(magic_name, magic_args)
294 294 t_magic_name, _, t_magic_arg_s = arg.partition(' ')
295 295 t_magic_name = t_magic_name.lstrip(ESC_MAGIC)
296 296 if next_input is None:
297 297 return 'get_ipython().run_line_magic(%r, %r)' % (t_magic_name, t_magic_arg_s)
298 298 else:
299 299 return 'get_ipython().set_next_input(%r);get_ipython().run_line_magic(%r, %r)' % \
300 300 (next_input, t_magic_name, t_magic_arg_s)
301 301
302 302 def _tr_help(content):
303 303 """Translate lines escaped with: ?
304 304
305 305 A naked help line should fire the intro help screen (shell.show_usage())
306 306 """
307 307 if not content:
308 308 return 'get_ipython().show_usage()'
309 309
310 310 return _make_help_call(content, '?')
311 311
312 312 def _tr_help2(content):
313 313 """Translate lines escaped with: ??
314 314
315 315 A naked help line should fire the intro help screen (shell.show_usage())
316 316 """
317 317 if not content:
318 318 return 'get_ipython().show_usage()'
319 319
320 320 return _make_help_call(content, '??')
321 321
322 322 def _tr_magic(content):
323 323 "Translate lines escaped with a percent sign: %"
324 324 name, _, args = content.partition(' ')
325 325 return 'get_ipython().run_line_magic(%r, %r)' % (name, args)
326 326
327 327 def _tr_quote(content):
328 328 "Translate lines escaped with a comma: ,"
329 329 name, _, args = content.partition(' ')
330 330 return '%s("%s")' % (name, '", "'.join(args.split()) )
331 331
332 332 def _tr_quote2(content):
333 333 "Translate lines escaped with a semicolon: ;"
334 334 name, _, args = content.partition(' ')
335 335 return '%s("%s")' % (name, args)
336 336
337 337 def _tr_paren(content):
338 338 "Translate lines escaped with a slash: /"
339 339 name, _, args = content.partition(' ')
340 340 return '%s(%s)' % (name, ", ".join(args.split()))
341 341
342 342 tr = { ESC_SHELL : 'get_ipython().system({!r})'.format,
343 343 ESC_SH_CAP : 'get_ipython().getoutput({!r})'.format,
344 344 ESC_HELP : _tr_help,
345 345 ESC_HELP2 : _tr_help2,
346 346 ESC_MAGIC : _tr_magic,
347 347 ESC_QUOTE : _tr_quote,
348 348 ESC_QUOTE2 : _tr_quote2,
349 349 ESC_PAREN : _tr_paren }
350 350
351 351 class EscapedCommand(TokenTransformBase):
352 352 """Transformer for escaped commands like %foo, !foo, or /foo"""
353 353 @classmethod
354 354 def find(cls, tokens_by_line):
355 355 """Find the first escaped command (%foo, !foo, etc.) in the cell.
356 356 """
357 357 for line in tokens_by_line:
358 358 if not line:
359 359 continue
360 360 ix = 0
361 361 ll = len(line)
362 362 while ll > ix and line[ix].type in {tokenize.INDENT, tokenize.DEDENT}:
363 363 ix += 1
364 364 if ix >= ll:
365 365 continue
366 366 if line[ix].string in ESCAPE_SINGLES:
367 367 return cls(line[ix].start)
368 368
369 369 def transform(self, lines):
370 370 """Transform an escaped line found by the ``find()`` classmethod.
371 371 """
372 372 start_line, start_col = self.start_line, self.start_col
373 373
374 374 indent = lines[start_line][:start_col]
375 375 end_line = find_end_of_continued_line(lines, start_line)
376 376 line = assemble_continued_line(lines, (start_line, start_col), end_line)
377 377
378 378 if len(line) > 1 and line[:2] in ESCAPE_DOUBLES:
379 379 escape, content = line[:2], line[2:]
380 380 else:
381 381 escape, content = line[:1], line[1:]
382 382
383 383 if escape in tr:
384 384 call = tr[escape](content)
385 385 else:
386 386 call = ''
387 387
388 388 lines_before = lines[:start_line]
389 389 new_line = indent + call + '\n'
390 390 lines_after = lines[end_line + 1:]
391 391
392 392 return lines_before + [new_line] + lines_after
393 393
394 394 _help_end_re = re.compile(r"""(%{0,2}
395 395 [a-zA-Z_*][\w*]* # Variable name
396 396 (\.[a-zA-Z_*][\w*]*)* # .etc.etc
397 397 )
398 398 (\?\??)$ # ? or ??
399 399 """,
400 400 re.VERBOSE)
401 401
402 402 class HelpEnd(TokenTransformBase):
403 403 """Transformer for help syntax: obj? and obj??"""
404 404 # This needs to be higher priority (lower number) than EscapedCommand so
405 405 # that inspecting magics (%foo?) works.
406 406 priority = 5
407 407
408 408 def __init__(self, start, q_locn):
409 409 super().__init__(start)
410 410 self.q_line = q_locn[0] - 1 # Shift from 1-indexed to 0-indexed
411 411 self.q_col = q_locn[1]
412 412
413 413 @classmethod
414 414 def find(cls, tokens_by_line):
415 415 """Find the first help command (foo?) in the cell.
416 416 """
417 417 for line in tokens_by_line:
418 418 # Last token is NEWLINE; look at last but one
419 419 if len(line) > 2 and line[-2].string == '?':
420 420 # Find the first token that's not INDENT/DEDENT
421 421 ix = 0
422 422 while line[ix].type in {tokenize.INDENT, tokenize.DEDENT}:
423 423 ix += 1
424 424 return cls(line[ix].start, line[-2].start)
425 425
426 426 def transform(self, lines):
427 427 """Transform a help command found by the ``find()`` classmethod.
428 428 """
429 429 piece = ''.join(lines[self.start_line:self.q_line+1])
430 430 indent, content = piece[:self.start_col], piece[self.start_col:]
431 431 lines_before = lines[:self.start_line]
432 432 lines_after = lines[self.q_line + 1:]
433 433
434 434 m = _help_end_re.search(content)
435 435 if not m:
436 436 raise SyntaxError(content)
437 437 assert m is not None, content
438 438 target = m.group(1)
439 439 esc = m.group(3)
440 440
441 441 # If we're mid-command, put it back on the next prompt for the user.
442 442 next_input = None
443 443 if (not lines_before) and (not lines_after) \
444 444 and content.strip() != m.group(0):
445 445 next_input = content.rstrip('?\n')
446 446
447 447 call = _make_help_call(target, esc, next_input=next_input)
448 448 new_line = indent + call + '\n'
449 449
450 450 return lines_before + [new_line] + lines_after
451 451
452 452 def make_tokens_by_line(lines):
453 453 """Tokenize a series of lines and group tokens by line.
454 454
455 455 The tokens for a multiline Python string or expression are
456 456 grouped as one line.
457 457 """
458 458 # NL tokens are used inside multiline expressions, but also after blank
459 459 # lines or comments. This is intentional - see https://bugs.python.org/issue17061
460 460 # We want to group the former case together but split the latter, so we
461 461 # track parentheses level, similar to the internals of tokenize.
462 462 NEWLINE, NL = tokenize.NEWLINE, tokenize.NL
463 463 tokens_by_line = [[]]
464 464 parenlev = 0
465 465 try:
466 466 for token in tokenize.generate_tokens(iter(lines).__next__):
467 467 tokens_by_line[-1].append(token)
468 468 if (token.type == NEWLINE) \
469 469 or ((token.type == NL) and (parenlev <= 0)):
470 470 tokens_by_line.append([])
471 471 elif token.string in {'(', '[', '{'}:
472 472 parenlev += 1
473 473 elif token.string in {')', ']', '}'}:
474 474 if parenlev > 0:
475 475 parenlev -= 1
476 476 except tokenize.TokenError:
477 477 # Input ended in a multiline string or expression. That's OK for us.
478 478 pass
479 479
480 480
481 481 if not tokens_by_line[-1]:
482 482 tokens_by_line.pop()
483 483
484 484
485 485 return tokens_by_line
486 486
487 487 def show_linewise_tokens(s: str):
488 488 """For investigation and debugging"""
489 489 if not s.endswith('\n'):
490 490 s += '\n'
491 491 lines = s.splitlines(keepends=True)
492 492 for line in make_tokens_by_line(lines):
493 493 print("Line -------")
494 494 for tokinfo in line:
495 495 print(" ", tokinfo)
496 496
497 497 # Arbitrary limit to prevent getting stuck in infinite loops
498 498 TRANSFORM_LOOP_LIMIT = 500
499 499
500 500 class TransformerManager:
501 501 """Applies various transformations to a cell or code block.
502 502
503 503 The key methods for external use are ``transform_cell()``
504 504 and ``check_complete()``.
505 505 """
506 506 def __init__(self):
507 507 self.cleanup_transforms = [
508 508 leading_indent,
509 509 classic_prompt,
510 510 ipython_prompt,
511 511 ]
512 512 self.line_transforms = [
513 513 cell_magic,
514 514 ]
515 515 self.token_transformers = [
516 516 MagicAssign,
517 517 SystemAssign,
518 518 EscapedCommand,
519 519 HelpEnd,
520 520 ]
521 521
522 522 def do_one_token_transform(self, lines):
523 523 """Find and run the transform earliest in the code.
524 524
525 525 Returns (changed, lines).
526 526
527 527 This method is called repeatedly until changed is False, indicating
528 528 that all available transformations are complete.
529 529
530 530 The tokens following IPython special syntax might not be valid, so
531 531 the transformed code is retokenised every time to identify the next
532 532 piece of special syntax. Hopefully long code cells are mostly valid
533 533 Python, not using lots of IPython special syntax, so this shouldn't be
534 534 a performance issue.
535 535 """
536 536 tokens_by_line = make_tokens_by_line(lines)
537 537 candidates = []
538 538 for transformer_cls in self.token_transformers:
539 539 transformer = transformer_cls.find(tokens_by_line)
540 540 if transformer:
541 541 candidates.append(transformer)
542 542
543 543 if not candidates:
544 544 # Nothing to transform
545 545 return False, lines
546 546 ordered_transformers = sorted(candidates, key=TokenTransformBase.sortby)
547 547 for transformer in ordered_transformers:
548 548 try:
549 549 return True, transformer.transform(lines)
550 550 except SyntaxError:
551 551 pass
552 552 return False, lines
553 553
554 554 def do_token_transforms(self, lines):
555 555 for _ in range(TRANSFORM_LOOP_LIMIT):
556 556 changed, lines = self.do_one_token_transform(lines)
557 557 if not changed:
558 558 return lines
559 559
560 560 raise RuntimeError("Input transformation still changing after "
561 561 "%d iterations. Aborting." % TRANSFORM_LOOP_LIMIT)
562 562
563 563 def transform_cell(self, cell: str) -> str:
564 564 """Transforms a cell of input code"""
565 565 if not cell.endswith('\n'):
566 566 cell += '\n' # Ensure the cell has a trailing newline
567 567 lines = cell.splitlines(keepends=True)
568 568 for transform in self.cleanup_transforms + self.line_transforms:
569 569 lines = transform(lines)
570 570
571 571 lines = self.do_token_transforms(lines)
572 572 return ''.join(lines)
573 573
574 574 def check_complete(self, cell: str):
575 575 """Return whether a block of code is ready to execute, or should be continued
576 576
577 577 Parameters
578 578 ----------
579 579 source : string
580 580 Python input code, which can be multiline.
581 581
582 582 Returns
583 583 -------
584 584 status : str
585 585 One of 'complete', 'incomplete', or 'invalid' if source is not a
586 586 prefix of valid code.
587 587 indent_spaces : int or None
588 588 The number of spaces by which to indent the next line of code. If
589 589 status is not 'incomplete', this is None.
590 590 """
591 591 # Remember if the lines ends in a new line.
592 592 ends_with_newline = False
593 593 for character in reversed(cell):
594 594 if character == '\n':
595 595 ends_with_newline = True
596 596 break
597 597 elif character.strip():
598 598 break
599 599 else:
600 600 continue
601 601
602 602 if ends_with_newline:
603 603 # Append an newline for consistent tokenization
604 604 # See https://bugs.python.org/issue33899
605 605 cell += '\n'
606 606
607 607 lines = cell.splitlines(keepends=True)
608 608
609 609 if not lines:
610 610 return 'complete', None
611 611
612 612 if lines[-1].endswith('\\'):
613 613 # Explicit backslash continuation
614 614 return 'incomplete', find_last_indent(lines)
615 615
616 616 try:
617 617 for transform in self.cleanup_transforms:
618 618 lines = transform(lines)
619 619 except SyntaxError:
620 620 return 'invalid', None
621 621
622 622 if lines[0].startswith('%%'):
623 623 # Special case for cell magics - completion marked by blank line
624 624 if lines[-1].strip():
625 625 return 'incomplete', find_last_indent(lines)
626 626 else:
627 627 return 'complete', None
628 628
629 629 try:
630 630 for transform in self.line_transforms:
631 631 lines = transform(lines)
632 632 lines = self.do_token_transforms(lines)
633 633 except SyntaxError:
634 634 return 'invalid', None
635 635
636 636 tokens_by_line = make_tokens_by_line(lines)
637 637
638 638 if not tokens_by_line:
639 639 return 'incomplete', find_last_indent(lines)
640 640
641 641 if tokens_by_line[-1][-1].type != tokenize.ENDMARKER:
642 642 # We're in a multiline string or expression
643 643 return 'incomplete', find_last_indent(lines)
644 644
645 645 newline_types = {tokenize.NEWLINE, tokenize.COMMENT, tokenize.ENDMARKER}
646 646
647 647 # Remove newline_types for the list of tokens
648 648 while len(tokens_by_line) > 1 and len(tokens_by_line[-1]) == 1 \
649 649 and tokens_by_line[-1][-1].type in newline_types:
650 650 tokens_by_line.pop()
651 651
652 652 while tokens_by_line[-1] and tokens_by_line[-1][-1].type in newline_types:
653 653 tokens_by_line[-1].pop()
654 654
655 655 if len(tokens_by_line) == 1 and not tokens_by_line[-1]:
656 656 return 'incomplete', 0
657 657
658 if tokens_by_line[-1][-1].string == ':':
658 new_block = False
659 for token in reversed(tokens_by_line[-1]):
660 if token.type == tokenize.DEDENT:
661 continue
662 elif token.string == ':':
663 new_block = True
664 break
665
666 if new_block:
659 667 # The last line starts a block (e.g. 'if foo:')
660 668 ix = 0
661 669 while tokens_by_line[-1][ix].type in {tokenize.INDENT, tokenize.DEDENT}:
662 670 ix += 1
663 671
664 672 indent = tokens_by_line[-1][ix].start[1]
665 673 return 'incomplete', indent + 4
666 674
667 675 if tokens_by_line[-1][0].line.endswith('\\'):
668 676 return 'incomplete', None
669 677
670 678 # At this point, our checks think the code is complete (or invalid).
671 679 # We'll use codeop.compile_command to check this with the real parser
672 680 try:
673 681 with warnings.catch_warnings():
674 682 warnings.simplefilter('error', SyntaxWarning)
675 683 res = compile_command(''.join(lines), symbol='exec')
676 684 except (SyntaxError, OverflowError, ValueError, TypeError,
677 685 MemoryError, SyntaxWarning):
678 686 return 'invalid', None
679 687 else:
680 688 if res is None:
681 689 return 'incomplete', find_last_indent(lines)
682 690
683 691 if tokens_by_line[-1][-1].type == tokenize.DEDENT:
684 692 if ends_with_newline:
685 693 return 'complete', None
686 694 return 'incomplete', find_last_indent(lines)
687 695
688 696 # If there's a blank line at the end, assume we're ready to execute
689 697 if not lines[-1].strip():
690 698 return 'complete', None
691 699
692 700 return 'complete', None
693 701
694 702
695 703 def find_last_indent(lines):
696 704 m = _indent_re.match(lines[-1])
697 705 if not m:
698 706 return 0
699 707 return len(m.group(0).replace('\t', ' '*4))
@@ -1,250 +1,251 b''
1 1 """Tests for the token-based transformers in IPython.core.inputtransformer2
2 2
3 3 Line-based transformers are the simpler ones; token-based transformers are
4 4 more complex. See test_inputtransformer2_line for tests for line-based
5 5 transformations.
6 6 """
7 7 import nose.tools as nt
8 8 import string
9 9
10 10 from IPython.core import inputtransformer2 as ipt2
11 11 from IPython.core.inputtransformer2 import make_tokens_by_line
12 12
13 13 from textwrap import dedent
14 14
15 15 MULTILINE_MAGIC = ("""\
16 16 a = f()
17 17 %foo \\
18 18 bar
19 19 g()
20 20 """.splitlines(keepends=True), (2, 0), """\
21 21 a = f()
22 22 get_ipython().run_line_magic('foo', ' bar')
23 23 g()
24 24 """.splitlines(keepends=True))
25 25
26 26 INDENTED_MAGIC = ("""\
27 27 for a in range(5):
28 28 %ls
29 29 """.splitlines(keepends=True), (2, 4), """\
30 30 for a in range(5):
31 31 get_ipython().run_line_magic('ls', '')
32 32 """.splitlines(keepends=True))
33 33
34 34 MULTILINE_MAGIC_ASSIGN = ("""\
35 35 a = f()
36 36 b = %foo \\
37 37 bar
38 38 g()
39 39 """.splitlines(keepends=True), (2, 4), """\
40 40 a = f()
41 41 b = get_ipython().run_line_magic('foo', ' bar')
42 42 g()
43 43 """.splitlines(keepends=True))
44 44
45 45 MULTILINE_SYSTEM_ASSIGN = ("""\
46 46 a = f()
47 47 b = !foo \\
48 48 bar
49 49 g()
50 50 """.splitlines(keepends=True), (2, 4), """\
51 51 a = f()
52 52 b = get_ipython().getoutput('foo bar')
53 53 g()
54 54 """.splitlines(keepends=True))
55 55
56 56 AUTOCALL_QUOTE = (
57 57 [",f 1 2 3\n"], (1, 0),
58 58 ['f("1", "2", "3")\n']
59 59 )
60 60
61 61 AUTOCALL_QUOTE2 = (
62 62 [";f 1 2 3\n"], (1, 0),
63 63 ['f("1 2 3")\n']
64 64 )
65 65
66 66 AUTOCALL_PAREN = (
67 67 ["/f 1 2 3\n"], (1, 0),
68 68 ['f(1, 2, 3)\n']
69 69 )
70 70
71 71 SIMPLE_HELP = (
72 72 ["foo?\n"], (1, 0),
73 73 ["get_ipython().run_line_magic('pinfo', 'foo')\n"]
74 74 )
75 75
76 76 DETAILED_HELP = (
77 77 ["foo??\n"], (1, 0),
78 78 ["get_ipython().run_line_magic('pinfo2', 'foo')\n"]
79 79 )
80 80
81 81 MAGIC_HELP = (
82 82 ["%foo?\n"], (1, 0),
83 83 ["get_ipython().run_line_magic('pinfo', '%foo')\n"]
84 84 )
85 85
86 86 HELP_IN_EXPR = (
87 87 ["a = b + c?\n"], (1, 0),
88 88 ["get_ipython().set_next_input('a = b + c');"
89 89 "get_ipython().run_line_magic('pinfo', 'c')\n"]
90 90 )
91 91
92 92 HELP_CONTINUED_LINE = ("""\
93 93 a = \\
94 94 zip?
95 95 """.splitlines(keepends=True), (1, 0),
96 96 [r"get_ipython().set_next_input('a = \\\nzip');get_ipython().run_line_magic('pinfo', 'zip')" + "\n"]
97 97 )
98 98
99 99 HELP_MULTILINE = ("""\
100 100 (a,
101 101 b) = zip?
102 102 """.splitlines(keepends=True), (1, 0),
103 103 [r"get_ipython().set_next_input('(a,\nb) = zip');get_ipython().run_line_magic('pinfo', 'zip')" + "\n"]
104 104 )
105 105
106 106 def null_cleanup_transformer(lines):
107 107 """
108 108 A cleanup transform that returns an empty list.
109 109 """
110 110 return []
111 111
112 112 def check_make_token_by_line_never_ends_empty():
113 113 """
114 114 Check that not sequence of single or double characters ends up leading to en empty list of tokens
115 115 """
116 116 from string import printable
117 117 for c in printable:
118 118 nt.assert_not_equal(make_tokens_by_line(c)[-1], [])
119 119 for k in printable:
120 120 nt.assert_not_equal(make_tokens_by_line(c+k)[-1], [])
121 121
122 122 def check_find(transformer, case, match=True):
123 123 sample, expected_start, _ = case
124 124 tbl = make_tokens_by_line(sample)
125 125 res = transformer.find(tbl)
126 126 if match:
127 127 # start_line is stored 0-indexed, expected values are 1-indexed
128 128 nt.assert_equal((res.start_line+1, res.start_col), expected_start)
129 129 return res
130 130 else:
131 131 nt.assert_is(res, None)
132 132
133 133 def check_transform(transformer_cls, case):
134 134 lines, start, expected = case
135 135 transformer = transformer_cls(start)
136 136 nt.assert_equal(transformer.transform(lines), expected)
137 137
138 138 def test_continued_line():
139 139 lines = MULTILINE_MAGIC_ASSIGN[0]
140 140 nt.assert_equal(ipt2.find_end_of_continued_line(lines, 1), 2)
141 141
142 142 nt.assert_equal(ipt2.assemble_continued_line(lines, (1, 5), 2), "foo bar")
143 143
144 144 def test_find_assign_magic():
145 145 check_find(ipt2.MagicAssign, MULTILINE_MAGIC_ASSIGN)
146 146 check_find(ipt2.MagicAssign, MULTILINE_SYSTEM_ASSIGN, match=False)
147 147
148 148 def test_transform_assign_magic():
149 149 check_transform(ipt2.MagicAssign, MULTILINE_MAGIC_ASSIGN)
150 150
151 151 def test_find_assign_system():
152 152 check_find(ipt2.SystemAssign, MULTILINE_SYSTEM_ASSIGN)
153 153 check_find(ipt2.SystemAssign, (["a = !ls\n"], (1, 5), None))
154 154 check_find(ipt2.SystemAssign, (["a=!ls\n"], (1, 2), None))
155 155 check_find(ipt2.SystemAssign, MULTILINE_MAGIC_ASSIGN, match=False)
156 156
157 157 def test_transform_assign_system():
158 158 check_transform(ipt2.SystemAssign, MULTILINE_SYSTEM_ASSIGN)
159 159
160 160 def test_find_magic_escape():
161 161 check_find(ipt2.EscapedCommand, MULTILINE_MAGIC)
162 162 check_find(ipt2.EscapedCommand, INDENTED_MAGIC)
163 163 check_find(ipt2.EscapedCommand, MULTILINE_MAGIC_ASSIGN, match=False)
164 164
165 165 def test_transform_magic_escape():
166 166 check_transform(ipt2.EscapedCommand, MULTILINE_MAGIC)
167 167 check_transform(ipt2.EscapedCommand, INDENTED_MAGIC)
168 168
169 169 def test_find_autocalls():
170 170 for case in [AUTOCALL_QUOTE, AUTOCALL_QUOTE2, AUTOCALL_PAREN]:
171 171 print("Testing %r" % case[0])
172 172 check_find(ipt2.EscapedCommand, case)
173 173
174 174 def test_transform_autocall():
175 175 for case in [AUTOCALL_QUOTE, AUTOCALL_QUOTE2, AUTOCALL_PAREN]:
176 176 print("Testing %r" % case[0])
177 177 check_transform(ipt2.EscapedCommand, case)
178 178
179 179 def test_find_help():
180 180 for case in [SIMPLE_HELP, DETAILED_HELP, MAGIC_HELP, HELP_IN_EXPR]:
181 181 check_find(ipt2.HelpEnd, case)
182 182
183 183 tf = check_find(ipt2.HelpEnd, HELP_CONTINUED_LINE)
184 184 nt.assert_equal(tf.q_line, 1)
185 185 nt.assert_equal(tf.q_col, 3)
186 186
187 187 tf = check_find(ipt2.HelpEnd, HELP_MULTILINE)
188 188 nt.assert_equal(tf.q_line, 1)
189 189 nt.assert_equal(tf.q_col, 8)
190 190
191 191 # ? in a comment does not trigger help
192 192 check_find(ipt2.HelpEnd, (["foo # bar?\n"], None, None), match=False)
193 193 # Nor in a string
194 194 check_find(ipt2.HelpEnd, (["foo = '''bar?\n"], None, None), match=False)
195 195
196 196 def test_transform_help():
197 197 tf = ipt2.HelpEnd((1, 0), (1, 9))
198 198 nt.assert_equal(tf.transform(HELP_IN_EXPR[0]), HELP_IN_EXPR[2])
199 199
200 200 tf = ipt2.HelpEnd((1, 0), (2, 3))
201 201 nt.assert_equal(tf.transform(HELP_CONTINUED_LINE[0]), HELP_CONTINUED_LINE[2])
202 202
203 203 tf = ipt2.HelpEnd((1, 0), (2, 8))
204 204 nt.assert_equal(tf.transform(HELP_MULTILINE[0]), HELP_MULTILINE[2])
205 205
206 206 def test_check_complete():
207 207 cc = ipt2.TransformerManager().check_complete
208 208 nt.assert_equal(cc("a = 1"), ('complete', None))
209 209 nt.assert_equal(cc("for a in range(5):"), ('incomplete', 4))
210 nt.assert_equal(cc("for a in range(5):\n if a > 0:"), ('incomplete', 8))
210 211 nt.assert_equal(cc("raise = 2"), ('invalid', None))
211 212 nt.assert_equal(cc("a = [1,\n2,"), ('incomplete', 0))
212 213 nt.assert_equal(cc(")"), ('incomplete', 0))
213 214 nt.assert_equal(cc("\\\r\n"), ('incomplete', 0))
214 215 nt.assert_equal(cc("a = '''\n hi"), ('incomplete', 3))
215 216 nt.assert_equal(cc("def a():\n x=1\n global x"), ('invalid', None))
216 217 nt.assert_equal(cc("a \\ "), ('invalid', None)) # Nothing allowed after backslash
217 218 nt.assert_equal(cc("1\\\n+2"), ('complete', None))
218 219 nt.assert_equal(cc("exit"), ('complete', None))
219 220
220 221 example = dedent("""
221 222 if True:
222 223 a=1""" )
223 224
224 225 nt.assert_equal(cc(example), ('incomplete', 4))
225 226 nt.assert_equal(cc(example+'\n'), ('complete', None))
226 227 nt.assert_equal(cc(example+'\n '), ('complete', None))
227 228
228 229 # no need to loop on all the letters/numbers.
229 230 short = '12abAB'+string.printable[62:]
230 231 for c in short:
231 232 # test does not raise:
232 233 cc(c)
233 234 for k in short:
234 235 cc(c+k)
235 236
236 237 def test_check_complete_II():
237 238 """
238 239 Test that multiple line strings are properly handled.
239 240
240 241 Separate test function for convenience
241 242
242 243 """
243 244 cc = ipt2.TransformerManager().check_complete
244 245 nt.assert_equal(cc('''def foo():\n """'''), ('incomplete', 4))
245 246
246 247
247 248 def test_null_cleanup_transformer():
248 249 manager = ipt2.TransformerManager()
249 250 manager.cleanup_transforms.insert(0, null_cleanup_transformer)
250 251 nt.assert_is(manager.transform_cell(""), "")
General Comments 0
You need to be logged in to leave comments. Login now