Question

我正在学习使用Ruby的OptionParser类。如何提高解析器错误消息的质量？以下是包含必填项的标记示例，该标记必须是hour，day，week或month之一。

opt_parser = OptionParser.new do |opts|
  opts.banner = "Usage: #{$0} [options] username"

  times = [:hour, :day, :week, :month]
  opts.on('-t', '--time=TIME', times,
          'Show messages from the last TIME (defaults to weeks)', "Avaliable options are (#{times.join(', ')})") do |time|
    o.time = time
  end
end

以下是一些示例输出。

$ ./script -t
./scraper.rb:195:in `main': missing argument: -t (OptionParser::MissingArgument)
from ./scraper.rb:210:in `<main>'

$ ./script -t not_a_value
./scraper.rb:195:in `main': invalid argument: -t not_a_value (OptionParser::InvalidArgument)
from ./scraper.rb:210:in `<main>'

我希望错误提及可接受的值，例如invalid option for -t 'not_a_value', valid options are hour, day, week, month

Answer 1

OptionParser对此并没有多大帮助，但你可以自己实现它而不会有太多麻烦而仍然是干的。只需自己检查正确性，如果需要就抛出错误。

times = [:hour, :day, :week, :month]
opts.on('-t', '--time=TIME',
    'Show messages from the last TIME (defaults to weeks)',
    "Available options are <#{times.join ', '}>") do |time|
  times.include?(time.to_sym) or 
    raise OptionParser::ParseError.new("time must be one of <#{times.join ', '}>")
  o.time = time
end

使输出更清洁也很好：

  begin
    p.parse!(ARGV)
  rescue OptionParser::ParseError => e
    puts e
    exit 1
  end

Answer 2

我是按照以下方式做的：

begin
    parser.parse! ARGV
rescue OptionParser::InvalidArgument => e
#    puts e.instance_variables
#    puts e.args
#    puts e.reason
    if e.args.include? '-t'
        STDERR.puts "Invalid value of parameter -t. Availible options: #{t_options}"
        puts parser.help
        exit 1
    end
    STDERR.puts e
end

如果参数-t缺少打印输出。否则打印默认错误消息。留下一些注释掉的“放置”行，我帮助你在异常数据中找到其他有用的东西。

Answer 3

当然这很简单：

opt_parser = OptionParser.new do |opts|
  opts.banner = "Usage: #{$0} [options] username"

  times = [:hour, :day, :week, :month]
  begin
    opts.on('-t', '--time=TIME', times,
      'Show messages from the last TIME (defaults to weeks)', "Avaliable options are (#    {times.join(', ')})") do |time|
    o.time = time
    rescue OptionParser::MissingArgument, OptionParser::InvalidArgument
      $stderr.print "Usage: -t <argument> where argument in [:hour, :day, :week, :month]"
    end
  end
end

修改Ruby OptionParser错误消息

3 个答案: