"""The xonsh configuration (xonfig) utility."""
import os
import re
import ast
import json
import shutil
import random
import pprint
import textwrap
import builtins
import argparse
import functools
import itertools
import contextlib
import collections
try:
import ply
except ImportError:
from xonsh.ply import ply
import xonsh.wizard as wiz
from xonsh import __version__ as XONSH_VERSION
from xonsh.prompt.base import is_template_string
from xonsh.platform import (
is_readline_available,
ptk_version,
PYTHON_VERSION_INFO,
pygments_version,
ON_POSIX,
ON_LINUX,
linux_distro,
ON_DARWIN,
ON_WINDOWS,
ON_CYGWIN,
DEFAULT_ENCODING,
ON_MSYS,
githash,
)
from xonsh.tools import (
to_bool,
is_string,
print_exception,
is_superuser,
color_style_names,
print_color,
color_style,
)
from xonsh.foreign_shells import CANON_SHELL_NAMES
from xonsh.xontribs import xontrib_metadata, find_xontrib
from xonsh.lazyasd import lazyobject
HR = "'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'"
WIZARD_HEAD = """
{{BOLD_WHITE}}Welcome to the xonsh configuration wizard!{{NO_COLOR}}
{{YELLOW}}------------------------------------------{{NO_COLOR}}
This will present a guided tour through setting up the xonsh static
config file. Xonsh will automatically ask you if you want to run this
wizard if the configuration file does not exist. However, you can
always rerun this wizard with the xonfig command:
$ xonfig wizard
This wizard will load an existing configuration, if it is available.
Also never fear when this wizard saves its results! It will create
a backup of any existing configuration automatically.
This wizard has two main phases: foreign shell setup and environment
variable setup. Each phase may be skipped in its entirety.
For the configuration to take effect, you will need to restart xonsh.
{hr}
""".format(
hr=HR
)
WIZARD_FS = """
{hr}
{{BOLD_WHITE}}Foreign Shell Setup{{NO_COLOR}}
{{YELLOW}}-------------------{{NO_COLOR}}
The xonsh shell has the ability to interface with foreign shells such
as Bash, or zsh (fish not yet implemented).
For configuration, this means that xonsh can load the environment,
aliases, and functions specified in the config files of these shells.
Naturally, these shells must be available on the system to work.
Being able to share configuration (and source) from foreign shells
makes it easier to transition to and from xonsh.
""".format(
hr=HR
)
WIZARD_ENV = """
{hr}
{{BOLD_WHITE}}Environment Variable Setup{{NO_COLOR}}
{{YELLOW}}--------------------------{{NO_COLOR}}
The xonsh shell also allows you to setup environment variables from
the static configuration file. Any variables set in this way are
superseded by the definitions in the xonshrc or on the command line.
Still, setting environment variables in this way can help define
options that are global to the system or user.
The following lists the environment variable name, its documentation,
the default value, and the current value. The default and current
values are presented as pretty repr strings of their Python types.
{{BOLD_GREEN}}Note:{{NO_COLOR}} Simply hitting enter for any environment variable
will accept the default value for that entry.
""".format(
hr=HR
)
WIZARD_ENV_QUESTION = "Would you like to set env vars now, " + wiz.YN
WIZARD_XONTRIB = """
{hr}
{{BOLD_WHITE}}Xontribs{{NO_COLOR}}
{{YELLOW}}--------{{NO_COLOR}}
No shell is complete without extensions, and xonsh is no exception. Xonsh
extensions are called {{BOLD_GREEN}}xontribs{{NO_COLOR}}, or xonsh contributions.
Xontribs are dynamically loadable, either by importing them directly or by
using the 'xontrib' command. However, you can also configure xonsh to load
xontribs automatically on startup prior to loading the run control files.
This allows the xontrib to be used immediately in your xonshrc files.
The following describes all xontribs that have been registered with xonsh.
These come from users, 3rd party developers, or xonsh itself!
""".format(
hr=HR
)
WIZARD_XONTRIB_QUESTION = "Would you like to enable xontribs now, " + wiz.YN
WIZARD_TAIL = """
Thanks for using the xonsh configuration wizard!"""
_XONFIG_SOURCE_FOREIGN_SHELL_COMMAND = collections.defaultdict(
lambda: "source-foreign", bash="source-bash", cmd="source-cmd", zsh="source-zsh"
)
def _dump_xonfig_foreign_shell(path, value):
shell = value["shell"]
shell = CANON_SHELL_NAMES.get(shell, shell)
cmd = [_XONFIG_SOURCE_FOREIGN_SHELL_COMMAND[shell]]
interactive = value.get("interactive", None)
if interactive is not None:
cmd.extend(["--interactive", str(interactive)])
login = value.get("login", None)
if login is not None:
cmd.extend(["--login", str(login)])
envcmd = value.get("envcmd", None)
if envcmd is not None:
cmd.extend(["--envcmd", envcmd])
aliascmd = value.get("aliasmd", None)
if aliascmd is not None:
cmd.extend(["--aliascmd", aliascmd])
extra_args = value.get("extra_args", None)
if extra_args:
cmd.extend(["--extra-args", repr(" ".join(extra_args))])
safe = value.get("safe", None)
if safe is not None:
cmd.extend(["--safe", str(safe)])
prevcmd = value.get("prevcmd", "")
if prevcmd:
cmd.extend(["--prevcmd", repr(prevcmd)])
postcmd = value.get("postcmd", "")
if postcmd:
cmd.extend(["--postcmd", repr(postcmd)])
funcscmd = value.get("funcscmd", None)
if funcscmd:
cmd.extend(["--funcscmd", repr(funcscmd)])
sourcer = value.get("sourcer", None)
if sourcer:
cmd.extend(["--sourcer", sourcer])
if cmd[0] == "source-foreign":
cmd.append(shell)
cmd.append('"echo loading xonsh foreign shell"')
return " ".join(cmd)
def _dump_xonfig_env(path, value):
name = os.path.basename(path.rstrip("/"))
ensurer = builtins.__xonsh__.env.get_ensurer(name)
dval = ensurer.detype(value)
return "${name} = {val!r}".format(name=name, val=dval)
def _dump_xonfig_xontribs(path, value):
return "xontrib load {0}".format(" ".join(value))
@lazyobject
def XONFIG_DUMP_RULES():
return {
"/": None,
"/env/": None,
"/foreign_shells/*/": _dump_xonfig_foreign_shell,
"/env/*": _dump_xonfig_env,
"/env/*/[0-9]*": None,
"/xontribs/": _dump_xonfig_xontribs,
}
[docs]def make_fs_wiz():
"""Makes the foreign shell part of the wizard."""
cond = wiz.create_truefalse_cond(prompt="Add a new foreign shell, " + wiz.YN)
fs = wiz.While(
cond=cond,
body=[
wiz.Input("shell name (e.g. bash): ", path="/foreign_shells/{idx}/shell"),
wiz.StoreNonEmpty(
"interactive shell [bool, default=True]: ",
converter=to_bool,
show_conversion=True,
path="/foreign_shells/{idx}/interactive",
),
wiz.StoreNonEmpty(
"login shell [bool, default=False]: ",
converter=to_bool,
show_conversion=True,
path="/foreign_shells/{idx}/login",
),
wiz.StoreNonEmpty(
"env command [str, default='env']: ",
path="/foreign_shells/{idx}/envcmd",
),
wiz.StoreNonEmpty(
"alias command [str, default='alias']: ",
path="/foreign_shells/{idx}/aliascmd",
),
wiz.StoreNonEmpty(
("extra command line arguments [list of str, " "default=[]]: "),
converter=ast.literal_eval,
show_conversion=True,
path="/foreign_shells/{idx}/extra_args",
),
wiz.StoreNonEmpty(
"safely handle exceptions [bool, default=True]: ",
converter=to_bool,
show_conversion=True,
path="/foreign_shells/{idx}/safe",
),
wiz.StoreNonEmpty(
"pre-command [str, default='']: ", path="/foreign_shells/{idx}/prevcmd"
),
wiz.StoreNonEmpty(
"post-command [str, default='']: ", path="/foreign_shells/{idx}/postcmd"
),
wiz.StoreNonEmpty(
"foreign function command [str, default=None]: ",
path="/foreign_shells/{idx}/funcscmd",
),
wiz.StoreNonEmpty(
"source command [str, default=None]: ",
path="/foreign_shells/{idx}/sourcer",
),
wiz.Message(message="Foreign shell added.\n"),
],
)
return fs
def _wrap_paragraphs(text, width=70, **kwargs):
"""Wraps paragraphs instead."""
pars = text.split("\n")
pars = ["\n".join(textwrap.wrap(p, width=width, **kwargs)) for p in pars]
s = "\n".join(pars)
return s
ENVVAR_MESSAGE = """
{{BOLD_CYAN}}${name}{{NO_COLOR}}
{docstr}
{{RED}}default value:{{NO_COLOR}} {default}
{{RED}}current value:{{NO_COLOR}} {current}"""
ENVVAR_PROMPT = "{BOLD_GREEN}>>>{NO_COLOR} "
[docs]def make_exit_message():
"""Creates a message for how to exit the wizard."""
shell_type = builtins.__xonsh__.shell.shell_type
keyseq = "Ctrl-D" if shell_type == "readline" else "Ctrl-C"
msg = "To exit the wizard at any time, press {BOLD_UNDERLINE_CYAN}"
msg += keyseq + "{NO_COLOR}.\n"
m = wiz.Message(message=msg)
return m
[docs]def make_envvar(name):
"""Makes a StoreNonEmpty node for an environment variable."""
env = builtins.__xonsh__.env
vd = env.get_docs(name)
if not vd.configurable:
return
default = vd.default
if "\n" in default:
default = "\n" + _wrap_paragraphs(default, width=69)
curr = env.get(name)
if is_string(curr) and is_template_string(curr):
curr = curr.replace("{", "{{").replace("}", "}}")
curr = pprint.pformat(curr, width=69)
if "\n" in curr:
curr = "\n" + curr
msg = ENVVAR_MESSAGE.format(
name=name,
default=default,
current=curr,
docstr=_wrap_paragraphs(vd.docstr, width=69),
)
mnode = wiz.Message(message=msg)
ens = env.get_ensurer(name)
path = "/env/" + name
pnode = wiz.StoreNonEmpty(
ENVVAR_PROMPT,
converter=ens.convert,
show_conversion=True,
path=path,
retry=True,
store_raw=vd.store_as_str,
)
return mnode, pnode
def _make_flat_wiz(kidfunc, *args):
kids = map(kidfunc, *args)
flatkids = []
for k in kids:
if k is None:
continue
flatkids.extend(k)
wizard = wiz.Wizard(children=flatkids)
return wizard
[docs]def make_env_wiz():
"""Makes an environment variable wizard."""
w = _make_flat_wiz(make_envvar, sorted(builtins.__xonsh__.env._docs.keys()))
return w
XONTRIB_PROMPT = "{BOLD_GREEN}Add this xontrib{NO_COLOR}, " + wiz.YN
def _xontrib_path(visitor=None, node=None, val=None):
# need this to append only based on user-selected size
return ("xontribs", len(visitor.state.get("xontribs", ())))
[docs]def make_xontrib(xontrib, package):
"""Makes a message and StoreNonEmpty node for a xontrib."""
name = xontrib.get("name", "<unknown-xontrib-name>")
msg = "\n{BOLD_CYAN}" + name + "{NO_COLOR}\n"
if "url" in xontrib:
msg += "{RED}url:{NO_COLOR} " + xontrib["url"] + "\n"
if "package" in xontrib:
msg += "{RED}package:{NO_COLOR} " + xontrib["package"] + "\n"
if "url" in package:
if "url" in xontrib and package["url"] != xontrib["url"]:
msg += "{RED}package-url:{NO_COLOR} " + package["url"] + "\n"
if "license" in package:
msg += "{RED}license:{NO_COLOR} " + package["license"] + "\n"
msg += "{PURPLE}installed?{NO_COLOR} "
msg += ("no" if find_xontrib(name) is None else "yes") + "\n"
desc = xontrib.get("description", "")
if not isinstance(desc, str):
desc = "".join(desc)
msg += _wrap_paragraphs(desc, width=69)
if msg.endswith("\n"):
msg = msg[:-1]
mnode = wiz.Message(message=msg)
convert = lambda x: name if to_bool(x) else wiz.Unstorable
pnode = wiz.StoreNonEmpty(XONTRIB_PROMPT, converter=convert, path=_xontrib_path)
return mnode, pnode
[docs]def make_xontribs_wiz():
"""Makes a xontrib wizard."""
md = xontrib_metadata()
pkgs = [md["packages"].get(d.get("package", None), {}) for d in md["xontribs"]]
w = _make_flat_wiz(make_xontrib, md["xontribs"], pkgs)
return w
[docs]def make_xonfig_wizard(default_file=None, confirm=False, no_wizard_file=None):
"""Makes a configuration wizard for xonsh config file.
Parameters
----------
default_file : str, optional
Default filename to save and load to. User will still be prompted.
confirm : bool, optional
Confirm that the main part of the wizard should be run.
no_wizard_file : str, optional
Filename for that will flag to future runs that the wizard should not be
run again. If None (default), this defaults to default_file.
"""
w = wiz.Wizard(
children=[
wiz.Message(message=WIZARD_HEAD),
make_exit_message(),
wiz.Message(message=WIZARD_FS),
make_fs_wiz(),
wiz.Message(message=WIZARD_ENV),
wiz.YesNo(question=WIZARD_ENV_QUESTION, yes=make_env_wiz(), no=wiz.Pass()),
wiz.Message(message=WIZARD_XONTRIB),
wiz.YesNo(
question=WIZARD_XONTRIB_QUESTION, yes=make_xontribs_wiz(), no=wiz.Pass()
),
wiz.Message(message="\n" + HR + "\n"),
wiz.FileInserter(
prefix="# XONSH WIZARD START",
suffix="# XONSH WIZARD END",
dump_rules=XONFIG_DUMP_RULES,
default_file=default_file,
check=True,
),
wiz.Message(message=WIZARD_TAIL),
]
)
if confirm:
q = (
"Would you like to run the xonsh configuration wizard now?\n\n"
"1. Yes (You can abort at any time)\n"
"2. No, but ask me next time.\n"
"3. No, and don't ask me again.\n\n"
"1, 2, or 3 [default: 2]? "
)
no_wizard_file = default_file if no_wizard_file is None else no_wizard_file
passer = wiz.Pass()
saver = wiz.SaveJSON(
check=False, ask_filename=False, default_file=no_wizard_file
)
w = wiz.Question(
q, {1: w, 2: passer, 3: saver}, converter=lambda x: int(x) if x != "" else 2
)
return w
def _wizard(ns):
env = builtins.__xonsh__.env
shell = builtins.__xonsh__.shell.shell
fname = env.get("XONSHRC")[-1] if ns.file is None else ns.file
no_wiz = os.path.join(env.get("XONSH_CONFIG_DIR"), "no-wizard")
w = make_xonfig_wizard(
default_file=fname, confirm=ns.confirm, no_wizard_file=no_wiz
)
tempenv = {"PROMPT": "", "XONSH_STORE_STDOUT": False}
pv = wiz.PromptVisitor(w, store_in_history=False, multiline=False)
@contextlib.contextmanager
def force_hide():
if env.get("XONSH_STORE_STDOUT") and hasattr(shell, "_force_hide"):
orig, shell._force_hide = shell._force_hide, False
yield
shell._force_hide = orig
else:
yield
with force_hide(), env.swap(tempenv):
try:
pv.visit()
except (KeyboardInterrupt, Exception):
print()
print_exception()
def _xonfig_format_human(data):
wcol1 = wcol2 = 0
for key, val in data:
wcol1 = max(wcol1, len(key))
wcol2 = max(wcol2, len(str(val)))
hr = "+" + ("-" * (wcol1 + 2)) + "+" + ("-" * (wcol2 + 2)) + "+\n"
row = "| {key!s:<{wcol1}} | {val!s:<{wcol2}} |\n"
s = hr
for key, val in data:
s += row.format(key=key, wcol1=wcol1, val=val, wcol2=wcol2)
s += hr
return s
def _xonfig_format_json(data):
data = {k.replace(" ", "_"): v for k, v in data}
s = json.dumps(data, sort_keys=True, indent=1) + "\n"
return s
def _info(ns):
env = builtins.__xonsh__.env
try:
ply.__version__ = ply.__version__
except AttributeError:
ply.__version__ = "3.8"
data = [("xonsh", XONSH_VERSION)]
hash_, date_ = githash()
if hash_:
data.append(("Git SHA", hash_))
data.append(("Commit Date", date_))
data.extend(
[
("Python", "{}.{}.{}".format(*PYTHON_VERSION_INFO)),
("PLY", ply.__version__),
("have readline", is_readline_available()),
("prompt toolkit", ptk_version() or None),
("shell type", env.get("SHELL_TYPE")),
("pygments", pygments_version()),
("on posix", bool(ON_POSIX)),
("on linux", bool(ON_LINUX)),
]
)
if ON_LINUX:
data.append(("distro", linux_distro()))
data.extend(
[
("on darwin", ON_DARWIN),
("on windows", ON_WINDOWS),
("on cygwin", ON_CYGWIN),
("on msys2", ON_MSYS),
("is superuser", is_superuser()),
("default encoding", DEFAULT_ENCODING),
("xonsh encoding", env.get("XONSH_ENCODING")),
("encoding errors", env.get("XONSH_ENCODING_ERRORS")),
]
)
formatter = _xonfig_format_json if ns.json else _xonfig_format_human
s = formatter(data)
return s
def _styles(ns):
env = builtins.__xonsh__.env
curr = env.get("XONSH_COLOR_STYLE")
styles = sorted(color_style_names())
if ns.json:
s = json.dumps(styles, sort_keys=True, indent=1)
print(s)
return
lines = []
for style in styles:
if style == curr:
lines.append("* {GREEN}" + style + "{NO_COLOR}")
else:
lines.append(" " + style)
s = "\n".join(lines)
print_color(s)
def _str_colors(cmap, cols):
color_names = sorted(cmap.keys(), key=(lambda s: (len(s), s)))
grper = lambda s: min(cols // (len(s) + 1), 8)
lines = []
for n, group in itertools.groupby(color_names, key=grper):
width = cols // n
line = ""
for i, name in enumerate(group):
buf = " " * (width - len(name))
line += "{" + name + "}" + name + "{NO_COLOR}" + buf
if (i + 1) % n == 0:
lines.append(line)
line = ""
if len(line) != 0:
lines.append(line)
return "\n".join(lines)
def _tok_colors(cmap, cols):
from xonsh.style_tools import Color
nc = Color.NO_COLOR
names_toks = {}
for t in cmap.keys():
name = str(t)
if name.startswith("Token.Color."):
_, _, name = name.rpartition(".")
names_toks[name] = t
color_names = sorted(names_toks.keys(), key=(lambda s: (len(s), s)))
grper = lambda s: min(cols // (len(s) + 1), 8)
toks = []
for n, group in itertools.groupby(color_names, key=grper):
width = cols // n
for i, name in enumerate(group):
toks.append((names_toks[name], name))
buf = " " * (width - len(name))
if (i + 1) % n == 0:
buf += "\n"
toks.append((nc, buf))
if not toks[-1][1].endswith("\n"):
toks[-1] = (nc, toks[-1][1] + "\n")
return toks
def _colors(args):
columns, _ = shutil.get_terminal_size()
columns -= int(ON_WINDOWS)
style_stash = builtins.__xonsh__.env["XONSH_COLOR_STYLE"]
if args.style is not None:
if args.style not in color_style_names():
print("Invalid style: {}".format(args.style))
return
builtins.__xonsh__.env["XONSH_COLOR_STYLE"] = args.style
color_map = color_style()
akey = next(iter(color_map))
if isinstance(akey, str):
s = _str_colors(color_map, columns)
else:
s = _tok_colors(color_map, columns)
print_color(s)
builtins.__xonsh__.env["XONSH_COLOR_STYLE"] = style_stash
def _tutorial(args):
import webbrowser
webbrowser.open("http://xon.sh/tutorial.html")
@functools.lru_cache(1)
def _xonfig_create_parser():
p = argparse.ArgumentParser(
prog="xonfig", description="Manages xonsh configuration."
)
subp = p.add_subparsers(title="action", dest="action")
info = subp.add_parser(
"info", help=("displays configuration information, " "default action")
)
info.add_argument(
"--json", action="store_true", default=False, help="reports results as json"
)
wiz = subp.add_parser("wizard", help="displays configuration information")
wiz.add_argument(
"--file", default=None, help="config file location, default=$XONSHRC"
)
wiz.add_argument(
"--confirm",
action="store_true",
default=False,
help="confirm that the wizard should be run.",
)
sty = subp.add_parser("styles", help="prints available xonsh color styles")
sty.add_argument(
"--json", action="store_true", default=False, help="reports results as json"
)
colors = subp.add_parser("colors", help="preview color style")
colors.add_argument(
"style", nargs="?", default=None, help="style to preview, default: <current>"
)
subp.add_parser("tutorial", help="Launch tutorial in browser.")
return p
_XONFIG_MAIN_ACTIONS = {
"info": _info,
"wizard": _wizard,
"styles": _styles,
"colors": _colors,
"tutorial": _tutorial,
}
[docs]def xonfig_main(args=None):
"""Main xonfig entry point."""
if not args or (
args[0] not in _XONFIG_MAIN_ACTIONS and args[0] not in {"-h", "--help"}
):
args.insert(0, "info")
parser = _xonfig_create_parser()
ns = parser.parse_args(args)
if ns.action is None: # apply default action
ns = parser.parse_args(["info"] + args)
return _XONFIG_MAIN_ACTIONS[ns.action](ns)
@lazyobject
def STRIP_COLOR_RE():
return re.compile("{.*?}")
def _align_string(string, align="<", fill=" ", width=80):
""" Align and pad a color formatted string """
linelen = len(STRIP_COLOR_RE.sub("", string))
padlen = max(width - linelen, 0)
if align == "^":
return fill * (padlen // 2) + string + fill * (padlen // 2 + padlen % 2)
elif align == ">":
return fill * padlen + string
elif align == "<":
return string + fill * padlen
else:
return string
@lazyobject
def TAGLINES():
return [
"Exofrills in the shell",
"No frills in the shell",
"Become the Lord of the Files",
"Break out of your shell",
"The only shell that is also a shell",
"All that is and all that shell be",
"It cannot be that hard",
"Pass the xonsh, Piggy",
"Piggy glanced nervously into hell and cradled the xonsh",
"The xonsh is a symbol",
"It is pronounced conch",
"The shell, bourne again",
"Snailed it",
"Starfish loves you",
"Come snail away",
"This is Major Tom to Ground Xonshtrol",
"Sally sells csh and keeps xonsh to herself",
"Nice indeed. Everything's accounted for, except your old shell.",
"I wanna thank you for putting me back in my snail shell",
"Crustaceanly Yours",
"With great shell comes great reproducibility",
"None shell pass",
"You shell not pass!",
"The x-on shell",
"Ever wonder why there isn't a Taco Shell? Because it is a corny idea.",
"The carcolh will catch you!",
"People xonshtantly mispronounce these things",
"WHAT...is your favorite shell?",
"Conches for the xonsh god!",
"Python-powered, cross-platform, Unix-gazing shell",
"Tab completion in Alderaan places",
"This fix was trickier than expected",
"The unholy cross of Bash/Python",
]
# list of strings or tuples (string, align, fill)
WELCOME_MSG = [
"",
("{{INTENSE_WHITE}}Welcome to the xonsh shell ({version}){{NO_COLOR}}", "^", " "),
"",
("{{INTENSE_RED}}~{{NO_COLOR}} {tagline} {{INTENSE_RED}}~{{NO_COLOR}}", "^", " "),
"",
("{{INTENSE_BLACK}}", "<", "-"),
"{{GREEN}}xonfig{{NO_COLOR}} tutorial {{INTENSE_WHITE}}-> Launch the tutorial in "
"the browser{{NO_COLOR}}",
"{{GREEN}}xonfig{{NO_COLOR}} wizard {{INTENSE_WHITE}}-> Run the configuration "
"wizard and claim your shell {{NO_COLOR}}",
"{{INTENSE_BLACK}}(Note: Run the Wizard or create a {{RED}}~/.xonshrc{{INTENSE_BLACK}} file "
"to suppress the welcome screen)",
"",
]
[docs]def print_welcome_screen():
subst = dict(tagline=random.choice(list(TAGLINES)), version=XONSH_VERSION)
for elem in WELCOME_MSG:
if isinstance(elem, str):
elem = (elem, "", "")
line = elem[0].format(**subst)
termwidth = os.get_terminal_size().columns
line = _align_string(line, elem[1], elem[2], width=termwidth)
print_color(line)
