Spec-Zone.ru › Ruby 3.1

класс OptionParser

Родитель:
Объект

OptionParser

Новичок в OptionParser?

Посмотрите Руководство.

Введение

OptionParser — это класс для анализа опций командной строки. Он намного более продвинутый, но и проще в использовании, чем GetoptLong, и является более ориентированным на Ruby решением.

Особенности

  1. Указание аргументов и код для их обработки написаны в одном месте.

  2. Он может выводить сводку опций; вам не нужно хранить эту строку отдельно.

  3. Необязательные и обязательные аргументы указываются очень изящно.

  4. Аргументы могут быть автоматически преобразованы в указанный класс.

  5. Аргументы могут быть ограничены определённым набором.

Все эти особенности продемонстрированы в примерах ниже. Полная документация содержится в make_switch.

Минимальный пример

require 'optparse'

options = {}
OptionParser.new do |parser|
  parser.banner = "Usage: example.rb [options]"

  parser.on("-v", "--[no-]verbose", "Run verbosely") do |v|
    options[:verbose] = v
  end
end.parse!

p options
p ARGV

Генерация справки

OptionParser может использоваться для автоматической генерации справки по вашим командам:

require 'optparse'

Options = Struct.new(:name)

class Parser
  def self.parse(options)
    args = Options.new("world")

    opt_parser = OptionParser.new do |parser|
      parser.banner = "Usage: example.rb [options]"

      parser.on("-nNAME", "--name=NAME", "Name to say hello to") do |n|
        args.name = n
      end

      parser.on("-h", "--help", "Prints this help") do
        puts parser
        exit
      end
    end

    opt_parser.parse!(options)
    return args
  end
end
options = Parser.parse %w[--help]

#=>
   # Usage: example.rb [options]
   #     -n, --name=NAME                  Name to say hello to
   #     -h, --help                       Prints this help

Обязательные аргументы

Для опций, требующих аргумент, строки спецификаций опций могут содержать имя опции в верхнем регистре. Если опция используется без требуемого аргумента, будет вызвано исключение.

require 'optparse'

options = {}
OptionParser.new do |parser|
  parser.on("-r", "--require LIBRARY",
            "Require the LIBRARY before executing your script") do |lib|
    puts "You required #{lib}!"
  end
end.parse!

Используется:

$ ruby optparse-test.rb -r
optparse-test.rb:9:in `<main>': missing argument: -r (OptionParser::MissingArgument)
$ ruby optparse-test.rb -r my-library
You required my-library!

Преобразование типов

OptionParser поддерживает возможность принудительного преобразования аргументов командной строки в объекты.

OptionParser поставляется с несколькими готовыми типами преобразования. Они:

  • Date — Всё, что принимается Date.parse

  • DateTime — Всё, что принимается DateTime.parse

  • Time — Всё, что принимается Time.httpdate или Time.parse

  • URI — Всё, что принимается URI.parse

  • Shellwords — Всё, что принимается Shellwords.shellwords

  • String — Любая непустая строка

  • Integer — Любое целое число. Преобразует восьмеричные числа. (например, 124, -3, 040)

  • Float — Любое число с плавающей точкой. (например, 10, 3.14, -100E+13)

  • Numeric — Любое целое число, число с плавающей точкой или рациональное число (1, 3.4, 1/3)

  • DecimalInteger — Как Integer, но без восьмеричного формата.

  • OctalInteger — Как Integer, но без десятичного формата.

  • DecimalNumeric — Десятичное целое число или число с плавающей точкой.

  • TrueClass — Принимает ‘+, yes, true, -, no, false’ и по умолчанию true

  • FalseClass — То же, что и TrueClass, но по умолчанию false

  • Array — Строки, разделенные запятыми (например, 1,2,3)

  • Regexp — Регулярные выражения. Также включает опции.

Мы также можем добавить свои преобразования, о чём мы расскажем ниже.

Использование встроенных преобразований

В качестве примера используется встроенное преобразование Time. Другие встроенные преобразования работают аналогично. OptionParser попытается разобрать аргумент как Time. Если это удастся, то это время будет передано блоку обработчика. В противном случае будет вызвано исключение.

require 'optparse'
require 'optparse/time'
OptionParser.new do |parser|
  parser.on("-t", "--time [TIME]", Time, "Begin execution at given time") do |time|
    p time
  end
end.parse!

Используется:

$ ruby optparse-test.rb  -t nonsense
... invalid argument: -t nonsense (OptionParser::InvalidArgument)
$ ruby optparse-test.rb  -t 10-11-12
2010-11-12 00:00:00 -0500
$ ruby optparse-test.rb  -t 9:30
2014-08-13 09:30:00 -0400

Создание пользовательских преобразований

Метод accept в OptionParser может использоваться для создания преобразователей. Он указывает, какой блок преобразования вызывать всякий раз, когда указывается класс. Пример ниже использует его для извлечения объекта User перед тем, как обработчик on получит его.

require 'optparse'

User = Struct.new(:id, :name)

def find_user id
  not_found = ->{ raise "No User Found for id #{id}" }
  [ User.new(1, "Sam"),
    User.new(2, "Gandalf") ].find(not_found) do |u|
    u.id == id
  end
end

op = OptionParser.new
op.accept(User) do |user_id|
  find_user user_id.to_i
end

op.on("--user ID", User) do |user|
  puts user
end

op.parse!

Используется:

$ ruby optparse-test.rb --user 1
#<struct User id=1, name="Sam">
$ ruby optparse-test.rb --user 2
#<struct User id=2, name="Gandalf">
$ ruby optparse-test.rb --user 3
optparse-test.rb:15:in `block in find_user': No User Found for id 3 (RuntimeError)

