如何获得“set -e”的效果和用处？在 shell 函数内？

Question

set -e（或以#!/bin/sh -e 开头的脚本）对于在出现问题时自动轰炸非常有用。它使我不必对每个可能失败的命令进行错误检查。

如何在函数内获得与此等效的内容？

例如，我有以下脚本，该脚本在出现错误时立即退出，并显示错误退出状态：

#!/bin/sh -e

echo "the following command could fail:"
false
echo "this is after the command that fails"

输出符合预期：

the following command could fail:

现在我想将其包装到函数中：

#!/bin/sh -e

my_function() {
    echo "the following command could fail:"
    false
    echo "this is after the command that fails"
}

if ! my_function; then
    echo "dealing with the problem"
fi

echo "run this all the time regardless of the success of my_function"

预期输出：

the following command could fail:
dealing with the problem
run this all the time regardless of the success of my_function

实际输出：（

the following output could fail:
this is after the command that fails
run this all the time regardless of the success of my_function

即函数忽略set -e）

这可能是预期的行为。我的问题是：如何在 shell 函数内获得 set -e 的效果和用处？我希望能够进行一些设置，这样我就不必单独检查每个调用的错误，但脚本将在遇到错误时停止。它应该根据需要展开堆栈，直到我检查结果为止，或者如果我没有检查结果，则退出脚本本身。这就是 set -e 已经做的事情，只是它不嵌套。

我发现同样的问题 在 Stack Overflow 外询问，但没有合适的答案。

Answer 1

我最终选择了这个，这显然是有效的。我一开始尝试了导出方法，但后来发现我需要导出脚本使用的每个全局（常量）变量。

禁用 set -e，然后在启用了 set -e 的子 shell 中运行函数调用。将子shell的退出状态保存在变量中，重新启用set -e，然后测试该变量。

f() { echo "a"; false;  echo "Should NOT get HERE"; }

# Don't pipe the subshell into anything or we won't be able to see its exit status
set +e ; ( set -e; f ) ; err_status=$?
set -e

## cleaner syntax which POSIX sh doesn't support.  Use bash/zsh/ksh/other fancy shells
if ((err_status)) ; then
    echo "f returned false: $err_status"
fi

## POSIX-sh features only (e.g. dash, /bin/sh)
if test "$err_status" -ne 0 ; then
    echo "f returned false: $err_status"
fi

echo "always print this"

您不能将 f 作为管道的一部分运行，也不能作为 || 命令列表的 && 的一部分运行（除非管道或列表中的最后一个命令），或作为 if 或 while 中的条件，或其他忽略 set -e 的上下文。 此代码也不能出现在任何这些上下文中，因此，如果您在函数中使用此代码，调用者必须使用相同的 subshel​​l / save-exit-status 技巧。考虑到限制和难以阅读的语法，这种使用 set -e 实现类似于抛出/捕获异常的语义并不真正适合一般用途。

trap err_handler_function ERR 与 set -e 具有相同的限制，因为它不会在 set -e 不会触发的上下文中触发错误t 在命令失败时退出。

您可能认为以下内容可行，但事实并非如此：

if ! ( set -e; f );then    ##### doesn't work, f runs ignoring -e
    echo "f returned false: $?"
fi

set -e 在子 shell 内不起作用，因为它记住它位于 if 的条件内。我认为作为一个子 shell 会改变这一点，但只有在一个单独的文件中并在其上运行一个完整的单独 shell 才可以工作。

Answer 2

来自 set -e 的文档：

启用此选项后，如果任何简单命令失败
后果中列出的原因
Shell 错误或返回退出状态
值> 0，并且不属于
while 之后的化合物列表，
until 或 if 关键字，并且不是
AND 或 OR 列表的一部分，并且不是
前面带有 ! 保留的管道
字，那么外壳应立即
退出。

在您的情况下，false 是管道的一部分，前面是 ! 和 的一部分 if。因此，解决方案是重写您的代码，使其不再存在。

换句话说，这里的函数没有什么特别的。尝试：

set -e
! { false; echo hi; }

Answer 3

您可以直接使用子 shell 作为函数定义，并使用 set -e 将其设置为立即退出。这会将 set -e 的范围限制为仅函数子 shell，并且稍后可以避免在 set +e 和 set -e 之间切换。

此外，您可以在 if 测试中使用变量赋值，然后在附加的 else 语句中回显结果。

# use subshell for function definition
f() (
   set -exo pipefail
   echo a
   false
   echo Should NOT get HERE
   exit 0
)

# next line also works for non-subshell function given by agsamek above
#if ret="$( set -e && f )" ; then 
if ret="$( f )" ; then
   true
else
   echo "$ret"
fi

# prints
# ++ echo a
# ++ false
# a

Answer 4

这有点混乱，但你可以这样做：

export -f f
if sh -ec f; then 
...

如果你的 shell 支持 export -f （bash 支持），这将起作用。

请注意，这不会终止脚本。回声
f 中的 false 后不会执行，主体也不会执行
if 的一部分，但是 if 后面的语句会被执行。

如果您使用的 shell 不支持 export -f，您可以
通过在函数中运行 sh 来获取所需的语义：

f() { sh -ec '
  echo This will execute
  false
  echo This will not
  '
}

Answer 5

注意/编辑：正如评论者指出的那样，这个答案使用 bash，而不是像他的问题中使用的 OP 那样的 sh。当我最初发布答案时，我错过了这个细节。无论如何，我都会保留这个答案，因为某些路人可能会对它感兴趣。

