kernel.core.prompts¶
Module: kernel.core.prompts¶
Inheritance diagram for IPython.kernel.core.prompts:
Classes for handling input/output prompts.
Authors¶
- Fernando Perez <Fernando.Perez@berkeley.edu>
Classes¶
BasePrompt¶
- class IPython.kernel.core.prompts.BasePrompt(cache, sep, prompt, pad_left=False)¶
Bases: object
Interactive prompt similar to Mathematica’s.
- __init__()¶
- cwd_filt()¶
Return the last depth elements of the current working directory.
$HOME is always replaced with ‘~’. If depth==0, the full path is returned.
- cwd_filt2()¶
Return the last depth elements of the current working directory.
$HOME is always replaced with ‘~’. If depth==0, the full path is returned.
- p_template¶
Template for prompt string creation
- set_p_str()¶
Set the interpolating prompt strings.
This must be called every time the color settings change, because the prompt_specials global may have changed.
- write()¶
CachedOutput¶
- class IPython.kernel.core.prompts.CachedOutput(shell, cache_size, Pprint, colors='NoColor', input_sep='n', output_sep='n', output_sep2='', ps1=None, ps2=None, ps_out=None, pad_left=True)¶
Class for printing output from calculations while keeping a cache of reults. It dynamically creates global variables prefixed with _ which contain these results.
Meant to be used as a sys.displayhook replacement, providing numbered prompts and cache services.
Initialize with initial and final values for cache counter (this defines the maximum size of the cache.
- __init__()¶
- display()¶
Default printer method, uses pprint.
Do ip.set_hook(“result_display”, my_displayhook) for custom result display, e.g. when your own objects need special formatting.
- flush()¶
- set_colors()¶
Set the active color scheme and configure colors for the three prompt subsystems.
- update()¶
Prompt1¶
- class IPython.kernel.core.prompts.Prompt1(cache, sep='n', prompt='In [\#]: ', pad_left=True)¶
Bases: IPython.kernel.core.prompts.BasePrompt
Input interactive prompt similar to Mathematica’s.
- __init__()¶
- auto_rewrite()¶
Print a string of the form ‘—>’ which lines up with the previous input string. Useful for systems which re-write the user input when handling automatically special syntaxes.
- set_colors()¶
Functions¶
- IPython.kernel.core.prompts.multiple_replace()¶
Replace in ‘text’ all occurences of any key in the given dictionary by its corresponding value. Returns the new string.
- IPython.kernel.core.prompts.str_safe()¶
Convert to a string, without ever raising an exception.
If str(arg) fails, <ERROR: ... > is returned, where ... is the exception error message.