Сохранение опций в Hash

Опция into методов order, parse и т. д. сохраняет опции командной строки в Hash.

require 'optparse'

options = {}
OptionParser.new do |parser|
  parser.on('-a')
  parser.on('-b NUM', Integer)
  parser.on('-v', '--verbose')
end.parse!(into: options)

p options

Используется:

$ ruby optparse-test.rb -a
{:a=>true}
$ ruby optparse-test.rb -a -v
{:a=>true, :verbose=>true}
$ ruby optparse-test.rb -a -b 100
{:a=>true, :b=>100}

Полный пример

Следующий пример — полная программа Ruby. Вы можете запустить её и увидеть эффект указания различных опций. Это, вероятно, лучший способ изучить возможности optparse.

require 'optparse'
require 'optparse/time'
require 'ostruct'
require 'pp'

class OptparseExample
  Version = '1.0.0'

  CODES = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
  CODE_ALIASES = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" }

  class ScriptOptions
    attr_accessor :library, :inplace, :encoding, :transfer_type,
                  :verbose, :extension, :delay, :time, :record_separator,
                  :list

    def initialize
      self.library = []
      self.inplace = false
      self.encoding = "utf8"
      self.transfer_type = :auto
      self.verbose = false
    end

    def define_options(parser)
      parser.banner = "Usage: example.rb [options]"
      parser.separator ""
      parser.separator "Specific options:"

      # add additional options
      perform_inplace_option(parser)
      delay_execution_option(parser)
      execute_at_time_option(parser)
      specify_record_separator_option(parser)
      list_example_option(parser)
      specify_encoding_option(parser)
      optional_option_argument_with_keyword_completion_option(parser)
      boolean_verbose_option(parser)

      parser.separator ""
      parser.separator "Common options:"
      # No argument, shows at tail.  This will print an options summary.
      # Try it and see!
      parser.on_tail("-h", "--help", "Show this message") do
        puts parser
        exit
      end
      # Another typical switch to print the version.
      parser.on_tail("--version", "Show version") do
        puts Version
        exit
      end
    end

    def perform_inplace_option(parser)
      # Specifies an optional option argument
      parser.on("-i", "--inplace [EXTENSION]",
                "Edit ARGV files in place",
                "(make backup if EXTENSION supplied)") do |ext|
        self.inplace = true
        self.extension = ext || ''
        self.extension.sub!(/\A\.?(?=.)/, ".")  # Ensure extension begins with dot.
      end
    end

    def delay_execution_option(parser)
      # Cast 'delay' argument to a Float.
      parser.on("--delay N", Float, "Delay N seconds before executing") do |n|
        self.delay = n
      end
    end

    def execute_at_time_option(parser)
      # Cast 'time' argument to a Time object.
      parser.on("-t", "--time [TIME]", Time, "Begin execution at given time") do |time|
        self.time = time
      end
    end

    def specify_record_separator_option(parser)
      # Cast to octal integer.
      parser.on("-F", "--irs [OCTAL]", OptionParser::OctalInteger,
                "Specify record separator (default \\0)") do |rs|
        self.record_separator = rs
      end
    end

    def list_example_option(parser)
      # List of arguments.
      parser.on("--list x,y,z", Array, "Example 'list' of arguments") do |list|
        self.list = list
      end
    end

    def specify_encoding_option(parser)
      # Keyword completion.  We are specifying a specific set of arguments (CODES
      # and CODE_ALIASES - notice the latter is a Hash), and the user may provide
      # the shortest unambiguous text.
      code_list = (CODE_ALIASES.keys + CODES).join(', ')
      parser.on("--code CODE", CODES, CODE_ALIASES, "Select encoding",
                "(#{code_list})") do |encoding|
        self.encoding = encoding
      end
    end

    def optional_option_argument_with_keyword_completion_option(parser)
      # Optional '--type' option argument with keyword completion.
      parser.on("--type [TYPE]", [:text, :binary, :auto],
                "Select transfer type (text, binary, auto)") do |t|
        self.transfer_type = t
      end
    end

    def boolean_verbose_option(parser)
      # Boolean switch.
      parser.on("-v", "--[no-]verbose", "Run verbosely") do |v|
        self.verbose = v
      end
    end
  end

  #
  # Return a structure describing the options.
  #
  def parse(args)
    # The options specified on the command line will be collected in
    # *options*.

    @options = ScriptOptions.new
    @args = OptionParser.new do |parser|
      @options.define_options(parser)
      parser.parse!(args)
    end
    @options
  end

  attr_reader :parser, :options