你准备好了吗？

这是一种利用 DEBUG 陷阱来实现此目的的方法，该陷阱在每个命令之前运行，并且会产生类似于其他语言中的整个异常/try/catch 习惯用法的错误。看看吧。我已经让你的例子又加深了一次“调用”。

#!/bin/bash

# Get rid of that disgusting set -e.  We don't need it anymore!
# functrace allows RETURN and DEBUG traps to be inherited by each
# subshell and function.  Plus, it doesn't suffer from that horrible
# erasure problem that -e and -E suffer from when the command 
# is used in a conditional expression.
set -o functrace

# A trap to bubble up the error unless our magic command is encountered 
# ('catch=$?' in this case) at which point it stops.  Also don't try to
# bubble the error if were not in a function.
trap '{ 
    code=$?
    if [[ $code != 0 ]] && [[ $BASH_COMMAND != '\''catch=$?'\'' ]]; then
        # If were in a function, return, else exit.
        [[ $FUNCNAME ]] && return $code || exit $code
    fi
}' DEBUG

my_function() {
    my_function2
}

my_function2() {
    echo "the following command could fail:"
    false
    echo "this is after the command that fails"
}

# the || isn't necessary, but the 'catch=$?' is.
my_function || catch=$?
echo "Dealing with the problem with errcode=$catch (⌐■_■)"

echo "run this all the time regardless of the success of my_function"

和输出：

the following command could fail:
Dealing with the problem with errcode=1 (⌐■_■)
run this all the time regardless of the success of my_function

我还没有在野外测试过这个，但是在我的脑海中，有很多优点：

1. 实际上并没有那么慢。我在使用和不使用 functrace 选项的紧密循环中运行了该脚本，并且在 10 000 次迭代下时间非常接近。

2. 您可以扩展此 DEBUG 陷阱来打印堆栈跟踪而无需对 $FUNCNAME 和 $BASH_LINENO 进行整个循环。你可以免费得到它（除了实际做回声线）。

3. 不必担心 shopt -s Heritage_errexit 问题。

Answer 6

使用 && 运算符连接函数中的所有命令。这并不是太麻烦，并且会给出您想要的结果。

Answer 7

这是由设计和 POSIX 规范决定的。我们可以在 man bash 中读到：

如果复合命令或 shell 函数在 -e 被忽略的上下文中执行，则在复合命令或函数体内执行的任何命令都不会受到 -e 的影响 设置，即使设置了 -e 并且命令返回失败状态。如果复合命令或 shell 函数在忽略 -e 的上下文中执行时设置了 -e，则在复合命令或包含以下内容的命令之前，该设置不会产生任何效果：函数调用完成。

因此，您应该避免在函数中依赖set -e。

给出以下示例 ^{Austin Group}：

set -e
start() {
   some_server
   echo some_server started successfully
}
start || echo >&2 some_server failed

函数中的 set -e 被忽略，因为该函数是 AND-OR 列表中的命令，而不是最后一个命令。

上述行为是 POSIX 指定和要求的（请参阅：所需操作）：

执行while、until、if之后的复合列表时，应忽略-e设置，或 elif 保留字，以 ! 保留字开头的管道，或 AND-OR 列表中除最后一个以外的任何命令。

Answer 8

我知道这不是您所要求的，但您可能知道也可能不知道您寻求的行为内置于“make”中。 “make”过程的任何部分失败都会中止运行。不过，这是一种与 shell 脚本完全不同的“编程”方式。

Answer 9

您需要在子 shell 中调用函数（在方括号 () 内）才能实现此目的。

我想你想这样写你的脚本：

#!/bin/sh -e

my_function() {
    echo "the following command could fail:"
    false
    echo "this is after the command that fails"
}

(my_function)

if [ $? -ne 0 ] ; then
    echo "dealing with the problem"
fi

echo "run this all the time regardless of the success of my_function"

然后输出是（根据需要）：

the following command could fail:
dealing with the problem
run this all the time regardless of the success of my_function

Answer 10

如果子shell不是一个选项（假设你需要做一些疯狂的事情，比如设置一个变量），那么你可以检查每个可能失败的命令并通过附加 || 来处理它。返回 $?。这会导致函数在失败时返回错误代码。

它很丑陋，但它确实

#!/bin/sh
set -e

my_function() {
    echo "the following command could fail:"
    false || return $?
    echo "this is after the command that fails"
}

if ! my_function; then
    echo "dealing with the problem"
fi

echo "run this all the time regardless of the success of my_function"

有效

the following command could fail:
dealing with the problem
run this all the time regardless of the success of my_function

Answer 11

基于@antak的答案的可重用bash函数：

function try {
  # Run the args in a `set -e` mode.
  # Error code should be checked with `((ERR))`.
  # Please don't check it directly with `if try`, `try ||`, etc.
  # Explained: https://github.com/denis-ryzhkov/cheatsheets/tree/main/bash/try

  set +e
  (set -e; "$@")
  declare -gx ERR=$?
  set -e
}

使用示例：

function func {
  echo "func args: $@"
  func-bug
  echo func-never
}

try func arg1 arg2
if ((ERR))
then echo "func failed"
else echo "func succeeded"
fi

输出：

func args: arg1 arg2
./test.sh: line 3: func-bug: command not found
func failed

详细说明此处。