バージョン:2.3.0 > ライブラリ:optparse > クエリ:new

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

トップページ >

:2.3.0

:optparse

:new

別のキーワード

種類

クラス

OptionParser (44)

キーワード

OptionParser (1)
accept (2)
banner (1)
banner= (1)
default_argv (1)
default_argv= (1)
environment (1)
getopts (4)
help (1)
load (1)
on_head (1)
on_tail (1)
order (4)
order! (2)
parse (2)
parse! (1)
permute (2)
permute! (1)
program_name (1)
program_name= (1)
reject (2)
release (1)
separator (1)
summarize (2)
summary_indent (1)
summary_indent= (1)
summary_width (1)
summary_width= (1)
to_a (1)
to_s (1)
ver (1)

検索結果

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

2.3.0

特異メソッド

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

...クトを引数としてブロックを評
価します。つまり、以下のような書き方が可能です。

//emlist[][ruby]{
require 'optparse'
OptionParser.new do |opt|

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

opt.parse!(ARGV)
end
//}

@param banner ヘルプ(サマリ)の...

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

2.3.0

特異メソッド

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

OptionParser.getopts(*opts) -> Hash (55.0)

2.3.0

特異メソッド

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

@param argv パースしたい配列を指定します。

@param opts 引数を文字列で指定します。

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

@see OptionParser#getopts

OptionParser.getopts(argv, *opts) -> Hash (55.0)

2.3.0

特異メソッド

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

OptionParser (43.0)

2.3.0

クラス

コマンドラインのオプションを取り扱うためのクラスです。

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

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

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

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

