このエントリーをはてなブックマークに追加


getoptsを利用して引数を取得する(bashビルドイン)

今回利用するコマンドはgetoptsです。コマンドのgetoptsではありません。
getoptsは、bashのビルドインコマンドです。


スポンサーリンク

関連資料

bashビルドインのgetoptsについて

以下にgetoptsの使いかたを説明します。

getopts引数:先頭の:の意味

getopts ":abc"

先頭に:が存在する場合は、abc以外のオプションが来た場合のエラー処理を自ら記述することを意味します。

  • 先頭に:がある場合
    #!/bin/bash
    # filename: getopts-1.sh
    while getopts ":abc" opts
    do
      case $opts in
        a)
          echo a
          ;;
        b)
          echo b
          ;;
        c)
          echo c
          ;;
      esac
    done
    実行結果
    $ ./getopts-1.sh -abc
    a
    b
    c
    $ ./getopts-1.sh -a -b -c
    a
    b
    c
    先頭に:があるためエラー出力されません。
    $ ./getopts-1.sh -d
    $
  • 先頭に:が無い場合
    #!/bin/bash
    # filename: getopts-2.sh
    while getopts "abc" opts
    do
      case $opts in
        a)
          echo a
          ;;
        b)
          echo b
          ;;
        c)
          echo c
          ;;
      esac
    done
    実行結果
    $ ./getopts-2.sh -abcd
    a
    b
    c
    ./getopts-2.sh: illegal option -- d

getopts引数:後ろの:の意味

後ろに:がある場合は、オプションの後ろに引数があるを指定します。

getopts "abf:"
#!/bin/bash
# filename: getopts-3.sh
while getopts "abf:" opts
do
  case $opts in
    a)
      echo a
      ;;
    b)
      echo b
      ;;
    f)
      TARGET_FILE=$OPTARG 
      ;;
  esac
done

if [ "$TARGET_FILE" != "" ]; then
  echo TARGET = $TARGET_FILE
fi

実行結果

$ ./getopts-3.sh -a -f foo.txt
a
TARGET = foo.txt
$ ./getopts-3.sh -fbar.txt
TARGET = bar.txt
$ ./getopts-3.sh -f
./getopts-3.sh: option requires an argument -- f

自分でエラー処理をする場合

先頭に:を付けることによりオプションのエラー処理を自ら記述しなけらばなりません。
以下に簡単なシェルスクリプト例と実行例を記述します。

#!/bin/bash
# filename: getopts-4.sh
while getopts ":af:" opts
do
  case $opts in
    a)
      echo a
      ;;
    f)
      TARGET_FILE=$OPTARG
      ;;
    :)
      echo "Option -$OPTARG requires an argument !!!" >&2
      ;;
    ¥?)
      echo "What is -$OPTARG option ???" >&2 
      ;;
  esac
done

if [ "$TARGET_FILE" != "" ]; then
  echo TARGET = $TARGET_FILE
fi

実行結果

  • 不正なオプションを渡した場合の実行結果
    $ ./getopts-4.sh -z
    What is -z option???
    \?)に記述された処理が実行されています。
  • オプションに引数が必要なのに引数を渡さないで実行した結果
    $ ./getopts-4.sh -f
    Option -f requires an argument !!!
    :)に記述された処理が実行されています。

getoptsの変数

getoptsには、以下の変数があります。

  • OPTIND
  • OPTARG
  • OPTERR

OPTARGの説明

OPTARGについては上記のサンプルシェルスクリプトで使用しています。
処理対象のオプションが格納されています。

OPTERRの説明

OPTERRの初期値は1になります。
この値を0にするとgetoptsからのエラー出力を抑止できます。
以下のサンプルシェルスクリプトで説明します。

#!/bin/bash
# filename: getopts-5.sh
echo Initial value: OPTERR=$OPTERR
while getopts "af" opts
do
  case $opts in
    a)
      echo a
      ;;
    f)
      OPTERR=0
      ;;
  esac
done
  • 不正なオプションを指定して実行
    $ ./getopts-5.sh -z
    Initial value: OPTERR=1
    ./getopts-5.sh: illegal option -- z
    getoptsの引数の先頭に:がないのでgetoptsによりエラー処理が実行されているのがわかります。
    $ ./getopts-5.sh -f -z
    Initial value: OPTERR=1
    上記は最初に-fオプションを指定しOPTERRの値を0にしています。
    したがって、-zがillegal optionなのですが、エラー表示が抑止されています。

OPTINDの説明

OPTINDの値を表示する簡単なシェルスクリプト

#!/bin/bash
# filename: getopts-6.sh
while getopts "abc" opts
do
  case $opts in
    a)
      echo a
      ;;
    b)
      echo b
      ;;
    c)
      echo c
      ;;
  esac
  echo OPTIND value is $OPTIND
done
  • 1つの引数として実行
    $ ./getopts-6.sh -abc
    a
    OPTIND value is 1
    b
    OPTIND value is 1
    c
    OPTIND value is 2
  • オプションを個々に指定し実行
    $ ./getopts-6.sh -a -b -c
    a
    OPTIND value is 2
    b
    OPTIND value is 3
    c
    OPTIND value is 4
    上記の結果よりOPTINDは引数の位置を管理しています。
    1つの引数として実行した場合は、1つの引数にabc全て含まれているのでOPTINDは1のまま処理され、処理終了後次の位置を示す2となっています。
    個々に指定した-a -b -cは1つずつ処理され次の位置を示す4となります。

OPTINDを使う場面は以下のような場合です。

  • getoptsで処理する以外の引数が存在する場合 以下にサンプルシェルスクリプトです。
    #!/bin/bash
    # filename: getopts-7.sh
    while getopts "abc" opts
    do
      case $opts in
        a)
          ;;
        b)
          ;;
        c)
          ;;
      esac
    done
    
    shift `expr $OPTIND - 1`
    echo $*
    実行結果
    $ ./getopts-7.sh -a -b -c sakura
    sakura

shiftコマンドによりgetoptsで処理されたオプションが消されsakuraだけが残ります。
したがって、getopts以外で使用する引数がある場合などは、OPTINDとshiftを使うことにより引数を残すことができます。
以下のように記述することもできます。

shift $((OPTIND-1))  # shift `expr $OPTIND - 1`

スポンサーリンク


添付ファイル: filegetopts-7.sh 162件 [詳細] filegetopts-4.sh 165件 [詳細] filegetopts-1.sh 232件 [詳細] filegetopts-6.sh 152件 [詳細] filegetopts-3.sh 162件 [詳細] filegetopts-2.sh 155件 [詳細] filegetopts-5.sh 145件 [詳細]

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2015-03-20 (金) 22:27:06 (1213d)