Bashでフラグ付きの引数を取得する方法


283

私はbashでこのように配置されたパラメーターを簡単に取得できることを知っています:

$0 または $1

このようなフラグオプションを使用して、各パラメーターの使用目的を指定できるようにしたいと思います。

mysql -u user -h host

位置ではなくフラグで-u param値と-h param値を取得する最良の方法は何ですか?


2
unix.stackexchange.comでも質問/チェックすることをお勧めします
MRR0GERS

8
「bash getopts」のグーグル-たくさんのチュートリアル。
グレン・ジャックマン、2011

89
@ glenn-jackman:名前がわかったので、間違いなくそれをググる。グーグルについてのことは-質問すること-あなたは答えの50%をすでに知っているはずです。
Stann

回答:


291

これは私が通常使う慣用句です:

while test $# -gt 0; do
  case "$1" in
    -h|--help)
      echo "$package - attempt to capture frames"
      echo " "
      echo "$package [options] application [arguments]"
      echo " "
      echo "options:"
      echo "-h, --help                show brief help"
      echo "-a, --action=ACTION       specify an action to use"
      echo "-o, --output-dir=DIR      specify a directory to store output in"
      exit 0
      ;;
    -a)
      shift
      if test $# -gt 0; then
        export PROCESS=$1
      else
        echo "no process specified"
        exit 1
      fi
      shift
      ;;
    --action*)
      export PROCESS=`echo $1 | sed -e 's/^[^=]*=//g'`
      shift
      ;;
    -o)
      shift
      if test $# -gt 0; then
        export OUTPUT=$1
      else
        echo "no output dir specified"
        exit 1
      fi
      shift
      ;;
    --output-dir*)
      export OUTPUT=`echo $1 | sed -e 's/^[^=]*=//g'`
      shift
      ;;
    *)
      break
      ;;
  esac
done

重要なポイントは次のとおりです。

  • $# 引数の数です
  • whileループは、指定されたすべての引数を調べ、caseステートメント内の値を照合します
  • シフトは最初のものを取り去ります。caseステートメント内で複数回シフトして、複数の値を取得できます。

3
--action*--output-dir*ケースは何をしますか?
Lucio 14

1
彼らは環境にもたらす価値を保存するだけです。
フレキソ

22
@Lucio超古いコメントですが、誰かがこのページにアクセスした場合に備えてコメントを追加します。*(ワイルドカード)は、誰かがタイプ--action=[ACTION]する場合とタイプする場合の両方に対応しています--action [ACTION]
クーパー

2
なぜ*)あなたはそこを壊すのですか?あなたは悪いオプションを終了したり無視したりすべきではありませんか?つまり-bad -o dir-o dirパーツは処理されません。
newguy

@newguyいい質問。私は彼らが何か他のものに
陥れる

427

この例では、Bashの組み込みgetoptsコマンドを使用しており、Googleシェルスタイルガイドに基づいています

a_flag=''
b_flag=''
files=''
verbose='false'

print_usage() {
  printf "Usage: ..."
}

while getopts 'abf:v' flag; do
  case "${flag}" in
    a) a_flag='true' ;;
    b) b_flag='true' ;;
    f) files="${OPTARG}" ;;
    v) verbose='true' ;;
    *) print_usage
       exit 1 ;;
  esac
done

注:文字の後にコロンが続く場合(例:)f:、そのオプションには引数が必要です。

使用例: ./script -v -a -b -f filename

getoptsを使用すると、受け入れられた回答よりもいくつかの利点があります。

  • while条件はもっと読みやすく、受け入れられるオプションが何であるかを示します
  • よりクリーンなコード。パラメータの数を数えず、シフトしない
  • オプションに参加できます(例-a -b -c-abc

ただし、大きな欠点は、長いオプションをサポートせず、1文字のオプションのみをサポートすることです。


48
なぜbashビルトインを使用したこの答えがトップの答えではないのか不思議に思います
Will Barnwell

13
後世のために: 'abf:v'の後のコロンは、-fが追加の引数(この場合はファイル名)を取ることを示します。
zahbaz

1
私はこれにエラー行を変更する必要がありました:?) printf '\nUsage: %s: [-a] aflag [-b] bflag\n' $0; exit 2 ;;
アンディ

