NAME
wrap-with-perinci-sub-wrapper - Wrap subroutine with Perinci::Sub::Wrapper
VERSION
This document describes version 0.112 of wrap-with-perinci-sub-wrapper (from Perl distribution App-PerinciUtils), released on 2019-01-20.
SYNOPSIS
Usage:
% wrap-with-perinci-sub-wrapper [options] [meta] [args]DESCRIPTION
This script is useful for testing Perinci::Sub::Wrapper. You specify input Rinci metadata either using --meta or using --url to get it from Riap URL.
You then can show the code generated by the wrapper using --show-code (-c).
Or, you can call the wrapped function with one or more sets of arguments, by supplying --code and one of: --args, --multiple-args, --args-file, or --multiple-args-file.
OPTIONS
* marks required options.
Action selection options
- --show-meta
-
Don't call sub or wrap, show normalized metadata (before wrapping) only.
- --show-wrap-code, -c
-
Don't call sub, show generated wrapper code only.
- --show-wrap-meta
-
Don't call sub, show generated metadata after wrapping only.
Argument specification options
- --args-file-type=s
-
Give hint for args file type.
Valid values:
["json","yaml"] - --args-file=filename
-
Retrieve args from file.
JSON and YAML formats are supported. File type will be guessed from filename, defaults to JSON.
- --args-json=s
-
See
--args. - --args=s
- --multiple-args-file=filename
-
Retrieve multiple args from file.
This is like `args_file` except that for multiple args. Content must be an array.
- --multiple-args-json=s
-
Call with multiple args (array of args) (JSON-encoded).
See
--multiple-args. - --multiple-args=s
-
Call with multiple args (array of args).
Code specification options
Configuration options
- --config-path=filename
-
Set path to configuration file.
Can be specified multiple times.
- --config-profile=s, -P
-
Set configuration profile to use.
- --no-config, -C
-
Do not use any configuration file.
Environment options
Meta specification options
- --meta-json=s
-
Specify function metadata (JSON-encoded).
See
--meta. - --meta=s
-
Specify function metadata.
- --url=s
-
Use function metadata from Riap URL.
Output options
- --args-with-result, -d
-
Show args alongside with call result.
The default is to show the call result only.
- --format=s
-
Choose output format, e.g. json, text.
Default value:
undef - --json
-
Set output format to json.
- --linenum, -l
-
When showing source code (--show-wrap-code), add line numbers.
- --no-naked-res
-
When outputing as JSON, add result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Wrapping options
- --core
-
Whether to generate code which avoids the use of non-core modules.
- --core-or-pp
-
Whether to generate code which avoids the use of non-core XS modules.
In other words, generated code should stick with core or pure-perl modules.
- --no-validate-args
- --no-validate-result
- --pp
-
Whether to generate code which avoids the use of XS modules.
- --with-debug
-
Generate wrapper with debug on.
This means e.g. to pepper the wrapper code with more comments.
- --wrap
Other options
COMPLETION
This script has shell tab completion capability with support for several shells.
bash
To activate bash completion for this script, put:
complete -C wrap-with-perinci-sub-wrapper wrap-with-perinci-sub-wrapperin your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
tcsh
To activate tcsh completion for this script, put:
complete wrap-with-perinci-sub-wrapper 'p/*/`wrap-with-perinci-sub-wrapper`/'in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
other shells
For fish and zsh, install shcompgen as described above.
CONFIGURATION FILE
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/wrap-with-perinci-sub-wrapper.conf, ~/wrap-with-perinci-sub-wrapper.conf, or /etc/wrap-with-perinci-sub-wrapper.conf.
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
List of available configuration parameters:
args (see --args)
args_file (see --args-file)
args_file_type (see --args-file-type)
args_with_result (see --args-with-result)
code (see --code)
core (see --core)
core_or_pp (see --core-or-pp)
format (see --format)
linenum (see --linenum)
meta (see --meta)
multiple_args (see --multiple-args)
multiple_args_file (see --multiple-args-file)
naked_res (see --naked-res)
pp (see --pp)
show_meta (see --show-meta)
show_wrap_code (see --show-wrap-code)
show_wrap_meta (see --show-wrap-meta)
url (see --url)
validate_args (see --no-validate-args)
validate_result (see --no-validate-result)
with_debug (see --with-debug)
wrap (see --wrap)ENVIRONMENT
WRAP_WITH_PERINCI_SUB_WRAPPER_OPT => str
Specify additional command-line options.
FILES
~/.config/wrap-with-perinci-sub-wrapper.conf
~/wrap-with-perinci-sub-wrapper.conf
/etc/wrap-with-perinci-sub-wrapper.conf
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-PerinciUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-PerinciUtils.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PerinciUtils
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.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2019, 2017, 2016, 2015 by 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.