Base Shell Class (xonsh.base_shell)

The base class for xonsh shell

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

The xonsh shell.

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)[source]

Implements code execution.

emptyline()[source]

Called when an empty line has been entered.

format_color(string, **kwargs)[source]

Formats the colors in a string. This base implmentation does not actually do any coloring, but just returns the string directly.

precmd(line)[source]

Called just before execution of line.

print_color(string, **kwargs)[source]

Prints a string in color. This base implmentation does not actually do any coloring, but just prints the string directly.

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.

prompt

Obtains the current prompt string.

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 strea,.

This represents what a user would actually see on the command line. This class as 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.

line_buffering