# File ext/psych/lib/psych.rb, line 506
def self.dump o, io = nil, options = {}
  if Hash === io
    options = io
    io      = nil
  end

  visitor = Psych::Visitors::YAMLTree.create options
  visitor << o
  visitor.tree.yaml io, options
end

Выводит объект Ruby o в строку YAML. Дополнительные options могут быть переданы для управления форматом вывода. Если передан объект IO, YAML будет выведен в этот объект IO.

В настоящее время поддерживаются следующие параметры:

:indentation

Количество пробелов, используемых для отступа. Допустимое значение должно быть в диапазоне 0..9, в противном случае параметр игнорируется.

По умолчанию: 2.

:line_width

Максимальная длина строки для перевода строки.

По умолчанию: 0 (означает «перевод строки при 81»).

:canonical

Запись «канонической» формы YAML (очень подробной, но строго формальной).

По умолчанию: false.

:header

Запись «%YAML [version]» в начале документа.

По умолчанию: false.

Пример:

# 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)

# File ext/psych/lib/psych.rb, line 523
def self.dump_stream *objects
  visitor = Psych::Visitors::YAMLTree.create({})
  objects.each do |o|
    visitor << o
  end
  visitor.tree.yaml
end

Выводит список объектов в виде отдельных документов в поток документов.

Пример:

Psych.dump_stream("foo\n  ", {}) # => "--- ! \"foo\\n  \"\n--- {}\n"

static VALUE libyaml_version(VALUE module)
{
    int major, minor, patch;
    VALUE list[3];

    yaml_get_version(&major, &minor, &patch);

    list[0] = INT2NUM(major);
    list[1] = INT2NUM(minor);
    list[2] = INT2NUM(patch);

    return rb_ary_new4((long)3, list);
}

Возвращает версию используемого libyaml

# File ext/psych/lib/psych.rb, line 274
def self.load yaml, legacy_filename = NOT_GIVEN, filename: nil, fallback: false, symbolize_names: false, freeze: false
  if legacy_filename != NOT_GIVEN
    warn_with_uplevel 'Passing filename with the 2nd argument of Psych.load is deprecated. Use keyword argument like Psych.load(yaml, filename: ...) instead.', uplevel: 1 if $VERBOSE
    filename = legacy_filename
  end

  result = parse(yaml, filename: filename)
  return fallback unless result
  result.to_ruby(symbolize_names: symbolize_names, freeze: freeze)
end

Загружает yaml в структуру данных Ruby. Если предоставляется несколько документов, возвращается объект, содержащийся в первом документе. filename будет использоваться в сообщении об ошибке, если при разборе возникнет какая-либо ошибка. Если yaml пусто, возвращается указанное значение fallback, по умолчанию false.

Вызывает Psych::SyntaxError, если обнаружена ошибка синтаксиса YAML.

Пример:

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

Если необязательный параметр symbolize_names имеет значение true, возвращает символы для ключей в объектах Hash (по умолчанию — строки).

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

Вызывает TypeError, если параметр `yaml` равен NilClass

ПРИМЕЧАНИЕ: Этот метод *не следует* использовать для разбора ненадежных документов, таких как документы YAML, предоставленные пользователем. Вместо этого используйте метод safe_load.

# File ext/psych/lib/psych.rb, line 580
def self.load_file filename, **kwargs
  File.open(filename, 'r:bom|utf-8') { |f|
    self.load f, filename: filename, **kwargs
  }
end

Загружает документ, содержащийся в filename. Возвращает содержащийся в filename YAML в виде объекта Ruby, или, если файл пуст, возвращает указанное значение fallback возврата, по умолчанию false.

ПРИМЕЧАНИЕ: Этот метод *не следует* использовать для разбора ненадежных документов, таких как документы YAML, предоставленные пользователем. Вместо этого используйте метод safe_load_file.

# File ext/psych/lib/psych.rb, line 554
def self.load_stream yaml, legacy_filename = NOT_GIVEN, filename: nil, fallback: [], **kwargs
  if legacy_filename != NOT_GIVEN
    warn_with_uplevel 'Passing filename with the 2nd argument of Psych.load_stream is deprecated. Use keyword argument like Psych.load_stream(yaml, filename: ...) instead.', uplevel: 1 if $VERBOSE
    filename = legacy_filename
  end

  result = if block_given?
             parse_stream(yaml, filename: filename) do |node|
               yield node.to_ruby(**kwargs)
             end
           else
             parse_stream(yaml, filename: filename).children.map { |node| node.to_ruby(**kwargs) }
           end

  return fallback if result.is_a?(Array) && result.empty?
  result
end

Загружает несколько документов, заданных в yaml. Возвращает загруженные документы в виде списка. Если задан блок, каждый документ будет преобразован в Ruby и передан в блок во время разбора

Пример:

Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']

list = []
Psych.load_stream("--- foo\n...\n--- bar\n...") do |ruby|
  list << ruby
end
list # => ['foo', 'bar']

# File ext/psych/lib/psych.rb, line 384
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

Разбирает строку YAML в yaml. Возвращает Psych::Nodes::Document. filename используется в сообщении об ошибке, если возникает Psych::SyntaxError.

Вызывает Psych::SyntaxError, если обнаружена ошибка синтаксиса YAML.

Пример:

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

См. Psych::Nodes для получения дополнительной информации об AST YAML.

# File ext/psych/lib/psych.rb, line 406
def self.parse_file filename, fallback: false
  result = File.open filename, 'r:bom|utf-8' do |f|
    parse f, filename: filename
  end
  result || fallback
end

Разбирает файл по адресу filename. Возвращает Psych::Nodes::Document.

