Skip to content
Back to top
View this page
Edit this page

# Xonsh Library

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.
`xonsh.shell` | The xonsh shell

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` | Subprocess and pipeline execution for the xonsh shell.
`xonsh.lib.inspectors` | Tools for inspecting Python objects.
`xonsh.history` | Command history backends for the xonsh shell.
`xonsh.completer` | A (tab-)completer for xonsh.
`xonsh.completers` | Tab completion providers for the xonsh shell.
`xonsh.prompt` | Prompt formatting for the xonsh shell.
`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` | Cross-platform reimplementations of common coreutils.

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` | Shared utility functions and helpers for the xonsh shell.
`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.lib.lazyjson` | Implements a lazy JSON file class that wraps around json data.
`xonsh.lib.lazyasd` | Lazy and self destructive containers for speeding up module import.
`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.
`xonsh.ansi_colors` | Tools for helping with ANSI color codes.
`xonsh.style_tools` | Xonsh color styling tools that simulate pygments, when it is unavailable.
`xonsh.cli_utils` | helper functions and classes to create argparse CLI from functions.
`xonsh.timings` | Timing related functionality for the xonsh shell.
`xonsh.pygments_cache` | A fast, drop-in replacement for pygments `get_*()` and `guess_*()` funtions.
`xonsh.platforms` | Platform-dependent code.
`xonsh.webconfig` | Web-based configuration UI for the xonsh shell.

Xompletions:

`xompletions` |

Xontribs:

`xontrib` |