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

rubyでは、コマンドライン引数(外部から渡す引数)を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
スポンサーリンク





カテゴリー

今週よく読まれている記事

  1. 学会・会議で英語が絶望的にできなくて困るケース | オンライン開催で「英語力のなさ」を痛感した場合の対処法

    学会・会議で英語ができなくてに困るケース学会やイベント・会議などが、オンラインで開催される…
  2. r tidyverse 使い方 | 列 filter 絞り込み select関数 – dplyrパッケージ

    tidyverseで1つのデータフレームの列の絞り込みは、dplyrパッケージのselect関数を…
  3. プログラミングで疲れた脳をリフレッシュ 〜 鬼滅の刃「感動」と「やる気アップ」でストレス発散!

    ストレス発散は鬼滅で。「50%OFF」で読む!脳のパフォーマンスを上げるには、適度な休憩と…
  4. AWS ディスク容量不足 新しいボリュームを追加する

    バイオインフォマティクスでは大きなファイルを扱うことがあるので、ディスク不足に陥ることがあります。…
  5. 「知っている」と「知らない」とでは、もしものとき、大違いになる – コロナうつ対策

    コロナうつなどという言葉を聞くようになりましたが、派遣切り、解雇、リストラは、これから本格化します…

人気記事

  1. R言語

    R subset関数 データフレームやmatrixからの条件指定による行・列の抽出
    R の subset関数は、データフレームやマトリックスか…
  2. Excel, 統計

    z-score 計算方法 エクセル(Excel) 編
    統計処理で、大きく変化しているなどの判断基準にも使われる値…
  3. IGV, 解析ツール

    IGV 使い方 インストール〜便利な使い方まで | リファレンス・マッピングデータ・アノテーションを読み込んで表示しよう
    IGV(Integrative Genomics View…

おすすめ記事

  1. シェルスクリプト

    シェルスクリプト | ファイル存在チェック・空ファイルチェック
    bashでスクリプトを作成するときに、よく使うのがファイル…
  2. R言語, グラフ

    R 使い方 軸・ラベルの調整(向き・サイズ・色など) グラフの描き方
    Rによるplot(グラフ)の描画は、手軽で大変便利です。た…
  3. awk, シェルスクリプト

    bash 部分文字列・置換・長さ・連結・分割の文字列処理
    bashのよく使う文字列処理、部分文字列・置換・連結・長さ…