web-dev-qa-db-ja.com

Ruby OptionParserで、引数ではなく）必要なスイッチをどのように指定しますか？

スクリプトを書いていますが、--Host値で切り替えますが、--Hostスイッチが指定されていません。オプションの解析を失敗させたいです。

私はそれを行う方法を理解できないようです。ドキュメントでは、スイッチ自体ではなく、引数値を必須にする方法のみを指定しているようです。

rubyargumentsoptionparser
47
Teflon Ted

ここではoptparseを使用していると仮定していますが、同じテクニックが他のオプション解析ライブラリでも機能します。

最も簡単な方法は、おそらく、選択したオプション解析ライブラリを使用してパラメータを解析し、Hostの値がnilの場合にOptionParser :: MissingArgument例外を発生させることです。

次のコードは

#!/usr/bin/env Ruby
require 'optparse'

options = {}

optparse = OptionParser.new do |opts|
  opts.on('-h', '--Host HOSTNAME', "Mandatory Host Name") do |f|
    options[:Host] = f
  end
end

optparse.parse!

#Now raise an exception if we have not found a Host option
raise OptionParser::MissingArgument if options[:Host].nil?


puts "Host = #{options[:Host]}"

次のコマンドラインでこの例を実行します

./program -h somehost

単純な表示「Host = somehost」

-hを指定せずにファイル名を指定せずに実行すると、次の出力が生成されます

./program:15: missing argument:  (OptionParser::MissingArgument)

./program -hのコマンドラインで実行すると、

