如何创建一个可以通过位置和命名参数接受信息的通用Bash函数

时间:2013-12-24 17:46:27

标签: bash arguments options getopt getopts

我正在编写大量的Bash函数,这些函数能够从使用位置参数命名参数传递的命令行中获取不同的信息(由getopts提供)。这个想法是,位置论证主要用于轻快和直接的人为控制,而命名论据主要用于清晰度和其他功能的控制。为了说明我如何考虑这个问题,请考虑一个可以从一个事物转换为另一个事物的函数。广义地说,该功能可以在快速模式或高级模式中使用。在快速模式下,指定的参数很少,通常是位置参数,而在高级模式中,可以指定许多参数,通常是命名参数。例如......

快速模式

此模式可以采用以下方式使用:

function fileName1 fileName2

它使用内部假设和自主测量将一个文件转换为另一个文件。

高级模式

此模式可以采用以下方式使用:

function -i fileName1 -o fileName2 -m -r 100 -v

此模式也可以采用以下方式使用:

function -m -v fileName1 fileName2 -r 100

请注意-v不接受任何参数。它只是一个选项(指定诸如详细程度之类的东西)。


所以,这种情况下的逻辑是第一个位置参数假定为fileName1,第二个位置参数假定为fileName2 除非使用-i-o选项指定这些文件名中的任何一个,在这种情况下使用 ,因为它们具有更高的优先级(并且第一个和第二个位置参数被忽略。)

我要求在中以尽可能通用的方式实现这些类型的要求的建议和指导,因为这种方法将应用于150多个函数的库。

3 个答案:

答案 0 :(得分:1)

我使用@ getopt @来解析命令行参数。如果它解决了你的问题我现在不记得了。但它对我有用。

http://linux.die.net/man/1/getopt

答案 1 :(得分:1)

改编自http://rsalveti.wordpress.com/2007/04/03/bash-parsing-arguments-with-getopts/

如何首先尝试getopts,如果失败则恢复为仅使用$ 1 / $ 2 /等。

TEST=
SERVER=
PASSWD=
VERBOSE=
while getopts “ht:r:p:v” OPTION
do
     case $OPTION in
         h)
             usage
             exit 1
             ;;
         t)
             TEST=$OPTARG
             ;;
         r)
             SERVER=$OPTARG
             ;;
         p)
             PASSWD=$OPTARG
             ;;
         v)
             VERBOSE=1
             ;;
         ?)
             usage
             exit
             ;;
     esac
done

if [[ -z $TEST ]] || [[ -z $SERVER ]] || [[ -z $PASSWD ]]
then
     // Set variables from $1/$2/etc....
fi

答案 2 :(得分:1)

请注意,如果您使用getoptsall positional arguments must come after any options。第二个警告是,如果使用getopts来解析函数的参数,则必须在解析任何选项后将全局OPTIND变量重置为1。否则我认为解决方案很简单:

argparse.sh

#!/usr/bin/env bash

func() {
    local args=$*
    local input output verbose
    local r="unset" m=0 verbose=0

    while getopts i:o:mr:v opt; do
        case "$opt" in
            i) input="$OPTARG" ;;
            o) output="$OPTARG" ;;
            r) r="$OPTARG" ;;
            m) m=1 ;;
            v) verbose=1 ;;
        esac
    done
    shift $((OPTIND-1))
    OPTIND=1    # reset global variable

    [[ $input ]]  || input=$1
    [[ $output ]] || output=$2

    echo "=== func $args ==="
    echo "input: $input"
    echo "output: $output"
    echo "verbose: $verbose"
    echo "r: $r"
    echo "m: $m"
    echo
}

func fileName1 fileName2
func -i fileName1 -o fileName2 -m -r 100 -v
func -m -v -r 100 fileName1 fileName2

输出

=== func fileName1 fileName2 ===
input: fileName1
output: fileName2
verbose: 0
r: unset
m: 0

=== func -i fileName1 -o fileName2 -m -r 100 -v ===
input: fileName1
output: fileName2
verbose: 1
r: 100
m: 1

=== func -m -v -r 100 fileName1 fileName2 ===
input: fileName1
output: fileName2
verbose: 1
r: 100
m: 1