検索結果

psych (38132.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0.0
• 3.1.0
• 3.2.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
• 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.parse(yaml, filename = nil) -> Psych::Nodes::Document (17149.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0.0
• 3.1.0
• 3.2.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
• Psych::Nodes
• Psych::SyntaxError

Psych.parse_stream(yaml) -> Psych::Nodes::Stream (17131.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0.0
• 3.1.0
• 3.2.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
• Psych::Nodes
• Psych::Nodes::Stream

Psych.parse_file(filename) -> Psych::Nodes::Document (17107.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0.0
• 3.1.0
• 3.2.0

• 特異メソッド

filename で指定したファイルをパースして YAML の AST を返します。

...filename で指定したファイルをパースして YAML の AST を返します。

@param filename パースするファイルの名前
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します...

• Psych

Psych.parser -> Psych::Parser (17101.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0.0
• 3.1.0
• 3.2.0

• 特異メソッド

デフォルトで使われるのパーサを返します。

デフォルトで使われるのパーサを返します。

• Psych

絞り込み条件を変える

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

• 3.0.0
• 3.1.0
• 3.2.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, freeze: false) -> object (17084.0)

• 3.0.0
• 3.1.0
• 3.2.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, legacy_permitted_classes=[], legacy_permitted_symbols=[], legacy_aliases=false, legacy_filename=nil) -> object (17072.0)

• 2.6.0
• 2.7.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 (17072.0)

• 2.6.0
• 2.7.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.load(yaml, filename = nil, fallback: false, symbolize_names: false) -> object (17054.0)

• 2.5.0
• 2.6.0
• 2.7.0
• 3.0.0
• 3.1.0
• 3.2.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
• Psych::SyntaxError
• Symbol

絞り込み条件を変える

Psych.safe_load(yaml, whitelist_classes = [], whitelist_symbols = [], aliases = false, filename = nil, symbolize_names: false) -> object (17054.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.load(yaml, filename = nil, fallback = false) -> object (17042.0)

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

Psych.safe_load(yaml, whitelist_classes = [], whitelist_symbols = [], aliases = false, filename = nil) -> object (17042.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

Psych.parse_stream(yaml) {|node| ... } -> () (17031.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0.0
• 3.1.0
• 3.2.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
• Psych::Nodes
• Psych::Nodes::Stream

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0.0
• 3.1.0
• 3.2.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

絞り込み条件を変える

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

• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 3.2.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