python - 使用 Python 将复杂参数解析为 shell 脚本

Question

当我编写 shell 脚本时，我经常发现自己大部分时间(尤其是在调试时)都花在处理参数上。我编写或维护的许多脚本很容易超过 80% 的输入解析和清理。我将其与我的 Python 脚本进行比较，其中 argparse为我处理大部分繁重的工作，让我轻松构建复杂的选项结构和清理/字符串解析行为。

因此，我希望能够让 Python 完成这项繁重的工作，然后在我的 shell 脚本中获得这些简化和净化的值，而无需进一步担心用户指定的参数。

举一个具体的例子，我工作的许多 shell 脚本都被定义为以特定的顺序接受它们的参数。您可以调用 start_server.sh --server myserver --port 80 但 start_server.sh --port 80 --server myserver 失败并显示 You must specify a server开始。 - 它使解析代码更简单，但它并不直观。

因此，第一个通过的解决方案可以像让 Python 接收参数、对它们进行排序(将它们的参数放在它们旁边)并返回排序后的参数一样简单。所以 shell 脚本仍然会进行一些解析和清理，但是用户可以输入比 shell 脚本 native 接受的内容更多的任意内容，例如:

# script.sh -o -aR --dir/tmp/test --verbose

#!/bin/bash

args=$(order.py "$@")
# args is set to "-a --dir /tmp/test -o -R --verbose"

# simpler processing now that we can guarantee the order of parameters

这里有一些明显的局限性，特别是 parse.py 无法区分带有参数的最终选项和索引参数的开头，但这似乎并不那么糟糕。

所以这是我的问题:1) 是否有任何现有的(最好是 Python)实用程序可以通过比 bash 更强大的东西启用 CLI 解析，然后我的 bash 脚本的其余部分可以在之后访问它 sanitizer ，或 2) 以前有人这样做过吗？是否存在我不知道的问题或陷阱或更好的解决方案？愿意分享您的实现吗？

---

一个(非常不成熟的)想法:

#!/bin/bash

# Some sort of simple syntax to describe to Python what arguments to accept
opts='
"a", "append", boolean, help="Append to existing file"
"dir", str, help="Directory to run from"
"o", "overwrite", boolean, help="Overwrite duplicates"
"R", "recurse", boolean, help="Recurse into subdirectories"
"v", "verbose", boolean, help="Print additional information"
'

# Takes in CLI arguments and outputs a sanitized structure (JSON?) or fails
p=$(parse.py "Runs complex_function with nice argument parsing" "$opts" "$@")
if [ $? -ne 0 ]; exit 1; fi # while parse outputs usage to stderr

# Takes the sanitized structure and an argument to get
append=$(arg.py "$p" append)
overwrite=$(arg.py "$p" overwrite)
recurse=$(arg.py "$p" recurse)
verbose=$(arg.py "$p" verbose)

cd $(python arg.py "$p" dir)

complex_function $append $overwrite $recurse $verbose

两行代码，以及对预期参数的简明描述，我们就开始了实际的脚本行为。也许我疯了，但这似乎方式比我现在必须做的更好。

---

我看过 Parsing shell script arguments以及类似 easy CLI argument parsing 上的维基页面之类的东西，但其中许多模式感觉笨拙且容易出错，我不喜欢每次编写 shell 脚本时都必须重新实现它们，尤其是当 Python、Java 等拥有如此出色的参数处理库时。

Answer 1

您可能会利用 bash 中的关联数组来帮助实现您的目标。

declare -A opts=($(getopts.py $@))
cd ${opts[dir]}
complex_function ${opts[append]}  ${opts[overwrite]} ${opts[recurse]} \
                 ${opts[verbose]} ${opts[args]}

要使其正常工作，getopts.py 应该是一个 python 脚本，用于解析和清理您的参数。它应该打印如下字符串:

[dir]=/tmp
[append]=foo
[overwrite]=bar
[recurse]=baz
[verbose]=fizzbuzz
[args]="a b c d"

您可以预留一些值来检查选项是否也能够被正确解析和清理。

从 getopts.py 返回:

[__error__]=true

添加到 bash 脚本:

if ${opts[__error__]}; then
    exit 1
fi

如果您更愿意使用 getopts.py 中的退出代码，您可以使用 eval:

getopts=$(getopts.py $@) || exit 1
eval declare -A opts=($getopts)

或者:

getopts=$(getopts.py $@)
if [[ $? -ne 0 ]]; then
    exit 1;
fi
eval declare -A opts=($getopts)