Class: PP

Relationships & Source Files
Namespace Children
Modules: PPMethods
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, PrettyPrint
Instance Chain: self, PPMethods, PrettyPrint
Inherits:	PrettyPrint ::Object PrettyPrint PP
Defined in:	lib/pp.rb

Overview

A pretty-printer for Ruby objects.

All examples assume you have loaded the PP class with:

require 'pp'

What PP Does

Standard output by #p returns this:

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

Pretty-printed output returns this:

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

Usage

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

Output obj(s) to $> in pretty printed format.

It returns obj(s).

Output Customization

To define a customized pretty printing function for your classes, redefine method #pretty_print(pp) in the class.

#pretty_print takes the .pp argument, which is an instance of the PP class. The method uses #text, #breakable, #nest, #group and #pp to print the object.

Pretty-Print JSON

To pretty-print JSON refer to JSON#pretty_generate.

Author

Tanaka Akira <akr@fsij.org>

Class Attribute Summary

.sharing_detection rw

Returns the sharing detection flag as a boolean value.

Class Method Summary

.pp(obj, out = $>, width = 79)

Outputs obj to out in pretty printed format of width columns in width.
.singleline_pp(obj, out = $>)

Outputs obj to out like .pp but with no indent and newline.

Instance Method Summary

PPMethods - Included

#check_inspect_key	Check whether the object_id `id` is in the current buffer of objects to be pretty printed.
#comma_breakable	A convenience method which is same as follows:
#guard_inspect_key	Yields to a block and preserves the previous set of objects being printed.
#object_address_group	A convenience method, like object_group, but also reformats the Object's object_id.
#object_group	A convenience method which is same as follows:
#pop_inspect_key	Removes an object from the set of objects being pretty printed.
#pp	Adds `obj` to the pretty printing buffer using `Object#pretty_print` or `Object#pretty_print_cycle`.
#pp_hash	A pretty print for a ::Hash.
#pp_object	A present standard failsafe for pretty printing any given ::Object.
#push_inspect_key	Adds the object_id `id` to the set of objects being pretty printed, so as to not repeat objects.
#seplist	Adds a separated list.

Class Attribute Details

.sharing_detection (rw)

Returns the sharing detection flag as a boolean value. It is false by default.

[ GitHub ]

# File 'lib/pp.rb', line 126


attr_accessor :sharing_detection

Class Method Details

.pp(obj, out = $>, width = 79)

Outputs obj to out in pretty printed format of width columns in width.

If out is omitted, $> is assumed. If width is omitted, 79 is assumed.

pp returns out.

[ GitHub ]

# 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

.singleline_pp(obj, out = $>)

Outputs obj to out like .pp but with no indent and newline.

singleline_pp returns out.

[ GitHub ]

# 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