...]{
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
//}

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

opts = Op...

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

2.3.0

特異メソッド

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(...

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

2.3.0

インスタンスメソッド

OptionParser.accept と同様ですが、登録したブロックはレシーバーに限定されます。

...@param pat match メソッドを持ったオブジェクト(Regexp オブジェクトなど)を与えます。

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

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

OptionParser#banner -> String (25.0)

2.3.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#banner=(heading) (25.0)

2.3.0

インスタンスメソッド

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

...文字列を指定します。

@param heading サマリの最初に表示される文字列を指定します。

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

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

opts.on("-v",...

絞り込み条件を変える

OptionParser#default_argv -> [String] (25.0)

2.3.0

インスタンスメソッド

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

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

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

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

opts = OptionParser.new

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

OptionParser#default_argv=(argv) (25.0)

2.3.0

インスタンスメソッド

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

...きに使われます。

@param argv デフォルトでパースしたい文字列の配列を指定します。

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

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

# パラメーター指定なしで実行
opt...

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

2.3.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#getopts(*opts) -> Hash (25.0)

2.3.0

インスタンスメソッド

引数をパースした結果を、Hash として返します。

引数をパースした結果を、Hash として返します。

配列 argv を与えた場合、argv をパースします。そうでない場合は、
default_argv をパースします。

//emlist[][ruby]{
opt = OptionParser.new
params = opt.getopts(ARGV, "ab:", "foo", "bar:")
# params["a"] = true # -a
# params["b"] = "1" # -b1
# params["foo"] = true # --foo
# params["bar"] = "x" # --bar x...

OptionParser#getopts(argv, *opts) -> Hash (25.0)

2.3.0

インスタンスメソッド

引数をパースした結果を、Hash として返します。

絞り込み条件を変える

OptionParser#help -> String (25.0)

2.3.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#load(filename = nil) -> bool (25.0)

2.3.0

インスタンスメソッド

指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。

...ラムのサフィックスを付けた '~/.options/コマンド名' というファイルをパースします。

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

IO.write("options.txt", %w(-a --b).join("\n"))
options = { a: false, b: false }
OptionParser.new do |opt|
opt.on('-a') { |v| options[:a] = v...

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

2.3.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...

OptionParser#order!(argv = self.default_argv) -> [String] (25.0)

2.3.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) {|s| ...} -> [String] (25.0)

2.3.0

インスタンスメソッド

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

絞り込み条件を変える

OptionParser#order(*args) -> [String] (25.0)

2.3.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) {|s| ...} -> [String] (25.0)

2.3.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.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

OptionParser#order(argv) -> [String] (25.0)

2.3.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.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

OptionParser#order(argv) {|s| ...} -> [String] (25.0)

2.3.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.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

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

2.3.0

インスタンスメソッド

与えられた 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(*args) -> [String] (25.0)

2.3.0

インスタンスメソッド

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

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

2.3.0

インスタンスメソッド

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

OptionParser#permute!(argv = self.default_argv) -> [String] (25.0)

2.3.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#permute(*args) -> [String] (25.0)

2.3.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) -> [String] (25.0)

2.3.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#program_name -> String (25.0)

2.3.0

インスタンスメソッド

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

...字列で返します。

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

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

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

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

OptionParser#program_name=(name) (25.0)

2.3.0

インスタンスメソッド

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

...の名前を文字列で指定します。

@param name プログラムの名前を文字列で指定します。

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

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

OptionParser#reject(klass) -> () (25.0)

2.3.0

インスタンスメソッド

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(AR...

OptionParser#release -> String (25.0)

2.3.0

インスタンスメソッド

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

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

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

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

OptionParser#separator(sep) -> () (25.0)

2.3.0

インスタンスメソッド

サマリにオプションを区切るための文字列 sep を挿入します。オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。

...ところでこのメソッドを呼びます。

@param sep サマリの区切りを文字列で指定します。

//emlist[][ruby]{
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"

opts.separator ""
opts.separator "Specific options:"

opts.on("-r", "--requi...

絞り込み条件を変える

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) -> () (25.0)

2.3.0

インスタンスメソッド

サマリを指定された to へと加えていきます。

...大幅を整数で指定します。

@param indent サマリのインデントを文字列で指定します。

//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.summarize
#...

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) {|line| ... } -> () (25.0)

2.3.0

インスタンスメソッド

サマリを指定された to へと加えていきます。

OptionParser#summary_indent -> String (25.0)

2.3.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#summary_indent=(indent) (25.0)

2.3.0

インスタンスメソッド

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

...す。

@param indent サマリを表示する時に使われるインデントを文字列で指定します。

//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#summary_width -> Integer (25.0)

2.3.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_wid...

絞り込み条件を変える

OptionParser#summary_width=(width) (25.0)

2.3.0

インスタンスメソッド

サマリを表示するときの幅を整数で指定します。

...幅を整数で指定します。

@param width サマリを表示するときの幅を整数で指定します。

//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_w...

OptionParser#to_a -> [String] (25.0)

2.3.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#to_s -> String (25.0)

2.3.0

インスタンスメソッド

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

OptionParser#ver -> String (25.0)

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

2.3.0

特異メソッド

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

...スタンスに変換されてから、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

op...

絞り込み条件を変える

別のキーワード

種類

クラス

キーワード

検索結果

先頭5件

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

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

OptionParser.getopts(*opts) -> Hash (55.0)

OptionParser.getopts(argv, *opts) -> Hash (55.0)

OptionParser (43.0)

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

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

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

OptionParser#banner -> String (25.0)

OptionParser#banner=(heading) (25.0)

OptionParser#default_argv -> [String] (25.0)

OptionParser#default_argv=(argv) (25.0)

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

OptionParser#getopts(*opts) -> Hash (25.0)

OptionParser#getopts(argv, *opts) -> Hash (25.0)

OptionParser#help -> String (25.0)

OptionParser#load(filename = nil) -> bool (25.0)

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

OptionParser#order!(argv = self.default_argv) -> [String] (25.0)

OptionParser#order!(argv = self.default_argv) {|s| ...} -> [String] (25.0)

OptionParser#order(*args) -> [String] (25.0)

OptionParser#order(*args) {|s| ...} -> [String] (25.0)

OptionParser#order(argv) -> [String] (25.0)

OptionParser#order(argv) {|s| ...} -> [String] (25.0)

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

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

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

OptionParser#permute!(argv = self.default_argv) -> [String] (25.0)

OptionParser#permute(*args) -> [String] (25.0)

OptionParser#permute(argv) -> [String] (25.0)

OptionParser#program_name -> String (25.0)

OptionParser#program_name=(name) (25.0)

OptionParser#reject(klass) -> () (25.0)

OptionParser#release -> String (25.0)

OptionParser#separator(sep) -> () (25.0)

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) -> () (25.0)

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) {|line| ... } -> () (25.0)

OptionParser#summary_indent -> String (25.0)

OptionParser#summary_indent=(indent) (25.0)

OptionParser#summary_width -> Integer (25.0)

OptionParser#summary_width=(width) (25.0)

OptionParser#to_a -> [String] (25.0)

OptionParser#to_s -> String (25.0)

OptionParser#ver -> String (25.0)

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

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

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