end  # class OptparseExample

example = OptparseExample.new
options = example.parse(ARGV)
pp options # example.options
pp ARGV

Модуль Completion оболочки

Для современных оболочек (например, bash, zsh и т. д.) можно использовать автодополнение для опций командной строки.

Дополнительная документация

Приведенные выше примеры, а также прилагаемое Руководство, должны быть достаточно для того, чтобы понять, как использовать этот класс. Если у вас возникнут какие-либо вопросы, отправьте тикет на bugs.ruby-lang.org.

Константы

DecimalInteger

Формат десятичного целого числа, подлежащий преобразованию в Integer.

DecimalNumeric

Формат десятичного целого/вещественного числа, подлежащий преобразованию в Integer для целочисленного формата, Float для формата с плавающей точкой.

OctalInteger

Формат целочисленного числа в восьмеричной/шестнадцатеричной/двоичной системе (подобно Ruby/C), подлежащий преобразованию в Integer.

Version

Атрибуты

banner[W]

Заголовок-баннер, предшествующий описанию.

default_argv[RW]

Строки, подлежащие парсингу по умолчанию.

program_name[W]

Имя программы, отображаемое в сообщении об ошибке и по умолчанию в баннере, по умолчанию равно $0.

release[W]

Код выпуска

require_exact[RW]

Требовать точное соответствие опций (запрещает предоставление сокращенной длинной опции в качестве короткой опции).

set_banner[W]

Заголовок-баннер, предшествующий описанию.

set_program_name[W]

Имя программы, отображаемое в сообщении об ошибке и по умолчанию в баннере, по умолчанию равно $0.

set_summary_indent[RW]

Отступ для описания. Должен быть String (или иметь метод + String).

set_summary_width[RW]

Ширина части описания списка опций. Должна быть Numeric.

summary_indent[RW]

Отступ для описания. Должен быть String (или иметь метод + String).

summary_width[RW]

Ширина части описания списка опций. Должна быть Numeric.

version[W]

Version

Публичные методы класса

accept(*args, &blk) Показать исходный код
# File lib/optparse.rb, line 1139
def self.accept(*args, &blk) top.accept(*args, &blk) end

См. accept.

