有没有办法知道用户如何从 bash 调用程序？

Question

问题是：我有这个脚本foo.py，如果用户在没有--bar 选项的情况下调用它，我想显示以下错误消息：

Please add the --bar option to your command, like so:
    python foo.py --bar

现在，棘手的部分是用户可能会通过多种方式调用命令：

• 他们可能使用了python foo.py，就像示例中一样
• 他们可能使用过/usr/bin/foo.py
• 他们可能有一个shell别名frob='python foo.py'，实际上运行frob
• 也许它甚至是一个git别名flab=!/usr/bin/foo.py，而他们使用git flab

在每种情况下，我都希望消息能够反映用户如何调用命令，以便我提供的示例有意义。

sys.argv 总是包含foo.py，而/proc/$$/cmdline 不知道别名。在我看来，此信息的唯一可能来源是 bash 本身，但我不知道如何询问。

有什么想法吗？

更新如果我们将可能的场景限制在上面列出的那些呢？

更新 2：很多人写了很好的解释说明为什么在一般情况下这是不可能的，所以我想把我的问题限制在这个：

在以下假设下：

• 脚本以交互方式从 bash 启动
• 脚本以以下三种方式之一之一启动：
  1. foo <args> 其中 foo 是符号链接 /usr/bin/foo -> foo.py
  2. git foo where alias.foo=!/usr/bin/foo in ~/.gitconfig
  3. git baz 其中 alias.baz=!/usr/bin/foo 在 ~/.gitconfig

有没有办法从脚本中区分 1 和 (2,3)？有没有办法从脚本中区分 2 和 3？

我知道这是一个很长的机会，所以我现在接受 Charles Duffy 的回答。

更新 3：到目前为止，最有希望的角度是 Charles Duffy 在下面的 cmets 中提出的。如果我能让我的用户拥有

trap 'export LAST_BASH_COMMAND=$(history 1)' DEBUG

在他们的.bashrc 中，然后我可以在我的代码中使用这样的东西：

like_so = None
cmd = os.environ['LAST_BASH_COMMAND']
if cmd is not None:
    cmd = cmd[8:]  # Remove the history counter
    if cmd.startswith("foo "):
        like_so = "foo --bar " + cmd[4:]
    elif cmd.startswith(r"git foo "):
        like_so = "git foo --bar " + cmd[8:]
    elif cmd.startswith(r"git baz "):
        like_so = "git baz --bar " + cmd[8:]
if like_so is not None:
    print("Please add the --bar option to your command, like so:")
    print("    " + like_so)
else:
    print("Please add the --bar option to your command.")

这样，如果我无法获得他们的调用方法，我会显示一般消息。当然，如果我要依靠更改用户的环境，我不妨确保各种别名导出自己可以查看的环境变量，但至少这种方式允许我对任何使用相同的技术稍后我可能会添加其他脚本。

Answer 1

不，没有办法看到原文（在别名/函数/等之前）。

在 UNIX 中启动程序是在底层系统调用级别完成的：

int execve(const char *path, char *const argv[], char *const envp[]);

值得注意的是，有三个参数：

• 可执行文件的路径
• 一个 argv 数组（其中的第一项 -- argv[0] 或 $0 -- 被传递给该可执行文件以反映启动它的名称）
• 环境变量列表

这里没有一个字符串提供原始用户输入的 shell 命令，从该命令请求新进程的调用。 尤其如此，因为并非所有程序都从 shell 启动；考虑一下你的程序是从另一个 Python 脚本启动的，shell=False。

---

在 UNIX 上，假设您的程序是通过argv[0] 中给出的任何名称启动的，这完全是惯例；这适用于符号链接。

您甚至可以看到标准的 UNIX 工具这样做：

$ ls '*.txt'         # sample command to generate an error message; note "ls:" at the front
ls: *.txt: No such file or directory
$ (exec -a foobar ls '*.txt')   # again, but tell it that its name is "foobar"
foobar: *.txt: No such file or directory
$ alias somesuch=ls             # this **doesn't** happen with an alias
$ somesuch '*.txt'              # ...the program still sees its real name, not the alias!
ls: *.txt: No such file 

---

如果您确实想要生成 UNIX 命令行，请使用 pipes.quote() (Python 2) 或 shlex.quote() (Python 3) 来安全地完成。

