検索結果

psych (38150.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• ライブラリ

yaml のバックエンドライブラリです。libyaml ベースで作成されてお り、YAML バージョン 1.1 を扱う事ができます。

...エンドライブラリです。libyaml ベースで作成されてお
り、YAML バージョン 1.1 を扱う事ができます。


=== 概要

Psych を用いると YAML のパースと出力ができます。
これらの機能は libyaml http://pyyaml.org/wiki/LibYAML を用いて
実装さ...

...uire '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
• Psych::BadAlias
• Psych::Emitter
• Psych::Exception
• Psych::Handler
• Psych::Nodes
• Psych::Nodes::Alias
• Psych::Nodes::Document
• Psych::Nodes::Mapping
• Psych::Nodes::Node
• Psych::Nodes::Scalar
• Psych::Nodes::Sequence
• Psych::Nodes::Stream
• Psych::Omap
• Psych::Parser
• Psych::Parser::Mark
• Psych::ScalarScanner
• Psych::Set
• Psych::Stream
• Psych::SyntaxError
• ...

Psych.dump(o, io, options = {}) -> () (35174.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

Ruby のオブジェクト o を YAML ドキュメントに変換します。

...ョン

//emlist[例][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

Psych.dump(o, options = {}) -> String (35174.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

Ruby のオブジェクト o を YAML ドキュメントに変換します。

...ョン

//emlist[例][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

Psych.dump_stream(*objects) -> String (23113.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

オブジェクト列を YAML ドキュメント列に変換します。

...オブジェクト列を YAML ドキュメント列に変換します。

@param objects 変換対象のオブジェクト列

//emlist[例][ruby]{
Psych.dump_stream("foo\n ", {}) # => "--- ! \"foo\\n \"\n--- {}\n"
//}...

• Psych

Psych.safe_load(yaml, legacy_permitted_classes=[], legacy_permitted_symbols=[], legacy_aliases=false, legacy_filename=nil) -> object (17090.0)

• 3.1
• 3.2
• 3.3

• 特異メソッド

安全に 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
• Psych::SyntaxError
• Symbol

絞り込み条件を変える

Psych.safe_load(yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false) -> object (17090.0)

• 3.1
• 3.2
• 3.3

• 特異メソッド

安全に 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
• Psych::SyntaxError
• Symbol

Psych.safe_load(yaml, legacy_permitted_classes=[], legacy_permitted_symbols=[], legacy_aliases=false, legacy_filename=nil) -> object (17078.0)

• 2.6.0
• 2.7.0
• 3.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
• Psych::SyntaxError
• Symbol

Psych.safe_load(yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false) -> object (17078.0)

• 2.6.0
• 2.7.0
• 3.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
• Psych::SyntaxError
• Symbol

Psych.safe_load(yaml, whitelist_classes = [], whitelist_symbols = [], aliases = false, filename = nil, symbolize_names: false) -> object (17060.0)

• 2.5.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
• Psych::SyntaxError
• Symbol

Psych.safe_load(yaml, whitelist_classes = [], whitelist_symbols = [], aliases = false, filename = nil) -> object (17048.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.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
• Psych::SyntaxError
• Symbol

絞り込み条件を変える

Object#psych_to_yaml(options = {}) -> String (14137.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

オブジェクトを YAML document に変換します。

...ョンを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。

syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予...

...定であるため、特別の事情がない限り to_yaml を用いてください。

@param options 出力オプション
@see Psych.dump...

• Object
• syck

Psych::Visitors::YAMLTree.new(options = {}, emitter = Psych::TreeBuilder.new, ss = Psych::ScalarScanner.new) -> Psych::Visitors::YAMLTree (11339.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

YAMLTree オブジェクトを生成します。

...定します。
Psych.dump と同じオプションが指定できます。

emitter には AST の構築に使われる Psych::TreeBuilder オブジェクト
を渡します。

ss は Ruby の String が YAML document 上で quote が必要かどうか
を判定するための Psych::ScalarScanner...

...常デフォルトのものから変える必要はないでしょう。

@param options オプション
@param emitter AST の構築に使う Psych::TreeBuilder オブジェクト
@param ss 文字列に quite が必要かどうかを判定するための Psych::ScalarScanner オブジェクト...

• Psych::ScalarScanner
• Psych::TreeBuilder
• Psych::Visitors::YAMLTree
• String

Psych::Nodes (11172.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• モジュール

Psych が中間データとして利用している AST (Abstract Syntax Tree) に 関するモジュール。

...Psych が中間データとして利用している AST (Abstract Syntax Tree) に
関するモジュール。

Psych.load によって YAML ドキュメントを Ruby オブジェクトに変換
するときには、一度中間的な AST に変換され、その AST が Ruby の
オブジェクト...

...。

逆向き、つまり Psych.dump で Ruby のオブジェクトを
YAML ドキュメントに変換するときには、中間的な AST に変換してから
それを YAML ドキュメントに変換します。

YAML AST の各ノードのクラスはすべて Psych::Nodes の下にありま...

...を1つ持つリストの AST を構築しています。

# Create our nodes
stream = Psych::Nodes::Stream.new
doc = Psych::Nodes::Document.new
seq = Psych::Nodes::Sequence.new
scalar = Psych::Nodes::Scalar.new('foo')

# Build up our tree
stream.children << doc
doc.children...

• Psych::Nodes::Alias
• Psych::Nodes::Document
• Psych::Nodes::Mapping
• Psych::Nodes::Scalar
• Psych::Nodes::Sequence
• Psych::Nodes::Stream

Object#to_yaml(options = {}) -> String (11037.0)

• 2.1.0
• 2.4.0
• 2.6.0
• 2.7.0
• 3.2
• 3.3

• インスタンスメソッド

オブジェクトを YAML document に変換します。

...ョンを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。

syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予...

...定であるため、特別の事情がない限り to_yaml を用いてください。

@param options 出力オプション
@see Psych.dump...

• Object
• syck