класс PP

Родитель:: PrettyPrint
Включённые модули:: PP::PPMethods

Форматированный вывод объектов Ruby.

Все примеры предполагают, что класс PP загружен с помощью:

require 'pp'

Что делает PP

Стандартный вывод с помощью p возвращает следующее:

#<PP:0x81fedf0 @genspace=#<Proc:0x81feda0>, @group_queue=#<PrettyPrint::GroupQueue:0x81fed3c @queue=[[#<PrettyPrint::Group:0x81fed78 @breakables=[], @depth=0, @break=false>], []]>, @buffer=[], @newline="\n", @group_stack=[#<PrettyPrint::Group:0x81fed78 @breakables=[], @depth=0, @break=false>], @buffer_width=0, @indent=0, @maxwidth=79, @output_width=2, @output=#<IO:0x8114ee4>>

Форматированный вывод возвращает следующее:

#<PP:0x81fedf0
 @buffer=[],
 @buffer_width=0,
 @genspace=#<Proc:0x81feda0>,
 @group_queue=
  #<PrettyPrint::GroupQueue:0x81fed3c
   @queue=
    [[#<PrettyPrint::Group:0x81fed78 @break=false, @breakables=[], @depth=0>],
     []]>,
 @group_stack=
  [#<PrettyPrint::Group:0x81fed78 @break=false, @breakables=[], @depth=0>],
 @indent=0,
 @maxwidth=79,
 @newline="\n",
 @output=#<IO:0x8114ee4>,
 @output_width=2>

Использование

pp(obj)             #=> obj
pp obj              #=> obj
pp(obj1, obj2, ...) #=> [obj1, obj2, ...]
pp()                #=> nil

Выводит obj(s) в $> в формате с форматированием.

Возвращает obj(s).

Настройка вывода

Для определения пользовательской функции форматирования вывода для ваших классов переопределите метод #pretty_print(pp) в классе.

#pretty_print принимает аргумент pp, который является экземпляром класса PP. Метод использует text, breakable, nest, group и pp для вывода объекта.

Форматированный вывод JSON

Для форматированного вывода JSON обратитесь к JSON#pretty_generate.

Автор

Tanaka Akira <akr@fsij.org>

Атрибуты

sharing_detection[RW]

Возвращает флаг обнаружения общих участков в виде булевого значения. По умолчанию он равен false.

Публичные методы класса

pp(obj, out=$>, width=79) Показать исходный код

# File lib/pp.rb, line 97
def PP.pp(obj, out=$>, width=79)
  q = PP.new(out, width)
  q.guard_inspect_key {q.pp obj}
  q.flush
  #$pp = q
  out << "\n"
end

Выводит obj в out в формате с форматированием шириной width столбцов.

Если out опущено, используется $>. Если width опущено, используется 79.

::pp возвращает out.

singleline_pp(obj, out=$>) Показать исходный код

# File lib/pp.rb, line 109
def PP.singleline_pp(obj, out=$>)
  q = SingleLine.new(out)
  q.guard_inspect_key {q.pp obj}
  q.flush
  out
end

Выводит obj в out так же, как ::pp, но без отступов и переносов строк.

::singleline_pp возвращает out.

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.