NAME
Perinci::Sub::Util::Args - Utility routines related to Rinci arguments
VERSION
This document describes version 0.472 of Perinci::Sub::Util::Args (from Perl distribution Perinci-Sub-Util), released on 2023-10-28.
SYNOPSIS
package MyPackage;
use Perinci::Sub::Util::Args qw(
args_by_tag
argnames_by_tag
func_args_by_tag
func_argnames_by_tag
call_with_its_args
);
our %SPEC;
my %func1_args;
$SPEC{myfunc1} = {
v => 1.1,
summary => 'My function one',
args => {
%func1_args = (
foo => {tags=>['t1', 't2']},
bar => {tags=>['t2', 't3']},
baz => {},
),
},
};
sub myfunc1 {
my %args = @_;
}
$SPEC{myfunc2} = {
v => 1.1,
summary => 'My function two',
args => {
%func1_args,
qux => {tags=>['t3']},
},
};
sub myfunc2 {
my %args = @_;
my $res = call_with_its_args('myfunc1', \%args);
}
DESCRIPTION
FUNCTIONS
args_by_tag
Usage:
my %args = args_by_tag($meta, \%args0, $tag);
Will select only keypairs from %args0
arguments which have tag $tag
. Examples:
my %args = args_by_tag($SPEC{myfunc1}, {foo=>1, bar=>2, baz=>3, qux=>4}, 't2'); # (foo=>1, bar=>2)
argnames_by_tag
Usage:
my @arg_names = argnames_by_tag($meta, $tag);
Will select only argument names which have tag $tag
.
func_args_by_tag
Usage:
my %args = func_args_by_tag($func_name, \%args0, $tag);
Like "args_by_tag" except that instead of supplying Rinci function metadata, you supply a function name. Rinci metadata will be searched in %SPEC
variable.
func_argnames_by_tag
Usage:
my @argnames = func_argnames_by_tag($func_name, $tag);
Like "argnames_by_tag" except that instead of supplying Rinci function metadata, you supply a function name. Rinci metadata will be searched in %SPEC
variable.
call_with_its_args
Usage:
my $res = call_with_its_args($func_name, \%args);
Call function with arguments taken from %args
. Only arguments which the function declares it accepts will be passed.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Perinci-Sub-Util.
SOURCE
Source repository is at https://github.com/perlancar/perl-Perinci-Sub-Util.
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, 2020, 2017, 2016, 2015, 2014 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=Perinci-Sub-Util
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.