xonsh.base_shell#

The base class for xonsh shell

class xonsh.base_shell.BaseShell(execer, ctx, **kwargs)[source]#

The xonsh shell.

Notes

classes inheriting multiple base classes should call them explicitly as done for ReadlineShell

color_style()[source]#: Returns the current color map.

color_style_names()[source]#: Returns an iterable of all available style names.

compile(src)[source]#: Compiles source code and returns the (possibly modified) source and a valid code object.

default(line, raw_line=None)[source]#: Implements code execution.

emptyline()[source]#: Called when an empty line has been entered.

format_color(string, hide=False, force_string=False, **kwargs)[source]#: Formats the colors in a string. BaseShell’s default implementation of this method uses colors based on ANSI color codes.

precmd(line)[source]#: Called just before execution of line.

print_color(string, hide=False, **kwargs)[source]#: Prints a string in color. This base implementation’s colors are based on ANSI color codes if a string was given as input. If a list of token pairs is given, it will color based on pygments, if available. If pygments is not available, it will print a colorless string.

push(line)[source]#: Pushes a line onto the buffer and compiles the code in a way that enables multiline input.

reset_buffer()[source]#: Resets the line buffer.

restore_tty_sanity()[source]#: An interface for resetting the TTY stdin mode. This is highly dependent on the shell backend. Also it is mostly optional since it only affects ^Z backgrounding behaviour.

settitle()[source]#: Sets terminal title.

singleline(**kwargs)[source]#: Reads a single line of input from the shell.

property prompt#: Obtains the current prompt string.

property styler#

class xonsh.base_shell.Tee(buffer=None, encoding=None, errors=None, newline=None, line_buffering=False, write_through=False)[source]#

Class that merges tee’d stdout and stderr into a single stream.

This represents what a user would actually see on the command line. This class has the same interface as io.TextIOWrapper, except that the buffer is optional.

close()[source]#: Closes the buffer as well as the stdout and stderr tees.

getvalue()[source]#: Gets the current contents of the in-memory buffer.

property line_buffering#