7
コロンについてのメモを追加していただけませんか?つまり、各文字の後のコロンは引数がないことを意味し、1つのコロンは引数を意味し、2つのコロンはオプションの引数を意味しますか?
limasxgoesto0

3
@WillBarnwellは、質問が質問されてから3年後に追加されたのに対し、トップの回答は同じ日に追加されたことに注意してください。
rbennell 2018

47

getoptはあなたの友達です..簡単な例:

function f () {
TEMP=`getopt --long -o "u:h:" "$@"`
eval set -- "$TEMP"
while true ; do
    case "$1" in
        -u )
            user=$2
            shift 2
        ;;
        -h )
            host=$2
            shift 2
        ;;
        *)
            break
        ;;
    esac 
done;

echo "user = $user, host = $host"
}

f -u myself -h some_host

/ usr / binディレクトリにさまざまな例があるはずです。


3
より広範な例は/usr/share/doc/util-linux/examples、少なくともUbuntuマシンのディレクトリにあります。
Serge Stroobandt、2015年

10

これは、あなたが達成したいことのより簡単な例として役立つと思います。外部ツールを使用する必要はありません。Bashに組み込まれているツールで作業を行うことができます。

function DOSOMETHING {

   while test $# -gt 0; do
           case "$1" in
                -first)
                    shift
                    first_argument=$1
                    shift
                    ;;
                -last)
                    shift
                    last_argument=$1
                    shift
                    ;;
                *)
                   echo "$1 is not a recognized flag!"
                   return 1;
                   ;;
          esac
  done  

  echo "First argument : $first_argument";
  echo "Last argument : $last_argument";
 }

これにより、フラグを使用できるため、パラメーターを渡す順序に関係なく、適切な動作が得られます。

例:

 DOSOMETHING -last "Adios" -first "Hola"

出力:

 First argument : Hola
 Last argument : Adios

この関数をプロファイルに追加するか、スクリプト内に配置できます。

ありがとう!

編集:これをファイルとして保存し、次のように実行します yourfile.sh -last "Adios" -first "Hola"

#!/bin/bash
while test $# -gt 0; do
           case "$1" in
                -first)
                    shift
                    first_argument=$1
                    shift
                    ;;
                -last)
                    shift
                    last_argument=$1
                    shift
                    ;;
                *)
                   echo "$1 is not a recognized flag!"
                   return 1;
                   ;;
          esac
  done  

  echo "First argument : $first_argument";
  echo "Last argument : $last_argument";

私は上記のコードを使用しています&実行しても何も印刷されません。./hello.sh DOSOMETHING -last "Adios" -first "Hola"
dinu0101 2017

@ dinu0101これは関数です。スクリプトではありません。DOSOMETHING -last "Adios" -first "Hola"として使用する必要があります
Matias Barrios

@Matiasに感謝します。わかった。スクリプト内で実行する方法。
dinu0101 2017

1
本当にありがとう@Matias
dinu0101

2
macOSのreturn 1;最後の出力例で使用しcan only 'return' from a function or sourced scriptます。への切り替えexit 1;は期待どおりに動作します。
マティアス2018年

5

別の代替案は、長い--imageまたは短い-iタグを使用でき、コンパイル済みの-i = "example.jpg"または個別の-i example.jpgメソッドで引数を渡すことができる以下の例のようなものを使用することです。。

# declaring a couple of associative arrays
declare -A arguments=();  
declare -A variables=();

# declaring an index integer
declare -i index=1;