each_const(path, base = ::Object) Показать исходный код
# File lib/optparse/version.rb, line 50
def each_const(path, base = ::Object)
  path.split(/::|\//).inject(base) do |klass, name|
    raise NameError, path unless Module === klass
    klass.constants.grep(/#{name}/i) do |c|
      klass.const_defined?(c) or next
      klass.const_get(c)
    end
  end
end
getopts(*args) Показать исходный код
# File lib/optparse.rb, line 1733
def self.getopts(*args)
  new.getopts(*args)
end

См. getopts.

inc(arg, default = nil) Показать исходный код
# File lib/optparse.rb, line 1074
def self.inc(arg, default = nil)
  case arg
  when Integer
    arg.nonzero?
  when nil
    default.to_i + 1
  end
end

Возвращает увеличенное значение default в соответствии с arg.

new(banner = nil, width = 32, indent = ' ' * 4) { |self| ... } Показать исходный код
# File lib/optparse.rb, line 1093
def initialize(banner = nil, width = 32, indent = ' ' * 4)
  @stack = [DefaultList, List.new, List.new]
  @program_name = nil
  @banner = banner
  @summary_width = width
  @summary_indent = indent
  @default_argv = ARGV
  @require_exact = false
  add_officious
  yield self if block_given?
end

Инициализирует экземпляр и передает его, если вызвана с блоком.

banner

Сообщение баннера.

width

Ширина описания.

indent

Отступ описания.

reject(*args, &blk) Показать исходный код
# File lib/optparse.rb, line 1152
def self.reject(*args, &blk) top.reject(*args, &blk) end

См. reject.

search_const(klass, name) { |klass, cname, const| ... } Показать исходный код
# File lib/optparse/version.rb, line 60
def search_const(klass, name)
  klasses = [klass]
  while klass = klasses.shift
    klass.constants.each do |cname|
      klass.const_defined?(cname) or next
      const = klass.const_get(cname)
      yield klass, cname, const if name === cname
      klasses << const if Module === const and const != ::Object
    end
  end
end
show_version(*pkgs) Показать исходный код
# File lib/optparse/version.rb, line 5
def show_version(*pkgs)
  progname = ARGV.options.program_name
  result = false
  show = proc do |klass, cname, version|
    str = "#{progname}"
    unless klass == ::Object and cname == :VERSION
      version = version.join(".") if Array === version
      str << ": #{klass}" unless klass == Object
      str << " version #{version}"
    end
    [:Release, :RELEASE].find do |rel|
      if klass.const_defined?(rel)
        str << " (#{klass.const_get(rel)})"
      end
    end
    puts str
    result = true
  end
  if pkgs.size == 1 and pkgs[0] == "all"
    self.search_const(::Object, /\AV(?:ERSION|ersion)\z/) do |klass, cname, version|
      unless cname[1] == ?e and klass.const_defined?(:Version)
        show.call(klass, cname.intern, version)
      end
    end
  else
    pkgs.each do |pkg|
      begin
        pkg = pkg.split(/::|\//).inject(::Object) {|m, c| m.const_get(c)}
        v = case
            when pkg.const_defined?(:Version)
              pkg.const_get(n = :Version)
            when pkg.const_defined?(:VERSION)
              pkg.const_get(n = :VERSION)
            else
              n = nil
              "unknown"
            end
        show.call(pkg, n, v)
      rescue NameError
      end
    end
  end
  result
end
terminate(arg = nil) Показать исходный код
# File lib/optparse.rb, line 1119
def self.terminate(arg = nil)
  throw :terminate, arg
end
top() Показать исходный код
# File lib/optparse.rb, line 1124
def self.top() DefaultList end
with(*args, &block) Показать исходный код
# File lib/optparse.rb, line 1065
def self.with(*args, &block)
  opts = new(*args)
  opts.instance_eval(&block)
  opts
end

Инициализирует новый экземпляр и вычисляет необязательный блок в контексте экземпляра. Аргументы args передаются в new, см. там описание параметров.

Этот метод устарел, его поведение соответствует более старому методу new.

Общедоступные методы экземпляра

abort(mesg = $!) Показать исходный код
# File lib/optparse.rb, line 1237
def abort(mesg = $!)
  super("#{program_name}: #{mesg}")
end
Вызывает метод суперкласса Kernel#abort
accept(*args, &blk) Показать исходный код
# File lib/optparse.rb, line 1135
def accept(*args, &blk) top.accept(*args, &blk) end

Направляет на принятие указанного класса t. Строка аргумента передаётся в блок, в котором она должна быть преобразована в желаемый класс.

t

Указатель класса аргумента, любой объект, включая Class.

pat

Шаблон для аргумента, по умолчанию t, если он отвечает на match.

accept(t, pat, &block)
additional_message(typ, opt) Показать исходный код
# File lib/optparse.rb, line 1784
def additional_message(typ, opt)
  return unless typ and opt and defined?(DidYouMean::SpellChecker)
  all_candidates = []
  visit(:get_candidates, typ) do |candidates|
    all_candidates.concat(candidates)
  end
  all_candidates.select! {|cand| cand.is_a?(String) }
  checker = DidYouMean::SpellChecker.new(dictionary: all_candidates)
  DidYouMean.formatter.message_for(all_candidates & checker.correct(opt))
end

Возвращает дополнительную информацию.

banner() Показать исходный код
# File lib/optparse.rb, line 1181
def banner
  unless @banner
    @banner = +"Usage: #{program_name} [options]"
    visit(:add_banner, @banner)
  end
  @banner
end

Заголовок-баннер, предшествующий сводке.

base() Показать исходный код
# File lib/optparse.rb, line 1251
def base
  @stack[1]
end

Предмет on_tail.

candidate(word) Показать исходный код
# File lib/optparse.rb, line 1795
def candidate(word)
  list = []
  case word
  when '-'
    long = short = true
  when /\A--/
    word, arg = word.split(/=/, 2)
    argpat = Completion.regexp(arg, false) if arg and !arg.empty?
    long = true
  when /\A-/
    short = true
  end
  pat = Completion.regexp(word, long)
  visit(:each_option) do |opt|
    next unless Switch === opt
    opts = (long ? opt.long : []) + (short ? opt.short : [])
    opts = Completion.candidate(word, true, pat, &opts.method(:each)).map(&:first) if pat
    if /\A=/ =~ opt.arg
      opts.map! {|sw| sw + "="}
      if arg and CompletingHash === opt.pattern
        if opts = opt.pattern.candidate(arg, false, argpat)
          opts.map!(&:last)
        end
      end
    end
    list.concat(opts)
  end
  list
end
def_head_option(*opts, &block)
Псевдоним для: define_head
def_option(*opts, &block)
Псевдоним для: define
def_tail_option(*opts, &block)
Псевдоним для: define_tail
define(*params, &block) Показать исходный код
# File lib/optparse.rb, line 1463
def define(*opts, &block)
  top.append(*(sw = make_switch(opts, block)))
  sw[0]
end

Создаёт параметр из заданных параметров params. См. Параметры для новых параметров.

Блок, если задан, является обработчиком созданного параметра. Когда параметр встречается во время разбора командной строки, блок вызывается с аргументом, заданным для параметра, если таковой имеется. См. Обработчики параметров.

Также алиас: def_option
define_by_keywords(options, method, **params) Показать исходный код
# File lib/optparse/kwargs.rb, line 10
def define_by_keywords(options, meth, **opts)
  meth.parameters.each do |type, name|
    case type
    when :key, :keyreq
      op, cl = *(type == :key ? %w"[ ]" : ["", ""])
      define("--#{name}=#{op}#{name.upcase}#{cl}", *opts[name]) do |o|
        options[name] = o
      end
    end
  end
  options
end

Создаёт параметр из заданных параметров params. См. Параметры для новых параметров.

Блок, если задан, является обработчиком созданного параметра. Когда параметр встречается во время разбора командной строки, блок вызывается с аргументом, заданным для параметра, если таковой имеется. См. Обработчики параметров.

define_head(*params, &block) Показать исходный код
# File lib/optparse.rb, line 1484
def define_head(*opts, &block)
  top.prepend(*(sw = make_switch(opts, block)))
  sw[0]
end

Создаёт параметр из заданных параметров params. См. Параметры для новых параметров.

Блок, если задан, является обработчиком созданного параметра. Когда параметр встречается во время разбора командной строки, блок вызывается с аргументом, заданным для параметра, если таковой имеется. См. Обработчики параметров.

Также алиас: def_head_option
define_tail(*params, &block) Показать исходный код
# File lib/optparse.rb, line 1507
def define_tail(*opts, &block)
  base.append(*(sw = make_switch(opts, block)))
  sw[0]
end

Создаёт параметр из заданных параметров params. См. Параметры для новых параметров.

Блок, если задан, является обработчиком созданного параметра. Когда параметр встречается во время разбора командной строки, блок вызывается с аргументом, заданным для параметра, если таковой имеется. См. Обработчики параметров.

Также алиас: def_tail_option
environment(env = File.basename($0, '.*')) Показать исходный код
# File lib/optparse.rb, line 1865
def environment(env = File.basename($0, '.*'))
  env = ENV[env] || ENV[env.upcase] or return
  require 'shellwords'
  parse(*Shellwords.shellwords(env))
end

Парсит переменную окружения env или её верхний регистр с разделением, как в оболочке.

env по умолчанию является базовым именем программы.

getopts(*args) Показать исходный код
# File lib/optparse.rb, line 1698
def getopts(*args)
  argv = Array === args.first ? args.shift : default_argv
  single_options, *long_options = *args

  result = {}

  single_options.scan(/(.)(:)?/) do |opt, val|
    if val
      result[opt] = nil
      define("-#{opt} VAL")
    else
      result[opt] = false
      define("-#{opt}")
    end
  end if single_options

  long_options.each do |arg|
    arg, desc = arg.split(';', 2)
    opt, val = arg.split(':', 2)
    if val
      result[opt] = val.empty? ? nil : val
      define("--#{opt}=#{result[opt] || "VAL"}", *[desc].compact)
    else
      result[opt] = false
      define("--#{opt}", *[desc].compact)
    end
  end

  parse_in_order(argv, result.method(:[]=))
  result
end

Метод-обёртка для getopts.rb.

params = ARGV.getopts("ab:", "foo", "bar:", "zot:Z;zot option")
# params["a"] = true   # -a
# params["b"] = "1"    # -b1
# params["foo"] = "1"  # --foo
# params["bar"] = "x"  # --bar x
# params["zot"] = "z"  # --zot Z
help() Показать исходный код
# File lib/optparse.rb, line 1293
def help; summarize("#{banner}".sub(/\n?\z/, "\n")) end

Возвращает строку сводки параметров.

Также алиас: to_s
inc(*args) Показать исходный код
# File lib/optparse.rb, line 1082
def inc(*args)
  self.class.inc(*args)
end
load(filename = nil) Показать исходный код
# File lib/optparse.rb, line 1833
def load(filename = nil)
  unless filename
    basename = File.basename($0, '.*')
    return true if load(File.expand_path(basename, '~/.options')) rescue nil
    basename << ".options"
    return [
      # XDG
      ENV['XDG_CONFIG_HOME'],
      '~/.config',
      *ENV['XDG_CONFIG_DIRS']&.split(File::PATH_SEPARATOR),

      # Haiku
      '~/config/settings',
    ].any? {|dir|
      next if !dir or dir.empty?
      load(File.expand_path(basename, dir)) rescue nil
    }
  end
  begin
    parse(*IO.readlines(filename).each {|s| s.chomp!})
    true
  rescue Errno::ENOENT, Errno::ENOTDIR
    false
  end
end

Загружает параметры из имён файлов как filename. Ничего не делает, если файла нет. Возвращает, загрузился ли он успешно.

filename по умолчанию является базовым именем программы без суффикса в каталоге ~/.options, затем базовое имя с суффиксом '.options' в стандартных местах XDG и Haiku.

make_switch(params, block = nil) Показать исходный код
# File lib/optparse.rb, line 1325
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
  q, a = nil
  has_arg = false

  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}"
      (q = q.downcase).tr!('_', '-')
      long << "no-#{q}"
      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}"
      (o = q.downcase).tr!('_', '-')
      long << o
      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}"
      (o = q.downcase).tr!('_', '-')
      long << o
    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
      else
        has_arg = true
      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?)
    if has_arg and default_style == Switch::NoArgument
      default_style = Switch::RequiredArgument
    end
    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
  return s, short, long,
    (not_style.new(not_pattern, not_conv, sdesc, ldesc, nil, desc, block) if not_style),
    nolong
