cloup.formatting._util

Functions

ensure_is_cloup_formatter(formatter)

unstyled_len(string)

Contents

cloup.formatting._util.FORMATTER_TYPE_ERROR = Multiline-String
Show Value
1
2
3
4
5
6
7
since cloup v0.8.0, this class relies on cloup.HelpFormatter to align help
sections. So, you need to make sure your command class uses cloup.HelpFormatter
as formatter class.

If you have your own custom HelpFormatter, know that cloup.HelpFormatter is
more easily customizable then Click's one, so consider extending it instead
of extending click.HelpFormatter.
cloup.formatting._util.ensure_is_cloup_formatter(formatter)[source]
Parameters

formatter (click.formatting.HelpFormatter) –

Return type

cloup.HelpFormatter

cloup.formatting._util.unstyled_len(string)[source]
Parameters

string (str) –

Return type

int