クエリ:parse > クエリ:Ruby > クエリ:OptionParser

...ブロックを
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!(...

... parse を行う。
//}

=== デフォルトで利用可能なオプション

以下はデフォルトで利用可能なオプションです。オプションサマリには
出てきません。

: --help
オプションサマリを表示してから exit します。

: --version

OptionParser...

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

インスタンスメソッド

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

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

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

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

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

...。

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

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

opts = OptionParser.new do |opts...

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

インスタンスメソッド

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

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

インスタンスメソッド

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

...s|
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) -> [String] (42144.0)

インスタンスメソッド

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

...s|
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 = self.default_argv, into: nil) -> [String] (30155.0)

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

...

OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に 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"]
ARGV # => ["-i", "-u", "-h", "test"]
opts.parse!(ARGV) # => ["test"]
ARGV # => ["test"]
//}...

OptionParser.new(banner = nil, width = 32, indent = ' ' * 4) -> OptionParser (24242.0)

特異メソッド

OptionParser オブジェクトを生成して返します。

...
OptionParser オブジェクトを生成して返します。

ブロックが与えられた場合、生成した OptionParser オブジェクトを引数としてブロックを評
価します。つまり、以下のような書き方が可能です。

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

...nParser.new do |opt|

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

opt.parse!(ARGV)
end
//}

@param banner ヘルプ(サマリ)の最初の部分に表示される、アプリケーションの説明などを文字列で与えます。

@param width サマリの幅を整数で与えます...

OptionParser.new(banner = nil, width = 32, indent = ' ' * 4) {|opt| ...} -> OptionParser (24242.0)

特異メソッド

OptionParser オブジェクトを生成して返します。

OptionParser.accept(klass, pat = /.*/) {|str| ...} -> () (24086.0)

特異メソッド

オプションの引数を文字列から Ruby のオブジェクトに変換するためのブロックを登録します。すべての OptionParser インスタンスに共通です。

...オプションの引数を文字列から Ruby のオブジェクトに変換するための
ブロックを登録します。すべての OptionParser インスタンスに共通です。

ブロックには、文字列として与えられるオプションの引数から klass のインスタ...

...返すものを指定します。

OptionParser#on で klass を指定した場合、
コマンドラインのオプションに与えられた引数は、この accept で登録したブロックで
klass のインスタンスに変換されてから、OptionParser#on メソッドで登録したブ...

.../emlist[][ruby]{
require "optparse"
require "time"

OptionParser.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument, s
end
end

opts = OptionParser.new

opts.on("-t", "--time [TIME]", Time) do |time|
p time.class #=> Time
end

opts.parse!(ARGV)
/...

絞り込み条件を変える

OptionParser.reject(klass) -> () (24082.0)

特異メソッド

OptionParser.accept メソッドで登録したブロックを削除します。

...
OptionParser.accept メソッドで登録したブロックを削除します。

@param klass 削除したいクラスオブジェクトを指定します。

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

def parse(option_parser)
option_parser.on("-t", "--time [TIME]", Time) do |time|...

....class
end
option_parser.parse(ARGV)
end

OptionParser.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument, s
end
end

opts1 = OptionParser.new
parse(opts1) # => Time
OptionParser.reject(Time)
opts2 = OptionParser.new
parse(opts2) # => unsupport...

OptionParser#on(long, klass = String, desc = "") {|v| ...} -> self (24066.0)

インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...なクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定され...

...例外
OptionParser::InvalidArgument を投げます。

オプションの引数は accept で登録したブロックで klass のインスタンス
に変換されてから、ブロックに渡されます。

opts.on("-w", "--width N", Integer){|w|
p w.class #=> Integer
}
# ruby comman...

...の引数は変換されません。

: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します。

: Integer
Integer オブジェクトに変換されます。"0b1"、"07"、"99"、"0xff" といった...

<< 1 2 3 ... > >>

別のキーワード

種類

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

OptionParser (44084.0)

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

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

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

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

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

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

OptionParser.new(banner = nil, width = 32, indent = &#39; &#39; * 4) -> OptionParser (24242.0)

OptionParser.new(banner = nil, width = 32, indent = &#39; &#39; * 4) {|opt| ...} -> OptionParser (24242.0)

OptionParser.accept(klass, pat = /.*/) {|str| ...} -> () (24086.0)

OptionParser.reject(klass) -> () (24082.0)

OptionParser#on(long, klass = String, desc = "") {|v| ...} -> self (24066.0)

OptionParser.new(banner = nil, width = 32, indent = ' ' * 4) -> OptionParser (24242.0)

OptionParser.new(banner = nil, width = 32, indent = ' ' * 4) {|opt| ...} -> OptionParser (24242.0)