end

Создаёт параметр из заданных параметров params. См. Параметры для новых параметров.

Блок, если задан, является обработчиком созданного параметра. Когда параметр встречается во время разбора командной строки, блок вызывается с аргументом, заданным для параметра, если таковой имеется. См. Обработчики параметров.

new() { |self| ... } Показать исходный код
# File lib/optparse.rb, line 1258
def new
  @stack.push(List.new)
  if block_given?
    yield self
  else
    self
  end
end

Добавляет новый List.

on(*params, &block) Показать исходный код
# File lib/optparse.rb, line 1473
def on(*opts, &block)
  define(*opts, &block)
  self
end

Создаёт параметр из заданных параметров params. См. Параметры для новых параметров.

Блок, если задан, является обработчиком созданного параметра. Когда параметр встречается во время разбора командной строки, блок вызывается с аргументом, заданным для параметра, если таковой имеется. См. Обработчики параметров.

END_OF_DOCUMENT_MARKER
on_head(*params, &block) Показать исходный код
# File lib/optparse.rb, line 1496
def on_head(*opts, &block)
  define_head(*opts, &block)
  self
end

Создаёт опцию из заданных параметров params. См. Параметры для новых опций.

Блок, если он задан, является обработчиком для созданной опции. Когда опция встречается во время парсинга командной строки, блок вызывается с аргументом, заданным для опции, если таковой имеется. См. Обработчики опций.