# any variables you want to use here
# on the left left side is argument label or key (entered at the command line along with it's value) 
# on the right side is the variable name the value of these arguments should be mapped to.
# (the examples above show how these are being passed into this script)
variables["-gu"]="git_user";  
variables["--git-user"]="git_user";  
variables["-gb"]="git_branch";  
variables["--git-branch"]="git_branch";  
variables["-dbr"]="db_fqdn";  
variables["--db-redirect"]="db_fqdn";  
variables["-e"]="environment";  
variables["--environment"]="environment";

# $@ here represents all arguments passed in
for i in "$@"  
do  
  arguments[$index]=$i;
  prev_index="$(expr $index - 1)";

  # this if block does something akin to "where $i contains ="
  # "%=*" here strips out everything from the = to the end of the argument leaving only the label
  if [[ $i == *"="* ]]
    then argument_label=${i%=*} 
    else argument_label=${arguments[$prev_index]}
  fi

  # this if block only evaluates to true if the argument label exists in the variables array
  if [[ -n ${variables[$argument_label]} ]]
    then
        # dynamically creating variables names using declare
        # "#$argument_label=" here strips out the label leaving only the value
        if [[ $i == *"="* ]]
            then declare ${variables[$argument_label]}=${i#$argument_label=} 
            else declare ${variables[$argument_label]}=${arguments[$index]}
        fi
  fi

  index=index+1;
done;

# then you could simply use the variables like so:
echo "$git_user";

3

ここで、ロバートマクマハンの答えが一番好きです。使用するスクリプトの共有可能なインクルードファイルを作成するのが最も簡単なようです。しかしif [[ -n ${variables[$argument_label]} ]]、「variables:bad array subscript」というメッセージをスローする行に欠陥があるようです。私にはコメントする担当者がいないので、これが適切な「修正」であるとは思えませんが、それをラップしifif [[ -n $argument_label ]] ; thenクリーンアップします。

これが私が最終的に作成したコードです。より良い方法がわかっている場合は、ロバートの回答にコメントを追加してください。

インクルードファイル「flags-declares.sh」

# declaring a couple of associative arrays
declare -A arguments=();
declare -A variables=();

# declaring an index integer
declare -i index=1;

インクルードファイル「flags-arguments.sh」

# $@ here represents all arguments passed in
for i in "$@"
do
  arguments[$index]=$i;
  prev_index="$(expr $index - 1)";

  # this if block does something akin to "where $i contains ="
  # "%=*" here strips out everything from the = to the end of the argument leaving only the label
  if [[ $i == *"="* ]]
    then argument_label=${i%=*}
    else argument_label=${arguments[$prev_index]}
  fi

  if [[ -n $argument_label ]] ; then
    # this if block only evaluates to true if the argument label exists in the variables array
    if [[ -n ${variables[$argument_label]} ]] ; then
      # dynamically creating variables names using declare
      # "#$argument_label=" here strips out the label leaving only the value
      if [[ $i == *"="* ]]
        then declare ${variables[$argument_label]}=${i#$argument_label=} 
        else declare ${variables[$argument_label]}=${arguments[$index]}
      fi
    fi
  fi

  index=index+1;
done;

あなたの「script.sh」

. bin/includes/flags-declares.sh

# any variables you want to use here
# on the left left side is argument label or key (entered at the command line along with it's value) 
# on the right side is the variable name the value of these arguments should be mapped to.
# (the examples above show how these are being passed into this script)
variables["-gu"]="git_user";
variables["--git-user"]="git_user";
variables["-gb"]="git_branch";
variables["--git-branch"]="git_branch";
variables["-dbr"]="db_fqdn";
variables["--db-redirect"]="db_fqdn";
variables["-e"]="environment";
variables["--environment"]="environment";

. bin/includes/flags-arguments.sh

# then you could simply use the variables like so:
echo "$git_user";
echo "$git_branch";
echo "$db_fqdn";
echo "$environment";

3

Python argparseに精通していて、bash引数を解析するためにpythonを呼び出してもかまわない場合は、argparse-bashと呼ばれる非常に使いやすく非常に使いやすいコードがargparse-bash https://github.com/nhoffman/にありますargparse-bash

例は、example.shスクリプトから取得しています。

#!/bin/bash

source $(dirname $0)/argparse.bash || exit 1
argparse "$@" <<EOF || exit 1
parser.add_argument('infile')
parser.add_argument('outfile')
parser.add_argument('-a', '--the-answer', default=42, type=int,
                    help='Pick a number [default %(default)s]')
parser.add_argument('-d', '--do-the-thing', action='store_true',
                    default=False, help='store a boolean [default %(default)s]')
parser.add_argument('-m', '--multiple', nargs='+',
                    help='multiple values allowed')
EOF

echo required infile: "$INFILE"
echo required outfile: "$OUTFILE"
echo the answer: "$THE_ANSWER"
echo -n do the thing?
if [[ $DO_THE_THING ]]; then
    echo " yes, do it"
else
    echo " no, do not do it"
fi
echo -n "arg with multiple values: "
for a in "${MULTIPLE[@]}"; do
    echo -n "[$a] "
done
echo

2

簡単なTLDRを提案します。初心者のための例。

helloworld.shというbashスクリプトを作成します

#!/bin/bash

while getopts "n:" arg; do
  case $arg in
    n) Name=$OPTARG;;
  esac
done

echo "Hello $Name!"

その後-n、スクリプトの実行時にオプションのパラメーターを渡すことができます。

そのようにスクリプトを実行します。

$ bash helloworld.sh -n 'World'

出力

$ Hello World!

ノート

複数のパラメーターを使用する場合:

  1. 次のwhile getops "n:" arg: doようなより多くのパラメータで拡張します while getops "n:o:p:" arg: do
  2. ケーススイッチを追加の変数割り当てで拡張します。などo) Option=$OPTARGp) Parameter=$OPTARG

