バージョン:2.6.0 > クエリ:String > ライブラリ:optparse

45件ヒット [1-45件を表示] （0.040秒）

トップページ >

:2.6.0

:String

:optparse

別のキーワード

種類

インスタンスメソッド (44)
特異メソッド (1)

クラス

OptionParser (35)
OptionParser::ParseError (6)

モジュール

OptionParser::Arguable (4)

キーワード

banner (1)
default_argv (1)
environment (1)
filter_backtrace (1)
help (1)
inspect (1)
message (1)
on (12)
order (4)
order! (4)
parse (2)
parse! (2)
permute (2)
permute! (2)
program_name (1)
reason (1)
release (1)
set_backtrace (1)
summary_indent (1)
to_a (1)
to_s (2)
ver (1)
version (1)

検索結果

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

2.6.0

インスタンスメソッド

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

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

klass にはクラスを与えます。どのようなクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定された
場合、例外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::I...

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

2.6.0

インスタンスメソッド

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

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

2.6.0

インスタンスメソッド

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

OptionParser#order(*args, into: nil) -> [String] (319.0)

2.6.0

インスタンスメソッド

与えられた argv を順番にパースします。オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

OptionParser#order(*args, into: nil) {|s| ...} -> [String] (319.0)

2.6.0

インスタンスメソッド

絞り込み条件を変える

OptionParser#order(argv, into: nil) -> [String] (319.0)

2.6.0

インスタンスメソッド

OptionParser#order(argv, into: nil) {|s| ...} -> [String] (319.0)

2.6.0

インスタンスメソッド

OptionParser#help -> String (313.0)

2.6.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:...

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

2.6.0

インスタンスメソッド

与えられた argv を順番に破壊的にパースします。 argv からオプションがすべて取り除かれます。 argv を返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

OptionParser#order!(argv = self.default_argv, into: nil) {|s| ...} -> [String] (313.0)

2.6.0

インスタンスメソッド

与えられた argv を順番に破壊的にパースします。 argv からオプションがすべて取り除かれます。 argv を返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

絞り込み条件を変える

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

2.6.0

インスタンスメソッド

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

...実際は 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...

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

2.6.0

インスタンスメソッド

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

OptionParser#permute(*args, into: nil) -> [String] (313.0)

2.6.0

インスタンスメソッド

与えられた argv をパースします。オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somef...

OptionParser#permute(argv, into: nil) -> [String] (313.0)

2.6.0

インスタンスメソッド

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somef...

OptionParser#to_s -> String (313.0)

2.6.0

インスタンスメソッド

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

絞り込み条件を変える

OptionParser::Arguable#order! -> [String] (313.0)

2.6.0

インスタンスメソッド

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

...ます。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

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

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

OptionParser::Arguable#order! {|s| ... } -> [String] (313.0)

2.6.0

インスタンスメソッド

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

OptionParser::ParseError#message -> String (313.0)

2.6.0

インスタンスメソッド

標準エラーに出力するメッセージを返します。

標準エラーに出力するメッセージを返します。

@return 文字列を返します。

OptionParser::ParseError#to_s -> String (313.0)

2.6.0

インスタンスメソッド

標準エラーに出力するメッセージを返します。

標準エラーに出力するメッセージを返します。

@return 文字列を返します。

OptionParser#banner -> String (310.0)

2.6.0

インスタンスメソッド

サマリの最初に表示される文字列を返します。

...示される文字列を返します。

@return サマリの最初に表示される文字列を返します。

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

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

opts.on("-v", "--[no-]verbose", "Run verbosely")...

絞り込み条件を変える

OptionParser#default_argv -> [String] (310.0)

2.6.0

インスタンスメソッド

自身がデフォルトでパースする引数を文字列の配列で返します。

...列の配列で返します。

@param argv デフォルトでパースする文字列の配列を返します。

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

opts = OptionParser.new

# --hoo param1 --bar param2 をパラメーターに指定して実行
opts.default_argv # => ["--foo", "param1", "--ba...

OptionParser#environment(env) -> [String] (310.0)

2.6.0

インスタンスメソッド

環境変数 env に対して Shellwords.#shellwords を呼んで配列にしてから parse を行ないます。

...実際は OptionParser::ParseError のサブク
ラスになります。

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

config = {}
opts = OptionParser.new
opts.on("-r", "--require LIBRARY"){|lib| config[:lib] = lib }

# HOGE_OPT は hoge というプログラム...

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

2.6.0

インスタンスメソッド

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

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

2.6.0

インスタンスメソッド

与えられた argv を破壊的にパースします。argv からオプションがすべて取り除かれます。オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv を返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somef...

OptionParser#program_name -> String (310.0)