Новая опция добавляется в начало списка.

on_tail(*params, &block) Показать исходный код
# File lib/optparse.rb, line 1520
def on_tail(*opts, &block)
  define_tail(*opts, &block)
  self
end

Создаёт опцию из заданных параметров params. См. Параметры для новых опций.

Блок, если он задан, является обработчиком для созданной опции. Когда опция встречается во время парсинга командной строки, блок вызывается с аргументом, заданным для опции, если таковой имеется. См. Обработчики опций.

Новая опция добавляется в конец списка.

order(*argv, into: nil, &nonopt) Показать исходный код
# File lib/optparse.rb, line 1542
def order(*argv, into: nil, &nonopt)
  argv = argv[0].dup if argv.size == 1 and Array === argv[0]
  order!(argv, into: into, &nonopt)
end

Парсит аргументы командной строки argv в порядке следования. Когда задан блок, каждый не являющийся опцией аргумент передаётся в этот блок. Когда предоставляется необязательный into ключевой аргумент, значения проанализированных опций сохраняются там посредством метода []= (поэтому он может быть Hash, или OpenStruct, или другим аналогичным объектом).

Возвращает оставшиеся argv необработанными аргументы.

order!(argv = default_argv, into: nil, &nonopt) Показать исходный код
# File lib/optparse.rb, line 1551
def order!(argv = default_argv, into: nil, &nonopt)
  setter = ->(name, val) {into[name.to_sym] = val} if into
  parse_in_order(argv, setter, &nonopt)
