如何处理 Ruby OptionParser 中缺少的强制参数？

Question

在 OptionParser 中，我可以强制选择一个选项，但如果我省略该值，它将采用任何后续选项的名称作为值，从而搞砸命令行解析的其余部分。 这是一个与选项值相呼应的测试用例：

$ ./test_case.rb --input foo --output bar
output  bar
input  foo

现在省略第一个选项的值：

$ ./test_case.rb --input  --output bar
input  --output

是否有某种方法可以防止它采用另一个选项名称作为值？ 谢谢！

这是测试用例代码：

#!/usr/bin/env ruby
require 'optparse'
files = Hash.new

option_parser = OptionParser.new do |opts|
  opts.on('-i', '--input FILENAME', 'Input filename - required') do |filename|
    files[:input] = filename
  end
  opts.on('-o', '--output FILENAME', 'Output filename - required') do |filename|
    files[:output] = filename
  end
end

begin
  option_parser.parse!(ARGV)
rescue OptionParser::ParseError
  $stderr.print "Error: " + $! + "\n"
  exit
end

files.keys.each do |key|
  print "#{key}  #{files[key]}\n"
end

Answer 1

你想做的事情并不是一个好主意。如果你确实有一个名为“--output”的文件怎么办？这是 Unix 上完全有效的文件名。每个 Unix 程序的选项解析的工作方式都与 ruby​​ 程序的工作方式相同，因此您不应该更改它，因为这样您的程序将与其他程序任意不同，这会令人困惑并违反“最少意外原则”。

真正的问题是：你为什么会遇到这个问题？也许您正在从另一个程序运行您的程序，并且父程序提供一个空白文件名作为 --input 的参数，这使其将 --output 视为 --input 的参数。您可以通过始终引用在命令行上传递的文件名来解决此问题：

./test_case.rb --input "" --output "bar"

然后 --input 将为空，这很容易检测到。

另请注意，如果 --input 设置为 --output （并且 --output 不是真实文件），您可以尝试打开 --input 文件。如果失败，请打印一条消息，例如：

can't open input file: --output: file not found

这应该让用户清楚他们做错了什么。

Answer 2

试试这个：

opts.on('-i', '--input FILENAME', 'Input filename - required') do |filename|
  files[:input] = filename
end

opts.on('-o', '--output FILENAME', 'Output filename - required') do |filename|
  files[:output] = filename
end

opts.on("-h", "--help", "Show this message") do 
  puts opts
  exit
end


begin
  ARGV << "-h" if ARGV.size != 2   
  option_parser.parse!(ARGV)
rescue OptionParser::ParseError
  $stderr.print "Error: " + $! + "\n"
  exit
end

Answer 3

在这种情况下，缺少强制的 --output 选项，因此请在调用 parse! 后执行此操作：

unless files[:input] && files[:output]
  $stderr.puts "Error: you must specify both --input and --output options."
  exit 1
end

Answer 4

好的 - 这有效 - on() 调用中的正则表达式允许任何字符串，只要它不以 '-' 开头

如果我不将参数传递给 --input 并且下游还有另一个选项，那么它会将该选项键作为 --input 的参数。 （例如--输入--输出）。正则表达式捕获该错误，然后我检查错误消息。如果它报告的参数以“-”开头，我会输出正确的错误消息，即缺少参数。不漂亮，但似乎有效。

这是我的工作测试用例：

#!/usr/bin/env ruby
require 'optparse'
files = Hash.new

option_parser = OptionParser.new do |opts|
  opts.on('-i FILENAME', '--input FILENAME', /\A[^\-]+/, 'Input filename - required') do |filename|
    files[:input] = filename
  end
  opts.on('-o FILENAME', '--output FILENAME', /\A[^\-]+/, 'Output filename - required') do |filename|
    files[:output] = filename
  end
end

begin
  option_parser.parse!(ARGV)
rescue OptionParser::ParseError
  if $!.to_s =~ /invalid\s+argument\:\s+(\-\-\S+)\s+\-/
    $stderr.print "Error: missing argument: #{$1}\n"
  else 
    $stderr.print "Error: " + $! + "\n"
  end  
  exit
end

files.keys.each do |key|
  print "#{key}  #{files[key]}\n"
end