1
#!/bin/bash

if getopts "n:" arg; then
  echo "Welcome $OPTARG"
fi

それをsample.shとして保存し、実行してみます

sh sample.sh -n John

あなたのターミナルで。


1

複数のフラグを指定したgetoptsの使用に問題があったため、このコードを作成しました。モーダル変数を使用してフラグを検出し、それらのフラグを使用して変数に引数を割り当てます。

フラグに引数がない場合は、CURRENTFLAGを設定する以外の方法を実行できることに注意してください。

    for MYFIELD in "$@"; do

        CHECKFIRST=`echo $MYFIELD | cut -c1`

        if [ "$CHECKFIRST" == "-" ]; then
            mode="flag"
        else
            mode="arg"
        fi

        if [ "$mode" == "flag" ]; then
            case $MYFIELD in
                -a)
                    CURRENTFLAG="VARIABLE_A"
                    ;;
                -b)
                    CURRENTFLAG="VARIABLE_B"
                    ;;
                -c)
                    CURRENTFLAG="VARIABLE_C"
                    ;;
            esac
        elif [ "$mode" == "arg" ]; then
            case $CURRENTFLAG in
                VARIABLE_A)
                    VARIABLE_A="$MYFIELD"
                    ;;
                VARIABLE_B)
                    VARIABLE_B="$MYFIELD"
                    ;;
                VARIABLE_C)
                    VARIABLE_C="$MYFIELD"
                    ;;
            esac
        fi
    done

0

これが私の解決策です。ハイフンなし、1つのハイフン、2つのハイフン、および1つと2つのハイフンを持つパラメーター/値の割り当てを使用してブールフラグを処理できるようにしたいと考えました。