end

То же, что и order, но переключатели удаляются деструктивно. Не являющиеся опцией аргументы остаются в argv.

parse(*argv, into: nil) Показать исходный код
# File lib/optparse.rb, line 1671
def parse(*argv, into: nil)
  argv = argv[0].dup if argv.size == 1 and Array === argv[0]
  parse!(argv, into: into)
end

Парсит аргументы командной строки argv в порядке следования, когда переменная окружения POSIXLY_CORRECT установлена, и в режиме перестановки в противном случае. Когда предоставляется необязательный into ключевой аргумент, значения проанализированных опций сохраняются там посредством метода []= (поэтому он может быть Hash, или OpenStruct, или другим аналогичным объектом).

parse!(argv = default_argv, into: nil) Показать исходный код
# File lib/optparse.rb, line 1680
def parse!(argv = default_argv, into: nil)
  if ENV.include?('POSIXLY_CORRECT')
    order!(argv, into: into)
  else
    permute!(argv, into: into)
  end
end

То же, что и parse, но переключатели удаляются деструктивно. Не являющиеся опцией аргументы остаются в argv.

permute(*argv, into: nil) Показать исходный код
# File lib/optparse.rb, line 1648
def permute(*argv, into: nil)
  argv = argv[0].dup if argv.size == 1 and Array === argv[0]
  permute!(argv, into: into)
