Sah::Schema::percent - A float


This document describes version 0.011 of Sah::Schema::percent (from Perl distribution Sah-Schemas-Float), released on 2020-06-04.


To check data against this schema (requires Data::Sah):

 use Data::Sah qw(gen_validator);
 my $validator = gen_validator("percent*");
 say $validator->($data) ? "valid" : "INVALID!";

 # Data::Sah can also create validator that returns nice error message string
 # and/or coerced value. Data::Sah can even create validator that targets other
 # language, like JavaScript. All from the same schema. See its documentation
 # for more details.

To validate function parameters against this schema (requires Params::Sah):

 use Params::Sah qw(gen_validator);

 sub myfunc {
     my @args = @_;
     state $validator = gen_validator("percent*");

To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine to create a CLI:

 # in lib/
 package MyApp;
 our %SPEC;
 $SPEC{myfunc} = {
     v => 1.1,
     summary => 'Routine to do blah ...',
     args => {
         arg1 => {
             summary => 'The blah blah argument',
             schema => ['percent*'],
 sub myfunc {
     my %args = @_;

 # in
 package main;
 use Perinci::CmdLine::Any;

 # in command-line
 % ./ --help
 myapp - Routine to do blah ...

 % ./ --version

 % ./ --arg1 ...

Sample data:

 0  # valid, becomes 0

 0.5  # valid, becomes 0.005

 5  # valid, becomes 0.05

 "5%"  # valid, becomes 0.05


This type is basically float, with str_as_percent coerce rule. So the percent sign is optional, but the number is always interpreted as percent, e.g. "1" is interpreted as 1% (0.01).

In general, instead of using this schema, I recommend just using the float type (which by default includes coercion rule to convert from percent notation e.g. '1%' -> 0.01). Use this schema if your argument really needs to be expressed in percents.


Please visit the project's homepage at


Source repository is at


Please report any bugs or feature requests on the bugtracker website

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.


perlancar <>


This software is copyright (c) 2020, 2019, 2018 by

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