Hvordan angir du en nødvendig bryter (ikke argument) med Ruby OptionParser?

stemmer
44

Jeg skriver et manus, og jeg ønsker å kreve en --hostbryter med verdi, men hvis --hostbryteren ikke er angitt, jeg vil ha muligheten til analyse for å mislykkes.

Jeg kan ikke synes å finne ut hvordan du gjør det. Docs synes å bare spesifisere hvordan du gjør argumentet verdi obligatorisk, ikke selve bryteren.

Publisert på 09/10/2009 klokken 00:38
kilden bruker
På andre språk...                            


8 svar

stemmer
56

Jeg antar du bruker optparse her, selv om den samme teknikken vil fungere for andre alternativ parsing biblioteker.

Den enkleste metoden er sannsynligvis å analysere parametere med ditt valgte alternativ parsing bibliotek og deretter heve en OptionParser :: MissingArgument Unntak hvis verdien av verten er null.

Følgende kode illustrerer

#!/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]}"

Kjører dette eksempelet med en kommandolinje av

./program -h somehost

enkle viser "Host = somehost"

Mens du kjører med en manglende -h og ingen filnavn produserer følgende resultat

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

Og kjører med en kommandolinje av ./program h produserer

/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
Svarte 09/10/2009 kl. 08:53
kilden bruker

stemmer
86

En tilnærming ved hjelp optparse som gir vennlig utgang på mangler brytere:

#!/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}"

Kjører uten -teller -fbryterne viser følgende resultat:

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

Kjøring av parse metode i en begynne / redning leddet tillater vennlig formatering ved andre feil, slik som manglende argumenter eller ugyldige bryterverdiene, for eksempel å føre en streng for -nbryteren.

Svarte 27/01/2010 kl. 18:00
kilden bruker

stemmer
1

Svaret fra ukjente (google) er god, men inneholder en mindre feil.

rescue OptionParser::InvalidArgument, OptionParser::MissingArgument

bør være

OptionParser::InvalidOption, OptionParser::MissingArgument

Ellers optparse.parse!vil utløse standard feil utgang for OptionParser::InvalidOption, ikke den tilpassede meldingen.

Svarte 04/02/2010 kl. 08:19
kilden bruker

stemmer
9

Jeg snudde dette til en perle du kan laste ned og installere fra rubygems.org:

gem install pickled_optparse

Og du kan hente den oppdaterte prosjekt kildekoden på GitHub:
http://github.com/PicklePumpers/pickled_optparse

- Eldre post info -

Dette var virkelig, virkelig plage meg så jeg fikset det og holdt bruken super tørr.

For å gjøre en bryter som kreves bare legge til en: påbudt symbol hvor som helst i rekke alternativer som så:

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

Så på slutten av OptionParser blokk legge en av disse til å skrive ut de manglende brytere og brukerveiledningen:

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

Og til slutt å gjøre det hele fungere må du legge til følgende "optparse_required_switches.rb" filen til prosjektet sted og kreve det når du gjør din kommandolinjen parsing.

Jeg skrev opp en liten artikkel med et eksempel på bloggen min: http://picklepumpers.com/wordpress/?p=949

Og her er den modifiserte OptionParser fil med et eksempel på bruken:

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
Svarte 28/10/2010 kl. 05:46
kilden bruker

stemmer
3

Hvis verten er nødvendig, og sikkert er det ikke et alternativ , det er en krangel .

Med det i tankene, her er en måte å løse problemet. Du kan avhøre ARGVutvalg for å se om en vert har blitt spesifisert, og hvis det ikke har vært, så ring abort("You must specify a host!")eller lignende, for å gjøre programmet avslutter med en feilstatus.

Svarte 23/12/2011 kl. 04:39
kilden bruker

stemmer
2

Hvis du gjør noe som dette:

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

Da someoptions[:host]vil enten være verdien fra kommandolinja, eller nil(hvis du ikke leverer host og / eller ingen verdi etter host), og du kan teste for den enkelt (og betinget bestått) etter parse:

fail "Hostname not provided" unless someoptions[:host]
Svarte 08/04/2013 kl. 15:10
kilden bruker

stemmer
4

Jeg kom opp med en klar og konsis løsning som oppsummerer dine bidrag. Det reiser et OptionParser::MissingArgumentunntak med de manglende argumenter som en melding. Dette unntaket er catched i rescueblokk sammen med resten av unntak fra 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

Kjører dette eksempelet:

 ./program            
missing argument: host
Usage: program [options]
    -h, --host hostname              Host name
Svarte 02/01/2016 kl. 17:51
kilden bruker

stemmer
0

Ideen er å definere en OptionParser, så parse!det, og putsdet hvis noen felt mangler. Innstilling filenametil tom streng som standard er trolig ikke den beste veien å gå, men du fikk ideen.

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}'..."

Hvis -i filenamemangler, viser det:

~/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
Svarte 14/07/2016 kl. 13:21
kilden bruker

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more