class method

Psych.load

(::String yaml, ?filename: ::String | ::_ToStr | ::_ToS?, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped

load(yaml, permitted_classes: [Symbol], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false, parse_symbols: true)

ext/psych/lib/psych.rb View on GitHub ↗

# File tmp/rubies/ruby-4.0.0/ext/psych/lib/psych.rb, line 369
def self.load yaml, permitted_classes: [Symbol], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false, parse_symbols: true
  safe_load yaml, permitted_classes: permitted_classes,
                  permitted_symbols: permitted_symbols,
                  aliases: aliases,
                  filename: filename,
                  fallback: fallback,
                  symbolize_names: symbolize_names,
                  freeze: freeze,
                  strict_integer: strict_integer,
                  parse_symbols: parse_symbols
end

Load yaml in to a Ruby data structure. If multiple documents are provided, the object contained in the first document will be returned. filename will be used in the exception message if any exception is raised while parsing. If yaml is empty, it returns the specified fallback return value, which defaults to nil.

Raises a Psych::SyntaxError when a YAML syntax error is detected.

Example:

Example

Psych.load("--- a")             # => 'a'
Psych.load("---\n - a\n - b")   # => ['a', 'b']

begin
  Psych.load("--- `", filename: "file.txt")
rescue Psych::SyntaxError => ex
  ex.file    # => 'file.txt'
  ex.message # => "(file.txt): found character that cannot start any token"
end

When the optional symbolize_names keyword argument is set to a true value, returns symbols for keys in Hash objects (default: strings).

Example

Psych.load("---\n foo: bar")                         # => {"foo"=>"bar"}
Psych.load("---\n foo: bar", symbolize_names: true)  # => {:foo=>"bar"}

Raises a TypeError when yaml parameter is NilClass. This method is similar to safe_load except that Symbol objects are allowed by default.

See also .libyaml_version .load_file .dump_stream .load_stream also in 4.1 · 3.4 · 3.3 · 3.2 · 3.1 · 3.0

‹ prev.libyaml_version next ›.load_file