クエリ:optparse > クエリ:parse

...=== チュートリアル

optparse を使う場合、基本的には

(1) OptionParser オブジェクト opt を生成する。
(2) オプションを取り扱うブロックを opt に登録する。
(3) opt.parse(ARGV) でコマンドラインを実際に parse する。

というような...

...ist[sample.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a') {|v| p v }
opt.on('-b') {|v| p v }

opt.parse!(ARGV)
p ARGV
//}
↓
ruby sample.rb -a foo bar -b baz
# => true
true
["foo", "bar", "baz"]

OptionParser#on メソッドの引数で...

...す(optionargの項も参照)。

Enumerator#each などと違い、OptionParser#on
メソッドが呼ばれた時点ではブロックは実行されません。あくまで登録される
だけです。OptionParser#parse が呼ばれた時に、コマンドラインにオプ
ションが指定さ...

OptionParser#parse(*args) -> [String] (29114.0)

インスタンスメソッド

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

...。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を文...

...@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は 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 # => ["-i", "-u", "-h", "test"]
opts.parse(ARGV) # => ["test"]
//}...

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

インスタンスメソッド

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

...ョンを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプションが定義されていればロ...

OptionParser#parse(argv) -> [String] (29114.0)

インスタンスメソッド

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

...opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

ARGV # => ["-i", "-u", "-h", "test"]
opts.parse(ARGV) # => ["test"]
//}...

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

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

...を文字列の配列として返します。
OptionParser#parse! を参照して下さい。

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

...ラスの例外になります。

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

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

OptionParser#parse!(argv = self.default_argv) -> [String] (17119.0)

インスタンスメソッド

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

...nParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。

@raise OptionParser::Parse...

...場合、発生します。
実際は 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 # => ["-i", "-u", "-h", "test"]
opts.parse(ARGV) # => ["test"]
ARGV # => ["-i", "-u", "-h", "test"]
opts.parse!(ARGV) # => ["test"]
ARGV # => ["test"]
//}...

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

インスタンスメソッド

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

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

OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。

@param argv パースしたい引数を文字列の配...

OptionParser::ParseError (17000.0)

クラス

OptionParser の例外クラスの基底クラスです。

...OptionParser の例外クラスの基底クラスです。...

OptionParser (14030.0)

クラス

コマンドラインのオプションを取り扱うためのクラスです。

...ックを
OptionParser#on メソッドで登録していきます。
つまり、OptionParser を使う場合、基本的には

(1) OptionParser オブジェクト opt を生成する。
(2) オプションを取り扱うブロックを opt に登録する。
(3) opt.parse(ARGV) でコマン...

...に parse する。

というような流れになります。

//emlist[][ruby]{
require "optparse"
ProgramConfig = Hash.new
opts = OptionParser.new
opts.on("-a"){|v| ProgramConfig[:a] = true } # オプション「-a」がコマンドラインで指定されていた場合の動作。
opts.parse!(...