cloup.constraints.common
¶
Useful functions used to implement constraints and predicates.
Functions¶
|
Define what it means for a parameter of a specific kind to be “set”. |
|
Return the name of a parameter casted to |
|
Filter |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Contents¶
-
cloup.constraints.common.
param_value_is_set
(param, value)[source]¶ Define what it means for a parameter of a specific kind to be “set”.
All cases are obvious besides that of boolean options: - (common rule) if the value is
None
, the parameter is unset; - a parameter that takes multiple values is set if at least one argument is provided; - a boolean flag is set only if True; - a boolean option is set if not None, even if it’s False.- Parameters
param (click.core.Parameter) –
value (Any) –
- Return type
-
cloup.constraints.common.
get_param_name
(param)[source]¶ Return the name of a parameter casted to
str
. Use this function to avoid typing errors in places where you expect a parameter having a name.- Parameters
param (click.core.Parameter) –
- Return type
-
cloup.constraints.common.
get_params_whose_value_is_set
(params, values)[source]¶ Filter
params
, returning only the parameters that have a value. Boolean flags are considered “set” if their value isTrue
.- Parameters
params (Iterable[click.core.Parameter]) –
values (Dict[str, Any]) –
- Return type
List[click.core.Parameter]
-
cloup.constraints.common.
get_required_params
(params)[source]¶ - Parameters
params (Iterable[click.core.Parameter]) –
- Return type
List[click.core.Parameter]
-
cloup.constraints.common.
get_param_label
(param)[source]¶ - Parameters
param (click.core.Parameter) –
- Return type
-
cloup.constraints.common.
join_param_labels
(params, sep=', ')[source]¶ - Parameters
params (Iterable[click.core.Parameter]) –
sep (str) –
- Return type
-
cloup.constraints.common.
format_param
(param)[source]¶ - Parameters
param (click.core.Parameter) –
- Return type
-
cloup.constraints.common.
format_param_list
(param_list, indent=2)[source]¶ - Parameters
param_list (Iterable[click.core.Parameter]) –
indent (int) –
- Return type
-
cloup.constraints.common.
param_value_by_name
(ctx, name)[source]¶ - Parameters
ctx (click.core.Context) –
name (str) –
- Return type
Any