end

Парсит аргументы командной строки argv в режиме перестановки и возвращает список не являющихся опциями аргументов. Когда предоставляется необязательный into ключевой аргумент, значения проанализированных опций сохраняются там посредством метода []= (поэтому он может быть Hash, или OpenStruct, или другим аналогичным объектом).

permute!(argv = default_argv, into: nil) Показать исходный код
# File lib/optparse.rb, line 1657
def permute!(argv = default_argv, into: nil)
  nonopts = []
  order!(argv, into: into, &nonopts.method(:<<))
  argv[0, 0] = nonopts
  argv
end

То же, что и permute, но переключатели удаляются деструктивно. Не являющиеся опцией аргументы остаются в argv.

program_name() Показать исходный код
# File lib/optparse.rb, line 1193
def program_name
  @program_name || File.basename($0, '.*')
end

Имя программы, которое отображается в сообщении об ошибке и в стандартном баннере, по умолчанию равно $0.

reject(*args, &blk) Показать исходный код
# File lib/optparse.rb, line 1148
def reject(*args, &blk) top.reject(*args, &blk) end

Направляет отказ указанному аргументу класса.

t

Указатель класса аргумента, любой объект, включая Class.

reject(t)
release() Показать исходный код
# File lib/optparse.rb, line 1218
def release
  (defined?(@release) && @release) || (defined?(::Release) && ::Release) || (defined?(::RELEASE) && ::RELEASE)
end

Код выпуска

remove() Показать исходный код
# File lib/optparse.rb, line 1270
def remove
  @stack.pop
end

Удаляет последнюю List.

separator(string) Показать исходный код
# File lib/optparse.rb, line 1529
def separator(string)
  top.append(string, nil, nil)
end

Добавляет разделитель в сводку.

summarize(to = [], width = @summary_width, max = width - 1, indent = @summary_indent, &blk) Показать исходный код
# File lib/optparse.rb, line 1283
def summarize(to = [], width = @summary_width, max = width - 1, indent = @summary_indent, &blk)
  nl = "\n"
  blk ||= proc {|l| to << (l.index(nl, -1) ? l : l + nl)}
  visit(:summarize, {}, {}, width, max, indent, &blk)
  to
end

Размещает сводку опций в to и возвращает to. Выводит каждую строку, если задан блок.

to

Место назначения вывода, которое должно иметь метод <<. По умолчанию [].

width

Ширина левой части, по умолчанию @summary_width.

max

Максимальная длина, разрешённая для левой части, по умолчанию width - 1.

indent

Отступ, по умолчанию @summary_indent.

terminate(arg = nil) Показать исходный код
# File lib/optparse.rb, line 1116
def terminate(arg = nil)
  self.class.terminate(arg)
end

Прерывает парсинг опций. Необязательный параметр arg — строка, которая возвращается назад и будет первым не являющимся опцией аргументом.

to_a() Показать исходный код
# File lib/optparse.rb, line 1299
def to_a; summarize("#{banner}".split(/^/)) end

Возвращает список сводки опций.

to_s()
Псевдоним для: help
top() Показать исходный код
# File lib/optparse.rb, line 1244
def top
  @stack[-1]
end

Предмет on / on_head, accept / reject

ver() Показать исходный код
# File lib/optparse.rb, line 1225
def ver
  if v = version
    str = +"#{program_name} #{[v].join('.')}"
    str << " (#{v})" if v = release
    str
  end
end

Возвращает строку версии из program_name, версии и выпуска.

version() Показать исходный код
# File lib/optparse.rb, line 1211
def version
  (defined?(@version) && @version) || (defined?(::Version) && ::Version)
end

Version

END_OF_DOCUMENT_MARKER
warn(mesg = $!) Показать исходный код
# File lib/optparse.rb, line 1233
def warn(mesg = $!)
  super("#{program_name}: #{mesg}")
end
Вызывает метод суперкласса Kernel#warn

Ruby Core © 1993–2022 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API