1
我在Bash中编写了一个脚本,作为几个监视器的模板。我选择getopt以便能够在CLI上使用长期选项。但是,我有一些问题正确实施。Getopt不解析bash
整个脚本是长了不少,但这是相关部分:
#!/bin/bash
#
# FUNCTION
# main
# DESCRIPTION
# Main function. Everything will be called from here
# ARGS
# Nothing
#
# RETURN CODE
# Nothing
#
# Main function. Everything will be called from here
main() {
# Parse the options and arguments
parse_options "${@}"
# Check if the interval is set to a valid number
check_interval
}
#
# FUNCTION
# check_interval
# DESCRIPTION
# Checks if a number is valid
# ARGS
# 1: number to be checked
# RETURN CODE
# 0: valid
# 1: invalid
#
check_interval() {
# We don't have to worry if interval is set at all, because getopt is already doing this
if (! check_number_pos ${arginterval}); then
echo "Error: invalid interval: ${arginterval}"
show_usage
exit 2
fi
}
#
# FUNCTION
# show_usage
# DESCRIPTION
# This is the Usage section. We a showing the Usage according to docopt standards
# ARGS
# Nothing
# RETURN CODE
# Nothing
#
show_usage() {
echo "Usage:" >&2
echo " ${THIS_SCRIPT_NAME} -i|--interval=<interval in s> [-r | --random [--randomwait=<wait in s>]] [-v|--verbose] [-d|--debug] [--colors]" >&2
echo " ${THIS_SCRIPT_NAME} [-h|--help]" >&2
}
#
# FUNCTION
# check_number_pos
# DESCRIPTION
# Checks if a number is valid and positive
# ARGS
# 1: number to be checked
#
# RETURN CODE
# 0: valid and positive
# 1: invalid or negative
#
check_number_pos() {
local returnval
if [[ "${1}" =~ ^[0-9]+$ ]]; then
returnval=0
else
returnval=1
fi
return ${returnval}
}
#
# FUNCTION
# parse_options
# DESCRIPTION
# Parse options from command line
# ARGS
# @: Arguments and options as given at CLI
# RETURN CODE
# Nothing
#
parse_options() {
# Use getopt(1) to parse options according to POSIX. If it fails, an error is shown, and we're showing the Usage and exit
# Add new options here and also in the case-statement below.
# Short options must be added in the 'options'-section
# Long options must be added in the 'longoptions'-section
# All short options must have a long equivalent
# The --name is set so the error-output will not show 'getopt'-errors but neat <application name>-errors
# Options and longoptions have the following format:
# <letter> Option without argument
# <letter>: Option with mandarory argument
# <letter>:: Option with optional argument <- this is broken for short options and long options without '='. Don't use it!
local -r GETOPT=$(getopt --name ${0} --options hrvdi: --longoptions help,random,verbose,debug,colors,randomwait:,interval: -- "${@}")
if [ ${?} != 0 ]; then
echo "Error: Error while getting arguments"
show_usage
exit 127;
fi
# No options or arguments given. Show Usage.
if [[ "${GETOPT}" == " --" ]]; then
show_usage
exit 127;
fi
# Evaluate GETOPT. We need this to have the quotes in the output of getopt(1) interpreted.
eval set -- "${GETOPT}"
# Walk through all the options. Don't put too much code in here, just point to a function or set a variable.
# Please note, all new options need to be added here but also in the GETOPT line above.
# Note: shift removes the first value from the string, so the option itself will be removed from the GETOPT-string, and the argument is available in $1
# After using an argument, please shift again, so the next option will be the first value in GETOPT
while true;
do
case "${1}" in
-i|--interval)
shift
arginterval=${1}
shift
;;
-r|--random)
shift
flagrandom=1
;;
--randomwait)
shift
flagrandom=1
argrandom=${1}
shift
;;
-v|-d|--verbose|--debug)
flagdebug=1
shift
;;
--colors)
flagcolors=1
shift
;;
-h|--help)
#show_help
exit 0
;;
--)
shift
break
;;
-*)
echo "Error: unrecognized option ${1}"
show_usage
exit 127
;;
*)
show_usage
exit 127
;;
esac
done
}
#Call main function after all
main "${@}"
现在,当我调用脚本以正确的方式,一切都顺利:
$ ./test1.sh -i 10
当我忘了参数,它也做我想要的:
$ ./test1.sh -i
./test1.sh: option requires an argument -- 'i'
Usage:
-i|--interval=<interval in s> [-r | --random [--randomwait=<wait in s>]] [-v|--verbose] [-d|--debug] [--colors]
[-h|--help]
但是,当我只是忘记了参数,并添加一个另外一个,它失败:
$ ./test1.sh -i --colors
Error: invalid interval: --colors
Usage:
-i|--interval=<interval in s> [-r | --random [--randomwait=<wait in s>]] [-v|--verbose] [-d|--debug] [--colors]
[-h|--help]
这是因为我检查的时间间隔为一个整数,但是出于其他目的,这是我如何改变的情况下,这样就不会读选项参数一件危险的事情?到目前为止,getopt并没有很好地服务于我,因为我也遇到了另一个bug /特性:'optional argument'(::)不像我预期的那样工作,因为它只在选项之间用'='时才起作用和论据。
版本:
$ getopt -V
getopt (enhanced) 1.1.4
$ bash --version
GNU bash, version 4.1.2(1)-release (x86_64-redhat-linux-gnu)
确实;类似地,'getup'要求将_optional_选项参数直接附加到option_ - ,而不用短格式的分隔符(例如'-i10'),以'='作为长格式的分隔符(例如'' - -interval = 10') - 因为这是唯一的_unambiguous_方法来做到这一点。 – mklement0
好的,也许我试着让这个想法太傻了,但我希望getopt能够理解 - 色彩是一个'选项',因为我告诉他了。 我会在脚本中增加一些检查来防止输入错误。 –
'--colors'可能是一个选项,但是无法告诉'getopt'它不能成为'-i'的有效参数。 – chepner