2.6.0

インスタンスメソッド

プログラムの名前を文字列で返します。

...字列で返します。

デフォルトは $0 が使われます。

@return プログラムの名前を文字列で返します。

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

OptionParser.new do |opts|
p $0 # => /path/to/filename.rb
p opts.program_name # => filename
end
//}...

絞り込み条件を変える

OptionParser#release -> String (310.0)

2.6.0

インスタンスメソッド

プログラムのリリースを文字列で返します。

...プログラムのリリースを文字列で返します。

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

OptionParser.new do |opts|
opts.release # => nil
opts.release = "2019-05-01"
opts.release # => "2019-05-01"
end
//}...

OptionParser#summary_indent -> String (310.0)

2.6.0

インスタンスメソッド

サマリを表示する時のインデントを文字列で返します。

...文字列で返します。

@return サマリを表示する時のインデントを文字列で返します。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.summary_ind...

OptionParser#to_a -> [String] (310.0)

2.6.0

インスタンスメソッド

サマリの各行を要素とした配列を返します。

...サマリの各行を要素とした配列を返します。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.to_a # => ["Usage: test [options]", " -i, --init\n", " -...

OptionParser#ver -> String (310.0)

2.6.0

インスタンスメソッド

program_name、version と release から生成したバージョンを表す文字列を返します。

...例][ruby]{
require "optparse"

OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"
opts.program_name = "Optparse Example"
opts.version = [0, 1]
opts.release = "2019-05-01"

opts.on_tail("--version", "Show version") do
puts opts.ver # => "Optparse Example 0.1 (2019-0...

OptionParser#version -> String (310.0)

2.6.0

インスタンスメソッド

プログラムのバージョンを文字列で返します。

プログラムのバージョンを文字列で返します。

@return プログラムのバージョンを文字列で返します。

@see OptionParser#ver

絞り込み条件を変える

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

2.6.0

インスタンスメソッド

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

...ます。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

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

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

OptionParser::Arguable#permute! -> [String] (310.0)

2.6.0

インスタンスメソッド

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

...ます。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

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

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

OptionParser::ParseError#inspect -> String (310.0)

2.6.0

インスタンスメソッド

自身を人間が読みやすい形の文字列表現にして返します。

自身を人間が読みやすい形の文字列表現にして返します。

@return 文字列を返します。

@see Object#inspect

OptionParser::ParseError#reason -> String (310.0)

2.6.0

インスタンスメソッド

エラーの内容を文字列で返します。

エラーの内容を文字列で返します。

@return 文字列を返します。

OptionParser::ParseError#set_backtrace(array) -> [String] (310.0)

2.6.0

インスタンスメソッド

自身に array で指定したバックトレースを設定します。

自身に array で指定したバックトレースを設定します。

@param array バックトレースを文字列の配列で指定します。

@return array を返します。

絞り込み条件を変える

OptionParser::ParseError.filter_backtrace(array) -> [String] (310.0)

2.6.0

特異メソッド

array で指定されたバックトレースから optparse ライブラリに関する行を除外します。

...array で指定されたバックトレースから optparse ライブラリに関する行を除
外します。

デバッグモード($DEBUGが真)の場合は何もしません。

@param array バックトレースを文字列の配列で指定します。

@return array を返します。...

OptionParser#on(long, *rest) {|v| ...} -> self (19.0)

2.6.0

インスタンスメソッド

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

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

コマンドに与えられた引数が配列やハッシュに含まれない場合、例外
OptionParser::InvalidArgument が OptionParser#parse 実行時
に発生します。

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

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

@param rest 可能な引数を列挙した配列やハッシュを与えます。文字列を与えた場合は、
サマリ...

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

2.6.0

インスタンスメソッド

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

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

ショートオプションとロングオプションを同時に登録することもできます。
opts.on("-r", "--require LIBRARY"){|lib| ...}
これは以下と同値です。
opts.on("-r LIBRARY"){|lib| ...}
opts.on("--require LIBRARY"){|lib| ...}

複数の異なるオプションに同じブロックを一度に登録することもできます。

opt.on('-v', '-vv')...

OptionParser#on(long, pat = /.*/, desc = "") {|v| ...} -> self (19.0)

2.6.0

インスタンスメソッド

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

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

pat にはオプションの引数に許すパターンを表す正規表現で与えます。
コマンドに与えられた引数がパターンにマッチしない場合、
例外 OptionParser::InvalidArgument が parse 実行時に投げられます。

opts.on("--username VALUE", /[a-zA-Z0-9_]+/){|name| ...}
# ruby command --username=ruby_user
# ruby command...

OptionParser#on(short, *rest) {|v| ...} -> self (19.0)