バージョン:2.2.0 > クエリ:IO > クエリ:on > クエリ:tr > ライブラリ:optparse

38件ヒット [1-38件を表示] （0.044秒）

トップページ >

:2.2.0

:IO

:on

:tr

:optparse

別のキーワード

種類

インスタンスメソッド (36)
特異メソッド (2)

クラス

OptionParser (28)
OptionParser::ParseError (6)

モジュール

OptionParser::Arguable (4)

キーワード

accept (2)
banner (1)
default_argv (1)
environment (1)
filter_backtrace (1)
help (1)
inspect (1)
message (1)
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 (73021.0)

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

OptionParser#version -> String (54907.0)

2.2.0

インスタンスメソッド

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

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

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

@see OptionParser#ver

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

2.2.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::ParseError#reason -> String (36607.0)

2.2.0

インスタンスメソッド

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

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

@return 文字列を返します。

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

2.2.0

インスタンスメソッド

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

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

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

@return array を返します。

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

2.2.0

特異メソッド

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

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

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

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

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

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

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

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

2.2.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] (18361.0)

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

OptionParser#summary_indent -> String (18361.0)

2.2.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] (18361.0)

2.2.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#order!(argv = self.default_argv) -> [String] (18343.0)

2.2.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] (18343.0)

2.2.0

インスタンスメソッド

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

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

2.2.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] (18343.0)

2.2.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] (18343.0)

2.2.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] (18343.0)

2.2.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#permute!(argv = self.default_argv) -> [String] (18343.0)

2.2.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] (18343.0)

2.2.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] (18343.0)

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

2.2.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 (18325.0)

2.2.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#help -> String (18325.0)

2.2.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#to_s -> String (18325.0)

2.2.0

インスタンスメソッド

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

OptionParser#ver -> String (18325.0)

2.2.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::Arguable#order! -> [String] (18325.0)

2.2.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] (18325.0)

2.2.0

インスタンスメソッド

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

絞り込み条件を変える

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

2.2.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] (18325.0)

2.2.0

インスタンスメソッド

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

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

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

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

OptionParser#default_argv -> [String] (18307.0)

2.2.0

インスタンスメソッド

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

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

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

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

opts = OptionParser.new

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

OptionParser#program_name -> String (18307.0)

2.2.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 (18307.0)

2.2.0

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

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