Matt S Trout > Data-Dumper-Concise-1.200 > Data::Dumper::Concise

Download:
Data-Dumper-Concise-1.200.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.200   Source   Latest Release: Data-Dumper-Concise-2.022

NAME ^

Data::Dumper::Concise - Less indentation and newlines plus sub deparsing

SYNOPSIS ^

  use Data::Dumper::Concise;

  warn Dumper($var);

is equivalent to:

  use Data::Dumper;
  {
    local $Data::Dumper::Terse = 1;
    local $Data::Dumper::Indent = 1;
    local $Data::Dumper::Useqq = 1;
    local $Data::Dumper::Deparse = 1;
    local $Data::Dumper::Quotekeys = 0;
    local $Data::Dumper::Sortkeys = 1;
    warn Dumper($var);
  }

whereas

  my $dd = Dumper;

is equivalent to:

  my $dd = Data::Dumper->new([])
                       ->Terse(1)
                       ->Indent(1)
                       ->Useqq(1)
                       ->Deparse(1)
                       ->Quotekeys(0)
                       ->Sortkeys(1);

So for the structure:

  { foo => "bar\nbaz", quux => sub { "fleem" } };

Data::Dumper::Concise will give you:

  {
    foo => "bar\nbaz",
    quux => sub {
        use warnings;
        use strict 'refs';
        'fleem';
    }
  }

instead of the default Data::Dumper output:

  $VAR1 = {
        'quux' => sub { "DUMMY" },
        'foo' => 'bar
  baz'
  };

(note the tab indentation, oh joy ...)

DESCRIPTION ^

This module always exports a single function, Dumper, which can be called with an array of values to dump those values or with no arguments to return the Data::Dumper object it's created. Note that this means that

  Dumper @list

will probably not do what you wanted when @list is empty. In this case use

  Dumper \@list

instead.

It exists, fundamentally, as a convenient way to reproduce a set of Dumper options that we've found ourselves using across large numbers of applications, primarily for debugging output.

The principle guiding theme is "all the concision you can get while still having a useful dump and not doing anything cleverer than setting Data::Dumper options" - it's been pointed out to us that Data::Dump::Streamer can produce shorter output with less lines of code. We know. This is simpler and we've never seen it segfault. But for complex/weird structures, it generally rocks. You should use it as well, when Concise is underkill. We do.

Why is deparsing on when the aim is concision? Because you often want to know what subroutine refs you have when debugging and because if you were planning to eval this back in you probably wanted to remove subrefs first and add them back in a custom way anyway. Note that this -does- force using the pure perl Dumper rather than the XS one, but I've never in my life seen Data::Dumper show up in a profile so "who cares?".

BUT BUT BUT ... ^

Yes, we know. Consider this module in the ::Tiny spirit and feel free to write a Data::Dumper::Concise::ButWithExtraTwiddlyBits if it makes you happy. Then tell us so we can add it to the see also section.

SUGARY SYNTAX ^

This package also provides:

Data::Dumper::Concise::Sugar - provides Dwarn and DwarnS convenience functions

Devel::Dwarn - shorter form for Data::Dumper::Concise::Sugar

SEE ALSO ^

We use for some purposes, and dearly love, the following alternatives:

Data::Dump - prettiness oriented but not amazingly configurable

Data::Dump::Streamer - brilliant. beautiful. insane. extensive. excessive. try it.

JSON::XS - no, really. If it's just plain data, JSON is a great option.

AUTHOR ^

mst - Matt S. Trout <mst@shadowcat.co.uk>

CONTRIBUTORS ^

frew - Arthur Axel "fREW" Schmidt <frioux@gmail.com>

COPYRIGHT ^

Copyright (c) 2009 the Data::Dumper::Concise "AUTHOR" and "CONTRIBUTORS" as listed above.

LICENSE ^

This library is free software and may be distributed under the same terms as perl itself.

syntax highlighting: