Xonsh API¶

For those of you who want the gritty details.

Language:

`xonsh.parsers.lexer`	Lexer for xonsh code.
`xonsh.parser`	Implements the xonsh parser.
`xonsh.parsers.ast`	Abstract Syntax Tree handler
`xonsh.execer`	Implements the xonsh executer.
`xonsh.imphooks`	Import hooks for importing xonsh source files.

Command Prompt:

`xonsh.built_ins`	The xonsh built-ins.
`xonsh.environ`	Environment for the xonsh shell.
`xonsh.aliases`	Aliases for the xonsh shell.
`xonsh.dirstack`	Directory stack and associated utilities for the xonsh shell.
`xonsh.procs`
`xonsh.lib.inspectors`	Tools for inspecting Python objects.
`xonsh.history`
`xonsh.completer`	A (tab-)completer for xonsh.
`xonsh.completers`
`xonsh.prompt`
`xonsh.shells`	The xonsh interactive shells
`xonsh.shells.base_shell`	The base class for xonsh shell
`xonsh.shells.readline_shell`	The readline based xonsh shell.
`xonsh.shells.ptk_shell`	The prompt_toolkit based xonsh shell.
`xonsh.lib.pretty`	Python advanced pretty printer.
`xonsh.history.diff_history`	Tools for diff'ing two xonsh history files in a meaningful fashion.
`xonsh.xoreutils`

Helpers:

`xonsh.events`	Events for xonsh.
`xonsh.lib`	Libraries of common functions that used in xonsh components as well as modules borrowed from other projects.
`xonsh.tools`	Misc.
`xonsh.platform`	Module for platform-specific constants and implementations, as well as compatibility layers to make use of the 'best' implementation available on a platform.
`xonsh.lazyjson`	DEPRECATED: Use xonsh.lib.lazyjson instead of xonsh.lazyjson.
`xonsh.lazyasd`	DEPRECATED: Use xonsh.lib.lazyasd instead of xonsh.lazyasd.
`xonsh.lib.openpy`	Tools to open `*.py` files as Unicode.
`xonsh.foreign_shells`	Tools to help interface with foreign shells, such as Bash.
`xonsh.commands_cache`	Module for caching command & alias names as well as for predicting whether a command will be able to be run in the background.
`xonsh.tracer`	Implements a xonsh tracer.
`xonsh.main`	The main xonsh script.
`xonsh.color_tools`	Tools for color handling in xonsh.
`xonsh.pyghooks`	Hooks for pygments syntax highlighting.
`xonsh.shells.dumb_shell`	A dumb shell for when $TERM == 'dumb', which usually happens in emacs.
`xonsh.wizard`	Tools for creating command-line and web-based wizards from a tree of nodes.
`xonsh.xonfig`	The xonsh configuration (xonfig) utility.
`xonsh.xontribs`	Tools for helping manage xontributions.
`xonsh.codecache`	Tools for caching xonsh code.
`xonsh.contexts`	Context management tools for xonsh.

Xontribs: