ライブラリ
- optparse (946)
クラス
- OptionParser (649)
-
OptionParser
:: ParseError (110) -
RDoc
:: Options (22)
モジュール
キーワード
- AmbiguousArgument (11)
- AmbiguousOption (11)
- Arguable (11)
- InvalidArgument (11)
- InvalidOption (11)
- MissingArgument (11)
-
NEWS for Ruby 2
. 4 . 0 (8) -
NEWS for Ruby 2
. 7 . 0 (5) - NeedlessArgument (11)
- ParseError (11)
- accept (22)
- args (11)
-
default
_ argv (11) -
default
_ argv= (11) - environment (11)
-
filter
_ backtrace (11) - getopts (55)
- help (11)
- inspect (11)
- load (11)
- new (22)
- on (132)
-
on
_ head (11) -
on
_ tail (11) -
option
_ parser (11) -
option
_ parser= (11) - optparse (11)
-
optparse
/ date (11) -
optparse
/ shellwords (11) -
optparse
/ time (11) -
optparse
/ uri (11) - order (44)
- order! (44)
- parse! (22)
- permute (22)
- permute! (22)
-
program
_ name (11) -
program
_ name= (11) - reason (11)
- reason= (11)
- recover (11)
- reject (22)
- release (11)
- release= (11)
-
ruby 1
. 8 . 2 feature (11) -
ruby 1
. 8 . 5 feature (11) - separator (11)
-
set
_ backtrace (11) -
set
_ option (11) - summarize (22)
-
summary
_ indent (11) -
summary
_ indent= (11) -
summary
_ width (11) -
summary
_ width= (11) -
to
_ a (11) -
to
_ s (22) - ver (11)
- version (11)
- version= (11)
検索結果
先頭5件
-
OptionParser (44072.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!(...... parse を行う。
//}
=== デフォルトで利用可能なオプション
以下はデフォルトで利用可能なオプションです。オプションサマリには
出てきません。
: --help
オプションサマリを表示してから exit します。
: --version
OptionParser... -
OptionParser
# parse(*args , into: nil) -> [String] (42144.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] (42144.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(*args) -> [String] (42138.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 |opt......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] (42138.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 |opt......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] (30149.0) -
与えられた argv をパースします。
...与えられた argv をパースします。
OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に 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 = self . default _ argv) -> [String] (30143.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 = & # 39; & # 39; * 4) -> OptionParser (24236.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 = & # 39; & # 39; * 4) {|opt| . . . } -> OptionParser (24236.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
. reject(klass) -> () (24076.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
. accept(klass , pat = / . * / ) {|str| . . . } -> () (24064.0) -
オプションの引数を文字列から Ruby のオブジェクトに変換するための ブロックを登録します。すべての OptionParser インスタンスに共通です。
...クを登録します。すべての OptionParser インスタンスに共通です。
ブロックには、文字列として与えられるオプションの引数から klass のインスタンスを生成して返すものを指定します。
OptionParser#on で 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#on を参照して下さい。
@param klass クラスオブジェクトを与え... -
OptionParser
# reject(klass) -> () (24058.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|
p time.class
end
option_parser.parse(ARGV)
end
opts = OptionParser.new
opts.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument, s
end
end
parse(opts) # => Time
opts.reject(Time)
parse(opts) # => unsupported argument type: Time (Arg... -
OptionParser
# on(long , klass = String , desc = "") {|v| . . . } -> self (24047.0) -
オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。
...なクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定され......外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::InvalidArgument を投げます。
オプションの引数は accept で登録したブロックで klass のインスタンス
に変換さ......の引数は変換されません。
: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します。
: Integer
Integer オブジェクトに変換されます。"0b1"、"07"、"99"、"0xff" といった...