класс PP

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

Инструмент для красивой печати объектов Ruby.

Что делает `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>

Общедоступные методы класса

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

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

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

Если out опущено, используется $>. Если width опущено, используется ширина out (см. width_for).

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

sharing_detection() Показать исходный код

# File lib/pp.rb, line 120
def sharing_detection
  Ractor.current[:pp_sharing_detection]
end

Возвращает флаг обнаружения совместного использования в виде булевого значения. По умолчанию он равен false (nil).

sharing_detection=(b) Показать исходный код

# File lib/pp.rb, line 124
def sharing_detection=(b)
  Ractor.current[:pp_sharing_detection] = b
end

Устанавливает флаг обнаружения совместного использования в значение b.

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

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

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

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

width_for(out) Показать исходный код

# File lib/pp.rb, line 74
def PP.width_for(out)
  begin
    require 'io/console'
    _, width = out.winsize
  rescue LoadError, NoMethodError, SystemCallError
  end
  (width || ENV['COLUMNS']&.to_i&.nonzero? || 80) - 1
end

Возвращает используемую ширину для out. Как ширина out.

Если out назначен на терминал, используется его ширина.
В противном случае, или если значение невозможно получить, используется значение переменной среды COLUMN.
Если COLUMN не задано или равно нулю, используется 80.

И наконец, возвращает указанную ширину минус 1.

-1 нужен для командной строки Windows, чтобы переводить курсор на следующую строку, если достигается последний столбец.

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