Data::Sah::Compiler::human - Compile Sah schema to human language


This document describes version 0.910 of Data::Sah::Compiler::human (from Perl distribution Data-Sah), released on 2021-08-01.



This class is derived from Data::Sah::Compiler. It generates human language text.



new() => OBJ

$c->compile(%args) => RESULT

Aside from base class' arguments, this class supports these arguments (suffix * denotes required argument):

  • format => STR (default: inline_text)

    Format of text to generate. Either inline_text, inline_err_text, or markdown. Note that you can easily convert Markdown to HTML, there are libraries in Perl, JavaScript, etc to do that.

    Sample inline_text output:

     integer, must satisfy all of the following: (divisible by 3, at least 10)

    inline_err_text is just like inline_text, except geared towards producing an error message. Currently, instead of producing "integer" from schema "int", it produces "Not of type integer". The rest is identical.

    Sample markdown output:

     integer, must satisfy all of the following:
     * divisible by 3
     * at least 10
  • hash_values => hash

    Optional, supply more keys to hash value to sprintfn which will be used during compilation.

Compilation data

This subclass adds the following compilation data ($cd).

Keys which contain compilation state:

Keys which contain compilation result:


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) 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012 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.