/ 
App-CSVUtils-1.024
River stage one • 3 direct dependents • 4 total dependents
/ App::CSVUtils::csv_check_cell_values

NAME

App::CSVUtils::csv_check_cell_values - Check the value of single cells of CSV against code/schema/regex

VERSION

This document describes version 1.024 of App::CSVUtils::csv_check_cell_values (from Perl distribution App-CSVUtils), released on 2023-04-01.

FUNCTIONS

csv_check_cell_values

Usage:

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

Check the value of single cells of CSV against code/schema/regex.

Examples:

  • Check whether the `rank` field has monotonically increasing values:

    csv_check_cell_values(
    input_filename => "formula.csv",
  include_fields => ["rank"],
  with_schema    => "array/num//monotonically_increasing"
);

Example input.csv:

ingredient,%weight
foo,81
bar,9
baz,10

Check that ingredients do not contain number:

% csv-check-cell-values input.csv -f ingredient --with-regex '/\\A[A-Za-z ]+\\z/'

Check that all %weight is between 0 and 100:

% csv-check-cell-values input.csv -f %weight --with-code '$_>0 && $_<=100'

This function is not exported.

Arguments ('*' denotes required arguments):

  • exclude_field_pat => re

    Field regex pattern to exclude, takes precedence over --field-pat.

  • exclude_fields => array[str]

    Field names to exclude, takes precedence over --fields.

  • ignore_unknown_fields => bool

    When unknown fields are specified in --include-field (--field) or --exclude-field options, ignore them instead of throwing an error.

  • include_field_pat => re

    Field regex pattern to select, overidden by --exclude-field-pat.

  • include_fields => array[str]

    Field names to include, takes precedence over --exclude-field-pat.

  • input_escape_char => str

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

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

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

    Input CSV file.

    Use - to read from stdin.

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

  • input_header => bool (default: 1)

    Specify whether input CSV has a header row.

    By default, the first row of the input CSV will be assumed to contain field names (and the second row contains the first data row). When you declare that input CSV does not have header row (--no-input-header), the first row of the CSV is assumed to contain the first data row. Fields will be named field1, field2, and so on.

  • input_quote_char => str

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

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

  • input_sep_char => str

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

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

  • input_tsv => true

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

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

  • print_validated => bool

    Print the validated values of each cell.

    When validating with schema, will print each validated (possible coerced, filtered) value of each cell.

  • quiet => bool

    (No description)

  • show_selected_fields => true

    Show selected fields and then immediately exit.

  • with_code => str|code

    Check with Perl code.

    Code will be given the value of the cell and should return a true value if value is valid.

  • with_regex => re_from_str

    (No description)

  • with_schema => str|array

    Check with a Sah schema.

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.