クエリ:ruby > クエリ:OptionParser

...ARGV) でコマンドラインを実際に parse する。

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

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

...は
出てきません。

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

: --version

OptionParser#ver を表示してから exit します。
OptionParser#ver が定義されていない場合は、そのようにエラーメッセージを出力して abort します...

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

特異メソッド

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

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

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

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

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

特異メソッド

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

OptionParser.accept(klass, pat = /.*/) {|str| ...} -> () (21074.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...

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

インスタンスメソッド

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

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

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

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

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

...d --width=32

opts.on("-o", "--overwrite VALUE", TrueClass){|boolean| ...}
# ruby command --overwrite yes

@param short ショートオプションを表す文字列を指定します。

@param long ロングオプションを表す文字列を指定します。

@param klass オプションの...

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

OptionParser#on_tail(*arg, &block) -> self (21054.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")
opt...

..., --help
//}

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

opts = OptionParser.new
opts.on_tail("-h", "--help", "Show this message") do
puts opts
exit
end

opts.on_tail("--version", "Show version") do
puts OptionParser::Version.join('.')
exit
end
//}

@see OptionParser#on, OptionParser#on_head...

OptionParser.reject(klass) -> () (21052.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|...

...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) # => unsupported arg...

<< 1 2 3 ... > >>

別のキーワード

種類

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

OptionParser (38060.0)

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

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

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

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

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

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

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

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

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

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