# Handle multiple types of arguments and prints some variables
#
# Boolean flags
# 1) No hyphen
#    create   Assigns `true` to the variable `CREATE`.
#             Default is `CREATE_DEFAULT`.
#    delete   Assigns true to the variable `DELETE`.
#             Default is `DELETE_DEFAULT`.
# 2) One hyphen
#      a      Assigns `true` to a. Default is `false`.
#      b      Assigns `true` to b. Default is `false`.
# 3) Two hyphens
#    cats     Assigns `true` to `cats`. By default is not set.
#    dogs     Assigns `true` to `cats`. By default is not set.
#
# Parameter - Value
# 1) One hyphen
#      c      Assign any value you want
#      d      Assign any value you want
#
# 2) Two hyphens
#   ... Anything really, whatever two-hyphen argument is given that is not
#       defined as flag, will be defined with the next argument after it.
#
# Example:
# ./parser_example.sh delete -a -c VA_1 --cats --dir /path/to/dir
parser() {
    # Define arguments with one hyphen that are boolean flags
    HYPHEN_FLAGS="a b"
    # Define arguments with two hyphens that are boolean flags
    DHYPHEN_FLAGS="cats dogs"

    # Iterate over all the arguments
    while [ $# -gt 0 ]; do
        # Handle the arguments with no hyphen
        if [[ $1 != "-"* ]]; then
            echo "Argument with no hyphen!"
            echo $1
            # Assign true to argument $1
            declare $1=true
            # Shift arguments by one to the left
            shift
        # Handle the arguments with one hyphen
        elif [[ $1 == "-"[A-Za-z0-9]* ]]; then
            # Handle the flags
            if [[ $HYPHEN_FLAGS == *"${1/-/}"* ]]; then
                echo "Argument with one hyphen flag!"
                echo $1
                # Remove the hyphen from $1
                local param="${1/-/}"
                # Assign true to $param
                declare $param=true
                # Shift by one
                shift
            # Handle the parameter-value cases
            else
                echo "Argument with one hyphen value!"
                echo $1 $2
                # Remove the hyphen from $1
                local param="${1/-/}"
                # Assign argument $2 to $param
                declare $param="$2"
                # Shift by two
                shift 2
            fi
        # Handle the arguments with two hyphens
        elif [[ $1 == "--"[A-Za-z0-9]* ]]; then
            # NOTE: For double hyphen I am using `declare -g $param`.
            #   This is the case because I am assuming that's going to be
            #   the final name of the variable
            echo "Argument with two hypens!"
            # Handle the flags
            if [[ $DHYPHEN_FLAGS == *"${1/--/}"* ]]; then
                echo $1 true
                # Remove the hyphens from $1
                local param="${1/--/}"
                # Assign argument $2 to $param
                declare -g $param=true
                # Shift by two
                shift
            # Handle the parameter-value cases
            else
                echo $1 $2
                # Remove the hyphens from $1
                local param="${1/--/}"
                # Assign argument $2 to $param
                declare -g $param="$2"
                # Shift by two
                shift 2
            fi
        fi

    done
    # Default value for arguments with no hypheb
    CREATE=${create:-'CREATE_DEFAULT'}
    DELETE=${delete:-'DELETE_DEFAULT'}
    # Default value for arguments with one hypen flag
    VAR1=${a:-false}
    VAR2=${b:-false}
    # Default value for arguments with value
    # NOTE1: This is just for illustration in one line. We can well create
    #   another function to handle this. Here I am handling the cases where
    #   we have a full named argument and a contraction of it.
    #   For example `--arg1` can be also set with `-c`.
    # NOTE2: What we are doing here is to check if $arg is defined. If not,
    #   check if $c was defined. If not, assign the default value "VD_"
    VAR3=$(if [[ $arg1 ]]; then echo $arg1; else echo ${c:-"VD_1"}; fi)
    VAR4=$(if [[ $arg2 ]]; then echo $arg2; else echo ${d:-"VD_2"}; fi)
}


# Pass all the arguments given to the script to the parser function
parser "$@"


echo $CREATE $DELETE $VAR1 $VAR2 $VAR3 $VAR4 $cats $dir

いくつかの参考文献

  • 主な手順はここにあります
  • すべての引数を関数に渡す方法については、こちらをご覧ください
  • デフォルト値に関する詳細はこちら
  • declaredo に関する詳細情報$ bash -c "help declare"
  • shiftdo に関する詳細情報$ bash -c "help shift"
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.