検索結果

OptionParser#default_argv=(argv) (18607.0)

• 2.4.0

• インスタンスメソッド

自身がデフォルトでパースする引数を文字列の配列で指定します。

...きに使われます。

@param argv デフォルトでパースしたい文字列の配列を指定します。

//emlist[例][ruby]{
require "optparse"

config = {}
opts = OptionParser.new
opts.on("-r", "--require LIBRARY"){|lib| config[:lib] = lib }

# パラメーター指定なしで実行
opt...

• OptionParser

OptionParser#default_argv -> [String] (18307.0)

• 2.4.0

• インスタンスメソッド

自身がデフォルトでパースする引数を文字列の配列で返します。

...列の配列で返します。

@param argv デフォルトでパースする文字列の配列を返します。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new

# --hoo param1 --bar param2 をパラメーターに指定して実行
opts.default_argv # => ["--foo", "param1", "--ba...

• OptionParser

OptionParser::ParseError#args -> Array (18307.0)

• 2.4.0

• インスタンスメソッド

エラーのあったオプションの一覧を配列で返します。

エラーのあったオプションの一覧を配列で返します。

@return エラーのあったオプションの一覧。

• OptionParser::ParseError

OptionParser::AmbiguousArgument (18007.0)

• 2.4.0

• クラス

オプションの引数が曖昧にしか補完できない場合に投げられます。

オプションの引数が曖昧にしか補完できない場合に投げられます。

OptionParser::Arguable (18007.0)

• 2.4.0

• モジュール

主に Object::ARGV を拡張するために用意されたモジュールです。 optparse を require することにより、ARGV は OptionParser::Arguable を Object#extend します。

...主に Object::ARGV を拡張するために用意されたモジュールです。
optparse を require することにより、ARGV は
OptionParser::Arguable を Object#extend します。

コマンドライン引数を表す文字列の配列を、拡張するためにも使うことができ...

• optparse

絞り込み条件を変える

OptionParser::InvalidArgument (18007.0)

• 2.4.0

• クラス

オプションの引数が指定されたパターンにマッチしない時に投げられます。

オプションの引数が指定されたパターンにマッチしない時に投げられます。

OptionParser::MissingArgument (18007.0)

• 2.4.0

• クラス

引数が必要なオプションに引数が与えられなかった場合に投げられます。

引数が必要なオプションに引数が与えられなかった場合に投げられます。

OptionParser::NeedlessArgument (18007.0)

• 2.4.0

• クラス

引数を取らないはずのオプションに引数が与えられた場合に投げられます。

引数を取らないはずのオプションに引数が与えられた場合に投げられます。

OptionParser::Arguable#getopts(short_opt, *long_opt) -> Hash (9007.0)

• 2.4.0

• インスタンスメソッド

指定された short_opt や long_opt に応じて自身をパースし、結果を Hash として返します。

...実際は OptionParser::ParseError のサブク
ラスの例外になります。

//emlist[t.rb][ruby]{
require 'optparse'
params = ARGV.getopts("ab:", "foo", "bar:", "bufsize:1024")
p params
//}

