argument_converters - Ruby 3.3 的文件

引數轉換器¶ ↑

選項可以指定其引數從預設的 String 轉換為另一個類別的執行個體。

內容¶ ↑

內建引數轉換器
- 日期
- 日期時間
- 時間
- URI
- Shellwords
- 整數
- 浮點數
- 數字
- 十進位整數
- 八進位整數
- 十進位數字
- 真值類別
- 假值類別
- 物件
- 字串
- 陣列
- 正規表示式
自訂引數轉換器

內建引數轉換器¶ ↑

OptionParser 有一些內建的引數轉換器，如下所示。

`日期`¶ ↑

File date.rb 定義了一個選項，其引數將轉換為 Date 物件。此引數由方法 Date#parse 轉換。

require 'optparse/date'
parser = OptionParser.new
parser.on('--date=DATE', Date) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby date.rb --date 2001-02-03
[#<Date: 2001-02-03 ((2451944j,0s,0n),+0s,2299161j)>, Date]
$ ruby date.rb --date 20010203
[#<Date: 2001-02-03 ((2451944j,0s,0n),+0s,2299161j)>, Date]
$ ruby date.rb --date "3rd Feb 2001"
[#<Date: 2001-02-03 ((2451944j,0s,0n),+0s,2299161j)>, Date]

`DateTime`¶ ↑

File datetime.rb 定義一個選項，其參數要轉換為 DateTime 物件。參數會由 DateTime#parse 方法轉換。

require 'optparse/date'
parser = OptionParser.new
parser.on('--datetime=DATETIME', DateTime) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby datetime.rb --datetime 2001-02-03T04:05:06+07:00
[#<DateTime: 2001-02-03T04:05:06+07:00 ((2451943j,75906s,0n),+25200s,2299161j)>, DateTime]
$ ruby datetime.rb --datetime 20010203T040506+0700
[#<DateTime: 2001-02-03T04:05:06+07:00 ((2451943j,75906s,0n),+25200s,2299161j)>, DateTime]
$ ruby datetime.rb --datetime "3rd Feb 2001 04:05:06 PM"
[#<DateTime: 2001-02-03T16:05:06+00:00 ((2451944j,57906s,0n),+0s,2299161j)>, DateTime]

`Time`¶ ↑

File time.rb 定義一個選項，其參數要轉換為 Time 物件。參數會由 Time#httpdate 或 Time#parse 方法轉換。

require 'optparse/time'
parser = OptionParser.new
parser.on('--time=TIME', Time) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby time.rb --time "Thu, 06 Oct 2011 02:26:12 GMT"
[2011-10-06 02:26:12 UTC, Time]
$ ruby time.rb --time 2010-10-31
[2010-10-31 00:00:00 -0500, Time]

`URI`¶ ↑

File uri.rb 定義一個選項，其參數要轉換為 URI 物件。參數會由 URI#parse 方法轉換。

require 'optparse/uri'
parser = OptionParser.new
parser.on('--uri=URI', URI) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby uri.rb --uri https://github.com
[#<URI::HTTPS https://github.com>, URI::HTTPS]
$ ruby uri.rb --uri http://github.com
[#<URI::HTTP http://github.com>, URI::HTTP]
$ ruby uri.rb --uri file://~/var
[#<URI::File file://~/var>, URI::File]

`Shellwords`¶ ↑

File shellwords.rb 定義一個選項，其參數要由 Shellwords#shellwords 方法轉換為 Array 物件。

require 'optparse/shellwords'
parser = OptionParser.new
parser.on('--shellwords=SHELLWORDS', Shellwords) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby shellwords.rb --shellwords "ruby my_prog.rb | less"
[["ruby", "my_prog.rb", "|", "less"], Array]
$ ruby shellwords.rb --shellwords "here are 'two words'"
[["here", "are", "two words"], Array]

`Integer`¶ ↑

File integer.rb 定義一個選項，其參數要由 Kernel#Integer 方法轉換為 Integer 物件。

require 'optparse'
parser = OptionParser.new
parser.on('--integer=INTEGER', Integer) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby integer.rb --integer 100
[100, Integer]
$ ruby integer.rb --integer -100
[-100, Integer]
$ ruby integer.rb --integer 0100
[64, Integer]
$ ruby integer.rb --integer 0x100
[256, Integer]
$ ruby integer.rb --integer 0b100
[4, Integer]

`Float`¶ ↑

File float.rb 定義一個選項，其參數要由 Kernel#Float 方法轉換為 Float 物件。

require 'optparse'
parser = OptionParser.new
parser.on('--float=FLOAT', Float) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby float.rb --float 1
[1.0, Float]
$ ruby float.rb --float 3.14159
[3.14159, Float]
$ ruby float.rb --float 1.234E2
[123.4, Float]
$ ruby float.rb --float 1.234E-2
[0.01234, Float]

`Numeric`¶ ↑

File numeric.rb 定義一個選項，其參數要轉換為 Rational、Float 或 Integer 的實例。參數會由 Kernel#Rational、Kernel#Float 或 Kernel#Integer 方法轉換。

require 'optparse'
parser = OptionParser.new
parser.on('--numeric=NUMERIC', Numeric) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby numeric.rb --numeric 1/3
[(1/3), Rational]
$ ruby numeric.rb --numeric 3.333E-1
[0.3333, Float]
$ ruby numeric.rb --numeric 3
[3, Integer]

`DecimalInteger`¶ ↑

File decimal_integer.rb 定義一個選項，其引數要轉換成 Integer 物件。引數會由方法 Kernel#Integer 轉換。

require 'optparse'
include OptionParser::Acceptables
parser = OptionParser.new
parser.on('--decimal_integer=DECIMAL_INTEGER', DecimalInteger) do |value|
  p [value, value.class]
end
parser.parse!

引數不能是二進制或十六進制格式；會忽略前導零（不會當成八進制來解析）。

執行

$ ruby decimal_integer.rb --decimal_integer 100
[100, Integer]
$ ruby decimal_integer.rb --decimal_integer -100
[-100, Integer]
$ ruby decimal_integer.rb --decimal_integer 0100
[100, Integer]
$ ruby decimal_integer.rb --decimal_integer -0100
[-100, Integer]

`OctalInteger`¶ ↑

File octal_integer.rb 定義一個選項，其引數要轉換成 Integer 物件。引數會由方法 Kernel#Integer 轉換。

require 'optparse'
include OptionParser::Acceptables
parser = OptionParser.new
parser.on('--octal_integer=OCTAL_INTEGER', OctalInteger) do |value|
  p [value, value.class]
end
parser.parse!

引數不能是二進制或十六進制格式；會當成八進制來解析，不論它有沒有前導零。

執行

$ ruby octal_integer.rb --octal_integer 100
[64, Integer]
$ ruby octal_integer.rb --octal_integer -100
[-64, Integer]
$ ruby octal_integer.rb --octal_integer 0100
[64, Integer]

`DecimalNumeric`¶ ↑

File decimal_numeric.rb 定義一個選項，其引數要轉換成 Integer 物件。引數會由方法 Kernel#Integer 轉換。

require 'optparse'
include OptionParser::Acceptables
parser = OptionParser.new
parser.on('--decimal_numeric=DECIMAL_NUMERIC', DecimalNumeric) do |value|
  p [value, value.class]
end
parser.parse!

引數不能是二進制或十六進制格式；前導零會導致引數被當成八進制來解析。

執行

$ ruby decimal_numeric.rb --decimal_numeric 100
[100, Integer]
$ ruby decimal_numeric.rb --decimal_numeric -100
[-100, Integer]
$ ruby decimal_numeric.rb --decimal_numeric 0100
[64, Integer]

`TrueClass`¶ ↑

File true_class.rb 定義一個選項，其引數要轉換成 true 或 false。引數會由方法 Object#nil? 評估。

require 'optparse'
parser = OptionParser.new
parser.on('--true_class=TRUE_CLASS', TrueClass) do |value|
  p [value, value.class]
end
parser.parse!

引數可以是下列範例中所示的任何一個。

執行

$ ruby true_class.rb --true_class true
[true, TrueClass]
$ ruby true_class.rb --true_class yes
[true, TrueClass]
$ ruby true_class.rb --true_class +
[true, TrueClass]
$ ruby true_class.rb --true_class false
[false, FalseClass]
$ ruby true_class.rb --true_class no
[false, FalseClass]
$ ruby true_class.rb --true_class -
[false, FalseClass]
$ ruby true_class.rb --true_class nil
[false, FalseClass]

`FalseClass`¶ ↑

File false_class.rb 定義一個選項，其引數要轉換成 true 或 false。引數會由方法 Object#nil? 評估。

require 'optparse'
parser = OptionParser.new
parser.on('--false_class=FALSE_CLASS', FalseClass) do |value|
  p [value, value.class]
end
parser.parse!

引數可以是下列範例中所示的任何一個。

執行

$ ruby false_class.rb --false_class false
[false, FalseClass]
$ ruby false_class.rb --false_class no
[false, FalseClass]
$ ruby false_class.rb --false_class -
[false, FalseClass]
$ ruby false_class.rb --false_class nil
[false, FalseClass]
$ ruby false_class.rb --false_class true
[true, TrueClass]
$ ruby false_class.rb --false_class yes
[true, TrueClass]
$ ruby false_class.rb --false_class +
[true, TrueClass]

`Object`¶ ↑

File object.rb 定義一個選項，其引數不會從 String 轉換。

require 'optparse'
parser = OptionParser.new
parser.on('--object=OBJECT', Object) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby object.rb --object foo
["foo", String]
$ ruby object.rb --object nil
["nil", String]

`String`¶ ↑

File string.rb 定義一個選項，其引數不會從 String 轉換。

require 'optparse'
parser = OptionParser.new
parser.on('--string=STRING', String) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby string.rb --string foo
["foo", String]
$ ruby string.rb --string nil
["nil", String]

`Array`¶ ↑

File array.rb 定義一個選項，其引數要從 String 轉換成陣列字串，根據逗號分隔的子字串。

require 'optparse'
parser = OptionParser.new
parser.on('--array=ARRAY', Array) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby array.rb --array ""
[[], Array]
$ ruby array.rb --array foo,bar,baz
[["foo", "bar", "baz"], Array]
$ ruby array.rb --array "foo, bar, baz"
[["foo", " bar", " baz"], Array]

`Regexp`¶ ↑

File regexp.rb 定義一個選項，其參數要轉換為 Regexp 物件。

require 'optparse'
parser = OptionParser.new
parser.on('--regexp=REGEXP', Regexp) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby regexp.rb --regexp foo

自訂參數轉換器¶ ↑

您可以建立自訂參數轉換器。要建立自訂轉換器，請呼叫 OptionParser#accept，並提供

識別碼，可以是任何物件。
選配的比對模式，預設為 /.*/m。
區塊，接受參數並傳回轉換後的數值。

此自訂轉換器接受任何參數，並在可能的情況下將其轉換為 Complex 物件。

require 'optparse/date'
parser = OptionParser.new
parser.accept(Complex) do |value|
  value.to_c
end
parser.on('--complex COMPLEX', Complex) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby custom_converter.rb --complex 0
[(0+0i), Complex]
$ ruby custom_converter.rb --complex 1
[(1+0i), Complex]
$ ruby custom_converter.rb --complex 1+2i
[(1+2i), Complex]
$ ruby custom_converter.rb --complex 0.3-0.5i
[(0.3-0.5i), Complex]

此自訂轉換器接受任何 1 個字的參數，並在可能的情況下將其大寫。

require 'optparse/date'
parser = OptionParser.new
parser.accept(:capitalize, /\w*/) do |value|
  value.capitalize
end
parser.on('--capitalize XXX', :capitalize) do |value|
  p [value, value.class]
end
parser.parse!

執行

$ ruby match_converter.rb --capitalize foo
["Foo", String]
$ ruby match_converter.rb --capitalize "foo bar"
match_converter.rb:9:in `<main>': invalid argument: --capitalize foo bar (OptionParser::InvalidArgument)

引數轉換器¶ ↑

內容¶ ↑

內建引數轉換器¶ ↑

日期¶ ↑

DateTime¶ ↑

Time¶ ↑

URI¶ ↑

Shellwords¶ ↑

Integer¶ ↑

Float¶ ↑

Numeric¶ ↑

DecimalInteger¶ ↑

OctalInteger¶ ↑

DecimalNumeric¶ ↑

TrueClass¶ ↑

FalseClass¶ ↑

Object¶ ↑

String¶ ↑

Array¶ ↑

Regexp¶ ↑