##// END OF EJS Templates
Change logic to adding newline implicitly instead of removing the automatically added one
Nguyen Duy Hai -
Show More
@@ -1,719 +1,702 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 # Convert if using cpython tokenize
485 # upstream bug was fixed in Python 3.7.1, so once we drop 3.7 this can likely be removed.
486 if (list(map(lambda x: x.type, tokens_by_line[-1])) ==
487 [tokenize.DEDENT] * (len(tokens_by_line[-1]) - 1) + [tokenize.ENDMARKER]):
488 if (
489 len(tokens_by_line) > 1 and
490 len(tokens_by_line[-2]) > 0 and
491 tokens_by_line[-2][-1].type == tokenize.NEWLINE
492 ):
493 tokens_by_line[-2].pop()
494 tokens_by_line[-2] += tokens_by_line[-1]
495 tokens_by_line.pop()
496 484
497 485 return tokens_by_line
498 486
499 487 def show_linewise_tokens(s: str):
500 488 """For investigation and debugging"""
501 489 if not s.endswith('\n'):
502 490 s += '\n'
503 491 lines = s.splitlines(keepends=True)
504 492 for line in make_tokens_by_line(lines):
505 493 print("Line -------")
506 494 for tokinfo in line:
507 495 print(" ", tokinfo)
508 496
509 497 # Arbitrary limit to prevent getting stuck in infinite loops
510 498 TRANSFORM_LOOP_LIMIT = 500
511 499
512 500 class TransformerManager:
513 501 """Applies various transformations to a cell or code block.
514 502
515 503 The key methods for external use are ``transform_cell()``
516 504 and ``check_complete()``.
517 505 """
518 506 def __init__(self):
519 507 self.cleanup_transforms = [
520 508 leading_indent,
521 509 classic_prompt,
522 510 ipython_prompt,
523 511 ]
524 512 self.line_transforms = [
525 513 cell_magic,
526 514 ]
527 515 self.token_transformers = [
528 516 MagicAssign,
529 517 SystemAssign,
530 518 EscapedCommand,
531 519 HelpEnd,
532 520 ]
533 521
534 522 def do_one_token_transform(self, lines):
535 523 """Find and run the transform earliest in the code.
536 524
537 525 Returns (changed, lines).
538 526
539 527 This method is called repeatedly until changed is False, indicating
540 528 that all available transformations are complete.
541 529
542 530 The tokens following IPython special syntax might not be valid, so
543 531 the transformed code is retokenised every time to identify the next
544 532 piece of special syntax. Hopefully long code cells are mostly valid
545 533 Python, not using lots of IPython special syntax, so this shouldn't be
546 534 a performance issue.
547 535 """
548 536 tokens_by_line = make_tokens_by_line(lines)
549 537 candidates = []
550 538 for transformer_cls in self.token_transformers:
551 539 transformer = transformer_cls.find(tokens_by_line)
552 540 if transformer:
553 541 candidates.append(transformer)
554 542
555 543 if not candidates:
556 544 # Nothing to transform
557 545 return False, lines
558 546 ordered_transformers = sorted(candidates, key=TokenTransformBase.sortby)
559 547 for transformer in ordered_transformers:
560 548 try:
561 549 return True, transformer.transform(lines)
562 550 except SyntaxError:
563 551 pass
564 552 return False, lines
565 553
566 554 def do_token_transforms(self, lines):
567 555 for _ in range(TRANSFORM_LOOP_LIMIT):
568 556 changed, lines = self.do_one_token_transform(lines)
569 557 if not changed:
570 558 return lines
571 559
572 560 raise RuntimeError("Input transformation still changing after "
573 561 "%d iterations. Aborting." % TRANSFORM_LOOP_LIMIT)
574 562
575 563 def transform_cell(self, cell: str) -> str:
576 564 """Transforms a cell of input code"""
577 565 if not cell.endswith('\n'):
578 566 cell += '\n' # Ensure the cell has a trailing newline
579 567 lines = cell.splitlines(keepends=True)
580 568 for transform in self.cleanup_transforms + self.line_transforms:
581 569 lines = transform(lines)
582 570
583 571 lines = self.do_token_transforms(lines)
584 572 return ''.join(lines)
585 573
586 574 def check_complete(self, cell: str):
587 575 """Return whether a block of code is ready to execute, or should be continued
588 576
589 577 Parameters
590 578 ----------
591 579 source : string
592 580 Python input code, which can be multiline.
593 581
594 582 Returns
595 583 -------
596 584 status : str
597 585 One of 'complete', 'incomplete', or 'invalid' if source is not a
598 586 prefix of valid code.
599 587 indent_spaces : int or None
600 588 The number of spaces by which to indent the next line of code. If
601 589 status is not 'incomplete', this is None.
602 590 """
603 591 # Remember if the lines ends in a new line.
604 592 ends_with_newline = False
605 593 for character in reversed(cell):
606 594 if character == '\n':
607 595 ends_with_newline = True
608 596 break
609 597 elif character.strip():
610 598 break
611 599 else:
612 600 continue
613 601
614 if ends_with_newline:
602 if not ends_with_newline:
615 603 # Append an newline for consistent tokenization
616 604 # See https://bugs.python.org/issue33899
617 605 cell += '\n'
618 606
619 607 lines = cell.splitlines(keepends=True)
620 608
621 609 if not lines:
622 610 return 'complete', None
623 611
624 612 if lines[-1].endswith('\\'):
625 613 # Explicit backslash continuation
626 614 return 'incomplete', find_last_indent(lines)
627 615
628 616 try:
629 617 for transform in self.cleanup_transforms:
630 618 lines = transform(lines)
631 619 except SyntaxError:
632 620 return 'invalid', None
633 621
634 622 if lines[0].startswith('%%'):
635 623 # Special case for cell magics - completion marked by blank line
636 624 if lines[-1].strip():
637 625 return 'incomplete', find_last_indent(lines)
638 626 else:
639 627 return 'complete', None
640 628
641 629 try:
642 630 for transform in self.line_transforms:
643 631 lines = transform(lines)
644 632 lines = self.do_token_transforms(lines)
645 633 except SyntaxError:
646 634 return 'invalid', None
647 635
648 636 tokens_by_line = make_tokens_by_line(lines)
649 637
650 638 if not tokens_by_line:
651 639 return 'incomplete', find_last_indent(lines)
652 640
653 641 if tokens_by_line[-1][-1].type != tokenize.ENDMARKER:
654 642 # We're in a multiline string or expression
655 643 return 'incomplete', find_last_indent(lines)
656 644
657 645 newline_types = {tokenize.NEWLINE, tokenize.COMMENT, tokenize.ENDMARKER}
658 646
659 # Remove newline_types for the list of tokens
660 while len(tokens_by_line) > 1 and len(tokens_by_line[-1]) == 1 \
661 and tokens_by_line[-1][-1].type in newline_types:
662 tokens_by_line.pop()
647 # Pop the last line which only contains DEDENTs and ENDMARKER
648 last_token_line = None
649 if {t.type for t in tokens_by_line[-1]} in [
650 {tokenize.DEDENT, tokenize.ENDMARKER},
651 {tokenize.ENDMARKER}
652 ] and len(tokens_by_line) > 1:
653 last_token_line = tokens_by_line.pop()
663 654
664 655 while tokens_by_line[-1] and tokens_by_line[-1][-1].type in newline_types:
665 656 tokens_by_line[-1].pop()
666 657
667 658 if len(tokens_by_line) == 1 and not tokens_by_line[-1]:
668 659 return 'incomplete', 0
669 660
670 new_block = False
671 for token in reversed(tokens_by_line[-1]):
672 if token.type == tokenize.DEDENT:
673 continue
674 elif token.string == ':':
675 new_block = True
676 break
677
678 if new_block:
661 if tokens_by_line[-1][-1].string == ':':
679 662 # The last line starts a block (e.g. 'if foo:')
680 663 ix = 0
681 664 while tokens_by_line[-1][ix].type in {tokenize.INDENT, tokenize.DEDENT}:
682 665 ix += 1
683 666
684 667 indent = tokens_by_line[-1][ix].start[1]
685 668 return 'incomplete', indent + 4
686 669
687 670 if tokens_by_line[-1][0].line.endswith('\\'):
688 671 return 'incomplete', None
689 672
690 673 # At this point, our checks think the code is complete (or invalid).
691 674 # We'll use codeop.compile_command to check this with the real parser
692 675 try:
693 676 with warnings.catch_warnings():
694 677 warnings.simplefilter('error', SyntaxWarning)
695 678 res = compile_command(''.join(lines), symbol='exec')
696 679 except (SyntaxError, OverflowError, ValueError, TypeError,
697 680 MemoryError, SyntaxWarning):
698 681 return 'invalid', None
699 682 else:
700 683 if res is None:
701 684 return 'incomplete', find_last_indent(lines)
702 685
703 if tokens_by_line[-1][-1].type == tokenize.DEDENT:
686 if last_token_line and last_token_line[0].type == tokenize.DEDENT:
704 687 if ends_with_newline:
705 688 return 'complete', None
706 689 return 'incomplete', find_last_indent(lines)
707 690
708 691 # If there's a blank line at the end, assume we're ready to execute
709 692 if not lines[-1].strip():
710 693 return 'complete', None
711 694
712 695 return 'complete', None
713 696
714 697
715 698 def find_last_indent(lines):
716 699 m = _indent_re.match(lines[-1])
717 700 if not m:
718 701 return 0
719 702 return len(m.group(0).replace('\t', ' '*4))
General Comments 0
You need to be logged in to leave comments. Login now