Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/IPython/terminal/interactiveshell.py: 37%
400 statements
« prev ^ index » next coverage.py v7.2.2, created at 2023-03-26 06:07 +0000
« prev ^ index » next coverage.py v7.2.2, created at 2023-03-26 06:07 +0000
1"""IPython terminal interface using prompt_toolkit"""
3import asyncio
4import os
5import sys
6from warnings import warn
7from typing import Union as UnionType
9from IPython.core.async_helpers import get_asyncio_loop
10from IPython.core.interactiveshell import InteractiveShell, InteractiveShellABC
11from IPython.utils.py3compat import input
12from IPython.utils.terminal import toggle_set_term_title, set_term_title, restore_term_title
13from IPython.utils.process import abbrev_cwd
14from traitlets import (
15 Bool,
16 Unicode,
17 Dict,
18 Integer,
19 List,
20 observe,
21 Instance,
22 Type,
23 default,
24 Enum,
25 Union,
26 Any,
27 validate,
28 Float,
29)
31from prompt_toolkit.auto_suggest import AutoSuggestFromHistory
32from prompt_toolkit.enums import DEFAULT_BUFFER, EditingMode
33from prompt_toolkit.filters import HasFocus, Condition, IsDone
34from prompt_toolkit.formatted_text import PygmentsTokens
35from prompt_toolkit.history import History
36from prompt_toolkit.layout.processors import ConditionalProcessor, HighlightMatchingBracketProcessor
37from prompt_toolkit.output import ColorDepth
38from prompt_toolkit.patch_stdout import patch_stdout
39from prompt_toolkit.shortcuts import PromptSession, CompleteStyle, print_formatted_text
40from prompt_toolkit.styles import DynamicStyle, merge_styles
41from prompt_toolkit.styles.pygments import style_from_pygments_cls, style_from_pygments_dict
42from prompt_toolkit import __version__ as ptk_version
44from pygments.styles import get_style_by_name
45from pygments.style import Style
46from pygments.token import Token
48from .debugger import TerminalPdb, Pdb
49from .magics import TerminalMagics
50from .pt_inputhooks import get_inputhook_name_and_func
51from .prompts import Prompts, ClassicPrompts, RichPromptDisplayHook
52from .ptutils import IPythonPTCompleter, IPythonPTLexer
53from .shortcuts import (
54 create_ipython_shortcuts,
55 create_identifier,
56 RuntimeBinding,
57 add_binding,
58)
59from .shortcuts.filters import KEYBINDING_FILTERS, filter_from_string
60from .shortcuts.auto_suggest import (
61 NavigableAutoSuggestFromHistory,
62 AppendAutoSuggestionInAnyLine,
63)
65PTK3 = ptk_version.startswith('3.')
68class _NoStyle(Style): pass
72_style_overrides_light_bg = {
73 Token.Prompt: '#ansibrightblue',
74 Token.PromptNum: '#ansiblue bold',
75 Token.OutPrompt: '#ansibrightred',
76 Token.OutPromptNum: '#ansired bold',
77}
79_style_overrides_linux = {
80 Token.Prompt: '#ansibrightgreen',
81 Token.PromptNum: '#ansigreen bold',
82 Token.OutPrompt: '#ansibrightred',
83 Token.OutPromptNum: '#ansired bold',
84}
86def get_default_editor():
87 try:
88 return os.environ['EDITOR']
89 except KeyError:
90 pass
91 except UnicodeError:
92 warn("$EDITOR environment variable is not pure ASCII. Using platform "
93 "default editor.")
95 if os.name == 'posix':
96 return 'vi' # the only one guaranteed to be there!
97 else:
98 return 'notepad' # same in Windows!
100# conservatively check for tty
101# overridden streams can result in things like:
102# - sys.stdin = None
103# - no isatty method
104for _name in ('stdin', 'stdout', 'stderr'):
105 _stream = getattr(sys, _name)
106 try:
107 if not _stream or not hasattr(_stream, "isatty") or not _stream.isatty():
108 _is_tty = False
109 break
110 except ValueError:
111 # stream is closed
112 _is_tty = False
113 break
114else:
115 _is_tty = True
118_use_simple_prompt = ('IPY_TEST_SIMPLE_PROMPT' in os.environ) or (not _is_tty)
120def black_reformat_handler(text_before_cursor):
121 """
122 We do not need to protect against error,
123 this is taken care at a higher level where any reformat error is ignored.
124 Indeed we may call reformatting on incomplete code.
125 """
126 import black
128 formatted_text = black.format_str(text_before_cursor, mode=black.FileMode())
129 if not text_before_cursor.endswith("\n") and formatted_text.endswith("\n"):
130 formatted_text = formatted_text[:-1]
131 return formatted_text
134def yapf_reformat_handler(text_before_cursor):
135 from yapf.yapflib import file_resources
136 from yapf.yapflib import yapf_api
138 style_config = file_resources.GetDefaultStyleForDir(os.getcwd())
139 formatted_text, was_formatted = yapf_api.FormatCode(
140 text_before_cursor, style_config=style_config
141 )
142 if was_formatted:
143 if not text_before_cursor.endswith("\n") and formatted_text.endswith("\n"):
144 formatted_text = formatted_text[:-1]
145 return formatted_text
146 else:
147 return text_before_cursor
150class PtkHistoryAdapter(History):
151 """
152 Prompt toolkit has it's own way of handling history, Where it assumes it can
153 Push/pull from history.
155 """
157 def __init__(self, shell):
158 super().__init__()
159 self.shell = shell
160 self._refresh()
162 def append_string(self, string):
163 # we rely on sql for that.
164 self._loaded = False
165 self._refresh()
167 def _refresh(self):
168 if not self._loaded:
169 self._loaded_strings = list(self.load_history_strings())
171 def load_history_strings(self):
172 last_cell = ""
173 res = []
174 for __, ___, cell in self.shell.history_manager.get_tail(
175 self.shell.history_load_length, include_latest=True
176 ):
177 # Ignore blank lines and consecutive duplicates
178 cell = cell.rstrip()
179 if cell and (cell != last_cell):
180 res.append(cell)
181 last_cell = cell
182 yield from res[::-1]
184 def store_string(self, string: str) -> None:
185 pass
187class TerminalInteractiveShell(InteractiveShell):
188 mime_renderers = Dict().tag(config=True)
190 space_for_menu = Integer(6, help='Number of line at the bottom of the screen '
191 'to reserve for the tab completion menu, '
192 'search history, ...etc, the height of '
193 'these menus will at most this value. '
194 'Increase it is you prefer long and skinny '
195 'menus, decrease for short and wide.'
196 ).tag(config=True)
198 pt_app: UnionType[PromptSession, None] = None
199 auto_suggest: UnionType[
200 AutoSuggestFromHistory, NavigableAutoSuggestFromHistory, None
201 ] = None
202 debugger_history = None
204 debugger_history_file = Unicode(
205 "~/.pdbhistory", help="File in which to store and read history"
206 ).tag(config=True)
208 simple_prompt = Bool(_use_simple_prompt,
209 help="""Use `raw_input` for the REPL, without completion and prompt colors.
211 Useful when controlling IPython as a subprocess, and piping STDIN/OUT/ERR. Known usage are:
212 IPython own testing machinery, and emacs inferior-shell integration through elpy.
214 This mode default to `True` if the `IPY_TEST_SIMPLE_PROMPT`
215 environment variable is set, or the current terminal is not a tty."""
216 ).tag(config=True)
218 @property
219 def debugger_cls(self):
220 return Pdb if self.simple_prompt else TerminalPdb
222 confirm_exit = Bool(True,
223 help="""
224 Set to confirm when you try to exit IPython with an EOF (Control-D
225 in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit',
226 you can force a direct exit without any confirmation.""",
227 ).tag(config=True)
229 editing_mode = Unicode('emacs',
230 help="Shortcut style to use at the prompt. 'vi' or 'emacs'.",
231 ).tag(config=True)
233 emacs_bindings_in_vi_insert_mode = Bool(
234 True,
235 help="Add shortcuts from 'emacs' insert mode to 'vi' insert mode.",
236 ).tag(config=True)
238 modal_cursor = Bool(
239 True,
240 help="""
241 Cursor shape changes depending on vi mode: beam in vi insert mode,
242 block in nav mode, underscore in replace mode.""",
243 ).tag(config=True)
245 ttimeoutlen = Float(
246 0.01,
247 help="""The time in milliseconds that is waited for a key code
248 to complete.""",
249 ).tag(config=True)
251 timeoutlen = Float(
252 0.5,
253 help="""The time in milliseconds that is waited for a mapped key
254 sequence to complete.""",
255 ).tag(config=True)
257 autoformatter = Unicode(
258 None,
259 help="Autoformatter to reformat Terminal code. Can be `'black'`, `'yapf'` or `None`",
260 allow_none=True
261 ).tag(config=True)
263 auto_match = Bool(
264 False,
265 help="""
266 Automatically add/delete closing bracket or quote when opening bracket or quote is entered/deleted.
267 Brackets: (), [], {}
268 Quotes: '', \"\"
269 """,
270 ).tag(config=True)
272 mouse_support = Bool(False,
273 help="Enable mouse support in the prompt\n(Note: prevents selecting text with the mouse)"
274 ).tag(config=True)
276 # We don't load the list of styles for the help string, because loading
277 # Pygments plugins takes time and can cause unexpected errors.
278 highlighting_style = Union([Unicode('legacy'), Type(klass=Style)],
279 help="""The name or class of a Pygments style to use for syntax
280 highlighting. To see available styles, run `pygmentize -L styles`."""
281 ).tag(config=True)
283 @validate('editing_mode')
284 def _validate_editing_mode(self, proposal):
285 if proposal['value'].lower() == 'vim':
286 proposal['value']= 'vi'
287 elif proposal['value'].lower() == 'default':
288 proposal['value']= 'emacs'
290 if hasattr(EditingMode, proposal['value'].upper()):
291 return proposal['value'].lower()
293 return self.editing_mode
296 @observe('editing_mode')
297 def _editing_mode(self, change):
298 if self.pt_app:
299 self.pt_app.editing_mode = getattr(EditingMode, change.new.upper())
301 def _set_formatter(self, formatter):
302 if formatter is None:
303 self.reformat_handler = lambda x:x
304 elif formatter == 'black':
305 self.reformat_handler = black_reformat_handler
306 elif formatter == "yapf":
307 self.reformat_handler = yapf_reformat_handler
308 else:
309 raise ValueError
311 @observe("autoformatter")
312 def _autoformatter_changed(self, change):
313 formatter = change.new
314 self._set_formatter(formatter)
316 @observe('highlighting_style')
317 @observe('colors')
318 def _highlighting_style_changed(self, change):
319 self.refresh_style()
321 def refresh_style(self):
322 self._style = self._make_style_from_name_or_cls(self.highlighting_style)
325 highlighting_style_overrides = Dict(
326 help="Override highlighting format for specific tokens"
327 ).tag(config=True)
329 true_color = Bool(False,
330 help="""Use 24bit colors instead of 256 colors in prompt highlighting.
331 If your terminal supports true color, the following command should
332 print ``TRUECOLOR`` in orange::
334 printf \"\\x1b[38;2;255;100;0mTRUECOLOR\\x1b[0m\\n\"
335 """,
336 ).tag(config=True)
338 editor = Unicode(get_default_editor(),
339 help="Set the editor used by IPython (default to $EDITOR/vi/notepad)."
340 ).tag(config=True)
342 prompts_class = Type(Prompts, help='Class used to generate Prompt token for prompt_toolkit').tag(config=True)
344 prompts = Instance(Prompts)
346 @default('prompts')
347 def _prompts_default(self):
348 return self.prompts_class(self)
350# @observe('prompts')
351# def _(self, change):
352# self._update_layout()
354 @default('displayhook_class')
355 def _displayhook_class_default(self):
356 return RichPromptDisplayHook
358 term_title = Bool(True,
359 help="Automatically set the terminal title"
360 ).tag(config=True)
362 term_title_format = Unicode("IPython: {cwd}",
363 help="Customize the terminal title format. This is a python format string. " +
364 "Available substitutions are: {cwd}."
365 ).tag(config=True)
367 display_completions = Enum(('column', 'multicolumn','readlinelike'),
368 help= ( "Options for displaying tab completions, 'column', 'multicolumn', and "
369 "'readlinelike'. These options are for `prompt_toolkit`, see "
370 "`prompt_toolkit` documentation for more information."
371 ),
372 default_value='multicolumn').tag(config=True)
374 highlight_matching_brackets = Bool(True,
375 help="Highlight matching brackets.",
376 ).tag(config=True)
378 extra_open_editor_shortcuts = Bool(False,
379 help="Enable vi (v) or Emacs (C-X C-E) shortcuts to open an external editor. "
380 "This is in addition to the F2 binding, which is always enabled."
381 ).tag(config=True)
383 handle_return = Any(None,
384 help="Provide an alternative handler to be called when the user presses "
385 "Return. This is an advanced option intended for debugging, which "
386 "may be changed or removed in later releases."
387 ).tag(config=True)
389 enable_history_search = Bool(True,
390 help="Allows to enable/disable the prompt toolkit history search"
391 ).tag(config=True)
393 autosuggestions_provider = Unicode(
394 "NavigableAutoSuggestFromHistory",
395 help="Specifies from which source automatic suggestions are provided. "
396 "Can be set to ``'NavigableAutoSuggestFromHistory'`` (:kbd:`up` and "
397 ":kbd:`down` swap suggestions), ``'AutoSuggestFromHistory'``, "
398 " or ``None`` to disable automatic suggestions. "
399 "Default is `'NavigableAutoSuggestFromHistory`'.",
400 allow_none=True,
401 ).tag(config=True)
403 def _set_autosuggestions(self, provider):
404 # disconnect old handler
405 if self.auto_suggest and isinstance(
406 self.auto_suggest, NavigableAutoSuggestFromHistory
407 ):
408 self.auto_suggest.disconnect()
409 if provider is None:
410 self.auto_suggest = None
411 elif provider == "AutoSuggestFromHistory":
412 self.auto_suggest = AutoSuggestFromHistory()
413 elif provider == "NavigableAutoSuggestFromHistory":
414 self.auto_suggest = NavigableAutoSuggestFromHistory()
415 else:
416 raise ValueError("No valid provider.")
417 if self.pt_app:
418 self.pt_app.auto_suggest = self.auto_suggest
420 @observe("autosuggestions_provider")
421 def _autosuggestions_provider_changed(self, change):
422 provider = change.new
423 self._set_autosuggestions(provider)
425 shortcuts = List(
426 trait=Dict(
427 key_trait=Enum(
428 [
429 "command",
430 "match_keys",
431 "match_filter",
432 "new_keys",
433 "new_filter",
434 "create",
435 ]
436 ),
437 per_key_traits={
438 "command": Unicode(),
439 "match_keys": List(Unicode()),
440 "match_filter": Unicode(),
441 "new_keys": List(Unicode()),
442 "new_filter": Unicode(),
443 "create": Bool(False),
444 },
445 ),
446 help="""Add, disable or modifying shortcuts.
448 Each entry on the list should be a dictionary with ``command`` key
449 identifying the target function executed by the shortcut and at least
450 one of the following:
452 - ``match_keys``: list of keys used to match an existing shortcut,
453 - ``match_filter``: shortcut filter used to match an existing shortcut,
454 - ``new_keys``: list of keys to set,
455 - ``new_filter``: a new shortcut filter to set
457 The filters have to be composed of pre-defined verbs and joined by one
458 of the following conjunctions: ``&`` (and), ``|`` (or), ``~`` (not).
459 The pre-defined verbs are:
461 {}
464 To disable a shortcut set ``new_keys`` to an empty list.
465 To add a shortcut add key ``create`` with value ``True``.
467 When modifying/disabling shortcuts, ``match_keys``/``match_filter`` can
468 be omitted if the provided specification uniquely identifies a shortcut
469 to be modified/disabled. When modifying a shortcut ``new_filter`` or
470 ``new_keys`` can be omitted which will result in reuse of the existing
471 filter/keys.
473 Only shortcuts defined in IPython (and not default prompt-toolkit
474 shortcuts) can be modified or disabled. The full list of shortcuts,
475 command identifiers and filters is available under
476 :ref:`terminal-shortcuts-list`.
477 """.format(
478 "\n ".join([f"- `{k}`" for k in KEYBINDING_FILTERS])
479 ),
480 ).tag(config=True)
482 @observe("shortcuts")
483 def _shortcuts_changed(self, change):
484 if self.pt_app:
485 self.pt_app.key_bindings = self._merge_shortcuts(user_shortcuts=change.new)
487 def _merge_shortcuts(self, user_shortcuts):
488 # rebuild the bindings list from scratch
489 key_bindings = create_ipython_shortcuts(self)
491 # for now we only allow adding shortcuts for commands which are already
492 # registered; this is a security precaution.
493 known_commands = {
494 create_identifier(binding.handler): binding.handler
495 for binding in key_bindings.bindings
496 }
497 shortcuts_to_skip = []
498 shortcuts_to_add = []
500 for shortcut in user_shortcuts:
501 command_id = shortcut["command"]
502 if command_id not in known_commands:
503 allowed_commands = "\n - ".join(known_commands)
504 raise ValueError(
505 f"{command_id} is not a known shortcut command."
506 f" Allowed commands are: \n - {allowed_commands}"
507 )
508 old_keys = shortcut.get("match_keys", None)
509 old_filter = (
510 filter_from_string(shortcut["match_filter"])
511 if "match_filter" in shortcut
512 else None
513 )
514 matching = [
515 binding
516 for binding in key_bindings.bindings
517 if (
518 (old_filter is None or binding.filter == old_filter)
519 and (old_keys is None or [k for k in binding.keys] == old_keys)
520 and create_identifier(binding.handler) == command_id
521 )
522 ]
524 new_keys = shortcut.get("new_keys", None)
525 new_filter = shortcut.get("new_filter", None)
527 command = known_commands[command_id]
529 creating_new = shortcut.get("create", False)
530 modifying_existing = not creating_new and (
531 new_keys is not None or new_filter
532 )
534 if creating_new and new_keys == []:
535 raise ValueError("Cannot add a shortcut without keys")
537 if modifying_existing:
538 specification = {
539 key: shortcut[key]
540 for key in ["command", "filter"]
541 if key in shortcut
542 }
543 if len(matching) == 0:
544 raise ValueError(
545 f"No shortcuts matching {specification} found in {key_bindings.bindings}"
546 )
547 elif len(matching) > 1:
548 raise ValueError(
549 f"Multiple shortcuts matching {specification} found,"
550 f" please add keys/filter to select one of: {matching}"
551 )
553 matched = matching[0]
554 old_filter = matched.filter
555 old_keys = list(matched.keys)
556 shortcuts_to_skip.append(
557 RuntimeBinding(
558 command,
559 keys=old_keys,
560 filter=old_filter,
561 )
562 )
564 if new_keys != []:
565 shortcuts_to_add.append(
566 RuntimeBinding(
567 command,
568 keys=new_keys or old_keys,
569 filter=filter_from_string(new_filter)
570 if new_filter is not None
571 else (
572 old_filter
573 if old_filter is not None
574 else filter_from_string("always")
575 ),
576 )
577 )
579 # rebuild the bindings list from scratch
580 key_bindings = create_ipython_shortcuts(self, skip=shortcuts_to_skip)
581 for binding in shortcuts_to_add:
582 add_binding(key_bindings, binding)
584 return key_bindings
586 prompt_includes_vi_mode = Bool(True,
587 help="Display the current vi mode (when using vi editing mode)."
588 ).tag(config=True)
590 @observe('term_title')
591 def init_term_title(self, change=None):
592 # Enable or disable the terminal title.
593 if self.term_title and _is_tty:
594 toggle_set_term_title(True)
595 set_term_title(self.term_title_format.format(cwd=abbrev_cwd()))
596 else:
597 toggle_set_term_title(False)
599 def restore_term_title(self):
600 if self.term_title and _is_tty:
601 restore_term_title()
603 def init_display_formatter(self):
604 super(TerminalInteractiveShell, self).init_display_formatter()
605 # terminal only supports plain text
606 self.display_formatter.active_types = ["text/plain"]
608 def init_prompt_toolkit_cli(self):
609 if self.simple_prompt:
610 # Fall back to plain non-interactive output for tests.
611 # This is very limited.
612 def prompt():
613 prompt_text = "".join(x[1] for x in self.prompts.in_prompt_tokens())
614 lines = [input(prompt_text)]
615 prompt_continuation = "".join(x[1] for x in self.prompts.continuation_prompt_tokens())
616 while self.check_complete('\n'.join(lines))[0] == 'incomplete':
617 lines.append( input(prompt_continuation) )
618 return '\n'.join(lines)
619 self.prompt_for_code = prompt
620 return
622 # Set up keyboard shortcuts
623 key_bindings = self._merge_shortcuts(user_shortcuts=self.shortcuts)
625 # Pre-populate history from IPython's history database
626 history = PtkHistoryAdapter(self)
628 self._style = self._make_style_from_name_or_cls(self.highlighting_style)
629 self.style = DynamicStyle(lambda: self._style)
631 editing_mode = getattr(EditingMode, self.editing_mode.upper())
633 self.pt_loop = asyncio.new_event_loop()
634 self.pt_app = PromptSession(
635 auto_suggest=self.auto_suggest,
636 editing_mode=editing_mode,
637 key_bindings=key_bindings,
638 history=history,
639 completer=IPythonPTCompleter(shell=self),
640 enable_history_search=self.enable_history_search,
641 style=self.style,
642 include_default_pygments_style=False,
643 mouse_support=self.mouse_support,
644 enable_open_in_editor=self.extra_open_editor_shortcuts,
645 color_depth=self.color_depth,
646 tempfile_suffix=".py",
647 **self._extra_prompt_options(),
648 )
649 if isinstance(self.auto_suggest, NavigableAutoSuggestFromHistory):
650 self.auto_suggest.connect(self.pt_app)
652 def _make_style_from_name_or_cls(self, name_or_cls):
653 """
654 Small wrapper that make an IPython compatible style from a style name
656 We need that to add style for prompt ... etc.
657 """
658 style_overrides = {}
659 if name_or_cls == 'legacy':
660 legacy = self.colors.lower()
661 if legacy == 'linux':
662 style_cls = get_style_by_name('monokai')
663 style_overrides = _style_overrides_linux
664 elif legacy == 'lightbg':
665 style_overrides = _style_overrides_light_bg
666 style_cls = get_style_by_name('pastie')
667 elif legacy == 'neutral':
668 # The default theme needs to be visible on both a dark background
669 # and a light background, because we can't tell what the terminal
670 # looks like. These tweaks to the default theme help with that.
671 style_cls = get_style_by_name('default')
672 style_overrides.update({
673 Token.Number: '#ansigreen',
674 Token.Operator: 'noinherit',
675 Token.String: '#ansiyellow',
676 Token.Name.Function: '#ansiblue',
677 Token.Name.Class: 'bold #ansiblue',
678 Token.Name.Namespace: 'bold #ansiblue',
679 Token.Name.Variable.Magic: '#ansiblue',
680 Token.Prompt: '#ansigreen',
681 Token.PromptNum: '#ansibrightgreen bold',
682 Token.OutPrompt: '#ansired',
683 Token.OutPromptNum: '#ansibrightred bold',
684 })
686 # Hack: Due to limited color support on the Windows console
687 # the prompt colors will be wrong without this
688 if os.name == 'nt':
689 style_overrides.update({
690 Token.Prompt: '#ansidarkgreen',
691 Token.PromptNum: '#ansigreen bold',
692 Token.OutPrompt: '#ansidarkred',
693 Token.OutPromptNum: '#ansired bold',
694 })
695 elif legacy =='nocolor':
696 style_cls=_NoStyle
697 style_overrides = {}
698 else :
699 raise ValueError('Got unknown colors: ', legacy)
700 else :
701 if isinstance(name_or_cls, str):
702 style_cls = get_style_by_name(name_or_cls)
703 else:
704 style_cls = name_or_cls
705 style_overrides = {
706 Token.Prompt: '#ansigreen',
707 Token.PromptNum: '#ansibrightgreen bold',
708 Token.OutPrompt: '#ansired',
709 Token.OutPromptNum: '#ansibrightred bold',
710 }
711 style_overrides.update(self.highlighting_style_overrides)
712 style = merge_styles([
713 style_from_pygments_cls(style_cls),
714 style_from_pygments_dict(style_overrides),
715 ])
717 return style
719 @property
720 def pt_complete_style(self):
721 return {
722 'multicolumn': CompleteStyle.MULTI_COLUMN,
723 'column': CompleteStyle.COLUMN,
724 'readlinelike': CompleteStyle.READLINE_LIKE,
725 }[self.display_completions]
727 @property
728 def color_depth(self):
729 return (ColorDepth.TRUE_COLOR if self.true_color else None)
731 def _extra_prompt_options(self):
732 """
733 Return the current layout option for the current Terminal InteractiveShell
734 """
735 def get_message():
736 return PygmentsTokens(self.prompts.in_prompt_tokens())
738 if self.editing_mode == 'emacs':
739 # with emacs mode the prompt is (usually) static, so we call only
740 # the function once. With VI mode it can toggle between [ins] and
741 # [nor] so we can't precompute.
742 # here I'm going to favor the default keybinding which almost
743 # everybody uses to decrease CPU usage.
744 # if we have issues with users with custom Prompts we can see how to
745 # work around this.
746 get_message = get_message()
748 options = {
749 "complete_in_thread": False,
750 "lexer": IPythonPTLexer(),
751 "reserve_space_for_menu": self.space_for_menu,
752 "message": get_message,
753 "prompt_continuation": (
754 lambda width, lineno, is_soft_wrap: PygmentsTokens(
755 self.prompts.continuation_prompt_tokens(width)
756 )
757 ),
758 "multiline": True,
759 "complete_style": self.pt_complete_style,
760 "input_processors": [
761 # Highlight matching brackets, but only when this setting is
762 # enabled, and only when the DEFAULT_BUFFER has the focus.
763 ConditionalProcessor(
764 processor=HighlightMatchingBracketProcessor(chars="[](){}"),
765 filter=HasFocus(DEFAULT_BUFFER)
766 & ~IsDone()
767 & Condition(lambda: self.highlight_matching_brackets),
768 ),
769 # Show auto-suggestion in lines other than the last line.
770 ConditionalProcessor(
771 processor=AppendAutoSuggestionInAnyLine(),
772 filter=HasFocus(DEFAULT_BUFFER)
773 & ~IsDone()
774 & Condition(
775 lambda: isinstance(
776 self.auto_suggest, NavigableAutoSuggestFromHistory
777 )
778 ),
779 ),
780 ],
781 }
782 if not PTK3:
783 options['inputhook'] = self.inputhook
785 return options
787 def prompt_for_code(self):
788 if self.rl_next_input:
789 default = self.rl_next_input
790 self.rl_next_input = None
791 else:
792 default = ''
794 # In order to make sure that asyncio code written in the
795 # interactive shell doesn't interfere with the prompt, we run the
796 # prompt in a different event loop.
797 # If we don't do this, people could spawn coroutine with a
798 # while/true inside which will freeze the prompt.
800 policy = asyncio.get_event_loop_policy()
801 old_loop = get_asyncio_loop()
803 # FIXME: prompt_toolkit is using the deprecated `asyncio.get_event_loop`
804 # to get the current event loop.
805 # This will probably be replaced by an attribute or input argument,
806 # at which point we can stop calling the soon-to-be-deprecated `set_event_loop` here.
807 if old_loop is not self.pt_loop:
808 policy.set_event_loop(self.pt_loop)
809 try:
810 with patch_stdout(raw=True):
811 text = self.pt_app.prompt(
812 default=default,
813 **self._extra_prompt_options())
814 finally:
815 # Restore the original event loop.
816 if old_loop is not None and old_loop is not self.pt_loop:
817 policy.set_event_loop(old_loop)
819 return text
821 def enable_win_unicode_console(self):
822 # Since IPython 7.10 doesn't support python < 3.6 and PEP 528, Python uses the unicode APIs for the Windows
823 # console by default, so WUC shouldn't be needed.
824 warn("`enable_win_unicode_console` is deprecated since IPython 7.10, does not do anything and will be removed in the future",
825 DeprecationWarning,
826 stacklevel=2)
828 def init_io(self):
829 if sys.platform not in {'win32', 'cli'}:
830 return
832 import colorama
833 colorama.init()
835 def init_magics(self):
836 super(TerminalInteractiveShell, self).init_magics()
837 self.register_magics(TerminalMagics)
839 def init_alias(self):
840 # The parent class defines aliases that can be safely used with any
841 # frontend.
842 super(TerminalInteractiveShell, self).init_alias()
844 # Now define aliases that only make sense on the terminal, because they
845 # need direct access to the console in a way that we can't emulate in
846 # GUI or web frontend
847 if os.name == 'posix':
848 for cmd in ('clear', 'more', 'less', 'man'):
849 self.alias_manager.soft_define_alias(cmd, cmd)
852 def __init__(self, *args, **kwargs) -> None:
853 super(TerminalInteractiveShell, self).__init__(*args, **kwargs)
854 self._set_autosuggestions(self.autosuggestions_provider)
855 self.init_prompt_toolkit_cli()
856 self.init_term_title()
857 self.keep_running = True
858 self._set_formatter(self.autoformatter)
861 def ask_exit(self):
862 self.keep_running = False
864 rl_next_input = None
866 def interact(self):
867 self.keep_running = True
868 while self.keep_running:
869 print(self.separate_in, end='')
871 try:
872 code = self.prompt_for_code()
873 except EOFError:
874 if (not self.confirm_exit) \
875 or self.ask_yes_no('Do you really want to exit ([y]/n)?','y','n'):
876 self.ask_exit()
878 else:
879 if code:
880 self.run_cell(code, store_history=True)
882 def mainloop(self):
883 # An extra layer of protection in case someone mashing Ctrl-C breaks
884 # out of our internal code.
885 while True:
886 try:
887 self.interact()
888 break
889 except KeyboardInterrupt as e:
890 print("\n%s escaped interact()\n" % type(e).__name__)
891 finally:
892 # An interrupt during the eventloop will mess up the
893 # internal state of the prompt_toolkit library.
894 # Stopping the eventloop fixes this, see
895 # https://github.com/ipython/ipython/pull/9867
896 if hasattr(self, '_eventloop'):
897 self._eventloop.stop()
899 self.restore_term_title()
901 # try to call some at-exit operation optimistically as some things can't
902 # be done during interpreter shutdown. this is technically inaccurate as
903 # this make mainlool not re-callable, but that should be a rare if not
904 # in existent use case.
906 self._atexit_once()
909 _inputhook = None
910 def inputhook(self, context):
911 if self._inputhook is not None:
912 self._inputhook(context)
914 active_eventloop = None
915 def enable_gui(self, gui=None):
916 if self._inputhook is not None and gui is not None:
917 warn(
918 f"Shell was already running a gui event loop for {self.active_eventloop}; switching to {gui}."
919 )
920 if gui and (gui not in {"inline", "webagg"}):
921 # This hook runs with each cycle of the `prompt_toolkit`'s event loop.
922 self.active_eventloop, self._inputhook = get_inputhook_name_and_func(gui)
923 else:
924 self.active_eventloop = self._inputhook = None
926 # For prompt_toolkit 3.0. We have to create an asyncio event loop with
927 # this inputhook.
928 if PTK3:
929 import asyncio
930 from prompt_toolkit.eventloop import new_eventloop_with_inputhook
932 if gui == 'asyncio':
933 # When we integrate the asyncio event loop, run the UI in the
934 # same event loop as the rest of the code. don't use an actual
935 # input hook. (Asyncio is not made for nesting event loops.)
936 self.pt_loop = get_asyncio_loop()
938 elif self._inputhook:
939 # If an inputhook was set, create a new asyncio event loop with
940 # this inputhook for the prompt.
941 self.pt_loop = new_eventloop_with_inputhook(self._inputhook)
942 else:
943 # When there's no inputhook, run the prompt in a separate
944 # asyncio event loop.
945 self.pt_loop = asyncio.new_event_loop()
947 # Run !system commands directly, not through pipes, so terminal programs
948 # work correctly.
949 system = InteractiveShell.system_raw
951 def auto_rewrite_input(self, cmd):
952 """Overridden from the parent class to use fancy rewriting prompt"""
953 if not self.show_rewritten_input:
954 return
956 tokens = self.prompts.rewrite_prompt_tokens()
957 if self.pt_app:
958 print_formatted_text(PygmentsTokens(tokens), end='',
959 style=self.pt_app.app.style)
960 print(cmd)
961 else:
962 prompt = ''.join(s for t, s in tokens)
963 print(prompt, cmd, sep='')
965 _prompts_before = None
966 def switch_doctest_mode(self, mode):
967 """Switch prompts to classic for %doctest_mode"""
968 if mode:
969 self._prompts_before = self.prompts
970 self.prompts = ClassicPrompts(self)
971 elif self._prompts_before:
972 self.prompts = self._prompts_before
973 self._prompts_before = None
974# self._update_layout()
977InteractiveShellABC.register(TerminalInteractiveShell)
979if __name__ == '__main__':
980 TerminalInteractiveShell.instance().interact()