开发工具【免费下载链接】xonsh Python-powered shell. Full-featured, cross-platform and AI-friendly.项目地址https://gitcode.com/gh_mirrors/xo/xonsh点击查看免费下载xonsh 是一款 Python 驱动的跨平台 shell其别名alias系统是它区别于传统 shell 的核心机制之一。本文以官方文档 docs/aliases.rst 为骨架系统梳理 xonsh 的内建别名包括cd、ls、grep等常见命令xpython、xxonsh、showcmd等 xonsh 特有命令并深入讲解json、xml、path等命令装饰器、目录栈、作业控制、source-foreign系列源码别名以及带描述的用户别名定义方式。读完本文你将能够在日常会话和 RC 文件中熟练使用这些别名并理解其底层实现对应 xonsh/aliases.py。一、常用命令别名Well-known Commandscd切换目录cd命令用于切换当前工作目录如果不带任何参数则切换到当前用户的主目录home directory。在源码中cd与pushd/popd/dirs一样由 xonsh/dirstack.py 提供实现并在 xonsh/aliases.py#L1676 处注册进默认别名表。cd # 回到 home 目录 cd /var/log # 切换到指定目录ls平台相关的彩色列表ls别名在不同平台上展开为不同参数见 xonsh/aliases.py#L1825-L1842平台展开后的别名值Linux[ls, --colorauto, -v]macOS / FreeBSD / DragonFlyBSD[ls, -G]NetBSD / OpenBSD不定义ls别名直接调用系统ls注意 Linux 上的-v是 GNUls的自然排序选项版本排序而 macOS 上的-G启用彩色输出。由于别名值是字符串列表你可以随时覆盖它aliases[ls] [ls, --colorauto, -F] # 追加文件类型符号grep默认启用颜色grep被别名为[grep, --colorauto]。在 FreeBSD、NetBSD、DragonFlyBSD 上还会额外注册egrep、fgrep的彩色别名Linux 上同样注册这三者OpenBSD 上不定义任何 grep 系列别名。timeit计时工具timeit对参数进行计时研究功能类似 IPython 的%timeit魔法。其实现来自 xonsh/timings.py 中的timeit_aliastimeit sleep 0.1 # 测量一条命令的执行时间 timeit python -c sum(range(1000))exit/quit/EOF安全退出exit、EOF、quit三个名字都映射到同一个动作以安全的方式退出 xonsh。按Ctrl-d等同于输入EOF并回车。其底层实现是 xonsh/aliases.py#L971 的xonsh_exit它先调用clean_jobs()确保没有未清理的作业然后从参数中解析退出码解析失败则视为 1无参数则视为 0写入XSH.exit。特别地exit N会把 shell 的退出码设置为N并停止当前脚本的剩余部分 xonsh -c echo 1; exit 42; echo 3 1 .lastcmd.rtn 42echo 3没有被执行且退出码为 42。二、xonsh 特有别名Xonsh-specific Aliaseshistory历史记录管理history提供 xonsh 历史记录的全部管理工具包括所有子命令。完整用法参见 docs/history.rst。其实现为 xonsh/history/main.py 中的history_mainhistory show # 显示历史 history file # 显示历史文件路径 history clear # 清空历史showcmd查看命令求值结果showcmd以字符串列表的形式展示 xonsh 在子进程模式下会如何执行一条命令及其参数用于调试参数展开、$()捕获、()列表与引号处理。使用-e/--expand-alias展开别名实现见 xonsh/aliases.py#L1465 showcmd echo The (args) ([list, is]) $(echo here) and --sayhello to ([]) you [echo, The, args, list, is, here, and, --sayhello, to, you] showcmd ls ls showcmd -e ls [ls, --group-directories-first, -A, --color]对比两次输出可见不带-e时只显示字面命令名带-e时则递归展开为最终执行的参数列表。它同样适用于自己定义的别名 aliases[ali] echo 1 showcmd -e ali 2 [echo, 1, 2]xonfig配置管理xonfig管理 xonsh 的配置信息其实现为 xonsh/xonfig.py 中的xonfig_main通过懒加载注册见 xonsh/aliases.py#L1446-L1451xonfig # 交互式查看/修改配置 xonfig wizard # 基于向导的配置 xonfig info # 打印环境与依赖信息xontrib扩展管理xontrib管理 xonsh 的扩展xontrib详见 docs/xontrib.rst实现位于 xonsh/xontribs.pyxontrib list # 列出可用/已加载扩展 xontrib load vox # 加载扩展xcontext报告当前 xonsh 环境xcontext报告当前 xonsh 环境的信息包括 Python 解释器、pip、xonsh 自身的路径以及相关环境变量。其实现为 xonsh/xoreutils/xcontext.py 中的xcontext_main xcontext [Current xonsh session] xxonsh: /home/snail/.local/xonsh-env/bin/xonsh xpython: /home/snail/.local/xonsh-env/bin/python # Python 3.12.10 xpip: /home/snail/.local/xonsh-env/bin/python -m pip [Current commands environment] xonsh: /home/snail/.local/xonsh-env/bin/xonsh python: /usr/bin/python # Python 3.11.6 pip: /usr/bin/pip CONDA_DEFAULT_ENV: my-env默认情况下输出中的符号链接会被解析为真实路径传入--no-resolve-n则显示原始路径。此外还支持--as-json以 JSON 形式输出对应源码中的as_json参数。从源码结构看它使用XContext对象统一收集当前 xonsh 会话与当前命令环境两组路径信息并在--no-resolve模式下仍以红色标出失效条目。xpipxonsh 自己的 pipxpip运行与 xonsh 自身绑定的pip包管理器非常适合 xonsh 位于隔离环境conda、mamba、homebrew中的安装场景。其实现get_xpip_alias()xonsh/aliases.py#L1542返回[sys.executable, -m, pip]并在特殊场景下自动调整AppImage环境下使用$_指向的真实 Python 解释器Python 可执行文件所在目录不可写典型如系统级安装时自动包装成在pip install后追加--user把包装进当前用户目录Windows 上直接返回基础命令。 which pip /usr/bin/pip # system pip which xpip /home/snail/.local/xonsh-env/bin/python -m pip # current xonsh session pip xpip install fire import fire fire module fire from /home/snail/.local/xonsh-env/lib/python3.11/site-packages/fire/__init__.pyxpip install装出的包与当前 xonsh 会话共享同一个 Python 环境因此import fire立即可用。xpython当前解释器xpython是正在运行 xonsh 的 Python 解释器即sys.executable的别名用于在与 shell 自身相同的环境中运行 Python 模块或脚本特别适合 AppImage 等复杂安装场景 python -V Python 3.12.10 xpython -V Python 3.11.9 which python /opt/homebrew/bin/python which xpython /home/snail/.local/xonsh-env/bin/python从 xonsh/aliases.py#L1722-L1724 可见AppImage 下其值为[$_, sys.executable]$_是 AppImage 内置的真实解释器否则为[sys.executable]。xxonsh启动与当前会话完全相同的 xonshxxonsh启动与启动当前会话完全相同的那个 xonsh——相同的解释器、相同的源码树与当前工作目录或site-packages中安装的内容无关。记忆法把开头的x想成c即(c)urrent xonsh。其实现get_xxonsh_alias()xonsh/aliases.py#L1494总是返回一个列表方便与其他 argv 拼接通过入口点启动时sys.argv[0]是可执行绝对路径返回[current_xonsh]通过python -m xonsh从源码启动时为避免当前工作目录污染sys.path导致加载错误会计算xonsh包所在目录并生成一段python -c引导代码把该目录插入sys.path后再导入xonsh.main。一个经典用法是把它作为构建块启动tmux即xtmux配方详见 docs/launch.rst#L128aliases[xtmux] [tmux, new-session] .imp.xonsh.aliases.get_xxonsh_alias()xreset清空 xonsh 上下文xreset清理 xonsh 的上下文context删除所有用户变量。其实现是 xonsh/aliases.py#L987 的xonsh_reset即清空XSH.ctx a1 a 1 xreset a Not foundtrace执行前打印源码行trace提供在执行源代码行之前将其打印出来的接口实现位于 xonsh/tracer.py 的tracermain注册时被标记为unthreadable见 xonsh/aliases.py#L1454-L1462trace -h # 查看完整选项 trace myscript.xsh # 逐行追踪执行exec与xexec同进程替换exec别名xexec使用os.execvpe()用指定程序替换当前 xonsh 进程等价于 bash 的exec内建。实现在 xonsh/aliases.py#L1354exec bash -l -i bash $支持的选项选项含义-l,--login在传给命令的第零个参数前加-模拟登录 shell-c,--clean以空环境执行命令-a,--name把name作为第零个参数传给被执行的命令源码细节非--clean时会 detype 当前环境并把$SHLVL减一以对齐 bash 行为同时清理__ALIAS_STACK/__ALIAS_NAME避免新进程误判别名递归对应 PR #6198。若目标不是二进制Exec format error会回退到通过 shebang 解析成脚本子进程命令再执行。⚠️ 注意exec与 Python 内建函数exec()不是一回事——后者用于执行 Python 代码。发生名字冲突时请直接使用xexec或显式进入子进程模式![exec command]。三、命令装饰器Command Decorators命令装饰器是一组以开头的特殊别名用于在单条命令上修改子进程的捕获/线程/格式行为。它们在 xonsh/aliases.py#L1726-L1807 中注册为SpecAttrDecoratorAlias本质上是在执行前向命令 spec 注入对应属性。error_raise与error_ignore命令级错误控制用error_raise让命令返回非零退出码时抛出异常——类似$XONSH_SUBPROC_CMD_RAISE_ERROR但作用域限于单条命令且无条件抛出即使在/||链中、即使$XONSH_SUBPROC_RAISE_ERROR被关闭。用error_ignore显式抑制抛出它同样优先于$XONSH_SUBPROC_RAISE_ERROR的链式结果检查 r !(error_raise ls nonono) subprocess.CalledProcessError: Command [error_raise, ls, nonono] returned non-zero exit status 1. r !(error_ignore ls nonono)thread与unthread线程行为thread/unthread把命令标记为可线程化/不可线程化。例如为了获取 SSH 命令的结果需要线程化以读取输出 !(thread ssh host -T echo 1)path与paths输出转 Path 对象path把命令输出的第一行转换为一个pathlib.Path对象paths把每一行转换为Path对象列表跳过空行。底层转换函数是 xonsh/aliases.py#L1657-L1670 的_output_to_path_object/_output_to_path_objects dir $(path echo /bin) dir.exists() dirs $(paths echo /bin\n/etc) [p.exists() for p in dirs]lines输出转行列表lines把命令输出作为行列表返回对应output_format: list_lines等价于$XONSH_SUBPROC_OUTPUT_FORMAT设为list_lines lines $(lines cat file)stream输出转行流stream把命令输出作为行流返回stream_lines。当$XONSH_SUBPROC_OUTPUT_FORMAT为list_lines时尤为有用 str $(stream cat file)json解析 JSONjson把命令输出解析为 JSON 对象底层是json.loads(\n.join(lines)) data $(json curl https://example.com/data.json)jsonl解析 JSON Linesjsonl按行解析 JSON返回 JSON 对象列表 items $(jsonl cat data.jsonl)yaml解析 YAMLyaml把命令输出解析为字典yaml.safe_load config $(yaml cat config.yaml)toml解析 TOMLtoml把命令输出解析为字典使用标准库tomllib.loads config $(toml cat pyproject.toml)xml解析 XMLxml使用标准库xml.etree.ElementTree把输出解析为Element对象可用.tag、.attrib、.text、.find()、.findall()等导航 feed $(xml curl -s https://github.com/xonsh/xonsh/releases.atom) ns {a: http://www.w3.org/2005/Atom} [e.find(a:title, ns).text for e in feed.findall(a:entry, ns)[:5]] [v0.23.6, v0.23.5, v0.23.4, v0.23.3, v0.23.2]lxml基于 lxml 的 XML 解析lxml使用 lxml 解析 XML返回lxml.etree._Element在标准库xml之上提供完整 XPath、更丰富的错误信息与更快的解析速度。仅当安装了 lxml 时才注册xonsh/aliases.py#L1798-L1807 通过importlib.util.find_spec(lxml)判断安装方式xpip install lxml feed $(lxml curl -s https://github.com/xonsh/xonsh/releases.atom) ns {a: http://www.w3.org/2005/Atom} feed.xpath(//a:entry/a:title/text(), namespacesns)[:5] [v0.23.6, v0.23.5, v0.23.4, v0.23.3, v0.23.2]四、目录栈Directory Stack目录栈由 xonsh/dirstack.py 实现三个命令共用同一个全局栈DIRSTACK并提供-n、-q、N/-N旋转等细节对应 bash 语义。pushd压栈并切换pushd把一个目录加到目录栈顶部新顶部即当前工作目录或通过N/-N旋转栈参数含义dir把dir设为栈顶并cd过去N把dirs列表从左数第 N 个从 0 开始目录旋转到栈顶-N把dirs列表从右数第 N 个目录旋转到栈顶-n只操作栈不切换目录-q静默模式不调用dirs显示结果pushd /tmp # 保存当前目录并进入 /tmp pushd -n /var/log # 仅压栈不切换 pushd 1 # 旋转栈实现细节Windows 上遇到 UNC 路径\\server\share且未开启DisableUNCCheck注册表项时会像 CMD 的PUSHD一样临时映射一个盘符。栈大小受$DIRSTACK_SIZE限制超出部分被截断。popd弹栈popd从目录栈中移除条目并切换到新的栈顶参数语义与pushd的N/-N一致popd # 弹出一个目录并切换过去 popd 2 # 弹出左边第 2 个条目dirs查看与清空dirs显示当前记住的目录列表也可用于清空目录栈dirs # 列出目录栈 dirs -c # 清空目录栈五、作业控制Jobs作业控制别名由 xonsh/procs/jobs.py 提供。jobs列出当前作业jobs显示所有当前作业列表支持--posix以 POSIX 风格输出见 xonsh/procs/jobs.py#L583jobs jobs --posixfg转到前台fg把当前活动作业带到前台给定一个数字参数则把该作业带到前台。此外支持最近操作的作业与-次近的作业两种速记fg # 恢复最近挂起的作业到前台 fg 3 # 恢复作业 3bg转到后台bg在后台恢复执行当前活动作业或恢复指定编号的作业bg # 后台恢复最近挂起的作业 bg 3 # 后台恢复作业 3源码中fg/bg共用resume_job()xonsh/procs/jobs.py#L596前台恢复时tee_outputTrue把输出接到终端后台恢复则不 tee 输出并把作业标记为bgTrue、statusrunning。disown脱离作业表disown的行为与 zsh 的disown一致把指定作业从作业表中移除shell 不再报告其状态退出交互 shell 时也不会因它们仍在运行/停止而抱怨。未指定作业时disown 当前作业。如果作业处于停止状态且设置了$AUTO_CONTINUE True会打印一条警告说明如何让它们在被 disown 后继续运行如果使用了-c/--continueforce_auto_continue作业会被自动置为运行状态与$AUTO_CONTINUE的设置无关。disown # 脱离当前作业 disown 2 5 # 脱离作业 2 和 5 disown -c 3 # 脱离作业 3 并自动继续运行六、源码类别名Source Aliasessource执行 xonsh/Python 文件source在当前上下文中执行给定文件的内容仅适用于 xonsh 和 Python 文件*.xsh、*.py。使用-e忽略扩展名限制source myscript.xsh source -e somefile.txtsource-foreignsource 外来 shell 文件source-foreign用于 source 外来非 xonsh语言编写的文件会拾取目标 shell 的环境变量和别名。支持的外来 shellbash、zsh、sh以及dash、ash、ksh、mksh、pdkshWindows 上支持cmd。/bin/bash、/bin/sh这类绝对路径会被规范化到同名默认 shell。source-foreign bash /etc/profile source-foreign --sourcer . /etc/profile # 指定 POSIX dot 内建 source-foreign zsh --show-output ~/.zshrc # 转发 stdout/stderr其实现source_foreign_fnxonsh/aliases.py#L992参数非常丰富常用选项包括选项含义-i,--interactive以交互模式运行外来 shell-l,--login以登录模式运行外来 shell--envcmd打印环境变量的命令--aliascmd打印别名的命令--extra-args运行该 shell 所需的额外参数-u,--unsafe不安全模式出错时也不抛错-p,--prevcmd在 source 之前先运行的命令替代传统 source--postcmd在所有命令之后运行的命令--sourcer目标 shell 语言中的 source 命令不指定时按 shell 名查默认值--use-tmpfile把 source 命令写入临时文件执行--seterrprevcmd/--seterrpostcmd在前后设置 exit-on-error 的命令--overwrite-aliases覆盖同名 xonsh 别名--suppress-skip-message抑制跳过提示也可用$FOREIGN_ALIASES_SUPPRESS_SKIP_MESSAGE True--show显示将发给外来 shell 的生成命令--show-output把 source 脚本产生的 stdout/stderr 转发到终端默认静默丢弃-d,--dry-run实际不 source源码行为要点source 成功后环境变量差异会写回 xonsh 环境$SHLVL被忽略未在脚本中出现的原变量会被移除别名冲突时默认跳过并打印提示可用--overwrite-aliases强制应用。source-shPOSIX 友好包装source-sh是source-foreign sh配合--sourcer .的薄包装——因为 dash 系发行版上的/bin/sh不理解source内建改用 POSIX 点号内建。适用于 source/etc/profile之类的 POSIX 配置文件同时覆盖dash、ash、ksh、mksh、pdksh环境与别名会被拾取但 shell 专属的函数列表不可用。source-bash与source-zshsource-bash是source-foreign bash --sourcer source的薄包装source-zsh是source-foreign zsh --sourcer source的薄包装。三者都是 xonsh/aliases.py#L1691-L1709 中通过functools.partial预置参数构造的SourceForeignAlias因此source-foreign接受的每个标志在它们身上同样可用source-bash ~/.bashrc source-zsh -l ~/.zprofile source-sh /etc/profile七、Windows 别名Windows Aliases基于 cmd 的别名在 Windows 上以下别名被展开为[cmd, /c, alias]实际源码用_find_cmd_exe()解析出cmd.exe的绝对路径避免依赖可能被改写的COMSPEC见 xonsh/aliases.py#L1597-L1628{cls: [cmd, /c, cls], copy: [cmd, /c, copy], del: [cmd, /c, del], dir: [cmd, /c, dir], erase: [cmd, /c, erase], md: [cmd, /c, md], mkdir: [cmd, /c, mkdir], mklink: [cmd, /c, mklink], move: [cmd, /c, move], rd: [cmd, /c, rd], ren: [cmd, /c, ren], rename: [cmd, /c, rename], rmdir: [cmd, /c, rmdir], time: [cmd, /c, time], type: [cmd, /c, type], vol: [cmd, /c, vol], }此外 Windows 上还额外注册call/source-bat→source-cmdclear→cls。Anaconda 下的activate/deactivate在安装了 Anaconda Python 发行版的 Windows 上activate和deactivate被别名为[source-cmd, activate.bat]和[source-cmd, deactivate.bat]从而可以用与 cmd.exe 中相同的命令来激活/停用 conda 环境activate myenv deactivate源码判断条件xonsh/aliases.py#L1815-L1822xonsh 安装在 conda 环境内ON_ANACONDA或$PATH中存在conda启动器时才会注册这两个别名。Windows 上的sudo在 Windows 上如果找不到名为sudo的可执行文件xonsh 会添加一个sudo别名借助ShellExecuteEx和ctypes补全以管理员运行行为xonsh/aliases.py#L1632 的win_sudo。它不支持真正的sudo参数只接受要运行的命令sudo cmd /k whoami # 触发 UAC 提升后执行八、带描述的用户别名User Aliases with Descriptions一行描述的作用每个别名都可以携带一行描述doc它会出现在Tab 补全下拉框中别名名称旁边cmd?/cmd??帮助输出中。对于可调用别名callable alias函数 docstring 会被自动用作描述xonsh/aliases.py#L149-L200 的FuncAlias会把__doc__等属性继承过来 aliases.register(qwe) def _qwe(): List files in long format. ls -la qwTAB qwe List files in long format.对于字符串/列表别名——它们没有地方挂 docstring——使用字典形式 aliases[qwe] {alias: ls -la, doc: List files} aliases | { psg: {alias: [ps, aux], doc: Process list}, g: {alias: git, doc: Git wrapper}, }字典形式的键规则字典形式识别两个键alias必填别名值本身可以是字符串、列表或可调用对象doc可选一行描述。其他键为未来功能保留目前会被忽略。相关实现位于Aliases.__setitem__xonsh/aliases.py#L616 附近。doc 覆盖 docstring当可调用别名同时设置了doc时doc会覆盖函数自身的__doc__——适合在补全中显示简短摘要、在源码中保留详细 docstring def _bar(): Long, detailed description of bar... echo bar aliases[bar] {alias: _bar, doc: Short summary} baTAB bar Short summary重新赋值会清除旧描述不带doc重新赋值同名别名会清除之前的描述避免描述粘在同一个名字下不同的值上aliases[qwe] ls -la # 之前的 List files 描述被清除显示控制默认情况下只有别名带有 docstring或显式doc时才在下拉框中显示描述。对于非别名命令若要同时显示其二进制路径设置$CMD_COMPLETIONS_SHOW_DESC True别名解析机制所有别名无论内建还是用户定义最终都经过Aliases.eval_alias()xonsh/aliases.py#L406递归求值它会不断取最左 token 展开若它也是别名则继续展开如lls -CF、lsls --colorauto的链式展开遇到可调用别名则部分应用剩余参数同时用seen_tokens集合防止egrepegrep --colorauto这类自引用别名陷入死循环。九、参见docs/callable_aliases.rst深入编写可调用别名docs/subprocess.rst子进程运算符与捕获模式docs/xonshrc.rst在 RC 文件中定义别名。赞分享开发工具【免费下载链接】xonsh Python-powered shell. Full-featured, cross-platform and AI-friendly.项目地址https://gitcode.com/gh_mirrors/xo/xonsh点击查看免费下载相关推荐告别冗长命令downkyi命令行参数别名完全指南告别冗长命令downkyi命令行参数别名完全指南 你是否还在为记住 downkyi quality 8K download all output dir /vWingetUI命令行别名为常用命令创建简短别名的技巧WingetUI命令行别名为常用命令创建简短别名的技巧 你是否经常在使用WingetUI时输入冗长的命令本文将教你如何为常用命令创建简短别名大幅提升操作效桌面应用开发工具跨平台告别重复输入notepad--命令别名设置完全指南告别重复输入notepad 命令别名设置完全指南 为什么需要命令别名 你是否还在为频繁输入冗长命令而烦恼在日常文本编辑工作中重复输入复杂命令不仅浪费时间桌面应用上一篇为什么选择AnimateLCM解密快速视频生成的核心优势下一篇RandomColorSwift 项目推荐创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考