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