End of Life Ruby 3.0 has reached end of life and gets no more fixes. Switch to Ruby 4.0 →

class method

Psych.parse

parse(yaml, legacy_filename = NOT_GIVEN, filename: nil, fallback: NOT_GIVEN)

# File tmp/rubies/ruby-3.0.5/ext/psych/lib/psych.rb, line 385
def self.parse yaml, legacy_filename = NOT_GIVEN, filename: nil, fallback: NOT_GIVEN
  if legacy_filename != NOT_GIVEN
    warn_with_uplevel 'Passing filename with the 2nd argument of Psych.parse is deprecated. Use keyword argument like Psych.parse(yaml, filename: ...) instead.', uplevel: 1 if $VERBOSE
    filename = legacy_filename
  end

  parse_stream(yaml, filename: filename) do |node|
    return node
  end

  if fallback != NOT_GIVEN
    warn_with_uplevel 'Passing the `fallback` keyword argument of Psych.parse is deprecated.', uplevel: 1 if $VERBOSE
    fallback
  else
    false
  end
end

Parse a YAML string in yaml. Returns the Psych::Nodes::Document. filename is used in the exception message if a Psych::SyntaxError is raised.

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

Example:

Example

Psych.parse("---\n - a\n - b") # => #<Psych::Nodes::Document:0x00>

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

See Psych::Nodes for more information about YAML AST.

See also .load_stream .parse_file .load_file .parser also in 4.1 · 4.0 · 3.4 · 3.3 · 3.2 · 3.1

‹ prev.load_stream next ›.parse_file