Вызывает Psych::SyntaxError, если обнаружена ошибка синтаксиса YAML.

# File ext/psych/lib/psych.rb, line 448
def self.parse_stream yaml, legacy_filename = NOT_GIVEN, filename: nil, &block
  if legacy_filename != NOT_GIVEN
    warn_with_uplevel 'Passing filename with the 2nd argument of Psych.parse_stream is deprecated. Use keyword argument like Psych.parse_stream(yaml, filename: ...) instead.', uplevel: 1 if $VERBOSE
    filename = legacy_filename
  end

  if block_given?
    parser = Psych::Parser.new(Handlers::DocumentStream.new(&block))
    parser.parse yaml, filename
  else
    parser = self.parser
    parser.parse yaml, filename
    parser.handler.root
  end
end

Разбирает строку YAML в yaml. Возвращает Psych::Nodes::Stream. Этот метод может обрабатывать несколько документов YAML, содержащихся в yaml. filename используется в сообщении об ошибке, если возникает Psych::SyntaxError.

Если задан блок, узел Psych::Nodes::Document будет передан в блок во время разбора.

Вызывает Psych::SyntaxError, если обнаружена ошибка синтаксиса YAML.

Пример:

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

Psych.parse_stream("--- a\n--- b") do |node|
  node # => #<Psych::Nodes::Document:0x00>
end

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

Вызывает TypeError, если передан NilClass.

См. Psych::Nodes для получения дополнительной информации об AST YAML.

# File ext/psych/lib/psych.rb, line 415
def self.parser
  Psych::Parser.new(TreeBuilder.new)
end

Возвращает парсер по умолчанию

# File ext/psych/lib/psych.rb, line 329
def self.safe_load yaml, legacy_permitted_classes = NOT_GIVEN, legacy_permitted_symbols = NOT_GIVEN, legacy_aliases = NOT_GIVEN, legacy_filename = NOT_GIVEN, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false
  if legacy_permitted_classes != NOT_GIVEN
    warn_with_uplevel 'Passing permitted_classes with the 2nd argument of Psych.safe_load is deprecated. Use keyword argument like Psych.safe_load(yaml, permitted_classes: ...) instead.', uplevel: 1 if $VERBOSE
    permitted_classes = legacy_permitted_classes
  end

  if legacy_permitted_symbols != NOT_GIVEN
    warn_with_uplevel 'Passing permitted_symbols with the 3rd argument of Psych.safe_load is deprecated. Use keyword argument like Psych.safe_load(yaml, permitted_symbols: ...) instead.', uplevel: 1 if $VERBOSE
    permitted_symbols = legacy_permitted_symbols
  end

  if legacy_aliases != NOT_GIVEN
    warn_with_uplevel 'Passing aliases with the 4th argument of Psych.safe_load is deprecated. Use keyword argument like Psych.safe_load(yaml, aliases: ...) instead.', uplevel: 1 if $VERBOSE
    aliases = legacy_aliases
  end

  if legacy_filename != NOT_GIVEN
    warn_with_uplevel 'Passing filename with the 5th argument of Psych.safe_load is deprecated. Use keyword argument like Psych.safe_load(yaml, filename: ...) instead.', uplevel: 1 if $VERBOSE
    filename = legacy_filename
  end

  result = parse(yaml, filename: filename)
  return fallback unless result

  class_loader = ClassLoader::Restricted.new(permitted_classes.map(&:to_s),
                                             permitted_symbols.map(&:to_s))
  scanner      = ScalarScanner.new class_loader
  visitor = if aliases
              Visitors::ToRuby.new scanner, class_loader, symbolize_names: symbolize_names, freeze: freeze
            else
              Visitors::NoAliasRuby.new scanner, class_loader, symbolize_names: symbolize_names, freeze: freeze
            end
  result = visitor.accept result
  result
end

Безопасно загружает строку yaml в yaml. По умолчанию разрешены только следующие классы:

• TrueClass

• FalseClass

• NilClass

• Numeric

• String

• Array

• Hash

Вложенные структуры данных по умолчанию не разрешены. Произвольные классы можно разрешить, добавив эти классы в параметр permitted_classes. Они добавляются. Например, для разрешения загрузки Date:

Psych.safe_load(yaml, permitted_classes: [Date])

Теперь класс Date может быть загружен дополнительно к перечисленным выше классам.

Псевдонимы можно явно разрешить, изменив параметр aliases. Например:

x = []
x << x
yaml = Psych.dump x
Psych.safe_load yaml               # => raises an exception
Psych.safe_load yaml, aliases: true # => loads the aliases

Psych::DisallowedClass будет вызван, если YAML содержит класс, который отсутствует в списке permitted_classes.

Psych::BadAlias будет вызван, если YAML содержит псевдонимы, но параметр aliases имеет значение false.

filename будет использоваться в сообщении об ошибке, если при разборе возникнет какая-либо ошибка.

Если необязательный параметр symbolize_names имеет значение true, возвращает символы для ключей в объектах Hash (по умолчанию — строки).

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

# File ext/psych/lib/psych.rb, line 591
def self.safe_load_file filename, **kwargs
  File.open(filename, 'r:bom|utf-8') { |f|
    self.safe_load f, filename: filename, **kwargs
  }
end

Безопасно загружает документ, содержащийся в filename. Возвращает yaml, содержащийся в filename, в виде объекта Ruby, или, если файл пуст, возвращает указанное значение fallback возврата, по умолчанию равное false. См. safe_load для вариантов.

# File ext/psych/lib/psych.rb, line 533
def self.to_json object
  visitor = Psych::Visitors::JSONTree.create
  visitor << object
  visitor.tree.yaml
end

Преобразует объект Ruby object в строку JSON.