クエリ:ruby > クエリ:Ruby > クエリ:help > クエリ:parse > クエリ:optparse

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

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

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

というような...

...* optionarg
* longoption
* help
* subcmd
* argv
* hyphen_start_file

====[a:optiondef] オプションの定義

以下はオプション -a, -b を受け付けるコマンドを作成する例です。

//emlist[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 メソッドの引数でオプションを定義し、引数が指定さ
れた時の処理をブロックで...

OptionParser#parse(*args) -> [String] (29132.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] (29132.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) -> [String] (29132.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] (29132.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#help -> String (29125.0)

インスタンスメソッド

サマリの文字列を返します。

...を返します。

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

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"

opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
options[:verbose] = v
end
end

puts opts.help

# => Usage: example.rb [options]
#...

OptionParser#parse!(argv = self.default_argv) -> [String] (17137.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] (17137.0)

インスタンスメソッド

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

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

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

@param 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"]
ARGV # => ["-i", "-u", "-h", "test"]
opts.parse!(ARGV) # => ["test"]
ARGV # => ["test"]
//}...

OptionParser (14060.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#to_s -> String (14025.0)

インスタンスメソッド

サマリの文字列を返します。

絞り込み条件を変える

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

インスタンスメソッド

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

...録します。

--version や --help の説明をサマリの最後に表示したい時に便利です。

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

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

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

opts = OptionParser.new do |opts|
opts.on_head("-i",...

...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 = 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#on_head(*arg, &block) -> self (11036.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

# => Usage: test...

...[options]
# -i, --init
# -u, --update
# -h, --help
//}

@see OptionParser#on, OptionParser#on_tail...

<< 1 2 3 > >>

別のキーワード

種類

ライブラリ

クラス

キーワード

検索結果

先頭5件

optparse (44978.0)

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

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

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

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

OptionParser#help -> String (29125.0)

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

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

OptionParser (14060.0)

OptionParser#to_s -> String (14025.0)

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

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