try:
    from pipes import quote # Python 2
except ImportError:
    from shlex import quote # Python 3

cmd = ' '.join(quote(s) for s in open('/proc/self/cmdline', 'r').read().split('\0')[:-1])
print("We were called as: {}".format(cmd))

同样，这不会“取消扩展”别名，恢复为调用调用命令的函数的代码等；没有不响铃。

---

那个可以用来在你的父进程树中寻找一个git实例，并发现它的参数列表：

def find_cmdline(pid):
    return open('/proc/%d/cmdline' % (pid,), 'r').read().split('\0')[:-1]

def find_ppid(pid):
    stat_data = open('/proc/%d/stat' % (pid,), 'r').read()
    stat_data_sanitized = re.sub('[(]([^)]+)[)]', '_', stat_data)
    return int(stat_data_sanitized.split(' ')[3])

def all_parent_cmdlines(pid):
    while pid > 0:
        yield find_cmdline(pid)
        pid = find_ppid(pid)

def find_git_parent(pid):
    for cmdline in all_parent_cmdlines(pid):
        if cmdline[0] == 'git':
            return ' '.join(quote(s) for s in cmdline)
    return None

Answer 2

请参阅底部关于最初提议的包装脚本的注释。

一种新的更灵活的方法是让 python 脚本提供一个新的命令行选项，允许用户指定他们希望在错误消息中看到的自定义字符串。

例如，如果用户更喜欢通过别名调用 python 脚本“myPyScript.py”，他们可以通过以下方式更改别名定义：

  alias myAlias='myPyScript.py $@'

到这里：

  alias myAlias='myPyScript.py --caller=myAlias $@'

如果他们更喜欢从 shell 脚本调用 python 脚本，它可以使用额外的命令行选项，如下所示：

  #!/bin/bash
  exec myPyScript.py "$@" --caller=${0##*/}

此方法的其他可能应用：

  bash -c myPyScript.py --caller="bash -c myPyScript.py"

  myPyScript.py --caller=myPyScript.py

为了列出扩展的命令行，这里有一个脚本'pyTest.py'，基于@CharlesDuffy 的反馈，它列出了正在运行的python 脚本的cmdline，以及产生它的父进程。 如果使用了新的 -caller 参数，它会出现在命令行中，虽然别名会被展开等等。

#!/usr/bin/env python

import os, re

with open ("/proc/self/stat", "r") as myfile:
  data = [x.strip() for x in str.split(myfile.readlines()[0],' ')]

pid = data[0]
ppid = data[3]

def commandLine(pid):
  with open ("/proc/"+pid+"/cmdline", "r") as myfile:
    return [x.strip() for x in str.split(myfile.readlines()[0],'\x00')][0:-1]

pid_cmdline = commandLine(pid)
ppid_cmdline = commandLine(ppid)

print "%r" % pid_cmdline
print "%r" % ppid_cmdline

将其保存到名为“pytest.py”的文件中，然后从名为“pytest.sh”的 bash 脚本中使用各种参数调用它后，输出如下：

$ ./pytest.sh a b "c d" e
['python', './pytest.py']
['/bin/bash', './pytest.sh', 'a', 'b', 'c d', 'e']

注意：对原始包装脚本 aliasTest.sh 的批评是有效的。尽管预定义别名的存在是问题规范的一部分，并且可以假定存在于用户环境中，但提案定义了别名（造成误导性印象，即它是推荐的一部分而不是指定的用户环境的一部分），并且它没有显示包装器如何与被调用的 python 脚本通信。在实践中，用户要么必须获取包装器的来源，要么在包装器中定义别名，并且 python 脚本必须将错误消息的打印委托给多个自定义调用脚本（调用信息所在的位置），并且客户端将拥有调用包装脚本。解决这些问题导致了一种更简单的方法，可以扩展到任意数量的其他用例。

这是原始脚本的一个不太容易混淆的版本，供参考：

#!/bin/bash
shopt -s expand_aliases
alias myAlias='myPyScript.py'

# called like this:
set -o history
myAlias $@
_EXITCODE=$?
CALL_HISTORY=( `history` )
_CALLING_MODE=${CALL_HISTORY[1]}

case "$_EXITCODE" in
0) # no error message required
  ;;
