##// END OF EJS Templates
Documentation overhaul....
Documentation overhaul. Remove many unnecessary section or inaccurate, build locally using RTD theme to simplify testing locally. Decrease the depth of some section. And do not duplicate table of content which anyway is always on the sidebar.

File last commit:

r22471:d95a1efb
r22588:5b905f8f
Show More
prompts.py
74 lines | 2.1 KiB | text/x-python | PythonLexer
Thomas Kluyver
Add __future__ import for prompts module
r22428 """Terminal input and output prompts."""
from __future__ import print_function
Thomas Kluyver
New prompts class for terminal interface
r22421 from pygments.token import Token
Thomas Kluyver
Use new prompt machinery to generate Out prompts
r22422 import sys
from IPython.core.displayhook import DisplayHook
Thomas Kluyver
New prompts class for terminal interface
r22421
Matthias Bussonnier
Don't compute length of ZeroWidthTokens....
r22471 from prompt_toolkit.layout.utils import token_list_width
Thomas Kluyver
New prompts class for terminal interface
r22421 class Prompts(object):
def __init__(self, shell):
self.shell = shell
def in_prompt_tokens(self, cli=None):
return [
(Token.Prompt, 'In ['),
(Token.PromptNum, str(self.shell.execution_count)),
(Token.Prompt, ']: '),
]
def _width(self):
Matthias Bussonnier
Don't compute length of ZeroWidthTokens....
r22471 return token_list_width(self.in_prompt_tokens())
Thomas Kluyver
New prompts class for terminal interface
r22421
def continuation_prompt_tokens(self, cli=None, width=None):
if width is None:
width = self._width()
return [
(Token.Prompt, (' ' * (width - 5)) + '...: '),
]
def rewrite_prompt_tokens(self):
width = self._width()
return [
(Token.Prompt, ('-' * (width - 2)) + '> '),
]
def out_prompt_tokens(self):
return [
(Token.OutPrompt, 'Out['),
(Token.OutPromptNum, str(self.shell.execution_count)),
(Token.OutPrompt, ']: '),
]
Thomas Kluyver
Use new prompt machinery to generate Out prompts
r22422
Thomas Kluyver
Switch prompts for doctest_mode
r22429 class ClassicPrompts(Prompts):
def in_prompt_tokens(self, cli=None):
return [
(Token.Prompt, '>>> '),
]
def continuation_prompt_tokens(self, cli=None, width=None):
return [
(Token.Prompt, '... ')
]
def rewrite_prompt_tokens(self):
return []
def out_prompt_tokens(self):
return []
Thomas Kluyver
Use new prompt machinery to generate Out prompts
r22422 class RichPromptDisplayHook(DisplayHook):
"""Subclass of base display hook using coloured prompt"""
def write_output_prompt(self):
sys.stdout.write(self.shell.separate_out)
Thomas Kluyver
Integrate new prompt machinery with intelli-newlining
r22423 self.prompt_end_newline = False
Thomas Kluyver
Use new prompt machinery to generate Out prompts
r22422 if self.do_full_cache:
tokens = self.shell.prompts.out_prompt_tokens()
Thomas Kluyver
Integrate new prompt machinery with intelli-newlining
r22423 if tokens and tokens[-1][1].endswith('\n'):
self.prompt_end_newline = True
Thomas Kluyver
Use new prompt machinery to generate Out prompts
r22422 if self.shell.pt_cli:
self.shell.pt_cli.print_tokens(tokens)
else:
print(*(s for t, s in tokens), sep='')