# 実行結果
$ ruby t.rb -b 1 --foo --bar xxx -- -a
{"bufsize"=>...

• OptionParser::Arguable

OptionParser::Arguable#options -> OptionParser (9007.0)

• 2.4.0

• インスタンスメソッド

自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。

...行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。

//emlist[][ruby]{
require 'optparse'

o = nil
ARGV.options{|opt|
opt.on('-a'){ o = true }
opt.parse!
}
p o #=> true
//}...

• OptionParser
• OptionParser::Arguable
• OptionParser::ParseError

絞り込み条件を変える

OptionParser::Arguable#options {|opt| ... } -> object | nil (9007.0)

• 2.4.0

• インスタンスメソッド

自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。

...行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。

//emlist[][ruby]{
require 'optparse'

o = nil
ARGV.options{|opt|
opt.on('-a'){ o = true }
opt.parse!
}
p o #=> true
//}...

• OptionParser
• OptionParser::Arguable
• OptionParser::ParseError

OptionParser::Arguable#options=(opt) (9007.0)

• 2.4.0

• インスタンスメソッド

自身をパースするための OptionParser オブジェクトをセットします。

自身をパースするための OptionParser オブジェクトをセットします。

@param opt 自身をパースする OptionParser 、あるいは nil か false を指定します。
nil か false である場合、自身の options= メソッドと options メソッドを
undef します。

• OptionParser
• OptionParser::Arguable

OptionParser::Arguable#order! -> [String] (9007.0)

• 2.4.0

• インスタンスメソッド

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#order! を参照して下さい。

...ます。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

//emlist[][ruby]{
require 'optparse'

o = nil
ARGV.options.on('-a'){ o = true }
ARGV.order!
p o #=> true
//}...

• OptionParser::Arguable

OptionParser::Arguable#order! {|s| ... } -> [String] (9007.0)

• 2.4.0

• インスタンスメソッド

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#order! を参照して下さい。

...ます。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

//emlist[][ruby]{
require 'optparse'

o = nil
ARGV.options.on('-a'){ o = true }
ARGV.order!
p o #=> true
//}...

• OptionParser::Arguable

OptionParser::Arguable#parse! -> [String] (9007.0)

• 2.4.0

• インスタンスメソッド

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#parse! を参照して下さい。

...ます。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

//emlist[][ruby]{
require 'optparse'

o = nil
ARGV.options.on('-a'){ o = true }
ARGV.parse!
p o #=> true
//}...

• OptionParser::Arguable

絞り込み条件を変える

OptionParser::Arguable#permute! -> [String] (9007.0)

• 2.4.0

• インスタンスメソッド

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#permute! を参照して下さい。

...ます。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

//emlist[][ruby]{
require 'optparse'

o = nil
ARGV.options.on('-a'){ o = true }
ARGV.permute!
p o #=> true
//}...

• OptionParser::Arguable

OptionParser#order!(argv = self.default_argv, into: nil) -> [String] (607.0)

• 2.4.0

• インスタンスメソッド

与えられた argv を順番に破壊的にパースします。 argv からオプションがすべて取り除かれます。 argv を返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

OptionParser#order!(argv = self.default_argv, into: nil) {|s| ...} -> [String] (607.0)

• 2.4.0

• インスタンスメソッド

与えられた argv を順番に破壊的にパースします。 argv からオプションがすべて取り除かれます。 argv を返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

OptionParser#parse!(argv = self.default_argv, into: nil) -> [String] (607.0)

• 2.4.0

• インスタンスメソッド

与えられた argv をパースします。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

ARGV...

• OptionParser

OptionParser#permute!(argv = self.default_argv, into: nil) -> [String] (607.0)

• 2.4.0

• インスタンスメソッド

与えられた argv を破壊的にパースします。argv からオプションがすべて取り除かれます。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv を返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somef...

• OptionParser

絞り込み条件を変える

OptionParser#on_head(*arg, &block) -> self (328.0)

• 2.4.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。

...登録します。

@param arg OptionParser#on と同様です。

@param block OptionParser#on と同様です。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

puts opts.help...

• OptionParser

OptionParser#on_tail(*arg, &block) -> self (328.0)

• 2.4.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。

...]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

puts opts.help

# => Usage: test [options]
# -i, --init
# -u, --update
# -h, --help
//}

//emlist[例][ruby]{
require "optparse"

opts = Op...

• OptionParser

OptionParser#getopts(argv, *opts) -> Hash (307.0)

• 2.4.0

• インスタンスメソッド

引数をパースした結果を、Hash として返します。

引数をパースした結果を、Hash として返します。

配列 argv を与えた場合、argv をパースします。そうでない場合は、
default_argv をパースします。

//emlist[][ruby]{
opt = OptionParser.new
params = opt.getopts(ARGV, "ab:", "foo", "bar:")
# params["a"] = true # -a
# params["b"] = "1" # -b1
# params["foo"] = true # --foo
# params["bar"] = "x" # --bar x...

• OptionParser

OptionParser#order(*args, into: nil) -> [String] (307.0)

• 2.4.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

OptionParser#order(*args, into: nil) {|s| ...} -> [String] (307.0)

• 2.4.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

絞り込み条件を変える

OptionParser#order(argv, into: nil) -> [String] (307.0)

• 2.4.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

OptionParser#order(argv, into: nil) {|s| ...} -> [String] (307.0)

• 2.4.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

OptionParser#parse(*args, into: nil) -> [String] (307.0)

• 2.4.0

• インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

ARGV...

• OptionParser

OptionParser#parse(argv, into: nil) -> [String] (307.0)

• 2.4.0

• インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

ARGV...

• OptionParser

OptionParser#permute(*args, into: nil) -> [String] (307.0)

• 2.4.0

• インスタンスメソッド

与えられた argv をパースします。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somef...

• OptionParser

絞り込み条件を変える

OptionParser#permute(argv, into: nil) -> [String] (307.0)

• 2.4.0

• インスタンスメソッド

与えられた argv をパースします。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somef...

• OptionParser

OptionParser.getopts(argv, *opts) -> Hash (307.0)

• 2.4.0

• 特異メソッド

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

@param argv パースしたい配列を指定します。

@param opts 引数を文字列で指定します。

@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。


@see OptionParser#getopts

• OptionParser

OptionParser::ParseError#recover(argv) -> Array (307.0)

• 2.4.0

• インスタンスメソッド

argv の先頭に self.args を戻します。

argv の先頭に self.args を戻します。

argv を返します。

@param argv OptionParser#parse に渡したオブジェクトなどの配列を指定します。

@return argv を返します。

• OptionParser::ParseError