/ 
App-CSVUtils-1.033
River stage one • 3 direct dependents • 4 total dependents
/ App::CSVUtils::paras2csv

NAME

App::CSVUtils::paras2csv - Convert paragraphs to CSV

VERSION

This document describes version 1.033 of App::CSVUtils::paras2csv (from Perl distribution App-CSVUtils), released on 2023-09-06.

FUNCTIONS

paras2csv

Usage:

paras2csv(%args) -> [$status_code, $reason, $payload, \%result_meta]

Convert paragraphs to CSV.

This utility is the counterpart of the csv2paras utility. See its documentation for more details.

Keywords: paragraphs, cards, pages, headers

This function is not exported.

Arguments ('*' denotes required arguments):

  • input_file => filename (default: "-")

    (No description)

  • ltrim_header => bool

    (No description)

  • output_always_quote => bool (default: 0)

    Whether to always quote values.

    When set to false (the default), values are quoted only when necessary:

    field1,field2,"field three contains comma (,)",field4

    When set to true, then all values will be quoted:

    "field1","field2","field three contains comma (,)","field4"

  • output_escape_char => str

    Specify character to escape value in field in output CSV, will be passed to Text::CSV_XS.

    This is like --input-escape-char option but for output instead of input.

    Defaults to \\ (backslash). Overrides --output-tsv option.

  • output_filename => filename

    Output filename.

    Use - to output to stdout (the default if you don't specify this option).

    Encoding of output file is assumed to be UTF-8.

  • output_header => bool

    Whether output CSV should have a header row.

    By default, a header row will be output if input CSV has header row. Under --output-header, a header row will be output even if input CSV does not have header row (value will be something like "col0,col1,..."). Under --no-output-header, header row will not be printed even if input CSV has header row. So this option can be used to unconditionally add or remove header row.

  • output_quote_char => str

    Specify field quote character in output CSV, will be passed to Text::CSV_XS.

    This is like --input-quote-char option but for output instead of input.

    Defaults to " (double quote). Overrides --output-tsv option.

  • output_quote_empty => bool (default: 0)

    Whether to quote empty values.

    When set to false (the default), empty values are not quoted:

    field1,field2,,field4

    When set to true, then empty values will be quoted:

    field1,field2,"",field4

  • output_sep_char => str

    Specify field separator character in output CSV, will be passed to Text::CSV_XS.

    This is like --input-sep-char option but for output instead of input.

    Defaults to , (comma). Overrides --output-tsv option.

  • output_tsv => bool

    Inform that output file is TSV (tab-separated) format instead of CSV.

    This is like --input-tsv option but for output instead of input.

    Overriden by --output-sep-char, --output-quote-char, --output-escape-char options. If one of those options is specified, then --output-tsv will be ignored.

  • overwrite => bool

    Whether to override existing output file.

  • rtrim_header => bool

    (No description)

  • trim_header => bool

    (No description)

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-CSVUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-CSVUtils.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-CSVUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.