ruby コマンドライン引数 optparseの利用 スクリプトの書き方

バイオインフォ道場、くまぞうです。

スクリプトでは、コマンドライン引数(外部から渡す引数)を良く使います。ARGV配列にインデックスを指定することで簡単に取り出せますが、数が多くなると意味がわかりにくくなったり、順番を間違えたりして不便に感じることがあります。そんなときは、optparseライブラリを使うと便利です。

スポンサーリンク



optparse ライブラリとは

コマンドラインのオプションを取り扱うためのライブラリです。シェルコマンドのオプション指定時のように、ロングオプションやショートオプションの形式で名前指定できるようになるので大変便利です。また、ヘルプコマンドが使えるので、コマンドライン引数の指定方法を忘れてしまった場合も安心です。

optparse ライブラリの使い方

基本形

optparseライブラリをrequireして、OptionParser.newのブロック内でオプション解析を行います。hashにオプションを格納しておくと、後から参照する場合も楽です。

require 'optparse'

option = {}
OptionParser.new do |opt|
  opt.on('-f val', 'input file name') {|v| option[:f] = v}

  opt.parse!(ARGV)
end

puts option[:f]

ヘルプ機能

引数の定義内容に従って、ヘルプを表示します。

$ ruby ruby_opt.rb --help
Usage: ruby_opt [options]
    -f file                          input file name

オプションの設定(ショート)

OptionParser.newブロック内に必要なオプションを定義します。引数無しのオプションはオプション名(例:-a)のみ、必須引数ありのオプションはオプション名と引数名(例:-b value)、省略可の引数ありのオプションはオプション名を[]で囲って引数名(例:-c [value])を指定します。尚、必須引数ありのオプションで引数を指定しないとエラーが発生します。

ruby_opt.rb

require 'optparse'

option = {}
OptionParser.new do |opt|
  opt.on('-a',         '引数なし') {|v| option[:a] = v}
  opt.on('-b value',   '引数あり(必須)') {|v| option[:b] = v}
  opt.on('-c [value]', '引数あり(省略可)') {|v| option[:c] = v}

  opt.parse!(ARGV)
end

puts option[:a] if option[:a]
puts option[:b] if option[:b]
puts option[:c] if option[:c]

使い方

$ ruby ruby_opt.rb -a -b BBB -c CCC
true
BBB
CCC

$ ruby ruby_opt.rb -b BBB
BBB

$ ruby ruby_opt.rb -b
エラー発生!missing argument: -b (OptionParser::MissingArgument)

オプションの設定(ショート&ロング)

ショートとロングのオプション設定は、一度に行うことができます。使い方などはショートと同じです

ruby_opt.rb

require 'optparse'

option = {}
OptionParser.new do |opt|
  opt.on('-a',         '--a_long', '引数なし') {|v| option[:a] = v}
  opt.on('-b value',   '--b_long', '引数あり(必須)') {|v| option[:b] = v}
  opt.on('-c [value]', '--c_long', '引数あり(省略可)') {|v| option[:c] = v}

  opt.parse!(ARGV)
end

puts option[:a] if option[:a]
puts option[:b] if option[:b]
puts option[:c] if option[:c]
$ ruby ruby_opt.rb -a --b_long BBB -c CCC
true
BBB
CCC
スポンサーリンク