1)
  echo "customized error message #1 [$_CALLING_MODE]" 1>&2
  ;;
2)
  echo "customized error message #2 [$_CALLING_MODE]" 1>&2
  ;;
esac

这是输出：

$ aliasTest.sh 1 2 3
['./myPyScript.py', '1', '2', '3']
customized error message #2 [myAlias]

Answer 3

无法区分脚本的解释器是在命令行上显式指定的，还是操作系统从 hashbang 行推断出来的。

证明：

$ cat test.sh 
#!/usr/bin/env bash

ps -o command $$

$ bash ./test.sh 
COMMAND
bash ./test.sh

$ ./test.sh 
COMMAND
bash ./test.sh

这会阻止您检测列表中前两个案例之间的差异。

我也相信没有合理的方法来识别调用命令的其他（中介）方式。

Answer 4

我可以看到两种方法：

• 如 3sky 所建议的，最简单的方法是从 python 脚本中解析命令行。 argparse 可用于以可靠的方式执行此操作。这仅在您可以更改该脚本时才有效。
• 一种更复杂、更通用、更复杂的方法是更改​​系统上的 python 可执行文件。

---

由于第一个选项有据可查，这里有更多关于第二个选项的详细信息：

无论调用脚本的方式如何，都会运行python。这里的目标是用一个脚本替换python 可执行文件，该脚本检查foo.py 是否在参数中，如果是，则检查--bar 是否也在其中。如果没有，打印消息并返回。

在其他情况下，执行真正的 python 可执行文件。

现在，希望通过以下 shebang 运行 python：#!/usr/bin/env python3，或通过python foo.py，而不是#!/usr/bin/python 或/usr/bin/python foo.py 的变体。这样，您可以更改 $PATH 变量，并在您的错误 python 所在的目录前面添加一个目录。

在另一种情况下，您可以替换 /usr/bin/python executable，但有可能无法很好地更新。

一个更复杂的方法可能是使用命名空间和挂载，但以上可能就足够了，特别是如果你有管理员权限。

---

可以用作脚本的示例：

#!/usr/bin/env bash

function checkbar
{
    for i in "$@"
    do
            if [ "$i" = "--bar" ]
            then
                    echo "Well done, you added --bar!"
                    return 0
            fi
    done
    return 1
}

command=$(basename ${1:-none})
if [ $command = "foo.py" ]
then
    if ! checkbar "$@"
    then
        echo "Please add --bar to the command line, like so:"
        printf "%q " $0
        printf "%q " "$@"
        printf -- "--bar\n"
        exit 1
    fi
fi
/path/to/real/python "$@"

但是，在重新阅读您的问题后，很明显我误解了它。在我看来，只打印“foo.py must be called like foo.py --bar”、“please add bar to your arguments”或“please try (instead of )”都可以，不管是什么用户输入：

• 如果这是一个 (git) 别名，这是一次性错误，用户将在创建别名后尝试使用别名，因此他们知道将 --bar 部分放在哪里
• 使用/usr/bin/foo.py 或python foo.py：
  • 如果用户不是真正精通命令行，他们可以只粘贴显示的工作命令，即使他们不知道其中的区别
  • 如果是，他们应该能够毫无困难地理解消息，并调整他们的命令行。

Answer 5

我知道这是bash 任务，但我认为最简单的方法是修改“foo.py”。当然，这取决于脚本的复杂程度，但也许它会适合。这是示例代码：

#!/usr/bin/python

import sys

if len(sys.argv) > 1 and sys.argv[1] == '--bar':
    print 'make magic'
else:
    print 'Please add the --bar option to your command, like so:'
    print '    python foo.py --bar'

在这种情况下，用户如何运行此代码并不重要。

$ ./a.py
Please add the --bar option to your command, like so:
    python foo.py --bar

$ ./a.py -dua
Please add the --bar option to your command, like so:
    python foo.py --bar

$ ./a.py --bar
make magic

$ python a.py --t
Please add the --bar option to your command, like so:
    python foo.py --bar

$ /home/3sky/test/a.py
Please add the --bar option to your command, like so:
    python foo.py --bar

$ alias a='python a.py'
$ a
Please add the --bar option to your command, like so:
    python foo.py --bar

$ a --bar
make magic