/usr/lib/Ruby/1.8/optparse.rb:451:in `parse': missing argument: -h (OptionParser::MissingArgument)
  from /usr/lib/Ruby/1.8/optparse.rb:1288:in `parse_in_order'
  from /usr/lib/Ruby/1.8/optparse.rb:1247:in `catch'
  from /usr/lib/Ruby/1.8/optparse.rb:1247:in `parse_in_order'
  from /usr/lib/Ruby/1.8/optparse.rb:1241:in `order!'
  from /usr/lib/Ruby/1.8/optparse.rb:1332:in `permute!'
  from /usr/lib/Ruby/1.8/optparse.rb:1353:in `parse!'
  from ./program:13
59
Steve Weet

不足しているスイッチでわかりやすい出力を提供するoptparseを使用するアプローチ：

#!/usr/bin/env Ruby
require 'optparse'

options = {}

optparse = OptionParser.new do |opts|
  opts.on('-f', '--from SENDER', 'username of sender') do |sender|
    options[:from] = sender
  end

  opts.on('-t', '--to RECIPIENTS', 'comma separated list of recipients') do |recipients|
    options[:to] = recipients
  end

  options[:number_of_files] = 1
  opts.on('-n', '--num_files NUMBER', Integer, "number of files to send (default #{options[:number_of_files]})") do |number_of_files|
    options[:number_of_files] = number_of_files
  end

  opts.on('-h', '--help', 'Display this screen') do
    puts opts
    exit
  end
end

begin
  optparse.parse!
  mandatory = [:from, :to]                                         # Enforce the presence of
  missing = mandatory.select{ |param| options[param].nil? }        # the -t and -f switches
  unless missing.empty?                                            #
    raise OptionParser::MissingArgument.new(missing.join(', '))    #
  end                                                              #
rescue OptionParser::InvalidOption, OptionParser::MissingArgument      #
  puts $!.to_s                                                           # Friendly output when parsing fails
  puts optparse                                                          #
  exit                                                                   #
end                                                                      #

puts "Performing task with options: #{options.inspect}"

-tまたは-fスイッチなしで実行すると、次の出力が表示されます。

Missing options: from, to
Usage: test_script [options]
    -f, --from SENDER                username of sender
    -t, --to RECIPIENTS              comma separated list of recipients
    -n, --num_files NUMBER           number of files to send (default 1)
    -h, --help

Begin/rescue句で解析メソッドを実行すると、引数の欠落や無効なスイッチ値など、他の失敗時のわかりやすい書式設定が可能になります。たとえば、-nスイッチに文字列を渡します。

92
volund

これを、rubygems.orgからダウンロードしてインストールできるgemに変えました。

gem install pickled_optparse

また、githubで更新されたプロジェクトソースコードをチェックアウトできます。
http://github.com/PicklePumpers/pickled_optparse

-古い投稿情報-

これは本当に、本当に私を悩ませていたので、私はそれを修正し、使用法をスーパーDRYのままにしました。

スイッチを必須にするには、次のようなオプションの配列のどこかに：requiredシンボルを追加するだけです。

opts.on("-f", "--foo [Bar]", String, :required, "Some required option") do |option|
  @options[:foo] = option
end

次に、OptionParserブロックの最後に、これらのいずれかを追加して、欠落しているスイッチと使用手順を出力します。

if opts.missing_switches?
  puts opts.missing_switches
  puts opts
  exit
end

そして最後に、すべてを機能させるには、次の「optparse_required_switches.rb」ファイルをプロジェクトのどこかに追加し、コマンドライン解析を行うときにそれを要求する必要があります。

私は私のブログで例を使って小さな記事を書きました： http://picklepumpers.com/wordpress/?p=949

そして、変更されたOptionParserファイルとその使用例を示します。

required_switches_example.rb

#!/usr/bin/env Ruby
require 'optparse'
require_relative 'optparse_required_switches'

# Configure options based on command line options
@options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: test [options] in_file[.srt] out_file[.srt]"

  # Note that :required can be anywhere in the parameters

  # Also note that OptionParser is bugged and will only check 
  # for required parameters on the last option, not my bug.

  # required switch, required parameter
  opts.on("-s Short", String, :required, "a required switch with just a short") do |operation|
    @options[:operation] = operation
  end

  # required switch, optional parameter
  opts.on(:required, "--long [Long]", String, "a required switch with just a long") do |operation|
    @options[:operation] = operation
  end

  # required switch, required parameter
  opts.on("-b", "--both ShortAndLong", String, "a required switch with short and long", :required) do |operation|
    @options[:operation] = operation
  end

  # optional switch, optional parameter
  opts.on("-o", "--optional [Whatever]", String, "an optional switch with short and long") do |operation|
    @options[:operation] = operation
  end

  # Now we can see if there are any missing required 
  # switches so we can alert the user to what they 
  # missed and how to use the program properly.
  if opts.missing_switches?
    puts opts.missing_switches
    puts opts
    exit
  end

end.parse!

optparse_required_switches.rb

# Add required switches to OptionParser
class OptionParser

  # An array of messages describing the missing required switches
  attr_reader :missing_switches

  # Convenience method to test if we're missing any required switches
  def missing_switches?
    !@missing_switches.nil?
  end

  def make_switch(opts, block = nil)
    short, long, nolong, style, pattern, conv, not_pattern, not_conv, not_style = [], [], []
    ldesc, sdesc, desc, arg = [], [], []
    default_style = Switch::NoArgument
    default_pattern = nil
    klass = nil
    n, q, a = nil

    # Check for required switches
    required = opts.delete(:required)

    opts.each do |o|

      # argument class
      next if search(:atype, o) do |pat, c|
        klass = notwice(o, klass, 'type')
        if not_style and not_style != Switch::NoArgument
          not_pattern, not_conv = pat, c
        else
          default_pattern, conv = pat, c
        end
      end

      # directly specified pattern(any object possible to match)
      if (!(String === o || Symbol === o)) and o.respond_to?(:match)
        pattern = notwice(o, pattern, 'pattern')
        if pattern.respond_to?(:convert)
          conv = pattern.method(:convert).to_proc
        else
          conv = SPLAT_PROC
        end
        next
      end

      # anything others
      case o
        when Proc, Method
          block = notwice(o, block, 'block')
        when Array, Hash
          case pattern
            when CompletingHash
            when nil
              pattern = CompletingHash.new
              conv = pattern.method(:convert).to_proc if pattern.respond_to?(:convert)
            else
              raise ArgumentError, "argument pattern given twice"
          end
          o.each {|pat, *v| pattern[pat] = v.fetch(0) {pat}}
        when Module
          raise ArgumentError, "unsupported argument type: #{o}", ParseError.filter_backtrace(caller(4))
        when *ArgumentStyle.keys
          style = notwice(ArgumentStyle[o], style, 'style')
        when /^--no-([^\[\]=\s]*)(.+)?/
          q, a = $1, $2
          o = notwice(a ? Object : TrueClass, klass, 'type')
          not_pattern, not_conv = search(:atype, o) unless not_style
          not_style = (not_style || default_style).guess(arg = a) if a
          default_style = Switch::NoArgument
          default_pattern, conv = search(:atype, FalseClass) unless default_pattern
          ldesc << "--no-#{q}"
          long << 'no-' + (q = q.downcase)
          nolong << q
        when /^--\[no-\]([^\[\]=\s]*)(.+)?/
          q, a = $1, $2
          o = notwice(a ? Object : TrueClass, klass, 'type')
          if a
            default_style = default_style.guess(arg = a)
            default_pattern, conv = search(:atype, o) unless default_pattern
          end
          ldesc << "--[no-]#{q}"
          long << (o = q.downcase)
          not_pattern, not_conv = search(:atype, FalseClass) unless not_style
          not_style = Switch::NoArgument
          nolong << 'no-' + o
        when /^--([^\[\]=\s]*)(.+)?/
          q, a = $1, $2
          if a
            o = notwice(NilClass, klass, 'type')
            default_style = default_style.guess(arg = a)
            default_pattern, conv = search(:atype, o) unless default_pattern
          end
          ldesc << "--#{q}"
          long << (o = q.downcase)
        when /^-(\[\^?\]?(?:[^\\\]]|\\.)*\])(.+)?/
          q, a = $1, $2
          o = notwice(Object, klass, 'type')
          if a
            default_style = default_style.guess(arg = a)
            default_pattern, conv = search(:atype, o) unless default_pattern
          end
          sdesc << "-#{q}"
          short << Regexp.new(q)
        when /^-(.)(.+)?/
          q, a = $1, $2
          if a
            o = notwice(NilClass, klass, 'type')
            default_style = default_style.guess(arg = a)
            default_pattern, conv = search(:atype, o) unless default_pattern
          end
          sdesc << "-#{q}"
          short << q
        when /^=/
          style = notwice(default_style.guess(arg = o), style, 'style')
          default_pattern, conv = search(:atype, Object) unless default_pattern
        else
          desc.Push(o)
      end

    end

    default_pattern, conv = search(:atype, default_style.pattern) unless default_pattern
    if !(short.empty? and long.empty?)
      s = (style || default_style).new(pattern || default_pattern, conv, sdesc, ldesc, arg, desc, block)
    elsif !block
      if style or pattern
        raise ArgumentError, "no switch given", ParseError.filter_backtrace(caller)
      end
      s = desc
    else
      short << pattern
      s = (style || default_style).new(pattern, conv, nil, nil, arg, desc, block)
    end

    # Make sure required switches are given
    if required && !(default_argv.include?("-#{short[0]}") || default_argv.include?("--#{long[0]}"))
        @missing_switches ||= [] # Should be placed in initialize if incorporated into Ruby proper

        # This is more clear but ugly and long.
        #missing = "-#{short[0]}" if !short.empty?
        #missing = "#{missing} or " if !short.empty? && !long.empty?
        #missing = "#{missing}--#{long[0]}" if !long.empty?

        # This is less clear and uglier but shorter.
        missing = "#{"-#{short[0]}" if !short.empty?}#{" or " if !short.empty? && !long.empty?}#{"--#{long[0]}" if !long.empty?}"

        @missing_switches << "Missing switch: #{missing}"
    end

    return s, short, long,
      (not_style.new(not_pattern, not_conv, sdesc, ldesc, nil, desc, block) if not_style),
      nolong
  end

end
10
Mike Bethany

私はあなたの貢献を要約する明確で簡潔な解決策を思いつきました。 OptionParser::MissingArgumentメッセージとして引数が欠落している例外。この例外は、rescueブロックからの残りの例外とともに、OptionParserブロックでキャッチされます。

#!/usr/bin/env Ruby
require 'optparse'

options = {}

optparse = OptionParser.new do |opts|
  opts.on('-h', '--Host hostname', "Host name") do |Host|
    options[:Host] = Host
  end
end

begin
  optparse.parse!
  mandatory = [:Host]
  missing = mandatory.select{ |param| options[param].nil? }
  raise OptionParser::MissingArgument, missing.join(', ') unless missing.empty?
rescue OptionParser::ParseError => e
  puts e
  puts optparse
  exit
end

この例を実行する：

 ./program            
missing argument: Host
Usage: program [options]
    -h, --Host hostname              Host name
6
pj.martorell

Hostが必要な場合は、optionではなく、引数。

それを念頭に置いて、問題を解決する方法を次に示します。 ARGV配列に問い合わせて、ホストが指定されているかどうかを確認し、指定されていない場合は、abort("You must specify a Host!")などを呼び出して、プログラムをエラーで終了させます。状態。

4
sampablokuper

このようなことをする場合：

opts.on('-h', '--Host',
          'required Host name [STRING]') do |h|
    someoptions[:Host] = h || nil
  end

そうして someoptions[:Host]は、コマンドラインからの値またはnil（--Hostを指定しない場合、および/または--Hostの後に値を指定しない場合）であり、その後簡単にテストできます（条件付きで失敗します）。解析：

fail "Hostname not provided" unless someoptions[:Host]
2
Uraki66

アイデアは、OptionParserを定義してから、parse! it、および一部のフィールドが欠落している場合はputs it。 filenameをデフォルトで空の文字列に設定するのはおそらく最善の方法ではありませんが、アイデアは得られました。

require 'optparse'

filename = ''
options = OptionParser.new do |opts|
    opts.banner = "Usage: Swift-code-style.rb [options]"

    opts.on("-iNAME", "--input-filename=NAME", "Input filename") do |name|
        filename = name
    end
    opts.on("-h", "--help", "Prints this help") do
        puts opts
        exit
    end
end

options.parse!

if filename == ''
    puts "Missing filename.\n---\n"
    puts options
    exit
end

puts "Processing '#{filename}'..."

-i filenameが欠落しており、次のように表示されます。

~/prj/gem/Swift-code-kit ./Swift-code-style.rb
Missing filename.
---
Usage: Swift-code-style.rb [options]
    -i, --input-filename=NAME        Input filename
    -h, --help                       Prints this help
1
superarts.org

不明（google）からの回答は適切ですが、小さなエラーが含まれています。

rescue OptionParser::InvalidArgument, OptionParser::MissingArgument

あるべき

OptionParser::InvalidOption, OptionParser::MissingArgument

それ以外の場合、optparse.parse!は、カスタムメッセージではなく、OptionParser::InvalidOptionの標準エラー出力をトリガーします。

1
neilfws