##// END OF EJS Templates
Fix use of --pylab=auto and --matplotlib=auto
Ian Thomas -
Show More
@@ -1,3980 +1,3987 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 bdb
18 18 import builtins as builtin_mod
19 19 import functools
20 20 import inspect
21 21 import os
22 22 import re
23 23 import runpy
24 24 import shutil
25 25 import subprocess
26 26 import sys
27 27 import tempfile
28 28 import traceback
29 29 import types
30 30 import warnings
31 31 from ast import stmt
32 32 from io import open as io_open
33 33 from logging import error
34 34 from pathlib import Path
35 35 from typing import Callable
36 36 from typing import List as ListType, Dict as DictType, Any as AnyType
37 37 from typing import Optional, Sequence, Tuple
38 38 from warnings import warn
39 39
40 40 try:
41 41 from pickleshare import PickleShareDB
42 42 except ModuleNotFoundError:
43 43
44 44 class PickleShareDB: # type: ignore [no-redef]
45 45 _mock = True
46 46
47 47 def __init__(self, path):
48 48 pass
49 49
50 50 def get(self, key, default=None):
51 51 warn(
52 52 f"This is now an optional IPython functionality, using {key} requires you to install the `pickleshare` library.",
53 53 stacklevel=2,
54 54 )
55 55 return default
56 56
57 57 def __getitem__(self, key):
58 58 warn(
59 59 f"This is now an optional IPython functionality, using {key} requires you to install the `pickleshare` library.",
60 60 stacklevel=2,
61 61 )
62 62 return None
63 63
64 64 def __setitem__(self, key, value):
65 65 warn(
66 66 f"This is now an optional IPython functionality, setting {key} requires you to install the `pickleshare` library.",
67 67 stacklevel=2,
68 68 )
69 69
70 70 def __delitem__(self, key):
71 71 warn(
72 72 f"This is now an optional IPython functionality, deleting {key} requires you to install the `pickleshare` library.",
73 73 stacklevel=2,
74 74 )
75 75
76 76
77 77 from tempfile import TemporaryDirectory
78 78 from traitlets import (
79 79 Any,
80 80 Bool,
81 81 CaselessStrEnum,
82 82 Dict,
83 83 Enum,
84 84 Instance,
85 85 Integer,
86 86 List,
87 87 Type,
88 88 Unicode,
89 89 default,
90 90 observe,
91 91 validate,
92 92 )
93 93 from traitlets.config.configurable import SingletonConfigurable
94 94 from traitlets.utils.importstring import import_item
95 95
96 96 import IPython.core.hooks
97 97 from IPython.core import magic, oinspect, page, prefilter, ultratb
98 98 from IPython.core.alias import Alias, AliasManager
99 99 from IPython.core.autocall import ExitAutocall
100 100 from IPython.core.builtin_trap import BuiltinTrap
101 101 from IPython.core.compilerop import CachingCompiler
102 102 from IPython.core.debugger import InterruptiblePdb
103 103 from IPython.core.display_trap import DisplayTrap
104 104 from IPython.core.displayhook import DisplayHook
105 105 from IPython.core.displaypub import DisplayPublisher
106 106 from IPython.core.error import InputRejected, UsageError
107 107 from IPython.core.events import EventManager, available_events
108 108 from IPython.core.extensions import ExtensionManager
109 109 from IPython.core.formatters import DisplayFormatter
110 110 from IPython.core.history import HistoryManager
111 111 from IPython.core.inputtransformer2 import ESC_MAGIC, ESC_MAGIC2
112 112 from IPython.core.logger import Logger
113 113 from IPython.core.macro import Macro
114 114 from IPython.core.payload import PayloadManager
115 115 from IPython.core.prefilter import PrefilterManager
116 116 from IPython.core.profiledir import ProfileDir
117 117 from IPython.core.usage import default_banner
118 118 from IPython.display import display
119 119 from IPython.paths import get_ipython_dir
120 120 from IPython.testing.skipdoctest import skip_doctest
121 121 from IPython.utils import PyColorize, io, openpy, py3compat
122 122 from IPython.utils.decorators import undoc
123 123 from IPython.utils.io import ask_yes_no
124 124 from IPython.utils.ipstruct import Struct
125 125 from IPython.utils.path import ensure_dir_exists, get_home_dir, get_py_filename
126 126 from IPython.utils.process import getoutput, system
127 127 from IPython.utils.strdispatch import StrDispatch
128 128 from IPython.utils.syspathcontext import prepended_to_syspath
129 129 from IPython.utils.text import DollarFormatter, LSString, SList, format_screen
130 130 from IPython.core.oinspect import OInfo
131 131
132 132
133 133 sphinxify: Optional[Callable]
134 134
135 135 try:
136 136 import docrepr.sphinxify as sphx
137 137
138 138 def sphinxify(oinfo):
139 139 wrapped_docstring = sphx.wrap_main_docstring(oinfo)
140 140
141 141 def sphinxify_docstring(docstring):
142 142 with TemporaryDirectory() as dirname:
143 143 return {
144 144 "text/html": sphx.sphinxify(wrapped_docstring, dirname),
145 145 "text/plain": docstring,
146 146 }
147 147
148 148 return sphinxify_docstring
149 149 except ImportError:
150 150 sphinxify = None
151 151
152 152 if sys.version_info[:2] < (3, 11):
153 153 from exceptiongroup import BaseExceptionGroup
154 154
155 155 class ProvisionalWarning(DeprecationWarning):
156 156 """
157 157 Warning class for unstable features
158 158 """
159 159 pass
160 160
161 161 from ast import Module
162 162
163 163 _assign_nodes = (ast.AugAssign, ast.AnnAssign, ast.Assign)
164 164 _single_targets_nodes = (ast.AugAssign, ast.AnnAssign)
165 165
166 166 #-----------------------------------------------------------------------------
167 167 # Await Helpers
168 168 #-----------------------------------------------------------------------------
169 169
170 170 # we still need to run things using the asyncio eventloop, but there is no
171 171 # async integration
172 172 from .async_helpers import (
173 173 _asyncio_runner,
174 174 _curio_runner,
175 175 _pseudo_sync_runner,
176 176 _should_be_async,
177 177 _trio_runner,
178 178 )
179 179
180 180 #-----------------------------------------------------------------------------
181 181 # Globals
182 182 #-----------------------------------------------------------------------------
183 183
184 184 # compiled regexps for autoindent management
185 185 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
186 186
187 187 #-----------------------------------------------------------------------------
188 188 # Utilities
189 189 #-----------------------------------------------------------------------------
190 190
191 191
192 192 def is_integer_string(s: str):
193 193 """
194 194 Variant of "str.isnumeric()" that allow negative values and other ints.
195 195 """
196 196 try:
197 197 int(s)
198 198 return True
199 199 except ValueError:
200 200 return False
201 201 raise ValueError("Unexpected error")
202 202
203 203
204 204 @undoc
205 205 def softspace(file, newvalue):
206 206 """Copied from code.py, to remove the dependency"""
207 207
208 208 oldvalue = 0
209 209 try:
210 210 oldvalue = file.softspace
211 211 except AttributeError:
212 212 pass
213 213 try:
214 214 file.softspace = newvalue
215 215 except (AttributeError, TypeError):
216 216 # "attribute-less object" or "read-only attributes"
217 217 pass
218 218 return oldvalue
219 219
220 220 @undoc
221 221 def no_op(*a, **kw):
222 222 pass
223 223
224 224
225 225 class SpaceInInput(Exception): pass
226 226
227 227
228 228 class SeparateUnicode(Unicode):
229 229 r"""A Unicode subclass to validate separate_in, separate_out, etc.
230 230
231 231 This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``.
232 232 """
233 233
234 234 def validate(self, obj, value):
235 235 if value == '0': value = ''
236 236 value = value.replace('\\n','\n')
237 237 return super(SeparateUnicode, self).validate(obj, value)
238 238
239 239
240 240 @undoc
241 241 class DummyMod(object):
242 242 """A dummy module used for IPython's interactive module when
243 243 a namespace must be assigned to the module's __dict__."""
244 244 __spec__ = None
245 245
246 246
247 247 class ExecutionInfo(object):
248 248 """The arguments used for a call to :meth:`InteractiveShell.run_cell`
249 249
250 250 Stores information about what is going to happen.
251 251 """
252 252 raw_cell = None
253 253 store_history = False
254 254 silent = False
255 255 shell_futures = True
256 256 cell_id = None
257 257
258 258 def __init__(self, raw_cell, store_history, silent, shell_futures, cell_id):
259 259 self.raw_cell = raw_cell
260 260 self.store_history = store_history
261 261 self.silent = silent
262 262 self.shell_futures = shell_futures
263 263 self.cell_id = cell_id
264 264
265 265 def __repr__(self):
266 266 name = self.__class__.__qualname__
267 267 raw_cell = (
268 268 (self.raw_cell[:50] + "..") if len(self.raw_cell) > 50 else self.raw_cell
269 269 )
270 270 return (
271 271 '<%s object at %x, raw_cell="%s" store_history=%s silent=%s shell_futures=%s cell_id=%s>'
272 272 % (
273 273 name,
274 274 id(self),
275 275 raw_cell,
276 276 self.store_history,
277 277 self.silent,
278 278 self.shell_futures,
279 279 self.cell_id,
280 280 )
281 281 )
282 282
283 283
284 284 class ExecutionResult:
285 285 """The result of a call to :meth:`InteractiveShell.run_cell`
286 286
287 287 Stores information about what took place.
288 288 """
289 289
290 290 execution_count: Optional[int] = None
291 291 error_before_exec: Optional[bool] = None
292 292 error_in_exec: Optional[BaseException] = None
293 293 info = None
294 294 result = None
295 295
296 296 def __init__(self, info):
297 297 self.info = info
298 298
299 299 @property
300 300 def success(self):
301 301 return (self.error_before_exec is None) and (self.error_in_exec is None)
302 302
303 303 def raise_error(self):
304 304 """Reraises error if `success` is `False`, otherwise does nothing"""
305 305 if self.error_before_exec is not None:
306 306 raise self.error_before_exec
307 307 if self.error_in_exec is not None:
308 308 raise self.error_in_exec
309 309
310 310 def __repr__(self):
311 311 name = self.__class__.__qualname__
312 312 return '<%s object at %x, execution_count=%s error_before_exec=%s error_in_exec=%s info=%s result=%s>' %\
313 313 (name, id(self), self.execution_count, self.error_before_exec, self.error_in_exec, repr(self.info), repr(self.result))
314 314
315 315 @functools.wraps(io_open)
316 316 def _modified_open(file, *args, **kwargs):
317 317 if file in {0, 1, 2}:
318 318 raise ValueError(
319 319 f"IPython won't let you open fd={file} by default "
320 320 "as it is likely to crash IPython. If you know what you are doing, "
321 321 "you can use builtins' open."
322 322 )
323 323
324 324 return io_open(file, *args, **kwargs)
325 325
326 326 class InteractiveShell(SingletonConfigurable):
327 327 """An enhanced, interactive shell for Python."""
328 328
329 329 _instance = None
330 330
331 331 ast_transformers: List[ast.NodeTransformer] = List(
332 332 [],
333 333 help="""
334 334 A list of ast.NodeTransformer subclass instances, which will be applied
335 335 to user input before code is run.
336 336 """,
337 337 ).tag(config=True)
338 338
339 339 autocall = Enum((0,1,2), default_value=0, help=
340 340 """
341 341 Make IPython automatically call any callable object even if you didn't
342 342 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
343 343 automatically. The value can be '0' to disable the feature, '1' for
344 344 'smart' autocall, where it is not applied if there are no more
345 345 arguments on the line, and '2' for 'full' autocall, where all callable
346 346 objects are automatically called (even if no arguments are present).
347 347 """
348 348 ).tag(config=True)
349 349
350 350 autoindent = Bool(True, help=
351 351 """
352 352 Autoindent IPython code entered interactively.
353 353 """
354 354 ).tag(config=True)
355 355
356 356 autoawait = Bool(True, help=
357 357 """
358 358 Automatically run await statement in the top level repl.
359 359 """
360 360 ).tag(config=True)
361 361
362 362 loop_runner_map ={
363 363 'asyncio':(_asyncio_runner, True),
364 364 'curio':(_curio_runner, True),
365 365 'trio':(_trio_runner, True),
366 366 'sync': (_pseudo_sync_runner, False)
367 367 }
368 368
369 369 loop_runner = Any(default_value="IPython.core.interactiveshell._asyncio_runner",
370 370 allow_none=True,
371 371 help="""Select the loop runner that will be used to execute top-level asynchronous code"""
372 372 ).tag(config=True)
373 373
374 374 @default('loop_runner')
375 375 def _default_loop_runner(self):
376 376 return import_item("IPython.core.interactiveshell._asyncio_runner")
377 377
378 378 @validate('loop_runner')
379 379 def _import_runner(self, proposal):
380 380 if isinstance(proposal.value, str):
381 381 if proposal.value in self.loop_runner_map:
382 382 runner, autoawait = self.loop_runner_map[proposal.value]
383 383 self.autoawait = autoawait
384 384 return runner
385 385 runner = import_item(proposal.value)
386 386 if not callable(runner):
387 387 raise ValueError('loop_runner must be callable')
388 388 return runner
389 389 if not callable(proposal.value):
390 390 raise ValueError('loop_runner must be callable')
391 391 return proposal.value
392 392
393 393 automagic = Bool(True, help=
394 394 """
395 395 Enable magic commands to be called without the leading %.
396 396 """
397 397 ).tag(config=True)
398 398
399 399 banner1 = Unicode(default_banner,
400 400 help="""The part of the banner to be printed before the profile"""
401 401 ).tag(config=True)
402 402 banner2 = Unicode('',
403 403 help="""The part of the banner to be printed after the profile"""
404 404 ).tag(config=True)
405 405
406 406 cache_size = Integer(1000, help=
407 407 """
408 408 Set the size of the output cache. The default is 1000, you can
409 409 change it permanently in your config file. Setting it to 0 completely
410 410 disables the caching system, and the minimum value accepted is 3 (if
411 411 you provide a value less than 3, it is reset to 0 and a warning is
412 412 issued). This limit is defined because otherwise you'll spend more
413 413 time re-flushing a too small cache than working
414 414 """
415 415 ).tag(config=True)
416 416 color_info = Bool(True, help=
417 417 """
418 418 Use colors for displaying information about objects. Because this
419 419 information is passed through a pager (like 'less'), and some pagers
420 420 get confused with color codes, this capability can be turned off.
421 421 """
422 422 ).tag(config=True)
423 423 colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'),
424 424 default_value='Neutral',
425 425 help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)."
426 426 ).tag(config=True)
427 427 debug = Bool(False).tag(config=True)
428 428 disable_failing_post_execute = Bool(False,
429 429 help="Don't call post-execute functions that have failed in the past."
430 430 ).tag(config=True)
431 431 display_formatter = Instance(DisplayFormatter, allow_none=True)
432 432 displayhook_class = Type(DisplayHook)
433 433 display_pub_class = Type(DisplayPublisher)
434 434 compiler_class = Type(CachingCompiler)
435 435 inspector_class = Type(
436 436 oinspect.Inspector, help="Class to use to instantiate the shell inspector"
437 437 ).tag(config=True)
438 438
439 439 sphinxify_docstring = Bool(False, help=
440 440 """
441 441 Enables rich html representation of docstrings. (This requires the
442 442 docrepr module).
443 443 """).tag(config=True)
444 444
445 445 @observe("sphinxify_docstring")
446 446 def _sphinxify_docstring_changed(self, change):
447 447 if change['new']:
448 448 warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning)
449 449
450 450 enable_html_pager = Bool(False, help=
451 451 """
452 452 (Provisional API) enables html representation in mime bundles sent
453 453 to pagers.
454 454 """).tag(config=True)
455 455
456 456 @observe("enable_html_pager")
457 457 def _enable_html_pager_changed(self, change):
458 458 if change['new']:
459 459 warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning)
460 460
461 461 data_pub_class = None
462 462
463 463 exit_now = Bool(False)
464 464 exiter = Instance(ExitAutocall)
465 465 @default('exiter')
466 466 def _exiter_default(self):
467 467 return ExitAutocall(self)
468 468 # Monotonically increasing execution counter
469 469 execution_count = Integer(1)
470 470 filename = Unicode("<ipython console>")
471 471 ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__
472 472
473 473 # Used to transform cells before running them, and check whether code is complete
474 474 input_transformer_manager = Instance('IPython.core.inputtransformer2.TransformerManager',
475 475 ())
476 476
477 477 @property
478 478 def input_transformers_cleanup(self):
479 479 return self.input_transformer_manager.cleanup_transforms
480 480
481 481 input_transformers_post: List = List(
482 482 [],
483 483 help="A list of string input transformers, to be applied after IPython's "
484 484 "own input transformations."
485 485 )
486 486
487 487 @property
488 488 def input_splitter(self):
489 489 """Make this available for backward compatibility (pre-7.0 release) with existing code.
490 490
491 491 For example, ipykernel ipykernel currently uses
492 492 `shell.input_splitter.check_complete`
493 493 """
494 494 from warnings import warn
495 495 warn("`input_splitter` is deprecated since IPython 7.0, prefer `input_transformer_manager`.",
496 496 DeprecationWarning, stacklevel=2
497 497 )
498 498 return self.input_transformer_manager
499 499
500 500 logstart = Bool(False, help=
501 501 """
502 502 Start logging to the default log file in overwrite mode.
503 503 Use `logappend` to specify a log file to **append** logs to.
504 504 """
505 505 ).tag(config=True)
506 506 logfile = Unicode('', help=
507 507 """
508 508 The name of the logfile to use.
509 509 """
510 510 ).tag(config=True)
511 511 logappend = Unicode('', help=
512 512 """
513 513 Start logging to the given file in append mode.
514 514 Use `logfile` to specify a log file to **overwrite** logs to.
515 515 """
516 516 ).tag(config=True)
517 517 object_info_string_level = Enum((0,1,2), default_value=0,
518 518 ).tag(config=True)
519 519 pdb = Bool(False, help=
520 520 """
521 521 Automatically call the pdb debugger after every exception.
522 522 """
523 523 ).tag(config=True)
524 524 display_page = Bool(False,
525 525 help="""If True, anything that would be passed to the pager
526 526 will be displayed as regular output instead."""
527 527 ).tag(config=True)
528 528
529 529
530 530 show_rewritten_input = Bool(True,
531 531 help="Show rewritten input, e.g. for autocall."
532 532 ).tag(config=True)
533 533
534 534 quiet = Bool(False).tag(config=True)
535 535
536 536 history_length = Integer(10000,
537 537 help='Total length of command history'
538 538 ).tag(config=True)
539 539
540 540 history_load_length = Integer(1000, help=
541 541 """
542 542 The number of saved history entries to be loaded
543 543 into the history buffer at startup.
544 544 """
545 545 ).tag(config=True)
546 546
547 547 ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'],
548 548 default_value='last_expr',
549 549 help="""
550 550 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying
551 551 which nodes should be run interactively (displaying output from expressions).
552 552 """
553 553 ).tag(config=True)
554 554
555 555 warn_venv = Bool(
556 556 True,
557 557 help="Warn if running in a virtual environment with no IPython installed (so IPython from the global environment is used).",
558 558 ).tag(config=True)
559 559
560 560 # TODO: this part of prompt management should be moved to the frontends.
561 561 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
562 562 separate_in = SeparateUnicode('\n').tag(config=True)
563 563 separate_out = SeparateUnicode('').tag(config=True)
564 564 separate_out2 = SeparateUnicode('').tag(config=True)
565 565 wildcards_case_sensitive = Bool(True).tag(config=True)
566 566 xmode = CaselessStrEnum(('Context', 'Plain', 'Verbose', 'Minimal'),
567 567 default_value='Context',
568 568 help="Switch modes for the IPython exception handlers."
569 569 ).tag(config=True)
570 570
571 571 # Subcomponents of InteractiveShell
572 572 alias_manager = Instance("IPython.core.alias.AliasManager", allow_none=True)
573 573 prefilter_manager = Instance(
574 574 "IPython.core.prefilter.PrefilterManager", allow_none=True
575 575 )
576 576 builtin_trap = Instance("IPython.core.builtin_trap.BuiltinTrap")
577 577 display_trap = Instance("IPython.core.display_trap.DisplayTrap")
578 578 extension_manager = Instance(
579 579 "IPython.core.extensions.ExtensionManager", allow_none=True
580 580 )
581 581 payload_manager = Instance("IPython.core.payload.PayloadManager", allow_none=True)
582 582 history_manager = Instance(
583 583 "IPython.core.history.HistoryAccessorBase", allow_none=True
584 584 )
585 585 magics_manager = Instance("IPython.core.magic.MagicsManager")
586 586
587 587 profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True)
588 588 @property
589 589 def profile(self):
590 590 if self.profile_dir is not None:
591 591 name = os.path.basename(self.profile_dir.location)
592 592 return name.replace('profile_','')
593 593
594 594
595 595 # Private interface
596 596 _post_execute = Dict()
597 597
598 598 # Tracks any GUI loop loaded for pylab
599 599 pylab_gui_select = None
600 600
601 601 last_execution_succeeded = Bool(True, help='Did last executed command succeeded')
602 602
603 603 last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True)
604 604
605 605 def __init__(self, ipython_dir=None, profile_dir=None,
606 606 user_module=None, user_ns=None,
607 607 custom_exceptions=((), None), **kwargs):
608 608 # This is where traits with a config_key argument are updated
609 609 # from the values on config.
610 610 super(InteractiveShell, self).__init__(**kwargs)
611 611 if 'PromptManager' in self.config:
612 612 warn('As of IPython 5.0 `PromptManager` config will have no effect'
613 613 ' and has been replaced by TerminalInteractiveShell.prompts_class')
614 614 self.configurables = [self]
615 615
616 616 # These are relatively independent and stateless
617 617 self.init_ipython_dir(ipython_dir)
618 618 self.init_profile_dir(profile_dir)
619 619 self.init_instance_attrs()
620 620 self.init_environment()
621 621
622 622 # Check if we're in a virtualenv, and set up sys.path.
623 623 self.init_virtualenv()
624 624
625 625 # Create namespaces (user_ns, user_global_ns, etc.)
626 626 self.init_create_namespaces(user_module, user_ns)
627 627 # This has to be done after init_create_namespaces because it uses
628 628 # something in self.user_ns, but before init_sys_modules, which
629 629 # is the first thing to modify sys.
630 630 # TODO: When we override sys.stdout and sys.stderr before this class
631 631 # is created, we are saving the overridden ones here. Not sure if this
632 632 # is what we want to do.
633 633 self.save_sys_module_state()
634 634 self.init_sys_modules()
635 635
636 636 # While we're trying to have each part of the code directly access what
637 637 # it needs without keeping redundant references to objects, we have too
638 638 # much legacy code that expects ip.db to exist.
639 639 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
640 640
641 641 self.init_history()
642 642 self.init_encoding()
643 643 self.init_prefilter()
644 644
645 645 self.init_syntax_highlighting()
646 646 self.init_hooks()
647 647 self.init_events()
648 648 self.init_pushd_popd_magic()
649 649 self.init_user_ns()
650 650 self.init_logger()
651 651 self.init_builtins()
652 652
653 653 # The following was in post_config_initialization
654 654 self.init_inspector()
655 655 self.raw_input_original = input
656 656 self.init_completer()
657 657 # TODO: init_io() needs to happen before init_traceback handlers
658 658 # because the traceback handlers hardcode the stdout/stderr streams.
659 659 # This logic in in debugger.Pdb and should eventually be changed.
660 660 self.init_io()
661 661 self.init_traceback_handlers(custom_exceptions)
662 662 self.init_prompts()
663 663 self.init_display_formatter()
664 664 self.init_display_pub()
665 665 self.init_data_pub()
666 666 self.init_displayhook()
667 667 self.init_magics()
668 668 self.init_alias()
669 669 self.init_logstart()
670 670 self.init_pdb()
671 671 self.init_extension_manager()
672 672 self.init_payload()
673 673 self.events.trigger('shell_initialized', self)
674 674 atexit.register(self.atexit_operations)
675 675
676 676 # The trio runner is used for running Trio in the foreground thread. It
677 677 # is different from `_trio_runner(async_fn)` in `async_helpers.py`
678 678 # which calls `trio.run()` for every cell. This runner runs all cells
679 679 # inside a single Trio event loop. If used, it is set from
680 680 # `ipykernel.kernelapp`.
681 681 self.trio_runner = None
682 682
683 683 def get_ipython(self):
684 684 """Return the currently running IPython instance."""
685 685 return self
686 686
687 687 #-------------------------------------------------------------------------
688 688 # Trait changed handlers
689 689 #-------------------------------------------------------------------------
690 690 @observe('ipython_dir')
691 691 def _ipython_dir_changed(self, change):
692 692 ensure_dir_exists(change['new'])
693 693
694 694 def set_autoindent(self,value=None):
695 695 """Set the autoindent flag.
696 696
697 697 If called with no arguments, it acts as a toggle."""
698 698 if value is None:
699 699 self.autoindent = not self.autoindent
700 700 else:
701 701 self.autoindent = value
702 702
703 703 def set_trio_runner(self, tr):
704 704 self.trio_runner = tr
705 705
706 706 #-------------------------------------------------------------------------
707 707 # init_* methods called by __init__
708 708 #-------------------------------------------------------------------------
709 709
710 710 def init_ipython_dir(self, ipython_dir):
711 711 if ipython_dir is not None:
712 712 self.ipython_dir = ipython_dir
713 713 return
714 714
715 715 self.ipython_dir = get_ipython_dir()
716 716
717 717 def init_profile_dir(self, profile_dir):
718 718 if profile_dir is not None:
719 719 self.profile_dir = profile_dir
720 720 return
721 721 self.profile_dir = ProfileDir.create_profile_dir_by_name(
722 722 self.ipython_dir, "default"
723 723 )
724 724
725 725 def init_instance_attrs(self):
726 726 self.more = False
727 727
728 728 # command compiler
729 729 self.compile = self.compiler_class()
730 730
731 731 # Make an empty namespace, which extension writers can rely on both
732 732 # existing and NEVER being used by ipython itself. This gives them a
733 733 # convenient location for storing additional information and state
734 734 # their extensions may require, without fear of collisions with other
735 735 # ipython names that may develop later.
736 736 self.meta = Struct()
737 737
738 738 # Temporary files used for various purposes. Deleted at exit.
739 739 # The files here are stored with Path from Pathlib
740 740 self.tempfiles = []
741 741 self.tempdirs = []
742 742
743 743 # keep track of where we started running (mainly for crash post-mortem)
744 744 # This is not being used anywhere currently.
745 745 self.starting_dir = os.getcwd()
746 746
747 747 # Indentation management
748 748 self.indent_current_nsp = 0
749 749
750 750 # Dict to track post-execution functions that have been registered
751 751 self._post_execute = {}
752 752
753 753 def init_environment(self):
754 754 """Any changes we need to make to the user's environment."""
755 755 pass
756 756
757 757 def init_encoding(self):
758 758 # Get system encoding at startup time. Certain terminals (like Emacs
759 759 # under Win32 have it set to None, and we need to have a known valid
760 760 # encoding to use in the raw_input() method
761 761 try:
762 762 self.stdin_encoding = sys.stdin.encoding or 'ascii'
763 763 except AttributeError:
764 764 self.stdin_encoding = 'ascii'
765 765
766 766
767 767 @observe('colors')
768 768 def init_syntax_highlighting(self, changes=None):
769 769 # Python source parser/formatter for syntax highlighting
770 770 pyformat = PyColorize.Parser(style=self.colors, parent=self).format
771 771 self.pycolorize = lambda src: pyformat(src,'str')
772 772
773 773 def refresh_style(self):
774 774 # No-op here, used in subclass
775 775 pass
776 776
777 777 def init_pushd_popd_magic(self):
778 778 # for pushd/popd management
779 779 self.home_dir = get_home_dir()
780 780
781 781 self.dir_stack = []
782 782
783 783 def init_logger(self):
784 784 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
785 785 logmode='rotate')
786 786
787 787 def init_logstart(self):
788 788 """Initialize logging in case it was requested at the command line.
789 789 """
790 790 if self.logappend:
791 791 self.magic('logstart %s append' % self.logappend)
792 792 elif self.logfile:
793 793 self.magic('logstart %s' % self.logfile)
794 794 elif self.logstart:
795 795 self.magic('logstart')
796 796
797 797
798 798 def init_builtins(self):
799 799 # A single, static flag that we set to True. Its presence indicates
800 800 # that an IPython shell has been created, and we make no attempts at
801 801 # removing on exit or representing the existence of more than one
802 802 # IPython at a time.
803 803 builtin_mod.__dict__['__IPYTHON__'] = True
804 804 builtin_mod.__dict__['display'] = display
805 805
806 806 self.builtin_trap = BuiltinTrap(shell=self)
807 807
808 808 @observe('colors')
809 809 def init_inspector(self, changes=None):
810 810 # Object inspector
811 811 self.inspector = self.inspector_class(
812 812 oinspect.InspectColors,
813 813 PyColorize.ANSICodeColors,
814 814 self.colors,
815 815 self.object_info_string_level,
816 816 )
817 817
818 818 def init_io(self):
819 819 # implemented in subclasses, TerminalInteractiveShell does call
820 820 # colorama.init().
821 821 pass
822 822
823 823 def init_prompts(self):
824 824 # Set system prompts, so that scripts can decide if they are running
825 825 # interactively.
826 826 sys.ps1 = 'In : '
827 827 sys.ps2 = '...: '
828 828 sys.ps3 = 'Out: '
829 829
830 830 def init_display_formatter(self):
831 831 self.display_formatter = DisplayFormatter(parent=self)
832 832 self.configurables.append(self.display_formatter)
833 833
834 834 def init_display_pub(self):
835 835 self.display_pub = self.display_pub_class(parent=self, shell=self)
836 836 self.configurables.append(self.display_pub)
837 837
838 838 def init_data_pub(self):
839 839 if not self.data_pub_class:
840 840 self.data_pub = None
841 841 return
842 842 self.data_pub = self.data_pub_class(parent=self)
843 843 self.configurables.append(self.data_pub)
844 844
845 845 def init_displayhook(self):
846 846 # Initialize displayhook, set in/out prompts and printing system
847 847 self.displayhook = self.displayhook_class(
848 848 parent=self,
849 849 shell=self,
850 850 cache_size=self.cache_size,
851 851 )
852 852 self.configurables.append(self.displayhook)
853 853 # This is a context manager that installs/revmoes the displayhook at
854 854 # the appropriate time.
855 855 self.display_trap = DisplayTrap(hook=self.displayhook)
856 856
857 857 @staticmethod
858 858 def get_path_links(p: Path):
859 859 """Gets path links including all symlinks
860 860
861 861 Examples
862 862 --------
863 863 In [1]: from IPython.core.interactiveshell import InteractiveShell
864 864
865 865 In [2]: import sys, pathlib
866 866
867 867 In [3]: paths = InteractiveShell.get_path_links(pathlib.Path(sys.executable))
868 868
869 869 In [4]: len(paths) == len(set(paths))
870 870 Out[4]: True
871 871
872 872 In [5]: bool(paths)
873 873 Out[5]: True
874 874 """
875 875 paths = [p]
876 876 while p.is_symlink():
877 877 new_path = Path(os.readlink(p))
878 878 if not new_path.is_absolute():
879 879 new_path = p.parent / new_path
880 880 p = new_path
881 881 paths.append(p)
882 882 return paths
883 883
884 884 def init_virtualenv(self):
885 885 """Add the current virtualenv to sys.path so the user can import modules from it.
886 886 This isn't perfect: it doesn't use the Python interpreter with which the
887 887 virtualenv was built, and it ignores the --no-site-packages option. A
888 888 warning will appear suggesting the user installs IPython in the
889 889 virtualenv, but for many cases, it probably works well enough.
890 890
891 891 Adapted from code snippets online.
892 892
893 893 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
894 894 """
895 895 if 'VIRTUAL_ENV' not in os.environ:
896 896 # Not in a virtualenv
897 897 return
898 898 elif os.environ["VIRTUAL_ENV"] == "":
899 899 warn("Virtual env path set to '', please check if this is intended.")
900 900 return
901 901
902 902 p = Path(sys.executable)
903 903 p_venv = Path(os.environ["VIRTUAL_ENV"])
904 904
905 905 # fallback venv detection:
906 906 # stdlib venv may symlink sys.executable, so we can't use realpath.
907 907 # but others can symlink *to* the venv Python, so we can't just use sys.executable.
908 908 # So we just check every item in the symlink tree (generally <= 3)
909 909 paths = self.get_path_links(p)
910 910
911 911 # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible
912 912 if p_venv.parts[1] == "cygdrive":
913 913 drive_name = p_venv.parts[2]
914 914 p_venv = (drive_name + ":/") / Path(*p_venv.parts[3:])
915 915
916 916 if any(p_venv == p.parents[1] for p in paths):
917 917 # Our exe is inside or has access to the virtualenv, don't need to do anything.
918 918 return
919 919
920 920 if sys.platform == "win32":
921 921 virtual_env = str(Path(os.environ["VIRTUAL_ENV"], "Lib", "site-packages"))
922 922 else:
923 923 virtual_env_path = Path(
924 924 os.environ["VIRTUAL_ENV"], "lib", "python{}.{}", "site-packages"
925 925 )
926 926 p_ver = sys.version_info[:2]
927 927
928 928 # Predict version from py[thon]-x.x in the $VIRTUAL_ENV
929 929 re_m = re.search(r"\bpy(?:thon)?([23])\.(\d+)\b", os.environ["VIRTUAL_ENV"])
930 930 if re_m:
931 931 predicted_path = Path(str(virtual_env_path).format(*re_m.groups()))
932 932 if predicted_path.exists():
933 933 p_ver = re_m.groups()
934 934
935 935 virtual_env = str(virtual_env_path).format(*p_ver)
936 936 if self.warn_venv:
937 937 warn(
938 938 "Attempting to work in a virtualenv. If you encounter problems, "
939 939 "please install IPython inside the virtualenv."
940 940 )
941 941 import site
942 942 sys.path.insert(0, virtual_env)
943 943 site.addsitedir(virtual_env)
944 944
945 945 #-------------------------------------------------------------------------
946 946 # Things related to injections into the sys module
947 947 #-------------------------------------------------------------------------
948 948
949 949 def save_sys_module_state(self):
950 950 """Save the state of hooks in the sys module.
951 951
952 952 This has to be called after self.user_module is created.
953 953 """
954 954 self._orig_sys_module_state = {'stdin': sys.stdin,
955 955 'stdout': sys.stdout,
956 956 'stderr': sys.stderr,
957 957 'excepthook': sys.excepthook}
958 958 self._orig_sys_modules_main_name = self.user_module.__name__
959 959 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
960 960
961 961 def restore_sys_module_state(self):
962 962 """Restore the state of the sys module."""
963 963 try:
964 964 for k, v in self._orig_sys_module_state.items():
965 965 setattr(sys, k, v)
966 966 except AttributeError:
967 967 pass
968 968 # Reset what what done in self.init_sys_modules
969 969 if self._orig_sys_modules_main_mod is not None:
970 970 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
971 971
972 972 #-------------------------------------------------------------------------
973 973 # Things related to the banner
974 974 #-------------------------------------------------------------------------
975 975
976 976 @property
977 977 def banner(self):
978 978 banner = self.banner1
979 979 if self.profile and self.profile != 'default':
980 980 banner += '\nIPython profile: %s\n' % self.profile
981 981 if self.banner2:
982 982 banner += '\n' + self.banner2
983 983 return banner
984 984
985 985 def show_banner(self, banner=None):
986 986 if banner is None:
987 987 banner = self.banner
988 988 sys.stdout.write(banner)
989 989
990 990 #-------------------------------------------------------------------------
991 991 # Things related to hooks
992 992 #-------------------------------------------------------------------------
993 993
994 994 def init_hooks(self):
995 995 # hooks holds pointers used for user-side customizations
996 996 self.hooks = Struct()
997 997
998 998 self.strdispatchers = {}
999 999
1000 1000 # Set all default hooks, defined in the IPython.hooks module.
1001 1001 hooks = IPython.core.hooks
1002 1002 for hook_name in hooks.__all__:
1003 1003 # default hooks have priority 100, i.e. low; user hooks should have
1004 1004 # 0-100 priority
1005 1005 self.set_hook(hook_name, getattr(hooks, hook_name), 100)
1006 1006
1007 1007 if self.display_page:
1008 1008 self.set_hook('show_in_pager', page.as_hook(page.display_page), 90)
1009 1009
1010 1010 def set_hook(self, name, hook, priority=50, str_key=None, re_key=None):
1011 1011 """set_hook(name,hook) -> sets an internal IPython hook.
1012 1012
1013 1013 IPython exposes some of its internal API as user-modifiable hooks. By
1014 1014 adding your function to one of these hooks, you can modify IPython's
1015 1015 behavior to call at runtime your own routines."""
1016 1016
1017 1017 # At some point in the future, this should validate the hook before it
1018 1018 # accepts it. Probably at least check that the hook takes the number
1019 1019 # of args it's supposed to.
1020 1020
1021 1021 f = types.MethodType(hook,self)
1022 1022
1023 1023 # check if the hook is for strdispatcher first
1024 1024 if str_key is not None:
1025 1025 sdp = self.strdispatchers.get(name, StrDispatch())
1026 1026 sdp.add_s(str_key, f, priority )
1027 1027 self.strdispatchers[name] = sdp
1028 1028 return
1029 1029 if re_key is not None:
1030 1030 sdp = self.strdispatchers.get(name, StrDispatch())
1031 1031 sdp.add_re(re.compile(re_key), f, priority )
1032 1032 self.strdispatchers[name] = sdp
1033 1033 return
1034 1034
1035 1035 dp = getattr(self.hooks, name, None)
1036 1036 if name not in IPython.core.hooks.__all__:
1037 1037 print("Warning! Hook '%s' is not one of %s" % \
1038 1038 (name, IPython.core.hooks.__all__ ))
1039 1039
1040 1040 if name in IPython.core.hooks.deprecated:
1041 1041 alternative = IPython.core.hooks.deprecated[name]
1042 1042 raise ValueError(
1043 1043 "Hook {} has been deprecated since IPython 5.0. Use {} instead.".format(
1044 1044 name, alternative
1045 1045 )
1046 1046 )
1047 1047
1048 1048 if not dp:
1049 1049 dp = IPython.core.hooks.CommandChainDispatcher()
1050 1050
1051 1051 try:
1052 1052 dp.add(f,priority)
1053 1053 except AttributeError:
1054 1054 # it was not commandchain, plain old func - replace
1055 1055 dp = f
1056 1056
1057 1057 setattr(self.hooks,name, dp)
1058 1058
1059 1059 #-------------------------------------------------------------------------
1060 1060 # Things related to events
1061 1061 #-------------------------------------------------------------------------
1062 1062
1063 1063 def init_events(self):
1064 1064 self.events = EventManager(self, available_events)
1065 1065
1066 1066 self.events.register("pre_execute", self._clear_warning_registry)
1067 1067
1068 1068 def register_post_execute(self, func):
1069 1069 """DEPRECATED: Use ip.events.register('post_run_cell', func)
1070 1070
1071 1071 Register a function for calling after code execution.
1072 1072 """
1073 1073 raise ValueError(
1074 1074 "ip.register_post_execute is deprecated since IPython 1.0, use "
1075 1075 "ip.events.register('post_run_cell', func) instead."
1076 1076 )
1077 1077
1078 1078 def _clear_warning_registry(self):
1079 1079 # clear the warning registry, so that different code blocks with
1080 1080 # overlapping line number ranges don't cause spurious suppression of
1081 1081 # warnings (see gh-6611 for details)
1082 1082 if "__warningregistry__" in self.user_global_ns:
1083 1083 del self.user_global_ns["__warningregistry__"]
1084 1084
1085 1085 #-------------------------------------------------------------------------
1086 1086 # Things related to the "main" module
1087 1087 #-------------------------------------------------------------------------
1088 1088
1089 1089 def new_main_mod(self, filename, modname):
1090 1090 """Return a new 'main' module object for user code execution.
1091 1091
1092 1092 ``filename`` should be the path of the script which will be run in the
1093 1093 module. Requests with the same filename will get the same module, with
1094 1094 its namespace cleared.
1095 1095
1096 1096 ``modname`` should be the module name - normally either '__main__' or
1097 1097 the basename of the file without the extension.
1098 1098
1099 1099 When scripts are executed via %run, we must keep a reference to their
1100 1100 __main__ module around so that Python doesn't
1101 1101 clear it, rendering references to module globals useless.
1102 1102
1103 1103 This method keeps said reference in a private dict, keyed by the
1104 1104 absolute path of the script. This way, for multiple executions of the
1105 1105 same script we only keep one copy of the namespace (the last one),
1106 1106 thus preventing memory leaks from old references while allowing the
1107 1107 objects from the last execution to be accessible.
1108 1108 """
1109 1109 filename = os.path.abspath(filename)
1110 1110 try:
1111 1111 main_mod = self._main_mod_cache[filename]
1112 1112 except KeyError:
1113 1113 main_mod = self._main_mod_cache[filename] = types.ModuleType(
1114 1114 modname,
1115 1115 doc="Module created for script run in IPython")
1116 1116 else:
1117 1117 main_mod.__dict__.clear()
1118 1118 main_mod.__name__ = modname
1119 1119
1120 1120 main_mod.__file__ = filename
1121 1121 # It seems pydoc (and perhaps others) needs any module instance to
1122 1122 # implement a __nonzero__ method
1123 1123 main_mod.__nonzero__ = lambda : True
1124 1124
1125 1125 return main_mod
1126 1126
1127 1127 def clear_main_mod_cache(self):
1128 1128 """Clear the cache of main modules.
1129 1129
1130 1130 Mainly for use by utilities like %reset.
1131 1131
1132 1132 Examples
1133 1133 --------
1134 1134 In [15]: import IPython
1135 1135
1136 1136 In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython')
1137 1137
1138 1138 In [17]: len(_ip._main_mod_cache) > 0
1139 1139 Out[17]: True
1140 1140
1141 1141 In [18]: _ip.clear_main_mod_cache()
1142 1142
1143 1143 In [19]: len(_ip._main_mod_cache) == 0
1144 1144 Out[19]: True
1145 1145 """
1146 1146 self._main_mod_cache.clear()
1147 1147
1148 1148 #-------------------------------------------------------------------------
1149 1149 # Things related to debugging
1150 1150 #-------------------------------------------------------------------------
1151 1151
1152 1152 def init_pdb(self):
1153 1153 # Set calling of pdb on exceptions
1154 1154 # self.call_pdb is a property
1155 1155 self.call_pdb = self.pdb
1156 1156
1157 1157 def _get_call_pdb(self):
1158 1158 return self._call_pdb
1159 1159
1160 1160 def _set_call_pdb(self,val):
1161 1161
1162 1162 if val not in (0,1,False,True):
1163 1163 raise ValueError('new call_pdb value must be boolean')
1164 1164
1165 1165 # store value in instance
1166 1166 self._call_pdb = val
1167 1167
1168 1168 # notify the actual exception handlers
1169 1169 self.InteractiveTB.call_pdb = val
1170 1170
1171 1171 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
1172 1172 'Control auto-activation of pdb at exceptions')
1173 1173
1174 1174 def debugger(self,force=False):
1175 1175 """Call the pdb debugger.
1176 1176
1177 1177 Keywords:
1178 1178
1179 1179 - force(False): by default, this routine checks the instance call_pdb
1180 1180 flag and does not actually invoke the debugger if the flag is false.
1181 1181 The 'force' option forces the debugger to activate even if the flag
1182 1182 is false.
1183 1183 """
1184 1184
1185 1185 if not (force or self.call_pdb):
1186 1186 return
1187 1187
1188 1188 if not hasattr(sys,'last_traceback'):
1189 1189 error('No traceback has been produced, nothing to debug.')
1190 1190 return
1191 1191
1192 1192 self.InteractiveTB.debugger(force=True)
1193 1193
1194 1194 #-------------------------------------------------------------------------
1195 1195 # Things related to IPython's various namespaces
1196 1196 #-------------------------------------------------------------------------
1197 1197 default_user_namespaces = True
1198 1198
1199 1199 def init_create_namespaces(self, user_module=None, user_ns=None):
1200 1200 # Create the namespace where the user will operate. user_ns is
1201 1201 # normally the only one used, and it is passed to the exec calls as
1202 1202 # the locals argument. But we do carry a user_global_ns namespace
1203 1203 # given as the exec 'globals' argument, This is useful in embedding
1204 1204 # situations where the ipython shell opens in a context where the
1205 1205 # distinction between locals and globals is meaningful. For
1206 1206 # non-embedded contexts, it is just the same object as the user_ns dict.
1207 1207
1208 1208 # FIXME. For some strange reason, __builtins__ is showing up at user
1209 1209 # level as a dict instead of a module. This is a manual fix, but I
1210 1210 # should really track down where the problem is coming from. Alex
1211 1211 # Schmolck reported this problem first.
1212 1212
1213 1213 # A useful post by Alex Martelli on this topic:
1214 1214 # Re: inconsistent value from __builtins__
1215 1215 # Von: Alex Martelli <aleaxit@yahoo.com>
1216 1216 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
1217 1217 # Gruppen: comp.lang.python
1218 1218
1219 1219 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
1220 1220 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
1221 1221 # > <type 'dict'>
1222 1222 # > >>> print type(__builtins__)
1223 1223 # > <type 'module'>
1224 1224 # > Is this difference in return value intentional?
1225 1225
1226 1226 # Well, it's documented that '__builtins__' can be either a dictionary
1227 1227 # or a module, and it's been that way for a long time. Whether it's
1228 1228 # intentional (or sensible), I don't know. In any case, the idea is
1229 1229 # that if you need to access the built-in namespace directly, you
1230 1230 # should start with "import __builtin__" (note, no 's') which will
1231 1231 # definitely give you a module. Yeah, it's somewhat confusing:-(.
1232 1232
1233 1233 # These routines return a properly built module and dict as needed by
1234 1234 # the rest of the code, and can also be used by extension writers to
1235 1235 # generate properly initialized namespaces.
1236 1236 if (user_ns is not None) or (user_module is not None):
1237 1237 self.default_user_namespaces = False
1238 1238 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
1239 1239
1240 1240 # A record of hidden variables we have added to the user namespace, so
1241 1241 # we can list later only variables defined in actual interactive use.
1242 1242 self.user_ns_hidden = {}
1243 1243
1244 1244 # Now that FakeModule produces a real module, we've run into a nasty
1245 1245 # problem: after script execution (via %run), the module where the user
1246 1246 # code ran is deleted. Now that this object is a true module (needed
1247 1247 # so doctest and other tools work correctly), the Python module
1248 1248 # teardown mechanism runs over it, and sets to None every variable
1249 1249 # present in that module. Top-level references to objects from the
1250 1250 # script survive, because the user_ns is updated with them. However,
1251 1251 # calling functions defined in the script that use other things from
1252 1252 # the script will fail, because the function's closure had references
1253 1253 # to the original objects, which are now all None. So we must protect
1254 1254 # these modules from deletion by keeping a cache.
1255 1255 #
1256 1256 # To avoid keeping stale modules around (we only need the one from the
1257 1257 # last run), we use a dict keyed with the full path to the script, so
1258 1258 # only the last version of the module is held in the cache. Note,
1259 1259 # however, that we must cache the module *namespace contents* (their
1260 1260 # __dict__). Because if we try to cache the actual modules, old ones
1261 1261 # (uncached) could be destroyed while still holding references (such as
1262 1262 # those held by GUI objects that tend to be long-lived)>
1263 1263 #
1264 1264 # The %reset command will flush this cache. See the cache_main_mod()
1265 1265 # and clear_main_mod_cache() methods for details on use.
1266 1266
1267 1267 # This is the cache used for 'main' namespaces
1268 1268 self._main_mod_cache = {}
1269 1269
1270 1270 # A table holding all the namespaces IPython deals with, so that
1271 1271 # introspection facilities can search easily.
1272 1272 self.ns_table = {'user_global':self.user_module.__dict__,
1273 1273 'user_local':self.user_ns,
1274 1274 'builtin':builtin_mod.__dict__
1275 1275 }
1276 1276
1277 1277 @property
1278 1278 def user_global_ns(self):
1279 1279 return self.user_module.__dict__
1280 1280
1281 1281 def prepare_user_module(self, user_module=None, user_ns=None):
1282 1282 """Prepare the module and namespace in which user code will be run.
1283 1283
1284 1284 When IPython is started normally, both parameters are None: a new module
1285 1285 is created automatically, and its __dict__ used as the namespace.
1286 1286
1287 1287 If only user_module is provided, its __dict__ is used as the namespace.
1288 1288 If only user_ns is provided, a dummy module is created, and user_ns
1289 1289 becomes the global namespace. If both are provided (as they may be
1290 1290 when embedding), user_ns is the local namespace, and user_module
1291 1291 provides the global namespace.
1292 1292
1293 1293 Parameters
1294 1294 ----------
1295 1295 user_module : module, optional
1296 1296 The current user module in which IPython is being run. If None,
1297 1297 a clean module will be created.
1298 1298 user_ns : dict, optional
1299 1299 A namespace in which to run interactive commands.
1300 1300
1301 1301 Returns
1302 1302 -------
1303 1303 A tuple of user_module and user_ns, each properly initialised.
1304 1304 """
1305 1305 if user_module is None and user_ns is not None:
1306 1306 user_ns.setdefault("__name__", "__main__")
1307 1307 user_module = DummyMod()
1308 1308 user_module.__dict__ = user_ns
1309 1309
1310 1310 if user_module is None:
1311 1311 user_module = types.ModuleType("__main__",
1312 1312 doc="Automatically created module for IPython interactive environment")
1313 1313
1314 1314 # We must ensure that __builtin__ (without the final 's') is always
1315 1315 # available and pointing to the __builtin__ *module*. For more details:
1316 1316 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1317 1317 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1318 1318 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1319 1319
1320 1320 if user_ns is None:
1321 1321 user_ns = user_module.__dict__
1322 1322
1323 1323 return user_module, user_ns
1324 1324
1325 1325 def init_sys_modules(self):
1326 1326 # We need to insert into sys.modules something that looks like a
1327 1327 # module but which accesses the IPython namespace, for shelve and
1328 1328 # pickle to work interactively. Normally they rely on getting
1329 1329 # everything out of __main__, but for embedding purposes each IPython
1330 1330 # instance has its own private namespace, so we can't go shoving
1331 1331 # everything into __main__.
1332 1332
1333 1333 # note, however, that we should only do this for non-embedded
1334 1334 # ipythons, which really mimic the __main__.__dict__ with their own
1335 1335 # namespace. Embedded instances, on the other hand, should not do
1336 1336 # this because they need to manage the user local/global namespaces
1337 1337 # only, but they live within a 'normal' __main__ (meaning, they
1338 1338 # shouldn't overtake the execution environment of the script they're
1339 1339 # embedded in).
1340 1340
1341 1341 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1342 1342 main_name = self.user_module.__name__
1343 1343 sys.modules[main_name] = self.user_module
1344 1344
1345 1345 def init_user_ns(self):
1346 1346 """Initialize all user-visible namespaces to their minimum defaults.
1347 1347
1348 1348 Certain history lists are also initialized here, as they effectively
1349 1349 act as user namespaces.
1350 1350
1351 1351 Notes
1352 1352 -----
1353 1353 All data structures here are only filled in, they are NOT reset by this
1354 1354 method. If they were not empty before, data will simply be added to
1355 1355 them.
1356 1356 """
1357 1357 # This function works in two parts: first we put a few things in
1358 1358 # user_ns, and we sync that contents into user_ns_hidden so that these
1359 1359 # initial variables aren't shown by %who. After the sync, we add the
1360 1360 # rest of what we *do* want the user to see with %who even on a new
1361 1361 # session (probably nothing, so they really only see their own stuff)
1362 1362
1363 1363 # The user dict must *always* have a __builtin__ reference to the
1364 1364 # Python standard __builtin__ namespace, which must be imported.
1365 1365 # This is so that certain operations in prompt evaluation can be
1366 1366 # reliably executed with builtins. Note that we can NOT use
1367 1367 # __builtins__ (note the 's'), because that can either be a dict or a
1368 1368 # module, and can even mutate at runtime, depending on the context
1369 1369 # (Python makes no guarantees on it). In contrast, __builtin__ is
1370 1370 # always a module object, though it must be explicitly imported.
1371 1371
1372 1372 # For more details:
1373 1373 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1374 1374 ns = {}
1375 1375
1376 1376 # make global variables for user access to the histories
1377 1377 ns['_ih'] = self.history_manager.input_hist_parsed
1378 1378 ns['_oh'] = self.history_manager.output_hist
1379 1379 ns['_dh'] = self.history_manager.dir_hist
1380 1380
1381 1381 # user aliases to input and output histories. These shouldn't show up
1382 1382 # in %who, as they can have very large reprs.
1383 1383 ns['In'] = self.history_manager.input_hist_parsed
1384 1384 ns['Out'] = self.history_manager.output_hist
1385 1385
1386 1386 # Store myself as the public api!!!
1387 1387 ns['get_ipython'] = self.get_ipython
1388 1388
1389 1389 ns['exit'] = self.exiter
1390 1390 ns['quit'] = self.exiter
1391 1391 ns["open"] = _modified_open
1392 1392
1393 1393 # Sync what we've added so far to user_ns_hidden so these aren't seen
1394 1394 # by %who
1395 1395 self.user_ns_hidden.update(ns)
1396 1396
1397 1397 # Anything put into ns now would show up in %who. Think twice before
1398 1398 # putting anything here, as we really want %who to show the user their
1399 1399 # stuff, not our variables.
1400 1400
1401 1401 # Finally, update the real user's namespace
1402 1402 self.user_ns.update(ns)
1403 1403
1404 1404 @property
1405 1405 def all_ns_refs(self):
1406 1406 """Get a list of references to all the namespace dictionaries in which
1407 1407 IPython might store a user-created object.
1408 1408
1409 1409 Note that this does not include the displayhook, which also caches
1410 1410 objects from the output."""
1411 1411 return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \
1412 1412 [m.__dict__ for m in self._main_mod_cache.values()]
1413 1413
1414 1414 def reset(self, new_session=True, aggressive=False):
1415 1415 """Clear all internal namespaces, and attempt to release references to
1416 1416 user objects.
1417 1417
1418 1418 If new_session is True, a new history session will be opened.
1419 1419 """
1420 1420 # Clear histories
1421 1421 assert self.history_manager is not None
1422 1422 self.history_manager.reset(new_session)
1423 1423 # Reset counter used to index all histories
1424 1424 if new_session:
1425 1425 self.execution_count = 1
1426 1426
1427 1427 # Reset last execution result
1428 1428 self.last_execution_succeeded = True
1429 1429 self.last_execution_result = None
1430 1430
1431 1431 # Flush cached output items
1432 1432 if self.displayhook.do_full_cache:
1433 1433 self.displayhook.flush()
1434 1434
1435 1435 # The main execution namespaces must be cleared very carefully,
1436 1436 # skipping the deletion of the builtin-related keys, because doing so
1437 1437 # would cause errors in many object's __del__ methods.
1438 1438 if self.user_ns is not self.user_global_ns:
1439 1439 self.user_ns.clear()
1440 1440 ns = self.user_global_ns
1441 1441 drop_keys = set(ns.keys())
1442 1442 drop_keys.discard('__builtin__')
1443 1443 drop_keys.discard('__builtins__')
1444 1444 drop_keys.discard('__name__')
1445 1445 for k in drop_keys:
1446 1446 del ns[k]
1447 1447
1448 1448 self.user_ns_hidden.clear()
1449 1449
1450 1450 # Restore the user namespaces to minimal usability
1451 1451 self.init_user_ns()
1452 1452 if aggressive and not hasattr(self, "_sys_modules_keys"):
1453 1453 print("Cannot restore sys.module, no snapshot")
1454 1454 elif aggressive:
1455 1455 print("culling sys module...")
1456 1456 current_keys = set(sys.modules.keys())
1457 1457 for k in current_keys - self._sys_modules_keys:
1458 1458 if k.startswith("multiprocessing"):
1459 1459 continue
1460 1460 del sys.modules[k]
1461 1461
1462 1462 # Restore the default and user aliases
1463 1463 self.alias_manager.clear_aliases()
1464 1464 self.alias_manager.init_aliases()
1465 1465
1466 1466 # Now define aliases that only make sense on the terminal, because they
1467 1467 # need direct access to the console in a way that we can't emulate in
1468 1468 # GUI or web frontend
1469 1469 if os.name == 'posix':
1470 1470 for cmd in ('clear', 'more', 'less', 'man'):
1471 1471 if cmd not in self.magics_manager.magics['line']:
1472 1472 self.alias_manager.soft_define_alias(cmd, cmd)
1473 1473
1474 1474 # Flush the private list of module references kept for script
1475 1475 # execution protection
1476 1476 self.clear_main_mod_cache()
1477 1477
1478 1478 def del_var(self, varname, by_name=False):
1479 1479 """Delete a variable from the various namespaces, so that, as
1480 1480 far as possible, we're not keeping any hidden references to it.
1481 1481
1482 1482 Parameters
1483 1483 ----------
1484 1484 varname : str
1485 1485 The name of the variable to delete.
1486 1486 by_name : bool
1487 1487 If True, delete variables with the given name in each
1488 1488 namespace. If False (default), find the variable in the user
1489 1489 namespace, and delete references to it.
1490 1490 """
1491 1491 if varname in ('__builtin__', '__builtins__'):
1492 1492 raise ValueError("Refusing to delete %s" % varname)
1493 1493
1494 1494 ns_refs = self.all_ns_refs
1495 1495
1496 1496 if by_name: # Delete by name
1497 1497 for ns in ns_refs:
1498 1498 try:
1499 1499 del ns[varname]
1500 1500 except KeyError:
1501 1501 pass
1502 1502 else: # Delete by object
1503 1503 try:
1504 1504 obj = self.user_ns[varname]
1505 1505 except KeyError as e:
1506 1506 raise NameError("name '%s' is not defined" % varname) from e
1507 1507 # Also check in output history
1508 1508 assert self.history_manager is not None
1509 1509 ns_refs.append(self.history_manager.output_hist)
1510 1510 for ns in ns_refs:
1511 1511 to_delete = [n for n, o in ns.items() if o is obj]
1512 1512 for name in to_delete:
1513 1513 del ns[name]
1514 1514
1515 1515 # Ensure it is removed from the last execution result
1516 1516 if self.last_execution_result.result is obj:
1517 1517 self.last_execution_result = None
1518 1518
1519 1519 # displayhook keeps extra references, but not in a dictionary
1520 1520 for name in ('_', '__', '___'):
1521 1521 if getattr(self.displayhook, name) is obj:
1522 1522 setattr(self.displayhook, name, None)
1523 1523
1524 1524 def reset_selective(self, regex=None):
1525 1525 """Clear selective variables from internal namespaces based on a
1526 1526 specified regular expression.
1527 1527
1528 1528 Parameters
1529 1529 ----------
1530 1530 regex : string or compiled pattern, optional
1531 1531 A regular expression pattern that will be used in searching
1532 1532 variable names in the users namespaces.
1533 1533 """
1534 1534 if regex is not None:
1535 1535 try:
1536 1536 m = re.compile(regex)
1537 1537 except TypeError as e:
1538 1538 raise TypeError('regex must be a string or compiled pattern') from e
1539 1539 # Search for keys in each namespace that match the given regex
1540 1540 # If a match is found, delete the key/value pair.
1541 1541 for ns in self.all_ns_refs:
1542 1542 for var in ns:
1543 1543 if m.search(var):
1544 1544 del ns[var]
1545 1545
1546 1546 def push(self, variables, interactive=True):
1547 1547 """Inject a group of variables into the IPython user namespace.
1548 1548
1549 1549 Parameters
1550 1550 ----------
1551 1551 variables : dict, str or list/tuple of str
1552 1552 The variables to inject into the user's namespace. If a dict, a
1553 1553 simple update is done. If a str, the string is assumed to have
1554 1554 variable names separated by spaces. A list/tuple of str can also
1555 1555 be used to give the variable names. If just the variable names are
1556 1556 give (list/tuple/str) then the variable values looked up in the
1557 1557 callers frame.
1558 1558 interactive : bool
1559 1559 If True (default), the variables will be listed with the ``who``
1560 1560 magic.
1561 1561 """
1562 1562 vdict = None
1563 1563
1564 1564 # We need a dict of name/value pairs to do namespace updates.
1565 1565 if isinstance(variables, dict):
1566 1566 vdict = variables
1567 1567 elif isinstance(variables, (str, list, tuple)):
1568 1568 if isinstance(variables, str):
1569 1569 vlist = variables.split()
1570 1570 else:
1571 1571 vlist = variables
1572 1572 vdict = {}
1573 1573 cf = sys._getframe(1)
1574 1574 for name in vlist:
1575 1575 try:
1576 1576 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1577 1577 except:
1578 1578 print('Could not get variable %s from %s' %
1579 1579 (name,cf.f_code.co_name))
1580 1580 else:
1581 1581 raise ValueError('variables must be a dict/str/list/tuple')
1582 1582
1583 1583 # Propagate variables to user namespace
1584 1584 self.user_ns.update(vdict)
1585 1585
1586 1586 # And configure interactive visibility
1587 1587 user_ns_hidden = self.user_ns_hidden
1588 1588 if interactive:
1589 1589 for name in vdict:
1590 1590 user_ns_hidden.pop(name, None)
1591 1591 else:
1592 1592 user_ns_hidden.update(vdict)
1593 1593
1594 1594 def drop_by_id(self, variables):
1595 1595 """Remove a dict of variables from the user namespace, if they are the
1596 1596 same as the values in the dictionary.
1597 1597
1598 1598 This is intended for use by extensions: variables that they've added can
1599 1599 be taken back out if they are unloaded, without removing any that the
1600 1600 user has overwritten.
1601 1601
1602 1602 Parameters
1603 1603 ----------
1604 1604 variables : dict
1605 1605 A dictionary mapping object names (as strings) to the objects.
1606 1606 """
1607 1607 for name, obj in variables.items():
1608 1608 if name in self.user_ns and self.user_ns[name] is obj:
1609 1609 del self.user_ns[name]
1610 1610 self.user_ns_hidden.pop(name, None)
1611 1611
1612 1612 #-------------------------------------------------------------------------
1613 1613 # Things related to object introspection
1614 1614 #-------------------------------------------------------------------------
1615 1615 @staticmethod
1616 1616 def _find_parts(oname: str) -> Tuple[bool, ListType[str]]:
1617 1617 """
1618 1618 Given an object name, return a list of parts of this object name.
1619 1619
1620 1620 Basically split on docs when using attribute access,
1621 1621 and extract the value when using square bracket.
1622 1622
1623 1623
1624 1624 For example foo.bar[3].baz[x] -> foo, bar, 3, baz, x
1625 1625
1626 1626
1627 1627 Returns
1628 1628 -------
1629 1629 parts_ok: bool
1630 1630 wether we were properly able to parse parts.
1631 1631 parts: list of str
1632 1632 extracted parts
1633 1633
1634 1634
1635 1635
1636 1636 """
1637 1637 raw_parts = oname.split(".")
1638 1638 parts = []
1639 1639 parts_ok = True
1640 1640 for p in raw_parts:
1641 1641 if p.endswith("]"):
1642 1642 var, *indices = p.split("[")
1643 1643 if not var.isidentifier():
1644 1644 parts_ok = False
1645 1645 break
1646 1646 parts.append(var)
1647 1647 for ind in indices:
1648 1648 if ind[-1] != "]" and not is_integer_string(ind[:-1]):
1649 1649 parts_ok = False
1650 1650 break
1651 1651 parts.append(ind[:-1])
1652 1652 continue
1653 1653
1654 1654 if not p.isidentifier():
1655 1655 parts_ok = False
1656 1656 parts.append(p)
1657 1657
1658 1658 return parts_ok, parts
1659 1659
1660 1660 def _ofind(
1661 1661 self, oname: str, namespaces: Optional[Sequence[Tuple[str, AnyType]]] = None
1662 1662 ) -> OInfo:
1663 1663 """Find an object in the available namespaces.
1664 1664
1665 1665
1666 1666 Returns
1667 1667 -------
1668 1668 OInfo with fields:
1669 1669 - ismagic
1670 1670 - isalias
1671 1671 - found
1672 1672 - obj
1673 1673 - namespac
1674 1674 - parent
1675 1675
1676 1676 Has special code to detect magic functions.
1677 1677 """
1678 1678 oname = oname.strip()
1679 1679 parts_ok, parts = self._find_parts(oname)
1680 1680
1681 1681 if (
1682 1682 not oname.startswith(ESC_MAGIC)
1683 1683 and not oname.startswith(ESC_MAGIC2)
1684 1684 and not parts_ok
1685 1685 ):
1686 1686 return OInfo(
1687 1687 ismagic=False,
1688 1688 isalias=False,
1689 1689 found=False,
1690 1690 obj=None,
1691 1691 namespace=None,
1692 1692 parent=None,
1693 1693 )
1694 1694
1695 1695 if namespaces is None:
1696 1696 # Namespaces to search in:
1697 1697 # Put them in a list. The order is important so that we
1698 1698 # find things in the same order that Python finds them.
1699 1699 namespaces = [ ('Interactive', self.user_ns),
1700 1700 ('Interactive (global)', self.user_global_ns),
1701 1701 ('Python builtin', builtin_mod.__dict__),
1702 1702 ]
1703 1703
1704 1704 ismagic = False
1705 1705 isalias = False
1706 1706 found = False
1707 1707 ospace = None
1708 1708 parent = None
1709 1709 obj = None
1710 1710
1711 1711
1712 1712 # Look for the given name by splitting it in parts. If the head is
1713 1713 # found, then we look for all the remaining parts as members, and only
1714 1714 # declare success if we can find them all.
1715 1715 oname_parts = parts
1716 1716 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1717 1717 for nsname,ns in namespaces:
1718 1718 try:
1719 1719 obj = ns[oname_head]
1720 1720 except KeyError:
1721 1721 continue
1722 1722 else:
1723 1723 for idx, part in enumerate(oname_rest):
1724 1724 try:
1725 1725 parent = obj
1726 1726 # The last part is looked up in a special way to avoid
1727 1727 # descriptor invocation as it may raise or have side
1728 1728 # effects.
1729 1729 if idx == len(oname_rest) - 1:
1730 1730 obj = self._getattr_property(obj, part)
1731 1731 else:
1732 1732 if is_integer_string(part):
1733 1733 obj = obj[int(part)]
1734 1734 else:
1735 1735 obj = getattr(obj, part)
1736 1736 except:
1737 1737 # Blanket except b/c some badly implemented objects
1738 1738 # allow __getattr__ to raise exceptions other than
1739 1739 # AttributeError, which then crashes IPython.
1740 1740 break
1741 1741 else:
1742 1742 # If we finish the for loop (no break), we got all members
1743 1743 found = True
1744 1744 ospace = nsname
1745 1745 break # namespace loop
1746 1746
1747 1747 # Try to see if it's magic
1748 1748 if not found:
1749 1749 obj = None
1750 1750 if oname.startswith(ESC_MAGIC2):
1751 1751 oname = oname.lstrip(ESC_MAGIC2)
1752 1752 obj = self.find_cell_magic(oname)
1753 1753 elif oname.startswith(ESC_MAGIC):
1754 1754 oname = oname.lstrip(ESC_MAGIC)
1755 1755 obj = self.find_line_magic(oname)
1756 1756 else:
1757 1757 # search without prefix, so run? will find %run?
1758 1758 obj = self.find_line_magic(oname)
1759 1759 if obj is None:
1760 1760 obj = self.find_cell_magic(oname)
1761 1761 if obj is not None:
1762 1762 found = True
1763 1763 ospace = 'IPython internal'
1764 1764 ismagic = True
1765 1765 isalias = isinstance(obj, Alias)
1766 1766
1767 1767 # Last try: special-case some literals like '', [], {}, etc:
1768 1768 if not found and oname_head in ["''",'""','[]','{}','()']:
1769 1769 obj = eval(oname_head)
1770 1770 found = True
1771 1771 ospace = 'Interactive'
1772 1772
1773 1773 return OInfo(
1774 1774 obj=obj,
1775 1775 found=found,
1776 1776 parent=parent,
1777 1777 ismagic=ismagic,
1778 1778 isalias=isalias,
1779 1779 namespace=ospace,
1780 1780 )
1781 1781
1782 1782 @staticmethod
1783 1783 def _getattr_property(obj, attrname):
1784 1784 """Property-aware getattr to use in object finding.
1785 1785
1786 1786 If attrname represents a property, return it unevaluated (in case it has
1787 1787 side effects or raises an error.
1788 1788
1789 1789 """
1790 1790 if not isinstance(obj, type):
1791 1791 try:
1792 1792 # `getattr(type(obj), attrname)` is not guaranteed to return
1793 1793 # `obj`, but does so for property:
1794 1794 #
1795 1795 # property.__get__(self, None, cls) -> self
1796 1796 #
1797 1797 # The universal alternative is to traverse the mro manually
1798 1798 # searching for attrname in class dicts.
1799 1799 if is_integer_string(attrname):
1800 1800 return obj[int(attrname)]
1801 1801 else:
1802 1802 attr = getattr(type(obj), attrname)
1803 1803 except AttributeError:
1804 1804 pass
1805 1805 else:
1806 1806 # This relies on the fact that data descriptors (with both
1807 1807 # __get__ & __set__ magic methods) take precedence over
1808 1808 # instance-level attributes:
1809 1809 #
1810 1810 # class A(object):
1811 1811 # @property
1812 1812 # def foobar(self): return 123
1813 1813 # a = A()
1814 1814 # a.__dict__['foobar'] = 345
1815 1815 # a.foobar # == 123
1816 1816 #
1817 1817 # So, a property may be returned right away.
1818 1818 if isinstance(attr, property):
1819 1819 return attr
1820 1820
1821 1821 # Nothing helped, fall back.
1822 1822 return getattr(obj, attrname)
1823 1823
1824 1824 def _object_find(self, oname, namespaces=None) -> OInfo:
1825 1825 """Find an object and return a struct with info about it."""
1826 1826 return self._ofind(oname, namespaces)
1827 1827
1828 1828 def _inspect(self, meth, oname: str, namespaces=None, **kw):
1829 1829 """Generic interface to the inspector system.
1830 1830
1831 1831 This function is meant to be called by pdef, pdoc & friends.
1832 1832 """
1833 1833 info: OInfo = self._object_find(oname, namespaces)
1834 1834 if self.sphinxify_docstring:
1835 1835 if sphinxify is None:
1836 1836 raise ImportError("Module ``docrepr`` required but missing")
1837 1837 docformat = sphinxify(self.object_inspect(oname))
1838 1838 else:
1839 1839 docformat = None
1840 1840 if info.found or hasattr(info.parent, oinspect.HOOK_NAME):
1841 1841 pmethod = getattr(self.inspector, meth)
1842 1842 # TODO: only apply format_screen to the plain/text repr of the mime
1843 1843 # bundle.
1844 1844 formatter = format_screen if info.ismagic else docformat
1845 1845 if meth == 'pdoc':
1846 1846 pmethod(info.obj, oname, formatter)
1847 1847 elif meth == 'pinfo':
1848 1848 pmethod(
1849 1849 info.obj,
1850 1850 oname,
1851 1851 formatter,
1852 1852 info,
1853 1853 enable_html_pager=self.enable_html_pager,
1854 1854 **kw,
1855 1855 )
1856 1856 else:
1857 1857 pmethod(info.obj, oname)
1858 1858 else:
1859 1859 print('Object `%s` not found.' % oname)
1860 1860 return 'not found' # so callers can take other action
1861 1861
1862 1862 def object_inspect(self, oname, detail_level=0):
1863 1863 """Get object info about oname"""
1864 1864 with self.builtin_trap:
1865 1865 info = self._object_find(oname)
1866 1866 if info.found:
1867 1867 return self.inspector.info(info.obj, oname, info=info,
1868 1868 detail_level=detail_level
1869 1869 )
1870 1870 else:
1871 1871 return oinspect.object_info(name=oname, found=False)
1872 1872
1873 1873 def object_inspect_text(self, oname, detail_level=0):
1874 1874 """Get object info as formatted text"""
1875 1875 return self.object_inspect_mime(oname, detail_level)['text/plain']
1876 1876
1877 1877 def object_inspect_mime(self, oname, detail_level=0, omit_sections=()):
1878 1878 """Get object info as a mimebundle of formatted representations.
1879 1879
1880 1880 A mimebundle is a dictionary, keyed by mime-type.
1881 1881 It must always have the key `'text/plain'`.
1882 1882 """
1883 1883 with self.builtin_trap:
1884 1884 info = self._object_find(oname)
1885 1885 if info.found:
1886 1886 docformat = (
1887 1887 sphinxify(self.object_inspect(oname))
1888 1888 if self.sphinxify_docstring
1889 1889 else None
1890 1890 )
1891 1891 return self.inspector._get_info(
1892 1892 info.obj,
1893 1893 oname,
1894 1894 info=info,
1895 1895 detail_level=detail_level,
1896 1896 formatter=docformat,
1897 1897 omit_sections=omit_sections,
1898 1898 )
1899 1899 else:
1900 1900 raise KeyError(oname)
1901 1901
1902 1902 #-------------------------------------------------------------------------
1903 1903 # Things related to history management
1904 1904 #-------------------------------------------------------------------------
1905 1905
1906 1906 def init_history(self):
1907 1907 """Sets up the command history, and starts regular autosaves."""
1908 1908 self.history_manager = HistoryManager(shell=self, parent=self)
1909 1909 self.configurables.append(self.history_manager)
1910 1910
1911 1911 #-------------------------------------------------------------------------
1912 1912 # Things related to exception handling and tracebacks (not debugging)
1913 1913 #-------------------------------------------------------------------------
1914 1914
1915 1915 debugger_cls = InterruptiblePdb
1916 1916
1917 1917 def init_traceback_handlers(self, custom_exceptions):
1918 1918 # Syntax error handler.
1919 1919 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self)
1920 1920
1921 1921 # The interactive one is initialized with an offset, meaning we always
1922 1922 # want to remove the topmost item in the traceback, which is our own
1923 1923 # internal code. Valid modes: ['Plain','Context','Verbose','Minimal']
1924 1924 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1925 1925 color_scheme='NoColor',
1926 1926 tb_offset = 1,
1927 1927 debugger_cls=self.debugger_cls, parent=self)
1928 1928
1929 1929 # The instance will store a pointer to the system-wide exception hook,
1930 1930 # so that runtime code (such as magics) can access it. This is because
1931 1931 # during the read-eval loop, it may get temporarily overwritten.
1932 1932 self.sys_excepthook = sys.excepthook
1933 1933
1934 1934 # and add any custom exception handlers the user may have specified
1935 1935 self.set_custom_exc(*custom_exceptions)
1936 1936
1937 1937 # Set the exception mode
1938 1938 self.InteractiveTB.set_mode(mode=self.xmode)
1939 1939
1940 1940 def set_custom_exc(self, exc_tuple, handler):
1941 1941 """set_custom_exc(exc_tuple, handler)
1942 1942
1943 1943 Set a custom exception handler, which will be called if any of the
1944 1944 exceptions in exc_tuple occur in the mainloop (specifically, in the
1945 1945 run_code() method).
1946 1946
1947 1947 Parameters
1948 1948 ----------
1949 1949 exc_tuple : tuple of exception classes
1950 1950 A *tuple* of exception classes, for which to call the defined
1951 1951 handler. It is very important that you use a tuple, and NOT A
1952 1952 LIST here, because of the way Python's except statement works. If
1953 1953 you only want to trap a single exception, use a singleton tuple::
1954 1954
1955 1955 exc_tuple == (MyCustomException,)
1956 1956
1957 1957 handler : callable
1958 1958 handler must have the following signature::
1959 1959
1960 1960 def my_handler(self, etype, value, tb, tb_offset=None):
1961 1961 ...
1962 1962 return structured_traceback
1963 1963
1964 1964 Your handler must return a structured traceback (a list of strings),
1965 1965 or None.
1966 1966
1967 1967 This will be made into an instance method (via types.MethodType)
1968 1968 of IPython itself, and it will be called if any of the exceptions
1969 1969 listed in the exc_tuple are caught. If the handler is None, an
1970 1970 internal basic one is used, which just prints basic info.
1971 1971
1972 1972 To protect IPython from crashes, if your handler ever raises an
1973 1973 exception or returns an invalid result, it will be immediately
1974 1974 disabled.
1975 1975
1976 1976 Notes
1977 1977 -----
1978 1978 WARNING: by putting in your own exception handler into IPython's main
1979 1979 execution loop, you run a very good chance of nasty crashes. This
1980 1980 facility should only be used if you really know what you are doing.
1981 1981 """
1982 1982
1983 1983 if not isinstance(exc_tuple, tuple):
1984 1984 raise TypeError("The custom exceptions must be given as a tuple.")
1985 1985
1986 1986 def dummy_handler(self, etype, value, tb, tb_offset=None):
1987 1987 print('*** Simple custom exception handler ***')
1988 1988 print('Exception type :', etype)
1989 1989 print('Exception value:', value)
1990 1990 print('Traceback :', tb)
1991 1991
1992 1992 def validate_stb(stb):
1993 1993 """validate structured traceback return type
1994 1994
1995 1995 return type of CustomTB *should* be a list of strings, but allow
1996 1996 single strings or None, which are harmless.
1997 1997
1998 1998 This function will *always* return a list of strings,
1999 1999 and will raise a TypeError if stb is inappropriate.
2000 2000 """
2001 2001 msg = "CustomTB must return list of strings, not %r" % stb
2002 2002 if stb is None:
2003 2003 return []
2004 2004 elif isinstance(stb, str):
2005 2005 return [stb]
2006 2006 elif not isinstance(stb, list):
2007 2007 raise TypeError(msg)
2008 2008 # it's a list
2009 2009 for line in stb:
2010 2010 # check every element
2011 2011 if not isinstance(line, str):
2012 2012 raise TypeError(msg)
2013 2013 return stb
2014 2014
2015 2015 if handler is None:
2016 2016 wrapped = dummy_handler
2017 2017 else:
2018 2018 def wrapped(self,etype,value,tb,tb_offset=None):
2019 2019 """wrap CustomTB handler, to protect IPython from user code
2020 2020
2021 2021 This makes it harder (but not impossible) for custom exception
2022 2022 handlers to crash IPython.
2023 2023 """
2024 2024 try:
2025 2025 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
2026 2026 return validate_stb(stb)
2027 2027 except:
2028 2028 # clear custom handler immediately
2029 2029 self.set_custom_exc((), None)
2030 2030 print("Custom TB Handler failed, unregistering", file=sys.stderr)
2031 2031 # show the exception in handler first
2032 2032 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
2033 2033 print(self.InteractiveTB.stb2text(stb))
2034 2034 print("The original exception:")
2035 2035 stb = self.InteractiveTB.structured_traceback(
2036 2036 (etype,value,tb), tb_offset=tb_offset
2037 2037 )
2038 2038 return stb
2039 2039
2040 2040 self.CustomTB = types.MethodType(wrapped,self)
2041 2041 self.custom_exceptions = exc_tuple
2042 2042
2043 2043 def excepthook(self, etype, value, tb):
2044 2044 """One more defense for GUI apps that call sys.excepthook.
2045 2045
2046 2046 GUI frameworks like wxPython trap exceptions and call
2047 2047 sys.excepthook themselves. I guess this is a feature that
2048 2048 enables them to keep running after exceptions that would
2049 2049 otherwise kill their mainloop. This is a bother for IPython
2050 2050 which expects to catch all of the program exceptions with a try:
2051 2051 except: statement.
2052 2052
2053 2053 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
2054 2054 any app directly invokes sys.excepthook, it will look to the user like
2055 2055 IPython crashed. In order to work around this, we can disable the
2056 2056 CrashHandler and replace it with this excepthook instead, which prints a
2057 2057 regular traceback using our InteractiveTB. In this fashion, apps which
2058 2058 call sys.excepthook will generate a regular-looking exception from
2059 2059 IPython, and the CrashHandler will only be triggered by real IPython
2060 2060 crashes.
2061 2061
2062 2062 This hook should be used sparingly, only in places which are not likely
2063 2063 to be true IPython errors.
2064 2064 """
2065 2065 self.showtraceback((etype, value, tb), tb_offset=0)
2066 2066
2067 2067 def _get_exc_info(self, exc_tuple=None):
2068 2068 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
2069 2069
2070 2070 Ensures sys.last_type,value,traceback hold the exc_info we found,
2071 2071 from whichever source.
2072 2072
2073 2073 raises ValueError if none of these contain any information
2074 2074 """
2075 2075 if exc_tuple is None:
2076 2076 etype, value, tb = sys.exc_info()
2077 2077 else:
2078 2078 etype, value, tb = exc_tuple
2079 2079
2080 2080 if etype is None:
2081 2081 if hasattr(sys, 'last_type'):
2082 2082 etype, value, tb = sys.last_type, sys.last_value, \
2083 2083 sys.last_traceback
2084 2084
2085 2085 if etype is None:
2086 2086 raise ValueError("No exception to find")
2087 2087
2088 2088 # Now store the exception info in sys.last_type etc.
2089 2089 # WARNING: these variables are somewhat deprecated and not
2090 2090 # necessarily safe to use in a threaded environment, but tools
2091 2091 # like pdb depend on their existence, so let's set them. If we
2092 2092 # find problems in the field, we'll need to revisit their use.
2093 2093 sys.last_type = etype
2094 2094 sys.last_value = value
2095 2095 sys.last_traceback = tb
2096 2096
2097 2097 return etype, value, tb
2098 2098
2099 2099 def show_usage_error(self, exc):
2100 2100 """Show a short message for UsageErrors
2101 2101
2102 2102 These are special exceptions that shouldn't show a traceback.
2103 2103 """
2104 2104 print("UsageError: %s" % exc, file=sys.stderr)
2105 2105
2106 2106 def get_exception_only(self, exc_tuple=None):
2107 2107 """
2108 2108 Return as a string (ending with a newline) the exception that
2109 2109 just occurred, without any traceback.
2110 2110 """
2111 2111 etype, value, tb = self._get_exc_info(exc_tuple)
2112 2112 msg = traceback.format_exception_only(etype, value)
2113 2113 return ''.join(msg)
2114 2114
2115 2115 def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None,
2116 2116 exception_only=False, running_compiled_code=False):
2117 2117 """Display the exception that just occurred.
2118 2118
2119 2119 If nothing is known about the exception, this is the method which
2120 2120 should be used throughout the code for presenting user tracebacks,
2121 2121 rather than directly invoking the InteractiveTB object.
2122 2122
2123 2123 A specific showsyntaxerror() also exists, but this method can take
2124 2124 care of calling it if needed, so unless you are explicitly catching a
2125 2125 SyntaxError exception, don't try to analyze the stack manually and
2126 2126 simply call this method."""
2127 2127
2128 2128 try:
2129 2129 try:
2130 2130 etype, value, tb = self._get_exc_info(exc_tuple)
2131 2131 except ValueError:
2132 2132 print('No traceback available to show.', file=sys.stderr)
2133 2133 return
2134 2134
2135 2135 if issubclass(etype, SyntaxError):
2136 2136 # Though this won't be called by syntax errors in the input
2137 2137 # line, there may be SyntaxError cases with imported code.
2138 2138 self.showsyntaxerror(filename, running_compiled_code)
2139 2139 elif etype is UsageError:
2140 2140 self.show_usage_error(value)
2141 2141 else:
2142 2142 if exception_only:
2143 2143 stb = ['An exception has occurred, use %tb to see '
2144 2144 'the full traceback.\n']
2145 2145 stb.extend(self.InteractiveTB.get_exception_only(etype,
2146 2146 value))
2147 2147 else:
2148 2148
2149 2149 def contains_exceptiongroup(val):
2150 2150 if val is None:
2151 2151 return False
2152 2152 return isinstance(
2153 2153 val, BaseExceptionGroup
2154 2154 ) or contains_exceptiongroup(val.__context__)
2155 2155
2156 2156 if contains_exceptiongroup(value):
2157 2157 # fall back to native exception formatting until ultratb
2158 2158 # supports exception groups
2159 2159 traceback.print_exc()
2160 2160 else:
2161 2161 try:
2162 2162 # Exception classes can customise their traceback - we
2163 2163 # use this in IPython.parallel for exceptions occurring
2164 2164 # in the engines. This should return a list of strings.
2165 2165 if hasattr(value, "_render_traceback_"):
2166 2166 stb = value._render_traceback_()
2167 2167 else:
2168 2168 stb = self.InteractiveTB.structured_traceback(
2169 2169 etype, value, tb, tb_offset=tb_offset
2170 2170 )
2171 2171
2172 2172 except Exception:
2173 2173 print(
2174 2174 "Unexpected exception formatting exception. Falling back to standard exception"
2175 2175 )
2176 2176 traceback.print_exc()
2177 2177 return None
2178 2178
2179 2179 self._showtraceback(etype, value, stb)
2180 2180 if self.call_pdb:
2181 2181 # drop into debugger
2182 2182 self.debugger(force=True)
2183 2183 return
2184 2184
2185 2185 # Actually show the traceback
2186 2186 self._showtraceback(etype, value, stb)
2187 2187
2188 2188 except KeyboardInterrupt:
2189 2189 print('\n' + self.get_exception_only(), file=sys.stderr)
2190 2190
2191 2191 def _showtraceback(self, etype, evalue, stb: str):
2192 2192 """Actually show a traceback.
2193 2193
2194 2194 Subclasses may override this method to put the traceback on a different
2195 2195 place, like a side channel.
2196 2196 """
2197 2197 val = self.InteractiveTB.stb2text(stb)
2198 2198 try:
2199 2199 print(val)
2200 2200 except UnicodeEncodeError:
2201 2201 print(val.encode("utf-8", "backslashreplace").decode())
2202 2202
2203 2203 def showsyntaxerror(self, filename=None, running_compiled_code=False):
2204 2204 """Display the syntax error that just occurred.
2205 2205
2206 2206 This doesn't display a stack trace because there isn't one.
2207 2207
2208 2208 If a filename is given, it is stuffed in the exception instead
2209 2209 of what was there before (because Python's parser always uses
2210 2210 "<string>" when reading from a string).
2211 2211
2212 2212 If the syntax error occurred when running a compiled code (i.e. running_compile_code=True),
2213 2213 longer stack trace will be displayed.
2214 2214 """
2215 2215 etype, value, last_traceback = self._get_exc_info()
2216 2216
2217 2217 if filename and issubclass(etype, SyntaxError):
2218 2218 try:
2219 2219 value.filename = filename
2220 2220 except:
2221 2221 # Not the format we expect; leave it alone
2222 2222 pass
2223 2223
2224 2224 # If the error occurred when executing compiled code, we should provide full stacktrace.
2225 2225 elist = traceback.extract_tb(last_traceback) if running_compiled_code else []
2226 2226 stb = self.SyntaxTB.structured_traceback(etype, value, elist)
2227 2227 self._showtraceback(etype, value, stb)
2228 2228
2229 2229 # This is overridden in TerminalInteractiveShell to show a message about
2230 2230 # the %paste magic.
2231 2231 def showindentationerror(self):
2232 2232 """Called by _run_cell when there's an IndentationError in code entered
2233 2233 at the prompt.
2234 2234
2235 2235 This is overridden in TerminalInteractiveShell to show a message about
2236 2236 the %paste magic."""
2237 2237 self.showsyntaxerror()
2238 2238
2239 2239 @skip_doctest
2240 2240 def set_next_input(self, s, replace=False):
2241 2241 """ Sets the 'default' input string for the next command line.
2242 2242
2243 2243 Example::
2244 2244
2245 2245 In [1]: _ip.set_next_input("Hello Word")
2246 2246 In [2]: Hello Word_ # cursor is here
2247 2247 """
2248 2248 self.rl_next_input = s
2249 2249
2250 2250 def _indent_current_str(self):
2251 2251 """return the current level of indentation as a string"""
2252 2252 return self.input_splitter.get_indent_spaces() * ' '
2253 2253
2254 2254 #-------------------------------------------------------------------------
2255 2255 # Things related to text completion
2256 2256 #-------------------------------------------------------------------------
2257 2257
2258 2258 def init_completer(self):
2259 2259 """Initialize the completion machinery.
2260 2260
2261 2261 This creates completion machinery that can be used by client code,
2262 2262 either interactively in-process (typically triggered by the readline
2263 2263 library), programmatically (such as in test suites) or out-of-process
2264 2264 (typically over the network by remote frontends).
2265 2265 """
2266 2266 from IPython.core.completer import IPCompleter
2267 2267 from IPython.core.completerlib import (
2268 2268 cd_completer,
2269 2269 magic_run_completer,
2270 2270 module_completer,
2271 2271 reset_completer,
2272 2272 )
2273 2273
2274 2274 self.Completer = IPCompleter(shell=self,
2275 2275 namespace=self.user_ns,
2276 2276 global_namespace=self.user_global_ns,
2277 2277 parent=self,
2278 2278 )
2279 2279 self.configurables.append(self.Completer)
2280 2280
2281 2281 # Add custom completers to the basic ones built into IPCompleter
2282 2282 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
2283 2283 self.strdispatchers['complete_command'] = sdisp
2284 2284 self.Completer.custom_completers = sdisp
2285 2285
2286 2286 self.set_hook('complete_command', module_completer, str_key = 'import')
2287 2287 self.set_hook('complete_command', module_completer, str_key = 'from')
2288 2288 self.set_hook('complete_command', module_completer, str_key = '%aimport')
2289 2289 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
2290 2290 self.set_hook('complete_command', cd_completer, str_key = '%cd')
2291 2291 self.set_hook('complete_command', reset_completer, str_key = '%reset')
2292 2292
2293 2293 @skip_doctest
2294 2294 def complete(self, text, line=None, cursor_pos=None):
2295 2295 """Return the completed text and a list of completions.
2296 2296
2297 2297 Parameters
2298 2298 ----------
2299 2299 text : string
2300 2300 A string of text to be completed on. It can be given as empty and
2301 2301 instead a line/position pair are given. In this case, the
2302 2302 completer itself will split the line like readline does.
2303 2303 line : string, optional
2304 2304 The complete line that text is part of.
2305 2305 cursor_pos : int, optional
2306 2306 The position of the cursor on the input line.
2307 2307
2308 2308 Returns
2309 2309 -------
2310 2310 text : string
2311 2311 The actual text that was completed.
2312 2312 matches : list
2313 2313 A sorted list with all possible completions.
2314 2314
2315 2315 Notes
2316 2316 -----
2317 2317 The optional arguments allow the completion to take more context into
2318 2318 account, and are part of the low-level completion API.
2319 2319
2320 2320 This is a wrapper around the completion mechanism, similar to what
2321 2321 readline does at the command line when the TAB key is hit. By
2322 2322 exposing it as a method, it can be used by other non-readline
2323 2323 environments (such as GUIs) for text completion.
2324 2324
2325 2325 Examples
2326 2326 --------
2327 2327 In [1]: x = 'hello'
2328 2328
2329 2329 In [2]: _ip.complete('x.l')
2330 2330 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
2331 2331 """
2332 2332
2333 2333 # Inject names into __builtin__ so we can complete on the added names.
2334 2334 with self.builtin_trap:
2335 2335 return self.Completer.complete(text, line, cursor_pos)
2336 2336
2337 2337 def set_custom_completer(self, completer, pos=0) -> None:
2338 2338 """Adds a new custom completer function.
2339 2339
2340 2340 The position argument (defaults to 0) is the index in the completers
2341 2341 list where you want the completer to be inserted.
2342 2342
2343 2343 `completer` should have the following signature::
2344 2344
2345 2345 def completion(self: Completer, text: string) -> List[str]:
2346 2346 raise NotImplementedError
2347 2347
2348 2348 It will be bound to the current Completer instance and pass some text
2349 2349 and return a list with current completions to suggest to the user.
2350 2350 """
2351 2351
2352 2352 newcomp = types.MethodType(completer, self.Completer)
2353 2353 self.Completer.custom_matchers.insert(pos,newcomp)
2354 2354
2355 2355 def set_completer_frame(self, frame=None):
2356 2356 """Set the frame of the completer."""
2357 2357 if frame:
2358 2358 self.Completer.namespace = frame.f_locals
2359 2359 self.Completer.global_namespace = frame.f_globals
2360 2360 else:
2361 2361 self.Completer.namespace = self.user_ns
2362 2362 self.Completer.global_namespace = self.user_global_ns
2363 2363
2364 2364 #-------------------------------------------------------------------------
2365 2365 # Things related to magics
2366 2366 #-------------------------------------------------------------------------
2367 2367
2368 2368 def init_magics(self):
2369 2369 from IPython.core import magics as m
2370 2370 self.magics_manager = magic.MagicsManager(shell=self,
2371 2371 parent=self,
2372 2372 user_magics=m.UserMagics(self))
2373 2373 self.configurables.append(self.magics_manager)
2374 2374
2375 2375 # Expose as public API from the magics manager
2376 2376 self.register_magics = self.magics_manager.register
2377 2377
2378 2378 self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics,
2379 2379 m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics,
2380 2380 m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics,
2381 2381 m.NamespaceMagics, m.OSMagics, m.PackagingMagics,
2382 2382 m.PylabMagics, m.ScriptMagics,
2383 2383 )
2384 2384 self.register_magics(m.AsyncMagics)
2385 2385
2386 2386 # Register Magic Aliases
2387 2387 mman = self.magics_manager
2388 2388 # FIXME: magic aliases should be defined by the Magics classes
2389 2389 # or in MagicsManager, not here
2390 2390 mman.register_alias('ed', 'edit')
2391 2391 mman.register_alias('hist', 'history')
2392 2392 mman.register_alias('rep', 'recall')
2393 2393 mman.register_alias('SVG', 'svg', 'cell')
2394 2394 mman.register_alias('HTML', 'html', 'cell')
2395 2395 mman.register_alias('file', 'writefile', 'cell')
2396 2396
2397 2397 # FIXME: Move the color initialization to the DisplayHook, which
2398 2398 # should be split into a prompt manager and displayhook. We probably
2399 2399 # even need a centralize colors management object.
2400 2400 self.run_line_magic('colors', self.colors)
2401 2401
2402 2402 # Defined here so that it's included in the documentation
2403 2403 @functools.wraps(magic.MagicsManager.register_function)
2404 2404 def register_magic_function(self, func, magic_kind='line', magic_name=None):
2405 2405 self.magics_manager.register_function(
2406 2406 func, magic_kind=magic_kind, magic_name=magic_name
2407 2407 )
2408 2408
2409 2409 def _find_with_lazy_load(self, /, type_, magic_name: str):
2410 2410 """
2411 2411 Try to find a magic potentially lazy-loading it.
2412 2412
2413 2413 Parameters
2414 2414 ----------
2415 2415
2416 2416 type_: "line"|"cell"
2417 2417 the type of magics we are trying to find/lazy load.
2418 2418 magic_name: str
2419 2419 The name of the magic we are trying to find/lazy load
2420 2420
2421 2421
2422 2422 Note that this may have any side effects
2423 2423 """
2424 2424 finder = {"line": self.find_line_magic, "cell": self.find_cell_magic}[type_]
2425 2425 fn = finder(magic_name)
2426 2426 if fn is not None:
2427 2427 return fn
2428 2428 lazy = self.magics_manager.lazy_magics.get(magic_name)
2429 2429 if lazy is None:
2430 2430 return None
2431 2431
2432 2432 self.run_line_magic("load_ext", lazy)
2433 2433 res = finder(magic_name)
2434 2434 return res
2435 2435
2436 2436 def run_line_magic(self, magic_name: str, line: str, _stack_depth=1):
2437 2437 """Execute the given line magic.
2438 2438
2439 2439 Parameters
2440 2440 ----------
2441 2441 magic_name : str
2442 2442 Name of the desired magic function, without '%' prefix.
2443 2443 line : str
2444 2444 The rest of the input line as a single string.
2445 2445 _stack_depth : int
2446 2446 If run_line_magic() is called from magic() then _stack_depth=2.
2447 2447 This is added to ensure backward compatibility for use of 'get_ipython().magic()'
2448 2448 """
2449 2449 fn = self._find_with_lazy_load("line", magic_name)
2450 2450 if fn is None:
2451 2451 lazy = self.magics_manager.lazy_magics.get(magic_name)
2452 2452 if lazy:
2453 2453 self.run_line_magic("load_ext", lazy)
2454 2454 fn = self.find_line_magic(magic_name)
2455 2455 if fn is None:
2456 2456 cm = self.find_cell_magic(magic_name)
2457 2457 etpl = "Line magic function `%%%s` not found%s."
2458 2458 extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, '
2459 2459 'did you mean that instead?)' % magic_name )
2460 2460 raise UsageError(etpl % (magic_name, extra))
2461 2461 else:
2462 2462 # Note: this is the distance in the stack to the user's frame.
2463 2463 # This will need to be updated if the internal calling logic gets
2464 2464 # refactored, or else we'll be expanding the wrong variables.
2465 2465
2466 2466 # Determine stack_depth depending on where run_line_magic() has been called
2467 2467 stack_depth = _stack_depth
2468 2468 if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False):
2469 2469 # magic has opted out of var_expand
2470 2470 magic_arg_s = line
2471 2471 else:
2472 2472 magic_arg_s = self.var_expand(line, stack_depth)
2473 2473 # Put magic args in a list so we can call with f(*a) syntax
2474 2474 args = [magic_arg_s]
2475 2475 kwargs = {}
2476 2476 # Grab local namespace if we need it:
2477 2477 if getattr(fn, "needs_local_scope", False):
2478 2478 kwargs['local_ns'] = self.get_local_scope(stack_depth)
2479 2479 with self.builtin_trap:
2480 2480 result = fn(*args, **kwargs)
2481 2481
2482 2482 # The code below prevents the output from being displayed
2483 2483 # when using magics with decorator @output_can_be_silenced
2484 2484 # when the last Python token in the expression is a ';'.
2485 2485 if getattr(fn, magic.MAGIC_OUTPUT_CAN_BE_SILENCED, False):
2486 2486 if DisplayHook.semicolon_at_end_of_expression(magic_arg_s):
2487 2487 return None
2488 2488
2489 2489 return result
2490 2490
2491 2491 def get_local_scope(self, stack_depth):
2492 2492 """Get local scope at given stack depth.
2493 2493
2494 2494 Parameters
2495 2495 ----------
2496 2496 stack_depth : int
2497 2497 Depth relative to calling frame
2498 2498 """
2499 2499 return sys._getframe(stack_depth + 1).f_locals
2500 2500
2501 2501 def run_cell_magic(self, magic_name, line, cell):
2502 2502 """Execute the given cell magic.
2503 2503
2504 2504 Parameters
2505 2505 ----------
2506 2506 magic_name : str
2507 2507 Name of the desired magic function, without '%' prefix.
2508 2508 line : str
2509 2509 The rest of the first input line as a single string.
2510 2510 cell : str
2511 2511 The body of the cell as a (possibly multiline) string.
2512 2512 """
2513 2513 fn = self._find_with_lazy_load("cell", magic_name)
2514 2514 if fn is None:
2515 2515 lm = self.find_line_magic(magic_name)
2516 2516 etpl = "Cell magic `%%{0}` not found{1}."
2517 2517 extra = '' if lm is None else (' (But line magic `%{0}` exists, '
2518 2518 'did you mean that instead?)'.format(magic_name))
2519 2519 raise UsageError(etpl.format(magic_name, extra))
2520 2520 elif cell == '':
2521 2521 message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name)
2522 2522 if self.find_line_magic(magic_name) is not None:
2523 2523 message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name)
2524 2524 raise UsageError(message)
2525 2525 else:
2526 2526 # Note: this is the distance in the stack to the user's frame.
2527 2527 # This will need to be updated if the internal calling logic gets
2528 2528 # refactored, or else we'll be expanding the wrong variables.
2529 2529 stack_depth = 2
2530 2530 if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False):
2531 2531 # magic has opted out of var_expand
2532 2532 magic_arg_s = line
2533 2533 else:
2534 2534 magic_arg_s = self.var_expand(line, stack_depth)
2535 2535 kwargs = {}
2536 2536 if getattr(fn, "needs_local_scope", False):
2537 2537 kwargs['local_ns'] = self.user_ns
2538 2538
2539 2539 with self.builtin_trap:
2540 2540 args = (magic_arg_s, cell)
2541 2541 result = fn(*args, **kwargs)
2542 2542
2543 2543 # The code below prevents the output from being displayed
2544 2544 # when using magics with decorator @output_can_be_silenced
2545 2545 # when the last Python token in the expression is a ';'.
2546 2546 if getattr(fn, magic.MAGIC_OUTPUT_CAN_BE_SILENCED, False):
2547 2547 if DisplayHook.semicolon_at_end_of_expression(cell):
2548 2548 return None
2549 2549
2550 2550 return result
2551 2551
2552 2552 def find_line_magic(self, magic_name):
2553 2553 """Find and return a line magic by name.
2554 2554
2555 2555 Returns None if the magic isn't found."""
2556 2556 return self.magics_manager.magics['line'].get(magic_name)
2557 2557
2558 2558 def find_cell_magic(self, magic_name):
2559 2559 """Find and return a cell magic by name.
2560 2560
2561 2561 Returns None if the magic isn't found."""
2562 2562 return self.magics_manager.magics['cell'].get(magic_name)
2563 2563
2564 2564 def find_magic(self, magic_name, magic_kind='line'):
2565 2565 """Find and return a magic of the given type by name.
2566 2566
2567 2567 Returns None if the magic isn't found."""
2568 2568 return self.magics_manager.magics[magic_kind].get(magic_name)
2569 2569
2570 2570 def magic(self, arg_s):
2571 2571 """
2572 2572 DEPRECATED
2573 2573
2574 2574 Deprecated since IPython 0.13 (warning added in
2575 2575 8.1), use run_line_magic(magic_name, parameter_s).
2576 2576
2577 2577 Call a magic function by name.
2578 2578
2579 2579 Input: a string containing the name of the magic function to call and
2580 2580 any additional arguments to be passed to the magic.
2581 2581
2582 2582 magic('name -opt foo bar') is equivalent to typing at the ipython
2583 2583 prompt:
2584 2584
2585 2585 In[1]: %name -opt foo bar
2586 2586
2587 2587 To call a magic without arguments, simply use magic('name').
2588 2588
2589 2589 This provides a proper Python function to call IPython's magics in any
2590 2590 valid Python code you can type at the interpreter, including loops and
2591 2591 compound statements.
2592 2592 """
2593 2593 warnings.warn(
2594 2594 "`magic(...)` is deprecated since IPython 0.13 (warning added in "
2595 2595 "8.1), use run_line_magic(magic_name, parameter_s).",
2596 2596 DeprecationWarning,
2597 2597 stacklevel=2,
2598 2598 )
2599 2599 # TODO: should we issue a loud deprecation warning here?
2600 2600 magic_name, _, magic_arg_s = arg_s.partition(' ')
2601 2601 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2602 2602 return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2)
2603 2603
2604 2604 #-------------------------------------------------------------------------
2605 2605 # Things related to macros
2606 2606 #-------------------------------------------------------------------------
2607 2607
2608 2608 def define_macro(self, name, themacro):
2609 2609 """Define a new macro
2610 2610
2611 2611 Parameters
2612 2612 ----------
2613 2613 name : str
2614 2614 The name of the macro.
2615 2615 themacro : str or Macro
2616 2616 The action to do upon invoking the macro. If a string, a new
2617 2617 Macro object is created by passing the string to it.
2618 2618 """
2619 2619
2620 2620 from IPython.core import macro
2621 2621
2622 2622 if isinstance(themacro, str):
2623 2623 themacro = macro.Macro(themacro)
2624 2624 if not isinstance(themacro, macro.Macro):
2625 2625 raise ValueError('A macro must be a string or a Macro instance.')
2626 2626 self.user_ns[name] = themacro
2627 2627
2628 2628 #-------------------------------------------------------------------------
2629 2629 # Things related to the running of system commands
2630 2630 #-------------------------------------------------------------------------
2631 2631
2632 2632 def system_piped(self, cmd):
2633 2633 """Call the given cmd in a subprocess, piping stdout/err
2634 2634
2635 2635 Parameters
2636 2636 ----------
2637 2637 cmd : str
2638 2638 Command to execute (can not end in '&', as background processes are
2639 2639 not supported. Should not be a command that expects input
2640 2640 other than simple text.
2641 2641 """
2642 2642 if cmd.rstrip().endswith('&'):
2643 2643 # this is *far* from a rigorous test
2644 2644 # We do not support backgrounding processes because we either use
2645 2645 # pexpect or pipes to read from. Users can always just call
2646 2646 # os.system() or use ip.system=ip.system_raw
2647 2647 # if they really want a background process.
2648 2648 raise OSError("Background processes not supported.")
2649 2649
2650 2650 # we explicitly do NOT return the subprocess status code, because
2651 2651 # a non-None value would trigger :func:`sys.displayhook` calls.
2652 2652 # Instead, we store the exit_code in user_ns.
2653 2653 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1))
2654 2654
2655 2655 def system_raw(self, cmd):
2656 2656 """Call the given cmd in a subprocess using os.system on Windows or
2657 2657 subprocess.call using the system shell on other platforms.
2658 2658
2659 2659 Parameters
2660 2660 ----------
2661 2661 cmd : str
2662 2662 Command to execute.
2663 2663 """
2664 2664 cmd = self.var_expand(cmd, depth=1)
2665 2665 # warn if there is an IPython magic alternative.
2666 2666 if cmd == "":
2667 2667 main_cmd = ""
2668 2668 else:
2669 2669 main_cmd = cmd.split()[0]
2670 2670 has_magic_alternatives = ("pip", "conda", "cd")
2671 2671
2672 2672 if main_cmd in has_magic_alternatives:
2673 2673 warnings.warn(
2674 2674 (
2675 2675 "You executed the system command !{0} which may not work "
2676 2676 "as expected. Try the IPython magic %{0} instead."
2677 2677 ).format(main_cmd)
2678 2678 )
2679 2679
2680 2680 # protect os.system from UNC paths on Windows, which it can't handle:
2681 2681 if sys.platform == 'win32':
2682 2682 from IPython.utils._process_win32 import AvoidUNCPath
2683 2683 with AvoidUNCPath() as path:
2684 2684 if path is not None:
2685 2685 cmd = '"pushd %s &&"%s' % (path, cmd)
2686 2686 try:
2687 2687 ec = os.system(cmd)
2688 2688 except KeyboardInterrupt:
2689 2689 print('\n' + self.get_exception_only(), file=sys.stderr)
2690 2690 ec = -2
2691 2691 else:
2692 2692 # For posix the result of the subprocess.call() below is an exit
2693 2693 # code, which by convention is zero for success, positive for
2694 2694 # program failure. Exit codes above 128 are reserved for signals,
2695 2695 # and the formula for converting a signal to an exit code is usually
2696 2696 # signal_number+128. To more easily differentiate between exit
2697 2697 # codes and signals, ipython uses negative numbers. For instance
2698 2698 # since control-c is signal 2 but exit code 130, ipython's
2699 2699 # _exit_code variable will read -2. Note that some shells like
2700 2700 # csh and fish don't follow sh/bash conventions for exit codes.
2701 2701 executable = os.environ.get('SHELL', None)
2702 2702 try:
2703 2703 # Use env shell instead of default /bin/sh
2704 2704 ec = subprocess.call(cmd, shell=True, executable=executable)
2705 2705 except KeyboardInterrupt:
2706 2706 # intercept control-C; a long traceback is not useful here
2707 2707 print('\n' + self.get_exception_only(), file=sys.stderr)
2708 2708 ec = 130
2709 2709 if ec > 128:
2710 2710 ec = -(ec - 128)
2711 2711
2712 2712 # We explicitly do NOT return the subprocess status code, because
2713 2713 # a non-None value would trigger :func:`sys.displayhook` calls.
2714 2714 # Instead, we store the exit_code in user_ns. Note the semantics
2715 2715 # of _exit_code: for control-c, _exit_code == -signal.SIGNIT,
2716 2716 # but raising SystemExit(_exit_code) will give status 254!
2717 2717 self.user_ns['_exit_code'] = ec
2718 2718
2719 2719 # use piped system by default, because it is better behaved
2720 2720 system = system_piped
2721 2721
2722 2722 def getoutput(self, cmd, split=True, depth=0):
2723 2723 """Get output (possibly including stderr) from a subprocess.
2724 2724
2725 2725 Parameters
2726 2726 ----------
2727 2727 cmd : str
2728 2728 Command to execute (can not end in '&', as background processes are
2729 2729 not supported.
2730 2730 split : bool, optional
2731 2731 If True, split the output into an IPython SList. Otherwise, an
2732 2732 IPython LSString is returned. These are objects similar to normal
2733 2733 lists and strings, with a few convenience attributes for easier
2734 2734 manipulation of line-based output. You can use '?' on them for
2735 2735 details.
2736 2736 depth : int, optional
2737 2737 How many frames above the caller are the local variables which should
2738 2738 be expanded in the command string? The default (0) assumes that the
2739 2739 expansion variables are in the stack frame calling this function.
2740 2740 """
2741 2741 if cmd.rstrip().endswith('&'):
2742 2742 # this is *far* from a rigorous test
2743 2743 raise OSError("Background processes not supported.")
2744 2744 out = getoutput(self.var_expand(cmd, depth=depth+1))
2745 2745 if split:
2746 2746 out = SList(out.splitlines())
2747 2747 else:
2748 2748 out = LSString(out)
2749 2749 return out
2750 2750
2751 2751 #-------------------------------------------------------------------------
2752 2752 # Things related to aliases
2753 2753 #-------------------------------------------------------------------------
2754 2754
2755 2755 def init_alias(self):
2756 2756 self.alias_manager = AliasManager(shell=self, parent=self)
2757 2757 self.configurables.append(self.alias_manager)
2758 2758
2759 2759 #-------------------------------------------------------------------------
2760 2760 # Things related to extensions
2761 2761 #-------------------------------------------------------------------------
2762 2762
2763 2763 def init_extension_manager(self):
2764 2764 self.extension_manager = ExtensionManager(shell=self, parent=self)
2765 2765 self.configurables.append(self.extension_manager)
2766 2766
2767 2767 #-------------------------------------------------------------------------
2768 2768 # Things related to payloads
2769 2769 #-------------------------------------------------------------------------
2770 2770
2771 2771 def init_payload(self):
2772 2772 self.payload_manager = PayloadManager(parent=self)
2773 2773 self.configurables.append(self.payload_manager)
2774 2774
2775 2775 #-------------------------------------------------------------------------
2776 2776 # Things related to the prefilter
2777 2777 #-------------------------------------------------------------------------
2778 2778
2779 2779 def init_prefilter(self):
2780 2780 self.prefilter_manager = PrefilterManager(shell=self, parent=self)
2781 2781 self.configurables.append(self.prefilter_manager)
2782 2782 # Ultimately this will be refactored in the new interpreter code, but
2783 2783 # for now, we should expose the main prefilter method (there's legacy
2784 2784 # code out there that may rely on this).
2785 2785 self.prefilter = self.prefilter_manager.prefilter_lines
2786 2786
2787 2787 def auto_rewrite_input(self, cmd):
2788 2788 """Print to the screen the rewritten form of the user's command.
2789 2789
2790 2790 This shows visual feedback by rewriting input lines that cause
2791 2791 automatic calling to kick in, like::
2792 2792
2793 2793 /f x
2794 2794
2795 2795 into::
2796 2796
2797 2797 ------> f(x)
2798 2798
2799 2799 after the user's input prompt. This helps the user understand that the
2800 2800 input line was transformed automatically by IPython.
2801 2801 """
2802 2802 if not self.show_rewritten_input:
2803 2803 return
2804 2804
2805 2805 # This is overridden in TerminalInteractiveShell to use fancy prompts
2806 2806 print("------> " + cmd)
2807 2807
2808 2808 #-------------------------------------------------------------------------
2809 2809 # Things related to extracting values/expressions from kernel and user_ns
2810 2810 #-------------------------------------------------------------------------
2811 2811
2812 2812 def _user_obj_error(self):
2813 2813 """return simple exception dict
2814 2814
2815 2815 for use in user_expressions
2816 2816 """
2817 2817
2818 2818 etype, evalue, tb = self._get_exc_info()
2819 2819 stb = self.InteractiveTB.get_exception_only(etype, evalue)
2820 2820
2821 2821 exc_info = {
2822 2822 "status": "error",
2823 2823 "traceback": stb,
2824 2824 "ename": etype.__name__,
2825 2825 "evalue": py3compat.safe_unicode(evalue),
2826 2826 }
2827 2827
2828 2828 return exc_info
2829 2829
2830 2830 def _format_user_obj(self, obj):
2831 2831 """format a user object to display dict
2832 2832
2833 2833 for use in user_expressions
2834 2834 """
2835 2835
2836 2836 data, md = self.display_formatter.format(obj)
2837 2837 value = {
2838 2838 'status' : 'ok',
2839 2839 'data' : data,
2840 2840 'metadata' : md,
2841 2841 }
2842 2842 return value
2843 2843
2844 2844 def user_expressions(self, expressions):
2845 2845 """Evaluate a dict of expressions in the user's namespace.
2846 2846
2847 2847 Parameters
2848 2848 ----------
2849 2849 expressions : dict
2850 2850 A dict with string keys and string values. The expression values
2851 2851 should be valid Python expressions, each of which will be evaluated
2852 2852 in the user namespace.
2853 2853
2854 2854 Returns
2855 2855 -------
2856 2856 A dict, keyed like the input expressions dict, with the rich mime-typed
2857 2857 display_data of each value.
2858 2858 """
2859 2859 out = {}
2860 2860 user_ns = self.user_ns
2861 2861 global_ns = self.user_global_ns
2862 2862
2863 2863 for key, expr in expressions.items():
2864 2864 try:
2865 2865 value = self._format_user_obj(eval(expr, global_ns, user_ns))
2866 2866 except:
2867 2867 value = self._user_obj_error()
2868 2868 out[key] = value
2869 2869 return out
2870 2870
2871 2871 #-------------------------------------------------------------------------
2872 2872 # Things related to the running of code
2873 2873 #-------------------------------------------------------------------------
2874 2874
2875 2875 def ex(self, cmd):
2876 2876 """Execute a normal python statement in user namespace."""
2877 2877 with self.builtin_trap:
2878 2878 exec(cmd, self.user_global_ns, self.user_ns)
2879 2879
2880 2880 def ev(self, expr):
2881 2881 """Evaluate python expression expr in user namespace.
2882 2882
2883 2883 Returns the result of evaluation
2884 2884 """
2885 2885 with self.builtin_trap:
2886 2886 return eval(expr, self.user_global_ns, self.user_ns)
2887 2887
2888 2888 def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False):
2889 2889 """A safe version of the builtin execfile().
2890 2890
2891 2891 This version will never throw an exception, but instead print
2892 2892 helpful error messages to the screen. This only works on pure
2893 2893 Python files with the .py extension.
2894 2894
2895 2895 Parameters
2896 2896 ----------
2897 2897 fname : string
2898 2898 The name of the file to be executed.
2899 2899 *where : tuple
2900 2900 One or two namespaces, passed to execfile() as (globals,locals).
2901 2901 If only one is given, it is passed as both.
2902 2902 exit_ignore : bool (False)
2903 2903 If True, then silence SystemExit for non-zero status (it is always
2904 2904 silenced for zero status, as it is so common).
2905 2905 raise_exceptions : bool (False)
2906 2906 If True raise exceptions everywhere. Meant for testing.
2907 2907 shell_futures : bool (False)
2908 2908 If True, the code will share future statements with the interactive
2909 2909 shell. It will both be affected by previous __future__ imports, and
2910 2910 any __future__ imports in the code will affect the shell. If False,
2911 2911 __future__ imports are not shared in either direction.
2912 2912
2913 2913 """
2914 2914 fname = Path(fname).expanduser().resolve()
2915 2915
2916 2916 # Make sure we can open the file
2917 2917 try:
2918 2918 with fname.open("rb"):
2919 2919 pass
2920 2920 except:
2921 2921 warn('Could not open file <%s> for safe execution.' % fname)
2922 2922 return
2923 2923
2924 2924 # Find things also in current directory. This is needed to mimic the
2925 2925 # behavior of running a script from the system command line, where
2926 2926 # Python inserts the script's directory into sys.path
2927 2927 dname = str(fname.parent)
2928 2928
2929 2929 with prepended_to_syspath(dname), self.builtin_trap:
2930 2930 try:
2931 2931 glob, loc = (where + (None, ))[:2]
2932 2932 py3compat.execfile(
2933 2933 fname, glob, loc,
2934 2934 self.compile if shell_futures else None)
2935 2935 except SystemExit as status:
2936 2936 # If the call was made with 0 or None exit status (sys.exit(0)
2937 2937 # or sys.exit() ), don't bother showing a traceback, as both of
2938 2938 # these are considered normal by the OS:
2939 2939 # > python -c'import sys;sys.exit(0)'; echo $?
2940 2940 # 0
2941 2941 # > python -c'import sys;sys.exit()'; echo $?
2942 2942 # 0
2943 2943 # For other exit status, we show the exception unless
2944 2944 # explicitly silenced, but only in short form.
2945 2945 if status.code:
2946 2946 if raise_exceptions:
2947 2947 raise
2948 2948 if not exit_ignore:
2949 2949 self.showtraceback(exception_only=True)
2950 2950 except:
2951 2951 if raise_exceptions:
2952 2952 raise
2953 2953 # tb offset is 2 because we wrap execfile
2954 2954 self.showtraceback(tb_offset=2)
2955 2955
2956 2956 def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False):
2957 2957 """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax.
2958 2958
2959 2959 Parameters
2960 2960 ----------
2961 2961 fname : str
2962 2962 The name of the file to execute. The filename must have a
2963 2963 .ipy or .ipynb extension.
2964 2964 shell_futures : bool (False)
2965 2965 If True, the code will share future statements with the interactive
2966 2966 shell. It will both be affected by previous __future__ imports, and
2967 2967 any __future__ imports in the code will affect the shell. If False,
2968 2968 __future__ imports are not shared in either direction.
2969 2969 raise_exceptions : bool (False)
2970 2970 If True raise exceptions everywhere. Meant for testing.
2971 2971 """
2972 2972 fname = Path(fname).expanduser().resolve()
2973 2973
2974 2974 # Make sure we can open the file
2975 2975 try:
2976 2976 with fname.open("rb"):
2977 2977 pass
2978 2978 except:
2979 2979 warn('Could not open file <%s> for safe execution.' % fname)
2980 2980 return
2981 2981
2982 2982 # Find things also in current directory. This is needed to mimic the
2983 2983 # behavior of running a script from the system command line, where
2984 2984 # Python inserts the script's directory into sys.path
2985 2985 dname = str(fname.parent)
2986 2986
2987 2987 def get_cells():
2988 2988 """generator for sequence of code blocks to run"""
2989 2989 if fname.suffix == ".ipynb":
2990 2990 from nbformat import read
2991 2991 nb = read(fname, as_version=4)
2992 2992 if not nb.cells:
2993 2993 return
2994 2994 for cell in nb.cells:
2995 2995 if cell.cell_type == 'code':
2996 2996 yield cell.source
2997 2997 else:
2998 2998 yield fname.read_text(encoding="utf-8")
2999 2999
3000 3000 with prepended_to_syspath(dname):
3001 3001 try:
3002 3002 for cell in get_cells():
3003 3003 result = self.run_cell(cell, silent=True, shell_futures=shell_futures)
3004 3004 if raise_exceptions:
3005 3005 result.raise_error()
3006 3006 elif not result.success:
3007 3007 break
3008 3008 except:
3009 3009 if raise_exceptions:
3010 3010 raise
3011 3011 self.showtraceback()
3012 3012 warn('Unknown failure executing file: <%s>' % fname)
3013 3013
3014 3014 def safe_run_module(self, mod_name, where):
3015 3015 """A safe version of runpy.run_module().
3016 3016
3017 3017 This version will never throw an exception, but instead print
3018 3018 helpful error messages to the screen.
3019 3019
3020 3020 `SystemExit` exceptions with status code 0 or None are ignored.
3021 3021
3022 3022 Parameters
3023 3023 ----------
3024 3024 mod_name : string
3025 3025 The name of the module to be executed.
3026 3026 where : dict
3027 3027 The globals namespace.
3028 3028 """
3029 3029 try:
3030 3030 try:
3031 3031 where.update(
3032 3032 runpy.run_module(str(mod_name), run_name="__main__",
3033 3033 alter_sys=True)
3034 3034 )
3035 3035 except SystemExit as status:
3036 3036 if status.code:
3037 3037 raise
3038 3038 except:
3039 3039 self.showtraceback()
3040 3040 warn('Unknown failure executing module: <%s>' % mod_name)
3041 3041
3042 3042 def run_cell(
3043 3043 self,
3044 3044 raw_cell,
3045 3045 store_history=False,
3046 3046 silent=False,
3047 3047 shell_futures=True,
3048 3048 cell_id=None,
3049 3049 ):
3050 3050 """Run a complete IPython cell.
3051 3051
3052 3052 Parameters
3053 3053 ----------
3054 3054 raw_cell : str
3055 3055 The code (including IPython code such as %magic functions) to run.
3056 3056 store_history : bool
3057 3057 If True, the raw and translated cell will be stored in IPython's
3058 3058 history. For user code calling back into IPython's machinery, this
3059 3059 should be set to False.
3060 3060 silent : bool
3061 3061 If True, avoid side-effects, such as implicit displayhooks and
3062 3062 and logging. silent=True forces store_history=False.
3063 3063 shell_futures : bool
3064 3064 If True, the code will share future statements with the interactive
3065 3065 shell. It will both be affected by previous __future__ imports, and
3066 3066 any __future__ imports in the code will affect the shell. If False,
3067 3067 __future__ imports are not shared in either direction.
3068 3068
3069 3069 Returns
3070 3070 -------
3071 3071 result : :class:`ExecutionResult`
3072 3072 """
3073 3073 result = None
3074 3074 try:
3075 3075 result = self._run_cell(
3076 3076 raw_cell, store_history, silent, shell_futures, cell_id
3077 3077 )
3078 3078 finally:
3079 3079 self.events.trigger('post_execute')
3080 3080 if not silent:
3081 3081 self.events.trigger('post_run_cell', result)
3082 3082 return result
3083 3083
3084 3084 def _run_cell(
3085 3085 self,
3086 3086 raw_cell: str,
3087 3087 store_history: bool,
3088 3088 silent: bool,
3089 3089 shell_futures: bool,
3090 3090 cell_id: str,
3091 3091 ) -> ExecutionResult:
3092 3092 """Internal method to run a complete IPython cell."""
3093 3093
3094 3094 # we need to avoid calling self.transform_cell multiple time on the same thing
3095 3095 # so we need to store some results:
3096 3096 preprocessing_exc_tuple = None
3097 3097 try:
3098 3098 transformed_cell = self.transform_cell(raw_cell)
3099 3099 except Exception:
3100 3100 transformed_cell = raw_cell
3101 3101 preprocessing_exc_tuple = sys.exc_info()
3102 3102
3103 3103 assert transformed_cell is not None
3104 3104 coro = self.run_cell_async(
3105 3105 raw_cell,
3106 3106 store_history=store_history,
3107 3107 silent=silent,
3108 3108 shell_futures=shell_futures,
3109 3109 transformed_cell=transformed_cell,
3110 3110 preprocessing_exc_tuple=preprocessing_exc_tuple,
3111 3111 cell_id=cell_id,
3112 3112 )
3113 3113
3114 3114 # run_cell_async is async, but may not actually need an eventloop.
3115 3115 # when this is the case, we want to run it using the pseudo_sync_runner
3116 3116 # so that code can invoke eventloops (for example via the %run , and
3117 3117 # `%paste` magic.
3118 3118 if self.trio_runner:
3119 3119 runner = self.trio_runner
3120 3120 elif self.should_run_async(
3121 3121 raw_cell,
3122 3122 transformed_cell=transformed_cell,
3123 3123 preprocessing_exc_tuple=preprocessing_exc_tuple,
3124 3124 ):
3125 3125 runner = self.loop_runner
3126 3126 else:
3127 3127 runner = _pseudo_sync_runner
3128 3128
3129 3129 try:
3130 3130 result = runner(coro)
3131 3131 except BaseException as e:
3132 3132 info = ExecutionInfo(
3133 3133 raw_cell, store_history, silent, shell_futures, cell_id
3134 3134 )
3135 3135 result = ExecutionResult(info)
3136 3136 result.error_in_exec = e
3137 3137 self.showtraceback(running_compiled_code=True)
3138 3138 finally:
3139 3139 return result
3140 3140
3141 3141 def should_run_async(
3142 3142 self, raw_cell: str, *, transformed_cell=None, preprocessing_exc_tuple=None
3143 3143 ) -> bool:
3144 3144 """Return whether a cell should be run asynchronously via a coroutine runner
3145 3145
3146 3146 Parameters
3147 3147 ----------
3148 3148 raw_cell : str
3149 3149 The code to be executed
3150 3150
3151 3151 Returns
3152 3152 -------
3153 3153 result: bool
3154 3154 Whether the code needs to be run with a coroutine runner or not
3155 3155 .. versionadded:: 7.0
3156 3156 """
3157 3157 if not self.autoawait:
3158 3158 return False
3159 3159 if preprocessing_exc_tuple is not None:
3160 3160 return False
3161 3161 assert preprocessing_exc_tuple is None
3162 3162 if transformed_cell is None:
3163 3163 warnings.warn(
3164 3164 "`should_run_async` will not call `transform_cell`"
3165 3165 " automatically in the future. Please pass the result to"
3166 3166 " `transformed_cell` argument and any exception that happen"
3167 3167 " during the"
3168 3168 "transform in `preprocessing_exc_tuple` in"
3169 3169 " IPython 7.17 and above.",
3170 3170 DeprecationWarning,
3171 3171 stacklevel=2,
3172 3172 )
3173 3173 try:
3174 3174 cell = self.transform_cell(raw_cell)
3175 3175 except Exception:
3176 3176 # any exception during transform will be raised
3177 3177 # prior to execution
3178 3178 return False
3179 3179 else:
3180 3180 cell = transformed_cell
3181 3181 return _should_be_async(cell)
3182 3182
3183 3183 async def run_cell_async(
3184 3184 self,
3185 3185 raw_cell: str,
3186 3186 store_history=False,
3187 3187 silent=False,
3188 3188 shell_futures=True,
3189 3189 *,
3190 3190 transformed_cell: Optional[str] = None,
3191 3191 preprocessing_exc_tuple: Optional[AnyType] = None,
3192 3192 cell_id=None,
3193 3193 ) -> ExecutionResult:
3194 3194 """Run a complete IPython cell asynchronously.
3195 3195
3196 3196 Parameters
3197 3197 ----------
3198 3198 raw_cell : str
3199 3199 The code (including IPython code such as %magic functions) to run.
3200 3200 store_history : bool
3201 3201 If True, the raw and translated cell will be stored in IPython's
3202 3202 history. For user code calling back into IPython's machinery, this
3203 3203 should be set to False.
3204 3204 silent : bool
3205 3205 If True, avoid side-effects, such as implicit displayhooks and
3206 3206 and logging. silent=True forces store_history=False.
3207 3207 shell_futures : bool
3208 3208 If True, the code will share future statements with the interactive
3209 3209 shell. It will both be affected by previous __future__ imports, and
3210 3210 any __future__ imports in the code will affect the shell. If False,
3211 3211 __future__ imports are not shared in either direction.
3212 3212 transformed_cell: str
3213 3213 cell that was passed through transformers
3214 3214 preprocessing_exc_tuple:
3215 3215 trace if the transformation failed.
3216 3216
3217 3217 Returns
3218 3218 -------
3219 3219 result : :class:`ExecutionResult`
3220 3220
3221 3221 .. versionadded:: 7.0
3222 3222 """
3223 3223 info = ExecutionInfo(raw_cell, store_history, silent, shell_futures, cell_id)
3224 3224 result = ExecutionResult(info)
3225 3225
3226 3226 if (not raw_cell) or raw_cell.isspace():
3227 3227 self.last_execution_succeeded = True
3228 3228 self.last_execution_result = result
3229 3229 return result
3230 3230
3231 3231 if silent:
3232 3232 store_history = False
3233 3233
3234 3234 if store_history:
3235 3235 result.execution_count = self.execution_count
3236 3236
3237 3237 def error_before_exec(value):
3238 3238 if store_history:
3239 3239 self.execution_count += 1
3240 3240 result.error_before_exec = value
3241 3241 self.last_execution_succeeded = False
3242 3242 self.last_execution_result = result
3243 3243 return result
3244 3244
3245 3245 self.events.trigger('pre_execute')
3246 3246 if not silent:
3247 3247 self.events.trigger('pre_run_cell', info)
3248 3248
3249 3249 if transformed_cell is None:
3250 3250 warnings.warn(
3251 3251 "`run_cell_async` will not call `transform_cell`"
3252 3252 " automatically in the future. Please pass the result to"
3253 3253 " `transformed_cell` argument and any exception that happen"
3254 3254 " during the"
3255 3255 "transform in `preprocessing_exc_tuple` in"
3256 3256 " IPython 7.17 and above.",
3257 3257 DeprecationWarning,
3258 3258 stacklevel=2,
3259 3259 )
3260 3260 # If any of our input transformation (input_transformer_manager or
3261 3261 # prefilter_manager) raises an exception, we store it in this variable
3262 3262 # so that we can display the error after logging the input and storing
3263 3263 # it in the history.
3264 3264 try:
3265 3265 cell = self.transform_cell(raw_cell)
3266 3266 except Exception:
3267 3267 preprocessing_exc_tuple = sys.exc_info()
3268 3268 cell = raw_cell # cell has to exist so it can be stored/logged
3269 3269 else:
3270 3270 preprocessing_exc_tuple = None
3271 3271 else:
3272 3272 if preprocessing_exc_tuple is None:
3273 3273 cell = transformed_cell
3274 3274 else:
3275 3275 cell = raw_cell
3276 3276
3277 3277 # Do NOT store paste/cpaste magic history
3278 3278 if "get_ipython().run_line_magic(" in cell and "paste" in cell:
3279 3279 store_history = False
3280 3280
3281 3281 # Store raw and processed history
3282 3282 if store_history:
3283 3283 assert self.history_manager is not None
3284 3284 self.history_manager.store_inputs(self.execution_count, cell, raw_cell)
3285 3285 if not silent:
3286 3286 self.logger.log(cell, raw_cell)
3287 3287
3288 3288 # Display the exception if input processing failed.
3289 3289 if preprocessing_exc_tuple is not None:
3290 3290 self.showtraceback(preprocessing_exc_tuple)
3291 3291 if store_history:
3292 3292 self.execution_count += 1
3293 3293 return error_before_exec(preprocessing_exc_tuple[1])
3294 3294
3295 3295 # Our own compiler remembers the __future__ environment. If we want to
3296 3296 # run code with a separate __future__ environment, use the default
3297 3297 # compiler
3298 3298 compiler = self.compile if shell_futures else self.compiler_class()
3299 3299
3300 3300 with self.builtin_trap:
3301 3301 cell_name = compiler.cache(cell, self.execution_count, raw_code=raw_cell)
3302 3302
3303 3303 with self.display_trap:
3304 3304 # Compile to bytecode
3305 3305 try:
3306 3306 code_ast = compiler.ast_parse(cell, filename=cell_name)
3307 3307 except self.custom_exceptions as e:
3308 3308 etype, value, tb = sys.exc_info()
3309 3309 self.CustomTB(etype, value, tb)
3310 3310 return error_before_exec(e)
3311 3311 except IndentationError as e:
3312 3312 self.showindentationerror()
3313 3313 return error_before_exec(e)
3314 3314 except (OverflowError, SyntaxError, ValueError, TypeError,
3315 3315 MemoryError) as e:
3316 3316 self.showsyntaxerror()
3317 3317 return error_before_exec(e)
3318 3318
3319 3319 # Apply AST transformations
3320 3320 try:
3321 3321 code_ast = self.transform_ast(code_ast)
3322 3322 except InputRejected as e:
3323 3323 self.showtraceback()
3324 3324 return error_before_exec(e)
3325 3325
3326 3326 # Give the displayhook a reference to our ExecutionResult so it
3327 3327 # can fill in the output value.
3328 3328 self.displayhook.exec_result = result
3329 3329
3330 3330 # Execute the user code
3331 3331 interactivity = "none" if silent else self.ast_node_interactivity
3332 3332
3333 3333
3334 3334 has_raised = await self.run_ast_nodes(code_ast.body, cell_name,
3335 3335 interactivity=interactivity, compiler=compiler, result=result)
3336 3336
3337 3337 self.last_execution_succeeded = not has_raised
3338 3338 self.last_execution_result = result
3339 3339
3340 3340 # Reset this so later displayed values do not modify the
3341 3341 # ExecutionResult
3342 3342 self.displayhook.exec_result = None
3343 3343
3344 3344 if store_history:
3345 3345 assert self.history_manager is not None
3346 3346 # Write output to the database. Does nothing unless
3347 3347 # history output logging is enabled.
3348 3348 self.history_manager.store_output(self.execution_count)
3349 3349 # Each cell is a *single* input, regardless of how many lines it has
3350 3350 self.execution_count += 1
3351 3351
3352 3352 return result
3353 3353
3354 3354 def transform_cell(self, raw_cell):
3355 3355 """Transform an input cell before parsing it.
3356 3356
3357 3357 Static transformations, implemented in IPython.core.inputtransformer2,
3358 3358 deal with things like ``%magic`` and ``!system`` commands.
3359 3359 These run on all input.
3360 3360 Dynamic transformations, for things like unescaped magics and the exit
3361 3361 autocall, depend on the state of the interpreter.
3362 3362 These only apply to single line inputs.
3363 3363
3364 3364 These string-based transformations are followed by AST transformations;
3365 3365 see :meth:`transform_ast`.
3366 3366 """
3367 3367 # Static input transformations
3368 3368 cell = self.input_transformer_manager.transform_cell(raw_cell)
3369 3369
3370 3370 if len(cell.splitlines()) == 1:
3371 3371 # Dynamic transformations - only applied for single line commands
3372 3372 with self.builtin_trap:
3373 3373 # use prefilter_lines to handle trailing newlines
3374 3374 # restore trailing newline for ast.parse
3375 3375 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
3376 3376
3377 3377 lines = cell.splitlines(keepends=True)
3378 3378 for transform in self.input_transformers_post:
3379 3379 lines = transform(lines)
3380 3380 cell = ''.join(lines)
3381 3381
3382 3382 return cell
3383 3383
3384 3384 def transform_ast(self, node):
3385 3385 """Apply the AST transformations from self.ast_transformers
3386 3386
3387 3387 Parameters
3388 3388 ----------
3389 3389 node : ast.Node
3390 3390 The root node to be transformed. Typically called with the ast.Module
3391 3391 produced by parsing user input.
3392 3392
3393 3393 Returns
3394 3394 -------
3395 3395 An ast.Node corresponding to the node it was called with. Note that it
3396 3396 may also modify the passed object, so don't rely on references to the
3397 3397 original AST.
3398 3398 """
3399 3399 for transformer in self.ast_transformers:
3400 3400 try:
3401 3401 node = transformer.visit(node)
3402 3402 except InputRejected:
3403 3403 # User-supplied AST transformers can reject an input by raising
3404 3404 # an InputRejected. Short-circuit in this case so that we
3405 3405 # don't unregister the transform.
3406 3406 raise
3407 3407 except Exception as e:
3408 3408 warn(
3409 3409 "AST transformer %r threw an error. It will be unregistered. %s"
3410 3410 % (transformer, e)
3411 3411 )
3412 3412 self.ast_transformers.remove(transformer)
3413 3413
3414 3414 if self.ast_transformers:
3415 3415 ast.fix_missing_locations(node)
3416 3416 return node
3417 3417
3418 3418 async def run_ast_nodes(
3419 3419 self,
3420 3420 nodelist: ListType[stmt],
3421 3421 cell_name: str,
3422 3422 interactivity="last_expr",
3423 3423 compiler=compile,
3424 3424 result=None,
3425 3425 ):
3426 3426 """Run a sequence of AST nodes. The execution mode depends on the
3427 3427 interactivity parameter.
3428 3428
3429 3429 Parameters
3430 3430 ----------
3431 3431 nodelist : list
3432 3432 A sequence of AST nodes to run.
3433 3433 cell_name : str
3434 3434 Will be passed to the compiler as the filename of the cell. Typically
3435 3435 the value returned by ip.compile.cache(cell).
3436 3436 interactivity : str
3437 3437 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none',
3438 3438 specifying which nodes should be run interactively (displaying output
3439 3439 from expressions). 'last_expr' will run the last node interactively
3440 3440 only if it is an expression (i.e. expressions in loops or other blocks
3441 3441 are not displayed) 'last_expr_or_assign' will run the last expression
3442 3442 or the last assignment. Other values for this parameter will raise a
3443 3443 ValueError.
3444 3444
3445 3445 compiler : callable
3446 3446 A function with the same interface as the built-in compile(), to turn
3447 3447 the AST nodes into code objects. Default is the built-in compile().
3448 3448 result : ExecutionResult, optional
3449 3449 An object to store exceptions that occur during execution.
3450 3450
3451 3451 Returns
3452 3452 -------
3453 3453 True if an exception occurred while running code, False if it finished
3454 3454 running.
3455 3455 """
3456 3456 if not nodelist:
3457 3457 return
3458 3458
3459 3459
3460 3460 if interactivity == 'last_expr_or_assign':
3461 3461 if isinstance(nodelist[-1], _assign_nodes):
3462 3462 asg = nodelist[-1]
3463 3463 if isinstance(asg, ast.Assign) and len(asg.targets) == 1:
3464 3464 target = asg.targets[0]
3465 3465 elif isinstance(asg, _single_targets_nodes):
3466 3466 target = asg.target
3467 3467 else:
3468 3468 target = None
3469 3469 if isinstance(target, ast.Name):
3470 3470 nnode = ast.Expr(ast.Name(target.id, ast.Load()))
3471 3471 ast.fix_missing_locations(nnode)
3472 3472 nodelist.append(nnode)
3473 3473 interactivity = 'last_expr'
3474 3474
3475 3475 _async = False
3476 3476 if interactivity == 'last_expr':
3477 3477 if isinstance(nodelist[-1], ast.Expr):
3478 3478 interactivity = "last"
3479 3479 else:
3480 3480 interactivity = "none"
3481 3481
3482 3482 if interactivity == 'none':
3483 3483 to_run_exec, to_run_interactive = nodelist, []
3484 3484 elif interactivity == 'last':
3485 3485 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
3486 3486 elif interactivity == 'all':
3487 3487 to_run_exec, to_run_interactive = [], nodelist
3488 3488 else:
3489 3489 raise ValueError("Interactivity was %r" % interactivity)
3490 3490
3491 3491 try:
3492 3492
3493 3493 def compare(code):
3494 3494 is_async = inspect.CO_COROUTINE & code.co_flags == inspect.CO_COROUTINE
3495 3495 return is_async
3496 3496
3497 3497 # refactor that to just change the mod constructor.
3498 3498 to_run = []
3499 3499 for node in to_run_exec:
3500 3500 to_run.append((node, "exec"))
3501 3501
3502 3502 for node in to_run_interactive:
3503 3503 to_run.append((node, "single"))
3504 3504
3505 3505 for node, mode in to_run:
3506 3506 if mode == "exec":
3507 3507 mod = Module([node], [])
3508 3508 elif mode == "single":
3509 3509 mod = ast.Interactive([node]) # type: ignore
3510 3510 with compiler.extra_flags(
3511 3511 getattr(ast, "PyCF_ALLOW_TOP_LEVEL_AWAIT", 0x0)
3512 3512 if self.autoawait
3513 3513 else 0x0
3514 3514 ):
3515 3515 code = compiler(mod, cell_name, mode)
3516 3516 asy = compare(code)
3517 3517 if await self.run_code(code, result, async_=asy):
3518 3518 return True
3519 3519
3520 3520 # Flush softspace
3521 3521 if softspace(sys.stdout, 0):
3522 3522 print()
3523 3523
3524 3524 except:
3525 3525 # It's possible to have exceptions raised here, typically by
3526 3526 # compilation of odd code (such as a naked 'return' outside a
3527 3527 # function) that did parse but isn't valid. Typically the exception
3528 3528 # is a SyntaxError, but it's safest just to catch anything and show
3529 3529 # the user a traceback.
3530 3530
3531 3531 # We do only one try/except outside the loop to minimize the impact
3532 3532 # on runtime, and also because if any node in the node list is
3533 3533 # broken, we should stop execution completely.
3534 3534 if result:
3535 3535 result.error_before_exec = sys.exc_info()[1]
3536 3536 self.showtraceback()
3537 3537 return True
3538 3538
3539 3539 return False
3540 3540
3541 3541 async def run_code(self, code_obj, result=None, *, async_=False):
3542 3542 """Execute a code object.
3543 3543
3544 3544 When an exception occurs, self.showtraceback() is called to display a
3545 3545 traceback.
3546 3546
3547 3547 Parameters
3548 3548 ----------
3549 3549 code_obj : code object
3550 3550 A compiled code object, to be executed
3551 3551 result : ExecutionResult, optional
3552 3552 An object to store exceptions that occur during execution.
3553 3553 async_ : Bool (Experimental)
3554 3554 Attempt to run top-level asynchronous code in a default loop.
3555 3555
3556 3556 Returns
3557 3557 -------
3558 3558 False : successful execution.
3559 3559 True : an error occurred.
3560 3560 """
3561 3561 # special value to say that anything above is IPython and should be
3562 3562 # hidden.
3563 3563 __tracebackhide__ = "__ipython_bottom__"
3564 3564 # Set our own excepthook in case the user code tries to call it
3565 3565 # directly, so that the IPython crash handler doesn't get triggered
3566 3566 old_excepthook, sys.excepthook = sys.excepthook, self.excepthook
3567 3567
3568 3568 # we save the original sys.excepthook in the instance, in case config
3569 3569 # code (such as magics) needs access to it.
3570 3570 self.sys_excepthook = old_excepthook
3571 3571 outflag = True # happens in more places, so it's easier as default
3572 3572 try:
3573 3573 try:
3574 3574 if async_:
3575 3575 await eval(code_obj, self.user_global_ns, self.user_ns)
3576 3576 else:
3577 3577 exec(code_obj, self.user_global_ns, self.user_ns)
3578 3578 finally:
3579 3579 # Reset our crash handler in place
3580 3580 sys.excepthook = old_excepthook
3581 3581 except SystemExit as e:
3582 3582 if result is not None:
3583 3583 result.error_in_exec = e
3584 3584 self.showtraceback(exception_only=True)
3585 3585 warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1)
3586 3586 except bdb.BdbQuit:
3587 3587 etype, value, tb = sys.exc_info()
3588 3588 if result is not None:
3589 3589 result.error_in_exec = value
3590 3590 # the BdbQuit stops here
3591 3591 except self.custom_exceptions:
3592 3592 etype, value, tb = sys.exc_info()
3593 3593 if result is not None:
3594 3594 result.error_in_exec = value
3595 3595 self.CustomTB(etype, value, tb)
3596 3596 except:
3597 3597 if result is not None:
3598 3598 result.error_in_exec = sys.exc_info()[1]
3599 3599 self.showtraceback(running_compiled_code=True)
3600 3600 else:
3601 3601 outflag = False
3602 3602 return outflag
3603 3603
3604 3604 # For backwards compatibility
3605 3605 runcode = run_code
3606 3606
3607 3607 def check_complete(self, code: str) -> Tuple[str, str]:
3608 3608 """Return whether a block of code is ready to execute, or should be continued
3609 3609
3610 3610 Parameters
3611 3611 ----------
3612 3612 code : string
3613 3613 Python input code, which can be multiline.
3614 3614
3615 3615 Returns
3616 3616 -------
3617 3617 status : str
3618 3618 One of 'complete', 'incomplete', or 'invalid' if source is not a
3619 3619 prefix of valid code.
3620 3620 indent : str
3621 3621 When status is 'incomplete', this is some whitespace to insert on
3622 3622 the next line of the prompt.
3623 3623 """
3624 3624 status, nspaces = self.input_transformer_manager.check_complete(code)
3625 3625 return status, ' ' * (nspaces or 0)
3626 3626
3627 3627 #-------------------------------------------------------------------------
3628 3628 # Things related to GUI support and pylab
3629 3629 #-------------------------------------------------------------------------
3630 3630
3631 3631 active_eventloop: Optional[str] = None
3632 3632
3633 3633 def enable_gui(self, gui=None):
3634 3634 raise NotImplementedError('Implement enable_gui in a subclass')
3635 3635
3636 3636 def enable_matplotlib(self, gui=None):
3637 3637 """Enable interactive matplotlib and inline figure support.
3638 3638
3639 3639 This takes the following steps:
3640 3640
3641 3641 1. select the appropriate eventloop and matplotlib backend
3642 3642 2. set up matplotlib for interactive use with that backend
3643 3643 3. configure formatters for inline figure display
3644 3644 4. enable the selected gui eventloop
3645 3645
3646 3646 Parameters
3647 3647 ----------
3648 3648 gui : optional, string
3649 3649 If given, dictates the choice of matplotlib GUI backend to use
3650 3650 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
3651 3651 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
3652 3652 matplotlib (as dictated by the matplotlib build-time options plus the
3653 3653 user's matplotlibrc configuration file). Note that not all backends
3654 3654 make sense in all contexts, for example a terminal ipython can't
3655 3655 display figures inline.
3656 3656 """
3657 from .pylabtools import _matplotlib_manages_backends
3658
3659 if not _matplotlib_manages_backends() and gui in (None, "auto"):
3660 # Early import of backend_inline required for its side effect of
3661 # calling _enable_matplotlib_integration()
3662 import matplotlib_inline.backend_inline
3663
3657 3664 from IPython.core import pylabtools as pt
3658 3665 gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select)
3659 3666
3660 3667 if gui != None:
3661 3668 # If we have our first gui selection, store it
3662 3669 if self.pylab_gui_select is None:
3663 3670 self.pylab_gui_select = gui
3664 3671 # Otherwise if they are different
3665 3672 elif gui != self.pylab_gui_select:
3666 3673 print('Warning: Cannot change to a different GUI toolkit: %s.'
3667 3674 ' Using %s instead.' % (gui, self.pylab_gui_select))
3668 3675 gui, backend = pt.find_gui_and_backend(self.pylab_gui_select)
3669 3676
3670 3677 pt.activate_matplotlib(backend)
3671 3678
3672 3679 from matplotlib_inline.backend_inline import configure_inline_support
3673 3680
3674 3681 configure_inline_support(self, backend)
3675 3682
3676 3683 # Now we must activate the gui pylab wants to use, and fix %run to take
3677 3684 # plot updates into account
3678 3685 self.enable_gui(gui)
3679 3686 self.magics_manager.registry['ExecutionMagics'].default_runner = \
3680 3687 pt.mpl_runner(self.safe_execfile)
3681 3688
3682 3689 return gui, backend
3683 3690
3684 3691 def enable_pylab(self, gui=None, import_all=True, welcome_message=False):
3685 3692 """Activate pylab support at runtime.
3686 3693
3687 3694 This turns on support for matplotlib, preloads into the interactive
3688 3695 namespace all of numpy and pylab, and configures IPython to correctly
3689 3696 interact with the GUI event loop. The GUI backend to be used can be
3690 3697 optionally selected with the optional ``gui`` argument.
3691 3698
3692 3699 This method only adds preloading the namespace to InteractiveShell.enable_matplotlib.
3693 3700
3694 3701 Parameters
3695 3702 ----------
3696 3703 gui : optional, string
3697 3704 If given, dictates the choice of matplotlib GUI backend to use
3698 3705 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
3699 3706 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
3700 3707 matplotlib (as dictated by the matplotlib build-time options plus the
3701 3708 user's matplotlibrc configuration file). Note that not all backends
3702 3709 make sense in all contexts, for example a terminal ipython can't
3703 3710 display figures inline.
3704 3711 import_all : optional, bool, default: True
3705 3712 Whether to do `from numpy import *` and `from pylab import *`
3706 3713 in addition to module imports.
3707 3714 welcome_message : deprecated
3708 3715 This argument is ignored, no welcome message will be displayed.
3709 3716 """
3710 3717 from IPython.core.pylabtools import import_pylab
3711 3718
3712 3719 gui, backend = self.enable_matplotlib(gui)
3713 3720
3714 3721 # We want to prevent the loading of pylab to pollute the user's
3715 3722 # namespace as shown by the %who* magics, so we execute the activation
3716 3723 # code in an empty namespace, and we update *both* user_ns and
3717 3724 # user_ns_hidden with this information.
3718 3725 ns = {}
3719 3726 import_pylab(ns, import_all)
3720 3727 # warn about clobbered names
3721 3728 ignored = {"__builtins__"}
3722 3729 both = set(ns).intersection(self.user_ns).difference(ignored)
3723 3730 clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ]
3724 3731 self.user_ns.update(ns)
3725 3732 self.user_ns_hidden.update(ns)
3726 3733 return gui, backend, clobbered
3727 3734
3728 3735 #-------------------------------------------------------------------------
3729 3736 # Utilities
3730 3737 #-------------------------------------------------------------------------
3731 3738
3732 3739 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
3733 3740 """Expand python variables in a string.
3734 3741
3735 3742 The depth argument indicates how many frames above the caller should
3736 3743 be walked to look for the local namespace where to expand variables.
3737 3744
3738 3745 The global namespace for expansion is always the user's interactive
3739 3746 namespace.
3740 3747 """
3741 3748 ns = self.user_ns.copy()
3742 3749 try:
3743 3750 frame = sys._getframe(depth+1)
3744 3751 except ValueError:
3745 3752 # This is thrown if there aren't that many frames on the stack,
3746 3753 # e.g. if a script called run_line_magic() directly.
3747 3754 pass
3748 3755 else:
3749 3756 ns.update(frame.f_locals)
3750 3757
3751 3758 try:
3752 3759 # We have to use .vformat() here, because 'self' is a valid and common
3753 3760 # name, and expanding **ns for .format() would make it collide with
3754 3761 # the 'self' argument of the method.
3755 3762 cmd = formatter.vformat(cmd, args=[], kwargs=ns)
3756 3763 except Exception:
3757 3764 # if formatter couldn't format, just let it go untransformed
3758 3765 pass
3759 3766 return cmd
3760 3767
3761 3768 def mktempfile(self, data=None, prefix='ipython_edit_'):
3762 3769 """Make a new tempfile and return its filename.
3763 3770
3764 3771 This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp),
3765 3772 but it registers the created filename internally so ipython cleans it up
3766 3773 at exit time.
3767 3774
3768 3775 Optional inputs:
3769 3776
3770 3777 - data(None): if data is given, it gets written out to the temp file
3771 3778 immediately, and the file is closed again."""
3772 3779
3773 3780 dir_path = Path(tempfile.mkdtemp(prefix=prefix))
3774 3781 self.tempdirs.append(dir_path)
3775 3782
3776 3783 handle, filename = tempfile.mkstemp(".py", prefix, dir=str(dir_path))
3777 3784 os.close(handle) # On Windows, there can only be one open handle on a file
3778 3785
3779 3786 file_path = Path(filename)
3780 3787 self.tempfiles.append(file_path)
3781 3788
3782 3789 if data:
3783 3790 file_path.write_text(data, encoding="utf-8")
3784 3791 return filename
3785 3792
3786 3793 def ask_yes_no(self, prompt, default=None, interrupt=None):
3787 3794 if self.quiet:
3788 3795 return True
3789 3796 return ask_yes_no(prompt,default,interrupt)
3790 3797
3791 3798 def show_usage(self):
3792 3799 """Show a usage message"""
3793 3800 page.page(IPython.core.usage.interactive_usage)
3794 3801
3795 3802 def extract_input_lines(self, range_str, raw=False):
3796 3803 """Return as a string a set of input history slices.
3797 3804
3798 3805 Parameters
3799 3806 ----------
3800 3807 range_str : str
3801 3808 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
3802 3809 since this function is for use by magic functions which get their
3803 3810 arguments as strings. The number before the / is the session
3804 3811 number: ~n goes n back from the current session.
3805 3812
3806 3813 If empty string is given, returns history of current session
3807 3814 without the last input.
3808 3815
3809 3816 raw : bool, optional
3810 3817 By default, the processed input is used. If this is true, the raw
3811 3818 input history is used instead.
3812 3819
3813 3820 Notes
3814 3821 -----
3815 3822 Slices can be described with two notations:
3816 3823
3817 3824 * ``N:M`` -> standard python form, means including items N...(M-1).
3818 3825 * ``N-M`` -> include items N..M (closed endpoint).
3819 3826 """
3820 3827 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
3821 3828 text = "\n".join(x for _, _, x in lines)
3822 3829
3823 3830 # Skip the last line, as it's probably the magic that called this
3824 3831 if not range_str:
3825 3832 if "\n" not in text:
3826 3833 text = ""
3827 3834 else:
3828 3835 text = text[: text.rfind("\n")]
3829 3836
3830 3837 return text
3831 3838
3832 3839 def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False):
3833 3840 """Get a code string from history, file, url, or a string or macro.
3834 3841
3835 3842 This is mainly used by magic functions.
3836 3843
3837 3844 Parameters
3838 3845 ----------
3839 3846 target : str
3840 3847 A string specifying code to retrieve. This will be tried respectively
3841 3848 as: ranges of input history (see %history for syntax), url,
3842 3849 corresponding .py file, filename, or an expression evaluating to a
3843 3850 string or Macro in the user namespace.
3844 3851
3845 3852 If empty string is given, returns complete history of current
3846 3853 session, without the last line.
3847 3854
3848 3855 raw : bool
3849 3856 If true (default), retrieve raw history. Has no effect on the other
3850 3857 retrieval mechanisms.
3851 3858
3852 3859 py_only : bool (default False)
3853 3860 Only try to fetch python code, do not try alternative methods to decode file
3854 3861 if unicode fails.
3855 3862
3856 3863 Returns
3857 3864 -------
3858 3865 A string of code.
3859 3866 ValueError is raised if nothing is found, and TypeError if it evaluates
3860 3867 to an object of another type. In each case, .args[0] is a printable
3861 3868 message.
3862 3869 """
3863 3870 code = self.extract_input_lines(target, raw=raw) # Grab history
3864 3871 if code:
3865 3872 return code
3866 3873 try:
3867 3874 if target.startswith(('http://', 'https://')):
3868 3875 return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie)
3869 3876 except UnicodeDecodeError as e:
3870 3877 if not py_only :
3871 3878 # Deferred import
3872 3879 from urllib.request import urlopen
3873 3880 response = urlopen(target)
3874 3881 return response.read().decode('latin1')
3875 3882 raise ValueError(("'%s' seem to be unreadable.") % target) from e
3876 3883
3877 3884 potential_target = [target]
3878 3885 try :
3879 3886 potential_target.insert(0,get_py_filename(target))
3880 3887 except IOError:
3881 3888 pass
3882 3889
3883 3890 for tgt in potential_target :
3884 3891 if os.path.isfile(tgt): # Read file
3885 3892 try :
3886 3893 return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie)
3887 3894 except UnicodeDecodeError as e:
3888 3895 if not py_only :
3889 3896 with io_open(tgt,'r', encoding='latin1') as f :
3890 3897 return f.read()
3891 3898 raise ValueError(("'%s' seem to be unreadable.") % target) from e
3892 3899 elif os.path.isdir(os.path.expanduser(tgt)):
3893 3900 raise ValueError("'%s' is a directory, not a regular file." % target)
3894 3901
3895 3902 if search_ns:
3896 3903 # Inspect namespace to load object source
3897 3904 object_info = self.object_inspect(target, detail_level=1)
3898 3905 if object_info['found'] and object_info['source']:
3899 3906 return object_info['source']
3900 3907
3901 3908 try: # User namespace
3902 3909 codeobj = eval(target, self.user_ns)
3903 3910 except Exception as e:
3904 3911 raise ValueError(("'%s' was not found in history, as a file, url, "
3905 3912 "nor in the user namespace.") % target) from e
3906 3913
3907 3914 if isinstance(codeobj, str):
3908 3915 return codeobj
3909 3916 elif isinstance(codeobj, Macro):
3910 3917 return codeobj.value
3911 3918
3912 3919 raise TypeError("%s is neither a string nor a macro." % target,
3913 3920 codeobj)
3914 3921
3915 3922 def _atexit_once(self):
3916 3923 """
3917 3924 At exist operation that need to be called at most once.
3918 3925 Second call to this function per instance will do nothing.
3919 3926 """
3920 3927
3921 3928 if not getattr(self, "_atexit_once_called", False):
3922 3929 self._atexit_once_called = True
3923 3930 # Clear all user namespaces to release all references cleanly.
3924 3931 self.reset(new_session=False)
3925 3932 # Close the history session (this stores the end time and line count)
3926 3933 # this must be *before* the tempfile cleanup, in case of temporary
3927 3934 # history db
3928 3935 self.history_manager.end_session()
3929 3936 self.history_manager = None
3930 3937
3931 3938 #-------------------------------------------------------------------------
3932 3939 # Things related to IPython exiting
3933 3940 #-------------------------------------------------------------------------
3934 3941 def atexit_operations(self):
3935 3942 """This will be executed at the time of exit.
3936 3943
3937 3944 Cleanup operations and saving of persistent data that is done
3938 3945 unconditionally by IPython should be performed here.
3939 3946
3940 3947 For things that may depend on startup flags or platform specifics (such
3941 3948 as having readline or not), register a separate atexit function in the
3942 3949 code that has the appropriate information, rather than trying to
3943 3950 clutter
3944 3951 """
3945 3952 self._atexit_once()
3946 3953
3947 3954 # Cleanup all tempfiles and folders left around
3948 3955 for tfile in self.tempfiles:
3949 3956 try:
3950 3957 tfile.unlink()
3951 3958 self.tempfiles.remove(tfile)
3952 3959 except FileNotFoundError:
3953 3960 pass
3954 3961 del self.tempfiles
3955 3962 for tdir in self.tempdirs:
3956 3963 try:
3957 3964 shutil.rmtree(tdir)
3958 3965 self.tempdirs.remove(tdir)
3959 3966 except FileNotFoundError:
3960 3967 pass
3961 3968 del self.tempdirs
3962 3969
3963 3970 # Restore user's cursor
3964 3971 if hasattr(self, "editing_mode") and self.editing_mode == "vi":
3965 3972 sys.stdout.write("\x1b[0 q")
3966 3973 sys.stdout.flush()
3967 3974
3968 3975 def cleanup(self):
3969 3976 self.restore_sys_module_state()
3970 3977
3971 3978
3972 3979 # Overridden in terminal subclass to change prompts
3973 3980 def switch_doctest_mode(self, mode):
3974 3981 pass
3975 3982
3976 3983
3977 3984 class InteractiveShellABC(metaclass=abc.ABCMeta):
3978 3985 """An abstract base class for InteractiveShell."""
3979 3986
3980 3987 InteractiveShellABC.register(InteractiveShell)
General Comments 0
You need to be logged in to leave comments. Login now