Show More
@@ -1,809 +1,813 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 | Given an index in the stack return wether it should be skipped. | |
|
293 | Given an index in the stack return whether it should be skipped. | |
|
294 | 294 | |
|
295 | 295 | This is used in up/down and where to skip frames. |
|
296 | 296 | """ |
|
297 | 297 | # The f_locals dictionary is updated from the actual frame |
|
298 | 298 | # locals whenever the .f_locals accessor is called, so we |
|
299 | 299 | # avoid calling it here to preserve self.curframe_locals. |
|
300 | 300 | # Futhermore, there is no good reason to hide the current frame. |
|
301 | 301 | ip_hide = [ |
|
302 | 302 | False if s[0] is self.curframe else s[0].f_locals.get( |
|
303 | 303 | "__tracebackhide__", False) |
|
304 | 304 | for s in stack] |
|
305 | 305 | ip_start = [i for i, s in enumerate(ip_hide) if s == "__ipython_bottom__"] |
|
306 | 306 | if ip_start: |
|
307 | 307 | ip_hide = [h if i > ip_start[0] else True for (i, h) in enumerate(ip_hide)] |
|
308 | 308 | return ip_hide |
|
309 | 309 | |
|
310 | 310 | def interaction(self, frame, traceback): |
|
311 | 311 | try: |
|
312 | 312 | OldPdb.interaction(self, frame, traceback) |
|
313 | 313 | except KeyboardInterrupt: |
|
314 | 314 | self.stdout.write("\n" + self.shell.get_exception_only()) |
|
315 | 315 | |
|
316 | 316 | def new_do_frame(self, arg): |
|
317 | 317 | OldPdb.do_frame(self, arg) |
|
318 | 318 | |
|
319 | 319 | def new_do_quit(self, arg): |
|
320 | 320 | |
|
321 | 321 | if hasattr(self, 'old_all_completions'): |
|
322 | 322 | self.shell.Completer.all_completions=self.old_all_completions |
|
323 | 323 | |
|
324 | 324 | return OldPdb.do_quit(self, arg) |
|
325 | 325 | |
|
326 | 326 | do_q = do_quit = decorate_fn_with_doc(new_do_quit, OldPdb.do_quit) |
|
327 | 327 | |
|
328 | 328 | def new_do_restart(self, arg): |
|
329 | 329 | """Restart command. In the context of ipython this is exactly the same |
|
330 | 330 | thing as 'quit'.""" |
|
331 | 331 | self.msg("Restart doesn't make sense here. Using 'quit' instead.") |
|
332 | 332 | return self.do_quit(arg) |
|
333 | 333 | |
|
334 | 334 | def print_stack_trace(self, context=None): |
|
335 | 335 | Colors = self.color_scheme_table.active_colors |
|
336 | 336 | ColorsNormal = Colors.Normal |
|
337 | 337 | if context is None: |
|
338 | 338 | context = self.context |
|
339 | 339 | try: |
|
340 | 340 | context=int(context) |
|
341 | 341 | if context <= 0: |
|
342 | 342 | raise ValueError("Context must be a positive integer") |
|
343 | 343 | except (TypeError, ValueError) as e: |
|
344 | 344 | raise ValueError("Context must be a positive integer") from e |
|
345 | 345 | try: |
|
346 | 346 | skipped = 0 |
|
347 | 347 | for hidden, frame_lineno in zip(self.hidden_frames(self.stack), self.stack): |
|
348 | 348 | if hidden and self.skip_hidden: |
|
349 | 349 | skipped += 1 |
|
350 | 350 | continue |
|
351 | 351 | if skipped: |
|
352 | 352 | print( |
|
353 | 353 | f"{Colors.excName} [... skipping {skipped} hidden frame(s)]{ColorsNormal}\n" |
|
354 | 354 | ) |
|
355 | 355 | skipped = 0 |
|
356 | 356 | self.print_stack_entry(frame_lineno, context=context) |
|
357 | 357 | if skipped: |
|
358 | 358 | print( |
|
359 | 359 | f"{Colors.excName} [... skipping {skipped} hidden frame(s)]{ColorsNormal}\n" |
|
360 | 360 | ) |
|
361 | 361 | except KeyboardInterrupt: |
|
362 | 362 | pass |
|
363 | 363 | |
|
364 | 364 | def print_stack_entry(self, frame_lineno, prompt_prefix='\n-> ', |
|
365 | 365 | context=None): |
|
366 | 366 | if context is None: |
|
367 | 367 | context = self.context |
|
368 | 368 | try: |
|
369 | 369 | context=int(context) |
|
370 | 370 | if context <= 0: |
|
371 | 371 | raise ValueError("Context must be a positive integer") |
|
372 | 372 | except (TypeError, ValueError) as e: |
|
373 | 373 | raise ValueError("Context must be a positive integer") from e |
|
374 | 374 | print(self.format_stack_entry(frame_lineno, '', context), file=self.stdout) |
|
375 | 375 | |
|
376 | 376 | # vds: >> |
|
377 | 377 | frame, lineno = frame_lineno |
|
378 | 378 | filename = frame.f_code.co_filename |
|
379 | 379 | self.shell.hooks.synchronize_with_editor(filename, lineno, 0) |
|
380 | 380 | # vds: << |
|
381 | 381 | |
|
382 | 382 | def format_stack_entry(self, frame_lineno, lprefix=': ', context=None): |
|
383 | 383 | if context is None: |
|
384 | 384 | context = self.context |
|
385 | 385 | try: |
|
386 | 386 | context=int(context) |
|
387 | 387 | if context <= 0: |
|
388 | 388 | print("Context must be a positive integer", file=self.stdout) |
|
389 | 389 | except (TypeError, ValueError): |
|
390 | 390 | print("Context must be a positive integer", file=self.stdout) |
|
391 | 391 | |
|
392 | 392 | import reprlib |
|
393 | 393 | |
|
394 | 394 | ret = [] |
|
395 | 395 | |
|
396 | 396 | Colors = self.color_scheme_table.active_colors |
|
397 | 397 | ColorsNormal = Colors.Normal |
|
398 | 398 | tpl_link = u'%s%%s%s' % (Colors.filenameEm, ColorsNormal) |
|
399 | 399 | tpl_call = u'%s%%s%s%%s%s' % (Colors.vName, Colors.valEm, ColorsNormal) |
|
400 | 400 | tpl_line = u'%%s%s%%s %s%%s' % (Colors.lineno, ColorsNormal) |
|
401 | 401 | tpl_line_em = u'%%s%s%%s %s%%s%s' % (Colors.linenoEm, Colors.line, |
|
402 | 402 | ColorsNormal) |
|
403 | 403 | |
|
404 | 404 | frame, lineno = frame_lineno |
|
405 | 405 | |
|
406 | 406 | return_value = '' |
|
407 | 407 | if '__return__' in frame.f_locals: |
|
408 | 408 | rv = frame.f_locals['__return__'] |
|
409 | 409 | #return_value += '->' |
|
410 | 410 | return_value += reprlib.repr(rv) + '\n' |
|
411 | 411 | ret.append(return_value) |
|
412 | 412 | |
|
413 | 413 | #s = filename + '(' + `lineno` + ')' |
|
414 | 414 | filename = self.canonic(frame.f_code.co_filename) |
|
415 | 415 | link = tpl_link % py3compat.cast_unicode(filename) |
|
416 | 416 | |
|
417 | 417 | if frame.f_code.co_name: |
|
418 | 418 | func = frame.f_code.co_name |
|
419 | 419 | else: |
|
420 | 420 | func = "<lambda>" |
|
421 | 421 | |
|
422 | 422 | call = '' |
|
423 | 423 | if func != '?': |
|
424 | 424 | if '__args__' in frame.f_locals: |
|
425 | 425 | args = reprlib.repr(frame.f_locals['__args__']) |
|
426 | 426 | else: |
|
427 | 427 | args = '()' |
|
428 | 428 | call = tpl_call % (func, args) |
|
429 | 429 | |
|
430 | 430 | # The level info should be generated in the same format pdb uses, to |
|
431 | 431 | # avoid breaking the pdbtrack functionality of python-mode in *emacs. |
|
432 | 432 | if frame is self.curframe: |
|
433 | 433 | ret.append('> ') |
|
434 | 434 | else: |
|
435 | 435 | ret.append(' ') |
|
436 | 436 | ret.append(u'%s(%s)%s\n' % (link,lineno,call)) |
|
437 | 437 | |
|
438 | 438 | start = lineno - 1 - context//2 |
|
439 | 439 | lines = linecache.getlines(filename) |
|
440 | 440 | start = min(start, len(lines) - context) |
|
441 | 441 | start = max(start, 0) |
|
442 | 442 | lines = lines[start : start + context] |
|
443 | 443 | |
|
444 | 444 | for i,line in enumerate(lines): |
|
445 | 445 | show_arrow = (start + 1 + i == lineno) |
|
446 | 446 | linetpl = (frame is self.curframe or show_arrow) \ |
|
447 | 447 | and tpl_line_em \ |
|
448 | 448 | or tpl_line |
|
449 | 449 | ret.append(self.__format_line(linetpl, filename, |
|
450 | 450 | start + 1 + i, line, |
|
451 | 451 | arrow = show_arrow) ) |
|
452 | 452 | return ''.join(ret) |
|
453 | 453 | |
|
454 | 454 | def __format_line(self, tpl_line, filename, lineno, line, arrow = False): |
|
455 | 455 | bp_mark = "" |
|
456 | 456 | bp_mark_color = "" |
|
457 | 457 | |
|
458 | 458 | new_line, err = self.parser.format2(line, 'str') |
|
459 | 459 | if not err: |
|
460 | 460 | line = new_line |
|
461 | 461 | |
|
462 | 462 | bp = None |
|
463 | 463 | if lineno in self.get_file_breaks(filename): |
|
464 | 464 | bps = self.get_breaks(filename, lineno) |
|
465 | 465 | bp = bps[-1] |
|
466 | 466 | |
|
467 | 467 | if bp: |
|
468 | 468 | Colors = self.color_scheme_table.active_colors |
|
469 | 469 | bp_mark = str(bp.number) |
|
470 | 470 | bp_mark_color = Colors.breakpoint_enabled |
|
471 | 471 | if not bp.enabled: |
|
472 | 472 | bp_mark_color = Colors.breakpoint_disabled |
|
473 | 473 | |
|
474 | 474 | numbers_width = 7 |
|
475 | 475 | if arrow: |
|
476 | 476 | # This is the line with the error |
|
477 | 477 | pad = numbers_width - len(str(lineno)) - len(bp_mark) |
|
478 | 478 | num = '%s%s' % (make_arrow(pad), str(lineno)) |
|
479 | 479 | else: |
|
480 | 480 | num = '%*s' % (numbers_width - len(bp_mark), str(lineno)) |
|
481 | 481 | |
|
482 | 482 | return tpl_line % (bp_mark_color + bp_mark, num, line) |
|
483 | 483 | |
|
484 | 484 | |
|
485 | 485 | def print_list_lines(self, filename, first, last): |
|
486 | 486 | """The printing (as opposed to the parsing part of a 'list' |
|
487 | 487 | command.""" |
|
488 | 488 | try: |
|
489 | 489 | Colors = self.color_scheme_table.active_colors |
|
490 | 490 | ColorsNormal = Colors.Normal |
|
491 | 491 | tpl_line = '%%s%s%%s %s%%s' % (Colors.lineno, ColorsNormal) |
|
492 | 492 | tpl_line_em = '%%s%s%%s %s%%s%s' % (Colors.linenoEm, Colors.line, ColorsNormal) |
|
493 | 493 | src = [] |
|
494 | 494 | if filename == "<string>" and hasattr(self, "_exec_filename"): |
|
495 | 495 | filename = self._exec_filename |
|
496 | 496 | |
|
497 | 497 | for lineno in range(first, last+1): |
|
498 | 498 | line = linecache.getline(filename, lineno) |
|
499 | 499 | if not line: |
|
500 | 500 | break |
|
501 | 501 | |
|
502 | 502 | if lineno == self.curframe.f_lineno: |
|
503 | 503 | line = self.__format_line(tpl_line_em, filename, lineno, line, arrow = True) |
|
504 | 504 | else: |
|
505 | 505 | line = self.__format_line(tpl_line, filename, lineno, line, arrow = False) |
|
506 | 506 | |
|
507 | 507 | src.append(line) |
|
508 | 508 | self.lineno = lineno |
|
509 | 509 | |
|
510 | 510 | print(''.join(src), file=self.stdout) |
|
511 | 511 | |
|
512 | 512 | except KeyboardInterrupt: |
|
513 | 513 | pass |
|
514 | 514 | |
|
515 | 515 | def do_skip_hidden(self, arg): |
|
516 | 516 | """ |
|
517 | 517 | Change whether or not we should skip frames with the |
|
518 | 518 | __tracebackhide__ attribute. |
|
519 | 519 | """ |
|
520 | 520 | if arg.strip().lower() in ("true", "yes"): |
|
521 | 521 | self.skip_hidden = True |
|
522 | 522 | elif arg.strip().lower() in ("false", "no"): |
|
523 | 523 | self.skip_hidden = False |
|
524 | 524 | |
|
525 | 525 | def do_list(self, arg): |
|
526 | 526 | """Print lines of code from the current stack frame |
|
527 | 527 | """ |
|
528 | 528 | self.lastcmd = 'list' |
|
529 | 529 | last = None |
|
530 | 530 | if arg: |
|
531 | 531 | try: |
|
532 | 532 | x = eval(arg, {}, {}) |
|
533 | 533 | if type(x) == type(()): |
|
534 | 534 | first, last = x |
|
535 | 535 | first = int(first) |
|
536 | 536 | last = int(last) |
|
537 | 537 | if last < first: |
|
538 | 538 | # Assume it's a count |
|
539 | 539 | last = first + last |
|
540 | 540 | else: |
|
541 | 541 | first = max(1, int(x) - 5) |
|
542 | 542 | except: |
|
543 | 543 | print('*** Error in argument:', repr(arg), file=self.stdout) |
|
544 | 544 | return |
|
545 | 545 | elif self.lineno is None: |
|
546 | 546 | first = max(1, self.curframe.f_lineno - 5) |
|
547 | 547 | else: |
|
548 | 548 | first = self.lineno + 1 |
|
549 | 549 | if last is None: |
|
550 | 550 | last = first + 10 |
|
551 | 551 | self.print_list_lines(self.curframe.f_code.co_filename, first, last) |
|
552 | 552 | |
|
553 | 553 | # vds: >> |
|
554 | 554 | lineno = first |
|
555 | 555 | filename = self.curframe.f_code.co_filename |
|
556 | 556 | self.shell.hooks.synchronize_with_editor(filename, lineno, 0) |
|
557 | 557 | # vds: << |
|
558 | 558 | |
|
559 | 559 | do_l = do_list |
|
560 | 560 | |
|
561 | 561 | def getsourcelines(self, obj): |
|
562 | 562 | lines, lineno = inspect.findsource(obj) |
|
563 | 563 | if inspect.isframe(obj) and obj.f_globals is obj.f_locals: |
|
564 | 564 | # must be a module frame: do not try to cut a block out of it |
|
565 | 565 | return lines, 1 |
|
566 | 566 | elif inspect.ismodule(obj): |
|
567 | 567 | return lines, 1 |
|
568 | 568 | return inspect.getblock(lines[lineno:]), lineno+1 |
|
569 | 569 | |
|
570 | 570 | def do_longlist(self, arg): |
|
571 | 571 | """Print lines of code from the current stack frame. |
|
572 | 572 | |
|
573 | 573 | Shows more lines than 'list' does. |
|
574 | 574 | """ |
|
575 | 575 | self.lastcmd = 'longlist' |
|
576 | 576 | try: |
|
577 | 577 | lines, lineno = self.getsourcelines(self.curframe) |
|
578 | 578 | except OSError as err: |
|
579 | 579 | self.error(err) |
|
580 | 580 | return |
|
581 | 581 | last = lineno + len(lines) |
|
582 | 582 | self.print_list_lines(self.curframe.f_code.co_filename, lineno, last) |
|
583 | 583 | do_ll = do_longlist |
|
584 | 584 | |
|
585 | 585 | def do_debug(self, arg): |
|
586 | 586 | """debug code |
|
587 | 587 | Enter a recursive debugger that steps through the code |
|
588 | 588 | argument (which is an arbitrary expression or statement to be |
|
589 | 589 | executed in the current environment). |
|
590 | 590 | """ |
|
591 | 591 | sys.settrace(None) |
|
592 | 592 | globals = self.curframe.f_globals |
|
593 | 593 | locals = self.curframe_locals |
|
594 | 594 | p = self.__class__(completekey=self.completekey, |
|
595 | 595 | stdin=self.stdin, stdout=self.stdout) |
|
596 | 596 | p.use_rawinput = self.use_rawinput |
|
597 | 597 | p.prompt = "(%s) " % self.prompt.strip() |
|
598 | 598 | self.message("ENTERING RECURSIVE DEBUGGER") |
|
599 | 599 | sys.call_tracing(p.run, (arg, globals, locals)) |
|
600 | 600 | self.message("LEAVING RECURSIVE DEBUGGER") |
|
601 | 601 | sys.settrace(self.trace_dispatch) |
|
602 | 602 | self.lastcmd = p.lastcmd |
|
603 | 603 | |
|
604 | 604 | def do_pdef(self, arg): |
|
605 | 605 | """Print the call signature for any callable object. |
|
606 | 606 | |
|
607 | 607 | The debugger interface to %pdef""" |
|
608 | 608 | namespaces = [('Locals', self.curframe.f_locals), |
|
609 | 609 | ('Globals', self.curframe.f_globals)] |
|
610 | 610 | self.shell.find_line_magic('pdef')(arg, namespaces=namespaces) |
|
611 | 611 | |
|
612 | 612 | def do_pdoc(self, arg): |
|
613 | 613 | """Print the docstring for an object. |
|
614 | 614 | |
|
615 | 615 | The debugger interface to %pdoc.""" |
|
616 | 616 | namespaces = [('Locals', self.curframe.f_locals), |
|
617 | 617 | ('Globals', self.curframe.f_globals)] |
|
618 | 618 | self.shell.find_line_magic('pdoc')(arg, namespaces=namespaces) |
|
619 | 619 | |
|
620 | 620 | def do_pfile(self, arg): |
|
621 | 621 | """Print (or run through pager) the file where an object is defined. |
|
622 | 622 | |
|
623 | 623 | The debugger interface to %pfile. |
|
624 | 624 | """ |
|
625 | 625 | namespaces = [('Locals', self.curframe.f_locals), |
|
626 | 626 | ('Globals', self.curframe.f_globals)] |
|
627 | 627 | self.shell.find_line_magic('pfile')(arg, namespaces=namespaces) |
|
628 | 628 | |
|
629 | 629 | def do_pinfo(self, arg): |
|
630 | 630 | """Provide detailed information about an object. |
|
631 | 631 | |
|
632 | 632 | The debugger interface to %pinfo, i.e., obj?.""" |
|
633 | 633 | namespaces = [('Locals', self.curframe.f_locals), |
|
634 | 634 | ('Globals', self.curframe.f_globals)] |
|
635 | 635 | self.shell.find_line_magic('pinfo')(arg, namespaces=namespaces) |
|
636 | 636 | |
|
637 | 637 | def do_pinfo2(self, arg): |
|
638 | 638 | """Provide extra detailed information about an object. |
|
639 | 639 | |
|
640 | 640 | The debugger interface to %pinfo2, i.e., obj??.""" |
|
641 | 641 | namespaces = [('Locals', self.curframe.f_locals), |
|
642 | 642 | ('Globals', self.curframe.f_globals)] |
|
643 | 643 | self.shell.find_line_magic('pinfo2')(arg, namespaces=namespaces) |
|
644 | 644 | |
|
645 | 645 | def do_psource(self, arg): |
|
646 | 646 | """Print (or run through pager) the source code for an object.""" |
|
647 | 647 | namespaces = [('Locals', self.curframe.f_locals), |
|
648 | 648 | ('Globals', self.curframe.f_globals)] |
|
649 | 649 | self.shell.find_line_magic('psource')(arg, namespaces=namespaces) |
|
650 | 650 | |
|
651 | 651 | def do_where(self, arg): |
|
652 | 652 | """w(here) |
|
653 | 653 | Print a stack trace, with the most recent frame at the bottom. |
|
654 | 654 | An arrow indicates the "current frame", which determines the |
|
655 | 655 | context of most commands. 'bt' is an alias for this command. |
|
656 | 656 | |
|
657 | 657 | Take a number as argument as an (optional) number of context line to |
|
658 | 658 | print""" |
|
659 | 659 | if arg: |
|
660 | 660 | try: |
|
661 | 661 | context = int(arg) |
|
662 | 662 | except ValueError as err: |
|
663 | 663 | self.error(err) |
|
664 | 664 | return |
|
665 | 665 | self.print_stack_trace(context) |
|
666 | 666 | else: |
|
667 | 667 | self.print_stack_trace() |
|
668 | 668 | |
|
669 | 669 | do_w = do_where |
|
670 | 670 | |
|
671 | 671 | def stop_here(self, frame): |
|
672 | 672 | hidden = False |
|
673 | 673 | if self.skip_hidden: |
|
674 | 674 | hidden = frame.f_locals.get("__tracebackhide__", False) |
|
675 | 675 | if hidden: |
|
676 | 676 | Colors = self.color_scheme_table.active_colors |
|
677 | 677 | ColorsNormal = Colors.Normal |
|
678 | 678 | print(f"{Colors.excName} [... skipped 1 hidden frame]{ColorsNormal}\n") |
|
679 | 679 | |
|
680 | 680 | return super().stop_here(frame) |
|
681 | 681 | |
|
682 | 682 | def do_up(self, arg): |
|
683 | 683 | """u(p) [count] |
|
684 | 684 | Move the current frame count (default one) levels up in the |
|
685 | 685 | stack trace (to an older frame). |
|
686 | 686 | |
|
687 | 687 | Will skip hidden frames. |
|
688 | 688 | """ |
|
689 | 689 | ## modified version of upstream that skips |
|
690 | 690 | # frames with __tracebackide__ |
|
691 | 691 | if self.curindex == 0: |
|
692 | 692 | self.error("Oldest frame") |
|
693 | 693 | return |
|
694 | 694 | try: |
|
695 | 695 | count = int(arg or 1) |
|
696 | 696 | except ValueError: |
|
697 | 697 | self.error("Invalid frame count (%s)" % arg) |
|
698 | 698 | return |
|
699 | 699 | skipped = 0 |
|
700 | 700 | if count < 0: |
|
701 | 701 | _newframe = 0 |
|
702 | 702 | else: |
|
703 | 703 | _newindex = self.curindex |
|
704 | 704 | counter = 0 |
|
705 | 705 | hidden_frames = self.hidden_frames(self.stack) |
|
706 | 706 | for i in range(self.curindex - 1, -1, -1): |
|
707 | 707 | frame = self.stack[i][0] |
|
708 | 708 | if hidden_frames[i] and self.skip_hidden: |
|
709 | 709 | skipped += 1 |
|
710 | 710 | continue |
|
711 | 711 | counter += 1 |
|
712 | 712 | if counter >= count: |
|
713 | 713 | break |
|
714 | 714 | else: |
|
715 | 715 | # if no break occured. |
|
716 |
self.error( |
|
|
716 | self.error( | |
|
717 | "all frames above hidden, use `skip_hidden False` to get get into those." | |
|
718 | ) | |
|
717 | 719 | return |
|
718 | 720 | |
|
719 | 721 | Colors = self.color_scheme_table.active_colors |
|
720 | 722 | ColorsNormal = Colors.Normal |
|
721 | 723 | _newframe = i |
|
722 | 724 | self._select_frame(_newframe) |
|
723 | 725 | if skipped: |
|
724 | 726 | print( |
|
725 | 727 | f"{Colors.excName} [... skipped {skipped} hidden frame(s)]{ColorsNormal}\n" |
|
726 | 728 | ) |
|
727 | 729 | |
|
728 | 730 | def do_down(self, arg): |
|
729 | 731 | """d(own) [count] |
|
730 | 732 | Move the current frame count (default one) levels down in the |
|
731 | 733 | stack trace (to a newer frame). |
|
732 | 734 | |
|
733 | 735 | Will skip hidden frames. |
|
734 | 736 | """ |
|
735 | 737 | if self.curindex + 1 == len(self.stack): |
|
736 | 738 | self.error("Newest frame") |
|
737 | 739 | return |
|
738 | 740 | try: |
|
739 | 741 | count = int(arg or 1) |
|
740 | 742 | except ValueError: |
|
741 | 743 | self.error("Invalid frame count (%s)" % arg) |
|
742 | 744 | return |
|
743 | 745 | if count < 0: |
|
744 | 746 | _newframe = len(self.stack) - 1 |
|
745 | 747 | else: |
|
746 | 748 | _newindex = self.curindex |
|
747 | 749 | counter = 0 |
|
748 | 750 | skipped = 0 |
|
749 | 751 | hidden_frames = self.hidden_frames(self.stack) |
|
750 | 752 | for i in range(self.curindex + 1, len(self.stack)): |
|
751 | 753 | frame = self.stack[i][0] |
|
752 | 754 | if hidden_frames[i] and self.skip_hidden: |
|
753 | 755 | skipped += 1 |
|
754 | 756 | continue |
|
755 | 757 | counter += 1 |
|
756 | 758 | if counter >= count: |
|
757 | 759 | break |
|
758 | 760 | else: |
|
759 |
self.error( |
|
|
761 | self.error( | |
|
762 | "all frames bellow hidden, use `skip_hidden False` to get get into those." | |
|
763 | ) | |
|
760 | 764 | return |
|
761 | 765 | |
|
762 | 766 | Colors = self.color_scheme_table.active_colors |
|
763 | 767 | ColorsNormal = Colors.Normal |
|
764 | 768 | if skipped: |
|
765 | 769 | print( |
|
766 | 770 | f"{Colors.excName} [... skipped {skipped} hidden frame(s)]{ColorsNormal}\n" |
|
767 | 771 | ) |
|
768 | 772 | _newframe = i |
|
769 | 773 | |
|
770 | 774 | self._select_frame(_newframe) |
|
771 | 775 | |
|
772 | 776 | do_d = do_down |
|
773 | 777 | do_u = do_up |
|
774 | 778 | |
|
775 | 779 | class InterruptiblePdb(Pdb): |
|
776 | 780 | """Version of debugger where KeyboardInterrupt exits the debugger altogether.""" |
|
777 | 781 | |
|
778 | 782 | def cmdloop(self): |
|
779 | 783 | """Wrap cmdloop() such that KeyboardInterrupt stops the debugger.""" |
|
780 | 784 | try: |
|
781 | 785 | return OldPdb.cmdloop(self) |
|
782 | 786 | except KeyboardInterrupt: |
|
783 | 787 | self.stop_here = lambda frame: False |
|
784 | 788 | self.do_quit("") |
|
785 | 789 | sys.settrace(None) |
|
786 | 790 | self.quitting = False |
|
787 | 791 | raise |
|
788 | 792 | |
|
789 | 793 | def _cmdloop(self): |
|
790 | 794 | while True: |
|
791 | 795 | try: |
|
792 | 796 | # keyboard interrupts allow for an easy way to cancel |
|
793 | 797 | # the current command, so allow them during interactive input |
|
794 | 798 | self.allow_kbdint = True |
|
795 | 799 | self.cmdloop() |
|
796 | 800 | self.allow_kbdint = False |
|
797 | 801 | break |
|
798 | 802 | except KeyboardInterrupt: |
|
799 | 803 | self.message('--KeyboardInterrupt--') |
|
800 | 804 | raise |
|
801 | 805 | |
|
802 | 806 | |
|
803 | 807 | def set_trace(frame=None): |
|
804 | 808 | """ |
|
805 | 809 | Start debugging from `frame`. |
|
806 | 810 | |
|
807 | 811 | If frame is not specified, debugging starts from caller's frame. |
|
808 | 812 | """ |
|
809 | 813 | Pdb().set_trace(frame or sys._getframe().f_back) |
@@ -1,1206 +1,1206 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Top-level display functions for displaying object in different formats.""" |
|
3 | 3 | |
|
4 | 4 | # Copyright (c) IPython Development Team. |
|
5 | 5 | # Distributed under the terms of the Modified BSD License. |
|
6 | 6 | |
|
7 | 7 | |
|
8 | 8 | from binascii import b2a_base64, hexlify |
|
9 | 9 | import json |
|
10 | 10 | import mimetypes |
|
11 | 11 | import os |
|
12 | 12 | import struct |
|
13 | 13 | import warnings |
|
14 | 14 | from copy import deepcopy |
|
15 | 15 | from os.path import splitext |
|
16 | 16 | from pathlib import Path, PurePath |
|
17 | 17 | |
|
18 | 18 | from IPython.utils.py3compat import cast_unicode |
|
19 | 19 | from IPython.testing.skipdoctest import skip_doctest |
|
20 | 20 | from . import display_functions |
|
21 | 21 | |
|
22 | 22 | |
|
23 | 23 | __all__ = ['display_pretty', 'display_html', 'display_markdown', |
|
24 | 24 | 'display_svg', 'display_png', 'display_jpeg', 'display_latex', 'display_json', |
|
25 | 25 | 'display_javascript', 'display_pdf', 'DisplayObject', 'TextDisplayObject', |
|
26 | 26 | 'Pretty', 'HTML', 'Markdown', 'Math', 'Latex', 'SVG', 'ProgressBar', 'JSON', |
|
27 | 27 | 'GeoJSON', 'Javascript', 'Image', 'set_matplotlib_formats', |
|
28 | 28 | 'set_matplotlib_close', |
|
29 | 29 | 'Video'] |
|
30 | 30 | |
|
31 | 31 | _deprecated_names = ["display", "clear_output", "publish_display_data", "update_display", "DisplayHandle"] |
|
32 | 32 | |
|
33 | 33 | __all__ = __all__ + _deprecated_names |
|
34 | 34 | |
|
35 | 35 | |
|
36 | 36 | # ----- warn to import from IPython.display ----- |
|
37 | 37 | |
|
38 | 38 | from warnings import warn |
|
39 | 39 | |
|
40 | 40 | |
|
41 | 41 | def __getattr__(name): |
|
42 | 42 | if name in _deprecated_names: |
|
43 | 43 | warn(f"Importing {name} from IPython.core.display is deprecated since IPython 7.14, please import from IPython display", DeprecationWarning, stacklevel=2) |
|
44 | 44 | return getattr(display_functions, name) |
|
45 | 45 | |
|
46 | 46 | if name in globals().keys(): |
|
47 | 47 | return globals()[name] |
|
48 | 48 | else: |
|
49 | 49 | raise AttributeError(f"module {__name__} has no attribute {name}") |
|
50 | 50 | |
|
51 | 51 | |
|
52 | 52 | #----------------------------------------------------------------------------- |
|
53 | 53 | # utility functions |
|
54 | 54 | #----------------------------------------------------------------------------- |
|
55 | 55 | |
|
56 | 56 | def _safe_exists(path): |
|
57 | 57 | """Check path, but don't let exceptions raise""" |
|
58 | 58 | try: |
|
59 | 59 | return os.path.exists(path) |
|
60 | 60 | except Exception: |
|
61 | 61 | return False |
|
62 | 62 | |
|
63 | 63 | |
|
64 | 64 | def _display_mimetype(mimetype, objs, raw=False, metadata=None): |
|
65 | 65 | """internal implementation of all display_foo methods |
|
66 | 66 | |
|
67 | 67 | Parameters |
|
68 | 68 | ---------- |
|
69 | 69 | mimetype : str |
|
70 | 70 | The mimetype to be published (e.g. 'image/png') |
|
71 | 71 | *objs : object |
|
72 | 72 | The Python objects to display, or if raw=True raw text data to |
|
73 | 73 | display. |
|
74 | 74 | raw : bool |
|
75 | 75 | Are the data objects raw data or Python objects that need to be |
|
76 | 76 | formatted before display? [default: False] |
|
77 | 77 | metadata : dict (optional) |
|
78 | 78 | Metadata to be associated with the specific mimetype output. |
|
79 | 79 | """ |
|
80 | 80 | if metadata: |
|
81 | 81 | metadata = {mimetype: metadata} |
|
82 | 82 | if raw: |
|
83 | 83 | # turn list of pngdata into list of { 'image/png': pngdata } |
|
84 | 84 | objs = [ {mimetype: obj} for obj in objs ] |
|
85 | 85 | display(*objs, raw=raw, metadata=metadata, include=[mimetype]) |
|
86 | 86 | |
|
87 | 87 | #----------------------------------------------------------------------------- |
|
88 | 88 | # Main functions |
|
89 | 89 | #----------------------------------------------------------------------------- |
|
90 | 90 | |
|
91 | 91 | |
|
92 | 92 | def display_pretty(*objs, **kwargs): |
|
93 | 93 | """Display the pretty (default) representation of an object. |
|
94 | 94 | |
|
95 | 95 | Parameters |
|
96 | 96 | ---------- |
|
97 | 97 | *objs : object |
|
98 | 98 | The Python objects to display, or if raw=True raw text data to |
|
99 | 99 | display. |
|
100 | 100 | raw : bool |
|
101 | 101 | Are the data objects raw data or Python objects that need to be |
|
102 | 102 | formatted before display? [default: False] |
|
103 | 103 | metadata : dict (optional) |
|
104 | 104 | Metadata to be associated with the specific mimetype output. |
|
105 | 105 | """ |
|
106 | 106 | _display_mimetype('text/plain', objs, **kwargs) |
|
107 | 107 | |
|
108 | 108 | |
|
109 | 109 | def display_html(*objs, **kwargs): |
|
110 | 110 | """Display the HTML representation of an object. |
|
111 | 111 | |
|
112 | 112 | Note: If raw=False and the object does not have a HTML |
|
113 | 113 | representation, no HTML will be shown. |
|
114 | 114 | |
|
115 | 115 | Parameters |
|
116 | 116 | ---------- |
|
117 | 117 | *objs : object |
|
118 | 118 | The Python objects to display, or if raw=True raw HTML data to |
|
119 | 119 | display. |
|
120 | 120 | raw : bool |
|
121 | 121 | Are the data objects raw data or Python objects that need to be |
|
122 | 122 | formatted before display? [default: False] |
|
123 | 123 | metadata : dict (optional) |
|
124 | 124 | Metadata to be associated with the specific mimetype output. |
|
125 | 125 | """ |
|
126 | 126 | _display_mimetype('text/html', objs, **kwargs) |
|
127 | 127 | |
|
128 | 128 | |
|
129 | 129 | def display_markdown(*objs, **kwargs): |
|
130 | 130 | """Displays the Markdown representation of an object. |
|
131 | 131 | |
|
132 | 132 | Parameters |
|
133 | 133 | ---------- |
|
134 | 134 | *objs : object |
|
135 | 135 | The Python objects to display, or if raw=True raw markdown data to |
|
136 | 136 | display. |
|
137 | 137 | raw : bool |
|
138 | 138 | Are the data objects raw data or Python objects that need to be |
|
139 | 139 | formatted before display? [default: False] |
|
140 | 140 | metadata : dict (optional) |
|
141 | 141 | Metadata to be associated with the specific mimetype output. |
|
142 | 142 | """ |
|
143 | 143 | |
|
144 | 144 | _display_mimetype('text/markdown', objs, **kwargs) |
|
145 | 145 | |
|
146 | 146 | |
|
147 | 147 | def display_svg(*objs, **kwargs): |
|
148 | 148 | """Display the SVG representation of an object. |
|
149 | 149 | |
|
150 | 150 | Parameters |
|
151 | 151 | ---------- |
|
152 | 152 | *objs : object |
|
153 | 153 | The Python objects to display, or if raw=True raw svg data to |
|
154 | 154 | display. |
|
155 | 155 | raw : bool |
|
156 | 156 | Are the data objects raw data or Python objects that need to be |
|
157 | 157 | formatted before display? [default: False] |
|
158 | 158 | metadata : dict (optional) |
|
159 | 159 | Metadata to be associated with the specific mimetype output. |
|
160 | 160 | """ |
|
161 | 161 | _display_mimetype('image/svg+xml', objs, **kwargs) |
|
162 | 162 | |
|
163 | 163 | |
|
164 | 164 | def display_png(*objs, **kwargs): |
|
165 | 165 | """Display the PNG representation of an object. |
|
166 | 166 | |
|
167 | 167 | Parameters |
|
168 | 168 | ---------- |
|
169 | 169 | *objs : object |
|
170 | 170 | The Python objects to display, or if raw=True raw png data to |
|
171 | 171 | display. |
|
172 | 172 | raw : bool |
|
173 | 173 | Are the data objects raw data or Python objects that need to be |
|
174 | 174 | formatted before display? [default: False] |
|
175 | 175 | metadata : dict (optional) |
|
176 | 176 | Metadata to be associated with the specific mimetype output. |
|
177 | 177 | """ |
|
178 | 178 | _display_mimetype('image/png', objs, **kwargs) |
|
179 | 179 | |
|
180 | 180 | |
|
181 | 181 | def display_jpeg(*objs, **kwargs): |
|
182 | 182 | """Display the JPEG representation of an object. |
|
183 | 183 | |
|
184 | 184 | Parameters |
|
185 | 185 | ---------- |
|
186 | 186 | *objs : object |
|
187 | 187 | The Python objects to display, or if raw=True raw JPEG data to |
|
188 | 188 | display. |
|
189 | 189 | raw : bool |
|
190 | 190 | Are the data objects raw data or Python objects that need to be |
|
191 | 191 | formatted before display? [default: False] |
|
192 | 192 | metadata : dict (optional) |
|
193 | 193 | Metadata to be associated with the specific mimetype output. |
|
194 | 194 | """ |
|
195 | 195 | _display_mimetype('image/jpeg', objs, **kwargs) |
|
196 | 196 | |
|
197 | 197 | |
|
198 | 198 | def display_latex(*objs, **kwargs): |
|
199 | 199 | """Display the LaTeX representation of an object. |
|
200 | 200 | |
|
201 | 201 | Parameters |
|
202 | 202 | ---------- |
|
203 | 203 | *objs : object |
|
204 | 204 | The Python objects to display, or if raw=True raw latex data to |
|
205 | 205 | display. |
|
206 | 206 | raw : bool |
|
207 | 207 | Are the data objects raw data or Python objects that need to be |
|
208 | 208 | formatted before display? [default: False] |
|
209 | 209 | metadata : dict (optional) |
|
210 | 210 | Metadata to be associated with the specific mimetype output. |
|
211 | 211 | """ |
|
212 | 212 | _display_mimetype('text/latex', objs, **kwargs) |
|
213 | 213 | |
|
214 | 214 | |
|
215 | 215 | def display_json(*objs, **kwargs): |
|
216 | 216 | """Display the JSON representation of an object. |
|
217 | 217 | |
|
218 | 218 | Note that not many frontends support displaying JSON. |
|
219 | 219 | |
|
220 | 220 | Parameters |
|
221 | 221 | ---------- |
|
222 | 222 | *objs : object |
|
223 | 223 | The Python objects to display, or if raw=True raw json data to |
|
224 | 224 | display. |
|
225 | 225 | raw : bool |
|
226 | 226 | Are the data objects raw data or Python objects that need to be |
|
227 | 227 | formatted before display? [default: False] |
|
228 | 228 | metadata : dict (optional) |
|
229 | 229 | Metadata to be associated with the specific mimetype output. |
|
230 | 230 | """ |
|
231 | 231 | _display_mimetype('application/json', objs, **kwargs) |
|
232 | 232 | |
|
233 | 233 | |
|
234 | 234 | def display_javascript(*objs, **kwargs): |
|
235 | 235 | """Display the Javascript representation of an object. |
|
236 | 236 | |
|
237 | 237 | Parameters |
|
238 | 238 | ---------- |
|
239 | 239 | *objs : object |
|
240 | 240 | The Python objects to display, or if raw=True raw javascript data to |
|
241 | 241 | display. |
|
242 | 242 | raw : bool |
|
243 | 243 | Are the data objects raw data or Python objects that need to be |
|
244 | 244 | formatted before display? [default: False] |
|
245 | 245 | metadata : dict (optional) |
|
246 | 246 | Metadata to be associated with the specific mimetype output. |
|
247 | 247 | """ |
|
248 | 248 | _display_mimetype('application/javascript', objs, **kwargs) |
|
249 | 249 | |
|
250 | 250 | |
|
251 | 251 | def display_pdf(*objs, **kwargs): |
|
252 | 252 | """Display the PDF representation of an object. |
|
253 | 253 | |
|
254 | 254 | Parameters |
|
255 | 255 | ---------- |
|
256 | 256 | *objs : object |
|
257 | 257 | The Python objects to display, or if raw=True raw javascript data to |
|
258 | 258 | display. |
|
259 | 259 | raw : bool |
|
260 | 260 | Are the data objects raw data or Python objects that need to be |
|
261 | 261 | formatted before display? [default: False] |
|
262 | 262 | metadata : dict (optional) |
|
263 | 263 | Metadata to be associated with the specific mimetype output. |
|
264 | 264 | """ |
|
265 | 265 | _display_mimetype('application/pdf', objs, **kwargs) |
|
266 | 266 | |
|
267 | 267 | |
|
268 | 268 | #----------------------------------------------------------------------------- |
|
269 | 269 | # Smart classes |
|
270 | 270 | #----------------------------------------------------------------------------- |
|
271 | 271 | |
|
272 | 272 | |
|
273 | 273 | class DisplayObject(object): |
|
274 | 274 | """An object that wraps data to be displayed.""" |
|
275 | 275 | |
|
276 | 276 | _read_flags = 'r' |
|
277 | 277 | _show_mem_addr = False |
|
278 | 278 | metadata = None |
|
279 | 279 | |
|
280 | 280 | def __init__(self, data=None, url=None, filename=None, metadata=None): |
|
281 | 281 | """Create a display object given raw data. |
|
282 | 282 | |
|
283 | 283 | When this object is returned by an expression or passed to the |
|
284 | 284 | display function, it will result in the data being displayed |
|
285 | 285 | in the frontend. The MIME type of the data should match the |
|
286 | 286 | subclasses used, so the Png subclass should be used for 'image/png' |
|
287 | 287 | data. If the data is a URL, the data will first be downloaded |
|
288 | 288 | and then displayed. If |
|
289 | 289 | |
|
290 | 290 | Parameters |
|
291 | 291 | ---------- |
|
292 | 292 | data : unicode, str or bytes |
|
293 | 293 | The raw data or a URL or file to load the data from |
|
294 | 294 | url : unicode |
|
295 | 295 | A URL to download the data from. |
|
296 | 296 | filename : unicode |
|
297 | 297 | Path to a local file to load the data from. |
|
298 | 298 | metadata : dict |
|
299 | 299 | Dict of metadata associated to be the object when displayed |
|
300 | 300 | """ |
|
301 | 301 | if isinstance(data, (Path, PurePath)): |
|
302 | 302 | data = str(data) |
|
303 | 303 | |
|
304 | 304 | if data is not None and isinstance(data, str): |
|
305 | 305 | if data.startswith('http') and url is None: |
|
306 | 306 | url = data |
|
307 | 307 | filename = None |
|
308 | 308 | data = None |
|
309 | 309 | elif _safe_exists(data) and filename is None: |
|
310 | 310 | url = None |
|
311 | 311 | filename = data |
|
312 | 312 | data = None |
|
313 | 313 | |
|
314 | 314 | self.url = url |
|
315 | 315 | self.filename = filename |
|
316 | 316 | # because of @data.setter methods in |
|
317 | 317 | # subclasses ensure url and filename are set |
|
318 | 318 | # before assigning to self.data |
|
319 | 319 | self.data = data |
|
320 | 320 | |
|
321 | 321 | if metadata is not None: |
|
322 | 322 | self.metadata = metadata |
|
323 | 323 | elif self.metadata is None: |
|
324 | 324 | self.metadata = {} |
|
325 | 325 | |
|
326 | 326 | self.reload() |
|
327 | 327 | self._check_data() |
|
328 | 328 | |
|
329 | 329 | def __repr__(self): |
|
330 | 330 | if not self._show_mem_addr: |
|
331 | 331 | cls = self.__class__ |
|
332 | 332 | r = "<%s.%s object>" % (cls.__module__, cls.__name__) |
|
333 | 333 | else: |
|
334 | 334 | r = super(DisplayObject, self).__repr__() |
|
335 | 335 | return r |
|
336 | 336 | |
|
337 | 337 | def _check_data(self): |
|
338 | 338 | """Override in subclasses if there's something to check.""" |
|
339 | 339 | pass |
|
340 | 340 | |
|
341 | 341 | def _data_and_metadata(self): |
|
342 | 342 | """shortcut for returning metadata with shape information, if defined""" |
|
343 | 343 | if self.metadata: |
|
344 | 344 | return self.data, deepcopy(self.metadata) |
|
345 | 345 | else: |
|
346 | 346 | return self.data |
|
347 | 347 | |
|
348 | 348 | def reload(self): |
|
349 | 349 | """Reload the raw data from file or URL.""" |
|
350 | 350 | if self.filename is not None: |
|
351 | 351 | with open(self.filename, self._read_flags) as f: |
|
352 | 352 | self.data = f.read() |
|
353 | 353 | elif self.url is not None: |
|
354 | 354 | # Deferred import |
|
355 | 355 | from urllib.request import urlopen |
|
356 | 356 | response = urlopen(self.url) |
|
357 | 357 | data = response.read() |
|
358 | 358 | # extract encoding from header, if there is one: |
|
359 | 359 | encoding = None |
|
360 | 360 | if 'content-type' in response.headers: |
|
361 | 361 | for sub in response.headers['content-type'].split(';'): |
|
362 | 362 | sub = sub.strip() |
|
363 | 363 | if sub.startswith('charset'): |
|
364 | 364 | encoding = sub.split('=')[-1].strip() |
|
365 | 365 | break |
|
366 | 366 | if 'content-encoding' in response.headers: |
|
367 | 367 | # TODO: do deflate? |
|
368 | 368 | if 'gzip' in response.headers['content-encoding']: |
|
369 | 369 | import gzip |
|
370 | 370 | from io import BytesIO |
|
371 | 371 | with gzip.open(BytesIO(data), 'rt', encoding=encoding) as fp: |
|
372 | 372 | encoding = None |
|
373 | 373 | data = fp.read() |
|
374 | 374 | |
|
375 | 375 | # decode data, if an encoding was specified |
|
376 | 376 | # We only touch self.data once since |
|
377 | 377 | # subclasses such as SVG have @data.setter methods |
|
378 | 378 | # that transform self.data into ... well svg. |
|
379 | 379 | if encoding: |
|
380 | 380 | self.data = data.decode(encoding, 'replace') |
|
381 | 381 | else: |
|
382 | 382 | self.data = data |
|
383 | 383 | |
|
384 | 384 | |
|
385 | 385 | class TextDisplayObject(DisplayObject): |
|
386 | 386 | """Validate that display data is text""" |
|
387 | 387 | def _check_data(self): |
|
388 | 388 | if self.data is not None and not isinstance(self.data, str): |
|
389 | 389 | raise TypeError("%s expects text, not %r" % (self.__class__.__name__, self.data)) |
|
390 | 390 | |
|
391 | 391 | class Pretty(TextDisplayObject): |
|
392 | 392 | |
|
393 | 393 | def _repr_pretty_(self, pp, cycle): |
|
394 | 394 | return pp.text(self.data) |
|
395 | 395 | |
|
396 | 396 | |
|
397 | 397 | class HTML(TextDisplayObject): |
|
398 | 398 | |
|
399 | 399 | def __init__(self, data=None, url=None, filename=None, metadata=None): |
|
400 | 400 | def warn(): |
|
401 | 401 | if not data: |
|
402 | 402 | return False |
|
403 | 403 | |
|
404 | 404 | # |
|
405 | 405 | # Avoid calling lower() on the entire data, because it could be a |
|
406 | 406 | # long string and we're only interested in its beginning and end. |
|
407 | 407 | # |
|
408 | 408 | prefix = data[:10].lower() |
|
409 | 409 | suffix = data[-10:].lower() |
|
410 | 410 | return prefix.startswith("<iframe ") and suffix.endswith("</iframe>") |
|
411 | 411 | |
|
412 | 412 | if warn(): |
|
413 | 413 | warnings.warn("Consider using IPython.display.IFrame instead") |
|
414 | 414 | super(HTML, self).__init__(data=data, url=url, filename=filename, metadata=metadata) |
|
415 | 415 | |
|
416 | 416 | def _repr_html_(self): |
|
417 | 417 | return self._data_and_metadata() |
|
418 | 418 | |
|
419 | 419 | def __html__(self): |
|
420 | 420 | """ |
|
421 | 421 | This method exists to inform other HTML-using modules (e.g. Markupsafe, |
|
422 | 422 | htmltag, etc) that this object is HTML and does not need things like |
|
423 | 423 | special characters (<>&) escaped. |
|
424 | 424 | """ |
|
425 | 425 | return self._repr_html_() |
|
426 | 426 | |
|
427 | 427 | |
|
428 | 428 | class Markdown(TextDisplayObject): |
|
429 | 429 | |
|
430 | 430 | def _repr_markdown_(self): |
|
431 | 431 | return self._data_and_metadata() |
|
432 | 432 | |
|
433 | 433 | |
|
434 | 434 | class Math(TextDisplayObject): |
|
435 | 435 | |
|
436 | 436 | def _repr_latex_(self): |
|
437 | 437 | s = r"$\displaystyle %s$" % self.data.strip('$') |
|
438 | 438 | if self.metadata: |
|
439 | 439 | return s, deepcopy(self.metadata) |
|
440 | 440 | else: |
|
441 | 441 | return s |
|
442 | 442 | |
|
443 | 443 | |
|
444 | 444 | class Latex(TextDisplayObject): |
|
445 | 445 | |
|
446 | 446 | def _repr_latex_(self): |
|
447 | 447 | return self._data_and_metadata() |
|
448 | 448 | |
|
449 | 449 | |
|
450 | 450 | class SVG(DisplayObject): |
|
451 | 451 | """Embed an SVG into the display. |
|
452 | 452 | |
|
453 | 453 | Note if you just want to view a svg image via a URL use `:class:Image` with |
|
454 | 454 | a url=URL keyword argument. |
|
455 | 455 | """ |
|
456 | 456 | |
|
457 | 457 | _read_flags = 'rb' |
|
458 | 458 | # wrap data in a property, which extracts the <svg> tag, discarding |
|
459 | 459 | # document headers |
|
460 | 460 | _data = None |
|
461 | 461 | |
|
462 | 462 | @property |
|
463 | 463 | def data(self): |
|
464 | 464 | return self._data |
|
465 | 465 | |
|
466 | 466 | @data.setter |
|
467 | 467 | def data(self, svg): |
|
468 | 468 | if svg is None: |
|
469 | 469 | self._data = None |
|
470 | 470 | return |
|
471 | 471 | # parse into dom object |
|
472 | 472 | from xml.dom import minidom |
|
473 | 473 | x = minidom.parseString(svg) |
|
474 | 474 | # get svg tag (should be 1) |
|
475 | 475 | found_svg = x.getElementsByTagName('svg') |
|
476 | 476 | if found_svg: |
|
477 | 477 | svg = found_svg[0].toxml() |
|
478 | 478 | else: |
|
479 | 479 | # fallback on the input, trust the user |
|
480 | 480 | # but this is probably an error. |
|
481 | 481 | pass |
|
482 | 482 | svg = cast_unicode(svg) |
|
483 | 483 | self._data = svg |
|
484 | 484 | |
|
485 | 485 | def _repr_svg_(self): |
|
486 | 486 | return self._data_and_metadata() |
|
487 | 487 | |
|
488 | 488 | class ProgressBar(DisplayObject): |
|
489 | 489 | """Progressbar supports displaying a progressbar like element |
|
490 | 490 | """ |
|
491 | 491 | def __init__(self, total): |
|
492 | 492 | """Creates a new progressbar |
|
493 | 493 | |
|
494 | 494 | Parameters |
|
495 | 495 | ---------- |
|
496 | 496 | total : int |
|
497 | 497 | maximum size of the progressbar |
|
498 | 498 | """ |
|
499 | 499 | self.total = total |
|
500 | 500 | self._progress = 0 |
|
501 | 501 | self.html_width = '60ex' |
|
502 | 502 | self.text_width = 60 |
|
503 | 503 | self._display_id = hexlify(os.urandom(8)).decode('ascii') |
|
504 | 504 | |
|
505 | 505 | def __repr__(self): |
|
506 | 506 | fraction = self.progress / self.total |
|
507 | 507 | filled = '=' * int(fraction * self.text_width) |
|
508 | 508 | rest = ' ' * (self.text_width - len(filled)) |
|
509 | 509 | return '[{}{}] {}/{}'.format( |
|
510 | 510 | filled, rest, |
|
511 | 511 | self.progress, self.total, |
|
512 | 512 | ) |
|
513 | 513 | |
|
514 | 514 | def _repr_html_(self): |
|
515 | 515 | return "<progress style='width:{}' max='{}' value='{}'></progress>".format( |
|
516 | 516 | self.html_width, self.total, self.progress) |
|
517 | 517 | |
|
518 | 518 | def display(self): |
|
519 | 519 | display(self, display_id=self._display_id) |
|
520 | 520 | |
|
521 | 521 | def update(self): |
|
522 | 522 | display(self, display_id=self._display_id, update=True) |
|
523 | 523 | |
|
524 | 524 | @property |
|
525 | 525 | def progress(self): |
|
526 | 526 | return self._progress |
|
527 | 527 | |
|
528 | 528 | @progress.setter |
|
529 | 529 | def progress(self, value): |
|
530 | 530 | self._progress = value |
|
531 | 531 | self.update() |
|
532 | 532 | |
|
533 | 533 | def __iter__(self): |
|
534 | 534 | self.display() |
|
535 | 535 | self._progress = -1 # First iteration is 0 |
|
536 | 536 | return self |
|
537 | 537 | |
|
538 | 538 | def __next__(self): |
|
539 | 539 | """Returns current value and increments display by one.""" |
|
540 | 540 | self.progress += 1 |
|
541 | 541 | if self.progress < self.total: |
|
542 | 542 | return self.progress |
|
543 | 543 | else: |
|
544 | 544 | raise StopIteration() |
|
545 | 545 | |
|
546 | 546 | class JSON(DisplayObject): |
|
547 | 547 | """JSON expects a JSON-able dict or list |
|
548 | 548 | |
|
549 | 549 | not an already-serialized JSON string. |
|
550 | 550 | |
|
551 | 551 | Scalar types (None, number, string) are not allowed, only dict or list containers. |
|
552 | 552 | """ |
|
553 | 553 | # wrap data in a property, which warns about passing already-serialized JSON |
|
554 | 554 | _data = None |
|
555 | 555 | def __init__(self, data=None, url=None, filename=None, expanded=False, metadata=None, root='root', **kwargs): |
|
556 | 556 | """Create a JSON display object given raw data. |
|
557 | 557 | |
|
558 | 558 | Parameters |
|
559 | 559 | ---------- |
|
560 | 560 | data : dict or list |
|
561 | 561 | JSON data to display. Not an already-serialized JSON string. |
|
562 | 562 | Scalar types (None, number, string) are not allowed, only dict |
|
563 | 563 | or list containers. |
|
564 | 564 | url : unicode |
|
565 | 565 | A URL to download the data from. |
|
566 | 566 | filename : unicode |
|
567 | 567 | Path to a local file to load the data from. |
|
568 | 568 | expanded : boolean |
|
569 | 569 | Metadata to control whether a JSON display component is expanded. |
|
570 | 570 | metadata: dict |
|
571 | 571 | Specify extra metadata to attach to the json display object. |
|
572 | 572 | root : str |
|
573 | 573 | The name of the root element of the JSON tree |
|
574 | 574 | """ |
|
575 | 575 | self.metadata = { |
|
576 | 576 | 'expanded': expanded, |
|
577 | 577 | 'root': root, |
|
578 | 578 | } |
|
579 | 579 | if metadata: |
|
580 | 580 | self.metadata.update(metadata) |
|
581 | 581 | if kwargs: |
|
582 | 582 | self.metadata.update(kwargs) |
|
583 | 583 | super(JSON, self).__init__(data=data, url=url, filename=filename) |
|
584 | 584 | |
|
585 | 585 | def _check_data(self): |
|
586 | 586 | if self.data is not None and not isinstance(self.data, (dict, list)): |
|
587 | 587 | raise TypeError("%s expects JSONable dict or list, not %r" % (self.__class__.__name__, self.data)) |
|
588 | 588 | |
|
589 | 589 | @property |
|
590 | 590 | def data(self): |
|
591 | 591 | return self._data |
|
592 | 592 | |
|
593 | 593 | @data.setter |
|
594 | 594 | def data(self, data): |
|
595 | 595 | if isinstance(data, (Path, PurePath)): |
|
596 | 596 | data = str(data) |
|
597 | 597 | |
|
598 | 598 | if isinstance(data, str): |
|
599 | 599 | if self.filename is None and self.url is None: |
|
600 | 600 | warnings.warn("JSON expects JSONable dict or list, not JSON strings") |
|
601 | 601 | data = json.loads(data) |
|
602 | 602 | self._data = data |
|
603 | 603 | |
|
604 | 604 | def _data_and_metadata(self): |
|
605 | 605 | return self.data, self.metadata |
|
606 | 606 | |
|
607 | 607 | def _repr_json_(self): |
|
608 | 608 | return self._data_and_metadata() |
|
609 | 609 | |
|
610 | 610 | _css_t = """var link = document.createElement("link"); |
|
611 | 611 | link.ref = "stylesheet"; |
|
612 | 612 | link.type = "text/css"; |
|
613 | 613 | link.href = "%s"; |
|
614 | 614 | document.head.appendChild(link); |
|
615 | 615 | """ |
|
616 | 616 | |
|
617 | 617 | _lib_t1 = """new Promise(function(resolve, reject) { |
|
618 | 618 | var script = document.createElement("script"); |
|
619 | 619 | script.onload = resolve; |
|
620 | 620 | script.onerror = reject; |
|
621 | 621 | script.src = "%s"; |
|
622 | 622 | document.head.appendChild(script); |
|
623 | 623 | }).then(() => { |
|
624 | 624 | """ |
|
625 | 625 | |
|
626 | 626 | _lib_t2 = """ |
|
627 | 627 | });""" |
|
628 | 628 | |
|
629 | 629 | class GeoJSON(JSON): |
|
630 | 630 | """GeoJSON expects JSON-able dict |
|
631 | 631 | |
|
632 | 632 | not an already-serialized JSON string. |
|
633 | 633 | |
|
634 | 634 | Scalar types (None, number, string) are not allowed, only dict containers. |
|
635 | 635 | """ |
|
636 | 636 | |
|
637 | 637 | def __init__(self, *args, **kwargs): |
|
638 | 638 | """Create a GeoJSON display object given raw data. |
|
639 | 639 | |
|
640 | 640 | Parameters |
|
641 | 641 | ---------- |
|
642 | 642 | data : dict or list |
|
643 | 643 | VegaLite data. Not an already-serialized JSON string. |
|
644 | 644 | Scalar types (None, number, string) are not allowed, only dict |
|
645 | 645 | or list containers. |
|
646 | 646 | url_template : string |
|
647 | 647 | Leaflet TileLayer URL template: http://leafletjs.com/reference.html#url-template |
|
648 | 648 | layer_options : dict |
|
649 | 649 | Leaflet TileLayer options: http://leafletjs.com/reference.html#tilelayer-options |
|
650 | 650 | url : unicode |
|
651 | 651 | A URL to download the data from. |
|
652 | 652 | filename : unicode |
|
653 | 653 | Path to a local file to load the data from. |
|
654 | 654 | metadata: dict |
|
655 | 655 | Specify extra metadata to attach to the json display object. |
|
656 | 656 | |
|
657 | 657 | Examples |
|
658 | 658 | -------- |
|
659 | 659 | |
|
660 | 660 | The following will display an interactive map of Mars with a point of |
|
661 | 661 | interest on frontend that do support GeoJSON display. |
|
662 | 662 | |
|
663 | 663 | >>> from IPython.display import GeoJSON |
|
664 | 664 | |
|
665 | 665 | >>> GeoJSON(data={ |
|
666 | 666 | ... "type": "Feature", |
|
667 | 667 | ... "geometry": { |
|
668 | 668 | ... "type": "Point", |
|
669 | 669 | ... "coordinates": [-81.327, 296.038] |
|
670 | 670 | ... } |
|
671 | 671 | ... }, |
|
672 | 672 | ... url_template="http://s3-eu-west-1.amazonaws.com/whereonmars.cartodb.net/{basemap_id}/{z}/{x}/{y}.png", |
|
673 | 673 | ... layer_options={ |
|
674 | 674 | ... "basemap_id": "celestia_mars-shaded-16k_global", |
|
675 | 675 | ... "attribution" : "Celestia/praesepe", |
|
676 | 676 | ... "minZoom" : 0, |
|
677 | 677 | ... "maxZoom" : 18, |
|
678 | 678 | ... }) |
|
679 | 679 | <IPython.core.display.GeoJSON object> |
|
680 | 680 | |
|
681 | 681 | In the terminal IPython, you will only see the text representation of |
|
682 | 682 | the GeoJSON object. |
|
683 | 683 | |
|
684 | 684 | """ |
|
685 | 685 | |
|
686 | 686 | super(GeoJSON, self).__init__(*args, **kwargs) |
|
687 | 687 | |
|
688 | 688 | |
|
689 | 689 | def _ipython_display_(self): |
|
690 | 690 | bundle = { |
|
691 | 691 | 'application/geo+json': self.data, |
|
692 | 692 | 'text/plain': '<IPython.display.GeoJSON object>' |
|
693 | 693 | } |
|
694 | 694 | metadata = { |
|
695 | 695 | 'application/geo+json': self.metadata |
|
696 | 696 | } |
|
697 | 697 | display(bundle, metadata=metadata, raw=True) |
|
698 | 698 | |
|
699 | 699 | class Javascript(TextDisplayObject): |
|
700 | 700 | |
|
701 | 701 | def __init__(self, data=None, url=None, filename=None, lib=None, css=None): |
|
702 | 702 | """Create a Javascript display object given raw data. |
|
703 | 703 | |
|
704 | 704 | When this object is returned by an expression or passed to the |
|
705 | 705 | display function, it will result in the data being displayed |
|
706 | 706 | in the frontend. If the data is a URL, the data will first be |
|
707 | 707 | downloaded and then displayed. |
|
708 | 708 | |
|
709 | 709 | In the Notebook, the containing element will be available as `element`, |
|
710 | 710 | and jQuery will be available. Content appended to `element` will be |
|
711 | 711 | visible in the output area. |
|
712 | 712 | |
|
713 | 713 | Parameters |
|
714 | 714 | ---------- |
|
715 | 715 | data : unicode, str or bytes |
|
716 | 716 | The Javascript source code or a URL to download it from. |
|
717 | 717 | url : unicode |
|
718 | 718 | A URL to download the data from. |
|
719 | 719 | filename : unicode |
|
720 | 720 | Path to a local file to load the data from. |
|
721 | 721 | lib : list or str |
|
722 | 722 | A sequence of Javascript library URLs to load asynchronously before |
|
723 | 723 | running the source code. The full URLs of the libraries should |
|
724 | 724 | be given. A single Javascript library URL can also be given as a |
|
725 | 725 | string. |
|
726 | 726 | css: : list or str |
|
727 | 727 | A sequence of css files to load before running the source code. |
|
728 | 728 | The full URLs of the css files should be given. A single css URL |
|
729 | 729 | can also be given as a string. |
|
730 | 730 | """ |
|
731 | 731 | if isinstance(lib, str): |
|
732 | 732 | lib = [lib] |
|
733 | 733 | elif lib is None: |
|
734 | 734 | lib = [] |
|
735 | 735 | if isinstance(css, str): |
|
736 | 736 | css = [css] |
|
737 | 737 | elif css is None: |
|
738 | 738 | css = [] |
|
739 | 739 | if not isinstance(lib, (list,tuple)): |
|
740 | 740 | raise TypeError('expected sequence, got: %r' % lib) |
|
741 | 741 | if not isinstance(css, (list,tuple)): |
|
742 | 742 | raise TypeError('expected sequence, got: %r' % css) |
|
743 | 743 | self.lib = lib |
|
744 | 744 | self.css = css |
|
745 | 745 | super(Javascript, self).__init__(data=data, url=url, filename=filename) |
|
746 | 746 | |
|
747 | 747 | def _repr_javascript_(self): |
|
748 | 748 | r = '' |
|
749 | 749 | for c in self.css: |
|
750 | 750 | r += _css_t % c |
|
751 | 751 | for l in self.lib: |
|
752 | 752 | r += _lib_t1 % l |
|
753 | 753 | r += self.data |
|
754 | 754 | r += _lib_t2*len(self.lib) |
|
755 | 755 | return r |
|
756 | 756 | |
|
757 | 757 | # constants for identifying png/jpeg data |
|
758 | 758 | _PNG = b'\x89PNG\r\n\x1a\n' |
|
759 | 759 | _JPEG = b'\xff\xd8' |
|
760 | 760 | |
|
761 | 761 | def _pngxy(data): |
|
762 | 762 | """read the (width, height) from a PNG header""" |
|
763 | 763 | ihdr = data.index(b'IHDR') |
|
764 | 764 | # next 8 bytes are width/height |
|
765 | 765 | return struct.unpack('>ii', data[ihdr+4:ihdr+12]) |
|
766 | 766 | |
|
767 | 767 | def _jpegxy(data): |
|
768 | 768 | """read the (width, height) from a JPEG header""" |
|
769 | 769 | # adapted from http://www.64lines.com/jpeg-width-height |
|
770 | 770 | |
|
771 | 771 | idx = 4 |
|
772 | 772 | while True: |
|
773 | 773 | block_size = struct.unpack('>H', data[idx:idx+2])[0] |
|
774 | 774 | idx = idx + block_size |
|
775 | 775 | if data[idx:idx+2] == b'\xFF\xC0': |
|
776 | 776 | # found Start of Frame |
|
777 | 777 | iSOF = idx |
|
778 | 778 | break |
|
779 | 779 | else: |
|
780 | 780 | # read another block |
|
781 | 781 | idx += 2 |
|
782 | 782 | |
|
783 | 783 | h, w = struct.unpack('>HH', data[iSOF+5:iSOF+9]) |
|
784 | 784 | return w, h |
|
785 | 785 | |
|
786 | 786 | def _gifxy(data): |
|
787 | 787 | """read the (width, height) from a GIF header""" |
|
788 | 788 | return struct.unpack('<HH', data[6:10]) |
|
789 | 789 | |
|
790 | 790 | |
|
791 | 791 | class Image(DisplayObject): |
|
792 | 792 | |
|
793 | 793 | _read_flags = 'rb' |
|
794 | 794 | _FMT_JPEG = u'jpeg' |
|
795 | 795 | _FMT_PNG = u'png' |
|
796 | 796 | _FMT_GIF = u'gif' |
|
797 | 797 | _ACCEPTABLE_EMBEDDINGS = [_FMT_JPEG, _FMT_PNG, _FMT_GIF] |
|
798 | 798 | _MIMETYPES = { |
|
799 | 799 | _FMT_PNG: 'image/png', |
|
800 | 800 | _FMT_JPEG: 'image/jpeg', |
|
801 | 801 | _FMT_GIF: 'image/gif', |
|
802 | 802 | } |
|
803 | 803 | |
|
804 | 804 | def __init__(self, data=None, url=None, filename=None, format=None, |
|
805 | 805 | embed=None, width=None, height=None, retina=False, |
|
806 | 806 | unconfined=False, metadata=None): |
|
807 | 807 | """Create a PNG/JPEG/GIF image object given raw data. |
|
808 | 808 | |
|
809 | 809 | When this object is returned by an input cell or passed to the |
|
810 | 810 | display function, it will result in the image being displayed |
|
811 | 811 | in the frontend. |
|
812 | 812 | |
|
813 | 813 | Parameters |
|
814 | 814 | ---------- |
|
815 | 815 | data : unicode, str or bytes |
|
816 | 816 | The raw image data or a URL or filename to load the data from. |
|
817 | 817 | This always results in embedded image data. |
|
818 | 818 | url : unicode |
|
819 | 819 | A URL to download the data from. If you specify `url=`, |
|
820 | 820 | the image data will not be embedded unless you also specify `embed=True`. |
|
821 | 821 | filename : unicode |
|
822 | 822 | Path to a local file to load the data from. |
|
823 | 823 | Images from a file are always embedded. |
|
824 | 824 | format : unicode |
|
825 | 825 | The format of the image data (png/jpeg/jpg/gif). If a filename or URL is given |
|
826 | 826 | for format will be inferred from the filename extension. |
|
827 | 827 | embed : bool |
|
828 | 828 | Should the image data be embedded using a data URI (True) or be |
|
829 | 829 | loaded using an <img> tag. Set this to True if you want the image |
|
830 | 830 | to be viewable later with no internet connection in the notebook. |
|
831 | 831 | |
|
832 | 832 | Default is `True`, unless the keyword argument `url` is set, then |
|
833 | 833 | default value is `False`. |
|
834 | 834 | |
|
835 | 835 | Note that QtConsole is not able to display images if `embed` is set to `False` |
|
836 | 836 | width : int |
|
837 | 837 | Width in pixels to which to constrain the image in html |
|
838 | 838 | height : int |
|
839 | 839 | Height in pixels to which to constrain the image in html |
|
840 | 840 | retina : bool |
|
841 | 841 | Automatically set the width and height to half of the measured |
|
842 | 842 | width and height. |
|
843 | 843 | This only works for embedded images because it reads the width/height |
|
844 | 844 | from image data. |
|
845 | 845 | For non-embedded images, you can just set the desired display width |
|
846 | 846 | and height directly. |
|
847 | 847 | unconfined: bool |
|
848 | 848 | Set unconfined=True to disable max-width confinement of the image. |
|
849 | 849 | metadata: dict |
|
850 | 850 | Specify extra metadata to attach to the image. |
|
851 | 851 | |
|
852 | 852 | Examples |
|
853 | 853 | -------- |
|
854 | 854 | # embedded image data, works in qtconsole and notebook |
|
855 | 855 | # when passed positionally, the first arg can be any of raw image data, |
|
856 | 856 | # a URL, or a filename from which to load image data. |
|
857 | 857 | # The result is always embedding image data for inline images. |
|
858 | 858 | Image('http://www.google.fr/images/srpr/logo3w.png') |
|
859 | 859 | Image('/path/to/image.jpg') |
|
860 | 860 | Image(b'RAW_PNG_DATA...') |
|
861 | 861 | |
|
862 | 862 | # Specifying Image(url=...) does not embed the image data, |
|
863 | 863 | # it only generates `<img>` tag with a link to the source. |
|
864 | 864 | # This will not work in the qtconsole or offline. |
|
865 | 865 | Image(url='http://www.google.fr/images/srpr/logo3w.png') |
|
866 | 866 | |
|
867 | 867 | """ |
|
868 | 868 | if isinstance(data, (Path, PurePath)): |
|
869 | 869 | data = str(data) |
|
870 | 870 | |
|
871 | 871 | if filename is not None: |
|
872 | 872 | ext = self._find_ext(filename) |
|
873 | 873 | elif url is not None: |
|
874 | 874 | ext = self._find_ext(url) |
|
875 | 875 | elif data is None: |
|
876 | 876 | raise ValueError("No image data found. Expecting filename, url, or data.") |
|
877 | 877 | elif isinstance(data, str) and ( |
|
878 | 878 | data.startswith('http') or _safe_exists(data) |
|
879 | 879 | ): |
|
880 | 880 | ext = self._find_ext(data) |
|
881 | 881 | else: |
|
882 | 882 | ext = None |
|
883 | 883 | |
|
884 | 884 | if format is None: |
|
885 | 885 | if ext is not None: |
|
886 | 886 | if ext == u'jpg' or ext == u'jpeg': |
|
887 | 887 | format = self._FMT_JPEG |
|
888 | 888 | elif ext == u'png': |
|
889 | 889 | format = self._FMT_PNG |
|
890 | 890 | elif ext == u'gif': |
|
891 | 891 | format = self._FMT_GIF |
|
892 | 892 | else: |
|
893 | 893 | format = ext.lower() |
|
894 | 894 | elif isinstance(data, bytes): |
|
895 | 895 | # infer image type from image data header, |
|
896 | 896 | # only if format has not been specified. |
|
897 | 897 | if data[:2] == _JPEG: |
|
898 | 898 | format = self._FMT_JPEG |
|
899 | 899 | |
|
900 | 900 | # failed to detect format, default png |
|
901 | 901 | if format is None: |
|
902 | 902 | format = self._FMT_PNG |
|
903 | 903 | |
|
904 | 904 | if format.lower() == 'jpg': |
|
905 | 905 | # jpg->jpeg |
|
906 | 906 | format = self._FMT_JPEG |
|
907 | 907 | |
|
908 | 908 | self.format = format.lower() |
|
909 | 909 | self.embed = embed if embed is not None else (url is None) |
|
910 | 910 | |
|
911 | 911 | if self.embed and self.format not in self._ACCEPTABLE_EMBEDDINGS: |
|
912 | 912 | raise ValueError("Cannot embed the '%s' image format" % (self.format)) |
|
913 | 913 | if self.embed: |
|
914 | 914 | self._mimetype = self._MIMETYPES.get(self.format) |
|
915 | 915 | |
|
916 | 916 | self.width = width |
|
917 | 917 | self.height = height |
|
918 | 918 | self.retina = retina |
|
919 | 919 | self.unconfined = unconfined |
|
920 | 920 | super(Image, self).__init__(data=data, url=url, filename=filename, |
|
921 | 921 | metadata=metadata) |
|
922 | 922 | |
|
923 | 923 | if self.width is None and self.metadata.get('width', {}): |
|
924 | 924 | self.width = metadata['width'] |
|
925 | 925 | |
|
926 | 926 | if self.height is None and self.metadata.get('height', {}): |
|
927 | 927 | self.height = metadata['height'] |
|
928 | 928 | |
|
929 | 929 | if retina: |
|
930 | 930 | self._retina_shape() |
|
931 | 931 | |
|
932 | 932 | |
|
933 | 933 | def _retina_shape(self): |
|
934 | 934 | """load pixel-doubled width and height from image data""" |
|
935 | 935 | if not self.embed: |
|
936 | 936 | return |
|
937 | 937 | if self.format == self._FMT_PNG: |
|
938 | 938 | w, h = _pngxy(self.data) |
|
939 | 939 | elif self.format == self._FMT_JPEG: |
|
940 | 940 | w, h = _jpegxy(self.data) |
|
941 | 941 | elif self.format == self._FMT_GIF: |
|
942 | 942 | w, h = _gifxy(self.data) |
|
943 | 943 | else: |
|
944 | 944 | # retina only supports png |
|
945 | 945 | return |
|
946 | 946 | self.width = w // 2 |
|
947 | 947 | self.height = h // 2 |
|
948 | 948 | |
|
949 | 949 | def reload(self): |
|
950 | 950 | """Reload the raw data from file or URL.""" |
|
951 | 951 | if self.embed: |
|
952 | 952 | super(Image,self).reload() |
|
953 | 953 | if self.retina: |
|
954 | 954 | self._retina_shape() |
|
955 | 955 | |
|
956 | 956 | def _repr_html_(self): |
|
957 | 957 | if not self.embed: |
|
958 | 958 | width = height = klass = '' |
|
959 | 959 | if self.width: |
|
960 | 960 | width = ' width="%d"' % self.width |
|
961 | 961 | if self.height: |
|
962 | 962 | height = ' height="%d"' % self.height |
|
963 | 963 | if self.unconfined: |
|
964 | 964 | klass = ' class="unconfined"' |
|
965 | 965 | return u'<img src="{url}"{width}{height}{klass}/>'.format( |
|
966 | 966 | url=self.url, |
|
967 | 967 | width=width, |
|
968 | 968 | height=height, |
|
969 | 969 | klass=klass, |
|
970 | 970 | ) |
|
971 | 971 | |
|
972 | 972 | def _repr_mimebundle_(self, include=None, exclude=None): |
|
973 | 973 | """Return the image as a mimebundle |
|
974 | 974 | |
|
975 | 975 | Any new mimetype support should be implemented here. |
|
976 | 976 | """ |
|
977 | 977 | if self.embed: |
|
978 | 978 | mimetype = self._mimetype |
|
979 | 979 | data, metadata = self._data_and_metadata(always_both=True) |
|
980 | 980 | if metadata: |
|
981 | 981 | metadata = {mimetype: metadata} |
|
982 | 982 | return {mimetype: data}, metadata |
|
983 | 983 | else: |
|
984 | 984 | return {'text/html': self._repr_html_()} |
|
985 | 985 | |
|
986 | 986 | def _data_and_metadata(self, always_both=False): |
|
987 | 987 | """shortcut for returning metadata with shape information, if defined""" |
|
988 | 988 | try: |
|
989 | 989 | b64_data = b2a_base64(self.data).decode('ascii') |
|
990 | 990 | except TypeError as e: |
|
991 | 991 | raise FileNotFoundError( |
|
992 | 992 | "No such file or directory: '%s'" % (self.data)) from e |
|
993 | 993 | md = {} |
|
994 | 994 | if self.metadata: |
|
995 | 995 | md.update(self.metadata) |
|
996 | 996 | if self.width: |
|
997 | 997 | md['width'] = self.width |
|
998 | 998 | if self.height: |
|
999 | 999 | md['height'] = self.height |
|
1000 | 1000 | if self.unconfined: |
|
1001 | 1001 | md['unconfined'] = self.unconfined |
|
1002 | 1002 | if md or always_both: |
|
1003 | 1003 | return b64_data, md |
|
1004 | 1004 | else: |
|
1005 | 1005 | return b64_data |
|
1006 | 1006 | |
|
1007 | 1007 | def _repr_png_(self): |
|
1008 | 1008 | if self.embed and self.format == self._FMT_PNG: |
|
1009 | 1009 | return self._data_and_metadata() |
|
1010 | 1010 | |
|
1011 | 1011 | def _repr_jpeg_(self): |
|
1012 | 1012 | if self.embed and self.format == self._FMT_JPEG: |
|
1013 | 1013 | return self._data_and_metadata() |
|
1014 | 1014 | |
|
1015 | 1015 | def _find_ext(self, s): |
|
1016 | 1016 | base, ext = splitext(s) |
|
1017 | 1017 | |
|
1018 | 1018 | if not ext: |
|
1019 | 1019 | return base |
|
1020 | 1020 | |
|
1021 | 1021 | # `splitext` includes leading period, so we skip it |
|
1022 | 1022 | return ext[1:].lower() |
|
1023 | 1023 | |
|
1024 | 1024 | |
|
1025 | 1025 | class Video(DisplayObject): |
|
1026 | 1026 | |
|
1027 | 1027 | def __init__(self, data=None, url=None, filename=None, embed=False, |
|
1028 | 1028 | mimetype=None, width=None, height=None, html_attributes="controls"): |
|
1029 | 1029 | """Create a video object given raw data or an URL. |
|
1030 | 1030 | |
|
1031 | 1031 | When this object is returned by an input cell or passed to the |
|
1032 | 1032 | display function, it will result in the video being displayed |
|
1033 | 1033 | in the frontend. |
|
1034 | 1034 | |
|
1035 | 1035 | Parameters |
|
1036 | 1036 | ---------- |
|
1037 | 1037 | data : unicode, str or bytes |
|
1038 | 1038 | The raw video data or a URL or filename to load the data from. |
|
1039 | 1039 | Raw data will require passing `embed=True`. |
|
1040 | 1040 | url : unicode |
|
1041 | 1041 | A URL for the video. If you specify `url=`, |
|
1042 | 1042 | the image data will not be embedded. |
|
1043 | 1043 | filename : unicode |
|
1044 | 1044 | Path to a local file containing the video. |
|
1045 | 1045 | Will be interpreted as a local URL unless `embed=True`. |
|
1046 | 1046 | embed : bool |
|
1047 | 1047 | Should the video be embedded using a data URI (True) or be |
|
1048 | 1048 | loaded using a <video> tag (False). |
|
1049 | 1049 | |
|
1050 | 1050 | Since videos are large, embedding them should be avoided, if possible. |
|
1051 | 1051 | You must confirm embedding as your intention by passing `embed=True`. |
|
1052 | 1052 | |
|
1053 | 1053 | Local files can be displayed with URLs without embedding the content, via:: |
|
1054 | 1054 | |
|
1055 | 1055 | Video('./video.mp4') |
|
1056 | 1056 | |
|
1057 | 1057 | mimetype: unicode |
|
1058 | 1058 | Specify the mimetype for embedded videos. |
|
1059 | 1059 | Default will be guessed from file extension, if available. |
|
1060 | 1060 | width : int |
|
1061 | 1061 | Width in pixels to which to constrain the video in HTML. |
|
1062 | 1062 | If not supplied, defaults to the width of the video. |
|
1063 | 1063 | height : int |
|
1064 | 1064 | Height in pixels to which to constrain the video in html. |
|
1065 | 1065 | If not supplied, defaults to the height of the video. |
|
1066 | 1066 | html_attributes : str |
|
1067 | 1067 | Attributes for the HTML `<video>` block. |
|
1068 | 1068 | Default: `"controls"` to get video controls. |
|
1069 | 1069 | Other examples: `"controls muted"` for muted video with controls, |
|
1070 | 1070 | `"loop autoplay"` for looping autoplaying video without controls. |
|
1071 | 1071 | |
|
1072 | 1072 | Examples |
|
1073 | 1073 | -------- |
|
1074 | 1074 | |
|
1075 | 1075 | :: |
|
1076 | 1076 | |
|
1077 | 1077 | Video('https://archive.org/download/Sita_Sings_the_Blues/Sita_Sings_the_Blues_small.mp4') |
|
1078 | 1078 | Video('path/to/video.mp4') |
|
1079 | 1079 | Video('path/to/video.mp4', embed=True) |
|
1080 | 1080 | Video('path/to/video.mp4', embed=True, html_attributes="controls muted autoplay") |
|
1081 | 1081 | Video(b'raw-videodata', embed=True) |
|
1082 | 1082 | """ |
|
1083 | 1083 | if isinstance(data, (Path, PurePath)): |
|
1084 | 1084 | data = str(data) |
|
1085 | 1085 | |
|
1086 | 1086 | if url is None and isinstance(data, str) and data.startswith(('http:', 'https:')): |
|
1087 | 1087 | url = data |
|
1088 | 1088 | data = None |
|
1089 | elif os.path.exists(data): | |
|
1089 | elif data is not None and os.path.exists(data): | |
|
1090 | 1090 | filename = data |
|
1091 | 1091 | data = None |
|
1092 | 1092 | |
|
1093 | 1093 | if data and not embed: |
|
1094 | 1094 | msg = ''.join([ |
|
1095 | 1095 | "To embed videos, you must pass embed=True ", |
|
1096 | 1096 | "(this may make your notebook files huge)\n", |
|
1097 | 1097 | "Consider passing Video(url='...')", |
|
1098 | 1098 | ]) |
|
1099 | 1099 | raise ValueError(msg) |
|
1100 | 1100 | |
|
1101 | 1101 | self.mimetype = mimetype |
|
1102 | 1102 | self.embed = embed |
|
1103 | 1103 | self.width = width |
|
1104 | 1104 | self.height = height |
|
1105 | 1105 | self.html_attributes = html_attributes |
|
1106 | 1106 | super(Video, self).__init__(data=data, url=url, filename=filename) |
|
1107 | 1107 | |
|
1108 | 1108 | def _repr_html_(self): |
|
1109 | 1109 | width = height = '' |
|
1110 | 1110 | if self.width: |
|
1111 | 1111 | width = ' width="%d"' % self.width |
|
1112 | 1112 | if self.height: |
|
1113 | 1113 | height = ' height="%d"' % self.height |
|
1114 | 1114 | |
|
1115 | 1115 | # External URLs and potentially local files are not embedded into the |
|
1116 | 1116 | # notebook output. |
|
1117 | 1117 | if not self.embed: |
|
1118 | 1118 | url = self.url if self.url is not None else self.filename |
|
1119 | 1119 | output = """<video src="{0}" {1} {2} {3}> |
|
1120 | 1120 | Your browser does not support the <code>video</code> element. |
|
1121 | 1121 | </video>""".format(url, self.html_attributes, width, height) |
|
1122 | 1122 | return output |
|
1123 | 1123 | |
|
1124 | 1124 | # Embedded videos are base64-encoded. |
|
1125 | 1125 | mimetype = self.mimetype |
|
1126 | 1126 | if self.filename is not None: |
|
1127 | 1127 | if not mimetype: |
|
1128 | 1128 | mimetype, _ = mimetypes.guess_type(self.filename) |
|
1129 | 1129 | |
|
1130 | 1130 | with open(self.filename, 'rb') as f: |
|
1131 | 1131 | video = f.read() |
|
1132 | 1132 | else: |
|
1133 | 1133 | video = self.data |
|
1134 | 1134 | if isinstance(video, str): |
|
1135 | 1135 | # unicode input is already b64-encoded |
|
1136 | 1136 | b64_video = video |
|
1137 | 1137 | else: |
|
1138 | 1138 | b64_video = b2a_base64(video).decode('ascii').rstrip() |
|
1139 | 1139 | |
|
1140 | 1140 | output = """<video {0} {1} {2}> |
|
1141 | 1141 | <source src="data:{3};base64,{4}" type="{3}"> |
|
1142 | 1142 | Your browser does not support the video tag. |
|
1143 | 1143 | </video>""".format(self.html_attributes, width, height, mimetype, b64_video) |
|
1144 | 1144 | return output |
|
1145 | 1145 | |
|
1146 | 1146 | def reload(self): |
|
1147 | 1147 | # TODO |
|
1148 | 1148 | pass |
|
1149 | 1149 | |
|
1150 | 1150 | |
|
1151 | 1151 | @skip_doctest |
|
1152 | 1152 | def set_matplotlib_formats(*formats, **kwargs): |
|
1153 | 1153 | """Select figure formats for the inline backend. Optionally pass quality for JPEG. |
|
1154 | 1154 | |
|
1155 | 1155 | For example, this enables PNG and JPEG output with a JPEG quality of 90%:: |
|
1156 | 1156 | |
|
1157 | 1157 | In [1]: set_matplotlib_formats('png', 'jpeg', quality=90) |
|
1158 | 1158 | |
|
1159 | 1159 | To set this in your config files use the following:: |
|
1160 | 1160 | |
|
1161 | 1161 | c.InlineBackend.figure_formats = {'png', 'jpeg'} |
|
1162 | 1162 | c.InlineBackend.print_figure_kwargs.update({'quality' : 90}) |
|
1163 | 1163 | |
|
1164 | 1164 | Parameters |
|
1165 | 1165 | ---------- |
|
1166 | 1166 | *formats : strs |
|
1167 | 1167 | One or more figure formats to enable: 'png', 'retina', 'jpeg', 'svg', 'pdf'. |
|
1168 | 1168 | **kwargs : |
|
1169 | 1169 | Keyword args will be relayed to ``figure.canvas.print_figure``. |
|
1170 | 1170 | """ |
|
1171 | 1171 | from IPython.core.interactiveshell import InteractiveShell |
|
1172 | 1172 | from IPython.core.pylabtools import select_figure_formats |
|
1173 | 1173 | # build kwargs, starting with InlineBackend config |
|
1174 | 1174 | kw = {} |
|
1175 | 1175 | from ipykernel.pylab.config import InlineBackend |
|
1176 | 1176 | cfg = InlineBackend.instance() |
|
1177 | 1177 | kw.update(cfg.print_figure_kwargs) |
|
1178 | 1178 | kw.update(**kwargs) |
|
1179 | 1179 | shell = InteractiveShell.instance() |
|
1180 | 1180 | select_figure_formats(shell, formats, **kw) |
|
1181 | 1181 | |
|
1182 | 1182 | @skip_doctest |
|
1183 | 1183 | def set_matplotlib_close(close=True): |
|
1184 | 1184 | """Set whether the inline backend closes all figures automatically or not. |
|
1185 | 1185 | |
|
1186 | 1186 | By default, the inline backend used in the IPython Notebook will close all |
|
1187 | 1187 | matplotlib figures automatically after each cell is run. This means that |
|
1188 | 1188 | plots in different cells won't interfere. Sometimes, you may want to make |
|
1189 | 1189 | a plot in one cell and then refine it in later cells. This can be accomplished |
|
1190 | 1190 | by:: |
|
1191 | 1191 | |
|
1192 | 1192 | In [1]: set_matplotlib_close(False) |
|
1193 | 1193 | |
|
1194 | 1194 | To set this in your config files use the following:: |
|
1195 | 1195 | |
|
1196 | 1196 | c.InlineBackend.close_figures = False |
|
1197 | 1197 | |
|
1198 | 1198 | Parameters |
|
1199 | 1199 | ---------- |
|
1200 | 1200 | close : bool |
|
1201 | 1201 | Should all matplotlib figures be automatically closed after each cell is |
|
1202 | 1202 | run? |
|
1203 | 1203 | """ |
|
1204 | 1204 | from ipykernel.pylab.config import InlineBackend |
|
1205 | 1205 | cfg = InlineBackend.instance() |
|
1206 | 1206 | cfg.close_figures = close |
@@ -1,3792 +1,3794 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Main IPython class.""" |
|
3 | 3 | |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
6 | 6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
7 | 7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
8 | 8 | # |
|
9 | 9 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | 10 | # the file COPYING, distributed as part of this software. |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | |
|
13 | 13 | |
|
14 | 14 | import abc |
|
15 | 15 | import ast |
|
16 | 16 | import atexit |
|
17 | 17 | import builtins as builtin_mod |
|
18 | 18 | import functools |
|
19 | 19 | import inspect |
|
20 | 20 | import os |
|
21 | 21 | import re |
|
22 | 22 | import runpy |
|
23 | 23 | import sys |
|
24 | 24 | import tempfile |
|
25 | 25 | import traceback |
|
26 | 26 | import types |
|
27 | 27 | import subprocess |
|
28 | 28 | import warnings |
|
29 | 29 | from io import open as io_open |
|
30 | 30 | |
|
31 | 31 | from pathlib import Path |
|
32 | 32 | from pickleshare import PickleShareDB |
|
33 | 33 | |
|
34 | 34 | from traitlets.config.configurable import SingletonConfigurable |
|
35 | 35 | from traitlets.utils.importstring import import_item |
|
36 | 36 | from IPython.core import oinspect |
|
37 | 37 | from IPython.core import magic |
|
38 | 38 | from IPython.core import page |
|
39 | 39 | from IPython.core import prefilter |
|
40 | 40 | from IPython.core import ultratb |
|
41 | 41 | from IPython.core.alias import Alias, AliasManager |
|
42 | 42 | from IPython.core.autocall import ExitAutocall |
|
43 | 43 | from IPython.core.builtin_trap import BuiltinTrap |
|
44 | 44 | from IPython.core.events import EventManager, available_events |
|
45 | 45 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython |
|
46 | 46 | from IPython.core.debugger import Pdb |
|
47 | 47 | from IPython.core.display_trap import DisplayTrap |
|
48 | 48 | from IPython.core.displayhook import DisplayHook |
|
49 | 49 | from IPython.core.displaypub import DisplayPublisher |
|
50 | 50 | from IPython.core.error import InputRejected, UsageError |
|
51 | 51 | from IPython.core.extensions import ExtensionManager |
|
52 | 52 | from IPython.core.formatters import DisplayFormatter |
|
53 | 53 | from IPython.core.history import HistoryManager |
|
54 | 54 | from IPython.core.inputtransformer2 import ESC_MAGIC, ESC_MAGIC2 |
|
55 | 55 | from IPython.core.logger import Logger |
|
56 | 56 | from IPython.core.macro import Macro |
|
57 | 57 | from IPython.core.payload import PayloadManager |
|
58 | 58 | from IPython.core.prefilter import PrefilterManager |
|
59 | 59 | from IPython.core.profiledir import ProfileDir |
|
60 | 60 | from IPython.core.usage import default_banner |
|
61 | 61 | from IPython.display import display |
|
62 | 62 | from IPython.testing.skipdoctest import skip_doctest |
|
63 | 63 | from IPython.utils import PyColorize |
|
64 | 64 | from IPython.utils import io |
|
65 | 65 | from IPython.utils import py3compat |
|
66 | 66 | from IPython.utils import openpy |
|
67 | 67 | from IPython.utils.decorators import undoc |
|
68 | 68 | from IPython.utils.io import ask_yes_no |
|
69 | 69 | from IPython.utils.ipstruct import Struct |
|
70 | 70 | from IPython.paths import get_ipython_dir |
|
71 | 71 | from IPython.utils.path import get_home_dir, get_py_filename, ensure_dir_exists |
|
72 | 72 | from IPython.utils.process import system, getoutput |
|
73 | 73 | from IPython.utils.strdispatch import StrDispatch |
|
74 | 74 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
75 | 75 | from IPython.utils.text import format_screen, LSString, SList, DollarFormatter |
|
76 | 76 | from IPython.utils.tempdir import TemporaryDirectory |
|
77 | 77 | from traitlets import ( |
|
78 | 78 | Integer, Bool, CaselessStrEnum, Enum, List, Dict, Unicode, Instance, Type, |
|
79 | 79 | observe, default, validate, Any |
|
80 | 80 | ) |
|
81 | 81 | from warnings import warn |
|
82 | 82 | from logging import error |
|
83 | 83 | import IPython.core.hooks |
|
84 | 84 | |
|
85 | 85 | from typing import List as ListType, Tuple, Optional |
|
86 | 86 | from ast import AST |
|
87 | 87 | |
|
88 | 88 | # NoOpContext is deprecated, but ipykernel imports it from here. |
|
89 | 89 | # See https://github.com/ipython/ipykernel/issues/157 |
|
90 | 90 | # (2016, let's try to remove than in IPython 8.0) |
|
91 | 91 | from IPython.utils.contexts import NoOpContext |
|
92 | 92 | |
|
93 | 93 | try: |
|
94 | 94 | import docrepr.sphinxify as sphx |
|
95 | 95 | |
|
96 | 96 | def sphinxify(doc): |
|
97 | 97 | with TemporaryDirectory() as dirname: |
|
98 | 98 | return { |
|
99 | 99 | 'text/html': sphx.sphinxify(doc, dirname), |
|
100 | 100 | 'text/plain': doc |
|
101 | 101 | } |
|
102 | 102 | except ImportError: |
|
103 | 103 | sphinxify = None |
|
104 | 104 | |
|
105 | 105 | |
|
106 | 106 | class ProvisionalWarning(DeprecationWarning): |
|
107 | 107 | """ |
|
108 | 108 | Warning class for unstable features |
|
109 | 109 | """ |
|
110 | 110 | pass |
|
111 | 111 | |
|
112 | 112 | if sys.version_info > (3,8): |
|
113 | 113 | from ast import Module |
|
114 | 114 | else : |
|
115 | 115 | # mock the new API, ignore second argument |
|
116 | 116 | # see https://github.com/ipython/ipython/issues/11590 |
|
117 | 117 | from ast import Module as OriginalModule |
|
118 | 118 | Module = lambda nodelist, type_ignores: OriginalModule(nodelist) |
|
119 | 119 | |
|
120 | 120 | if sys.version_info > (3,6): |
|
121 | 121 | _assign_nodes = (ast.AugAssign, ast.AnnAssign, ast.Assign) |
|
122 | 122 | _single_targets_nodes = (ast.AugAssign, ast.AnnAssign) |
|
123 | 123 | else: |
|
124 | 124 | _assign_nodes = (ast.AugAssign, ast.Assign ) |
|
125 | 125 | _single_targets_nodes = (ast.AugAssign, ) |
|
126 | 126 | |
|
127 | 127 | #----------------------------------------------------------------------------- |
|
128 | 128 | # Await Helpers |
|
129 | 129 | #----------------------------------------------------------------------------- |
|
130 | 130 | |
|
131 | 131 | def removed_co_newlocals(function:types.FunctionType) -> types.FunctionType: |
|
132 | 132 | """Return a function that do not create a new local scope. |
|
133 | 133 | |
|
134 | 134 | Given a function, create a clone of this function where the co_newlocal flag |
|
135 | 135 | has been removed, making this function code actually run in the sourounding |
|
136 | 136 | scope. |
|
137 | 137 | |
|
138 | 138 | We need this in order to run asynchronous code in user level namespace. |
|
139 | 139 | """ |
|
140 | 140 | from types import CodeType, FunctionType |
|
141 | 141 | CO_NEWLOCALS = 0x0002 |
|
142 | 142 | code = function.__code__ |
|
143 | 143 | new_co_flags = code.co_flags & ~CO_NEWLOCALS |
|
144 | 144 | if sys.version_info > (3, 8, 0, 'alpha', 3): |
|
145 | 145 | new_code = code.replace(co_flags=new_co_flags) |
|
146 | 146 | else: |
|
147 | 147 | new_code = CodeType( |
|
148 | 148 | code.co_argcount, |
|
149 | 149 | code.co_kwonlyargcount, |
|
150 | 150 | code.co_nlocals, |
|
151 | 151 | code.co_stacksize, |
|
152 | 152 | new_co_flags, |
|
153 | 153 | code.co_code, |
|
154 | 154 | code.co_consts, |
|
155 | 155 | code.co_names, |
|
156 | 156 | code.co_varnames, |
|
157 | 157 | code.co_filename, |
|
158 | 158 | code.co_name, |
|
159 | 159 | code.co_firstlineno, |
|
160 | 160 | code.co_lnotab, |
|
161 | 161 | code.co_freevars, |
|
162 | 162 | code.co_cellvars |
|
163 | 163 | ) |
|
164 | 164 | return FunctionType(new_code, globals(), function.__name__, function.__defaults__) |
|
165 | 165 | |
|
166 | 166 | |
|
167 | 167 | # we still need to run things using the asyncio eventloop, but there is no |
|
168 | 168 | # async integration |
|
169 | 169 | from .async_helpers import (_asyncio_runner, _asyncify, _pseudo_sync_runner) |
|
170 | 170 | from .async_helpers import _curio_runner, _trio_runner, _should_be_async |
|
171 | 171 | |
|
172 | 172 | |
|
173 | 173 | def _ast_asyncify(cell:str, wrapper_name:str) -> ast.Module: |
|
174 | 174 | """ |
|
175 | 175 | Parse a cell with top-level await and modify the AST to be able to run it later. |
|
176 | 176 | |
|
177 | 177 | Parameters |
|
178 | 178 | ---------- |
|
179 | 179 | cell: str |
|
180 | 180 | The code cell to asyncronify |
|
181 | 181 | wrapper_name: str |
|
182 | 182 | The name of the function to be used to wrap the passed `cell`. It is |
|
183 | 183 | advised to **not** use a python identifier in order to not pollute the |
|
184 | 184 | global namespace in which the function will be ran. |
|
185 | 185 | |
|
186 | 186 | Returns |
|
187 | 187 | ------- |
|
188 | 188 | ModuleType: |
|
189 | 189 | A module object AST containing **one** function named `wrapper_name`. |
|
190 | 190 | |
|
191 | 191 | The given code is wrapped in a async-def function, parsed into an AST, and |
|
192 | 192 | the resulting function definition AST is modified to return the last |
|
193 | 193 | expression. |
|
194 | 194 | |
|
195 | 195 | The last expression or await node is moved into a return statement at the |
|
196 | 196 | end of the function, and removed from its original location. If the last |
|
197 | 197 | node is not Expr or Await nothing is done. |
|
198 | 198 | |
|
199 | 199 | The function `__code__` will need to be later modified (by |
|
200 | 200 | ``removed_co_newlocals``) in a subsequent step to not create new `locals()` |
|
201 | 201 | meaning that the local and global scope are the same, ie as if the body of |
|
202 | 202 | the function was at module level. |
|
203 | 203 | |
|
204 | 204 | Lastly a call to `locals()` is made just before the last expression of the |
|
205 | 205 | function, or just after the last assignment or statement to make sure the |
|
206 | 206 | global dict is updated as python function work with a local fast cache which |
|
207 | 207 | is updated only on `local()` calls. |
|
208 | 208 | """ |
|
209 | 209 | |
|
210 | 210 | from ast import Expr, Await, Return |
|
211 | 211 | if sys.version_info >= (3,8): |
|
212 | 212 | return ast.parse(cell) |
|
213 | 213 | tree = ast.parse(_asyncify(cell)) |
|
214 | 214 | |
|
215 | 215 | function_def = tree.body[0] |
|
216 | 216 | function_def.name = wrapper_name |
|
217 | 217 | try_block = function_def.body[0] |
|
218 | 218 | lastexpr = try_block.body[-1] |
|
219 | 219 | if isinstance(lastexpr, (Expr, Await)): |
|
220 | 220 | try_block.body[-1] = Return(lastexpr.value) |
|
221 | 221 | ast.fix_missing_locations(tree) |
|
222 | 222 | return tree |
|
223 | 223 | #----------------------------------------------------------------------------- |
|
224 | 224 | # Globals |
|
225 | 225 | #----------------------------------------------------------------------------- |
|
226 | 226 | |
|
227 | 227 | # compiled regexps for autoindent management |
|
228 | 228 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
229 | 229 | |
|
230 | 230 | #----------------------------------------------------------------------------- |
|
231 | 231 | # Utilities |
|
232 | 232 | #----------------------------------------------------------------------------- |
|
233 | 233 | |
|
234 | 234 | @undoc |
|
235 | 235 | def softspace(file, newvalue): |
|
236 | 236 | """Copied from code.py, to remove the dependency""" |
|
237 | 237 | |
|
238 | 238 | oldvalue = 0 |
|
239 | 239 | try: |
|
240 | 240 | oldvalue = file.softspace |
|
241 | 241 | except AttributeError: |
|
242 | 242 | pass |
|
243 | 243 | try: |
|
244 | 244 | file.softspace = newvalue |
|
245 | 245 | except (AttributeError, TypeError): |
|
246 | 246 | # "attribute-less object" or "read-only attributes" |
|
247 | 247 | pass |
|
248 | 248 | return oldvalue |
|
249 | 249 | |
|
250 | 250 | @undoc |
|
251 | 251 | def no_op(*a, **kw): |
|
252 | 252 | pass |
|
253 | 253 | |
|
254 | 254 | |
|
255 | 255 | class SpaceInInput(Exception): pass |
|
256 | 256 | |
|
257 | 257 | |
|
258 | 258 | def get_default_colors(): |
|
259 | 259 | "DEPRECATED" |
|
260 | 260 | warn('get_default_color is deprecated since IPython 5.0, and returns `Neutral` on all platforms.', |
|
261 | 261 | DeprecationWarning, stacklevel=2) |
|
262 | 262 | return 'Neutral' |
|
263 | 263 | |
|
264 | 264 | |
|
265 | 265 | class SeparateUnicode(Unicode): |
|
266 | 266 | r"""A Unicode subclass to validate separate_in, separate_out, etc. |
|
267 | 267 | |
|
268 | 268 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. |
|
269 | 269 | """ |
|
270 | 270 | |
|
271 | 271 | def validate(self, obj, value): |
|
272 | 272 | if value == '0': value = '' |
|
273 | 273 | value = value.replace('\\n','\n') |
|
274 | 274 | return super(SeparateUnicode, self).validate(obj, value) |
|
275 | 275 | |
|
276 | 276 | |
|
277 | 277 | @undoc |
|
278 | 278 | class DummyMod(object): |
|
279 | 279 | """A dummy module used for IPython's interactive module when |
|
280 | 280 | a namespace must be assigned to the module's __dict__.""" |
|
281 | 281 | __spec__ = None |
|
282 | 282 | |
|
283 | 283 | |
|
284 | 284 | class ExecutionInfo(object): |
|
285 | 285 | """The arguments used for a call to :meth:`InteractiveShell.run_cell` |
|
286 | 286 | |
|
287 | 287 | Stores information about what is going to happen. |
|
288 | 288 | """ |
|
289 | 289 | raw_cell = None |
|
290 | 290 | store_history = False |
|
291 | 291 | silent = False |
|
292 | 292 | shell_futures = True |
|
293 | 293 | |
|
294 | 294 | def __init__(self, raw_cell, store_history, silent, shell_futures): |
|
295 | 295 | self.raw_cell = raw_cell |
|
296 | 296 | self.store_history = store_history |
|
297 | 297 | self.silent = silent |
|
298 | 298 | self.shell_futures = shell_futures |
|
299 | 299 | |
|
300 | 300 | def __repr__(self): |
|
301 | 301 | name = self.__class__.__qualname__ |
|
302 | 302 | raw_cell = ((self.raw_cell[:50] + '..') |
|
303 | 303 | if len(self.raw_cell) > 50 else self.raw_cell) |
|
304 | 304 | return '<%s object at %x, raw_cell="%s" store_history=%s silent=%s shell_futures=%s>' %\ |
|
305 | 305 | (name, id(self), raw_cell, self.store_history, self.silent, self.shell_futures) |
|
306 | 306 | |
|
307 | 307 | |
|
308 | 308 | class ExecutionResult(object): |
|
309 | 309 | """The result of a call to :meth:`InteractiveShell.run_cell` |
|
310 | 310 | |
|
311 | 311 | Stores information about what took place. |
|
312 | 312 | """ |
|
313 | 313 | execution_count = None |
|
314 | 314 | error_before_exec = None |
|
315 | 315 | error_in_exec = None |
|
316 | 316 | info = None |
|
317 | 317 | result = None |
|
318 | 318 | |
|
319 | 319 | def __init__(self, info): |
|
320 | 320 | self.info = info |
|
321 | 321 | |
|
322 | 322 | @property |
|
323 | 323 | def success(self): |
|
324 | 324 | return (self.error_before_exec is None) and (self.error_in_exec is None) |
|
325 | 325 | |
|
326 | 326 | def raise_error(self): |
|
327 | 327 | """Reraises error if `success` is `False`, otherwise does nothing""" |
|
328 | 328 | if self.error_before_exec is not None: |
|
329 | 329 | raise self.error_before_exec |
|
330 | 330 | if self.error_in_exec is not None: |
|
331 | 331 | raise self.error_in_exec |
|
332 | 332 | |
|
333 | 333 | def __repr__(self): |
|
334 | 334 | name = self.__class__.__qualname__ |
|
335 | 335 | return '<%s object at %x, execution_count=%s error_before_exec=%s error_in_exec=%s info=%s result=%s>' %\ |
|
336 | 336 | (name, id(self), self.execution_count, self.error_before_exec, self.error_in_exec, repr(self.info), repr(self.result)) |
|
337 | 337 | |
|
338 | 338 | |
|
339 | 339 | class InteractiveShell(SingletonConfigurable): |
|
340 | 340 | """An enhanced, interactive shell for Python.""" |
|
341 | 341 | |
|
342 | 342 | _instance = None |
|
343 | 343 | |
|
344 | 344 | ast_transformers = List([], help= |
|
345 | 345 | """ |
|
346 | 346 | A list of ast.NodeTransformer subclass instances, which will be applied |
|
347 | 347 | to user input before code is run. |
|
348 | 348 | """ |
|
349 | 349 | ).tag(config=True) |
|
350 | 350 | |
|
351 | 351 | autocall = Enum((0,1,2), default_value=0, help= |
|
352 | 352 | """ |
|
353 | 353 | Make IPython automatically call any callable object even if you didn't |
|
354 | 354 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
355 | 355 | automatically. The value can be '0' to disable the feature, '1' for |
|
356 | 356 | 'smart' autocall, where it is not applied if there are no more |
|
357 | 357 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
358 | 358 | objects are automatically called (even if no arguments are present). |
|
359 | 359 | """ |
|
360 | 360 | ).tag(config=True) |
|
361 | 361 | |
|
362 | 362 | autoindent = Bool(True, help= |
|
363 | 363 | """ |
|
364 | 364 | Autoindent IPython code entered interactively. |
|
365 | 365 | """ |
|
366 | 366 | ).tag(config=True) |
|
367 | 367 | |
|
368 | 368 | autoawait = Bool(True, help= |
|
369 | 369 | """ |
|
370 | 370 | Automatically run await statement in the top level repl. |
|
371 | 371 | """ |
|
372 | 372 | ).tag(config=True) |
|
373 | 373 | |
|
374 | 374 | loop_runner_map ={ |
|
375 | 375 | 'asyncio':(_asyncio_runner, True), |
|
376 | 376 | 'curio':(_curio_runner, True), |
|
377 | 377 | 'trio':(_trio_runner, True), |
|
378 | 378 | 'sync': (_pseudo_sync_runner, False) |
|
379 | 379 | } |
|
380 | 380 | |
|
381 | 381 | loop_runner = Any(default_value="IPython.core.interactiveshell._asyncio_runner", |
|
382 | 382 | allow_none=True, |
|
383 | 383 | help="""Select the loop runner that will be used to execute top-level asynchronous code""" |
|
384 | 384 | ).tag(config=True) |
|
385 | 385 | |
|
386 | 386 | @default('loop_runner') |
|
387 | 387 | def _default_loop_runner(self): |
|
388 | 388 | return import_item("IPython.core.interactiveshell._asyncio_runner") |
|
389 | 389 | |
|
390 | 390 | @validate('loop_runner') |
|
391 | 391 | def _import_runner(self, proposal): |
|
392 | 392 | if isinstance(proposal.value, str): |
|
393 | 393 | if proposal.value in self.loop_runner_map: |
|
394 | 394 | runner, autoawait = self.loop_runner_map[proposal.value] |
|
395 | 395 | self.autoawait = autoawait |
|
396 | 396 | return runner |
|
397 | 397 | runner = import_item(proposal.value) |
|
398 | 398 | if not callable(runner): |
|
399 | 399 | raise ValueError('loop_runner must be callable') |
|
400 | 400 | return runner |
|
401 | 401 | if not callable(proposal.value): |
|
402 | 402 | raise ValueError('loop_runner must be callable') |
|
403 | 403 | return proposal.value |
|
404 | 404 | |
|
405 | 405 | automagic = Bool(True, help= |
|
406 | 406 | """ |
|
407 | 407 | Enable magic commands to be called without the leading %. |
|
408 | 408 | """ |
|
409 | 409 | ).tag(config=True) |
|
410 | 410 | |
|
411 | 411 | banner1 = Unicode(default_banner, |
|
412 | 412 | help="""The part of the banner to be printed before the profile""" |
|
413 | 413 | ).tag(config=True) |
|
414 | 414 | banner2 = Unicode('', |
|
415 | 415 | help="""The part of the banner to be printed after the profile""" |
|
416 | 416 | ).tag(config=True) |
|
417 | 417 | |
|
418 | 418 | cache_size = Integer(1000, help= |
|
419 | 419 | """ |
|
420 | 420 | Set the size of the output cache. The default is 1000, you can |
|
421 | 421 | change it permanently in your config file. Setting it to 0 completely |
|
422 | 422 | disables the caching system, and the minimum value accepted is 3 (if |
|
423 | 423 | you provide a value less than 3, it is reset to 0 and a warning is |
|
424 | 424 | issued). This limit is defined because otherwise you'll spend more |
|
425 | 425 | time re-flushing a too small cache than working |
|
426 | 426 | """ |
|
427 | 427 | ).tag(config=True) |
|
428 | 428 | color_info = Bool(True, help= |
|
429 | 429 | """ |
|
430 | 430 | Use colors for displaying information about objects. Because this |
|
431 | 431 | information is passed through a pager (like 'less'), and some pagers |
|
432 | 432 | get confused with color codes, this capability can be turned off. |
|
433 | 433 | """ |
|
434 | 434 | ).tag(config=True) |
|
435 | 435 | colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'), |
|
436 | 436 | default_value='Neutral', |
|
437 | 437 | help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)." |
|
438 | 438 | ).tag(config=True) |
|
439 | 439 | debug = Bool(False).tag(config=True) |
|
440 | 440 | disable_failing_post_execute = Bool(False, |
|
441 | 441 | help="Don't call post-execute functions that have failed in the past." |
|
442 | 442 | ).tag(config=True) |
|
443 | 443 | display_formatter = Instance(DisplayFormatter, allow_none=True) |
|
444 | 444 | displayhook_class = Type(DisplayHook) |
|
445 | 445 | display_pub_class = Type(DisplayPublisher) |
|
446 | 446 | |
|
447 | 447 | sphinxify_docstring = Bool(False, help= |
|
448 | 448 | """ |
|
449 | 449 | Enables rich html representation of docstrings. (This requires the |
|
450 | 450 | docrepr module). |
|
451 | 451 | """).tag(config=True) |
|
452 | 452 | |
|
453 | 453 | @observe("sphinxify_docstring") |
|
454 | 454 | def _sphinxify_docstring_changed(self, change): |
|
455 | 455 | if change['new']: |
|
456 | 456 | warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning) |
|
457 | 457 | |
|
458 | 458 | enable_html_pager = Bool(False, help= |
|
459 | 459 | """ |
|
460 | 460 | (Provisional API) enables html representation in mime bundles sent |
|
461 | 461 | to pagers. |
|
462 | 462 | """).tag(config=True) |
|
463 | 463 | |
|
464 | 464 | @observe("enable_html_pager") |
|
465 | 465 | def _enable_html_pager_changed(self, change): |
|
466 | 466 | if change['new']: |
|
467 | 467 | warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning) |
|
468 | 468 | |
|
469 | 469 | data_pub_class = None |
|
470 | 470 | |
|
471 | 471 | exit_now = Bool(False) |
|
472 | 472 | exiter = Instance(ExitAutocall) |
|
473 | 473 | @default('exiter') |
|
474 | 474 | def _exiter_default(self): |
|
475 | 475 | return ExitAutocall(self) |
|
476 | 476 | # Monotonically increasing execution counter |
|
477 | 477 | execution_count = Integer(1) |
|
478 | 478 | filename = Unicode("<ipython console>") |
|
479 | 479 | ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__ |
|
480 | 480 | |
|
481 | 481 | # Used to transform cells before running them, and check whether code is complete |
|
482 | 482 | input_transformer_manager = Instance('IPython.core.inputtransformer2.TransformerManager', |
|
483 | 483 | ()) |
|
484 | 484 | |
|
485 | 485 | @property |
|
486 | 486 | def input_transformers_cleanup(self): |
|
487 | 487 | return self.input_transformer_manager.cleanup_transforms |
|
488 | 488 | |
|
489 | 489 | input_transformers_post = List([], |
|
490 | 490 | help="A list of string input transformers, to be applied after IPython's " |
|
491 | 491 | "own input transformations." |
|
492 | 492 | ) |
|
493 | 493 | |
|
494 | 494 | @property |
|
495 | 495 | def input_splitter(self): |
|
496 | 496 | """Make this available for backward compatibility (pre-7.0 release) with existing code. |
|
497 | 497 | |
|
498 | 498 | For example, ipykernel ipykernel currently uses |
|
499 | 499 | `shell.input_splitter.check_complete` |
|
500 | 500 | """ |
|
501 | 501 | from warnings import warn |
|
502 | 502 | warn("`input_splitter` is deprecated since IPython 7.0, prefer `input_transformer_manager`.", |
|
503 | 503 | DeprecationWarning, stacklevel=2 |
|
504 | 504 | ) |
|
505 | 505 | return self.input_transformer_manager |
|
506 | 506 | |
|
507 | 507 | logstart = Bool(False, help= |
|
508 | 508 | """ |
|
509 | 509 | Start logging to the default log file in overwrite mode. |
|
510 | 510 | Use `logappend` to specify a log file to **append** logs to. |
|
511 | 511 | """ |
|
512 | 512 | ).tag(config=True) |
|
513 | 513 | logfile = Unicode('', help= |
|
514 | 514 | """ |
|
515 | 515 | The name of the logfile to use. |
|
516 | 516 | """ |
|
517 | 517 | ).tag(config=True) |
|
518 | 518 | logappend = Unicode('', help= |
|
519 | 519 | """ |
|
520 | 520 | Start logging to the given file in append mode. |
|
521 | 521 | Use `logfile` to specify a log file to **overwrite** logs to. |
|
522 | 522 | """ |
|
523 | 523 | ).tag(config=True) |
|
524 | 524 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
525 | 525 | ).tag(config=True) |
|
526 | 526 | pdb = Bool(False, help= |
|
527 | 527 | """ |
|
528 | 528 | Automatically call the pdb debugger after every exception. |
|
529 | 529 | """ |
|
530 | 530 | ).tag(config=True) |
|
531 | 531 | display_page = Bool(False, |
|
532 | 532 | help="""If True, anything that would be passed to the pager |
|
533 | 533 | will be displayed as regular output instead.""" |
|
534 | 534 | ).tag(config=True) |
|
535 | 535 | |
|
536 | 536 | # deprecated prompt traits: |
|
537 | 537 | |
|
538 | 538 | prompt_in1 = Unicode('In [\\#]: ', |
|
539 | 539 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
540 | 540 | ).tag(config=True) |
|
541 | 541 | prompt_in2 = Unicode(' .\\D.: ', |
|
542 | 542 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
543 | 543 | ).tag(config=True) |
|
544 | 544 | prompt_out = Unicode('Out[\\#]: ', |
|
545 | 545 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
546 | 546 | ).tag(config=True) |
|
547 | 547 | prompts_pad_left = Bool(True, |
|
548 | 548 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
549 | 549 | ).tag(config=True) |
|
550 | 550 | |
|
551 | 551 | @observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left') |
|
552 | 552 | def _prompt_trait_changed(self, change): |
|
553 | 553 | name = change['name'] |
|
554 | 554 | warn("InteractiveShell.{name} is deprecated since IPython 4.0" |
|
555 | 555 | " and ignored since 5.0, set TerminalInteractiveShell.prompts" |
|
556 | 556 | " object directly.".format(name=name)) |
|
557 | 557 | |
|
558 | 558 | # protect against weird cases where self.config may not exist: |
|
559 | 559 | |
|
560 | 560 | show_rewritten_input = Bool(True, |
|
561 | 561 | help="Show rewritten input, e.g. for autocall." |
|
562 | 562 | ).tag(config=True) |
|
563 | 563 | |
|
564 | 564 | quiet = Bool(False).tag(config=True) |
|
565 | 565 | |
|
566 | 566 | history_length = Integer(10000, |
|
567 | 567 | help='Total length of command history' |
|
568 | 568 | ).tag(config=True) |
|
569 | 569 | |
|
570 | 570 | history_load_length = Integer(1000, help= |
|
571 | 571 | """ |
|
572 | 572 | The number of saved history entries to be loaded |
|
573 | 573 | into the history buffer at startup. |
|
574 | 574 | """ |
|
575 | 575 | ).tag(config=True) |
|
576 | 576 | |
|
577 | 577 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'], |
|
578 | 578 | default_value='last_expr', |
|
579 | 579 | help=""" |
|
580 | 580 | 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying |
|
581 | 581 | which nodes should be run interactively (displaying output from expressions). |
|
582 | 582 | """ |
|
583 | 583 | ).tag(config=True) |
|
584 | 584 | |
|
585 | 585 | # TODO: this part of prompt management should be moved to the frontends. |
|
586 | 586 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
587 | 587 | separate_in = SeparateUnicode('\n').tag(config=True) |
|
588 | 588 | separate_out = SeparateUnicode('').tag(config=True) |
|
589 | 589 | separate_out2 = SeparateUnicode('').tag(config=True) |
|
590 | 590 | wildcards_case_sensitive = Bool(True).tag(config=True) |
|
591 | 591 | xmode = CaselessStrEnum(('Context', 'Plain', 'Verbose', 'Minimal'), |
|
592 | 592 | default_value='Context', |
|
593 | 593 | help="Switch modes for the IPython exception handlers." |
|
594 | 594 | ).tag(config=True) |
|
595 | 595 | |
|
596 | 596 | # Subcomponents of InteractiveShell |
|
597 | 597 | alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True) |
|
598 | 598 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True) |
|
599 | 599 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True) |
|
600 | 600 | display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True) |
|
601 | 601 | extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True) |
|
602 | 602 | payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True) |
|
603 | 603 | history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True) |
|
604 | 604 | magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True) |
|
605 | 605 | |
|
606 | 606 | profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True) |
|
607 | 607 | @property |
|
608 | 608 | def profile(self): |
|
609 | 609 | if self.profile_dir is not None: |
|
610 | 610 | name = os.path.basename(self.profile_dir.location) |
|
611 | 611 | return name.replace('profile_','') |
|
612 | 612 | |
|
613 | 613 | |
|
614 | 614 | # Private interface |
|
615 | 615 | _post_execute = Dict() |
|
616 | 616 | |
|
617 | 617 | # Tracks any GUI loop loaded for pylab |
|
618 | 618 | pylab_gui_select = None |
|
619 | 619 | |
|
620 | 620 | last_execution_succeeded = Bool(True, help='Did last executed command succeeded') |
|
621 | 621 | |
|
622 | 622 | last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True) |
|
623 | 623 | |
|
624 | 624 | def __init__(self, ipython_dir=None, profile_dir=None, |
|
625 | 625 | user_module=None, user_ns=None, |
|
626 | 626 | custom_exceptions=((), None), **kwargs): |
|
627 | 627 | |
|
628 | 628 | # This is where traits with a config_key argument are updated |
|
629 | 629 | # from the values on config. |
|
630 | 630 | super(InteractiveShell, self).__init__(**kwargs) |
|
631 | 631 | if 'PromptManager' in self.config: |
|
632 | 632 | warn('As of IPython 5.0 `PromptManager` config will have no effect' |
|
633 | 633 | ' and has been replaced by TerminalInteractiveShell.prompts_class') |
|
634 | 634 | self.configurables = [self] |
|
635 | 635 | |
|
636 | 636 | # These are relatively independent and stateless |
|
637 | 637 | self.init_ipython_dir(ipython_dir) |
|
638 | 638 | self.init_profile_dir(profile_dir) |
|
639 | 639 | self.init_instance_attrs() |
|
640 | 640 | self.init_environment() |
|
641 | 641 | |
|
642 | 642 | # Check if we're in a virtualenv, and set up sys.path. |
|
643 | 643 | self.init_virtualenv() |
|
644 | 644 | |
|
645 | 645 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
646 | 646 | self.init_create_namespaces(user_module, user_ns) |
|
647 | 647 | # This has to be done after init_create_namespaces because it uses |
|
648 | 648 | # something in self.user_ns, but before init_sys_modules, which |
|
649 | 649 | # is the first thing to modify sys. |
|
650 | 650 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
651 | 651 | # is created, we are saving the overridden ones here. Not sure if this |
|
652 | 652 | # is what we want to do. |
|
653 | 653 | self.save_sys_module_state() |
|
654 | 654 | self.init_sys_modules() |
|
655 | 655 | |
|
656 | 656 | # While we're trying to have each part of the code directly access what |
|
657 | 657 | # it needs without keeping redundant references to objects, we have too |
|
658 | 658 | # much legacy code that expects ip.db to exist. |
|
659 | 659 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
660 | 660 | |
|
661 | 661 | self.init_history() |
|
662 | 662 | self.init_encoding() |
|
663 | 663 | self.init_prefilter() |
|
664 | 664 | |
|
665 | 665 | self.init_syntax_highlighting() |
|
666 | 666 | self.init_hooks() |
|
667 | 667 | self.init_events() |
|
668 | 668 | self.init_pushd_popd_magic() |
|
669 | 669 | self.init_user_ns() |
|
670 | 670 | self.init_logger() |
|
671 | 671 | self.init_builtins() |
|
672 | 672 | |
|
673 | 673 | # The following was in post_config_initialization |
|
674 | 674 | self.init_inspector() |
|
675 | 675 | self.raw_input_original = input |
|
676 | 676 | self.init_completer() |
|
677 | 677 | # TODO: init_io() needs to happen before init_traceback handlers |
|
678 | 678 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
679 | 679 | # This logic in in debugger.Pdb and should eventually be changed. |
|
680 | 680 | self.init_io() |
|
681 | 681 | self.init_traceback_handlers(custom_exceptions) |
|
682 | 682 | self.init_prompts() |
|
683 | 683 | self.init_display_formatter() |
|
684 | 684 | self.init_display_pub() |
|
685 | 685 | self.init_data_pub() |
|
686 | 686 | self.init_displayhook() |
|
687 | 687 | self.init_magics() |
|
688 | 688 | self.init_alias() |
|
689 | 689 | self.init_logstart() |
|
690 | 690 | self.init_pdb() |
|
691 | 691 | self.init_extension_manager() |
|
692 | 692 | self.init_payload() |
|
693 | 693 | self.init_deprecation_warnings() |
|
694 | 694 | self.hooks.late_startup_hook() |
|
695 | 695 | self.events.trigger('shell_initialized', self) |
|
696 | 696 | atexit.register(self.atexit_operations) |
|
697 | 697 | |
|
698 | 698 | # The trio runner is used for running Trio in the foreground thread. It |
|
699 | 699 | # is different from `_trio_runner(async_fn)` in `async_helpers.py` |
|
700 | 700 | # which calls `trio.run()` for every cell. This runner runs all cells |
|
701 | 701 | # inside a single Trio event loop. If used, it is set from |
|
702 | 702 | # `ipykernel.kernelapp`. |
|
703 | 703 | self.trio_runner = None |
|
704 | 704 | |
|
705 | 705 | def get_ipython(self): |
|
706 | 706 | """Return the currently running IPython instance.""" |
|
707 | 707 | return self |
|
708 | 708 | |
|
709 | 709 | #------------------------------------------------------------------------- |
|
710 | 710 | # Trait changed handlers |
|
711 | 711 | #------------------------------------------------------------------------- |
|
712 | 712 | @observe('ipython_dir') |
|
713 | 713 | def _ipython_dir_changed(self, change): |
|
714 | 714 | ensure_dir_exists(change['new']) |
|
715 | 715 | |
|
716 | 716 | def set_autoindent(self,value=None): |
|
717 | 717 | """Set the autoindent flag. |
|
718 | 718 | |
|
719 | 719 | If called with no arguments, it acts as a toggle.""" |
|
720 | 720 | if value is None: |
|
721 | 721 | self.autoindent = not self.autoindent |
|
722 | 722 | else: |
|
723 | 723 | self.autoindent = value |
|
724 | 724 | |
|
725 | 725 | def set_trio_runner(self, tr): |
|
726 | 726 | self.trio_runner = tr |
|
727 | 727 | |
|
728 | 728 | #------------------------------------------------------------------------- |
|
729 | 729 | # init_* methods called by __init__ |
|
730 | 730 | #------------------------------------------------------------------------- |
|
731 | 731 | |
|
732 | 732 | def init_ipython_dir(self, ipython_dir): |
|
733 | 733 | if ipython_dir is not None: |
|
734 | 734 | self.ipython_dir = ipython_dir |
|
735 | 735 | return |
|
736 | 736 | |
|
737 | 737 | self.ipython_dir = get_ipython_dir() |
|
738 | 738 | |
|
739 | 739 | def init_profile_dir(self, profile_dir): |
|
740 | 740 | if profile_dir is not None: |
|
741 | 741 | self.profile_dir = profile_dir |
|
742 | 742 | return |
|
743 | 743 | self.profile_dir =\ |
|
744 | 744 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
745 | 745 | |
|
746 | 746 | def init_instance_attrs(self): |
|
747 | 747 | self.more = False |
|
748 | 748 | |
|
749 | 749 | # command compiler |
|
750 | 750 | self.compile = CachingCompiler() |
|
751 | 751 | |
|
752 | 752 | # Make an empty namespace, which extension writers can rely on both |
|
753 | 753 | # existing and NEVER being used by ipython itself. This gives them a |
|
754 | 754 | # convenient location for storing additional information and state |
|
755 | 755 | # their extensions may require, without fear of collisions with other |
|
756 | 756 | # ipython names that may develop later. |
|
757 | 757 | self.meta = Struct() |
|
758 | 758 | |
|
759 | 759 | # Temporary files used for various purposes. Deleted at exit. |
|
760 | # The files here are stored with Path from Pathlib | |
|
760 | 761 | self.tempfiles = [] |
|
761 | 762 | self.tempdirs = [] |
|
762 | 763 | |
|
763 | 764 | # keep track of where we started running (mainly for crash post-mortem) |
|
764 | 765 | # This is not being used anywhere currently. |
|
765 | 766 | self.starting_dir = os.getcwd() |
|
766 | 767 | |
|
767 | 768 | # Indentation management |
|
768 | 769 | self.indent_current_nsp = 0 |
|
769 | 770 | |
|
770 | 771 | # Dict to track post-execution functions that have been registered |
|
771 | 772 | self._post_execute = {} |
|
772 | 773 | |
|
773 | 774 | def init_environment(self): |
|
774 | 775 | """Any changes we need to make to the user's environment.""" |
|
775 | 776 | pass |
|
776 | 777 | |
|
777 | 778 | def init_encoding(self): |
|
778 | 779 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
779 | 780 | # under Win32 have it set to None, and we need to have a known valid |
|
780 | 781 | # encoding to use in the raw_input() method |
|
781 | 782 | try: |
|
782 | 783 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
783 | 784 | except AttributeError: |
|
784 | 785 | self.stdin_encoding = 'ascii' |
|
785 | 786 | |
|
786 | 787 | |
|
787 | 788 | @observe('colors') |
|
788 | 789 | def init_syntax_highlighting(self, changes=None): |
|
789 | 790 | # Python source parser/formatter for syntax highlighting |
|
790 | 791 | pyformat = PyColorize.Parser(style=self.colors, parent=self).format |
|
791 | 792 | self.pycolorize = lambda src: pyformat(src,'str') |
|
792 | 793 | |
|
793 | 794 | def refresh_style(self): |
|
794 | 795 | # No-op here, used in subclass |
|
795 | 796 | pass |
|
796 | 797 | |
|
797 | 798 | def init_pushd_popd_magic(self): |
|
798 | 799 | # for pushd/popd management |
|
799 | 800 | self.home_dir = get_home_dir() |
|
800 | 801 | |
|
801 | 802 | self.dir_stack = [] |
|
802 | 803 | |
|
803 | 804 | def init_logger(self): |
|
804 | 805 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
805 | 806 | logmode='rotate') |
|
806 | 807 | |
|
807 | 808 | def init_logstart(self): |
|
808 | 809 | """Initialize logging in case it was requested at the command line. |
|
809 | 810 | """ |
|
810 | 811 | if self.logappend: |
|
811 | 812 | self.magic('logstart %s append' % self.logappend) |
|
812 | 813 | elif self.logfile: |
|
813 | 814 | self.magic('logstart %s' % self.logfile) |
|
814 | 815 | elif self.logstart: |
|
815 | 816 | self.magic('logstart') |
|
816 | 817 | |
|
817 | 818 | def init_deprecation_warnings(self): |
|
818 | 819 | """ |
|
819 | 820 | register default filter for deprecation warning. |
|
820 | 821 | |
|
821 | 822 | This will allow deprecation warning of function used interactively to show |
|
822 | 823 | warning to users, and still hide deprecation warning from libraries import. |
|
823 | 824 | """ |
|
824 | 825 | if sys.version_info < (3,7): |
|
825 | 826 | warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__")) |
|
826 | 827 | |
|
827 | 828 | |
|
828 | 829 | def init_builtins(self): |
|
829 | 830 | # A single, static flag that we set to True. Its presence indicates |
|
830 | 831 | # that an IPython shell has been created, and we make no attempts at |
|
831 | 832 | # removing on exit or representing the existence of more than one |
|
832 | 833 | # IPython at a time. |
|
833 | 834 | builtin_mod.__dict__['__IPYTHON__'] = True |
|
834 | 835 | builtin_mod.__dict__['display'] = display |
|
835 | 836 | |
|
836 | 837 | self.builtin_trap = BuiltinTrap(shell=self) |
|
837 | 838 | |
|
838 | 839 | @observe('colors') |
|
839 | 840 | def init_inspector(self, changes=None): |
|
840 | 841 | # Object inspector |
|
841 | 842 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
842 | 843 | PyColorize.ANSICodeColors, |
|
843 | 844 | self.colors, |
|
844 | 845 | self.object_info_string_level) |
|
845 | 846 | |
|
846 | 847 | def init_io(self): |
|
847 | 848 | # This will just use sys.stdout and sys.stderr. If you want to |
|
848 | 849 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
849 | 850 | # *before* instantiating this class, because io holds onto |
|
850 | 851 | # references to the underlying streams. |
|
851 | 852 | # io.std* are deprecated, but don't show our own deprecation warnings |
|
852 | 853 | # during initialization of the deprecated API. |
|
853 | 854 | with warnings.catch_warnings(): |
|
854 | 855 | warnings.simplefilter('ignore', DeprecationWarning) |
|
855 | 856 | io.stdout = io.IOStream(sys.stdout) |
|
856 | 857 | io.stderr = io.IOStream(sys.stderr) |
|
857 | 858 | |
|
858 | 859 | def init_prompts(self): |
|
859 | 860 | # Set system prompts, so that scripts can decide if they are running |
|
860 | 861 | # interactively. |
|
861 | 862 | sys.ps1 = 'In : ' |
|
862 | 863 | sys.ps2 = '...: ' |
|
863 | 864 | sys.ps3 = 'Out: ' |
|
864 | 865 | |
|
865 | 866 | def init_display_formatter(self): |
|
866 | 867 | self.display_formatter = DisplayFormatter(parent=self) |
|
867 | 868 | self.configurables.append(self.display_formatter) |
|
868 | 869 | |
|
869 | 870 | def init_display_pub(self): |
|
870 | 871 | self.display_pub = self.display_pub_class(parent=self, shell=self) |
|
871 | 872 | self.configurables.append(self.display_pub) |
|
872 | 873 | |
|
873 | 874 | def init_data_pub(self): |
|
874 | 875 | if not self.data_pub_class: |
|
875 | 876 | self.data_pub = None |
|
876 | 877 | return |
|
877 | 878 | self.data_pub = self.data_pub_class(parent=self) |
|
878 | 879 | self.configurables.append(self.data_pub) |
|
879 | 880 | |
|
880 | 881 | def init_displayhook(self): |
|
881 | 882 | # Initialize displayhook, set in/out prompts and printing system |
|
882 | 883 | self.displayhook = self.displayhook_class( |
|
883 | 884 | parent=self, |
|
884 | 885 | shell=self, |
|
885 | 886 | cache_size=self.cache_size, |
|
886 | 887 | ) |
|
887 | 888 | self.configurables.append(self.displayhook) |
|
888 | 889 | # This is a context manager that installs/revmoes the displayhook at |
|
889 | 890 | # the appropriate time. |
|
890 | 891 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
891 | 892 | |
|
892 | 893 | def init_virtualenv(self): |
|
893 | 894 | """Add the current virtualenv to sys.path so the user can import modules from it. |
|
894 | 895 | This isn't perfect: it doesn't use the Python interpreter with which the |
|
895 | 896 | virtualenv was built, and it ignores the --no-site-packages option. A |
|
896 | 897 | warning will appear suggesting the user installs IPython in the |
|
897 | 898 | virtualenv, but for many cases, it probably works well enough. |
|
898 | 899 | |
|
899 | 900 | Adapted from code snippets online. |
|
900 | 901 | |
|
901 | 902 | http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv |
|
902 | 903 | """ |
|
903 | 904 | if 'VIRTUAL_ENV' not in os.environ: |
|
904 | 905 | # Not in a virtualenv |
|
905 | 906 | return |
|
906 | 907 | elif os.environ["VIRTUAL_ENV"] == "": |
|
907 | 908 | warn("Virtual env path set to '', please check if this is intended.") |
|
908 | 909 | return |
|
909 | 910 | |
|
910 | 911 | p = Path(sys.executable) |
|
911 | 912 | p_venv = Path(os.environ["VIRTUAL_ENV"]) |
|
912 | 913 | |
|
913 | 914 | # fallback venv detection: |
|
914 | 915 | # stdlib venv may symlink sys.executable, so we can't use realpath. |
|
915 | 916 | # but others can symlink *to* the venv Python, so we can't just use sys.executable. |
|
916 | 917 | # So we just check every item in the symlink tree (generally <= 3) |
|
917 | 918 | paths = [p] |
|
918 | 919 | while p.is_symlink(): |
|
919 | 920 | p = Path(os.readlink(p)) |
|
920 | 921 | paths.append(p.resolve()) |
|
921 | 922 | |
|
922 | 923 | # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible |
|
923 | 924 | if str(p_venv).startswith("\\cygdrive"): |
|
924 | 925 | p_venv = Path(str(p_venv)[11:]) |
|
925 | 926 | elif len(str(p_venv)) >= 2 and str(p_venv)[1] == ":": |
|
926 | 927 | p_venv = Path(str(p_venv)[2:]) |
|
927 | 928 | |
|
928 | 929 | if any(os.fspath(p_venv) in os.fspath(p) for p in paths): |
|
929 | 930 | # Our exe is inside or has access to the virtualenv, don't need to do anything. |
|
930 | 931 | return |
|
931 | 932 | |
|
932 | 933 | warn("Attempting to work in a virtualenv. If you encounter problems, please " |
|
933 | 934 | "install IPython inside the virtualenv.") |
|
934 | 935 | if sys.platform == "win32": |
|
935 | 936 | virtual_env = Path(os.environ["VIRTUAL_ENV"]).joinpath( |
|
936 | 937 | "Lib", "site-packages" |
|
937 | 938 | ) |
|
938 | 939 | else: |
|
939 | 940 | virtual_env = Path(os.environ["VIRTUAL_ENV"]).joinpath( |
|
940 | 941 | "lib", "python{}.{}".format(*sys.version_info[:2]), "site-packages" |
|
941 | 942 | ) |
|
942 | 943 | |
|
943 | 944 | import site |
|
944 | 945 | sys.path.insert(0, virtual_env) |
|
945 | 946 | site.addsitedir(virtual_env) |
|
946 | 947 | |
|
947 | 948 | #------------------------------------------------------------------------- |
|
948 | 949 | # Things related to injections into the sys module |
|
949 | 950 | #------------------------------------------------------------------------- |
|
950 | 951 | |
|
951 | 952 | def save_sys_module_state(self): |
|
952 | 953 | """Save the state of hooks in the sys module. |
|
953 | 954 | |
|
954 | 955 | This has to be called after self.user_module is created. |
|
955 | 956 | """ |
|
956 | 957 | self._orig_sys_module_state = {'stdin': sys.stdin, |
|
957 | 958 | 'stdout': sys.stdout, |
|
958 | 959 | 'stderr': sys.stderr, |
|
959 | 960 | 'excepthook': sys.excepthook} |
|
960 | 961 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
961 | 962 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) |
|
962 | 963 | |
|
963 | 964 | def restore_sys_module_state(self): |
|
964 | 965 | """Restore the state of the sys module.""" |
|
965 | 966 | try: |
|
966 | 967 | for k, v in self._orig_sys_module_state.items(): |
|
967 | 968 | setattr(sys, k, v) |
|
968 | 969 | except AttributeError: |
|
969 | 970 | pass |
|
970 | 971 | # Reset what what done in self.init_sys_modules |
|
971 | 972 | if self._orig_sys_modules_main_mod is not None: |
|
972 | 973 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod |
|
973 | 974 | |
|
974 | 975 | #------------------------------------------------------------------------- |
|
975 | 976 | # Things related to the banner |
|
976 | 977 | #------------------------------------------------------------------------- |
|
977 | 978 | |
|
978 | 979 | @property |
|
979 | 980 | def banner(self): |
|
980 | 981 | banner = self.banner1 |
|
981 | 982 | if self.profile and self.profile != 'default': |
|
982 | 983 | banner += '\nIPython profile: %s\n' % self.profile |
|
983 | 984 | if self.banner2: |
|
984 | 985 | banner += '\n' + self.banner2 |
|
985 | 986 | return banner |
|
986 | 987 | |
|
987 | 988 | def show_banner(self, banner=None): |
|
988 | 989 | if banner is None: |
|
989 | 990 | banner = self.banner |
|
990 | 991 | sys.stdout.write(banner) |
|
991 | 992 | |
|
992 | 993 | #------------------------------------------------------------------------- |
|
993 | 994 | # Things related to hooks |
|
994 | 995 | #------------------------------------------------------------------------- |
|
995 | 996 | |
|
996 | 997 | def init_hooks(self): |
|
997 | 998 | # hooks holds pointers used for user-side customizations |
|
998 | 999 | self.hooks = Struct() |
|
999 | 1000 | |
|
1000 | 1001 | self.strdispatchers = {} |
|
1001 | 1002 | |
|
1002 | 1003 | # Set all default hooks, defined in the IPython.hooks module. |
|
1003 | 1004 | hooks = IPython.core.hooks |
|
1004 | 1005 | for hook_name in hooks.__all__: |
|
1005 | 1006 | # default hooks have priority 100, i.e. low; user hooks should have |
|
1006 | 1007 | # 0-100 priority |
|
1007 | 1008 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) |
|
1008 | 1009 | |
|
1009 | 1010 | if self.display_page: |
|
1010 | 1011 | self.set_hook('show_in_pager', page.as_hook(page.display_page), 90) |
|
1011 | 1012 | |
|
1012 | 1013 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, |
|
1013 | 1014 | _warn_deprecated=True): |
|
1014 | 1015 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
1015 | 1016 | |
|
1016 | 1017 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
1017 | 1018 | adding your function to one of these hooks, you can modify IPython's |
|
1018 | 1019 | behavior to call at runtime your own routines.""" |
|
1019 | 1020 | |
|
1020 | 1021 | # At some point in the future, this should validate the hook before it |
|
1021 | 1022 | # accepts it. Probably at least check that the hook takes the number |
|
1022 | 1023 | # of args it's supposed to. |
|
1023 | 1024 | |
|
1024 | 1025 | f = types.MethodType(hook,self) |
|
1025 | 1026 | |
|
1026 | 1027 | # check if the hook is for strdispatcher first |
|
1027 | 1028 | if str_key is not None: |
|
1028 | 1029 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1029 | 1030 | sdp.add_s(str_key, f, priority ) |
|
1030 | 1031 | self.strdispatchers[name] = sdp |
|
1031 | 1032 | return |
|
1032 | 1033 | if re_key is not None: |
|
1033 | 1034 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1034 | 1035 | sdp.add_re(re.compile(re_key), f, priority ) |
|
1035 | 1036 | self.strdispatchers[name] = sdp |
|
1036 | 1037 | return |
|
1037 | 1038 | |
|
1038 | 1039 | dp = getattr(self.hooks, name, None) |
|
1039 | 1040 | if name not in IPython.core.hooks.__all__: |
|
1040 | 1041 | print("Warning! Hook '%s' is not one of %s" % \ |
|
1041 | 1042 | (name, IPython.core.hooks.__all__ )) |
|
1042 | 1043 | |
|
1043 | 1044 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): |
|
1044 | 1045 | alternative = IPython.core.hooks.deprecated[name] |
|
1045 | 1046 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2) |
|
1046 | 1047 | |
|
1047 | 1048 | if not dp: |
|
1048 | 1049 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
1049 | 1050 | |
|
1050 | 1051 | try: |
|
1051 | 1052 | dp.add(f,priority) |
|
1052 | 1053 | except AttributeError: |
|
1053 | 1054 | # it was not commandchain, plain old func - replace |
|
1054 | 1055 | dp = f |
|
1055 | 1056 | |
|
1056 | 1057 | setattr(self.hooks,name, dp) |
|
1057 | 1058 | |
|
1058 | 1059 | #------------------------------------------------------------------------- |
|
1059 | 1060 | # Things related to events |
|
1060 | 1061 | #------------------------------------------------------------------------- |
|
1061 | 1062 | |
|
1062 | 1063 | def init_events(self): |
|
1063 | 1064 | self.events = EventManager(self, available_events) |
|
1064 | 1065 | |
|
1065 | 1066 | self.events.register("pre_execute", self._clear_warning_registry) |
|
1066 | 1067 | |
|
1067 | 1068 | def register_post_execute(self, func): |
|
1068 | 1069 | """DEPRECATED: Use ip.events.register('post_run_cell', func) |
|
1069 | 1070 | |
|
1070 | 1071 | Register a function for calling after code execution. |
|
1071 | 1072 | """ |
|
1072 | 1073 | warn("ip.register_post_execute is deprecated, use " |
|
1073 | 1074 | "ip.events.register('post_run_cell', func) instead.", stacklevel=2) |
|
1074 | 1075 | self.events.register('post_run_cell', func) |
|
1075 | 1076 | |
|
1076 | 1077 | def _clear_warning_registry(self): |
|
1077 | 1078 | # clear the warning registry, so that different code blocks with |
|
1078 | 1079 | # overlapping line number ranges don't cause spurious suppression of |
|
1079 | 1080 | # warnings (see gh-6611 for details) |
|
1080 | 1081 | if "__warningregistry__" in self.user_global_ns: |
|
1081 | 1082 | del self.user_global_ns["__warningregistry__"] |
|
1082 | 1083 | |
|
1083 | 1084 | #------------------------------------------------------------------------- |
|
1084 | 1085 | # Things related to the "main" module |
|
1085 | 1086 | #------------------------------------------------------------------------- |
|
1086 | 1087 | |
|
1087 | 1088 | def new_main_mod(self, filename, modname): |
|
1088 | 1089 | """Return a new 'main' module object for user code execution. |
|
1089 | 1090 | |
|
1090 | 1091 | ``filename`` should be the path of the script which will be run in the |
|
1091 | 1092 | module. Requests with the same filename will get the same module, with |
|
1092 | 1093 | its namespace cleared. |
|
1093 | 1094 | |
|
1094 | 1095 | ``modname`` should be the module name - normally either '__main__' or |
|
1095 | 1096 | the basename of the file without the extension. |
|
1096 | 1097 | |
|
1097 | 1098 | When scripts are executed via %run, we must keep a reference to their |
|
1098 | 1099 | __main__ module around so that Python doesn't |
|
1099 | 1100 | clear it, rendering references to module globals useless. |
|
1100 | 1101 | |
|
1101 | 1102 | This method keeps said reference in a private dict, keyed by the |
|
1102 | 1103 | absolute path of the script. This way, for multiple executions of the |
|
1103 | 1104 | same script we only keep one copy of the namespace (the last one), |
|
1104 | 1105 | thus preventing memory leaks from old references while allowing the |
|
1105 | 1106 | objects from the last execution to be accessible. |
|
1106 | 1107 | """ |
|
1107 | 1108 | filename = os.path.abspath(filename) |
|
1108 | 1109 | try: |
|
1109 | 1110 | main_mod = self._main_mod_cache[filename] |
|
1110 | 1111 | except KeyError: |
|
1111 | 1112 | main_mod = self._main_mod_cache[filename] = types.ModuleType( |
|
1112 | 1113 | modname, |
|
1113 | 1114 | doc="Module created for script run in IPython") |
|
1114 | 1115 | else: |
|
1115 | 1116 | main_mod.__dict__.clear() |
|
1116 | 1117 | main_mod.__name__ = modname |
|
1117 | 1118 | |
|
1118 | 1119 | main_mod.__file__ = filename |
|
1119 | 1120 | # It seems pydoc (and perhaps others) needs any module instance to |
|
1120 | 1121 | # implement a __nonzero__ method |
|
1121 | 1122 | main_mod.__nonzero__ = lambda : True |
|
1122 | 1123 | |
|
1123 | 1124 | return main_mod |
|
1124 | 1125 | |
|
1125 | 1126 | def clear_main_mod_cache(self): |
|
1126 | 1127 | """Clear the cache of main modules. |
|
1127 | 1128 | |
|
1128 | 1129 | Mainly for use by utilities like %reset. |
|
1129 | 1130 | |
|
1130 | 1131 | Examples |
|
1131 | 1132 | -------- |
|
1132 | 1133 | In [15]: import IPython |
|
1133 | 1134 | |
|
1134 | 1135 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') |
|
1135 | 1136 | |
|
1136 | 1137 | In [17]: len(_ip._main_mod_cache) > 0 |
|
1137 | 1138 | Out[17]: True |
|
1138 | 1139 | |
|
1139 | 1140 | In [18]: _ip.clear_main_mod_cache() |
|
1140 | 1141 | |
|
1141 | 1142 | In [19]: len(_ip._main_mod_cache) == 0 |
|
1142 | 1143 | Out[19]: True |
|
1143 | 1144 | """ |
|
1144 | 1145 | self._main_mod_cache.clear() |
|
1145 | 1146 | |
|
1146 | 1147 | #------------------------------------------------------------------------- |
|
1147 | 1148 | # Things related to debugging |
|
1148 | 1149 | #------------------------------------------------------------------------- |
|
1149 | 1150 | |
|
1150 | 1151 | def init_pdb(self): |
|
1151 | 1152 | # Set calling of pdb on exceptions |
|
1152 | 1153 | # self.call_pdb is a property |
|
1153 | 1154 | self.call_pdb = self.pdb |
|
1154 | 1155 | |
|
1155 | 1156 | def _get_call_pdb(self): |
|
1156 | 1157 | return self._call_pdb |
|
1157 | 1158 | |
|
1158 | 1159 | def _set_call_pdb(self,val): |
|
1159 | 1160 | |
|
1160 | 1161 | if val not in (0,1,False,True): |
|
1161 | 1162 | raise ValueError('new call_pdb value must be boolean') |
|
1162 | 1163 | |
|
1163 | 1164 | # store value in instance |
|
1164 | 1165 | self._call_pdb = val |
|
1165 | 1166 | |
|
1166 | 1167 | # notify the actual exception handlers |
|
1167 | 1168 | self.InteractiveTB.call_pdb = val |
|
1168 | 1169 | |
|
1169 | 1170 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
1170 | 1171 | 'Control auto-activation of pdb at exceptions') |
|
1171 | 1172 | |
|
1172 | 1173 | def debugger(self,force=False): |
|
1173 | 1174 | """Call the pdb debugger. |
|
1174 | 1175 | |
|
1175 | 1176 | Keywords: |
|
1176 | 1177 | |
|
1177 | 1178 | - force(False): by default, this routine checks the instance call_pdb |
|
1178 | 1179 | flag and does not actually invoke the debugger if the flag is false. |
|
1179 | 1180 | The 'force' option forces the debugger to activate even if the flag |
|
1180 | 1181 | is false. |
|
1181 | 1182 | """ |
|
1182 | 1183 | |
|
1183 | 1184 | if not (force or self.call_pdb): |
|
1184 | 1185 | return |
|
1185 | 1186 | |
|
1186 | 1187 | if not hasattr(sys,'last_traceback'): |
|
1187 | 1188 | error('No traceback has been produced, nothing to debug.') |
|
1188 | 1189 | return |
|
1189 | 1190 | |
|
1190 | 1191 | self.InteractiveTB.debugger(force=True) |
|
1191 | 1192 | |
|
1192 | 1193 | #------------------------------------------------------------------------- |
|
1193 | 1194 | # Things related to IPython's various namespaces |
|
1194 | 1195 | #------------------------------------------------------------------------- |
|
1195 | 1196 | default_user_namespaces = True |
|
1196 | 1197 | |
|
1197 | 1198 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
1198 | 1199 | # Create the namespace where the user will operate. user_ns is |
|
1199 | 1200 | # normally the only one used, and it is passed to the exec calls as |
|
1200 | 1201 | # the locals argument. But we do carry a user_global_ns namespace |
|
1201 | 1202 | # given as the exec 'globals' argument, This is useful in embedding |
|
1202 | 1203 | # situations where the ipython shell opens in a context where the |
|
1203 | 1204 | # distinction between locals and globals is meaningful. For |
|
1204 | 1205 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
1205 | 1206 | |
|
1206 | 1207 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
1207 | 1208 | # level as a dict instead of a module. This is a manual fix, but I |
|
1208 | 1209 | # should really track down where the problem is coming from. Alex |
|
1209 | 1210 | # Schmolck reported this problem first. |
|
1210 | 1211 | |
|
1211 | 1212 | # A useful post by Alex Martelli on this topic: |
|
1212 | 1213 | # Re: inconsistent value from __builtins__ |
|
1213 | 1214 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
1214 | 1215 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
1215 | 1216 | # Gruppen: comp.lang.python |
|
1216 | 1217 | |
|
1217 | 1218 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
1218 | 1219 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
1219 | 1220 | # > <type 'dict'> |
|
1220 | 1221 | # > >>> print type(__builtins__) |
|
1221 | 1222 | # > <type 'module'> |
|
1222 | 1223 | # > Is this difference in return value intentional? |
|
1223 | 1224 | |
|
1224 | 1225 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
1225 | 1226 | # or a module, and it's been that way for a long time. Whether it's |
|
1226 | 1227 | # intentional (or sensible), I don't know. In any case, the idea is |
|
1227 | 1228 | # that if you need to access the built-in namespace directly, you |
|
1228 | 1229 | # should start with "import __builtin__" (note, no 's') which will |
|
1229 | 1230 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
1230 | 1231 | |
|
1231 | 1232 | # These routines return a properly built module and dict as needed by |
|
1232 | 1233 | # the rest of the code, and can also be used by extension writers to |
|
1233 | 1234 | # generate properly initialized namespaces. |
|
1234 | 1235 | if (user_ns is not None) or (user_module is not None): |
|
1235 | 1236 | self.default_user_namespaces = False |
|
1236 | 1237 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
1237 | 1238 | |
|
1238 | 1239 | # A record of hidden variables we have added to the user namespace, so |
|
1239 | 1240 | # we can list later only variables defined in actual interactive use. |
|
1240 | 1241 | self.user_ns_hidden = {} |
|
1241 | 1242 | |
|
1242 | 1243 | # Now that FakeModule produces a real module, we've run into a nasty |
|
1243 | 1244 | # problem: after script execution (via %run), the module where the user |
|
1244 | 1245 | # code ran is deleted. Now that this object is a true module (needed |
|
1245 | 1246 | # so doctest and other tools work correctly), the Python module |
|
1246 | 1247 | # teardown mechanism runs over it, and sets to None every variable |
|
1247 | 1248 | # present in that module. Top-level references to objects from the |
|
1248 | 1249 | # script survive, because the user_ns is updated with them. However, |
|
1249 | 1250 | # calling functions defined in the script that use other things from |
|
1250 | 1251 | # the script will fail, because the function's closure had references |
|
1251 | 1252 | # to the original objects, which are now all None. So we must protect |
|
1252 | 1253 | # these modules from deletion by keeping a cache. |
|
1253 | 1254 | # |
|
1254 | 1255 | # To avoid keeping stale modules around (we only need the one from the |
|
1255 | 1256 | # last run), we use a dict keyed with the full path to the script, so |
|
1256 | 1257 | # only the last version of the module is held in the cache. Note, |
|
1257 | 1258 | # however, that we must cache the module *namespace contents* (their |
|
1258 | 1259 | # __dict__). Because if we try to cache the actual modules, old ones |
|
1259 | 1260 | # (uncached) could be destroyed while still holding references (such as |
|
1260 | 1261 | # those held by GUI objects that tend to be long-lived)> |
|
1261 | 1262 | # |
|
1262 | 1263 | # The %reset command will flush this cache. See the cache_main_mod() |
|
1263 | 1264 | # and clear_main_mod_cache() methods for details on use. |
|
1264 | 1265 | |
|
1265 | 1266 | # This is the cache used for 'main' namespaces |
|
1266 | 1267 | self._main_mod_cache = {} |
|
1267 | 1268 | |
|
1268 | 1269 | # A table holding all the namespaces IPython deals with, so that |
|
1269 | 1270 | # introspection facilities can search easily. |
|
1270 | 1271 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
1271 | 1272 | 'user_local':self.user_ns, |
|
1272 | 1273 | 'builtin':builtin_mod.__dict__ |
|
1273 | 1274 | } |
|
1274 | 1275 | |
|
1275 | 1276 | @property |
|
1276 | 1277 | def user_global_ns(self): |
|
1277 | 1278 | return self.user_module.__dict__ |
|
1278 | 1279 | |
|
1279 | 1280 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
1280 | 1281 | """Prepare the module and namespace in which user code will be run. |
|
1281 | 1282 | |
|
1282 | 1283 | When IPython is started normally, both parameters are None: a new module |
|
1283 | 1284 | is created automatically, and its __dict__ used as the namespace. |
|
1284 | 1285 | |
|
1285 | 1286 | If only user_module is provided, its __dict__ is used as the namespace. |
|
1286 | 1287 | If only user_ns is provided, a dummy module is created, and user_ns |
|
1287 | 1288 | becomes the global namespace. If both are provided (as they may be |
|
1288 | 1289 | when embedding), user_ns is the local namespace, and user_module |
|
1289 | 1290 | provides the global namespace. |
|
1290 | 1291 | |
|
1291 | 1292 | Parameters |
|
1292 | 1293 | ---------- |
|
1293 | 1294 | user_module : module, optional |
|
1294 | 1295 | The current user module in which IPython is being run. If None, |
|
1295 | 1296 | a clean module will be created. |
|
1296 | 1297 | user_ns : dict, optional |
|
1297 | 1298 | A namespace in which to run interactive commands. |
|
1298 | 1299 | |
|
1299 | 1300 | Returns |
|
1300 | 1301 | ------- |
|
1301 | 1302 | A tuple of user_module and user_ns, each properly initialised. |
|
1302 | 1303 | """ |
|
1303 | 1304 | if user_module is None and user_ns is not None: |
|
1304 | 1305 | user_ns.setdefault("__name__", "__main__") |
|
1305 | 1306 | user_module = DummyMod() |
|
1306 | 1307 | user_module.__dict__ = user_ns |
|
1307 | 1308 | |
|
1308 | 1309 | if user_module is None: |
|
1309 | 1310 | user_module = types.ModuleType("__main__", |
|
1310 | 1311 | doc="Automatically created module for IPython interactive environment") |
|
1311 | 1312 | |
|
1312 | 1313 | # We must ensure that __builtin__ (without the final 's') is always |
|
1313 | 1314 | # available and pointing to the __builtin__ *module*. For more details: |
|
1314 | 1315 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1315 | 1316 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
1316 | 1317 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
1317 | 1318 | |
|
1318 | 1319 | if user_ns is None: |
|
1319 | 1320 | user_ns = user_module.__dict__ |
|
1320 | 1321 | |
|
1321 | 1322 | return user_module, user_ns |
|
1322 | 1323 | |
|
1323 | 1324 | def init_sys_modules(self): |
|
1324 | 1325 | # We need to insert into sys.modules something that looks like a |
|
1325 | 1326 | # module but which accesses the IPython namespace, for shelve and |
|
1326 | 1327 | # pickle to work interactively. Normally they rely on getting |
|
1327 | 1328 | # everything out of __main__, but for embedding purposes each IPython |
|
1328 | 1329 | # instance has its own private namespace, so we can't go shoving |
|
1329 | 1330 | # everything into __main__. |
|
1330 | 1331 | |
|
1331 | 1332 | # note, however, that we should only do this for non-embedded |
|
1332 | 1333 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1333 | 1334 | # namespace. Embedded instances, on the other hand, should not do |
|
1334 | 1335 | # this because they need to manage the user local/global namespaces |
|
1335 | 1336 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1336 | 1337 | # shouldn't overtake the execution environment of the script they're |
|
1337 | 1338 | # embedded in). |
|
1338 | 1339 | |
|
1339 | 1340 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1340 | 1341 | main_name = self.user_module.__name__ |
|
1341 | 1342 | sys.modules[main_name] = self.user_module |
|
1342 | 1343 | |
|
1343 | 1344 | def init_user_ns(self): |
|
1344 | 1345 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1345 | 1346 | |
|
1346 | 1347 | Certain history lists are also initialized here, as they effectively |
|
1347 | 1348 | act as user namespaces. |
|
1348 | 1349 | |
|
1349 | 1350 | Notes |
|
1350 | 1351 | ----- |
|
1351 | 1352 | All data structures here are only filled in, they are NOT reset by this |
|
1352 | 1353 | method. If they were not empty before, data will simply be added to |
|
1353 | 1354 | them. |
|
1354 | 1355 | """ |
|
1355 | 1356 | # This function works in two parts: first we put a few things in |
|
1356 | 1357 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1357 | 1358 | # initial variables aren't shown by %who. After the sync, we add the |
|
1358 | 1359 | # rest of what we *do* want the user to see with %who even on a new |
|
1359 | 1360 | # session (probably nothing, so they really only see their own stuff) |
|
1360 | 1361 | |
|
1361 | 1362 | # The user dict must *always* have a __builtin__ reference to the |
|
1362 | 1363 | # Python standard __builtin__ namespace, which must be imported. |
|
1363 | 1364 | # This is so that certain operations in prompt evaluation can be |
|
1364 | 1365 | # reliably executed with builtins. Note that we can NOT use |
|
1365 | 1366 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1366 | 1367 | # module, and can even mutate at runtime, depending on the context |
|
1367 | 1368 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1368 | 1369 | # always a module object, though it must be explicitly imported. |
|
1369 | 1370 | |
|
1370 | 1371 | # For more details: |
|
1371 | 1372 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1372 | 1373 | ns = {} |
|
1373 | 1374 | |
|
1374 | 1375 | # make global variables for user access to the histories |
|
1375 | 1376 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1376 | 1377 | ns['_oh'] = self.history_manager.output_hist |
|
1377 | 1378 | ns['_dh'] = self.history_manager.dir_hist |
|
1378 | 1379 | |
|
1379 | 1380 | # user aliases to input and output histories. These shouldn't show up |
|
1380 | 1381 | # in %who, as they can have very large reprs. |
|
1381 | 1382 | ns['In'] = self.history_manager.input_hist_parsed |
|
1382 | 1383 | ns['Out'] = self.history_manager.output_hist |
|
1383 | 1384 | |
|
1384 | 1385 | # Store myself as the public api!!! |
|
1385 | 1386 | ns['get_ipython'] = self.get_ipython |
|
1386 | 1387 | |
|
1387 | 1388 | ns['exit'] = self.exiter |
|
1388 | 1389 | ns['quit'] = self.exiter |
|
1389 | 1390 | |
|
1390 | 1391 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1391 | 1392 | # by %who |
|
1392 | 1393 | self.user_ns_hidden.update(ns) |
|
1393 | 1394 | |
|
1394 | 1395 | # Anything put into ns now would show up in %who. Think twice before |
|
1395 | 1396 | # putting anything here, as we really want %who to show the user their |
|
1396 | 1397 | # stuff, not our variables. |
|
1397 | 1398 | |
|
1398 | 1399 | # Finally, update the real user's namespace |
|
1399 | 1400 | self.user_ns.update(ns) |
|
1400 | 1401 | |
|
1401 | 1402 | @property |
|
1402 | 1403 | def all_ns_refs(self): |
|
1403 | 1404 | """Get a list of references to all the namespace dictionaries in which |
|
1404 | 1405 | IPython might store a user-created object. |
|
1405 | 1406 | |
|
1406 | 1407 | Note that this does not include the displayhook, which also caches |
|
1407 | 1408 | objects from the output.""" |
|
1408 | 1409 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ |
|
1409 | 1410 | [m.__dict__ for m in self._main_mod_cache.values()] |
|
1410 | 1411 | |
|
1411 | 1412 | def reset(self, new_session=True): |
|
1412 | 1413 | """Clear all internal namespaces, and attempt to release references to |
|
1413 | 1414 | user objects. |
|
1414 | 1415 | |
|
1415 | 1416 | If new_session is True, a new history session will be opened. |
|
1416 | 1417 | """ |
|
1417 | 1418 | # Clear histories |
|
1418 | 1419 | self.history_manager.reset(new_session) |
|
1419 | 1420 | # Reset counter used to index all histories |
|
1420 | 1421 | if new_session: |
|
1421 | 1422 | self.execution_count = 1 |
|
1422 | 1423 | |
|
1423 | 1424 | # Reset last execution result |
|
1424 | 1425 | self.last_execution_succeeded = True |
|
1425 | 1426 | self.last_execution_result = None |
|
1426 | 1427 | |
|
1427 | 1428 | # Flush cached output items |
|
1428 | 1429 | if self.displayhook.do_full_cache: |
|
1429 | 1430 | self.displayhook.flush() |
|
1430 | 1431 | |
|
1431 | 1432 | # The main execution namespaces must be cleared very carefully, |
|
1432 | 1433 | # skipping the deletion of the builtin-related keys, because doing so |
|
1433 | 1434 | # would cause errors in many object's __del__ methods. |
|
1434 | 1435 | if self.user_ns is not self.user_global_ns: |
|
1435 | 1436 | self.user_ns.clear() |
|
1436 | 1437 | ns = self.user_global_ns |
|
1437 | 1438 | drop_keys = set(ns.keys()) |
|
1438 | 1439 | drop_keys.discard('__builtin__') |
|
1439 | 1440 | drop_keys.discard('__builtins__') |
|
1440 | 1441 | drop_keys.discard('__name__') |
|
1441 | 1442 | for k in drop_keys: |
|
1442 | 1443 | del ns[k] |
|
1443 | 1444 | |
|
1444 | 1445 | self.user_ns_hidden.clear() |
|
1445 | 1446 | |
|
1446 | 1447 | # Restore the user namespaces to minimal usability |
|
1447 | 1448 | self.init_user_ns() |
|
1448 | 1449 | |
|
1449 | 1450 | # Restore the default and user aliases |
|
1450 | 1451 | self.alias_manager.clear_aliases() |
|
1451 | 1452 | self.alias_manager.init_aliases() |
|
1452 | 1453 | |
|
1453 | 1454 | # Now define aliases that only make sense on the terminal, because they |
|
1454 | 1455 | # need direct access to the console in a way that we can't emulate in |
|
1455 | 1456 | # GUI or web frontend |
|
1456 | 1457 | if os.name == 'posix': |
|
1457 | 1458 | for cmd in ('clear', 'more', 'less', 'man'): |
|
1458 | 1459 | if cmd not in self.magics_manager.magics['line']: |
|
1459 | 1460 | self.alias_manager.soft_define_alias(cmd, cmd) |
|
1460 | 1461 | |
|
1461 | 1462 | # Flush the private list of module references kept for script |
|
1462 | 1463 | # execution protection |
|
1463 | 1464 | self.clear_main_mod_cache() |
|
1464 | 1465 | |
|
1465 | 1466 | def del_var(self, varname, by_name=False): |
|
1466 | 1467 | """Delete a variable from the various namespaces, so that, as |
|
1467 | 1468 | far as possible, we're not keeping any hidden references to it. |
|
1468 | 1469 | |
|
1469 | 1470 | Parameters |
|
1470 | 1471 | ---------- |
|
1471 | 1472 | varname : str |
|
1472 | 1473 | The name of the variable to delete. |
|
1473 | 1474 | by_name : bool |
|
1474 | 1475 | If True, delete variables with the given name in each |
|
1475 | 1476 | namespace. If False (default), find the variable in the user |
|
1476 | 1477 | namespace, and delete references to it. |
|
1477 | 1478 | """ |
|
1478 | 1479 | if varname in ('__builtin__', '__builtins__'): |
|
1479 | 1480 | raise ValueError("Refusing to delete %s" % varname) |
|
1480 | 1481 | |
|
1481 | 1482 | ns_refs = self.all_ns_refs |
|
1482 | 1483 | |
|
1483 | 1484 | if by_name: # Delete by name |
|
1484 | 1485 | for ns in ns_refs: |
|
1485 | 1486 | try: |
|
1486 | 1487 | del ns[varname] |
|
1487 | 1488 | except KeyError: |
|
1488 | 1489 | pass |
|
1489 | 1490 | else: # Delete by object |
|
1490 | 1491 | try: |
|
1491 | 1492 | obj = self.user_ns[varname] |
|
1492 | 1493 | except KeyError as e: |
|
1493 | 1494 | raise NameError("name '%s' is not defined" % varname) from e |
|
1494 | 1495 | # Also check in output history |
|
1495 | 1496 | ns_refs.append(self.history_manager.output_hist) |
|
1496 | 1497 | for ns in ns_refs: |
|
1497 | 1498 | to_delete = [n for n, o in ns.items() if o is obj] |
|
1498 | 1499 | for name in to_delete: |
|
1499 | 1500 | del ns[name] |
|
1500 | 1501 | |
|
1501 | 1502 | # Ensure it is removed from the last execution result |
|
1502 | 1503 | if self.last_execution_result.result is obj: |
|
1503 | 1504 | self.last_execution_result = None |
|
1504 | 1505 | |
|
1505 | 1506 | # displayhook keeps extra references, but not in a dictionary |
|
1506 | 1507 | for name in ('_', '__', '___'): |
|
1507 | 1508 | if getattr(self.displayhook, name) is obj: |
|
1508 | 1509 | setattr(self.displayhook, name, None) |
|
1509 | 1510 | |
|
1510 | 1511 | def reset_selective(self, regex=None): |
|
1511 | 1512 | """Clear selective variables from internal namespaces based on a |
|
1512 | 1513 | specified regular expression. |
|
1513 | 1514 | |
|
1514 | 1515 | Parameters |
|
1515 | 1516 | ---------- |
|
1516 | 1517 | regex : string or compiled pattern, optional |
|
1517 | 1518 | A regular expression pattern that will be used in searching |
|
1518 | 1519 | variable names in the users namespaces. |
|
1519 | 1520 | """ |
|
1520 | 1521 | if regex is not None: |
|
1521 | 1522 | try: |
|
1522 | 1523 | m = re.compile(regex) |
|
1523 | 1524 | except TypeError as e: |
|
1524 | 1525 | raise TypeError('regex must be a string or compiled pattern') from e |
|
1525 | 1526 | # Search for keys in each namespace that match the given regex |
|
1526 | 1527 | # If a match is found, delete the key/value pair. |
|
1527 | 1528 | for ns in self.all_ns_refs: |
|
1528 | 1529 | for var in ns: |
|
1529 | 1530 | if m.search(var): |
|
1530 | 1531 | del ns[var] |
|
1531 | 1532 | |
|
1532 | 1533 | def push(self, variables, interactive=True): |
|
1533 | 1534 | """Inject a group of variables into the IPython user namespace. |
|
1534 | 1535 | |
|
1535 | 1536 | Parameters |
|
1536 | 1537 | ---------- |
|
1537 | 1538 | variables : dict, str or list/tuple of str |
|
1538 | 1539 | The variables to inject into the user's namespace. If a dict, a |
|
1539 | 1540 | simple update is done. If a str, the string is assumed to have |
|
1540 | 1541 | variable names separated by spaces. A list/tuple of str can also |
|
1541 | 1542 | be used to give the variable names. If just the variable names are |
|
1542 | 1543 | give (list/tuple/str) then the variable values looked up in the |
|
1543 | 1544 | callers frame. |
|
1544 | 1545 | interactive : bool |
|
1545 | 1546 | If True (default), the variables will be listed with the ``who`` |
|
1546 | 1547 | magic. |
|
1547 | 1548 | """ |
|
1548 | 1549 | vdict = None |
|
1549 | 1550 | |
|
1550 | 1551 | # We need a dict of name/value pairs to do namespace updates. |
|
1551 | 1552 | if isinstance(variables, dict): |
|
1552 | 1553 | vdict = variables |
|
1553 | 1554 | elif isinstance(variables, (str, list, tuple)): |
|
1554 | 1555 | if isinstance(variables, str): |
|
1555 | 1556 | vlist = variables.split() |
|
1556 | 1557 | else: |
|
1557 | 1558 | vlist = variables |
|
1558 | 1559 | vdict = {} |
|
1559 | 1560 | cf = sys._getframe(1) |
|
1560 | 1561 | for name in vlist: |
|
1561 | 1562 | try: |
|
1562 | 1563 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1563 | 1564 | except: |
|
1564 | 1565 | print('Could not get variable %s from %s' % |
|
1565 | 1566 | (name,cf.f_code.co_name)) |
|
1566 | 1567 | else: |
|
1567 | 1568 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1568 | 1569 | |
|
1569 | 1570 | # Propagate variables to user namespace |
|
1570 | 1571 | self.user_ns.update(vdict) |
|
1571 | 1572 | |
|
1572 | 1573 | # And configure interactive visibility |
|
1573 | 1574 | user_ns_hidden = self.user_ns_hidden |
|
1574 | 1575 | if interactive: |
|
1575 | 1576 | for name in vdict: |
|
1576 | 1577 | user_ns_hidden.pop(name, None) |
|
1577 | 1578 | else: |
|
1578 | 1579 | user_ns_hidden.update(vdict) |
|
1579 | 1580 | |
|
1580 | 1581 | def drop_by_id(self, variables): |
|
1581 | 1582 | """Remove a dict of variables from the user namespace, if they are the |
|
1582 | 1583 | same as the values in the dictionary. |
|
1583 | 1584 | |
|
1584 | 1585 | This is intended for use by extensions: variables that they've added can |
|
1585 | 1586 | be taken back out if they are unloaded, without removing any that the |
|
1586 | 1587 | user has overwritten. |
|
1587 | 1588 | |
|
1588 | 1589 | Parameters |
|
1589 | 1590 | ---------- |
|
1590 | 1591 | variables : dict |
|
1591 | 1592 | A dictionary mapping object names (as strings) to the objects. |
|
1592 | 1593 | """ |
|
1593 | 1594 | for name, obj in variables.items(): |
|
1594 | 1595 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1595 | 1596 | del self.user_ns[name] |
|
1596 | 1597 | self.user_ns_hidden.pop(name, None) |
|
1597 | 1598 | |
|
1598 | 1599 | #------------------------------------------------------------------------- |
|
1599 | 1600 | # Things related to object introspection |
|
1600 | 1601 | #------------------------------------------------------------------------- |
|
1601 | 1602 | |
|
1602 | 1603 | def _ofind(self, oname, namespaces=None): |
|
1603 | 1604 | """Find an object in the available namespaces. |
|
1604 | 1605 | |
|
1605 | 1606 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1606 | 1607 | |
|
1607 | 1608 | Has special code to detect magic functions. |
|
1608 | 1609 | """ |
|
1609 | 1610 | oname = oname.strip() |
|
1610 | 1611 | if not oname.startswith(ESC_MAGIC) and \ |
|
1611 | 1612 | not oname.startswith(ESC_MAGIC2) and \ |
|
1612 | 1613 | not all(a.isidentifier() for a in oname.split(".")): |
|
1613 | 1614 | return {'found': False} |
|
1614 | 1615 | |
|
1615 | 1616 | if namespaces is None: |
|
1616 | 1617 | # Namespaces to search in: |
|
1617 | 1618 | # Put them in a list. The order is important so that we |
|
1618 | 1619 | # find things in the same order that Python finds them. |
|
1619 | 1620 | namespaces = [ ('Interactive', self.user_ns), |
|
1620 | 1621 | ('Interactive (global)', self.user_global_ns), |
|
1621 | 1622 | ('Python builtin', builtin_mod.__dict__), |
|
1622 | 1623 | ] |
|
1623 | 1624 | |
|
1624 | 1625 | ismagic = False |
|
1625 | 1626 | isalias = False |
|
1626 | 1627 | found = False |
|
1627 | 1628 | ospace = None |
|
1628 | 1629 | parent = None |
|
1629 | 1630 | obj = None |
|
1630 | 1631 | |
|
1631 | 1632 | |
|
1632 | 1633 | # Look for the given name by splitting it in parts. If the head is |
|
1633 | 1634 | # found, then we look for all the remaining parts as members, and only |
|
1634 | 1635 | # declare success if we can find them all. |
|
1635 | 1636 | oname_parts = oname.split('.') |
|
1636 | 1637 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1637 | 1638 | for nsname,ns in namespaces: |
|
1638 | 1639 | try: |
|
1639 | 1640 | obj = ns[oname_head] |
|
1640 | 1641 | except KeyError: |
|
1641 | 1642 | continue |
|
1642 | 1643 | else: |
|
1643 | 1644 | for idx, part in enumerate(oname_rest): |
|
1644 | 1645 | try: |
|
1645 | 1646 | parent = obj |
|
1646 | 1647 | # The last part is looked up in a special way to avoid |
|
1647 | 1648 | # descriptor invocation as it may raise or have side |
|
1648 | 1649 | # effects. |
|
1649 | 1650 | if idx == len(oname_rest) - 1: |
|
1650 | 1651 | obj = self._getattr_property(obj, part) |
|
1651 | 1652 | else: |
|
1652 | 1653 | obj = getattr(obj, part) |
|
1653 | 1654 | except: |
|
1654 | 1655 | # Blanket except b/c some badly implemented objects |
|
1655 | 1656 | # allow __getattr__ to raise exceptions other than |
|
1656 | 1657 | # AttributeError, which then crashes IPython. |
|
1657 | 1658 | break |
|
1658 | 1659 | else: |
|
1659 | 1660 | # If we finish the for loop (no break), we got all members |
|
1660 | 1661 | found = True |
|
1661 | 1662 | ospace = nsname |
|
1662 | 1663 | break # namespace loop |
|
1663 | 1664 | |
|
1664 | 1665 | # Try to see if it's magic |
|
1665 | 1666 | if not found: |
|
1666 | 1667 | obj = None |
|
1667 | 1668 | if oname.startswith(ESC_MAGIC2): |
|
1668 | 1669 | oname = oname.lstrip(ESC_MAGIC2) |
|
1669 | 1670 | obj = self.find_cell_magic(oname) |
|
1670 | 1671 | elif oname.startswith(ESC_MAGIC): |
|
1671 | 1672 | oname = oname.lstrip(ESC_MAGIC) |
|
1672 | 1673 | obj = self.find_line_magic(oname) |
|
1673 | 1674 | else: |
|
1674 | 1675 | # search without prefix, so run? will find %run? |
|
1675 | 1676 | obj = self.find_line_magic(oname) |
|
1676 | 1677 | if obj is None: |
|
1677 | 1678 | obj = self.find_cell_magic(oname) |
|
1678 | 1679 | if obj is not None: |
|
1679 | 1680 | found = True |
|
1680 | 1681 | ospace = 'IPython internal' |
|
1681 | 1682 | ismagic = True |
|
1682 | 1683 | isalias = isinstance(obj, Alias) |
|
1683 | 1684 | |
|
1684 | 1685 | # Last try: special-case some literals like '', [], {}, etc: |
|
1685 | 1686 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1686 | 1687 | obj = eval(oname_head) |
|
1687 | 1688 | found = True |
|
1688 | 1689 | ospace = 'Interactive' |
|
1689 | 1690 | |
|
1690 | 1691 | return { |
|
1691 | 1692 | 'obj':obj, |
|
1692 | 1693 | 'found':found, |
|
1693 | 1694 | 'parent':parent, |
|
1694 | 1695 | 'ismagic':ismagic, |
|
1695 | 1696 | 'isalias':isalias, |
|
1696 | 1697 | 'namespace':ospace |
|
1697 | 1698 | } |
|
1698 | 1699 | |
|
1699 | 1700 | @staticmethod |
|
1700 | 1701 | def _getattr_property(obj, attrname): |
|
1701 | 1702 | """Property-aware getattr to use in object finding. |
|
1702 | 1703 | |
|
1703 | 1704 | If attrname represents a property, return it unevaluated (in case it has |
|
1704 | 1705 | side effects or raises an error. |
|
1705 | 1706 | |
|
1706 | 1707 | """ |
|
1707 | 1708 | if not isinstance(obj, type): |
|
1708 | 1709 | try: |
|
1709 | 1710 | # `getattr(type(obj), attrname)` is not guaranteed to return |
|
1710 | 1711 | # `obj`, but does so for property: |
|
1711 | 1712 | # |
|
1712 | 1713 | # property.__get__(self, None, cls) -> self |
|
1713 | 1714 | # |
|
1714 | 1715 | # The universal alternative is to traverse the mro manually |
|
1715 | 1716 | # searching for attrname in class dicts. |
|
1716 | 1717 | attr = getattr(type(obj), attrname) |
|
1717 | 1718 | except AttributeError: |
|
1718 | 1719 | pass |
|
1719 | 1720 | else: |
|
1720 | 1721 | # This relies on the fact that data descriptors (with both |
|
1721 | 1722 | # __get__ & __set__ magic methods) take precedence over |
|
1722 | 1723 | # instance-level attributes: |
|
1723 | 1724 | # |
|
1724 | 1725 | # class A(object): |
|
1725 | 1726 | # @property |
|
1726 | 1727 | # def foobar(self): return 123 |
|
1727 | 1728 | # a = A() |
|
1728 | 1729 | # a.__dict__['foobar'] = 345 |
|
1729 | 1730 | # a.foobar # == 123 |
|
1730 | 1731 | # |
|
1731 | 1732 | # So, a property may be returned right away. |
|
1732 | 1733 | if isinstance(attr, property): |
|
1733 | 1734 | return attr |
|
1734 | 1735 | |
|
1735 | 1736 | # Nothing helped, fall back. |
|
1736 | 1737 | return getattr(obj, attrname) |
|
1737 | 1738 | |
|
1738 | 1739 | def _object_find(self, oname, namespaces=None): |
|
1739 | 1740 | """Find an object and return a struct with info about it.""" |
|
1740 | 1741 | return Struct(self._ofind(oname, namespaces)) |
|
1741 | 1742 | |
|
1742 | 1743 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1743 | 1744 | """Generic interface to the inspector system. |
|
1744 | 1745 | |
|
1745 | 1746 | This function is meant to be called by pdef, pdoc & friends. |
|
1746 | 1747 | """ |
|
1747 | 1748 | info = self._object_find(oname, namespaces) |
|
1748 | 1749 | docformat = sphinxify if self.sphinxify_docstring else None |
|
1749 | 1750 | if info.found: |
|
1750 | 1751 | pmethod = getattr(self.inspector, meth) |
|
1751 | 1752 | # TODO: only apply format_screen to the plain/text repr of the mime |
|
1752 | 1753 | # bundle. |
|
1753 | 1754 | formatter = format_screen if info.ismagic else docformat |
|
1754 | 1755 | if meth == 'pdoc': |
|
1755 | 1756 | pmethod(info.obj, oname, formatter) |
|
1756 | 1757 | elif meth == 'pinfo': |
|
1757 | 1758 | pmethod(info.obj, oname, formatter, info, |
|
1758 | 1759 | enable_html_pager=self.enable_html_pager, **kw) |
|
1759 | 1760 | else: |
|
1760 | 1761 | pmethod(info.obj, oname) |
|
1761 | 1762 | else: |
|
1762 | 1763 | print('Object `%s` not found.' % oname) |
|
1763 | 1764 | return 'not found' # so callers can take other action |
|
1764 | 1765 | |
|
1765 | 1766 | def object_inspect(self, oname, detail_level=0): |
|
1766 | 1767 | """Get object info about oname""" |
|
1767 | 1768 | with self.builtin_trap: |
|
1768 | 1769 | info = self._object_find(oname) |
|
1769 | 1770 | if info.found: |
|
1770 | 1771 | return self.inspector.info(info.obj, oname, info=info, |
|
1771 | 1772 | detail_level=detail_level |
|
1772 | 1773 | ) |
|
1773 | 1774 | else: |
|
1774 | 1775 | return oinspect.object_info(name=oname, found=False) |
|
1775 | 1776 | |
|
1776 | 1777 | def object_inspect_text(self, oname, detail_level=0): |
|
1777 | 1778 | """Get object info as formatted text""" |
|
1778 | 1779 | return self.object_inspect_mime(oname, detail_level)['text/plain'] |
|
1779 | 1780 | |
|
1780 | 1781 | def object_inspect_mime(self, oname, detail_level=0): |
|
1781 | 1782 | """Get object info as a mimebundle of formatted representations. |
|
1782 | 1783 | |
|
1783 | 1784 | A mimebundle is a dictionary, keyed by mime-type. |
|
1784 | 1785 | It must always have the key `'text/plain'`. |
|
1785 | 1786 | """ |
|
1786 | 1787 | with self.builtin_trap: |
|
1787 | 1788 | info = self._object_find(oname) |
|
1788 | 1789 | if info.found: |
|
1789 | 1790 | return self.inspector._get_info(info.obj, oname, info=info, |
|
1790 | 1791 | detail_level=detail_level |
|
1791 | 1792 | ) |
|
1792 | 1793 | else: |
|
1793 | 1794 | raise KeyError(oname) |
|
1794 | 1795 | |
|
1795 | 1796 | #------------------------------------------------------------------------- |
|
1796 | 1797 | # Things related to history management |
|
1797 | 1798 | #------------------------------------------------------------------------- |
|
1798 | 1799 | |
|
1799 | 1800 | def init_history(self): |
|
1800 | 1801 | """Sets up the command history, and starts regular autosaves.""" |
|
1801 | 1802 | self.history_manager = HistoryManager(shell=self, parent=self) |
|
1802 | 1803 | self.configurables.append(self.history_manager) |
|
1803 | 1804 | |
|
1804 | 1805 | #------------------------------------------------------------------------- |
|
1805 | 1806 | # Things related to exception handling and tracebacks (not debugging) |
|
1806 | 1807 | #------------------------------------------------------------------------- |
|
1807 | 1808 | |
|
1808 | 1809 | debugger_cls = Pdb |
|
1809 | 1810 | |
|
1810 | 1811 | def init_traceback_handlers(self, custom_exceptions): |
|
1811 | 1812 | # Syntax error handler. |
|
1812 | 1813 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self) |
|
1813 | 1814 | |
|
1814 | 1815 | # The interactive one is initialized with an offset, meaning we always |
|
1815 | 1816 | # want to remove the topmost item in the traceback, which is our own |
|
1816 | 1817 | # internal code. Valid modes: ['Plain','Context','Verbose','Minimal'] |
|
1817 | 1818 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1818 | 1819 | color_scheme='NoColor', |
|
1819 | 1820 | tb_offset = 1, |
|
1820 | 1821 | check_cache=check_linecache_ipython, |
|
1821 | 1822 | debugger_cls=self.debugger_cls, parent=self) |
|
1822 | 1823 | |
|
1823 | 1824 | # The instance will store a pointer to the system-wide exception hook, |
|
1824 | 1825 | # so that runtime code (such as magics) can access it. This is because |
|
1825 | 1826 | # during the read-eval loop, it may get temporarily overwritten. |
|
1826 | 1827 | self.sys_excepthook = sys.excepthook |
|
1827 | 1828 | |
|
1828 | 1829 | # and add any custom exception handlers the user may have specified |
|
1829 | 1830 | self.set_custom_exc(*custom_exceptions) |
|
1830 | 1831 | |
|
1831 | 1832 | # Set the exception mode |
|
1832 | 1833 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1833 | 1834 | |
|
1834 | 1835 | def set_custom_exc(self, exc_tuple, handler): |
|
1835 | 1836 | """set_custom_exc(exc_tuple, handler) |
|
1836 | 1837 | |
|
1837 | 1838 | Set a custom exception handler, which will be called if any of the |
|
1838 | 1839 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1839 | 1840 | run_code() method). |
|
1840 | 1841 | |
|
1841 | 1842 | Parameters |
|
1842 | 1843 | ---------- |
|
1843 | 1844 | |
|
1844 | 1845 | exc_tuple : tuple of exception classes |
|
1845 | 1846 | A *tuple* of exception classes, for which to call the defined |
|
1846 | 1847 | handler. It is very important that you use a tuple, and NOT A |
|
1847 | 1848 | LIST here, because of the way Python's except statement works. If |
|
1848 | 1849 | you only want to trap a single exception, use a singleton tuple:: |
|
1849 | 1850 | |
|
1850 | 1851 | exc_tuple == (MyCustomException,) |
|
1851 | 1852 | |
|
1852 | 1853 | handler : callable |
|
1853 | 1854 | handler must have the following signature:: |
|
1854 | 1855 | |
|
1855 | 1856 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1856 | 1857 | ... |
|
1857 | 1858 | return structured_traceback |
|
1858 | 1859 | |
|
1859 | 1860 | Your handler must return a structured traceback (a list of strings), |
|
1860 | 1861 | or None. |
|
1861 | 1862 | |
|
1862 | 1863 | This will be made into an instance method (via types.MethodType) |
|
1863 | 1864 | of IPython itself, and it will be called if any of the exceptions |
|
1864 | 1865 | listed in the exc_tuple are caught. If the handler is None, an |
|
1865 | 1866 | internal basic one is used, which just prints basic info. |
|
1866 | 1867 | |
|
1867 | 1868 | To protect IPython from crashes, if your handler ever raises an |
|
1868 | 1869 | exception or returns an invalid result, it will be immediately |
|
1869 | 1870 | disabled. |
|
1870 | 1871 | |
|
1871 | 1872 | WARNING: by putting in your own exception handler into IPython's main |
|
1872 | 1873 | execution loop, you run a very good chance of nasty crashes. This |
|
1873 | 1874 | facility should only be used if you really know what you are doing.""" |
|
1874 | 1875 | if not isinstance(exc_tuple, tuple): |
|
1875 | 1876 | raise TypeError("The custom exceptions must be given as a tuple.") |
|
1876 | 1877 | |
|
1877 | 1878 | def dummy_handler(self, etype, value, tb, tb_offset=None): |
|
1878 | 1879 | print('*** Simple custom exception handler ***') |
|
1879 | 1880 | print('Exception type :', etype) |
|
1880 | 1881 | print('Exception value:', value) |
|
1881 | 1882 | print('Traceback :', tb) |
|
1882 | 1883 | |
|
1883 | 1884 | def validate_stb(stb): |
|
1884 | 1885 | """validate structured traceback return type |
|
1885 | 1886 | |
|
1886 | 1887 | return type of CustomTB *should* be a list of strings, but allow |
|
1887 | 1888 | single strings or None, which are harmless. |
|
1888 | 1889 | |
|
1889 | 1890 | This function will *always* return a list of strings, |
|
1890 | 1891 | and will raise a TypeError if stb is inappropriate. |
|
1891 | 1892 | """ |
|
1892 | 1893 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1893 | 1894 | if stb is None: |
|
1894 | 1895 | return [] |
|
1895 | 1896 | elif isinstance(stb, str): |
|
1896 | 1897 | return [stb] |
|
1897 | 1898 | elif not isinstance(stb, list): |
|
1898 | 1899 | raise TypeError(msg) |
|
1899 | 1900 | # it's a list |
|
1900 | 1901 | for line in stb: |
|
1901 | 1902 | # check every element |
|
1902 | 1903 | if not isinstance(line, str): |
|
1903 | 1904 | raise TypeError(msg) |
|
1904 | 1905 | return stb |
|
1905 | 1906 | |
|
1906 | 1907 | if handler is None: |
|
1907 | 1908 | wrapped = dummy_handler |
|
1908 | 1909 | else: |
|
1909 | 1910 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1910 | 1911 | """wrap CustomTB handler, to protect IPython from user code |
|
1911 | 1912 | |
|
1912 | 1913 | This makes it harder (but not impossible) for custom exception |
|
1913 | 1914 | handlers to crash IPython. |
|
1914 | 1915 | """ |
|
1915 | 1916 | try: |
|
1916 | 1917 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1917 | 1918 | return validate_stb(stb) |
|
1918 | 1919 | except: |
|
1919 | 1920 | # clear custom handler immediately |
|
1920 | 1921 | self.set_custom_exc((), None) |
|
1921 | 1922 | print("Custom TB Handler failed, unregistering", file=sys.stderr) |
|
1922 | 1923 | # show the exception in handler first |
|
1923 | 1924 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1924 | 1925 | print(self.InteractiveTB.stb2text(stb)) |
|
1925 | 1926 | print("The original exception:") |
|
1926 | 1927 | stb = self.InteractiveTB.structured_traceback( |
|
1927 | 1928 | (etype,value,tb), tb_offset=tb_offset |
|
1928 | 1929 | ) |
|
1929 | 1930 | return stb |
|
1930 | 1931 | |
|
1931 | 1932 | self.CustomTB = types.MethodType(wrapped,self) |
|
1932 | 1933 | self.custom_exceptions = exc_tuple |
|
1933 | 1934 | |
|
1934 | 1935 | def excepthook(self, etype, value, tb): |
|
1935 | 1936 | """One more defense for GUI apps that call sys.excepthook. |
|
1936 | 1937 | |
|
1937 | 1938 | GUI frameworks like wxPython trap exceptions and call |
|
1938 | 1939 | sys.excepthook themselves. I guess this is a feature that |
|
1939 | 1940 | enables them to keep running after exceptions that would |
|
1940 | 1941 | otherwise kill their mainloop. This is a bother for IPython |
|
1941 | 1942 | which excepts to catch all of the program exceptions with a try: |
|
1942 | 1943 | except: statement. |
|
1943 | 1944 | |
|
1944 | 1945 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1945 | 1946 | any app directly invokes sys.excepthook, it will look to the user like |
|
1946 | 1947 | IPython crashed. In order to work around this, we can disable the |
|
1947 | 1948 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1948 | 1949 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1949 | 1950 | call sys.excepthook will generate a regular-looking exception from |
|
1950 | 1951 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1951 | 1952 | crashes. |
|
1952 | 1953 | |
|
1953 | 1954 | This hook should be used sparingly, only in places which are not likely |
|
1954 | 1955 | to be true IPython errors. |
|
1955 | 1956 | """ |
|
1956 | 1957 | self.showtraceback((etype, value, tb), tb_offset=0) |
|
1957 | 1958 | |
|
1958 | 1959 | def _get_exc_info(self, exc_tuple=None): |
|
1959 | 1960 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. |
|
1960 | 1961 | |
|
1961 | 1962 | Ensures sys.last_type,value,traceback hold the exc_info we found, |
|
1962 | 1963 | from whichever source. |
|
1963 | 1964 | |
|
1964 | 1965 | raises ValueError if none of these contain any information |
|
1965 | 1966 | """ |
|
1966 | 1967 | if exc_tuple is None: |
|
1967 | 1968 | etype, value, tb = sys.exc_info() |
|
1968 | 1969 | else: |
|
1969 | 1970 | etype, value, tb = exc_tuple |
|
1970 | 1971 | |
|
1971 | 1972 | if etype is None: |
|
1972 | 1973 | if hasattr(sys, 'last_type'): |
|
1973 | 1974 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1974 | 1975 | sys.last_traceback |
|
1975 | 1976 | |
|
1976 | 1977 | if etype is None: |
|
1977 | 1978 | raise ValueError("No exception to find") |
|
1978 | 1979 | |
|
1979 | 1980 | # Now store the exception info in sys.last_type etc. |
|
1980 | 1981 | # WARNING: these variables are somewhat deprecated and not |
|
1981 | 1982 | # necessarily safe to use in a threaded environment, but tools |
|
1982 | 1983 | # like pdb depend on their existence, so let's set them. If we |
|
1983 | 1984 | # find problems in the field, we'll need to revisit their use. |
|
1984 | 1985 | sys.last_type = etype |
|
1985 | 1986 | sys.last_value = value |
|
1986 | 1987 | sys.last_traceback = tb |
|
1987 | 1988 | |
|
1988 | 1989 | return etype, value, tb |
|
1989 | 1990 | |
|
1990 | 1991 | def show_usage_error(self, exc): |
|
1991 | 1992 | """Show a short message for UsageErrors |
|
1992 | 1993 | |
|
1993 | 1994 | These are special exceptions that shouldn't show a traceback. |
|
1994 | 1995 | """ |
|
1995 | 1996 | print("UsageError: %s" % exc, file=sys.stderr) |
|
1996 | 1997 | |
|
1997 | 1998 | def get_exception_only(self, exc_tuple=None): |
|
1998 | 1999 | """ |
|
1999 | 2000 | Return as a string (ending with a newline) the exception that |
|
2000 | 2001 | just occurred, without any traceback. |
|
2001 | 2002 | """ |
|
2002 | 2003 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
2003 | 2004 | msg = traceback.format_exception_only(etype, value) |
|
2004 | 2005 | return ''.join(msg) |
|
2005 | 2006 | |
|
2006 | 2007 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, |
|
2007 | 2008 | exception_only=False, running_compiled_code=False): |
|
2008 | 2009 | """Display the exception that just occurred. |
|
2009 | 2010 | |
|
2010 | 2011 | If nothing is known about the exception, this is the method which |
|
2011 | 2012 | should be used throughout the code for presenting user tracebacks, |
|
2012 | 2013 | rather than directly invoking the InteractiveTB object. |
|
2013 | 2014 | |
|
2014 | 2015 | A specific showsyntaxerror() also exists, but this method can take |
|
2015 | 2016 | care of calling it if needed, so unless you are explicitly catching a |
|
2016 | 2017 | SyntaxError exception, don't try to analyze the stack manually and |
|
2017 | 2018 | simply call this method.""" |
|
2018 | 2019 | |
|
2019 | 2020 | try: |
|
2020 | 2021 | try: |
|
2021 | 2022 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
2022 | 2023 | except ValueError: |
|
2023 | 2024 | print('No traceback available to show.', file=sys.stderr) |
|
2024 | 2025 | return |
|
2025 | 2026 | |
|
2026 | 2027 | if issubclass(etype, SyntaxError): |
|
2027 | 2028 | # Though this won't be called by syntax errors in the input |
|
2028 | 2029 | # line, there may be SyntaxError cases with imported code. |
|
2029 | 2030 | self.showsyntaxerror(filename, running_compiled_code) |
|
2030 | 2031 | elif etype is UsageError: |
|
2031 | 2032 | self.show_usage_error(value) |
|
2032 | 2033 | else: |
|
2033 | 2034 | if exception_only: |
|
2034 | 2035 | stb = ['An exception has occurred, use %tb to see ' |
|
2035 | 2036 | 'the full traceback.\n'] |
|
2036 | 2037 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
2037 | 2038 | value)) |
|
2038 | 2039 | else: |
|
2039 | 2040 | try: |
|
2040 | 2041 | # Exception classes can customise their traceback - we |
|
2041 | 2042 | # use this in IPython.parallel for exceptions occurring |
|
2042 | 2043 | # in the engines. This should return a list of strings. |
|
2043 | 2044 | stb = value._render_traceback_() |
|
2044 | 2045 | except Exception: |
|
2045 | 2046 | stb = self.InteractiveTB.structured_traceback(etype, |
|
2046 | 2047 | value, tb, tb_offset=tb_offset) |
|
2047 | 2048 | |
|
2048 | 2049 | self._showtraceback(etype, value, stb) |
|
2049 | 2050 | if self.call_pdb: |
|
2050 | 2051 | # drop into debugger |
|
2051 | 2052 | self.debugger(force=True) |
|
2052 | 2053 | return |
|
2053 | 2054 | |
|
2054 | 2055 | # Actually show the traceback |
|
2055 | 2056 | self._showtraceback(etype, value, stb) |
|
2056 | 2057 | |
|
2057 | 2058 | except KeyboardInterrupt: |
|
2058 | 2059 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2059 | 2060 | |
|
2060 | 2061 | def _showtraceback(self, etype, evalue, stb): |
|
2061 | 2062 | """Actually show a traceback. |
|
2062 | 2063 | |
|
2063 | 2064 | Subclasses may override this method to put the traceback on a different |
|
2064 | 2065 | place, like a side channel. |
|
2065 | 2066 | """ |
|
2066 | 2067 | print(self.InteractiveTB.stb2text(stb)) |
|
2067 | 2068 | |
|
2068 | 2069 | def showsyntaxerror(self, filename=None, running_compiled_code=False): |
|
2069 | 2070 | """Display the syntax error that just occurred. |
|
2070 | 2071 | |
|
2071 | 2072 | This doesn't display a stack trace because there isn't one. |
|
2072 | 2073 | |
|
2073 | 2074 | If a filename is given, it is stuffed in the exception instead |
|
2074 | 2075 | of what was there before (because Python's parser always uses |
|
2075 | 2076 | "<string>" when reading from a string). |
|
2076 | 2077 | |
|
2077 | 2078 | If the syntax error occurred when running a compiled code (i.e. running_compile_code=True), |
|
2078 | 2079 | longer stack trace will be displayed. |
|
2079 | 2080 | """ |
|
2080 | 2081 | etype, value, last_traceback = self._get_exc_info() |
|
2081 | 2082 | |
|
2082 | 2083 | if filename and issubclass(etype, SyntaxError): |
|
2083 | 2084 | try: |
|
2084 | 2085 | value.filename = filename |
|
2085 | 2086 | except: |
|
2086 | 2087 | # Not the format we expect; leave it alone |
|
2087 | 2088 | pass |
|
2088 | 2089 | |
|
2089 | 2090 | # If the error occurred when executing compiled code, we should provide full stacktrace. |
|
2090 | 2091 | elist = traceback.extract_tb(last_traceback) if running_compiled_code else [] |
|
2091 | 2092 | stb = self.SyntaxTB.structured_traceback(etype, value, elist) |
|
2092 | 2093 | self._showtraceback(etype, value, stb) |
|
2093 | 2094 | |
|
2094 | 2095 | # This is overridden in TerminalInteractiveShell to show a message about |
|
2095 | 2096 | # the %paste magic. |
|
2096 | 2097 | def showindentationerror(self): |
|
2097 | 2098 | """Called by _run_cell when there's an IndentationError in code entered |
|
2098 | 2099 | at the prompt. |
|
2099 | 2100 | |
|
2100 | 2101 | This is overridden in TerminalInteractiveShell to show a message about |
|
2101 | 2102 | the %paste magic.""" |
|
2102 | 2103 | self.showsyntaxerror() |
|
2103 | 2104 | |
|
2104 | 2105 | #------------------------------------------------------------------------- |
|
2105 | 2106 | # Things related to readline |
|
2106 | 2107 | #------------------------------------------------------------------------- |
|
2107 | 2108 | |
|
2108 | 2109 | def init_readline(self): |
|
2109 | 2110 | """DEPRECATED |
|
2110 | 2111 | |
|
2111 | 2112 | Moved to terminal subclass, here only to simplify the init logic.""" |
|
2112 | 2113 | # Set a number of methods that depend on readline to be no-op |
|
2113 | 2114 | warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated', |
|
2114 | 2115 | DeprecationWarning, stacklevel=2) |
|
2115 | 2116 | self.set_custom_completer = no_op |
|
2116 | 2117 | |
|
2117 | 2118 | @skip_doctest |
|
2118 | 2119 | def set_next_input(self, s, replace=False): |
|
2119 | 2120 | """ Sets the 'default' input string for the next command line. |
|
2120 | 2121 | |
|
2121 | 2122 | Example:: |
|
2122 | 2123 | |
|
2123 | 2124 | In [1]: _ip.set_next_input("Hello Word") |
|
2124 | 2125 | In [2]: Hello Word_ # cursor is here |
|
2125 | 2126 | """ |
|
2126 | 2127 | self.rl_next_input = s |
|
2127 | 2128 | |
|
2128 | 2129 | def _indent_current_str(self): |
|
2129 | 2130 | """return the current level of indentation as a string""" |
|
2130 | 2131 | return self.input_splitter.get_indent_spaces() * ' ' |
|
2131 | 2132 | |
|
2132 | 2133 | #------------------------------------------------------------------------- |
|
2133 | 2134 | # Things related to text completion |
|
2134 | 2135 | #------------------------------------------------------------------------- |
|
2135 | 2136 | |
|
2136 | 2137 | def init_completer(self): |
|
2137 | 2138 | """Initialize the completion machinery. |
|
2138 | 2139 | |
|
2139 | 2140 | This creates completion machinery that can be used by client code, |
|
2140 | 2141 | either interactively in-process (typically triggered by the readline |
|
2141 | 2142 | library), programmatically (such as in test suites) or out-of-process |
|
2142 | 2143 | (typically over the network by remote frontends). |
|
2143 | 2144 | """ |
|
2144 | 2145 | from IPython.core.completer import IPCompleter |
|
2145 | 2146 | from IPython.core.completerlib import (module_completer, |
|
2146 | 2147 | magic_run_completer, cd_completer, reset_completer) |
|
2147 | 2148 | |
|
2148 | 2149 | self.Completer = IPCompleter(shell=self, |
|
2149 | 2150 | namespace=self.user_ns, |
|
2150 | 2151 | global_namespace=self.user_global_ns, |
|
2151 | 2152 | parent=self, |
|
2152 | 2153 | ) |
|
2153 | 2154 | self.configurables.append(self.Completer) |
|
2154 | 2155 | |
|
2155 | 2156 | # Add custom completers to the basic ones built into IPCompleter |
|
2156 | 2157 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
2157 | 2158 | self.strdispatchers['complete_command'] = sdisp |
|
2158 | 2159 | self.Completer.custom_completers = sdisp |
|
2159 | 2160 | |
|
2160 | 2161 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
2161 | 2162 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
2162 | 2163 | self.set_hook('complete_command', module_completer, str_key = '%aimport') |
|
2163 | 2164 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
2164 | 2165 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
2165 | 2166 | self.set_hook('complete_command', reset_completer, str_key = '%reset') |
|
2166 | 2167 | |
|
2167 | 2168 | @skip_doctest |
|
2168 | 2169 | def complete(self, text, line=None, cursor_pos=None): |
|
2169 | 2170 | """Return the completed text and a list of completions. |
|
2170 | 2171 | |
|
2171 | 2172 | Parameters |
|
2172 | 2173 | ---------- |
|
2173 | 2174 | |
|
2174 | 2175 | text : string |
|
2175 | 2176 | A string of text to be completed on. It can be given as empty and |
|
2176 | 2177 | instead a line/position pair are given. In this case, the |
|
2177 | 2178 | completer itself will split the line like readline does. |
|
2178 | 2179 | |
|
2179 | 2180 | line : string, optional |
|
2180 | 2181 | The complete line that text is part of. |
|
2181 | 2182 | |
|
2182 | 2183 | cursor_pos : int, optional |
|
2183 | 2184 | The position of the cursor on the input line. |
|
2184 | 2185 | |
|
2185 | 2186 | Returns |
|
2186 | 2187 | ------- |
|
2187 | 2188 | text : string |
|
2188 | 2189 | The actual text that was completed. |
|
2189 | 2190 | |
|
2190 | 2191 | matches : list |
|
2191 | 2192 | A sorted list with all possible completions. |
|
2192 | 2193 | |
|
2193 | 2194 | The optional arguments allow the completion to take more context into |
|
2194 | 2195 | account, and are part of the low-level completion API. |
|
2195 | 2196 | |
|
2196 | 2197 | This is a wrapper around the completion mechanism, similar to what |
|
2197 | 2198 | readline does at the command line when the TAB key is hit. By |
|
2198 | 2199 | exposing it as a method, it can be used by other non-readline |
|
2199 | 2200 | environments (such as GUIs) for text completion. |
|
2200 | 2201 | |
|
2201 | 2202 | Simple usage example: |
|
2202 | 2203 | |
|
2203 | 2204 | In [1]: x = 'hello' |
|
2204 | 2205 | |
|
2205 | 2206 | In [2]: _ip.complete('x.l') |
|
2206 | 2207 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
2207 | 2208 | """ |
|
2208 | 2209 | |
|
2209 | 2210 | # Inject names into __builtin__ so we can complete on the added names. |
|
2210 | 2211 | with self.builtin_trap: |
|
2211 | 2212 | return self.Completer.complete(text, line, cursor_pos) |
|
2212 | 2213 | |
|
2213 | 2214 | def set_custom_completer(self, completer, pos=0) -> None: |
|
2214 | 2215 | """Adds a new custom completer function. |
|
2215 | 2216 | |
|
2216 | 2217 | The position argument (defaults to 0) is the index in the completers |
|
2217 | 2218 | list where you want the completer to be inserted. |
|
2218 | 2219 | |
|
2219 | 2220 | `completer` should have the following signature:: |
|
2220 | 2221 | |
|
2221 | 2222 | def completion(self: Completer, text: string) -> List[str]: |
|
2222 | 2223 | raise NotImplementedError |
|
2223 | 2224 | |
|
2224 | 2225 | It will be bound to the current Completer instance and pass some text |
|
2225 | 2226 | and return a list with current completions to suggest to the user. |
|
2226 | 2227 | """ |
|
2227 | 2228 | |
|
2228 | 2229 | newcomp = types.MethodType(completer, self.Completer) |
|
2229 | 2230 | self.Completer.custom_matchers.insert(pos,newcomp) |
|
2230 | 2231 | |
|
2231 | 2232 | def set_completer_frame(self, frame=None): |
|
2232 | 2233 | """Set the frame of the completer.""" |
|
2233 | 2234 | if frame: |
|
2234 | 2235 | self.Completer.namespace = frame.f_locals |
|
2235 | 2236 | self.Completer.global_namespace = frame.f_globals |
|
2236 | 2237 | else: |
|
2237 | 2238 | self.Completer.namespace = self.user_ns |
|
2238 | 2239 | self.Completer.global_namespace = self.user_global_ns |
|
2239 | 2240 | |
|
2240 | 2241 | #------------------------------------------------------------------------- |
|
2241 | 2242 | # Things related to magics |
|
2242 | 2243 | #------------------------------------------------------------------------- |
|
2243 | 2244 | |
|
2244 | 2245 | def init_magics(self): |
|
2245 | 2246 | from IPython.core import magics as m |
|
2246 | 2247 | self.magics_manager = magic.MagicsManager(shell=self, |
|
2247 | 2248 | parent=self, |
|
2248 | 2249 | user_magics=m.UserMagics(self)) |
|
2249 | 2250 | self.configurables.append(self.magics_manager) |
|
2250 | 2251 | |
|
2251 | 2252 | # Expose as public API from the magics manager |
|
2252 | 2253 | self.register_magics = self.magics_manager.register |
|
2253 | 2254 | |
|
2254 | 2255 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, |
|
2255 | 2256 | m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics, |
|
2256 | 2257 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, |
|
2257 | 2258 | m.NamespaceMagics, m.OSMagics, m.PackagingMagics, |
|
2258 | 2259 | m.PylabMagics, m.ScriptMagics, |
|
2259 | 2260 | ) |
|
2260 | 2261 | self.register_magics(m.AsyncMagics) |
|
2261 | 2262 | |
|
2262 | 2263 | # Register Magic Aliases |
|
2263 | 2264 | mman = self.magics_manager |
|
2264 | 2265 | # FIXME: magic aliases should be defined by the Magics classes |
|
2265 | 2266 | # or in MagicsManager, not here |
|
2266 | 2267 | mman.register_alias('ed', 'edit') |
|
2267 | 2268 | mman.register_alias('hist', 'history') |
|
2268 | 2269 | mman.register_alias('rep', 'recall') |
|
2269 | 2270 | mman.register_alias('SVG', 'svg', 'cell') |
|
2270 | 2271 | mman.register_alias('HTML', 'html', 'cell') |
|
2271 | 2272 | mman.register_alias('file', 'writefile', 'cell') |
|
2272 | 2273 | |
|
2273 | 2274 | # FIXME: Move the color initialization to the DisplayHook, which |
|
2274 | 2275 | # should be split into a prompt manager and displayhook. We probably |
|
2275 | 2276 | # even need a centralize colors management object. |
|
2276 | 2277 | self.run_line_magic('colors', self.colors) |
|
2277 | 2278 | |
|
2278 | 2279 | # Defined here so that it's included in the documentation |
|
2279 | 2280 | @functools.wraps(magic.MagicsManager.register_function) |
|
2280 | 2281 | def register_magic_function(self, func, magic_kind='line', magic_name=None): |
|
2281 | 2282 | self.magics_manager.register_function(func, |
|
2282 | 2283 | magic_kind=magic_kind, magic_name=magic_name) |
|
2283 | 2284 | |
|
2284 | 2285 | def run_line_magic(self, magic_name, line, _stack_depth=1): |
|
2285 | 2286 | """Execute the given line magic. |
|
2286 | 2287 | |
|
2287 | 2288 | Parameters |
|
2288 | 2289 | ---------- |
|
2289 | 2290 | magic_name : str |
|
2290 | 2291 | Name of the desired magic function, without '%' prefix. |
|
2291 | 2292 | line : str |
|
2292 | 2293 | The rest of the input line as a single string. |
|
2293 | 2294 | _stack_depth : int |
|
2294 | 2295 | If run_line_magic() is called from magic() then _stack_depth=2. |
|
2295 | 2296 | This is added to ensure backward compatibility for use of 'get_ipython().magic()' |
|
2296 | 2297 | """ |
|
2297 | 2298 | fn = self.find_line_magic(magic_name) |
|
2298 | 2299 | if fn is None: |
|
2299 | 2300 | cm = self.find_cell_magic(magic_name) |
|
2300 | 2301 | etpl = "Line magic function `%%%s` not found%s." |
|
2301 | 2302 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' |
|
2302 | 2303 | 'did you mean that instead?)' % magic_name ) |
|
2303 | 2304 | raise UsageError(etpl % (magic_name, extra)) |
|
2304 | 2305 | else: |
|
2305 | 2306 | # Note: this is the distance in the stack to the user's frame. |
|
2306 | 2307 | # This will need to be updated if the internal calling logic gets |
|
2307 | 2308 | # refactored, or else we'll be expanding the wrong variables. |
|
2308 | 2309 | |
|
2309 | 2310 | # Determine stack_depth depending on where run_line_magic() has been called |
|
2310 | 2311 | stack_depth = _stack_depth |
|
2311 | 2312 | if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False): |
|
2312 | 2313 | # magic has opted out of var_expand |
|
2313 | 2314 | magic_arg_s = line |
|
2314 | 2315 | else: |
|
2315 | 2316 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2316 | 2317 | # Put magic args in a list so we can call with f(*a) syntax |
|
2317 | 2318 | args = [magic_arg_s] |
|
2318 | 2319 | kwargs = {} |
|
2319 | 2320 | # Grab local namespace if we need it: |
|
2320 | 2321 | if getattr(fn, "needs_local_scope", False): |
|
2321 | 2322 | kwargs['local_ns'] = self.get_local_scope(stack_depth) |
|
2322 | 2323 | with self.builtin_trap: |
|
2323 | 2324 | result = fn(*args, **kwargs) |
|
2324 | 2325 | return result |
|
2325 | 2326 | |
|
2326 | 2327 | def get_local_scope(self, stack_depth): |
|
2327 | 2328 | """Get local scope at given stack depth. |
|
2328 | 2329 | |
|
2329 | 2330 | Parameters |
|
2330 | 2331 | ---------- |
|
2331 | 2332 | stack_depth : int |
|
2332 | 2333 | Depth relative to calling frame |
|
2333 | 2334 | """ |
|
2334 | 2335 | return sys._getframe(stack_depth + 1).f_locals |
|
2335 | 2336 | |
|
2336 | 2337 | def run_cell_magic(self, magic_name, line, cell): |
|
2337 | 2338 | """Execute the given cell magic. |
|
2338 | 2339 | |
|
2339 | 2340 | Parameters |
|
2340 | 2341 | ---------- |
|
2341 | 2342 | magic_name : str |
|
2342 | 2343 | Name of the desired magic function, without '%' prefix. |
|
2343 | 2344 | line : str |
|
2344 | 2345 | The rest of the first input line as a single string. |
|
2345 | 2346 | cell : str |
|
2346 | 2347 | The body of the cell as a (possibly multiline) string. |
|
2347 | 2348 | """ |
|
2348 | 2349 | fn = self.find_cell_magic(magic_name) |
|
2349 | 2350 | if fn is None: |
|
2350 | 2351 | lm = self.find_line_magic(magic_name) |
|
2351 | 2352 | etpl = "Cell magic `%%{0}` not found{1}." |
|
2352 | 2353 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' |
|
2353 | 2354 | 'did you mean that instead?)'.format(magic_name)) |
|
2354 | 2355 | raise UsageError(etpl.format(magic_name, extra)) |
|
2355 | 2356 | elif cell == '': |
|
2356 | 2357 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) |
|
2357 | 2358 | if self.find_line_magic(magic_name) is not None: |
|
2358 | 2359 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) |
|
2359 | 2360 | raise UsageError(message) |
|
2360 | 2361 | else: |
|
2361 | 2362 | # Note: this is the distance in the stack to the user's frame. |
|
2362 | 2363 | # This will need to be updated if the internal calling logic gets |
|
2363 | 2364 | # refactored, or else we'll be expanding the wrong variables. |
|
2364 | 2365 | stack_depth = 2 |
|
2365 | 2366 | if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False): |
|
2366 | 2367 | # magic has opted out of var_expand |
|
2367 | 2368 | magic_arg_s = line |
|
2368 | 2369 | else: |
|
2369 | 2370 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2370 | 2371 | kwargs = {} |
|
2371 | 2372 | if getattr(fn, "needs_local_scope", False): |
|
2372 | 2373 | kwargs['local_ns'] = self.user_ns |
|
2373 | 2374 | |
|
2374 | 2375 | with self.builtin_trap: |
|
2375 | 2376 | args = (magic_arg_s, cell) |
|
2376 | 2377 | result = fn(*args, **kwargs) |
|
2377 | 2378 | return result |
|
2378 | 2379 | |
|
2379 | 2380 | def find_line_magic(self, magic_name): |
|
2380 | 2381 | """Find and return a line magic by name. |
|
2381 | 2382 | |
|
2382 | 2383 | Returns None if the magic isn't found.""" |
|
2383 | 2384 | return self.magics_manager.magics['line'].get(magic_name) |
|
2384 | 2385 | |
|
2385 | 2386 | def find_cell_magic(self, magic_name): |
|
2386 | 2387 | """Find and return a cell magic by name. |
|
2387 | 2388 | |
|
2388 | 2389 | Returns None if the magic isn't found.""" |
|
2389 | 2390 | return self.magics_manager.magics['cell'].get(magic_name) |
|
2390 | 2391 | |
|
2391 | 2392 | def find_magic(self, magic_name, magic_kind='line'): |
|
2392 | 2393 | """Find and return a magic of the given type by name. |
|
2393 | 2394 | |
|
2394 | 2395 | Returns None if the magic isn't found.""" |
|
2395 | 2396 | return self.magics_manager.magics[magic_kind].get(magic_name) |
|
2396 | 2397 | |
|
2397 | 2398 | def magic(self, arg_s): |
|
2398 | 2399 | """DEPRECATED. Use run_line_magic() instead. |
|
2399 | 2400 | |
|
2400 | 2401 | Call a magic function by name. |
|
2401 | 2402 | |
|
2402 | 2403 | Input: a string containing the name of the magic function to call and |
|
2403 | 2404 | any additional arguments to be passed to the magic. |
|
2404 | 2405 | |
|
2405 | 2406 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
2406 | 2407 | prompt: |
|
2407 | 2408 | |
|
2408 | 2409 | In[1]: %name -opt foo bar |
|
2409 | 2410 | |
|
2410 | 2411 | To call a magic without arguments, simply use magic('name'). |
|
2411 | 2412 | |
|
2412 | 2413 | This provides a proper Python function to call IPython's magics in any |
|
2413 | 2414 | valid Python code you can type at the interpreter, including loops and |
|
2414 | 2415 | compound statements. |
|
2415 | 2416 | """ |
|
2416 | 2417 | # TODO: should we issue a loud deprecation warning here? |
|
2417 | 2418 | magic_name, _, magic_arg_s = arg_s.partition(' ') |
|
2418 | 2419 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
2419 | 2420 | return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2) |
|
2420 | 2421 | |
|
2421 | 2422 | #------------------------------------------------------------------------- |
|
2422 | 2423 | # Things related to macros |
|
2423 | 2424 | #------------------------------------------------------------------------- |
|
2424 | 2425 | |
|
2425 | 2426 | def define_macro(self, name, themacro): |
|
2426 | 2427 | """Define a new macro |
|
2427 | 2428 | |
|
2428 | 2429 | Parameters |
|
2429 | 2430 | ---------- |
|
2430 | 2431 | name : str |
|
2431 | 2432 | The name of the macro. |
|
2432 | 2433 | themacro : str or Macro |
|
2433 | 2434 | The action to do upon invoking the macro. If a string, a new |
|
2434 | 2435 | Macro object is created by passing the string to it. |
|
2435 | 2436 | """ |
|
2436 | 2437 | |
|
2437 | 2438 | from IPython.core import macro |
|
2438 | 2439 | |
|
2439 | 2440 | if isinstance(themacro, str): |
|
2440 | 2441 | themacro = macro.Macro(themacro) |
|
2441 | 2442 | if not isinstance(themacro, macro.Macro): |
|
2442 | 2443 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2443 | 2444 | self.user_ns[name] = themacro |
|
2444 | 2445 | |
|
2445 | 2446 | #------------------------------------------------------------------------- |
|
2446 | 2447 | # Things related to the running of system commands |
|
2447 | 2448 | #------------------------------------------------------------------------- |
|
2448 | 2449 | |
|
2449 | 2450 | def system_piped(self, cmd): |
|
2450 | 2451 | """Call the given cmd in a subprocess, piping stdout/err |
|
2451 | 2452 | |
|
2452 | 2453 | Parameters |
|
2453 | 2454 | ---------- |
|
2454 | 2455 | cmd : str |
|
2455 | 2456 | Command to execute (can not end in '&', as background processes are |
|
2456 | 2457 | not supported. Should not be a command that expects input |
|
2457 | 2458 | other than simple text. |
|
2458 | 2459 | """ |
|
2459 | 2460 | if cmd.rstrip().endswith('&'): |
|
2460 | 2461 | # this is *far* from a rigorous test |
|
2461 | 2462 | # We do not support backgrounding processes because we either use |
|
2462 | 2463 | # pexpect or pipes to read from. Users can always just call |
|
2463 | 2464 | # os.system() or use ip.system=ip.system_raw |
|
2464 | 2465 | # if they really want a background process. |
|
2465 | 2466 | raise OSError("Background processes not supported.") |
|
2466 | 2467 | |
|
2467 | 2468 | # we explicitly do NOT return the subprocess status code, because |
|
2468 | 2469 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2469 | 2470 | # Instead, we store the exit_code in user_ns. |
|
2470 | 2471 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) |
|
2471 | 2472 | |
|
2472 | 2473 | def system_raw(self, cmd): |
|
2473 | 2474 | """Call the given cmd in a subprocess using os.system on Windows or |
|
2474 | 2475 | subprocess.call using the system shell on other platforms. |
|
2475 | 2476 | |
|
2476 | 2477 | Parameters |
|
2477 | 2478 | ---------- |
|
2478 | 2479 | cmd : str |
|
2479 | 2480 | Command to execute. |
|
2480 | 2481 | """ |
|
2481 | 2482 | cmd = self.var_expand(cmd, depth=1) |
|
2482 | 2483 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2483 | 2484 | if sys.platform == 'win32': |
|
2484 | 2485 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2485 | 2486 | with AvoidUNCPath() as path: |
|
2486 | 2487 | if path is not None: |
|
2487 | 2488 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2488 | 2489 | try: |
|
2489 | 2490 | ec = os.system(cmd) |
|
2490 | 2491 | except KeyboardInterrupt: |
|
2491 | 2492 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2492 | 2493 | ec = -2 |
|
2493 | 2494 | else: |
|
2494 | 2495 | # For posix the result of the subprocess.call() below is an exit |
|
2495 | 2496 | # code, which by convention is zero for success, positive for |
|
2496 | 2497 | # program failure. Exit codes above 128 are reserved for signals, |
|
2497 | 2498 | # and the formula for converting a signal to an exit code is usually |
|
2498 | 2499 | # signal_number+128. To more easily differentiate between exit |
|
2499 | 2500 | # codes and signals, ipython uses negative numbers. For instance |
|
2500 | 2501 | # since control-c is signal 2 but exit code 130, ipython's |
|
2501 | 2502 | # _exit_code variable will read -2. Note that some shells like |
|
2502 | 2503 | # csh and fish don't follow sh/bash conventions for exit codes. |
|
2503 | 2504 | executable = os.environ.get('SHELL', None) |
|
2504 | 2505 | try: |
|
2505 | 2506 | # Use env shell instead of default /bin/sh |
|
2506 | 2507 | ec = subprocess.call(cmd, shell=True, executable=executable) |
|
2507 | 2508 | except KeyboardInterrupt: |
|
2508 | 2509 | # intercept control-C; a long traceback is not useful here |
|
2509 | 2510 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2510 | 2511 | ec = 130 |
|
2511 | 2512 | if ec > 128: |
|
2512 | 2513 | ec = -(ec - 128) |
|
2513 | 2514 | |
|
2514 | 2515 | # We explicitly do NOT return the subprocess status code, because |
|
2515 | 2516 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2516 | 2517 | # Instead, we store the exit_code in user_ns. Note the semantics |
|
2517 | 2518 | # of _exit_code: for control-c, _exit_code == -signal.SIGNIT, |
|
2518 | 2519 | # but raising SystemExit(_exit_code) will give status 254! |
|
2519 | 2520 | self.user_ns['_exit_code'] = ec |
|
2520 | 2521 | |
|
2521 | 2522 | # use piped system by default, because it is better behaved |
|
2522 | 2523 | system = system_piped |
|
2523 | 2524 | |
|
2524 | 2525 | def getoutput(self, cmd, split=True, depth=0): |
|
2525 | 2526 | """Get output (possibly including stderr) from a subprocess. |
|
2526 | 2527 | |
|
2527 | 2528 | Parameters |
|
2528 | 2529 | ---------- |
|
2529 | 2530 | cmd : str |
|
2530 | 2531 | Command to execute (can not end in '&', as background processes are |
|
2531 | 2532 | not supported. |
|
2532 | 2533 | split : bool, optional |
|
2533 | 2534 | If True, split the output into an IPython SList. Otherwise, an |
|
2534 | 2535 | IPython LSString is returned. These are objects similar to normal |
|
2535 | 2536 | lists and strings, with a few convenience attributes for easier |
|
2536 | 2537 | manipulation of line-based output. You can use '?' on them for |
|
2537 | 2538 | details. |
|
2538 | 2539 | depth : int, optional |
|
2539 | 2540 | How many frames above the caller are the local variables which should |
|
2540 | 2541 | be expanded in the command string? The default (0) assumes that the |
|
2541 | 2542 | expansion variables are in the stack frame calling this function. |
|
2542 | 2543 | """ |
|
2543 | 2544 | if cmd.rstrip().endswith('&'): |
|
2544 | 2545 | # this is *far* from a rigorous test |
|
2545 | 2546 | raise OSError("Background processes not supported.") |
|
2546 | 2547 | out = getoutput(self.var_expand(cmd, depth=depth+1)) |
|
2547 | 2548 | if split: |
|
2548 | 2549 | out = SList(out.splitlines()) |
|
2549 | 2550 | else: |
|
2550 | 2551 | out = LSString(out) |
|
2551 | 2552 | return out |
|
2552 | 2553 | |
|
2553 | 2554 | #------------------------------------------------------------------------- |
|
2554 | 2555 | # Things related to aliases |
|
2555 | 2556 | #------------------------------------------------------------------------- |
|
2556 | 2557 | |
|
2557 | 2558 | def init_alias(self): |
|
2558 | 2559 | self.alias_manager = AliasManager(shell=self, parent=self) |
|
2559 | 2560 | self.configurables.append(self.alias_manager) |
|
2560 | 2561 | |
|
2561 | 2562 | #------------------------------------------------------------------------- |
|
2562 | 2563 | # Things related to extensions |
|
2563 | 2564 | #------------------------------------------------------------------------- |
|
2564 | 2565 | |
|
2565 | 2566 | def init_extension_manager(self): |
|
2566 | 2567 | self.extension_manager = ExtensionManager(shell=self, parent=self) |
|
2567 | 2568 | self.configurables.append(self.extension_manager) |
|
2568 | 2569 | |
|
2569 | 2570 | #------------------------------------------------------------------------- |
|
2570 | 2571 | # Things related to payloads |
|
2571 | 2572 | #------------------------------------------------------------------------- |
|
2572 | 2573 | |
|
2573 | 2574 | def init_payload(self): |
|
2574 | 2575 | self.payload_manager = PayloadManager(parent=self) |
|
2575 | 2576 | self.configurables.append(self.payload_manager) |
|
2576 | 2577 | |
|
2577 | 2578 | #------------------------------------------------------------------------- |
|
2578 | 2579 | # Things related to the prefilter |
|
2579 | 2580 | #------------------------------------------------------------------------- |
|
2580 | 2581 | |
|
2581 | 2582 | def init_prefilter(self): |
|
2582 | 2583 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) |
|
2583 | 2584 | self.configurables.append(self.prefilter_manager) |
|
2584 | 2585 | # Ultimately this will be refactored in the new interpreter code, but |
|
2585 | 2586 | # for now, we should expose the main prefilter method (there's legacy |
|
2586 | 2587 | # code out there that may rely on this). |
|
2587 | 2588 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2588 | 2589 | |
|
2589 | 2590 | def auto_rewrite_input(self, cmd): |
|
2590 | 2591 | """Print to the screen the rewritten form of the user's command. |
|
2591 | 2592 | |
|
2592 | 2593 | This shows visual feedback by rewriting input lines that cause |
|
2593 | 2594 | automatic calling to kick in, like:: |
|
2594 | 2595 | |
|
2595 | 2596 | /f x |
|
2596 | 2597 | |
|
2597 | 2598 | into:: |
|
2598 | 2599 | |
|
2599 | 2600 | ------> f(x) |
|
2600 | 2601 | |
|
2601 | 2602 | after the user's input prompt. This helps the user understand that the |
|
2602 | 2603 | input line was transformed automatically by IPython. |
|
2603 | 2604 | """ |
|
2604 | 2605 | if not self.show_rewritten_input: |
|
2605 | 2606 | return |
|
2606 | 2607 | |
|
2607 | 2608 | # This is overridden in TerminalInteractiveShell to use fancy prompts |
|
2608 | 2609 | print("------> " + cmd) |
|
2609 | 2610 | |
|
2610 | 2611 | #------------------------------------------------------------------------- |
|
2611 | 2612 | # Things related to extracting values/expressions from kernel and user_ns |
|
2612 | 2613 | #------------------------------------------------------------------------- |
|
2613 | 2614 | |
|
2614 | 2615 | def _user_obj_error(self): |
|
2615 | 2616 | """return simple exception dict |
|
2616 | 2617 | |
|
2617 | 2618 | for use in user_expressions |
|
2618 | 2619 | """ |
|
2619 | 2620 | |
|
2620 | 2621 | etype, evalue, tb = self._get_exc_info() |
|
2621 | 2622 | stb = self.InteractiveTB.get_exception_only(etype, evalue) |
|
2622 | 2623 | |
|
2623 | 2624 | exc_info = { |
|
2624 | 2625 | u'status' : 'error', |
|
2625 | 2626 | u'traceback' : stb, |
|
2626 | 2627 | u'ename' : etype.__name__, |
|
2627 | 2628 | u'evalue' : py3compat.safe_unicode(evalue), |
|
2628 | 2629 | } |
|
2629 | 2630 | |
|
2630 | 2631 | return exc_info |
|
2631 | 2632 | |
|
2632 | 2633 | def _format_user_obj(self, obj): |
|
2633 | 2634 | """format a user object to display dict |
|
2634 | 2635 | |
|
2635 | 2636 | for use in user_expressions |
|
2636 | 2637 | """ |
|
2637 | 2638 | |
|
2638 | 2639 | data, md = self.display_formatter.format(obj) |
|
2639 | 2640 | value = { |
|
2640 | 2641 | 'status' : 'ok', |
|
2641 | 2642 | 'data' : data, |
|
2642 | 2643 | 'metadata' : md, |
|
2643 | 2644 | } |
|
2644 | 2645 | return value |
|
2645 | 2646 | |
|
2646 | 2647 | def user_expressions(self, expressions): |
|
2647 | 2648 | """Evaluate a dict of expressions in the user's namespace. |
|
2648 | 2649 | |
|
2649 | 2650 | Parameters |
|
2650 | 2651 | ---------- |
|
2651 | 2652 | expressions : dict |
|
2652 | 2653 | A dict with string keys and string values. The expression values |
|
2653 | 2654 | should be valid Python expressions, each of which will be evaluated |
|
2654 | 2655 | in the user namespace. |
|
2655 | 2656 | |
|
2656 | 2657 | Returns |
|
2657 | 2658 | ------- |
|
2658 | 2659 | A dict, keyed like the input expressions dict, with the rich mime-typed |
|
2659 | 2660 | display_data of each value. |
|
2660 | 2661 | """ |
|
2661 | 2662 | out = {} |
|
2662 | 2663 | user_ns = self.user_ns |
|
2663 | 2664 | global_ns = self.user_global_ns |
|
2664 | 2665 | |
|
2665 | 2666 | for key, expr in expressions.items(): |
|
2666 | 2667 | try: |
|
2667 | 2668 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) |
|
2668 | 2669 | except: |
|
2669 | 2670 | value = self._user_obj_error() |
|
2670 | 2671 | out[key] = value |
|
2671 | 2672 | return out |
|
2672 | 2673 | |
|
2673 | 2674 | #------------------------------------------------------------------------- |
|
2674 | 2675 | # Things related to the running of code |
|
2675 | 2676 | #------------------------------------------------------------------------- |
|
2676 | 2677 | |
|
2677 | 2678 | def ex(self, cmd): |
|
2678 | 2679 | """Execute a normal python statement in user namespace.""" |
|
2679 | 2680 | with self.builtin_trap: |
|
2680 | 2681 | exec(cmd, self.user_global_ns, self.user_ns) |
|
2681 | 2682 | |
|
2682 | 2683 | def ev(self, expr): |
|
2683 | 2684 | """Evaluate python expression expr in user namespace. |
|
2684 | 2685 | |
|
2685 | 2686 | Returns the result of evaluation |
|
2686 | 2687 | """ |
|
2687 | 2688 | with self.builtin_trap: |
|
2688 | 2689 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2689 | 2690 | |
|
2690 | 2691 | def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False): |
|
2691 | 2692 | """A safe version of the builtin execfile(). |
|
2692 | 2693 | |
|
2693 | 2694 | This version will never throw an exception, but instead print |
|
2694 | 2695 | helpful error messages to the screen. This only works on pure |
|
2695 | 2696 | Python files with the .py extension. |
|
2696 | 2697 | |
|
2697 | 2698 | Parameters |
|
2698 | 2699 | ---------- |
|
2699 | 2700 | fname : string |
|
2700 | 2701 | The name of the file to be executed. |
|
2701 | 2702 | where : tuple |
|
2702 | 2703 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2703 | 2704 | If only one is given, it is passed as both. |
|
2704 | 2705 | exit_ignore : bool (False) |
|
2705 | 2706 | If True, then silence SystemExit for non-zero status (it is always |
|
2706 | 2707 | silenced for zero status, as it is so common). |
|
2707 | 2708 | raise_exceptions : bool (False) |
|
2708 | 2709 | If True raise exceptions everywhere. Meant for testing. |
|
2709 | 2710 | shell_futures : bool (False) |
|
2710 | 2711 | If True, the code will share future statements with the interactive |
|
2711 | 2712 | shell. It will both be affected by previous __future__ imports, and |
|
2712 | 2713 | any __future__ imports in the code will affect the shell. If False, |
|
2713 | 2714 | __future__ imports are not shared in either direction. |
|
2714 | 2715 | |
|
2715 | 2716 | """ |
|
2716 | 2717 | fname = Path(fname).expanduser().resolve() |
|
2717 | 2718 | |
|
2718 | 2719 | # Make sure we can open the file |
|
2719 | 2720 | try: |
|
2720 | 2721 | with fname.open(): |
|
2721 | 2722 | pass |
|
2722 | 2723 | except: |
|
2723 | 2724 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2724 | 2725 | return |
|
2725 | 2726 | |
|
2726 | 2727 | # Find things also in current directory. This is needed to mimic the |
|
2727 | 2728 | # behavior of running a script from the system command line, where |
|
2728 | 2729 | # Python inserts the script's directory into sys.path |
|
2729 | 2730 | dname = str(fname.parent) |
|
2730 | 2731 | |
|
2731 | 2732 | with prepended_to_syspath(dname), self.builtin_trap: |
|
2732 | 2733 | try: |
|
2733 | 2734 | glob, loc = (where + (None, ))[:2] |
|
2734 | 2735 | py3compat.execfile( |
|
2735 | 2736 | fname, glob, loc, |
|
2736 | 2737 | self.compile if shell_futures else None) |
|
2737 | 2738 | except SystemExit as status: |
|
2738 | 2739 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2739 | 2740 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2740 | 2741 | # these are considered normal by the OS: |
|
2741 | 2742 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2742 | 2743 | # 0 |
|
2743 | 2744 | # > python -c'import sys;sys.exit()'; echo $? |
|
2744 | 2745 | # 0 |
|
2745 | 2746 | # For other exit status, we show the exception unless |
|
2746 | 2747 | # explicitly silenced, but only in short form. |
|
2747 | 2748 | if status.code: |
|
2748 | 2749 | if raise_exceptions: |
|
2749 | 2750 | raise |
|
2750 | 2751 | if not exit_ignore: |
|
2751 | 2752 | self.showtraceback(exception_only=True) |
|
2752 | 2753 | except: |
|
2753 | 2754 | if raise_exceptions: |
|
2754 | 2755 | raise |
|
2755 | 2756 | # tb offset is 2 because we wrap execfile |
|
2756 | 2757 | self.showtraceback(tb_offset=2) |
|
2757 | 2758 | |
|
2758 | 2759 | def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False): |
|
2759 | 2760 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. |
|
2760 | 2761 | |
|
2761 | 2762 | Parameters |
|
2762 | 2763 | ---------- |
|
2763 | 2764 | fname : str |
|
2764 | 2765 | The name of the file to execute. The filename must have a |
|
2765 | 2766 | .ipy or .ipynb extension. |
|
2766 | 2767 | shell_futures : bool (False) |
|
2767 | 2768 | If True, the code will share future statements with the interactive |
|
2768 | 2769 | shell. It will both be affected by previous __future__ imports, and |
|
2769 | 2770 | any __future__ imports in the code will affect the shell. If False, |
|
2770 | 2771 | __future__ imports are not shared in either direction. |
|
2771 | 2772 | raise_exceptions : bool (False) |
|
2772 | 2773 | If True raise exceptions everywhere. Meant for testing. |
|
2773 | 2774 | """ |
|
2774 | 2775 | fname = Path(fname).expanduser().resolve() |
|
2775 | 2776 | |
|
2776 | 2777 | # Make sure we can open the file |
|
2777 | 2778 | try: |
|
2778 | 2779 | with fname.open(): |
|
2779 | 2780 | pass |
|
2780 | 2781 | except: |
|
2781 | 2782 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2782 | 2783 | return |
|
2783 | 2784 | |
|
2784 | 2785 | # Find things also in current directory. This is needed to mimic the |
|
2785 | 2786 | # behavior of running a script from the system command line, where |
|
2786 | 2787 | # Python inserts the script's directory into sys.path |
|
2787 | 2788 | dname = str(fname.parent) |
|
2788 | 2789 | |
|
2789 | 2790 | def get_cells(): |
|
2790 | 2791 | """generator for sequence of code blocks to run""" |
|
2791 | 2792 | if fname.suffix == ".ipynb": |
|
2792 | 2793 | from nbformat import read |
|
2793 | 2794 | nb = read(fname, as_version=4) |
|
2794 | 2795 | if not nb.cells: |
|
2795 | 2796 | return |
|
2796 | 2797 | for cell in nb.cells: |
|
2797 | 2798 | if cell.cell_type == 'code': |
|
2798 | 2799 | yield cell.source |
|
2799 | 2800 | else: |
|
2800 | 2801 | yield fname.read_text() |
|
2801 | 2802 | |
|
2802 | 2803 | with prepended_to_syspath(dname): |
|
2803 | 2804 | try: |
|
2804 | 2805 | for cell in get_cells(): |
|
2805 | 2806 | result = self.run_cell(cell, silent=True, shell_futures=shell_futures) |
|
2806 | 2807 | if raise_exceptions: |
|
2807 | 2808 | result.raise_error() |
|
2808 | 2809 | elif not result.success: |
|
2809 | 2810 | break |
|
2810 | 2811 | except: |
|
2811 | 2812 | if raise_exceptions: |
|
2812 | 2813 | raise |
|
2813 | 2814 | self.showtraceback() |
|
2814 | 2815 | warn('Unknown failure executing file: <%s>' % fname) |
|
2815 | 2816 | |
|
2816 | 2817 | def safe_run_module(self, mod_name, where): |
|
2817 | 2818 | """A safe version of runpy.run_module(). |
|
2818 | 2819 | |
|
2819 | 2820 | This version will never throw an exception, but instead print |
|
2820 | 2821 | helpful error messages to the screen. |
|
2821 | 2822 | |
|
2822 | 2823 | `SystemExit` exceptions with status code 0 or None are ignored. |
|
2823 | 2824 | |
|
2824 | 2825 | Parameters |
|
2825 | 2826 | ---------- |
|
2826 | 2827 | mod_name : string |
|
2827 | 2828 | The name of the module to be executed. |
|
2828 | 2829 | where : dict |
|
2829 | 2830 | The globals namespace. |
|
2830 | 2831 | """ |
|
2831 | 2832 | try: |
|
2832 | 2833 | try: |
|
2833 | 2834 | where.update( |
|
2834 | 2835 | runpy.run_module(str(mod_name), run_name="__main__", |
|
2835 | 2836 | alter_sys=True) |
|
2836 | 2837 | ) |
|
2837 | 2838 | except SystemExit as status: |
|
2838 | 2839 | if status.code: |
|
2839 | 2840 | raise |
|
2840 | 2841 | except: |
|
2841 | 2842 | self.showtraceback() |
|
2842 | 2843 | warn('Unknown failure executing module: <%s>' % mod_name) |
|
2843 | 2844 | |
|
2844 | 2845 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): |
|
2845 | 2846 | """Run a complete IPython cell. |
|
2846 | 2847 | |
|
2847 | 2848 | Parameters |
|
2848 | 2849 | ---------- |
|
2849 | 2850 | raw_cell : str |
|
2850 | 2851 | The code (including IPython code such as %magic functions) to run. |
|
2851 | 2852 | store_history : bool |
|
2852 | 2853 | If True, the raw and translated cell will be stored in IPython's |
|
2853 | 2854 | history. For user code calling back into IPython's machinery, this |
|
2854 | 2855 | should be set to False. |
|
2855 | 2856 | silent : bool |
|
2856 | 2857 | If True, avoid side-effects, such as implicit displayhooks and |
|
2857 | 2858 | and logging. silent=True forces store_history=False. |
|
2858 | 2859 | shell_futures : bool |
|
2859 | 2860 | If True, the code will share future statements with the interactive |
|
2860 | 2861 | shell. It will both be affected by previous __future__ imports, and |
|
2861 | 2862 | any __future__ imports in the code will affect the shell. If False, |
|
2862 | 2863 | __future__ imports are not shared in either direction. |
|
2863 | 2864 | |
|
2864 | 2865 | Returns |
|
2865 | 2866 | ------- |
|
2866 | 2867 | result : :class:`ExecutionResult` |
|
2867 | 2868 | """ |
|
2868 | 2869 | result = None |
|
2869 | 2870 | try: |
|
2870 | 2871 | result = self._run_cell( |
|
2871 | 2872 | raw_cell, store_history, silent, shell_futures) |
|
2872 | 2873 | finally: |
|
2873 | 2874 | self.events.trigger('post_execute') |
|
2874 | 2875 | if not silent: |
|
2875 | 2876 | self.events.trigger('post_run_cell', result) |
|
2876 | 2877 | return result |
|
2877 | 2878 | |
|
2878 | 2879 | def _run_cell(self, raw_cell:str, store_history:bool, silent:bool, shell_futures:bool) -> ExecutionResult: |
|
2879 | 2880 | """Internal method to run a complete IPython cell.""" |
|
2880 | 2881 | |
|
2881 | 2882 | # we need to avoid calling self.transform_cell multiple time on the same thing |
|
2882 | 2883 | # so we need to store some results: |
|
2883 | 2884 | preprocessing_exc_tuple = None |
|
2884 | 2885 | try: |
|
2885 | 2886 | transformed_cell = self.transform_cell(raw_cell) |
|
2886 | 2887 | except Exception: |
|
2887 | 2888 | transformed_cell = raw_cell |
|
2888 | 2889 | preprocessing_exc_tuple = sys.exc_info() |
|
2889 | 2890 | |
|
2890 | 2891 | assert transformed_cell is not None |
|
2891 | 2892 | coro = self.run_cell_async( |
|
2892 | 2893 | raw_cell, |
|
2893 | 2894 | store_history=store_history, |
|
2894 | 2895 | silent=silent, |
|
2895 | 2896 | shell_futures=shell_futures, |
|
2896 | 2897 | transformed_cell=transformed_cell, |
|
2897 | 2898 | preprocessing_exc_tuple=preprocessing_exc_tuple, |
|
2898 | 2899 | ) |
|
2899 | 2900 | |
|
2900 | 2901 | # run_cell_async is async, but may not actually need an eventloop. |
|
2901 | 2902 | # when this is the case, we want to run it using the pseudo_sync_runner |
|
2902 | 2903 | # so that code can invoke eventloops (for example via the %run , and |
|
2903 | 2904 | # `%paste` magic. |
|
2904 | 2905 | if self.trio_runner: |
|
2905 | 2906 | runner = self.trio_runner |
|
2906 | 2907 | elif self.should_run_async( |
|
2907 | 2908 | raw_cell, |
|
2908 | 2909 | transformed_cell=transformed_cell, |
|
2909 | 2910 | preprocessing_exc_tuple=preprocessing_exc_tuple, |
|
2910 | 2911 | ): |
|
2911 | 2912 | runner = self.loop_runner |
|
2912 | 2913 | else: |
|
2913 | 2914 | runner = _pseudo_sync_runner |
|
2914 | 2915 | |
|
2915 | 2916 | try: |
|
2916 | 2917 | return runner(coro) |
|
2917 | 2918 | except BaseException as e: |
|
2918 | 2919 | info = ExecutionInfo(raw_cell, store_history, silent, shell_futures) |
|
2919 | 2920 | result = ExecutionResult(info) |
|
2920 | 2921 | result.error_in_exec = e |
|
2921 | 2922 | self.showtraceback(running_compiled_code=True) |
|
2922 | 2923 | return result |
|
2923 | 2924 | |
|
2924 | 2925 | def should_run_async( |
|
2925 | 2926 | self, raw_cell: str, *, transformed_cell=None, preprocessing_exc_tuple=None |
|
2926 | 2927 | ) -> bool: |
|
2927 | 2928 | """Return whether a cell should be run asynchronously via a coroutine runner |
|
2928 | 2929 | |
|
2929 | 2930 | Parameters |
|
2930 | 2931 | ---------- |
|
2931 | 2932 | raw_cell: str |
|
2932 | 2933 | The code to be executed |
|
2933 | 2934 | |
|
2934 | 2935 | Returns |
|
2935 | 2936 | ------- |
|
2936 | 2937 | result: bool |
|
2937 | 2938 | Whether the code needs to be run with a coroutine runner or not |
|
2938 | 2939 | |
|
2939 | 2940 | .. versionadded: 7.0 |
|
2940 | 2941 | """ |
|
2941 | 2942 | if not self.autoawait: |
|
2942 | 2943 | return False |
|
2943 | 2944 | if preprocessing_exc_tuple is not None: |
|
2944 | 2945 | return False |
|
2945 | 2946 | assert preprocessing_exc_tuple is None |
|
2946 | 2947 | if transformed_cell is None: |
|
2947 | 2948 | warnings.warn( |
|
2948 | 2949 | "`should_run_async` will not call `transform_cell`" |
|
2949 | 2950 | " automatically in the future. Please pass the result to" |
|
2950 | 2951 | " `transformed_cell` argument and any exception that happen" |
|
2951 | 2952 | " during the" |
|
2952 | 2953 | "transform in `preprocessing_exc_tuple` in" |
|
2953 | 2954 | " IPython 7.17 and above.", |
|
2954 | 2955 | DeprecationWarning, |
|
2955 | 2956 | stacklevel=2, |
|
2956 | 2957 | ) |
|
2957 | 2958 | try: |
|
2958 | 2959 | cell = self.transform_cell(raw_cell) |
|
2959 | 2960 | except Exception: |
|
2960 | 2961 | # any exception during transform will be raised |
|
2961 | 2962 | # prior to execution |
|
2962 | 2963 | return False |
|
2963 | 2964 | else: |
|
2964 | 2965 | cell = transformed_cell |
|
2965 | 2966 | return _should_be_async(cell) |
|
2966 | 2967 | |
|
2967 | 2968 | async def run_cell_async( |
|
2968 | 2969 | self, |
|
2969 | 2970 | raw_cell: str, |
|
2970 | 2971 | store_history=False, |
|
2971 | 2972 | silent=False, |
|
2972 | 2973 | shell_futures=True, |
|
2973 | 2974 | *, |
|
2974 | 2975 | transformed_cell: Optional[str] = None, |
|
2975 | 2976 | preprocessing_exc_tuple: Optional[Any] = None |
|
2976 | 2977 | ) -> ExecutionResult: |
|
2977 | 2978 | """Run a complete IPython cell asynchronously. |
|
2978 | 2979 | |
|
2979 | 2980 | Parameters |
|
2980 | 2981 | ---------- |
|
2981 | 2982 | raw_cell : str |
|
2982 | 2983 | The code (including IPython code such as %magic functions) to run. |
|
2983 | 2984 | store_history : bool |
|
2984 | 2985 | If True, the raw and translated cell will be stored in IPython's |
|
2985 | 2986 | history. For user code calling back into IPython's machinery, this |
|
2986 | 2987 | should be set to False. |
|
2987 | 2988 | silent : bool |
|
2988 | 2989 | If True, avoid side-effects, such as implicit displayhooks and |
|
2989 | 2990 | and logging. silent=True forces store_history=False. |
|
2990 | 2991 | shell_futures : bool |
|
2991 | 2992 | If True, the code will share future statements with the interactive |
|
2992 | 2993 | shell. It will both be affected by previous __future__ imports, and |
|
2993 | 2994 | any __future__ imports in the code will affect the shell. If False, |
|
2994 | 2995 | __future__ imports are not shared in either direction. |
|
2995 | 2996 | transformed_cell: str |
|
2996 | 2997 | cell that was passed through transformers |
|
2997 | 2998 | preprocessing_exc_tuple: |
|
2998 | 2999 | trace if the transformation failed. |
|
2999 | 3000 | |
|
3000 | 3001 | Returns |
|
3001 | 3002 | ------- |
|
3002 | 3003 | result : :class:`ExecutionResult` |
|
3003 | 3004 | |
|
3004 | 3005 | .. versionadded: 7.0 |
|
3005 | 3006 | """ |
|
3006 | 3007 | info = ExecutionInfo( |
|
3007 | 3008 | raw_cell, store_history, silent, shell_futures) |
|
3008 | 3009 | result = ExecutionResult(info) |
|
3009 | 3010 | |
|
3010 | 3011 | if (not raw_cell) or raw_cell.isspace(): |
|
3011 | 3012 | self.last_execution_succeeded = True |
|
3012 | 3013 | self.last_execution_result = result |
|
3013 | 3014 | return result |
|
3014 | 3015 | |
|
3015 | 3016 | if silent: |
|
3016 | 3017 | store_history = False |
|
3017 | 3018 | |
|
3018 | 3019 | if store_history: |
|
3019 | 3020 | result.execution_count = self.execution_count |
|
3020 | 3021 | |
|
3021 | 3022 | def error_before_exec(value): |
|
3022 | 3023 | if store_history: |
|
3023 | 3024 | self.execution_count += 1 |
|
3024 | 3025 | result.error_before_exec = value |
|
3025 | 3026 | self.last_execution_succeeded = False |
|
3026 | 3027 | self.last_execution_result = result |
|
3027 | 3028 | return result |
|
3028 | 3029 | |
|
3029 | 3030 | self.events.trigger('pre_execute') |
|
3030 | 3031 | if not silent: |
|
3031 | 3032 | self.events.trigger('pre_run_cell', info) |
|
3032 | 3033 | |
|
3033 | 3034 | if transformed_cell is None: |
|
3034 | 3035 | warnings.warn( |
|
3035 | 3036 | "`run_cell_async` will not call `transform_cell`" |
|
3036 | 3037 | " automatically in the future. Please pass the result to" |
|
3037 | 3038 | " `transformed_cell` argument and any exception that happen" |
|
3038 | 3039 | " during the" |
|
3039 | 3040 | "transform in `preprocessing_exc_tuple` in" |
|
3040 | 3041 | " IPython 7.17 and above.", |
|
3041 | 3042 | DeprecationWarning, |
|
3042 | 3043 | stacklevel=2, |
|
3043 | 3044 | ) |
|
3044 | 3045 | # If any of our input transformation (input_transformer_manager or |
|
3045 | 3046 | # prefilter_manager) raises an exception, we store it in this variable |
|
3046 | 3047 | # so that we can display the error after logging the input and storing |
|
3047 | 3048 | # it in the history. |
|
3048 | 3049 | try: |
|
3049 | 3050 | cell = self.transform_cell(raw_cell) |
|
3050 | 3051 | except Exception: |
|
3051 | 3052 | preprocessing_exc_tuple = sys.exc_info() |
|
3052 | 3053 | cell = raw_cell # cell has to exist so it can be stored/logged |
|
3053 | 3054 | else: |
|
3054 | 3055 | preprocessing_exc_tuple = None |
|
3055 | 3056 | else: |
|
3056 | 3057 | if preprocessing_exc_tuple is None: |
|
3057 | 3058 | cell = transformed_cell |
|
3058 | 3059 | else: |
|
3059 | 3060 | cell = raw_cell |
|
3060 | 3061 | |
|
3061 | 3062 | # Store raw and processed history |
|
3062 | 3063 | if store_history: |
|
3063 | 3064 | self.history_manager.store_inputs(self.execution_count, |
|
3064 | 3065 | cell, raw_cell) |
|
3065 | 3066 | if not silent: |
|
3066 | 3067 | self.logger.log(cell, raw_cell) |
|
3067 | 3068 | |
|
3068 | 3069 | # Display the exception if input processing failed. |
|
3069 | 3070 | if preprocessing_exc_tuple is not None: |
|
3070 | 3071 | self.showtraceback(preprocessing_exc_tuple) |
|
3071 | 3072 | if store_history: |
|
3072 | 3073 | self.execution_count += 1 |
|
3073 | 3074 | return error_before_exec(preprocessing_exc_tuple[1]) |
|
3074 | 3075 | |
|
3075 | 3076 | # Our own compiler remembers the __future__ environment. If we want to |
|
3076 | 3077 | # run code with a separate __future__ environment, use the default |
|
3077 | 3078 | # compiler |
|
3078 | 3079 | compiler = self.compile if shell_futures else CachingCompiler() |
|
3079 | 3080 | |
|
3080 | 3081 | _run_async = False |
|
3081 | 3082 | |
|
3082 | 3083 | with self.builtin_trap: |
|
3083 | 3084 | cell_name = self.compile.cache(cell, self.execution_count) |
|
3084 | 3085 | |
|
3085 | 3086 | with self.display_trap: |
|
3086 | 3087 | # Compile to bytecode |
|
3087 | 3088 | try: |
|
3088 | 3089 | if sys.version_info < (3,8) and self.autoawait: |
|
3089 | 3090 | if _should_be_async(cell): |
|
3090 | 3091 | # the code AST below will not be user code: we wrap it |
|
3091 | 3092 | # in an `async def`. This will likely make some AST |
|
3092 | 3093 | # transformer below miss some transform opportunity and |
|
3093 | 3094 | # introduce a small coupling to run_code (in which we |
|
3094 | 3095 | # bake some assumptions of what _ast_asyncify returns. |
|
3095 | 3096 | # they are ways around (like grafting part of the ast |
|
3096 | 3097 | # later: |
|
3097 | 3098 | # - Here, return code_ast.body[0].body[1:-1], as well |
|
3098 | 3099 | # as last expression in return statement which is |
|
3099 | 3100 | # the user code part. |
|
3100 | 3101 | # - Let it go through the AST transformers, and graft |
|
3101 | 3102 | # - it back after the AST transform |
|
3102 | 3103 | # But that seem unreasonable, at least while we |
|
3103 | 3104 | # do not need it. |
|
3104 | 3105 | code_ast = _ast_asyncify(cell, 'async-def-wrapper') |
|
3105 | 3106 | _run_async = True |
|
3106 | 3107 | else: |
|
3107 | 3108 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
3108 | 3109 | else: |
|
3109 | 3110 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
3110 | 3111 | except self.custom_exceptions as e: |
|
3111 | 3112 | etype, value, tb = sys.exc_info() |
|
3112 | 3113 | self.CustomTB(etype, value, tb) |
|
3113 | 3114 | return error_before_exec(e) |
|
3114 | 3115 | except IndentationError as e: |
|
3115 | 3116 | self.showindentationerror() |
|
3116 | 3117 | return error_before_exec(e) |
|
3117 | 3118 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
3118 | 3119 | MemoryError) as e: |
|
3119 | 3120 | self.showsyntaxerror() |
|
3120 | 3121 | return error_before_exec(e) |
|
3121 | 3122 | |
|
3122 | 3123 | # Apply AST transformations |
|
3123 | 3124 | try: |
|
3124 | 3125 | code_ast = self.transform_ast(code_ast) |
|
3125 | 3126 | except InputRejected as e: |
|
3126 | 3127 | self.showtraceback() |
|
3127 | 3128 | return error_before_exec(e) |
|
3128 | 3129 | |
|
3129 | 3130 | # Give the displayhook a reference to our ExecutionResult so it |
|
3130 | 3131 | # can fill in the output value. |
|
3131 | 3132 | self.displayhook.exec_result = result |
|
3132 | 3133 | |
|
3133 | 3134 | # Execute the user code |
|
3134 | 3135 | interactivity = "none" if silent else self.ast_node_interactivity |
|
3135 | 3136 | if _run_async: |
|
3136 | 3137 | interactivity = 'async' |
|
3137 | 3138 | |
|
3138 | 3139 | has_raised = await self.run_ast_nodes(code_ast.body, cell_name, |
|
3139 | 3140 | interactivity=interactivity, compiler=compiler, result=result) |
|
3140 | 3141 | |
|
3141 | 3142 | self.last_execution_succeeded = not has_raised |
|
3142 | 3143 | self.last_execution_result = result |
|
3143 | 3144 | |
|
3144 | 3145 | # Reset this so later displayed values do not modify the |
|
3145 | 3146 | # ExecutionResult |
|
3146 | 3147 | self.displayhook.exec_result = None |
|
3147 | 3148 | |
|
3148 | 3149 | if store_history: |
|
3149 | 3150 | # Write output to the database. Does nothing unless |
|
3150 | 3151 | # history output logging is enabled. |
|
3151 | 3152 | self.history_manager.store_output(self.execution_count) |
|
3152 | 3153 | # Each cell is a *single* input, regardless of how many lines it has |
|
3153 | 3154 | self.execution_count += 1 |
|
3154 | 3155 | |
|
3155 | 3156 | return result |
|
3156 | 3157 | |
|
3157 | 3158 | def transform_cell(self, raw_cell): |
|
3158 | 3159 | """Transform an input cell before parsing it. |
|
3159 | 3160 | |
|
3160 | 3161 | Static transformations, implemented in IPython.core.inputtransformer2, |
|
3161 | 3162 | deal with things like ``%magic`` and ``!system`` commands. |
|
3162 | 3163 | These run on all input. |
|
3163 | 3164 | Dynamic transformations, for things like unescaped magics and the exit |
|
3164 | 3165 | autocall, depend on the state of the interpreter. |
|
3165 | 3166 | These only apply to single line inputs. |
|
3166 | 3167 | |
|
3167 | 3168 | These string-based transformations are followed by AST transformations; |
|
3168 | 3169 | see :meth:`transform_ast`. |
|
3169 | 3170 | """ |
|
3170 | 3171 | # Static input transformations |
|
3171 | 3172 | cell = self.input_transformer_manager.transform_cell(raw_cell) |
|
3172 | 3173 | |
|
3173 | 3174 | if len(cell.splitlines()) == 1: |
|
3174 | 3175 | # Dynamic transformations - only applied for single line commands |
|
3175 | 3176 | with self.builtin_trap: |
|
3176 | 3177 | # use prefilter_lines to handle trailing newlines |
|
3177 | 3178 | # restore trailing newline for ast.parse |
|
3178 | 3179 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
3179 | 3180 | |
|
3180 | 3181 | lines = cell.splitlines(keepends=True) |
|
3181 | 3182 | for transform in self.input_transformers_post: |
|
3182 | 3183 | lines = transform(lines) |
|
3183 | 3184 | cell = ''.join(lines) |
|
3184 | 3185 | |
|
3185 | 3186 | return cell |
|
3186 | 3187 | |
|
3187 | 3188 | def transform_ast(self, node): |
|
3188 | 3189 | """Apply the AST transformations from self.ast_transformers |
|
3189 | 3190 | |
|
3190 | 3191 | Parameters |
|
3191 | 3192 | ---------- |
|
3192 | 3193 | node : ast.Node |
|
3193 | 3194 | The root node to be transformed. Typically called with the ast.Module |
|
3194 | 3195 | produced by parsing user input. |
|
3195 | 3196 | |
|
3196 | 3197 | Returns |
|
3197 | 3198 | ------- |
|
3198 | 3199 | An ast.Node corresponding to the node it was called with. Note that it |
|
3199 | 3200 | may also modify the passed object, so don't rely on references to the |
|
3200 | 3201 | original AST. |
|
3201 | 3202 | """ |
|
3202 | 3203 | for transformer in self.ast_transformers: |
|
3203 | 3204 | try: |
|
3204 | 3205 | node = transformer.visit(node) |
|
3205 | 3206 | except InputRejected: |
|
3206 | 3207 | # User-supplied AST transformers can reject an input by raising |
|
3207 | 3208 | # an InputRejected. Short-circuit in this case so that we |
|
3208 | 3209 | # don't unregister the transform. |
|
3209 | 3210 | raise |
|
3210 | 3211 | except Exception: |
|
3211 | 3212 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) |
|
3212 | 3213 | self.ast_transformers.remove(transformer) |
|
3213 | 3214 | |
|
3214 | 3215 | if self.ast_transformers: |
|
3215 | 3216 | ast.fix_missing_locations(node) |
|
3216 | 3217 | return node |
|
3217 | 3218 | |
|
3218 | 3219 | async def run_ast_nodes(self, nodelist:ListType[AST], cell_name:str, interactivity='last_expr', |
|
3219 | 3220 | compiler=compile, result=None): |
|
3220 | 3221 | """Run a sequence of AST nodes. The execution mode depends on the |
|
3221 | 3222 | interactivity parameter. |
|
3222 | 3223 | |
|
3223 | 3224 | Parameters |
|
3224 | 3225 | ---------- |
|
3225 | 3226 | nodelist : list |
|
3226 | 3227 | A sequence of AST nodes to run. |
|
3227 | 3228 | cell_name : str |
|
3228 | 3229 | Will be passed to the compiler as the filename of the cell. Typically |
|
3229 | 3230 | the value returned by ip.compile.cache(cell). |
|
3230 | 3231 | interactivity : str |
|
3231 | 3232 | 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none', |
|
3232 | 3233 | specifying which nodes should be run interactively (displaying output |
|
3233 | 3234 | from expressions). 'last_expr' will run the last node interactively |
|
3234 | 3235 | only if it is an expression (i.e. expressions in loops or other blocks |
|
3235 | 3236 | are not displayed) 'last_expr_or_assign' will run the last expression |
|
3236 | 3237 | or the last assignment. Other values for this parameter will raise a |
|
3237 | 3238 | ValueError. |
|
3238 | 3239 | |
|
3239 | 3240 | Experimental value: 'async' Will try to run top level interactive |
|
3240 | 3241 | async/await code in default runner, this will not respect the |
|
3241 | 3242 | interactivity setting and will only run the last node if it is an |
|
3242 | 3243 | expression. |
|
3243 | 3244 | |
|
3244 | 3245 | compiler : callable |
|
3245 | 3246 | A function with the same interface as the built-in compile(), to turn |
|
3246 | 3247 | the AST nodes into code objects. Default is the built-in compile(). |
|
3247 | 3248 | result : ExecutionResult, optional |
|
3248 | 3249 | An object to store exceptions that occur during execution. |
|
3249 | 3250 | |
|
3250 | 3251 | Returns |
|
3251 | 3252 | ------- |
|
3252 | 3253 | True if an exception occurred while running code, False if it finished |
|
3253 | 3254 | running. |
|
3254 | 3255 | """ |
|
3255 | 3256 | if not nodelist: |
|
3256 | 3257 | return |
|
3257 | 3258 | |
|
3258 | 3259 | if interactivity == 'last_expr_or_assign': |
|
3259 | 3260 | if isinstance(nodelist[-1], _assign_nodes): |
|
3260 | 3261 | asg = nodelist[-1] |
|
3261 | 3262 | if isinstance(asg, ast.Assign) and len(asg.targets) == 1: |
|
3262 | 3263 | target = asg.targets[0] |
|
3263 | 3264 | elif isinstance(asg, _single_targets_nodes): |
|
3264 | 3265 | target = asg.target |
|
3265 | 3266 | else: |
|
3266 | 3267 | target = None |
|
3267 | 3268 | if isinstance(target, ast.Name): |
|
3268 | 3269 | nnode = ast.Expr(ast.Name(target.id, ast.Load())) |
|
3269 | 3270 | ast.fix_missing_locations(nnode) |
|
3270 | 3271 | nodelist.append(nnode) |
|
3271 | 3272 | interactivity = 'last_expr' |
|
3272 | 3273 | |
|
3273 | 3274 | _async = False |
|
3274 | 3275 | if interactivity == 'last_expr': |
|
3275 | 3276 | if isinstance(nodelist[-1], ast.Expr): |
|
3276 | 3277 | interactivity = "last" |
|
3277 | 3278 | else: |
|
3278 | 3279 | interactivity = "none" |
|
3279 | 3280 | |
|
3280 | 3281 | if interactivity == 'none': |
|
3281 | 3282 | to_run_exec, to_run_interactive = nodelist, [] |
|
3282 | 3283 | elif interactivity == 'last': |
|
3283 | 3284 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
3284 | 3285 | elif interactivity == 'all': |
|
3285 | 3286 | to_run_exec, to_run_interactive = [], nodelist |
|
3286 | 3287 | elif interactivity == 'async': |
|
3287 | 3288 | to_run_exec, to_run_interactive = [], nodelist |
|
3288 | 3289 | _async = True |
|
3289 | 3290 | else: |
|
3290 | 3291 | raise ValueError("Interactivity was %r" % interactivity) |
|
3291 | 3292 | |
|
3292 | 3293 | try: |
|
3293 | 3294 | if _async and sys.version_info > (3,8): |
|
3294 | 3295 | raise ValueError("This branch should never happen on Python 3.8 and above, " |
|
3295 | 3296 | "please try to upgrade IPython and open a bug report with your case.") |
|
3296 | 3297 | if _async: |
|
3297 | 3298 | # If interactivity is async the semantics of run_code are |
|
3298 | 3299 | # completely different Skip usual machinery. |
|
3299 | 3300 | mod = Module(nodelist, []) |
|
3300 | 3301 | async_wrapper_code = compiler(mod, cell_name, 'exec') |
|
3301 | 3302 | exec(async_wrapper_code, self.user_global_ns, self.user_ns) |
|
3302 | 3303 | async_code = removed_co_newlocals(self.user_ns.pop('async-def-wrapper')).__code__ |
|
3303 | 3304 | if (await self.run_code(async_code, result, async_=True)): |
|
3304 | 3305 | return True |
|
3305 | 3306 | else: |
|
3306 | 3307 | if sys.version_info > (3, 8): |
|
3307 | 3308 | def compare(code): |
|
3308 | 3309 | is_async = (inspect.CO_COROUTINE & code.co_flags == inspect.CO_COROUTINE) |
|
3309 | 3310 | return is_async |
|
3310 | 3311 | else: |
|
3311 | 3312 | def compare(code): |
|
3312 | 3313 | return _async |
|
3313 | 3314 | |
|
3314 | 3315 | # refactor that to just change the mod constructor. |
|
3315 | 3316 | to_run = [] |
|
3316 | 3317 | for node in to_run_exec: |
|
3317 | 3318 | to_run.append((node, 'exec')) |
|
3318 | 3319 | |
|
3319 | 3320 | for node in to_run_interactive: |
|
3320 | 3321 | to_run.append((node, 'single')) |
|
3321 | 3322 | |
|
3322 | 3323 | for node,mode in to_run: |
|
3323 | 3324 | if mode == 'exec': |
|
3324 | 3325 | mod = Module([node], []) |
|
3325 | 3326 | elif mode == 'single': |
|
3326 | 3327 | mod = ast.Interactive([node]) |
|
3327 | 3328 | with compiler.extra_flags(getattr(ast, 'PyCF_ALLOW_TOP_LEVEL_AWAIT', 0x0) if self.autoawait else 0x0): |
|
3328 | 3329 | code = compiler(mod, cell_name, mode) |
|
3329 | 3330 | asy = compare(code) |
|
3330 | 3331 | if (await self.run_code(code, result, async_=asy)): |
|
3331 | 3332 | return True |
|
3332 | 3333 | |
|
3333 | 3334 | # Flush softspace |
|
3334 | 3335 | if softspace(sys.stdout, 0): |
|
3335 | 3336 | print() |
|
3336 | 3337 | |
|
3337 | 3338 | except: |
|
3338 | 3339 | # It's possible to have exceptions raised here, typically by |
|
3339 | 3340 | # compilation of odd code (such as a naked 'return' outside a |
|
3340 | 3341 | # function) that did parse but isn't valid. Typically the exception |
|
3341 | 3342 | # is a SyntaxError, but it's safest just to catch anything and show |
|
3342 | 3343 | # the user a traceback. |
|
3343 | 3344 | |
|
3344 | 3345 | # We do only one try/except outside the loop to minimize the impact |
|
3345 | 3346 | # on runtime, and also because if any node in the node list is |
|
3346 | 3347 | # broken, we should stop execution completely. |
|
3347 | 3348 | if result: |
|
3348 | 3349 | result.error_before_exec = sys.exc_info()[1] |
|
3349 | 3350 | self.showtraceback() |
|
3350 | 3351 | return True |
|
3351 | 3352 | |
|
3352 | 3353 | return False |
|
3353 | 3354 | |
|
3354 | 3355 | def _async_exec(self, code_obj: types.CodeType, user_ns: dict): |
|
3355 | 3356 | """ |
|
3356 | 3357 | Evaluate an asynchronous code object using a code runner |
|
3357 | 3358 | |
|
3358 | 3359 | Fake asynchronous execution of code_object in a namespace via a proxy namespace. |
|
3359 | 3360 | |
|
3360 | 3361 | Returns coroutine object, which can be executed via async loop runner |
|
3361 | 3362 | |
|
3362 | 3363 | WARNING: The semantics of `async_exec` are quite different from `exec`, |
|
3363 | 3364 | in particular you can only pass a single namespace. It also return a |
|
3364 | 3365 | handle to the value of the last things returned by code_object. |
|
3365 | 3366 | """ |
|
3366 | 3367 | |
|
3367 | 3368 | return eval(code_obj, user_ns) |
|
3368 | 3369 | |
|
3369 | 3370 | async def run_code(self, code_obj, result=None, *, async_=False): |
|
3370 | 3371 | """Execute a code object. |
|
3371 | 3372 | |
|
3372 | 3373 | When an exception occurs, self.showtraceback() is called to display a |
|
3373 | 3374 | traceback. |
|
3374 | 3375 | |
|
3375 | 3376 | Parameters |
|
3376 | 3377 | ---------- |
|
3377 | 3378 | code_obj : code object |
|
3378 | 3379 | A compiled code object, to be executed |
|
3379 | 3380 | result : ExecutionResult, optional |
|
3380 | 3381 | An object to store exceptions that occur during execution. |
|
3381 | 3382 | async_ : Bool (Experimental) |
|
3382 | 3383 | Attempt to run top-level asynchronous code in a default loop. |
|
3383 | 3384 | |
|
3384 | 3385 | Returns |
|
3385 | 3386 | ------- |
|
3386 | 3387 | False : successful execution. |
|
3387 | 3388 | True : an error occurred. |
|
3388 | 3389 | """ |
|
3389 | 3390 | # special value to say that anything above is IPython and should be |
|
3390 | 3391 | # hidden. |
|
3391 | 3392 | __tracebackhide__ = "__ipython_bottom__" |
|
3392 | 3393 | # Set our own excepthook in case the user code tries to call it |
|
3393 | 3394 | # directly, so that the IPython crash handler doesn't get triggered |
|
3394 | 3395 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook |
|
3395 | 3396 | |
|
3396 | 3397 | # we save the original sys.excepthook in the instance, in case config |
|
3397 | 3398 | # code (such as magics) needs access to it. |
|
3398 | 3399 | self.sys_excepthook = old_excepthook |
|
3399 | 3400 | outflag = True # happens in more places, so it's easier as default |
|
3400 | 3401 | try: |
|
3401 | 3402 | try: |
|
3402 | 3403 | self.hooks.pre_run_code_hook() |
|
3403 | 3404 | if async_ and sys.version_info < (3,8): |
|
3404 | 3405 | last_expr = (await self._async_exec(code_obj, self.user_ns)) |
|
3405 | 3406 | code = compile('last_expr', 'fake', "single") |
|
3406 | 3407 | exec(code, {'last_expr': last_expr}) |
|
3407 | 3408 | elif async_ : |
|
3408 | 3409 | await eval(code_obj, self.user_global_ns, self.user_ns) |
|
3409 | 3410 | else: |
|
3410 | 3411 | exec(code_obj, self.user_global_ns, self.user_ns) |
|
3411 | 3412 | finally: |
|
3412 | 3413 | # Reset our crash handler in place |
|
3413 | 3414 | sys.excepthook = old_excepthook |
|
3414 | 3415 | except SystemExit as e: |
|
3415 | 3416 | if result is not None: |
|
3416 | 3417 | result.error_in_exec = e |
|
3417 | 3418 | self.showtraceback(exception_only=True) |
|
3418 | 3419 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1) |
|
3419 | 3420 | except self.custom_exceptions: |
|
3420 | 3421 | etype, value, tb = sys.exc_info() |
|
3421 | 3422 | if result is not None: |
|
3422 | 3423 | result.error_in_exec = value |
|
3423 | 3424 | self.CustomTB(etype, value, tb) |
|
3424 | 3425 | except: |
|
3425 | 3426 | if result is not None: |
|
3426 | 3427 | result.error_in_exec = sys.exc_info()[1] |
|
3427 | 3428 | self.showtraceback(running_compiled_code=True) |
|
3428 | 3429 | else: |
|
3429 | 3430 | outflag = False |
|
3430 | 3431 | return outflag |
|
3431 | 3432 | |
|
3432 | 3433 | # For backwards compatibility |
|
3433 | 3434 | runcode = run_code |
|
3434 | 3435 | |
|
3435 | 3436 | def check_complete(self, code: str) -> Tuple[str, str]: |
|
3436 | 3437 | """Return whether a block of code is ready to execute, or should be continued |
|
3437 | 3438 | |
|
3438 | 3439 | Parameters |
|
3439 | 3440 | ---------- |
|
3440 | 3441 | source : string |
|
3441 | 3442 | Python input code, which can be multiline. |
|
3442 | 3443 | |
|
3443 | 3444 | Returns |
|
3444 | 3445 | ------- |
|
3445 | 3446 | status : str |
|
3446 | 3447 | One of 'complete', 'incomplete', or 'invalid' if source is not a |
|
3447 | 3448 | prefix of valid code. |
|
3448 | 3449 | indent : str |
|
3449 | 3450 | When status is 'incomplete', this is some whitespace to insert on |
|
3450 | 3451 | the next line of the prompt. |
|
3451 | 3452 | """ |
|
3452 | 3453 | status, nspaces = self.input_transformer_manager.check_complete(code) |
|
3453 | 3454 | return status, ' ' * (nspaces or 0) |
|
3454 | 3455 | |
|
3455 | 3456 | #------------------------------------------------------------------------- |
|
3456 | 3457 | # Things related to GUI support and pylab |
|
3457 | 3458 | #------------------------------------------------------------------------- |
|
3458 | 3459 | |
|
3459 | 3460 | active_eventloop = None |
|
3460 | 3461 | |
|
3461 | 3462 | def enable_gui(self, gui=None): |
|
3462 | 3463 | raise NotImplementedError('Implement enable_gui in a subclass') |
|
3463 | 3464 | |
|
3464 | 3465 | def enable_matplotlib(self, gui=None): |
|
3465 | 3466 | """Enable interactive matplotlib and inline figure support. |
|
3466 | 3467 | |
|
3467 | 3468 | This takes the following steps: |
|
3468 | 3469 | |
|
3469 | 3470 | 1. select the appropriate eventloop and matplotlib backend |
|
3470 | 3471 | 2. set up matplotlib for interactive use with that backend |
|
3471 | 3472 | 3. configure formatters for inline figure display |
|
3472 | 3473 | 4. enable the selected gui eventloop |
|
3473 | 3474 | |
|
3474 | 3475 | Parameters |
|
3475 | 3476 | ---------- |
|
3476 | 3477 | gui : optional, string |
|
3477 | 3478 | If given, dictates the choice of matplotlib GUI backend to use |
|
3478 | 3479 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3479 | 3480 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3480 | 3481 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3481 | 3482 | user's matplotlibrc configuration file). Note that not all backends |
|
3482 | 3483 | make sense in all contexts, for example a terminal ipython can't |
|
3483 | 3484 | display figures inline. |
|
3484 | 3485 | """ |
|
3485 | 3486 | from IPython.core import pylabtools as pt |
|
3486 | 3487 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) |
|
3487 | 3488 | |
|
3488 | 3489 | if gui != 'inline': |
|
3489 | 3490 | # If we have our first gui selection, store it |
|
3490 | 3491 | if self.pylab_gui_select is None: |
|
3491 | 3492 | self.pylab_gui_select = gui |
|
3492 | 3493 | # Otherwise if they are different |
|
3493 | 3494 | elif gui != self.pylab_gui_select: |
|
3494 | 3495 | print('Warning: Cannot change to a different GUI toolkit: %s.' |
|
3495 | 3496 | ' Using %s instead.' % (gui, self.pylab_gui_select)) |
|
3496 | 3497 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) |
|
3497 | 3498 | |
|
3498 | 3499 | pt.activate_matplotlib(backend) |
|
3499 | 3500 | pt.configure_inline_support(self, backend) |
|
3500 | 3501 | |
|
3501 | 3502 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
3502 | 3503 | # plot updates into account |
|
3503 | 3504 | self.enable_gui(gui) |
|
3504 | 3505 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ |
|
3505 | 3506 | pt.mpl_runner(self.safe_execfile) |
|
3506 | 3507 | |
|
3507 | 3508 | return gui, backend |
|
3508 | 3509 | |
|
3509 | 3510 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): |
|
3510 | 3511 | """Activate pylab support at runtime. |
|
3511 | 3512 | |
|
3512 | 3513 | This turns on support for matplotlib, preloads into the interactive |
|
3513 | 3514 | namespace all of numpy and pylab, and configures IPython to correctly |
|
3514 | 3515 | interact with the GUI event loop. The GUI backend to be used can be |
|
3515 | 3516 | optionally selected with the optional ``gui`` argument. |
|
3516 | 3517 | |
|
3517 | 3518 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. |
|
3518 | 3519 | |
|
3519 | 3520 | Parameters |
|
3520 | 3521 | ---------- |
|
3521 | 3522 | gui : optional, string |
|
3522 | 3523 | If given, dictates the choice of matplotlib GUI backend to use |
|
3523 | 3524 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3524 | 3525 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3525 | 3526 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3526 | 3527 | user's matplotlibrc configuration file). Note that not all backends |
|
3527 | 3528 | make sense in all contexts, for example a terminal ipython can't |
|
3528 | 3529 | display figures inline. |
|
3529 | 3530 | import_all : optional, bool, default: True |
|
3530 | 3531 | Whether to do `from numpy import *` and `from pylab import *` |
|
3531 | 3532 | in addition to module imports. |
|
3532 | 3533 | welcome_message : deprecated |
|
3533 | 3534 | This argument is ignored, no welcome message will be displayed. |
|
3534 | 3535 | """ |
|
3535 | 3536 | from IPython.core.pylabtools import import_pylab |
|
3536 | 3537 | |
|
3537 | 3538 | gui, backend = self.enable_matplotlib(gui) |
|
3538 | 3539 | |
|
3539 | 3540 | # We want to prevent the loading of pylab to pollute the user's |
|
3540 | 3541 | # namespace as shown by the %who* magics, so we execute the activation |
|
3541 | 3542 | # code in an empty namespace, and we update *both* user_ns and |
|
3542 | 3543 | # user_ns_hidden with this information. |
|
3543 | 3544 | ns = {} |
|
3544 | 3545 | import_pylab(ns, import_all) |
|
3545 | 3546 | # warn about clobbered names |
|
3546 | 3547 | ignored = {"__builtins__"} |
|
3547 | 3548 | both = set(ns).intersection(self.user_ns).difference(ignored) |
|
3548 | 3549 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] |
|
3549 | 3550 | self.user_ns.update(ns) |
|
3550 | 3551 | self.user_ns_hidden.update(ns) |
|
3551 | 3552 | return gui, backend, clobbered |
|
3552 | 3553 | |
|
3553 | 3554 | #------------------------------------------------------------------------- |
|
3554 | 3555 | # Utilities |
|
3555 | 3556 | #------------------------------------------------------------------------- |
|
3556 | 3557 | |
|
3557 | 3558 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
3558 | 3559 | """Expand python variables in a string. |
|
3559 | 3560 | |
|
3560 | 3561 | The depth argument indicates how many frames above the caller should |
|
3561 | 3562 | be walked to look for the local namespace where to expand variables. |
|
3562 | 3563 | |
|
3563 | 3564 | The global namespace for expansion is always the user's interactive |
|
3564 | 3565 | namespace. |
|
3565 | 3566 | """ |
|
3566 | 3567 | ns = self.user_ns.copy() |
|
3567 | 3568 | try: |
|
3568 | 3569 | frame = sys._getframe(depth+1) |
|
3569 | 3570 | except ValueError: |
|
3570 | 3571 | # This is thrown if there aren't that many frames on the stack, |
|
3571 | 3572 | # e.g. if a script called run_line_magic() directly. |
|
3572 | 3573 | pass |
|
3573 | 3574 | else: |
|
3574 | 3575 | ns.update(frame.f_locals) |
|
3575 | 3576 | |
|
3576 | 3577 | try: |
|
3577 | 3578 | # We have to use .vformat() here, because 'self' is a valid and common |
|
3578 | 3579 | # name, and expanding **ns for .format() would make it collide with |
|
3579 | 3580 | # the 'self' argument of the method. |
|
3580 | 3581 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) |
|
3581 | 3582 | except Exception: |
|
3582 | 3583 | # if formatter couldn't format, just let it go untransformed |
|
3583 | 3584 | pass |
|
3584 | 3585 | return cmd |
|
3585 | 3586 | |
|
3586 | 3587 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
3587 | 3588 | """Make a new tempfile and return its filename. |
|
3588 | 3589 | |
|
3589 | 3590 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), |
|
3590 | 3591 | but it registers the created filename internally so ipython cleans it up |
|
3591 | 3592 | at exit time. |
|
3592 | 3593 | |
|
3593 | 3594 | Optional inputs: |
|
3594 | 3595 | |
|
3595 | 3596 | - data(None): if data is given, it gets written out to the temp file |
|
3596 | 3597 | immediately, and the file is closed again.""" |
|
3597 | 3598 | |
|
3598 |
dir |
|
|
3599 |
self.tempdirs.append(dir |
|
|
3599 | dir_path = Path(tempfile.mkdtemp(prefix=prefix)) | |
|
3600 | self.tempdirs.append(dir_path) | |
|
3600 | 3601 | |
|
3601 |
handle, filename = tempfile.mkstemp( |
|
|
3602 | handle, filename = tempfile.mkstemp(".py", prefix, dir=str(dir_path)) | |
|
3602 | 3603 | os.close(handle) # On Windows, there can only be one open handle on a file |
|
3603 | self.tempfiles.append(filename) | |
|
3604 | ||
|
3605 | file_path = Path(filename) | |
|
3606 | self.tempfiles.append(file_path) | |
|
3604 | 3607 | |
|
3605 | 3608 | if data: |
|
3606 | with open(filename, 'w') as tmp_file: | |
|
3607 | tmp_file.write(data) | |
|
3609 | file_path.write_text(data) | |
|
3608 | 3610 | return filename |
|
3609 | 3611 | |
|
3610 | 3612 | @undoc |
|
3611 | 3613 | def write(self,data): |
|
3612 | 3614 | """DEPRECATED: Write a string to the default output""" |
|
3613 | 3615 | warn('InteractiveShell.write() is deprecated, use sys.stdout instead', |
|
3614 | 3616 | DeprecationWarning, stacklevel=2) |
|
3615 | 3617 | sys.stdout.write(data) |
|
3616 | 3618 | |
|
3617 | 3619 | @undoc |
|
3618 | 3620 | def write_err(self,data): |
|
3619 | 3621 | """DEPRECATED: Write a string to the default error output""" |
|
3620 | 3622 | warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead', |
|
3621 | 3623 | DeprecationWarning, stacklevel=2) |
|
3622 | 3624 | sys.stderr.write(data) |
|
3623 | 3625 | |
|
3624 | 3626 | def ask_yes_no(self, prompt, default=None, interrupt=None): |
|
3625 | 3627 | if self.quiet: |
|
3626 | 3628 | return True |
|
3627 | 3629 | return ask_yes_no(prompt,default,interrupt) |
|
3628 | 3630 | |
|
3629 | 3631 | def show_usage(self): |
|
3630 | 3632 | """Show a usage message""" |
|
3631 | 3633 | page.page(IPython.core.usage.interactive_usage) |
|
3632 | 3634 | |
|
3633 | 3635 | def extract_input_lines(self, range_str, raw=False): |
|
3634 | 3636 | """Return as a string a set of input history slices. |
|
3635 | 3637 | |
|
3636 | 3638 | Parameters |
|
3637 | 3639 | ---------- |
|
3638 | 3640 | range_str : string |
|
3639 | 3641 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", |
|
3640 | 3642 | since this function is for use by magic functions which get their |
|
3641 | 3643 | arguments as strings. The number before the / is the session |
|
3642 | 3644 | number: ~n goes n back from the current session. |
|
3643 | 3645 | |
|
3644 | 3646 | raw : bool, optional |
|
3645 | 3647 | By default, the processed input is used. If this is true, the raw |
|
3646 | 3648 | input history is used instead. |
|
3647 | 3649 | |
|
3648 | 3650 | Notes |
|
3649 | 3651 | ----- |
|
3650 | 3652 | |
|
3651 | 3653 | Slices can be described with two notations: |
|
3652 | 3654 | |
|
3653 | 3655 | * ``N:M`` -> standard python form, means including items N...(M-1). |
|
3654 | 3656 | * ``N-M`` -> include items N..M (closed endpoint). |
|
3655 | 3657 | """ |
|
3656 | 3658 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) |
|
3657 | 3659 | return "\n".join(x for _, _, x in lines) |
|
3658 | 3660 | |
|
3659 | 3661 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): |
|
3660 | 3662 | """Get a code string from history, file, url, or a string or macro. |
|
3661 | 3663 | |
|
3662 | 3664 | This is mainly used by magic functions. |
|
3663 | 3665 | |
|
3664 | 3666 | Parameters |
|
3665 | 3667 | ---------- |
|
3666 | 3668 | |
|
3667 | 3669 | target : str |
|
3668 | 3670 | |
|
3669 | 3671 | A string specifying code to retrieve. This will be tried respectively |
|
3670 | 3672 | as: ranges of input history (see %history for syntax), url, |
|
3671 | 3673 | corresponding .py file, filename, or an expression evaluating to a |
|
3672 | 3674 | string or Macro in the user namespace. |
|
3673 | 3675 | |
|
3674 | 3676 | raw : bool |
|
3675 | 3677 | If true (default), retrieve raw history. Has no effect on the other |
|
3676 | 3678 | retrieval mechanisms. |
|
3677 | 3679 | |
|
3678 | 3680 | py_only : bool (default False) |
|
3679 | 3681 | Only try to fetch python code, do not try alternative methods to decode file |
|
3680 | 3682 | if unicode fails. |
|
3681 | 3683 | |
|
3682 | 3684 | Returns |
|
3683 | 3685 | ------- |
|
3684 | 3686 | A string of code. |
|
3685 | 3687 | |
|
3686 | 3688 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
3687 | 3689 | to an object of another type. In each case, .args[0] is a printable |
|
3688 | 3690 | message. |
|
3689 | 3691 | """ |
|
3690 | 3692 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
3691 | 3693 | if code: |
|
3692 | 3694 | return code |
|
3693 | 3695 | try: |
|
3694 | 3696 | if target.startswith(('http://', 'https://')): |
|
3695 | 3697 | return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie) |
|
3696 | 3698 | except UnicodeDecodeError as e: |
|
3697 | 3699 | if not py_only : |
|
3698 | 3700 | # Deferred import |
|
3699 | 3701 | from urllib.request import urlopen |
|
3700 | 3702 | response = urlopen(target) |
|
3701 | 3703 | return response.read().decode('latin1') |
|
3702 | 3704 | raise ValueError(("'%s' seem to be unreadable.") % target) from e |
|
3703 | 3705 | |
|
3704 | 3706 | potential_target = [target] |
|
3705 | 3707 | try : |
|
3706 | 3708 | potential_target.insert(0,get_py_filename(target)) |
|
3707 | 3709 | except IOError: |
|
3708 | 3710 | pass |
|
3709 | 3711 | |
|
3710 | 3712 | for tgt in potential_target : |
|
3711 | 3713 | if os.path.isfile(tgt): # Read file |
|
3712 | 3714 | try : |
|
3713 | 3715 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) |
|
3714 | 3716 | except UnicodeDecodeError as e: |
|
3715 | 3717 | if not py_only : |
|
3716 | 3718 | with io_open(tgt,'r', encoding='latin1') as f : |
|
3717 | 3719 | return f.read() |
|
3718 | 3720 | raise ValueError(("'%s' seem to be unreadable.") % target) from e |
|
3719 | 3721 | elif os.path.isdir(os.path.expanduser(tgt)): |
|
3720 | 3722 | raise ValueError("'%s' is a directory, not a regular file." % target) |
|
3721 | 3723 | |
|
3722 | 3724 | if search_ns: |
|
3723 | 3725 | # Inspect namespace to load object source |
|
3724 | 3726 | object_info = self.object_inspect(target, detail_level=1) |
|
3725 | 3727 | if object_info['found'] and object_info['source']: |
|
3726 | 3728 | return object_info['source'] |
|
3727 | 3729 | |
|
3728 | 3730 | try: # User namespace |
|
3729 | 3731 | codeobj = eval(target, self.user_ns) |
|
3730 | 3732 | except Exception as e: |
|
3731 | 3733 | raise ValueError(("'%s' was not found in history, as a file, url, " |
|
3732 | 3734 | "nor in the user namespace.") % target) from e |
|
3733 | 3735 | |
|
3734 | 3736 | if isinstance(codeobj, str): |
|
3735 | 3737 | return codeobj |
|
3736 | 3738 | elif isinstance(codeobj, Macro): |
|
3737 | 3739 | return codeobj.value |
|
3738 | 3740 | |
|
3739 | 3741 | raise TypeError("%s is neither a string nor a macro." % target, |
|
3740 | 3742 | codeobj) |
|
3741 | 3743 | |
|
3742 | 3744 | #------------------------------------------------------------------------- |
|
3743 | 3745 | # Things related to IPython exiting |
|
3744 | 3746 | #------------------------------------------------------------------------- |
|
3745 | 3747 | def atexit_operations(self): |
|
3746 | 3748 | """This will be executed at the time of exit. |
|
3747 | 3749 | |
|
3748 | 3750 | Cleanup operations and saving of persistent data that is done |
|
3749 | 3751 | unconditionally by IPython should be performed here. |
|
3750 | 3752 | |
|
3751 | 3753 | For things that may depend on startup flags or platform specifics (such |
|
3752 | 3754 | as having readline or not), register a separate atexit function in the |
|
3753 | 3755 | code that has the appropriate information, rather than trying to |
|
3754 | 3756 | clutter |
|
3755 | 3757 | """ |
|
3756 | 3758 | # Close the history session (this stores the end time and line count) |
|
3757 | 3759 | # this must be *before* the tempfile cleanup, in case of temporary |
|
3758 | 3760 | # history db |
|
3759 | 3761 | self.history_manager.end_session() |
|
3760 | 3762 | |
|
3761 | 3763 | # Cleanup all tempfiles and folders left around |
|
3762 | 3764 | for tfile in self.tempfiles: |
|
3763 | 3765 | try: |
|
3764 |
|
|
|
3765 |
except |
|
|
3766 | tfile.unlink() | |
|
3767 | except FileNotFoundError: | |
|
3766 | 3768 | pass |
|
3767 | 3769 | |
|
3768 | 3770 | for tdir in self.tempdirs: |
|
3769 | 3771 | try: |
|
3770 |
|
|
|
3771 |
except |
|
|
3772 | tdir.rmdir() | |
|
3773 | except FileNotFoundError: | |
|
3772 | 3774 | pass |
|
3773 | 3775 | |
|
3774 | 3776 | # Clear all user namespaces to release all references cleanly. |
|
3775 | 3777 | self.reset(new_session=False) |
|
3776 | 3778 | |
|
3777 | 3779 | # Run user hooks |
|
3778 | 3780 | self.hooks.shutdown_hook() |
|
3779 | 3781 | |
|
3780 | 3782 | def cleanup(self): |
|
3781 | 3783 | self.restore_sys_module_state() |
|
3782 | 3784 | |
|
3783 | 3785 | |
|
3784 | 3786 | # Overridden in terminal subclass to change prompts |
|
3785 | 3787 | def switch_doctest_mode(self, mode): |
|
3786 | 3788 | pass |
|
3787 | 3789 | |
|
3788 | 3790 | |
|
3789 | 3791 | class InteractiveShellABC(metaclass=abc.ABCMeta): |
|
3790 | 3792 | """An abstract base class for InteractiveShell.""" |
|
3791 | 3793 | |
|
3792 | 3794 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,1496 +1,1496 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Implementation of execution-related magic functions.""" |
|
3 | 3 | |
|
4 | 4 | # Copyright (c) IPython Development Team. |
|
5 | 5 | # Distributed under the terms of the Modified BSD License. |
|
6 | 6 | |
|
7 | 7 | |
|
8 | 8 | import ast |
|
9 | 9 | import bdb |
|
10 | 10 | import builtins as builtin_mod |
|
11 | 11 | import gc |
|
12 | 12 | import itertools |
|
13 | 13 | import os |
|
14 | 14 | import shlex |
|
15 | 15 | import sys |
|
16 | 16 | import time |
|
17 | 17 | import timeit |
|
18 | 18 | import math |
|
19 | 19 | import re |
|
20 | 20 | from pdb import Restart |
|
21 | 21 | |
|
22 | 22 | import cProfile as profile |
|
23 | 23 | import pstats |
|
24 | 24 | |
|
25 | 25 | from IPython.core import oinspect |
|
26 | 26 | from IPython.core import magic_arguments |
|
27 | 27 | from IPython.core import page |
|
28 | 28 | from IPython.core.error import UsageError |
|
29 | 29 | from IPython.core.macro import Macro |
|
30 | 30 | from IPython.core.magic import (Magics, magics_class, line_magic, cell_magic, |
|
31 | 31 | line_cell_magic, on_off, needs_local_scope, |
|
32 | 32 | no_var_expand) |
|
33 | 33 | from IPython.testing.skipdoctest import skip_doctest |
|
34 | 34 | from IPython.utils.contexts import preserve_keys |
|
35 | 35 | from IPython.utils.capture import capture_output |
|
36 | 36 | from IPython.utils.ipstruct import Struct |
|
37 | 37 | from IPython.utils.module_paths import find_mod |
|
38 | 38 | from IPython.utils.path import get_py_filename, shellglob |
|
39 | 39 | from IPython.utils.timing import clock, clock2 |
|
40 | 40 | from warnings import warn |
|
41 | 41 | from logging import error |
|
42 | 42 | from io import StringIO |
|
43 | from pathlib import Path | |
|
43 | 44 | |
|
44 | 45 | if sys.version_info > (3,8): |
|
45 | 46 | from ast import Module |
|
46 | 47 | else : |
|
47 | 48 | # mock the new API, ignore second argument |
|
48 | 49 | # see https://github.com/ipython/ipython/issues/11590 |
|
49 | 50 | from ast import Module as OriginalModule |
|
50 | 51 | Module = lambda nodelist, type_ignores: OriginalModule(nodelist) |
|
51 | 52 | |
|
52 | 53 | |
|
53 | 54 | #----------------------------------------------------------------------------- |
|
54 | 55 | # Magic implementation classes |
|
55 | 56 | #----------------------------------------------------------------------------- |
|
56 | 57 | |
|
57 | 58 | |
|
58 | 59 | class TimeitResult(object): |
|
59 | 60 | """ |
|
60 | 61 | Object returned by the timeit magic with info about the run. |
|
61 | 62 | |
|
62 | 63 | Contains the following attributes : |
|
63 | 64 | |
|
64 | 65 | loops: (int) number of loops done per measurement |
|
65 | 66 | repeat: (int) number of times the measurement has been repeated |
|
66 | 67 | best: (float) best execution time / number |
|
67 | 68 | all_runs: (list of float) execution time of each run (in s) |
|
68 | 69 | compile_time: (float) time of statement compilation (s) |
|
69 | 70 | |
|
70 | 71 | """ |
|
71 | 72 | def __init__(self, loops, repeat, best, worst, all_runs, compile_time, precision): |
|
72 | 73 | self.loops = loops |
|
73 | 74 | self.repeat = repeat |
|
74 | 75 | self.best = best |
|
75 | 76 | self.worst = worst |
|
76 | 77 | self.all_runs = all_runs |
|
77 | 78 | self.compile_time = compile_time |
|
78 | 79 | self._precision = precision |
|
79 | 80 | self.timings = [ dt / self.loops for dt in all_runs] |
|
80 | 81 | |
|
81 | 82 | @property |
|
82 | 83 | def average(self): |
|
83 | 84 | return math.fsum(self.timings) / len(self.timings) |
|
84 | 85 | |
|
85 | 86 | @property |
|
86 | 87 | def stdev(self): |
|
87 | 88 | mean = self.average |
|
88 | 89 | return (math.fsum([(x - mean) ** 2 for x in self.timings]) / len(self.timings)) ** 0.5 |
|
89 | 90 | |
|
90 | 91 | def __str__(self): |
|
91 | 92 | pm = '+-' |
|
92 | 93 | if hasattr(sys.stdout, 'encoding') and sys.stdout.encoding: |
|
93 | 94 | try: |
|
94 | 95 | u'\xb1'.encode(sys.stdout.encoding) |
|
95 | 96 | pm = u'\xb1' |
|
96 | 97 | except: |
|
97 | 98 | pass |
|
98 | 99 | return ( |
|
99 | 100 | u"{mean} {pm} {std} per loop (mean {pm} std. dev. of {runs} run{run_plural}, {loops} loop{loop_plural} each)" |
|
100 | 101 | .format( |
|
101 | 102 | pm = pm, |
|
102 | 103 | runs = self.repeat, |
|
103 | 104 | loops = self.loops, |
|
104 | 105 | loop_plural = "" if self.loops == 1 else "s", |
|
105 | 106 | run_plural = "" if self.repeat == 1 else "s", |
|
106 | 107 | mean = _format_time(self.average, self._precision), |
|
107 | 108 | std = _format_time(self.stdev, self._precision)) |
|
108 | 109 | ) |
|
109 | 110 | |
|
110 | 111 | def _repr_pretty_(self, p , cycle): |
|
111 | 112 | unic = self.__str__() |
|
112 | 113 | p.text(u'<TimeitResult : '+unic+u'>') |
|
113 | 114 | |
|
114 | 115 | |
|
115 | 116 | class TimeitTemplateFiller(ast.NodeTransformer): |
|
116 | 117 | """Fill in the AST template for timing execution. |
|
117 | 118 | |
|
118 | 119 | This is quite closely tied to the template definition, which is in |
|
119 | 120 | :meth:`ExecutionMagics.timeit`. |
|
120 | 121 | """ |
|
121 | 122 | def __init__(self, ast_setup, ast_stmt): |
|
122 | 123 | self.ast_setup = ast_setup |
|
123 | 124 | self.ast_stmt = ast_stmt |
|
124 | 125 | |
|
125 | 126 | def visit_FunctionDef(self, node): |
|
126 | 127 | "Fill in the setup statement" |
|
127 | 128 | self.generic_visit(node) |
|
128 | 129 | if node.name == "inner": |
|
129 | 130 | node.body[:1] = self.ast_setup.body |
|
130 | 131 | |
|
131 | 132 | return node |
|
132 | 133 | |
|
133 | 134 | def visit_For(self, node): |
|
134 | 135 | "Fill in the statement to be timed" |
|
135 | 136 | if getattr(getattr(node.body[0], 'value', None), 'id', None) == 'stmt': |
|
136 | 137 | node.body = self.ast_stmt.body |
|
137 | 138 | return node |
|
138 | 139 | |
|
139 | 140 | |
|
140 | 141 | class Timer(timeit.Timer): |
|
141 | 142 | """Timer class that explicitly uses self.inner |
|
142 | 143 | |
|
143 | 144 | which is an undocumented implementation detail of CPython, |
|
144 | 145 | not shared by PyPy. |
|
145 | 146 | """ |
|
146 | 147 | # Timer.timeit copied from CPython 3.4.2 |
|
147 | 148 | def timeit(self, number=timeit.default_number): |
|
148 | 149 | """Time 'number' executions of the main statement. |
|
149 | 150 | |
|
150 | 151 | To be precise, this executes the setup statement once, and |
|
151 | 152 | then returns the time it takes to execute the main statement |
|
152 | 153 | a number of times, as a float measured in seconds. The |
|
153 | 154 | argument is the number of times through the loop, defaulting |
|
154 | 155 | to one million. The main statement, the setup statement and |
|
155 | 156 | the timer function to be used are passed to the constructor. |
|
156 | 157 | """ |
|
157 | 158 | it = itertools.repeat(None, number) |
|
158 | 159 | gcold = gc.isenabled() |
|
159 | 160 | gc.disable() |
|
160 | 161 | try: |
|
161 | 162 | timing = self.inner(it, self.timer) |
|
162 | 163 | finally: |
|
163 | 164 | if gcold: |
|
164 | 165 | gc.enable() |
|
165 | 166 | return timing |
|
166 | 167 | |
|
167 | 168 | |
|
168 | 169 | @magics_class |
|
169 | 170 | class ExecutionMagics(Magics): |
|
170 | 171 | """Magics related to code execution, debugging, profiling, etc. |
|
171 | 172 | |
|
172 | 173 | """ |
|
173 | 174 | |
|
174 | 175 | def __init__(self, shell): |
|
175 | 176 | super(ExecutionMagics, self).__init__(shell) |
|
176 | 177 | # Default execution function used to actually run user code. |
|
177 | 178 | self.default_runner = None |
|
178 | 179 | |
|
179 | 180 | @skip_doctest |
|
180 | 181 | @no_var_expand |
|
181 | 182 | @line_cell_magic |
|
182 | 183 | def prun(self, parameter_s='', cell=None): |
|
183 | 184 | |
|
184 | 185 | """Run a statement through the python code profiler. |
|
185 | 186 | |
|
186 | 187 | Usage, in line mode: |
|
187 | 188 | %prun [options] statement |
|
188 | 189 | |
|
189 | 190 | Usage, in cell mode: |
|
190 | 191 | %%prun [options] [statement] |
|
191 | 192 | code... |
|
192 | 193 | code... |
|
193 | 194 | |
|
194 | 195 | In cell mode, the additional code lines are appended to the (possibly |
|
195 | 196 | empty) statement in the first line. Cell mode allows you to easily |
|
196 | 197 | profile multiline blocks without having to put them in a separate |
|
197 | 198 | function. |
|
198 | 199 | |
|
199 | 200 | The given statement (which doesn't require quote marks) is run via the |
|
200 | 201 | python profiler in a manner similar to the profile.run() function. |
|
201 | 202 | Namespaces are internally managed to work correctly; profile.run |
|
202 | 203 | cannot be used in IPython because it makes certain assumptions about |
|
203 | 204 | namespaces which do not hold under IPython. |
|
204 | 205 | |
|
205 | 206 | Options: |
|
206 | 207 | |
|
207 | 208 | -l <limit> |
|
208 | 209 | you can place restrictions on what or how much of the |
|
209 | 210 | profile gets printed. The limit value can be: |
|
210 | 211 | |
|
211 | 212 | * A string: only information for function names containing this string |
|
212 | 213 | is printed. |
|
213 | 214 | |
|
214 | 215 | * An integer: only these many lines are printed. |
|
215 | 216 | |
|
216 | 217 | * A float (between 0 and 1): this fraction of the report is printed |
|
217 | 218 | (for example, use a limit of 0.4 to see the topmost 40% only). |
|
218 | 219 | |
|
219 | 220 | You can combine several limits with repeated use of the option. For |
|
220 | 221 | example, ``-l __init__ -l 5`` will print only the topmost 5 lines of |
|
221 | 222 | information about class constructors. |
|
222 | 223 | |
|
223 | 224 | -r |
|
224 | 225 | return the pstats.Stats object generated by the profiling. This |
|
225 | 226 | object has all the information about the profile in it, and you can |
|
226 | 227 | later use it for further analysis or in other functions. |
|
227 | 228 | |
|
228 | 229 | -s <key> |
|
229 | 230 | sort profile by given key. You can provide more than one key |
|
230 | 231 | by using the option several times: '-s key1 -s key2 -s key3...'. The |
|
231 | 232 | default sorting key is 'time'. |
|
232 | 233 | |
|
233 | 234 | The following is copied verbatim from the profile documentation |
|
234 | 235 | referenced below: |
|
235 | 236 | |
|
236 | 237 | When more than one key is provided, additional keys are used as |
|
237 | 238 | secondary criteria when the there is equality in all keys selected |
|
238 | 239 | before them. |
|
239 | 240 | |
|
240 | 241 | Abbreviations can be used for any key names, as long as the |
|
241 | 242 | abbreviation is unambiguous. The following are the keys currently |
|
242 | 243 | defined: |
|
243 | 244 | |
|
244 | 245 | ============ ===================== |
|
245 | 246 | Valid Arg Meaning |
|
246 | 247 | ============ ===================== |
|
247 | 248 | "calls" call count |
|
248 | 249 | "cumulative" cumulative time |
|
249 | 250 | "file" file name |
|
250 | 251 | "module" file name |
|
251 | 252 | "pcalls" primitive call count |
|
252 | 253 | "line" line number |
|
253 | 254 | "name" function name |
|
254 | 255 | "nfl" name/file/line |
|
255 | 256 | "stdname" standard name |
|
256 | 257 | "time" internal time |
|
257 | 258 | ============ ===================== |
|
258 | 259 | |
|
259 | 260 | Note that all sorts on statistics are in descending order (placing |
|
260 | 261 | most time consuming items first), where as name, file, and line number |
|
261 | 262 | searches are in ascending order (i.e., alphabetical). The subtle |
|
262 | 263 | distinction between "nfl" and "stdname" is that the standard name is a |
|
263 | 264 | sort of the name as printed, which means that the embedded line |
|
264 | 265 | numbers get compared in an odd way. For example, lines 3, 20, and 40 |
|
265 | 266 | would (if the file names were the same) appear in the string order |
|
266 | 267 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the |
|
267 | 268 | line numbers. In fact, sort_stats("nfl") is the same as |
|
268 | 269 | sort_stats("name", "file", "line"). |
|
269 | 270 | |
|
270 | 271 | -T <filename> |
|
271 | 272 | save profile results as shown on screen to a text |
|
272 | 273 | file. The profile is still shown on screen. |
|
273 | 274 | |
|
274 | 275 | -D <filename> |
|
275 | 276 | save (via dump_stats) profile statistics to given |
|
276 | 277 | filename. This data is in a format understood by the pstats module, and |
|
277 | 278 | is generated by a call to the dump_stats() method of profile |
|
278 | 279 | objects. The profile is still shown on screen. |
|
279 | 280 | |
|
280 | 281 | -q |
|
281 | 282 | suppress output to the pager. Best used with -T and/or -D above. |
|
282 | 283 | |
|
283 | 284 | If you want to run complete programs under the profiler's control, use |
|
284 | 285 | ``%run -p [prof_opts] filename.py [args to program]`` where prof_opts |
|
285 | 286 | contains profiler specific options as described here. |
|
286 | 287 | |
|
287 | 288 | You can read the complete documentation for the profile module with:: |
|
288 | 289 | |
|
289 | 290 | In [1]: import profile; profile.help() |
|
290 | 291 | |
|
291 | 292 | .. versionchanged:: 7.3 |
|
292 | 293 | User variables are no longer expanded, |
|
293 | 294 | the magic line is always left unmodified. |
|
294 | 295 | |
|
295 | 296 | """ |
|
296 | 297 | opts, arg_str = self.parse_options(parameter_s, 'D:l:rs:T:q', |
|
297 | 298 | list_all=True, posix=False) |
|
298 | 299 | if cell is not None: |
|
299 | 300 | arg_str += '\n' + cell |
|
300 | 301 | arg_str = self.shell.transform_cell(arg_str) |
|
301 | 302 | return self._run_with_profiler(arg_str, opts, self.shell.user_ns) |
|
302 | 303 | |
|
303 | 304 | def _run_with_profiler(self, code, opts, namespace): |
|
304 | 305 | """ |
|
305 | 306 | Run `code` with profiler. Used by ``%prun`` and ``%run -p``. |
|
306 | 307 | |
|
307 | 308 | Parameters |
|
308 | 309 | ---------- |
|
309 | 310 | code : str |
|
310 | 311 | Code to be executed. |
|
311 | 312 | opts : Struct |
|
312 | 313 | Options parsed by `self.parse_options`. |
|
313 | 314 | namespace : dict |
|
314 | 315 | A dictionary for Python namespace (e.g., `self.shell.user_ns`). |
|
315 | 316 | |
|
316 | 317 | """ |
|
317 | 318 | |
|
318 | 319 | # Fill default values for unspecified options: |
|
319 | 320 | opts.merge(Struct(D=[''], l=[], s=['time'], T=[''])) |
|
320 | 321 | |
|
321 | 322 | prof = profile.Profile() |
|
322 | 323 | try: |
|
323 | 324 | prof = prof.runctx(code, namespace, namespace) |
|
324 | 325 | sys_exit = '' |
|
325 | 326 | except SystemExit: |
|
326 | 327 | sys_exit = """*** SystemExit exception caught in code being profiled.""" |
|
327 | 328 | |
|
328 | 329 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) |
|
329 | 330 | |
|
330 | 331 | lims = opts.l |
|
331 | 332 | if lims: |
|
332 | 333 | lims = [] # rebuild lims with ints/floats/strings |
|
333 | 334 | for lim in opts.l: |
|
334 | 335 | try: |
|
335 | 336 | lims.append(int(lim)) |
|
336 | 337 | except ValueError: |
|
337 | 338 | try: |
|
338 | 339 | lims.append(float(lim)) |
|
339 | 340 | except ValueError: |
|
340 | 341 | lims.append(lim) |
|
341 | 342 | |
|
342 | 343 | # Trap output. |
|
343 | 344 | stdout_trap = StringIO() |
|
344 | 345 | stats_stream = stats.stream |
|
345 | 346 | try: |
|
346 | 347 | stats.stream = stdout_trap |
|
347 | 348 | stats.print_stats(*lims) |
|
348 | 349 | finally: |
|
349 | 350 | stats.stream = stats_stream |
|
350 | 351 | |
|
351 | 352 | output = stdout_trap.getvalue() |
|
352 | 353 | output = output.rstrip() |
|
353 | 354 | |
|
354 | 355 | if 'q' not in opts: |
|
355 | 356 | page.page(output) |
|
356 | 357 | print(sys_exit, end=' ') |
|
357 | 358 | |
|
358 | 359 | dump_file = opts.D[0] |
|
359 | 360 | text_file = opts.T[0] |
|
360 | 361 | if dump_file: |
|
361 | 362 | prof.dump_stats(dump_file) |
|
362 | 363 | print('\n*** Profile stats marshalled to file',\ |
|
363 | 364 | repr(dump_file)+'.',sys_exit) |
|
364 | 365 | if text_file: |
|
365 | with open(text_file, 'w') as pfile: | |
|
366 | pfile.write(output) | |
|
366 | Path(text_file).write_text(output) | |
|
367 | 367 | print('\n*** Profile printout saved to text file',\ |
|
368 | 368 | repr(text_file)+'.',sys_exit) |
|
369 | 369 | |
|
370 | 370 | if 'r' in opts: |
|
371 | 371 | return stats |
|
372 | 372 | else: |
|
373 | 373 | return None |
|
374 | 374 | |
|
375 | 375 | @line_magic |
|
376 | 376 | def pdb(self, parameter_s=''): |
|
377 | 377 | """Control the automatic calling of the pdb interactive debugger. |
|
378 | 378 | |
|
379 | 379 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without |
|
380 | 380 | argument it works as a toggle. |
|
381 | 381 | |
|
382 | 382 | When an exception is triggered, IPython can optionally call the |
|
383 | 383 | interactive pdb debugger after the traceback printout. %pdb toggles |
|
384 | 384 | this feature on and off. |
|
385 | 385 | |
|
386 | 386 | The initial state of this feature is set in your configuration |
|
387 | 387 | file (the option is ``InteractiveShell.pdb``). |
|
388 | 388 | |
|
389 | 389 | If you want to just activate the debugger AFTER an exception has fired, |
|
390 | 390 | without having to type '%pdb on' and rerunning your code, you can use |
|
391 | 391 | the %debug magic.""" |
|
392 | 392 | |
|
393 | 393 | par = parameter_s.strip().lower() |
|
394 | 394 | |
|
395 | 395 | if par: |
|
396 | 396 | try: |
|
397 | 397 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] |
|
398 | 398 | except KeyError: |
|
399 | 399 | print ('Incorrect argument. Use on/1, off/0, ' |
|
400 | 400 | 'or nothing for a toggle.') |
|
401 | 401 | return |
|
402 | 402 | else: |
|
403 | 403 | # toggle |
|
404 | 404 | new_pdb = not self.shell.call_pdb |
|
405 | 405 | |
|
406 | 406 | # set on the shell |
|
407 | 407 | self.shell.call_pdb = new_pdb |
|
408 | 408 | print('Automatic pdb calling has been turned',on_off(new_pdb)) |
|
409 | 409 | |
|
410 | 410 | @skip_doctest |
|
411 | 411 | @magic_arguments.magic_arguments() |
|
412 | 412 | @magic_arguments.argument('--breakpoint', '-b', metavar='FILE:LINE', |
|
413 | 413 | help=""" |
|
414 | 414 | Set break point at LINE in FILE. |
|
415 | 415 | """ |
|
416 | 416 | ) |
|
417 | 417 | @magic_arguments.argument('statement', nargs='*', |
|
418 | 418 | help=""" |
|
419 | 419 | Code to run in debugger. |
|
420 | 420 | You can omit this in cell magic mode. |
|
421 | 421 | """ |
|
422 | 422 | ) |
|
423 | 423 | @no_var_expand |
|
424 | 424 | @line_cell_magic |
|
425 | 425 | def debug(self, line='', cell=None): |
|
426 | 426 | """Activate the interactive debugger. |
|
427 | 427 | |
|
428 | 428 | This magic command support two ways of activating debugger. |
|
429 | 429 | One is to activate debugger before executing code. This way, you |
|
430 | 430 | can set a break point, to step through the code from the point. |
|
431 | 431 | You can use this mode by giving statements to execute and optionally |
|
432 | 432 | a breakpoint. |
|
433 | 433 | |
|
434 | 434 | The other one is to activate debugger in post-mortem mode. You can |
|
435 | 435 | activate this mode simply running %debug without any argument. |
|
436 | 436 | If an exception has just occurred, this lets you inspect its stack |
|
437 | 437 | frames interactively. Note that this will always work only on the last |
|
438 | 438 | traceback that occurred, so you must call this quickly after an |
|
439 | 439 | exception that you wish to inspect has fired, because if another one |
|
440 | 440 | occurs, it clobbers the previous one. |
|
441 | 441 | |
|
442 | 442 | If you want IPython to automatically do this on every exception, see |
|
443 | 443 | the %pdb magic for more details. |
|
444 | 444 | |
|
445 | 445 | .. versionchanged:: 7.3 |
|
446 | 446 | When running code, user variables are no longer expanded, |
|
447 | 447 | the magic line is always left unmodified. |
|
448 | 448 | |
|
449 | 449 | """ |
|
450 | 450 | args = magic_arguments.parse_argstring(self.debug, line) |
|
451 | 451 | |
|
452 | 452 | if not (args.breakpoint or args.statement or cell): |
|
453 | 453 | self._debug_post_mortem() |
|
454 | 454 | elif not (args.breakpoint or cell): |
|
455 | 455 | # If there is no breakpoints, the line is just code to execute |
|
456 | 456 | self._debug_exec(line, None) |
|
457 | 457 | else: |
|
458 | 458 | # Here we try to reconstruct the code from the output of |
|
459 | 459 | # parse_argstring. This might not work if the code has spaces |
|
460 | 460 | # For example this fails for `print("a b")` |
|
461 | 461 | code = "\n".join(args.statement) |
|
462 | 462 | if cell: |
|
463 | 463 | code += "\n" + cell |
|
464 | 464 | self._debug_exec(code, args.breakpoint) |
|
465 | 465 | |
|
466 | 466 | def _debug_post_mortem(self): |
|
467 | 467 | self.shell.debugger(force=True) |
|
468 | 468 | |
|
469 | 469 | def _debug_exec(self, code, breakpoint): |
|
470 | 470 | if breakpoint: |
|
471 | 471 | (filename, bp_line) = breakpoint.rsplit(':', 1) |
|
472 | 472 | bp_line = int(bp_line) |
|
473 | 473 | else: |
|
474 | 474 | (filename, bp_line) = (None, None) |
|
475 | 475 | self._run_with_debugger(code, self.shell.user_ns, filename, bp_line) |
|
476 | 476 | |
|
477 | 477 | @line_magic |
|
478 | 478 | def tb(self, s): |
|
479 | 479 | """Print the last traceback. |
|
480 | 480 | |
|
481 | 481 | Optionally, specify an exception reporting mode, tuning the |
|
482 | 482 | verbosity of the traceback. By default the currently-active exception |
|
483 | 483 | mode is used. See %xmode for changing exception reporting modes. |
|
484 | 484 | |
|
485 | 485 | Valid modes: Plain, Context, Verbose, and Minimal. |
|
486 | 486 | """ |
|
487 | 487 | interactive_tb = self.shell.InteractiveTB |
|
488 | 488 | if s: |
|
489 | 489 | # Switch exception reporting mode for this one call. |
|
490 | 490 | # Ensure it is switched back. |
|
491 | 491 | def xmode_switch_err(name): |
|
492 | 492 | warn('Error changing %s exception modes.\n%s' % |
|
493 | 493 | (name,sys.exc_info()[1])) |
|
494 | 494 | |
|
495 | 495 | new_mode = s.strip().capitalize() |
|
496 | 496 | original_mode = interactive_tb.mode |
|
497 | 497 | try: |
|
498 | 498 | try: |
|
499 | 499 | interactive_tb.set_mode(mode=new_mode) |
|
500 | 500 | except Exception: |
|
501 | 501 | xmode_switch_err('user') |
|
502 | 502 | else: |
|
503 | 503 | self.shell.showtraceback() |
|
504 | 504 | finally: |
|
505 | 505 | interactive_tb.set_mode(mode=original_mode) |
|
506 | 506 | else: |
|
507 | 507 | self.shell.showtraceback() |
|
508 | 508 | |
|
509 | 509 | @skip_doctest |
|
510 | 510 | @line_magic |
|
511 | 511 | def run(self, parameter_s='', runner=None, |
|
512 | 512 | file_finder=get_py_filename): |
|
513 | 513 | """Run the named file inside IPython as a program. |
|
514 | 514 | |
|
515 | 515 | Usage:: |
|
516 | 516 | |
|
517 | 517 | %run [-n -i -e -G] |
|
518 | 518 | [( -t [-N<N>] | -d [-b<N>] | -p [profile options] )] |
|
519 | 519 | ( -m mod | file ) [args] |
|
520 | 520 | |
|
521 | 521 | Parameters after the filename are passed as command-line arguments to |
|
522 | 522 | the program (put in sys.argv). Then, control returns to IPython's |
|
523 | 523 | prompt. |
|
524 | 524 | |
|
525 | 525 | This is similar to running at a system prompt ``python file args``, |
|
526 | 526 | but with the advantage of giving you IPython's tracebacks, and of |
|
527 | 527 | loading all variables into your interactive namespace for further use |
|
528 | 528 | (unless -p is used, see below). |
|
529 | 529 | |
|
530 | 530 | The file is executed in a namespace initially consisting only of |
|
531 | 531 | ``__name__=='__main__'`` and sys.argv constructed as indicated. It thus |
|
532 | 532 | sees its environment as if it were being run as a stand-alone program |
|
533 | 533 | (except for sharing global objects such as previously imported |
|
534 | 534 | modules). But after execution, the IPython interactive namespace gets |
|
535 | 535 | updated with all variables defined in the program (except for __name__ |
|
536 | 536 | and sys.argv). This allows for very convenient loading of code for |
|
537 | 537 | interactive work, while giving each program a 'clean sheet' to run in. |
|
538 | 538 | |
|
539 | 539 | Arguments are expanded using shell-like glob match. Patterns |
|
540 | 540 | '*', '?', '[seq]' and '[!seq]' can be used. Additionally, |
|
541 | 541 | tilde '~' will be expanded into user's home directory. Unlike |
|
542 | 542 | real shells, quotation does not suppress expansions. Use |
|
543 | 543 | *two* back slashes (e.g. ``\\\\*``) to suppress expansions. |
|
544 | 544 | To completely disable these expansions, you can use -G flag. |
|
545 | 545 | |
|
546 | 546 | On Windows systems, the use of single quotes `'` when specifying |
|
547 | 547 | a file is not supported. Use double quotes `"`. |
|
548 | 548 | |
|
549 | 549 | Options: |
|
550 | 550 | |
|
551 | 551 | -n |
|
552 | 552 | __name__ is NOT set to '__main__', but to the running file's name |
|
553 | 553 | without extension (as python does under import). This allows running |
|
554 | 554 | scripts and reloading the definitions in them without calling code |
|
555 | 555 | protected by an ``if __name__ == "__main__"`` clause. |
|
556 | 556 | |
|
557 | 557 | -i |
|
558 | 558 | run the file in IPython's namespace instead of an empty one. This |
|
559 | 559 | is useful if you are experimenting with code written in a text editor |
|
560 | 560 | which depends on variables defined interactively. |
|
561 | 561 | |
|
562 | 562 | -e |
|
563 | 563 | ignore sys.exit() calls or SystemExit exceptions in the script |
|
564 | 564 | being run. This is particularly useful if IPython is being used to |
|
565 | 565 | run unittests, which always exit with a sys.exit() call. In such |
|
566 | 566 | cases you are interested in the output of the test results, not in |
|
567 | 567 | seeing a traceback of the unittest module. |
|
568 | 568 | |
|
569 | 569 | -t |
|
570 | 570 | print timing information at the end of the run. IPython will give |
|
571 | 571 | you an estimated CPU time consumption for your script, which under |
|
572 | 572 | Unix uses the resource module to avoid the wraparound problems of |
|
573 | 573 | time.clock(). Under Unix, an estimate of time spent on system tasks |
|
574 | 574 | is also given (for Windows platforms this is reported as 0.0). |
|
575 | 575 | |
|
576 | 576 | If -t is given, an additional ``-N<N>`` option can be given, where <N> |
|
577 | 577 | must be an integer indicating how many times you want the script to |
|
578 | 578 | run. The final timing report will include total and per run results. |
|
579 | 579 | |
|
580 | 580 | For example (testing the script uniq_stable.py):: |
|
581 | 581 | |
|
582 | 582 | In [1]: run -t uniq_stable |
|
583 | 583 | |
|
584 | 584 | IPython CPU timings (estimated): |
|
585 | 585 | User : 0.19597 s. |
|
586 | 586 | System: 0.0 s. |
|
587 | 587 | |
|
588 | 588 | In [2]: run -t -N5 uniq_stable |
|
589 | 589 | |
|
590 | 590 | IPython CPU timings (estimated): |
|
591 | 591 | Total runs performed: 5 |
|
592 | 592 | Times : Total Per run |
|
593 | 593 | User : 0.910862 s, 0.1821724 s. |
|
594 | 594 | System: 0.0 s, 0.0 s. |
|
595 | 595 | |
|
596 | 596 | -d |
|
597 | 597 | run your program under the control of pdb, the Python debugger. |
|
598 | 598 | This allows you to execute your program step by step, watch variables, |
|
599 | 599 | etc. Internally, what IPython does is similar to calling:: |
|
600 | 600 | |
|
601 | 601 | pdb.run('execfile("YOURFILENAME")') |
|
602 | 602 | |
|
603 | 603 | with a breakpoint set on line 1 of your file. You can change the line |
|
604 | 604 | number for this automatic breakpoint to be <N> by using the -bN option |
|
605 | 605 | (where N must be an integer). For example:: |
|
606 | 606 | |
|
607 | 607 | %run -d -b40 myscript |
|
608 | 608 | |
|
609 | 609 | will set the first breakpoint at line 40 in myscript.py. Note that |
|
610 | 610 | the first breakpoint must be set on a line which actually does |
|
611 | 611 | something (not a comment or docstring) for it to stop execution. |
|
612 | 612 | |
|
613 | 613 | Or you can specify a breakpoint in a different file:: |
|
614 | 614 | |
|
615 | 615 | %run -d -b myotherfile.py:20 myscript |
|
616 | 616 | |
|
617 | 617 | When the pdb debugger starts, you will see a (Pdb) prompt. You must |
|
618 | 618 | first enter 'c' (without quotes) to start execution up to the first |
|
619 | 619 | breakpoint. |
|
620 | 620 | |
|
621 | 621 | Entering 'help' gives information about the use of the debugger. You |
|
622 | 622 | can easily see pdb's full documentation with "import pdb;pdb.help()" |
|
623 | 623 | at a prompt. |
|
624 | 624 | |
|
625 | 625 | -p |
|
626 | 626 | run program under the control of the Python profiler module (which |
|
627 | 627 | prints a detailed report of execution times, function calls, etc). |
|
628 | 628 | |
|
629 | 629 | You can pass other options after -p which affect the behavior of the |
|
630 | 630 | profiler itself. See the docs for %prun for details. |
|
631 | 631 | |
|
632 | 632 | In this mode, the program's variables do NOT propagate back to the |
|
633 | 633 | IPython interactive namespace (because they remain in the namespace |
|
634 | 634 | where the profiler executes them). |
|
635 | 635 | |
|
636 | 636 | Internally this triggers a call to %prun, see its documentation for |
|
637 | 637 | details on the options available specifically for profiling. |
|
638 | 638 | |
|
639 | 639 | There is one special usage for which the text above doesn't apply: |
|
640 | 640 | if the filename ends with .ipy[nb], the file is run as ipython script, |
|
641 | 641 | just as if the commands were written on IPython prompt. |
|
642 | 642 | |
|
643 | 643 | -m |
|
644 | 644 | specify module name to load instead of script path. Similar to |
|
645 | 645 | the -m option for the python interpreter. Use this option last if you |
|
646 | 646 | want to combine with other %run options. Unlike the python interpreter |
|
647 | 647 | only source modules are allowed no .pyc or .pyo files. |
|
648 | 648 | For example:: |
|
649 | 649 | |
|
650 | 650 | %run -m example |
|
651 | 651 | |
|
652 | 652 | will run the example module. |
|
653 | 653 | |
|
654 | 654 | -G |
|
655 | 655 | disable shell-like glob expansion of arguments. |
|
656 | 656 | |
|
657 | 657 | """ |
|
658 | 658 | |
|
659 | 659 | # Logic to handle issue #3664 |
|
660 | 660 | # Add '--' after '-m <module_name>' to ignore additional args passed to a module. |
|
661 | 661 | if '-m' in parameter_s and '--' not in parameter_s: |
|
662 | 662 | argv = shlex.split(parameter_s, posix=(os.name == 'posix')) |
|
663 | 663 | for idx, arg in enumerate(argv): |
|
664 | 664 | if arg and arg.startswith('-') and arg != '-': |
|
665 | 665 | if arg == '-m': |
|
666 | 666 | argv.insert(idx + 2, '--') |
|
667 | 667 | break |
|
668 | 668 | else: |
|
669 | 669 | # Positional arg, break |
|
670 | 670 | break |
|
671 | 671 | parameter_s = ' '.join(shlex.quote(arg) for arg in argv) |
|
672 | 672 | |
|
673 | 673 | # get arguments and set sys.argv for program to be run. |
|
674 | 674 | opts, arg_lst = self.parse_options(parameter_s, |
|
675 | 675 | 'nidtN:b:pD:l:rs:T:em:G', |
|
676 | 676 | mode='list', list_all=1) |
|
677 | 677 | if "m" in opts: |
|
678 | 678 | modulename = opts["m"][0] |
|
679 | 679 | modpath = find_mod(modulename) |
|
680 | 680 | if modpath is None: |
|
681 | 681 | msg = '%r is not a valid modulename on sys.path'%modulename |
|
682 | 682 | raise Exception(msg) |
|
683 | 683 | arg_lst = [modpath] + arg_lst |
|
684 | 684 | try: |
|
685 | 685 | fpath = None # initialize to make sure fpath is in scope later |
|
686 | 686 | fpath = arg_lst[0] |
|
687 | 687 | filename = file_finder(fpath) |
|
688 | 688 | except IndexError as e: |
|
689 | 689 | msg = 'you must provide at least a filename.' |
|
690 | 690 | raise Exception(msg) from e |
|
691 | 691 | except IOError as e: |
|
692 | 692 | try: |
|
693 | 693 | msg = str(e) |
|
694 | 694 | except UnicodeError: |
|
695 | 695 | msg = e.message |
|
696 | 696 | if os.name == 'nt' and re.match(r"^'.*'$",fpath): |
|
697 | 697 | warn('For Windows, use double quotes to wrap a filename: %run "mypath\\myfile.py"') |
|
698 | 698 | raise Exception(msg) from e |
|
699 | 699 | except TypeError: |
|
700 | 700 | if fpath in sys.meta_path: |
|
701 | 701 | filename = "" |
|
702 | 702 | else: |
|
703 | 703 | raise |
|
704 | 704 | |
|
705 | 705 | if filename.lower().endswith(('.ipy', '.ipynb')): |
|
706 | 706 | with preserve_keys(self.shell.user_ns, '__file__'): |
|
707 | 707 | self.shell.user_ns['__file__'] = filename |
|
708 | 708 | self.shell.safe_execfile_ipy(filename, raise_exceptions=True) |
|
709 | 709 | return |
|
710 | 710 | |
|
711 | 711 | # Control the response to exit() calls made by the script being run |
|
712 | 712 | exit_ignore = 'e' in opts |
|
713 | 713 | |
|
714 | 714 | # Make sure that the running script gets a proper sys.argv as if it |
|
715 | 715 | # were run from a system shell. |
|
716 | 716 | save_argv = sys.argv # save it for later restoring |
|
717 | 717 | |
|
718 | 718 | if 'G' in opts: |
|
719 | 719 | args = arg_lst[1:] |
|
720 | 720 | else: |
|
721 | 721 | # tilde and glob expansion |
|
722 | 722 | args = shellglob(map(os.path.expanduser, arg_lst[1:])) |
|
723 | 723 | |
|
724 | 724 | sys.argv = [filename] + args # put in the proper filename |
|
725 | 725 | |
|
726 | 726 | if 'n' in opts: |
|
727 |
name = |
|
|
727 | name = Path(filename).stem | |
|
728 | 728 | else: |
|
729 | 729 | name = '__main__' |
|
730 | 730 | |
|
731 | 731 | if 'i' in opts: |
|
732 | 732 | # Run in user's interactive namespace |
|
733 | 733 | prog_ns = self.shell.user_ns |
|
734 | 734 | __name__save = self.shell.user_ns['__name__'] |
|
735 | 735 | prog_ns['__name__'] = name |
|
736 | 736 | main_mod = self.shell.user_module |
|
737 | 737 | |
|
738 | 738 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must |
|
739 | 739 | # set the __file__ global in the script's namespace |
|
740 | 740 | # TK: Is this necessary in interactive mode? |
|
741 | 741 | prog_ns['__file__'] = filename |
|
742 | 742 | else: |
|
743 | 743 | # Run in a fresh, empty namespace |
|
744 | 744 | |
|
745 | 745 | # The shell MUST hold a reference to prog_ns so after %run |
|
746 | 746 | # exits, the python deletion mechanism doesn't zero it out |
|
747 | 747 | # (leaving dangling references). See interactiveshell for details |
|
748 | 748 | main_mod = self.shell.new_main_mod(filename, name) |
|
749 | 749 | prog_ns = main_mod.__dict__ |
|
750 | 750 | |
|
751 | 751 | # pickle fix. See interactiveshell for an explanation. But we need to |
|
752 | 752 | # make sure that, if we overwrite __main__, we replace it at the end |
|
753 | 753 | main_mod_name = prog_ns['__name__'] |
|
754 | 754 | |
|
755 | 755 | if main_mod_name == '__main__': |
|
756 | 756 | restore_main = sys.modules['__main__'] |
|
757 | 757 | else: |
|
758 | 758 | restore_main = False |
|
759 | 759 | |
|
760 | 760 | # This needs to be undone at the end to prevent holding references to |
|
761 | 761 | # every single object ever created. |
|
762 | 762 | sys.modules[main_mod_name] = main_mod |
|
763 | 763 | |
|
764 | 764 | if 'p' in opts or 'd' in opts: |
|
765 | 765 | if 'm' in opts: |
|
766 | 766 | code = 'run_module(modulename, prog_ns)' |
|
767 | 767 | code_ns = { |
|
768 | 768 | 'run_module': self.shell.safe_run_module, |
|
769 | 769 | 'prog_ns': prog_ns, |
|
770 | 770 | 'modulename': modulename, |
|
771 | 771 | } |
|
772 | 772 | else: |
|
773 | 773 | if 'd' in opts: |
|
774 | 774 | # allow exceptions to raise in debug mode |
|
775 | 775 | code = 'execfile(filename, prog_ns, raise_exceptions=True)' |
|
776 | 776 | else: |
|
777 | 777 | code = 'execfile(filename, prog_ns)' |
|
778 | 778 | code_ns = { |
|
779 | 779 | 'execfile': self.shell.safe_execfile, |
|
780 | 780 | 'prog_ns': prog_ns, |
|
781 | 781 | 'filename': get_py_filename(filename), |
|
782 | 782 | } |
|
783 | 783 | |
|
784 | 784 | try: |
|
785 | 785 | stats = None |
|
786 | 786 | if 'p' in opts: |
|
787 | 787 | stats = self._run_with_profiler(code, opts, code_ns) |
|
788 | 788 | else: |
|
789 | 789 | if 'd' in opts: |
|
790 | 790 | bp_file, bp_line = parse_breakpoint( |
|
791 | 791 | opts.get('b', ['1'])[0], filename) |
|
792 | 792 | self._run_with_debugger( |
|
793 | 793 | code, code_ns, filename, bp_line, bp_file) |
|
794 | 794 | else: |
|
795 | 795 | if 'm' in opts: |
|
796 | 796 | def run(): |
|
797 | 797 | self.shell.safe_run_module(modulename, prog_ns) |
|
798 | 798 | else: |
|
799 | 799 | if runner is None: |
|
800 | 800 | runner = self.default_runner |
|
801 | 801 | if runner is None: |
|
802 | 802 | runner = self.shell.safe_execfile |
|
803 | 803 | |
|
804 | 804 | def run(): |
|
805 | 805 | runner(filename, prog_ns, prog_ns, |
|
806 | 806 | exit_ignore=exit_ignore) |
|
807 | 807 | |
|
808 | 808 | if 't' in opts: |
|
809 | 809 | # timed execution |
|
810 | 810 | try: |
|
811 | 811 | nruns = int(opts['N'][0]) |
|
812 | 812 | if nruns < 1: |
|
813 | 813 | error('Number of runs must be >=1') |
|
814 | 814 | return |
|
815 | 815 | except (KeyError): |
|
816 | 816 | nruns = 1 |
|
817 | 817 | self._run_with_timing(run, nruns) |
|
818 | 818 | else: |
|
819 | 819 | # regular execution |
|
820 | 820 | run() |
|
821 | 821 | |
|
822 | 822 | if 'i' in opts: |
|
823 | 823 | self.shell.user_ns['__name__'] = __name__save |
|
824 | 824 | else: |
|
825 | 825 | # update IPython interactive namespace |
|
826 | 826 | |
|
827 | 827 | # Some forms of read errors on the file may mean the |
|
828 | 828 | # __name__ key was never set; using pop we don't have to |
|
829 | 829 | # worry about a possible KeyError. |
|
830 | 830 | prog_ns.pop('__name__', None) |
|
831 | 831 | |
|
832 | 832 | with preserve_keys(self.shell.user_ns, '__file__'): |
|
833 | 833 | self.shell.user_ns.update(prog_ns) |
|
834 | 834 | finally: |
|
835 | 835 | # It's a bit of a mystery why, but __builtins__ can change from |
|
836 | 836 | # being a module to becoming a dict missing some key data after |
|
837 | 837 | # %run. As best I can see, this is NOT something IPython is doing |
|
838 | 838 | # at all, and similar problems have been reported before: |
|
839 | 839 | # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html |
|
840 | 840 | # Since this seems to be done by the interpreter itself, the best |
|
841 | 841 | # we can do is to at least restore __builtins__ for the user on |
|
842 | 842 | # exit. |
|
843 | 843 | self.shell.user_ns['__builtins__'] = builtin_mod |
|
844 | 844 | |
|
845 | 845 | # Ensure key global structures are restored |
|
846 | 846 | sys.argv = save_argv |
|
847 | 847 | if restore_main: |
|
848 | 848 | sys.modules['__main__'] = restore_main |
|
849 | 849 | if '__mp_main__' in sys.modules: |
|
850 | 850 | sys.modules['__mp_main__'] = restore_main |
|
851 | 851 | else: |
|
852 | 852 | # Remove from sys.modules the reference to main_mod we'd |
|
853 | 853 | # added. Otherwise it will trap references to objects |
|
854 | 854 | # contained therein. |
|
855 | 855 | del sys.modules[main_mod_name] |
|
856 | 856 | |
|
857 | 857 | return stats |
|
858 | 858 | |
|
859 | 859 | def _run_with_debugger(self, code, code_ns, filename=None, |
|
860 | 860 | bp_line=None, bp_file=None): |
|
861 | 861 | """ |
|
862 | 862 | Run `code` in debugger with a break point. |
|
863 | 863 | |
|
864 | 864 | Parameters |
|
865 | 865 | ---------- |
|
866 | 866 | code : str |
|
867 | 867 | Code to execute. |
|
868 | 868 | code_ns : dict |
|
869 | 869 | A namespace in which `code` is executed. |
|
870 | 870 | filename : str |
|
871 | 871 | `code` is ran as if it is in `filename`. |
|
872 | 872 | bp_line : int, optional |
|
873 | 873 | Line number of the break point. |
|
874 | 874 | bp_file : str, optional |
|
875 | 875 | Path to the file in which break point is specified. |
|
876 | 876 | `filename` is used if not given. |
|
877 | 877 | |
|
878 | 878 | Raises |
|
879 | 879 | ------ |
|
880 | 880 | UsageError |
|
881 | 881 | If the break point given by `bp_line` is not valid. |
|
882 | 882 | |
|
883 | 883 | """ |
|
884 | 884 | deb = self.shell.InteractiveTB.pdb |
|
885 | 885 | if not deb: |
|
886 | 886 | self.shell.InteractiveTB.pdb = self.shell.InteractiveTB.debugger_cls() |
|
887 | 887 | deb = self.shell.InteractiveTB.pdb |
|
888 | 888 | |
|
889 | 889 | # deb.checkline() fails if deb.curframe exists but is None; it can |
|
890 | 890 | # handle it not existing. https://github.com/ipython/ipython/issues/10028 |
|
891 | 891 | if hasattr(deb, 'curframe'): |
|
892 | 892 | del deb.curframe |
|
893 | 893 | |
|
894 | 894 | # reset Breakpoint state, which is moronically kept |
|
895 | 895 | # in a class |
|
896 | 896 | bdb.Breakpoint.next = 1 |
|
897 | 897 | bdb.Breakpoint.bplist = {} |
|
898 | 898 | bdb.Breakpoint.bpbynumber = [None] |
|
899 | 899 | deb.clear_all_breaks() |
|
900 | 900 | if bp_line is not None: |
|
901 | 901 | # Set an initial breakpoint to stop execution |
|
902 | 902 | maxtries = 10 |
|
903 | 903 | bp_file = bp_file or filename |
|
904 | 904 | checkline = deb.checkline(bp_file, bp_line) |
|
905 | 905 | if not checkline: |
|
906 | 906 | for bp in range(bp_line + 1, bp_line + maxtries + 1): |
|
907 | 907 | if deb.checkline(bp_file, bp): |
|
908 | 908 | break |
|
909 | 909 | else: |
|
910 | 910 | msg = ("\nI failed to find a valid line to set " |
|
911 | 911 | "a breakpoint\n" |
|
912 | 912 | "after trying up to line: %s.\n" |
|
913 | 913 | "Please set a valid breakpoint manually " |
|
914 | 914 | "with the -b option." % bp) |
|
915 | 915 | raise UsageError(msg) |
|
916 | 916 | # if we find a good linenumber, set the breakpoint |
|
917 | 917 | deb.do_break('%s:%s' % (bp_file, bp_line)) |
|
918 | 918 | |
|
919 | 919 | if filename: |
|
920 | 920 | # Mimic Pdb._runscript(...) |
|
921 | 921 | deb._wait_for_mainpyfile = True |
|
922 | 922 | deb.mainpyfile = deb.canonic(filename) |
|
923 | 923 | |
|
924 | 924 | # Start file run |
|
925 | 925 | print("NOTE: Enter 'c' at the %s prompt to continue execution." % deb.prompt) |
|
926 | 926 | try: |
|
927 | 927 | if filename: |
|
928 | 928 | # save filename so it can be used by methods on the deb object |
|
929 | 929 | deb._exec_filename = filename |
|
930 | 930 | while True: |
|
931 | 931 | try: |
|
932 | 932 | trace = sys.gettrace() |
|
933 | 933 | deb.run(code, code_ns) |
|
934 | 934 | except Restart: |
|
935 | 935 | print("Restarting") |
|
936 | 936 | if filename: |
|
937 | 937 | deb._wait_for_mainpyfile = True |
|
938 | 938 | deb.mainpyfile = deb.canonic(filename) |
|
939 | 939 | continue |
|
940 | 940 | else: |
|
941 | 941 | break |
|
942 | 942 | finally: |
|
943 | 943 | sys.settrace(trace) |
|
944 | 944 | |
|
945 | 945 | |
|
946 | 946 | except: |
|
947 | 947 | etype, value, tb = sys.exc_info() |
|
948 | 948 | # Skip three frames in the traceback: the %run one, |
|
949 | 949 | # one inside bdb.py, and the command-line typed by the |
|
950 | 950 | # user (run by exec in pdb itself). |
|
951 | 951 | self.shell.InteractiveTB(etype, value, tb, tb_offset=3) |
|
952 | 952 | |
|
953 | 953 | @staticmethod |
|
954 | 954 | def _run_with_timing(run, nruns): |
|
955 | 955 | """ |
|
956 | 956 | Run function `run` and print timing information. |
|
957 | 957 | |
|
958 | 958 | Parameters |
|
959 | 959 | ---------- |
|
960 | 960 | run : callable |
|
961 | 961 | Any callable object which takes no argument. |
|
962 | 962 | nruns : int |
|
963 | 963 | Number of times to execute `run`. |
|
964 | 964 | |
|
965 | 965 | """ |
|
966 | 966 | twall0 = time.perf_counter() |
|
967 | 967 | if nruns == 1: |
|
968 | 968 | t0 = clock2() |
|
969 | 969 | run() |
|
970 | 970 | t1 = clock2() |
|
971 | 971 | t_usr = t1[0] - t0[0] |
|
972 | 972 | t_sys = t1[1] - t0[1] |
|
973 | 973 | print("\nIPython CPU timings (estimated):") |
|
974 | 974 | print(" User : %10.2f s." % t_usr) |
|
975 | 975 | print(" System : %10.2f s." % t_sys) |
|
976 | 976 | else: |
|
977 | 977 | runs = range(nruns) |
|
978 | 978 | t0 = clock2() |
|
979 | 979 | for nr in runs: |
|
980 | 980 | run() |
|
981 | 981 | t1 = clock2() |
|
982 | 982 | t_usr = t1[0] - t0[0] |
|
983 | 983 | t_sys = t1[1] - t0[1] |
|
984 | 984 | print("\nIPython CPU timings (estimated):") |
|
985 | 985 | print("Total runs performed:", nruns) |
|
986 | 986 | print(" Times : %10s %10s" % ('Total', 'Per run')) |
|
987 | 987 | print(" User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)) |
|
988 | 988 | print(" System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)) |
|
989 | 989 | twall1 = time.perf_counter() |
|
990 | 990 | print("Wall time: %10.2f s." % (twall1 - twall0)) |
|
991 | 991 | |
|
992 | 992 | @skip_doctest |
|
993 | 993 | @no_var_expand |
|
994 | 994 | @line_cell_magic |
|
995 | 995 | @needs_local_scope |
|
996 | 996 | def timeit(self, line='', cell=None, local_ns=None): |
|
997 | 997 | """Time execution of a Python statement or expression |
|
998 | 998 | |
|
999 | 999 | Usage, in line mode: |
|
1000 | 1000 | %timeit [-n<N> -r<R> [-t|-c] -q -p<P> -o] statement |
|
1001 | 1001 | or in cell mode: |
|
1002 | 1002 | %%timeit [-n<N> -r<R> [-t|-c] -q -p<P> -o] setup_code |
|
1003 | 1003 | code |
|
1004 | 1004 | code... |
|
1005 | 1005 | |
|
1006 | 1006 | Time execution of a Python statement or expression using the timeit |
|
1007 | 1007 | module. This function can be used both as a line and cell magic: |
|
1008 | 1008 | |
|
1009 | 1009 | - In line mode you can time a single-line statement (though multiple |
|
1010 | 1010 | ones can be chained with using semicolons). |
|
1011 | 1011 | |
|
1012 | 1012 | - In cell mode, the statement in the first line is used as setup code |
|
1013 | 1013 | (executed but not timed) and the body of the cell is timed. The cell |
|
1014 | 1014 | body has access to any variables created in the setup code. |
|
1015 | 1015 | |
|
1016 | 1016 | Options: |
|
1017 | 1017 | -n<N>: execute the given statement <N> times in a loop. If <N> is not |
|
1018 | 1018 | provided, <N> is determined so as to get sufficient accuracy. |
|
1019 | 1019 | |
|
1020 | 1020 | -r<R>: number of repeats <R>, each consisting of <N> loops, and take the |
|
1021 | 1021 | best result. |
|
1022 | 1022 | Default: 7 |
|
1023 | 1023 | |
|
1024 | 1024 | -t: use time.time to measure the time, which is the default on Unix. |
|
1025 | 1025 | This function measures wall time. |
|
1026 | 1026 | |
|
1027 | 1027 | -c: use time.clock to measure the time, which is the default on |
|
1028 | 1028 | Windows and measures wall time. On Unix, resource.getrusage is used |
|
1029 | 1029 | instead and returns the CPU user time. |
|
1030 | 1030 | |
|
1031 | 1031 | -p<P>: use a precision of <P> digits to display the timing result. |
|
1032 | 1032 | Default: 3 |
|
1033 | 1033 | |
|
1034 | 1034 | -q: Quiet, do not print result. |
|
1035 | 1035 | |
|
1036 | 1036 | -o: return a TimeitResult that can be stored in a variable to inspect |
|
1037 | 1037 | the result in more details. |
|
1038 | 1038 | |
|
1039 | 1039 | .. versionchanged:: 7.3 |
|
1040 | 1040 | User variables are no longer expanded, |
|
1041 | 1041 | the magic line is always left unmodified. |
|
1042 | 1042 | |
|
1043 | 1043 | Examples |
|
1044 | 1044 | -------- |
|
1045 | 1045 | :: |
|
1046 | 1046 | |
|
1047 | 1047 | In [1]: %timeit pass |
|
1048 | 1048 | 8.26 ns Β± 0.12 ns per loop (mean Β± std. dev. of 7 runs, 100000000 loops each) |
|
1049 | 1049 | |
|
1050 | 1050 | In [2]: u = None |
|
1051 | 1051 | |
|
1052 | 1052 | In [3]: %timeit u is None |
|
1053 | 1053 | 29.9 ns Β± 0.643 ns per loop (mean Β± std. dev. of 7 runs, 10000000 loops each) |
|
1054 | 1054 | |
|
1055 | 1055 | In [4]: %timeit -r 4 u == None |
|
1056 | 1056 | |
|
1057 | 1057 | In [5]: import time |
|
1058 | 1058 | |
|
1059 | 1059 | In [6]: %timeit -n1 time.sleep(2) |
|
1060 | 1060 | |
|
1061 | 1061 | |
|
1062 | 1062 | The times reported by %timeit will be slightly higher than those |
|
1063 | 1063 | reported by the timeit.py script when variables are accessed. This is |
|
1064 | 1064 | due to the fact that %timeit executes the statement in the namespace |
|
1065 | 1065 | of the shell, compared with timeit.py, which uses a single setup |
|
1066 | 1066 | statement to import function or create variables. Generally, the bias |
|
1067 | 1067 | does not matter as long as results from timeit.py are not mixed with |
|
1068 | 1068 | those from %timeit.""" |
|
1069 | 1069 | |
|
1070 | 1070 | opts, stmt = self.parse_options(line,'n:r:tcp:qo', |
|
1071 | 1071 | posix=False, strict=False) |
|
1072 | 1072 | if stmt == "" and cell is None: |
|
1073 | 1073 | return |
|
1074 | 1074 | |
|
1075 | 1075 | timefunc = timeit.default_timer |
|
1076 | 1076 | number = int(getattr(opts, "n", 0)) |
|
1077 | 1077 | default_repeat = 7 if timeit.default_repeat < 7 else timeit.default_repeat |
|
1078 | 1078 | repeat = int(getattr(opts, "r", default_repeat)) |
|
1079 | 1079 | precision = int(getattr(opts, "p", 3)) |
|
1080 | 1080 | quiet = 'q' in opts |
|
1081 | 1081 | return_result = 'o' in opts |
|
1082 | 1082 | if hasattr(opts, "t"): |
|
1083 | 1083 | timefunc = time.time |
|
1084 | 1084 | if hasattr(opts, "c"): |
|
1085 | 1085 | timefunc = clock |
|
1086 | 1086 | |
|
1087 | 1087 | timer = Timer(timer=timefunc) |
|
1088 | 1088 | # this code has tight coupling to the inner workings of timeit.Timer, |
|
1089 | 1089 | # but is there a better way to achieve that the code stmt has access |
|
1090 | 1090 | # to the shell namespace? |
|
1091 | 1091 | transform = self.shell.transform_cell |
|
1092 | 1092 | |
|
1093 | 1093 | if cell is None: |
|
1094 | 1094 | # called as line magic |
|
1095 | 1095 | ast_setup = self.shell.compile.ast_parse("pass") |
|
1096 | 1096 | ast_stmt = self.shell.compile.ast_parse(transform(stmt)) |
|
1097 | 1097 | else: |
|
1098 | 1098 | ast_setup = self.shell.compile.ast_parse(transform(stmt)) |
|
1099 | 1099 | ast_stmt = self.shell.compile.ast_parse(transform(cell)) |
|
1100 | 1100 | |
|
1101 | 1101 | ast_setup = self.shell.transform_ast(ast_setup) |
|
1102 | 1102 | ast_stmt = self.shell.transform_ast(ast_stmt) |
|
1103 | 1103 | |
|
1104 | 1104 | # Check that these compile to valid Python code *outside* the timer func |
|
1105 | 1105 | # Invalid code may become valid when put inside the function & loop, |
|
1106 | 1106 | # which messes up error messages. |
|
1107 | 1107 | # https://github.com/ipython/ipython/issues/10636 |
|
1108 | 1108 | self.shell.compile(ast_setup, "<magic-timeit-setup>", "exec") |
|
1109 | 1109 | self.shell.compile(ast_stmt, "<magic-timeit-stmt>", "exec") |
|
1110 | 1110 | |
|
1111 | 1111 | # This codestring is taken from timeit.template - we fill it in as an |
|
1112 | 1112 | # AST, so that we can apply our AST transformations to the user code |
|
1113 | 1113 | # without affecting the timing code. |
|
1114 | 1114 | timeit_ast_template = ast.parse('def inner(_it, _timer):\n' |
|
1115 | 1115 | ' setup\n' |
|
1116 | 1116 | ' _t0 = _timer()\n' |
|
1117 | 1117 | ' for _i in _it:\n' |
|
1118 | 1118 | ' stmt\n' |
|
1119 | 1119 | ' _t1 = _timer()\n' |
|
1120 | 1120 | ' return _t1 - _t0\n') |
|
1121 | 1121 | |
|
1122 | 1122 | timeit_ast = TimeitTemplateFiller(ast_setup, ast_stmt).visit(timeit_ast_template) |
|
1123 | 1123 | timeit_ast = ast.fix_missing_locations(timeit_ast) |
|
1124 | 1124 | |
|
1125 | 1125 | # Track compilation time so it can be reported if too long |
|
1126 | 1126 | # Minimum time above which compilation time will be reported |
|
1127 | 1127 | tc_min = 0.1 |
|
1128 | 1128 | |
|
1129 | 1129 | t0 = clock() |
|
1130 | 1130 | code = self.shell.compile(timeit_ast, "<magic-timeit>", "exec") |
|
1131 | 1131 | tc = clock()-t0 |
|
1132 | 1132 | |
|
1133 | 1133 | ns = {} |
|
1134 | 1134 | glob = self.shell.user_ns |
|
1135 | 1135 | # handles global vars with same name as local vars. We store them in conflict_globs. |
|
1136 | 1136 | conflict_globs = {} |
|
1137 | 1137 | if local_ns and cell is None: |
|
1138 | 1138 | for var_name, var_val in glob.items(): |
|
1139 | 1139 | if var_name in local_ns: |
|
1140 | 1140 | conflict_globs[var_name] = var_val |
|
1141 | 1141 | glob.update(local_ns) |
|
1142 | 1142 | |
|
1143 | 1143 | exec(code, glob, ns) |
|
1144 | 1144 | timer.inner = ns["inner"] |
|
1145 | 1145 | |
|
1146 | 1146 | # This is used to check if there is a huge difference between the |
|
1147 | 1147 | # best and worst timings. |
|
1148 | 1148 | # Issue: https://github.com/ipython/ipython/issues/6471 |
|
1149 | 1149 | if number == 0: |
|
1150 | 1150 | # determine number so that 0.2 <= total time < 2.0 |
|
1151 | 1151 | for index in range(0, 10): |
|
1152 | 1152 | number = 10 ** index |
|
1153 | 1153 | time_number = timer.timeit(number) |
|
1154 | 1154 | if time_number >= 0.2: |
|
1155 | 1155 | break |
|
1156 | 1156 | |
|
1157 | 1157 | all_runs = timer.repeat(repeat, number) |
|
1158 | 1158 | best = min(all_runs) / number |
|
1159 | 1159 | worst = max(all_runs) / number |
|
1160 | 1160 | timeit_result = TimeitResult(number, repeat, best, worst, all_runs, tc, precision) |
|
1161 | 1161 | |
|
1162 | 1162 | # Restore global vars from conflict_globs |
|
1163 | 1163 | if conflict_globs: |
|
1164 | 1164 | glob.update(conflict_globs) |
|
1165 | 1165 | |
|
1166 | 1166 | if not quiet : |
|
1167 | 1167 | # Check best timing is greater than zero to avoid a |
|
1168 | 1168 | # ZeroDivisionError. |
|
1169 | 1169 | # In cases where the slowest timing is lesser than a microsecond |
|
1170 | 1170 | # we assume that it does not really matter if the fastest |
|
1171 | 1171 | # timing is 4 times faster than the slowest timing or not. |
|
1172 | 1172 | if worst > 4 * best and best > 0 and worst > 1e-6: |
|
1173 | 1173 | print("The slowest run took %0.2f times longer than the " |
|
1174 | 1174 | "fastest. This could mean that an intermediate result " |
|
1175 | 1175 | "is being cached." % (worst / best)) |
|
1176 | 1176 | |
|
1177 | 1177 | print( timeit_result ) |
|
1178 | 1178 | |
|
1179 | 1179 | if tc > tc_min: |
|
1180 | 1180 | print("Compiler time: %.2f s" % tc) |
|
1181 | 1181 | if return_result: |
|
1182 | 1182 | return timeit_result |
|
1183 | 1183 | |
|
1184 | 1184 | @skip_doctest |
|
1185 | 1185 | @no_var_expand |
|
1186 | 1186 | @needs_local_scope |
|
1187 | 1187 | @line_cell_magic |
|
1188 | 1188 | def time(self,line='', cell=None, local_ns=None): |
|
1189 | 1189 | """Time execution of a Python statement or expression. |
|
1190 | 1190 | |
|
1191 | 1191 | The CPU and wall clock times are printed, and the value of the |
|
1192 | 1192 | expression (if any) is returned. Note that under Win32, system time |
|
1193 | 1193 | is always reported as 0, since it can not be measured. |
|
1194 | 1194 | |
|
1195 | 1195 | This function can be used both as a line and cell magic: |
|
1196 | 1196 | |
|
1197 | 1197 | - In line mode you can time a single-line statement (though multiple |
|
1198 | 1198 | ones can be chained with using semicolons). |
|
1199 | 1199 | |
|
1200 | 1200 | - In cell mode, you can time the cell body (a directly |
|
1201 | 1201 | following statement raises an error). |
|
1202 | 1202 | |
|
1203 | 1203 | This function provides very basic timing functionality. Use the timeit |
|
1204 | 1204 | magic for more control over the measurement. |
|
1205 | 1205 | |
|
1206 | 1206 | .. versionchanged:: 7.3 |
|
1207 | 1207 | User variables are no longer expanded, |
|
1208 | 1208 | the magic line is always left unmodified. |
|
1209 | 1209 | |
|
1210 | 1210 | Examples |
|
1211 | 1211 | -------- |
|
1212 | 1212 | :: |
|
1213 | 1213 | |
|
1214 | 1214 | In [1]: %time 2**128 |
|
1215 | 1215 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1216 | 1216 | Wall time: 0.00 |
|
1217 | 1217 | Out[1]: 340282366920938463463374607431768211456L |
|
1218 | 1218 | |
|
1219 | 1219 | In [2]: n = 1000000 |
|
1220 | 1220 | |
|
1221 | 1221 | In [3]: %time sum(range(n)) |
|
1222 | 1222 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s |
|
1223 | 1223 | Wall time: 1.37 |
|
1224 | 1224 | Out[3]: 499999500000L |
|
1225 | 1225 | |
|
1226 | 1226 | In [4]: %time print 'hello world' |
|
1227 | 1227 | hello world |
|
1228 | 1228 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1229 | 1229 | Wall time: 0.00 |
|
1230 | 1230 | |
|
1231 | 1231 | Note that the time needed by Python to compile the given expression |
|
1232 | 1232 | will be reported if it is more than 0.1s. In this example, the |
|
1233 | 1233 | actual exponentiation is done by Python at compilation time, so while |
|
1234 | 1234 | the expression can take a noticeable amount of time to compute, that |
|
1235 | 1235 | time is purely due to the compilation: |
|
1236 | 1236 | |
|
1237 | 1237 | In [5]: %time 3**9999; |
|
1238 | 1238 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1239 | 1239 | Wall time: 0.00 s |
|
1240 | 1240 | |
|
1241 | 1241 | In [6]: %time 3**999999; |
|
1242 | 1242 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1243 | 1243 | Wall time: 0.00 s |
|
1244 | 1244 | Compiler : 0.78 s |
|
1245 | 1245 | """ |
|
1246 | 1246 | |
|
1247 | 1247 | # fail immediately if the given expression can't be compiled |
|
1248 | 1248 | |
|
1249 | 1249 | if line and cell: |
|
1250 | 1250 | raise UsageError("Can't use statement directly after '%%time'!") |
|
1251 | 1251 | |
|
1252 | 1252 | if cell: |
|
1253 | 1253 | expr = self.shell.transform_cell(cell) |
|
1254 | 1254 | else: |
|
1255 | 1255 | expr = self.shell.transform_cell(line) |
|
1256 | 1256 | |
|
1257 | 1257 | # Minimum time above which parse time will be reported |
|
1258 | 1258 | tp_min = 0.1 |
|
1259 | 1259 | |
|
1260 | 1260 | t0 = clock() |
|
1261 | 1261 | expr_ast = self.shell.compile.ast_parse(expr) |
|
1262 | 1262 | tp = clock()-t0 |
|
1263 | 1263 | |
|
1264 | 1264 | # Apply AST transformations |
|
1265 | 1265 | expr_ast = self.shell.transform_ast(expr_ast) |
|
1266 | 1266 | |
|
1267 | 1267 | # Minimum time above which compilation time will be reported |
|
1268 | 1268 | tc_min = 0.1 |
|
1269 | 1269 | |
|
1270 | 1270 | expr_val=None |
|
1271 | 1271 | if len(expr_ast.body)==1 and isinstance(expr_ast.body[0], ast.Expr): |
|
1272 | 1272 | mode = 'eval' |
|
1273 | 1273 | source = '<timed eval>' |
|
1274 | 1274 | expr_ast = ast.Expression(expr_ast.body[0].value) |
|
1275 | 1275 | else: |
|
1276 | 1276 | mode = 'exec' |
|
1277 | 1277 | source = '<timed exec>' |
|
1278 | 1278 | # multi-line %%time case |
|
1279 | 1279 | if len(expr_ast.body) > 1 and isinstance(expr_ast.body[-1], ast.Expr): |
|
1280 | 1280 | expr_val= expr_ast.body[-1] |
|
1281 | 1281 | expr_ast = expr_ast.body[:-1] |
|
1282 | 1282 | expr_ast = Module(expr_ast, []) |
|
1283 | 1283 | expr_val = ast.Expression(expr_val.value) |
|
1284 | 1284 | |
|
1285 | 1285 | t0 = clock() |
|
1286 | 1286 | code = self.shell.compile(expr_ast, source, mode) |
|
1287 | 1287 | tc = clock()-t0 |
|
1288 | 1288 | |
|
1289 | 1289 | # skew measurement as little as possible |
|
1290 | 1290 | glob = self.shell.user_ns |
|
1291 | 1291 | wtime = time.time |
|
1292 | 1292 | # time execution |
|
1293 | 1293 | wall_st = wtime() |
|
1294 | 1294 | if mode=='eval': |
|
1295 | 1295 | st = clock2() |
|
1296 | 1296 | try: |
|
1297 | 1297 | out = eval(code, glob, local_ns) |
|
1298 | 1298 | except: |
|
1299 | 1299 | self.shell.showtraceback() |
|
1300 | 1300 | return |
|
1301 | 1301 | end = clock2() |
|
1302 | 1302 | else: |
|
1303 | 1303 | st = clock2() |
|
1304 | 1304 | try: |
|
1305 | 1305 | exec(code, glob, local_ns) |
|
1306 | 1306 | out=None |
|
1307 | 1307 | # multi-line %%time case |
|
1308 | 1308 | if expr_val is not None: |
|
1309 | 1309 | code_2 = self.shell.compile(expr_val, source, 'eval') |
|
1310 | 1310 | out = eval(code_2, glob, local_ns) |
|
1311 | 1311 | except: |
|
1312 | 1312 | self.shell.showtraceback() |
|
1313 | 1313 | return |
|
1314 | 1314 | end = clock2() |
|
1315 | 1315 | |
|
1316 | 1316 | wall_end = wtime() |
|
1317 | 1317 | # Compute actual times and report |
|
1318 | 1318 | wall_time = wall_end-wall_st |
|
1319 | 1319 | cpu_user = end[0]-st[0] |
|
1320 | 1320 | cpu_sys = end[1]-st[1] |
|
1321 | 1321 | cpu_tot = cpu_user+cpu_sys |
|
1322 | 1322 | # On windows cpu_sys is always zero, so no new information to the next print |
|
1323 | 1323 | if sys.platform != 'win32': |
|
1324 | 1324 | print("CPU times: user %s, sys: %s, total: %s" % \ |
|
1325 | 1325 | (_format_time(cpu_user),_format_time(cpu_sys),_format_time(cpu_tot))) |
|
1326 | 1326 | print("Wall time: %s" % _format_time(wall_time)) |
|
1327 | 1327 | if tc > tc_min: |
|
1328 | 1328 | print("Compiler : %s" % _format_time(tc)) |
|
1329 | 1329 | if tp > tp_min: |
|
1330 | 1330 | print("Parser : %s" % _format_time(tp)) |
|
1331 | 1331 | return out |
|
1332 | 1332 | |
|
1333 | 1333 | @skip_doctest |
|
1334 | 1334 | @line_magic |
|
1335 | 1335 | def macro(self, parameter_s=''): |
|
1336 | 1336 | """Define a macro for future re-execution. It accepts ranges of history, |
|
1337 | 1337 | filenames or string objects. |
|
1338 | 1338 | |
|
1339 | 1339 | Usage:\\ |
|
1340 | 1340 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... |
|
1341 | 1341 | |
|
1342 | 1342 | Options: |
|
1343 | 1343 | |
|
1344 | 1344 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
1345 | 1345 | so that magics are loaded in their transformed version to valid |
|
1346 | 1346 | Python. If this option is given, the raw input as typed at the |
|
1347 | 1347 | command line is used instead. |
|
1348 | 1348 | |
|
1349 | 1349 | -q: quiet macro definition. By default, a tag line is printed |
|
1350 | 1350 | to indicate the macro has been created, and then the contents of |
|
1351 | 1351 | the macro are printed. If this option is given, then no printout |
|
1352 | 1352 | is produced once the macro is created. |
|
1353 | 1353 | |
|
1354 | 1354 | This will define a global variable called `name` which is a string |
|
1355 | 1355 | made of joining the slices and lines you specify (n1,n2,... numbers |
|
1356 | 1356 | above) from your input history into a single string. This variable |
|
1357 | 1357 | acts like an automatic function which re-executes those lines as if |
|
1358 | 1358 | you had typed them. You just type 'name' at the prompt and the code |
|
1359 | 1359 | executes. |
|
1360 | 1360 | |
|
1361 | 1361 | The syntax for indicating input ranges is described in %history. |
|
1362 | 1362 | |
|
1363 | 1363 | Note: as a 'hidden' feature, you can also use traditional python slice |
|
1364 | 1364 | notation, where N:M means numbers N through M-1. |
|
1365 | 1365 | |
|
1366 | 1366 | For example, if your history contains (print using %hist -n ):: |
|
1367 | 1367 | |
|
1368 | 1368 | 44: x=1 |
|
1369 | 1369 | 45: y=3 |
|
1370 | 1370 | 46: z=x+y |
|
1371 | 1371 | 47: print x |
|
1372 | 1372 | 48: a=5 |
|
1373 | 1373 | 49: print 'x',x,'y',y |
|
1374 | 1374 | |
|
1375 | 1375 | you can create a macro with lines 44 through 47 (included) and line 49 |
|
1376 | 1376 | called my_macro with:: |
|
1377 | 1377 | |
|
1378 | 1378 | In [55]: %macro my_macro 44-47 49 |
|
1379 | 1379 | |
|
1380 | 1380 | Now, typing `my_macro` (without quotes) will re-execute all this code |
|
1381 | 1381 | in one pass. |
|
1382 | 1382 | |
|
1383 | 1383 | You don't need to give the line-numbers in order, and any given line |
|
1384 | 1384 | number can appear multiple times. You can assemble macros with any |
|
1385 | 1385 | lines from your input history in any order. |
|
1386 | 1386 | |
|
1387 | 1387 | The macro is a simple object which holds its value in an attribute, |
|
1388 | 1388 | but IPython's display system checks for macros and executes them as |
|
1389 | 1389 | code instead of printing them when you type their name. |
|
1390 | 1390 | |
|
1391 | 1391 | You can view a macro's contents by explicitly printing it with:: |
|
1392 | 1392 | |
|
1393 | 1393 | print macro_name |
|
1394 | 1394 | |
|
1395 | 1395 | """ |
|
1396 | 1396 | opts,args = self.parse_options(parameter_s,'rq',mode='list') |
|
1397 | 1397 | if not args: # List existing macros |
|
1398 | 1398 | return sorted(k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)) |
|
1399 | 1399 | if len(args) == 1: |
|
1400 | 1400 | raise UsageError( |
|
1401 | 1401 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") |
|
1402 | 1402 | name, codefrom = args[0], " ".join(args[1:]) |
|
1403 | 1403 | |
|
1404 | 1404 | #print 'rng',ranges # dbg |
|
1405 | 1405 | try: |
|
1406 | 1406 | lines = self.shell.find_user_code(codefrom, 'r' in opts) |
|
1407 | 1407 | except (ValueError, TypeError) as e: |
|
1408 | 1408 | print(e.args[0]) |
|
1409 | 1409 | return |
|
1410 | 1410 | macro = Macro(lines) |
|
1411 | 1411 | self.shell.define_macro(name, macro) |
|
1412 | 1412 | if not ( 'q' in opts) : |
|
1413 | 1413 | print('Macro `%s` created. To execute, type its name (without quotes).' % name) |
|
1414 | 1414 | print('=== Macro contents: ===') |
|
1415 | 1415 | print(macro, end=' ') |
|
1416 | 1416 | |
|
1417 | 1417 | @magic_arguments.magic_arguments() |
|
1418 | 1418 | @magic_arguments.argument('output', type=str, default='', nargs='?', |
|
1419 | 1419 | help="""The name of the variable in which to store output. |
|
1420 | 1420 | This is a utils.io.CapturedIO object with stdout/err attributes |
|
1421 | 1421 | for the text of the captured output. |
|
1422 | 1422 | |
|
1423 | 1423 | CapturedOutput also has a show() method for displaying the output, |
|
1424 | 1424 | and __call__ as well, so you can use that to quickly display the |
|
1425 | 1425 | output. |
|
1426 | 1426 | |
|
1427 | 1427 | If unspecified, captured output is discarded. |
|
1428 | 1428 | """ |
|
1429 | 1429 | ) |
|
1430 | 1430 | @magic_arguments.argument('--no-stderr', action="store_true", |
|
1431 | 1431 | help="""Don't capture stderr.""" |
|
1432 | 1432 | ) |
|
1433 | 1433 | @magic_arguments.argument('--no-stdout', action="store_true", |
|
1434 | 1434 | help="""Don't capture stdout.""" |
|
1435 | 1435 | ) |
|
1436 | 1436 | @magic_arguments.argument('--no-display', action="store_true", |
|
1437 | 1437 | help="""Don't capture IPython's rich display.""" |
|
1438 | 1438 | ) |
|
1439 | 1439 | @cell_magic |
|
1440 | 1440 | def capture(self, line, cell): |
|
1441 | 1441 | """run the cell, capturing stdout, stderr, and IPython's rich display() calls.""" |
|
1442 | 1442 | args = magic_arguments.parse_argstring(self.capture, line) |
|
1443 | 1443 | out = not args.no_stdout |
|
1444 | 1444 | err = not args.no_stderr |
|
1445 | 1445 | disp = not args.no_display |
|
1446 | 1446 | with capture_output(out, err, disp) as io: |
|
1447 | 1447 | self.shell.run_cell(cell) |
|
1448 | 1448 | if args.output: |
|
1449 | 1449 | self.shell.user_ns[args.output] = io |
|
1450 | 1450 | |
|
1451 | 1451 | def parse_breakpoint(text, current_file): |
|
1452 | 1452 | '''Returns (file, line) for file:line and (current_file, line) for line''' |
|
1453 | 1453 | colon = text.find(':') |
|
1454 | 1454 | if colon == -1: |
|
1455 | 1455 | return current_file, int(text) |
|
1456 | 1456 | else: |
|
1457 | 1457 | return text[:colon], int(text[colon+1:]) |
|
1458 | 1458 | |
|
1459 | 1459 | def _format_time(timespan, precision=3): |
|
1460 | 1460 | """Formats the timespan in a human readable form""" |
|
1461 | 1461 | |
|
1462 | 1462 | if timespan >= 60.0: |
|
1463 | 1463 | # we have more than a minute, format that in a human readable form |
|
1464 | 1464 | # Idea from http://snipplr.com/view/5713/ |
|
1465 | 1465 | parts = [("d", 60*60*24),("h", 60*60),("min", 60), ("s", 1)] |
|
1466 | 1466 | time = [] |
|
1467 | 1467 | leftover = timespan |
|
1468 | 1468 | for suffix, length in parts: |
|
1469 | 1469 | value = int(leftover / length) |
|
1470 | 1470 | if value > 0: |
|
1471 | 1471 | leftover = leftover % length |
|
1472 | 1472 | time.append(u'%s%s' % (str(value), suffix)) |
|
1473 | 1473 | if leftover < 1: |
|
1474 | 1474 | break |
|
1475 | 1475 | return " ".join(time) |
|
1476 | 1476 | |
|
1477 | 1477 | |
|
1478 | 1478 | # Unfortunately the unicode 'micro' symbol can cause problems in |
|
1479 | 1479 | # certain terminals. |
|
1480 | 1480 | # See bug: https://bugs.launchpad.net/ipython/+bug/348466 |
|
1481 | 1481 | # Try to prevent crashes by being more secure than it needs to |
|
1482 | 1482 | # E.g. eclipse is able to print a Β΅, but has no sys.stdout.encoding set. |
|
1483 | 1483 | units = [u"s", u"ms",u'us',"ns"] # the save value |
|
1484 | 1484 | if hasattr(sys.stdout, 'encoding') and sys.stdout.encoding: |
|
1485 | 1485 | try: |
|
1486 | 1486 | u'\xb5'.encode(sys.stdout.encoding) |
|
1487 | 1487 | units = [u"s", u"ms",u'\xb5s',"ns"] |
|
1488 | 1488 | except: |
|
1489 | 1489 | pass |
|
1490 | 1490 | scaling = [1, 1e3, 1e6, 1e9] |
|
1491 | 1491 | |
|
1492 | 1492 | if timespan > 0.0: |
|
1493 | 1493 | order = min(-int(math.floor(math.log10(timespan)) // 3), 3) |
|
1494 | 1494 | else: |
|
1495 | 1495 | order = 3 |
|
1496 | 1496 | return u"%.*g %s" % (precision, timespan * scaling[order], units[order]) |
@@ -1,103 +1,104 b'' | |||
|
1 | 1 | """Implementation of packaging-related magic functions. |
|
2 | 2 | """ |
|
3 | 3 | #----------------------------------------------------------------------------- |
|
4 | 4 | # Copyright (c) 2018 The IPython Development Team. |
|
5 | 5 | # |
|
6 | 6 | # Distributed under the terms of the Modified BSD License. |
|
7 | 7 | # |
|
8 | 8 | # The full license is in the file COPYING.txt, distributed with this software. |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | |
|
11 | import os | |
|
12 | 11 | import re |
|
13 | 12 | import shlex |
|
14 | 13 | import sys |
|
15 | 14 | |
|
15 | from pathlib import Path | |
|
16 | 16 | from IPython.core.magic import Magics, magics_class, line_magic |
|
17 | 17 | |
|
18 | 18 | |
|
19 | 19 | def _is_conda_environment(): |
|
20 | 20 | """Return True if the current Python executable is in a conda env""" |
|
21 | 21 | # TODO: does this need to change on windows? |
|
22 |
|
|
|
23 | return os.path.exists(conda_history) | |
|
22 | return Path(sys.prefix, "conda-meta", "history").exists() | |
|
24 | 23 | |
|
25 | 24 | |
|
26 | 25 | def _get_conda_executable(): |
|
27 | 26 | """Find the path to the conda executable""" |
|
28 | 27 | # Check if there is a conda executable in the same directory as the Python executable. |
|
29 | 28 | # This is the case within conda's root environment. |
|
30 |
conda = |
|
|
31 |
if |
|
|
32 | return conda | |
|
29 | conda = Path(sys.executable).parent / "conda" | |
|
30 | if conda.isfile(): | |
|
31 | return str(conda) | |
|
33 | 32 | |
|
34 | 33 | # Otherwise, attempt to extract the executable from conda history. |
|
35 | 34 | # This applies in any conda environment. |
|
36 | R = re.compile(r"^#\s*cmd:\s*(?P<command>.*conda)\s[create|install]") | |
|
37 | with open(os.path.join(sys.prefix, 'conda-meta', 'history')) as f: | |
|
38 | for line in f: | |
|
39 | match = R.match(line) | |
|
40 | if match: | |
|
41 | return match.groupdict()['command'] | |
|
35 | history = Path(sys.prefix, "conda-meta", "history").read_text() | |
|
36 | match = re.search( | |
|
37 | r"^#\s*cmd:\s*(?P<command>.*conda)\s[create|install]", | |
|
38 | history, | |
|
39 | flags=re.MULTILINE, | |
|
40 | ) | |
|
41 | if match: | |
|
42 | return match.groupdict()["command"] | |
|
42 | 43 | |
|
43 | 44 | # Fallback: assume conda is available on the system path. |
|
44 | 45 | return "conda" |
|
45 | 46 | |
|
46 | 47 | |
|
47 | 48 | CONDA_COMMANDS_REQUIRING_PREFIX = { |
|
48 | 49 | 'install', 'list', 'remove', 'uninstall', 'update', 'upgrade', |
|
49 | 50 | } |
|
50 | 51 | CONDA_COMMANDS_REQUIRING_YES = { |
|
51 | 52 | 'install', 'remove', 'uninstall', 'update', 'upgrade', |
|
52 | 53 | } |
|
53 | 54 | CONDA_ENV_FLAGS = {'-p', '--prefix', '-n', '--name'} |
|
54 | 55 | CONDA_YES_FLAGS = {'-y', '--y'} |
|
55 | 56 | |
|
56 | 57 | |
|
57 | 58 | @magics_class |
|
58 | 59 | class PackagingMagics(Magics): |
|
59 | 60 | """Magics related to packaging & installation""" |
|
60 | 61 | |
|
61 | 62 | @line_magic |
|
62 | 63 | def pip(self, line): |
|
63 | 64 | """Run the pip package manager within the current kernel. |
|
64 | 65 | |
|
65 | 66 | Usage: |
|
66 | 67 | %pip install [pkgs] |
|
67 | 68 | """ |
|
68 | 69 | self.shell.system(' '.join([sys.executable, '-m', 'pip', line])) |
|
69 | 70 | print("Note: you may need to restart the kernel to use updated packages.") |
|
70 | 71 | |
|
71 | 72 | @line_magic |
|
72 | 73 | def conda(self, line): |
|
73 | 74 | """Run the conda package manager within the current kernel. |
|
74 | 75 | |
|
75 | 76 | Usage: |
|
76 | 77 | %conda install [pkgs] |
|
77 | 78 | """ |
|
78 | 79 | if not _is_conda_environment(): |
|
79 | 80 | raise ValueError("The python kernel does not appear to be a conda environment. " |
|
80 | 81 | "Please use ``%pip install`` instead.") |
|
81 | 82 | |
|
82 | 83 | conda = _get_conda_executable() |
|
83 | 84 | args = shlex.split(line) |
|
84 | 85 | command = args[0] |
|
85 | 86 | args = args[1:] |
|
86 | 87 | extra_args = [] |
|
87 | 88 | |
|
88 | 89 | # When the subprocess does not allow us to respond "yes" during the installation, |
|
89 | 90 | # we need to insert --yes in the argument list for some commands |
|
90 | 91 | stdin_disabled = getattr(self.shell, 'kernel', None) is not None |
|
91 | 92 | needs_yes = command in CONDA_COMMANDS_REQUIRING_YES |
|
92 | 93 | has_yes = set(args).intersection(CONDA_YES_FLAGS) |
|
93 | 94 | if stdin_disabled and needs_yes and not has_yes: |
|
94 | 95 | extra_args.append("--yes") |
|
95 | 96 | |
|
96 | 97 | # Add --prefix to point conda installation to the current environment |
|
97 | 98 | needs_prefix = command in CONDA_COMMANDS_REQUIRING_PREFIX |
|
98 | 99 | has_prefix = set(args).intersection(CONDA_ENV_FLAGS) |
|
99 | 100 | if needs_prefix and not has_prefix: |
|
100 | 101 | extra_args.extend(["--prefix", sys.prefix]) |
|
101 | 102 | |
|
102 | 103 | self.shell.system(' '.join([conda, command] + extra_args + args)) |
|
103 | 104 | print("\nNote: you may need to restart the kernel to use updated packages.") |
@@ -1,316 +1,323 b'' | |||
|
1 | 1 | """ |
|
2 |
Test for async helpers. |
|
|
2 | Test for async helpers. | |
|
3 | 3 | |
|
4 | 4 | Should only trigger on python 3.5+ or will have syntax errors. |
|
5 | 5 | """ |
|
6 | 6 | from itertools import chain, repeat |
|
7 | 7 | import nose.tools as nt |
|
8 | 8 | from textwrap import dedent, indent |
|
9 | 9 | from unittest import TestCase |
|
10 | 10 | from IPython.testing.decorators import skip_without |
|
11 | 11 | import sys |
|
12 | from typing import TYPE_CHECKING | |
|
13 | ||
|
14 | if TYPE_CHECKING: | |
|
15 | from IPython import get_ipython | |
|
16 | ||
|
17 | ip = get_ipython() | |
|
18 | ||
|
12 | 19 | |
|
13 | 20 | iprc = lambda x: ip.run_cell(dedent(x)).raise_error() |
|
14 | 21 | iprc_nr = lambda x: ip.run_cell(dedent(x)) |
|
15 | 22 | |
|
16 | 23 | from IPython.core.async_helpers import _should_be_async |
|
17 | 24 | |
|
18 | 25 | class AsyncTest(TestCase): |
|
19 | 26 | def test_should_be_async(self): |
|
20 | 27 | nt.assert_false(_should_be_async("False")) |
|
21 | 28 | nt.assert_true(_should_be_async("await bar()")) |
|
22 | 29 | nt.assert_true(_should_be_async("x = await bar()")) |
|
23 | 30 | nt.assert_false( |
|
24 | 31 | _should_be_async( |
|
25 | 32 | dedent( |
|
26 | 33 | """ |
|
27 | 34 | async def awaitable(): |
|
28 | 35 | pass |
|
29 | 36 | """ |
|
30 | 37 | ) |
|
31 | 38 | ) |
|
32 | 39 | ) |
|
33 | 40 | |
|
34 | 41 | def _get_top_level_cases(self): |
|
35 | 42 | # These are test cases that should be valid in a function |
|
36 | 43 | # but invalid outside of a function. |
|
37 | 44 | test_cases = [] |
|
38 | 45 | test_cases.append(('basic', "{val}")) |
|
39 | 46 | |
|
40 | 47 | # Note, in all conditional cases, I use True instead of |
|
41 | 48 | # False so that the peephole optimizer won't optimize away |
|
42 | 49 | # the return, so CPython will see this as a syntax error: |
|
43 | 50 | # |
|
44 | 51 | # while True: |
|
45 | 52 | # break |
|
46 | 53 | # return |
|
47 | 54 | # |
|
48 | 55 | # But not this: |
|
49 | 56 | # |
|
50 | 57 | # while False: |
|
51 | 58 | # return |
|
52 | 59 | # |
|
53 | 60 | # See https://bugs.python.org/issue1875 |
|
54 | 61 | |
|
55 | 62 | test_cases.append(('if', dedent(""" |
|
56 | 63 | if True: |
|
57 | 64 | {val} |
|
58 | 65 | """))) |
|
59 | 66 | |
|
60 | 67 | test_cases.append(('while', dedent(""" |
|
61 | 68 | while True: |
|
62 | 69 | {val} |
|
63 | 70 | break |
|
64 | 71 | """))) |
|
65 | 72 | |
|
66 | 73 | test_cases.append(('try', dedent(""" |
|
67 | 74 | try: |
|
68 | 75 | {val} |
|
69 | 76 | except: |
|
70 | 77 | pass |
|
71 | 78 | """))) |
|
72 | 79 | |
|
73 | 80 | test_cases.append(('except', dedent(""" |
|
74 | 81 | try: |
|
75 | 82 | pass |
|
76 | 83 | except: |
|
77 | 84 | {val} |
|
78 | 85 | """))) |
|
79 | 86 | |
|
80 | 87 | test_cases.append(('finally', dedent(""" |
|
81 | 88 | try: |
|
82 | 89 | pass |
|
83 | 90 | except: |
|
84 | 91 | pass |
|
85 | 92 | finally: |
|
86 | 93 | {val} |
|
87 | 94 | """))) |
|
88 | 95 | |
|
89 | 96 | test_cases.append(('for', dedent(""" |
|
90 | 97 | for _ in range(4): |
|
91 | 98 | {val} |
|
92 | 99 | """))) |
|
93 | 100 | |
|
94 | 101 | |
|
95 | 102 | test_cases.append(('nested', dedent(""" |
|
96 | 103 | if True: |
|
97 | 104 | while True: |
|
98 | 105 | {val} |
|
99 | 106 | break |
|
100 | 107 | """))) |
|
101 | 108 | |
|
102 | 109 | test_cases.append(('deep-nested', dedent(""" |
|
103 | 110 | if True: |
|
104 | 111 | while True: |
|
105 | 112 | break |
|
106 | 113 | for x in range(3): |
|
107 | 114 | if True: |
|
108 | 115 | while True: |
|
109 | 116 | for x in range(3): |
|
110 | 117 | {val} |
|
111 | 118 | """))) |
|
112 | 119 | |
|
113 | 120 | return test_cases |
|
114 | 121 | |
|
115 | 122 | def _get_ry_syntax_errors(self): |
|
116 | 123 | # This is a mix of tests that should be a syntax error if |
|
117 | 124 | # return or yield whether or not they are in a function |
|
118 | 125 | |
|
119 | 126 | test_cases = [] |
|
120 | 127 | |
|
121 | 128 | test_cases.append(('class', dedent(""" |
|
122 | 129 | class V: |
|
123 | 130 | {val} |
|
124 | 131 | """))) |
|
125 | 132 | |
|
126 | 133 | test_cases.append(('nested-class', dedent(""" |
|
127 | 134 | class V: |
|
128 | 135 | class C: |
|
129 | 136 | {val} |
|
130 | 137 | """))) |
|
131 | 138 | |
|
132 | 139 | return test_cases |
|
133 | 140 | |
|
134 | 141 | |
|
135 | 142 | def test_top_level_return_error(self): |
|
136 | 143 | tl_err_test_cases = self._get_top_level_cases() |
|
137 | 144 | tl_err_test_cases.extend(self._get_ry_syntax_errors()) |
|
138 | 145 | |
|
139 | 146 | vals = ('return', 'yield', 'yield from (_ for _ in range(3))', |
|
140 | 147 | dedent(''' |
|
141 | 148 | def f(): |
|
142 | 149 | pass |
|
143 | 150 | return |
|
144 | 151 | '''), |
|
145 | 152 | ) |
|
146 | 153 | |
|
147 | 154 | for test_name, test_case in tl_err_test_cases: |
|
148 | 155 | # This example should work if 'pass' is used as the value |
|
149 | 156 | with self.subTest((test_name, 'pass')): |
|
150 | 157 | iprc(test_case.format(val='pass')) |
|
151 | 158 | |
|
152 | 159 | # It should fail with all the values |
|
153 | 160 | for val in vals: |
|
154 | 161 | with self.subTest((test_name, val)): |
|
155 | 162 | msg = "Syntax error not raised for %s, %s" % (test_name, val) |
|
156 | 163 | with self.assertRaises(SyntaxError, msg=msg): |
|
157 | 164 | iprc(test_case.format(val=val)) |
|
158 | 165 | |
|
159 | 166 | def test_in_func_no_error(self): |
|
160 | 167 | # Test that the implementation of top-level return/yield |
|
161 | 168 | # detection isn't *too* aggressive, and works inside a function |
|
162 | 169 | func_contexts = [] |
|
163 | 170 | |
|
164 | 171 | func_contexts.append(('func', False, dedent(""" |
|
165 | 172 | def f():"""))) |
|
166 | 173 | |
|
167 | 174 | func_contexts.append(('method', False, dedent(""" |
|
168 | 175 | class MyClass: |
|
169 | 176 | def __init__(self): |
|
170 | 177 | """))) |
|
171 | 178 | |
|
172 | 179 | func_contexts.append(('async-func', True, dedent(""" |
|
173 | 180 | async def f():"""))) |
|
174 | 181 | |
|
175 | 182 | func_contexts.append(('async-method', True, dedent(""" |
|
176 | 183 | class MyClass: |
|
177 | 184 | async def f(self):"""))) |
|
178 | 185 | |
|
179 | 186 | func_contexts.append(('closure', False, dedent(""" |
|
180 | 187 | def f(): |
|
181 | 188 | def g(): |
|
182 | 189 | """))) |
|
183 | 190 | |
|
184 | 191 | def nest_case(context, case): |
|
185 | 192 | # Detect indentation |
|
186 | 193 | lines = context.strip().splitlines() |
|
187 | 194 | prefix_len = 0 |
|
188 | 195 | for c in lines[-1]: |
|
189 | 196 | if c != ' ': |
|
190 | 197 | break |
|
191 | 198 | prefix_len += 1 |
|
192 | 199 | |
|
193 | 200 | indented_case = indent(case, ' ' * (prefix_len + 4)) |
|
194 | 201 | return context + '\n' + indented_case |
|
195 | 202 | |
|
196 | 203 | # Gather and run the tests |
|
197 | 204 | |
|
198 | 205 | # yield is allowed in async functions, starting in Python 3.6, |
|
199 | 206 | # and yield from is not allowed in any version |
|
200 | 207 | vals = ('return', 'yield', 'yield from (_ for _ in range(3))') |
|
201 | 208 | async_safe = (True, |
|
202 | 209 | True, |
|
203 | 210 | False) |
|
204 | 211 | vals = tuple(zip(vals, async_safe)) |
|
205 | 212 | |
|
206 | 213 | success_tests = zip(self._get_top_level_cases(), repeat(False)) |
|
207 | 214 | failure_tests = zip(self._get_ry_syntax_errors(), repeat(True)) |
|
208 | 215 | |
|
209 | 216 | tests = chain(success_tests, failure_tests) |
|
210 | 217 | |
|
211 | 218 | for context_name, async_func, context in func_contexts: |
|
212 | 219 | for (test_name, test_case), should_fail in tests: |
|
213 | 220 | nested_case = nest_case(context, test_case) |
|
214 | 221 | |
|
215 | 222 | for val, async_safe in vals: |
|
216 | 223 | val_should_fail = (should_fail or |
|
217 | 224 | (async_func and not async_safe)) |
|
218 | 225 | |
|
219 | 226 | test_id = (context_name, test_name, val) |
|
220 | 227 | cell = nested_case.format(val=val) |
|
221 | 228 | |
|
222 | 229 | with self.subTest(test_id): |
|
223 | 230 | if val_should_fail: |
|
224 | 231 | msg = ("SyntaxError not raised for %s" % |
|
225 | 232 | str(test_id)) |
|
226 | 233 | with self.assertRaises(SyntaxError, msg=msg): |
|
227 | 234 | iprc(cell) |
|
228 | 235 | |
|
229 | 236 | print(cell) |
|
230 | 237 | else: |
|
231 | 238 | iprc(cell) |
|
232 | 239 | |
|
233 | 240 | def test_nonlocal(self): |
|
234 | 241 | # fails if outer scope is not a function scope or if var not defined |
|
235 | 242 | with self.assertRaises(SyntaxError): |
|
236 | 243 | iprc("nonlocal x") |
|
237 | 244 | iprc(""" |
|
238 | 245 | x = 1 |
|
239 | 246 | def f(): |
|
240 | 247 | nonlocal x |
|
241 | 248 | x = 10000 |
|
242 | 249 | yield x |
|
243 | 250 | """) |
|
244 | 251 | iprc(""" |
|
245 | 252 | def f(): |
|
246 | 253 | def g(): |
|
247 | 254 | nonlocal x |
|
248 | 255 | x = 10000 |
|
249 | 256 | yield x |
|
250 | 257 | """) |
|
251 | 258 | |
|
252 | 259 | # works if outer scope is a function scope and var exists |
|
253 | 260 | iprc(""" |
|
254 | 261 | def f(): |
|
255 | 262 | x = 20 |
|
256 | 263 | def g(): |
|
257 | 264 | nonlocal x |
|
258 | 265 | x = 10000 |
|
259 | 266 | yield x |
|
260 | 267 | """) |
|
261 | 268 | |
|
262 | 269 | |
|
263 | 270 | def test_execute(self): |
|
264 | 271 | iprc(""" |
|
265 | 272 | import asyncio |
|
266 | 273 | await asyncio.sleep(0.001) |
|
267 | 274 | """ |
|
268 | 275 | ) |
|
269 | 276 | |
|
270 | 277 | def test_autoawait(self): |
|
271 | 278 | iprc("%autoawait False") |
|
272 | 279 | iprc("%autoawait True") |
|
273 | 280 | iprc(""" |
|
274 | 281 | from asyncio import sleep |
|
275 | 282 | await sleep(0.1) |
|
276 | 283 | """ |
|
277 | 284 | ) |
|
278 | ||
|
285 | ||
|
279 | 286 | if sys.version_info < (3,9): |
|
280 | 287 | # new pgen parser in 3.9 does not raise MemoryError on too many nested |
|
281 | 288 | # parens anymore |
|
282 | 289 | def test_memory_error(self): |
|
283 | 290 | with self.assertRaises(MemoryError): |
|
284 | 291 | iprc("(" * 200 + ")" * 200) |
|
285 | 292 | |
|
286 | 293 | @skip_without('curio') |
|
287 | 294 | def test_autoawait_curio(self): |
|
288 | 295 | iprc("%autoawait curio") |
|
289 | 296 | |
|
290 | 297 | @skip_without('trio') |
|
291 | 298 | def test_autoawait_trio(self): |
|
292 | 299 | iprc("%autoawait trio") |
|
293 | 300 | |
|
294 | 301 | @skip_without('trio') |
|
295 | 302 | def test_autoawait_trio_wrong_sleep(self): |
|
296 | 303 | iprc("%autoawait trio") |
|
297 | 304 | res = iprc_nr(""" |
|
298 | 305 | import asyncio |
|
299 | 306 | await asyncio.sleep(0) |
|
300 | 307 | """) |
|
301 | 308 | with nt.assert_raises(TypeError): |
|
302 | 309 | res.raise_error() |
|
303 | 310 | |
|
304 | 311 | @skip_without('trio') |
|
305 | 312 | def test_autoawait_asyncio_wrong_sleep(self): |
|
306 | 313 | iprc("%autoawait asyncio") |
|
307 | 314 | res = iprc_nr(""" |
|
308 | 315 | import trio |
|
309 | 316 | await trio.sleep(0) |
|
310 | 317 | """) |
|
311 | 318 | with nt.assert_raises(RuntimeError): |
|
312 | 319 | res.raise_error() |
|
313 | 320 | |
|
314 | 321 | |
|
315 | 322 | def tearDown(self): |
|
316 | 323 | ip.loop_runner = "asyncio" |
@@ -1,455 +1,459 b'' | |||
|
1 | 1 | # Copyright (c) IPython Development Team. |
|
2 | 2 | # Distributed under the terms of the Modified BSD License. |
|
3 | 3 | |
|
4 | 4 | import json |
|
5 | 5 | import os |
|
6 | 6 | import warnings |
|
7 | 7 | |
|
8 | 8 | from unittest import mock |
|
9 | 9 | |
|
10 | 10 | import nose.tools as nt |
|
11 | 11 | |
|
12 | 12 | from IPython import display |
|
13 | 13 | from IPython.core.getipython import get_ipython |
|
14 | 14 | from IPython.utils.io import capture_output |
|
15 | 15 | from IPython.utils.tempdir import NamedFileInTemporaryDirectory |
|
16 | 16 | from IPython import paths as ipath |
|
17 | 17 | from IPython.testing.tools import AssertNotPrints |
|
18 | 18 | |
|
19 | 19 | import IPython.testing.decorators as dec |
|
20 | 20 | |
|
21 | 21 | def test_image_size(): |
|
22 | 22 | """Simple test for display.Image(args, width=x,height=y)""" |
|
23 | 23 | thisurl = 'http://www.google.fr/images/srpr/logo3w.png' |
|
24 | 24 | img = display.Image(url=thisurl, width=200, height=200) |
|
25 | 25 | nt.assert_equal(u'<img src="%s" width="200" height="200"/>' % (thisurl), img._repr_html_()) |
|
26 | 26 | img = display.Image(url=thisurl, metadata={'width':200, 'height':200}) |
|
27 | 27 | nt.assert_equal(u'<img src="%s" width="200" height="200"/>' % (thisurl), img._repr_html_()) |
|
28 | 28 | img = display.Image(url=thisurl, width=200) |
|
29 | 29 | nt.assert_equal(u'<img src="%s" width="200"/>' % (thisurl), img._repr_html_()) |
|
30 | 30 | img = display.Image(url=thisurl) |
|
31 | 31 | nt.assert_equal(u'<img src="%s"/>' % (thisurl), img._repr_html_()) |
|
32 | 32 | img = display.Image(url=thisurl, unconfined=True) |
|
33 | 33 | nt.assert_equal(u'<img src="%s" class="unconfined"/>' % (thisurl), img._repr_html_()) |
|
34 | 34 | |
|
35 | 35 | |
|
36 | 36 | def test_image_mimes(): |
|
37 | 37 | fmt = get_ipython().display_formatter.format |
|
38 | 38 | for format in display.Image._ACCEPTABLE_EMBEDDINGS: |
|
39 | 39 | mime = display.Image._MIMETYPES[format] |
|
40 | 40 | img = display.Image(b'garbage', format=format) |
|
41 | 41 | data, metadata = fmt(img) |
|
42 | 42 | nt.assert_equal(sorted(data), sorted([mime, 'text/plain'])) |
|
43 | 43 | |
|
44 | 44 | |
|
45 | 45 | def test_geojson(): |
|
46 | 46 | |
|
47 | 47 | gj = display.GeoJSON(data={ |
|
48 | 48 | "type": "Feature", |
|
49 | 49 | "geometry": { |
|
50 | 50 | "type": "Point", |
|
51 | 51 | "coordinates": [-81.327, 296.038] |
|
52 | 52 | }, |
|
53 | 53 | "properties": { |
|
54 | 54 | "name": "Inca City" |
|
55 | 55 | } |
|
56 | 56 | }, |
|
57 | 57 | url_template="http://s3-eu-west-1.amazonaws.com/whereonmars.cartodb.net/{basemap_id}/{z}/{x}/{y}.png", |
|
58 | 58 | layer_options={ |
|
59 | 59 | "basemap_id": "celestia_mars-shaded-16k_global", |
|
60 | 60 | "attribution": "Celestia/praesepe", |
|
61 | 61 | "minZoom": 0, |
|
62 | 62 | "maxZoom": 18, |
|
63 | 63 | }) |
|
64 | 64 | nt.assert_equal(u'<IPython.core.display.GeoJSON object>', str(gj)) |
|
65 | 65 | |
|
66 | 66 | def test_retina_png(): |
|
67 | 67 | here = os.path.dirname(__file__) |
|
68 | 68 | img = display.Image(os.path.join(here, "2x2.png"), retina=True) |
|
69 | 69 | nt.assert_equal(img.height, 1) |
|
70 | 70 | nt.assert_equal(img.width, 1) |
|
71 | 71 | data, md = img._repr_png_() |
|
72 | 72 | nt.assert_equal(md['width'], 1) |
|
73 | 73 | nt.assert_equal(md['height'], 1) |
|
74 | 74 | |
|
75 | 75 | def test_embed_svg_url(): |
|
76 | 76 | import gzip |
|
77 | 77 | from io import BytesIO |
|
78 | 78 | svg_data = b'<svg><circle x="0" y="0" r="1"/></svg>' |
|
79 | 79 | url = 'http://test.com/circle.svg' |
|
80 | 80 | |
|
81 | 81 | gzip_svg = BytesIO() |
|
82 | 82 | with gzip.open(gzip_svg, 'wb') as fp: |
|
83 | 83 | fp.write(svg_data) |
|
84 | 84 | gzip_svg = gzip_svg.getvalue() |
|
85 | 85 | |
|
86 | 86 | def mocked_urlopen(*args, **kwargs): |
|
87 | 87 | class MockResponse: |
|
88 | 88 | def __init__(self, svg): |
|
89 | 89 | self._svg_data = svg |
|
90 | 90 | self.headers = {'content-type': 'image/svg+xml'} |
|
91 | 91 | |
|
92 | 92 | def read(self): |
|
93 | 93 | return self._svg_data |
|
94 | 94 | |
|
95 | 95 | if args[0] == url: |
|
96 | 96 | return MockResponse(svg_data) |
|
97 | 97 | elif args[0] == url + 'z': |
|
98 | 98 | ret= MockResponse(gzip_svg) |
|
99 | 99 | ret.headers['content-encoding']= 'gzip' |
|
100 | 100 | return ret |
|
101 | 101 | return MockResponse(None) |
|
102 | 102 | |
|
103 | 103 | with mock.patch('urllib.request.urlopen', side_effect=mocked_urlopen): |
|
104 | 104 | svg = display.SVG(url=url) |
|
105 | 105 | nt.assert_true(svg._repr_svg_().startswith('<svg')) |
|
106 | 106 | svg = display.SVG(url=url + 'z') |
|
107 | 107 | nt.assert_true(svg._repr_svg_().startswith('<svg')) |
|
108 | 108 | |
|
109 | 109 | def test_retina_jpeg(): |
|
110 | 110 | here = os.path.dirname(__file__) |
|
111 | 111 | img = display.Image(os.path.join(here, "2x2.jpg"), retina=True) |
|
112 | 112 | nt.assert_equal(img.height, 1) |
|
113 | 113 | nt.assert_equal(img.width, 1) |
|
114 | 114 | data, md = img._repr_jpeg_() |
|
115 | 115 | nt.assert_equal(md['width'], 1) |
|
116 | 116 | nt.assert_equal(md['height'], 1) |
|
117 | 117 | |
|
118 | 118 | def test_base64image(): |
|
119 | 119 | display.Image("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAWJLR0QAiAUdSAAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB94BCRQnOqNu0b4AAAAKSURBVAjXY2AAAAACAAHiIbwzAAAAAElFTkSuQmCC") |
|
120 | 120 | |
|
121 | 121 | def test_image_filename_defaults(): |
|
122 | 122 | '''test format constraint, and validity of jpeg and png''' |
|
123 | 123 | tpath = ipath.get_ipython_package_dir() |
|
124 | 124 | nt.assert_raises(ValueError, display.Image, filename=os.path.join(tpath, 'testing/tests/badformat.zip'), |
|
125 | 125 | embed=True) |
|
126 | 126 | nt.assert_raises(ValueError, display.Image) |
|
127 | 127 | nt.assert_raises(ValueError, display.Image, data='this is not an image', format='badformat', embed=True) |
|
128 | 128 | # check boths paths to allow packages to test at build and install time |
|
129 | 129 | imgfile = os.path.join(tpath, 'core/tests/2x2.png') |
|
130 | 130 | img = display.Image(filename=imgfile) |
|
131 | 131 | nt.assert_equal('png', img.format) |
|
132 | 132 | nt.assert_is_not_none(img._repr_png_()) |
|
133 | 133 | img = display.Image(filename=os.path.join(tpath, 'testing/tests/logo.jpg'), embed=False) |
|
134 | 134 | nt.assert_equal('jpeg', img.format) |
|
135 | 135 | nt.assert_is_none(img._repr_jpeg_()) |
|
136 | 136 | |
|
137 | 137 | def _get_inline_config(): |
|
138 | 138 | from ipykernel.pylab.config import InlineBackend |
|
139 | 139 | return InlineBackend.instance() |
|
140 | 140 | |
|
141 | @dec.skip_without('matplotlib') | |
|
141 | ||
|
142 | @dec.skip_without("ipykernel") | |
|
143 | @dec.skip_without("matplotlib") | |
|
142 | 144 | def test_set_matplotlib_close(): |
|
143 | 145 | cfg = _get_inline_config() |
|
144 | 146 | cfg.close_figures = False |
|
145 | 147 | display.set_matplotlib_close() |
|
146 | 148 | assert cfg.close_figures |
|
147 | 149 | display.set_matplotlib_close(False) |
|
148 | 150 | assert not cfg.close_figures |
|
149 | 151 | |
|
150 | 152 | _fmt_mime_map = { |
|
151 | 153 | 'png': 'image/png', |
|
152 | 154 | 'jpeg': 'image/jpeg', |
|
153 | 155 | 'pdf': 'application/pdf', |
|
154 | 156 | 'retina': 'image/png', |
|
155 | 157 | 'svg': 'image/svg+xml', |
|
156 | 158 | } |
|
157 | 159 | |
|
158 | 160 | @dec.skip_without('matplotlib') |
|
159 | 161 | def test_set_matplotlib_formats(): |
|
160 | 162 | from matplotlib.figure import Figure |
|
161 | 163 | formatters = get_ipython().display_formatter.formatters |
|
162 | 164 | for formats in [ |
|
163 | 165 | ('png',), |
|
164 | 166 | ('pdf', 'svg'), |
|
165 | 167 | ('jpeg', 'retina', 'png'), |
|
166 | 168 | (), |
|
167 | 169 | ]: |
|
168 | 170 | active_mimes = {_fmt_mime_map[fmt] for fmt in formats} |
|
169 | 171 | display.set_matplotlib_formats(*formats) |
|
170 | 172 | for mime, f in formatters.items(): |
|
171 | 173 | if mime in active_mimes: |
|
172 | 174 | nt.assert_in(Figure, f) |
|
173 | 175 | else: |
|
174 | 176 | nt.assert_not_in(Figure, f) |
|
175 | 177 | |
|
176 | @dec.skip_without('matplotlib') | |
|
178 | ||
|
179 | @dec.skip_without("ipykernel") | |
|
180 | @dec.skip_without("matplotlib") | |
|
177 | 181 | def test_set_matplotlib_formats_kwargs(): |
|
178 | 182 | from matplotlib.figure import Figure |
|
179 | 183 | ip = get_ipython() |
|
180 | 184 | cfg = _get_inline_config() |
|
181 | 185 | cfg.print_figure_kwargs.update(dict(foo='bar')) |
|
182 | 186 | kwargs = dict(quality=10) |
|
183 | 187 | display.set_matplotlib_formats('png', **kwargs) |
|
184 | 188 | formatter = ip.display_formatter.formatters['image/png'] |
|
185 | 189 | f = formatter.lookup_by_type(Figure) |
|
186 | 190 | cell = f.__closure__[0].cell_contents |
|
187 | 191 | expected = kwargs |
|
188 | 192 | expected.update(cfg.print_figure_kwargs) |
|
189 | 193 | nt.assert_equal(cell, expected) |
|
190 | 194 | |
|
191 | 195 | def test_display_available(): |
|
192 | 196 | """ |
|
193 | 197 | Test that display is available without import |
|
194 | 198 | |
|
195 | 199 | We don't really care if it's in builtin or anything else, but it should |
|
196 | 200 | always be available. |
|
197 | 201 | """ |
|
198 | 202 | ip = get_ipython() |
|
199 | 203 | with AssertNotPrints('NameError'): |
|
200 | 204 | ip.run_cell('display') |
|
201 | 205 | try: |
|
202 | 206 | ip.run_cell('del display') |
|
203 | 207 | except NameError: |
|
204 | 208 | pass # it's ok, it might be in builtins |
|
205 | 209 | # even if deleted it should be back |
|
206 | 210 | with AssertNotPrints('NameError'): |
|
207 | 211 | ip.run_cell('display') |
|
208 | 212 | |
|
209 | 213 | def test_textdisplayobj_pretty_repr(): |
|
210 | 214 | p = display.Pretty("This is a simple test") |
|
211 | 215 | nt.assert_equal(repr(p), '<IPython.core.display.Pretty object>') |
|
212 | 216 | nt.assert_equal(p.data, 'This is a simple test') |
|
213 | 217 | |
|
214 | 218 | p._show_mem_addr = True |
|
215 | 219 | nt.assert_equal(repr(p), object.__repr__(p)) |
|
216 | 220 | |
|
217 | 221 | def test_displayobject_repr(): |
|
218 | 222 | h = display.HTML('<br />') |
|
219 | 223 | nt.assert_equal(repr(h), '<IPython.core.display.HTML object>') |
|
220 | 224 | h._show_mem_addr = True |
|
221 | 225 | nt.assert_equal(repr(h), object.__repr__(h)) |
|
222 | 226 | h._show_mem_addr = False |
|
223 | 227 | nt.assert_equal(repr(h), '<IPython.core.display.HTML object>') |
|
224 | 228 | |
|
225 | 229 | j = display.Javascript('') |
|
226 | 230 | nt.assert_equal(repr(j), '<IPython.core.display.Javascript object>') |
|
227 | 231 | j._show_mem_addr = True |
|
228 | 232 | nt.assert_equal(repr(j), object.__repr__(j)) |
|
229 | 233 | j._show_mem_addr = False |
|
230 | 234 | nt.assert_equal(repr(j), '<IPython.core.display.Javascript object>') |
|
231 | 235 | |
|
232 | 236 | @mock.patch('warnings.warn') |
|
233 | 237 | def test_encourage_iframe_over_html(m_warn): |
|
234 | 238 | display.HTML() |
|
235 | 239 | m_warn.assert_not_called() |
|
236 | 240 | |
|
237 | 241 | display.HTML('<br />') |
|
238 | 242 | m_warn.assert_not_called() |
|
239 | 243 | |
|
240 | 244 | display.HTML('<html><p>Lots of content here</p><iframe src="http://a.com"></iframe>') |
|
241 | 245 | m_warn.assert_not_called() |
|
242 | 246 | |
|
243 | 247 | display.HTML('<iframe src="http://a.com"></iframe>') |
|
244 | 248 | m_warn.assert_called_with('Consider using IPython.display.IFrame instead') |
|
245 | 249 | |
|
246 | 250 | m_warn.reset_mock() |
|
247 | 251 | display.HTML('<IFRAME SRC="http://a.com"></IFRAME>') |
|
248 | 252 | m_warn.assert_called_with('Consider using IPython.display.IFrame instead') |
|
249 | 253 | |
|
250 | 254 | def test_progress(): |
|
251 | 255 | p = display.ProgressBar(10) |
|
252 | 256 | nt.assert_in('0/10',repr(p)) |
|
253 | 257 | p.html_width = '100%' |
|
254 | 258 | p.progress = 5 |
|
255 | 259 | nt.assert_equal(p._repr_html_(), "<progress style='width:100%' max='10' value='5'></progress>") |
|
256 | 260 | |
|
257 | 261 | def test_progress_iter(): |
|
258 | 262 | with capture_output(display=False) as captured: |
|
259 | 263 | for i in display.ProgressBar(5): |
|
260 | 264 | out = captured.stdout |
|
261 | 265 | nt.assert_in('{0}/5'.format(i), out) |
|
262 | 266 | out = captured.stdout |
|
263 | 267 | nt.assert_in('5/5', out) |
|
264 | 268 | |
|
265 | 269 | def test_json(): |
|
266 | 270 | d = {'a': 5} |
|
267 | 271 | lis = [d] |
|
268 | 272 | metadata = [ |
|
269 | 273 | {'expanded': False, 'root': 'root'}, |
|
270 | 274 | {'expanded': True, 'root': 'root'}, |
|
271 | 275 | {'expanded': False, 'root': 'custom'}, |
|
272 | 276 | {'expanded': True, 'root': 'custom'}, |
|
273 | 277 | ] |
|
274 | 278 | json_objs = [ |
|
275 | 279 | display.JSON(d), |
|
276 | 280 | display.JSON(d, expanded=True), |
|
277 | 281 | display.JSON(d, root='custom'), |
|
278 | 282 | display.JSON(d, expanded=True, root='custom'), |
|
279 | 283 | ] |
|
280 | 284 | for j, md in zip(json_objs, metadata): |
|
281 | 285 | nt.assert_equal(j._repr_json_(), (d, md)) |
|
282 | 286 | |
|
283 | 287 | with warnings.catch_warnings(record=True) as w: |
|
284 | 288 | warnings.simplefilter("always") |
|
285 | 289 | j = display.JSON(json.dumps(d)) |
|
286 | 290 | nt.assert_equal(len(w), 1) |
|
287 | 291 | nt.assert_equal(j._repr_json_(), (d, metadata[0])) |
|
288 | 292 | |
|
289 | 293 | json_objs = [ |
|
290 | 294 | display.JSON(lis), |
|
291 | 295 | display.JSON(lis, expanded=True), |
|
292 | 296 | display.JSON(lis, root='custom'), |
|
293 | 297 | display.JSON(lis, expanded=True, root='custom'), |
|
294 | 298 | ] |
|
295 | 299 | for j, md in zip(json_objs, metadata): |
|
296 | 300 | nt.assert_equal(j._repr_json_(), (lis, md)) |
|
297 | 301 | |
|
298 | 302 | with warnings.catch_warnings(record=True) as w: |
|
299 | 303 | warnings.simplefilter("always") |
|
300 | 304 | j = display.JSON(json.dumps(lis)) |
|
301 | 305 | nt.assert_equal(len(w), 1) |
|
302 | 306 | nt.assert_equal(j._repr_json_(), (lis, metadata[0])) |
|
303 | 307 | |
|
304 | 308 | def test_video_embedding(): |
|
305 | 309 | """use a tempfile, with dummy-data, to ensure that video embedding doesn't crash""" |
|
306 | 310 | v = display.Video("http://ignored") |
|
307 | 311 | assert not v.embed |
|
308 | 312 | html = v._repr_html_() |
|
309 | 313 | nt.assert_not_in('src="data:', html) |
|
310 | 314 | nt.assert_in('src="http://ignored"', html) |
|
311 | 315 | |
|
312 | 316 | with nt.assert_raises(ValueError): |
|
313 | 317 | v = display.Video(b'abc') |
|
314 | 318 | |
|
315 | 319 | with NamedFileInTemporaryDirectory('test.mp4') as f: |
|
316 | 320 | f.write(b'abc') |
|
317 | 321 | f.close() |
|
318 | 322 | |
|
319 | 323 | v = display.Video(f.name) |
|
320 | 324 | assert not v.embed |
|
321 | 325 | html = v._repr_html_() |
|
322 | 326 | nt.assert_not_in('src="data:', html) |
|
323 | 327 | |
|
324 | 328 | v = display.Video(f.name, embed=True) |
|
325 | 329 | html = v._repr_html_() |
|
326 | 330 | nt.assert_in('src="data:video/mp4;base64,YWJj"',html) |
|
327 | 331 | |
|
328 | 332 | v = display.Video(f.name, embed=True, mimetype='video/other') |
|
329 | 333 | html = v._repr_html_() |
|
330 | 334 | nt.assert_in('src="data:video/other;base64,YWJj"',html) |
|
331 | 335 | |
|
332 | 336 | v = display.Video(b'abc', embed=True, mimetype='video/mp4') |
|
333 | 337 | html = v._repr_html_() |
|
334 | 338 | nt.assert_in('src="data:video/mp4;base64,YWJj"',html) |
|
335 | 339 | |
|
336 | 340 | v = display.Video(u'YWJj', embed=True, mimetype='video/xyz') |
|
337 | 341 | html = v._repr_html_() |
|
338 | 342 | nt.assert_in('src="data:video/xyz;base64,YWJj"',html) |
|
339 | 343 | |
|
340 | 344 | def test_html_metadata(): |
|
341 | 345 | s = "<h1>Test</h1>" |
|
342 | 346 | h = display.HTML(s, metadata={"isolated": True}) |
|
343 | 347 | nt.assert_equal(h._repr_html_(), (s, {"isolated": True})) |
|
344 | 348 | |
|
345 | 349 | def test_display_id(): |
|
346 | 350 | ip = get_ipython() |
|
347 | 351 | with mock.patch.object(ip.display_pub, 'publish') as pub: |
|
348 | 352 | handle = display.display('x') |
|
349 | 353 | nt.assert_is(handle, None) |
|
350 | 354 | handle = display.display('y', display_id='secret') |
|
351 | 355 | nt.assert_is_instance(handle, display.DisplayHandle) |
|
352 | 356 | handle2 = display.display('z', display_id=True) |
|
353 | 357 | nt.assert_is_instance(handle2, display.DisplayHandle) |
|
354 | 358 | nt.assert_not_equal(handle.display_id, handle2.display_id) |
|
355 | 359 | |
|
356 | 360 | nt.assert_equal(pub.call_count, 3) |
|
357 | 361 | args, kwargs = pub.call_args_list[0] |
|
358 | 362 | nt.assert_equal(args, ()) |
|
359 | 363 | nt.assert_equal(kwargs, { |
|
360 | 364 | 'data': { |
|
361 | 365 | 'text/plain': repr('x') |
|
362 | 366 | }, |
|
363 | 367 | 'metadata': {}, |
|
364 | 368 | }) |
|
365 | 369 | args, kwargs = pub.call_args_list[1] |
|
366 | 370 | nt.assert_equal(args, ()) |
|
367 | 371 | nt.assert_equal(kwargs, { |
|
368 | 372 | 'data': { |
|
369 | 373 | 'text/plain': repr('y') |
|
370 | 374 | }, |
|
371 | 375 | 'metadata': {}, |
|
372 | 376 | 'transient': { |
|
373 | 377 | 'display_id': handle.display_id, |
|
374 | 378 | }, |
|
375 | 379 | }) |
|
376 | 380 | args, kwargs = pub.call_args_list[2] |
|
377 | 381 | nt.assert_equal(args, ()) |
|
378 | 382 | nt.assert_equal(kwargs, { |
|
379 | 383 | 'data': { |
|
380 | 384 | 'text/plain': repr('z') |
|
381 | 385 | }, |
|
382 | 386 | 'metadata': {}, |
|
383 | 387 | 'transient': { |
|
384 | 388 | 'display_id': handle2.display_id, |
|
385 | 389 | }, |
|
386 | 390 | }) |
|
387 | 391 | |
|
388 | 392 | |
|
389 | 393 | def test_update_display(): |
|
390 | 394 | ip = get_ipython() |
|
391 | 395 | with mock.patch.object(ip.display_pub, 'publish') as pub: |
|
392 | 396 | with nt.assert_raises(TypeError): |
|
393 | 397 | display.update_display('x') |
|
394 | 398 | display.update_display('x', display_id='1') |
|
395 | 399 | display.update_display('y', display_id='2') |
|
396 | 400 | args, kwargs = pub.call_args_list[0] |
|
397 | 401 | nt.assert_equal(args, ()) |
|
398 | 402 | nt.assert_equal(kwargs, { |
|
399 | 403 | 'data': { |
|
400 | 404 | 'text/plain': repr('x') |
|
401 | 405 | }, |
|
402 | 406 | 'metadata': {}, |
|
403 | 407 | 'transient': { |
|
404 | 408 | 'display_id': '1', |
|
405 | 409 | }, |
|
406 | 410 | 'update': True, |
|
407 | 411 | }) |
|
408 | 412 | args, kwargs = pub.call_args_list[1] |
|
409 | 413 | nt.assert_equal(args, ()) |
|
410 | 414 | nt.assert_equal(kwargs, { |
|
411 | 415 | 'data': { |
|
412 | 416 | 'text/plain': repr('y') |
|
413 | 417 | }, |
|
414 | 418 | 'metadata': {}, |
|
415 | 419 | 'transient': { |
|
416 | 420 | 'display_id': '2', |
|
417 | 421 | }, |
|
418 | 422 | 'update': True, |
|
419 | 423 | }) |
|
420 | 424 | |
|
421 | 425 | |
|
422 | 426 | def test_display_handle(): |
|
423 | 427 | ip = get_ipython() |
|
424 | 428 | handle = display.DisplayHandle() |
|
425 | 429 | nt.assert_is_instance(handle.display_id, str) |
|
426 | 430 | handle = display.DisplayHandle('my-id') |
|
427 | 431 | nt.assert_equal(handle.display_id, 'my-id') |
|
428 | 432 | with mock.patch.object(ip.display_pub, 'publish') as pub: |
|
429 | 433 | handle.display('x') |
|
430 | 434 | handle.update('y') |
|
431 | 435 | |
|
432 | 436 | args, kwargs = pub.call_args_list[0] |
|
433 | 437 | nt.assert_equal(args, ()) |
|
434 | 438 | nt.assert_equal(kwargs, { |
|
435 | 439 | 'data': { |
|
436 | 440 | 'text/plain': repr('x') |
|
437 | 441 | }, |
|
438 | 442 | 'metadata': {}, |
|
439 | 443 | 'transient': { |
|
440 | 444 | 'display_id': handle.display_id, |
|
441 | 445 | } |
|
442 | 446 | }) |
|
443 | 447 | args, kwargs = pub.call_args_list[1] |
|
444 | 448 | nt.assert_equal(args, ()) |
|
445 | 449 | nt.assert_equal(kwargs, { |
|
446 | 450 | 'data': { |
|
447 | 451 | 'text/plain': repr('y') |
|
448 | 452 | }, |
|
449 | 453 | 'metadata': {}, |
|
450 | 454 | 'transient': { |
|
451 | 455 | 'display_id': handle.display_id, |
|
452 | 456 | }, |
|
453 | 457 | 'update': True, |
|
454 | 458 | }) |
|
455 | 459 |
@@ -1,1266 +1,1257 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Tests for various magic functions. |
|
3 | 3 | |
|
4 | 4 | Needs to be run by nose (to make ipython session available). |
|
5 | 5 | """ |
|
6 | 6 | |
|
7 | 7 | import io |
|
8 | 8 | import os |
|
9 | 9 | import re |
|
10 | 10 | import sys |
|
11 | 11 | import warnings |
|
12 | 12 | from textwrap import dedent |
|
13 | 13 | from unittest import TestCase |
|
14 | 14 | from unittest import mock |
|
15 | 15 | from importlib import invalidate_caches |
|
16 | 16 | from io import StringIO |
|
17 | from pathlib import Path | |
|
17 | 18 | |
|
18 | 19 | import nose.tools as nt |
|
19 | 20 | |
|
20 | 21 | import shlex |
|
21 | 22 | |
|
22 | 23 | from IPython import get_ipython |
|
23 | 24 | from IPython.core import magic |
|
24 | 25 | from IPython.core.error import UsageError |
|
25 | 26 | from IPython.core.magic import (Magics, magics_class, line_magic, |
|
26 | 27 | cell_magic, |
|
27 | 28 | register_line_magic, register_cell_magic) |
|
28 | 29 | from IPython.core.magics import execution, script, code, logging, osm |
|
29 | 30 | from IPython.testing import decorators as dec |
|
30 | 31 | from IPython.testing import tools as tt |
|
31 | 32 | from IPython.utils.io import capture_output |
|
32 | 33 | from IPython.utils.tempdir import (TemporaryDirectory, |
|
33 | 34 | TemporaryWorkingDirectory) |
|
34 | 35 | from IPython.utils.process import find_cmd |
|
35 | 36 | from .test_debugger import PdbTestInput |
|
36 | 37 | |
|
37 | 38 | |
|
38 | 39 | @magic.magics_class |
|
39 | 40 | class DummyMagics(magic.Magics): pass |
|
40 | 41 | |
|
41 | 42 | def test_extract_code_ranges(): |
|
42 | 43 | instr = "1 3 5-6 7-9 10:15 17: :10 10- -13 :" |
|
43 | 44 | expected = [(0, 1), |
|
44 | 45 | (2, 3), |
|
45 | 46 | (4, 6), |
|
46 | 47 | (6, 9), |
|
47 | 48 | (9, 14), |
|
48 | 49 | (16, None), |
|
49 | 50 | (None, 9), |
|
50 | 51 | (9, None), |
|
51 | 52 | (None, 13), |
|
52 | 53 | (None, None)] |
|
53 | 54 | actual = list(code.extract_code_ranges(instr)) |
|
54 | 55 | nt.assert_equal(actual, expected) |
|
55 | 56 | |
|
56 | 57 | def test_extract_symbols(): |
|
57 | 58 | source = """import foo\na = 10\ndef b():\n return 42\n\n\nclass A: pass\n\n\n""" |
|
58 | 59 | symbols_args = ["a", "b", "A", "A,b", "A,a", "z"] |
|
59 | 60 | expected = [([], ['a']), |
|
60 | 61 | (["def b():\n return 42\n"], []), |
|
61 | 62 | (["class A: pass\n"], []), |
|
62 | 63 | (["class A: pass\n", "def b():\n return 42\n"], []), |
|
63 | 64 | (["class A: pass\n"], ['a']), |
|
64 | 65 | ([], ['z'])] |
|
65 | 66 | for symbols, exp in zip(symbols_args, expected): |
|
66 | 67 | nt.assert_equal(code.extract_symbols(source, symbols), exp) |
|
67 | 68 | |
|
68 | 69 | |
|
69 | 70 | def test_extract_symbols_raises_exception_with_non_python_code(): |
|
70 | 71 | source = ("=begin A Ruby program :)=end\n" |
|
71 | 72 | "def hello\n" |
|
72 | 73 | "puts 'Hello world'\n" |
|
73 | 74 | "end") |
|
74 | 75 | with nt.assert_raises(SyntaxError): |
|
75 | 76 | code.extract_symbols(source, "hello") |
|
76 | 77 | |
|
77 | 78 | |
|
78 | 79 | def test_magic_not_found(): |
|
79 | 80 | # magic not found raises UsageError |
|
80 | 81 | with nt.assert_raises(UsageError): |
|
81 | 82 | _ip.magic('doesntexist') |
|
82 | 83 | |
|
83 | 84 | # ensure result isn't success when a magic isn't found |
|
84 | 85 | result = _ip.run_cell('%doesntexist') |
|
85 | 86 | assert isinstance(result.error_in_exec, UsageError) |
|
86 | 87 | |
|
87 | 88 | |
|
88 | 89 | def test_cell_magic_not_found(): |
|
89 | 90 | # magic not found raises UsageError |
|
90 | 91 | with nt.assert_raises(UsageError): |
|
91 | 92 | _ip.run_cell_magic('doesntexist', 'line', 'cell') |
|
92 | 93 | |
|
93 | 94 | # ensure result isn't success when a magic isn't found |
|
94 | 95 | result = _ip.run_cell('%%doesntexist') |
|
95 | 96 | assert isinstance(result.error_in_exec, UsageError) |
|
96 | 97 | |
|
97 | 98 | |
|
98 | 99 | def test_magic_error_status(): |
|
99 | 100 | def fail(shell): |
|
100 | 101 | 1/0 |
|
101 | 102 | _ip.register_magic_function(fail) |
|
102 | 103 | result = _ip.run_cell('%fail') |
|
103 | 104 | assert isinstance(result.error_in_exec, ZeroDivisionError) |
|
104 | 105 | |
|
105 | 106 | |
|
106 | 107 | def test_config(): |
|
107 | 108 | """ test that config magic does not raise |
|
108 | 109 | can happen if Configurable init is moved too early into |
|
109 | 110 | Magics.__init__ as then a Config object will be registered as a |
|
110 | 111 | magic. |
|
111 | 112 | """ |
|
112 | 113 | ## should not raise. |
|
113 | 114 | _ip.magic('config') |
|
114 | 115 | |
|
115 | 116 | def test_config_available_configs(): |
|
116 | 117 | """ test that config magic prints available configs in unique and |
|
117 | 118 | sorted order. """ |
|
118 | 119 | with capture_output() as captured: |
|
119 | 120 | _ip.magic('config') |
|
120 | 121 | |
|
121 | 122 | stdout = captured.stdout |
|
122 | 123 | config_classes = stdout.strip().split('\n')[1:] |
|
123 | 124 | nt.assert_list_equal(config_classes, sorted(set(config_classes))) |
|
124 | 125 | |
|
125 | 126 | def test_config_print_class(): |
|
126 | 127 | """ test that config with a classname prints the class's options. """ |
|
127 | 128 | with capture_output() as captured: |
|
128 | 129 | _ip.magic('config TerminalInteractiveShell') |
|
129 | 130 | |
|
130 | 131 | stdout = captured.stdout |
|
131 | 132 | if not re.match("TerminalInteractiveShell.* options", stdout.splitlines()[0]): |
|
132 | 133 | print(stdout) |
|
133 | 134 | raise AssertionError("1st line of stdout not like " |
|
134 | 135 | "'TerminalInteractiveShell.* options'") |
|
135 | 136 | |
|
136 | 137 | def test_rehashx(): |
|
137 | 138 | # clear up everything |
|
138 | 139 | _ip.alias_manager.clear_aliases() |
|
139 | 140 | del _ip.db['syscmdlist'] |
|
140 | 141 | |
|
141 | 142 | _ip.magic('rehashx') |
|
142 | 143 | # Practically ALL ipython development systems will have more than 10 aliases |
|
143 | 144 | |
|
144 | 145 | nt.assert_true(len(_ip.alias_manager.aliases) > 10) |
|
145 | 146 | for name, cmd in _ip.alias_manager.aliases: |
|
146 | 147 | # we must strip dots from alias names |
|
147 | 148 | nt.assert_not_in('.', name) |
|
148 | 149 | |
|
149 | 150 | # rehashx must fill up syscmdlist |
|
150 | 151 | scoms = _ip.db['syscmdlist'] |
|
151 | 152 | nt.assert_true(len(scoms) > 10) |
|
152 | 153 | |
|
153 | 154 | |
|
154 | 155 | |
|
155 | 156 | def test_magic_parse_options(): |
|
156 | 157 | """Test that we don't mangle paths when parsing magic options.""" |
|
157 | 158 | ip = get_ipython() |
|
158 | 159 | path = 'c:\\x' |
|
159 | 160 | m = DummyMagics(ip) |
|
160 | 161 | opts = m.parse_options('-f %s' % path,'f:')[0] |
|
161 | 162 | # argv splitting is os-dependent |
|
162 | 163 | if os.name == 'posix': |
|
163 | 164 | expected = 'c:x' |
|
164 | 165 | else: |
|
165 | 166 | expected = path |
|
166 | 167 | nt.assert_equal(opts['f'], expected) |
|
167 | 168 | |
|
168 | 169 | def test_magic_parse_long_options(): |
|
169 | 170 | """Magic.parse_options can handle --foo=bar long options""" |
|
170 | 171 | ip = get_ipython() |
|
171 | 172 | m = DummyMagics(ip) |
|
172 | 173 | opts, _ = m.parse_options('--foo --bar=bubble', 'a', 'foo', 'bar=') |
|
173 | 174 | nt.assert_in('foo', opts) |
|
174 | 175 | nt.assert_in('bar', opts) |
|
175 | 176 | nt.assert_equal(opts['bar'], "bubble") |
|
176 | 177 | |
|
177 | 178 | |
|
178 | 179 | def doctest_hist_f(): |
|
179 | 180 | """Test %hist -f with temporary filename. |
|
180 | 181 | |
|
181 | 182 | In [9]: import tempfile |
|
182 | 183 | |
|
183 | 184 | In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-') |
|
184 | 185 | |
|
185 | 186 | In [11]: %hist -nl -f $tfile 3 |
|
186 | 187 | |
|
187 | 188 | In [13]: import os; os.unlink(tfile) |
|
188 | 189 | """ |
|
189 | 190 | |
|
190 | 191 | |
|
191 | 192 | def doctest_hist_op(): |
|
192 | 193 | """Test %hist -op |
|
193 | 194 | |
|
194 | 195 | In [1]: class b(float): |
|
195 | 196 | ...: pass |
|
196 | 197 | ...: |
|
197 | 198 | |
|
198 | 199 | In [2]: class s(object): |
|
199 | 200 | ...: def __str__(self): |
|
200 | 201 | ...: return 's' |
|
201 | 202 | ...: |
|
202 | 203 | |
|
203 | 204 | In [3]: |
|
204 | 205 | |
|
205 | 206 | In [4]: class r(b): |
|
206 | 207 | ...: def __repr__(self): |
|
207 | 208 | ...: return 'r' |
|
208 | 209 | ...: |
|
209 | 210 | |
|
210 | 211 | In [5]: class sr(s,r): pass |
|
211 | 212 | ...: |
|
212 | 213 | |
|
213 | 214 | In [6]: |
|
214 | 215 | |
|
215 | 216 | In [7]: bb=b() |
|
216 | 217 | |
|
217 | 218 | In [8]: ss=s() |
|
218 | 219 | |
|
219 | 220 | In [9]: rr=r() |
|
220 | 221 | |
|
221 | 222 | In [10]: ssrr=sr() |
|
222 | 223 | |
|
223 | 224 | In [11]: 4.5 |
|
224 | 225 | Out[11]: 4.5 |
|
225 | 226 | |
|
226 | 227 | In [12]: str(ss) |
|
227 | 228 | Out[12]: 's' |
|
228 | 229 | |
|
229 | 230 | In [13]: |
|
230 | 231 | |
|
231 | 232 | In [14]: %hist -op |
|
232 | 233 | >>> class b: |
|
233 | 234 | ... pass |
|
234 | 235 | ... |
|
235 | 236 | >>> class s(b): |
|
236 | 237 | ... def __str__(self): |
|
237 | 238 | ... return 's' |
|
238 | 239 | ... |
|
239 | 240 | >>> |
|
240 | 241 | >>> class r(b): |
|
241 | 242 | ... def __repr__(self): |
|
242 | 243 | ... return 'r' |
|
243 | 244 | ... |
|
244 | 245 | >>> class sr(s,r): pass |
|
245 | 246 | >>> |
|
246 | 247 | >>> bb=b() |
|
247 | 248 | >>> ss=s() |
|
248 | 249 | >>> rr=r() |
|
249 | 250 | >>> ssrr=sr() |
|
250 | 251 | >>> 4.5 |
|
251 | 252 | 4.5 |
|
252 | 253 | >>> str(ss) |
|
253 | 254 | 's' |
|
254 | 255 | >>> |
|
255 | 256 | """ |
|
256 | 257 | |
|
257 | 258 | def test_hist_pof(): |
|
258 | 259 | ip = get_ipython() |
|
259 | 260 | ip.run_cell(u"1+2", store_history=True) |
|
260 | 261 | #raise Exception(ip.history_manager.session_number) |
|
261 | 262 | #raise Exception(list(ip.history_manager._get_range_session())) |
|
262 | 263 | with TemporaryDirectory() as td: |
|
263 | 264 | tf = os.path.join(td, 'hist.py') |
|
264 | 265 | ip.run_line_magic('history', '-pof %s' % tf) |
|
265 | 266 | assert os.path.isfile(tf) |
|
266 | 267 | |
|
267 | 268 | |
|
268 | 269 | def test_macro(): |
|
269 | 270 | ip = get_ipython() |
|
270 | 271 | ip.history_manager.reset() # Clear any existing history. |
|
271 | 272 | cmds = ["a=1", "def b():\n return a**2", "print(a,b())"] |
|
272 | 273 | for i, cmd in enumerate(cmds, start=1): |
|
273 | 274 | ip.history_manager.store_inputs(i, cmd) |
|
274 | 275 | ip.magic("macro test 1-3") |
|
275 | 276 | nt.assert_equal(ip.user_ns["test"].value, "\n".join(cmds)+"\n") |
|
276 | 277 | |
|
277 | 278 | # List macros |
|
278 | 279 | nt.assert_in("test", ip.magic("macro")) |
|
279 | 280 | |
|
280 | 281 | |
|
281 | 282 | def test_macro_run(): |
|
282 | 283 | """Test that we can run a multi-line macro successfully.""" |
|
283 | 284 | ip = get_ipython() |
|
284 | 285 | ip.history_manager.reset() |
|
285 | 286 | cmds = ["a=10", "a+=1", "print(a)", "%macro test 2-3"] |
|
286 | 287 | for cmd in cmds: |
|
287 | 288 | ip.run_cell(cmd, store_history=True) |
|
288 | 289 | nt.assert_equal(ip.user_ns["test"].value, "a+=1\nprint(a)\n") |
|
289 | 290 | with tt.AssertPrints("12"): |
|
290 | 291 | ip.run_cell("test") |
|
291 | 292 | with tt.AssertPrints("13"): |
|
292 | 293 | ip.run_cell("test") |
|
293 | 294 | |
|
294 | 295 | |
|
295 | 296 | def test_magic_magic(): |
|
296 | 297 | """Test %magic""" |
|
297 | 298 | ip = get_ipython() |
|
298 | 299 | with capture_output() as captured: |
|
299 | 300 | ip.magic("magic") |
|
300 | 301 | |
|
301 | 302 | stdout = captured.stdout |
|
302 | 303 | nt.assert_in('%magic', stdout) |
|
303 | 304 | nt.assert_in('IPython', stdout) |
|
304 | 305 | nt.assert_in('Available', stdout) |
|
305 | 306 | |
|
306 | 307 | |
|
307 | 308 | @dec.skipif_not_numpy |
|
308 | 309 | def test_numpy_reset_array_undec(): |
|
309 | 310 | "Test '%reset array' functionality" |
|
310 | 311 | _ip.ex('import numpy as np') |
|
311 | 312 | _ip.ex('a = np.empty(2)') |
|
312 | 313 | nt.assert_in('a', _ip.user_ns) |
|
313 | 314 | _ip.magic('reset -f array') |
|
314 | 315 | nt.assert_not_in('a', _ip.user_ns) |
|
315 | 316 | |
|
316 | 317 | def test_reset_out(): |
|
317 | 318 | "Test '%reset out' magic" |
|
318 | 319 | _ip.run_cell("parrot = 'dead'", store_history=True) |
|
319 | 320 | # test '%reset -f out', make an Out prompt |
|
320 | 321 | _ip.run_cell("parrot", store_history=True) |
|
321 | 322 | nt.assert_true('dead' in [_ip.user_ns[x] for x in ('_','__','___')]) |
|
322 | 323 | _ip.magic('reset -f out') |
|
323 | 324 | nt.assert_false('dead' in [_ip.user_ns[x] for x in ('_','__','___')]) |
|
324 | 325 | nt.assert_equal(len(_ip.user_ns['Out']), 0) |
|
325 | 326 | |
|
326 | 327 | def test_reset_in(): |
|
327 | 328 | "Test '%reset in' magic" |
|
328 | 329 | # test '%reset -f in' |
|
329 | 330 | _ip.run_cell("parrot", store_history=True) |
|
330 | 331 | nt.assert_true('parrot' in [_ip.user_ns[x] for x in ('_i','_ii','_iii')]) |
|
331 | 332 | _ip.magic('%reset -f in') |
|
332 | 333 | nt.assert_false('parrot' in [_ip.user_ns[x] for x in ('_i','_ii','_iii')]) |
|
333 | 334 | nt.assert_equal(len(set(_ip.user_ns['In'])), 1) |
|
334 | 335 | |
|
335 | 336 | def test_reset_dhist(): |
|
336 | 337 | "Test '%reset dhist' magic" |
|
337 | 338 | _ip.run_cell("tmp = [d for d in _dh]") # copy before clearing |
|
338 | 339 | _ip.magic('cd ' + os.path.dirname(nt.__file__)) |
|
339 | 340 | _ip.magic('cd -') |
|
340 | 341 | nt.assert_true(len(_ip.user_ns['_dh']) > 0) |
|
341 | 342 | _ip.magic('reset -f dhist') |
|
342 | 343 | nt.assert_equal(len(_ip.user_ns['_dh']), 0) |
|
343 | 344 | _ip.run_cell("_dh = [d for d in tmp]") #restore |
|
344 | 345 | |
|
345 | 346 | def test_reset_in_length(): |
|
346 | 347 | "Test that '%reset in' preserves In[] length" |
|
347 | 348 | _ip.run_cell("print 'foo'") |
|
348 | 349 | _ip.run_cell("reset -f in") |
|
349 | 350 | nt.assert_equal(len(_ip.user_ns['In']), _ip.displayhook.prompt_count+1) |
|
350 | 351 | |
|
351 | 352 | class TestResetErrors(TestCase): |
|
352 | 353 | |
|
353 | 354 | def test_reset_redefine(self): |
|
354 | 355 | |
|
355 | 356 | @magics_class |
|
356 | 357 | class KernelMagics(Magics): |
|
357 | 358 | @line_magic |
|
358 | 359 | def less(self, shell): pass |
|
359 | 360 | |
|
360 | 361 | _ip.register_magics(KernelMagics) |
|
361 | 362 | |
|
362 | 363 | with self.assertLogs() as cm: |
|
363 | 364 | # hack, we want to just capture logs, but assertLogs fails if not |
|
364 | 365 | # logs get produce. |
|
365 | 366 | # so log one things we ignore. |
|
366 | 367 | import logging as log_mod |
|
367 | 368 | log = log_mod.getLogger() |
|
368 | 369 | log.info('Nothing') |
|
369 | 370 | # end hack. |
|
370 | 371 | _ip.run_cell("reset -f") |
|
371 | 372 | |
|
372 | 373 | assert len(cm.output) == 1 |
|
373 | 374 | for out in cm.output: |
|
374 | 375 | assert "Invalid alias" not in out |
|
375 | 376 | |
|
376 | 377 | def test_tb_syntaxerror(): |
|
377 | 378 | """test %tb after a SyntaxError""" |
|
378 | 379 | ip = get_ipython() |
|
379 | 380 | ip.run_cell("for") |
|
380 | 381 | |
|
381 | 382 | # trap and validate stdout |
|
382 | 383 | save_stdout = sys.stdout |
|
383 | 384 | try: |
|
384 | 385 | sys.stdout = StringIO() |
|
385 | 386 | ip.run_cell("%tb") |
|
386 | 387 | out = sys.stdout.getvalue() |
|
387 | 388 | finally: |
|
388 | 389 | sys.stdout = save_stdout |
|
389 | 390 | # trim output, and only check the last line |
|
390 | 391 | last_line = out.rstrip().splitlines()[-1].strip() |
|
391 | 392 | nt.assert_equal(last_line, "SyntaxError: invalid syntax") |
|
392 | 393 | |
|
393 | 394 | |
|
394 | 395 | def test_time(): |
|
395 | 396 | ip = get_ipython() |
|
396 | 397 | |
|
397 | 398 | with tt.AssertPrints("Wall time: "): |
|
398 | 399 | ip.run_cell("%time None") |
|
399 | 400 | |
|
400 | 401 | ip.run_cell("def f(kmjy):\n" |
|
401 | 402 | " %time print (2*kmjy)") |
|
402 | 403 | |
|
403 | 404 | with tt.AssertPrints("Wall time: "): |
|
404 | 405 | with tt.AssertPrints("hihi", suppress=False): |
|
405 | 406 | ip.run_cell("f('hi')") |
|
406 | 407 | |
|
407 | 408 | def test_time_last_not_expression(): |
|
408 | 409 | ip.run_cell("%%time\n" |
|
409 | 410 | "var_1 = 1\n" |
|
410 | 411 | "var_2 = 2\n") |
|
411 | 412 | assert ip.user_ns['var_1'] == 1 |
|
412 | 413 | del ip.user_ns['var_1'] |
|
413 | 414 | assert ip.user_ns['var_2'] == 2 |
|
414 | 415 | del ip.user_ns['var_2'] |
|
415 | 416 | |
|
416 | 417 | |
|
417 | 418 | @dec.skip_win32 |
|
418 | 419 | def test_time2(): |
|
419 | 420 | ip = get_ipython() |
|
420 | 421 | |
|
421 | 422 | with tt.AssertPrints("CPU times: user "): |
|
422 | 423 | ip.run_cell("%time None") |
|
423 | 424 | |
|
424 | 425 | def test_time3(): |
|
425 | 426 | """Erroneous magic function calls, issue gh-3334""" |
|
426 | 427 | ip = get_ipython() |
|
427 | 428 | ip.user_ns.pop('run', None) |
|
428 | 429 | |
|
429 | 430 | with tt.AssertNotPrints("not found", channel='stderr'): |
|
430 | 431 | ip.run_cell("%%time\n" |
|
431 | 432 | "run = 0\n" |
|
432 | 433 | "run += 1") |
|
433 | 434 | |
|
434 | 435 | def test_multiline_time(): |
|
435 | 436 | """Make sure last statement from time return a value.""" |
|
436 | 437 | ip = get_ipython() |
|
437 | 438 | ip.user_ns.pop('run', None) |
|
438 | 439 | |
|
439 | 440 | ip.run_cell(dedent("""\ |
|
440 | 441 | %%time |
|
441 | 442 | a = "ho" |
|
442 | 443 | b = "hey" |
|
443 | 444 | a+b |
|
444 | 445 | """)) |
|
445 | 446 | nt.assert_equal(ip.user_ns_hidden['_'], 'hohey') |
|
446 | 447 | |
|
447 | 448 | def test_time_local_ns(): |
|
448 | 449 | """ |
|
449 | 450 | Test that local_ns is actually global_ns when running a cell magic |
|
450 | 451 | """ |
|
451 | 452 | ip = get_ipython() |
|
452 | 453 | ip.run_cell("%%time\n" |
|
453 | 454 | "myvar = 1") |
|
454 | 455 | nt.assert_equal(ip.user_ns['myvar'], 1) |
|
455 | 456 | del ip.user_ns['myvar'] |
|
456 | 457 | |
|
457 | 458 | def test_doctest_mode(): |
|
458 | 459 | "Toggle doctest_mode twice, it should be a no-op and run without error" |
|
459 | 460 | _ip.magic('doctest_mode') |
|
460 | 461 | _ip.magic('doctest_mode') |
|
461 | 462 | |
|
462 | 463 | |
|
463 | 464 | def test_parse_options(): |
|
464 | 465 | """Tests for basic options parsing in magics.""" |
|
465 | 466 | # These are only the most minimal of tests, more should be added later. At |
|
466 | 467 | # the very least we check that basic text/unicode calls work OK. |
|
467 | 468 | m = DummyMagics(_ip) |
|
468 | 469 | nt.assert_equal(m.parse_options('foo', '')[1], 'foo') |
|
469 | 470 | nt.assert_equal(m.parse_options(u'foo', '')[1], u'foo') |
|
470 | 471 | |
|
471 | 472 | |
|
472 | 473 | def test_dirops(): |
|
473 | 474 | """Test various directory handling operations.""" |
|
474 | 475 | # curpath = lambda :os.path.splitdrive(os.getcwd())[1].replace('\\','/') |
|
475 | 476 | curpath = os.getcwd |
|
476 | 477 | startdir = os.getcwd() |
|
477 | 478 | ipdir = os.path.realpath(_ip.ipython_dir) |
|
478 | 479 | try: |
|
479 | 480 | _ip.magic('cd "%s"' % ipdir) |
|
480 | 481 | nt.assert_equal(curpath(), ipdir) |
|
481 | 482 | _ip.magic('cd -') |
|
482 | 483 | nt.assert_equal(curpath(), startdir) |
|
483 | 484 | _ip.magic('pushd "%s"' % ipdir) |
|
484 | 485 | nt.assert_equal(curpath(), ipdir) |
|
485 | 486 | _ip.magic('popd') |
|
486 | 487 | nt.assert_equal(curpath(), startdir) |
|
487 | 488 | finally: |
|
488 | 489 | os.chdir(startdir) |
|
489 | 490 | |
|
490 | 491 | |
|
491 | 492 | def test_cd_force_quiet(): |
|
492 | 493 | """Test OSMagics.cd_force_quiet option""" |
|
493 | 494 | _ip.config.OSMagics.cd_force_quiet = True |
|
494 | 495 | osmagics = osm.OSMagics(shell=_ip) |
|
495 | 496 | |
|
496 | 497 | startdir = os.getcwd() |
|
497 | 498 | ipdir = os.path.realpath(_ip.ipython_dir) |
|
498 | 499 | |
|
499 | 500 | try: |
|
500 | 501 | with tt.AssertNotPrints(ipdir): |
|
501 | 502 | osmagics.cd('"%s"' % ipdir) |
|
502 | 503 | with tt.AssertNotPrints(startdir): |
|
503 | 504 | osmagics.cd('-') |
|
504 | 505 | finally: |
|
505 | 506 | os.chdir(startdir) |
|
506 | 507 | |
|
507 | 508 | |
|
508 | 509 | def test_xmode(): |
|
509 | 510 | # Calling xmode three times should be a no-op |
|
510 | 511 | xmode = _ip.InteractiveTB.mode |
|
511 | 512 | for i in range(4): |
|
512 | 513 | _ip.magic("xmode") |
|
513 | 514 | nt.assert_equal(_ip.InteractiveTB.mode, xmode) |
|
514 | 515 | |
|
515 | 516 | def test_reset_hard(): |
|
516 | 517 | monitor = [] |
|
517 | 518 | class A(object): |
|
518 | 519 | def __del__(self): |
|
519 | 520 | monitor.append(1) |
|
520 | 521 | def __repr__(self): |
|
521 | 522 | return "<A instance>" |
|
522 | 523 | |
|
523 | 524 | _ip.user_ns["a"] = A() |
|
524 | 525 | _ip.run_cell("a") |
|
525 | 526 | |
|
526 | 527 | nt.assert_equal(monitor, []) |
|
527 | 528 | _ip.magic("reset -f") |
|
528 | 529 | nt.assert_equal(monitor, [1]) |
|
529 | 530 | |
|
530 | 531 | class TestXdel(tt.TempFileMixin): |
|
531 | 532 | def test_xdel(self): |
|
532 | 533 | """Test that references from %run are cleared by xdel.""" |
|
533 | 534 | src = ("class A(object):\n" |
|
534 | 535 | " monitor = []\n" |
|
535 | 536 | " def __del__(self):\n" |
|
536 | 537 | " self.monitor.append(1)\n" |
|
537 | 538 | "a = A()\n") |
|
538 | 539 | self.mktmp(src) |
|
539 | 540 | # %run creates some hidden references... |
|
540 | 541 | _ip.magic("run %s" % self.fname) |
|
541 | 542 | # ... as does the displayhook. |
|
542 | 543 | _ip.run_cell("a") |
|
543 | 544 | |
|
544 | 545 | monitor = _ip.user_ns["A"].monitor |
|
545 | 546 | nt.assert_equal(monitor, []) |
|
546 | 547 | |
|
547 | 548 | _ip.magic("xdel a") |
|
548 | 549 | |
|
549 | 550 | # Check that a's __del__ method has been called. |
|
550 | 551 | nt.assert_equal(monitor, [1]) |
|
551 | 552 | |
|
552 | 553 | def doctest_who(): |
|
553 | 554 | """doctest for %who |
|
554 | 555 | |
|
555 | 556 | In [1]: %reset -f |
|
556 | 557 | |
|
557 | 558 | In [2]: alpha = 123 |
|
558 | 559 | |
|
559 | 560 | In [3]: beta = 'beta' |
|
560 | 561 | |
|
561 | 562 | In [4]: %who int |
|
562 | 563 | alpha |
|
563 | 564 | |
|
564 | 565 | In [5]: %who str |
|
565 | 566 | beta |
|
566 | 567 | |
|
567 | 568 | In [6]: %whos |
|
568 | 569 | Variable Type Data/Info |
|
569 | 570 | ---------------------------- |
|
570 | 571 | alpha int 123 |
|
571 | 572 | beta str beta |
|
572 | 573 | |
|
573 | 574 | In [7]: %who_ls |
|
574 | 575 | Out[7]: ['alpha', 'beta'] |
|
575 | 576 | """ |
|
576 | 577 | |
|
577 | 578 | def test_whos(): |
|
578 | 579 | """Check that whos is protected against objects where repr() fails.""" |
|
579 | 580 | class A(object): |
|
580 | 581 | def __repr__(self): |
|
581 | 582 | raise Exception() |
|
582 | 583 | _ip.user_ns['a'] = A() |
|
583 | 584 | _ip.magic("whos") |
|
584 | 585 | |
|
585 | 586 | def doctest_precision(): |
|
586 | 587 | """doctest for %precision |
|
587 | 588 | |
|
588 | 589 | In [1]: f = get_ipython().display_formatter.formatters['text/plain'] |
|
589 | 590 | |
|
590 | 591 | In [2]: %precision 5 |
|
591 | 592 | Out[2]: '%.5f' |
|
592 | 593 | |
|
593 | 594 | In [3]: f.float_format |
|
594 | 595 | Out[3]: '%.5f' |
|
595 | 596 | |
|
596 | 597 | In [4]: %precision %e |
|
597 | 598 | Out[4]: '%e' |
|
598 | 599 | |
|
599 | 600 | In [5]: f(3.1415927) |
|
600 | 601 | Out[5]: '3.141593e+00' |
|
601 | 602 | """ |
|
602 | 603 | |
|
603 | 604 | def test_debug_magic(): |
|
604 | 605 | """Test debugging a small code with %debug |
|
605 | 606 | |
|
606 | 607 | In [1]: with PdbTestInput(['c']): |
|
607 | 608 | ...: %debug print("a b") #doctest: +ELLIPSIS |
|
608 | 609 | ...: |
|
609 | 610 | ... |
|
610 | 611 | ipdb> c |
|
611 | 612 | a b |
|
612 | 613 | In [2]: |
|
613 | 614 | """ |
|
614 | 615 | |
|
615 | 616 | def test_psearch(): |
|
616 | 617 | with tt.AssertPrints("dict.fromkeys"): |
|
617 | 618 | _ip.run_cell("dict.fr*?") |
|
618 | 619 | with tt.AssertPrints("Ο.is_integer"): |
|
619 | 620 | _ip.run_cell("Ο = 3.14;\nΟ.is_integ*?") |
|
620 | 621 | |
|
621 | 622 | def test_timeit_shlex(): |
|
622 | 623 | """test shlex issues with timeit (#1109)""" |
|
623 | 624 | _ip.ex("def f(*a,**kw): pass") |
|
624 | 625 | _ip.magic('timeit -n1 "this is a bug".count(" ")') |
|
625 | 626 | _ip.magic('timeit -r1 -n1 f(" ", 1)') |
|
626 | 627 | _ip.magic('timeit -r1 -n1 f(" ", 1, " ", 2, " ")') |
|
627 | 628 | _ip.magic('timeit -r1 -n1 ("a " + "b")') |
|
628 | 629 | _ip.magic('timeit -r1 -n1 f("a " + "b")') |
|
629 | 630 | _ip.magic('timeit -r1 -n1 f("a " + "b ")') |
|
630 | 631 | |
|
631 | 632 | |
|
632 | 633 | def test_timeit_special_syntax(): |
|
633 | 634 | "Test %%timeit with IPython special syntax" |
|
634 | 635 | @register_line_magic |
|
635 | 636 | def lmagic(line): |
|
636 | 637 | ip = get_ipython() |
|
637 | 638 | ip.user_ns['lmagic_out'] = line |
|
638 | 639 | |
|
639 | 640 | # line mode test |
|
640 | 641 | _ip.run_line_magic('timeit', '-n1 -r1 %lmagic my line') |
|
641 | 642 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line') |
|
642 | 643 | # cell mode test |
|
643 | 644 | _ip.run_cell_magic('timeit', '-n1 -r1', '%lmagic my line2') |
|
644 | 645 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line2') |
|
645 | 646 | |
|
646 | 647 | def test_timeit_return(): |
|
647 | 648 | """ |
|
648 | 649 | test whether timeit -o return object |
|
649 | 650 | """ |
|
650 | 651 | |
|
651 | 652 | res = _ip.run_line_magic('timeit','-n10 -r10 -o 1') |
|
652 | 653 | assert(res is not None) |
|
653 | 654 | |
|
654 | 655 | def test_timeit_quiet(): |
|
655 | 656 | """ |
|
656 | 657 | test quiet option of timeit magic |
|
657 | 658 | """ |
|
658 | 659 | with tt.AssertNotPrints("loops"): |
|
659 | 660 | _ip.run_cell("%timeit -n1 -r1 -q 1") |
|
660 | 661 | |
|
661 | 662 | def test_timeit_return_quiet(): |
|
662 | 663 | with tt.AssertNotPrints("loops"): |
|
663 | 664 | res = _ip.run_line_magic('timeit', '-n1 -r1 -q -o 1') |
|
664 | 665 | assert (res is not None) |
|
665 | 666 | |
|
666 | 667 | def test_timeit_invalid_return(): |
|
667 | 668 | with nt.assert_raises_regex(SyntaxError, "outside function"): |
|
668 | 669 | _ip.run_line_magic('timeit', 'return') |
|
669 | 670 | |
|
670 | 671 | @dec.skipif(execution.profile is None) |
|
671 | 672 | def test_prun_special_syntax(): |
|
672 | 673 | "Test %%prun with IPython special syntax" |
|
673 | 674 | @register_line_magic |
|
674 | 675 | def lmagic(line): |
|
675 | 676 | ip = get_ipython() |
|
676 | 677 | ip.user_ns['lmagic_out'] = line |
|
677 | 678 | |
|
678 | 679 | # line mode test |
|
679 | 680 | _ip.run_line_magic('prun', '-q %lmagic my line') |
|
680 | 681 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line') |
|
681 | 682 | # cell mode test |
|
682 | 683 | _ip.run_cell_magic('prun', '-q', '%lmagic my line2') |
|
683 | 684 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line2') |
|
684 | 685 | |
|
685 | 686 | @dec.skipif(execution.profile is None) |
|
686 | 687 | def test_prun_quotes(): |
|
687 | 688 | "Test that prun does not clobber string escapes (GH #1302)" |
|
688 | 689 | _ip.magic(r"prun -q x = '\t'") |
|
689 | 690 | nt.assert_equal(_ip.user_ns['x'], '\t') |
|
690 | 691 | |
|
691 | 692 | def test_extension(): |
|
692 | 693 | # Debugging information for failures of this test |
|
693 | 694 | print('sys.path:') |
|
694 | 695 | for p in sys.path: |
|
695 | 696 | print(' ', p) |
|
696 | 697 | print('CWD', os.getcwd()) |
|
697 | 698 | |
|
698 | 699 | nt.assert_raises(ImportError, _ip.magic, "load_ext daft_extension") |
|
699 | 700 | daft_path = os.path.join(os.path.dirname(__file__), "daft_extension") |
|
700 | 701 | sys.path.insert(0, daft_path) |
|
701 | 702 | try: |
|
702 | 703 | _ip.user_ns.pop('arq', None) |
|
703 | 704 | invalidate_caches() # Clear import caches |
|
704 | 705 | _ip.magic("load_ext daft_extension") |
|
705 | 706 | nt.assert_equal(_ip.user_ns['arq'], 185) |
|
706 | 707 | _ip.magic("unload_ext daft_extension") |
|
707 | 708 | assert 'arq' not in _ip.user_ns |
|
708 | 709 | finally: |
|
709 | 710 | sys.path.remove(daft_path) |
|
710 | 711 | |
|
711 | 712 | |
|
712 | 713 | def test_notebook_export_json(): |
|
713 | 714 | _ip = get_ipython() |
|
714 | 715 | _ip.history_manager.reset() # Clear any existing history. |
|
715 | 716 | cmds = [u"a=1", u"def b():\n return a**2", u"print('noΓ«l, Γ©tΓ©', b())"] |
|
716 | 717 | for i, cmd in enumerate(cmds, start=1): |
|
717 | 718 | _ip.history_manager.store_inputs(i, cmd) |
|
718 | 719 | with TemporaryDirectory() as td: |
|
719 | 720 | outfile = os.path.join(td, "nb.ipynb") |
|
720 | 721 | _ip.magic("notebook -e %s" % outfile) |
|
721 | 722 | |
|
722 | 723 | |
|
723 | 724 | class TestEnv(TestCase): |
|
724 | 725 | |
|
725 | 726 | def test_env(self): |
|
726 | 727 | env = _ip.magic("env") |
|
727 | 728 | self.assertTrue(isinstance(env, dict)) |
|
728 | 729 | |
|
729 | 730 | def test_env_secret(self): |
|
730 | 731 | env = _ip.magic("env") |
|
731 | 732 | hidden = "<hidden>" |
|
732 | 733 | with mock.patch.dict( |
|
733 | 734 | os.environ, |
|
734 | 735 | { |
|
735 | 736 | "API_KEY": "abc123", |
|
736 | 737 | "SECRET_THING": "ssshhh", |
|
737 | 738 | "JUPYTER_TOKEN": "", |
|
738 | 739 | "VAR": "abc" |
|
739 | 740 | } |
|
740 | 741 | ): |
|
741 | 742 | env = _ip.magic("env") |
|
742 | 743 | assert env["API_KEY"] == hidden |
|
743 | 744 | assert env["SECRET_THING"] == hidden |
|
744 | 745 | assert env["JUPYTER_TOKEN"] == hidden |
|
745 | 746 | assert env["VAR"] == "abc" |
|
746 | 747 | |
|
747 | 748 | def test_env_get_set_simple(self): |
|
748 | 749 | env = _ip.magic("env var val1") |
|
749 | 750 | self.assertEqual(env, None) |
|
750 | 751 | self.assertEqual(os.environ['var'], 'val1') |
|
751 | 752 | self.assertEqual(_ip.magic("env var"), 'val1') |
|
752 | 753 | env = _ip.magic("env var=val2") |
|
753 | 754 | self.assertEqual(env, None) |
|
754 | 755 | self.assertEqual(os.environ['var'], 'val2') |
|
755 | 756 | |
|
756 | 757 | def test_env_get_set_complex(self): |
|
757 | 758 | env = _ip.magic("env var 'val1 '' 'val2") |
|
758 | 759 | self.assertEqual(env, None) |
|
759 | 760 | self.assertEqual(os.environ['var'], "'val1 '' 'val2") |
|
760 | 761 | self.assertEqual(_ip.magic("env var"), "'val1 '' 'val2") |
|
761 | 762 | env = _ip.magic('env var=val2 val3="val4') |
|
762 | 763 | self.assertEqual(env, None) |
|
763 | 764 | self.assertEqual(os.environ['var'], 'val2 val3="val4') |
|
764 | 765 | |
|
765 | 766 | def test_env_set_bad_input(self): |
|
766 | 767 | self.assertRaises(UsageError, lambda: _ip.magic("set_env var")) |
|
767 | 768 | |
|
768 | 769 | def test_env_set_whitespace(self): |
|
769 | 770 | self.assertRaises(UsageError, lambda: _ip.magic("env var A=B")) |
|
770 | 771 | |
|
771 | 772 | |
|
772 | 773 | class CellMagicTestCase(TestCase): |
|
773 | 774 | |
|
774 | 775 | def check_ident(self, magic): |
|
775 | 776 | # Manually called, we get the result |
|
776 | 777 | out = _ip.run_cell_magic(magic, 'a', 'b') |
|
777 | 778 | nt.assert_equal(out, ('a','b')) |
|
778 | 779 | # Via run_cell, it goes into the user's namespace via displayhook |
|
779 | 780 | _ip.run_cell('%%' + magic +' c\nd\n') |
|
780 | 781 | nt.assert_equal(_ip.user_ns['_'], ('c','d\n')) |
|
781 | 782 | |
|
782 | 783 | def test_cell_magic_func_deco(self): |
|
783 | 784 | "Cell magic using simple decorator" |
|
784 | 785 | @register_cell_magic |
|
785 | 786 | def cellm(line, cell): |
|
786 | 787 | return line, cell |
|
787 | 788 | |
|
788 | 789 | self.check_ident('cellm') |
|
789 | 790 | |
|
790 | 791 | def test_cell_magic_reg(self): |
|
791 | 792 | "Cell magic manually registered" |
|
792 | 793 | def cellm(line, cell): |
|
793 | 794 | return line, cell |
|
794 | 795 | |
|
795 | 796 | _ip.register_magic_function(cellm, 'cell', 'cellm2') |
|
796 | 797 | self.check_ident('cellm2') |
|
797 | 798 | |
|
798 | 799 | def test_cell_magic_class(self): |
|
799 | 800 | "Cell magics declared via a class" |
|
800 | 801 | @magics_class |
|
801 | 802 | class MyMagics(Magics): |
|
802 | 803 | |
|
803 | 804 | @cell_magic |
|
804 | 805 | def cellm3(self, line, cell): |
|
805 | 806 | return line, cell |
|
806 | 807 | |
|
807 | 808 | _ip.register_magics(MyMagics) |
|
808 | 809 | self.check_ident('cellm3') |
|
809 | 810 | |
|
810 | 811 | def test_cell_magic_class2(self): |
|
811 | 812 | "Cell magics declared via a class, #2" |
|
812 | 813 | @magics_class |
|
813 | 814 | class MyMagics2(Magics): |
|
814 | 815 | |
|
815 | 816 | @cell_magic('cellm4') |
|
816 | 817 | def cellm33(self, line, cell): |
|
817 | 818 | return line, cell |
|
818 | 819 | |
|
819 | 820 | _ip.register_magics(MyMagics2) |
|
820 | 821 | self.check_ident('cellm4') |
|
821 | 822 | # Check that nothing is registered as 'cellm33' |
|
822 | 823 | c33 = _ip.find_cell_magic('cellm33') |
|
823 | 824 | nt.assert_equal(c33, None) |
|
824 | 825 | |
|
825 | 826 | def test_file(): |
|
826 | 827 | """Basic %%writefile""" |
|
827 | 828 | ip = get_ipython() |
|
828 | 829 | with TemporaryDirectory() as td: |
|
829 | 830 | fname = os.path.join(td, 'file1') |
|
830 | 831 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
831 | 832 | 'line1', |
|
832 | 833 | 'line2', |
|
833 | 834 | ])) |
|
834 | with open(fname) as f: | |
|
835 | s = f.read() | |
|
835 | s = Path(fname).read_text() | |
|
836 | 836 | nt.assert_in('line1\n', s) |
|
837 | 837 | nt.assert_in('line2', s) |
|
838 | 838 | |
|
839 | 839 | @dec.skip_win32 |
|
840 | 840 | def test_file_single_quote(): |
|
841 | 841 | """Basic %%writefile with embedded single quotes""" |
|
842 | 842 | ip = get_ipython() |
|
843 | 843 | with TemporaryDirectory() as td: |
|
844 | 844 | fname = os.path.join(td, '\'file1\'') |
|
845 | 845 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
846 | 846 | 'line1', |
|
847 | 847 | 'line2', |
|
848 | 848 | ])) |
|
849 | with open(fname) as f: | |
|
850 | s = f.read() | |
|
849 | s = Path(fname).read_text() | |
|
851 | 850 | nt.assert_in('line1\n', s) |
|
852 | 851 | nt.assert_in('line2', s) |
|
853 | 852 | |
|
854 | 853 | @dec.skip_win32 |
|
855 | 854 | def test_file_double_quote(): |
|
856 | 855 | """Basic %%writefile with embedded double quotes""" |
|
857 | 856 | ip = get_ipython() |
|
858 | 857 | with TemporaryDirectory() as td: |
|
859 | 858 | fname = os.path.join(td, '"file1"') |
|
860 | 859 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
861 | 860 | 'line1', |
|
862 | 861 | 'line2', |
|
863 | 862 | ])) |
|
864 | with open(fname) as f: | |
|
865 | s = f.read() | |
|
863 | s = Path(fname).read_text() | |
|
866 | 864 | nt.assert_in('line1\n', s) |
|
867 | 865 | nt.assert_in('line2', s) |
|
868 | 866 | |
|
869 | 867 | def test_file_var_expand(): |
|
870 | 868 | """%%writefile $filename""" |
|
871 | 869 | ip = get_ipython() |
|
872 | 870 | with TemporaryDirectory() as td: |
|
873 | 871 | fname = os.path.join(td, 'file1') |
|
874 | 872 | ip.user_ns['filename'] = fname |
|
875 | 873 | ip.run_cell_magic("writefile", '$filename', u'\n'.join([ |
|
876 | 874 | 'line1', |
|
877 | 875 | 'line2', |
|
878 | 876 | ])) |
|
879 | with open(fname) as f: | |
|
880 | s = f.read() | |
|
877 | s = Path(fname).read_text() | |
|
881 | 878 | nt.assert_in('line1\n', s) |
|
882 | 879 | nt.assert_in('line2', s) |
|
883 | 880 | |
|
884 | 881 | def test_file_unicode(): |
|
885 | 882 | """%%writefile with unicode cell""" |
|
886 | 883 | ip = get_ipython() |
|
887 | 884 | with TemporaryDirectory() as td: |
|
888 | 885 | fname = os.path.join(td, 'file1') |
|
889 | 886 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
890 | 887 | u'linΓ©1', |
|
891 | 888 | u'linΓ©2', |
|
892 | 889 | ])) |
|
893 | 890 | with io.open(fname, encoding='utf-8') as f: |
|
894 | 891 | s = f.read() |
|
895 | 892 | nt.assert_in(u'linΓ©1\n', s) |
|
896 | 893 | nt.assert_in(u'linΓ©2', s) |
|
897 | 894 | |
|
898 | 895 | def test_file_amend(): |
|
899 | 896 | """%%writefile -a amends files""" |
|
900 | 897 | ip = get_ipython() |
|
901 | 898 | with TemporaryDirectory() as td: |
|
902 | 899 | fname = os.path.join(td, 'file2') |
|
903 | 900 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
904 | 901 | 'line1', |
|
905 | 902 | 'line2', |
|
906 | 903 | ])) |
|
907 | 904 | ip.run_cell_magic("writefile", "-a %s" % fname, u'\n'.join([ |
|
908 | 905 | 'line3', |
|
909 | 906 | 'line4', |
|
910 | 907 | ])) |
|
911 | with open(fname) as f: | |
|
912 | s = f.read() | |
|
908 | s = Path(fname).read_text() | |
|
913 | 909 | nt.assert_in('line1\n', s) |
|
914 | 910 | nt.assert_in('line3\n', s) |
|
915 | 911 | |
|
916 | 912 | def test_file_spaces(): |
|
917 | 913 | """%%file with spaces in filename""" |
|
918 | 914 | ip = get_ipython() |
|
919 | 915 | with TemporaryWorkingDirectory() as td: |
|
920 | 916 | fname = "file name" |
|
921 | 917 | ip.run_cell_magic("file", '"%s"'%fname, u'\n'.join([ |
|
922 | 918 | 'line1', |
|
923 | 919 | 'line2', |
|
924 | 920 | ])) |
|
925 | with open(fname) as f: | |
|
926 | s = f.read() | |
|
921 | s = Path(fname).read_text() | |
|
927 | 922 | nt.assert_in('line1\n', s) |
|
928 | 923 | nt.assert_in('line2', s) |
|
929 | 924 | |
|
930 | 925 | def test_script_config(): |
|
931 | 926 | ip = get_ipython() |
|
932 | 927 | ip.config.ScriptMagics.script_magics = ['whoda'] |
|
933 | 928 | sm = script.ScriptMagics(shell=ip) |
|
934 | 929 | nt.assert_in('whoda', sm.magics['cell']) |
|
935 | 930 | |
|
936 | 931 | @dec.skip_win32 |
|
937 | 932 | def test_script_out(): |
|
938 | 933 | ip = get_ipython() |
|
939 | 934 | ip.run_cell_magic("script", "--out output sh", "echo 'hi'") |
|
940 | 935 | nt.assert_equal(ip.user_ns['output'], 'hi\n') |
|
941 | 936 | |
|
942 | 937 | @dec.skip_win32 |
|
943 | 938 | def test_script_err(): |
|
944 | 939 | ip = get_ipython() |
|
945 | 940 | ip.run_cell_magic("script", "--err error sh", "echo 'hello' >&2") |
|
946 | 941 | nt.assert_equal(ip.user_ns['error'], 'hello\n') |
|
947 | 942 | |
|
948 | 943 | @dec.skip_win32 |
|
949 | 944 | def test_script_out_err(): |
|
950 | 945 | ip = get_ipython() |
|
951 | 946 | ip.run_cell_magic("script", "--out output --err error sh", "echo 'hi'\necho 'hello' >&2") |
|
952 | 947 | nt.assert_equal(ip.user_ns['output'], 'hi\n') |
|
953 | 948 | nt.assert_equal(ip.user_ns['error'], 'hello\n') |
|
954 | 949 | |
|
955 | 950 | @dec.skip_win32 |
|
956 | 951 | def test_script_bg_out(): |
|
957 | 952 | ip = get_ipython() |
|
958 | 953 | ip.run_cell_magic("script", "--bg --out output sh", "echo 'hi'") |
|
959 | 954 | |
|
960 | 955 | nt.assert_equal(ip.user_ns['output'].read(), b'hi\n') |
|
961 | 956 | ip.user_ns['output'].close() |
|
962 | 957 | |
|
963 | 958 | @dec.skip_win32 |
|
964 | 959 | def test_script_bg_err(): |
|
965 | 960 | ip = get_ipython() |
|
966 | 961 | ip.run_cell_magic("script", "--bg --err error sh", "echo 'hello' >&2") |
|
967 | 962 | nt.assert_equal(ip.user_ns['error'].read(), b'hello\n') |
|
968 | 963 | ip.user_ns['error'].close() |
|
969 | 964 | |
|
970 | 965 | @dec.skip_win32 |
|
971 | 966 | def test_script_bg_out_err(): |
|
972 | 967 | ip = get_ipython() |
|
973 | 968 | ip.run_cell_magic("script", "--bg --out output --err error sh", "echo 'hi'\necho 'hello' >&2") |
|
974 | 969 | nt.assert_equal(ip.user_ns['output'].read(), b'hi\n') |
|
975 | 970 | nt.assert_equal(ip.user_ns['error'].read(), b'hello\n') |
|
976 | 971 | ip.user_ns['output'].close() |
|
977 | 972 | ip.user_ns['error'].close() |
|
978 | 973 | |
|
979 | 974 | def test_script_defaults(): |
|
980 | 975 | ip = get_ipython() |
|
981 | 976 | for cmd in ['sh', 'bash', 'perl', 'ruby']: |
|
982 | 977 | try: |
|
983 | 978 | find_cmd(cmd) |
|
984 | 979 | except Exception: |
|
985 | 980 | pass |
|
986 | 981 | else: |
|
987 | 982 | nt.assert_in(cmd, ip.magics_manager.magics['cell']) |
|
988 | 983 | |
|
989 | 984 | |
|
990 | 985 | @magics_class |
|
991 | 986 | class FooFoo(Magics): |
|
992 | 987 | """class with both %foo and %%foo magics""" |
|
993 | 988 | @line_magic('foo') |
|
994 | 989 | def line_foo(self, line): |
|
995 | 990 | "I am line foo" |
|
996 | 991 | pass |
|
997 | 992 | |
|
998 | 993 | @cell_magic("foo") |
|
999 | 994 | def cell_foo(self, line, cell): |
|
1000 | 995 | "I am cell foo, not line foo" |
|
1001 | 996 | pass |
|
1002 | 997 | |
|
1003 | 998 | def test_line_cell_info(): |
|
1004 | 999 | """%%foo and %foo magics are distinguishable to inspect""" |
|
1005 | 1000 | ip = get_ipython() |
|
1006 | 1001 | ip.magics_manager.register(FooFoo) |
|
1007 | 1002 | oinfo = ip.object_inspect('foo') |
|
1008 | 1003 | nt.assert_true(oinfo['found']) |
|
1009 | 1004 | nt.assert_true(oinfo['ismagic']) |
|
1010 | 1005 | |
|
1011 | 1006 | oinfo = ip.object_inspect('%%foo') |
|
1012 | 1007 | nt.assert_true(oinfo['found']) |
|
1013 | 1008 | nt.assert_true(oinfo['ismagic']) |
|
1014 | 1009 | nt.assert_equal(oinfo['docstring'], FooFoo.cell_foo.__doc__) |
|
1015 | 1010 | |
|
1016 | 1011 | oinfo = ip.object_inspect('%foo') |
|
1017 | 1012 | nt.assert_true(oinfo['found']) |
|
1018 | 1013 | nt.assert_true(oinfo['ismagic']) |
|
1019 | 1014 | nt.assert_equal(oinfo['docstring'], FooFoo.line_foo.__doc__) |
|
1020 | 1015 | |
|
1021 | 1016 | def test_multiple_magics(): |
|
1022 | 1017 | ip = get_ipython() |
|
1023 | 1018 | foo1 = FooFoo(ip) |
|
1024 | 1019 | foo2 = FooFoo(ip) |
|
1025 | 1020 | mm = ip.magics_manager |
|
1026 | 1021 | mm.register(foo1) |
|
1027 | 1022 | nt.assert_true(mm.magics['line']['foo'].__self__ is foo1) |
|
1028 | 1023 | mm.register(foo2) |
|
1029 | 1024 | nt.assert_true(mm.magics['line']['foo'].__self__ is foo2) |
|
1030 | 1025 | |
|
1031 | 1026 | def test_alias_magic(): |
|
1032 | 1027 | """Test %alias_magic.""" |
|
1033 | 1028 | ip = get_ipython() |
|
1034 | 1029 | mm = ip.magics_manager |
|
1035 | 1030 | |
|
1036 | 1031 | # Basic operation: both cell and line magics are created, if possible. |
|
1037 | 1032 | ip.run_line_magic('alias_magic', 'timeit_alias timeit') |
|
1038 | 1033 | nt.assert_in('timeit_alias', mm.magics['line']) |
|
1039 | 1034 | nt.assert_in('timeit_alias', mm.magics['cell']) |
|
1040 | 1035 | |
|
1041 | 1036 | # --cell is specified, line magic not created. |
|
1042 | 1037 | ip.run_line_magic('alias_magic', '--cell timeit_cell_alias timeit') |
|
1043 | 1038 | nt.assert_not_in('timeit_cell_alias', mm.magics['line']) |
|
1044 | 1039 | nt.assert_in('timeit_cell_alias', mm.magics['cell']) |
|
1045 | 1040 | |
|
1046 | 1041 | # Test that line alias is created successfully. |
|
1047 | 1042 | ip.run_line_magic('alias_magic', '--line env_alias env') |
|
1048 | 1043 | nt.assert_equal(ip.run_line_magic('env', ''), |
|
1049 | 1044 | ip.run_line_magic('env_alias', '')) |
|
1050 | 1045 | |
|
1051 | 1046 | # Test that line alias with parameters passed in is created successfully. |
|
1052 | 1047 | ip.run_line_magic('alias_magic', '--line history_alias history --params ' + shlex.quote('3')) |
|
1053 | 1048 | nt.assert_in('history_alias', mm.magics['line']) |
|
1054 | 1049 | |
|
1055 | 1050 | |
|
1056 | 1051 | def test_save(): |
|
1057 | 1052 | """Test %save.""" |
|
1058 | 1053 | ip = get_ipython() |
|
1059 | 1054 | ip.history_manager.reset() # Clear any existing history. |
|
1060 | 1055 | cmds = [u"a=1", u"def b():\n return a**2", u"print(a, b())"] |
|
1061 | 1056 | for i, cmd in enumerate(cmds, start=1): |
|
1062 | 1057 | ip.history_manager.store_inputs(i, cmd) |
|
1063 | 1058 | with TemporaryDirectory() as tmpdir: |
|
1064 | 1059 | file = os.path.join(tmpdir, "testsave.py") |
|
1065 | 1060 | ip.run_line_magic("save", "%s 1-10" % file) |
|
1066 | with open(file) as f: | |
|
1067 | content = f.read() | |
|
1068 | nt.assert_equal(content.count(cmds[0]), 1) | |
|
1069 | nt.assert_in('coding: utf-8', content) | |
|
1061 | content = Path(file).read_text() | |
|
1062 | nt.assert_equal(content.count(cmds[0]), 1) | |
|
1063 | nt.assert_in("coding: utf-8", content) | |
|
1070 | 1064 | ip.run_line_magic("save", "-a %s 1-10" % file) |
|
1071 | with open(file) as f: | |
|
1072 | content = f.read() | |
|
1073 | nt.assert_equal(content.count(cmds[0]), 2) | |
|
1074 | nt.assert_in('coding: utf-8', content) | |
|
1065 | content = Path(file).read_text() | |
|
1066 | nt.assert_equal(content.count(cmds[0]), 2) | |
|
1067 | nt.assert_in("coding: utf-8", content) | |
|
1075 | 1068 | |
|
1076 | 1069 | |
|
1077 | 1070 | def test_store(): |
|
1078 | 1071 | """Test %store.""" |
|
1079 | 1072 | ip = get_ipython() |
|
1080 | 1073 | ip.run_line_magic('load_ext', 'storemagic') |
|
1081 | 1074 | |
|
1082 | 1075 | # make sure the storage is empty |
|
1083 | 1076 | ip.run_line_magic('store', '-z') |
|
1084 | 1077 | ip.user_ns['var'] = 42 |
|
1085 | 1078 | ip.run_line_magic('store', 'var') |
|
1086 | 1079 | ip.user_ns['var'] = 39 |
|
1087 | 1080 | ip.run_line_magic('store', '-r') |
|
1088 | 1081 | nt.assert_equal(ip.user_ns['var'], 42) |
|
1089 | 1082 | |
|
1090 | 1083 | ip.run_line_magic('store', '-d var') |
|
1091 | 1084 | ip.user_ns['var'] = 39 |
|
1092 | 1085 | ip.run_line_magic('store' , '-r') |
|
1093 | 1086 | nt.assert_equal(ip.user_ns['var'], 39) |
|
1094 | 1087 | |
|
1095 | 1088 | |
|
1096 | 1089 | def _run_edit_test(arg_s, exp_filename=None, |
|
1097 | 1090 | exp_lineno=-1, |
|
1098 | 1091 | exp_contents=None, |
|
1099 | 1092 | exp_is_temp=None): |
|
1100 | 1093 | ip = get_ipython() |
|
1101 | 1094 | M = code.CodeMagics(ip) |
|
1102 | 1095 | last_call = ['',''] |
|
1103 | 1096 | opts,args = M.parse_options(arg_s,'prxn:') |
|
1104 | 1097 | filename, lineno, is_temp = M._find_edit_target(ip, args, opts, last_call) |
|
1105 | 1098 | |
|
1106 | 1099 | if exp_filename is not None: |
|
1107 | 1100 | nt.assert_equal(exp_filename, filename) |
|
1108 | 1101 | if exp_contents is not None: |
|
1109 | 1102 | with io.open(filename, 'r', encoding='utf-8') as f: |
|
1110 | 1103 | contents = f.read() |
|
1111 | 1104 | nt.assert_equal(exp_contents, contents) |
|
1112 | 1105 | if exp_lineno != -1: |
|
1113 | 1106 | nt.assert_equal(exp_lineno, lineno) |
|
1114 | 1107 | if exp_is_temp is not None: |
|
1115 | 1108 | nt.assert_equal(exp_is_temp, is_temp) |
|
1116 | 1109 | |
|
1117 | 1110 | |
|
1118 | 1111 | def test_edit_interactive(): |
|
1119 | 1112 | """%edit on interactively defined objects""" |
|
1120 | 1113 | ip = get_ipython() |
|
1121 | 1114 | n = ip.execution_count |
|
1122 | 1115 | ip.run_cell(u"def foo(): return 1", store_history=True) |
|
1123 | 1116 | |
|
1124 | 1117 | try: |
|
1125 | 1118 | _run_edit_test("foo") |
|
1126 | 1119 | except code.InteractivelyDefined as e: |
|
1127 | 1120 | nt.assert_equal(e.index, n) |
|
1128 | 1121 | else: |
|
1129 | 1122 | raise AssertionError("Should have raised InteractivelyDefined") |
|
1130 | 1123 | |
|
1131 | 1124 | |
|
1132 | 1125 | def test_edit_cell(): |
|
1133 | 1126 | """%edit [cell id]""" |
|
1134 | 1127 | ip = get_ipython() |
|
1135 | 1128 | |
|
1136 | 1129 | ip.run_cell(u"def foo(): return 1", store_history=True) |
|
1137 | 1130 | |
|
1138 | 1131 | # test |
|
1139 | 1132 | _run_edit_test("1", exp_contents=ip.user_ns['In'][1], exp_is_temp=True) |
|
1140 | 1133 | |
|
1141 | 1134 | def test_edit_fname(): |
|
1142 | 1135 | """%edit file""" |
|
1143 | 1136 | # test |
|
1144 | 1137 | _run_edit_test("test file.py", exp_filename="test file.py") |
|
1145 | 1138 | |
|
1146 | 1139 | def test_bookmark(): |
|
1147 | 1140 | ip = get_ipython() |
|
1148 | 1141 | ip.run_line_magic('bookmark', 'bmname') |
|
1149 | 1142 | with tt.AssertPrints('bmname'): |
|
1150 | 1143 | ip.run_line_magic('bookmark', '-l') |
|
1151 | 1144 | ip.run_line_magic('bookmark', '-d bmname') |
|
1152 | 1145 | |
|
1153 | 1146 | def test_ls_magic(): |
|
1154 | 1147 | ip = get_ipython() |
|
1155 | 1148 | json_formatter = ip.display_formatter.formatters['application/json'] |
|
1156 | 1149 | json_formatter.enabled = True |
|
1157 | 1150 | lsmagic = ip.magic('lsmagic') |
|
1158 | 1151 | with warnings.catch_warnings(record=True) as w: |
|
1159 | 1152 | j = json_formatter(lsmagic) |
|
1160 | 1153 | nt.assert_equal(sorted(j), ['cell', 'line']) |
|
1161 | 1154 | nt.assert_equal(w, []) # no warnings |
|
1162 | 1155 | |
|
1163 | 1156 | def test_strip_initial_indent(): |
|
1164 | 1157 | def sii(s): |
|
1165 | 1158 | lines = s.splitlines() |
|
1166 | 1159 | return '\n'.join(code.strip_initial_indent(lines)) |
|
1167 | 1160 | |
|
1168 | 1161 | nt.assert_equal(sii(" a = 1\nb = 2"), "a = 1\nb = 2") |
|
1169 | 1162 | nt.assert_equal(sii(" a\n b\nc"), "a\n b\nc") |
|
1170 | 1163 | nt.assert_equal(sii("a\n b"), "a\n b") |
|
1171 | 1164 | |
|
1172 | 1165 | def test_logging_magic_quiet_from_arg(): |
|
1173 | 1166 | _ip.config.LoggingMagics.quiet = False |
|
1174 | 1167 | lm = logging.LoggingMagics(shell=_ip) |
|
1175 | 1168 | with TemporaryDirectory() as td: |
|
1176 | 1169 | try: |
|
1177 | 1170 | with tt.AssertNotPrints(re.compile("Activating.*")): |
|
1178 | 1171 | lm.logstart('-q {}'.format( |
|
1179 | 1172 | os.path.join(td, "quiet_from_arg.log"))) |
|
1180 | 1173 | finally: |
|
1181 | 1174 | _ip.logger.logstop() |
|
1182 | 1175 | |
|
1183 | 1176 | def test_logging_magic_quiet_from_config(): |
|
1184 | 1177 | _ip.config.LoggingMagics.quiet = True |
|
1185 | 1178 | lm = logging.LoggingMagics(shell=_ip) |
|
1186 | 1179 | with TemporaryDirectory() as td: |
|
1187 | 1180 | try: |
|
1188 | 1181 | with tt.AssertNotPrints(re.compile("Activating.*")): |
|
1189 | 1182 | lm.logstart(os.path.join(td, "quiet_from_config.log")) |
|
1190 | 1183 | finally: |
|
1191 | 1184 | _ip.logger.logstop() |
|
1192 | 1185 | |
|
1193 | 1186 | |
|
1194 | 1187 | def test_logging_magic_not_quiet(): |
|
1195 | 1188 | _ip.config.LoggingMagics.quiet = False |
|
1196 | 1189 | lm = logging.LoggingMagics(shell=_ip) |
|
1197 | 1190 | with TemporaryDirectory() as td: |
|
1198 | 1191 | try: |
|
1199 | 1192 | with tt.AssertPrints(re.compile("Activating.*")): |
|
1200 | 1193 | lm.logstart(os.path.join(td, "not_quiet.log")) |
|
1201 | 1194 | finally: |
|
1202 | 1195 | _ip.logger.logstop() |
|
1203 | 1196 | |
|
1204 | 1197 | |
|
1205 | 1198 | def test_time_no_var_expand(): |
|
1206 | 1199 | _ip.user_ns['a'] = 5 |
|
1207 | 1200 | _ip.user_ns['b'] = [] |
|
1208 | 1201 | _ip.magic('time b.append("{a}")') |
|
1209 | 1202 | assert _ip.user_ns['b'] == ['{a}'] |
|
1210 | 1203 | |
|
1211 | 1204 | |
|
1212 | 1205 | # this is slow, put at the end for local testing. |
|
1213 | 1206 | def test_timeit_arguments(): |
|
1214 | 1207 | "Test valid timeit arguments, should not cause SyntaxError (GH #1269)" |
|
1215 | 1208 | if sys.version_info < (3,7): |
|
1216 | 1209 | _ip.magic("timeit -n1 -r1 ('#')") |
|
1217 | 1210 | else: |
|
1218 | 1211 | # 3.7 optimize no-op statement like above out, and complain there is |
|
1219 | 1212 | # nothing in the for loop. |
|
1220 | 1213 | _ip.magic("timeit -n1 -r1 a=('#')") |
|
1221 | 1214 | |
|
1222 | 1215 | |
|
1223 | 1216 | TEST_MODULE = """ |
|
1224 | 1217 | print('Loaded my_tmp') |
|
1225 | 1218 | if __name__ == "__main__": |
|
1226 | 1219 | print('I just ran a script') |
|
1227 | 1220 | """ |
|
1228 | 1221 | |
|
1229 | 1222 | |
|
1230 | 1223 | def test_run_module_from_import_hook(): |
|
1231 | 1224 | "Test that a module can be loaded via an import hook" |
|
1232 | 1225 | with TemporaryDirectory() as tmpdir: |
|
1233 | 1226 | fullpath = os.path.join(tmpdir, 'my_tmp.py') |
|
1234 | with open(fullpath, 'w') as f: | |
|
1235 | f.write(TEST_MODULE) | |
|
1227 | Path(fullpath).write_text(TEST_MODULE) | |
|
1236 | 1228 | |
|
1237 | 1229 | class MyTempImporter(object): |
|
1238 | 1230 | def __init__(self): |
|
1239 | 1231 | pass |
|
1240 | 1232 | |
|
1241 | 1233 | def find_module(self, fullname, path=None): |
|
1242 | 1234 | if 'my_tmp' in fullname: |
|
1243 | 1235 | return self |
|
1244 | 1236 | return None |
|
1245 | 1237 | |
|
1246 | 1238 | def load_module(self, name): |
|
1247 | 1239 | import imp |
|
1248 | 1240 | return imp.load_source('my_tmp', fullpath) |
|
1249 | 1241 | |
|
1250 | 1242 | def get_code(self, fullname): |
|
1251 | with open(fullpath, 'r') as f: | |
|
1252 | return compile(f.read(), 'foo', 'exec') | |
|
1243 | return compile(Path(fullpath).read_text(), "foo", "exec") | |
|
1253 | 1244 | |
|
1254 | 1245 | def is_package(self, __): |
|
1255 | 1246 | return False |
|
1256 | 1247 | |
|
1257 | 1248 | sys.meta_path.insert(0, MyTempImporter()) |
|
1258 | 1249 | |
|
1259 | 1250 | with capture_output() as captured: |
|
1260 | 1251 | _ip.magic("run -m my_tmp") |
|
1261 | 1252 | _ip.run_cell("import my_tmp") |
|
1262 | 1253 | |
|
1263 | 1254 | output = "Loaded my_tmp\nI just ran a script\nLoaded my_tmp\n" |
|
1264 | 1255 | nt.assert_equal(output, captured.stdout) |
|
1265 | 1256 | |
|
1266 | 1257 | sys.meta_path.pop(0) |
@@ -1,1086 +1,1087 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | Verbose and colourful traceback formatting. |
|
4 | 4 | |
|
5 | 5 | **ColorTB** |
|
6 | 6 | |
|
7 | 7 | I've always found it a bit hard to visually parse tracebacks in Python. The |
|
8 | 8 | ColorTB class is a solution to that problem. It colors the different parts of a |
|
9 | 9 | traceback in a manner similar to what you would expect from a syntax-highlighting |
|
10 | 10 | text editor. |
|
11 | 11 | |
|
12 | 12 | Installation instructions for ColorTB:: |
|
13 | 13 | |
|
14 | 14 | import sys,ultratb |
|
15 | 15 | sys.excepthook = ultratb.ColorTB() |
|
16 | 16 | |
|
17 | 17 | **VerboseTB** |
|
18 | 18 | |
|
19 | 19 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds |
|
20 | 20 | of useful info when a traceback occurs. Ping originally had it spit out HTML |
|
21 | 21 | and intended it for CGI programmers, but why should they have all the fun? I |
|
22 | 22 | altered it to spit out colored text to the terminal. It's a bit overwhelming, |
|
23 | 23 | but kind of neat, and maybe useful for long-running programs that you believe |
|
24 | 24 | are bug-free. If a crash *does* occur in that type of program you want details. |
|
25 | 25 | Give it a shot--you'll love it or you'll hate it. |
|
26 | 26 | |
|
27 | 27 | .. note:: |
|
28 | 28 | |
|
29 | 29 | The Verbose mode prints the variables currently visible where the exception |
|
30 | 30 | happened (shortening their strings if too long). This can potentially be |
|
31 | 31 | very slow, if you happen to have a huge data structure whose string |
|
32 | 32 | representation is complex to compute. Your computer may appear to freeze for |
|
33 | 33 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback |
|
34 | 34 | with Ctrl-C (maybe hitting it more than once). |
|
35 | 35 | |
|
36 | 36 | If you encounter this kind of situation often, you may want to use the |
|
37 | 37 | Verbose_novars mode instead of the regular Verbose, which avoids formatting |
|
38 | 38 | variables (but otherwise includes the information and context given by |
|
39 | 39 | Verbose). |
|
40 | 40 | |
|
41 | 41 | .. note:: |
|
42 | 42 | |
|
43 | 43 | The verbose mode print all variables in the stack, which means it can |
|
44 | 44 | potentially leak sensitive information like access keys, or unencrypted |
|
45 | 45 | password. |
|
46 | 46 | |
|
47 | 47 | Installation instructions for VerboseTB:: |
|
48 | 48 | |
|
49 | 49 | import sys,ultratb |
|
50 | 50 | sys.excepthook = ultratb.VerboseTB() |
|
51 | 51 | |
|
52 | 52 | Note: Much of the code in this module was lifted verbatim from the standard |
|
53 | 53 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. |
|
54 | 54 | |
|
55 | 55 | Color schemes |
|
56 | 56 | ------------- |
|
57 | 57 | |
|
58 | 58 | The colors are defined in the class TBTools through the use of the |
|
59 | 59 | ColorSchemeTable class. Currently the following exist: |
|
60 | 60 | |
|
61 | 61 | - NoColor: allows all of this module to be used in any terminal (the color |
|
62 | 62 | escapes are just dummy blank strings). |
|
63 | 63 | |
|
64 | 64 | - Linux: is meant to look good in a terminal like the Linux console (black |
|
65 | 65 | or very dark background). |
|
66 | 66 | |
|
67 | 67 | - LightBG: similar to Linux but swaps dark/light colors to be more readable |
|
68 | 68 | in light background terminals. |
|
69 | 69 | |
|
70 | 70 | - Neutral: a neutral color scheme that should be readable on both light and |
|
71 | 71 | dark background |
|
72 | 72 | |
|
73 | 73 | You can implement other color schemes easily, the syntax is fairly |
|
74 | 74 | self-explanatory. Please send back new schemes you develop to the author for |
|
75 | 75 | possible inclusion in future releases. |
|
76 | 76 | |
|
77 | 77 | Inheritance diagram: |
|
78 | 78 | |
|
79 | 79 | .. inheritance-diagram:: IPython.core.ultratb |
|
80 | 80 | :parts: 3 |
|
81 | 81 | """ |
|
82 | 82 | |
|
83 | 83 | #***************************************************************************** |
|
84 | 84 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> |
|
85 | 85 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> |
|
86 | 86 | # |
|
87 | 87 | # Distributed under the terms of the BSD License. The full license is in |
|
88 | 88 | # the file COPYING, distributed as part of this software. |
|
89 | 89 | #***************************************************************************** |
|
90 | 90 | |
|
91 | 91 | |
|
92 | 92 | import inspect |
|
93 | 93 | import linecache |
|
94 | 94 | import pydoc |
|
95 | 95 | import sys |
|
96 | 96 | import time |
|
97 | 97 | import traceback |
|
98 | 98 | |
|
99 | 99 | import stack_data |
|
100 | 100 | from pygments.formatters.terminal256 import Terminal256Formatter |
|
101 | 101 | from pygments.styles import get_style_by_name |
|
102 | 102 | |
|
103 | 103 | # IPython's own modules |
|
104 | 104 | from IPython import get_ipython |
|
105 | 105 | from IPython.core import debugger |
|
106 | 106 | from IPython.core.display_trap import DisplayTrap |
|
107 | 107 | from IPython.core.excolors import exception_colors |
|
108 | 108 | from IPython.utils import path as util_path |
|
109 | 109 | from IPython.utils import py3compat |
|
110 | 110 | from IPython.utils.terminal import get_terminal_size |
|
111 | 111 | |
|
112 | 112 | import IPython.utils.colorable as colorable |
|
113 | 113 | |
|
114 | 114 | # Globals |
|
115 | 115 | # amount of space to put line numbers before verbose tracebacks |
|
116 | 116 | INDENT_SIZE = 8 |
|
117 | 117 | |
|
118 | 118 | # Default color scheme. This is used, for example, by the traceback |
|
119 | 119 | # formatter. When running in an actual IPython instance, the user's rc.colors |
|
120 | 120 | # value is used, but having a module global makes this functionality available |
|
121 | 121 | # to users of ultratb who are NOT running inside ipython. |
|
122 | 122 | DEFAULT_SCHEME = 'NoColor' |
|
123 | 123 | |
|
124 | 124 | # --------------------------------------------------------------------------- |
|
125 | 125 | # Code begins |
|
126 | 126 | |
|
127 | 127 | # Helper function -- largely belongs to VerboseTB, but we need the same |
|
128 | 128 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they |
|
129 | 129 | # can be recognized properly by ipython.el's py-traceback-line-re |
|
130 | 130 | # (SyntaxErrors have to be treated specially because they have no traceback) |
|
131 | 131 | |
|
132 | 132 | |
|
133 | 133 | def _format_traceback_lines(lines, Colors, has_colors, lvals): |
|
134 | 134 | """ |
|
135 | 135 | Format tracebacks lines with pointing arrow, leading numbers... |
|
136 | 136 | |
|
137 | 137 | Parameters |
|
138 | 138 | ---------- |
|
139 | 139 | lines : list[Line] |
|
140 | 140 | Colors |
|
141 | 141 | ColorScheme used. |
|
142 | 142 | lvals : str |
|
143 | 143 | Values of local variables, already colored, to inject just after the error line. |
|
144 | 144 | """ |
|
145 | 145 | numbers_width = INDENT_SIZE - 1 |
|
146 | 146 | res = [] |
|
147 | 147 | |
|
148 | 148 | for stack_line in lines: |
|
149 | 149 | if stack_line is stack_data.LINE_GAP: |
|
150 | 150 | res.append('%s (...)%s\n' % (Colors.linenoEm, Colors.Normal)) |
|
151 | 151 | continue |
|
152 | 152 | |
|
153 | 153 | line = stack_line.render(pygmented=has_colors).rstrip('\n') + '\n' |
|
154 | 154 | lineno = stack_line.lineno |
|
155 | 155 | if stack_line.is_current: |
|
156 | 156 | # This is the line with the error |
|
157 | 157 | pad = numbers_width - len(str(lineno)) |
|
158 | 158 | num = '%s%s' % (debugger.make_arrow(pad), str(lineno)) |
|
159 | 159 | start_color = Colors.linenoEm |
|
160 | 160 | else: |
|
161 | 161 | num = '%*s' % (numbers_width, lineno) |
|
162 | 162 | start_color = Colors.lineno |
|
163 | 163 | |
|
164 | 164 | line = '%s%s%s %s' % (start_color, num, Colors.Normal, line) |
|
165 | 165 | |
|
166 | 166 | res.append(line) |
|
167 | 167 | if lvals and stack_line.is_current: |
|
168 | 168 | res.append(lvals + '\n') |
|
169 | 169 | return res |
|
170 | 170 | |
|
171 | 171 | |
|
172 | 172 | #--------------------------------------------------------------------------- |
|
173 | 173 | # Module classes |
|
174 | 174 | class TBTools(colorable.Colorable): |
|
175 | 175 | """Basic tools used by all traceback printer classes.""" |
|
176 | 176 | |
|
177 | 177 | # Number of frames to skip when reporting tracebacks |
|
178 | 178 | tb_offset = 0 |
|
179 | 179 | |
|
180 | 180 | def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None, parent=None, config=None): |
|
181 | 181 | # Whether to call the interactive pdb debugger after printing |
|
182 | 182 | # tracebacks or not |
|
183 | 183 | super(TBTools, self).__init__(parent=parent, config=config) |
|
184 | 184 | self.call_pdb = call_pdb |
|
185 | 185 | |
|
186 | 186 | # Output stream to write to. Note that we store the original value in |
|
187 | 187 | # a private attribute and then make the public ostream a property, so |
|
188 | 188 | # that we can delay accessing sys.stdout until runtime. The way |
|
189 | 189 | # things are written now, the sys.stdout object is dynamically managed |
|
190 | 190 | # so a reference to it should NEVER be stored statically. This |
|
191 | 191 | # property approach confines this detail to a single location, and all |
|
192 | 192 | # subclasses can simply access self.ostream for writing. |
|
193 | 193 | self._ostream = ostream |
|
194 | 194 | |
|
195 | 195 | # Create color table |
|
196 | 196 | self.color_scheme_table = exception_colors() |
|
197 | 197 | |
|
198 | 198 | self.set_colors(color_scheme) |
|
199 | 199 | self.old_scheme = color_scheme # save initial value for toggles |
|
200 | 200 | |
|
201 | 201 | if call_pdb: |
|
202 | 202 | self.pdb = debugger.Pdb() |
|
203 | 203 | else: |
|
204 | 204 | self.pdb = None |
|
205 | 205 | |
|
206 | 206 | def _get_ostream(self): |
|
207 | 207 | """Output stream that exceptions are written to. |
|
208 | 208 | |
|
209 | 209 | Valid values are: |
|
210 | 210 | |
|
211 | 211 | - None: the default, which means that IPython will dynamically resolve |
|
212 | 212 | to sys.stdout. This ensures compatibility with most tools, including |
|
213 | 213 | Windows (where plain stdout doesn't recognize ANSI escapes). |
|
214 | 214 | |
|
215 | 215 | - Any object with 'write' and 'flush' attributes. |
|
216 | 216 | """ |
|
217 | 217 | return sys.stdout if self._ostream is None else self._ostream |
|
218 | 218 | |
|
219 | 219 | def _set_ostream(self, val): |
|
220 | 220 | assert val is None or (hasattr(val, 'write') and hasattr(val, 'flush')) |
|
221 | 221 | self._ostream = val |
|
222 | 222 | |
|
223 | 223 | ostream = property(_get_ostream, _set_ostream) |
|
224 | 224 | |
|
225 | 225 | def get_parts_of_chained_exception(self, evalue): |
|
226 | 226 | def get_chained_exception(exception_value): |
|
227 | 227 | cause = getattr(exception_value, '__cause__', None) |
|
228 | 228 | if cause: |
|
229 | 229 | return cause |
|
230 | 230 | if getattr(exception_value, '__suppress_context__', False): |
|
231 | 231 | return None |
|
232 | 232 | return getattr(exception_value, '__context__', None) |
|
233 | 233 | |
|
234 | 234 | chained_evalue = get_chained_exception(evalue) |
|
235 | 235 | |
|
236 | 236 | if chained_evalue: |
|
237 | 237 | return chained_evalue.__class__, chained_evalue, chained_evalue.__traceback__ |
|
238 | 238 | |
|
239 | 239 | def prepare_chained_exception_message(self, cause): |
|
240 | 240 | direct_cause = "\nThe above exception was the direct cause of the following exception:\n" |
|
241 | 241 | exception_during_handling = "\nDuring handling of the above exception, another exception occurred:\n" |
|
242 | 242 | |
|
243 | 243 | if cause: |
|
244 | 244 | message = [[direct_cause]] |
|
245 | 245 | else: |
|
246 | 246 | message = [[exception_during_handling]] |
|
247 | 247 | return message |
|
248 | 248 | |
|
249 | 249 | @property |
|
250 | 250 | def has_colors(self): |
|
251 | 251 | return self.color_scheme_table.active_scheme_name.lower() != "nocolor" |
|
252 | 252 | |
|
253 | 253 | def set_colors(self, *args, **kw): |
|
254 | 254 | """Shorthand access to the color table scheme selector method.""" |
|
255 | 255 | |
|
256 | 256 | # Set own color table |
|
257 | 257 | self.color_scheme_table.set_active_scheme(*args, **kw) |
|
258 | 258 | # for convenience, set Colors to the active scheme |
|
259 | 259 | self.Colors = self.color_scheme_table.active_colors |
|
260 | 260 | # Also set colors of debugger |
|
261 | 261 | if hasattr(self, 'pdb') and self.pdb is not None: |
|
262 | 262 | self.pdb.set_colors(*args, **kw) |
|
263 | 263 | |
|
264 | 264 | def color_toggle(self): |
|
265 | 265 | """Toggle between the currently active color scheme and NoColor.""" |
|
266 | 266 | |
|
267 | 267 | if self.color_scheme_table.active_scheme_name == 'NoColor': |
|
268 | 268 | self.color_scheme_table.set_active_scheme(self.old_scheme) |
|
269 | 269 | self.Colors = self.color_scheme_table.active_colors |
|
270 | 270 | else: |
|
271 | 271 | self.old_scheme = self.color_scheme_table.active_scheme_name |
|
272 | 272 | self.color_scheme_table.set_active_scheme('NoColor') |
|
273 | 273 | self.Colors = self.color_scheme_table.active_colors |
|
274 | 274 | |
|
275 | 275 | def stb2text(self, stb): |
|
276 | 276 | """Convert a structured traceback (a list) to a string.""" |
|
277 | 277 | return '\n'.join(stb) |
|
278 | 278 | |
|
279 | 279 | def text(self, etype, value, tb, tb_offset=None, context=5): |
|
280 | 280 | """Return formatted traceback. |
|
281 | 281 | |
|
282 | 282 | Subclasses may override this if they add extra arguments. |
|
283 | 283 | """ |
|
284 | 284 | tb_list = self.structured_traceback(etype, value, tb, |
|
285 | 285 | tb_offset, context) |
|
286 | 286 | return self.stb2text(tb_list) |
|
287 | 287 | |
|
288 | 288 | def structured_traceback(self, etype, evalue, tb, tb_offset=None, |
|
289 | 289 | context=5, mode=None): |
|
290 | 290 | """Return a list of traceback frames. |
|
291 | 291 | |
|
292 | 292 | Must be implemented by each class. |
|
293 | 293 | """ |
|
294 | 294 | raise NotImplementedError() |
|
295 | 295 | |
|
296 | 296 | |
|
297 | 297 | #--------------------------------------------------------------------------- |
|
298 | 298 | class ListTB(TBTools): |
|
299 | 299 | """Print traceback information from a traceback list, with optional color. |
|
300 | 300 | |
|
301 | 301 | Calling requires 3 arguments: (etype, evalue, elist) |
|
302 | 302 | as would be obtained by:: |
|
303 | 303 | |
|
304 | 304 | etype, evalue, tb = sys.exc_info() |
|
305 | 305 | if tb: |
|
306 | 306 | elist = traceback.extract_tb(tb) |
|
307 | 307 | else: |
|
308 | 308 | elist = None |
|
309 | 309 | |
|
310 | 310 | It can thus be used by programs which need to process the traceback before |
|
311 | 311 | printing (such as console replacements based on the code module from the |
|
312 | 312 | standard library). |
|
313 | 313 | |
|
314 | 314 | Because they are meant to be called without a full traceback (only a |
|
315 | 315 | list), instances of this class can't call the interactive pdb debugger.""" |
|
316 | 316 | |
|
317 | 317 | def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None, parent=None, config=None): |
|
318 | 318 | TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
319 | 319 | ostream=ostream, parent=parent,config=config) |
|
320 | 320 | |
|
321 | 321 | def __call__(self, etype, value, elist): |
|
322 | 322 | self.ostream.flush() |
|
323 | 323 | self.ostream.write(self.text(etype, value, elist)) |
|
324 | 324 | self.ostream.write('\n') |
|
325 | 325 | |
|
326 | 326 | def _extract_tb(self, tb): |
|
327 | 327 | if tb: |
|
328 | 328 | return traceback.extract_tb(tb) |
|
329 | 329 | else: |
|
330 | 330 | return None |
|
331 | 331 | |
|
332 | 332 | def structured_traceback(self, etype, evalue, etb=None, tb_offset=None, |
|
333 | 333 | context=5): |
|
334 | 334 | """Return a color formatted string with the traceback info. |
|
335 | 335 | |
|
336 | 336 | Parameters |
|
337 | 337 | ---------- |
|
338 | 338 | etype : exception type |
|
339 | 339 | Type of the exception raised. |
|
340 | 340 | evalue : object |
|
341 | 341 | Data stored in the exception |
|
342 | 342 | etb : object |
|
343 | 343 | If list: List of frames, see class docstring for details. |
|
344 | 344 | If Traceback: Traceback of the exception. |
|
345 | 345 | tb_offset : int, optional |
|
346 | 346 | Number of frames in the traceback to skip. If not given, the |
|
347 | 347 | instance evalue is used (set in constructor). |
|
348 | 348 | context : int, optional |
|
349 | 349 | Number of lines of context information to print. |
|
350 | 350 | |
|
351 | 351 | Returns |
|
352 | 352 | ------- |
|
353 | 353 | String with formatted exception. |
|
354 | 354 | """ |
|
355 | 355 | # This is a workaround to get chained_exc_ids in recursive calls |
|
356 | 356 | # etb should not be a tuple if structured_traceback is not recursive |
|
357 | 357 | if isinstance(etb, tuple): |
|
358 | 358 | etb, chained_exc_ids = etb |
|
359 | 359 | else: |
|
360 | 360 | chained_exc_ids = set() |
|
361 | 361 | |
|
362 | 362 | if isinstance(etb, list): |
|
363 | 363 | elist = etb |
|
364 | 364 | elif etb is not None: |
|
365 | 365 | elist = self._extract_tb(etb) |
|
366 | 366 | else: |
|
367 | 367 | elist = [] |
|
368 | 368 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
369 | 369 | Colors = self.Colors |
|
370 | 370 | out_list = [] |
|
371 | 371 | if elist: |
|
372 | 372 | |
|
373 | 373 | if tb_offset and len(elist) > tb_offset: |
|
374 | 374 | elist = elist[tb_offset:] |
|
375 | 375 | |
|
376 | 376 | out_list.append('Traceback %s(most recent call last)%s:' % |
|
377 | 377 | (Colors.normalEm, Colors.Normal) + '\n') |
|
378 | 378 | out_list.extend(self._format_list(elist)) |
|
379 | 379 | # The exception info should be a single entry in the list. |
|
380 | 380 | lines = ''.join(self._format_exception_only(etype, evalue)) |
|
381 | 381 | out_list.append(lines) |
|
382 | 382 | |
|
383 | 383 | exception = self.get_parts_of_chained_exception(evalue) |
|
384 | 384 | |
|
385 | 385 | if exception and not id(exception[1]) in chained_exc_ids: |
|
386 | 386 | chained_exception_message = self.prepare_chained_exception_message( |
|
387 | 387 | evalue.__cause__)[0] |
|
388 | 388 | etype, evalue, etb = exception |
|
389 | 389 | # Trace exception to avoid infinite 'cause' loop |
|
390 | 390 | chained_exc_ids.add(id(exception[1])) |
|
391 | 391 | chained_exceptions_tb_offset = 0 |
|
392 | 392 | out_list = ( |
|
393 | 393 | self.structured_traceback( |
|
394 | 394 | etype, evalue, (etb, chained_exc_ids), |
|
395 | 395 | chained_exceptions_tb_offset, context) |
|
396 | 396 | + chained_exception_message |
|
397 | 397 | + out_list) |
|
398 | 398 | |
|
399 | 399 | return out_list |
|
400 | 400 | |
|
401 | 401 | def _format_list(self, extracted_list): |
|
402 | 402 | """Format a list of traceback entry tuples for printing. |
|
403 | 403 | |
|
404 | 404 | Given a list of tuples as returned by extract_tb() or |
|
405 | 405 | extract_stack(), return a list of strings ready for printing. |
|
406 | 406 | Each string in the resulting list corresponds to the item with the |
|
407 | 407 | same index in the argument list. Each string ends in a newline; |
|
408 | 408 | the strings may contain internal newlines as well, for those items |
|
409 | 409 | whose source text line is not None. |
|
410 | 410 | |
|
411 | 411 | Lifted almost verbatim from traceback.py |
|
412 | 412 | """ |
|
413 | 413 | |
|
414 | 414 | Colors = self.Colors |
|
415 | 415 | list = [] |
|
416 | 416 | for filename, lineno, name, line in extracted_list[:-1]: |
|
417 | 417 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ |
|
418 | 418 | (Colors.filename, filename, Colors.Normal, |
|
419 | 419 | Colors.lineno, lineno, Colors.Normal, |
|
420 | 420 | Colors.name, name, Colors.Normal) |
|
421 | 421 | if line: |
|
422 | 422 | item += ' %s\n' % line.strip() |
|
423 | 423 | list.append(item) |
|
424 | 424 | # Emphasize the last entry |
|
425 | 425 | filename, lineno, name, line = extracted_list[-1] |
|
426 | 426 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ |
|
427 | 427 | (Colors.normalEm, |
|
428 | 428 | Colors.filenameEm, filename, Colors.normalEm, |
|
429 | 429 | Colors.linenoEm, lineno, Colors.normalEm, |
|
430 | 430 | Colors.nameEm, name, Colors.normalEm, |
|
431 | 431 | Colors.Normal) |
|
432 | 432 | if line: |
|
433 | 433 | item += '%s %s%s\n' % (Colors.line, line.strip(), |
|
434 | 434 | Colors.Normal) |
|
435 | 435 | list.append(item) |
|
436 | 436 | return list |
|
437 | 437 | |
|
438 | 438 | def _format_exception_only(self, etype, value): |
|
439 | 439 | """Format the exception part of a traceback. |
|
440 | 440 | |
|
441 | 441 | The arguments are the exception type and value such as given by |
|
442 | 442 | sys.exc_info()[:2]. The return value is a list of strings, each ending |
|
443 | 443 | in a newline. Normally, the list contains a single string; however, |
|
444 | 444 | for SyntaxError exceptions, it contains several lines that (when |
|
445 | 445 | printed) display detailed information about where the syntax error |
|
446 | 446 | occurred. The message indicating which exception occurred is the |
|
447 | 447 | always last string in the list. |
|
448 | 448 | |
|
449 | 449 | Also lifted nearly verbatim from traceback.py |
|
450 | 450 | """ |
|
451 | 451 | have_filedata = False |
|
452 | 452 | Colors = self.Colors |
|
453 | 453 | list = [] |
|
454 | 454 | stype = py3compat.cast_unicode(Colors.excName + etype.__name__ + Colors.Normal) |
|
455 | 455 | if value is None: |
|
456 | 456 | # Not sure if this can still happen in Python 2.6 and above |
|
457 | 457 | list.append(stype + '\n') |
|
458 | 458 | else: |
|
459 | 459 | if issubclass(etype, SyntaxError): |
|
460 | 460 | have_filedata = True |
|
461 | 461 | if not value.filename: value.filename = "<string>" |
|
462 | 462 | if value.lineno: |
|
463 | 463 | lineno = value.lineno |
|
464 | 464 | textline = linecache.getline(value.filename, value.lineno) |
|
465 | 465 | else: |
|
466 | 466 | lineno = 'unknown' |
|
467 | 467 | textline = '' |
|
468 | 468 | list.append('%s File %s"%s"%s, line %s%s%s\n' % \ |
|
469 | 469 | (Colors.normalEm, |
|
470 | 470 | Colors.filenameEm, py3compat.cast_unicode(value.filename), Colors.normalEm, |
|
471 | 471 | Colors.linenoEm, lineno, Colors.Normal )) |
|
472 | 472 | if textline == '': |
|
473 | 473 | textline = py3compat.cast_unicode(value.text, "utf-8") |
|
474 | 474 | |
|
475 | 475 | if textline is not None: |
|
476 | 476 | i = 0 |
|
477 | 477 | while i < len(textline) and textline[i].isspace(): |
|
478 | 478 | i += 1 |
|
479 | 479 | list.append('%s %s%s\n' % (Colors.line, |
|
480 | 480 | textline.strip(), |
|
481 | 481 | Colors.Normal)) |
|
482 | 482 | if value.offset is not None: |
|
483 | 483 | s = ' ' |
|
484 | 484 | for c in textline[i:value.offset - 1]: |
|
485 | 485 | if c.isspace(): |
|
486 | 486 | s += c |
|
487 | 487 | else: |
|
488 | 488 | s += ' ' |
|
489 | 489 | list.append('%s%s^%s\n' % (Colors.caret, s, |
|
490 | 490 | Colors.Normal)) |
|
491 | 491 | |
|
492 | 492 | try: |
|
493 | 493 | s = value.msg |
|
494 | 494 | except Exception: |
|
495 | 495 | s = self._some_str(value) |
|
496 | 496 | if s: |
|
497 | 497 | list.append('%s%s:%s %s\n' % (stype, Colors.excName, |
|
498 | 498 | Colors.Normal, s)) |
|
499 | 499 | else: |
|
500 | 500 | list.append('%s\n' % stype) |
|
501 | 501 | |
|
502 | 502 | # sync with user hooks |
|
503 | 503 | if have_filedata: |
|
504 | 504 | ipinst = get_ipython() |
|
505 | 505 | if ipinst is not None: |
|
506 | 506 | ipinst.hooks.synchronize_with_editor(value.filename, value.lineno, 0) |
|
507 | 507 | |
|
508 | 508 | return list |
|
509 | 509 | |
|
510 | 510 | def get_exception_only(self, etype, value): |
|
511 | 511 | """Only print the exception type and message, without a traceback. |
|
512 | 512 | |
|
513 | 513 | Parameters |
|
514 | 514 | ---------- |
|
515 | 515 | etype : exception type |
|
516 | 516 | evalue : exception value |
|
517 | 517 | """ |
|
518 | 518 | return ListTB.structured_traceback(self, etype, value) |
|
519 | 519 | |
|
520 | 520 | def show_exception_only(self, etype, evalue): |
|
521 | 521 | """Only print the exception type and message, without a traceback. |
|
522 | 522 | |
|
523 | 523 | Parameters |
|
524 | 524 | ---------- |
|
525 | 525 | etype : exception type |
|
526 | 526 | evalue : exception value |
|
527 | 527 | """ |
|
528 | 528 | # This method needs to use __call__ from *this* class, not the one from |
|
529 | 529 | # a subclass whose signature or behavior may be different |
|
530 | 530 | ostream = self.ostream |
|
531 | 531 | ostream.flush() |
|
532 | 532 | ostream.write('\n'.join(self.get_exception_only(etype, evalue))) |
|
533 | 533 | ostream.flush() |
|
534 | 534 | |
|
535 | 535 | def _some_str(self, value): |
|
536 | 536 | # Lifted from traceback.py |
|
537 | 537 | try: |
|
538 | 538 | return py3compat.cast_unicode(str(value)) |
|
539 | 539 | except: |
|
540 | 540 | return u'<unprintable %s object>' % type(value).__name__ |
|
541 | 541 | |
|
542 | 542 | |
|
543 | 543 | #---------------------------------------------------------------------------- |
|
544 | 544 | class VerboseTB(TBTools): |
|
545 | 545 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead |
|
546 | 546 | of HTML. Requires inspect and pydoc. Crazy, man. |
|
547 | 547 | |
|
548 | 548 | Modified version which optionally strips the topmost entries from the |
|
549 | 549 | traceback, to be used with alternate interpreters (because their own code |
|
550 | 550 | would appear in the traceback).""" |
|
551 | 551 | |
|
552 | 552 | def __init__(self, color_scheme='Linux', call_pdb=False, ostream=None, |
|
553 | 553 | tb_offset=0, long_header=False, include_vars=True, |
|
554 | 554 | check_cache=None, debugger_cls = None, |
|
555 | 555 | parent=None, config=None): |
|
556 | 556 | """Specify traceback offset, headers and color scheme. |
|
557 | 557 | |
|
558 | 558 | Define how many frames to drop from the tracebacks. Calling it with |
|
559 | 559 | tb_offset=1 allows use of this handler in interpreters which will have |
|
560 | 560 | their own code at the top of the traceback (VerboseTB will first |
|
561 | 561 | remove that frame before printing the traceback info).""" |
|
562 | 562 | TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
563 | 563 | ostream=ostream, parent=parent, config=config) |
|
564 | 564 | self.tb_offset = tb_offset |
|
565 | 565 | self.long_header = long_header |
|
566 | 566 | self.include_vars = include_vars |
|
567 | 567 | # By default we use linecache.checkcache, but the user can provide a |
|
568 | 568 | # different check_cache implementation. This is used by the IPython |
|
569 | 569 | # kernel to provide tracebacks for interactive code that is cached, |
|
570 | 570 | # by a compiler instance that flushes the linecache but preserves its |
|
571 | 571 | # own code cache. |
|
572 | 572 | if check_cache is None: |
|
573 | 573 | check_cache = linecache.checkcache |
|
574 | 574 | self.check_cache = check_cache |
|
575 | 575 | |
|
576 | 576 | self.debugger_cls = debugger_cls or debugger.Pdb |
|
577 | 577 | self.skip_hidden = True |
|
578 | 578 | |
|
579 | 579 | def format_record(self, frame_info): |
|
580 | 580 | """Format a single stack frame""" |
|
581 | 581 | Colors = self.Colors # just a shorthand + quicker name lookup |
|
582 | 582 | ColorsNormal = Colors.Normal # used a lot |
|
583 | 583 | |
|
584 | 584 | |
|
585 | 585 | |
|
586 | 586 | if isinstance(frame_info, stack_data.RepeatedFrames): |
|
587 | 587 | return ' %s[... skipping similar frames: %s]%s\n' % ( |
|
588 | 588 | Colors.excName, frame_info.description, ColorsNormal) |
|
589 | 589 | |
|
590 | 590 | indent = ' ' * INDENT_SIZE |
|
591 | 591 | em_normal = '%s\n%s%s' % (Colors.valEm, indent, ColorsNormal) |
|
592 | 592 | tpl_link = '%s%%s%s' % (Colors.filenameEm, ColorsNormal) |
|
593 | 593 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, |
|
594 | 594 | ColorsNormal) |
|
595 | 595 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ |
|
596 | 596 | (Colors.vName, Colors.valEm, ColorsNormal) |
|
597 | 597 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) |
|
598 | 598 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) |
|
599 | 599 | |
|
600 | 600 | file = frame_info.filename |
|
601 | 601 | file = py3compat.cast_unicode(file, util_path.fs_encoding) |
|
602 | 602 | link = tpl_link % util_path.compress_user(file) |
|
603 | 603 | args, varargs, varkw, locals_ = inspect.getargvalues(frame_info.frame) |
|
604 | 604 | |
|
605 | 605 | func = frame_info.executing.code_qualname() |
|
606 | 606 | if func == '<module>': |
|
607 | 607 | call = tpl_call % (func, '') |
|
608 | 608 | else: |
|
609 | 609 | # Decide whether to include variable details or not |
|
610 | 610 | var_repr = eqrepr if self.include_vars else nullrepr |
|
611 | 611 | try: |
|
612 | 612 | call = tpl_call % (func, inspect.formatargvalues(args, |
|
613 | 613 | varargs, varkw, |
|
614 | 614 | locals_, formatvalue=var_repr)) |
|
615 | 615 | except KeyError: |
|
616 | 616 | # This happens in situations like errors inside generator |
|
617 | 617 | # expressions, where local variables are listed in the |
|
618 | 618 | # line, but can't be extracted from the frame. I'm not |
|
619 | 619 | # 100% sure this isn't actually a bug in inspect itself, |
|
620 | 620 | # but since there's no info for us to compute with, the |
|
621 | 621 | # best we can do is report the failure and move on. Here |
|
622 | 622 | # we must *not* call any traceback construction again, |
|
623 | 623 | # because that would mess up use of %debug later on. So we |
|
624 | 624 | # simply report the failure and move on. The only |
|
625 | 625 | # limitation will be that this frame won't have locals |
|
626 | 626 | # listed in the call signature. Quite subtle problem... |
|
627 | 627 | # I can't think of a good way to validate this in a unit |
|
628 | 628 | # test, but running a script consisting of: |
|
629 | 629 | # dict( (k,v.strip()) for (k,v) in range(10) ) |
|
630 | 630 | # will illustrate the error, if this exception catch is |
|
631 | 631 | # disabled. |
|
632 | 632 | call = tpl_call_fail % func |
|
633 | 633 | |
|
634 | 634 | lvals = '' |
|
635 | 635 | lvals_list = [] |
|
636 | 636 | if self.include_vars: |
|
637 | 637 | for var in frame_info.variables_in_executing_piece: |
|
638 | 638 | lvals_list.append(tpl_name_val % (var.name, repr(var.value))) |
|
639 | 639 | if lvals_list: |
|
640 | 640 | lvals = '%s%s' % (indent, em_normal.join(lvals_list)) |
|
641 | 641 | |
|
642 | 642 | result = '%s %s\n' % (link, call) |
|
643 | 643 | |
|
644 | 644 | result += ''.join(_format_traceback_lines(frame_info.lines, Colors, self.has_colors, lvals)) |
|
645 | 645 | return result |
|
646 | 646 | |
|
647 | 647 | def prepare_header(self, etype, long_version=False): |
|
648 | 648 | colors = self.Colors # just a shorthand + quicker name lookup |
|
649 | 649 | colorsnormal = colors.Normal # used a lot |
|
650 | 650 | exc = '%s%s%s' % (colors.excName, etype, colorsnormal) |
|
651 | 651 | width = min(75, get_terminal_size()[0]) |
|
652 | 652 | if long_version: |
|
653 | 653 | # Header with the exception type, python version, and date |
|
654 | 654 | pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable |
|
655 | 655 | date = time.ctime(time.time()) |
|
656 | 656 | |
|
657 | 657 | head = '%s%s%s\n%s%s%s\n%s' % (colors.topline, '-' * width, colorsnormal, |
|
658 | 658 | exc, ' ' * (width - len(str(etype)) - len(pyver)), |
|
659 | 659 | pyver, date.rjust(width) ) |
|
660 | 660 | head += "\nA problem occurred executing Python code. Here is the sequence of function" \ |
|
661 | 661 | "\ncalls leading up to the error, with the most recent (innermost) call last." |
|
662 | 662 | else: |
|
663 | 663 | # Simplified header |
|
664 | 664 | head = '%s%s' % (exc, 'Traceback (most recent call last)'. \ |
|
665 | 665 | rjust(width - len(str(etype))) ) |
|
666 | 666 | |
|
667 | 667 | return head |
|
668 | 668 | |
|
669 | 669 | def format_exception(self, etype, evalue): |
|
670 | 670 | colors = self.Colors # just a shorthand + quicker name lookup |
|
671 | 671 | colorsnormal = colors.Normal # used a lot |
|
672 | 672 | # Get (safely) a string form of the exception info |
|
673 | 673 | try: |
|
674 | 674 | etype_str, evalue_str = map(str, (etype, evalue)) |
|
675 | 675 | except: |
|
676 | 676 | # User exception is improperly defined. |
|
677 | 677 | etype, evalue = str, sys.exc_info()[:2] |
|
678 | 678 | etype_str, evalue_str = map(str, (etype, evalue)) |
|
679 | 679 | # ... and format it |
|
680 | 680 | return ['%s%s%s: %s' % (colors.excName, etype_str, |
|
681 | 681 | colorsnormal, py3compat.cast_unicode(evalue_str))] |
|
682 | 682 | |
|
683 | 683 | def format_exception_as_a_whole(self, etype, evalue, etb, number_of_lines_of_context, tb_offset): |
|
684 | 684 | """Formats the header, traceback and exception message for a single exception. |
|
685 | 685 | |
|
686 | 686 | This may be called multiple times by Python 3 exception chaining |
|
687 | 687 | (PEP 3134). |
|
688 | 688 | """ |
|
689 | 689 | # some locals |
|
690 | 690 | orig_etype = etype |
|
691 | 691 | try: |
|
692 | 692 | etype = etype.__name__ |
|
693 | 693 | except AttributeError: |
|
694 | 694 | pass |
|
695 | 695 | |
|
696 | 696 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
697 | 697 | head = self.prepare_header(etype, self.long_header) |
|
698 | 698 | records = self.get_records(etb, number_of_lines_of_context, tb_offset) |
|
699 | 699 | |
|
700 | 700 | frames = [] |
|
701 | 701 | skipped = 0 |
|
702 |
|
|
|
702 | lastrecord = len(records) - 1 | |
|
703 | for i, r in enumerate(records): | |
|
703 | 704 | if not isinstance(r, stack_data.RepeatedFrames) and self.skip_hidden: |
|
704 | if r.frame.f_locals.get("__tracebackhide__", 0): | |
|
705 | if r.frame.f_locals.get("__tracebackhide__", 0) and i != lastrecord: | |
|
705 | 706 | skipped += 1 |
|
706 | 707 | continue |
|
707 | 708 | if skipped: |
|
708 | 709 | Colors = self.Colors # just a shorthand + quicker name lookup |
|
709 | 710 | ColorsNormal = Colors.Normal # used a lot |
|
710 | 711 | frames.append( |
|
711 | 712 | " %s[... skipping hidden %s frame]%s\n" |
|
712 | 713 | % (Colors.excName, skipped, ColorsNormal) |
|
713 | 714 | ) |
|
714 | 715 | skipped = 0 |
|
715 | 716 | frames.append(self.format_record(r)) |
|
716 | 717 | if skipped: |
|
717 | 718 | Colors = self.Colors # just a shorthand + quicker name lookup |
|
718 | 719 | ColorsNormal = Colors.Normal # used a lot |
|
719 | 720 | frames.append( |
|
720 | 721 | " %s[... skipping hidden %s frame]%s\n" |
|
721 | 722 | % (Colors.excName, skipped, ColorsNormal) |
|
722 | 723 | ) |
|
723 | 724 | |
|
724 | 725 | formatted_exception = self.format_exception(etype, evalue) |
|
725 | 726 | if records: |
|
726 | 727 | frame_info = records[-1] |
|
727 | 728 | ipinst = get_ipython() |
|
728 | 729 | if ipinst is not None: |
|
729 | 730 | ipinst.hooks.synchronize_with_editor(frame_info.filename, frame_info.lineno, 0) |
|
730 | 731 | |
|
731 | 732 | return [[head] + frames + [''.join(formatted_exception[0])]] |
|
732 | 733 | |
|
733 | 734 | def get_records(self, etb, number_of_lines_of_context, tb_offset): |
|
734 | 735 | context = number_of_lines_of_context - 1 |
|
735 | 736 | after = context // 2 |
|
736 | 737 | before = context - after |
|
737 | 738 | if self.has_colors: |
|
738 | 739 | style = get_style_by_name('default') |
|
739 | 740 | style = stack_data.style_with_executing_node(style, 'bg:#00005f') |
|
740 | 741 | formatter = Terminal256Formatter(style=style) |
|
741 | 742 | else: |
|
742 | 743 | formatter = None |
|
743 | 744 | options = stack_data.Options( |
|
744 | 745 | before=before, |
|
745 | 746 | after=after, |
|
746 | 747 | pygments_formatter=formatter, |
|
747 | 748 | ) |
|
748 | 749 | return list(stack_data.FrameInfo.stack_data(etb, options=options))[tb_offset:] |
|
749 | 750 | |
|
750 | 751 | def structured_traceback(self, etype, evalue, etb, tb_offset=None, |
|
751 | 752 | number_of_lines_of_context=5): |
|
752 | 753 | """Return a nice text document describing the traceback.""" |
|
753 | 754 | |
|
754 | 755 | formatted_exception = self.format_exception_as_a_whole(etype, evalue, etb, number_of_lines_of_context, |
|
755 | 756 | tb_offset) |
|
756 | 757 | |
|
757 | 758 | colors = self.Colors # just a shorthand + quicker name lookup |
|
758 | 759 | colorsnormal = colors.Normal # used a lot |
|
759 | 760 | head = '%s%s%s' % (colors.topline, '-' * min(75, get_terminal_size()[0]), colorsnormal) |
|
760 | 761 | structured_traceback_parts = [head] |
|
761 | 762 | chained_exceptions_tb_offset = 0 |
|
762 | 763 | lines_of_context = 3 |
|
763 | 764 | formatted_exceptions = formatted_exception |
|
764 | 765 | exception = self.get_parts_of_chained_exception(evalue) |
|
765 | 766 | if exception: |
|
766 | 767 | formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__) |
|
767 | 768 | etype, evalue, etb = exception |
|
768 | 769 | else: |
|
769 | 770 | evalue = None |
|
770 | 771 | chained_exc_ids = set() |
|
771 | 772 | while evalue: |
|
772 | 773 | formatted_exceptions += self.format_exception_as_a_whole(etype, evalue, etb, lines_of_context, |
|
773 | 774 | chained_exceptions_tb_offset) |
|
774 | 775 | exception = self.get_parts_of_chained_exception(evalue) |
|
775 | 776 | |
|
776 | 777 | if exception and not id(exception[1]) in chained_exc_ids: |
|
777 | 778 | chained_exc_ids.add(id(exception[1])) # trace exception to avoid infinite 'cause' loop |
|
778 | 779 | formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__) |
|
779 | 780 | etype, evalue, etb = exception |
|
780 | 781 | else: |
|
781 | 782 | evalue = None |
|
782 | 783 | |
|
783 | 784 | # we want to see exceptions in a reversed order: |
|
784 | 785 | # the first exception should be on top |
|
785 | 786 | for formatted_exception in reversed(formatted_exceptions): |
|
786 | 787 | structured_traceback_parts += formatted_exception |
|
787 | 788 | |
|
788 | 789 | return structured_traceback_parts |
|
789 | 790 | |
|
790 | 791 | def debugger(self, force=False): |
|
791 | 792 | """Call up the pdb debugger if desired, always clean up the tb |
|
792 | 793 | reference. |
|
793 | 794 | |
|
794 | 795 | Keywords: |
|
795 | 796 | |
|
796 | 797 | - force(False): by default, this routine checks the instance call_pdb |
|
797 | 798 | flag and does not actually invoke the debugger if the flag is false. |
|
798 | 799 | The 'force' option forces the debugger to activate even if the flag |
|
799 | 800 | is false. |
|
800 | 801 | |
|
801 | 802 | If the call_pdb flag is set, the pdb interactive debugger is |
|
802 | 803 | invoked. In all cases, the self.tb reference to the current traceback |
|
803 | 804 | is deleted to prevent lingering references which hamper memory |
|
804 | 805 | management. |
|
805 | 806 | |
|
806 | 807 | Note that each call to pdb() does an 'import readline', so if your app |
|
807 | 808 | requires a special setup for the readline completers, you'll have to |
|
808 | 809 | fix that by hand after invoking the exception handler.""" |
|
809 | 810 | |
|
810 | 811 | if force or self.call_pdb: |
|
811 | 812 | if self.pdb is None: |
|
812 | 813 | self.pdb = self.debugger_cls() |
|
813 | 814 | # the system displayhook may have changed, restore the original |
|
814 | 815 | # for pdb |
|
815 | 816 | display_trap = DisplayTrap(hook=sys.__displayhook__) |
|
816 | 817 | with display_trap: |
|
817 | 818 | self.pdb.reset() |
|
818 | 819 | # Find the right frame so we don't pop up inside ipython itself |
|
819 | 820 | if hasattr(self, 'tb') and self.tb is not None: |
|
820 | 821 | etb = self.tb |
|
821 | 822 | else: |
|
822 | 823 | etb = self.tb = sys.last_traceback |
|
823 | 824 | while self.tb is not None and self.tb.tb_next is not None: |
|
824 | 825 | self.tb = self.tb.tb_next |
|
825 | 826 | if etb and etb.tb_next: |
|
826 | 827 | etb = etb.tb_next |
|
827 | 828 | self.pdb.botframe = etb.tb_frame |
|
828 | 829 | self.pdb.interaction(None, etb) |
|
829 | 830 | |
|
830 | 831 | if hasattr(self, 'tb'): |
|
831 | 832 | del self.tb |
|
832 | 833 | |
|
833 | 834 | def handler(self, info=None): |
|
834 | 835 | (etype, evalue, etb) = info or sys.exc_info() |
|
835 | 836 | self.tb = etb |
|
836 | 837 | ostream = self.ostream |
|
837 | 838 | ostream.flush() |
|
838 | 839 | ostream.write(self.text(etype, evalue, etb)) |
|
839 | 840 | ostream.write('\n') |
|
840 | 841 | ostream.flush() |
|
841 | 842 | |
|
842 | 843 | # Changed so an instance can just be called as VerboseTB_inst() and print |
|
843 | 844 | # out the right info on its own. |
|
844 | 845 | def __call__(self, etype=None, evalue=None, etb=None): |
|
845 | 846 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" |
|
846 | 847 | if etb is None: |
|
847 | 848 | self.handler() |
|
848 | 849 | else: |
|
849 | 850 | self.handler((etype, evalue, etb)) |
|
850 | 851 | try: |
|
851 | 852 | self.debugger() |
|
852 | 853 | except KeyboardInterrupt: |
|
853 | 854 | print("\nKeyboardInterrupt") |
|
854 | 855 | |
|
855 | 856 | |
|
856 | 857 | #---------------------------------------------------------------------------- |
|
857 | 858 | class FormattedTB(VerboseTB, ListTB): |
|
858 | 859 | """Subclass ListTB but allow calling with a traceback. |
|
859 | 860 | |
|
860 | 861 | It can thus be used as a sys.excepthook for Python > 2.1. |
|
861 | 862 | |
|
862 | 863 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. |
|
863 | 864 | |
|
864 | 865 | Allows a tb_offset to be specified. This is useful for situations where |
|
865 | 866 | one needs to remove a number of topmost frames from the traceback (such as |
|
866 | 867 | occurs with python programs that themselves execute other python code, |
|
867 | 868 | like Python shells). """ |
|
868 | 869 | |
|
869 | 870 | def __init__(self, mode='Plain', color_scheme='Linux', call_pdb=False, |
|
870 | 871 | ostream=None, |
|
871 | 872 | tb_offset=0, long_header=False, include_vars=False, |
|
872 | 873 | check_cache=None, debugger_cls=None, |
|
873 | 874 | parent=None, config=None): |
|
874 | 875 | |
|
875 | 876 | # NEVER change the order of this list. Put new modes at the end: |
|
876 | 877 | self.valid_modes = ['Plain', 'Context', 'Verbose', 'Minimal'] |
|
877 | 878 | self.verbose_modes = self.valid_modes[1:3] |
|
878 | 879 | |
|
879 | 880 | VerboseTB.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
880 | 881 | ostream=ostream, tb_offset=tb_offset, |
|
881 | 882 | long_header=long_header, include_vars=include_vars, |
|
882 | 883 | check_cache=check_cache, debugger_cls=debugger_cls, |
|
883 | 884 | parent=parent, config=config) |
|
884 | 885 | |
|
885 | 886 | # Different types of tracebacks are joined with different separators to |
|
886 | 887 | # form a single string. They are taken from this dict |
|
887 | 888 | self._join_chars = dict(Plain='', Context='\n', Verbose='\n', |
|
888 | 889 | Minimal='') |
|
889 | 890 | # set_mode also sets the tb_join_char attribute |
|
890 | 891 | self.set_mode(mode) |
|
891 | 892 | |
|
892 | 893 | def structured_traceback(self, etype, value, tb, tb_offset=None, number_of_lines_of_context=5): |
|
893 | 894 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
894 | 895 | mode = self.mode |
|
895 | 896 | if mode in self.verbose_modes: |
|
896 | 897 | # Verbose modes need a full traceback |
|
897 | 898 | return VerboseTB.structured_traceback( |
|
898 | 899 | self, etype, value, tb, tb_offset, number_of_lines_of_context |
|
899 | 900 | ) |
|
900 | 901 | elif mode == 'Minimal': |
|
901 | 902 | return ListTB.get_exception_only(self, etype, value) |
|
902 | 903 | else: |
|
903 | 904 | # We must check the source cache because otherwise we can print |
|
904 | 905 | # out-of-date source code. |
|
905 | 906 | self.check_cache() |
|
906 | 907 | # Now we can extract and format the exception |
|
907 | 908 | return ListTB.structured_traceback( |
|
908 | 909 | self, etype, value, tb, tb_offset, number_of_lines_of_context |
|
909 | 910 | ) |
|
910 | 911 | |
|
911 | 912 | def stb2text(self, stb): |
|
912 | 913 | """Convert a structured traceback (a list) to a string.""" |
|
913 | 914 | return self.tb_join_char.join(stb) |
|
914 | 915 | |
|
915 | 916 | |
|
916 | 917 | def set_mode(self, mode=None): |
|
917 | 918 | """Switch to the desired mode. |
|
918 | 919 | |
|
919 | 920 | If mode is not specified, cycles through the available modes.""" |
|
920 | 921 | |
|
921 | 922 | if not mode: |
|
922 | 923 | new_idx = (self.valid_modes.index(self.mode) + 1 ) % \ |
|
923 | 924 | len(self.valid_modes) |
|
924 | 925 | self.mode = self.valid_modes[new_idx] |
|
925 | 926 | elif mode not in self.valid_modes: |
|
926 | 927 | raise ValueError('Unrecognized mode in FormattedTB: <' + mode + '>\n' |
|
927 | 928 | 'Valid modes: ' + str(self.valid_modes)) |
|
928 | 929 | else: |
|
929 | 930 | self.mode = mode |
|
930 | 931 | # include variable details only in 'Verbose' mode |
|
931 | 932 | self.include_vars = (self.mode == self.valid_modes[2]) |
|
932 | 933 | # Set the join character for generating text tracebacks |
|
933 | 934 | self.tb_join_char = self._join_chars[self.mode] |
|
934 | 935 | |
|
935 | 936 | # some convenient shortcuts |
|
936 | 937 | def plain(self): |
|
937 | 938 | self.set_mode(self.valid_modes[0]) |
|
938 | 939 | |
|
939 | 940 | def context(self): |
|
940 | 941 | self.set_mode(self.valid_modes[1]) |
|
941 | 942 | |
|
942 | 943 | def verbose(self): |
|
943 | 944 | self.set_mode(self.valid_modes[2]) |
|
944 | 945 | |
|
945 | 946 | def minimal(self): |
|
946 | 947 | self.set_mode(self.valid_modes[3]) |
|
947 | 948 | |
|
948 | 949 | |
|
949 | 950 | #---------------------------------------------------------------------------- |
|
950 | 951 | class AutoFormattedTB(FormattedTB): |
|
951 | 952 | """A traceback printer which can be called on the fly. |
|
952 | 953 | |
|
953 | 954 | It will find out about exceptions by itself. |
|
954 | 955 | |
|
955 | 956 | A brief example:: |
|
956 | 957 | |
|
957 | 958 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') |
|
958 | 959 | try: |
|
959 | 960 | ... |
|
960 | 961 | except: |
|
961 | 962 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object |
|
962 | 963 | """ |
|
963 | 964 | |
|
964 | 965 | def __call__(self, etype=None, evalue=None, etb=None, |
|
965 | 966 | out=None, tb_offset=None): |
|
966 | 967 | """Print out a formatted exception traceback. |
|
967 | 968 | |
|
968 | 969 | Optional arguments: |
|
969 | 970 | - out: an open file-like object to direct output to. |
|
970 | 971 | |
|
971 | 972 | - tb_offset: the number of frames to skip over in the stack, on a |
|
972 | 973 | per-call basis (this overrides temporarily the instance's tb_offset |
|
973 | 974 | given at initialization time.""" |
|
974 | 975 | |
|
975 | 976 | if out is None: |
|
976 | 977 | out = self.ostream |
|
977 | 978 | out.flush() |
|
978 | 979 | out.write(self.text(etype, evalue, etb, tb_offset)) |
|
979 | 980 | out.write('\n') |
|
980 | 981 | out.flush() |
|
981 | 982 | # FIXME: we should remove the auto pdb behavior from here and leave |
|
982 | 983 | # that to the clients. |
|
983 | 984 | try: |
|
984 | 985 | self.debugger() |
|
985 | 986 | except KeyboardInterrupt: |
|
986 | 987 | print("\nKeyboardInterrupt") |
|
987 | 988 | |
|
988 | 989 | def structured_traceback(self, etype=None, value=None, tb=None, |
|
989 | 990 | tb_offset=None, number_of_lines_of_context=5): |
|
990 | 991 | if etype is None: |
|
991 | 992 | etype, value, tb = sys.exc_info() |
|
992 | 993 | if isinstance(tb, tuple): |
|
993 | 994 | # tb is a tuple if this is a chained exception. |
|
994 | 995 | self.tb = tb[0] |
|
995 | 996 | else: |
|
996 | 997 | self.tb = tb |
|
997 | 998 | return FormattedTB.structured_traceback( |
|
998 | 999 | self, etype, value, tb, tb_offset, number_of_lines_of_context) |
|
999 | 1000 | |
|
1000 | 1001 | |
|
1001 | 1002 | #--------------------------------------------------------------------------- |
|
1002 | 1003 | |
|
1003 | 1004 | # A simple class to preserve Nathan's original functionality. |
|
1004 | 1005 | class ColorTB(FormattedTB): |
|
1005 | 1006 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" |
|
1006 | 1007 | |
|
1007 | 1008 | def __init__(self, color_scheme='Linux', call_pdb=0, **kwargs): |
|
1008 | 1009 | FormattedTB.__init__(self, color_scheme=color_scheme, |
|
1009 | 1010 | call_pdb=call_pdb, **kwargs) |
|
1010 | 1011 | |
|
1011 | 1012 | |
|
1012 | 1013 | class SyntaxTB(ListTB): |
|
1013 | 1014 | """Extension which holds some state: the last exception value""" |
|
1014 | 1015 | |
|
1015 | 1016 | def __init__(self, color_scheme='NoColor', parent=None, config=None): |
|
1016 | 1017 | ListTB.__init__(self, color_scheme, parent=parent, config=config) |
|
1017 | 1018 | self.last_syntax_error = None |
|
1018 | 1019 | |
|
1019 | 1020 | def __call__(self, etype, value, elist): |
|
1020 | 1021 | self.last_syntax_error = value |
|
1021 | 1022 | |
|
1022 | 1023 | ListTB.__call__(self, etype, value, elist) |
|
1023 | 1024 | |
|
1024 | 1025 | def structured_traceback(self, etype, value, elist, tb_offset=None, |
|
1025 | 1026 | context=5): |
|
1026 | 1027 | # If the source file has been edited, the line in the syntax error can |
|
1027 | 1028 | # be wrong (retrieved from an outdated cache). This replaces it with |
|
1028 | 1029 | # the current value. |
|
1029 | 1030 | if isinstance(value, SyntaxError) \ |
|
1030 | 1031 | and isinstance(value.filename, str) \ |
|
1031 | 1032 | and isinstance(value.lineno, int): |
|
1032 | 1033 | linecache.checkcache(value.filename) |
|
1033 | 1034 | newtext = linecache.getline(value.filename, value.lineno) |
|
1034 | 1035 | if newtext: |
|
1035 | 1036 | value.text = newtext |
|
1036 | 1037 | self.last_syntax_error = value |
|
1037 | 1038 | return super(SyntaxTB, self).structured_traceback(etype, value, elist, |
|
1038 | 1039 | tb_offset=tb_offset, context=context) |
|
1039 | 1040 | |
|
1040 | 1041 | def clear_err_state(self): |
|
1041 | 1042 | """Return the current error state and clear it""" |
|
1042 | 1043 | e = self.last_syntax_error |
|
1043 | 1044 | self.last_syntax_error = None |
|
1044 | 1045 | return e |
|
1045 | 1046 | |
|
1046 | 1047 | def stb2text(self, stb): |
|
1047 | 1048 | """Convert a structured traceback (a list) to a string.""" |
|
1048 | 1049 | return ''.join(stb) |
|
1049 | 1050 | |
|
1050 | 1051 | |
|
1051 | 1052 | # some internal-use functions |
|
1052 | 1053 | def text_repr(value): |
|
1053 | 1054 | """Hopefully pretty robust repr equivalent.""" |
|
1054 | 1055 | # this is pretty horrible but should always return *something* |
|
1055 | 1056 | try: |
|
1056 | 1057 | return pydoc.text.repr(value) |
|
1057 | 1058 | except KeyboardInterrupt: |
|
1058 | 1059 | raise |
|
1059 | 1060 | except: |
|
1060 | 1061 | try: |
|
1061 | 1062 | return repr(value) |
|
1062 | 1063 | except KeyboardInterrupt: |
|
1063 | 1064 | raise |
|
1064 | 1065 | except: |
|
1065 | 1066 | try: |
|
1066 | 1067 | # all still in an except block so we catch |
|
1067 | 1068 | # getattr raising |
|
1068 | 1069 | name = getattr(value, '__name__', None) |
|
1069 | 1070 | if name: |
|
1070 | 1071 | # ick, recursion |
|
1071 | 1072 | return text_repr(name) |
|
1072 | 1073 | klass = getattr(value, '__class__', None) |
|
1073 | 1074 | if klass: |
|
1074 | 1075 | return '%s instance' % text_repr(klass) |
|
1075 | 1076 | except KeyboardInterrupt: |
|
1076 | 1077 | raise |
|
1077 | 1078 | except: |
|
1078 | 1079 | return 'UNRECOVERABLE REPR FAILURE' |
|
1079 | 1080 | |
|
1080 | 1081 | |
|
1081 | 1082 | def eqrepr(value, repr=text_repr): |
|
1082 | 1083 | return '=%s' % repr(value) |
|
1083 | 1084 | |
|
1084 | 1085 | |
|
1085 | 1086 | def nullrepr(value, repr=text_repr): |
|
1086 | 1087 | return '' |
@@ -1,34 +1,36 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Test suite for the deepreload module.""" |
|
3 | 3 | |
|
4 | 4 | # Copyright (c) IPython Development Team. |
|
5 | 5 | # Distributed under the terms of the Modified BSD License. |
|
6 | 6 | |
|
7 | import os | |
|
7 | from pathlib import Path | |
|
8 | 8 | |
|
9 | 9 | import nose.tools as nt |
|
10 | 10 | |
|
11 | 11 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
12 | 12 | from IPython.utils.tempdir import TemporaryDirectory |
|
13 | 13 | from IPython.lib.deepreload import reload as dreload |
|
14 | 14 | |
|
15 | ||
|
15 | 16 | def test_deepreload(): |
|
16 | 17 | "Test that dreload does deep reloads and skips excluded modules." |
|
17 | 18 | with TemporaryDirectory() as tmpdir: |
|
18 | 19 | with prepended_to_syspath(tmpdir): |
|
19 | with open(os.path.join(tmpdir, 'A.py'), 'w') as f: | |
|
20 | tmpdirpath = Path(tmpdir) | |
|
21 | with open(tmpdirpath / "A.py", "w") as f: | |
|
20 | 22 | f.write("class Object(object):\n pass\n") |
|
21 |
with open( |
|
|
23 | with open(tmpdirpath / "B.py", "w") as f: | |
|
22 | 24 | f.write("import A\n") |
|
23 | 25 | import A |
|
24 | 26 | import B |
|
25 | 27 | |
|
26 | 28 | # Test that A is not reloaded. |
|
27 | 29 | obj = A.Object() |
|
28 |
dreload(B, exclude=[ |
|
|
30 | dreload(B, exclude=["A"]) | |
|
29 | 31 | nt.assert_true(isinstance(obj, A.Object)) |
|
30 | 32 | |
|
31 | 33 | # Test that A is reloaded. |
|
32 | 34 | obj = A.Object() |
|
33 | 35 | dreload(B) |
|
34 | 36 | nt.assert_false(isinstance(obj, A.Object)) |
@@ -1,64 +1,64 b'' | |||
|
1 | 1 | IPython Documentation |
|
2 | 2 | --------------------- |
|
3 | 3 | |
|
4 | 4 | This directory contains the majority of the documentation for IPython. |
|
5 | 5 | |
|
6 | 6 | |
|
7 | 7 | Deploy docs |
|
8 | 8 | ----------- |
|
9 | 9 | |
|
10 | 10 | Documentation is automatically deployed on ReadTheDocs on every push or merged |
|
11 | 11 | Pull requests. |
|
12 | 12 | |
|
13 | 13 | |
|
14 | 14 | Requirements |
|
15 | 15 | ------------ |
|
16 | 16 | |
|
17 | 17 | The documentation must be built using Python 3. |
|
18 | 18 | |
|
19 |
In addition |
|
|
19 | In addition to :ref:`devinstall`, | |
|
20 | 20 | the following tools are needed to build the documentation: |
|
21 | 21 | |
|
22 | 22 | - sphinx |
|
23 | 23 | - sphinx_rtd_theme |
|
24 | 24 | - docrepr |
|
25 | 25 | |
|
26 | 26 | In a conda environment, or a Python 3 ``venv``, you should be able to run:: |
|
27 | 27 | |
|
28 | 28 | cd ipython |
|
29 | 29 | pip install -U -r docs/requirements.txt |
|
30 | 30 | |
|
31 | 31 | |
|
32 | 32 | Build Commands |
|
33 | 33 | -------------- |
|
34 | 34 | |
|
35 | 35 | The documentation gets built using ``make``, and comes in several flavors. |
|
36 | 36 | |
|
37 | 37 | ``make html`` - build the API and narrative documentation web pages, this is |
|
38 | 38 | the default ``make`` target, so running just ``make`` is equivalent to ``make |
|
39 | 39 | html``. |
|
40 | 40 | |
|
41 | 41 | ``make html_noapi`` - same as above, but without running the auto-generated API |
|
42 | 42 | docs. When you are working on the narrative documentation, the most time |
|
43 | consuming portion of the build process is the processing and rending of the | |
|
43 | consuming portion of the build process is the processing and rendering of the | |
|
44 | 44 | API documentation. This build target skips that. |
|
45 | 45 | |
|
46 | 46 | ``make pdf`` will compile a pdf from the documentation. |
|
47 | 47 | |
|
48 | 48 | You can run ``make help`` to see information on all possible make targets. |
|
49 | 49 | |
|
50 | 50 | To save time, |
|
51 | 51 | the make targets above only process the files that have been changed since the |
|
52 | 52 | previous docs build. |
|
53 | 53 | To remove the previous docs build you can use ``make clean``. |
|
54 | 54 | You can also combine ``clean`` with other `make` commands; |
|
55 | 55 | for example, |
|
56 | ``make clean html`` will do a complete rebuild of the docs or `make clean pdf` will do a complete build of the pdf. | |
|
56 | ``make clean html`` will do a complete rebuild of the docs or ``make clean pdf`` will do a complete build of the pdf. | |
|
57 | 57 | |
|
58 | 58 | |
|
59 | 59 | Continuous Integration |
|
60 | 60 | ---------------------- |
|
61 | 61 | |
|
62 | 62 | Documentation builds are included in the Travis-CI continuous integration process, |
|
63 | 63 | so you can see the results of the docs build for any pull request at |
|
64 | 64 | https://travis-ci.org/ipython/ipython/pull_requests. |
@@ -1,128 +1,127 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | |
|
3 | 3 | from os.path import join, dirname, abspath |
|
4 | 4 | import inspect |
|
5 | ||
|
5 | from pathlib import Path | |
|
6 | 6 | from IPython.terminal.ipapp import TerminalIPythonApp |
|
7 | 7 | from ipykernel.kernelapp import IPKernelApp |
|
8 | 8 | from traitlets import Undefined |
|
9 | 9 | from collections import defaultdict |
|
10 | 10 | |
|
11 | 11 | here = abspath(dirname(__file__)) |
|
12 | 12 | options = join(here, 'source', 'config', 'options') |
|
13 | 13 | generated = join(options, 'config-generated.txt') |
|
14 | 14 | |
|
15 | 15 | import textwrap |
|
16 | 16 | indent = lambda text,n: textwrap.indent(text,n*' ') |
|
17 | 17 | |
|
18 | 18 | |
|
19 | 19 | def interesting_default_value(dv): |
|
20 | 20 | if (dv is None) or (dv is Undefined): |
|
21 | 21 | return False |
|
22 | 22 | if isinstance(dv, (str, list, tuple, dict, set)): |
|
23 | 23 | return bool(dv) |
|
24 | 24 | return True |
|
25 | 25 | |
|
26 | 26 | def format_aliases(aliases): |
|
27 | 27 | fmted = [] |
|
28 | 28 | for a in aliases: |
|
29 | 29 | dashes = '-' if len(a) == 1 else '--' |
|
30 | 30 | fmted.append('``%s%s``' % (dashes, a)) |
|
31 | 31 | return ', '.join(fmted) |
|
32 | 32 | |
|
33 | 33 | def class_config_rst_doc(cls, trait_aliases): |
|
34 | 34 | """Generate rST documentation for this class' config options. |
|
35 | 35 | |
|
36 | 36 | Excludes traits defined on parent classes. |
|
37 | 37 | """ |
|
38 | 38 | lines = [] |
|
39 | 39 | classname = cls.__name__ |
|
40 | 40 | for k, trait in sorted(cls.class_traits(config=True).items()): |
|
41 | 41 | ttype = trait.__class__.__name__ |
|
42 | 42 | |
|
43 | 43 | fullname = classname + '.' + trait.name |
|
44 | 44 | lines += ['.. configtrait:: ' + fullname, |
|
45 | 45 | '' |
|
46 | 46 | ] |
|
47 | 47 | |
|
48 | 48 | help = trait.help.rstrip() or 'No description' |
|
49 | 49 | lines.append(indent(inspect.cleandoc(help), 4) + '\n') |
|
50 | 50 | |
|
51 | 51 | # Choices or type |
|
52 | 52 | if 'Enum' in ttype: |
|
53 | 53 | # include Enum choices |
|
54 | 54 | lines.append(indent( |
|
55 | 55 | ':options: ' + ', '.join('``%r``' % x for x in trait.values), 4)) |
|
56 | 56 | else: |
|
57 | 57 | lines.append(indent(':trait type: ' + ttype, 4)) |
|
58 | 58 | |
|
59 | 59 | # Default value |
|
60 | 60 | # Ignore boring default values like None, [] or '' |
|
61 | 61 | if interesting_default_value(trait.default_value): |
|
62 | 62 | try: |
|
63 | 63 | dvr = trait.default_value_repr() |
|
64 | 64 | except Exception: |
|
65 | 65 | dvr = None # ignore defaults we can't construct |
|
66 | 66 | if dvr is not None: |
|
67 | 67 | if len(dvr) > 64: |
|
68 | 68 | dvr = dvr[:61] + '...' |
|
69 | 69 | # Double up backslashes, so they get to the rendered docs |
|
70 | 70 | dvr = dvr.replace('\\n', '\\\\n') |
|
71 | 71 | lines.append(indent(':default: ``%s``' % dvr, 4)) |
|
72 | 72 | |
|
73 | 73 | # Command line aliases |
|
74 | 74 | if trait_aliases[fullname]: |
|
75 | 75 | fmt_aliases = format_aliases(trait_aliases[fullname]) |
|
76 | 76 | lines.append(indent(':CLI option: ' + fmt_aliases, 4)) |
|
77 | 77 | |
|
78 | 78 | # Blank line |
|
79 | 79 | lines.append('') |
|
80 | 80 | |
|
81 | 81 | return '\n'.join(lines) |
|
82 | 82 | |
|
83 | 83 | def reverse_aliases(app): |
|
84 | 84 | """Produce a mapping of trait names to lists of command line aliases. |
|
85 | 85 | """ |
|
86 | 86 | res = defaultdict(list) |
|
87 | 87 | for alias, trait in app.aliases.items(): |
|
88 | 88 | res[trait].append(alias) |
|
89 | 89 | |
|
90 | 90 | # Flags also often act as aliases for a boolean trait. |
|
91 | 91 | # Treat flags which set one trait to True as aliases. |
|
92 | 92 | for flag, (cfg, _) in app.flags.items(): |
|
93 | 93 | if len(cfg) == 1: |
|
94 | 94 | classname = list(cfg)[0] |
|
95 | 95 | cls_cfg = cfg[classname] |
|
96 | 96 | if len(cls_cfg) == 1: |
|
97 | 97 | traitname = list(cls_cfg)[0] |
|
98 | 98 | if cls_cfg[traitname] is True: |
|
99 | 99 | res[classname+'.'+traitname].append(flag) |
|
100 | 100 | |
|
101 | 101 | return res |
|
102 | 102 | |
|
103 | 103 | def write_doc(name, title, app, preamble=None): |
|
104 | 104 | trait_aliases = reverse_aliases(app) |
|
105 | 105 | filename = join(options, name+'.rst') |
|
106 | 106 | with open(filename, 'w') as f: |
|
107 | 107 | f.write(title + '\n') |
|
108 | 108 | f.write(('=' * len(title)) + '\n') |
|
109 | 109 | f.write('\n') |
|
110 | 110 | if preamble is not None: |
|
111 | 111 | f.write(preamble + '\n\n') |
|
112 | 112 | #f.write(app.document_config_options()) |
|
113 | 113 | |
|
114 | 114 | for c in app._classes_inc_parents(): |
|
115 | 115 | f.write(class_config_rst_doc(c, trait_aliases)) |
|
116 | 116 | f.write('\n') |
|
117 | 117 | |
|
118 | 118 | |
|
119 | 119 | if __name__ == '__main__': |
|
120 | 120 | # Touch this file for the make target |
|
121 | with open(generated, 'w'): | |
|
122 | pass | |
|
121 | Path(generated).write_text("") | |
|
123 | 122 | |
|
124 | 123 | write_doc('terminal', 'Terminal IPython options', TerminalIPythonApp()) |
|
125 | 124 | write_doc('kernel', 'IPython kernel options', IPKernelApp(), |
|
126 | 125 | preamble=("These options can be used in :file:`ipython_kernel_config.py`. " |
|
127 | 126 | "The kernel also respects any options in `ipython_config.py`"), |
|
128 | 127 | ) |
@@ -1,67 +1,68 b'' | |||
|
1 | ||
|
1 | 2 | from pathlib import Path |
|
2 | 3 | from IPython.core.alias import Alias |
|
3 | 4 | from IPython.core.interactiveshell import InteractiveShell |
|
4 | 5 | from IPython.core.magic import MagicAlias |
|
5 | 6 | from IPython.utils.text import dedent, indent |
|
6 | 7 | |
|
7 | 8 | shell = InteractiveShell.instance() |
|
8 | 9 | magics = shell.magics_manager.magics |
|
9 | 10 | |
|
10 | 11 | def _strip_underline(line): |
|
11 | 12 | chars = set(line.strip()) |
|
12 | 13 | if len(chars) == 1 and ("-" in chars or "=" in chars): |
|
13 | 14 | return "" |
|
14 | 15 | else: |
|
15 | 16 | return line |
|
16 | 17 | |
|
17 | 18 | def format_docstring(func): |
|
18 | 19 | docstring = (func.__doc__ or "Undocumented").rstrip() |
|
19 | 20 | docstring = indent(dedent(docstring)) |
|
20 | 21 | # Sphinx complains if indented bits have rst headings in, so strip out |
|
21 | 22 | # any underlines in the docstring. |
|
22 | 23 | lines = [_strip_underline(l) for l in docstring.splitlines()] |
|
23 | 24 | return "\n".join(lines) |
|
24 | 25 | |
|
25 | 26 | output = [ |
|
26 | 27 | "Line magics", |
|
27 | 28 | "===========", |
|
28 | 29 | "", |
|
29 | 30 | ] |
|
30 | 31 | |
|
31 | 32 | # Case insensitive sort by name |
|
32 | 33 | def sortkey(s): return s[0].lower() |
|
33 | 34 | |
|
34 | 35 | for name, func in sorted(magics["line"].items(), key=sortkey): |
|
35 | 36 | if isinstance(func, Alias) or isinstance(func, MagicAlias): |
|
36 | 37 | # Aliases are magics, but shouldn't be documented here |
|
37 | 38 | # Also skip aliases to other magics |
|
38 | 39 | continue |
|
39 | 40 | output.extend([".. magic:: {}".format(name), |
|
40 | 41 | "", |
|
41 | 42 | format_docstring(func), |
|
42 | 43 | ""]) |
|
43 | 44 | |
|
44 | 45 | output.extend([ |
|
45 | 46 | "Cell magics", |
|
46 | 47 | "===========", |
|
47 | 48 | "", |
|
48 | 49 | ]) |
|
49 | 50 | |
|
50 | 51 | for name, func in sorted(magics["cell"].items(), key=sortkey): |
|
51 | 52 | if name == "!": |
|
52 | 53 | # Special case - don't encourage people to use %%! |
|
53 | 54 | continue |
|
54 | 55 | if func == magics["line"].get(name, "QQQP"): |
|
55 | 56 | # Don't redocument line magics that double as cell magics |
|
56 | 57 | continue |
|
57 | 58 | if isinstance(func, MagicAlias): |
|
58 | 59 | continue |
|
59 | 60 | output.extend([".. cellmagic:: {}".format(name), |
|
60 | 61 | "", |
|
61 | 62 | format_docstring(func), |
|
62 | 63 | ""]) |
|
63 | 64 | |
|
65 | ||
|
64 | 66 | src_path = Path(__file__).parent |
|
65 | 67 | dest = src_path.joinpath("source", "interactive", "magics-generated.txt") |
|
66 | with open(dest, "w") as f: | |
|
67 | f.write("\n".join(output)) | |
|
68 | dest.write_text("\n".join(output)) |
@@ -1,473 +1,520 b'' | |||
|
1 | 1 | |
|
2 | 2 | .. _ipython_directive: |
|
3 | 3 | |
|
4 | 4 | ======================== |
|
5 | 5 | IPython Sphinx Directive |
|
6 | 6 | ======================== |
|
7 | 7 | |
|
8 | 8 | .. note:: |
|
9 | 9 | |
|
10 | 10 | The IPython Sphinx Directive is in 'beta' and currently under |
|
11 | 11 | active development. Improvements to the code or documentation are welcome! |
|
12 | 12 | |
|
13 | The ipython directive is a stateful ipython shell for embedding in | |
|
14 | sphinx documents. It knows about standard ipython prompts, and | |
|
15 | extracts the input and output lines. These prompts will be renumbered | |
|
16 | starting at ``1``. The inputs will be fed to an embedded ipython | |
|
17 | interpreter and the outputs from that interpreter will be inserted as | |
|
18 | well. For example, code blocks like the following:: | |
|
13 | .. |rst| replace:: reStructured text | |
|
14 | ||
|
15 | The :rst:dir:`ipython` directive is a stateful shell that can be used | |
|
16 | in |rst| files. | |
|
17 | ||
|
18 | It knows about standard ipython prompts, and extracts the input and output | |
|
19 | lines. These prompts will be renumbered starting at ``1``. The inputs will be | |
|
20 | fed to an embedded ipython interpreter and the outputs from that interpreter | |
|
21 | will be inserted as well. For example, code blocks like the following:: | |
|
19 | 22 | |
|
20 | 23 | .. ipython:: |
|
21 | 24 | |
|
22 | 25 | In [136]: x = 2 |
|
23 | 26 | |
|
24 | 27 | In [137]: x**3 |
|
25 | 28 | Out[137]: 8 |
|
26 | 29 | |
|
27 | 30 | will be rendered as |
|
28 | 31 | |
|
29 | 32 | .. ipython:: |
|
30 | 33 | |
|
31 | 34 | In [136]: x = 2 |
|
32 | 35 | |
|
33 | 36 | In [137]: x**3 |
|
34 | 37 | Out[137]: 8 |
|
35 | 38 | |
|
36 | 39 | .. note:: |
|
37 | 40 | |
|
38 | 41 | This tutorial should be read side-by-side with the Sphinx source |
|
39 | 42 | for this document because otherwise you will see only the rendered |
|
40 | 43 | output and not the code that generated it. Excepting the example |
|
41 | 44 | above, we will not in general be showing the literal ReST in this |
|
42 | 45 | document that generates the rendered output. |
|
43 | 46 | |
|
44 | 47 | |
|
48 | Directive and options | |
|
49 | ===================== | |
|
50 | ||
|
51 | The IPython directive takes a number of options detailed here. | |
|
52 | ||
|
53 | .. rst:directive:: ipython | |
|
54 | ||
|
55 | Create an IPython directive. | |
|
56 | ||
|
57 | .. rst:directive:option:: doctest | |
|
58 | ||
|
59 | Run a doctest on IPython code blocks in rst. | |
|
60 | ||
|
61 | .. rst:directive:option:: python | |
|
62 | ||
|
63 | Used to indicate that the relevant code block does not have IPython prompts. | |
|
64 | ||
|
65 | .. rst:directive:option:: okexcept | |
|
66 | ||
|
67 | Allow the code block to raise an exception. | |
|
68 | ||
|
69 | .. rst:directive:option:: okwarning | |
|
70 | ||
|
71 | Allow the code block to emit an warning. | |
|
72 | ||
|
73 | .. rst:directive:option:: suppress | |
|
74 | ||
|
75 | Silence any warnings or expected errors. | |
|
76 | ||
|
77 | .. rst:directive:option:: verbatim | |
|
78 | ||
|
79 | A noop that allows for any text to be syntax highlighted as valid IPython code. | |
|
80 | ||
|
81 | .. rst:directive:option:: savefig: OUTFILE [IMAGE_OPTIONS] | |
|
82 | ||
|
83 | Save output from matplotlib to *outfile*. | |
|
84 | ||
|
85 | It's important to note that all of these options can be used for the entire | |
|
86 | directive block or they can decorate individual lines of code as explained | |
|
87 | in :ref:`pseudo-decorators`. | |
|
88 | ||
|
89 | ||
|
45 | 90 | Persisting the Python session across IPython directive blocks |
|
46 | 91 | ============================================================= |
|
47 | 92 | |
|
48 | 93 | The state from previous sessions is stored, and standard error is |
|
49 | 94 | trapped. At doc build time, ipython's output and std err will be |
|
50 | 95 | inserted, and prompts will be renumbered. So the prompt below should |
|
51 | 96 | be renumbered in the rendered docs, and pick up where the block above |
|
52 | 97 | left off. |
|
53 | 98 | |
|
54 | 99 | .. ipython:: |
|
55 | 100 | :verbatim: |
|
56 | 101 | |
|
57 | 102 | In [138]: z = x*3 # x is recalled from previous block |
|
58 | 103 | |
|
59 | 104 | In [139]: z |
|
60 | 105 | Out[139]: 6 |
|
61 | 106 | |
|
62 | 107 | In [142]: print(z) |
|
63 | 108 | 6 |
|
64 | 109 | |
|
65 | 110 | In [141]: q = z[) # this is a syntax error -- we trap ipy exceptions |
|
66 | 111 | ------------------------------------------------------------ |
|
67 | 112 | File "<ipython console>", line 1 |
|
68 | 113 | q = z[) # this is a syntax error -- we trap ipy exceptions |
|
69 | 114 | ^ |
|
70 | 115 | SyntaxError: invalid syntax |
|
71 | 116 | |
|
72 | 117 | |
|
73 | 118 | Adding documentation tests to your IPython directive |
|
74 | 119 | ==================================================== |
|
75 | 120 | |
|
76 | 121 | The embedded interpreter supports some limited markup. For example, |
|
77 | 122 | you can put comments in your ipython sessions, which are reported |
|
78 | 123 | verbatim. There are some handy "pseudo-decorators" that let you |
|
79 | 124 | doctest the output. The inputs are fed to an embedded ipython |
|
80 | 125 | session and the outputs from the ipython session are inserted into |
|
81 | 126 | your doc. If the output in your doc and in the ipython session don't |
|
82 | 127 | match on a doctest assertion, an error will occur. |
|
83 | 128 | |
|
84 | 129 | |
|
85 | 130 | .. ipython:: |
|
86 | 131 | |
|
87 | 132 | In [1]: x = 'hello world' |
|
88 | 133 | |
|
89 | 134 | # this will raise an error if the ipython output is different |
|
90 | 135 | @doctest |
|
91 | 136 | In [2]: x.upper() |
|
92 | 137 | Out[2]: 'HELLO WORLD' |
|
93 | 138 | |
|
94 | 139 | # some readline features cannot be supported, so we allow |
|
95 | 140 | # "verbatim" blocks, which are dumped in verbatim except prompts |
|
96 | 141 | # are continuously numbered |
|
97 | 142 | @verbatim |
|
98 | 143 | In [3]: x.st<TAB> |
|
99 | 144 | x.startswith x.strip |
|
100 | 145 | |
|
101 | 146 | For more information on @doctest decorator, please refer to the end of this page in Pseudo-Decorators section. |
|
102 | 147 | |
|
103 | 148 | Multi-line input |
|
104 | 149 | ================ |
|
105 | 150 | |
|
106 | 151 | Multi-line input is supported. |
|
107 | 152 | |
|
108 | 153 | .. ipython:: |
|
109 | 154 | :verbatim: |
|
110 | 155 | |
|
111 | 156 | In [130]: url = 'http://ichart.finance.yahoo.com/table.csv?s=CROX\ |
|
112 | 157 | .....: &d=9&e=22&f=2009&g=d&a=1&br=8&c=2006&ignore=.csv' |
|
113 | 158 | |
|
114 | 159 | In [131]: print(url.split('&')) |
|
115 | 160 | ['http://ichart.finance.yahoo.com/table.csv?s=CROX', 'd=9', 'e=22', |
|
116 | 161 | |
|
117 | 162 | Testing directive outputs |
|
118 | 163 | ========================= |
|
119 | 164 | |
|
120 | 165 | The IPython Sphinx Directive makes it possible to test the outputs that you provide with your code. To do this, |
|
121 | 166 | decorate the contents in your directive block with one of the following: |
|
122 | 167 | |
|
123 | 168 | * list directives here |
|
124 | 169 | |
|
125 | 170 | If an IPython doctest decorator is found, it will take these steps when your documentation is built: |
|
126 | 171 | |
|
127 | 172 | 1. Run the *input* lines in your IPython directive block against the current Python kernel (remember that the session |
|
128 | 173 | persists across IPython directive blocks); |
|
129 | 174 | |
|
130 | 175 | 2. Compare the *output* of this with the output text that you've put in the IPython directive block (what comes |
|
131 | 176 | after `Out[NN]`); |
|
132 | 177 | |
|
133 | 178 | 3. If there is a difference, the directive will raise an error and your documentation build will fail. |
|
134 | 179 | |
|
135 | 180 | You can do doctesting on multi-line output as well. Just be careful |
|
136 | 181 | when using non-deterministic inputs like random numbers in the ipython |
|
137 | 182 | directive, because your inputs are run through a live interpreter, so |
|
138 | 183 | if you are doctesting random output you will get an error. Here we |
|
139 | 184 | "seed" the random number generator for deterministic output, and we |
|
140 | 185 | suppress the seed line so it doesn't show up in the rendered output |
|
141 | 186 | |
|
142 | 187 | .. ipython:: |
|
143 | 188 | |
|
144 | 189 | In [133]: import numpy.random |
|
145 | 190 | |
|
146 | 191 | @suppress |
|
147 | 192 | In [134]: numpy.random.seed(2358) |
|
148 | 193 | |
|
149 | 194 | @doctest |
|
150 | 195 | In [135]: numpy.random.rand(10,2) |
|
151 | 196 | Out[135]: |
|
152 | 197 | array([[0.64524308, 0.59943846], |
|
153 | 198 | [0.47102322, 0.8715456 ], |
|
154 | 199 | [0.29370834, 0.74776844], |
|
155 | 200 | [0.99539577, 0.1313423 ], |
|
156 | 201 | [0.16250302, 0.21103583], |
|
157 | 202 | [0.81626524, 0.1312433 ], |
|
158 | 203 | [0.67338089, 0.72302393], |
|
159 | 204 | [0.7566368 , 0.07033696], |
|
160 | 205 | [0.22591016, 0.77731835], |
|
161 | 206 | [0.0072729 , 0.34273127]]) |
|
162 | 207 | |
|
163 | 208 | For more information on @supress and @doctest decorators, please refer to the end of this file in |
|
164 | 209 | Pseudo-Decorators section. |
|
165 | 210 | |
|
166 | 211 | Another demonstration of multi-line input and output |
|
167 | 212 | |
|
168 | 213 | .. ipython:: |
|
169 | 214 | :verbatim: |
|
170 | 215 | |
|
171 | 216 | In [106]: print(x) |
|
172 | 217 | jdh |
|
173 | 218 | |
|
174 | 219 | In [109]: for i in range(10): |
|
175 | 220 | .....: print(i) |
|
176 | 221 | .....: |
|
177 | 222 | .....: |
|
178 | 223 | 0 |
|
179 | 224 | 1 |
|
180 | 225 | 2 |
|
181 | 226 | 3 |
|
182 | 227 | 4 |
|
183 | 228 | 5 |
|
184 | 229 | 6 |
|
185 | 230 | 7 |
|
186 | 231 | 8 |
|
187 | 232 | 9 |
|
188 | 233 | |
|
189 | 234 | |
|
190 | 235 | Most of the "pseudo-decorators" can be used an options to ipython |
|
191 | 236 | mode. For example, to setup matplotlib pylab but suppress the output, |
|
192 | 237 | you can do. When using the matplotlib ``use`` directive, it should |
|
193 | 238 | occur before any import of pylab. This will not show up in the |
|
194 | 239 | rendered docs, but the commands will be executed in the embedded |
|
195 | 240 | interpreter and subsequent line numbers will be incremented to reflect |
|
196 | 241 | the inputs:: |
|
197 | 242 | |
|
198 | 243 | |
|
199 | 244 | .. ipython:: |
|
200 | 245 | :suppress: |
|
201 | 246 | |
|
202 | 247 | In [144]: from matplotlib.pylab import * |
|
203 | 248 | |
|
204 | 249 | In [145]: ion() |
|
205 | 250 | |
|
206 | 251 | .. ipython:: |
|
207 | 252 | :suppress: |
|
208 | 253 | |
|
209 | 254 | In [144]: from matplotlib.pylab import * |
|
210 | 255 | |
|
211 | 256 | In [145]: ion() |
|
212 | 257 | |
|
213 | 258 | Likewise, you can set ``:doctest:`` or ``:verbatim:`` to apply these |
|
214 | 259 | settings to the entire block. For example, |
|
215 | 260 | |
|
216 | 261 | .. ipython:: |
|
217 | 262 | :verbatim: |
|
218 | 263 | |
|
219 | 264 | In [9]: cd mpl/examples/ |
|
220 | 265 | /home/jdhunter/mpl/examples |
|
221 | 266 | |
|
222 | 267 | In [10]: pwd |
|
223 | 268 | Out[10]: '/home/jdhunter/mpl/examples' |
|
224 | 269 | |
|
225 | 270 | |
|
226 | 271 | In [14]: cd mpl/examples/<TAB> |
|
227 | 272 | mpl/examples/animation/ mpl/examples/misc/ |
|
228 | 273 | mpl/examples/api/ mpl/examples/mplot3d/ |
|
229 | 274 | mpl/examples/axes_grid/ mpl/examples/pylab_examples/ |
|
230 | 275 | mpl/examples/event_handling/ mpl/examples/widgets |
|
231 | 276 | |
|
232 | 277 | In [14]: cd mpl/examples/widgets/ |
|
233 | 278 | /home/msierig/mpl/examples/widgets |
|
234 | 279 | |
|
235 | 280 | In [15]: !wc * |
|
236 | 281 | 2 12 77 README.txt |
|
237 | 282 | 40 97 884 buttons.py |
|
238 | 283 | 26 90 712 check_buttons.py |
|
239 | 284 | 19 52 416 cursor.py |
|
240 | 285 | 180 404 4882 menu.py |
|
241 | 286 | 16 45 337 multicursor.py |
|
242 | 287 | 36 106 916 radio_buttons.py |
|
243 | 288 | 48 226 2082 rectangle_selector.py |
|
244 | 289 | 43 118 1063 slider_demo.py |
|
245 | 290 | 40 124 1088 span_selector.py |
|
246 | 291 | 450 1274 12457 total |
|
247 | 292 | |
|
248 | 293 | You can create one or more pyplot plots and insert them with the |
|
249 | 294 | ``@savefig`` decorator. |
|
250 | 295 | |
|
251 | 296 | For more information on @savefig decorator, please refer to the end of this page in Pseudo-Decorators section. |
|
252 | 297 | |
|
253 | 298 | .. ipython:: |
|
254 | 299 | |
|
255 | 300 | @savefig plot_simple.png width=4in |
|
256 | 301 | In [151]: plot([1,2,3]); |
|
257 | 302 | |
|
258 | 303 | # use a semicolon to suppress the output |
|
259 | 304 | @savefig hist_simple.png width=4in |
|
260 | 305 | In [151]: hist(np.random.randn(10000), 100); |
|
261 | 306 | |
|
262 | 307 | In a subsequent session, we can update the current figure with some |
|
263 | 308 | text, and then resave |
|
264 | 309 | |
|
265 | 310 | .. ipython:: |
|
266 | 311 | |
|
267 | 312 | |
|
268 | 313 | In [151]: ylabel('number') |
|
269 | 314 | |
|
270 | 315 | In [152]: title('normal distribution') |
|
271 | 316 | |
|
272 | 317 | @savefig hist_with_text.png width=4in |
|
273 | 318 | In [153]: grid(True) |
|
274 | 319 | |
|
275 | 320 | You can also have function definitions included in the source. |
|
276 | 321 | |
|
277 | 322 | .. ipython:: |
|
278 | 323 | |
|
279 | 324 | In [3]: def square(x): |
|
280 | 325 | ...: """ |
|
281 | 326 | ...: An overcomplicated square function as an example. |
|
282 | 327 | ...: """ |
|
283 | 328 | ...: if x < 0: |
|
284 | 329 | ...: x = abs(x) |
|
285 | 330 | ...: y = x * x |
|
286 | 331 | ...: return y |
|
287 | 332 | ...: |
|
288 | 333 | |
|
289 | 334 | Then call it from a subsequent section. |
|
290 | 335 | |
|
291 | 336 | .. ipython:: |
|
292 | 337 | |
|
293 | 338 | In [4]: square(3) |
|
294 | 339 | Out [4]: 9 |
|
295 | 340 | |
|
296 | 341 | In [5]: square(-2) |
|
297 | 342 | Out [5]: 4 |
|
298 | 343 | |
|
299 | 344 | |
|
300 | 345 | Writing Pure Python Code |
|
301 | 346 | ------------------------ |
|
302 | 347 | |
|
303 | 348 | Pure python code is supported by the optional argument `python`. In this pure |
|
304 | 349 | python syntax you do not include the output from the python interpreter. The |
|
305 | 350 | following markup:: |
|
306 | 351 | |
|
307 | 352 | .. ipython:: python |
|
308 | 353 | |
|
309 | 354 | foo = 'bar' |
|
310 | 355 | print(foo) |
|
311 | 356 | foo = 2 |
|
312 | 357 | foo**2 |
|
313 | 358 | |
|
314 | 359 | Renders as |
|
315 | 360 | |
|
316 | 361 | .. ipython:: python |
|
317 | 362 | |
|
318 | 363 | foo = 'bar' |
|
319 | 364 | print(foo) |
|
320 | 365 | foo = 2 |
|
321 | 366 | foo**2 |
|
322 | 367 | |
|
323 | 368 | We can even plot from python, using the savefig decorator, as well as, suppress |
|
324 | 369 | output with a semicolon |
|
325 | 370 | |
|
326 | 371 | .. ipython:: python |
|
327 | 372 | |
|
328 | 373 | @savefig plot_simple_python.png width=4in |
|
329 | 374 | plot([1,2,3]); |
|
330 | 375 | |
|
331 | 376 | For more information on @savefig decorator, please refer to the end of this page in Pseudo-Decorators section. |
|
332 | 377 | |
|
333 | 378 | Similarly, std err is inserted |
|
334 | 379 | |
|
335 | 380 | .. ipython:: python |
|
336 | 381 | :okexcept: |
|
337 | 382 | |
|
338 | 383 | foo = 'bar' |
|
339 | 384 | foo[) |
|
340 | 385 | |
|
341 | 386 | Handling Comments |
|
342 | 387 | ================== |
|
343 | 388 | |
|
344 | 389 | Comments are handled and state is preserved |
|
345 | 390 | |
|
346 | 391 | .. ipython:: python |
|
347 | 392 | |
|
348 | 393 | # comments are handled |
|
349 | 394 | print(foo) |
|
350 | 395 | |
|
351 | 396 | If you don't see the next code block then the options work. |
|
352 | 397 | |
|
353 | 398 | .. ipython:: python |
|
354 | 399 | :suppress: |
|
355 | 400 | |
|
356 | 401 | ioff() |
|
357 | 402 | ion() |
|
358 | 403 | |
|
359 | 404 | Splitting Python statements across lines |
|
360 | 405 | ======================================== |
|
361 | 406 | |
|
362 | 407 | Multi-line input is handled. |
|
363 | 408 | |
|
364 | 409 | .. ipython:: python |
|
365 | 410 | |
|
366 | 411 | line = 'Multi\ |
|
367 | 412 | line &\ |
|
368 | 413 | support &\ |
|
369 | 414 | works' |
|
370 | 415 | print(line.split('&')) |
|
371 | 416 | |
|
372 | 417 | Functions definitions are correctly parsed |
|
373 | 418 | |
|
374 | 419 | .. ipython:: python |
|
375 | 420 | |
|
376 | 421 | def square(x): |
|
377 | 422 | """ |
|
378 | 423 | An overcomplicated square function as an example. |
|
379 | 424 | """ |
|
380 | 425 | if x < 0: |
|
381 | 426 | x = abs(x) |
|
382 | 427 | y = x * x |
|
383 | 428 | return y |
|
384 | 429 | |
|
385 | 430 | And persist across sessions |
|
386 | 431 | |
|
387 | 432 | .. ipython:: python |
|
388 | 433 | |
|
389 | 434 | print(square(3)) |
|
390 | 435 | print(square(-2)) |
|
391 | 436 | |
|
392 | 437 | Pretty much anything you can do with the ipython code, you can do with |
|
393 | 438 | with a simple python script. Obviously, though it doesn't make sense |
|
394 | 439 | to use the doctest option. |
|
395 | 440 | |
|
441 | .. _pseudo-decorators: | |
|
442 | ||
|
396 | 443 | Pseudo-Decorators |
|
397 | 444 | ================= |
|
398 | 445 | |
|
399 | 446 | Here are the supported decorators, and any optional arguments they |
|
400 | 447 | take. Some of the decorators can be used as options to the entire |
|
401 | 448 | block (eg ``verbatim`` and ``suppress``), and some only apply to the |
|
402 | 449 | line just below them (eg ``savefig``). |
|
403 | 450 | |
|
404 | 451 | @suppress |
|
405 | 452 | |
|
406 | 453 | execute the ipython input block, but suppress the input and output |
|
407 | 454 | block from the rendered output. Also, can be applied to the entire |
|
408 | 455 | ``.. ipython`` block as a directive option with ``:suppress:``. |
|
409 | 456 | |
|
410 | 457 | @verbatim |
|
411 | 458 | |
|
412 | 459 | insert the input and output block in verbatim, but auto-increment |
|
413 | 460 | the line numbers. Internally, the interpreter will be fed an empty |
|
414 | 461 | string, so it is a no-op that keeps line numbering consistent. |
|
415 | 462 | Also, can be applied to the entire ``.. ipython`` block as a |
|
416 | 463 | directive option with ``:verbatim:``. |
|
417 | 464 | |
|
418 | 465 | @savefig OUTFILE [IMAGE_OPTIONS] |
|
419 | 466 | |
|
420 | 467 | save the figure to the static directory and insert it into the |
|
421 | 468 | document, possibly binding it into a minipage and/or putting |
|
422 | 469 | code/figure label/references to associate the code and the |
|
423 | 470 | figure. Takes args to pass to the image directive (*scale*, |
|
424 | 471 | *width*, etc can be kwargs); see `image options |
|
425 | 472 | <http://docutils.sourceforge.net/docs/ref/rst/directives.html#image>`_ |
|
426 | 473 | for details. |
|
427 | 474 | |
|
428 | 475 | @doctest |
|
429 | 476 | |
|
430 | 477 | Compare the pasted in output in the ipython block with the output |
|
431 | 478 | generated at doc build time, and raise errors if they don't |
|
432 | 479 | match. Also, can be applied to the entire ``.. ipython`` block as a |
|
433 | 480 | directive option with ``:doctest:``. |
|
434 | 481 | |
|
435 | 482 | Configuration Options |
|
436 | 483 | ===================== |
|
437 | 484 | |
|
438 | 485 | ipython_savefig_dir |
|
439 | 486 | |
|
440 | 487 | The directory in which to save the figures. This is relative to the |
|
441 | 488 | Sphinx source directory. The default is `html_static_path`. |
|
442 | 489 | |
|
443 | 490 | ipython_rgxin |
|
444 | 491 | |
|
445 | 492 | The compiled regular expression to denote the start of IPython input |
|
446 | 493 | lines. The default is `re.compile('In \[(\d+)\]:\s?(.*)\s*')`. You |
|
447 | 494 | shouldn't need to change this. |
|
448 | 495 | |
|
449 | 496 | ipython_rgxout |
|
450 | 497 | |
|
451 | 498 | The compiled regular expression to denote the start of IPython output |
|
452 | 499 | lines. The default is `re.compile('Out\[(\d+)\]:\s?(.*)\s*')`. You |
|
453 | 500 | shouldn't need to change this. |
|
454 | 501 | |
|
455 | 502 | |
|
456 | 503 | ipython_promptin |
|
457 | 504 | |
|
458 | 505 | The string to represent the IPython input prompt in the generated ReST. |
|
459 | 506 | The default is `'In [%d]:'`. This expects that the line numbers are used |
|
460 | 507 | in the prompt. |
|
461 | 508 | |
|
462 | 509 | ipython_promptout |
|
463 | 510 | |
|
464 | 511 | The string to represent the IPython prompt in the generated ReST. The |
|
465 | 512 | default is `'Out [%d]:'`. This expects that the line numbers are used |
|
466 | 513 | in the prompt. |
|
467 | 514 | |
|
468 | 515 | |
|
469 | 516 | Automatically generated documentation |
|
470 | 517 | ===================================== |
|
471 | 518 | |
|
472 | 519 | .. automodule:: IPython.sphinxext.ipython_directive |
|
473 | 520 |
@@ -1,82 +1,81 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | """Update the What's New doc (development version) |
|
3 | 3 | |
|
4 | 4 | This collects the snippets from whatsnew/pr/, moves their content into |
|
5 | 5 | whatsnew/development.rst (chronologically ordered), and deletes the snippets. |
|
6 | 6 | """ |
|
7 | 7 | |
|
8 | 8 | import io |
|
9 | 9 | import sys |
|
10 |
from |
|
|
11 | from os.path import dirname, basename, abspath, join as pjoin | |
|
10 | from pathlib import Path | |
|
12 | 11 | from subprocess import check_call, check_output |
|
13 | 12 | |
|
14 | repo_root = dirname(dirname(abspath(__file__))) | |
|
15 |
whatsnew_dir = |
|
|
16 |
pr_dir = |
|
|
17 |
target = |
|
|
13 | repo_root = Path(__file__).resolve().parent.parent | |
|
14 | whatsnew_dir = repo_root / "docs" / "source" / "whatsnew" | |
|
15 | pr_dir = whatsnew_dir / "pr" | |
|
16 | target = whatsnew_dir / "development.rst" | |
|
18 | 17 | |
|
19 | 18 | FEATURE_MARK = ".. DO NOT EDIT THIS LINE BEFORE RELEASE. FEATURE INSERTION POINT." |
|
20 | 19 | INCOMPAT_MARK = ".. DO NOT EDIT THIS LINE BEFORE RELEASE. INCOMPAT INSERTION POINT." |
|
21 | 20 | |
|
22 | 21 | # 1. Collect the whatsnew snippet files --------------------------------------- |
|
23 | 22 | |
|
24 |
files = set(glob( |
|
|
23 | files = set(pr_dir.glob("*.rst")) | |
|
25 | 24 | # Ignore explanatory and example files |
|
26 |
files.difference_update( |
|
|
27 | 'incompat-switching-to-perl.rst', | |
|
28 | 'antigravity-feature.rst'} | |
|
29 | }) | |
|
25 | files.difference_update( | |
|
26 | {pr_dir / f for f in {"incompat-switching-to-perl.rst", "antigravity-feature.rst"}} | |
|
27 | ) | |
|
30 | 28 | |
|
31 | 29 | if not files: |
|
32 | 30 | print("No automatic update available for what's new") |
|
33 | 31 | sys.exit(0) |
|
34 | 32 | |
|
35 | 33 | |
|
36 | 34 | def getmtime(f): |
|
37 |
return check_output([ |
|
|
35 | return check_output(["git", "log", "-1", '--format="%ai"', "--", f]) | |
|
36 | ||
|
38 | 37 | |
|
39 | 38 | files = sorted(files, key=getmtime) |
|
40 | 39 | |
|
41 | 40 | features, incompats = [], [] |
|
42 | 41 | for path in files: |
|
43 |
with io.open(path, encoding= |
|
|
42 | with io.open(path, encoding="utf-8") as f: | |
|
44 | 43 | try: |
|
45 | 44 | content = f.read().rstrip() |
|
46 | 45 | except Exception as e: |
|
47 | 46 | raise Exception('Error reading "{}"'.format(f)) from e |
|
48 | 47 | |
|
49 |
if |
|
|
48 | if path.name.startswith("incompat-"): | |
|
50 | 49 | incompats.append(content) |
|
51 | 50 | else: |
|
52 | 51 | features.append(content) |
|
53 | 52 | |
|
54 | 53 | # Put the insertion markers back on the end, so they're ready for next time. |
|
55 |
feature_block = |
|
|
56 |
incompat_block = |
|
|
54 | feature_block = "\n\n".join(features + [FEATURE_MARK]) | |
|
55 | incompat_block = "\n\n".join(incompats + [INCOMPAT_MARK]) | |
|
57 | 56 | |
|
58 | 57 | # 2. Update the target file --------------------------------------------------- |
|
59 | 58 | |
|
60 |
with io.open(target, encoding= |
|
|
59 | with io.open(target, encoding="utf-8") as f: | |
|
61 | 60 | content = f.read() |
|
62 | 61 | |
|
63 | 62 | assert content.count(FEATURE_MARK) == 1 |
|
64 | 63 | assert content.count(INCOMPAT_MARK) == 1 |
|
65 | 64 | |
|
66 | 65 | content = content.replace(FEATURE_MARK, feature_block) |
|
67 | 66 | content = content.replace(INCOMPAT_MARK, incompat_block) |
|
68 | 67 | |
|
69 | 68 | # Clean trailing whitespace |
|
70 |
content = |
|
|
69 | content = "\n".join(l.rstrip() for l in content.splitlines()) | |
|
71 | 70 | |
|
72 |
with io.open(target, |
|
|
71 | with io.open(target, "w", encoding="utf-8") as f: | |
|
73 | 72 | f.write(content) |
|
74 | 73 | |
|
75 | 74 | # 3. Stage the changes in git ------------------------------------------------- |
|
76 | 75 | |
|
77 | 76 | for file in files: |
|
78 |
check_call([ |
|
|
77 | check_call(["git", "rm", file]) | |
|
79 | 78 | |
|
80 |
check_call([ |
|
|
79 | check_call(["git", "add", target]) | |
|
81 | 80 | |
|
82 | 81 | print("Merged what's new changes. Check the diff and commit the change.") |
General Comments 0
You need to be logged in to leave comments.
Login now