Ruby/OptionParser の履歴(No.5)

• 履歴一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• Ruby/OptionParser へ行く。
  • 1 (2015-01-09 (金) 06:51:43)
  • 2 (2016-04-13 (水) 07:47:56)
  • 3 (2016-04-27 (水) 10:51:27)
  • 4 (2018-05-28 (月) 15:07:55)
  • 5 (2022-04-11 (月) 15:28:22)

Tag: Ruby/OptionParser

目次†

関連ページ†

参考情報†

• library optparse

概要†

• コマンドラインオプションを解析するライブラリ。

基本的使用方法†

• 以下のように使用する

  require 'optparse'
  
  opt = OptionParser.new
  opt.banner = "Usage: #{opt.program_name} [-h|--help] <args>"
  opt.separator("#{opt.program_name} Available Options")
  opt.version = '2.3.4'
  opt.on_head('-h', '--help', 'Show this message') do |v|
    puts opt.help
    exit
  end
  opts = {}
  opt.on('-a VAL') {|v| opts[:a] = v }
  opt.on('-b') {|v| opts[:b] = v }
  opt.on('-c VAL', '--check-type=VAL') {|v| opts[:b] = v }
  opt.on('-t VAL', '--type=VAL', ['foo', 'bar' 'baz']) {|v| opts[:t] = v } #選択肢は配列として第二引数に指定
  opt.parse!(ARGV)
  p opts
  
  

• 以下が出力される。

  $ ruby option.rb -a foo -b
  {:a=>"foo", :b=>true}
  

• ヘルプを表示する場合。

  ruby option.rb  --help
  Usage: option [-h|--help] <args>
      -h, --help                       Show this message
  option Available Options
      -a VAL
      -b
      -c, --check-type=VAL
  

• on_head / on_tailはopt.helpで表示されるヘルプ文字列の並びに影響する。on_headはseparatorの前になり、on_tailはonの後ろとなる。
• h / -vはデフォルトでハンドリングされるが、-vのほうは適切な表示を行いたい場合opt.versionを設定しておく。

その他使用方法†

ショートオプションのみを指定†

• 以下のように指定

  opt.on('-a VAL') {|v| opts[:a] = v }
  opt.on('-b') {|v| opts[:b] = v }
  opt.on('-t', 'test option}{|v| opts[:t] = v}
  

• ショートオプションは最初の1文字のみが採用される。例えば"-to"を指定すると"-t o"と解釈される。

  #pre {{
  opt.on('-to', 'test option') {|v| opts[:to] = v}
  }}

ロングオプションのみを指定†

• 以下のように指定

  opt.on('--test-option', 'test option') {|v| opts[:test_option] = v}
  

Tips†

必要な引数が存在しない場合ヘルプを表示して終了する†

• デフォルトで-h / -vオプションがサポートされている。必要な引数がわたっていなかった場合にヘルプを表示して終了したい場合、以下のように処理する。

  opts = {}
  opt = OptionParser.new
  opt.on('-f VAL', '--file=VAL') {|v| opts[:file] = v }
  opt.parse!(ARGV)
  
  
  if opts[:file].nil? || !FileTest.file?(opts[:file])
    puts opt # putsでヘルプが表示sあれる
    exit
  end