ライブラリ
- psych (1751)
- yaml (10)
-
yaml
/ store (17)
クラス
- Module (8)
- Object (30)
-
Psych
:: Emitter (70) -
Psych
:: Handler (120) -
Psych
:: Nodes :: Alias (30) -
Psych
:: Nodes :: Document (100) -
Psych
:: Nodes :: Mapping (120) -
Psych
:: Nodes :: Node (80) -
Psych
:: Nodes :: Scalar (190) -
Psych
:: Nodes :: Sequence (120) -
Psych
:: Nodes :: Stream (70) -
Psych
:: Parser (90) -
Psych
:: Parser :: Mark (30) -
Psych
:: ScalarScanner (30) -
Psych
:: Stream (40) -
Psych
:: SyntaxError (60) -
Psych
:: TreeBuilder (20) -
Psych
:: Visitors :: YAMLTree (100) -
YAML
:: Store (17)
キーワード
- << (10)
- ANY (50)
- Alias (10)
- BLOCK (20)
- BadAlias (10)
-
DOUBLE
_ QUOTED (10) - Document (10)
- Emitter (10)
- Exception (10)
- FLOW (20)
- FOLDED (10)
- Handler (10)
-
LIBYAML
_ VERSION (10) - LITERAL (10)
- Mapping (10)
- Mark (10)
-
NEWS for Ruby 2
. 2 . 0 (9) -
NEWS for Ruby 2
. 3 . 0 (8) -
NEWS for Ruby 2
. 4 . 0 (7) -
NEWS for Ruby 2
. 5 . 0 (6) -
NEWS for Ruby 2
. 6 . 0 (5) -
NEWS for Ruby 3
. 0 . 0 (3) -
NEWS for Ruby 3
. 1 . 0 (2) - Node (10)
- Nodes (10)
- Omap (10)
- PLAIN (10)
- Parser (10)
- Psych (10)
-
SINGLE
_ QUOTED (10) - Scalar (10)
- ScalarScanner (10)
- Sequence (10)
- Set (10)
- Stream (20)
- SyntaxError (10)
- TreeBuilder (10)
- UTF16BE (20)
- UTF16LE (20)
- UTF8 (20)
- VERSION (10)
- Visitor (10)
- Visitors (10)
- YAML (10)
- YAMLTree (10)
- alias (10)
- anchor (40)
- anchor= (40)
- canonical (10)
- canonical= (10)
- children (10)
- column (20)
- context (10)
- dump (20)
-
dump
_ stream (10) - each (20)
- empty (10)
- encoding (10)
- encoding= (10)
-
end
_ document (10) -
end
_ mapping (10) -
end
_ sequence (10) -
end
_ stream (10) - file (10)
- finish (20)
- finished (10)
- finished? (10)
- handler (10)
- handler= (10)
- implicit (30)
- implicit= (30)
-
implicit
_ end (10) -
implicit
_ end= (10) - indentation (10)
- indentation= (10)
- index (10)
-
libyaml
_ version (10) - line (20)
-
line
_ width (10) -
line
_ width= (10) - load (10)
-
load
_ documents (8) -
load
_ file (10) -
load
_ stream (20) - mark (10)
- new (137)
- offset (10)
- parse (20)
-
parse
_ file (10) -
parse
_ stream (20) -
parse
_ time (10) - parser (10)
- plain (10)
- plain= (10)
- problem (10)
-
psych
_ to _ yaml (10) -
psych
_ y (10) -
psych
_ yaml _ as (4) - push (10)
- quoted (10)
- quoted= (10)
- root (20)
-
safe
_ load (15) - scalar (10)
- start (30)
-
start
_ document (10) -
start
_ mapping (10) -
start
_ sequence (10) -
start
_ stream (10) - started (10)
- started? (10)
- streaming? (10)
- style (30)
- style= (30)
- tag (40)
- tag= (30)
-
tag
_ directives (10) -
tag
_ directives= (10) -
to
_ json (10) -
to
_ ruby (10) -
to
_ yaml (20) - tokenize (10)
- transform (10)
- tree (10)
- value (10)
- value= (10)
- version (10)
- version= (10)
- y (10)
- yaml (20)
-
yaml
_ as (4) -
yaml
_ tag (10)
検索結果
先頭5件
-
psych (38132.0)
-
yaml のバックエンドライブラリです。libyaml ベースで作成されてお り、YAML バージョン 1.1 を扱う事ができます。
...エンドライブラリです。libyaml ベースで作成されてお
り、YAML バージョン 1.1 を扱う事ができます。
=== 概要
Psych を用いると YAML のパースと出力ができます。
これらの機能は libyaml http://pyyaml.org/wiki/LibYAML を用いて
実装さ......equire 'psych'
# YAML のテキストをパースする
Psych.load("--- foo") # => "foo"
# YAML のデータを出力
Psych.dump("foo") # => "--- foo\n...\n"
{ :a => 'b'}.to_yaml # => "---\n:a: b\n"
//}
基本的な使い方はこれだけです。簡単な用事は
Psych.load、Psych.dump......で片付きます。
==== YAML のパース
Psych は YAML ドキュメントのパースができます。
ユーザの必要に応じ、高水準な API から低水準な API まで用意されています。
最も低水準なものは、イベントベースな API です。中程度の水... -
Psych
. parse(yaml , filename = nil) -> Psych :: Nodes :: Document (17149.0) -
YAML ドキュメントをパースし、YAML の AST を返します。
...用います。
AST については Psych::Nodes を参照してください。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメント......に文法エラーが発見されたときに発生します
@see Psych.load
//emlist[例][ruby]{
Psych.parse("---\n - a\n - b") # => #<Psych::Nodes::Document:...>
begin
Psych.parse("--- `", "file.txt")
rescue Psych::SyntaxError => ex
p ex.file # => 'file.txt'
p ex.message # => "(file.txt... -
Psych
. parse _ stream(yaml) -> Psych :: Nodes :: Stream (17131.0) -
YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
...した Psych::Nodes::Stream オブジェクト)を返します。
ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。
@see Psych::Nodes......//emlist[例][ruby]{
Psych.parse_stream("---\n - a\n - b") # => #<Psych::Nodes::Stream:0x00>
//}... -
Psych
. parse _ file(filename) -> Psych :: Nodes :: Document (17107.0) -
filename で指定したファイルをパースして YAML の AST を返します。
...filename で指定したファイルをパースして YAML の AST を返します。
@param filename パースするファイルの名前
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します... -
Psych
. parser -> Psych :: Parser (17101.0) -
デフォルトで使われるのパーサを返します。
デフォルトで使われるのパーサを返します。 -
Psych
. safe _ load(yaml , legacy _ permitted _ classes=[] , legacy _ permitted _ symbols=[] , legacy _ aliases=false , legacy _ filename=nil) -> object (17084.0) -
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
...えば Date クラスを許可するには
以下のように書いてください:
//emlist[permitted_classes: に Date を渡した例][ruby]{
Psych.safe_load(yaml, permitted_classes: [Date])
//}
すると上のクラス一覧に加えて Date クラスが読み込まれます。
エイリア......の例][ruby]{
x = []
x << x
yaml = Psych.dump x
Psych.safe_load yaml # => 例外発生
Psych.safe_load yaml, aliases: true # => エイリアスが読み込まれる
//}
yaml に許可されていないクラスが含まれていた場合は、
Psych::DisallowedClass 例外が発生......します。
yaml がエイリアスを含んでいてキーワード引数 aliases が false の時、
Psych::BadAlias 例外が発生します。
filename はパース中に発生した例外のメッセージに用います。
キーワード引数 symbolize_names に true を指定した場... -
Psych
. safe _ load(yaml , permitted _ classes: [] , permitted _ symbols: [] , aliases: false , filename: nil , fallback: nil , symbolize _ names: false , freeze: false) -> object (17084.0) -
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
...えば Date クラスを許可するには
以下のように書いてください:
//emlist[permitted_classes: に Date を渡した例][ruby]{
Psych.safe_load(yaml, permitted_classes: [Date])
//}
すると上のクラス一覧に加えて Date クラスが読み込まれます。
エイリア......の例][ruby]{
x = []
x << x
yaml = Psych.dump x
Psych.safe_load yaml # => 例外発生
Psych.safe_load yaml, aliases: true # => エイリアスが読み込まれる
//}
yaml に許可されていないクラスが含まれていた場合は、
Psych::DisallowedClass 例外が発生......します。
yaml がエイリアスを含んでいてキーワード引数 aliases が false の時、
Psych::BadAlias 例外が発生します。
filename はパース中に発生した例外のメッセージに用います。
キーワード引数 symbolize_names に true を指定した場... -
Psych
. safe _ load(yaml , legacy _ permitted _ classes=[] , legacy _ permitted _ symbols=[] , legacy _ aliases=false , legacy _ filename=nil) -> object (17072.0) -
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
...えば Date クラスを許可するには
以下のように書いてください:
//emlist[permitted_classes: に Date を渡した例][ruby]{
Psych.safe_load(yaml, permitted_classes: [Date])
//}
すると上のクラス一覧に加えて Date クラスが読み込まれます。
エイリア......の例][ruby]{
x = []
x << x
yaml = Psych.dump x
Psych.safe_load yaml # => 例外発生
Psych.safe_load yaml, aliases: true # => エイリアスが読み込まれる
//}
yaml に許可されていないクラスが含まれていた場合は、
Psych::DisallowedClass 例外が発生......します。
yaml がエイリアスを含んでいてキーワード引数 aliases が false の時、
Psych::BadAlias 例外が発生します。
filename はパース中に発生した例外のメッセージに用います。
キーワード引数 symbolize_names に true を指定した場... -
Psych
. safe _ load(yaml , permitted _ classes: [] , permitted _ symbols: [] , aliases: false , filename: nil , fallback: nil , symbolize _ names: false) -> object (17072.0) -
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
...えば Date クラスを許可するには
以下のように書いてください:
//emlist[permitted_classes: に Date を渡した例][ruby]{
Psych.safe_load(yaml, permitted_classes: [Date])
//}
すると上のクラス一覧に加えて Date クラスが読み込まれます。
エイリア......の例][ruby]{
x = []
x << x
yaml = Psych.dump x
Psych.safe_load yaml # => 例外発生
Psych.safe_load yaml, aliases: true # => エイリアスが読み込まれる
//}
yaml に許可されていないクラスが含まれていた場合は、
Psych::DisallowedClass 例外が発生......します。
yaml がエイリアスを含んでいてキーワード引数 aliases が false の時、
Psych::BadAlias 例外が発生します。
filename はパース中に発生した例外のメッセージに用います。
キーワード引数 symbolize_names に true を指定した場... -
Psych
. load(yaml , filename = nil , fallback: false , symbolize _ names: false) -> object (17054.0) -
YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。
...に発生した例外のメッセージに用います。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@param fallback 引数 yaml に空のYAMLを指定した場合の戻り......。
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します
@see Psych.parse
//emlist[例][ruby]{
Psych.load("--- a") # => 'a'
Psych.load("---\n - a\n - b") # => ['a', 'b']
begin
Psych.load("--- `", "file.txt")
rescue Psych::SyntaxEr......ード引数 symbolize_names に true を指定した場合はハッシュのキー
を Symbol に変換して返します。
//emlist[例][ruby]{
Psych.load("---\n foo: bar") # => {"foo"=>"bar"}
Psych.load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"}
//}... -
Psych
. safe _ load(yaml , whitelist _ classes = [] , whitelist _ symbols = [] , aliases = false , filename = nil , symbolize _ names: false) -> object (17054.0) -
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
...[ruby]{
Psych.safe_load(yaml, [Date])
//}
すると上のクラス一覧に加えて Date クラスが読み込まれます。
エイリアスは aliases パラメーターを変更することで明示的に許可できます。
//emlist[例][ruby]{
x = []
x << x
yaml = Psych.dump x
Psych.safe_l......oad yaml # => 例外発生
Psych.safe_load yaml, [], [], true # => エイリアスが読み込まれる
//}
yaml にホワイトリストにないクラスが含まれていた場合は、
Psych::DisallowedClass 例外が発生します。
yaml がエイリアスを含んでいて al......、
Psych::BadAlias 例外が発生します。
filename はパース中に発生した例外のメッセージに用います。
キーワード引数 symbolize_names に true を指定した場合はハッシュのキー
を Symbol に変換して返します。
//emlist[例][ruby]{
Psych.safe_... -
Psych
. load(yaml , filename = nil , fallback = false) -> object (17042.0) -
YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。
...IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@param fallback 引数 yaml に空のYAMLを指定した場合の戻り値を指定します。デフォルトは false です。
@raise Psych::SyntaxError YAMLドキュメント......文法エラーが発見されたときに発生します
@see Psych.parse
//emlist[例][ruby]{
Psych.load("--- a") # => 'a'
Psych.load("---\n - a\n - b") # => ['a', 'b']
begin
Psych.load("--- `", "file.txt")
rescue Psych::SyntaxError => ex
p ex.file # => 'file.txt'
p ex.message... -
Psych
. safe _ load(yaml , whitelist _ classes = [] , whitelist _ symbols = [] , aliases = false , filename = nil) -> object (17042.0) -
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
...[ruby]{
Psych.safe_load(yaml, [Date])
//}
すると上のクラス一覧に加えて Date クラスが読み込まれます。
エイリアスは aliases パラメーターを変更することで明示的に許可できます。
//emlist[例][ruby]{
x = []
x << x
yaml = Psych.dump x
Psych.safe_l......oad yaml # => 例外発生
Psych.safe_load yaml, [], [], true # => エイリアスが読み込まれる
//}
yaml にホワイトリストにないクラスが含まれていた場合は、
Psych::DisallowedClass 例外が発生します。
yaml がエイリアスを含んでいて al......iases パラメーターが false の時、
Psych::BadAlias 例外が発生します。
filename はパース中に発生した例外のメッセージに用います。
キーワード引数 symbolize_names に true を指定した場合はハッシュのキー
を Symbol に変換して返しま... -
Psych
. parse _ stream(yaml) {|node| . . . } -> () (17031.0) -
YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
...した Psych::Nodes::Stream オブジェクト)を返します。
ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。
@see Psych::Nodes......//emlist[例][ruby]{
Psych.parse_stream("---\n - a\n - b") # => #<Psych::Nodes::Stream:0x00>
//}... -
Psych
. dump(o , io , options = {}) -> () (17024.0) -
Ruby のオブジェクト o を YAML ドキュメントに変換します。
...[例][ruby]{
# Dump an array, get back a YAML string
Psych.dump(['a', 'b']) # => "---\n- a\n- b\n"
# Dump an array to an IO object
Psych.dump(['a', 'b'], StringIO.new) # => #<StringIO:0x000001009d0890>
# Dump an array with indentation set
Psych.dump(['a', ['b']], :indentation => 3) # => "---\n-......a\n- - b\n"
# Dump an array to an IO with indentation set
Psych.dump(['a', ['b']], StringIO.new, :indentation => 3)
//}... -
Psych
. dump(o , options = {}) -> String (17024.0) -
Ruby のオブジェクト o を YAML ドキュメントに変換します。
...[例][ruby]{
# Dump an array, get back a YAML string
Psych.dump(['a', 'b']) # => "---\n- a\n- b\n"
# Dump an array to an IO object
Psych.dump(['a', 'b'], StringIO.new) # => #<StringIO:0x000001009d0890>
# Dump an array with indentation set
Psych.dump(['a', ['b']], :indentation => 3) # => "---\n-......a\n- - b\n"
# Dump an array to an IO with indentation set
Psych.dump(['a', ['b']], StringIO.new, :indentation => 3)
//}...