Show More
@@ -1,802 +1,809 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | Pdb debugger class. |
|
4 | 4 | |
|
5 | 5 | Modified from the standard pdb.Pdb class to avoid including readline, so that |
|
6 | 6 | the command line completion of other programs which include this isn't |
|
7 | 7 | damaged. |
|
8 | 8 | |
|
9 | 9 | In the future, this class will be expanded with improvements over the standard |
|
10 | 10 | pdb. |
|
11 | 11 | |
|
12 | 12 | The code in this file is mainly lifted out of cmd.py in Python 2.2, with minor |
|
13 | 13 | changes. Licensing should therefore be under the standard Python terms. For |
|
14 | 14 | details on the PSF (Python Software Foundation) standard license, see: |
|
15 | 15 | |
|
16 | 16 | https://docs.python.org/2/license.html |
|
17 | 17 | """ |
|
18 | 18 | |
|
19 | 19 | #***************************************************************************** |
|
20 | 20 | # |
|
21 | 21 | # This file is licensed under the PSF license. |
|
22 | 22 | # |
|
23 | 23 | # Copyright (C) 2001 Python Software Foundation, www.python.org |
|
24 | 24 | # Copyright (C) 2005-2006 Fernando Perez. <fperez@colorado.edu> |
|
25 | 25 | # |
|
26 | 26 | # |
|
27 | 27 | #***************************************************************************** |
|
28 | 28 | |
|
29 | 29 | import bdb |
|
30 | 30 | import functools |
|
31 | 31 | import inspect |
|
32 | 32 | import linecache |
|
33 | 33 | import sys |
|
34 | 34 | import warnings |
|
35 | 35 | import re |
|
36 | 36 | |
|
37 | 37 | from IPython import get_ipython |
|
38 | 38 | from IPython.utils import PyColorize |
|
39 | 39 | from IPython.utils import coloransi, py3compat |
|
40 | 40 | from IPython.core.excolors import exception_colors |
|
41 | 41 | from IPython.testing.skipdoctest import skip_doctest |
|
42 | 42 | |
|
43 | 43 | |
|
44 | 44 | prompt = 'ipdb> ' |
|
45 | 45 | |
|
46 | 46 | #We have to check this directly from sys.argv, config struct not yet available |
|
47 | 47 | from pdb import Pdb as OldPdb |
|
48 | 48 | |
|
49 | 49 | # Allow the set_trace code to operate outside of an ipython instance, even if |
|
50 | 50 | # it does so with some limitations. The rest of this support is implemented in |
|
51 | 51 | # the Tracer constructor. |
|
52 | 52 | |
|
53 | 53 | def make_arrow(pad): |
|
54 | 54 | """generate the leading arrow in front of traceback or debugger""" |
|
55 | 55 | if pad >= 2: |
|
56 | 56 | return '-'*(pad-2) + '> ' |
|
57 | 57 | elif pad == 1: |
|
58 | 58 | return '>' |
|
59 | 59 | return '' |
|
60 | 60 | |
|
61 | 61 | |
|
62 | 62 | def BdbQuit_excepthook(et, ev, tb, excepthook=None): |
|
63 | 63 | """Exception hook which handles `BdbQuit` exceptions. |
|
64 | 64 | |
|
65 | 65 | All other exceptions are processed using the `excepthook` |
|
66 | 66 | parameter. |
|
67 | 67 | """ |
|
68 | 68 | warnings.warn("`BdbQuit_excepthook` is deprecated since version 5.1", |
|
69 | 69 | DeprecationWarning, stacklevel=2) |
|
70 | 70 | if et==bdb.BdbQuit: |
|
71 | 71 | print('Exiting Debugger.') |
|
72 | 72 | elif excepthook is not None: |
|
73 | 73 | excepthook(et, ev, tb) |
|
74 | 74 | else: |
|
75 | 75 | # Backwards compatibility. Raise deprecation warning? |
|
76 | 76 | BdbQuit_excepthook.excepthook_ori(et,ev,tb) |
|
77 | 77 | |
|
78 | 78 | |
|
79 | 79 | def BdbQuit_IPython_excepthook(self,et,ev,tb,tb_offset=None): |
|
80 | 80 | warnings.warn( |
|
81 | 81 | "`BdbQuit_IPython_excepthook` is deprecated since version 5.1", |
|
82 | 82 | DeprecationWarning, stacklevel=2) |
|
83 | 83 | print('Exiting Debugger.') |
|
84 | 84 | |
|
85 | 85 | |
|
86 | 86 | class Tracer(object): |
|
87 | 87 | """ |
|
88 | 88 | DEPRECATED |
|
89 | 89 | |
|
90 | 90 | Class for local debugging, similar to pdb.set_trace. |
|
91 | 91 | |
|
92 | 92 | Instances of this class, when called, behave like pdb.set_trace, but |
|
93 | 93 | providing IPython's enhanced capabilities. |
|
94 | 94 | |
|
95 | 95 | This is implemented as a class which must be initialized in your own code |
|
96 | 96 | and not as a standalone function because we need to detect at runtime |
|
97 | 97 | whether IPython is already active or not. That detection is done in the |
|
98 | 98 | constructor, ensuring that this code plays nicely with a running IPython, |
|
99 | 99 | while functioning acceptably (though with limitations) if outside of it. |
|
100 | 100 | """ |
|
101 | 101 | |
|
102 | 102 | @skip_doctest |
|
103 | 103 | def __init__(self, colors=None): |
|
104 | 104 | """ |
|
105 | 105 | DEPRECATED |
|
106 | 106 | |
|
107 | 107 | Create a local debugger instance. |
|
108 | 108 | |
|
109 | 109 | Parameters |
|
110 | 110 | ---------- |
|
111 | 111 | |
|
112 | 112 | colors : str, optional |
|
113 | 113 | The name of the color scheme to use, it must be one of IPython's |
|
114 | 114 | valid color schemes. If not given, the function will default to |
|
115 | 115 | the current IPython scheme when running inside IPython, and to |
|
116 | 116 | 'NoColor' otherwise. |
|
117 | 117 | |
|
118 | 118 | Examples |
|
119 | 119 | -------- |
|
120 | 120 | :: |
|
121 | 121 | |
|
122 | 122 | from IPython.core.debugger import Tracer; debug_here = Tracer() |
|
123 | 123 | |
|
124 | 124 | Later in your code:: |
|
125 | 125 | |
|
126 | 126 | debug_here() # -> will open up the debugger at that point. |
|
127 | 127 | |
|
128 | 128 | Once the debugger activates, you can use all of its regular commands to |
|
129 | 129 | step through code, set breakpoints, etc. See the pdb documentation |
|
130 | 130 | from the Python standard library for usage details. |
|
131 | 131 | """ |
|
132 | 132 | warnings.warn("`Tracer` is deprecated since version 5.1, directly use " |
|
133 | 133 | "`IPython.core.debugger.Pdb.set_trace()`", |
|
134 | 134 | DeprecationWarning, stacklevel=2) |
|
135 | 135 | |
|
136 | 136 | ip = get_ipython() |
|
137 | 137 | if ip is None: |
|
138 | 138 | # Outside of ipython, we set our own exception hook manually |
|
139 | 139 | sys.excepthook = functools.partial(BdbQuit_excepthook, |
|
140 | 140 | excepthook=sys.excepthook) |
|
141 | 141 | def_colors = 'NoColor' |
|
142 | 142 | else: |
|
143 | 143 | # In ipython, we use its custom exception handler mechanism |
|
144 | 144 | def_colors = ip.colors |
|
145 | 145 | ip.set_custom_exc((bdb.BdbQuit,), BdbQuit_IPython_excepthook) |
|
146 | 146 | |
|
147 | 147 | if colors is None: |
|
148 | 148 | colors = def_colors |
|
149 | 149 | |
|
150 | 150 | # The stdlib debugger internally uses a modified repr from the `repr` |
|
151 | 151 | # module, that limits the length of printed strings to a hardcoded |
|
152 | 152 | # limit of 30 characters. That much trimming is too aggressive, let's |
|
153 | 153 | # at least raise that limit to 80 chars, which should be enough for |
|
154 | 154 | # most interactive uses. |
|
155 | 155 | try: |
|
156 | 156 | from reprlib import aRepr |
|
157 | 157 | aRepr.maxstring = 80 |
|
158 | 158 | except: |
|
159 | 159 | # This is only a user-facing convenience, so any error we encounter |
|
160 | 160 | # here can be warned about but can be otherwise ignored. These |
|
161 | 161 | # printouts will tell us about problems if this API changes |
|
162 | 162 | import traceback |
|
163 | 163 | traceback.print_exc() |
|
164 | 164 | |
|
165 | 165 | self.debugger = Pdb(colors) |
|
166 | 166 | |
|
167 | 167 | def __call__(self): |
|
168 | 168 | """Starts an interactive debugger at the point where called. |
|
169 | 169 | |
|
170 | 170 | This is similar to the pdb.set_trace() function from the std lib, but |
|
171 | 171 | using IPython's enhanced debugger.""" |
|
172 | 172 | |
|
173 | 173 | self.debugger.set_trace(sys._getframe().f_back) |
|
174 | 174 | |
|
175 | 175 | |
|
176 | 176 | RGX_EXTRA_INDENT = re.compile(r'(?<=\n)\s+') |
|
177 | 177 | |
|
178 | 178 | |
|
179 | 179 | def strip_indentation(multiline_string): |
|
180 | 180 | return RGX_EXTRA_INDENT.sub('', multiline_string) |
|
181 | 181 | |
|
182 | 182 | |
|
183 | 183 | def decorate_fn_with_doc(new_fn, old_fn, additional_text=""): |
|
184 | 184 | """Make new_fn have old_fn's doc string. This is particularly useful |
|
185 | 185 | for the ``do_...`` commands that hook into the help system. |
|
186 | 186 | Adapted from from a comp.lang.python posting |
|
187 | 187 | by Duncan Booth.""" |
|
188 | 188 | def wrapper(*args, **kw): |
|
189 | 189 | return new_fn(*args, **kw) |
|
190 | 190 | if old_fn.__doc__: |
|
191 | 191 | wrapper.__doc__ = strip_indentation(old_fn.__doc__) + additional_text |
|
192 | 192 | return wrapper |
|
193 | 193 | |
|
194 | 194 | |
|
195 | 195 | class Pdb(OldPdb): |
|
196 | 196 | """Modified Pdb class, does not load readline. |
|
197 | 197 | |
|
198 | 198 | for a standalone version that uses prompt_toolkit, see |
|
199 | 199 | `IPython.terminal.debugger.TerminalPdb` and |
|
200 | 200 | `IPython.terminal.debugger.set_trace()` |
|
201 | 201 | """ |
|
202 | 202 | |
|
203 | 203 | def __init__(self, color_scheme=None, completekey=None, |
|
204 | 204 | stdin=None, stdout=None, context=5, **kwargs): |
|
205 | 205 | """Create a new IPython debugger. |
|
206 | 206 | |
|
207 | 207 | :param color_scheme: Deprecated, do not use. |
|
208 | 208 | :param completekey: Passed to pdb.Pdb. |
|
209 | 209 | :param stdin: Passed to pdb.Pdb. |
|
210 | 210 | :param stdout: Passed to pdb.Pdb. |
|
211 | 211 | :param context: Number of lines of source code context to show when |
|
212 | 212 | displaying stacktrace information. |
|
213 | 213 | :param kwargs: Passed to pdb.Pdb. |
|
214 | 214 | The possibilities are python version dependent, see the python |
|
215 | 215 | docs for more info. |
|
216 | 216 | """ |
|
217 | 217 | |
|
218 | 218 | # Parent constructor: |
|
219 | 219 | try: |
|
220 | 220 | self.context = int(context) |
|
221 | 221 | if self.context <= 0: |
|
222 | 222 | raise ValueError("Context must be a positive integer") |
|
223 | 223 | except (TypeError, ValueError) as e: |
|
224 | 224 | raise ValueError("Context must be a positive integer") from e |
|
225 | 225 | |
|
226 | 226 | # `kwargs` ensures full compatibility with stdlib's `pdb.Pdb`. |
|
227 | 227 | OldPdb.__init__(self, completekey, stdin, stdout, **kwargs) |
|
228 | 228 | |
|
229 | 229 | # IPython changes... |
|
230 | 230 | self.shell = get_ipython() |
|
231 | 231 | |
|
232 | 232 | if self.shell is None: |
|
233 | 233 | save_main = sys.modules['__main__'] |
|
234 | 234 | # No IPython instance running, we must create one |
|
235 | 235 | from IPython.terminal.interactiveshell import \ |
|
236 | 236 | TerminalInteractiveShell |
|
237 | 237 | self.shell = TerminalInteractiveShell.instance() |
|
238 | 238 | # needed by any code which calls __import__("__main__") after |
|
239 | 239 | # the debugger was entered. See also #9941. |
|
240 | 240 | sys.modules['__main__'] = save_main |
|
241 | 241 | |
|
242 | 242 | if color_scheme is not None: |
|
243 | 243 | warnings.warn( |
|
244 | 244 | "The `color_scheme` argument is deprecated since version 5.1", |
|
245 | 245 | DeprecationWarning, stacklevel=2) |
|
246 | 246 | else: |
|
247 | 247 | color_scheme = self.shell.colors |
|
248 | 248 | |
|
249 | 249 | self.aliases = {} |
|
250 | 250 | |
|
251 | 251 | # Create color table: we copy the default one from the traceback |
|
252 | 252 | # module and add a few attributes needed for debugging |
|
253 | 253 | self.color_scheme_table = exception_colors() |
|
254 | 254 | |
|
255 | 255 | # shorthands |
|
256 | 256 | C = coloransi.TermColors |
|
257 | 257 | cst = self.color_scheme_table |
|
258 | 258 | |
|
259 | 259 | cst['NoColor'].colors.prompt = C.NoColor |
|
260 | 260 | cst['NoColor'].colors.breakpoint_enabled = C.NoColor |
|
261 | 261 | cst['NoColor'].colors.breakpoint_disabled = C.NoColor |
|
262 | 262 | |
|
263 | 263 | cst['Linux'].colors.prompt = C.Green |
|
264 | 264 | cst['Linux'].colors.breakpoint_enabled = C.LightRed |
|
265 | 265 | cst['Linux'].colors.breakpoint_disabled = C.Red |
|
266 | 266 | |
|
267 | 267 | cst['LightBG'].colors.prompt = C.Blue |
|
268 | 268 | cst['LightBG'].colors.breakpoint_enabled = C.LightRed |
|
269 | 269 | cst['LightBG'].colors.breakpoint_disabled = C.Red |
|
270 | 270 | |
|
271 | 271 | cst['Neutral'].colors.prompt = C.Blue |
|
272 | 272 | cst['Neutral'].colors.breakpoint_enabled = C.LightRed |
|
273 | 273 | cst['Neutral'].colors.breakpoint_disabled = C.Red |
|
274 | 274 | |
|
275 | 275 | |
|
276 | 276 | # Add a python parser so we can syntax highlight source while |
|
277 | 277 | # debugging. |
|
278 | 278 | self.parser = PyColorize.Parser(style=color_scheme) |
|
279 | 279 | self.set_colors(color_scheme) |
|
280 | 280 | |
|
281 | 281 | # Set the prompt - the default prompt is '(Pdb)' |
|
282 | 282 | self.prompt = prompt |
|
283 | 283 | self.skip_hidden = True |
|
284 | 284 | |
|
285 | 285 | def set_colors(self, scheme): |
|
286 | 286 | """Shorthand access to the color table scheme selector method.""" |
|
287 | 287 | self.color_scheme_table.set_active_scheme(scheme) |
|
288 | 288 | self.parser.style = scheme |
|
289 | 289 | |
|
290 | 290 | |
|
291 | 291 | def hidden_frames(self, stack): |
|
292 | 292 | """ |
|
293 | 293 | Given an index in the stack return wether it should be skipped. |
|
294 | 294 | |
|
295 | 295 | This is used in up/down and where to skip frames. |
|
296 | 296 | """ |
|
297 | ip_hide = [s[0].f_locals.get("__tracebackhide__", False) for s in stack] | |
|
297 | # The f_locals dictionary is updated from the actual frame | |
|
298 | # locals whenever the .f_locals accessor is called, so we | |
|
299 | # avoid calling it here to preserve self.curframe_locals. | |
|
300 | # Futhermore, there is no good reason to hide the current frame. | |
|
301 | ip_hide = [ | |
|
302 | False if s[0] is self.curframe else s[0].f_locals.get( | |
|
303 | "__tracebackhide__", False) | |
|
304 | for s in stack] | |
|
298 | 305 | ip_start = [i for i, s in enumerate(ip_hide) if s == "__ipython_bottom__"] |
|
299 | 306 | if ip_start: |
|
300 | 307 | ip_hide = [h if i > ip_start[0] else True for (i, h) in enumerate(ip_hide)] |
|
301 | 308 | return ip_hide |
|
302 | 309 | |
|
303 | 310 | def interaction(self, frame, traceback): |
|
304 | 311 | try: |
|
305 | 312 | OldPdb.interaction(self, frame, traceback) |
|
306 | 313 | except KeyboardInterrupt: |
|
307 | 314 | self.stdout.write("\n" + self.shell.get_exception_only()) |
|
308 | 315 | |
|
309 | 316 | def new_do_frame(self, arg): |
|
310 | 317 | OldPdb.do_frame(self, arg) |
|
311 | 318 | |
|
312 | 319 | def new_do_quit(self, arg): |
|
313 | 320 | |
|
314 | 321 | if hasattr(self, 'old_all_completions'): |
|
315 | 322 | self.shell.Completer.all_completions=self.old_all_completions |
|
316 | 323 | |
|
317 | 324 | return OldPdb.do_quit(self, arg) |
|
318 | 325 | |
|
319 | 326 | do_q = do_quit = decorate_fn_with_doc(new_do_quit, OldPdb.do_quit) |
|
320 | 327 | |
|
321 | 328 | def new_do_restart(self, arg): |
|
322 | 329 | """Restart command. In the context of ipython this is exactly the same |
|
323 | 330 | thing as 'quit'.""" |
|
324 | 331 | self.msg("Restart doesn't make sense here. Using 'quit' instead.") |
|
325 | 332 | return self.do_quit(arg) |
|
326 | 333 | |
|
327 | 334 | def print_stack_trace(self, context=None): |
|
328 | 335 | Colors = self.color_scheme_table.active_colors |
|
329 | 336 | ColorsNormal = Colors.Normal |
|
330 | 337 | if context is None: |
|
331 | 338 | context = self.context |
|
332 | 339 | try: |
|
333 | 340 | context=int(context) |
|
334 | 341 | if context <= 0: |
|
335 | 342 | raise ValueError("Context must be a positive integer") |
|
336 | 343 | except (TypeError, ValueError) as e: |
|
337 | 344 | raise ValueError("Context must be a positive integer") from e |
|
338 | 345 | try: |
|
339 | 346 | skipped = 0 |
|
340 | 347 | for hidden, frame_lineno in zip(self.hidden_frames(self.stack), self.stack): |
|
341 | 348 | if hidden and self.skip_hidden: |
|
342 | 349 | skipped += 1 |
|
343 | 350 | continue |
|
344 | 351 | if skipped: |
|
345 | 352 | print( |
|
346 | 353 | f"{Colors.excName} [... skipping {skipped} hidden frame(s)]{ColorsNormal}\n" |
|
347 | 354 | ) |
|
348 | 355 | skipped = 0 |
|
349 | 356 | self.print_stack_entry(frame_lineno, context=context) |
|
350 | 357 | if skipped: |
|
351 | 358 | print( |
|
352 | 359 | f"{Colors.excName} [... skipping {skipped} hidden frame(s)]{ColorsNormal}\n" |
|
353 | 360 | ) |
|
354 | 361 | except KeyboardInterrupt: |
|
355 | 362 | pass |
|
356 | 363 | |
|
357 | 364 | def print_stack_entry(self, frame_lineno, prompt_prefix='\n-> ', |
|
358 | 365 | context=None): |
|
359 | 366 | if context is None: |
|
360 | 367 | context = self.context |
|
361 | 368 | try: |
|
362 | 369 | context=int(context) |
|
363 | 370 | if context <= 0: |
|
364 | 371 | raise ValueError("Context must be a positive integer") |
|
365 | 372 | except (TypeError, ValueError) as e: |
|
366 | 373 | raise ValueError("Context must be a positive integer") from e |
|
367 | 374 | print(self.format_stack_entry(frame_lineno, '', context), file=self.stdout) |
|
368 | 375 | |
|
369 | 376 | # vds: >> |
|
370 | 377 | frame, lineno = frame_lineno |
|
371 | 378 | filename = frame.f_code.co_filename |
|
372 | 379 | self.shell.hooks.synchronize_with_editor(filename, lineno, 0) |
|
373 | 380 | # vds: << |
|
374 | 381 | |
|
375 | 382 | def format_stack_entry(self, frame_lineno, lprefix=': ', context=None): |
|
376 | 383 | if context is None: |
|
377 | 384 | context = self.context |
|
378 | 385 | try: |
|
379 | 386 | context=int(context) |
|
380 | 387 | if context <= 0: |
|
381 | 388 | print("Context must be a positive integer", file=self.stdout) |
|
382 | 389 | except (TypeError, ValueError): |
|
383 | 390 | print("Context must be a positive integer", file=self.stdout) |
|
384 | 391 | |
|
385 | 392 | import reprlib |
|
386 | 393 | |
|
387 | 394 | ret = [] |
|
388 | 395 | |
|
389 | 396 | Colors = self.color_scheme_table.active_colors |
|
390 | 397 | ColorsNormal = Colors.Normal |
|
391 | 398 | tpl_link = u'%s%%s%s' % (Colors.filenameEm, ColorsNormal) |
|
392 | 399 | tpl_call = u'%s%%s%s%%s%s' % (Colors.vName, Colors.valEm, ColorsNormal) |
|
393 | 400 | tpl_line = u'%%s%s%%s %s%%s' % (Colors.lineno, ColorsNormal) |
|
394 | 401 | tpl_line_em = u'%%s%s%%s %s%%s%s' % (Colors.linenoEm, Colors.line, |
|
395 | 402 | ColorsNormal) |
|
396 | 403 | |
|
397 | 404 | frame, lineno = frame_lineno |
|
398 | 405 | |
|
399 | 406 | return_value = '' |
|
400 | 407 | if '__return__' in frame.f_locals: |
|
401 | 408 | rv = frame.f_locals['__return__'] |
|
402 | 409 | #return_value += '->' |
|
403 | 410 | return_value += reprlib.repr(rv) + '\n' |
|
404 | 411 | ret.append(return_value) |
|
405 | 412 | |
|
406 | 413 | #s = filename + '(' + `lineno` + ')' |
|
407 | 414 | filename = self.canonic(frame.f_code.co_filename) |
|
408 | 415 | link = tpl_link % py3compat.cast_unicode(filename) |
|
409 | 416 | |
|
410 | 417 | if frame.f_code.co_name: |
|
411 | 418 | func = frame.f_code.co_name |
|
412 | 419 | else: |
|
413 | 420 | func = "<lambda>" |
|
414 | 421 | |
|
415 | 422 | call = '' |
|
416 | 423 | if func != '?': |
|
417 | 424 | if '__args__' in frame.f_locals: |
|
418 | 425 | args = reprlib.repr(frame.f_locals['__args__']) |
|
419 | 426 | else: |
|
420 | 427 | args = '()' |
|
421 | 428 | call = tpl_call % (func, args) |
|
422 | 429 | |
|
423 | 430 | # The level info should be generated in the same format pdb uses, to |
|
424 | 431 | # avoid breaking the pdbtrack functionality of python-mode in *emacs. |
|
425 | 432 | if frame is self.curframe: |
|
426 | 433 | ret.append('> ') |
|
427 | 434 | else: |
|
428 | 435 | ret.append(' ') |
|
429 | 436 | ret.append(u'%s(%s)%s\n' % (link,lineno,call)) |
|
430 | 437 | |
|
431 | 438 | start = lineno - 1 - context//2 |
|
432 | 439 | lines = linecache.getlines(filename) |
|
433 | 440 | start = min(start, len(lines) - context) |
|
434 | 441 | start = max(start, 0) |
|
435 | 442 | lines = lines[start : start + context] |
|
436 | 443 | |
|
437 | 444 | for i,line in enumerate(lines): |
|
438 | 445 | show_arrow = (start + 1 + i == lineno) |
|
439 | 446 | linetpl = (frame is self.curframe or show_arrow) \ |
|
440 | 447 | and tpl_line_em \ |
|
441 | 448 | or tpl_line |
|
442 | 449 | ret.append(self.__format_line(linetpl, filename, |
|
443 | 450 | start + 1 + i, line, |
|
444 | 451 | arrow = show_arrow) ) |
|
445 | 452 | return ''.join(ret) |
|
446 | 453 | |
|
447 | 454 | def __format_line(self, tpl_line, filename, lineno, line, arrow = False): |
|
448 | 455 | bp_mark = "" |
|
449 | 456 | bp_mark_color = "" |
|
450 | 457 | |
|
451 | 458 | new_line, err = self.parser.format2(line, 'str') |
|
452 | 459 | if not err: |
|
453 | 460 | line = new_line |
|
454 | 461 | |
|
455 | 462 | bp = None |
|
456 | 463 | if lineno in self.get_file_breaks(filename): |
|
457 | 464 | bps = self.get_breaks(filename, lineno) |
|
458 | 465 | bp = bps[-1] |
|
459 | 466 | |
|
460 | 467 | if bp: |
|
461 | 468 | Colors = self.color_scheme_table.active_colors |
|
462 | 469 | bp_mark = str(bp.number) |
|
463 | 470 | bp_mark_color = Colors.breakpoint_enabled |
|
464 | 471 | if not bp.enabled: |
|
465 | 472 | bp_mark_color = Colors.breakpoint_disabled |
|
466 | 473 | |
|
467 | 474 | numbers_width = 7 |
|
468 | 475 | if arrow: |
|
469 | 476 | # This is the line with the error |
|
470 | 477 | pad = numbers_width - len(str(lineno)) - len(bp_mark) |
|
471 | 478 | num = '%s%s' % (make_arrow(pad), str(lineno)) |
|
472 | 479 | else: |
|
473 | 480 | num = '%*s' % (numbers_width - len(bp_mark), str(lineno)) |
|
474 | 481 | |
|
475 | 482 | return tpl_line % (bp_mark_color + bp_mark, num, line) |
|
476 | 483 | |
|
477 | 484 | |
|
478 | 485 | def print_list_lines(self, filename, first, last): |
|
479 | 486 | """The printing (as opposed to the parsing part of a 'list' |
|
480 | 487 | command.""" |
|
481 | 488 | try: |
|
482 | 489 | Colors = self.color_scheme_table.active_colors |
|
483 | 490 | ColorsNormal = Colors.Normal |
|
484 | 491 | tpl_line = '%%s%s%%s %s%%s' % (Colors.lineno, ColorsNormal) |
|
485 | 492 | tpl_line_em = '%%s%s%%s %s%%s%s' % (Colors.linenoEm, Colors.line, ColorsNormal) |
|
486 | 493 | src = [] |
|
487 | 494 | if filename == "<string>" and hasattr(self, "_exec_filename"): |
|
488 | 495 | filename = self._exec_filename |
|
489 | 496 | |
|
490 | 497 | for lineno in range(first, last+1): |
|
491 | 498 | line = linecache.getline(filename, lineno) |
|
492 | 499 | if not line: |
|
493 | 500 | break |
|
494 | 501 | |
|
495 | 502 | if lineno == self.curframe.f_lineno: |
|
496 | 503 | line = self.__format_line(tpl_line_em, filename, lineno, line, arrow = True) |
|
497 | 504 | else: |
|
498 | 505 | line = self.__format_line(tpl_line, filename, lineno, line, arrow = False) |
|
499 | 506 | |
|
500 | 507 | src.append(line) |
|
501 | 508 | self.lineno = lineno |
|
502 | 509 | |
|
503 | 510 | print(''.join(src), file=self.stdout) |
|
504 | 511 | |
|
505 | 512 | except KeyboardInterrupt: |
|
506 | 513 | pass |
|
507 | 514 | |
|
508 | 515 | def do_skip_hidden(self, arg): |
|
509 | 516 | """ |
|
510 | 517 | Change whether or not we should skip frames with the |
|
511 | 518 | __tracebackhide__ attribute. |
|
512 | 519 | """ |
|
513 | 520 | if arg.strip().lower() in ("true", "yes"): |
|
514 | 521 | self.skip_hidden = True |
|
515 | 522 | elif arg.strip().lower() in ("false", "no"): |
|
516 | 523 | self.skip_hidden = False |
|
517 | 524 | |
|
518 | 525 | def do_list(self, arg): |
|
519 | 526 | """Print lines of code from the current stack frame |
|
520 | 527 | """ |
|
521 | 528 | self.lastcmd = 'list' |
|
522 | 529 | last = None |
|
523 | 530 | if arg: |
|
524 | 531 | try: |
|
525 | 532 | x = eval(arg, {}, {}) |
|
526 | 533 | if type(x) == type(()): |
|
527 | 534 | first, last = x |
|
528 | 535 | first = int(first) |
|
529 | 536 | last = int(last) |
|
530 | 537 | if last < first: |
|
531 | 538 | # Assume it's a count |
|
532 | 539 | last = first + last |
|
533 | 540 | else: |
|
534 | 541 | first = max(1, int(x) - 5) |
|
535 | 542 | except: |
|
536 | 543 | print('*** Error in argument:', repr(arg), file=self.stdout) |
|
537 | 544 | return |
|
538 | 545 | elif self.lineno is None: |
|
539 | 546 | first = max(1, self.curframe.f_lineno - 5) |
|
540 | 547 | else: |
|
541 | 548 | first = self.lineno + 1 |
|
542 | 549 | if last is None: |
|
543 | 550 | last = first + 10 |
|
544 | 551 | self.print_list_lines(self.curframe.f_code.co_filename, first, last) |
|
545 | 552 | |
|
546 | 553 | # vds: >> |
|
547 | 554 | lineno = first |
|
548 | 555 | filename = self.curframe.f_code.co_filename |
|
549 | 556 | self.shell.hooks.synchronize_with_editor(filename, lineno, 0) |
|
550 | 557 | # vds: << |
|
551 | 558 | |
|
552 | 559 | do_l = do_list |
|
553 | 560 | |
|
554 | 561 | def getsourcelines(self, obj): |
|
555 | 562 | lines, lineno = inspect.findsource(obj) |
|
556 | 563 | if inspect.isframe(obj) and obj.f_globals is obj.f_locals: |
|
557 | 564 | # must be a module frame: do not try to cut a block out of it |
|
558 | 565 | return lines, 1 |
|
559 | 566 | elif inspect.ismodule(obj): |
|
560 | 567 | return lines, 1 |
|
561 | 568 | return inspect.getblock(lines[lineno:]), lineno+1 |
|
562 | 569 | |
|
563 | 570 | def do_longlist(self, arg): |
|
564 | 571 | """Print lines of code from the current stack frame. |
|
565 | 572 | |
|
566 | 573 | Shows more lines than 'list' does. |
|
567 | 574 | """ |
|
568 | 575 | self.lastcmd = 'longlist' |
|
569 | 576 | try: |
|
570 | 577 | lines, lineno = self.getsourcelines(self.curframe) |
|
571 | 578 | except OSError as err: |
|
572 | 579 | self.error(err) |
|
573 | 580 | return |
|
574 | 581 | last = lineno + len(lines) |
|
575 | 582 | self.print_list_lines(self.curframe.f_code.co_filename, lineno, last) |
|
576 | 583 | do_ll = do_longlist |
|
577 | 584 | |
|
578 | 585 | def do_debug(self, arg): |
|
579 | 586 | """debug code |
|
580 | 587 | Enter a recursive debugger that steps through the code |
|
581 | 588 | argument (which is an arbitrary expression or statement to be |
|
582 | 589 | executed in the current environment). |
|
583 | 590 | """ |
|
584 | 591 | sys.settrace(None) |
|
585 | 592 | globals = self.curframe.f_globals |
|
586 | 593 | locals = self.curframe_locals |
|
587 | 594 | p = self.__class__(completekey=self.completekey, |
|
588 | 595 | stdin=self.stdin, stdout=self.stdout) |
|
589 | 596 | p.use_rawinput = self.use_rawinput |
|
590 | 597 | p.prompt = "(%s) " % self.prompt.strip() |
|
591 | 598 | self.message("ENTERING RECURSIVE DEBUGGER") |
|
592 | 599 | sys.call_tracing(p.run, (arg, globals, locals)) |
|
593 | 600 | self.message("LEAVING RECURSIVE DEBUGGER") |
|
594 | 601 | sys.settrace(self.trace_dispatch) |
|
595 | 602 | self.lastcmd = p.lastcmd |
|
596 | 603 | |
|
597 | 604 | def do_pdef(self, arg): |
|
598 | 605 | """Print the call signature for any callable object. |
|
599 | 606 | |
|
600 | 607 | The debugger interface to %pdef""" |
|
601 | 608 | namespaces = [('Locals', self.curframe.f_locals), |
|
602 | 609 | ('Globals', self.curframe.f_globals)] |
|
603 | 610 | self.shell.find_line_magic('pdef')(arg, namespaces=namespaces) |
|
604 | 611 | |
|
605 | 612 | def do_pdoc(self, arg): |
|
606 | 613 | """Print the docstring for an object. |
|
607 | 614 | |
|
608 | 615 | The debugger interface to %pdoc.""" |
|
609 | 616 | namespaces = [('Locals', self.curframe.f_locals), |
|
610 | 617 | ('Globals', self.curframe.f_globals)] |
|
611 | 618 | self.shell.find_line_magic('pdoc')(arg, namespaces=namespaces) |
|
612 | 619 | |
|
613 | 620 | def do_pfile(self, arg): |
|
614 | 621 | """Print (or run through pager) the file where an object is defined. |
|
615 | 622 | |
|
616 | 623 | The debugger interface to %pfile. |
|
617 | 624 | """ |
|
618 | 625 | namespaces = [('Locals', self.curframe.f_locals), |
|
619 | 626 | ('Globals', self.curframe.f_globals)] |
|
620 | 627 | self.shell.find_line_magic('pfile')(arg, namespaces=namespaces) |
|
621 | 628 | |
|
622 | 629 | def do_pinfo(self, arg): |
|
623 | 630 | """Provide detailed information about an object. |
|
624 | 631 | |
|
625 | 632 | The debugger interface to %pinfo, i.e., obj?.""" |
|
626 | 633 | namespaces = [('Locals', self.curframe.f_locals), |
|
627 | 634 | ('Globals', self.curframe.f_globals)] |
|
628 | 635 | self.shell.find_line_magic('pinfo')(arg, namespaces=namespaces) |
|
629 | 636 | |
|
630 | 637 | def do_pinfo2(self, arg): |
|
631 | 638 | """Provide extra detailed information about an object. |
|
632 | 639 | |
|
633 | 640 | The debugger interface to %pinfo2, i.e., obj??.""" |
|
634 | 641 | namespaces = [('Locals', self.curframe.f_locals), |
|
635 | 642 | ('Globals', self.curframe.f_globals)] |
|
636 | 643 | self.shell.find_line_magic('pinfo2')(arg, namespaces=namespaces) |
|
637 | 644 | |
|
638 | 645 | def do_psource(self, arg): |
|
639 | 646 | """Print (or run through pager) the source code for an object.""" |
|
640 | 647 | namespaces = [('Locals', self.curframe.f_locals), |
|
641 | 648 | ('Globals', self.curframe.f_globals)] |
|
642 | 649 | self.shell.find_line_magic('psource')(arg, namespaces=namespaces) |
|
643 | 650 | |
|
644 | 651 | def do_where(self, arg): |
|
645 | 652 | """w(here) |
|
646 | 653 | Print a stack trace, with the most recent frame at the bottom. |
|
647 | 654 | An arrow indicates the "current frame", which determines the |
|
648 | 655 | context of most commands. 'bt' is an alias for this command. |
|
649 | 656 | |
|
650 | 657 | Take a number as argument as an (optional) number of context line to |
|
651 | 658 | print""" |
|
652 | 659 | if arg: |
|
653 | 660 | try: |
|
654 | 661 | context = int(arg) |
|
655 | 662 | except ValueError as err: |
|
656 | 663 | self.error(err) |
|
657 | 664 | return |
|
658 | 665 | self.print_stack_trace(context) |
|
659 | 666 | else: |
|
660 | 667 | self.print_stack_trace() |
|
661 | 668 | |
|
662 | 669 | do_w = do_where |
|
663 | 670 | |
|
664 | 671 | def stop_here(self, frame): |
|
665 | 672 | hidden = False |
|
666 | 673 | if self.skip_hidden: |
|
667 | 674 | hidden = frame.f_locals.get("__tracebackhide__", False) |
|
668 | 675 | if hidden: |
|
669 | 676 | Colors = self.color_scheme_table.active_colors |
|
670 | 677 | ColorsNormal = Colors.Normal |
|
671 | 678 | print(f"{Colors.excName} [... skipped 1 hidden frame]{ColorsNormal}\n") |
|
672 | 679 | |
|
673 | 680 | return super().stop_here(frame) |
|
674 | 681 | |
|
675 | 682 | def do_up(self, arg): |
|
676 | 683 | """u(p) [count] |
|
677 | 684 | Move the current frame count (default one) levels up in the |
|
678 | 685 | stack trace (to an older frame). |
|
679 | 686 | |
|
680 | 687 | Will skip hidden frames. |
|
681 | 688 | """ |
|
682 | 689 | ## modified version of upstream that skips |
|
683 | 690 | # frames with __tracebackide__ |
|
684 | 691 | if self.curindex == 0: |
|
685 | 692 | self.error("Oldest frame") |
|
686 | 693 | return |
|
687 | 694 | try: |
|
688 | 695 | count = int(arg or 1) |
|
689 | 696 | except ValueError: |
|
690 | 697 | self.error("Invalid frame count (%s)" % arg) |
|
691 | 698 | return |
|
692 | 699 | skipped = 0 |
|
693 | 700 | if count < 0: |
|
694 | 701 | _newframe = 0 |
|
695 | 702 | else: |
|
696 | 703 | _newindex = self.curindex |
|
697 | 704 | counter = 0 |
|
698 | 705 | hidden_frames = self.hidden_frames(self.stack) |
|
699 | 706 | for i in range(self.curindex - 1, -1, -1): |
|
700 | 707 | frame = self.stack[i][0] |
|
701 | 708 | if hidden_frames[i] and self.skip_hidden: |
|
702 | 709 | skipped += 1 |
|
703 | 710 | continue |
|
704 | 711 | counter += 1 |
|
705 | 712 | if counter >= count: |
|
706 | 713 | break |
|
707 | 714 | else: |
|
708 | 715 | # if no break occured. |
|
709 | 716 | self.error("all frames above hidden") |
|
710 | 717 | return |
|
711 | 718 | |
|
712 | 719 | Colors = self.color_scheme_table.active_colors |
|
713 | 720 | ColorsNormal = Colors.Normal |
|
714 | 721 | _newframe = i |
|
715 | 722 | self._select_frame(_newframe) |
|
716 | 723 | if skipped: |
|
717 | 724 | print( |
|
718 | 725 | f"{Colors.excName} [... skipped {skipped} hidden frame(s)]{ColorsNormal}\n" |
|
719 | 726 | ) |
|
720 | 727 | |
|
721 | 728 | def do_down(self, arg): |
|
722 | 729 | """d(own) [count] |
|
723 | 730 | Move the current frame count (default one) levels down in the |
|
724 | 731 | stack trace (to a newer frame). |
|
725 | 732 | |
|
726 | 733 | Will skip hidden frames. |
|
727 | 734 | """ |
|
728 | 735 | if self.curindex + 1 == len(self.stack): |
|
729 | 736 | self.error("Newest frame") |
|
730 | 737 | return |
|
731 | 738 | try: |
|
732 | 739 | count = int(arg or 1) |
|
733 | 740 | except ValueError: |
|
734 | 741 | self.error("Invalid frame count (%s)" % arg) |
|
735 | 742 | return |
|
736 | 743 | if count < 0: |
|
737 | 744 | _newframe = len(self.stack) - 1 |
|
738 | 745 | else: |
|
739 | 746 | _newindex = self.curindex |
|
740 | 747 | counter = 0 |
|
741 | 748 | skipped = 0 |
|
742 | 749 | hidden_frames = self.hidden_frames(self.stack) |
|
743 | 750 | for i in range(self.curindex + 1, len(self.stack)): |
|
744 | 751 | frame = self.stack[i][0] |
|
745 | 752 | if hidden_frames[i] and self.skip_hidden: |
|
746 | 753 | skipped += 1 |
|
747 | 754 | continue |
|
748 | 755 | counter += 1 |
|
749 | 756 | if counter >= count: |
|
750 | 757 | break |
|
751 | 758 | else: |
|
752 | 759 | self.error("all frames bellow hidden") |
|
753 | 760 | return |
|
754 | 761 | |
|
755 | 762 | Colors = self.color_scheme_table.active_colors |
|
756 | 763 | ColorsNormal = Colors.Normal |
|
757 | 764 | if skipped: |
|
758 | 765 | print( |
|
759 | 766 | f"{Colors.excName} [... skipped {skipped} hidden frame(s)]{ColorsNormal}\n" |
|
760 | 767 | ) |
|
761 | 768 | _newframe = i |
|
762 | 769 | |
|
763 | 770 | self._select_frame(_newframe) |
|
764 | 771 | |
|
765 | 772 | do_d = do_down |
|
766 | 773 | do_u = do_up |
|
767 | 774 | |
|
768 | 775 | class InterruptiblePdb(Pdb): |
|
769 | 776 | """Version of debugger where KeyboardInterrupt exits the debugger altogether.""" |
|
770 | 777 | |
|
771 | 778 | def cmdloop(self): |
|
772 | 779 | """Wrap cmdloop() such that KeyboardInterrupt stops the debugger.""" |
|
773 | 780 | try: |
|
774 | 781 | return OldPdb.cmdloop(self) |
|
775 | 782 | except KeyboardInterrupt: |
|
776 | 783 | self.stop_here = lambda frame: False |
|
777 | 784 | self.do_quit("") |
|
778 | 785 | sys.settrace(None) |
|
779 | 786 | self.quitting = False |
|
780 | 787 | raise |
|
781 | 788 | |
|
782 | 789 | def _cmdloop(self): |
|
783 | 790 | while True: |
|
784 | 791 | try: |
|
785 | 792 | # keyboard interrupts allow for an easy way to cancel |
|
786 | 793 | # the current command, so allow them during interactive input |
|
787 | 794 | self.allow_kbdint = True |
|
788 | 795 | self.cmdloop() |
|
789 | 796 | self.allow_kbdint = False |
|
790 | 797 | break |
|
791 | 798 | except KeyboardInterrupt: |
|
792 | 799 | self.message('--KeyboardInterrupt--') |
|
793 | 800 | raise |
|
794 | 801 | |
|
795 | 802 | |
|
796 | 803 | def set_trace(frame=None): |
|
797 | 804 | """ |
|
798 | 805 | Start debugging from `frame`. |
|
799 | 806 | |
|
800 | 807 | If frame is not specified, debugging starts from caller's frame. |
|
801 | 808 | """ |
|
802 | 809 | Pdb().set_trace(frame or sys._getframe().f_back) |
@@ -1,645 +1,646 b'' | |||
|
1 | 1 | """IPython terminal interface using prompt_toolkit""" |
|
2 | 2 | |
|
3 | 3 | import asyncio |
|
4 | 4 | import os |
|
5 | 5 | import sys |
|
6 | 6 | import warnings |
|
7 | 7 | from warnings import warn |
|
8 | 8 | |
|
9 | 9 | from IPython.core.interactiveshell import InteractiveShell, InteractiveShellABC |
|
10 | 10 | from IPython.utils import io |
|
11 | 11 | from IPython.utils.py3compat import input |
|
12 | 12 | from IPython.utils.terminal import toggle_set_term_title, set_term_title, restore_term_title |
|
13 | 13 | from IPython.utils.process import abbrev_cwd |
|
14 | 14 | from traitlets import ( |
|
15 | 15 | Bool, Unicode, Dict, Integer, observe, Instance, Type, default, Enum, Union, |
|
16 | 16 | Any, validate |
|
17 | 17 | ) |
|
18 | 18 | |
|
19 | 19 | from prompt_toolkit.enums import DEFAULT_BUFFER, EditingMode |
|
20 | 20 | from prompt_toolkit.filters import (HasFocus, Condition, IsDone) |
|
21 | 21 | from prompt_toolkit.formatted_text import PygmentsTokens |
|
22 | 22 | from prompt_toolkit.history import InMemoryHistory |
|
23 | 23 | from prompt_toolkit.layout.processors import ConditionalProcessor, HighlightMatchingBracketProcessor |
|
24 | 24 | from prompt_toolkit.output import ColorDepth |
|
25 | 25 | from prompt_toolkit.patch_stdout import patch_stdout |
|
26 | 26 | from prompt_toolkit.shortcuts import PromptSession, CompleteStyle, print_formatted_text |
|
27 | 27 | from prompt_toolkit.styles import DynamicStyle, merge_styles |
|
28 | 28 | from prompt_toolkit.styles.pygments import style_from_pygments_cls, style_from_pygments_dict |
|
29 | 29 | from prompt_toolkit import __version__ as ptk_version |
|
30 | 30 | |
|
31 | 31 | from pygments.styles import get_style_by_name |
|
32 | 32 | from pygments.style import Style |
|
33 | 33 | from pygments.token import Token |
|
34 | 34 | |
|
35 | 35 | from .debugger import TerminalPdb, Pdb |
|
36 | 36 | from .magics import TerminalMagics |
|
37 | 37 | from .pt_inputhooks import get_inputhook_name_and_func |
|
38 | 38 | from .prompts import Prompts, ClassicPrompts, RichPromptDisplayHook |
|
39 | 39 | from .ptutils import IPythonPTCompleter, IPythonPTLexer |
|
40 | 40 | from .shortcuts import create_ipython_shortcuts |
|
41 | 41 | |
|
42 | 42 | DISPLAY_BANNER_DEPRECATED = object() |
|
43 | 43 | PTK3 = ptk_version.startswith('3.') |
|
44 | 44 | |
|
45 | 45 | |
|
46 | 46 | class _NoStyle(Style): pass |
|
47 | 47 | |
|
48 | 48 | |
|
49 | 49 | |
|
50 | 50 | _style_overrides_light_bg = { |
|
51 | 51 | Token.Prompt: '#ansibrightblue', |
|
52 | 52 | Token.PromptNum: '#ansiblue bold', |
|
53 | 53 | Token.OutPrompt: '#ansibrightred', |
|
54 | 54 | Token.OutPromptNum: '#ansired bold', |
|
55 | 55 | } |
|
56 | 56 | |
|
57 | 57 | _style_overrides_linux = { |
|
58 | 58 | Token.Prompt: '#ansibrightgreen', |
|
59 | 59 | Token.PromptNum: '#ansigreen bold', |
|
60 | 60 | Token.OutPrompt: '#ansibrightred', |
|
61 | 61 | Token.OutPromptNum: '#ansired bold', |
|
62 | 62 | } |
|
63 | 63 | |
|
64 | 64 | def get_default_editor(): |
|
65 | 65 | try: |
|
66 | 66 | return os.environ['EDITOR'] |
|
67 | 67 | except KeyError: |
|
68 | 68 | pass |
|
69 | 69 | except UnicodeError: |
|
70 | 70 | warn("$EDITOR environment variable is not pure ASCII. Using platform " |
|
71 | 71 | "default editor.") |
|
72 | 72 | |
|
73 | 73 | if os.name == 'posix': |
|
74 | 74 | return 'vi' # the only one guaranteed to be there! |
|
75 | 75 | else: |
|
76 | 76 | return 'notepad' # same in Windows! |
|
77 | 77 | |
|
78 | 78 | # conservatively check for tty |
|
79 | 79 | # overridden streams can result in things like: |
|
80 | 80 | # - sys.stdin = None |
|
81 | 81 | # - no isatty method |
|
82 | 82 | for _name in ('stdin', 'stdout', 'stderr'): |
|
83 | 83 | _stream = getattr(sys, _name) |
|
84 | 84 | if not _stream or not hasattr(_stream, 'isatty') or not _stream.isatty(): |
|
85 | 85 | _is_tty = False |
|
86 | 86 | break |
|
87 | 87 | else: |
|
88 | 88 | _is_tty = True |
|
89 | 89 | |
|
90 | 90 | |
|
91 | 91 | _use_simple_prompt = ('IPY_TEST_SIMPLE_PROMPT' in os.environ) or (not _is_tty) |
|
92 | 92 | |
|
93 | 93 | def black_reformat_handler(text_before_cursor): |
|
94 | 94 | import black |
|
95 | 95 | formatted_text = black.format_str(text_before_cursor, mode=black.FileMode()) |
|
96 | 96 | if not text_before_cursor.endswith('\n') and formatted_text.endswith('\n'): |
|
97 | 97 | formatted_text = formatted_text[:-1] |
|
98 | 98 | return formatted_text |
|
99 | 99 | |
|
100 | 100 | |
|
101 | 101 | class TerminalInteractiveShell(InteractiveShell): |
|
102 | 102 | mime_renderers = Dict().tag(config=True) |
|
103 | 103 | |
|
104 | 104 | space_for_menu = Integer(6, help='Number of line at the bottom of the screen ' |
|
105 | 105 | 'to reserve for the tab completion menu, ' |
|
106 | 106 | 'search history, ...etc, the height of ' |
|
107 | 107 | 'these menus will at most this value. ' |
|
108 | 108 | 'Increase it is you prefer long and skinny ' |
|
109 | 109 | 'menus, decrease for short and wide.' |
|
110 | 110 | ).tag(config=True) |
|
111 | 111 | |
|
112 | 112 | pt_app = None |
|
113 | 113 | debugger_history = None |
|
114 | 114 | |
|
115 | 115 | simple_prompt = Bool(_use_simple_prompt, |
|
116 | 116 | help="""Use `raw_input` for the REPL, without completion and prompt colors. |
|
117 | 117 | |
|
118 | 118 | Useful when controlling IPython as a subprocess, and piping STDIN/OUT/ERR. Known usage are: |
|
119 | 119 | IPython own testing machinery, and emacs inferior-shell integration through elpy. |
|
120 | 120 | |
|
121 | 121 | This mode default to `True` if the `IPY_TEST_SIMPLE_PROMPT` |
|
122 | 122 | environment variable is set, or the current terminal is not a tty.""" |
|
123 | 123 | ).tag(config=True) |
|
124 | 124 | |
|
125 | 125 | @property |
|
126 | 126 | def debugger_cls(self): |
|
127 | 127 | return Pdb if self.simple_prompt else TerminalPdb |
|
128 | 128 | |
|
129 | 129 | confirm_exit = Bool(True, |
|
130 | 130 | help=""" |
|
131 | 131 | Set to confirm when you try to exit IPython with an EOF (Control-D |
|
132 | 132 | in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit', |
|
133 | 133 | you can force a direct exit without any confirmation.""", |
|
134 | 134 | ).tag(config=True) |
|
135 | 135 | |
|
136 | 136 | editing_mode = Unicode('emacs', |
|
137 | 137 | help="Shortcut style to use at the prompt. 'vi' or 'emacs'.", |
|
138 | 138 | ).tag(config=True) |
|
139 | 139 | |
|
140 | 140 | autoformatter = Unicode(None, |
|
141 | 141 | help="Autoformatter to reformat Terminal code. Can be `'black'` or `None`", |
|
142 | 142 | allow_none=True |
|
143 | 143 | ).tag(config=True) |
|
144 | 144 | |
|
145 | 145 | mouse_support = Bool(False, |
|
146 | 146 | help="Enable mouse support in the prompt\n(Note: prevents selecting text with the mouse)" |
|
147 | 147 | ).tag(config=True) |
|
148 | 148 | |
|
149 | 149 | # We don't load the list of styles for the help string, because loading |
|
150 | 150 | # Pygments plugins takes time and can cause unexpected errors. |
|
151 | 151 | highlighting_style = Union([Unicode('legacy'), Type(klass=Style)], |
|
152 | 152 | help="""The name or class of a Pygments style to use for syntax |
|
153 | 153 | highlighting. To see available styles, run `pygmentize -L styles`.""" |
|
154 | 154 | ).tag(config=True) |
|
155 | 155 | |
|
156 | 156 | @validate('editing_mode') |
|
157 | 157 | def _validate_editing_mode(self, proposal): |
|
158 | 158 | if proposal['value'].lower() == 'vim': |
|
159 | 159 | proposal['value']= 'vi' |
|
160 | 160 | elif proposal['value'].lower() == 'default': |
|
161 | 161 | proposal['value']= 'emacs' |
|
162 | 162 | |
|
163 | 163 | if hasattr(EditingMode, proposal['value'].upper()): |
|
164 | 164 | return proposal['value'].lower() |
|
165 | 165 | |
|
166 | 166 | return self.editing_mode |
|
167 | 167 | |
|
168 | 168 | |
|
169 | 169 | @observe('editing_mode') |
|
170 | 170 | def _editing_mode(self, change): |
|
171 | 171 | u_mode = change.new.upper() |
|
172 | 172 | if self.pt_app: |
|
173 | 173 | self.pt_app.editing_mode = u_mode |
|
174 | 174 | |
|
175 | 175 | @observe('autoformatter') |
|
176 | 176 | def _autoformatter_changed(self, change): |
|
177 | 177 | formatter = change.new |
|
178 | 178 | if formatter is None: |
|
179 | 179 | self.reformat_handler = lambda x:x |
|
180 | 180 | elif formatter == 'black': |
|
181 | 181 | self.reformat_handler = black_reformat_handler |
|
182 | 182 | else: |
|
183 | 183 | raise ValueError |
|
184 | 184 | |
|
185 | 185 | @observe('highlighting_style') |
|
186 | 186 | @observe('colors') |
|
187 | 187 | def _highlighting_style_changed(self, change): |
|
188 | 188 | self.refresh_style() |
|
189 | 189 | |
|
190 | 190 | def refresh_style(self): |
|
191 | 191 | self._style = self._make_style_from_name_or_cls(self.highlighting_style) |
|
192 | 192 | |
|
193 | 193 | |
|
194 | 194 | highlighting_style_overrides = Dict( |
|
195 | 195 | help="Override highlighting format for specific tokens" |
|
196 | 196 | ).tag(config=True) |
|
197 | 197 | |
|
198 | 198 | true_color = Bool(False, |
|
199 | 199 | help=("Use 24bit colors instead of 256 colors in prompt highlighting. " |
|
200 | 200 | "If your terminal supports true color, the following command " |
|
201 | 201 | "should print 'TRUECOLOR' in orange: " |
|
202 | 202 | "printf \"\\x1b[38;2;255;100;0mTRUECOLOR\\x1b[0m\\n\"") |
|
203 | 203 | ).tag(config=True) |
|
204 | 204 | |
|
205 | 205 | editor = Unicode(get_default_editor(), |
|
206 | 206 | help="Set the editor used by IPython (default to $EDITOR/vi/notepad)." |
|
207 | 207 | ).tag(config=True) |
|
208 | 208 | |
|
209 | 209 | prompts_class = Type(Prompts, help='Class used to generate Prompt token for prompt_toolkit').tag(config=True) |
|
210 | 210 | |
|
211 | 211 | prompts = Instance(Prompts) |
|
212 | 212 | |
|
213 | 213 | @default('prompts') |
|
214 | 214 | def _prompts_default(self): |
|
215 | 215 | return self.prompts_class(self) |
|
216 | 216 | |
|
217 | 217 | # @observe('prompts') |
|
218 | 218 | # def _(self, change): |
|
219 | 219 | # self._update_layout() |
|
220 | 220 | |
|
221 | 221 | @default('displayhook_class') |
|
222 | 222 | def _displayhook_class_default(self): |
|
223 | 223 | return RichPromptDisplayHook |
|
224 | 224 | |
|
225 | 225 | term_title = Bool(True, |
|
226 | 226 | help="Automatically set the terminal title" |
|
227 | 227 | ).tag(config=True) |
|
228 | 228 | |
|
229 | 229 | term_title_format = Unicode("IPython: {cwd}", |
|
230 | 230 | help="Customize the terminal title format. This is a python format string. " + |
|
231 | 231 | "Available substitutions are: {cwd}." |
|
232 | 232 | ).tag(config=True) |
|
233 | 233 | |
|
234 | 234 | display_completions = Enum(('column', 'multicolumn','readlinelike'), |
|
235 | 235 | help= ( "Options for displaying tab completions, 'column', 'multicolumn', and " |
|
236 | 236 | "'readlinelike'. These options are for `prompt_toolkit`, see " |
|
237 | 237 | "`prompt_toolkit` documentation for more information." |
|
238 | 238 | ), |
|
239 | 239 | default_value='multicolumn').tag(config=True) |
|
240 | 240 | |
|
241 | 241 | highlight_matching_brackets = Bool(True, |
|
242 | 242 | help="Highlight matching brackets.", |
|
243 | 243 | ).tag(config=True) |
|
244 | 244 | |
|
245 | 245 | extra_open_editor_shortcuts = Bool(False, |
|
246 | 246 | help="Enable vi (v) or Emacs (C-X C-E) shortcuts to open an external editor. " |
|
247 | 247 | "This is in addition to the F2 binding, which is always enabled." |
|
248 | 248 | ).tag(config=True) |
|
249 | 249 | |
|
250 | 250 | handle_return = Any(None, |
|
251 | 251 | help="Provide an alternative handler to be called when the user presses " |
|
252 | 252 | "Return. This is an advanced option intended for debugging, which " |
|
253 | 253 | "may be changed or removed in later releases." |
|
254 | 254 | ).tag(config=True) |
|
255 | 255 | |
|
256 | 256 | enable_history_search = Bool(True, |
|
257 | 257 | help="Allows to enable/disable the prompt toolkit history search" |
|
258 | 258 | ).tag(config=True) |
|
259 | 259 | |
|
260 | 260 | prompt_includes_vi_mode = Bool(True, |
|
261 | 261 | help="Display the current vi mode (when using vi editing mode)." |
|
262 | 262 | ).tag(config=True) |
|
263 | 263 | |
|
264 | 264 | @observe('term_title') |
|
265 | 265 | def init_term_title(self, change=None): |
|
266 | 266 | # Enable or disable the terminal title. |
|
267 | 267 | if self.term_title: |
|
268 | 268 | toggle_set_term_title(True) |
|
269 | 269 | set_term_title(self.term_title_format.format(cwd=abbrev_cwd())) |
|
270 | 270 | else: |
|
271 | 271 | toggle_set_term_title(False) |
|
272 | 272 | |
|
273 | 273 | def restore_term_title(self): |
|
274 | 274 | if self.term_title: |
|
275 | 275 | restore_term_title() |
|
276 | 276 | |
|
277 | 277 | def init_display_formatter(self): |
|
278 | 278 | super(TerminalInteractiveShell, self).init_display_formatter() |
|
279 | 279 | # terminal only supports plain text |
|
280 | 280 | self.display_formatter.active_types = ['text/plain'] |
|
281 | 281 | # disable `_ipython_display_` |
|
282 | 282 | self.display_formatter.ipython_display_formatter.enabled = False |
|
283 | 283 | |
|
284 | 284 | def init_prompt_toolkit_cli(self): |
|
285 | 285 | if self.simple_prompt: |
|
286 | 286 | # Fall back to plain non-interactive output for tests. |
|
287 | 287 | # This is very limited. |
|
288 | 288 | def prompt(): |
|
289 | 289 | prompt_text = "".join(x[1] for x in self.prompts.in_prompt_tokens()) |
|
290 | 290 | lines = [input(prompt_text)] |
|
291 | 291 | prompt_continuation = "".join(x[1] for x in self.prompts.continuation_prompt_tokens()) |
|
292 | 292 | while self.check_complete('\n'.join(lines))[0] == 'incomplete': |
|
293 | 293 | lines.append( input(prompt_continuation) ) |
|
294 | 294 | return '\n'.join(lines) |
|
295 | 295 | self.prompt_for_code = prompt |
|
296 | 296 | return |
|
297 | 297 | |
|
298 | 298 | # Set up keyboard shortcuts |
|
299 | 299 | key_bindings = create_ipython_shortcuts(self) |
|
300 | 300 | |
|
301 | 301 | # Pre-populate history from IPython's history database |
|
302 | 302 | history = InMemoryHistory() |
|
303 | 303 | last_cell = u"" |
|
304 | 304 | for __, ___, cell in self.history_manager.get_tail(self.history_load_length, |
|
305 | 305 | include_latest=True): |
|
306 | 306 | # Ignore blank lines and consecutive duplicates |
|
307 | 307 | cell = cell.rstrip() |
|
308 | 308 | if cell and (cell != last_cell): |
|
309 | 309 | history.append_string(cell) |
|
310 | 310 | last_cell = cell |
|
311 | 311 | |
|
312 | 312 | self._style = self._make_style_from_name_or_cls(self.highlighting_style) |
|
313 | 313 | self.style = DynamicStyle(lambda: self._style) |
|
314 | 314 | |
|
315 | 315 | editing_mode = getattr(EditingMode, self.editing_mode.upper()) |
|
316 | 316 | |
|
317 | 317 | self.pt_loop = asyncio.new_event_loop() |
|
318 | 318 | self.pt_app = PromptSession( |
|
319 | 319 | editing_mode=editing_mode, |
|
320 | 320 | key_bindings=key_bindings, |
|
321 | 321 | history=history, |
|
322 | 322 | completer=IPythonPTCompleter(shell=self), |
|
323 | 323 | enable_history_search = self.enable_history_search, |
|
324 | 324 | style=self.style, |
|
325 | 325 | include_default_pygments_style=False, |
|
326 | 326 | mouse_support=self.mouse_support, |
|
327 | 327 | enable_open_in_editor=self.extra_open_editor_shortcuts, |
|
328 | 328 | color_depth=self.color_depth, |
|
329 | 329 | tempfile_suffix=".py", |
|
330 | 330 | **self._extra_prompt_options()) |
|
331 | 331 | |
|
332 | 332 | def _make_style_from_name_or_cls(self, name_or_cls): |
|
333 | 333 | """ |
|
334 | 334 | Small wrapper that make an IPython compatible style from a style name |
|
335 | 335 | |
|
336 | 336 | We need that to add style for prompt ... etc. |
|
337 | 337 | """ |
|
338 | 338 | style_overrides = {} |
|
339 | 339 | if name_or_cls == 'legacy': |
|
340 | 340 | legacy = self.colors.lower() |
|
341 | 341 | if legacy == 'linux': |
|
342 | 342 | style_cls = get_style_by_name('monokai') |
|
343 | 343 | style_overrides = _style_overrides_linux |
|
344 | 344 | elif legacy == 'lightbg': |
|
345 | 345 | style_overrides = _style_overrides_light_bg |
|
346 | 346 | style_cls = get_style_by_name('pastie') |
|
347 | 347 | elif legacy == 'neutral': |
|
348 | 348 | # The default theme needs to be visible on both a dark background |
|
349 | 349 | # and a light background, because we can't tell what the terminal |
|
350 | 350 | # looks like. These tweaks to the default theme help with that. |
|
351 | 351 | style_cls = get_style_by_name('default') |
|
352 | 352 | style_overrides.update({ |
|
353 | 353 | Token.Number: '#ansigreen', |
|
354 | 354 | Token.Operator: 'noinherit', |
|
355 | 355 | Token.String: '#ansiyellow', |
|
356 | 356 | Token.Name.Function: '#ansiblue', |
|
357 | 357 | Token.Name.Class: 'bold #ansiblue', |
|
358 | 358 | Token.Name.Namespace: 'bold #ansiblue', |
|
359 | Token.Name.Variable.Magic: '#ansiblue', | |
|
359 | 360 | Token.Prompt: '#ansigreen', |
|
360 | 361 | Token.PromptNum: '#ansibrightgreen bold', |
|
361 | 362 | Token.OutPrompt: '#ansired', |
|
362 | 363 | Token.OutPromptNum: '#ansibrightred bold', |
|
363 | 364 | }) |
|
364 | 365 | |
|
365 | 366 | # Hack: Due to limited color support on the Windows console |
|
366 | 367 | # the prompt colors will be wrong without this |
|
367 | 368 | if os.name == 'nt': |
|
368 | 369 | style_overrides.update({ |
|
369 | 370 | Token.Prompt: '#ansidarkgreen', |
|
370 | 371 | Token.PromptNum: '#ansigreen bold', |
|
371 | 372 | Token.OutPrompt: '#ansidarkred', |
|
372 | 373 | Token.OutPromptNum: '#ansired bold', |
|
373 | 374 | }) |
|
374 | 375 | elif legacy =='nocolor': |
|
375 | 376 | style_cls=_NoStyle |
|
376 | 377 | style_overrides = {} |
|
377 | 378 | else : |
|
378 | 379 | raise ValueError('Got unknown colors: ', legacy) |
|
379 | 380 | else : |
|
380 | 381 | if isinstance(name_or_cls, str): |
|
381 | 382 | style_cls = get_style_by_name(name_or_cls) |
|
382 | 383 | else: |
|
383 | 384 | style_cls = name_or_cls |
|
384 | 385 | style_overrides = { |
|
385 | 386 | Token.Prompt: '#ansigreen', |
|
386 | 387 | Token.PromptNum: '#ansibrightgreen bold', |
|
387 | 388 | Token.OutPrompt: '#ansired', |
|
388 | 389 | Token.OutPromptNum: '#ansibrightred bold', |
|
389 | 390 | } |
|
390 | 391 | style_overrides.update(self.highlighting_style_overrides) |
|
391 | 392 | style = merge_styles([ |
|
392 | 393 | style_from_pygments_cls(style_cls), |
|
393 | 394 | style_from_pygments_dict(style_overrides), |
|
394 | 395 | ]) |
|
395 | 396 | |
|
396 | 397 | return style |
|
397 | 398 | |
|
398 | 399 | @property |
|
399 | 400 | def pt_complete_style(self): |
|
400 | 401 | return { |
|
401 | 402 | 'multicolumn': CompleteStyle.MULTI_COLUMN, |
|
402 | 403 | 'column': CompleteStyle.COLUMN, |
|
403 | 404 | 'readlinelike': CompleteStyle.READLINE_LIKE, |
|
404 | 405 | }[self.display_completions] |
|
405 | 406 | |
|
406 | 407 | @property |
|
407 | 408 | def color_depth(self): |
|
408 | 409 | return (ColorDepth.TRUE_COLOR if self.true_color else None) |
|
409 | 410 | |
|
410 | 411 | def _extra_prompt_options(self): |
|
411 | 412 | """ |
|
412 | 413 | Return the current layout option for the current Terminal InteractiveShell |
|
413 | 414 | """ |
|
414 | 415 | def get_message(): |
|
415 | 416 | return PygmentsTokens(self.prompts.in_prompt_tokens()) |
|
416 | 417 | |
|
417 | 418 | if self.editing_mode == 'emacs': |
|
418 | 419 | # with emacs mode the prompt is (usually) static, so we call only |
|
419 | 420 | # the function once. With VI mode it can toggle between [ins] and |
|
420 | 421 | # [nor] so we can't precompute. |
|
421 | 422 | # here I'm going to favor the default keybinding which almost |
|
422 | 423 | # everybody uses to decrease CPU usage. |
|
423 | 424 | # if we have issues with users with custom Prompts we can see how to |
|
424 | 425 | # work around this. |
|
425 | 426 | get_message = get_message() |
|
426 | 427 | |
|
427 | 428 | options = { |
|
428 | 429 | 'complete_in_thread': False, |
|
429 | 430 | 'lexer':IPythonPTLexer(), |
|
430 | 431 | 'reserve_space_for_menu':self.space_for_menu, |
|
431 | 432 | 'message': get_message, |
|
432 | 433 | 'prompt_continuation': ( |
|
433 | 434 | lambda width, lineno, is_soft_wrap: |
|
434 | 435 | PygmentsTokens(self.prompts.continuation_prompt_tokens(width))), |
|
435 | 436 | 'multiline': True, |
|
436 | 437 | 'complete_style': self.pt_complete_style, |
|
437 | 438 | |
|
438 | 439 | # Highlight matching brackets, but only when this setting is |
|
439 | 440 | # enabled, and only when the DEFAULT_BUFFER has the focus. |
|
440 | 441 | 'input_processors': [ConditionalProcessor( |
|
441 | 442 | processor=HighlightMatchingBracketProcessor(chars='[](){}'), |
|
442 | 443 | filter=HasFocus(DEFAULT_BUFFER) & ~IsDone() & |
|
443 | 444 | Condition(lambda: self.highlight_matching_brackets))], |
|
444 | 445 | } |
|
445 | 446 | if not PTK3: |
|
446 | 447 | options['inputhook'] = self.inputhook |
|
447 | 448 | |
|
448 | 449 | return options |
|
449 | 450 | |
|
450 | 451 | def prompt_for_code(self): |
|
451 | 452 | if self.rl_next_input: |
|
452 | 453 | default = self.rl_next_input |
|
453 | 454 | self.rl_next_input = None |
|
454 | 455 | else: |
|
455 | 456 | default = '' |
|
456 | 457 | |
|
457 | 458 | # In order to make sure that asyncio code written in the |
|
458 | 459 | # interactive shell doesn't interfere with the prompt, we run the |
|
459 | 460 | # prompt in a different event loop. |
|
460 | 461 | # If we don't do this, people could spawn coroutine with a |
|
461 | 462 | # while/true inside which will freeze the prompt. |
|
462 | 463 | |
|
463 | 464 | try: |
|
464 | 465 | old_loop = asyncio.get_event_loop() |
|
465 | 466 | except RuntimeError: |
|
466 | 467 | # This happens when the user used `asyncio.run()`. |
|
467 | 468 | old_loop = None |
|
468 | 469 | |
|
469 | 470 | asyncio.set_event_loop(self.pt_loop) |
|
470 | 471 | try: |
|
471 | 472 | with patch_stdout(raw=True): |
|
472 | 473 | text = self.pt_app.prompt( |
|
473 | 474 | default=default, |
|
474 | 475 | **self._extra_prompt_options()) |
|
475 | 476 | finally: |
|
476 | 477 | # Restore the original event loop. |
|
477 | 478 | asyncio.set_event_loop(old_loop) |
|
478 | 479 | |
|
479 | 480 | return text |
|
480 | 481 | |
|
481 | 482 | def enable_win_unicode_console(self): |
|
482 | 483 | # Since IPython 7.10 doesn't support python < 3.6 and PEP 528, Python uses the unicode APIs for the Windows |
|
483 | 484 | # console by default, so WUC shouldn't be needed. |
|
484 | 485 | from warnings import warn |
|
485 | 486 | warn("`enable_win_unicode_console` is deprecated since IPython 7.10, does not do anything and will be removed in the future", |
|
486 | 487 | DeprecationWarning, |
|
487 | 488 | stacklevel=2) |
|
488 | 489 | |
|
489 | 490 | def init_io(self): |
|
490 | 491 | if sys.platform not in {'win32', 'cli'}: |
|
491 | 492 | return |
|
492 | 493 | |
|
493 | 494 | import colorama |
|
494 | 495 | colorama.init() |
|
495 | 496 | |
|
496 | 497 | # For some reason we make these wrappers around stdout/stderr. |
|
497 | 498 | # For now, we need to reset them so all output gets coloured. |
|
498 | 499 | # https://github.com/ipython/ipython/issues/8669 |
|
499 | 500 | # io.std* are deprecated, but don't show our own deprecation warnings |
|
500 | 501 | # during initialization of the deprecated API. |
|
501 | 502 | with warnings.catch_warnings(): |
|
502 | 503 | warnings.simplefilter('ignore', DeprecationWarning) |
|
503 | 504 | io.stdout = io.IOStream(sys.stdout) |
|
504 | 505 | io.stderr = io.IOStream(sys.stderr) |
|
505 | 506 | |
|
506 | 507 | def init_magics(self): |
|
507 | 508 | super(TerminalInteractiveShell, self).init_magics() |
|
508 | 509 | self.register_magics(TerminalMagics) |
|
509 | 510 | |
|
510 | 511 | def init_alias(self): |
|
511 | 512 | # The parent class defines aliases that can be safely used with any |
|
512 | 513 | # frontend. |
|
513 | 514 | super(TerminalInteractiveShell, self).init_alias() |
|
514 | 515 | |
|
515 | 516 | # Now define aliases that only make sense on the terminal, because they |
|
516 | 517 | # need direct access to the console in a way that we can't emulate in |
|
517 | 518 | # GUI or web frontend |
|
518 | 519 | if os.name == 'posix': |
|
519 | 520 | for cmd in ('clear', 'more', 'less', 'man'): |
|
520 | 521 | self.alias_manager.soft_define_alias(cmd, cmd) |
|
521 | 522 | |
|
522 | 523 | |
|
523 | 524 | def __init__(self, *args, **kwargs): |
|
524 | 525 | super(TerminalInteractiveShell, self).__init__(*args, **kwargs) |
|
525 | 526 | self.init_prompt_toolkit_cli() |
|
526 | 527 | self.init_term_title() |
|
527 | 528 | self.keep_running = True |
|
528 | 529 | |
|
529 | 530 | self.debugger_history = InMemoryHistory() |
|
530 | 531 | |
|
531 | 532 | def ask_exit(self): |
|
532 | 533 | self.keep_running = False |
|
533 | 534 | |
|
534 | 535 | rl_next_input = None |
|
535 | 536 | |
|
536 | 537 | def interact(self, display_banner=DISPLAY_BANNER_DEPRECATED): |
|
537 | 538 | |
|
538 | 539 | if display_banner is not DISPLAY_BANNER_DEPRECATED: |
|
539 | 540 | warn('interact `display_banner` argument is deprecated since IPython 5.0. Call `show_banner()` if needed.', DeprecationWarning, stacklevel=2) |
|
540 | 541 | |
|
541 | 542 | self.keep_running = True |
|
542 | 543 | while self.keep_running: |
|
543 | 544 | print(self.separate_in, end='') |
|
544 | 545 | |
|
545 | 546 | try: |
|
546 | 547 | code = self.prompt_for_code() |
|
547 | 548 | except EOFError: |
|
548 | 549 | if (not self.confirm_exit) \ |
|
549 | 550 | or self.ask_yes_no('Do you really want to exit ([y]/n)?','y','n'): |
|
550 | 551 | self.ask_exit() |
|
551 | 552 | |
|
552 | 553 | else: |
|
553 | 554 | if code: |
|
554 | 555 | self.run_cell(code, store_history=True) |
|
555 | 556 | |
|
556 | 557 | def mainloop(self, display_banner=DISPLAY_BANNER_DEPRECATED): |
|
557 | 558 | # An extra layer of protection in case someone mashing Ctrl-C breaks |
|
558 | 559 | # out of our internal code. |
|
559 | 560 | if display_banner is not DISPLAY_BANNER_DEPRECATED: |
|
560 | 561 | warn('mainloop `display_banner` argument is deprecated since IPython 5.0. Call `show_banner()` if needed.', DeprecationWarning, stacklevel=2) |
|
561 | 562 | while True: |
|
562 | 563 | try: |
|
563 | 564 | self.interact() |
|
564 | 565 | break |
|
565 | 566 | except KeyboardInterrupt as e: |
|
566 | 567 | print("\n%s escaped interact()\n" % type(e).__name__) |
|
567 | 568 | finally: |
|
568 | 569 | # An interrupt during the eventloop will mess up the |
|
569 | 570 | # internal state of the prompt_toolkit library. |
|
570 | 571 | # Stopping the eventloop fixes this, see |
|
571 | 572 | # https://github.com/ipython/ipython/pull/9867 |
|
572 | 573 | if hasattr(self, '_eventloop'): |
|
573 | 574 | self._eventloop.stop() |
|
574 | 575 | |
|
575 | 576 | self.restore_term_title() |
|
576 | 577 | |
|
577 | 578 | |
|
578 | 579 | _inputhook = None |
|
579 | 580 | def inputhook(self, context): |
|
580 | 581 | if self._inputhook is not None: |
|
581 | 582 | self._inputhook(context) |
|
582 | 583 | |
|
583 | 584 | active_eventloop = None |
|
584 | 585 | def enable_gui(self, gui=None): |
|
585 | 586 | if gui and (gui != 'inline') : |
|
586 | 587 | self.active_eventloop, self._inputhook =\ |
|
587 | 588 | get_inputhook_name_and_func(gui) |
|
588 | 589 | else: |
|
589 | 590 | self.active_eventloop = self._inputhook = None |
|
590 | 591 | |
|
591 | 592 | # For prompt_toolkit 3.0. We have to create an asyncio event loop with |
|
592 | 593 | # this inputhook. |
|
593 | 594 | if PTK3: |
|
594 | 595 | import asyncio |
|
595 | 596 | from prompt_toolkit.eventloop import new_eventloop_with_inputhook |
|
596 | 597 | |
|
597 | 598 | if gui == 'asyncio': |
|
598 | 599 | # When we integrate the asyncio event loop, run the UI in the |
|
599 | 600 | # same event loop as the rest of the code. don't use an actual |
|
600 | 601 | # input hook. (Asyncio is not made for nesting event loops.) |
|
601 | 602 | self.pt_loop = asyncio.get_event_loop() |
|
602 | 603 | |
|
603 | 604 | elif self._inputhook: |
|
604 | 605 | # If an inputhook was set, create a new asyncio event loop with |
|
605 | 606 | # this inputhook for the prompt. |
|
606 | 607 | self.pt_loop = new_eventloop_with_inputhook(self._inputhook) |
|
607 | 608 | else: |
|
608 | 609 | # When there's no inputhook, run the prompt in a separate |
|
609 | 610 | # asyncio event loop. |
|
610 | 611 | self.pt_loop = asyncio.new_event_loop() |
|
611 | 612 | |
|
612 | 613 | # Run !system commands directly, not through pipes, so terminal programs |
|
613 | 614 | # work correctly. |
|
614 | 615 | system = InteractiveShell.system_raw |
|
615 | 616 | |
|
616 | 617 | def auto_rewrite_input(self, cmd): |
|
617 | 618 | """Overridden from the parent class to use fancy rewriting prompt""" |
|
618 | 619 | if not self.show_rewritten_input: |
|
619 | 620 | return |
|
620 | 621 | |
|
621 | 622 | tokens = self.prompts.rewrite_prompt_tokens() |
|
622 | 623 | if self.pt_app: |
|
623 | 624 | print_formatted_text(PygmentsTokens(tokens), end='', |
|
624 | 625 | style=self.pt_app.app.style) |
|
625 | 626 | print(cmd) |
|
626 | 627 | else: |
|
627 | 628 | prompt = ''.join(s for t, s in tokens) |
|
628 | 629 | print(prompt, cmd, sep='') |
|
629 | 630 | |
|
630 | 631 | _prompts_before = None |
|
631 | 632 | def switch_doctest_mode(self, mode): |
|
632 | 633 | """Switch prompts to classic for %doctest_mode""" |
|
633 | 634 | if mode: |
|
634 | 635 | self._prompts_before = self.prompts |
|
635 | 636 | self.prompts = ClassicPrompts(self) |
|
636 | 637 | elif self._prompts_before: |
|
637 | 638 | self.prompts = self._prompts_before |
|
638 | 639 | self._prompts_before = None |
|
639 | 640 | # self._update_layout() |
|
640 | 641 | |
|
641 | 642 | |
|
642 | 643 | InteractiveShellABC.register(TerminalInteractiveShell) |
|
643 | 644 | |
|
644 | 645 | if __name__ == '__main__': |
|
645 | 646 | TerminalInteractiveShell.instance().interact() |
General Comments 0
You need to be logged in to leave comments.
Login now